aboutsummaryrefslogtreecommitdiffstats
path: root/genhdlist2
blob: f4452a3e40762933359a576905b4f3c2fd600b71 (plain)
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
#!/usr/bin/perl

(our $VERSION) = q(Id: genhdlist2 20460 2006-11-23 13:19:11Z pixel ) =~ /(\d+\.\d+)/;

use URPM;
use MDV::Packdrakeng;
use Getopt::Long;
use Encode;

main();

sub usage () {
    require Pod::Usage;
    Pod::Usage::pod2usage({ '-verbose' => 1 });
}

sub main() {
    my %options = (xml_media_info => 'auto');

    GetOptions(
	'clean' => \$options{no_incremental},
	'no-bad-rpm' => \$options{no_bad_rpm},
	'no-md5sum' => \$options{no_md5sum},
	'no-clean-old-rpms' => \$options{no_clean_old_rpms},
	'only-clean-old-rpms' => \$options{only_clean_old_rpms},
	'nolock' => \$options{nolock},
	'allow-empty-media' => \$options{allow_empty_media},
	'file-deps=s' => \$options{file_deps},
	'xml-media-info!' => \$options{xml_media_info},
	'media_info-dir=s' => \$options{media_info_dir},
	'h|help' => sub { usage(); exit 0 },
	'q|quiet' => sub { $options{verbose} = -1 },
	'v|verbose' => sub { $options{verbose}++ },
	'version' => sub { warn "$0 version $VERSION\n"; exit 0 },
    );

    @ARGV == 1 or usage();
    my $rpms_dir = $ARGV[0];

    do_it($rpms_dir, %options);
}

# global vars
my ($no_bad_rpm, $verbose);
my $tmp_header;

sub do_it {
    my ($rpms_dir, %options) = @_;

    $verbose  = $options{verbose};
    $no_bad_rpm = $options{no_bad_rpm};

    my @rpms = grep { /\.rpm$/ } all($rpms_dir);
    @rpms || $options{allow_empty_media} or die "no *.rpm found in $rpms_dir (use --allow-empty-media?)\n";

    my $media_info_dir = $options{media_info_dir} || "$rpms_dir/media_info";
    -e $media_info_dir || mkdir $media_info_dir or die "Can't mkdir $media_info_dir: $!n";
    -d $media_info_dir && -w _ && -x _ or die "$media_info_dir isn't a writable directory, bailing out\n";

    my $synthesis = "$media_info_dir/synthesis.hdlist.cz";
    my $lock_file = "$media_info_dir/UPDATING";
    $tmp_header = "$media_info_dir/.tmp-header";

    my $lock = !$options{nolock} && global_lock($lock_file);

    $SIG{INT} = sub { 
	unlink "$media_info_dir/hdlist.cz.tmp", "$synthesis.tmp", $tmp_header;
	unlink $lock_file if $lock;
	exit 1;
    };
    END { unlink $lock_file if $lock }


    #- handle old-rpms.lst
    my $old_rpms_file = "$media_info_dir/old-rpms.lst";
    my $old_rpms = read_old_rpms_lst($old_rpms_file, $options{nolock});
    if ($old_rpms) {
	filter_out_old_rpms($rpms_dir, $old_rpms, \@rpms);
	if (!$options{no_clean_old_rpms}) {
	    clean_old_rpms($rpms_dir, $old_rpms);
	    write_old_rpms_lst($old_rpms, $old_rpms_file);
	}
    }
    $options{only_clean_old_rpms} and return;


    my %rpms_todo = map { /(.*)\.rpm/ => 1 } @rpms;

    my $urpm = new URPM;

    read_file_deps($urpm, $options{file_deps}) if $options{file_deps};

    if ($options{xml_media_info} eq 'auto') {
	$options{xml_media_info} = -e "$media_info_dir/info.xml.lzma";
    }
    my @xml_media_info = $options{xml_media_info} ? ('info', 'files', 'changelog') : ();

    build_hdlist($urpm, \%rpms_todo, $media_info_dir, $rpms_dir, \@xml_media_info, $options{no_incremental});
    build_synthesis($urpm, "$synthesis.tmp");

    if (1) {
	foreach my $name ('hdlist.cz', map { "$_.xml.lzma" } @xml_media_info) {
	    print "replacing $media_info_dir/$name with $name.tmp\n" if $verbose >= 0;
	    rename "$media_info_dir/$name.tmp", "$media_info_dir/$name" or die "rename $media_info_dir/$name failed: $?\n";
	}
	print "replacing $synthesis with synthesis.hdlist.cz.tmp\n" if $verbose >= 0;
	rename "$synthesis.tmp", $synthesis or die "ERROR: this should not happen: rename $synthesis failed\n";
	generate_md5sum($media_info_dir) if !$options{no_md5sum};
    }
}

