/
Arch.pm
1060 lines (854 loc) · 32.7 KB
/
Arch.pm
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
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package CPANPLUS::Dist::Arch;
use warnings;
use strict;
use base qw(CPANPLUS::Dist::Base Exporter);
use File::Spec::Functions qw(catfile catdir);
use Module::CoreList qw();
use CPANPLUS::Error qw(error msg);
use Digest::MD5 qw();
use Pod::Select qw();
use File::Path qw(mkpath);
use File::Copy qw(copy);
use File::stat qw(stat);
use DynaLoader qw();
use IPC::Cmd qw(can_run);
use version qw(qv);
use English qw(-no_match_vars);
use Carp qw(carp croak);
use Cwd qw();
our $VERSION = '0.12';
our @EXPORT = qw();
our @EXPORT_OK = qw(dist_pkgname dist_pkgver);
our @EXPORT_TAGS = ( ':all' => \@EXPORT_OK );
#----------------------------------------------------------------------
# CLASS CONSTANTS
#----------------------------------------------------------------------
my $MKPKGCONF_FQP = '/etc/makepkg.conf';
my $CPANURL = 'http://search.cpan.org';
my $ROOT_USER_ID = 0;
my $CFG_VALUE_MATCH = '\A \s* (%s) \s* = \s* (.*?) \s* (?: \#.* )? \z';
my $NONROOT_WARNING = <<'END_MSG';
In order to install packages as a non-root user (highly recommended)
you must have a sudo-like command specified in your CPANPLUS
configuration.
END_MSG
# Patterns to use when using pacman for finding library owners.
my $PACMAN_FINDOWN = qr/\A[^ ]+ is owned by ([\w-]+) ([\w.-]+)/;
my $PACMAN_FINDOWN_ERR = qr/\Aerror:/;
# Override a package's name to conform to packaging guidelines.
# Copied entries from CPANPLUS::Dist::Pacman and alot more
# from searching for packages with perl in their name in
# [extra] and [community]
my $PKGNAME_OVERRIDES =
{ map { split /[\s=]+/ } split /\s*\n+\s*/, <<'END_OVERRIDES' };
libwww-perl = perl-libwww
glade-perl-two = perl-glade-two
aceperl = perl-ace
Gnome2-GConf = gconf-perl
Gtk2-GladeXML = glade-perl
Glib = glib-perl
Gnome2 = gnome-perl
Gnome2-VFS = gnome-vfs-perl
Gnome2-Canvas = gnomecanvas-perl
Gtk2 = gtk2-perl
XML-LibXML = libxml-perl
mod_perl = mod_perl
Pango = pango-perl
XML-Parser = perlxml0
SDL_Perl = sdl_perl
shorewall-perl = shorewall-perl
END_OVERRIDES
=for Mini-Template Format
The template format is very simple, to insert a template variable
use [% foo %]. This will insert the value of the variable
named 'foo'.
The print_template() sub will throw: 'Template variable ... was
not provided' if the variable was not defined.
[% IF var_name %] ... [% FI %] will remove the ... stuff if the
variable named var_name is not set to a true value.
See the _process_template method below.
=cut
# Crude template for our PKGBUILD script
my $PKGBUILD_TEMPL = <<'END_TEMPL';
# Contributor: [% packager %]
# Generator : CPANPLUS::Dist::Arch [% version %]
pkgname='[% pkgname %]'
pkgver='[% pkgver %]'
pkgrel='1'
pkgdesc="[% pkgdesc %]"
arch=('i686' 'x86_64')
license=('PerlArtistic' 'GPL')
options=('!emptydirs')
depends=([% depends %])
url='[% url %]'
source=('[% source %]')
md5sums=('[% md5sums %]')
build() {
_DISTDIR="${srcdir}/[% distdir %]"
export PERL_MM_USE_DEFAULT=1
{ cd "$_DISTDIR" &&
[% IF is_makemaker %]
perl Makefile.PL INSTALLDIRS=vendor &&
make &&
[% IF skiptest %]#[% FI %]make test &&
make DESTDIR="${pkgdir}/" install;
[% FI %]
[% IF is_modulebuild %]
perl Build.PL --installdirs=vendor --destdir="$pkgdir" &&
./Build &&
[% IF skiptest %]#[% FI %]./Build test &&
./Build install;
[% FI %]
} || return 1;
find "$pkgdir" -name .packlist -delete
find "$pkgdir" -name perllocal.pod -delete
}
END_TEMPL
#----------------------------------------------------------------------
# CLASS GLOBALS
#----------------------------------------------------------------------
our ($PKGDEST, $PACKAGER);
$PACKAGER = 'Anonymous';
READ_CONF:
{
# Read makepkg.conf to see if there are system-wide settings
my $mkpkgconf;
if ( ! open $mkpkgconf, '<', $MKPKGCONF_FQP ) {
error "Could not read $MKPKGCONF_FQP: $!";
last READ_CONF;
}
my %cfg_vars = ( 'PKGDEST' => \$PKGDEST,
'PACKAGER' => \$PACKAGER );
my $cfg_field_match = sprintf $CFG_VALUE_MATCH,
join '|', keys %cfg_vars;
while (<$mkpkgconf>) {
chomp;
if ( my ($name, $value) = /$cfg_field_match/xmso ) {
${$cfg_vars{$name}} =
( $value =~ m/\A"(.*)"\z/ ?
do {
$value = $1;
$value =~ tr/\\//d;
$value;
} :
$value =~ m/\A'(.*)'\z/ ? $1 :
$value );
}
}
close $mkpkgconf or error "close on makepkg.conf: $!";
}
#-------------------------------------------------------------------------------
# PUBLIC CPANPLUS::Dist::Base Interface
#-------------------------------------------------------------------------------
=for Interface Methods
See CPANPLUS::Dist::Base's documentation for a description of the
purpose of these functions. All of these "interface" methods override
Base's default actions in order to create our packages.
=cut
#---INTERFACE METHOD---
# Purpose : Checks if we have makepkg and pacman installed
# Returns : 1 - if we have the tools needed to make a pacman package.
# 0 - if we don't think so.
#----------------------
sub format_available
{
for my $prog ( qw/ makepkg pacman / ) {
if ( ! can_run($prog) ) {
error "CPANPLUS::Dist::Arch needs to run $prog, to work properly";
return 0;
}
}
return 1;
}
#---INTERFACE METHOD---
# Purpose : Initializes our object internals to get things started
# Returns : 1 always
#----------------------
sub init
{
my $self = shift;
$self->status->mk_accessors( qw{ pkgname pkgver pkgbase pkgdesc
pkgurl pkgsize pkgarch
builddir destdir } );
return 1;
}
#---INTERFACE METHOD---
# Purpose : Prepares the files and directories we will need to build a
# package. Also prepares any data we expect to have later,
# on a per-object basis.
# Return : 1 if ok, 0 on error.
# Postcond : Sets $self->status->prepare to 1 or 0 on success or
# failure.
#----------------------
sub prepare
{
my $self = shift;
my $status = $self->status; # Private hash
my $module = $self->parent; # CPANPLUS::Module
my $intern = $module->parent; # CPANPLUS::Internals
my $conf = $intern->configure_object; # CPANPLUS::Configure
my $distcpan = $module->status->dist_cpan; # CPANPLUS::Dist::MM or
# CPANPLUS::Dist::Build
$self->_prepare_status;
$status->prepared(0);
# Call CPANPLUS::Dist::Base's prepare to resolve our pre-reqs.
return $self->SUPER::prepare(@_);
}
#---INTERFACE METHOD---
# Purpose : Creates the pacman package using the 'makepkg' command.
#----------------------
sub create
{
my ($self, %opts) = (shift, @_);
my $status = $self->status; # Private hash
my $module = $self->parent; # CPANPLUS::Module
my $intern = $module->parent; # CPANPLUS::Internals
my $conf = $intern->configure_object; # CPANPLUS::Configure
my $distcpan = $module->status->dist_cpan; # CPANPLUS::Dist::MM or
# CPANPLUS::Dist::Build
# Create directories for building and delivering the new package.
for my $dir ( $status->pkgbase, $status->destdir ) {
if ( -e $dir ) {
die "$dir exists but is not a directory!" if ( ! -d _ );
die "$dir exists but is read-only!" if ( ! -w _ );
}
else {
mkpath $dir
or die qq{failed to create directory '$dir': $OS_ERROR};
if ( $opts{verbose} ) { msg "Created directory $dir" }
}
}
my $pkg_type = $opts{pkg} || $opts{pkgtype} || 'bin';
$pkg_type = lc $pkg_type;
unless ( $pkg_type =~ /^(?:bin|src)$/ ) {
error qq{Invalid package type requested: "$pkg_type"
Package type must be 'bin' or 'src'};
return 0;
}
if ( $opts{verbose} ) {
my %fullname = ( bin => 'binary', src => 'source' );
msg "Creating a $fullname{$pkg_type} pacman package";
}
if ( $pkg_type eq 'bin' ) {
# Use CPANPLUS::Dist::Base to make packages for pre-requisites...
# (starts the packaging process for any missing ones)
my @ok_resolve_args = qw/ verbose target force prereq_build /;
my %resolve_args = map { ( exists $opts{$_} ?
($_ => $opts{$_}) : () ) } @ok_resolve_args;
$distcpan->_resolve_prereqs( %resolve_args,
'format' => ref $self,
'prereqs' => $module->status->prereqs );
}
# Prepare our file name paths for pkgfile and source tarball...
my $pkgfile = join '-', ( qq{${\$status->pkgname}},
qq{${\$status->pkgver}},
( $pkg_type eq q{bin}
? ( q{1},
qq{${\$status->pkgarch}.pkg.tar.gz} )
: q{1.src.tar.gz} )
);
my $srcfile_fqp = $status->pkgbase . '/' . $module->package;
my $pkgfile_fqp = $status->pkgbase . "/$pkgfile";
my $destdir = $opts{destdir} || $status->destdir;
$destdir = Cwd::abs_path( $destdir );
my $destfile_fqp = catfile( $destdir, $pkgfile );
# Prepare our 'makepkg' package building directory,
# namely the PKGBUILD and source tarball files...
if ( ! -e $srcfile_fqp ) {
my $tarball_fqp = $module->_status->fetch;
link $tarball_fqp, $srcfile_fqp
or error "Failed to create link to $tarball_fqp: $OS_ERROR";
}
$self->create_pkgbuild($self->status->pkgbase);
# Wrap it up!
chdir $status->pkgbase or die "chdir: $OS_ERROR";
my $makepkg_cmd = join ' ', ( 'makepkg',
# XXX: should we force rebuilding?
#'-f',
( $EUID == 0 ? '--asroot' : () ),
( $pkg_type eq 'src' ? '--source' : () ),
( !$opts{verbose} ? '>/dev/null' : () ),
);
# I tried to use IPC::Cmd here, but colors didn't work...
system $makepkg_cmd;
if ($CHILD_ERROR) {
error ( $CHILD_ERROR & 127
? sprintf "makepkg failed with signal %d", $CHILD_ERROR & 127
: sprintf "makepkg returned abnormal status: %d",
$CHILD_ERROR >> 8
);
return 0;
}
if ( ! rename $pkgfile_fqp, $destfile_fqp ) {
error "failed to move $pkgfile to $destfile_fqp: $OS_ERROR";
return 0;
}
$status->dist($destfile_fqp);
return $status->created(1);
}
#---INTERFACE METHOD---
# Purpose : Installs the package file (.pkg.tar.gz) using sudo and
# pacman.
# Comments : Called automatically on pre-requisite packages
#----------------------
sub install
{
my ($self, %opts) = (shift, @_);
my $status = $self->status; # Private hash
my $module = $self->parent; # CPANPLUS::Module
my $intern = $module->parent; # CPANPLUS::Internals
my $conf = $intern->configure_object; # CPANPLUS::Configure
my $pkgfile_fqp = $status->dist;
unless ( $pkgfile_fqp ) {
error << 'END_ERROR';
Path to package file has not been set.
Someone is using CPANPLUS::Dist::Arch incorrectly.
Tell them to call create() before install().
END_ERROR
return 0;
}
die "Package file $pkgfile_fqp was not found" if ( ! -f $pkgfile_fqp );
my $pacmancmd;
# Make sure the user has access to install a package...
my $sudocmd = $conf->get_program('sudo');
if ( $EFFECTIVE_USER_ID != $ROOT_USER_ID ) {
if ( $sudocmd ) {
$pacmancmd = "$sudocmd pacman -U $pkgfile_fqp";
}
else {
error $NONROOT_WARNING;
return 0;
}
}
else { $pacmancmd = "pacman -U $pkgfile_fqp"; }
system $pacmancmd;
if ( $CHILD_ERROR ) {
error ( $CHILD_ERROR & 127
? sprintf qq{'$pacmancmd' failed with signal %d},
$CHILD_ERROR & 127
: sprintf qq{'$pacmancmd' returned abnormal status: %d},
$CHILD_ERROR >> 8
);
return 0;
}
return $status->installed(1);
}
#-------------------------------------------------------------------------------
# EXPORTED FUNCTIONS
#-------------------------------------------------------------------------------
sub dist_pkgname
{
croak "Must provide arguments to dist_pkgname" if ( @_ == 0 );
my ($distname) = @_;
# Override this package name if there is one specified...
return $PKGNAME_OVERRIDES->{$distname}
if $PKGNAME_OVERRIDES->{$distname};
# Package names should be lowercase and consist of alphanumeric
# characters only (and hyphens!)...
$distname = lc $distname;
$distname =~ tr/_/-/;
$distname =~ tr/-a-z0-9//cd;
$distname =~ tr/-/-/s;
# Delete leading or trailing hyphens...
$distname =~ s/\A-//;
$distname =~ s/-\z//;
die qq{Dist name '$distname' completely violates packaging standards}
if ( ! $distname );
if ( $distname !~ / (?: \A perl ) | (?: -perl \z ) /xms ) {
$distname = "perl-$distname";
}
return $distname;
}
sub dist_pkgver
{
croak "Must provide arguments to pacman_version" if ( @_ == 0 );
my ($version) = @_;
# Package versions should be letters, numbers and decimal points only...
$version =~ tr/_-/../s;
$version =~ tr/a-zA-Z0-9.//cd;
return $version;
}
#-------------------------------------------------------------------------------
# PUBLIC METHODS
#-------------------------------------------------------------------------------
sub set_destdir
{
croak 'Invalid arguments to set_destdir' if ( @_ != 2 );
my ($self, $destdir) = @_;
$self->status->destdir($destdir);
return $destdir;
}
sub get_destdir
{
my $self = shift;
return $self->status->destdir;
}
sub get_cpandistdir
{
my ($self) = @_;
my $module = $self->parent;
my $distdir = $module->package;
$distdir =~ s/ [.] ${\$module->package_extension} \z //xms;
return $distdir;
}
sub get_pkgvars
{
croak 'Invalid arguments to get_pkgvars' if ( @_ != 1 );
my $self = shift;
my $status = $self->status;
croak 'prepare() must be called before get_pkgvars()'
unless ( $status->prepared );
return ( pkgname => $status->pkgname,
pkgver => $status->pkgver,
pkgdesc => $status->pkgdesc,
depends => scalar $self->_translate_cpan_deps,
url => $self->_get_disturl,
source => $self->_get_srcurl,
md5sums => $self->_calc_tarballmd5,
depshash => { $self->_translate_cpan_deps },
);
}
sub get_pkgvars_ref
{
croak 'Invalid arguments to get_pkgvars_ref' if ( @_ != 1 );
my $self = shift;
return { $self->get_pkgvars };
}
sub get_pkgbuild
{
my ($self) = @_;
my $status = $self->status;
my $module = $self->parent;
my $conf = $module->parent->configure_object;
croak 'prepare() must be called before get_pkgbuild()'
unless $status->prepared;
my %pkgvars = $self->get_pkgvars;
# Quote our package desc for bash.
$pkgvars{pkgdesc} =~ s/ ([\$\"\`\!]) / \\$1 /gxms;
my $templ_vars = { packager => $PACKAGER,
version => $VERSION,
%pkgvars,
distdir => $self->get_cpandistdir(),
skiptest => $conf->get_conf('skiptest'),
};
my $dist_type = $module->status->installer_type;
@{$templ_vars}{'is_makemaker', 'is_modulebuild'} =
( $dist_type eq 'CPANPLUS::Dist::MM' ? (1, 0) :
$dist_type eq 'CPANPLUS::Dist::Build' ? (0, 1) :
die "unknown Perl module installer type: '$dist_type'" );
return scalar $self->_process_template( $PKGBUILD_TEMPL,
$templ_vars );
}
sub create_pkgbuild
{
croak 'Invalid arguments to create_pkgbuild' if ( @_ != 2 );
my ($self, $destdir) = @_;
croak qq{Invalid directory passed to create_pkgbuild: "$destdir" ...
Directory does not exist or is not writeable}
unless ( -d $destdir && -w _ );
my $pkgbuild_text = $self->get_pkgbuild;
my $fqpath = catfile( $destdir, 'PKGBUILD' );
open my $pkgbuild_file, '>', $fqpath
or die "failed to open new PKGBUILD: $OS_ERROR";
print $pkgbuild_file $pkgbuild_text;
close $pkgbuild_file
or die "failed to close new PKGBUILD: $OS_ERROR";
return;
}
#-------------------------------------------------------------------------------
# PRIVATE INSTANCE METHODS
#-------------------------------------------------------------------------------
#---INSTANCE METHOD---
# Usage : my $deps_str = $self->_translate_cpan_deps()
# Purpose : Convert CPAN prerequisites into pacman package dependencies
# Returns : String to be appended after 'depends=' in PKGBUILD file,
# without parenthesis.
#---------------------
sub _translate_cpan_deps
{
croak 'Invalid arguments to _translate_cpan_deps method'
if @_ != 1;
my ($self) = @_;
my %pkgdeps;
my $module = $self->parent;
my $backend = $module->parent;
my $prereqs = $module->status->prereqs;
CPAN_DEP_LOOP:
for my $modname ( keys %{$prereqs} ) {
my $depver = $prereqs->{$modname};
# Sometimes a perl version is given as a prerequisite
if ( $modname eq 'perl' ) {
$pkgdeps{perl} = $depver;
next CPAN_DEP_LOOP;
}
# Ignore modules included with this version of perl...
# XXX: This checks the version of perl being run, not necessarily
# the latest perl version.
# NOTE: If 'provides' are given version numbers in the perl
# package we won't need to check this.
my $bundled_version = $Module::CoreList::version{0+$]}->{$modname};
if ( defined $bundled_version ) {
next CPAN_DEP_LOOP if ( qv($bundled_version) >= qv($depver) );
}
# Translate the module's distribution name into a package name...
my $modobj = $backend->parse_module( module => $modname )
or next CPAN_DEP_LOOP;
my $pkgname = dist_pkgname( $modobj->package_name );
$pkgdeps{$pkgname} = ( $depver eq '0'
? $depver
: dist_pkgver( $depver ) );
}
# Always require perl.
$pkgdeps{perl} ||= 0;
# Merge in the XS C library package deps...
my $xs_deps = $self->_translate_xs_deps;
XSDEP_LOOP:
while ( my ($name, $ver) = each %$xs_deps ) {
# TODO: report this error?
next XSDEP_LOOP if ( exists $pkgdeps{$name} );
$pkgdeps{$name} = $ver;
}
# Return a hash if in list context or return a string representing
# the depends= line in the PKGBUILD if caller wants a scalar.
return %pkgdeps if ( wantarray );
return ( join ' ',
map { $pkgdeps{$_} ? qq{'${_}>=$pkgdeps{$_}'} : qq{'$_'} }
sort keys %pkgdeps );
}
#---INSTANCE METHOD---
# Usage : $pkgdesc = $self->_prepare_pkgdesc();
# Purpose : Tries to find a module's "abstract" short description for
# use as a package description.
# Postcond : Sets the $self->status->pkgdesc accessor to the found
# package description.
# Returns : The package short description.
# Comments : We search through the META.yml file, the main module's .pm file,
# .pod file, and then the README file.
#---------------------
sub _prepare_pkgdesc
{
croak 'Invalid arguments to _prepare_pkgdesc method' if @_ != 1;
my ($self) = @_;
my ($status, $module, $pkgdesc) = ($self->status, $self->parent);
# Registered modules have their description stored in the object.
return $status->pkgdesc( $module->description )
if ( $module->description );
# First, try to find the short description in the META.yml file.
METAYML:
{
my $metayml;
unless ( open $metayml, '<', $module->status->extract().'/META.yml' ) {
#error "Could not open META.yml to get pkgdesc: $!";
last METAYML;
}
while ( <$metayml> ) {
chomp;
if ( ($pkgdesc) = /^abstract:\s*(.+)/) {
$pkgdesc = $1 if ( $pkgdesc =~ /\A'(.*)'\z/ );
close $metayml;
return $status->pkgdesc($pkgdesc);
}
}
close $metayml;
}
# Next, parse the source file or pod file for a NAME section...
my $podselect = Pod::Select->new;
$podselect->select('NAME');
my $modname = $module->name;
# We use the package name because there is usually a module file
# with the exact same name as the package file.
#
# We want the main module's description, just in case the user requested
# a lesser module in the same package file.
#
# Assume the main .pm or .pod file is under lib/Module/Name/Here.pm
my $mainmod_file = $module->package_name;
$mainmod_file =~ tr{-}{/}s;
$mainmod_file = catfile( $module->status->extract, 'lib', $mainmod_file );
PODSEARCH:
for my $podfile_path ( map { "$mainmod_file.$_" } qw/pm pod/ ) {
my $name_section = '';
next PODSEARCH unless ( -e $podfile_path );
open my $podfile, '<', $podfile_path
or next PODSEARCH;
open my $podout, '>', \$name_section
or die "failed open on filehandle to string: $!";
$podselect->parse_from_filehandle( $podfile, $podout );
close $podfile;
close $podout
or die "failed close on filehandle to string: $!";
next PODSEARCH unless ($name_section);
# Remove formatting codes.
$name_section =~ s{ [IBCLEFSXZ] <(.*?)> }{$1}gxms;
$name_section =~ s{ [IBCLEFSXZ] <<(.*?)>> }{$1}gxms;
# The short desc is on a line beginning with 'Module::Name - '
if ( ($pkgdesc) =
$name_section =~ / ^ \s* $modname [\s-]+ (.+?) $ /xms ) {
return $status->pkgdesc($pkgdesc);
}
}
# Last, try to find it in in the README file
README:
{
open my $readme, '<', $module->status->extract . '/README'
or last README;
# error( "Could not open README to get pkgdesc: $!" ), return undef;
my $modname = $module->name;
while ( <$readme> ) {
chomp;
if ( (/^NAME/ ... /^[A-Z]+/) # limit ourselves to a NAME section
&& ( ($pkgdesc) = / ^ \s* ${modname} [\s\-]+ (.+) $ /oxms) ) {
close $readme;
return $status->pkgdesc($pkgdesc);
}
}
close $readme;
}
return $status->pkgdesc(q{});
}
#---INSTANCE METHOD---
# Usage : $self->_prepare_status()
# Purpose : Prepares all the package-specific accessors in our $self->status
# accessor object (of the class Object::Accessor).
# Postcond : Accessors assigned to: pkgname pkgver pkgbase pkgarch
# destdir
# Returns : The object's status accessor.
#---------------------
sub _prepare_status
{
croak 'Invalid arguments to _prepare_status method' if @_ != 1;
my $self = shift;
my $status = $self->status; # Private hash
my $module = $self->parent; # CPANPLUS::Module
my $conf = $module->parent->configure_object;
my $our_base = catdir( $conf->get_conf('base'),
( sprintf "%vd", $PERL_VERSION ),
'pacman' );
$status->destdir( $PKGDEST || catdir( $our_base, 'pkg' ) );
my ($pkgver, $pkgname)
= ( dist_pkgver( $module->package_version ),
dist_pkgname( $module->package_name) );
my $pkgbase = catdir( $our_base, 'build', "$pkgname-$pkgver" );
my $pkgarch = `uname -m`;
chomp $pkgarch;
foreach ( $pkgname, $pkgver, $pkgbase, $pkgarch ) {
die "A package variable is invalid" unless defined;
}
$status->pkgname($pkgname);
$status->pkgver ($pkgver );
$status->pkgbase($pkgbase);
$status->pkgarch($pkgarch);
$self->_prepare_pkgdesc();
return $status;
}
#---INSTANCE METHOD---
# Usage : my $pkgurl = $self->_get_disturl()
# Purpose : Creates a nice, version agnostic homepage URL for the distribution.
# Returns : URL to the distribution's web page on CPAN.
#---------------------
sub _get_disturl
{
croak 'Invalid arguments to _get_disturl method' if @_ != 1;
my $self = shift;
my $module = $self->parent;
my $distname = $module->package_name;
return join '/', $CPANURL, 'dist', $distname;
}
#---INSTANCE METHOD---
# Usage : my $srcurl = $self->_get_srcurl()
# Purpose : Generates the standard cpan download link for the source tarball.
# Returns : URL to the distribution's tarball on CPAN.
#---------------------
sub _get_srcurl
{
croak 'Invalid arguments to _get_srcurl method' if @_ != 1;
my ($self) = @_;
my $module = $self->parent;
return join '/', $CPANURL, 'CPAN', $module->path, $module->package;
}
#---INSTANCE METHOD---
# Usage : my $md5hex = $self->calc_tarballmd5()
# Purpose : Returns the hex md5 string for the source (dist) tarball
# of the module.
# Throws : failed to get md5 of <filename>: ...
# Returns : The MD5 sum of the .tar.gz file in hex string form.
#---------------------
sub _calc_tarballmd5
{
my ($self) = @_;
my $module = $self->parent;
my $tarball_fqp = $module->_status->fetch;
# my $tarball_fqp = $self->status->pkgbase . '/' . $module->package;
open my $distfile, '<', $tarball_fqp
or die "failed to get md5 of $tarball_fqp: $OS_ERROR";
my $md5 = Digest::MD5->new;
$md5->addfile($distfile);
close $distfile;
return $md5->hexdigest;
}
#---HELPER FUNCTION---
# Purpose : Split the text into everything before the tags, inside tags, and after
# the tags. Inner nested tags are skipped.
#---------------------
sub _extract_nested
{
croak 'Invalid arguments to _extract_nested' unless ( @_ == 3 );
my ($text, $begin_match, $end_match) = @_;
my ($before_end, $middle_start, $middle_end, $after_start);
croak qq{could not find beginning match "$begin_match"}
unless ( $text =~ /$begin_match/ );
$before_end = $LAST_MATCH_START[0];
$middle_start = $LAST_MATCH_END [0];
my $search_pos = $middle_start;
END_SEARCH:
{
pos $text = $search_pos;
croak sprintf <<'END_ERR', substr $text, $search_pos, 30
could not find ending match starting at:
%s...
END_ERR
unless ( $text =~ /$end_match/go );
$middle_end = $LAST_MATCH_START[0];
$after_start = $LAST_MATCH_END[0];
pos $text = $search_pos;
if ( $text =~ /$begin_match/go && pos($text) < $after_start ) {
$search_pos = $after_start;
redo END_SEARCH;
}
}
my $before = substr $text, 0, $before_end;
my $middle = substr $text, $middle_start, $middle_end-$middle_start;
my $after = substr $text, $after_start;
return ($before, $middle, $after);
}
#---HELPER FUNCTION---
# Purpose : Removes IF blocks whose variables are not true.
# Params : $templ - The template as a string.
# $templ_vars - A hashref to template variables.
#---------------------
sub _prune_if_blocks
{
my ($templ, $templ_vars) = @_;
while ( my ($varname) = $templ =~ /\[%\s*IF (\w*)\s*%\]/ ) {
croak 'Invalid template given, must provide a variable name in IF block'
unless ( $varname );
croak "Unknown variable name in IF block: $varname"
unless ( exists $templ_vars->{$varname} );
my @chunks = _extract_nested( $templ,
qr/\[% IF \w+ %\]\n?/,
qr/\[% FI %\]\n?/ );
if ( ! $templ_vars->{$varname} ) { splice @chunks, 1, 1; }
$templ = join q{}, @chunks;
}
return $templ;
}
#---INSTANCE METHOD---
# Usage : $self->_process_template( $templ, $templ_vars );
# Purpose : Processes IF blocks and fills in a template with supplied
# variables.
# Params : templ - A scalar variable containing the template
# templ_vars - A hashref of template variables that you can refer to
# in the template to insert the variable's value.
# Throws : 'Template variable %s was not provided' is thrown if a template
# variable is used in $templ but not provided in $templ_vars,
# OR IF IT IS UNDEF!
# Returns : String of the template result.
#---------------------
sub _process_template
{
croak "Invalid arguments to _template_out" if @_ != 3;
my ($self, $templ, $templ_vars) = @_;
croak 'templ_var parameter must be a hashref'
if ( ref $templ_vars ne 'HASH' );
$templ = _prune_if_blocks( $templ, $templ_vars );
$templ =~ s{ \[% \s* (\w+) \s* %\] }
{ ( defined $templ_vars->{$1}
? $templ_vars->{$1}
: croak "Template variable $1 was not provided" )
}xmseg;
return $templ;
}
#-----------------------------------------------------------------------------
# XS module library dependency hunting
#-----------------------------------------------------------------------------
#---INSTANCE METHOD---
# Usage : $deps_ref = $self->_translate_cs_deps;
# Purpose : Attempts to find non-perl dependencies in XS modules.
# Returns : A hashref of 'package name' => 'minimum version'.
# (Minimum version will be the current installed version
# of the library)
#---------------------
sub _translate_xs_deps
{
my $self = shift;
my $modstat = $self->parent->status;
my $inst_type = $modstat->installer_type;
my $distcpan = $modstat->dist_cpan;
# Delegate to the other methods depending on the dist type...
my $libs_ref = ( $inst_type eq 'CPANPLUS::Dist::MM' ?
$self->_get_mm_xs_deps($distcpan) :
$inst_type eq 'CPANPLUS::Dist::Build' ?
$self->_get_mb_xs_deps($distcpan) :
die qq{Unknown installer type "$inst_type"} );
# Turn the linker flags into package deps...
return +{ map { ($self->_get_lib_pkg($_)) }
@$libs_ref };
}
#---INSTANCE METHOD---
# Usage : %pkg = $self->_get_lib_pkg($lib)
# Params : $lib - Can be a dynamic library name, with/without lib prefix
# or the -l<name> flag that is passed to the linker.
# (anything DynaLoader::dl_findfile accepts)
# Returns : A hash (or two element list) of:
# 'package name' => 'installed version'
# or an empty list if the lib/package owner could not be found.
#---------------------
sub _get_lib_pkg
{
my ($self, $libname) = @_;