package stemmaweb::Controller::Root;
use Moose;
use namespace::autoclean;
-use Text::Tradition::Analysis qw/ run_analysis /;
+use JSON qw ();
+use LWP::UserAgent;
use TryCatch;
+use XML::LibXML;
+use XML::LibXML::XPathContext;
BEGIN { extends 'Catalyst::Controller' }
#
__PACKAGE__->config(namespace => '');
+my $STEMWEB_BASE_URL = 'http://slinkola.users.cs.helsinki.fi';
+
=head1 NAME
stemmaweb::Controller::Root - Root Controller for stemmaweb
sub index :Path :Args(0) {
my ( $self, $c ) = @_;
+ # Are we being asked to load a text immediately? If so
+ if( $c->req->param('withtradition') ) {
+ $c->stash->{'withtradition'} = $c->req->param('withtradition');
+ }
+ # Get the current list of Stemweb algorithms
+ my $ua = LWP::UserAgent->new();
+ my $resp = $ua->get( $STEMWEB_BASE_URL . '/algorithms/available' );
+ if( $resp->is_success ) {
+ $c->stash->{'stemweb_algorithms'} = $resp->content;
+ } else {
+ $c->stash->{'stemweb_algorithms'} = '{}';
+ }
$c->stash->{template} = 'index.tt';
}
+=head2 about
+
+A general overview/documentation page for the site.
+
+=cut
+
+sub about :Local :Args(0) {
+ my( $self, $c ) = @_;
+ $c->stash->{template} = 'about.tt';
+}
+
+=head2 help/*
+
+A dispatcher for documentation of various aspects of the application.
+
+=cut
+
+sub help :Local :Args(1) {
+ my( $self, $c, $topic ) = @_;
+ $c->stash->{template} = "$topic.tt";
+}
+
=head1 Elements of index page
=head2 directory
my $tradition;
my $errmsg;
if( $ext eq 'xml' ) {
- # Try the different XML parsing options to see if one works.
- foreach my $type ( qw/ CollateX CTE TEI / ) {
+ my $type;
+ # Parse the XML to see which flavor it is.
+ my $parser = XML::LibXML->new();
+ my $doc;
+ try {
+ $doc = $parser->parse_file( $newopts{'file'} );
+ } catch( $err ) {
+ $errmsg = "XML file parsing error: $err";
+ }
+ if( $doc ) {
+ if( $doc->documentElement->nodeName eq 'GraphML' ) {
+ $type = 'CollateX';
+ } elsif( $doc->documentElement->nodeName ne 'TEI' ) {
+ $errmsg = 'Unrecognized XML type ' . $doc->documentElement->nodeName;
+ } else {
+ my $xpc = XML::LibXML::XPathContext->new( $doc->documentElement );
+ my $venc = $xpc->findvalue( '/TEI/teiHeader/encodingDesc/variantEncoding/attribute::method' );
+ if( $venc && $venc eq 'double-end-point' ) {
+ $type = 'CTE';
+ } else {
+ $type = 'TEI';
+ }
+ }
+ }
+ # Try the relevant XML parsing option.
+ if( $type ) {
+ delete $newopts{'file'};
+ $newopts{'xmlobj'} = $doc;
try {
$tradition = Text::Tradition->new( %newopts, 'input' => $type );
} catch ( Text::Tradition::Error $e ) {
$errmsg = $e->message;
- } catch {
- $errmsg = "Unexpected parsing error";
+ } catch ( $e ) {
+ $errmsg = "Unexpected parsing error: $e";
}
- last if $tradition;
}
} elsif( $ext =~ /^(txt|csv|xls(x)?)$/ ) {
# If it's Excel we need to pass excel => $ext;
);
} catch ( Text::Tradition::Error $e ) {
$errmsg = $e->message;
- } catch {
- $errmsg = "Unexpected parsing error";
+ } catch ( $e ) {
+ $errmsg = "Unexpected parsing error: $e";
}
} else {
# Error unless we have a recognized filename extension
- return _json_error( $c, 500, "Unrecognized file type extension $ext" );
+ return _json_error( $c, 403, "Unrecognized file type extension $ext" );
}
# Save the tradition if we have it, and return its data or else the
sub textinfo :Local :Args(1) {
my( $self, $c, $textid ) = @_;
my $tradition = $c->model('Directory')->tradition( $textid );
+ ## Have to keep users in the same scope as tradition
+ my $newuser;
+ my $olduser;
unless( $tradition ) {
- return _json_error( $c, 500, "No tradition with ID $textid" );
+ return _json_error( $c, 404, "No tradition with ID $textid" );
}
my $ok = _check_permission( $c, $tradition );
return unless $ok;
# Handle changes to owner-accessible parameters
my $m = $c->model('Directory');
my $changed;
- # Handle scalar params
- foreach my $param ( qw/ name language / ) {
- if( exists $params->{$param} ) {
- my $newval = delete $params->{$param};
- unless( $tradition->$param eq $newval ) {
- try {
- $tradition->$param( $newval );
- } catch {
- return _json_error( $c, 500, "Error setting $param to $newval" );
- }
+ # Handle name param - easy
+ if( exists $params->{name} ) {
+ my $newname = delete $params->{name};
+ unless( $tradition->name eq $newname ) {
+ try {
+ $tradition->name( $newname );
$changed = 1;
+ } catch {
+ return _json_error( $c, 500, "Error setting name to $newname" );
}
}
}
+ # Handle language param, making Default => null
+ my $langval = delete $params->{language} || 'Default';
+
+ unless( $tradition->language eq $langval || !$tradition->can('language') ) {
+ try {
+ $tradition->language( $langval );
+ $changed = 1;
+ } catch {
+ return _json_error( $c, 500, "Error setting language to $langval" );
+ }
+ }
+
# Handle our boolean
+ my $ispublic = $tradition->public;
if( delete $params->{'public'} ) { # if it's any true value...
$tradition->public( 1 );
+ $changed = 1 unless $ispublic;
+ } else { # the checkbox was unchecked, ergo it should not be public
+ $tradition->public( 0 );
+ $changed = 1 if $ispublic;
}
- # Handle ownership changes
- my $newuser;
+
+ # Handle ownership change
if( exists $params->{'owner'} ) {
# Only admins can update user / owner
my $newownerid = delete $params->{'owner'};
- unless( $tradition->has_user && $tradition->user->id eq $newownerid ) {
+ if( $tradition->has_user && !$tradition->user ) {
+ $tradition->clear_user;
+ }
+ unless( !$newownerid ||
+ ( $tradition->has_user && $tradition->user->email eq $newownerid ) ) {
unless( $c->user->get_object->is_admin ) {
return _json_error( $c, 403,
"Only admin users can change tradition ownership" );
}
- $newuser = $m->lookup_user( $params->{'owner'} );
+ $newuser = $m->find_user({ email => $newownerid });
unless( $newuser ) {
- return _json_error( $c, 500, "No such user " . $params->{'owner'} );
+ return _json_error( $c, 500, "No such user " . $newownerid );
+ }
+ if( $tradition->has_user ) {
+ $olduser = $tradition->user;
+ $olduser->remove_tradition( $tradition );
}
$newuser->add_tradition( $tradition );
$changed = 1;
my $textinfo = {
textid => $textid,
name => $tradition->name,
- language => $tradition->language,
- public => $tradition->public,
- owner => $tradition->user ? $tradition->user->id : undef,
+ public => $tradition->public || 0,
+ owner => $tradition->user ? $tradition->user->email : undef,
witnesses => [ map { $_->sigil } $tradition->witnesses ],
};
- my @stemmasvg = map { $_->as_svg({ size => [ 500, 375 ] }) } $tradition->stemmata;
+ if( $tradition->can('language') ) {
+ $textinfo->{'language'} = $tradition->language;
+ }
+ if( $tradition->can('stemweb_jobid') ) {
+ $textinfo->{'stemweb_jobid'} = $tradition->stemweb_jobid || 0;
+ }
+ my @stemmasvg = map { {
+ name => $_->identifier,
+ directed => _json_bool( !$_->is_undirected ),
+ svg => $_->as_svg() } }
+ $tradition->stemmata;
map { $_ =~ s/\n/ /mg } @stemmasvg;
$textinfo->{stemmata} = \@stemmasvg;
$c->stash->{'result'} = $textinfo;
my( $self, $c, $textid ) = @_;
my $tradition = $c->model('Directory')->tradition( $textid );
unless( $tradition ) {
- return _json_error( $c, 500, "No tradition with ID $textid" );
+ return _json_error( $c, 404, "No tradition with ID $textid" );
}
my $ok = _check_permission( $c, $tradition );
return unless $ok;
my $m = $c->model('Directory');
my $tradition = $m->tradition( $textid );
unless( $tradition ) {
- return _json_error( $c, 500, "No tradition with ID $textid" );
+ return _json_error( $c, 404, "No tradition with ID $textid" );
}
my $ok = _check_permission( $c, $tradition );
return unless $ok;
if( $c->req->method eq 'POST' ) {
if( $ok eq 'full' ) {
my $dot = $c->request->body_params->{'dot'};
+ # Graph::Reader::Dot does not handle bare unicode. We get around this
+ # by wrapping all words in double quotes, as long as they aren't already
+ # wrapped, and as long as they aren't the initial '(di)?graph .*'.
+ # Horrible HACK.
+ my @dlines = split( "\n", $dot );
+ my $wdot = '';
+ foreach( @dlines ) {
+ unless( /^(di)?graph/ ) { # Skip the first line
+ s/(?<!")\b(\w+)\b(?!")/"$1"/g;
+ }
+ $wdot .= "$_\n";
+ }
+ # $dot =~ s/(?<!")\b(?!(?:digraph|stemma)\b)(\w+)\b(?!")/"$1"/g;
+ $dot = $wdot;
+ print STDERR "$dot\n";
try {
if( $stemmaid eq 'n' ) {
# We are adding a new stemma.
+ $stemmaid = $tradition->stemma_count;
$stemma = $tradition->add_stemma( 'dot' => $dot );
+ } elsif( $stemmaid !~ /^\d+$/ ) {
+ return _json_error( $c, 403, "Invalid stemma ID specification $stemmaid" );
} elsif( $stemmaid < $tradition->stemma_count ) {
# We are updating an existing stemma.
$stemma = $tradition->stemma( $stemmaid );
$stemma->alter_graph( $dot );
} else {
# Unrecognized stemma ID
- return _json_error( $c, 500, "No stemma at index $stemmaid, cannot update" );
+ return _json_error( $c, 404, "No stemma at index $stemmaid, cannot update" );
}
} catch ( Text::Tradition::Error $e ) {
return _json_error( $c, 500, $e->message );
# For a GET or a successful POST request, return the SVG representation
# of the stemma in question, if any.
- $c->log->debug( "Received Accept header: " . $c->req->header('Accept') );
if( !$stemma && $tradition->stemma_count > $stemmaid ) {
$stemma = $tradition->stemma( $stemmaid );
}
- $c->stash->{'result'} = $stemma
- ? $stemma->as_svg( { size => [ 500, 375 ] } ) : '';
- $c->forward('View::SVG');
+ my $stemma_xml = $stemma ? $stemma->as_svg() : '';
+ # What was requested, XML or JSON?
+ my $return_view = 'SVG';
+ if( my $accept_header = $c->req->header('Accept') ) {
+ $c->log->debug( "Received Accept header: $accept_header" );
+ foreach my $type ( split( /,\s*/, $accept_header ) ) {
+ # If we were first asked for XML, return SVG
+ last if $type =~ /^(application|text)\/xml$/;
+ # If we were first asked for JSON, return JSON
+ if( $type eq 'application/json' ) {
+ $return_view = 'JSON';
+ last;
+ }
+ }
+ }
+ if( $return_view eq 'SVG' ) {
+ $c->stash->{'result'} = $stemma_xml;
+ $c->forward('View::SVG');
+ } else { # JSON
+ $stemma_xml =~ s/\n/ /mg;
+ $c->stash->{'result'} = {
+ 'stemmaid' => $stemmaid,
+ 'name' => $stemma->identifier,
+ 'directed' => _json_bool( !$stemma->is_undirected ),
+ 'svg' => $stemma_xml };
+ $c->forward('View::JSON');
+ }
}
=head2 stemmadot
my $m = $c->model('Directory');
my $tradition = $m->tradition( $textid );
unless( $tradition ) {
- return _json_error( $c, 500, "No tradition with ID $textid" );
+ return _json_error( $c, 404, "No tradition with ID $textid" );
}
my $ok = _check_permission( $c, $tradition );
return unless $ok;
my $stemma = $tradition->stemma( $stemmaid );
unless( $stemma ) {
- return _json_error( $c, 500, "Tradition $textid has no stemma ID $stemmaid" );
+ return _json_error( $c, 404, "Tradition $textid has no stemma ID $stemmaid" );
}
# Get the dot and transmute its line breaks to literal '|n'
$c->stash->{'result'} = { 'dot' => $stemma->editable( { linesep => '|n' } ) };
$c->forward('View::JSON');
}
+=head2 download
+
+ GET /download/$textid
+
+Returns the full XML definition of the tradition and its stemmata, if any.
+
+=cut
+
+sub download :Local :Args(1) {
+ my( $self, $c, $textid ) = @_;
+ my $tradition = $c->model('Directory')->tradition( $textid );
+ unless( $tradition ) {
+ return _json_error( $c, 404, "No tradition with ID $textid" );
+ }
+ my $ok = _check_permission( $c, $tradition );
+ return unless $ok;
+ try {
+ $c->stash->{'result'} = $tradition->collation->as_graphml();
+ } catch( Text::Tradition::Error $e ) {
+ return _json_error( $c, 500, $e->message );
+ }
+ $c->forward('View::GraphML');
+}
+
####################
### Helper functions
####################
return 0;
}
+sub _json_bool {
+ return $_[0] ? JSON::true : JSON::false;
+}
+
=head2 default
Standard 404 error page