1 package stemmaweb::Controller::Root;
3 use namespace::autoclean;
4 use Text::Tradition::Analysis qw/ run_analysis /;
7 use XML::LibXML::XPathContext;
10 BEGIN { extends 'Catalyst::Controller' }
13 # Sets the actions in this controller to be registered with no prefix
14 # so they function identically to actions created in MyApp.pm
16 __PACKAGE__->config(namespace => '');
20 stemmaweb::Controller::Root - Root Controller for stemmaweb
24 Serves up the main container pages.
30 The root page (/). Serves the main container page, from which the various
31 components will be loaded.
35 sub index :Path :Args(0) {
36 my ( $self, $c ) = @_;
38 # Are we being asked to load a text immediately? If so
39 if( $c->req->param('withtradition') ) {
40 $c->stash->{'withtradition'} = $c->req->param('withtradition');
42 $c->stash->{template} = 'index.tt';
47 A general overview/documentation page for the site.
51 sub about :Local :Args(0) {
53 $c->stash->{template} = 'about.tt';
58 A dispatcher for documentation of various aspects of the application.
62 sub help :Local :Args(1) {
63 my( $self, $c, $topic ) = @_;
64 $c->stash->{template} = "$topic.tt";
67 =head1 Elements of index page
73 Serves a snippet of HTML that lists the available texts. This returns texts belonging to the logged-in user if any, otherwise it returns all public texts.
77 sub directory :Local :Args(0) {
79 my $m = $c->model('Directory');
80 # Is someone logged in?
82 if( $c->user_exists ) {
83 my $user = $c->user->get_object;
84 my @list = $m->traditionlist( $user );
85 map { $usertexts{$_->{id}} = 1 } @list;
86 $c->stash->{usertexts} = \@list;
87 $c->stash->{is_admin} = 1 if $user->is_admin;
89 # List public (i.e. readonly) texts separately from any user (i.e.
90 # full access) texts that exist. Admin users therefore have nothing
92 my @plist = grep { !$usertexts{$_->{id}} } $m->traditionlist('public');
93 $c->stash->{publictexts} = \@plist;
94 $c->stash->{template} = 'directory.tt';
97 =head1 AJAX methods for traditions and their properties
103 language: <language>,
107 Creates a new tradition belonging to the logged-in user, with the given name
108 and the collation given in the uploaded file. The file type is indicated via
109 the filename extension (.csv, .txt, .xls, .xlsx, .xml). Returns the ID and
110 name of the new tradition.
114 sub newtradition :Local :Args(0) {
115 my( $self, $c ) = @_;
116 return _json_error( $c, 403, 'Cannot save a tradition without being logged in' )
117 unless $c->user_exists;
119 my $user = $c->user->get_object;
120 # Grab the file upload, check its name/extension, and call the
121 # appropriate parser(s).
122 my $upload = $c->request->upload('file');
123 my $name = $c->request->param('name') || 'Uploaded tradition';
124 my $lang = $c->request->param( 'language' ) || 'Default';
125 my $public = $c->request->param( 'public' ) ? 1 : undef;
126 my( $ext ) = $upload->filename =~ /\.(\w+)$/;
131 'file' => $upload->tempname
136 if( $ext eq 'xml' ) {
138 # Parse the XML to see which flavor it is.
139 my $parser = XML::LibXML->new();
142 $doc = $parser->parse_file( $newopts{'file'} );
144 $errmsg = "XML file parsing error: $err";
147 if( $doc->documentElement->nodeName eq 'GraphML' ) {
149 } elsif( $doc->documentElement->nodeName ne 'TEI' ) {
150 $errmsg = 'Unrecognized XML type ' . $doc->documentElement->nodeName;
152 my $xpc = XML::LibXML::XPathContext->new( $doc->documentElement );
153 my $venc = $xpc->findvalue( '/TEI/teiHeader/encodingDesc/variantEncoding/attribute::method' );
154 if( $venc && $venc eq 'double-end-point' ) {
161 # Try the relevant XML parsing option.
163 delete $newopts{'file'};
164 $newopts{'xmlobj'} = $doc;
166 $tradition = Text::Tradition->new( %newopts, 'input' => $type );
167 } catch ( Text::Tradition::Error $e ) {
168 $errmsg = $e->message;
170 $errmsg = "Unexpected parsing error: $e";
173 } elsif( $ext =~ /^(txt|csv|xls(x)?)$/ ) {
174 # If it's Excel we need to pass excel => $ext;
175 # otherwise we need to pass sep_char => [record separator].
176 if( $ext =~ /xls/ ) {
177 $newopts{'excel'} = $ext;
179 $newopts{'sep_char'} = $ext eq 'txt' ? "\t" : ',';
182 $tradition = Text::Tradition->new(
184 'input' => 'Tabular',
186 } catch ( Text::Tradition::Error $e ) {
187 $errmsg = $e->message;
189 $errmsg = "Unexpected parsing error: $e";
192 # Error unless we have a recognized filename extension
193 return _json_error( $c, 403, "Unrecognized file type extension $ext" );
196 # Save the tradition if we have it, and return its data or else the
197 # error that occurred trying to make it.
199 return _json_error( $c, 500, "Error parsing tradition .$ext file: $errmsg" );
200 } elsif( !$tradition ) {
201 return _json_error( $c, 500, "No error caught but tradition not created" );
204 my $m = $c->model('Directory');
205 $user->add_tradition( $tradition );
206 my $id = $c->model('Directory')->store( $tradition );
207 $c->model('Directory')->store( $user );
208 $c->stash->{'result'} = { 'id' => $id, 'name' => $tradition->name };
209 $c->forward('View::JSON');
214 GET /textinfo/$textid
215 POST /textinfo/$textid,
217 language: $new_language,
219 owner: $new_userid } # only admin users can update the owner
221 Returns information about a particular text.
225 sub textinfo :Local :Args(1) {
226 my( $self, $c, $textid ) = @_;
227 my $tradition = $c->model('Directory')->tradition( $textid );
228 ## Have to keep users in the same scope as tradition
231 unless( $tradition ) {
232 return _json_error( $c, 404, "No tradition with ID $textid" );
234 my $ok = _check_permission( $c, $tradition );
236 if( $c->req->method eq 'POST' ) {
237 return _json_error( $c, 403,
238 'You do not have permission to update this tradition' )
239 unless $ok eq 'full';
240 my $params = $c->request->parameters;
241 # Handle changes to owner-accessible parameters
242 my $m = $c->model('Directory');
244 # Handle name param - easy
245 if( exists $params->{name} ) {
246 my $newname = delete $params->{name};
247 unless( $tradition->name eq $newname ) {
249 $tradition->name( $newname );
252 return _json_error( $c, 500, "Error setting name to $newname" );
256 # Handle language param, making Default => null
257 my $langval = delete $params->{language} || 'Default';
259 unless( $tradition->language eq $langval || !$tradition->can('language') ) {
261 $tradition->language( $langval );
264 return _json_error( $c, 500, "Error setting language to $langval" );
269 my $ispublic = $tradition->public;
270 if( delete $params->{'public'} ) { # if it's any true value...
271 $tradition->public( 1 );
272 $changed = 1 unless $ispublic;
273 } else { # the checkbox was unchecked, ergo it should not be public
274 $tradition->public( 0 );
275 $changed = 1 if $ispublic;
278 # Handle ownership change
279 if( exists $params->{'owner'} ) {
280 # Only admins can update user / owner
281 my $newownerid = delete $params->{'owner'};
282 if( $tradition->has_user && !$tradition->user ) {
283 $tradition->clear_user;
285 unless( !$newownerid ||
286 ( $tradition->has_user && $tradition->user->email eq $newownerid ) ) {
287 unless( $c->user->get_object->is_admin ) {
288 return _json_error( $c, 403,
289 "Only admin users can change tradition ownership" );
291 $newuser = $m->find_user({ email => $newownerid });
293 return _json_error( $c, 500, "No such user " . $newownerid );
295 if( $tradition->has_user ) {
296 $olduser = $tradition->user;
297 $olduser->remove_tradition( $tradition );
299 $newuser->add_tradition( $tradition );
303 # TODO check for rogue parameters
304 if( scalar keys %$params ) {
305 my $rogueparams = join( ', ', keys %$params );
306 return _json_error( $c, 403, "Request parameters $rogueparams not recognized" );
308 # If we safely got to the end, then write to the database.
309 $m->save( $tradition ) if $changed;
310 $m->save( $newuser ) if $newuser;
313 # Now return the current textinfo, whether GET or successful POST.
316 name => $tradition->name,
317 #language => $tradition->language,
318 public => $tradition->public || 0,
319 owner => $tradition->user ? $tradition->user->email : undef,
320 witnesses => [ map { $_->sigil } $tradition->witnesses ],
322 if( $tradition->can('language') ) {
323 $textinfo->{'language'} = $tradition->language;
325 my @stemmasvg = map { $_->as_svg() } $tradition->stemmata;
326 map { $_ =~ s/\n/ /mg } @stemmasvg;
327 $textinfo->{stemmata} = \@stemmasvg;
328 $c->stash->{'result'} = $textinfo;
329 $c->forward('View::JSON');
334 GET /variantgraph/$textid
336 Returns the variant graph for the text specified at $textid, in SVG form.
340 sub variantgraph :Local :Args(1) {
341 my( $self, $c, $textid ) = @_;
342 my $tradition = $c->model('Directory')->tradition( $textid );
343 unless( $tradition ) {
344 return _json_error( $c, 404, "No tradition with ID $textid" );
346 my $ok = _check_permission( $c, $tradition );
349 my $collation = $tradition->collation;
350 $c->stash->{'result'} = $collation->as_svg;
351 $c->forward('View::SVG');
356 GET /stemma/$textid/$stemmaseq
357 POST /stemma/$textid/$stemmaseq, { 'dot' => $dot_string }
359 Returns an SVG representation of the given stemma hypothesis for the text.
360 If the URL is called with POST, the stemma at $stemmaseq will be altered
361 to reflect the definition in $dot_string. If $stemmaseq is 'n', a new
362 stemma will be added.
366 sub stemma :Local :Args(2) {
367 my( $self, $c, $textid, $stemmaid ) = @_;
368 my $m = $c->model('Directory');
369 my $tradition = $m->tradition( $textid );
370 unless( $tradition ) {
371 return _json_error( $c, 404, "No tradition with ID $textid" );
373 my $ok = _check_permission( $c, $tradition );
376 $c->stash->{'result'} = '';
378 if( $c->req->method eq 'POST' ) {
379 if( $ok eq 'full' ) {
380 my $dot = $c->request->body_params->{'dot'};
381 # Graph::Reader::Dot does not handle bare unicode. We get around this
382 # by wrapping all words in double quotes, as long as they aren't already
383 # wrapped, and as long as they aren't the initial 'digraph stemma'.
385 $dot =~ s/(?<!")\b(?!(?:digraph|stemma)\b)(\w+)\b(?!")/"$1"/g;
387 if( $stemmaid eq 'n' ) {
388 # We are adding a new stemma.
389 $stemmaid = $tradition->stemma_count;
390 $stemma = $tradition->add_stemma( 'dot' => $dot );
391 } elsif( $stemmaid !~ /^\d+$/ ) {
392 return _json_error( $c, 403, "Invalid stemma ID specification $stemmaid" );
393 } elsif( $stemmaid < $tradition->stemma_count ) {
394 # We are updating an existing stemma.
395 $stemma = $tradition->stemma( $stemmaid );
396 $stemma->alter_graph( $dot );
398 # Unrecognized stemma ID
399 return _json_error( $c, 404, "No stemma at index $stemmaid, cannot update" );
401 } catch ( Text::Tradition::Error $e ) {
402 return _json_error( $c, 500, $e->message );
404 $m->store( $tradition );
406 # No permissions to update the stemma
407 return _json_error( $c, 403,
408 'You do not have permission to update stemmata for this tradition' );
412 # For a GET or a successful POST request, return the SVG representation
413 # of the stemma in question, if any.
414 if( !$stemma && $tradition->stemma_count > $stemmaid ) {
415 $stemma = $tradition->stemma( $stemmaid );
417 my $stemma_xml = $stemma ? $stemma->as_svg() : '';
418 # What was requested, XML or JSON?
419 my $return_view = 'SVG';
420 if( my $accept_header = $c->req->header('Accept') ) {
421 $c->log->debug( "Received Accept header: $accept_header" );
422 foreach my $type ( split( /,\s*/, $accept_header ) ) {
423 # If we were first asked for XML, return SVG
424 last if $type =~ /^(application|text)\/xml$/;
425 # If we were first asked for JSON, return JSON
426 if( $type eq 'application/json' ) {
427 $return_view = 'JSON';
432 if( $return_view eq 'SVG' ) {
433 $c->stash->{'result'} = $stemma_xml;
434 $c->forward('View::SVG');
436 $stemma_xml =~ s/\n/ /mg;
437 $c->stash->{'result'} = { 'stemmaid' => $stemmaid, 'stemmasvg' => $stemma_xml };
438 $c->forward('View::JSON');
444 GET /stemmadot/$textid/$stemmaseq
446 Returns the 'dot' format representation of the current stemma hypothesis.
450 sub stemmadot :Local :Args(2) {
451 my( $self, $c, $textid, $stemmaid ) = @_;
452 my $m = $c->model('Directory');
453 my $tradition = $m->tradition( $textid );
454 unless( $tradition ) {
455 return _json_error( $c, 404, "No tradition with ID $textid" );
457 my $ok = _check_permission( $c, $tradition );
459 my $stemma = $tradition->stemma( $stemmaid );
461 return _json_error( $c, 404, "Tradition $textid has no stemma ID $stemmaid" );
463 # Get the dot and transmute its line breaks to literal '|n'
464 $c->stash->{'result'} = { 'dot' => $stemma->editable( { linesep => '|n' } ) };
465 $c->forward('View::JSON');
470 GET /download/$textid
472 Returns the full XML definition of the tradition and its stemmata, if any.
476 sub download :Local :Args(1) {
477 my( $self, $c, $textid ) = @_;
478 my $tradition = $c->model('Directory')->tradition( $textid );
479 unless( $tradition ) {
480 return _json_error( $c, 404, "No tradition with ID $textid" );
482 my $ok = _check_permission( $c, $tradition );
485 $c->stash->{'result'} = $tradition->collation->as_graphml();
486 } catch( Text::Tradition::Error $e ) {
487 return _json_error( $c, 500, $e->message );
489 $c->forward('View::GraphML');
496 # Helper to check what permission, if any, the active user has for
497 # the given tradition
498 sub _check_permission {
499 my( $c, $tradition ) = @_;
500 my $user = $c->user_exists ? $c->user->get_object : undef;
502 return 'full' if ( $user->is_admin ||
503 ( $tradition->has_user && $tradition->user->id eq $user->id ) );
505 # Text doesn't belong to us, so maybe it's public?
506 return 'readonly' if $tradition->public;
508 # ...nope. Forbidden!
509 return _json_error( $c, 403, 'You do not have permission to view this tradition.' );
512 # Helper to throw a JSON exception
514 my( $c, $code, $errmsg ) = @_;
515 $c->response->status( $code );
516 $c->stash->{'result'} = { 'error' => $errmsg };
517 $c->forward('View::JSON');
523 Standard 404 error page
528 my ( $self, $c ) = @_;
529 $c->response->body( 'Page not found' );
530 $c->response->status(404);
535 Attempt to render a view, if needed.
539 sub end : ActionClass('RenderView') {}
547 This library is free software. You can redistribute it and/or modify
548 it under the same terms as Perl itself.
552 __PACKAGE__->meta->make_immutable;