2 # Packages::Dispatcher -- CGI interface for packages.debian.org
4 # Copyright (C) 2004-2007 Frank Lichtenheld
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.
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.
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.
20 package Packages::Dispatcher;
31 use Benchmark ':hireswallclock';
32 use I18N::AcceptLanguage;
35 use Packages::Config qw( $DBDIR $ROOT $TEMPLATEDIR $CACHEDIR
36 @SUITES @SECTIONS @ARCHIVES @ARCHITECTURES @PRIORITIES
37 @LANGUAGES @DDTP_LANGUAGES );
38 use Packages::CGI qw( :DEFAULT error get_all_messages );
40 use Packages::Search qw( :all );
41 use Packages::Template ();
42 use Packages::Sections;
43 use Packages::I18N::Locale;
45 use Packages::DoSearch;
46 use Packages::DoSearchContents;
48 use Packages::DoIndex;
49 use Packages::DoNewPkg;
50 use Packages::DoDownload;
51 use Packages::DoFilelist;
56 &Packages::CGI::reset;
57 $Packages::Search::too_many_hits = 0;
60 $ENV{PATH} = "/bin:/usr/bin";
61 delete $ENV{'LANGUAGE'};
63 delete $ENV{'LC_ALL'};
64 delete $ENV{'LC_MESSAGES'};
66 my %SUITES_ALIAS = ( oldstable => 'sarge',
73 # Read in all the variables set by the form
75 if ($ARGV[0] && ($ARGV[0] eq 'php')) {
76 $input = new CGI(\*STDIN);
80 my $cgi_error = $input->cgi_error;
82 fatal_error( "Error parsing the request", $cgi_error );
85 my $pet0 = new Benchmark;
86 my $tet0 = new Benchmark;
87 my $debug = DEBUG && $input->param("debug");
88 $debug = 0 if !defined($debug) || $debug !~ /^\d+$/o;
89 $Packages::CGI::debug = $debug;
91 my $homedir = dirname($ENV{SCRIPT_FILENAME}).'/../';
92 &Packages::Config::init( $homedir );
93 &Packages::DB::init();
94 &Packages::I18N::Locale::load( "$homedir/po" );
96 my $acc = I18N::AcceptLanguage->new();
97 my %all_langs = map { $_ => 1 } (@LANGUAGES, @DDTP_LANGUAGES);
98 my @all_langs = sort keys %all_langs;
99 my $http_lang = $acc->accepts( $input->http("Accept-Language"),
100 \@all_langs ) || 'en';
101 debug( "LANGUAGES=@all_langs header=".
102 ($input->http("Accept-Language")||'').
103 " http_lang=$http_lang", 1 ) if DEBUG;
105 # backwards compatibility stuff
106 debug( "SCRIPT_URL=$ENV{SCRIPT_URL} SCRIPT_URI=$ENV{SCRIPT_URI}" ) if DEBUG;
108 if ($ENV{SCRIPT_URL} =~ m|^/cgi-bin/search_|) {
109 error( "You reached this site over an old URL. ".
110 "Depending on the exact parameters your search might work or not." );
111 # contents search changed a lot
112 if ($ENV{SCRIPT_URL} =~ m|^/cgi-bin/search_contents|) {
113 $input->param('keywords',$input->param('word')) if $input->param('word');
114 $input->param('searchon','contents');
115 for ($input->param('searchmode')) {
116 /^searchfiles/ && do {
117 $input->param('mode','filename');
121 $ENV{PATH_INFO} = '/'.join('/',($input->param('version')||'stable',
122 $input->param('keywords'),
123 $input->param('arch')||'i386',
125 $input->delete('searchon','version','keywords','arch');
131 if ($ENV{is_reportbug}) {
132 $input->param('exact', 1);
133 debug( "reportbug detected, set paramater exact to '1'" ) if DEBUG;
136 my $what_to_do = 'show';
138 if (my $path = $ENV{'PATH_INFO'} || $input->param('PATH_INFO')) {
139 my @components = grep { $_ } map { lc $_ } split /\/+/, $path;
141 debug( "PATH_INFO=$path components=@components", 3) if DEBUG;
143 push @components, 'index' if @components && $path =~ m,/$,;
145 my %LANGUAGES = map { $_ => 1 } @all_langs;
146 if (@components > 1 and $LANGUAGES{$components[0]}
147 and !$input->param('lang')) {
148 $input->param( 'lang', shift(@components) );
150 if (@components > 1 and $components[0] eq 'source') {
152 $input->param( 'source', 1 );
154 if (@components > 0 and $components[0] eq 'search') {
156 $what_to_do = 'search';
158 fatal_error( "search doesn't take any more path elements" )
160 } elsif (@components == 0) {
161 fatal_error( "We're supposed to display the homepage here, instead of getting dispatch.pl" );
162 } elsif (@components == 1) {
163 $what_to_do = 'search';
166 for ($components[-1]) {
167 /^(index|allpackages|newpkg|changelog|copyright|download|filelist)$/ && do {
174 my %SUITES = map { $_ => 1 } @SUITES;
175 my %SECTIONS = map { $_ => 1 } @SECTIONS;
176 my %ARCHIVES = map { $_ => 1 } @ARCHIVES;
177 my %ARCHITECTURES = map { $_ => 1 } (@ARCHITECTURES, 'all', 'any');
178 my %PRIORITIES = map { $_ => 1 } @PRIORITIES;
181 my ($cgi, $params_set, $key, $val) = @_;
182 debug("set_param_once key=$key val=$val",4) if DEBUG;
183 if ($params_set->{$key}++) {
184 fatal_error( "$key set more than once in path" );
186 $cgi->param( $key, $val );
190 my (@pkg, $need_pkg);
191 foreach (reverse @components) {
193 && ($what_to_do !~ /^(index|allpackages|newpkg)$/);
194 debug("need_pkg=$need_pkg component=$_",4) if DEBUG;
195 if (!$need_pkg && $SUITES{$_}) {
196 set_param_once( $input, \%params_set, 'suite', $_);
197 } elsif (!$need_pkg && (my $s = $SUITES_ALIAS{$_})) {
198 set_param_once( $input, \%params_set, 'suite', $s);
199 } elsif (!$need_pkg && $SECTIONS{$_}) {
200 set_param_once( $input, \%params_set, 'section', $_);
201 } elsif (!$need_pkg && $sections_descs{$_}) {
202 set_param_once( $input, \%params_set, 'subsection', $_);
203 } elsif (!$need_pkg && ($_ eq 'source')) {
204 set_param_once( $input, \%params_set, 'source', 1);
205 } elsif ($ARCHITECTURES{$_}) {
206 set_param_once( $input, \%params_set, 'arch', $_)
208 } elsif (!$need_pkg && $ARCHIVES{$_}) {
209 set_param_once( $input, \%params_set, 'archive', $_);
210 } elsif ($PRIORITIES{$_}) {
211 set_param_once( $input, \%params_set, 'priority', $_);
218 if (@components > 1) {
219 fatal_error( "two or more packages specified (@components)" );
221 } # else if (@components == 1)
224 my $c = uri_unescape($components[0]);
225 $input->param( 'keywords', $c );
226 $input->param( 'package', $c );
230 my ( $pkg, @suites, @sections, @subsections, @archives, @archs );
232 my %params_def = ( keywords => { default => undef,
234 match => '^([-+\@\w\/.:]+)$',
236 'package' => { default => undef,
237 match => '^([\w.+-]+)$',
239 suite => { default => 'default', match => '^([\w-]+)$',
240 array => ',', var => \@suites,
241 replace => { all => \@SUITES,
244 archive => { default => ($what_to_do eq 'search') ?
246 match => '^([\w-]+)$',
247 array => ',', var => \@archives,
248 replace => { all => \@ARCHIVES,
249 default => \@ARCHIVES} },
250 exact => { default => 0, match => '^(\w+)$', },
251 lang => { default => $http_lang, match => '^([\w-]+)$', },
252 source => { default => 0, match => '^(\d+)$', },
253 debug => { default => 0, match => '^(\d+)$', },
254 searchon => { default => 'names', match => '^(\w+)$', },
255 section => { default => 'all', match => '^([\w-]+)$',
256 alias => 'release', array => ',',
258 replace => { all => \@SECTIONS } },
259 subsection => { default => 'default', match => '^([\w-]+)$',
260 array => ',', var => \@subsections,
261 replace => { default => [] } },
262 priority => { default => 'default', match => '^([\w-]+)$',
264 replace => { default => [] } },
265 arch => { default => 'any', match => '^([\w-]+)$',
266 array => ',', var => \@archs, replace =>
267 { any => \@ARCHITECTURES } },
268 'format' => { default => 'html', match => '^([\w.]+)$', },
269 mode => { default => '', match => '^(\w+)$', },
270 sort_by => { default => 'file', match => '^(\w+)$', },
273 my %params = Packages::CGI::parse_params( $input, \%params_def, \%opts );
274 Packages::CGI::init_url( $input, \%params, \%opts );
276 my $charset = "UTF-8";
277 my $cat = Packages::I18N::Locale->get_handle( $opts{lang} )
278 || Packages::I18N::Locale->get_handle( 'en' );
279 die "get_handle failed for $opts{lang}" unless $cat;
282 $opts{h_suites} = { map { $_ => 1 } @suites };
283 $opts{h_sections} = { map { $_ => 1 } @sections };
284 $opts{h_archives} = { map { $_ => 1 } @archives };
285 $opts{h_archs} = { map { $_ => 1 } @archs };
287 if ((($opts{searchon} eq 'names') && $opts{source}) ||
288 ($opts{searchon} eq 'sourcenames')) {
290 $opts{searchon} = 'names',
291 $opts{searchon_form} = 'sourcenames';
293 $opts{searchon_form} = $opts{searchon};
295 if ($opts{searchon} eq 'contents' or $opts{searchon} eq 'filenames') {
296 $what_to_do = 'search_contents';
299 my $pet1 = new Benchmark;
300 my $petd = timediff($pet1, $pet0);
301 debug( "Parameter evaluation took ".timestr($petd) ) if DEBUG;
303 my $template = new Packages::Template( $TEMPLATEDIR, $opts{format},
304 { lang => $opts{lang}, charset => $charset,
306 debug => ( DEBUG ? $opts{debug} : 0 ) },
307 ( $CACHEDIR ? { COMPILE_DIR => $CACHEDIR } : {} ) );
310 unless (($what_to_do eq 'allpackages' and $opts{format} =~ /^(html|txt\.gz)/)
311 || -e "$TEMPLATEDIR/$opts{format}/${what_to_do}.tmpl") {
312 fatal_error( $cat->g("requested format not available for this document"),
313 "406 requested format not available");
317 unless (@Packages::CGI::fatal_errors) {
319 &{"do_$what_to_do"}( \%params, \%opts, \%page_content );
322 $page_content{opts} = \%opts;
323 $page_content{params} = \%params;
325 unless (@Packages::CGI::fatal_errors) {
326 print $input->header(-charset => $charset, -type => get_mime($opts{format}) );
328 #print '<pre>'.Dumper(\%ENV, \%page_content, get_all_messages()).'</pre>';
329 print $template->page( $what_to_do, { %page_content, %{ get_all_messages() } } );
330 } elsif ($Packages::CGI::http_code && $Packages::CGI::http_code !~ /^2\d\d/) {
331 print $input->header( -charset => $charset, -status => $Packages::CGI::http_code );
333 # We currently have only an error page in html
334 # so no format support here
335 print $input->header( -charset => $charset );
336 print $template->error_page( get_all_messages() );