Patch from Galen Charlton, removing $Id$ $Log$ and $Revision$ from files
[koha.git] / C4 / Output.pm
index 38212fa..d4ae30f 100644 (file)
-package C4::Output; #asummes C4/Output
+package C4::Output;
 
 #package to deal with marking up output
 #You will need to edit parts of this pm
 #set the value of path to be where your html lives
 
+# Copyright 2000-2002 Katipo Communications
+#
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
+# Suite 330, Boston, MA  02111-1307 USA
+
+
+# NOTE: I'm pretty sure this module is deprecated in favor of
+# templates.
+
 use strict;
 require Exporter;
 
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+use C4::Context;
+use HTML::Template::Pro;
 
-# set the version for version checking
-$VERSION = 0.01;
+use vars qw($VERSION @ISA @EXPORT);
 
-@ISA = qw(Exporter);
-@EXPORT = qw(&startpage &endpage &mktablehdr &mktableft &mktablerow &mklink
-&startmenu &endmenu &mkheadr &center &endcenter &mkform &mkform2 &bold
-&gotopage &mkformnotable &mkform3);
-%EXPORT_TAGS = ( );     # eg: TAG => [ qw!name1 name2! ],
+# set the version for version checking
+$VERSION = 3.00;
 
-# your exported package globals go here,
-# as well as any optionally exported functions
+=head1 NAME
 
-@EXPORT_OK   = qw($Var1 %Hashit);
+C4::Output - Functions for managing templates
 
+=head1 FUNCTIONS
 
-# non-exported package globals go here
-use vars qw(@more $stuff);
+=over 2
 
-# initalize package globals, first exported ones
+=cut
 
-my $Var1   = '';
-my %Hashit = ();
+@ISA    = qw(Exporter);
+push @EXPORT, qw(
+  &themelanguage &gettemplate setlanguagecookie pagination_bar
+);
 
+#Output
+push @EXPORT, qw(
+    &output_html_with_http_headers
+);
 
-# then the others (which are still accessible as $Some::Module::stuff)
-my $stuff  = '';
-my @more   = ();
 
-# all file-scoped lexicals must be created before
-# the functions below that use them.
+#FIXME: this is a quick fix to stop rc1 installing broken
+#Still trying to figure out the correct fix.
+my $path = C4::Context->config('intrahtdocs') . "/prog/en/includes/";
 
