keep help page at a readable width

[invirt/packages/invirt-web.git] / code / main.py

diff --git a/code/main.py b/code/main.py
index c419f32..3fe04d5 100755 (executable)
--- a/code/main.py
+++ b/code/main.py
@@ -36,7 +36,8 @@ sys.path.append('/home/ecprice/.local/lib/python2.5/site-packages')
 
 import templates
 from Cheetah.Template import Template
 
 import templates
 from Cheetah.Template import Template

-from sipb_xen_database import Machine, CDROM, ctx, connect, MachineAccess
+import sipb_xen_database
+from sipb_xen_database import Machine, CDROM, ctx, connect, MachineAccess, Type, Autoinstall

 import validation
 from webcommon import InvalidInput, CodeError, g
 import controls
 import validation
 from webcommon import InvalidInput, CodeError, g
 import controls

@@ -59,8 +60,8 @@ checkpoint = Checkpoint()
 
 def helppopup(subj):
     """Return HTML code for a (?) link to a specified help topic"""
 
 def helppopup(subj):
     """Return HTML code for a (?) link to a specified help topic"""

-    return ('<span class="helplink"><a href="help?subject=' + subj + 
-            '&amp;simple=true" target="_blank" ' + 
+    return ('<span class="helplink"><a href="help?subject=' + subj +
+            '&amp;simple=true" target="_blank" ' +

             'onclick="return helppopup(\'' + subj + '\')">(?)</a></span>')
 
 def makeErrorPre(old, addition):
             'onclick="return helppopup(\'' + subj + '\')">(?)</a></span>')
 
 def makeErrorPre(old, addition):

@@ -71,6 +72,7 @@ def makeErrorPre(old, addition):
     else:
         return '<p>STDERR:</p><pre>' + str(addition) + '</pre>'
 
     else:
         return '<p>STDERR:</p><pre>' + str(addition) + '</pre>'
 

+Template.sipb_xen_database = sipb_xen_database

 Template.helppopup = staticmethod(helppopup)
 Template.err = None
 
 Template.helppopup = staticmethod(helppopup)
 Template.err = None
 

@@ -96,9 +98,10 @@ class Defaults:
     memory = 256
     disk = 4.0
     cdrom = ''
     memory = 256
     disk = 4.0
     cdrom = ''

+    autoinstall = ''

     name = ''
     name = ''

-    vmtype = 'hvm'

     def __init__(self, max_memory=None, max_disk=None, **kws):
     def __init__(self, max_memory=None, max_disk=None, **kws):

+        self.type = Type.get('linux-hvm')

         if max_memory is not None:
             self.memory = min(self.memory, max_memory)
         if max_disk is not None:
         if max_memory is not None:
             self.memory = min(self.memory, max_memory)
         if max_disk is not None:

@@ -136,25 +139,23 @@ def hasVnc(status):
 def parseCreate(user, fields):
     name = fields.getfirst('name')
     if not validation.validMachineName(name):
 def parseCreate(user, fields):
     name = fields.getfirst('name')
     if not validation.validMachineName(name):

-        raise InvalidInput('name', name, 'You must provide a machine name.')
+        raise InvalidInput('name', name, 'You must provide a machine name.  Max 22 chars, alnum plus \'-\' and \'_\'.')

     name = name.lower()
 
     if Machine.get_by(name=name):
         raise InvalidInput('name', name,
                            "Name already exists.")
     name = name.lower()
 
     if Machine.get_by(name=name):
         raise InvalidInput('name', name,
                            "Name already exists.")

-    
+

     owner = validation.testOwner(user, fields.getfirst('owner'))
 
     memory = fields.getfirst('memory')
     memory = validation.validMemory(owner, memory, on=True)
     owner = validation.testOwner(user, fields.getfirst('owner'))
 
     memory = fields.getfirst('memory')
     memory = validation.validMemory(owner, memory, on=True)

