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
21 # with Koha; if not, write to the Free Software Foundation, Inc.,
22 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 # NOTE: I'm pretty sure this module is deprecated in favor of
31 use C4::Languages qw(getTranslatedLanguages get_bidi regex_lang_subtags language_get_description accept_language );
32 use C4::Dates qw(format_date);
33 use C4::Budgets qw(GetCurrency);
35 use HTML::Template::Pro;
36 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
39 # set the version for version checking
43 @EXPORT_OK = qw(&is_ajax ajax_fail); # More stuff should go here instead
44 %EXPORT_TAGS = ( all =>[qw(&themelanguage &gettemplate setlanguagecookie pagination_bar
45 &output_with_http_headers &output_html_with_http_headers)],
46 ajax =>[qw(&output_with_http_headers is_ajax)],
47 html =>[qw(&output_with_http_headers &output_html_with_http_headers)]
50 &themelanguage &gettemplate setlanguagecookie getlanguagecookie pagination_bar
53 &output_html_with_http_headers &output_with_http_headers FormatData FormatNumber
59 C4::Output - Functions for managing templates
67 #FIXME: this is a quick fix to stop rc1 installing broken
68 #Still trying to figure out the correct fix.
69 my $path = C4::Context->config('intrahtdocs') . "/prog/en/includes/";
71 #---------------------------------------------------------------------------------------------------------
74 sub _get_template_file {
75 my ( $tmplbase, $interface, $query ) = @_;
76 my $htdocs = C4::Context->config( $interface ne 'intranet' ? 'opachtdocs' : 'intrahtdocs' );
77 my ( $theme, $lang ) = themelanguage( $htdocs, $tmplbase, $interface, $query );
78 my $opacstylesheet = C4::Context->preference('opacstylesheet');
80 # if the template doesn't exist, load the English one as a last resort
81 my $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
82 unless (-f $filename) {
84 $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
87 return ( $htdocs, $theme, $lang, $filename );
91 my ( $tmplbase, $interface, $query ) = @_;
92 ($query) or warn "no query in gettemplate";
93 my $path = C4::Context->preference('intranet_includes') || 'includes';
94 my $opacstylesheet = C4::Context->preference('opacstylesheet');
95 my ( $htdocs, $theme, $lang, $filename ) = _get_template_file( $tmplbase, $interface, $query );
97 my $template = HTML::Template::Pro->new(
98 filename => $filename,
99 die_on_bad_params => 1,
102 loop_context_vars => 1, # enable: __first__, __last__, __inner__, __odd__, __counter__
103 path => ["$htdocs/$theme/$lang/$path"]
105 my $themelang=( $interface ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' )
108 themelang => $themelang,
109 yuipath => (C4::Context->preference("yuipath") eq "local"?"$themelang/lib/yui":C4::Context->preference("yuipath")),
110 interface => ( $interface ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' ),
116 my $current_lang = regex_lang_subtags($lang);
118 $bidi = get_bidi($current_lang->{script}) if $current_lang->{script};
120 my $languages_loop = getTranslatedLanguages($interface,$theme,$lang);
121 my $num_languages_enabled = 0;
122 foreach my $lang (@$languages_loop) {
123 foreach my $sublang (@{ $lang->{'sublanguages_loop'} }) {
124 $num_languages_enabled++ if $sublang->{enabled};
128 languages_loop => $languages_loop,
130 one_language_enabled => ($num_languages_enabled <= 1) ? 1 : 0, # deal with zero enabled langs as well
131 ) unless @$languages_loop<2;
136 #---------------------------------------------------------------------------------------------------------
139 my ( $htdocs, $tmpl, $interface, $query ) = @_;
140 ($query) or warn "no query in themelanguage";
142 # Set some defaults for language and theme
143 # First, check the user's preferences
145 my $http_accept_language = $ENV{ HTTP_ACCEPT_LANGUAGE };
146 $lang = accept_language( $http_accept_language,
147 getTranslatedLanguages($interface,'prog') )
148 if $http_accept_language;
149 # But, if there's a cookie set, obey it
150 $lang = $query->cookie('KohaOpacLanguage') if (defined $query and $query->cookie('KohaOpacLanguage'));
151 # Fall back to English
153 if ($interface eq 'intranet') {
154 @languages = split ",", C4::Context->preference("language");
156 @languages = split ",", C4::Context->preference("opaclanguages");
159 @languages=($lang,@languages);
161 $lang = $languages[0];
163 my $theme = 'prog'; # in the event of theme failure default to 'prog' -fbcit
164 my $dbh = C4::Context->dbh;
166 if ( $interface eq "intranet" ) {
167 @themes = split " ", C4::Context->preference("template");
170 # we are in the opac here, what im trying to do is let the individual user
171 # set the theme they want to use.
172 # and perhaps the them as well.
173 #my $lang = $query->cookie('KohaOpacLanguage');
174 @themes = split " ", C4::Context->preference("opacthemes");
177 # searches through the themes and languages. First template it find it returns.
178 # Priority is for getting the theme right.
180 foreach my $th (@themes) {
181 foreach my $la (@languages) {
182 #for ( my $pass = 1 ; $pass <= 2 ; $pass += 1 ) {
183 # warn "$htdocs/$th/$la/modules/$interface-"."tmpl";
184 #$la =~ s/([-_])/ $1 eq '-'? '_': '-' /eg if $pass == 2;
185 if ( -e "$htdocs/$th/$la/modules/$tmpl") {
186 #".($interface eq 'intranet'?"modules":"")."/$tmpl" ) {
191 last unless $la =~ /[-_]/;
195 return ( $theme, $lang );
198 sub setlanguagecookie {
199 my ( $query, $language, $uri ) = @_;
200 my $cookie = $query->cookie(
201 -name => 'KohaOpacLanguage',
205 print $query->redirect(
211 sub getlanguagecookie {
214 if ($query->cookie('KohaOpacLanguage')){
215 $lang = $query->cookie('KohaOpacLanguage') ;
217 $lang = $ENV{HTTP_ACCEPT_LANGUAGE};
220 $lang = substr($lang, 0, 2);
228 my $cur = GetCurrency;
229 my $cur_format = C4::Context->preference("CurrencyFormat");
232 if ( $cur_format eq 'FR' ) {
233 $num = new Number::Format(
234 'decimal_fill' => '2',
235 'decimal_point' => ',',
236 'int_curr_symbol' => $cur->{symbol},
237 'mon_thousands_sep' => ' ',
238 'thousands_sep' => ' ',
239 'mon_decimal_point' => ','
241 } else { # US by default..
242 $num = new Number::Format(
243 'int_curr_symbol' => '',
244 'mon_thousands_sep' => ',',
245 'mon_decimal_point' => '.'
253 FormatData($data_hashref)
254 C<$data_hashref> is a ref to data to format
256 Format dates of data those dates are assumed to contain date in their noun
257 Could be used in order to centralize all the formatting for HTML output
261 my $data_hashref=shift;
262 $$data_hashref{$_} = format_date( $$data_hashref{$_} ) for grep{/date/} keys (%$data_hashref);
267 pagination_bar($base_url, $nb_pages, $current_page, $startfrom_name)
269 Build an HTML pagination bar based on the number of page to display, the
270 current page and the url to give to each page link.
272 C<$base_url> is the URL for each page link. The
273 C<$startfrom_name>=page_number is added at the end of the each URL.
275 C<$nb_pages> is the total number of pages available.
277 C<$current_page> is the current page number. This page number won't become a
280 This function returns HTML, without any language dependency.
285 my $base_url = (@_ ? shift : $ENV{SCRIPT_NAME} . $ENV{QUERY_STRING}) or return undef;
286 my $nb_pages = (@_) ? shift : 1;
287 my $current_page = (@_) ? shift : undef; # delay default until later
288 my $startfrom_name = (@_) ? shift : 'page';
290 # how many pages to show before and after the current page?
291 my $pages_around = 2;
293 my $delim = qr/\&(?:amp;)?|;/; # "non memory" cluster: no backreference
294 $base_url =~ s/$delim*\b$startfrom_name=(\d+)//g; # remove previous pagination var
295 unless (defined $current_page and $current_page > 0 and $current_page <= $nb_pages) {
296 $current_page = ($1) ? $1 : 1; # pull current page from param in URL, else default to 1
297 # $debug and # FIXME: use C4::Debug;
298 # warn "with QUERY_STRING:" .$ENV{QUERY_STRING}. "\ncurrent_page:$current_page\n1:$1 2:$2 3:$3";
300 $base_url =~ s/($delim)+/$1/g; # compress duplicate delims
301 $base_url =~ s/$delim;//g; # remove empties
302 $base_url =~ s/$delim$//; # remove trailing delim
304 my $url = $base_url . (($base_url =~ m/$delim/ or $base_url =~ m/\?/) ? '&' : '?' ) . $startfrom_name . '=';
305 my $pagination_bar = '';
307 # navigation bar useful only if more than one page to display !
308 if ( $nb_pages > 1 ) {
310 # link to first page?
311 if ( $current_page > 1 ) {
317 . '<<' . '</a>';
321 "\n" . ' <span class="inactive"><<</span>';
324 # link on previous page ?
325 if ( $current_page > 1 ) {
326 my $previous = $current_page - 1;
333 . '" rel="prev">' . '<' . '</a>';
337 "\n" . ' <span class="inactive"><</span>';
340 my $min_to_display = $current_page - $pages_around;
341 my $max_to_display = $current_page + $pages_around;
342 my $last_displayed_page = undef;
344 for my $page_number ( 1 .. $nb_pages ) {
347 or $page_number == $nb_pages
348 or ( $page_number >= $min_to_display
349 and $page_number <= $max_to_display )
352 if ( defined $last_displayed_page
353 and $last_displayed_page != $page_number - 1 )
356 "\n" . ' <span class="inactive">...</span>';
359 if ( $page_number == $current_page ) {
362 . '<span class="currentPage">'
371 . $page_number . '">'
372 . $page_number . '</a>';
374 $last_displayed_page = $page_number;
379 if ( $current_page < $nb_pages ) {
380 my $next = $current_page + 1;
382 $pagination_bar .= "\n"
386 . '" rel="next">' . '>' . '</a>';
390 "\n" . ' <span class="inactive">></span>';
394 if ( $current_page != $nb_pages ) {
395 $pagination_bar .= "\n"
400 . '>>' . '</a>';
404 "\n" . ' <span class="inactive">>></span>';
408 return $pagination_bar;
411 =item output_with_http_headers
413 &output_with_http_headers($query, $cookie, $data, $content_type[, $status])
415 Outputs $data with the appropriate HTTP headers,
416 the authentication cookie $cookie and a Content-Type specified in
419 If applicable, $cookie can be undef, and it will not be sent.
421 $content_type is one of the following: 'html', 'js', 'json', 'xml', 'rss', or 'atom'.
423 $status is an HTTP status message, like '403 Authentication Required'. It defaults to '200 OK'.
427 sub output_with_http_headers($$$$;$) {
428 my ( $query, $cookie, $data, $content_type, $status ) = @_;
429 $status ||= '200 OK';
431 my %content_type_map = (
432 'html' => 'text/html',
433 'js' => 'text/javascript',
434 'json' => 'application/json',
436 # NOTE: not using application/atom+xml or application/rss+xml because of
437 # Internet Explorer 6; see bug 2078.
442 die "Unknown content type '$content_type'" if ( !defined( $content_type_map{$content_type} ) );
444 type => $content_type_map{$content_type},
447 Pragma => 'no-cache',
448 'Cache-Control' => 'no-cache',
450 $options->{cookie} = $cookie if $cookie;
451 if ($content_type eq 'html') { # guaranteed to be one of the content_type_map keys, else we'd have died
452 $options->{'Content-Style-Type' } = 'text/css';
453 $options->{'Content-Script-Type'} = 'text/javascript';
455 # remove SUDOC specific NSB NSE
456 $data =~ s/\x{C2}\x{98}|\x{C2}\x{9C}/ /g;
457 $data =~ s/\x{C2}\x{88}|\x{C2}\x{89}/ /g;
458 print $query->header($options), $data;
461 sub output_html_with_http_headers ($$$;$) {
462 my ( $query, $cookie, $data, $status ) = @_;
463 output_with_http_headers( $query, $cookie, $data, 'html', $status );
467 my $x_req = $ENV{HTTP_X_REQUESTED_WITH};
468 return ( $x_req and $x_req =~ /XMLHttpRequest/i ) ? 1 : 0;
471 END { } # module clean-up code here (global destructor)
480 Koha Developement team <info@koha.org>