Bug 26922: Regression tests
[koha.git] / C4 / Output.pm
blob8ea7bb51fa986e20ead5e2ea607369a9a27ce5ae
1 package C4::Output;
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
12 # under the terms of the GNU General Public License as published by
13 # the Free Software Foundation; either version 3 of the License, or
14 # (at your option) any later version.
16 # Koha is distributed in the hope that it will be useful, but
17 # WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 # GNU General Public License for more details.
21 # You should have received a copy of the GNU General Public License
22 # along with Koha; if not, see <http://www.gnu.org/licenses>.
25 # NOTE: I'm pretty sure this module is deprecated in favor of
26 # templates.
28 use Modern::Perl;
30 use URI::Escape;
31 use Scalar::Util qw( looks_like_number );
33 use C4::Auth qw(get_template_and_user);
34 use C4::Context;
35 use C4::Templates;
37 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
39 BEGIN {
40 require Exporter;
42 @ISA = qw(Exporter);
43 @EXPORT_OK = qw(&is_ajax ajax_fail); # More stuff should go here instead
44 %EXPORT_TAGS = ( all =>[qw(setlanguagecookie pagination_bar parametrized_url
45 &output_with_http_headers &output_ajax_with_http_headers &output_html_with_http_headers)],
46 ajax =>[qw(&output_with_http_headers &output_ajax_with_http_headers is_ajax)],
47 html =>[qw(&output_with_http_headers &output_html_with_http_headers)]
49 push @EXPORT, qw(
50 setlanguagecookie getlanguagecookie pagination_bar parametrized_url
52 push @EXPORT, qw(
53 &output_html_with_http_headers &output_ajax_with_http_headers &output_with_http_headers
54 &output_and_exit_if_error &output_and_exit &output_error
59 =head1 NAME
61 C4::Output - Functions for managing output, is slowly being deprecated
63 =head1 FUNCTIONS
65 =over 2
67 =item pagination_bar
69 pagination_bar($base_url, $nb_pages, $current_page, $startfrom_name)
71 Build an HTML pagination bar based on the number of page to display, the
72 current page and the url to give to each page link.
74 C<$base_url> is the URL for each page link. The
75 C<$startfrom_name>=page_number is added at the end of the each URL.
77 C<$nb_pages> is the total number of pages available.
79 C<$current_page> is the current page number. This page number won't become a
80 link.
82 This function returns HTML, without any language dependency.
84 =cut
86 sub pagination_bar {
87 my $base_url = (@_ ? shift : return);
88 my $nb_pages = (@_) ? shift : 1;
89 my $current_page = (@_) ? shift : undef; # delay default until later
90 my $startfrom_name = (@_) ? shift : 'page';
91 my $additional_parameters = shift || {};
93 $current_page = looks_like_number($current_page) ? $current_page : undef;
94 $nb_pages = looks_like_number($nb_pages) ? $nb_pages : undef;
96 # how many pages to show before and after the current page?
97 my $pages_around = 2;
99 my $delim = qr/\&(?:amp;)?|;/; # "non memory" cluster: no backreference
100 $base_url =~ s/$delim*\b$startfrom_name=(\d+)//g; # remove previous pagination var
101 unless (defined $current_page and $current_page > 0 and $current_page <= $nb_pages) {
102 $current_page = ($1) ? $1 : 1; # pull current page from param in URL, else default to 1
103 # $debug and # FIXME: use C4::Debug;
104 # warn "with QUERY_STRING:" .$ENV{QUERY_STRING}. "\ncurrent_page:$current_page\n1:$1 2:$2 3:$3";
106 $base_url =~ s/($delim)+/$1/g; # compress duplicate delims
107 $base_url =~ s/$delim;//g; # remove empties
108 $base_url =~ s/$delim$//; # remove trailing delim
110 my $url = $base_url . (($base_url =~ m/$delim/ or $base_url =~ m/\?/) ? '&amp;' : '?' ) . $startfrom_name . '=';
111 my $url_suffix;
112 while ( my ( $k, $v ) = each %$additional_parameters ) {
113 $url_suffix .= '&amp;' . URI::Escape::uri_escape_utf8($k) . '=' . URI::Escape::uri_escape_utf8($v);
115 my $pagination_bar = '';
117 # navigation bar useful only if more than one page to display !
118 if ( $nb_pages > 1 ) {
120 # link to first page?
121 if ( $current_page > 1 ) {
122 $pagination_bar .=
123 "\n" . '&nbsp;'
124 . '<a href="'
125 . $url
126 . '1'
127 . $url_suffix
128 . '"rel="start">'
129 . '&lt;&lt;' . '</a>';
131 else {
132 $pagination_bar .=
133 "\n" . '&nbsp;<span class="inactive">&lt;&lt;</span>';
136 # link on previous page ?
137 if ( $current_page > 1 ) {
138 my $previous = $current_page - 1;
140 $pagination_bar .=
141 "\n" . '&nbsp;'
142 . '<a href="'
143 . $url
144 . $previous
145 . $url_suffix
146 . '" rel="prev">' . '&lt;' . '</a>';
148 else {
149 $pagination_bar .=
150 "\n" . '&nbsp;<span class="inactive">&lt;</span>';
153 my $min_to_display = $current_page - $pages_around;
154 my $max_to_display = $current_page + $pages_around;
155 my $last_displayed_page = undef;
157 for my $page_number ( 1 .. $nb_pages ) {
158 if (
159 $page_number == 1
160 or $page_number == $nb_pages
161 or ( $page_number >= $min_to_display
162 and $page_number <= $max_to_display )
165 if ( defined $last_displayed_page
166 and $last_displayed_page != $page_number - 1 )
168 $pagination_bar .=
169 "\n" . '&nbsp;<span class="inactive">...</span>';
172 if ( $page_number == $current_page ) {
173 $pagination_bar .=
174 "\n" . '&nbsp;'
175 . '<span class="currentPage">'
176 . $page_number
177 . '</span>';
179 else {
180 $pagination_bar .=
181 "\n" . '&nbsp;'
182 . '<a href="'
183 . $url
184 . $page_number
185 . $url_suffix
186 . '">'
187 . $page_number . '</a>';
189 $last_displayed_page = $page_number;
193 # link on next page?
194 if ( $current_page < $nb_pages ) {
195 my $next = $current_page + 1;
197 $pagination_bar .= "\n"
198 . '&nbsp;<a href="'
199 . $url
200 . $next
201 . $url_suffix
202 . '" rel="next">' . '&gt;' . '</a>';
204 else {
205 $pagination_bar .=
206 "\n" . '&nbsp;<span class="inactive">&gt;</span>';
209 # link to last page?
210 if ( $current_page != $nb_pages ) {
211 $pagination_bar .= "\n"
212 . '&nbsp;<a href="'
213 . $url
214 . $nb_pages
215 . $url_suffix
216 . '" rel="last">'
217 . '&gt;&gt;' . '</a>';
219 else {
220 $pagination_bar .=
221 "\n" . '&nbsp;<span class="inactive">&gt;&gt;</span>';
225 return $pagination_bar;
228 =item output_with_http_headers
230 &output_with_http_headers($query, $cookie, $data, $content_type[, $status[, $extra_options]])
232 Outputs $data with the appropriate HTTP headers,
233 the authentication cookie $cookie and a Content-Type specified in
234 $content_type.
236 If applicable, $cookie can be undef, and it will not be sent.
238 $content_type is one of the following: 'html', 'js', 'json', 'opensearchdescription', 'xml', 'rss', or 'atom'.
240 $status is an HTTP status message, like '403 Authentication Required'. It defaults to '200 OK'.
242 $extra_options is hashref. If the key 'force_no_caching' is present and has
243 a true value, the HTTP headers include directives to force there to be no
244 caching whatsoever.
246 =cut
248 sub output_with_http_headers {
249 my ( $query, $cookie, $data, $content_type, $status, $extra_options ) = @_;
250 $status ||= '200 OK';
252 $extra_options //= {};
254 my %content_type_map = (
255 'html' => 'text/html',
256 'js' => 'text/javascript',
257 'json' => 'application/json',
258 'xml' => 'text/xml',
259 # NOTE: not using application/atom+xml or application/rss+xml because of
260 # Internet Explorer 6; see bug 2078.
261 'rss' => 'text/xml',
262 'atom' => 'text/xml',
263 'opensearchdescription' => 'application/opensearchdescription+xml',
266 die "Unknown content type '$content_type'" if ( !defined( $content_type_map{$content_type} ) );
267 my $cache_policy = 'no-cache';
268 $cache_policy .= ', no-store, max-age=0' if $extra_options->{force_no_caching};
269 my $options = {
270 type => $content_type_map{$content_type},
271 status => $status,
272 charset => 'UTF-8',
273 Pragma => 'no-cache',
274 'Cache-Control' => $cache_policy,
275 'X-Frame-Options' => 'SAMEORIGIN',
277 $options->{expires} = 'now' if $extra_options->{force_no_caching};
278 $options->{'Access-Control-Allow-Origin'} = C4::Context->preference('AccessControlAllowOrigin')
279 if C4::Context->preference('AccessControlAllowOrigin');
281 $options->{cookie} = $cookie if $cookie;
282 if ($content_type eq 'html') { # guaranteed to be one of the content_type_map keys, else we'd have died
283 $options->{'Content-Style-Type' } = 'text/css';
284 $options->{'Content-Script-Type'} = 'text/javascript';
287 # We can't encode here, that will double encode our templates, and xslt
288 # We need to fix the encoding as it comes out of the database, or when we pass the variables to templates
290 $data =~ s/\&amp\;amp\; /\&amp\; /g;
291 print $query->header($options), $data;
294 sub output_html_with_http_headers {
295 my ( $query, $cookie, $data, $status, $extra_options ) = @_;
296 output_with_http_headers( $query, $cookie, $data, 'html', $status, $extra_options );
300 sub output_ajax_with_http_headers {
301 my ( $query, $js ) = @_;
302 print $query->header(
303 -type => 'text/javascript',
304 -charset => 'UTF-8',
305 -Pragma => 'no-cache',
306 -'Cache-Control' => 'no-cache',
307 -expires => '-1d',
308 ), $js;
311 sub is_ajax {
312 my $x_req = $ENV{HTTP_X_REQUESTED_WITH};
313 return ( $x_req and $x_req =~ /XMLHttpRequest/i ) ? 1 : 0;
316 =item output_and_exit_if_error
318 output_and_exit_if_error( $query, $cookie, $template, $params );
320 To executed at the beginning of scripts to stop the script at this point if
321 some errors are found.
323 Tests for module 'members':
324 * patron is not defined (we are looking for a patron that does no longer exist/never existed)
325 * The logged in user cannot see patron's infos (feature 'cannot_see_patron_infos')
327 Others will be added here depending on the needs (for instance biblio does not exist will be useful).
329 =cut
331 sub output_and_exit_if_error {
332 my ( $query, $cookie, $template, $params ) = @_;
333 my $error;
334 if ( $params and exists $params->{module} ) {
335 if ( $params->{module} eq 'members' ) {
336 my $logged_in_user = $params->{logged_in_user};
337 my $current_patron = $params->{current_patron};
338 if ( not $current_patron ) {
339 $error = 'unknown_patron';
341 elsif( not $logged_in_user->can_see_patron_infos( $current_patron ) ) {
342 $error = 'cannot_see_patron_infos';
344 } elsif ( $params->{module} eq 'cataloguing' ) {
345 # We are testing the record to avoid additem to fetch the Koha::Biblio
346 # But in the long term we will want to get a biblio in parameter
347 $error = 'unknown_biblio' unless $params->{record};
351 output_and_exit( $query, $cookie, $template, $error ) if $error;
352 return;
355 =item output_and_exit
357 output_and_exit( $query, $cookie, $template, $error );
359 $error is a blocking error like biblionumber not found or so.
360 We should output the error and exit.
362 =cut
364 sub output_and_exit {
365 my ( $query, $cookie, $template, $error ) = @_;
366 $template->param( blocking_error => $error );
367 output_html_with_http_headers ( $query, $cookie, $template->output );
368 exit;
371 sub output_error {
372 my ( $query, $error ) = @_;
373 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
375 template_name => 'errors/errorpage.tt',
376 query => $query,
377 type => 'intranet',
378 authnotrequired => 1,
381 my $admin = C4::Context->preference('KohaAdminEmailAddress');
382 $template->param (
383 admin => $admin,
384 errno => $error,
386 output_with_http_headers $query, $cookie, $template->output, 'html', '404 Not Found';
389 sub parametrized_url {
390 my $url = shift || ''; # ie page.pl?ln={LANG}
391 my $vars = shift || {}; # ie { LANG => en }
392 my $ret = $url;
393 while ( my ($key,$val) = each %$vars) {
394 my $val_url = URI::Escape::uri_escape_utf8( $val // q{} );
395 $ret =~ s/\{$key\}/$val_url/g;
397 $ret =~ s/\{[^\{]*\}//g; # remove remaining vars
398 return $ret;
401 END { } # module clean-up code here (global destructor)
404 __END__
406 =back
408 =head1 AUTHOR
410 Koha Development Team <http://koha-community.org/>
412 =cut