Bug 33496: Add 'host_items' param to Koha::Biblio->items
[koha.git] / t / db_dependent / Koha / Biblio.t
1 #!/usr/bin/perl
2
3 # This file is part of Koha.
4 #
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.
9 #
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.
14 #
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>.
17
18 use Modern::Perl;
19
20 use Test::More tests => 23;
21 use Test::Exception;
22 use Test::Warn;
23
24 use C4::Biblio qw( AddBiblio ModBiblio ModBiblioMarc );
25 use C4::Circulation qw( AddIssue AddReturn );
26
27 use Koha::Database;
28 use Koha::Cache::Memory::Lite;
29 use Koha::Caches;
30 use Koha::Acquisition::Orders;
31 use Koha::AuthorisedValueCategories;
32 use Koha::AuthorisedValues;
33 use Koha::MarcSubfieldStructures;
34 use Koha::Exception;
35
36 use MARC::Field;
37 use MARC::Record;
38
39 use t::lib::TestBuilder;
40 use t::lib::Mocks;
41 use Test::MockModule;
42
43 BEGIN {
44     use_ok('Koha::Biblio');
45     use_ok('Koha::Biblios');
46 }
47
48 my $schema  = Koha::Database->new->schema;
49 my $builder = t::lib::TestBuilder->new;
50
51 subtest 'metadata() tests' => sub {
52
53     plan tests => 4;
54
55     $schema->storage->txn_begin;
56
57     my $title = 'Oranges and Peaches';
58
59     my $record = MARC::Record->new();
60     my $field = MARC::Field->new('245','','','a' => $title);
61     $record->append_fields( $field );
62     my ($biblionumber) = C4::Biblio::AddBiblio($record, '');
63
64     my $biblio = Koha::Biblios->find( $biblionumber );
65     is( ref $biblio, 'Koha::Biblio', 'Found a Koha::Biblio object' );
66
67     my $metadata = $biblio->metadata;
68     is( ref $metadata, 'Koha::Biblio::Metadata', 'Method metadata() returned a Koha::Biblio::Metadata object' );
69
70     my $record2 = $metadata->record;
71     is( ref $record2, 'MARC::Record', 'Method record() returned a MARC::Record object' );
72
73     is( $record2->field('245')->subfield("a"), $title, 'Title in 245$a matches title from original record object' );
74
75     $schema->storage->txn_rollback;
76 };
77
78 subtest 'hidden_in_opac() tests' => sub {
79
80     plan tests => 6;
81
82     $schema->storage->txn_begin;
83
84     my $biblio = $builder->build_sample_biblio();
85     my $rules  = { withdrawn => [ 2 ] };
86
87     t::lib::Mocks::mock_preference( 'OpacHiddenItemsHidesRecord', 0 );
88
89     ok(
90         !$biblio->hidden_in_opac({ rules => $rules }),
91         'Biblio not hidden if there is no item attached (!OpacHiddenItemsHidesRecord)'
92     );
93
94     t::lib::Mocks::mock_preference( 'OpacHiddenItemsHidesRecord', 1 );
95
96     ok(
97         !$biblio->hidden_in_opac({ rules => $rules }),
98         'Biblio not hidden if there is no item attached (OpacHiddenItemsHidesRecord)'
99     );
100
101     my $item_1 = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
102     my $item_2 = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
103
104     $item_1->withdrawn( 1 )->store->discard_changes;
105     $item_2->withdrawn( 1 )->store->discard_changes;
106
107     ok( !$biblio->hidden_in_opac({ rules => $rules }), 'Biblio not hidden' );
108
109     $item_2->withdrawn( 2 )->store->discard_changes;
110     $biblio->discard_changes; # refresh
111
112     ok( !$biblio->hidden_in_opac({ rules => $rules }), 'Biblio not hidden' );
113
114     $item_1->withdrawn( 2 )->store->discard_changes;
115     $biblio->discard_changes; # refresh
116
117     ok( $biblio->hidden_in_opac({ rules => $rules }), 'Biblio hidden' );
118
119     t::lib::Mocks::mock_preference( 'OpacHiddenItemsHidesRecord', 0 );
120     ok(
121         !$biblio->hidden_in_opac( { rules => $rules } ),
122         'Biblio hidden (!OpacHiddenItemsHidesRecord)'
123     );
124
125
126     $schema->storage->txn_rollback;
127 };
128
129 subtest 'items() tests' => sub {
130
131     plan tests => 3;
132
133     $schema->storage->txn_begin;
134
135     my $biblio = $builder->build_sample_biblio();
136
137     is( $biblio->items->count, 0, 'No items, count is 0' );
138
139     my $item_1 = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
140     my $item_2 = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
141
142     my $items = $biblio->items;
143     is( ref($items), 'Koha::Items', 'Returns a Koha::Items resultset' );
144     is( $items->count, 2, 'Two items in resultset' );
145
146     $schema->storage->txn_rollback;
147
148 };
149
150 subtest 'get_coins and get_openurl' => sub {
151
152     plan tests => 4;
153
154     $schema->storage->txn_begin;
155
156     my $builder = t::lib::TestBuilder->new;
157     my $biblio = $builder->build_sample_biblio({
158             title => 'Title 1',
159             author => 'Author 1'
160         });
161     is(
162         $biblio->get_coins,
163         'ctx_ver=Z39.88-2004&amp;rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&amp;rft.genre=book&amp;rft.btitle=Title%201&amp;rft.au=Author%201',
164         'GetCOinsBiblio returned right metadata'
165     );
166
167     my $record = MARC::Record->new();
168     $record->append_fields( MARC::Field->new('100','','','a' => 'Author 2'), MARC::Field->new('880','','','a' => 'Something') );
169     my ( $biblionumber ) = C4::Biblio::AddBiblio($record, '');
170     my $biblio_no_title = Koha::Biblios->find($biblionumber);
171     is(
172         $biblio_no_title->get_coins,
173         'ctx_ver=Z39.88-2004&amp;rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&amp;rft.genre=book&amp;rft.au=Author%202',
174         'GetCOinsBiblio returned right metadata if biblio does not have a title'
175     );
176
177     t::lib::Mocks::mock_preference("OpenURLResolverURL", "https://koha.example.com/");
178     is(
179         $biblio->get_openurl,
180         'https://koha.example.com/?ctx_ver=Z39.88-2004&amp;rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&amp;rft.genre=book&amp;rft.btitle=Title%201&amp;rft.au=Author%201',
181         'Koha::Biblio->get_openurl returned right URL'
182     );
183
184     t::lib::Mocks::mock_preference("OpenURLResolverURL", "https://koha.example.com/?client_id=ci1");
185     is(
186         $biblio->get_openurl,
187         'https://koha.example.com/?client_id=ci1&amp;ctx_ver=Z39.88-2004&amp;rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&amp;rft.genre=book&amp;rft.btitle=Title%201&amp;rft.au=Author%201',
188         'Koha::Biblio->get_openurl returned right URL'
189     );
190
191     $schema->storage->txn_rollback;
192 };
193
194 subtest 'is_serial() tests' => sub {
195
196     plan tests => 3;
197
198     $schema->storage->txn_begin;
199
200     my $biblio = $builder->build_sample_biblio();
201
202     $biblio->serial( 1 )->store->discard_changes;
203     ok( $biblio->is_serial, 'Bibliographic record is serial' );
204
205     $biblio->serial( 0 )->store->discard_changes;
206     ok( !$biblio->is_serial, 'Bibliographic record is not serial' );
207
208     my $record = $biblio->metadata->record;
209     $record->leader('00142nas a22     7a 4500');
210     ModBiblio($record, $biblio->biblionumber );
211     $biblio = Koha::Biblios->find($biblio->biblionumber);
212
213     ok( $biblio->is_serial, 'Bibliographic record is serial' );
214
215     $schema->storage->txn_rollback;
216 };
217
218 subtest 'pickup_locations() tests' => sub {
219
220     plan tests => 11;
221
222     $schema->storage->txn_begin;
223
224     Koha::CirculationRules->search->delete;
225     Koha::CirculationRules->set_rules(
226         {
227             categorycode => undef,
228             itemtype     => undef,
229             branchcode   => undef,
230             rules        => {
231                 reservesallowed => 25,
232             }
233         }
234     );
235
236     my $root1 = $builder->build_object( { class => 'Koha::Library::Groups', value => { ft_local_hold_group => 1 } } );
237     my $root2 = $builder->build_object( { class => 'Koha::Library::Groups', value => { ft_local_hold_group => 1 } } );
238     my $root3 = $builder->build_object( { class => 'Koha::Library::Groups', value => { ft_local_hold_group => 1 } } );
239
240     my $library1 = $builder->build_object( { class => 'Koha::Libraries', value => { pickup_location => 1, branchname => 'zzz' } } );
241     my $library2 = $builder->build_object( { class => 'Koha::Libraries', value => { pickup_location => 1, branchname => 'AAA' } } );
242     my $library3 = $builder->build_object( { class => 'Koha::Libraries', value => { pickup_location => 0, branchname => 'FFF' } } );
243     my $library4 = $builder->build_object( { class => 'Koha::Libraries', value => { pickup_location => 1, branchname => 'CCC' } } );
244     my $library5 = $builder->build_object( { class => 'Koha::Libraries', value => { pickup_location => 1, branchname => 'eee' } } );
245     my $library6 = $builder->build_object( { class => 'Koha::Libraries', value => { pickup_location => 1, branchname => 'BBB' } } );
246     my $library7 = $builder->build_object( { class => 'Koha::Libraries', value => { pickup_location => 1, branchname => 'DDD' } } );
247     my $library8 = $builder->build_object( { class => 'Koha::Libraries', value => { pickup_location => 0, branchname => 'GGG' } } );
248
249     our @branchcodes = map { $_->branchcode } ($library1, $library2, $library3, $library4, $library5, $library6, $library7, $library8);
250
251     Koha::CirculationRules->set_rules(
252         {
253             branchcode => $library1->branchcode,
254             itemtype   => undef,
255             rules => {
256                 holdallowed => 'from_home_library',
257                 hold_fulfillment_policy => 'any',
258                 returnbranch => 'any'
259             }
260         }
261     );
262
263     Koha::CirculationRules->set_rules(
264         {
265             branchcode => $library2->branchcode,
266             itemtype   => undef,
267             rules => {
268                 holdallowed => 'from_local_hold_group',
269                 hold_fulfillment_policy => 'holdgroup',
270                 returnbranch => 'any'
271             }
272         }
273     );
274
275     Koha::CirculationRules->set_rules(
276         {
277             branchcode => $library3->branchcode,
278             itemtype   => undef,
279             rules => {
280                 holdallowed => 'from_local_hold_group',
281                 hold_fulfillment_policy => 'patrongroup',
282                 returnbranch => 'any'
283             }
284         }
285     );
286
287     Koha::CirculationRules->set_rules(
288         {
289             branchcode => $library4->branchcode,
290             itemtype   => undef,
291             rules => {
292                 holdallowed => 'from_any_library',
293                 hold_fulfillment_policy => 'holdingbranch',
294                 returnbranch => 'any'
295             }
296         }
297     );
298
299     Koha::CirculationRules->set_rules(
300         {
301             branchcode => $library5->branchcode,
302             itemtype   => undef,
303             rules => {
304                 holdallowed => 'from_any_library',
305                 hold_fulfillment_policy => 'homebranch',
306                 returnbranch => 'any'
307             }
308         }
309     );
310
311     Koha::CirculationRules->set_rules(
312         {
313             branchcode => $library6->branchcode,
314             itemtype   => undef,
315             rules => {
316                 holdallowed => 'from_home_library',
317                 hold_fulfillment_policy => 'holdgroup',
318                 returnbranch => 'any'
319             }
320         }
321     );
322
323     Koha::CirculationRules->set_rules(
324         {
325             branchcode => $library7->branchcode,
326             itemtype   => undef,
327             rules => {
328                 holdallowed => 'from_local_hold_group',
329                 hold_fulfillment_policy => 'holdingbranch',
330                 returnbranch => 'any'
331             }
332         }
333     );
334
335
336     Koha::CirculationRules->set_rules(
337         {
338             branchcode => $library8->branchcode,
339             itemtype   => undef,
340             rules => {
341                 holdallowed => 'from_any_library',
342                 hold_fulfillment_policy => 'patrongroup',
343                 returnbranch => 'any'
344             }
345         }
346     );
347
348     my $group1_1 = $builder->build_object( { class => 'Koha::Library::Groups', value => { parent_id => $root1->id, branchcode => $library1->branchcode } } );
349     my $group1_2 = $builder->build_object( { class => 'Koha::Library::Groups', value => { parent_id => $root1->id, branchcode => $library2->branchcode } } );
350
351     my $group2_3 = $builder->build_object( { class => 'Koha::Library::Groups', value => { parent_id => $root2->id, branchcode => $library3->branchcode } } );
352     my $group2_4 = $builder->build_object( { class => 'Koha::Library::Groups', value => { parent_id => $root2->id, branchcode => $library4->branchcode } } );
353
354     my $group3_5 = $builder->build_object( { class => 'Koha::Library::Groups', value => { parent_id => $root3->id, branchcode => $library5->branchcode } } );
355     my $group3_6 = $builder->build_object( { class => 'Koha::Library::Groups', value => { parent_id => $root3->id, branchcode => $library6->branchcode } } );
356     my $group3_7 = $builder->build_object( { class => 'Koha::Library::Groups', value => { parent_id => $root3->id, branchcode => $library7->branchcode } } );
357     my $group3_8 = $builder->build_object( { class => 'Koha::Library::Groups', value => { parent_id => $root3->id, branchcode => $library8->branchcode } } );
358
359     my $biblio1  = $builder->build_sample_biblio({ title => '1' });
360     my $biblio2  = $builder->build_sample_biblio({ title => '2' });
361
362     throws_ok
363       { $biblio1->pickup_locations }
364       'Koha::Exceptions::MissingParameter',
365       'Exception thrown on missing parameter';
366
367     is( $@->parameter, 'patron', 'Exception param correctly set' );
368
369     my $item1_1  = $builder->build_sample_item({
370         biblionumber     => $biblio1->biblionumber,
371         homebranch       => $library1->branchcode,
372         holdingbranch    => $library2->branchcode,
373     })->store;
374
375     my $item1_3  = $builder->build_sample_item({
376         biblionumber     => $biblio1->biblionumber,
377         homebranch       => $library3->branchcode,
378         holdingbranch    => $library4->branchcode,
379     })->store;
380
381     my $item1_7  = $builder->build_sample_item({
382         biblionumber     => $biblio1->biblionumber,
383         homebranch       => $library7->branchcode,
384         holdingbranch    => $library4->branchcode,
385     })->store;
386
387     my $item2_2  = $builder->build_sample_item({
388         biblionumber     => $biblio2->biblionumber,
389         homebranch       => $library2->branchcode,
390         holdingbranch    => $library1->branchcode,
391     })->store;
392
393     my $item2_4  = $builder->build_sample_item({
394         biblionumber     => $biblio2->biblionumber,
395         homebranch       => $library4->branchcode,
396         holdingbranch    => $library3->branchcode,
397     })->store;
398
399     my $item2_6  = $builder->build_sample_item({
400         biblionumber     => $biblio2->biblionumber,
401         homebranch       => $library6->branchcode,
402         holdingbranch    => $library4->branchcode,
403     })->store;
404
405     my $patron1 = $builder->build_object( { class => 'Koha::Patrons', value => { firstname=>'1', branchcode => $library1->branchcode } } );
406     my $patron8 = $builder->build_object( { class => 'Koha::Patrons', value => { firstname=>'8', branchcode => $library8->branchcode } } );
407
408     my $results = {
409         "ItemHomeLibrary-1-1" => 6,
410         "ItemHomeLibrary-1-8" => 1,
411         "ItemHomeLibrary-2-1" => 2,
412         "ItemHomeLibrary-2-8" => 0,
413         "PatronLibrary-1-1" => 6,
414         "PatronLibrary-1-8" => 3,
415         "PatronLibrary-2-1" => 0,
416         "PatronLibrary-2-8" => 3,
417     };
418
419     sub _doTest {
420         my ( $cbranch, $biblio, $patron, $results ) = @_;
421         t::lib::Mocks::mock_preference('ReservesControlBranch', $cbranch);
422
423         my @pl = map {
424             my $pickup_location = $_;
425             grep { $pickup_location->branchcode eq $_ } @branchcodes
426         } $biblio->pickup_locations( { patron => $patron } )->as_list;
427
428         ok(
429             scalar(@pl) == $results->{ $cbranch . '-'
430                   . $biblio->title . '-'
431                   . $patron->firstname },
432             'ReservesControlBranch: '
433               . $cbranch
434               . ', biblio'
435               . $biblio->title
436               . ', patron'
437               . $patron->firstname
438               . ' should return '
439               . $results->{ $cbranch . '-'
440                   . $biblio->title . '-'
441                   . $patron->firstname }
442               . ' but returns '
443               . scalar(@pl)
444         );
445     }
446
447     foreach my $cbranch ('ItemHomeLibrary','PatronLibrary') {
448         my $cache = Koha::Cache::Memory::Lite->get_instance();
449         $cache->flush(); # needed since we change ReservesControlBranch
450         foreach my $biblio ($biblio1, $biblio2) {
451             foreach my $patron ($patron1, $patron8) {
452                 _doTest($cbranch, $biblio, $patron, $results);
453             }
454         }
455     }
456
457     my @pl_names = map { $_->branchname } $biblio1->pickup_locations( { patron => $patron1 } )->as_list;
458     my $pl_ori_str = join('|', @pl_names);
459     my $pl_sorted_str = join('|', sort { lc($a) cmp lc($b) } @pl_names);
460     ok(
461         $pl_ori_str eq $pl_sorted_str,
462         'Libraries must be sorted by name'
463     );
464     $schema->storage->txn_rollback;
465 };
466
467 subtest 'to_api() tests' => sub {
468
469     $schema->storage->txn_begin;
470
471     my $biblio = $builder->build_sample_biblio();
472     my $item = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
473
474     my $biblioitem_api = $biblio->biblioitem->to_api;
475     my $biblio_api     = $biblio->to_api;
476
477     plan tests => (scalar keys %{ $biblioitem_api }) + 1;
478
479     foreach my $key ( keys %{ $biblioitem_api } ) {
480         is( $biblio_api->{$key}, $biblioitem_api->{$key}, "$key is added to the biblio object" );
481     }
482
483     $biblio_api = $biblio->to_api({ embed => { items => {} } });
484     is_deeply( $biblio_api->{items}, [ $item->to_api ], 'Item correctly embedded' );
485
486     $schema->storage->txn_rollback;
487 };
488
489 subtest 'suggestions() tests' => sub {
490
491     plan tests => 3;
492
493     $schema->storage->txn_begin;
494
495     my $biblio     = $builder->build_sample_biblio();
496
497     is( ref($biblio->suggestions), 'Koha::Suggestions', 'Return type is correct' );
498
499     is_deeply(
500         $biblio->suggestions->unblessed,
501         [],
502         '->suggestions returns an empty Koha::Suggestions resultset'
503     );
504
505     my $suggestion = $builder->build_object(
506         {
507             class => 'Koha::Suggestions',
508             value => { biblionumber => $biblio->biblionumber }
509         }
510     );
511
512     my $suggestions = $biblio->suggestions->unblessed;
513
514     is_deeply(
515         $biblio->suggestions->unblessed,
516         [ $suggestion->unblessed ],
517         '->suggestions returns the related Koha::Suggestion objects'
518     );
519
520     $schema->storage->txn_rollback;
521 };
522
523 subtest 'get_marc_components() tests' => sub {
524
525     plan tests => 5;
526
527     $schema->storage->txn_begin;
528
529     my ($host_bibnum) = C4::Biblio::AddBiblio(host_record(), '');
530     my $host_biblio = Koha::Biblios->find($host_bibnum);
531     t::lib::Mocks::mock_preference( 'SearchEngine', 'Zebra' );
532     my $search_mod = Test::MockModule->new( 'Koha::SearchEngine::Zebra::Search' );
533     $search_mod->mock( 'search_compat', \&search_component_record2 );
534
535     my $components = $host_biblio->get_marc_components;
536     is( ref($components), 'ARRAY', 'Return type is correct' );
537
538     is_deeply(
539         $components,
540         [],
541         '->get_marc_components returns an empty ARRAY'
542     );
543
544     $search_mod->unmock( 'search_compat');
545     $search_mod->mock( 'search_compat', \&search_component_record1 );
546     my $component_record = component_record1()->as_xml();
547
548     is_deeply(
549         $host_biblio->get_marc_components,
550         [$component_record],
551         '->get_marc_components returns the related component part record'
552     );
553     $search_mod->unmock( 'search_compat');
554
555     $search_mod->mock( 'search_compat',
556         sub { Koha::Exception->throw("error searching analytics") }
557     );
558     warning_like { $components = $host_biblio->get_marc_components }
559         qr{Warning from search_compat: .* 'error searching analytics'};
560
561     is_deeply(
562         $host_biblio->object_messages,
563         [
564             {
565                 type    => 'error',
566                 message => 'component_search',
567                 payload => "Exception 'Koha::Exception' thrown 'error searching analytics'\n"
568             }
569         ]
570     );
571     $search_mod->unmock( 'search_compat');
572
573     $schema->storage->txn_rollback;
574 };
575
576 subtest 'get_components_query' => sub {
577     plan tests => 12;
578
579     my $biblio = $builder->build_sample_biblio();
580     my $biblionumber = $biblio->biblionumber;
581     my $record = $biblio->metadata->record;
582
583     foreach my $engine ('Zebra','Elasticsearch'){
584         t::lib::Mocks::mock_preference( 'SearchEngine', $engine );
585
586         t::lib::Mocks::mock_preference( 'UseControlNumber', '0' );
587         t::lib::Mocks::mock_preference( 'ComponentSortField', 'author' );
588         t::lib::Mocks::mock_preference( 'ComponentSortOrder', 'za' );
589         my ( $comp_query, $comp_query_str, $comp_sort ) = $biblio->get_components_query;
590         is($comp_query_str, 'Host-item:("Some boring read")', "$engine: UseControlNumber disabled");
591         is($comp_sort, "author_za", "$engine: UseControlNumber disabled sort is correct");
592
593         t::lib::Mocks::mock_preference( 'UseControlNumber', '1' );
594         t::lib::Mocks::mock_preference( 'ComponentSortOrder', 'az' );
595         my $marc_001_field = MARC::Field->new('001', $biblionumber);
596         $record->append_fields($marc_001_field);
597         C4::Biblio::ModBiblio( $record, $biblio->biblionumber );
598         $biblio = Koha::Biblios->find( $biblio->biblionumber);
599
600         ( $comp_query, $comp_query_str, $comp_sort ) = $biblio->get_components_query;
601         is($comp_query_str, "(rcn:\"$biblionumber\" AND (bib-level:a OR bib-level:b))", "$engine: UseControlNumber enabled without MarcOrgCode");
602         is($comp_sort, "author_az", "$engine: UseControlNumber enabled without MarcOrgCode sort is correct");
603
604         my $marc_003_field = MARC::Field->new('003', 'OSt');
605         $record->append_fields($marc_003_field);
606         C4::Biblio::ModBiblio( $record, $biblio->biblionumber );
607         $biblio = Koha::Biblios->find( $biblio->biblionumber);
608
609         t::lib::Mocks::mock_preference( 'ComponentSortField', 'title' );
610         t::lib::Mocks::mock_preference( 'ComponentSortOrder', 'asc' );
611         ( $comp_query, $comp_query_str, $comp_sort ) = $biblio->get_components_query;
612         is($comp_query_str, "(((rcn:\"$biblionumber\" AND cni:\"OSt\") OR rcn:\"OSt $biblionumber\") AND (bib-level:a OR bib-level:b))", "$engine: UseControlNumber enabled with MarcOrgCode");
613         is($comp_sort, "title_asc", "$engine: UseControlNumber enabled with MarcOrgCode sort if correct");
614         $record->delete_field($marc_003_field);
615     }
616 };
617
618 subtest 'orders() and active_orders() tests' => sub {
619
620     plan tests => 5;
621
622     $schema->storage->txn_begin;
623
624     my $biblio = $builder->build_sample_biblio();
625
626     my $orders        = $biblio->orders;
627     my $active_orders = $biblio->active_orders;
628
629     is( ref($orders), 'Koha::Acquisition::Orders', 'Result type is correct' );
630     is( $biblio->orders->count, $biblio->active_orders->count, '->orders->count returns the count for the resultset' );
631
632     # Add a couple orders
633     foreach (1..2) {
634         $builder->build_object(
635             {
636                 class => 'Koha::Acquisition::Orders',
637                 value => {
638                     biblionumber => $biblio->biblionumber,
639                     datecancellationprinted => '2019-12-31'
640                 }
641             }
642         );
643     }
644
645     $builder->build_object(
646         {
647             class => 'Koha::Acquisition::Orders',
648             value => {
649                 biblionumber => $biblio->biblionumber,
650                 datecancellationprinted => undef
651             }
652         }
653     );
654
655     $orders = $biblio->orders;
656     $active_orders = $biblio->active_orders;
657
658     is( ref($orders), 'Koha::Acquisition::Orders', 'Result type is correct' );
659     is( ref($active_orders), 'Koha::Acquisition::Orders', 'Result type is correct' );
660     is( $orders->count, $active_orders->count + 2, '->active_orders->count returns the rigt count' );
661
662     $schema->storage->txn_rollback;
663 };
664
665 subtest 'subscriptions() tests' => sub {
666
667     plan tests => 4;
668
669     $schema->storage->txn_begin;
670
671     my $biblio = $builder->build_sample_biblio;
672
673     my $subscriptions = $biblio->subscriptions;
674     is( ref($subscriptions), 'Koha::Subscriptions',
675         'Koha::Biblio->subscriptions should return a Koha::Subscriptions object'
676     );
677     is( $subscriptions->count, 0, 'Koha::Biblio->subscriptions should return the correct number of subscriptions');
678
679     # Add two subscriptions
680     foreach (1..2) {
681         $builder->build_object(
682             {
683                 class => 'Koha::Subscriptions',
684                 value => { biblionumber => $biblio->biblionumber }
685             }
686         );
687     }
688
689     $subscriptions = $biblio->subscriptions;
690     is( ref($subscriptions), 'Koha::Subscriptions',
691         'Koha::Biblio->subscriptions should return a Koha::Subscriptions object'
692     );
693     is( $subscriptions->count, 2, 'Koha::Biblio->subscriptions should return the correct number of subscriptions');
694
695     $schema->storage->txn_rollback;
696 };
697
698 subtest 'get_marc_notes() MARC21 tests' => sub {
699     plan tests => 14;
700
701     $schema->storage->txn_begin;
702
703     t::lib::Mocks::mock_preference( 'NotesToHide', '520' );
704
705     my $av = $builder->build_object( { class => 'Koha::AuthorisedValues' } );
706
707     my $biblio = $builder->build_sample_biblio;
708     my $record = $biblio->metadata->record;
709     $record->append_fields(
710         MARC::Field->new( '500', '', '', a => 'Note1' ),
711         MARC::Field->new( '505', '', '', a => 'Note2', u => 'http://someserver.com' ),
712         MARC::Field->new( '520', '', '', a => 'Note3 skipped' ),
713         MARC::Field->new( '541', '0', '', a => 'Note4 skipped on opac' ),
714         MARC::Field->new( '544', '', '', a => 'Note5' ),
715         MARC::Field->new( '590', '', '', a => $av->authorised_value ),
716         MARC::Field->new( '545', '', '', a => 'Invisible on OPAC' ),
717     );
718
719     my $mss = Koha::MarcSubfieldStructures->find({tagfield => "590", tagsubfield => "a", frameworkcode => $biblio->frameworkcode });
720     $mss->update({ authorised_value => $av->category });
721
722     $mss = Koha::MarcSubfieldStructures->find({tagfield => "545", tagsubfield => "a", frameworkcode => $biblio->frameworkcode });
723     $mss->update({ hidden => 1 });
724
725     my $cache = Koha::Caches->get_instance;
726     $cache->clear_from_cache("MarcStructure-0-");
727     $cache->clear_from_cache("MarcStructure-1-");
728     $cache->clear_from_cache("MarcSubfieldStructure-");
729     $cache->clear_from_cache("MarcCodedFields-");
730
731     C4::Biblio::ModBiblio( $record, $biblio->biblionumber );
732     $biblio = Koha::Biblios->find( $biblio->biblionumber);
733
734     my $notes = $biblio->get_marc_notes;
735     is( $notes->[0]->{marcnote}, 'Note1', 'First note' );
736     is( $notes->[1]->{marcnote}, 'Note2', 'Second note' );
737     is( $notes->[2]->{marcnote}, 'http://someserver.com', 'URL separated' );
738     is( $notes->[3]->{marcnote}, 'Note4 skipped on opac',"Note shows if not opac (Hidden by Indicator)" );
739     is( $notes->[4]->{marcnote}, 'Note5', 'Fifth note' );
740     is( $notes->[5]->{marcnote}, $av->lib, 'Authorised value is correctly parsed to show description rather than code' );
741     is( $notes->[6]->{marcnote}, 'Invisible on OPAC', 'Note shows if not opac (Hidden by framework)' );
742     is( @$notes, 7, 'No more notes' );
743     $notes = $biblio->get_marc_notes({ opac => 1 });
744     is( $notes->[0]->{marcnote}, 'Note1', 'First note' );
745     is( $notes->[1]->{marcnote}, 'Note2', 'Second note' );
746     is( $notes->[2]->{marcnote}, 'http://someserver.com', 'URL separated' );
747     is( $notes->[3]->{marcnote}, 'Note5', 'Fifth note shows after fourth skipped' );
748     is( $notes->[4]->{marcnote}, $av->lib_opac, 'Authorised value is correctly parsed for OPAC to show description rather than code' );
749     is( @$notes, 5, 'No more notes' );
750
751     $cache->clear_from_cache("MarcStructure-0-");
752     $cache->clear_from_cache("MarcStructure-1-");
753     $cache->clear_from_cache("MarcSubfieldStructure-");
754     $cache->clear_from_cache("MarcCodedFields-");
755
756     $schema->storage->txn_rollback;
757 };
758
759 subtest 'get_marc_notes() UNIMARC tests' => sub {
760     plan tests => 3;
761
762     $schema->storage->txn_begin;
763
764     t::lib::Mocks::mock_preference( 'NotesToHide', '310' );
765     t::lib::Mocks::mock_preference( 'marcflavour', 'UNIMARC' );
766
767     my $biblio = $builder->build_sample_biblio;
768     my $record = $biblio->metadata->record;
769     $record->append_fields(
770         MARC::Field->new( '300', '', '', a => 'Note1' ),
771         MARC::Field->new( '300', '', '', a => 'Note2' ),
772         MARC::Field->new( '310', '', '', a => 'Note3 skipped' ),
773     );
774     C4::Biblio::ModBiblio( $record, $biblio->biblionumber );
775     $biblio = Koha::Biblios->find( $biblio->biblionumber);
776     my $notes = $biblio->get_marc_notes({ marcflavour => 'UNIMARC' });
777     is( $notes->[0]->{marcnote}, 'Note1', 'First note' );
778     is( $notes->[1]->{marcnote}, 'Note2', 'Second note' );
779     is( @$notes, 2, 'No more notes' );
780
781     t::lib::Mocks::mock_preference( 'marcflavour', 'MARC21' );
782     $schema->storage->txn_rollback;
783 };
784
785 subtest 'host_items() tests' => sub {
786     plan tests => 7;
787
788     $schema->storage->txn_begin;
789
790     my $biblio = $builder->build_sample_biblio( { frameworkcode => '' } );
791
792     t::lib::Mocks::mock_preference( 'EasyAnalyticalRecords', 1 );
793     my $host_items = $biblio->host_items;
794     is( ref($host_items),   'Koha::Items' );
795     is( $host_items->count, 0 );
796
797     my $item_1 =
798       $builder->build_sample_item( { biblionumber => $biblio->biblionumber } );
799     my $host_item_1 = $builder->build_sample_item;
800     my $host_item_2 = $builder->build_sample_item;
801
802     my $record = $biblio->metadata->record;
803     $record->append_fields(
804         MARC::Field->new(
805             '773', '', '',
806             9 => $host_item_1->itemnumber,
807             9 => $host_item_2->itemnumber
808         ),
809     );
810     C4::Biblio::ModBiblio( $record, $biblio->biblionumber );
811     $biblio = $biblio->get_from_storage;
812     $host_items = $biblio->host_items;
813     is( $host_items->count, 2 );
814     is_deeply( [ $host_items->get_column('itemnumber') ],
815         [ $host_item_1->itemnumber, $host_item_2->itemnumber ] );
816
817     t::lib::Mocks::mock_preference( 'EasyAnalyticalRecords', 0 );
818     $host_items = $biblio->host_items;
819     is( ref($host_items),   'Koha::Items' );
820     is( $host_items->count, 0 );
821
822     subtest 'test host_items param in items()' => sub {
823         plan tests => 4;
824
825         my $items = $biblio->items;
826         is( $items->count, 1, "Without host_items param we only get the items on the biblio");
827         $items = $biblio->items({ host_items => 1 });
828         is( $items->count, 3, "With param host_items we get the biblio items plus analytics");
829         is( ref($items), 'Koha::Items', "We correctly get an Items object");
830         is_deeply( [ $items->get_column('itemnumber') ],
831             [ $item_1->itemnumber, $host_item_1->itemnumber, $host_item_2->itemnumber ] );
832     };
833
834     $schema->storage->txn_rollback;
835 };
836
837 subtest 'article_requests() tests' => sub {
838
839     plan tests => 3;
840
841     $schema->storage->txn_begin;
842
843     my $item   = $builder->build_sample_item;
844     my $biblio = $item->biblio;
845
846     my $article_requests = $biblio->article_requests;
847     is( ref($article_requests), 'Koha::ArticleRequests',
848         'In scalar context, type is correct' );
849     is( $article_requests->count, 0, 'No article requests' );
850
851     foreach my $i ( 0 .. 3 ) {
852
853         my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
854
855         Koha::ArticleRequest->new(
856             {
857                 borrowernumber => $patron->id,
858                 biblionumber   => $biblio->id,
859                 itemnumber     => $item->id,
860                 title          => $biblio->title,
861             }
862         )->request;
863     }
864
865     $article_requests = $biblio->article_requests;
866     is( $article_requests->count, 4, '4 article requests' );
867
868     $schema->storage->txn_rollback;
869 };
870
871 subtest 'current_checkouts() and old_checkouts() tests' => sub {
872
873     plan tests => 4;
874
875     $schema->storage->txn_begin;
876
877     my $library = $builder->build_object({ class => 'Koha::Libraries' });
878
879     my $patron_1 = $builder->build_object({ class => 'Koha::Patrons' })->unblessed;
880     my $patron_2 = $builder->build_object({ class => 'Koha::Patrons' })->unblessed;
881
882     my $item_1 = $builder->build_sample_item;
883     my $item_2 = $builder->build_sample_item({ biblionumber => $item_1->biblionumber });
884
885     t::lib::Mocks::mock_userenv({ branchcode => $library->id });
886
887     AddIssue( $patron_1, $item_1->barcode );
888     AddIssue( $patron_1, $item_2->barcode );
889
890     AddReturn( $item_1->barcode );
891     AddIssue( $patron_2, $item_1->barcode );
892
893     my $biblio = $item_1->biblio;
894     my $current_checkouts = $biblio->current_checkouts;
895     my $old_checkouts = $biblio->old_checkouts;
896
897     is( ref($current_checkouts), 'Koha::Checkouts', 'Type is correct' );
898     is( ref($old_checkouts), 'Koha::Old::Checkouts', 'Type is correct' );
899
900     is( $current_checkouts->count, 2, 'Count is correct for current checkouts' );
901     is( $old_checkouts->count, 1, 'Count is correct for old checkouts' );
902
903     $schema->storage->txn_rollback;
904 };
905
906 subtest 'get_marc_contributors() tests' => sub {
907
908     plan tests => 2;
909
910     $schema->storage->txn_begin;
911
912     my $biblio = $builder->build_sample_biblio({ author => 'Main author' });
913     my $record = $biblio->metadata->record;
914
915     # add author information
916     my $field = MARC::Field->new('700','1','','a' => 'Jefferson, Thomas');
917     $record->append_fields($field);
918     $field = MARC::Field->new('701','1','','d' => 'Secondary author 2');
919     $record->append_fields($field);
920
921     # get record
922     C4::Biblio::ModBiblio( $record, $biblio->biblionumber );
923     $biblio = Koha::Biblios->find( $biblio->biblionumber );
924
925     is( @{$biblio->get_marc_authors}, 3, 'get_marc_authors retrieves correct number of author subfields' );
926     is( @{$biblio->get_marc_contributors}, 2, 'get_marc_contributors retrieves correct number of author subfields' );
927     $schema->storage->txn_rollback;
928 };
929
930 subtest 'Recalls tests' => sub {
931
932     plan tests => 13;
933
934     $schema->storage->txn_begin;
935
936     my $item1 = $builder->build_sample_item;
937     my $biblio = $item1->biblio;
938     my $branchcode = $item1->holdingbranch;
939     my $patron1 = $builder->build_object({ class => 'Koha::Patrons', value => { branchcode => $branchcode } });
940     my $patron2 = $builder->build_object({ class => 'Koha::Patrons', value => { branchcode => $branchcode } });
941     my $patron3 = $builder->build_object({ class => 'Koha::Patrons', value => { branchcode => $branchcode } });
942     my $item2 = $builder->build_object({ class => 'Koha::Items', value => { holdingbranch => $branchcode, homebranch => $branchcode, biblionumber => $biblio->biblionumber, itype => $item1->effective_itemtype } });
943     t::lib::Mocks::mock_userenv({ patron => $patron1 });
944
945     my $recall1 = Koha::Recall->new(
946         {   patron_id         => $patron1->borrowernumber,
947             created_date      => \'NOW()',
948             biblio_id         => $biblio->biblionumber,
949             pickup_library_id => $branchcode,
950             item_id           => $item1->itemnumber,
951             expiration_date   => undef,
952             item_level        => 1
953         }
954     )->store;
955     my $recall2 = Koha::Recall->new(
956         {   patron_id         => $patron2->borrowernumber,
957             created_date      => \'NOW()',
958             biblio_id         => $biblio->biblionumber,
959             pickup_library_id => $branchcode,
960             item_id           => undef,
961             expiration_date   => undef,
962             item_level        => 0
963         }
964     )->store;
965     my $recall3 = Koha::Recall->new(
966         {   patron_id         => $patron3->borrowernumber,
967             created_date      => \'NOW()',
968             biblio_id         => $biblio->biblionumber,
969             pickup_library_id => $branchcode,
970             item_id           => $item1->itemnumber,
971             expiration_date   => undef,
972             item_level        => 1
973         }
974     )->store;
975
976     my $recalls = $biblio->recalls;
977     is( $recalls->count, 3, 'Correctly get number of recalls for biblio' );
978
979     $recall1->set_cancelled;
980     $recall2->set_expired({ interface => 'COMMANDLINE' });
981
982     is( $recalls->count, 3, 'Correctly get number of recalls for biblio' );
983     is( $recalls->filter_by_current->count, 1, 'Correctly get number of active recalls for biblio' );
984
985     t::lib::Mocks::mock_preference('UseRecalls', 0);
986     is( $biblio->can_be_recalled({ patron => $patron1 }), 0, "Can't recall with UseRecalls disabled" );
987
988     t::lib::Mocks::mock_preference("UseRecalls", 1);
989     $item1->update({ notforloan => 1 });
990     is( $biblio->can_be_recalled({ patron => $patron1 }), 0, "Can't recall with no available items" );
991
992     $item1->update({ notforloan => 0 });
993     Koha::CirculationRules->set_rules({
994         branchcode => $branchcode,
995         categorycode => $patron1->categorycode,
996         itemtype => $item1->effective_itemtype,
997         rules => {
998             recalls_allowed => 0,
999             recalls_per_record => 1,
1000             on_shelf_recalls => 'all',
1001         },
1002     });
1003     is( $biblio->can_be_recalled({ patron => $patron1 }), 0, "Can't recall if recalls_allowed = 0" );
1004
1005     Koha::CirculationRules->set_rules({
1006         branchcode => $branchcode,
1007         categorycode => $patron1->categorycode,
1008         itemtype => $item1->effective_itemtype,
1009         rules => {
1010             recalls_allowed => 1,
1011             recalls_per_record => 1,
1012             on_shelf_recalls => 'all',
1013         },
1014     });
1015     is( $biblio->can_be_recalled({ patron => $patron1 }), 0, "Can't recall if patron has more existing recall(s) than recalls_allowed" );
1016     is( $biblio->can_be_recalled({ patron => $patron1 }), 0, "Can't recall if patron has more existing recall(s) than recalls_per_record" );
1017
1018     $recall1->set_cancelled;
1019     C4::Circulation::AddIssue( $patron1->unblessed, $item2->barcode );
1020     is( $biblio->can_be_recalled({ patron => $patron1 }), 0, "Can't recall if patron has already checked out an item attached to this biblio" );
1021
1022     is( $biblio->can_be_recalled({ patron => $patron1 }), 0, "Can't recall if on_shelf_recalls = all and items are still available" );
1023
1024     Koha::CirculationRules->set_rules({
1025         branchcode => $branchcode,
1026         categorycode => $patron1->categorycode,
1027         itemtype => $item1->effective_itemtype,
1028         rules => {
1029             recalls_allowed => 1,
1030             recalls_per_record => 1,
1031             on_shelf_recalls => 'any',
1032         },
1033     });
1034     C4::Circulation::AddReturn( $item2->barcode, $branchcode );
1035     is( $biblio->can_be_recalled({ patron => $patron1 }), 0, "Can't recall if no items are checked out" );
1036
1037     $recall2->set_cancelled;
1038     C4::Circulation::AddIssue( $patron2->unblessed, $item2->barcode );
1039     C4::Circulation::AddIssue( $patron2->unblessed, $item1->barcode );
1040     is( $biblio->can_be_recalled({ patron => $patron1 }), 2, "Can recall two items" );
1041
1042     $item1->update({ withdrawn => 1 });
1043     is( $biblio->can_be_recalled({ patron => $patron1 }), 1, "Can recall one item" );
1044
1045     $schema->storage->txn_rollback;
1046 };
1047
1048 subtest 'ill_requests() tests' => sub {
1049
1050     plan tests => 3;
1051
1052     $schema->storage->txn_begin;
1053
1054     my $biblio = $builder->build_sample_biblio;
1055
1056     my $rs = $biblio->ill_requests;
1057     is( ref($rs), 'Koha::Illrequests' );
1058     is( $rs->count, 0, 'No linked requests' );
1059
1060     foreach ( 1..10 ) {
1061         $builder->build_object(
1062             {
1063                 class => 'Koha::Illrequests',
1064                 value => { biblio_id => $biblio->id }
1065             }
1066         );
1067     }
1068
1069     is( $biblio->ill_requests->count, 10, 'Linked requests are present' );
1070
1071     $schema->storage->txn_rollback;
1072 };
1073
1074 subtest 'item_groups() tests' => sub {
1075
1076     plan tests => 6;
1077
1078     $schema->storage->txn_begin;
1079
1080     my $biblio = $builder->build_sample_biblio();
1081
1082     my @item_groups = $biblio->item_groups->as_list;
1083     is( scalar(@item_groups), 0, 'Got zero item groups');
1084
1085     my $item_group_1 = Koha::Biblio::ItemGroup->new( { biblio_id => $biblio->id } )->store();
1086
1087     @item_groups = $biblio->item_groups->as_list;
1088     is( scalar(@item_groups), 1, 'Got one item group');
1089     is( $item_groups[0]->id, $item_group_1->id, 'Got correct item group');
1090
1091     my $item_group_2 = Koha::Biblio::ItemGroup->new( { biblio_id => $biblio->id } )->store();
1092
1093     @item_groups = $biblio->item_groups->as_list;
1094     is( scalar(@item_groups), 2, 'Got two item groups');
1095     is( $item_groups[0]->id, $item_group_1->id, 'Got correct item group 1');
1096     is( $item_groups[1]->id, $item_group_2->id, 'Got correct item group 2');
1097
1098     $schema->storage->txn_rollback;
1099 };
1100
1101 sub component_record1 {
1102     my $marc = MARC::Record->new;
1103     $marc->append_fields(
1104         MARC::Field->new( '001', '3456' ),
1105         MARC::Field->new( '245', '', '', a => 'Some title 1' ),
1106         MARC::Field->new( '773', '', '', w => '(FIRST)1234' ),
1107     );
1108     return $marc;
1109 }
1110 sub search_component_record1 {
1111     my @results = ( component_record1()->as_xml() );
1112     return ( undef, { biblioserver => { RECORDS => \@results, hits => 1 } }, 1 );
1113 }
1114
1115 sub search_component_record2 {
1116     my @results;
1117     return ( undef, { biblioserver => { RECORDS => \@results, hits => 0 } }, 0 );
1118 }
1119
1120 sub host_record {
1121     my $marc = MARC::Record->new;
1122     $marc->append_fields(
1123         MARC::Field->new( '001', '1234' ),
1124         MARC::Field->new( '003', 'FIRST' ),
1125         MARC::Field->new( '245', '', '', a => 'Some title' ),
1126     );
1127     return $marc;
1128 }