Koha-clms/Koha/Config.pm

138 lines
4.7 KiB
Perl

package Koha::Config;
# 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 XML::LibXML ':libxml';
# Default config file, if none is specified
use constant CONFIG_FNAME => "/etc/koha/koha-conf.xml";
# path to config file set by installer
# __KOHA_CONF_DIR__ is set by rewrite-confg.PL
# when Koha is installed in 'standard' or 'single'
# mode. If Koha was installed in 'dev' mode,
# __KOHA_CONF_DIR__ is *not* rewritten; instead
# developers should set the KOHA_CONF environment variable
my $INSTALLED_CONFIG_FNAME = '__KOHA_CONF_DIR__/koha-conf.xml';
# Should not be called outside of C4::Context
# use C4::Context->config instead
sub read_from_file {
my ( $class, $file ) = @_;
return if not defined $file;
my $config = {};
eval {
my $dom = XML::LibXML->load_xml(location => $file);
foreach my $childNode ($dom->documentElement->nonBlankChildNodes) {
$class->_read_from_dom_node($childNode, $config);
}
};
if ($@) {
die "\nError reading file $file.\nTry running this again as the koha instance user (or use the koha-shell command in debian)\n\n";
}
return $config;
}
sub _read_from_dom_node {
my ($class, $node, $config) = @_;
if ($node->nodeType == XML_TEXT_NODE) {
$config->{content} = $node->textContent;
} elsif ($node->nodeType == XML_ELEMENT_NODE) {
my $subconfig = {};
foreach my $attribute ($node->attributes) {
my $key = $attribute->nodeName;
my $value = $attribute->value;
$subconfig->{$key} = $value;
}
foreach my $childNode ($node->nonBlankChildNodes) {
$class->_read_from_dom_node($childNode, $subconfig);
}
my $key = $node->nodeName;
if ($node->hasAttribute('id')) {
my $id = $node->getAttribute('id');
$config->{$key} //= {};
$config->{$key}->{$id} = $subconfig;
delete $subconfig->{id};
} else {
my @keys = keys %$subconfig;
if (1 == scalar @keys && $keys[0] eq 'content') {
# An element with no attributes and no child elements becomes its text content
$subconfig = $subconfig->{content};
} elsif (0 == scalar @keys) {
# An empty element becomes an empty string
$subconfig = '';
}
if (exists $config->{$key}) {
unless (ref $config->{$key} eq 'ARRAY') {
$config->{$key} = [$config->{$key}];
}
push @{ $config->{$key} }, $subconfig;
} else {
if (grep { $_ eq $key } (qw(listen server serverinfo))) {
# <listen>, <server> and <serverinfo> are always arrays
$config->{$key} = [$subconfig];
} else {
$config->{$key} = $subconfig;
}
}
}
}
}
# Koha's main configuration file koha-conf.xml
# is searched for according to this priority list:
#
# 1. Path supplied via use C4::Context '/path/to/koha-conf.xml'
# 2. Path supplied in KOHA_CONF environment variable.
# 3. Path supplied in INSTALLED_CONFIG_FNAME, as long
# as value has changed from its default of
# '__KOHA_CONF_DIR__/koha-conf.xml', as happens
# when Koha is installed in 'standard' or 'single'
# mode.
# 4. Path supplied in CONFIG_FNAME.
#
# The first entry that refers to a readable file is used.
sub guess_koha_conf {
# If the $KOHA_CONF environment variable is set, use
# that. Otherwise, use the built-in default.
my $conf_fname;
if ( exists $ENV{"KOHA_CONF"} and $ENV{'KOHA_CONF'} and -s $ENV{"KOHA_CONF"} ) {
$conf_fname = $ENV{"KOHA_CONF"};
} elsif ( $INSTALLED_CONFIG_FNAME !~ /__KOHA_CONF_DIR/ and -s $INSTALLED_CONFIG_FNAME ) {
# NOTE: be careful -- don't change __KOHA_CONF_DIR in the above
# regex to anything else -- don't want installer to rewrite it
$conf_fname = $INSTALLED_CONFIG_FNAME;
} elsif ( -s CONFIG_FNAME ) {
$conf_fname = CONFIG_FNAME;
}
return $conf_fname;
}
1;