emulabserver.py.in 210 KB
Newer Older
1
2
#! /usr/bin/env python
#
3
# Copyright (c) 2004-2017 University of Utah and the Flux Group.
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# 
# {{{EMULAB-LICENSE
# 
# This file is part of the Emulab network testbed software.
# 
# This file is free software: you can redistribute it and/or modify it
# under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or (at
# your option) any later version.
# 
# This file is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
# License for more details.
# 
# You should have received a copy of the GNU Affero General Public License
# along with this file.  If not, see <http://www.gnu.org/licenses/>.
# 
# }}}
23
24
25
26
#
import sys
import socket
import os
Timothy Stack's avatar
   
Timothy Stack committed
27
28
import os.path
import stat
29
30
import tempfile
import time
31
32
import re
import string
Timothy Stack's avatar
   
Timothy Stack committed
33
34
35
36
import pwd
import grp
import errno
import exceptions
37
import xmlrpclib
38
import signal
39
import types
40
import datetime
41
import syslog
42
import subprocess
43
44
45

# Configure variables
TBDIR = "@prefix@"
46
BOSSNODE = "@BOSSNODE@"
47
BOSSEVENTPORT = "@BOSSEVENTPORT@"
Timothy Stack's avatar
   
Timothy Stack committed
48
49
OURDOMAIN = "@OURDOMAIN@"
USERNODE = "@USERNODE@"
Ryan Jackson's avatar
Ryan Jackson committed
50
51
52
BASEADDR = "@FRISEBEEMCASTADDR@"
BASEPORT = "@FRISEBEEMCASTPORT@"
SUBBOSS_UID = "elabman"
53
PREDICT = "@prefix@/sbin/predict"
Timothy Stack's avatar
   
Timothy Stack committed
54
55
56
57
58
59
60
61
62

TBPATH = os.path.join(TBDIR, "lib")
if TBPATH not in sys.path:
    sys.path.append(TBPATH)
    pass

from libdb        import *
from libtestbed   import SENDMAIL, TBOPS
from emulabclient import *
63

64
65
66
# Version
VERSION = 0.1

Timothy Stack's avatar
   
Timothy Stack committed
67
# Well known directories
68
69
70
71
72
PROJROOT = "@PROJROOT_DIR@"
GROUPROOT = "@GROUPSROOT_DIR@"
SCRATCHROOT = "@SCRATCHROOT_DIR@"
SHAREROOT = "@SHAREROOT_DIR@"
USERSROOT = "@USERSROOT_DIR@"
Timothy Stack's avatar
   
Timothy Stack committed
73
74
75
76
77
78
79

# List of directories exported to nodes via NFS.
NFS_EXPORTS = [
    PROJROOT,
    GROUPROOT,
    SHAREROOT,
    USERSROOT,
80
    SCRATCHROOT,
Timothy Stack's avatar
   
Timothy Stack committed
81
82
    ]

