[scpubgit/stemmaweb.git] / lib / stemmaweb / Controller / Relation.pm

package stemmaweb::Controller::Relation;
use JSON qw/ to_json /;
use Moose;
use Module::Load;
use namespace::autoclean;
use TryCatch;

BEGIN { extends 'Catalyst::Controller' }


=head1 NAME

stemmaweb::Controller::Relation - Controller for the relationship mapper

=head1 DESCRIPTION

The reading relationship mapper with draggable nodes.

=head1 METHODS

=head2 index

 GET relation/$textid
 
Renders the application for the text identified by $textid.

=cut

sub index :Path :Args(0) {
	my( $self, $c ) = @_;
	$c->stash->{'template'} = 'relate.tt';
}

=head2 text

 GET relation/$textid/
 
 Runs the relationship mapper for the specified text ID.
 
=cut

sub text :Chained('/') :PathPart('relation') :CaptureArgs(1) {
	my( $self, $c, $textid ) = @_;
	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;
	
	# Stash the relationship definitions
	$c->stash->{'relationship_scopes'} = to_json( [ qw/ local global / ] );
	my @reltypeinfo;
	foreach my $type ( sort { _typesort( $a, $b ) } $collation->relations->types ) {
		next if $type->is_weak;
		my $struct = { name => $type->name, description => $type->description };
		push( @reltypeinfo, $struct );
	}
	$c->stash->{'relationship_types'} = to_json( \@reltypeinfo );
	
	# See how big the tradition is. Edges are more important than nodes
	# when it comes to rendering difficulty.
	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;
	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'} = [];
		foreach my $i ( 0..$#divs ) {
			my $seg = { 'start' => $divs[$i] };
			$seg->{'display'} = "Segment " . ($i+1);
			push( @{$c->stash->{'textsegments'}}, $seg );
		}
	}
	my $startseg = $c->req->param('start');
	my $svgopts;
	if( $startseg ) {
		# Only render the subgraph from startseg to endseg or to END,
		# whichever is less.
		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 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';
}

sub _typesort {
	my( $a, $b ) = @_;
	my $blsort = $a->bindlevel <=> $b->bindlevel;
	return $blsort if $blsort;
	return $a->name cmp $b->name;
}

=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 the list of relationships defined for this text.

 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 :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 @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;
	} else {
		# Check write permissions first of all
		if( $c->stash->{'permission'} ne 'full' ) {
			$c->response->status( '403' );
			$c->stash->{'result'} = { 
				'error' => 'You do not have permission to modify this tradition.' };
			$c->detach( 'View::JSON' );
		} 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, '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 };
			}	
		}
	}
	$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' => '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

Attempt to render a view, if needed.

=cut

sub end : ActionClass('RenderView') {}

=head1 AUTHOR

Tara L Andrews

=head1 LICENSE

This library is free software. You can redistribute it and/or modify
it under the same terms as Perl itself.

=cut

__PACKAGE__->meta->make_immutable;

1;
Commit	Line	Data
b8a92065	1	package stemmaweb::Controller::Relation;
56e3972e	2	use JSON qw/ to_json /;
b8a92065	3	use Moose;
cc86fa11	4	use Module::Load;
b8a92065	5	use namespace::autoclean;
b28e606e	6	use TryCatch;
b8a92065	7
	8	BEGIN { extends 'Catalyst::Controller' }
	9
	10
	11	=head1 NAME
	12
	13	stemmaweb::Controller::Relation - Controller for the relationship mapper
	14
	15	=head1 DESCRIPTION
	16
b28e606e	17	The reading relationship mapper with draggable nodes.
b8a92065	18
	19	=head1 METHODS
	20
b28e606e	21	=head2 index
b28e606e	22
b8a92065	23	GET relation/$textid
	24
	25	Renders the application for the text identified by $textid.
	26
b8a92065	27	=cut
b8a92065	28
9529f69c	29	sub index :Path :Args(0) {
9529f69c	30	my( $self, $c ) = @_;
b28e606e	31	$c->stash->{'template'} = 'relate.tt';
	32	}
	33
9529f69c	34	=head2 text
b28e606e	35
9529f69c	36	GET relation/$textid/
	37
	38	Runs the relationship mapper for the specified text ID.
	39