-    
+

     disk_size = fields.getfirst('disk')
     disk_size = validation.validDisk(owner, disk_size)
 
     vm_type = fields.getfirst('vmtype')
     disk_size = fields.getfirst('disk')
     disk_size = validation.validDisk(owner, disk_size)
 
     vm_type = fields.getfirst('vmtype')

-    if vm_type not in ('hvm', 'paravm'):
-        raise CodeError("Invalid vm type '%s'"  % vm_type)    
-    is_hvm = (vm_type == 'hvm')
+    vm_type = validation.validVmType(vm_type)

 
     cdrom = fields.getfirst('cdrom')
     if cdrom is not None and not CDROM.get(cdrom):
 
     cdrom = fields.getfirst('cdrom')
     if cdrom is not None and not CDROM.get(cdrom):

@@ -163,9 +164,9 @@ def parseCreate(user, fields):
     clone_from = fields.getfirst('clone_from')
     if clone_from and clone_from != 'ice3':
         raise CodeError("Invalid clone image '%s'" % clone_from)
     clone_from = fields.getfirst('clone_from')
     if clone_from and clone_from != 'ice3':
         raise CodeError("Invalid clone image '%s'" % clone_from)

-    
+

     return dict(contact=user, name=name, memory=memory, disk_size=disk_size,
     return dict(contact=user, name=name, memory=memory, disk_size=disk_size,

-                owner=owner, is_hvm=is_hvm, cdrom=cdrom, clone_from=clone_from)
+                owner=owner, machine_type=vm_type, cdrom=cdrom, clone_from=clone_from)

 
 def create(user, fields):
     """Handler for create requests."""
 
 def create(user, fields):
     """Handler for create requests."""

@@ -188,6 +189,7 @@ def create(user, fields):
 
 
 def getListDict(user):
 
 
 def getListDict(user):

+    """Gets the list of local variables used by list.tmpl."""

     machines = g.machines
     checkpoint.checkpoint('Got my machines')
     on = {}
     machines = g.machines
     checkpoint.checkpoint('Got my machines')
     on = {}

@@ -220,8 +222,7 @@ def getListDict(user):
              defaults=defaults,
              machines=machines,
              has_vnc=has_vnc,
              defaults=defaults,
              machines=machines,
              has_vnc=has_vnc,

-             uptimes=g.uptimes,
-             cdroms=CDROM.select())
+             uptimes=g.uptimes)

     return d
 
 def listVms(user, fields):
     return d
 
 def listVms(user, fields):

@@ -230,7 +231,7 @@ def listVms(user, fields):
     d = getListDict(user)
     checkpoint.checkpoint('Got list dict')
     return templates.list(searchList=[d])
     d = getListDict(user)
     checkpoint.checkpoint('Got list dict')
     return templates.list(searchList=[d])

-            
+

 def vnc(user, fields):
     """VNC applet page.
 
 def vnc(user, fields):
     """VNC applet page.
 

@@ -242,9 +243,9 @@ def vnc(user, fields):
     You might want iptables like:
 
     -t nat -A PREROUTING -s ! 18.181.0.60 -i eth1 -p tcp -m tcp \
     You might want iptables like:
 
     -t nat -A PREROUTING -s ! 18.181.0.60 -i eth1 -p tcp -m tcp \

-      --dport 10003 -j DNAT --to-destination 18.181.0.60:10003 
+      --dport 10003 -j DNAT --to-destination 18.181.0.60:10003

     -t nat -A POSTROUTING -d 18.181.0.60 -o eth1 -p tcp -m tcp \
     -t nat -A POSTROUTING -d 18.181.0.60 -o eth1 -p tcp -m tcp \

-      --dport 10003 -j SNAT --to-source 18.187.7.142 
+      --dport 10003 -j SNAT --to-source 18.187.7.142

     -A FORWARD -d 18.181.0.60 -i eth1 -o eth1 -p tcp -m tcp \
       --dport 10003 -j ACCEPT
 
     -A FORWARD -d 18.181.0.60 -i eth1 -o eth1 -p tcp -m tcp \
       --dport 10003 -j ACCEPT
 

