[scpubgit/stemmatology.git] / TreeOfTexts / lib / TreeOfTexts / Controller / Root.pm

package TreeOfTexts::Controller::Root;
use Moose;
use namespace::autoclean;
use Text::Tradition::Analysis qw/ run_analysis /;


BEGIN { extends 'Catalyst::Controller' }

#
# Sets the actions in this controller to be registered with no prefix
# so they function identically to actions created in MyApp.pm
#
__PACKAGE__->config(namespace => '');

=head1 NAME

TreeOfTexts::Controller::Root - Root Controller for TreeOfTexts

=head1 DESCRIPTION

Serves up the main container pages.

=head1 URLs

=head2 index

The root page (/).  Serves the main container page, from which the various
components will be loaded.

=cut

sub index :Path :Args(0) {
    my ( $self, $c ) = @_;

    $c->stash->{template} = 'index.tt';
}

=head1 Elements of index page

=head2 directory

 GET /directory

Serves a snippet of HTML that lists the available texts.  Eventually this will be available texts by user.

=cut
sub directory :Path :Args(0) {
	my( $self, $c ) = @_;
    my $m = $c->model('Directory');
    # TODO not used yet, will load user texts later
    my $user = $c->request->param( 'user' ) || 'ALL';
    my @textlist;
    foreach my $id ( $m->tradition_ids ) {
    	my $data = { 
    		'id' => $id,
    		'name' => $m->name( $id ),
    	};
    	push( @all_texts, $data );
    }
    
    $c->stash->{texts} = \@textlist;
	$c->stash->{template} = 'directory.tt';
}

=head2 alignment

 GET /alignment/$textid

Returns an alignment table for the text specified at $textid.

=cut

sub alignment :Path :Args(1) {
	my( $self, $c, $textid ) = @_;
	my $m = $c->model('Directory');
	my $collation = $m->tradition( $textid )->collation;
	my $alignment = $collation->make_alignment_table;
	
	# Turn the table, so that witnesses are by column and the rows
	# are by rank.
	my $wits = [ map { $_->{'witness'} } @{$alignment->{'alignment'}} ];
	my $rows;
	foreach my $i ( 0 .. $alignment->{'length'} - 1 ) {
		my @rankrdgs = map { $_->{'tokens'}->[$i]->{'t'} } 
			@{$alignment->{'alignment'}};
		push( @$rows, { 'rank' => $i+1, 'readings' => \@rankrdgs } );
	}
	$c->log->debug( Dumper( $rows ) );
	$c->stash->{'witnesses'} = $wits;
	$c->stash->{'table'} = $rows;
	$c->stash->{'template'} = 'alignment.tt';
}

=head2 stemma

 GET /stemma/$textid
 POST /stemma/$textid, { 'dot' => $dot_string }

Returns an SVG representation of the stemma hypothesis for the text.  If 
the URL is called with POST and a new dot string, updates the stemma and
returns the SVG as with GET.

=cut

sub stemma :Path :Args(1) {
	my( $self, $c, $textid ) = @_;
	my $m = $c->model('Directory');
	my $tradition = $m->tradition( $textid );
	
	if( $c->req->method eq 'POST' ) {
		# Update the stemma
		my $dot = $c->request->body_params->{'dot'};
		$tradition->add_stemma( $dot );
		$m->store( $tradition );
	}
	
	$c->stash->{'result'} = $tradition->stemma->as_svg;
	$c->forward('View::SVG');
}

=head2 stemmadot

 GET /stemmadot/$textid
 
Returns the 'dot' format representation of the current stemma hypothesis.

=cut

sub stemma :Path :Args(1) {
	my( $self, $c, $textid ) = @_;
	my $m = $c->model('Directory');
	my $tradition = $m->tradition( $textid );
	
	$c->response->body( $tradition->stemma->editable );
	$c->forward('View::Plain');
}

=head2 relationships

The relationship editor tool.

=cut

sub relationships :Local {
	my( $self, $c ) = @_;
	my $m = $c->model('Directory');
	my $tradition = $m->tradition( $c->request->params->{'textid'} );
	my $table = $tradition->collation->make_alignment_table();
	my $witlist = map { $_->{'witness'} } @{$table->{'alignment'}};
	$c->stash->{witnesses} = $witlist;
	$c->stash->{alignment} = $table;
	$c->stash->{template} = 'relate.tt';	
}

=head2 stexaminer

