dbdefs.php3.in 33 KB
Newer Older
1
2
3
4
<?php
#
# Database Constants
#
5
$TBDBNAME       = "@TBDBNAME@";
6
$TBOPSPID	= "emulab-ops";
7
8
9

$TBDB_UIDLEN    = 8;
$TBDB_PIDLEN    = 12;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
10
11
$TBDB_GIDLEN	= 12;
$TBDB_UNIXGLEN	= 16;
12
$TBDB_NODEIDLEN = 10;
13
14
15
16
17
18
19
20
21

#
# Current policy is to prefix the EID with the PID. Make sure it is not
# too long for the database. PID is 12, and the max is 32, so the user
# cannot have provided an EID more than 19, since other parts of the system
# may concatenate them together with a hyphen.
#
$TBDB_EIDLEN    = 19;

22
23
$TBDB_OSID_OSIDLEN         = 35;
$TBDB_OSID_OSNAMELEN       = 20;
24
$TBDB_OSID_VERSLEN         = 12;
25
26
$TBDB_IMAGEID_IMAGEIDLEN   = 45;
$TBDB_IMAGEID_IMAGENAMELEN = 30;
27

28
29
30
#
# User status field.
#
31
32
33
34
35
define("TBDB_USERSTATUS_ACTIVE",	"active");
define("TBDB_USERSTATUS_NEWUSER",	"newuser");
define("TBDB_USERSTATUS_UNAPPROVED",	"unapproved");
define("TBDB_USERSTATUS_UNVERIFIED",	"unverified");
define("TBDB_USERSTATUS_FROZEN",	"frozen");
36

Leigh B. Stoller's avatar
Leigh B. Stoller committed
37
38
39
40
41
42
43
44
45
46
47
#
# Trust. Define the trust level as an increasing value. Then define a
# function to return whether the given trust is high enough.
#
$TBDB_TRUST_NONE		= 0;
$TBDB_TRUST_USER		= 1;
$TBDB_TRUST_LOCALROOT		= 2;
$TBDB_TRUST_GROUPROOT		= 3;
$TBDB_TRUST_PROJROOT		= 4;
$TBDB_TRUST_ADMIN		= 5;

48
49
50
51
52
53
54
55
56
#
# Text strings in the DB for above.
# 
define("TBDB_TRUSTSTRING_NONE",		"none");
define("TBDB_TRUSTSTRING_USER",		"user");
define("TBDB_TRUSTSTRING_LOCALROOT",	"local_root");
define("TBDB_TRUSTSTRING_GROUPROOT",	"group_root");
define("TBDB_TRUSTSTRING_PROJROOT",	"project_root");

Leigh B. Stoller's avatar
Leigh B. Stoller committed
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
#
# These are the permission types. Different operations for the varying
# types of things we need to control access to.
#
# Things you can do to a node.
$TB_NODEACCESS_READINFO		= 1;
$TB_NODEACCESS_MODIFYINFO	= 2;
$TB_NODEACCESS_LOADIMAGE	= 3;
$TB_NODEACCESS_REBOOT		= 4;
$TB_NODEACCESS_POWERCYCLE	= 5;
$TB_NODEACCESS_MIN		= $TB_NODEACCESS_READINFO;
$TB_NODEACCESS_MAX		= $TB_NODEACCESS_POWERCYCLE;

# User Info (modinfo web page, etc).
$TB_USERINFO_READINFO		= 1;
$TB_USERINFO_MODIFYINFO		= 2;
$TB_USERINFO_MIN		= $TB_USERINFO_READINFO;
$TB_USERINFO_MAX		= $TB_USERINFO_MODIFYINFO;

# Experiments (also batch experiments).
$TB_EXPT_READINFO		= 1;
$TB_EXPT_MODIFY			= 2;	# Allocate/dealloc nodes
$TB_EXPT_DESTROY		= 3;
80
$TB_EXPT_UPDATEACCOUNTS		= 4;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
81
$TB_EXPT_MIN			= $TB_EXPT_READINFO;
82
$TB_EXPT_MAX			= $TB_EXPT_UPDATEACCOUNTS;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
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

# Projects.
$TB_PROJECT_READINFO		= 1;
$TB_PROJECT_MAKEGROUP		= 2;
$TB_PROJECT_EDITGROUP		= 3;
$TB_PROJECT_DELGROUP		= 4;
$TB_PROJECT_LEADGROUP		= 5;
$TB_PROJECT_ADDUSER		= 6;
$TB_PROJECT_DELUSER             = 7;
$TB_PROJECT_MAKEOSID		= 8;
$TB_PROJECT_DELOSID		= 9;
$TB_PROJECT_MAKEIMAGEID		= 10;
$TB_PROJECT_DELIMAGEID		= 11;
$TB_PROJECT_CREATEEXPT		= 12;
$TB_PROJECT_MIN			= $TB_PROJECT_READINFO;
$TB_PROJECT_MAX			= $TB_PROJECT_CREATEEXPT;

# OSIDs 
$TB_OSID_READINFO		= 1;
$TB_OSID_MODIFYINFO		= 2;
$TB_OSID_DESTROY		= 3;
$TB_OSID_MIN			= $TB_OSID_READINFO;
$TB_OSID_MAX			= $TB_OSID_DESTROY;

