X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Fstemmaweb%2FController%2FRelation.pm;h=be519833c066eafae7a5bb4646835c172a21d3b7;hb=8843c8b9a186dda97aaf7864ac2e2eec41db177c;hp=008262406d4c170e3b7f8090268123c3312c4378;hpb=d58766c062530ab9f1ffb35e095eadfaebc4f610;p=scpubgit%2Fstemmaweb.git

diff --git a/lib/stemmaweb/Controller/Relation.pm b/lib/stemmaweb/Controller/Relation.pm
index 0082624..be51983 100644
--- a/lib/stemmaweb/Controller/Relation.pm
+++ b/lib/stemmaweb/Controller/Relation.pm
@@ -1,5 +1,6 @@
 package stemmaweb::Controller::Relation;
 use Moose;
+use Module::Load;
 use namespace::autoclean;
 use TryCatch;
 
@@ -29,35 +30,6 @@ sub index :Path :Args(0) {
 	$c->stash->{'template'} = 'relate.tt';
 }
 
-=head2 help
-
- GET relation/help
-
-Returns the help window HTML.
-
-=cut
-
-sub help :Local :Args(0) {
-	my( $self, $c ) = @_;
-	$c->stash->{'template'} = 'relatehelp.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/
@@ -68,13 +40,39 @@ 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" );
+        $tradition->collation->_set_tradition( $tradition );
+        $c->model('Directory')->save( $tradition );
+    }
+    # Check permissions. Will return 403 if denied, otherwise will
+    # put the appropriate value in the stash.
+    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;
@@ -92,46 +90,91 @@ 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 );
 		}
 	}
-	$DB::single = 1;
-	$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;
+	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
+
+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
@@ -151,6 +194,8 @@ success or 403 on error.
 sub relationships :Chained('text') :PathPart :Args(0) {
 	my( $self, $c ) = @_;
 	my $tradition = delete $c->stash->{'tradition'};
+	my $ok = _check_permission( $c, $tradition );
+	return unless $ok;
 	my $collation = $tradition->collation;
 	my $m = $c->model('Directory');
 	if( $c->request->method eq 'GET' ) {
@@ -159,47 +204,231 @@ sub relationships :Chained('text') :PathPart :Args(0) {
 		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 ) {
+	} else {
+		# Check write permissions first of all
+		if( $c->stash->{'permission'} ne 'full' ) {
 			$c->response->status( '403' );
-			$c->stash->{'result'} = { 'error' => $e->message };
+			$c->stash->{'result'} = { 
+				'error' => 'You do not have permission to view this tradition.' };
+		} elsif( $c->request->method eq 'POST' ) {
+			unless( $c->stash->{'permission'} eq 'full' ) {
+				$c->response->status( '403' );
+				$c->stash->{'result'} = { 
+					'error' => 'You do not have permission to view this tradition.' };
+				$c->detach( 'View::JSON' );
+			}	
+			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, 'propagate' => 1 };
+			$opts->{'scope'} = $scope if $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 };
+			}	
 		}
-	} 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->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->$_ if $reading->can( $_ ) } keys( %read_write_keys );
+	# Special case
+	$struct->{'lexemes'} = $reading->can( '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 $ok = _check_permission( $c, $tradition );
+	return unless $ok;
+	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' ) {
+		if( $c->stash->{'permission'} ne 'full' ) {
 			$c->response->status( '403' );
-			$c->stash->{'result'} = { 'error' => $e->message };
-		}	
+			$c->stash->{'result'} = { 
+				'error' => 'You do not have permission to view this tradition.' };
+			$c->detach('View::JSON');
+			return;
+		}
+		my $errmsg;
+		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 );
+					}
+				}		
+			}
+			$m->save( $rdg );
+		} else {
+			$errmsg = "Reading does not exist or cannot be morphologized";
+		}
+		$c->stash->{'result'} = $errmsg ? { 'error' => $errmsg }
+			: _reading_struct( $rdg );
+
 	}
 	$c->forward('View::JSON');
-}		
-		
+
+}
+
+sub _check_permission {
+	my( $c, $tradition ) = @_;
+    my $user = $c->user_exists ? $c->user->get_object : undef;
+    # Does this user have access?
+    if( $user ) {
+   		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;
+    } 
+	# 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 {
+	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