X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=C4%2FTemplates.pm;h=343a3741993f51866d564c1b784ce5eb3d3b9ffd;hb=3f7b2fa41898f59ce39d1725f8dfe6001095f796;hp=78dcdddd031f54c8dec0ccf7346aeffa8ffa3a08;hpb=bc5f5f4f011c05517cf31c366da115dd97de1f36;p=koha.git diff --git a/C4/Templates.pm b/C4/Templates.pm index 78dcdddd03..343a374199 100644 --- a/C4/Templates.pm +++ b/C4/Templates.pm @@ -3,29 +3,29 @@ package C4::Templates; use strict; use warnings; use Carp; -use CGI; -use List::MoreUtils qw/any/; +use CGI qw ( -utf8 ); +use List::MoreUtils qw/ any uniq /; # Copyright 2009 Chris Cormack and The Koha Dev Team # # 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 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 3 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. +# 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 +# You should have received a copy of the GNU General Public License +# along with Koha; if not, see . =head1 NAME - Koha::Templates - Object for manipulating templates for use with Koha +C4::Templates - Object for manipulating templates for use with Koha =cut @@ -36,6 +36,9 @@ use C4::Languages qw(getTranslatedLanguages get_bidi regex_lang_subtags language use C4::Context; +use Koha::Cache::Memory::Lite; +use Koha::Exceptions; + __PACKAGE__->mk_accessors(qw( theme activethemes preferredtheme lang filename htdocs interface vars)); @@ -59,14 +62,17 @@ sub new { push @includes, "$htdocs/$_/$lang/includes"; push @includes, "$htdocs/$_/en/includes" unless $lang eq 'en'; } + # Do not use template cache if script is called from commandline + my $use_template_cache = C4::Context->config('template_cache_dir') && defined $ENV{GATEWAY_INTERFACE}; my $template = Template->new( { EVAL_PERL => 1, ABSOLUTE => 1, PLUGIN_BASE => 'Koha::Template::Plugin', - COMPILE_EXT => C4::Context->config('template_cache_dir')?'.ttc':'', - COMPILE_DIR => C4::Context->config('template_cache_dir')?C4::Context->config('template_cache_dir'):'',, + COMPILE_EXT => $use_template_cache ? '.ttc' : '', + COMPILE_DIR => $use_template_cache ? C4::Context->config('template_cache_dir') : '', INCLUDE_PATH => \@includes, FILTERS => {}, + ENCODING => 'UTF-8', } ) or die Template->error(); my $self = { @@ -100,84 +106,24 @@ sub output { } $vars->{lang} = $self->lang; $vars->{themelang} .= '/' . $self->preferredtheme . '/' . $self->lang; - $vars->{yuipath} = - ( C4::Context->preference("yuipath") eq "local" - ? ( $self->interface eq 'intranet' ? $vars->{themelang} . "/lib/yui" : "/opac-tmpl/lib/yui" ) - : C4::Context->preference("yuipath") ); $vars->{interface} = ( $self->{interface} ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' ); $vars->{theme} = $self->theme; - $vars->{opaccolorstylesheet} = - C4::Context->preference('opaccolorstylesheet'); - $vars->{opacsmallimage} = C4::Context->preference('opacsmallimage'); + $vars->{OpacAdditionalStylesheet} = + C4::Context->preference('OpacAdditionalStylesheet'); $vars->{opaclayoutstylesheet} = C4::Context->preference('opaclayoutstylesheet'); # add variables set via param to $vars for processing - # and clean any utf8 mess - for my $k ( keys %{ $self->{VARS} } ) { - $vars->{$k} = $self->{VARS}->{$k}; - if (ref($vars->{$k}) eq 'ARRAY'){ - utf8_arrayref($vars->{$k}); - } - elsif (ref($vars->{$k}) eq 'HASH'){ - utf8_hashref($vars->{$k}); - } - else { - utf8::encode($vars->{$k}) if utf8::is_utf8($vars->{$k}); - } - } + $vars = { %$vars, %{ $self->{VARS} } }; + my $data; -# binmode( STDOUT, ":utf8" ); + binmode( STDOUT, ":utf8" ); $template->process( $self->filename, $vars, \$data ) || die "Template process failed: ", $template->error(); return $data; } -sub utf8_arrayref { - my $arrayref = shift; - foreach my $element (@$arrayref){ - if (ref($element) eq 'ARRAY'){ - utf8_arrayref($element); - next; - } - if (ref($element) eq 'HASH'){ - utf8_hashref($element); - next; - } - utf8::encode($element) if utf8::is_utf8($element); - } -} - -sub utf8_hashref { - my $hashref = shift; - for my $key (keys %{$hashref}){ - if (ref($hashref->{$key}) eq 'ARRAY'){ - utf8_arrayref($hashref->{$key}); - next; - } - if (ref($hashref->{$key}) eq 'HASH'){ - utf8_hashref($hashref->{$key}); - next; - } - utf8::encode($hashref->{$key}) if utf8::is_utf8($hashref->{$key}); - } -} - - -# FIXME - this is a horrible hack to cache -# the current known-good language, temporarily -# put in place to resolve bug 4403. It is -# used only by C4::XSLT::XSLTParse4Display; -# the language is set via the usual call -# to themelanguage. -my $_current_language = 'en'; - -sub _current_language { - return $_current_language; -} - - # wrapper method to allow easier transition from HTML template pro to Template Toolkit sub param { my $self = shift; @@ -216,25 +162,53 @@ sub _get_template_file { my $is_intranet = $interface eq 'intranet'; my $htdocs = C4::Context->config($is_intranet ? 'intrahtdocs' : 'opachtdocs'); my ($theme, $lang, $availablethemes) = themelanguage($htdocs, $tmplbase, $interface, $query); + $lang //= 'en'; + $theme //= ''; + $tmplbase = "$htdocs/$theme/$lang/modules/$tmplbase" if $tmplbase !~ /^\//; + # do not prefix an absolute path - # if the template doesn't exist, load the English one as a last resort - my $filename = "$htdocs/$theme/$lang/modules/$tmplbase"; - unless (-f $filename) { - $lang = 'en'; - $filename = "$htdocs/$theme/$lang/modules/$tmplbase"; - } - return ($htdocs, $theme, $lang, $filename); + return ( $htdocs, $theme, $lang, $tmplbase ); } +=head2 badtemplatecheck + + badtemplatecheck( $template_path ); + + The sub will throw an exception if the template path is not allowed. + + Note: At this moment the sub is actually a helper routine for + sub gettemplate. + +=cut + +sub badtemplatecheck { + my ( $template ) = @_; + if( !$template || $template !~ m/^[a-zA-Z0-9_\-\/]+\.(tt|pref)$/ ) { + # This also includes two dots + Koha::Exceptions::NoPermission->throw( 'bad template path' ); + } else { + # Check allowed dirs + my $dirs = C4::Context->config("pluginsdir"); + $dirs = [ $dirs ] if !ref($dirs); + unshift @$dirs, C4::Context->config('opachtdocs'), C4::Context->config('intrahtdocs'); + my $found = 0; + foreach my $dir ( @$dirs ) { + $dir .= '/' if $dir !~ m/\/$/; + $found++ if $template =~ m/^$dir/; + last if $found; + } + Koha::Exceptions::NoPermission->throw( 'bad template path' ) if !$found; + } +} sub gettemplate { my ( $tmplbase, $interface, $query ) = @_; ($query) or warn "no query in gettemplate"; - my $path = C4::Context->preference('intranet_includes') || 'includes'; - $tmplbase =~ s/\.tmpl$/.tt/; my ($htdocs, $theme, $lang, $filename) = _get_template_file($tmplbase, $interface, $query); + badtemplatecheck( $filename ); # single trip for bad templates my $template = C4::Templates->new($interface, $filename, $tmplbase, $query); + # NOTE: Commenting these out rather than deleting them so that those who need # to know how we previously shimmed these directories will be able to understand. # my $is_intranet = $interface eq 'intranet'; @@ -243,18 +217,18 @@ sub gettemplate { # "/$theme/$lang"; # $template->param( # themelang => $themelang, -# yuipath => C4::Context->preference("yuipath") eq "local" -# ? "$themelang/lib/yui" -# : C4::Context->preference("yuipath"), # interface => $is_intranet ? '/intranet-tmpl' : '/opac-tmpl', # theme => $theme, # lang => $lang # ); - # Bidirectionality + # Bidirectionality, must be sent even if is the only language my $current_lang = regex_lang_subtags($lang); my $bidi; $bidi = get_bidi($current_lang->{script}) if $current_lang->{script}; + $template->param( + bidi => $bidi, + ); # Languages my $languages_loop = getTranslatedLanguages($interface,$theme,$lang); my $num_languages_enabled = 0; @@ -263,87 +237,153 @@ sub gettemplate { $num_languages_enabled++ if $sublang->{enabled}; } } + my $one_language_enabled = ($num_languages_enabled <= 1) ? 1 : 0; # deal with zero enabled langs as well $template->param( languages_loop => $languages_loop, - bidi => $bidi, - one_language_enabled => ($num_languages_enabled <= 1) ? 1 : 0, # deal with zero enabled langs as well - ) unless @$languages_loop<2; + one_language_enabled => $one_language_enabled, + ) unless $one_language_enabled; return $template; } -#--------------------------------------------------------------------------------------------------------- -# FIXME - POD +=head2 themelanguage + + my ($theme,$lang,\@themes) = themelanguage($htdocs,$tmpl,$interface,query); + +This function returns the theme and language to be used for rendering the UI. +It also returns the list of themes that should be applied as a fallback. This is +used for the theme overlay feature (i.e. if a file doesn't exist on the requested +theme, fallback to the configured fallback). + +Important: this function is used on the webinstaller too, so always consider +the use case where the DB is not populated already when rewriting/fixing. + +=cut + sub themelanguage { my ($htdocs, $tmpl, $interface, $query) = @_; ($query) or warn "no query in themelanguage"; # Select a language based on cookie, syspref available languages & browser - my $lang = getlanguage($query, $interface); - - # Select theme - my $is_intranet = $interface eq 'intranet'; - my @themes = split(" ", C4::Context->preference( - $is_intranet ? "template" : "opacthemes" )); - push @themes, 'prog'; - - # Try to find first theme for the selected language + my $lang = C4::Languages::getlanguage($query); + + # Get theme + my @themes; + my $theme_syspref = ($interface eq 'intranet') ? 'template' : 'opacthemes'; + my $fallback_syspref = ($interface eq 'intranet') ? 'template' : 'OPACFallback'; + # Yeah, hardcoded, last resort if the DB is not populated + my $hardcoded_theme = ($interface eq 'intranet') ? 'prog' : 'bootstrap'; + + # Configured theme is the first one + push @themes, C4::Context->preference( $theme_syspref ) + if C4::Context->preference( $theme_syspref ); + # Configured fallback next + push @themes, C4::Context->preference( $fallback_syspref ) + if C4::Context->preference( $fallback_syspref ); + # The hardcoded fallback theme is the last one + push @themes, $hardcoded_theme; + + # Try to find first theme for the selected theme/lang, then for fallback/lang + my $where = $tmpl =~ /xsl$/ ? 'xslt' : 'modules'; for my $theme (@themes) { - if ( -e "$htdocs/$theme/$lang/modules/$tmpl" ) { - $_current_language = $lang; - return ($theme, $lang, \@themes) + if ( -e "$htdocs/$theme/$lang/$where/$tmpl" ) { + return ( $theme, $lang, [ uniq(@themes) ] ); } } - # Otherwise, return prog theme in English 'en' - return ('prog', 'en', \@themes); + # Otherwise return theme/'en', last resort fallback/'en' + for my $theme (@themes) { + if ( -e "$htdocs/$theme/en/$where/$tmpl" ) { + return ( $theme, 'en', [ uniq(@themes) ] ); + } + } + # tmpl is a full path, so this is a template for a plugin + if ( $tmpl =~ /^\// && -e $tmpl ) { + return ( $themes[0], $lang, [ uniq(@themes) ] ); + } } sub setlanguagecookie { my ( $query, $language, $uri ) = @_; + + my $cookie = getlanguagecookie( $query, $language ); + + # We do not want to set getlanguage in cache, some additional checks are + # done in C4::Languages::getlanguage + Koha::Cache::Memory::Lite->get_instance()->clear_from_cache( 'getlanguage' ); + + print $query->redirect( + -uri => $uri, + -cookie => $cookie + ); +} + +=head2 getlanguagecookie + + my $cookie = getlanguagecookie($query,$language); + +Returns a cookie object containing the calculated language to be used. + +=cut + +sub getlanguagecookie { + my ( $query, $language ) = @_; my $cookie = $query->cookie( -name => 'KohaOpacLanguage', -value => $language, -HttpOnly => 1, -expires => '+3y' ); - print $query->redirect( - -uri => $uri, - -cookie => $cookie - ); + + return $cookie; } +=head2 GetColumnDefs -sub getlanguage { - my ($query, $interface) = @_; + my $columns = GetColumnDefs( $cgi ) - # Select a language based on cookie, syspref available languages & browser - my $preference_to_check = - $interface eq 'intranet' ? 'language' : 'opaclanguages'; - my @languages = split /,/, C4::Context->preference($preference_to_check); +It is passed a CGI object and returns a hash of hashes containing +the column names and descriptions for each table defined in the +columns.def file corresponding to the CGI object. - my $lang; +=cut - # cookie - if ( $query->cookie('KohaOpacLanguage') ) { - $lang = $query->cookie('KohaOpacLanguage'); - $lang =~ s/[^a-zA-Z_-]*//; # sanitize cookie - } +sub GetColumnDefs { - # HTTP_ACCEPT_LANGUAGE - if ( !$lang && $ENV{HTTP_ACCEPT_LANGUAGE} ) { - $lang = accept_language( $ENV{HTTP_ACCEPT_LANGUAGE}, - getTranslatedLanguages( $interface, 'prog' ) ); - } + my $query = shift; - # Ignore a lang not selected in sysprefs - if ( $lang && any { $_ eq $lang } @languages ) { - return $lang; + my $columns = {}; + + my $htdocs = C4::Context->config('intrahtdocs'); + my $columns_file = 'columns.def'; + + # Get theme and language to build the path to columns.def + my ($theme, $lang, $availablethemes) = + themelanguage($htdocs, 'about.tt', 'intranet', $query); + # Build columns.def path + my $path = "$htdocs/$theme/$lang/$columns_file"; + my $fh; + if ( ! open ( $fh, q{<:encoding(utf-8)}, $path ) ) { + carp "Error opening $path. Check your templates."; + return; + } + # Loop through the columns.def file + while ( my $input = <$fh> ){ + chomp $input; + if ( $input =~ m|(.*)| ) { + my ( $table, $column ) = split( '\.', $1); + my $description = $2; + # Initialize the table array if needed. + @{$columns->{ $table }} = () if ! defined $columns->{ $table }; + # Push field and description + push @{$columns->{ $table }}, + { field => $column, description => $description }; + } } + close $fh; - # Fall back to English if necessary - return 'en'; + return $columns; } 1;