X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=stemmaweb%2Flib%2Fstemmaweb%2FController%2FRelation.pm;h=8785d6fc108c133f4d77ae969fabada6d75f5641;hb=a7f4020a1a1fd72aba6e25dc0a8f8aa9a1891202;hp=25b91de28ddc4c11600c46469de3ca92e39cff18;hpb=1c0900efd0c09bdf8086e15d8c85f046ebb42960;p=scpubgit%2Fstemmatology.git

diff --git a/stemmaweb/lib/stemmaweb/Controller/Relation.pm b/stemmaweb/lib/stemmaweb/Controller/Relation.pm
index 25b91de..8785d6f 100644
--- a/stemmaweb/lib/stemmaweb/Controller/Relation.pm
+++ b/stemmaweb/lib/stemmaweb/Controller/Relation.pm
@@ -1,5 +1,6 @@
 package stemmaweb::Controller::Relation;
 use Moose;
+use Module::Load;
 use namespace::autoclean;
 use TryCatch;
 
@@ -24,24 +25,12 @@ Renders the application for the text identified by $textid.
 
 =cut
 
-sub index :Path :Args(1) {
-	my( $self, $c, $textid ) = @_;
-	my $m = $c->model('Directory');
-	my $tradition = $m->tradition( $textid );
-	my $collation = $tradition->collation;
-	my $svg_str = $collation->as_svg;
-	$svg_str =~ s/\n//gs;
-	$c->stash->{'svg_string'} = $svg_str;
+sub index :Path :Args(0) {
+	my( $self, $c ) = @_;
 	$c->stash->{'template'} = 'relate.tt';
 }
 
-sub dispatcher :Path :Args(2) {
-	my( $self, $c, $textid, $forward ) = @_;
-	$c->stash->{'tradition'} = $c->model('Directory')->tradition( $textid );
-	$c->forward( $forward );	
-}
-
-=head2 relationship_definition
+=head2 definitions
 
  GET relation/definitions
  
@@ -51,75 +40,319 @@ 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 / ];
+	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 relationship
-
- POST relation/$textid/relationship
-   source_id: $source, target_id: $target, rel_type: $type, scope: $scope
-   
-Sets the specified relationship between the readings in $source and $target.
-Returns 200 and a list of node pairs where the relationship was added on success;
-returns 403 and an { error: message } struct on failure.
+=head2 text
 
+ GET relation/$textid/
+ 
+ Runs the relationship mapper for the specified text ID.
+ 
 =cut
 
-sub relationship :Private {
+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 );
+    # 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 $node = $c->request->param('source_id');
-	my $target = $c->request->param('target_id');
-	my $relation = $c->request->param('rel_type');
-	my $note = $c->request->param('note');
-	my $scope = $c->request->param('scope');
-
-	my $opts = { 'type' => $relation,
-				 'scope' => $scope };
-	
-	try {
-		my @vectors = $collation->add_relationship( $node, $target, $opts );
-		my $m = $c->model('Directory');
-		$m->save( $tradition );
-		$c->stash->{'result'} = \@vectors;
-	} catch( Text::Tradition::Error $e ) {
-		$c->response->status( '403' );
-		$c->stash->{'result'} = { 'error' => $e->message };
+	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 };
 	}
-	$c->forward('View::JSON');
+	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 relation/$textid/relationships
 
-Returns a list of relationships that exist in the specified text. Each
-relationship is returned in a struct that looks like:
+Returns the list of relationships defined for this text.
 
-{ source: $sid, target: $tid, type: $rel_type, scope: $rel_scope }
+ POST relation/$textid/relationships { request }
+ 
+Attempts to define the requested relationship within the text. Returns 200 on
+success or 403 on error.
+
+ DELETE relation/$textid/relationships { request }
+ 
 
 =cut
 
-sub relationships :Private {
+sub relationships :Chained('text') :PathPart :Args(0) {
 	my( $self, $c ) = @_;
-	my $collation = delete $c->stash->{'collation'};
-	# TODO make this API
-	my @pairs = $collation->relationships; # returns the edges
-	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 } );
+	my $tradition = delete $c->stash->{'tradition'};
+	my $collation = $tradition->collation;
+	my $m = $c->model('Directory');
+	if( $c->request->method eq 'GET' ) {
+		my @pairs = $collation->relationships; # returns the edges
+		my @all_relations;
+		foreach my $p ( @pairs ) {
+			my $relobj = $collation->relations->get_relationship( @$p );
+			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' ) {
+		my $node = $c->request->param('source_id');
+		my $target = $c->request->param('target_id');
+		my $relation = $c->request->param('rel_type');
+		my $note = $c->request->param('note');
+		my $scope = $c->request->param('scope');
+	
+		my $opts = { 'type' => $relation,
+					 'scope' => $scope };
+		$opts->{'annotation'} = $note if $note;
+		
+		try {
+			my @vectors = $collation->add_relationship( $node, $target, $opts );
+			$c->stash->{'result'} = \@vectors;
+			$m->save( $tradition );
+		} catch( Text::Tradition::Error $e ) {
+			$c->response->status( '403' );
+			$c->stash->{'result'} = { 'error' => $e->message };
+		}
+	} elsif( $c->request->method eq 'DELETE' ) {
+		my $node = $c->request->param('source_id');
+		my $target = $c->request->param('target_id');
+	
+		try {
+			my @vectors = $collation->del_relationship( $node, $target );
+			$m->save( $tradition );
+			$c->stash->{'result'} = \@vectors;
+		} catch( Text::Tradition::Error $e ) {
+			$c->response->status( '403' );
+			$c->stash->{'result'} = { 'error' => $e->message };
+		}	
+	}
+	$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->stash->{'result'} = \@all_relations;
 	$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