add error handling for reading morphology update
[scpubgit/stemmatology.git] / stemmaweb / lib / stemmaweb / Controller / Relation.pm
index 690f44e..8785d6f 100644 (file)
@@ -1,5 +1,6 @@
 package stemmaweb::Controller::Relation;
 use Moose;
+use Module::Load;
 use namespace::autoclean;
 use TryCatch;
 
@@ -39,8 +40,7 @@ Returns a data structure giving the valid types and scopes for a relationship.
 
 sub definitions :Local :Args(0) {
        my( $self, $c ) = @_;
-       my $valid_relationships = [ qw/ spelling orthographic grammatical meaning 
-                                                                       lexical transposition / ];
+       my $valid_relationships = [ qw/ spelling orthographic grammatical lexical transposition / ];
        my $valid_scopes = [ qw/ local global / ];
        $c->stash->{'result'} = { 'types' => $valid_relationships, 'scopes' => $valid_scopes };
        $c->forward('View::JSON');
@@ -56,33 +56,115 @@ sub definitions :Local :Args(0) {
 
 sub text :Chained('/') :PathPart('relation') :CaptureArgs(1) {
        my( $self, $c, $textid ) = @_;
-       $c->stash->{'tradition'} = $c->model('Directory')->tradition( $textid );
+       # If the tradition has more than 500 ranks or so, split it up.
+       my $tradition = $c->model('Directory')->tradition( $textid );
+    # Account for a bad interaction between FastCGI and KiokuDB
+    unless( $tradition->collation->tradition ) {
+        $c->log->warn( "Fixing broken tradition link" );
+        $tradition->collation->_set_tradition( $tradition );
+        $c->model('Directory')->save( $tradition );
+    }
+       # See how big the tradition is. Edges are more important than nodes
+       # when it comes to rendering difficulty.
+       my $numnodes = scalar $tradition->collation->readings;
+       my $numedges = scalar $tradition->collation->paths;
+       my $length = $tradition->collation->end->rank;
+       # We should display no more than roughly 500 nodes, or roughly 700
+       # edges, at a time.
+       my $segments = $numnodes / 500;
+       if( $numedges / 700 > $segments ) {
+               $segments = $numedges / 700;
+       }
+       my $segsize = sprintf( "%.0f", $length / $segments );
+       my $margin = sprintf( "%.0f", $segsize / 10 );
+       if( $segments > 1 ) {
+               # Segment the tradition in order not to overload the browser.
+               my @divs;
+               my $r = 0;
+               while( $r + $margin < $length ) {
+                       push( @divs, $r );
+                       $r += $segsize;
+               }
+               $c->stash->{'textsegments'} = [];
+               $c->stash->{'segsize'} = $segsize;
+               $c->stash->{'margin'} = $margin;
+               foreach my $i ( 0..$#divs ) {
+                       my $seg = { 'start' => $divs[$i] };
+                       $seg->{'display'} = "Segment " . ($i+1);
+                       push( @{$c->stash->{'textsegments'}}, $seg );
+               }
+       }
+       $c->stash->{'textid'} = $textid;
+       $c->stash->{'tradition'} = $tradition;
 }
 
 sub main :Chained('text') :PathPart('') :Args(0) {
        my( $self, $c ) = @_;
+       my $startseg = $c->req->param('start');
        my $tradition = delete $c->stash->{'tradition'};
        my $collation = $tradition->collation;
-       my $svg_str = $collation->as_svg;
+       my $svgopts;
+       if( $startseg ) {
+               # Only render the subgraph from startseg to endseg or to END,
+               # whichever is less.
+               my $endseg = $startseg + $c->stash->{'segsize'} + $c->stash->{'margin'};
+               $svgopts = { 'from' => $startseg };
+               $svgopts->{'to'} = $endseg if $endseg < $collation->end->rank;
+       } elsif( exists $c->stash->{'textsegments'} ) {
+               # This is the unqualified load of a long tradition. We implicitly start 
+               # at zero, but go only as far as 550.
+               my $endseg = $c->stash->{'segsize'} + $c->stash->{'margin'};
+               $startseg = 0;
+               $svgopts = { 'to' => $endseg };
+       }
+       my $svg_str = $collation->as_svg( $svgopts );
        $svg_str =~ s/\n//gs;
+       $c->stash->{'startseg'} = $startseg if defined $startseg;
        $c->stash->{'svg_string'} = $svg_str;
        $c->stash->{'text_title'} = $tradition->name;
+       $c->stash->{'text_lang'} = $tradition->language;
        $c->stash->{'template'} = 'relate.tt';
+}
+
+=head2 help
 
+ GET relation/help/$language
+
+Returns the help window HTML.
+
+=cut
+
+sub help :Local :Args(1) {
+       my( $self, $c, $lang ) = @_;
+       # Display the morphological help for the language if it is defined.
+       if( $lang && $lang ne 'Default' ) {
+               my $mod = 'Text::Tradition::Language::' . $lang;
+               try {
+                       load( $mod );
+               } catch {
+                       $c->log->debug("Warning: could not load $mod");
+               }
+               my $has_mod = $mod->can('morphology_tags');
+               if( $has_mod ) {
+                       my $tagset = &$has_mod;
+                       $c->stash->{'tagset'} = $tagset;
+               }
+       }
+       $c->stash->{'template'} = 'relatehelp.tt';
 }
 
 =head2 relationships
 
- GET $textid/relationships
+ GET relation/$textid/relationships
 
 Returns the list of relationships defined for this text.
 
- POST $textid/relationships { request }
+ POST relation/$textid/relationships { request }
  
 Attempts to define the requested relationship within the text. Returns 200 on
 success or 403 on error.
 
- DELETE $textid/relationships { request }
+ DELETE relation/$textid/relationships { request }
  
 
 =cut
@@ -97,9 +179,12 @@ sub relationships :Chained('text') :PathPart :Args(0) {
                my @all_relations;
                foreach my $p ( @pairs ) {
                        my $relobj = $collation->relations->get_relationship( @$p );
-                       push( @all_relations, 
-                               { source => $p->[0], target => $p->[1], 
-                                 type => $relobj->type, scope => $relobj->scope } );
+                       next if $relobj->type eq 'collated'; # Don't show these
+                       next if $p->[0] eq $p->[1]; # HACK until bugfix
+                       my $relhash = { source => $p->[0], target => $p->[1], 
+                                 type => $relobj->type, scope => $relobj->scope };
+                       $relhash->{'note'} = $relobj->annotation if $relobj->has_annotation;
+                       push( @all_relations, $relhash );
                }
                $c->stash->{'result'} = \@all_relations;
        } elsif( $c->request->method eq 'POST' ) {
@@ -111,6 +196,7 @@ sub relationships :Chained('text') :PathPart :Args(0) {
        
                my $opts = { 'type' => $relation,
                                         'scope' => $scope };
+               $opts->{'annotation'} = $note if $note;
                
                try {
                        my @vectors = $collation->add_relationship( $node, $target, $opts );
@@ -134,8 +220,139 @@ sub relationships :Chained('text') :PathPart :Args(0) {
                }       
        }
        $c->forward('View::JSON');
-}              
-               
+}
+
+=head2 readings
+
+ GET relation/$textid/readings
+
+Returns the list of readings defined for this text along with their metadata.
+
+=cut
+
+my %read_write_keys = (
+       'id' => 0,
+       'text' => 0,
+       'is_meta' => 0,
+       'grammar_invalid' => 1,
+       'is_nonsense' => 1,
+       'normal_form' => 1,
+);
+
+sub _reading_struct {
+       my( $reading ) = @_;
+       # Return a JSONable struct of the useful keys.  Keys meant to be writable
+       # have a true value; read-only keys have a false value.
+       my $struct = {};
+       map { $struct->{$_} = $reading->$_ } keys( %read_write_keys );
+       # Special case
+       $struct->{'lexemes'} = [ $reading->lexemes ];
+       # Look up any words related via spelling or orthography
+       my $sameword = sub { 
+               my $t = $_[0]->type;
+               return $t eq 'spelling' || $t eq 'orthographic';
+       };
+       my @variants;
+       foreach my $sr ( $reading->related_readings( $sameword ) ) {
+               push( @variants, $sr->text );
+       }
+       $struct->{'variants'} = \@variants;
+       return $struct;
+}
+
+sub readings :Chained('text') :PathPart :Args(0) {
+       my( $self, $c ) = @_;
+       my $tradition = delete $c->stash->{'tradition'};
+       my $collation = $tradition->collation;
+       my $m = $c->model('Directory');
+       if( $c->request->method eq 'GET' ) {
+               my $rdginfo = {};
+               foreach my $rdg ( $collation->readings ) {
+                       $rdginfo->{$rdg->id} = _reading_struct( $rdg );
+               }
+               $c->stash->{'result'} = $rdginfo;
+       }
+       $c->forward('View::JSON');
+}
+
+=head2 reading
+
+ GET relation/$textid/reading/$id
+
+Returns the list of readings defined for this text along with their metadata.
+
+ POST relation/$textid/reading/$id { request }
+Alters the reading according to the values in request. Returns 403 Forbidden if
+the alteration isn't allowed.
+
+=cut
+
+sub reading :Chained('text') :PathPart :Args(1) {
+       my( $self, $c, $reading_id ) = @_;
+       my $tradition = delete $c->stash->{'tradition'};
+       my $collation = $tradition->collation;
+       my $rdg = $collation->reading( $reading_id );
+       my $m = $c->model('Directory');
+       if( $c->request->method eq 'GET' ) {
+               $c->stash->{'result'} = $rdg ? _reading_struct( $rdg )
+                       : { 'error' => "No reading with ID $reading_id" };
+       } elsif ( $c->request->method eq 'POST' ) {
+               my $errmsg;
+               # Are we re-lemmatizing?
+               if( $c->request->param('relemmatize') ) {
+                       my $nf = $c->request->param('normal_form');
+                       # TODO throw error unless $nf
+                       $rdg->normal_form( $nf );
+                       # TODO throw error if lemmatization fails
+                       # TODO skip this if normal form hasn't changed
+                       $rdg->lemmatize();
+               } else {
+                       # Set all the values that we have for the reading.
+                       # TODO error handling
+                       foreach my $p ( keys %{$c->request->params} ) {
+                               if( $p =~ /^morphology_(\d+)$/ ) {
+                                       # Set the form on the correct lexeme
+                                       my $midx = $1;
+                                       $c->log->debug( "Fetching lexeme $midx" );
+                                       my $lx = $rdg->lexeme( $midx );
+                                       my $strrep = $rdg->language . ' // ' 
+                                               . $c->request->param( $p );
+                                       my $idx = $lx->has_form( $strrep );
+                                       unless( defined $idx ) {
+                                               # Make the word form and add it to the lexeme.
+                                               $c->log->debug("Adding new form for $strrep");
+                                               try {
+                                                       $idx = $lx->add_matching_form( $strrep ) - 1;
+                                               } catch( Text::Tradition::Error $e ) {
+                                                       $c->response->status( '403' );
+                                                       $errmsg = $e->message;
+                                               }
+                                       }
+                                       $lx->disambiguate( $idx ) if defined $idx;
+                               } elsif( $read_write_keys{$p} ) {
+                                       my $val = _clean_booleans( $rdg, $p, $c->request->param( $p ) );
+                                       $rdg->$p( $val );
+                               }
+                       }               
+               }
+               $m->save( $tradition );
+               $c->stash->{'result'} = $errmsg ? { 'error' => $errmsg }
+                       : _reading_struct( $rdg );
+
+       }
+       $c->forward('View::JSON');
+
+}
+
+sub _clean_booleans {
+       my( $rdg, $param, $val ) = @_;
+       if( $rdg->meta->get_attribute( $param )->type_constraint->name eq 'Bool' ) {
+               $val = 1 if $val eq 'true';
+               $val = undef if $val eq 'false';
+       } 
+       return $val;
+}
 
 =head2 end