Koha/about.pl
Andrew Isherwood 1c8952a36b Bug 20996: Remove prefix use of borrower category
This patch removes the potential use of borrower category as a ILL
request ID prefix. It makes no sense. We provide the ability for a site
to define a request prefix based on branch, there is no use case for
using the borrower category. Add to this that the borrower for every
request was being retrieved in order to get the category, it's a huge
performance hit also.

We also now require the <branch> block in the <interlibrary_loans> block
and complain if it's not present. The request prefix should be defined
in this block.

This patch also improves the performance of the API request that returns all
requests, optionally including additional data.

It also deprecates the overloaded TO_JSON method and moves the request
augmentation code into the API route's controller. It may be that we
want to shift it out of there at some point, but it is fine where it is
for now.

Signed-off-by: Magnus Enger <magnus@libriotech.no>

Signed-off-by: Josef Moravec <josef.moravec@gmail.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
2018-11-02 10:33:02 +00:00

548 lines
18 KiB
Perl
Executable file

#!/usr/bin/perl
# Copyright Pat Eyler 2003
# Copyright Biblibre 2006
# Parts Copyright Liblime 2008
# Parts Copyright Chris Nighswonger 2010
#
# 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 CGI qw ( -utf8 );
use DateTime::TimeZone;
use File::Spec;
use List::MoreUtils qw/ any /;
use LWP::Simple;
use Module::Load::Conditional qw(can_load);
use XML::Simple;
use Config;
use Search::Elasticsearch;
use Try::Tiny;
use C4::Output;
use C4::Auth;
use C4::Context;
use C4::Installer;
use Koha;
use Koha::DateUtils qw(dt_from_string output_pref);
use Koha::Acquisition::Currencies;
use Koha::Patron::Categories;
use Koha::Patrons;
use Koha::Caches;
use Koha::Config::SysPrefs;
use Koha::Illrequest::Config;
use Koha::SearchEngine::Elasticsearch;
use C4::Members::Statistics;
#use Smart::Comments '####';
my $query = new CGI;
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
{
template_name => "about.tt",
query => $query,
type => "intranet",
authnotrequired => 0,
flagsrequired => { catalogue => 1 },
debug => 1,
}
);
my $config_timezone = C4::Context->config('timezone') // '';
my $config_invalid = !DateTime::TimeZone->is_valid_name( $config_timezone );
my $env_timezone = $ENV{TZ} // '';
my $env_invalid = !DateTime::TimeZone->is_valid_name( $env_timezone );
my $actual_bad_tz_fallback = 0;
if ( $config_timezone ne '' &&
$config_invalid ) {
# Bad config
$actual_bad_tz_fallback = 1;
}
elsif ( $config_timezone eq '' &&
$env_timezone ne '' &&
$env_invalid ) {
# No config, but bad ENV{TZ}
$actual_bad_tz_fallback = 1;
}
my $time_zone = {
actual => C4::Context->tz->name,
actual_bad_tz_fallback => $actual_bad_tz_fallback,
config => $config_timezone,
config_invalid => $config_invalid,
environment => $env_timezone,
environment_invalid => $env_invalid
};
$template->param(
time_zone => $time_zone,
current_date_and_time => output_pref({ dt => dt_from_string(), dateformat => 'iso' })
);
my $perl_path = $^X;
if ($^O ne 'VMS') {
$perl_path .= $Config{_exe} unless $perl_path =~ m/$Config{_exe}$/i;
}
my $zebraVersion = `zebraidx -V`;
# Check running PSGI env
if ( any { /(^psgi\.|^plack\.)/i } keys %ENV ) {
$template->param(
is_psgi => 1,
psgi_server => ($ENV{ PLACK_ENV }) ? "Plack ($ENV{PLACK_ENV})" :
($ENV{ MOD_PERL }) ? "mod_perl ($ENV{MOD_PERL})" :
'Unknown'
);
}
# Memcached configuration
my $memcached_servers = $ENV{MEMCACHED_SERVERS} || C4::Context->config('memcached_servers');
my $memcached_namespace = $ENV{MEMCACHED_NAMESPACE} || C4::Context->config('memcached_namespace') // 'koha';
my $cache = Koha::Caches->get_instance;
my $effective_caching_method = ref($cache->cache);
# Memcached may have been running when plack has been initialized but could have been stopped since
# FIXME What are the consequences of that??
my $is_memcached_still_active = $cache->set_in_cache('test_for_about_page', "just a simple value");
my $where_is_memcached_config = 'nowhere';
if ( $ENV{MEMCACHED_SERVERS} and C4::Context->config('memcached_servers') ) {
$where_is_memcached_config = 'both';
} elsif ( $ENV{MEMCACHED_SERVERS} and not C4::Context->config('memcached_servers') ) {
$where_is_memcached_config = 'ENV_only';
} elsif ( C4::Context->config('memcached_servers') ) {
$where_is_memcached_config = 'config_only';
}
$template->param(
effective_caching_method => $effective_caching_method,
memcached_servers => $memcached_servers,
memcached_namespace => $memcached_namespace,
is_memcached_still_active => $is_memcached_still_active,
where_is_memcached_config => $where_is_memcached_config,
memcached_running => Koha::Caches->get_instance->memcached_cache,
);
# Additional system information for warnings
my $warnStatisticsFieldsError;
my $prefStatisticsFields = C4::Context->preference('StatisticsFields');
if ($prefStatisticsFields) {
$warnStatisticsFieldsError = $prefStatisticsFields
unless ( $prefStatisticsFields eq C4::Members::Statistics->get_fields() );
}
my $prefAutoCreateAuthorities = C4::Context->preference('AutoCreateAuthorities');
my $prefBiblioAddsAuthorities = C4::Context->preference('BiblioAddsAuthorities');
my $warnPrefBiblioAddsAuthorities = ( $prefAutoCreateAuthorities && ( !$prefBiblioAddsAuthorities) );
my $prefEasyAnalyticalRecords = C4::Context->preference('EasyAnalyticalRecords');
my $prefUseControlNumber = C4::Context->preference('UseControlNumber');
my $warnPrefEasyAnalyticalRecords = ( $prefEasyAnalyticalRecords && $prefUseControlNumber );
my $warnPrefAnonymousPatron = (
C4::Context->preference('OPACPrivacy')
and not C4::Context->preference('AnonymousPatron')
);
my $anonymous_patron = Koha::Patrons->find( C4::Context->preference('AnonymousPatron') );
my $warnPrefAnonymousPatron_PatronDoesNotExist = ( not $anonymous_patron and Koha::Patrons->search({ privacy => 2 })->count );
my $errZebraConnection = C4::Context->Zconn("biblioserver",0)->errcode();
my $warnIsRootUser = (! $loggedinuser);
my $warnNoActiveCurrency = (! defined Koha::Acquisition::Currencies->get_active);
my @xml_config_warnings;
my $context = new C4::Context;
if ( C4::Context->config('zebra_bib_index_mode')
and C4::Context->config('zebra_bib_index_mode') eq 'grs1' )
{
push @xml_config_warnings, { error => 'zebra_bib_index_mode_is_grs1' };
}
if ( C4::Context->config('zebra_auth_index_mode')
and C4::Context->config('zebra_auth_index_mode') eq 'grs1' )
{
push @xml_config_warnings, { error => 'zebra_auth_index_mode_is_grs1' };
}
if ( (C4::Context->config('zebra_auth_index_mode') eq 'dom') && ($context->{'server'}->{'authorityserver'}->{'config'} !~ /zebra-authorities-dom.cfg/) ) {
push @xml_config_warnings, {
error => 'zebra_auth_index_mode_mismatch_warn'
};
}
if ( ! defined C4::Context->config('log4perl_conf') ) {
push @xml_config_warnings, {
error => 'log4perl_entry_missing'
}
}
if ( ! defined C4::Context->config('upload_path') ) {
if ( Koha::Config::SysPrefs->find('OPACBaseURL')->value ) {
# OPACBaseURL seems to be set
push @xml_config_warnings, {
error => 'uploadpath_entry_missing'
}
} else {
push @xml_config_warnings, {
error => 'uploadpath_and_opacbaseurl_entry_missing'
}
}
}
if ( ! C4::Context->config('tmp_path') ) {
my $temporary_directory = C4::Context::temporary_directory;
push @xml_config_warnings, {
error => 'tmp_path_missing',
effective_tmp_dir => $temporary_directory,
}
}
# Test QueryParser configuration sanity
if ( C4::Context->preference( 'UseQueryParser' ) ) {
# Get the QueryParser configuration file name
my $queryparser_file = C4::Context->config( 'queryparser_config' );
my $queryparser_fallback_file = '/etc/koha/searchengine/queryparser.yaml';
# Check QueryParser is functional
my $QParser = C4::Context->queryparser();
my $queryparser_error = {};
if ( ! defined $QParser || ref($QParser) ne 'Koha::QueryParser::Driver::PQF' ) {
# Error initializing the QueryParser object
# Get the used queryparser.yaml file path to report the user
$queryparser_error->{ fallback } = ( defined $queryparser_file ) ? 0 : 1;
$queryparser_error->{ file } = ( defined $queryparser_file )
? $queryparser_file
: $queryparser_fallback_file;
# Report error data to the template
$template->param( QueryParserError => $queryparser_error );
} else {
# Check for an absent queryparser_config entry in koha-conf.xml
if ( ! defined $queryparser_file ) {
# Not an error but a warning for the missing entry in koha-conf-xml
push @xml_config_warnings, {
error => 'queryparser_entry_missing',
file => $queryparser_fallback_file
};
}
}
}
# Test Zebra facets configuration
if ( !defined C4::Context->config('use_zebra_facets') ) {
push @xml_config_warnings, { error => 'use_zebra_facets_entry_missing' };
}
# ILL module checks
if ( C4::Context->preference('ILLModule') ) {
my $warnILLConfiguration = 0;
my $ill_config_from_file = C4::Context->config("interlibrary_loans");
my $ill_config = Koha::Illrequest::Config->new;
my $available_ill_backends =
( scalar @{ $ill_config->available_backends } > 0 );
# Check backends
if ( !$available_ill_backends ) {
$template->param( no_ill_backends => 1 );
$warnILLConfiguration = 1;
}
# Check partner_code
if ( !Koha::Patron::Categories->find($ill_config->partner_code) ) {
$template->param( ill_partner_code_doesnt_exist => $ill_config->partner_code );
$warnILLConfiguration = 1;
}
if ( !$ill_config_from_file->{partner_code} ) {
# partner code not defined
$template->param( ill_partner_code_not_defined => 1 );
$warnILLConfiguration = 1;
}
if ( !$ill_config_from_file->{branch} ) {
# branch not defined
$template->param( ill_branch_not_defined => 1 );
$warnILLConfiguration = 1;
}
$template->param( warnILLConfiguration => $warnILLConfiguration );
}
if ( C4::Context->preference('SearchEngine') eq 'Elasticsearch' ) {
# Check ES configuration health and runtime status
my $es_status;
my $es_config_error;
my $es_running = 1;
my $es_conf;
try {
$es_conf = Koha::SearchEngine::Elasticsearch::_read_configuration();
}
catch {
if ( ref($_) eq 'Koha::Exceptions::Config::MissingEntry' ) {
$template->param( elasticsearch_fatal_config_error => $_->message );
$es_config_error = 1;
}
};
if ( !$es_config_error ) {
my $biblios_index_name = $es_conf->{index_name} . "_" . $Koha::SearchEngine::BIBLIOS_INDEX;
my $authorities_index_name = $es_conf->{index_name} . "_" . $Koha::SearchEngine::AUTHORITIES_INDEX;
my @indexes = ($biblios_index_name, $authorities_index_name);
# TODO: When new indexes get added, we could have other ways to
# fetch the list of available indexes (e.g. plugins, etc)
$es_status->{nodes} = $es_conf->{nodes};
my $es = Search::Elasticsearch->new({ nodes => $es_conf->{nodes} });
foreach my $index ( @indexes ) {
my $count;
try {
$count = $es->indices->stats( index => $index )
->{_all}{primaries}{docs}{count};
}
catch {
if ( ref($_) eq 'Search::Elasticsearch::Error::Missing' ) {
push @{ $es_status->{errors} }, "Index not found ($index)";
$count = -1;
}
elsif ( ref($_) eq 'Search::Elasticsearch::Error::NoNodes' ) {
$es_running = 0;
}
else {
# TODO: when time comes, we will cover more use cases
die $_;
}
};
push @{ $es_status->{indexes} },
{
index_name => $index,
count => $count
};
}
$es_status->{running} = $es_running;
$template->param( elasticsearch_status => $es_status );
}
}
if ( C4::Context->preference('RESTOAuth2ClientCredentials') ) {
# Do we have the required deps?
unless ( can_load( modules => { 'Net::OAuth2::AuthorizationServer' => undef }) ) {
$template->param( oauth2_missing_deps => 1 );
}
}
# Sco Patron should not contain any other perms than circulate => self_checkout
if ( C4::Context->preference('WebBasedSelfCheck')
and C4::Context->preference('AutoSelfCheckAllowed')
) {
my $userid = C4::Context->preference('AutoSelfCheckID');
my $all_permissions = C4::Auth::get_user_subpermissions( $userid );
my ( $has_self_checkout_perm, $has_other_permissions );
while ( my ( $module, $permissions ) = each %$all_permissions ) {
if ( $module eq 'self_check' ) {
while ( my ( $permission, $flag ) = each %$permissions ) {
if ( $permission eq 'self_checkout_module' ) {
$has_self_checkout_perm = 1;
} else {
$has_other_permissions = 1;
}
}
} else {
$has_other_permissions = 1;
}
}
$template->param(
AutoSelfCheckPatronDoesNotHaveSelfCheckPerm => not ( $has_self_checkout_perm ),
AutoSelfCheckPatronHasTooManyPerm => $has_other_permissions,
);
}
{
my $dbh = C4::Context->dbh;
my $patrons = $dbh->selectall_arrayref(
q|select b.borrowernumber from borrowers b join deletedborrowers db on b.borrowernumber=db.borrowernumber|,
{ Slice => {} }
);
my $biblios = $dbh->selectall_arrayref(
q|select b.biblionumber from biblio b join deletedbiblio db on b.biblionumber=db.biblionumber|,
{ Slice => {} }
);
my $items = $dbh->selectall_arrayref(
q|select i.itemnumber from items i join deleteditems di on i.itemnumber=di.itemnumber|,
{ Slice => {} }
);
my $checkouts = $dbh->selectall_arrayref(
q|select i.issue_id from issues i join old_issues oi on i.issue_id=oi.issue_id|,
{ Slice => {} }
);
my $holds = $dbh->selectall_arrayref(
q|select r.reserve_id from reserves r join old_reserves o on r.reserve_id=o.reserve_id|,
{ Slice => {} }
);
if ( @$patrons or @$biblios or @$items or @$checkouts or @$holds ) {
$template->param(
has_ai_issues => 1,
ai_patrons => $patrons,
ai_biblios => $biblios,
ai_items => $items,
ai_checkouts => $checkouts,
ai_holds => $holds,
);
}
}
my %versions = C4::Context::get_versions();
$template->param(
kohaVersion => $versions{'kohaVersion'},
osVersion => $versions{'osVersion'},
perlPath => $perl_path,
perlVersion => $versions{'perlVersion'},
perlIncPath => [ map { perlinc => $_ }, @INC ],
mysqlVersion => $versions{'mysqlVersion'},
apacheVersion => $versions{'apacheVersion'},
zebraVersion => $zebraVersion,
prefBiblioAddsAuthorities => $prefBiblioAddsAuthorities,
prefAutoCreateAuthorities => $prefAutoCreateAuthorities,
warnPrefBiblioAddsAuthorities => $warnPrefBiblioAddsAuthorities,
warnPrefEasyAnalyticalRecords => $warnPrefEasyAnalyticalRecords,
warnPrefAnonymousPatron => $warnPrefAnonymousPatron,
warnPrefAnonymousPatron_PatronDoesNotExist => $warnPrefAnonymousPatron_PatronDoesNotExist,
errZebraConnection => $errZebraConnection,
warnIsRootUser => $warnIsRootUser,
warnNoActiveCurrency => $warnNoActiveCurrency,
warnNoTemplateCaching => ( C4::Context->config('template_cache_dir') ? 0 : 1 ),
xml_config_warnings => \@xml_config_warnings,
warnStatisticsFieldsError => $warnStatisticsFieldsError,
);
my @components = ();
my $perl_modules = C4::Installer::PerlModules->new;
$perl_modules->versions_info;
my @pm_types = qw(missing_pm upgrade_pm current_pm);
foreach my $pm_type(@pm_types) {
my $modules = $perl_modules->get_attr($pm_type);
foreach (@$modules) {
my ($module, $stats) = each %$_;
push(
@components,
{
name => $module,
version => $stats->{'cur_ver'},
missing => ($pm_type eq 'missing_pm' ? 1 : 0),
upgrade => ($pm_type eq 'upgrade_pm' ? 1 : 0),
current => ($pm_type eq 'current_pm' ? 1 : 0),
require => $stats->{'required'},
reqversion => $stats->{'min_ver'},
}
);
}
}
@components = sort {$a->{'name'} cmp $b->{'name'}} @components;
my $counter=0;
my $row = [];
my $table = [];
foreach (@components) {
push (@$row, $_);
unless (++$counter % 4) {
push (@$table, {row => $row});
$row = [];
}
}
# Processing the last line (if there are any modules left)
if (scalar(@$row) > 0) {
# Extending $row to the table size
$$row[3] = '';
# Pushing the last line
push (@$table, {row => $row});
}
## ## $table
$template->param( table => $table );
## ------------------------------------------
## Koha time line code
#get file location
my $docdir;
if ( defined C4::Context->config('docdir') ) {
$docdir = C4::Context->config('docdir');
} else {
# if no <docdir> is defined in koha-conf.xml, use the default location
# this is a work-around to stop breakage on upgraded Kohas, bug 8911
$docdir = C4::Context->config('intranetdir') . '/docs';
}
if ( open( my $file, "<:encoding(UTF-8)", "$docdir" . "/history.txt" ) ) {
my $i = 0;
my @rows2 = ();
my $row2 = [];
my @lines = <$file>;
close($file);
shift @lines; #remove header row
foreach (@lines) {
my ( $epoch, $date, $desc, $tag ) = split(/\t/);
if(!$desc && $date=~ /(?<=\d{4})\s+/) {
($date, $desc)= ($`, $');
}
push(
@rows2,
{
date => $date,
desc => $desc,
}
);
}
my $table2 = [];
#foreach my $row2 (@rows2) {
foreach (@rows2) {
push (@$row2, $_);
push( @$table2, { row2 => $row2 } );
$row2 = [];
}
$template->param( table2 => $table2 );
} else {
$template->param( timeline_read_error => 1 );
}
output_html_with_http_headers $query, $cookie, $template->output;