summaryrefslogtreecommitdiff
path: root/Master/tlpkg/TeXLive/TLPDB.pm
blob: a20bf491ba7e660e9a1563132ed69f6b1f8cf2a2 (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
# $Id$
# TeXLive::TLPDB.pm - module for using tlpdb files
# Copyright 2007 Norbert Preining
#
# This file is licensed under the GNU General Public License version 2
# or any later version.

package TeXLive::TLPDB;

=pod
=head1 NAME

TeXLive::TLPDB - a database of TeX Live Packages

=head1 SYNOPSIS

  use TeXLive::TLPDB;

  TeXLive::TLPDB->listdir([$dir]);
  TeXLive::TLPDB->new ( [ location => "path/to/tlpdb/file" ] );

  $tlpdb->location([$location]);
  $tlpdb->from_file($filename);
  $tlpdb->writeout([FILEHANDLE]);
  $tlpdb->save;
  $tlpdb->generate_listfiles([$destdir]);
  $tlpdb->add_objpkg($tlpobj);
  $tlpdb->get_package("packagename");
  $tlpdb->list_packages;
  $tlpdb->package_revision("packagename");

=head1 DESCRIPTION

=cut

use TeXLive::TLUtils;
use TeXLive::TLPOBJ;

my $_listdir;

=pod

C<TeXLive::TLPDB->new> creates a new C<TLPDB> object. If the argument 
location is given it will be initialized from this locations.

=cut

sub new { 
  my $class = shift;
  my %params = @_;
  my $self = {
    location => $params{'location'},
    tlps => $params{'tlps'}
  };
  $_listdir = $params{'listdir'} if defined($params{'listdir'});
  bless $self, $class;
  if (defined($self->{'location'})) {
    $self->from_file($self->{'location'});
  }
  return $self;
}

=pod

The C<add_tlpobj> adds an object of the type TLPOBJ to the TLPDB.

=cut
sub add_tlpobj {
  my ($self,$tlp) = @_;
  $self->{'tlps'}{$tlp->name} = $tlp;
}

=pod

The C<from_file> function initializes the C<TLPDB> in case the location
was not given at generation time.

=cut
sub from_file {
  my $self = shift;
  if (@_ != 1) {
    die("Need a filename for initialization!");
  }
  if (defined($self->{'location'})) {
    if ($self->location ne $_[0]) {
      printf STDERR "Initialisation from different location as originally given.\nHope you are sure!\n";
    }
  }
  $self->location($_[0]);
  open(TMP,"<$_[0]") || die("Cannot open tlpdb file: $_[0]");
  my $found = 0;
  do {
    my $tlp = TeXLive::TLPOBJ->new;
    &TeXLive::TLUtils::debug("creating tlp ...\n");
    $found = $tlp->from_fh(\*TMP,1);
    if ($found) {
      $self->add_tlpobj($tlp);
    }
  } until (!$found);
}

=pod

The C<writeout> function writes the whole TLPDB to STDOUT, or to the file
handle given as argument.

=cut
sub writeout {
  my $self = shift;
  my $fd = (@_ ? $_[0] : STDOUT);
  foreach (sort keys %{$self->{'tlps'}}) {
    &TeXLive::TLUtils::debug("tlpname = $_\n");
    &TeXLive::TLUtils::debug("foo: " . $self->{'tlps'}{$_}->name . "\n");
    $self->{'tlps'}{$_}->writeout($fd);
    print $fd "\n";
  }
}

=pod

The C<save> functions saves the TLPDB to the file which has been set
as location. If the location is undefined, die.

=cut
sub save {
  my $self = shift;
  open(FOO,">$self->{'location'}") || die("Cannot open $self->{'location'} for writing: $!");
  $self->writeout(\*FOO);
  close(FOO);
}

=pod

The C<get_package> function returns a reference to an TLPOBJ object in case
its name the the argument name coincide.

=cut
sub get_package {
  my ($self,$pkg) = @_;
  if (defined($self->{'tlps'}{$pkg})) {
    return($self->{'tlps'}{$pkg});
  } else {
    return(undef);
  }
}

=pod

The C<list_packages> function returns the list of all included packages.

=cut
sub list_packages {
  my $self = shift;
  return (sort keys %{$self->{'tlps'}});
}

=pod

The C<package_revision> function returns the the revision of the
package named in the first argument.

=cut
sub package_revision {
  my ($self,$pkg) = @_;
  if (defined($self->{'tlps'}{$pkg})) {
    return($self->{'tlps'}{$pkg}->revision);
  } else {
    return(undef);
  }
}

=pod

The C<generate_packagelist> lists all available TL Packages together
with their revisions.

=cut
sub generate_packagelist {
  my $self = shift;
  my $fd = (@_ ? $_[0] : STDOUT);
  foreach (sort keys %{$self->{'tlps'}}) {
    print $fd $self->{'tlps'}{$_}->name, " ", $self->{'tlps'}{$_}->revision, "\n";
  }
}

=pod

The C<generate_listfiles> generates the list files for the old 
installers. This function will probably go away.

=cut
sub generate_listfiles {
  my ($self,$destdir) = @_;
  if (not(defined($destdir))) {
    $destdir = TeXLive::TLPDB->listdir;
  }
  foreach (sort keys %{$self->{'tlps'}}) {
    $tlp = $self->{'tlps'}{$_};
    $self->_generate_listfile($tlp, $destdir, "all");
    if ($tlp->is_arch_dependent) {
      foreach my $a (keys %{$tlp->binfiles}) {
        $self->_generate_listfile($tlp, $destdir, $a);
      }
    }
  }
}

sub _generate_listfile {
  my ($self,$tlp,$destdir,$arch) = @_;
  my @files = ();
  my $listname;
  if ($arch ne "all") {
    my %foo = %{$tlp->binfiles};
    push @files, @{$foo{$arch}};
    $listname = $tlp->name . ".$arch";
  } else {
    $listname = $tlp->name;
    push @files, $tlp->runfiles;
    push @files, $tlp->docfiles;
    push @files, $tlp->srcfiles;
  }
  @files = TeXLive::TLUtils::sort_uniq(@files);
  &mkpath("$destdir") if (! -d "$destdir");
  my (@lop, @lot);
  foreach my $d ($tlp->depends) {
    if ($d =~ m/^(Package|Documentation|TLCore)\/(.*)$/) {
      push @lop, $2;
    } elsif ($d =~ m/^Collection\/(.*)$/) {
      push @lot, $1;
    } else {
      warn "strange depends line: $d\n";
    }
  }
  open(TMP, ">$destdir/$listname") or die "Cannot open $destdir/$listname!";
  # title and size information for collections and schemes in the
  # first two lines, marked with *
	if ($tlp->category eq "Collection") {
    print TMP "*Title: ", $tlp->shortdesc, "\n";
    # collections references Packages, we have to collect the sizes of
    # all the Package-tlps included
    # What is unclear for me is HOW the size is computed for bin-*
    # packages. The collection-basicbin contains quite a lot of
    # bin-files, but the sizes for the different archs differ.
    # I guess we have to take the maximum?
    my $s = 0;
    foreach my $p (@lop) {
      my $subtlp = $self->get_package($p);
      if (!defined($subtlp)) {
        warn "Strange: $listname references $p, but it is not in tlpdb";
      }
      $s += $subtlp->total_size;
    }
    # in case the collection itself ships files ...
    $s += $tlp->runsize + $tlp->srcsize + $tlp->docsize;
    print TMP "*Size: $s\n";
  } elsif ($tlp->category eq "Scheme") {
    print TMP "*Title: ", $tlp->shortdesc, "\n";
    my $s = 0;
    # schemes size includes ONLY those packages which are directly
    # included and direclty included files, not the size of the
    # included collections. But if a package is included in one of
    # the called for collections AND listed directly, we don't want
    # to count its size two times
    my (@inccol,@incpkg,@collpkg);
    # first we add all the packages tlps that are directly included
    @incpkg = @lop;
    # now we select all collections, and for all collections we
    # again select all packages of type Documentation and Package
    foreach my $c (@lot) {
      my $coll = $self->get_package($c);
      foreach my $d ($coll->depends) {
        if ($d =~ m/^(Package|Documentation|TLCore)\/(.*)$/) {
          TeXLive::TLUtils::push_uniq(\@collpkg,$2);
        }
      }
    }
    # finally go through all packages and add the ->total_size
    foreach my $p (@incpkg) {
      if (!TeXLive::TLUtils::member($p,@collpkg)) {
        $s += $self->get_package($p)->total_size;
      }
    } 
    $s += $tlp->runsize + $tlp->srcsize + $tlp->docsize;
    print TMP "*Size: $s\n";
  }
  # dependencies and inclusion of packages
  foreach my $t (@lot) {
    # strange, schemes mark included collections via -, while collections
    # themself mark deps on other collections with +. collection are
    # never referenced in Packages
    if ($listname =~ m/^scheme/) {
      print TMP "-";
    } else {
      print TMP "+";
    }
    print TMP "$t\n";
  }
  foreach my $t (@lop) { print TMP "+$t\n"; }
  # included files
  foreach my $f (@files) { print TMP "$f\n"; }
  # also print the listfile itself
  print TMP "$destdir/$listname\n";
  # execute statements
  foreach my $e ($tlp->executes) {
    print TMP "!$e\n";
  }
  # finish
  close(TMP);
}

=pod

The function C<location> allows to read and set the location of the
text file of the TeX Live Database.

=cut
sub location {
  my $self = shift;
  if (@_) { $self->{'location'} = shift }
  return $self->{'location'};
}

=pod

The function C<listdir> allows to read and set the packages variable
specifiying where generated list files are created.

=cut
sub listdir {
  my @self = shift;
  if (@_) { $_listdir = $_[0] }
  return $_listdir;
}


=pod

=head1 SEE ALSO

The modules L<TeXLive::TLPSRC>, L<TeXLive::TLPOBJ>, 
L<TeXLive::TLTREE>, L<TeXLive::TLUtils> and the
document L<Perl-API.txt> and the specification in the TeX Live
repository trunk/Master/tlpkg/doc/.

=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

1;

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