83
84
85
86
87
88
89
90
91
92
93
94
95
96
#
# XXX
# This mirrors db/xmlconvert. Be sure to keep this table in sync with that table.
#
virtual_tables = {
    "experiments"		: { "rows"  : None, 
                                    "tag"   : "experiment",
                                    "attrs" : [ ] },
    "virt_nodes"		: { "rows"  : None, 
                                    "tag"   : "nodes",
                                    "attrs" : [ "vname" ]},
    "virt_lans"                 : { "rows"  : None, 
                                    "tag"   : "lans",
                                    "attrs" : [ "vname" ]},
97
98
99
    "virt_lan_lans"             : { "rows"  : None, 
                                    "tag"   : "lan_lans",
                                    "attrs" : [ "vname" ]},
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
    "virt_lan_settings"         : { "rows"  : None, 
                                    "tag"   : "lan_settings",
                                    "attrs" : [ "vname", "capkey" ]},
    "virt_lan_member_settings"  : { "rows"  : None, 
                                    "tag"   : "lan_member_settings",
                                    "attrs" : [ "vname", "member", "capkey" ]},
    "virt_trafgens"		: { "rows"  : None, 
                                    "tag"   : "trafgens",
                                    "attrs" : [ "vname", "vnode" ]},
    "virt_agents"		: { "rows"  : None, 
                                    "tag"   : "agents",
                                    "attrs" : [ "vname", "vnode" ]},
    "virt_node_desires"         : { "rows"  : None, 
                                    "tag"   : "node_desires",
                                    "attrs" : [ "vname", "desire" ]},
Timothy Stack's avatar
   
Timothy Stack committed
115
116
117
    "virt_node_startloc"        : { "rows"  : None,
                                    "tag"   : "node_startlocs",
                                    "attrs" : [ "vname", "building" ]},
118
119
120
121
122
123
124
125
126
    "virt_routes"		: { "rows"  : None, 
                                    "tag"   : "routes",
                                    "attrs" : [ "vname", "src", "dst" ]},
    "virt_vtypes"		: { "rows"  : None, 
                                    "tag"   : "vtypes",
                                    "attrs" : [ "name" ]},
    "virt_programs"		: { "rows"  : None, 
                                    "tag"   : "programs",
                                    "attrs" : [ "vname", "vnode" ]},
Timothy Stack's avatar
   
Timothy Stack committed
127
128
129
    "virt_user_environment"	: { "rows"  : None, 
                                    "tag"   : "user_environment",
                                    "attrs" : [ "name", "value" ]},
130
131
132
133
134
    "nseconfigs"		: { "rows"  : None, 
                                    "tag"   : "nseconfigs",
                                    "attrs" : [ "vname" ]},
    "eventlist"                 : { "rows"  : None, 
                                    "tag"   : "events",
Timothy Stack's avatar
   
Timothy Stack committed
135
                                    "attrs" : [ "vname" ]},
Timothy Stack's avatar
   
Timothy Stack committed
136
137
138
139
140
141
142
143
144
    "event_groups"              : { "rows"  : None,
                                    "tag"   : "event_groups",
                                    "attrs" : [ "group_name", "agent-name" ]},
    "virt_firewalls"            : { "rows"  : None,
                                    "tag"   : "virt_firewalls",
                                    "attrs" : [ "fwname", "type", "style" ]},
    "firewall_rules"            : { "rows"  : None,
                                    "tag"   : "firewall_rules",
                                    "attrs" : [ "fwname", "ruleno", "rule" ]},
Timothy Stack's avatar
   
Timothy Stack committed
145
146
147
    "virt_tiptunnels"           : { "rows"  : None,
                                    "tag"   : "tiptunnels",
                                    "attrs" : [ "host", "vnode" ]},
148
149
    }
    
Timothy Stack's avatar
   
Timothy Stack committed
150
151
152
153
154
155
156
157
158
159
160
161
# Base class for emulab specific exceptions.
class EmulabError(exceptions.Exception):
    pass

# Exception thrown when logins are not allowed.
class NoLoginsError(EmulabError):
    pass

# Exception thrown an unknown user tries to import this module.
class UnknownUserError(EmulabError):
    pass

162
163
164
165
166
167
168
# Exception thrown when a timer expires.
class TimedOutError(EmulabError):
    pass

def TimeoutHandler(signum, frame):
    raise TimedOutError, 'Timer Expired'

169
170
171
172
173
174
175
176
177
def logit(debug, msg):
    if debug:
        print msg
        pass
    else:
        syslog.syslog(syslog.LOG_INFO, msg);
        pass
    return

178
#
179
180
# Arguments to methods are passed as a Dictionary. This converts to a XML
# "struct" which in Perl/PHP/Ruby would be a hash. So, a client written in
181
182
# pretty much any language should be able to talk to this class.
#
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
#
# A helper function for checking required arguments.
#
def CheckRequiredArgs(argdict, arglist):
    # proj,group,exp are aliases for pid,gid,eid
    if (argdict.has_key("pid") and not argdict.has_key("proj")):
        argdict["proj"] = argdict["pid"]
        pass
    if (argdict.has_key("gid") and not argdict.has_key("group")):
        argdict["group"] = argdict["gid"]
        pass
    if (argdict.has_key("eid") and not argdict.has_key("exp")):
        argdict["exp"] = argdict["eid"]
        pass

    # Okay, now check.
    for arg in arglist:
        if not argdict.has_key(arg):
            return EmulabResponse(RESPONSE_BADARGS,
                                  output="Must supply '" + arg + "'")
        pass
    return None

Timothy Stack's avatar
   
Timothy Stack committed
206
207
208
#
# Check user permission to access a project.
#
209
def CheckProjPermission(uid_idx, pid):
Timothy Stack's avatar
   