The stemma analysis tool with the pretty colored table.

=cut

sub stexaminer :Local {
    my( $self, $c ) = @_;
    my $m = $c->model('Directory');
	my $tradition = $m->tradition( $c->request->params->{'textid'} );
	my $stemma = $tradition->stemma;
	# TODO Think about caching the stemma in a session 
	$c->stash->{svg} = $stemma->as_svg;
	$c->stash->{text_title} = $tradition->name;
	$c->stash->{template} = 'index.tt'; 
	# TODO Run the analysis as AJAX from the loaded page.
	my $t = run_analysis( $tradition );
	$c->stash->{variants} = $t->{'variants'};
	$c->stash->{total} = $t->{'variant_count'};
	$c->stash->{genealogical} = $t->{'genealogical_count'};
	$c->stash->{conflict} = $t->{'conflict_count'};
}

=head1 MICROSERVICE CALLS

=head2 renderSVG

Parse the passed collation data and return an SVG of the collated text.  Takes
the following parameters:

=over 4

=item * data - The collation data itself.

=item * input - The data format.  Valid values include CollateX, Self, TEI (for parallel segmentation) eventually Tabular.

=item * name - A name for the text. Not so important for this function.

=cut

# Utility function to render SVG from a graph input.
sub renderSVG :Local {
	my( $self, $c ) = @_;
	my $format = $c->request->param('format') || 'string';
	my $type = $c->request->body_params->{'type'};
	my $name = $c->request->param('name') || 'Collation graph';
	my $data = $c->request->body_params->{'data'};
	$c->log->debug( $data );
	my $tradition = Text::Tradition->new( 
		'name' => $name,
		'input' => $type,
		$format => $data,
		);
	$c->log->debug( "Got tradition with " . $tradition->collation->readings . " readings" );
	$c->stash->{'result'} = $tradition->collation->as_svg;
	$c->forward('View::SVG');
}


=head1 OPENSOCIAL URLs

=head2 view_table

Simple gadget to return the analysis table for the stexaminer

=cut

sub view_table :Local {
    my( $self, $c ) = @_;
    my $m = $c->model('Directory');
	my $id = $c->request->params->{'textid'};
	my $t = run_analysis( $m->tradition( $id ), $m->stemma( $id ) );
   	$c->stash->{variants} = $t->{'variants'};
    $c->stash->{template} = 'table_gadget.tt';
}

=head2 view_svg

Simple gadget to return the SVG for a given stemma

=cut

sub view_svg :Local {
    my( $self, $c ) = @_;
    my $m = $c->model('Directory');
    my $stemma = $m->tradition( $c->request->params->{'textid'} )->stemma;
	if( $stemma ) {
	   	$c->stash->{svg} = $stemma->as_svg;
	}
    $c->stash->{template} = 'stemma_gadget.tt';
}

=head2 default

Standard 404 error page

=cut

sub default :Path {
    my ( $self, $c ) = @_;
    $c->response->body( 'Page not found' );
    $c->response->status(404);
}

=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
dbcf12a6	1	package TreeOfTexts::Controller::Root;
	2	use Moose;
	3	use namespace::autoclean;
3837c155	4	use Text::Tradition::Analysis qw/ run_analysis /;
3837c155	5
dbcf12a6	6
	7	BEGIN { extends 'Catalyst::Controller' }
	8
	9	#
	10	# Sets the actions in this controller to be registered with no prefix
	11	# so they function identically to actions created in MyApp.pm
	12	#
	13	__PACKAGE__->config(namespace => '');
	14
	15	=head1 NAME
	16
	17	TreeOfTexts::Controller::Root - Root Controller for TreeOfTexts
	18
	19	=head1 DESCRIPTION
	20
6b70c348	21	Serves up the main container pages.
dbcf12a6	22
6b70c348	23	=head1 URLs
dbcf12a6	24
	25	=head2 index
	26
