3 # Copyright Pat Eyler 2003
4 # Copyright Biblibre 2006
5 # Parts Copyright Liblime 2008
6 # Parts Copyright Chris Nighswonger 2010
8 # This file is part of Koha.
10 # Koha is free software; you can redistribute it and/or modify it
11 # under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 3 of the License, or
13 # (at your option) any later version.
15 # Koha is distributed in the hope that it will be useful, but
16 # WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with Koha; if not, see <http://www.gnu.org/licenses>.
26 use DateTime
::TimeZone
;
28 use List
::MoreUtils qw
/ any /;
30 use Module
::Load
::Conditional
qw(can_load);
33 use Search
::Elasticsearch
;
35 use YAML qw
/LoadFile/;
40 use C4
::Installer
::PerlModules
;
43 use Koha
::DateUtils
qw(dt_from_string output_pref);
44 use Koha
::Acquisition
::Currencies
;
45 use Koha
::Patron
::Categories
;
48 use Koha
::Config
::SysPrefs
;
49 use Koha
::Illrequest
::Config
;
50 use Koha
::SearchEngine
::Elasticsearch
;
52 use C4
::Members
::Statistics
;
55 #use Smart::Comments '####';
58 my ( $template, $loggedinuser, $cookie ) = get_template_and_user
(
60 template_name
=> "about.tt",
64 flagsrequired
=> { catalogue
=> 1 },
69 my $config_timezone = C4
::Context
->config('timezone') // '';
70 my $config_invalid = !DateTime
::TimeZone
->is_valid_name( $config_timezone );
71 my $env_timezone = $ENV{TZ
} // '';
72 my $env_invalid = !DateTime
::TimeZone
->is_valid_name( $env_timezone );
73 my $actual_bad_tz_fallback = 0;
75 if ( $config_timezone ne '' &&
78 $actual_bad_tz_fallback = 1;
80 elsif ( $config_timezone eq '' &&
81 $env_timezone ne '' &&
83 # No config, but bad ENV{TZ}
84 $actual_bad_tz_fallback = 1;
88 actual
=> C4
::Context
->tz->name,
89 actual_bad_tz_fallback
=> $actual_bad_tz_fallback,
90 config
=> $config_timezone,
91 config_invalid
=> $config_invalid,
92 environment
=> $env_timezone,
93 environment_invalid
=> $env_invalid
97 time_zone
=> $time_zone,
98 current_date_and_time
=> output_pref
({ dt
=> dt_from_string
(), dateformat
=> 'iso' })
103 $perl_path .= $Config{_exe
} unless $perl_path =~ m/$Config{_exe}$/i;
106 my $zebraVersion = `zebraidx -V`;
108 # Check running PSGI env
109 if ( any
{ /(^psgi\.|^plack\.)/i } keys %ENV ) {
112 psgi_server
=> ($ENV{ PLACK_ENV
}) ?
"Plack ($ENV{PLACK_ENV})" :
113 ($ENV{ MOD_PERL
}) ?
"mod_perl ($ENV{MOD_PERL})" :
118 # Memcached configuration
119 my $memcached_servers = $ENV{MEMCACHED_SERVERS
} || C4
::Context
->config('memcached_servers');
120 my $memcached_namespace = $ENV{MEMCACHED_NAMESPACE
} || C4
::Context
->config('memcached_namespace') // 'koha';
122 my $cache = Koha
::Caches
->get_instance;
123 my $effective_caching_method = ref($cache->cache);
124 # Memcached may have been running when plack has been initialized but could have been stopped since
125 # FIXME What are the consequences of that??
126 my $is_memcached_still_active = $cache->set_in_cache('test_for_about_page', "just a simple value");
128 my $where_is_memcached_config = 'nowhere';
129 if ( $ENV{MEMCACHED_SERVERS
} and C4
::Context
->config('memcached_servers') ) {
130 $where_is_memcached_config = 'both';
131 } elsif ( $ENV{MEMCACHED_SERVERS
} and not C4
::Context
->config('memcached_servers') ) {
132 $where_is_memcached_config = 'ENV_only';
133 } elsif ( C4
::Context
->config('memcached_servers') ) {
134 $where_is_memcached_config = 'config_only';
138 effective_caching_method
=> $effective_caching_method,
139 memcached_servers
=> $memcached_servers,
140 memcached_namespace
=> $memcached_namespace,
141 is_memcached_still_active
=> $is_memcached_still_active,
142 where_is_memcached_config
=> $where_is_memcached_config,
143 memcached_running
=> Koha
::Caches
->get_instance->memcached_cache,
146 # Additional system information for warnings
148 my $warnStatisticsFieldsError;
149 my $prefStatisticsFields = C4
::Context
->preference('StatisticsFields');
150 if ($prefStatisticsFields) {
151 $warnStatisticsFieldsError = $prefStatisticsFields
152 unless ( $prefStatisticsFields eq C4
::Members
::Statistics
->get_fields() );
155 my $prefAutoCreateAuthorities = C4
::Context
->preference('AutoCreateAuthorities');
156 my $prefBiblioAddsAuthorities = C4
::Context
->preference('BiblioAddsAuthorities');
157 my $warnPrefBiblioAddsAuthorities = ( $prefAutoCreateAuthorities && ( !$prefBiblioAddsAuthorities) );
159 my $prefEasyAnalyticalRecords = C4
::Context
->preference('EasyAnalyticalRecords');
160 my $prefUseControlNumber = C4
::Context
->preference('UseControlNumber');
161 my $warnPrefEasyAnalyticalRecords = ( $prefEasyAnalyticalRecords && $prefUseControlNumber );
163 my $AnonymousPatron = C4
::Context
->preference('AnonymousPatron');
164 my $warnPrefAnonymousPatronOPACPrivacy = (
165 C4
::Context
->preference('OPACPrivacy')
166 and not $AnonymousPatron
168 my $warnPrefAnonymousPatronAnonSuggestions = (
169 C4
::Context
->preference('AnonSuggestions')
170 and not $AnonymousPatron
173 my $anonymous_patron = Koha
::Patrons
->find( $AnonymousPatron );
174 my $warnPrefAnonymousPatronAnonSuggestions_PatronDoesNotExist = ( $AnonymousPatron && C4
::Context
->preference('AnonSuggestions') && not $anonymous_patron );
176 my $warnPrefAnonymousPatronOPACPrivacy_PatronDoesNotExist = ( not $anonymous_patron and Koha
::Patrons
->search({ privacy
=> 2 })->count );
178 my $errZebraConnection = C4
::Context
->Zconn("biblioserver",0)->errcode();
180 my $warnIsRootUser = (! $loggedinuser);
182 my $warnNoActiveCurrency = (! defined Koha
::Acquisition
::Currencies
->get_active);
184 my @xml_config_warnings;
186 my $context = new C4
::Context
;
188 if ( C4
::Context
->config('zebra_bib_index_mode')
189 and C4
::Context
->config('zebra_bib_index_mode') eq 'grs1' )
191 push @xml_config_warnings, { error
=> 'zebra_bib_index_mode_is_grs1' };
194 if ( C4
::Context
->config('zebra_auth_index_mode')
195 and C4
::Context
->config('zebra_auth_index_mode') eq 'grs1' )
197 push @xml_config_warnings, { error
=> 'zebra_auth_index_mode_is_grs1' };
200 if ( (C4
::Context
->config('zebra_auth_index_mode') eq 'dom') && ($context->{'server'}->{'authorityserver'}->{'config'} !~ /zebra-authorities-dom.cfg/) ) {
201 push @xml_config_warnings, {
202 error
=> 'zebra_auth_index_mode_mismatch_warn'
206 if ( ! defined C4
::Context
->config('log4perl_conf') ) {
207 push @xml_config_warnings, {
208 error
=> 'log4perl_entry_missing'
212 if ( ! defined C4
::Context
->config('upload_path') ) {
213 if ( Koha
::Config
::SysPrefs
->find('OPACBaseURL')->value ) {
214 # OPACBaseURL seems to be set
215 push @xml_config_warnings, {
216 error
=> 'uploadpath_entry_missing'
219 push @xml_config_warnings, {
220 error
=> 'uploadpath_and_opacbaseurl_entry_missing'
225 if ( ! C4
::Context
->config('tmp_path') ) {
226 my $temporary_directory = C4
::Context
::temporary_directory
;
227 push @xml_config_warnings, {
228 error
=> 'tmp_path_missing',
229 effective_tmp_dir
=> $temporary_directory,
233 # Test QueryParser configuration sanity
234 if ( C4
::Context
->preference( 'UseQueryParser' ) ) {
235 # Get the QueryParser configuration file name
236 my $queryparser_file = C4
::Context
->config( 'queryparser_config' );
237 my $queryparser_fallback_file = '/etc/koha/searchengine/queryparser.yaml';
238 # Check QueryParser is functional
239 my $QParser = C4
::Context
->queryparser();
240 my $queryparser_error = {};
241 if ( ! defined $QParser || ref($QParser) ne 'Koha::QueryParser::Driver::PQF' ) {
242 # Error initializing the QueryParser object
243 # Get the used queryparser.yaml file path to report the user
244 $queryparser_error->{ fallback
} = ( defined $queryparser_file ) ?
0 : 1;
245 $queryparser_error->{ file
} = ( defined $queryparser_file )
247 : $queryparser_fallback_file;
248 # Report error data to the template
249 $template->param( QueryParserError
=> $queryparser_error );
251 # Check for an absent queryparser_config entry in koha-conf.xml
252 if ( ! defined $queryparser_file ) {
253 # Not an error but a warning for the missing entry in koha-conf-xml
254 push @xml_config_warnings, {
255 error
=> 'queryparser_entry_missing',
256 file
=> $queryparser_fallback_file
262 # Test Zebra facets configuration
263 if ( !defined C4
::Context
->config('use_zebra_facets') ) {
264 push @xml_config_warnings, { error
=> 'use_zebra_facets_entry_missing' };
268 if ( C4
::Context
->preference('ILLModule') ) {
269 my $warnILLConfiguration = 0;
270 my $ill_config_from_file = C4
::Context
->config("interlibrary_loans");
271 my $ill_config = Koha
::Illrequest
::Config
->new;
273 my $available_ill_backends =
274 ( scalar @
{ $ill_config->available_backends } > 0 );
277 if ( !$available_ill_backends ) {
278 $template->param( no_ill_backends
=> 1 );
279 $warnILLConfiguration = 1;
283 if ( !Koha
::Patron
::Categories
->find($ill_config->partner_code) ) {
284 $template->param( ill_partner_code_doesnt_exist
=> $ill_config->partner_code );
285 $warnILLConfiguration = 1;
288 if ( !$ill_config_from_file->{partner_code
} ) {
289 # partner code not defined
290 $template->param( ill_partner_code_not_defined
=> 1 );
291 $warnILLConfiguration = 1;
295 if ( !$ill_config_from_file->{branch
} ) {
297 $template->param( ill_branch_not_defined
=> 1 );
298 $warnILLConfiguration = 1;
301 $template->param( warnILLConfiguration
=> $warnILLConfiguration );
304 if ( C4
::Context
->preference('SearchEngine') eq 'Elasticsearch' ) {
305 # Check ES configuration health and runtime status
313 $es_conf = Koha
::SearchEngine
::Elasticsearch
::_read_configuration
();
316 if ( ref($_) eq 'Koha::Exceptions::Config::MissingEntry' ) {
317 $template->param( elasticsearch_fatal_config_error
=> $_->message );
318 $es_config_error = 1;
321 if ( !$es_config_error ) {
323 my $biblios_index_name = $es_conf->{index_name
} . "_" . $Koha::SearchEngine
::BIBLIOS_INDEX
;
324 my $authorities_index_name = $es_conf->{index_name
} . "_" . $Koha::SearchEngine
::AUTHORITIES_INDEX
;
326 my @indexes = ($biblios_index_name, $authorities_index_name);
327 # TODO: When new indexes get added, we could have other ways to
328 # fetch the list of available indexes (e.g. plugins, etc)
329 $es_status->{nodes
} = $es_conf->{nodes
};
330 my $es = Search
::Elasticsearch
->new({ nodes
=> $es_conf->{nodes
} });
332 foreach my $index ( @indexes ) {
335 $count = $es->indices->stats( index => $index )
336 ->{_all
}{primaries
}{docs
}{count
};
339 if ( ref($_) eq 'Search::Elasticsearch::Error::Missing' ) {
340 push @
{ $es_status->{errors
} }, "Index not found ($index)";
343 elsif ( ref($_) eq 'Search::Elasticsearch::Error::NoNodes' ) {
347 # TODO: when time comes, we will cover more use cases
352 push @
{ $es_status->{indexes
} },
354 index_name
=> $index,
358 $es_status->{running
} = $es_running;
360 $template->param( elasticsearch_status
=> $es_status );
364 if ( C4
::Context
->preference('RESTOAuth2ClientCredentials') ) {
365 # Do we have the required deps?
366 unless ( can_load
( modules
=> { 'Net::OAuth2::AuthorizationServer' => undef }) ) {
367 $template->param( oauth2_missing_deps
=> 1 );
371 # Sco Patron should not contain any other perms than circulate => self_checkout
372 if ( C4
::Context
->preference('WebBasedSelfCheck')
373 and C4
::Context
->preference('AutoSelfCheckAllowed')
375 my $userid = C4
::Context
->preference('AutoSelfCheckID');
376 my $all_permissions = C4
::Auth
::get_user_subpermissions
( $userid );
377 my ( $has_self_checkout_perm, $has_other_permissions );
378 while ( my ( $module, $permissions ) = each %$all_permissions ) {
379 if ( $module eq 'self_check' ) {
380 while ( my ( $permission, $flag ) = each %$permissions ) {
381 if ( $permission eq 'self_checkout_module' ) {
382 $has_self_checkout_perm = 1;
384 $has_other_permissions = 1;
388 $has_other_permissions = 1;
392 AutoSelfCheckPatronDoesNotHaveSelfCheckPerm
=> not ( $has_self_checkout_perm ),
393 AutoSelfCheckPatronHasTooManyPerm
=> $has_other_permissions,
397 # Test YAML system preferences
398 # FIXME: This is list of current YAML formatted prefs, should by type of preference
400 "UpdateNotForLoanStatusOnCheckin",
402 "BibtexExportAdditionalFields",
403 "RisExportAdditionalFields",
404 "UpdateItemWhenLostFromHoldList",
406 "MarcItemFieldsToOrder",
407 "UpdateitemLocationOnCheckin",
411 foreach my $syspref (@yaml_prefs) {
412 my $yaml = C4
::Context
->preference( $syspref );
414 eval { YAML
::Load
( "$yaml\n\n" ); };
416 push @bad_yaml_prefs, $syspref;
420 $template->param( 'bad_yaml_prefs' => \
@bad_yaml_prefs ) if @bad_yaml_prefs;
423 my $dbh = C4
::Context
->dbh;
424 my $patrons = $dbh->selectall_arrayref(
425 q
|select b
.borrowernumber from borrowers b
join deletedborrowers db on b
.borrowernumber
=db
.borrowernumber
|,
428 my $biblios = $dbh->selectall_arrayref(
429 q
|select b
.biblionumber from biblio b
join deletedbiblio db on b
.biblionumber
=db
.biblionumber
|,
432 my $items = $dbh->selectall_arrayref(
433 q
|select i
.itemnumber from items i
join deleteditems di on i
.itemnumber
=di
.itemnumber
|,
436 my $checkouts = $dbh->selectall_arrayref(
437 q
|select i
.issue_id from issues i
join old_issues oi on i
.issue_id
=oi
.issue_id
|,
440 my $holds = $dbh->selectall_arrayref(
441 q
|select r
.reserve_id from reserves r
join old_reserves o on r
.reserve_id
=o
.reserve_id
|,
444 if ( @
$patrons or @
$biblios or @
$items or @
$checkouts or @
$holds ) {
447 ai_patrons
=> $patrons,
448 ai_biblios
=> $biblios,
450 ai_checkouts
=> $checkouts,
458 my $dbh = C4
::Context
->dbh;
459 my $units = Koha
::CirculationRules
->search({ rule_name
=> 'lengthunit', rule_value
=> { -not_in
=> ['days', 'hours'] } });
461 if ( $units->count ) {
463 warnIssuingRules
=> 1,
469 # Guarantor relationships warnings
471 my $dbh = C4
::Context
->dbh;
472 my ($bad_relationships_count) = $dbh->selectall_arrayref(q{
475 SELECT relationship FROM borrower_relationships WHERE relationship='_bad_data'
477 SELECT relationship FROM borrowers WHERE relationship='_bad_data') a
480 $bad_relationships_count = $bad_relationships_count->[0]->[0];
482 my $existing_relationships = $dbh->selectall_arrayref(q{
483 SELECT DISTINCT(relationship)
485 SELECT relationship FROM borrower_relationships WHERE relationship IS NOT NULL
487 SELECT relationship FROM borrowers WHERE relationship IS NOT NULL) a
490 my %valid_relationships = map { $_ => 1 } split( /,|\|/, C4
::Context
->preference('borrowerRelationship') );
491 $valid_relationships{ _bad_data
} = 1; # we handle this case in another way
493 my $wrong_relationships = [ grep { !$valid_relationships{ $_->[0] } } @
{$existing_relationships} ];
494 if ( @
$wrong_relationships or $bad_relationships_count ) {
497 warnRelationships
=> 1,
500 if ( $wrong_relationships ) {
502 wrong_relationships
=> $wrong_relationships
505 if ($bad_relationships_count) {
507 bad_relationships_count
=> $bad_relationships_count,
513 my %versions = C4
::Context
::get_versions
();
516 kohaVersion
=> $versions{'kohaVersion'},
517 osVersion
=> $versions{'osVersion'},
518 perlPath
=> $perl_path,
519 perlVersion
=> $versions{'perlVersion'},
520 perlIncPath
=> [ map { perlinc
=> $_ }, @INC ],
521 mysqlVersion
=> $versions{'mysqlVersion'},
522 apacheVersion
=> $versions{'apacheVersion'},
523 zebraVersion
=> $zebraVersion,
524 prefBiblioAddsAuthorities
=> $prefBiblioAddsAuthorities,
525 prefAutoCreateAuthorities
=> $prefAutoCreateAuthorities,
526 warnPrefBiblioAddsAuthorities
=> $warnPrefBiblioAddsAuthorities,
527 warnPrefEasyAnalyticalRecords
=> $warnPrefEasyAnalyticalRecords,
528 warnPrefAnonymousPatronOPACPrivacy
=> $warnPrefAnonymousPatronOPACPrivacy,
529 warnPrefAnonymousPatronAnonSuggestions
=> $warnPrefAnonymousPatronAnonSuggestions,
530 warnPrefAnonymousPatronOPACPrivacy_PatronDoesNotExist
=> $warnPrefAnonymousPatronOPACPrivacy_PatronDoesNotExist,
531 warnPrefAnonymousPatronAnonSuggestions_PatronDoesNotExist
=> $warnPrefAnonymousPatronAnonSuggestions_PatronDoesNotExist,
532 errZebraConnection
=> $errZebraConnection,
533 warnIsRootUser
=> $warnIsRootUser,
534 warnNoActiveCurrency
=> $warnNoActiveCurrency,
535 warnNoTemplateCaching
=> ( C4
::Context
->config('template_cache_dir') ?
0 : 1 ),
536 xml_config_warnings
=> \
@xml_config_warnings,
537 warnStatisticsFieldsError
=> $warnStatisticsFieldsError,
542 my $perl_modules = C4
::Installer
::PerlModules
->new;
543 $perl_modules->versions_info;
545 my @pm_types = qw(missing_pm upgrade_pm current_pm);
547 foreach my $pm_type(@pm_types) {
548 my $modules = $perl_modules->get_attr($pm_type);
549 foreach (@
$modules) {
550 my ($module, $stats) = each %$_;
555 version
=> $stats->{'cur_ver'},
556 missing
=> ($pm_type eq 'missing_pm' ?
1 : 0),
557 upgrade
=> ($pm_type eq 'upgrade_pm' ?
1 : 0),
558 current
=> ($pm_type eq 'current_pm' ?
1 : 0),
559 require => $stats->{'required'},
560 reqversion
=> $stats->{'min_ver'},
561 maxversion
=> $stats->{'max_ver'}
567 @components = sort {$a->{'name'} cmp $b->{'name'}} @components;
572 foreach (@components) {
574 unless (++$counter % 4) {
575 push (@
$table, {row
=> $row});
579 # Processing the last line (if there are any modules left)
580 if (scalar(@
$row) > 0) {
581 # Extending $row to the table size
583 # Pushing the last line
584 push (@
$table, {row
=> $row});
588 $template->param( table
=> $table );
591 ## ------------------------------------------
592 ## Koha contributions
594 if ( defined C4
::Context
->config('docdir') ) {
595 $docdir = C4
::Context
->config('docdir');
597 # if no <docdir> is defined in koha-conf.xml, use the default location
598 # this is a work-around to stop breakage on upgraded Kohas, bug 8911
599 $docdir = C4
::Context
->config('intranetdir') . '/docs';
604 -e
"$docdir" . "/teams.yaml"
605 ? LoadFile
( "$docdir" . "/teams.yaml" )
607 my $dev_team = (sort {$b <=> $a} (keys %{$teams->{team
}}))[0];
608 my $short_version = substr($versions{'kohaVersion'},0,5);
609 my $minor = substr($versions{'kohaVersion'},3,2);
610 my $development_version = ( $minor eq '05' || $minor eq '11' ) ?
0 : 1;
611 $template->param( short_version
=> $short_version );
612 $template->param( development_version
=> $development_version );
616 -e
"$docdir" . "/contributors.yaml"
617 ? LoadFile
( "$docdir" . "/contributors.yaml" )
619 for my $version ( sort { $a <=> $b } keys %{$teams->{team
}} ) {
620 for my $role ( keys %{ $teams->{team
}->{$version} } ) {
621 my $normalized_role = "$role";
622 $normalized_role =~ s/s$//;
623 if ( ref( $teams->{team
}->{$version}->{$role} ) eq 'ARRAY' ) {
624 for my $contributor ( @
{ $teams->{team
}->{$version}->{$role} } ) {
625 my $name = $contributor->{name
};
626 # Add role to contributors
627 push @
{ $contributors->{$name}->{roles
}->{$normalized_role} },
629 # Add openhub to teams
630 if ( exists( $contributors->{$name}->{openhub
} ) ) {
631 $contributor->{openhub
} = $contributors->{$name}->{openhub
};
635 elsif ( $role ne 'release_date' ) {
636 my $name = $teams->{team
}->{$version}->{$role}->{name
};
637 # Add role to contributors
638 push @
{ $contributors->{$name}->{roles
}->{$normalized_role} },
640 # Add openhub to teams
641 if ( exists( $contributors->{$name}->{openhub
} ) ) {
642 $teams->{team
}->{$version}->{$role}->{openhub
} =
643 $contributors->{$name}->{openhub
};
647 $teams->{team
}->{$version}->{$role} = DateTime
->from_epoch( epoch
=> $teams->{team
}->{$version}->{$role});
652 ## Create last name ordered array of people from contributors
654 { name
=> $_, ( $contributors->{$_} ?
%{ $contributors->{$_} } : () ) }
656 my ($alast) = ( split( /\s/, $a ) )[-1];
657 my ($blast) = ( split( /\s/, $b ) )[-1];
658 lc($alast) cmp lc($blast)
659 } keys %{$contributors};
661 $template->param( contributors
=> \
@people );
662 $template->param( maintenance_team
=> $teams->{team
}->{$dev_team} );
663 $template->param( release_team
=> $teams->{team
}->{$short_version} );
666 if ( open( my $file, "<:encoding(UTF-8)", "$docdir" . "/history.txt" ) ) {
676 shift @lines; #remove header row
679 my ( $epoch, $date, $desc, $tag ) = split(/\t/);
680 if(!$desc && $date=~ /(?<=\d{4})\s+/) {
681 ($date, $desc)= ($`, $');
693 #foreach my $row2 (@rows2) {
696 push( @$table2, { row2 => $row2 } );
700 $template->param( table2 => $table2 );
702 $template->param( timeline_read_error => 1 );
705 output_html_with_http_headers $query, $cookie, $template->output;