Timothy Stack committed
210
211
212
213
214
    if not re.match("^[-\w]*$", pid):
        return EmulabResponse(RESPONSE_BADARGS,
                              output="Illegal characters in project ID!")

    res = DBQueryFatal("SELECT trust FROM group_membership "
215
216
                       "WHERE uid_idx=%s and pid=%s and gid=%s and trust!='none'",
                       (uid_idx, pid, pid))
Timothy Stack's avatar
   
Timothy Stack committed
217
218
219
220
221
222
223
224

    if len(res) == 0:
        return EmulabResponse(RESPONSE_FORBIDDEN,
                              output=("You do not have permission to " +
                                      "access project: " + pid))
    
    return None

225
def GetProjects(uid_idx):
Timothy Stack's avatar
   
Timothy Stack committed
226
    res = DBQueryFatal("SELECT distinct pid FROM group_membership "
227
228
                       "WHERE uid_idx=%s",
                       (uid_idx,))
Timothy Stack's avatar
   
Timothy Stack committed
229
230
231
232

    return [x[0] for x in res]


233
234
235
#
# Check user permission to access an experiment.
# 
236
def CheckExptPermission(uid_idx, pid, eid):
237
238
239
240
241
    if not (re.match("^[-\w]*$", pid) and
            re.match("^[-\w]*$", eid)):
        return EmulabResponse(RESPONSE_BADARGS,
                  output="Illegal characters in project and/or experiment IDs!")
    
242
243
244
245
246
247
248
249
250
251
    res = DBQueryFatal("SELECT gid FROM experiments "
                       "WHERE pid=%s and eid=%s",
                       (pid, eid))

    if len(res) == 0:
        return EmulabResponse(RESPONSE_ERROR,
                              output="No such experiment: " +
                              pid + "/" + eid)

    gid = res[0][0]
Timothy Stack's avatar
   
Timothy Stack committed
252
    
253
    res = DBQueryFatal("SELECT trust FROM group_membership "
254
255
                       "WHERE uid_idx=%s and pid=%s and gid=%s",
                       (uid_idx, pid, gid))
256
257
258
259
260
261
262

    if len(res) == 0:
        return EmulabResponse(RESPONSE_FORBIDDEN,
                              output=("You do not have permission to " +
                                      "access experiment: " + pid + "/" + eid))
    return None

Timothy Stack's avatar
   
Timothy Stack committed
263
264
265
#
# Check user permission to access a node.
# 
266
def CheckNodePermission(uid_idx, node):
Timothy Stack's avatar
   
Timothy Stack committed
267
268
269
270
271
272
273
274
275
276
    res = DBQueryFatal("SELECT e.pid,e.eid FROM reserved AS r "
                       "left join experiments as e on "
                       "     e.pid=r.pid and e.eid=r.eid "
                       "WHERE r.node_id=%s",
                       (node,))
    
    if len(res) == 0:
        return EmulabResponse(RESPONSE_ERROR,
                              output="No such node: " + node)

277
    return CheckExptPermission(uid_idx, res[0][0], res[0][1])
Timothy Stack's avatar
   
Timothy Stack committed
278

279
280
281
#
# Check if user is an admin person
# 
282
def CheckIsAdmin(uid_idx):
283
    res = DBQueryFatal("SELECT admin FROM users "
284
285
                       "WHERE uid_idx=%s and status='active'",
                       (uid_idx,))
286
287
288
    
    if len(res) == 0:
        return EmulabResponse(RESPONSE_ERROR,
289
                              output="No such user: " + uid_idx)
290
291
292

    return res[0][0];

293
294
295
296
297
298
299
300
301
302
303
304
305
306
#
# Template lookup, by exptidx of an experiment.
#
def TemplateLookup(exptidx):
    res = DBQueryFatal("select parent_guid,parent_vers from "
                       "   experiment_template_instances "
                       "where exptidx=%s",
                       (exptidx,))
    
    if len(res) == 0:
        return None

    return (res[0][0], res[0][1])

307
308
309
310
311
312
313
314
315
316
317
318
319
#
# Get an experiment index.
#
def ExperimentIndex(pid, eid):
    res = DBQueryFatal("select idx from experiments "
                       "where pid=%s and eid=%s",
                       (pid, eid))
    
    if len(res) == 0:
        return None
    
    return res[0][0];

