summaryrefslogtreecommitdiff
path: root/Master/tlpkg/bin/tl-update-tlpdb
blob: fd69fdc942ec1bdb403948cdd3ac9934556cee37 (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
#!/usr/bin/env perl
# $Id$
# convert a set of tlpsrc files (given as arguments) into tlpdb
# 
# Copyright 2007, 2008, 2009 Norbert Preining
# This file is licensed under the GNU General Public License version 2
# or any later version.

BEGIN {
  $^W = 1;
  chomp ($mydir = `dirname $0`);
  unshift (@INC, "$mydir/..");
}

use strict;

use TeXLive::TLConfig;
use TeXLive::TLPSRC;
use TeXLive::TLPOBJ;
use TeXLive::TLPDB;
use TeXLive::TLTREE;
use TeXLive::TLUtils;
use Getopt::Long;
use Pod::Usage;
use File::Path;

my $opt_catalogue = "";
chomp (my $opt_master = `cd $::mydir/../.. && pwd`);
my $help = 0;
my $opt_nobinsplit = 0;
my $opt_winwarning;
my $opt_fromfiles = 0;
my $opt_noautopatterns = 0;
my $opt_norevisioncheck = 0;
my $opt_tlpsrc_from_cmdline = 0;
my $opt_output;

TeXLive::TLUtils::process_logging_options();
GetOptions(
    "master=s" => \$opt_master,	# location of the TL tree
    "catalogue=s" => \$opt_catalogue, # location of the TeX Catalogue
    "no-bin-split!" => \$opt_nobinsplit,
    "no-autopatterns" => \$opt_noautopatterns,
    "no-revision-check" => \$opt_norevisioncheck,
    "from-files" => \$opt_fromfiles,
    "tlpsrc-from-cmdline" => \$opt_tlpsrc_from_cmdline,
    "with-win-pattern-warning" => \$opt_winwarning,
    "output=s" => \$opt_output,
    "help|?" => \$help) or pod2usage(1);
pod2usage(-exitstatus => 0, -verbose => 2) if $help;

exit (&main ());






sub finish
{
  my ($tlpdb, $pkgcount) = @_;
  if ($opt_output) {
    if (open(OUT, ">$opt_output")) {
      $tlpdb->writeout(\*OUT);
      info ("$0: wrote $pkgcount packages to $opt_output.\n");
    } else {
      warn ("Cannot open $opt_output for writing");
      exit 1;
    }
  } else {
    $tlpdb->save;
    info ("$0: wrote $pkgcount packages to ". $tlpdb->root . ".\n");
  }
  exit(0);
}

sub main
{
  if (! -d $opt_master) {
    die "$0: Master $opt_master not a directory, goodbye.\n";
  }
  my $tlc = undef;
  if (! -d $opt_catalogue) {
    info ("$0: -c /Cat/a/logue not given, continuing without it.\n");
  } else {
    require TeXLive::TeXCatalogue;  # not at compile time, for now anyway.
    info ("$0: reading TeX Catalogue $opt_catalogue ...\n");
    $tlc = TeXLive::TeXCatalogue->new ("location" => $opt_catalogue);
  }

  my $oldtlpdb = TeXLive::TLPDB->new ("root" => $opt_master);
  my ($newtlpdb, $pkgcount) = create_tlpdb($tlc);
  if (!defined($oldtlpdb)) {
    info("No checking on increasing revisions, no old tlpdb found\n");
    finish($newtlpdb, $pkgcount);
  }
  if ($opt_norevisioncheck) {
    info("No checking on increasing revisions due to --no-revision-check\n");
    finish($newtlpdb, $pkgcount);
  }
  if (compare_tlpdbs($oldtlpdb, $newtlpdb)) {
    # compare_tlpdbs checks in dummy changes to the tlpsrc files
    # now we check again and that should not give any changes!
    ($newtlpdb, $pkgcount) = create_tlpdb($tlc);
    if (compare_tlpdbs($oldtlpdb, $newtlpdb)) {
      tlwarn("$0: That should not happen, after one iteration of compare_tlpdbs\nthe newly created tlpdb is still going backwards in time.\nPlease check output above!\n");
      exit(1);
    }
  }
  # new $newtlpdb points to the right one
  finish ($newtlpdb, $pkgcount);
}

sub compare_tlpdbs {
  my ($oldtlpdb, $newtlpdb) = @_;
  #
  # check that revisions are actually going forward
  my $recheck = 0;
  for my $p ($newtlpdb->list_packages) {
    my $newrev = $newtlpdb->get_package($p)->revision;
    my $oldtlp = $oldtlpdb->get_package($p);
    if (defined($oldtlp)) {
      my $oldrev = $oldtlp->revision;
      if ($oldrev > $newrev) {
        # that is the bad case
        $recheck = 1;
        # here we should do a change to
        #   $opt_master/tlpkg/tlpsrc/$p.tlpsrc
        # and commit it!
        tlwarn("$0: revision going backwards in $p!\n");
      }
    }
  }
  return($recheck);
}

  

sub create_tlpdb
{
  my $tlc = shift;
  if (defined($opt_winwarning)) {
    $::tlpsrc_pattern_warn_win = 1;
  }
  my $tlpsrc_dir = "$opt_master/tlpkg/tlpsrc";

  if (!$opt_tlpsrc_from_cmdline) {
    # if not otherwise given use all tlpsrc files

    # if we're regenerating the whole thing, get all our tlpsrc files.
    chdir ($tlpsrc_dir) || die "chdir($tlpsrc_dir) failed: $!";
    @ARGV = glob ("*.tlpsrc");
  }
  
  info ("$0: reading Master $opt_master ...\n");
  my $tltree = TeXLive::TLTREE->new ("svnroot" => $opt_master);
  if ($opt_fromfiles) {
    $tltree->init_from_files;
  } else {
    $tltree->init_from_svn;
  }

  info ("$0: updating from tlpsrc ...\n");
  my $tldb = TeXLive::TLPDB->new;
  my $src_count = 0;
  foreach my $f (@ARGV) {
    next if ($f =~ m/^00texlive\.autopatterns/);
    $src_count++;

    my $tlsrc = new TeXLive::TLPSRC;
    $tlsrc->from_file ($f);
    my $tlp = $tlsrc->make_tlpobj ($tltree, $opt_master);

    (my $base_f = $f) =~ s/\.tlpsrc$//;
    warn "$f: package name " . $tlp->name . " does not match filename\n"
      if $tlp->name ne $base_f;
      
    if ($tlc) {
      # merge TeX Catalogue information
      $tlp->update_from_catalogue ($tlc);
    }
   
    # split bin packages off unless requested otherwise (no reason to so
    # request these days).
    unless ($opt_nobinsplit) {
      # packages which have already a .win32 extension or the 
      # 00texlive.something package are NOT split, never!
      if ($tlp->name !~ m/\.win32/
          && $tlp->name !~ m/^00texlive/) {
        my @binobjs = $tlp->split_bin_package;
        foreach my $binobj (@binobjs) {
          # we recompute the revision numbers of the binary packages
          # since that might be much smaller, and we don't want to 
          # update every package only because one binary for one arch
          # was changed
          $binobj->recompute_revision ($tltree, $tltree->file_svn_lastrevision("tlpkg/tlpsrc/$f"));
          $tldb->add_tlpobj ($binobj);
        }
        # we have to recompute the revision of the package itself 
        # since the binfiles have been removed and that might lower the
        # revision number
        $tlp->recompute_revision ($tltree, $tltree->file_svn_lastrevision("tlpkg/tlpsrc/$f"));
      }
    }
    if ($tlp->name eq "00texlive.config") {
      my @bar = $tlp->depends;
      for my $k (keys %TeXLive::TLConfig::TLPDBConfigs) {
        push @bar, "$k/" . $TeXLive::TLConfig::TLPDBConfigs{$k};
      }
      # add the latest revision
      push @bar, "revision/".$tltree->revision;
      $tlp->depends (@bar);
    }
    $tldb->add_tlpobj ($tlp);
  }
  $tldb->root ($opt_master);
  # do set the option_archs from the dirs in Master/bin
  my @archs = $tltree->architectures;
  $tldb->setting("available_architectures", @archs);

  # reset options to what we have by default
  $tldb->add_default_options();

  return($tldb, $src_count);
}

__END__

=head1 NAME

tl-update-tlpdb - generate/update a TeX Live database from tlpsrc files

=head1 SYNOPSIS

tl-update-tlpdb [OPTION]... [TLPSRC]...

=head1 OPTIONS

=over 4

=item B<-catalogue> I<Catalogue_dir>
The location given by B<-catalogue> must point to a valid TeX Catalogue.
No default value.  If given, the generated tlpobj files will contain
information gathered from the TeX Catalogue.

=item B<-master> I<Master/dir>
The location I<Master/dir> must point to a valid svn repository of TeX
Live's Master directory.  Defaults to C<../..> of C<$0>.

=item B<-no-bin-split>
Do NOT split files with binaries into several packages (one for the arch
independent and one for each of the architectures with only the respective
binaries).  There is no reason to use this option.

=item B<-tlpsrc-from-cmdline>

by default, B<tl-update-tlpdb> recreates the tlpdb from all the tlpsrc
files present in the current tree. If this option is given the tlpsrc
have to be given on the command line.

=item B<-output=filename>

by default, B<tl-update-tlpdb> saves/updates the tlpdb in the default
place. This option specifies the place where the output should go to.

=item B<-with-win-pattern-warning>
Normally, this program issues a warning for all patterns without a matching
file, but does I<not> warn for binpatterns when working on the win32 
architecture. Giving this option makes it issues all warnings, i.e., also
those where a binpattern on win32 does not hit.

=item B<-from-files>
Use find instead of svn -status to create the list of files.

=item B<-no-revision-check>
By default, B<tl-update-tlpdb> checks that in the generated tlpdb the
revision numbers of packages are not going backward compared to the
previous version. This option disables this check.

=back

The standard options B<-q>, B<-v>, and B<-logfile>=I<file> are also
accepted; see the C<process_logging_options> function in
L<TeXLive::TLUtils> for details.

=head1 DESCRIPTION

B<tl-update-tlpdb> converts TeX Live source package files (tlpsrc) files 
into a TeX Live package database (tlpdb).

In addition if at the same location there is already a TLPDB, it compares
the revision number of packages and checks if a package is going back
in time (i.e., having a smaller revision number in the new tlpdb). In
this case it commits a dummy change to the package's tlpsrc file to make
sure that revisions are always increasing.

If a TeX Catalogue hierarchy is specified, additional information from
the catalogue are merged into the database (see L<TeXLive::TLPOBJ> for
the list of included information from the TeX Catalogue).

=head1 AUTHORS AND COPYRIGHT

This script and its documentation were written for the TeX Live
distribution (L<http://tug.org/texlive>) and both are licensed under the
GNU General Public License Version 2 or later.

=cut

### Local Variables:
### perl-indent-level: 2
### tab-width: 2
### indent-tabs-mode: nil
### End:
# vim:set tabstop=2 expandtab: #