3 # Copyright ByWater Solutions 2014
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use List::MoreUtils qw(any);
31 use Koha::DateUtils qw( dt_from_string );
33 use base qw(Koha::Object);
35 use Koha::Acquisition::Orders;
36 use Koha::ArticleRequest::Status;
37 use Koha::ArticleRequests;
38 use Koha::Biblio::Metadatas;
39 use Koha::Biblioitems;
40 use Koha::CirculationRules;
41 use Koha::Item::Transfer::Limits;
44 use Koha::Suggestions;
45 use Koha::Subscriptions;
49 Koha::Biblio - Koha Biblio Object class
59 Overloaded I<store> method to set default values
66 $self->datecreated( dt_from_string ) unless $self->datecreated;
68 return $self->SUPER::store;
73 my $metadata = $biblio->metadata();
75 Returns a Koha::Biblio::Metadata object
82 my $metadata = $self->_result->metadata;
83 return Koha::Biblio::Metadata->_new_from_dbic($metadata);
88 my $orders = $biblio->orders();
90 Returns a Koha::Acquisition::Orders object
97 my $orders = $self->_result->orders;
98 return Koha::Acquisition::Orders->_new_from_dbic($orders);
103 my $active_orders = $biblio->active_orders();
105 Returns the active acquisition orders related to this biblio.
106 An order is considered active when it is not cancelled (i.e. when datecancellation
114 return $self->orders->search({ datecancellationprinted => undef });
117 =head3 can_article_request
119 my $bool = $biblio->can_article_request( $borrower );
121 Returns true if article requests can be made for this record
123 $borrower must be a Koha::Patron object
127 sub can_article_request {
128 my ( $self, $borrower ) = @_;
130 my $rule = $self->article_request_type($borrower);
131 return q{} if $rule eq 'item_only' && !$self->items()->count();
132 return 1 if $rule && $rule ne 'no';
137 =head3 can_be_transferred
139 $biblio->can_be_transferred({ to => $to_library, from => $from_library })
141 Checks if at least one item of a biblio can be transferred to given library.
143 This feature is controlled by two system preferences:
144 UseBranchTransferLimits to enable / disable the feature
145 BranchTransferLimitsType to use either an itemnumber or ccode as an identifier
146 for setting the limitations
148 Performance-wise, it is recommended to use this method for a biblio instead of
149 iterating each item of a biblio with Koha::Item->can_be_transferred().
151 Takes HASHref that can have the following parameters:
152 MANDATORY PARAMETERS:
155 $from : Koha::Library # if given, only items from that
156 # holdingbranch are considered
158 Returns 1 if at least one of the item of a biblio can be transferred
159 to $to_library, otherwise 0.
163 sub can_be_transferred {
164 my ($self, $params) = @_;
166 my $to = $params->{to};
167 my $from = $params->{from};
169 return 1 unless C4::Context->preference('UseBranchTransferLimits');
170 my $limittype = C4::Context->preference('BranchTransferLimitsType');
173 foreach my $item_of_bib ($self->items->as_list) {
174 next unless $item_of_bib->holdingbranch;
175 next if $from && $from->branchcode ne $item_of_bib->holdingbranch;
176 return 1 if $item_of_bib->holdingbranch eq $to->branchcode;
177 my $code = $limittype eq 'itemtype'
178 ? $item_of_bib->effective_itemtype
179 : $item_of_bib->ccode;
180 return 1 unless $code;
181 $items->{$code}->{$item_of_bib->holdingbranch} = 1;
184 # At this point we will have a HASHref containing each itemtype/ccode that
185 # this biblio has, inside which are all of the holdingbranches where those
186 # items are located at. Then, we will query Koha::Item::Transfer::Limits to
187 # find out whether a transfer limits for such $limittype from any of the
188 # listed holdingbranches to the given $to library exist. If at least one
189 # holdingbranch for that $limittype does not have a transfer limit to given
190 # $to library, then we know that the transfer is possible.
191 foreach my $code (keys %{$items}) {
192 my @holdingbranches = keys %{$items->{$code}};
193 return 1 if Koha::Item::Transfer::Limits->search({
194 toBranch => $to->branchcode,
195 fromBranch => { 'in' => \@holdingbranches },
198 group_by => [qw/fromBranch/]
199 })->count == scalar(@holdingbranches) ? 0 : 1;
206 =head3 pickup_locations
208 my $pickup_locations = $biblio->pickup_locations( {patron => $patron } );
210 Returns a Koha::Libraries set of possible pickup locations for this biblio's items,
211 according to patron's home library (if patron is defined and holds are allowed
212 only from hold groups) and if item can be transferred to each pickup location.
216 sub pickup_locations {
217 my ( $self, $params ) = @_;
219 my $patron = $params->{patron};
221 my @pickup_locations;
222 foreach my $item_of_bib ( $self->items->as_list ) {
223 push @pickup_locations,
224 $item_of_bib->pickup_locations( { patron => $patron } )
225 ->_resultset->get_column('branchcode')->all;
228 return Koha::Libraries->search(
229 { branchcode => { '-in' => \@pickup_locations } }, { order_by => ['branchname'] } );
232 =head3 hidden_in_opac
234 my $bool = $biblio->hidden_in_opac({ [ rules => $rules ] })
236 Returns true if the biblio matches the hidding criteria defined in $rules.
237 Returns false otherwise. It involves the I<OpacHiddenItems> and
238 I<OpacHiddenItemsHidesRecord> system preferences.
240 Takes HASHref that can have the following parameters:
242 $rules : { <field> => [ value_1, ... ], ... }
244 Note: $rules inherits its structure from the parsed YAML from reading
245 the I<OpacHiddenItems> system preference.
250 my ( $self, $params ) = @_;
252 my $rules = $params->{rules} // {};
254 my @items = $self->items->as_list;
256 return 0 unless @items; # Do not hide if there is no item
258 # Ok, there are items, don't even try the rules unless OpacHiddenItemsHidesRecord
259 return 0 unless C4::Context->preference('OpacHiddenItemsHidesRecord');
261 return !(any { !$_->hidden_in_opac({ rules => $rules }) } @items);
264 =head3 article_request_type
266 my $type = $biblio->article_request_type( $borrower );
268 Returns the article request type based on items, or on the record
269 itself if there are no items.
271 $borrower must be a Koha::Patron object
275 sub article_request_type {
276 my ( $self, $borrower ) = @_;
278 return q{} unless $borrower;
280 my $rule = $self->article_request_type_for_items( $borrower );
281 return $rule if $rule;
283 # If the record has no items that are requestable, go by the record itemtype
284 $rule = $self->article_request_type_for_bib($borrower);
285 return $rule if $rule;
290 =head3 article_request_type_for_bib
292 my $type = $biblio->article_request_type_for_bib
294 Returns the article request type 'yes', 'no', 'item_only', 'bib_only', for the given record
298 sub article_request_type_for_bib {
299 my ( $self, $borrower ) = @_;
301 return q{} unless $borrower;
303 my $borrowertype = $borrower->categorycode;
304 my $itemtype = $self->itemtype();
306 my $rule = Koha::CirculationRules->get_effective_rule(
308 rule_name => 'article_requests',
309 categorycode => $borrowertype,
310 itemtype => $itemtype,
314 return q{} unless $rule;
315 return $rule->rule_value || q{}
318 =head3 article_request_type_for_items
320 my $type = $biblio->article_request_type_for_items
322 Returns the article request type 'yes', 'no', 'item_only', 'bib_only', for the given record's items
324 If there is a conflict where some items are 'bib_only' and some are 'item_only', 'bib_only' will be returned.
328 sub article_request_type_for_items {
329 my ( $self, $borrower ) = @_;
332 foreach my $item ( $self->items()->as_list() ) {
333 my $rule = $item->article_request_type($borrower);
334 return $rule if $rule eq 'bib_only'; # we don't need to go any further
338 return 'item_only' if $counts->{item_only};
339 return 'yes' if $counts->{yes};
340 return 'no' if $counts->{no};
344 =head3 article_requests
346 my @requests = $biblio->article_requests
348 Returns the article requests associated with this Biblio
352 sub article_requests {
353 my ( $self, $borrower ) = @_;
355 $self->{_article_requests} ||= Koha::ArticleRequests->search( { biblionumber => $self->biblionumber() } );
357 return wantarray ? $self->{_article_requests}->as_list : $self->{_article_requests};
360 =head3 article_requests_current
362 my @requests = $biblio->article_requests_current
364 Returns the article requests associated with this Biblio that are incomplete
368 sub article_requests_current {
369 my ( $self, $borrower ) = @_;
371 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
373 biblionumber => $self->biblionumber(),
375 { status => Koha::ArticleRequest::Status::Pending },
376 { status => Koha::ArticleRequest::Status::Processing }
381 return wantarray ? $self->{_article_requests_current}->as_list : $self->{_article_requests_current};
384 =head3 article_requests_finished
386 my @requests = $biblio->article_requests_finished
388 Returns the article requests associated with this Biblio that are completed
392 sub article_requests_finished {
393 my ( $self, $borrower ) = @_;
395 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
397 biblionumber => $self->biblionumber(),
399 { status => Koha::ArticleRequest::Status::Completed },
400 { status => Koha::ArticleRequest::Status::Canceled }
405 return wantarray ? $self->{_article_requests_finished}->as_list : $self->{_article_requests_finished};
410 my $items = $biblio->items();
412 Returns the related Koha::Items object for this biblio
419 my $items_rs = $self->_result->items;
421 return Koha::Items->_new_from_dbic( $items_rs );
426 my $itemtype = $biblio->itemtype();
428 Returns the itemtype for this record.
435 return $self->biblioitem()->itemtype();
440 my $holds = $biblio->holds();
442 return the current holds placed on this record
447 my ( $self, $params, $attributes ) = @_;
448 $attributes->{order_by} = 'priority' unless exists $attributes->{order_by};
449 my $hold_rs = $self->_result->reserves->search( $params, $attributes );
450 return Koha::Holds->_new_from_dbic($hold_rs);
455 my $holds = $biblio->current_holds
457 Return the holds placed on this bibliographic record.
458 It does not include future holds.
464 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
466 { reservedate => { '<=' => $dtf->format_date(dt_from_string) } } );
471 my $field = $self->biblioitem()->itemtype
473 Returns the related Koha::Biblioitem object for this Biblio object
480 $self->{_biblioitem} ||= Koha::Biblioitems->find( { biblionumber => $self->biblionumber() } );
482 return $self->{_biblioitem};
487 my $suggestions = $self->suggestions
489 Returns the related Koha::Suggestions object for this Biblio object
496 my $suggestions_rs = $self->_result->suggestions;
497 return Koha::Suggestions->_new_from_dbic( $suggestions_rs );
502 my $subscriptions = $self->subscriptions
504 Returns the related Koha::Subscriptions object for this Biblio object
511 $self->{_subscriptions} ||= Koha::Subscriptions->search( { biblionumber => $self->biblionumber } );
513 return $self->{_subscriptions};
516 =head3 has_items_waiting_or_intransit
518 my $itemsWaitingOrInTransit = $biblio->has_items_waiting_or_intransit
520 Tells if this bibliographic record has items waiting or in transit.
524 sub has_items_waiting_or_intransit {
527 if ( Koha::Holds->search({ biblionumber => $self->id,
528 found => ['W', 'T'] })->count ) {
532 foreach my $item ( $self->items->as_list ) {
533 return 1 if $item->get_transfer;
541 my $coins = $biblio->get_coins;
543 Returns the COinS (a span) which can be included in a biblio record
550 my $record = $self->metadata->record;
552 my $pos7 = substr $record->leader(), 7, 1;
553 my $pos6 = substr $record->leader(), 6, 1;
556 my ( $aulast, $aufirst ) = ( '', '' );
567 # For the purposes of generating COinS metadata, LDR/06-07 can be
568 # considered the same for UNIMARC and MARC21
577 'i' => 'audioRecording',
578 'j' => 'audioRecording',
581 'm' => 'computerProgram',
586 'a' => 'journalArticle',
590 $genre = $fmts6->{$pos6} ? $fmts6->{$pos6} : 'book';
592 if ( $genre eq 'book' ) {
593 $genre = $fmts7->{$pos7} if $fmts7->{$pos7};
596 ##### We must transform mtx to a valable mtx and document type ####
597 if ( $genre eq 'book' ) {
600 } elsif ( $genre eq 'journal' ) {
603 } elsif ( $genre eq 'journalArticle' ) {
611 if ( C4::Context->preference("marcflavour") eq "UNIMARC" ) {
614 $aulast = $record->subfield( '700', 'a' ) || '';
615 $aufirst = $record->subfield( '700', 'b' ) || '';
616 push @authors, "$aufirst $aulast" if ($aufirst or $aulast);
619 if ( $record->field('200') ) {
620 for my $au ( $record->field('200')->subfield('g') ) {
625 $title = $record->subfield( '200', 'a' );
626 my $subfield_210d = $record->subfield('210', 'd');
627 if ($subfield_210d and $subfield_210d =~ /(\d{4})/) {
630 $publisher = $record->subfield( '210', 'c' ) || '';
631 $isbn = $record->subfield( '010', 'a' ) || '';
632 $issn = $record->subfield( '011', 'a' ) || '';
635 # MARC21 need some improve
638 if ( $record->field('100') ) {
639 push @authors, $record->subfield( '100', 'a' );
643 if ( $record->field('700') ) {
644 for my $au ( $record->field('700')->subfield('a') ) {
648 $title = $record->field('245');
649 $title &&= $title->as_string('ab');
650 if ($titletype eq 'a') {
651 $pubyear = $record->field('008') || '';
652 $pubyear = substr($pubyear->data(), 7, 4) if $pubyear;
653 $isbn = $record->subfield( '773', 'z' ) || '';
654 $issn = $record->subfield( '773', 'x' ) || '';
655 $hosttitle = $record->subfield( '773', 't' ) || $record->subfield( '773', 'a') || q{};
656 my @rels = $record->subfield( '773', 'g' );
657 $pages = join(', ', @rels);
659 $pubyear = $record->subfield( '260', 'c' ) || '';
660 $publisher = $record->subfield( '260', 'b' ) || '';
661 $isbn = $record->subfield( '020', 'a' ) || '';
662 $issn = $record->subfield( '022', 'a' ) || '';
668 [ 'ctx_ver', 'Z39.88-2004' ],
669 [ 'rft_val_fmt', "info:ofi/fmt:kev:mtx:$mtx" ],
670 [ ($mtx eq 'dc' ? 'rft.type' : 'rft.genre'), $genre ],
671 [ "rft.${titletype}title", $title ],
674 # rft.title is authorized only once, so by checking $titletype
675 # we ensure that rft.title is not already in the list.
676 if ($hosttitle and $titletype) {
677 push @params, [ 'rft.title', $hosttitle ];
681 [ 'rft.isbn', $isbn ],
682 [ 'rft.issn', $issn ],
685 # If it's a subscription, these informations have no meaning.
686 if ($genre ne 'journal') {
688 [ 'rft.aulast', $aulast ],
689 [ 'rft.aufirst', $aufirst ],
690 (map { [ 'rft.au', $_ ] } @authors),
691 [ 'rft.pub', $publisher ],
692 [ 'rft.date', $pubyear ],
693 [ 'rft.pages', $pages ],
697 my $coins_value = join( '&',
698 map { $$_[1] ? $$_[0] . '=' . uri_escape_utf8( $$_[1] ) : () } @params );
705 my $url = $biblio->get_openurl;
707 Returns url for OpenURL resolver set in OpenURLResolverURL system preference
714 my $OpenURLResolverURL = C4::Context->preference('OpenURLResolverURL');
716 if ($OpenURLResolverURL) {
717 my $uri = URI->new($OpenURLResolverURL);
719 if (not defined $uri->query) {
720 $OpenURLResolverURL .= '?';
722 $OpenURLResolverURL .= '&';
724 $OpenURLResolverURL .= $self->get_coins;
727 return $OpenURLResolverURL;
732 my $serial = $biblio->is_serial
734 Return boolean true if this bibbliographic record is continuing resource
741 return 1 if $self->serial;
743 my $record = $self->metadata->record;
744 return 1 if substr($record->leader, 7, 1) eq 's';
749 =head3 custom_cover_image_url
751 my $image_url = $biblio->custom_cover_image_url
753 Return the specific url of the cover image for this bibliographic record.
754 It is built regaring the value of the system preference CustomCoverImagesURL
758 sub custom_cover_image_url {
760 my $url = C4::Context->preference('CustomCoverImagesURL');
761 if ( $url =~ m|{isbn}| ) {
762 my $isbn = $self->biblioitem->isbn;
764 $url =~ s|{isbn}|$isbn|g;
766 if ( $url =~ m|{normalized_isbn}| ) {
767 my $normalized_isbn = C4::Koha::GetNormalizedISBN($self->biblioitem->isbn);
768 return unless $normalized_isbn;
769 $url =~ s|{normalized_isbn}|$normalized_isbn|g;
771 if ( $url =~ m|{issn}| ) {
772 my $issn = $self->biblioitem->issn;
774 $url =~ s|{issn}|$issn|g;
777 my $re = qr|{(?<field>\d{3})\$(?<subfield>.)}|;
779 my $field = $+{field};
780 my $subfield = $+{subfield};
781 my $marc_record = $self->metadata->record;
782 my $value = $marc_record->subfield($field, $subfield);
783 return unless $value;
784 $url =~ s|$re|$value|;
792 Return the cover images associated with this biblio.
799 my $cover_images_rs = $self->_result->cover_images;
800 return unless $cover_images_rs;
801 return Koha::CoverImages->_new_from_dbic($cover_images_rs);
804 =head3 get_marc_notes
806 $marcnotesarray = $biblio->get_marc_notes({ marcflavour => $marcflavour });
808 Get all notes from the MARC record and returns them in an array.
809 The notes are stored in different fields depending on MARC flavour.
810 MARC21 5XX $u subfields receive special attention as they are URIs.
815 my ( $self, $params ) = @_;
817 my $marcflavour = $params->{marcflavour};
818 my $opac = $params->{opac};
820 my $scope = $marcflavour eq "UNIMARC"? '3..': '5..';
823 #MARC21 specs indicate some notes should be private if first indicator 0
824 my %maybe_private = (
832 my %hiddenlist = map { $_ => 1 }
833 split( /,/, C4::Context->preference('NotesToHide'));
834 foreach my $field ( $self->metadata->record->field($scope) ) {
835 my $tag = $field->tag();
836 next if $hiddenlist{ $tag };
837 next if $opac && $maybe_private{$tag} && !$field->indicator(1);
838 if( $marcflavour ne 'UNIMARC' && $field->subfield('u') ) {
839 # Field 5XX$u always contains URI
840 # Examples: 505u, 506u, 510u, 514u, 520u, 530u, 538u, 540u, 542u, 552u, 555u, 561u, 563u, 583u
841 # We first push the other subfields, then all $u's separately
842 # Leave further actions to the template (see e.g. opac-detail)
844 join '', ( 'a' .. 't', 'v' .. 'z', '0' .. '9' ); # excl 'u'
845 push @marcnotes, { marcnote => $field->as_string($othersub) };
846 foreach my $sub ( $field->subfield('u') ) {
847 $sub =~ s/^\s+|\s+$//g; # trim
848 push @marcnotes, { marcnote => $sub };
851 push @marcnotes, { marcnote => $field->as_string() };
859 my $json = $biblio->to_api;
861 Overloaded method that returns a JSON representation of the Koha::Biblio object,
862 suitable for API output. The related Koha::Biblioitem object is merged as expected
868 my ($self, $args) = @_;
870 my $response = $self->SUPER::to_api( $args );
871 my $biblioitem = $self->biblioitem->to_api;
873 return { %$response, %$biblioitem };
876 =head3 to_api_mapping
878 This method returns the mapping for representing a Koha::Biblio object
885 biblionumber => 'biblio_id',
886 frameworkcode => 'framework_id',
887 unititle => 'uniform_title',
888 seriestitle => 'series_title',
889 copyrightdate => 'copyright_date',
890 datecreated => 'creation_date'
896 $host = $biblio->host_record;
898 ( $host, $relatedparts ) = $biblio->host_record;
900 Returns host biblio record from MARC21 773 (undef if no 773 present).
901 It looks at the first 773 field with MARCorgCode or only a control
902 number. Complete $w or numeric part is used to search host record.
903 The optional parameter no_items triggers a check if $biblio has items.
904 If there are, the sub returns undef.
905 Called in list context, it also returns 773$g (related parts).
910 my ($self, $params) = @_;
911 my $no_items = $params->{no_items};
912 return if C4::Context->preference('marcflavour') eq 'UNIMARC'; # TODO
913 return if !C4::Context->preference('ArticleRequestsHostRedirection');
914 return if $params->{no_items} && $self->items->count > 0;
917 eval { $record = $self->metadata->record };
920 # We pick the first $w with your MARCOrgCode or the first $w that has no
921 # code (between parentheses) at all.
922 my $orgcode = C4::Context->preference('MARCOrgCode') // q{};
924 foreach my $f ( $record->field('773') ) {
925 my $w = $f->subfield('w') or next;
926 if( $w =~ /^\($orgcode\)\s*(\d+)/i or $w =~ /^\d+/ ) {
932 my $rcn = $hostfld->subfield('w');
934 # Look for control number with/without orgcode
935 my $engine = Koha::SearchEngine::Search->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
938 my ( $error, $results, $total_hits ) = $engine->simple_search_compat( 'Control-number='.$rcn, 0,1 );
939 if( !$error and $total_hits == 1 ) {
940 $bibno = $engine->extract_biblionumber( $results->[0] );
943 # Add or remove orgcode for second try
944 if( $try == 1 && $rcn =~ /\)\s*(\d+)/ ) {
945 $rcn = $1; # number only
946 } elsif( $try == 1 && $rcn =~ /^\d+/ ) {
947 $rcn = "($orgcode)$rcn";
953 my $host = Koha::Biblios->find($bibno) or return;
954 return wantarray ? ( $host, $hostfld->subfield('g') ) : $host;
958 =head2 Internal methods
970 Kyle M Hall <kyle@bywatersolutions.com>