1 package stemmaweb::Controller::Root;
3 use namespace::autoclean;
4 use Text::Tradition::Analysis qw/ run_analysis /;
8 BEGIN { extends 'Catalyst::Controller' }
11 # Sets the actions in this controller to be registered with no prefix
12 # so they function identically to actions created in MyApp.pm
14 __PACKAGE__->config(namespace => '');
18 stemmaweb::Controller::Root - Root Controller for stemmaweb
22 Serves up the main container pages.
28 The root page (/). Serves the main container page, from which the various
29 components will be loaded.
33 sub index :Path :Args(0) {
34 my ( $self, $c ) = @_;
36 $c->stash->{template} = 'index.tt';
39 =head1 Elements of index page
45 Serves a snippet of HTML that lists the available texts. This returns texts belonging to the logged-in user if any, otherwise it returns all public texts.
49 sub directory :Local :Args(0) {
51 my $m = $c->model('Directory');
52 # Is someone logged in?
54 if( $c->user_exists ) {
55 my $user = $c->user->get_object;
56 my @list = $m->traditionlist( $user );
57 map { $usertexts{$_->{id}} = 1 } @list;
58 $c->stash->{usertexts} = \@list;
59 $c->stash->{is_admin} = 1 if $user->is_admin;
61 # List public (i.e. readonly) texts separately from any user (i.e.
62 # full access) texts that exist. Admin users therefore have nothing
64 my @plist = grep { !$usertexts{$_->{id}} } $m->traditionlist('public');
65 $c->stash->{publictexts} = \@plist;
66 $c->stash->{template} = 'directory.tt';
69 =head1 AJAX methods for traditions and their properties
79 Creates a new tradition belonging to the logged-in user, with the given name
80 and the collation given in the uploaded file. The file type is indicated via
81 the filename extension (.csv, .txt, .xls, .xlsx, .xml). Returns the ID and
82 name of the new tradition.
86 sub newtradition :Local :Args(0) {
88 return _json_error( $c, 403, 'Cannot save a tradition without being logged in' )
89 unless $c->user_exists;
91 my $user = $c->user->get_object;
92 # Grab the file upload, check its name/extension, and call the
93 # appropriate parser(s).
94 my $upload = $c->request->upload('file');
95 my $name = $c->request->param('name') || 'Uploaded tradition';
96 my $lang = $c->request->param( 'language' ) || 'Default';
97 my $public = $c->request->param( 'public' ) ? 1 : undef;
98 my( $ext ) = $upload->filename =~ /\.(\w+)$/;
103 'file' => $upload->tempname
108 if( $ext eq 'xml' ) {
109 # Try the different XML parsing options to see if one works.
110 foreach my $type ( qw/ CollateX CTE TEI / ) {
112 $tradition = Text::Tradition->new( %newopts, 'input' => $type );
113 } catch ( Text::Tradition::Error $e ) {
114 $errmsg = $e->message;
116 $errmsg = "Unexpected parsing error";
120 } elsif( $ext =~ /^(txt|csv|xls(x)?)$/ ) {
121 # If it's Excel we need to pass excel => $ext;
122 # otherwise we need to pass sep_char => [record separator].
123 if( $ext =~ /xls/ ) {
124 $newopts{'excel'} = $ext;
126 $newopts{'sep_char'} = $ext eq 'txt' ? "\t" : ',';
129 $tradition = Text::Tradition->new(
131 'input' => 'Tabular',
133 } catch ( Text::Tradition::Error $e ) {
134 $errmsg = $e->message;
136 $errmsg = "Unexpected parsing error";
139 # Error unless we have a recognized filename extension
140 return _json_error( $c, 500, "Unrecognized file type extension $ext" );
143 # Save the tradition if we have it, and return its data or else the
144 # error that occurred trying to make it.
146 return _json_error( $c, 500, "Error parsing tradition .$ext file: $errmsg" );
147 } elsif( !$tradition ) {
148 return _json_error( $c, 500, "No error caught but tradition not created" );
151 my $m = $c->model('Directory');
152 $user->add_tradition( $tradition );
153 my $id = $c->model('Directory')->store( $tradition );
154 $c->model('Directory')->store( $user );
155 $c->stash->{'result'} = { 'id' => $id, 'name' => $tradition->name };
156 $c->forward('View::JSON');
161 GET /textinfo/$textid
162 POST /textinfo/$textid,
164 language: $new_language,
166 owner: $new_userid } # only admin users can update the owner
168 Returns information about a particular text.
172 sub textinfo :Local :Args(1) {
173 my( $self, $c, $textid ) = @_;
174 my $tradition = $c->model('Directory')->tradition( $textid );
175 unless( $tradition ) {
176 return _json_error( $c, 500, "No tradition with ID $textid" );
178 my $ok = _check_permission( $c, $tradition );
180 if( $c->req->method eq 'POST' ) {
181 return _json_error( $c, 403,
182 'You do not have permission to update this tradition' )
183 unless $ok eq 'full';
184 my $params = $c->request->parameters;
185 # Handle changes to owner-accessible parameters
186 my $m = $c->model('Directory');
188 # Handle scalar params
189 foreach my $param ( qw/ name language / ) {
190 if( exists $params->{$param} ) {
191 my $newval = delete $params->{$param};
192 unless( $tradition->$param eq $newval ) {
194 $tradition->$param( $newval );
196 return _json_error( $c, 500, "Error setting $param to $newval" );
203 if( delete $params->{'public'} ) { # if it's any true value...
204 $tradition->public( 1 );
206 # Handle ownership changes
208 if( exists $params->{'owner'} ) {
209 # Only admins can update user / owner
210 my $newownerid = delete $params->{'owner'};
211 unless( $tradition->has_user && $tradition->user->id eq $newownerid ) {
212 unless( $c->user->get_object->is_admin ) {
213 return _json_error( $c, 403,
214 "Only admin users can change tradition ownership" );
216 $newuser = $m->lookup_user( $params->{'owner'} );
218 return _json_error( $c, 500, "No such user " . $params->{'owner'} );
220 $newuser->add_tradition( $tradition );
224 # TODO check for rogue parameters
225 if( scalar keys %$params ) {
226 my $rogueparams = join( ', ', keys %$params );
227 return _json_error( $c, 403, "Request parameters $rogueparams not recognized" );
229 # If we safely got to the end, then write to the database.
230 $m->save( $tradition ) if $changed;
231 $m->save( $newuser ) if $newuser;
234 # Now return the current textinfo, whether GET or successful POST.
237 name => $tradition->name,
238 language => $tradition->language,
239 public => $tradition->public,
240 owner => $tradition->user ? $tradition->user->id : undef,
241 witnesses => [ map { $_->sigil } $tradition->witnesses ],
243 my @stemmasvg = map { $_->as_svg({ size => [ 500, 375 ] }) } $tradition->stemmata;
244 map { $_ =~ s/\n/ /mg } @stemmasvg;
245 $textinfo->{stemmata} = \@stemmasvg;
246 $c->stash->{'result'} = $textinfo;
247 $c->forward('View::JSON');
252 GET /variantgraph/$textid
254 Returns the variant graph for the text specified at $textid, in SVG form.
258 sub variantgraph :Local :Args(1) {
259 my( $self, $c, $textid ) = @_;
260 my $tradition = $c->model('Directory')->tradition( $textid );
261 unless( $tradition ) {
262 return _json_error( $c, 500, "No tradition with ID $textid" );
264 my $ok = _check_permission( $c, $tradition );
267 my $collation = $tradition->collation;
268 $c->stash->{'result'} = $collation->as_svg;
269 $c->forward('View::SVG');
274 GET /stemma/$textid/$stemmaseq
275 POST /stemma/$textid/$stemmaseq, { 'dot' => $dot_string }
277 Returns an SVG representation of the given stemma hypothesis for the text.
278 If the URL is called with POST, the stemma at $stemmaseq will be altered
279 to reflect the definition in $dot_string. If $stemmaseq is 'n', a new
280 stemma will be added.
284 sub stemma :Local :Args(2) {
285 my( $self, $c, $textid, $stemmaid ) = @_;
286 my $m = $c->model('Directory');
287 my $tradition = $m->tradition( $textid );
288 unless( $tradition ) {
289 return _json_error( $c, 500, "No tradition with ID $textid" );
291 my $ok = _check_permission( $c, $tradition );
294 $c->stash->{'result'} = '';
296 if( $c->req->method eq 'POST' ) {
297 if( $ok eq 'full' ) {
298 my $dot = $c->request->body_params->{'dot'};
300 if( $stemmaid eq 'n' ) {
301 # We are adding a new stemma.
302 $stemma = $tradition->add_stemma( 'dot' => $dot );
303 } elsif( $stemmaid < $tradition->stemma_count ) {
304 # We are updating an existing stemma.
305 $stemma = $tradition->stemma( $stemmaid );
306 $stemma->alter_graph( $dot );
308 # Unrecognized stemma ID
309 return _json_error( $c, 500, "No stemma at index $stemmaid, cannot update" );
311 } catch ( Text::Tradition::Error $e ) {
312 return _json_error( $c, 500, $e->message );
314 $m->store( $tradition );
316 # No permissions to update the stemma
317 return _json_error( $c, 403,
318 'You do not have permission to update stemmata for this tradition' );
322 # For a GET or a successful POST request, return the SVG representation
323 # of the stemma in question, if any.
324 $c->log->debug( "Received Accept header: " . $c->req->header('Accept') );
325 if( !$stemma && $tradition->stemma_count > $stemmaid ) {
326 $stemma = $tradition->stemma( $stemmaid );
328 $c->stash->{'result'} = $stemma
329 ? $stemma->as_svg( { size => [ 500, 375 ] } ) : '';
330 $c->forward('View::SVG');
335 GET /stemmadot/$textid/$stemmaseq
337 Returns the 'dot' format representation of the current stemma hypothesis.
341 sub stemmadot :Local :Args(2) {
342 my( $self, $c, $textid, $stemmaid ) = @_;
343 my $m = $c->model('Directory');
344 my $tradition = $m->tradition( $textid );
345 unless( $tradition ) {
346 return _json_error( $c, 500, "No tradition with ID $textid" );
348 my $ok = _check_permission( $c, $tradition );
350 my $stemma = $tradition->stemma( $stemmaid );
352 return _json_error( $c, 500, "Tradition $textid has no stemma ID $stemmaid" );
354 # Get the dot and transmute its line breaks to literal '|n'
355 $c->stash->{'result'} = { 'dot' => $stemma->editable( { linesep => '|n' } ) };
356 $c->forward('View::JSON');
363 # Helper to check what permission, if any, the active user has for
364 # the given tradition
365 sub _check_permission {
366 my( $c, $tradition ) = @_;
367 my $user = $c->user_exists ? $c->user->get_object : undef;
369 return 'full' if ( $user->is_admin ||
370 ( $tradition->has_user && $tradition->user->id eq $user->id ) );
372 # Text doesn't belong to us, so maybe it's public?
373 return 'readonly' if $tradition->public;
375 # ...nope. Forbidden!
376 return _json_error( $c, 403, 'You do not have permission to view this tradition.' );
379 # Helper to throw a JSON exception
381 my( $c, $code, $errmsg ) = @_;
382 $c->response->status( $code );
383 $c->stash->{'result'} = { 'error' => $errmsg };
384 $c->forward('View::JSON');
390 Standard 404 error page
395 my ( $self, $c ) = @_;
396 $c->response->body( 'Page not found' );
397 $c->response->status(404);
402 Attempt to render a view, if needed.
406 sub end : ActionClass('RenderView') {}
414 This library is free software. You can redistribute it and/or modify
415 it under the same terms as Perl itself.
419 __PACKAGE__->meta->make_immutable;