320
321
322
323
324
#
# This is a wrapper class so that you can invoke methods in dotted form.
# For example experiment.swapexp(...).
#
class EmulabServer:
325
    def __init__(self, uid, uid_idx, readonly=0, clientip=None, debug=0):
326
        self.readonly  = readonly;
Leigh B. Stoller's avatar
Leigh B. Stoller committed
327
        self.clientip  = clientip;
328
        self.debug     = debug;
329
        self.instances = {};
330
331
        self.uid_idx   = uid_idx;
        self.uid       = uid;
332
333
334

        self.instances["experiment"] = experiment(self);
        self.instances["template"]   = template(self);
335
336
337
        if readonly:
            return
        
338
339
340
341
342
343
344
        self.instances["emulab"]     = emulab(self);
        self.instances["user"]       = user(self);
        self.instances["fs"]         = fs(self);
        self.instances["imageid"]    = imageid(self);
        self.instances["osid"]       = osid(self);
        self.instances["node"]       = node(self);
        self.instances["elabinelab"] = elabinelab(self);
345
        self.instances["subboss"]    = subboss(self);
346
        self.instances["blob"]       = blob(self);
347
        self.instances["dataset"]    = dataset(self);
348
349
350
351
352
353
354
        return

    def __getattr__(self, name):
        dotted = name.split(".");
        if len(dotted) != 2:
            raise AttributeError("Bad name '%s'" % name)
        if not self.instances.has_key(dotted[0]):
355
356
            raise AttributeError("unknown method '%s' (readonly=%d)" %
                                 (name, self.readonly))
357
358
359
360
        
        return getattr(self.instances[dotted[0]], dotted[1]);
    pass

Timothy Stack's avatar
   
Timothy Stack committed
361
362
363
364
365
#
# This class implements the server side of the XMLRPC interface to emulab as a
# whole.
#
class emulab:
366
367
368
369
370
371
    def __init__(self, server):
        self.server   = server
        self.readonly = server.readonly
        self.uid      = server.uid
        self.uid_idx  = server.uid_idx
        self.debug    = server.debug
372
        self.VERSION  = VERSION
Timothy Stack's avatar
   