6b70c348	27	The root page (/). Serves the main container page, from which the various
6b70c348	28	components will be loaded.
dbcf12a6	29
	30	=cut
	31
	32	sub index :Path :Args(0) {
	33	my ( $self, $c ) = @_;
	34
6b70c348	35	$c->stash->{template} = 'index.tt';
	36	}
	37
	38	=head1 Elements of index page
	39
	40	=head2 directory
	41
	42	GET /directory
	43
	44	Serves a snippet of HTML that lists the available texts. Eventually this will be available texts by user.
	45
	46	=cut
	47	sub directory :Path :Args(0) {
	48	my( $self, $c ) = @_;
3837c155	49	my $m = $c->model('Directory');
6b70c348	50	# TODO not used yet, will load user texts later
	51	my $user = $c->request->param( 'user' ) \|\| 'ALL';
	52	my @textlist;
12720144	53	foreach my $id ( $m->tradition_ids ) {
3837c155	54	my $data = {
3837c155	55	'id' => $id,
12720144	56	'name' => $m->name( $id ),
3837c155	57	};
	58	push( @all_texts, $data );
	59	}
	60
6b70c348	61	$c->stash->{texts} = \@textlist;
	62	$c->stash->{template} = 'directory.tt';
	63	}
	64
	65	=head2 alignment
	66
	67	GET /alignment/$textid
	68
	69	Returns an alignment table for the text specified at $textid.
	70
	71	=cut
	72
	73	sub alignment :Path :Args(1) {
	74	my( $self, $c, $textid ) = @_;
	75	my $m = $c->model('Directory');
	76	my $collation = $m->tradition( $textid )->collation;
	77	my $alignment = $collation->make_alignment_table;
	78
	79	# Turn the table, so that witnesses are by column and the rows
	80	# are by rank.
	81	my $wits = [ map { $_->{'witness'} } @{$alignment->{'alignment'}} ];
	82	my $rows;
	83	foreach my $i ( 0 .. $alignment->{'length'} - 1 ) {
	84	my @rankrdgs = map { $_->{'tokens'}->[$i]->{'t'} }
	85	@{$alignment->{'alignment'}};
	86	push( @$rows, { 'rank' => $i+1, 'readings' => \@rankrdgs } );
	87	}
	88	$c->log->debug( Dumper( $rows ) );
	89	$c->stash->{'witnesses'} = $wits;
	90	$c->stash->{'table'} = $rows;
	91	$c->stash->{'template'} = 'alignment.tt';
	92	}
	93
	94	=head2 stemma
	95
	96	GET /stemma/$textid
	97	POST /stemma/$textid, { 'dot' => $dot_string }
	98
	99	Returns an SVG representation of the stemma hypothesis for the text. If
	100	the URL is called with POST and a new dot string, updates the stemma and
	101	returns the SVG as with GET.
	102
	103	=cut
	104
	105	sub stemma :Path :Args(1) {
	106	my( $self, $c, $textid ) = @_;
	107	my $m = $c->model('Directory');
	108	my $tradition = $m->tradition( $textid );
	109
	110	if( $c->req->method eq 'POST' ) {
	111	# Update the stemma
	112	my $dot = $c->request->body_params->{'dot'};
	113	$tradition->add_stemma( $dot );
	114	$m->store( $tradition );
	115	}
	116
	117	$c->stash->{'result'} = $tradition->stemma->as_svg;
	118	$c->forward('View::SVG');
dbcf12a6	119	}
dbcf12a6	120
6b70c348	121	=head2 stemmadot
12720144	122
6b70c348	123	GET /stemmadot/$textid
	124
	125	Returns the 'dot' format representation of the current stemma hypothesis.
	126
	127	=cut
	128
	129	sub stemma :Path :Args(1) {
	130	my( $self, $c, $textid ) = @_;
	131	my $m = $c->model('Directory');
	132	my $tradition = $m->tradition( $textid );
	133
	134	$c->response->body( $tradition->stemma->editable );
	135	$c->forward('View::Plain');
	136	}
12720144	137
	138	=head2 relationships
	139
	140	The relationship editor tool.
	141
	142	=cut
	143
3837c155	144	sub relationships :Local {
	145	my( $self, $c ) = @_;
	146	my $m = $c->model('Directory');
	147	my $tradition = $m->tradition( $c->request->params->{'textid'} );
b90c84a0	148	my $table = $tradition->collation->make_alignment_table();
68454b71	149	my $witlist = map { $_->{'witness'} } @{$table->{'alignment'}};
68454b71	150	$c->stash->{witnesses} = $witlist;
b90c84a0	151	$c->stash->{alignment} = $table;
b90c84a0	152	$c->stash->{template} = 'relate.tt';
3837c155	153	}
3837c155	154
12720144	155	=head2 stexaminer
	156
	157	The stemma analysis tool with the pretty colored table.
	158
	159	=cut
	160
