1 package OpenILS::WWW::EGWeb;
2 use strict; use warnings;
8 use Apache2::Const -compile => qw(OK DECLINED HTTP_INTERNAL_SERVER_ERROR);
10 use OpenSRF::EX qw(:try);
11 use OpenILS::Utils::CStoreEditor q/:funcs/;
12 use List::MoreUtils qw/uniq/;
14 use constant OILS_HTTP_COOKIE_SKIN => 'eg_skin';
15 use constant OILS_HTTP_COOKIE_THEME => 'eg_theme';
16 use constant OILS_HTTP_COOKIE_LOCALE => 'eg_locale';
18 # cache string bundles
19 my %registered_locales;
23 my $ctx = load_context($r);
24 my $base = $ctx->{base_path};
26 my($template, $page_args, $as_xml) = find_template($r, $base, $ctx);
27 $ctx->{page_args} = $page_args;
29 my $stat = run_context_loader($r, $ctx);
31 return $stat unless $stat == Apache2::Const::OK;
32 return Apache2::Const::DECLINED unless $template;
34 my $text_handler = set_text_handler($ctx, $r);
36 my $tt = Template->new({
38 OUTPUT => ($as_xml) ? sub { parse_as_xml($r, $ctx, @_); } : $r,
39 INCLUDE_PATH => $ctx->{template_paths},
40 DEBUG => $ctx->{debug_template},
42 EGI18N => 'OpenILS::WWW::EGWeb::I18NFilter',
43 CGI_utf8 => 'OpenILS::WWW::EGWeb::CGI_utf8'
46 # Register a dynamic filter factory for our locale::maketext generator
50 return sub { $text_handler->(shift(), @args); }
57 $r->log->error("Error creating template processor: $@");
58 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
61 $ctx->{encode_utf8} = sub {return encode_utf8(shift())};
63 unless($tt->process($template, {ctx => $ctx, ENV => \%ENV, l => $text_handler})) {
64 $r->log->warn('egweb: template error: ' . $tt->error);
65 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
68 return Apache2::Const::OK;
71 sub set_text_handler {
75 my $locale = $ctx->{locale};
77 $r->log->debug("egweb: messages locale = $locale");
80 my $lh = OpenILS::WWW::EGWeb::I18N->get_handle($locale);
81 return $lh->maketext(@_);
87 sub run_context_loader {
91 my $stat = Apache2::Const::OK;
93 my $loader = $r->dir_config('OILSWebContextLoader');
94 return $stat unless $loader;
98 $stat = $loader->new($r, $ctx)->load;
102 $r->log->error("egweb: Context Loader error: $@");
103 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
106 $r->log->debug("egweb: context loader resulted in status $stat");
118 my $doc = XML::LibXML->new->parse_string($data);
119 $data = $doc->documentElement->toStringC14N;
120 $data = $ctx->{final_dtd} . "\n" . $data;
124 my $err = "Invalid XML: $e";
125 $r->log->error("egweb: $err");
126 $r->content_type('text/plain; encoding=utf8');
127 $r->print("\n$err\n\n$data");
130 $r->print($data) if ($success);
136 my $ctx = {}; # new context for each page load
138 $ctx->{base_path} = $r->dir_config('OILSWebBasePath');
139 $ctx->{web_dir} = $r->dir_config('OILSWebWebDir');
140 $ctx->{debug_template} = ($r->dir_config('OILSWebDebugTemplate') =~ /true/io);
141 $ctx->{media_prefix} = $r->dir_config('OILSWebMediaPrefix');
142 $ctx->{hostname} = $r->hostname;
143 $ctx->{base_url} = $cgi->url(-base => 1);
144 $ctx->{skin} = $cgi->cookie(OILS_HTTP_COOKIE_SKIN) || 'default';
145 $ctx->{theme} = $cgi->cookie(OILS_HTTP_COOKIE_THEME) || 'default';
146 $ctx->{proto} = $cgi->https ? 'https' : 'http';
148 my @template_paths = uniq $r->dir_config->get('OILSWebTemplatePath');
149 $ctx->{template_paths} = [ reverse @template_paths ];
151 my %locales = $r->dir_config->get('OILSWebLocale');
152 load_locale_handlers($ctx, %locales);
154 $ctx->{locales} = \%registered_locales;
156 # Set a locale cookie if the requested locale is valid
157 my $set_locale = $cgi->param('set_eg_locale');
158 if (!(grep {$_ eq $set_locale} keys %registered_locales)) {
161 my $slc = $cgi->cookie({
162 '-name' => OILS_HTTP_COOKIE_LOCALE,
163 '-value' => $set_locale,
166 $r->headers_out->add('Set-Cookie' => $slc);
169 $ctx->{locale} = $set_locale ||
170 $cgi->cookie(OILS_HTTP_COOKIE_LOCALE) ||
171 parse_accept_lang($r->headers_in->get('Accept-Language')) || 'en_us';
173 my $mprefix = $ctx->{media_prefix};
174 if($mprefix and $mprefix !~ /^http/ and $mprefix !~ /^\//) {
175 # if a hostname is provided /w no protocol, match the protocol to the current page
176 $ctx->{media_prefix} = ($cgi->https) ? "https://$mprefix" : "http://$mprefix";
182 # turn Accept-Language into sometihng EG can understand
183 # TODO: try all langs, not just the first
184 sub parse_accept_lang {
186 return undef unless $al;
187 my ($locale) = split(/,/, $al);
188 ($locale) = split(/;/, $locale);
189 return undef unless $locale;
194 # Given a URI, finds the configured template and any extra page
195 # arguments (trailing path info). Any extra data is returned
196 # as page arguments, in the form of an array, one item per
197 # /-separated URI component
203 $path =~ s/$base\/?//og;
206 my $as_xml = $r->dir_config('OILSWebForceValidXML');
207 my $ext = $r->dir_config('OILSWebDefaultTemplateExtension');
209 my @parts = split('/', $path);
210 my $localpath = $path;
212 if ($localpath =~ m|opac/css|) {
213 $r->content_type('text/css; encoding=utf8');
215 $r->content_type('text/html; encoding=utf8');
219 last unless $localpath;
220 for my $tpath (@{$ctx->{template_paths}}) {
221 my $fpath = "$tpath/$localpath.$ext";
222 $r->log->debug("egweb: looking at possible template $fpath");
224 $template = "$localpath.$ext";
229 push(@args, pop @parts);
230 $localpath = join('/', @parts);
233 $page_args = [@args];
235 # no template configured or found
237 $r->log->debug("egweb: No template configured for path $path");
241 $r->log->debug("egweb: template = $template : page args = @$page_args");
242 return ($template, $page_args, $as_xml);
245 # Create an I18N sub-module for each supported locale
246 # Each module creates its own MakeText lexicon by parsing .po/.mo files
247 sub load_locale_handlers {
251 my $editor = new_editor();
252 my @locale_tags = sort { length($a) <=> length($b) } keys %locales;
254 # always fall back to en_us, the assumed template language
255 push(@locale_tags, 'en_us');
257 for my $idx (0..$#locale_tags) {
259 my $tag = $locale_tags[$idx];
260 next if grep { $_ eq $tag } keys %registered_locales;
262 my $res = $editor->json_query({
264 "evergreen.get_locale_name",
269 my $locale_name = $res->[0]->{"name"} if exists $res->[0]->{"name"};
270 next unless $locale_name;
275 # find the parent locale if possible. It will be
276 # longest left-anchored substring of the current tag
277 while( --$sub_idx >= 0 ) {
278 my $ptag = $locale_tags[$sub_idx];
279 if( substr($tag, 0, length($ptag)) eq $ptag ) {
280 $parent_tag = "::$ptag";
285 my $messages = $locales{$tag} || '';
287 # TODO Can we do this without eval?
288 my $eval = <<" EVAL";
289 package OpenILS::WWW::EGWeb::I18N::$tag;
290 use base 'OpenILS::WWW::EGWeb::I18N$parent_tag';
292 use Locale::Maketext::Lexicon {
295 use Locale::Maketext::Lexicon::Gettext;
296 if(open F, '$messages') {
297 our %Lexicon = (%Lexicon, %{ Locale::Maketext::Lexicon::Gettext->parse(<F>) });
300 warn "EGWeb: unable to open messages file: $messages";
309 $registered_locales{"$tag"} = $locale_name;
315 # base class for all supported locales
316 package OpenILS::WWW::EGWeb::I18N;
317 use base 'Locale::Maketext';
318 our %Lexicon = (_AUTO => 1);