1 package C4::ShelfBrowser;
3 # Copyright 2010 Catalyst IT
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 C4::Biblio qw( GetAuthorisedValueDesc GetMarcBiblio );
25 use C4::Koha qw( GetNormalizedUPC GetNormalizedOCLCNumber GetNormalizedISBN GetNormalizedEAN );
29 our (@ISA, @EXPORT_OK);
40 C4::ShelfBrowser - functions that deal with the shelf browser feature found in
49 This module provides functions to get items nearby to another item, for use
50 in the shelf browser function.
52 'Nearby' is controlled by a handful of system preferences that specify what
57 =head2 GetNearbyItems($itemnumber, [$num_each_side])
59 $nearby = GetNearbyItems($itemnumber, [$num_each_side]);
61 @items = @{ $nearby->{items} };
64 # These won't format well like this, but here are the fields
66 print $_->{biblionumber};
67 print $_->{itemnumber};
68 print $_->{browser_normalized_upc};
69 print $_->{browser_normalized_oclc};
70 print $_->{browser_normalized_isbn};
71 print $_->{browser_normalized_ean};
74 # This is the information required to scroll the browser to the next left
75 # or right set. Can be derived from next/prev, but it's here for convenience.
76 print $nearby->{prev_item}{itemnumber};
77 print $nearby->{next_item}{itemnumber};
78 print $nearby->{prev_item}{biblionumber};
79 print $nearby->{next_item}{biblionumber};
81 # These will be undef if the values are not used to calculate the
83 print $nearby->{starting_homebranch}->{code};
84 print $nearby->{starting_homebranch}->{description};
85 print $nearby->{starting_location}->{code};
86 print $nearby->{starting_location}->{description};
87 print $nearby->{starting_ccode}->{code};
88 print $nearby->{starting_ccode}->{description};
90 This finds the items that are nearby to the supplied item, and supplies
91 those previous and next, along with the other useful information for displaying
94 It automatically applies the following user preferences to work out how to
95 calculate things: C<ShelfBrowserUsesLocation>, C<ShelfBrowserUsesHomeBranch>,
96 C<ShelfBrowserUsesCcode>.
98 The option C<$num_each_side> value determines how many items will be fetched
99 each side of the supplied item. Note that the item itself is the first entry
100 in the 'next' set, and counts towards this limit (this is to keep the
101 behaviour consistent with the code that this is a refactor of.) Default is
104 This will throw an exception if something went wrong.
109 my ( $itemnumber, $num_each_side, $gap) = @_;
110 $num_each_side ||= 3;
111 $gap ||= 7; # Should be > $num_each_side
112 die "BAD CALL in C4::ShelfBrowser::GetNearbyItems, gap should be > num_each_side"
113 if $gap <= $num_each_side;
115 my $dbh = C4::Context->dbh;
117 my $sth_get_item_details = $dbh->prepare("SELECT cn_sort,homebranch,location,ccode from items where itemnumber=?");
118 $sth_get_item_details->execute($itemnumber);
119 my $item_details_result = $sth_get_item_details->fetchrow_hashref();
120 die "Unable to find item '$itemnumber' for shelf browser" if (!$sth_get_item_details);
121 my $start_cn_sort = $item_details_result->{'cn_sort'};
123 my ($start_homebranch, $start_location, $start_ccode);
124 if (C4::Context->preference('ShelfBrowserUsesHomeBranch') &&
125 defined($item_details_result->{'homebranch'})) {
126 $start_homebranch->{code} = $item_details_result->{'homebranch'};
127 $start_homebranch->{description} = Koha::Libraries->find($item_details_result->{'homebranch'})->branchname;
129 if (C4::Context->preference('ShelfBrowserUsesLocation') &&
130 defined($item_details_result->{'location'})) {
131 $start_location->{code} = $item_details_result->{'location'};
132 $start_location->{description} = GetAuthorisedValueDesc('','',$item_details_result->{'location'},'','','LOC','opac');
134 if (C4::Context->preference('ShelfBrowserUsesCcode') &&
135 defined($item_details_result->{'ccode'})) {
136 $start_ccode->{code} = $item_details_result->{'ccode'};
137 $start_ccode->{description} = GetAuthorisedValueDesc('', '', $item_details_result->{'ccode'}, '', '', 'CCODE', 'opac');
140 # Build the query for previous and next items
142 SELECT itemnumber, biblionumber, cn_sort, itemcallnumber
145 ((cn_sort = ? AND itemnumber < ?) OR cn_sort < ?) ';
147 SELECT itemnumber, biblionumber, cn_sort, itemcallnumber
150 ((cn_sort = ? AND itemnumber >= ?) OR cn_sort > ?) ';
153 push @params, ($start_cn_sort, $itemnumber, $start_cn_sort);
154 if ($start_homebranch) {
155 $query_cond .= 'AND homebranch = ? ';
156 push @params, $start_homebranch->{code};
158 if ($start_location) {
159 $query_cond .= 'AND location = ? ';
160 push @params, $start_location->{code};
163 $query_cond .= 'AND ccode = ? ';
164 push @params, $start_ccode->{code};
168 $dbh->selectall_arrayref(
169 $prev_query . $query_cond . ' ORDER BY cn_sort DESC, itemnumber DESC LIMIT ?',
175 $dbh->selectall_arrayref(
176 $next_query . $query_cond . ' ORDER BY cn_sort, itemnumber LIMIT ?',
178 ( @params, $gap + 1 )
182 my $prev_item = $prev_items[-1];
183 my $next_item = $next_items[-1];
184 @next_items = splice( @next_items, 0, $num_each_side + 1 );
185 @prev_items = reverse splice( @prev_items, 0, $num_each_side );
186 my @items = ( @prev_items, @next_items );
190 or ( $next_item->{itemnumber} == $items[-1]->{itemnumber}
191 and ( @prev_items or @next_items <= 1 )
195 or ( $prev_item->{itemnumber} == $items[0]->{itemnumber}
196 and ( @next_items or @prev_items <= 1 )
200 @items = GetShelfInfo( @items );
204 next_item => $next_item,
205 prev_item => $prev_item,
206 starting_homebranch => $start_homebranch,
207 starting_location => $start_location,
208 starting_ccode => $start_ccode,
212 # populate an item list with its title and upc, oclc and isbn normalized.
213 # Not really intended to be exported.
216 my $marcflavour = C4::Context->preference("marcflavour");
218 for my $item ( @items ) {
219 my $biblio = Koha::Biblios->find( $item->{biblionumber} );
220 next unless defined $biblio;
222 $item->{biblio_object} = $biblio;
223 $item->{biblionumber} = $biblio->biblionumber;
224 $item->{title} = $biblio->title;
225 $item->{subtitle} = $biblio->subtitle;
226 $item->{medium} = $biblio->medium;
227 $item->{part_number} = $biblio->part_number;
228 $item->{part_name} = $biblio->part_name;
229 my $this_record = GetMarcBiblio({ biblionumber => $biblio->biblionumber });
230 $item->{'browser_normalized_upc'} = GetNormalizedUPC($this_record,$marcflavour);
231 $item->{'browser_normalized_oclc'} = GetNormalizedOCLCNumber($this_record,$marcflavour);
232 $item->{'browser_normalized_isbn'} = GetNormalizedISBN(undef,$this_record,$marcflavour);
233 $item->{'browser_normalized_ean'} = GetNormalizedEAN($this_record,$marcflavour);
234 push @valid_items, $item;