Jonathan Druart
19a977dc7b
This is the fourth and last patch set to remove C4::Branch. The real purpose of this patch is to standardise and refactor some code which is related to the libraries selection/display. Its unconfessed purpose is to remove the C4::Branch package. Before this patch set, only 6 subroutines still existed in the C4::Branch package: - GetBranchName - GetBranchesLoop - mybranch - onlymine - GetBranches - GetBranch GetBranchName basically returns the branchname for a given branchcode. The branchname is only used for a display purpose and we don't need to retrieve it in package or pl scripts (unless for a few exceptions). We have a `Branches` template plugin with a `GetName` method which does exactly this job. To achieve this removal, we will use this template plugin and delete the GetBranchName from pl and pm files. The `Branches.all()` will now select the library of the logged in user if no `selected` parameter has been passed. This new behavior could cause regressions, for instance there are some places where we do not want an option preselected (batch item modification for instance), keep that in mind when testing. GetBranchesLoop took 3 parameters: $branch and $onlymine. The first one was used to set a "selected" flag, for a display purpose: select an option in the libraries dropdown lists. The second one was useless: If not passed or set to 0, the `C4::Branch::onlymine` subroutine was called. This onlymine flag was use to know if the logged in user was able to see other libraries infos. A patron can see the infos from other libraries if IndependentBranches is not set OR if he has the superlibrarian permission. Prior to this patch set, the "onlymine test" was done on different places (neworderempty.pl, additem.pl, holidays.pl, etc.), including the Branches TT plugin. In this patch set, this test is only done on one place (C4::Context::only_my_library, code moved from C4::Branch::onlymine). To accomplish the same job as this subroutine, we just need to call the `Branches.all()` method from the `Branches` TT plugin. It already accepts a `selected` parameter to set a flag on the option to select. To avoid the repetitive [% IF selected %]<option selected="selected">[% ELSE %]<option>[% END %] pattern, a new `html_helpers` TT include file has been created, it defines an `options_for_libraries` block, which takes a `selected` parameter. We could imagine to use this include file for other selects. The 'mybranch` and `onlymine` subroutines of the C4::Branch package have been moved to C4::Context. onlymine has been renamed with only_my_library. There are only 4 occurrences of it, against 11 before this patch set. There 2 subroutines are Context-centric and it makes sense to put them in `C4::Context` (at least it's the least worst place!) GetBranches is the tricky part of this patch set: It retrieves all the libraries, independently of the value of IndependentBranches. To keep the same way as the existing calls of `Branches.all()`, I have added a `unfiltered` parameter. If set, the `Branches.all()` will call a usual Koha::Libraries->search method, otherwise Koha::Libraries->search_filtered will be called. This new method will check if the logged in user is allowed to see other libraries or only its library. Note that this `GetBranches` subroutine also created a `category` key: it allowed to get the list of groups (of libraries) where this library existed. Thanks to a previous patch set (bug 15295), this value was not used anymore (I may have missed something!). Note that the only use of `GetBranch` was buggy (see bug 15746). Test plan (for the whole patch set): The best way to test this whole patch set is to test with 2 instances: 1 with the patch set applied, 1 using master, to be sure there is no regression. It would be good to test the same with `IndependentBranches` and the without `IndependentBranches`. No difference should be found. The tester must focus on the library dropdowns on as many forms as possible. You will notice changes in the order of the options: the libraries will now be ordered by branchname (instead of branchcode in some places). A special attention will be given to the following page: - acqui/neworderempty.pl - catalogue/search.pl - members/members-home.pl (header?) - opac/opac-topissues.pl - tools/holidays.pl - admin/branch_transfer_limits.pl - admin/item_circulation_alerts.pl - rotating_collections/transferCollection.pl - suggestion/suggestion.pl - tools/export.pl Notes for QA: - There are 2 FIXMEs in the patch set, I have kept the existing behavior, but I am not sure it's the good one. Feel free to open a bug report and I will fill a patch if you think it's not correct. Otherwise, remove the FIXME lines in a follow-up patch. - The whole patch set is huge and makes a lot of changes. But it finally will tremendously reduce the number of lines: 716 insertions for 1910 deletions Signed-off-by: Owen Leonard <oleonard@myacpl.org> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
159 lines
6.4 KiB
Perl
Executable file
159 lines
6.4 KiB
Perl
Executable file
#!/usr/bin/perl
|
|
|
|
#
|
|
# 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 strict;
|
|
#use warnings; FIXME - Bug 2505
|
|
use C4::Context;
|
|
use CGI qw ( -utf8 );
|
|
use C4::Output;
|
|
use C4::Auth;
|
|
use C4::Overdues; # AddNotifyLine
|
|
use C4::Biblio;
|
|
use C4::Koha;
|
|
use C4::Debug;
|
|
use C4::Branch;
|
|
use Koha::DateUtils;
|
|
use Data::Dumper;
|
|
|
|
=head1 branchoverdues.pl
|
|
|
|
this module is a new interface, allow to the librarian to check all items on overdues (based on the acountlines type 'FU' )
|
|
this interface is filtered by branches (automatically), and by location (optional) ....
|
|
all informations are stocked in the notifys BDD
|
|
|
|
FIXME for this time, we have only four methods to notify :
|
|
- mail : work with a batch programm
|
|
- letter : for us, the letters are generated by an open-office program
|
|
- phone : Simple method, when the method 'phone' is selected, we consider, that the borrower as been notified, and the notify send date is implemented
|
|
- considered lost : for us if the document is on the third overduelevel,
|
|
|
|
FIXME the methods are actually hardcoded for the levels : (maybe can be improved by a new possibility in overduerule)
|
|
|
|
level 1 : three methods are possible : - mail, letter, phone
|
|
level 2 : only one method is possible : - letter
|
|
level 3 : only methode is possible : - Considered Lost
|
|
|
|
the documents displayed on this interface, are checked on three points
|
|
- 1) the document must be on accountlines (Type 'FU')
|
|
- 2) item issues is not returned
|
|
- 3) this item as not been already notify
|
|
|
|
FIXME: who is the author?
|
|
FIXME: No privisions (i.e. "actions") for handling notices are implemented.
|
|
FIXME: This is linked as "Overdue Fines" but the relationship to fines in GetOverduesForBranch is more complicated than that.
|
|
|
|
=cut
|
|
|
|
my $input = new CGI;
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my ( $template, $loggedinuser, $cookie ) = get_template_and_user({
|
|
template_name => "circ/branchoverdues.tt",
|
|
query => $input,
|
|
type => "intranet",
|
|
authnotrequired => 0,
|
|
flagsrequired => { circulate => "circulate_remaining_permissions" },
|
|
debug => 1,
|
|
});
|
|
|
|
my $default = C4::Context->userenv->{'branch'};
|
|
|
|
# Deal with the vars recept from the template
|
|
my $borrowernumber = $input->param('borrowernumber');
|
|
my $itemnumber = $input->param('itemnumber');
|
|
my $method = $input->param('method');
|
|
my $overduelevel = $input->param('overduelevel');
|
|
my $notifyId = $input->param('notifyId');
|
|
my $location = $input->param('location');
|
|
|
|
# FIXME: better check that borrowernumber is defined and valid.
|
|
# FIXME: same for itemnumber and other variables passed in here.
|
|
|
|
# now create the line in bdd (notifys)
|
|
if ( $input->param('action') eq 'add' ) {
|
|
my $addnotify =
|
|
AddNotifyLine( $borrowernumber, $itemnumber, $overduelevel, $method,
|
|
$notifyId ) # FIXME: useless variable, no TMPL code for "action" exists.;
|
|
}
|
|
elsif ( $input->param('action') eq 'remove' ) {
|
|
my $notify_date = $input->param('notify_date');
|
|
my $removenotify =
|
|
RemoveNotifyLine( $borrowernumber, $itemnumber, $notify_date ); # FIXME: useless variable, no TMPL code for "action" exists.
|
|
}
|
|
|
|
my @overduesloop;
|
|
my @getoverdues = GetOverduesForBranch( $default, $location );
|
|
$debug and warn "HERE : $default / $location" . Dumper(@getoverdues);
|
|
# search for location authorised value
|
|
my ($tag,$subfield) = GetMarcFromKohaField('items.location','');
|
|
my $tagslib = &GetMarcStructure(1,'');
|
|
if ($tagslib->{$tag}->{$subfield}->{authorised_value}) {
|
|
my $values= GetAuthorisedValues($tagslib->{$tag}->{$subfield}->{authorised_value});
|
|
for (@$values) { $_->{selected} = 1 if $location eq $_->{authorised_value} }
|
|
$template->param(locationsloop => $values);
|
|
}
|
|
# now display infos
|
|
foreach my $num (@getoverdues) {
|
|
my %overdueforbranch;
|
|
my $record = GetMarcBiblio($num->{biblionumber});
|
|
if ($record){
|
|
$overdueforbranch{'subtitle'} = GetRecordValue('subtitle',$record,'')->[0]->{subfield};
|
|
}
|
|
my $dt = dt_from_string($num->{date_due}, 'sql');
|
|
$overdueforbranch{'date_due'} = output_pref($dt);
|
|
$overdueforbranch{'title'} = $num->{'title'};
|
|
$overdueforbranch{'description'} = $num->{'description'};
|
|
$overdueforbranch{'barcode'} = $num->{'barcode'};
|
|
$overdueforbranch{'biblionumber'} = $num->{'biblionumber'};
|
|
$overdueforbranch{'author'} = $num->{'author'};
|
|
$overdueforbranch{'borrowersurname'} = $num->{'surname'};
|
|
$overdueforbranch{'borrowerfirstname'} = $num->{'firstname'};
|
|
$overdueforbranch{'borrowerphone'} = $num->{'phone'};
|
|
$overdueforbranch{'borroweremail'} = $num->{'email'};
|
|
$overdueforbranch{'homebranch'} = $num->{'homebranch'};
|
|
$overdueforbranch{'itemcallnumber'} = $num->{'itemcallnumber'};
|
|
$overdueforbranch{'borrowernumber'} = $num->{'borrowernumber'};
|
|
$overdueforbranch{'itemnumber'} = $num->{'itemnumber'};
|
|
$overdueforbranch{'cardnumber'} = $num->{'cardnumber'};
|
|
|
|
# now we add on the template, the differents values of notify_level
|
|
# FIXME: numerical comparison, not string eq.
|
|
if ( $num->{'notify_level'} eq '1' ) {
|
|
$overdueforbranch{'overdue1'} = 1;
|
|
$overdueforbranch{'overdueLevel'} = 1;
|
|
}
|
|
elsif ( $num->{'notify_level'} eq '2' ) {
|
|
$overdueforbranch{'overdue2'} = 1;
|
|
$overdueforbranch{'overdueLevel'} = 2;
|
|
}
|
|
elsif ( $num->{'notify_level'} eq '3' ) {
|
|
$overdueforbranch{'overdue3'} = 1;
|
|
$overdueforbranch{'overdueLevel'} = 3;
|
|
}
|
|
$overdueforbranch{'notify_id'} = $num->{'notify_id'};
|
|
|
|
push( @overduesloop, \%overdueforbranch );
|
|
}
|
|
|
|
# initiate the templates for the overdueloop
|
|
$template->param(
|
|
overduesloop => \@overduesloop,
|
|
location => $location,
|
|
);
|
|
|
|
output_html_with_http_headers $input, $cookie, $template->output;
|