b28e606e	40	=cut
b28e606e	41
9529f69c	42	sub text :Chained('/') :PathPart('relation') :CaptureArgs(1) {
9529f69c	43	my( $self, $c, $textid ) = @_;
13aa153c	44	my $tradition = $c->model('Directory')->tradition( $textid );
cd3f7f55	45	unless( $tradition ) {
	46	$c->response->status('404');
	47	$c->response->body("No such tradition with ID $textid");
	48	$c->detach('View::Plain');
	49	return;
	50	}
	51
7562a27b	52	# Account for a bad interaction between FastCGI and KiokuDB
	53	unless( $tradition->collation->tradition ) {
	54	$c->log->warn( "Fixing broken tradition link" );
	55	$tradition->collation->_set_tradition( $tradition );
	56	$c->model('Directory')->save( $tradition );
	57	}
20198e59	58	# Check permissions. Will return 403 if denied, otherwise will
	59	# put the appropriate value in the stash.
	60	my $ok = _check_permission( $c, $tradition );
	61	return unless $ok;
	62
8843c8b9	63	$c->stash->{'textid'} = $textid;
	64	$c->stash->{'tradition'} = $tradition;
	65	}
	66
	67	sub main :Chained('text') :PathPart('') :Args(0) {
	68	my( $self, $c ) = @_;
	69	my $tradition = delete $c->stash->{'tradition'};
	70	my $collation = $tradition->collation;
	71
56e3972e	72	# Stash the relationship definitions
	73	$c->stash->{'relationship_scopes'} = to_json( [ qw/ local global / ] );
	74	my @reltypeinfo;
	75	foreach my $type ( sort { _typesort( $a, $b ) } $collation->relations->types ) {
	76	next if $type->is_weak;
	77	my $struct = { name => $type->name, description => $type->description };
	78	push( @reltypeinfo, $struct );
	79	}
	80	$c->stash->{'relationship_types'} = to_json( \@reltypeinfo );
	81
d58766c0	82	# See how big the tradition is. Edges are more important than nodes
d58766c0	83	# when it comes to rendering difficulty.
8843c8b9	84	my $numnodes = scalar $collation->readings;
	85	my $numedges = scalar $collation->paths;
	86	my $length = $collation->end->rank;
d58766c0	87	# We should display no more than roughly 500 nodes, or roughly 700
	88	# edges, at a time.
	89	my $segments = $numnodes / 500;
	90	if( $numedges / 700 > $segments ) {
	91	$segments = $numedges / 700;
	92	}
	93	my $segsize = sprintf( "%.0f", $length / $segments );
	94	my $margin = sprintf( "%.0f", $segsize / 10 );
	95	if( $segments > 1 ) {
13aa153c	96	# Segment the tradition in order not to overload the browser.
13aa153c	97	my @divs;
13aa153c	98	my $r = 0;
d58766c0	99	while( $r + $margin < $length ) {
13aa153c	100	push( @divs, $r );
d58766c0	101	$r += $segsize;
13aa153c	102	}
13aa153c	103	$c->stash->{'textsegments'} = [];
ea8e8b3c	104	foreach my $i ( 0..$#divs ) {
	105	my $seg = { 'start' => $divs[$i] };
	106	$seg->{'display'} = "Segment " . ($i+1);
13aa153c	107	push( @{$c->stash->{'textsegments'}}, $seg );
	108	}
	109	}
13aa153c	110	my $startseg = $c->req->param('start');
13aa153c	111	my $svgopts;
13aa153c	112	if( $startseg ) {
d58766c0	113	# Only render the subgraph from startseg to endseg or to END,
13aa153c	114	# whichever is less.
8843c8b9	115	my $endseg = $startseg + $segsize + $margin;
13aa153c	116	$svgopts = { 'from' => $startseg };
d58766c0	117	$svgopts->{'to'} = $endseg if $endseg < $collation->end->rank;
13aa153c	118	} elsif( exists $c->stash->{'textsegments'} ) {
13aa153c	119	# This is the unqualified load of a long tradition. We implicitly start
8843c8b9	120	# at zero, but go only as far as our segment size.
8843c8b9	121	my $endseg = $segsize + $margin;
ea8e8b3c	122	$startseg = 0;
d58766c0	123	$svgopts = { 'to' => $endseg };
13aa153c	124	}
8843c8b9	125	# Spit out the SVG
13aa153c	126	my $svg_str = $collation->as_svg( $svgopts );
9529f69c	127	$svg_str =~ s/\n//gs;
ea8e8b3c	128	$c->stash->{'startseg'} = $startseg if defined $startseg;
9529f69c	129	$c->stash->{'svg_string'} = $svg_str;
9529f69c	130	$c->stash->{'text_title'} = $tradition->name;
487674b9	131	if( $tradition->can('language') ) {
	132	$c->stash->{'text_lang'} = $tradition->language;
	133	$c->stash->{'can_morphologize'} = 1;
	134	} else {
	135	$c->stash->{'text_lang'} = 'Default';
	136	}
9529f69c	137	$c->stash->{'template'} = 'relate.tt';
b28e606e	138	}
b28e606e	139
56e3972e	140	sub _typesort {
	141	my( $a, $b ) = @_;
	142	my $blsort = $a->bindlevel <=> $b->bindlevel;
	143	return $blsort if $blsort;
	144	return $a->name cmp $b->name;
8843c8b9	145	}
8843c8b9	146
cc86fa11	147	=head2 help
	148
	149	GET relation/help/$language
	150
	151	Returns the help window HTML.
	152
	153	=cut
	154
	155	sub help :Local :Args(1) {
	156	my( $self, $c, $lang ) = @_;
	157	# Display the morphological help for the language if it is defined.
	158	if( $lang && $lang ne 'Default' ) {
	159	my $mod = 'Text::Tradition::Language::' . $lang;
	160	try {
	161	load( $mod );
	162	} catch {
	163	$c->log->debug("Warning: could not load $mod");
	164	}
	165	my $has_mod = $mod->can('morphology_tags');
cc86fa11	166	if( $has_mod ) {
	167	my $tagset = &$has_mod;
	168	$c->stash->{'tagset'} = $tagset;
	169	}
	170	}
	171	$c->stash->{'template'} = 'relatehelp.tt';
	172	}
	173
