Bug 29915: Add selenium tests
[srvgit] / Koha / Biblio.pm
index 12b22d9..4022819 100644 (file)
@@ -19,13 +19,12 @@ package Koha::Biblio;
 
 use Modern::Perl;
 
-use Carp;
-use List::MoreUtils qw(any);
+use List::MoreUtils qw( any );
 use URI;
-use URI::Escape;
+use URI::Escape qw( uri_escape_utf8 );
 
-use C4::Koha;
-use C4::Biblio qw();
+use C4::Koha qw( GetNormalizedISBN );
+use C4::XSLT qw( transformMARCXML4XSLT );
 
 use Koha::Database;
 use Koha::DateUtils qw( dt_from_string );
@@ -33,16 +32,21 @@ use Koha::DateUtils qw( dt_from_string );
 use base qw(Koha::Object);
 
 use Koha::Acquisition::Orders;
-use Koha::ArticleRequest::Status;
 use Koha::ArticleRequests;
 use Koha::Biblio::Metadatas;
 use Koha::Biblioitems;
+use Koha::Checkouts;
 use Koha::CirculationRules;
 use Koha::Item::Transfer::Limits;
 use Koha::Items;
 use Koha::Libraries;
+use Koha::Old::Checkouts;
+use Koha::Recalls;
 use Koha::Suggestions;
 use Koha::Subscriptions;
+use Koha::SearchEngine;
+use Koha::SearchEngine::Search;
+use Koha::SearchEngine::QueryBuilder;
 
 =head1 NAME
 