-#
-# Change this value to reflect where you will store your includes
-#
-my %configfile;
-open (KC, "/etc/koha.conf");
-while (<KC>) {
- chomp;
- (next) if (/^\s*#/);
- if (/(.*)\s*=\s*(.*)/) {
-   my $variable=$1;
-   my $value=$2;
-   # Clean up white space at beginning and end
-   $variable=~s/^\s*//g;
-   $variable=~s/\s*$//g;
-   $value=~s/^\s*//g;
-   $value=~s/\s*$//g;
-   $configfile{$variable}=$value;
- }
+#---------------------------------------------------------------------------------------------------------
+# FIXME - POD
+sub gettemplate {
+    my ( $tmplbase, $interface, $query ) = @_;
+    if ( !$query ) {
+        warn "no query in gettemplate";
+    }
+    my $htdocs;
+    if ( $interface ne "intranet" ) {
+        $htdocs = C4::Context->config('opachtdocs');
+    }
+    else {
+        $htdocs = C4::Context->config('intrahtdocs');
+    }
+    my $path = C4::Context->preference('intranet_includes') || 'includes';
+
+    #    warn "PATH : $path";
+    my ( $theme, $lang ) = themelanguage( $htdocs, $tmplbase, $interface, $query );
+    my $opacstylesheet = C4::Context->preference('opacstylesheet');
+    my $template       = HTML::Template::Pro->new(
+        filename          => "$htdocs/$theme/$lang/".($interface eq 'intranet'?"modules":"")."/$tmplbase",
+        die_on_bad_params => 1,
+        global_vars       => 1,
+        case_sensitive    => 1,
+        path              => ["$htdocs/$theme/$lang/$path"]
+    );
+
+    $template->param(
+        themelang => ( $interface ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' )
+          . "/$theme/$lang",
+        interface => ( $interface ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' ),
+        theme => $theme,
+        opacstylesheet      => $opacstylesheet,
+        opaccolorstylesheet => C4::Context->preference('opaccolorstylesheet'),
+        opacsmallimage      => C4::Context->preference('opacsmallimage'),
+        lang                => $lang
+    );
+
+    return $template;
 }
-my $path=$configfile{'includes'};
-($path) || ($path="/usr/local/www/hdl/htdocs/includes");
-
-
-# here's a file-private function as a closure,
-# callable as &$priv_func;  it cannot be prototyped.
-my $priv_func = sub {
-# stuff goes here.
-  };
-   
-# make all your functions, whether exported or not;
-sub startpage{
-  return("<html>\n");
+
+#---------------------------------------------------------------------------------------------------------
+# FIXME - POD
+sub themelanguage {
+    my ( $htdocs, $tmpl, $section, $query ) = @_;
+
+    #   if (!$query) {
+    #     warn "no query";
+    #   }
+    my $dbh = C4::Context->dbh;
+    my @languages;
+    my @themes;
+    if ( $section eq "intranet" ) {
+        @languages = split " ", C4::Context->preference("opaclanguages");
+        @themes    = split " ", C4::Context->preference("template");
+    }
+    else {
+
+      # we are in the opac here, what im trying to do is let the individual user
+      # set the theme they want to use.
+      # and perhaps the them as well.
+        my $lang = $query->cookie('KohaOpacLanguage');
+        if ($lang) {
+
+            push @languages, $lang;
+            @themes = split " ", C4::Context->preference("opacthemes");
+        }
+        else {
+            @languages = split " ", C4::Context->preference("opaclanguages");
+            @themes    = split " ", C4::Context->preference("opacthemes");
+        }
+    }
+
+    my ( $theme, $lang );
+
+ # searches through the themes and languages. First template it find it returns.
+ # Priority is for getting the theme right.
+  THEME:
+    foreach my $th (@themes) {
+        foreach my $la (@languages) {
+            for ( my $pass = 1 ; $pass <= 2 ; $pass += 1 ) {
+                $la =~ s/([-_])/ $1 eq '-'? '_': '-' /eg if $pass == 2;
+                if ( -e "$htdocs/$th/$la/".($section eq 'intranet'?"modules":"")."/$tmpl" ) {
+                    $theme = $th;
+                    $lang  = $la;
+                    last THEME;
+                }
+                last unless $la =~ /[-_]/;
+            }
+        }
+    }
+    if ( $theme and $lang ) {
+        return ( $theme, $lang );
+    }
+    else {
+        return ( 'prog', 'en' );
+    }
 }
 
-sub gotopage{
-  my ($target) = @_;
-  print "<br>goto target = $target<br>";
-  my $string = "<META HTTP-EQUIV=Refresh CONTENT=\"0;URL=http:$target\">";
-  return $string;
+sub setlanguagecookie {
+    my ( $query, $language, $uri ) = @_;
+    my $cookie = $query->cookie(
+        -name    => 'KohaOpacLanguage',
+        -value   => $language,
+        -expires => ''
+    );
+    print $query->redirect(
+        -uri    => $uri,
+        -cookie => $cookie
+    );
 }
 
+=item pagination_bar
 
-sub startmenu{
-  # edit the paths in here
-  my ($type)=@_;
-  if ($type eq 'issue') {
-    open (FILE,"$path/issues-top.inc") || die;
-  } elsif ($type eq 'opac') {
-    open (FILE,"$path/opac-top.inc") || die;
-  } elsif ($type eq 'member') {
-    open (FILE,"$path/members-top.inc") || die;
-  } elsif ($type eq 'acquisitions'){
-    open (FILE,"$path/acquisitions-top.inc")|| die;
-  } elsif ($type eq 'report'){
-    open (FILE,"$path/reports-top.inc") || die;
-  } elsif ($type eq 'circulation') {
-    open (FILE,"$path/circulation-top.inc") || die;
-  } else {
-    open (FILE,"$path/cat-top.inc") || die;
-  }
-  my @string=<FILE>;
-  close FILE;
-  my $count=@string;
-  #  $string[$count]="<BLOCKQUOTE>";
-  return @string;
-}
+   pagination_bar($base_url, $nb_pages, $current_page, $startfrom_name)
 
+Build an HTML pagination bar based on the number of page to display, the
+current page and the url to give to each page link.
 
-sub endmenu{
-  my ($type)=@_;
-  if ($type eq 'issue'){
-    open (FILE,"$path/issues-bottom.inc") || die;
-  } elsif ($type eq 'opac') {
-    open (FILE,"$path/opac-bottom.inc") || die;
-  } elsif ($type eq 'member') {
-    open (FILE,"$path/members-bottom.inc") || die;
-  } elsif ($type eq 'acquisitions') {
-    open (FILE,"$path/acquisitions-bottom.inc") || die;
-  } elsif ($type eq 'report') {
-    open (FILE,"$path/reports-bottom.inc") || die;
-  } elsif ($type eq 'circulation') {
-    open (FILE,"$path/circulation-bottom.inc") || die;
-  } else {
-    open (FILE,"$path/cat-bottom.inc") || die;
-  }
-  my @string=<FILE>;
-  close FILE;
-  return @string;
-}
+C<$base_url> is the URL for each page link. The
+C<$startfrom_name>=page_number is added at the end of the each URL.
 
-sub mktablehdr {
-    return("<table border=0 cellspacing=0 cellpadding=5>\n");
-}
+C<$nb_pages> is the total number of pages available.
 
+C<$current_page> is the current page number. This page number won't become a
+link.
 
-sub mktablerow {
-    #the last item in data may be a backgroundimage
-    
-    # FIXME
-    # should this be a foreach (1..$cols) loop?
-
-  my ($cols,$colour,@data)=@_;
-  my $i=0;
-  my $string="<tr valign=top bgcolor=$colour>";
-  while ($i <$cols){
-    if ($data[$cols] ne ''){
-    #check for backgroundimage
-      $string.="<td background=\"$data[$cols]\">";
-    } else {
-      $string.="<td>";
-    }
-    if ($data[$i] eq "") {
-      $string.=" &nbsp; </td>";
-    } else {
-      $string.="$data[$i]</td>";
-    } 
-    $i++;
-  }
-  $string=$string."</tr>\n";
-  return($string);
-}
+This function returns HTML, without any language dependency.
 
-sub mktableft {
-  return("</table>\n");
-}
+=cut
 
-sub mkform{
-  my ($action,%inputs)=@_;
-  my $string="<form action=$action method=post>\n";
-  $string=$string.mktablehdr();
-  my $key;
-  my @keys=sort keys %inputs;
-  
-  my $count=@keys;
-  my $i2=0;
-  while ( $i2<$count) {
-    my $value=$inputs{$keys[$i2]};
-    my @data=split('\t',$value);
-    #my $posn = shift(@data);
-    if ($data[0] eq 'hidden'){
-      $string=$string."<input type=hidden name=$keys[$i2] value=\"$data[1]\">\n";
-    } else {
-      my $text;
-      if ($data[0] eq 'radio') {
-        $text="<input type=radio name=$keys[$i2] value=$data[1]>$data[1]
-       <input type=radio name=$keys[$i2] value=$data[2]>$data[2]";
-      } 
-      if ($data[0] eq 'text') {
-        $text="<input type=$data[0] name=$keys[$i2] value=\"$data[1]\">";
-      }
-      if ($data[0] eq 'textarea') {
-        $text="<textarea name=$keys[$i2] wrap=physical cols=40 rows=4>$data[1]</textarea>";
-      }
-      if ($data[0] eq 'select') {
-        $text="<select name=$keys[$i2]>";
-       my $i=1;
-               while ($data[$i] ne "") {
-         my $val = $data[$i+1];
-         $text = $text."<option value=$data[$i]>$val";
-         $i = $i+2;
-       }
-       $text=$text."</select>";
-      }        
-      $string=$string.mktablerow(2,'white',$keys[$i2],$text);
-      #@order[$posn] =mktablerow(2,'white',$keys[$i2],$text);
-    }
-    $i2++;
-  }
-  #$string=$string.join("\n",@order);
-  $string=$string.mktablerow(2,'white','<input type=submit>','<input type=reset>');
-  $string=$string.mktableft;
-  $string=$string."</form>";
-}
+sub pagination_bar {
+    my ( $base_url, $nb_pages, $current_page, $startfrom_name ) = @_;
 
-sub mkform3{
-  my ($action,%inputs)=@_;
-  my $string="<form action=$action method=post>\n";
-  $string=$string.mktablehdr();
-  my $key;
-  my @keys=sort keys %inputs;
-  my @order;  
-  my $count=@keys;
-  my $i2=0;
-  while ( $i2<$count) {
-    my $value=$inputs{$keys[$i2]};
-    my @data=split('\t',$value);
-    my $posn = $data[2];
-    if ($data[0] eq 'hidden'){
-      $order[$posn]="<input type=hidden name=$keys[$i2] value=\"$data[1]\">\n";
-    } else {
-      my $text;
-      if ($data[0] eq 'radio') {
-        $text="<input type=radio name=$keys[$i2] value=$data[1]>$data[1]
-       <input type=radio name=$keys[$i2] value=$data[2]>$data[2]";
-      } 
-      if ($data[0] eq 'text') {
-        $text="<input type=$data[0] name=$keys[$i2] value=\"$data[1]\" size=40>";
-      }
-      if ($data[0] eq 'textarea') {
-        $text="<textarea name=$keys[$i2] cols=40 rows=4>$data[1]</textarea>";
-      }
-      if ($data[0] eq 'select') {
-        $text="<select name=$keys[$i2]>";
-       my $i=1;
-               while ($data[$i] ne "") {
-         my $val = $data[$i+1];
-         $text = $text."<option value=$data[$i]>$val";
-         $i = $i+2;
-       }
-       $text=$text."</select>";
-      }        
-#      $string=$string.mktablerow(2,'white',$keys[$i2],$text);
-      $order[$posn]=mktablerow(2,'white',$keys[$i2],$text);
-    }
-    $i2++;
-  }
-  my $temp=join("\n",@order);
-  $string=$string.$temp;
-  $string=$string.mktablerow(1,'white','<input type=submit>');
-  $string=$string.mktableft;
-  $string=$string."</form>";
-}
+    # how many pages to show before and after the current page?
+    my $pages_around = 2;
 
-sub mkformnotable{
-  my ($action,@inputs)=@_;
-  my $string="<form action=$action method=post>\n";
-  my $count=@inputs;
-  for (my $i=0; $i<$count; $i++){
-    if ($inputs[$i][0] eq 'hidden'){
-      $string=$string."<input type=hidden name=$inputs[$i][1] value=\"$inputs[$i][2]\">\n";
-    }
-    if ($inputs[$i][0] eq 'radio') {
-      $string.="<input type=radio name=$inputs[1] value=$inputs[$i][2]>$inputs[$i][2]";
-    } 
-    if ($inputs[$i][0] eq 'text') {
-      $string.="<input type=$inputs[$i][0] name=$inputs[$i][1] value=\"$inputs[$i][2]\">";
-    }
-    if ($inputs[$i][0] eq 'textarea') {
-        $string.="<textarea name=$inputs[$i][1] wrap=physical cols=40 rows=4>$inputs[$i][2]</textarea>";
+    my $url =
+      $base_url . ( $base_url =~ m/&/ ? '&amp;' : '?' ) . $startfrom_name . '=';
+
+    my $pagination_bar = '';
+
+    # current page detection
+    if ( not defined $current_page ) {
+        $current_page = 1;
     }
-    if ($inputs[$i][0] eq 'reset'){
-      $string.="<input type=reset name=$inputs[$i][1] value=\"$inputs[$i][2]\">";
-    }    
-    if ($inputs[$i][0] eq 'submit'){
-      $string.="<input type=submit name=$inputs[$i][1] value=\"$inputs[$i][2]\">";
-    }    
-  }
-  $string=$string."</form>";
-}
 
-sub mkform2{
-  my ($action,%inputs)=@_;
-  my $string="<form action=$action method=post>\n";
-  $string=$string.mktablehdr();
-  my $key;
-  my @order;
-  while ( my ($key, $value) = each %inputs) {
-    my @data=split('\t',$value);
-    my $posn = shift(@data);
-    my $reqd = shift(@data);
-    my $ltext = shift(@data);    
-    if ($data[0] eq 'hidden'){
-      $string=$string."<input type=hidden name=$key value=\"$data[1]\">\n";
-    } else {
-      my $text;
-      if ($data[0] eq 'radio') {
-        $text="<input type=radio name=$key value=$data[1]>$data[1]
-       <input type=radio name=$key value=$data[2]>$data[2]";
-      } elsif ($data[0] eq 'text') {
-        my $size = $data[1];
-        if ($size eq "") {
-          $size=40;
+    # navigation bar useful only if more than one page to display !
+    if ( $nb_pages > 1 ) {
+
+        # link to first page?
+        if ( $current_page > 1 ) {
+            $pagination_bar .=
+                "\n" . '&nbsp;'
+              . '<a href="'
+              . $url
+              . '1" rel="start">'
+              . '&lt;&lt;' . '</a>';
+        }
+        else {
+            $pagination_bar .=
+              "\n" . '&nbsp;<span class="inactive">&lt;&lt;</span>';
+        }
+
+        # link on previous page ?
+        if ( $current_page > 1 ) {
+            my $previous = $current_page - 1;
+
+            $pagination_bar .=
+                "\n" . '&nbsp;'
+              . '<a href="'
+              . $url
+              . $previous
+              . '" rel="prev">' . '&lt;' . '</a>';
         }
-        $text="<input type=$data[0] name=$key size=$size value=\"$data[2]\">";
-      } elsif ($data[0] eq 'textarea') {
-        my @size=split("x",$data[1]);
-        if ($data[1] eq "") {
-          $size[0] = 40;
-          $size[1] = 4;
+        else {
+            $pagination_bar .=
+              "\n" . '&nbsp;<span class="inactive">&lt;</span>';
+        }
+
+        my $min_to_display      = $current_page - $pages_around;
+        my $max_to_display      = $current_page + $pages_around;
+        my $last_displayed_page = undef;
+
+        for my $page_number ( 1 .. $nb_pages ) {
+            if (
+                   $page_number == 1
+                or $page_number == $nb_pages
+                or (    $page_number >= $min_to_display
+                    and $page_number <= $max_to_display )
+              )
+            {
+                if ( defined $last_displayed_page
+                    and $last_displayed_page != $page_number - 1 )
+                {
+                    $pagination_bar .=
+                      "\n" . '&nbsp;<span class="inactive">...</span>';
+                }
+
+                if ( $page_number == $current_page ) {
+                    $pagination_bar .=
+                        "\n" . '&nbsp;'
+                      . '<span class="currentPage">'
+                      . $page_number
+                      . '</span>';
+                }
+                else {
+                    $pagination_bar .=
+                        "\n" . '&nbsp;'
+                      . '<a href="'
+                      . $url
+                      . $page_number . '">'
+                      . $page_number . '</a>';
+                }
+                $last_displayed_page = $page_number;
+            }
+        }
+
+        # link on next page?
+        if ( $current_page < $nb_pages ) {
+            my $next = $current_page + 1;
+
+            $pagination_bar .= "\n"
+              . '&nbsp;<a href="'
+              . $url
+              . $next
+              . '" rel="next">' . '&gt;' . '</a>';
+        }
+        else {
+            $pagination_bar .=
+              "\n" . '&nbsp;<span class="inactive">&gt;</span>';
+        }
+
+        # link to last page?
+        if ( $current_page != $nb_pages ) {
+            $pagination_bar .= "\n"
+              . '&nbsp;<a href="'
+              . $url
+              . $nb_pages
+              . '" rel="last">'
+              . '&gt;&gt;' . '</a>';
+        }
+        else {
+            $pagination_bar .=
+              "\n" . '&nbsp;<span class="inactive">&gt;&gt;</span>';
         }
-        $text="<textarea name=$key wrap=physical cols=$size[0] rows=$size[1]>$data[2]</textarea>";
-      } elsif ($data[0] eq 'select') {
-        $text="<select name=$key>";
-       my $sel=$data[1];
-       my $i=2;
-               while ($data[$i] ne "") {
-         my $val = $data[$i+1];
-                 $text = $text."<option value=\"$data[$i]\"";
-         if ($data[$i] eq $sel) {
-            $text = $text." selected";
-         }   
-          $text = $text.">$val";
-         $i = $i+2;
-       }
-       $text=$text."</select>";
-      }
-      if ($reqd eq "R") {
-        $ltext = $ltext." (Req)";
-       }
-      @order[$posn] =mktablerow(2,'white',$ltext,$text);
     }
-  }
-  $string=$string.join("\n",@order);
-  $string=$string.mktablerow(2,'white','<input type=submit>','<input type=reset>');
-  $string=$string.mktableft;
-  $string=$string."</form>";
+
+    return $pagination_bar;
 }
 
+=item output_html_with_http_headers
 
-sub endpage{
-  return("</body></html>\n");
-}
+   &output_html_with_http_headers($query, $cookie, $html)
 
-sub mklink {
-  my ($url,$text)=@_;
-  my $string="<a href=\"$url\">$text</a>";
-  return ($string);
-}
+Outputs the HTML page $html with the appropriate HTTP headers,
+with the authentication cookie $cookie and a Content-Type that
+corresponds to the HTML page $html.
+
+=cut
 
-sub mkheadr {
-  my ($type,$text)=@_;
-  my $string;
-  if ($type eq '1'){
-    $string="<FONT SIZE=6><em>$text</em></FONT><br>";
-  }
-  if ($type eq '2'){
-    $string="<FONT SIZE=6><em>$text</em></FONT>";
-  }
-    if ($type eq '3'){
-    $string="<FONT SIZE=6><em>$text</em></FONT><p>";
-  }
-  return ($string);
+sub output_html_with_http_headers ($$$) {
+    my($query, $cookie, $html) = @_;
+    print $query->header(
+        -type    => 'text/html',
+        -charset => 'UTF-8',
+        -cookie  => $cookie,
+    ), $html;
 }
 
-sub center {
-  return ("<CENTER>\n");
-}  
+END { }    # module clean-up code here (global destructor)
 
-sub endcenter {
-  return ("</CENTER>\n");
-}  
+1;
+__END__
 
-sub bold {
-  my ($text)=@_;
-  my $string="<b>$text</b>";
-  return($string);
-}
+=back
 
-END { }       # module clean-up code here (global destructor)
-    
+=head1 AUTHOR
 
+Koha Developement team <info@koha.org>
 
+=cut