sub lock_file {
    my ($file) = @_;
    #- avoid putting a require on Fcntl ':flock' (which is perl and not perl-base).
    my ($LOCK_EX, $LOCK_NB) = (2, 4);

    print "locking $file\n" if $verbose > 0;
    open(my $lock, '>', $file) or die "lock_file $file failed\n";
    flock $lock, $LOCK_EX|$LOCK_NB or return;
    $lock;
}
sub global_lock {
    my ($file) = @_;
    my $lock = lock_file($file) or die "another genhdlist2 already running\n";
    $lock;
}

sub read_file_deps {
    my ($urpm, $file_deps) = @_;

    -r $file_deps or die "can't read $file_deps: $?\n";

    foreach (cat_($file_deps)) {
	chomp;
	$urpm->{provides}{$_} = undef;
    }
}

sub build_hdlist {
    my ($urpm, $rpms_todo, $media_info_dir, $rpms_dir, $xml_media_info, $b_no_incremental) = @_;

    my $hdlist = "$media_info_dir/hdlist.cz";

    my $out_hdlist = MDV::Packdrakeng->new(
	archive => "$hdlist.tmp",
	compress => "gzip",
	uncompress => "gzip -d",
	comp_level => 9,
    ) or die "Can't create archive";

    my $out = {
	hdlist => $out_hdlist,
	map { $_ => open_xml_lzma("$media_info_dir/$_.xml.lzma.tmp") } @$xml_media_info
    };

    if (-e $hdlist && !$b_no_incremental) {
	print "filtering $hdlist into hdlist.cz.tmp\n" if $verbose >= 0;
	filter_existing_hdlist($urpm, $rpms_todo, $hdlist, $out);
    }

    add_new_rpms_to_hdlist($urpm, $rpms_todo, $out, $rpms_dir);

    close_xml($out->{$_}) foreach @$xml_media_info;
}

sub filter_existing_hdlist {
    my ($urpm, $rpms_todo, $in_hdlist, $out) = @_;

    if ($urpm->parse_hdlist($in_hdlist, packing => 1, callback => sub {
	my (undef, $pkg) = @_;
	my $fullname = $pkg->fullname;
	if (delete $rpms_todo->{$fullname}) {
	    print "keeping $fullname\n" if $verbose > 1;
	    add_pkg($out, $pkg);
	    1; # do keep in memory
	} else {
	    print "removing $fullname\n" if $verbose > 0;
	    0; # don't keep in memory
	}
    })) {
	# ok
    } else {
	my $nb = @{$urpm->{depslist}};
	print STDERR "parse_hdlist has failed, keeping $nb headers successfully parsed\n" if $verbose >= 0;
    }
}

