Bug 12571 - Add ability to customize SIP2 screen messages
[koha-ffzg.git] / C4 / Templates.pm
index 7f50143..6a9d48b 100644 (file)
@@ -67,7 +67,6 @@ sub new {
             COMPILE_DIR => C4::Context->config('template_cache_dir')?C4::Context->config('template_cache_dir'):'',,
             INCLUDE_PATH => \@includes,
             FILTERS => {},
-            ENCODING => 'utf8', # templates don't have BOM, see Template::FAQ
         }
     ) or die Template->error();
     my $self = {
@@ -110,34 +109,60 @@ sub output {
     $vars->{theme} = $self->theme;
     $vars->{opaccolorstylesheet} =
         C4::Context->preference('opaccolorstylesheet');
-    $vars->{opacsmallimage} = C4::Context->preference('opacsmallimage');
     $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});
+        }
     }
     my $data;
+#    binmode( STDOUT, ":utf8" );
     $template->process( $self->filename, $vars, \$data )
       || die "Template process failed: ", $template->error();
     return $data;
 }
 
-
-# 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;
+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});
+    }
 }
 
-
 # wrapper method to allow easier transition from HTML template pro to Template Toolkit
 sub param {
     my $self = shift;
@@ -191,32 +216,18 @@ sub gettemplate {
     my ( $tmplbase, $interface, $query, $is_plugin ) = @_;
     ($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);
     $filename = $tmplbase if ( $is_plugin );
     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';
-#    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
+    # 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;
@@ -225,11 +236,11 @@ 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;
 }
@@ -242,7 +253,7 @@ sub themelanguage {
     ($query) or warn "no query in themelanguage";
 
     # Select a language based on cookie, syspref available languages & browser
-    my $lang = getlanguage($query, $interface);
+    my $lang = C4::Languages::getlanguage($query);
 
     # Select theme
     my $is_intranet = $interface eq 'intranet';
@@ -253,7 +264,6 @@ sub themelanguage {
     # 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)
         }
     }
@@ -264,6 +274,7 @@ sub themelanguage {
 
 sub setlanguagecookie {
     my ( $query, $language, $uri ) = @_;
+
     my $cookie = $query->cookie(
         -name    => 'KohaOpacLanguage',
         -value   => $language,
@@ -276,36 +287,71 @@ sub setlanguagecookie {
     );
 }
 
+=head2 getlanguagecookie
 
-sub getlanguage {
-    my ($query, $interface) = @_;
+    my $cookie = getlanguagecookie($query,$language);
 
-    # 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);
+Returns a cookie object containing the calculated language to be used.
 
-    my $lang;
+=cut
 
-    # cookie
-    if ( $query->cookie('KohaOpacLanguage') ) {
-        $lang = $query->cookie('KohaOpacLanguage');
-        $lang =~ s/[^a-zA-Z_-]*//; # sanitize cookie
-    }
+sub getlanguagecookie {
+    my ( $query, $language ) = @_;
+    my $cookie = $query->cookie(
+        -name    => 'KohaOpacLanguage',
+        -value   => $language,
+        -HttpOnly => 1,
+        -expires => '+3y'
+    );
 
-    # HTTP_ACCEPT_LANGUAGE
-    if ( !$lang && $ENV{HTTP_ACCEPT_LANGUAGE} ) {
-        $lang = accept_language( $ENV{HTTP_ACCEPT_LANGUAGE},
-            getTranslatedLanguages( $interface, 'prog' ) );
-    }
+    return $cookie;
+}
+
+=head2 GetColumnDefs
+
+    my $columns = GetColumnDefs( $cgi )
 
-    # Ignore a lang not selected in sysprefs
-    if ( $lang && any { $_ eq $lang } @languages ) {
-        return $lang;
+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.
+
+=cut
+
+sub GetColumnDefs {
+
+    my $query = shift;
+
+    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{<}, $path ) )  {
+        carp "Error opening $path. Check your templates.";
+        return;
+    }
+    # Loop through the columns.def file
+    while ( my $input = <$fh> ){
+        chomp $input;
+        if ( $input =~ m|<field name="(.*)">(.*)</field>| ) {
+            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;