596 lines
15 KiB
Perl
596 lines
15 KiB
Perl
package C4::RotatingCollections;
|
|
|
|
# $Id: RotatingCollections.pm,v 0.1 2007/04/20 kylemhall
|
|
|
|
# This package is inteded to keep track of what library
|
|
# Items of a certain collection should be at.
|
|
|
|
# Copyright 2007 Kyle Hall
|
|
#
|
|
# 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 Modern::Perl;
|
|
|
|
use C4::Context;
|
|
use C4::Circulation;
|
|
use C4::Reserves qw(CheckReserves);
|
|
use Koha::Database;
|
|
|
|
use DBI;
|
|
use Try::Tiny;
|
|
|
|
use vars qw(@ISA @EXPORT);
|
|
|
|
|
|
=head1 NAME
|
|
|
|
C4::RotatingCollections - Functions for managing rotating collections
|
|
|
|
=head1 FUNCTIONS
|
|
|
|
=cut
|
|
|
|
BEGIN {
|
|
require Exporter;
|
|
@ISA = qw( Exporter );
|
|
@EXPORT = qw(
|
|
CreateCollection
|
|
UpdateCollection
|
|
DeleteCollection
|
|
|
|
GetItemsInCollection
|
|
|
|
GetCollection
|
|
GetCollections
|
|
|
|
AddItemToCollection
|
|
RemoveItemFromCollection
|
|
TransferCollection
|
|
|
|
GetCollectionItemBranches
|
|
);
|
|
}
|
|
|
|
=head2 CreateCollection
|
|
( $success, $errorcode, $errormessage ) = CreateCollection( $title, $description );
|
|
|
|
Creates a new collection
|
|
|
|
Input:
|
|
$title: short description of the club or service
|
|
$description: long description of the club or service
|
|
|
|
Output:
|
|
$success: 1 if all database operations were successful, 0 otherwise
|
|
$errorCode: Code for reason of failure, good for translating errors in templates
|
|
$errorMessage: English description of error
|
|
|
|
=cut
|
|
|
|
sub CreateCollection {
|
|
my ( $title, $description ) = @_;
|
|
|
|
my $schema = Koha::Database->new()->schema();
|
|
my $duplicate_titles = $schema->resultset('Collection')->count({ colTitle => $title });
|
|
|
|
## Check for all necessary parameters
|
|
if ( !$title ) {
|
|
return ( 0, 1, "NO_TITLE" );
|
|
} elsif ( $duplicate_titles ) {
|
|
return ( 0, 2, "DUPLICATE_TITLE" );
|
|
}
|
|
|
|
$description ||= q{};
|
|
|
|
my $success = 1;
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my $sth;
|
|
$sth = $dbh->prepare(
|
|
"INSERT INTO collections ( colId, colTitle, colDesc )
|
|
VALUES ( NULL, ?, ? )"
|
|
);
|
|
$sth->execute( $title, $description ) or return ( 0, 3, $sth->errstr() );
|
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
=head2 UpdateCollection
|
|
|
|
( $success, $errorcode, $errormessage ) = UpdateCollection( $colId, $title, $description );
|
|
|
|
Updates a collection
|
|
|
|
Input:
|
|
$colId: id of the collection to be updated
|
|
$title: short description of the club or service
|
|
$description: long description of the club or service
|
|
|
|
Output:
|
|
$success: 1 if all database operations were successful, 0 otherwise
|
|
$errorCode: Code for reason of failure, good for translating errors in templates
|
|
$errorMessage: English description of error
|
|
|
|
=cut
|
|
|
|
sub UpdateCollection {
|
|
my ( $colId, $title, $description ) = @_;
|
|
|
|
my $schema = Koha::Database->new()->schema();
|
|
my $duplicate_titles = $schema->resultset('Collection')->count({ colTitle => $title, -not => { colId => $colId } });
|
|
|
|
## Check for all necessary parameters
|
|
if ( !$colId ) {
|
|
return ( 0, 1, "NO_ID" );
|
|
}
|
|
if ( !$title ) {
|
|
return ( 0, 2, "NO_TITLE" );
|
|
}
|
|
if ( $duplicate_titles ) {
|
|
return ( 0, 3, "DUPLICATE_TITLE" );
|
|
}
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
$description ||= q{};
|
|
|
|
my $sth;
|
|
$sth = $dbh->prepare(
|
|
"UPDATE collections
|
|
SET
|
|
colTitle = ?, colDesc = ?
|
|
WHERE colId = ?"
|
|
);
|
|
$sth->execute( $title, $description, $colId )
|
|
or return ( 0, 4, $sth->errstr() );
|
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
=head2 DeleteCollection
|
|
|
|
( $success, $errorcode, $errormessage ) = DeleteCollection( $colId );
|
|
|
|
Deletes a collection of the given id
|
|
|
|
Input:
|
|
$colId : id of the Archetype to be deleted
|
|
|
|
Output:
|
|
$success: 1 if all database operations were successful, 0 otherwise
|
|
$errorCode: Code for reason of failure, good for translating errors in templates
|
|
$errorMessage: English description of error
|
|
|
|
=cut
|
|
|
|
sub DeleteCollection {
|
|
my ($colId) = @_;
|
|
|
|
## Parameter check
|
|
if ( !$colId ) {
|
|
return ( 0, 1, "NO_ID" );
|
|
}
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my $sth;
|
|
|
|
$sth = $dbh->prepare("DELETE FROM collections WHERE colId = ?");
|
|
$sth->execute($colId) or return ( 0, 4, $sth->errstr() );
|
|
|
|
return 1;
|
|
}
|
|
|
|
=head2 GetCollections
|
|
|
|
$collections = GetCollections();
|
|
|
|
Returns data about all collections
|
|
|
|
Output:
|
|
On Success:
|
|
$results: Reference to an array of associated arrays
|
|
On Failure:
|
|
$errorCode: Code for reason of failure, good for translating errors in templates
|
|
$errorMessage: English description of error
|
|
|
|
=cut
|
|
|
|
sub GetCollections {
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my $sth = $dbh->prepare("SELECT * FROM collections");
|
|
$sth->execute() or return ( 1, $sth->errstr() );
|
|
|
|
my @results;
|
|
while ( my $row = $sth->fetchrow_hashref ) {
|
|
push( @results, $row );
|
|
}
|
|
|
|
return \@results;
|
|
}
|
|
|
|
=head2 GetItemsInCollection
|
|
|
|
( $results, $success, $errorcode, $errormessage ) = GetItemsInCollection( $colId );
|
|
|
|
Returns information about the items in the given collection
|
|
|
|
Input:
|
|
$colId: The id of the collection
|
|
|
|
Output:
|
|
$results: Reference to an array of associated arrays
|
|
$success: 1 if all database operations were successful, 0 otherwise
|
|
$errorCode: Code for reason of failure, good for translating errors in templates
|
|
$errorMessage: English description of error
|
|
|
|
=cut
|
|
|
|
sub GetItemsInCollection {
|
|
my ($colId) = @_;
|
|
|
|
## Parameter check
|
|
if ( !$colId ) {
|
|
return ( 0, 0, 1, "NO_ID" );
|
|
}
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my $sth = $dbh->prepare(
|
|
"SELECT
|
|
biblio.title,
|
|
biblio.biblionumber,
|
|
items.itemcallnumber,
|
|
items.barcode
|
|
FROM collections, collections_tracking, items, biblio
|
|
WHERE collections.colId = collections_tracking.colId
|
|
AND collections_tracking.itemnumber = items.itemnumber
|
|
AND items.biblionumber = biblio.biblionumber
|
|
AND collections.colId = ? ORDER BY biblio.title"
|
|
);
|
|
$sth->execute($colId) or return ( 0, 0, 2, $sth->errstr() );
|
|
|
|
my @results;
|
|
while ( my $row = $sth->fetchrow_hashref ) {
|
|
push( @results, $row );
|
|
}
|
|
|
|
return \@results;
|
|
}
|
|
|
|
=head2 GetCollection
|
|
|
|
( $colId, $colTitle, $colDesc, $colBranchcode ) = GetCollection( $colId );
|
|
|
|
Returns information about a collection
|
|
|
|
Input:
|
|
$colId: Id of the collection
|
|
Output:
|
|
$colId, $colTitle, $colDesc, $colBranchcode
|
|
|
|
=cut
|
|
|
|
sub GetCollection {
|
|
my ($colId) = @_;
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my ( $sth, @results );
|
|
$sth = $dbh->prepare("SELECT * FROM collections WHERE colId = ?");
|
|
$sth->execute($colId) or return 0;
|
|
|
|
my $row = $sth->fetchrow_hashref;
|
|
|
|
return (
|
|
$$row{'colId'}, $$row{'colTitle'},
|
|
$$row{'colDesc'}, $$row{'colBranchcode'}
|
|
);
|
|
|
|
}
|
|
|
|
=head2 AddItemToCollection
|
|
|
|
( $success, $errorcode, $errormessage ) = AddItemToCollection( $colId, $itemnumber );
|
|
|
|
Adds an item to a rotating collection.
|
|
|
|
Input:
|
|
$colId: Collection to add the item to.
|
|
$itemnumber: Item to be added to the collection
|
|
Output:
|
|
$success: 1 if all database operations were successful, 0 otherwise
|
|
$errorCode: Code for reason of failure, good for translating errors in templates
|
|
$errorMessage: English description of error
|
|
|
|
=cut
|
|
|
|
sub AddItemToCollection {
|
|
my ( $colId, $itemnumber ) = @_;
|
|
|
|
## Check for all necessary parameters
|
|
if ( !$colId ) {
|
|
return ( 0, 1, "NO_ID" );
|
|
}
|
|
if ( !$itemnumber ) {
|
|
return ( 0, 2, "NO_ITEM" );
|
|
}
|
|
|
|
if ( isItemInThisCollection( $itemnumber, $colId ) ) {
|
|
return ( 0, 2, "IN_COLLECTION" );
|
|
}
|
|
elsif ( isItemInAnyCollection($itemnumber) ) {
|
|
return ( 0, 3, "IN_COLLECTION_OTHER" );
|
|
}
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my $sth;
|
|
$sth = $dbh->prepare("
|
|
INSERT INTO collections_tracking (
|
|
colId,
|
|
itemnumber
|
|
) VALUES ( ?, ? )
|
|
");
|
|
$sth->execute( $colId, $itemnumber ) or return ( 0, 3, $sth->errstr() );
|
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
=head2 RemoveItemFromCollection
|
|
|
|
( $success, $errorcode, $errormessage ) = RemoveItemFromCollection( $colId, $itemnumber );
|
|
|
|
Removes an item to a collection
|
|
|
|
Input:
|
|
$colId: Collection to add the item to.
|
|
$itemnumber: Item to be removed from collection
|
|
|
|
Output:
|
|
$success: 1 if all database operations were successful, 0 otherwise
|
|
$errorCode: Code for reason of failure, good for translating errors in templates
|
|
$errorMessage: English description of error
|
|
|
|
=cut
|
|
|
|
sub RemoveItemFromCollection {
|
|
my ( $colId, $itemnumber ) = @_;
|
|
|
|
## Check for all necessary parameters
|
|
if ( !$itemnumber ) {
|
|
return ( 0, 2, "NO_ITEM" );
|
|
}
|
|
|
|
if ( !isItemInThisCollection( $itemnumber, $colId ) ) {
|
|
return ( 0, 2, "NOT_IN_COLLECTION" );
|
|
}
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my $sth;
|
|
$sth = $dbh->prepare(
|
|
"DELETE FROM collections_tracking
|
|
WHERE itemnumber = ?"
|
|
);
|
|
$sth->execute($itemnumber) or return ( 0, 3, $sth->errstr() );
|
|
|
|
return 1;
|
|
}
|
|
|
|
=head2 TransferCollection
|
|
|
|
( $success, $messages ) = TransferCollection( $colId, $colBranchcode );
|
|
|
|
Transfers a collection to another branch
|
|
|
|
Input:
|
|
$colId: id of the collection to be updated
|
|
$colBranchcode: branch where collection is moving to
|
|
|
|
Output:
|
|
$success: 1 if all database operations were successful, 0 otherwise
|
|
$messages: Arrayref of messages for user feedback
|
|
|
|
=cut
|
|
|
|
sub TransferCollection {
|
|
my ( $colId, $colBranchcode ) = @_;
|
|
|
|
## Check for all necessary parameters
|
|
if ( !$colId ) {
|
|
return ( 0, [{ type => 'error', code => 'NO_ID' }] );
|
|
}
|
|
if ( !$colBranchcode ) {
|
|
return ( 0, [{ type => 'error', code => 'NO_BRANCHCODE' }] );
|
|
}
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my $sth;
|
|
$sth = $dbh->prepare(
|
|
"UPDATE collections
|
|
SET
|
|
colBranchcode = ?
|
|
WHERE colId = ?"
|
|
);
|
|
$sth->execute( $colBranchcode, $colId ) or return 0;
|
|
my $to_library = Koha::Libraries->find( $colBranchcode );
|
|
|
|
$sth = $dbh->prepare(q{
|
|
SELECT items.itemnumber, items.barcode FROM collections_tracking
|
|
LEFT JOIN items ON collections_tracking.itemnumber = items.itemnumber
|
|
LEFT JOIN issues ON items.itemnumber = issues.itemnumber
|
|
WHERE issues.borrowernumber IS NULL
|
|
AND collections_tracking.colId = ?
|
|
});
|
|
$sth->execute($colId) or return 0;
|
|
my $messages;
|
|
while ( my $item = $sth->fetchrow_hashref ) {
|
|
my $item_object = Koha::Items->find( $item->{itemnumber} );
|
|
try {
|
|
$item_object->request_transfer(
|
|
{
|
|
to => $to_library,
|
|
reason => 'RotatingCollection',
|
|
ignore_limits => 0
|
|
}
|
|
); # Request transfer
|
|
}
|
|
catch {
|
|
if ( $_->isa('Koha::Exceptions::Item::Transfer::InQueue') ) {
|
|
my $exception = $_;
|
|
my $found_transfer = $_->transfer;
|
|
if ( $found_transfer->in_transit
|
|
|| $found_transfer->reason eq 'Reserve' )
|
|
{
|
|
my $transfer = $item_object->request_transfer(
|
|
{
|
|
to => $to_library,
|
|
reason => "RotatingCollection",
|
|
ignore_limits => 0,
|
|
enqueue => 1
|
|
}
|
|
); # Queue transfer
|
|
push @{$messages},
|
|
{
|
|
type => 'alert',
|
|
code => 'enqueued',
|
|
item => $item_object,
|
|
found_transfer => $found_transfer
|
|
};
|
|
}
|
|
else {
|
|
my $transfer = $item_object->request_transfer(
|
|
{
|
|
to => $to_library,
|
|
reason => "RotatingCollection",
|
|
ignore_limits => 0,
|
|
replace => 1
|
|
}
|
|
); # Replace transfer
|
|
# NOTE: If we just replaced a StockRotationAdvance,
|
|
# it will get enqueued afresh on the next cron run
|
|
}
|
|
}
|
|
elsif ( $_->isa('Koha::Exceptions::Item::Transfer::Limit') ) {
|
|
push @{$messages},
|
|
{
|
|
type => 'error',
|
|
code => 'limits',
|
|
item => $item_object
|
|
};
|
|
}
|
|
else {
|
|
$_->rethrow();
|
|
}
|
|
};
|
|
}
|
|
|
|
return (1, $messages);
|
|
}
|
|
|
|
=head2 GetCollectionItemBranches
|
|
|
|
my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
|
|
|
|
=cut
|
|
|
|
sub GetCollectionItemBranches {
|
|
my ($itemnumber) = @_;
|
|
|
|
if ( !$itemnumber ) {
|
|
return;
|
|
}
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my ( $sth, @results );
|
|
$sth = $dbh->prepare(
|
|
"SELECT holdingbranch, colBranchcode FROM items, collections, collections_tracking
|
|
WHERE items.itemnumber = collections_tracking.itemnumber
|
|
AND collections.colId = collections_tracking.colId
|
|
AND items.itemnumber = ?"
|
|
);
|
|
$sth->execute($itemnumber);
|
|
|
|
my $row = $sth->fetchrow_hashref;
|
|
|
|
return ( $$row{'holdingbranch'}, $$row{'colBranchcode'}, );
|
|
}
|
|
|
|
=head2 isItemInThisCollection
|
|
|
|
$inCollection = isItemInThisCollection( $itemnumber, $colId );
|
|
|
|
=cut
|
|
|
|
sub isItemInThisCollection {
|
|
my ( $itemnumber, $colId ) = @_;
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my $sth = $dbh->prepare(
|
|
"SELECT COUNT(*) as inCollection FROM collections_tracking WHERE itemnumber = ? AND colId = ?"
|
|
);
|
|
$sth->execute( $itemnumber, $colId ) or return (0);
|
|
|
|
my $row = $sth->fetchrow_hashref;
|
|
|
|
return $$row{'inCollection'};
|
|
}
|
|
|
|
=head2 isItemInAnyCollection
|
|
|
|
my $inCollection = isItemInAnyCollection( $itemnumber );
|
|
|
|
=cut
|
|
|
|
sub isItemInAnyCollection {
|
|
my ($itemnumber) = @_;
|
|
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my $sth = $dbh->prepare(
|
|
"SELECT itemnumber FROM collections_tracking WHERE itemnumber = ?");
|
|
$sth->execute($itemnumber) or return (0);
|
|
|
|
my $row = $sth->fetchrow_hashref;
|
|
|
|
$itemnumber = $row->{itemnumber};
|
|
if ($itemnumber) {
|
|
return 1;
|
|
}
|
|
else {
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
1;
|
|
|
|
__END__
|
|
|
|
=head1 AUTHOR
|
|
|
|
Kyle Hall <kylemhall@gmail.com>
|
|
|
|
=cut
|