pyuserconfig/userconfig.py

#!/usr/bin/env python
# encoding: utf-8
#
# $Id$
# $URL$

"""
userconfig.py

Created by Marcus Stoegbauer on 2013-01-10.
Copyright (c) 2013 __MyCompanyName__. All rights reserved.
"""

import sys
import os
import tempfile
import re
import getopt
import time

# 
import Userconfig.cfgfile as cfgfile
from Userconfig.checks import checks
import Userconfig.Tools as Tools

debug = Tools.Debug()

classchecks = checks()
cfg = cfgfile.Conf()

hostclasses = classchecks.__classesForHost__()

class Usage(Exception):
  def __init__(self, msg):
    self.msg = msg
  # def __init__
  help_message = """
-h help
-v verbose level (multiple v for higher level)
-c userconfig.cfg config file
"""
# class Usage

def workconf(directory, depth=2):
  """walks through directory, collecting all filenames, returns list of all filenames"""
  dirs = os.listdir(directory)
  ret = []
  debug.debug("Finding files in directory %s." % directory, 4)
  for d in dirs:
    name = directory+"/"+d
    if os.path.isdir(name):
      # fixme: create name if it does not exist
      workconf(name, depth+1)
    # if dir
    if not name.endswith(".swp"):
      ret.append(name)
      debug.debug("Found file %s in directory %s" % (name, directory), 4)
    # if not .swp
  # for d
  return ret
# def workconf

def workdir(directory):
  """walks through all host classes, checking if the classes directory exists in directory
     then collect all filenames within this directory and return a dict of all files for this
     directory
  """  
  debug.debug("Working on directory %s" % directory, 3)
  # skip directory if no CONFIGFILE present
  if not os.path.isfile(directory+"/"+cfg.get("Main", "configfile")):
    debug.debug("No %s in %s, skipping." % (cfg.get("Main", "configfile"), directory), 1)
    return ({},None)
  # if not DEST
  
  # get config file for directory
  dirConfig = Tools.getConfig(directory+"/"+cfg.get("Main", "configfile"))
  if not dirConfig:
    debug.debug("Cannot read %s in %s, skipping." % (cfg.get("Main", "configfile"), directory), 1)
    return ({},None)
  # if not dirConfig
  
  destdir = dirConfig.get("Main","dest")
  # destfiles is a dict of all files that will be created from the classes config
  # key is the destination filename, values are all classes filenames that are used to
  # build the file
  destfiles = {}
  
  # walk through all know classes in directory and find filenames
  for h in hostclasses:
    # build classes directory
    if h[0] != "":
      classdir = directory+"/"+h[0]+"_"+h[1]
    else:
      classdir = directory+"/"+h[1]
    # if all
    debug.debug("Looking for directory %s." % classdir, 4)
    # if class directory exists
    if os.path.isdir(classdir):
      debug.debug("Found directory %s, getting files." % classdir, 4)
      # get list of files within this class directory
      tempfiles = workconf(classdir)
      debug.debug("Got %d files: %s." % (len(tempfiles), str(tempfiles)), 4)
      # put files into dict
      for f in tempfiles:
        destname = destdir+os.path.basename(f)  # destination filename
        if not destfiles.has_key(destname):
          destfiles[destname] = []
        # if not destname, create key with empty list
        destfiles[destname].append(f) # append each file to dict
        debug.debug("Added file to %s, now %d files: %s" % (destname, len(destfiles[destname]), destfiles[destname]), 4)
      # for tempfiles
    # if classdir
  # for hostclasses
  
  debug.debug("workdir: %s, Files: %s" % (directory, str(destfiles)), 3)
  return (destfiles, dirConfig)
# def work

def buildFile(classfiles, destfile, commentstring):
  """open all classfiles, assemble them and write the contents into a tempfile
    returns the name of tempfile"""
  content = []
  if commentstring != "":
    debug.debug("commentstring found, adding header.", 3)
    content.append(commentstring + " " + cfg.get("Main","stamp") + " " + time.strftime("%+") + "\n")
  # if commentstring not empty
  
  for f in classfiles:
    debug.debug("Merging %s." % f, 4)
    fp = open(f, "r")
    filecontent = fp.read()
    fp.close()
    if commentstring == "":
      # look for stamp in content, replace with real stamp
      if re.search(re.escape(cfg.get("Main","stampreplace")), filecontent):
        debug.debug("commentstring empty, replacing stamp in file", 3)
        filecontent = re.sub(re.escape(cfg.get("Main","stampreplace")), cfg.get("Main","stamp"), filecontent)
      # if search
    # if commentstring empty  
    content.append(filecontent)
  # end f
  
  (tempfd, tempfilename) = tempfile.mkstemp(prefix=os.path.basename(destfile), dir="/tmp")

  fp = None
  try:
    fp = os.fdopen(tempfd, "w")
  except:
    Tools.error("Cannot write to temporary file %s" % tempfilename)
    os.remove(tempfilename)
    return False
  # try
  debug.debug("Writing merged files into tempfile %s." % tempfilename, 3)
  for block in content:
    fp.write(block)
    fp.write("\n")
  # for content
  fp.close()

  return tempfilename
