path: root/bin/slxsettings

#! /usr/bin/perl
# -----------------------------------------------------------------------------
# Copyright (c) 2006, 2007 - OpenSLX GmbH
#
# This program is free software distributed under the GPL version 2.
# See http://openslx.org/COPYING
#
# If you have any feedback please consult http://openslx.org/feedback and
# send your suggestions, praise, or complaints to feedback@openslx.org
#
# General information about OpenSLX can be found at http://openslx.org/
# -----------------------------------------------------------------------------
# slxsettings
#	- OpenSLX-script to show & change local settings
# -----------------------------------------------------------------------------
use strict;

my $abstract = q[
slxsettings
    This script can be used to show or change the local settings for OpenSLX.

    Any cmdline-argument passed to this script will change the local OpenSLX
    settings file (usually /etc/opt/openslx/settings).

    If you invoke the script without any arguments, it will print the current
    settings and exit.

    Please use the --man option in order to read the full manual.
];

use Getopt::Long qw(:config pass_through);
use Pod::Usage;

# add the lib-folder and the folder this script lives in to perl's search
# path for modules:
use FindBin;
use lib "$FindBin::RealBin/../lib";
use lib "$FindBin::RealBin";
	# development path to config-db stuff

use OpenSLX::Basics;
use OpenSLX::Utils;

my (
	$quiet,
	@reset,
	$helpReq,
	$manReq,
	$versionReq,
);

GetOptions(
	'quiet' => \$quiet,
		# will avoid printing anything
	'reset=s' => \@reset,
		# resets given option to its default

	'help|?' => \$helpReq,
	'man' => \$manReq,
	'version' => \$versionReq,
);
pod2usage(-msg => $abstract, -verbose => 0, -exitval => 1) if $helpReq;
pod2usage(-verbose => 2) if $manReq;
if ($versionReq) {
	system('slxversion');
	exit 1;
}

openslxInit() or pod2usage(2);

my %givenSettings = %cmdlineConfig;

# if there are still arguments in the cmdline left, it must be extended
# settings:
while (scalar @ARGV) {
	my $extSetting = shift;
	if ($extSetting !~ m[^([-\w]+)=(.+)$]) {
		die _tr("extended setting '%s' has unknown format, expected '<key>=<value>!'",
				$extSetting);
	}
	$givenSettings{$1} = $2;
}

# fetch current content of local settings file...
my $settings = slurpFile("$openslxConfig{'config-path'}/settings");

my $changeCount;

# ...set new values...
foreach my $key (keys %givenSettings) {
	next if $key eq 'config-path';
		# config-path can't be changed, it is used to find settings
	my $value = $givenSettings{$key};
	next if !defined $value;
	vlog 0, _tr("setting %s to '%s'", $key, $value) unless $quiet;
	my $externalKey = externalKeyFor($key);
	if (!($settings =~ s[^\s*$externalKey=.*?$][$externalKey=$value]ms)) {
		$settings .= "$externalKey=$value\n";
	}
	$changeCount++;
}

# reset specified keys to fall back to default:
foreach my $key (@reset) {
	my $externalKey = externalKeyFor($key);
	if ($settings =~ s[^\s*?$externalKey=.*?\n][]ms) {
		vlog 0, _tr("removing option '%s' from local settings", $key) unless $quiet;
	} else {
		vlog 0, _tr("option '%s' didn't exist in local settings!", $key) unless $quiet;
	}
	$changeCount++;
}

# ... and write local settings file if necessary
if ($changeCount) {
	my $f = "$openslxConfig{'config-path'}/settings";
	open(SETTINGS, "> $f")
		or die _tr("Unable to write local settings file '%s' (%s)", $f, $!);
	print SETTINGS $settings;
	close(SETTINGS);
}

if (!$changeCount) {
	my $text
		= $changeCount ? "resulting base settings:" : "current base settings:";
	print "\n"._tr($text)."\n";
	my @baseSettings = grep { exists $cmdlineConfig{$_} } keys %openslxConfig;
	foreach my $key (sort @baseSettings) {
		print qq[\t--$key='$openslxConfig{$key}'\n];
	}
	print "extended settings:\n";
	my @extSettings = grep { !exists $cmdlineConfig{$_} } keys %openslxConfig;
	foreach my $key (sort @extSettings) {
		print qq[\t$key='$openslxConfig{$key}'\n];
	}
}

sub externalKeyFor
{
	my $key = shift;

	$key =~ tr[-][_];
	return "SLX_".uc($key);
}



=head1 NAME

slxsettings - OpenSLX-script to show & change local settings

=head1 SYNOPSIS

slxsettings [options] [action ...]

=head3 Script Options

      --reset=<string>           resets the given option to its default

