daklib/filewriter.py

   1 #!/usr/bin/env python
   2 """
   3 Helper code for file writing with optional compression.
   4
   5 @contact: Debian FTPMaster <ftpmaster@debian.org>
   6 @copyright: 2011 Torsten Werner <twerner@debian.org>
   7 @license: GNU General Public License version 2 or later
   8 """
   9
  10 ################################################################################
  11
  12 # This program is free software; you can redistribute it and/or modify
  13 # it under the terms of the GNU General Public License as published by
  14 # the Free Software Foundation; either version 2 of the License, or
  15 # (at your option) any later version.
  16
  17 # This program is distributed in the hope that it will be useful,
  18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 # GNU General Public License for more details.
  21
  22 # You should have received a copy of the GNU General Public License
  23 # along with this program; if not, write to the Free Software
  24 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  25
  26 ################################################################################
  27
  28 from daklib.config import Config
  29
  30 from subprocess import check_call
  31
  32 import os, os.path
  33
  34 class BaseFileWriter(object):
  35     '''
  36     Base class for compressed and uncompressed file writing.
  37     '''
  38     def __init__(template, **keywords):
  39         '''
  40         The template argument is a string template like
  41         "dists/%(suite)s/%(component)s/Contents-%(architecture)s.gz" that
  42         should be relative to the archive's root directory. The keywords
  43         include strings for suite, component, architecture and booleans
  44         uncompressed, gzip, bzip2.
  45         '''
  46         self.uncompressed = keywords.get('uncompressed', True)
  47         self.gzip = keywords.get('gzip', False)
  48         self.bzip2 = keywords.get('bzip2', False)
  49         root_dir = Config()['Dir::Root']
  50         relative_dir = template % keywords
  51         self.path = os.path.join(root_dir, relative_dir)
  52
  53     def open(self):
  54         '''
  55         Returns a file object for writing.
  56         '''
  57         self.file = open(self.path + '.new')
  58
  59     # internal helper function
  60     def rename(self, filename):
  61         tempfilename = filename + '.new'
  62         os.chmod(tempfilename, 0664)
  63         os.rename(tempfilename, filename)
  64
  65     def close(self):
  66         '''
  67         Closes the file object and does the compression and rename work.
  68         '''
  69         self.file.close()
  70         if self.gzip:
  71             check_call('gzip --rsyncable <%s.new >%s.gz.new' % (self.path, self.path),
  72                 shell = True)
  73             self.rename('%s.gz' % self.path)
  74         if self.bzip2:
  75             check_call('bzip2 <%s.new >%s.bz2.new' % (self.path, self.path), shell = True)
  76             self.rename('%s.bz2' % self.path)
  77         if self.uncompressed:
  78             self.rename(self.path)
  79         else:
  80             os.unlink(self.path)
  81
  82 class BinaryContentsWriter(BaseFileWriter):
  83     def __init__(**keywords):
  84         '''
  85         The value of the keywords suite, component, and architecture are
  86         strings. The value of component may be omitted if not applicable.
  87         Output files are gzip compressed only.
  88         '''
  89         flags = {
  90             'uncompressed': False,
  91             'gzip':         True,
  92             'bzip2':        False
  93         }
  94         flags.update(keywords)
  95         if 'component' in flags:
  96             template "dists/%(suite)s/%(component)s/Contents-%(architecture)s.gz" % values
  97         else:
  98             template = "dists/%(suite)s/Contents-%(architecture)s.gz" % values
  99         BaseFileWriter.__init__(self, template, **flags)