# ImageIDs
$TB_IMAGEID_READINFO		= 1;
$TB_IMAGEID_MODIFYINFO		= 2;
$TB_IMAGEID_ACCESS		= 3;
$TB_IMAGEID_DESTROY		= 4;
$TB_IMAGEID_MIN			= $TB_IMAGEID_READINFO;
$TB_IMAGEID_MAX			= $TB_IMAGEID_DESTROY;

115
# Experiment states (that matter to us).
116
117
$TB_EXPTSTATE_NEW		= "new"; 
$TB_EXPTSTATE_PRERUN		= "prerunning"; 
118
$TB_EXPTSTATE_SWAPPING		= "swapping";
119
$TB_EXPTSTATE_SWAPPED		= "swapped";
120
$TB_EXPTSTATE_ACTIVATING	= "activating";
121
122
$TB_EXPTSTATE_ACTIVE		= "active";

Leigh B. Stoller's avatar
Leigh B. Stoller committed
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
#
# Convert a trust string to the above numeric values.
#
function TBTrustConvert($trust_string)
{
    global $TBDB_TRUST_NONE;
    global $TBDB_TRUST_USER;
    global $TBDB_TRUST_LOCALROOT;
    global $TBDB_TRUST_GROUPROOT;
    global $TBDB_TRUST_PROJROOT;
    global $TBDB_TRUST_ADMIN;
    $trust_value = 0;

    #
    # Convert string to value. Perhaps the DB should have done it this way?
    # 
    if (strcmp($trust_string, "none") == 0) {
	    $trust_value = $TBDB_TRUST_NONE;
    }
    elseif (strcmp($trust_string, "user") == 0) {
	    $trust_value = $TBDB_TRUST_USER;
    }
    elseif (strcmp($trust_string, "local_root") == 0) {
	    $trust_value = $TBDB_TRUST_LOCALROOT;
    }
    elseif (strcmp($trust_string, "group_root") == 0) {
	    $trust_value = $TBDB_TRUST_GROUPROOT;
    }
    elseif (strcmp($trust_string, "project_root") == 0) {
	    $trust_value = $TBDB_TRUST_PROJROOT;
    }
    elseif (strcmp($trust_string, "admin") == 0) {
	    $trust_value = $TBDB_TRUST_ADMIN;
    }
    else {
	    TBERROR("Invalid trust value $trust_string!", 1);
    }

    return $trust_value;
}

#
# Return true if the given trust string is >= to the minimum required.
# The trust value can be either numeric or a string; if a string its
# first converted to the numeric equiv.
#
function TBMinTrust($trust_value, $minimum)
{
    global $TBDB_TRUST_NONE;
    global $TBDB_TRUST_ADMIN;

    if ($minimum < $TBDB_TRUST_NONE || $minimum > $TBDB_TRUST_ADMIN) {
	    TBERROR("Invalid minimum trust $minimum!", 1);
    }

    #
    # Sleazy?
    #
    if (gettype($trust_value) == "string") {
	$trust_value = TBTrustConvert($trust_value);
    }
    
    return $trust_value >= $minimum;
}

#
# Determine the trust level for a uid/pid/gid. That is, each uid will have
# a different trust level depending on the project/group in question.
# Return that trust level as one of the numeric values above. 
# 
function TBGrpTrust($uid, $pid, $gid)
{
    global $TBDB_TRUST_NONE;

    #
    # No group, then use the default group.
    #
    if (! $gid) {
	$gid = $pid;
    }

    $query_result =
	DBQueryFatal("select trust from group_membership ".
		     "where uid='$uid' and pid='$pid' and gid='$gid'");

    #
    # No membership is the same as no trust. True? Maybe an error instead?
    # 
    if (mysql_num_rows($query_result) == 0) {
	return $TBDB_TRUST_NONE;
    }
    $row = mysql_fetch_array($query_result);
    $trust_string = $row[trust];

    return TBTrustConvert($trust_string);
}

#
# Determine the project trust level for a uid/pid. This is the trust level
# for the default group in the project.
# 
function TBProjTrust($uid, $pid)
{
    return TBGrpTrust($uid, $pid, $pid);
}