# def buildFile

def processAllFiles(destfiles, dirConfig):
  """processes all files in destfiles, generate files from classes, compare and copy if necessary"""
  for df in destfiles.keys():
    debug.debug("Processing source files for %s." % df, 2)
    # assemble file to tmp
    commentstring = ""
    if dirConfig.check("Main", "commentstring"):
      commentstring = dirConfig.get("Main", "commentstring")
      debug.debug("Found commentstring %s in %s" % (commentstring, df), 3)
    # if COMMENTSTRNIG
        
    tempfilename = buildFile(destfiles[df], df, commentstring)
    if not tempfilename:
      debug.debug("Error while creating temp file for %s, skipping." % df, 1)
      continue
    # if not tempfilename
    debug.debug("Merged files %s for %s into %s" % (str(destfiles[df]), df, tempfilename), 2)
    
    # diff assembled file and config file
    if Tools.diff(df, tempfilename, commentstring, debug):
      debug.debug("File %s has changed" % df, 0)
      if not Tools.userConfigGenerated(df, cfg):
        debug.debug("%s not generated by userconfig, backing up." % df, 2)
        # file not generated from userconfig -> back up
        Tools.backupFile(df, debug)
      # if not userConfigGenerated
      # copy tmp file to real location
      debug.debug("Copy %s to %s." % (tempfilename, df), 0)
      Tools.copyFile(tempfilename, df, debug)
    # if diff
    # remove tmp
    debug.debug("Removing temporary file %s." % tempfilename, 2)
    os.remove(tempfilename)
  # for df
# def buildAllFiles

def main():
  configfile = os.environ['HOME']+"/etc/userconfig.cfg"
  global verbose
  
  try:
    try:
      opts, args = getopt.getopt(sys.argv[1:], "hdc:v", ["help", "debug", "config="])
    except getopt.error, msg:
      raise Usage(msg)
    # try getopt
    
    for option, value in opts:
      if option == "-v":
        debug.addverbose()
      if option in ("-h", "--help"):
        raise Usage(help_message)
      if option in ("-d", "--debug.debug"):
        pass
      if option in ("-c", "--config"):
        configfile = value
      # if
    # for option, value
  except Usage, err:
    Tools.error(sys.argv[0].split("/")[-1] + ": " + str(err.msg))
    Tools.error("\t for help use --help")
    return 2
  # try
  
  debug.debug("Using configfile %s." % configfile, 1)
  if not os.path.isfile(configfile):
    Tools.error( "No config file specified.")
    return 2
  # if configfile
  cfg.setdebug(debug)
  cfg.setfilename(configfile)
  
  debug.debug("Current host is in classes %s" % hostclasses, 1)
  configdir = cfg.get("Main", "configdir")
  for d in os.listdir(configdir):
    destfiles = {}
    name = configdir+"/"+d
    debug.debug("Working in %s" % name, 1)
    if not os.path.isdir(name):
      debug.debug("%s is not a directory, skipping." % name, 3)
      continue
    elif d.startswith(".svn"):
      debug.debug("%s is .svn, skipping." % name, 3)
      continue
    elif os.path.isfile(name+"/.ignore"):
      debug.debug("%s contains file .ignore, skipping." % name, 3)
      continue
    else:
      debug.debug("Processing files in %s" % name, 2)
      (destfiles, dirConfig) = workdir(name)
      if isinstance(destfiles, dict):
        if len(destfiles.keys()) > 0:
          debug.debug("Building %d files: %s" % (len(destfiles.keys()), destfiles.keys()), 3)
          processAllFiles(destfiles, dirConfig)
        # if > 0
      else:
        debug.debug("No files found for %s, skipping." % name, 1)
    # if
  # for d
# def main


if __name__ == '__main__':
  main()