Remove extraneous whitespace and add documentation

svn path=/trunk/packages/sipb-xen-www/; revision=438

diff --git a/code/main.py b/code/main.py
index df2ef4e..9caf7c4 100755 (executable)
--- a/code/main.py
+++ b/code/main.py
@@ -59,8 +59,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):

@@ -142,12 +142,12 @@ def parseCreate(user, fields):
     if Machine.get_by(name=name):
         raise InvalidInput('name', name,
                            "Name already exists.")
     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)
 
     disk_size = fields.getfirst('disk')
     disk_size = validation.validDisk(owner, disk_size)
 

@@ -161,7 +161,7 @@ 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,
                 owner=owner, machine_type=vm_type, cdrom=cdrom, clone_from=clone_from)
 
     return dict(contact=user, name=name, memory=memory, disk_size=disk_size,
                 owner=owner, machine_type=vm_type, cdrom=cdrom, clone_from=clone_from)
 

@@ -186,6 +186,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 = {}

@@ -228,7 +229,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.
 

@@ -240,9 +241,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
 

@@ -250,7 +251,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 = {}

@@ -263,10 +264,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,

@@ -276,6 +277,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:

@@ -317,7 +322,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

@@ -352,6 +357,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:

@@ -369,7 +378,7 @@ 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

- 
+

         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)

@@ -378,7 +387,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:

@@ -387,7 +396,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:

@@ -400,7 +409,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:

@@ -419,13 +428,13 @@ 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="""
 ParaVM machines do not support local console access over VNC.  To
 access the serial console of these machines, you can SSH with Kerberos
     help_mapping = dict(paravm_console="""
 ParaVM machines do not support local console access over VNC.  To
 access the serial console of these machines, you can SSH with Kerberos

@@ -460,22 +469,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)

@@ -522,14 +533,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:

@@ -583,6 +594,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

@@ -593,7 +605,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)