build.py

# Copyright 2009 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import glob
import logging
import md5
import os
import random
import re
import sys
import StringIO
import time
import zipfile
import os.path


ZIP_SKIP_RE = re.compile('\.svn|\.pyc|\.[pm]o')
IGNORED_CONTRIB = ('admin', 'gis', 'comments', 'localflavor', 'databrowse')
ROOT_DIR = os.path.dirname(__file__)
DOC_DIR = os.path.join(ROOT_DIR, 'doc')
RST_TEMPLATE_PATH = os.path.join(DOC_DIR, 'template.rst2html')
API_TEMPLATE_DIR = os.path.join(ROOT_DIR, 'api', 'templates')

HELP_SITE_NAME = """
Your site name is important, it's the name of your site!
"""

HELP_SECRET_KEY = """
This is a secret key, you should keep it secret.
"""

HELP_GAE_DOMAIN = """
This is the appspot.com domain you are going to host your app at. Even if you
are running under a hosted domain you will want to set this so that you can
allow SSL for logins.
"""

HELP_HOSTED_DOMAIN_ENABLED = """
Are you hosting this on your own domain instead of YOUR_APP.appspot.com? If so
you need to check this box and enter the domain you are using below.
"""

HELP_HOSTED_DOMAIN = """
If you checked the box to Enable Hosted Domain above you will need to enter
the domain you are hosting on here.
"""

HELP_NS_DOMAIN = """
This is the namespace you plan on using for the nicknames of your users, a
safe bet is to set this to be the same as Hosted Domain above, or to your
Google App Engine Domain if you did not enable Hosted Domains.
"""

HELP_ROOT_NICK = """
This is the nick for the admin user. It should probably look something like
admin@<Your Namespace Domain>
"""

HELP_SSL_LOGIN_ENABLED = """
Enabling SSL logins is a good idea for the safety of your users. If you have
enabled Hosted Domains above, your login page will be shown via the Google App Engine Domain listed above.
"""

HELP_DEFAULT_FROM_EMAIL = """
This the email address mail from your app will be sent from, it needs to be
one of the developers of the app (i.e. you) for App Engine to accept it.
"""


def bootstrap(only_check_for_zips=False):
  logging.info('Beginning bootstrap...')
  l = os.listdir('vendor')
  for vendor_lib in l:
    if vendor_lib.startswith('.'):
      continue
    if only_check_for_zips and os.path.exists('%s.zip' % vendor_lib):
      continue
    logging.info('Building zip for %s...' % vendor_lib)
    zip_vendor_lib(vendor_lib)
  logging.info('Finishing bootstrap.')

def generate_api_docs():
  logging.info('Generating api docs...')
  from epydoc import docparser

  try:
    import roman
  except ImportError:
    print ("Could not import module 'roman,' docutils has not been installed"
          "properly")
    print "Please install docutils: http://docutils.sourceforge.net"
    sys.exit(1)

  from common import api
  
  a = docparser.parse_docs(name='common.api')
  variables = a.apidoc_links(imports=False, 
                             packages=False, 
                             submodules=False,
                             bases=False,
                             subclasses=False,
                             private=False,
                             overrides=False)


  public_api_methods = api.PublicApi.methods.keys()
  public_decorators = ['throttle', 'owner_required']

  allowed_names = public_api_methods + public_decorators
  for v in variables:
    if v.name in public_api_methods:
      prefix = "method"
    elif v.name in public_decorators:
      prefix = "deco"
    else:
      continue
    
    filename = '%s_%s.txt' % (prefix, v.name)
    path = os.path.join(DOC_DIR, filename)

    logging.info('  for %s...' % v.name)

    docs = rst_docs(v.value)
    
    f = open(path, 'w')
    f.write(docs)
    f.close()
  logging.info('Finished generating api docs.')

def build_docs():
  logging.info('Building html docs...')
  txts = glob.glob(os.path.join(DOC_DIR, '*.txt')) 
  for t in txts:
    basename = os.path.basename(t)
    baseroot, ext = os.path.splitext(basename)
    outname = os.path.join(API_TEMPLATE_DIR, 'built_%s.html' % baseroot)

    logging.info('  for %s...' % baseroot)

    infile = open(t)
    outfile = open(outname, 'w')

    rst_to_html(infile, outfile)
    infile.close()
    outfile.close()
  
  logging.info('Finished building html docs.')

def check_config():
  # TODO(termie): 
  pass

