| 1 | ###########################################################################
|
|---|
| 2 | #
|
|---|
| 3 | # doc.pm --
|
|---|
| 4 | # A component of the Greenstone digital library software
|
|---|
| 5 | # from the New Zealand Digital Library Project at the
|
|---|
| 6 | # University of Waikato, New Zealand.
|
|---|
| 7 | #
|
|---|
| 8 | # Copyright (C) 1999 New Zealand Digital Library Project
|
|---|
| 9 | #
|
|---|
| 10 | # This program is free software; you can redistribute it and/or modify
|
|---|
| 11 | # it under the terms of the GNU General Public License as published by
|
|---|
| 12 | # the Free Software Foundation; either version 2 of the License, or
|
|---|
| 13 | # (at your option) any later version.
|
|---|
| 14 | #
|
|---|
| 15 | # This program is distributed in the hope that it will be useful,
|
|---|
| 16 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 17 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|---|
| 18 | # GNU General Public License for more details.
|
|---|
| 19 | #
|
|---|
| 20 | # You should have received a copy of the GNU General Public License
|
|---|
| 21 | # along with this program; if not, write to the Free Software
|
|---|
| 22 | # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|---|
| 23 | #
|
|---|
| 24 | ###########################################################################
|
|---|
| 25 |
|
|---|
| 26 | # base class to hold documents
|
|---|
| 27 |
|
|---|
| 28 | package doc;
|
|---|
| 29 | eval {require bytes};
|
|---|
| 30 |
|
|---|
| 31 | BEGIN {
|
|---|
| 32 | die "GSDLHOME not set\n" unless defined $ENV{'GSDLHOME'};
|
|---|
| 33 | unshift (@INC, "$ENV{'GSDLHOME'}/perllib/dynamic/lib/site_perl/5.005/i686-linux");
|
|---|
| 34 | }
|
|---|
| 35 |
|
|---|
| 36 | use unicode;
|
|---|
| 37 | use util;
|
|---|
| 38 | use ghtml;
|
|---|
| 39 | ##use hashdoc;
|
|---|
| 40 |
|
|---|
| 41 | # the document type may be indexed_doc, nonindexed_doc, or
|
|---|
| 42 | # classification
|
|---|
| 43 |
|
|---|
| 44 | my $OIDcount = 0;
|
|---|
| 45 |
|
|---|
| 46 | sub new {
|
|---|
| 47 | my $class = shift (@_);
|
|---|
| 48 | my ($source_filename, $doc_type) = @_;
|
|---|
| 49 |
|
|---|
| 50 | my $self = bless {'associated_files'=>[],
|
|---|
| 51 | 'subsection_order'=>[],
|
|---|
| 52 | 'next_subsection'=>1,
|
|---|
| 53 | 'subsections'=>{},
|
|---|
| 54 | 'metadata'=>[],
|
|---|
| 55 | 'text'=>"",
|
|---|
| 56 | 'OIDtype'=>"hash"}, $class;
|
|---|
| 57 |
|
|---|
| 58 | $self->set_source_filename ($source_filename) if defined $source_filename;
|
|---|
| 59 | $self->set_doc_type ($doc_type) if defined $doc_type;
|
|---|
| 60 |
|
|---|
| 61 | return $self;
|
|---|
| 62 | }
|
|---|
| 63 |
|
|---|
| 64 | # clone the $self object
|
|---|
| 65 | sub duplicate {
|
|---|
| 66 | my $self = shift (@_);
|
|---|
| 67 |
|
|---|
| 68 | my $newobj = {};
|
|---|
| 69 |
|
|---|
| 70 | foreach $k (keys %$self) {
|
|---|
| 71 | $newobj->{$k} = &clone ($self->{$k});
|
|---|
| 72 | }
|
|---|
| 73 |
|
|---|
| 74 | bless $newobj, ref($self);
|
|---|
| 75 | return $newobj;
|
|---|
| 76 | }
|
|---|
| 77 |
|
|---|
| 78 | sub clone {
|
|---|
| 79 | my ($from) = @_;
|
|---|
| 80 | my $type = ref ($from);
|
|---|
| 81 |
|
|---|
| 82 | if ($type eq "HASH") {
|
|---|
| 83 | my $to = {};
|
|---|
| 84 | foreach $key (keys %$from) {
|
|---|
| 85 | $to->{$key} = &clone ($from->{$key});
|
|---|
| 86 | }
|
|---|
| 87 | return $to;
|
|---|
| 88 | } elsif ($type eq "ARRAY") {
|
|---|
| 89 | my $to = [];
|
|---|
| 90 | foreach $v (@$from) {
|
|---|
| 91 | push (@$to, &clone ($v));
|
|---|
| 92 | }
|
|---|
| 93 | return $to;
|
|---|
| 94 | } else {
|
|---|
| 95 | return $from;
|
|---|
| 96 | }
|
|---|
| 97 | }
|
|---|
| 98 |
|
|---|
| 99 | sub set_OIDtype {
|
|---|
| 100 | my $self = shift (@_);
|
|---|
| 101 | my ($type) = @_;
|
|---|
| 102 |
|
|---|
| 103 | if ($type eq "incremental") {
|
|---|
| 104 | $self->{'OIDtype'} = $type;
|
|---|
| 105 | } else {
|
|---|
| 106 | $self->{'OIDtype'} = "hash";
|
|---|
| 107 | }
|
|---|
| 108 | }
|
|---|
| 109 |
|
|---|
| 110 | sub set_source_filename {
|
|---|
| 111 | my $self = shift (@_);
|
|---|
| 112 | my ($source_filename) = @_;
|
|---|
| 113 |
|
|---|
| 114 | $self->set_metadata_element ($self->get_top_section(),
|
|---|
| 115 | "gsdlsourcefilename",
|
|---|
| 116 | $source_filename);
|
|---|
| 117 | }
|
|---|
| 118 |
|
|---|
| 119 | # returns the source_filename as it was provided
|
|---|
| 120 | sub get_source_filename {
|
|---|
| 121 | my $self = shift (@_);
|
|---|
| 122 |
|
|---|
| 123 | return $self->get_metadata_element ($self->get_top_section(), "gsdlsourcefilename");
|
|---|
| 124 | }
|
|---|
| 125 |
|
|---|
| 126 | sub set_doc_type {
|
|---|
| 127 | my $self = shift (@_);
|
|---|
| 128 | my ($doc_type) = @_;
|
|---|
| 129 |
|
|---|
| 130 | $self->set_metadata_element ($self->get_top_section(),
|
|---|
| 131 | "gsdldoctype",
|
|---|
| 132 | $doc_type);
|
|---|
| 133 | }
|
|---|
| 134 |
|
|---|
| 135 | # returns the source_filename as it was provided
|
|---|
| 136 | # the default of "indexed_doc" is used if no document
|
|---|
| 137 | # type was provided
|
|---|
| 138 | sub get_doc_type {
|
|---|
| 139 | my $self = shift (@_);
|
|---|
| 140 |
|
|---|
| 141 | my $doc_type = $self->get_metadata_element ($self->get_top_section(), "gsdldoctype");
|
|---|
| 142 | return $doc_type if (defined $doc_type);
|
|---|
| 143 | return "indexed_doc";
|
|---|
| 144 | }
|
|---|
| 145 |
|
|---|
| 146 | sub _escape_text {
|
|---|
| 147 | my ($text) = @_;
|
|---|
| 148 |
|
|---|
| 149 | # special characters in the gml encoding
|
|---|
| 150 | $text =~ s/&/&/g; # this has to be first...
|
|---|
| 151 | $text =~ s/</</g;
|
|---|
| 152 | $text =~ s/>/>/g;
|
|---|
| 153 | $text =~ s/\"/"/g;
|
|---|
| 154 |
|
|---|
| 155 | return $text;
|
|---|
| 156 | }
|
|---|
| 157 |
|
|---|
| 158 | sub buffer_section_xml {
|
|---|
| 159 | my $self = shift (@_);
|
|---|
| 160 | my ($section) = @_;
|
|---|
| 161 |
|
|---|
| 162 | my $section_ptr = $self->_lookup_section ($section);
|
|---|
| 163 | return "" unless defined $section_ptr;
|
|---|
| 164 |
|
|---|
| 165 | my $all_text = "<Section>\n";
|
|---|
| 166 | $all_text .= " <Description>\n";
|
|---|
| 167 |
|
|---|
| 168 | # output metadata
|
|---|
| 169 | foreach my $data (@{$section_ptr->{'metadata'}}) {
|
|---|
| 170 | my $escaped_value = &_escape_text($data->[1]);
|
|---|
| 171 | $all_text .= ' <Metadata name="' . $data->[0] . '">' . $escaped_value . "</Metadata>\n";
|
|---|
| 172 | }
|
|---|
| 173 |
|
|---|
| 174 | $all_text .= " </Description>\n";
|
|---|
| 175 |
|
|---|
| 176 | # output the text
|
|---|
| 177 | $all_text .= " <Content>";
|
|---|
| 178 | $all_text .= &_escape_text($section_ptr->{'text'});
|
|---|
| 179 | $all_text .= "</Content>\n";
|
|---|
| 180 |
|
|---|
| 181 | # output all the subsections
|
|---|
| 182 | foreach my $subsection (@{$section_ptr->{'subsection_order'}}) {
|
|---|
| 183 | $all_text .= $self->buffer_section_xml("$section.$subsection");
|
|---|
| 184 | }
|
|---|
| 185 |
|
|---|
| 186 | $all_text .= "</Section>\n";
|
|---|
| 187 |
|
|---|
| 188 | # make sure no nasty control characters have snuck through
|
|---|
| 189 | # (XML::Parser will barf on anything it doesn't consider to be
|
|---|
| 190 | # valid UTF-8 text, including things like \c@, \cC etc.)
|
|---|
| 191 | $all_text =~ s/[\x00-\x09\x0B\x0C\x0E-\x1F]//g;
|
|---|
| 192 |
|
|---|
| 193 | return $all_text;
|
|---|
| 194 | }
|
|---|
| 195 |
|
|---|
| 196 | sub output_section {
|
|---|
| 197 | my $self = shift (@_);
|
|---|
| 198 | my ($handle, $section) = @_;
|
|---|
| 199 |
|
|---|
| 200 | print $handle $self->buffer_section_xml($section);
|
|---|
| 201 | }
|
|---|
| 202 |
|
|---|
| 203 | # look up the reference to the a particular section
|
|---|
| 204 | sub _lookup_section {
|
|---|
| 205 | my $self = shift (@_);
|
|---|
| 206 | my ($section) = @_;
|
|---|
| 207 |
|
|---|
| 208 | my ($num);
|
|---|
| 209 | my $sectionref = $self;
|
|---|
| 210 |
|
|---|
| 211 | while (defined $section && $section ne "") {
|
|---|
| 212 | ($num, $section) = $section =~ /^\.?(\d+)(.*)$/;
|
|---|
| 213 | $num =~ s/^0+(\d)/$1/; # remove leading 0s
|
|---|
| 214 | $section = "" unless defined $section;
|
|---|
| 215 |
|
|---|
| 216 | if (defined $num && defined $sectionref->{'subsections'}->{$num}) {
|
|---|
| 217 | $sectionref = $sectionref->{'subsections'}->{$num};
|
|---|
| 218 | } else {
|
|---|
| 219 | return undef;
|
|---|
| 220 | }
|
|---|
| 221 | }
|
|---|
| 222 |
|
|---|
| 223 | return $sectionref;
|
|---|
| 224 | }
|
|---|
| 225 |
|
|---|
| 226 | # calculate OID by hashing the contents of the document
|
|---|
| 227 | sub _calc_OID {
|
|---|
| 228 | my $self = shift (@_);
|
|---|
| 229 | my ($filename) = @_;
|
|---|
| 230 |
|
|---|
| 231 | my $osexe = &util::get_os_exe();
|
|---|
| 232 |
|
|---|
| 233 | my $hashfile_exe = &util::filename_cat($ENV{'GSDLHOME'},"bin",
|
|---|
| 234 | $ENV{'GSDLOS'},"hashfile$osexe");
|
|---|
| 235 | my $result = "NULL";
|
|---|
| 236 |
|
|---|
| 237 | if (-e "$hashfile_exe") {
|
|---|
| 238 | # $result = `\"$hashfile_exe\" \"$filename\"`;
|
|---|
| 239 | $result = `hashfile$osexe \"$filename\"`;
|
|---|
| 240 | ($result) = $result =~ /:\s*([0-9a-f]+)/i;
|
|---|
| 241 |
|
|---|
| 242 | } else {
|
|---|
| 243 | print STDERR "doc::_calc_OID $hashfile_exe could not be found\n";
|
|---|
| 244 | }
|
|---|
| 245 |
|
|---|
| 246 | return "HASH$result";
|
|---|
| 247 | }
|
|---|
| 248 |
|
|---|
| 249 | # methods dealing with OID, not groups of them.
|
|---|
| 250 |
|
|---|
| 251 | # if $OID is not provided one is calculated
|
|---|
| 252 | sub set_OID {
|
|---|
| 253 | my $self = shift (@_);
|
|---|
| 254 | my ($OID) = @_;
|
|---|
| 255 |
|
|---|
| 256 | # if an OID wasn't provided claculate one
|
|---|
| 257 | if (!defined $OID) {
|
|---|
| 258 | $OID = "NULL";
|
|---|
| 259 |
|
|---|
| 260 | if ($self->{'OIDtype'} eq "incremental") {
|
|---|
| 261 | $OID = "D" . $OIDcount;
|
|---|
| 262 | $OIDcount ++;
|
|---|
| 263 |
|
|---|
| 264 | } else {
|
|---|
| 265 | # "hash" OID - feed file to hashfile.exe
|
|---|
| 266 | my $filename = $self->get_source_filename();
|
|---|
| 267 | if (defined($filename) && -e $filename) {
|
|---|
| 268 |
|
|---|
| 269 | $OID = $self->_calc_OID ($filename);
|
|---|
| 270 |
|
|---|
| 271 | } else {
|
|---|
| 272 | $filename = &util::get_tmp_filename();
|
|---|
| 273 | if (!open (OUTFILE, ">$filename")) {
|
|---|
| 274 | print STDERR "doc::set_OID could not write to $filename\n";
|
|---|
| 275 | } else {
|
|---|
| 276 | $self->output_section('OUTFILE', $self->get_top_section(),
|
|---|
| 277 | undef, 1);
|
|---|
| 278 | close (OUTFILE);
|
|---|
| 279 | }
|
|---|
| 280 |
|
|---|
| 281 | $OID = $self->_calc_OID ($filename);
|
|---|
| 282 | &util::rm ($filename);
|
|---|
| 283 | }
|
|---|
| 284 | }
|
|---|
| 285 | }
|
|---|
| 286 | $self->set_metadata_element ($self->get_top_section(), "Identifier", $OID);
|
|---|
| 287 | }
|
|---|
| 288 |
|
|---|
| 289 | # this uses hashdoc (embedded c thingy) which is faster but still
|
|---|
| 290 | # needs a little work to be suffiently stable
|
|---|
| 291 | sub ___set_OID {
|
|---|
| 292 | my $self = shift (@_);
|
|---|
| 293 | my ($OID) = @_;
|
|---|
| 294 |
|
|---|
| 295 | # if an OID wasn't provided then calculate hash value based on document
|
|---|
| 296 | if (!defined $OID)
|
|---|
| 297 | {
|
|---|
| 298 | my $hash_text = $self->buffer_section_gml($self->get_top_section(),
|
|---|
| 299 | undef, 1);
|
|---|
| 300 | my $hash_len = length($hash_text);
|
|---|
| 301 |
|
|---|
| 302 | $OID = &hashdoc::buffer($hash_text,$hash_len);
|
|---|
| 303 | }
|
|---|
| 304 |
|
|---|
| 305 | $self->set_metadata_element ($self->get_top_section(), "Identifier", $OID);
|
|---|
| 306 | }
|
|---|
| 307 |
|
|---|
| 308 | # returns the OID for this document
|
|---|
| 309 | sub get_OID {
|
|---|
| 310 | my $self = shift (@_);
|
|---|
| 311 | my $OID = $self->get_metadata_element ($self->get_top_section(), "Identifier");
|
|---|
| 312 | return $OID if (defined $OID);
|
|---|
| 313 | return "NULL";
|
|---|
| 314 | }
|
|---|
| 315 |
|
|---|
| 316 | sub delete_OID {
|
|---|
| 317 | my $self = shift (@_);
|
|---|
| 318 |
|
|---|
| 319 | $self->set_metadata_element ($self->get_top_section(), "Identifier", "NULL");
|
|---|
| 320 | }
|
|---|
| 321 |
|
|---|
| 322 |
|
|---|
| 323 | # methods for manipulating section names
|
|---|
| 324 |
|
|---|
| 325 | # returns the name of the top-most section (the top
|
|---|
| 326 | # level of the document
|
|---|
| 327 | sub get_top_section {
|
|---|
| 328 | my $self = shift (@_);
|
|---|
| 329 |
|
|---|
| 330 | return "";
|
|---|
| 331 | }
|
|---|
| 332 |
|
|---|
| 333 | # returns a section
|
|---|
| 334 | sub get_parent_section {
|
|---|
| 335 | my $self = shift (@_);
|
|---|
| 336 | my ($section) = @_;
|
|---|
| 337 |
|
|---|
| 338 | $section =~ s/(^|\.)\d+$//;
|
|---|
| 339 |
|
|---|
| 340 | return $section;
|
|---|
| 341 | }
|
|---|
| 342 |
|
|---|
| 343 | # returns the first child section (or the end child
|
|---|
| 344 | # if there isn't any)
|
|---|
| 345 | sub get_begin_child {
|
|---|
| 346 | my $self = shift (@_);
|
|---|
| 347 | my ($section) = @_;
|
|---|
| 348 |
|
|---|
| 349 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 350 | return "" unless defined $section_ptr;
|
|---|
| 351 |
|
|---|
| 352 | if (defined $section_ptr->{'subsection_order'}->[0]) {
|
|---|
| 353 | return "$section.$section_ptr->{'subsection_order'}->[0]";
|
|---|
| 354 | }
|
|---|
| 355 |
|
|---|
| 356 | return $self->get_end_child ($section);
|
|---|
| 357 | }
|
|---|
| 358 |
|
|---|
| 359 | # returns the next child of a parent section
|
|---|
| 360 | sub get_next_child {
|
|---|
| 361 | my $self = shift (@_);
|
|---|
| 362 | my ($section) = @_;
|
|---|
| 363 |
|
|---|
| 364 | my $parent_section = $self->get_parent_section($section);
|
|---|
| 365 | my $parent_section_ptr = $self->_lookup_section($parent_section);
|
|---|
| 366 | return undef unless defined $parent_section_ptr;
|
|---|
| 367 |
|
|---|
| 368 | my ($section_num) = $section =~ /(\d+)$/;
|
|---|
| 369 | return undef unless defined $section_num;
|
|---|
| 370 |
|
|---|
| 371 | my $i = 0;
|
|---|
| 372 | my $section_order = $parent_section_ptr->{'subsection_order'};
|
|---|
| 373 | while ($i < scalar(@$section_order)) {
|
|---|
| 374 | last if $section_order->[$i] eq $section_num;
|
|---|
| 375 | $i++;
|
|---|
| 376 | }
|
|---|
| 377 |
|
|---|
| 378 | $i++; # the next child
|
|---|
| 379 | if ($i < scalar(@$section_order)) {
|
|---|
| 380 | return $section_order->[$i] if $parent_section eq "";
|
|---|
| 381 | return "$parent_section.$section_order->[$i]";
|
|---|
| 382 | }
|
|---|
| 383 |
|
|---|
| 384 | # no more sections in this level
|
|---|
| 385 | return undef;
|
|---|
| 386 | }
|
|---|
| 387 |
|
|---|
| 388 | # returns a reference to a list of children
|
|---|
| 389 | sub get_children {
|
|---|
| 390 | my $self = shift (@_);
|
|---|
| 391 | my ($section) = @_;
|
|---|
| 392 |
|
|---|
| 393 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 394 | return [] unless defined $section_ptr;
|
|---|
| 395 |
|
|---|
| 396 | my @children = @{$section_ptr->{'subsection_order'}};
|
|---|
| 397 |
|
|---|
| 398 | map {$_ = "$section.$_"; $_ =~ s/^\.+//;} @children;
|
|---|
| 399 | return \@children;
|
|---|
| 400 | }
|
|---|
| 401 |
|
|---|
| 402 | # returns the child section one past the last one (which
|
|---|
| 403 | # is coded as "0")
|
|---|
| 404 | sub get_end_child {
|
|---|
| 405 | my $self = shift (@_);
|
|---|
| 406 | my ($section) = @_;
|
|---|
| 407 |
|
|---|
| 408 | return $section . ".0" unless $section eq "";
|
|---|
| 409 | return "0";
|
|---|
| 410 | }
|
|---|
| 411 |
|
|---|
| 412 | # returns the next section in book order
|
|---|
| 413 | sub get_next_section {
|
|---|
| 414 | my $self = shift (@_);
|
|---|
| 415 | my ($section) = @_;
|
|---|
| 416 |
|
|---|
| 417 | return undef unless defined $section;
|
|---|
| 418 |
|
|---|
| 419 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 420 | return undef unless defined $section_ptr;
|
|---|
| 421 |
|
|---|
| 422 | # first try to find first child
|
|---|
| 423 | if (defined $section_ptr->{'subsection_order'}->[0]) {
|
|---|
| 424 | return $section_ptr->{'subsection_order'}->[0] if ($section eq "");
|
|---|
| 425 | return "$section.$section_ptr->{'subsection_order'}->[0]";
|
|---|
| 426 | }
|
|---|
| 427 |
|
|---|
| 428 | do {
|
|---|
| 429 | # try to find sibling
|
|---|
| 430 | my $next_child = $self->get_next_child ($section);
|
|---|
| 431 | return $next_child if (defined $next_child);
|
|---|
| 432 |
|
|---|
| 433 | # move up one level
|
|---|
| 434 | $section = $self->get_parent_section ($section);
|
|---|
| 435 | } while $section =~ /\d/;
|
|---|
| 436 |
|
|---|
| 437 | return undef;
|
|---|
| 438 | }
|
|---|
| 439 |
|
|---|
| 440 | sub is_leaf_section {
|
|---|
| 441 | my $self = shift (@_);
|
|---|
| 442 | my ($section) = @_;
|
|---|
| 443 |
|
|---|
| 444 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 445 | return 1 unless defined $section_ptr;
|
|---|
| 446 |
|
|---|
| 447 | return (scalar (@{$section_ptr->{'subsection_order'}}) == 0);
|
|---|
| 448 | }
|
|---|
| 449 |
|
|---|
| 450 | # methods for dealing with sections
|
|---|
| 451 |
|
|---|
| 452 | # returns the name of the inserted section
|
|---|
| 453 | sub insert_section {
|
|---|
| 454 | my $self = shift (@_);
|
|---|
| 455 | my ($before_section) = @_;
|
|---|
| 456 |
|
|---|
| 457 | # get the child to insert before and its parent section
|
|---|
| 458 | my $parent_section = "";
|
|---|
| 459 | my $before_child = "0";
|
|---|
| 460 | my @before_section = split (/\./, $before_section);
|
|---|
| 461 | if (scalar(@before_section) > 0) {
|
|---|
| 462 | $before_child = pop (@before_section);
|
|---|
| 463 | $parent_section = join (".", @before_section);
|
|---|
| 464 | }
|
|---|
| 465 |
|
|---|
| 466 | my $parent_section_ptr = $self->_lookup_section($parent_section);
|
|---|
| 467 | if (!defined $parent_section_ptr) {
|
|---|
| 468 | print STDERR "doc::insert_section couldn't find parent section " .
|
|---|
| 469 | "$parent_section\n";
|
|---|
| 470 | return;
|
|---|
| 471 | }
|
|---|
| 472 |
|
|---|
| 473 | # get the next section number
|
|---|
| 474 | my $section_num = $parent_section_ptr->{'next_subsection'}++;
|
|---|
| 475 |
|
|---|
| 476 | my $i = 0;
|
|---|
| 477 | while ($i < scalar(@{$parent_section_ptr->{'subsection_order'}}) &&
|
|---|
| 478 | $parent_section_ptr->{'subsection_order'}->[$i] ne $before_child) {
|
|---|
| 479 | $i++;
|
|---|
| 480 | }
|
|---|
| 481 |
|
|---|
| 482 | # insert the section number into the order list
|
|---|
| 483 | splice (@{$parent_section_ptr->{'subsection_order'}}, $i, 0, $section_num);
|
|---|
| 484 |
|
|---|
| 485 | # add this section to the parent section
|
|---|
| 486 | my $section_ptr = {'subsection_order'=>[],
|
|---|
| 487 | 'next_subsection'=>1,
|
|---|
| 488 | 'subsections'=>{},
|
|---|
| 489 | 'metadata'=>[],
|
|---|
| 490 | 'text'=>""};
|
|---|
| 491 | $parent_section_ptr->{'subsections'}->{$section_num} = $section_ptr;
|
|---|
| 492 |
|
|---|
| 493 | # work out the full section number
|
|---|
| 494 | my $section = $parent_section;
|
|---|
| 495 | $section .= "." unless $section eq "";
|
|---|
| 496 | $section .= $section_num;
|
|---|
| 497 |
|
|---|
| 498 | return $section;
|
|---|
| 499 | }
|
|---|
| 500 |
|
|---|
| 501 | # creates a pre-named section
|
|---|
| 502 | sub create_named_section {
|
|---|
| 503 | my $self = shift (@_);
|
|---|
| 504 | my ($mastersection) = @_;
|
|---|
| 505 |
|
|---|
| 506 | my ($num);
|
|---|
| 507 | my $section = $mastersection;
|
|---|
| 508 | my $sectionref = $self;
|
|---|
| 509 |
|
|---|
| 510 | while ($section ne "") {
|
|---|
| 511 | ($num, $section) = $section =~ /^\.?(\d+)(.*)$/;
|
|---|
| 512 | $num =~ s/^0+(\d)/$1/; # remove leading 0s
|
|---|
| 513 | $section = "" unless defined $section;
|
|---|
| 514 |
|
|---|
| 515 | if (defined $num) {
|
|---|
| 516 | if (!defined $sectionref->{'subsections'}->{$num}) {
|
|---|
| 517 | push (@{$sectionref->{'subsection_order'}}, $num);
|
|---|
| 518 | $sectionref->{'subsections'}->{$num} = {'subsection_order'=>[],
|
|---|
| 519 | 'next_subsection'=>1,
|
|---|
| 520 | 'subsections'=>{},
|
|---|
| 521 | 'metadata'=>[],
|
|---|
| 522 | 'text'=>""};
|
|---|
| 523 | if ($num >= $sectionref->{'next_subsection'}) {
|
|---|
| 524 | $sectionref->{'next_subsection'} = $num + 1;
|
|---|
| 525 | }
|
|---|
| 526 | }
|
|---|
| 527 | $sectionref = $sectionref->{'subsections'}->{$num};
|
|---|
| 528 |
|
|---|
| 529 | } else {
|
|---|
| 530 | print STDERR "doc::create_named_section couldn't create section ";
|
|---|
| 531 | print STDERR "$mastersection\n";
|
|---|
| 532 | last;
|
|---|
| 533 | }
|
|---|
| 534 | }
|
|---|
| 535 | }
|
|---|
| 536 |
|
|---|
| 537 | # returns a reference to a list of subsections
|
|---|
| 538 | sub list_subsections {
|
|---|
| 539 | my $self = shift (@_);
|
|---|
| 540 | my ($section) = @_;
|
|---|
| 541 |
|
|---|
| 542 | my $section_ptr = $self->_lookup_section ($section);
|
|---|
| 543 | if (!defined $section_ptr) {
|
|---|
| 544 | print STDERR "doc::list_subsections couldn't find section $section\n";
|
|---|
| 545 | return [];
|
|---|
| 546 | }
|
|---|
| 547 |
|
|---|
| 548 | return [@{$section_ptr->{'subsection_order'}}];
|
|---|
| 549 | }
|
|---|
| 550 |
|
|---|
| 551 | sub delete_section {
|
|---|
| 552 | my $self = shift (@_);
|
|---|
| 553 | my ($section) = @_;
|
|---|
| 554 |
|
|---|
| 555 | # my $section_ptr = {'subsection_order'=>[],
|
|---|
| 556 | # 'next_subsection'=>1,
|
|---|
| 557 | # 'subsections'=>{},
|
|---|
| 558 | # 'metadata'=>[],
|
|---|
| 559 | # 'text'=>""};
|
|---|
| 560 |
|
|---|
| 561 | # if this is the top section reset everything
|
|---|
| 562 | if ($section eq "") {
|
|---|
| 563 | $self->{'subsection_order'} = [];
|
|---|
| 564 | $self->{'subsections'} = {};
|
|---|
| 565 | $self->{'metadata'} = [];
|
|---|
| 566 | $self->{'text'} = "";
|
|---|
| 567 | return;
|
|---|
| 568 | }
|
|---|
| 569 |
|
|---|
| 570 | # find the parent of the section to delete
|
|---|
| 571 | my $parent_section = "";
|
|---|
| 572 | my $child = "0";
|
|---|
| 573 | my @section = split (/\./, $section);
|
|---|
| 574 | if (scalar(@section) > 0) {
|
|---|
| 575 | $child = pop (@section);
|
|---|
| 576 | $parent_section = join (".", @section);
|
|---|
| 577 | }
|
|---|
| 578 |
|
|---|
| 579 | my $parent_section_ptr = $self->_lookup_section($parent_section);
|
|---|
| 580 | if (!defined $parent_section_ptr) {
|
|---|
| 581 | print STDERR "doc::delete_section couldn't find parent section " .
|
|---|
| 582 | "$parent_section\n";
|
|---|
| 583 | return;
|
|---|
| 584 | }
|
|---|
| 585 |
|
|---|
| 586 | # remove this section from the subsection_order list
|
|---|
| 587 | my $i = 0;
|
|---|
| 588 | while ($i < scalar (@{$parent_section_ptr->{'subsection_order'}})) {
|
|---|
| 589 | if ($parent_section_ptr->{'subsection_order'}->[$i] eq $child) {
|
|---|
| 590 | splice (@{$parent_section_ptr->{'subsection_order'}}, $i, 1);
|
|---|
| 591 | last;
|
|---|
| 592 | }
|
|---|
| 593 | $i++;
|
|---|
| 594 | }
|
|---|
| 595 |
|
|---|
| 596 | # remove this section from the subsection hash
|
|---|
| 597 | if (defined ($parent_section_ptr->{'subsections'}->{$child})) {
|
|---|
| 598 | undef $parent_section_ptr->{'subsections'}->{$child};
|
|---|
| 599 | }
|
|---|
| 600 | }
|
|---|
| 601 |
|
|---|
| 602 | #--
|
|---|
| 603 | # methods for dealing with metadata
|
|---|
| 604 |
|
|---|
| 605 | # set_metadata_element and get_metadata_element are for metadata
|
|---|
| 606 | # which should only have one value. add_meta_data and get_metadata
|
|---|
| 607 | # are for metadata which can have more than one value.
|
|---|
| 608 |
|
|---|
| 609 | # returns the first metadata value which matches field
|
|---|
| 610 | sub get_metadata_element {
|
|---|
| 611 | my $self = shift (@_);
|
|---|
| 612 | my ($section, $field) = @_;
|
|---|
| 613 | my ($data);
|
|---|
| 614 |
|
|---|
| 615 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 616 | if (!defined $section_ptr) {
|
|---|
| 617 | print STDERR "doc::get_metadata_element couldn't find section " .
|
|---|
| 618 | "$section\n";
|
|---|
| 619 | return;
|
|---|
| 620 | }
|
|---|
| 621 |
|
|---|
| 622 | foreach $data (@{$section_ptr->{'metadata'}}) {
|
|---|
| 623 | return $data->[1] if (scalar(@$data) >= 2 && $data->[0] eq $field);
|
|---|
| 624 | }
|
|---|
| 625 |
|
|---|
| 626 | return undef; # was not found
|
|---|
| 627 | }
|
|---|
| 628 |
|
|---|
| 629 |
|
|---|
| 630 | # returns a list of the form [value1, value2, ...]
|
|---|
| 631 | sub get_metadata {
|
|---|
| 632 | my $self = shift (@_);
|
|---|
| 633 | my ($section, $field) = @_;
|
|---|
| 634 | my ($data);
|
|---|
| 635 |
|
|---|
| 636 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 637 | if (!defined $section_ptr) {
|
|---|
| 638 | print STDERR "doc::get_metadata couldn't find section " .
|
|---|
| 639 | "$section\n";
|
|---|
| 640 | return;
|
|---|
| 641 | }
|
|---|
| 642 |
|
|---|
| 643 | my @metadata = ();
|
|---|
| 644 | foreach $data (@{$section_ptr->{'metadata'}}) {
|
|---|
| 645 | push (@metadata, $data->[1]) if ($data->[0] eq $field);
|
|---|
| 646 | }
|
|---|
| 647 |
|
|---|
| 648 | return \@metadata;
|
|---|
| 649 | }
|
|---|
| 650 |
|
|---|
| 651 | # returns a list of the form [[field,value],[field,value],...]
|
|---|
| 652 | sub get_all_metadata {
|
|---|
| 653 | my $self = shift (@_);
|
|---|
| 654 | my ($section) = @_;
|
|---|
| 655 |
|
|---|
| 656 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 657 | if (!defined $section_ptr) {
|
|---|
| 658 | print STDERR "doc::get_all_metadata couldn't find section " .
|
|---|
| 659 | "$section\n";
|
|---|
| 660 | return;
|
|---|
| 661 | }
|
|---|
| 662 |
|
|---|
| 663 | return $section_ptr->{'metadata'};
|
|---|
| 664 | }
|
|---|
| 665 |
|
|---|
| 666 | # $value is optional
|
|---|
| 667 | sub delete_metadata {
|
|---|
| 668 | my $self = shift (@_);
|
|---|
| 669 | my ($section, $field, $value) = @_;
|
|---|
| 670 |
|
|---|
| 671 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 672 | if (!defined $section_ptr) {
|
|---|
| 673 | print STDERR "doc::delete_metadata couldn't find section " .
|
|---|
| 674 | "$section\n";
|
|---|
| 675 | return;
|
|---|
| 676 | }
|
|---|
| 677 |
|
|---|
| 678 | my $i = 0;
|
|---|
| 679 | while ($i < scalar (@{$section_ptr->{'metadata'}})) {
|
|---|
| 680 | if (($section_ptr->{'metadata'}->[$i]->[0] eq $field) &&
|
|---|
| 681 | (!defined $value || $section_ptr->{'metadata'}->[$i]->[1] eq $value)) {
|
|---|
| 682 | splice (@{$section_ptr->{'metadata'}}, $i, 1);
|
|---|
| 683 | } else {
|
|---|
| 684 | $i++;
|
|---|
| 685 | }
|
|---|
| 686 | }
|
|---|
| 687 | }
|
|---|
| 688 |
|
|---|
| 689 | sub delete_all_metadata {
|
|---|
| 690 | my $self = shift (@_);
|
|---|
| 691 | my ($section) = @_;
|
|---|
| 692 |
|
|---|
| 693 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 694 | if (!defined $section_ptr) {
|
|---|
| 695 | print STDERR "doc::delete_all_metadata couldn't find section " .
|
|---|
| 696 | "$section\n";
|
|---|
| 697 | return;
|
|---|
| 698 | }
|
|---|
| 699 |
|
|---|
| 700 | $section_ptr->{'metadata'} = [];
|
|---|
| 701 | }
|
|---|
| 702 |
|
|---|
| 703 | sub set_metadata_element {
|
|---|
| 704 | my $self = shift (@_);
|
|---|
| 705 | my ($section, $field, $value) = @_;
|
|---|
| 706 |
|
|---|
| 707 | $self->set_utf8_metadata_element ($section, $field,
|
|---|
| 708 | &unicode::ascii2utf8(\$value));
|
|---|
| 709 | }
|
|---|
| 710 |
|
|---|
| 711 | # set_utf8_metadata_element assumes the text has already been
|
|---|
| 712 | # converted to the UTF-8 encoding.
|
|---|
| 713 | sub set_utf8_metadata_element {
|
|---|
| 714 | my $self = shift (@_);
|
|---|
| 715 | my ($section, $field, $value) = @_;
|
|---|
| 716 |
|
|---|
| 717 | $self->delete_metadata ($section, $field);
|
|---|
| 718 | $self->add_utf8_metadata ($section, $field, $value);
|
|---|
| 719 | }
|
|---|
| 720 |
|
|---|
| 721 |
|
|---|
| 722 | # add_metadata assumes the text is in (extended) ascii form. For
|
|---|
| 723 | # text which hash been already converted to the UTF-8 format use
|
|---|
| 724 | # add_utf8_metadata.
|
|---|
| 725 | sub add_metadata {
|
|---|
| 726 | my $self = shift (@_);
|
|---|
| 727 | my ($section, $field, $value) = @_;
|
|---|
| 728 |
|
|---|
| 729 | $self->add_utf8_metadata ($section, $field,
|
|---|
| 730 | &unicode::ascii2utf8(\$value));
|
|---|
| 731 | }
|
|---|
| 732 |
|
|---|
| 733 | # add_utf8_metadata assumes the text has already been converted
|
|---|
| 734 | # to the UTF-8 encoding.
|
|---|
| 735 | sub add_utf8_metadata {
|
|---|
| 736 | my $self = shift (@_);
|
|---|
| 737 | my ($section, $field, $value) = @_;
|
|---|
| 738 |
|
|---|
| 739 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 740 | if (!defined $section_ptr) {
|
|---|
| 741 | print STDERR "doc::add_utf8_metadata couldn't find section " .
|
|---|
| 742 | "$section\n";
|
|---|
| 743 | return;
|
|---|
| 744 | }
|
|---|
| 745 | if (!defined $value) {
|
|---|
| 746 | print STDERR "doc::add_utf8_metadata undefined value for $field\n";
|
|---|
| 747 | return;
|
|---|
| 748 | }
|
|---|
| 749 | if (!defined $field) {
|
|---|
| 750 | print STDERR "doc::add_utf8_metadata undefined metadata type \n";
|
|---|
| 751 | return;
|
|---|
| 752 | }
|
|---|
| 753 |
|
|---|
| 754 | push (@{$section_ptr->{'metadata'}}, [$field, $value]);
|
|---|
| 755 | }
|
|---|
| 756 |
|
|---|
| 757 |
|
|---|
| 758 | # methods for dealing with text
|
|---|
| 759 |
|
|---|
| 760 | # returns the text for a section
|
|---|
| 761 | sub get_text {
|
|---|
| 762 | my $self = shift (@_);
|
|---|
| 763 | my ($section) = @_;
|
|---|
| 764 |
|
|---|
| 765 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 766 | if (!defined $section_ptr) {
|
|---|
| 767 | print STDERR "doc::get_text couldn't find section " .
|
|---|
| 768 | "$section\n";
|
|---|
| 769 | return "";
|
|---|
| 770 | }
|
|---|
| 771 |
|
|---|
| 772 | return $section_ptr->{'text'};
|
|---|
| 773 | }
|
|---|
| 774 |
|
|---|
| 775 | # returns the (utf-8 encoded) length of the text for a section
|
|---|
| 776 | sub get_text_length {
|
|---|
| 777 | my $self = shift (@_);
|
|---|
| 778 | my ($section) = @_;
|
|---|
| 779 |
|
|---|
| 780 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 781 | if (!defined $section_ptr) {
|
|---|
| 782 | print STDERR "doc::get_text_length couldn't find section " .
|
|---|
| 783 | "$section\n";
|
|---|
| 784 | return 0;
|
|---|
| 785 | }
|
|---|
| 786 |
|
|---|
| 787 | return length ($section_ptr->{'text'});
|
|---|
| 788 | }
|
|---|
| 789 |
|
|---|
| 790 | sub delete_text {
|
|---|
| 791 | my $self = shift (@_);
|
|---|
| 792 | my ($section) = @_;
|
|---|
| 793 |
|
|---|
| 794 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 795 | if (!defined $section_ptr) {
|
|---|
| 796 | print STDERR "doc::delete_text couldn't find section " .
|
|---|
| 797 | "$section\n";
|
|---|
| 798 | return;
|
|---|
| 799 | }
|
|---|
| 800 |
|
|---|
| 801 | $section_ptr->{'text'} = "";
|
|---|
| 802 | }
|
|---|
| 803 |
|
|---|
| 804 | # add_text assumes the text is in (extended) ascii form. For
|
|---|
| 805 | # text which has been already converted to the UTF-8 format
|
|---|
| 806 | # use add_utf8_text.
|
|---|
| 807 | sub add_text {
|
|---|
| 808 | my $self = shift (@_);
|
|---|
| 809 | my ($section, $text) = @_;
|
|---|
| 810 |
|
|---|
| 811 | # convert the text to UTF-8 encoded unicode characters
|
|---|
| 812 | # and add the text
|
|---|
| 813 | $self->add_utf8_text($section, &unicode::ascii2utf8(\$text));
|
|---|
| 814 | }
|
|---|
| 815 |
|
|---|
| 816 |
|
|---|
| 817 | # add_utf8_text assumes the text to be added has already
|
|---|
| 818 | # been converted to the UTF-8 encoding. For ascii text use
|
|---|
| 819 | # add_text
|
|---|
| 820 | sub add_utf8_text {
|
|---|
| 821 | my $self = shift (@_);
|
|---|
| 822 | my ($section, $text) = @_;
|
|---|
| 823 |
|
|---|
| 824 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 825 | if (!defined $section_ptr) {
|
|---|
| 826 | print STDERR "doc::add_utf8_text couldn't find section " .
|
|---|
| 827 | "$section\n";
|
|---|
| 828 | return;
|
|---|
| 829 | }
|
|---|
| 830 |
|
|---|
| 831 | $section_ptr->{'text'} .= $text;
|
|---|
| 832 | }
|
|---|
| 833 |
|
|---|
| 834 |
|
|---|
| 835 | # methods for dealing with associated files
|
|---|
| 836 |
|
|---|
| 837 | # a file is associated with a document, NOT a section.
|
|---|
| 838 | # if section is defined it is noted in the data structure
|
|---|
| 839 | # only so that files associated from a particular section
|
|---|
| 840 | # may be removed later (using delete_section_assoc_files)
|
|---|
| 841 | sub associate_file {
|
|---|
| 842 | my $self = shift (@_);
|
|---|
| 843 | my ($real_filename, $assoc_filename, $mime_type, $section) = @_;
|
|---|
| 844 | $mime_type = &ghtml::guess_mime_type ($real_filename) unless defined $mime_type;
|
|---|
| 845 |
|
|---|
| 846 | # remove all associated files with the same name
|
|---|
| 847 | $self->delete_assoc_file ($assoc_filename);
|
|---|
| 848 |
|
|---|
| 849 | push (@{$self->{'associated_files'}},
|
|---|
| 850 | [$real_filename, $assoc_filename, $mime_type, $section]);
|
|---|
| 851 | }
|
|---|
| 852 |
|
|---|
| 853 | # returns a list of associated files in the form
|
|---|
| 854 | # [[real_filename, assoc_filename, mimetype], ...]
|
|---|
| 855 | sub get_assoc_files {
|
|---|
| 856 | my $self = shift (@_);
|
|---|
| 857 |
|
|---|
| 858 | return $self->{'associated_files'};
|
|---|
| 859 | }
|
|---|
| 860 |
|
|---|
| 861 | sub delete_section_assoc_files {
|
|---|
| 862 | my $self = shift (@_);
|
|---|
| 863 | my ($section) = @_;
|
|---|
| 864 |
|
|---|
| 865 | my $i=0;
|
|---|
| 866 | while ($i < scalar (@{$self->{'associated_files'}})) {
|
|---|
| 867 | if (defined $self->{'associated_files'}->[$i]->[3] &&
|
|---|
| 868 | $self->{'associated_files'}->[$i]->[3] eq $section) {
|
|---|
| 869 | splice (@{$self->{'associated_files'}}, $i, 1);
|
|---|
| 870 | } else {
|
|---|
| 871 | $i++;
|
|---|
| 872 | }
|
|---|
| 873 | }
|
|---|
| 874 | }
|
|---|
| 875 |
|
|---|
| 876 | sub delete_assoc_file {
|
|---|
| 877 | my $self = shift (@_);
|
|---|
| 878 | my ($assoc_filename) = @_;
|
|---|
| 879 |
|
|---|
| 880 | my $i=0;
|
|---|
| 881 | while ($i < scalar (@{$self->{'associated_files'}})) {
|
|---|
| 882 | if ($self->{'associated_files'}->[$i]->[1] eq $assoc_filename) {
|
|---|
| 883 | splice (@{$self->{'associated_files'}}, $i, 1);
|
|---|
| 884 | } else {
|
|---|
| 885 | $i++;
|
|---|
| 886 | }
|
|---|
| 887 | }
|
|---|
| 888 | }
|
|---|
| 889 |
|
|---|
| 890 | sub reset_nextsection_ptr {
|
|---|
| 891 | my $self = shift (@_);
|
|---|
| 892 | my ($section) = @_;
|
|---|
| 893 |
|
|---|
| 894 | my $section_ptr = $self->_lookup_section($section);
|
|---|
| 895 | $section_ptr->{'next_subsection'} = 1;
|
|---|
| 896 | }
|
|---|
| 897 |
|
|---|
| 898 | 1;
|
|---|
