Attachment 111147 Details for Bug 24083 – Bug 24083: Required atomic updates & DB update

[patch] Bug 24083: Required atomic updates & DB update

Bug-24083-Required-atomic-updates--DB-update.patch (text/plain), 10.96 KB, created by Andrew Isherwood on 2020-10-02 12:45:34 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Andrew Isherwood

Created: 2020-10-02 12:45:34 UTC

Size: 10.96 KB

patch

obsolete

>From 33c67c126da9db67b54e0a2d3645c084c82d317b Mon Sep 17 00:00:00 2001
>From: Andrew Isherwood <andrew.isherwood@ptfs-europe.com>
>Date: Thu, 21 Nov 2019 14:35:41 +0000
>Subject: [PATCH] Bug 24083: Required atomic updates & DB update
>
>This patch adds:
>
>- An "UnseenRenewals" circulation syspref that enables/disables the
>  functionality added in this bug
>
>- Add unseen_renewals_allowed to circulation_rules
>
>- A change to the issues & old_issues table schemas and corresponding
>  database upgrades to add issues.unseen_renewals &
>  old_issues.unseen_renewals
>
>- An update for the renewals letter to include a message for unseen
>  renewals
>
>Signed-off-by: Sally Healey <sally.Healey@cheshirewestandchester.gov.uk>
>---
> .../bug_24083_UnseenRenewals_syspref.perl     |  6 ++++
> .../bug_24083_add_issues_unseen_renewals.perl | 12 ++++++++
> ..._issuingrules_unseen_renewals_allowed.perl |  7 +++++
> ...bug_24083_update_auto_renewals_letter.perl | 30 +++++++++++++++++++
> installer/data/mysql/kohastructure.sql        |  2 ++
> installer/data/mysql/sysprefs.sql             |  1 +
> .../admin/preferences/circulation.pref        |  6 ++++
> 7 files changed, 64 insertions(+)
> create mode 100644 installer/data/mysql/atomicupdate/bug_24083_UnseenRenewals_syspref.perl
> create mode 100644 installer/data/mysql/atomicupdate/bug_24083_add_issues_unseen_renewals.perl
> create mode 100644 installer/data/mysql/atomicupdate/bug_24083_add_issuingrules_unseen_renewals_allowed.perl
> create mode 100644 installer/data/mysql/atomicupdate/bug_24083_update_auto_renewals_letter.perl
>
>diff --git a/installer/data/mysql/atomicupdate/bug_24083_UnseenRenewals_syspref.perl b/installer/data/mysql/atomicupdate/bug_24083_UnseenRenewals_syspref.perl
>new file mode 100644
>index 0000000000..afa0fcba25
>--- /dev/null
>+++ b/installer/data/mysql/atomicupdate/bug_24083_UnseenRenewals_syspref.perl
>@@ -0,0 +1,6 @@
>+$DBversion = 'XXX'; # will be replaced by the RM
>+if( CheckVersion( $DBversion ) ) {
>+    $dbh->do( q| INSERT IGNORE INTO systempreferences (variable, value, explanation, options, type) VALUES ('UnseenRenewals', '0', 'If enabled, a renewal can be recorded as "unseen" by the library and count against the borrowers unseen renewals limit', '', 'YesNo'); | );
>+    SetVersion( $DBversion );
>+    print "Upgrade to $DBversion done (Bug 24083 - Add UnseenRenewals syspref)\n";
>+}
>diff --git a/installer/data/mysql/atomicupdate/bug_24083_add_issues_unseen_renewals.perl b/installer/data/mysql/atomicupdate/bug_24083_add_issues_unseen_renewals.perl
>new file mode 100644
>index 0000000000..adee26005a
>--- /dev/null
>+++ b/installer/data/mysql/atomicupdate/bug_24083_add_issues_unseen_renewals.perl
>@@ -0,0 +1,12 @@
>+$DBversion = 'XXX'; # will be replaced by the RM
>+if( CheckVersion( $DBversion ) ) {
>+    if( !column_exists( 'issues', 'unseen_renewals' ) ) {
>+        $dbh->do( q| ALTER TABLE issues ADD unseen_renewals TINYINT(4) DEFAULT 0 NOT NULL AFTER renewals | );
>+    }
>+    if( !column_exists( 'old_issues', 'unseen_renewals' ) ) {
>+        $dbh->do( q| ALTER TABLE old_issues ADD unseen_renewals TINYINT(4) DEFAULT 0 NOT NULL AFTER renewals | );
>+    }
>+
>+    SetVersion( $DBversion );
>+    print "Upgrade to $DBversion done (Bug 24083 - Add issues.unseen_renewals & old_issues.unseen_renewals)\n";
>+}
>diff --git a/installer/data/mysql/atomicupdate/bug_24083_add_issuingrules_unseen_renewals_allowed.perl b/installer/data/mysql/atomicupdate/bug_24083_add_issuingrules_unseen_renewals_allowed.perl
>new file mode 100644
>index 0000000000..3e4cc251ce
>--- /dev/null
>+++ b/installer/data/mysql/atomicupdate/bug_24083_add_issuingrules_unseen_renewals_allowed.perl
>@@ -0,0 +1,7 @@
>+$DBversion = 'XXX'; # will be replaced by the RM
>+if( CheckVersion( $DBversion ) ) {
>+    $dbh->do( q| INSERT IGNORE INTO circulation_rules (rule_name) VALUES ('unseen_renewals_allowed') | );
>+
>+    SetVersion( $DBversion );
>+    print "Upgrade to $DBversion done (Bug 24083 - Add circulation_rules 'unseen_renewals_allowed' rule)\n";
>+}
>diff --git a/installer/data/mysql/atomicupdate/bug_24083_update_auto_renewals_letter.perl b/installer/data/mysql/atomicupdate/bug_24083_update_auto_renewals_letter.perl
>new file mode 100644
>index 0000000000..4a0d2e79ec
>--- /dev/null
>+++ b/installer/data/mysql/atomicupdate/bug_24083_update_auto_renewals_letter.perl
>@@ -0,0 +1,30 @@
>+$DBversion = 'XXX'; # will be replaced by the RM
>+if( CheckVersion( $DBversion ) ) {
>+    my ($text) = $dbh->selectrow_array('SELECT content FROM letter WHERE module = "circulation" AND code = "AUTO_RENEWALS" AND content NOT LIKE "%too_unseen%"');
>+
>+    if ($text) {
>+        my $find = qr/^\[\% (IF|ELSIF) checkout.auto_renew_error == 'too_many' \%\]$/;
>+        my @lines_in = split /^/, $text;
>+        my @lines_out = ();
>+        foreach my $line(@lines_in) {
>+            chomp($line);
>+            if ($line =~ $find) {
>+                if ($1) {
>+                    my $newline_test = $1 eq 'IF' ? 'IF' : 'ELSIF';
>+                    $line =~ s/\bIF\b/ELSIF/;
>+                    push @lines_out, "[% $newline_test checkout.auto_renew_error == 'too_unseen' %]";
>+                    push @lines_out, "You have reach the maximum of consecutive renewals without visiting the library.";
>+                }
>+            }
>+            push @lines_out, $line;
>+        }
>+        if (scalar @lines_out > 0) {
>+            my $joined = join "\n", @lines_out;
>+            $dbh->do(q{UPDATE letter SET content = ? WHERE module = "circulation" AND code = "AUTO_RENEWALS"}, undef, ($joined));
>+        }
>+    }
>+
>+
>+    SetVersion( $DBversion );
>+    print "Upgrade to $DBversion done (Bug 24083 - Update auto renewals letter)\n";
>+}
>diff --git a/installer/data/mysql/kohastructure.sql b/installer/data/mysql/kohastructure.sql
>index 7bc8a4dd96..e9236a7263 100644
>--- a/installer/data/mysql/kohastructure.sql
>+++ b/installer/data/mysql/kohastructure.sql
>@@ -1624,6 +1624,7 @@ CREATE TABLE `issues` ( -- information related to check outs or issues
>   `lastreneweddate` datetime default NULL, -- date the item was last renewed
>   `renewals` tinyint(4) NOT NULL default 0, -- lists the number of times the item was renewed
>   `auto_renew` tinyint(1) default FALSE, -- automatic renewal
>+  `unseen_renewals` tinyint(4) NOT NULL default 0, -- lists the number of consecutive times the item was renewed without being seen
>   `auto_renew_error` varchar(32) COLLATE utf8mb4_unicode_ci DEFAULT NULL, -- automatic renewal error
>   `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- the date and time this record was last touched
>   `issuedate` datetime default NULL, -- date the item was checked out or issued
>@@ -1656,6 +1657,7 @@ CREATE TABLE `old_issues` ( -- lists items that were checked out and have been r
>   `lastreneweddate` datetime default NULL, -- date the item was last renewed
>   `renewals` tinyint(4) NOT NULL default 0, -- lists the number of times the item was renewed
>   `auto_renew` tinyint(1) default FALSE, -- automatic renewal
>+  `unseen_renewals` tinyint(4) NOT NULL default 0, -- lists the number of consecutive times the item was renewed without being seen
>   `auto_renew_error` varchar(32) COLLATE utf8mb4_unicode_ci DEFAULT NULL, -- automatic renewal error
>   `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- the date and time this record was last touched
>   `issuedate` datetime default NULL, -- date the item was checked out or issued
>diff --git a/installer/data/mysql/sysprefs.sql b/installer/data/mysql/sysprefs.sql
>index 3b96afd0a7..a06b0e9526 100644
>--- a/installer/data/mysql/sysprefs.sql
>+++ b/installer/data/mysql/sysprefs.sql
>@@ -669,6 +669,7 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, `
> ('UNIMARCField100Language','fre',NULL,'UNIMARC field 100 default language','short'),
> ('UpdateItemWhenLostFromHoldList','',NULL,'This is a list of values to update an item when it is marked as lost from the holds to pull screen','Free'),
> ('UniqueItemFields','barcode','','Pipe-separated list of fields that should be unique (used in acquisition module for item creation). Fields must be valid SQL column names of items table','Free'),
>+('UnseenRenewals','0','','Allow renewals to be recorded as "unseen" by the library, and count against the borrowers unseen renewals limit','YesNo'),
> ('UnsubscribeReflectionDelay','',NULL,'Delay for locking unsubscribers', 'Integer'),
> ('UpdateItemLocationOnCheckin', '', 'NULL', 'This is a list of value pairs.\n Examples:\n\nPROC: FIC - causes an item in the Processing Center location to be updated into the Fiction location on check in.\nFIC: GEN - causes an item in the Fiction location to be updated into the General stacks location on check in.\n_BLANK_:FIC - causes an item that has no location to be updated into the Fiction location on check in.\nFIC: _BLANK_ - causes an item in location FIC to be updated to a blank location on check in.\n_ALL_:FIC - causes all items to be updated into the Fiction location on check in.\nPROC: _PERM_ - causes an item that is in the Processing Center to be updated to it''s permanent location.\n\nGeneral rule: if the location value on the left matches the item''s current location, it will be updated to match the location value on the right.\nNote: PROC and CART are special values, for these locations only can location and permanent_location differ, in all other cases an update will affect both. Items in the CART location will be returned to their permanent location on checkout.\n\nThe special term _BLANK_ may be used on either side of a value pair to update or remove the location from items with no location assigned.\nThe special term _ALL_ is used on the left side of the colon (:) to affect all items.\nThe special term _PERM_ is used on the right side of the colon (:) to return items to their permanent location.', 'Free'),
> ('UpdateNotForLoanStatusOnCheckin', '', 'NULL', 'This is a list of value pairs. When an item is checked in, if the not for loan value on the left matches the items not for loan value it will be updated to the right-hand value. E.g. ''-1: 0'' will cause an item that was set to ''Ordered'' to now be available for loan. Each pair of values should be on a separate line.', 'Free'),
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref
>index dd803e71b2..0fb94dd174 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref
>@@ -319,6 +319,12 @@ Circulation:
>                   yes: Send
>                   no: "Don't send"
>             - "a renewal notice according to patron's messaging preferences for 'Item checkout'."
>+        -
>+            - pref: UnseenRenewals
>+              choices:
>+                  yes: Allow
>+                  no: "Don't allow"
>+            - renewals to be recorded as "unseen" by the library, and count against the borrowers unseen renewals limit
>         -
>             - Prevent patrons from making holds on the OPAC if they owe more than
>             - pref: maxoutstanding
>-- 
>2.20.1

Actions: View | Diff | Splinter Review

Attachments on bug 24083: 95861 | 95862 | 95863 | 95864 | 95865 | 95866 | 95867 | 95868 | 98749 | 98750 | 98751 | 98752 | 98765 | 98766 | 98767 | 98768 | 100244 | 100245 | 100246 | 100247 | 100380 | 100381 | 100382 | 100383 | 100392 | 110607 | 110608 | 110609 | 110610 | 110611 | 111147 | 111148 | 111149 | 111150 | 111151 | 111152 | 111283 | 111284 | 111285 | 111286 | 111287 | 111288 | 111289 | 111290 | 111291 | 111292 | 111293 | 111849 | 111850 | 111851 | 111852 | 111853 | 111854 | 111855 | 111856 | 111857 | 111858 | 111859 | 111860 | 112230 | 112231 | 112232 | 112233 | 112234 | 112235 | 112236 | 112237 | 112238 | 112239 | 112240 | 112241 | 112242 | 112243 | 112410 | 112411 | 112412 | 112413 | 112414 | 112415 | 112416 | 112417 | 112418 | 112419 | 112420 | 112421 | 112422 | 112423 | 113073 | 113074 | 113075 | 113076 | 113077 | 113078 | 113079 | 113080 | 113314 | 113315 | 113484 | 113485 | 113486 | 113487 | 113488 | 113489 | 113490 | 113491 | 113492 | 113493 | 113494 | 113546 | 113556 | 113557 | 113814