1 package stemmaweb::Controller::Stemweb;
3 use namespace::autoclean;
4 use Encode qw/ decode_utf8 /;
11 BEGIN { extends 'Catalyst::Controller' }
13 ## TODO Move the /algorithms/available function to the Stemweb module
14 my $STEMWEB_BASE_URL = 'http://slinkola.users.cs.helsinki.fi';
18 stemmaweb::Controller::Stemweb - Client listener for Stemweb results
22 This is a client listener for the Stemweb API as implemented by the protocol defined at
23 L<https://docs.google.com/document/d/1aNYGAo1v1WPDZi6LXZ30FJSMJwF8RQPYbOkKqHdCZEc/pub>.
30 Content-Type: application/json
39 result: <error message> }
41 Used by the Stemweb server to notify us that one or more stemma graphs
42 has been calculated in response to an earlier request.
46 sub result :Local :Args(0) {
48 if( $c->request->method eq 'POST' ) {
49 # TODO: Verify the sender!
51 if( ref( $c->request->body ) eq 'File::Temp' ) {
52 # Read in the file and parse that.
53 $c->log->debug( "Request body is in a temp file" );
54 open( POSTDATA, $c->request->body )
55 or return _json_error( $c, 500, "Failed to open post data file" );
56 binmode( POSTDATA, ':utf8' );
57 # JSON should be all one line
58 my $pdata = <POSTDATA>;
62 $answer = from_json( $pdata );
64 return _json_error( $c, 400,
65 "Could not parse POST request '' $pdata '' as JSON: $@" );
68 $answer = from_json( $c->request->body );
70 $c->log->debug( "Received push notification from Stemweb: "
71 . to_json( $answer ) );
72 return _process_stemweb_result( $c, $answer );
74 return _json_error( $c, 403, 'Please use POST!' );
80 GET stemweb/query/<jobid>
82 A backup method to query the stemweb server to check a particular job status.
83 Returns a result as in /stemweb/result above, but status can also be -1 to
84 indicate that the job is still running.
88 sub query :Local :Args(1) {
89 my( $self, $c, $jobid ) = @_;
90 my $ua = LWP::UserAgent->new();
91 my $resp = $ua->get( $STEMWEB_BASE_URL . "/algorithms/jobstatus/$jobid" );
92 if( $resp->is_success ) {
94 my $response = decode_utf8( $resp->content );
95 $c->log->debug( "Got a response from the server: $response" );
98 $answer = from_json( $response );
100 return _json_error( $c, 500,
101 "Could not parse stemweb response '' $response '' as JSON: $@" );
103 return _process_stemweb_result( $c, $answer );
104 } elsif( $resp->code == 500 && $resp->header('Client-Warning')
105 && $resp->header('Client-Warning') eq 'Internal response' ) {
106 # The server was unavailable.
107 return _json_error( $c, 503, "The Stemweb server is currently unreachable." );
109 return _json_error( $c, 500, "Stemweb error: " . $resp->code . " / "
115 ## Helper function for parsing Stemweb result data either by push or by pull
116 sub _process_stemweb_result {
117 my( $c, $answer ) = @_;
118 # Find the specified tradition and check its job ID.
119 my $m = $c->model('Directory');
120 my $tradition = $m->tradition( $answer->{textid} );
121 unless( $tradition ) {
122 return _json_error( $c, 400, "No tradition found with ID "
123 . $answer->{textid} );
125 if( $answer->{status} == 0 ) {
127 if( $tradition->has_stemweb_jobid
128 && $tradition->stemweb_jobid eq $answer->{jobid} ) {
130 $stemmata = $tradition->record_stemweb_result( $answer );
131 $m->save( $tradition );
132 } catch( Text::Tradition::Error $e ) {
133 return _json_error( $c, 500, $e->message );
135 return _json_error( $c, 500, $@ );
138 # It may be that we already received a callback meanwhile.
139 # Check all stemmata for the given jobid and return them.
140 @$stemmata = grep { $_->came_from_jobid && $_->from_jobid eq $answer->{jobid} } $tradition->stemmata;
144 # If we got here, success!
145 my @steminfo = map { {
146 name => $_->identifier,
147 directed => _json_bool( !$_->is_undirected ),
148 svg => $_->as_svg() } }
150 $c->stash->{'result'} = {
151 'status' => 'success',
152 'stemmata' => \@steminfo };
154 # Hm, no stemmata found on this tradition with this jobid.
155 # Clear the tradition jobid so that the user can try again.
156 if( $tradition->has_stemweb_jobid ) {
157 $tradition->_clear_stemweb_jobid;
158 $m->save( $tradition );
160 $c->stash->{'result'} = { status => 'notfound' };
162 } elsif( $answer->{status} < 1 ) {
163 $c->stash->{'result'} = { 'status' => 'running' };
165 return _json_error( $c, 500,
166 "Stemweb failure not handled: " . $answer->{result} );
168 $c->forward('View::JSON');
173 GET stemweb/request/?
174 tradition=<tradition ID> &
175 algorithm=<algorithm ID> &
176 [<algorithm parameters>]
178 Send a request for the given tradition with the given parameters to Stemweb.
179 Processes and returns the JSON response given by the Stemweb server.
183 sub request :Local :Args(0) {
184 my( $self, $c ) = @_;
185 # Look up the relevant tradition and check permissions.
186 my $reqparams = $c->req->params;
187 my $tid = delete $reqparams->{tradition};
188 my $t = $c->model('Directory')->tradition( $tid );
189 my $ok = _check_permission( $c, $t );
191 return( _json_error( $c, 403,
192 'You do not have permission to update stemmata for this tradition' ) )
193 unless $ok eq 'full';
195 # Form the request for Stemweb.
196 my $algorithm = delete $reqparams->{algorithm};
197 my $return_uri = URI->new( $c->uri_for( '/stemweb/result' ) );
198 my $stemweb_request = {
199 return_path => $return_uri->path,
200 return_host => $return_uri->host_port,
201 data => $t->collation->as_tsv({noac => 1}),
202 userid => $c->user->get_object->email,
204 parameters => $reqparams };
206 # Call to the appropriate URL with the request parameters.
207 my $ua = LWP::UserAgent->new();
208 $c->log->debug( 'Sending request to Stemweb: ' . to_json( $stemweb_request ) );
209 my $resp = $ua->post( $STEMWEB_BASE_URL . "/algorithms/process/$algorithm/",
210 'Content-Type' => 'application/json; charset=utf-8',
211 'Content' => encode_json( $stemweb_request ) );
212 if( $resp->is_success ) {
214 $c->log->debug( 'Got a response from the server: '
215 . decode_utf8( $resp->content ) );
216 my $stemweb_response = decode_json( $resp->content );
218 $t->set_stemweb_jobid( $stemweb_response->{jobid} );
219 } catch( Text::Tradition::Error $e ) {
220 return _json_error( $c, 429, $e->message );
222 $c->model('Directory')->save( $t );
223 $c->stash->{'result'} = $stemweb_response;
224 $c->forward('View::JSON');
225 } elsif( $resp->code == 500 && $resp->header('Client-Warning')
226 && $resp->header('Client-Warning') eq 'Internal response' ) {
227 # The server was unavailable.
228 return _json_error( $c, 503, "The Stemweb server is currently unreachable." );
230 return _json_error( $c, 500, "Stemweb error: " . $resp->code . " / "
235 # Helper to check what permission, if any, the active user has for
236 # the given tradition
237 sub _check_permission {
238 my( $c, $tradition ) = @_;
239 my $user = $c->user_exists ? $c->user->get_object : undef;
241 return 'full' if ( $user->is_admin ||
242 ( $tradition->has_user && $tradition->user->id eq $user->id ) );
244 # Text doesn't belong to us, so maybe it's public?
245 return 'readonly' if $tradition->public;
247 # ...nope. Forbidden!
248 return _json_error( $c, 403, 'You do not have permission to view this tradition.' );
251 # Helper to throw a JSON exception
253 my( $c, $code, $errmsg ) = @_;
254 $c->response->status( $code );
255 $c->stash->{'result'} = { 'error' => $errmsg };
256 $c->forward('View::JSON');
261 return $_[0] ? JSON::true : JSON::false;