Bug 29697: Replace GetMarcBiblio occurrences with $biblio->metadata->record
[srvgit] / opac / opac-shelves.pl
index 802366d..e228b3d 100755 (executable)
 use Modern::Perl;
 
 use CGI qw ( -utf8 );
-use C4::Auth;
-use C4::Biblio;
-use C4::Koha;
-use C4::Items;
+use C4::Auth qw( get_template_and_user );
+use C4::Biblio qw( GetBiblioData GetFrameworkCode );
+use C4::External::BakerTaylor qw( image_url link_url );
+use C4::Koha qw(
+    GetNormalizedEAN
+    GetNormalizedISBN
+    GetNormalizedOCLCNumber
+    GetNormalizedUPC
+);
 use C4::Members;
-use C4::Output;
+use C4::Output qw( pagination_bar output_with_http_headers );
 use C4::Tags qw( get_tags );
-use C4::XSLT;
+use C4::XSLT qw( XSLTParse4Display );
 
 use Koha::Biblios;
 use Koha::Biblioitems;
-use Koha::IssuingRules;
+use Koha::CirculationRules;
+use Koha::CsvProfiles;
+use Koha::DateUtils qw/dt_from_string/;
 use Koha::Items;
 use Koha::ItemTypes;
 use Koha::Patrons;
+use Koha::Virtualshelfshares;
 use Koha::Virtualshelves;
 use Koha::RecordProcessor;
 
 use constant ANYONE => 2;
+use constant STAFF => 3;
 
-my $query = new CGI;
+my $query = CGI->new;
 
 my $template_name = $query->param('rss') ? "opac-shelves-rss.tt" : "opac-shelves.tt";
 
@@ -50,18 +59,39 @@ if ( ! C4::Context->preference('virtualshelves') ) {
     exit;
 }
 
-my ( $template, $loggedinuser, $cookie ) = get_template_and_user({
-        template_name   => $template_name,
-        query           => $query,
-        type            => "opac",
-        authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
-    });
+my $op = $query->param('op') || 'list';
+my ( $template, $loggedinuser, $cookie );
+
+if( $op eq 'view' || $op eq 'list' ){
+    ( $template, $loggedinuser, $cookie ) = get_template_and_user({
+            template_name   => $template_name,
+            query           => $query,
+            type            => "opac",
+            authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
+        });
+} else {
+    ( $template, $loggedinuser, $cookie ) = get_template_and_user({
+            template_name   => $template_name,
+            query           => $query,
+            type            => "opac",
+            authnotrequired => 0,
+        });
+}
+
+if (C4::Context->preference("BakerTaylorEnabled")) {
+    $template->param(
+        BakerTaylorImageURL => &image_url(),
+        BakerTaylorLinkURL  => &link_url(),
+    );
+}
 
-my $op       = $query->param('op')       || 'list';
 my $referer  = $query->param('referer')  || $op;
-my $category = $query->param('category') || 1;
+my $public = 0;
+$public = 1 if $query->param('public') && $query->param('public') == 1;
+
 my ( $shelf, $shelfnumber, @messages );
 