@@ -252,7 +253,7 @@ def vnc(user, fields):
     echo 1 > /proc/sys/net/ipv4/ip_forward
     """
     machine = validation.testMachineId(user, fields.getfirst('machine_id'))
     echo 1 > /proc/sys/net/ipv4/ip_forward
     """
     machine = validation.testMachineId(user, fields.getfirst('machine_id'))

-    
+

     TOKEN_KEY = "0M6W0U1IXexThi5idy8mnkqPKEq1LtEnlK/pZSn0cDrN"
 
     data = {}
     TOKEN_KEY = "0M6W0U1IXexThi5idy8mnkqPKEq1LtEnlK/pZSn0cDrN"
 
     data = {}

@@ -265,10 +266,10 @@ def vnc(user, fields):
     token = {'data': pickled_data, 'digest': m.digest()}
     token = cPickle.dumps(token)
     token = base64.urlsafe_b64encode(token)
     token = {'data': pickled_data, 'digest': m.digest()}
     token = cPickle.dumps(token)
     token = base64.urlsafe_b64encode(token)

-    
+

     status = controls.statusInfo(machine)
     has_vnc = hasVnc(status)
     status = controls.statusInfo(machine)
     has_vnc = hasVnc(status)

-    
+

     d = dict(user=user,
              on=status,
              has_vnc=has_vnc,
     d = dict(user=user,
              on=status,
              has_vnc=has_vnc,

@@ -278,6 +279,10 @@ def vnc(user, fields):
     return templates.vnc(searchList=[d])
 
 def getHostname(nic):
     return templates.vnc(searchList=[d])
 
 def getHostname(nic):

+    """Find the hostname associated with a NIC.
+
+    XXX this should be merged with the similar logic in DNS and DHCP.
+    """

     if nic.hostname and '.' in nic.hostname:
         return nic.hostname
     elif nic.machine:
     if nic.hostname and '.' in nic.hostname:
         return nic.hostname
     elif nic.machine:

@@ -319,7 +324,7 @@ def getDiskInfo(data_dict, machine):
     disk_fields = []
     for disk in machine.disks:
         name = disk.guest_device_name
     disk_fields = []
     for disk in machine.disks:
         name = disk.guest_device_name

-        disk_fields.extend([(x % name, y % name) for x, y in 
+        disk_fields.extend([(x % name, y % name) for x, y in

                             disk_fields_template])
         data_dict['%s_size' % name] = "%0.1f GiB" % (disk.size / 1024.)
     return disk_fields
                             disk_fields_template])
         data_dict['%s_size' % name] = "%0.1f GiB" % (disk.size / 1024.)
     return disk_fields

@@ -354,6 +359,10 @@ def command(user, fields):
         raise InvalidInput('back', back, 'Not a known back page.')
 
 def modifyDict(user, fields):
         raise InvalidInput('back', back, 'Not a known back page.')
 
 def modifyDict(user, fields):

+    """Modify a machine as specified by CGI arguments.
+
+    Return a list of local variables for modify.tmpl.
+    """

     olddisk = {}
     transaction = ctx.current.create_transaction()
     try:
     olddisk = {}
     transaction = ctx.current.create_transaction()
     try:

@@ -371,7 +380,11 @@ def modifyDict(user, fields):
         if memory is not None:
             memory = validation.validMemory(user, memory, machine, on=False)
             machine.memory = memory
         if memory is not None:
             memory = validation.validMemory(user, memory, machine, on=False)
             machine.memory = memory

- 
+
+        vm_type = validation.validVmType(fields.getfirst('vmtype'))
+        if vm_type is not None:
+            machine.type = vm_type
+

         disksize = validation.testDisk(user, fields.getfirst('disk'))
         if disksize is not None:
             disksize = validation.validDisk(user, disksize, machine)
         disksize = validation.testDisk(user, fields.getfirst('disk'))
         if disksize is not None:
             disksize = validation.validDisk(user, disksize, machine)

@@ -380,7 +393,7 @@ def modifyDict(user, fields):
                 olddisk[disk.guest_device_name] = disksize
                 disk.size = disksize
                 ctx.current.save(disk)
                 olddisk[disk.guest_device_name] = disksize
                 disk.size = disksize
                 ctx.current.save(disk)

-        
+

         if owner is not None:
             machine.owner = owner
         if name is not None:
         if owner is not None:
             machine.owner = owner
         if name is not None:

@@ -389,7 +402,7 @@ def modifyDict(user, fields):
             machine.administrator = admin
         if contact is not None:
             machine.contact = contact
             machine.administrator = admin
         if contact is not None:
             machine.contact = contact

-            
+

         ctx.current.save(machine)
         transaction.commit()
     except:
         ctx.current.save(machine)
         transaction.commit()
     except:

@@ -402,7 +415,7 @@ def modifyDict(user, fields):
     return dict(user=user,
                 command=command,
                 machine=machine)
     return dict(user=user,
                 command=command,
                 machine=machine)

-    
+

 def modify(user, fields):
     """Handler for modifying attributes of a machine."""
     try:
 def modify(user, fields):
     """Handler for modifying attributes of a machine."""
     try:

@@ -421,17 +434,18 @@ def modify(user, fields):
             setattr(info_dict['defaults'], field, fields.getfirst(field))
     info_dict['result'] = result
     return templates.info(searchList=[info_dict])
             setattr(info_dict['defaults'], field, fields.getfirst(field))
     info_dict['result'] = result
     return templates.info(searchList=[info_dict])

-    
+

 
 def helpHandler(user, fields):
     """Handler for help messages."""
     simple = fields.getfirst('simple')
     subjects = fields.getlist('subject')
 
 def helpHandler(user, fields):
     """Handler for help messages."""
     simple = fields.getfirst('simple')
     subjects = fields.getlist('subject')

-    
+

     help_mapping = dict(paravm_console="""
     help_mapping = dict(paravm_console="""

-ParaVM machines do not support console access over VNC.  To access
-these machines, you either need to boot with a liveCD and ssh in or
-hope that the sipb-xen maintainers add support for serial consoles.""",
+ParaVM machines do not support local console access over VNC.  To
+access the serial console of these machines, you can SSH with Kerberos
+to sipb-xen-console.mit.edu, using the name of the machine as your
+username.""",

                         hvm_paravm="""
 HVM machines use the virtualization features of the processor, while
 ParaVM machines use Xen's emulation of virtualization features.  You
                         hvm_paravm="""
 HVM machines use the virtualization features of the processor, while
 ParaVM machines use Xen's emulation of virtualization features.  You

@@ -443,8 +457,8 @@ The owner field is used to determine <a
 href="help?subject=quotas">quotas</a>.  It must be the name of a
 locker that you are an AFS administrator of.  In particular, you or an
 AFS group you are a member of must have AFS rlidwka bits on the
 href="help?subject=quotas">quotas</a>.  It must be the name of a
 locker that you are an AFS administrator of.  In particular, you or an
 AFS group you are a member of must have AFS rlidwka bits on the

-locker.  You can check see who administers the LOCKER locker using the
-command 'fs la /mit/LOCKER' on Athena.)  See also <a
+locker.  You can check who administers the LOCKER locker using the
+commands 'attach LOCKER; fs la /mit/LOCKER' on Athena.)  See also <a

 href="help?subject=administrator">administrator</a>.""",
                         administrator="""
 The administrator field determines who can access the console and
 href="help?subject=administrator">administrator</a>.""",
                         administrator="""
 The administrator field determines who can access the console and

@@ -461,22 +475,24 @@ your machine will run just fine, but the applet's display of the
 console will suffer artifacts.
 """
                    )
 console will suffer artifacts.
 """
                    )

