summaryrefslogtreecommitdiff
path: root/cloudinit/UserDataHandler.py
blob: 48bd97806df9b1ce9f3d2e761db0bd4974fdfeee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# vi: ts=4 expandtab
#
#    Copyright (C) 2009-2010 Canonical Ltd.
#
#    Author: Scott Moser <scott.moser@canonical.com>
#
#    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 <http://www.gnu.org/licenses/>.
import email

from email.mime.multipart import MIMEMultipart
from email.mime.text import MIMEText
from email.mime.base import MIMEBase
import yaml
import cloudinit
import cloudinit.util as util
import hashlib
import urllib


starts_with_mappings = {
    '#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',
}


# if 'string' is compressed return decompressed otherwise return it
def decomp_str(string):
    import StringIO
    import gzip
    try:
        uncomp = gzip.GzipFile(None, "rb", 1, StringIO.StringIO(string)).read()
        return(uncomp)
    except:
        return(string)


def do_include(content, appendmsg):
    import os
    # is just a list of urls, one per line
    # also support '#include <url here>'
    includeonce = False
    for line in content.splitlines():
        if line == "#include":
            continue
        if line == "#include-once":
            includeonce = True
            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

        # urls cannot not have leading or trailing white space
        msum = hashlib.md5()  # pylint: disable=E1101
        msum.update(line.strip())
        includeonce_filename = "%s/urlcache/%s" % (
            cloudinit.get_ipath_cur("data"), msum.hexdigest())
        try:
            if includeonce and os.path.isfile(includeonce_filename):
                with open(includeonce_filename, "r") as fp:
                    content = fp.read()
            else:
                content = urllib.urlopen(line).read()
                if includeonce:
                    util.write_file(includeonce_filename, content, mode=0600)
        except Exception:
            raise

        process_includes(message_from_string(decomp_str(content)), appendmsg)


def explode_cc_archive(archive, appendmsg):
    for ent in yaml.load(archive):
        # ent can be one of:
        #  dict { 'filename' : 'value', 'content' : 'value', 'type' : 'value' }
        #    filename and type not be present
        # or
        #  scalar(payload)

        def_type = "text/cloud-config"
        if isinstance(ent, str):
            ent = {'content': ent}

        content = ent.get('content', '')
        mtype = ent.get('type', None)
        if mtype == None:
            mtype = type_from_startswith(content, def_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'])

        _attach_part(appendmsg, msg)


def multi_part_count(outermsg, newcount=None):
    """
    Return the number of attachments to this MIMEMultipart by looking
    at its 'Number-Attachments' header.
    """
    nfield = 'Number-Attachments'
    if nfield not in outermsg:
        outermsg[nfield] = "0"

    if newcount != None:
        outermsg.replace_header(nfield, str(newcount))

    return(int(outermsg.get('Number-Attachments', 0)))


def _attach_part(outermsg, part):
    """
    Attach an part to an outer message. outermsg must be a MIMEMultipart.
    Modifies a header in outermsg to keep track of number of attachments.
    """
    cur = multi_part_count(outermsg)
    if not part.get_filename(None):
        part.add_header('Content-Disposition', 'attachment',
            filename='part-%03d' % (cur + 1))
    outermsg.attach(part)
    multi_part_count(outermsg, cur + 1)


def type_from_startswith(payload, default=None):
    # slist is sorted longest first
    slist = sorted(starts_with_mappings.keys(), key=lambda e: 0 - len(e))
    for sstr in slist:
        if payload.startswith(sstr):
            return(starts_with_mappings[sstr])
    return default


def process_includes(msg, appendmsg=None):
    if appendmsg == None:
        appendmsg = MIMEMultipart()

    for part in 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 ctype_orig == "text/plain":
            ctype = type_from_startswith(payload)

        if ctype is None:
            ctype = ctype_orig

        if ctype in ('text/x-include-url', 'text/x-include-once-url'):
            do_include(payload, appendmsg)
            continue

        if ctype == "text/cloud-config-archive":
            explode_cc_archive(payload, appendmsg)
            continue

        if 'Content-Type' in msg:
            msg.replace_header('Content-Type', ctype)
        else:
            msg['Content-Type'] = ctype

        _attach_part(appendmsg, part)


def message_from_string(data, headers=None):
    if headers is None:
        headers = {}
    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", "text/plain")
        maintype, subtype = mtype.split("/", 1)
        msg = MIMEBase(maintype, subtype, *headers)
        msg.set_payload(data)

    return(msg)


# this is heavily wasteful, reads through userdata string input
def preprocess_userdata(data):
    newmsg = MIMEMultipart()
    process_includes(message_from_string(decomp_str(data)), newmsg)
    return(newmsg.as_string())


# callback is a function that will be called with (data, content_type,
# filename, payload)
def walk_userdata(istr, callback, data=None):
    partnum = 0
    for part in message_from_string(istr).walk():
        # multipart/* are just containers
        if part.get_content_maintype() == 'multipart':
            continue

        ctype = part.get_content_type()
        if ctype is None:
            ctype = 'application/octet-stream'

        filename = part.get_filename()
        if not filename:
            filename = 'part-%03d' % partnum

        callback(data, ctype, filename, part.get_payload(decode=True))

        partnum = partnum + 1


if __name__ == "__main__":
    import sys
    data = decomp_str(file(sys.argv[1]).read())
    newmsg = MIMEMultipart()
    process_includes(message_from_string(data), newmsg)
    print newmsg
    print "#found %s parts" % multi_part_count(newmsg)