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