beginexp_xml.php3 12.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<?php
#
# EMULAB-COPYRIGHT
# Copyright (c) 2000-2003 University of Utah and the Flux Group.
# All rights reserved.
#
include("defs.php3");

#
# No PAGEHEADER since we spit back plain XML output.
#
$errors    = array();

$session_interactive  = 0;
$session_errorhandler = 'handle_error';

#
# Capture script errors and report back to user.
#
function handle_error($message, $death)
{
    XMLSTATUS("weberror", $message);
    if ($death)
	exit(1);
}

#
# Form Errors. 
#
function XMLERROR()
{
    XMLSTATUS("xmlerror", "Invalid form arugments");
}

#
# Helper function to send back errors. This needs some work!
#
function XMLSTATUS($status, $message)
{
    global $errors;

    $results = array();
    $results[status]  = $status;
    $results[message] = $message;
    $results[errors]  = $errors;
    $xmlcode = xmlrpc_encode_request("dummy", $results);

    echo "$xmlcode\n";
    exit(1);
}

#
# Only known and logged in users can begin experiments. Must perform this
# check inline so we can report back status instead of simply dying. I
# need to investigate how to make this cleaner, perhaps with a global variable
# that changes how TBERROR and USERERROR operate. Needs more thought.
#
$uid    = GETLOGIN();
$status = CHECKLOGIN($uid);
if (($status & CHECKLOGIN_NOTLOGGEDIN) != CHECKLOGIN_NOTLOGGEDIN) {
    EXPERROR("autherror", "Not logged in");
}

# Need this below;
$idleswaptimeout = TBGetSiteVar("idle/threshold");

#
# We must get XML code.
# 
if (!isset($xmlcode)) {
    PAGEARGERROR();
}

# Convert the xml into PHP datatypes; an array of arguments. We ignore the
# the method for now. 
$foo = xmlrpc_decode_request($xmlcode, $meth);
77
78
79
80
if (!isset($foo)) {
    TBERROR("Could not decode XML request!\n\n" .
	    urldecode($xmlcode) . "\n", 1);
}
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272

# First argument is the formfields array. 
$formfields = $foo[0];

#
# Validate the arguments.
#
# Some local variables.
$nsfilelocale    = 0;
$thensfile       = 0;
$deletensfile    = 0;
$nonsfile        = 0;

#
# Project:
#
if (!isset($formfields[exp_pid]) || $formfields[exp_pid] == "") {
    $errors["Project"] = "Not Selected";
}
elseif (!TBvalid_pid($formfields[exp_pid])) {
    $errors["Project"] = TBFieldErrorString();
    # Immediate error since we use this below.
    XMLERROR();
}
elseif (!TBValidProject($formfields[exp_pid])) {
    $errors["Project"] = "No such project";
}

#
# Group: If none specified, then use default group (see below).
#
if (isset($formfields[exp_gid]) && $formfields[exp_gid] != "") {
    if (!TBvalid_gid($formfields[exp_gid])) {
	$errors["Group"] = TBFieldErrorString();
    }
    elseif (!TBValidGroup($formfields[exp_pid], $formfields[exp_gid])) {
	$errors["Group"] = "Group '$exp_gid' is not in project '$exp_pid'";
    }
}

#
# EID:
#
if (!isset($formfields[exp_id]) || $formfields[exp_id] == "") {
    $errors["Experiment Name"] = "Missing Field";
}
elseif (!TBvalid_eid($formfields[exp_id])) {
    $errors["Experiment Name"] = TBFieldErrorString();
}
elseif (TBValidExperiment($formfields[exp_pid], $formfields[exp_id])) {
    $errors["Experiment Name"] = "Already in use";
}

#
# Description:
# 
if (!isset($formfields[exp_description]) ||
    $formfields[exp_description] == "") {
    $errors["Description"] = "Missing Field";
}
elseif (!TBvalid_description($formfields[exp_description])) {
    $errors["Description"] = TBFieldErrorString();
}

#
# NS File. There is a bunch of stuff here for Netbuild, which uses the
# beginexp form as a backend. Switch to XML interface someday ...
#
if (isset($formfields[nsref])) {
    if ($formfields[nsref] == "" ||
	!ereg("^[0-9]+$", $formfields[nsref] == "")) {
	$errors["NS File Reference"] = TBFieldErrorString();
    }
}
if (isset($formfields[guid])) {
    if ($formfields[guid] == "" ||
	!ereg("^[0-9]+$", $formfields[guid] == "")) {
	$errors["NS File UID"] = TBFieldErrorString();
    }
    $nsfilelocale = "nsref";
}
if (isset($formfields[exp_localnsfile]) &&
	$formfields[exp_localnsfile] != "") {
    if (!preg_match("/^([-\@\w\.\/]+)$/", $formfields[exp_localnsfile])) {
	$errors["Server NS File"] = "Pathname includes illegal characters";
    }
    elseif (! ereg("^$TBPROJ_DIR/.*",  $formfields[exp_localnsfile]) &&
	    ! ereg("^$TBUSER_DIR/.*",  $formfields[exp_localnsfile]) &&
	    ! ereg("^$TBGROUP_DIR/.*", $formfields[exp_localnsfile])) {
	$errors["Server NS File"] = "Must reside in either ".
	    "$TBUSER_DIR/, $TBPROJ_DIR/, or $TBGROUP_DIR/";
    }
    $nsfilelocale = "local";
}
elseif (isset($formfields[exp_nsfile_contents]) &&
	$formfields[exp_nsfile_contents] != "") {
    #
    # The NS file is encoded inline. We will write it to a tempfile below
    # once all other checks passed.
    #
    $nsfilelocale = "inline";
}
else {
    #
    # I am going to allow shell experiments to be created (No NS file),
    # but only by admin types.
    #
    if (! ISADMIN($uid)) {
	$errors["NS File"] = "You must provide an NS file";
    }
}