b28e606e	174	=head2 relationships
b28e606e	175
13aa153c	176	GET relation/$textid/relationships
9529f69c	177
9529f69c	178	Returns the list of relationships defined for this text.
b28e606e	179
13aa153c	180	POST relation/$textid/relationships { request }
9529f69c	181
	182	Attempts to define the requested relationship within the text. Returns 200 on
	183	success or 403 on error.
b28e606e	184
13aa153c	185	DELETE relation/$textid/relationships { request }
9529f69c	186
b28e606e	187
	188	=cut
	189
9529f69c	190	sub relationships :Chained('text') :PathPart :Args(0) {
b28e606e	191	my( $self, $c ) = @_;
6d124a83	192	my $tradition = delete $c->stash->{'tradition'};
20198e59	193	my $ok = _check_permission( $c, $tradition );
20198e59	194	return unless $ok;
6d124a83	195	my $collation = $tradition->collation;
cdd592f3	196	my $m = $c->model('Directory');
9529f69c	197	if( $c->request->method eq 'GET' ) {
	198	my @pairs = $collation->relationships; # returns the edges
	199	my @all_relations;
	200	foreach my $p ( @pairs ) {
	201	my $relobj = $collation->relations->get_relationship( @$p );
545163a2	202	next if $relobj->type eq 'collated'; # Don't show these
7562a27b	203	next if $p->[0] eq $p->[1]; # HACK until bugfix
69a19c91	204	my $relhash = { source => $p->[0], target => $p->[1],
	205	type => $relobj->type, scope => $relobj->scope };
	206	$relhash->{'note'} = $relobj->annotation if $relobj->has_annotation;
	207	push( @all_relations, $relhash );
9529f69c	208	}
9529f69c	209	$c->stash->{'result'} = \@all_relations;
20198e59	210	} else {
	211	# Check write permissions first of all
	212	if( $c->stash->{'permission'} ne 'full' ) {
9529f69c	213	$c->response->status( '403' );
20198e59	214	$c->stash->{'result'} = {
56e3972e	215	'error' => 'You do not have permission to modify this tradition.' };
56e3972e	216	$c->detach( 'View::JSON' );
20198e59	217	} elsif( $c->request->method eq 'POST' ) {
20198e59	218	my $node = $c->request->param('source_id');
	219	my $target = $c->request->param('target_id');
	220	my $relation = $c->request->param('rel_type');
	221	my $note = $c->request->param('note');
	222	my $scope = $c->request->param('scope');
	223
8073db65	224	my $opts = { 'type' => $relation, 'propagate' => 1 };
8073db65	225	$opts->{'scope'} = $scope if $scope;
20198e59	226	$opts->{'annotation'} = $note if $note;
	227
	228	try {
	229	my @vectors = $collation->add_relationship( $node, $target, $opts );
	230	$c->stash->{'result'} = \@vectors;
	231	$m->save( $tradition );
	232	} catch( Text::Tradition::Error $e ) {
	233	$c->response->status( '403' );
	234	$c->stash->{'result'} = { 'error' => $e->message };
	235	}
	236	} elsif( $c->request->method eq 'DELETE' ) {
	237	my $node = $c->request->param('source_id');
	238	my $target = $c->request->param('target_id');
	239
	240	try {
	241	my @vectors = $collation->del_relationship( $node, $target );
	242	$m->save( $tradition );
	243	$c->stash->{'result'} = \@vectors;
	244	} catch( Text::Tradition::Error $e ) {
	245	$c->response->status( '403' );
	246	$c->stash->{'result'} = { 'error' => $e->message };
	247	}
9529f69c	248	}
b28e606e	249	}
b28e606e	250	$c->forward('View::JSON');
5f15640c	251	}
	252
	253	=head2 readings
	254
	255	GET relation/$textid/readings
	256
	257	Returns the list of readings defined for this text along with their metadata.
	258
	259	=cut
	260
