2 # koha-shell -- put you in a shell with a koha environment set up
3 # Copyright 2012 Catalyst IT, Ltd
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 Getopt::Long::Configure("bundling");
24 my $res = GetOptions( \%opts, "command|c=s", "help|h", "login|l", "shell|s=s",
25 "preserve-environment|p|m", "verbose|v" );
27 if ( !$res || $opts{help} ) {
33 show_help( 1, "An instance name must be supplied." );
36 my $instance = shift @ARGV;
37 if ( !-e "/etc/koha/sites/$instance" ) {
38 show_help( 1, "The instance doesn't exist: $instance" );
41 my $shell = $opts{shell} || $ENV{SHELL} || '/bin/sh';
43 # Now we're set up, build the 'su' command
44 my $perl5lib = read_perl5lib( $instance );
46 push @su_args, '/usr/bin/sudo';
47 push @su_args, '--preserve-env' if $opts{'preserve-environment'};
48 push @su_args, '--login' if $opts{login};
49 push @su_args, "-u", "$instance-koha";
52 . "KOHA_CONF=/etc/koha/sites/$instance/koha-conf.xml "
53 . "PERL5LIB=$perl5lib $shell"
54 . ( $opts{command} ? " -c '$opts{command}'" : '' );
56 print "Command: '".join("' '",@su_args)."'\n" if $opts{verbose};
59 print STDERR "failed to execute: $!\n";
62 printf STDERR "child died with signal %d, %s coredump\n",
63 ( $? & 127 ), ( $? & 128 ) ? 'with' : 'without';
67 my ( $err, $msg ) = @_;
69 my $fh = $err ? *STDERR : *STDOUT;
70 say $fh "Error: " . $msg if $msg;
71 print $fh $_ while <DATA>;
75 my ( $instance ) = @_;
77 # This simulates what the debian shell scripts do:
78 # Read /etc/default/koha-common
79 # Check dev_install in koha-conf.xml
81 my $result = `grep "^PERL5LIB=" /etc/default/koha-common`;
83 $result =~ s/^PERL5LIB=\s*//;
84 my $dev_install = `xmlstarlet sel -t -v 'yazgfs/config/dev_install' /etc/koha/sites/$instance/koha-conf.xml`;
86 return $dev_install || $result;
90 koha-shell -- gives you a shell with your Koha environment set up
92 Usage: koha-shell [options] [instance name]
95 -c, --command COMMAND pass COMMAND to the invoked shell
96 -h, --help show this help and quit
97 -l, --login make the shell a login shell
99 --preserve-environment do not reset environment variables
100 -s, --shell SHELL use SHELL instead of the one from your environment
101 -v, --verbose output the full command that will be executed
103 The default shell is the one currently in use. Refer to su(1) for more detail