C4/BookShelves.pm

   1 # -*- tab-width: 8 -*-
   2 # Please use 8-character tabs for this file (indents are every 4 characters)
   3
   4 package C4::BookShelves;
   5
   6 # $Id$
   7
   8 # Copyright 2000-2002 Katipo Communications
   9 #
  10 # This file is part of Koha.
  11 #
  12 # Koha is free software; you can redistribute it and/or modify it under the
  13 # terms of the GNU General Public License as published by the Free Software
  14 # Foundation; either version 2 of the License, or (at your option) any later
  15 # version.
  16 #
  17 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  18 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  19 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  20 #
  21 # You should have received a copy of the GNU General Public License along with
  22 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  23 # Suite 330, Boston, MA  02111-1307 USA
  24
  25 use strict;
  26 require Exporter;
  27 use DBI;
  28 use C4::Context;
  29 use C4::Circulation::Circ2;
  30 use vars qw($VERSION @ISA @EXPORT);
  31
  32 # set the version for version checking
  33 $VERSION = 0.01;
  34
  35 =head1 NAME
  36
  37 C4::BookShelves - Functions for manipulating Koha virtual bookshelves
  38
  39 =head1 SYNOPSIS
  40
  41   use C4::BookShelves;
  42
  43 =head1 DESCRIPTION
  44
  45 This module provides functions for manipulating virtual bookshelves,
  46 including creating and deleting bookshelves, and adding and removing
  47 items to and from bookshelves.
  48
  49 =head1 FUNCTIONS
  50
  51 =over 2
  52
  53 =cut
  54
  55 @ISA = qw(Exporter);
  56 @EXPORT = qw(&GetShelfList &GetShelfContents &AddToShelf &RemoveFromShelf &AddShelf &RemoveShelf);
  57
  58 my $dbh = C4::Context->dbh;
  59
  60 =item GetShelfList
  61
  62   $shelflist = &GetShelfList();
  63   ($shelfnumber, $shelfhash) = each %{$shelflist};
  64
  65 Looks up the virtual bookshelves, and returns a summary. C<$shelflist>
  66 is a reference-to-hash. The keys are the bookshelf numbers
  67 (C<$shelfnumber>, above), and the values (C<$shelfhash>, above) are
  68 themselves references-to-hash, with the following keys:
  69
  70 =over 4
  71
  72 =item C<$shelfhash-E<gt>{shelfname}>
  73
  74 A string. The name of the shelf.
  75
  76 =item C<$shelfhash-E<gt>{count}>
  77
  78 The number of books on that bookshelf.
  79
  80 =back
  81
  82 =cut
  83 #'
  84 # FIXME - Wouldn't it be more intuitive to return a list, rather than
  85 # a reference-to-hash? The shelf number can be just another key in the
  86 # hash.
  87 sub GetShelfList {
  88     # FIXME - These two database queries can be combined into one:
  89     #   SELECT          bookshelf.shelfnumber, bookshelf.shelfname,
  90     #                   count(shelfcontents.itemnumber)
  91     #   FROM            bookshelf
  92     #   LEFT JOIN       shelfcontents
  93     #   ON              bookshelf.shelfnumber = shelfcontents.shelfnumber
  94     #   GROUP BY        bookshelf.shelfnumber
  95     my $sth=$dbh->prepare("select shelfnumber,shelfname from bookshelf");
  96     $sth->execute;
  97     my %shelflist;
  98     while (my ($shelfnumber, $shelfname) = $sth->fetchrow) {
  99         my $sti=$dbh->prepare("select count(*) from shelfcontents where shelfnumber=$shelfnumber");
 100                 # FIXME - Should there be an "order by" in here somewhere?
 101         $sti->execute;
 102         my ($count) = $sti->fetchrow;
 103         $shelflist{$shelfnumber}->{'shelfname'}=$shelfname;
 104         $shelflist{$shelfnumber}->{'count'}=$count;
 105     }
 106     return(\%shelflist);
 107 }
 108
 109 =item GetShelfContents
 110
 111   $itemlist = &GetShelfContents($env, $shelfnumber);
 112
 113 Looks up information about the contents of virtual bookshelf number
 114 C<$shelfnumber>.
 115
 116 Returns a reference-to-array, whose elements are references-to-hash,
 117 as returned by C<&getiteminformation>.
 118
 119 I don't know what C<$env> is.
 120
 121 =cut
 122 #'
 123 sub GetShelfContents {
 124     my ($env, $shelfnumber) = @_;
 125     my @itemlist;
 126     my $sth=$dbh->prepare("select itemnumber from shelfcontents where shelfnumber=$shelfnumber order by itemnumber");
 127     $sth->execute;
 128     while (my ($itemnumber) = $sth->fetchrow) {
 129         my ($item) = getiteminformation($env, $itemnumber, 0);
 130         push (@itemlist, $item);
 131     }
 132     return (\@itemlist);
 133                 # FIXME - Wouldn't it be more intuitive to return a list,
 134                 # rather than a reference-to-list?
 135 }
 136
 137 =item AddToShelf
 138
 139   &AddToShelf($env, $itemnumber, $shelfnumber);
 140
 141 Adds item number C<$itemnumber> to virtual bookshelf number
 142 C<$shelfnumber>, unless that item is already on that shelf.
 143
 144 C<$env> is ignored.
 145
 146 =cut
 147 #'
 148 sub AddToShelf {
 149     my ($env, $itemnumber, $shelfnumber) = @_;
 150     my $sth=$dbh->prepare("select * from shelfcontents
 151         where shelfnumber=? and itemnumber=?");
 152
 153     $sth->execute($shelfnumber, $itemnumber);
 154     if ($sth->rows) {
 155 # already on shelf
 156     } else {
 157         $sth=$dbh->prepare("insert into shelfcontents
 158                 (shelfnumber, itemnumber, flags) values (?, ?, 0)");
 159
 160                         # FIXME - The default for 'flags' is NULL.
 161                         # Why set it to 0?
 162         $sth->execute($shelfnumber, $itemnumber);
 163     }
 164 }
 165
 166 =item RemoveFromShelf
 167
 168   &RemoveFromShelf($env, $itemnumber, $shelfnumber);
 169
 170 Removes item number C<$itemnumber> from virtual bookshelf number
 171 C<$shelfnumber>. If the item wasn't on that bookshelf to begin with,
 172 nothing happens.
 173
 174 C<$env> is ignored.
 175
 176 =cut
 177 #'
 178 sub RemoveFromShelf {
 179     my ($env, $itemnumber, $shelfnumber) = @_;
 180     my $sth=$dbh->prepare("delete from shelfcontents where shelfnumber=$shelfnumber and itemnumber=$itemnumber");
 181     $sth->execute;
 182 }
 183
 184 =item AddShelf
 185
 186   ($status, $msg) = &AddShelf($env, $shelfname);
 187
 188 Creates a new virtual bookshelf with name C<$shelfname>.
 189
 190 Returns a two-element array, where C<$status> is 0 if the operation
 191 was successful, or non-zero otherwise. C<$msg> is "Done" in case of
 192 success, or an error message giving the reason for failure.
 193
 194 C<$env> is ignored.
 195
 196 =cut
 197 #'
 198 # FIXME - Perhaps this could/should return the number of the new bookshelf
 199 # as well?
 200 sub AddShelf {
 201     my ($env, $shelfname) = @_;
 202     my $q_shelfname=$dbh->quote($shelfname);
 203     my $sth=$dbh->prepare("select * from bookshelf where shelfname=$q_shelfname");
 204     $sth->execute;
 205     if ($sth->rows) {
 206         return(1, "Shelf \"$shelfname\" already exists");
 207     } else {
 208         $sth=$dbh->prepare("insert into bookshelf (shelfname) values ($q_shelfname)");
 209         $sth->execute;
 210         return (0, "Done");
 211     }
 212 }
 213
 214 =item RemoveShelf
 215
 216   ($status, $msg) = &RemoveShelf($env, $shelfnumber);
 217
 218 Deletes virtual bookshelf number C<$shelfnumber>. The bookshelf must
 219 be empty.
 220
 221 Returns a two-element array, where C<$status> is 0 if the operation
 222 was successful, or non-zero otherwise. C<$msg> is "Done" in case of
 223 success, or an error message giving the reason for failure.
 224
 225 C<$env> is ignored.
 226
 227 =cut
 228 #'
 229 sub RemoveShelf {
 230     my ($env, $shelfnumber) = @_;
 231     my $sth=$dbh->prepare("select count(*) from shelfcontents where shelfnumber=$shelfnumber");
 232     $sth->execute;
 233     my ($count)=$sth->fetchrow;
 234     if ($count) {
 235         return (1, "Shelf has $count items on it.  Please remove all items before deleting this shelf.");
 236     } else {
 237         $sth=$dbh->prepare("delete from bookshelf where shelfnumber=$shelfnumber");
 238         $sth->execute;
 239         return (0, "Done");
 240     }
 241 }
 242
 243 END { }       # module clean-up code here (global destructor)
 244
 245 1;
 246
 247 #
 248 # $Log$
 249 # Revision 1.10  2003/02/05 10:05:02  acli
 250 # Converted a few SQL statements to use ? to fix a few strange SQL errors
 251 # Noted correct tab size
 252 #
 253 # Revision 1.9  2002/10/13 08:29:18  arensb
 254 # Deleted unused variables.
 255 # Removed trailing whitespace.
 256 #
 257 # Revision 1.8  2002/10/10 04:32:44  arensb
 258 # Simplified references.
 259 #
 260 # Revision 1.7  2002/10/05 09:50:10  arensb
 261 # Merged with arensb-context branch: use C4::Context->dbh instead of
 262 # &C4Connect, and generally prefer C4::Context over C4::Database.
 263 #
 264 # Revision 1.6.2.1  2002/10/04 02:24:43  arensb
 265 # Use C4::Connect instead of C4::Database, C4::Connect->dbh instead
 266 # C4Connect.
 267 #
 268 # Revision 1.6  2002/09/23 13:50:30  arensb
 269 # Fixed missing bit in POD.
 270 #
 271 # Revision 1.5  2002/09/22 17:29:17  arensb
 272 # Added POD.
 273 # Added some FIXME comments.
 274 # Removed useless trailing whitespace.
 275 #
 276 # Revision 1.4  2002/08/14 18:12:51  tonnesen
 277 # Added copyright statement to all .pl and .pm files
 278 #
 279 # Revision 1.3  2002/07/02 17:48:06  tonnesen
 280 # Merged in updates from rel-1-2
 281 #
 282 # Revision 1.2.2.1  2002/06/26 20:46:48  tonnesen
 283 # Inserting some changes I made locally a while ago.
 284 #
 285 #
 286
 287 __END__
 288
 289 =back
 290
 291 =head1 AUTHOR
 292
 293 Koha Developement team <info@koha.org>
 294
 295 =head1 SEE ALSO
 296
 297 C4::Circulation::Circ2(3)
 298
 299 =cut