/usr/share/perl5/Debian/DocBase/Document.pm is in doc-base 0.10.8.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 | # vim:cindent:ts=2:sw=2:et:fdm=marker:cms=\ #\ %s
#
# $Id: Document.pm 222 2011-02-28 22:18:55Z robert $
#
package Debian::DocBase::Document;
use strict;
use warnings;
use Debian::DocBase::Common;
use Debian::DocBase::Utils;
use Debian::DocBase::DocBaseFile;
use Debian::DocBase::Gettext;
use Debian::DocBase::DB;
#use Scalar::Util qw(weaken);
our %DOCUMENTS = ();
my %section_map = ();
#################################################
### PUBLIC STATIC FUNCTIONS ###
#################################################
# return list of all proceseed documents
sub GetDocumentList() { # {{{
return values %DOCUMENTS;
} # }}}
# check if $docid exists in status database
sub IsRegistered($) { # {{{
my $docid = shift;
return Debian::DocBase::DB::GetStatusDB()->Exists($docid);
} # }}}
# return all documents id from status database
sub GetAllRegisteredDocumentIDs() { # {{{
my $statusdb = Debian::DocBase::DB::GetStatusDB();
return sort $statusdb->GetDBKeys();
} # }}}
sub new { # {{{
my $class = shift;
my $documentId = shift;
return $DOCUMENTS{$documentId} if defined $DOCUMENTS{$documentId};
my $self = {
DOCUMENT_ID => $documentId,
MAIN_DATA => {},
FORMAT_LIST => {},
CONTROL_FILES => {},
STATUS_DICT => {},
MERGED_CTRL_FILES => 0,
INVALID => 1
};
bless($self, $class);
$self->_ReadStatusDB($documentId);
$DOCUMENTS{$documentId} = $self;
# weaken $DOCUMENTS{$documentId};
return $self;
} # }}}
#################################################
### PUBLIC FUNCTIONS ###
#################################################
sub DESTROY { # {{{
my $self = shift;
delete $DOCUMENTS{$self->GetDocumentID()};
} # }}}
sub GetDocumentID() { # {{{
my $self = shift;
return $self->{'DOCUMENT_ID'};
} # }}}
sub Invalid() { # {{{
my $self = shift;
return $self->{'INVALID'};
} # }}}
# getters for common fields
sub GetAbstract() { # {{{
my $self = shift;
return $self->_GetMainFld($FLD_ABSTRACT);
} # }}}
sub GetTitle() { # {{{
my $self = shift;
return $self->_GetMainFld($FLD_TITLE);
} # }}}
sub GetSection() { # {{{
my $self = shift;
return $self->_GetMainFld($FLD_SECTION);
} # }}}
sub GetAuthor() { # {{{
my $self = shift;
return $self->_GetMainFld($FLD_AUTHOR);
} # }}}
# returns hash with format data (i.e. with FLD_FORMAT, $FLD_INDEX, $FLD_FILES keys)
# for $format_name
sub GetFormat($$) { # {{{
my $self = shift;
my $format_name = shift;
return undef unless $self->_HasControlFiles();
$self->_CheckMerged();
return $self->{'FORMAT_LIST'}->{$format_name};
} # }}}
# returns status data for $key
sub GetStatus() { # {{{
my $self = shift;
my $key = shift;
return $self->{'STATUS_DICT'}->{$key};
} # }}}
sub SetStatus($%) { # {{{
my $self = shift;
my %status = @_;
my $changed = 0;
foreach my $key (keys %status) {
my $oldvalue = $self->{'STATUS_DICT'}->{$key};
my $value = $status{$key};
if (defined $value) {
$self->{'STATUS_DICT'}->{$key} = $value;
} else {
delete $self->{'STATUS_DICT'}->{$key};
}
$changed = 1 if ( (defined $value xor defined $oldvalue)
or (defined $value and $value ne $oldvalue) );
}
$changed ? $self->_WriteStatusDB()
: Debug("Status of `" . join ("', `", keys %status) . "' in " .
$self->GetDocumentID() . " not changed");
} # }}}
# displays informations about the document (called by `install-docs -s')
sub DisplayStatusInformation($) { # {{{
my $self = shift;
my $docid = $self->GetDocumentID();
my $status_file = "$DATA_DIR/$docid.status";
my $var_ctrl_file = "$VAR_CTRL_DIR/$docid";
my $doc_info_msg = _g("---document-information---");
my $fmt_desc_msg = _g("---format-description---");
my $status_info_msg = _g("---status-information---");
if (-f $var_ctrl_file) {
if (open(F, '<', $var_ctrl_file)) {
print $doc_info_msg . "\n";
while (<F>) {
next if /^Control-Files:/;
s/^$/\n$fmt_desc_msg/o;
print $_;
}
close(F);
} else {
Warn( _g("Cannot open file `%s' for reading: %s."), $var_ctrl_file, $!);
}
}
print "\n" . $status_info_msg . "\n";
map {
print "Control-File: $_ (changed: ". localtime ($self->{'CONTROL_FILES'}->{$_}->GetLastChangeTime()) . ")\n";
} sort keys %{$self->{'CONTROL_FILES'}};
map {
print "$_: $self->{'STATUS_DICT'}->{$_}\n";
} sort keys %{$self->{'STATUS_DICT'}};
} # }}}
sub Register($$) { # {{{
my $self = shift;
my $db_file = shift;
my $db_filename = $db_file->GetSourceFileName();
Debug("Registering `$db_filename'");
if ($db_file->GetDocumentID() ne $self->GetDocumentID()) {
delete $self->{'CONTROL_FILES'}->{$db_filename};
$db_file->OnRegistered(0);
return Error( _g("Document id in `%s' does not match our document id (%s != %s)."),
$db_filename, $db_file->GetDocumentID(), $self->GetDocumentID()
);
}
if ($db_file->Invalid()) {
delete $self->{'CONTROL_FILES'}->{$db_filename};
$db_file->OnRegistered(0);
return Warn( _g( "`%s' contains errors, not registering."), $db_file->GetSourceFileName() );
}
# $db_file->OnRegistered(1); # Set it after document is generated
$self->{'CONTROL_FILES'}->{$db_filename} = $db_file;
} # }}}
sub Unregister($$) { # {{{
my $self = shift;
my $db_file = shift;
my $db_filename = $db_file->GetSourceFileName();
unless (exists $self->{'CONTROL_FILES'}->{$db_filename}) {
# remove any file data from our existing files database if it's there
Debian::DocBase::DB::GetFilesDB()->RemoveData($db_filename);
return Warn( _g("File `%s' is not registered, cannot remove.") , $db_filename)
}
$self->{'CONTROL_FILES'}->{$db_filename}->OnUnregistered();
delete $self->{'CONTROL_FILES'}->{$db_filename};
} # }}}
sub UnregisterAll($) { # {{{
my $self = shift;
Debug(_g("Unregistering all control files from document `%s'."), $self->GetDocumentID() );
foreach my $doc ( values %{$self->{'CONTROL_FILES'}} ) {
$doc->OnUnregistered();
}
$self->{'CONTROL_FILES'} = {};
} # }}}
# generate and write new merged control file into /var/lib/doc-base/documents
sub WriteNewCtrlFile() { # {{{
my $self = shift;
my $docid = $self->GetDocumentID();
my $tmpfile = $VAR_CTRL_DIR . "/." . $docid . ".tmp";
my $file = $VAR_CTRL_DIR . "/" . $docid;
my $fld = undef;
$self->_CheckMerged();
if ($self->Invalid() || !$self->_HasControlFiles()) {
if (-e $file) {
Debug("Removing control file $file");
unlink $file or Fatal($ERR_FSACCESS, _g("Cannot remove file `%s': %s."), $file, $!);
}
return;
}
open(F, '>', $tmpfile) or
Fatal($ERR_FSACCESS, _g("Cannot open file `%s' for writing: %s."), $tmpfile, $!);
foreach $fld (GetFldKeys($FLDTYPE_MAIN)) {
print F ucfirst($fld) . ": " . $self->{'MAIN_DATA'}->{$fld} . "\n"
if $self->{'MAIN_DATA'}->{$fld};
}
foreach my $format (sort keys %{$self->{'FORMAT_LIST'}}) {
print F "\n";
foreach $fld (GetFldKeys($FLDTYPE_FORMAT)) {
print F ucfirst($fld) . ": " . $self->{'FORMAT_LIST'}->{$format}->{$fld} . "\n"
if $self->{'FORMAT_LIST'}->{$format}->{$fld};
}
}
close F or Fatal($ERR_FSACCESS, _g("Cannot close file `%s': %s."), $file, $!);
rename $tmpfile, $file
or Fatal($ERR_FSACCESS, _g("Cannot rename file `%s' to `%s': %s."), $tmpfile, $file, $!);
# mark the control files as registered
map { $self->{'CONTROL_FILES'}->{$_}->OnRegistered(1); } keys %{$self->{'CONTROL_FILES'}};
} # }}}
# merge contents of all available control files for the document
# into $self->{'MAIN_DATA'} and $self->{'FORMAT_LIST'}
# Fields 'Document' and 'Section' must have the same value in all control files.
# Value of fields 'Author', 'Abstract', 'Title' is taken from the first control file
# in which the value is not empty.
# Format sections are joined. It's an error if the same format is defined in more
# than one control file.
sub MergeCtrlFiles($) { # {{{
my $self = shift;
my $doc_id = $self->GetDocumentID();
$self->_ParseControlFiles();
$self->{'INVALID'} = 1;
$self->{'MERGED_CTRL_FILES'} = 1;
$self->{'MAIN_DATA'} = {};
$self->{'FORMAT_LIST'} = {};
my @control_files = $self->_GetControlFileNames();
for (my $idx = 0; $idx <= $#control_files; $idx++) {
my $db_file_name = $control_files[$idx];
my $doc_data = $self->{'CONTROL_FILES'}->{$db_file_name};
my $doc_fname = $doc_data->GetSourceFileName();
if ($doc_data->GetDocumentID() ne $doc_id) {
Warn( _g("Unregistering file `%s', since its actual document id `%s' does not match its saved document id `%s'."),
$doc_fname, $doc_data->GetDocumentID(), $doc_id);
$self->Unregister($doc_data);
splice (@control_files, $idx--, 1);
next;
}
# merge main sections' fields
foreach my $fld (GetFldKeys($FLDTYPE_MAIN)) {
my $old_val = $self->{'MAIN_DATA'}->{$fld};
my $new_val = $doc_data->GetFldValue($fld);
if ($new_val) {
$new_val = $self->_MangleSection($new_val) if $fld eq $FLD_SECTION;
if ($old_val and $old_val ne $new_val and
($fld eq $FLD_DOCUMENT or $fld eq $FLD_SECTION)) {
return Error( _g("Error while merging %s with %s: inconsistent values of %s."),
join(', ', @control_files[0..$idx-1]), $doc_fname, $fld);
}
$self->{'MAIN_DATA'}->{$fld} = $new_val unless $old_val;
}
}
# merge formats
foreach my $format ($doc_data->GetFormatNames()) {
return Error( _g("Error while merging %s with %s: format %s already defined."),
join(', ', @control_files[0..$idx-1]), $doc_fname, $format) if $self->{'FORMAT_LIST'}->{$format};
$self->{'FORMAT_LIST'}->{$format} = $doc_data->GetFormat($format);
}
}
return unless %{$self->{'FORMAT_LIST'}};
$self->{'INVALID'} = 0;
} # }}}
# Save status changes, calls _WriteStatusDB()
sub SaveStatusChanges($) { # {{{
my $self = shift;
$self->_WriteStatusDB();
} # }}}
#################################################
### PRIVATE FUNCTIONS ###
#################################################
# dies with Internal error if document hasn't been merged yet
sub _CheckMerged($) { # {{{
my $self = shift;
Fatal($ERR_INTERNAL, _g("Document `%s' is not yet merged."), $self->GetDocumentID())
unless $self->{'MERGED_CTRL_FILES'};
} # }}}
# returns $fld from $self->{'MAIN_DATA'}
sub _GetMainFld($$) { # {{{
my $self = shift;
my $fld = shift;
$self->_CheckMerged();
return "" if $self->Invalid();
return "" unless $self->{'MAIN_DATA'}->{$fld};
return $self->{'MAIN_DATA'}->{$fld};
} # }}}
sub _HasControlFiles() { # {{{
my $self = shift;
return $self->{'CONTROL_FILES'}
} # }}}
# reads our status file and sets $self->{'STATUS_DICT'} and sets keys of
# $self->{'CONTROL_FILES'}
sub _ReadStatusDB { # {{{
my $self = shift;
my $docid = $self->GetDocumentID();
my $data = Debian::DocBase::DB::GetStatusDB()->GetData($docid);
if ($data) {
my %cf = map { $_ => Debian::DocBase::DocBaseFile->new($_) } keys %{$data->{'CF'}};
$self->{'CONTROL_FILES'} = \%cf;
$self->{'STATUS_DICT'} = $data->{'SD'};
} else {
$self->{'CONTROL_FILES'} = {};
$self->{'STATUS_DICT'} = {};
};
$self->{'INVALID'} = 0;
} # }}}
# writes our status file
sub _WriteStatusDB { # {{{
my $self = shift;
my $docid = $self->GetDocumentID();
if (%{$self->{'CONTROL_FILES'}} or %{$self->{'STATUS_DICT'}}) {
my %cf = map { $_ => undef } keys %{$self->{'CONTROL_FILES'}};
my $data = { 'CF' => \%cf,
'SD' => $self->{'STATUS_DICT'}
};
Debian::DocBase::DB::GetStatusDB()->PutData($docid, $data);
} else {
Debian::DocBase::DB::GetStatusDB()->RemoveData($docid);
}
} # }}}
# if called without any argument, returns array of control files' names
# if called with an argument returns string containing names of the control files
# joined with value of the argument
sub _GetControlFileNames($;$) { # {{{
my $self = shift;
my $join_str = shift;
my @cfnames = sort keys %{$self->{'CONTROL_FILES'}};
return @cfnames unless ($join_str);
return join($join_str, @cfnames);
} # }}}
# reads and parses all control files mentioned in $self->{'CONTROL_FILES'}
sub _ParseControlFiles($) { # {{{
my $self = shift;
foreach my $cfname ($self->_GetControlFileNames()) {
Fatal($ERR_INTERNAL, _g("`%s' not yet created."), $cfname) unless $self->{'CONTROL_FILES'}->{$cfname};
$self->{'CONTROL_FILES'}->{$cfname}->Parse();
}
} # }}}
sub _MangleSection($) { # {{{
my $self = shift;
my $section = shift;
ReadMap($DOCBASE_SECTIONS_MAP, \%section_map) unless %section_map;
$section = lc $section;
$section =~ s/\s+/ /g; $section =~ s/\/+/\//g;
$section =~ s/[\/\s]$//g; $section =~ s/^[\/\s]//g;
$section =~ s/\b./\U$&\E/g;
my @sect_comps = split (/\/+/, $section);
my $result = "";
while ($#sect_comps > -1) {
my $tmp = shift(@sect_comps);
$result = ($result) ? $result . "/" . $tmp : $tmp;
$tmp = lc $result;
$result = $section_map{$tmp} if exists $section_map{$tmp};
}
return $result if $result;
return "Unknown";
} # }}}
1;
|