root/Trunk/setup.py

#!/usr/bin/python

# $Id$

'''

Copyright 2006 - 2008 Todd D. Esposito.

This file is part of TurtolCMS.

    TurtolCMS is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as 
    published by the Free Software Foundation, either version 3 of the 
    License, or (at your option) any later version.

    TurtolCMS 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public 
    License along with TurtolCMS.  If not, see <http://www.gnu.org/licenses/>.

'''

# Most of this is creating python that will generate resource files on the
# fly (javascript, css, and images). The actual "build" process is at the
# bottom of the file.

import sys, os, os.path, shutil
from datetime import datetime
from sha import sha

def MakeETag(filepath):
  return sha("%s%s" % (filepath, str( datetime.now() ) ) ).hexdigest()
  
def rcs_to_py (name):
  ''' make a python module name from a source file name
  '''
  if name[-3:] == ".py":
    return name
  return "%s.py" % name.replace ('.', '_')

_pageheader = '''# DO NOT EDIT THIS FILE BY HAND!
# TurtolCMS setup generated this file; any edits here will be lost
# the next time TurtolCMS is updated.  See the developer documentation
# at http://www.turtolcms.org/ for further information.
'''

_starttextpage = '''
from TurtolCMS.Core import Asset

class AssetProxy (Asset):
  def __init__ (self, uri, ctx):
    super (AssetProxy, self).__init__ (uri, ctx, types=['TurtolCMS.Types.Page', 'TurtolCMS.Types.RawTextPage'])
    self['etag'] = '%(etag)s'
    #self['modified'] = %(modified)s
    self['TurtolCMS.Types.RawTextPage.type'] = '%(type)s'
'''

_startdatapage = '''
from TurtolCMS.Core import Asset

class AssetProxy (Asset):
  def __init__ (self, uri, ctx):
    super (AssetProxy, self).__init__ (uri, ctx, types=['TurtolCMS.Types.Page', 'TurtolCMS.Types.RawDataPage'])
    self['etag'] = '%(etag)s'
    #self['modified'] = %(modified)s
    self['TurtolCMS.Types.RawDataPage.type'] = '%(type)s'
    self['TurtolCMS.Types.RawDataPage.length'] = %(length)s
'''

_starttext = "\n    self['TurtolCMS.Types.RawTextPage.text'] = '''"

_startdata = "\n    self['TurtolCMS.Types.RawDataPage.data'] = '''"

_endtext = "'''\n"

_enddata = "'''\n"

_endpage = ""

def GenTextPage (src, target, type):
  rval = True
  etag = MakeETag (target)
  modified = datetime.now()
  try:
    out = file (target, 'w')
    out.write (_pageheader % locals())
    out.write (_starttextpage % locals())

    out.write (_starttext % locals())
    for line in src:
      out.write (line.replace("\\", "\%s" %"\\"))
    out.write (_endtext % locals())

    out.write (_endpage % locals())
    out.close()
  except:
    rval = False
  return rval

def GenImagePage (src, target, type):
  rval = True
  etag = MakeETag (target)
  modified = datetime.now()

  # IMPORTANT NOTE: src must support seeking for this to work; shouldn't be an issue
  src.seek (0, 2)
  length = src.tell()
  src.seek (0, 0)

  try:
    out = file (target, 'w')
    out.write (_pageheader % locals())
    out.write (_startdatapage % locals())

    out.write (_startdata % locals())
    for c in src.read():
      if ord(c) < ord (' ') or ord(c) > ord ('~'):
        if ord (c) < 16:
          out.write ('\\x0%s' % hex(ord(c))[-1:])
        else:
          out.write ('\\x%s' % hex (ord(c))[-2:])
      elif c == '\\':
        out.write ('\\\\')
      elif c == "'":
        out.write("\\'")
      else:
        out.write (c)
    out.write (_enddata % locals())

    out.write (_endpage % locals())
    out.close()
  except:
    rval = False
  return rval
  
def PassThru (src, target, type):
  # just copy the source to target
  out = file (target, 'w')
  for l in src.readlines():
    out.write (l)
  out.close()
  return True

def CssMinifier (src):
  # TODO: minify the CSS
  return file (src, 'r')

  #create the css file by passing the source through the css_slimmer
  from slimmer.slimmer import css_slimmer
  src = file (inputFile)
  # for line in src:
  out.write ("    w('''")
  out.write (css_slimmer (src.read()))
  #out.write (line.replace("\\", "\%s" %"\\").strip())
  out.write ("\\n ''')\n")
  src.close()
  out.close()

def JsMinifier (src):
  # TODO: minify the Js
  return file (src, 'r')

  #create the js file by passing the source through the JSMinifier
  from jsmin import JavascriptMinify
  import StringIO
  src = file (inputFile)
  # for line in src:
  out.write ("    w('''")
  JavascriptMinify().minify(src, out)
  #out.write (line.replace("\\", "\%s" %"\\").strip())
  out.write ("\\n ''')\n")
  # src.close()  -- Done by minify()
  out.close()

