Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity
Koha/C4/BookShelves.pm
tgarip1957 0451359813 New set of routines for HEAD. 
Uses a complete new ZEBRA Indexing.
ZEBRA is now XML and comprises of a KOHA meta record. Explanatory notes will be on koha-devel
Fixes UTF8 problems
Fixes bug with authorities
SQL database major changes.
Separate biblioograaphic and holdings records. Biblioitems table depreceated
etc. etc.
Wait for explanatory document on koha-devel
2006-08-25 21:07:08 +00:00

681 lines
20 KiB
Perl
Executable file
Raw Blame History

# -*- tab-width: 8 -*-
# Please use 8-character tabs for this file (indents are every 4 characters)
package C4::BookShelves;
# $Id$
# 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;
require Exporter;
use C4::Context;
use C4::Circulation::Circ2;
use C4::AcademicInfo;
use C4::Search;
use C4::Date;
use C4::Biblio;
use vars qw($VERSION @ISA @EXPORT);
# set the version for version checking
$VERSION = 0.01;
=head1 NAME
C4::BookShelves - Functions for manipulating Koha virtual bookshelves
=head1 SYNOPSIS
use C4::BookShelves;
=head1 DESCRIPTION
This module provides functions for manipulating virtual bookshelves,
including creating and deleting bookshelves, and adding and removing
items to and from bookshelves.
=head1 FUNCTIONS
=over 2
=cut
@ISA = qw(Exporter);
@EXPORT = qw(&GetShelfList &GetShelfContents &AddToShelf &AddToShelfFromBiblio
&RemoveFromShelf &AddShelf &RemoveShelf
&ShelfPossibleAction
&GetShelfListExt &AddShelfExt &EditShelfExt &RemoveShelfExt
&GetShelfInfo &GetShelfContentsExt &RemoveFromShelfExt
&GetShelfListOfExt &AddToShelfExt
&AddRequestToShelf &CountShelfRequest &GetShelfRequests
&RejectShelfRequest &CatalogueShelfRequest &GetShelfRequestOwner
&GetShelfRequest);
my $dbh;
$dbh = C4::Context->dbh;
=item ShelfPossibleAction
=over 4
=item 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.
=back
=cut
sub ShelfPossibleAction {
my ($loggedinuser,$shelfnumber,$action)= @_;
my $sth = $dbh->prepare("select owner,category from bookshelf where shelfnumber=?");
$sth->execute($shelfnumber);
my ($owner,$category) = $sth->fetchrow;
return 1 if (($category>=3 or $owner eq $loggedinuser) && $action eq 'manage');
return 1 if (($category>= 2 or $owner eq $loggedinuser) && $action eq 'view');
return 0;
}
=item GetShelfList
$shelflist = &GetShelfList();
($shelfnumber, $shelfhash) = each %{$shelflist};
Looks up the virtual bookshelves, and returns a summary. C<$shelflist>
is a reference-to-hash. The keys are the bookshelf numbers
(C<$shelfnumber>, above), and the values (C<$shelfhash>, above) are
themselves references-to-hash, with the following keys:
=over 4
=item C<$shelfhash-E<gt>{shelfname}>
A string. The name of the shelf.
=item C<$shelfhash-E<gt>{count}>
The number of books on that bookshelf.
=back
=cut
#'
# FIXME - Wouldn't it be more intuitive to return a list, rather than
# a reference-to-hash? The shelf number can be just another key in the
# hash.
sub GetShelfList {
my ($owner,$mincategory) = @_;
# mincategory : 2 if the list is for "look". 3 if the list is for "Select bookshelf for adding a book".
# bookshelves of the owner are always selected, whatever the category
my $sth=$dbh->prepare("SELECT bookshelf.shelfnumber, bookshelf.shelfname,owner,surname,firstname, category,
count(shelfcontents.itemnumber) as count
FROM bookshelf
LEFT JOIN shelfcontents
ON bookshelf.shelfnumber = shelfcontents.shelfnumber
left join borrowers on bookshelf.owner = borrowers.borrowernumber
where owner=? or category>=?
GROUP BY bookshelf.shelfnumber order by shelfname");
$sth->execute($owner,$mincategory);
my %shelflist;
while (my ($shelfnumber, $shelfname,$owner,$surname,$firstname,$category,$count) = $sth->fetchrow) {
$shelflist{$shelfnumber}->{'shelfname'}=$shelfname;
$shelflist{$shelfnumber}->{'count'}=$count;
$shelflist{$shelfnumber}->{'owner'}=$owner;
$shelflist{$shelfnumber}->{'surname'} = $surname;
$shelflist{$shelfnumber}->{'firstname'} = $firstname;
$shelflist{$shelfnumber}->{'category'} = $category;
}
return(\%shelflist);
}
=item GetShelfContents
$itemlist = &GetShelfContents($env, $shelfnumber);
Looks up information about the contents of virtual bookshelf number
C<$shelfnumber>.
Returns a reference-to-array, whose elements are references-to-hash,
as returned by C<&getiteminformation>.
I don't know what C<$env> is.
=cut
#'
sub GetShelfContents {
my ($env, $shelfnumber) = @_;
my @itemlist;
my $sth=$dbh->prepare("select itemnumber from shelfcontents where shelfnumber=? order by itemnumber");
$sth->execute($shelfnumber);
while (my ($itemnumber) = $sth->fetchrow) {
my ($item) = getiteminformation($env, $itemnumber, 0);
push (@itemlist, $item);
}
return (\@itemlist);
}
=item AddToShelf
&AddToShelf($env, $itemnumber, $shelfnumber);
Adds item number C<$itemnumber> to virtual bookshelf number
C<$shelfnumber>, unless that item is already on that shelf.
C<$env> is ignored.
=cut
#'
sub AddToShelf {
my ($env, $itemnumber, $shelfnumber) = @_;
return unless $itemnumber;
my $sth=$dbh->prepare("select * from shelfcontents where shelfnumber=? and itemnumber=?");
$sth->execute($shelfnumber, $itemnumber);
if ($sth->rows) {
# already on shelf
} else {
$sth=$dbh->prepare("insert into shelfcontents (shelfnumber, itemnumber, flags) values (?, ?, 0)");
$sth->execute($shelfnumber, $itemnumber);
}
}
sub AddToShelfFromBiblio {
my ($env, $biblionumber, $shelfnumber) = @_;
return unless $biblionumber;
my $sth = $dbh->prepare("select itemnumber from items where biblionumber=?");
$sth->execute($biblionumber);
my ($itemnumber) = $sth->fetchrow;
$sth=$dbh->prepare("select * from shelfcontents where shelfnumber=? and itemnumber=?");
$sth->execute($shelfnumber, $itemnumber);
if ($sth->rows) {
# already on shelf
} else {
$sth=$dbh->prepare("insert into shelfcontents (shelfnumber, itemnumber, flags,biblionumber) values (?, ?, 0,?)");
$sth->execute($shelfnumber, $itemnumber,$biblionumber);
}
}
=item RemoveFromShelf
&RemoveFromShelf($env, $itemnumber, $shelfnumber);
Removes item number C<$itemnumber> from virtual bookshelf number
C<$shelfnumber>. If the item wasn't on that bookshelf to begin with,
nothing happens.
C<$env> is ignored.
=cut
#'
sub RemoveFromShelf {
my ($env, $itemnumber, $shelfnumber) = @_;
my $sth=$dbh->prepare("delete from shelfcontents where shelfnumber=? and itemnumber=?");
$sth->execute($shelfnumber,$itemnumber);
}
=item AddShelf
($status, $msg) = &AddShelf($env, $shelfname);
Creates a new virtual bookshelf with name C<$shelfname>.
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.
C<$env> is ignored.
=cut
#'
# FIXME - Perhaps this could/should return the number of the new bookshelf
# as well?
sub AddShelf {
my ($env, $shelfname,$owner,$category) = @_;
my $sth=$dbh->prepare("select * from bookshelf where shelfname=?");
$sth->execute($shelfname);
if ($sth->rows) {
return(1, "Shelf \"$shelfname\" already exists");
} else {
$sth=$dbh->prepare("insert into bookshelf (shelfname,owner,category) values (?,?,?)");
$sth->execute($shelfname,$owner,$category);
return (0, "Done");
}
}
=item RemoveShelf
($status, $msg) = &RemoveShelf($env, $shelfnumber);
Deletes virtual bookshelf number C<$shelfnumber>. The bookshelf 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.
C<$env> is ignored.
=cut
#'
sub RemoveShelf {
my ($env, $shelfnumber) = @_;
my $sth=$dbh->prepare("select count(*) from shelfcontents where shelfnumber=?");
$sth->execute($shelfnumber);
my ($count)=$sth->fetchrow;
if ($count) {
return (1, "Shelf has $count items on it. Please remove all items before deleting this shelf.");
} else {
$sth=$dbh->prepare("delete from bookshelf where shelfnumber=?");
$sth->execute($shelfnumber);
return (0, "Done");
}
}
sub GetShelfListOfExt {
my ($owner) = @_;
my $sth;
if ($owner) {
$sth = $dbh->prepare("SELECT * FROM bookshelf WHERE (owner = ?) or category>=2 ORDER BY shelfname");
$sth->execute($owner);
} else {
$sth = $dbh->prepare("SELECT * FROM bookshelf where category<2 ORDER BY shelfname");
$sth->execute();
}
my $sth2 = $dbh->prepare("SELECT count(biblionumber) as bibliocount FROM shelfcontents WHERE (shelfnumber = ?)");
my @results;
while (my $row = $sth->fetchrow_hashref) {
$sth2->execute($row->{'shelfnumber'});
$row->{'bibliocount'} = $sth2->fetchrow;
if ($row->{'category'} == 1) {
$row->{'private'} = 1;
} else {
$row->{'public'} = 1;
}
push @results, $row;
}
return \@results;
}
sub GetShelfListExt {
my ($owner,$mincategory,$id_intitution, $intra) = @_;
my $sth1 = $dbh->prepare("SELECT * FROM careers WHERE id_institution = ?");
$sth1->execute($id_intitution);
my @results;
my $total_shelves = 0;
while (my $row1 = $sth1->fetchrow_hashref) {
my @shelves;
my $sth2;
if ($intra) {
$sth2=$dbh->prepare("SELECT
bookshelf.shelfnumber, bookshelf.shelfname,owner,surname,firstname, category,
count(shelfcontents.biblionumber) as count
FROM
bookshelf
LEFT JOIN shelfcontents ON bookshelf.shelfnumber = shelfcontents.shelfnumber
LEFT JOIN borrowers ON bookshelf.owner = borrowers.borrowernumber
LEFT JOIN bookshelves_careers ON bookshelves_careers.shelfnumber = bookshelf.shelfnumber
WHERE
(id_career = ?)
GROUP BY bookshelf.shelfnumber
ORDER BY shelfname");
$sth2->execute($row1->{'id_career'});
} else {
$sth2=$dbh->prepare("SELECT
bookshelf.shelfnumber, bookshelf.shelfname,owner,surname,firstname, category,
count(shelfcontents.biblionumber) as count
FROM
bookshelf
LEFT JOIN shelfcontents ON bookshelf.shelfnumber = shelfcontents.shelfnumber
LEFT JOIN borrowers ON bookshelf.owner = borrowers.borrowernumber
LEFT JOIN bookshelves_careers ON bookshelves_careers.shelfnumber = bookshelf.shelfnumber
WHERE
(owner = ? OR category >= ?) AND (id_career = ?)
GROUP BY bookshelf.shelfnumber
ORDER BY shelfname");
$sth2->execute($owner,$mincategory,$row1->{'id_career'});
}
$row1->{'shelfcount'} = 0;
while (my $row2 = $sth2->fetchrow_hashref) {
if ($owner == $row2->{'owner'}) {
$row2->{'canmanage'} = 1;
}
if ($row2->{'category'} == 1) {
$row2->{'private'} = 1;
} else {
$row2->{'public'} = 1;
}
$row1->{'shelfcount'}++;
$total_shelves++;
push @shelves, $row2;
}
$row1->{'shelvesloop'} = \@shelves;
push @results, $row1;
}
return($total_shelves, \@results);
}
sub AddShelfExt {
my ($shelfname,$owner,$category,$careers) = @_;
my $sth = $dbh->prepare("SELECT * FROM bookshelf WHERE shelfname = ?");
$sth->execute($shelfname);
if ($sth->rows) {
return 0;
} else {
$sth = $dbh->prepare("INSERT INTO bookshelf (shelfname,owner,category) VALUES (?,?,?)");
$sth->execute($shelfname,$owner,$category);
my $shelfnumber = $dbh->{'mysql_insertid'};
foreach my $row (@{$careers}) {
$sth = $dbh->prepare("INSERT INTO bookshelves_careers VALUES (?,?)");
$sth->execute($shelfnumber, $row);
}
return $shelfnumber;
}
}
sub EditShelfExt {
my ($shelfnumber,$shelfname,$category,$careers) = @_;
my $sth = $dbh->prepare("SELECT * FROM bookshelf WHERE shelfname = ? AND NOT shelfnumber = ? ");
$sth->execute($shelfname, $shelfnumber);
if ($sth->rows) {
return 0;
} else {
$sth = $dbh->prepare("UPDATE bookshelf SET shelfname = ?, category = ? WHERE shelfnumber = ?");
$sth->execute($shelfname,$category,$shelfnumber);
$sth = $dbh->prepare("DELETE FROM bookshelves_careers WHERE shelfnumber = ?");
$sth->execute($shelfnumber);
foreach my $row (@{$careers}) {
$sth = $dbh->prepare("INSERT INTO bookshelves_careers VALUES (?,?)");
$sth->execute($shelfnumber, $row);
}
return $shelfnumber;
}
}
sub RemoveShelfExt {
my ($shelfnumber) = @_;
my $sth = $dbh->prepare("DELETE FROM bookshelves_careers WHERE shelfnumber = ?");
$sth->execute($shelfnumber);
my $sth = $dbh->prepare("DELETE FROM shelfcontents WHERE shelfnumber = ?");
$sth->execute($shelfnumber);
$sth = $dbh->prepare("DELETE FROM bookshelf WHERE shelfnumber = ?");
$sth->execute($shelfnumber);
return 1;
}
sub GetShelfInfo {
my ($shelfnumber, $owner) = @_;
my $sth = $dbh->prepare("SELECT * FROM bookshelf WHERE shelfnumber = ?");
$sth->execute($shelfnumber);
my $result = $sth->fetchrow_hashref;
if ($result->{'owner'} == $owner) {
$result->{'canmanage'} = 1;
}
my $sth = $dbh->prepare("SELECT id_career FROM bookshelves_careers WHERE shelfnumber = ?");
$sth->execute($shelfnumber);
my @careers;
while (my $row = $sth->fetchrow) {
push @careers, $row;
}
$result->{'careers'} = \@careers;
return $result;
}
sub GetShelfContentsExt {
my ($shelfnumber) = @_;
my $sth = $dbh->prepare("SELECT biblionumber FROM shelfcontents WHERE shelfnumber = ? ORDER BY biblionumber");
$sth->execute($shelfnumber);
my @biblios;
my $even = 0;
while (my ($biblionumber) = $sth->fetchrow) {
my $biblio=ZEBRA_readyXML_noheader($dbh,$biblionumber);
push @biblios,$biblio;
}
my (@results)=parsefields($dbh,"opac",@biblios);
return (\@results);
}
sub RemoveFromShelfExt {
my ($biblionumber, $shelfnumber) = @_;
my $sth = $dbh->prepare("DELETE FROM shelfcontents WHERE shelfnumber = ? AND biblionumber = ?");
$sth->execute($shelfnumber,$biblionumber);
}
sub AddToShelfExt {
my ($biblionumber, $shelfnumber) = @_;
my $sth = $dbh->prepare("SELECT * FROM shelfcontents WHERE shelfnumber = ? AND biblionumber = ?");
$sth->execute($shelfnumber, $biblionumber);
if ($sth->rows) {
return 0
} else {
$sth = $dbh->prepare("INSERT INTO shelfcontents (shelfnumber, biblionumber) VALUES (?, ?)");
$sth->execute($shelfnumber, $biblionumber);
}
}
sub AddRequestToShelf {
my ($shelfnumber, $requestType, $requestName, $comments) = @_;
my $sth = $dbh->prepare("INSERT INTO shelf_requests (shelfnumber, request_name, request_type, status, request_date, comments) VALUES (?,?,?,?, CURRENT_DATE(),?)");
$sth->execute($shelfnumber, $requestName, $requestType, "PENDING", $comments);
return $dbh->{'mysql_insertid'};
}
sub CountShelfRequest {
my ($shelfnumber, $status) = @_;
my $sth;
if ($shelfnumber) {
$sth = $dbh->prepare("SELECT count(idRequest) FROM shelf_requests WHERE shelfnumber = ? AND status = ?");
$sth->execute($shelfnumber, $status);
} else {
$sth = $dbh->prepare("SELECT count(idRequest) FROM shelf_requests WHERE status = ?");
$sth->execute($status);
}
my ($count) = $sth->fetchrow_array;
return $count;
}
sub GetShelfRequests {
my ($shelfnumber, $status, $type) = @_;
my @params;
my $query = "SELECT * FROM shelf_requests SR INNER JOIN bookshelf BS ON SR.shelfnumber = BS.shelfnumber WHERE status = ?";
push @params, $status;
if ($shelfnumber) {
$query.= " AND shelfnumber = ?";
push @params, $shelfnumber;
}
if ($type) {
$query.= " AND request_type = ?";
push @params, $type;
}
$query.= " ORDER BY SR.shelfnumber, SR.request_date";
my $sth = $dbh->prepare($query);
$sth->execute(@params);
my @results;
my $color = 0;
while (my $row = $sth->fetchrow_hashref) {
my $borrdata = borrdata('',$row->{'owner'});
$row->{'surname'} = $borrdata->{'surname'};
$row->{'firstname'} = $borrdata->{'firstname'};
$row->{'cardnumber'} = $borrdata->{'cardnumber'};
$row->{'request_date'} = format_date($row->{'request_date'});
$row->{$row->{'request_type'}} = 1;
$row->{$row->{'status'}} = 1;
$row->{'color'} = $color = not $color;
push @results, $row;
}
return (\@results);
}
sub RejectShelfRequest {
my ($idRequest) = @_;
#get the type and name request
my $sth = $dbh->prepare("SELECT request_type, request_name FROM shelf_requests WHERE idRequest = ?");
$sth->execute($idRequest);
my ($request_type, $request_name) = $sth->fetchrow_array;
#if the request is a file, then unlink the file
if ($request_type eq 'file') {
unlink($ENV{'DOCUMENT_ROOT'}."/uploaded-files/shelf-files/$idRequest-$request_name");
}
#change tha request status to REJECTED
$sth = $dbh->prepare("UPDATE shelf_requests SET status = ? WHERE idRequest = ?");
$sth->execute("REJECTED", $idRequest);
return 1;
}
sub GetShelfRequestOwner {
my ($idRequest) = @_;
my $sth = $dbh->prepare("SELECT owner FROM shelf_requests R INNER JOIN bookshelf S ON R.shelfnumber = S.shelfnumber WHERE idRequest = ?");
$sth->execute($idRequest);
my ($owner) = $sth->fetchrow_array;
my $bordata = &borrdata(undef, $owner);
#print "Content-type: text/plain \n\n --- $owner ----- $bordata->{'emailaddress'}" ;
return ($bordata);
}
sub GetShelfRequest {
my ($idRequest) = @_;
my $sth = $dbh->prepare("SELECT * FROM shelf_requests R INNER JOIN bookshelf S ON R.shelfnumber = S.shelfnumber WHERE idRequest = ?");
$sth->execute($idRequest);
my $request_data = $sth->fetchrow_hashref;
return $request_data;
}
sub CatalogueShelfRequest {
my ($idRequest, $shelfnumber, $biblionumber) = @_;
#find the last request status
my $sth = $dbh->prepare("SELECT status, biblionumber FROM shelf_requests WHERE idRequest = ?");
$sth->execute($idRequest);
my ($prev_status, $prev_biblionumber) = $sth->fetchrow_array;
#if the status was not seted, inserts an entry in shelfcontents
if ($prev_status ne "CATALOGUED") {
$sth = $dbh->prepare("INSERT INTO shelfcontents (shelfnumber, biblionumber) VALUES (?,?)");
$sth->execute($shelfnumber, $biblionumber);
#if the request was previously catalogued, delete the entry in shelfcontens
} elsif ($prev_status ne "REJECTED") {
$sth = $dbh->prepare("DELETE FROM shelfcontents WHERE shelfnumber = ? AND biblionumber = ?");
$sth->execute($shelfnumber, $prev_biblionumber);
}
#change the status to catalogued
$sth = $dbh->prepare("UPDATE shelf_requests SET status = ?, biblionumber = ? WHERE idRequest = ?");
$sth->execute("CATALOGUED", $biblionumber, $idRequest);
return 1;
}
END { } # module clean-up code here (global destructor)
1;
#
# $Log$
# Revision 1.16 2006/08/25 21:07:08 tgarip1957
# New set of routines for HEAD.
# Uses a complete new ZEBRA Indexing.
# ZEBRA is now XML and comprises of a KOHA meta record. Explanatory notes will be on koha-devel
# Fixes UTF8 problems
# Fixes bug with authorities
# SQL database major changes.
# Separate biblioograaphic and holdings records. Biblioitems table depreceated
# etc. etc.
# Wait for explanatory document on koha-devel
#
# Revision 1.13 2004/03/11 16:06:20 tipaul
# *** empty log message ***
#
# Revision 1.11.2.2 2004/02/19 10:15:41 tipaul
# new feature : adding book to bookshelf from biblio detail screen.
#
# Revision 1.11.2.1 2004/02/06 14:16:55 tipaul
# fixing bugs in bookshelves management.
#
# Revision 1.11 2003/12/15 10:57:08 slef
# DBI call fix for bug 662
#
# Revision 1.10 2003/02/05 10:05:02 acli
# Converted a few SQL statements to use ? to fix a few strange SQL errors
# Noted correct tab size
#
# Revision 1.9 2002/10/13 08:29:18 arensb
# Deleted unused variables.
# Removed trailing whitespace.
#
# Revision 1.8 2002/10/10 04:32:44 arensb
# Simplified references.
#
# Revision 1.7 2002/10/05 09:50:10 arensb
# Merged with arensb-context branch: use C4::Context->dbh instead of
# &C4Connect, and generally prefer C4::Context over C4::Database.
#
# Revision 1.6.2.1 2002/10/04 02:24:43 arensb
# Use C4::Connect instead of C4::Database, C4::Connect->dbh instead
# C4Connect.
#
# Revision 1.6 2002/09/23 13:50:30 arensb
# Fixed missing bit in POD.
#
# Revision 1.5 2002/09/22 17:29:17 arensb
# Added POD.
# Added some FIXME comments.
# Removed useless trailing whitespace.
#
# Revision 1.4 2002/08/14 18:12:51 tonnesen
# Added copyright statement to all .pl and .pm files
#
# Revision 1.3 2002/07/02 17:48:06 tonnesen
# Merged in updates from rel-1-2
#
# Revision 1.2.2.1 2002/06/26 20:46:48 tonnesen
# Inserting some changes I made locally a while ago.
#
#
__END__
=back
=head1 AUTHOR
Koha Developement team <info@koha.org>
=head1 SEE ALSO
C4::Circulation::Circ2(3)
=cut
View git blame Copy permalink