Bug 8761 Dont inadvertantly use slices
[koha.git] / C4 / Templates.pm
index 37e8932..507e077 100644 (file)
@@ -4,6 +4,7 @@ use strict;
 use warnings;
 use Carp;
 use CGI;
+use List::MoreUtils qw/any/;
 
 # Copyright 2009 Chris Cormack and The Koha Dev Team
 #
@@ -35,7 +36,7 @@ use C4::Languages qw(getTranslatedLanguages get_bidi regex_lang_subtags language
 
 use C4::Context;
 
-__PACKAGE__->mk_accessors(qw( theme lang filename htdocs interface vars));
+__PACKAGE__->mk_accessors(qw( theme activethemes preferredtheme lang filename htdocs interface vars));
 
 
 
@@ -52,15 +53,20 @@ sub new {
     else {
         $htdocs = C4::Context->config('intrahtdocs');
     }
-
-    my ($theme, $lang)= themelanguage( $htdocs, $tmplbase, $interface, $query);
+    my ($theme, $lang, $activethemes)= themelanguage( $htdocs, $tmplbase, $interface, $query);
+    my @includes;
+    foreach (@$activethemes) {
+        push @includes, "$htdocs/$_/$lang/includes";
+        push @includes, "$htdocs/$_/en/includes" unless $lang eq 'en';
+    }
     my $template = Template->new(
-        {
-            EVAL_PERL    => 1,
+        {   EVAL_PERL    => 1,
             ABSOLUTE     => 1,
-            INCLUDE_PATH => "$htdocs/$theme/$lang/includes",
-            FILTERS      => {},
-
+            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'):'',,
+            INCLUDE_PATH => \@includes,
+            FILTERS => {},
         }
     ) or die Template->error();
     my $self = {
@@ -70,6 +76,8 @@ sub new {
     bless $self, $class;
     $self->theme($theme);
     $self->lang($lang);
+    $self->activethemes($activethemes);
+    $self->preferredtheme($activethemes->[0]);
     $self->filename($filename);
     $self->htdocs($htdocs);
     $self->interface($interface);
@@ -91,18 +99,19 @@ sub output {
         $vars->{themelang} = '/opac-tmpl';
     }
     $vars->{lang} = $self->lang;
-    $vars->{themelang} .= '/' . $self->theme . '/' . $self->lang;
+    $vars->{themelang} .= '/' . $self->preferredtheme . '/' . $self->lang;
     $vars->{yuipath} =
       ( C4::Context->preference("yuipath") eq "local"
-        ? $vars->{themelang} . "/lib/yui"
+        ? ( $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');
+        C4::Context->preference('opaccolorstylesheet');
     $vars->{opacsmallimage} = C4::Context->preference('opacsmallimage');
-    $vars->{opacstylesheet} = C4::Context->preference('opacstylesheet');
+    $vars->{opaclayoutstylesheet} =
+        C4::Context->preference('opaclayoutstylesheet');
 
     # add variables set via param to $vars for processing
     # and clean any utf8 mess
@@ -168,57 +177,6 @@ sub _current_language {
     return $_current_language;
 }
 
-sub themelanguage_lite {
-    my ( $htdocs, $tmpl, $interface ) = @_;
-    my $query = new CGI;
-
-    # Set some defaults for language and theme
-    # First, check the user's preferences
-    my $lang;
-
-    # But, if there's a cookie set, obey it
-    $lang = $query->cookie('KohaOpacLanguage')
-      if ( defined $query and $query->cookie('KohaOpacLanguage') );
-
-    # Fall back to English
-    my @languages;
-    if ( $interface eq 'intranet' ) {
-        @languages = split ",", C4::Context->preference("language");
-    }
-    else {
-        @languages = split ",", C4::Context->preference("opaclanguages");
-    }
-    if ($lang) {
-        @languages = ( $lang, @languages );
-    }
-    else {
-        $lang = $languages[0] || 'en';
-    }
-    my $theme = 'prog'; # in the event of theme failure default to 'prog' -fbcit
-    my @themes;
-    if ( $interface eq "intranet" ) {
-        @themes = split " ", C4::Context->preference("template");
-    }
-    else {
-        @themes = split " ", C4::Context->preference("opacthemes");
-    }
-
- # 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) {
-            if ( -e "$htdocs/$th/$la/modules/$tmpl" ) {
-                $theme = $th;
-                $lang  = $la;
-                last THEME;
-            }
-            last unless $la =~ /[-_]/;
-        }
-    }
-    $_current_language = $lang;  # FIXME part of bad hack to paper over bug 4403
-    return ( $theme, $lang );
-}
 
 # wrapper method to allow easier transition from HTML template pro to Template Toolkit
 sub param {
@@ -228,7 +186,11 @@ sub param {
         my $val = shift;
         if    ( ref($val) eq 'ARRAY' && !scalar @$val ) { $val = undef; }
         elsif ( ref($val) eq 'HASH'  && !scalar %$val ) { $val = undef; }
-        $self->{VARS}->{$key} = $val;
+        if ( $key ) {
+            $self->{VARS}->{$key} = $val;
+        } else {
+            warn "Problem = a value of $val has been passed to param without key";
+        }
     }
 }
 
@@ -249,10 +211,11 @@ my $path = C4::Context->config('intrahtdocs') . "/prog/en/includes/";
 # FIXME - POD
 
 sub _get_template_file {
-    my ( $tmplbase, $interface, $query ) = @_;
-    my $htdocs = C4::Context->config( $interface ne 'intranet' ? 'opachtdocs' : 'intrahtdocs' );
-    my ( $theme, $lang ) = themelanguage( $htdocs, $tmplbase, $interface, $query );
-    my $opacstylesheet = C4::Context->preference('opacstylesheet');
+    my ($tmplbase, $interface, $query) = @_;
+
+    my $is_intranet = $interface eq 'intranet';
+    my $htdocs = C4::Context->config($is_intranet ? 'intrahtdocs' : 'opachtdocs');
+    my ($theme, $lang, $availablethemes) = themelanguage($htdocs, $tmplbase, $interface, $query);
 
     # if the template doesn't exist, load the English one as a last resort
     my $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
@@ -260,27 +223,33 @@ sub _get_template_file {
         $lang = 'en';
         $filename = "$htdocs/$theme/$lang/modules/$tmplbase";
     }
-
-    return ( $htdocs, $theme, $lang, $filename );
+    return ($htdocs, $theme, $lang, $filename);
 }
 
+
 sub gettemplate {
     my ( $tmplbase, $interface, $query ) = @_;
     ($query) or warn "no query in gettemplate";
     my $path = C4::Context->preference('intranet_includes') || 'includes';
-    my $opacstylesheet = C4::Context->preference('opacstylesheet');
     $tmplbase =~ s/\.tmpl$/.tt/;
-    my ( $htdocs, $theme, $lang, $filename ) = _get_template_file( $tmplbase, $interface, $query );
+    my ($htdocs, $theme, $lang, $filename)
+       =  _get_template_file($tmplbase, $interface, $query);
     my $template = C4::Templates->new($interface, $filename, $tmplbase, $query);
-    my $themelang=( $interface ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' )
-          . "/$theme/$lang";
-    $template->param(
-        themelang => $themelang,
-        yuipath   => (C4::Context->preference("yuipath") eq "local"?"$themelang/lib/yui":C4::Context->preference("yuipath")),
-        interface => ( $interface ne 'intranet' ? '/opac-tmpl' : '/intranet-tmpl' ),
-        theme     => $theme,
-        lang      => $lang
-    );
+# 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';
+#    my $themelang =
+#        ($is_intranet ? '/intranet-tmpl' : '/opac-tmpl') .
+#        "/$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
     my $current_lang = regex_lang_subtags($lang);
@@ -307,73 +276,36 @@ sub gettemplate {
 #---------------------------------------------------------------------------------------------------------
 # FIXME - POD
 sub themelanguage {
-    my ( $htdocs, $tmpl, $interface, $query ) = @_;
+    my ($htdocs, $tmpl, $interface, $query) = @_;
     ($query) or warn "no query in themelanguage";
 
-    # Set some defaults for language and theme
-    # First, check the user's preferences
-    my $lang;
-    my $http_accept_language = $ENV{ HTTP_ACCEPT_LANGUAGE };
-    $lang = accept_language( $http_accept_language, 
-              getTranslatedLanguages($interface,'prog') )
-      if $http_accept_language;
-    # But, if there's a cookie set, obey it
-    $lang = $query->cookie('KohaOpacLanguage') if (defined $query and $query->cookie('KohaOpacLanguage'));
-    # Fall back to English
-    my @languages;
-    if ($interface eq 'intranet') {
-        @languages = split ",", C4::Context->preference("language");
-    } else {
-        @languages = split ",", C4::Context->preference("opaclanguages");
-    }
-    if ($lang){  
-        @languages=($lang,@languages);
-    } else {
-        $lang = $languages[0];
-    }      
-    my $theme = 'prog';        # in the event of theme failure default to 'prog' -fbcit
-    my $dbh = C4::Context->dbh;
-    my @themes;
-    if ( $interface eq "intranet" ) {
-        @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');
-        @themes = split " ", C4::Context->preference("opacthemes");
-    }
+    # Select a language based on cookie, syspref available languages & browser
+    my $lang = getlanguage($query, $interface);
 
- # 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 ) {
-                # warn "$htdocs/$th/$la/modules/$interface-"."tmpl";
-                #$la =~ s/([-_])/ $1 eq '-'? '_': '-' /eg if $pass == 2;
-                               if ( -e "$htdocs/$th/$la/modules/$tmpl") {
-                #".($interface eq 'intranet'?"modules":"")."/$tmpl" ) {
-                    $theme = $th;
-                    $lang  = $la;
-                    last THEME;
-                }
-                last unless $la =~ /[-_]/;
-            #}
+    # 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
+    for my $theme (@themes) {
+        if ( -e "$htdocs/$theme/$lang/modules/$tmpl" ) {
+            $_current_language = $lang;
+            return ($theme, $lang, \@themes)
         }
     }
-
-    $_current_language = $lang; # FIXME part of bad hack to paper over bug 4403
-    return ( $theme, $lang );
+    # Otherwise, return prog theme in English 'en'
+    return ('prog', 'en', \@themes);
 }
 
+
 sub setlanguagecookie {
     my ( $query, $language, $uri ) = @_;
     my $cookie = $query->cookie(
         -name    => 'KohaOpacLanguage',
         -value   => $language,
-        -expires => ''
+        -expires => '+3y'
     );
     print $query->redirect(
         -uri    => $uri,
@@ -381,19 +313,36 @@ sub setlanguagecookie {
     );
 }
 
-sub getlanguagecookie {
-    my ($query) = @_;
+
+sub getlanguage {
+    my ($query, $interface) = @_;
+
+    # 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);
+
     my $lang;
-    if ($query->cookie('KohaOpacLanguage')){
-        $lang = $query->cookie('KohaOpacLanguage') ;
-    }else{
-        $lang = $ENV{HTTP_ACCEPT_LANGUAGE};
-        
+
+    # cookie
+    if ( $query->cookie('KohaOpacLanguage') ) {
+        $lang = $query->cookie('KohaOpacLanguage');
+        $lang =~ s/[^a-zA-Z_-]*//; # sanitize cookie
     }
-    $lang = substr($lang, 0, 2);
 
-    return $lang;
+    # HTTP_ACCEPT_LANGUAGE
+    if ( !$lang && $ENV{HTTP_ACCEPT_LANGUAGE} ) {
+        $lang = accept_language( $ENV{HTTP_ACCEPT_LANGUAGE},
+            getTranslatedLanguages( $interface, 'prog' ) );
+    }
+
+    # Ignore a lang not selected in sysprefs
+    if ( $lang && any { $_ eq $lang } @languages ) {
+        return $lang;
+    }
+
+    # Fall back to English if necessary
+    return 'en';
 }
 
 1;
-