def GenerateResources():
  import mimetypes
  # some configuration constants
  api_source = 'api_resources'
  src_len = len (api_source)
  api_base = 'TurtolCMS/Api'
  api_init = '%s/__init__.py' % api_base

  # this maps content (mime) types to the appropriate generators/processor
  # each value tuple consists of the output generator function and
  # corresponding input filter for each MIME type.  The 'file' filter
  # can be used to just read the file straight up.
  generators = { 'application/javascript' : (GenTextPage, JsMinifier)
               , 'text/css'               : (GenTextPage, CssMinifier)
               , 'text/plain'             : (GenTextPage, file)
               , 'text/x-python'          : (PassThru, file)
               , 'image/png'              : (GenImagePage, file)
               }

  print "Generating api code modules from source..."
  modified = False
  mimetypes.init()
  mimetypes.add_type("text/plain", ".htc")
  
  # make sure we have the api base directory
  if not os.path.isdir (api_base):
    try:
      os.mkdir (api_base)
      modified = True
    except:
      print "Error: Cannot create '%s' for API generation" % api_base
      sys.exit (1)

  # walk the resources tree
  walker = os.walk (api_source)
  for root, dirs, files in walker:
    # we don't want to process svn control directories
    if '.svn' in dirs:
      dirs.remove ('.svn')

    # we can also dump readme and license files
    # This is principly for tiny_mce
    if 'readme.txt' in files:
      files.remove ('readme.txt')
    if 'license.txt' in files:
      files.remove ('license.txt')

    target = "%s%s" % (api_base, root[src_len:])
    
    #append target to Api_Packages so sub-directories are copied to site-packages during build
    Api_Packages.append(target.replace("/", "."))

    # make sure an equiv to root exists in api, generate if needed
    if not os.path.exists (target):
      try:
        os.mkdir (target)
        ifile = file("%s/__init__.py" % target, 'w')
        ifile.close()
        modified = True
      except:
        print "Error: Cannot create '%s' for API generation" % target
        sys.exit (1)
    for f in files:
      # skip any files starting with "."
      if f[0] != ".":
        # check that an equiv to f exists in api, and is not newer
        sourcefile = os.path.join (root, f)
        targetfile = os.path.join (target, rcs_to_py(f))
        if (not os.path.exists (targetfile)) \
        or os.path.getmtime (targetfile) < os.path.getmtime (sourcefile):
          contentType = mimetypes.guess_type(sourcefile)[0]
          if contentType:
            print "Generating '%s' (%s) from '%s'..." % (targetfile, contentType, f)
            proc, filter = generators.get (contentType, (None, None))
            if proc:
              if proc (filter (sourcefile), targetfile, contentType):
                modified = True
              else:
                print "Fatal Error while converting source file '%s'" % sourcefile
                sys.exit (1)
            else:
              print "Warning: unhandled source file '%s' of type '%s'" % (sourcefile, fullContentType)
          else:
            print "Warning: unhandled source file '%s' of UNKNOWN type" % sourcefile

  # if we've found a modified file and/or the api module init wasn't there, set the install time
  if modified or not os.path.isfile (api_init):
    initsrc = file (api_init, 'w')
    initsrc.write ('#!/usr/bin/python\n\n')
    initsrc.write("# This file is created on the fly by setup and should not be edited by human hands\n\n")
    initsrc.write('CMS_INSTALL_TIME = "%s"\n' % datetime.utcnow().strftime("%a, %d %b %Y %H:%M:%S GMT"))
    initsrc.close()

def EnumerateAssetTypes ():
  print "Generating Type List..."
  types = ['TurtolCMS.Core.CmsType']  # the only guaranteed type
  # Create the list of all known types
  for l in Libraries:
    print "... from library '%s'" % l
    walker = os.walk (l)
    for root, dirs, files in walker:
      if '.svn' in dirs:
        dirs.remove ('.svn')

      for f in files:
        if f[-3:] == '.py' and f[:2] != '__':
          types.append ("%s.%s" % (l, f[0:-3]))
  if types:
    f = file ('TurtolCMS/Api/TypeList.py', 'w')
    f.write ('TypeList = [\n')
    for t in types:
      f.write (  "'%s',\n" % t.replace ('/', '.'))
    f.write (' ]\n')
    f.close()
  else:
    print "types is none?"

Api_Packages = []
Libraries = ['TurtolCMS/Types']

# This next is naive, but good enough for now.
if len(sys.argv) > 1 and sys.argv[1] in ['gen', 'build', 'build_py', 'install', 'install_py']:
  #generate our js, css and img resources from source
  GenerateResources()
  EnumerateAssetTypes()
  if sys.argv[1] == 'gen':
    sys.exit (0)

# raise RuntimeError ('aborting; testing mode')

from TurtolCMS import __version__ as cms_version
from distutils.core import setup
setup (name='TurtolCMS',
      description='Turtol Content Management System',
      author='The TurtolCMS Team',
      author_email='Dev@TurtolCMS.org',
      url='http://www.turtolcms.org',
      version= cms_version,
      license='AGPL-3',
      packages = [ 'TurtolCMS'
                 , 'TurtolCMS.Api'
#                 , 'TurtolCMS.Application'
#                 , 'TurtolCMS.Assets'
                 , 'TurtolCMS.BootStrap'
#                 , 'TurtolCMS.Calendar'
#                 , 'TurtolCMS.Controls'
                 , 'TurtolCMS.Core'
#                 , 'TurtolCMS.Forms'
#                 , 'TurtolCMS.GoogleTools'
                 , 'TurtolCMS.Libs'                 
#                 , 'TurtolCMS.Newsletter'
#                 , 'TurtolCMS.Pages'
                 , 'TurtolCMS.Storage'
                 , 'TurtolCMS.Types'
#                 , 'TurtolCMS.Widgets'
                 ] + Api_Packages + Libraries,
      data_files = [ ('/usr/bin', ['utils/tcms']) # , 'utils/tcmsSend']) 
#                   , ('/usr/share/TurtolCMS', ['utils/tcms5to6.sql'])
                   ]
      )

# vim: set ts=2 sw=2 expandtab: #