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 => 59;
27 use t::lib::TestBuilder;
30 use_ok('C4::Members');
33 my $schema = Koha::Database->schema;
34 $schema->storage->txn_begin;
35 my $builder = t::lib::TestBuilder->new;
36 my $dbh = C4::Context->dbh;
37 $dbh->{RaiseError} = 1;
39 my $library1 = $builder->build({
42 my $library2 = $builder->build({
45 my $CARDNUMBER = 'TESTCARD01';
46 my $FIRSTNAME = 'Marie';
47 my $SURNAME = 'Mcknight';
48 my $CATEGORYCODE = 'S';
49 my $BRANCHCODE = $library1->{branchcode};
51 my $CHANGED_FIRSTNAME = "Marry Ann";
52 my $EMAIL = "Marie\@email.com";
53 my $EMAILPRO = "Marie\@work.com";
54 my $PHONE = "555-12123";
56 # XXX should be randomised and checked against the database
57 my $IMPOSSIBLE_CARDNUMBER = "XYZZZ999";
59 #my ($usernum, $userid, $usercnum, $userfirstname, $usersurname, $userbranch, $branchname, $userflags, $emailaddress, $branchprinter)= @_;
72 C4::Context->_new_userenv ('DUMMY_SESSION_ID');
73 C4::Context->set_userenv ( @USERENV );
75 my $userenv = C4::Context->userenv
76 or BAIL_OUT("No userenv");
78 # Make a borrower for testing
80 cardnumber => $CARDNUMBER,
81 firstname => $FIRSTNAME,
83 categorycode => $CATEGORYCODE,
84 branchcode => $BRANCHCODE,
86 dateexpiry => '9999-12-31',
90 testAgeAccessors(\%data); #Age accessor tests don't touch the db so it is safe to run them with just the object.
92 my $addmem=AddMember(%data);
93 ok($addmem, "AddMember()");
95 # It's not really a Move, it's a Copy.
96 my $result = MoveMemberToDeleted($addmem);
97 ok($result,"MoveMemberToDeleted()");
99 my $sth = $dbh->prepare("SELECT * from borrowers WHERE borrowernumber=?");
100 $sth->execute($addmem);
101 my $MemberAdded = $sth->fetchrow_hashref;
103 $sth = $dbh->prepare("SELECT * from deletedborrowers WHERE borrowernumber=?");
104 $sth->execute($addmem);
105 my $MemberMoved = $sth->fetchrow_hashref;
107 is_deeply($MemberMoved,$MemberAdded,"Confirm MoveMemberToDeleted.");
109 my $member=GetMemberDetails("",$CARDNUMBER)
110 or BAIL_OUT("Cannot read member with card $CARDNUMBER");
112 ok ( $member->{firstname} eq $FIRSTNAME &&
113 $member->{surname} eq $SURNAME &&
114 $member->{categorycode} eq $CATEGORYCODE &&
115 $member->{branchcode} eq $BRANCHCODE
117 or diag("Mismatching member details: ".Dumper(\%data, $member));
119 is($member->{dateofbirth}, undef, "Empty dates handled correctly");
121 $member->{firstname} = $CHANGED_FIRSTNAME;
122 $member->{email} = $EMAIL;
123 $member->{phone} = $PHONE;
124 $member->{emailpro} = $EMAILPRO;
126 my $changedmember=GetMemberDetails("",$CARDNUMBER);
127 ok ( $changedmember->{firstname} eq $CHANGED_FIRSTNAME &&
128 $changedmember->{email} eq $EMAIL &&
129 $changedmember->{phone} eq $PHONE &&
130 $changedmember->{emailpro} eq $EMAILPRO
132 or diag("Mismatching member details: ".Dumper($member, $changedmember));
134 t::lib::Mocks::mock_preference( 'CardnumberLength', '' );
135 C4::Context->clear_syspref_cache();
137 my $checkcardnum=C4::Members::checkcardnumber($CARDNUMBER, "");
138 is ($checkcardnum, "1", "Card No. in use");
140 $checkcardnum=C4::Members::checkcardnumber($IMPOSSIBLE_CARDNUMBER, "");
141 is ($checkcardnum, "0", "Card No. not used");
143 t::lib::Mocks::mock_preference( 'CardnumberLength', '4' );
144 C4::Context->clear_syspref_cache();
146 $checkcardnum=C4::Members::checkcardnumber($IMPOSSIBLE_CARDNUMBER, "");
147 is ($checkcardnum, "2", "Card number is too long");
151 t::lib::Mocks::mock_preference( 'AutoEmailPrimaryAddress', 'OFF' );
152 C4::Context->clear_syspref_cache();
154 my $notice_email = GetNoticeEmailAddress($member->{'borrowernumber'});
155 is ($notice_email, $EMAIL, "GetNoticeEmailAddress returns correct value when AutoEmailPrimaryAddress is off");
157 t::lib::Mocks::mock_preference( 'AutoEmailPrimaryAddress', 'emailpro' );
158 C4::Context->clear_syspref_cache();
160 $notice_email = GetNoticeEmailAddress($member->{'borrowernumber'});
161 is ($notice_email, $EMAILPRO, "GetNoticeEmailAddress returns correct value when AutoEmailPrimaryAddress is emailpro");
163 ok(!$member->{is_expired}, "GetMemberDetails() indicates that patron is not expired");
164 ModMember(borrowernumber => $member->{'borrowernumber'}, dateexpiry => '2001-01-1');
165 $member = GetMemberDetails($member->{'borrowernumber'});
166 ok($member->{is_expired}, "GetMemberDetails() indicates that patron is expired");
169 DelMember($member->{borrowernumber});
170 my $borrower = GetMember( cardnumber => $CARDNUMBER );
171 is( $borrower, undef, 'DelMember should remove the patron' );
175 cardnumber => "123456789",
176 firstname => "Tomasito",
179 branchcode => $library2->{branchcode},
186 my $borrowernumber = AddMember( %data );
187 is( Check_Userid( 'tomasito.non', $borrowernumber ), 1,
188 'recently created userid -> unique (borrowernumber passed)' );
189 is( Check_Userid( 'tomasitoxxx', $borrowernumber ), 1,
190 'non-existent userid -> unique (borrowernumber passed)' );
191 is( Check_Userid( 'tomasito.none', '' ), 0,
192 'userid exists (blank borrowernumber)' );
193 is( Check_Userid( 'tomasitoxxx', '' ), 1,
194 'non-existent userid -> unique (blank borrowernumber)' );
196 $borrower = GetMember( borrowernumber => $borrowernumber );
197 is( $borrower->{dateofbirth}, undef, 'AddMember should undef dateofbirth if empty string is given');
198 is( $borrower->{debarred}, undef, 'AddMember should undef debarred if empty string is given');
199 isnt( $borrower->{dateexpiry}, '0000-00-00', 'AddMember should not set dateexpiry to 0000-00-00 if empty string is given');
200 isnt( $borrower->{dateenrolled}, '0000-00-00', 'AddMember should not set dateenrolled to 0000-00-00 if empty string is given');
202 ModMember( borrowernumber => $borrowernumber, dateofbirth => '', debarred => '', dateexpiry => '', dateenrolled => '' );
203 $borrower = GetMember( borrowernumber => $borrowernumber );
204 is( $borrower->{dateofbirth}, undef, 'ModMember should undef dateofbirth if empty string is given');
205 is( $borrower->{debarred}, undef, 'ModMember should undef debarred if empty string is given');
206 isnt( $borrower->{dateexpiry}, '0000-00-00', 'ModMember should not set dateexpiry to 0000-00-00 if empty string is given');
207 isnt( $borrower->{dateenrolled}, '0000-00-00', 'ModMember should not set dateenrolled to 0000-00-00 if empty string is given');
209 ModMember( borrowernumber => $borrowernumber, dateofbirth => '1970-01-01', debarred => '2042-01-01', dateexpiry => '9999-12-31', dateenrolled => '2015-09-06' );
210 $borrower = GetMember( borrowernumber => $borrowernumber );
211 is( $borrower->{dateofbirth}, '1970-01-01', 'ModMember should correctly set dateofbirth if a valid date is given');
212 is( $borrower->{debarred}, '2042-01-01', 'ModMember should correctly set debarred if a valid date is given');
213 is( $borrower->{dateexpiry}, '9999-12-31', 'ModMember should correctly set dateexpiry if a valid date is given');
214 is( $borrower->{dateenrolled}, '2015-09-06', 'ModMember should correctly set dateenrolled if a valid date is given');
216 # Add a new borrower with the same userid but different cardnumber
217 $data{ cardnumber } = "987654321";
218 my $new_borrowernumber = AddMember( %data );
219 is( Check_Userid( 'tomasito.none', '' ), 0,
220 'userid not unique (blank borrowernumber)' );
221 is( Check_Userid( 'tomasito.none', $new_borrowernumber ), 0,
222 'userid not unique (second borrowernumber passed)' );
223 $borrower = GetMember( borrowernumber => $new_borrowernumber );
224 ok( $borrower->{userid} ne 'tomasito', "Borrower with duplicate userid has new userid generated" );
226 $data{ cardnumber } = "234567890";
227 $data{userid} = 'a_user_id';
228 $borrowernumber = AddMember( %data );
229 $borrower = GetMember( borrowernumber => $borrowernumber );
230 is( $borrower->{userid}, $data{userid}, 'AddMember should insert the given userid' );
232 # Regression tests for BZ13502
233 ## Remove all entries with userid='' (should be only 1 max)
234 $dbh->do(q|DELETE FROM borrowers WHERE userid = ''|);
235 ## And create a patron with a userid=''
236 $borrowernumber = AddMember( categorycode => 'S', branchcode => $library2->{branchcode} );
237 $dbh->do(q|UPDATE borrowers SET userid = '' WHERE borrowernumber = ?|, undef, $borrowernumber);
238 # Create another patron and verify the userid has been generated
239 $borrowernumber = AddMember( categorycode => 'S', branchcode => $library2->{branchcode} );
240 ok( $borrowernumber > 0, 'AddMember should have inserted the patron even if no userid is given' );
241 $borrower = GetMember( borrowernumber => $borrowernumber );
242 ok( $borrower->{userid}, 'A userid should have been generated correctly' );
244 # Regression tests for BZ12226
245 is( Check_Userid( C4::Context->config('user'), '' ), 0,
246 'Check_Userid should return 0 for the DB user (Bug 12226)');
248 subtest 'GetMemberAccountRecords' => sub {
252 my $borrowernumber = $builder->build({ source => 'Borrower' })->{ borrowernumber };
253 my $accountline_1 = $builder->build({
254 source => 'Accountline',
256 borrowernumber => $borrowernumber,
257 amountoutstanding => 64.60
261 my ($total,undef,undef) = GetMemberAccountRecords( $borrowernumber );
262 is( $total , 64.60, "Rounding works correctly in total calculation (single value)" );
264 my $accountline_2 = $builder->build({
265 source => 'Accountline',
267 borrowernumber => $borrowernumber,
268 amountoutstanding => 10.65
272 ($total,undef,undef) = GetMemberAccountRecords( $borrowernumber );
273 is( $total , 75.25, "Rounding works correctly in total calculation (multiple values)" );
277 subtest 'GetMemberAccountBalance' => sub {
281 my $members_mock = new Test::MockModule('C4::Members');
282 $members_mock->mock( 'GetMemberAccountRecords', sub {
283 my ($borrowernumber) = @_;
284 if ($borrowernumber) {
286 { amountoutstanding => '7', accounttype => 'Rent' },
287 { amountoutstanding => '5', accounttype => 'Res' },
288 { amountoutstanding => '3', accounttype => 'Pay' } );
289 return ( 15, \@accountlines );
293 return ( 0, \@accountlines );
297 my $person = GetMemberDetails(undef,undef);
298 ok( !$person , 'Expected no member details from undef,undef' );
299 $person = GetMemberDetails(undef,'987654321');
300 is( $person->{amountoutstanding}, 15,
301 'Expected 15 outstanding for cardnumber.');
302 $borrowernumber = $person->{borrowernumber};
303 $person = GetMemberDetails($borrowernumber,undef);
304 is( $person->{amountoutstanding}, 15,
305 'Expected 15 outstanding for borrowernumber.');
306 $person = GetMemberDetails($borrowernumber,'987654321');
307 is( $person->{amountoutstanding}, 15,
308 'Expected 15 outstanding for both borrowernumber and cardnumber.');
310 # do not count holds charges
311 t::lib::Mocks::mock_preference( 'HoldsInNoissuesCharge', '1' );
312 t::lib::Mocks::mock_preference( 'ManInvInNoissuesCharge', '0' );
313 my ($total, $total_minus_charges,
314 $other_charges) = C4::Members::GetMemberAccountBalance(123);
315 is( $total, 15 , "Total calculated correctly");
316 is( $total_minus_charges, 15, "Holds charges are not count if HoldsInNoissuesCharge=1");
317 is( $other_charges, 0, "Holds charges are not considered if HoldsInNoissuesCharge=1");
319 t::lib::Mocks::mock_preference( 'HoldsInNoissuesCharge', '0' );
320 ($total, $total_minus_charges,
321 $other_charges) = C4::Members::GetMemberAccountBalance(123);
322 is( $total, 15 , "Total calculated correctly");
323 is( $total_minus_charges, 10, "Holds charges are count if HoldsInNoissuesCharge=0");
324 is( $other_charges, 5, "Holds charges are considered if HoldsInNoissuesCharge=1");
327 subtest 'purgeSelfRegistration' => sub {
332 C4::Members::DeleteUnverifiedOpacRegistrations($d);
334 $dbh->do("INSERT INTO borrower_modifications (timestamp, borrowernumber, verification_token) VALUES ('2014-01-01 01:02:03',0,?)", undef, (scalar localtime)."_$_");
336 is( C4::Members::DeleteUnverifiedOpacRegistrations($d), 3, 'Test for DeleteUnverifiedOpacRegistrations' );
338 #purge members in temporary category
340 $dbh->do("INSERT IGNORE INTO categories (categorycode) VALUES ('$c')");
341 t::lib::Mocks::mock_preference('PatronSelfRegistrationDefaultCategory', $c );
342 t::lib::Mocks::mock_preference('PatronSelfRegistrationExpireTemporaryAccountsDelay', 360);
343 C4::Members::DeleteExpiredOpacRegistrations();
344 $dbh->do("INSERT INTO borrowers (surname, address, city, branchcode, categorycode, dateenrolled) VALUES ('Testaabbcc', 'Street 1', 'CITY', ?, '$c', '2014-01-01 01:02:03')", undef, $library1->{branchcode});
345 is( C4::Members::DeleteExpiredOpacRegistrations(), 1, 'Test for DeleteExpiredOpacRegistrations');
349 my ($resultset) = @_;
350 my $found = $resultset && grep( { $_->{cardnumber} && $_->{cardnumber} eq $CARDNUMBER } @$resultset );
354 # Regression tests for BZ15343
356 ( $borrowernumber, $password ) = AddMember_Opac(surname=>"Dick",firstname=>'Philip',branchcode => $library2->{branchcode});
357 is( $password =~ /^[a-zA-Z]{10}$/ , 1, 'Test for autogenerated password if none submitted');
358 ( $borrowernumber, $password ) = AddMember_Opac(surname=>"Deckard",firstname=>"Rick",password=>"Nexus-6",branchcode => $library2->{branchcode});
359 is( $password eq "Nexus-6", 1, 'Test password used if submitted');
360 $borrower = GetMember(borrowernumber => $borrowernumber);
361 my $hashed_up = Koha::AuthUtils::hash_password("Nexus-6", $borrower->{password});
362 is( $borrower->{password} eq $hashed_up, 1, 'Check password hash equals hash of submitted password' );
366 ### ------------------------------------- ###
367 ### Testing GetAge() / SetAge() functions ###
368 ### ------------------------------------- ###
369 #USES the package $member-variable to mock a koha.borrowers-object
370 sub testAgeAccessors {
372 my $original_dateofbirth = $member->{dateofbirth};
375 my $age=GetAge("1992-08-14", "2011-01-19");
376 is ($age, "18", "Age correct");
378 $age=GetAge("2011-01-19", "1992-01-19");
379 is ($age, "-19", "Birthday In the Future");
381 ##Testing SetAge() for now()
382 my $dt_now = DateTime->now();
383 $age = DateTime::Duration->new(years => 12, months => 6, days => 1);
384 C4::Members::SetAge( $member, $age );
385 $age = C4::Members::GetAge( $member->{dateofbirth} );
386 is ($age, '12', "SetAge 12 years");
388 $age = DateTime::Duration->new(years => 18, months => 12, days => 31);
389 C4::Members::SetAge( $member, $age );
390 $age = C4::Members::GetAge( $member->{dateofbirth} );
391 is ($age, '19', "SetAge 18+1 years"); #This is a special case, where months=>12 and days=>31 constitute one full year, hence we get age 19 instead of 18.
393 $age = DateTime::Duration->new(years => 18, months => 12, days => 30);
394 C4::Members::SetAge( $member, $age );
395 $age = C4::Members::GetAge( $member->{dateofbirth} );
396 is ($age, '19', "SetAge 18 years");
398 $age = DateTime::Duration->new(years => 0, months => 1, days => 1);
399 C4::Members::SetAge( $member, $age );
400 $age = C4::Members::GetAge( $member->{dateofbirth} );
401 is ($age, '0', "SetAge 0 years");
404 C4::Members::SetAge( $member, $age );
405 $age = C4::Members::GetAge( $member->{dateofbirth} );
406 is ($age, '19', "SetAge ISO_Date 18+1 years"); #This is a special case, where months=>12 and days=>31 constitute one full year, hence we get age 19 instead of 18.
409 C4::Members::SetAge( $member, $age );
410 $age = C4::Members::GetAge( $member->{dateofbirth} );
411 is ($age, '19', "SetAge ISO_Date 18 years");
414 eval { C4::Members::SetAge( $member, $age ); };
415 is ((length $@ > 1), '1', "SetAge ISO_Date $age years FAILS");
418 eval { C4::Members::SetAge( $member, $age ); };
419 is ((length $@ == 0), '1', "SetAge ISO_Date $age years succeeds");
421 ##Testing SetAge() for relative_date
422 my $relative_date = DateTime->new(year => 3010, month => 3, day => 15);
424 $age = DateTime::Duration->new(years => 10, months => 3);
425 C4::Members::SetAge( $member, $age, $relative_date );
426 $age = C4::Members::GetAge( $member->{dateofbirth}, $relative_date->ymd() );
427 is ($age, '10', "SetAge, 10 years and 3 months old person was born on ".$member->{dateofbirth}." if todays is ".$relative_date->ymd());
429 $age = DateTime::Duration->new(years => 112, months => 1, days => 1);
430 C4::Members::SetAge( $member, $age, $relative_date );
431 $age = C4::Members::GetAge( $member->{dateofbirth}, $relative_date->ymd() );
432 is ($age, '112', "SetAge, 112 years, 1 months and 1 days old person was born on ".$member->{dateofbirth}." if today is ".$relative_date->ymd());
435 C4::Members::SetAge( $member, $age, $relative_date );
436 $age = C4::Members::GetAge( $member->{dateofbirth}, $relative_date->ymd() );
437 is ($age, '112', "SetAge ISO_Date, 112 years, 1 months and 1 days old person was born on ".$member->{dateofbirth}." if today is ".$relative_date->ymd());
439 $member->{dateofbirth} = $original_dateofbirth; #It is polite to revert made changes in the unit tests.
440 } #sub testAgeAccessors
442 # regression test for bug 16009
445 my $patron = GetMember(cardnumber => undef);
447 is($@, '', 'Bug 16009: GetMember(cardnumber => undef) works');
448 is($patron, undef, 'Bug 16009: GetMember(cardnumber => undef) returns undef');