/usr/sbin/update-xmlcatalog is in xml-core 0.13+nmu2.
This file is owned by root:root, with mode 0o755.
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 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 | #!/usr/bin/perl
## ----------------------------------------------------------------------
## Debian update-xmlcatalog
## ----------------------------------------------------------------------
## Copyright (c) 2003-2004 Ardo van Rangelrooij
##
## This is free software; see the GNU General Public Licence version 2
## or later for copying conditions. There is NO warranty.
## ----------------------------------------------------------------------
=head1 NAME
update-xmlcatalog - maintain XML catalog files
=head1 SYNOPSIS
B<update-xmlcatalog> B<--add> B<--root> S<B<--package> I<package>>
S<B<--type> I<type>> S<B<--id> I<id>>
B<update-xmlcatalog> B<--del> B<--root> S<B<--package> I<package>>
S<B<--type> I<type>> S<B<--id> I<id>>
B<update-xmlcatalog> B<--add> S<B<--package> I<package>> S<B<--local>
I<local>> S<B<--type> I<type>> S<B<--id> I<id>>
B<update-xmlcatalog> B<--del> S<B<--package> I<package>> S<B<--local>
I<local>> S<B<--type> I<type>> S<B<--id> I<id>>
B<update-xmlcatalog> B<--add> S<B<--local> I<local>> S<B<--file>
I<file>> S<B<--type> I<type>> S<B<--id> I<id>>
B<update-xmlcatalog> B<--del> S<B<--local> I<local>> S<B<--file>
I<file>> S<B<--type> I<type>> S<B<--id> I<id>>
B<update-xmlcatalog> B<--help>
=head1 DESCRIPTION
B<update-xmlcatalog> add entries to and removes entries from the root
XML catalog file, a package XML catalog file or a local XML catalog
file.
=head1 OPTIONS
=over 4
=item B<--add>
Adds the entry to the root XML catalog file, a package XML catalog
file or a local XML catalog file. If the XML catalog file does not
exist yet, it is automatically created.
=item B<--del>
Deletes the entry from the root XML catalog file, the package XML
catalog file or the local XML catalog file. A resulting empty XML
catalog is not automatically deleted from the filesystem.
=item B<--file> I<file>
Indicates a local filename.
=item B<--id> I<id>
Indicates the XML catalog file entry identifier.
=item B<--local> I<local>
Indicates a local XML catalog file.
=item B<--package> I<package>
Indicates a package XML catalog file.
=item B<--root>
Indicates the root XML catalog file.
=item B<--type> I<type>
Indicates the XML catalog file entry type (public, system, uri).
=item B<--help>
Displays the usage information.
=back
=head1 NOTES
B<update-xmlcatalog> is the de-facto standard tool to be used to
maintain XML catalog files on a Debian system, similar to that
L<update-catalog(8)> is the standard tool to be used to main SGML
catalog files on a Debian system. A Debian XML Policy document to
this effect is currently under development.
B<update-xmlcatalog> and L<xmlcatalog(1)> are incompatible. The
former has an internal database of all the entries in all the XML
catalog files it maintains and regenerates the indicated XML catalog
file completely from scratch upon an update. The latter updates the
indicated XML catalog file directly. This means that any change made
to an XML catalog file using L<xmlcatalog(1)> is overwritten the next
time that XML catalog file is updated using B<update-xmlcatalog>.
=head1 SEE ALSO
F</usr/share/doc/xml-core/README.Debian>
=head1 AUTHOR
B<Ardo van Rangelrooij> E<lt>ardo@debian.orgE<gt>
=cut
## ----------------------------------------------------------------------
use strict;
## ----------------------------------------------------------------------
use File::Spec;
use Getopt::Long;
## ----------------------------------------------------------------------
$0 =~ m|[^/]+$|;
## ----------------------------------------------------------------------
my $name = $&;
## ----------------------------------------------------------------------
use vars qw( $catalog_data $catalog_data_dir );
use vars qw( $catalog $catalog_dir );
use vars qw( %catalog $key $entry );
## ----------------------------------------------------------------------
$catalog_data_dir = '/var/lib/xml-core';
$catalog_dir = '/etc/xml';
## ----------------------------------------------------------------------
use vars qw( $add );
use vars qw( $del );
use vars qw( $file );
use vars qw( $help );
use vars qw( $local );
use vars qw( $package );
use vars qw( $root );
use vars qw( $type $id );
use vars qw( $verbose );
## ----------------------------------------------------------------------
if ( ! GetOptions(
'add' => \$add,
'del' => \$del,
'file=s' => \$file,
'help' => \$help,
'id=s' => \$id,
'local=s' => \$local,
'package=s' => \$package,
'root' => \$root,
'type=s' => \$type,
'verbose' => \$verbose,
)
)
{
&help;
exit 1;
}
## ----------------------------------------------------------------------
if ( defined( $help ) )
{
&help;
exit -1;
}
## ----------------------------------------------------------------------
if ( ! ( defined( $add ) || defined( $del ) ) )
{
print STDERR "$name: error: either 'add' or 'del' must be given\n";
exit 1;
}
elsif ( ( defined( $add ) && defined( $del ) ) )
{
print STDERR "$name: error: only one of 'add' and 'del' can be given\n";
exit 1;
}
## ----------------------------------------------------------------------
if ( defined( $add ) )
{
if ( defined( $root ) )
{
if ( defined( $package ) )
{
my $catalog = File::Spec->catfile( $catalog_dir, "$package.xml" );
if ( ! -f $catalog )
{
print STDERR "$name: error: package catalog $catalog not found\n";
exit 1;
}
}
else
{
print STDERR "$name: error: package catalog not given\n";
exit 1;
}
if ( defined( $local) || defined( $file ) )
{
print STDERR "$name: error: local catalog and file not for adding to root catalog file\n";
exit 1;
}
}
elsif ( defined( $package ) )
{
if ( defined( $local ) )
{
if ( ! -f $local )
{
print STDERR "$name: error: local catalog $local not found\n";
exit 1;
}
}
else
{
print STDERR "$name: error: local catalog not given\n";
exit 1;
}
if ( defined( $file ) )
{
print STDERR "$name: error: file not for adding to package catalog file\n";
exit 1;
}
}
elsif ( defined( $local ) )
{
if ( defined( $file ) )
{
if ( ! -f $file )
{
print STDERR "$name: error: file $file not found\n";
exit 1;
}
}
else
{
print STDERR "$name: error: file not given\n";
exit 1;
}
}
else
{
print STDERR "$name: error: catalog not given\n";
exit 1;
}
}
elsif ( defined( $del ) )
{
if ( defined( $root ) )
{
my $catalog = File::Spec->catfile( $catalog_dir, 'catalog' );
if ( ! -f $catalog )
{
print STDERR "$name: error: root catalog $catalog not found\n";
exit 1;
}
if ( defined( $package) || defined( $local ) || defined( $file ) )
{
print STDERR "$name: error: package catalog, local catalog or file not for deleting from root catalog file\n";
exit 1;
}
}
elsif ( defined( $package ) )
{
my $catalog = File::Spec->catfile( $catalog_dir, "$package.xml" );
if ( ! -f $catalog )
{
print STDERR "$name: error: package catalog $catalog not found\n";
exit 1;
}
if ( defined( $local ) || defined( $file ) )
{
print STDERR "$name: error: local catalog or file not for deleting from package catalog file\n";
exit 1;
}
}
elsif ( defined( $local ) )
{
if ( ! -f $local )
{
print STDERR "$name: error: local catalog $local not found\n";
exit 1;
}
if ( defined( $file ) )
{
print STDERR "$name: error: file not for deleting from local catalog file\n";
exit 1;
}
}
else
{
print STDERR "$name: error: catalog not given\n";
exit 1;
}
}
## ----------------------------------------------------------------------
if ( defined( $type ) )
{
if ( $type !~ /^(public|system|uri)$/ )
{
print STDERR "$name: error: wrong type\n";
exit 1;
}
}
else
{
print STDERR "$name: error: type not given\n";
exit 1;
}
## ----------------------------------------------------------------------
if ( ! defined( $id ) )
{
print STDERR "$name: error: id not given\n";
exit 1;
}
## ----------------------------------------------------------------------
if ( defined( $root ) )
{
$catalog = 'catalog';
$catalog_data = File::Spec->catfile( $catalog_data_dir, $catalog );
$catalog = File::Spec->catfile( $catalog_dir, $catalog );
my $start = $type;
$start .= 'Id' unless $type eq 'uri';
$start .= 'StartString';
$id = "$start=\"$id\"";
$type = ( $type eq 'uri' ) ? "\U$type" : "\u$type";
$type = "delegate$type";
$package = "catalog=\"file:///etc/xml/$package.xml\"";
$key = "$type $id";
$entry = "$package";
}
elsif ( defined( $package ) )
{
$catalog_data = File::Spec->catfile( $catalog_data_dir, $package );
$catalog = File::Spec->catfile( $catalog_dir, "$package.xml" );
my $start = $type;
$start .= 'Id' unless $type eq 'uri';
$start .= 'StartString';
$id = "$start=\"$id\"";
$type = ( $type eq 'uri' ) ? "\U$type" : "\u$type";
$type = "delegate$type";
$local = "catalog=\"file://$local\"";
$key = "$type $id";
$entry = "$local";
}
elsif ( defined( $local ) )
{
$catalog = $local;
$catalog_data = $local;
$catalog_data =~ tr|/|_|;
$catalog_data = File::Spec->catfile( $catalog_data_dir, $catalog_data );
my $start = ( $type eq 'uri' ) ? 'name' : $type;
$start .= 'Id' unless $type eq 'uri';
$id = "$start=\"$id\"";
$file = "uri=\"$file\"";
$key = "$type $id";
$entry = "$file";
}
## ----------------------------------------------------------------------
if ( defined( $add ) )
{
&read_catalog_data if -f $catalog_data;
if ( &add_entry )
{
&create_backup if -f $catalog;
&write_catalog_data;
&write_catalog;
}
else
{
exit 1;
}
}
elsif ( defined( $del ) )
{
&read_catalog_data;
if ( &del_entry )
{
&create_backup;
&write_catalog_data;
&write_catalog;
}
else
{
exit 1;
}
}
## ----------------------------------------------------------------------
exit 0;
## ----------------------------------------------------------------------
sub add_entry
{
## ------------------------------------------------------------------
if ( exists( $catalog{ $key } ) )
{
if ( $catalog{ $key } ne $entry )
{
print STDERR "$name: error: entity already registered with a different value\n";
print STDERR " Entity : [$key]\n";
print STDERR " Old value: [$catalog{$key}]\n";
print STDERR " New value: [$entry]\n";
return;
}
else
{
print STDERR "$name: notice: entity already registered\n"
if $verbose;
return 1;
}
}
else
{
print "$name: adding entity to catalog data $catalog_data with the same value\n"
if $verbose;
$catalog{ $key } = $entry;
return 1;
}
} ## add_entry
## ----------------------------------------------------------------------
sub del_entry
{
## ------------------------------------------------------------------
if ( exists( $catalog{ $key } ) )
{
print "$name: removing entity from catalog data $catalog_data\n"
if $verbose;
delete( $catalog{ $key } );
return 1;
}
else
{
print STDERR "$name: error: entity not registered\n";
return;
}
} ## del_entry
## ----------------------------------------------------------------------
sub read_catalog_data
{
## ------------------------------------------------------------------
print "$name: reading catalog data $catalog_data\n" if $verbose;
open( CATALOG_DATA, '<', $catalog_data )
or die "$name: cannot open catalog data $catalog_data for reading: $!";
while ( <CATALOG_DATA> )
{
chop;
my ( $key, $entry ) = split( />/ );
$key =~ s/^<//;
$entry =~ s/^<//;
$catalog{ $key } = $entry;
}
close( CATALOG_DATA )
or die "$name: cannot close catalog data $catalog_data: $!";
} ## read_catalog_data
## ----------------------------------------------------------------------
sub write_catalog_data
{
## ------------------------------------------------------------------
print "$name: writing catalog data $catalog_data\n" if $verbose;
open( CATALOG_DATA, '>', $catalog_data )
or die "$name: cannot open catalog data $catalog_data for writing: $!";
my $counter = 0;
for my $key ( keys %catalog )
{
print( CATALOG_DATA "<$key><$catalog{ $key }>\n" );
$counter++;
}
close( CATALOG_DATA )
or die "$name: cannot close catalog data $catalog_data: $!";
## ------------------------------------------------------------------
if ( $counter == 0 )
{
print "$name: removing catalog data $catalog_data\n" if $verbose;
unlink( $catalog_data );
}
} ## write_catalog_data
## ----------------------------------------------------------------------
sub create_backup
{
## ------------------------------------------------------------------
my $backup = $catalog . '.old';
## ------------------------------------------------------------------
if ( -f $backup )
{
print "$name: removing backup $backup\n" if $verbose;
unlink( $backup )
or die "$name: cannot remove backup $backup: $!";
}
## ------------------------------------------------------------------
print "$name: moving catalog $catalog to backup $backup\n" if $verbose;
rename( $catalog, $backup )
or die "$name: cannot move catalog $catalog to backup $backup: $!";
} ## create_backup
## ----------------------------------------------------------------------
sub write_catalog
{
## ------------------------------------------------------------------
my @catalog = ();
## ------------------------------------------------------------------
my $header = '/usr/share/xml-core/catalog.header';
open( HEADER, '<', $header )
or die "$name: cannot open catalog header $header for reading: $!";
while ( <HEADER> )
{
chop;
push( @catalog, $_ );
}
close( HEADER )
or die "$name: cannot close catalog header $header: $!";
## ------------------------------------------------------------------
my $counter = 0;
for my $key ( keys %catalog )
{
push( @catalog, "<$key $catalog{ $key }/>" );
$counter++;
}
## ------------------------------------------------------------------
my $footer = '/usr/share/xml-core/catalog.footer';
open( FOOTER, '<', $footer )
or die "$name: cannot open catalog footer $footer for reading: $!";
while ( <FOOTER> )
{
chop;
push( @catalog, $_ );
}
close( FOOTER )
or die "$name: cannot close catalog footer $footer: $!";
## ------------------------------------------------------------------
print "$name: writing catalog $catalog\n" if $verbose;
open( CATALOG, '>', $catalog )
or die "$name: cannot open catalog $catalog for writing: $!";
for ( @catalog )
{
print( CATALOG $_, "\n" );
}
close( CATALOG )
or die "$name: cannot close catalog $catalog: $!";
## ------------------------------------------------------------------
if ( $counter == 0 )
{
print "$name: removing catalog $catalog\n" if $verbose;
unlink( $catalog );
}
} ## write_catalog
## ----------------------------------------------------------------------
sub help
{
## ------------------------------------------------------------------
print <<END;
Usage:
$name <options> --add --root --type <type> \\
--id <id> --package <package>
$name <options> --del --root --type <type> \\
--id <id>
$name <options> --add --package <package> --type <type> \\
--id <id> --local <local>
$name <options> --del --package <package> --type <type> \\
--id <id>
$name <options> --add --local <local> --type <type> \\
--id <id> --file <file>
$name <options> --del --local <local> --type <type> \\
--id <id>
$name --help
With:
--file <file> = a local filename
--id <id> = catalog entry idenitifier
--local <local> = a local XML catalog
--package <package> = a package XML catalog
--root = the root XML catalog (= /etc/xml/catalog)
--type <type> = catalog entry type (= public, system, uri)
Options:
--verbose = be verbose
END
} ## help
## ----------------------------------------------------------------------
__END__
## ----------------------------------------------------------------------
|