Add a description field.
[invirt/packages/invirt-web.git] / code / controls.py
1 """
2 Functions to perform remctls.
3 """
4
5 from sipb_xen_database import Machine, Disk, Type, NIC, CDROM, ctx, meta
6 import validation
7 from webcommon import CodeError, InvalidInput
8 import random
9 import subprocess
10 import sys
11 import time
12 import re
13 import cache_acls
14 import yaml
15
16 # ... and stolen from xend/uuid.py
17 def randomUUID():
18     """Generate a random UUID."""
19
20     return [ random.randint(0, 255) for _ in range(0, 16) ]
21
22 def uuidToString(u):
23     """Turn a numeric UUID to a hyphen-seperated one."""
24     return "-".join(["%02x" * 4, "%02x" * 2, "%02x" * 2, "%02x" * 2,
25                      "%02x" * 6]) % tuple(u)
26 # end stolen code
27
28 def kinit(username = 'daemon/sipb-xen.mit.edu', keytab = '/etc/sipb-xen.keytab'):
29     """Kinit with a given username and keytab"""
30
31     p = subprocess.Popen(['kinit', "-k", "-t", keytab, username],
32                          stderr=subprocess.PIPE)
33     e = p.wait()
34     if e:
35         raise CodeError("Error %s in kinit: %s" % (e, p.stderr.read()))
36
37 def checkKinit():
38     """If we lack tickets, kinit."""
39     p = subprocess.Popen(['klist', '-s'])
40     if p.wait():
41         kinit()
42
43 def remctl(*args, **kws):
44     """Perform a remctl and return the output.
45
46     kinits if necessary, and outputs errors to stderr.
47     """
48     checkKinit()
49     p = subprocess.Popen(['remctl', 'remote.mit.edu']
50                          + list(args),
51                          stdout=subprocess.PIPE,
52                          stderr=subprocess.PIPE)
53     v = p.wait()
54     if kws.get('err'):
55         return p.stdout.read(), p.stderr.read()
56     if v:
57         print >> sys.stderr, 'Error', v, 'on remctl', args, ':'
58         print >> sys.stderr, p.stderr.read()
59         raise CodeError('ERROR on remctl')
60     return p.stdout.read()
61
62 def lvcreate(machine, disk):
63     """Create a single disk for a machine"""
64     remctl('web', 'lvcreate', machine.name,
65            disk.guest_device_name, str(disk.size))
66     
67 def makeDisks(machine):
68     """Update the lvm partitions to add a disk."""
69     for disk in machine.disks:
70         lvcreate(machine, disk)
71
72 def lvcopy(machine_orig_name, machine, rootpw):
73     """Copy a golden image onto a machine's disk"""
74     remctl('web', 'lvcopy', machine_orig_name, machine.name, rootpw)
75
76 def bootMachine(machine, cdtype):
77     """Boot a machine with a given boot CD.
78
79     If cdtype is None, give no boot cd.  Otherwise, it is the string
80     id of the CD (e.g. 'gutsy_i386')
81     """
82     if cdtype is not None:
83         out, err = remctl('control', machine.name, 'create', 
84                           cdtype, err=True)
85     else:
86         out, err = remctl('control', machine.name, 'create',
87                           err=True)
88     if 'already exists' in out:
89         raise InvalidInput('action', 'create',
90                            'VM %s is already on' % machine.name)
91     elif err:
92         raise CodeError('"%s" on "control %s create %s' 
93                         % (err, machine.name, cdtype))
94
95 def createVm(username, state, owner, contact, name, description, memory, disksize, machine_type, cdrom, clone_from):
96     """Create a VM and put it in the database"""
97     # put stuff in the table
98     transaction = ctx.current.create_transaction()
99     try:
100         validation.Validate(username, state, name=name, description=description, owner=owner, memory=memory, disksize=disksize/1024.)
101         res = meta.engine.execute('select nextval('
102                                   '\'"machines_machine_id_seq"\')')
103         id = res.fetchone()[0]
104         machine = Machine()
105         machine.machine_id = id
106         machine.name = name
107         machine.description = description
108         machine.memory = memory
109         machine.owner = owner
110         machine.administrator = owner
111         machine.contact = contact
112         machine.uuid = uuidToString(randomUUID())
113         machine.boot_off_cd = True
114         machine.type_id = machine_type.type_id
115         ctx.current.save(machine)
116         disk = Disk(machine_id=machine.machine_id,
117                     guest_device_name='hda', size=disksize)
118         open_nics = NIC.select_by(machine_id=None)
119         if not open_nics: #No IPs left!
120             raise CodeError("No IP addresses left!  "
121                             "Contact xvm@mit.edu.")
122         nic = open_nics[0]
123         nic.machine_id = machine.machine_id
124         nic.hostname = name
125         ctx.current.save(nic)
126         ctx.current.save(disk)
127         cache_acls.refreshMachine(machine)
128         transaction.commit()
129     except:
130         transaction.rollback()
131         raise
132     makeDisks(machine)
133     if clone_from:
134         lvcopy(clone_from, machine, 'password')
135     # tell it to boot with cdrom
136     bootMachine(machine, cdrom)
137     return machine
138
139 def getList():
140     """Return a dictionary mapping machine names to dicts."""
141     value_string = remctl('web', 'listvms')
142     value_dict = yaml.load(value_string, yaml.CSafeLoader)
143     return value_dict
144
145 def parseStatus(s):
146     """Parse a status string into nested tuples of strings.
147
148     s = output of xm list --long <machine_name>
149     """
150     values = re.split('([()])', s)
151     stack = [[]]
152     for v in values[2:-2]: #remove initial and final '()'
153         if not v:
154             continue
155         v = v.strip()
156         if v == '(':
157             stack.append([])
158         elif v == ')':
159             if len(stack[-1]) == 1:
160                 stack[-1].append('')
161             stack[-2].append(stack[-1])
162             stack.pop()
163         else:
164             if not v:
165                 continue
166             stack[-1].extend(v.split())
167     return stack[-1]
168
169 def statusInfo(machine):
170     """Return the status list for a given machine.
171
172     Gets and parses xm list --long
173     """
174     value_string, err_string = remctl('control', machine.name, 'list-long', 
175                                       err=True)
176     if 'Unknown command' in err_string:
177         raise CodeError("ERROR in remctl list-long %s is not registered" % 
178                         (machine.name,))
179     elif 'does not exist' in err_string:
180         return None
181     elif err_string:
182         raise CodeError("ERROR in remctl list-long %s:  %s" % 
183                         (machine.name, err_string))
184     status = parseStatus(value_string)
185     return status
186
187 def deleteVM(machine):
188     """Delete a VM."""
189     remctl('control', machine.name, 'destroy', err=True)
190     transaction = ctx.current.create_transaction()
191     delete_disk_pairs = [(machine.name, d.guest_device_name) 
192                          for d in machine.disks]
193     try:
194         for nic in machine.nics:
195             nic.machine_id = None
196             nic.hostname = None
197             ctx.current.save(nic)
198         for disk in machine.disks:
199             ctx.current.delete(disk)
200         ctx.current.delete(machine)
201         transaction.commit()
202     except:
203         transaction.rollback()
204         raise
205     for mname, dname in delete_disk_pairs:
206         remctl('web', 'lvremove', mname, dname)
207
208 def commandResult(username, state, fields):
209     start_time = 0
210     machine = validation.Validate(username, state, machine_id=fields.getfirst('machine_id')).machine
211     action = fields.getfirst('action')
212     cdrom = fields.getfirst('cdrom')
213     if cdrom is not None and not CDROM.get(cdrom):
214         raise CodeError("Invalid cdrom type '%s'" % cdrom)    
215     if action not in ('Reboot', 'Power on', 'Power off', 'Shutdown', 
216                       'Delete VM'):
217         raise CodeError("Invalid action '%s'" % action)
218     if action == 'Reboot':
219         if cdrom is not None:
220             out, err = remctl('control', machine.name, 'reboot', cdrom,
221                               err=True)
222         else:
223             out, err = remctl('control', machine.name, 'reboot',
224                               err=True)
225         if err:
226             if re.match("Error: Domain '.*' does not exist.", err):
227                 raise InvalidInput("action", "reboot", 
228                                    "Machine is not on")
229             else:
230                 print >> sys.stderr, 'Error on reboot:'
231                 print >> sys.stderr, err
232                 raise CodeError('ERROR on remctl')
233                 
234     elif action == 'Power on':
235         if validation.maxMemory(username, state, machine) < machine.memory:
236             raise InvalidInput('action', 'Power on',
237                                "You don't have enough free RAM quota "
238                                "to turn on this machine.")
239         bootMachine(machine, cdrom)
240     elif action == 'Power off':
241         out, err = remctl('control', machine.name, 'destroy', err=True)
242         if err:
243             if re.match("Error: Domain '.*' does not exist.", err):
244                 raise InvalidInput("action", "Power off", 
245                                    "Machine is not on.")
246             else:
247                 print >> sys.stderr, 'Error on power off:'
248                 print >> sys.stderr, err
249                 raise CodeError('ERROR on remctl')
250     elif action == 'Shutdown':
251         out, err = remctl('control', machine.name, 'shutdown', err=True)
252         if err:
253             if re.match("Error: Domain '.*' does not exist.", err):
254                 raise InvalidInput("action", "Shutdown", 
255                                    "Machine is not on.")
256             else:
257                 print >> sys.stderr, 'Error on Shutdown:'
258                 print >> sys.stderr, err
259                 raise CodeError('ERROR on remctl')
260     elif action == 'Delete VM':
261         deleteVM(machine)
262
263     d = dict(user=username,
264              command=action,
265              machine=machine)
266     return d
267
268 def resizeDisk(machine_name, disk_name, new_size):
269     remctl("web", "lvresize", machine_name, disk_name, new_size)
270
271 def renameMachine(machine, old_name, new_name):
272     for disk in machine.disks:
273         remctl("web", "lvrename", old_name, 
274                disk.guest_device_name, new_name)
275