-    
+

     if not subjects:
         subjects = sorted(help_mapping.keys())
     if not subjects:
         subjects = sorted(help_mapping.keys())

-        
+

     d = dict(user=user,
              simple=simple,
              subjects=subjects,
              mapping=help_mapping)
     d = dict(user=user,
              simple=simple,
              subjects=subjects,
              mapping=help_mapping)

-    
+

     return templates.help(searchList=[d])
     return templates.help(searchList=[d])

-    
+

 
 def badOperation(u, e):
 
 def badOperation(u, e):

+    """Function called when accessing an unknown URI."""

     raise CodeError("Unknown operation")
 
 def infoDict(user, machine):
     raise CodeError("Unknown operation")
 
 def infoDict(user, machine):

+    """Get the variables used by info.tmpl."""

     status = controls.statusInfo(machine)
     checkpoint.checkpoint('Getting status info')
     has_vnc = hasVnc(status)
     status = controls.statusInfo(machine)
     checkpoint.checkpoint('Getting status info')
     has_vnc = hasVnc(status)

@@ -523,14 +539,14 @@ def infoDict(user, machine):
 
     nic_fields = getNicInfo(machine_info, machine)
     nic_point = display_fields.index('NIC_INFO')
 
     nic_fields = getNicInfo(machine_info, machine)
     nic_point = display_fields.index('NIC_INFO')