def config(write_to_file=False):
  d = {}
  d['DEBUG'] = False
  d['TEMPLATE_DEBUG'] = False
  d['SITE_NAME'] = get_input(HELP_SITE_NAME, 'Enter a site name')
  d['SECRET_KEY'] = get_input(HELP_SECRET_KEY, 
                              'Enter a secret key', 
                              generate_secret_key())

  d['GAE_DOMAIN'] = get_input(HELP_GAE_DOMAIN, 
                              'Enter an appspot domain')
  d['HOSTED_DOMAIN_ENABLED'] = get_input(HELP_HOSTED_DOMAIN_ENABLED,
                                         'Enabled Hosted Domains (yes|no)',
                                         'yes',
                                         yesno)
  if d['HOSTED_DOMAIN_ENABLED']:
    d['HOSTED_DOMAIN'] = get_input(HELP_HOSTED_DOMAIN,
                                   'Enter your hosted domain (without www.)')

  if d['HOSTED_DOMAIN_ENABLED']:
    default_ns = d['HOSTED_DOMAIN']
    d['DOMAIN'] = 'www.%s' % d['HOSTED_DOMAIN']
  else:
    default_ns = d['GAE_DOMAIN']
    d['DOMAIN'] = d['GAE_DOMAIN']

  d['COOKIE_DOMAIN'] = d['DOMAIN']

  d['NS_DOMAIN'] = get_input(HELP_NS_DOMAIN,
                             'Enter your namespace domain',
                             default_ns)

  default_root = 'admin@%s' % d['NS_DOMAIN']
  d['ROOT_NICK'] = get_input(HELP_ROOT_NICK,
                             'Enter the nick for your admin user',
                             default_root)

  d['SSL_LOGIN_ENABLED'] = get_input(HELP_SSL_LOGIN_ENABLED,
                                     'Enable SSL login (yes|no)',
                                     'yes',
                                     yesno)
  d['DEFAULT_FROM_EMAIL'] = get_input(HELP_DEFAULT_FROM_EMAIL,
                                      'Enter an email address to send from')
  o = []
  for k, v in d.iteritems():
    o.append('%s = %r\n' % (k, v))

  if write_to_file:
    print
    print 'Writing your settings to local_settings.py...',
    f = open('local_settings.py', 'w')
    f.write('\n'.join(o))
    f.close()
    print ' done.'
  else:
    print
    print 'Your settings:'
    print
    print '\n'.join(o)

def clean(skip_zip=False):
  # TODO(termie): running this multiple times will tend to create zip files
  #               and then delete them
  logging.info('Removing built files...')
  # clean up docs, built html and zip files
  if not skip_zip:
    zipfiles = glob.glob(os.path.join(ROOT_DIR, '*.zip'))
  else:
    zipfiles = []
  api_methods = glob.glob(os.path.join(DOC_DIR, 'method_*'))
  api_decos = glob.glob(os.path.join(DOC_DIR, 'deco_*'))
  html_docs = glob.glob(os.path.join(API_TEMPLATE_DIR, 'built_*'))
  
  all_to_remove = zipfiles + api_methods + api_decos + html_docs
  for filename in all_to_remove:
    os.unlink(filename)

  logging.info('Finished removing built files.')



# Helpers
def generate_secret_key():
 bits = random.getrandbits(10)
 return md5.new(str(time.time()) + str(bits)).hexdigest() 

def required(s):
  if not s:
    raise ValueError('Invalid entry, cannot be empty')
  return s

def yesno(s):
  s = s.lower()
  if s not in ('y', 'n', 'yes', 'no'):
    raise ValueError('Invalid entry, please type yes or no')
  return (False, True)[s.startswith('y')] 

def get_input(message, prompt, default='', cleaner=required):
  print message
  real_prompt = '%s [%s]: ' % (prompt, default)
  s = raw_input(real_prompt)
  if not s and default:
    s = default
  try:
    o = cleaner(s)
    print '==============================='
  except ValueError, e:
    print 
    print 'Error:', e.message
    o = get_input(message, prompt, default, cleaner)
  return o

def rst_to_html(infile, outfile):
  import docutils.core

  docutils.core.publish_file(
      source=infile,
      destination=outfile,
      writer_name='html',
      settings_overrides={'default_template_path': RST_TEMPLATE_PATH,
                          'doctitle_xform': False}
      )

def rst_docs(api_doc):
  from epydoc import apidoc

  sig_template = '**%(shortname)s** (%(args_list)s)'
  dec_template = ' * %(decorator)s'

  shortname = str(api_doc.canonical_name).split('.')[-1]
  args_list = ', '.join(api_doc.posargs)
  if api_doc.kwarg:
    args_list += ', \*\*%s' % api_doc.kwarg
  
  o = [sig_template % {'shortname': shortname, 'args_list': args_list},
       '']
  #for d in api_doc.decorators:
  #  o.append(dec_template % {'decorator': d})
  
  o.append('')
  if api_doc.docstring != apidoc.UNKNOWN:
    o.append(api_doc.docstring)
  else:
    o.append('No additional documentation')
  return '\n'.join(o)

def _strip_contrib(dirnames):
  for d in IGNORED_CONTRIB:
    try:
      dirnames.remove(d)
    except ValueError:
      pass

def zip_vendor_lib(lib):
  f = zipfile.ZipFile('%s.zip' % lib, 'w')

  for dirpath, dirnames, filenames in os.walk('vendor/%s' % lib):
    if dirpath == os.path.join('vendor', lib, 'contrib'):
      _strip_contrib(dirnames)

    for filename in filenames:
      name = os.path.join(dirpath, filename)
      if ZIP_SKIP_RE.search(name):
        logging.debug('Skipped (skip_re): %s', name)
        continue
      if not os.path.isfile(name):
        logging.debug('Skipped (isfile): %s', name)
        continue
      logging.debug('Adding %s...', name)
      f.write(name, name[len('vendor/'):], zipfile.ZIP_DEFLATED)

  f.close()

if __name__ == "__main__":
  command = ''
  if len(sys.argv) > 1:
    command = sys.argv[1]

  if command.startswith('config'):
    build_config(True)