X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Fstemmaweb%2FController%2FRoot.pm;h=c77212269e40a148818483be1b5a78138e96476a;hb=8e26de0f2079f2b952536a2be1af1ba159eba5c5;hp=abc19522939b97edf1f1df04127b09158b00b292;hpb=e0b902362ea75e07419933809f6cf99a2f2d082c;p=scpubgit%2Fstemmaweb.git diff --git a/lib/stemmaweb/Controller/Root.pm b/lib/stemmaweb/Controller/Root.pm index abc1952..c772122 100644 --- a/lib/stemmaweb/Controller/Root.pm +++ b/lib/stemmaweb/Controller/Root.pm @@ -1,9 +1,10 @@ package stemmaweb::Controller::Root; -use File::Temp; use Moose; use namespace::autoclean; -use Text::Tradition::Analysis qw/ run_analysis /; +use JSON qw (); use TryCatch; +use XML::LibXML; +use XML::LibXML::XPathContext; BEGIN { extends 'Catalyst::Controller' } @@ -52,6 +53,17 @@ sub about :Local :Args(0) { $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 @@ -90,8 +102,7 @@ sub directory :Local :Args(0) { { name: , language: , public: , - filename: , - file: } + file: } Creates a new tradition belonging to the logged-in user, with the given name and the collation given in the uploaded file. The file type is indicated via @@ -100,7 +111,6 @@ name of the new tradition. =cut -## TODO Figure out how to mimic old-style HTML file uploads in AJAX / HTML5 sub newtradition :Local :Args(0) { my( $self, $c ) = @_; return _json_error( $c, 403, 'Cannot save a tradition without being logged in' ) @@ -109,35 +119,55 @@ sub newtradition :Local :Args(0) { my $user = $c->user->get_object; # Grab the file upload, check its name/extension, and call the # appropriate parser(s). - my $upload = File::Temp->new(); - print $upload $c->request->param('file'); - close $upload; + my $upload = $c->request->upload('file'); my $name = $c->request->param('name') || 'Uploaded tradition'; my $lang = $c->request->param( 'language' ) || 'Default'; my $public = $c->request->param( 'public' ) ? 1 : undef; - my( $ext ) = $c->request->param( 'filename' ) =~ /\.(\w+)$/; + my( $ext ) = $upload->filename =~ /\.(\w+)$/; my %newopts = ( 'name' => $name, 'language' => $lang, 'public' => $public, - 'file' => $upload->filename + 'file' => $upload->tempname ); 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"; - } - if( $tradition ) { - $errmsg = undef; - last; + } catch ( $e ) { + $errmsg = "Unexpected parsing error: $e"; } } } elsif( $ext =~ /^(txt|csv|xls(x)?)$/ ) { @@ -155,8 +185,8 @@ sub newtradition :Local :Args(0) { ); } 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 @@ -195,6 +225,9 @@ Returns information about a particular text. 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, 404, "No tradition with ID $textid" ); } @@ -216,18 +249,19 @@ sub textinfo :Local :Args(1) { $tradition->name( $newname ); $changed = 1; } catch { - return _json_error( $c, 500, "Error setting name to $newname" ); + 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 ) { + + 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" ); + return _json_error( $c, 500, "Error setting language to $langval: $@" ); } } @@ -242,20 +276,26 @@ sub textinfo :Local :Args(1) { } # Handle ownership change - my $newuser; if( exists $params->{'owner'} ) { # Only admins can update user / owner my $newownerid = delete $params->{'owner'}; + if( $tradition->has_user && !$tradition->user ) { + $tradition->clear_user; + } unless( !$newownerid || - ( $tradition->has_user && $tradition->user->id eq $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->find_user({ username => $newownerid }); + $newuser = $m->find_user({ email => $newownerid }); unless( $newuser ) { 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; } @@ -274,13 +314,18 @@ sub textinfo :Local :Args(1) { my $textinfo = { textid => $textid, name => $tradition->name, - language => $tradition->language, public => $tradition->public || 0, - owner => $tradition->user ? $tradition->user->id : undef, + owner => $tradition->user ? $tradition->user->email : undef, witnesses => [ map { $_->sigil } $tradition->witnesses ], }; - my @stemmasvg = map { $_->as_svg() } $tradition->stemmata; - map { $_ =~ s/\n/ /mg } @stemmasvg; + ## TODO Make these into callbacks in the other controllers maybe? + if( $tradition->can('language') ) { + $textinfo->{'language'} = $tradition->language; + } + if( $tradition->can('stemweb_jobid') ) { + $textinfo->{'stemweb_jobid'} = $tradition->stemweb_jobid || 0; + } + my @stemmasvg = map { _stemma_info( $_ ) } $tradition->stemmata; $textinfo->{stemmata} = \@stemmasvg; $c->stash->{'result'} = $textinfo; $c->forward('View::JSON'); @@ -307,6 +352,22 @@ sub variantgraph :Local :Args(1) { $c->stash->{'result'} = $collation->as_svg; $c->forward('View::SVG'); } + +sub _stemma_info { + my( $stemma, $sid ) = @_; + my $ssvg = $stemma->as_svg(); + $ssvg =~ s/\n/ /mg; + my $sinfo = { + name => $stemma->identifier, + directed => _json_bool( !$stemma->is_undirected ), + svg => $ssvg }; + if( $sid ) { + $sinfo->{stemmaid} = $sid; + } + return $sinfo; +} + +## TODO Separate stemma manipulation functionality into its own controller. =head2 stemma @@ -366,7 +427,6 @@ sub stemma :Local :Args(2) { if( !$stemma && $tradition->stemma_count > $stemmaid ) { $stemma = $tradition->stemma( $stemmaid ); } - 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') ) { @@ -382,11 +442,10 @@ sub stemma :Local :Args(2) { } } if( $return_view eq 'SVG' ) { - $c->stash->{'result'} = $stemma_xml; + $c->stash->{'result'} = $stemma->as_svg(); $c->forward('View::SVG'); } else { # JSON - $stemma_xml =~ s/\n/ /mg; - $c->stash->{'result'} = { 'stemmaid' => $stemmaid, 'stemmasvg' => $stemma_xml }; + $c->stash->{'result'} = { _stemma_info( $stemma, $stemmaid ) }; $c->forward('View::JSON'); } } @@ -417,6 +476,78 @@ sub stemmadot :Local :Args(2) { $c->forward('View::JSON'); } +=head2 stemmaroot + + POST /stemmaroot/$textid/$stemmaseq, { root: } + +Orients the given stemma so that the given node is the root (archetype). Returns the +information structure for the new stemma. + +=cut + +sub stemmaroot :Local :Args(2) { + my( $self, $c, $textid, $stemmaid ) = @_; + my $m = $c->model('Directory'); + my $tradition = $m->tradition( $textid ); + unless( $tradition ) { + return _json_error( $c, 404, "No tradition with ID $textid" ); + } + my $ok = _check_permission( $c, $tradition ); + if( $ok eq 'full' ) { + my $stemma = $tradition->stemma( $stemmaid ); + try { + $stemma->root_graph( $c->req->param('root') ); + $m->save( $tradition ); + } catch( Text::Tradition::Error $e ) { + return _json_error( $c, 400, $e->message ); + } catch { + return _json_error( $c, 500, "Error re-rooting stemma: $@" ); + } + $c->stash->{'result'} = _stemma_info( $stemma ); + $c->forward('View::JSON'); + } else { + return _json_error( $c, 403, + 'You do not have permission to update stemmata for this tradition' ); + } +} + +=head2 download + + GET /download/$textid/$format + +Returns a file for download of the tradition in the requested format. + +=cut + +sub download :Local :Args(2) { + my( $self, $c, $textid, $format ) = @_; + 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; + + my $outmethod = "as_" . lc( $format ); + my $view = "View::$format"; + $c->stash->{'name'} = $tradition->name(); + $c->stash->{'download'} = 1; + my @outputargs; + if( $format eq 'SVG' ) { + # Send the list of colors through to the backend. + # TODO Think of some way not to hard-code this. + push( @outputargs, { 'show_relations' => 'all', + 'graphcolors' => [ "#5CCCCC", "#67E667", "#F9FE72", "#6B90D4", + "#FF7673", "#E467B3", "#AA67D5", "#8370D8", "#FFC173" ] } ); + } + try { + $c->stash->{'result'} = $tradition->collation->$outmethod( @outputargs ); + } catch( Text::Tradition::Error $e ) { + return _json_error( $c, 500, $e->message ); + } + $c->forward( $view ); +} + #################### ### Helper functions #################### @@ -446,6 +577,10 @@ sub _json_error { return 0; } +sub _json_bool { + return $_[0] ? JSON::true : JSON::false; +} + =head2 default Standard 404 error page