/[cvs]/nfo/perl/libs/shortcuts.pm
ViewVC logotype

Contents of /nfo/perl/libs/shortcuts.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.16 - (show annotations)
Wed Jun 25 22:49:56 2003 UTC (20 years, 10 months ago) by joko
Branch: MAIN
Changes since 1.15: +17 -6 lines
RUNNING_IN_HELL mode for detach option

1 ## ---------------------------------------------------------------------------
2 ## $Id: shortcuts.pm,v 1.15 2003/06/24 20:21:12 jonen Exp $
3 ## ---------------------------------------------------------------------------
4 ## $Log: shortcuts.pm,v $
5 ## Revision 1.15 2003/06/24 20:21:12 jonen
6 ## + changed linux part of run_cmd to use Proc::Background instead of IPC::...
7 ##
8 ## Revision 1.14 2003/06/24 20:13:18 joko
9 ## + sub findpatch
10 ## + now using findpatch and Proc::Background for win32/perl
11 ##
12 ## Revision 1.13 2003/06/23 20:58:31 joko
13 ## restructured, hopefully makes Linux and Windows (and *BSD) more compatible... what about IPC::Cmd???
14 ##
15 ## Revision 1.12 2003/06/23 19:43:19 joko
16 ## minor cleanup
17 ## now using IPC::Session::NoShell
18 ##
19 ## Revision 1.11 2003/06/23 17:41:50 jonen
20 ## + NEW - used IPC::Session instead of IPC::Run to get better results at linux
21 ##
22 ## Revision 1.10 2003/06/23 15:59:16 joko
23 ## major/minor fixes?
24 ##
25 ## Revision 1.9 2003/05/13 05:36:24 joko
26 ## heavy modifications to run_cmd
27 ## + sub get_executable
28 ## + sub get_executable_wrapper
29 ##
30 ## Revision 1.8 2003/04/04 17:31:59 joko
31 ## + sub make_guid
32 ##
33 ## Revision 1.7 2003/03/29 07:24:10 joko
34 ## enhanced 'run_cmd': now tries to execute program with appropriate application (e.g. 'cmd.exe' or 'perl')
35 ##
36 ## Revision 1.6 2003/03/28 06:58:06 joko
37 ## new: 'run_cmd' now asynchronous! (via IPC::Run...)
38 ##
39 ## Revision 1.5 2003/02/22 17:26:13 joko
40 ## + enhanced unix compatibility fix
41 ##
42 ## Revision 1.4 2003/02/22 17:19:36 joko
43 ## + unix compatibility fix
44 ##
45 ## Revision 1.3 2003/02/14 14:17:04 joko
46 ## - shortened seperator
47 ##
48 ## Revision 1.2 2003/02/11 05:14:28 joko
49 ## + refactored code from libp.pm
50 ##
51 ## Revision 1.1 2003/02/09 04:49:45 joko
52 ## + shortcuts now refactored to this file
53 ##
54 ## ---------------------------------------------------------------------------
55
56
57 package shortcuts;
58
59 use strict;
60 use warnings;
61
62 require Exporter;
63 our @ISA = qw( Exporter );
64 our @EXPORT_OK = qw(
65 strftime
66 now today
67 run_cmd run_cmds
68 get_chomped
69 bool2status
70 make_guid
71 );
72
73
74 use Data::Dumper;
75 use POSIX qw( strftime );
76 #use IPC::Run qw( run timeout );
77 use IPC::Run qw( start pump finish timeout run timer ) ;
78 use Carp;
79
80 # NEW - 2003-06-23 for Linux (what about *BSD?)
81 use IPC::Session;
82
83 use File::Spec;
84 use Proc::Background;
85
86
87 # $now_string = strftime "%a %b %e %H:%M:%S %Y", localtime;
88 # see "perldoc -f localtime"
89 sub now {
90 my $options = shift;
91 my $pattern = "%Y-%m-%d %H:%M:%S";
92 $pattern = "%Y-%m-%d_%H-%M-%S" if $options->{fs};
93 my $result = strftime($pattern, localtime);
94 return $result;
95 }
96
97 sub today {
98 return strftime("%Y-%m-%d", localtime);
99 }
100
101 sub RUNNING_IN_HELL () { $^O eq 'MSWin32' }
102
103
104 sub get_executable {
105 my $cmd = shift;
106 # FIXME: detect type of program and run with proper application/interpreter
107 # using IPC::Run we have to dispatch this on our own! *no* os-interaction or interpolation here!?
108 # => better use absolute path-names only?!
109 my $application = '';
110 if ($cmd =~ m/\w+\.pl\s*.*/) {
111 $application = get_interpreter_wrapper($cmd, 'perl');
112 #$cmd = "$application $cmd" if $application;
113 $application .= ' ';
114
115 } else {
116 $application = './';
117 }
118 return $application;
119 }
120
121 sub get_interpreter_wrapper {
122 my $cmd = shift;
123 my $language = shift;
124 $language ||= '';
125
126 my $wrapper = '';
127
128 if ($language eq 'perl') {
129
130 if (RUNNING_IN_HELL()) {
131 # Required to adapt to IPC::Run on win32.
132 #$wrapper = 'cmd.exe /C perl';
133 #$wrapper = 'start perl';
134 $wrapper = 'perl';
135 #$wrapper = 'cmd.exe /C';
136 } else {
137 # NEW 2003-06-23 - needed if used with IPC::Session (at Linux)
138 # whats about Win32?
139 $wrapper = 'perl';
140 }
141
142 } else {
143 die("No wrapper for language '$language'.");
144 }
145
146 return $wrapper;
147 }
148
149
150 sub run_cmd {
151 my $cmd = shift;
152 my $caption = shift;
153 my $options = shift;
154
155 #print STDOUT "run_cmd - options: ", Dumper($options), "\n";
156
157 # report - header
158 my $sep = "-" x 60;
159 print STDOUT $sep, "\n";
160 print STDOUT " ", $cmd;
161 print STDOUT " - ", $caption if $caption;
162 print STDOUT "\n", $sep, "\n";
163
164 # strip name of executable from full command string
165 $cmd =~ m/^(.+?)\s(.*)$/;
166 my $executable = $1;
167 my $executable_args = $2;
168
169 =pod
170 # for unix: check if executable is in local directory, if so - prefix with './'
171 if (!RUNNING_IN_HELL()) {
172 #if ($cmd !~ m/\//) {
173 if (-e $executable) {
174 }
175 }
176 =cut
177
178 # new of 2003-05-07: basedir option to be prepended to command string
179 my $basedir = $options->{BASEDIR};
180 my $use_path = $options->{USE_PATH};
181
182 # for all systems: check existance of files - use basedir if given, try current directory otherwise
183 if ($basedir) {
184 -e "$basedir/$executable" or die("$basedir/$executable does not exist.");
185 $basedir .= '/';
186 $cmd = "$basedir$cmd";
187 } elsif ($use_path) {
188 #$basedir = "";
189 $basedir = findpath($executable);
190 #print "basedir: $basedir", "\n";
191 my $abspath = File::Spec->catfile($basedir, $executable);
192 #print STDOUT "PATH: ", $abspath, "\n";
193 -e $abspath or die("$abspath does not exist.");
194 $cmd = $abspath . ' ' . $executable_args;
195 } else {
196 -e $executable or die("$executable does not exist.");
197 #$basedir = ".";
198 #$basedir .= './';
199 $basedir = "";
200 $cmd = "$basedir$cmd";
201 }
202
203 # V1 - backticks or qq{}
204 #`$cmd`;
205 #qq{$cmd};
206
207 # V2 - via 'system'
208 #system($cmd);
209
210 #if (not $use_path) {
211 my $application = get_executable($cmd);
212 $cmd = "$application$cmd" if $application;
213 #}
214
215 my @cmd = split(' ', $cmd);
216
217 # V3 - using IPC (optional)
218 if ($options->{async}) {
219
220 #run \@cmd, \$in, \$out, \$err, timeout( 10 ) or die "cat: $?";
221
222 print STDOUT "run_cmd[async]: Proc::Background: $cmd", "\n";
223
224 # V3.1 - using IPC::Run
225 #
226 # tests:
227
228 if (RUNNING_IN_HELL()) {
229
230 #my $in; my $out; my $err;
231
232 #print STDOUT "findpath: ", findpath('rap.pl'), "\n";
233
234 # no success!
235 #start \@cmd, timeout(0) or croak("run_cmd: IPC::Run could not start '$cmd'.");
236 #
237 # success on Win32, but seems broken at 'timeout' on linux:
238 #run(\@cmd, timeout(3)) or croak("run_cmd: IPC::Run could not start '$cmd'.");
239 #start(\@cmd, timer(2)) or croak("run_cmd: IPC::Run could not start '$cmd'.");
240 #start(\@cmd, \undef) or croak("run_cmd: IPC::Run could not start '$cmd'.");
241 #start \@cmd or croak("run_cmd: IPC::Run could not start '$cmd'.");
242 #start(\@cmd, timeout(1)) or croak("run_cmd: IPC::Run could not start '$cmd'.");
243
244 # other tests ;)
245 #$IPC::Run::Timer::timeout = 2000;
246 #start $cmd or die("IPC::Run could not start '$cmd'.");
247
248 #my $in; my $out; my $t;
249 #my $harness = start( \@cmd, \$in, \$out, $t = timer( 5 ) ) ;
250 #my $harness = start( \@cmd ) ;
251 #$harness->pump_nb();
252
253 #my $postfix = '2>&1 |';
254 #open PIPE, "$cmd $postfix" or die("run_cmd: could not run in background via open!");
255
256 my $proc1 = Proc::Background->new(@cmd);
257 print "pid: ", $proc1->pid(), "\n";
258
259
260 } else {
261
262 #print STDOUT "run_cmd: IPC::Session: $cmd", "\n";
263
264 # V3.2 - using IPC::Session
265 # success on Linux AND Win32 ??
266 #
267 # set timeout:
268 # (don't really know why we needs some secconds
269 # to wait for init of process !?!)
270 #my $session_timeout = 15;
271 # set session name (default: cmd as string):
272 #my $session_command = $cmd;
273 #my $session_shell = "/bin/sh";
274 # create session (beware of using '->new' here!?):
275 #my $session = new IPC::Session($session_shell, $session_timeout);
276
277 # send 'cmd' to session - not required since complete command is sent via constructor above
278 #$session->send($cmd);
279
280 #my $output = $session->stdout();
281 #print "WS::Admin started.\n" if $output = ' ';
282
283 # tests
284 #$session->send("echo hello");
285 #chomp(my $hello = $session->stdout());
286 #print "ok 3\n" if $hello eq "hello";
287
288 # optional switch case:
289 #for ($session->stdout()) {
290 # /_bootDataBases/ && do { print "WS::Admin started.\n" };
291 #}
292 # optional get error:
293 #my $err = session->stderr();
294 #print "ERR: " . Dumper($err) . "\n";
295
296 #open( *OUT, ">out.txt" ) ;
297 #open( *ERR, ">err.txt" ) ;
298 #run(\@cmd, \undef, \*OUT, \*ERR ) or croak("run_cmd: IPC::Run could not start '$cmd'.");
299 #my ($out, $err);
300 #my $h = start(\@cmd, \undef, \*OUT, \*ERR ) or croak("run_cmd: IPC::Run could not start '$cmd'.");
301 #finish $h if $err =~ /error/;
302
303 # get child pid
304 #my $kid;
305 #do { $kid=wait(); } until $kid > 0;
306 #print "Child PID: " . $kid . "n";
307
308 #finish $h;
309
310
311 # test using Proc::Background - success !!
312 my $proc = Proc::Background->new($cmd);
313 my $kid = $proc->pid();
314 print STDOUT "run_cmd: Proc::Background: $cmd, child PID $kid", "\n";
315 $proc->wait();
316 $proc->die();
317
318 }
319
320
321 } elsif ($options->{detach}) {
322
323 if (RUNNING_IN_HELL()) {
324 print STDOUT "run_cmd[detach]: Proc::Background: $cmd", "\n";
325 my $proc1 = Proc::Background->new(@cmd);
326 print "pid: ", $proc1->pid(), "\n";
327 } else {
328 print STDERR "run_cmd[detach]: system('$cmd' &).", "\n";
329 system($cmd . ' &');
330 }
331
332 } else {
333 print STDOUT "run_cmd: system('$cmd').", "\n";
334 system($cmd);
335 }
336
337 print STDOUT "run_cmd: ready.", "\n";
338
339 }
340
341 sub run_cmds {
342 my $options = {};
343 if (ref $_[$#_] eq 'HASH') {
344 #print "YAI", "\n";
345 $options = pop @_;
346 }
347 foreach (@_) {
348 run_cmd($_, '', $options);
349 }
350 }
351
352 sub get_chomped {
353 my $str = shift;
354 chomp($str);
355 return $str;
356 }
357
358 sub bool2status {
359 my $bool = shift;
360 return ($bool ? 'ok' : 'failed');
361 }
362
363 # create global unique identifers using Data::UUID
364 # if updating this code, please also modify Tangram::Storage::make_guid
365 sub make_guid
366 {
367 my $self = shift;
368
369 my $guid;
370
371 # try to use Data::UUID first ...
372 eval("use Data::UUID;");
373 if (!$@) {
374 my $ug = Data::UUID->new();
375 $guid = $ug->create_str();
376
377 # ... if this fails, try to fallback to Data::UUID::PurePerl instead ...
378 } else {
379 eval("use Data::UUID::PurePerl;");
380 if (!$@) {
381 $guid = Data::UUID::PurePerl::generate_id();
382 } else {
383 croak "couldn't create globally unique identifier";
384 }
385 }
386
387 return $guid;
388 }
389
390 # [modified] from: http://www.mit.edu/afs/athena/contrib/watchmaker/src/pt/Configure
391 sub findpath {
392 #local($path);
393 #local($arg) = shift;
394 my $arg = shift;
395 my $path;
396 #for my $dir (split(/:/,$ENV{'PATH'})) {
397 for my $dir (File::Spec->path()) {
398 #if (-x "$dir/$arg" && -f _) {
399 #print STDOUT "scanning: ", "$dir/$arg", "\n";
400 if (-e "$dir/$arg") {
401 #$path = "$dir/$arg";
402 #$path = "$dir/";
403 $path = $dir;
404 last;
405 }
406 }
407 $path;
408 }
409
410 1;
411 __END__

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed