scripts/console

   1 #!/usr/bin/perl
   2
   3 use warnings;
   4 use strict;
   5 use 5.008;                          # too much magic in here to include perl 5.6
   6
   7 BEGIN {
   8   unshift @INC, "modules/override"; # Use our own versions of various modules (e.g. YAML).
   9   push    @INC, "modules/fallback"; # Only use our own versions of modules if there's no system version.
  10 }
  11
  12 use Config::Std;
  13 use Data::Dumper;
  14 use Devel::REPL 1.002001;
  15 use Term::ReadLine::Perl::Bind;     # use sane key binding for rxvt users
  16
  17 read_config 'config/console.conf' => my %config;# if -f 'config/console.conf';
  18
  19 my $login        = shift || $config{Console}{login}        || 'demo';
  20 my $history_file =          $config{Console}{history_file} || '/tmp/lxoffice_console_history.log'; # fallback if users is not writable
  21 my $autorun      =          $config{Console}{autorun};
  22
  23 # will be configed eventually
  24 my @plugins      = qw(History LexEnv Colors MultiLine::PPI FancyPrompt PermanentHistory AutoloadModules);
  25
  26 my $repl = Devel::REPL->new;
  27 $repl->load_plugin($_) for @plugins;
  28 $repl->load_history($history_file);
  29 $repl->eval('help');
  30 $repl->print("trying to auto login as '$login'...");
  31 $repl->print($repl->eval("lxinit '$login'"));
  32 if ($autorun) {
  33   my $result = $repl->eval($autorun);
  34   $repl->print($result->message) if ref($result) eq 'Devel::REPL::Error';
  35 }
  36 $repl->run;
  37
  38 package Devel::REPL;
  39
  40 use utf8;
  41 use CGI qw( -no_xhtml);
  42 use SL::Auth;
  43 use SL::Form;
  44 use SL::Locale;
  45 use SL::LXDebug;
  46 use Data::Dumper;
  47
  48 # this is a cleaned up version of am.pl
  49 # it lacks redirection, some html setup and most of the authentication process.
  50 # it is assumed that anyone with physical access and execution rights on this script
  51 # won't be hindered by authentication anyway.
  52 sub lxinit {
  53   my $login = shift;
  54
  55   die 'need login' unless $login;
  56
  57   package main;
  58
  59   { no warnings 'once';
  60     $::userspath  = "users";
  61     $::templates  = "templates";
  62     $::sendmail   = "| /usr/sbin/sendmail -t";
  63   }
  64
  65   eval { require "config/lx-erp.conf"; };
  66   eval { require "config/lx-erp-local.conf"; } if -f "config/lx-erp-local.conf";
  67
  68   $::lxdebug = LXDebug->new;
  69   $::locale = Locale->new($::language);
  70   $::cgi    = CGI->new qw();
  71   $::form   = Form->new;
  72   $::auth   = SL::Auth->new;
  73
  74   die 'cannot reach auth db'               unless $::auth->session_tables_present;
  75
  76   $::auth->restore_session;
  77
  78   require "bin/mozilla/common.pl";
  79
  80   die "cannot find user $login"            unless %::myconfig = $::auth->read_user($login);
  81
  82   $::form->{login} = $login; # normaly implicit at login
  83
  84   die "cannot find locale for user $login" unless $::locale   = Locale->new($::myconfig{countrycode});
  85
  86
  87   return "logged in as $login";
  88 }
  89
  90 # these function provides a load command to slurp in a lx-office module
  91 # since it's seldomly useful, it's not documented in help
  92 sub load {
  93   my $module = shift;
  94   $module =~ s/[^\w]//g;
  95   require "bin/mozilla/$module.pl";
  96 }
  97
  98 sub reload {
  99   require Module::Reload;
 100   Module::Reload->check();
 101
 102   return "modules reloaded";
 103 }
 104
 105 sub quit {
 106   exit;
 107 }
 108
 109 sub help {
 110   print <<EOL;
 111
 112   Lx-Office Konsole
 113
 114   ./scripts/console [login]
 115
 116 Spezielle Kommandos:
 117
 118   help                - zeigt diese Hilfe an.
 119   lxinit 'login'      - lädt das Lx-Office Environment für den User 'login'.
 120   reload              - lädt modifizierte Module neu.
 121   pp DATA             - zeigt die Datenstruktur mit Data::Dumper an.
 122   quit                - beendet die Konsole
 123
 124 EOL
 125 #  load   'module'     - läd das angegebene Modul, d.h. bin/mozilla/module.pl und SL/Module.pm.
 126 }
 127
 128 sub pp {
 129   local $Data::Dumper::Indent   = 2;
 130   local $Data::Dumper::Maxdepth = 2;
 131   local $Data::Dumper::Sortkeys = 1;
 132   Data::Dumper::Dumper(@_);
 133 }
 134
 135 1;
 136
 137 __END__
 138
 139 =head1 NAME
 140
 141 scripts/console - Lx Office Console
 142
 143 =head1 SYNOPSIS
 144
 145   ./script/console
 146   > help               # displays a brief documentation
 147
 148 =head1 DESCRIPTION
 149
 150 Users of Ruby on Rails will recognize this as a perl reimplementation of the
 151 rails scripts/console. It's intend is to provide a shell environment to the
 152 lx-office internals. This will mostly not interest you if you just want to do
 153 your ERP stuff with lx-office, but will be invaluable for those who wish to
 154 make changes to lx-office itself.
 155
 156 =head1 FUNCTIONS
 157
 158 You can do most things in the console that you could do in an actual perl
 159 script. Certain helper functions will aid you in debugging the state of the
 160 program:
 161
 162 =head2 pp C<DATA>
 163
 164 Named after the rails pretty print gem, this will call Data::Dumper on the
 165 given C<DATA>. Use it to see what is going on.
 166
 167 Currently C<pp> will set the Data::Dumper depth to 2, so if you need a
 168 different depth, you'll have to change that. A nice feature would be to
 169 configure that, or at least to be able to change it at runtime.
 170
 171 =head2 lxinit C<login>
 172
 173 Login into lx-office using a specified login. No password will be required, and
 174 security mechanisms will mostly be inactive. form, locale, myconfig will be
 175 correctly set.
 176
 177 =head2 reload
 178
 179 Attempts to reload modules that changed since last reload (or inital startup).
 180 This will mostly work just fine, except for Moose classes that have been made
 181 immutable. Keep in mind that existing objects will continue to have the methods
 182 of the classes they were created with.
 183
 184 =head1 BUGS
 185
 186  - Reload on immutable Moose classes is buggy.
 187  - Logging in more than once is not supported by the program, and thus not by
 188    the console. It seems to work, but strange things may happen.
 189
 190 =head1 SEE ALSO
 191
 192 Configuration of this script is located in:
 193
 194  config/console.conf
 195  config/console.conf.default
 196
 197 See there for interesting options.
 198
 199 =head1 AUTHOR
 200
 201   Sven Schöling <s.schoeling@linet-services.de>
 202
 203 =cut