Newer
Older
# -*- python -*-
# -*- coding: utf-8 -*-
# Started 10/05/2011 by Seblu <seblu@seblu.net>
'''
Image stuff
'''
import os
import stat
import time
import json
import ConfigParser
import subprocess
import gzipstream #until python support gzip not seekable
import installsystems.template as istemplate
import installsystems.tools as istools
from installsystems.printer import *
from installsystems.tarball import Tarball
format = "1"
return re.match("\w+", buf) is not None
@staticmethod
def check_image_version(buf):
if not istools.isfile(path):
raise NotImplementedError("SourceImage must be local")
# main path
parser_path = os.path.join(path, "parser")
setup_path = os.path.join(path, "setup")
if not os.path.exists(d) or not os.path.isdir(d):
os.mkdir(d)
raise Exception("Unable to create directory: %s: %s" % (d, e))
try:
# create description example from template
open(os.path.join(path, "description"), "w").write(istemplate.description)
open(os.path.join(parser_path, "01-parser.py"), "w").write(istemplate.parser)
open(os.path.join(setup_path, "01-setup.py"), "w").write(istemplate.setup)
except Exception as e:
raise Exception("Unable to example file: %s" % e)
try:
# setting rights on files in setup and parser
for dpath in (parser_path, setup_path):
for f in os.listdir(dpath):
except Exception as e:
raise Exception("Unable to set rights on %s: %s" % (pf, e))
if not istools.isfile(path):
raise NotImplementedError("SourceImage must be local")
self.base_path = path
self.parser_path = os.path.join(path, "parser")
self.setup_path = os.path.join(path, "setup")
self.payload_path = os.path.join(path, "payload")
self.validate_source_files()
self.description = self.parse_description()
# script tarball path
self.image_name = "%s-%s%s" % (self.description["name"],
self.description["version"],
self.extension)
def validate_source_files(self):
'''
Check if we are a valid SourceImage directories
'''
for d in (self.base_path, self.parser_path, self.setup_path, self.payload_path):
if not os.path.exists(d):
raise Exception("Missing directory: %s" % d)
if not os.path.isdir(d):
raise Exception("Not a directory: %s" % d)
if not os.access(d, os.R_OK|os.X_OK):
raise Exception("Unable to access to %s" % d)
if not os.path.exists(os.path.join(self.base_path, "description")):
raise Exception("No description file")
def build(self, force=False, check=True):
# check if free to create script tarball
if os.path.exists(self.image_name) and force == False:
raise Exception("Tarball already exists. Remove it before")
# Check python file
if check:
self.check_scripts(self.parser_path)
self.check_scripts(self.setup_path)
# generate a JSON description
jdesc = self.generate_json_description(payloads)
'''
Create a script tarball in current directory
'''
# create tarball
arrow("Creating image tarball")
arrowlevel(1)
arrow("Name %s" % self.image_name)
tarball = Tarball.open(self.image_name, mode="w:gz", dereference=True)
raise Exception("Unable to create tarball %s: %s" % (self.image_name, e))
tarball.add_str("description.json", description, tarfile.REGTYPE, 0444)
tarball.add_str("format", self.format, tarfile.REGTYPE, 0444)
self._add_scripts(tarball, self.parser_path)
self._add_scripts(tarball, self.setup_path)
# closing tarball file
tarball.close()
# build list of payload files
candidates = os.listdir(self.payload_path)
return []
# create payload files
l_l = []
for pay in candidates:
source_path = os.path.join(self.payload_path, pay)
dest_path = "%s-%s-%s%s" % (self.description["name"],
self.description["version"],
pay,
Payload.extension)
source_stat = os.stat(source_path)
isdir = stat.S_ISDIR(source_stat.st_mode)
if isdir:
self._create_payload_tarball(dest_path, source_path)
else:
self._create_payload_file(dest_path, source_path)
# create payload object
payobj = Payload(pay, dest_path, isdir=isdir)
payobj.uid = source_stat.st_uid
payobj.gid = source_stat.st_gid
payobj.mode = stat.S_IMODE(source_stat.st_mode)
payobj.mtime = source_stat.st_mtime
l_l.append(payobj)
def _create_payload_tarball(self, tar_path, data_path):
'''
Create a payload tarball
This is needed by payload directory
'''
# compute dname to set as a base directory
dname = os.path.basename(data_path)
try:
tarball.add(data_path, arcname="/", recursive=True,
filter=self._create_payload_tarball_filter)
tarball.close()
except Exception as e:
raise Exception("Unable to create payload tarball %s: %s" % (tar_path, e))
def _create_payload_tarball_filter(self, tarinfo):
'''
Have the same behaviour as --numeric-owner on gnu tar
Remove string name and group to escape weird translation
'''
tarinfo.uname = ""
tarinfo.gname = ""
return tarinfo
def _create_payload_file(self, dest, source):
'''
Create a payload file
Only gzipping it
'''
fsource = istools.uopen(source)
# open file not done in GzipFile, to escape writing of filename
# in gzip file. This change md5.
fdest = open(dest, "wb")
fdest = gzip.GzipFile(filename=os.path.basename(source),
fileobj=fdest,
mtime=os.stat(source).st_mtime)
istools.copyfileobj(fsource, fdest)
fsource.close()
fdest.close()
def _add_scripts(self, tarball, directory):
Add scripts inside a directory into a tarball
basedirectory = os.path.basename(directory)
arrow("Add %s scripts" % basedirectory)
arrowlevel(1)
# adding base directory
ti = tarball.gettarinfo(directory, arcname=basedirectory)
ti.mode = 0755
ti.uid = ti.gid = 0
ti.uname = ti.gname = "root"
tarball.addfile(ti)
# adding each file
for fi in os.listdir(directory):
# check name
if not re.match("\d+-.*\.py$", fi):
debug("%s skipped: invalid name" % fi)
continue
# adding file
ti = tarball.gettarinfo(fp, arcname=os.path.join(basedirectory, fi))
ti.mode = 0755
ti.uid = ti.gid = 0
ti.uname = ti.gname = "root"
arrow("%s added" % fi)
arrowlevel(-1)
'''
Check if scripts inside a directory can be compiled
'''
basedirectory = os.path.basename(directory)
arrow("Checking %s scripts" % basedirectory)
arrowlevel(1)
# checking each file
for fi in os.listdir(directory):
# check name
if not re.match("\d+-.*\.py$", fi):
debug("%s skipped: invalid name" % fi)
continue
# compiling file
fs = open(os.path.join(directory, fi), "rb").read()
compile(fs, fi, mode="exec")
arrow(fi)
arrowlevel(-1)
def generate_json_description(self, payloads):
'''
Generate a JSON description file
'''
arrow("Generating JSON description")
arrowlevel(1)
# copy description
desc = self.description.copy()
# timestamp image
desc["payload"] = {}
for payload in payloads:
desc["payload"][payload.name] = payload.info
# serialize
return json.dumps(desc)
def parse_description(self):
'''
Raise an exception is description file is invalid and return vars to include
'''
d = dict()
try:
descpath = os.path.join(self.base_path, "description")
cp = ConfigParser.RawConfigParser()
cp.read(descpath)
for n in ("name","version", "description", "author"):
d[n] = cp.get("image", n)
except Exception as e:
def __init__(self, path, fileobj=None, md5name=False):
'''
Initialize a package image
fileobj must be a seekable fileobj
'''
self.base_path = os.path.dirname(self.path)
# tarball are named by md5 and not by real name
self.md5name = md5name
if fileobj is None:
fileobj = istools.uopen(self.path)
self._tarball = Tarball.open(fileobj=fileobj, mode='r:gz')
arrow("Image %s v%s loaded" % (self.name, self.version))
arrow("Author: %s" % self.author, 1)
arrow("Date: %s" % time.ctime(self.date), 1)
# build payloads
self.payload = {}
for pname, pval in self._metadata["payload"].items():
if self.md5name:
ppath = os.path.join(self.base_path,
self._metadata["payload"][pname]["md5"])
else:
ppath = os.path.join(self.base_path,
"%s-%s%s" % (self.id, pname, Payload.extension))
self.payload[pname] = Payload(pname, ppath, **pval)
if name in self._metadata:
return self._metadata[name]
raise AttributeError
@property
def id(self):
'''
Return image versionned name / id
'''
return "%s-%s" % (self.name, self.version)
@property
def filename(self):
return "%s%s" % (self.id, self.extension)
img_format = self._tarball.get_str("format")
img_desc = self._tarball.get_str("description.json")
if img_format != self.format:
raise Exception("Invalid tarball image format")
# FIXME: we should check valid information here
return desc
'''
Display image content
'''
out('#light##yellow#Name:#reset# %s' % self.name)
out('#light##yellow#Version:#reset# %s' % self.version)
out('#yellow#Date:#reset# %s' % time.ctime(self.date))
out('#yellow#Description:#reset# %s' % self.description)
out('#yellow#Author:#reset# %s' % self.author)
out('#yellow#MD5:#reset# %s' % self.md5)
if verbose:
payloads = self.payload
for payload_name in payloads:
payload = payloads[payload_name]
out(' #yellow#Date:#reset# %s' % time.ctime(payload.mtime))
out(' #yellow#Size:#reset# %s' % (istools.human_size(payload.size)))
out(' #yellow#MD5:#reset# %s' % payload.md5)
out('#light##yellow#Content:#reset#')
self._tarball.list(verbose)
# check image
if self.md5 != istools.md5sum(self.path):
raise Exception("Invalid MD5 of image %s" % self.name)
# check payloads
for pay_name, pay_obj in self.payload.items():
'''
Display filename in the tarball
'''
for filename in self._tarball.getnames(glob_pattern=filename):
arrow(filename)
out(self._tarball.get_str(filename))
def download(self, directory, force=False, payload=False):
'''
Download image in directory
'''
# check if destination exists
directory = os.path.abspath(directory)
dest = os.path.join(directory, self.filename)
if not force and os.path.exists(dest):
raise Exception("Image destination already exists: %s" % dest)
# download
arrow("Downloading image in %s" % directory)
fs = istools.uopen(self.path)
fd = open(self.filename, "wb")
slen, smd5 = istools.copyfileobj(fs, fd)
fs.close()
fd.close()
if self.md5 != smd5:
raise Exception("Download image %s failed: Invalid MD5" % self.name)
if payload:
for payname in self.payload:
arrow("Downloading payload %s in %s" % (payname, directory))
self.payload[payname].info
self.payload[payname].download(directory, force=force)
def extract(self, directory, force=False, payload=False):
'''
Extract content of the image inside a repository
'''
# check destination
if not os.path.isdir(directory):
istools.mkdir(directory)
if not force and len(os.listdir(directory)) != 0:
raise Exception("%s is not empty" % directory)
# extract content
arrow("Extracting image in %s" % directory)
self._tarball.extractall(directory)
# launch payload extract
if payload:
for payname in self.payload:
dest = os.path.join(directory, "payload", payname)
arrow("Extracting payload %s in %s" % (payname, dest))
self.payload[payname].extract(dest, force=force)
l_scripts = self._tarball.getnames(re_pattern="%s/.*\.py" % directory)
# order matter!
l_scripts.sort()
# run scripts
arrow(os.path.basename(n_scripts))
old_level = arrowlevel(1)
except Exception as e:
raise Exception("Extracting script %s fail: %s" %
o_scripts = compile(s_scripts, n_scripts, "exec")
except Exception as e:
raise Exception("Unable to compile %s fail: %s" %
(n_scripts, e))
# define execution context
gl = {}
for k in kwargs:
gl[k] = kwargs[k]
gl["image"] = self
# execute source code
try:
exec o_scripts in gl
except Exception as e:
raise Exception("Execution script %s fail: %s" %
class Payload(object):
'''
Payload class represents a payload object
'''
extension = ".isdata"
legit_attr = ('isdir', 'md5', 'size', 'uid', 'gid', 'mode', 'mtime')
def __init__(self, name, path, **kwargs):
object.__setattr__(self, "name", name)
object.__setattr__(self, "path", path)
# register legit param
for attr in self.legit_attr:
setattr(self, attr, None)
# set all named param
for kwarg in kwargs:
# do not use hasattr which user getattr and so call md5 checksum...
if kwarg in self.legit_attr:
setattr(self, kwarg, kwargs[kwarg])
def __getattr__(self, name):
# get all value with an understance as if there is no underscore
if hasattr(self, "_%s" % name):
return getattr(self, "_%s" % name)
raise AttributeError
def __setattr__(self, name, value):
# set all value which exists have no underscore, but where undesrcore exists
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
if name in self.legit_attr:
object.__setattr__(self, "_%s" % name, value)
else:
object.__setattr__(self, name, value)
def checksummize(self):
'''
Fill missing md5/size about payload
'''
fileobj = istools.uopen(self.path)
size, md5 = istools.copyfileobj(fileobj, None)
if self._size is None:
self._size = size
if self._md5 is None:
self._md5 = md5
@property
def md5(self):
'''
Return md5 of payload
'''
if self._md5 is None:
self.checksummize()
return self._md5
@property
def size(self):
'''
Return size of payload
'''
if self._size is None:
self.checksummize()
return self._size
@property
def uid(self):
'''
Return uid of owner of orginal payload
'''
return self._uid if self._uid is not None else 0
@property
def gid(self):
'''
Return gid of owner of orginal payload
'''
return self._gid if self._gid is not None else 0
@property
def mode(self):
'''
Return mode of orginal payload
'''
if self._mode is not None:
return self._mode
else:
umask = os.umask(0)
os.umask(umask)
return 0666 & ~umask
@property
def filename(self):
'''
Return the filename of the original payload
'''
return "%s%s" % (self.name, self.extension)
@property
def mtime(self):
'''
Return last modification time of orginal payload
'''
return self._mtime if self._mtime is not None else time.time()
@property
def info(self):
'''
Return a dict of info about current payload
This info will be inserted in descript.json
Auto calculated info like name and filename must not be here
"size": self.size,
"isdir": self.isdir,
"uid": self.uid,
"gid": self.gid,
"mode": self.mode,
"mtime": self.mtime}
def check(self):
'''
Check that path correspond to current md5 and size
'''
if self._size is None or self._md5 is None:
debug("Check is called on payload with nothing to check")
return True
fileobj = istools.uopen(self.path)
size, md5 = istools.copyfileobj(fileobj, None)
if self._size != size:
raise Exception("Invalid size of payload %s" % self.name)
if self._md5 != md5:
raise Exception("Invalid MD5 of payload %s" % self._md5)
def download(self, dest, force=False):
'''
Download payload in directory
'''
# if dest is a directory try to create file inside
if os.path.isdir(dest):
dest = os.path.join(dest, self.filename)
# try to create leading directories
elif not os.path.exists(os.path.dirname(dest)):
istools.mkdir(os.path.dirname(dest))
# check validity of dest
if os.path.exists(dest):
if os.path.isdir(dest):
raise Exception("Destination %s is a directory" % dest)
if not force:
raise Exception("File %s already exists" % dest)
# download
fs = istools.uopen(self.path)
fd = open(dest, "wb")
slen, smd5 = istools.copyfileobj(fs, fd)
fs.close()
fd.close()
if self.md5 != smd5:
raise Exception("Downloading payload %s failed: Invalid MD5" % self.name)
def extract(self, dest, force=False, filelist=None):
'''
Extract payload into dest
filelist is a filter of file in tarball
force will overwrite existing file if exists
'''
if self.isdir:
self.extract_tar(dest, force=force, filelist=filelist)
else:
self.extract_file(dest, force=force)
def extract_tar(self, dest, force=False, filelist=None):
'''
Extract a payload which is a tarball.
This is used mainly to extract payload from a directory
'''
# check validity of dest
if os.path.exists(dest):
if not os.path.isdir(dest):
raise Exception("Destination %s is not a directory" % dest)
if not force and len(os.listdir(dest)) > 0:
raise Exception("Directory %s is not empty (need force)" % dest)
else:
raise Exception("Unable to open payload file %s" % self.path)
# try to open tarball on payload
t = Tarball.open(fileobj=fo, mode="r|gz", ignore_zeros=True)
members = (None if filelist is None
else [ t.gettarinfo(name) for name in filelist ])
raise Exception("Extracting failed: %s" % e)
# closing fo
t.close()
fo.close()
def extract_file(self, dest, force=False):
'''
Copy a payload directly to a file
Check md5 on the fly
'''
# if dest is a directory try to create file inside
if os.path.isdir(dest):
dest = os.path.join(dest, self.name)
# try to create leading directories
elif not os.path.exists(os.path.dirname(dest)):
istools.mkdir(os.path.dirname(dest))
if os.path.isdir(dest):
raise Exception("Destination %s is a directory" % dest)
if not force:
raise Exception("File %s already exists" % dest)
# opening destination
try:
f_dst = istools.uopen(dest, "wb")
except Exception as e:
raise Exception("Unable to open destination file %s" % dest)
# try to open payload file
try:
f_gsrc = istools.uopen(self.path)
f_src = gzipstream.GzipStream(stream=f_gsrc)
except Exception as e:
raise Exception("Unable to open payload file %s" % self.path)
# launch copy
size, md5 = istools.copyfileobj(f_src, f_dst)
# closing fo
f_dst.close()
f_gsrc.close()
f_src.close()
# settings file orginal rights
istools.chrights(dest, self.uid, self.gid, self.mode, self.mtime)