1 |
## --------------------------------------------------------------------------- |
2 |
## $Id: shortcuts.pm,v 1.12 2003/06/23 19:43:19 joko Exp $ |
3 |
## --------------------------------------------------------------------------- |
4 |
## $Log: shortcuts.pm,v $ |
5 |
## Revision 1.12 2003/06/23 19:43:19 joko |
6 |
## minor cleanup |
7 |
## now using IPC::Session::NoShell |
8 |
## |
9 |
## Revision 1.11 2003/06/23 17:41:50 jonen |
10 |
## + NEW - used IPC::Session instead of IPC::Run to get better results at linux |
11 |
## |
12 |
## Revision 1.10 2003/06/23 15:59:16 joko |
13 |
## major/minor fixes? |
14 |
## |
15 |
## Revision 1.9 2003/05/13 05:36:24 joko |
16 |
## heavy modifications to run_cmd |
17 |
## + sub get_executable |
18 |
## + sub get_executable_wrapper |
19 |
## |
20 |
## Revision 1.8 2003/04/04 17:31:59 joko |
21 |
## + sub make_guid |
22 |
## |
23 |
## Revision 1.7 2003/03/29 07:24:10 joko |
24 |
## enhanced 'run_cmd': now tries to execute program with appropriate application (e.g. 'cmd.exe' or 'perl') |
25 |
## |
26 |
## Revision 1.6 2003/03/28 06:58:06 joko |
27 |
## new: 'run_cmd' now asynchronous! (via IPC::Run...) |
28 |
## |
29 |
## Revision 1.5 2003/02/22 17:26:13 joko |
30 |
## + enhanced unix compatibility fix |
31 |
## |
32 |
## Revision 1.4 2003/02/22 17:19:36 joko |
33 |
## + unix compatibility fix |
34 |
## |
35 |
## Revision 1.3 2003/02/14 14:17:04 joko |
36 |
## - shortened seperator |
37 |
## |
38 |
## Revision 1.2 2003/02/11 05:14:28 joko |
39 |
## + refactored code from libp.pm |
40 |
## |
41 |
## Revision 1.1 2003/02/09 04:49:45 joko |
42 |
## + shortcuts now refactored to this file |
43 |
## |
44 |
## --------------------------------------------------------------------------- |
45 |
|
46 |
|
47 |
package shortcuts; |
48 |
|
49 |
use strict; |
50 |
use warnings; |
51 |
|
52 |
require Exporter; |
53 |
our @ISA = qw( Exporter ); |
54 |
our @EXPORT_OK = qw( |
55 |
strftime |
56 |
now today |
57 |
run_cmd run_cmds |
58 |
get_chomped |
59 |
bool2status |
60 |
make_guid |
61 |
); |
62 |
|
63 |
|
64 |
use Data::Dumper; |
65 |
use POSIX qw( strftime ); |
66 |
#use IPC::Run qw( run timeout ); |
67 |
use IPC::Run qw( start pump finish timeout run ) ; |
68 |
use Carp; |
69 |
|
70 |
# NEW - 2003-06-23 for Linux (what about *BSD?) |
71 |
use IPC::Session; |
72 |
|
73 |
|
74 |
# $now_string = strftime "%a %b %e %H:%M:%S %Y", localtime; |
75 |
# see "perldoc -f localtime" |
76 |
sub now { |
77 |
my $options = shift; |
78 |
my $pattern = "%Y-%m-%d %H:%M:%S"; |
79 |
$pattern = "%Y-%m-%d_%H-%M-%S" if $options->{fs}; |
80 |
my $result = strftime($pattern, localtime); |
81 |
return $result; |
82 |
} |
83 |
|
84 |
sub today { |
85 |
return strftime("%Y-%m-%d", localtime); |
86 |
} |
87 |
|
88 |
sub RUNNING_IN_HELL () { $^O eq 'MSWin32' } |
89 |
|
90 |
|
91 |
sub get_executable { |
92 |
my $cmd = shift; |
93 |
# FIXME: detect type of program and run with proper application/interpreter |
94 |
# using IPC::Run we have to dispatch this on our own! *no* os-interaction or interpolation here!? |
95 |
# => better use absolute path-names only?! |
96 |
my $application = ''; |
97 |
if ($cmd =~ m/\w+\.pl\s*.*/) { |
98 |
$application = get_interpreter_wrapper($cmd, 'perl'); |
99 |
#$cmd = "$application $cmd" if $application; |
100 |
$application .= ' '; |
101 |
|
102 |
} else { |
103 |
$application = './'; |
104 |
} |
105 |
return $application; |
106 |
} |
107 |
|
108 |
sub get_interpreter_wrapper { |
109 |
my $cmd = shift; |
110 |
my $language = shift; |
111 |
$language ||= ''; |
112 |
|
113 |
my $wrapper = ''; |
114 |
|
115 |
if ($language eq 'perl') { |
116 |
|
117 |
if (RUNNING_IN_HELL()) { |
118 |
# Required to adapt to IPC::Run on win32. |
119 |
$wrapper = 'cmd.exe /C perl'; |
120 |
} else { |
121 |
# NEW 2003-06-23 - needed if used with IPC::Session (at Linux) |
122 |
# whats about Win32? |
123 |
$wrapper = 'perl'; |
124 |
} |
125 |
|
126 |
} else { |
127 |
die("No wrapper for language '$language'."); |
128 |
} |
129 |
|
130 |
return $wrapper; |
131 |
} |
132 |
|
133 |
|
134 |
sub run_cmd { |
135 |
my $cmd = shift; |
136 |
my $caption = shift; |
137 |
my $options = shift; |
138 |
|
139 |
#print Dumper($options); |
140 |
|
141 |
# report - header |
142 |
my $sep = "-" x 60; |
143 |
print STDERR $sep, "\n"; |
144 |
print STDERR " ", $cmd; |
145 |
print STDERR " - ", $caption if $caption; |
146 |
print STDERR "\n", $sep, "\n"; |
147 |
|
148 |
# strip name of executable from full command string |
149 |
$cmd =~ m/(.+?)\s/; |
150 |
my $executable = $1; |
151 |
|
152 |
=pod |
153 |
# for unix: check if executable is in local directory, if so - prefix with './' |
154 |
if (!RUNNING_IN_HELL()) { |
155 |
#if ($cmd !~ m/\//) { |
156 |
if (-e $executable) { |
157 |
} |
158 |
} |
159 |
=cut |
160 |
|
161 |
# new of 2003-05-07: basedir option to be prepended to command string |
162 |
my $basedir = $options->{BASEDIR}; |
163 |
my $use_path = $options->{USE_PATH}; |
164 |
|
165 |
# for all systems: check existance of files - use basedir if given, try current directory otherwise |
166 |
if ($basedir) { |
167 |
-e "$basedir/$executable" or die("$basedir/$executable does not exist."); |
168 |
$basedir .= '/'; |
169 |
} elsif ($use_path) { |
170 |
$basedir = ""; |
171 |
} else { |
172 |
-e $executable or die("$executable does not exist."); |
173 |
#$basedir = "."; |
174 |
#$basedir .= './'; |
175 |
$basedir = ""; |
176 |
} |
177 |
$cmd = "$basedir$cmd"; |
178 |
|
179 |
# V1 - backticks or qq{} |
180 |
#`$cmd`; |
181 |
#qq{$cmd}; |
182 |
|
183 |
# V2 - via 'system' |
184 |
#system($cmd); |
185 |
|
186 |
if (not $use_path) { |
187 |
my $application = get_executable($cmd); |
188 |
$cmd = "$application$cmd" if $application; |
189 |
} |
190 |
|
191 |
# V3 - using IPC (optional) |
192 |
if ($options->{async}) { |
193 |
|
194 |
#run \@cmd, \$in, \$out, \$err, timeout( 10 ) or die "cat: $?"; |
195 |
my @cmd = split(' ', $cmd); |
196 |
|
197 |
|
198 |
# V3.1 - using IPC::Run |
199 |
# |
200 |
# tests: |
201 |
|
202 |
if (RUNNING_IN_HELL()) { |
203 |
|
204 |
#my $in; my $out; my $err; |
205 |
print STDERR "run_cmd: IPC::Run: $cmd", "\n"; |
206 |
|
207 |
# no success! |
208 |
#start \@cmd, timeout(0) or croak("run_cmd: IPC::Run could not start '$cmd'."); |
209 |
# |
210 |
# success on Win32, but seems broken at 'timeout' on linux: |
211 |
run(\@cmd, timeout(4)) or croak("run_cmd: IPC::Run could not start '$cmd'."); |
212 |
|
213 |
# other tests ;) |
214 |
#$IPC::Run::Timer::timeout = 2000; |
215 |
#start $cmd or die("IPC::Run could not start '$cmd'."); |
216 |
|
217 |
} else { |
218 |
|
219 |
print STDERR "run_cmd: IPC::Session: $cmd", "\n"; |
220 |
|
221 |
# V3.2 - using IPC::Session |
222 |
# success on Linux AND Win32 ?? |
223 |
# |
224 |
# set timeout: |
225 |
# (don't really know why we needs 2 secconds |
226 |
# to wait for init of process !?!) |
227 |
my $session_timeout = 3; |
228 |
# set session name (default: cmd as string): |
229 |
my $session_name = $cmd; |
230 |
# create session: |
231 |
my $session = IPC::Session->new($session_name, $session_timeout); |
232 |
|
233 |
# send 'cmd' to session - not required since complete command is sent via constructor above |
234 |
$session->send(\@cmd); |
235 |
|
236 |
#print $session->stdout(), "\n"; |
237 |
|
238 |
# optional switch case: |
239 |
#for ($session->stdout()) { |
240 |
#} |
241 |
# optional get error: |
242 |
#my $err = session->stderr(); |
243 |
} |
244 |
|
245 |
} else { |
246 |
print STDERR "run_cmd: system('$cmd').", "\n"; |
247 |
system($cmd); |
248 |
} |
249 |
|
250 |
print STDERR "run_cmd: ready.", "\n"; |
251 |
|
252 |
} |
253 |
|
254 |
sub run_cmds { |
255 |
my $options = {}; |
256 |
if (ref $_[$#_] eq 'HASH') { |
257 |
#print "YAI", "\n"; |
258 |
$options = pop @_; |
259 |
} |
260 |
foreach (@_) { |
261 |
run_cmd($_, '', $options); |
262 |
} |
263 |
} |
264 |
|
265 |
sub get_chomped { |
266 |
my $str = shift; |
267 |
chomp($str); |
268 |
return $str; |
269 |
} |
270 |
|
271 |
sub bool2status { |
272 |
my $bool = shift; |
273 |
return ($bool ? 'ok' : 'failed'); |
274 |
} |
275 |
|
276 |
# create global unique identifers using Data::UUID |
277 |
# if updating this code, please also modify Tangram::Storage::make_guid |
278 |
sub make_guid |
279 |
{ |
280 |
my $self = shift; |
281 |
|
282 |
my $guid; |
283 |
|
284 |
# try to use Data::UUID first ... |
285 |
eval("use Data::UUID;"); |
286 |
if (!$@) { |
287 |
my $ug = Data::UUID->new(); |
288 |
$guid = $ug->create_str(); |
289 |
|
290 |
# ... if this fails, try to fallback to Data::UUID::PurePerl instead ... |
291 |
} else { |
292 |
eval("use Data::UUID::PurePerl;"); |
293 |
if (!$@) { |
294 |
$guid = Data::UUID::PurePerl::generate_id(); |
295 |
} else { |
296 |
croak "couldn't create globally unique identifier"; |
297 |
} |
298 |
} |
299 |
|
300 |
return $guid; |
301 |
} |
302 |
|
303 |
1; |
304 |
__END__ |