Jonathan Druart
df97814f30
Signed-off-by: Owen Leonard <oleonard@myacpl.org> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
248 lines
8.5 KiB
Perl
248 lines
8.5 KiB
Perl
#!/usr/bin/perl
|
|
|
|
package C4::ShelfBrowser;
|
|
|
|
# Copyright 2010 Catalyst IT
|
|
#
|
|
# This file is part of Koha.
|
|
#
|
|
# Koha is free software; you can redistribute it and/or modify it
|
|
# under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Koha is distributed in the hope that it will be useful, but
|
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Koha; if not, see <http://www.gnu.org/licenses>.
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
use C4::Biblio;
|
|
use C4::Context;
|
|
use C4::Koha;
|
|
use Koha::Libraries;
|
|
|
|
use vars qw(@ISA @EXPORT @EXPORT_OK);
|
|
|
|
BEGIN {
|
|
require Exporter;
|
|
@ISA = qw(Exporter);
|
|
@EXPORT = qw(
|
|
&GetNearbyItems
|
|
);
|
|
@EXPORT_OK = qw(
|
|
);
|
|
}
|
|
|
|
=head1 NAME
|
|
|
|
C4::ShelfBrowser - functions that deal with the shelf browser feature found in
|
|
the OPAC.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use C4::ShelfBrowser;
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This module provides functions to get items nearby to another item, for use
|
|
in the shelf browser function.
|
|
|
|
'Nearby' is controlled by a handful of system preferences that specify what
|
|
to take into account.
|
|
|
|
=head1 FUNCTIONS
|
|
|
|
=head2 GetNearbyItems($itemnumber, [$num_each_side])
|
|
|
|
$nearby = GetNearbyItems($itemnumber, [$num_each_side]);
|
|
|
|
@items = @{ $nearby->{items} };
|
|
|
|
foreach (@items) {
|
|
# These won't format well like this, but here are the fields
|
|
print $_->{title};
|
|
print $_->{biblionumber};
|
|
print $_->{itemnumber};
|
|
print $_->{browser_normalized_upc};
|
|
print $_->{browser_normalized_oclc};
|
|
print $_->{browser_normalized_isbn};
|
|
print $_->{browser_normalized_ean};
|
|
}
|
|
|
|
# This is the information required to scroll the browser to the next left
|
|
# or right set. Can be derived from next/prev, but it's here for convenience.
|
|
print $nearby->{prev_item}{itemnumber};
|
|
print $nearby->{next_item}{itemnumber};
|
|
print $nearby->{prev_item}{biblionumber};
|
|
print $nearby->{next_item}{biblionumber};
|
|
|
|
# These will be undef if the values are not used to calculate the
|
|
# nearby items.
|
|
print $nearby->{starting_homebranch}->{code};
|
|
print $nearby->{starting_homebranch}->{description};
|
|
print $nearby->{starting_location}->{code};
|
|
print $nearby->{starting_location}->{description};
|
|
print $nearby->{starting_ccode}->{code};
|
|
print $nearby->{starting_ccode}->{description};
|
|
|
|
This finds the items that are nearby to the supplied item, and supplies
|
|
those previous and next, along with the other useful information for displaying
|
|
the shelf browser.
|
|
|
|
It automatically applies the following user preferences to work out how to
|
|
calculate things: C<ShelfBrowserUsesLocation>, C<ShelfBrowserUsesHomeBranch>,
|
|
C<ShelfBrowserUsesCcode>.
|
|
|
|
The option C<$num_each_side> value determines how many items will be fetched
|
|
each side of the supplied item. Note that the item itself is the first entry
|
|
in the 'next' set, and counts towards this limit (this is to keep the
|
|
behaviour consistent with the code that this is a refactor of.) Default is
|
|
3.
|
|
|
|
This will throw an exception if something went wrong.
|
|
|
|
=cut
|
|
|
|
sub GetNearbyItems {
|
|
my ( $itemnumber, $num_each_side, $gap) = @_;
|
|
$num_each_side ||= 3;
|
|
$gap ||= 7; # Should be > $num_each_side
|
|
die "BAD CALL in C4::ShelfBrowser::GetNearbyItems, gap should be > num_each_side"
|
|
if $gap <= $num_each_side;
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my $sth_get_item_details = $dbh->prepare("SELECT cn_sort,homebranch,location,ccode from items where itemnumber=?");
|
|
$sth_get_item_details->execute($itemnumber);
|
|
my $item_details_result = $sth_get_item_details->fetchrow_hashref();
|
|
die "Unable to find item '$itemnumber' for shelf browser" if (!$sth_get_item_details);
|
|
my $start_cn_sort = $item_details_result->{'cn_sort'};
|
|
|
|
my ($start_homebranch, $start_location, $start_ccode);
|
|
if (C4::Context->preference('ShelfBrowserUsesHomeBranch') &&
|
|
defined($item_details_result->{'homebranch'})) {
|
|
$start_homebranch->{code} = $item_details_result->{'homebranch'};
|
|
$start_homebranch->{description} = Koha::Libraries->find($item_details_result->{'homebranch'})->branchname;
|
|
}
|
|
if (C4::Context->preference('ShelfBrowserUsesLocation') &&
|
|
defined($item_details_result->{'location'})) {
|
|
$start_location->{code} = $item_details_result->{'location'};
|
|
$start_location->{description} = GetAuthorisedValueDesc('','',$item_details_result->{'location'},'','','LOC','opac');
|
|
}
|
|
if (C4::Context->preference('ShelfBrowserUsesCcode') &&
|
|
defined($item_details_result->{'ccode'})) {
|
|
$start_ccode->{code} = $item_details_result->{'ccode'};
|
|
$start_ccode->{description} = GetAuthorisedValueDesc('', '', $item_details_result->{'ccode'}, '', '', 'CCODE', 'opac');
|
|
}
|
|
|
|
# Build the query for previous and next items
|
|
my $prev_query ='
|
|
SELECT itemnumber, biblionumber, cn_sort, itemcallnumber
|
|
FROM items
|
|
WHERE
|
|
((cn_sort = ? AND itemnumber < ?) OR cn_sort < ?) ';
|
|
my $next_query ='
|
|
SELECT itemnumber, biblionumber, cn_sort, itemcallnumber
|
|
FROM items
|
|
WHERE
|
|
((cn_sort = ? AND itemnumber >= ?) OR cn_sort > ?) ';
|
|
my @params;
|
|
my $query_cond;
|
|
push @params, ($start_cn_sort, $itemnumber, $start_cn_sort);
|
|
if ($start_homebranch) {
|
|
$query_cond .= 'AND homebranch = ? ';
|
|
push @params, $start_homebranch->{code};
|
|
}
|
|
if ($start_location) {
|
|
$query_cond .= 'AND location = ? ';
|
|
push @params, $start_location->{code};
|
|
}
|
|
if ($start_ccode) {
|
|
$query_cond .= 'AND ccode = ? ';
|
|
push @params, $start_ccode->{code};
|
|
}
|
|
|
|
my @prev_items = @{
|
|
$dbh->selectall_arrayref(
|
|
$prev_query . $query_cond . ' ORDER BY cn_sort DESC, itemnumber DESC LIMIT ?',
|
|
{ Slice => {} },
|
|
( @params, $gap )
|
|
)
|
|
};
|
|
my @next_items = @{
|
|
$dbh->selectall_arrayref(
|
|
$next_query . $query_cond . ' ORDER BY cn_sort, itemnumber LIMIT ?',
|
|
{ Slice => {} },
|
|
( @params, $gap + 1 )
|
|
)
|
|
};
|
|
|
|
my $prev_item = $prev_items[-1];
|
|
my $next_item = $next_items[-1];
|
|
@next_items = splice( @next_items, 0, $num_each_side + 1 );
|
|
@prev_items = reverse splice( @prev_items, 0, $num_each_side );
|
|
my @items = ( @prev_items, @next_items );
|
|
|
|
$next_item = undef
|
|
if not $next_item
|
|
or ( $next_item->{itemnumber} == $items[-1]->{itemnumber}
|
|
and ( @prev_items or @next_items <= 1 )
|
|
);
|
|
$prev_item = undef
|
|
if not $prev_item
|
|
or ( $prev_item->{itemnumber} == $items[0]->{itemnumber}
|
|
and ( @next_items or @prev_items <= 1 )
|
|
);
|
|
|
|
# populate the items
|
|
@items = GetShelfInfo( @items );
|
|
|
|
return {
|
|
items => \@items,
|
|
next_item => $next_item,
|
|
prev_item => $prev_item,
|
|
starting_homebranch => $start_homebranch,
|
|
starting_location => $start_location,
|
|
starting_ccode => $start_ccode,
|
|
};
|
|
}
|
|
|
|
# populate an item list with its title and upc, oclc and isbn normalized.
|
|
# Not really intended to be exported.
|
|
sub GetShelfInfo {
|
|
my @items = @_;
|
|
my $marcflavour = C4::Context->preference("marcflavour");
|
|
my @valid_items;
|
|
for my $item ( @items ) {
|
|
my $this_biblio = GetBibData($item->{biblionumber});
|
|
next unless defined $this_biblio;
|
|
$item->{'title'} = $this_biblio->{'title'};
|
|
my $this_record = GetMarcBiblio($this_biblio->{'biblionumber'});
|
|
$item->{'browser_normalized_upc'} = GetNormalizedUPC($this_record,$marcflavour);
|
|
$item->{'browser_normalized_oclc'} = GetNormalizedOCLCNumber($this_record,$marcflavour);
|
|
$item->{'browser_normalized_isbn'} = GetNormalizedISBN(undef,$this_record,$marcflavour);
|
|
$item->{'browser_normalized_ean'} = GetNormalizedEAN($this_record,$marcflavour);
|
|
$item->{'subtitle'} = GetRecordValue('subtitle', $this_record, GetFrameworkCode( $item->{biblionumber} ));
|
|
push @valid_items, $item;
|
|
}
|
|
return @valid_items;
|
|
}
|
|
|
|
# Fetches some basic biblio data needed by the shelf stuff
|
|
sub GetBibData {
|
|
my ($bibnum) = @_;
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
my $sth = $dbh->prepare("SELECT biblionumber, title FROM biblio WHERE biblionumber=?");
|
|
$sth->execute($bibnum);
|
|
my $bib = $sth->fetchrow_hashref();
|
|
return $bib;
|
|
}
|
|
|
|
1;
|