Add a firmware downloader

To make keeping firmware up-to-date even easier, add a script that
downloads the latest firmware. Data about this firmware is fetched from
the github repo of this project. It is also used by
Ilo.update_rib_firmware(): if the filename passed to this function is
"latest", it will download and use the latest firmware.

Author: seveas

.gitignore

@@ -4,3 +4,5 @@ build
 dist
 MANIFEST
 hp
+*.bin
+*.scexe

firmware.conf

@@ -0,0 +1,11 @@
+[ilo2]
+version = 2.09
+released = 2012-06-04
+url = http://ftp.hp.com/pub/softlib2/software1/sc-linux-fw-ilo/p1285463034/v75848/CP017013.scexe
+file = ilo2_209.bin
+
+[ilo3]
+version = 1.28
+released = 2012-03-06
+url = http://ftp.hp.com/pub/softlib2/software1/sc-linux-fw-ilo/p1255562964/v73832/CP016462.scexe
+file = ilo3_128.bin

hpilo.py

@@ -25,6 +25,7 @@ def wrap_socket(sock, *args, **kwargs):
     import xml.etree.cElementTree as etree
 except ImportError:
     import cElementTree as etree
+import hpilo_fw
 
 # Which protocol to use
 ILO_RAW  = 1
@@ -950,10 +951,25 @@ def uid_control(self, uid="No"):
         return self._control_tag('SERVER_INFO', 'UID_CONTROL', attrib={"UID": uid.title()})
 
     def update_rib_firmware(self, filename, progress=None):
-        """Upload new RIB firmware"""
+        """Upload new RIB firmware, use "latest" as filename to automatically
+        download and use the latest firmware"""
         if not self.protocol:
             self._detect_protocol()
 
+        if self.protocol == 'ILO_LOCAL':
+            raise ValueError("Cannot update iLO firmware using hponcfg")
+
+        if filename == 'latest':
+            config = hpilo_fw.config()
+            current = self.get_fw_version()
+            ilo = current['management_processor'].lower()
+            if ilo not in config:
+                raise IloError("Cannot update %s to the latest version automatically" % ilo)
+            if current['firmware_version'] >= config[ilo]['version']:
+                return "Already up-to-date"
+            hpilo_fw.download(ilo)
+            filename = config[ilo]['file']
+
         if progress:
             def progress_(data):
                 if data is None:

hpilo_fw.py

@@ -0,0 +1,76 @@
+# Downloader / extracter for latest iLO2 / iLO3 firmware
+
+import tarfile
+import os
+import sys
+PY3 = sys.version_info[0] >= 3
+
+if PY3:
+    import urllib.request as urllib2
+    import configparser as ConfigParser
+    import io as StringIO
+    b = bytes
+else:
+    import urllib2
+    import ConfigParser
+    import StringIO
+    b = lambda x: x
+
+_config = None
+def config():
+    global _config
+    if not _config:
+        conf = _download('https://raw.github.com/seveas/python-hpilo/master/firmware.conf').decode('ascii')
+        parser = ConfigParser.ConfigParser()
+        parser.readfp(StringIO.StringIO(conf))
+        _config = {}
+        for section in parser.sections():
+            _config[section] = {}
+            for option in parser.options(section):
+                _config[section][option] = parser.get(section, option)
+    return _config
+
+def _download(url):
+    req = urllib2.urlopen(url)
+    size = int(req.headers['Content-Length'])
+    if size < 4096:
+        return req.read()
+    downloaded = 0
+    data = b('')
+    while downloaded < size:
+        new = req.read(4096)
+        data += new
+        downloaded += len(new)
+        sys.stdout.write('\r\033[K%d/%d (%d%%)' % (downloaded, size, downloaded*100.0/size))
+        sys.stdout.flush()
+    print("")
+    return data
+
+def download(ilo, path=None):
+    if not path:
+        path = os.getcwd()
+    conf = config()
+    if os.path.exists(os.path.join(path, conf[ilo]['file'])):
+        return
+    print("Downloading %s firmware version %s" % (ilo, conf[ilo]['version']))
+    scexe = _download(conf[ilo]['url'])
+
+    # An scexe is a shell script with an embedded compressed tarball. Find the tarball.
+    skip_start = scexe.index(b('_SKIP=')) + 6
+    skip_end = scexe.index('\n', skip_start)
+    skip = int(scexe[skip_start:skip_end]) - 1
+    tarball = scexe.split('\n', skip)[-1]
+
+    # Now uncompress it
+    if tarball[:2] != '\x1f\x8b':
+        raise ValueError("Downloaded scexe file seems corrupt")
+    
+    tf = tarfile.open(fileobj=StringIO.StringIO(tarball), mode='r:gz')
+    tf.extract(conf[ilo]['file'], path)
+
+if __name__ == '__main__':
+    path = os.getcwd()
+    if len(sys.argv) > 1:
+        path =  sys.argv[1]
+    conf = config()
+    [download(x, path) for x in conf]

setup.py

@@ -8,7 +8,7 @@
       author_email = "[email protected]",
       url = "http://github.com/seveas/python-hpilo",
       description = "Accessing HP iLO interfaces from python",
-      py_modules = ["hpilo"],
+      py_modules = ["hpilo", "hpilo_fw"],
       scripts = ["hpilo_cli", "hpilo_ca"],
       classifiers = [
         'Development Status :: 5 - Production/Stable',