Bug 16149: Generate and send custom notices based on report output
[koha-equinox.git] / C4 / Reports / Guided.pm
index a4c7c01..eff3a7c 100644 (file)
@@ -4,51 +4,55 @@ package C4::Reports::Guided;
 #
 # This file is part of Koha.
 #
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
 #
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License along
-# with Koha; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
-use strict;
-#use warnings; FIXME - Bug 2505 this module needs a lot of repair to run clean under warnings
-use CGI;
+use Modern::Perl;
+use CGI qw ( -utf8 );
 use Carp;
+use JSON qw( from_json );
 
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
 use C4::Context;
-use C4::Dates qw/format_date format_date_in_iso/;
 use C4::Templates qw/themelanguage/;
 use C4::Koha;
+use Koha::DateUtils;
+use Koha::Patrons;
+use Koha::Reports;
 use C4::Output;
-use XML::Simple;
-use XML::Dumper;
 use C4::Debug;
-# use Smart::Comments;
-# use Data::Dumper;
+use C4::Log;
+use Koha::Notice::Templates;
+use C4::Letters;
+
+use Koha::AuthorisedValues;
+use Koha::Patron::Categories;
+use Koha::SharedContent;
 
 BEGIN {
-    # set the version for version checking
-    $VERSION = 3.07.00.049;
     require Exporter;
     @ISA    = qw(Exporter);
     @EXPORT = qw(
       get_report_types get_report_areas get_report_groups get_columns build_query get_criteria
-      save_report get_saved_reports execute_query get_saved_report create_compound run_compound
+      save_report get_saved_reports execute_query
       get_column_type get_distinct_values save_dictionary get_from_dictionary
       delete_definition delete_report format_results get_sql
-      nb_rows update_sql build_authorised_value_list
+      nb_rows update_sql
       GetReservedAuthorisedValues
       GetParametersFromSQL
       IsAuthorisedValueValid
       ValidateSQLParameters
+      nb_rows update_sql
     );
 }
 
@@ -72,63 +76,37 @@ This will return a list of all the available report areas
 
 =cut
 
-my @REPORT_AREA = (
-    [CIRC => "Circulation"],
-    [CAT  => "Catalogue"],
-    [PAT  => "Patrons"],
-    [ACQ  => "Acquisition"],
-    [ACC  => "Accounts"],
-);
-my $AREA_NAME_SQL_SNIPPET
-  = "CASE report_area " .
+sub get_area_name_sql_snippet {
+    my @REPORT_AREA = (
+        [CIRC => "Circulation"],
+        [CAT  => "Catalogue"],
+        [PAT  => "Patrons"],
+        [ACQ  => "Acquisition"],
+        [ACC  => "Accounts"],
+        [SER  => "Serials"],
+    );
+
+    return "CASE report_area " .
     join (" ", map "WHEN '$_->[0]' THEN '$_->[1]'", @REPORT_AREA) .
     " END AS areaname";
+}
+
 sub get_report_areas {
-    return \@REPORT_AREA
+
+    my $report_areas = [ 'CIRC', 'CAT', 'PAT', 'ACQ', 'ACC', 'SER' ];
+
+    return $report_areas;
 }
 