+# PART 1: Perform a few actions
 if ( $op eq 'add_form' ) {
     # Only pass default
     $shelf = { allow_change_from_owner => 1 };
@@ -70,7 +100,7 @@ if ( $op eq 'add_form' ) {
     $shelf       = Koha::Virtualshelves->find($shelfnumber);
 
     if ( $shelf ) {
-        $category = $shelf->category;
+        $public = $shelf->public;
         my $patron = Koha::Patrons->find( $shelf->owner );
         $template->param( owner => $patron, );
         unless ( $shelf->can_be_managed( $loggedinuser ) ) {
@@ -87,9 +117,10 @@ if ( $op eq 'add_form' ) {
             $shelf = Koha::Virtualshelf->new(
                 {   shelfname          => scalar $query->param('shelfname'),
                     sortfield          => scalar $query->param('sortfield'),
-                    category           => scalar $query->param('category') || 1,
+                    public             => $public,
                     allow_change_from_owner => $allow_changes_from > 0,
                     allow_change_from_others => $allow_changes_from == ANYONE,
+                    allow_change_from_staff => $allow_changes_from == STAFF,
                     owner              => scalar $loggedinuser,
                 }
             );
@@ -114,14 +145,15 @@ if ( $op eq 'add_form' ) {
     if ( $shelf ) {
         $op = $referer;
         my $sortfield = $query->param('sortfield');
-        $sortfield = 'title' unless grep {/^$sortfield$/}qw( title author copyrightdate itemcallnumber dateadded );
+        $sortfield = 'title' unless grep { $_ eq $sortfield } qw( title author copyrightdate itemcallnumber dateadded );
         if ( $shelf->can_be_managed( $loggedinuser ) ) {
             $shelf->shelfname( scalar $query->param('shelfname') );
             $shelf->sortfield( $sortfield );
             my $allow_changes_from = $query->param('allow_changes_from');
             $shelf->allow_change_from_owner( $allow_changes_from > 0 );
             $shelf->allow_change_from_others( $allow_changes_from == ANYONE );
-            $shelf->category( scalar $query->param('category') );
+            $shelf->allow_change_from_staff( $allow_changes_from == STAFF );
+            $shelf->public( $public );
             eval { $shelf->store };
 
             if ($@) {
@@ -226,18 +258,60 @@ if ( $op eq 'add_form' ) {
         push @messages, { type => 'error', code => 'does_not_exist' };
     }
     $op = 'view';
+} elsif( $op eq 'transfer' ) {
+    $shelfnumber = $query->param('shelfnumber');
+    $shelf = Koha::Virtualshelves->find($shelfnumber) if $shelfnumber;
+    my $new_owner = $query->param('new_owner'); # borrowernumber or undef
+    my $error_code = $shelf
+        ? $shelf->cannot_be_transferred({ by => $loggedinuser, to => $new_owner, interface => 'opac' })
+        : 'does_not_exist';
+
+    if( !$new_owner && $error_code eq 'missing_to_parameter' ) { # show transfer form
+        my $patrons = [];
+        my $shares = $shelf->get_shares->search({ borrowernumber => { '!=' => undef } });
+        while( my $share = $shares->next ) {
+            my $email = $share->sharee->notice_email_address;
+            push @$patrons, { email => $email, borrowernumber => $share->get_column('borrowernumber') } if $email;
+        }
+        if( @$patrons ) {
+            $template->param( shared_users => $patrons );
+            $op = 'transfer';
+        } else {
+            push @messages, { type => 'error', code => 'no_email_found' };
+        }
+    } elsif( $error_code ) {
+        push @messages, { type => 'error', code => $error_code };
+        $op = 'list';
+    } else { # transfer; remove new_owner from virtualshelfshares, add loggedinuser
+        $shelf->_result->result_source->schema->txn_do( sub {
+            $shelf->get_shares->search({ borrowernumber => $new_owner })->delete;
+            Koha::Virtualshelfshare->new({ shelfnumber => $shelfnumber, borrowernumber => $loggedinuser, sharedate => dt_from_string })->store;
+            $shelf->owner($new_owner)->store;
+        });
+        $op = 'list';
+    }
 }
 
+# PART 2: After a possible action, view one list or show a number of lists
 if ( $op eq 'view' ) {
     $shelfnumber ||= $query->param('shelfnumber');
     $shelf = Koha::Virtualshelves->find($shelfnumber);
     if ( $shelf ) {
         if ( $shelf->can_be_viewed( $loggedinuser ) ) {
-            $category = $shelf->category;
-            my $sortfield = $query->param('sortfield') || $shelf->sortfield;    # Passed in sorting overrides default sorting
-            $sortfield = 'title' unless grep $_ eq $sortfield, qw( title author copyrightdate itemcallnumber dateadded );
-            my $direction = $query->param('direction') || 'asc';
-            $direction = 'asc' if $direction ne 'asc' and $direction ne 'desc';
+            $public = $shelf->public;
+
+            # Sortfield param may still include sort order with :asc or :desc, but direction overrides it
+            my( $sortfield, $direction );
+            if( $query->param('sortfield') ){
+                ( $sortfield, $direction ) = split /:/, $query->param('sortfield');
+            } else {
+                $sortfield = $shelf->sortfield;
+                $direction = 'asc';
+            }
+            $direction = $query->param('direction') if $query->param('direction');
+            $direction = 'asc' if !$direction or ( $direction ne 'asc' and $direction ne 'desc' );
+            $sortfield = 'title' if !$sortfield or !grep { $_ eq $sortfield } qw( title author copyrightdate itemcallnumber dateadded );
+
             my ( $page, $rows );
             unless ( $query->param('print') or $query->param('rss') ) {
                 $rows = C4::Context->preference('OPACnumSearchResults') || 20;
@@ -247,7 +321,8 @@ if ( $op eq 'view' ) {
             my $contents = $shelf->get_contents->search(
                 {},
                 {
-                    prefetch => [ { 'biblionumber' => { 'biblioitems' => 'items' } } ],
+                    distinct => 'biblionumber',
+                    join     => [ { 'biblionumber' => { 'biblioitems' => 'items' } } ],
                     page     => $page,
                     rows     => $rows,
                     order_by => { "-$direction" => $order_by },
@@ -262,30 +337,32 @@ if ( $op eq 'view' ) {
 
             my $patron = Koha::Patrons->find( $loggedinuser );
 
-            # Lists display falls back to search results configuration
-            my $xslfile = C4::Context->preference('OPACXSLTListsDisplay');
-            my $lang   = $xslfile ? C4::Languages::getlanguage()  : undef;
-            my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
+            my $categorycode; # needed for may_article_request
+            if( C4::Context->preference('ArticleRequests') ) {
+                $categorycode = $patron ? $patron->categorycode : undef;
+            }
 
             my $record_processor = Koha::RecordProcessor->new({ filters => 'ViewPolicy' });
-            my @items;
+
+            my $art_req_itypes;
+            if( C4::Context->preference('ArticleRequests') ) {
+                $art_req_itypes = Koha::CirculationRules->guess_article_requestable_itemtypes({ $patron ? ( categorycode => $patron->categorycode ) : () });
+            }
+
+            my @items_info;
             while ( my $content = $contents->next ) {
                 my $biblionumber = $content->biblionumber;
                 my $this_item    = GetBiblioData($biblionumber);
-                my $record = GetMarcBiblio({ biblionumber => $biblionumber });
-                my $framework = GetFrameworkCode( $biblionumber );
-                my $biblio = Koha::Biblios->find( $biblionumber );
-                $record_processor->options({
+                my $biblio       = Koha::Biblios->find($biblionumber);
+                my $record       = $biblio->metadata->record;
+                my $framework    = GetFrameworkCode($biblionumber);
+                $record_processor->options(
+                    {
                     interface => 'opac',
                     frameworkcode => $framework
                 });
                 $record_processor->process($record);
 
-                if ( $xslfile ) {
-                    $this_item->{XSLTBloc} = XSLTParse4Display( $biblionumber, $record, "OPACXSLTListsDisplay",
-                                                                1, undef, $sysxml, $xslfile, $lang);
-                }
-
                 my $marcflavour = C4::Context->preference("marcflavour");
                 my $itemtype = Koha::Biblioitems->search({ biblionumber => $content->biblionumber })->next->itemtype;
                 $itemtype = Koha::ItemTypes->find( $itemtype );
@@ -299,6 +376,8 @@ if ( $op eq 'view' ) {
                 $this_item->{'normalized_ean'}  = GetNormalizedEAN( $record, $marcflavour );
                 $this_item->{'normalized_oclc'} = GetNormalizedOCLCNumber( $record, $marcflavour );
                 $this_item->{'normalized_isbn'} = GetNormalizedISBN( undef, $record, $marcflavour );
+                # BZ17530: 'Intelligent' guess if result can be article requested
+                $this_item->{artreqpossible} = ( $art_req_itypes->{ $this_item->{itemtype} // q{} } || $art_req_itypes->{ '*' } ) ? 1 : q{};
 
                 unless ( defined $this_item->{size} ) {
 
@@ -306,10 +385,6 @@ if ( $op eq 'view' ) {
                     $this_item->{size} = q||;
                 }
 
-                # Getting items infos for location display
-                my @items_infos = &GetItemsLocationInfo( $biblionumber );
-                $this_item->{'ITEM_RESULTS'} = \@items_infos;
-
                 if (C4::Context->preference('TagsEnabled') and C4::Context->preference('TagsShowOnList')) {
                     $this_item->{TagLoop} = get_tags({
                         biblionumber => $biblionumber, approved=>1, 'sort'=>'-weight',
@@ -317,19 +392,41 @@ if ( $op eq 'view' ) {
                     });
                 }
 
-                my $items = $biblio->items;
+                my $items = $biblio->items->filter_by_visible_in_opac({ patron => $patron });
+                my $allow_onshelf_holds;
                 while ( my $item = $items->next ) {
-                    $this_item->{allow_onshelf_holds} = Koha::IssuingRules->get_onshelfholds_policy( { item => $item, patron => $patron } );
-                    last if $this_item->{allow_onshelf_holds};
+
+                    # This method must take a Koha::Items rs
+                    $allow_onshelf_holds ||= Koha::CirculationRules->get_onshelfholds_policy(
+                        { item => $item, patron => $patron } );
+
                 }
 
+                $this_item->{allow_onshelf_holds} = $allow_onshelf_holds;
+                $this_item->{'ITEM_RESULTS'} = $items;
+
+                my $variables = {
+                    anonymous_session => ($loggedinuser) ? 0 : 1
+                };
+                $this_item->{XSLTBloc} = XSLTParse4Display(
+                    {
+                        biblionumber   => $biblionumber,
+                        record         => $record,
+                        xsl_syspref    => "OPACXSLTListsDisplay",
+                        fix_amps       => 1,
+                        xslt_variables => $variables,
+                        items_rs       => $items->reset,
+                    }
+                );
+
+
                 if ( grep {$_ eq $biblionumber} @cart_list) {
                     $this_item->{incart} = 1;
                 }
 
                 $this_item->{biblio_object} = $biblio;
                 $this_item->{biblionumber}  = $biblionumber;
-                push @items, $this_item;
+                push @items_info, $this_item;
             }
 
             $template->param(
@@ -337,9 +434,16 @@ if ( $op eq 'view' ) {
                 can_delete_shelf   => $shelf->can_be_deleted($loggedinuser),
                 can_remove_biblios => $shelf->can_biblios_be_removed($loggedinuser),
                 can_add_biblios    => $shelf->can_biblios_be_added($loggedinuser),
-                itemsloop          => \@items,
+                itemsloop          => \@items_info,
                 sortfield          => $sortfield,
                 direction          => $direction,
+                csv_profiles => Koha::CsvProfiles->search(
+                    {
+                        type       => 'marc',
+                        used_for   => 'export_records',
+                        staff_only => 0
+                    }
+                  ),
             );
             if ( $page ) {
                 my $pager = $contents->pager;
@@ -357,12 +461,10 @@ if ( $op eq 'view' ) {
     } else {
         push @messages, { type => 'error', code => 'does_not_exist' };
     }
-}
-
-if ( $op eq 'list' ) {
+} elsif ( $op eq 'list' ) {
     my $shelves;
     my ( $page, $rows ) = ( $query->param('page') || 1, 20 );
-    if ( $category == 1 ) {
+    if ( !$public ) {
         $shelves = Koha::Virtualshelves->get_private_shelves({ page => $page, rows => $rows, borrowernumber => $loggedinuser, });
     } else {
         $shelves = Koha::Virtualshelves->get_public_shelves({ page => $page, rows => $rows, });
@@ -373,19 +475,23 @@ if ( $op eq 'list' ) {
         shelves => $shelves,
         pagination_bar => pagination_bar(
             q||, $pager->last_page - $pager->first_page + 1,
-            $page, "page", { op => 'list', category => $category, }
+            $page, "page", { op => 'list', public => $public, }
         ),
     );
 }
 
+my $staffuser;
+$staffuser = Koha::Patrons->find( $loggedinuser )->can_patron_change_staff_only_lists if $loggedinuser;
 $template->param(
     op       => $op,
     referer  => $referer,
     shelf    => $shelf,
     messages => \@messages,
-    category => $category,
+    public   => $public,
     print    => scalar $query->param('print') || 0,
     listsview => 1,
+    staffuser => $staffuser,
 );
 
-output_html_with_http_headers $query, $cookie, $template->output;
+my $content_type = $query->param('rss')? 'rss' : 'html';
+output_with_http_headers $query, $cookie, $template->output, $content_type;