scripts/feeds: scan for target metadata
[openwrt.git] / scripts / feeds
1 #!/usr/bin/perl
2 use Getopt::Std;
3 use FindBin;
4 use Cwd;
5 use lib "$FindBin::Bin";
6 use metadata;
7 use warnings;
8 use strict;
9 use Cwd 'abs_path';
10
11 chdir "$FindBin::Bin/..";
12 $ENV{TOPDIR}=getcwd();
13 $ENV{GIT_CONFIG_PARAMETERS}="'core.autocrlf=false'";
14 $ENV{GREP_OPTIONS}="";
15
16 my $mk=`which gmake 2>/dev/null`;       # select the right 'make' program
17 chomp($mk);             # trim trailing newline
18 $mk or $mk = "make";    # default to 'make'
19
20 # check version of make
21 my @mkver = split /\s+/, `$mk -v`, 4;
22 my $valid_mk = 1;
23 $mkver[0] =~ /^GNU/ or $valid_mk = 0;
24 $mkver[1] =~ /^Make/ or $valid_mk = 0;
25 $mkver[2] >= "3.81" or $valid_mk = 0;
26 $valid_mk or die "Unsupported version of make found: $mk\n";
27
28 my @feeds;
29 my %build_packages;
30 my %installed;
31 my %feed_cache;
32
33 my $feed_package = {};
34 my $feed_src = {};
35
36 sub parse_config() {
37         my $line = 0;
38         my %name;
39
40         open FEEDS, "feeds.conf" or
41                 open FEEDS, "feeds.conf.default" or
42                 die "Unable to open feeds configuration";
43         while (<FEEDS>) {
44                 chomp;
45                 s/#.+$//;
46                 next unless /\S/;
47                 my @line = split /\s+/, $_, 3;
48                 my @src;
49                 $line++;
50
51                 my $valid = 1;
52                 $line[0] =~ /^src-\w+$/ or $valid = 0;
53                 $line[1] =~ /^\w+$/ or $valid = 0;
54                 @src = split /\s+/, $line[2];
55                 $valid or die "Syntax error in feeds.conf, line: $line\n";
56
57                 $name{$line[1]} and die "Duplicate feed name '$line[1]', line: $line\n";
58                 $name{$line[1]} = 1;
59
60                 push @feeds, [$line[0], $line[1], \@src];
61         }
62         close FEEDS;
63 }
64
65 sub update_location($$)
66 {
67         my $name = shift;
68         my $url  = shift;
69         my $old_url;
70
71         -d "./feeds/$name.tmp" or mkdir "./feeds/$name.tmp" or return 1;
72
73         if( open LOC, "< ./feeds/$name.tmp/location" )
74         {
75                 chomp($old_url = readline LOC);
76                 close LOC;
77         }
78
79         if( !$old_url || $old_url ne $url )
80         {
81                 if( open LOC, "> ./feeds/$name.tmp/location" )
82                 {
83                         print LOC $url, "\n";
84                         close LOC;
85                 }
86                 return $old_url ? 1 : 0;
87         }
88
89         return 0;
90 }
91
92 sub update_index($)
93 {
94         my $name = shift;
95
96         -d "./feeds/$name.tmp" or mkdir "./feeds/$name.tmp" or return 1;
97         -d "./feeds/$name.tmp/info" or mkdir "./feeds/$name.tmp/info" or return 1;
98
99         system("$mk -s prepare-mk OPENWRT_BUILD= TMP_DIR=\"$ENV{TOPDIR}/feeds/$name.tmp\"");
100         system("$mk -s -f include/scan.mk IS_TTY=1 SCAN_TARGET=\"packageinfo\" SCAN_DIR=\"feeds/$name\" SCAN_NAME=\"package\" SCAN_DEPS=\"$ENV{TOPDIR}/include/package*.mk\" SCAN_DEPTH=5 SCAN_EXTRA=\"\" TMP_DIR=\"$ENV{TOPDIR}/feeds/$name.tmp\"");
101         system("$mk -s -f include/scan.mk IS_TTY=1 SCAN_TARGET=\"targetinfo\" SCAN_DIR=\"feeds/$name\" SCAN_NAME=\"target\" SCAN_DEPS=\"profiles/*.mk $ENV{TOPDIR}/include/target.mk\" SCAN_DEPTH=5 SCAN_EXTRA=\"\" SCAN_MAKEOPTS=\"TARGET_BUILD=1\" TMP_DIR=\"$ENV{TOPDIR}/feeds/$name.tmp\"");
102         system("ln -sf $name.tmp/.packageinfo ./feeds/$name.index");
103         system("ln -sf $name.tmp/.targetinfo ./feeds/$name.targetindex");
104
105         return 0;
106 }
107
108 my %update_method = (
109         'src-svn' => {
110                 'init'          => "svn checkout '%s' '%s'",
111                 'update'        => "svn update",
112                 'controldir'    => ".svn",
113                 'revision'      => "svn info | grep 'Revision' | cut -d ' ' -f 2 | tr -d '\n'"},
114         'src-cpy' => {
115                 'init'          => "cp -Rf '%s' '%s'",
116                 'update'        => "",
117                 'revision'      => "echo -n 'local'"},
118         'src-link' => {
119                 'init'          => "ln -s '%s' '%s'",
120                 'update'        => "",
121                 'revision'      => "echo -n 'local'"},
122         'src-git' => {
123                 'init'          => "git clone --depth 1 '%s' '%s'",
124                 'init_branch'   => "git clone --depth 1 --branch '%s' '%s' '%s'",
125                 'init_commit'   => "git clone '%s' '%s' && cd '%s' && git checkout -b '%s' '%s' && cd -",
126                 'update'        => "git pull --ff",
127                 'controldir'    => ".git",
128                 'revision'      => "git show --abbrev-commit HEAD | head -n 1 | cut -d ' ' -f 2 | tr -d '\n'"},
129         'src-gitsvn' => {
130                 'init'  => "git svn clone -r HEAD '%s' '%s'",
131                 'update'        => "git svn rebase",
132                 'controldir'    => ".git",
133                 'revision'      => "git show --abbrev-commit HEAD | head -n 1 | cut -d ' ' -f 2 | tr -d '\n'"},
134         'src-bzr' => {
135                 'init'          => "bzr checkout --lightweight '%s' '%s'",
136                 'update'        => "bzr update",
137                 'controldir'    => ".bzr"},
138         'src-hg' => {
139                 'init'          => "hg clone '%s' '%s'",
140                 'update'        => "hg pull --update",
141                 'controldir'    => ".hg"},
142         'src-darcs' => {
143                 'init'    => "darcs get '%s' '%s'",
144                 'update'  => "darcs pull -a",
145                 'controldir' => "_darcs"},
146 );
147
148 # src-git: pull broken
149 # src-cpy: broken if `basename $src` != $name
150
151 sub update_feed_via($$$$) {
152         my $type = shift;
153         my $name = shift;
154         my $src = shift;
155         my $relocate = shift;
156
157         my $m = $update_method{$type};
158         my $localpath = "./feeds/$name";
159         my $safepath = $localpath;
160         $safepath =~ s/'/'\\''/;
161         my ($base_branch, $branch) = split(/;/, $src, 2);
162         my ($base_commit, $commit) = split(/\^/, $src, 2);
163
164         if( $relocate || !$m->{'update'} || !-d "$localpath/$m->{'controldir'}" ) {
165                 system("rm -rf '$safepath'");
166                 if ($m->{'init_branch'} and $branch) {
167                         system(sprintf($m->{'init_branch'}, $branch, $base_branch, $safepath)) == 0 or return 1;
168                 } elsif ($m->{'init_commit'} and $commit) {
169                         system(sprintf($m->{'init_commit'}, $base_commit, $safepath, $safepath, $commit, $commit)) == 0 or return 1;
170                 } else {
171                         system(sprintf($m->{'init'}, $src, $safepath)) == 0 or return 1;
172                 }
173         } elsif ($m->{'init_commit'} and $commit) {
174                 # in case git hash has been provided don't update the feed
175         } else {
176                 system("cd '$safepath'; $m->{'update'}") == 0 or return 1;
177         }
178
179         return 0;
180 }
181
182 sub get_feed($) {
183         my $feed = shift;
184
185         if (!defined($feed_cache{$feed})) {
186                 my $file = "./feeds/$feed.index";
187
188                 clear_packages();
189                 -f $file or do {
190                         print "Ignoring feed '$feed' - index missing\n";
191                         return;
192                 };
193                 parse_package_metadata($file) or return;
194                 $feed_cache{$feed} = [ { %package }, { %srcpackage } ];
195         }
196
197         $feed_package = $feed_cache{$feed}->[0];
198         $feed_src = $feed_cache{$feed}->[1];
199         return $feed_cache{$feed}->[0];
200 }
201
202 sub get_installed() {
203         system("$mk -s prepare-tmpinfo OPENWRT_BUILD=");
204         clear_packages();
205         parse_package_metadata("./tmp/.packageinfo");
206         %installed = %package;
207 }
208
209 sub search_feed {
210         my $feed = shift;
211         my @substr = @_;
212         my $display;
213
214         return unless @substr > 0;
215         get_feed($feed);
216         foreach my $name (sort { lc($a) cmp lc($b) } keys %$feed_package) {
217                 my $pkg = $feed_package->{$name};
218                 my $substr;
219                 my $pkgmatch = 1;
220
221                 next if $pkg->{vdepends};
222                 foreach my $substr (@substr) {
223                         my $match;
224                         foreach my $key (qw(name title description src)) {
225                                 $pkg->{$key} and $substr and $pkg->{$key} =~ m/$substr/i and $match = 1;
226                         }
227                         $match or undef $pkgmatch;
228                 };
229                 $pkgmatch and do {
230                         $display or do {
231                                 print "Search results in feed '$feed':\n";
232                                 $display = 1;
233                         };
234                         printf "\%-25s\t\%s\n", $pkg->{name}, $pkg->{title};
235                 };
236         }
237         return 0;
238 }
239
240 sub search {
241         my %opts;
242
243         getopt('r:', \%opts);
244         foreach my $feed (@feeds) {
245                 search_feed($feed->[1], @ARGV) if (!defined($opts{r}) or $opts{r} eq $feed->[1]);
246         }
247 }
248
249 sub list_feed {
250         my $feed = shift;
251
252         get_feed($feed);
253         foreach my $name (sort { lc($a) cmp lc($b) } keys %$feed_package) {
254                 my $pkg = $feed_package->{$name};
255                 next if $pkg->{vdepends};
256                 if($pkg->{name}) {
257                         printf "\%-32s\t\%s\n", $pkg->{name}, $pkg->{title};
258                 }
259         }
260
261         return 0;
262 }
263
264 sub list {
265         my %opts;
266
267         getopts('r:d:nsh', \%opts);
268         if ($opts{h}) {
269                 usage();
270                 return 0;
271         }
272         if ($opts{n}) {
273                 foreach my $feed (@feeds) {
274                         printf "%s\n", $feed->[1];
275                 }
276                 return 0;
277         }
278         if ($opts{s}) {
279                 foreach my $feed (@feeds) {
280                         my $localpath = "./feeds/$feed->[1]";
281                         my $m = $update_method{$feed->[0]};
282                         my $revision;
283                         if( !$m->{'revision'} ) {
284                                 $revision = "X";
285                         }
286                         elsif( $m->{'controldir'} && -d "$localpath/$m->{'controldir'}" ) {
287                                 $revision = `cd '$localpath'; $m->{'revision'}`;
288                         }
289                         else {
290                                 $revision = "local";
291                         }
292                         if ($opts{d}) {
293                                 printf "%s%s%s%s%s%s%s\n", $feed->[1], $opts{d}, $feed->[0], $opts{d}, $revision, $opts{d}, join(", ", @{$feed->[2]});
294                         }
295                         else {
296                                 printf "\%-8s \%-8s \%-8s \%s\n", $feed->[1], $feed->[0], $revision, join(", ", @{$feed->[2]});
297                         }
298                 }
299                 return 0;
300         }
301         foreach my $feed (@feeds) {
302                 list_feed($feed->[1], @ARGV) if (!defined($opts{r}) or $opts{r} eq $feed->[1]);
303         }
304         return 0;
305 }
306
307 sub install_generic() {
308         my $feed = shift;
309         my $pkg = shift;
310         my $path = $pkg->{makefile};
311
312         if($path) {
313                 $path =~ s/\/Makefile$//;
314
315                 -d "./package/feeds" or mkdir "./package/feeds";
316                 -d "./package/feeds/$feed->[1]" or mkdir "./package/feeds/$feed->[1]";
317                 system("ln -sf ../../../$path ./package/feeds/$feed->[1]/");
318         } else {
319                 warn "Package is not valid\n";
320                 return 1;
321         }
322
323         return 0;
324 }
325
326 my %install_method = (
327         'src-svn' => \&install_generic,
328         'src-cpy' => \&install_generic,
329         'src-link' => \&install_generic,
330         'src-git' => \&install_generic,
331         'src-gitsvn' => \&install_generic,
332         'src-bzr' => \&install_generic,
333         'src-hg' => \&install_generic,
334         'src-darcs' => \&install_generic,
335 );
336
337 my %feed;
338
339 sub lookup_package($$) {
340         my $feed = shift;
341         my $package = shift;
342
343         foreach my $feed ($feed, @feeds) {
344                 next unless $feed->[1];
345                 next unless $feed{$feed->[1]};
346                 $feed{$feed->[1]}->{$package} and return $feed;
347         }
348         return;
349 }
350
351 sub is_core_package($) {
352         my $package = shift;
353         foreach my $file ("tmp/info/.packageinfo-$package", glob("tmp/info/.packageinfo-*_$package")) {
354                 next unless index($file, "tmp/info/.packageinfo-feeds_");
355                 return 1 if -s $file;
356         }
357         return 0;
358 }
359
360 sub install_package {
361         my $feed = shift;
362         my $name = shift;
363         my $force = shift;
364         my $ret = 0;
365
366         $feed = lookup_package($feed, $name);
367         $feed or do {
368                 $installed{$name} and return 0;
369                 # TODO: check if it's already installed within ./package directory
370                 $feed_src->{$name} or is_core_package($name) or warn "WARNING: No feed for package '$name' found, maybe it's already part of the standard packages?\n";
371                 return 0;
372         };
373
374         # switch to the metadata for the selected feed
375         get_feed($feed->[1]);
376
377         my $pkg = $feed{$feed->[1]}->{$name} or return 1;
378         $pkg->{name} or do {
379                 $installed{$name} and return 0;
380                 # TODO: check if this is an alias package, maybe it's known by another name
381                 warn "WARNING: Package '$name' is not available in feed $feed->[1].\n";
382                 return 0;
383         };
384         my $src = $pkg->{src};
385         my $type = $feed->[0];
386         $src or $src = $name;
387
388         # If it's a core package and we don't want to override, just return
389         !$force and is_core_package($src) and return 0;
390
391         # previously installed packages set the runtime package
392         # newly installed packages set the source package to 1
393         $installed{$src} and $installed{$src} == 1 and return 0;
394
395         # we'll trigger the override only with the 3 conditions below:
396         # - override is allowed by command line (-f)
397         # - a package with the same src exists in the core packages list
398         # - the package previously installed is not from a feed
399         my $override = 1 if ($force and is_core_package($src) and !$installed{$name}->{feed});
400
401         # check previously installed packages
402         $installed{$name} and !$override and return 0;
403         $installed{$src} = 1;
404
405         defined($override) and $override == 1
406                 and warn "Overriding package '$src'\n"
407                 or warn "Installing package '$src'\n";
408
409         $install_method{$type} or do {
410                 warn "Unknown installation method: '$type'\n";
411                 return 1;
412         };
413
414         &{$install_method{$type}}($feed, $pkg) == 0 or do {
415                 warn "failed.\n";
416                 return 1;
417         };
418
419         # install all dependencies referenced from the source package
420         foreach my $vpkg (@{$feed_src->{$src}}) {
421                 foreach my $dep (@{$vpkg->{depends}}, @{$vpkg->{builddepends}}, @{$vpkg->{"builddepends/host"}}) {
422                         next if $dep =~ /@/;
423                         $dep =~ s/^\+//;
424                         $dep =~ s/^.+://;
425                         $dep =~ s/\/.+$//;
426                         next unless $dep;
427                         install_package($feed, $dep, 0) == 0 or $ret = 1;
428                 }
429         }
430
431         return $ret;
432 }
433
434 sub refresh_config {
435         my $default = shift;
436
437         # workaround for timestamp check
438         system("rm -f tmp/.packageinfo");
439
440         # refresh the config
441         if ($default) {
442                 system("$mk oldconfig CONFDEFAULT=\"$default\" Config.in >/dev/null 2>/dev/null");
443         } else {
444                 system("$mk defconfig Config.in >/dev/null 2>/dev/null");
445         }
446 }
447
448 sub install {
449         my $name;
450         my %opts;
451         my $feed;
452         my $ret = 0;
453
454         getopts('ap:d:fh', \%opts);
455
456         if ($opts{h}) {
457                 usage();
458                 return 0;
459         }
460
461         get_installed();
462
463         foreach my $f (@feeds) {
464                 # index all feeds
465                 $feed{$f->[1]} = get_feed($f->[1]);
466
467                 # look up the preferred feed
468                 $opts{p} and $f->[1] eq $opts{p} and $feed = $f;
469         }
470
471         if($opts{a}) {
472                 foreach my $f (@feeds) {
473                         if (!defined($opts{p}) or $opts{p} eq $f->[1]) {
474                                 printf "Installing all packages from feed %s.\n", $f->[1];
475                                 get_feed($f->[1]);
476                                 foreach my $name (sort { lc($a) cmp lc($b) } keys %$feed_package) {
477                                         my $p = $feed_package->{$name};
478                                         next if $p->{vdepends};
479                                         if( $p->{name} ) {
480                                                 install_package($feed, $p->{name}, exists($opts{f})) == 0 or $ret = 1;
481                                                 get_feed($f->[1]);
482                                         }
483                                 }
484                         }
485                 }
486         } else {
487                 while ($name = shift @ARGV) {
488                         install_package($feed, $name, exists($opts{f})) == 0 or $ret = 1;
489                 }
490         }
491
492         # workaround for timestamp check
493
494         # set the defaults
495         if ($opts{d} and $opts{d} =~ /^[ymn]$/) {
496                 refresh_config($opts{d});
497         }
498
499         return $ret;
500 }
501
502 sub uninstall {
503         my %opts;
504         my $name;
505         my $uninstall;
506
507         getopts('ah', \%opts);
508
509         if ($opts{h}) {
510                 usage();
511                 return 0;
512         }
513
514         if ($opts{a}) {
515                 system("rm -rvf ./package/feeds");
516                 $uninstall = 1;
517         } else {
518                 if($#ARGV == -1) {
519                         warn "WARNING: no package to uninstall\n";
520                         return 0;
521                 }
522                 get_installed();
523                 while ($name = shift @ARGV) {
524                         my $pkg = $installed{$name};
525                         $pkg or do {
526                                 warn "WARNING: $name not installed\n";
527                                 next;
528                         };
529                         $pkg->{src} and $name = $pkg->{src};
530                         warn "Uninstalling package '$name'\n";
531                         system("rm -f ./package/feeds/*/$name");
532                         $uninstall = 1;
533                 }
534         }
535         $uninstall and refresh_config();
536         return 0;
537 }
538
539 sub update_feed($$$$)
540 {
541         my $type=shift;
542         my $name=shift;
543         my $src=shift;
544         my $perform_update=shift;
545         my $force_relocate=update_location( $name, "@$src" );
546
547         if( $force_relocate ) {
548                 warn "Source of feed $name has changed, replacing copy\n";
549         }
550         $update_method{$type} or do {
551                 warn "Unknown type '$type' in feed $name\n";
552                 return 1;
553         };
554         $perform_update and do {
555                 my $failed = 1;
556                 foreach my $feedsrc (@$src) {
557                         warn "Updating feed '$name' from '$feedsrc' ...\n";
558                         next unless update_feed_via($type, $name, $feedsrc, $force_relocate) == 0;
559                         $failed = 0;
560                         last;
561                 }
562                 $failed and do {
563                         warn "failed.\n";
564                         return 1;
565                 };
566         };
567         warn "Create index file './feeds/$name.index' \n";
568         update_index($name) == 0 or do {
569                 warn "failed.\n";
570                 return 1;
571         };
572         return 0;
573 }
574
575 sub update {
576         my %opts;
577         my $feed_name;
578         my $perform_update=1;
579
580         $ENV{SCAN_COOKIE} = $$;
581         $ENV{OPENWRT_VERBOSE} = 's';
582
583         getopts('ahi', \%opts);
584
585         if ($opts{h}) {
586                 usage();
587                 return 0;
588         }
589
590         if ($opts{i}) {
591                 # don't update from (remote) repository
592                 # only re-create index information
593                 $perform_update=0;
594         }
595
596         -d "feeds" or do {
597                         mkdir "feeds" or die "Unable to create the feeds directory";
598                 };
599
600         if ( ($#ARGV == -1) or $opts{a}) {
601                 foreach my $feed (@feeds) {
602                         my ($type, $name, $src) = @$feed;
603                         next unless update_feed($type, $name, $src, $perform_update) == 1;
604                         last;
605                 }
606         } else {
607                 while ($feed_name = shift @ARGV) {
608                         foreach my $feed (@feeds) {
609                                 my ($type, $name, $src) = @$feed;
610                                 if($feed_name ne $name) {
611                                         next;
612                                 }
613                                 update_feed($type, $name, $src, $perform_update);
614                         }
615                 }
616         }
617
618         refresh_config();
619
620         return 0;
621 }
622
623 sub feed_config() {
624         foreach my $feed (@feeds) {
625                 my $installed = (-f "feeds/$feed->[1].index");
626
627                 printf "\tconfig FEED_%s\n", $feed->[1];
628                 printf "\t\tbool \"Enable feed %s\"\n", $feed->[1];
629                 printf "\t\tdepends on PER_FEED_REPO\n";
630                 printf "\t\tdefault y\n" if $installed;
631                 printf "\t\thelp\n";
632                 printf "\t\t Enable the \\\"%s\\\" feed at %s.\n", $feed->[1], $feed->[2][0];
633                 printf "\n";
634         }
635
636         return 0;
637 }
638
639 sub usage() {
640         print <<EOF;
641 Usage: $0 <command> [options]
642
643 Commands:
644         list [options]: List feeds, their content and revisions (if installed)
645         Options:
646             -n :            List of feed names.
647             -s :            List of feed names and their URL.
648             -r <feedname>:  List packages of specified feed.
649             -d <delimiter>: Use specified delimiter to distinguish rows (default: spaces)
650
651         install [options] <package>: Install a package
652         Options:
653             -a :           Install all packages from all feeds or from the specified feed using the -p option.
654             -p <feedname>: Prefer this feed when installing packages.
655             -d <y|m|n>:    Set default for newly installed packages.
656             -f :           Install will be forced even if the package exists in core OpenWrt (override)
657
658         search [options] <substring>: Search for a package
659         Options:
660             -r <feedname>: Only search in this feed
661
662         uninstall -a|<package>: Uninstall a package
663         Options:
664             -a :           Uninstalls all packages.
665
666         update -a|<feedname(s)>: Update packages and lists of feeds in feeds.conf .
667         Options:
668             -a :           Update all feeds listed within feeds.conf. Otherwise the specified feeds will be updated.
669             -i :           Recreate the index only. No feed update from repository is performed.
670
671         clean:             Remove downloaded/generated files.
672
673 EOF
674         exit(1);
675 }
676
677 my %commands = (
678         'list' => \&list,
679         'update' => \&update,
680         'install' => \&install,
681         'search' => \&search,
682         'uninstall' => \&uninstall,
683         'feed_config' => \&feed_config,
684         'clean' => sub {
685                 system("rm -rf feeds");
686         }
687 );
688
689 my $arg = shift @ARGV;
690 $arg or usage();
691 parse_config;
692 foreach my $cmd (keys %commands) {
693         $arg eq $cmd and do {
694                 exit(&{$commands{$cmd}}());
695         };
696 }
697 usage();