@@ -343,66 +347,46 @@ sub article_request_type_for_items {
 
 =head3 article_requests
 
-my @requests = $biblio->article_requests
+    my $article_requests = $biblio->article_requests
 
-Returns the article requests associated with this Biblio
+Returns the article requests associated with this biblio
 
 =cut
 
 sub article_requests {
-    my ( $self, $borrower ) = @_;
-
-    $self->{_article_requests} ||= Koha::ArticleRequests->search( { biblionumber => $self->biblionumber() } );
+    my ( $self ) = @_;
 
-    return wantarray ? $self->{_article_requests}->as_list : $self->{_article_requests};
+    return Koha::ArticleRequests->_new_from_dbic( scalar $self->_result->article_requests );
 }
 
-=head3 article_requests_current
+=head3 current_checkouts
 
-my @requests = $biblio->article_requests_current
+    my $current_checkouts = $biblio->current_checkouts
 
-Returns the article requests associated with this Biblio that are incomplete
+Returns the current checkouts associated with this biblio
 
 =cut
 
-sub article_requests_current {
-    my ( $self, $borrower ) = @_;
-
-    $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
-        {
-            biblionumber => $self->biblionumber(),
-            -or          => [
-                { status => Koha::ArticleRequest::Status::Pending },
-                { status => Koha::ArticleRequest::Status::Processing }
-            ]
-        }
-    );
+sub current_checkouts {
+    my ($self) = @_;
 
-    return wantarray ? $self->{_article_requests_current}->as_list : $self->{_article_requests_current};
+    return Koha::Checkouts->search( { "item.biblionumber" => $self->id },
+        { join => 'item' } );
 }
 
-=head3 article_requests_finished
+=head3 old_checkouts
 
-my @requests = $biblio->article_requests_finished
+    my $old_checkouts = $biblio->old_checkouts
 
-Returns the article requests associated with this Biblio that are completed
+Returns the past checkouts associated with this biblio
 
 =cut
 
-sub article_requests_finished {
-    my ( $self, $borrower ) = @_;
-
-    $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
-        {
-            biblionumber => $self->biblionumber(),
-            -or          => [
-                { status => Koha::ArticleRequest::Status::Completed },
-                { status => Koha::ArticleRequest::Status::Canceled }
-            ]
-        }
-    );
+sub old_checkouts {
+    my ( $self ) = @_;
 
-    return wantarray ? $self->{_article_requests_finished}->as_list : $self->{_article_requests_finished};
+    return Koha::Old::Checkouts->search( { "item.biblionumber" => $self->id },
+        { join => 'item' } );
 }
 
 =head3 items
@@ -421,6 +405,37 @@ sub items {
     return Koha::Items->_new_from_dbic( $items_rs );
 }
 
+=head3 host_items
+
+my $host_items = $biblio->host_items();
+
+Return the host items (easy analytical record)
+
+=cut
+
+sub host_items {
+    my ($self) = @_;
+
+    return Koha::Items->new->empty
+      unless C4::Context->preference('EasyAnalyticalRecords');
+
+    my $marcflavour = C4::Context->preference("marcflavour");
+    my $analyticfield = '773';
+    if ( $marcflavour eq 'MARC21' ) {
+        $analyticfield = '773';
+    }
+    elsif ( $marcflavour eq 'UNIMARC' ) {
+        $analyticfield = '461';
+    }
+    my $marc_record = $self->metadata->record;
+    my @itemnumbers;
+    foreach my $field ( $marc_record->field($analyticfield) ) {
+        push @itemnumbers, $field->subfield('9');
+    }
+
+    return Koha::Items->search( { itemnumber => { -in => \@itemnumbers } } );
+}
+
 =head3 itemtype
 
 my $itemtype = $biblio->itemtype();
@@ -497,6 +512,95 @@ sub suggestions {
     return Koha::Suggestions->_new_from_dbic( $suggestions_rs );
 }
 
+=head3 get_marc_components
+
+  my $components = $self->get_marc_components();
+
+Returns an array of MARCXML data, which are component parts of
+this object (MARC21 773$w points to this)
+
+=cut
+
+sub get_marc_components {
+    my ($self, $max_results) = @_;
+
+    return [] if (C4::Context->preference('marcflavour') ne 'MARC21');
+
+    my $searchstr = $self->get_components_query;
+
+    my $components;
+    if (defined($searchstr)) {
+        my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
+        my ( $error, $results, $total_hits );
+        eval {
+            ( $error, $results, $total_hits ) = $searcher->simple_search_compat( $searchstr, 0, $max_results );
+        };
+        if( $error || $@ ) {
+            $error //= q{};
+            $error .= $@ if $@;
+            warn "Warning from simple_search_compat: '$error'";
+            $self->add_message(
+                {
+                    type    => 'error',
+                    message => 'component_search',
+                    payload => $error,
+                }
+            );
+        }
+        $components = $results if defined($results) && @$results;
+    }
+
+    return $components // [];
+}
+
+=head2 get_components_query
+
+Returns a query which can be used to search for all component parts of MARC21 biblios
+
+=cut
+
+sub get_components_query {
+    my ($self) = @_;
+
+    my $builder = Koha::SearchEngine::QueryBuilder->new(
+        { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
+    my $marc = $self->metadata->record;
+
+    my $searchstr;
+    if ( C4::Context->preference('UseControlNumber') ) {
+        my $pf001 = $marc->field('001') || undef;
+
+        if ( defined($pf001) ) {
+            $searchstr = "(";
+            my $pf003 = $marc->field('003') || undef;
+
+            if ( !defined($pf003) ) {
+                # search for 773$w='Host001'
+                $searchstr .= "rcn:" . $pf001->data();
+            }
+            else {
+                $searchstr .= "(";
+                # search for (773$w='Host001' and 003='Host003') or 773$w='(Host003)Host001'
+                $searchstr .= "(rcn:" . $pf001->data() . " AND cni:" . $pf003->data() . ")";
+                $searchstr .= " OR rcn:\"" . $pf003->data() . " " . $pf001->data() . "\"";
+                $searchstr .= ")";
+            }
+
+            # limit to monograph and serial component part records
+            $searchstr .= " AND (bib-level:a OR bib-level:b)";
+            $searchstr .= ")";
+        }
+    }
+    else {
+        my $cleaned_title = $marc->subfield('245', "a");
+        $cleaned_title =~ tr|/||;
+        $cleaned_title = $builder->clean_search_term($cleaned_title);
+        $searchstr = "Host-item:($cleaned_title)";
+    }
+
+    return $searchstr;
+}
+
 =head3 subscriptions
 
 my $subscriptions = $self->subscriptions
@@ -774,12 +878,18 @@ sub custom_cover_image_url {
         $url =~ s|{issn}|$issn|g;
     }
 
-    my $re = qr|{(?<field>\d{3})\$(?<subfield>.)}|;
+    my $re = qr|{(?<field>\d{3})(\$(?<subfield>.))?}|;
     if ( $url =~ $re ) {
         my $field = $+{field};
         my $subfield = $+{subfield};
         my $marc_record = $self->metadata->record;
-        my $value = $marc_record->subfield($field, $subfield);
+        my $value;
+        if ( $subfield ) {
+            $value = $marc_record->subfield( $field, $subfield );
+        } else {
+            my $controlfield = $marc_record->field($field);
+            $value = $controlfield->data() if $controlfield;
+        }
         return unless $value;
         $url =~ s|$re|$value|;
     }
@@ -831,7 +941,10 @@ sub get_marc_notes {
 
     my %hiddenlist = map { $_ => 1 }
         split( /,/, C4::Context->preference('NotesToHide'));
-    foreach my $field ( $self->metadata->record->field($scope) ) {
+    my $record = $self->metadata->record;
+    $record = transformMARCXML4XSLT( $self->biblionumber, $record, $opac );
+
+    foreach my $field ( $record->field($scope) ) {
         my $tag = $field->tag();
         next if $hiddenlist{ $tag };
         next if $opac && $maybe_private{$tag} && !$field->indicator(1);
@@ -854,6 +967,102 @@ sub get_marc_notes {
     return \@marcnotes;
 }
 
+=head3 get_marc_authors
+
+    my $authors = $biblio->get_marc_authors;
+
+Get all authors from the MARC record and returns them in an array.
+The authors are stored in different fields depending on MARC flavour
+
+=cut
+
+sub get_marc_authors {
+    my ( $self, $params ) = @_;
+
+    my ( $mintag, $maxtag, $fields_filter );
+    my $marcflavour = C4::Context->preference('marcflavour');
+
+    # tagslib useful only for UNIMARC author responsibilities
+    my $tagslib;
+    if ( $marcflavour eq "UNIMARC" ) {
+        $tagslib = C4::Biblio::GetMarcStructure( 1, $self->frameworkcode, { unsafe => 1 });
+        $mintag = "700";
+        $maxtag = "712";
+        $fields_filter = '7..';
+    } else { # marc21/normarc
+        $mintag = "700";
+        $maxtag = "720";
+        $fields_filter = '7..';
+    }
+
+    my @marcauthors;
+    my $AuthoritySeparator = C4::Context->preference('AuthoritySeparator');
+
+    foreach my $field ( $self->metadata->record->field($fields_filter) ) {
+        next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
+        my @subfields_loop;
+        my @link_loop;
+        my @subfields  = $field->subfields();
+        my $count_auth = 0;
+
+        # if there is an authority link, build the link with Koha-Auth-Number: subfield9
+        my $subfield9 = $field->subfield('9');
+        if ($subfield9) {
+            my $linkvalue = $subfield9;
+            $linkvalue =~ s/(\(|\))//g;
+            @link_loop = ( { 'limit' => 'an', 'link' => $linkvalue } );
+        }
+
+        # other subfields
+        my $unimarc3;
+        for my $authors_subfield (@subfields) {
+            next if ( $authors_subfield->[0] eq '9' );
+
+            # unimarc3 contains the $3 of the author for UNIMARC.
+            # For french academic libraries, it's the "ppn", and it's required for idref webservice
+            $unimarc3 = $authors_subfield->[1] if $marcflavour eq 'UNIMARC' and $authors_subfield->[0] =~ /3/;
+
+            # don't load unimarc subfields 3, 5
+            next if ( $marcflavour eq 'UNIMARC' and ( $authors_subfield->[0] =~ /3|5/ ) );
+
+            my $code = $authors_subfield->[0];
+            my $value        = $authors_subfield->[1];
+            my $linkvalue    = $value;
+            $linkvalue =~ s/(\(|\))//g;
+            # UNIMARC author responsibility
+            if ( $marcflavour eq 'UNIMARC' and $code eq '4' ) {
+                $value = C4::Biblio::GetAuthorisedValueDesc( $field->tag(), $code, $value, '', $tagslib );
+                $linkvalue = "($value)";
+            }
+            # if no authority link, build a search query
+            unless ($subfield9) {
+                push @link_loop, {
+                    limit    => 'au',
+                    'link'   => $linkvalue,
+                    operator => (scalar @link_loop) ? ' AND ' : undef
+                };
+            }
+            my @this_link_loop = @link_loop;
+            # do not display $0
+            unless ( $code eq '0') {
+                push @subfields_loop, {
+                    tag       => $field->tag(),
+                    code      => $code,
+                    value     => $value,
+                    link_loop => \@this_link_loop,
+                    separator => (scalar @subfields_loop) ? $AuthoritySeparator : ''
+                };
+            }
+        }
+        push @marcauthors, {
+            MARCAUTHOR_SUBFIELDS_LOOP => \@subfields_loop,
+            authoritylink => $subfield9,
+            unimarc3 => $unimarc3
+        };
+    }
+    return \@marcauthors;
+}
+
 =head3 to_api
 
     my $json = $biblio->to_api;
@@ -891,11 +1100,11 @@ sub to_api_mapping {
     };
 }
 
-=head3 host_record
+=head3 get_marc_host
 
-    $host = $biblio->host_record;
+    $host = $biblio->get_marc_host;
     # OR:
-    ( $host, $relatedparts ) = $biblio->host_record;
+    ( $host, $relatedparts ) = $biblio->get_marc_host;
 
     Returns host biblio record from MARC21 773 (undef if no 773 present).
     It looks at the first 773 field with MARCorgCode or only a control
@@ -906,11 +1115,10 @@ sub to_api_mapping {
 
 =cut
 
-sub host_record {
+sub get_marc_host {
     my ($self, $params) = @_;
     my $no_items = $params->{no_items};
     return if C4::Context->preference('marcflavour') eq 'UNIMARC'; # TODO
-    return if !C4::Context->preference('ArticleRequestsHostRedirection');
     return if $params->{no_items} && $self->items->count > 0;
 
     my $record;
@@ -955,6 +1163,115 @@ sub host_record {
     }
 }
 
+=head3 recalls
+
+    my $recalls = $biblio->recalls;
+
+Return recalls linked to this biblio
+
+=cut
+
+sub recalls {
+    my ( $self ) = @_;
+    return Koha::Recalls->_new_from_dbic( scalar $self->_result->recalls );
+}
+
+=head3 can_be_recalled
+
+    my @items_for_recall = $biblio->can_be_recalled({ patron => $patron_object });
+
+Does biblio-level checks and returns the items attached to this biblio that are available for recall
+
+=cut
+
+sub can_be_recalled {
+    my ( $self, $params ) = @_;
+
+    return 0 if !( C4::Context->preference('UseRecalls') );
+
+    my $patron = $params->{patron};
+
+    my $branchcode = C4::Context->userenv->{'branch'};
+    if ( C4::Context->preference('CircControl') eq 'PatronLibrary' and $patron ) {
+        $branchcode = $patron->branchcode;
+    }
+
+    my @all_items = Koha::Items->search({ biblionumber => $self->biblionumber })->as_list;
+
+    # if there are no available items at all, no recall can be placed
+    return 0 if ( scalar @all_items == 0 );
+
+    my @itemtypes;
+    my @itemnumbers;
+    my @items;
+    my @all_itemnumbers;
+    foreach my $item ( @all_items ) {
+        push( @all_itemnumbers, $item->itemnumber );
+        if ( $item->can_be_recalled({ patron => $patron }) ) {
+            push( @itemtypes, $item->effective_itemtype );
+            push( @itemnumbers, $item->itemnumber );
+            push( @items, $item );
+        }
+    }
+
+    # if there are no recallable items, no recall can be placed
+    return 0 if ( scalar @items == 0 );
+
+    # Check the circulation rule for each relevant itemtype for this biblio
+    my ( @recalls_allowed, @recalls_per_record, @on_shelf_recalls );
+    foreach my $itemtype ( @itemtypes ) {
+        my $rule = Koha::CirculationRules->get_effective_rules({
+            branchcode => $branchcode,
+            categorycode => $patron ? $patron->categorycode : undef,
+            itemtype => $itemtype,
+            rules => [
+                'recalls_allowed',
+                'recalls_per_record',
+                'on_shelf_recalls',
+            ],
+        });
+        push( @recalls_allowed, $rule->{recalls_allowed} ) if $rule;
+        push( @recalls_per_record, $rule->{recalls_per_record} ) if $rule;
+        push( @on_shelf_recalls, $rule->{on_shelf_recalls} ) if $rule;
+    }
+    my $recalls_allowed = (sort {$b <=> $a} @recalls_allowed)[0]; # take highest
+    my $recalls_per_record = (sort {$b <=> $a} @recalls_per_record)[0]; # take highest
+    my %on_shelf_recalls_count = ();
+    foreach my $count ( @on_shelf_recalls ) {
+        $on_shelf_recalls_count{$count}++;
+    }
+    my $on_shelf_recalls = (sort {$on_shelf_recalls_count{$b} <=> $on_shelf_recalls_count{$a}} @on_shelf_recalls)[0]; # take most common
+
+    # check recalls allowed has been set and is not zero
+    return 0 if ( !defined($recalls_allowed) || $recalls_allowed == 0 );
+
+    if ( $patron ) {
+        # check borrower has not reached open recalls allowed limit
+        return 0 if ( $patron->recalls->filter_by_current->count >= $recalls_allowed );
+
+        # check borrower has not reached open recalls allowed per record limit
+        return 0 if ( $patron->recalls->filter_by_current->search({ biblionumber => $self->biblionumber })->count >= $recalls_per_record );
+
+        # check if any of the items under this biblio are already checked out by this borrower
+        return 0 if ( Koha::Checkouts->search({ itemnumber => [ @all_itemnumbers ], borrowernumber => $patron->borrowernumber })->count > 0 );
+    }
+
+    # check item availability
+    my $checked_out_count = 0;
+    foreach (@items) {
+        if ( Koha::Checkouts->search({ itemnumber => $_->itemnumber })->count > 0 ){ $checked_out_count++; }
+    }
+
+    # can't recall if on shelf recalls only allowed when all unavailable, but items are still available for checkout
+    return 0 if ( $on_shelf_recalls eq 'all' && $checked_out_count < scalar @items );
+
+    # can't recall if no items have been checked out
+    return 0 if ( $checked_out_count == 0 );
+
+    # can recall
+    return @items;
+}
+
 =head2 Internal methods
 
 =head3 type