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

package stemmaweb::Controller::Relation;
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 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/
 
 Runs the relationship mapper for the specified text ID.
 
=cut

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 );
    }
    # 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;

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