1 package stemmaweb::Controller::Relation;
2 use JSON qw/ to_json from_json /;
4 use Moose::Util::TypeConstraints qw/ find_type_constraint /;
6 use namespace::autoclean;
7 use Text::Tradition::Datatypes;
10 BEGIN { extends 'Catalyst::Controller' }
15 stemmaweb::Controller::Relation - Controller for the relationship mapper
19 The reading relationship mapper with draggable nodes.
27 Renders the application for the text identified by $textid.
31 sub index :Path :Args(0) {
33 $c->stash->{'template'} = 'relate.tt';
40 Runs the relationship mapper for the specified text ID.
44 sub text :Chained('/') :PathPart('relation') :CaptureArgs(1) {
45 my( $self, $c, $textid ) = @_;
46 my $tradition = $c->model('Directory')->tradition( $textid );
47 unless( $tradition ) {
48 $c->response->status('404');
49 $c->response->body("No such tradition with ID $textid");
50 $c->detach('View::Plain');
54 # Account for a bad interaction between FastCGI and KiokuDB
55 unless( $tradition->collation->tradition ) {
56 $c->log->warn( "Fixing broken tradition link" );
57 $tradition->collation->_set_tradition( $tradition );
58 $c->model('Directory')->save( $tradition );
60 # Check permissions. Will return 403 if denied, otherwise will
61 # put the appropriate value in the stash.
62 my $ok = _check_permission( $c, $tradition );
65 $c->stash->{'textid'} = $textid;
66 $c->stash->{'tradition'} = $tradition;
69 sub main :Chained('text') :PathPart('') :Args(0) {
71 my $tradition = delete $c->stash->{'tradition'};
72 my $collation = $tradition->collation;
74 # Stash the relationship definitions
75 $c->stash->{'relationship_scopes'} =
76 to_json( find_type_constraint( 'RelationshipScope' )->values );
77 $c->stash->{'ternary_values'} =
78 to_json( find_type_constraint( 'Ternary' )->values );
80 foreach my $type ( sort { _typesort( $a, $b ) } $collation->relations->types ) {
81 next if $type->is_weak;
82 my $struct = { name => $type->name, description => $type->description };
83 push( @reltypeinfo, $struct );
85 $c->stash->{'relationship_types'} = to_json( \@reltypeinfo );
87 # See how big the tradition is. Edges are more important than nodes
88 # when it comes to rendering difficulty.
89 my $numnodes = scalar $collation->readings;
90 my $numedges = scalar $collation->paths;
91 my $length = $collation->end->rank;
92 # We should display no more than roughly 500 nodes, or roughly 700
94 my $segments = $numnodes / 500;
95 if( $numedges / 700 > $segments ) {
96 $segments = $numedges / 700;
98 my $segsize = sprintf( "%.0f", $length / $segments );
99 my $margin = sprintf( "%.0f", $segsize / 10 );
100 if( $segments > 1 ) {
101 # Segment the tradition in order not to overload the browser.
104 while( $r + $margin < $length ) {
108 $c->stash->{'textsegments'} = [];
109 foreach my $i ( 0..$#divs ) {
110 my $seg = { 'start' => $divs[$i] };
111 $seg->{'display'} = "Segment " . ($i+1);
112 push( @{$c->stash->{'textsegments'}}, $seg );
115 my $startseg = $c->req->param('start');
118 # Only render the subgraph from startseg to endseg or to END,
120 my $endseg = $startseg + $segsize + $margin;
121 $svgopts = { 'from' => $startseg };
122 $svgopts->{'to'} = $endseg if $endseg < $collation->end->rank;
123 } elsif( exists $c->stash->{'textsegments'} ) {
124 # This is the unqualified load of a long tradition. We implicitly start
125 # at zero, but go only as far as our segment size.
126 my $endseg = $segsize + $margin;
128 $svgopts = { 'to' => $endseg };
131 my $svg_str = $collation->as_svg( $svgopts );
132 $svg_str =~ s/\n//gs;
133 $c->stash->{'startseg'} = $startseg if defined $startseg;
134 $c->stash->{'svg_string'} = $svg_str;
135 $c->stash->{'text_title'} = $tradition->name;
136 if( $tradition->can('language') && $tradition->language ) {
137 $c->stash->{'text_lang'} = $tradition->language;
138 $c->stash->{'can_morphologize'} = 1;
140 $c->stash->{'text_lang'} = 'Default';
142 $c->stash->{'template'} = 'relate.tt';
147 my $blsort = $a->bindlevel <=> $b->bindlevel;
148 return $blsort if $blsort;
149 return $a->name cmp $b->name;
154 GET relation/help/$language
156 Returns the help window HTML.
160 sub help :Local :Args(1) {
161 my( $self, $c, $lang ) = @_;
162 # Display the morphological help for the language if it is defined.
163 if( $lang && $lang ne 'Default' ) {
164 my $mod = 'Text::Tradition::Language::' . $lang;
168 $c->log->debug("Warning: could not load $mod");
170 my $has_mod = $mod->can('morphology_tags');
172 my $tagset = &$has_mod;
173 $c->stash->{'tagset'} = $tagset;
176 $c->stash->{'template'} = 'relatehelp.tt';
181 GET relation/$textid/relationships
183 Returns the list of relationships defined for this text.
185 POST relation/$textid/relationships { request }
187 Attempts to define the requested relationship within the text. Returns 200 on
188 success or 403 on error.
190 DELETE relation/$textid/relationships { request }
195 sub relationships :Chained('text') :PathPart :Args(0) {
196 my( $self, $c ) = @_;
197 my $tradition = delete $c->stash->{'tradition'};
198 my $ok = _check_permission( $c, $tradition );
200 my $collation = $tradition->collation;
201 my $m = $c->model('Directory');
202 if( $c->request->method eq 'GET' ) {
203 my @pairs = $collation->relationships; # returns the edges
205 foreach my $p ( @pairs ) {
206 my $relobj = $collation->relations->get_relationship( @$p );
207 next if $relobj->type eq 'collated'; # Don't show these
208 next if $p->[0] eq $p->[1]; # HACK until bugfix
209 my $relhash = { source_id => $p->[0], target_id => $p->[1],
210 source_text => $collation->reading( $p->[0] )->text,
211 target_text => $collation->reading( $p->[1] )->text,
212 type => $relobj->type, scope => $relobj->scope,
213 a_derivable_from_b => $relobj->a_derivable_from_b,
214 b_derivable_from_a => $relobj->b_derivable_from_a,
215 non_independent => $relobj->non_independent,
216 is_significant => $relobj->is_significant
218 $relhash->{'note'} = $relobj->annotation if $relobj->has_annotation;
219 push( @all_relations, $relhash );
221 $c->stash->{'result'} = \@all_relations;
223 # Check write permissions first of all
224 if( $c->stash->{'permission'} ne 'full' ) {
225 $c->response->status( '403' );
226 $c->stash->{'result'} = {
227 'error' => 'You do not have permission to modify this tradition.' };
228 $c->detach( 'View::JSON' );
229 } elsif( $c->request->method eq 'POST' ) {
230 my $opts = $c->request->params;
232 # Retrieve the source / target from the options
233 my $node = delete $opts->{source_id};
234 my $target = delete $opts->{target_id};
236 # Make sure we didn't send a blank or invalid relationship type
237 my $relation = $opts->{type};
238 unless( $collation->get_relationship_type( $relation ) ) {
239 my $errmsg = $relation ? "No such relationship type $relation" :
240 "You must specify a relationship type";
241 $c->stash->{'result'} = { error => $errmsg };
242 $c->response->status( '400' );
243 $c->detach( 'View::JSON' );
246 # Keep the data clean
247 my @booleans = qw/ a_derivable_from_b b_derivable_from_a non_independent /;
248 foreach my $k ( keys %$opts ) {
249 if( $opts->{$k} && grep { $_ eq $k } @booleans ) {
254 delete $opts->{scope} unless $opts->{scope};
255 delete $opts->{annotation} unless $opts->{annotation};
256 delete $opts->{is_significant} unless $opts->{is_significant};
257 $opts->{propagate} = 1;
260 my @vectors = $collation->add_relationship( $node, $target, $opts );
261 $c->stash->{'result'} = \@vectors;
262 $m->save( $tradition );
263 } catch( Text::Tradition::Error $e ) {
264 $c->response->status( '403' );
265 $c->stash->{'result'} = { error => $e->message };
267 $c->response->status( '500' );
268 $c->stash->{'result'} = { error => "Something went wrong with the request" };
270 } elsif( $c->request->method eq 'DELETE' ) {
271 my $node = $c->request->param('source_id');
272 my $target = $c->request->param('target_id');
273 my $scopewide = $c->request->param('scopewide')
274 && $c->request->param('scopewide') eq 'true';
276 my @vectors = $collation->del_relationship( $node, $target, $scopewide );
277 $m->save( $tradition );
278 $c->stash->{'result'} = \@vectors;
279 } catch( Text::Tradition::Error $e ) {
280 $c->response->status( '403' );
281 $c->stash->{'result'} = { 'error' => $e->message };
283 $c->response->status( '500' );
284 $c->stash->{'result'} = { error => "Something went wrong with the request" };
288 $c->forward('View::JSON');
293 GET relation/$textid/readings
295 Returns the list of readings defined for this text along with their metadata.
299 my %read_write_keys = (
303 'grammar_invalid' => 1,
308 sub _reading_struct {
310 # Return a JSONable struct of the useful keys. Keys meant to be writable
311 # have a true value; read-only keys have a false value.
313 map { $struct->{$_} = $reading->$_ if $reading->can( $_ ) } keys( %read_write_keys );
315 $struct->{'lexemes'} = $reading->can( 'lexemes' ) ? [ $reading->lexemes ] : [];
316 # Look up any words related via spelling or orthography
319 return $t eq 'spelling' || $t eq 'orthographic';
321 # Now add the list data
322 $struct->{'variants'} = [ map { $_->text } $reading->related_readings( $sameword ) ];
323 $struct->{'witnesses'} = [ $reading->witnesses ];
327 sub readings :Chained('text') :PathPart :Args(0) {
328 my( $self, $c ) = @_;
329 my $tradition = delete $c->stash->{'tradition'};
330 my $ok = _check_permission( $c, $tradition );
332 my $collation = $tradition->collation;
333 my $m = $c->model('Directory');
334 if( $c->request->method eq 'GET' ) {
336 foreach my $rdg ( $collation->readings ) {
337 $rdginfo->{$rdg->id} = _reading_struct( $rdg );
339 $c->stash->{'result'} = $rdginfo;
341 $c->forward('View::JSON');
346 GET relation/$textid/reading/$id
348 Returns the list of readings defined for this text along with their metadata.
350 POST relation/$textid/reading/$id { request }
352 Alters the reading according to the values in request. Returns 403 Forbidden if
353 the alteration isn't allowed.
357 sub reading :Chained('text') :PathPart :Args(1) {
358 my( $self, $c, $reading_id ) = @_;
359 my $tradition = delete $c->stash->{'tradition'};
360 my $collation = $tradition->collation;
361 my $rdg = $collation->reading( $reading_id );
362 my $m = $c->model('Directory');
363 if( $c->request->method eq 'GET' ) {
364 $c->stash->{'result'} = $rdg ? _reading_struct( $rdg )
365 : { 'error' => "No reading with ID $reading_id" };
366 } elsif ( $c->request->method eq 'POST' ) {
367 if( $c->stash->{'permission'} ne 'full' ) {
368 $c->response->status( '403' );
369 $c->stash->{'result'} = {
370 'error' => 'You do not have permission to modify this tradition.' };
371 $c->detach('View::JSON');
375 if( $rdg && $rdg->does('Text::Tradition::Morphology') ) {
376 # Are we re-lemmatizing?
377 if( $c->request->param('relemmatize') ) {
378 my $nf = $c->request->param('normal_form');
379 # TODO throw error unless $nf
380 $rdg->normal_form( $nf );
381 # TODO throw error if lemmatization fails
382 # TODO skip this if normal form hasn't changed
385 # Set all the values that we have for the reading.
386 # TODO error handling
387 foreach my $p ( keys %{$c->request->params} ) {
388 if( $p =~ /^morphology_(\d+)$/ ) {
389 # Set the form on the correct lexeme
390 my $morphval = $c->request->param( $p );
391 next unless $morphval;
393 my $lx = $rdg->lexeme( $midx );
394 my $strrep = $rdg->language . ' // ' . $morphval;
395 my $idx = $lx->has_form( $strrep );
396 unless( defined $idx ) {
397 # Make the word form and add it to the lexeme.
399 $idx = $lx->add_matching_form( $strrep ) - 1;
400 } catch( Text::Tradition::Error $e ) {
401 $c->response->status( '403' );
402 $errmsg = $e->message;
404 # Something else went wrong, probably a Moose error
405 $c->response->status( '500' );
406 $errmsg = 'Something went wrong with the request';
409 $lx->disambiguate( $idx ) if defined $idx;
410 } elsif( $read_write_keys{$p} ) {
411 my $val = _clean_booleans( $rdg, $p, $c->request->param( $p ) );
418 $errmsg = "Reading does not exist or cannot be morphologized";
420 $c->stash->{'result'} = $errmsg ? { 'error' => $errmsg }
421 : _reading_struct( $rdg );
424 $c->forward('View::JSON');
430 POST relation/$textid/merge { data }
432 Merges the requested readings, combining the witnesses of both readings into
433 the target reading. All non-conflicting source relationships are inherited by
434 the target relationship.
438 sub merge :Chained('text') :PathPart :Args(0) {
439 my( $self, $c ) = @_;
440 my $tradition = delete $c->stash->{'tradition'};
441 my $collation = $tradition->collation;
442 my $m = $c->model('Directory');
443 if( $c->request->method eq 'POST' ) {
444 if( $c->stash->{'permission'} ne 'full' ) {
445 $c->response->status( '403' );
446 $c->stash->{'result'} = {
447 'error' => 'You do not have permission to modify this tradition.' };
448 $c->detach('View::JSON');
454 my $main = $c->request->param('target_id');
455 my $second = $c->request->param('source_id');
456 # Find the common successor of these, so that we can detect other
457 # potentially identical readings.
458 my $csucc = $collation->common_successor( $main, $second );
460 # Try the merge if these are parallel readings.
461 if( $csucc->id eq $main || $csucc->id eq $second ) {
462 $errmsg = "Cannot merge readings in the same path";
465 $collation->merge_readings( $main, $second );
466 } catch( Text::Tradition::Error $e ) {
467 $c->response->status( '403' );
468 $errmsg = $e->message;
470 # Something else went wrong, probably a Moose error
471 $c->response->status( '403' );
472 $errmsg = 'Something went wrong with the request';
476 # Look for readings that are now identical.
478 $response = { status => 'error', error => $errmsg };
480 $response = { status => 'ok' };
481 unless( $c->request->param('single') ) {
482 my @identical = $collation->identical_readings(
483 start => $main, end => $csucc->id );
485 $response->{'checkalign'} = [
486 map { [ $_->[0]->id, $_->[1]->id ] } @identical ];
489 $m->save( $collation );
491 $c->stash->{'result'} = $response;
492 $c->forward('View::JSON');
498 POST relation/$textid/duplicate { data }
500 Duplicates the requested readings, detaching the witnesses specified in
501 the list to use the new reading(s) instead of the old. The data to be
502 passed should be a JSON structure:
504 { readings: rid1,rid2,rid3,...
505 witnesses: [ wit1, ... ] }
509 sub duplicate :Chained('text') :PathPart :Args(0) {
510 my( $self, $c ) = @_;
511 my $tradition = delete $c->stash->{'tradition'};
512 my $collation = $tradition->collation;
513 my $m = $c->model('Directory');
514 if( $c->request->method eq 'POST' ) {
515 if( $c->stash->{'permission'} ne 'full' ) {
516 $c->response->status( '403' );
517 $c->stash->{'result'} = {
518 'error' => 'You do not have permission to modify this tradition.' };
519 $c->detach('View::JSON');
524 # Sort out which readings need to be duplicated from the set given, and
525 # ensure that all the given wits bear each relevant reading.
528 map { $wits{$_} = 1 } $c->request->param('witnesses[]');
530 foreach my $rid ( $c->request->param('readings[]') ) {
532 my $rdg = $collation->reading( $rid );
533 foreach my $rwit ( $rdg->witnesses( $rid ) ) {
534 $numwits++ if exists $wits{$rwit};
536 next unless $numwits; # Disregard readings with none of our witnesses
537 if( $numwits < keys( %wits ) ) {
538 $errmsg = "Reading $rid contains some but not all of the specified witnesses.";
540 } elsif( exists $rdgranks{ $rdg->rank } ) {
541 $errmsg = "More than one reading would be detached along with $rid at rank " . $rdg->rank;
544 $rdgranks{ $rdg->rank } = $rid;
548 # Now check that the readings make a single sequence.
551 foreach my $rank ( sort { $a <=> $b } keys %rdgranks ) {
552 my $rid = $rdgranks{$rank};
554 # Check that there is only one path between $prior and $rdg.
555 foreach my $wit ( keys %wits ) {
556 unless( $collation->prior_reading( $rid, $wit ) eq $prior ) {
557 $errmsg = "Diverging witness paths from $prior to $rid at $wit";
566 # Abort if we've run into a problem.
568 $c->stash->{'result'} = { 'error' => $errmsg };
569 $c->response->status( '403' );
570 $c->forward('View::JSON');
574 # Otherwise, do the dirty work.
575 my @witlist = keys %wits;
576 my @deleted_relations;
577 foreach my $rank ( sort { $a <=> $b } keys %rdgranks ) {
579 my $reading_id = $rdgranks{$rank};
582 ( $newrdg, @delrels ) =
583 $collation->duplicate_reading( $reading_id, @witlist );
584 } catch( Text::Tradition::Error $e ) {
585 $c->response->status( '403' );
586 $errmsg = $e->message;
588 # Something else went wrong, probably a Moose error
589 $c->response->status( '500' );
590 $errmsg = 'Something went wrong with the request';
593 my $data = _reading_struct( $newrdg );
594 $data->{'orig_rdg'} = $reading_id;
595 $response->{"$newrdg"} = $data;
596 push( @deleted_relations, @delrels );
600 $c->stash->{'result'} = { 'error' => $errmsg };
602 $m->save( $collation );
603 $response->{'DELETED'} = \@deleted_relations;
604 $c->stash->{'result'} = $response;
607 $c->forward('View::JSON');
612 sub _check_permission {
613 my( $c, $tradition ) = @_;
614 my $user = $c->user_exists ? $c->user->get_object : undef;
615 # Does this user have access?
617 if( $user->is_admin ||
618 ( $tradition->has_user && $tradition->user->id eq $user->id ) ) {
619 $c->stash->{'permission'} = 'full';
624 if( $tradition->public ) {
625 $c->stash->{'permission'} = 'readonly';
629 $c->response->status( 403 );
630 $c->response->body( 'You do not have permission to view this tradition.' );
631 $c->detach( 'View::Plain' );
635 sub _clean_booleans {
636 my( $obj, $param, $val ) = @_;
637 if( $obj->meta->get_attribute( $param )->type_constraint->name eq 'Bool' ) {
638 $val = 1 if $val eq 'true';
639 $val = undef if $val eq 'false';
646 Attempt to render a view, if needed.
650 sub end : ActionClass('RenderView') {}
658 This library is free software. You can redistribute it and/or modify
659 it under the same terms as Perl itself.
663 __PACKAGE__->meta->make_immutable;