sub add_new_rpms_to_hdlist {
    my ($urpm, $rpms_todo, $out, $rpms_dir) = @_;

    my @rpms = keys %$rpms_todo or return;
    if ($verbose >= 0) {
	if (@rpms > 100 || $verbose == 0) {
	    print "adding ", int(@rpms), " new rpms not available in existing hdlist\n";
	} else {
	    print "adding ", join(' ', @rpms), "\n";
	}
    }

    foreach (@rpms) {
	print "adding $_\n" if $verbose > 1;

	my $rpm = "$rpms_dir/$_.rpm";
	my ($id, undef) = $urpm->parse_rpm($rpm);
	if (!defined $id) {
	    if ($no_bad_rpm) {
		print STDERR "bad rpm $rpm\n";
		next;
	    } else {
		die "bad rpm $rpm\n";
	    }
	}
	my $pkg = $urpm->{depslist}[$id];
	add_pkg($out, $pkg);

	$pkg->pack_header; # for synthesis
    }
}

sub open_xml_lzma {
    my ($file) = @_;
    open(my $F, "| lzma -5 > $file") or die "can't open $file\n";
    binmode $F, ':utf8';
    print $F "<media_info>";
    $F;
}

sub close_xml {
    my ($F) = @_;
    print $F "</media_info>\n";
}

sub ensure_utf8 {
    my ($s) = @_;
    
    Encode::_utf8_on($s); #- this is done on the copy
    if (!Encode::is_utf8($s, 1)) {
	Encode::_utf8_off($_[0]);
	Encode::from_to($_[0], 'iso-8859-15', 'utf8');
    }
}

