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') ) {
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 $opts->{propagate} = 1;
259 my @vectors = $collation->add_relationship( $node, $target, $opts );
260 $c->stash->{'result'} = \@vectors;
261 $m->save( $tradition );
262 } catch( Text::Tradition::Error $e ) {
263 $c->response->status( '403' );
264 $c->stash->{'result'} = { 'error' => $e->message };
266 } elsif( $c->request->method eq 'DELETE' ) {
267 my $node = $c->request->param('source_id');
268 my $target = $c->request->param('target_id');
269 my $scopewide = $c->request->param('scopewide')
270 && $c->request->param('scopewide') eq 'true';
272 my @vectors = $collation->del_relationship( $node, $target, $scopewide );
273 $m->save( $tradition );
274 $c->stash->{'result'} = \@vectors;
275 } catch( Text::Tradition::Error $e ) {
276 $c->response->status( '403' );
277 $c->stash->{'result'} = { 'error' => $e->message };
281 $c->forward('View::JSON');
286 GET relation/$textid/readings
288 Returns the list of readings defined for this text along with their metadata.
292 my %read_write_keys = (
296 'grammar_invalid' => 1,
301 sub _reading_struct {
303 # Return a JSONable struct of the useful keys. Keys meant to be writable
304 # have a true value; read-only keys have a false value.
306 map { $struct->{$_} = $reading->$_ if $reading->can( $_ ) } keys( %read_write_keys );
308 $struct->{'lexemes'} = $reading->can( 'lexemes' ) ? [ $reading->lexemes ] : [];
309 # Look up any words related via spelling or orthography
312 return $t eq 'spelling' || $t eq 'orthographic';
314 # Now add the list data
315 $struct->{'variants'} = [ map { $_->text } $reading->related_readings( $sameword ) ];
316 $struct->{'witnesses'} = [ $reading->witnesses ];
320 sub readings :Chained('text') :PathPart :Args(0) {
321 my( $self, $c ) = @_;
322 my $tradition = delete $c->stash->{'tradition'};
323 my $ok = _check_permission( $c, $tradition );
325 my $collation = $tradition->collation;
326 my $m = $c->model('Directory');
327 if( $c->request->method eq 'GET' ) {
329 foreach my $rdg ( $collation->readings ) {
330 $rdginfo->{$rdg->id} = _reading_struct( $rdg );
332 $c->stash->{'result'} = $rdginfo;
334 $c->forward('View::JSON');
339 GET relation/$textid/reading/$id
341 Returns the list of readings defined for this text along with their metadata.
343 POST relation/$textid/reading/$id { request }
345 Alters the reading according to the values in request. Returns 403 Forbidden if
346 the alteration isn't allowed.
350 sub reading :Chained('text') :PathPart :Args(1) {
351 my( $self, $c, $reading_id ) = @_;
352 my $tradition = delete $c->stash->{'tradition'};
353 my $collation = $tradition->collation;
354 my $rdg = $collation->reading( $reading_id );
355 my $m = $c->model('Directory');
356 if( $c->request->method eq 'GET' ) {
357 $c->stash->{'result'} = $rdg ? _reading_struct( $rdg )
358 : { 'error' => "No reading with ID $reading_id" };
359 } elsif ( $c->request->method eq 'POST' ) {
360 if( $c->stash->{'permission'} ne 'full' ) {
361 $c->response->status( '403' );
362 $c->stash->{'result'} = {
363 'error' => 'You do not have permission to modify this tradition.' };
364 $c->detach('View::JSON');
368 if( $rdg && $rdg->does('Text::Tradition::Morphology') ) {
369 # Are we re-lemmatizing?
370 if( $c->request->param('relemmatize') ) {
371 my $nf = $c->request->param('normal_form');
372 # TODO throw error unless $nf
373 $rdg->normal_form( $nf );
374 # TODO throw error if lemmatization fails
375 # TODO skip this if normal form hasn't changed
378 # Set all the values that we have for the reading.
379 # TODO error handling
380 foreach my $p ( keys %{$c->request->params} ) {
381 if( $p =~ /^morphology_(\d+)$/ ) {
382 # Set the form on the correct lexeme
383 my $morphval = $c->request->param( $p );
384 next unless $morphval;
386 my $lx = $rdg->lexeme( $midx );
387 my $strrep = $rdg->language . ' // ' . $morphval;
388 my $idx = $lx->has_form( $strrep );
389 unless( defined $idx ) {
390 # Make the word form and add it to the lexeme.
392 $idx = $lx->add_matching_form( $strrep ) - 1;
393 } catch( Text::Tradition::Error $e ) {
394 $c->response->status( '403' );
395 $errmsg = $e->message;
397 # Something else went wrong, probably a Moose error
398 $c->response->status( '403' );
399 $errmsg = 'Something went wrong with the request';
402 $lx->disambiguate( $idx ) if defined $idx;
403 } elsif( $read_write_keys{$p} ) {
404 my $val = _clean_booleans( $rdg, $p, $c->request->param( $p ) );
411 $errmsg = "Reading does not exist or cannot be morphologized";
413 $c->stash->{'result'} = $errmsg ? { 'error' => $errmsg }
414 : _reading_struct( $rdg );
417 $c->forward('View::JSON');
423 POST relation/$textid/merge { data }
425 Merges the requested readings, combining the witnesses of both readings into
426 the target reading. All non-conflicting source relationships are inherited by
427 the target relationship.
431 sub merge :Chained('text') :PathPart :Args(0) {
432 my( $self, $c ) = @_;
433 my $tradition = delete $c->stash->{'tradition'};
434 my $collation = $tradition->collation;
435 my $m = $c->model('Directory');
436 if( $c->request->method eq 'POST' ) {
437 if( $c->stash->{'permission'} ne 'full' ) {
438 $c->response->status( '403' );
439 $c->stash->{'result'} = {
440 'error' => 'You do not have permission to modify this tradition.' };
441 $c->detach('View::JSON');
447 my $main = $c->request->param('target_id');
448 my $second = $c->request->param('source_id');
449 # Find the common successor of these, so that we can detect other
450 # potentially identical readings.
451 my $csucc = $collation->common_successor( $main, $second );
453 # Try the merge if these are parallel readings.
454 if( $csucc->id eq $main || $csucc->id eq $second ) {
455 $errmsg = "Cannot merge readings in the same path";
458 $collation->merge_readings( $main, $second );
459 } catch( Text::Tradition::Error $e ) {
460 $c->response->status( '403' );
461 $errmsg = $e->message;
463 # Something else went wrong, probably a Moose error
464 $c->response->status( '403' );
465 $errmsg = 'Something went wrong with the request';
469 # Look for readings that are now identical.
471 $response = { status => 'error', error => $errmsg };
473 $response = { status => 'ok' };
474 unless( $c->request->param('single') ) {
475 my @identical = $collation->identical_readings(
476 start => $main, end => $csucc->id );
478 $response->{'checkalign'} = [
479 map { [ $_->[0]->id, $_->[1]->id ] } @identical ];
482 $m->save( $collation );
484 $c->stash->{'result'} = $response;
485 $c->forward('View::JSON');
491 POST relation/$textid/duplicate { data }
493 Duplicates the requested readings, detaching the witnesses specified in
494 the list to use the new reading(s) instead of the old. The data to be
495 passed should be a JSON structure:
497 { readings: rid1,rid2,rid3,...
498 witnesses: [ wit1, ... ] }
502 sub duplicate :Chained('text') :PathPart :Args(0) {
503 my( $self, $c ) = @_;
504 my $tradition = delete $c->stash->{'tradition'};
505 my $collation = $tradition->collation;
506 my $m = $c->model('Directory');
507 if( $c->request->method eq 'POST' ) {
508 if( $c->stash->{'permission'} ne 'full' ) {
509 $c->response->status( '403' );
510 $c->stash->{'result'} = {
511 'error' => 'You do not have permission to modify this tradition.' };
512 $c->detach('View::JSON');
517 # Sort out which readings need to be duplicated from the set given, and
518 # ensure that all the given wits bear each relevant reading.
521 map { $wits{$_} = 1 } $c->request->param('witnesses[]');
523 foreach my $rid ( $c->request->param('readings[]') ) {
525 my $rdg = $collation->reading( $rid );
526 foreach my $rwit ( $rdg->witnesses( $rid ) ) {
527 $numwits++ if exists $wits{$rwit};
529 next unless $numwits; # Disregard readings with none of our witnesses
530 if( $numwits < keys( %wits ) ) {
531 $errmsg = "Reading $rid contains some but not all of the specified witnesses.";
533 } elsif( exists $rdgranks{ $rdg->rank } ) {
534 $errmsg = "More than one reading would be detached along with $rid at rank " . $rdg->rank;
537 $rdgranks{ $rdg->rank } = $rid;
541 # Now check that the readings make a single sequence.
544 foreach my $rank ( sort { $a <=> $b } keys %rdgranks ) {
545 my $rid = $rdgranks{$rank};
547 # Check that there is only one path between $prior and $rdg.
548 foreach my $wit ( keys %wits ) {
549 unless( $collation->prior_reading( $rid, $wit ) eq $prior ) {
550 $errmsg = "Diverging witness paths from $prior to $rid at $wit";
559 # Abort if we've run into a problem.
561 $c->stash->{'result'} = { 'error' => $errmsg };
562 $c->response->status( '403' );
563 $c->forward('View::JSON');
567 # Otherwise, do the dirty work.
568 my @witlist = keys %wits;
569 my @deleted_relations;
570 foreach my $rank ( sort { $a <=> $b } keys %rdgranks ) {
572 my $reading_id = $rdgranks{$rank};
575 ( $newrdg, @delrels ) =
576 $collation->duplicate_reading( $reading_id, @witlist );
577 } catch( Text::Tradition::Error $e ) {
578 $c->response->status( '403' );
579 $errmsg = $e->message;
581 # Something else went wrong, probably a Moose error
582 $c->response->status( '403' );
583 $errmsg = 'Something went wrong with the request';
586 my $data = _reading_struct( $newrdg );
587 $data->{'orig_rdg'} = $reading_id;
588 $response->{"$newrdg"} = $data;
589 push( @deleted_relations, @delrels );
593 $c->stash->{'result'} = { 'error' => $errmsg };
595 $m->save( $collation );
596 $response->{'DELETED'} = \@deleted_relations;
597 $c->stash->{'result'} = $response;
600 $c->forward('View::JSON');
605 sub _check_permission {
606 my( $c, $tradition ) = @_;
607 my $user = $c->user_exists ? $c->user->get_object : undef;
608 # Does this user have access?
610 if( $user->is_admin ||
611 ( $tradition->has_user && $tradition->user->id eq $user->id ) ) {
612 $c->stash->{'permission'} = 'full';
617 if( $tradition->public ) {
618 $c->stash->{'permission'} = 'readonly';
622 $c->response->status( 403 );
623 $c->response->body( 'You do not have permission to view this tradition.' );
624 $c->detach( 'View::Plain' );
628 sub _clean_booleans {
629 my( $obj, $param, $val ) = @_;
630 if( $obj->meta->get_attribute( $param )->type_constraint->name eq 'Bool' ) {
631 $val = 1 if $val eq 'true';
632 $val = undef if $val eq 'false';
639 Attempt to render a view, if needed.
643 sub end : ActionClass('RenderView') {}
651 This library is free software. You can redistribute it and/or modify
652 it under the same terms as Perl itself.
656 __PACKAGE__->meta->make_immutable;