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
|
# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
#
# Copyright (C) 2015 Canonical Ltd
#
# 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 logging
import os
import re
import tarfile
import urllib.parse
import snapcraft.common
logger = logging.getLogger(__name__)
class BasePlugin:
def __init__(self, name, options):
self.name = name
self.options = options
self.sourcedir = os.path.join(os.getcwd(), "parts", self.name, "src")
self.builddir = os.path.join(os.getcwd(), "parts", self.name, "build")
self.installdir = os.path.join(os.getcwd(), "parts", self.name, "install")
self.stagedir = os.path.join(os.getcwd(), "stage")
self.snapdir = os.path.join(os.getcwd(), "snap")
# The API
def pull(self):
return True
def build(self):
return True
def snap_files(self):
"""Returns two iteratables of globs:
- the first is the set of files/dirs to include
- the second is the set of files/dirs to exclude
For example: (['bin', 'lib'], ['lib/*.a'])"""
return (['*'], [])
def env(self, root):
return []
# Helpers
def run(self, cmd, cwd=None, **kwargs):
if cwd is None:
cwd = self.builddir
if True:
print(' '.join(cmd))
return snapcraft.common.run(cmd, cwd=cwd, **kwargs)
def isurl(self, url):
return urllib.parse.urlparse(url).scheme != ""
def pull_bzr(self, source, source_tag=None):
tag_opts = []
if source_tag:
tag_opts = ['-r', 'tag:' + source_tag]
if os.path.exists(os.path.join(self.sourcedir, ".bzr")):
return self.run(['bzr', 'pull'] + tag_opts + [source, '-d', self.sourcedir], cwd=os.getcwd())
else:
os.rmdir(self.sourcedir)
return self.run(['bzr', 'branch'] + tag_opts + [source, self.sourcedir], cwd=os.getcwd())
def pull_hg(self, source, source_tag=None, source_branch=None):
if source_tag and source_branch:
logger.error("You can't specify both source-tag and source-branch for a mercurial source (part '%s')." % self.name)
snapcraft.common.fatal()
if os.path.exists(os.path.join(self.sourcedir, ".hg")):
ref = []
if source_tag:
ref = ['-r', source_tag]
elif source_branch:
ref = ['-b', source_branch]
return self.run(['hg', 'pull'] + ref + [source, ], cwd=os.getcwd())
else:
ref = []
if source_tag or source_branch:
ref = ['-u', source_tag or source_branch]
return self.run(['hg', 'clone'] + ref + [source, self.sourcedir], cwd=os.getcwd())
def pull_git(self, source, source_tag=None, source_branch=None):
if source_tag and source_branch:
logger.error("You can't specify both source-tag and source-branch for a git source (part '%s')." % self.name)
snapcraft.common.fatal()
if os.path.exists(os.path.join(self.sourcedir, ".git")):
refspec = 'HEAD'
if source_branch:
refspec = 'refs/heads/' + source_branch
elif source_tag:
refspec = 'refs/tags/' + source_tag
return self.run(['git', '-C', self.sourcedir, 'pull', source, refspec], cwd=os.getcwd())
else:
branch_opts = []
if source_tag or source_branch:
branch_opts = ['--branch', source_tag or source_branch]
return self.run(['git', 'clone'] + branch_opts + [source, self.sourcedir], cwd=os.getcwd())
def pull_tarball(self, source, destdir=None):
destdir = destdir or self.sourcedir
if self.isurl(source):
return self.run(['wget', '-c', source], cwd=destdir)
else:
return True
def extract_tarball(self, source, srcdir=None, destdir=None):
srcdir = srcdir or self.sourcedir
destdir = destdir or self.builddir
if self.isurl(source):
tarball = os.path.join(srcdir, os.path.basename(source))
else:
tarball = os.path.abspath(source)
with tarfile.open(tarball) as tar:
def filter_members(tar):
"""Filters members and member names:
- strips common prefix
- bans dangerous names"""
members = tar.getmembers()
common = os.path.commonprefix([m.name for m in members])
# commonprefix() works a character at a time and will
# consider "d/ab" and "d/abc" to have common prefix "d/ab";
# check all members either start with common dir
for m in members:
if not (m.name.startswith(common + "/") or
m.isdir() and m.name == common):
# commonprefix() didn't return a dir name; go up one
# level
common = os.path.dirname(common)
break
for m in members:
if m.name == common:
continue
if m.name.startswith(common + "/"):
m.name = m.name[len(common + "/"):]
# strip leading "/", "./" or "../" as many times as needed
m.name = re.sub(r'^(\.{0,2}/)*', r'', m.name)
yield m
tar.extractall(members=filter_members(tar), path=destdir)
return True
def get_source(self, source, source_type=None, source_tag=None, source_branch=None):
if source_type is None:
if source.startswith("bzr:") or source.startswith("lp:"):
source_type = 'bzr'
elif source.startswith("git:"):
source_type = 'git'
elif self.isurl(source):
logger.error("Unrecognized source '%s' for part '%s'." % (source, self.name))
snapcraft.common.fatal()
if source_type == 'bzr':
if source_branch:
logger.error("You can't specify source-branch for a bzr source (part '%s')." % self.name)
snapcraft.common.fatal()
if not self.pull_bzr(source, source_tag=source_tag):
return False
if not self.run(['cp', '-Trfa', self.sourcedir, self.builddir]):
return False
elif source_type == 'git':
if not self.pull_git(source, source_tag=source_tag, source_branch=source_branch):
return False
if not self.run(['cp', '-Trfa', self.sourcedir, self.builddir]):
return False
elif source_type == 'hg' or source_type == 'mercurial':
if not self.pull_hg(source, source_tag=source_tag, source_branch=source_branch):
return False
if not self.run(['cp', '-Trfa', self.sourcedir, self.builddir]):
return False
elif source_type == 'tar':
if source_branch:
logger.error("You can't specify source-branch for a tar source (part '%s')." % self.name)
snapcraft.common.fatal()
if source_tag:
logger.error("You can't specify source-tag for a tar source (part '%s')." % self.name)
snapcraft.common.fatal()
if not self.pull_tarball(source):
return False
if not self.extract_tarball(source):
return False
else:
# local source dir
path = os.path.abspath(source)
if os.path.isdir(self.builddir):
os.rmdir(self.builddir)
else:
os.remove(self.builddir)
os.symlink(path, self.builddir)
return True
def handle_source_options(self):
stype = getattr(self.options, 'source_type', None)
stag = getattr(self.options, 'source_tag', None)
sbranch = getattr(self.options, 'source_branch', None)
return self.get_source(self.options.source,
source_type=stype,
source_tag=stag,
source_branch=sbranch)
def makedirs(self, d):
os.makedirs(d, exist_ok=True)
|