2 # Script to perform searching
3 # For documentation try 'perldoc /path/to/search'
5 # Copyright 2006 LibLime
7 # This file is part of Koha
9 # Koha is free software; you can redistribute it and/or modify it under the
10 # terms of the GNU General Public License as published by the Free Software
11 # Foundation; either version 2 of the License, or (at your option) any later
14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License along
19 # with Koha; if not, write to the Free Software Foundation, Inc.,
20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 search - a search script for finding records in a Koha system (Version 3)
28 This script utilizes a new search API for Koha 3. It is designed to be
29 simple to use and configure, yet capable of performing feats like stemming,
30 field weighting, relevance ranking, support for multiple query language
31 formats (CCL, CQL, PQF), full support for the bib1 attribute set, extended
32 attribute sets defined in Zebra profiles, access to the full range of Z39.50
33 and SRU query options, federated searches on Z39.50/SRU targets, etc.
35 The API as represented in this script is mostly sound, even if the individual
36 functions in Search.pm and Koha.pm need to be cleaned up. Of course, you are
39 I will attempt to describe what is happening at each part of this script.
40 -- Joshua Ferraro <jmf AT liblime DOT com>
44 This script performs two functions:
48 =item 1. interacts with Koha to retrieve and display the results of a search
50 =item 2. loads the advanced search page
54 These two functions share many of the same variables and modules, so the first
55 task is to load what they have in common and determine which template to use.
56 Once determined, proceed to only load the variables and procedures necessary
59 =head2 LOADING ADVANCED SEARCH PAGE
61 This is fairly straightforward, and I won't go into detail ;-)
63 =head2 PERFORMING A SEARCH
65 If we're performing a search, this script performs three primary
70 =item 1. builds query strings (yes, plural)
72 =item 2. perform the search and return the results array
74 =item 3. build the HTML for output to the template
78 There are several additional secondary functions performed that I will
81 =head3 1. Building Query Strings
83 There are several types of queries needed in the process of search and retrieve:
87 =item 1 $query - the fully-built query passed to zebra
89 This is the most complex query that needs to be built. The original design goal
90 was to use a custom CCL2PQF query parser to translate an incoming CCL query into
91 a multi-leaf query to pass to Zebra. It needs to be multi-leaf to allow field
92 weighting, koha-specific relevance ranking, and stemming. When I have a chance
93 I'll try to flesh out this section to better explain.
95 This query incorporates query profiles that aren't compatible with most non-Zebra
96 Z39.50 targets to acomplish the field weighting and relevance ranking.
98 =item 2 $simple_query - a simple query that doesn't contain the field weighting,
99 stemming, etc., suitable to pass off to other search targets
101 This query is just the user's query expressed in CCL CQL, or PQF for passing to a
102 non-zebra Z39.50 target (one that doesn't support the extended profile that Zebra does).
104 =item 3 $query_cgi - passed to the template / saved for future refinements of
107 This is a simple string that completely expresses the query as a CGI string that
108 can be used for future refinements of the query or as a part of a history feature.
110 =item 4 $query_desc - Human search description - what the user sees in search
113 This is a simple string that is human readable. It will contain '=', ',', etc.
117 =head3 2. Perform the Search
119 This section takes the query strings and performs searches on the named servers,
120 including the Koha Zebra server, stores the results in a deeply nested object,
121 builds 'faceted results', and returns these objects.
125 The final major section of this script takes the objects collected thusfar and
126 builds the HTML for output to the template and user.
128 =head3 Additional Notes
134 use strict; # always use
135 #use warnings; FIXME - Bug 2505
137 ## STEP 1. Load things that are used in both search page and
138 # results page and decide which template to load, operations
144 use C4::Auth qw(:DEFAULT get_session);
146 use C4::Languages qw(getAllLanguages);
148 use C4::Members qw(GetMember);
149 use C4::VirtualShelves qw(GetRecentShelves);
150 use POSIX qw(ceil floor);
151 use C4::Branch; # GetBranches
153 my $DisplayMultiPlaceHold = C4::Context->preference("DisplayMultiPlaceHold");
154 # create a new CGI object
155 # FIXME: no_undef_params needs to be tested
156 use CGI qw('-no_undef_params');
159 my ($template,$borrowernumber,$cookie);
161 # decide which template to use
164 my @params = $cgi->param("limit");
165 if ((@params>=1) || ($cgi->param("q")) || ($cgi->param('multibranchlimit')) || ($cgi->param('limit-yr')) ) {
166 $template_name = 'catalogue/results.tmpl';
169 $template_name = 'catalogue/advsearch.tmpl';
170 $template_type = 'advsearch';
173 ($template, $borrowernumber, $cookie) = get_template_and_user({
174 template_name => $template_name,
177 authnotrequired => 0,
178 flagsrequired => { catalogue => 1 },
181 if (C4::Context->preference("marcflavour") eq "UNIMARC" ) {
182 $template->param('UNIMARC' => 1);
185 if($cgi->cookie("holdfor")){
186 my $holdfor_patron = GetMember('borrowernumber' => $cgi->cookie("holdfor"));
188 holdfor => $cgi->cookie("holdfor"),
189 holdfor_surname => $holdfor_patron->{'surname'},
190 holdfor_firstname => $holdfor_patron->{'firstname'},
191 holdfor_cardnumber => $holdfor_patron->{'cardnumber'},
196 # Deprecated, but preserved because it's interesting :-)
197 # The same thing can be accomplished with mod_rewrite in
201 #my $uri = $cgi->url(-base => 1);
202 #my $relative_url = $cgi->url(-relative=>1);
203 #$uri.="/".$relative_url."?";
205 #my @cgi_params_list = $cgi->param();
206 #my $url_params = $cgi->Vars;
208 #for my $each_param_set (@cgi_params_list) {
209 # $uri.= join "", map "\&$each_param_set=".$_, split("\0",$url_params->{$each_param_set}) if $url_params->{$each_param_set};
211 #warn "New URI:$uri";
212 # Only re-write a URI if there are params or if it already hasn't been re-written
213 #unless (($cgi->param('r')) || (!$cgi->param()) ) {
214 # print $cgi->redirect( -uri=>$uri."&r=1",
215 # -cookie => $cookie);
220 my $branches = GetBranches();
222 # Populate branch_loop with all branches sorted by their name. If
223 # independantbranches is activated, set the default branch to the borrower
224 # branch, except for superlibrarian who need to search all libraries.
225 my $user = C4::Context->userenv;
226 my @branch_loop = map {
229 branchname => $branches->{$_}->{branchname},
230 selected => $user->{branch} eq $_ && C4::Branch::onlymine(),
233 $branches->{$a}->{branchname} cmp $branches->{$b}->{branchname}
236 my $categories = GetBranchCategories(undef,'searchdomain');
238 $template->param(branchloop => \@branch_loop, searchdomainloop => $categories);
240 # load the Type stuff
241 # load the Type stuff
242 my $itemtypes = GetItemTypes;
243 # the index parameter is different for item-level itemtypes
244 my $itype_or_itemtype = (C4::Context->preference("item-level_itypes"))?'itype':'itemtype';
248 my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes");
250 if (!$advanced_search_types or $advanced_search_types eq 'itemtypes') { foreach my $thisitemtype ( sort {$itemtypes->{$a}->{'description'} cmp $itemtypes->{$b}->{'description'} } keys %$itemtypes ) {
251 my %row =( number=>$cnt++,
252 ccl => $itype_or_itemtype,
253 code => $thisitemtype,
254 selected => $selected,
255 description => $itemtypes->{$thisitemtype}->{'description'},
257 imageurl=> getitemtypeimagelocation( 'intranet', $itemtypes->{$thisitemtype}->{'imageurl'} ),
259 $selected = 0 if ($selected) ;
260 push @itemtypesloop, \%row;
262 $template->param(itemtypeloop => \@itemtypesloop);
264 my $advsearchtypes = GetAuthorisedValues($advanced_search_types);
265 for my $thisitemtype (sort {$a->{'lib'} cmp $b->{'lib'}} @$advsearchtypes) {
268 ccl => $advanced_search_types,
269 code => $thisitemtype->{authorised_value},
270 selected => $selected,
271 description => $thisitemtype->{'lib'},
273 imageurl=> getitemtypeimagelocation( 'intranet', $thisitemtype->{'imageurl'} ),
275 push @itemtypesloop, \%row;
277 $template->param(itemtypeloop => \@itemtypesloop);
280 # The following should only be loaded if we're bringing up the advanced search template
281 if ( $template_type eq 'advsearch' ) {
283 # load the servers (used for searching -- to do federated searching, etc.)
284 my $primary_servers_loop;# = displayPrimaryServers();
285 $template->param(outer_servers_loop => $primary_servers_loop,);
287 my $secondary_servers_loop;
288 $template->param(outer_sup_servers_loop => $secondary_servers_loop,);
290 # set the default sorting
291 my $default_sort_by = C4::Context->preference('defaultSortField')."_".C4::Context->preference('defaultSortOrder')
292 if (C4::Context->preference('OPACdefaultSortField') && C4::Context->preference('OPACdefaultSortOrder'));
293 $template->param($default_sort_by => 1);
295 # determine what to display next to the search boxes (ie, boolean option
296 # shouldn't appear on the first one, scan indexes should, adding a new
297 # box should only appear on the last, etc.
298 my @search_boxes_array;
299 my $search_boxes_count = C4::Context->preference("OPACAdvSearchInputCount") || 3; # FIXME: using OPAC sysprefs?
300 # FIXME: all this junk can be done in TMPL using __first__ and __last__
301 for (my $i=1;$i<=$search_boxes_count;$i++) {
302 # if it's the first one, don't display boolean option, but show scan indexes
304 push @search_boxes_array, {scan_index => 1};
306 # if it's the last one, show the 'add field' box
307 elsif ($i==$search_boxes_count) {
308 push @search_boxes_array,
315 push @search_boxes_array,
322 $template->param(uc(C4::Context->preference("marcflavour")) => 1,
323 search_boxes_loop => \@search_boxes_array);
325 # load the language limits (for search)
326 my $languages_limit_loop = getAllLanguages();
327 $template->param(search_languages_loop => $languages_limit_loop,);
329 # use the global setting by default
330 if ( C4::Context->preference("expandedSearchOption") == 1) {
331 $template->param( expanded_options => C4::Context->preference("expandedSearchOption") );
333 # but let the user override it
334 if ( ($cgi->param('expanded_options') == 0) || ($cgi->param('expanded_options') == 1 ) ) {
335 $template->param( expanded_options => $cgi->param('expanded_options'));
338 $template->param(virtualshelves => C4::Context->preference("virtualshelves"));
340 output_html_with_http_headers $cgi, $cookie, $template->output;
344 ### OK, if we're this far, we're performing a search, not just loading the advanced search page
346 # Fetch the paramater list as a hash in scalar context:
347 # * returns paramater list as tied hash ref
348 # * we can edit the values by changing the key
349 # * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
350 my $params = $cgi->Vars;
352 # Params that can have more than one value
353 # sort by is used to sort the query
354 # in theory can have more than one but generally there's just one
356 my $default_sort_by = C4::Context->preference('defaultSortField')."_".C4::Context->preference('defaultSortOrder')
357 if (C4::Context->preference('defaultSortField') && C4::Context->preference('defaultSortOrder'));
359 @sort_by = split("\0",$params->{'sort_by'}) if $params->{'sort_by'};
360 $sort_by[0] = $default_sort_by unless $sort_by[0];
361 foreach my $sort (@sort_by) {
362 $template->param($sort => 1);
364 $template->param('sort_by' => $sort_by[0]);
366 # Use the servers defined, or just search our local catalog(default)
368 @servers = split("\0",$params->{'server'}) if $params->{'server'};
370 #FIXME: this should be handled using Context.pm
371 @servers = ("biblioserver");
372 # @servers = C4::Context->config("biblioserver");
374 # operators include boolean and proximity operators and are used
375 # to evaluate multiple operands
377 @operators = split("\0",$params->{'op'}) if $params->{'op'};
379 # indexes are query qualifiers, like 'title', 'author', etc. They
380 # can be single or multiple parameters separated by comma: kw,right-Truncation
382 @indexes = split("\0",$params->{'idx'});
384 # if a simple index (only one) display the index used in the top search box
385 if ($indexes[0] && !$indexes[1]) {
386 $template->param("ms_".$indexes[0] => 1);}
389 # an operand can be a single term, a phrase, or a complete ccl query
391 @operands = split("\0",$params->{'q'}) if $params->{'q'};
393 # limits are use to limit to results to a pre-defined category such as branch or language
395 @limits = split("\0",$params->{'limit'}) if $params->{'limit'};
397 if($params->{'multibranchlimit'}) {
398 push @limits, join(" or ", map { "branch: $_ "} @{GetBranchesInCategory($params->{'multibranchlimit'})}) ;
402 foreach my $limit(@limits) {
403 if ($limit =~/available/) {
407 $template->param(available => $available);
409 # append year limits if they exist
412 if ($params->{'limit-yr'}) {
413 if ($params->{'limit-yr'} =~ /\d{4}-\d{4}/) {
414 my ($yr1,$yr2) = split(/-/, $params->{'limit-yr'});
415 $limit_yr = "yr,st-numeric,ge=$yr1 and yr,st-numeric,le=$yr2";
416 $limit_yr_value = "$yr1-$yr2";
418 elsif ($params->{'limit-yr'} =~ /\d{4}/) {
419 $limit_yr = "yr,st-numeric=$params->{'limit-yr'}";
420 $limit_yr_value = $params->{'limit-yr'};
422 push @limits,$limit_yr;
423 #FIXME: Should return a error to the user, incorect date format specified
426 # convert indexes and operands to corresponding parameter names for the z3950 search
427 # $ %z3950p will be a hash ref if the indexes are present (advacned search), otherwise undef
429 my $indexes2z3950 = {
430 kw=>'title', au=>'author', 'au,phr'=>'author', nb=>'isbn', ns=>'issn',
431 'lcn,phr'=>'dewey', su=>'subject', 'su,phr'=>'subject',
432 ti=>'title', 'ti,phr'=>'title', se=>'title'
434 for (my $ii = 0; $ii < @operands; ++$ii)
436 my $name = $indexes2z3950->{$indexes[$ii]};
437 if (defined $name && defined $operands[$ii])
440 $z3950par->{$name} = $operands[$ii] if !exists $z3950par->{$name};
445 # Params that can only have one value
446 my $scan = $params->{'scan'};
447 my $count = C4::Context->preference('numSearchResults') || 20;
448 my $results_per_page = $params->{'count'} || $count;
449 my $offset = $params->{'offset'} || 0;
450 my $page = $cgi->param('page') || 1;
451 #my $offset = ($page-1)*$results_per_page;
453 my $expanded_facet = $params->{'expand'};
455 # Define some global variables
456 my ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type);
460 ## I. BUILD THE QUERY
461 my $lang = C4::Output::getlanguagecookie($cgi);
462 ( $error,$query,$simple_query,$query_cgi,$query_desc,$limit,$limit_cgi,$limit_desc,$stopwords_removed,$query_type) = buildQuery(\@operators,\@operands,\@indexes,\@limits,\@sort_by,$scan,$lang);
464 ## parse the query_cgi string and put it into a form suitable for <input>s
466 my $scan_index_to_use;
468 for my $this_cgi ( split('&',$query_cgi) ) {
469 next unless $this_cgi;
470 $this_cgi =~ m/(.*=)(.*)/;
472 my $input_value = $2;
473 $input_name =~ s/=$//;
474 push @query_inputs, { input_name => $input_name, input_value => $input_value };
475 if ($input_name eq 'idx') {
476 $scan_index_to_use = $input_value; # unless $scan_index_to_use;
479 $template->param ( QUERY_INPUTS => \@query_inputs,
480 scan_index_to_use => $scan_index_to_use );
482 ## parse the limit_cgi string and put it into a form suitable for <input>s
484 for my $this_cgi ( split('&',$limit_cgi) ) {
485 next unless $this_cgi;
486 # handle special case limit-yr
487 if ($this_cgi =~ /yr,st-numeric/) {
488 push @limit_inputs, { input_name => 'limit-yr', input_value => $limit_yr_value };
491 $this_cgi =~ m/(.*=)(.*)/;
493 my $input_value = $2;
494 $input_name =~ s/=$//;
495 push @limit_inputs, { input_name => $input_name, input_value => $input_value };
497 $template->param ( LIMIT_INPUTS => \@limit_inputs );
499 ## II. DO THE SEARCH AND GET THE RESULTS
500 my $total; # the total results for the whole set
501 my $facets; # this object stores the faceted results that display on the left-hand of the results page
505 if (C4::Context->preference('NoZebra')) {
506 $query=~s/yr(:|=)\s*([\d]{1,4})-([\d]{1,4})/(yr>=$2 and yr<=$3)/g;
507 $simple_query=~s/yr\s*(:|=)([\d]{1,4})-([\d]{1,4})/(yr>=$2 and yr<=$3)/g;
510 ($error, $results_hashref, $facets) = NZgetRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
514 ($error, $results_hashref, $facets) = getRecords($query,$simple_query,\@sort_by,\@servers,$results_per_page,$offset,$expanded_facet,$branches,$query_type,$scan);
517 # This sorts the facets into alphabetical order
519 foreach my $f (@$facets) {
520 $f->{facets} = [ sort { uc($a->{facet_title_value}) cmp uc($b->{facet_title_value}) } @{ $f->{facets} } ];
524 $template->param(query_error => $error.$@);
525 output_html_with_http_headers $cgi, $cookie, $template->output;
529 # At this point, each server has given us a result set
530 # now we build that set for template display
531 my @sup_results_array;
532 for (my $i=0;$i<@servers;$i++) {
533 my $server = $servers[$i];
534 if ($server =~/biblioserver/) { # this is the local bibliographic server
535 $hits = $results_hashref->{$server}->{"hits"};
536 my $page = $cgi->param('page') || 0;
537 my @newresults = searchResults('intranet', $query_desc, $hits, $results_per_page, $offset, $scan,
538 @{$results_hashref->{$server}->{"RECORDS"}});
539 $total = $total + $results_hashref->{$server}->{"hits"};
540 ## If there's just one result, redirect to the detail page
542 my $biblionumber = $newresults[0]->{biblionumber};
543 my $defaultview = C4::Context->preference('IntranetBiblioDefaultView');
544 my $views = { C4::Search::enabled_staff_search_views };
545 if ($defaultview eq 'isbd' && $views->{can_view_ISBD}) {
546 print $cgi->redirect("/cgi-bin/koha/catalogue/ISBDdetail.pl?biblionumber=$biblionumber");
547 } elsif ($defaultview eq 'marc' && $views->{can_view_MARC}) {
548 print $cgi->redirect("/cgi-bin/koha/catalogue/MARCdetail.pl?biblionumber=$biblionumber");
549 } elsif ($defaultview eq 'labeled_marc' && $views->{can_view_labeledMARC}) {
550 print $cgi->redirect("/cgi-bin/koha/catalogue/labeledMARCdetail.pl?biblionumber=$biblionumber");
552 print $cgi->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber");
559 $template->param(total => $hits);
560 my $limit_cgi_not_availablity = $limit_cgi;
561 $limit_cgi_not_availablity =~ s/&limit=available//g;
562 $template->param(limit_cgi_not_availablity => $limit_cgi_not_availablity);
563 $template->param(limit_cgi => $limit_cgi);
564 $template->param(query_cgi => $query_cgi);
565 $template->param(query_desc => $query_desc);
566 $template->param(limit_desc => $limit_desc);
567 $template->param(offset => $offset);
568 $template->param(DisplayMultiPlaceHold => $DisplayMultiPlaceHold);
569 $template->param (z3950_search_params => C4::Search::z3950_search_args($query_desc));
570 if ($query_desc || $limit_desc) {
571 $template->param(searchdesc => 1);
573 $template->param(stopwords_removed => "@$stopwords_removed") if $stopwords_removed;
574 $template->param(results_per_page => $results_per_page);
575 $template->param(SEARCH_RESULTS => \@newresults);
577 ## FIXME: add a global function for this, it's better than the current global one
578 ## Build the page numbers on the bottom of the page
580 # total number of pages there will be
581 my $pages = ceil($hits / $results_per_page);
582 # default page number
583 my $current_page_number = 1;
584 $current_page_number = ($offset / $results_per_page + 1) if $offset;
585 my $previous_page_offset = $offset - $results_per_page unless ($offset - $results_per_page <0);
586 my $next_page_offset = $offset + $results_per_page;
587 # If we're within the first 10 pages, keep it simple
588 #warn "current page:".$current_page_number;
589 if ($current_page_number < 10) {
590 # just show the first 10 pages
591 # Loop through the pages
592 my $pages_to_show = 10;
593 $pages_to_show = $pages if $pages<10;
594 for (my $i=1; $i<=$pages_to_show;$i++) {
595 # the offset for this page
596 my $this_offset = (($i*$results_per_page)-$results_per_page);
597 # the page number for this page
598 my $this_page_number = $i;
599 # it should only be highlighted if it's the current page
600 my $highlight = 1 if ($this_page_number == $current_page_number);
601 # put it in the array
602 push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
608 # now, show twenty pages, with the current one smack in the middle
610 for (my $i=$current_page_number; $i<=($current_page_number + 20 );$i++) {
611 my $this_offset = ((($i-9)*$results_per_page)-$results_per_page);
612 my $this_page_number = $i-9;
613 my $highlight = 1 if ($this_page_number == $current_page_number);
614 if ($this_page_number <= $pages) {
615 push @page_numbers, { offset => $this_offset, pg => $this_page_number, highlight => $highlight, sort_by => join " ",@sort_by };
619 # FIXME: no previous_page_offset when pages < 2
620 $template->param( PAGE_NUMBERS => \@page_numbers,
621 previous_page_offset => $previous_page_offset) unless $pages < 2;
622 $template->param( next_page_offset => $next_page_offset) unless $pages eq $current_page_number;
628 $template->param(searchdesc => 1,query_desc => $query_desc,limit_desc => $limit_desc);
629 $template->param (z3950_search_params => C4::Search::z3950_search_args($z3950par || $query_desc));
632 } # end of the if local
634 # asynchronously search the authority server
635 elsif ($server =~/authorityserver/) { # this is the local authority server
636 my @inner_sup_results_array;
637 for my $sup_record ( @{$results_hashref->{$server}->{"RECORDS"}} ) {
638 my $marc_record_object = MARC::Record->new_from_usmarc($sup_record);
639 # warn "Authority Found: ".$marc_record_object->as_formatted();
640 push @inner_sup_results_array, {
641 'title' => $marc_record_object->field(100)->subfield('a'),
642 'link' => "&idx=an&q=".$marc_record_object->field('001')->as_string(),
645 push @sup_results_array, { servername => $server,
646 inner_sup_results_loop => \@inner_sup_results_array} if @inner_sup_results_array;
648 # FIXME: can add support for other targets as needed here
649 $template->param( outer_sup_results_loop => \@sup_results_array);
650 } #/end of the for loop
651 #$template->param(FEDERATED_RESULTS => \@results_array);
655 #classlist => $classlist,
658 facets_loop => $facets,
660 search_error => $error,
663 if ($query_desc || $limit_desc) {
664 $template->param(searchdesc => 1);
667 # VI. BUILD THE TEMPLATE
669 # Build drop-down list for 'Add To:' menu...
671 my $row_count = 10; # FIXME:This probably should be a syspref
672 my ($pubshelves, $total) = GetRecentShelves(2, $row_count, undef);
673 my ($barshelves, $total) = GetRecentShelves(1, $row_count, $borrowernumber);
675 my @pubshelves = @{$pubshelves};
676 my @barshelves = @{$barshelves};
679 $template->param( addpubshelves => scalar (@pubshelves));
680 $template->param( addpubshelvesloop => @pubshelves);
684 $template->param( addbarshelves => scalar (@barshelves));
685 $template->param( addbarshelvesloop => @barshelves);
690 output_html_with_http_headers $cgi, $cookie, $template->output;