#
# Project permission checks. The group id (gid) can be zero, in which case
# the pid is used (ie: a default group check is made).
#
# Usage: TBProjAccessCheck($uid, $pid, $gid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
# 
function TBProjAccessCheck($uid, $pid, $gid, $access_type)
{
    global $TB_PROJECT_READINFO;
    global $TB_PROJECT_MAKEGROUP;
    global $TB_PROJECT_EDITGROUP;
    global $TB_PROJECT_DELGROUP;
    global $TB_PROJECT_LEADGROUP;
    global $TB_PROJECT_ADDUSER;
    global $TB_PROJECT_DELUSER;
    global $TB_PROJECT_MAKEOSID;
    global $TB_PROJECT_DELOSID;
    global $TB_PROJECT_MAKEIMAGEID;
    global $TB_PROJECT_DELIMAGEID;
    global $TB_PROJECT_CREATEEXPT;
    global $TB_PROJECT_MIN;
    global $TB_PROJECT_MAX;
    global $TBDB_TRUST_USER;
    global $TBDB_TRUST_LOCALROOT;
    global $TBDB_TRUST_GROUPROOT;
    global $TBDB_TRUST_PROJROOT;
    $mintrust;

    if ($access_type < $TB_PROJECT_MIN ||
	$access_type > $TB_PROJECT_MAX) {
	TBERROR("Invalid access type: $access_type!", 1);
    }

    #
    # Admins do whatever they want!
    # 
    if (ISADMIN($uid)) {
	return 1;
    }

    #
    # No group, then use the default group.
    #
    if (! $gid) {
	$gid = $pid;
    }

    if ($access_type == $TB_PROJECT_READINFO) {
	$mintrust = $TBDB_TRUST_USER;
    }
    elseif ($access_type == $TB_PROJECT_MAKEGROUP ||
	    $access_type == $TB_PROJECT_DELGROUP) {
	$mintrust = $TBDB_TRUST_PROJROOT;
    }
    elseif ($access_type == $TB_PROJECT_LEADGROUP) {
	#
	# Must be at least local root to lead a group.
	# 
	$mintrust = $TBDB_TRUST_LOCALROOT;
    }
    elseif ($access_type == $TB_PROJECT_MAKEOSID ||
	    $access_type == $TB_PROJECT_MAKEIMAGEID ||
	    $access_type == $TB_PROJECT_CREATEEXPT) {
	$mintrust = $TBDB_TRUST_LOCALROOT;
    }
296
297
298
299
300
301
302
    elseif ($access_type == $TB_PROJECT_ADDUSER) {
	#
	# Allow delegation of approving users to group_root in main group.
	#
	$mintrust = $TBDB_TRUST_GROUPROOT;
    }
    elseif ($access_type == $TB_PROJECT_EDITGROUP) {
303
	if (strcmp($gid, $pid) == 0) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
304
305
306
307
308
309
	    $mintrust = $TBDB_TRUST_PROJROOT;
	}
	else {
	    $mintrust = $TBDB_TRUST_GROUPROOT;
	}
    }
310
311
312
    elseif ($access_type == $TB_PROJECT_DELUSER) {
	$mintrust = $TBDB_TRUST_PROJROOT;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
313
314
315
316
317
318
319
    else {
	TBERROR("Unexpected access type: $access_type!", 1);
    }

    return TBMinTrust(TBGrpTrust($uid, $pid, $gid), $mintrust);
}

