From 49c364f94b54fa5db5388d2125d1392581108dc9 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Marc=20V=C3=A9ron?= <veron@veron.ch>
Date: Mon, 20 Apr 2015 22:13:04 +0200
Subject: [PATCH] Bug 14024 - add reports to action logs

This patch sets adds the possibility to log new, update and delete actions for saved reports.

To test:
-Apply patch
-Run updatedatabase.pl
-Enable system preference ReportsLog
-Create, duplicate, edit and delete saved reports
-Go to Home > Tools > Logs
-Verify that you can select "Reports" in Modules list
-Verify that your actions were logged

Signed-off-by: Nicole Engard <nengard@bywatersolutions.com>

Signed-off-by: Nicole Engard <nengard@bywatersolutions.com>

Signed-off-by: Jonathan Druart <jonathan.druart@koha-community.org>
Signed-off-by: Tomas Cohen Arazi <tomascohen@gmail.com>
---
 C4/Reports/Guided.pm                                        | 6 +++++-
 .../mysql/atomicupdate/bug_14024_add_reportslog_syspref.sql | 1 +
 installer/data/mysql/sysprefs.sql                           | 1 +
 .../prog/en/modules/admin/preferences/logs.pref             | 6 ++++++
 koha-tmpl/intranet-tmpl/prog/en/modules/tools/viewlog.tt    | 3 ++-
 reports/guided_reports.pl                                   | 4 ++++
 6 files changed, 19 insertions(+), 2 deletions(-)
 create mode 100644 installer/data/mysql/atomicupdate/bug_14024_add_reportslog_syspref.sql

diff --git a/C4/Reports/Guided.pm b/C4/Reports/Guided.pm
index 97a41c7b9b..af921417c7 100644
--- a/C4/Reports/Guided.pm
+++ b/C4/Reports/Guided.pm
@@ -32,6 +32,7 @@ use XML::Dumper;
 use C4::Debug;
 # use Smart::Comments;
 # use Data::Dumper;
+use C4::Log;
 
 BEGIN {
     # set the version for version checking
@@ -639,6 +640,10 @@ sub format_results {
 sub delete_report {
     my (@ids) = @_;
     return unless @ids;
+    foreach my $id (@ids) {
+        my $data = get_saved_report($id);
+        logaction( "REPORTS", "DELETE", $id, "Name: $data->{'report_name'} SQL: $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);
@@ -646,7 +651,6 @@ sub delete_report {
 }
 
 sub get_saved_reports_base_query {
-
     my $area_name_sql_snippet = get_area_name_sql_snippet;
     return <<EOQ;
 SELECT s.*, r.report, r.date_run, $area_name_sql_snippet, av_g.lib AS groupname, av_sg.lib AS subgroupname,
diff --git a/installer/data/mysql/atomicupdate/bug_14024_add_reportslog_syspref.sql b/installer/data/mysql/atomicupdate/bug_14024_add_reportslog_syspref.sql
new file mode 100644
index 0000000000..3cebee095c
--- /dev/null
+++ b/installer/data/mysql/atomicupdate/bug_14024_add_reportslog_syspref.sql
@@ -0,0 +1 @@
+INSERT IGNORE INTO systempreferences (variable,value,explanation,options,type) VALUES ('ReportsLog','0',NULL,'If ON, log information about reports.','YesNo');
diff --git a/installer/data/mysql/sysprefs.sql b/installer/data/mysql/sysprefs.sql
index 0e65f8028a..a744cbf2ca 100644
--- a/installer/data/mysql/sysprefs.sql
+++ b/installer/data/mysql/sysprefs.sql
@@ -357,6 +357,7 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, `
 ('RenewSerialAddsSuggestion','0',NULL,'If ON, adds a new suggestion at serial subscription renewal','YesNo'),
 ('RentalFeesCheckoutConfirmation', '0', NULL , 'Allow user to confirm when checking out an item with rental fees.', 'YesNo'),
 ('RentalsInNoissuesCharge','1',NULL,'Rental charges block checkouts (added to noissuescharge).','YesNo'),
+('ReportsLog','0',NULL,'If ON, log information about reports.','YesNo'),
 ('RequestOnOpac','1',NULL,'If ON, globally enables patron holds on OPAC','YesNo'),
 ('ReservesControlBranch','PatronLibrary','ItemHomeLibrary|PatronLibrary','Branch checked for members reservations rights','Choice'),
 ('ReservesMaxPickUpDelay','7','','Define the Maximum delay to pick up an item on hold','Integer'),
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/logs.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/logs.pref
index 73f76c22e2..fdc0928e26 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/logs.pref
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/logs.pref
@@ -53,3 +53,9 @@ Logging:
               on: Log
               off: "Don't log"
         - information from cron jobs.
+    -
+        - pref: ReportsLog
+          choices:
+              on: Log
+              off: "Don't log"
+        - when reports are added, deleted or changed.
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/viewlog.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/viewlog.tt
index 41414a2c6f..3ebed6ff99 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/viewlog.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/viewlog.tt
@@ -27,6 +27,7 @@
 [%        CASE 'FINES'        %]Fines
 [%        CASE 'SYSTEMPREFERENCE' %]System prefs
 [%        CASE 'CRONJOBS' %]Cron jobs
+[%        CASE 'REPORTS'      %]Reports
 [%        CASE %][% module %]
 [%    END %]
 [% END %]
@@ -77,7 +78,7 @@
                                     [% ELSE %]
                                         <option value="">All</option>
                                     [% END %]
-                                    [% FOREACH modx IN [ 'CATALOGUING' 'AUTHORITIES' 'MEMBERS' 'ACQUISITIONS' 'SERIAL' 'CIRCULATION' 'LETTER' 'FINES' 'SYSTEMPREFERENCE' 'CRONJOBS' ] %]
+                                    [% FOREACH modx IN [ 'CATALOGUING' 'AUTHORITIES' 'MEMBERS' 'ACQUISITIONS' 'SERIAL' 'CIRCULATION' 'LETTER' 'FINES' 'SYSTEMPREFERENCE' 'CRONJOBS', 'REPORTS' ] %]
                                         [% IF modules.grep(modx).size %]
                                             <option value="[% modx %]" selected="selected">[% PROCESS translate_log_module module=modx %]</option>
                                         [% ELSE %]
diff --git a/reports/guided_reports.pl b/reports/guided_reports.pl
index 5d8b30242e..d2b658f496 100755
--- a/reports/guided_reports.pl
+++ b/reports/guided_reports.pl
@@ -31,6 +31,8 @@ use C4::Dates qw/format_date/;
 use C4::Debug;
 use C4::Branch; # XXX subfield_is_koha_internal_p
 use C4::Koha qw/IsAuthorisedValueCategory GetFrameworksLoop/;
+use C4::Context;
+use C4::Log;
 
 =head1 NAME
 
@@ -237,6 +239,7 @@ elsif ( $phase eq 'Update SQL'){
                 'reportname'            => $reportname,
                 'id'                    => $id,
             );
+            logaction( "REPORTS", "MODIFY", $id, "$reportname: SQL: $sql" ) if C4::Context->preference("ReportsLog");
         }
         if ( $usecache ) {
             $template->param(
@@ -594,6 +597,7 @@ elsif ( $phase eq 'Save Report' ) {
                     cache_expiry   => $cache_expiry,
                     public         => $public,
                 } );
+                logaction( "REPORTS", "ADD", 0, "Name: $name: SQL: $sql" ) if C4::Context->preference("ReportsLog");
             $template->param(
                 'save_successful' => 1,
                 'reportname'      => $name,
-- 
2.39.5