3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use Test::More tests => 50;
24 use Data::Dumper qw/Dumper/;
28 use Koha::List::Patron;
30 use Koha::Patron::Relationship;
33 use t::lib::TestBuilder;
36 use_ok('C4::Members');
39 my $schema = Koha::Database->schema;
40 $schema->storage->txn_begin;
41 my $builder = t::lib::TestBuilder->new;
42 my $dbh = C4::Context->dbh;
44 my $library1 = $builder->build({
47 my $library2 = $builder->build({
50 my $patron_category = $builder->build({ source => 'Category' });
51 my $CARDNUMBER = 'TESTCARD01';
52 my $FIRSTNAME = 'Marie';
53 my $SURNAME = 'Mcknight';
54 my $BRANCHCODE = $library1->{branchcode};
56 my $CHANGED_FIRSTNAME = "Marry Ann";
57 my $EMAIL = "Marie\@email.com";
58 my $EMAILPRO = "Marie\@work.com";
59 my $PHONE = "555-12123";
61 # XXX should be randomised and checked against the database
62 my $IMPOSSIBLE_CARDNUMBER = "XYZZZ999";
64 t::lib::Mocks::mock_userenv();
66 # Make a borrower for testing
68 cardnumber => $CARDNUMBER,
69 firstname => $FIRSTNAME . q{ },
71 categorycode => $patron_category->{categorycode},
72 branchcode => $BRANCHCODE,
74 dateexpiry => '9999-12-31',
78 my $addmem=Koha::Patron->new(\%data)->store->borrowernumber;
79 ok($addmem, "Koha::Patron->store()");
81 my $patron = Koha::Patrons->find( { cardnumber => $CARDNUMBER } )
82 or BAIL_OUT("Cannot read member with card $CARDNUMBER");
83 my $member = $patron->unblessed;
85 ok ( $member->{firstname} eq $FIRSTNAME &&
86 $member->{surname} eq $SURNAME &&
87 $member->{categorycode} eq $patron_category->{categorycode} &&
88 $member->{branchcode} eq $BRANCHCODE
90 or diag("Mismatching member details: ".Dumper(\%data, $member));
92 is($member->{dateofbirth}, undef, "Empty dates handled correctly");
94 $member->{firstname} = $CHANGED_FIRSTNAME . q{ };
95 $member->{email} = $EMAIL;
96 $member->{phone} = $PHONE;
97 $member->{emailpro} = $EMAILPRO;
98 $patron->set($member)->store;
99 my $changedmember = Koha::Patrons->find( { cardnumber => $CARDNUMBER } )->unblessed;
100 ok ( $changedmember->{firstname} eq $CHANGED_FIRSTNAME &&
101 $changedmember->{email} eq $EMAIL &&
102 $changedmember->{phone} eq $PHONE &&
103 $changedmember->{emailpro} eq $EMAILPRO
105 or diag("Mismatching member details: ".Dumper($member, $changedmember));
107 t::lib::Mocks::mock_preference( 'CardnumberLength', '' );
108 C4::Context->clear_syspref_cache();
110 my $checkcardnum=C4::Members::checkcardnumber($CARDNUMBER, "");
111 is ($checkcardnum, "1", "Card No. in use");
113 $checkcardnum=C4::Members::checkcardnumber($IMPOSSIBLE_CARDNUMBER, "");
114 is ($checkcardnum, "0", "Card No. not used");
116 t::lib::Mocks::mock_preference( 'CardnumberLength', '4' );
117 C4::Context->clear_syspref_cache();
119 $checkcardnum=C4::Members::checkcardnumber($IMPOSSIBLE_CARDNUMBER, "");
120 is ($checkcardnum, "2", "Card number is too long");
125 cardnumber => "123456789",
126 firstname => "Tomasito",
128 categorycode => $patron_category->{categorycode},
129 branchcode => $library2->{branchcode},
135 my $borrowernumber = Koha::Patron->new( \%data )->store->borrowernumber;
136 $patron = Koha::Patrons->find( $borrowernumber );
137 my $borrower = $patron->unblessed;
138 is( $borrower->{dateofbirth}, undef, 'Koha::Patron->store should undef dateofbirth if empty string is given');
139 is( $borrower->{debarred}, undef, 'Koha::Patron->store should undef debarred if empty string is given');
140 isnt( $borrower->{dateexpiry}, '0000-00-00', 'Koha::Patron->store should not set dateexpiry to 0000-00-00 if empty string is given');
141 isnt( $borrower->{dateenrolled}, '0000-00-00', 'Koha::Patron->store should not set dateenrolled to 0000-00-00 if empty string is given');
143 $patron->set({ dateofbirth => '', debarred => '', dateexpiry => '', dateenrolled => '' })->store;
144 $borrower = Koha::Patrons->find( $borrowernumber )->unblessed;
145 is( $borrower->{dateofbirth}, undef, 'Koha::Patron->store should undef dateofbirth if empty string is given');
146 is( $borrower->{debarred}, undef, 'Koha::Patron->store should undef debarred if empty string is given');
147 isnt( $borrower->{dateexpiry}, '0000-00-00', 'Koha::Patron->store should not set dateexpiry to 0000-00-00 if empty string is given');
148 isnt( $borrower->{dateenrolled}, '0000-00-00', 'Koha::Patron->store should not set dateenrolled to 0000-00-00 if empty string is given');
150 $patron->set({ dateofbirth => '1970-01-01', debarred => '2042-01-01', dateexpiry => '9999-12-31', dateenrolled => '2015-09-06' })->store;
151 $borrower = Koha::Patrons->find( $borrowernumber )->unblessed;
152 is( $borrower->{dateofbirth}, '1970-01-01', 'Koha::Patron->store should correctly set dateofbirth if a valid date is given');
153 is( $borrower->{debarred}, '2042-01-01', 'Koha::Patron->store should correctly set debarred if a valid date is given');
154 is( $borrower->{dateexpiry}, '9999-12-31', 'Koha::Patron->store should correctly set dateexpiry if a valid date is given');
155 is( $borrower->{dateenrolled}, '2015-09-06', 'Koha::Patron->store should correctly set dateenrolled if a valid date is given');
157 subtest 'Koha::Patron->store should not update userid if not true' => sub {
160 # TODO Move this to t/db_dependent/Koha/Patrons.t subtest ->store
162 $data{ cardnumber } = "234567890";
163 $data{userid} = 'a_user_id';
164 $borrowernumber = Koha::Patron->new( \%data )->store->borrowernumber;
165 my $patron = Koha::Patrons->find( $borrowernumber );
166 my $borrower = $patron->unblessed;
168 $patron->set( { firstname => 'Tomas', userid => '' } )->store;
169 $borrower = Koha::Patrons->find( $borrowernumber )->unblessed;
170 is ( $borrower->{userid}, $data{userid}, 'Koha::Patron->store should not update the userid with an empty string' );
171 $patron->set( { firstname => 'Tomas', userid => 0 } )->store;
172 $borrower = Koha::Patrons->find( $borrowernumber )->unblessed;
173 is ( $borrower->{userid}, $data{userid}, 'Koha::Patron->store should not update the userid with an 0');
174 $patron->set( { firstname => 'Tomas', userid => undef } )->store;
175 $borrower = Koha::Patrons->find( $borrowernumber )->unblessed;
176 is ( $borrower->{userid}, $data{userid}, 'Koha::Patron->store should not update the userid with an undefined value');
179 #Regression tests for bug 10612
180 my $library3 = $builder->build({
184 source => 'Category',
186 categorycode => 'STAFFER',
187 description => 'Staff dont batch del',
188 category_type => 'S',
193 source => 'Category',
195 categorycode => 'CIVILIAN',
196 description => 'Civilian batch del',
197 category_type => 'A',
202 source => 'Category',
204 categorycode => 'KIDclamp',
205 description => 'Kid to be guaranteed',
206 category_type => 'C',
210 my $borrower1 = $builder->build({
211 source => 'Borrower',
213 categorycode=>'STAFFER',
214 branchcode => $library3->{branchcode},
215 dateexpiry => '2015-01-01',
218 my $bor1inlist = $borrower1->{borrowernumber};
219 my $borrower2 = $builder->build({
220 source => 'Borrower',
222 categorycode=>'STAFFER',
223 branchcode => $library3->{branchcode},
224 dateexpiry => '2015-01-01',
228 my $guarantee = $builder->build({
229 source => 'Borrower',
231 categorycode=>'KIDclamp',
232 branchcode => $library3->{branchcode},
233 dateexpiry => '2015-01-01',
237 my $bor2inlist = $borrower2->{borrowernumber};
240 source => 'OldIssue',
242 borrowernumber => $bor2inlist,
243 timestamp => '2016-01-01',
247 # The following calls to GetBorrowersToExpunge are assuming that the pref
248 # IndependentBranches is off.
249 t::lib::Mocks::mock_preference('IndependentBranches', 0);
251 my $anonymous_patron = Koha::Patron->new({ categorycode => 'CIVILIAN', branchcode => $library2->{branchcode} })->store->borrowernumber;
252 t::lib::Mocks::mock_preference('AnonymousPatron', $anonymous_patron);
254 my $owner = Koha::Patron->new({ categorycode => 'STAFFER', branchcode => $library2->{branchcode} })->store->borrowernumber;
255 my $list1 = AddPatronList( { name => 'Test List 1', owner => $owner } );
257 AddPatronsToList( { list => $list1, borrowernumbers => [$anonymous_patron] } );
258 my $patstodel = GetBorrowersToExpunge( { patron_list_id => $list1->patron_list_id() } );
259 is( scalar(@$patstodel), 0, 'Anonymous Patron not deleted from list' );
261 my @listpatrons = ($bor1inlist, $bor2inlist);
262 AddPatronsToList( { list => $list1, borrowernumbers => \@listpatrons });
263 $patstodel = GetBorrowersToExpunge( {patron_list_id => $list1->patron_list_id() } );
264 is( scalar(@$patstodel),0,'No staff deleted from list of all staff');
265 Koha::Patrons->find($bor2inlist)->set({ categorycode => 'CIVILIAN' })->store;
266 $patstodel = GetBorrowersToExpunge( {patron_list_id => $list1->patron_list_id()} );
267 ok( scalar(@$patstodel)== 1 && $patstodel->[0]->{'borrowernumber'} eq $bor2inlist,'Staff patron not deleted from list');
268 $patstodel = GetBorrowersToExpunge( {branchcode => $library3->{branchcode},patron_list_id => $list1->patron_list_id() } );
269 ok( scalar(@$patstodel) == 1 && $patstodel->[0]->{'borrowernumber'} eq $bor2inlist,'Staff patron not deleted by branchcode and list');
270 $patstodel = GetBorrowersToExpunge( {expired_before => '2015-01-02', patron_list_id => $list1->patron_list_id() } );
271 ok( scalar(@$patstodel) == 1 && $patstodel->[0]->{'borrowernumber'} eq $bor2inlist,'Staff patron not deleted by expirationdate and list');
272 $patstodel = GetBorrowersToExpunge( {not_borrowed_since => '2016-01-02', patron_list_id => $list1->patron_list_id() } );
273 ok( scalar(@$patstodel) == 1 && $patstodel->[0]->{'borrowernumber'} eq $bor2inlist,'Staff patron not deleted by last issue date');
275 Koha::Patrons->find($bor1inlist)->set({ categorycode => 'CIVILIAN' })->store;
277 t::lib::Mocks::mock_preference( 'borrowerRelationship', 'test' );
279 my $relationship = Koha::Patron::Relationship->new( { guarantor_id => $bor1inlist, guarantee_id => $guarantee->{borrowernumber}, relationship => 'test' } )->store();
281 $patstodel = GetBorrowersToExpunge( {patron_list_id => $list1->patron_list_id()} );
282 ok( scalar(@$patstodel)== 1 && $patstodel->[0]->{'borrowernumber'} eq $bor2inlist,'Guarantor patron not deleted from list');
283 $patstodel = GetBorrowersToExpunge( {branchcode => $library3->{branchcode},patron_list_id => $list1->patron_list_id() } );
284 ok( scalar(@$patstodel) == 1 && $patstodel->[0]->{'borrowernumber'} eq $bor2inlist,'Guarantor patron not deleted by branchcode and list');
285 $patstodel = GetBorrowersToExpunge( {expired_before => '2015-01-02', patron_list_id => $list1->patron_list_id() } );
286 ok( scalar(@$patstodel) == 1 && $patstodel->[0]->{'borrowernumber'} eq $bor2inlist,'Guarantor patron not deleted by expirationdate and list');
287 $patstodel = GetBorrowersToExpunge( {not_borrowed_since => '2016-01-02', patron_list_id => $list1->patron_list_id() } );
288 ok( scalar(@$patstodel) == 1 && $patstodel->[0]->{'borrowernumber'} eq $bor2inlist,'Guarantor patron not deleted by last issue date');
289 $relationship->delete();
294 borrowernumber => $bor2inlist,
297 $patstodel = GetBorrowersToExpunge( {patron_list_id => $list1->patron_list_id()} );
298 is( scalar(@$patstodel),1,'Borrower with issue not deleted from list');
299 $patstodel = GetBorrowersToExpunge( {branchcode => $library3->{branchcode},patron_list_id => $list1->patron_list_id() } );
300 is( scalar(@$patstodel),1,'Borrower with issue not deleted by branchcode and list');
301 $patstodel = GetBorrowersToExpunge( {category_code => 'CIVILIAN',patron_list_id => $list1->patron_list_id() } );
302 is( scalar(@$patstodel),1,'Borrower with issue not deleted by category_code and list');
303 $patstodel = GetBorrowersToExpunge( {category_code => ['CIVILIAN','STAFFER'],patron_list_id => $list1->patron_list_id() } );
304 is( scalar(@$patstodel),1,'Borrower with issue not deleted by multiple category_code and list');
305 $patstodel = GetBorrowersToExpunge( {expired_before => '2015-01-02',patron_list_id => $list1->patron_list_id() } );
306 is( scalar(@$patstodel),1,'Borrower with issue not deleted by expiration_date and list');
307 $builder->schema->resultset( 'Issue' )->delete_all;
308 $patstodel = GetBorrowersToExpunge( {patron_list_id => $list1->patron_list_id()} );
309 ok( scalar(@$patstodel)== 2,'Borrowers without issue deleted from list');
310 $patstodel = GetBorrowersToExpunge( {category_code => 'CIVILIAN',patron_list_id => $list1->patron_list_id() } );
311 is( scalar(@$patstodel),2,'Borrowers without issues deleted by category_code and list');
312 $patstodel = GetBorrowersToExpunge( {category_code => ['CIVILIAN','STAFFER'],patron_list_id => $list1->patron_list_id() } );
313 is( scalar(@$patstodel),2,'Borrowers without issues deleted by multiple category_code and list');
314 $patstodel = GetBorrowersToExpunge( {expired_before => '2015-01-02',patron_list_id => $list1->patron_list_id() } );
315 is( scalar(@$patstodel),2,'Borrowers without issues deleted by expiration_date and list');
316 $patstodel = GetBorrowersToExpunge( {not_borrowed_since => '2016-01-02', patron_list_id => $list1->patron_list_id() } );
317 is( scalar(@$patstodel),2,'Borrowers without issues deleted by last issue date');
319 # Test GetBorrowersToExpunge and TrackLastPatronActivity
320 $dbh->do(q|UPDATE borrowers SET lastseen=NULL|);
321 $builder->build({ source => 'Borrower', value => { lastseen => '2016-01-01 01:01:01', categorycode => 'CIVILIAN' } } );
322 $builder->build({ source => 'Borrower', value => { lastseen => '2016-02-02 02:02:02', categorycode => 'CIVILIAN' } } );
323 $builder->build({ source => 'Borrower', value => { lastseen => '2016-03-03 03:03:03', categorycode => 'CIVILIAN' } } );
324 $patstodel = GetBorrowersToExpunge( { last_seen => '1999-12-12' });
325 is( scalar @$patstodel, 0, 'TrackLastPatronActivity - 0 patrons must be deleted' );
326 $patstodel = GetBorrowersToExpunge( { last_seen => '2016-02-15' });
327 is( scalar @$patstodel, 2, 'TrackLastPatronActivity - 2 patrons must be deleted' );
328 $patstodel = GetBorrowersToExpunge( { last_seen => '2016-04-04' });
329 is( scalar @$patstodel, 3, 'TrackLastPatronActivity - 3 patrons must be deleted' );
330 my $patron2 = $builder->build({ source => 'Borrower', value => { lastseen => undef } });
331 t::lib::Mocks::mock_preference( 'TrackLastPatronActivity', '0' );
332 Koha::Patrons->find( $patron2->{borrowernumber} )->track_login;
333 is( Koha::Patrons->find( $patron2->{borrowernumber} )->lastseen, undef, 'Lastseen should not be changed' );
334 Koha::Patrons->find( $patron2->{borrowernumber} )->track_login({ force => 1 });
335 isnt( Koha::Patrons->find( $patron2->{borrowernumber} )->lastseen, undef, 'Lastseen should be changed now' );
337 # Regression tests for BZ13502
338 ## Remove all entries with userid='' (should be only 1 max)
339 $dbh->do(q|DELETE FROM borrowers WHERE userid = ''|);
340 ## And create a patron with a userid=''
341 $borrowernumber = Koha::Patron->new({ categorycode => $patron_category->{categorycode}, branchcode => $library2->{branchcode} })->store->borrowernumber;
342 $dbh->do(q|UPDATE borrowers SET userid = '' WHERE borrowernumber = ?|, undef, $borrowernumber);
343 # Create another patron and verify the userid has been generated
344 $borrowernumber = Koha::Patron->new({ categorycode => $patron_category->{categorycode}, branchcode => $library2->{branchcode} })->store->borrowernumber;
345 ok( $borrowernumber > 0, 'Koha::Patron->store should have inserted the patron even if no userid is given' );
346 $borrower = Koha::Patrons->find( $borrowernumber )->unblessed;
347 ok( $borrower->{userid}, 'A userid should have been generated correctly' );
349 subtest 'purgeSelfRegistration' => sub {
354 C4::Members::DeleteUnverifiedOpacRegistrations($d);
356 $dbh->do("INSERT INTO borrower_modifications (timestamp, borrowernumber, verification_token, changed_fields) VALUES ('2014-01-01 01:02:03',0,?,'firstname,surname')", undef, (scalar localtime)."_$_");
358 is( C4::Members::DeleteUnverifiedOpacRegistrations($d), 3, 'Test for DeleteUnverifiedOpacRegistrations' );
360 #purge members in temporary category
362 $dbh->do("INSERT IGNORE INTO categories (categorycode) VALUES ('$c')");
363 t::lib::Mocks::mock_preference('PatronSelfRegistrationDefaultCategory', $c );
364 t::lib::Mocks::mock_preference('PatronSelfRegistrationExpireTemporaryAccountsDelay', 360);
365 C4::Members::DeleteExpiredOpacRegistrations();
366 my $self_reg = $builder->build_object({
367 class => 'Koha::Patrons',
369 dateenrolled => '2014-01-01 01:02:03',
374 my $checkout = $builder->build_object({
375 class=>'Koha::Checkouts',
377 borrowernumber=>$self_reg->borrowernumber
380 is( C4::Members::DeleteExpiredOpacRegistrations(), 0, "DeleteExpiredOpacRegistrations doesn't delete borrower with checkout");
382 my $account_line = $builder->build_object(
384 class => 'Koha::Account::Lines',
386 borrowernumber => $self_reg->borrowernumber,
387 amountoutstanding => 5,
392 is( C4::Members::DeleteExpiredOpacRegistrations(), 0, "DeleteExpiredOpacRegistrations doesn't delete borrower with checkout and fine");
395 is( C4::Members::DeleteExpiredOpacRegistrations(), 0, "DeleteExpiredOpacRegistrations doesn't delete borrower with fine and no checkout");
397 $account_line->delete;
398 is( C4::Members::DeleteExpiredOpacRegistrations(), 1, "DeleteExpiredOpacRegistrations does delete borrower with no fines and no checkouts");
403 my ($resultset) = @_;
404 my $found = $resultset && grep( { $_->{cardnumber} && $_->{cardnumber} eq $CARDNUMBER } @$resultset );
408 $schema->storage->txn_rollback;
410 subtest 'Koha::Patron->store (invalid categorycode) tests' => sub {
412 # TODO Move this to t/db_dependent/Koha/Patrons.t subtest ->store
414 $schema->storage->txn_begin;
416 my $category = $builder->build_object({ class => 'Koha::Patron::Categories' });
417 my $category_id = $category->id;
418 # Remove category to make sure the id is not on the DB
422 categorycode => $category_id
426 { Koha::Patron->new( $patron_data )->store; }
427 'Koha::Exceptions::Object::FKConstraint',
428 'AddMember raises an exception on invalid categorycode';
430 $schema->storage->txn_rollback;