320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
# Usage: TBExptGroup($pid, $eid, &$gid)
#	 returns 0 if expt doesn't exist.
#        returns 1 if expt exists.
function TBExptGroup($pid, $eid, &$gid)
{
  $query_result =
    DBQueryFatal("SELECT gid FROM experiments WHERE ".
		 "eid='$eid' and pid='$pid'");
  if (mysql_num_rows($query_result) == 0) {
    return 0;
  }
  $row  = mysql_fetch_array($query_result);
  $gid  = $row[gid];
  return 1;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
336
337
338
339
340
341
342
343
344
345
346
347
#
# Experiment permission checks.
#
# Usage: TBExptAccessCheck($uid, $pid, $eid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
# 
function TBExptAccessCheck($uid, $pid, $eid, $access_type)
{
    global $TB_EXPT_READINFO;
    global $TB_EXPT_MODIFY;
    global $TB_EXPT_DESTROY;
348
    global $TB_EXPT_UPDATEACCOUNTS;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
    global $TB_EXPT_MIN;
    global $TB_EXPT_MAX;
    global $TBDB_TRUST_USER;
    global $TBDB_TRUST_LOCALROOT;
    global $TBDB_TRUST_GROUPROOT;
    global $TBDB_TRUST_PROJROOT;
    $mintrust;

    if ($access_type < $TB_EXPT_MIN ||
	$access_type > $TB_EXPT_MAX) {
	TBERROR("Invalid access type: $access_type!", 1);
    }

    #
    # Admins do whatever they want!
    # 
    if (ISADMIN($uid)) {
	return 1;
    }

    $query_result =
370
	DBQueryFatal("SELECT gid,expt_head_uid FROM experiments WHERE ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
371
372
373
374
375
		     "eid='$eid' and pid='$pid'");
    
    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
376
377
378
    $row  = mysql_fetch_array($query_result);
    $gid  = $row[gid];
    $head = $row[expt_head_uid];
Leigh B. Stoller's avatar
Leigh B. Stoller committed
379
380
381
382

    if ($access_type == $TB_EXPT_READINFO) {
	$mintrust = $TBDB_TRUST_USER;
    }
383
384
385
386
387
388
    elseif ($access_type == $TB_EXPT_UPDATEACCOUNTS) {
	if (strcmp($uid, $head))
	    $mintrust = $TBDB_TRUST_GROUPROOT;
	else
	    return 1;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
389
390
391
392
393
394
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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
    else {
	$mintrust = $TBDB_TRUST_LOCALROOT;
    }

    return TBMinTrust(TBGrpTrust($uid, $pid, $gid), $mintrust);
}

#
# Determine if uid can access a node (read or modify).
#
# Usage: TBNodeAccessCheck($uid, $node_id, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
# 
function TBNodeAccessCheck($uid, $node_id, $access_type)
{
    global $TB_NODEACCESS_READINFO;
    global $TB_NODEACCESS_MODIFYINFO;
    global $TB_NODEACCESS_LOADIMAGE;
    global $TB_NODEACCESS_REBOOT;
    global $TB_NODEACCESS_POWERCYCLE;
    global $TB_NODEACCESS_MIN;
    global $TB_NODEACCESS_MAX;
    global $TBDB_TRUST_USER;
    global $TBDB_TRUST_LOCALROOT;
    $mintrust;

    if ($access_type < $TB_NODEACCESS_MIN ||
	$access_type > $TB_NODEACCESS_MAX) {
	TBERROR("Invalid access type: $access_type!", 1);
    }

    $query_result =
	DBQueryFatal("select node_id,trust from reserved as n ".
		     "left join experiments as e on ".
		     "     e.pid=n.pid and e.eid=n.eid ".
		     "left join group_membership as g on ".
		     "     g.pid=e.pid and g.gid=e.gid ".
		     "where g.uid='$uid' and n.node_id='$node_id'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $foorow = mysql_fetch_array($query_result);
    $trust  = $foorow[trust];

    if ($access_type == $TB_NODEACCESS_READINFO) {
	$mintrust = $TBDB_TRUST_USER;
    }
    else {
	$mintrust = $TBDB_TRUST_LOCALROOT;
    }

    return TBMinTrust($trust, $mintrust);
}

#
# Determine if uid can access a another user record (read or modify).
#
# Usage: TBUserInfoAccessCheck($uid, $target_uid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
# 
function TBUserInfoAccessCheck($uid, $target_uid, $access_type)
{
    global $TB_USERINFO_READINFO;
    global $TB_USERINFO_MODIFYINFO;
    global $TB_USERINFO_MIN;
    global $TB_USERINFO_MAX;

    if ($access_type < $TB_USERINFO_MIN || $access_type > $TB_USERINFO_MAX) {
	TBERROR("Invalid access type $access_type!", 1);
    }

    if (strcmp($uid, $target_uid) == 0) {
	return 1;
    }

    #
    # This join will allow the operation if the current user is in the same
    # group (any group) as the target user, but with root permissions.
    # 
    $query_result =
	DBQueryFatal("select g.trust from group_membership as g ".
		     "left join group_membership as authed on ".
		     "     g.pid=authed.pid and g.gid=authed.gid and ".
		     "     g.uid='$target_uid' ".
		     "where authed.uid='$uid' and ".
		     "      (authed.trust='group_root' or ".
		     "       authed.trust='project_root')");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    return 1;
}

#
# Access checks for an OSID. Tests for tbadmin.
#
# Usage: TBOSIDAccessCheck($uid, $osid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
# 
function TBOSIDAccessCheck($uid, $osid, $access_type)
{
    global $TB_OSID_READINFO;
    global $TB_OSID_MODIFYINFO;
    global $TB_OSID_DESTROY;
    global $TB_OSID_MIN;
    global $TB_OSID_MAX;
    global $TBDB_TRUST_USER;
    global $TBDB_TRUST_LOCALROOT;
    $mintrust;

    if ($access_type < $TB_OSID_MIN || $access_type > $TB_OSID_MAX) {
	TBERROR("Invalid access type $access_type!", 1);
    }

    #
    # Admins do whatever they want!
    # 
    if (ISADMIN($uid)) {
	return 1;
    }

    #
    # No GIDs yet.
    #
    $query_result =
519
	DBQueryFatal("SELECT pid,shared FROM os_info WHERE osid='$osid'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
520
521
522
523
524
    
    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row = mysql_fetch_array($query_result);
525
526
    $pid    = $row[pid];
    $shared = $row[shared];
Leigh B. Stoller's avatar
Leigh B. Stoller committed
527
528
529
530

    #
    # Global OSIDs can be read by anyone.
    # 
531
    if ($shared) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
	if ($access_type == $TB_OSID_READINFO) {
	    return 1;
	}
	return 0;
    }
    
    #
    # Otherwise must have proper trust in the project.
    # 
    if ($access_type == $TB_OSID_READINFO) {
	$mintrust = $TBDB_TRUST_USER;
    }
    else {
	$mintrust = $TBDB_TRUST_LOCALROOT;
    }

    return TBMinTrust(TBProjTrust($uid, $pid), $mintrust);
}

#
# Access checks for an ImageID
#
# Usage: TBImageIDAccessCheck($uid, $imageid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
# 
function TBImageIDAccessCheck($uid, $imageid, $access_type)
{
    global $TB_IMAGEID_READINFO;
    global $TB_IMAGEID_MODIFYINFO;
    global $TB_IMAGEID_DESTROY;
    global $TB_IMAGEID_ACCESS;
    global $TB_IMAGEID_MIN;
    global $TB_IMAGEID_MAX;
    global $TBDB_TRUST_USER;
    global $TBDB_TRUST_LOCALROOT;
    $mintrust;

    if ($access_type < $TB_IMAGEID_MIN || $access_type > $TB_IMAGEID_MAX) {
	TBERROR("Invalid access type $access_type!", 1);
    }

    #
    # Admins do whatever they want!
    # 
    if (ISADMIN($uid)) {
	return 1;
    }

    #
    # No GIDs yet.
    #
    $query_result =
585
	DBQueryFatal("SELECT pid,shared FROM images WHERE imageid='$imageid'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
586
587
588
589
    
    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
590
591
592
    $row    = mysql_fetch_array($query_result);
    $shared = $row[shared];
    $pid    = $row[pid];
Leigh B. Stoller's avatar
Leigh B. Stoller committed
593
594

    #
595
    # Global ImageIDs can be read by anyone but written by Admins only.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
596
    # 
597
    if ($shared) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
	if ($access_type == $TB_IMAGEID_READINFO) {
	    return 1;
	}
	return 0;
    }

    #
    # Otherwise must have proper trust in the project.
    # 
    if ($access_type == $TB_IMAGEID_READINFO) {
	$mintrust = $TBDB_TRUST_USER;
    }
    else {
	$mintrust = $TBDB_TRUST_LOCALROOT;
    }

    return TBMinTrust(TBProjTrust($uid, $pid), $mintrust);
}

#
# Return the Unix GID Name and Number for a group. This is distinct from
# the name we use within the Testbed system.
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
621
# usage: TBGroupUnixInfo($pid, $gid, &$unix_gid, &$unix_name)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
622
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
623
function TBGroupUnixInfo($pid, $gid, &$unix_gid, &$unix_name)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
{
    $query_result =
	DBQueryFatal("select unix_name,unix_gid from groups ".
		     "where pid='$pid' and gid='$gid'");

    if (mysql_num_rows($query_result) == 0) {
	TBERROR("No such group $gid in project $pid!", 1);
    }
    $row = mysql_fetch_array($query_result);
    $unix_gid  = $row[unix_gid];
    $unix_name = $row[unix_name];
}

#
# Get name and email info for a uid. Args are pass by reference.
#
# usage: TBUserInfo($uid, $user_name, $user_email)
#
function TBUserInfo($uid, &$user_name, &$user_email)
{
    $query_result =
	DBQueryFatal("select usr_name,usr_email from users where uid='$uid'");

    if (mysql_num_rows($query_result) == 0) {
	TBERROR("No such user $uid!", 1);
    }
    $row = mysql_fetch_array($query_result);
    $user_name  = $row[usr_name];
    $user_email = $row[usr_email];
}

655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
#
# Confirm a current user or not.
#
# usage TBCurrentUser($uid)
#       returns 1 if a valid user.
#       returns 0 if not a valid user.
#
function TBCurrentUser($uid)
{
    $query_result =
	DBQueryFatal("SELECT usr_pswd FROM users WHERE uid='$uid'");

    return mysql_num_rows($query_result);
}

670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
#
# Get user status,
#
# usage TBUserStatus($uid)
#       returns status if a valid user.
#       returns 0 if not a valid user.
#
function TBUserStatus($uid)
{
    $query_result =
	DBQueryFatal("SELECT status FROM users WHERE uid='$uid'");

    if (! mysql_num_rows($query_result)) {
	return 0;
    }
    $row = mysql_fetch_row($query_result);
    return $row[0];
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
#
# Confirm a valid pid/gid
#
# usage TBValidGroup($pid, $gid)
#       returns 1 if a valid group.
#       returns 0 if not a valid group
#
function TBValidGroup($pid, $gid)
{
    $query_result =
	DBQueryFatal("select pid,gid from groups as g ".
		     "where pid='$pid' and gid='$gid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }

    #
    # XXX String compare to ensure case match. 
    #
    $row = mysql_fetch_row($query_result);
    if (strcmp($row[0], $pid) ||
	strcmp($row[1], $gid)) {
	return 0;
    }
    return 1;
}

717
718
719
720
721
722
723
724
725
726
727
728
#
# Confirm a valid project.
#
# usage TBValidProject($pid)
#       returns 1 if a valid project.
#       returns 0 if not a valid project.
#
function TBValidProject($pid)
{
    return TBValidGroup($pid, $pid);
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
#
# Confirm a group member.
#
# usage TBGroupMember($uid, $pid, $gid, &$approved)
#       returns 1 if a member.
#       returns 0 if not a member.
#
function TBGroupMember($uid, $pid, $gid, &$approved)
{
    global $TBDB_TRUST_USER;
	
    $approved = 0;
    
    $query_result =
	DBQueryFatal("select trust from group_membership ".
		     "where uid='$uid' and pid='$pid' and gid='$gid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row = mysql_fetch_row($query_result);
    $trust = $row[0];

    $approved = TBMinTrust($trust, $TBDB_TRUST_USER);
    return 1;
}

756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
#
# Confirm a valid OS Descriptor in the specified project.
#
# usage TBValidOS($pid, $imagename)
#       returns 1 if valid
#       returns 0 if not valid
#
function TBValidOS($pid, $osname)
{
    $query_result =
	DBQueryFatal("select osid from os_info where ".
		     "pid='$pid' and osname='$osname'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    return 1;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
#
# Confirm a valid osid.
#
# usage TBValidOSID($osid)
#       returns 1 if valid
#       returns 0 if not valid
#
function TBValidOSID($osid)
{
    $query_result =
	DBQueryFatal("select osid from os_info where osid='$osid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    return 1;
}

#
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
# Confirm a valid image in the specified project.
#
# usage TBValidImage($pid, $imagename)
#       returns 1 if valid
#       returns 0 if not valid
#
function TBValidImage($pid, $imagename)
{
    $query_result =
	DBQueryFatal("select imageid from images where ".
		     "pid='$pid' and imagename='$imagename'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    return 1;
}

#
# Confirm a valid imageid (imageids are globally unique).
Leigh B. Stoller's avatar
Leigh B. Stoller committed
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
#
# usage TBValidImageID($imageid)
#       returns 1 if valid
#       returns 0 if not valid
#
function TBValidImageID($imageid)
{
    $query_result =
	DBQueryFatal("select imageid from images where imageid='$imageid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    return 1;
}

830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
#
# Return info for an imageid.
# 
# usage TBImageInfo($imageid, &$imagename, &$pid)
#       returns 1 if valid
#       returns 0 if not valid
#
function TBImageInfo($imageid, &$imagename, &$pid)
{
    $query_result =
	DBQueryFatal("select * from images where imageid='$imageid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row = mysql_fetch_array($query_result);
    $imagename = $row[imagename];
    $pid       = $row[pid];
    return 1;
}

#
# Return info for an osid.
# 
# usage TBOSInfo($osid, &$osname, &$pid)
#       returns 1 if valid
#       returns 0 if not valid
#
function TBOSInfo($osid, &$osname, &$pid)
{
    $query_result =
	DBQueryFatal("select * from os_info where osid='$osid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row = mysql_fetch_array($query_result);
    $osname = $row[osname];
    $pid    = $row[pid];
    return 1;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
#
# Confirm a valid experiment.
#
# usage TBValidExperiment($pid, $eid)
#       returns 1 if valid
#       returns 0 if not valid
#
function TBValidExperiment($pid, $eid)
{
    $query_result =
	DBQueryFatal("select eid from experiments ".
		     "where eid='$eid' and pid='$pid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    return 1;
}

#
892
# Confirm a valid node name.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
893
#
894
# usage TBValidNodeName($node)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
895
896
897
#       returns 1 if valid
#       returns 0 if not valid
#
898
function TBValidNodeName($node)
Leigh B. Stoller's avatar
Leigh B. Stoller committed
899
900
{
    $query_result =
901
	DBQueryFatal("select node_id from nodes where node_id='$node'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
902
903
904
905
906
907
908

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    return 1;
}

909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
#
# Return mail addresses for project_root and group_root people.
#
# usage TBLeaderMailList($pid, $gid)
#       Uses default group (pid=gid) if gid not given.
#       returns string like "Leader Name (uid) <email>[, ...]"
#       returns 0 if not valid
function TBLeaderMailList($pid, $gid)
{
  # No group, then use the default group.
  if (! $gid) { $gid = $pid; }
  
  $query_result =
    DBQueryFatal("select distinct usr_name,u.uid,usr_email from users as u ".
		 "left join group_membership as gm on gm.uid=u.uid ".
		 "where (trust='". TBDB_TRUSTSTRING_PROJROOT .
		 "' and pid='$pid') or (trust='". TBDB_TRUSTSTRING_GROUPROOT .
		 "' and gid='$gid') order by trust DESC, usr_name");
  
  if (mysql_num_rows($query_result) == 0) {
    return 0;
  }
  $mailstr="";
  while ($row = mysql_fetch_array($query_result)) {
    if ($mailstr != "") { $mailstr .=", "; }
934
    $mailstr .= '"'.$row[usr_name]." (".$row[uid].")\" <".$row[usr_email].">";
935
936
937
938
  }
  return $mailstr;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
#
# Return Project Leader.
#
# usage TBProjLeader($pid, &$projleader)
#       returns 1 if valid
#       returns 0 if not valid
#
function TBProjLeader($pid, &$projleader)
{
    $query_result =
	DBQueryFatal("select head_uid from projects where pid='$pid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row = mysql_fetch_array($query_result);
    $projleader  = $row[head_uid];
    
    return 1;
}

960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
#
# Return Group Leader.
#
# usage TBGroupLeader($pid, $gid, &$groupleader)
#       returns 1 if valid
#       returns 0 if not valid
#
function TBGroupLeader($pid, $gid, &$groupleader)
{
    $query_result =
	DBQueryFatal("select leader from groups ".
		     "where pid='$pid' and gid='$gid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row = mysql_fetch_array($query_result);
    $groupleader  = $row[leader];
    
    return 1;
}

982
983
984
#
# Return Experiment Leader.
#
985
# usage TBExpLeader($pid, $eid, &$expleader)
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
#       returns 1 if valid
#       returns 0 if not valid
#
function TBExpLeader($pid, $eid, &$expleader)
{
    $query_result =
	DBQueryFatal("select expt_head_uid from experiments ".
		     "where pid='$pid' and eid='$eid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row = mysql_fetch_array($query_result);
    $expleader  = $row[expt_head_uid];
    
    return 1;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
1004
1005
1006
1007
1008
1009
#
# Return a list of projects for which the uid is allowed to perform the
# requested operation. Only a couple of access options are supported since
# to be totally general would require too many DB operations. Not worth
# the effort or the expense.
#
1010
1011
# Returns an indexed array (by pid) of lists (of gids).
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1012
1013
1014
1015
1016
function TBProjList($uid, $access_type)
{
    global $TB_PROJECT_CREATEEXPT;
    global $TB_PROJECT_MAKEOSID;
    global $TB_PROJECT_MAKEIMAGEID;
1017
    global $TB_PROJECT_MAKEGROUP;
1018
    global $TB_PROJECT_READINFO;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1019
    $result = array();
1020
    $user_clause = "where uid='$uid' and";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1021
    
1022
1023
1024
1025
    if ($access_type == $TB_PROJECT_READINFO) {
	$trust_clause = "trust!='none'";
    }
    elseif ($access_type == $TB_PROJECT_MAKEGROUP) {
1026
1027
	$trust_clause = "trust='project_root'";
    }
1028
    elseif ($access_type == $TB_PROJECT_CREATEEXPT) {
1029
1030
1031
	$trust_clause = "(trust='project_root' or trust='group_root' or ".
	                " trust='local_root')";
    }
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
    elseif ($access_type == $TB_PROJECT_MAKEOSID ||
	    $access_type == $TB_PROJECT_MAKEIMAGEID) {
        if (ISADMIN($uid)) {
            $user_clause = "";
	}
        else {
  	    $trust_clause = "(trust='project_root' or trust='group_root' or ".
	                    " trust='local_root')";
        }
    }
1042
    else {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1043
1044
1045
1046
	TBERROR("Invalid access type $access_type!", 1);
    }
    
    $query_result =
1047
	DBQueryFatal("SELECT distinct pid,gid FROM group_membership ".
1048
		     "$user_clause $trust_clause order by pid");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1049
1050
1051
1052
1053
1054
1055

    if (mysql_num_rows($query_result) == 0) {
	return $result;
    }

    $i = 0;
    while ($row = mysql_fetch_array($query_result)) {
1056
1057
1058
1059
	$pid = $row['pid'];
	$gid = $row['gid'];
	
	$result[$pid][] = $gid;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1060
1061
1062
1063
1064
1065

	$i++;
    }
    return $result;
}

1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
function TBExptState($pid, $eid)
{
    $query_result =
	DBQueryFatal("select state from experiments ".
		     "where eid='$eid' and pid='$pid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row   = mysql_fetch_array($query_result);
    $state = $row[state];
    return $state;
}

1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
function TBUidNodeLastLogin($uid)
{
    $query_result =
	DBQueryFatal("select * from uidnodelastlogin where uid='$uid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row   = mysql_fetch_array($query_result);
    return $row;
}

#
# Return the last login for the node, but only after the experiment was
# created (swapped in).
# 
function TBNodeUidLastLogin($node_id)
{
    $query_result =
	DBQueryFatal("select n.* from nodeuidlastlogin as n ".
		     "left join reserved as r on n.node_id=r.node_id ".
		     "left join experiments as e ".
		     " on r.eid=e.eid and r.pid=e.pid ".
		     "where r.node_id='$node_id' and ".
		     "  DATE_ADD(n.date, INTERVAL n.time HOUR_SECOND) >= ".
		     "           e.expt_swapped");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row   = mysql_fetch_array($query_result);
    return $row;
}

1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
#
# Return the last login for the users node.
# 
function TBUsersLastLogin($uid)
{
    $query_result =
	DBQueryFatal("select * from userslastlogin where uid='$uid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row   = mysql_fetch_array($query_result);
    return $row;
}

1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
#
# Return number of events in an experiment.
#
function TBEventCount($pid, $eid)
{
    $query_result =
	DBQueryFatal("select count(*) from eventlist ".
		     "where pid='$pid' and eid='$eid'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row = mysql_fetch_row($query_result);
    return $row[0];
}

1145
1146
1147
1148
1149
1150
1151
#
# Return the last login for all of the nodes in an experiment, but only
# after the experiment was created (swapped in).
# 
function TBExpUidLastLogins($pid, $eid)
{
    $query_result =
1152
1153
	DBQueryFatal("select n.*, to_days(now())-to_days(n.date) as daysidle ".
	             "from nodeuidlastlogin as n ".
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
		     "left join reserved as r on n.node_id=r.node_id ".
		     "left join experiments as e ".
		     " on r.eid=e.eid and r.pid=e.pid ".
		     "where r.pid='$pid' and r.eid='$eid' and ".
		     "  DATE_ADD(n.date, INTERVAL n.time HOUR_SECOND) >= ".
		     "           e.expt_swapped ".
		     "      order by n.date DESC");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row   = mysql_fetch_array($query_result);
    return $row;
}

1169
#
1170
# Number of globally free PCs.
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
#
function TBFreePCs()
{
    $query_result =
	DBQueryFatal("select a.node_id from nodes as a ".
		     "left join reserved as b on a.node_id=b.node_id ".
		     "left join node_types as nt on a.type=nt.type ".
		     "where b.node_id is null and a.role='testnode' ".
		     "  and a.type like 'pc%'");

    return mysql_num_rows($query_result);
}

1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
function TBUserPCs($uid)
{
    $query_result =
	DBQueryFatal("select a.node_id from nodes as a ".
		     "left join reserved as b on a.node_id=b.node_id ".
		     "left join node_types as nt on a.type=nt.type ".
                     "left join experiments as e on b.pid=e.pid and ".
                     " b.eid=e.eid ".
		     "where e.expt_head_uid='$uid' and e.pid!='emulab-ops' ".
		     "  and a.role='testnode' and a.type like 'pc%'");

    return mysql_num_rows($query_result);
}

1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
function TBExptLogFile($pid, $eid)
{
    $query_result =
	DBQueryFatal("select logfile from experiments ".
		     "where pid='$pid' and eid='$eid' and ".
		     " logfile is not null");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row = mysql_fetch_row($query_result);
    return $row[0];
}

1212
1213
1214
1215
1216
1217
1218
1219
function TBWebdbAllowed($uid) {
    $query_result =
        DBQueryFatal("select dbedit from users ".
		     "WHERE uid='$uid' and dbedit=1");

    return mysql_num_rows($query_result);
}

1220
1221
1222
1223
1224
1225
1226
1227
function TBCvswebAllowed($uid) {
    $query_result =
        DBQueryFatal("select cvsweb from users ".
		     "WHERE uid='$uid' and cvsweb=1");

    return mysql_num_rows($query_result);
}

1228
1229
1230
1231
1232
1233
1234
1235
1236
#
# Returns > 0 if a node has a serial console, 0 if it does not
#
function TBHasSerialConsole($node_id) {
    $query_result =
	DBQueryFatal("select tipname from tiplines WHERE node_id='$node_id'");
    return mysql_num_rows($query_result);
}

1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
#
# Generate a verification key, and stash it in the database
#
function TBGenVerificationKey($name) {
    $key = md5(uniqid(rand(),1));
    DBQueryFatal("update users set verify_key='$key' where uid='$name'");
    return $key;
}

#
# Get a verification key from the database
#
function TBGetVerificationKey($name) {
    $query_result =
	DBQueryFatal("select verify_key from users where uid='$name'");

    if (mysql_num_rows($query_result) == 0) {
	# Can we signal error somehow?
	return "";
    }
    $row   = mysql_fetch_array($query_result);
    return $row[verify_key];
}

1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
#
# Map IP to nodeid.
#
function TBIPtoNodeID($ip) {
    $query_result =
	DBQueryFatal("select n.node_id from interfaces as i ".
		     "left join nodes as n on n.node_id=i.node_id ".
		     "left join node_types as t ".
		     "   on t.type=n.type and i.card=t.control_net ".
		     "where i.IP='$ip'");

    if (mysql_num_rows($query_result) == 0) {
	return 0;
    }
    $row   = mysql_fetch_array($query_result);
    return $row[node_id];
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
1279
1280
1281
#
# DB Interface.
#
1282
1283
$maxtries = 3;
$DBlinkid = 0;
1284
while ($maxtries) {
1285
    $DBlinkid = mysql_connect("localhost", basename($SCRIPT_NAME));
1286
1287
1288
    if ($DBlinkid) {
	break;
    }
1289
1290
1291
1292
1293
1294
1295
1296
1297
    $maxtries--;
    sleep(1);
}
if (! $DBlinkid) {
    TBERROR("Could not connect to mysqld after several attempts!", 1);
}
if (!mysql_select_db($TBDBNAME)) {
    TBERROR("Could not select DB after connecting!", 1);
}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324

#
# Record last DB error string.
#
$DBErrorString = "";

#
# This mirrors the routine in the PERL code. The point is to avoid
# writing the same thing repeatedly, get consistent error handling,
# and make sure that mail is sent to the testbed list when things go
# wrong!
#
# Argument is a string. Returns the actual query object, so it is up to
# the caller to test it. I would not for one moment view this as
# encapsulation of the DB interface. 
# 
# usage: DBQuery(char *str)
#        returns the query object result.
#
# Sets $DBErrorString is case of error; saving the original query string and
# the error string from the DB module. Use DBFatal (below) to print/email
# that string, and then exit.
#
function DBQuery($query)
{
    global	$TBDBNAME;
    global	$DBErrorString;
1325
    global      $DBlinkid;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1326
    
1327
    $result = mysql_query($query, $DBlinkid);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392

    if (! $result) {
	$DBErrorString =
	    "  Query: $query\n".
	    "  Error: " . mysql_error();
    }
    return $result;
}

#
# Same as above, but die on error. 
# 
function DBQueryFatal($query)
{
    $result = DBQuery($query);

    if (! $result) {
	DBFatal("DB Query failed");
    }
    return $result;
}

#
# Same as above, but just send email on error. This info is useful
# to the TB system, but the caller has to retain control.
# 
function DBQueryWarn($query)
{
    $result = DBQuery($query);

    if (! $result) {
	DBWarn("DB Query failed");
    }
    return $result;
}

#
# Warn and send email after a failed DB query. First argument is the error
# message to send. The contents of $DBErrorString is also sent. We do not
# print this stuff back to the user since we might leak stuff out that we
# should not.
# 
# usage: DBWarn(char *message)
#
function DBWarn($message)
{
    global	$PHP_SELF, $DBErrorString;
    
    $text = "$message - In $PHP_SELF\n" .
  	    "$DBErrorString\n";

    TBERROR($text, 0);
}

#
# Same as above, but die after the warning.
# 
# usage: DBFatal(char *message);
#
function DBFatal($message)
{
    global $TBMAILADDR;

    DBWarn($message);

1393
1394
1395
    PAGEERROR("<p><p>".
	      "Unexpected Error. Could not continue. ".
              "Please contact $TBMAILADDR\n");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1396
}
1397
?>