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/;
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",
63 flagsrequired => { catalogue => 1 },
68 my $config_timezone = C4::Context->config('timezone') // '';
69 my $config_invalid = !DateTime::TimeZone->is_valid_name( $config_timezone );
70 my $env_timezone = $ENV{TZ} // '';
71 my $env_invalid = !DateTime::TimeZone->is_valid_name( $env_timezone );
72 my $actual_bad_tz_fallback = 0;
74 if ( $config_timezone ne '' &&
77 $actual_bad_tz_fallback = 1;
79 elsif ( $config_timezone eq '' &&
80 $env_timezone ne '' &&
82 # No config, but bad ENV{TZ}
83 $actual_bad_tz_fallback = 1;
87 actual => C4::Context->tz->name,
88 actual_bad_tz_fallback => $actual_bad_tz_fallback,
89 config => $config_timezone,
90 config_invalid => $config_invalid,
91 environment => $env_timezone,
92 environment_invalid => $env_invalid
96 time_zone => $time_zone,
97 current_date_and_time => output_pref({ dt => dt_from_string(), dateformat => 'iso' })
102 $perl_path .= $Config{_exe} unless $perl_path =~ m/$Config{_exe}$/i;
105 my $zebraVersion = `zebraidx -V`;
107 # Check running PSGI env
108 if ( any { /(^psgi\.|^plack\.)/i } keys %ENV ) {
111 psgi_server => ($ENV{ PLACK_ENV }) ? "Plack ($ENV{PLACK_ENV})" :
112 ($ENV{ MOD_PERL }) ? "mod_perl ($ENV{MOD_PERL})" :
117 # Memcached configuration
118 my $memcached_servers = $ENV{MEMCACHED_SERVERS} || C4::Context->config('memcached_servers');
119 my $memcached_namespace = $ENV{MEMCACHED_NAMESPACE} || C4::Context->config('memcached_namespace') // 'koha';
121 my $cache = Koha::Caches->get_instance;
122 my $effective_caching_method = ref($cache->cache);
123 # Memcached may have been running when plack has been initialized but could have been stopped since
124 # FIXME What are the consequences of that??
125 my $is_memcached_still_active = $cache->set_in_cache('test_for_about_page', "just a simple value");
127 my $where_is_memcached_config = 'nowhere';
128 if ( $ENV{MEMCACHED_SERVERS} and C4::Context->config('memcached_servers') ) {
129 $where_is_memcached_config = 'both';
130 } elsif ( $ENV{MEMCACHED_SERVERS} and not C4::Context->config('memcached_servers') ) {
131 $where_is_memcached_config = 'ENV_only';
132 } elsif ( C4::Context->config('memcached_servers') ) {
133 $where_is_memcached_config = 'config_only';
137 effective_caching_method => $effective_caching_method,
138 memcached_servers => $memcached_servers,
139 memcached_namespace => $memcached_namespace,
140 is_memcached_still_active => $is_memcached_still_active,
141 where_is_memcached_config => $where_is_memcached_config,
142 memcached_running => Koha::Caches->get_instance->memcached_cache,
145 # Additional system information for warnings
147 my $warnStatisticsFieldsError;
148 my $prefStatisticsFields = C4::Context->preference('StatisticsFields');
149 if ($prefStatisticsFields) {
150 $warnStatisticsFieldsError = $prefStatisticsFields
151 unless ( $prefStatisticsFields eq C4::Members::Statistics->get_fields() );
154 my $prefAutoCreateAuthorities = C4::Context->preference('AutoCreateAuthorities');
155 my $prefBiblioAddsAuthorities = C4::Context->preference('BiblioAddsAuthorities');
156 my $warnPrefBiblioAddsAuthorities = ( $prefAutoCreateAuthorities && ( !$prefBiblioAddsAuthorities) );
158 my $prefEasyAnalyticalRecords = C4::Context->preference('EasyAnalyticalRecords');
159 my $prefUseControlNumber = C4::Context->preference('UseControlNumber');
160 my $warnPrefEasyAnalyticalRecords = ( $prefEasyAnalyticalRecords && $prefUseControlNumber );
162 my $AnonymousPatron = C4::Context->preference('AnonymousPatron');
163 my $warnPrefAnonymousPatronOPACPrivacy = (
164 C4::Context->preference('OPACPrivacy')
165 and not $AnonymousPatron
167 my $warnPrefAnonymousPatronAnonSuggestions = (
168 C4::Context->preference('AnonSuggestions')
169 and not $AnonymousPatron
172 my $anonymous_patron = Koha::Patrons->find( $AnonymousPatron );
173 my $warnPrefAnonymousPatronAnonSuggestions_PatronDoesNotExist = ( $AnonymousPatron && C4::Context->preference('AnonSuggestions') && not $anonymous_patron );
175 my $warnPrefAnonymousPatronOPACPrivacy_PatronDoesNotExist = ( not $anonymous_patron and Koha::Patrons->search({ privacy => 2 })->count );
177 my $errZebraConnection = C4::Context->Zconn("biblioserver",0)->errcode();
179 my $warnIsRootUser = (! $loggedinuser);
181 my $warnNoActiveCurrency = (! defined Koha::Acquisition::Currencies->get_active);
183 my @xml_config_warnings;
185 my $context = new C4::Context;
187 if ( C4::Context->config('zebra_bib_index_mode')
188 and C4::Context->config('zebra_bib_index_mode') eq 'grs1' )
190 push @xml_config_warnings, { error => 'zebra_bib_index_mode_is_grs1' };
193 if ( C4::Context->config('zebra_auth_index_mode')
194 and C4::Context->config('zebra_auth_index_mode') eq 'grs1' )
196 push @xml_config_warnings, { error => 'zebra_auth_index_mode_is_grs1' };
199 if( ( C4::Context->config('zebra_auth_index_mode')
200 and C4::Context->config('zebra_auth_index_mode') eq 'dom' )
201 && ( $context->{'server'}->{'authorityserver'}->{'config'} !~ /zebra-authorities-dom.cfg/ ) )
203 push @xml_config_warnings, {
204 error => 'zebra_auth_index_mode_mismatch_warn'
208 if ( ! defined C4::Context->config('log4perl_conf') ) {
209 push @xml_config_warnings, {
210 error => 'log4perl_entry_missing'
214 if ( ! defined C4::Context->config('upload_path') ) {
215 if ( Koha::Config::SysPrefs->find('OPACBaseURL')->value ) {
216 # OPACBaseURL seems to be set
217 push @xml_config_warnings, {
218 error => 'uploadpath_entry_missing'
221 push @xml_config_warnings, {
222 error => 'uploadpath_and_opacbaseurl_entry_missing'
227 if ( ! C4::Context->config('tmp_path') ) {
228 my $temporary_directory = C4::Context::temporary_directory;
229 push @xml_config_warnings, {
230 error => 'tmp_path_missing',
231 effective_tmp_dir => $temporary_directory,
235 # Test QueryParser configuration sanity
236 if ( C4::Context->preference( 'UseQueryParser' ) ) {
237 # Get the QueryParser configuration file name
238 my $queryparser_file = C4::Context->config( 'queryparser_config' );
239 my $queryparser_fallback_file = '/etc/koha/searchengine/queryparser.yaml';
240 # Check QueryParser is functional
241 my $QParser = C4::Context->queryparser();
242 my $queryparser_error = {};
243 if ( ! defined $QParser || ref($QParser) ne 'Koha::QueryParser::Driver::PQF' ) {
244 # Error initializing the QueryParser object
245 # Get the used queryparser.yaml file path to report the user
246 $queryparser_error->{ fallback } = ( defined $queryparser_file ) ? 0 : 1;
247 $queryparser_error->{ file } = ( defined $queryparser_file )
249 : $queryparser_fallback_file;
250 # Report error data to the template
251 $template->param( QueryParserError => $queryparser_error );
253 # Check for an absent queryparser_config entry in koha-conf.xml
254 if ( ! defined $queryparser_file ) {
255 # Not an error but a warning for the missing entry in koha-conf-xml
256 push @xml_config_warnings, {
257 error => 'queryparser_entry_missing',
258 file => $queryparser_fallback_file
264 # Test Zebra facets configuration
265 if ( !defined C4::Context->config('use_zebra_facets') ) {
266 push @xml_config_warnings, { error => 'use_zebra_facets_entry_missing' };
270 if ( C4::Context->preference('ILLModule') ) {
271 my $warnILLConfiguration = 0;
272 my $ill_config_from_file = C4::Context->config("interlibrary_loans");
273 my $ill_config = Koha::Illrequest::Config->new;
275 my $available_ill_backends =
276 ( scalar @{ $ill_config->available_backends } > 0 );
279 if ( !$available_ill_backends ) {
280 $template->param( no_ill_backends => 1 );
281 $warnILLConfiguration = 1;
285 if ( !Koha::Patron::Categories->find($ill_config->partner_code) ) {
286 $template->param( ill_partner_code_doesnt_exist => $ill_config->partner_code );
287 $warnILLConfiguration = 1;
290 if ( !$ill_config_from_file->{partner_code} ) {
291 # partner code not defined
292 $template->param( ill_partner_code_not_defined => 1 );
293 $warnILLConfiguration = 1;
297 if ( !$ill_config_from_file->{branch} ) {
299 $template->param( ill_branch_not_defined => 1 );
300 $warnILLConfiguration = 1;
303 $template->param( warnILLConfiguration => $warnILLConfiguration );
306 if ( C4::Context->preference('SearchEngine') eq 'Elasticsearch' ) {
307 # Check ES configuration health and runtime status
315 $es_conf = Koha::SearchEngine::Elasticsearch::_read_configuration();
318 if ( ref($_) eq 'Koha::Exceptions::Config::MissingEntry' ) {
319 $template->param( elasticsearch_fatal_config_error => $_->message );
320 $es_config_error = 1;
323 if ( !$es_config_error ) {
325 my $biblios_index_name = $es_conf->{index_name} . "_" . $Koha::SearchEngine::BIBLIOS_INDEX;
326 my $authorities_index_name = $es_conf->{index_name} . "_" . $Koha::SearchEngine::AUTHORITIES_INDEX;
328 my @indexes = ($biblios_index_name, $authorities_index_name);
329 # TODO: When new indexes get added, we could have other ways to
330 # fetch the list of available indexes (e.g. plugins, etc)
331 $es_status->{nodes} = $es_conf->{nodes};
332 my $es = Search::Elasticsearch->new({ nodes => $es_conf->{nodes} });
333 my $es_status->{version} = $es->info->{version}->{number};
335 foreach my $index ( @indexes ) {
338 $count = $es->indices->stats( index => $index )
339 ->{_all}{primaries}{docs}{count};
342 if ( ref($_) eq 'Search::Elasticsearch::Error::Missing' ) {
343 push @{ $es_status->{errors} }, "Index not found ($index)";
346 elsif ( ref($_) eq 'Search::Elasticsearch::Error::NoNodes' ) {
350 # TODO: when time comes, we will cover more use cases
355 push @{ $es_status->{indexes} },
357 index_name => $index,
361 $es_status->{running} = $es_running;
363 $template->param( elasticsearch_status => $es_status );
367 if ( C4::Context->preference('RESTOAuth2ClientCredentials') ) {
368 # Do we have the required deps?
369 unless ( can_load( modules => { 'Net::OAuth2::AuthorizationServer' => undef }) ) {
370 $template->param( oauth2_missing_deps => 1 );
374 # Sco Patron should not contain any other perms than circulate => self_checkout
375 if ( C4::Context->preference('WebBasedSelfCheck')
376 and C4::Context->preference('AutoSelfCheckAllowed')
378 my $userid = C4::Context->preference('AutoSelfCheckID');
379 my $all_permissions = C4::Auth::get_user_subpermissions( $userid );
380 my ( $has_self_checkout_perm, $has_other_permissions );
381 while ( my ( $module, $permissions ) = each %$all_permissions ) {
382 if ( $module eq 'self_check' ) {
383 while ( my ( $permission, $flag ) = each %$permissions ) {
384 if ( $permission eq 'self_checkout_module' ) {
385 $has_self_checkout_perm = 1;
387 $has_other_permissions = 1;
391 $has_other_permissions = 1;
395 AutoSelfCheckPatronDoesNotHaveSelfCheckPerm => not ( $has_self_checkout_perm ),
396 AutoSelfCheckPatronHasTooManyPerm => $has_other_permissions,
400 # Test YAML system preferences
401 # FIXME: This is list of current YAML formatted prefs, should by type of preference
403 "UpdateNotForLoanStatusOnCheckin",
405 "BibtexExportAdditionalFields",
406 "RisExportAdditionalFields",
407 "UpdateItemWhenLostFromHoldList",
409 "MarcItemFieldsToOrder",
410 "UpdateitemLocationOnCheckin",
414 foreach my $syspref (@yaml_prefs) {
415 my $yaml = C4::Context->preference( $syspref );
417 eval { YAML::Load( "$yaml\n\n" ); };
419 push @bad_yaml_prefs, $syspref;
423 $template->param( 'bad_yaml_prefs' => \@bad_yaml_prefs ) if @bad_yaml_prefs;
426 my $dbh = C4::Context->dbh;
427 my $patrons = $dbh->selectall_arrayref(
428 q|select b.borrowernumber from borrowers b join deletedborrowers db on b.borrowernumber=db.borrowernumber|,
431 my $biblios = $dbh->selectall_arrayref(
432 q|select b.biblionumber from biblio b join deletedbiblio db on b.biblionumber=db.biblionumber|,
435 my $items = $dbh->selectall_arrayref(
436 q|select i.itemnumber from items i join deleteditems di on i.itemnumber=di.itemnumber|,
439 my $checkouts = $dbh->selectall_arrayref(
440 q|select i.issue_id from issues i join old_issues oi on i.issue_id=oi.issue_id|,
443 my $holds = $dbh->selectall_arrayref(
444 q|select r.reserve_id from reserves r join old_reserves o on r.reserve_id=o.reserve_id|,
447 if ( @$patrons or @$biblios or @$items or @$checkouts or @$holds ) {
450 ai_patrons => $patrons,
451 ai_biblios => $biblios,
453 ai_checkouts => $checkouts,
461 my $dbh = C4::Context->dbh;
462 my $units = $dbh->selectall_arrayref(
463 q|SELECT branchcode, categorycode, itemtype, lengthunit FROM issuingrules WHERE lengthunit NOT IN ( 'days', 'hours' ); |,
469 warnIssuingRules => 1,
475 # Guarantor relationships warnings
477 my $dbh = C4::Context->dbh;
478 my ($bad_relationships_count) = $dbh->selectall_arrayref(q{
481 SELECT relationship FROM borrower_relationships WHERE relationship='_bad_data'
483 SELECT relationship FROM borrowers WHERE relationship='_bad_data') a
486 $bad_relationships_count = $bad_relationships_count->[0]->[0];
488 my $existing_relationships = $dbh->selectall_arrayref(q{
489 SELECT DISTINCT(relationship)
491 SELECT relationship FROM borrower_relationships WHERE relationship IS NOT NULL
493 SELECT relationship FROM borrowers WHERE relationship IS NOT NULL) a
496 my %valid_relationships = map { $_ => 1 } split( /,|\|/, C4::Context->preference('borrowerRelationship') );
497 $valid_relationships{ _bad_data } = 1; # we handle this case in another way
499 my $wrong_relationships = [ grep { !$valid_relationships{ $_->[0] } } @{$existing_relationships} ];
500 if ( @$wrong_relationships or $bad_relationships_count ) {
503 warnRelationships => 1,
506 if ( $wrong_relationships ) {
508 wrong_relationships => $wrong_relationships
511 if ($bad_relationships_count) {
513 bad_relationships_count => $bad_relationships_count,
519 my %versions = C4::Context::get_versions();
522 kohaVersion => $versions{'kohaVersion'},
523 osVersion => $versions{'osVersion'},
524 perlPath => $perl_path,
525 perlVersion => $versions{'perlVersion'},
526 perlIncPath => [ map { perlinc => $_ }, @INC ],
527 mysqlVersion => $versions{'mysqlVersion'},
528 apacheVersion => $versions{'apacheVersion'},
529 zebraVersion => $zebraVersion,
530 prefBiblioAddsAuthorities => $prefBiblioAddsAuthorities,
531 prefAutoCreateAuthorities => $prefAutoCreateAuthorities,
532 warnPrefBiblioAddsAuthorities => $warnPrefBiblioAddsAuthorities,
533 warnPrefEasyAnalyticalRecords => $warnPrefEasyAnalyticalRecords,
534 warnPrefAnonymousPatronOPACPrivacy => $warnPrefAnonymousPatronOPACPrivacy,
535 warnPrefAnonymousPatronAnonSuggestions => $warnPrefAnonymousPatronAnonSuggestions,
536 warnPrefAnonymousPatronOPACPrivacy_PatronDoesNotExist => $warnPrefAnonymousPatronOPACPrivacy_PatronDoesNotExist,
537 warnPrefAnonymousPatronAnonSuggestions_PatronDoesNotExist => $warnPrefAnonymousPatronAnonSuggestions_PatronDoesNotExist,
538 errZebraConnection => $errZebraConnection,
539 warnIsRootUser => $warnIsRootUser,
540 warnNoActiveCurrency => $warnNoActiveCurrency,
541 warnNoTemplateCaching => ( C4::Context->config('template_cache_dir') ? 0 : 1 ),
542 xml_config_warnings => \@xml_config_warnings,
543 warnStatisticsFieldsError => $warnStatisticsFieldsError,
548 my $perl_modules = C4::Installer::PerlModules->new;
549 $perl_modules->versions_info;
551 my @pm_types = qw(missing_pm upgrade_pm current_pm);
553 foreach my $pm_type(@pm_types) {
554 my $modules = $perl_modules->get_attr($pm_type);
555 foreach (@$modules) {
556 my ($module, $stats) = each %$_;
561 version => $stats->{'cur_ver'},
562 missing => ($pm_type eq 'missing_pm' ? 1 : 0),
563 upgrade => ($pm_type eq 'upgrade_pm' ? 1 : 0),
564 current => ($pm_type eq 'current_pm' ? 1 : 0),
565 require => $stats->{'required'},
566 reqversion => $stats->{'min_ver'},
572 @components = sort {$a->{'name'} cmp $b->{'name'}} @components;
577 foreach (@components) {
579 unless (++$counter % 4) {
580 push (@$table, {row => $row});
584 # Processing the last line (if there are any modules left)
585 if (scalar(@$row) > 0) {
586 # Extending $row to the table size
588 # Pushing the last line
589 push (@$table, {row => $row});
593 $template->param( table => $table );
596 ## ------------------------------------------
597 ## Koha contributions
599 if ( defined C4::Context->config('docdir') ) {
600 $docdir = C4::Context->config('docdir');
602 # if no <docdir> is defined in koha-conf.xml, use the default location
603 # this is a work-around to stop breakage on upgraded Kohas, bug 8911
604 $docdir = C4::Context->config('intranetdir') . '/docs';
609 -e "$docdir" . "/teams.yaml"
610 ? LoadFile( "$docdir" . "/teams.yaml" )
612 my $dev_team = (sort {$b <=> $a} (keys %{$teams->{team}}))[0];
613 my $short_version = substr($versions{'kohaVersion'},0,5);
614 my $minor = substr($versions{'kohaVersion'},3,2);
615 my $development_version = ( $minor eq '05' || $minor eq '11' ) ? 0 : 1;
616 $template->param( short_version => $short_version );
617 $template->param( development_version => $development_version );
621 -e "$docdir" . "/contributors.yaml"
622 ? LoadFile( "$docdir" . "/contributors.yaml" )
624 for my $version ( sort { $a <=> $b } keys %{$teams->{team}} ) {
625 for my $role ( keys %{ $teams->{team}->{$version} } ) {
626 my $normalized_role = "$role";
627 $normalized_role =~ s/s$//;
628 if ( ref( $teams->{team}->{$version}->{$role} ) eq 'ARRAY' ) {
629 for my $contributor ( @{ $teams->{team}->{$version}->{$role} } ) {
630 my $name = $contributor->{name};
631 # Add role to contributors
632 push @{ $contributors->{$name}->{roles}->{$normalized_role} },
634 # Add openhub to teams
635 if ( exists( $contributors->{$name}->{openhub} ) ) {
636 $contributor->{openhub} = $contributors->{$name}->{openhub};
640 elsif ( $role ne 'release_date' ) {
641 my $name = $teams->{team}->{$version}->{$role}->{name};
642 # Add role to contributors
643 push @{ $contributors->{$name}->{roles}->{$normalized_role} },
645 # Add openhub to teams
646 if ( exists( $contributors->{$name}->{openhub} ) ) {
647 $teams->{team}->{$version}->{$role}->{openhub} =
648 $contributors->{$name}->{openhub};
652 $teams->{team}->{$version}->{$role} = DateTime->from_epoch( epoch => $teams->{team}->{$version}->{$role});
657 ## Create last name ordered array of people from contributors
659 { name => $_, ( $contributors->{$_} ? %{ $contributors->{$_} } : () ) }
661 my ($alast) = ( split( /\s/, $a ) )[-1];
662 my ($blast) = ( split( /\s/, $b ) )[-1];
663 lc($alast) cmp lc($blast)
664 } keys %{$contributors};
666 $template->param( contributors => \@people );
667 $template->param( maintenance_team => $teams->{team}->{$dev_team} );
668 $template->param( release_team => $teams->{team}->{$short_version} );
671 if ( open( my $file, "<:encoding(UTF-8)", "$docdir" . "/history.txt" ) ) {
681 shift @lines; #remove header row
684 my ( $epoch, $date, $desc, $tag ) = split(/\t/);
685 if(!$desc && $date=~ /(?<=\d{4})\s+/) {
686 ($date, $desc)= ($`, $');
698 #foreach my $row2 (@rows2) {
701 push( @$table2, { row2 => $row2 } );
705 $template->param( table2 => $table2 );
707 $template->param( timeline_read_error => 1 );
710 output_html_with_http_headers $query, $cookie, $template->output;