Attachment 140779 Details for Bug 31028 – Bug 31028: Add notice trigger for catalog concerns

[patch] Bug 31028: Add notice trigger for catalog concerns

Bug-31028-Add-notice-trigger-for-catalog-concerns.patch (text/plain), 8.99 KB, created by Martin Renvoize (ashimema) on 2022-09-20 11:24:46 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Martin Renvoize (ashimema)

Created: 2022-09-20 11:24:46 UTC

Size: 8.99 KB

patch

obsolete

>From c4e43e0ceda2073c0d03143264af71d1322be509 Mon Sep 17 00:00:00 2001
>From: Martin Renvoize <martin.renvoize@ptfs-europe.com>
>Date: Tue, 16 Aug 2022 17:06:39 +0100
>Subject: [PATCH] Bug 31028: Add notice trigger for catalog concerns
>
>This patch adds a new system prefernce, `CatalogerEmails`. If set with a
>valid email address adding a new catalog concern should produce a
>notification email sent to that address.
>---
> C4/Letters.pm                                 |  9 +++-
> Koha/Catalog/Concern.pm                       | 47 ++++++++++++++++++-
> .../data/mysql/atomicupdate/bug_31028.pl      | 15 ++++++
> .../mysql/en/mandatory/sample_notices.yml     | 16 +++++++
> installer/data/mysql/mandatory/sysprefs.sql   |  1 +
> .../admin/preferences/cataloguing.pref        |  6 +++
> 6 files changed, 91 insertions(+), 3 deletions(-)
>
>diff --git a/C4/Letters.pm b/C4/Letters.pm
>index bde0d2b0dc..f7ca52d0d7 100644
>--- a/C4/Letters.pm
>+++ b/C4/Letters.pm
>@@ -737,6 +737,7 @@ sub _parseletter_sth {
>     ($table eq 'accountlines' )    ? "SELECT * FROM $table WHERE   accountlines_id = ?"                               :
>     ($table eq 'biblio'       )    ? "SELECT * FROM $table WHERE   biblionumber = ?"                                  :
>     ($table eq 'biblioitems'  )    ? "SELECT * FROM $table WHERE   biblionumber = ?"                                  :
>+    ($table eq 'catalog_concerns'  )    ? "SELECT * FROM $table WHERE   id = ?"                                       :
>     ($table eq 'credits'      )    ? "SELECT * FROM accountlines WHERE   accountlines_id = ?"                         :
>     ($table eq 'debits'       )    ? "SELECT * FROM accountlines WHERE   accountlines_id = ?"                         :
>     ($table eq 'items'        )    ? "SELECT * FROM $table WHERE     itemnumber = ?"                                  :
>@@ -1608,7 +1609,7 @@ sub _process_tt {
>     my $tt_params = { %{ _get_tt_params( $tables ) }, %{ _get_tt_params( $loops, 'is_a_loop' ) }, %$substitute, %$objects };
> 
>     $content = add_tt_filters( $content );
>-    $content = qq|[% USE KohaDates %][% USE Remove_MARC_punctuation %]$content|;
>+    $content = qq|[% USE KohaDates %][% USE Remove_MARC_punctuation %][% PROCESS 'html_helpers.inc' %]$content|;
> 
>     my $output;
>     my $schema = Koha::Database->new->schema;
>@@ -1644,6 +1645,12 @@ sub _get_tt_params {
>             plural   => 'biblios',
>             pk       => 'biblionumber',
>         },
>+        catalog_concerns => {
>+            module   => 'Koha::Catalog::Concerns',
>+            singular => 'catalog_concern',
>+            plural   => 'catalog_concerns',
>+            pk       => 'id',
>+        },
>         biblioitems => {
>             module   => 'Koha::Biblioitems',
>             singular => 'biblioitem',
>diff --git a/Koha/Catalog/Concern.pm b/Koha/Catalog/Concern.pm
>index a4ab05615e..8c2f75767b 100644
>--- a/Koha/Catalog/Concern.pm
>+++ b/Koha/Catalog/Concern.pm
>@@ -17,16 +17,17 @@ package Koha::Catalog::Concern;
> 
> use Modern::Perl;
> 
>-
> use base qw(Koha::Object);
> 
>+use C4::Letters;
>+
> =head1 NAME
> 
> Koha::Catalog::Concern - Koha Catalog::Concern Object class
> 
> =head1 API
> 
>-=head2 Class methods
>+=head2 Relations
> 
> =cut
> 
>@@ -69,6 +70,8 @@ sub biblio {
>     return Koha::Biblio->_new_from_dbic( $rs );
> }
> 
>+=head2 Actions
>+
> =head3 resolve
> 
>   $concern = $concern->resolve(
>@@ -105,6 +108,46 @@ sub resolve {
>     return $self;
> }
> 
>+=head2 Core methods
>+
>+=head3 store
>+
>+Overloaded I<store> method to trigger notices as required
>+
>+=cut
>+
>+sub store {
>+    my ($self) = @_;
>+
>+    my $is_new = !$self->in_storage;
>+    $self = $self->SUPER::store;
>+
>+    if ($is_new && C4::Context->preference('CatalogerEmails') ) {
>+
>+        # notify the library if a notice exists
>+        my $letter = C4::Letters::GetPreparedLetter(
>+            module      => 'catalog',
>+            letter_code => 'CONCERN_NOTIFY',
>+            branchcode  => $self->reporter->branchcode,
>+            tables      => { catalog_concerns => $self->id }
>+        );
>+
>+        if ($letter) {
>+            my $message_id = C4::Letters::EnqueueLetter(
>+                {
>+                    letter                 => $letter,
>+                    message_transport_type => 'email',
>+                    to_address             => C4::Preference('CatalogerEmails'),
>+                    reply_address          => $self->reporter->notice_email_address,
>+                }
>+            );
>+            C4::Letters::SendQueuedMessages( { message_id => $message_id } );
>+        }
>+    }
>+
>+    return $self;
>+}
>+
> =head2 Internal methods
> 
> =cut
>diff --git a/installer/data/mysql/atomicupdate/bug_31028.pl b/installer/data/mysql/atomicupdate/bug_31028.pl
>index 276d14835a..f2f80b501e 100644
>--- a/installer/data/mysql/atomicupdate/bug_31028.pl
>+++ b/installer/data/mysql/atomicupdate/bug_31028.pl
>@@ -40,5 +40,20 @@ return {
> 	            ('OpacCatalogConcerns', '0', NULL, 'Allow logged in OPAC users to report catalog concerns', 'YesNo')
> 	        }
>         );
>+
>+        $dbh->do(
>+            q{
>+                INSERT IGNORE INTO systempreferences ( `variable`, `value`, `options`, `explanation`, `type` ) VALUES
>+	            ('CatalogerEmails', '', '', 'Notify these catalogers by email when a catalog concern is submitted', 'free')
>+	        }
>+        );
>+
>+        $dbh->do(
>+            q{
>+                INSERT IGNORE INTO letter(module,code,branchcode,name,is_html,title,content,message_transport_type)
>+                VALUES ( 'catalog', 'CONCERN_NOTIFY', '', 'Catalog concern notification', '1', 'Catalog concern reported', "Dear cataloger,\r\n\r\n[% INCLUDE 'patron-title.inc' patron => catalog_concern.reporter %] reported the following concern with [% INCLUDE 'biblio-title.inc' biblio=catalog_concern.biblio link = 1 %]\r\n\r\n\r\n\r\n[% catalog_concern.message %]\r\n\r\n\r\n\r\nYou can mark this concern as resolved from the concern management <a href='[% Koha.Preference('IntranetBaseURL') %]/cgi-bin/koha/cataloguing/concerns.pl'>page</a>.", 'email' );
>+            }
>+        );
>+
>     },
> }
>diff --git a/installer/data/mysql/en/mandatory/sample_notices.yml b/installer/data/mysql/en/mandatory/sample_notices.yml
>index 759dc12920..6b1f3a0ed3 100644
>--- a/installer/data/mysql/en/mandatory/sample_notices.yml
>+++ b/installer/data/mysql/en/mandatory/sample_notices.yml
>@@ -43,6 +43,22 @@ tables:
>             - ""
>             - "Your library."
> 
>+        - module: catalog
>+          code: CONCERN_NOTIFY
>+          branchcode: ""
>+          name: "Concern notification"
>+          is_html: 1
>+          title: "Catalog concern reported"
>+          message_transport_type: email
>+          lang: default
>+          content:
>+            - "Dear cataloger,"
>+            - "[% INCLUDE 'patron-title.inc' patron => catalog_concern.reporter %] reported the following concern with [% INCLUDE 'biblio-title.inc' biblio=catalog_concern.biblio link = 1 %]"
>+            - ""
>+            - "[% catalog_concern.message %]"
>+            - ""
>+            - "You can mark this concern as resolved from the concern management <a href='[% Koha.Preference('IntranetBaseURL') %]/cgi-bin/koha/cataloguing/concerns.pl'>page</a>."
>+
>         - module: circulation
>           code: ACCOUNT_CREDIT
>           branchcode: ""
>diff --git a/installer/data/mysql/mandatory/sysprefs.sql b/installer/data/mysql/mandatory/sysprefs.sql
>index c221bd0a57..e87159e8cf 100644
>--- a/installer/data/mysql/mandatory/sysprefs.sql
>+++ b/installer/data/mysql/mandatory/sysprefs.sql
>@@ -129,6 +129,7 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, `
> ('casServerUrl','https://localhost:8443/cas','','URL of the cas server','Free'),
> ('casServerVersion','2', '2|3','Version of the CAS server Koha will connect to.','Choice'),
> ('CatalogConcerns', '0', NULL, 'Allow users to report catalog concerns', 'YesNo'),
>+('CatalogerEmails', '', '', 'Notify these catalogers by email when a catalog concern is submitted', 'free'),
> ('CatalogModuleRelink','0',NULL,'If OFF the linker will never replace the authids that are set in the cataloging module.','YesNo'),
> ('CataloguingLog','1',NULL,'If ON, log edit/create/delete actions on bibliographic data. WARNING: this feature is very resource consuming.','YesNo'),
> ('ChargeFinesOnClosedDays','0',NULL,'Charge fines on days the library is closed.','YesNo'),
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/cataloguing.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/cataloguing.pref
>index 785781b4a9..8b54d5094e 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/cataloguing.pref
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/cataloguing.pref
>@@ -50,6 +50,12 @@ Cataloging:
>                   1: Allow
>             - "staff to report concerns about catalog records."
>             - '<strong>Note:</strong> You can also enable `OpacCatalogConcerns` to allow OPAC users the same option.'
>+        -
>+            - "Use "
>+            - pref: CatalogerEmails
>+              default: ''
>+              class: email
>+            - " as the notification address for catalog concerns."
> 
>     Spine labels:
>         -
>-- 
>2.20.1

Actions: View | Diff | Splinter Review

Attachments on bug 31028: 137412 | 139222 | 139223 | 139224 | 139225 | 139226 | 139227 | 139228 | 139229 | 139230 | 139231 | 139232 | 139233 | 139234 | 139235 | 139236 | 139237 | 139238 | 139572 | 139573 | 139574 | 139575 | 139576 | 139577 | 139578 | 139579 | 139580 | 139581 | 139582 | 139583 | 139584 | 139585 | 139586 | 139587 | 139588 | 139589 | 139590 | 139591 | 140289 | 140290 | 140291 | 140292 | 140293 | 140294 | 140295 | 140296 | 140297 | 140298 | 140299 | 140300 | 140301 | 140302 | 140303 | 140304 | 140305 | 140306 | 140307 | 140308 | 140436 | 140437 | 140438 | 140439 | 140440 | 140441 | 140442 | 140443 | 140444 | 140445 | 140446 | 140447 | 140448 | 140449 | 140450 | 140451 | 140452 | 140453 | 140454 | 140455 | 140764 | 140765 | 140766 | 140767 | 140768 | 140769 | 140770 | 140771 | 140772 | 140773 | 140774 | 140775 | 140776 | 140777 | 140778 | 140779 | 140780 | 140781 | 140782 | 140783 | 140793 | 140929 | 140930 | 140931 | 140932 | 140933 | 140934 | 140935 | 140936 | 140937 | 140938 | 140939 | 140940 | 140941 | 140942 | 140943 | 140944 | 140945 | 140946 | 140947 | 140948 | 140949 | 140950 | 141133 | 141134 | 141135 | 141136 | 141137 | 141138 | 141139 | 141140 | 141141 | 141142 | 141143 | 141144 | 141145 | 141146 | 141147 | 141148 | 141149 | 141150 | 141151 | 141152 | 141153 | 141154 | 141440 | 141441 | 141442 | 141443 | 141444 | 141445 | 141446 | 141447 | 141448 | 141449 | 141450 | 141451 | 141452 | 141453 | 141454 | 141455 | 141456 | 141457 | 141458 | 141459 | 141460 | 142164 | 142165 | 142166 | 142167 | 142168 | 142169 | 142170 | 142171 | 142172 | 142173 | 142174 | 142175 | 142177 | 142179 | 142180 | 142181 | 142182 | 142183 | 142184 | 142185 | 142186 | 142187 | 142188 | 142189 | 142190 | 142191 | 142616 | 142617 | 142618 | 142619 | 142620 | 142621 | 142622 | 142623 | 142624 | 142625 | 142626 | 142627 | 142932 | 142933 | 142934 | 142935 | 142936 | 142937 | 142938 | 142939 | 142940 | 142941 | 142942 | 142943 | 142944 | 142945 | 142946 | 142947 | 142948 | 142949 | 143238 | 143239 | 143240 | 143241 | 143242 | 143243 | 143244 | 143245 | 143246 | 143247 | 143248 | 143249 | 143250 | 143251 | 143252 | 143253 | 143254 | 143255 | 143256 | 143257 | 143302 | 143303 | 143304 | 143305 | 143306 | 143307 | 143308 | 143309 | 143310 | 143311 | 143312 | 143313 | 143314 | 143315 | 143316 | 143317 | 143318 | 143319 | 143320 | 143321 | 143322 | 143323 | 143324 | 143325 | 143326 | 143327 | 143328 | 143329 | 143330 | 143331 | 143332 | 143333 | 143334 | 143335 | 143336 | 143337 | 143338 | 143339 | 143340 | 143341 | 143470 | 143471 | 143472 | 143473 | 143474 | 143475 | 143476 | 143477 | 143478 | 143479 | 143480 | 143481 | 143482 | 143483 | 143484 | 143485 | 143486 | 143487 | 143488 | 143489 | 143490 | 143647 | 143648 | 143649 | 143650 | 143651 | 143652 | 143653 | 143654 | 143655 | 143656 | 143657 | 143658 | 143659 | 143660 | 143661 | 143662 | 143663 | 143664 | 143665 | 143666 | 143667 | 143708 | 143709 | 143710 | 143711 | 143712 | 143713 | 143714 | 143715 | 143716 | 143717 | 143718 | 143719 | 143720 | 143721 | 143722 | 143723 | 143724 | 143725 | 143726 | 143727 | 144647 | 144648 | 144649 | 144650 | 144651 | 144652 | 144653 | 144654 | 144655 | 144656 | 144657 | 144658 | 144659 | 144660 | 144661 | 144662 | 144663 | 144664 | 144665 | 144666 | 144667 | 144668 | 145542 | 146214 | 146215 | 146216 | 146217 | 146218 | 146219 | 146220 | 146221 | 146222 | 146223 | 146224 | 146225 | 146226 | 146227 | 146228 | 146229 | 146230 | 146231 | 146232 | 146233 | 146234 | 146235 | 146236 | 146237 | 146238 | 146239 | 146240 | 146241 | 146242 | 146243 | 146244 | 146245 | 146246 | 146247 | 146248 | 146249 | 146250 | 146251 | 146252 | 146253 | 146254 | 146255 | 146256 | 146257 | 146258 | 146259 | 146260 | 146261 | 146262 | 146697 | 146870 | 146871 | 146872 | 146873 | 146874 | 146875 | 146876 | 146877 | 146878 | 146879 | 146880 | 146881 | 146882 | 146883 | 146884 | 146885 | 146886 | 146887 | 146888 | 146889 | 146890 | 146891 | 146892 | 146893 | 146894 | 146895 | 146896 | 147797 | 147840 | 147841 | 147844 | 147859 | 147860 | 147861 | 147866 | 148673 | 149931