Commit | Line | Data |
b8a92065 |
1 | package stemmaweb::Controller::Relation; |
2 | use Moose; |
3 | use namespace::autoclean; |
b28e606e |
4 | use TryCatch; |
b8a92065 |
5 | |
6 | BEGIN { extends 'Catalyst::Controller' } |
7 | |
8 | |
9 | =head1 NAME |
10 | |
11 | stemmaweb::Controller::Relation - Controller for the relationship mapper |
12 | |
13 | =head1 DESCRIPTION |
14 | |
b28e606e |
15 | The reading relationship mapper with draggable nodes. |
b8a92065 |
16 | |
17 | =head1 METHODS |
18 | |
b28e606e |
19 | =head2 index |
20 | |
b8a92065 |
21 | GET relation/$textid |
22 | |
23 | Renders the application for the text identified by $textid. |
24 | |
b8a92065 |
25 | =cut |
26 | |
9529f69c |
27 | sub index :Path :Args(0) { |
28 | my( $self, $c ) = @_; |
b28e606e |
29 | $c->stash->{'template'} = 'relate.tt'; |
30 | } |
31 | |
e847b186 |
32 | =head2 help |
33 | |
34 | GET relation/help |
35 | |
36 | Returns the help window HTML. |
37 | |
38 | =cut |
39 | |
40 | sub help :Local :Args(0) { |
41 | my( $self, $c ) = @_; |
42 | $c->stash->{'template'} = 'relatehelp.tt'; |
43 | } |
44 | |
9529f69c |
45 | =head2 definitions |
b28e606e |
46 | |
9c2e7b80 |
47 | GET relation/definitions |
b28e606e |
48 | |
49 | Returns a data structure giving the valid types and scopes for a relationship. |
50 | |
51 | =cut |
52 | |
9c2e7b80 |
53 | sub definitions :Local :Args(0) { |
b28e606e |
54 | my( $self, $c ) = @_; |
17b660e6 |
55 | my $valid_relationships = [ qw/ spelling orthographic grammatical lexical transposition / ]; |
b28e606e |
56 | my $valid_scopes = [ qw/ local global / ]; |
57 | $c->stash->{'result'} = { 'types' => $valid_relationships, 'scopes' => $valid_scopes }; |
58 | $c->forward('View::JSON'); |
b8a92065 |
59 | } |
60 | |
9529f69c |
61 | =head2 text |
b28e606e |
62 | |
9529f69c |
63 | GET relation/$textid/ |
64 | |
65 | Runs the relationship mapper for the specified text ID. |
66 | |
b28e606e |
67 | =cut |
68 | |
9529f69c |
69 | sub text :Chained('/') :PathPart('relation') :CaptureArgs(1) { |
70 | my( $self, $c, $textid ) = @_; |
13aa153c |
71 | # If the tradition has more than 500 ranks or so, split it up. |
72 | my $tradition = $c->model('Directory')->tradition( $textid ); |
73 | my $length = $tradition->collation->end->rank; |
74 | if( $length > 700 ) { |
75 | # Segment the tradition in order not to overload the browser. |
76 | # Split it up into units of 500 ranks, but have each segment show |
77 | # 550 ranks so that overlap works. |
78 | my @divs; |
79 | my $r = 0; |
80 | while( $r + 50 < $length ) { |
81 | push( @divs, $r ); |
82 | $r += 500; |
83 | } |
84 | $c->stash->{'textsegments'} = []; |
ea8e8b3c |
85 | foreach my $i ( 0..$#divs ) { |
86 | my $seg = { 'start' => $divs[$i] }; |
87 | $seg->{'display'} = "Segment " . ($i+1); |
13aa153c |
88 | push( @{$c->stash->{'textsegments'}}, $seg ); |
89 | } |
90 | } |
ea8e8b3c |
91 | $DB::single = 1; |
13aa153c |
92 | $c->stash->{'textid'} = $textid; |
93 | $c->stash->{'tradition'} = $tradition; |
9529f69c |
94 | } |
95 | |
96 | sub main :Chained('text') :PathPart('') :Args(0) { |
b28e606e |
97 | my( $self, $c ) = @_; |
13aa153c |
98 | my $startseg = $c->req->param('start'); |
9c2e7b80 |
99 | my $tradition = delete $c->stash->{'tradition'}; |
100 | my $collation = $tradition->collation; |
13aa153c |
101 | my $svgopts; |
102 | if( $startseg ) { |
ea8e8b3c |
103 | # Only render the subgraph from startseg to +550 or end, |
13aa153c |
104 | # whichever is less. |
105 | $svgopts = { 'from' => $startseg }; |
106 | $svgopts->{'to'} = $startseg + 550 |
107 | if $startseg + 550 < $collation->end->rank; |
108 | } elsif( exists $c->stash->{'textsegments'} ) { |
109 | # This is the unqualified load of a long tradition. We implicitly start |
110 | # at zero, but go only as far as 550. |
ea8e8b3c |
111 | $startseg = 0; |
13aa153c |
112 | $svgopts = { 'to' => 550 }; |
113 | } |
114 | my $svg_str = $collation->as_svg( $svgopts ); |
9529f69c |
115 | $svg_str =~ s/\n//gs; |
ea8e8b3c |
116 | $c->stash->{'startseg'} = $startseg if defined $startseg; |
9529f69c |
117 | $c->stash->{'svg_string'} = $svg_str; |
118 | $c->stash->{'text_title'} = $tradition->name; |
119 | $c->stash->{'template'} = 'relate.tt'; |
b28e606e |
120 | } |
121 | |
122 | =head2 relationships |
123 | |
13aa153c |
124 | GET relation/$textid/relationships |
9529f69c |
125 | |
126 | Returns the list of relationships defined for this text. |
b28e606e |
127 | |
13aa153c |
128 | POST relation/$textid/relationships { request } |
9529f69c |
129 | |
130 | Attempts to define the requested relationship within the text. Returns 200 on |
131 | success or 403 on error. |
b28e606e |
132 | |
13aa153c |
133 | DELETE relation/$textid/relationships { request } |
9529f69c |
134 | |
b28e606e |
135 | |
136 | =cut |
137 | |
9529f69c |
138 | sub relationships :Chained('text') :PathPart :Args(0) { |
b28e606e |
139 | my( $self, $c ) = @_; |
6d124a83 |
140 | my $tradition = delete $c->stash->{'tradition'}; |
141 | my $collation = $tradition->collation; |
cdd592f3 |
142 | my $m = $c->model('Directory'); |
9529f69c |
143 | if( $c->request->method eq 'GET' ) { |
144 | my @pairs = $collation->relationships; # returns the edges |
145 | my @all_relations; |
146 | foreach my $p ( @pairs ) { |
147 | my $relobj = $collation->relations->get_relationship( @$p ); |
545163a2 |
148 | next if $relobj->type eq 'collated'; # Don't show these |
69a19c91 |
149 | my $relhash = { source => $p->[0], target => $p->[1], |
150 | type => $relobj->type, scope => $relobj->scope }; |
151 | $relhash->{'note'} = $relobj->annotation if $relobj->has_annotation; |
152 | push( @all_relations, $relhash ); |
9529f69c |
153 | } |
154 | $c->stash->{'result'} = \@all_relations; |
155 | } elsif( $c->request->method eq 'POST' ) { |
156 | my $node = $c->request->param('source_id'); |
157 | my $target = $c->request->param('target_id'); |
158 | my $relation = $c->request->param('rel_type'); |
159 | my $note = $c->request->param('note'); |
160 | my $scope = $c->request->param('scope'); |
161 | |
162 | my $opts = { 'type' => $relation, |
69a19c91 |
163 | 'scope' => $scope }; |
164 | $opts->{'annotation'} = $note if $note; |
9529f69c |
165 | |
166 | try { |
167 | my @vectors = $collation->add_relationship( $node, $target, $opts ); |
168 | $c->stash->{'result'} = \@vectors; |
cdd592f3 |
169 | $m->save( $tradition ); |
9529f69c |
170 | } catch( Text::Tradition::Error $e ) { |
171 | $c->response->status( '403' ); |
172 | $c->stash->{'result'} = { 'error' => $e->message }; |
173 | } |
174 | } elsif( $c->request->method eq 'DELETE' ) { |
175 | my $node = $c->request->param('source_id'); |
176 | my $target = $c->request->param('target_id'); |
177 | |
178 | try { |
179 | my @vectors = $collation->del_relationship( $node, $target ); |
cdd592f3 |
180 | $m->save( $tradition ); |
9529f69c |
181 | $c->stash->{'result'} = \@vectors; |
182 | } catch( Text::Tradition::Error $e ) { |
183 | $c->response->status( '403' ); |
184 | $c->stash->{'result'} = { 'error' => $e->message }; |
185 | } |
b28e606e |
186 | } |
b28e606e |
187 | $c->forward('View::JSON'); |
188 | } |
9529f69c |
189 | |
b28e606e |
190 | |
b8a92065 |
191 | =head2 end |
192 | |
193 | Attempt to render a view, if needed. |
194 | |
195 | =cut |
196 | |
197 | sub end : ActionClass('RenderView') {} |
198 | |
199 | =head1 AUTHOR |
200 | |
201 | Tara L Andrews |
202 | |
203 | =head1 LICENSE |
204 | |
205 | This library is free software. You can redistribute it and/or modify |
206 | it under the same terms as Perl itself. |
207 | |
208 | =cut |
209 | |
210 | __PACKAGE__->meta->make_immutable; |
211 | |
212 | 1; |