Koha/admin/itemtypes.pl
ahmed 30edfbfa58 Bug 10937: Option to hide and group itemtypes from advanced search
This allows to group certain item types in a category, to be displayed (and searched) as such in OPAC's advanced search.  For example, you can group Reserve 2h and Reserve 12h into a Reserve category.  The 2 and 12h types won't appear anymore.
This also allows to simply prevent an item type from displaying as a search option.

TEST PLAN
------------------
0) Back up database, so you can reset and retest easily. ;)
1) Apply the patch
2) Run Koha QA tool.
3) prove -v t/db_dependent/Koha.t
  -- all tests should pass.
  4) run ./installer/data/mysql/updatedatabase.pl to add the
  two columns to itemtypes
  -- Does a meaningful message get printed?
  Are the columns added?
  "DESCRIBE itemtypes;" should list hideinopac and searchcategory.
  5) You need to add a category to group your item types:
  a) In Intranet/Koha Admin/Authorized values,
  select DOCTYPECAT in the 'Show category:' dropdown
  i) If you do not have a DOCTYPECAT category, create one.
  b) Click button "New authorized value for DOCTYPECAT"
  c) Enter
  Authorized value: HARDWARE
  Description : Hardware
  Description (OPAC): Hardware
  6) Group your items under that new category
  a) In Intranet/Koha Admin/Item types, choose (at least)
  two item types and for each:
  - Click action/Edit on the right column
  - Third row (below Description) is the Search category list box, select Hardware
  - click Save changes at the bottom
  7) Select at least one item to be hidden in the OPAC search
  a) In Intranet/Koha Admin/Item types (again), choose a different item type:
  -  Click action/Edit
  -  Click the checkbox "Hide in OPAC" below the list of icons.
  8) Go test your modifications
  a) Go to OPAC/Adv search.
  b) Validate that all items modified above (hidden or grouped) do not appear in Item type list
  c) Validate that new item type Hardware does appear instead.
  d) Select item Hardware, start Search.
  ) Validate returned items are the of the two types that were grouped into the Hardware category in step 4.

Sponsored-by: Vanier college

Signed-off-by: Nick <nick@quecheelibrary.org>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2015-10-22 11:06:07 -03:00

277 lines
9.4 KiB
Perl
Executable file