=head3 OpenSLX Options

      --base-path=<string>       basic path to project files
      --bin-path=<string>        path to binaries and scripts
      --config-path=<string>     path to configuration files
      --db-basepath=<string>     basic path to openslx database
      --db-datadir=<string>      data folder created under db-basepath
      --db-name=<string>         name of database
      --db-spec=<string>         full DBI-specification of database
      --db-type=<string>         type of database to connect to
      --export-path=<string>     path to root of all exported filesystems
      --locale=<string>          locale to use for translations
      --logfile=<string>         file to write logging output to
      --private-path=<string>    path to private data
      --public-path=<string>     path to public (client-accesible) data
      --share-path=<string>      path to sharable data
      --temp-path=<string>       path to temporary data
      --tftpboot-path=<string>   path to root of tftp-server
      --verbose-level=<int>      level of logging verbosity (0-3)

=head3 General Options

      --help                     brief help message
      --man                      full documentation
      --quiet                    do not print anything
      --version                  show version

=head3 Actions

=over 8

=item B<<     --<openslx-option>=<value> >>

sets the specified openslx-option to the given value

=item B<<     <extended-setting>=<value> >>

sets the specified extended setting to the given value

=item B<<     --reset=<setting> [--reset=...] >>

removes the given setting from the local settings (resets it to its default
value)

=back

=head1 DESCRIPTION

B<slxsettings> can be used to show or change the local settings for OpenSLX.

Any cmdline-argument passed to this script will change the local OpenSLX
settings file (usually /etc/opt/openslx/settings).

If you invoke the script without any arguments, it will print the current
settings and exit.

=head1 OPTIONS

=head3 OpenSLX Options

=over 8

=item B<<     --base-path=<string> >>

Sets basic path to project files.

Default is $SLX_BASE_PATH (usually F</opt/openslx>).

=item B<<     --bin-path=<string> >>

Sets path to binaries and scripts.

Default is $SLX_BASE_PATH/bin (usually F</opt/openslx/bin>).

=item B<<     --config-path=<string> >>

Sets path to configuration files.

Default is $SLX_CONFIG_PATH (usually F</etc/opt/openslx>).

=item B<<     --db-basepath=<string> >>

Sets basic path to openslx database.

Default is $SLX_DB_PATH (usually F</var/opt/openslx/db>).

=item B<<     --db-datadir=<string> >>

Sets data folder created under db-basepath.

Default is $SLX_DB_DATADIR (usually empty as it depends on db-type
whether or not such a directory is required at all).

=item B<<     --db-name=<string> >>

Gives the name of the database to connect to.

Default is $SLX_DB_NAME (usually C<openslx>).

=item B<<     --db-spec=<string> >>

Gives the full DBI-specification of database to connect to. Content depends
on the db-type.

Default is $SLX_DB_SPEC (usually empty as it will be built automatically).

=item B<<     --db-type=<string> >>

Sets the type of database to connect to (CSV, SQLite, mysql, ...).

Default $SLX_DB_TYPE (usually C<CSV>).

=item B<<     --export-path=<string> >>

Sets path to root of all exported filesystems. For each type of export (NFS,
NBD, ...) a separate folder will be created in here.

Default is $SLX_EXPORT_PATH (usually F</srv/openslx/export>.

=item B<<     --locale=<string> >>

Sets the locale to use for translations.

Defaults to the system's standard locale.

=item B<<     --logfile=<string> >>

Specifies a file where logging output will be written to.

Default is to log to STDERR.

=item B<<     --private-path=<string> >>

Sets path to private data, where the config-db, vendor_oses and configurational
extensions will be stored.

Default is $SLX_PRIVATE_PATH (usually F</var/opt/openslx>.

=item B<<     --public-path=<string> >>

Sets path to public (client-accesible) data.

Default is $SLX_PUBLIC_PATH (usually F</srv/openslx>.

=item B<<     --share-path=<string> >>

Sets path to sharable data, where distro-specs and functionality templates
will be stored.

Default is $SLX_SHARE_PATH (usually F</opt/openslx/share>.

=item B<<     --stage1-path=<string> >>

Sets path to stage1 systems, where distributor-systems will be installed.

Default is $SLX_STAGE1_PATH (usually F</var/opt/openslx/stage1>.

=item B<<     --temp-path=<string> >>

Sets path to temporary data.

Default is $SLX_TEMP_PATH (usually F</tmp>.

=item B<<     --tftpboot-path=<string> >>

Sets path to root of tftp-server from which clients will access their files.

Default is $SLX_TFTPBOOT_PATH (usually F</srv/openslx/tftpboot>.

=item B<<     --verbose-level=<int> >>

Sets the level of logging verbosity (0-3).
Prints additional output for debugging. N is a number between 0 and 3. Level
1 provides more information than the default, while 2 provides traces. With
level 3 you get extreme debug output, e.g. database commands are printed.

Default is $SLX_VERBOSE_LEVEL (usually 0, no logging).

=back

=head3 General Options

=over 8

=item B<    --help>

Prints a brief help message and exits.

=item B<    --man>

Prints the manual page and exits.

=item B<    --quiet>

Runs the script without printing anything.

=item B<    --version>

Prints the version and exits.

=back

=head1 SEE ALSO

slxos-setup, slxos-export, slxconfig, slxconfig-demuxer

=cut