3 #package to deal with marking up output
4 #You will need to edit parts of this pm
5 #set the value of path to be where your html lives
7 # Copyright 2000-2002 Katipo Communications
9 # This file is part of Koha.
11 # Koha is free software; you can redistribute it and/or modify it under the
12 # terms of the GNU General Public License as published by the Free Software
13 # Foundation; either version 2 of the License, or (at your option) any later
16 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
17 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License along with
21 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
22 # Suite 330, Boston, MA 02111-1307 USA
25 # NOTE: I'm pretty sure this module is deprecated in favor of
32 use C4::Languages qw(getTranslatedLanguages get_bidi regex_lang_subtags language_get_description);
34 use HTML::Template::Pro;
35 use vars qw($VERSION @ISA @EXPORT);
37 # set the version for version checking
42 C4::Output - Functions for managing templates
52 &themelanguage &gettemplate setlanguagecookie pagination_bar
57 &output_html_with_http_headers
61 #FIXME: this is a quick fix to stop rc1 installing broken
62 #Still trying to figure out the correct fix.
63 my $path = C4::Context->config('intrahtdocs') . "/prog/en/includes/";
65 #---------------------------------------------------------------------------------------------------------
68 my ( $tmplbase, $interface, $query ) = @_;
70 warn "no query in gettemplate";
73 if ( $interface ne "intranet" ) {
74 $htdocs = C4::Context->config('opachtdocs');
77 $htdocs = C4::Context->config('intrahtdocs');
79 my $path = C4::Context->preference('intranet_includes') || 'includes';
81 # warn "PATH : $path";
82 my ( $theme, $lang ) = themelanguage( $htdocs, $tmplbase, $interface, $query );
83 my $opacstylesheet = C4::Context->preference('opacstylesheet');
85 # if the template doesn't exist, load the English one as a last resort
86 my $filename = "$htdocs/$theme/$lang/".($interface eq 'intranet'?"modules":"")."/$tmplbase";
87 unless (-f $filename) {
89 $filename = "$htdocs/$theme/$lang/".($interface eq 'intranet'?"modules":"")."/$tmplbase";
91 my $template = HTML::Template::Pro->new(
92 filename => $filename,
93 die_on_bad_params => 1,
96 path => ["$htdocs/$theme/$lang/$path"]
100 themelang => ( $interface ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' )
102 interface => ( $interface ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' ),
104 opacstylesheet => $opacstylesheet,
105 opaccolorstylesheet => C4::Context->preference('opaccolorstylesheet'),
106 opacsmallimage => C4::Context->preference('opacsmallimage'),
110 # Language, Script, and Locale
111 my $language_subtags_hashref = regex_lang_subtags($lang);
113 $bidi = get_bidi($language_subtags_hashref->{script}) if $language_subtags_hashref->{script};
114 my @template_languages;
115 my $languages_loop = getTranslatedLanguages($interface,$theme);
116 for my $language_hashref (@$languages_loop) {
117 $language_hashref->{'language_script_description'} = language_get_description($language_hashref->{'language_script'},$lang);
118 $language_hashref->{'language_region_description'} = language_get_description($language_hashref->{'language_region'},$lang);
119 $language_hashref->{'language_variant_description'} = language_get_description($language_hashref->{'language_variant'},$lang);
121 if ($language_hashref->{'language_code'} eq $lang) {
123 warn "Code:".$language_hashref->{'language_code'};
124 #language_hashref->{language_code} eq $language_subtags_hashref->{language}) {
125 $language_hashref->{current}++;
127 push @template_languages, $language_hashref;
129 # load the languages ( for switching from one template to another )
130 $template->param( languages_loop => \@template_languages,
137 #---------------------------------------------------------------------------------------------------------
140 my ( $htdocs, $tmpl, $section, $query ) = @_;
146 # set some defaults for language and theme
147 my $lang = $query->cookie('KohaOpacLanguage');
148 $lang = 'en' unless $lang;
151 my $dbh = C4::Context->dbh;
154 if ( $section eq "intranet" ) {
155 @languages = split " ", C4::Context->preference("opaclanguages");
156 @themes = split " ", C4::Context->preference("template");
157 pop @languages, $lang if $lang;
161 # we are in the opac here, what im trying to do is let the individual user
162 # set the theme they want to use.
163 # and perhaps the them as well.
164 #my $lang = $query->cookie('KohaOpacLanguage');
167 push @languages, $lang;
168 @themes = split " ", C4::Context->preference("opacthemes");
171 @languages = split " ", C4::Context->preference("opaclanguages");
172 @themes = split " ", C4::Context->preference("opacthemes");
176 # searches through the themes and languages. First template it find it returns.
177 # Priority is for getting the theme right.
179 foreach my $th (@themes) {
180 foreach my $la (@languages) {
181 for ( my $pass = 1 ; $pass <= 2 ; $pass += 1 ) {
182 $la =~ s/([-_])/ $1 eq '-'? '_': '-' /eg if $pass == 2;
183 if ( -e "$htdocs/$th/$la/modules/$tmpl" ) {
188 last unless $la =~ /[-_]/;
192 return ( $theme, $lang );
195 sub setlanguagecookie {
196 my ( $query, $language, $uri ) = @_;
197 my $cookie = $query->cookie(
198 -name => 'KohaOpacLanguage',
202 print $query->redirect(
210 pagination_bar($base_url, $nb_pages, $current_page, $startfrom_name)
212 Build an HTML pagination bar based on the number of page to display, the
213 current page and the url to give to each page link.
215 C<$base_url> is the URL for each page link. The
216 C<$startfrom_name>=page_number is added at the end of the each URL.
218 C<$nb_pages> is the total number of pages available.
220 C<$current_page> is the current page number. This page number won't become a
223 This function returns HTML, without any language dependency.
228 my ( $base_url, $nb_pages, $current_page, $startfrom_name ) = @_;
230 # how many pages to show before and after the current page?
231 my $pages_around = 2;
234 $base_url . ( $base_url =~ m/&/ ? '&' : '?' ) . $startfrom_name . '=';
236 my $pagination_bar = '';
238 # current page detection
239 if ( not defined $current_page ) {
243 # navigation bar useful only if more than one page to display !
244 if ( $nb_pages > 1 ) {
246 # link to first page?
247 if ( $current_page > 1 ) {
253 . '<<' . '</a>';
257 "\n" . ' <span class="inactive"><<</span>';
260 # link on previous page ?
261 if ( $current_page > 1 ) {
262 my $previous = $current_page - 1;
269 . '" rel="prev">' . '<' . '</a>';
273 "\n" . ' <span class="inactive"><</span>';
276 my $min_to_display = $current_page - $pages_around;
277 my $max_to_display = $current_page + $pages_around;
278 my $last_displayed_page = undef;
280 for my $page_number ( 1 .. $nb_pages ) {
283 or $page_number == $nb_pages
284 or ( $page_number >= $min_to_display
285 and $page_number <= $max_to_display )
288 if ( defined $last_displayed_page
289 and $last_displayed_page != $page_number - 1 )
292 "\n" . ' <span class="inactive">...</span>';
295 if ( $page_number == $current_page ) {
298 . '<span class="currentPage">'
307 . $page_number . '">'
308 . $page_number . '</a>';
310 $last_displayed_page = $page_number;
315 if ( $current_page < $nb_pages ) {
316 my $next = $current_page + 1;
318 $pagination_bar .= "\n"
322 . '" rel="next">' . '>' . '</a>';
326 "\n" . ' <span class="inactive">></span>';
330 if ( $current_page != $nb_pages ) {
331 $pagination_bar .= "\n"
336 . '>>' . '</a>';
340 "\n" . ' <span class="inactive">>></span>';
344 return $pagination_bar;
347 =item output_html_with_http_headers
349 &output_html_with_http_headers($query, $cookie, $html)
351 Outputs the HTML page $html with the appropriate HTTP headers,
352 with the authentication cookie $cookie and a Content-Type that
353 corresponds to the HTML page $html.
357 sub output_html_with_http_headers ($$$) {
358 my($query, $cookie, $html) = @_;
359 print $query->header(
360 -type => 'text/html',
363 -Pragma => 'no-cache',
364 -'Cache-Control' => 'no-cache',
368 END { } # module clean-up code here (global destructor)
377 Koha Developement team <info@koha.org>