1 package stemmaweb::Controller::Relation;
2 use JSON qw/ to_json from_json /;
5 use namespace::autoclean;
8 BEGIN { extends 'Catalyst::Controller' }
13 stemmaweb::Controller::Relation - Controller for the relationship mapper
17 The reading relationship mapper with draggable nodes.
25 Renders the application for the text identified by $textid.
29 sub index :Path :Args(0) {
31 $c->stash->{'template'} = 'relate.tt';
38 Runs the relationship mapper for the specified text ID.
42 sub text :Chained('/') :PathPart('relation') :CaptureArgs(1) {
43 my( $self, $c, $textid ) = @_;
44 my $tradition = $c->model('Directory')->tradition( $textid );
45 unless( $tradition ) {
46 $c->response->status('404');
47 $c->response->body("No such tradition with ID $textid");
48 $c->detach('View::Plain');
52 # Account for a bad interaction between FastCGI and KiokuDB
53 unless( $tradition->collation->tradition ) {
54 $c->log->warn( "Fixing broken tradition link" );
55 $tradition->collation->_set_tradition( $tradition );
56 $c->model('Directory')->save( $tradition );
58 # Check permissions. Will return 403 if denied, otherwise will
59 # put the appropriate value in the stash.
60 my $ok = _check_permission( $c, $tradition );
63 $c->stash->{'textid'} = $textid;
64 $c->stash->{'tradition'} = $tradition;
67 sub main :Chained('text') :PathPart('') :Args(0) {
69 my $tradition = delete $c->stash->{'tradition'};
70 my $collation = $tradition->collation;
72 # Stash the relationship definitions
73 $c->stash->{'relationship_scopes'} = to_json( [ qw/ local global / ] );
75 foreach my $type ( sort { _typesort( $a, $b ) } $collation->relations->types ) {
76 next if $type->is_weak;
77 my $struct = { name => $type->name, description => $type->description };
78 push( @reltypeinfo, $struct );
80 $c->stash->{'relationship_types'} = to_json( \@reltypeinfo );
82 # See how big the tradition is. Edges are more important than nodes
83 # when it comes to rendering difficulty.
84 my $numnodes = scalar $collation->readings;
85 my $numedges = scalar $collation->paths;
86 my $length = $collation->end->rank;
87 # We should display no more than roughly 500 nodes, or roughly 700
89 my $segments = $numnodes / 500;
90 if( $numedges / 700 > $segments ) {
91 $segments = $numedges / 700;
93 my $segsize = sprintf( "%.0f", $length / $segments );
94 my $margin = sprintf( "%.0f", $segsize / 10 );
96 # Segment the tradition in order not to overload the browser.
99 while( $r + $margin < $length ) {
103 $c->stash->{'textsegments'} = [];
104 foreach my $i ( 0..$#divs ) {
105 my $seg = { 'start' => $divs[$i] };
106 $seg->{'display'} = "Segment " . ($i+1);
107 push( @{$c->stash->{'textsegments'}}, $seg );
110 my $startseg = $c->req->param('start');
113 # Only render the subgraph from startseg to endseg or to END,
115 my $endseg = $startseg + $segsize + $margin;
116 $svgopts = { 'from' => $startseg };
117 $svgopts->{'to'} = $endseg if $endseg < $collation->end->rank;
118 } elsif( exists $c->stash->{'textsegments'} ) {
119 # This is the unqualified load of a long tradition. We implicitly start
120 # at zero, but go only as far as our segment size.
121 my $endseg = $segsize + $margin;
123 $svgopts = { 'to' => $endseg };
126 my $svg_str = $collation->as_svg( $svgopts );
127 $svg_str =~ s/\n//gs;
128 $c->stash->{'startseg'} = $startseg if defined $startseg;
129 $c->stash->{'svg_string'} = $svg_str;
130 $c->stash->{'text_title'} = $tradition->name;
131 if( $tradition->can('language') ) {
132 $c->stash->{'text_lang'} = $tradition->language;
133 $c->stash->{'can_morphologize'} = 1;
135 $c->stash->{'text_lang'} = 'Default';
137 $c->stash->{'template'} = 'relate.tt';
142 my $blsort = $a->bindlevel <=> $b->bindlevel;
143 return $blsort if $blsort;
144 return $a->name cmp $b->name;
149 GET relation/help/$language
151 Returns the help window HTML.
155 sub help :Local :Args(1) {
156 my( $self, $c, $lang ) = @_;
157 # Display the morphological help for the language if it is defined.
158 if( $lang && $lang ne 'Default' ) {
159 my $mod = 'Text::Tradition::Language::' . $lang;
163 $c->log->debug("Warning: could not load $mod");
165 my $has_mod = $mod->can('morphology_tags');
167 my $tagset = &$has_mod;
168 $c->stash->{'tagset'} = $tagset;
171 $c->stash->{'template'} = 'relatehelp.tt';
176 GET relation/$textid/relationships
178 Returns the list of relationships defined for this text.
180 POST relation/$textid/relationships { request }
182 Attempts to define the requested relationship within the text. Returns 200 on
183 success or 403 on error.
185 DELETE relation/$textid/relationships { request }
190 sub relationships :Chained('text') :PathPart :Args(0) {
191 my( $self, $c ) = @_;
192 my $tradition = delete $c->stash->{'tradition'};
193 my $ok = _check_permission( $c, $tradition );
195 my $collation = $tradition->collation;
196 my $m = $c->model('Directory');
197 if( $c->request->method eq 'GET' ) {
198 my @pairs = $collation->relationships; # returns the edges
200 foreach my $p ( @pairs ) {
201 my $relobj = $collation->relations->get_relationship( @$p );
202 next if $relobj->type eq 'collated'; # Don't show these
203 next if $p->[0] eq $p->[1]; # HACK until bugfix
204 my $relhash = { source => $p->[0], target => $p->[1],
205 type => $relobj->type, scope => $relobj->scope };
206 $relhash->{'note'} = $relobj->annotation if $relobj->has_annotation;
207 push( @all_relations, $relhash );
209 $c->stash->{'result'} = \@all_relations;
211 # Check write permissions first of all
212 if( $c->stash->{'permission'} ne 'full' ) {
213 $c->response->status( '403' );
214 $c->stash->{'result'} = {
215 'error' => 'You do not have permission to modify this tradition.' };
216 $c->detach( 'View::JSON' );
217 } elsif( $c->request->method eq 'POST' ) {
218 my $node = $c->request->param('source_id');
219 my $target = $c->request->param('target_id');
220 my $relation = $c->request->param('rel_type');
221 my $note = $c->request->param('note');
222 my $scope = $c->request->param('scope');
224 my $opts = { 'type' => $relation, 'propagate' => 1 };
225 $opts->{'scope'} = $scope if $scope;
226 $opts->{'annotation'} = $note if $note;
229 my @vectors = $collation->add_relationship( $node, $target, $opts );
230 $c->stash->{'result'} = \@vectors;
231 $m->save( $tradition );
232 } catch( Text::Tradition::Error $e ) {
233 $c->response->status( '403' );
234 $c->stash->{'result'} = { 'error' => $e->message };
236 } elsif( $c->request->method eq 'DELETE' ) {
237 my $node = $c->request->param('source_id');
238 my $target = $c->request->param('target_id');
239 my $scopewide = $c->request->param('scopewide')
240 && $c->request->param('scopewide') eq 'true';
242 my @vectors = $collation->del_relationship( $node, $target, $scopewide );
243 $m->save( $tradition );
244 $c->stash->{'result'} = \@vectors;
245 } catch( Text::Tradition::Error $e ) {
246 $c->response->status( '403' );
247 $c->stash->{'result'} = { 'error' => $e->message };
251 $c->forward('View::JSON');
256 GET relation/$textid/readings
258 Returns the list of readings defined for this text along with their metadata.
262 my %read_write_keys = (
266 'grammar_invalid' => 1,
271 sub _reading_struct {
273 # Return a JSONable struct of the useful keys. Keys meant to be writable
274 # have a true value; read-only keys have a false value.
276 map { $struct->{$_} = $reading->$_ if $reading->can( $_ ) } keys( %read_write_keys );
278 $struct->{'lexemes'} = $reading->can( 'lexemes' ) ? [ $reading->lexemes ] : [];
279 # Look up any words related via spelling or orthography
282 return $t eq 'spelling' || $t eq 'orthographic';
284 # Now add the list data
285 $struct->{'variants'} = [ map { $_->text } $reading->related_readings( $sameword ) ];
286 $struct->{'witnesses'} = [ $reading->witnesses ];
290 sub readings :Chained('text') :PathPart :Args(0) {
291 my( $self, $c ) = @_;
292 my $tradition = delete $c->stash->{'tradition'};
293 my $ok = _check_permission( $c, $tradition );
295 my $collation = $tradition->collation;
296 my $m = $c->model('Directory');
297 if( $c->request->method eq 'GET' ) {
299 foreach my $rdg ( $collation->readings ) {
300 $rdginfo->{$rdg->id} = _reading_struct( $rdg );
302 $c->stash->{'result'} = $rdginfo;
304 $c->forward('View::JSON');
309 GET relation/$textid/reading/$id
311 Returns the list of readings defined for this text along with their metadata.
313 POST relation/$textid/reading/$id { request }
315 Alters the reading according to the values in request. Returns 403 Forbidden if
316 the alteration isn't allowed.
320 sub reading :Chained('text') :PathPart :Args(1) {
321 my( $self, $c, $reading_id ) = @_;
322 my $tradition = delete $c->stash->{'tradition'};
323 my $collation = $tradition->collation;
324 my $rdg = $collation->reading( $reading_id );
325 my $m = $c->model('Directory');
326 if( $c->request->method eq 'GET' ) {
327 $c->stash->{'result'} = $rdg ? _reading_struct( $rdg )
328 : { 'error' => "No reading with ID $reading_id" };
329 } elsif ( $c->request->method eq 'POST' ) {
330 if( $c->stash->{'permission'} ne 'full' ) {
331 $c->response->status( '403' );
332 $c->stash->{'result'} = {
333 'error' => 'You do not have permission to modify this tradition.' };
334 $c->detach('View::JSON');
338 if( $rdg && $rdg->does('Text::Tradition::Morphology') ) {
339 # Are we re-lemmatizing?
340 if( $c->request->param('relemmatize') ) {
341 my $nf = $c->request->param('normal_form');
342 # TODO throw error unless $nf
343 $rdg->normal_form( $nf );
344 # TODO throw error if lemmatization fails
345 # TODO skip this if normal form hasn't changed
348 # Set all the values that we have for the reading.
349 # TODO error handling
350 foreach my $p ( keys %{$c->request->params} ) {
351 if( $p =~ /^morphology_(\d+)$/ ) {
352 # Set the form on the correct lexeme
353 my $morphval = $c->request->param( $p );
354 next unless $morphval;
356 my $lx = $rdg->lexeme( $midx );
357 my $strrep = $rdg->language . ' // ' . $morphval;
358 my $idx = $lx->has_form( $strrep );
359 unless( defined $idx ) {
360 # Make the word form and add it to the lexeme.
362 $idx = $lx->add_matching_form( $strrep ) - 1;
363 } catch( Text::Tradition::Error $e ) {
364 $c->response->status( '403' );
365 $errmsg = $e->message;
367 # Something else went wrong, probably a Moose error
368 $c->response->status( '403' );
369 $errmsg = 'Something went wrong with the request';
372 $lx->disambiguate( $idx ) if defined $idx;
373 } elsif( $read_write_keys{$p} ) {
374 my $val = _clean_booleans( $rdg, $p, $c->request->param( $p ) );
381 $errmsg = "Reading does not exist or cannot be morphologized";
383 $c->stash->{'result'} = $errmsg ? { 'error' => $errmsg }
384 : _reading_struct( $rdg );
387 $c->forward('View::JSON');
393 POST relation/$textid/merge { data }
395 Merges the requested readings, combining the witnesses of both readings into
396 the target reading. All non-conflicting source relationships are inherited by
397 the target relationship.
401 sub merge :Chained('text') :PathPart :Args(0) {
402 my( $self, $c ) = @_;
403 my $tradition = delete $c->stash->{'tradition'};
404 my $collation = $tradition->collation;
405 my $m = $c->model('Directory');
406 if( $c->request->method eq 'POST' ) {
407 if( $c->stash->{'permission'} ne 'full' ) {
408 $c->response->status( '403' );
409 $c->stash->{'result'} = {
410 'error' => 'You do not have permission to modify this tradition.' };
411 $c->detach('View::JSON');
417 my $main = $c->request->param('target_id');
418 my $second = $c->request->param('source_id');
419 # Find the common successor of these, so that we can detect other
420 # potentially identical readings.
421 my $csucc = $collation->common_successor( $main, $second );
423 # Try the merge if these are parallel readings.
424 if( $csucc->id eq $main || $csucc->id eq $second ) {
425 $errmsg = "Cannot merge readings in the same path";
428 $collation->merge_readings( $main, $second );
429 } catch( Text::Tradition::Error $e ) {
430 $c->response->status( '403' );
431 $errmsg = $e->message;
433 # Something else went wrong, probably a Moose error
434 $c->response->status( '403' );
435 $errmsg = 'Something went wrong with the request';
439 # Look for readings that are now identical.
441 $response = { status => 'error', error => $errmsg };
443 $response = { status => 'ok' };
444 unless( $c->request->param('single') ) {
445 my @identical = $collation->identical_readings(
446 start => $main, end => $csucc->id );
448 $response->{'checkalign'} = [
449 map { [ $_->[0]->id, $_->[1]->id ] } @identical ];
452 $m->save( $collation );
454 $c->stash->{'result'} = $response;
455 $c->forward('View::JSON');
461 POST relation/$textid/duplicate { data }
463 Duplicates the requested readings, detaching the witnesses specified in
464 the list to use the new reading(s) instead of the old. The data to be
465 passed should be a JSON structure:
467 { readings: rid1,rid2,rid3,...
468 witnesses: [ wit1, ... ] }
472 sub duplicate :Chained('text') :PathPart :Args(0) {
473 my( $self, $c ) = @_;
474 my $tradition = delete $c->stash->{'tradition'};
475 my $collation = $tradition->collation;
476 my $m = $c->model('Directory');
477 if( $c->request->method eq 'POST' ) {
478 if( $c->stash->{'permission'} ne 'full' ) {
479 $c->response->status( '403' );
480 $c->stash->{'result'} = {
481 'error' => 'You do not have permission to modify this tradition.' };
482 $c->detach('View::JSON');
487 # Sort out which readings need to be duplicated from the set given, and
488 # ensure that all the given wits bear each relevant reading.
491 map { $wits{$_} = 1 } $c->request->param('witnesses[]');
493 foreach my $rid ( $c->request->param('readings[]') ) {
495 my $rdg = $collation->reading( $rid );
496 foreach my $rwit ( $rdg->witnesses( $rid ) ) {
497 $numwits++ if exists $wits{$rwit};
499 next unless $numwits; # Disregard readings with none of our witnesses
500 if( $numwits < keys( %wits ) ) {
501 $errmsg = "Reading $rid contains some but not all of the specified witnesses.";
503 } elsif( exists $rdgranks{ $rdg->rank } ) {
504 $errmsg = "More than one reading would be detached along with $rid at rank " . $rdg->rank;
507 $rdgranks{ $rdg->rank } = $rid;
511 # Now check that the readings make a single sequence.
514 foreach my $rank ( sort { $a <=> $b } keys %rdgranks ) {
515 my $rid = $rdgranks{$rank};
517 # Check that there is only one path between $prior and $rdg.
518 foreach my $wit ( keys %wits ) {
519 unless( $collation->prior_reading( $rid, $wit ) eq $prior ) {
520 $errmsg = "Diverging witness paths from $prior to $rid at $wit";
529 # Abort if we've run into a problem.
531 $c->stash->{'result'} = { 'error' => $errmsg };
532 $c->response->status( '403' );
533 $c->forward('View::JSON');
537 # Otherwise, do the dirty work.
538 my @witlist = keys %wits;
539 my @deleted_relations;
540 foreach my $rank ( sort { $a <=> $b } keys %rdgranks ) {
542 my $reading_id = $rdgranks{$rank};
545 ( $newrdg, @delrels ) =
546 $collation->duplicate_reading( $reading_id, @witlist );
547 } catch( Text::Tradition::Error $e ) {
548 $c->response->status( '403' );
549 $errmsg = $e->message;
551 # Something else went wrong, probably a Moose error
552 $c->response->status( '403' );
553 $errmsg = 'Something went wrong with the request';
556 my $data = _reading_struct( $newrdg );
557 $data->{'orig_rdg'} = $reading_id;
558 $response->{"$newrdg"} = $data;
559 push( @deleted_relations, @delrels );
563 $c->stash->{'result'} = { 'error' => $errmsg };
565 $m->save( $collation );
566 $response->{'DELETED'} = \@deleted_relations;
567 $c->stash->{'result'} = $response;
570 $c->forward('View::JSON');
575 sub _check_permission {
576 my( $c, $tradition ) = @_;
577 my $user = $c->user_exists ? $c->user->get_object : undef;
578 # Does this user have access?
580 if( $user->is_admin ||
581 ( $tradition->has_user && $tradition->user->id eq $user->id ) ) {
582 $c->stash->{'permission'} = 'full';
587 if( $tradition->public ) {
588 $c->stash->{'permission'} = 'readonly';
592 $c->response->status( 403 );
593 $c->response->body( 'You do not have permission to view this tradition.' );
594 $c->detach( 'View::Plain' );
598 sub _clean_booleans {
599 my( $rdg, $param, $val ) = @_;
600 if( $rdg->meta->get_attribute( $param )->type_constraint->name eq 'Bool' ) {
601 $val = 1 if $val eq 'true';
602 $val = undef if $val eq 'false';
609 Attempt to render a view, if needed.
613 sub end : ActionClass('RenderView') {}
621 This library is free software. You can redistribute it and/or modify
622 it under the same terms as Perl itself.
626 __PACKAGE__->meta->make_immutable;