]> git.deb.at Git - deb/packages.git/blob - lib/Packages/HTML.pm
Fix some smaller issues reported by Thijs Kinkhorst
[deb/packages.git] / lib / Packages / HTML.pm
1 package Packages::HTML;
2
3 use strict;
4 use warnings;
5
6 use Exporter;
7 use URI::Escape;
8 use HTML::Entities;
9 use Locale::gettext;
10
11 use Packages::CGI qw(make_url make_search_url);
12 use Packages::Search qw( read_entry_simple );
13 use Packages::Config qw( :all );
14
15 #use Packages::Util;
16 use Packages::I18N::Locale;
17 use Packages::I18N::Languages;
18 use Packages::I18N::LanguageNames;
19 #use Generated::Strings qw( gettext dgettext );
20
21 our @ISA = qw( Exporter );
22 our @EXPORT = qw( header title trailer file_changed time_stamp
23                   read_md5_hash write_md5_hash simple_menu
24                   ds_begin ds_item ds_end title marker pdesc
25                   pdeplegend pkg_list pmoreinfo print_deps print_src_deps );
26
27 our $CHANGELOG_URL = '/changelogs';
28
29 sub img {
30     my ( $root, $url, $src, $alt, %attr ) = @_; 
31     my @attr;
32
33     foreach my $a ( keys %attr ) {
34         push @attr, "$a=\"$attr{$a}\"";
35     }
36
37     return "<a href=\"$root$url\"><img src=\"$root$src\" alt=\"$alt\" @attr></a>";
38 }
39
40 sub simple_menu {
41     my $str = "";
42     foreach my $entry (@_) {
43         $str .= "[&nbsp;$entry->[0] <a title=\"$entry->[1]\" href=\"$entry->[2]\">$entry->[3]</a>&nbsp;]\n";
44     }
45     return $str;
46 }
47
48 sub title {
49     return "<h1>$_[0]</h1>\n";
50 }
51
52 sub marker {
53     return "[<strong class=\"pmarker\">$_[0]</strong>]";
54 }
55
56 sub pdesc {
57     my ( $short_desc, $long_desc ) = @_;
58     my $str = "";
59
60     $str .= "<div id=\"pdesc\">\n";
61     $str .= "<h2>$short_desc</h2>\n";
62
63     $str .= "<p>$long_desc\n";
64     $str .= "</div> <!-- end pdesc -->\n";
65
66     return $str;
67 }
68
69 sub pdeplegend {
70     my $str = "<table id=\"pdeplegend\" summary=\"legend\"><tr>\n";
71
72     foreach my $entry (@_) {
73         $str .= "<td><img src=\"$ROOT/Pics/$entry->[0].gif\" alt=\"[$entry->[0]]\" width=\"16\" height=\"16\">= $entry->[1]</td>";
74     }
75
76     $str .= "\n</tr></table>\n";
77     return $str;
78 }
79
80 sub pkg_list {
81     my ( $packages, $opts, $pkgs, $lang ) = @_;
82     my $suite = $opts->{suite}[0];
83
84     my $str = "";
85     foreach my $p ( sort @$pkgs ) {
86
87         # we don't deal with virtual packages here because for the
88         # current uses of this function this isn't needed
89         my $short_desc = (read_entry_simple( $packages, $p, $opts->{h_archives}, $suite))->[-1];
90
91         if ( $short_desc ) {
92             $str .= "<dt><a href=\"".make_url($p,'',{source=>undef})."\">$p</a></dt>\n".
93                     "\t<dd>$short_desc</dd>\n";
94         } else {
95             $str .= "<dt>$p</dt>\n\t<dd>"._g("Not available")."</dd>\n";
96         }
97     }
98     if ($str) {
99         $str = "<dl>$str</dl>\n";
100     }
101
102     return $str;
103 }
104
105 sub pmoreinfo {
106     my %info = @_;
107     
108     my $name = $info{name} or return;
109     my $env = $info{env} or return;
110     my $opts = $info{opts} or return;
111     my $page = $info{data} or return;
112     my $is_source = $info{is_source};
113     my $suite = $opts->{suite}[0];
114
115     my $str = "<div id=\"pmoreinfo\">";
116     $str .= sprintf( "<h2>"._g( "More Information on %s" )."</h2>",
117                      $name );
118     
119     if ($info{bugreports}) {
120         my $bug_url = $is_source ? $SRC_BUG_URL : $BUG_URL; 
121         $str .= "<p>\n".sprintf( _g( "Check for <a href=\"%s\">Bug Reports</a> about %s." )."<br>\n",
122                          $bug_url.$name, $name );
123     }
124         
125     my $source = $page->get_src( 'package' );
126     my $source_version = $page->get_src( 'version' );
127     my $src_dir = $page->get_src('directory');
128     if ($info{sourcedownload}) {
129         my $files = $page->get_src( 'files' );
130         $str .= _g( "Source Package:" );
131         $str .= " <a href=\"".make_url($source,'',{source=>'source'})."\">$source</a>, ".
132             _g( "Download" ).":\n";
133
134         unless (defined($files) and @$files) {
135             $str .= _g( "Not found" );
136         } else {
137             foreach( @$files ) {
138                 my ($src_file_md5, $src_file_size, $src_file_name) = split /\s/o, $_;
139                 # non-US hack
140                 (my $server = lc $page->get_newest('archive')) =~ s/-//go;
141                 $str .= sprintf("<a href=\"%s/$src_dir/$src_file_name\">[",
142                                 $env->{$server}||$env->{us});
143                 if ($src_file_name =~ /dsc$/) {
144                     $str .= "dsc";
145                 } else {
146                     $str .= $src_file_name;
147                 }
148                 $str .= "]</a>\n";
149             }
150         }
151 #           $package_page .= sprintf( _g( " (These sources are for version %s)\n" ), $src_version )
152 #               if ($src_version ne $version) && !$src_version_given_in_control;
153     }
154
155     if ($info{changesandcopy}) {
156         if ( $src_dir ) {
157             (my $src_basename = $source_version) =~ s,^\d+:,,; # strip epoche
158             $src_basename = "${source}_$src_basename";
159             $src_dir =~ s,pool/updates,pool,o;
160             $src_dir =~ s,pool/non-US,pool,o;
161             $str .= "<br>".sprintf( _g( 'View the <a href="%s">Debian changelog</a>' ),
162                                     "$CHANGELOG_URL/$src_dir/$src_basename/changelog" )."<br>\n";
163             my $copyright_url = "$CHANGELOG_URL/$src_dir/$src_basename/";
164             $copyright_url .= ( $is_source ? 'copyright' : "$name.copyright" );
165
166             $str .= sprintf( _g( 'View the <a href="%s">copyright file</a>' ),
167                              $copyright_url )."</p>";
168         }
169    }
170
171     if ($info{maintainers}) {
172         my $uploaders = $page->get_src( 'uploaders' );
173         if ($uploaders && @$uploaders) {
174             foreach (@$uploaders) {
175                 $_->[0] = encode_entities( $_->[0], '&<>' );
176             }
177             my ($maint_name, $maint_mail) = @{shift @$uploaders}; 
178             unless (@$uploaders) {
179                 $str .= "<p>\n".sprintf( _g( "%s is responsible for this Debian package." ).
180                                          "\n",
181                                          "<a href=\"mailto:$maint_mail\">$maint_name</a>" 
182                                          );
183             } else {
184                 my $up_str = "<a href=\"mailto:$maint_mail\">$maint_name</a>";
185                 my @uploaders_str;
186                 foreach (@$uploaders) {
187                     push @uploaders_str, "<a href=\"mailto:$_->[1]\">$_->[0]</a>";
188                 }
189                 my $last_up = pop @uploaders_str;
190                 $up_str .= ", ".join ", ", @uploaders_str if @uploaders_str;
191                 $up_str .= sprintf( _g( " and %s are responsible for this Debian package." ), $last_up );
192                 $str .= "<p>\n$up_str ";
193             }
194         }
195
196         $str .= sprintf( _g( "See the <a href=\"%s\">developer information for %s</a>." )."</p>", $QA_URL.$source, $name ) if $source;
197     }
198
199     if ($info{search}) {
200         my $encodedname = uri_escape( $name );
201         my $search_url = $is_source ? "$ROOT/source" : $ROOT;
202         $str .= "<p>".sprintf( _g( "Search for <a href=\"%s\">other versions of %s</a>" ),
203             "$search_url/$encodedname", $name )."</p>\n";
204     }
205
206     $str .= "</div> <!-- end pmoreinfo -->\n";
207     return $str;
208 }
209
210 sub dep_item {
211     my ( $suite, $name, $info, $desc ) = @_;
212     my ($link, $post_link) = ('', '');
213     if ($suite) {
214         $link = "<a href=\"".make_url($name,'',{suite=>$suite,source=>undef})."\">";
215         $post_link = '</a>';
216     }
217     if ($info) {
218         $info = " $info";
219     } else {
220         $info = '';
221     }
222     if ($desc) {
223         $desc = "</dt><dd>$desc</dd>";
224     } else {
225         $desc = '</dt>';
226     }
227
228     return "$link$name$post_link$info$desc";
229 } # end dep_item
230
231 sub provides_string {
232     my ($suite, $entry, $also) = @_;
233     my %tmp = map { $_ => 1 } split /\s/, $entry;
234     my @provided_by = keys %tmp; # weed out duplicates
235     my $short_desc = $also ? _g("also a virtual package provided by ")
236         : _g("virtual package provided by ");
237     if (@provided_by < 10) {
238         $short_desc .= join( ', ',map { "<a href=\"".make_url($_,'',{suite=>$suite,source=>undef})."\">$_</a>" } @provided_by);
239     } else {
240         $short_desc .= sprintf( _g("%s packages"), scalar(@provided_by));
241     }
242     return $short_desc;
243 }
244
245 sub print_deps {
246     my ( $packages, $opts, $pkg, $relations, $type) = @_;
247     my %dep_type = ('depends' => 'dep', 'recommends' => 'rec', 
248                     'suggests' => 'sug', 'build-depends' => 'adep',
249                     'build-depends-indep' => 'idep' );
250     my $res = "<ul class=\"ul$dep_type{$type}\">\n";
251     my $first = 1;
252     my $suite = $opts->{suite}[0];
253
254 #    use Data::Dumper;
255 #    debug( "print_deps called:\n".Dumper( $pkg, $relations, \$type ), 3 ) if DEBUG;
256
257     foreach my $rel (@$relations) {
258         my $is_old_pkgs = $rel->[0];
259         my @res_pkgs = ();
260
261         if ($is_old_pkgs)  {
262             $res .= "<dt>";
263         } else {
264             if ($first) {
265                 $res .= "<li>";
266                 $first = 0;
267             } else {
268                 $res .= "</dl></li>\n<li>";
269             }
270             $res .= "<dl><dt><img class=\"hidecss\" src=\"$ROOT/Pics/$dep_type{$type}.gif\" alt=\"[$dep_type{$type}]\"> ";
271         }
272
273         foreach my $rel_alt ( @$rel ) {
274             next unless ref($rel_alt);
275             my ( $p_name, $pkg_version, $arch_neg,
276                  $arch_str, $subsection, $available ) = @$rel_alt;
277
278             if ($arch_str ||= '') {
279                 if ($arch_neg) {
280                     $arch_str = " ["._g("not")." $arch_str]";
281                 } else {
282                     $arch_str = " [$arch_str]";
283                 }
284             }
285             $pkg_version = "($pkg_version)" if $pkg_version ||= '';
286             
287             my @results;
288             my %entries;
289             my $entry = $entries{$p_name} ||
290                 read_entry_simple( $packages, $p_name, $opts->{h_archives}, $suite);
291             my $short_desc = $entry->[-1];
292             my $arch = $entry->[3];
293             my $archive = $entry->[1];
294             my $p_suite = $entry->[2];
295             if ( $short_desc ) {
296                 if ( $is_old_pkgs ) {
297                     push @res_pkgs, dep_item( $p_suite,
298                                               $p_name, "$pkg_version$arch_str" );
299                 } elsif (defined $entry->[1]) {
300                     $entries{$p_name} ||= $entry;
301                     $short_desc = encode_entities( $short_desc, "<>&\"" );
302                     $short_desc .= "<br>".provides_string( $p_suite,
303                                                            $entry->[0],
304                                                            1 )
305                         if defined $entry->[0];
306                     push @res_pkgs, dep_item( $p_suite,
307                                               $p_name, "$pkg_version$arch_str", $short_desc );
308                 } elsif (defined $entry->[0]) {
309                     $short_desc = provides_string( $p_suite,
310                                                    $entry->[0] );
311                     #FIXME: we don't handle virtual packages from
312                     # the fallback suite correctly here
313                     push @res_pkgs, dep_item( $suite,
314                                               $p_name, "$pkg_version$arch_str", $short_desc );
315                 }
316             } elsif ( $is_old_pkgs ) {
317                 push @res_pkgs, dep_item( undef, $p_name, "$pkg_version$arch_str" );
318             } else {
319                 my $short_desc = _g( "Package not available" );
320                 push @res_pkgs, dep_item( undef, $p_name, "$pkg_version$arch_str", $short_desc );
321             }
322             
323         }
324         
325         $res .= "\n".join( "<dt>"._g( "or" )." ", @res_pkgs )."\n";
326     }
327     if (@$relations) {
328         $res .= "</dl></li>\n";
329         $res .= "</ul>\n";
330     } else {
331         $res = "";
332     }
333     return $res;
334 } # end print_deps
335
336 my $ds_begin = '<dl>';
337 my $ds_item_desc  = '<dt>';
338 my $ds_item = ':</dt><dd>';
339 my $ds_item_end = '</dd>';
340 my $ds_end = '</dl>';
341 #           my $ds_begin = '<table><tbody>';
342 #           my $ds_item_desc  = '<tr><td>';
343 #           my $ds_item = '</td><td>';
344 #           my $ds_item_end = '</td></tr>';
345 #           my $ds_end = '</tbody></table>';
346
347 sub ds_begin {
348     return $ds_begin;
349 }
350 sub ds_item {
351     return "$ds_item_desc$_[0]$ds_item$_[1]$ds_item_end\n";
352 }
353 sub ds_end {
354     return $ds_end;
355 }
356
357 sub header {
358     my (%params) = @_;
359
360     my $DESC_LINE;
361     if (defined $params{desc}) {
362         $DESC_LINE = "<meta name=\"Description\" content=\"$params{desc}\">";
363     }
364     else {
365         $DESC_LINE = '';
366     }
367
368     my $title_keywords = $params{title_keywords} || $params{title} || '';
369     my $title_tag = $params{title_tag} || $params{title} || '';
370     my $title_in_header = $params{page_title} || $params{title} || '';
371     my $page_title = $params{page_title} || $params{title} || '';
372     my $meta = $params{meta} || '';
373
374     my $search_in_header = '';
375     $params{print_search_field} ||= "";
376     if ($params{print_search_field} eq 'packages') {
377         my %values = %{$params{search_field_values}};
378         my %checked_searchon = ( names => "",
379                                  all => "",
380                                  sourcenames => "",
381                                  contents => "");
382         $checked_searchon{$values{searchon}} = "checked=\"checked\"";
383         $checked_searchon{names} = "checked=\"checked\""
384                 if $values{searchon} eq 'default';
385         $search_in_header = <<MENU;
386 <form method="GET" action="$SEARCH_URL">
387 <div id="hpacketsearch">
388 <input type="text" size="30" name="keywords" value="" id="kw">
389 <input type="submit" value="%s">
390 <span style="font-size: 60%%"><a href="$SEARCH_PAGE#search_packages">%s</a></span>
391 <br>
392 <div style="font-size: 80%%">%s
393 <input type="radio" name="searchon" value="names" id="onlynames" $checked_searchon{names}>
394 <label for="onlynames">%s</label>&nbsp;&nbsp;
395 <input type="radio" name="searchon" value="all" id="descs" $checked_searchon{all}>
396 <label for="descs">%s</label>
397 <br>
398 <input type="radio" name="searchon" value="sourcenames" id="src" $checked_searchon{sourcenames}>
399 <label for="src">%s</label>
400 <input type="radio" name="searchon" value="contents" id="conts" $checked_searchon{contents}>
401 <label for="conts">%s</label>
402 </div>
403 </div> <!-- end hpacketsearch -->
404 </form>
405 MENU
406 ;
407         $search_in_header = sprintf( $search_in_header,
408                                      _g( 'Search' ),
409                                      _g( 'Full options' ),
410                                      _g( 'Search on:'),
411                                      _g( 'Package Names' ),
412                                      _g( 'Descriptions' ),
413                                      _g( 'Source package names' ),
414                                      _g( 'Package contents' ));
415 #     } elsif ($params{print_search_field} eq 'contents') {
416 #       my %values = %{$params{search_field_values}};
417 #       my %checked_searchmode = ( searchfiles => "",
418 #                                  searchfilesanddirs => "",
419 #                                  searchword => "",
420 #                                  filelist => "", );
421 #       $checked_searchmode{$values{searchmode}} = "checked=\"checked\"";
422 #       $search_in_header = <<MENU;
423 # <form method="GET" action="$CONTENTS_SEARCH_CGI">
424 # <div id="hpacketsearch">
425 # <input type="hidden" name="debug" value="$values{debug}" />
426 # <input type="hidden" name="version" value="$values{version}" />
427 # <input type="hidden" name="arch" value="$values{arch}" />
428 # <input type="hidden" name="case" value="$values{case}" />
429 # <input type="text" size="30" name="word" id="keyword" value="$values{keyword}">&nbsp;
430 # <input type="submit" value="Search">
431 # <span style="font-size: 60%"><a href="$SEARCH_PAGE#search_contents">Full options</a></span>
432 # <br>
433 # <div style="font-size: 80%">Display:
434 # <input type=radio name="searchmode" value="searchfiles" id="searchfiles" $checked_searchmode{searchfiles}>
435 # <label for="searchfiles">files</label>
436 # <input type=radio name="searchmode" value="searchfilesanddirs" id="searchfilesanddirs" $checked_searchmode{searchfilesanddirs}>
437 # <label for="searchfilesanddirs">files &amp; directories</label>
438 # <br>
439 # <input type=radio name="searchmode" value="searchword" id="searchword" $checked_searchmode{searchword}>
440 # <label for="searchword">subword matching</label>
441 # <input type=radio name="searchmode" value="filelist" id="filelist" $checked_searchmode{filelist}>
442 # <label for="filelist">content list</label>
443 # </div>
444 # </div> <!-- end hpacketsearch -->
445 # </form>
446 # MENU
447 # ;
448     }
449
450     my $keywords = $params{keywords} || '';
451     my $KEYWORDS_LINE = "<meta name=\"Keywords\" content=\"debian, $keywords $title_keywords\">";
452     
453     my $LANG = $params{lang};
454     my $charset = get_charset($LANG);
455     my $txt = <<HEAD;
456 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
457 <html lang="$LANG">
458 <head>
459 <title>Debian -- $title_tag</title>
460 <link rev="made" href="mailto:$WEBMASTER_MAIL">
461 <meta http-equiv="Content-Type" content="text/html; charset=$charset">
462 <meta name="Author" content="Debian Webmaster, $WEBMASTER_MAIL">
463 $KEYWORDS_LINE
464 $DESC_LINE
465 $meta
466 <link href="$ROOT/debian.css" rel="stylesheet" type="text/css" media="all">
467 <link href="$ROOT/packages.css" rel="stylesheet" type="text/css" media="all">
468 </head>
469 <body>
470 <div id="header">
471    <div id="upperheader">
472    <div id="logo">
473   <a href="$HOME/"><img src="$HOME/logos/openlogo-nd-50.png" alt="" /></a>
474 HEAD
475 ;
476
477     $txt .= img( "$HOME/", "", "Pics/debian.png", _g( "Debian Project" ),
478                  width => 179, height => 61 );
479     $txt .= <<HEADEND;
480
481 </div> <!-- end logo -->
482 HEADEND
483 ;
484
485     $txt .= <<NAVBEGIN;
486 $search_in_header
487 </div> <!-- end upperheader -->
488
489 NAVBEGIN
490 ;
491     $txt .= "<p class=\"hidecss\"><a href=\"\#inner\">" . _g("Skip Site Navigation")."</a></p>\n";
492     $txt .= "<div id=\"navbar\">\n<ul>".
493         "<li><a href=\"$HOME/intro/about\">"._g( "About&nbsp;Debian" )."</a></li>\n".
494         "<li><a href=\"$HOME/News/\">"._g( "News" )."</a></li>\n".
495         "<li><a href=\"$HOME/distrib/\">"._g( "Getting&nbsp;Debian" )."</a></li>\n".
496         "<li><a href=\"$HOME/support\">"._g( "Support" )."</a></li>\n".
497         "<li><a href=\"$HOME/devel/\">"._g( "Development" )."</a></li>\n".
498         "<li><a href=\"$HOME/sitemap\">"._g( "Site map" )."</a></li>\n".
499         "<li><a href=\"http://search.debian.org/\">"._g( "Search" )."</a></li>\n";
500     $txt .= "</ul>\n";
501     $txt .= <<ENDNAV;
502 </div> <!-- end navbar -->
503 </div> <!-- end header -->
504 ENDNAV
505 ;
506     $txt .= <<BEGINCONTENT;
507 <div id="outer">
508 <div id="inner">
509
510 BEGINCONTENT
511 ;
512     if ($params{print_title}) {
513         $txt .= "<h1>$page_title</h1>\n";
514     }
515
516     return $txt;
517 }
518
519 sub trailer {
520     my ($ROOT, $NAME, $LANG, @USED_LANGS) = @_;
521     my $txt = "</div> <!-- end inner -->\n<div id=\"footer\">\n";
522     my $langs = languages( $NAME, $LANG, @USED_LANGS );
523     my $bl_class = $langs ? ' class="bordertop"' : "";
524     $txt .=
525         $langs.
526         "\n<hr class=\"hidecss\">\n" .
527         "<p$bl_class>".
528         sprintf( _g( "Back to: <a href=\"%s/\">Debian Project homepage</a> || <a href=\"%s/\">Packages search page</a>" ), $HOME, $ROOT ).
529         "</p>\n<hr class=\"hidecss\">\n".
530         "<div id=\"fineprint\" class=\"bordertop\"><p>".
531         sprintf( _g( "To report a problem with the web site, e-mail <a href=\"mailto:%s\">%s</a>. For other contact information, see the Debian <a href=\"%s/contact\">contact page</a>." ), $CONTACT_MAIL, $CONTACT_MAIL, $HOME).
532         "</p>\n".
533         "<p>". _g( "Last Modified: " ). gmtime().
534         "<br>\n".
535         sprintf( _g( "Copyright &copy; 1997-2005 <a href=\"http://www.spi-inc.org\">SPI</a>; See <a href=\"%s/license\">license terms</a>." ), "$HOME/" )."<br>\n".
536         _g( "Debian is a registered trademark of Software in the Public Interest, Inc." ).
537         "</div> <!-- end fineprint -->\n".
538         "</div> <!-- end footer -->\n".
539         "</div> <!-- end outer -->\n".
540         "</body>\n</html>\n";
541
542     return $txt;
543 }
544
545 sub languages {
546     my ( $name, $lang, @used_langs ) = @_;
547     
548     my $str = "";
549     
550     if (@used_langs) {
551         $str .= "<hr class=\"hidecss\">\n";
552         $str .= "<!--UdmComment-->\n<p>\n";
553         $str .= _g( "This page is also available in the following languages:\n" );
554         $str .= "</p><p class=\"navpara\">\n";
555         
556         my @printed_langs = ();
557         foreach (@used_langs) {
558             next if $_ eq $lang; # Never print the current language
559             unless (get_selfname($_)) { warn "missing language $_"; next } #DEBUG
560             push @printed_langs, $_;
561         }
562         return "" unless scalar @printed_langs;
563         # Sort on uppercase to work with languages which use lowercase initial
564         # letters.
565         foreach my $cur_lang (sort langcmp @printed_langs) {
566             my $tooltip = dgettext( "langs", get_language_name($cur_lang) );
567             $str .= "<a href=\"$name.$cur_lang.html\" title=\"$tooltip\" hreflang=\"$cur_lang\" lang=\"$cur_lang\" rel=\"alternate\">".get_selfname($cur_lang);
568             $str .= " (".get_transliteration($cur_lang).")" if defined get_transliteration($cur_lang);
569             $str .= "</a>\n";
570         }
571         $str .= "\n</p><p>\n";
572         $str .= sprintf( _g( "How to set <a href=\"%s\">the default document language</a>" ), $CN_HELP_URL )."</p>";
573         $str .= "\n<!--/UdmComment-->\n";
574     }
575     
576     return $str;
577 }
578
579 1;