]> git.deb.at Git - deb/packages.git/blob - lib/Packages/Dispatcher.pm
Merge branch 'master' into debian-master
[deb/packages.git] / lib / Packages / Dispatcher.pm
1 #!/usr/bin/perl -T
2 # Packages::Dispatcher -- CGI interface for packages.debian.org
3 #
4 # Copyright (C) 2004-2008 Frank Lichtenheld
5 #
6 #    This program is free software; you can redistribute it and/or modify
7 #    it under the terms of the GNU General Public License as published by
8 #    the Free Software Foundation; either version 1 of the License, or
9 #    (at your option) any later version.
10 #
11 #    This program is distributed in the hope that it will be useful,
12 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
13 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 #    GNU General Public License for more details.
15 #
16 #    You should have received a copy of the GNU General Public License
17 #    along with this program; if not, write to the Free Software
18 #    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
20 package Packages::Dispatcher;
21
22 use strict;
23 use warnings;
24
25 use CGI;
26 use POSIX;
27 use File::Basename;
28 use Template;
29 use DB_File;
30 use URI::Escape;
31 use Benchmark ':hireswallclock';
32 use I18N::AcceptLanguage;
33 use Date::Parse;
34
35 use Deb::Versions;
36 use Packages::Config qw( $DBDIR $ROOT $TEMPLATEDIR $CACHEDIR
37                          @SUITES @SECTIONS @ARCHIVES @ARCHITECTURES @PRIORITIES
38                          @LANGUAGES @DDTP_LANGUAGES );
39 use Packages::CGI qw( :DEFAULT error get_all_messages );
40 use Packages::DB;
41 use Packages::Search qw( :all );
42 use Packages::Template ();
43 use Packages::Sections;
44 use Packages::I18N::Locale;
45
46 use Packages::DoSearch;
47 use Packages::DoSearchContents;
48 use Packages::DoShow;
49 use Packages::DoIndex;
50 use Packages::DoNewPkg;
51 use Packages::DoDownload;
52 use Packages::DoFilelist;
53
54
55 sub do_dispatch {
56
57     &Packages::CGI::reset;
58     $Packages::Search::too_many_hits = 0;
59
60     # clean up env
61     $ENV{PATH} = "/bin:/usr/bin";
62     delete $ENV{'LANGUAGE'};
63     delete $ENV{'LANG'};
64     delete $ENV{'LC_ALL'};
65     delete $ENV{'LC_MESSAGES'};
66
67     my %SUITES_ALIAS = ( oldstable => 'lenny',
68                          stable => 'squeeze',
69                          testing => 'wheezy',
70                          unstable => 'sid',
71                          '5.0' => 'lenny',
72                          '6.0' => 'squeeze' );
73
74     # Read in all the variables set by the form
75     my $input;
76     if ($ARGV[0] && ($ARGV[0] eq 'php')) {
77         $input = new CGI(\*STDIN);
78     } else {
79         $input = new CGI;
80     }
81     my $cgi_error = $input->cgi_error;
82     if ($cgi_error) {
83         fatal_error( "Error parsing the request", $cgi_error );
84     }
85
86     my $pet0 = new Benchmark;
87     my $tet0 = new Benchmark;
88     my $debug = DEBUG && $input->param("debug");
89     $debug = 0 if !defined($debug) || $debug !~ /^\d+$/o;
90     $Packages::CGI::debug = $debug;
91
92     my $homedir = dirname($ENV{SCRIPT_FILENAME}).'/../';
93     &Packages::Config::init( $homedir );
94     &Packages::DB::init();
95     my $last_modified = $Packages::DB::db_read_time;
96     my $now = time;
97     my $expires = $last_modified + (12*3600);
98     $expires = $now + 3600 if $expires < $now;
99     # allow some fudge, since the db mod time is not the end of
100     # the cron job
101     $last_modified = $now if $now - $last_modified < 3600;
102
103     if ($input->http('If-Modified-Since') and
104         (my $modtime = str2time($input->http('If-Modified-Since'), 'UTC'))) {
105         if ($modtime <= $last_modified) {
106             print $input->header(-status => 304);
107             exit;
108         }
109     }
110
111     my %PO_LANGUAGES = map { $_ => 1 } @LANGUAGES;
112     my %DDTP_LANGUAGES = map { $_ => 1 } @DDTP_LANGUAGES;
113     my $acc = I18N::AcceptLanguage->new(defaultLanguage => 'en');
114     my $ddtp_lang = $acc->accepts( $input->http("Accept-Language"),
115                                    \@DDTP_LANGUAGES );
116     my $po_lang = $acc->accepts( $input->http("Accept-Language"),
117                                  \@LANGUAGES );
118     debug( "LANGS=@LANGUAGES DDTP_LANGS=@DDTP_LANGUAGES header=".
119            ($input->http("Accept-Language")||'').
120            " po_lang=$po_lang ddtp_lang=$ddtp_lang", 1 ) if DEBUG;
121
122     # backwards compatibility stuff
123     debug( "SCRIPT_URL=$ENV{SCRIPT_URL} SCRIPT_URI=$ENV{SCRIPT_URI}" ) if DEBUG;
124
125     if ($ENV{SCRIPT_URL} =~ m|^/cgi-bin/search_|) {
126         error( "You reached this site over an old URL. ".
127                "Depending on the exact parameters your search might work or not." );
128         # contents search changed a lot
129         if ($ENV{SCRIPT_URL} =~ m|^/cgi-bin/search_contents|) {
130             $input->param('keywords',$input->param('word')) if $input->param('word');
131             $input->param('searchon','contents');
132             for ($input->param('searchmode')) {
133                 /^searchfiles/ && do {
134                     $input->param('mode','filename');
135                     last;
136                 };
137                 /^filelist/ && do {
138                     $ENV{PATH_INFO} = '/'.join('/',($input->param('version')||'stable',
139                                                     $input->param('keywords'),
140                                                     $input->param('arch')||'i386',
141                                                     'filelist' ));
142                     $input->delete('searchon','version','keywords','arch');
143                     last;
144                 };
145             }
146         }
147     }
148     if ($ENV{is_reportbug}) {
149         $input->param('exact', 1);
150         debug( "reportbug detected, set paramater exact to '1'" ) if DEBUG;
151     }
152
153     my $what_to_do = 'show';
154     my $source = 0;
155     if (my $path = $ENV{'PATH_INFO'} || $input->param('PATH_INFO')) {
156         my @components = grep { $_ } map { lc $_ } split /\/+/, $path;
157
158         debug( "PATH_INFO=$path components=@components", 3) if DEBUG;
159
160         push @components, 'index' if @components && $path =~ m,/$,;
161
162         my %LANGUAGES = map { $_ => 1 } (@LANGUAGES, @DDTP_LANGUAGES);
163         if (@components > 1 and $LANGUAGES{$components[0]}
164             and !$input->param('lang')) {
165             $input->param( 'lang', shift(@components) );
166         }
167         if (@components > 1 and $components[0] eq 'source') {
168             shift @components;
169             $input->param( 'source', 1 );
170         }
171         if (@components > 0 and $components[0] eq 'search') {
172             shift @components;
173             $what_to_do = 'search';
174             # Done
175             fatal_error( "search doesn't take any more path elements" )
176                 if @components;
177         } elsif (@components == 0) {
178             fatal_error( "We're supposed to display the homepage here, instead of getting dispatch.pl" );
179         } elsif (@components == 1) {
180             if ($components[0] eq 'index') {
181                 $what_to_do = 'homepage';
182             } else {
183                 $what_to_do = 'search';
184             }
185         } else {
186
187             for ($components[-1]) {
188                 /^(index|allpackages|newpkg|changelog|copyright|download|filelist)$/ && do {
189                     pop @components;
190                     $what_to_do = $1;
191                     last;
192                 };
193             }
194
195             my %SUITES = map { $_ => 1 } @SUITES;
196             my %SECTIONS = map { $_ => 1 } @SECTIONS;
197             my %ARCHIVES = map { $_ => 1 } @ARCHIVES;
198             my %ARCHITECTURES = map { $_ => 1 } (@ARCHITECTURES, 'all', 'any');
199             my %PRIORITIES = map { $_ => 1 } @PRIORITIES;
200             my %params_set;
201             sub set_param_once {
202                 my ($cgi, $params_set, $key, $val) = @_;
203                 debug("set_param_once key=$key val=$val",4) if DEBUG;
204                 if ($params_set->{$key}++) {
205                     fatal_error( "$key set more than once in path" );
206                 } else {
207                     $cgi->param( $key, $val );
208                 }
209             }
210
211             my (@pkg, $need_pkg);
212             foreach (reverse @components) {
213                 $need_pkg = !@pkg
214                     && ($what_to_do !~ /^(index|allpackages|newpkg)$/);
215                 debug("need_pkg=$need_pkg component=$_",4) if DEBUG;
216                 if (!$need_pkg && $SUITES{$_}) {
217                     set_param_once( $input, \%params_set, 'suite', $_);
218                 } elsif (!$need_pkg && (my $s = $SUITES_ALIAS{$_})) {
219                     set_param_once( $input, \%params_set, 'suite', $s);
220                 } elsif (!$need_pkg && $SECTIONS{$_}) {
221                     set_param_once( $input, \%params_set, 'section', $_);
222                 } elsif (!$need_pkg && $sections_descs{$_}) {
223                     set_param_once( $input, \%params_set, 'subsection', $_);
224                 } elsif (!$need_pkg && ($_ eq 'source')) {
225                     set_param_once( $input, \%params_set, 'source', 1);
226                 } elsif ($ARCHITECTURES{$_}) {
227                     set_param_once( $input, \%params_set, 'arch', $_)
228                         unless $_ eq 'any';
229                 } elsif (!$need_pkg && $ARCHIVES{$_}) {
230                     set_param_once( $input, \%params_set, 'archive', $_);
231                 } elsif ($PRIORITIES{$_}) {
232                     set_param_once( $input, \%params_set, 'priority', $_);
233                 } else {
234                     push @pkg, $_;
235                 }
236             }
237             @components = @pkg;
238
239             if (@components > 1) {
240                 fatal_error( "two or more packages specified (@components)" );
241             }
242         } # else if (@components == 1)
243
244         if (@components) {
245             my $c = uri_unescape($components[0]);
246             $input->param( 'keywords', $c );
247             $input->param( 'package', $c );
248         }
249     }
250
251     my ( $pkg, @suites, @sections, @subsections, @archives, @archs );
252
253     my %params_def = ( keywords => { default => undef,
254                                      array => '\s+',
255                                      match => '^([-+\@\w\/.:]+)$',
256                                  },
257                        'package' => { default => undef,
258                                       match => '^([\w.+-]+)$',
259                                       var => \$pkg },
260                        suite => { default => 'default', match => '^([\w-]+)$',
261                                   array => ',', var => \@suites,
262                                   replace => { all => \@SUITES,
263                                                default => \@SUITES,
264                                                %SUITES_ALIAS } },
265                        archive => { default => ($what_to_do eq 'search') ?
266                                         'all' : 'default',
267                                         match => '^([\w-]+)$',
268                                         array => ',', var => \@archives,
269                                         replace => { all => \@ARCHIVES,
270                                                      default => \@ARCHIVES} },
271                        exact => { default => 0, match => '^(\w+)$',  },
272                        lang => { default => undef, match => '^([\w-]+)$',  },
273                        source => { default => 0, match => '^(\d+)$',  },
274                        debug => { default => 0, match => '^(\d+)$',  },
275                        searchon => { default => 'names', match => '^(\w+)$', },
276                        section => { default => 'all', match => '^([\w-]+)$',
277                                     alias => 'release', array => ',',
278                                     var => \@sections,
279                                     replace => { all => \@SECTIONS } },
280                        subsection => { default => 'default', match => '^([\w-]+)$',
281                                        array => ',', var => \@subsections,
282                                        replace => { default => [] } },
283                        priority => { default => 'default', match => '^([\w-]+)$',
284                                      array => ',',
285                                      replace => { default => [] } },
286                        arch => { default => 'any', match => '^([\w-]+)$',
287                                  array => ',', var => \@archs, replace =>
288                                  { any => \@ARCHITECTURES } },
289                        'format' => { default => 'html', match => '^([\w.]+)$',  },
290                        mode => { default => '', match => '^(\w+)$',  },
291                        sort_by => { default => 'file', match => '^(\w+)$', },
292                        );
293     my %opts;
294     my %params = Packages::CGI::parse_params( $input, \%params_def, \%opts );
295     Packages::CGI::init_url( $input, \%params, \%opts );
296
297     if (defined($opts{lang})) {
298         $opts{po_lang} = $PO_LANGUAGES{$opts{lang}} ? $opts{lang} : 'en';
299         $opts{ddtp_lang} = $DDTP_LANGUAGES{$opts{lang}} ? $opts{lang} : 'en';
300     } else {
301         $opts{po_lang} = $po_lang;
302         $opts{ddtp_lang} = $ddtp_lang;
303     }
304     my $charset = "UTF-8";
305     my $cat = Packages::I18N::Locale->get_handle( $opts{po_lang}, 'en' )
306         or die "get_handle failed for $opts{po_lang}";
307     $opts{cat} = $cat;
308
309     $opts{h_suites} = { map { $_ => 1 } @suites };
310     $opts{h_sections} = { map { $_ => 1 } @sections };
311     $opts{h_archives} = { map { $_ => 1 } @archives };
312     $opts{h_archs} = { map { $_ => 1 } @archs };
313
314     if ((($opts{searchon} eq 'names') && $opts{source}) ||
315         ($opts{searchon} eq 'sourcenames')) {
316         $opts{source} = 1;
317         $opts{searchon} = 'names',
318         $opts{searchon_form} = 'sourcenames';
319     } else {
320         $opts{searchon_form} = $opts{searchon};
321     }
322     if ($opts{searchon} eq 'contents' or $opts{searchon} eq 'filenames') {
323         $what_to_do = 'search_contents';
324     }
325
326     my $pet1 = new Benchmark;
327     my $petd = timediff($pet1, $pet0);
328     debug( "Parameter evaluation took ".timestr($petd) ) if DEBUG;
329
330     my $template = new Packages::Template( $TEMPLATEDIR, $opts{format},
331                                            { po_lang => $opts{po_lang}, ddtp_lang => $opts{ddtp_lang},
332                                              charset => $charset, cat => $cat,
333                                              debug => ( DEBUG ? $opts{debug} : 0 ) },
334                                            ( $CACHEDIR ? { COMPILE_DIR => $CACHEDIR } : {} ) );
335
336     #FIXME: ugly hack
337     unless (($what_to_do eq 'allpackages' and $opts{format} =~ /^(html|txt\.gz)/)
338             || ($what_to_do eq 'index' and $opts{format} eq 'html')
339             || -e "$TEMPLATEDIR/$opts{format}/${what_to_do}.tmpl") {
340         fatal_error( $cat->g("requested format not available for this document"),
341                      "406 requested format not available");
342     }
343
344     my (%page_content);
345     unless (@Packages::CGI::fatal_errors) {
346         no strict 'refs';
347         &{"do_$what_to_do"}( \%params, \%opts, \%page_content );
348     }
349
350     $page_content{opts} = \%opts;
351     $page_content{params} = \%params;
352
353     unless (@Packages::CGI::fatal_errors) {
354         print $input->header(-charset => $charset,
355                              -type => get_mime($opts{format}),
356                              -vary => 'negotiate,accept-language',
357                              -last_modified => strftime("%a, %d %b %Y %T %z",
358                                                         localtime($last_modified)),
359                              -expires => strftime("%a, %d %b %Y %T %z",
360                                                   localtime($expires)),
361                              );
362         #use Data::Dumper;
363         #print '<pre>'.Dumper(\%ENV, \%page_content, get_all_messages()).'</pre>';
364         print $template->page( $what_to_do, { %page_content, %{ get_all_messages() } } );
365     } elsif ($Packages::CGI::http_code && $Packages::CGI::http_code !~ /^2\d\d/) {
366         print $input->header( -charset => $charset, -status => $Packages::CGI::http_code );
367     } else {
368         # We currently have only an error page in html
369         # so no format support here
370         print $input->header( -charset => $charset );
371         print $template->error_page( get_all_messages() );
372     }
373 }
374
375 1;
376 # vim: ts=8 sw=4