lib/Text/Tradition/Parser/GraphML.pm

   1 package Text::Tradition::Parser::GraphML;
   2
   3 use strict;
   4 use warnings;
   5 use XML::LibXML;
   6 use XML::LibXML::XPathContext;
   7
   8 =head1 NAME
   9
  10 Text::Tradition::Parser::GraphML
  11
  12 =head1 DESCRIPTION
  13
  14 Parser module for Text::Tradition, given a GraphML file that describes
  15 a collation graph.  For further information on the GraphML format for
  16 text collation, see http://gregor.middell.net/collatex/
  17
  18 =head1 METHODS
  19
  20 =over
  21
  22 =item B<parse>
  23
  24 parse( $graph, $graphml_string );
  25
  26 Takes an initialized Text::Tradition::Graph object and a string
  27 containing the GraphML; creates the appropriate nodes and edges on the
  28 graph.
  29
  30 =cut
  31
  32 use vars qw/ $xpc %nodedata /;
  33
  34 sub parse {
  35     my( $tradition, $graphml_str ) = @_;
  36
  37     my $collation = $tradition->collation;
  38     my $parser = XML::LibXML->new();
  39     my $doc = $parser->parse_string( $graphml_str );
  40     my $graphml = $doc->documentElement();
  41     $xpc = XML::LibXML::XPathContext->new( $graphml );
  42     $xpc->registerNs( 'g', 'http://graphml.graphdrawing.org/xmlns' );
  43
  44     # First get the ID keys, for witnesses and for collation data
  45     my %witnesses;
  46     foreach my $k ( $xpc->findnodes( '//g:key' ) ) {
  47         # Each key has a 'for' attribute; the edge keys are witnesses, and
  48         # the node keys contain an ID and string for each node.
  49
  50         if( $k->getAttribute( 'for' ) eq 'node' ) {
  51             # The node data keys we expect are:
  52             # 'number' -> unique node identifier
  53             # 'token' -> reading for the node
  54             # 'identical' -> the node of which this node is
  55             #                a transposed version
  56             # 'position' -> a calculated position for the node
  57             $nodedata{ $k->getAttribute( 'attr.name' ) } = $k->getAttribute( 'id' );
  58         } else {
  59             $witnesses{ $k->getAttribute( 'id' ) } = $k->getAttribute( 'attr.name' );
  60         }
  61     }
  62
  63     my $has_explicit_positions = defined $nodedata{'position'};
  64
  65     # Add the witnesses that we have found
  66     foreach my $wit ( values %witnesses ) {
  67         $tradition->add_witness( 'sigil' => $wit );
  68     }
  69
  70     my $graph_el = $xpc->find( '/g:graphml/g:graph' )->[0];
  71
  72     # Add the nodes to the graph.  First delete the start node, because
  73     # GraphML graphs will have their own start nodes.
  74     $collation->del_reading( $collation->start() );
  75     # Map from XML IDs to node name/identity
  76     my %node_name;
  77     # Keep track of whatever extra info we're passed
  78     my $extra_data = {};
  79     my @nodes = $xpc->findnodes( '//g:node' );
  80     foreach my $n ( @nodes ) {
  81         my $id = _lookup_node_data( $n, 'number' );
  82         my $label = _lookup_node_data( $n, 'token' );
  83         my $gnode = $collation->add_reading( $id );
  84         $node_name{ $n->getAttribute('id') } = $id;
  85         $gnode->set_attribute( 'label', $label );
  86
  87         # Now get the rest of the data, i.e. not the ID or label
  88         my $extra = {};
  89         foreach my $k ( keys %nodedata ) {
  90             next if $k =~ /^(number|token)$/;
  91             $extra->{ $k } = _lookup_node_data( $n, $k );
  92         }
  93         $extra_data->{ $id } = $extra;
  94     }
  95
  96     # Now add the edges.
  97     my @edges = $xpc->findnodes( '//g:edge' );
  98     foreach my $e ( @edges ) {
  99         my $from = $node_name{ $e->getAttribute('source') };
 100         my $to = $node_name{ $e->getAttribute('target') };
 101         # Label according to the witnesses present.
 102         my @wit_ids = $xpc->findnodes( './g:data/attribute::key', $e );
 103         my @wit_names = map { $witnesses{ $_->getValue() } } @wit_ids;
 104         my $label = $collation->path_label( @wit_names );
 105         $collation->add_path( $from, $to, $label );
 106     }
 107
 108     ## Reverse the node_name hash so that we have two-way lookup.
 109     my %node_id = reverse %node_name;
 110
 111     ## Record the nodes that are marked as transposed.
 112     my $tr_xpath = '//g:node[g:data[@key="' . $nodedata{'identical'} . '"]]';
 113     my $transposition_nodes = $xpc->find( $tr_xpath );
 114     foreach my $tn ( @$transposition_nodes ) {
 115         my $id_xpath = sprintf( './g:data[@key="%s"]/text()',
 116                                 $nodedata{'identical'} );
 117         $collation->reading( $node_id{ $tn->getAttribute( 'id' ) } )->
 118             set_identical( $collation->reading(
 119                                $node_name{ $xpc->findvalue( $id_xpath, $tn ) } ) );
 120     }
 121
 122     # Find the beginning and end nodes of the graph.  The beginning node
 123     # has no incoming edges; the end node has no outgoing edges.
 124     my( $begin_node, $end_node );
 125     foreach my $gnode ( $collation->readings() ) {
 126         # print STDERR "Checking node " . $gnode->name . "\n";
 127         my @outgoing = $gnode->outgoing();
 128         my @incoming = $gnode->incoming();
 129
 130         unless( scalar @incoming ) {
 131             warn "Already have a beginning node" if $begin_node;
 132             $begin_node = $gnode;
 133             $collation->start( $gnode );
 134         }
 135         unless( scalar @outgoing ) {
 136             warn "Already have an ending node" if $end_node;
 137             $end_node = $gnode;
 138         }
 139     }
 140
 141     $collation->walk_witness_paths( $end_node );
 142     # Now we have added the witnesses and their paths, so have also
 143     # implicitly marked the common nodes. Now we can calculate their
 144     # explicit permissions.  This is separate because it won't always
 145     # be necessary with the GraphML parsing.
 146     $collation->calculate_positions() unless $has_explicit_positions;
 147     if( $has_explicit_positions ) {
 148         # Record the positions that came with each graph node.
 149         # TODO we really need to translate these into our own style of
 150         # position identifier.  That's why we defer this until now.
 151         foreach my $node_id ( keys %$extra_data ) {
 152             my $pos = $extra_data->{$node_id}->{'position'};
 153             $collation->reading( $node_name{$node_id} )->position( $pos );
 154         }
 155     } else {
 156         # Calculate a position for each graph node.
 157         $collation->calculate_positions();
 158     }
 159 }
 160
 161 sub _lookup_node_data {
 162     my( $xmlnode, $key ) = @_;
 163     my $lookup_xpath = './g:data[@key="%s"]/child::text()';
 164     my $data = $xpc->findvalue( sprintf( $lookup_xpath, $nodedata{$key} ),
 165                                 $xmlnode );
 166     return $data;
 167 }
 168
 169 =back
 170
 171 =head1 LICENSE
 172
 173 This package is free software and is provided "as is" without express
 174 or implied warranty.  You can redistribute it and/or modify it under
 175 the same terms as Perl itself.
 176
 177 =head1 AUTHOR
 178
 179 Tara L Andrews, aurum@cpan.org
 180
 181 =cut
 182
 183 1;