Bump to 0.7.12
[quicknote] / support / py2deb.py
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3 ##
4 ##    Copyright (C) 2009 manatlan manatlan[at]gmail(dot)com
5 ##
6 ## This program is free software; you can redistribute it and/or modify
7 ## it under the terms of the GNU General Public License as published
8 ## by the Free Software Foundation; version 2 only.
9 ##
10 ## This program is distributed in the hope that it will be useful,
11 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 ## GNU General Public License for more details.
14 ##
15 """
16 Known limitations :
17 - don't sign package (-us -uc)
18 - no distinctions between author and maintainer(packager)
19
20 depends on :
21 - dpkg-dev (dpkg-buildpackage)
22 - alien
23 - python
24 - fakeroot
25
26 changelog
27  - ??? ?/??/20?? (By epage)
28     - PEP8
29     - added recommends
30     - fixed bug where it couldn't handle the contents of the pre/post scripts being specified
31     - Added customization based on the targeted policy for sections (Maemo support)
32     - Added maemo specific tarball, dsc, changes file generation support (including icon support)
33     - Added armel architecture
34     - Reduced the size of params being passed around by reducing the calls to locals()
35     - Added respository, distribution, priority
36     - Made setting control file a bit more flexible
37  - 0.5 05/09/2009
38     - pre/post install/remove scripts enabled
39     - deb package install py2deb in dist-packages for py2.6
40  - 0.4 14/10/2008
41     - use os.environ USERNAME or USER (debian way)
42     - install on py 2.(4,5,6) (*FIX* do better here)
43
44 """
45
46 import os
47 import hashlib
48 import sys
49 import shutil
50 import time
51 import string
52 import StringIO
53 import stat
54 import commands
55 import base64
56 import tarfile
57 from glob import glob
58 from datetime import datetime
59 import socket # gethostname()
60 from subprocess import Popen, PIPE
61
62 #~ __version__ = "0.4"
63 __version__ = "0.5"
64 __author__ = "manatlan"
65 __mail__ = "manatlan@gmail.com"
66
67
68 PERMS_URW_GRW_OR = stat.S_IRUSR | stat.S_IWUSR | \
69                    stat.S_IRGRP | stat.S_IWGRP | \
70                    stat.S_IROTH
71
72 UID_ROOT = 0
73 GID_ROOT = 0
74
75
76 def run(cmds):
77     p = Popen(cmds, shell=False, stdout=PIPE, stderr=PIPE)
78     time.sleep(0.01)    # to avoid "IOError: [Errno 4] Interrupted system call"
79     out = string.join(p.stdout.readlines()).strip()
80     outerr = string.join(p.stderr.readlines()).strip()
81     return out
82
83
84 def deb2rpm(file):
85     txt=run(['alien', '-r', file])
86     return txt.split(" generated")[0]
87
88
89 def py2src(TEMP, name):
90     l=glob("%(TEMP)s/%(name)s*.tar.gz" % locals())
91     if len(l) != 1:
92         raise Py2debException("don't find source package tar.gz")
93
94     tar = os.path.basename(l[0])
95     shutil.move(l[0], tar)
96
97     return tar
98
99
100 def md5sum(filename):
101     f = open(filename, "r")
102     try:
103         return hashlib.md5(f.read()).hexdigest()
104     finally:
105         f.close()
106
107
108 class Py2changes(object):
109
110     def __init__(self, ChangedBy, description, changes, files, category, repository, **kwargs):
111       self.options = kwargs # TODO: Is order important?
112       self.description = description
113       self.changes=changes
114       self.files=files
115       self.category=category
116       self.repository=repository
117       self.ChangedBy=ChangedBy
118
119     def getContent(self):
120         content = ["%s: %s" % (k, v)
121                    for k,v in self.options.iteritems()]
122
123         if self.description:
124             description=self.description.replace("\n","\n ")
125             content.append('Description: ')
126             content.append(' %s' % description)
127         if self.changes:
128             changes=self.changes.replace("\n","\n ")
129             content.append('Changes: ')
130             content.append(' %s' % changes)
131         if self.ChangedBy:
132             content.append("Changed-By: %s" % self.ChangedBy)
133
134         content.append('Files:')
135
136         for onefile in self.files:
137             md5 = md5sum(onefile)
138             size = os.stat(onefile).st_size.__str__()
139             content.append(' ' + md5 + ' ' + size + ' ' + self.category +' '+self.repository+' '+os.path.basename(onefile))
140
141         return "\n".join(content) + "\n\n"
142
143
144 def py2changes(params):
145     changescontent = Py2changes(
146         "%(author)s <%(mail)s>" % params,
147         "%(description)s" % params,
148         "%(changelog)s" % params,
149         (
150             "%(TEMP)s/%(name)s_%(version)s.tar.gz" % params,
151             "%(TEMP)s/%(name)s_%(version)s.dsc" % params,
152         ),
153         "%(section)s" % params,
154         "%(repository)s" % params,
155         Format='1.7',
156         Date=time.strftime("%a, %d %b %Y %H:%M:%S +0000", time.gmtime()),
157         Source="%(name)s" % params,
158         Architecture="%(arch)s" % params,
159         Version="%(version)s" % params,
160         Distribution="%(distribution)s" % params,
161         Urgency="%(urgency)s" % params,
162         Maintainer="%(author)s <%(mail)s>" % params
163     )
164     f = open("%(TEMP)s/%(name)s_%(version)s.changes" % params,"wb")
165     f.write(changescontent.getContent())
166     f.close()
167
168     fileHandle = open('/tmp/py2deb2.tmp', 'w')
169     fileHandle.write('#!/bin/sh\n')
170     fileHandle.write("cd " +os.getcwd()+ "\n")
171     # TODO Renable signing
172     # fileHandle.write("gpg --local-user %(mail)s --clearsign %(TEMP)s/%(name)s_%(version)s.changes\n" % params)
173     fileHandle.write("mv %(TEMP)s/%(name)s_%(version)s.changes.asc %(TEMP)s/%(name)s_%(version)s.changes\n" % params)
174     fileHandle.write('\nexit')
175     fileHandle.close()
176     commands.getoutput("chmod 777 /tmp/py2deb2.tmp")
177     commands.getoutput("/tmp/py2deb2.tmp")
178
179     ret = []
180
181     l=glob("%(TEMP)s/%(name)s*.tar.gz" % params)
182     if len(l)!=1:
183         raise Py2debException("don't find source package tar.gz")
184     tar = os.path.basename(l[0])
185     shutil.move(l[0],tar)
186     ret.append(tar)
187
188     l=glob("%(TEMP)s/%(name)s*.dsc" % params)
189     if len(l)!=1:
190         raise Py2debException("don't find source package dsc")
191     tar = os.path.basename(l[0])
192     shutil.move(l[0],tar)
193     ret.append(tar)
194
195     l = glob("%(TEMP)s/%(name)s*.changes" % params)
196     if len(l)!=1:
197         raise Py2debException("don't find source package changes")
198     tar = os.path.basename(l[0])
199     shutil.move(l[0],tar)
200     ret.append(tar)
201
202     return ret
203
204
205 class Py2dsc(object):
206
207     def __init__(self, StandardsVersion, BuildDepends, files, **kwargs):
208       self.options = kwargs # TODO: Is order important?
209       self.StandardsVersion = StandardsVersion
210       self.BuildDepends=BuildDepends
211       self.files=files
212
213     @property
214     def content(self):
215         content = ["%s: %s" % (k, v)
216                    for k,v in self.options.iteritems()]
217
218         if self.BuildDepends:
219             content.append("Build-Depends: %s" % self.BuildDepends)
220         if self.StandardsVersion:
221             content.append("Standards-Version: %s" % self.StandardsVersion)
222
223         content.append('Files:')
224
225         for onefile in self.files:
226             print onefile
227             md5 = md5sum(onefile)
228             size = os.stat(onefile).st_size.__str__()
229             content.append(' '+md5 + ' ' + size +' '+os.path.basename(onefile))
230
231         return "\n".join(content)+"\n\n"
232
233
234 def py2dsc(TEMP, name, version, depends, author, mail, arch):
235     dsccontent = Py2dsc(
236         "%(version)s" % locals(),
237         "%(depends)s" % locals(),
238         ("%(TEMP)s/%(name)s_%(version)s.tar.gz" % locals(),),
239         Format='1.0',
240         Source="%(name)s" % locals(),
241         Version="%(version)s" % locals(),
242         Maintainer="%(author)s <%(mail)s>" % locals(),
243         Architecture="%(arch)s" % locals(),
244     )
245
246     filename = "%(TEMP)s/%(name)s_%(version)s.dsc" % locals()
247
248     f = open(filename, "wb")
249     try:
250         f.write(dsccontent.content)
251     finally:
252         f.close()
253
254     fileHandle = open('/tmp/py2deb.tmp', 'w')
255     try:
256         fileHandle.write('#!/bin/sh\n')
257         fileHandle.write("cd " + os.getcwd() + "\n")
258         # TODO Renable signing
259         # fileHandle.write("gpg --local-user %(mail)s --clearsign %(TEMP)s/%(name)s_%(version)s.dsc\n" % locals())
260         fileHandle.write("mv %(TEMP)s/%(name)s_%(version)s.dsc.asc %(filename)s\n" % locals())
261         fileHandle.write('\nexit')
262         fileHandle.close()
263     finally:
264         f.close()
265
266     commands.getoutput("chmod 777 /tmp/py2deb.tmp")
267     commands.getoutput("/tmp/py2deb.tmp")
268
269     return filename
270
271
272 class Py2tar(object):
273
274     def __init__(self, dataDirectoryPath):
275         self._dataDirectoryPath = dataDirectoryPath
276
277     def packed(self):
278         return self._getSourcesFiles()
279
280     def _getSourcesFiles(self):
281         directoryPath = self._dataDirectoryPath
282
283         outputFileObj = StringIO.StringIO() # TODO: Do more transparently?
284
285         tarOutput = tarfile.TarFile.open('sources',
286                                  mode = "w:gz",
287                                  fileobj = outputFileObj)
288
289         # Note: We can't use this because we need to fiddle permissions:
290         #       tarOutput.add(directoryPath, arcname = "")
291
292         for root, dirs, files in os.walk(directoryPath):
293             archiveRoot = root[len(directoryPath):]
294
295             tarinfo = tarOutput.gettarinfo(root, archiveRoot)
296             # TODO: Make configurable?
297             tarinfo.uid = UID_ROOT
298             tarinfo.gid = GID_ROOT
299             tarinfo.uname = ""
300             tarinfo.gname = ""
301             tarOutput.addfile(tarinfo)
302
303             for f in  files:
304                 tarinfo = tarOutput.gettarinfo(os.path.join(root, f),
305                                                os.path.join(archiveRoot, f))
306                 tarinfo.uid = UID_ROOT
307                 tarinfo.gid = GID_ROOT
308                 tarinfo.uname = ""
309                 tarinfo.gname = ""
310                 tarOutput.addfile(tarinfo, file(os.path.join(root, f)))
311
312         tarOutput.close()
313
314         data_tar_gz = outputFileObj.getvalue()
315
316         return data_tar_gz
317
318
319 def py2tar(DEST, TEMP, name, version):
320     tarcontent = Py2tar("%(DEST)s" % locals())
321     filename = "%(TEMP)s/%(name)s_%(version)s.tar.gz" % locals()
322     f = open(filename, "wb")
323     try:
324         f.write(tarcontent.packed())
325     finally:
326         f.close()
327     return filename
328
329
330 class Py2debException(Exception):
331     pass
332
333
334 SECTIONS_BY_POLICY = {
335     # http://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections
336     "debian": "admin, base, comm, contrib, devel, doc, editors, electronics, embedded, games, gnome, graphics, hamradio, interpreters, kde, libs, libdevel, mail, math, misc, net, news, non-free, oldlibs, otherosfs, perl, python, science, shells, sound, tex, text, utils, web, x11",
337     # http://maemo.org/forrest-images/pdf/maemo-policy.pdf
338     "chinook": "accessories, communication, games, multimedia, office, other, programming, support, themes, tools",
339     # http://wiki.maemo.org/Task:Package_categories
340     "diablo": "user/desktop, user/development, user/education, user/games, user/graphics, user/multimedia, user/navigation, user/network, user/office, user/science, user/system, user/utilities",
341     # http://wiki.maemo.org/Task:Fremantle_application_categories
342     "mer": "user/desktop, user/development, user/education, user/games, user/graphics, user/multimedia, user/navigation, user/network, user/office, user/science, user/system, user/utilities",
343     # http://wiki.maemo.org/Task:Fremantle_application_categories
344     "fremantle": "user/desktop, user/development, user/education, user/games, user/graphics, user/multimedia, user/navigation, user/network, user/office, user/science, user/system, user/utilities",
345 }
346
347
348 LICENSE_AGREEMENT = {
349         "gpl": """
350     This package is free software; you can redistribute it and/or modify
351     it under the terms of the GNU General Public License as published by
352     the Free Software Foundation; either version 2 of the License, or
353     (at your option) any later version.
354
355     This package is distributed in the hope that it will be useful,
356     but WITHOUT ANY WARRANTY; without even the implied warranty of
357     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
358     GNU General Public License for more details.
359
360     You should have received a copy of the GNU General Public License
361     along with this package; if not, write to the Free Software
362     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
363
364 On Debian systems, the complete text of the GNU General
365 Public License can be found in `/usr/share/common-licenses/GPL'.
366 """,
367         "lgpl":"""
368     This package is free software; you can redistribute it and/or
369     modify it under the terms of the GNU Lesser General Public
370     License as published by the Free Software Foundation; either
371     version 2 of the License, or (at your option) any later version.
372
373     This package is distributed in the hope that it will be useful,
374     but WITHOUT ANY WARRANTY; without even the implied warranty of
375     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
376     Lesser General Public License for more details.
377
378     You should have received a copy of the GNU Lesser General Public
379     License along with this package; if not, write to the Free Software
380     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
381
382 On Debian systems, the complete text of the GNU Lesser General
383 Public License can be found in `/usr/share/common-licenses/LGPL'.
384 """,
385         "bsd": """
386     Redistribution and use in source and binary forms, with or without
387     modification, are permitted under the terms of the BSD License.
388
389     THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
390     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
391     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
392     ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
393     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
394     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
395     OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
396     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
397     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
398     OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
399     SUCH DAMAGE.
400
401 On Debian systems, the complete text of the BSD License can be
402 found in `/usr/share/common-licenses/BSD'.
403 """,
404         "artistic": """
405     This program is free software; you can redistribute it and/or modify it
406     under the terms of the "Artistic License" which comes with Debian.
407
408     THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
409     WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES
410     OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
411
412 On Debian systems, the complete text of the Artistic License
413 can be found in `/usr/share/common-licenses/Artistic'.
414 """
415 }
416
417
418 class Py2deb(object):
419     """
420     heavily based on technic described here :
421     http://wiki.showmedo.com/index.php?title=LinuxJensMakingDeb
422     """
423     ## STATICS
424     clear = False  # clear build folder after py2debianization
425
426     SECTIONS = SECTIONS_BY_POLICY["debian"]
427
428     #http://www.debian.org/doc/debian-policy/footnotes.html#f69
429     ARCHS = "all i386 ia64 alpha amd64 armeb arm hppa m32r m68k mips mipsel powerpc ppc64 s390 s390x sh3 sh3eb sh4 sh4eb sparc darwin-i386 darwin-ia64 darwin-alpha darwin-amd64 darwin-armeb darwin-arm darwin-hppa darwin-m32r darwin-m68k darwin-mips darwin-mipsel darwin-powerpc darwin-ppc64 darwin-s390 darwin-s390x darwin-sh3 darwin-sh3eb darwin-sh4 darwin-sh4eb darwin-sparc freebsd-i386 freebsd-ia64 freebsd-alpha freebsd-amd64 freebsd-armeb freebsd-arm freebsd-hppa freebsd-m32r freebsd-m68k freebsd-mips freebsd-mipsel freebsd-powerpc freebsd-ppc64 freebsd-s390 freebsd-s390x freebsd-sh3 freebsd-sh3eb freebsd-sh4 freebsd-sh4eb freebsd-sparc kfreebsd-i386 kfreebsd-ia64 kfreebsd-alpha kfreebsd-amd64 kfreebsd-armeb kfreebsd-arm kfreebsd-hppa kfreebsd-m32r kfreebsd-m68k kfreebsd-mips kfreebsd-mipsel kfreebsd-powerpc kfreebsd-ppc64 kfreebsd-s390 kfreebsd-s390x kfreebsd-sh3 kfreebsd-sh3eb kfreebsd-sh4 kfreebsd-sh4eb kfreebsd-sparc knetbsd-i386 knetbsd-ia64 knetbsd-alpha knetbsd-amd64 knetbsd-armeb knetbsd-arm knetbsd-hppa knetbsd-m32r knetbsd-m68k knetbsd-mips knetbsd-mipsel knetbsd-powerpc knetbsd-ppc64 knetbsd-s390 knetbsd-s390x knetbsd-sh3 knetbsd-sh3eb knetbsd-sh4 knetbsd-sh4eb knetbsd-sparc netbsd-i386 netbsd-ia64 netbsd-alpha netbsd-amd64 netbsd-armeb netbsd-arm netbsd-hppa netbsd-m32r netbsd-m68k netbsd-mips netbsd-mipsel netbsd-powerpc netbsd-ppc64 netbsd-s390 netbsd-s390x netbsd-sh3 netbsd-sh3eb netbsd-sh4 netbsd-sh4eb netbsd-sparc openbsd-i386 openbsd-ia64 openbsd-alpha openbsd-amd64 openbsd-armeb openbsd-arm openbsd-hppa openbsd-m32r openbsd-m68k openbsd-mips openbsd-mipsel openbsd-powerpc openbsd-ppc64 openbsd-s390 openbsd-s390x openbsd-sh3 openbsd-sh3eb openbsd-sh4 openbsd-sh4eb openbsd-sparc hurd-i386 hurd-ia64 hurd-alpha hurd-amd64 hurd-armeb hurd-arm hurd-hppa hurd-m32r hurd-m68k hurd-mips hurd-mipsel hurd-powerpc hurd-ppc64 hurd-s390 hurd-s390x hurd-sh3 hurd-sh3eb hurd-sh4 hurd-sh4eb hurd-sparc armel".split(" ")
430
431     # license terms taken from dh_make
432     LICENSES = list(LICENSE_AGREEMENT.iterkeys())
433
434     def __setitem__(self, path, files):
435
436         if not type(files)==list:
437             raise Py2debException("value of key path '%s' is not a list"%path)
438         if not files:
439             raise Py2debException("value of key path '%s' should'nt be empty"%path)
440         if not path.startswith("/"):
441             raise Py2debException("key path '%s' malformed (don't start with '/')"%path)
442         if path.endswith("/"):
443             raise Py2debException("key path '%s' malformed (shouldn't ends with '/')"%path)
444
445         nfiles=[]
446         for file in files:
447
448             if ".." in file:
449                 raise Py2debException("file '%s' contains '..', please avoid that!"%file)
450
451
452             if "|" in file:
453                 if file.count("|")!=1:
454                     raise Py2debException("file '%s' is incorrect (more than one pipe)"%file)
455
456                 file, nfile = file.split("|")
457             else:
458                 nfile=file  # same localisation
459
460             if os.path.isdir(file):
461                 raise Py2debException("file '%s' is a folder, and py2deb refuse folders !"%file)
462
463             if not os.path.isfile(file):
464                 raise Py2debException("file '%s' doesn't exist"%file)
465
466             if file.startswith("/"):    # if an absolute file is defined
467                 if file==nfile:         # and not renamed (pipe trick)
468                     nfile=os.path.basename(file)   # it's simply copied to 'path'
469
470             nfiles.append((file, nfile))
471
472         nfiles.sort(lambda a, b: cmp(a[1], b[1]))    #sort according new name (nfile)
473
474         self.__files[path]=nfiles
475
476     def __delitem__(self, k):
477         del self.__files[k]
478
479     def __init__(self,
480                     name,
481                     description="no description",
482                     license="gpl",
483                     depends="",
484                     section="utils",
485                     arch="all",
486
487                     url="",
488                     author = None,
489                     mail = None,
490
491                     preinstall = None,
492                     postinstall = None,
493                     preremove = None,
494                     postremove = None
495                 ):
496
497         if author is None:
498             author = ("USERNAME" in os.environ) and os.environ["USERNAME"] or None
499             if author is None:
500                 author = ("USER" in os.environ) and os.environ["USER"] or "unknown"
501
502         if mail is None:
503             mail = author+"@"+socket.gethostname()
504
505         self.name = name
506         self.prettyName = ""
507         self.description = description
508         self.upgradeDescription = ""
509         self.bugTracker = ""
510         self.license = license
511         self.depends = depends
512         self.recommends = ""
513         self.section = section
514         self.arch = arch
515         self.url = url
516         self.author = author
517         self.mail = mail
518         self.icon = ""
519         self.distribution = ""
520         self.respository = ""
521         self.urgency = "low"
522
523         self.preinstall = preinstall
524         self.postinstall = postinstall
525         self.preremove = preremove
526         self.postremove = postremove
527
528         self.__files={}
529
530     def __repr__(self):
531         name = self.name
532         license = self.license
533         description = self.description
534         depends = self.depends
535         recommends = self.recommends
536         section = self.section
537         arch = self.arch
538         url = self.url
539         author = self.author
540         mail = self.mail
541
542         preinstall = self.preinstall
543         postinstall = self.postinstall
544         preremove = self.preremove
545         postremove = self.postremove
546
547         paths=self.__files.keys()
548         paths.sort()
549         files=[]
550         for path in paths:
551             for file, nfile in self.__files[path]:
552                 #~ rfile=os.path.normpath(os.path.join(path, nfile))
553                 rfile=os.path.join(path, nfile)
554                 if nfile==file:
555                     files.append(rfile)
556                 else:
557                     files.append(rfile + " (%s)"%file)
558
559         files.sort()
560         files = "\n".join(files)
561
562
563         lscripts = [    preinstall and "preinst",
564                         postinstall and "postinst",
565                         preremove and "prerm",
566                         postremove and "postrm",
567                     ]
568         scripts = lscripts and ", ".join([i for i in lscripts if i]) or "None"
569         return """
570 ----------------------------------------------------------------------
571 NAME        : %(name)s
572 ----------------------------------------------------------------------
573 LICENSE     : %(license)s
574 URL         : %(url)s
575 AUTHOR      : %(author)s
576 MAIL        : %(mail)s
577 ----------------------------------------------------------------------
578 DEPENDS     : %(depends)s
579 RECOMMENDS  : %(recommends)s
580 ARCH        : %(arch)s
581 SECTION     : %(section)s
582 ----------------------------------------------------------------------
583 DESCRIPTION :
584 %(description)s
585 ----------------------------------------------------------------------
586 SCRIPTS : %(scripts)s
587 ----------------------------------------------------------------------
588 FILES :
589 %(files)s
590 """ % locals()
591
592     def generate(self, version, changelog="", rpm=False, src=False, build=True, tar=False, changes=False, dsc=False):
593         """ generate a deb of version 'version', with or without 'changelog', with or without a rpm
594             (in the current folder)
595             return a list of generated files
596         """
597         if not sum([len(i) for i in self.__files.values()])>0:
598             raise Py2debException("no files are defined")
599
600         if not changelog:
601             changelog="* no changelog"
602
603         name = self.name
604         description = self.description
605         license = self.license
606         depends = self.depends
607         recommends = self.recommends
608         section = self.section
609         arch = self.arch
610         url = self.url
611         distribution = self.distribution
612         repository = self.repository
613         urgency = self.urgency
614         author = self.author
615         mail = self.mail
616         files = self.__files
617         preinstall = self.preinstall
618         postinstall = self.postinstall
619         preremove = self.preremove
620         postremove = self.postremove
621
622         if section not in Py2deb.SECTIONS:
623             raise Py2debException("section '%s' is unknown (%s)" % (section, str(Py2deb.SECTIONS)))
624
625         if arch not in Py2deb.ARCHS:
626             raise Py2debException("arch '%s' is unknown (%s)"% (arch, str(Py2deb.ARCHS)))
627
628         if license not in Py2deb.LICENSES:
629             raise Py2debException("License '%s' is unknown (%s)" % (license, str(Py2deb.LICENSES)))
630
631         # create dates (buildDate, buildDateYear)
632         d=datetime.now()
633         buildDate=d.strftime("%a, %d %b %Y %H:%M:%S +0000")
634         buildDateYear=str(d.year)
635
636         #clean description (add a space before each next lines)
637         description=description.replace("\r", "").strip()
638         description = "\n ".join(description.split("\n"))
639
640         #clean changelog (add 2 spaces before each next lines)
641         changelog=changelog.replace("\r", "").strip()
642         changelog = "\n  ".join(changelog.split("\n"))
643
644         TEMP = ".py2deb_build_folder"
645         DEST = os.path.join(TEMP, name)
646         DEBIAN = os.path.join(DEST, "debian")
647
648         packageContents = locals()
649
650         # let's start the process
651         try:
652             shutil.rmtree(TEMP)
653         except:
654             pass
655
656         os.makedirs(DEBIAN)
657         try:
658             rules=[]
659             dirs=[]
660             for path in files:
661                 for ofile, nfile in files[path]:
662                     if os.path.isfile(ofile):
663                         # it's a file
664
665                         if ofile.startswith("/"): # if absolute path
666                             # we need to change dest
667                             dest=os.path.join(DEST, nfile)
668                         else:
669                             dest=os.path.join(DEST, ofile)
670
671                         # copy file to be packaged
672                         destDir = os.path.dirname(dest)
673                         if not os.path.isdir(destDir):
674                             os.makedirs(destDir)
675
676                         shutil.copy2(ofile, dest)
677
678                         ndir = os.path.join(path, os.path.dirname(nfile))
679                         nname = os.path.basename(nfile)
680
681                         # make a line RULES to be sure the destination folder is created
682                         # and one for copying the file
683                         fpath = "/".join(["$(CURDIR)", "debian", name+ndir])
684                         rules.append('mkdir -p "%s"' % fpath)
685                         rules.append('cp -a "%s" "%s"' % (ofile, os.path.join(fpath, nname)))
686
687                         # append a dir
688                         dirs.append(ndir)
689
690                     else:
691                         raise Py2debException("unknown file '' "%ofile) # shouldn't be raised (because controlled before)
692
693             # make rules right
694             rules= "\n\t".join(rules) + "\n"
695             packageContents["rules"] = rules
696
697             # make dirs right
698             dirs= [i[1:] for i in set(dirs)]
699             dirs.sort()
700
701             #==========================================================================
702             # CREATE debian/dirs
703             #==========================================================================
704             open(os.path.join(DEBIAN, "dirs"), "w").write("\n".join(dirs))
705
706             #==========================================================================
707             # CREATE debian/changelog
708             #==========================================================================
709             clog="""%(name)s (%(version)s) stable; urgency=low
710
711   %(changelog)s
712
713  -- %(author)s <%(mail)s>  %(buildDate)s
714 """ % packageContents
715
716             open(os.path.join(DEBIAN, "changelog"), "w").write(clog)
717
718             #==========================================================================
719             #Create pre/post install/remove
720             #==========================================================================
721             def mkscript(name, dest):
722                 if name and name.strip()!="":
723                     if os.path.isfile(name):    # it's a file
724                         content = file(name).read()
725                     else:   # it's a script
726                         content = name
727                     open(os.path.join(DEBIAN, dest), "w").write(content)
728
729             mkscript(preinstall, "preinst")
730             mkscript(postinstall, "postinst")
731             mkscript(preremove, "prerm")
732             mkscript(postremove, "postrm")
733
734
735             #==========================================================================
736             # CREATE debian/compat
737             #==========================================================================
738             open(os.path.join(DEBIAN, "compat"), "w").write("5\n")
739
740             #==========================================================================
741             # CREATE debian/control
742             #==========================================================================
743             generalParagraphFields = [
744                 "Source: %(name)s",
745                 "Maintainer: %(author)s <%(mail)s>",
746                 "Section: %(section)s",
747                 "Priority: extra",
748                 "Build-Depends: debhelper (>= 5)",
749                 "Standards-Version: 3.7.2",
750             ]
751
752             specificParagraphFields = [
753                 "Package: %(name)s",
754                 "Architecture: %(arch)s",
755                 "Depends: %(depends)s",
756                 "Recommends: %(recommends)s",
757                 "Description: %(description)s",
758             ]
759
760             if self.prettyName:
761                 prettyName = "XSBC-Maemo-Display-Name: %s" % self.prettyName.strip()
762                 specificParagraphFields.append("\n  ".join(prettyName.split("\n")))
763
764             if self.bugTracker:
765                 bugTracker = "XSBC-Bugtracker: %s" % self.bugTracker.strip()
766                 specificParagraphFields.append("\n  ".join(bugTracker.split("\n")))
767
768             if self.upgradeDescription:
769                 upgradeDescription = "XSBC-Maemo-Upgrade-Description: %s" % self.upgradeDescription.strip()
770                 specificParagraphFields.append("\n  ".join(upgradeDescription.split("\n")))
771
772             if self.icon:
773                 f = open(self.icon, "rb")
774                 try:
775                     rawIcon = f.read()
776                 finally:
777                     f.close()
778                 uueIcon = base64.b64encode(rawIcon)
779                 uueIconLines = []
780                 for i, c in enumerate(uueIcon):
781                     if i % 60 == 0:
782                         uueIconLines.append("")
783                     uueIconLines[-1] += c
784                 uueIconLines[0:0] = ("XSBC-Maemo-Icon-26:", )
785                 specificParagraphFields.append("\n  ".join(uueIconLines))
786
787             generalParagraph = "\n".join(generalParagraphFields)
788             specificParagraph = "\n".join(specificParagraphFields)
789             controlContent = "\n\n".join((generalParagraph, specificParagraph)) % packageContents
790             open(os.path.join(DEBIAN, "control"), "w").write(controlContent)
791
792             #==========================================================================
793             # CREATE debian/copyright
794             #==========================================================================
795             packageContents["txtLicense"] = LICENSE_AGREEMENT[license]
796             packageContents["pv"] =__version__
797             txt="""This package was py2debianized(%(pv)s) by %(author)s <%(mail)s> on
798 %(buildDate)s.
799
800 It was downloaded from %(url)s
801
802 Upstream Author: %(author)s <%(mail)s>
803
804 Copyright: %(buildDateYear)s by %(author)s
805
806 License:
807
808 %(txtLicense)s
809
810 The Debian packaging is (C) %(buildDateYear)s, %(author)s <%(mail)s> and
811 is licensed under the GPL, see above.
812
813
814 # Please also look if there are files or directories which have a
815 # different copyright/license attached and list them here.
816 """ % packageContents
817             open(os.path.join(DEBIAN, "copyright"), "w").write(txt)
818
819             #==========================================================================
820             # CREATE debian/rules
821             #==========================================================================
822             txt="""#!/usr/bin/make -f
823 # -*- makefile -*-
824 # Sample debian/rules that uses debhelper.
825 # This file was originally written by Joey Hess and Craig Small.
826 # As a special exception, when this file is copied by dh-make into a
827 # dh-make output file, you may use that output file without restriction.
828 # This special exception was added by Craig Small in version 0.37 of dh-make.
829
830 # Uncomment this to turn on verbose mode.
831 #export DH_VERBOSE=1
832
833
834
835
836 CFLAGS = -Wall -g
837
838 ifneq (,$(findstring noopt,$(DEB_BUILD_OPTIONS)))
839         CFLAGS += -O0
840 else
841         CFLAGS += -O2
842 endif
843
844 configure: configure-stamp
845 configure-stamp:
846         dh_testdir
847         # Add here commands to configure the package.
848
849         touch configure-stamp
850
851
852 build: build-stamp
853
854 build-stamp: configure-stamp
855         dh_testdir
856         touch build-stamp
857
858 clean:
859         dh_testdir
860         dh_testroot
861         rm -f build-stamp configure-stamp
862         dh_clean
863
864 install: build
865         dh_testdir
866         dh_testroot
867         dh_clean -k
868         dh_installdirs
869
870         # ======================================================
871         #$(MAKE) DESTDIR="$(CURDIR)/debian/%(name)s" install
872         mkdir -p "$(CURDIR)/debian/%(name)s"
873
874         %(rules)s
875         # ======================================================
876
877 # Build architecture-independent files here.
878 binary-indep: build install
879 # We have nothing to do by default.
880
881 # Build architecture-dependent files here.
882 binary-arch: build install
883         dh_testdir
884         dh_testroot
885         dh_installchangelogs debian/changelog
886         dh_installdocs
887         dh_installexamples
888 #       dh_install
889 #       dh_installmenu
890 #       dh_installdebconf
891 #       dh_installlogrotate
892 #       dh_installemacsen
893 #       dh_installpam
894 #       dh_installmime
895 #       dh_python
896 #       dh_installinit
897 #       dh_installcron
898 #       dh_installinfo
899         dh_installman
900         dh_link
901         dh_strip
902         dh_compress
903         dh_fixperms
904 #       dh_perl
905 #       dh_makeshlibs
906         dh_installdeb
907         dh_shlibdeps
908         dh_gencontrol
909         dh_md5sums
910         dh_builddeb
911
912 binary: binary-indep binary-arch
913 .PHONY: build clean binary-indep binary-arch binary install configure
914 """ % packageContents
915             open(os.path.join(DEBIAN, "rules"), "w").write(txt)
916             os.chmod(os.path.join(DEBIAN, "rules"), 0755)
917
918             ###########################################################################
919             ###########################################################################
920             ###########################################################################
921
922             generatedFiles = []
923
924             if build:
925                 #http://www.debian.org/doc/manuals/maint-guide/ch-build.fr.html
926                 ret = os.system('cd "%(DEST)s"; dpkg-buildpackage -tc -rfakeroot -us -uc' % packageContents)
927                 if ret != 0:
928                     raise Py2debException("buildpackage failed (see output)")
929
930                 l=glob("%(TEMP)s/%(name)s*.deb" % packageContents)
931                 if len(l) != 1:
932                     raise Py2debException("didn't find builded deb")
933
934                 tdeb = l[0]
935                 deb = os.path.basename(tdeb)
936                 shutil.move(tdeb, deb)
937
938                 generatedFiles = [deb, ]
939
940                 if rpm:
941                     rpmFilename = deb2rpm(deb)
942                     generatedFiles.append(rpmFilename)
943
944                 if src:
945                     tarFilename = py2src(TEMP, name)
946                     generatedFiles.append(tarFilename)
947
948             if tar:
949                 tarFilename = py2tar(DEST, TEMP, name, version)
950                 generatedFiles.append(tarFilename)
951
952             if dsc:
953                 dscFilename = py2dsc(TEMP, name, version, depends, author, mail, arch)
954                 generatedFiles.append(dscFilename)
955
956             if changes:
957                 changesFilenames = py2changes(packageContents)
958                 generatedFiles.extend(changesFilenames)
959
960             return generatedFiles
961
962         #~ except Exception,m:
963             #~ raise Py2debException("build error :"+str(m))
964
965         finally:
966             if Py2deb.clear:
967                 shutil.rmtree(TEMP)
968
969
970 if __name__ == "__main__":
971     try:
972         os.chdir(os.path.dirname(sys.argv[0]))
973     except:
974         pass
975
976     p=Py2deb("python-py2deb")
977     p.description="Generate simple deb(/rpm/tgz) from python (2.4, 2.5 and 2.6)"
978     p.url = "http://www.manatlan.com/page/py2deb"
979     p.author=__author__
980     p.mail=__mail__
981     p.depends = "dpkg-dev, fakeroot, alien, python"
982     p.section="python"
983     p["/usr/lib/python2.6/dist-packages"] = ["py2deb.py", ]
984     p["/usr/lib/python2.5/site-packages"] = ["py2deb.py", ]
985     p["/usr/lib/python2.4/site-packages"] = ["py2deb.py", ]
986     #~ p.postinstall = "s.py"
987     #~ p.preinstall = "s.py"
988     #~ p.postremove = "s.py"
989     #~ p.preremove = "s.py"
990     print p
991     print p.generate(__version__, changelog = __doc__, src=True)