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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
|
#!/usr/bin/perl -w
# ChangeLog:
# 0.3 20200420 bkw:
# - Check github URLs for validity.
# 0.2 20200103 bkw:
# - Use "git rev-parse" to decide if we're in a git repo, because
# "git status" traverses the whole repo looking for untracked files.
# It does this even if you use -uno (it won't *print* the untracked
# files, but it still searches for them). Thanks to alienBOB for cluing
# me in to using rev-parse for this.
# - Skip the junkfiles check when we're in a git repo. It's more
# annoying than it is useful.
# - Allow possible -e/-u arguments in the shebang.
# - Avoid false positives when the script does a "cd $PKG" and then
# uses relative paths for install/*.
# - Require VERSION= to appear within the first 10 non-comment/non-blank
# lines, and don't check it anywhere else in the script.
# - Allow scripts to skip lint checks via ###sbolint on/off comments.
# 0.1 20141114 bkw, Initial release.
$VERSION="0.3";
# generate man page with:
# pod2man --stderr -r0.2 -s1 -c"SBo Maintainer Tools" sbolint > sbolint.1
# This script is meant to be fairly self-contained, prefer not to
# require a huge pile of perl module dependencies. In some cases this
# means using system() or backticks or such (e.g. to run tar, instead of
# using Archive::Tar). Please don't "improve" the script by using a ton
# of modules. The POSIX module ships with perl, not afraid of using that.
# future options:
# -l list packages with errs/warnings, don't give details
# possibly some way to selectively disable the checks (does anyone
# really need this?)
# future ideas for checks:
# - REQUIRES= packages have to exist? annoying if you're working on a batch
# of stuff to be submitted together.
# - Validate images, e.g. icon.png or .xpm or such. ImageMagick's identify
# command can tell a non-image or a wrong-format image (a .jpg filename
# that's actually a PNG image), but it doesn't detect truncated images.
# Also we have to parse its stdout/stderr, it returns 0.
=pod
=head1 NAME
sbolint - check SlackBuild directories or tarballs for common errors.
=head1 SYNOPSIS
B<sbolint> [-q] [-u] [-n] [build [build ...]]
=head1 DESCRIPTION
sbolint checks for common errors in SlackBuilds.org scripts. It's
intended for slackbuild authors and maintainers, and can cut down on
"There was a problem with your upload" errors from the submission form.
The [build] arguments must be either directories or tarballs, each
containing a SlackBuild script, slack-desc, README, and .info file.
With no [build] arguments, the current directory is checked.
sbolint will flag errors for problems that would prevent the build from
being accepted by the upload form (or by the SBo admins, if if passes
the upload checks). There may also be warnings, which are things that
(probably) won't stop your build from being accepted, but may cause the
SBo admins extra work.
sbolint was not written by the SlackBuilds.org team, and shares no code
with the upload form's submission checker. Lack of errors/warnings from
sbolint does not guarantee that your build will be accepted!
sbolint doesn't check built packages, and never executes the build
script. If you want a lint tool for binary Slackware packages, try
pprkut's B<lintpkg>.
=head1 OPTIONS
=over 4
=item B<-q>
Quiet. Suppresses 'xxx checks out OK' and the total errors/warnings summary.
=item B<-u>
URL check. Uses B<curl> to make HTTP HEAD requests for the B<HOMEPAGE>,
B<DOWNLOAD>, and B<DOWNLOAD_x86_64> links. This won't guarantee that
the links are good, but some kinds of failure (e.g. site down, 404)
means they're definitely bad. Unfortunately a lot of sites have stopped
responding to HEAD requests in the name of "security", so your mileage
man vary.
=item B<-n>
Suppress warnings. Only errors will be listed. This also affects the
exit status (see below).
=back
=head1 CHECKS
For tar files only:
=over 4
=item -
File size must not be bigger than the upload form's limit (currently one
megabyte).
=item -
File must be a tar archive, possibly compressed with gzip, bzip2, or xz,
extractable by the B<tar>(1) command.
=item -
Filename extension must match compression type.
=item -
Archive must contain a directory with the same name as the archive's base name,
e.g. I<foo.tar.gz> must contain I<foo/>. Everything else in the archive must be
inside this directory.
=item -
Archive must contain I<dirname/Idirname.SlackBuild>.
=back
For all builds:
=over 4
=item -
The SlackBuild, .info, README files must have Unix \n line endings (not
DOS \r\n), and the last line of each must have a \n.
=item -
The SlackBuild script must exist, with mode 0755 (or 0644, if in a git repo),
and be a I<#!/bin/bash> script.
=item -
The script must contain the standard variable assignements for PRGNAM,
VERSION, BUILD, and TAG.
=item -
I<PRGNAM> in the script must match I<PRGNAM> in the .info file. Both must
match the script name (I<PRGNAM.SlackBuild>) and the directory name.
=item -
I<VERSION> must match the I<VERSION> in the .info file.
=item -
TAG=${TAG:-_SBo} must occur in the script.
=item -
The I<VERSION> and I<BUILD> variables must respect the environment.
=item -
The script must install the slack-desc in $PKG/install.
=item -
If there is a doinst.sh script, the SlackBuild must install it to I<$PKG/install>.
=item -
Template boilerplate comments should be removed, e.g. I<"REMOVE THIS ENTIRE BLOCK OF TEXT">
or I<"Automatically determine the architecture we're building on">.
=item -
Script must contain a B<makepkg> command.
=item -
README must exist and have mode 0644.
=item -
slack-desc must exist and have mode 0644.
=item -
slack-desc contents must match the SBo template, including the "handy-ruler",
comments, and correct spacing/indentation.
=item -
.info file must exist, have mode 0644, and match the SBo template.
=item -
.info file URLs must be valid URLs (for a very loose definition of "valid": they
must begin with B<ftp://>, B<http://>, or B<https://>).
=item -
Optionally, .info file URLs can be checked for existence with an HTTP HEAD
request (see the B<-u> option).
=back
The following tests are only done when sbolint's starting directory
was NOT in a git repo:
=over 4
=item -
Any files other than the .SlackBuild, .info, slack-desc, and README are
checked for permissions (should be 0644) and excessive size.
=item -
The source archive(s) must not exist. Also sbolint attempts to detect
extracted source trees (but isn't all that good at it).
=item -
Files named 'build.log' or 'strace.out*' must not exist. The B<sbrun>
tool creates these.
=back
The rationale for skipping the above tests when in a git repo is that
maintainers will be using git to track files and push changes, so we
don't need to check them here.
=head1 EXIT STATUS
Exit status from sbolint will normally be 0 (success) if there were no
errors or warnings in any of the builds checked. With the B<-n> option,
exit status will be 0 if there are no errors.
Exit status 1 indicates there was at least one warning or error (or, with
B<-n>, at least one error).
Any other exit status means sbolint itself failed somehow (e.g. called
with nonexistent filename).
=head1 BUGS
Probably quite a few. Watch this space for details.
=head1 AUTHOR
B. Watson (yalhcru at gmail dot com, or Urchlay on Freenode IRC)
=head1 SEE ALSO
B<sbofixinfo>(1), B<sbosearch>(1)
=cut
use POSIX qw/getcwd/;
@boilerplate = (
qr/#\s*REMOVE THIS ENTIRE BLOCK OF TEXT/,
qr/#\s*replace with (?:version:name) of program/,
qr/#\s*the "_SBo" is required/,
qr/#\s*Automatically determine the architecture we're building on/,
qr/#\s*Unless \$ARCH is already set,/,
qr/#\s*For consistency's sake, use this/,
qr/#\s*Drop the package in \/tmp/,
qr/#\s*Exit on most errors/,
qr/#\s*If you prefer to do selective error checking with/,
qr/#\s*Your application will probably need/,
qr/#\s*Compile the application and install it into the/,
qr/#\s*Strip binaries and libraries - this can be done with/,
qr/#\s*Compress man pages$/,
qr/#\s*Compress info pages and remove the/,
qr/#\s*Copy program documentation into the package/,
qr/#\s*Copy the slack-desc \(and a custom doinst\.sh if necessary\)/,
qr/#\s*Make the package; be sure to leave it in/,
);
# this was scraped from the HTML source for the upload form:
$MAX_TARBALL_SIZE = 1048576;
($SELF = $0) =~ s,.*/,,;
$buildname = $build = "";
$g_warncount = 0;
$g_errcount = 0;
$warncount = 0;
$errcount = 0;
$tempdir = 0;
our %info = (); # has to be global, check_info sets it, check_script needs it
# main() {
#check_github_url("testing", $_) for @ARGV;
#exit 0;
while(@ARGV && ($ARGV[0] =~ /^-/)) {
my $opt = shift;
$opt =~ /^-u/ && do { $url_head = 1; next; };
$opt =~ /^-d/ && do { $url_download = 1; next; };
$opt =~ /^--?q(uiet)?/ && do { $quiet = 1; next; };
$opt =~ /^-$/ && do { $stdin = 1; next; };
$opt =~ /^--?h(elp)?/ && do { usage(); exit 0; };
$opt =~ /^-n$/ && do { $nowarn = 1; next; };
die_usage("Unrecognized option '$opt'");
}
if($url_head && $url_download) {
die_usage("-u and -d options are mutually exclusive");
}
if($url_head || $url_download) {
if(system("curl --version > /dev/null") != 0) {
die "$SELF: -u and -d options require curl, can't find it in your \$PATH.\n";
}
}
if($stdin) {
@ARGV = <STDIN>;
chomp for @ARGV;
}
push @ARGV, "." unless @ARGV;
# are we in a git repo? build scripts are mode 0644 there, plus
# the junkfile check is skipped.
$in_git_repo = system("git rev-parse >/dev/null 2>/dev/null") == 0;
for(@ARGV) {
run_checks($_);
$g_errcount += $errcount;
$g_warncount += $warncount;
if(!$quiet) {
if($errcount == 0 and $warncount == 0) {
print "$buildname checks out OK\n";
} else {
print "$buildname: errors $errcount, warnings $warncount\n";
}
}
}
# print total errs/warns only if >1 build checked
if(!$quiet && @ARGV > 1) {
print "Total errors: $g_errcount\n";
print "Total warnings: $g_warncount\n" unless $nowarn;
}
exit ($g_errcount > 0 || (!$nowarn && $g_warncount > 0));
# }
sub dequote {
my $a = shift;
#warn "dequote arg: $a\n";
$a =~ s/^("|')(\S+)(\1)$/$2/;
#warn "dequote ret: $a\n";
return $a;
}
sub logmsg {
my $severity = shift;
my $format = shift;
printf("$buildname: $severity: $format\n", @_);
}
sub log_error {
logmsg("ERR", @_);
$errcount++;
}
sub log_warning {
return if $nowarn;
logmsg("WARN", @_);
$warncount++;
}
sub usage {
if(@_) {
warn "$SELF: $_\n" for @_;
}
warn <<EOF;
$SELF - check SlackBuilds.org scripts for common problems.
Usage: $SELF [-q] [-u] [-n] <build <build ...>>
builds may be directories or tarballs. If no build arguments given,
. (current directory) is assumed. Use - to read a list of tarballs/dirs
from stdin.
Options:
-q Quiet: only emit errors/warnings, no 'checks out OK' or totals.
-u URL Check: use HTTP HEAD request to verify download/homepage URLs exist.
-n Suppress warnings, log only errors.
See the man page for more details. If you don't have the man page, you
can generate it with:
pod2man --stderr -s1 -cSBoStuff -r$VERSION /path/to/sbolint > sbolint.1
EOF
# not yet:
#-d URL Download: as -u, plus download & check md5sums of download URLs.
}
sub die_usage {
usage(@_);
exit 1;
}
sub chdir_or_die {
chdir($_[0]) or die "$SELF: chdir($_[0]): $!\n";
}
sub make_temp_dir {
return if $tempdir;
my $tmp = $ENV{TMP} || "/tmp";
$tempdir = "$tmp/$SELF." . int(rand(2**32-1));
system("rm -rf $tempdir");
system("mkdir -p $tempdir");
if(! -d $tempdir) {
die "$SELF: can't create temp dir $tempdir\n";
}
}
sub rm_temp_dir {
if($tempdir && (-d $tempdir)) {
system("rm -rf $tempdir");
$tempdir = 0;
}
}
sub check_tarball_mime {
my $file = shift;
### This stuff is a little pedantic. It also relies on having a recent-ish
### version of GNU file (the one in Slack 14.1 works fine).
my %types = (
'tar' => 'application/x-tar',
'tar.gz' => 'application/x-gzip',
'tar.bz2' => 'application/x-bzip2',
'tar.xz' => 'application/x-xz',
);
(my $basename = $file) =~ s,.*/,,;
my (undef, $ext) = split /\./, $basename, 2;
my $mime = `file --brief --mime-type $file`;
chomp $mime;
if(!grep { $_ eq $mime } values %types) {
log_error("$file is not a tarball (mime type is '$mime')");
} elsif(!$ext) {
log_error("$file: filename has no extension (will be rejected by upload form)");
} elsif($types{$ext} ne $mime) {
log_error("$file mime type '$mime' doesn't match filename (should be $types{$ext})");
} elsif($ext ne 'tar') {
my $realmime = `file -z --brief --mime-type $file`;
chomp $realmime;
if($realmime ne 'application/x-tar') {
log_error("$file doesn't contain a tar archive (content mime type is $realmime, should be application/x-tar)");
}
}
}
sub check_tarball {
my $file = shift;
### First, mime type checks. None of this will be fatal (no return 0 on error).
check_tarball_mime($file);
### one more pre-extraction check:
if(-s "$file" > $MAX_TARBALL_SIZE) {
log_warning("$file is larger than $MAX_TARBALL_SIZE bytes, upload may be rejected");
}
### now call tar to list the contents, and start returning 0 on failure.
my @list = split "\n", `tar tf $file`;
if($?) {
log_error("$file: tar failed to list contents");
return 0;
}
if(!@list) {
log_error("$file is empty archive?");
return 0;
}
if($list[0] ne "$buildname/") {
log_error("$file not a SBo-compliant tarball, first element should be '$buildname/', not '$list[0]'");
return 0;
}
my $foundsb = 0;
shift @list; # 1st element is dirname/, we already checked it
for(@list) {
my $bn = quotemeta($buildname); # some builds have + in the name
if(not /^$bn\//) {
log_error("$file not a SBo-compliant tarball, contains extra junk '$_'");
return 0;
}
if(/^$bn\/$bn.SlackBuild$/) {
$foundsb = 1;
}
}
if(not $foundsb) {
log_error("$file not a SBo-compliant tarball, doesn't contain '$buildname/$buildname.SlackBuild'");
return 0;
}
return 1;
}
sub extract_tarball {
my $file = shift;
$file = `readlink -n -e $file`;
make_temp_dir();
chdir_or_die($tempdir);
system("tar xf $file");
return "$tempdir/$buildname";
}
# run_checks will extract its argument (then cd to it) if it's a tarball,
# otherwise cd to its argument if it's a dir, otherwise error.
sub run_checks {
$build = shift;
my $oldcwd = getcwd();
$errcount = $warncount = 0;
if(-f $build || -l $build) {
($buildname = $build) =~ s,\.tar(\..*)?$,,;
$buildname =~ s,.*/,,;
if(check_tarball($build)) {
chdir_or_die(extract_tarball($build));
} else {
return 0;
}
} elsif(-d $build) {
chdir_or_die($build);
} else {
die_usage "'$build' not a file or a directory.";
}
# last component of directory is the build name
$buildname = `readlink -n -e .`;
$buildname =~ s,.*/,,;
my @checks = (
\&check_readme,
\&check_slackdesc,
\&check_info,
\&check_script,
\&check_images,
);
# if we're in a git repo, it's assumed we're going to track extra
# files with git, and use git to update the build, not tar it up
# and use the web form.
push @checks, \&check_junkfiles unless $in_git_repo;
for(@checks) {
$_->($build);
}
chdir_or_die($oldcwd);
rm_temp_dir();
}
sub check_mode {
my ($file, $wantmode) = @_;
if(! -e $file) {
log_error("$file does not exist");
return 0;
}
my $gotmode = 07777 & ((stat($file))[2]);
if($wantmode != $gotmode) {
log_error("$file should be mode %04o, not %04o", $wantmode, $gotmode);
return 0;
}
return 1;
}
sub check_crlf {
my $file = shift;
for(@_) {
if(/\r/) {
log_error("$file has DOS-style CRLF line endings");
return 0;
}
}
return 1;
}
sub check_and_read {
my ($file, $mode) = @_;
my $crlf_err;
my @lines;
my $lastline_nonl;
check_mode($file, $mode);
if(open my $fh, "<$file") {
while(<$fh>) {
$lastline_nonl = 1 unless /\n$/;
chomp;
$crlf_err = 1 if s/\r$//;
push @lines, $_;
}
if(scalar @lines == 0) {
log_error("$file exists but is empty");
}
}
log_error("$file has DOS-style CRLF line endings") if $crlf_err;
log_error("$file has no newline at EOF") if $lastline_nonl;
return @lines;
}
sub check_readme {
my @lines = check_and_read("README", 0644);
if(grep { length > 72 } @lines) {
log_warning("README has lines >72 characters");
}
# TODO: check encoding (must be ASCII or UTF-8)
}
# the slack-desc checking code offends me (the author), on the one hand it's
# overly complex, and on the other hand it assumes the slack-desc is at
# least close to being right...
sub check_slackdesc {
my @lines = check_and_read("slack-desc", 0644);
return unless scalar @lines;
my $lineno = 1;
if($lines[0] =~ /^# HOW TO EDIT THIS FILE:$/) {
shift @lines;
$lineno++;
} else {
log_warning("slack-desc doesn't start with how-to-edit comment");
}
my $count = 0;
while($lines[0] =~ /^#/) {
$count++;
$lineno++;
shift @lines;
}
if($count != 5) {
log_warning("slack-desc doesn't have standard how-to-edit stanza");
}
$count = 0;
while($lines[0] eq "") {
$count++;
$lineno++;
shift @lines;
}
if($count == 0) {
log_warning("slack-desc missing blank line before handy-ruler");
} elsif($count > 1) {
log_warning("slack-desc has extra blank lines before handy-ruler");
}
if($lines[0] =~ /handy-ruler/) {
my $ruler = shift @lines;
$lineno++;
my ($spaces, $prefix, $hr, $suffix, $junk) = ($ruler =~ /^( *)(\|-+)(handy-ruler)(-+\|)(.*)$/);
if(length($spaces) != length($buildname)) {
log_error("slack-desc:$lineno: handy-ruler has wrong number of indent spaces (%d, should be %d)",
length($spaces),
length($buildname));
}
if(length($junk) > 0) {
log_error("slack-desc:$lineno: handy-ruler has %d characters of trailing junk after last |", length($junk));
}
my $rlen = length($prefix . $hr . $suffix);
if($rlen != 72) {
log_error("slack-desc:$lineno: handy-ruler must be 72 characters, not %d", $rlen);
} elsif(length($prefix) != 6) {
log_error("slack-desc:$lineno: handy-ruler malformed, has '$prefix' instead of '|-----'");
}
} else {
log_error("slack-desc missing handy-ruler");
}
$count = 0;
for(@lines) {
$count++;
if(my ($prefix, $text) = /^([^\s]+:)(.*)/) {
if($prefix ne "$buildname:") {
log_error("slack-desc:$lineno: wrong prefix '$prefix', should be '$buildname:'");
} elsif($text =~ /^\s+$/) {
log_error("slack-desc:$lineno: trailing whitespace after colon, on otherwise-blank line");
} elsif(length($text) > 72) {
log_error("slack-desc:$lineno: text too long, %d characters, should be <= 72", length($text));
} elsif(length($text) && $text !~ /^ /) {
log_error("slack-desc:$lineno: missing whitespace after colon, on non-blank line");
}
my $bn = quotemeta($buildname); # some builds have + in the name
if(($count == 1) && ($text !~ /^ $bn \(.+\)$/)) {
log_warning("slack-desc:$lineno: first description line should be '$buildname: $buildname (short desc)'");
}
} else {
log_error("slack-desc:$lineno: malformed line in description section");
}
$lineno++;
}
if($count < 11) {
log_error("slack-desc only has $count description lines, should be 11 (add some empties)");
} elsif($count > 11) {
log_error("slack-desc has too many description lines ($count, should be 11)");
}
}
# This is a damn mess. Needs refactoring badly.
sub check_info {
my $file = $buildname . ".info";
my @lines = check_and_read($file, 0644);
return unless scalar @lines;
my $lineno = 0;
my $file_lineno = 0;
my @expected = qw/PRGNAM VERSION HOMEPAGE
DOWNLOAD MD5SUM
DOWNLOAD_x86_64 MD5SUM_x86_64
REQUIRES MAINTAINER EMAIL/;
my $next_exp = 0;
my @keys;
my $continuation = 0;
# parse and bitch about bad syntax...
for(@lines) {
$file_lineno++;
if($continuation) {
s/^\s*//;
$_ = "$continuation $_";
$continuation = 0;
$lineno = $file_lineno - 1;
} else {
$lineno = $file_lineno;
}
if(s/\s*\\$//) {
$continuation = $_;
next;
}
if(/^\s*$/) {
log_error("$file:$lineno: blank line (get rid of it)");
next;
}
unless(/=/) {
log_error("$file:$lineno: malformed line (no = sign, missing \\ on prev line?)");
next;
}
if(s/^\s+//) {
log_error("$file:$lineno: leading whitespace before key");
}
if(s/\s+$//) {
log_error("$file:$lineno: trailing whitespace at EOL");
}
if(my ($k, $s1, $s2, $q1, $val, $q2) = /^(\w+)(\s*)=(\s*)("?)(.*?)("?)$/) {
if(!grep { $k eq $_ } @expected) {
log_error("$file:$lineno: invalid key '$k'");
} else {
if($k ne $expected[$next_exp]) {
log_warning("$file:$lineno: out of order, expected $expected[$next_exp], got $k");
}
$next_exp++;
}
if(not $q1) {
log_error("$file:$lineno: missing opening double-quote");
}
if(not $q2) {
log_error("$file:$lineno: missing closing double-quote");
}
if(length($s1) || length($s2)) {
log_error("$file:$lineno: no spaces allowed before/after = sign");
}
my $oldval = $val;
if($val =~ s/^\s+//) {
log_error("$file:$lineno: leading space in value: \"$oldval\"");
}
if($val =~ s/\s+$//) {
log_error("$file:$lineno: trailing space in value: \"$oldval\"");
}
$info{$k} = $val;
} else {
log_error("$file:$lineno: malformed line");
}
}
# parsing done, now for semantic checks
my @missing;
for(@expected) {
if(not exists($info{$_})) {
push @missing, $_;
}
}
log_error("$file: missing required key(s): " . (join ", ", @missing)) if @missing;
# init this to avoid checking undef values below
$info{$_} ||= "" for @expected;
if($info{PRGNAM} && ($info{PRGNAM} ne $buildname)) {
log_error("$file: PRGNAM is '$info{PRGNAM}', should be '$buildname'");
}
if($info{VERSION} =~ /-/) {
log_error("$file: VERSION may not contain - (dash) characters");
}
if(!check_url($info{HOMEPAGE})) {
log_error("$file: HOMEPAGE=\"$info{HOMEPAGE}\" doesn't look like a valid URL (http, https, or ftp)");
}
# use a HEAD request for homepage, even if downloading other files
if($url_head || $url_download) {
curl_head_request($file, $info{HOMEPAGE}) || do {
log_warning("$file: HOMEPAGE URL broken?");
};
}
if($info{MD5SUM} =~ /^\s*$/) {
log_error("$file: MD5SUM is missing or blank") unless $info{DOWNLOAD} eq 'UNSUPPORTED';
} else {
check_dl_and_md5($file, "");
}
my $dl64 = $info{DOWNLOAD_x86_64};
if($dl64 =~ /^(?:|UNSUPPORTED|UNTESTED)$/) {
if($info{MD5SUM_x86_64} ne "") {
log_error("$file: MD5SUM_x86_64 must be blank if DOWNLOAD_x86_64 is not set");
}
} elsif($info{MD5SUM_x86_64} eq "") {
log_error("$file: MD5SUM_x86_64 may not be blank if DOWNLOAD_x86_64 is set");
} else {
check_dl_and_md5($file, "_x86_64");
}
}
sub check_dl_and_md5 {
my($file, $suffix) = @_;
my $md5key = "MD5SUM" . $suffix;
my $dlkey = "DOWNLOAD" . $suffix;
my @dlurls = split /\s+/, $info{$dlkey};
my @md5s = split /\s+/, $info{$md5key};
if(@md5s != @dlurls) {
log_error("$file: we have " . @dlurls . " $dlkey URLs but " . @md5s . " $md5key" . " values");
}
for my $u (@dlurls) {
if(!check_url($u)) {
log_error("$file: $dlkey URL '$u' doesn't look like a valid URL (http, https, or ftp)");
next;
}
#check_github_url($file, $u);
if($url_head) {
curl_head_request($file, $u) || do {
warn '$u is '. $u;
log_warning("$file: $dlkey URL '$u' broken?");
};
} elsif($url_download) {
warn "$SELF: -d option not yet implemented\n";
}
}
for(@md5s) {
unless(/^[0-9a-f]{32}$/) {
log_error("$file: $md5key '$_' is invalid (must be 32 hex digits)");
}
}
# TODO: maybe actually download and check md5sums.
}
sub check_url {
# url is bad if:
return 0 if $_[0] =~ /\s/; # ...it contains a space,
return 0 if $_[0] !~ /\./; # ...it has no dots, or
return 0 if $_[0] !~ /\//; # ...it has no slashes, or
return ($_[0] =~ /^(?:ftp|https?):\/\//); # ...it doesn't have a known protocol,
# ...which doesn't necessarily mean it's a good URL either.
}
sub curl_head_request {
#return !system("curl --head --location --silent --fail $_[0] >/dev/null");
#warn $_[1];
my $file = $_[0];
my $client_filename = $_[1];
$client_filename =~ s,.*/,,;
my $curlcmd = "curl -m20 --head --location --silent --fail $_[1]";
open my $pipe, "$curlcmd|";
#warn "$curlcmd";
while(<$pipe>) {
chomp;
s/\r//;
if(/^content-disposition:\s+attachment;\s+filename=["']?(.*?)["']?$/i) {
#warn $1;
if(defined($client_filename) && ($client_filename ne $1)) {
log_warning("$file: download filename varies based on content disposition: '$1' vs. '$client_filename'");
}
}
}
return close($pipe);
}
# WIP, maybe no longer needed
## sub check_github_url {
## my $file = shift;
## my $url = shift;
## return unless $url =~ m{(https?:)//github\.com};
##
## if($1 eq "http:") {
## log_warning("$file: github URL $url should be https");
## }
##
## (my $expect_filename = $url) =~ s,.*/,,;
## my(undef, undef, undef, $user, $prog, $archive, $ver, $filename) = split /\//, $url;
## warn "user $user, prog $prog, archive $archive, ver $ver, filename $filename, expect_filename $expect_filename\n";
##
## # assume these are correct, for now
## return if $user eq 'downloads';
## return if $archive eq 'releases';
##
## # TODO: work out what to do about /raw/
## return if $archive eq 'raw';
##
## if($archive ne 'archive') {
## log_warning("$file: unknown github URL type: $url");
## return;
## }
##
## # OK, good URLs look like this:
## # https://github.com/jeetsukumaran/DendroPy/archive/v4.4.0/DendroPy-4.4.0.tar.gz
## # ...and bad ones look like this:
## # https://github.com/haiwen/seafile-client/archive/v4.4.2.tar.gz
## # Corrected version of the bad one would be:
## # https://github.com/haiwen/seafile-client/archive/v4.4.2/seafile-client-4.4.2.tar.gz
## # Notice the "v" isn't part of the version number. It's not always there,
## # and sometimes it's a different letter (r, or g, or capital V, etc).
## }
# NOT going to police the script too much. Would end up rewriting most of
# the shell, in perl. Plus, it'd become a straitjacket. Here's what I'll
# implement:
# - #!/bin/bash on line 1
# - PRGNAM must match $buildname
# - VERSION must match the .info VERSION
# - BUILD line must be present
# - TAG line must be present
# - If VERSION, BUILD, TAG don't respect the env, it's a warning
# - Check for strings like slack-desc, $PKG/install, makepkg, stuff
# that's standard for SBo. Don't be too specific here.
# - If there's a doinst.sh, it must mentioned in the script. If not,
# it better not be mentioned.
# - Check for leftover boilerplate
# - cp -a <documentation> is an error
sub check_script {
my $file = $buildname . ".SlackBuild";
my $wantmode = $in_git_repo ? 0644 : 0755;
my @lines = check_and_read($file, $wantmode);
return unless scalar @lines;
if($lines[0] !~ /^#!/) {
log_error("$file:1: missing or invalid shebang line (should be '#!/bin/bash')");
} elsif($lines[0] !~ m,#!/bin/bash(?: (?:-e|-eu|-ue|-e -u|-u -e))?$,) {
log_warning("$file:1: shebang line should be #!/bin/bash (possibly with -e/-u arg(s)), not '$lines[0]'");
}
my $lineno = 0;
my ($prgnam, $version, $build, $tag, $need_doinst, $slackdesc, $makepkg, $install);
my ($cdpkg, $codestart, $lint_enabled);
$lint_enabled = 1;
for(@lines) {
$lineno++;
if(/^\s*[^#]/ && !defined($codestart)) {
$codestart = $lineno;
}
if(/^###sbolint\s*(\S+)/) {
my $arg = $1;
if(lc($arg) eq "on") {
$lint_enabled = 1;
} elsif(lc($arg) eq "off") {
$lint_enabled = 0;
} else {
log_warning("$file:$lineno: unknown ###sbolint argument '$arg' (should be 'on' or 'off')");
}
}
next unless $lint_enabled;
# TODO: cp without -a (or -p, or a couple other flags) is OK.
## if(/^[^#]*cp\s+(?:-\w+\s+)*[\"\$\{]*CWD/) {
## log_error("$file:$lineno: copying files from CWD with cp (use cat instead)");
## }
if(/^PRGNAM=(\S+)/) {
if($prgnam) {
log_error("$file:$lineno: PRGNAM redefined");
}
$prgnam = dequote($1);
if($prgnam ne $buildname) {
log_error("$file:$lineno: PRGNAM doesn't match dir name ($prgnam != $buildname)");
}
} elsif(/^VERSION=(\S+)/ && ($lineno <= $codestart + 10)) {
$version = dequote($1);
if(not ($version =~ s/\$\{VERSION:-([^}]+)\}/$1/)) {
log_warning("$file:$lineno: VERSION ignores environment, try VERSION=\${VERSION:-$version}");
}
$version = dequote($1);
if($version ne $info{VERSION}) {
log_error("$file:$lineno: VERSION ($version) doesn't match VERSION in the .info file ($info{VERSION})");
}
} elsif(/^BUILD=(\S+)/) {
$build = dequote($1);
if(not ($build =~ /\d/)) {
log_error("$file:$lineno: BUILD is non-numeric");
} elsif(not ($build =~ /\$\{BUILD:-\d+}/)) {
log_warning("$file:$lineno: BUILD ignores environment (try BUILD=\${BUILD:-$build}");
}
} elsif(/^TAG=(\S+)/) {
$tag = dequote($1);
if($tag !~ /\$\{TAG:-(?:_SBo|("|')_SBo(\1))\}/) {
log_error("$file:$lineno: TAG=\${TAG:-_SBo} is required");
}
} elsif(/^[^#]*\$\S*CWD\S*\/doinst.sh/) {
$need_doinst = $lineno;
} elsif(/^[^#]*slack-desc/) {
$slackdesc = $lineno;
$install = $lineno if m,install/,; # assume OK
} elsif(/^[^#]*?cd\s+[{\$"]*PKG[}"]*/) {
$cdpkg = $lineno;
} elsif(/^[^#]*?["{\$]+PKG[}"]*\/install/) {
$install = $lineno;
} elsif($cdpkg && /^[^#]*mkdir[^#]*install/) {
$install = $lineno;
} elsif(/^[^#]*makepkg/) {
if($makepkg) {
log_error("$file:$lineno: makepkg called twice (here and line $makepkg");
}
$makepkg = $lineno;
}
if(/^[^#]*<documentation>/) {
log_error("$file:$lineno: copy actual documentation, not <documentation>");
}
my $line = $_;
if(grep { $line =~ /$_/ } @boilerplate) {
log_error("$file:$lineno: template comment should be removed");
}
# special case here: don't complain about this comment if it's a perl-* build
if($file !~ /^perl-/) {
if($line =~ /#\s*Remove perllocal.pod and other special files/) {
log_error("$file:$lineno: template comment should be removed");
}
}
}
if(not defined($prgnam)) {
log_error("$file: no PRGNAM= line");
}
if(not defined($version)) {
log_error("$file: no VERSION= line");
}
if(not defined($build)) {
log_error("$file: no BUILD= line");
}
if(not defined($tag)) {
log_error("$file: no TAG= line");
}
if(not defined($slackdesc)) {
log_error("$file: doesn't seem to install slack-desc in \$PKG/install");
}
if(not defined($makepkg)) {
log_error("$file: no makepkg command found");
}
if(not defined($install)) {
log_error("$file: nothing gets installed in \$PKG/install");
}
my $have_doinst = (-f "doinst.sh");
if($have_doinst) {
check_and_read("doinst.sh", 0644);
}
if($need_doinst && !$have_doinst) {
log_error("$file:$need_doinst: script installs doinst.sh, but it doesn't exist");
} elsif($have_doinst && !$need_doinst) {
log_error("$file: doinst.sh exists, but the script doesn't install it");
}
}
# stuff like editor backups and dangling symlinks.
# maybe *any* symlinks?
# ELF objects are bad, too.
# Big-ass files...
# directories are OK, but hidden dirs are not.
sub check_junkfiles {
my @sources = split(/\s+/, $info{DOWNLOAD} . " " . $info{DOWNLOAD_x86_64});
s,.*/,, for @sources;
@sources = grep { $_ !~ /^(?:\s*|UNTESTED|UNSUPPORTED)$/ } @sources;
if(!grep { $_ =~ /^v$info{VERSION}\./ } @sources) {
push @sources, "v$info{VERSION}.$_" for qw /zip tar.gz tar.bz2 tar.xz/;
}
open my $fh, "-|", "find . ! -type d -print0 | xargs -0 file --mime-type";
FILE: while(<$fh>) {
chomp;
my ($file, $type) = split /: */, $_, 2;
$file =~ s,\./,,;
# skip the files caught by other checks
next if $file eq "$buildname.SlackBuild";
next if $file eq "$buildname.info";
next if $file eq "README";
next if $file eq "slack-desc";
next if $file =~ /(?:diff|patch)$/;
check_mode($file, 0644);
if(grep { $_ eq $file } @sources) {
log_error("source archive found: $file");
next FILE;
}
for($file) {
(/\.swp\w*$/ || /#/ || /~/ ) && do {
log_error("editor backup found: $file");
next FILE;
};
/^\./ && do {
log_error("hidden file found: $file");
next FILE;
};
/\.(?:orig|bak|old)[^.]*$/ && do {
log_warning("$file looks like sort some of backup file");
next FILE;
};
/^(?:build.log|strace.out)/ && do {
log_warning("$file is a build log");
next FILE;
};
/\.desktop$/ && do {
system("desktop-file-validate $file");
if($? != 0) {
log_warning("$file fails desktop-file-validate");
next FILE;
}
}
}
for($type) {
($_ eq "inode/x-empty") && do {
log_error("$file is empty (0 bytes long)");
next FILE;
};
($_ =~ /^inode/) && do {
log_error("$file is $type, not a regular file or directory");
next FILE;
};
($_ =~ m,application/x-(?:executable|dosexec|object|coredump),) && do {
log_error("$file is object code ($type)");
next FILE;
};
}
my $size = -s $file;
if($size > 1024 * 100) {
log_warning("$file is large ($size bytes), may be rejected by submission form");
}
}
close $fh;
open $fh, "-|", "find . -type d -mindepth 1";
while(<$fh>) {
chomp;
s,\./,,;
if(/^\./) {
log_error("found hidden directory: $_");
next;
}
if(glob("$_/*.o")) {
log_error("$_ contains compiled object files (leftover source tree?)");
next;
}
for my $badfile (qw/Makefile configure CmakeLists.txt makefile.pl SConstruct/) {
if(-f "$_/$badfile") {
log_error("$_ looks like extracted source tree (contains $badfile)");
}
}
}
close $fh;
# # this won't always catch everything (e.g. PRGNAM=foo VERSION=1, but the
# # extracted dir is foo1 or foo_1 or foo-source-1).
# if(-d "$buildname-$version") {
# log_warning("$buildname-$version/ looks like extracted source dir");
# }
}
# if anything *.diff or *.patch contains \r, warn the
# user about git stripping the \r's (better gzip it).
sub check_patches {
for(<*.diff>,<*.patch>) {
check_and_read($_, 0644);
}
}
# checking an image is a bit of a PITA. "file" can tell us if it's
# not an image, or has the wrong extension.
# ImageMagick's "identify" command won't detect truncated images.
# "convert" will, but it always returns 0/success, so we have to
# parse its output.
sub im_check_img {
our %ext2mime;
my $mime;
my $ok = 1;
%ext2mime = (
png => 'image/png',
jpg => 'image/jpeg',
xpm => 'image/x-xpm',
gif => 'image/gif',
) unless %ext2mime;
my $img = shift;
my $ext = $img;
$ext =~ s,.*\.,,;
$ext = lc $ext;
chomp($mime = `file --brief --mime "$img"`);
if($mime !~ /$ext2mime{$ext}/) {
log_error("$img has wrong extension $ext (MIME type is $mime)");
return;
}
open my $im, "convert \"$img\" png:/dev/null 2>&1 |";
while(<$im>) {
$ok = 0 if /premature|corrupt/i;
}
close $im;
log_error("$img appears to be corrupt") unless $ok;
}
sub check_images {
my $images = `find . \\( -iname '*.jpg' -o -iname '*.png' -o -iname '*.xpm' -o -iname '*.gif' \\) -print0`;
for(split /\x00/, $images) {
check_mode($_, 0644);
im_check_img($_);
}
}
|