1 package C4
::Reports
::Guided
;
3 # Copyright 2007 Liblime Ltd
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use JSON
qw( from_json );
25 use vars
qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
27 use C4::Templates qw/themelanguage/;
35 use Koha::Notice::Templates;
38 use Koha::AuthorisedValues;
39 use Koha::Patron::Categories;
40 use Koha::SharedContent;
46 get_report_types get_report_areas get_report_groups get_columns build_query get_criteria
47 save_report get_saved_reports execute_query
48 get_column_type get_distinct_values save_dictionary get_from_dictionary
49 delete_definition delete_report format_results get_sql
51 GetReservedAuthorisedValues
53 IsAuthorisedValueValid
61 C4::Reports::Guided - Module for generating guided reports
65 use C4::Reports::Guided;
73 =head2 get_report_areas
75 This will return a list of all the available report areas
79 sub get_area_name_sql_snippet
{
81 [CIRC
=> "Circulation"],
84 [ACQ
=> "Acquisition"],
89 return "CASE report_area " .
90 join (" ", map "WHEN '$_->[0]' THEN '$_->[1]'", @REPORT_AREA) .
94 sub get_report_areas
{
96 my $report_areas = [ 'CIRC', 'CAT', 'PAT', 'ACQ', 'ACC', 'SER' ];
101 sub get_table_areas
{
103 CIRC
=> [ 'borrowers', 'statistics', 'items', 'biblioitems' ],
104 CAT
=> [ 'items', 'biblioitems', 'biblio' ],
105 PAT
=> ['borrowers'],
106 ACQ
=> [ 'aqorders', 'biblio', 'items' ],
107 ACC
=> [ 'borrowers', 'accountlines' ],
108 SER
=> [ 'serial', 'serialitems', 'subscription', 'subscriptionhistory', 'subscriptionroutinglist', 'biblioitems', 'biblio', 'aqbooksellers' ],
112 =head2 get_report_types
114 This will return a list of all the available report types
118 sub get_report_types
{
119 my $dbh = C4
::Context
->dbh();
121 # FIXME these should be in the database perhaps
122 my @reports = ( 'Tabular', 'Summary', 'Matrix' );
124 for ( my $i = 0 ; $i < 3 ; $i++ ) {
126 $hashrep{id
} = $i + 1;
127 $hashrep{name
} = $reports[$i];
128 push @reports2, \
%hashrep;
130 return ( \
@reports2 );
134 =head2 get_report_groups
136 This will return a list of all the available report areas with groups
140 sub get_report_groups
{
141 my $dbh = C4
::Context
->dbh();
143 my $groups = GetAuthorisedValues
('REPORT_GROUP');
144 my $subgroups = GetAuthorisedValues
('REPORT_SUBGROUP');
146 my %groups_with_subgroups = map { $_->{authorised_value
} => {
150 foreach (@
$subgroups) {
151 my $sg = $_->{authorised_value
};
152 my $g = $_->{lib_opac
}
153 or warn( qq{REPORT_SUBGROUP
"$sg" without REPORT_GROUP
(lib_opac
)} ),
155 my $g_sg = $groups_with_subgroups{$g}
156 or warn( qq{REPORT_SUBGROUP
"$sg" with invalid REPORT_GROUP
"$g"} ),
158 $g_sg->{subgroups
}{$sg} = $_->{lib
};
160 return \
%groups_with_subgroups
163 =head2 get_all_tables
165 This will return a list of all tables in the database
170 my $dbh = C4
::Context
->dbh();
171 my $query = "SHOW TABLES";
172 my $sth = $dbh->prepare($query);
175 while ( my $data = $sth->fetchrow_arrayref() ) {
176 push @tables, $data->[0];
183 =head2 get_columns($area)
185 This will return a list of all columns for a report area
191 # this calls the internal function _get_columns
192 my ( $area, $cgi ) = @_;
193 my %table_areas = get_table_areas
;
194 my $tables = $table_areas{$area}
195 or die qq{Unsuported report area
"$area"};
199 foreach my $table (@
$tables) {
200 my @columns = _get_columns
($table,$cgi, $first);
202 push @allcolumns, @columns;
204 return ( \
@allcolumns );
208 my ($tablename,$cgi, $first) = @_;
209 my $dbh = C4
::Context
->dbh();
210 my $sth = $dbh->prepare("show columns from $tablename");
213 my $column_defs = _get_column_defs
($cgi);
215 $tablehash{'table'}=$tablename;
216 $tablehash{'__first__'} = $first;
217 push @columns, \
%tablehash;
218 while ( my $data = $sth->fetchrow_arrayref() ) {
220 $temphash{'name'} = "$tablename.$data->[0]";
221 $temphash{'description'} = $column_defs->{"$tablename.$data->[0]"};
222 push @columns, \
%temphash;
228 =head2 build_query($columns,$criteria,$orderby,$area)
230 This will build the sql needed to return the results asked for,
231 $columns is expected to be of the format tablename.columnname.
232 This is what get_columns returns.
237 my ( $columns, $criteria, $orderby, $area, $totals, $definition ) = @_;
240 CIRC
=> [ 'statistics.borrowernumber=borrowers.borrowernumber',
241 'items.itemnumber = statistics.itemnumber',
242 'biblioitems.biblioitemnumber = items.biblioitemnumber' ],
243 CAT
=> [ 'items.biblioitemnumber=biblioitems.biblioitemnumber',
244 'biblioitems.biblionumber=biblio.biblionumber' ],
246 ACQ
=> [ 'aqorders.biblionumber=biblio.biblionumber',
247 'biblio.biblionumber=items.biblionumber' ],
248 ACC
=> ['borrowers.borrowernumber=accountlines.borrowernumber'],
249 SER
=> [ 'serial.serialid=serialitems.serialid', 'serial.subscriptionid=subscription.subscriptionid', 'serial.subscriptionid=subscriptionhistory.subscriptionid', 'serial.subscriptionid=subscriptionroutinglist.subscriptionid', 'biblioitems.biblionumber=serial.biblionumber', 'biblio.biblionumber=biblioitems.biblionumber', 'subscription.aqbooksellerid=aqbooksellers.id'],
254 my $keys = $keys{$area};
255 my %table_areas = get_table_areas
;
256 my $tables = $table_areas{$area};
259 _build_query
( $tables, $columns, $criteria, $keys, $orderby, $totals, $definition );
264 my ( $tables, $columns, $criteria, $keys, $orderby, $totals, $definition) = @_;
266 # $keys is an array of joining constraints
267 my $dbh = C4
::Context
->dbh();
268 my $joinedtables = join( ',', @
$tables );
269 my $joinedcolumns = join( ',', @
$columns );
271 "SELECT $totals $joinedcolumns FROM $tables->[0] ";
272 for (my $i=1;$i<@
$tables;$i++){
273 $query .= "LEFT JOIN $tables->[$i] on ($keys->[$i-1]) ";
277 $criteria =~ s/AND/WHERE/;
278 $query .= " $criteria";
281 my @definitions = split(',',$definition);
283 foreach my $def (@definitions){
284 my $defin=get_from_dictionary
('',$def);
285 $deftext .=" ".$defin->[0]->{'saved_sql'};
287 if ($query =~ /WHERE/i){
291 $deftext =~ s/AND/WHERE/;
297 my @totcolumns = split( ',', $totals );
298 foreach my $total (@totcolumns) {
299 if ( $total =~ /\((.*)\)/ ) {
300 if ( $groupby eq '' ) {
301 $groupby = " GROUP BY $1";
316 =head2 get_criteria($area,$cgi);
318 Returns an arraref to hashrefs suitable for using in a tmpl_loop. With the criteria and available values.
323 my ($area,$cgi) = @_;
324 my $dbh = C4
::Context
->dbh();
326 # have to do someting here to know if its dropdown, free text, date etc
328 CIRC
=> [ 'statistics.type', 'borrowers.categorycode', 'statistics.branch',
329 'biblioitems.publicationyear|date', 'items.dateaccessioned|date' ],
330 CAT
=> [ 'items.itemnumber|textrange', 'items.biblionumber|textrange',
331 'items.barcode|textrange', 'biblio.frameworkcode',
332 'items.holdingbranch', 'items.homebranch',
333 'biblio.datecreated|daterange', 'biblio.timestamp|daterange',
334 'items.onloan|daterange', 'items.ccode',
335 'items.itemcallnumber|textrange', 'items.itype', 'items.itemlost',
337 PAT
=> [ 'borrowers.branchcode', 'borrowers.categorycode' ],
338 ACQ
=> ['aqorders.datereceived|date'],
339 ACC
=> [ 'borrowers.branchcode', 'borrowers.categorycode' ],
340 SER
=> ['subscription.startdate|date', 'subscription.enddate|date', 'subscription.periodicity', 'subscription.callnumber', 'subscription.location', 'subscription.branchcode'],
343 # Adds itemtypes to criteria, according to the syspref
344 if ( C4
::Context
->preference('item-level_itypes') ) {
345 unshift @
{ $criteria{'CIRC'} }, 'items.itype';
346 unshift @
{ $criteria{'CAT'} }, 'items.itype';
348 unshift @
{ $criteria{'CIRC'} }, 'biblioitems.itemtype';
349 unshift @
{ $criteria{'CAT'} }, 'biblioitems.itemtype';
353 my $crit = $criteria{$area};
354 my $column_defs = _get_column_defs
($cgi);
356 foreach my $localcrit (@
$crit) {
357 my ( $value, $type ) = split( /\|/, $localcrit );
358 my ( $table, $column ) = split( /\./, $value );
359 if ($type eq 'textrange') {
361 $temp{'name'} = $value;
362 $temp{'from'} = "from_" . $value;
363 $temp{'to'} = "to_" . $value;
364 $temp{'textrange'} = 1;
365 $temp{'description'} = $column_defs->{$value};
366 push @criteria_array, \
%temp;
368 elsif ($type eq 'date') {
370 $temp{'name'} = $value;
372 $temp{'description'} = $column_defs->{$value};
373 push @criteria_array, \
%temp;
375 elsif ($type eq 'daterange') {
377 $temp{'name'} = $value;
378 $temp{'from'} = "from_" . $value;
379 $temp{'to'} = "to_" . $value;
380 $temp{'daterange'} = 1;
381 $temp{'description'} = $column_defs->{$value};
382 push @criteria_array, \
%temp;
386 "SELECT distinct($column) as availablevalues FROM $table";
387 my $sth = $dbh->prepare($query);
390 # push the runtime choosing option
392 $list='branches' if $column eq 'branchcode' or $column eq 'holdingbranch' or $column eq 'homebranch';
393 $list='categorycode' if $column eq 'categorycode';
394 $list='itemtypes' if $column eq 'itype';
395 $list='ccode' if $column eq 'ccode';
396 # TODO : improve to let the librarian choose the description at runtime
398 availablevalues
=> "<<$column" . ( $list ?
"|$list" : '' ) . ">>",
399 display_value
=> "<<$column" . ( $list ?
"|$list" : '' ) . ">>",
401 while ( my $row = $sth->fetchrow_hashref() ) {
402 if ($row->{'availablevalues'} eq '') { $row->{'default'} = 1 }
403 else { $row->{display_value
} = _get_display_value
( $row->{'availablevalues'}, $column ); }
409 $temp{'name'} = $value;
410 $temp{'description'} = $column_defs->{$value};
411 $temp{'values'} = \
@values;
413 push @criteria_array, \
%temp;
416 return ( \
@criteria_array );
420 my $sql = shift or return;
421 my $sth = C4
::Context
->dbh->prepare($sql);
423 my $rows = $sth->fetchall_arrayref();
424 return scalar (@
$rows);
429 ($sth, $error) = execute_query($sql, $offset, $limit[, \@sql_params])
432 This function returns a DBI statement handler from which the caller can
433 fetch the results of the SQL passed via C<$sql>.
435 If passed any query other than a SELECT, or if there is a DB error,
436 C<$errors> is returned, and is a hashref containing the error after this
439 C<$error->{'sqlerr'}> contains the offending SQL keyword.
440 C<$error->{'queryerr'}> contains the native db engine error returned
443 C<$offset>, and C<$limit> are required parameters.
445 C<\@sql_params> is an optional list of parameter values to paste in.
446 The caller is responsible for making sure that C<$sql> has placeholders
447 and that the number placeholders matches the number of parameters.
451 # returns $sql, $offset, $limit
452 # $sql returned will be transformed to:
453 # ~ remove any LIMIT clause
454 # ~ repace SELECT clause w/ SELECT count(*)
456 sub select_2_select_count
{
457 # Modify the query passed in to create a count query... (I think this covers all cases -crn)
458 my ($sql) = strip_limit
(shift) or return;
459 $sql =~ s/\bSELECT\W+(?:\w+\W+){1,}?FROM\b|\bSELECT\W\*\WFROM\b/SELECT count(*) FROM /ig;
463 # This removes the LIMIT from the query so that a custom one can be specified.
465 # ($new_sql, $offset, $limit) = strip_limit($sql);
468 # $sql is the query to modify
469 # $new_sql is the resulting query
470 # $offset is the offset value, if the LIMIT was the two-argument form,
471 # 0 if it wasn't otherwise given.
472 # $limit is the limit value
475 # * This makes an effort to not break subqueries that have their own
476 # LIMIT specified. It does that by only removing a LIMIT if it comes after
477 # a WHERE clause (which isn't perfect, but at least should make more cases
478 # work - subqueries with a limit in the WHERE will still break.)
479 # * If your query doesn't have a WHERE clause then all LIMITs will be
480 # removed. This may break some subqueries, but is hopefully rare enough
481 # to not be a big issue.
486 return ($sql, 0, undef) unless $sql =~ /\bLIMIT\b/i;
488 # Two options: if there's no WHERE clause in the SQL, we simply capture
489 # any LIMIT that's there. If there is a WHERE, we make sure that we only
490 # capture a LIMIT after the last one. This prevents stomping on subqueries.
491 if ($sql !~ /\bWHERE\b/i) {
492 (my $res = $sql) =~ s/\bLIMIT\b\s*(\d+)(\s*\,\s*(\d+))?\s*/ /ig;
493 return ($res, (defined $2 ?
$1 : 0), (defined $3 ?
$3 : $1));
496 $res =~ m/.*\bWHERE\b/gsi;
497 $res =~ s/\G(.*)\bLIMIT\b\s*(\d+)(\s*\,\s*(\d+))?\s*/$1 /is;
498 return ($res, (defined $3 ?
$2 : 0), (defined $4 ?
$4 : $2));
504 my ( $sql, $offset, $limit, $sql_params, $report_id ) = @_;
506 $sql_params = [] unless defined $sql_params;
510 carp
"execute_query() called without SQL argument";
513 $offset = 0 unless $offset;
514 $limit = 999999 unless $limit;
515 $debug and print STDERR
"execute_query($sql, $offset, $limit)\n";
516 if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
517 return (undef, { sqlerr
=> $1} );
518 } elsif ($sql !~ /^\s*SELECT\b\s*/i) {
519 return (undef, { queryerr
=> 'Missing SELECT'} );
522 my ($useroffset, $userlimit);
524 # Grab offset/limit from user supplied LIMIT and drop the LIMIT so we can control pagination
525 ($sql, $useroffset, $userlimit) = strip_limit
($sql);
526 $debug and warn sprintf "User has supplied (OFFSET,) LIMIT = %s, %s",
528 (defined($userlimit ) ?
$userlimit : 'UNDEF');
529 $offset += $useroffset;
530 if (defined($userlimit)) {
531 if ($offset + $limit > $userlimit ) {
532 $limit = $userlimit - $offset;
533 } elsif ( ! $offset && $limit < $userlimit ) {
537 $sql .= " LIMIT ?, ?";
539 my $dbh = C4
::Context
->dbh;
541 $dbh->do( 'UPDATE saved_sql SET last_run = NOW() WHERE id = ?', undef, $report_id ) if $report_id;
543 my $sth = $dbh->prepare($sql);
544 $sth->execute(@
$sql_params, $offset, $limit);
546 return ( $sth, { queryerr
=> $sth->errstr } ) if ($sth->err);
550 =head2 save_report($sql,$name,$type,$notes)
552 Given some sql and a name this will saved it so that it can reused
553 Returns id of the newly created report
559 my $borrowernumber = $fields->{borrowernumber
};
560 my $sql = $fields->{sql
};
561 my $name = $fields->{name
};
562 my $type = $fields->{type
};
563 my $notes = $fields->{notes
};
564 my $area = $fields->{area
};
565 my $group = $fields->{group
};
566 my $subgroup = $fields->{subgroup
};
567 my $cache_expiry = $fields->{cache_expiry
} || 300;
568 my $public = $fields->{public
};
570 my $dbh = C4
::Context
->dbh();
571 $sql =~ s/(\s*\;\s*)$//; # removes trailing whitespace and /;/
572 my $query = "INSERT INTO saved_sql (borrowernumber,date_created,last_modified,savedsql,report_name,report_area,report_group,report_subgroup,type,notes,cache_expiry,public) VALUES (?,now(),now(),?,?,?,?,?,?,?,?,?)";
573 $dbh->do($query, undef, $borrowernumber, $sql, $name, $area, $group, $subgroup, $type, $notes, $cache_expiry, $public);
575 my $id = $dbh->selectrow_array("SELECT max(id) FROM saved_sql WHERE borrowernumber=? AND report_name=?", undef,
576 $borrowernumber, $name);
581 my $id = shift || croak
"No Id given";
583 my $sql = $fields->{sql
};
584 my $name = $fields->{name
};
585 my $notes = $fields->{notes
};
586 my $group = $fields->{group
};
587 my $subgroup = $fields->{subgroup
};
588 my $cache_expiry = $fields->{cache_expiry
};
589 my $public = $fields->{public
};
591 if( $cache_expiry >= 2592000 ){
592 die "Please specify a cache expiry less than 30 days\n";
595 my $dbh = C4
::Context
->dbh();
596 $sql =~ s/(\s*\;\s*)$//; # removes trailing whitespace and /;/
597 my $query = "UPDATE saved_sql SET savedsql = ?, last_modified = now(), report_name = ?, report_group = ?, report_subgroup = ?, notes = ?, cache_expiry = ?, public = ? WHERE id = ? ";
598 $dbh->do($query, undef, $sql, $name, $group, $subgroup, $notes, $cache_expiry, $public, $id );
602 my ( $id, $json ) = @_;
603 my $dbh = C4
::Context
->dbh();
605 INSERT INTO saved_reports
( report_id
, report
, date_run
) VALUES
( ?
, ?
, NOW
() );
606 |, undef, $id, $json );
611 my $dbh = C4
::Context
->dbh();
612 my ( $report_name, $notes, $json, $date_run ) = $dbh->selectrow_array(q
|
613 SELECT ss
.report_name
, ss
.notes
, sr
.report
, sr
.date_run
615 LEFT JOIN saved_reports sr ON sr
.report_id
= ss
.id
619 report_name
=> $report_name,
621 results
=> from_json
( $json ),
622 date_run
=> $date_run,
629 foreach my $id (@ids) {
630 my $data = Koha
::Reports
->find($id);
631 logaction
( "REPORTS", "DELETE", $id, $data->report_name." | ".$data->savedsql ) if C4
::Context
->preference("ReportsLog");
633 my $dbh = C4
::Context
->dbh;
634 my $query = 'DELETE FROM saved_sql WHERE id IN (' . join( ',', ('?') x
@ids ) . ')';
635 my $sth = $dbh->prepare($query);
636 return $sth->execute(@ids);
639 sub get_saved_reports_base_query
{
640 my $area_name_sql_snippet = get_area_name_sql_snippet
;
642 SELECT s.*, $area_name_sql_snippet, av_g.lib AS groupname, av_sg.lib AS subgroupname,
643 b.firstname AS borrowerfirstname, b.surname AS borrowersurname
645 LEFT JOIN saved_reports r ON r.report_id = s.id
646 LEFT OUTER JOIN authorised_values av_g ON (av_g.category = 'REPORT_GROUP' AND av_g.authorised_value = s.report_group)
647 LEFT OUTER JOIN authorised_values av_sg ON (av_sg.category = 'REPORT_SUBGROUP' AND av_sg.lib_opac = s.report_group AND av_sg.authorised_value = s.report_subgroup)
648 LEFT OUTER JOIN borrowers b USING (borrowernumber)
652 sub get_saved_reports
{
653 # $filter is either { date => $d, author => $a, keyword => $kw, }
654 # or $keyword. Optional.
656 $filter = { keyword
=> $filter } if $filter && !ref( $filter );
657 my ($group, $subgroup) = @_;
659 my $dbh = C4
::Context
->dbh();
660 my $query = get_saved_reports_base_query
;
663 if (my $date = $filter->{date
}) {
664 $date = eval { output_pref
( { dt
=> dt_from_string
( $date ), dateonly
=> 1, dateformat
=> 'iso' }); };
665 push @cond, "DATE(last_modified) = ? OR
667 push @args, $date, $date, $date;
669 if (my $author = $filter->{author
}) {
670 $author = "%$author%";
671 push @cond, "surname LIKE ? OR
673 push @args, $author, $author;
675 if (my $keyword = $filter->{keyword
}) {
678 OR report_name LIKE ?
683 push @args, "%$keyword%", "%$keyword%", "%$keyword%", "%$keyword%", $keyword;
685 if ($filter->{group
}) {
686 push @cond, "report_group = ?";
687 push @args, $filter->{group
};
689 if ($filter->{subgroup
}) {
690 push @cond, "report_subgroup = ?";
691 push @args, $filter->{subgroup
};
694 $query .= " WHERE ".join( " AND ", map "($_)", @cond ) if @cond;
695 $query .= " ORDER by date_created";
697 my $result = $dbh->selectall_arrayref($query, {Slice
=> {}}, @args);
702 =head2 get_column_type($column)
704 This takes a column name of the format table.column and will return what type it is
705 (free text, set values, date)
709 sub get_column_type
{
710 my ($tablecolumn) = @_;
711 my ($table,$column) = split(/\./,$tablecolumn);
712 my $dbh = C4
::Context
->dbh();
716 # mysql doesn't support a column selection, set column to %
718 my $sth = $dbh->column_info( $catalog, $schema, $table, $tempcolumn ) || die $dbh->errstr;
719 while (my $info = $sth->fetchrow_hashref()){
720 if ($info->{'COLUMN_NAME'} eq $column){
722 if ($info->{'TYPE_NAME'} eq 'CHAR' || $info->{'TYPE_NAME'} eq 'VARCHAR'){
723 $info->{'TYPE_NAME'} = 'distinct';
725 return $info->{'TYPE_NAME'};
730 =head2 get_distinct_values($column)
732 Given a column name, return an arrary ref of hashrefs suitable for use as a tmpl_loop
733 with the distinct values of the column
737 sub get_distinct_values
{
738 my ($tablecolumn) = @_;
739 my ($table,$column) = split(/\./,$tablecolumn);
740 my $dbh = C4
::Context
->dbh();
742 "SELECT distinct($column) as availablevalues FROM $table";
743 my $sth = $dbh->prepare($query);
745 return $sth->fetchall_arrayref({});
748 sub save_dictionary
{
749 my ( $name, $description, $sql, $area ) = @_;
750 my $dbh = C4
::Context
->dbh();
751 my $query = "INSERT INTO reports_dictionary (name,description,saved_sql,report_area,date_created,date_modified)
752 VALUES (?,?,?,?,now(),now())";
753 my $sth = $dbh->prepare($query);
754 $sth->execute($name,$description,$sql,$area) || return 0;
758 sub get_from_dictionary
{
759 my ( $area, $id ) = @_;
760 my $dbh = C4
::Context
->dbh();
761 my $area_name_sql_snippet = get_area_name_sql_snippet
;
763 SELECT d.*, $area_name_sql_snippet
764 FROM reports_dictionary d
768 $query .= " WHERE report_area = ?";
770 $query .= " WHERE id = ?";
772 my $sth = $dbh->prepare($query);
776 $sth->execute($area);
781 while ( my $data = $sth->fetchrow_hashref() ) {
787 sub delete_definition
{
788 my ($id) = @_ or return;
789 my $dbh = C4
::Context
->dbh();
790 my $query = "DELETE FROM reports_dictionary WHERE id = ?";
791 my $sth = $dbh->prepare($query);
795 =head2 get_sql($report_id)
797 Given a report id, return the SQL statement for that report.
798 Otherwise, it just returns.
803 my ($id) = @_ or return;
804 my $dbh = C4
::Context
->dbh();
805 my $query = "SELECT * FROM saved_sql WHERE id = ?";
806 my $sth = $dbh->prepare($query);
808 my $data=$sth->fetchrow_hashref();
809 return $data->{'savedsql'};
813 my ( $report_id ) = @_;
814 my $dbh = C4
::Context
->dbh;
815 return $dbh->selectall_arrayref(q
|
816 SELECT id
, report
, date_run
819 |, { Slice
=> {} }, $report_id);
822 sub _get_column_defs
{
825 my $columns_def_file = "columns.def";
826 my $htdocs = C4
::Context
->config('intrahtdocs');
827 my $section = 'intranet';
829 # We need the theme and the lang
830 # Since columns.def is not in the modules directory, we cannot sent it for the $tmpl var
831 my ($theme, $lang, $availablethemes) = C4
::Templates
::themelanguage
($htdocs, 'about.tt', $section, $cgi);
833 my $full_path_to_columns_def_file="$htdocs/$theme/$lang/$columns_def_file";
834 open (my $fh, '<:encoding(utf-8)', $full_path_to_columns_def_file);
835 while ( my $input = <$fh> ){
837 if ( $input =~ m
|<field name
="(.*)">(.*)</field
>| ) {
838 my ( $field, $translation ) = ( $1, $2 );
839 $columns{$field} = $translation;
846 =head2 GetReservedAuthorisedValues
848 my %reserved_authorised_values = GetReservedAuthorisedValues();
850 Returns a hash containig all reserved words
854 sub GetReservedAuthorisedValues
{
855 my %reserved_authorised_values =
856 map { $_ => 1 } ( 'date',
861 'biblio_framework' );
863 return \
%reserved_authorised_values;
867 =head2 IsAuthorisedValueValid
869 my $is_valid_ath_value = IsAuthorisedValueValid($authorised_value)
871 Returns 1 if $authorised_value is on the reserved authorised values list or
872 in the authorised value categories defined in
876 sub IsAuthorisedValueValid
{
878 my $authorised_value = shift;
879 my $reserved_authorised_values = GetReservedAuthorisedValues
();
881 if ( exists $reserved_authorised_values->{$authorised_value} ||
882 Koha
::AuthorisedValues
->search({ category
=> $authorised_value })->count ) {
889 =head2 GetParametersFromSQL
891 my @sql_parameters = GetParametersFromSQL($sql)
893 Returns an arrayref of hashes containing the keys name and authval
897 sub GetParametersFromSQL
{
900 my @split = split(/<<|>>/,$sql);
901 my @sql_parameters = ();
903 for ( my $i = 0; $i < ($#split/2) ; $i++ ) {
904 my ($name,$authval) = split(/\|/,$split[$i*2+1]);
905 push @sql_parameters, { 'name' => $name, 'authval' => $authval };
908 return \
@sql_parameters;
911 =head2 ValidateSQLParameters
913 my @problematic_parameters = ValidateSQLParameters($sql)
915 Returns an arrayref of hashes containing the keys name and authval of
916 those SQL parameters that do not correspond to valid authorised names
920 sub ValidateSQLParameters
{
923 my @problematic_parameters = ();
924 my $sql_parameters = GetParametersFromSQL
($sql);
926 foreach my $sql_parameter (@
$sql_parameters) {
927 if ( defined $sql_parameter->{'authval'} ) {
928 push @problematic_parameters, $sql_parameter unless
929 IsAuthorisedValueValid
($sql_parameter->{'authval'});
933 return \
@problematic_parameters;
938 my ( $emails, $arrayrefs ) = EmailReport($report_id, $letter_code, $module, $branch, $email)
940 Take a report and use it to process a Template Toolkit formatted notice
941 Returns arrayrefs containing prepared letters and errors respectively
948 my $report_id = $params->{report_id
};
949 my $from = $params->{from
};
950 my $email = $params->{email
};
951 my $module = $params->{module
};
952 my $code = $params->{code
};
953 my $branch = $params->{branch
} || "";
958 return ( undef, [{ FATAL
=> "MISSING_PARAMS" }] ) unless ($report_id && $module && $code);
960 return ( undef, [{ FATAL
=> "NO_LETTER" }] ) unless
961 my $letter = Koha
::Notice
::Templates
->find({
964 branchcode
=> $branch,
965 message_transport_type
=> 'email',
967 $letter = $letter->unblessed;
969 my $report = Koha
::Reports
->find( $report_id );
970 my $sql = $report->savedsql;
971 return ( { FATAL
=> "NO_REPORT" } ) unless $sql;
973 my ( $sth, $errors ) = execute_query
( $sql ); #don't pass offset or limit, hardcoded limit of 999,999 will be used
974 return ( undef, [{ FATAL
=> "REPORT_FAIL" }] ) if $errors;
977 my $template = $letter->{content
};
979 while ( my $row = $sth->fetchrow_hashref() ) {
981 my $err_count = scalar @errors;
982 push ( @errors, { NO_BOR_COL
=> $counter } ) unless defined $row->{borrowernumber
};
983 push ( @errors, { NO_EMAIL_COL
=> $counter } ) unless ( (defined $email && defined $row->{$email}) || defined $row->{email
} );
984 push ( @errors, { NO_FROM_COL
=> $counter } ) unless defined ( $from || $row->{from
} );
985 push ( @errors, { NO_BOR
=> $row->{borrowernumber
} } ) unless Koha
::Patrons
->find({borrowernumber
=>$row->{borrowernumber
}});
987 my $from_address = $from || $row->{from
};
988 my $to_address = $email ?
$row->{$email} : $row->{email
};
989 push ( @errors, { NOT_PARSE
=> $counter } ) unless my $content = _process_row_TT
( $row, $template );
991 next if scalar @errors > $err_count; #If any problems, try next
993 $letter->{content
} = $content;
994 $email->{borrowernumber
} = $row->{borrowernumber
};
995 $email->{letter
} = $letter;
996 $email->{from_address
} = $from_address;
997 $email->{to_address
} = $to_address;
999 push ( @emails, $email );
1002 return ( \
@emails, \
@errors );
1010 my $content = ProcessRowTT($row_hashref, $template);
1012 Accepts a hashref containing values and processes them against Template Toolkit
1017 sub _process_row_TT
{
1019 my ($row, $template) = @_;
1021 return 0 unless ($row && $template);
1023 my $processor = Template
->new();
1024 $processor->process( \
$template, $row, \
$content);
1029 sub _get_display_value
{
1030 my ( $original_value, $column ) = @_;
1031 if ( $column eq 'periodicity' ) {
1032 my $dbh = C4
::Context
->dbh();
1033 my $query = "SELECT description FROM subscription_frequencies WHERE id = ?";
1034 my $sth = $dbh->prepare($query);
1035 $sth->execute($original_value);
1036 return $sth->fetchrow;
1038 return $original_value;
1044 my $updated_sql = C4::Reports::Guided::convert_sql( $sql );
1046 Convert a sql query using biblioitems.marcxml to use the new
1047 biblio_metadata.metadata field instead
1053 my $updated_sql = $sql;
1054 if ( $sql =~ m
|biblioitems
| and $sql =~ m
|marcxml
| ) {
1055 $updated_sql =~ s
|biblioitems
|biblio_metadata
|g
;
1056 $updated_sql =~ s
|marcxml
|metadata
|g
;
1058 return $updated_sql;
1066 Chris Cormack <crc@liblime.com>