Bugzilla – Attachment 156446 Details for
Bug 12133
Guarantor requirements when registering a patron
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Bug 12133: Add requirements for guarantor and guarantee
Bug-12133-Add-requirements-for-guarantor-and-guara.patch (text/plain), 15.99 KB, created by
David Nind
on 2023-10-01 17:26:19 UTC
(
hide
)
Description:
Bug 12133: Add requirements for guarantor and guarantee
Filename:
MIME Type:
Creator:
David Nind
Created:
2023-10-01 17:26:19 UTC
Size:
15.99 KB
patch
obsolete
>From a13d1c58457ff7fc88a8eb3a9479adfa880a5d0b Mon Sep 17 00:00:00 2001 >From: Emmi Takkinen <emmi.takkinen@koha-suomi.fi> >Date: Fri, 17 Feb 2023 13:15:17 +0200 >Subject: [PATCH] Bug 12133: Add requirements for guarantor and guarantee > >Add two requirements when registering a new patron: > >- A child patron must have a guarantor. This is controlled by > a new syspref ChildNeedsGuarantor. >- A guarantor cannot be a guarantee. > >Test plan: >1. Add a child patron without guarantor or child patron with guarantee >as guarantor succesfully. >2. Apply this patch. >3. Add a child patron as a guarantor. >=> Error is raised. >4. Turn syspref "ChildNeedsGuarantor" ON. >5. Add a child patron without a guarantor and error "Child needs a >guarantor" is raised. >6. Add guarantor. Guarantor can either be existing patron or added with >"Contact" section. >=> Save without errors. > >Also prove t/db_dependent/Koha/Patron.t > >Sponsored-by: Koha-Suomi Oy >Signed-off-by: David Nind <david@davidnind.com> >--- > Koha/Exceptions/Patron/Relationship.pm | 11 ++- > Koha/Patron.pm | 38 +++++++- > .../data/mysql/atomicupdate/bug_12133.pl | 17 ++++ > installer/data/mysql/mandatory/sysprefs.sql | 1 + > .../en/modules/admin/preferences/patrons.pref | 7 ++ > .../prog/en/modules/members/memberentrygen.tt | 9 ++ > members/memberentry.pl | 48 ++++++++-- > t/db_dependent/Koha/Patron.t | 88 +++++++++++++++++++ > 8 files changed, 210 insertions(+), 9 deletions(-) > create mode 100755 installer/data/mysql/atomicupdate/bug_12133.pl > >diff --git a/Koha/Exceptions/Patron/Relationship.pm b/Koha/Exceptions/Patron/Relationship.pm >index 616ad830c7..6a0cc5dd76 100644 >--- a/Koha/Exceptions/Patron/Relationship.pm >+++ b/Koha/Exceptions/Patron/Relationship.pm >@@ -32,8 +32,12 @@ use Exception::Class ( > 'Koha::Exceptions::Patron::Relationship::InvalidRelationship' => { > isa => 'Koha::Exceptions::Patron::Relationship', > description => 'The specified relationship is invalid', >- fields => ['relationship','no_relationship'] >- } >+ fields => [ 'relationship', 'no_relationship', 'invalid_guarantor' ] >+ }, >+ 'Koha::Exceptions::Patron::Relationship::NoGuarantor' => { >+ isa => 'Koha::Exceptions::Patron::Relationship', >+ description => 'Child patron needs a guarantor', >+ }, > ); > > sub full_message { >@@ -46,6 +50,9 @@ sub full_message { > if ( $self->no_relationship ) { > $msg = sprintf( "No relationship passed." ); > } >+ elsif ( $self->invalid_guarantor ) { >+ $msg = sprintf("Child patron cannot be a guarantor."); >+ } > else { > $msg = sprintf("Invalid relationship passed, '%s' is not defined.", $self->relationship ); > } >diff --git a/Koha/Patron.pm b/Koha/Patron.pm >index 18e9d234e0..a4cdcfaa9f 100644 >--- a/Koha/Patron.pm >+++ b/Koha/Patron.pm >@@ -186,7 +186,10 @@ to db > =cut > > sub store { >- my ($self) = @_; >+ my $self = shift; >+ my $params = @_ ? shift : {}; >+ >+ my $guarantors = $params->{guarantors} // []; > > $self->_result->result_source->schema->txn_do( > sub { >@@ -283,6 +286,21 @@ sub store { > > $self->borrowernumber(undef); > >+ if ( C4::Context->preference('ChildNeedsGuarantor') >+ and ( $self->is_child or $self->category->can_be_guarantee ) >+ and $self->contactname eq "" >+ and !@$guarantors ) >+ { >+ Koha::Exceptions::Patron::Relationship::NoGuarantor->throw(); >+ } >+ >+ foreach my $guarantor (@$guarantors) { >+ if ( $guarantor->is_child or $guarantor->category->can_be_guarantee) { >+ Koha::Exceptions::Patron::Relationship::InvalidRelationship >+ ->throw( invalid_guarantor => 1 ); >+ } >+ } >+ > $self = $self->SUPER::store; > > $self->add_enrolment_fee_if_needed(0); >@@ -328,6 +346,24 @@ sub store { > > } > >+ my @existing_guarantors = $self->guarantor_relationships()->guarantors->as_list; >+ push @$guarantors, @existing_guarantors; >+ >+ if ( C4::Context->preference('ChildNeedsGuarantor') >+ and ( $self->is_child or $self->category->can_be_guarantee ) >+ and $self->contactname eq "" >+ and !@$guarantors ) >+ { >+ Koha::Exceptions::Patron::Relationship::NoGuarantor->throw(); >+ } >+ >+ foreach my $guarantor (@$guarantors) { >+ if ( $guarantor->is_child or $guarantor->category->can_be_guarantee) { >+ Koha::Exceptions::Patron::Relationship::InvalidRelationship >+ ->throw( invalid_guarantor => 1 ); >+ } >+ } >+ > # Actionlogs > if ( C4::Context->preference("BorrowersLog") ) { > my $info; >diff --git a/installer/data/mysql/atomicupdate/bug_12133.pl b/installer/data/mysql/atomicupdate/bug_12133.pl >new file mode 100755 >index 0000000000..e426f787eb >--- /dev/null >+++ b/installer/data/mysql/atomicupdate/bug_12133.pl >@@ -0,0 +1,17 @@ >+use Modern::Perl; >+ >+return { >+ bug_number => "12133", >+ description => "Add system preference ChildNeedsGuarantor", >+ up => sub { >+ my ($args) = @_; >+ my ($dbh, $out) = @$args{qw(dbh out)}; >+ >+ $dbh->do( q{ >+ INSERT IGNORE INTO systempreferences (variable,value,explanation,options,type) >+ VALUES('ChildNeedsGuarantor', 0, 'If ON, a child patron must have a guarantor when adding the patron.', '', 'YesNo'); >+ } ); >+ >+ say $out "Added new system preference 'ChildNeedsGuarantor')\n"; >+ }, >+}; >diff --git a/installer/data/mysql/mandatory/sysprefs.sql b/installer/data/mysql/mandatory/sysprefs.sql >index 78f02829c0..dc3b621fcc 100644 >--- a/installer/data/mysql/mandatory/sysprefs.sql >+++ b/installer/data/mysql/mandatory/sysprefs.sql >@@ -138,6 +138,7 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, ` > ('ChargeFinesOnClosedDays','0',NULL,'Charge fines on days the library is closed.','YesNo'), > ('CheckPrevCheckout','hardno','hardyes|softyes|softno|hardno','By default, for every item checked out, should we warn if the patron has borrowed that item in the past?','Choice'), > ('CheckPrevCheckoutDelay','0', NULL,'Maximum number of days that will trigger a warning if the patron has borrowed that item in the past when CheckPrevCheckout is enabled.','free'), >+('ChildNeedsGuarantor', 0, 'If ON, a child patron must have a guarantor when adding the patron.', '', 'YesNo'), > ('CircAutoPrintQuickSlip','qslip',NULL,'Choose what should happen when an empty barcode field is submitted in circulation: Display a print quick slip window, Display a print slip window or Clear the screen.','Choice'), > ('CircConfirmItemParts', '0', NULL, 'Require staff to confirm that all parts of an item are present at checkin/checkout.', 'Yes/No'), > ('CircControl','ItemHomeLibrary','PickupLibrary|PatronLibrary|ItemHomeLibrary','Specify the agency that controls the circulation and fines policy','Choice'), >diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref >index 3fa642ea5e..a6ef182fe8 100644 >--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref >+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref >@@ -365,6 +365,13 @@ Patrons: > 1: Allow > 0: "Don't allow" > - staff to set the ability for a patron's charges to be viewed by linked patrons in the OPAC. >+ - >+ - "A child patron" >+ - pref: "ChildNeedsGuarantor" >+ choices: >+ 1: "must have" >+ 0: "doesn't need" >+ - a guarantor when adding the patron. > > Privacy: > - >diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/members/memberentrygen.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/members/memberentrygen.tt >index e97a15fdc6..98dd40a3ce 100644 >--- a/koha-tmpl/intranet-tmpl/prog/en/modules/members/memberentrygen.tt >+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/members/memberentrygen.tt >@@ -183,6 +183,15 @@ legend:hover { > [% IF ERROR_bad_email_alternative %] > <li id="ERROR_bad_email_alternative">The alternative email is invalid.</li> > [% END %] >+ [% IF ( ERROR_child_no_guarantor ) %] >+ <li id="ERROR_child_no_guarantor">A child patron needs a guarantor.</li> >+ [% END %] >+ [% IF ( ERROR_guarantor_is_guarantee ) %] >+ <li id="ERROR_guarantor_is_guarantee">A guarantor cannot be a guarantee.</li> >+ [% END %] >+ [% IF ( ERROR_cannot_delete_guarantor ) %] >+ <li id="ERROR_cannot_delete_guarantor">Cannot delete guarantor(s). A child patron needs a guarantor.</li> >+ [% END %] > </ul> > </div> > [% END %] >diff --git a/members/memberentry.pl b/members/memberentry.pl >index 89e32ff181..21252828ed 100755 >--- a/members/memberentry.pl >+++ b/members/memberentry.pl >@@ -111,12 +111,18 @@ my $guarantor = undef; > $guarantor = Koha::Patrons->find( $guarantor_id ) if $guarantor_id; > $template->param( guarantor => $guarantor ); > >-my @delete_guarantor = $input->multi_param('delete_guarantor'); >-foreach my $id ( @delete_guarantor ) { >- my $r = Koha::Patron::Relationships->find( $id ); >- $r->delete() if $r; >+#Search existing guarantor id(s) and new ones from params >+my @guarantors; >+my @new_guarantor_ids = grep { $_ ne '' } $input->multi_param('new_guarantor_id'); >+ >+foreach my $new_guarantor_id (@new_guarantor_ids) { >+ my $new_guarantor = Koha::Patrons->find( { borrowernumber => $new_guarantor_id } ); >+ push @guarantors, $new_guarantor; > } > >+my @existing_guarantors = $patron->guarantor_relationships()->guarantors->as_list unless !$patron; >+push @guarantors, @existing_guarantors; >+ > ## Deal with debarments > $template->param( > restriction_types => scalar Koha::Patron::Restriction::Types->search() >@@ -266,6 +272,36 @@ if ( ( $op eq 'insert' ) and !$nodouble ) { > } > } > >+#Attempt to delete guarantors >+my @delete_guarantor = $input->multi_param('delete_guarantor'); >+if(@delete_guarantor){ >+ if ( C4::Context->preference('ChildNeedsGuarantor') >+ && scalar @guarantors - scalar @delete_guarantor == 0 ) { >+ push @errors, 'ERROR_cannot_delete_guarantor'; >+ } else { >+ foreach my $id ( @delete_guarantor ) { >+ my $r = Koha::Patron::Relationships->find( $id ); >+ $r->delete() if $r; >+ } >+ } >+} >+ >+#Check if guarantor requirements are met >+my $valid_guarantor = @guarantors ? @guarantors : $newdata{'contactname'}; >+if ( ( $op eq 'save' || $op eq 'insert' ) >+ && C4::Context->preference('ChildNeedsGuarantor') >+ && ( $category->category_type eq 'C' || $category->can_be_guarantee ) >+ && !$valid_guarantor ) >+{ >+ push @errors, 'ERROR_child_no_guarantor'; >+} >+ >+foreach my $guarantor (@guarantors) { >+ if ( ( $op eq 'save' || $op eq 'insert' ) && $guarantor->is_child || $guarantor->category->can_be_guarantee ) { >+ push @errors, 'ERROR_guarantor_is_guarantee'; >+ } >+} >+ > ###############test to take the right zipcode, country and city name ############## > # set only if parameter was passed from the form > $newdata{'city'} = $input->param('city') if defined($input->param('city')); >@@ -404,7 +440,7 @@ if ((!$nok) and $nodouble and ($op eq 'insert' or $op eq 'save')){ > delete $newdata{password2}; > $success = 1; > $patron = try { >- Koha::Patron->new(\%newdata)->store; >+ Koha::Patron->new(\%newdata)->store({ guarantors => \@guarantors }); > } catch { > $success = 0; > $nok = 1; >@@ -498,7 +534,7 @@ if ((!$nok) and $nodouble and ($op eq 'insert' or $op eq 'save')){ > delete $newdata{password2}; > > try { >- $patron->set(\%newdata)->store if scalar(keys %newdata) > 1; >+ $patron->set(\%newdata)->store({ guarantors => \@guarantors }) if scalar(keys %newdata) > 1; > # bug 4508 - avoid crash if we're not updating any columns in the borrowers table (editing patron attrs or msg prefs) > $success = 1; > } catch { >diff --git a/t/db_dependent/Koha/Patron.t b/t/db_dependent/Koha/Patron.t >index 85a6ae6198..809a0d2c41 100755 >--- a/t/db_dependent/Koha/Patron.t >+++ b/t/db_dependent/Koha/Patron.t >@@ -1549,3 +1549,91 @@ subtest 'update privacy tests' => sub { > is( $old_checkout->borrowernumber, $anon_patron->id, "Checkout is successfully anonymized"); > is( $patron->privacy(), 2, "Patron privacy is successfully updated"); > }; >+ >+subtest 'guarantor requirements tests' => sub { >+ >+ plan tests => 6; >+ >+ $schema->storage->txn_begin; >+ >+ my $branchcode = $builder->build( { source => 'Branch' } )->{branchcode}; >+ my $child_category = $builder->build( >+ { source => 'Category', value => { category_type => 'C', can_be_guarantee => 1 } } ) >+ ->{categorycode}; >+ my $patron_category = $builder->build( >+ { source => 'Category', value => { category_type => 'A', can_be_guarantee => 0 } } ) >+ ->{categorycode}; >+ >+ t::lib::Mocks::mock_preference( 'ChildNeedsGuarantor', 0 ); >+ >+ my $child = Koha::Patron->new( >+ { >+ branchcode => $branchcode, >+ categorycode => $child_category, >+ contactname => '' >+ } >+ ); >+ $child->store(); >+ >+ ok( >+ Koha::Patrons->find( $child->id ), >+ 'Child patron can be stored without guarantor when ChildNeedsGuarantor is off.' >+ ); >+ >+ t::lib::Mocks::mock_preference( 'ChildNeedsGuarantor', 1 ); >+ >+ my $child2 = Koha::Patron->new( >+ { >+ branchcode => $branchcode, >+ categorycode => $child_category, >+ contactname => '' >+ } >+ ); >+ my $child3 = $builder->build_object( >+ { >+ class => 'Koha::Patrons', >+ value => { categorycode => $child_category } >+ } >+ ); >+ my $patron = $builder->build_object( >+ { >+ class => 'Koha::Patrons', >+ value => { categorycode => $patron_category } >+ } >+ ); >+ >+ throws_ok { $child2->store(); } >+ 'Koha::Exceptions::Patron::Relationship::NoGuarantor', >+ 'Exception thrown when guarantor is required but not provided.'; >+ >+ my @guarantors = ( $patron, $child3 ); >+ throws_ok { $child2->store( { guarantors => \@guarantors } ); } >+ 'Koha::Exceptions::Patron::Relationship::InvalidRelationship', >+ 'Exception thrown when child patron is added as guarantor.'; >+ >+ #test ModMember >+ @guarantors = ( $patron ); >+ $child2->store( { guarantors => \@guarantors } )->discard_changes(); >+ >+ t::lib::Mocks::mock_preference( 'borrowerRelationship', '' ); >+ >+ my $relationship = Koha::Patron::Relationship->new( >+ { guarantor_id => $patron->borrowernumber, >+ guarantee_id => $child2->borrowernumber, >+ relationship => '' >+ } >+ ); >+ $relationship->store(); >+ >+ ok( $child2->store(), 'Child patron can be modified and stored when guarantor is stored'); >+ >+ @guarantors = ( $child3 ); >+ throws_ok { $child2->store( { guarantors => \@guarantors } ); } >+ 'Koha::Exceptions::Patron::Relationship::InvalidRelationship', >+ 'Exception thrown when child patron is modified and child patron is added as guarantor.'; >+ >+ $relationship->delete; >+ throws_ok { $child2->store(); } >+ 'Koha::Exceptions::Patron::Relationship::NoGuarantor', >+ 'Exception thrown when guarantor is deleted.'; >+}; >-- >2.30.2
<b>You cannot view the attachment while viewing its details because your browser does not support IFRAMEs. <a href="attachment.cgi?id=156446">View the attachment on a separate page</a>.</b>
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
|
Splinter Review
Attachments on
bug 12133
:
27517
|
27584
|
33459
|
91482
|
94371
|
94538
|
94544
|
99629
|
113099
|
113100
|
134013
|
134014
|
134015
|
146827
|
147440
|
148058
|
148070
|
152706
|
153082
|
153154
|
154300
|
154316
|
156387
| 156446 |
156447
|
158344
|
158345
|
158346
|
158919
|
158979