query dynamically for relationship types in rel mapper
[scpubgit/stemmaweb.git] / lib / stemmaweb / Controller / Relation.pm
index 961cfa1..be51983 100644 (file)
@@ -30,22 +30,6 @@ sub index :Path :Args(0) {
        $c->stash->{'template'} = 'relate.tt';
 }
 
-=head2 definitions
-
- GET relation/definitions
-Returns a data structure giving the valid types and scopes for a relationship.
-
-=cut
-
-sub definitions :Local :Args(0) {
-       my( $self, $c ) = @_;
-       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');
-}
-
 =head2 text
 
  GET relation/$textid/
@@ -56,8 +40,14 @@ sub definitions :Local :Args(0) {
 
 sub text :Chained('/') :PathPart('relation') :CaptureArgs(1) {
        my( $self, $c, $textid ) = @_;
-       # If the tradition has more than 500 ranks or so, split it up.
        my $tradition = $c->model('Directory')->tradition( $textid );
+       unless( $tradition ) {
+               $c->response->status('404');
+               $c->response->body("No such tradition with ID $textid");
+               $c->detach('View::Plain');
+               return;
+       }
+       
     # Account for a bad interaction between FastCGI and KiokuDB
     unless( $tradition->collation->tradition ) {
         $c->log->warn( "Fixing broken tradition link" );
@@ -69,11 +59,20 @@ sub text :Chained('/') :PathPart('relation') :CaptureArgs(1) {
     my $ok = _check_permission( $c, $tradition );
     return unless $ok;
 
+       $c->stash->{'textid'} = $textid;
+       $c->stash->{'tradition'} = $tradition;
+}
+
+sub main :Chained('text') :PathPart('') :Args(0) {
+       my( $self, $c ) = @_;
+       my $tradition = delete $c->stash->{'tradition'};
+       my $collation = $tradition->collation;
+       
        # 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;
+       my $numnodes = scalar $collation->readings;
+       my $numedges = scalar $collation->paths;
+       my $length = $collation->end->rank;
        # We should display no more than roughly 500 nodes, or roughly 700
        # edges, at a time.
        my $segments = $numnodes / 500;
@@ -91,46 +90,64 @@ sub text :Chained('/') :PathPart('relation') :CaptureArgs(1) {
                        $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 $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'};
+               my $endseg = $startseg + $segsize + $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'};
+               # at zero, but go only as far as our segment size.
+               my $endseg = $segsize + $margin;
                $startseg = 0;
                $svgopts = { 'to' => $endseg };
        }
+       # Spit out the SVG
        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;
+       if( $tradition->can('language') ) {
+               $c->stash->{'text_lang'} = $tradition->language;
+               $c->stash->{'can_morphologize'} = 1;
+       } else {
+               $c->stash->{'text_lang'} = 'Default';
+       }
        $c->stash->{'template'} = 'relate.tt';
 }
 
+=head2 definitions
+
+ GET relation/$textid/definitions
+Returns a data structure giving the valid types and scopes for a relationship in
+this tradition.
+
+=cut
+
+sub definitions :Chained('text') :PathPart :Args(0) {
+       my( $self, $c ) = @_;
+       my $tradition = delete $c->stash->{'tradition'};
+       my @valid_relationships = map { $_->name } grep { !$_->is_weak }
+               $tradition->collation->relations->types;
+       my $valid_scopes = [ qw/ local global / ];
+       $c->stash->{'result'} = { 
+               'types' => \@valid_relationships, 
+               'scopes' => $valid_scopes 
+       };
+       $c->forward('View::JSON');
+}
+
 =head2 help
 
  GET relation/help/$language
@@ -213,8 +230,8 @@ sub relationships :Chained('text') :PathPart :Args(0) {
                        my $note = $c->request->param('note');
                        my $scope = $c->request->param('scope');
                
-                       my $opts = { 'type' => $relation,
-                                                'scope' => $scope };
+                       my $opts = { 'type' => $relation, 'propagate' => 1 };
+                       $opts->{'scope'} = $scope if $scope;
                        $opts->{'annotation'} = $note if $note;
                        
                        try {
@@ -264,9 +281,9 @@ sub _reading_struct {
        # 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 );
+       map { $struct->{$_} = $reading->$_ if $reading->can( $_ ) } keys( %read_write_keys );
        # Special case
-       $struct->{'lexemes'} = [ $reading->lexemes ];
+       $struct->{'lexemes'} = $reading->can( 'lexemes' ) ? [ $reading->lexemes ] : [];
        # Look up any words related via spelling or orthography
        my $sameword = sub { 
                my $t = $_[0]->type;
@@ -325,49 +342,54 @@ sub reading :Chained('text') :PathPart :Args(1) {
                        $c->stash->{'result'} = { 
                                'error' => 'You do not have permission to view this tradition.' };
                        $c->detach('View::JSON');
+                       return;
                }
                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 $morphval = $c->request->param( $p );
-                                       next unless $morphval;
-                                       my $midx = $1;
-                                       my $lx = $rdg->lexeme( $midx );
-                                       my $strrep = $rdg->language . ' // ' . $morphval;
-                                       my $idx = $lx->has_form( $strrep );
-                                       unless( defined $idx ) {
-                                               # Make the word form and add it to the lexeme.
-                                               try {
-                                                       $idx = $lx->add_matching_form( $strrep ) - 1;
-                                               } catch( Text::Tradition::Error $e ) {
-                                                       $c->response->status( '403' );
-                                                       $errmsg = $e->message;
-                                               } catch {
-                                                       # Something else went wrong, probably a Moose error
-                                                       $c->response->status( '403' );
-                                                       $errmsg = 'Something went wrong with the request';      
+               if( $rdg && $rdg->does('Text::Tradition::Morphology') ) {
+                       # 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 $morphval = $c->request->param( $p );
+                                               next unless $morphval;
+                                               my $midx = $1;
+                                               my $lx = $rdg->lexeme( $midx );
+                                               my $strrep = $rdg->language . ' // ' . $morphval;
+                                               my $idx = $lx->has_form( $strrep );
+                                               unless( defined $idx ) {
+                                                       # Make the word form and add it to the lexeme.
+                                                       try {
+                                                               $idx = $lx->add_matching_form( $strrep ) - 1;
+                                                       } catch( Text::Tradition::Error $e ) {
+                                                               $c->response->status( '403' );
+                                                               $errmsg = $e->message;
+                                                       } catch {
+                                                               # Something else went wrong, probably a Moose error
+                                                               $c->response->status( '403' );
+                                                               $errmsg = 'Something went wrong with the request';      
+                                                       }
                                                }
+                                               $lx->disambiguate( $idx ) if defined $idx;
+                                       } elsif( $read_write_keys{$p} ) {
+                                               my $val = _clean_booleans( $rdg, $p, $c->request->param( $p ) );
+                                               $rdg->$p( $val );
                                        }
-                                       $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( $rdg );
+               } else {
+                       $errmsg = "Reading does not exist or cannot be morphologized";
                }
-               $m->save( $rdg );
                $c->stash->{'result'} = $errmsg ? { 'error' => $errmsg }
                        : _reading_struct( $rdg );
 
@@ -379,20 +401,24 @@ sub reading :Chained('text') :PathPart :Args(1) {
 sub _check_permission {
        my( $c, $tradition ) = @_;
     my $user = $c->user_exists ? $c->user->get_object : undef;
+    # Does this user have access?
     if( $user ) {
-       $c->stash->{'permission'} = 'full'
-               if( $user->is_admin || $tradition->user->id eq $user->id );
-       return 1;
-    } elsif( $tradition->public ) {
+               if( $user->is_admin || 
+                       ( $tradition->has_user && $tradition->user->id eq $user->id ) ) {
+                       $c->stash->{'permission'} = 'full';
+                       return 1;
+               }
+    } 
+    # Is it public?
+    if( $tradition->public ) {
        $c->stash->{'permission'} = 'readonly';
        return 1;
-    } else {
-       # Forbidden!
-       $c->response->status( 403 );
-       $c->response->body( 'You do not have permission to view this tradition.' );
-       $c->detach( 'View::Plain' );
-       return 0;
-    }
+    } 
+       # Forbidden!
+       $c->response->status( 403 );
+       $c->response->body( 'You do not have permission to view this tradition.' );
+       $c->detach( 'View::Plain' );
+       return 0;
 }
 
 sub _clean_booleans {