#
# Swappable
# Any of these which are not "1" become "0".
#
if (!isset($formfields[exp_swappable]) ||
    strcmp($formfields[exp_swappable], "1")) {
    $formfields[exp_swappable] = 0;

    if (!isset($formfields[exp_noswap_reason]) ||
        !strcmp($formfields[exp_noswap_reason], "")) {

        if (! ISADMIN($uid)) {
	    $errors["Not Swappable"] = "No justification provided";
        }
	else {
	    $formfields[exp_noswap_reason] = "ADMIN";
        }
    }
    elseif (!TBvalid_description($formfields[exp_noswap_reason])) {
	$errors["Not Swappable"] = TBFieldErrorString();
    }
}
else {
    $formfields[exp_swappable]     = 1;
    $formfields[exp_noswap_reason] = "";
}

if (!isset($formfields[exp_idleswap]) ||
    strcmp($formfields[exp_idleswap], "1")) {
    $formfields[exp_idleswap] = 0;

    if (!isset($formfields[exp_noidleswap_reason]) ||
	!strcmp($formfields[exp_noidleswap_reason], "")) {
	if (! ISADMIN($uid)) {
	    $errors["Not Idle-Swappable"] = "No justification provided";
	}
	else {
	    $formfields[exp_noidleswap_reason] = "ADMIN";
	}
    }
    elseif (!TBvalid_description($formfields[exp_noidleswap_reason])) {
	$errors["Not Idle-Swappable"] = TBFieldErrorString();
    }
}
else {
    $formfields[exp_idleswap]          = 1;
    $formfields[exp_noidleswap_reason] = "";
}

# Proper idleswap timeout must be provided.
if (!isset($formfields[exp_idleswap_timeout]) ||
    !preg_match("/^[\d]+$/", $formfields[exp_idleswap_timeout]) ||
    ($formfields[exp_idleswap_timeout] + 0) <= 0 ||
    ($formfields[exp_idleswap_timeout] + 0) > $idleswaptimeout) {
    $errors["Idleswap"] = "Invalid time provided - ".
	"must be non-zero and less than $idleswaptimeout";
}


if (!isset($formfields[exp_autoswap]) ||
    strcmp($formfields[exp_autoswap], "1")) {
    $formfields[exp_autoswap] = 0;
}
else {
    $formfields[exp_autoswap] = 1;
    
    if (!isset($formfields[exp_autoswap_timeout]) ||
	!preg_match("/[\d]+/", $formfields[exp_idleswap_timeout]) ||
	($formfields[exp_autoswap_timeout] + 0) <= 0) {
	$errors["Max. Duration"] = "No or invalid time provided";
    }
}

#
# If any errors, stop now. pid/eid/gid must be okay before continuing.
#
if (count($errors)) {
    XMLERROR();
}

273
$exp_desc    = escapeshellarg($formfields[exp_description]);
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
$exp_pid     = $formfields[exp_pid];
$exp_gid     = ((isset($formfields[exp_gid]) && $formfields[exp_gid] != "") ?
		$formfields[exp_gid] : $exp_pid);
$exp_id      = $formfields[exp_id];

#
# Verify permissions. We do this here since pid/eid/gid could be bogus above.
#
if (! TBProjAccessCheck($uid, $exp_pid, $exp_gid, $TB_PROJECT_CREATEEXPT)) {
    $errors["Project/Group"] = "Not enough permission to create experiment";
    XMLERROR();
}

