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