X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Fstemmaweb%2FController%2FRelation.pm;h=008262406d4c170e3b7f8090268123c3312c4378;hb=d58766c062530ab9f1ffb35e095eadfaebc4f610;hp=536269ac5bb2aaf406babb595a0ae4b0f08877a5;hpb=b28e606ed92c3cb17501c55987af65b154090f5b;p=scpubgit%2Fstemmaweb.git diff --git a/lib/stemmaweb/Controller/Relation.pm b/lib/stemmaweb/Controller/Relation.pm index 536269a..0082624 100644 --- a/lib/stemmaweb/Controller/Relation.pm +++ b/lib/stemmaweb/Controller/Relation.pm @@ -24,99 +24,182 @@ Renders the application for the text identified by $textid. =cut -sub index :Path :Args(1) { - my( $self, $c, $textid ) = @_; - my $m = $c->model('Directory'); - my $tradition = $m->tradition( $textid ); - my $collation = $tradition->collation; - my $svg_str = $collation->as_svg; - $svg_str =~ s/\n//gs; - $c->stash->{'svg_string'} = $svg_str; +sub index :Path :Args(0) { + my( $self, $c ) = @_; $c->stash->{'template'} = 'relate.tt'; } -sub dispatcher :Path :Args(2) { - my( $self, $c, $textid, $forward ) = @_; - $c->stash->{'collation'} = $c->model('Directory')->tradition( $textid )->collation; - $c->forward( $forward ); +=head2 help + + GET relation/help + +Returns the help window HTML. + +=cut + +sub help :Local :Args(0) { + my( $self, $c ) = @_; + $c->stash->{'template'} = 'relatehelp.tt'; } -=head2 relationship_definition +=head2 definitions - GET relation/relationship_definition + GET relation/definitions Returns a data structure giving the valid types and scopes for a relationship. =cut -sub relationship_definition :Local :Args(0) { +sub definitions :Local :Args(0) { my( $self, $c ) = @_; - my $valid_relationships = [ qw/ spelling orthographic grammatical meaning / ]; + my $valid_relationships = [ qw/ spelling orthographic grammatical lexical transposition / ]; my $valid_scopes = [ qw/ local global / ]; $c->stash->{'result'} = { 'types' => $valid_relationships, 'scopes' => $valid_scopes }; $c->forward('View::JSON'); } -=head2 set_relationship - - POST relation/$textid/relationship - source_id: $source, target_id: $target, rel_type: $type, scope: $scope - -Sets the specified relationship between the readings in $source and $target. -Returns 200 and a list of node pairs where the relationship was added on success; -returns 403 and an { error: message } struct on failure. +=head2 text + GET relation/$textid/ + + Runs the relationship mapper for the specified text ID. + =cut -sub relationship :Private { +sub text :Chained('/') :PathPart('relation') :CaptureArgs(1) { + my( $self, $c, $textid ) = @_; + # If the tradition has more than 500 ranks or so, split it up. + my $tradition = $c->model('Directory')->tradition( $textid ); + # See how big the tradition is. Edges are more important than nodes + # when it comes to rendering difficulty. + my $numnodes = scalar $tradition->collation->readings; + my $numedges = scalar $tradition->collation->paths; + my $length = $tradition->collation->end->rank; + # We should display no more than roughly 500 nodes, or roughly 700 + # edges, at a time. + my $segments = $numnodes / 500; + if( $numedges / 700 > $segments ) { + $segments = $numedges / 700; + } + my $segsize = sprintf( "%.0f", $length / $segments ); + my $margin = sprintf( "%.0f", $segsize / 10 ); + if( $segments > 1 ) { + # Segment the tradition in order not to overload the browser. + my @divs; + my $r = 0; + while( $r + $margin < $length ) { + push( @divs, $r ); + $r += $segsize; + } + $c->stash->{'textsegments'} = []; + $c->stash->{'segsize'} = $segsize; + $c->stash->{'margin'} = $margin; + foreach my $i ( 0..$#divs ) { + my $seg = { 'start' => $divs[$i] }; + $seg->{'display'} = "Segment " . ($i+1); + push( @{$c->stash->{'textsegments'}}, $seg ); + } + } + $DB::single = 1; + $c->stash->{'textid'} = $textid; + $c->stash->{'tradition'} = $tradition; +} + +sub main :Chained('text') :PathPart('') :Args(0) { my( $self, $c ) = @_; - my $collation = delete $c->stash->{'collation'}; - my $node = $c->request->param('source_id'); - my $target = $c->request->param('target_id'); - my $relation = $c->request->param('rel_type'); - my $note = $c->request->param('note'); - my $scope = $c->request->param('scope'); - - my $opts = { 'type' => $relation, - 'scope' => $scope }; - - try { - my @vectors = $collation->add_relationship( $node, $target, $opts ); - $c->stash->{'result'} = \@vectors; - } catch( Text::Tradition::Error $e ) { - $c->response->status( '403' ); - $c->stash->{'result'} = { 'error' => $e->message }; + my $startseg = $c->req->param('start'); + my $tradition = delete $c->stash->{'tradition'}; + my $collation = $tradition->collation; + my $svgopts; + if( $startseg ) { + # Only render the subgraph from startseg to endseg or to END, + # whichever is less. + my $endseg = $startseg + $c->stash->{'segsize'} + $c->stash->{'margin'}; + $svgopts = { 'from' => $startseg }; + $svgopts->{'to'} = $endseg if $endseg < $collation->end->rank; + } elsif( exists $c->stash->{'textsegments'} ) { + # This is the unqualified load of a long tradition. We implicitly start + # at zero, but go only as far as 550. + my $endseg = $c->stash->{'segsize'} + $c->stash->{'margin'}; + $startseg = 0; + $svgopts = { 'to' => $endseg }; } - $c->forward('View::JSON'); + my $svg_str = $collation->as_svg( $svgopts ); + $svg_str =~ s/\n//gs; + $c->stash->{'startseg'} = $startseg if defined $startseg; + $c->stash->{'svg_string'} = $svg_str; + $c->stash->{'text_title'} = $tradition->name; + $c->stash->{'template'} = 'relate.tt'; } =head2 relationships GET relation/$textid/relationships -Returns a list of relationships that exist in the specified text. Each -relationship is returned in a struct that looks like: +Returns the list of relationships defined for this text. -{ source: $sid, target: $tid, type: $rel_type, scope: $rel_scope } + POST relation/$textid/relationships { request } + +Attempts to define the requested relationship within the text. Returns 200 on +success or 403 on error. + + DELETE relation/$textid/relationships { request } + =cut -sub get_relationships :Private { +sub relationships :Chained('text') :PathPart :Args(0) { my( $self, $c ) = @_; - my $collation = delete $c->stash->{'collation'}; - # TODO make this API - my @pairs = $collation->relationships; # returns the edges - my @all_relations; - foreach my $p ( @pairs ) { - my $relobj = $collation->relations->get_relationship( @$p ); - push( @all_relations, - { source => $p->[0], target => $p->[1], - type => $relobj->type, scope => $relobj->scope } ); + my $tradition = delete $c->stash->{'tradition'}; + my $collation = $tradition->collation; + my $m = $c->model('Directory'); + if( $c->request->method eq 'GET' ) { + my @pairs = $collation->relationships; # returns the edges + my @all_relations; + foreach my $p ( @pairs ) { + my $relobj = $collation->relations->get_relationship( @$p ); + next if $relobj->type eq 'collated'; # Don't show these + my $relhash = { source => $p->[0], target => $p->[1], + type => $relobj->type, scope => $relobj->scope }; + $relhash->{'note'} = $relobj->annotation if $relobj->has_annotation; + push( @all_relations, $relhash ); + } + $c->stash->{'result'} = \@all_relations; + } elsif( $c->request->method eq 'POST' ) { + my $node = $c->request->param('source_id'); + my $target = $c->request->param('target_id'); + my $relation = $c->request->param('rel_type'); + my $note = $c->request->param('note'); + my $scope = $c->request->param('scope'); + + my $opts = { 'type' => $relation, + 'scope' => $scope }; + $opts->{'annotation'} = $note if $note; + + try { + my @vectors = $collation->add_relationship( $node, $target, $opts ); + $c->stash->{'result'} = \@vectors; + $m->save( $tradition ); + } catch( Text::Tradition::Error $e ) { + $c->response->status( '403' ); + $c->stash->{'result'} = { 'error' => $e->message }; + } + } elsif( $c->request->method eq 'DELETE' ) { + my $node = $c->request->param('source_id'); + my $target = $c->request->param('target_id'); + + try { + my @vectors = $collation->del_relationship( $node, $target ); + $m->save( $tradition ); + $c->stash->{'result'} = \@vectors; + } catch( Text::Tradition::Error $e ) { + $c->response->status( '403' ); + $c->stash->{'result'} = { 'error' => $e->message }; + } } - $c->stash->{'result'} = \@all_relations; $c->forward('View::JSON'); } - + =head2 end