Koha/admin/patron-attr-types.pl
Galen Charlton e30c9d00dd new editor for patron attribute types
Added new script under the Administration menu
to create, update, and delete patron attribute types.

Some things to note:

- once an attribute is created, its code cannot be changed
- the repeatibility and unique_id settings of an
  attribute type cannot be changed after creation -
  this is to avoid having to deal with changing
  constraints if an attribute type is already in use
  by patron records
- an attribute type cannot be deleted if it is
  used by any patron records
- this administration page is always displayed regardless
  of the value of the ExtendedPatronAttributes syspref.  If
  the syspref is off, the page will prompt the superlibrarian
  to turn it on if desired.

Signed-off-by: Joshua Ferraro <jmf@liblime.com>
2008-05-12 09:03:03 -05:00

254 lines
7.9 KiB
Perl
Executable file

#! /usr/bin/perl
#
# Copyright 2008 LibLime
#
# 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 CGI;
use C4::Auth;
use C4::Context;
use C4::Output;
use C4::Koha;
use C4::Members::AttributeTypes;
my $script_name = "/cgi-bin/koha/admin/patron-attr-types.pl";
my $input = new CGI;
my $op = $input->param('op');
my ($template, $loggedinuser, $cookie)
= get_template_and_user({template_name => "admin/patron-attr-types.tmpl",
query => $input,
type => "intranet",
authnotrequired => 0,
flagsrequired => {parameters => 1},
debug => 1,
});
$template->param(script_name => $script_name);
my $code = $input->param("code");
my $display_list = 0;
if ($op eq "edit_attribute_type") {
edit_attribute_type_form($template, $code);
} elsif ($op eq "edit_attribute_type_confirmed") {
$display_list = add_update_attribute_type('edit', $template, $code);
} elsif ($op eq "add_attribute_type") {
add_attribute_type_form($template);
} elsif ($op eq "add_attribute_type_confirmed") {
$display_list = add_update_attribute_type('add', $template, $code);
} elsif ($op eq "delete_attribute_type") {
$display_list = delete_attribute_type_form($template, $code);
} elsif ($op eq "delete_attribute_type_confirmed") {
delete_attribute_type($template, $code);
$display_list = 1;
} else {
$display_list = 1;
}
if ($display_list) {
unless (C4::Context->preference('ExtendedPatronAttributes')) {
$template->param(WARNING_extended_attributes_off => 1);
}
patron_attribute_type_list($template);
}
output_html_with_http_headers $input, $cookie, $template->output;
exit 0;
sub add_attribute_type_form {
my $template = shift;
$template->param(
attribute_type_form => 1,
confirm_op => 'add_attribute_type_confirmed',
);
authorised_value_category_list($template);
}
sub error_add_attribute_type_form {
my $template = shift;
$template->param(description => $input->param('description'));
if ($input->param('repeatable')) {
$template->param(repeatable_checked => 'checked="checked"');
}
if ($input->param('unique_id')) {
$template->param(unique_id_checked => 'checked="checked"');
}
if ($input->param('password_allowed')) {
$template->param(password_allowed_checked => 'checked="checked"');
}
if ($input->param('opac_display')) {
$template->param(opac_display_checked => 'checked="checked"');
}
if ($input->param('staff_searchable')) {
$template->param(staff_searchable_checked => 'checked="checked"');
}
$template->param(
attribute_type_form => 1,
confirm_op => 'add_attribute_type_confirmed',
);
authorised_value_category_list($template, $input->param('authorised_value_category'));
}
sub add_update_attribute_type {
my $op = shift;
my $template = shift;
my $code = shift;
my $description = $input->param('description');
my $attr_type;
if ($op eq 'edit') {
$attr_type = C4::Members::AttributeTypes->fetch($code);
$attr_type->description($description);
} else {
my $existing = C4::Members::AttributeTypes->fetch($code);
if (defined($existing)) {
$template->param(duplicate_code_error => $code);
error_add_attribute_type_form($template);
return 0;
}
$attr_type = C4::Members::AttributeTypes->new($code, $description);
my $repeatable = $input->param('repeatable');
$attr_type->repeatable($repeatable);
my $unique_id = $input->param('unique_id');
$attr_type->unique_id($unique_id);
}
my $opac_display = $input->param('opac_display');
$attr_type->opac_display($opac_display);
my $staff_searchable = $input->param('staff_searchable');
$attr_type->staff_searchable($staff_searchable);
my $authorised_value_category = $input->param('authorised_value_category');
$attr_type->authorised_value_category($authorised_value_category);
my $password_allowed = $input->param('password_allowed');
$attr_type->password_allowed($password_allowed);
if ($op eq 'edit') {
$template->param(edited_attribute_type => $attr_type->code());
} else {
$template->param(added_attribute_type => $attr_type->code());
}
$attr_type->store();
return 1;
}
sub delete_attribute_type_form {
my $template = shift;
my $code = shift;
my $attr_type = C4::Members::AttributeTypes->fetch($code);
my $display_list = 0;
if (defined($attr_type)) {
$template->param(
delete_attribute_type_form => 1,
confirm_op => "delete_attribute_type_confirmed",
code => $code,
description => $attr_type->description(),
);
} else {
$template->param(ERROR_delete_not_found => $code);
$display_list = 1;
}
return $display_list;
}
sub delete_attribute_type {
my $template = shift;
my $code = shift;
my $attr_type = C4::Members::AttributeTypes->fetch($code);
if (defined($attr_type)) {
if ($attr_type->num_patrons() > 0) {
$template->param(ERROR_delete_in_use => $code);
$template->param(ERROR_num_patrons => $attr_type->num_patrons());
} else {
$attr_type->delete();
$template->param(deleted_attribute_type => $code);
}
} else {
$template->param(ERROR_delete_not_found => $code);
}
}
sub edit_attribute_type_form {
my $template = shift;
my $code = shift;
my $attr_type = C4::Members::AttributeTypes->fetch($code);
$template->param(code => $code);
$template->param(description => $attr_type->description());
if ($attr_type->repeatable()) {
$template->param(repeatable_checked => 'checked="checked"');
}
$template->param(repeatable_disabled => 'disabled="disabled"');
if ($attr_type->unique_id()) {
$template->param(unique_id_checked => 'checked="checked"');
}
$template->param(unique_id_disabled => 'disabled="disabled"');
if ($attr_type->password_allowed()) {
$template->param(password_allowed_checked => 'checked="checked"');
}
if ($attr_type->opac_display()) {
$template->param(opac_display_checked => 'checked="checked"');
}
if ($attr_type->staff_searchable()) {
$template->param(staff_searchable_checked => 'checked="checked"');
}
authorised_value_category_list($template, $attr_type->authorised_value_category());
$template->param(
attribute_type_form => 1,
edit_attribute_type => 1,
confirm_op => 'edit_attribute_type_confirmed',
);
}
sub patron_attribute_type_list {
my $template = shift;
my @attr_types = C4::Members::AttributeTypes::GetAttributeTypes();
$template->param(available_attribute_types => \@attr_types);
$template->param(display_list => 1);
}
sub authorised_value_category_list {
my $template = shift;
my $selected = @_ ? shift : '';
my $categories = GetAuthorisedValueCategories();
my @list = ();
foreach my $category (@$categories) {
my $entry = { category => $category };
$entry->{selected} = 1 if $category eq $selected;
push @list, $entry;
}
$template->param(authorised_value_categories => \@list);
}