-    display_fields = (display_fields[:nic_point] + nic_fields + 
+    display_fields = (display_fields[:nic_point] + nic_fields +

                       display_fields[nic_point+1:])
 
     disk_fields = getDiskInfo(machine_info, machine)
     disk_point = display_fields.index('DISK_INFO')
                       display_fields[nic_point+1:])
 
     disk_fields = getDiskInfo(machine_info, machine)
     disk_point = display_fields.index('DISK_INFO')

-    display_fields = (display_fields[:disk_point] + disk_fields + 
+    display_fields = (display_fields[:disk_point] + disk_fields +

                       display_fields[disk_point+1:])
                       display_fields[disk_point+1:])

-    
+

     main_status['memory'] += ' MiB'
     for field, disp in display_fields:
         if field in ('uptime', 'cputime') and locals()[field] is not None:
     main_status['memory'] += ' MiB'
     for field, disp in display_fields:
         if field in ('uptime', 'cputime') and locals()[field] is not None:

@@ -550,12 +566,11 @@ def infoDict(user, machine):
     checkpoint.checkpoint('Got mem')
     max_disk = validation.maxDisk(user, machine)
     defaults = Defaults()
     checkpoint.checkpoint('Got mem')
     max_disk = validation.maxDisk(user, machine)
     defaults = Defaults()

-    for name in 'machine_id name administrator owner memory contact'.split():
+    for name in 'machine_id name administrator owner memory contact type'.split():

         setattr(defaults, name, getattr(machine, name))
     defaults.disk = "%0.2f" % (machine.disks[0].size/1024.)
     checkpoint.checkpoint('Got defaults')
     d = dict(user=user,
         setattr(defaults, name, getattr(machine, name))
     defaults.disk = "%0.2f" % (machine.disks[0].size/1024.)
     checkpoint.checkpoint('Got defaults')
     d = dict(user=user,

-             cdroms=CDROM.select(),

              on=status is not None,
              machine=machine,
              defaults=defaults,
              on=status is not None,
              machine=machine,
              defaults=defaults,

@@ -584,6 +599,7 @@ mapping = dict(list=listVms,
                help=helpHandler)
 
 def printHeaders(headers):
                help=helpHandler)
 
 def printHeaders(headers):

+    """Print a dictionary as HTTP headers."""

     for key, value in headers.iteritems():
         print '%s: %s' % (key, value)
     print
     for key, value in headers.iteritems():
         print '%s: %s' % (key, value)
     print

@@ -594,7 +610,7 @@ def getUser():
     username = os.environ['SSL_CLIENT_S_DN_Email'].split("@")[0]
     return username
 
     username = os.environ['SSL_CLIENT_S_DN_Email'].split("@")[0]
     return username
 

-def main(operation, user, fields):    
+def main(operation, user, fields):

     start_time = time.time()
     fun = mapping.get(operation, badOperation)
 
     start_time = time.time()
     fun = mapping.get(operation, badOperation)