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