#
# Figure out the NS file to give to the script. Eventually we will allow
# it to come inline as an XML argument.
# 
if ($nsfilelocale == "local") {
    #
    # No way to tell from here if this file actually exists, since
    # the web server runs as user nobody. The startexp script checks
    # for the file so the user will get immediate feedback if the filename
    # is bogus.
    #
    $thensfile = $formfields[exp_localnsfile];
}
elseif ($nsfilelocale == "nsref") {
    $nsref = $formfields[nsref];
    
    if (isset($formfields[guid])) {
	$guid      = $formfields[guid];
	$thensfile = "/tmp/$guid-$nsref.nsfile";
    }
    else {
	$thensfile = "/tmp/$uid-$nsref.nsfile";
    }
    $deletensfile = 1;
}
elseif ($nsfilelocale == "inline") {
    #
    # The NS file is encoded in the URL. Must create a temp file
    # to hold it, and pass through to the backend.
    #
    # XXX Hard to believe, but there is no equiv of mkstemp in php3.
    #
    list($usec, $sec) = explode(' ', microtime());
    srand((float) $sec + ((float) $usec * 100000));
    $foo = rand();
    
    $thensfile    = "/tmp/$uid-$foo.nsfile";
    $deletensfile = 1;

    if (! ($fp = fopen($thensfile, "w"))) {
	TBERROR("Could not create temporary file $nsfile", 1);
    }
    fwrite($fp, urldecode($formfields[exp_nsfile_contents]));
    fclose($fp);
    chmod($thensfile, 0666);
}
else {
    $nonsfile = 1;
}

#
# Convert other arguments to script parameters.
#
$exp_swappable = "";

if ($formfields[exp_swappable] == "1") {
    $exp_swappable .= " -s";
}

if ($formfields[exp_autoswap] == "1") {
    $exp_swappable .= " -a " . (60 * $formfields[exp_autoswap_timeout]);
}

if ($formfields[exp_idleswap] == "1") {
    $exp_swappable .= " -l " . (60 * $formfields[exp_idleswap_timeout]);
}

#
# All experiments are low priority for now.
#
$exp_priority  = "-n low";
$exp_batched   = 0;
$exp_preload   = 0;
$batcharg      = "-i";

if (isset($formfields[exp_batched]) &&
    strcmp($formfields[exp_batched], "Yep") == 0) {
    $exp_batched   = 1;
    $batcharg      = "";
}
if (isset($formfields[exp_preload]) &&
    strcmp($formfields[exp_preload], "Yep") == 0) {
    $exp_preload   = 1;
    $batcharg     .= " -f";
}

#
# We need the email address for messages below.
#
TBUserInfo($uid, $user_name, $user_email);

# Expiration is hardwired for now.
$exp_expires = date("Y:m:d", time() + (86400 * 120));

#
# Grab the unix GID for running scripts.
#
TBGroupUnixInfo($exp_pid, $exp_gid, $unix_gid, $unix_name);

#
# Run the backend script.
#
# Avoid SIGPROF in child.
#
set_time_limit(0);

$retval = SUEXEC($uid, $unix_gid,
394
		 "webbatchexp $batcharg -x \"$exp_expires\" -E $exp_desc ".
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
		 "$exp_priority $exp_swappable ".
		 "-p $exp_pid -g $exp_gid -e $exp_id ".
		 ($nonsfile ? "" : "$thensfile"),
		 SUEXEC_ACTION_IGNORE);

if ($deletensfile) {
    unlink($thensfile);
}

#
# Fatal Error. Report to the user, even though there is not much he can
# do with the error. Also reports to tbops.
# 
if ($retval < 0) {
    SUEXECERROR(SUEXEC_ACTION_DIE);
    #
    # Never returns ...
    #
    die("");
}

# User error. Tell user and exit.
if ($retval) {
    XMLSTATUS("weberror", $suexec_output);
    exit(1);
}

# add reasons to db, since we don't want to pass these on the command line.

if ($formfields[exp_noswap_reason]) {
    DBQueryFatal("UPDATE experiments " .
		 "SET noswap_reason='" .
                 addslashes($formfields[exp_noswap_reason]).
                 "' ".
		 "WHERE eid='$exp_id' and pid='$exp_pid'");
}

if ($formfields[exp_noidleswap_reason]) {
    DBQueryFatal("UPDATE experiments " .
		 "SET noidleswap_reason='" .
                 addslashes($formfields[exp_noidleswap_reason]).
                 "' ".
		 "WHERE eid='$exp_id' and pid='$exp_pid'");
}

# Send back a useful message. This needs more thought.
$message = "";
if ($nonsfile) {
    $message =
         "Since you did not provide an NS script, no nodes have been
          allocated. You will not be able to modify or swap this experiment,
          nor do most other neat things you can do with a real experiment.";
}
elseif ($exp_preload) {
    $message = 
         "Since you are only pre-loading the experiment, this will typically
          take less than one minute. If you do not receive email notification
          within a reasonable amount of time, please contact $TBMAILADDR.";
}
elseif ($exp_batched) {
    $message = 
         "Batch Mode experiments will be run when enough resources become
          available. This might happen immediately, or it may take hours
	  or days. You will be notified via email when the experiment has
          been run. If you do not receive email notification within a
          reasonable amount of time, please contact $TBMAILADDR.";
}
else {
    $message = 
         "You will be notified via email when the experiment has been fully
	  configured and you are able to proceed. This typically takes less
          than 10 minutes, depending on the number of nodes you have requested.
          If you do not receive email notification within a reasonable amount
          of time, please contact $TBMAILADDR.";
}
XMLSTATUS("success", $message);
?>