/usr/share/perl5/Debian/DocBase/Programs/Scrollkeeper.pm is in doc-base 0.10.5.
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 | # vim:cindent:ts=2:sw=2:et:fdm=marker:cms=\ #\ %s
#
# $Id: Scrollkeeper.pm 223 2011-02-28 23:34:22Z robert $
#
package Debian::DocBase::Programs::Scrollkeeper;
use Exporter();
use strict;
use warnings;
use vars qw(@ISA @EXPORT);
@ISA = qw(Exporter);
@EXPORT = qw(RegisterScrollkeeper ScrollkeeperStatusChanged
$SC_NOTCHANGED $SC_INSTALLED $SC_REMOVED);
use Debian::DocBase::Common;
use Debian::DocBase::Utils;
use Debian::DocBase::Gettext;
use Debian::DocBase::DB;
use UUID;
our $SC_NOTCHANGED = 0;
our $SC_INSTALLED = 1;
our $SC_REMOVED = 2;
our $scrollkeeper_update = "/usr/bin/scrollkeeper-update";
our $scrollkeeper_map_file = "/usr/share/doc-base/data/scrollkeeper.map";
our %omf_mime_types = (
'html' => 'mime="text/html"',
'text' => 'mime="text/plain"',
'pdf' => 'mime="application/pdf"',
'postscript' => 'mime="application/postscript"',
'dvi' => 'mime="application/x-dvi"',
'docbook-xml' => 'mime="text/xml" dtd="-//OASIS//DTD DocBook XML V4.1.2//EN"'
);
our %file_ext_mime_types = (
'bz2' => 'mime="application/x-bzip2"',
'gz' => 'mime="application/x-gzip"',
'tgz' => 'mime="application/x-gzip"',
'Z' => 'mime="application/x-compress"',
);
our @omf_formats = (
'html',
'docbook-xml',
'pdf',
'postscript',
'dvi',
'text'
);
our %mapping = (undef=>undef);
sub _GetUUID() { # {{{
my ($uuid, $retval);
UUID::generate($uuid);
UUID::unparse($uuid, $retval);
return $retval;
} # }}}
sub RegisterScrollkeeper($@) { # {{{
my $showinfo = shift;
my @documents = @_;
if (! $opt_update_menus)
{
Debug(_g("Skipping registration of %s because of --no-update-menus."), $opt_update_menus);
return;
}
my $statusChanged=ScrollkeeperStatusChanged();
if (-x $scrollkeeper_update)
{
Inform(_g("Registering documents with %s..."), "scrollkeeper") if $showinfo;
_RegisterScrollkeeperFiles(@documents);
}
elsif ($statusChanged == $SC_REMOVED)
{
Inform(_g("Unregistering documents from %s..."), "scrollkeeper") if $showinfo;
_UnregisterScrollkeeperFiles(@documents);
}
else
{
Debug(_g("Skipping execution of %s - %s package doesn't seem to be installed."), $scrollkeeper_update, "rarian-compat");
}
_SaveScrollkeeperStatus() if $statusChanged != $SC_NOTCHANGED;
} # }}}
sub _RegisterScrollkeeperFiles($@) { # {{{
my @documents = @_;
my $do_update = 0;
Debug(_g("%s started."), "_RegisterScrollkeeperFiles");
# read in doc-base -> scrollkeeper mappings unless already read
ReadMap($scrollkeeper_map_file, \%mapping);
foreach my $doc (@documents) {
my $format_data;
my $old_omf_file = $doc->GetStatus('Scrollkeeper-omf-file');
my $omf_serial_id = undef;
my $new_omf_file = undef;
my $omf_category = _MapDocbaseToScrollkeeper($doc->GetSection());
if (defined $omf_category) {
for my $omf_format (@omf_formats) {
$format_data = $doc->GetFormat($omf_format);
next unless defined $format_data;
my $file = defined $$format_data{'index'} ? $$format_data{'index'} : $$format_data{'files'};
next if $file =~ /\n/; # avoid `Unsuccessful stat on filename containing newline'
# given by perl in the next line when the files field is a
# multiline one, see Bug#607498
next unless -f $file;
$omf_serial_id = $doc->GetStatus('Scrollkeeper-sid');
# chomp ($omf_serial_id = `$scrollkeeper_gen_seriesid`) unless defined $omf_serial_id;
$omf_serial_id = _GetUUID() unless $omf_serial_id;
$new_omf_file = _WriteOmfFile($doc, $file,$omf_format,$omf_category, $omf_serial_id);
$do_update = 1;
last; # register only the first format found
}
}
# remove old omf file
# FIXME: $old_omf_file might be the same file as $new_omf_file even if $old_omf_file ne $new_omf_file
if (defined $old_omf_file and (not defined $new_omf_file or $old_omf_file ne $new_omf_file)) {
_RemoveOmfFile($old_omf_file);
$do_update = 1;
}
$doc->SetStatus( 'Scrollkeeper-omf-file' => $new_omf_file,
'Scrollkeeper-sid' => $omf_serial_id);
}
Execute($scrollkeeper_update, '-q') if ($do_update and $opt_update_menus);
Debug(_g("%s finished."), "_RegisterScrollkeeperFiles");
} # }}}
sub _UnregisterScrollkeeperFiles($@) { # {{{
my @documents = @_;
Debug(_g("%s started."), "_UnRegisterScrollkeeperFiles");
foreach my $doc (@documents) {
my $old_omf_file = $doc->GetStatus('Scrollkeeper-omf-file');
next unless defined $old_omf_file;
my $omf_serial_id = $doc->GetStatus('Scrollkeeper-sid');
_RemoveOmfFile($old_omf_file);
$doc->SetStatus( 'Scrollkeeper-omf-file' => undef,
'Scrollkeeper-sid' => $omf_serial_id);
}
Debug(_g("%s finished."), "_UnRegisterScrollkeeperFiles");
} # }}}
# arguments: filename
# reads a file that looks like:
# foo: bar
# returns: hash of lv -> rv
# arguments: doc-base section
# returns: scrollkeeper category
sub _MapDocbaseToScrollkeeper($) { # {{{
return $mapping{lc($_[0])};
} # }}}
sub _DirName { # {{{
my @p = split '/', $_[0];
return (join '/', @p[0..($#p-1)]) if $#p > 1;
return '/' if substr ($_[0], 0, 1) eq '/';
return '.';
} # }}}
sub _RemoveOmfFile($) { # {{{
my $omf_file = shift;
my $omf_dir = _DirName($omf_file);
Debug( _g("Removing scrollkeeper OMF file `%s'."), $omf_file);
unlink($omf_file) or return Error( _g("Cannot remove file `%s': %s."), $omf_file, $!);
#check to see if the directory is now empty. if so, kill it.
if (opendir(DIR, $omf_dir)) {
if (defined grep { $_ !~ /^\.\.?$/ } readdir DIR) {
rmdir($omf_dir) or Error( _g("Cannot delete directory `%s': %s."), $omf_dir, $!);
}
closedir DIR;
}
} # }}}
sub _HTMLEncode($) { # {{{
my $text = shift;
$text =~ s/&/(and)/g; # scrollkeeper doesn't handle & correctly, see Bug#429847
return HTMLEncode($text);
} # }}}
sub _GetMimeType($$) { # {{{
my ($file, $format) = @_;
if ((my $ext = $file) =~ s/^.*\.//)
{
return $file_ext_mime_types{$ext} if $file_ext_mime_types{$ext};
}
return $omf_mime_types{$format} if $omf_mime_types{$format};
return "application/x-unknown";
} # }}}
sub _WriteOmfFile($$$$) { # {{{
my ($doc, $file, $format, $category, $serial_id) = @_;
my $docid = $doc->GetDocumentID();
my $omf_file = "$OMF_DIR/$docid/$docid-C.omf";
my $date;
my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
$year += 1900;
$mon++;
if ($mday <10) {$mday = "0$mday";}
if ($mon <10) {$mon = "0$mon";}
$date = "$year-$mon-$mday";
if (! -d "$OMF_DIR/$docid") {
mkdir("$OMF_DIR/$docid") or Fatal($ERR_FSACCESS, _g("Cannot create directory `%s': %s."), $OMF_DIR/$docid, $!);
}
&Debug("Writing scrollkeeper OMF file `$omf_file'");
open(OMF, ">", $omf_file)
or croak("Cannot open OMF file `$omf_file' for writing: $!");
#now for the boiler plate XML stuff
print OMF "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
print OMF "<!DOCTYPE omf PUBLIC \"-//OMF//DTD Scrollkeeper OMF Variant V1.0//EN\" \"http://scrollkeeper.sourceforge.net/dtds/scrollkeeper-omf-1.0/scrollkeeper-omf.dtd\">\n";
print OMF "<omf>\n\t<resource>\n";
#now for the dynamic stuff
print OMF "\t\t<creator>".&_HTMLEncode($doc->GetAuthor())."</creator>\n";
print OMF "\t\t<title>".&_HTMLEncode($doc->GetTitle())."</title>\n";
print OMF "\t\t<date>$date</date>\n";
print OMF "\t\t<subject category=\"$category\"/>\n";
print OMF "\t\t<description>".&_HTMLEncode($doc->GetAbstract())."</description>\n";
print OMF "\t\t<format ".&_GetMimeType($file,$format)." />\n";
print OMF "\t\t<identifier url=\"$file\"/>\n";
print OMF "\t\t<language code=\"C\"/>\n";
print OMF "\t\t<relation seriesid=\"$serial_id\"/>\n";
#finish the boiler plate
print OMF "\t</resource>\n</omf>\n";
close(OMF) or Fatal($ERR_FSACCESS, _g("Cannot close file `%s': %s."), $omf_file, $!);
return $omf_file;
} # }}}
sub ScrollkeeperStatusChanged() # {{{
{
my $scStatus = Debian::DocBase::DB::GetStatusDB()->GetData("/internal/sc-status");
unless (defined $scStatus)
{
_SaveScrollkeeperStatus();
return 0;
}
my $statusChanged = (($scStatus ? 1 : 0) xor (-x $scrollkeeper_update ? 1 : 0));
Debug(_g("Scrollkeeper status changed: %d."), $statusChanged);
return $SC_NOTCHANGED unless $statusChanged;
return $SC_INSTALLED if -x $scrollkeeper_update;
return $SC_REMOVED;
} # }}}
sub _SaveScrollkeeperStatus() # {{{
{
my $status = (-x $scrollkeeper_update ? 1 : 0);
Debian::DocBase::DB::GetStatusDB()->PutData("/internal/sc-status", $status);
Debug(_g("Scrollkeeper status set to %d."), $status);
} # }}}
1;
|