Timothy Stack committed
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
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
        return

    #
    # Get the global 'notice' message that is usually printed under the menu
    # on the web site.
    #
    def message(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!")

        msg = TBGetSiteVar("web/message")

        return EmulabResponse(RESPONSE_SUCCESS,
                              value=msg,
                              output=msg)

    #
    # Get the news items as a list of {subject,author,date,msgid} items for
    # dates between an option start and ending.
    #
    def news(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!")

        # Process optional arguments.
        starting = None;
        if argdict.has_key("starting"):
            if not re.match("^[-:\w]*$", str(argdict["starting"])):
                return EmulabResponse(RESPONSE_BADARGS,
                                      output="Improperly formed 'starting'!")
            starting = sqldate(argdict["starting"])
            pass

        ending = None
        if argdict.has_key("ending"):
            if not re.match("^[-:\w]*$", str(argdict["ending"])):
                return EmulabResponse(RESPONSE_BADARGS,
                                      output="Improperly formed 'ending'!")
            ending = sqldate(argdict["ending"])
            pass

        # Construct the SQL date comparison
        if starting and ending:
            comparison = "BETWEEN %s and %s"
            sub = (starting, ending)
        elif starting:
            comparison = "> %s"
422
            pass
Timothy Stack's avatar
   
Timothy Stack committed
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
            sub = (starting,)
            pass
        elif ending:
            comparison = "< %s"
            sub = (ending,)
            pass
        else:
            comparison = ""
            sub = ()
            pass

        # Get the headlines and
        dbres = DBQueryFatal("SELECT subject,author,date,msgid FROM webnews "
                             "WHERE date "
                             + comparison
                             + " ORDER BY date DESC",
                             sub)

        # ... package them up
        result = []
        for res in dbres:
            tmp = {}
            tmp["subject"] = res[0]
            tmp["author"] = res[1]
            tmp["date"] = xmlrpclib.DateTime(
448
                time.strptime(str(res[2]), "%Y-%m-%d %H:%M:%S"))
Timothy Stack's avatar
   
Timothy Stack committed
449
            tmp["msgid"] = res[3]
Timothy Stack's avatar
   
Timothy Stack committed
450
            
Timothy Stack's avatar
   
Timothy Stack committed
451
452
453
454
455
456
            result.append(tmp)
            pass

        return EmulabResponse(RESPONSE_SUCCESS,
                              value=result,
                              output=str(result))
Timothy Stack's avatar
   
Timothy Stack committed
457

Timothy Stack's avatar
   
Timothy Stack committed
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
    def getareas(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!")
        
        # Get the listing that is accessible to this user and
        res = DBQueryFatal("SELECT distinct building FROM obstacles")

        if len(res) == 0:
            return EmulabResponse(RESPONSE_ERROR,
                                  output="No areas?")

        result = {}
        for area in res:
            result[area[0]] = {
                "name" : area[0]
                }
            pass

        return EmulabResponse(RESPONSE_SUCCESS,
                              value=result,
                              output=str(result))

Timothy Stack's avatar
   
Timothy Stack committed
481
482
483
484
485
486
487
488
489
    def vision_config(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!")

        if not re.match("^[-:\w]*$", str(argdict["area"])):
            return EmulabResponse(RESPONSE_BADARGS,
                                  output="Improperly formed 'area'!")

Timothy Stack's avatar
   
Timothy Stack committed
490
491
492
        result = DBQuery("select * from cameras where building=%s",
                        (argdict["area"],),
                        asDict=True)
Timothy Stack's avatar
   
Timothy Stack committed
493
        
Timothy Stack's avatar
   
Timothy Stack committed
494
        if len(result) == 0:
Timothy Stack's avatar
   
Timothy Stack committed
495
496
497
            return EmulabResponse(RESPONSE_ERROR,
                                  output="Unknown area " + argdict["area"])

Timothy Stack's avatar
   
Timothy Stack committed
498
499
500
        result = [scrubdict(x, defaultvals={ "loc_x" : 0.0, "loc_y" : 0.0 })
                  for x in result]

Timothy Stack's avatar
   
Timothy Stack committed
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
        return EmulabResponse(RESPONSE_SUCCESS,
                              value=result,
                              output=str(result))

    def obstacle_config(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!")

        if not re.match("^[-:\w]*$", str(argdict["area"])):
            return EmulabResponse(RESPONSE_BADARGS,
                                  output="Improperly formed 'area'!")

        if not argdict.has_key("units"):
            argdict["units"] = "pixels"
            pass
        
        res = DBQuery("select * from obstacles where building=%s",
                      (argdict["area"],),
                      asDict=True)

        ppm = DBQueryFatal("select pixels_per_meter from floorimages "
                           "where building=%s",
                           (argdict["area"],))
        
        if len(res) == 0 or len(ppm) == 0:
            return EmulabResponse(RESPONSE_ERROR,
                                  output="No such area " + argdict["area"])

        ppm = ppm[0][0]

        for ob in res:
            if argdict["units"] == "meters":
                ob["x1"] = ob["x1"] / ppm
                ob["y1"] = ob["y1"] / ppm
                ob["z1"] = ob["z1"] / ppm
                ob["x2"] = ob["x2"] / ppm
                ob["y2"] = ob["y2"] / ppm
                ob["z2"] = ob["z2"] / ppm
                pass
Timothy Stack's avatar
   
Timothy Stack committed
541
            scrubdict(ob)
Timothy Stack's avatar
   
Timothy Stack committed
542
543
544
545
546
            pass
        
        return EmulabResponse(RESPONSE_SUCCESS,
                              value=res,
                              output=str(res))
Timothy Stack's avatar
   
Timothy Stack committed
547
548
549
550
551
552
553
554
555
    
    pass


#
# This class implements the server side of the XMLRPC interface to user
# specific information.
#
class user:
556
557
558
559
560
561
    def __init__(self, server):
        self.server   = server
        self.readonly = server.readonly
        self.uid      = server.uid
        self.uid_idx  = server.uid_idx
        self.debug    = server.debug
562
        self.VERSION  = VERSION
Timothy Stack's avatar
   
Timothy Stack committed
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
        return

    #
    # Get the number of nodes this user is has allocated.
    #
    def nodecount(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!")

        try:
            checknologins()
            pass
        except NoLoginsError, e:
            return EmulabResponse(RESPONSE_REFUSED, output=str(e))

        res = 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=%s and e.pid!='emulab-ops' "
            "  and a.role='testnode' and nt.class = 'pc'",
587
            (self.uid,))
Timothy Stack's avatar
   
Timothy Stack committed
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634

        return EmulabResponse(RESPONSE_SUCCESS,
                              value=len(res),
                              output=str(len(res)))

    #
    # Get the listing of projects/groups that this user is a member of and,
    # optionally, has the permission to perform some task.
    #
    def membership(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!")

        try:
            checknologins()
            pass
        except NoLoginsError, e:
            return EmulabResponse(RESPONSE_REFUSED, output=str(e))

        permission = "readinfo"
        if argdict.has_key("permission"):
            permission = argdict["permission"]
            pass

        # Convert the permission to a SQL condition.
        if permission == "readinfo":
            trust_clause = "trust!='none'"
            pass
        elif permission == "makegroup":
            trust_clause = "trust='project_root'"
            pass
        elif permission == "createexpt":
            trust_clause = ("(trust='project_root' or trust='group_root' or "
                            " trust='local_root')")
            pass
        elif permission == "makeosid" or permission == "makeimageid":
            # XXX Handle admin
            trust_clause = ("(trust='project_root' or trust='group_root' or "
                            " trust='local_root')")
            pass
        else:
            return EmulabResponse(RESPONSE_BADARGS,
                                  output=("Bad permission value: "
                                          + permission))

        res = DBQueryFatal("SELECT distinct pid,gid FROM group_membership "
635
                           "WHERE uid_idx=%s and "
Timothy Stack's avatar
   
Timothy Stack committed
636
637
                           + trust_clause
                           + " ORDER BY pid",
638
                           (self.uid_idx,))
Timothy Stack's avatar
   
Timothy Stack committed
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657

        result = {}
        for proj in res:
            if result.has_key(proj[0]):
                # Add group to existing project list
                tmp = result[proj[0]]
                tmp.append(proj[1])
                pass
            else:
                # Add new project to root list
                tmp = [proj[1],]
                result[proj[0]] = tmp
                pass
            pass

        return EmulabResponse(RESPONSE_SUCCESS,
                              value=result,
                              output=str(result))

658
659
660
661
662
663
664
665
666
667
668
669
670
671
    #
    # Return collab password,
    #
    def collabpassword(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!")

        try:
            checknologins()
            pass
        except NoLoginsError, e:
            return EmulabResponse(RESPONSE_REFUSED, output=str(e))

672
673
        res = DBQueryFatal("select mailman_password from users where uid_idx=%s",
                           (self.uid_idx,))
674
675
676
677
678
679

        if len(res) == 0:
            return EmulabResponse(RESPONSE_ERROR,
                                  output="No such user!")

        passwd = res[0][0]
680
        return EmulabResponse(RESPONSE_SUCCESS, value=passwd, output=passwd)
681

Timothy Stack's avatar
   
Timothy Stack committed
682
683
684
685
686
687
688
689
    pass


#
# This class implements the server side of the XMLRPC interface to the emulab
# NFS exports.
#
class fs:
690
691
692
693
694
695
    def __init__(self, server):
        self.server   = server
        self.readonly = server.readonly
        self.uid      = server.uid
        self.uid_idx  = server.uid_idx
        self.debug    = server.debug
696
        self.VERSION  = VERSION
Timothy Stack's avatar
   
Timothy Stack committed
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
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
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
        return

    #
    # Check the accessibility of a path.
    #
    def access(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!");

        try:
            checknologins()
            pass
        except NoLoginsError, e:
            return EmulabResponse(RESPONSE_REFUSED, output=str(e))

        argerror = CheckRequiredArgs(argdict, ("permission", "path"))
        if (argerror):
            return argerror

        try:
            path = nfspath(argdict["path"]) # Scrub the path
            
            permission = argdict["permission"]

            # Convert the permission to a python compatible value.
            if permission == "read" or permission == "r":
                accessmode = os.R_OK
                pass
            elif permission == "write" or permission == "w":
                accessmode = os.W_OK
                pass
            elif permission == "execute" or permission == "x":
                accessmode = os.X_OK
                pass
            elif permission == "exists" or permission == "e":
                accessmode = os.F_OK
                pass
            else:
                return EmulabResponse(RESPONSE_BADARGS,
                                      output=("Bad permission value: "
                                              + permission))
            
            res = os.access(path, accessmode)

            return EmulabResponse(RESPONSE_SUCCESS,
                                  value=res,
                                  output=str(res))
        except OSError, e:
            return EmulabResponse(RESPONSE_ERROR,
                                  value=e,
                                  output=(e.strerror + ": " + e.filename))

        # Never reached...
        assert False
        pass

    #
    # Get a directory listing for a given path.
    #
    def listdir(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!")

        try:
            checknologins()
            pass
        except NoLoginsError, e:
            return EmulabResponse(RESPONSE_REFUSED, output=str(e))

        argerror = CheckRequiredArgs(argdict, ("path",))
        if (argerror):
            return argerror

        try:
            path = nfspath(argdict["path"]) # Scrub the path

            # Make sure the path is accessible,
            if not os.access(path, os.X_OK):
                raise OSError(errno.EPERM, "Path is not accessible", path)

            # ... get the directory listing, and
            res = os.listdir(path)

            # ... package it up into a platform independent from.
            result = []
            for entry in res:
                try:
                    st = os.stat(os.path.join(path, entry))
                    # The UID/GID will be meaningless to the other side,
                    # resolve them before sending it back.
                    try:
                        uname = pwd.getpwuid(st[stat.ST_UID])[0]
                        pass
                    except:
                        # Unknown UID, just send the number as a string
                        uname = str(st[stat.ST_UID])
                        pass
                    try:
                        gname = grp.getgrgid(st[stat.ST_GID])[0]
                        pass
                    except:
                        # Unknown GID, just send the number as a string
                        gname = str(st[stat.ST_GID])
                        pass
                    result.append((entry,
                                   filetype(st[stat.ST_MODE]),
                                   stat.S_IMODE(st[stat.ST_MODE]),
                                   uname,
                                   gname,
                                   st[stat.ST_SIZE],
                                   st[stat.ST_ATIME],
                                   st[stat.ST_MTIME],
                                   st[stat.ST_CTIME]))
                except OSError:
                    pass
                pass
            retval = EmulabResponse(RESPONSE_SUCCESS,
                                    value=result,
                                    output=str(result))
            pass
        except OSError, e:
            retval = EmulabResponse(RESPONSE_ERROR,
                                    value=e,
                                    output=(e.strerror + ": " + e.filename))
            pass

        return retval

    #
    # Get the list of potential NFS exports for an experiment.
    #
    def exports(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!")

        try:
            checknologins()
            pass
        except NoLoginsError, e:
            return EmulabResponse(RESPONSE_REFUSED, output=str(e))

        # Start with the default set of exports, then
        res = [
843
            USERSROOT + "/" + self.uid, # XXX Use getpwuid() and handle admin
Timothy Stack's avatar
   
Timothy Stack committed
844
845
846
847
848
            SHAREROOT,
            ]

        # ... add the project/group listings.
        projs = DBQueryFatal("SELECT distinct pid,gid FROM group_membership "
849
850
                             "WHERE uid_idx=%s and trust!='none' ORDER BY pid",
                             (self.uid_idx,))
Timothy Stack's avatar
   
Timothy Stack committed
851
852
853
854

        for proj in projs:
            if proj[0] == proj[1]:
                res.append(PROJROOT + "/" + proj[0])
855
856
857
                if not SCRATCHROOT == "":
                    res.append(SCRATCHROOT + "/" + proj[0])
                    pass
Timothy Stack's avatar
   
Timothy Stack committed
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
                pass
            else:
                res.append(GROUPROOT + "/" + proj[0] + "/" + proj[1])
                pass
            pass
        
        return EmulabResponse(RESPONSE_SUCCESS,
                              value=res,
                              output=str(res))

    pass


#
# This class implements the server side of the XMLRPC interface to image IDs.
#
class imageid:
875
876
877
878
879
880
    def __init__(self, server):
        self.server   = server
        self.readonly = server.readonly
        self.uid      = server.uid
        self.uid_idx  = server.uid_idx
        self.debug    = server.debug
881
        self.VERSION  = VERSION
Timothy Stack's avatar
   
Timothy Stack committed
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
        return

    def getlist(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!")

        try:
            checknologins()
            pass
        except NoLoginsError, e:
            return EmulabResponse(RESPONSE_REFUSED, output=str(e))

        # Get the listing that is accessible to this user and
        res = DBQueryFatal(
897
            "SELECT distinct i.imagename,v.description FROM images as i "
898
899
            "left join image_versions as v on "
            "     v.imageid=o.imageid and v.version=i.version "
Timothy Stack's avatar
   
Timothy Stack committed
900
            "left join group_membership as g on g.pid=i.pid "
901
            "WHERE g.uid_idx=%s or v.global",
902
            (self.uid_idx,))
Timothy Stack's avatar
   
Timothy Stack committed
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928

        if len(res) == 0:
            return EmulabResponse(RESPONSE_ERROR,
                                  output="No image ids?")

        # ... package it up.
        result = {}
        for image in res:
            tmp = {
                "imageid" : image[0],
                "description" : image[1],
                }
            result[image[0]] = tmp
            pass

        return EmulabResponse(RESPONSE_SUCCESS,
                              value=result,
                              output=str(result))

    pass


#
# This class implements the server side of the XMLRPC interface to OS IDs.
#
class osid:
929
930
931
932
933
934
    def __init__(self, server):
        self.server   = server
        self.readonly = server.readonly
        self.uid      = server.uid
        self.uid_idx  = server.uid_idx
        self.debug    = server.debug
935
        self.VERSION  = VERSION
Timothy Stack's avatar
   
Timothy Stack committed
936
937
938
939
940
941
942
943
944
945
946
947
948
949
        return

    def getlist(self, version, argdict):
        if version != self.VERSION:
            return EmulabResponse(RESPONSE_BADVERSION,
                                  output="Client version mismatch!")

        try:
            checknologins()
            pass
        except NoLoginsError, e:
            return EmulabResponse(RESPONSE_REFUSED, output=str(e))

        # Get the listing that is accessible to this user and
950
951
        res = DBQueryFatal("SELECT distinct v.* FROM os_info as o "
                           "left join os_info_versions as v on "
Leigh B Stoller's avatar
Leigh B Stoller committed
952
                           "     v.osid=o.osid and v.vers=o.version "
Timothy Stack's avatar
   
Timothy Stack committed
953
                           "left join group_membership as g on g.pid=o.pid "
954
955
                           "where (g.uid_idx=%s or v.shared=1) "
                           "group by o.pid,o.osname",
956
                           (self.uid_idx,),
Timothy Stack's avatar
   
Timothy Stack committed
957
                           True)
Timothy Stack's avatar
   
Timothy Stack committed
958
959
960
961
962
963
964
965

        if len(res) == 0:
            return EmulabResponse(RESPONSE_ERROR,
                                  output="No OS IDs?")

        # ... package it up.
        result = {}
        for osid in res:
Timothy Stack's avatar
   
Timothy Stack committed
966
967
968
            # XXX Legacy stuff...
            osid["fullosid"] = osid["osid"]
            osid["osid"] = osid["osname"]
Timothy Stack's avatar
   
Timothy Stack committed
969

970
            if not osid.has_key("OS") or len(osid["OS"]) == 0:
Timothy Stack's avatar
   
Timothy Stack committed
971
972
973
974
975
976
                osid["OS"] = "(None)"
                pass

            result[osid["osid"]] = scrubdict(osid)
            pass
        
Timothy Stack's avatar
   
Timothy Stack committed
977
978
        return EmulabResponse(RESPONSE_SUCCESS,
                              value=result,
Timothy Stack's avatar
   
Timothy Stack committed
979
                              output="")
Timothy Stack's avatar
   
Timothy Stack committed
980
981
982
983
984
985
986
    
    def info(self, version, argdict):
        # Check for valid arguments.
        argerror = CheckRequiredArgs(argdict, ("osid",))
        if (argerror):
            return argerror

987
        if not re.match("^[-\w\.]*$", argdict["osid"]):
Timothy Stack's avatar
   
Timothy Stack committed
988
989
990
991
            return EmulabResponse(RESPONSE_BADARGS,
                                  output="Improperly formed osid!")

        # Get the listing that is accessible to this user and
992
        res = DBQueryFatal("SELECT distinct v.* FROM os_info as o "
993
                           "left join os_info_versions as v on "
Leigh B Stoller's avatar
Leigh B Stoller committed
994
                           "     v.osid=o.osid and v.vers=o.version "
Timothy Stack's avatar
   
Timothy Stack committed
995
                           "left join group_membership as g on g.pid=o.pid "
996
997
998
                           "where (g.uid_idx=%s or v.shared=1) and "
                           "      (o.osname=%s or o.osid=%s) "
                           "group by o.pid,o.osname",
999
                           (self.uid_idx, argdict["osid"], argdict["osid"]),
Timothy Stack's avatar
   
Timothy Stack committed
1000
                           True)