#!/usr/bin/perl
# 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 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>.
=head1 admin/itemtypes.pl
script to administer the categories table
written 20/02/2002 by paul.poulain@free.fr
This software is placed under the gnu General Public License, v2 (http://www.gnu.org/licenses/gpl.html)
ALGO :
this script use an $op to know what to do.
if $op is empty or none of the above values,
- the default screen is build (with all records, or filtered datas).
- the user can clic on add, modify or delete record.
if $op=add_form
- if primkey exists, this is a modification,so we read the $primkey record
- builds the add/modify form
if $op=add_validate
- the user has just send datas, so we create/modify the record
if $op=delete_form
- we show the record having primkey=$primkey and ask for deletion validation form
if $op=delete_confirm
- we delete the record having primkey=$primkey
=cut
use strict;
#use warnings; FIXME - Bug 2505
use CGI qw ( -utf8 );
use List::Util qw/min/;
use File::Spec;
use C4::Koha;
use C4::Context;
use C4::Auth;
use C4::Output;
sub StringSearch {
my ( $searchstring, $type ) = @_;
my $dbh = C4::Context->dbh;
$searchstring =~ s/\'/\\\'/g;
my @data = split( ' ', $searchstring );
my $sth = $dbh->prepare(
"SELECT * FROM itemtypes WHERE (description LIKE ?) ORDER BY itemtype"
);
$sth->execute("$data[0]%");
return $sth->fetchall_arrayref({}); # return ref-to-array of ref-to-hashes
# like [ fetchrow_hashref(), fetchrow_hashref() ... ]
}
my $input = new CGI;
my $searchfield = $input->param('description');
my $script_name = "/cgi-bin/koha/admin/itemtypes.pl";
my $itemtype = $input->param('itemtype');
my $op = $input->param('op') // 'list';
my @messages;
$searchfield =~ s/\,//g;
my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
{
template_name => "admin/itemtypes.tt",
query => $input,
type => "intranet",
authnotrequired => 0,
flagsrequired => { parameters => 'parameters_remaining_permissions' },
debug => 1,
}
);
$template->param(script_name => $script_name);
if ($op) {
$template->param($op => 1); # we show only the TMPL_VAR names $op
}
my $dbh = C4::Context->dbh;
my $sip_media_type = $input->param('sip_media_type');
undef($sip_media_type) if defined($sip_media_type) and $sip_media_type =~ /^\s*$/;
################## ADD_FORM ##################################
# called by default. Used to create form to add or modify a record
if ( $op eq 'add_form' ) {
#---- if primkey exists, it's a modify action, so read values to modify...
my $data;
if ($itemtype) {
my $sth = $dbh->prepare("select * from itemtypes where itemtype=?");
$sth->execute($itemtype);
$data = $sth->fetchrow_hashref;
}
my $imagesets = C4::Koha::getImageSets( checked => $data->{'imageurl'} );
my $remote_image = undef;
if ( defined $data->{imageurl} and $data->{imageurl} =~ /^http/i ) {
$remote_image = $data->{imageurl};
}
my $searchcategory = GetAuthorisedValues("DOCTYPECAT", $data->{'searchcategory'});
$template->param(
itemtype => $itemtype,
description => $data->{'description'},
rentalcharge => sprintf( "%.2f", $data->{'rentalcharge'} ),
notforloan => $data->{'notforloan'},
imageurl => $data->{'imageurl'},
template => C4::Context->preference('template'),
summary => $data->{summary},
checkinmsg => $data->{'checkinmsg'},
checkinmsgtype => $data->{'checkinmsgtype'},
imagesets => $imagesets,
remote_image => $remote_image,
sip_media_type => $data->{sip_media_type},
hideinopac => $data->{'hideinopac'},
searchcategory => $searchcategory,
);
# END $OP eq ADD_FORM
################## ADD_VALIDATE ##################################
# called by add_form, used to insert/modify data in DB
}
elsif ( $op eq 'add_validate' ) {
my $is_a_modif = $input->param('is_a_modif');
my ( $already_exists ) = $dbh->selectrow_array(q|
SELECT itemtype
FROM itemtypes
WHERE itemtype = ?
|, undef, $itemtype );
if ( $already_exists and $is_a_modif ) { # it's a modification
my $query2 = '
UPDATE itemtypes
SET description = ?
, rentalcharge = ?
, notforloan = ?
, imageurl = ?
, summary = ?
, checkinmsg = ?
, checkinmsgtype = ?
, sip_media_type = ?
, hideinopac = ?
, searchcategory = ?
WHERE itemtype = ?
';
my $sth = $dbh->prepare($query2);
$sth->execute(
$input->param('description'),
$input->param('rentalcharge'),
( $input->param('notforloan') ? 1 : 0 ),
(
$input->param('image') eq 'removeImage' ? '' : (
$input->param('image') eq 'remoteImage'
? $input->param('remoteImage')
: $input->param('image') . ""
)
),
$input->param('summary'),
$input->param('checkinmsg'),
$input->param('checkinmsgtype'),
$sip_media_type,
$input->param('hideinopac') ? 1 : 0,
$input->param('searchcategory'),
$input->param('itemtype')
);
}
elsif ( not $already_exists and not $is_a_modif ) {
my $query = "
INSERT INTO itemtypes
(itemtype,description,rentalcharge, notforloan, imageurl, summary, checkinmsg, checkinmsgtype, sip_media_type, hideinopac, searchcategory)
VALUES
(?,?,?,?,?,?,?,?,?,?,?);
";
my $sth = $dbh->prepare($query);
my $image = $input->param('image');
$sth->execute(
$input->param('itemtype'),
$input->param('description'),
$input->param('rentalcharge'),
$input->param('notforloan') ? 1 : 0,
$image eq 'removeImage' ? '' :
$image eq 'remoteImage' ? $input->param('remoteImage') :
$image,
$input->param('summary'),
$input->param('checkinmsg'),
$input->param('checkinmsgtype'),
$sip_media_type,
$input->param('hideinopac') ? 1 : 0,
$input->param('searchcategory'),
);
}
else {
push @messages, {
type => 'error',
code => 'already_exists',
};
}
$searchfield = '';
$op = 'list';
# END $OP eq ADD_VALIDATE
################## DELETE_CONFIRM ##################################
# called by default form, used to confirm deletion of data in DB
}
elsif ( $op eq 'delete_confirm' ) {
# Check both items and biblioitems
my $sth = $dbh->prepare('
SELECT COUNT(*) AS total FROM (
SELECT itemtype AS t FROM biblioitems
UNION ALL
SELECT itype AS t FROM items
) AS tmp
WHERE tmp.t=?
');
$sth->execute($itemtype);
my $total = $sth->fetchrow_hashref->{'total'};
my $sth =
$dbh->prepare(
"select itemtype,description,rentalcharge from itemtypes where itemtype=?"
);
$sth->execute($itemtype);
my $data = $sth->fetchrow_hashref;
$template->param(
itemtype => $itemtype,
description => $data->{description},
rentalcharge => sprintf( "%.2f", $data->{rentalcharge} ),
imageurl => $data->{imageurl},
total => $total
);
# END $OP eq DELETE_CONFIRM
################## DELETE_CONFIRMED ##################################
# called by delete_confirm, used to effectively confirm deletion of data in DB
}
elsif ( $op eq 'delete_confirmed' ) {
my $itemtype = uc( $input->param('itemtype') );
my $sth = $dbh->prepare("delete from itemtypes where itemtype=?");
$sth->execute($itemtype);
$sth = $dbh->prepare("delete from issuingrules where itemtype=?");
$sth->execute($itemtype);
print $input->redirect('itemtypes.pl');
exit;
# END $OP eq DELETE_CONFIRMED
################## DEFAULT ##################################
}
if ( $op eq 'list' ) {
my ($results) = StringSearch( $searchfield, 'web' );
my @loop;
foreach my $itemtype ( @{$results} ) {
$itemtype->{imageurl} = getitemtypeimagelocation( 'intranet', $itemtype->{imageurl} );
$itemtype->{rentalcharge} = sprintf( '%.2f', $itemtype->{rentalcharge} );
push( @loop, $itemtype );
}
$template->param(
loop => \@loop,
else => 1,
messages => \@messages,
);
}
output_html_with_http_headers $input, $cookie, $template->output;