source: trunk/packages/sipb-xen-www/code/validation.py @ 610

Last change on this file since 610 was 609, checked in by andersk, 16 years ago

Add a description field.

File size: 10.7 KB
Line 
1#!/usr/bin/python
2
3import cache_acls
4import getafsgroups
5import re
6import string
7from sipb_xen_database import Machine, NIC, Type, Disk, CDROM
8from webcommon import InvalidInput
9
10MAX_MEMORY_TOTAL = 512
11MAX_MEMORY_SINGLE = 256
12MIN_MEMORY_SINGLE = 16
13MAX_DISK_TOTAL = 50
14MAX_DISK_SINGLE = 50
15MIN_DISK_SINGLE = 0.1
16MAX_VMS_TOTAL = 10
17MAX_VMS_ACTIVE = 4
18
19class Validate:
20    def __init__(self, username, state, machine_id=None, name=None, description=None, owner=None,
21                 admin=None, contact=None, memory=None, disksize=None,
22                 vmtype=None, cdrom=None, clone_from=None, strict=False):
23        # XXX Successive quota checks aren't a good idea, since you
24        # can't necessarily change the locker and disk size at the
25        # same time.
26        created_new = (machine_id is None)
27
28        if strict:
29            if name is None:
30                raise InvalidInput('name', name, "You must provide a machine name.")
31            if description is None:
32                raise InvalidInput('description', description, "You must provide a description.")
33            if memory is None:
34                raise InvalidInput('memory', memory, "You must provide a memory size.")
35            if disksize is None:
36                raise InvalidInput('disk', disksize, "You must provide a disk size.")
37
38        if machine_id is not None:
39            self.machine = testMachineId(username, machine_id)
40        machine = getattr(self, 'machine', None)
41
42        owner = testOwner(username, owner, machine)
43        if owner is not None:
44            self.owner = owner
45        admin = testAdmin(username, admin, machine)
46        if admin is not None:
47            self.admin = admin
48        contact = testContact(username, contact, machine)
49        if contact is not None:
50            self.contact = contact
51        name = testName(username, name, machine)
52        if name is not None:
53            self.name = name
54        description = testDescription(username, description, machine)
55        if description is not None:
56            self.description = description
57        if memory is not None:
58            self.memory = validMemory(self.owner, state, memory, machine,
59                                      on=not created_new)
60        if disksize is not None:
61            self.disksize = validDisk(self.owner, disksize, machine)
62        if vmtype is not None:
63            self.vmtype = validVmType(vmtype)
64        if cdrom is not None:
65            if not CDROM.get(cdrom):
66                raise CodeError("Invalid cdrom type '%s'" % cdrom)
67            self.cdrom = cdrom
68        if clone_from is not None:
69            if clone_from not in ('ice3', ):
70                raise CodeError("Invalid clone image '%s'" % clone_from)
71            self.clone_from = clone_from
72
73
74def getMachinesByOwner(owner, machine=None):
75    """Return the machines owned by the same as a machine.
76
77    If the machine is None, return the machines owned by the same
78    user.
79    """
80    if machine:
81        owner = machine.owner
82    return Machine.select_by(owner=owner)
83
84def maxMemory(owner, g, machine=None, on=True):
85    """Return the maximum memory for a machine or a user.
86
87    If machine is None, return the memory available for a new
88    machine.  Else, return the maximum that machine can have.
89
90    on is whether the machine should be turned on.  If false, the max
91    memory for the machine to change to, if it is left off, is
92    returned.
93    """
94    if machine is not None and machine.memory > MAX_MEMORY_SINGLE:
95        # If they've been blessed, let them have it
96        return machine.memory
97    if not on:
98        return MAX_MEMORY_SINGLE
99    machines = getMachinesByOwner(owner, machine)
100    active_machines = [m for m in machines if m.name in g.xmlist_raw]
101    mem_usage = sum([x.memory for x in active_machines if x != machine])
102    return min(MAX_MEMORY_SINGLE, MAX_MEMORY_TOTAL-mem_usage)
103
104def maxDisk(owner, machine=None):
105    """Return the maximum disk that a machine can reach.
106
107    If machine is None, the maximum disk for a new machine. Otherwise,
108    return the maximum that a given machine can be changed to.
109    """
110    if machine is not None:
111        machine_id = machine.machine_id
112    else:
113        machine_id = None
114    disk_usage = Disk.query().filter_by(Disk.c.machine_id != machine_id,
115                                        owner=owner).sum(Disk.c.size) or 0
116    return min(MAX_DISK_SINGLE, MAX_DISK_TOTAL-disk_usage/1024.)
117
118def cantAddVm(owner, g):
119    machines = getMachinesByOwner(owner)
120    active_machines = [m for m in machines if m.name in g.xmlist_raw]
121    if len(machines) >= MAX_VMS_TOTAL:
122        return 'You have too many VMs to create a new one.'
123    if len(active_machines) >= MAX_VMS_ACTIVE:
124        return ('You already have the maximum number of VMs turned on.  '
125                'To create more, turn one off.')
126    return False
127
128def haveAccess(user, machine):
129    """Return whether a user has administrative access to a machine"""
130    return user in cache_acls.accessList(machine)
131
132def owns(user, machine):
133    """Return whether a user owns a machine"""
134    return user in expandLocker(machine.owner)
135
136def validMachineName(name):
137    """Check that name is valid for a machine name"""
138    if not name:
139        return False
140    charset = string.ascii_letters + string.digits + '-_'
141    if name[0] in '-_' or len(name) > 22:
142        return False
143    for x in name:
144        if x not in charset:
145            return False
146    return True
147
148def validMemory(owner, g, memory, machine=None, on=True):
149    """Parse and validate limits for memory for a given owner and machine.
150
151    on is whether the memory must be valid after the machine is
152    switched on.
153    """
154    try:
155        memory = int(memory)
156        if memory < MIN_MEMORY_SINGLE:
157            raise ValueError
158    except ValueError:
159        raise InvalidInput('memory', memory,
160                           "Minimum %s MiB" % MIN_MEMORY_SINGLE)
161    max_val = maxMemory(owner, g, machine, on)
162    if memory > max_val:
163        raise InvalidInput('memory', memory,
164                           'Maximum %s MiB for %s' % (max_val, owner))
165    return memory
166
167def validDisk(owner, disk, machine=None):
168    """Parse and validate limits for disk for a given owner and machine."""
169    try:
170        disk = float(disk)
171        if disk > maxDisk(owner, machine):
172            raise InvalidInput('disk', disk,
173                               "Maximum %s G" % maxDisk(owner, machine))
174        disk = int(disk * 1024)
175        if disk < MIN_DISK_SINGLE * 1024:
176            raise ValueError
177    except ValueError:
178        raise InvalidInput('disk', disk,
179                           "Minimum %s GiB" % MIN_DISK_SINGLE)
180    return disk
181
182def validVmType(vm_type):
183    if vm_type is None:
184        return None
185    t = Type.get(vm_type)
186    if t is None:
187        raise CodeError("Invalid vm type '%s'"  % vm_type)
188    return t
189
190def testMachineId(user, machine_id, exists=True):
191    """Parse, validate and check authorization for a given user and machine.
192
193    If exists is False, don't check that it exists.
194    """
195    if machine_id is None:
196        raise InvalidInput('machine_id', machine_id,
197                           "Must specify a machine ID.")
198    try:
199        machine_id = int(machine_id)
200    except ValueError:
201        raise InvalidInput('machine_id', machine_id, "Must be an integer.")
202    machine = Machine.get(machine_id)
203    if exists and machine is None:
204        raise InvalidInput('machine_id', machine_id, "Does not exist.")
205    if machine is not None and not haveAccess(user, machine):
206        raise InvalidInput('machine_id', machine_id,
207                           "You do not have access to this machine.")
208    return machine
209
210def testAdmin(user, admin, machine):
211    """Determine whether a user can set the admin of a machine to this value.
212
213    Return the value to set the admin field to (possibly 'system:' +
214    admin).  XXX is modifying this a good idea?
215    """
216    if admin is None:
217        return None
218    if machine is not None and admin == machine.administrator:
219        return None
220    if admin == user:
221        return admin
222    if ':' not in admin:
223        if cache_acls.isUser(admin):
224            return admin
225        admin = 'system:' + admin
226    try:
227        if user in getafsgroups.getAfsGroupMembers(admin, 'athena.mit.edu'):
228            return admin
229    except getafsgroups.AfsProcessError, e:
230        errmsg = str(e)
231        if errmsg.startswith("pts: User or group doesn't exist"):
232            errmsg = 'The group "%s" does not exist.' % admin
233        raise InvalidInput('administrator', admin, errmsg)
234    #XXX Should we require that user is in the admin group?
235    return admin
236
237def testOwner(user, owner, machine=None):
238    """Determine whether a user can set the owner of a machine to this value.
239
240    If machine is None, this is the owner of a new machine.
241    """
242    if owner == user:
243        return owner
244    if machine is not None and owner in (machine.owner, None):
245        return machine.owner
246    if owner is None:
247        raise InvalidInput('owner', owner, "Owner must be specified")
248    try:
249        if user not in cache_acls.expandLocker(owner):
250            raise InvalidInput('owner', owner, 'You do not have access to the '
251                               + owner + ' locker')
252    except getafsgroups.AfsProcessError, e:
253        raise InvalidInput('owner', owner, str(e))
254    return owner
255
256def testContact(user, contact, machine=None):
257    if contact is None or (machine is not None and contact == machine.contact):
258        return None
259    if not re.match("^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$", contact, re.I):
260        raise InvalidInput('contact', contact, "Not a valid email.")
261    return contact
262
263def testDisk(user, disksize, machine=None):
264    return disksize
265
266def testName(user, name, machine=None):
267    if name is None:
268        return None
269    if machine is not None and name == machine.name:
270        return None
271    if not Machine.select_by(name=name):
272        if not validMachineName(name):
273            raise InvalidInput('name', name, 'You must provide a machine name.  Max 22 chars, alnum plus \'-\' and \'_\'.')
274        return name
275    raise InvalidInput('name', name, "Name is already taken.")
276
277def testDescription(user, description, machine=None):
278    if description is None or description.strip() == '':
279        return None
280    return description.strip()
281
282def testHostname(user, hostname, machine):
283    for nic in machine.nics:
284        if hostname == nic.hostname:
285            return hostname
286    # check if doesn't already exist
287    if NIC.select_by(hostname=hostname):
288        raise InvalidInput('hostname', hostname,
289                           "Already exists")
290    if not re.match("^[A-Z0-9-]{1,22}$", hostname, re.I):
291        raise InvalidInput('hostname', hostname, "Not a valid hostname; "
292                           "must only use number, letters, and dashes.")
293    return hostname
Note: See TracBrowser for help on using the repository browser.