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