0dcdd5ec	261	my %read_write_keys = (
	262	'id' => 0,
	263	'text' => 0,
	264	'is_meta' => 0,
	265	'grammar_invalid' => 1,
	266	'is_nonsense' => 1,
	267	'normal_form' => 1,
	268	);
	269
5f15640c	270	sub _reading_struct {
	271	my( $reading ) = @_;
	272	# Return a JSONable struct of the useful keys. Keys meant to be writable
	273	# have a true value; read-only keys have a false value.
5f15640c	274	my $struct = {};
2be76d3f	275	map { $struct->{$_} = $reading->$_ if $reading->can( $_ ) } keys( %read_write_keys );
5f15640c	276	# Special case
2be76d3f	277	$struct->{'lexemes'} = $reading->can( 'lexemes' ) ? [ $reading->lexemes ] : [];
0dcdd5ec	278	# Look up any words related via spelling or orthography
	279	my $sameword = sub {
	280	my $t = $_[0]->type;
	281	return $t eq 'spelling' \|\| $t eq 'orthographic';
	282	};
	283	my @variants;
	284	foreach my $sr ( $reading->related_readings( $sameword ) ) {
	285	push( @variants, $sr->text );
	286	}
	287	$struct->{'variants'} = \@variants;
5f15640c	288	return $struct;
	289	}
	290
	291	sub readings :Chained('text') :PathPart :Args(0) {
	292	my( $self, $c ) = @_;
	293	my $tradition = delete $c->stash->{'tradition'};
20198e59	294	my $ok = _check_permission( $c, $tradition );
20198e59	295	return unless $ok;
5f15640c	296	my $collation = $tradition->collation;
	297	my $m = $c->model('Directory');
	298	if( $c->request->method eq 'GET' ) {
	299	my $rdginfo = {};
	300	foreach my $rdg ( $collation->readings ) {
	301	$rdginfo->{$rdg->id} = _reading_struct( $rdg );
	302	}
	303	$c->stash->{'result'} = $rdginfo;
	304	}
	305	$c->forward('View::JSON');
	306	}
	307
	308	=head2 reading
	309
	310	GET relation/$textid/reading/$id
	311
	312	Returns the list of readings defined for this text along with their metadata.
	313
	314	POST relation/$textid/reading/$id { request }
	315
	316	Alters the reading according to the values in request. Returns 403 Forbidden if
	317	the alteration isn't allowed.
	318
	319	=cut
	320
	321	sub reading :Chained('text') :PathPart :Args(1) {
	322	my( $self, $c, $reading_id ) = @_;
	323	my $tradition = delete $c->stash->{'tradition'};
	324	my $collation = $tradition->collation;
0dcdd5ec	325	my $rdg = $collation->reading( $reading_id );
5f15640c	326	my $m = $c->model('Directory');
5f15640c	327	if( $c->request->method eq 'GET' ) {
5f15640c	328	$c->stash->{'result'} = $rdg ? _reading_struct( $rdg )
	329	: { 'error' => "No reading with ID $reading_id" };
	330	} elsif ( $c->request->method eq 'POST' ) {
20198e59	331	if( $c->stash->{'permission'} ne 'full' ) {
	332	$c->response->status( '403' );
	333	$c->stash->{'result'} = {
	334	'error' => 'You do not have permission to view this tradition.' };
	335	$c->detach('View::JSON');
487674b9	336	return;
20198e59	337	}
6666d111	338	my $errmsg;
487674b9	339	if( $rdg && $rdg->does('Text::Tradition::Morphology') ) {
	340	# Are we re-lemmatizing?
	341	if( $c->request->param('relemmatize') ) {
	342	my $nf = $c->request->param('normal_form');
	343	# TODO throw error unless $nf
	344	$rdg->normal_form( $nf );
	345	# TODO throw error if lemmatization fails
	346	# TODO skip this if normal form hasn't changed
	347	$rdg->lemmatize();
	348	} else {
	349	# Set all the values that we have for the reading.
	350	# TODO error handling
	351	foreach my $p ( keys %{$c->request->params} ) {
	352	if( $p =~ /^morphology_(\d+)$/ ) {
	353	# Set the form on the correct lexeme
	354	my $morphval = $c->request->param( $p );
	355	next unless $morphval;
	356	my $midx = $1;
	357	my $lx = $rdg->lexeme( $midx );
	358	my $strrep = $rdg->language . ' // ' . $morphval;
	359	my $idx = $lx->has_form( $strrep );
	360	unless( defined $idx ) {
	361	# Make the word form and add it to the lexeme.
	362	try {
	363	$idx = $lx->add_matching_form( $strrep ) - 1;
	364	} catch( Text::Tradition::Error $e ) {
	365	$c->response->status( '403' );
	366	$errmsg = $e->message;
	367	} catch {
	368	# Something else went wrong, probably a Moose error
	369	$c->response->status( '403' );
	370	$errmsg = 'Something went wrong with the request';
	371	}
6666d111	372	}
487674b9	373	$lx->disambiguate( $idx ) if defined $idx;
	374	} elsif( $read_write_keys{$p} ) {
	375	my $val = _clean_booleans( $rdg, $p, $c->request->param( $p ) );
	376	$rdg->$p( $val );
0dcdd5ec	377	}
487674b9	378	}
	379	}
	380	$m->save( $rdg );
	381	} else {
	382	$errmsg = "Reading does not exist or cannot be morphologized";
0dcdd5ec	383	}
6666d111	384	$c->stash->{'result'} = $errmsg ? { 'error' => $errmsg }
6666d111	385	: _reading_struct( $rdg );
0dcdd5ec	386
5f15640c	387	}
	388	$c->forward('View::JSON');
	389
	390	}
