1 """SCons.Tool.Packaging
9 # Permission is hereby granted, free of charge, to any person obtaining
10 # a copy of this software and associated documentation files (the
11 # "Software"), to deal in the Software without restriction, including
12 # without limitation the rights to use, copy, modify, merge, publish,
13 # distribute, sublicense, and/or sell copies of the Software, and to
14 # permit persons to whom the Software is furnished to do so, subject to
15 # the following conditions:
17 # The above copyright notice and this permission notice shall be included
18 # in all copies or substantial portions of the Software.
20 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
21 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
22 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
24 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
25 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
26 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 from __future__ import generators ### KEEP FOR COMPATIBILITY FIXERS
30 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
32 import SCons.Environment
33 from SCons.Variables import *
34 from SCons.Errors import *
35 from SCons.Util import is_List, make_path_relative
36 from SCons.Warnings import warn, Warning
41 __all__ = [ 'src_targz', 'src_tarbz2', 'src_zip', 'tarbz2', 'targz', 'zip', 'rpm', 'msi', 'ipk' ]
44 # Utility and Builder function
46 def Tag(env, target, source, *more_tags, **kw_tags):
47 """ Tag a file with the given arguments, just sets the accordingly named
48 attribute on the file object.
59 kw_tags[first_tag[0]] = ''
61 if len(kw_tags) == 0 and len(more_tags) == 0:
62 raise UserError, "No tags given."
68 if not SCons.Util.is_List(target):
71 # hmm, sometimes the target list, is a list of a list
72 # make sure it is flattened prior to processing.
73 # TODO: perhaps some bug ?!?
74 target=env.Flatten(target)
77 for (k,v) in kw_tags.items():
78 # all file tags have to start with PACKAGING_, so we can later
79 # differentiate between "normal" object attributes and the
80 # packaging attributes. As the user should not be bothered with
81 # that, the prefix will be added here if missing.
82 #if not k.startswith('PACKAGING_'):
83 if k[:10] != 'PACKAGING_':
87 def Package(env, target=None, source=None, **kw):
88 """ Entry point for the package tool.
90 # check if we need to find the source files ourself
92 source = env.FindInstalledFiles()
95 raise UserError, "No source for Package() given"
97 # decide which types of packages shall be built. Can be defined through
98 # four mechanisms: command line argument, keyword argument,
99 # environment argument and default selection( zip or tar.gz ) in that
101 try: kw['PACKAGETYPE']=env['PACKAGETYPE']
102 except KeyError: pass
104 if not kw.get('PACKAGETYPE'):
105 from SCons.Script import GetOption
106 kw['PACKAGETYPE'] = GetOption('package_type')
108 if kw['PACKAGETYPE'] == None:
109 if 'Tar' in env['BUILDERS']:
110 kw['PACKAGETYPE']='targz'
111 elif 'Zip' in env['BUILDERS']:
112 kw['PACKAGETYPE']='zip'
114 raise UserError, "No type for Package() given"
116 PACKAGETYPE=kw['PACKAGETYPE']
117 if not is_List(PACKAGETYPE):
118 PACKAGETYPE=PACKAGETYPE.split(',')
120 # load the needed packagers.
121 def load_packager(type):
123 file,path,desc=imp.find_module(type, __path__)
124 return imp.load_module(type, file, path, desc)
125 except ImportError, e:
126 raise EnvironmentError("packager %s not available: %s"%(type,str(e)))
128 packagers=list(map(load_packager, PACKAGETYPE))
130 # set up targets and the PACKAGEROOT
132 # fill up the target list with a default target name until the PACKAGETYPE
133 # list is of the same size as the target list.
134 if not target: target = []
136 size_diff = len(PACKAGETYPE)-len(target)
137 default_name = "%(NAME)s-%(VERSION)s"
140 default_target = default_name%kw
141 target.extend( [default_target]*size_diff )
143 if 'PACKAGEROOT' not in kw:
144 kw['PACKAGEROOT'] = default_name%kw
147 raise SCons.Errors.UserError( "Missing Packagetag '%s'"%e.args[0] )
149 # setup the source files
150 source=env.arg2nodes(source, env.fs.Entry)
152 # call the packager to setup the dependencies.
155 for packager in packagers:
157 t=packager.package(env,t,source, **kw)
160 assert( len(target) == 0 )
163 raise SCons.Errors.UserError( "Missing Packagetag '%s' for %s packager"\
164 % (e.args[0],packager.__name__) )
166 # this exception means that a needed argument for the packager is
167 # missing. As our packagers get their "tags" as named function
168 # arguments we need to find out which one is missing.
169 from inspect import getargspec
170 args,varargs,varkw,defaults=getargspec(packager.package)
172 args=args[:-len(defaults)] # throw away arguments with default values
174 args.remove('target')
175 args.remove('source')
176 # now remove any args for which we have a value in kw.
177 args=[x for x in args if x not in kw]
180 raise # must be a different error, so reraise
182 raise SCons.Errors.UserError( "Missing Packagetag '%s' for %s packager"\
183 % (args[0],packager.__name__) )
185 raise SCons.Errors.UserError( "Missing Packagetags '%s' for %s packager"\
186 % (", ".join(args),packager.__name__) )
188 target=env.arg2nodes(target, env.fs.Entry)
189 targets.extend(env.Alias( 'package', targets ))
193 # SCons tool initialization functions
199 from SCons.Script import AddOption
203 AddOption('--package-type',
208 help='The type of package to create.')
211 env['BUILDERS']['Package']
212 env['BUILDERS']['Tag']
214 env['BUILDERS']['Package'] = Package
215 env['BUILDERS']['Tag'] = Tag
223 EnumVariable( 'PACKAGETYPE',
224 'the type of package to create.',
225 None, allowed_values=list(map( str, __all__ )),
231 # Internal utility functions
234 def copy_attr(f1, f2):
235 """ copies the special packaging file attributes from f1 to f2.
237 #pattrs = [x for x in dir(f1) if not hasattr(f2, x) and\
238 # x.startswith('PACKAGING_')]
239 copyit = lambda x: not hasattr(f2, x) and x[:10] == 'PACKAGING_'
240 pattrs = list(filter(copyit, dir(f1)))
242 setattr(f2, attr, getattr(f1, attr))
243 def putintopackageroot(target, source, env, pkgroot, honor_install_location=1):
244 """ Uses the CopyAs builder to copy all source files to the directory given
247 If honor_install_location is set and the copied source file has an
248 PACKAGING_INSTALL_LOCATION attribute, the PACKAGING_INSTALL_LOCATION is
249 used as the new name of the source file under pkgroot.
251 The source file will not be copied if it is already under the the pkgroot
254 All attributes of the source file will be copied to the new file.
256 # make sure the packageroot is a Dir object.
257 if SCons.Util.is_String(pkgroot): pkgroot=env.Dir(pkgroot)
258 if not SCons.Util.is_List(source): source=[source]
262 if SCons.Util.is_String(file): file = env.File(file)
264 if file.is_under(pkgroot):
265 new_source.append(file)
267 if hasattr(file, 'PACKAGING_INSTALL_LOCATION') and\
268 honor_install_location:
269 new_name=make_path_relative(file.PACKAGING_INSTALL_LOCATION)
271 new_name=make_path_relative(file.get_path())
273 new_file=pkgroot.File(new_name)
274 new_file=env.CopyAs(new_file, file)[0]
275 copy_attr(file, new_file)
276 new_source.append(new_file)
278 return (target, new_source)
280 def stripinstallbuilder(target, source, env):
281 """ strips the install builder action from the source list and stores
282 the final installation location as the "PACKAGING_INSTALL_LOCATION" of
283 the source of the source file. This effectively removes the final installed
284 files from the source list while remembering the installation location.
286 It also warns about files which have no install builder attached.
288 def has_no_install_location(file):
289 return not (file.has_builder() and\
290 hasattr(file.builder, 'name') and\
291 (file.builder.name=="InstallBuilder" or\
292 file.builder.name=="InstallAsBuilder"))
294 if len(list(filter(has_no_install_location, source))):
295 warn(Warning, "there are files to package which have no\
296 InstallBuilder attached, this might lead to irreproducible packages")
300 if has_no_install_location(s):
306 setattr(ss, 'PACKAGING_INSTALL_LOCATION', s.get_path())
308 return (target, n_source)
312 # indent-tabs-mode:nil
314 # vim: set expandtab tabstop=4 shiftwidth=4: