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
|
# ABSTRACT: Write records to an 02packages.details.txt file
package Pinto::IndexWriter;
use Moose;
use MooseX::StrictConstructor;
use MooseX::MarkAsMethods ( autoclean => 1 );
use IO::Zlib;
use Module::CoreList;
use Path::Class qw(file);
use HTTP::Date qw(time2str);
use Pinto::Types qw(File);
use Pinto::Util qw(debug throw);
#------------------------------------------------------------------------------
our $VERSION = '0.14'; # VERSION
#------------------------------------------------------------------------------
has stack => (
is => 'ro',
isa => 'Pinto::Schema::Result::Stack',
required => 1,
);
has index_file => (
is => 'ro',
isa => File,
default => sub { $_[0]->stack->modules_dir->file('02packages.details.txt.gz') },
lazy => 1,
);
#------------------------------------------------------------------------------
sub write_index {
my ($self) = @_;
my $index_file = $self->index_file;
my $stack = $self->stack;
debug("Writing index for stack $stack at $index_file");
my $handle = IO::Zlib->new( $index_file->stringify, 'wb' )
or throw "Cannot open $index_file: $!";
my @records = $self->_get_index_records($stack);
my $count = scalar @records;
debug("Index for stack $stack has $count records");
$self->_write_header( $handle, $index_file, $count );
$self->_write_records( $handle, @records );
close $handle;
return $self;
}
#------------------------------------------------------------------------------
sub _write_header {
my ( $self, $fh, $filename, $line_count ) = @_;
my $base = $filename->basename;
my $uri = 'file://' . $filename->absolute->as_foreign('Unix');
my $writer = ref $self;
my $version = $self->VERSION || 'UNKNOWN';
my $date = time2str(time);
print {$fh} <<"END_PACKAGE_HEADER";
File: $base
URL: $uri
Description: Package names found in directory \$CPAN/authors/id/
Columns: package name, version, path
Intended-For: Automated fetch routines, namespace documentation.
Written-By: $writer version $version
Line-Count: $line_count
Last-Updated: $date
END_PACKAGE_HEADER
return $self;
}
#------------------------------------------------------------------------------
sub _write_records {
my ( $self, $fh, @records ) = @_;
for my $record (@records) {
my ( $name, $version, $author, $archive ) = @{$record};
my $path = join '/', substr( $author, 0, 1 ), substr( $author, 0, 2 ), $author, $archive;
my $width = 38 - length $version;
$width = length $name if $width < length $name;
printf {$fh} "%-${width}s %s %s\n", $name, $version, $path;
}
return $self;
}
#------------------------------------------------------------------------------
sub _get_index_records {
my ( $self, $stack ) = @_;
# The index is rewritten after almost every action, so we want
# this to be as fast as possible (especially during an Add or
# Remove action). Therefore, we use a cursor to get raw data and
# skip all the DBIC extras.
# Yes, slurping all the records at once consumes a lot of memory,
# but I want them to be sorted the way perl sorts them, not the
# way sqlite sorts them. That way, the index file looks more
# like one produced by PAUSE. Also, this is about twice as fast
# as using an iterator to read each record lazily.
my @joins = qw(package distribution);
my @selects = qw(package.name package.version distribution.author distribution.archive);
my $attrs = { join => \@joins, select => \@selects };
my $rs = $stack->head->search_related( 'registrations', {}, $attrs );
my %stack_records = map { ($_->[0] => $_) } $rs->cursor->all;
# Now, we merge the stuff from the stack with core modules. If
# the stack has a newer version of a core module (dual-life) then
# it should be the one that appears in the index. Then finally
# we sort them.
my %fake_records = $self->_get_fake_records;
my %merged_records = (%fake_records, %stack_records);
return map { $merged_records{$_} }
sort {lc $a cmp lc $b}
keys %merged_records;
}
#------------------------------------------------------------------------------
sub _get_fake_records {
my ($self) = @_;
# We generate artificial records for all the (non-deprecated) core modules
# that are in the target perl. That way, the index appears to have perl
# itself (just like the real CPAN) and installers can handle requests to
# install a core module.
my $tpv = $self->stack->target_perl_version;
my $tpv_normal = $tpv->normal; $tpv_normal =~ s/^v//;
my @fake = ("FAKE", "perl-$tpv_normal.tar.gz");
my $core_versions = $Module::CoreList::version{$tpv->numify + 0};
my $deprecated_modules = $Module::CoreList::deprecated{$tpv->numify + 0};
my $fake_records = {};
for my $module (keys %{ $core_versions }) {
next if $deprecated_modules && exists $deprecated_modules->{ $module };
$fake_records->{$module} = [$module, $core_versions->{$module} || 0, @fake];
}
return %{ $fake_records };
}
#------------------------------------------------------------------------------
__PACKAGE__->meta->make_immutable;
#------------------------------------------------------------------------------
1;
__END__
=pod
=encoding UTF-8
=for :stopwords Jeffrey Ryan Thalhammer
=head1 NAME
Pinto::IndexWriter - Write records to an 02packages.details.txt file
=head1 VERSION
version 0.14
=head1 AUTHOR
Jeffrey Ryan Thalhammer <jeff@stratopan.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by Jeffrey Ryan Thalhammer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|