3837c155	161	sub stexaminer :Local {
e367f5c0	162	my( $self, $c ) = @_;
3837c155	163	my $m = $c->model('Directory');
12720144	164	my $tradition = $m->tradition( $c->request->params->{'textid'} );
	165	my $stemma = $tradition->stemma;
	166	# TODO Think about caching the stemma in a session
3837c155	167	$c->stash->{svg} = $stemma->as_svg;
3837c155	168	$c->stash->{text_title} = $tradition->name;
12720144	169	$c->stash->{template} = 'index.tt';
	170	# TODO Run the analysis as AJAX from the loaded page.
	171	my $t = run_analysis( $tradition );
	172	$c->stash->{variants} = $t->{'variants'};
e367f5c0	173	$c->stash->{total} = $t->{'variant_count'};
	174	$c->stash->{genealogical} = $t->{'genealogical_count'};
	175	$c->stash->{conflict} = $t->{'conflict_count'};
e367f5c0	176	}
a275e7e6	177
6cfc5703	178	=head1 MICROSERVICE CALLS
	179
	180	=head2 renderSVG
	181
	182	Parse the passed collation data and return an SVG of the collated text. Takes
	183	the following parameters:
	184
	185	=over 4
	186
	187	=item * data - The collation data itself.
	188
	189	=item * input - The data format. Valid values include CollateX, Self, TEI (for parallel segmentation) eventually Tabular.
	190
	191	=item * name - A name for the text. Not so important for this function.
	192
	193	=cut
	194
	195	# Utility function to render SVG from a graph input.
	196	sub renderSVG :Local {
	197	my( $self, $c ) = @_;
	198	my $format = $c->request->param('format') \|\| 'string';
	199	my $type = $c->request->body_params->{'type'};
	200	my $name = $c->request->param('name') \|\| 'Collation graph';
	201	my $data = $c->request->body_params->{'data'};
	202	$c->log->debug( $data );
	203	my $tradition = Text::Tradition->new(
	204	'name' => $name,
	205	'input' => $type,
	206	$format => $data,
	207	);
	208	$c->log->debug( "Got tradition with " . $tradition->collation->readings . " readings" );
	209	$c->stash->{'result'} = $tradition->collation->as_svg;
	210	$c->forward('View::SVG');
	211	}
	212
	213
12720144	214	=head1 OPENSOCIAL URLs
	215
	216	=head2 view_table
	217
	218	Simple gadget to return the analysis table for the stexaminer
	219
	220	=cut
	221
a275e7e6	222	sub view_table :Local {
a275e7e6	223	my( $self, $c ) = @_;
3837c155	224	my $m = $c->model('Directory');
	225	my $id = $c->request->params->{'textid'};
	226	my $t = run_analysis( $m->tradition( $id ), $m->stemma( $id ) );
a275e7e6	227	$c->stash->{variants} = $t->{'variants'};
	228	$c->stash->{template} = 'table_gadget.tt';
	229	}
	230
12720144	231	=head2 view_svg
	232
	233	Simple gadget to return the SVG for a given stemma
	234
	235	=cut
	236
a275e7e6	237	sub view_svg :Local {
a275e7e6	238	my( $self, $c ) = @_;
3837c155	239	my $m = $c->model('Directory');
12720144	240	my $stemma = $m->tradition( $c->request->params->{'textid'} )->stemma;
3837c155	241	if( $stemma ) {
	242	$c->stash->{svg} = $stemma->as_svg;
	243	}
eb1ac99d	244	$c->stash->{template} = 'stemma_gadget.tt';
a275e7e6	245	}
a275e7e6	246
dbcf12a6	247	=head2 default
	248
	249	Standard 404 error page
	250
	251	=cut
	252
	253	sub default :Path {
	254	my ( $self, $c ) = @_;
	255	$c->response->body( 'Page not found' );
	256	$c->response->status(404);
	257	}
	258
	259	=head2 end
	260
	261	Attempt to render a view, if needed.
	262
	263	=cut
	264
	265	sub end : ActionClass('RenderView') {}
	266
	267	=head1 AUTHOR
	268
	269	Tara L Andrews
	270
	271	=head1 LICENSE
	272
	273	This library is free software. You can redistribute it and/or modify
	274	it under the same terms as Perl itself.
	275
	276	=cut
	277
	278	__PACKAGE__->meta->make_immutable;
	279
	280	1;