b28e606e	391
20198e59	392	sub _check_permission {
	393	my( $c, $tradition ) = @_;
	394	my $user = $c->user_exists ? $c->user->get_object : undef;
b0524272	395	# Does this user have access?
20198e59	396	if( $user ) {
b0524272	397	if( $user->is_admin \|\|
	398	( $tradition->has_user && $tradition->user->id eq $user->id ) ) {
	399	$c->stash->{'permission'} = 'full';
	400	return 1;
	401	}
080f8a02	402	}
	403	# Is it public?
	404	if( $tradition->public ) {
20198e59	405	$c->stash->{'permission'} = 'readonly';
20198e59	406	return 1;
080f8a02	407	}
	408	# Forbidden!
	409	$c->response->status( 403 );
	410	$c->response->body( 'You do not have permission to view this tradition.' );
	411	$c->detach( 'View::Plain' );
	412	return 0;
20198e59	413	}
20198e59	414
997ebe92	415	sub _clean_booleans {
	416	my( $rdg, $param, $val ) = @_;
	417	if( $rdg->meta->get_attribute( $param )->type_constraint->name eq 'Bool' ) {
	418	$val = 1 if $val eq 'true';
	419	$val = undef if $val eq 'false';
	420	}
	421	return $val;
	422	}
	423
b8a92065	424	=head2 end
	425
	426	Attempt to render a view, if needed.
	427
	428	=cut
	429
	430	sub end : ActionClass('RenderView') {}
	431
	432	=head1 AUTHOR
	433
	434	Tara L Andrews
	435
	436	=head1 LICENSE
	437
	438	This library is free software. You can redistribute it and/or modify
	439	it under the same terms as Perl itself.
	440
	441	=cut
	442
	443	__PACKAGE__->meta->make_immutable;
	444
	445	1;