1 package stemmaweb::Controller::Stexaminer;
3 use namespace::autoclean;
4 use Encode qw/ decode_utf8 /;
7 use Text::Tradition::Analysis qw/ run_analysis wit_stringify /;
8 use Text::Tradition::Stemma;
10 BEGIN { extends 'Catalyst::Controller' }
15 stemmaweb::Controller::Stexaminer - Simple controller for stemma display
19 The stemma analysis tool with the pretty colored table.
25 GET stexaminer/$textid/$stemmaid
27 Renders the application for the text identified by $textid, using the stemma
28 graph identified by $stemmaid.
32 sub index :Path :Args(2) {
33 my( $self, $c, $textid, $stemid ) = @_;
34 my $m = $c->model('Directory');
35 $c->stash->{template} = 'stexaminer.tt';
37 # Make sure the tradition exists and is viewable
38 my $tradition = $m->tradition( $textid );
39 unless( $tradition ) {
40 $c->response->status( 404 );
41 $c->stash->{'error'} = "No tradition with ID $textid";
44 my $ok = _check_permission( $c, $tradition );
47 if( $tradition->stemma_count ) {
48 my $stemma = $tradition->stemma( $stemid );
49 $c->stash->{svg} = $stemma->as_svg( { size => [ 600, 350 ] } );
50 $c->stash->{graphdot} = $stemma->editable({ linesep => ' ' });
51 $c->stash->{text_id} = $textid;
52 $c->stash->{text_title} = $tradition->name;
54 # Get the analysis options
55 my( $use_type1, $ignore_sort ) = ( 0, 'none' );
56 $use_type1 = $c->req->param( 'show_type1' ) ? 1 : 0;
57 $ignore_sort = $c->req->param( 'ignore_variant' ) || '';
58 $c->stash->{'show_type1'} = $use_type1;
59 $c->stash->{'ignore_variant'} = $ignore_sort;
60 # TODO Run the analysis as AJAX from the loaded page.
61 my %analysis_options = (
63 exclude_type1 => !$use_type1 );
64 if( $ignore_sort eq 'spelling' ) {
65 $analysis_options{'merge_types'} = [ qw/ spelling orthographic / ];
66 } elsif( $ignore_sort eq 'orthographic' ) {
67 $analysis_options{'merge_types'} = 'orthographic';
71 my $t = run_analysis( $tradition, %analysis_options );
72 # Stringify the reading groups
73 foreach my $loc ( @{$t->{'variants'}} ) {
74 my $mst = wit_stringify( $loc->{'missing'} );
75 $loc->{'missing'} = $mst;
76 foreach my $rhash ( @{$loc->{'readings'}} ) {
77 my $gst = wit_stringify( $rhash->{'group'} );
78 $rhash->{'group'} = $gst;
79 _stringify_element( $rhash, 'independent_occurrence' );
80 _stringify_element( $rhash, 'reversions' );
81 unless( $rhash->{'text'} ) {
82 $rhash->{'text'} = $rhash->{'readingid'};
86 # Values for TT rendering
87 $c->stash->{variants} = $t->{'variants'};
88 $c->stash->{total} = $t->{'variant_count'};
89 $c->stash->{genealogical} = $t->{'genealogical_count'};
90 $c->stash->{conflict} = $t->{'conflict_count'};
91 # Also make a JSON stash of the data for the statistics tables
92 $c->stash->{reading_statistics} = to_json( $t->{'variants'} );
94 $c->stash->{error} = 'Tradition ' . $tradition->name
95 . 'has no stemma for analysis.';
99 sub _stringify_element {
100 my( $hash, $key ) = @_;
101 return undef unless exists $hash->{$key};
102 if( ref( $hash->{$key} ) eq 'ARRAY' ) {
103 my $str = join( ', ', @{$hash->{$key}} );
104 $hash->{$key} = $str;
108 sub _check_permission {
109 my( $c, $tradition ) = @_;
110 my $user = $c->user_exists ? $c->user->get_object : undef;
112 return 'full' if ( $user->is_admin ||
113 ( $tradition->has_user && $tradition->user->id eq $user->id ) );
115 # Text doesn't belong to us, so maybe it's public?
116 return 'readonly' if $tradition->public;
118 # ...nope. Forbidden!
119 $c->response->status( 403 );
120 $c->stash->{'error'} = 'You do not have permission to view this tradition';
126 POST stexaminer/graphsvg
127 dot: <stemmagraph dot string>
128 layerwits: [ <a.c. witnesses ]
130 Returns an SVG string of the given graph, extended to include the given
135 sub graphsvg :Local {
136 my( $self, $c ) = @_;
137 my $dot = $c->request->param('dot');
138 my @layerwits = $c->request->param('layerwits[]');
139 open my $stemma_fh, '<', \$dot;
140 binmode( $stemma_fh, ':encoding(UTF-8)' );
141 my $tempstemma = Text::Tradition::Stemma->new( 'dot' => $stemma_fh );
142 my $svgopts = { size => [ 600, 350 ] };
144 $svgopts->{'layerwits'} = \@layerwits;
146 $c->stash->{'result'} = $tempstemma->as_svg( $svgopts );
147 $c->forward('View::SVG');
152 Attempt to render a view, if needed.
156 sub end : ActionClass('RenderView') {}
164 This library is free software. You can redistribute it and/or modify
165 it under the same terms as Perl itself.
169 __PACKAGE__->meta->make_immutable;