-my %table_areas = (
+sub get_table_areas {
+    return (
     CIRC => [ 'borrowers', 'statistics', 'items', 'biblioitems' ],
     CAT  => [ 'items', 'biblioitems', 'biblio' ],
     PAT  => ['borrowers'],
     ACQ  => [ 'aqorders', 'biblio', 'items' ],
     ACC  => [ 'borrowers', 'accountlines' ],
-);
-my %keys = (
-    CIRC => [ 'statistics.borrowernumber=borrowers.borrowernumber',
-              'items.itemnumber = statistics.itemnumber',
-              'biblioitems.biblioitemnumber = items.biblioitemnumber' ],
-    CAT  => [ 'items.biblioitemnumber=biblioitems.biblioitemnumber',
-              'biblioitems.biblionumber=biblio.biblionumber' ],
-    PAT  => [],
-    ACQ  => [ 'aqorders.biblionumber=biblio.biblionumber',
-              'biblio.biblionumber=items.biblionumber' ],
-    ACC  => ['borrowers.borrowernumber=accountlines.borrowernumber'],
-);
-
-# have to do someting here to know if its dropdown, free text, date etc
-my %criteria = (
-    CIRC => [ 'statistics.type', 'borrowers.categorycode', 'statistics.branch',
-              'biblioitems.publicationyear|date', 'items.dateaccessioned|date' ],
-    CAT  => [ 'items.itemnumber|textrange', 'items.biblionumber|textrange',
-              'items.barcode|textrange', 'biblio.frameworkcode',
-              'items.holdingbranch', 'items.homebranch',
-              'biblio.datecreated|daterange', 'biblio.timestamp|daterange',
-              'items.onloan|daterange', 'items.ccode',
-              'items.itemcallnumber|textrange', 'items.itype', 'items.itemlost',
-              'items.location' ],
-    PAT  => [ 'borrowers.branchcode', 'borrowers.categorycode' ],
-    ACQ  => ['aqorders.datereceived|date'],
-    ACC  => [ 'borrowers.branchcode', 'borrowers.categorycode' ],
-);
-
-# Adds itemtypes to criteria, according to the syspref
-if ( C4::Context->preference('item-level_itypes') ) {
-    unshift @{ $criteria{'CIRC'} }, 'items.itype';
-    unshift @{ $criteria{'CAT'} }, 'items.itype';
-} else {
-    unshift @{ $criteria{'CIRC'} }, 'biblioitems.itemtype';
-    unshift @{ $criteria{'CAT'} }, 'biblioitems.itemtype';
+    SER  => [ 'serial', 'serialitems', 'subscription', 'subscriptionhistory', 'subscriptionroutinglist', 'biblioitems', 'biblio', 'aqbooksellers' ],
+    );
 }
 
 =head2 get_report_types
@@ -210,8 +188,9 @@ This will return a list of all columns for a report area
 
 sub get_columns {
 
-    # this calls the internal fucntion _get_columns
+    # this calls the internal function _get_columns
     my ( $area, $cgi ) = @_;
+    my %table_areas = get_table_areas;
     my $tables = $table_areas{$area}
       or die qq{Unsuported report area "$area"};
 
@@ -256,8 +235,24 @@ This is what get_columns returns.
 
 sub build_query {
     my ( $columns, $criteria, $orderby, $area, $totals, $definition ) = @_;
+
+    my %keys = (
+        CIRC => [ 'statistics.borrowernumber=borrowers.borrowernumber',
+                  'items.itemnumber = statistics.itemnumber',
+                  'biblioitems.biblioitemnumber = items.biblioitemnumber' ],
+        CAT  => [ 'items.biblioitemnumber=biblioitems.biblioitemnumber',
+                  'biblioitems.biblionumber=biblio.biblionumber' ],
+        PAT  => [],
+        ACQ  => [ 'aqorders.biblionumber=biblio.biblionumber',
+                  'biblio.biblionumber=items.biblionumber' ],
+        ACC  => ['borrowers.borrowernumber=accountlines.borrowernumber'],
+        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'],
+    );
+
+
 ### $orderby
     my $keys   = $keys{$area};
+    my %table_areas = get_table_areas;
     my $tables = $table_areas{$area};
 
     my $sql =
@@ -327,6 +322,34 @@ Returns an arraref to hashrefs suitable for using in a tmpl_loop. With the crite
 sub get_criteria {
     my ($area,$cgi) = @_;
     my $dbh    = C4::Context->dbh();
+
+    # have to do someting here to know if its dropdown, free text, date etc
+    my %criteria = (
+        CIRC => [ 'statistics.type', 'borrowers.categorycode', 'statistics.branch',
+                  'biblioitems.publicationyear|date', 'items.dateaccessioned|date' ],
+        CAT  => [ 'items.itemnumber|textrange', 'items.biblionumber|textrange',
+                  'items.barcode|textrange', 'biblio.frameworkcode',
+                  'items.holdingbranch', 'items.homebranch',
+                  'biblio.datecreated|daterange', 'biblio.timestamp|daterange',
+                  'items.onloan|daterange', 'items.ccode',
+                  'items.itemcallnumber|textrange', 'items.itype', 'items.itemlost',
+                  'items.location' ],
+        PAT  => [ 'borrowers.branchcode', 'borrowers.categorycode' ],
+        ACQ  => ['aqorders.datereceived|date'],
+        ACC  => [ 'borrowers.branchcode', 'borrowers.categorycode' ],
+        SER  => ['subscription.startdate|date', 'subscription.enddate|date', 'subscription.periodicity', 'subscription.callnumber', 'subscription.location', 'subscription.branchcode'],
+    );
+
+    # Adds itemtypes to criteria, according to the syspref
+    if ( C4::Context->preference('item-level_itypes') ) {
+        unshift @{ $criteria{'CIRC'} }, 'items.itype';
+        unshift @{ $criteria{'CAT'} }, 'items.itype';
+    } else {
+        unshift @{ $criteria{'CIRC'} }, 'biblioitems.itemtype';
+        unshift @{ $criteria{'CAT'} }, 'biblioitems.itemtype';
+    }
+
+
     my $crit   = $criteria{$area};
     my $column_defs = _get_column_defs($cgi);
     my @criteria_array;
@@ -368,13 +391,17 @@ sub get_criteria {
             my $list;
             $list='branches' if $column eq 'branchcode' or $column eq 'holdingbranch' or $column eq 'homebranch';
             $list='categorycode' if $column eq 'categorycode';
-            $list='itemtype' if $column eq 'itype';
+            $list='itemtypes' if $column eq 'itype';
             $list='ccode' if $column eq 'ccode';
             # TODO : improve to let the librarian choose the description at runtime
-            push @values, { availablevalues => "<<$column".($list?"|$list":'').">>" };
+            push @values, {
+                availablevalues => "<<$column" . ( $list ? "|$list" : '' ) . ">>",
+                display_value   => "<<$column" . ( $list ? "|$list" : '' ) . ">>",
+            };
             while ( my $row = $sth->fetchrow_hashref() ) {
+                if ($row->{'availablevalues'} eq '') { $row->{'default'} = 1 }
+                else { $row->{display_value} = _get_display_value( $row->{'availablevalues'}, $column ); }
                 push @values, $row;
-                if ($row->{'availablevalues'} eq '') { $row->{'default'} = 1 };
             }
             $sth->finish();
 
@@ -385,7 +412,6 @@ sub get_criteria {
 
             push @criteria_array, \%temp;
         }
-
     }
     return ( \@criteria_array );
 }
@@ -417,7 +443,7 @@ for the query.
 C<$offset>, and C<$limit> are required parameters.
 
 C<\@sql_params> is an optional list of parameter values to paste in.
-The caller is reponsible for making sure that C<$sql> has placeholders
+The caller is responsible for making sure that C<$sql> has placeholders
 and that the number placeholders matches the number of parameters.
 
 =cut
@@ -475,7 +501,7 @@ sub strip_limit {
 
 sub execute_query {
 
-    my ( $sql, $offset, $limit, $sql_params ) = @_;
+    my ( $sql, $offset, $limit, $sql_params, $report_id ) = @_;
 
     $sql_params = [] unless defined $sql_params;
 
@@ -510,14 +536,15 @@ sub execute_query {
     }
     $sql .= " LIMIT ?, ?";
 
-    my $sth = C4::Context->dbh->prepare($sql);
+    my $dbh = C4::Context->dbh;
+
+    $dbh->do( 'UPDATE saved_sql SET last_run = NOW() WHERE id = ?', undef, $report_id ) if $report_id;
+
+    my $sth = $dbh->prepare($sql);
     $sth->execute(@$sql_params, $offset, $limit);
+
     return ( $sth, { queryerr => $sth->errstr } ) if ($sth->err);
     return ( $sth );
-    # my @xmlarray = ... ;
-    # my $url = "/cgi-bin/koha/reports/guided_reports.pl?phase=retrieve%20results&id=$id";
-    # my $xml = XML::Dumper->new()->pl2xml( \@xmlarray );
-    # store_results($id,$xml);
 }
 
 =head2 save_report($sql,$name,$type,$notes)
@@ -572,59 +599,47 @@ sub update_sql {
 }
 
 sub store_results {
-       my ($id,$xml)=@_;
-       my $dbh = C4::Context->dbh();
-       my $query = "SELECT * FROM saved_reports WHERE report_id=?";
-       my $sth = $dbh->prepare($query);
-       $sth->execute($id);
-       if (my $data=$sth->fetchrow_hashref()){
-               my $query2 = "UPDATE saved_reports SET report=?,date_run=now() WHERE report_id=?";
-               my $sth2 = $dbh->prepare($query2);
-           $sth2->execute($xml,$id);
-       }
-       else {
-               my $query2 = "INSERT INTO saved_reports (report_id,report,date_run) VALUES (?,?,now())";
-               my $sth2 = $dbh->prepare($query2);
-               $sth2->execute($id,$xml);
-       }
+    my ( $id, $json ) = @_;
+    my $dbh = C4::Context->dbh();
+    $dbh->do(q|
+        INSERT INTO saved_reports ( report_id, report, date_run ) VALUES ( ?, ?, NOW() );
+    |, undef, $id, $json );
 }
 
 sub format_results {
-       my ($id) = @_;
-       my $dbh = C4::Context->dbh();
-       my $query = "SELECT * FROM saved_reports WHERE report_id = ?";
-       my $sth = $dbh->prepare($query);
-       $sth->execute($id);
-       my $data = $sth->fetchrow_hashref();
-       my $dump = new XML::Dumper;
-       my $perl = $dump->xml2pl( $data->{'report'} );
-       foreach my $row (@$perl) {
-               my $htmlrow="<tr>";
-               foreach my $key (keys %$row){
-                       $htmlrow .= "<td>$row->{$key}</td>";
-               }
-               $htmlrow .= "</tr>";
-               $row->{'row'} = $htmlrow;
-       }
-       $sth->finish;
-       $query = "SELECT * FROM saved_sql WHERE id = ?";
-       $sth = $dbh->prepare($query);
-       $sth->execute($id);
-       $data = $sth->fetchrow_hashref();
-       return ($perl,$data->{'report_name'},$data->{'notes'}); 
-}      
+    my ( $id ) = @_;
+    my $dbh = C4::Context->dbh();
+    my ( $report_name, $notes, $json, $date_run ) = $dbh->selectrow_array(q|
+       SELECT ss.report_name, ss.notes, sr.report, sr.date_run
+       FROM saved_sql ss
+       LEFT JOIN saved_reports sr ON sr.report_id = ss.id
+       WHERE sr.id = ?
+    |, undef, $id);
+    return {
+        report_name => $report_name,
+        notes => $notes,
+        results => from_json( $json ),
+        date_run => $date_run,
+    };
+}
 
 sub delete_report {
     my (@ids) = @_;
     return unless @ids;
+    foreach my $id (@ids) {
+        my $data = Koha::Reports->find($id);
+        logaction( "REPORTS", "DELETE", $id, $data->report_name." | ".$data->savedsql ) if C4::Context->preference("ReportsLog");
+    }
     my $dbh = C4::Context->dbh;
     my $query = 'DELETE FROM saved_sql WHERE id IN (' . join( ',', ('?') x @ids ) . ')';
     my $sth = $dbh->prepare($query);
     return $sth->execute(@ids);
 }
 
-my $SAVED_REPORTS_BASE_QRY = <<EOQ;
-SELECT s.*, r.report, r.date_run, $AREA_NAME_SQL_SNIPPET, av_g.lib AS groupname, av_sg.lib AS subgroupname,
+sub get_saved_reports_base_query {
+    my $area_name_sql_snippet = get_area_name_sql_snippet;
+    return <<EOQ;
+SELECT s.*, $area_name_sql_snippet, av_g.lib AS groupname, av_sg.lib AS subgroupname,
 b.firstname AS borrowerfirstname, b.surname AS borrowersurname
 FROM saved_sql s
 LEFT JOIN saved_reports r ON r.report_id = s.id
@@ -632,7 +647,8 @@ LEFT OUTER JOIN authorised_values av_g ON (av_g.category = 'REPORT_GROUP' AND av
 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)
 LEFT OUTER JOIN borrowers b USING (borrowernumber)
 EOQ
-my $DATE_FORMAT = "%d/%m/%Y";
+}
+
 sub get_saved_reports {
 # $filter is either { date => $d, author => $a, keyword => $kw, }
 # or $keyword. Optional.
@@ -641,16 +657,14 @@ sub get_saved_reports {
     my ($group, $subgroup) = @_;
 
     my $dbh   = C4::Context->dbh();
-    my $query = $SAVED_REPORTS_BASE_QRY;
+    my $query = get_saved_reports_base_query;
     my (@cond,@args);
     if ($filter) {
         if (my $date = $filter->{date}) {
-            $date = format_date_in_iso($date);
-            push @cond, "DATE(date_run) = ? OR
-                         DATE(date_created) = ? OR
-                         DATE(last_modified) = ? OR
+            $date = eval { output_pref( { dt => dt_from_string( $date ), dateonly => 1, dateformat => 'iso' }); };
+            push @cond, "DATE(last_modified) = ? OR
                          DATE(last_run) = ?";
-            push @args, $date, $date, $date, $date;
+            push @args, $date, $date, $date;
         }
         if (my $author = $filter->{author}) {
             $author = "%$author%";
@@ -659,12 +673,14 @@ sub get_saved_reports {
             push @args, $author, $author;
         }
         if (my $keyword = $filter->{keyword}) {
-            $keyword = "%$keyword%";
-            push @cond, "report LIKE ? OR
-                         report_name LIKE ? OR
-                         notes LIKE ? OR
-                         savedsql LIKE ?";
-            push @args, $keyword, $keyword, $keyword, $keyword;
+            push @cond, q|
+                       report LIKE ?
+                    OR report_name LIKE ?
+                    OR notes LIKE ?
+                    OR savedsql LIKE ?
+                    OR s.id = ?
+            |;
+            push @args, "%$keyword%", "%$keyword%", "%$keyword%", "%$keyword%", $keyword;
         }
         if ($filter->{group}) {
             push @cond, "report_group = ?";
@@ -683,60 +699,6 @@ sub get_saved_reports {
     return $result;
 }
 
-sub get_saved_report {
-    my $dbh   = C4::Context->dbh();
-    my $query;
-    my $report_arg;
-    if ($#_ == 0 && ref $_[0] ne 'HASH') {
-        ($report_arg) = @_;
-        $query = " SELECT * FROM saved_sql WHERE id = ?";
-    } elsif (ref $_[0] eq 'HASH') {
-        my ($selector) = @_;
-        if ($selector->{name}) {
-            $query = " SELECT * FROM saved_sql WHERE report_name = ?";
-            $report_arg = $selector->{name};
-        } elsif ($selector->{id} || $selector->{id} eq '0') {
-            $query = " SELECT * FROM saved_sql WHERE id = ?";
-            $report_arg = $selector->{id};
-        } else {
-            return;
-        }
-    } else {
-        return;
-    }
-    return $dbh->selectrow_hashref($query, undef, $report_arg);
-}
-
-=head2 create_compound($masterID,$subreportID)
-
-This will take 2 reports and create a compound report using both of them
-
-=cut
-
-sub create_compound {
-    my ( $masterID, $subreportID ) = @_;
-    my $dbh = C4::Context->dbh();
-
-    # get the reports
-    my $master = get_saved_report($masterID);
-    my $mastersql = $master->{savedsql};
-    my $mastertype = $master->{type};
-    my $sub = get_saved_report($subreportID);
-    my $subsql = $master->{savedsql};
-    my $subtype = $master->{type};
-
-    # now we have to do some checking to see how these two will fit together
-    # or if they will
-    my ( $mastertables, $subtables );
-    if ( $mastersql =~ / from (.*) where /i ) {
-        $mastertables = $1;
-    }
-    if ( $subsql =~ / from (.*) where /i ) {
-        $subtables = $1;
-    }
-    return ( $mastertables, $subtables );
-}
-
 =head2 get_column_type($column)
 
 This takes a column name of the format table.column and will return what type it is
@@ -751,7 +713,7 @@ sub get_column_type {
        my $catalog;
        my $schema;
 
-       # mysql doesnt support a column selection, set column to %
+    # mysql doesn't support a column selection, set column to %
        my $tempcolumn='%';
        my $sth = $dbh->column_info( $catalog, $schema, $table, $tempcolumn ) || die $dbh->errstr;
        while (my $info = $sth->fetchrow_hashref()){
@@ -793,14 +755,15 @@ sub save_dictionary {
     return 1;
 }
 
-my $DICTIONARY_BASE_QRY = <<EOQ;
-SELECT d.*, $AREA_NAME_SQL_SNIPPET
-FROM reports_dictionary d
-EOQ
 sub get_from_dictionary {
     my ( $area, $id ) = @_;
     my $dbh   = C4::Context->dbh();
-    my $query = $DICTIONARY_BASE_QRY;
+    my $area_name_sql_snippet = get_area_name_sql_snippet;
+    my $query = <<EOQ;
+SELECT d.*, $area_name_sql_snippet
+FROM reports_dictionary d
+EOQ
+
     if ($area) {
         $query .= " WHERE report_area = ?";
     } elsif ($id) {
@@ -829,6 +792,13 @@ sub delete_definition {
        $sth->execute($id);
 }
 
+=head2 get_sql($report_id)
+
+Given a report id, return the SQL statement for that report.
+Otherwise, it just returns.
+
+=cut
+
 sub get_sql {
        my ($id) = @_ or return;
        my $dbh = C4::Context->dbh();
@@ -839,6 +809,16 @@ sub get_sql {
        return $data->{'savedsql'};
 }
 
+sub get_results {
+    my ( $report_id ) = @_;
+    my $dbh = C4::Context->dbh;
+    return $dbh->selectall_arrayref(q|
+        SELECT id, report, date_run
+        FROM saved_reports
+        WHERE report_id = ?
+    |, { Slice => {} }, $report_id);
+}
+
 sub _get_column_defs {
     my ($cgi) = @_;
     my %columns;
@@ -851,7 +831,7 @@ sub _get_column_defs {
     my ($theme, $lang, $availablethemes) = C4::Templates::themelanguage($htdocs, 'about.tt', $section, $cgi);
 
     my $full_path_to_columns_def_file="$htdocs/$theme/$lang/$columns_def_file";
-    open (my $fh, $full_path_to_columns_def_file);
+    open (my $fh, '<:encoding(utf-8)', $full_path_to_columns_def_file);
     while ( my $input = <$fh> ){
         chomp $input;
         if ( $input =~ m|<field name="(.*)">(.*)</field>| ) {
@@ -863,71 +843,6 @@ sub _get_column_defs {
     return \%columns;
 }
 
-=head2 build_authorised_value_list($authorised_value)
-
-Returns an arrayref - hashref pair. The hashref consists of
-various code => name lists depending on the $authorised_value.
-The arrayref is the hashref keys, in appropriate order
-
-=cut
-
-sub build_authorised_value_list {
-    my ( $authorised_value ) = @_;
-
-    my $dbh = C4::Context->dbh;
-    my @authorised_values;
-    my %authorised_lib;
-
-    # builds list, depending on authorised value...
-    if ( $authorised_value eq "branches" ) {
-        my $branches = GetBranchesLoop();
-        foreach my $thisbranch (@$branches) {
-            push @authorised_values, $thisbranch->{value};
-            $authorised_lib{ $thisbranch->{value} } = $thisbranch->{branchname};
-        }
-    } elsif ( $authorised_value eq "itemtypes" ) {
-        my $sth = $dbh->prepare("SELECT itemtype,description FROM itemtypes ORDER BY description");
-        $sth->execute;
-        while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
-            push @authorised_values, $itemtype;
-            $authorised_lib{$itemtype} = $description;
-        }
-    } elsif ( $authorised_value eq "cn_source" ) {
-        my $class_sources  = GetClassSources();
-        my $default_source = C4::Context->preference("DefaultClassificationSource");
-        foreach my $class_source ( sort keys %$class_sources ) {
-            next
-              unless $class_sources->{$class_source}->{'used'}
-                  or ( $class_source eq $default_source );
-            push @authorised_values, $class_source;
-            $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
-        }
-    } elsif ( $authorised_value eq "categorycode" ) {
-        my $sth = $dbh->prepare("SELECT categorycode, description FROM categories ORDER BY description");
-        $sth->execute;
-        while ( my ( $categorycode, $description ) = $sth->fetchrow_array ) {
-            push @authorised_values, $categorycode;
-            $authorised_lib{$categorycode} = $description;
-        }
-
-        #---- "true" authorised value
-    } else {
-        my $authorised_values_sth = $dbh->prepare("SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib");
-
-        $authorised_values_sth->execute($authorised_value);
-
-        while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
-            push @authorised_values, $value;
-            $authorised_lib{$value} = $lib;
-
-            # For item location, we show the code and the libelle
-            $authorised_lib{$value} = $lib;
-        }
-    }
-
-    return (\@authorised_values, \%authorised_lib);
-}
-
 =head2 GetReservedAuthorisedValues
 
     my %reserved_authorised_values = GetReservedAuthorisedValues();
@@ -942,7 +857,8 @@ sub GetReservedAuthorisedValues {
                               'branches',
                               'itemtypes',
                               'cn_source',
-                              'categorycode' );
+                              'categorycode',
+                              'biblio_framework' );
 
    return \%reserved_authorised_values;
 }
@@ -963,7 +879,7 @@ sub IsAuthorisedValueValid {
     my $reserved_authorised_values = GetReservedAuthorisedValues();
 
     if ( exists $reserved_authorised_values->{$authorised_value} ||
-         IsAuthorisedValueCategory($authorised_value)   ) {
+         Koha::AuthorisedValues->search({ category => $authorised_value })->count ) {
         return 1;
     }
 
@@ -1017,6 +933,131 @@ sub ValidateSQLParameters {
     return \@problematic_parameters;
 }
 
+=head2 EmailReport
+
+    my ( $emails, $arrayrefs ) = EmailReport($report_id, $letter_code, $module, $branch, $email)
+
+Take a report and use it to process a Template Toolkit formatted notice
+Returns arrayrefs containing prepared letters and errors respectively
+
+=cut
+
+sub EmailReport {
+
+    my $params     = shift;
+    my $report_id  = $params->{report_id};
+    my $from       = $params->{from};
+    my $email      = $params->{email};
+    my $module     = $params->{module};
+    my $code       = $params->{code};
+    my $branch     = $params->{branch} || "";
+
+    my @errors = ();
+    my @emails = ();
+
+    return ( undef, [{ FATAL => "MISSING_PARAMS" }] ) unless ($report_id && $module && $code);
+
+    return ( undef, [{ FATAL => "NO_LETTER" }] ) unless
+    my $letter = Koha::Notice::Templates->find({
+        module     => $module,
+        code       => $code,
+        branchcode => $branch,
+        message_transport_type => 'email',
+    });
+    $letter = $letter->unblessed;
+
+    my $report = Koha::Reports->find( $report_id );
+    my $sql = $report->savedsql;
+    return ( { FATAL => "NO_REPORT" } ) unless $sql;
+
+    my ( $sth, $errors ) = execute_query( $sql ); #don't pass offset or limit, hardcoded limit of 999,999 will be used
+    return ( undef, [{ FATAL => "REPORT_FAIL" }] ) if $errors;
+
+    my $counter = 1;
+    my $template = $letter->{content};
+
+    while ( my $row = $sth->fetchrow_hashref() ) {
+        my $email;
+        my $err_count = scalar @errors;
+        push ( @errors, { NO_BOR_COL => $counter } ) unless defined $row->{borrowernumber};
+        push ( @errors, { NO_EMAIL_COL => $counter } ) unless ( (defined $email && defined $row->{$email}) || defined $row->{email} );
+        push ( @errors, { NO_FROM_COL => $counter } ) unless defined ( $from || $row->{from} );
+        push ( @errors, { NO_BOR => $row->{borrowernumber} } ) unless Koha::Patrons->find({borrowernumber=>$row->{borrowernumber}});
+
+        my $from_address = $from || $row->{from};
+        my $to_address = $email ? $row->{$email} : $row->{email};
+        push ( @errors, { NOT_PARSE => $counter } ) unless my $content = _process_row_TT( $row, $template );
+        $counter++;
+        next if scalar @errors > $err_count; #If any problems, try next
+
+        $letter->{content}       = $content;
+        $email->{borrowernumber} = $row->{borrowernumber};
+        $email->{letter}         = $letter;
+        $email->{from_address}   = $from_address;
+        $email->{to_address}     = $to_address;
+
+        push ( @emails, $email );
+    }
+
+    return ( \@emails, \@errors );
+
+}
+
+
+
+=head2 ProcessRowTT
+
+   my $content = ProcessRowTT($row_hashref, $template);
+
+Accepts a hashref containing values and processes them against Template Toolkit
+to produce content
+
+=cut
+
+sub _process_row_TT {
+
+    my ($row, $template) = @_;
+
+    return 0 unless ($row && $template);
+    my $content;
+    my $processor = Template->new();
+    $processor->process( \$template, $row, \$content);
+    return $content;
+
+}
+
+sub _get_display_value {
+    my ( $original_value, $column ) = @_;
+    if ( $column eq 'periodicity' ) {
+        my $dbh = C4::Context->dbh();
+        my $query = "SELECT description FROM subscription_frequencies WHERE id = ?";
+        my $sth   = $dbh->prepare($query);
+        $sth->execute($original_value);
+        return $sth->fetchrow;
+    }
+    return $original_value;
+}
+
+
+=head3 convert_sql
+
+my $updated_sql = C4::Reports::Guided::convert_sql( $sql );
+
+Convert a sql query using biblioitems.marcxml to use the new
+biblio_metadata.metadata field instead
+
+=cut
+
+sub convert_sql {
+    my ( $sql ) = @_;
+    my $updated_sql = $sql;
+    if ( $sql =~ m|biblioitems| and $sql =~ m|marcxml| ) {
+        $updated_sql =~ s|biblioitems|biblio_metadata|g;
+        $updated_sql =~ s|marcxml|metadata|g;
+    }
+    return $updated_sql;
+}
+
 1;
 __END__