From: tla <tla@mit.edu>
Date: Tue, 29 Oct 2013 13:13:41 +0000 (+0100)
Subject: Implement the Stemweb request UI; start untested implementation of backend (#29)
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=scpubgit%2Fstemmaweb.git;a=commitdiff_plain;h=7074436718faf60f0a173d439f8db2ca97de2e3b

Implement the Stemweb request UI; start untested implementation of backend (#29)
---

diff --git a/lib/stemmaweb/Controller/Stemweb.pm b/lib/stemmaweb/Controller/Stemweb.pm
index 8aa8786..f0ffa08 100644
--- a/lib/stemmaweb/Controller/Stemweb.pm
+++ b/lib/stemmaweb/Controller/Stemweb.pm
@@ -2,11 +2,16 @@ package stemmaweb::Controller::Stemweb;
 use Moose;
 use namespace::autoclean;
 use JSON qw/ from_json /;
+use LWP::UserAgent;
 use Safe::Isa;
 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';
+
 =head1 NAME
 
 stemmaweb::Controller::Stemweb - Client listener for Stemweb results
@@ -93,6 +98,82 @@ sub result :Local :Args(0) {
 	}
 }
 
+=head2 request
+
+ GET stemweb/request/?
+	tradition=<tradition ID> &
+	algorithm=<algorithm ID> &
+	[<algorithm parameters>]
+   
+Send a request for the given tradition with the given parameters to Stemweb.
+Processes and returns the JSON response given by the Stemweb server.
+
+=cut
+
+sub request :Local :Args(0) {
+	my( $self, $c ) = @_;
+	# Look up the relevant tradition and check permissions.
+	my $reqparams = $c->req->params;
+	my $tid = delete $reqparams->{tradition};
+	my $t = $c->model('Directory')->tradition( $tid );
+	my $ok = _check_permission( $c, $t );
+	return unless $ok;
+	return( _json_error( $c, 403, 
+			'You do not have permission to update stemmata for this tradition' ) )
+		unless $ok eq 'full';
+	
+	# Form the request for Stemweb.
+	my $algorithm = delete $reqparams->{algorithm};
+	my $return_uri = URI->new( $c->uri_for( '/stemweb/result' ) );
+	my $stemweb_request = {
+		return_path => $return_uri->path,
+		return_host => $return_uri->host_port,
+		data => $t->collation->as_tsv,
+		userid => $c->user->email,
+		parameters => $reqparams };
+		
+	# Call to the appropriate URL with the request parameters.
+	my $ua = LWP::UserAgent->new();
+	my $resp = $ua->post( $STEMWEB_BASE_URL . "/algorithms/process/$algorithm/",
+		'Content-Type' => 'application/json; charset=utf-8', 
+		'Content' => encode_json( $stemweb_request ) ); 
+	if( $resp->is_success ) {
+		# Process it
+		my $stemweb_response = decode_json( $resp->content );
+		try {
+			$t->set_stemweb_jobid( $stemweb_response->{jobid} );
+		} catch( Text::Tradition::Error $e ) {
+			return _json_error( $c, 429, $e->message );
+		}
+		$c->model('Directory')->save( $t );
+		$c->stash->{'result'} = $stemweb_response;
+		$c->forward('View::JSON');
+	} elsif( $resp->code == 500 && $resp->header('Client-Warning')
+		&& $resp->header('Client-Warning') eq 'Internal response' ) {
+		# The server was unavailable.
+		return _json_error( $c, 503, "The Stemweb server is currently unreachable." );
+	} else {
+		return _json_error( $c, 500, "Stemweb error: " . $resp->status . " / "
+			. $resp->content );
+	}
+}
+
+# Helper to check what permission, if any, the active user has for
+# the given tradition
+sub _check_permission {
+	my( $c, $tradition ) = @_;
+    my $user = $c->user_exists ? $c->user->get_object : undef;
+    if( $user ) {
+    	return 'full' if ( $user->is_admin || 
+    		( $tradition->has_user && $tradition->user->id eq $user->id ) );
+    }
+	# Text doesn't belong to us, so maybe it's public?
+	return 'readonly' if $tradition->public;
+
+	# ...nope. Forbidden!
+	return _json_error( $c, 403, 'You do not have permission to view this tradition.' );
+}
+
 # Helper to throw a JSON exception
 sub _json_error {
 	my( $c, $code, $errmsg ) = @_;
diff --git a/root/js/componentload.js b/root/js/componentload.js
index 352d34a..80112d3 100644
--- a/root/js/componentload.js
+++ b/root/js/componentload.js
@@ -447,29 +447,20 @@ $(document).ready( function() {
 
 	$('#stemweb-ui-dialog').dialog({
 		autoOpen: false,
-		height: 200,
-		width: 300,
+		height: 160,
+		width: 225,
 		modal: true,
 		buttons: {
 			Run: function (evt) {
 				$("#stemweb_run_status").empty();
 				$(evt.target).button("disable");
-				var stemmaseq = $('#stemmaseq').val();
-				var requrl = _get_url([ "stemma", selectedTextID, stemmaseq ]);
-				var reqparam = { 'dot': $('#dot_field').val() };
+				var requrl = _get_url([ "stemweb", "request" ]);
+				var reqparam = $('#call_stemweb').serialize();
 				// TODO We need to stash the literal SVG string in stemmata
 				// somehow. Implement accept header on server side to decide
 				// whether to send application/json or application/xml?
-				$.post( requrl, reqparam, function (data) {
-					// We received a stemma SVG string in return. 
-					// Update the current stemma sequence number
-					selectedStemmaID = data.stemmaid;
-					delete data.stemmaid;
-					// Stash the answer in the appropriate spot in our stemma array
-					stemmata[selectedStemmaID] = data;
-					// Display the new stemma
-					load_stemma( selectedStemmaID, true );
-					// Reenable the button and close the form
+				$.getJSON( requrl, reqparam, function (data) {
+					// Job ID is in data.jobid. TODO do something with it.
 					$(evt.target).button("enable");
 					$('#stemma-edit-dialog').dialog('close');
 				}, 'json' );
@@ -484,11 +475,11 @@ $(document).ready( function() {
 			var algorithmTypes = {};
 			var algorithmArgs = {};
 			$.each( stemwebAlgorithms, function( i, o ) {
-				// If it's an algorithmarg, skip it for now
 				if( o.model === 'algorithms.algorithm' ) {
+					// it's an algorithm.
 					algorithmTypes[ o.pk ] = o.fields;
-				} else {
-					// it's an arg
+				} else if( o.model == 'algorithms.algorithmarg'	&& o.fields.external ) {
+					// it's an option for an algorithm that we should display.
 					algorithmArgs[ o.pk ] = o.fields;
 				}
 			});
@@ -496,10 +487,43 @@ $(document).ready( function() {
 				var algopt = $('<option>').attr( 'value', pk ).append( fields.name );
 				$('#stemweb_algorithm').append( algopt );
 			});
-			// TODO add the algorithm args
+			// Set up the relevant options for whichever algorithm is chosen.
+			// "key" -> form name, option ID "stemweb_$key_opt"
+			// "name" -> form label
+			$('#stemweb_algorithm').change( function() {
+				var pk = $(this).val();
+				$('#stemweb_runtime_options').empty();
+				$.each( algorithmTypes[pk].args, function( i, apk ) {
+					var argInfo = algorithmArgs[apk];
+					if( argInfo ) {
+						// Make the element ID
+						var optId = 'stemweb_' + argInfo.key + '_opt';
+						// Make the label
+						var optLabel = $('<label>').attr( 'for', optId )
+							.append( argInfo.name + ": " );
+						var optCtrl;
+						var argType = argInfo.value;
+						if( argType === 'positive_integer' ) {
+							// Make it an input field of smallish size.
+							optCtrl = $('<input>').attr( 'size', 4 );
+						} else if ( argType === 'boolean' ) {
+							// Make it a checkbox.
+							optCtrl = $('<checkbox>');
+						}
+						// Add the name and element ID
+						optCtrl.attr( 'name', argInfo.name ).attr( 'id', optId );
+						// Append the label and the option itself to the form.
+						$('#stemweb_runtime_options').append( optLabel )
+							.append( optCtrl ).append( $('<br>') );
+					}
+				});
+			});
+			// Prime the initial options
+			$('#stemweb_algorithm').change();
 		},
 		open: function(evt) {
-			$("#stemweb_run_status").empty();
+			$('#stemweb_run_status').empty();
+			$('#stemweb_tradition').attr('val', selectedTextID );
 		},
 	}).ajaxError( function(event, jqXHR, ajaxSettings, thrownError) {
 		$(event.target).parent().find('.ui-button').button("enable");
diff --git a/root/src/index.tt b/root/src/index.tt
index 2c2f735..c0daf8e 100644
--- a/root/src/index.tt
+++ b/root/src/index.tt
@@ -153,11 +153,12 @@ var stemwebAlgorithms = [% stemweb_algorithms %];
     </div>
 
 	<!-- Stemweb UI dialog box -->
-    <div id="stemweb-ui-dialog">
+    <div id="stemweb-ui-dialog" title="Generate a Stemweb tree">
       <div id="stemweb_ui_container">
     	<form id="call_stemweb">
-    		<label for="algorithm">Run algorithm:</label><br/>
-    		<select id="stemweb_algorithm" name="algorithm"></select>
+    		<input id="stemweb_tradition" type="hidden" name="tradition"/>
+    		<label for="algorithm">Run algorithm: </label>
+    		<select id="stemweb_algorithm" name="algorithm"></select><br/>
     		<!-- Algorithm-specific options, if any, will be added within this div -->
     		<div id="stemweb_runtime_options"></div>
     	</form>