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::Util;
  10 use Packages::I18N::Locale;
  11 use Packages::I18N::Languages;
  12 use Packages::I18N::LanguageNames;
  13 use Generated::Strings qw( gettext dgettext );
  14
  15 our @ISA = qw( Exporter );
  16 our @EXPORT = qw( header title trailer file_changed time_stamp
  17                   read_md5_hash write_md5_hash simple_menu
  18                   ds_begin ds_item ds_end note title marker pdesc
  19                   pdeplegend pkg_list pmoreinfo );
  20
  21 our $HOME = "http://www.debian.org";
  22 our $CONTACT_MAIL = 'debian-www@lists.debian.org';
  23 our $WEBMASTER_MAIL = 'webmaster@debian.org';
  24 our $SEARCH_PAGE = "http://packages.debian.org/";
  25 our $CGI_ROOT = "http://packages.debian.org/cgi-bin";
  26 our $CN_HELP_URL = "${HOME}/intro/cn";
  27 our $CHANGELOG_URL = '/changelogs';
  28 our $COPYRIGHT_URL = '/changelogs';
  29 our $SEARCH_URL = '/cgi-bin/search_packages.pl?searchon=names&amp;version=all&amp;exact=1&amp;keywords=';
  30 our $SRC_SEARCH_URL = '/cgi-bin/search_packages.pl?searchon=sourcenames&amp;version=all&amp;exact=1&amp;keywords=';
  31 our $BUG_URL = 'http://bugs.debian.org/';
  32 our $SRC_BUG_URL = 'http://bugs.debian.org/src:';
  33 our $QA_URL = 'http://packages.qa.debian.org/';
  34
  35
  36 my %img_trans = ( pt_BR => "pt", pt_PT => "pt", sv_SE => "sv" );
  37
  38 sub img {
  39     my ( $root, $url, $src, $alt, %attr ) = @_;
  40     my @attr;
  41
  42     foreach my $a ( keys %attr ) {
  43         push @attr, "$a=\"$attr{$a}\"";
  44     }
  45
  46     return "<a href=\"$root$url\"><img src=\"$root$src\" alt=\"$alt\" @attr></a>";
  47 }
  48
  49 sub simple_menu {
  50     my $str = "";
  51     foreach my $entry (@_) {
  52         $str .= "[&nbsp;$entry->[0] <a title=\"$entry->[1]\" href=\"$entry->[2]\">$entry->[3]</a>&nbsp;]\n";
  53     }
  54     return $str;
  55 }
  56
  57 sub title {
  58     return "<h1>$_[0]</h1>\n";
  59 }
  60
  61 sub marker {
  62     return "[<span class=\"pred\">$_[0]</span>]";
  63 }
  64
  65 sub note {
  66     my ( $title, $note ) = @_;
  67     my $str = "";
  68
  69     if ($note) {
  70         $str .= "<h2 class=\"pred\">$title</h2>";
  71     } else {
  72         $note = $title;
  73     }
  74     $str .= "<p>$note</p>";
  75     return $str;
  76 }
  77
  78 sub pdesc {
  79     my ( $short_desc, $long_desc ) = @_;
  80     my $str = "";
  81
  82     $str .= "<div id=\"pdesc\">\n";
  83     $str .= "<h2>$short_desc</h2>\n";
  84
  85     $str .= "<p>$long_desc\n";
  86     $str .= "</div> <!-- end pdesc -->\n";
  87
  88     return $str;
  89 }
  90
  91 sub pdeplegend {
  92     my $str = "<table border=\"1\" summary=\"legend\"><tr>\n";
  93
  94     foreach my $entry (@_) {
  95         $str .= "<td><img src=\"../../Pics/$entry->[0].gif\" alt=\"[$entry->[0]]\" width=\"16\" height=\"16\">= $entry->[1]</td>";
  96     }
  97
  98     $str .= "\n</tr></table>\n";
  99     return $str;
 100 }
 101
 102 sub pkg_list {
 103     my ( $pkgs, $lang, $env ) = @_;
 104
 105     my $str = "";
 106     foreach my $p ( @$pkgs ) {
 107         my $p_pkg = $env->{db}->get_pkg( $p );
 108
 109         if ( $p_pkg ) {
 110             if ($p_pkg->is_virtual) {
 111                 $str .= "<dt><a href=\"../virtual/$p\">$p</a></dt>\n".
 112                     "\t<dd>".gettext("Virtual package")."</dd>\n";
 113             } else {
 114                 my %subsections = $p_pkg->get_arch_fields( 'section',
 115                                                            $env->{archs} );
 116                 my $subsection = $subsections{max_unique};
 117                 my %desc_md5s = $p_pkg->get_arch_fields( 'description-md5',
 118                                                          $env->{archs} );
 119                 my $short_desc = conv_desc( $lang,
 120                                             encode_entities( $env->{db}->get_short_desc( $desc_md5s{max_unique}, $lang ), "<>&\"" ) );
 121                 $str .= "<dt><a href=\"../$subsection/$p\">$p</a></dt>\n".
 122                     "\t<dd>$short_desc</dd>\n";
 123             }
 124         } else {
 125             $str .= "<dt>$p</dt>\n\t<dd>".gettext("Not available")."</dd>\n";
 126         }
 127     }
 128     if ($str) {
 129         $str = "<dl>$str</dl>\n";
 130     }
 131
 132     return $str;
 133 }
 134
 135 sub pmoreinfo {
 136     my %info = @_;
 137
 138     my $name = $info{name} or return;
 139     my $env = $info{env} or return;
 140     my $d = $info{data} or return;
 141     my $is_source = $info{is_source};
 142
 143     my $str = "<div id=\"pmoreinfo\">";
 144     $str .= sprintf( "<h2>".gettext( "More Information on %s" )."</h2>",
 145                      $name );
 146
 147
 148     if ($info{bugreports}) {
 149         my $bug_url = $is_source ? $SRC_BUG_URL : $BUG_URL;
 150         $str .= "<p>\n".sprintf( gettext( "Check for <a href=\"%s\">Bug Reports</a> about %s." )."<br>\n",
 151                          $bug_url.$name, $name );
 152     }
 153
 154     if ($info{sourcedownload}) {
 155         $str .= gettext( "Source Package:" );
 156         $str .= " <a href=\"../source/$d->{src_name}\">$d->{src_name}</a>, ".
 157             gettext( "Download" ).":\n";
 158
 159         unless ($d->{src_files}) {
 160             $str .= gettext( "Not found" );
 161         } else {
 162             foreach( @{$d->{src_files}} ) {
 163                 my ($src_file_md5, $src_file_size, $src_file_name) = @$_;
 164                 if ($d->{is_security}) {
 165                     $str .= "<a href=\"$env->{opts}{security_site}/$d->{src_directory}/$src_file_name\">[";
 166                 } elsif ($d->{is_volatile}) {
 167                     $str .= "<a href=\"$env->{opts}{volatile_site}/$d->{src_directory}/$src_file_name\">[";
 168                 } elsif ($d->{is_nonus}) {
 169                     $str .= "<a href=\"$env->{opts}{nonus_site}/$d->{src_directory}/$src_file_name\">[";
 170                 } else {
 171                     $str .= "<a href=\"$env->{opts}{debian_site}/$d->{src_directory}/$src_file_name\">[";
 172                 }
 173                 if ($src_file_name =~ /dsc$/) {
 174                     $str .= "dsc";
 175                 } else {
 176                     $str .= $src_file_name;
 177                 }
 178                 $str .= "]</a>\n";
 179             }
 180         }
 181 #           $package_page .= sprintf( gettext( " (These sources are for version %s)\n" ), $src_version )
 182 #               if ($src_version ne $version) && !$src_version_given_in_control;
 183     }
 184
 185     if ($info{changesandcopy}) {
 186         if ( $d->{src_directory} ) {
 187             my $src_dir = $d->{src_directory};
 188             (my $src_basename = $d->{src_version}) =~ s,^\d+:,,; # strip epoche
 189             $src_basename = "$d->{src_name}_$src_basename";
 190             $src_dir =~ s,pool/updates,pool,o;
 191             $src_dir =~ s,pool/non-US,pool,o;
 192             $str .= "<br>".sprintf( gettext( "View the <a href=\"%s\">Debian changelog</a>" ),
 193                                     "$CHANGELOG_URL/$src_dir/$src_basename/changelog" )."<br>\n";
 194             my $copyright_url = "$COPYRIGHT_URL/$src_dir/$src_basename/";
 195             $copyright_url .= ( $is_source ? 'copyright' : "$name.copyright" );
 196
 197             $str .= sprintf( gettext( "View the <a href=\"%s\">copyright file</a>" ),
 198                              $copyright_url )."</p>";
 199         }
 200     }
 201
 202     if ($info{maintainers}) {
 203         my @uploaders = @{$d->{uploaders}};
 204         foreach (@uploaders) {
 205             $_->[0] = encode_entities( $_->[0], '&<>' );
 206         }
 207         my ($maint_name, $maint_mail ) = @{shift @uploaders};
 208         unless (@uploaders) {
 209             $str .= "<p>\n".sprintf( gettext( "%s is responsible for this Debian package." ).
 210                                      "\n",
 211                                      "<a href=\"mailto:$maint_mail\">$maint_name</a>"
 212                                      );
 213         } else {
 214             my $up_str = "<a href=\"mailto:$maint_mail\">$maint_name</a>";
 215             my @uploaders_str;
 216             foreach (@uploaders) {
 217                 push @uploaders_str, "<a href=\"mailto:$_->[1]\">$_->[0]</a>";
 218             }
 219             my $last_up = pop @uploaders_str;
 220             $up_str .= ", ".join ", ", @uploaders_str if @uploaders_str;
 221             $up_str .= sprintf( gettext( " and %s are responsible for this Debian package." ), $last_up );
 222             $str .= "<p>\n$up_str ";
 223         }
 224
 225         $str .= sprintf( gettext( "See the <a href=\"%s\">developer information for %s</a>." )."</p>", $QA_URL.$d->{src_name}, $name );
 226     }
 227
 228     if ($info{search}) {
 229         my $encodedname = uri_escape( $name );
 230         my $search_url = $is_source ? $SRC_SEARCH_URL : $SEARCH_URL;
 231         $str .= "<p>".sprintf( gettext( "Search for <a href=\"%s\">other versions of %s</a>" ), $search_url.$encodedname, $name )."</p>\n";
 232     }
 233
 234     $str .= "</div> <!-- end pmoreinfo -->\n";
 235     return $str;
 236 }
 237
 238 my $ds_begin = '<dl>';
 239 my $ds_item_desc  = '<dt>';
 240 my $ds_item = ':</dt><dd>';
 241 my $ds_item_end = '</dd>';
 242 my $ds_end = '</dl>';
 243 #           my $ds_begin = '<table><tbody>';
 244 #           my $ds_item_desc  = '<tr><td>';
 245 #           my $ds_item = '</td><td>';
 246 #           my $ds_item_end = '</td></tr>';
 247 #           my $ds_end = '</tbody></table>';
 248
 249 sub ds_begin {
 250     return $ds_begin;
 251 }
 252 sub ds_item {
 253     return "$ds_item_desc$_[0]$ds_item$_[1]$ds_item_end\n";
 254 }
 255 sub ds_end {
 256     return $ds_end;
 257 }
 258
 259 sub header {
 260     my (%params) = @_;
 261
 262     my $DESC_LINE;
 263     if (defined $params{desc}) {
 264         $DESC_LINE = "<meta name=\"Description\" content=\"$params{desc}\">";
 265     }
 266     else {
 267         $DESC_LINE = '';
 268     }
 269
 270     my $title_keywords = $params{title_keywords} || $params{title} || '';
 271     my $title_tag = $params{title_tag} || $params{title} || '';
 272     my $title_in_header = $params{page_title} || $params{title} || '';
 273     my $page_title = $params{page_title} || $params{title} || '';
 274     my $meta = $params{meta} || '';
 275
 276     if ($params{print_title_above}) {
 277         $title_in_header = "<h1>$title_in_header</h1>";
 278     } else {
 279         $title_in_header = '';
 280     }
 281
 282     my $search_in_header = '';
 283     $params{print_search_field} ||= "";
 284     if ($params{print_search_field} eq 'packages') {
 285         my %values = %{$params{search_field_values}};
 286         my %checked_searchon = ( names => "",
 287                                  all => "",
 288                                  sourcenames => "", );
 289         $checked_searchon{$values{searchon}} = "checked=\"checked\"";
 290         $search_in_header = <<MENU;
 291 <form method="GET" action="$CGI_ROOT/search_packages.pl">
 292 <div id="hpacketsearch">
 293 <input type="hidden" name="suite" value="$values{suite}">
 294 <input type="hidden" name="subword" value="$values{subword}">
 295 <input type="hidden" name="exact" value="$values{exact}">
 296 <input type="hidden" name="arch" value="$values{arch}">
 297 <input type="hidden" name="section" value="$values{section}">
 298 <input type="hidden" name="case" value="$values{case}">
 299 <input type="text" size="30" name="keywords" value="$values{keywords}" id="kw">
 300 <input type="submit" value="Search">
 301 <span style="font-size: 60%"><a href="$SEARCH_PAGE#search_packages">Full options</a></span>
 302 <br>
 303 <div style="font-size: 80%">Search on:
 304 <input type="radio" name="searchon" value="names" id="onlynames" $checked_searchon{names}>
 305 <label for="onlynames">Package names only</label>&nbsp;&nbsp;
 306 <input type="radio" name="searchon" value="all" id="descs" $checked_searchon{all}>
 307 <label for="descs">Descriptions</label>
 308 <br>
 309 <input type="radio" name="searchon" value="sourcenames" id="src" $checked_searchon{sourcenames}>
 310 <label for="src">Source package names</label>
 311 </div>
 312 </div> <!-- end hpacketsearch -->
 313 </form>
 314 MENU
 315 ;
 316     } elsif ($params{print_search_field} eq 'contents') {
 317         my %values = %{$params{search_field_values}};
 318         my %checked_searchmode = ( searchfiles => "",
 319                                    searchfilesanddirs => "",
 320                                    searchword => "",
 321                                    filelist => "", );
 322         $checked_searchmode{$values{searchmode}} = "checked=\"checked\"";
 323         $search_in_header = <<MENU;
 324 <form method="GET" action="$CGI_ROOT/search_contents.pl">
 325 <div id="hpacketsearch">
 326 <input type="hidden" name="version" value="$values{version}" />
 327 <input type="hidden" name="arch" value="$values{arch}" />
 328 <input type="hidden" name="case" value="$values{case}" />
 329 <input type="text" size="30" name="word" id="keyword" value="$values{keyword}">&nbsp;
 330 <input type="submit" value="Search">
 331 <span style="font-size: 60%"><a href="$SEARCH_PAGE#search_contents">Full options</a></span>
 332 <br>
 333 <div style="font-size: 80%">Display:
 334 <input type=radio name="searchmode" value="searchfiles" id="searchfiles" $checked_searchmode{searchfiles}>
 335 <label for="searchfiles">files</label>
 336 <input type=radio name="searchmode" value="searchfilesanddirs" id="searchfilesanddirs" $checked_searchmode{searchfilesanddirs}>
 337 <label for="searchfilesanddirs">files &amp; directories</label>
 338 <br>
 339 <input type=radio name="searchmode" value="searchword" id="searchword" $checked_searchmode{searchword}>
 340 <label for="searchword">subword matching</label>
 341 <input type=radio name="searchmode" value="filelist" id="filelist" $checked_searchmode{filelist}>
 342 <label for="filelist">content list</label>
 343 </div>
 344 </div> <!-- end hpacketsearch -->
 345 </form>
 346 MENU
 347 ;
 348     }
 349
 350     my $keywords = $params{keywords} || '';
 351     my $KEYWORDS_LINE = "<meta name=\"Keywords\" content=\"debian, $keywords $title_keywords\">";
 352
 353     my $LANG = $params{lang};
 354     my $img_lang = $img_trans{$LANG} || $LANG;
 355     my $charset = get_charset($LANG);
 356     my $txt = <<HEAD;
 357 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 358 <html lang="$LANG">
 359 <head>
 360 <title>Debian -- $title_tag</title>
 361 <link rev="made" href="mailto:$WEBMASTER_MAIL">
 362 <meta http-equiv="Content-Type" content="text/html; charset=$charset">
 363 <meta name="Author" content="Debian Webmaster, $WEBMASTER_MAIL">
 364 $KEYWORDS_LINE
 365 $DESC_LINE
 366 $meta
 367 <link href="$HOME/debian.css" rel="stylesheet" type="text/css" media="all">
 368 </head>
 369 <body>
 370 <div id="header">
 371    <div id="upperheader">
 372    <div id="logo">
 373   <a href="$HOME/"><img src="$HOME/logos/openlogo-nd-50.png" alt="" /></a>
 374 HEAD
 375 ;
 376
 377     $txt .= img( "$HOME/", "", "Pics/debian.png", gettext( "Debian Project" ),
 378                  width => 179, height => 61 );
 379     $txt .= <<HEADEND;
 380
 381 </div> <!-- end logo -->
 382 HEADEND
 383 ;
 384
 385     $txt .= <<NAVBEGIN;
 386 $search_in_header
 387 </div> <!-- end upperheader -->
 388
 389 NAVBEGIN
 390 ;
 391 # $title_in_header
 392     $txt .= "<p class=\"hidecss\"><a href=\"\#inner\">" . gettext("Skip Site Navigation")."</a></p>\n";
 393     $txt .= "<div id=\"navbar\">\n<ul>".
 394         "<li><a href=\"$HOME/intro/about\">".gettext( "About&nbsp;Debian" )."</a></li>\n".
 395         "<li><a href=\"$HOME/News/\">".gettext( "News" )."</a></li>\n".
 396         "<li><a href=\"$HOME/distrib/\">".gettext( "Getting&nbsp;Debian" )."</a></li>\n".
 397         "<li><a href=\"$HOME/support\">".gettext( "Support" )."</a></li>\n".
 398         "<li><a href=\"$HOME/devel/\">".gettext( "Development" )."</a></li>\n".
 399         "<li><a href=\"$HOME/sitemap\">".gettext( "Site map" )."</a></li>\n".
 400         "<li><a href=\"http://search.debian.org/\">".gettext( "Search" )."</a></li>\n";
 401     $txt .= "</ul>\n";
 402     $txt .= <<ENDNAV;
 403 </div> <!-- end navbar -->
 404 </div> <!-- end header -->
 405 ENDNAV
 406 ;
 407     $txt .= <<BEGINCONTENT;
 408 <div id="outer">
 409 <div id="inner">
 410
 411 BEGINCONTENT
 412 ;
 413     if ($params{print_title_above}) {
 414         $txt .= "<h1>$page_title</h1>\n";
 415     }
 416     if ($params{print_title_below}) {
 417         $txt .= "<h1>$page_title</h1>\n";
 418     }
 419
 420     return $txt;
 421 }
 422
 423 sub trailer {
 424     my ($ROOT, $NAME, $LANG, @USED_LANGS) = @_;
 425     my $txt = "</div> <!-- end inner -->\n<div id=\"footer\">\n";
 426     my $langs = languages( $NAME, $LANG, @USED_LANGS );
 427     my $bl_class = $langs ? ' class="bordertop"' : "";
 428     $txt .=
 429         $langs.
 430         "\n<hr class=\"hidecss\">\n" .
 431         "<p$bl_class>".
 432         sprintf( gettext( "Back to: <a href=\"%s/\">Debian Project homepage</a> || <a href=\"%s/\">Packages search page</a>" ), $HOME, $ROOT ).
 433         "</p>\n<hr class=\"hidecss\">\n".
 434         "<div id=\"fineprint\" class=\"bordertop\"><p>".
 435         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).
 436         "</p>\n".
 437         "<p>". gettext( "Last Modified: " ). "LAST_MODIFIED_DATE".
 438         "<br>\n".
 439         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".
 440         gettext( "Debian is a registered trademark of Software in the Public Interest, Inc." ).
 441         "</div> <!-- end fineprint -->\n".
 442         "</div> <!-- end footer -->\n".
 443         "</div> <!-- end outer -->\n".
 444         "</body>\n</html>\n";
 445
 446     return $txt;
 447 }
 448
 449 sub languages {
 450     my ( $name, $lang, @used_langs ) = @_;
 451
 452     my $str = "";
 453
 454     if (@used_langs) {
 455         $str .= "<hr class=\"hidecss\">\n";
 456         $str .= "<!--UdmComment-->\n<p>\n";
 457         $str .= gettext( "This page is also available in the following languages:\n" );
 458         $str .= "</p><p class=\"navpara\">\n";
 459
 460         my @printed_langs = ();
 461         foreach (@used_langs) {
 462             next if $_ eq $lang; # Never print the current language
 463             unless (get_selfname($_)) { warn "missing language $_"; next } #DEBUG
 464             push @printed_langs, $_;
 465         }
 466         return "" unless scalar @printed_langs;
 467         # Sort on uppercase to work with languages which use lowercase initial
 468         # letters.
 469         foreach my $cur_lang (sort langcmp @printed_langs) {
 470             my $tooltip = dgettext( "langs", get_language_name($cur_lang) );
 471             $str .= "<a href=\"$name.$cur_lang.html\" title=\"$tooltip\" hreflang=\"$cur_lang\" lang=\"$cur_lang\" rel=\"alternate\">".get_selfname($cur_lang);
 472             $str .= " (".get_transliteration($cur_lang).")" if defined get_transliteration($cur_lang);
 473             $str .= "</a>\n";
 474         }
 475         $str .= "\n</p><p>\n";
 476         $str .= sprintf( gettext( "How to set <a href=\"%s\">the default document language</a></p>" ), $CN_HELP_URL );
 477         $str .= "\n<!--/UdmComment-->\n";
 478     }
 479
 480     return $str;
 481 }
 482
 483 1;