sub encode_xml {
    my ($s) = @_;
    $s =~ s/&/&amp;/g;
    $s =~ s/</&lt;/g;
    $s =~ s/>/&gt;/g;
    ensure_utf8($s);
    $s;
}
sub encode_xml_attribute {
    my ($s) = @_;

    $s = encode_xml($s);

    $s =~ /'/ or return qq('$s');
    $s =~ /"/ or return qq("$s");

    # argh!! hum replacing " with '' :-D
    $s =~ s/"/''/g;
    print STDERR qq(encoding xml attribute: replacing " with '' for $s\n);

    qq("$s");
}

sub add_pkg {
    my ($out, $pkg) = @_;
    my $fullname = $pkg->fullname;

    add_pkg_header($out->{hdlist}, $pkg, $fullname);

    if ($out->{files}) {
	my $F = $out->{files};
	print $F qq(<files fn="$fullname">\n);
	print $F encode_xml($_), "\n" foreach $pkg->files;
	print $F qq(</files>);
    }

    if ($out->{info}) {
	my $F = $out->{info};
	print $F qq(<info fn="$fullname");
	printf $F qq(\n $_=%s), encode_xml_attribute($pkg->$_) foreach qw(sourcerpm url license);
	print $F qq(>\n);
	print $F encode_xml($pkg->description), "\n";
	print $F qq(</info>);
    }

    if ($out->{changelog} && $pkg->changelog_name) {
	my $F = $out->{changelog};
	my @ti = $pkg->changelog_time;
	my @na = $pkg->changelog_name;
	my @te = $pkg->changelog_text;

	print $F qq(<changelogs fn="$fullname">\n);
	foreach (0 .. $#ti) {
	    print $F qq(<log time="$ti[$_]">\n);
	    print $F qq(<log_name>), encode_xml($na[$_]), qq(</log_name>\n);
	    print $F qq(<log_text>), encode_xml($te[$_]), qq(</log_text>\n);
	    print $F qq(</log>);
	}
	print $F qq(</changelogs>);
    }
}

sub add_pkg_header {
    my ($out, $pkg, $fullname) = @_;
    {
	open(my $fh, ">", $tmp_header);
	$pkg->build_header(fileno $fh);
    }
    {
	open(my $fh, "<", $tmp_header);
	$out->add_virtual('f', $fullname, $fh);
    }
    unlink $tmp_header;
}

sub build_synthesis {
    my ($urpm, $synthesis) = @_;
    # for compatibility with perl-URPM < 1.48 (ie < 2007.1),
    # creating empty synthesis by hand. This is only needed to run on old distros
    if (@{$urpm->{depslist}} == 0) {
        open(my $hsynth, "| /bin/gzip > $synthesis");
	close $hsynth or die "Can't create empty synthesis $synthesis: $!\n";
    } else {
	$urpm->build_synthesis(
	    start     => 0,
	    end       => $#{$urpm->{depslist}},
	    synthesis => $synthesis,
	) or die "build_synthesis failed (disk full?)\n";
    }
}

sub generate_md5sum {
    my ($media_info_dir) = @_;
    print "updating $media_info_dir/MD5SUM\n" if $verbose >= 0;
    my $m = `cd '$media_info_dir' ; /usr/bin/md5sum hdlist.cz synthesis.hdlist.cz`;
    unlink "$media_info_dir/MD5SUM"; # ensure no hard link is used
    open(my $f, '>', "$media_info_dir/MD5SUM") or die "Can't write MD5SUM: $!\n";
    print $f $m;
}


################################################################################
sub read_old_rpms_lst {
    my ($file, $nolock) = @_;

    -e $file or return;

    my $lock = !$nolock && lock_file("$file.lock") 
      or $verbose >= 0 && print "lock failed, we simply won't write the modified file\n";

    require Config::IniFiles;
    my $lst = Config::IniFiles->new('-file' => $file) or die "invalid $file\n";
    { lst => $lst, lock => $lock };
}

sub write_old_rpms_lst {
    my ($old_rpms, $file) = @_;

    if ($old_rpms->{lock}) {
	sleep 10;
	$old_rpms->{lst}->WriteConfig($file); # no need to use a temp file + rename since WriteConfig is doing so

	print "unlocking $file.lock\n" if $verbose > 0;
	close(delete $old_rpms->{lock});
	unlink "$file.lock";
    } else {
	# we don't have the lock, so don't write
    }
}

sub clean_old_rpms {
    my ($rpms_dir, $old_rpms) = @_;

    my $lst = $old_rpms->{lst};
    foreach my $pkg ($lst->Parameters('Remove')) {
	my $keep;
	if (-e "$rpms_dir/$pkg") {
	    my $date = $lst->val('Remove', $pkg);
	    if ($date >= time()) {
		$keep = 1;
		print "[OLD-RPMS] keeping $pkg (it is scheduled for " . $lst->GetParameterComment('Remove', $pkg) . "# )\n" if $verbose > 0;
	    } else {
		print "[OLD-RPMS] removing rpm file $pkg (was scheduled for " . $lst->GetParameterComment('Remove', $pkg) . "# )\n" if $verbose >= 0;
		unlink "$rpms_dir/$pkg";
	    }
	} else {
	    print "[OLD-RPMS] $pkg already removed\n" if $verbose >= 0;
	}
	$keep or $old_rpms->{lst}->delval('Remove', $pkg);
    }
}

# 'Remove'

sub clean_old_rpms {
    my ($rpms_dir, $old_rpms) = @_;

    _apply_date_old_rpms($rpms_dir, $old_rpms, 'Remove', 'OLD-RPMS', sub {
	my ($pkg, $date) = @_;
	print "[OLD-RPMS] removing rpm file $pkg (was scheduled for $date)\n" if $verbose >= 0;
	unlink "$rpms_dir/$pkg";
    });
}

sub _apply_date_old_rpms {
    my ($rpms_dir, $old_rpms, $section, $section_tag, $do_it) = @_;

    my $lst = $old_rpms->{lst};
    foreach my $pkg ($lst->Parameters($section)) {
	my $keep;
	if (-e "$rpms_dir/$pkg") {
	    my $date = $lst->val($section, $pkg);
	    if ($date >= time()) {
		$keep = 1;
		print "[$section_tag] keeping $pkg (it is scheduled for " . $lst->GetParameterComment($section, $pkg) . "# )\n" if $verbose > 0;
	    } else {
		$do_it->($pkg, $verbose >= 0 && $lst->GetParameterComment($section, $pkg));
	    }
	} else {
	    print "[$section_tag] $pkg already removed\n" if $verbose >= 0;
	}
	$keep or $old_rpms->{lst}->delval($section, $pkg);
    }
}

sub filter_out_old_rpms {
    my ($rpms_dir, $old_rpms, $rpms_list) = @_;

    _apply_date_old_rpms($rpms_dir, $old_rpms, 'Keep-in-hdlist', 'KEEP-IN-HDLIST', sub {
	my ($pkg, $date) = @_;
	print "[KEEP-IN-HDLIST] removing $pkg from hdlist (was scheduled for $date)\n" if $verbose >= 0;
    });

    my %old = map { $_ => 1 } $old_rpms->{lst}->Parameters('Remove');
    delete $old{$_} foreach $old_rpms->{lst}->Parameters('Keep-in-hdlist');

    @$rpms_list = grep { !$old{$_} } @$rpms_list;
}
################################################################################


sub cat_ { my @l = map { my $F; open($F, '<', $_) ? <$F> : () } @_; wantarray() ? @l : join '', @l }

sub all {
    my $d = shift;

    local *F;
    opendir F, $d or return;
    my @l = grep { $_ ne '.' && $_ ne '..' } readdir F;
    closedir F;

    @l;
}

__END__

=head1 NAME

genhdlist2 - generates an hdlist and a synthesis file

=head1 SYNOPSIS

    genhdlist2 [options] dir

=head1 OPTIONS

=over 4

=item B<--clean>

Do not use existing hdlist.cz, build hdlist from scratch.

=item B<--file-deps>

Use the given file to know which file dependencies are used by other media.
Here is an example of use:

    package foo in medium contrib requires /bin/bar
    package bar in medium main has file /bin/bar

    % echo /bin/bar > media/media_info/file-deps
    % genhdlist2 --file-deps media/media_info/file-deps media/main/release

    without file-deps, media/main/release/media_info/synthesis.hdlist.cz would not provide /bin/bar.

This option is not needed for file-deps inside a same medium.

=item B<--no-md5sum>

Do not generate MD5SUM file.

=item B<--no-bad-rpm>

Do not abort on bad rpms.

=item B<--no-clean-old-rpms>

Take into account old-rpms.lst, but don't remove rpms from repository

=item B<--only-clean-old-rpms>

F<genhdlist2> will only clean old rpms from repository, it will not update
hdlist/synthesis.

=item B<--nolock>

Don't lock the media (can be useful when locks fail, eg NFS). Since the lock
is used to verify no other genhdlist2 process is running on the same media, it
is a dangerous option.

=item B<--allow-empty-media>

By default if no *.rpm files are found, F<genhdlist2> will exit on error.
To allow building empty media, use this option.

=item --media_info-dir directory

Write hdlist/synthesis in this directory instead of <dir>/media_info
(mostly useful for debugging)

=item B<-v>

Be verbose. Use one more B<-v> to get even more verbose.

=item B<--quiet>

Quiet mode.

=back

=head1 DESCRIPTION

F<genhdlist2> is used to generate an hdlist and an associated synthesis file
from a set of RPM packages found in the directory passed on the command-line.
It will put the hdlist and synthesis files in media_info/ sub-directory.

Without B<--clean>, F<genhdlist2> is incremental, ie it will use existing
media_info/hdlist.cz: it will first remove package headers for packages that
are no more in the directory. It will then add new packages. This makes an
important assumption: name-version-release-arch is enough to uniquely
indentify a package. So if foo-1-1 is in hdlist, genhdlist2 will keep it and
not bother verifying if it really is the same package.

Contrary to F<gendistrib>, F<genhdlist2> doesn't have to be work on all media
at once. For this, it assumes no inter media file dependencies are used. If
you still have inter media file dependencies, you can use option
B<--file-deps>.

=head1 SEE ALSO

gendistrib(1), parsehdlist(1)

=head1 COPYRIGHT

Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005 MandrakeSoft SA

Copyright (C) 2005, 2006, 2007 Mandriva SA

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

=cut