1 package Text::Tradition::Witness;
6 use Moose::Util::TypeConstraints;
7 use Text::TEI::Markup qw( word_tag_wrap );
9 use XML::Easy::Syntax qw( $xml10_name_rx );
13 Text::Tradition::Witness - a manuscript witness to a text tradition
17 use Text::Tradition::Witness;
18 my $w = Text::Tradition::Witness->new(
20 'identifier' => 'Oxford MS Ex.1932',
25 Text::Tradition::Witness is an object representation of a manuscript
26 witness to a text tradition. A manuscript has a sigil (a short code that
27 represents it in the wider tradition), an identifier (e.g. the library ID),
34 Create a new witness. Options include:
38 =item * sigil - A short code to represent the manuscript. Required.
40 =item * sourcetype - What sort of witness data this is. Options are
41 'xmldesc', 'plaintext', 'json', or 'collation' (the last should only be
42 used by Collation parsers.)
48 The data source for the witness. Use the appropriate option.
50 =item * use_text - An initialization option. If the witness is read from a
51 TEI document and more than one <text/> tag exists therein, the default
52 behavior is to use the first defined text. If this is not desired,
53 use_text should be set to an XPath expression that will select the correct
56 =item * language - The name of the applicable L<Text::Tradition::Lang>
57 module for language handling. Usually inherited from the language set in
58 the L<Text::Tradition> object, and defaults to Default.
60 =item * identifier - The recognized name of the manuscript, e.g. a library
61 identifier. Taken from the msDesc element for a TEI file.
63 =item * other_info - A freeform string for any other description of the
70 The sigil by which to identify this manuscript, which must conform to the
71 specification for XML attribute strings (broadly speaking, it must begin
72 with a letter and can have only a few sorts of punctuation characters in
77 A freeform name by which to identify the manuscript, which may be longer
78 than the sigil. Defaults to 'Unidentified ms', but will be taken from the
79 TEI msName attribute, or constructed from the settlement and idno if
84 The city, town, etc. where the manuscript is held. Will be read from the
85 TEI msDesc element if supplied.
89 The institution that holds the manuscript. Will be read from the TEI msDesc
94 The identification or call number of the manuscript. Will be read from the
95 TEI msDesc element if supplied.
99 An array of strings (words) that contains the text of the
100 manuscript. This should not change after the witness has been
101 instantiated, and the path through the collation should always match it.
105 An array of strings (words) that contains the layered
106 text, if any, of the manuscript. This should not change after the witness
107 has been instantiated, and the path through the collation should always
112 Accessor method to get the witness language.
116 Accessor method for the witness identifier.
120 Accessor method for the general witness description.
124 Boolean method that returns a true value if the witness was created with a
125 data source (that is, a file, string, or object to be parsed).
129 Boolean method to note whether the witness has layers (e.g. pre-correction
130 readings) in the collation.
135 my $trad = Text::Tradition->new( 'name' => 'test tradition' );
136 my $c = $trad->collation;
138 # Test a plaintext witness via string
139 my $str = 'This is a line of text';
140 my $ptwit = $trad->add_witness(
142 'sourcetype' => 'plaintext',
145 is( ref( $ptwit ), 'Text::Tradition::Witness', 'Created a witness' );
147 is( $ptwit->sigil, 'A', "Witness has correct sigil" );
148 is( $c->path_text( $ptwit->sigil ), $str, "Witness has correct text" );
151 # Test some JSON witnesses via object
152 open( JSIN, 't/data/witnesses/testwit.json' ) or die "Could not open JSON test input";
153 binmode( JSIN, ':encoding(UTF-8)' );
156 $trad->add_json_witnesses( join( '', @lines ) );
157 is( ref( $trad->witness( 'MsAJ' ) ), 'Text::Tradition::Witness',
158 "Found first JSON witness" );
159 is( ref( $trad->witness( 'MsBJ' ) ), 'Text::Tradition::Witness',
160 "Found second JSON witness" );
162 # Test an XML witness via file
163 my $xmlwit = $trad->add_witness( 'sourcetype' => 'xmldesc',
164 'file' => 't/data/witnesses/teiwit.xml' );
165 is( ref( $xmlwit ), 'Text::Tradition::Witness', "Created witness from XML file" );
167 is( $xmlwit->sigil, 'V887', "XML witness has correct sigil" );
168 ok( $xmlwit->is_layered, "Picked up correction layer" );
169 is( @{$xmlwit->text}, 182, "Got correct text length" );
170 is( @{$xmlwit->layertext}, 182, "Got correct a.c. text length" );
172 my @allwitwords = grep { $_->id =~ /^V887/ } $c->readings;
173 is( @allwitwords, 184, "Reused appropriate readings" );
176 my $xpwit = $trad->add_witness( 'sourcetype' => 'xmldesc',
177 'file' => 't/data/witnesses/group.xml',
178 'use_text' => '//tei:group/tei:text[2]' );
179 is( ref( $xpwit ), 'Text::Tradition::Witness', "Created witness from XML group" );
181 is( $xpwit->sigil, 'G', "XML part witness has correct sigil" );
182 ok( !$xpwit->is_layered, "Picked up no correction layer" );
183 is( @{$xpwit->text}, 157, "Got correct text length" );
191 subtype 'SourceType',
193 where { $_ =~ /^(xmldesc|plaintext|json|collation)$/ },
194 message { 'Source type must be one of xmldesc, plaintext, json, collation' };
198 where { $_ =~ /\A$xml10_name_rx\z/ },
199 message { 'Sigil must be a valid XML attribute string' };
201 no Moose::Util::TypeConstraints;
205 'isa' => 'Text::Tradition',
209 # Sigil. Required identifier for a witness, but may be found inside
214 predicate => 'has_sigil',
215 writer => '_set_sigil',
221 default => 'Default',
224 # Other identifying information
225 has 'identifier' => (
230 has 'settlement' => (
235 has 'repository' => (
245 # Source. Can be XML obj, JSON data struct, or string.
246 # Not used if the witness is created by parsing a collation.
247 has 'sourcetype' => (
256 predicate => 'has_file',
262 predicate => 'has_string',
265 has 'object' => ( # could be anything.
267 predicate => 'has_object',
268 clearer => 'clear_object',
271 # In the case of a TEI document with multiple texts, specify
272 # which text is the root. Should be an XPath expression.
278 # Text. This is an array of strings (i.e. word tokens).
279 # TODO Think about how to handle this for the case of pre-prepared
280 # collations, where the tokens are in the graph already.
283 isa => 'ArrayRef[Str]',
284 predicate => 'has_text',
289 isa => 'ArrayRef[Str]',
290 predicate => 'has_layertext',
293 # Path. This is an array of Reading nodes that can be saved during
294 # initialization, but should be cleared before saving in a DB.
297 isa => 'ArrayRef[Text::Tradition::Collation::Reading]',
298 predicate => 'has_path',
299 clearer => 'clear_path',
302 ## TODO change the name of this
303 has 'uncorrected_path' => (
305 isa => 'ArrayRef[Text::Tradition::Collation::Reading]',
306 clearer => 'clear_uncorrected_path',
309 has 'is_layered' => (
314 # If we set an uncorrected path, ever, remember that we did so.
315 around 'uncorrected_path' => sub {
319 $self->is_layered( 1 );
325 if( $self->has_source ) {
326 my $init_sub = '_init_from_' . $self->sourcetype;
328 # Remove our XML / source objects; we no longer need them.
329 $self->clear_object if $self->has_object;
330 $self->tradition->collation->make_witness_path( $self );
337 return $self->has_file || $self->has_string || $self->has_object;
340 sub _init_from_xmldesc {
343 if( $self->has_object ) {
344 unless( ref( $self->object ) eq 'XML::LibXML::Element' ) {
345 throw( ident => "bad source",
346 message => "Source object must be an XML::LibXML::Element (this is "
347 . ref( $self->object ) . ");" );
349 $xmlobj = $self->object;
352 my $parser = XML::LibXML->new();
353 my $parsersub = $self->has_file ? 'parse_file' : 'parse_string';
355 $xmlobj = $parser->$parsersub( $self->file )->documentElement;
356 } catch( XML::LibXML::Error $e ) {
357 throw( ident => "bad source",
358 message => "XML parsing error: " . $e->as_string );
362 unless( $xmlobj->nodeName eq 'TEI' ) {
363 throw( ident => "bad source",
364 message => "Source XML must be TEI (this is " . $xmlobj->nodeName . ")" );
367 # Set up the tags we need, with or without namespaces.
368 map { $tags{$_} = "//$_" }
369 qw/ msDesc msName settlement repository idno p lg w seg add del /;
370 # Set up our XPath object
371 my $xpc = _xpc_for_el( $xmlobj );
372 # Use namespace-aware tags if we have to
373 if( $xmlobj->namespaceURI ) {
374 map { $tags{$_} = "//tei:$_" } keys %tags;
378 if( my $desc = $xpc->find( $tags{msDesc} ) ) {
379 my $descnode = $desc->get_node(1);
380 # First try to use settlement/repository/idno.
381 my( $setNode, $reposNode, $idNode ) =
382 ( $xpc->find( $tags{settlement}, $descnode )->get_node(1),
383 $xpc->find( $tags{repository}, $descnode )->get_node(1),
384 $xpc->find( $tags{idno}, $descnode )->get_node(1) );
385 $self->settlement( $setNode ? $setNode->textContent : '' );
386 $self->repository( $reposNode ? $reposNode->textContent : '' );
387 $self->idno( $idNode ? $idNode->textContent : '' );
388 if( $self->settlement && $self->idno ) {
389 $self->identifier( join( ' ', $self->{'settlement'}, $self->{'idno'} ) );
391 # Look for an msName.
392 my $msNameNode = $xpc->find( $tags{msName}, $descnode )->get_node(1);
394 $self->identifier( $msNameNode->textContent );
396 # We have an msDesc but who knows what is in it?
397 my $desc = $descnode->textContent;
400 $self->identifier( $desc );
403 if( $descnode->hasAttribute('xml:id') ) {
404 $self->_set_sigil( $descnode->getAttribute('xml:id') );
405 } elsif( !$self->has_sigil ) {
406 throw( ident => 'missing sigil',
407 message => 'Could not find xml:id witness sigil' );
410 throw( ident => "bad source",
411 message => "Could not find manuscript description element in TEI header" );
414 # Now get the words out.
416 my @layerwords; # if the witness has layers
417 # First, make sure all the words are wrapped in tags.
418 # TODO Make this not necessarily dependent upon whitespace...
419 word_tag_wrap( $xmlobj );
420 # Now go text hunting.
422 if( $self->use_text ) {
423 @textnodes = $xpc->findnodes( $self->use_text );
425 # Use the first 'text' node in the document.
426 @textnodes = $xmlobj->getElementsByTagName( 'text' );
428 my $teitext = $textnodes[0];
430 _tokenize_text( $self, $teitext, \@words, \@layerwords );
432 throw( ident => "bad source",
433 message => "No text element in document '" . $self->{'identifier'} . "!" );
436 my @text = map { $_->text } @words;
437 my @layertext = map { $_->text } @layerwords;
438 $self->path( \@words );
439 $self->text( \@text );
440 if( join( ' ', @text ) ne join( ' ', @layertext ) ) {
441 $self->uncorrected_path( \@layerwords );
442 $self->layertext( \@layertext );
447 my( $self, $teitext, $wordlist, $uncorrlist ) = @_;
448 # Strip out the words.
449 my $xpc = _xpc_for_el( $teitext );
450 my @divs = $xpc->findnodes( '//*[starts-with(name(.), "div")]' );
453 if( my $n = $_->getAttribute( 'n' ) ) {
454 $place_str = '#DIV_' . $n . '#';
456 $place_str = '#DIV#';
458 $self->_objectify_words( $teitext, $wordlist, $uncorrlist, $place_str );
461 # But maybe we don't have any divs. Just paragraphs.
463 $self->_objectify_words( $teitext, $wordlist, $uncorrlist );
467 sub _objectify_words {
468 my( $self, $element, $wordlist, $uncorrlist, $divmarker ) = @_;
470 my $xpc = _xpc_for_el( $element );
471 my $xpexpr = '.' . $tags{p} . '|.' . $tags{lg};
472 my @pgraphs = $xpc->findnodes( $xpexpr );
473 return () unless @pgraphs;
474 # Set up an expression to look for words and segs
475 $xpexpr = '.' . $tags{w} . '|.' . $tags{seg};
476 foreach my $pg ( @pgraphs ) {
477 # If this paragraph is the descendant of a note element,
479 my @noop_container = $xpc->findnodes( 'ancestor::note', $pg );
480 next if scalar @noop_container;
481 # Get the text of each node
483 # Hunt down each wrapped word/seg, and make an object (or two objects)
484 # of it, if necessary.
485 foreach my $c ( $xpc->findnodes( $xpexpr, $pg ) ) {
486 my( $text, $uncorr ) = _get_word_strings( $c );
488 # ( $text, $uncorr ) = _get_word_object( $c );
489 # } catch( Text::Tradition::Error $e
490 # where { $_->has_tag( 'lb' ) } ) {
493 unless( defined $text || defined $uncorr ) {
494 print STDERR "WARNING: no text in node " . $c->nodeName
495 . "\n" unless $c->nodeName eq 'lb';
498 print STDERR "DEBUG: space found in element node "
499 . $c->nodeName . "\n" if $text =~ /\s/ || $uncorr =~ /\s/;
501 my $ctr = @$wordlist > @$uncorrlist ? @$wordlist : @$uncorrlist;
502 while( $self->tradition->collation->reading( $self->sigil.'r'.$ctr ) ) {
505 my $id = $self->sigil . 'r' . $ctr;
506 my( $word, $acword );
508 $word = $self->tradition->collation->add_reading(
509 { 'id' => $id, 'text' => $text });
511 if( $uncorr && $uncorr ne $text ) {
513 $acword = $self->tradition->collation->add_reading(
514 { 'id' => $id, 'text' => $uncorr });
519 # if( $first_word ) {
521 # # Set the relevant sectioning markers
523 # $w->add_placeholder( $divmarker );
524 # $divmarker = undef;
526 # $w->add_placeholder( '#PG#' );
528 push( @$wordlist, $word ) if $word;
529 push( @$uncorrlist, $acword ) if $acword;
534 # Given a word or segment node, make a Reading object for the word
535 # therein. Make two Reading objects if there is an 'uncorrected' vs.
538 sub _get_word_strings {
540 my( $text, $uncorrtext );
541 # We can have an lb or pb in the middle of a word; if we do, the
542 # whitespace (including \n) after the break becomes insignificant
543 # and we want to nuke it.
544 my $strip_leading_space = 0;
545 my $word_excluded = 0;
546 my $xpc = _xpc_for_el( $node );
547 # TODO This does not cope with nested add/dels.
548 my @addition = $xpc->findnodes( 'ancestor::' . substr( $tags{add}, 2 ) );
549 my @deletion = $xpc->findnodes( 'ancestor::' . substr( $tags{del}, 2 ) );
550 foreach my $c ($node->childNodes() ) {
551 if( $c->nodeName eq 'num'
552 && defined $c->getAttribute( 'value' ) ) {
554 $text .= $c->getAttribute( 'value' ) unless @deletion;
555 $uncorrtext .= $c->getAttribute( 'value' ) unless @addition;
556 # If this is just after a line/page break, return to normal behavior.
557 $strip_leading_space = 0;
558 } elsif ( $c->nodeName =~ /^[lp]b$/ ) {
559 # Set a flag that strips leading whitespace until we
560 # get to the next bit of non-whitespace.
561 $strip_leading_space = 1;
562 } elsif ( $c->nodeName eq 'fw' # for catchwords
563 || $c->nodeName eq 'sic'
564 || $c->nodeName eq 'note' #TODO: decide how to deal with notes
565 || $c->textContent eq ''
566 || ref( $c ) eq 'XML::LibXML::Comment' ) {
567 $word_excluded = 1 if $c->nodeName =~ /^(fw|sic)$/;
569 } elsif( $c->nodeName eq 'add' ) {
570 my( $use, $discard ) = _get_word_strings( $c );
572 } elsif( $c->nodeName eq 'del' ) {
573 my( $discard, $use ) = _get_word_strings( $c );
576 my ( $tagtxt, $taguncorr );
577 if( ref( $c ) eq 'XML::LibXML::Text' ) {
579 $tagtxt = $c->textContent;
580 $taguncorr = $c->textContent;
582 ( $tagtxt, $taguncorr ) = _get_word_strings( $c );
584 if( $strip_leading_space ) {
585 $tagtxt =~ s/^[\s\n]+//s;
586 $taguncorr =~ s/^[\s\n]+//s;
587 # Unset the flag as soon as we see non-whitespace.
588 $strip_leading_space = 0 if $tagtxt;
591 $uncorrtext .= $taguncorr;
594 throw( ident => "text not found",
595 tags => [ $node->nodeName ],
596 message => "No text found in node " . $node->toString(0) )
597 unless $text || $uncorrtext || $word_excluded || $node->toString(0) =~/gap/;
598 return( $text, $uncorrtext );
602 my( $self, $string, $c ) = @_;
603 my @raw_words = split( /\s+/, $string );
605 foreach my $w ( @raw_words ) {
606 my $id = $self->sigil . 'r'. $c++;
607 my %opts = ( 'text' => $w, 'id' => $id, 'language' => $self->language );
608 my $w_obj = $self->tradition->collation->add_reading( \%opts );
609 # Skip any words that have been canonized out of existence.
610 next if( length( $w_obj->text ) == 0 );
611 push( @words, $w_obj );
616 sub _init_from_json {
619 if( $self->has_object ) {
620 $wit = $self->object;
621 } elsif( $self->has_string ) {
622 $wit = from_json( $self->string );
623 } elsif( $self->has_file ) {
624 my $ok = open( INPUT, $self->file );
626 throw( ident => "bad source",
627 message => 'Could not open ' . $self->file . ' for reading' );
629 binmode( INPUT, ':encoding(UTF-8)' );
632 $wit = from_json( join( '', @lines ) );
635 if( exists $wit->{'id'} ) {
636 $self->_set_sigil( $wit->{'id'} );
637 } elsif( !$self->has_sigil ) {
638 throw( ident => 'missing sigil',
639 message => 'Could not find witness sigil (id) in JSON spec' );
641 $self->identifier( $wit->{'name'} );
644 my( @text, @layertext );
645 if( exists $wit->{'content'} ) {
646 # We need to tokenize the text ourselves.
647 @words = _split_words( $self, $wit->{'content'} );
648 } elsif( exists $wit->{'tokens'} ) {
649 # We have a bunch of pretokenized words.
651 foreach my $token ( @{$wit->{'tokens'}} ) {
652 my $w_obj = $self->tradition->collation->add_reading({
653 'text' => $token->{'t'}, 'id' => $self->sigil . 'r' . $ctr++ });
654 push( @words, $w_obj );
655 push( @text, $token->{'t'} ); # TODO unless...?
657 ## TODO rethink this JSOn mechanism
658 if( exists $wit->{'layertokens'} ) {
659 foreach my $token ( @{$wit->{'layertokens'}} ) {
660 my $w_obj = $self->tradition->collation->add_reading({
661 'text' => $token->{'t'}, 'id' => $self->sigil . 'r' . $ctr++ });
662 push( @layerwords, $w_obj );
663 push( @layertext, $token->{'t'} );
667 $self->text( \@text );
668 $self->layertext( \@layertext ) if @layertext;
669 $self->path( \@words );
670 $self->uncorrected_path( \@layerwords ) if @layerwords;
673 sub _init_from_plaintext {
676 if( $self->has_file ) {
677 my $ok = open( INPUT, $self->file );
679 throw( ident => "bad source",
680 message => 'Could not open ' . $self->file . ' for reading' );
682 binmode( INPUT, ':encoding(UTF-8)' );
685 $str = join( '', @lines );
686 } elsif( $self->has_object ) { # ...seriously?
687 $str = ${$self->object};
689 $str = $self->string;
692 # TODO allow a different word separation expression
693 my @text = split( /\s+/, $str );
694 $self->text( \@text );
695 my @words = _split_words( $self, $str );
696 $self->path( \@words );
700 Text::Tradition::Error->throw(
701 'ident' => 'Witness parsing error',
708 my $xpc = XML::LibXML::XPathContext->new( $el );
709 if( $el->namespaceURI ) {
710 $xpc->registerNs( 'tei', $el->namespaceURI );
715 =head2 export_as_json
717 Exports the witness as a JSON structure, with the following keys:
721 =item * id - The witness sigil
723 =item * name - The witness identifier
725 =item * tokens - An array of hashes of the form { "t":"WORD" }
732 my $trad = Text::Tradition->new();
734 my @text = qw/ Thhis is a line of text /;
735 my $wit = $trad->add_witness(
737 'string' => join( ' ', @text ),
738 'sourcetype' => 'plaintext',
739 'identifier' => 'test witness',
741 my $jsonstruct = $wit->export_as_json;
742 is( $jsonstruct->{'id'}, 'A', "got the right witness sigil" );
743 is( $jsonstruct->{'name'}, 'test witness', "got the right identifier" );
744 is( scalar @{$jsonstruct->{'tokens'}}, 6, "got six text tokens" );
745 foreach my $idx ( 0 .. $#text ) {
746 is( $jsonstruct->{'tokens'}->[$idx]->{'t'}, $text[$idx], "tokens look OK" );
749 my @ctext = qw( when april with his showers sweet with fruit the drought of march
750 has pierced unto the root );
751 $trad = Text::Tradition->new(
752 'input' => 'CollateX',
753 'file' => 't/data/Collatex-16.xml' );
755 $jsonstruct = $trad->witness('A')->export_as_json;
756 is( $jsonstruct->{'id'}, 'A', "got the right witness sigil" );
757 is( $jsonstruct->{'name'}, undef, "got undef for missing identifier" );
758 is( scalar @{$jsonstruct->{'tokens'}}, 17, "got all text tokens" );
759 foreach my $idx ( 0 .. $#ctext ) {
760 is( $jsonstruct->{'tokens'}->[$idx]->{'t'}, $ctext[$idx], "tokens look OK" );
763 ## TODO test layertext export
771 my @wordlist = map { { 't' => $_ || '' } } @{$self->text};
773 'id' => $self->sigil,
774 'tokens' => \@wordlist,
775 'name' => $self->identifier,
777 if( $self->is_layered ) {
778 my @lwlist = map { { 't' => $_ || '' } } @{$self->uncorrected};
779 $obj->{'layertokens'} = \@lwlist;
785 __PACKAGE__->meta->make_immutable;
791 =item * Figure out how to serialize a witness
793 =item * Support encodings other than UTF-8
799 This package is free software and is provided "as is" without express
800 or implied warranty. You can redistribute it and/or modify it under
801 the same terms as Perl itself.
805 Tara L Andrews E<lt>aurum@cpan.orgE<gt>