939b0a8e55
Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz> Signed-off-by: Joshua Ferraro <jmf@liblime.com>
453 lines
13 KiB
Perl
453 lines
13 KiB
Perl
# -*- tab-width: 8 -*-
|
|
# Please use 8-character tabs for this file (indents are every 4 characters)
|
|
|
|
package C4::VirtualShelves;
|
|
|
|
|
|
# Copyright 2000-2002 Katipo Communications
|
|
#
|
|
# 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 2 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, write to the Free Software Foundation, Inc., 59 Temple Place,
|
|
# Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
use strict;
|
|
use Carp;
|
|
use C4::Context;
|
|
use C4::Circulation;
|
|
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
|
|
|
|
BEGIN {
|
|
# set the version for version checking
|
|
$VERSION = 3.02;
|
|
require Exporter;
|
|
@ISA = qw(Exporter);
|
|
@EXPORT = qw(
|
|
&GetShelves &GetShelfContents &GetShelf
|
|
|
|
&AddToShelf &AddToShelfFromBiblio &AddShelf
|
|
|
|
&ModShelf
|
|
&ShelfPossibleAction
|
|
&DelFromShelf &DelShelf
|
|
);
|
|
@EXPORT_OK = qw(&GetShelvesSummary);
|
|
}
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
=head1 NAME
|
|
|
|
C4::VirtualShelves - Functions for manipulating Koha virtual virtualshelves
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use C4::VirtualShelves;
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This module provides functions for manipulating virtual virtualshelves,
|
|
including creating and deleting virtualshelves, and adding and removing
|
|
items to and from virtualshelves.
|
|
|
|
=head1 FUNCTIONS
|
|
|
|
=over 2
|
|
|
|
=item GetShelves
|
|
|
|
$shelflist = &GetShelves($owner);
|
|
$shelflist = &GetShelves($owner, $mincategory);
|
|
$shelflist = &GetShelves($owner, $mincategory, $limit);
|
|
($shelfnumber, $shelfhash) = each %{$shelflist};
|
|
|
|
Looks up the virtual virtualshelves, and returns a summary. C<$shelflist>
|
|
is a reference-to-hash. The keys are the virtualshelves numbers
|
|
(C<$shelfnumber>, above), and the values (C<$shelfhash>, above) are
|
|
themselves references-to-hash, with the following keys:
|
|
|
|
C<mincategory> : 2 if the list is for "Public", 3 for "Open".
|
|
virtualshelves of the owner are always selected, whatever the category
|
|
|
|
=over 4
|
|
|
|
=item C<$shelfhash-E<gt>{shelfname}>
|
|
|
|
A string. The name of the shelf.
|
|
|
|
=item C<$shelfhash-E<gt>{count}>
|
|
|
|
The number of virtuals on that virtualshelves.
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
sub GetShelves {
|
|
my ($owner, $mincategory, $limit) = @_;
|
|
($mincategory and $mincategory =~ /^\d+$/) or $mincategory = 2;
|
|
( $limit and $limit =~ /^\d+$/) or $limit = undef;
|
|
my $query = qq(
|
|
SELECT virtualshelves.shelfnumber, virtualshelves.shelfname,owner,surname,firstname,virtualshelves.category,virtualshelves.sortfield,
|
|
count(virtualshelfcontents.biblionumber) as count
|
|
FROM virtualshelves
|
|
LEFT JOIN virtualshelfcontents ON virtualshelves.shelfnumber = virtualshelfcontents.shelfnumber
|
|
LEFT JOIN borrowers ON virtualshelves.owner = borrowers.borrowernumber
|
|
WHERE owner=? OR category>=?
|
|
GROUP BY virtualshelves.shelfnumber
|
|
ORDER BY virtualshelves.category, virtualshelves.shelfname, borrowers.firstname, borrowers.surname
|
|
);
|
|
$limit and $query .= " LIMIT $limit ";
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute( $owner, $mincategory );
|
|
my %shelflist;
|
|
while (
|
|
my (
|
|
$shelfnumber, $shelfname, $owner, $surname,
|
|
$firstname, $category, $sortfield, $count
|
|
)
|
|
= $sth->fetchrow
|
|
)
|
|
{
|
|
$shelflist{$shelfnumber}->{'shelfname'} = $shelfname;
|
|
$shelflist{$shelfnumber}->{'count'} = $count;
|
|
$shelflist{$shelfnumber}->{'sortfield'} = $sortfield;
|
|
$shelflist{$shelfnumber}->{'category'} = $category;
|
|
$shelflist{$shelfnumber}->{'owner'} = $owner;
|
|
$shelflist{$shelfnumber}->{'surname'} = $surname;
|
|
$shelflist{$shelfnumber}->{'firstname'} = $firstname;
|
|
}
|
|
return ( \%shelflist );
|
|
}
|
|
|
|
sub GetShelvesSummary {
|
|
my ($owner, $mincategory, $limit) = @_;
|
|
($mincategory and $mincategory =~ /^\d+$/) or $mincategory = 2;
|
|
( $limit and $limit =~ /^\d+$/) or $limit = 10;
|
|
my $query = qq(
|
|
SELECT
|
|
virtualshelves.shelfnumber,
|
|
virtualshelves.shelfname,
|
|
owner,
|
|
CONCAT(firstname, ' ', surname) AS name,
|
|
virtualshelves.category,
|
|
count(virtualshelfcontents.biblionumber) AS count
|
|
FROM virtualshelves
|
|
LEFT JOIN virtualshelfcontents ON virtualshelves.shelfnumber = virtualshelfcontents.shelfnumber
|
|
LEFT JOIN borrowers ON virtualshelves.owner = borrowers.borrowernumber
|
|
WHERE owner=? OR category>=?
|
|
GROUP BY virtualshelves.shelfnumber
|
|
ORDER BY virtualshelves.category, borrowers.surname, borrowers.firstname, virtualshelves.shelfname
|
|
LIMIT ?
|
|
);
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute($owner,$mincategory,$limit);
|
|
|
|
my $shelves = $sth->fetchall_arrayref({});
|
|
# add private flag to each shelf entry --
|
|
# need to do this because HTML::Template::Pro's EXPR
|
|
# support complains about a non-initialized 'category'
|
|
# if the user has no shelves -- the offending line in
|
|
# masthead.inc was <-- TMPL_IF EXPR="category == 1"...
|
|
foreach my $shelf (@{ $shelves }) {
|
|
$shelf->{'private'} = ($shelf->{'category'} == 1);
|
|
}
|
|
return $shelves;
|
|
|
|
# Probably NOT the final implementation since it is still bulky (repeated hash keys).
|
|
# might like an array of rows of delimited values:
|
|
# 1|2||0|blacklist|112
|
|
# 2|6|Josh Ferraro|51|en_fuego|106
|
|
}
|
|
|
|
=item GetShelf
|
|
|
|
(shelfnumber,shelfname,owner,category,sortfield) = &GetShelf($shelfnumber);
|
|
|
|
Looks up information about the contents of virtual virtualshelves number
|
|
C<$shelfnumber>
|
|
|
|
Returns the database's information on 'virtualshelves' table.
|
|
|
|
=cut
|
|
|
|
sub GetShelf {
|
|
my ($shelfnumber) = @_;
|
|
my $query = qq(
|
|
SELECT shelfnumber, shelfname, owner, category, sortfield
|
|
FROM virtualshelves
|
|
WHERE shelfnumber=?
|
|
);
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute($shelfnumber);
|
|
return $sth->fetchrow;
|
|
}
|
|
|
|
=item GetShelfContents
|
|
|
|
$itemlist = &GetShelfContents($shelfnumber);
|
|
|
|
Looks up information about the contents of virtual virtualshelves number
|
|
C<$shelfnumber>. Sorted by a field in the biblio table. copyrightdate
|
|
gives a desc sort.
|
|
|
|
Returns a reference-to-array, whose elements are references-to-hash,
|
|
as returned by C<C4::Biblio::GetBiblioFromItemNumber>.
|
|
|
|
Note: the notforloan status comes from the itemtype, and where it equals 0
|
|
it does not ensure that related items.notforloan status is likewise 0. The
|
|
caller has to check any items on their own, possibly with CanBookBeIssued
|
|
from C4::Circulation.
|
|
|
|
=cut
|
|
|
|
sub GetShelfContents {
|
|
my ( $shelfnumber ,$sortfield) = @_;
|
|
my $dbh=C4::Context->dbh();
|
|
if(!$sortfield) {
|
|
my $sthsort = $dbh->prepare('select sortfield from virtualshelves where shelfnumber=?');
|
|
$sthsort->execute($shelfnumber);
|
|
($sortfield) = $sthsort->fetchrow_array;
|
|
}
|
|
my $query =
|
|
" SELECT vc.biblionumber, vc.shelfnumber,
|
|
biblio.*, biblioitems.itemtype, itemtypes.*
|
|
FROM virtualshelfcontents vc
|
|
LEFT JOIN biblio ON vc.biblionumber = biblio.biblionumber
|
|
LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
|
|
LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
|
|
WHERE vc.shelfnumber=? ";
|
|
if($sortfield) {
|
|
$query .= " ORDER BY `$sortfield` ";
|
|
$query .= " DESC " if ($sortfield eq 'copyrightdate');
|
|
}
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute($shelfnumber);
|
|
return $sth->fetchall_arrayref({});
|
|
# Like the perldoc says,
|
|
# returns reference-to-array, where each element is reference-to-hash of the row:
|
|
# like [ $sth->fetchrow_hashref(), $sth->fetchrow_hashref() ... ]
|
|
# Suitable for use in TMPL_LOOP.
|
|
# See http://search.cpan.org/~timb/DBI-1.601/DBI.pm#fetchall_arrayref
|
|
# or newer, for your version of DBI.
|
|
}
|
|
|
|
=item AddShelf
|
|
|
|
$shelfnumber = &AddShelf( $shelfname, $owner, $category);
|
|
|
|
Creates a new virtual virtualshelves with name C<$shelfname>, owner C<$owner> and category
|
|
C<$category>.
|
|
|
|
Returns a code to know what's happen.
|
|
* -1 : if this virtualshelves already exist.
|
|
* $shelfnumber : if success.
|
|
|
|
=cut
|
|
|
|
sub AddShelf {
|
|
my ( $shelfname, $owner, $category ) = @_;
|
|
my $query = qq(
|
|
SELECT *
|
|
FROM virtualshelves
|
|
WHERE shelfname=? AND owner=?
|
|
);
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute($shelfname,$owner);
|
|
( $sth->rows ) and return (-1);
|
|
$query = qq(
|
|
INSERT INTO virtualshelves
|
|
(shelfname,owner,category)
|
|
VALUES (?,?,?)
|
|
);
|
|
$sth = $dbh->prepare($query);
|
|
$sth->execute( $shelfname, $owner, $category );
|
|
my $shelfnumber = $dbh->{'mysql_insertid'};
|
|
return ($shelfnumber);
|
|
}
|
|
|
|
=item AddToShelf
|
|
|
|
&AddToShelf($biblionumber, $shelfnumber);
|
|
|
|
Adds item number C<$biblionumber> to virtual virtualshelves number
|
|
C<$shelfnumber>, unless that item is already on that shelf.
|
|
|
|
=cut
|
|
|
|
#'
|
|
sub AddToShelf {
|
|
my ( $biblionumber, $shelfnumber ) = @_;
|
|
return unless $biblionumber;
|
|
my $query = qq(
|
|
SELECT *
|
|
FROM virtualshelfcontents
|
|
WHERE shelfnumber=? AND biblionumber=?
|
|
);
|
|
my $sth = $dbh->prepare($query);
|
|
|
|
$sth->execute( $shelfnumber, $biblionumber );
|
|
($sth->rows) and return undef; # already on shelf
|
|
$query = qq(
|
|
INSERT INTO virtualshelfcontents
|
|
(shelfnumber, biblionumber, flags)
|
|
VALUES
|
|
(?, ?, 0)
|
|
);
|
|
$sth = $dbh->prepare($query);
|
|
$sth->execute( $shelfnumber, $biblionumber );
|
|
}
|
|
|
|
=item AddToShelfFromBiblio
|
|
|
|
&AddToShelfFromBiblio($biblionumber, $shelfnumber)
|
|
|
|
this function allow to add a virtual into the shelf number $shelfnumber
|
|
from biblionumber.
|
|
|
|
=cut
|
|
|
|
sub AddToShelfFromBiblio {
|
|
my ( $biblionumber, $shelfnumber ) = @_;
|
|
return unless $biblionumber;
|
|
my $query = qq(
|
|
SELECT *
|
|
FROM virtualshelfcontents
|
|
WHERE shelfnumber=? AND biblionumber=?
|
|
);
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute( $shelfnumber, $biblionumber );
|
|
unless ( $sth->rows ) {
|
|
my $query =qq(
|
|
INSERT INTO virtualshelfcontents
|
|
(shelfnumber, biblionumber, flags)
|
|
VALUES
|
|
(?, ?, 0)
|
|
);
|
|
$sth = $dbh->prepare($query);
|
|
$sth->execute( $shelfnumber, $biblionumber );
|
|
}
|
|
}
|
|
|
|
=item ModShelf
|
|
|
|
ModShelf($shelfnumber, $shelfname, $owner, $category )
|
|
|
|
Modify the value into virtualshelves table with values given on input arg.
|
|
|
|
=cut
|
|
|
|
sub ModShelf {
|
|
my ( $shelfnumber, $shelfname, $owner, $category, $sortfield ) = @_;
|
|
my $query = qq(
|
|
UPDATE virtualshelves
|
|
SET shelfname=?,owner=?,category=?,sortfield=?
|
|
WHERE shelfnumber=?
|
|
);
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute( $shelfname, $owner, $category, $sortfield, $shelfnumber );
|
|
}
|
|
|
|
=item ShelfPossibleAction
|
|
|
|
ShelfPossibleAction($loggedinuser, $shelfnumber, $action);
|
|
|
|
C<$loggedinuser,$shelfnumber,$action>
|
|
|
|
$action can be "view" or "manage".
|
|
|
|
Returns 1 if the user can do the $action in the $shelfnumber shelf.
|
|
Returns 0 otherwise.
|
|
|
|
=cut
|
|
|
|
sub ShelfPossibleAction {
|
|
my ( $user, $shelfnumber, $action ) = @_;
|
|
my $query = qq(
|
|
SELECT owner,category
|
|
FROM virtualshelves
|
|
WHERE shelfnumber=?
|
|
);
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute($shelfnumber);
|
|
my ( $owner, $category ) = $sth->fetchrow;
|
|
return 1 if ($owner eq $user);
|
|
return 1 if ( $category >= 3);
|
|
return 1 if (($category >= 2) && $action eq 'view' );
|
|
return 0;
|
|
}
|
|
|
|
=item DelFromShelf
|
|
|
|
&DelFromShelf( $biblionumber, $shelfnumber);
|
|
|
|
Removes item number C<$biblionumber> from virtual virtualshelves number
|
|
C<$shelfnumber>. If the item wasn't on that virtualshelves to begin with,
|
|
nothing happens.
|
|
|
|
=cut
|
|
|
|
#'
|
|
sub DelFromShelf {
|
|
my ( $biblionumber, $shelfnumber ) = @_;
|
|
my $query = qq(
|
|
DELETE FROM virtualshelfcontents
|
|
WHERE shelfnumber=? AND biblionumber=?
|
|
);
|
|
my $sth = $dbh->prepare($query);
|
|
$sth->execute( $shelfnumber, $biblionumber );
|
|
}
|
|
|
|
=item DelShelf (old version)
|
|
|
|
($status, $msg) = &DelShelf($shelfnumber);
|
|
|
|
Deletes virtual virtualshelves number C<$shelfnumber>. The virtualshelves must
|
|
be empty.
|
|
|
|
Returns a two-element array, where C<$status> is 0 if the operation
|
|
was successful, or non-zero otherwise. C<$msg> is "Done" in case of
|
|
success, or an error message giving the reason for failure.
|
|
|
|
=item DelShelf (current version)
|
|
|
|
$Number = DelShelf($shelfnumber);
|
|
|
|
This function deletes the shelf number, and all of it's content.
|
|
|
|
=cut
|
|
|
|
sub DelShelf {
|
|
unless (@_) {
|
|
carp "DelShelf called without valid argument (shelfnumber)";
|
|
return undef;
|
|
}
|
|
my $sth = $dbh->prepare("DELETE FROM virtualshelves WHERE shelfnumber=?");
|
|
return $sth->execute(shift);
|
|
}
|
|
|
|
1;
|
|
|
|
__END__
|
|
|
|
=back
|
|
|
|
=head1 AUTHOR
|
|
|
|
Koha Developement team <info@koha.org>
|
|
|
|
=head1 SEE ALSO
|
|
|
|
C4::Circulation::Circ2(3)
|
|
|
|
=cut
|