fix Stemweb reporting bug
[scpubgit/stemmaweb.git] / lib / stemmaweb / Controller / Stemweb.pm
index cab3b2e..a9e7755 100644 (file)
@@ -5,13 +5,17 @@ use Encode qw/ decode_utf8 /;
 use JSON;
 use LWP::UserAgent;
 use Safe::Isa;
+use Scalar::Util qw/ looks_like_number /;
 use TryCatch;
 use URI;
 
 BEGIN { extends 'Catalyst::Controller' }
 
-## TODO Move the /algorithms/available function to the Stemweb module
-my $STEMWEB_BASE_URL = 'http://slinkola.users.cs.helsinki.fi';
+has stemweb_url => (
+       is => 'ro',
+       isa => 'Str',
+       default => 'http://slinkola.users.cs.helsinki.fi',
+       );
 
 =head1 NAME
 
@@ -29,7 +33,7 @@ L<https://docs.google.com/document/d/1aNYGAo1v1WPDZi6LXZ30FJSMJwF8RQPYbOkKqHdCZE
  POST stemweb/result
  Content-Type: application/json
  (On success):
- { job_id: <ID number>
+ { jobid: <ID number>
    status: 0
    format: <format>
    result: <data> }
@@ -50,7 +54,9 @@ sub result :Local :Args(0) {
                my $answer;
                if( ref( $c->request->body ) eq 'File::Temp' ) {
                        # Read in the file and parse that.
-                       open( POSTDATA, $c->request->body ) or die "Failed to open post data file";
+                       $c->log->debug( "Request body is in a temp file" );
+                       open( POSTDATA, $c->request->body ) 
+                               or return _json_error( $c, 500, "Failed to open post data file" );
                        binmode( POSTDATA, ':utf8' );
                        # JSON should be all one line
                        my $pdata = <POSTDATA>;
@@ -65,12 +71,35 @@ sub result :Local :Args(0) {
                } else {
                        $answer = from_json( $c->request->body );
                }
+               $c->log->debug( "Received push notification from Stemweb: "
+                       . to_json( $answer ) );
                return _process_stemweb_result( $c, $answer );
        } else {
                return _json_error( $c, 403, 'Please use POST!' );
        }
 }
 
+=head2 available
+
+ GET algorithms/available
+Queries the Stemweb server for available stemma generation algorithms and their 
+parameters. Returns the JSON answer as obtained from Stemweb.
+
+=cut
+
+sub available :Local :Args(0) {
+       my( $self, $c ) = @_;
+       my $ua = LWP::UserAgent->new();
+       my $resp = $ua->get( $self->stemweb_url . '/algorithms/available' );
+       if( $resp->is_success ) {
+               $c->stash->{'result'} = decode_json( $resp->content );
+       } else {
+               $c->stash->{'result'} = {};
+       }
+       $c->forward('View::JSON');
+}
+
 =head2 query
 
  GET stemweb/query/<jobid>
@@ -84,7 +113,7 @@ indicate that the job is still running.
 sub query :Local :Args(1) {
        my( $self, $c, $jobid ) = @_;
        my $ua = LWP::UserAgent->new();
-       my $resp = $ua->get( $STEMWEB_BASE_URL . "/algorithms/jobstatus/$jobid" );
+       my $resp = $ua->get( $self->stemweb_url . "/algorithms/jobstatus/$jobid" );
        if( $resp->is_success ) {
                # Process it
                my $response = decode_utf8( $resp->content );
@@ -111,24 +140,17 @@ sub query :Local :Args(1) {
 ## Helper function for parsing Stemweb result data either by push or by pull
 sub _process_stemweb_result {
        my( $c, $answer ) = @_;
-       # Find a tradition with the defined Stemweb job ID.
-       # TODO: Maybe get Stemweb to pass back the tradition ID...
+       # Find the specified tradition and check its job ID.
        my $m = $c->model('Directory');
-       my @traditions;
-       ## STUPID HACK: unless we load the possible tradition owners
-       ## within scope of the scan, they will not exist when the affected
-       ## tradition is saved.
-       my @users;
-       $m->scan( sub{ push( @traditions, $_[0] )
-                                       if $_[0]->$_isa('Text::Tradition')
-                                       && $_[0]->has_stemweb_jobid 
-                                       && $_[0]->stemweb_jobid eq $answer->{job_id}; 
-                       push( @users, $_[0] ) if $_[0]->$_isa('Text::Tradition::User');
-                               } );
-       if( @traditions == 1 ) {
-               my $tradition = shift @traditions;
-               if( $answer->{status} == 0 ) {
-                       my $stemmata;
+       my $tradition = $m->tradition( $answer->{textid} );
+       unless( $tradition ) {
+               return _json_error( $c, 400, "No tradition found with ID "
+                       . $answer->{textid} );
+       }
+       if( $answer->{status} == 0 ) {
+               my $stemmata;
+               if( $tradition->has_stemweb_jobid 
+                       && $tradition->stemweb_jobid eq $answer->{jobid} ) {
                        try {
                                $stemmata = $tradition->record_stemweb_result( $answer );
                                $m->save( $tradition );
@@ -137,7 +159,14 @@ sub _process_stemweb_result {
                        } catch {
                                return _json_error( $c, 500, $@ );
                        }
+               } else {
+                       # It may be that we already received a callback meanwhile.
+                       # Check all stemmata for the given jobid and return them.
+                       @$stemmata = grep { $_->came_from_jobid && $_->from_jobid eq $answer->{jobid} } $tradition->stemmata;
+               }
+               if( @$stemmata ) {
                        # If we got here, success!
+                       # TODO Use helper in Root.pm to do this
                        my @steminfo = map { { 
                                        name => $_->identifier, 
                                        directed => _json_bool( !$_->is_undirected ),
@@ -146,23 +175,20 @@ sub _process_stemweb_result {
                        $c->stash->{'result'} = { 
                                'status' => 'success',
                                'stemmata' => \@steminfo };
-               } elsif( $answer->{status} < 1 ) {
-                       $c->stash->{'result'} = { 'status' => 'running' };
                } else {
-                       return _json_error( $c, 500,
-                               "Stemweb failure not handled: " . $answer->{result} );
+                       # Hm, no stemmata found on this tradition with this jobid.
+                       # Clear the tradition jobid so that the user can try again.
+                       if( $tradition->has_stemweb_jobid ) {
+                               $tradition->_clear_stemweb_jobid;
+                               $m->save( $tradition );
+                       }
+                       $c->stash->{'result'} = { status => 'notfound' };
                }
-       } elsif( @traditions ) {
-               return _json_error( $c, 500, 
-                       "Multiple traditions with Stemweb job ID " . $answer->{job_id} . "!" );
+       } elsif( $answer->{status} == -1 ) {
+               $c->stash->{'result'} = { 'status' => 'running' };
        } else {
-               # Possible that the tradition got updated in the meantime...
-               if( $answer->{status} == 0 ) {
-                       $c->stash->{'result'} = { 'status' => 'notfound' };
-               } else {
-                       return _json_error( $c, 400, 
-                               "No tradition found with Stemweb job ID " . $answer->{job_id} );
-               }
+               return _json_error( $c, 500,
+                       "Stemweb failure not handled: " . $answer->{result} );
        }
        $c->forward('View::JSON');
 }
@@ -197,14 +223,15 @@ sub request :Local :Args(0) {
        my $stemweb_request = {
                return_path => $return_uri->path,
                return_host => $return_uri->host_port,
-               data => $t->collation->as_tsv,
+               data => $t->collation->as_tsv({noac => 1}),
                userid => $c->user->get_object->email,
-               parameters => $reqparams };
+               textid => $tid,
+               parameters => _cast_nonstrings( $reqparams ) };
                
        # Call to the appropriate URL with the request parameters.
        my $ua = LWP::UserAgent->new();
        $c->log->debug( 'Sending request to Stemweb: ' . to_json( $stemweb_request ) ); 
-       my $resp = $ua->post( $STEMWEB_BASE_URL . "/algorithms/process/$algorithm/",
+       my $resp = $ua->post( $self->stemweb_url . "/algorithms/process/$algorithm/",
                'Content-Type' => 'application/json; charset=utf-8', 
                'Content' => encode_json( $stemweb_request ) ); 
        if( $resp->is_success ) {
@@ -246,6 +273,20 @@ sub _check_permission {
        return _json_error( $c, 403, 'You do not have permission to view this tradition.' );
 }
 
+# QUICK HACK to deal with strict Stemweb validation.
+sub _cast_nonstrings {
+       my $params = shift;
+       foreach my $k ( keys %$params ) {
+               my $v = $params->{$k};
+               if( looks_like_number( $v ) ) {
+                       $params->{$k} = $v * 1;
+               } elsif ( !defined $v || $v eq 'true' ) {
+                       $params->{$k} = _json_bool( $v );
+               }
+       }
+       return $params;
+}
+
 # Helper to throw a JSON exception
 sub _json_error {
        my( $c, $code, $errmsg ) = @_;
@@ -253,7 +294,7 @@ sub _json_error {
        $c->stash->{'result'} = { 'error' => $errmsg };
        $c->forward('View::JSON');
        return 0;
-}
+}              
 
 sub _json_bool {
        return $_[0] ? JSON::true : JSON::false;