1 package stemmaweb::Controller::Relation;
3 use namespace::autoclean;
6 BEGIN { extends 'Catalyst::Controller' }
11 stemmaweb::Controller::Relation - Controller for the relationship mapper
15 The reading relationship mapper with draggable nodes.
23 Renders the application for the text identified by $textid.
27 sub index :Path :Args(0) {
29 $c->stash->{'template'} = 'relate.tt';
36 Returns the help window HTML.
40 sub help :Local :Args(0) {
42 $c->stash->{'template'} = 'relatehelp.tt';
47 GET relation/definitions
49 Returns a data structure giving the valid types and scopes for a relationship.
53 sub definitions :Local :Args(0) {
55 my $valid_relationships = [ qw/ spelling orthographic grammatical lexical transposition / ];
56 my $valid_scopes = [ qw/ local global / ];
57 $c->stash->{'result'} = { 'types' => $valid_relationships, 'scopes' => $valid_scopes };
58 $c->forward('View::JSON');
65 Runs the relationship mapper for the specified text ID.
69 sub text :Chained('/') :PathPart('relation') :CaptureArgs(1) {
70 my( $self, $c, $textid ) = @_;
71 # If the tradition has more than 500 ranks or so, split it up.
72 my $tradition = $c->model('Directory')->tradition( $textid );
73 # Account for a bad interaction between FastCGI and KiokuDB
74 unless( $tradition->collation->tradition ) {
75 $c->log->warn( "Fixing broken tradition link" );
76 $tradition->collation->_set_tradition( $tradition );
77 $c->model('Directory')->save( $tradition );
79 # See how big the tradition is. Edges are more important than nodes
80 # when it comes to rendering difficulty.
81 my $numnodes = scalar $tradition->collation->readings;
82 my $numedges = scalar $tradition->collation->paths;
83 my $length = $tradition->collation->end->rank;
84 # We should display no more than roughly 500 nodes, or roughly 700
86 my $segments = $numnodes / 500;
87 if( $numedges / 700 > $segments ) {
88 $segments = $numedges / 700;
90 my $segsize = sprintf( "%.0f", $length / $segments );
91 my $margin = sprintf( "%.0f", $segsize / 10 );
93 # Segment the tradition in order not to overload the browser.
96 while( $r + $margin < $length ) {
100 $c->stash->{'textsegments'} = [];
101 $c->stash->{'segsize'} = $segsize;
102 $c->stash->{'margin'} = $margin;
103 foreach my $i ( 0..$#divs ) {
104 my $seg = { 'start' => $divs[$i] };
105 $seg->{'display'} = "Segment " . ($i+1);
106 push( @{$c->stash->{'textsegments'}}, $seg );
109 $c->stash->{'textid'} = $textid;
110 $c->stash->{'tradition'} = $tradition;
113 sub main :Chained('text') :PathPart('') :Args(0) {
114 my( $self, $c ) = @_;
115 my $startseg = $c->req->param('start');
116 my $tradition = delete $c->stash->{'tradition'};
117 my $collation = $tradition->collation;
120 # Only render the subgraph from startseg to endseg or to END,
122 my $endseg = $startseg + $c->stash->{'segsize'} + $c->stash->{'margin'};
123 $svgopts = { 'from' => $startseg };
124 $svgopts->{'to'} = $endseg if $endseg < $collation->end->rank;
125 } elsif( exists $c->stash->{'textsegments'} ) {
126 # This is the unqualified load of a long tradition. We implicitly start
127 # at zero, but go only as far as 550.
128 my $endseg = $c->stash->{'segsize'} + $c->stash->{'margin'};
130 $svgopts = { 'to' => $endseg };
132 my $svg_str = $collation->as_svg( $svgopts );
133 $svg_str =~ s/\n//gs;
134 $c->stash->{'startseg'} = $startseg if defined $startseg;
135 $c->stash->{'svg_string'} = $svg_str;
136 $c->stash->{'text_title'} = $tradition->name;
137 $c->stash->{'template'} = 'relate.tt';
142 GET relation/$textid/relationships
144 Returns the list of relationships defined for this text.
146 POST relation/$textid/relationships { request }
148 Attempts to define the requested relationship within the text. Returns 200 on
149 success or 403 on error.
151 DELETE relation/$textid/relationships { request }
156 sub relationships :Chained('text') :PathPart :Args(0) {
157 my( $self, $c ) = @_;
158 my $tradition = delete $c->stash->{'tradition'};
159 my $collation = $tradition->collation;
160 my $m = $c->model('Directory');
161 if( $c->request->method eq 'GET' ) {
162 my @pairs = $collation->relationships; # returns the edges
164 foreach my $p ( @pairs ) {
165 my $relobj = $collation->relations->get_relationship( @$p );
166 next if $relobj->type eq 'collated'; # Don't show these
167 next if $p->[0] eq $p->[1]; # HACK until bugfix
168 my $relhash = { source => $p->[0], target => $p->[1],
169 type => $relobj->type, scope => $relobj->scope };
170 $relhash->{'note'} = $relobj->annotation if $relobj->has_annotation;
171 push( @all_relations, $relhash );
173 $c->stash->{'result'} = \@all_relations;
174 } elsif( $c->request->method eq 'POST' ) {
175 my $node = $c->request->param('source_id');
176 my $target = $c->request->param('target_id');
177 my $relation = $c->request->param('rel_type');
178 my $note = $c->request->param('note');
179 my $scope = $c->request->param('scope');
181 my $opts = { 'type' => $relation,
183 $opts->{'annotation'} = $note if $note;
186 my @vectors = $collation->add_relationship( $node, $target, $opts );
187 $c->stash->{'result'} = \@vectors;
188 $m->save( $tradition );
189 } catch( Text::Tradition::Error $e ) {
190 $c->response->status( '403' );
191 $c->stash->{'result'} = { 'error' => $e->message };
193 } elsif( $c->request->method eq 'DELETE' ) {
194 my $node = $c->request->param('source_id');
195 my $target = $c->request->param('target_id');
198 my @vectors = $collation->del_relationship( $node, $target );
199 $m->save( $tradition );
200 $c->stash->{'result'} = \@vectors;
201 } catch( Text::Tradition::Error $e ) {
202 $c->response->status( '403' );
203 $c->stash->{'result'} = { 'error' => $e->message };
206 $c->forward('View::JSON');
212 Attempt to render a view, if needed.
216 sub end : ActionClass('RenderView') {}
224 This library is free software. You can redistribute it and/or modify
225 it under the same terms as Perl itself.
229 __PACKAGE__->meta->make_immutable;