disttar.py

#!python
# vim: set et sw=3 tw=0 fo=awqorc ft=python:
# DistTarBuilder: tool to generate tar files using SCons
# Copyright (C) 2005, 2006  Matthew A. Nicholson
# Copyright (C) 2006  John Pye
#
# This file is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 2.1 as published by the Free Software Foundation.
#
# This file 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# DISTTAR_EXCLUDEPATTERN functionality added by Alexander Dreyer, PolyBoRi Team

import os,sys
from SCons.Script import *
import SCons.Builder
from glob import glob
def DistTarEmitter(target,source,env):

   source,origsource = [], source

   excludeexts = env.Dictionary().get('DISTTAR_EXCLUDEEXTS',[])
   excludedirs = env.Dictionary().get('DISTTAR_EXCLUDEDIRS',[])
   excludepattern = env.Dictionary().get('DISTTAR_EXCLUDEPATTERN',[])

   # assume the sources are directories... need to check that
   for item in origsource:
      if os.path.isdir(str(item)):
         for root, dirs, files in os.walk(str(item)):

            ignoreglobs = []
            for patt in excludepattern:
                ignoreglobs += glob(os.path.join(root, patt))
                  
            # Was: don't make directory dependences as that triggers full build
            # of that directory
            # Since this is a recurring mistake:
            # Indeed: adding directories to be dependencies will trigger build!
            # But we want to stay in clean for distributing
            #
            # But - to fix permission - we will add the directory on the fly 
            # (while taring)
            if root in source:
               #print "Removing directory %s" % root
               source.remove(root)

            # loop through files in a directory
            for name in files:
               ext = os.path.splitext(name)
               if not ext[1] in excludeexts:
                  relpath = os.path.join(root,name)
                  if not relpath in ignoreglobs:
                      source.append(relpath)

            for d in excludedirs:
               if d in dirs:
                  dirs.remove(d)  # don't visit CVS directories etc
      else:
         ext = os.path.splitext(str(item))
         if not ext[1] in excludeexts:
            source.append(str(item))

   return target, source

def DistTarString(target, source, env):
   """
   This is what gets printed on the console. We'll strip out the list or source 
   files, since it tends to get very long. If you want to see the contents, the 
   easiest way is to uncomment the line 'Adding to TAR file' below.
   """
   return 'DistTar(%s,...)' % str(target[0])

def DistTar(target, source, env):
   """tar archive builder"""

   import tarfile

   env_dict = env.Dictionary()

   if env_dict.get("DISTTAR_FORMAT") in ["gz", "bz2"]:
      tar_format = env_dict["DISTTAR_FORMAT"]
   else:
      tar_format = ""

   # split the target directory, filename, and stuffix
   base_name = str(target[0]).split('.tar')[0]
   (target_dir, dir_name) = os.path.split(base_name)

   # create the target directory if it does not exist
   if target_dir and not os.path.exists(target_dir):
      os.makedirs(target_dir)

   # open our tar file for writing
   sys.stderr.write("DistTar: Writing "+str(target[0]))
   import time
   mtime= time.time()

   tar = tarfile.open(str(target[0]), "w:%s" % (tar_format,))

   default_info = tarfile.TarInfo()

   # write sources to our tar file
   files = []
   for item in source:
      itemdir=item.dir

      visited = [item]
      if itemdir not in files:
         while str(itemdir) != "."  and not itemdir in files:
            visited.insert(0, itemdir)
            itemdir = itemdir.dir
      files += visited

   for item in files:
      item = str(item)
      sys.stderr.write(".")
      #print "Adding to TAR file: %s/%s" % (dir_name,item)
      info = tar.gettarinfo(item,'%s/%s' % (dir_name,item))

      if info is None:
         sys.stderr.write("disttar: Unsupported type %r" % item)
         return

      info.mtime = mtime
      info.gname = default_info.gname
      info.uname = default_info.uname
      info.gid = default_info.gid
      info.uid = default_info.uid

      if info.isreg():
         if os.access(item, os.X_OK):
            info.mode = 0100755
         else:
            info.mode = 0100644
         file = open(item, "rb")
         tar.addfile(info, file)
         file.close()

      else:
         if info.isdir():
            info.mode = 040755
         tar.addfile(info)         

   # all done
   sys.stderr.write("\n") #print "Closing TAR file"
   tar.close()

def DistTarSuffix(env, sources):
   """tar archive suffix generator"""

   env_dict = env.Dictionary()
   if env_dict.has_key("DISTTAR_FORMAT") and env_dict["DISTTAR_FORMAT"] in ["gz", "bz2"]:
      return ".tar." + env_dict["DISTTAR_FORMAT"]
   else:
      return ".tar"

def generate(env):
   """
   Add builders and construction variables for the DistTar builder.
   """

   env.Append(BUILDERS = {
      'DistTar': env.Builder(
         action = SCons.Action.Action(DistTar, DistTarString),
         suffix = DistTarSuffix,
         emitter = DistTarEmitter,
         target_factory = env.fs.Entry,
      ),
   })

   env.AppendUnique(
      DISTTAR_FORMAT = 'gz',
   )

def exists(env):
   """
   Make sure this tool exists.
   """
   try:
      import os
      import tarfile
   except ImportError:
      return False
   else:
      return True