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