From 0a598f5a66ee1ba661c729b09f6b4e83271e7f7f Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Sat, 9 Jun 2012 12:31:19 -0700 Subject: Rename these to user_data module + submodules. --- cloudinit/parts/__init__.py | 117 ---------------- cloudinit/parts/boot_hook.py | 42 ------ cloudinit/parts/cloud_config.py | 36 ----- cloudinit/parts/shell_script.py | 27 ---- cloudinit/parts/upstart_job.py | 30 ---- cloudinit/user_data.py | 271 ------------------------------------ cloudinit/user_data/__init__.py | 210 ++++++++++++++++++++++++++++ cloudinit/user_data/boot_hook.py | 65 +++++++++ cloudinit/user_data/cloud_config.py | 59 ++++++++ cloudinit/user_data/processor.py | 205 +++++++++++++++++++++++++++ cloudinit/user_data/shell_script.py | 53 +++++++ cloudinit/user_data/upstart_job.py | 56 ++++++++ 12 files changed, 648 insertions(+), 523 deletions(-) delete mode 100644 cloudinit/parts/__init__.py delete mode 100644 cloudinit/parts/boot_hook.py delete mode 100644 cloudinit/parts/cloud_config.py delete mode 100644 cloudinit/parts/shell_script.py delete mode 100644 cloudinit/parts/upstart_job.py delete mode 100644 cloudinit/user_data.py create mode 100644 cloudinit/user_data/__init__.py create mode 100644 cloudinit/user_data/boot_hook.py create mode 100644 cloudinit/user_data/cloud_config.py create mode 100644 cloudinit/user_data/processor.py create mode 100644 cloudinit/user_data/shell_script.py create mode 100644 cloudinit/user_data/upstart_job.py (limited to 'cloudinit') diff --git a/cloudinit/parts/__init__.py b/cloudinit/parts/__init__.py deleted file mode 100644 index 20d4bd3b..00000000 --- a/cloudinit/parts/__init__.py +++ /dev/null @@ -1,117 +0,0 @@ -import os - -from cloudinit import util -from cloudinit.settings import (PER_ALWAYS, PER_INSTANCE) -from cloudinit import log as logging - -LOG = logging.getLogger(__name__) - -CONTENT_END = "__end__" -CONTENT_START = "__begin__" -PART_CONTENT_TYPES = ["text/part-handler"] -PART_HANDLER_FN_TMPL = 'part-handler-%03d' -UNDEF_HANDLER_VERSION = 1 - - -class PartHandler(object): - def __init__(self, frequency, version=2): - self.handler_version = version - self.frequency = frequency - - def __repr__(self): - return "%s: [%s]" % (self.__class__.__name__, self.list_types()) - - def list_types(self): - raise NotImplementedError() - - def handle_part(self, data, ctype, filename, payload, frequency): - return self._handle_part(data, ctype, filename, payload, frequency) - - def _handle_part(self, data, ctype, filename, payload, frequency): - raise NotImplementedError() - - -def fixup_module(mod): - if not hasattr(mod, "handler_version"): - setattr(mod, "handler_version", UNDEF_HANDLER_VERSION) - if not hasattr(mod, 'list_types'): - def empty_types(): - return [] - setattr(mod, 'list_types', empty_types) - if not hasattr(mod, frequency): - setattr(mod, 'frequency', PER_INSTANCE) - if not hasattr(mod, 'handle_part'): - def empty_handler(data, ctype, filename, payload): - pass - setattr(mod, 'handle_part', empty_handler) - return mod - - -def find_module_files(root_dir): - entries = dict() - for fname in glob.glob(os.path.join(root_dir, "*.py")): - if not os.path.isfile(fname): - continue - modname = os.path.basename(fname)[0:-3] - entries[fname] = modname - return entries - - -def run_part(mod, data, ctype, filename, payload, frequency): - # only add the handler if the module should run - mod_freq = getattr(mod, "frequency") - if not (mod_freq == PER_ALWAYS or - (frequency == PER_INSTANCE and mod_freq == PER_INSTANCE)): - return - try: - mod_ver = getattr(mod, 'handler_version') - if mod_ver == 1: - mod.handle_part(data, ctype, filename, payload) - else: - mod.handle_part(data, ctype, filename, payload, frequency) - except: - LOG.exception("Failed calling mod %s (%s, %s, %s) with frequency %s", mod, ctype, filename, mod_ver, frequency) - - -def call_begin(mod, data, frequency): - run_part(mod, data, CONTENT_START, None, None, frequency) - - -def call_end(mod, data, frequency): - run_part(mod, data, CONTENT_END, None, None, frequency) - - -def walker_handle_handler(pdata, _ctype, _filename, payload): - curcount = pdata['handlercount'] - modname = PART_HANDLER_FN_TMPL % (curcount) - frequency = pdata['frequency'] - modfname = os.path.join(pdata['handlerdir'], "%s.py" % (modname)) - # TODO: Check if path exists?? - util.write_file(modfname, payload, 0600) - handlers = pdata['handlers'] - try: - mod = fixup_module(importer.import_module(modname)) - handlers.register(mod) - call_begin(mod, pdata['data'], frequency) - pdata['handlercount'] = curcount + 1 - except: - LOG.exception("Failed at registered python file %s", modfname) - - -def walker_callback(pdata, ctype, filename, payload): - # data here is the part_handlers array and then the data to pass through - if ctype in PART_CONTENT_TYPES: - walker_handle_handler(pdata, ctype, filename, payload) - return - handlers = pdata['handlers'] - if ctype not in handlers: - if ctype == "text/x-not-multipart": - # Extract the first line or 24 bytes for displaying in the log - start = payload.split("\n", 1)[0][:24] - if start < payload: - details = "starting '%s...'" % start.encode("string-escape") - else: - details = repr(payload) - LOG.warning("Unhandled non-multipart userdata: %s", details) - return - run_part(handlers[ctype], pdata['data'], ctype, filename, payload, pdata['frequency']) \ No newline at end of file diff --git a/cloudinit/parts/boot_hook.py b/cloudinit/parts/boot_hook.py deleted file mode 100644 index 881ffc58..00000000 --- a/cloudinit/parts/boot_hook.py +++ /dev/null @@ -1,42 +0,0 @@ -import os - -from cloudinit import util -from cloudinit.settings import (PER_ALWAYS, PER_INSTANCE) -from cloudinit import log as logging -from cloudinit import parts - -LOG = logging.getLogger(__name__) - - - -class BootHookPartHandler(parts.PartHandler): - def __init__(self, boothook_dir, instance_id): - parts.PartHandler.__init__(self, PER_ALWAYS) - self.boothook_dir = boothook_dir - self.instance_id = instance_id - - def list_types(self): - return ['text/cloud-boothook'] - - def _handle_part(self, _data, ctype, filename, payload, _frequency): - if ctype in [CONTENT_START, CONTENT_END]: - return - - filename = util.clean_filename(filename) - payload = util.dos2unix(payload) - prefix = "#cloud-boothook" - start = 0 - if payload.startswith(prefix): - start = len(prefix) + 1 - - filepath = os.path.join(self.boothook_dir, filename) - util.write_file(filepath, payload[start:], 0700) - try: - env = os.environ.copy() - env['INSTANCE_ID'] = str(self.instance_id) - util.subp([filepath], env=env) - except util.ProcessExecutionError as e: - LOG.error("Boothooks script %s returned %s", filepath, e.exit_code) - except Exception as e: - LOG.error("Boothooks unknown exception %s when running %s", e, filepath) - diff --git a/cloudinit/parts/cloud_config.py b/cloudinit/parts/cloud_config.py deleted file mode 100644 index dab0e5f5..00000000 --- a/cloudinit/parts/cloud_config.py +++ /dev/null @@ -1,36 +0,0 @@ -import os - -from cloudinit import util -from cloudinit.settings import (PER_ALWAYS, PER_INSTANCE) -from cloudinit import log as logging -from cloudinit import parts - -LOG = logging.getLogger(__name__) - - - -class CloudConfigPartHandler(parts.PartHandler): - def __init__(self, cloud_fn): - parts.PartHandler.__init__(self, PER_ALWAYS) - self.cloud_buf = [] - self.cloud_fn = cloud_fn - - def list_types(self): - return ['text/cloud-config'] - - def _handle_part(self, _data, ctype, filename, payload, _frequency): - if ctype == CONTENT_START: - self.cloud_buf = [] - return - - if ctype == CONTENT_END: - payload = "\n".join(self.cloud_buf) - util.write_file(self.cloud_fn, payload, 0600) - self.cloud_buf = [] - return - - filename = util.clean_filename(filename) - entry = "\n".join(["#%s" % (filename), str(payload)]) - self.config_buf.append(entry) - - diff --git a/cloudinit/parts/shell_script.py b/cloudinit/parts/shell_script.py deleted file mode 100644 index a248f198..00000000 --- a/cloudinit/parts/shell_script.py +++ /dev/null @@ -1,27 +0,0 @@ -import os - -from cloudinit import util -from cloudinit.settings import (PER_ALWAYS, PER_INSTANCE) -from cloudinit import log as logging -from cloudinit import parts - -LOG = logging.getLogger(__name__) - - -class ShellScriptPartHandler(parts.PartHandler): - - def __init__(self, script_dir): - parts.PartHandler.__init__(self, PER_ALWAYS) - self.script_dir = script_dir - - def list_types(self): - return ['text/x-shellscript'] - - def _handle_part(self, _data, ctype, filename, payload, _frequency): - if ctype in [CONTENT_START, CONTENT_END]: - # maybe delete existing things here - return - - filename = util.clean_filename(filename) - payload = util.dos2unix(payload) - util.write_file(os.path.join(self.script_dir, filename), payload, 0700) diff --git a/cloudinit/parts/upstart_job.py b/cloudinit/parts/upstart_job.py deleted file mode 100644 index 7b290d26..00000000 --- a/cloudinit/parts/upstart_job.py +++ /dev/null @@ -1,30 +0,0 @@ -import os - -from cloudinit import util -from cloudinit.settings import (PER_ALWAYS, PER_INSTANCE) -from cloudinit import log as logging -from cloudinit import parts - -LOG = logging.getLogger(__name__) - - -class UpstartJobPartHandler(parts.PartHandler): - def __init__(self, upstart_dir): - parts.PartHandler.__init__(self, PER_INSTANCE) - self.upstart_dir = upstart_dir - - def list_types(self): - return ['text/upstart-job'] - - def _handle_part(self, _data, ctype, filename, payload, frequency): - if ctype in [CONTENT_START, CONTENT_END]: - return - - filename = utils.clean_filename(filename) - (name, ext) = os.path.splitext(filename) - ext = ext.lower() - if ext != ".conf": - filename = filename + ".conf" - - payload = util.dos2unix(payload) - util.write_file(os.path.join(self.upstart_dir, filename), payload, 0644) diff --git a/cloudinit/user_data.py b/cloudinit/user_data.py deleted file mode 100644 index f35e5d38..00000000 --- a/cloudinit/user_data.py +++ /dev/null @@ -1,271 +0,0 @@ -# vi: ts=4 expandtab -# -# Copyright (C) 2009-2010 Canonical Ltd. -# Copyright (C) 2012 Hewlett-Packard Development Company, L.P. -# -# Author: Scott Moser -# Author: Juerg Hafliger -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License version 3, as -# published by the Free Software Foundation. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . - -import hashlib -import os -import urllib - -import email -from email.mime.multipart import MIMEMultipart -from email.mime.text import MIMEText -from email.mime.base import MIMEBase - -import yaml - -from cloudinit import url_helper -from cloudinit import util - - -# Different file beginnings to there content type -INCLUSION_TYPES_MAP = { - '#include': 'text/x-include-url', - '#include-once': 'text/x-include-once-url', - '#!': 'text/x-shellscript', - '#cloud-config': 'text/cloud-config', - '#upstart-job': 'text/upstart-job', - '#part-handler': 'text/part-handler', - '#cloud-boothook': 'text/cloud-boothook', - '#cloud-config-archive': 'text/cloud-config-archive', -} - -# Various special content types -TYPE_NEEDED = ["text/plain", "text/x-not-multipart"] -INCLUDE_TYPES = ['text/x-include-url', 'text/x-include-once-url'] -ARCHIVE_TYPES = ["text/cloud-config-archive"] -UNDEF_TYPE = "text/plain" -ARCHIVE_UNDEF_TYPE = "text/cloud-config" -NOT_MULTIPART_TYPE = "text/x-not-multipart" -OCTET_TYPE = 'application/octet-stream' - -# Sorted longest first -INCLUSION_SRCH = sorted(INCLUSION_TYPES_MAP.keys(), key=(lambda e: 0 - len(e))) - -# Msg header used to track attachments -ATTACHMENT_FIELD = 'Number-Attachments' - -# This will be used to create a filename from a url (or like) entry -# When we want to make sure a entry isn't included more than once across sessions. -INCLUDE_ONCE_HASHER = 'md5' - -# For those pieces without filenames -PART_FN_TPL = 'part-%03d' - - -class UserDataProcessor(object): - def __init__(self, paths): - self.paths = paths - - def process(self, blob): - base_msg = convert_string(blob) - process_msg = MIMEMultipart() - self._process_msg(base_msg, process_msg) - return process_msg - - def _process_msg(self, base_msg, append_msg): - for part in base_msg.walk(): - # multipart/* are just containers - if part.get_content_maintype() == 'multipart': - continue - - ctype = None - ctype_orig = part.get_content_type() - payload = part.get_payload(decode=True) - - if not ctype_orig: - ctype_orig = UNDEF_TYPE - - if ctype_orig in TYPE_NEEDED: - ctype = type_from_starts_with(payload) - - if ctype is None: - ctype = ctype_orig - - if ctype in INCLUDE_TYPES: - self._do_include(payload, append_msg) - continue - - if ctype in ARCHIVE_TYPES: - self._explode_archive(payload, append_msg) - continue - - if 'Content-Type' in base_msg: - base_msg.replace_header('Content-Type', ctype) - else: - base_msg['Content-Type'] = ctype - - self._attach_part(append_msg, part) - - def _get_include_once_filename(self, entry): - msum = hashlib.new(INCLUDE_ONCE_HASHER) - msum.update(entry) - entry_fn = msum.hexdigest()[0:64] # Don't get to long now - return os.path.join(self.paths.get_ipath_cur('data'), 'urlcache', entry_fn) - - def _do_include(self, content, append_msg): - # is just a list of urls, one per line - # also support '#include ' - for line in content.splitlines(): - includeonce = False - if line in ("#include", "#include-once"): - continue - if line.startswith("#include-once"): - line = line[len("#include-once"):].lstrip() - includeonce = True - elif line.startswith("#include"): - line = line[len("#include"):].lstrip() - if line.startswith("#"): - continue - include_url = line.strip() - if not include_url: - continue - - includeonce_filename = self._get_include_once_filename(include_url) - if includeonce and os.path.isfile(includeonce_filename): - content = util.load_file(includeonce_filename) - else: - (content, st) = url_helper.readurl(include_url) - if includeonce and url_helper.ok_http_code(st): - util.write_file(includeonce_filename, content, mode=0600) - if not url_helper.ok_http_code(st): - content = '' - - new_msg = convert_string(content) - self._process_msg(new_msg, append_msg) - - def _explode_archive(self, archive, append_msg): - try: - entries = yaml.load(archive) - except: - entries = [] - if not isinstance(entries, (list, set)): - # TODO raise? - entries = [] - - for ent in entries: - # ent can be one of: - # dict { 'filename' : 'value', 'content' : 'value', 'type' : 'value' } - # filename and type not be present - # or - # scalar(payload) - if isinstance(ent, str): - ent = {'content': ent} - if not isinstance(ent, (dict)): - # TODO raise? - continue - - content = ent.get('content', '') - mtype = ent.get('type') - if not mtype: - mtype = type_from_starts_with(content, ARCHIVE_UNDEF_TYPE) - - maintype, subtype = mtype.split('/', 1) - if maintype == "text": - msg = MIMEText(content, _subtype=subtype) - else: - msg = MIMEBase(maintype, subtype) - msg.set_payload(content) - - if 'filename' in ent: - msg.add_header('Content-Disposition', 'attachment', filename=ent['filename']) - - for header in ent.keys(): - if header in ('content', 'filename', 'type'): - continue - msg.add_header(header, ent['header']) - - self._attach_part(append_msg, msg) - - def _multi_part_count(self, outer_msg, new_count=None): - """ - Return the number of attachments to this MIMEMultipart by looking - at its 'Number-Attachments' header. - """ - if ATTACHMENT_FIELD not in outer_msg: - outer_msg[ATTACHMENT_FIELD] = str(0) - - if new_count is not None: - outer_msg.replace_header(ATTACHMENT_FIELD, str(new_count)) - - fetched_count = 0 - try: - fetched_count = int(outer_msg.get(ATTACHMENT_FIELD)) - except (ValueError, TypeError): - outer_msg.replace_header(ATTACHMENT_FIELD, str(fetched_count)) - return fetched_count - - def _attach_part(self, outer_msg, part): - """ - Attach an part to an outer message. outermsg must be a MIMEMultipart. - Modifies a header in the message to keep track of number of attachments. - """ - cur = self._multi_part_count(outer_msg) - if not part.get_filename(): - part.add_header('Content-Disposition', 'attachment', filename=PART_FN_TPL % (cur + 1)) - outer_msg.attach(part) - self._multi_part_count(outer_msg, cur + 1) - - -# Callback is a function that will be called with -# (data, content_type, filename, payload) -def walk(ud_msg, callback, data): - partnum = 0 - for part in ud_msg.walk(): - # multipart/* are just containers - if part.get_content_maintype() == 'multipart': - continue - - ctype = part.get_content_type() - if ctype is None: - ctype = OCTET_TYPE - - filename = part.get_filename() - if not filename: - filename = PART_FN_TPL % partnum - - callback(data, ctype, filename, part.get_payload(decode=True)) - partnum = partnum + 1 - - -def convert_string(self, raw_data, headers=None): - if not data: - data = '' - if not headers: - headers = {} - data = util.decomp_str(raw_data) - if "mime-version:" in data[0:4096].lower(): - msg = email.message_from_string(data) - for (key, val) in headers.items(): - if key in msg: - msg.replace_header(key, val) - else: - msg[key] = val - else: - mtype = headers.get("Content-Type", NOT_MULTIPART_TYPE) - maintype, subtype = mtype.split("/", 1) - msg = MIMEBase(maintype, subtype, *headers) - msg.set_payload(data) - return msg - - -def type_from_starts_with(payload, default=None): - for text in INCLUSION_SRCH: - if payload.startswith(text): - return INCLUSION_TYPES_MAP[text] - return default diff --git a/cloudinit/user_data/__init__.py b/cloudinit/user_data/__init__.py new file mode 100644 index 00000000..6264a6cc --- /dev/null +++ b/cloudinit/user_data/__init__.py @@ -0,0 +1,210 @@ +# vi: ts=4 expandtab +# +# Copyright (C) 2012 Canonical Ltd. +# Copyright (C) 2012 Hewlett-Packard Development Company, L.P. +# Copyright (C) 2012 Yahoo! Inc. +# +# Author: Scott Moser +# Author: Juerg Haefliger +# Author: Joshua Harlow +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 3, as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +import os +import glob + +import email + +from email.mime.base import MIMEBase + +from cloudinit import log as logging +from cloudinit import util + +from cloudinit.settings import (PER_ALWAYS, PER_INSTANCE) + +LOG = logging.getLogger(__name__) + +# Special content types that signal the start and end of processing +CONTENT_END = "__end__" +CONTENT_START = "__begin__" +CONTENT_SIGNALS = [CONTENT_START, CONTENT_END] + +# Used when a part-handler type is encountered +# to allow for registration of new types. +PART_CONTENT_TYPES = ["text/part-handler"] +PART_HANDLER_FN_TMPL = 'part-handler-%03d' + +# For parts without filenames +PART_FN_TPL = 'part-%03d' + +# Used as the content type when a message is not multipart +# and it doesn't contain its own content-type +NOT_MULTIPART_TYPE = "text/x-not-multipart" + +# Different file beginnings to there content type +INCLUSION_TYPES_MAP = { + '#include': 'text/x-include-url', + '#include-once': 'text/x-include-once-url', + '#!': 'text/x-shellscript', + '#cloud-config': 'text/cloud-config', + '#upstart-job': 'text/upstart-job', + '#part-handler': 'text/part-handler', + '#cloud-boothook': 'text/cloud-boothook', + '#cloud-config-archive': 'text/cloud-config-archive', +} + +# Sorted longest first +INCLUSION_SRCH = sorted(INCLUSION_TYPES_MAP.keys(), key=(lambda e: 0 - len(e))) + + +class PartHandler(object): + def __init__(self, frequency, version=2): + self.handler_version = version + self.frequency = frequency + + def __repr__(self): + return "%s: [%s]" % (self.__class__.__name__, self.list_types()) + + def list_types(self): + raise NotImplementedError() + + def handle_part(self, data, ctype, filename, payload, frequency): + return self._handle_part(data, ctype, filename, payload, frequency) + + def _handle_part(self, data, ctype, filename, payload, frequency): + raise NotImplementedError() + + +def fixup_module(mod): + if not hasattr(mod, "handler_version"): + setattr(mod, "handler_version", 1) + if not hasattr(mod, 'list_types'): + def empty_types(): + return [] + setattr(mod, 'list_types', empty_types) + if not hasattr(mod, frequency): + setattr(mod, 'frequency', PER_INSTANCE) + if not hasattr(mod, 'handle_part'): + def empty_handler(data, ctype, filename, payload): + pass + setattr(mod, 'handle_part', empty_handler) + return mod + + +def run_part(mod, data, ctype, filename, payload, frequency): + mod_freq = mod.frequency + if not (mod_freq == PER_ALWAYS or + (frequency == PER_INSTANCE and mod_freq == PER_INSTANCE)): + return + mod_ver = mod.handler_version + try: + if mod_ver == 1: + mod.handle_part(data, ctype, filename, payload) + else: + mod.handle_part(data, ctype, filename, payload, frequency) + except: + LOG.exception("Failed calling mod %s (%s, %s, %s) with frequency %s", mod, ctype, filename, mod_ver, frequency) + + +def call_begin(mod, data, frequency): + run_part(mod, data, CONTENT_START, None, None, frequency) + + +def call_end(mod, data, frequency): + run_part(mod, data, CONTENT_END, None, None, frequency) + + +def walker_handle_handler(pdata, _ctype, _filename, payload): + curcount = pdata['handlercount'] + modname = PART_HANDLER_FN_TMPL % (curcount) + frequency = pdata['frequency'] + modfname = os.path.join(pdata['handlerdir'], "%s.py" % (modname)) + # TODO: Check if path exists?? + util.write_file(modfname, payload, 0600) + handlers = pdata['handlers'] + try: + mod = fixup_module(importer.import_module(modname)) + handlers.register(mod) + call_begin(mod, pdata['data'], frequency) + pdata['handlercount'] = curcount + 1 + except: + LOG.exception("Failed at registered python file: %s", modfname) + + +def walker_callback(pdata, ctype, filename, payload): + if ctype in PART_CONTENT_TYPES: + walker_handle_handler(pdata, ctype, filename, payload) + return + handlers = pdata['handlers'] + if ctype not in handlers: + if ctype == NOT_MULTIPART_TYPE: + # Extract the first line or 24 bytes for displaying in the log + start = payload.split("\n", 1)[0][:24] + if start < payload: + details = "starting '%s...'" % start.encode("string-escape") + else: + details = repr(payload) + LOG.warning("Unhandled non-multipart userdata: %s", details) + return + run_part(handlers[ctype], pdata['data'], ctype, filename, payload, pdata['frequency']) + + +# Callback is a function that will be called with +# (data, content_type, filename, payload) +def walk(msg, callback, data): + partnum = 0 + for part in msg.walk(): + # multipart/* are just containers + if part.get_content_maintype() == 'multipart': + continue + + ctype = part.get_content_type() + if ctype is None: + ctype = OCTET_TYPE + + filename = part.get_filename() + if not filename: + filename = PART_FN_TPL % (partnum) + + callback(data, ctype, filename, part.get_payload(decode=True)) + partnum = partnum + 1 + + +# Coverts a raw string into a mime message +def convert_string(self, raw_data, headers=None): + if not raw_data: + raw_data = '' + if not headers: + headers = {} + data = util.decomp_str(raw_data) + if "mime-version:" in data[0:4096].lower(): + msg = email.message_from_string(data) + for (key, val) in headers.items(): + if key in msg: + msg.replace_header(key, val) + else: + msg[key] = val + else: + mtype = headers.get("Content-Type", NOT_MULTIPART_TYPE) + maintype, subtype = mtype.split("/", 1) + msg = MIMEBase(maintype, subtype, *headers) + msg.set_payload(data) + return msg + + +def type_from_starts_with(payload, default=None): + for text in INCLUSION_SRCH: + if payload.startswith(text): + return INCLUSION_TYPES_MAP[text] + return default \ No newline at end of file diff --git a/cloudinit/user_data/boot_hook.py b/cloudinit/user_data/boot_hook.py new file mode 100644 index 00000000..4ce398ac --- /dev/null +++ b/cloudinit/user_data/boot_hook.py @@ -0,0 +1,65 @@ +# vi: ts=4 expandtab +# +# Copyright (C) 2012 Canonical Ltd. +# Copyright (C) 2012 Hewlett-Packard Development Company, L.P. +# Copyright (C) 2012 Yahoo! Inc. +# +# Author: Scott Moser +# Author: Juerg Haefliger +# Author: Joshua Harlow +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 3, as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import os + +from cloudinit import log as logging +from cloudinit import user_data as ud +from cloudinit import util + +from cloudinit.settings import (PER_ALWAYS) + +LOG = logging.getLogger(__name__) + + +class BootHookPartHandler(ud.PartHandler): + def __init__(self, boothook_dir, instance_id): + ud.PartHandler.__init__(self, PER_ALWAYS) + self.boothook_dir = boothook_dir + self.instance_id = instance_id + + def list_types(self): + return [ + ud.type_from_starts_with("#cloud-boothook"), + ] + + def _handle_part(self, _data, ctype, filename, payload, _frequency): + if ctype in ud.CONTENT_SIGNALS: + return + + filename = util.clean_filename(filename) + payload = util.dos2unix(payload) + prefix = "#cloud-boothook" + start = 0 + if payload.startswith(prefix): + start = len(prefix) + 1 + + filepath = os.path.join(self.boothook_dir, filename) + util.write_file(filepath, payload[start:], 0700) + try: + env = os.environ.copy() + env['INSTANCE_ID'] = str(self.instance_id) + util.subp([filepath], env=env) + except util.ProcessExecutionError as e: + LOG.error("Boothooks script %s returned %s", filepath, e.exit_code) + except Exception as e: + LOG.error("Boothooks unknown exception %s when running %s", e, filepath) diff --git a/cloudinit/user_data/cloud_config.py b/cloudinit/user_data/cloud_config.py new file mode 100644 index 00000000..1c43f3a1 --- /dev/null +++ b/cloudinit/user_data/cloud_config.py @@ -0,0 +1,59 @@ +# vi: ts=4 expandtab +# +# Copyright (C) 2012 Canonical Ltd. +# Copyright (C) 2012 Hewlett-Packard Development Company, L.P. +# Copyright (C) 2012 Yahoo! Inc. +# +# Author: Scott Moser +# Author: Juerg Haefliger +# Author: Joshua Harlow +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 3, as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +import os + +from cloudinit import log as logging +from cloudinit import user_data as ud +from cloudinit import util + +from cloudinit.settings import (PER_ALWAYS) + +LOG = logging.getLogger(__name__) + + +class CloudConfigPartHandler(ud.PartHandler): + def __init__(self, cloud_fn): + ud.PartHandler.__init__(self, PER_ALWAYS) + self.cloud_buf = [] + self.cloud_fn = cloud_fn + + def list_types(self): + return [ + ud.type_from_starts_with("#cloud-config"), + ] + + def _handle_part(self, _data, ctype, filename, payload, _frequency): + if ctype == ud.CONTENT_START: + self.cloud_buf = [] + return + + if ctype == ud.CONTENT_END: + payload = "\n".join(self.cloud_buf) + util.write_file(self.cloud_fn, payload, 0600) + self.cloud_buf = [] + return + + filename = util.clean_filename(filename) + entry = "\n".join(["#%s" % (filename), str(payload)]) + self.config_buf.append(entry) diff --git a/cloudinit/user_data/processor.py b/cloudinit/user_data/processor.py new file mode 100644 index 00000000..d4de9470 --- /dev/null +++ b/cloudinit/user_data/processor.py @@ -0,0 +1,205 @@ +# vi: ts=4 expandtab +# +# Copyright (C) 2012 Canonical Ltd. +# Copyright (C) 2012 Hewlett-Packard Development Company, L.P. +# Copyright (C) 2012 Yahoo! Inc. +# +# Author: Scott Moser +# Author: Juerg Haefliger +# Author: Joshua Harlow +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 3, as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import hashlib +import os +import urllib + +from email.mime.multipart import MIMEMultipart +from email.mime.text import MIMEText +from email.mime.base import MIMEBase + +import yaml + +from cloudinit import url_helper +from cloudinit import user_data as ud +from cloudinit import util + +# Various special content types +TYPE_NEEDED = ["text/plain", "text/x-not-multipart"] +INCLUDE_TYPES = ['text/x-include-url', 'text/x-include-once-url'] +ARCHIVE_TYPES = ["text/cloud-config-archive"] +UNDEF_TYPE = "text/plain" +ARCHIVE_UNDEF_TYPE = "text/cloud-config" +OCTET_TYPE = 'application/octet-stream' + +# Msg header used to track attachments +ATTACHMENT_FIELD = 'Number-Attachments' + +# This will be used to create a filename from a url (or like) entry +# When we want to make sure a entry isn't included more than once across sessions. +INCLUDE_ONCE_HASHER = 'md5' + + +class UserDataProcessor(object): + def __init__(self, paths): + self.paths = paths + + def process(self, blob): + base_msg = ud.convert_string(blob) + process_msg = MIMEMultipart() + self._process_msg(base_msg, process_msg) + return process_msg + + def _process_msg(self, base_msg, append_msg): + for part in base_msg.walk(): + # multipart/* are just containers + if part.get_content_maintype() == 'multipart': + continue + + ctype = None + ctype_orig = part.get_content_type() + payload = part.get_payload(decode=True) + + if not ctype_orig: + ctype_orig = UNDEF_TYPE + + if ctype_orig in TYPE_NEEDED: + ctype = ud.type_from_starts_with(payload) + + if ctype is None: + ctype = ctype_orig + + if ctype in INCLUDE_TYPES: + self._do_include(payload, append_msg) + continue + + if ctype in ARCHIVE_TYPES: + self._explode_archive(payload, append_msg) + continue + + if 'Content-Type' in base_msg: + base_msg.replace_header('Content-Type', ctype) + else: + base_msg['Content-Type'] = ctype + + self._attach_part(append_msg, part) + + def _get_include_once_filename(self, entry): + msum = hashlib.new(INCLUDE_ONCE_HASHER) + msum.update(entry) + entry_fn = msum.hexdigest()[0:64] # Don't get to long now + return os.path.join(self.paths.get_ipath_cur('data'), 'urlcache', entry_fn) + + def _do_include(self, content, append_msg): + # is just a list of urls, one per line + # also support '#include ' + for line in content.splitlines(): + includeonce = False + if line in ("#include", "#include-once"): + continue + if line.startswith("#include-once"): + line = line[len("#include-once"):].lstrip() + includeonce = True + elif line.startswith("#include"): + line = line[len("#include"):].lstrip() + if line.startswith("#"): + continue + include_url = line.strip() + if not include_url: + continue + + includeonce_filename = self._get_include_once_filename(include_url) + if includeonce and os.path.isfile(includeonce_filename): + content = util.load_file(includeonce_filename) + else: + (content, st) = url_helper.readurl(include_url) + if includeonce and url_helper.ok_http_code(st): + util.write_file(includeonce_filename, content, mode=0600) + if not url_helper.ok_http_code(st): + content = '' + + new_msg = ud.convert_string(content) + self._process_msg(new_msg, append_msg) + + def _explode_archive(self, archive, append_msg): + try: + entries = yaml.load(archive) + except: + entries = [] + if not isinstance(entries, (list, set)): + # TODO raise? + entries = [] + + for ent in entries: + # ent can be one of: + # dict { 'filename' : 'value', 'content' : 'value', 'type' : 'value' } + # filename and type not be present + # or + # scalar(payload) + if isinstance(ent, str): + ent = {'content': ent} + if not isinstance(ent, (dict)): + # TODO raise? + continue + + content = ent.get('content', '') + mtype = ent.get('type') + if not mtype: + mtype = ud.type_from_starts_with(content, ARCHIVE_UNDEF_TYPE) + + maintype, subtype = mtype.split('/', 1) + if maintype == "text": + msg = MIMEText(content, _subtype=subtype) + else: + msg = MIMEBase(maintype, subtype) + msg.set_payload(content) + + if 'filename' in ent: + msg.add_header('Content-Disposition', 'attachment', filename=ent['filename']) + + for header in ent.keys(): + if header in ('content', 'filename', 'type'): + continue + msg.add_header(header, ent['header']) + + self._attach_part(append_msg, msg) + + def _multi_part_count(self, outer_msg, new_count=None): + """ + Return the number of attachments to this MIMEMultipart by looking + at its 'Number-Attachments' header. + """ + if ATTACHMENT_FIELD not in outer_msg: + outer_msg[ATTACHMENT_FIELD] = str(0) + + if new_count is not None: + outer_msg.replace_header(ATTACHMENT_FIELD, str(new_count)) + + fetched_count = 0 + try: + fetched_count = int(outer_msg.get(ATTACHMENT_FIELD)) + except (ValueError, TypeError): + outer_msg.replace_header(ATTACHMENT_FIELD, str(fetched_count)) + return fetched_count + + def _attach_part(self, outer_msg, part): + """ + Attach an part to an outer message. outermsg must be a MIMEMultipart. + Modifies a header in the message to keep track of number of attachments. + """ + cur = self._multi_part_count(outer_msg) + if not part.get_filename(): + fn = ud.PART_FN_TPL % (cur + 1) + part.add_header('Content-Disposition', 'attachment', filename=fn) + outer_msg.attach(part) + self._multi_part_count(outer_msg, cur + 1) diff --git a/cloudinit/user_data/shell_script.py b/cloudinit/user_data/shell_script.py new file mode 100644 index 00000000..d666b9c4 --- /dev/null +++ b/cloudinit/user_data/shell_script.py @@ -0,0 +1,53 @@ +# vi: ts=4 expandtab +# +# Copyright (C) 2012 Canonical Ltd. +# Copyright (C) 2012 Hewlett-Packard Development Company, L.P. +# Copyright (C) 2012 Yahoo! Inc. +# +# Author: Scott Moser +# Author: Juerg Haefliger +# Author: Joshua Harlow +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 3, as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +import os + +from cloudinit import log as logging +from cloudinit import user_data as ud +from cloudinit import util + +from cloudinit.settings import (PER_INSTANCE) + +LOG = logging.getLogger(__name__) + + +class ShellScriptPartHandler(ud.PartHandler): + + def __init__(self, script_dir): + ud.PartHandler.__init__(self, PER_ALWAYS) + self.script_dir = script_dir + + def list_types(self): + return [ + ud.type_from_starts_with("#!"), + ] + + def _handle_part(self, _data, ctype, filename, payload, _frequency): + if ctype in ud.CONTENT_SIGNALS: + # maybe delete existing things here + return + + filename = util.clean_filename(filename) + payload = util.dos2unix(payload) + util.write_file(os.path.join(self.script_dir, filename), payload, 0700) diff --git a/cloudinit/user_data/upstart_job.py b/cloudinit/user_data/upstart_job.py new file mode 100644 index 00000000..d15e66c4 --- /dev/null +++ b/cloudinit/user_data/upstart_job.py @@ -0,0 +1,56 @@ +# vi: ts=4 expandtab +# +# Copyright (C) 2012 Canonical Ltd. +# Copyright (C) 2012 Hewlett-Packard Development Company, L.P. +# Copyright (C) 2012 Yahoo! Inc. +# +# Author: Scott Moser +# Author: Juerg Haefliger +# Author: Joshua Harlow +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 3, as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +import os + +from cloudinit import log as logging +from cloudinit import user_data as ud +from cloudinit import util + +from cloudinit.settings import (PER_INSTANCE) + +LOG = logging.getLogger(__name__) + + +class UpstartJobPartHandler(ud.PartHandler): + def __init__(self, upstart_dir): + ud.PartHandler.__init__(self, PER_INSTANCE) + self.upstart_dir = upstart_dir + + def list_types(self): + return [ + ud.type_from_starts_with("#upstart-job"), + ] + + def _handle_part(self, _data, ctype, filename, payload, frequency): + if ctype in ud.CONTENT_SIGNALS: + return + + filename = utils.clean_filename(filename) + (name, ext) = os.path.splitext(filename) + ext = ext.lower() + if ext != ".conf": + filename = filename + ".conf" + + payload = util.dos2unix(payload) + util.write_file(os.path.join(self.upstart_dir, filename), payload, 0644) -- cgit v1.2.3