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/;
34 use Koha::AuthorisedValues;
35 use Koha::Patron::Categories;
41 get_report_types get_report_areas get_report_groups get_columns build_query get_criteria
42 save_report get_saved_reports execute_query get_saved_report create_compound run_compound
43 get_column_type get_distinct_values save_dictionary get_from_dictionary
44 delete_definition delete_report format_results get_sql
46 GetReservedAuthorisedValues
48 IsAuthorisedValueValid
56 C4::Reports::Guided - Module for generating guided reports
60 use C4::Reports::Guided;
68 =head2 get_report_areas
70 This will return a list of all the available report areas
74 sub get_area_name_sql_snippet
{
76 [CIRC
=> "Circulation"],
79 [ACQ
=> "Acquisition"],
84 return "CASE report_area " .
85 join (" ", map "WHEN '$_->[0]' THEN '$_->[1]'", @REPORT_AREA) .
89 sub get_report_areas
{
91 my $report_areas = [ 'CIRC', 'CAT', 'PAT', 'ACQ', 'ACC', 'SER' ];
98 CIRC
=> [ 'borrowers', 'statistics', 'items', 'biblioitems' ],
99 CAT
=> [ 'items', 'biblioitems', 'biblio' ],
100 PAT
=> ['borrowers'],
101 ACQ
=> [ 'aqorders', 'biblio', 'items' ],
102 ACC
=> [ 'borrowers', 'accountlines' ],
103 SER
=> [ 'serial', 'serialitems', 'subscription', 'subscriptionhistory', 'subscriptionroutinglist', 'biblioitems', 'biblio', 'aqbooksellers' ],
107 =head2 get_report_types
109 This will return a list of all the available report types
113 sub get_report_types
{
114 my $dbh = C4
::Context
->dbh();
116 # FIXME these should be in the database perhaps
117 my @reports = ( 'Tabular', 'Summary', 'Matrix' );
119 for ( my $i = 0 ; $i < 3 ; $i++ ) {
121 $hashrep{id
} = $i + 1;
122 $hashrep{name
} = $reports[$i];
123 push @reports2, \
%hashrep;
125 return ( \
@reports2 );
129 =head2 get_report_groups
131 This will return a list of all the available report areas with groups
135 sub get_report_groups
{
136 my $dbh = C4
::Context
->dbh();
138 my $groups = GetAuthorisedValues
('REPORT_GROUP');
139 my $subgroups = GetAuthorisedValues
('REPORT_SUBGROUP');
141 my %groups_with_subgroups = map { $_->{authorised_value
} => {
145 foreach (@
$subgroups) {
146 my $sg = $_->{authorised_value
};
147 my $g = $_->{lib_opac
}
148 or warn( qq{REPORT_SUBGROUP
"$sg" without REPORT_GROUP
(lib_opac
)} ),
150 my $g_sg = $groups_with_subgroups{$g}
151 or warn( qq{REPORT_SUBGROUP
"$sg" with invalid REPORT_GROUP
"$g"} ),
153 $g_sg->{subgroups
}{$sg} = $_->{lib
};
155 return \
%groups_with_subgroups
158 =head2 get_all_tables
160 This will return a list of all tables in the database
165 my $dbh = C4
::Context
->dbh();
166 my $query = "SHOW TABLES";
167 my $sth = $dbh->prepare($query);
170 while ( my $data = $sth->fetchrow_arrayref() ) {
171 push @tables, $data->[0];
178 =head2 get_columns($area)
180 This will return a list of all columns for a report area
186 # this calls the internal function _get_columns
187 my ( $area, $cgi ) = @_;
188 my %table_areas = get_table_areas
;
189 my $tables = $table_areas{$area}
190 or die qq{Unsuported report area
"$area"};
194 foreach my $table (@
$tables) {
195 my @columns = _get_columns
($table,$cgi, $first);
197 push @allcolumns, @columns;
199 return ( \
@allcolumns );
203 my ($tablename,$cgi, $first) = @_;
204 my $dbh = C4
::Context
->dbh();
205 my $sth = $dbh->prepare("show columns from $tablename");
208 my $column_defs = _get_column_defs
($cgi);
210 $tablehash{'table'}=$tablename;
211 $tablehash{'__first__'} = $first;
212 push @columns, \
%tablehash;
213 while ( my $data = $sth->fetchrow_arrayref() ) {
215 $temphash{'name'} = "$tablename.$data->[0]";
216 $temphash{'description'} = $column_defs->{"$tablename.$data->[0]"};
217 push @columns, \
%temphash;
223 =head2 build_query($columns,$criteria,$orderby,$area)
225 This will build the sql needed to return the results asked for,
226 $columns is expected to be of the format tablename.columnname.
227 This is what get_columns returns.
232 my ( $columns, $criteria, $orderby, $area, $totals, $definition ) = @_;
235 CIRC
=> [ 'statistics.borrowernumber=borrowers.borrowernumber',
236 'items.itemnumber = statistics.itemnumber',
237 'biblioitems.biblioitemnumber = items.biblioitemnumber' ],
238 CAT
=> [ 'items.biblioitemnumber=biblioitems.biblioitemnumber',
239 'biblioitems.biblionumber=biblio.biblionumber' ],
241 ACQ
=> [ 'aqorders.biblionumber=biblio.biblionumber',
242 'biblio.biblionumber=items.biblionumber' ],
243 ACC
=> ['borrowers.borrowernumber=accountlines.borrowernumber'],
244 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'],
249 my $keys = $keys{$area};
250 my %table_areas = get_table_areas
;
251 my $tables = $table_areas{$area};
254 _build_query
( $tables, $columns, $criteria, $keys, $orderby, $totals, $definition );
259 my ( $tables, $columns, $criteria, $keys, $orderby, $totals, $definition) = @_;
261 # $keys is an array of joining constraints
262 my $dbh = C4
::Context
->dbh();
263 my $joinedtables = join( ',', @
$tables );
264 my $joinedcolumns = join( ',', @
$columns );
266 "SELECT $totals $joinedcolumns FROM $tables->[0] ";
267 for (my $i=1;$i<@
$tables;$i++){
268 $query .= "LEFT JOIN $tables->[$i] on ($keys->[$i-1]) ";
272 $criteria =~ s/AND/WHERE/;
273 $query .= " $criteria";
276 my @definitions = split(',',$definition);
278 foreach my $def (@definitions){
279 my $defin=get_from_dictionary
('',$def);
280 $deftext .=" ".$defin->[0]->{'saved_sql'};
282 if ($query =~ /WHERE/i){
286 $deftext =~ s/AND/WHERE/;
292 my @totcolumns = split( ',', $totals );
293 foreach my $total (@totcolumns) {
294 if ( $total =~ /\((.*)\)/ ) {
295 if ( $groupby eq '' ) {
296 $groupby = " GROUP BY $1";
311 =head2 get_criteria($area,$cgi);
313 Returns an arraref to hashrefs suitable for using in a tmpl_loop. With the criteria and available values.
318 my ($area,$cgi) = @_;
319 my $dbh = C4
::Context
->dbh();
321 # have to do someting here to know if its dropdown, free text, date etc
323 CIRC
=> [ 'statistics.type', 'borrowers.categorycode', 'statistics.branch',
324 'biblioitems.publicationyear|date', 'items.dateaccessioned|date' ],
325 CAT
=> [ 'items.itemnumber|textrange', 'items.biblionumber|textrange',
326 'items.barcode|textrange', 'biblio.frameworkcode',
327 'items.holdingbranch', 'items.homebranch',
328 'biblio.datecreated|daterange', 'biblio.timestamp|daterange',
329 'items.onloan|daterange', 'items.ccode',
330 'items.itemcallnumber|textrange', 'items.itype', 'items.itemlost',
332 PAT
=> [ 'borrowers.branchcode', 'borrowers.categorycode' ],
333 ACQ
=> ['aqorders.datereceived|date'],
334 ACC
=> [ 'borrowers.branchcode', 'borrowers.categorycode' ],
335 SER
=> ['subscription.startdate|date', 'subscription.enddate|date', 'subscription.periodicity', 'subscription.callnumber', 'subscription.location', 'subscription.branchcode'],
338 # Adds itemtypes to criteria, according to the syspref
339 if ( C4
::Context
->preference('item-level_itypes') ) {
340 unshift @
{ $criteria{'CIRC'} }, 'items.itype';
341 unshift @
{ $criteria{'CAT'} }, 'items.itype';
343 unshift @
{ $criteria{'CIRC'} }, 'biblioitems.itemtype';
344 unshift @
{ $criteria{'CAT'} }, 'biblioitems.itemtype';
348 my $crit = $criteria{$area};
349 my $column_defs = _get_column_defs
($cgi);
351 foreach my $localcrit (@
$crit) {
352 my ( $value, $type ) = split( /\|/, $localcrit );
353 my ( $table, $column ) = split( /\./, $value );
354 if ($type eq 'textrange') {
356 $temp{'name'} = $value;
357 $temp{'from'} = "from_" . $value;
358 $temp{'to'} = "to_" . $value;
359 $temp{'textrange'} = 1;
360 $temp{'description'} = $column_defs->{$value};
361 push @criteria_array, \
%temp;
363 elsif ($type eq 'date') {
365 $temp{'name'} = $value;
367 $temp{'description'} = $column_defs->{$value};
368 push @criteria_array, \
%temp;
370 elsif ($type eq 'daterange') {
372 $temp{'name'} = $value;
373 $temp{'from'} = "from_" . $value;
374 $temp{'to'} = "to_" . $value;
375 $temp{'daterange'} = 1;
376 $temp{'description'} = $column_defs->{$value};
377 push @criteria_array, \
%temp;
381 "SELECT distinct($column) as availablevalues FROM $table";
382 my $sth = $dbh->prepare($query);
385 # push the runtime choosing option
387 $list='branches' if $column eq 'branchcode' or $column eq 'holdingbranch' or $column eq 'homebranch';
388 $list='categorycode' if $column eq 'categorycode';
389 $list='itemtypes' if $column eq 'itype';
390 $list='ccode' if $column eq 'ccode';
391 # TODO : improve to let the librarian choose the description at runtime
393 availablevalues
=> "<<$column" . ( $list ?
"|$list" : '' ) . ">>",
394 display_value
=> "<<$column" . ( $list ?
"|$list" : '' ) . ">>",
396 while ( my $row = $sth->fetchrow_hashref() ) {
397 if ($row->{'availablevalues'} eq '') { $row->{'default'} = 1 }
398 else { $row->{display_value
} = _get_display_value
( $row->{'availablevalues'}, $column ); }
404 $temp{'name'} = $value;
405 $temp{'description'} = $column_defs->{$value};
406 $temp{'values'} = \
@values;
408 push @criteria_array, \
%temp;
411 return ( \
@criteria_array );
415 my $sql = shift or return;
416 my $sth = C4
::Context
->dbh->prepare($sql);
418 my $rows = $sth->fetchall_arrayref();
419 return scalar (@
$rows);
424 ($sth, $error) = execute_query($sql, $offset, $limit[, \@sql_params])
427 This function returns a DBI statement handler from which the caller can
428 fetch the results of the SQL passed via C<$sql>.
430 If passed any query other than a SELECT, or if there is a DB error,
431 C<$errors> is returned, and is a hashref containing the error after this
434 C<$error->{'sqlerr'}> contains the offending SQL keyword.
435 C<$error->{'queryerr'}> contains the native db engine error returned
438 C<$offset>, and C<$limit> are required parameters.
440 C<\@sql_params> is an optional list of parameter values to paste in.
441 The caller is responsible for making sure that C<$sql> has placeholders
442 and that the number placeholders matches the number of parameters.
446 # returns $sql, $offset, $limit
447 # $sql returned will be transformed to:
448 # ~ remove any LIMIT clause
449 # ~ repace SELECT clause w/ SELECT count(*)
451 sub select_2_select_count
{
452 # Modify the query passed in to create a count query... (I think this covers all cases -crn)
453 my ($sql) = strip_limit
(shift) or return;
454 $sql =~ s/\bSELECT\W+(?:\w+\W+){1,}?FROM\b|\bSELECT\W\*\WFROM\b/SELECT count(*) FROM /ig;
458 # This removes the LIMIT from the query so that a custom one can be specified.
460 # ($new_sql, $offset, $limit) = strip_limit($sql);
463 # $sql is the query to modify
464 # $new_sql is the resulting query
465 # $offset is the offset value, if the LIMIT was the two-argument form,
466 # 0 if it wasn't otherwise given.
467 # $limit is the limit value
470 # * This makes an effort to not break subqueries that have their own
471 # LIMIT specified. It does that by only removing a LIMIT if it comes after
472 # a WHERE clause (which isn't perfect, but at least should make more cases
473 # work - subqueries with a limit in the WHERE will still break.)
474 # * If your query doesn't have a WHERE clause then all LIMITs will be
475 # removed. This may break some subqueries, but is hopefully rare enough
476 # to not be a big issue.
481 return ($sql, 0, undef) unless $sql =~ /\bLIMIT\b/i;
483 # Two options: if there's no WHERE clause in the SQL, we simply capture
484 # any LIMIT that's there. If there is a WHERE, we make sure that we only
485 # capture a LIMIT after the last one. This prevents stomping on subqueries.
486 if ($sql !~ /\bWHERE\b/i) {
487 (my $res = $sql) =~ s/\bLIMIT\b\s*(\d+)(\s*\,\s*(\d+))?\s*/ /ig;
488 return ($res, (defined $2 ?
$1 : 0), (defined $3 ?
$3 : $1));
491 $res =~ m/.*\bWHERE\b/gsi;
492 $res =~ s/\G(.*)\bLIMIT\b\s*(\d+)(\s*\,\s*(\d+))?\s*/$1 /is;
493 return ($res, (defined $3 ?
$2 : 0), (defined $4 ?
$4 : $2));
499 my ( $sql, $offset, $limit, $sql_params ) = @_;
501 $sql_params = [] unless defined $sql_params;
505 carp
"execute_query() called without SQL argument";
508 $offset = 0 unless $offset;
509 $limit = 999999 unless $limit;
510 $debug and print STDERR
"execute_query($sql, $offset, $limit)\n";
511 if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
512 return (undef, { sqlerr
=> $1} );
513 } elsif ($sql !~ /^\s*SELECT\b\s*/i) {
514 return (undef, { queryerr
=> 'Missing SELECT'} );
517 my ($useroffset, $userlimit);
519 # Grab offset/limit from user supplied LIMIT and drop the LIMIT so we can control pagination
520 ($sql, $useroffset, $userlimit) = strip_limit
($sql);
521 $debug and warn sprintf "User has supplied (OFFSET,) LIMIT = %s, %s",
523 (defined($userlimit ) ?
$userlimit : 'UNDEF');
524 $offset += $useroffset;
525 if (defined($userlimit)) {
526 if ($offset + $limit > $userlimit ) {
527 $limit = $userlimit - $offset;
528 } elsif ( ! $offset && $limit < $userlimit ) {
532 $sql .= " LIMIT ?, ?";
534 my $sth = C4
::Context
->dbh->prepare($sql);
535 $sth->execute(@
$sql_params, $offset, $limit);
536 return ( $sth, { queryerr
=> $sth->errstr } ) if ($sth->err);
540 =head2 save_report($sql,$name,$type,$notes)
542 Given some sql and a name this will saved it so that it can reused
543 Returns id of the newly created report
549 my $borrowernumber = $fields->{borrowernumber
};
550 my $sql = $fields->{sql
};
551 my $name = $fields->{name
};
552 my $type = $fields->{type
};
553 my $notes = $fields->{notes
};
554 my $area = $fields->{area
};
555 my $group = $fields->{group
};
556 my $subgroup = $fields->{subgroup
};
557 my $cache_expiry = $fields->{cache_expiry
} || 300;
558 my $public = $fields->{public
};
560 my $dbh = C4
::Context
->dbh();
561 $sql =~ s/(\s*\;\s*)$//; # removes trailing whitespace and /;/
562 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(),?,?,?,?,?,?,?,?,?)";
563 $dbh->do($query, undef, $borrowernumber, $sql, $name, $area, $group, $subgroup, $type, $notes, $cache_expiry, $public);
565 my $id = $dbh->selectrow_array("SELECT max(id) FROM saved_sql WHERE borrowernumber=? AND report_name=?", undef,
566 $borrowernumber, $name);
571 my $id = shift || croak
"No Id given";
573 my $sql = $fields->{sql
};
574 my $name = $fields->{name
};
575 my $notes = $fields->{notes
};
576 my $group = $fields->{group
};
577 my $subgroup = $fields->{subgroup
};
578 my $cache_expiry = $fields->{cache_expiry
};
579 my $public = $fields->{public
};
581 if( $cache_expiry >= 2592000 ){
582 die "Please specify a cache expiry less than 30 days\n";
585 my $dbh = C4
::Context
->dbh();
586 $sql =~ s/(\s*\;\s*)$//; # removes trailing whitespace and /;/
587 my $query = "UPDATE saved_sql SET savedsql = ?, last_modified = now(), report_name = ?, report_group = ?, report_subgroup = ?, notes = ?, cache_expiry = ?, public = ? WHERE id = ? ";
588 $dbh->do($query, undef, $sql, $name, $group, $subgroup, $notes, $cache_expiry, $public, $id );
592 my ( $id, $json ) = @_;
593 my $dbh = C4
::Context
->dbh();
595 INSERT INTO saved_reports
( report_id
, report
, date_run
) VALUES
( ?
, ?
, NOW
() );
596 |, undef, $id, $json );
601 my $dbh = C4
::Context
->dbh();
602 my ( $report_name, $notes, $json, $date_run ) = $dbh->selectrow_array(q
|
603 SELECT ss
.report_name
, ss
.notes
, sr
.report
, sr
.date_run
605 LEFT JOIN saved_reports sr ON sr
.report_id
= ss
.id
609 report_name
=> $report_name,
611 results
=> from_json
( $json ),
612 date_run
=> $date_run,
619 foreach my $id (@ids) {
620 my $data = get_saved_report
($id);
621 logaction
( "REPORTS", "DELETE", $id, "$data->{'report_name'} | $data->{'savedsql'} " ) if C4
::Context
->preference("ReportsLog");
623 my $dbh = C4
::Context
->dbh;
624 my $query = 'DELETE FROM saved_sql WHERE id IN (' . join( ',', ('?') x
@ids ) . ')';
625 my $sth = $dbh->prepare($query);
626 return $sth->execute(@ids);
629 sub get_saved_reports_base_query
{
630 my $area_name_sql_snippet = get_area_name_sql_snippet
;
632 SELECT s.*, $area_name_sql_snippet, av_g.lib AS groupname, av_sg.lib AS subgroupname,
633 b.firstname AS borrowerfirstname, b.surname AS borrowersurname
635 LEFT OUTER JOIN authorised_values av_g ON (av_g.category = 'REPORT_GROUP' AND av_g.authorised_value = s.report_group)
636 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)
637 LEFT OUTER JOIN borrowers b USING (borrowernumber)
641 sub get_saved_reports
{
642 # $filter is either { date => $d, author => $a, keyword => $kw, }
643 # or $keyword. Optional.
645 $filter = { keyword
=> $filter } if $filter && !ref( $filter );
646 my ($group, $subgroup) = @_;
648 my $dbh = C4
::Context
->dbh();
649 my $query = get_saved_reports_base_query
;
652 if (my $date = $filter->{date
}) {
653 $date = eval { output_pref
( { dt
=> dt_from_string
( $date ), dateonly
=> 1, dateformat
=> 'iso' }); };
654 push @cond, "DATE(last_modified) = ? OR
656 push @args, $date, $date, $date;
658 if (my $author = $filter->{author
}) {
659 $author = "%$author%";
660 push @cond, "surname LIKE ? OR
662 push @args, $author, $author;
664 if (my $keyword = $filter->{keyword
}) {
667 OR report_name LIKE ?
672 push @args, "%$keyword%", "%$keyword%", "%$keyword%", "%$keyword%", $keyword;
674 if ($filter->{group
}) {
675 push @cond, "report_group = ?";
676 push @args, $filter->{group
};
678 if ($filter->{subgroup
}) {
679 push @cond, "report_subgroup = ?";
680 push @args, $filter->{subgroup
};
683 $query .= " WHERE ".join( " AND ", map "($_)", @cond ) if @cond;
684 $query .= " ORDER by date_created";
686 my $result = $dbh->selectall_arrayref($query, {Slice
=> {}}, @args);
691 sub get_saved_report
{
692 my $dbh = C4
::Context
->dbh();
695 if ($#_ == 0 && ref $_[0] ne 'HASH') {
697 $query = " SELECT * FROM saved_sql WHERE id = ?";
698 } elsif (ref $_[0] eq 'HASH') {
700 if ($selector->{name
}) {
701 $query = " SELECT * FROM saved_sql WHERE report_name = ?";
702 $report_arg = $selector->{name
};
703 } elsif ($selector->{id
} || $selector->{id
} eq '0') {
704 $query = " SELECT * FROM saved_sql WHERE id = ?";
705 $report_arg = $selector->{id
};
712 return $dbh->selectrow_hashref($query, undef, $report_arg);
715 =head2 create_compound($masterID,$subreportID)
717 This will take 2 reports and create a compound report using both of them
721 sub create_compound
{
722 my ( $masterID, $subreportID ) = @_;
723 my $dbh = C4
::Context
->dbh();
726 my $master = get_saved_report
($masterID);
727 my $mastersql = $master->{savedsql
};
728 my $mastertype = $master->{type
};
729 my $sub = get_saved_report
($subreportID);
730 my $subsql = $master->{savedsql
};
731 my $subtype = $master->{type
};
733 # now we have to do some checking to see how these two will fit together
735 my ( $mastertables, $subtables );
736 if ( $mastersql =~ / from (.*) where /i ) {
739 if ( $subsql =~ / from (.*) where /i ) {
742 return ( $mastertables, $subtables );
745 =head2 get_column_type($column)
747 This takes a column name of the format table.column and will return what type it is
748 (free text, set values, date)
752 sub get_column_type
{
753 my ($tablecolumn) = @_;
754 my ($table,$column) = split(/\./,$tablecolumn);
755 my $dbh = C4
::Context
->dbh();
759 # mysql doesn't support a column selection, set column to %
761 my $sth = $dbh->column_info( $catalog, $schema, $table, $tempcolumn ) || die $dbh->errstr;
762 while (my $info = $sth->fetchrow_hashref()){
763 if ($info->{'COLUMN_NAME'} eq $column){
765 if ($info->{'TYPE_NAME'} eq 'CHAR' || $info->{'TYPE_NAME'} eq 'VARCHAR'){
766 $info->{'TYPE_NAME'} = 'distinct';
768 return $info->{'TYPE_NAME'};
773 =head2 get_distinct_values($column)
775 Given a column name, return an arrary ref of hashrefs suitable for use as a tmpl_loop
776 with the distinct values of the column
780 sub get_distinct_values
{
781 my ($tablecolumn) = @_;
782 my ($table,$column) = split(/\./,$tablecolumn);
783 my $dbh = C4
::Context
->dbh();
785 "SELECT distinct($column) as availablevalues FROM $table";
786 my $sth = $dbh->prepare($query);
788 return $sth->fetchall_arrayref({});
791 sub save_dictionary
{
792 my ( $name, $description, $sql, $area ) = @_;
793 my $dbh = C4
::Context
->dbh();
794 my $query = "INSERT INTO reports_dictionary (name,description,saved_sql,report_area,date_created,date_modified)
795 VALUES (?,?,?,?,now(),now())";
796 my $sth = $dbh->prepare($query);
797 $sth->execute($name,$description,$sql,$area) || return 0;
801 sub get_from_dictionary
{
802 my ( $area, $id ) = @_;
803 my $dbh = C4
::Context
->dbh();
804 my $area_name_sql_snippet = get_area_name_sql_snippet
;
806 SELECT d.*, $area_name_sql_snippet
807 FROM reports_dictionary d
811 $query .= " WHERE report_area = ?";
813 $query .= " WHERE id = ?";
815 my $sth = $dbh->prepare($query);
819 $sth->execute($area);
824 while ( my $data = $sth->fetchrow_hashref() ) {
830 sub delete_definition
{
831 my ($id) = @_ or return;
832 my $dbh = C4
::Context
->dbh();
833 my $query = "DELETE FROM reports_dictionary WHERE id = ?";
834 my $sth = $dbh->prepare($query);
839 my ($id) = @_ or return;
840 my $dbh = C4
::Context
->dbh();
841 my $query = "SELECT * FROM saved_sql WHERE id = ?";
842 my $sth = $dbh->prepare($query);
844 my $data=$sth->fetchrow_hashref();
845 return $data->{'savedsql'};
849 my ( $report_id ) = @_;
850 my $dbh = C4
::Context
->dbh;
852 return $dbh->selectall_arrayref(q
|
853 SELECT id
, report
, date_run
856 |, { Slice
=> {} }, $report_id);
859 sub _get_column_defs
{
862 my $columns_def_file = "columns.def";
863 my $htdocs = C4
::Context
->config('intrahtdocs');
864 my $section = 'intranet';
866 # We need the theme and the lang
867 # Since columns.def is not in the modules directory, we cannot sent it for the $tmpl var
868 my ($theme, $lang, $availablethemes) = C4
::Templates
::themelanguage
($htdocs, 'about.tt', $section, $cgi);
870 my $full_path_to_columns_def_file="$htdocs/$theme/$lang/$columns_def_file";
871 open (my $fh, '<:encoding(utf-8)', $full_path_to_columns_def_file);
872 while ( my $input = <$fh> ){
874 if ( $input =~ m
|<field name
="(.*)">(.*)</field
>| ) {
875 my ( $field, $translation ) = ( $1, $2 );
876 $columns{$field} = $translation;
883 =head2 GetReservedAuthorisedValues
885 my %reserved_authorised_values = GetReservedAuthorisedValues();
887 Returns a hash containig all reserved words
891 sub GetReservedAuthorisedValues
{
892 my %reserved_authorised_values =
893 map { $_ => 1 } ( 'date',
898 'biblio_framework' );
900 return \
%reserved_authorised_values;
904 =head2 IsAuthorisedValueValid
906 my $is_valid_ath_value = IsAuthorisedValueValid($authorised_value)
908 Returns 1 if $authorised_value is on the reserved authorised values list or
909 in the authorised value categories defined in
913 sub IsAuthorisedValueValid
{
915 my $authorised_value = shift;
916 my $reserved_authorised_values = GetReservedAuthorisedValues
();
918 if ( exists $reserved_authorised_values->{$authorised_value} ||
919 Koha
::AuthorisedValues
->search({ category
=> $authorised_value })->count ) {
926 =head2 GetParametersFromSQL
928 my @sql_parameters = GetParametersFromSQL($sql)
930 Returns an arrayref of hashes containing the keys name and authval
934 sub GetParametersFromSQL
{
937 my @split = split(/<<|>>/,$sql);
938 my @sql_parameters = ();
940 for ( my $i = 0; $i < ($#split/2) ; $i++ ) {
941 my ($name,$authval) = split(/\|/,$split[$i*2+1]);
942 push @sql_parameters, { 'name' => $name, 'authval' => $authval };
945 return \
@sql_parameters;
948 =head2 ValidateSQLParameters
950 my @problematic_parameters = ValidateSQLParameters($sql)
952 Returns an arrayref of hashes containing the keys name and authval of
953 those SQL parameters that do not correspond to valid authorised names
957 sub ValidateSQLParameters
{
960 my @problematic_parameters = ();
961 my $sql_parameters = GetParametersFromSQL
($sql);
963 foreach my $sql_parameter (@
$sql_parameters) {
964 if ( defined $sql_parameter->{'authval'} ) {
965 push @problematic_parameters, $sql_parameter unless
966 IsAuthorisedValueValid
($sql_parameter->{'authval'});
970 return \
@problematic_parameters;
973 sub _get_display_value
{
974 my ( $original_value, $column ) = @_;
975 if ( $column eq 'periodicity' ) {
976 my $dbh = C4
::Context
->dbh();
977 my $query = "SELECT description FROM subscription_frequencies WHERE id = ?";
978 my $sth = $dbh->prepare($query);
979 $sth->execute($original_value);
980 return $sth->fetchrow;
982 return $original_value;
990 Chris Cormack <crc@liblime.com>