class Fixed (Manager) :
# Shared values
xmlConfFile = 'fixed.xml'
def __init__(self, project, cfg, cType) :
'''Do the primary initialization for this manager.'''
super(Fixed, self).__init__(project, cfg)
# Set values for this manager
self.gid = project.gid
self.pid = project.projectIDCode
self.tools = Tools()
self.project = project
self.projectConfig = project.projectConfig
self.cfg = cfg
self.cType = cType
self.Ctype = cType.capitalize()
self.log = project.log
self.manager = self.cType + '_Fixed'
self.managers = project.managers
self.rapumaXmlTextConfig = os.path.join(self.project.local.rapumaConfigFolder, self.xmlConfFile)
# import pdb; pdb.set_trace()
# Get persistant values from the config if there are any
newSectionSettings = self.tools.getPersistantSettings(self.project.projectConfig['Managers'][self.manager], self.rapumaXmlTextConfig)
if newSectionSettings != self.project.projectConfig['Managers'][self.manager] :
self.project.projectConfig['Managers'][self.manager] = newSectionSettings
self.tools.writeConfFile(self.project.projectConfig)
self.compSettings = self.project.projectConfig['Managers'][self.manager]
for k, v in self.compSettings.iteritems() :
setattr(self, k, v)
# Log messages for this module
self.errorCodes = {
'0000' : ['MSG', 'Placeholder message'],
}
class ProjScript (object) :
def __init__(self, pid, gid) :
'''Do the primary initialization for this class.'''
self.pid = pid
self.gid = gid
self.tools = Tools()
self.local = ProjLocal(pid)
self.user = UserConfig()
self.userConfig = self.user.userConfig
self.proj_config = Config(pid, gid)
self.proj_config.getProjectConfig()
self.projectConfig = self.proj_config.projectConfig
self.cType = self.projectConfig['Groups'][gid]['cType']
self.Ctype = self.cType.capitalize()
self.log = ProjLog(pid)
# Log messages for this module
self.errorCodes = {
'0000' : ['MSG', 'Placeholder message'],
'1010' : ['MSG', 'Script install process for [<<1>>] Succeeded.'],
'1020' : ['ERR', 'Script install process for [<<1>>] failed.'],
'1030' : ['ERR', 'Script type [<<1>>] not supported.'],
'1040' : ['ERR', 'Script install cannot proceed for [<<1>>] because this script already exists in the project. You must remove it first before you can add another script.'],
'2010' : ['MSG', 'Script remove process for [<<1>>] Succeeded.'],
'2020' : ['ERR', 'Script remove process for [<<1>>] failed.'],
'4210' : ['MSG', 'Processes completed successfully on: [<<1>>] by [<<2>>]'],
'4220' : ['ERR', 'Processes for [<<1>>] failed. Script [<<2>>] returned this error: [<<3>>]'],
'4260' : ['ERR', 'Installed the default component preprocessing script. Editing will be required for it to work with your project.'],
'4265' : ['LOG', 'Component preprocessing script is already installed.'],
'4310' : ['ERR', 'Script is an unrecognized type: [<<1>>] Cannot continue with installation.']
}
###############################################################################
############################# Script Add Functions ############################
###############################################################################
######################## Error Code Block Series = 1000 #######################
###############################################################################
def addScriptFiles (self, path, scriptType) :
'''Import/add processing script files for a group that are found
in the given path. Assumes valid path. Will fail if a copy
doesn't succeed. If the file is already there, give a warning and
will not copy.'''
# import pdb; pdb.set_trace()
source = path
fileName = self.tools.fName(path)
target = os.path.join(self.local.projScriptFolder, fileName)
# Do an initial check to see if the script is already there
# Never copy over the top of an existing script
if os.path.isfile(target) :
self.log.writeToLog(self.errorCodes['1040'], [fileName])
# Make script folder if needed
if not os.path.isdir(self.local.projScriptFolder) :
os.makedirs(self.local.projScriptFolder)
# Copy in the script
if self.scriptInstall(source, target) :
# Record the script file name
if scriptType == 'preprocess' :
self.projectConfig['Groups'][self.gid]['preprocessScript'] = fileName
elif scriptType == 'postprocess' :
self.projectConfig['Groups'][self.gid]['postprocessScript'] = fileName
else :
self.log.writeToLog(self.errorCodes['1030'], [scriptType])
self.tools.writeConfFile(self.projectConfig)
self.log.writeToLog(self.errorCodes['1010'], [fileName])
return True
else :
self.log.writeToLog(self.errorCodes['1020'], [fileName])
###############################################################################
############################ Script Remove Functions ##########################
###############################################################################
######################## Error Code Block Series = 2000 #######################
###############################################################################
def removeScriptFiles (self, scriptType) :
'''Remove processing script files for a group.'''
if scriptType == 'preprocess' :
fileName = self.projectConfig['Groups'][self.gid]['preprocessScript']
elif scriptType == 'postprocess' :
fileName = self.projectConfig['Groups'][self.gid]['postprocessScript']
else :
self.log.writeToLog(self.errorCodes['1030'], [scriptType])
target = os.path.join(self.local.projScriptFolder, fileName)
# Remove the script (if it's not there, we don't care)
try :
os.remove(target)
except :
pass
if not os.path.isfile(target) :
if scriptType == 'preprocess' :
self.projectConfig['Groups'][self.gid]['preprocessScript'] = ''
elif scriptType == 'postprocess' :
self.projectConfig['Groups'][self.gid]['postprocessScript'] = ''
else :
self.log.writeToLog(self.errorCodes['1030'], [scriptType])
self.tools.writeConfFile(self.projectConfig)
self.log.writeToLog(self.errorCodes['2010'], [fileName])
return True
else :
self.log.writeToLog(self.errorCodes['2020'], [fileName])
###############################################################################
########################## General Script Functions ###########################
###############################################################################
######################## Error Code Block Series = 4000 #######################
###############################################################################
def runProcessScript (self, target, scriptFile) :
'''Run a text processing script on a component. This assumes the
component and the script are valid and the component lock is turned
off. If not, you cannot expect any good to come of this.'''
# subprocess will fail if permissions are not set on the
# script we want to run. The correct permission should have
# been set when we did the installation.
err = subprocess.call([scriptFile, target])
if err == 0 :
self.log.writeToLog(self.errorCodes['4210'], [self.tools.fName(target), self.tools.fName(scriptFile)])
else :
self.log.writeToLog(self.errorCodes['4220'], [self.tools.fName(target), self.tools.fName(scriptFile), str(err)])
return False
return True
def scriptInstall (self, source, target) :
'''Install a script. A script can be a collection of items in
a zip file or a single .py script file.'''
scriptTargetFolder, fileName = os.path.split(target)
if self.tools.isExecutable(source) :
if not shutil.copy(source, target) :
self.tools.makeExecutable(target)
return True
elif self.tools.fName(source).split('.')[1].lower() == 'zip' :
myZip = zipfile.ZipFile(source, 'r')
for f in myZip.namelist() :
data = myZip.read(f, source)
# Pretty sure zip represents directory separator char as "/" regardless of OS
myPath = os.path.join(scriptTargetFolder, f.split("/")[-1])
try :
myFile = open(myPath, "wb")
myFile.write(data)
myFile.close()
except :
pass
myZip.close()
return True
else :
self.log.writeToLog(self.errorCodes['4310'], [self.tools.fName(source)])
class Pdftk (Manager) :
# Shared values
xmlConfFile = 'pdftk.xml'
def __init__(self, project, cfg, cType) :
'''Do the primary initialization for this manager.'''
super(Pdftk, self).__init__(project, cfg)
# import pdb; pdb.set_trace()
# Create all the values we can right now for this manager.
# Others will be created at run time when we know the cid.
self.tools = Tools()
self.project = project
self.local = project.local
self.log = project.log
self.cfg = cfg
self.pid = project.projectIDCode
self.gid = project.gid
self.cType = cType
self.Ctype = cType.capitalize()
self.mType = project.projectMediaIDCode
self.renderer = 'pdftk'
self.manager = self.cType + '_' + self.renderer.capitalize()
self.managers = project.managers
self.pg_back = ProjBackground(self.pid, self.gid)
self.fmt_diagnose = ProjDiagnose(self.pid, self.gid)
self.proj_config = Config(self.pid, self.gid)
self.proj_config.getProjectConfig()
self.proj_config.getLayoutConfig()
# Get config objs
self.projectConfig = self.proj_config.projectConfig
self.layoutConfig = self.proj_config.layoutConfig
self.userConfig = self.project.userConfig
# Some config settings
self.pdfViewerCmd = self.tools.getPdfViewerCommand(self.userConfig, self.projectConfig)
self.useBackground = self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useBackground'])
self.useDocInfo = self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useDocInfo'])
# Get settings for this component
self.managerSettings = self.projectConfig['Managers'][self.manager]
for k, v in self.managerSettings.iteritems() :
if v == 'True' or v == 'False' :
setattr(self, k, self.tools.str2bool(v))
else :
setattr(self, k, v)
# Make any dependent folders if needed
if not os.path.isdir(self.local.projGidFolder) :
os.makedirs(self.local.projGidFolder)
# Log messages for this module
self.errorCodes = {
'0000' : ['MSG', 'Messages for the pdftk module.'],
'5010' : ['ERR', 'Subprocess failed with this error: <<1>>'],
'5020' : ['MSG', 'PDF merge was successful. Output = <<1>>'],
'5200' : ['ERR', 'Rendered file not found: <<1>>'],
'5210' : ['WRN', 'PDF viewing is disabled.'],
'5720' : ['MSG', 'Saved rendered file to: [<<1>>]'],
'5730' : ['ERR', 'Failed to save rendered file to: [<<1>>]']
}
###############################################################################
############################ Manager Level Functions ##########################
###############################################################################
######################## Error Code Block Series = 1000 #######################
###############################################################################
def sourceListFromCidList (self, cidList) :
'''Return a sourceList derived from a given cidList.'''
sourceList = []
for cid in cidList :
sourceList.append(self.sourceFromCid(cid))
return sourceList
def sourceFromCid (self, cid) :
'''Return the full path with file name derived from a valid cid.'''
return os.path.join(self.local.projComponentFolder, cid, cid + '.pdf')
###############################################################################
################################# Main Function ###############################
###############################################################################
######################## Error Code Block Series = 5000 #######################
###############################################################################
def run (self, gid, cidList, pgRange, override, save) :
'''This will check all the dependencies for a group and then
use pdftk to "render" the whole group or a subset of components
and even a page range in a single component.'''
# import pdb; pdb.set_trace()
# There must be a cidList. If one was not passed, default to
# the group list
cidListSubFileName = ''
saveFile = ''
saveFileName = ''
viewFile = ''
if not cidList :
cidList = self.projectConfig['Groups'][gid]['cidList']
# Make a list of files that pdftk will merge together
sourceList = self.sourceListFromCidList(cidList)
# Merge the files
cmd = ['pdftk'] + sourceList + ['cat', 'output', self.local.gidPdfFile]
# import pdb; pdb.set_trace()
# No return from pdftk is good, we can continue on
if not subprocess.call(cmd) :
# Collect the page count and record in group (Write out at the end of the opp.)
self.projectConfig['Groups'][gid]['totalPages'] = str(PdfFileReader(open(self.local.gidPdfFile)).getNumPages())
# Write out any changes made to the project.conf file that happened during this opp.
self.tools.writeConfFile(self.projectConfig)
# Pull out pages if requested (use the same file for output)
if pgRange :
self.tools.pdftkPullPages(self.local.gidPdfFile, self.local.gidPdfFile, pgRange)
# The gidPdfFile is the residue of the last render and if approved, can be
# used for the binding process. In regard to saving and file naming, the
# gidPdfFile will be copied but never renamed. It must remain intact.
# If the user wants to save this file or use a custom name, do that now
if save and not override :
saveFileName = self.pid + '_' + gid
if cidListSubFileName :
saveFileName = saveFileName + '_' + cidListSubFileName
if pgRange :
saveFileName = saveFileName + '_pg(' + pgRange + ')'
# Add date stamp
saveFileName = saveFileName + '_' + self.tools.ymd()
# Add render file extention
saveFileName = saveFileName + '.pdf'
# Save this to the Deliverable folder (Make sure there is one)
if not os.path.isdir(self.local.projDeliverableFolder) :
os.makedirs(self.local.projDeliverableFolder)
# Final file name and path
saveFile = os.path.join(self.local.projDeliverableFolder, saveFileName)
# Copy, no news is good news
if shutil.copy(self.local.gidPdfFile, saveFile) :
self.log.writeToLog(self.errorCodes['5730'], [saveFileName])
else :
self.log.writeToLog(self.errorCodes['5720'], [saveFileName])
# If given, the override file name becomes the file name
if override :
saveFile = override
# With shutil.copy(), no news is good news
if shutil.copy(self.local.gidPdfFile, saveFile) :
self.log.writeToLog(self.errorCodes['5730'], [saveFileName])
else :
self.log.writeToLog(self.errorCodes['5720'], [saveFileName])
# Once we know the file is successfully generated, add a background if defined
if self.useBackground :
if saveFile :
viewFile = self.pg_back.addBackground(saveFile)
else :
viewFile = self.pg_back.addBackground(self.local.gidPdfFile)
# Add a timestamp and doc info if requested in addition to background
if self.useDocInfo :
if saveFile :
if os.path.isfile(viewFile) :
viewFile = self.pg_back.addDocInfo(viewFile)
else :
viewFile = self.pg_back.addDocInfo(saveFile)
else :
if os.path.isfile(viewFile) :
viewFile = self.pg_back.addDocInfo(viewFile)
else :
viewFile = self.pg_back.addDocInfo(self.local.gidPdfFile)
# To avoid confusion with file names, if this is a saved file,
# and it has a background, we need to remove the original, non-
# background file (remembering originals are kept in the group
# Component folder), then rename the -view version to whatever
# the saved name should be
if save or override :
if os.path.isfile(saveFile) and os.path.isfile(viewFile) :
# First remove
os.remove(saveFile)
# Next rename
os.rename(viewFile, saveFile)
##### Viewing #####
# First get the right file name to view
if saveFile :
# If there was a saveFile, that will be the viewFile
viewFile = saveFile
self.log.writeToLog(self.errorCodes['5020'], [saveFile])
else :
# The view file in this case is just temporary
if not os.path.isfile(viewFile) :
viewFile = self.local.gidPdfFile.replace(gid + '.pdf', gid + '-view.pdf')
shutil.copy(self.local.gidPdfFile, viewFile)
self.log.writeToLog(self.errorCodes['5020'], [self.tools.fName(viewFile)])
if os.path.isfile(viewFile) :
if self.pdfViewerCmd :
# Add the file to the viewer command
self.pdfViewerCmd.append(viewFile)
# Run the XeTeX and collect the return code for analysis
try :
subprocess.Popen(self.pdfViewerCmd)
return True
except Exception as e :
# If we don't succeed, we should probably quite here
self.log.writeToLog(self.errorCodes['5010'], [str(e)])
else :
self.log.writeToLog(self.errorCodes['5210'])
else :
self.log.writeToLog(self.errorCodes['5200'], [self.tools.fName(viewFile)])
# If we made it this far, return True
return True
class ProjBackground (object) :
def __init__(self, pid, gid = None) :
'''Intitate the whole class and create the object.'''
# import pdb; pdb.set_trace()
self.pid = pid
self.gid = gid
self.local = ProjLocal(pid, gid)
self.tools = Tools()
self.proj_config = Config(pid, gid)
self.proj_config.getProjectConfig()
self.proj_config.getLayoutConfig()
self.projectConfig = self.proj_config.projectConfig
self.layoutConfig = self.proj_config.layoutConfig
self.log = ProjLog(pid)
self.user = UserConfig()
self.userConfig = self.user.userConfig
self.projHome = os.path.join(os.environ['RAPUMA_PROJECTS'], self.pid)
self.mmToPx = 72 / 25.4
# For debugging purposes a switch can be set here for verbose
# message output via the terminal
self.debugMode = self.tools.str2bool(self.userConfig['System']['debugging'])
# Log messages for this module
self.errorCodes = {
'0000' : ['MSG', 'Placeholder message'],
'1110' : ['MSG', 'File exsits: [<<1>>]. Use \"force\" to remove it.'],
'1280' : ['ERR', 'Failed to merge background file with command: [<<1>>]. This is the error: [<<2>>]'],
'1290' : ['ERR', 'Failed to convert background file [<<1>>]. Error: [<<2>>] The command was: [<<3>>]'],
'1300' : ['MSG', 'Background merge operation in process, please wait...'],
'1305' : ['MSG', 'Adding document information, please wait...'],
'1310' : ['WRN', 'Failed to add background component: [<<1>>] with error: [<<2>>]'],
'1320' : ['MSG', 'New background created.']
}
###############################################################################
############################### Basic Functions ###############################
###############################################################################
######################## Error Code Block Series = 1000 #######################
###############################################################################
def turnOnBackground (self) :
'''Change the layout config settings to turn on the background.'''
if not self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useBackground']) :
self.layoutConfig['DocumentFeatures']['useBackground'] = True
self.tools.writeConfFile(self.layoutConfig)
def turnOffBackground (self) :
'''Change the layout config settings to turn off the background.'''
if self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useBackground']) :
self.layoutConfig['DocumentFeatures']['useBackground'] = False
self.tools.writeConfFile(self.layoutConfig)
def turnOnDocInfo (self) :
'''Change the layout config settings to turn on the doc info in the background.'''
if not self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useDocInfo']) :
self.layoutConfig['DocumentFeatures']['useDocInfo'] = True
self.tools.writeConfFile(self.layoutConfig)
def turnOffDocInfo (self) :
'''Change the layout config settings to turn off the doc info in the background.'''
if self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useDocInfo']) :
self.layoutConfig['DocumentFeatures']['useDocInfo'] = False
self.tools.writeConfFile(self.layoutConfig)
def addBackground (self, target) :
'''Add a background (watermark) to a rendered PDF file. This will
figure out what the background is to be composed of and create
a master background page. Using force will cause it to be remade.'''
# Do a quick check if the background needs to be remade
# The background normally is not remade if one already exists.
# If one is there, it can be remade if regenerate is set to
# to True. Obviously, if one is not there, it will be made.
if self.tools.str2bool(self.layoutConfig['DocumentFeatures']['regenerateBackground']) :
self.createBackground()
else :
# If there isn't one, make it
if not os.path.exists(self.local.backgroundFile) :
self.createBackground()
# Merge target with the project's background file in the Illustraton folder
self.log.writeToLog(self.errorCodes['1300'])
# Create a special name for the file with the background
# Then merge and save it
viewFile = self.tools.alterFileName(target, 'view')
shutil.copy(self.tools.mergePdfFilesPdftk(self.centerOnPrintPage(target), self.local.backgroundFile), viewFile)
# Not returning a file name would mean it failed
if os.path.exists(viewFile) :
return viewFile
def addDocInfo (self, target) :
'''Add (merge) document information to the rendered target doc.'''
# Initialize the process
docInfoText = self.layoutConfig['DocumentFeatures']['docInfoText']
timestamp = self.tools.tStamp()
if self.gid :
headerLine = self.pid + ' / ' + self.gid + ' / ' + timestamp
else :
headerLine = self.pid + ' / ' + timestamp
svgFile = tempfile.NamedTemporaryFile().name
## RENDERED PAGE DIMENSIONS (body)
# This can be determined with the pyPdf element
# "pdf.getPage(0).mediaBox", which returns a
# RectangleObject([0, 0, Width, Height]). The
# width and height are in points. Hopefully we will
# always be safe by measuring the gidPdfFile size.
#pdf = PdfFileReader(open(self.local.gidPdfFile,'rb'))
#var2 = pdf.getPage(0).mediaBox
#trimWidth = float(var2.getWidth())
#trimHeight = float(var2.getHeight())
trimWidth = float(self.layoutConfig['PageLayout']['pageWidth'])
trimHeight = float(self.layoutConfig['PageLayout']['pageHeight'])
# Printer page size
pps = self.printerPageSize()
ppsWidth = pps[0]
ppsHeight = pps[1]
ppsCenter = ppsWidth/2
# Write out SVG document text
with codecs.open(svgFile, 'wb') as fbackgr : # open file for writing
fbackgr.write( '''<svg xmlns="http://www.w3.org/2000/svg"
version="1.1" width = "''' + str(ppsWidth) + '''" height = "''' + str(ppsHeight) + '''">
<g><text x = "''' + str(ppsCenter) + '''" y = "''' + str(20) + '''" style="font-family:DejaVu Sans;font-style:regular;font-size:8;text-anchor:middle;fill:#000000;fill-opacity:1">''' + headerLine + '''</text></g>
<g><text x = "''' + str(ppsCenter) + '''" y = "''' + str(ppsHeight-30) + '''" style="font-family:DejaVu Sans;font-style:regular;font-size:8;text-anchor:middle;fill:#000000;fill-opacity:1">''' + self.tools.fName(target) + '''</text></g>
<g><text x = "''' + str(ppsCenter) + '''" y = "''' + str(ppsHeight-20) + '''" style="font-family:DejaVu Sans;font-style:regular;font-size:8;text-anchor:middle;fill:#000000;fill-opacity:1">''' + docInfoText + '''</text></g>
</svg>''')
# Merge target with the background
self.log.writeToLog(self.errorCodes['1305'])
# Create a special name for the file with the background
viewFile = self.tools.alterFileName(target, 'view')
# Compare the new file name with the target to see if we are
# already working with a background file
if viewFile == target :
# If the target is a BG file all we need to do is merge it
self.tools.mergePdfFilesPdftk(viewFile, self.tools.convertSvgToPdfRsvg(svgFile))
else :
# If not a BG file, we need to be sure the target is the same
# size as the print page to merge with pdftk
shutil.copy(self.tools.mergePdfFilesPdftk(self.centerOnPrintPage(target), self.tools.convertSvgToPdfRsvg(svgFile)), viewFile)
# Not returning a file name would mean it failed
if os.path.exists(viewFile) :
return viewFile
##### Background Creation Functions #####
def createBackground (self) :
'''Create a background file. This will overwrite any existing
background file and will add each recognized background type
found in the bacgroundComponents config setting.'''
self.createBlankBackground()
# Add each component to the blank background file
for comp in self.layoutConfig['DocumentFeatures']['backgroundComponents'] :
try :
getattr(self, 'merge' + comp.capitalize())()
except Exception as e :
self.log.writeToLog(self.errorCodes['1310'],[comp,str(e)])
pass
self.log.writeToLog(self.errorCodes['1320'])
return True
def createBlankBackground (self) :
'''Create a blank background page according to the print page
size specified.'''
# Set the temp svg file name
svgFile = tempfile.NamedTemporaryFile().name
# Printer page size
pps = self.printerPageSize()
ppsWidth = pps[0]
ppsHeight = pps[1]
# Be sure there is an illustrations folder in place
if not os.path.isdir(self.local.projIllustrationFolder) :
os.mkdir(self.local.projIllustrationFolder)
# Write out SVG document text
with codecs.open(svgFile, 'wb') as fbackgr : # open file for writing
fbackgr.write( '''<svg xmlns="http://www.w3.org/2000/svg"
version="1.1" width = "''' + str(ppsWidth) + '''" height = "''' + str(ppsHeight)+ '''">
</svg>''')
shutil.copy(self.tools.convertSvgToPdfRsvg(svgFile), self.local.backgroundFile)
def mergeWatermark (self) :
'''Create a watermark file and return the file name. Using force
will cause any exsiting versions to be recreated.'''
# import pdb; pdb.set_trace()
# Initialize the process
pubProg = "Rapuma"
watermarkText = self.layoutConfig['DocumentFeatures']['watermarkText']
svgFile = tempfile.NamedTemporaryFile().name
## RENDERED PAGE DIMENSIONS (body)
# Trim page width [px]
trimWidth = round(self.mmToPx * float(self.layoutConfig['PageLayout']['pageWidth']),1)
# Trim page height [px]
trimHeight = round(self.mmToPx * float(self.layoutConfig['PageLayout']['pageHeight']),1)
# Printer page size [px]
(ppsWidth, ppsHeight) = self.printerPageSize()
pageX = ppsWidth/2
pageY = ppsHeight/2
# Write out SVG document text
with codecs.open(svgFile, 'wb') as fbackgr : # open file for writing
fbackgr.write( '''<svg xmlns="http://www.w3.org/2000/svg"
version="1.1" width = "''' + str(ppsWidth) + '''" height = "''' + str(ppsHeight) + '''">
<g><text x = "''' + str(pageX-trimWidth*.42) + '''" y = "''' + str(pageY-trimHeight*0.39) + '''" style="font-family:DejaVu Sans;font-style:regular;font-size:32;text-anchor:start;fill:#d5d5f5;fill-opacity:1">''' + str(pubProg) + '''
<tspan x = "''' + str(pageX) + '''" y = "''' + str(pageY - trimHeight*0.22) + '''" style="text-anchor:middle">''' + str(pubProg) + '''</tspan>
<tspan x = "''' + str(pageX+trimWidth*0.42)+ '''" y = "''' + str(pageY-trimHeight*0.05) + '''" style="text-anchor:end">''' + str(pubProg) + '''</tspan>
<tspan x = "''' + str(pageX) + '''" y = "''' + str(pageY+trimHeight*0.12) + '''" style="text-anchor:middle">''' + str(pubProg) + '''</tspan>
<tspan x = "''' + str(pageX-trimWidth*0.42) + '''" y = "''' + str(pageY+trimHeight*0.29) + '''" style="text-anchor:start">''' + str(pubProg) + '''</tspan>
<tspan x = "''' + str(pageX+trimWidth*0.49) + '''" y = "''' + str(pageY+trimHeight*0.455) + '''" style="font-weight:bold;font-size:68;text-anchor:end">''' + watermarkText + ''' </tspan>
</text></g></svg>''')
# Convert the temp svg to pdf and merge into backgroundFile
results = self.tools.mergePdfFilesPdftk(self.local.backgroundFile, self.tools.convertSvgToPdfRsvg(svgFile))
if os.path.isfile(results) :
return True
def mergeCropmarks (self) :
'''Merge cropmarks on to the background page.'''
# Initialize the process
svgFile = tempfile.NamedTemporaryFile().name
## RENDERED PAGE DIMENSIONS (body)
# Trim page width [px]
trimWidth = round(self.mmToPx * float(self.layoutConfig['PageLayout']['pageWidth']),1)
# Trim page height [px]
trimHeight = round(self.mmToPx * float(self.layoutConfig['PageLayout']['pageHeight']),1)
# Printer page size [px]
pps = self.printerPageSize()
ppsWidth = pps[0]
ppsHeight = pps[1]
with codecs.open(svgFile, 'wb') as fbackgr :
# starting lines of SVG xml
fbackgr.write( '''<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width = "''' + str(ppsWidth) + '''" height = "''' + str(ppsHeight) + '''">\n''')
# vertical top left
fbackgr.write( '''<path d = "m''' + str((ppsWidth - trimWidth)/2) + ''',''' + str((ppsHeight - trimHeight)/2 - 32.0) + ''',v27," style="stroke:#000000;stroke-width:.2"/>\n''')
# vertical bottom left
fbackgr.write( '''<path d = "m''' + str((ppsWidth - trimWidth)/2) + ''',''' + str((ppsHeight + trimHeight)/2 + 5.0) + ''',v27" style="stroke:#000000;stroke-width:.2" />\n''')
# vertical bottom right
fbackgr.write( '''<path d = "m''' + str((ppsWidth + trimWidth)/2) + ''',''' + str((ppsHeight - trimHeight)/2 - 32.0) + ''',v27" style="stroke:#000000;stroke-width:.2"/>\n''')
# vertical top right
fbackgr.write( '''<path d = "m''' + str((ppsWidth + trimWidth)/2) + ''',''' + str((ppsHeight + trimHeight)/2 + 5.0) + ''',v27" style="stroke:#000000;stroke-width:.2" />\n''')
# horzontal top left
fbackgr.write( '''<path d =" m''' + str((ppsWidth - trimWidth)/2 - 32.0) + ''',''' + str((ppsHeight - trimHeight)/2) + ''',h27" style="stroke:#000000;stroke-width:.2" />\n''')
# horzontal top right
fbackgr.write( '''<path d =" m''' + str((ppsWidth + trimWidth)/2 + 5.0) + ''',''' + str((ppsHeight - trimHeight)/2) + ''',h27" style="stroke:#000000;stroke-width:.2" />\n''')
# horzontal bottom right
fbackgr.write( '''<path d =" m''' + str((ppsWidth - trimWidth)/2 - 32.0) + ''',''' + str((ppsHeight + trimHeight)/2) + ''',h27" style="stroke:#000000;stroke-width:.2" />\n''')
# horzontal bottom left
fbackgr.write( '''<path d =" m''' + str((ppsWidth + trimWidth)/2 +5.0) + ''',''' + str((ppsHeight + trimHeight)/2) + ''',h27" style="stroke:#000000;stroke-width:.2" />\n''')
fbackgr.write( '''</svg>''')
# Convert the temp svg to pdf and merge into backgroundFile
results = self.tools.mergePdfFilesPdftk(self.local.backgroundFile, self.tools.convertSvgToPdfRsvg(svgFile))
if os.path.isfile(results) :
return True
def mergePagebox (self) :
'''Merge a page box with the background page to be used for proof reading.'''
# Initialize the process
svgFile = tempfile.NamedTemporaryFile().name
## RENDERED PAGE DIMENSIONS (body)
# Trim page width [px]
trimWidth = round(self.mmToPx * float(self.layoutConfig['PageLayout']['pageWidth']),1)
# Trim page height [px]
trimHeight = round(self.mmToPx * float(self.layoutConfig['PageLayout']['pageHeight']),1)
# Printer page size [px]
pps = self.printerPageSize()
ppsWidth = pps[0]
ppsHeight = pps[1]
with codecs.open(svgFile, 'wb') as fbackgr :
# starting lines of SVG xml
fbackgr.write( '''<svg xmlns="http://www.w3.org/2000/svg"
version="1.1" width = "''' + str(ppsWidth) + '''" height = "''' + str(ppsHeight) + '''">''')
# rectangle
fbackgr.write( '''<rect x = "''' + str((ppsWidth - trimWidth)/2) + '''" y= "''' + str((ppsHeight - trimHeight)/2) + '''" height = "''' + str(trimHeight) + '''" width = "''' + str(trimWidth) + '''" style = "fill:none;fill-opacity:1;stroke:#000000;stroke-opacity:1;stroke-width:.2"/>
</svg>''')
# Convert the temp svg to pdf and merge into backgroundFile
results = self.tools.mergePdfFilesPdftk(self.local.backgroundFile, self.tools.convertSvgToPdfRsvg(svgFile))
if os.path.isfile(results) :
return True
# Depricated
#def makeBgFileName (self, orgName) :
#'''Alter the file name to reflect the fact it has a background
#added to it. This assumes the file only has a single extention.
#If that's not the case we're hosed.'''
#name = orgName.split('.')[0]
#ext = orgName.split('.')[1]
## Just in case this is the second pass
#name = name.replace('-bg', '')
#return name + '-bg.' + ext
def centerOnPrintPage (self, contents) :
'''Center a PDF file on the printerPageSize page. GhostScript
is the only way to do this at this point.'''
# import pdb; pdb.set_trace()
tmpFile = tempfile.NamedTemporaryFile().name
# Get the size of our printer page
(ppsWidth, ppsHeight) = self.printerPageSize()
(wo, ho) = self.getPageOffset()
pageOffset = str(wo) + ' ' + str(ho)
# Assemble the GhostScript command
cmd = [ 'gs',
'-o', tmpFile,
'-sDEVICE=pdfwrite',
'-dQUIET',
'-dDEVICEWIDTHPOINTS=' + str(ppsWidth),
'-dDEVICEHEIGHTPOINTS=' + str(ppsHeight),
'-dFIXEDMEDIA',
'-c',
'<</PageOffset [' + str(pageOffset) + ']>>',
'setpagedevice',
'-f',
contents]
if self.debugMode :
self.tools.terminal('Debug Mode On: \centerOnPrintPage() command: ' + str(cmd))
# Run the process
try:
subprocess.call(cmd)
# Return the name of the temp PDF
return tmpFile
except Exception as e :
self.log.writeToLog(self.errorCodes['1280'], [str(cmd), str(e)])
# Return the temp file name for further processing
def printerPageSize (self) :
'''Return the width and height of the printer page size in
points. Only US Letter and A4 are supported. If not specified
return the page trim size.'''
printerPageSizeCode = self.layoutConfig['PageLayout']['printerPageSizeCode'].lower()
## STANDARD PRINTER PAGE SIZES
# The output page (printer page) is what the typeset page will be placed on
# with a watermark behind it. There are only two page sizes supported.
# They are A4 and US Letter. We will determine the size by the ID code
# found in the layout.conf file. However, in some cases, for example
# during the layout process, the trim size is what is needed. If
# one of the two supported pages sizes are not used, this will defult
# to the trim size.
if printerPageSizeCode == 'a4' :
return float(595), float(842)
elif printerPageSizeCode == 'letter' :
return float(612), float(792)
else :
# Just default to the page trim size (assumed mm coming in) factor mmToPx = 72 / 25.4
return float(int(self.layoutConfig['PageLayout']['pageWidth']) * self.mmToPx), float(int(self.layoutConfig['PageLayout']['pageHeight']) * self.mmToPx)
def getPageOffset (self) :
'''Return the amount of horizontal and vertical offset that will
enable the page trim size to be centered on the printer page. If
something other than A4 or Letter is being used, the offset returned
will be zero as this only supports those two sizes. The offset is
based on the starting point being the lower-left side corner
of the page. '''
# Get the printer page size
printerPageSizeCode = self.layoutConfig['PageLayout']['printerPageSizeCode'].lower()
# Get the page trim size (assuming mm input)factor mmToPx = 72 / 25.4
trimWidth = int(self.layoutConfig['PageLayout']['pageWidth']) * self.mmToPx
trimHeight = int(self.layoutConfig['PageLayout']['pageHeight']) * self.mmToPx
# The trim size of the content page can never be bigger than
# the printer page size. If so, the offset is 0
if printerPageSizeCode == 'a4' or printerPageSizeCode == 'letter' :
(bw, bh) = self.printerPageSize()
wo = float((bw/2)-(trimWidth/2))
ho = float((bh/2)-(trimHeight/2))
return wo, ho
else :
return 0, 0
class Text (Manager) :
# Shared values
xmlConfFile = 'text.xml'
def __init__(self, project, cfg, cType) :
'''Do the primary initialization for this manager.'''
super(Text, self).__init__(project, cfg)
# Set values for this manager
self.gid = project.gid
self.pid = project.projectIDCode
self.tools = Tools()
self.project = project
self.projectConfig = project.projectConfig
self.cfg = cfg
self.cType = cType
self.Ctype = cType.capitalize()
self.log = project.log
self.manager = self.cType + '_Text'
self.managers = project.managers
self.rapumaXmlTextConfig = os.path.join(self.project.local.rapumaConfigFolder, self.xmlConfFile)
# import pdb; pdb.set_trace()
# Get persistant values from the config if there are any
newSectionSettings = self.tools.getPersistantSettings(self.project.projectConfig['Managers'][self.manager], self.rapumaXmlTextConfig)
if newSectionSettings != self.project.projectConfig['Managers'][self.manager] :
self.project.projectConfig['Managers'][self.manager] = newSectionSettings
self.tools.writeConfFile(self.project.projectConfig)
self.compSettings = self.project.projectConfig['Managers'][self.manager]
for k, v in self.compSettings.iteritems() :
setattr(self, k, v)
# Log messages for this module
self.errorCodes = {
'TEXT-000' : ['MSG', 'Text module messages'],
'TEXT-005' : ['ERR', 'Component type [<<1>>] is not supported by the text manager.'],
'TEXT-015' : ['MSG', 'TEXT-015 - Unassigned error message ID.'],
'TEXT-030' : ['LOG', 'Copied [<<1>>] to [<<2>>] in project.'],
'TEXT-040' : ['WRN', 'The [<<1>>] component is locked. It must be unlocked before any modifications can be made.'],
'TEXT-050' : ['LOG', 'Working text file for [<<1>>] has been completed.'],
'TEXT-055' : ['ERR', 'TEXT-055 - Unassigned error message ID.'],
'TEXT-080' : ['LOG', 'Validating text using the [<<1>>] style file.'],
'TEXT-150' : ['MSG', 'USFM file: [<<1>>] is valid.'],
'TEXT-160' : ['ERR', 'Unable to complete working text installation for [<<1>>]. May require \"force\" (-f).'],
'0000' : ['MSG', 'Placeholder message'],
}
###############################################################################
############################ Project Level Functions ##########################
###############################################################################
# def setSourceEditor (self, editor) :
# '''Set the source editor for the cType. It assumes the editor is valid.
# This cannot fail.'''
# se = ''
# if self.project.projectConfig['CompTypes'][self.Ctype].has_key('sourceEditor') :
# se = self.project.projectConfig['CompTypes'][self.Ctype]['sourceEditor']
# if se != editor :
# self.project.projectConfig['CompTypes'][self.Ctype]['sourceEditor'] = editor
# self.tools.writeConfFile(self.project.projectConfig)
# FIXME: Get rid of the PT dependencies
#def updateManagerSettings (self, gid) :
#'''Update the settings for this manager if needed.'''
## import pdb; pdb.set_trace()
#sourceEditor = self.pt_tools.getSourceEditor()
## If the source editor is PT, then a lot of information can be
## gleaned from the .ssf file. Otherwise we will go pretty much with
## the defaults and hope for the best.
#if sourceEditor.lower() == 'paratext' :
## Do a compare on the settings
#ptSet = self.pt_tools.getPTSettings()
#oldCompSet = self.compSettings.dict()
## Don't overwrite manager settings (default sets reset to False) if
## there already is a setting present on the nameFormID.
#if self.project.projectConfig['Managers'][self.cType + '_Text']['nameFormID'] :
#newCompSet = self.pt_tools.mapPTTextSettings(self.compSettings.dict(), ptSet)
#else :
#newCompSet = self.pt_tools.mapPTTextSettings(self.compSettings.dict(), ptSet, True)
#if not newCompSet == oldCompSet :
#self.compSettings.merge(newCompSet)
#self.tools.writeConfFile(self.project.projectConfig)
## Be sure to update the current session settings
#for k, v in self.compSettings.iteritems() :
#setattr(self, k, v)
## A generic editor means we really do not know where the text came
## from. In that case, we just do the best we can.
#elif sourceEditor.lower() == 'generic' :
#if not self.project.projectConfig['Managers'][self.cType + '_Text']['nameFormID'] or \
#not self.project.projectConfig['Managers'][self.cType + '_Text']['postPart'] :
#self.project.projectConfig['Managers'][self.cType + '_Text']['nameFormID'] = 'USFM'
#self.project.projectConfig['Managers'][self.cType + '_Text']['postPart'] = 'usfm'
#self.tools.writeConfFile(self.project.projectConfig)
#else :
#self.project.log.writeToLog('TEXT-010', [sourceEditor])
#self.tools.dieNow()
#return True
def testCompTextFile (self, cName, source, projSty = None) :
'''This will direct a request to the proper validator for
testing the source of a component text file.'''
if self.cType == 'usfm' :
# If this fails it will die at the validation process
if self.project.components[cName].usfmTextFileIsValid(source, projSty) :
self.project.log.writeToLog('TEXT-150', [source])
return True
else :
self.project.log.writeToLog('TEXT-005', [self.cType])
self.tools.dieNow()
class ProjFont (object) :
def __init__(self, pid) :
'''Do the primary initialization for this class.'''
self.pid = pid
self.tools = Tools()
self.user = UserConfig()
self.log = ProjLog(pid)
self.userConfig = self.user.userConfig
self.proj_config = Config(pid)
self.proj_config.getProjectConfig()
self.projectConfig = self.proj_config.projectConfig
self.proj_config.getFontConfig()
self.fontConfig = self.proj_config.fontConfig
self.local = ProjLocal(pid, self.projectConfig)
# Load all font settings for use in this module
if self.fontConfig :
for k, v in self.fontConfig['GeneralSettings'].iteritems() :
setattr(self, k, v)
# Log messages for this module
self.errorCodes = {
'FONT-000' : ['MSG', 'Font module messages'],
'FONT-005' : ['MSG', 'FONT-005 - Unassigned error message ID.'],
'FONT-015' : ['MSG', 'FONT-015 - Unassigned error message ID.'],
'FONT-020' : ['ERR', 'Failed to find font setting in ParaTExt project (.ssf file). A primary font must be set before this component can be successfully rendered.'],
'FONT-025' : ['ERR', 'No source editor was found for this project. Please enter this setting before continuing.'],
'FONT-042' : ['MSG', 'The [<<1>>] font setup information was added to project config'],
'FONT-050' : ['ERR', 'Halt! [<<1>>] not found. - font.copyInFont()'],
'FONT-070' : ['LOG', 'Copied the [<<1>>] font file into the project. - proj_font.copyInFont()'],
'FONT-100' : ['ERR', 'This function has not been implemented yet!. - proj_font.setGlyphMap()'],
'0010' : ['LOG', 'Wrote out new font configuration (font.__init__())'],
'1220' : ['ERR', 'The Font bundle file [<<1>>] could not be found. Process halted.'],
'1235' : ['MSG', 'Font [<<1>>] has been installed into the project.'],
'1237' : ['MSG', 'Font [<<1>>] has been updated.'],
'1240' : ['ERR', 'Font bundle file [<<1>>] not found.'],
'1241' : ['ERR', 'Font bundle [<<1>>] not found.'],
'1245' : ['LOG', '<<1>> font setup information added to project config'],
'1250' : ['ERR', 'The [<<1>>] font is apparently part of this project. Please remove before trying to re-add this font.'],
'1260' : ['MSG', 'The <<1>> font bundle has been copied into the project font folder.'],
'1262' : ['LOG', 'The <<1>> font bundle already exsits in the font folder.'],
'1265' : ['ERR', 'Failed to extract the [<<1>>] font bundle into the project. Font install process failed.'],
'1267' : ['LOG', 'The <<1>> font bundle has been copied into the project font folder.'],
'1280' : ['MSG', 'Failed to install the font: [<<1>>] into the project.'],
'1370' : ['LOG', 'Removed [<<1>>] font name from project component type: [<<2>>].'],
'1380' : ['MSG', 'Removed the [<<1>>] font from the project.'],
'1382' : ['MSG', 'Force switch was set (-f). This process has completely removed the [<<1>>] font and settings from the project. - proj_font.removeFont()'],
'1390' : ['LOG', 'Removed the [<<1>>] font package.'],
'1395' : ['MSG', 'Could not remove the [<<1>>] font package. It may be used by another group. Use force (-f) to remove the package from the font folder.']
}
###############################################################################
############################ Project Level Functions ##########################
###############################################################################
######################## Error Code Block Series = 1000 #######################
###############################################################################
def setGlyphMap (self, cType, font) :
'''If needed, set the glyph map used for this component type font.'''
self.log.writeToLog('FONT-100')
def getFontIdFromFileName (self, fileName) :
'''Return the font ID based on the file name'''
# File name less ext is the font ID
parts = len(fileName.split('.'))
return '.'.join(fileName.split('.')[:parts-1])
def getFontIdFromSource (self, source) :
'''Return the font ID based on the complete path and file name.'''
# Get the file name from the path
fileName = self.tools.fName(source)
# Return the font ID
return self.getFontIdFromFileName(fileName)
def recordFont (self, fontId, cType=None) :
'''Check for the exsitance of the specified font in the font folder.
Then extract the meta data into the appropreate configurations.'''
# import pdb; pdb.set_trace()
# Set vars do initial checks
metaDataSource = os.path.join(self.local.projFontFolder, fontId, fontId + '.xml')
if not os.path.isfile(metaDataSource) :
self.log.writeToLog(self.errorCodes['1240'], [fontId + '.xml', 'proj_font.recordFont():1240'])
# Build the Fonts section in the config (if needed)
self.tools.buildConfSection(self.fontConfig, 'Fonts')
# (Re)Inject the font info into the macPack config file.
fInfo = self.tools.getXMLSettings(metaDataSource)
self.fontConfig['Fonts'][fontId] = fInfo.dict()
# Save the settings now
self.tools.writeConfFile(self.fontConfig)
# If a component type was specified, record that as well
if cType :
self.projectConfig['CompTypes'][cType.capitalize()]['fontName'] = fontId
self.tools.writeConfFile(self.projectConfig)
return True
def copyInFont (self, source) :
'''Copy a font into a project. The font is bundled with other
necessary components in a .zip file. If the font folder is
already there we assume there is a font there and we do not
proceed. The user will be prompted to remove the old one first.'''
fontId = self.getFontIdFromSource(source)
confXml = os.path.join(self.local.projFontFolder, fontId, fontId + '.xml')
if not os.path.isfile(source) :
self.log.writeToLog(self.errorCodes['1220'], [source])
# Install new copy
if self.tools.pkgExtract(source, self.local.projFontFolder, confXml) :
self.log.writeToLog(self.errorCodes['1260'], [self.tools.fName(source)])
return True
else :
self.log.writeToLog(self.errorCodes['1265'], [fontId])
return False
def addFont (self, source, cType=None) :
'''It is a three step process to install a font. This will both
copy in a font and record it in one call. Do not try to
install a substitute font. Path is assumed to exsist and contains
the file name too.'''
# import pdb; pdb.set_trace()
fontId = self.getFontIdFromSource(source)
# Check for existance, never copy over
if self.isFont(fontId) :
self.log.writeToLog(self.errorCodes['1250'], [fontId])
# Now install and record
if self.copyInFont(source) and self.recordFont(fontId, cType) :
self.log.writeToLog(self.errorCodes['1235'], [fontId])
return True
else :
self.log.writeToLog(self.errorCodes['1280'], [fontId])
return False
def updateFontPack (self, source, cType=None) :
'''Update a font package but do not change any of the existing
settings. If there are setting issues (changes) it would be
best to remove, then reinstall. A potential confusion point
is that updating a font normally means changing the ID. Then
updating actually becomes just installing a font.'''
# import pdb; pdb.set_trace()
# Get the font ID
fontId = self.getFontIdFromSource(source)
# Be sure the font is in the project
if self.isFont(fontId) :
# Remove old copy
if os.path.exists(os.path.join(self.local.projFontFolder, fontId)) :
shutil.rmtree(os.path.join(self.local.projFontFolder, fontId))
# Bring in a fresh copy
if self.copyInFont(source) :
# If a component type was specified, record that as well
if cType :
self.projectConfig['CompTypes'][cType.capitalize()]['fontName'] = fontId
self.tools.writeConfFile(self.projectConfig)
self.log.writeToLog(self.errorCodes['1237'], [fontId])
return True
def removeFontSettings (self, fontId) :
'''Remove the font settings from the project.'''
# import pdb; pdb.set_trace()
if self.fontConfig.has_key('Fonts') :
if self.fontConfig['Fonts'].has_key(fontId) :
del self.fontConfig['Fonts'][fontId]
# Write out the new settings files
self.tools.writeConfFile(self.fontConfig)
self.log.writeToLog(self.errorCodes['1380'], [fontId])
# Check to see if this font is listed in any of the cTypes
# If so, remove it.
found = 0
for cType in self.projectConfig['CompTypes'].keys() :
# It might be possible that the cType has no font settings, so we check
if self.projectConfig['CompTypes'][cType.capitalize()].has_key('fontName') :
if self.projectConfig['CompTypes'][cType.capitalize()]['fontName'] == fontId :
self.projectConfig['CompTypes'][cType.capitalize()]['fontName'] = ''
self.log.writeToLog(self.errorCodes['1370'], [fontId, cType])
found +=1
if found > 0 :
self.tools.writeConfFile(self.projectConfig)
return True
def removeFontPack (self, fontId) :
'''Remove a font from a component type which will virtually disconnect
it from the calling component type. However, if the force switch is set,
then remove the font, regardless as to if it is used by another component
or not. This is useful for purging a font from a project but should be
used with care.'''
# Purge the font files and folder
fontDir = os.path.join(self.local.projFontFolder, fontId)
if os.path.exists(fontDir) :
shutil.rmtree(fontDir)
self.log.writeToLog(self.errorCodes['1390'], [fontId])
if self.removeFontSettings(fontId) :
return True
###############################################################################
############################ Font Settings Functions ##########################
###############################################################################
######################## Error Code Block Series = 2000 #######################
###############################################################################
def isFont (self, fontId) :
'''Return if it is varified that this font is part of the project.'''
# First do a cusory check to see if at least the font folder is there
fontDir = os.path.join(self.local.projFontFolder, fontId)
if not os.path.exists(fontDir) :
return False
# If the above passed, check in the font config to see if it is listed
if not self.fontConfig['Fonts'].has_key(fontId) :
return False
# If the two tests above passed it is probably there
return True
class ProjBinding (object) :
def __init__(self, pid) :
'''Do the primary initialization for this manager.'''
self.pid = pid
self.tools = Tools()
self.user = UserConfig()
self.userConfig = self.user.userConfig
self.config = Config(pid)
self.pg_back = ProjBackground(self.pid)
self.config.getProjectConfig()
self.config.getLayoutConfig()
self.projectConfig = self.config.projectConfig
self.layoutConfig = self.config.layoutConfig
self.useBackground = self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useBackground'])
self.useDocInfo = self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useDocInfo'])
self.projHome = os.path.join(os.environ['RAPUMA_PROJECTS'], self.pid)
self.local = ProjLocal(self.pid)
self.log = ProjLog(self.pid)
self.pdfViewerCmd = self.tools.getPdfViewerCommand(self.userConfig, self.projectConfig)
# Log messages for this module
self.errorCodes = {
'0205' : ['MSG', 'Unassigned message.'],
'0210' : ['MSG', 'No contents are specified for binding.'],
'0215' : ['ERR', 'Failed to bind contents into the [<<1>>] fille. Got error: [<<2>>]'],
'0220' : ['ERR', 'Could not copy [<<1>>] temp file to [<<2>>] saved binding file.'],
'0230' : ['MSG', 'Completed proccessing on the [<<1>>] binding file.'],
'0235' : ['ERR', 'Failed to complete proccessing on the [<<1>>] binding file.'],
'0240' : ['LOG', 'Recorded [<<1>>] rendered pages in the [<<2>>] binding file.'],
'0260' : ['ERR', 'PDF viewer failed with this error: [<<1>>]'],
'0265' : ['ERR', 'Rendered file not found: <<1>>'],
'0270' : ['WRN', 'PDF viewing is disabled.'],
'0280' : ['ERR', 'GS PDF file merge failed with this error: [<<1>>]'],
'0300' : ['MSG', 'File binding operation in process, please wait...']
}
###############################################################################
############################## Binding Functions ##############################
###############################################################################
######################## Error Code Block Series = 200 ########################
###############################################################################
# import pdb; pdb.set_trace()
def bind (self, save = False) :
'''Bind all groups in the order they are indicated by group bindOrder
settings. Note, because binding spans groups and the main body
(project.py) mainly just works on one group at a time, this has to
be called from outside project and project needs to be reinitialized
each time a group is rendered from here.'''
# import pdb; pdb.set_trace()
# Get the order of the groups to be bound.
bindOrder = {}
# Put a safty in here in case there are no groups yet
if not self.projectConfig.has_key('Groups') :
return False
# Build the bindOrder dict with ord num as key and file name as value
for gid in self.projectConfig['Groups'].keys() :
if not self.projectConfig['Groups'][gid].has_key('bindingOrder') :
self.projectConfig['Groups'][gid]['bindingOrder'] = 0
self.tools.writeConfFile(self.projectConfig)
if int(self.projectConfig['Groups'][gid]['bindingOrder']) > 0 :
gidPdfFile = os.path.join(self.local.projComponentFolder, gid, gid + '.pdf')
# bindOrder[self.projectConfig['Groups'][gid]['bindingOrder']] = self.projectConfig['Groups'][gid]['bindingFile']
bindOrder[self.projectConfig['Groups'][gid]['bindingOrder']] = gidPdfFile
bindGrpNum = len(bindOrder)
# Need not keep going if nothing was found
if bindGrpNum == 0 :
self.log.writeToLog(self.errorCodes['0210'])
return False
# Make an ordered key list
keyList = bindOrder.keys()
keyList.sort()
# Output the bind files in order according to the list we made
fileList = []
for key in keyList :
fileList.append(bindOrder[key])
# First merge the master pages together
tempFile = self.mergePdfFilesGs(fileList)
# Now add background and doc info if requested
bgFile = ''
if self.useBackground :
bgFile = self.pg_back.addBackground(tempFile)
if self.useDocInfo :
if bgFile :
bgFile = self.pg_back.addDocInfo(bgFile)
else :
bgFile = self.pg_back.addDocInfo(tempFile)
# If we are saving this make a name for it
if save :
bindFileName = self.pid + '_contents_' + self.tools.ymd()
# Save this to the Deliverable folder (Make sure there is one)
if not os.path.isdir(self.local.projDeliverableFolder) :
os.makedirs(self.local.projDeliverableFolder)
bindFile = os.path.join(self.local.projDeliverableFolder, bindFileName + '.pdf')
if os.path.exists(bgFile) :
if shutil.copy(bgFile, bindFile) :
self.log.writeToLog(self.errorCodes['0220'], [bgFile,bindFile])
else :
if shutil.copy(tempFile, bindFile) :
self.log.writeToLog(self.errorCodes['0220'], [tempFile,bindFile])
# Direct to viewFile
viewFile = bindFile
else :
if os.path.exists(bgFile) :
viewFile = bgFile
else :
viewFile = tempFile
# Binding should have been successful, report it now
self.log.writeToLog(self.errorCodes['0230'], [viewFile])
# View the file
if os.path.isfile(viewFile) :
if self.pdfViewerCmd :
# Add the file to the viewer command
self.pdfViewerCmd.append(viewFile)
# Run the viewer
try :
subprocess.Popen(self.pdfViewerCmd)
return True
except Exception as e :
# If we don't succeed, we should probably quite here
self.log.writeToLog(self.errorCodes['0260'], [str(e)])
else :
self.log.writeToLog(self.errorCodes['0270'])
else :
self.log.writeToLog(self.errorCodes['0265'], [self.tools.fName(viewFile)])
def mergePdfFilesGs (self, sourceList) :
'''Using GS, merge multiple PDF files into one. The advantage of
using Gs is that the index will be maintained. pdftk strips out
the index, which is bad...'''
# This is our working file for this operation
tempFile = tempfile.NamedTemporaryFile().name + '.pdf'
# FIXME: Note/Warning, the use "-dPDFSETTINGS=/prepress" can cause an issue when
# rendering. A segmentation fault may occur. This will cause the bind feature
# to fail because gs failed. The segmentation fault seems to occure from graphics
# embedded in the PDF that are either too big or not a true grayscale, but rather
# RGB. The /prepress setting will then fail which means the doc will fail to test
# out right in PDF x1a tests.
# There does not seem to be any good way around this at this time. With more
# development time and perhaps better options, we might someday be able to get
# the bind process to be completely automated and be able to pass all Adobe tests
# for x1a and other issues. As there is not any real demand for Rapuma, it isn't
# worth putting any more effort into this section of code. Therefore, the
# /prepress setting will be dropped from here and the user will be required to
# Run any output through an Adobe product to get output that will be acceptable
# to Adobe. Adobe wins, I quite. :-(
# This command structure was in production until the segmenation fault issue was found:
# cmd = ['gs', '-dBATCH', '-dNOPAUSE', '-q', '-sDEVICE=pdfwrite', '-dPDFSETTINGS=/prepress', '-sOutputFile=' + tempFile]
# For issues with segmentation faults, the following should help
# with debugging. Adjust as needed. for more info go to:
# http://ghostscript.com/doc/8.54/Use.htm#Debugging
# cmd = ['gs', '-dBATCH', '-dNOPAUSE', '-q', '-sDEVICE=pdfwrite', '-sOutputFile=' + tempFile, '-dPDFWRDEBUG', '-E']; print cmd
# This is the non-x1a compatable command that will normally be used
cmd = ['gs', '-dBATCH', '-dNOPAUSE', '-q', '-sDEVICE=pdfwrite', '-sOutputFile=' + tempFile]
# Continueing on, now add the files we want to bind together
cmd = cmd + sourceList
# Now bind the files
try :
self.log.writeToLog(self.errorCodes['0300'])
subprocess.call(cmd)
# Return our file name for further processing
return tempFile
except Exception as e :
# If we don't succeed, we should probably quite here
self.log.writeToLog(self.errorCodes['0280'], [str(e)])
class ProjDiagnose (object) :
def __init__(self, pid, gid = None) :
'''Intitate the whole class and create the object.'''
# import pdb; pdb.set_trace()
self.pid = pid
self.gid = gid
self.local = ProjLocal(pid, gid)
self.tools = Tools()
self.proj_config = Config(pid, gid)
self.proj_config.getProjectConfig()
self.proj_config.getLayoutConfig()
self.layoutConfig = self.proj_config.layoutConfig
self.user = UserConfig()
self.userConfig = self.user.userConfig
self.log = ProjLog(pid)
# to [px] is 72/25.4
self.mmToPx = 72 / 25.4
# page width [px]
self.paperPxWidth = round(self.mmToPx * float(self.layoutConfig['PageLayout']['pageWidth']),1)
# page height [px]
self.paperPxHeight = round(self.mmToPx * float(self.layoutConfig['PageLayout']['pageHeight']),1)
# Log messages for this module
self.errorCodes = {
'0000' : ['MSG', 'Placeholder message'],
'1310' : ['WRN', 'Failed to add diagnostic component: [<<1>>] with error: [<<2>>]']
}
###############################################################################
############################### Create Functions ##############################
###############################################################################
######################## Error Code Block Series = 1000 #######################
###############################################################################
def turnOnDiagnostic (self) :
'''Change the layout config settings to turn on the diagnostic layer.'''
if not self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useDiagnostic']) :
self.layoutConfig['DocumentFeatures']['useDiagnostic'] = True
self.tools.writeConfFile(self.layoutConfig)
def turnOffDiagnostic (self) :
'''Change the layout config settings to turn off the diagnostic layer.'''
if self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useDiagnostic']) :
self.layoutConfig['DocumentFeatures']['useDiagnostic'] = False
self.tools.writeConfFile(self.layoutConfig)
def addTransparency (self, target, force = False) :
'''Add a transparent layer to a rendered PDF file. This will
add in diagnosing format issues. Using force will cause any
existing layer file to be remade.'''
# Do a quick check if the transparency needs to be remade
# The transparency normally is not remade if one already exists.
# If one is there, it can be remade in two ways, with a force
# or a regenerate command.
if force :
self.createDiagnostic()
elif self.tools.str2bool(self.layoutConfig['DocumentFeatures']['regenerateTransparency']) :
self.createDiagnostic()
else :
# If there isn't one, make it
if not os.path.exists(self.local.diagnosticFile) :
self.createDiagnostic()
# Create a special temp named file for the target
tmpTarget = tempfile.NamedTemporaryFile().name
# Copy the target to the tmpTarget
shutil.copy(target, tmpTarget)
# Overlay the transparency diagnostic file over the tmpTarget
self.tools.mergePdfFilesPdftk(tmpTarget, self.local.diagnosticFile)
# Create a special name for the file with the background
# Then merge and save it
viewFile = self.tools.alterFileName(target, 'view')
# Copy the results back to the target (should be done now)
shutil.copy(tmpTarget, viewFile)
# Not returning a file name would mean it failed
if os.path.exists(viewFile) :
return viewFile
def createDiagnostic (self) :
'''Create a diagnostic transparency (file) that will be
superimposed over the page contents to help diagnose format
issues. This will overwrite any existing transparency file and
will add each recognoized diagnostic type found in the
diagnosticComponents config setting.'''
# import pdb; pdb.set_trace()
self.createBlankTransparency()
# Add each component to the blank transparency file
for comp in self.layoutConfig['DocumentFeatures']['diagnosticComponents'] :
try :
getattr(self, 'merge' + comp.capitalize())()
except Exception as e :
self.log.writeToLog(self.errorCodes['1310'],[comp,str(e)])
pass
return True
def createBlankTransparency (self) :
'''Create a blank background page according to the trim size
specified.'''
# Set the temp svg file name
svgFile = tempfile.NamedTemporaryFile().name
# Be sure there is an illustrations folder in place
if not os.path.isdir(self.local.projIllustrationFolder) :
os.mkdir(self.local.projIllustrationFolder)
# Write out SVG document text
with codecs.open(svgFile, 'wb') as fbackgr : # open file for writing
fbackgr.write( '''<svg xmlns="http://www.w3.org/2000/svg"
version="1.1" width = "''' + str(self.paperPxWidth) + '''" height = "''' + str(self.paperPxHeight)+ '''">
</svg>''')
shutil.copy(self.tools.convertSvgToPdfRsvg(svgFile), self.local.diagnosticFile)
###############################################################################
############################# Component Functions #############################
###############################################################################
######################## Error Code Block Series = 2000 #######################
###############################################################################
def mergeLeading (self) :
'''Create a diagnostic page component that has lines to indicate
the text leading. This will be superimposed over the contents of
the trim page, not in the background like a watermark, etc.'''
# Initialize the process
svgFile = tempfile.NamedTemporaryFile().name
# PAGE DIMENSIONS
# The page dimensions extracted from layoutConfig are in [mm] and
# must be converted to pixels [px], the conversion factor for [mm]
# bodyFontSize [px]
bodyFontSize = self.layoutConfig['TextElements']['bodyFontSize']
bodyFontPxSize = round(float(bodyFontSize) * 72/72.27,3)
# bodyTextLeading [px]
bodyTextLeading = self.layoutConfig['TextElements']['bodyTextLeading']
bodyTextPxLeading = round(float(bodyTextLeading) * 72/72.27,3)
# top margin [px]
topMargin = self.layoutConfig['PageLayout']['topMargin']
topPxMargin = round(self.mmToPx * float(topMargin),1)
# outside margin [px]
outsideMargin = self.layoutConfig['PageLayout']['outsideMargin']
outsidePxMargin = round(self.mmToPx * float(outsideMargin),1)
#inside margin [px]
insideMargin = self.layoutConfig['PageLayout']['insideMargin']
insidePxMargin = round(self.mmToPx * float(outsideMargin),1)
# bottom margin [px]
bottomMargin = self.layoutConfig['PageLayout']['bottomMargin']
bottomPxMargin = round(self.mmToPx * float(bottomMargin),1)
# width of the body text
textPxWidth = self.paperPxWidth - (outsidePxMargin + insidePxMargin)
# Create the svg file
with codecs.open(svgFile, 'wb') as fbackgr : # open file for writing
# starting lines of SVG xml
fbackgr.write( '''<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width = "''' + str(self.paperPxWidth)+ '''" height = "'''+str(self.paperPxHeight) + '''">
\n <!--RECTANGLE OF MARGINS-->\n''')
fbackgr.write( '''<rect x = "''' + str(outsidePxMargin) + '''" y= "''' + str(topPxMargin) + '''" height = "''' + str(self.paperPxHeight - topPxMargin - bottomPxMargin) + '''" width = "''' + str(textPxWidth) + '''" style = "fill:none;fill-opacity:1;stroke:#ffc800;stroke-opacity:1;stroke-width:.2"/>
\n <!--START OF LINEGRID-->\n''')
fbackgr.write( '''<path d= "m ''' + str(outsidePxMargin * 0.75-1) + "," + str(topPxMargin + bodyFontPxSize) + " " + str(textPxWidth + outsidePxMargin * 0.25)+ ''',0''')
# filling the space between the top line and bottom margin, starting at distance
# counter num = 0 up to the but not including the total of num x leading
# equals the distance between top and bottom margin
num = 0
while (num < int(round(self.paperPxHeight - bottomPxMargin - topPxMargin)/bodyTextPxLeading)):
# lines are drawn in zigzag pattern: RTL when num is even and LTR when odd
if num%2 == 0:
fbackgr.write( ''' m 0, ''' + str(bodyTextPxLeading) + " -" + str(textPxWidth + outsidePxMargin * 0.25)+ ''',0''')
else:
fbackgr.write( ''' m 0, ''' + str(bodyTextPxLeading) + " " + str(textPxWidth + outsidePxMargin * 0.25)+ ''',0''')
num = num +1
# draw all lines with following style
fbackgr.write( '''" style="stroke-width:0.2px;stroke:#ffc800;stroke-opacity:1"/>
\n <!--LINE NUMBERS-->\n''')
# add line number '1' to top line just left of margin
fbackgr.write( '''<text x="''' + str(outsidePxMargin * 0.75-2) + '''" y="''' + str(topPxMargin + bodyFontPxSize-3) + '''" style="font-family: Charis SIL;font-style:italic;font-size:7;fill:#760076"> 1''')
# add line numbers to all lines down to bottom margin, starting with line number
# counter linecount = 2, the distance counter runs from '0' till one short of
# the quotient (distance between top and bottom margin)/bodyTextPxLeading
num = 0 # line counter
linenumber = 2 # line number
while (num < int(round(self.paperPxHeight - bottomPxMargin - topPxMargin)/bodyTextPxLeading)):
fbackgr.write( '''<tspan x="''' + str(outsidePxMargin * 0.75-2) + '''" dy="''' + str(bodyTextPxLeading) + '''">''' + str(linenumber) + '''</tspan>''')
linenumber = linenumber +1
num = num +1
fbackgr.write('''</text>
\n <!--LINEGRID CAPTION-->
<text x="36" y="''' + str(self.paperPxHeight - bottomPxMargin+10) + '''" style="font-family: Charis SIL;font-style:italic;font-size:7;fill:#ffc800">page size: ''' + str(int(self.paperPxWidth/72*25.4+.5)) + ''' x ''' + str(int(self.paperPxHeight/72*25.4+.5)) + ''' mm ; font size: ''' + str(bodyFontSize) + ''' pt; leading: ''' + str(bodyTextLeading) + ''' pt</text>
\n <!--PURPLE LINES TOP AND BOTTOM MARGINS-->
<path d="M ''' + str(outsidePxMargin) + "," + str(topPxMargin) + " " + str(textPxWidth + outsidePxMargin) + "," + str(topPxMargin) + '''" style="fill:#ffffff;fill-opacity:1;stroke-width:0.4px;stroke:#760076;stroke-opacity:1"/>
<path d="M ''' + str(outsidePxMargin) + "," + str(self.paperPxHeight - bottomPxMargin) + " " + str(textPxWidth + outsidePxMargin) + "," + str(self.paperPxHeight - bottomPxMargin) + '''" style="fill:#ffffff;fill-opacity:1;stroke-width:0.4px;stroke:#760076;stroke-opacity:1"/>
</svg>''')
# Convert the lines background component to PDF
leadingPdf = self.tools.convertSvgToPdfRsvg(svgFile)
# Merge leadingPdf with existing transparency
results = self.tools.mergePdfFilesPdftk(self.local.diagnosticFile, leadingPdf)
# Test and return if good
if os.path.isfile(results) :
return True
class Project (object) :
def __init__(self, pid, gid) :
'''Instantiate this class.'''
self.pid = pid
self.gid = gid
self.user = UserConfig()
self.userConfig = self.user.userConfig
self.projHome = os.path.join(os.environ['RAPUMA_PROJECTS'], self.pid)
self.config = Config(self.pid)
self.config.getProjectConfig()
self.projectConfig = self.config.projectConfig
self.cType = self.projectConfig['Groups'][self.gid]['cType']
self.Ctype = self.cType.capitalize()
self.local = ProjLocal(pid, gid, self.cType)
self.log = ProjLog(self.pid)
self.tools = Tools()
self.groups = {}
self.components = {}
self.managers = {}
self.projectMediaIDCode = self.projectConfig['ProjectInfo']['projectMediaIDCode']
self.projectIDCode = self.projectConfig['ProjectInfo']['projectIDCode']
self.projectName = self.projectConfig['ProjectInfo']['projectTitle']
self.plid = self.projectConfig['ProjectInfo']['languageCode']
self.psid = self.projectConfig['ProjectInfo']['scriptCode']
# The gid cannot generally be set yet but we will make a placeholder
# for it here and the functions below will set it. (I'm just say'n)
# import pdb; pdb.set_trace()
m = import_module('rapuma.manager.' + self.projectMediaIDCode)
self.__class__ = getattr(m, self.projectMediaIDCode[0].upper() + self.projectMediaIDCode[1:])
# Update the existing config file with the project type XML file
# if needed
newXmlDefaults = os.path.join(self.local.rapumaConfigFolder, self.projectMediaIDCode + '.xml')
xmlConfig = self.tools.getXMLSettings(newXmlDefaults)
newConf = ConfigObj(xmlConfig.dict(), encoding='utf-8').override(self.projectConfig)
for s,v in self.projectConfig.items() :
if s not in newConf :
newConf[s] = v
# Replace with new conf if new is different from old
# Rem new conf doesn't have a filename, give it one
if self.projectConfig != newConf :
self.projectConfig = newConf
self.projectConfig.filename = self.local.projectConfFile
# Log messages for this module
self.errorCodes = {
'PROJ-000' : ['MSG', 'Project module messages'],
'PROJ-030' : ['MSG', 'Changed [<<1>>][<<2>>][<<3>>] setting from \"<<4>>\" to \"<<5>>\".'],
'PROJ-040' : ['ERR', 'Problem making setting change. Section [<<1>>] missing from configuration file.'],
'PROJ-050' : ['ERR', 'Component [<<1>>] working text file was not found in the project configuration.'],
'PROJ-060' : ['ERR', 'Component [<<1>>] was not found in the project configuration.'],
'PROJ-070' : ['ERR', 'Source file not found: [<<1>>].'],
'PROJ-080' : ['MSG', 'Successful copy of [<<1>>] to [<<2>>].'],
'PROJ-090' : ['ERR', 'Target file [<<1>>] already exists. Use force (-f) to overwrite.'],
'0205' : ['LOG', 'Created the [<<1>>] manager object.'],
'0210' : ['LOG', 'Wrote out [<<1>>] settings to the project configuration file.'],
'0211' : ['ERR', 'Failed to write out project [<<1>>] settings to the project configuration file.'],
'0660' : ['ERR', 'Invalid component ID: [<<1>>].'],
}
###############################################################################
############################ Manager Level Functions ##########################
###############################################################################
######################## Error Code Block Series = 200 ########################
###############################################################################
def createManager (self, mType) :
'''Check to see if a manager is listed in the config and load it if
it is not already.'''
fullName = self.cType + '_' + mType.capitalize()
if fullName not in self.managers :
self.addManager(mType)
self.loadManager(mType)
self.log.writeToLog(self.errorCodes['0205'], [fullName])
def loadManager (self, mType) :
'''Do basic load on a manager.'''
fullName = self.cType + '_' + mType.capitalize()
cfg = self.projectConfig['Managers'][fullName]
module = import_module('rapuma.manager.' + mType)
ManagerClass = getattr(module, mType.capitalize())
manobj = ManagerClass(self, cfg, self.cType)
self.managers[fullName] = manobj
def addManager (self, mType) :
'''Create a manager reference in the project config that components
will point to.'''
# import pdb; pdb.set_trace()
fullName = self.cType + '_' + mType.capitalize()
managerDefaults = None
# Insert the Manager section if it is not already there
self.tools.buildConfSection(self.projectConfig, 'Managers')
if not self.projectConfig['Managers'].has_key(fullName) :
self.tools.buildConfSection(self.projectConfig['Managers'], fullName)
# Update settings if needed
update = False
managerDefaults = self.tools.getXMLSettings(os.path.join(self.local.rapumaConfigFolder, mType + '.xml'))
for k, v, in managerDefaults.iteritems() :
# Do not overwrite if a value is already there
if not self.projectConfig['Managers'][fullName].has_key(k) :
self.projectConfig['Managers'][fullName][k] = v
# If we are dealing with an empty string, don't bother writing out
# Trying to avoid needless conf updating here. Just in case we are
# working with a list, we'll use len()
if len(v) > 0 :
update = True
# Update the conf if one or more settings were changed
if update :
if self.tools.writeConfFile(self.projectConfig) :
self.log.writeToLog(self.errorCodes['0210'],[fullName])
else :
self.log.writeToLog(self.errorCodes['0211'],[fullName])
###############################################################################
############################ Group Level Functions ############################
###############################################################################
####################### Error Code Block Series = 0600 ########################
###############################################################################
def renderGroup (self, cidList = '', pages = '', override = '', save = False) :
'''Render a group of subcomponents or any number of components
in the group specified in the cidList.'''
# import pdb; pdb.set_trace()
# If there are any cids listed we need to test them
if cidList :
self.isValidCidList(cidList)
# Otherwise, do a basic test for exsistance and move on
if self.projectConfig['Groups'].has_key(self.gid) :
# Now create the group and pass the params on
self.createGroup().render(self.gid, cidList, pages, override, save)
return True
def createGroup (self) :
'''Create a group object that can be acted on. It is assumed
this only happens for one group per session. This group
will contain one or more compoenents. The information for
each one will be contained in the group object.'''
# import pdb; pdb.set_trace()
# If the object already exists just return it
if self.gid in self.groups:
return self.groups[self.gid]
cType = self.projectConfig['Groups'][self.gid]['cType']
# Create a special component object if called
cfg = self.projectConfig['Groups'][self.gid]
module = import_module('rapuma.group.' + cType)
ManagerClass = getattr(module, cType.capitalize())
groupObj = ManagerClass(self, cfg)
self.groups[self.gid] = groupObj
return groupObj
def isValidCidList (self, thisCidlist) :
'''Check to see if all the components in the list are in the group.'''
cidList = self.projectConfig['Groups'][self.gid]['cidList']
for cid in thisCidlist :
# If this is not a usfm type we do not need to validate
if self.cType == 'usfm' :
if not cid in cidList :
self.log.writeToLog(self.errorCodes['0660'],[cid])
def listAllComponents (self, cType) :
'''Generate a list of valid component IDs and cNames for this cType.'''
# Create the component object now with a special component caller ID
self.createComponent('usfm_internal_caller')
# Get the component info dictionary
comps = self.components['usfm_internal_caller'].usfmCidInfo()
# List and sort
cList = list(comps.keys())
cList.sort()
# For now we'll output to terminal but may want to change this later.
for c in cList :
if c != '_z_' :
print c, comps[c][1]
###############################################################################
############################ System Level Functions ###########################
###############################################################################
def run (self, command, opts, userConfig) :
'''Run a command'''
if command in self.commands :
self.commands[command].run(opts, self, userConfig)
else :
self.tools.terminalError('The command: [' + command + '] failed to run with these options: ' + str(opts))
class Usfm (Group) :
'''This class contains information about a type of component
used in a type of project.'''
# Shared values
xmlConfFile = 'usfm.xml'
def __init__(self, project, cfg) :
super(Usfm, self).__init__(project, cfg)
# import pdb; pdb.set_trace()
# Set values for this manager
self.pid = project.projectIDCode
self.gid = project.gid
self.cType = 'usfm'
self.Ctype = self.cType.capitalize()
self.project = project
self.local = project.local
self.tools = Tools()
self.proj_font = ProjFont(self.pid)
self.proj_illustration = ProjIllustration(self.pid, self.gid)
self.proj_config = Config(self.pid, self.gid)
self.proj_config.getProjectConfig()
self.proj_config.getAdjustmentConfig()
self.projectConfig = self.proj_config.projectConfig
self.adjustmentConfig = self.proj_config.adjustmentConfig
self.log = project.log
self.cfg = cfg
self.mType = project.projectMediaIDCode
self.renderer = project.projectConfig['CompTypes'][self.Ctype]['renderer']
self.sourceEditor = project.projectConfig['CompTypes'][self.Ctype]['sourceEditor']
self.macPackId = project.projectConfig['CompTypes'][self.Ctype]['macroPackage']
# Get the comp settings
self.compSettings = project.projectConfig['CompTypes'][self.Ctype]
# Build a tuple of managers this component type needs to use
self.usfmManagers = ('text', self.renderer)
# Init the general managers
for self.mType in self.usfmManagers :
self.project.createManager(self.mType)
# Create the internal ref names we use in this module
self.text = self.project.managers[self.cType + '_Text']
# File names
# Folder paths
self.projScriptFolder = self.local.projScriptFolder
self.projComponentFolder = self.local.projComponentFolder
self.gidFolder = os.path.join(self.projComponentFolder, self.gid)
# File names with folder paths
self.rapumaXmlCompConfig = os.path.join(self.project.local.rapumaConfigFolder, self.xmlConfFile)
# Get persistant values from the config if there are any
newSectionSettings = self.tools.getPersistantSettings(self.projectConfig['CompTypes'][self.Ctype], self.rapumaXmlCompConfig)
if newSectionSettings != self.projectConfig['CompTypes'][self.Ctype] :
self.projectConfig['CompTypes'][self.Ctype] = newSectionSettings
# Set them here
for k, v in self.compSettings.iteritems() :
setattr(self, k, v)
# Module Error Codes
self.errorCodes = {
#'USFM-000' : ['MSG', 'Messages for the USFM module.'],
#'USFM-005' : ['MSG', 'Unassigned error message ID.'],
#'USFM-010' : ['ERR', 'Could not process character pair. This error was found: [<<1>>]. Process could not complete. - usfm.pt_tools.getNWFChars()'],
#'USFM-020' : ['ERR', 'Improper character pair found: [<<1>>]. Process could not complete. - usfm.pt_tools.getNWFChars()'],
#'USFM-025' : ['WRN', 'No non-word-forming characters were found in the PT settings file. - usfm.pt_tools.getNWFChars()'],
#'USFM-040' : ['ERR', 'Hyphenation source file not found: [<<1>>]. Process halted!'],
#'USFM-080' : ['LOG', 'Normalizing Unicode text to the [<<1>>] form.'],
#'USFM-090' : ['ERR', 'USFM file: [<<1>>] did NOT pass the validation test. Because of an encoding conversion, the terminal output is from the file [<<2>>]. Please only edit [<<1>>].'],
#'USFM-095' : ['WRN', 'Validation for USFM file: [<<1>>] was turned off.'],
#'USFM-100' : ['MSG', 'Source file editor [<<1>>] is not recognized by this system. Please double check the name used for the source text editor setting.'],
#'USFM-110' : ['ERR', 'Source file name could not be built because the Name Form ID for [<<1>>] is missing or incorrect. Double check to see which editor created the source text.'],
#'USFM-120' : ['ERR', 'Source file: [<<1>>] not found! Cannot copy to project. Process halting now.'],
#'USFM-130' : ['ERR', 'Failed to complete preprocessing on component [<<1>>]'],
#'USFM-140' : ['MSG', 'Completed installation on [<<1>>] component working text.'],
#'USFM-150' : ['ERR', 'Unable to copy [<<1>>] to [<<2>>] - error in text.'],
'0010' : ['LOG', 'Created the [<<1>>] master adjustment file.'],
'0220' : ['ERR', 'Cannot find: [<<1>>] working file, unable to complete preprocessing for rendering.'],
'0230' : ['LOG', 'Created the [<<1>>] component adjustment file.'],
'0240' : ['LOG', 'Could not find adjustments section for [<<1>>], created place holder setting.'],
'0245' : ['LOG', 'Could not find adjustments for [<<1>>]. No ajustment file has been output.'],
'0255' : ['LOG', 'Illustrations not being used. The piclist file has been removed from the [<<1>>] illustrations folder.'],
'0260' : ['LOG', 'Piclist file for [<<1>>] has been created.'],
'0265' : ['ERR', 'Failed to create piclist file for [<<1>>]!'],
'0300' : ['ERR', 'One or more illustration files are missing from the project. Please import these files before continuing.']
}
###############################################################################
############################ Functions Begin Here #############################
###############################################################################
######################## Error Code Block Series = 0200 #######################
###############################################################################
def makeFileName(self, cid) :
'''From what we know, return the full file name.'''
# FIXME: We default this to "base" but for a diglot implementation
# this is not going to work because we need to have a second
# file name. Cross that bridge...
return cid + '_base'
def makeFileNameWithExt(self, cid) :
'''From what we know, return the full file name.'''
return self.makeFileName(cid) + '.' + self.cType
def getCidPath (self, cid) :
'''Return the full path of the cName working text file. This assumes
the cid is valid.'''
return os.path.join(self.local.projComponentFolder, cid, self.makeFileNameWithExt(cid))
def getCidAdjPath (self, cid) :
'''Return the full path of the cName working text adjustments file.
This assumes the cName is valid. Note that all macro packages that have
a manual adjustment feature must use this naming scheme. The name syntax
comes from the "mother" macro package which is ptx2pdf.'''
return os.path.join(self.local.projComponentFolder, cid, self.makeFileNameWithExt(cid) + '.adj')
def render(self, gid, cidList, pages, override, save) :
'''Does USFM specific rendering of a USFM component'''
# import pdb; pdb.set_trace()
# If the whole group is being rendered, we need to preprocess it
cids = []
if not cidList :
cids = self.projectConfig['Groups'][gid]['cidList']
else :
cids = cidList
# Preprocess all subcomponents (one or more)
# Stop if it breaks at any point
for cid in cids :
if not self.preProcessGroup(gid, [cid]) :
return False
# With everything in place we can render the component.
# Note: We pass the cidList straight through
self.project.managers['usfm_' + self.renderer.capitalize()].run(gid, cidList, pages, override, save)
return True
def preProcessGroup (self, gid, cidList) :
'''This will prepare a component group for rendering by checking for
and/or creating any dependents it needs to render properly.'''
# import pdb; pdb.set_trace()
# Get some relevant settings
# FIXME: Note page border has not really been implemented yet.
# It is different from backgound management
useIllustrations = self.tools.str2bool(self.projectConfig['Groups'][gid]['useIllustrations'])
useManualAdjustments = self.tools.str2bool(self.projectConfig['Groups'][gid]['useManualAdjustments'])
# See if the working text is present for each subcomponent in the
# component and try to install it if it is not
for cid in cidList :
cType = self.cfg['cType']
cidUsfm = self.getCidPath(cid)
# Test for source here and die if it isn't there
if not os.path.isfile(cidUsfm) :
self.log.writeToLog(self.errorCodes['0220'], [cidUsfm], 'usfm.preProcessGroup():0220')
# Add/manage the dependent files for this cid
# FIXME: Some changes may be needed here to guide creation of adjustment files
# Component adjustment file
cidAdjFile = self.getCidAdjPath(cid)
if useManualAdjustments :
self.createCompAdjustmentFile(cid)
else :
# If no adjustments, remove any exsiting file
if os.path.isfile(cidAdjFile) :
os.remove(cidAdjFile)
# Component piclist file
cidPiclistFile = self.proj_illustration.getCidPiclistFile(cid)
if useIllustrations :
if self.proj_illustration.hasIllustrations(cid) :
# Check for missing illustrations (die here if not found)
if self.proj_illustration.missingIllustrations(cid) :
self.log.writeToLog(self.errorCodes['0300'])
# Create piclist file if not there or if the config has changed
if not os.path.isfile(cidPiclistFile) or self.tools.isOlder(cidPiclistFile, self.local.illustrationConfFile) :
# Now make a fresh version of the piclist file
if self.proj_illustration.createPiclistFile(cid) :
self.log.writeToLog(self.errorCodes['0260'], [cid])
else :
self.log.writeToLog(self.errorCodes['0265'], [cid])
else :
for f in [self.local.layoutConfFile, self.local.illustrationConfFile] :
if self.tools.isOlder(cidPiclistFile, f) or not os.path.isfile(cidPiclistFile) :
# Remake the piclist file
if self.proj_illustration.createPiclistFile(cid) :
self.log.writeToLog(self.errorCodes['0260'], [cid])
else :
self.log.writeToLog(self.errorCodes['0265'], [cid])
else :
# Does not seem to be any illustrations for this cid
# clean out any piclist file that might be there
if os.path.isfile(cidPiclistFile) :
os.remove(cidPiclistFile)
else :
# If we are not using illustrations then any existing piclist file will be removed
if os.path.isfile(cidPiclistFile) :
os.remove(cidPiclistFile)
self.log.writeToLog(self.errorCodes['0255'], [cid])
# Any more stuff to run?
return True
# FIXME: Moved this to xetex.py as that was the only place it was called from
#def checkStartPageNumber (self) :
#'''Adjust page number for the current group. The current logic is
#if there is no number in the startPageNumber setting, we can put
#one in there as a suggestion. If there is already one there, the
#user will be responsible for seeing that it is correct.'''
## import pdb; pdb.set_trace()
#try :
## Simply try to return anything that is in the field
#cStrPgNo = self.projectConfig['Groups'][self.gid]['startPageNumber']
#if cStrPgNo != '' :
#return cStrPgNo
#except :
## If nothing is there, we'll make a suggestion
#pGrp = str(self.projectConfig['Groups'][self.gid]['precedingGroup'])
#if pGrp == 'None' :
#self.projectConfig['Groups'][self.gid]['startPageNumber'] = 1
#self.tools.writeConfFile(self.projectConfig)
#return '1'
#else :
## Calculate the suggested number based on the preceeding group
#try :
#cStrPgNo = str(self.projectConfig['Groups'][self.gid]['startPageNumber'])
#except :
#cStrPgNo = 1
#self.projectConfig['Groups'][self.gid]['startPageNumber'] = 1
#try :
#pGrpPgs = int(self.projectConfig['Groups'][pGrp]['totalPages'])
#pGrpStrPgNo = int(self.projectConfig['Groups'][pGrp]['startPageNumber'])
#except :
## FIXME: Maybe this could go out and find out exactly how many pages were in the preceeding group
#pGrpPgs = 1
#pGrpStrPgNo = 1
#self.projectConfig['Groups'][pGrp]['totalPages'] = 1
#self.projectConfig['Groups'][pGrp]['startPageNumber'] = 1
## Whether this is right or wrong set it the way it is
#self.projectConfig['Groups'][self.gid]['startPageNumber'] = (pGrpStrPgNo + pGrpPgs)
#self.tools.writeConfFile(self.projectConfig)
#return self.projectConfig['Groups'][pGrp]['startPageNumber']
def createCompAdjustmentFile (self, cid) :
'''Create an adjustment file for this cid. If entries exsist in
the adjustment.conf file.'''
description = 'Auto-generated text adjustments file for: ' + cid + '\n'
# import pdb; pdb.set_trace()
# Check for a master adj conf file
if os.path.exists(self.local.adjustmentConfFile) :
adjFile = self.getCidAdjPath(cid)
# Clean up old file if there is one so we can start fresh
if os.path.exists(adjFile) :
os.remove(adjFile)
# Nothing to do if no gid section is found
if not self.adjustmentConfig.has_key(self.gid) :
self.tools.buildConfSection(self.adjustmentConfig, self.gid)
if not self.adjustmentConfig[self.gid].has_key(cid) :
self.tools.buildConfSection(self.adjustmentConfig[self.gid], cid)
self.adjustmentConfig[self.gid][cid]['%1.1'] = '1'
self.tools.writeConfFile(self.adjustmentConfig)
self.log.writeToLog(self.errorCodes['0240'], [cid])
return False
# Sort through commented adjustment lines ()
if self.adjustmentConfig[self.gid].has_key(cid) :
c = False
for k in self.adjustmentConfig[self.gid][cid].keys() :
if not re.search(r'%|#', k) :
c = True
if not c :
self.log.writeToLog(self.errorCodes['0245'], [cid])
return False
# If we make it this far, create the new adjustment file
with codecs.open(adjFile, "w", encoding='utf_8') as writeObject :
writeObject.write(self.tools.makeFileHeader(adjFile, description, True))
# Output like this: JAS 1.13 +1
for k, v in self.adjustmentConfig[self.gid][cid].iteritems() :
if re.search(r'%|#', k) :
continue
adj = v
if int(v) > 0 :
adj = '+' + str(v)
writeObject.write(cid.upper() + ' ' + k + ' ' + adj + '\n')
self.log.writeToLog(self.errorCodes['0230'], [self.tools.fName(adjFile)])
return True
def createProjAdjustmentConfFile (self) :
'''Create a project master component adjustment file that group component
ajustment files will be created automatically from. This will run every
time preprocess is run but after the first time it will only add a sections
for new groups or components.'''
if not os.path.exists(self.adjustmentConfFile) :
self.adjustmentConfig = ConfigObj(self.adjustmentConfFile, encoding='utf-8')
self.adjustmentConfig.filename = self.adjustmentConfFile
self.updateCompAdjustmentConf()
return True
def updateCompAdjustmentConf (self) :
'''Update an adjustmentConfig based on changes in the projectConfig.'''
for gid in self.projectConfig['Groups'].keys() :
if gid not in self.adjustmentConfig.keys() :
self.tools.buildConfSection(self.adjustmentConfig, gid)
for comp in self.projectConfig['Groups'][gid]['cidList'] :
if not self.adjustmentConfig[gid].has_key(comp) :
self.tools.buildConfSection(self.adjustmentConfig[gid], comp)
self.adjustmentConfig[gid][comp]['%1.1'] = '1'
self.tools.writeConfFile(self.adjustmentConfig)
return True
###############################################################################
######################## USFM Component Text Functions ########################
###############################################################################
######################## Error Code Block Series = 0400 #######################
###############################################################################
def getComponentType (self, gid) :
'''Return the cType for a component.'''
# import pdb; pdb.set_trace()
try :
cType = self.projectConfig['Groups'][gid]['cType']
except Exception as e :
# If we don't succeed, we should probably quite here
self.log.writeToLog('COMP-200', ['Key not found ' + str(e)])
self.tools.dieNow()
return cType
def isCompleteComponent (self, gid, cid) :
'''A two-part test to see if a component has a config entry and a file.'''
if self.hasCidFile(gid, cid) :
return True
def hasUsfmCidInfo (self, cid) :
'''Return True if this cid is in the PT USFM cid info dictionary.'''
if cid in self.usfmCidInfo().keys() :
return True
def hasCidFile (self, gid, cid) :
'''Return True or False depending on if a working file exists
for a given cName.'''
cType = self.projectConfig['Groups'][gid]['cType']
return os.path.isfile(os.path.join(self.local.projComponentFolder, cid, cid + '.' + cType))
def usfmCidInfo (self) :
'''Return a dictionary of all valid information about USFMs used in PT. Note
that a couple special non-standard IDs have been added at the top of the list.'''
# ID Comp Name Comp ID PT ID Chps
return {
'_z_' : ['USFM InternalCaller', 'usfm_internal_caller', '00', 0],
'gen' : ['Genesis', 'genesis', '01', 50],
'exo' : ['Exodus', 'exodus', '02', 40],
'lev' : ['Leviticus', 'leviticus', '03', 27],
'num' : ['Numbers', 'numbers', '04', 36],
'deu' : ['Deuteronomy', 'deuteronomy', '05', 34],
'jos' : ['Joshua', 'joshua', '06', 24],
'jdg' : ['Judges', 'judges', '07', 21],
'rut' : ['Ruth', 'ruth', '08', 4],
'1sa' : ['1 Samuel', '1_samuel', '09', 31],
'2sa' : ['2 Samuel', '2_samuel', '10', 24],
'1ki' : ['1 Kings', '1_kings', '11', 22],
'2ki' : ['2 Kings', '2_kings', '12', 25],
'1ch' : ['1 Chronicles', '1_chronicles', '13', 29],
'2ch' : ['2 Chronicles', '2_chronicles', '14', 36],
'ezr' : ['Ezra', 'ezra', '15', 10],
'neh' : ['Nehemiah', 'nehemiah', '16', 13],
'est' : ['Esther', 'esther', '17', 10],
'job' : ['Job', 'job', '18', 42],
'psa' : ['Psalms', 'psalms', '19', 150],
'pro' : ['Proverbs', 'proverbs', '20', 31],
'ecc' : ['Ecclesiastes', 'ecclesiastes', '21', 12],
'sng' : ['Song of Songs', 'song_of_songs', '22', 8],
'isa' : ['Isaiah', 'isaiah', '23', 66],
'jer' : ['Jeremiah', 'jeremiah', '24', 52],
'lam' : ['Lamentations', 'lamentations', '25', 5],
'ezk' : ['Ezekiel', 'ezekiel', '26', 48],
'dan' : ['Daniel', 'daniel', '27', 12],
'hos' : ['Hosea', 'hosea', '28', 14],
'jol' : ['Joel', 'joel', '29', 3],
'amo' : ['Amos', 'amos', '30', 9],
'oba' : ['Obadiah', 'obadiah', '31', 1],
'jon' : ['Jonah', 'jonah', '32', 4],
'mic' : ['Micah', 'micah', '33', 7],
'nam' : ['Nahum', 'nahum', '34', 3],
'hab' : ['Habakkuk', 'habakkuk', '35', 3],
'zep' : ['Zephaniah', 'zephaniah', '36', 3],
'hag' : ['Haggai', 'haggai', '37', 2],
'zec' : ['Zechariah', 'zechariah', '38', 14],
'mal' : ['Malachi', 'malachi', '39', 4],
'mat' : ['Matthew', 'matthew', '41', 28],
'mrk' : ['Mark', 'mark', '42', 16],
'luk' : ['Luke', 'luke', '43', 24],
'jhn' : ['John', 'john', '44', 21],
'act' : ['Acts', 'acts', '45', 28],
'rom' : ['Romans', 'romans', '46', 16],
'1co' : ['1 Corinthians', '1_corinthians', '47', 16],
'2co' : ['2 Corinthians', '2_corinthians', '48', 13],
'gal' : ['Galatians', 'galatians', '49', 6],
'eph' : ['Ephesians', 'ephesians', '50', 6],
'php' : ['Philippians', 'philippians', '51', 4],
'col' : ['Colossians', 'colossians', '52', 4],
'1th' : ['1 Thessalonians', '1_thessalonians', '53', 5],
'2th' : ['2 Thessalonians', '2_thessalonians', '54', 3],
'1ti' : ['1 Timothy', '1_timothy', '55', 6],
'2ti' : ['2 Timothy', '2_timothy', '56', 4],
'tit' : ['Titus', 'titus', '57', 3],
'phm' : ['Philemon', 'philemon', '58', 1],
'heb' : ['Hebrews', 'hebrews', '59', 13],
'jas' : ['James', 'james', '60', 5],
'1pe' : ['1 Peter', '1_peter', '61', 5],
'2pe' : ['2 Peter', '2_peter', '62', 3],
'1jn' : ['1 John', '1_john', '63', 5],
'2jn' : ['2 John', '2_john', '64', 1],
'3jn' : ['3 John', '3_john', '65', 1],
'jud' : ['Jude', 'jude', '66', 1],
'rev' : ['Revelation', 'revelation', '67', 22],
'tob' : ['Tobit', 'tobit', '68', '?'],
'jdt' : ['Judith', 'judith', '69', '?'],
'esg' : ['Esther', 'esther', '70', '?'],
'wis' : ['Wisdom of Solomon', 'wisdom_of_solomon', '71', '?'],
'sir' : ['Sirach', 'sirach', '72', '?'],
'bar' : ['Baruch', 'baruch', '73', '?'],
'lje' : ['Letter of Jeremiah', 'letter_of_jeremiah', '74', '?'],
's3y' : ['Song of the Three Children', 'song_3_children', '75', '?'],
'sus' : ['Susanna', 'susanna', '76', '?'],
'bel' : ['Bel and the Dragon', 'bel_dragon', '77', '?'],
'1ma' : ['1 Maccabees', '1_maccabees', '78', '?'],
'2ma' : ['2 Maccabees', '2_maccabees', '79', '?'],
'3ma' : ['3 Maccabees', '3_maccabees', '80', '?'],
'4ma' : ['4 Maccabees', '4_maccabees', '81', '?'],
'1es' : ['1 Esdras', '1_esdras', '82', '?'],
'2es' : ['2 Esdras', '2_esdras', '83', '?'],
'man' : ['Prayer of Manasses', 'prayer_of_manasses', '84', '?'],
'ps2' : ['Psalms 151', 'psalms_151', '85', '?'],
'oda' : ['Odae', 'odae', '86', '?'],
'pss' : ['Psalms of Solomon', 'psalms_of_solomon', '87', '?'],
'jsa' : ['Joshua A', 'joshua_a', '88', '?'],
'jdb' : ['Joshua B', 'joshua_b', '89', '?'],
'tbs' : ['Tobit S', 'tobit_s', '90', '?'],
'sst' : ['Susannah (Theodotion)', 'susannah_t', '91', '?'],
'dnt' : ['Daniel (Theodotion)', 'daniel_t', '92', '?'],
'blt' : ['Bel and the Dragon (Theodotion)', 'bel_dragon_t', '93', '?'],
'frt' : ['Front Matter', 'front_matter', 'A0', 0],
'int' : ['Introductions', 'introductions', 'A7', 0],
'bak' : ['Back Matter', 'back_matter', 'A1', 0],
'cnc' : ['Concordance', 'concordance', 'A8', 0],
'glo' : ['Glossary', 'glossary', 'A9', 0],
'tdx' : ['Topical Index', 'topical_index', 'B0', 0],
'ndx' : ['Names Index', 'names_index', 'B1', 0],
'xxa' : ['Extra A', 'extra_a', '94', 0],
'xxb' : ['Extra B', 'extra_b', '95', 0],
'xxc' : ['Extra C', 'extra_c', '96', 0],
'xxd' : ['Extra D', 'extra_d', '97', 0],
'xxe' : ['Extra E', 'extra_e', '98', 0],
'xxf' : ['Extra F', 'extra_f', '99', 0],
'xxg' : ['Extra G', 'extra_g', '100', 0],
'oth' : ['Other', 'other', 'A2', 0],
'eza' : ['Apocalypse of Ezra', 'apocalypse_of_ezra', 'A4', '?'],
'5ez' : ['5 Ezra', '5_ezra_lp', 'A5', '?'],
'6ez' : ['6 Ezra (Latin Epilogue)', '6_ezra_lp', 'A6', '?'],
'dag' : ['Daniel Greek', 'daniel_greek', 'B2', '?'],
'ps3' : ['Psalms 152-155', 'psalms_152-155', 'B3', '?'],
'2ba' : ['2 Baruch (Apocalypse)', '2_baruch_apocalypse', 'B4', '?'],
'lba' : ['Letter of Baruch', 'letter_of_baruch', 'B5', '?'],
'jub' : ['Jubilees', 'jubilees', 'B6', '?'],
'eno' : ['Enoch', 'enoch', 'B7', '?'],
'1mq' : ['1 Meqabyan', '1_meqabyan', 'B8', '?'],
'2mq' : ['2 Meqabyan', '2_meqabyan', 'B9', '?'],
'3mq' : ['3 Meqabyan', '3_meqabyan', 'C0', '?'],
'rep' : ['Reproof (Proverbs 25-31)', 'reproof_proverbs_25-31', 'C1', '?'],
'4ba' : ['4 Baruch (Rest of Baruch)', '4_baruch', 'C2', '?'],
'lao' : ['Laodiceans', 'laodiceans', 'C3', '?']
}
class UsfmTex (object) :
def __init__(self, layoutConfig) :
'''Do the primary initialization for this class.'''
self.tools = Tools()
self.layoutConfig = layoutConfig
# Log messages for this module
self.errorCodes = {
'0000' : ['MSG', 'Placeholder message'],
}
###############################################################################
############################ Macro Level Functions ############################
###############################################################################
####################### Error Code Block Series = 1000 ########################
###############################################################################
def getTitleColumns (self) :
'''Return 2 if titleColumnsTwo is True.'''
if self.tools.str2bool(self.layoutConfig['PageLayout']['titleColumnsTwo']) :
return 2
else :
return 1
def getIntroColumns (self) :
'''Return 2 if introColumnsTwo is True.'''
if self.tools.str2bool(self.layoutConfig['PageLayout']['introColumnsTwo']) :
return 2
else :
return 1
def getBodyColumns (self) :
'''Return 2 if bodyColumnsTwo is True.'''
if self.tools.str2bool(self.layoutConfig['PageLayout']['bodyColumnsTwo']) :
return 2
else :
return 1
def getHeaderPosition (self) :
'''Return the calculated relative position of the header based
on the top margin setting.'''
tm = float(self.layoutConfig['PageLayout']['topMargin'])
hp = float(self.layoutConfig['PageLayout']['headerPosition'])
return float("{0:.2f}".format(round(hp / tm, 2)))
def getFooterPosition (self) :
'''Return the calculated relative position of the footer based
on the bottom margin setting.'''
bm = float(self.layoutConfig['PageLayout']['bottomMargin'])
hp = float(self.layoutConfig['PageLayout']['footerPosition'])
return float("{0:.2f}".format(round(hp / bm, 2)))
def getMarginUnit (self) :
'''Calculate the basic margin unit for the macro package. This will be
based on the largest amount set for the top, bottom and side margins.'''
tm = float(self.layoutConfig['PageLayout']['topMargin'])
bm = float(self.layoutConfig['PageLayout']['bottomMargin'])
im = float(self.layoutConfig['PageLayout']['insideMargin'])
om = float(self.layoutConfig['PageLayout']['outsideMargin'])
# Adjust for binding gutter setting (extra insideMargin)
if self.getBindingGutterWidth() :
im = im - self.getBindingGutterWidth()
return max(float(u) for u in [tm, bm, im, om])
def getTopMarginFactor (self) :
'''Calculate the top margin factor based on what the base margin
and top margin settings are.'''
marginUnit = self.getMarginUnit()
topMargin = float(self.layoutConfig['PageLayout']['topMargin'])
return float("{0:.2f}".format(round(topMargin / marginUnit, 2)))
def getBottomMarginFactor (self) :
'''Calculate the bottom margin factor based on what the base margin
and bottom margin settings are.'''
marginUnit = self.getMarginUnit()
bottomMargin = float(self.layoutConfig['PageLayout']['bottomMargin'])
return float("{0:.2f}".format(round(bottomMargin / marginUnit, 2)))
def getSideMarginFactor (self) :
'''Calculate the side margin factor based on what the base margin
and outside margin settings are.'''
# For this we will be using the outsideMargin setting not the inside
marginUnit = self.getMarginUnit()
outsideMargin = float(self.layoutConfig['PageLayout']['outsideMargin'])
insideMargin = float(self.layoutConfig['PageLayout']['insideMargin'])
self.tools.writeConfFile(self.layoutConfig)
return float("{0:.2f}".format(round(outsideMargin / marginUnit, 2)))
def getBindingGutterWidth (self) :
'''Calculate the binding gutter width based on any extra space added
to the inside margin which exceeds the outside margin.'''
insideMargin = float(self.layoutConfig['PageLayout']['insideMargin'])
outsideMargin = float(self.layoutConfig['PageLayout']['outsideMargin'])
results = insideMargin - outsideMargin
# If nothing, just 0, rather than a float (0.0) so binding gutter
# can be turned off automatically
if int(results) == 0 :
return 0
else :
return results
def getFontSizeUnit (self) :
'''Calculate the font size unit. This counts on the style marker for "p"
being set to 12pt. If for some reason it is not, then this will fail.
This will divide the body font size by 12 to get the size unit.'''
fontDefaultSize = float(self.layoutConfig['TextElements']['fontDefaultSize'])
bodyFontSize = float(self.layoutConfig['TextElements']['bodyFontSize'])
return float("{0:.3f}".format(round(bodyFontSize / fontDefaultSize, 3)))
def getLineSpacingFactor (self) :
'''Calculate the line spacing factor. This is based on the body text leading.
It will divide the body text leading by (leading default size * font size unit)
to get the factor unit. [lsf = btl / (ld x fsu)]'''
fontSizeUnit = self.getFontSizeUnit()
bodyTextLeading = float(self.layoutConfig['TextElements']['bodyTextLeading'])
leadingDefaultSize = float(self.layoutConfig['TextElements']['leadingDefaultSize'])
return float("{0:.3f}".format(round(bodyTextLeading / (leadingDefaultSize * fontSizeUnit), 3)))
class Macro (object) :
def __init__(self, pid, cType, gid=None) :
'''Do the primary initialization for this class.'''
self.pid = pid
self.gid = gid
self.cType = cType
self.user = UserConfig()
self.userConfig = self.user.userConfig
self.projHome = os.path.join(os.path.expanduser(os.environ['RAPUMA_PROJECTS']), self.pid)
self.local = ProjLocal(pid, gid, cType)
# import pdb; pdb.set_trace()
self.proj_config = Config(pid)
self.proj_config.getProjectConfig()
self.projectConfig = self.proj_config.projectConfig
self.layoutConfig = self.proj_config.layoutConfig
self.tools = Tools()
self.log = ProjLog(pid)
# Create config placeholders
self.layoutConfig = None
self.illustrationConfig = None
self.macroConfig = self.tools.loadConfig(self.local.macroConfFile, self.local.macroConfXmlFile)
# Log messages for this module
self.errorCodes = {
'3010' : ['ERR', 'No macro package is registered for the [<<1>>] component type.'],
'3020' : ['ERR', 'Cannot update! No macro package is registered for the [<<1>>] component type.'],
'3050' : ['ERR', 'Macro package file not found: [<<1>>]'],
'3100' : ['ERR', 'Macro package: [<<1>>] already exists in the project. I am not allowed to copy over an existing package.'],
'3200' : ['ERR', 'Failed to install macro package: [<<1>>]'],
'3300' : ['MSG', 'Installed macro package: [<<1>>], Reinitialized [<<2>>]'],
'3310' : ['ERR', 'Failed to copy [<<1>>] to folder [<<2>>].'],
'3400' : ['MSG', 'Removed macro package configuration settings for: [<<1>>] from the macro.conf file.'],
'3500' : ['MSG', 'Removed macro package [<<1>>] folder and all files contained.'],
'3600' : ['MSG', 'Updated component type [<<1>>] with macro package [<<2>>]'],
'3650' : ['ERR', 'Failed to updated macro package [<<1>>]']
}
###############################################################################
###################### Macro Package Handling Functions #######################
###############################################################################
######################## Error Code Block Series = 3000 #######################
###############################################################################
def createMacroFiles (self, macPackId) :
'''Create all the necessary macro file names with their assigned paths.'''
self.projMacPackFolder = os.path.join(self.local.projMacPackFolder, macPackId)
texFileIds = {'preStyTexExtFile':'preSty-ext.tex', 'macSettingsFile':'settings.tex',
'extTexFile':'extension.tex', 'grpExtTexFile': self.gid + '-extension.tex',
'':'', '':'', '':'', '':'', '':'', }
styFileIds = {'glbExtStyFile':'extension.sty', 'grpExtStyFile': self.gid + '-extension.sty',
'':'', '':'', '':'', '':'', '':''}
def getMacPackIdFromFileName (self, fileName) :
'''Return the macPack ID based on the file name'''
# File name less ext is the ID
parts = len(fileName.split('.'))
return '.'.join(fileName.split('.')[:parts-1])
def getMacPackIdFromSource (self, source) :
'''Return the macPack ID based on the complete path and file name.'''
# Get the file name from the path
fileName = self.tools.fName(source)
# Return the ID
return self.getMacPackIdFromFileName(fileName)
def addMacPack (self, source) :
'''Add a macro package to the project. It will not work if
the same package is already present. Remove must be used
to get rid of the existing one first.'''
# import pdb; pdb.set_trace()
macPackId = self.getMacPackIdFromSource(source)
confXml = os.path.join(self.local.projMacroFolder, macPackId, macPackId + '.xml')
if not os.path.isfile(source) :
self.log.writeToLog(self.errorCodes['3050'], [source])
# Do not add/install if there seems to be a macro package there already
if self.projectConfig['CompTypes'][self.cType.capitalize()]['macroPackage'] and os.path.exists(self.local.macroConfFile) :
self.log.writeToLog(self.errorCodes['3100'], [macPackId])
return False
# Set the projectConf to the new/same package
self.projectConfig['CompTypes'][self.cType.capitalize()]['macroPackage'] = macPackId
self.tools.writeConfFile(self.projectConfig)
# If we got this far, install the a fresh copy of the macPack
self.installMacPackOnly(source)
# Move the style files and custom TeX files out of the macPack
self.moveMacStyles(macPackId)
self.moveMacTex(macPackId)
# Create a fresh macro.conf file if it dosn't exist
if not os.path.isfile(self.local.macroConfFile) :
self.macroConfig = self.tools.initNewConfig(self.local.macroConfFile, self.local.macroConfXmlFile)
# Inject information from this particular macro package
mInfo = self.tools.getXMLSettings(confXml)
self.macroConfig['Macros'][macPackId] = mInfo.dict()
# Save the settings now
self.tools.writeConfFile(self.macroConfig)
self.log.writeToLog(self.errorCodes['3300'], [macPackId, self.local.macroConfFileName])
return True
def moveMacStyles (self, macPackId) :
'''Move the default macro package styles out of the freshly installed
project macro package folder to the project Style folder.'''
# import pdb; pdb.set_trace()
# Collect the style files to copy
for f in self.getMacStyExtFiles(macPackId) :
source = os.path.join(os.path.join(self.local.projMacroFolder, macPackId, f))
target = os.path.join(self.local.projStyleFolder, f)
self.tools.makedirs(self.local.projStyleFolder)
# Do not overwrite existing files unless force is used
if not os.path.exists(target) :
shutil.copy(source, target)
# Look for default and set to read-only
defaultStyFile = os.path.join(self.local.projStyleFolder, macPackId + '.sty')
if target == defaultStyFile :
self.tools.makeReadOnly(defaultStyFile)
# Remove the source to avoid confusion
if os.path.exists(target) :
os.remove(source)
else :
self.log.writeToLog(self.errorCodes['3310'], [source,self.local.projStyleFolder])
def getMacStyExtFiles (self, macPackId) :
'''Return a list of macro package style extention files.'''
sFiles = []
macPackFiles = os.listdir(os.path.join(self.local.projMacroFolder, macPackId))
for f in macPackFiles :
if f.split('.')[1].lower() == 'sty' :
sFiles.append(f)
return sFiles
def moveMacTex (self, macPackId) :
'''Move the custom macro package TeX out of the freshly installed
project macro package folder to the project TeX folder.'''
# Collect the TeX extention files to copy
for f in self.getMacTexExtFiles(macPackId) :
source = os.path.join(os.path.join(self.local.projMacroFolder, macPackId, f))
target = os.path.join(self.local.projTexFolder, f)
self.tools.makedirs(self.local.projTexFolder)
# Do not overwrite existing files
if not os.path.exists(target) :
shutil.copy(source, target)
# Remove the source to avoid confusion
if os.path.exists(target) :
os.remove(source)
else :
self.log.writeToLog(self.errorCodes['3310'], [source,self.local.projTexFolder])
def getMacTexExtFiles (self, macPackId) :
'''Return a list of macro package TeX extention files.'''
tFiles = []
macPackFiles = os.listdir(os.path.join(self.local.projMacroFolder, macPackId))
for f in macPackFiles :
if f.find('ext.tex') > 0 :
tFiles.append(f)
return tFiles
def removeMacPack (self) :
'''Remove the macro package from a component type'''
# import pdb; pdb.set_trace()
if self.projectConfig['CompTypes'][self.cType.capitalize()]['macroPackage'] != '' :
macPackId = self.projectConfig['CompTypes'][self.cType.capitalize()]['macroPackage']
else :
self.log.writeToLog(self.errorCodes['3010'], [self.cType])
# Aquire target to delete
target = os.path.join(self.local.projMacroFolder, macPackId)
# Remove the macPack settings from the config file if it is there
try :
del self.macroConfig['Macros'][macPackId]
# Save the settings now
self.tools.writeConfFile(self.macroConfig)
self.log.writeToLog(self.errorCodes['3400'], [macPackId])
except :
pass
# Now remove the macro folder (with all its contents)
if os.path.exists(target) :
shutil.rmtree(target)
self.log.writeToLog(self.errorCodes['3500'], [macPackId])
# Remove any style files associated with the macro
styTarget = os.path.join(self.local.projStyleFolder, macPackId + '.sty')
self.tools.makeExecutable(styTarget)
self.tools.removeFile(styTarget)
# Remove the reference for this macro package from the component type
# that uses it. Normally that would probably be just be one of them.
self.projectConfig['CompTypes'][self.cType.capitalize()]['macroPackage'] = ''
self.tools.writeConfFile(self.projectConfig)
def updateMacPack (self, source) :
'''Update a macro package with the latest version but do not
touch the config file.'''
# Do not update if no macro package is registered in the projectConfig
if not self.projectConfig['CompTypes'][self.cType.capitalize()]['macroPackage'] :
self.log.writeToLog(self.errorCodes['3020'], [self.cType.capitalize()])
return False
macPackId = self.getMacPackIdFromSource(source)
confXml = os.path.join(self.local.projMacroFolder, macPackId, macPackId + '.xml')
oldMacPackId = self.projectConfig['CompTypes'][self.cType.capitalize()]['macroPackage']
oldMacDir = os.path.join(self.local.projMacroFolder, oldMacPackId)
newMacDir = os.path.join(self.local.projMacroFolder, macPackId)
# Install the new macPack (but use the old settings)
if self.installMacPackOnly(source) :
# The current macro system must have a "master" style file.
# This is a version of the ParaText style file. Because
# an update might include an update to the style file,
# we need to copy that from the macro folder to the Style
# folder. We will do that now. The name of the file should
# be the macPackId + ".sty", in theory.
srcStyleFile = os.path.join(self.local.projMacroFolder, macPackId, macPackId + '.sty')
oldStyleFile = os.path.join(self.local.projStyleFolder, oldMacPackId + '.sty')
newStyleFile = os.path.join(self.local.projStyleFolder, macPackId + '.sty')
# Unlock the old one so it can be deleted.
self.tools.makeExecutable(oldStyleFile)
self.tools.removeFile(oldStyleFile)
# Now copy in the new one.
shutil.copy(srcStyleFile, newStyleFile)
# The style file should never be edited by the user, relock it
self.tools.makeReadOnly(newStyleFile)
# Update exsisting extention file names. We never want to loose
# any settings that the user may have added to the extention
# files so we will rename the existing files to have the
# new ID otherwise the system will not find them at render time.
oldStyExtFile = os.path.join(self.local.projStyleFolder, oldMacPackId + '_ext.sty')
oldTexExtFile = os.path.join(self.local.projTexFolder, oldMacPackId + '_ext.tex')
oldTexPreStyExtFile = os.path.join(self.local.projTexFolder, oldMacPackId + '_preSty-ext.tex')
newStyExtFile = os.path.join(self.local.projStyleFolder, macPackId + '_ext.sty')
newTexExtFile = os.path.join(self.local.projTexFolder, macPackId + '_ext.tex')
newTexPreStyExtFile = os.path.join(self.local.projTexFolder, macPackId + '_preSty-ext.tex')
# By default, we protect any existing versions
if os.path.exists(newStyExtFile) :
os.remove(oldStyExtFile)
else :
self.tools.renameFile(oldStyExtFile, newStyExtFile)
if os.path.exists(newTexExtFile) :
os.remove(oldTexExtFile)
else :
self.tools.renameFile(oldTexExtFile, newTexExtFile)
if os.path.exists(newTexPreStyExtFile) :
os.remove(oldTexPreStyExtFile)
else :
self.tools.renameFile(oldTexPreStyExtFile, newTexPreStyExtFile)
# Remove un-needed sty and tex files from the newMacDir to
# avoid confusion. The ext files never are updated because
# they could contain custom project code that we don't want
# to loose in an update.
for f in self.getMacStyExtFiles(macPackId) :
source = os.path.join(newMacDir, f)
if os.path.exists(source) :
os.remove(source)
for f in self.getMacTexExtFiles(macPackId) :
source = os.path.join(newMacDir, f)
if os.path.exists(source) :
os.remove(source)
# Remove the old macPack folder
shutil.rmtree(oldMacDir)
# Merge new settings into old section (change name to new ID)
# When updating, we are assuming the new macro is in the same
# family as the old one. As such, settings should be almost
# identical, but in case new settings are being added, we will
# merge them in now.
oldConfSettings = self.macroConfig['Macros'][oldMacPackId]
newConfSettings = self.tools.getXMLSettings(confXml)
# Now merge
newConfSettings.merge(oldConfSettings)
# Inject the new section
# self.tools.buildConfSection(self.macroConfig, macPackId)
self.macroConfig['Macros'][macPackId] = newConfSettings.dict()
# Delete the old section
del self.macroConfig['Macros'][oldMacPackId]
# Save the changes
self.tools.writeConfFile(self.macroConfig)
# Assuming everything went well we will change the macPackID on the cType
self.projectConfig['CompTypes'][self.cType.capitalize()]['macroPackage'] = macPackId
self.tools.writeConfFile(self.projectConfig)
# Report success
self.log.writeToLog(self.errorCodes['3600'], [self.cType.capitalize(), macPackId])
return True
# But if the install fails everything stays the same and we report
else :
self.log.writeToLog(self.errorCodes['3650'], [macPackId])
return False
def installMacPackOnly (self, source) :
'''Install the new macro package but only that.'''
# import pdb; pdb.set_trace()
if self.tools.pkgExtract(source, self.local.projMacroFolder, self.local.macroConfXmlFile) :
return True
else :
self.log.writeToLog(self.errorCodes['3200'], [self.tools.fName(source)])
return False
class Macro(object):
def __init__(self, pid, cType, gid=None):
"""Do the primary initialization for this class."""
self.pid = pid
self.gid = gid
self.cType = cType
self.user = UserConfig()
self.userConfig = self.user.userConfig
self.projHome = os.path.join(os.path.expanduser(self.userConfig["Resources"]["projects"]), self.pid)
self.local = ProjLocal(pid, gid, cType)
# import pdb; pdb.set_trace()
self.proj_config = Config(pid)
self.proj_config.getProjectConfig()
self.projectConfig = self.proj_config.projectConfig
self.layoutConfig = self.proj_config.layoutConfig
self.tools = Tools()
self.log = ProjLog(pid)
# Create config placeholders
self.layoutConfig = None
self.illustrationConfig = None
self.macroConfig = self.tools.loadConfig(self.local.macroConfFile, self.local.macroConfXmlFile)
# Log messages for this module
self.errorCodes = {
"3010": ["ERR", "No macro package is registered for the [<<1>>] component type."],
"3020": ["ERR", "Cannot update! No macro package is registered for the [<<1>>] component type."],
"3050": ["ERR", "Macro package file not found: [<<1>>]"],
"3100": [
"ERR",
"Macro package: [<<1>>] already exists in the project. I am not allowed to copy over an existing package.",
],
"3200": ["ERR", "Failed to install macro package: [<<1>>]"],
"3300": ["MSG", "Installed macro package: [<<1>>], Reinitialized [<<2>>]"],
"3310": ["ERR", "Failed to copy [<<1>>] to folder [<<2>>]."],
"3400": ["MSG", "Removed macro package configuration settings for: [<<1>>] from the macro.conf file."],
"3500": ["MSG", "Removed macro package [<<1>>] folder and all files contained."],
"3600": ["MSG", "Updated component type [<<1>>] with macro package [<<2>>]"],
"3650": ["ERR", "Failed to updated macro package [<<1>>]"],
}
###############################################################################
###################### Macro Package Handling Functions #######################
###############################################################################
######################## Error Code Block Series = 3000 #######################
###############################################################################
def createMacroFiles(self, macPackId):
"""Create all the necessary macro file names with their assigned paths."""
self.projMacPackFolder = os.path.join(self.local.projMacPackFolder, macPackId)
texFileIds = {
"preStyTexExtFile": "preSty-ext.tex",
"macSettingsFile": "settings.tex",
"extTexFile": "extension.tex",
"grpExtTexFile": self.gid + "-extension.tex",
"": "",
"": "",
"": "",
"": "",
"": "",
}
styFileIds = {
"glbExtStyFile": "extension.sty",
"grpExtStyFile": self.gid + "-extension.sty",
"": "",
"": "",
"": "",
"": "",
"": "",
}
# <file>
# <name>TeX lccode Definition File</name>
# <description>The TeX file that contains lccode definitions and is linked with the hypenation exclusions file.</description>
# <fileID>lccodeTexFile</fileID>
# <fileName>[self:gid]-lccode.tex</fileName>
# <filePath>[self:projGidFolder]</filePath>
# <depends></depends>
# <relies></relies>
# <note>This file is located in the component group folder to allow more segregated processing.</note>
# </file>
# <file>
# <name>TeX Group Hyphenation Exclusions File</name>
# <description>The file that contains the hypenation words exclusions list for the current group that TeX will use to render the text.</description>
# <fileID>grpHyphExcTexFile</fileID>
# <fileName>[self:gid]-hyphenation.tex</fileName>
# <filePath>[self:projGidFolder]</filePath>
# <depends></depends>
# <relies></relies>
# <note>This file is located in the component group folder to allow more segregated processing.</note>
# </file>
def getMacPackIdFromFileName(self, fileName):
"""Return the macPack ID based on the file name"""
# File name less ext is the ID
parts = len(fileName.split("."))
return ".".join(fileName.split(".")[: parts - 1])
def getMacPackIdFromSource(self, source):
"""Return the macPack ID based on the complete path and file name."""
# Get the file name from the path
fileName = self.tools.fName(source)
# Return the ID
return self.getMacPackIdFromFileName(fileName)
def addMacPack(self, source):
"""Add a macro package to the project. It will not work if
the same package is already present. Remove must be used
to get rid of the existing one first."""
# import pdb; pdb.set_trace()
macPackId = self.getMacPackIdFromSource(source)
confXml = os.path.join(self.local.projMacroFolder, macPackId, macPackId + ".xml")
if not os.path.isfile(source):
self.log.writeToLog(self.errorCodes["3050"], [source])
# Do not add/install if there seems to be a macro package there already
if self.projectConfig["CompTypes"][self.cType.capitalize()]["macroPackage"] and os.path.exists(
self.local.macroConfFile
):
self.log.writeToLog(self.errorCodes["3100"], [macPackId])
return False
# Set the projectConf to the new/same package
self.projectConfig["CompTypes"][self.cType.capitalize()]["macroPackage"] = macPackId
self.tools.writeConfFile(self.projectConfig)
# If we got this far, install the a fresh copy of the macPack
self.installMacPackOnly(source)
# Move the style files and custom TeX files out of the macPack
self.moveMacStyles(macPackId)
self.moveMacTex(macPackId)
# Create a fresh macro.conf file if it dosn't exist
if not os.path.isfile(self.local.macroConfFile):
self.macroConfig = self.tools.initNewConfig(self.local.macroConfFile, self.local.macroConfXmlFile)
# Inject information from this particular macro package
mInfo = self.tools.getXMLSettings(confXml)
self.macroConfig["Macros"][macPackId] = mInfo.dict()
# Save the settings now
self.tools.writeConfFile(self.macroConfig)
self.log.writeToLog(self.errorCodes["3300"], [macPackId, self.local.macroConfFileName])
return True
def moveMacStyles(self, macPackId):
"""Move the default macro package styles out of the freshly installed
project macro package folder to the project Style folder."""
# import pdb; pdb.set_trace()
# Collect the style files to copy
for f in self.getMacStyExtFiles(macPackId):
source = os.path.join(os.path.join(self.local.projMacroFolder, macPackId, f))
target = os.path.join(self.local.projStyleFolder, f)
self.tools.makedirs(self.local.projStyleFolder)
# Do not overwrite existing files unless force is used
if not os.path.exists(target):
shutil.copy(source, target)
# Look for default and set to read-only
defaultStyFile = os.path.join(self.local.projStyleFolder, macPackId + ".sty")
if target == defaultStyFile:
self.tools.makeReadOnly(defaultStyFile)
# Remove the source to avoid confusion
if os.path.exists(target):
os.remove(source)
else:
self.log.writeToLog(self.errorCodes["3310"], [source, self.local.projStyleFolder])
def getMacStyExtFiles(self, macPackId):
"""Return a list of macro package style extention files."""
sFiles = []
macPackFiles = os.listdir(os.path.join(self.local.projMacroFolder, macPackId))
for f in macPackFiles:
if f.split(".")[1].lower() == "sty":
sFiles.append(f)
return sFiles
def moveMacTex(self, macPackId):
"""Move the custom macro package TeX out of the freshly installed
project macro package folder to the project TeX folder."""
# Collect the TeX extention files to copy
for f in self.getMacTexExtFiles(macPackId):
source = os.path.join(os.path.join(self.local.projMacroFolder, macPackId, f))
target = os.path.join(self.local.projTexFolder, f)
self.tools.makedirs(self.local.projTexFolder)
# Do not overwrite existing files
if not os.path.exists(target):
shutil.copy(source, target)
# Remove the source to avoid confusion
if os.path.exists(target):
os.remove(source)
else:
self.log.writeToLog(self.errorCodes["3310"], [source, self.local.projTexFolder])
def getMacTexExtFiles(self, macPackId):
"""Return a list of macro package TeX extention files."""
tFiles = []
macPackFiles = os.listdir(os.path.join(self.local.projMacroFolder, macPackId))
for f in macPackFiles:
if f.find("ext.tex") > 0:
tFiles.append(f)
return tFiles
def removeMacPack(self):
"""Remove the macro package from a component type"""
# import pdb; pdb.set_trace()
if self.projectConfig["CompTypes"][self.cType.capitalize()]["macroPackage"] != "":
macPackId = self.projectConfig["CompTypes"][self.cType.capitalize()]["macroPackage"]
else:
self.log.writeToLog(self.errorCodes["3010"], [self.cType])
# Aquire target to delete
target = os.path.join(self.local.projMacroFolder, macPackId)
# Remove the macPack settings from the config file if it is there
try:
del self.macroConfig["Macros"][macPackId]
# Save the settings now
self.tools.writeConfFile(self.macroConfig)
self.log.writeToLog(self.errorCodes["3400"], [macPackId])
except:
pass
# Now remove the macro folder (with all its contents)
if os.path.exists(target):
shutil.rmtree(target)
self.log.writeToLog(self.errorCodes["3500"], [macPackId])
# Remove any style files associated with the macro
styTarget = os.path.join(self.local.projStyleFolder, macPackId + ".sty")
self.tools.makeExecutable(styTarget)
self.tools.removeFile(styTarget)
# Remove the reference for this macro package from the component type
# that uses it. Normally that would probably be just be one of them.
self.projectConfig["CompTypes"][self.cType.capitalize()]["macroPackage"] = ""
self.tools.writeConfFile(self.projectConfig)
def updateMacPack(self, source):
"""Update a macro package with the latest version but do not
touch the config file."""
# Do not update if no macro package is registered in the projectConfig
if not self.projectConfig["CompTypes"][self.cType.capitalize()]["macroPackage"]:
self.log.writeToLog(self.errorCodes["3020"], [self.cType.capitalize()])
return False
macPackId = self.getMacPackIdFromSource(source)
confXml = os.path.join(self.local.projMacroFolder, macPackId, macPackId + ".xml")
oldMacPackId = self.projectConfig["CompTypes"][self.cType.capitalize()]["macroPackage"]
oldMacDir = os.path.join(self.local.projMacroFolder, oldMacPackId)
newMacDir = os.path.join(self.local.projMacroFolder, macPackId)
# Install the new macPack (but use the old settings)
if self.installMacPackOnly(source):
# The current macro system must have a "master" style file.
# This is a version of the ParaText style file. Because
# an update might include an update to the style file,
# we need to copy that from the macro folder to the Style
# folder. We will do that now. The name of the file should
# be the macPackId + ".sty", in theory.
srcStyleFile = os.path.join(self.local.projMacroFolder, macPackId, macPackId + ".sty")
oldStyleFile = os.path.join(self.local.projStyleFolder, oldMacPackId + ".sty")
newStyleFile = os.path.join(self.local.projStyleFolder, macPackId + ".sty")
# Unlock the old one so it can be deleted.
self.tools.makeExecutable(oldStyleFile)
self.tools.removeFile(oldStyleFile)
# Now copy in the new one.
shutil.copy(srcStyleFile, newStyleFile)
# The style file should never be edited by the user, relock it
self.tools.makeReadOnly(newStyleFile)
# Update exsisting extention file names. We never want to loose
# any settings that the user may have added to the extention
# files so we will rename the existing files to have the
# new ID otherwise the system will not find them at render time.
oldStyExtFile = os.path.join(self.local.projStyleFolder, oldMacPackId + "_ext.sty")
oldTexExtFile = os.path.join(self.local.projTexFolder, oldMacPackId + "_ext.tex")
oldTexPreStyExtFile = os.path.join(self.local.projTexFolder, oldMacPackId + "_preSty-ext.tex")
newStyExtFile = os.path.join(self.local.projStyleFolder, macPackId + "_ext.sty")
newTexExtFile = os.path.join(self.local.projTexFolder, macPackId + "_ext.tex")
newTexPreStyExtFile = os.path.join(self.local.projTexFolder, macPackId + "_preSty-ext.tex")
# By default, we protect any existing versions
if os.path.exists(newStyExtFile):
os.remove(oldStyExtFile)
else:
self.tools.renameFile(oldStyExtFile, newStyExtFile)
if os.path.exists(newTexExtFile):
os.remove(oldTexExtFile)
else:
self.tools.renameFile(oldTexExtFile, newTexExtFile)
if os.path.exists(newTexPreStyExtFile):
os.remove(oldTexPreStyExtFile)
else:
self.tools.renameFile(oldTexPreStyExtFile, newTexPreStyExtFile)
# Remove un-needed sty and tex files from the newMacDir to
# avoid confusion. The ext files never are updated because
# they could contain custom project code that we don't want
# to loose in an update.
for f in self.getMacStyExtFiles(macPackId):
source = os.path.join(newMacDir, f)
if os.path.exists(source):
os.remove(source)
for f in self.getMacTexExtFiles(macPackId):
source = os.path.join(newMacDir, f)
if os.path.exists(source):
os.remove(source)
# Remove the old macPack folder
shutil.rmtree(oldMacDir)
# Merge new settings into old section (change name to new ID)
# When updating, we are assuming the new macro is in the same
# family as the old one. As such, settings should be almost
# identical, but in case new settings are being added, we will
# merge them in now.
oldConfSettings = self.macroConfig["Macros"][oldMacPackId]
newConfSettings = self.tools.getXMLSettings(confXml)
# Now merge
newConfSettings.merge(oldConfSettings)
# Inject the new section
# self.tools.buildConfSection(self.macroConfig, macPackId)
self.macroConfig["Macros"][macPackId] = newConfSettings.dict()
# Delete the old section
del self.macroConfig["Macros"][oldMacPackId]
# Save the changes
self.tools.writeConfFile(self.macroConfig)
# Assuming everything went well we will change the macPackID on the cType
self.projectConfig["CompTypes"][self.cType.capitalize()]["macroPackage"] = macPackId
self.tools.writeConfFile(self.projectConfig)
# Report success
self.log.writeToLog(self.errorCodes["3600"], [self.cType.capitalize(), macPackId])
return True
# But if the install fails everything stays the same and we report
else:
self.log.writeToLog(self.errorCodes["3650"], [macPackId])
return False
def installMacPackOnly(self, source):
"""Install the new macro package but only that."""
# import pdb; pdb.set_trace()
if self.tools.pkgExtract(source, self.local.projMacroFolder, self.local.macroConfXmlFile):
return True
else:
self.log.writeToLog(self.errorCodes["3200"], [self.tools.fName(source)])
return False
class ProjBinding (object) :
def __init__(self, pid) :
'''Do the primary initialization for this manager.'''
self.pid = pid
self.tools = Tools()
self.user = UserConfig()
self.userConfig = self.user.userConfig
self.config = Config(pid)
self.pg_back = ProjBackground(self.pid)
self.config.getProjectConfig()
self.config.getLayoutConfig()
self.projectConfig = self.config.projectConfig
self.layoutConfig = self.config.layoutConfig
self.useBackground = self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useBackground'])
self.useDocInfo = self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useDocInfo'])
self.projHome = os.path.join(self.userConfig['Resources']['projects'], self.pid)
self.local = ProjLocal(self.pid)
self.log = ProjLog(self.pid)
self.pdfViewerCmd = self.userConfig['System']['pdfViewerCommand']
# Log messages for this module
self.errorCodes = {
'0205' : ['MSG', 'Unassigned message.'],
'0210' : ['MSG', 'No contents are specified for binding.'],
'0215' : ['ERR', 'Failed to bind contents into the [<<1>>] fille. Got error: [<<2>>]'],
'0220' : ['ERR', 'Could not copy [<<1>>] temp file to [<<2>>] saved binding file.'],
'0230' : ['MSG', 'Completed proccessing on the [<<1>>] binding file.'],
'0235' : ['ERR', 'Failed to complete proccessing on the [<<1>>] binding file.'],
'0240' : ['LOG', 'Recorded [<<1>>] rendered pages in the [<<2>>] binding file.'],
'0260' : ['ERR', 'PDF viewer failed with this error: [<<1>>]'],
'0265' : ['ERR', 'Rendered file not found: <<1>>'],
'0270' : ['WRN', 'PDF viewing is disabled.'],
'0280' : ['ERR', 'GS PDF file merge failed with this error: [<<1>>]'],
'0300' : ['MSG', 'File binding operation in process, please wait...']
}
###############################################################################
############################## Binding Functions ##############################
###############################################################################
######################## Error Code Block Series = 200 ########################
###############################################################################
# import pdb; pdb.set_trace()
def bind (self, save = False) :
'''Bind all groups in the order they are indicated by group bindOrder
settings. Note, because binding spans groups and the main body
(project.py) mainly just works on one group at a time, this has to
be called from outside project and project needs to be reinitialized
each time a group is rendered from here.'''
# import pdb; pdb.set_trace()
# Get the order of the groups to be bound.
bindOrder = {}
# Put a safty in here in case there are no groups yet
if not self.projectConfig.has_key('Groups') :
return False
# Build the bindOrder dict with ord num as key and file name as value
for gid in self.projectConfig['Groups'].keys() :
if not self.projectConfig['Groups'][gid].has_key('bindingOrder') :
self.projectConfig['Groups'][gid]['bindingOrder'] = 0
self.tools.writeConfFile(self.projectConfig)
if int(self.projectConfig['Groups'][gid]['bindingOrder']) > 0 :
gidPdfFile = os.path.join(self.local.projComponentFolder, gid, gid + '.pdf')
# bindOrder[self.projectConfig['Groups'][gid]['bindingOrder']] = self.projectConfig['Groups'][gid]['bindingFile']
bindOrder[self.projectConfig['Groups'][gid]['bindingOrder']] = gidPdfFile
bindGrpNum = len(bindOrder)
# Need not keep going if nothing was found
if bindGrpNum == 0 :
self.log.writeToLog(self.errorCodes['0210'])
return False
# Make an ordered key list
keyList = bindOrder.keys()
keyList.sort()
# Output the bind files in order according to the list we made
fileList = []
for key in keyList :
fileList.append(bindOrder[key])
# First merge the master pages together
tempFile = self.mergePdfFilesGs(fileList)
# Now add background and doc info if requested
bgFile = ''
if self.useBackground :
bgFile = self.pg_back.addBackground(tempFile)
if self.useDocInfo :
if bgFile :
bgFile = self.pg_back.addDocInfo(bgFile)
else :
bgFile = self.pg_back.addDocInfo(tempFile)
# If we are saving this make a name for it
if save :
bindFileName = self.pid + '_contents_' + self.tools.ymd()
# Save this to the Deliverable folder (Make sure there is one)
if not os.path.isdir(self.local.projDeliverableFolder) :
os.makedirs(self.local.projDeliverableFolder)
bindFile = os.path.join(self.local.projDeliverableFolder, bindFileName + '.pdf')
if os.path.exists(bgFile) :
if shutil.copy(bgFile, bindFile) :
self.log.writeToLog(self.errorCodes['0220'], [bgFile,bindFile])
else :
if shutil.copy(tempFile, bindFile) :
self.log.writeToLog(self.errorCodes['0220'], [tempFile,bindFile])
# Direct to viewFile
viewFile = bindFile
else :
if os.path.exists(bgFile) :
viewFile = bgFile
else :
viewFile = tempFile
# Binding should have been successful, report it now
self.log.writeToLog(self.errorCodes['0230'], [viewFile])
# View the file
if os.path.isfile(viewFile) :
if not len(self.pdfViewerCmd[0]) == 0 :
# Add the file to the viewer command
self.pdfViewerCmd.append(viewFile)
# Run the viewer
try :
subprocess.Popen(self.pdfViewerCmd)
return True
except Exception as e :
# If we don't succeed, we should probably quite here
self.log.writeToLog(self.errorCodes['0260'], [str(e)])
else :
self.log.writeToLog(self.errorCodes['0270'])
else :
self.log.writeToLog(self.errorCodes['0265'], [self.tools.fName(viewFile)])
def mergePdfFilesGs (self, sourceList) :
'''Using GS, merge multiple PDF files into one. The advantage of
using Gs is that the index will be maintained. pdftk strips out
the index, which is bad...'''
# This is our working file for this operation
tempFile = tempfile.NamedTemporaryFile().name + '.pdf'
# FIXME: Note/Warning, the use "-dPDFSETTINGS=/prepress" can cause an issue when
# rendering. A segmentation fault may occur. This will cause the bind feature
# to fail and gs will fail. There does not seem to be any way around this
# as getting feedback from gs while processing is not possible, or at least
# not very easy. It will have to stay this way for now.
cmd = ['gs', '-dBATCH', '-dNOPAUSE', '-q', '-sDEVICE=pdfwrite', '-dPDFSETTINGS=/prepress', '-sOutputFile=' + tempFile]
# If there issues with segmentation faults, the following should help with debugging
# cmd = ['gs', '-dBATCH', '-dNOPAUSE', '-q', '-sDEVICE=pdfwrite', '-sOutputFile=' + tempFile]
# Now add the files we want to bind together
cmd = cmd + sourceList
# Now bind the files
try :
self.log.writeToLog(self.errorCodes['0300'])
subprocess.call(cmd)
# Return our file name for further processing
return tempFile
except Exception as e :
# If we don't succeed, we should probably quite here
self.log.writeToLog(self.errorCodes['0280'], [str(e)])
class Xetex (Manager) :
# Shared values
xmlConfFile = 'xetex.xml'
def __init__(self, project, cfg, cType) :
'''Do the primary initialization for this manager.'''
super(Xetex, self).__init__(project, cfg)
# import pdb; pdb.set_trace()
# Create all the values we can right now for this manager.
# Others will be created at run time when we know the cid.
self.tools = Tools()
self.project = project
self.local = project.local
self.log = project.log
self.cfg = cfg
self.pid = project.projectIDCode
self.gid = project.gid
self.cType = cType
self.Ctype = cType.capitalize()
self.mType = project.projectMediaIDCode
self.renderer = 'xetex'
self.manager = self.cType + '_' + self.renderer.capitalize()
self.managers = project.managers
self.pg_back = ProjBackground(self.pid, self.gid)
self.fmt_diagnose = ProjDiagnose(self.pid, self.gid)
self.proj_config = Config(self.pid, self.gid)
self.proj_config.getProjectConfig()
self.proj_config.getLayoutConfig()
self.proj_config.getFontConfig()
self.proj_config.getMacroConfig()
# Bring in some manager objects we will need
self.proj_font = ProjFont(self.pid)
self.proj_illustration = ProjIllustration(self.pid, self.gid)
self.proj_hyphenation = ProjHyphenation(self.pid, self.gid)
self.usfmData = UsfmData()
self.cidChapNumDict = self.usfmData.cidChapNumDict()
self.cidPtIdDict = self.usfmData.cidPtIdDict()
# Get config objs
self.projectConfig = self.proj_config.projectConfig
self.layoutConfig = self.proj_config.layoutConfig
self.fontConfig = self.proj_config.fontConfig
self.macroConfig = self.proj_config.macroConfig
self.userConfig = self.project.userConfig
self.macPackId = self.projectConfig['CompTypes'][self.Ctype]['macroPackage']
# Some config settings
self.pdfViewerCmd = self.tools.getPdfViewerCommand(self.userConfig, self.projectConfig)
self.sourceEditor = self.projectConfig['CompTypes'][self.Ctype]['sourceEditor']
self.useBackground = self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useBackground'])
self.useDiagnostic = self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useDiagnostic'])
self.useDocInfo = self.tools.str2bool(self.layoutConfig['DocumentFeatures']['useDocInfo'])
# Get settings for this component
self.managerSettings = self.projectConfig['Managers'][self.manager]
for k, v in self.managerSettings.iteritems() :
if v == 'True' or v == 'False' :
setattr(self, k, self.tools.str2bool(v))
else :
setattr(self, k, v)
# Set some Booleans (this comes after persistant values are set)
# Setting hyphenation is a 2 step process, first check global, then group
self.useHyphenation = False
if self.tools.str2bool(self.projectConfig['ProjectInfo']['hyphenationOn']) :
if self.tools.str2bool(self.projectConfig['Groups'][self.gid]['useHyphenation']) :
self.useHyphenation = True
# In case the macro is not installed we need to skip over this
try :
self.chapNumOffSingChap = self.tools.str2bool(self.macroConfig['Macros'][self.macPackId]['ChapterVerse']['omitChapterNumberOnSingleChapterBook'])
except :
self.chapNumOffSingChap = None
# Make any dependent folders if needed
if not os.path.isdir(self.local.projGidFolder) :
os.makedirs(self.local.projGidFolder)
# Record some error codes
# FIXME: much more needs to be done with this
self.xetexErrorCodes = {
0 : 'Rendering succeful.',
256 : 'Something really awful happened.'
}
# Log messages for this module
self.errorCodes = {
'1005' : ['ERR', 'PDF viewer failed with error: [<<1>>]'],
'1010' : ['ERR', 'Style file [<<1>>] could not be created.'],
'1040' : ['LOG', 'Created: [<<1>>]'],
'0420' : ['WRN', 'TeX settings file has been frozen for debugging purposes.'],
'0440' : ['LOG', 'Created: [<<1>>]'],
'0460' : ['LOG', 'Settings changed in [<<1>>], [<<2>>] needed to be recreated.'],
'0465' : ['LOG', 'File: [<<1>>] missing, created a new one.'],
'0470' : ['ERR', 'Macro package [<<1>>] is not recognized by the system.'],
'0600' : ['MSG', '<<1>> cannot be viewed, PDF viewer turned off.'],
'0610' : ['LOG', 'Recorded [<<1>>] rendered pages in the [<<2>>] group.'],
'0615' : ['ERR', 'XeTeX failed to execute with error: <<1>>'],
'0617' : ['ERR', 'XeTeX failed to execute with this error: [<<1>>]'],
'0620' : ['DBG', 'xetex command in <<1>>: <<2>> <<3>>'],
'0625' : ['MSG', 'Rendering of [<<1>>] successful.'],
'0630' : ['ERR', 'Rendering [<<1>>] was unsuccessful. <<2>> (<<3>>)'],
'0635' : ['ERR', 'XeTeX error code [<<1>>] not understood by Rapuma.'],
'0650' : ['ERR', 'Component type [<<1>>] not supported!'],
'0690' : ['MSG', 'Dependent files unchanged, rerendering of [<<1>>] un-necessary.'],
'0695' : ['MSG', 'Routing <<1>> to PDF viewer.'],
'0700' : ['ERR', 'Rendered file not found: <<1>>'],
'0710' : ['WRN', 'PDF viewing is disabled.'],
'0720' : ['MSG', 'Saved rendered file to: [<<1>>]'],
'0730' : ['ERR', 'Failed to save rendered file to: [<<1>>]'],
'1000' : ['WRN', 'XeTeX debugging is set to [<<1>>]. These are the paths XeTeX is seeing: [<<2>>]'],
'1090' : ['ERR', 'Invalid value [<<1>>] used for XeTeX debugging. Must use an integer of 0, 1, 2, 4, 8, 16, or 32']
}
# FIXME: It would be good if we could do a check for dependent files here
###############################################################################
############################ Manager Level Functions ##########################
###############################################################################
######################## Error Code Block Series = 1000 #######################
###############################################################################
def checkStartPageNumber (self) :
'''Adjust page number for the current group. The current logic is
if there is no number in the startPageNumber setting, we can put
one in there as a suggestion. If there is already one there, the
user will be responsible for seeing that it is correct.'''
# import pdb; pdb.set_trace()
try :
# Simply try to return anything that is in the field
cStrPgNo = self.projectConfig['Groups'][self.gid]['startPageNumber']
if cStrPgNo != '' :
return cStrPgNo
except :
# If nothing is there, we'll make a suggestion
pGrp = str(self.projectConfig['Groups'][self.gid]['precedingGroup'])
if pGrp == 'None' :
self.projectConfig['Groups'][self.gid]['startPageNumber'] = 1
self.tools.writeConfFile(self.projectConfig)
return '1'
else :
# Calculate the suggested number based on the preceeding group
try :
cStrPgNo = str(self.projectConfig['Groups'][self.gid]['startPageNumber'])
except :
cStrPgNo = 1
self.projectConfig['Groups'][self.gid]['startPageNumber'] = 1
try :
pGrpPgs = int(self.projectConfig['Groups'][pGrp]['totalPages'])
pGrpStrPgNo = int(self.projectConfig['Groups'][pGrp]['startPageNumber'])
except :
# FIXME: Maybe this could go out and find out exactly how many pages were in the preceeding group
pGrpPgs = 1
pGrpStrPgNo = 1
self.projectConfig['Groups'][pGrp]['totalPages'] = 1
self.projectConfig['Groups'][pGrp]['startPageNumber'] = 1
# Whether this is right or wrong set it the way it is
self.projectConfig['Groups'][self.gid]['startPageNumber'] = (pGrpStrPgNo + pGrpPgs)
self.tools.writeConfFile(self.projectConfig)
return self.projectConfig['Groups'][pGrp]['startPageNumber']
def makeExtFile (self, fileName, description) :
'''Generic function to create an extension file if one does not already exist.'''
if not os.path.exists(fileName) :
with codecs.open(fileName, "w", encoding='utf_8') as writeObject :
writeObject.write(self.tools.makeFileHeader(fileName, description, False))
self.log.writeToLog(self.errorCodes['1040'], [self.tools.fName(fileName)])
return True
def makeCmpExtTexFileOn (self, fileName) :
'''Create a component TeX extention macro "on" file for a specified component. A matching "off"
file will be created as well.'''
description = 'This is a component (on) TeX macro extension file which may override any macros \
which were loaded for this rendering process. This file is read just before the component \
working file. After the component is rendered, the accompanying off TeX file will be \
loaded which will turn off any modified macro commands that this TeX file has set. The \
user must edit this file in order for it to work right.'
return self.makeExtFile(fileName, description)
def makeCmpExtTexFileOff (self, fileName) :
'''Create a component TeX extention macro "off" file for a specified component. This is to
match the "on" file that was created.'''
description = 'This is a component (off) style extension file which overrides the settings \
that were loaded for this rendering process just prior to loading the component working \
file. The commands in this style file will off-set the "on" settings causing the macro to \
render as it did before the "on" styles were loaded. The user must edit this file for it \
to work properly.'
return self.makeExtFile(fileName, description)
def makeCmpExtStyFileOn (self, fileName) :
'''Create a component style extentions "on" file for a specified component. A matching "off"
file will be created as well.'''
description = 'This is a component (on) style extension file which overrides any settings \
which were loaded for this rendering process. This file is read just before the component \
working file. After the component is rendered, the accompanying off style file will be \
loaded which will turn off any modified style commands that this style file has set. The \
user must edit this file in order for it to work right.'
return self.makeExtFile(fileName, description)
def makeCmpExtStyFileOff (self, fileName) :
'''Create a component style extentions "off" file for a specified component. This is to
match the "on" file that was created.'''
description = 'This is a component (off) style extension file which overrides the settings \
that were loaded for this rendering process just prior to loading the component working \
file. The commands in this style file will off-set the "on" settings causing the macro to \
render as it did before the "on" styles were loaded. The user must edit this file for it \
to work properly.'
return self.makeExtFile(fileName, description)
def makeGrpExtTexFile (self) :
'''Create a group TeX extentions file for a specified group.'''
description = 'This is the group TeX extention macro file which overrides settings in \
the global TeX extension macro file.'
return self.makeExtFile(self.local.grpExtTexFile, description)
def makeGrpExtStyFile (self) :
'''Create a group Style extentions file to a specified group.'''
description = 'This is the group style extention file which overrides settings in \
the main default component extentions settings style file.'
return self.makeExtFile(self.local.grpExtStyFile, description)
###############################################################################
############################# DEPENDENCY FUNCTIONS ############################
###############################################################################
######################## Error Code Block Series = 0400 #######################
###############################################################################
def makeSettingsTexFile (self) :
'''Create the primary TeX settings file.'''
# import pdb; pdb.set_trace()
description = 'This is the primary TeX settings file for the ' + self.gid + ' group. \
It is auto-generated so editing can be a rather futile exercise. This is unless you \
set freezeTexSettings to True in the XeTeX manager configuration of the project.conf \
file. Doing that will prevent the file from being remade. However, no configuration \
changes will be reflected in the static settings file. Use this with care.'
# Setting for internal testing
outputTest = False
# Check for freezeTexSettings in project.conf
if self.projectConfig['Managers'][self.cType + '_Xetex'].has_key('freezeTexSettings') and \
self.tools.str2bool(self.projectConfig['Managers'][self.cType + '_Xetex']['freezeTexSettings']) :
self.log.writeToLog(self.errorCodes['0420'])
return False
def appendLine(line, realVal) :
'''Use this to shorten the code and look for listy things.'''
if type(line) == list :
for s in line :
linesOut.append(self.proj_config.processNestedPlaceholders(s, realVal))
else :
linesOut.append(self.proj_config.processNestedPlaceholders(line, realVal))
# Open a fresh settings file
with codecs.open(self.local.macSettingsFile, "w", encoding='utf_8') as writeObject :
writeObject.write(self.tools.makeFileHeader(self.local.macSettingsFileName, description))
# Build a dictionary from the default XML settings file
# Create a dict that contains only the data we need here
macPackDict = self.tools.xmlFileToDict(self.local.macPackConfXmlFile)
for sections in macPackDict['root']['section'] :
for section in sections :
secItem = sections[section]
linesOut = []
if type(secItem) is list :
if outputTest :
print sections['sectionID']
linesOut.append('% ' + sections['sectionID'].upper())
for setting in secItem :
for k in setting.keys() :
if k == 'texCode' :
if outputTest :
print '\t', setting['key']
realVal = self.macroConfig['Macros'][self.macPackId][sections['sectionID']][setting['key']]
# Test any boolDepends that this setting might have
if setting.has_key('boolDepend') :
result = []
if type(setting['boolDepend']) == list :
for i in setting['boolDepend'] :
result.append(self.affirm(i))
else :
result.append(self.affirm(setting['boolDepend']))
# If 'None' didn't end up in the list, that means
# every bool tested good so we can output the line
if None not in result :
if outputTest :
print '\t', setting.get(k)
appendLine(setting['texCode'], realVal)
# Normal setting output
elif setting.get(k) :
if setting.get(k) != None :
# We filter out zero values here (But what if we need one of them?)
if not self.proj_config.processNestedPlaceholders(realVal) == '0' :
if outputTest :
print '\t', setting.get(k)
appendLine(setting['texCode'], realVal)
# Only write out sections that have something in them
if len(linesOut) > 1 :
writeObject.write('\n')
for line in linesOut :
writeObject.write(line + '\n')
# Continue here with injecting the font settings which are guided by
# the config file because the XML source(s) could vary
writeObject.write('\n% INSTALLED FONTS\n')
installedFonts = self.fontConfig['Fonts'].keys()
cTypeFont = self.projectConfig['CompTypes'][self.cType.capitalize()]['fontName']
for font in installedFonts :
if font == cTypeFont :
# Output the primary font
for key in self.fontConfig['Fonts'][font]['TexMapping']['PrimaryFont'].keys() :
writeObject.write(self.proj_config.processNestedPlaceholders(self.fontConfig['Fonts'][font]['TexMapping']['PrimaryFont'][key]) + '\n')
# Output the seconday settings as well for this font
for key in self.fontConfig['Fonts'][font]['TexMapping']['SecondaryFont'].keys() :
writeObject.write(self.proj_config.processNestedPlaceholders(self.fontConfig['Fonts'][font]['TexMapping']['SecondaryFont'][key]) + '\n')
else :
# There can only be one primary font, this is not it
for key in self.fontConfig['Fonts'][font]['TexMapping']['SecondaryFont'].keys() :
writeObject.write(self.proj_config.processNestedPlaceholders(self.fontConfig['Fonts'][font]['TexMapping']['SecondaryFont'][key]) + '\n')
writeObject.write('\n')
# Die here if testing
if outputTest :
self.tools.dieNow()
# Report finished if not
return True
def affirm (self, boolDependInfo) :
'''Affirm by returning True if the actual bool matches its
state setting. Returning 'None' will cause a setting to be skipped.'''
realBool = self.returnConfRefValue(boolDependInfo['#text']).lower()
if boolDependInfo['@state'].lower() == realBool.lower() :
return True
def returnConfRefValue (self, ref) :
'''Return the value of a given config reference. The ref syntax is
as follows: [config:configObj|section|key]. This should be able to
recuse as deep as necessary.'''
# import pdb; pdb.set_trace()
ref = ref.lstrip('[').rstrip(']')
(holderType, holderKey) = ref.split(':', 1)
if holderType.lower() == 'config' :
val = holderKey.split('|')
dct = ['self.' + val[0]]
val.remove(val[0])
for i in val :
i = self.proj_config.processNestedPlaceholders(i, '')
dct.append('["' + i + '"]')
return eval(''.join(dct))
def makeGidTexFile (self, cidList) :
'''Create the main gid TeX control file.'''
description = 'This is the group TeX control file. XeTeX will \
read this file to get all of links to other instructions (macros) \
needed to render the group, or a component of a group.'
# Since a render run could contain any number of components
# in any order, we will remake this file on every run. No need
# for dependency checking
if os.path.exists(self.local.gidTexFile) :
os.remove(self.local.gidTexFile)
# Create the main TeX settings file (made on every run)
self.makeSettingsTexFile()
# Start writing out the gid.tex file. Check/make dependencies as we go.
# If we fail to make a dependency it will die and report during that process.
# We bring in each element in the order necessary
with codecs.open(self.local.gidTexFile, "w", encoding='utf_8') as gidTexObject :
# Write out the file header
gidTexObject.write(self.tools.makeFileHeader(self.local.gidTexFileName, description))
# First bring in the main macro file
gidTexObject.write('\\input \"' + self.local.primaryMacroFile + '\"\n')
# Check for a preStyle extension file and load if it is there
if os.path.exists(self.local.preStyTexExtFile) :
gidTexObject.write('\\input \"' + self.local.preStyTexExtFile + '\"\n')
########
# FIXME? To avoid problems with the usfmTex marginalverses macro code, we bring
# in the stylesheets now. Will this cause any problems with other macPacks?
########
# Load style files (default and extention come with the package)
gidTexObject.write('\\stylesheet{' + self.local.defaultStyFile + '}\n')
# Load the global style extensions
gidTexObject.write('\\stylesheet{' + self.local.glbExtStyFile + '}\n')
# Load the group style extensions (if needed)
if self.projectConfig['Groups'][self.gid].has_key('useGrpStyOverride') and self.tools.str2bool(self.projectConfig['Groups'][self.gid]['useGrpStyOverride']) :
self.makeGrpExtStyFile()
gidTexObject.write('\\stylesheet{' + self.local.grpExtStyFile + '}\n')
# Load the settings (usfmTex: if marginalverses, load code in this)
gidTexObject.write('\\input \"' + self.local.macSettingsFile + '\"\n')
# Load the TeX macro extensions for this macro package
gidTexObject.write('\\input \"' + self.local.extTexFile + '\"\n')
# Load the group TeX macro extensions (if needed)
if self.projectConfig['Groups'][self.gid].has_key('useGrpTexOverride') and self.tools.str2bool(self.projectConfig['Groups'][self.gid]['useGrpTexOverride']) :
self.makeGrpExtTexFile()
gidTexObject.write('\\input \"' + self.local.grpExtTexFile + '\"\n')
# Load hyphenation data if needed
if self.useHyphenation :
# This is the main hyphenation settings file, this must be loaded first
gidTexObject.write('\\input \"' + self.proj_hyphenation.projHyphSetTexFile + '\"\n')
# This is the character definition file for hyphenation, this should be loaded second
gidTexObject.write('\\input \"' + self.proj_hyphenation.projHyphCharTexFile + '\"\n')
# This is the exception words list (all the hyphenated words), this is loaded last
gidTexObject.write('\\input \"' + self.proj_hyphenation.projHyphExcTexFile + '\"\n')
# If this is less than a full group render, just go with default pg num (1)
if cidList == self.projectConfig['Groups'][self.gid]['cidList'] :
# Check if this setting is there
startPageNumber = self.checkStartPageNumber()
if startPageNumber > 1 :
gidTexObject.write('\\pageno = ' + str(startPageNumber) + '\n')
# Insert Document properties and x1a compliant info if needed
gidTexObject.write(self.makeXoneACompliant())
# Now add in each of the components
for cid in cidList :
# Output files and commands for usfm cType
if self.cType == 'usfm' :
cidSource = os.path.join(self.local.projComponentFolder, cid, self.project.groups[self.gid].makeFileNameWithExt(cid))
cidTexFileOn = os.path.join(self.local.projTexFolder, self.gid + '-' + cid + '-On-ext.tex')
cidTexFileOff = os.path.join(self.local.projTexFolder, self.gid + '-' + cid + '-Off-ext.tex')
cidStyFileOn = os.path.join(self.local.projStyleFolder, self.gid + '-' + cid + '-On-ext.sty')
cidStyFileOff = os.path.join(self.local.projStyleFolder, self.gid + '-' + cid + '-Off-ext.sty')
# Check to see if a TeX macro override is needed
if self.projectConfig['Groups'][self.gid].has_key('compTexOverrideList') and cid in self.projectConfig['Groups'][self.gid]['compTexOverrideList'] :
self.makeCmpExtTexFileOn(cidTexFileOn)
gidTexObject.write('\\input \"' + cidTexFileOn + '\"\n')
# Check to see if a style override is needed (if so create "on" file)
if self.projectConfig['Groups'][self.gid].has_key('compStyOverrideList') and cid in self.projectConfig['Groups'][self.gid]['compStyOverrideList'] :
self.makeCmpExtStyFileOn(cidStyFileOn)
gidTexObject.write('\\stylesheet{' + cidStyFileOn + '}\n')
# Check for short books add omit statement
if self.chapNumOffSingChap and self.cidChapNumDict[cid] == 1 :
gidTexObject.write('\\OmitChapterNumbertrue\n')
# Add the working file here
gidTexObject.write('\\ptxfile{' + cidSource + '}\n')
# Check again for short books turn off omit statement
if self.chapNumOffSingChap and self.cidChapNumDict[cid] == 1 :
gidTexObject.write('\\OmitChapterNumberfalse\n')
# Check for for style override and add the "Off" style file here
if self.projectConfig['Groups'][self.gid].has_key('compStyOverrideList') and cid in self.projectConfig['Groups'][self.gid]['compStyOverrideList'] :
self.makeCmpExtStyFileOn(cidStyFileOff)
gidTexObject.write('\\stylesheet{' + cidStyFileOff + '}\n')
# Check for for TeX macro override and add the "Off" TeX file here
if self.projectConfig['Groups'][self.gid].has_key('compTexOverrideList') and cid in self.projectConfig['Groups'][self.gid]['compTexOverrideList'] :
self.makeCmpExtTexFileOff(cidTexFileOff)
gidTexObject.write('\\input \"' + cidTexFileOff + '\"\n')
else :
self.log.writeToLog(self.errorCodes['0650'], [self.cType])
# This can only hapen once in the whole process, this marks the end
gidTexObject.write('\\bye\n')
return True
def makeXoneACompliant (self) :
'''Insert the necessary TeX code into the header to give the
appearance of being PDF x1-a compliant. If the feature is turned
off then it will only inject relevant document properties that
are good to have included no mater what. XeTeX output is x1-a
for the most part, it just doesn't brag about it. The output
here mostly works. :-) '''
# import pdb; pdb.set_trace()
allLines = ''
# Set some of the vars for the output
title = self.projectConfig['ProjectInfo']['projectTitle']
subject = self.projectConfig['ProjectInfo']['projectDescription']
author = ''.join(self.projectConfig['ProjectInfo']['translators'])
creator = ''.join(self.projectConfig['ProjectInfo']['typesetters'])
# I don't think this next bit is not right, what does +7 mean anyway?
# It works for CDT time anyway, which I thought was -6
offSet = "+07\'00\'"
# To get the date stamp right, we strip out all the non-number
# characters so we are left with: yyyymmddhhmmss
comp = self.projectConfig['ProjectInfo']['projectCreateDate'].replace('-', '').replace(':', '').replace(' ', '')
cDate = 'D:' + comp + offSet
mDate = 'D:' + self.tools.fullFileTimeStamp() + offSet
lines = [
'\special{pdf:docinfo<<',
'/Title(' + title + ')%',
'/Subject(' + subject + ')%',
'/Author(' + author + ')%',
'/Creator(' + creator + ')%',
'/CreationDate(' + cDate + ')%',
'/ModDate(' + mDate + ')%',
'/Producer(XeTeX with Rapuma)%',
'/Trapped /False',
'/GTS_PDFXVersion(PDF/X-1:2003)%',
'/GTS_PDFXConformance(PDF/X-1a:2003)%',
'>> }'
]
# Add PDF header declairations for PDF X1-A:2003 compliance (default is True)
if self.tools.str2bool(self.layoutConfig['DocumentFeatures']['pdfX1a']) :
icc = os.path.join(self.local.rapumaConfigFolder, 'ps_cmyk.icc')
# Now create the insert line list
xtralines = [ '\special{pdf:fstream @OBJCVR (' + icc + ')}',
'\special{pdf:put @OBJCVR <</N 4>>}',
'%\special{pdf:close @OBJCVR}',
'\special{pdf:docview <<',
'/OutputIntents [ <<',
'/Type/OutputIndent',
'/S/GTS_PDFX',
'/OutputCondition (An Unknown print device)',
'/OutputConditionIdentifier (Custom)',
'/DestOutputProfile @OBJCVR',
'/RegistryName (http://www.color.og)',
'>> ] >>}'
]
lines = lines + xtralines
# Whatever our output, process the lines
for l in lines :
allLines = allLines + l + ' \n'
return allLines
###############################################################################
################################# Main Function ###############################
###############################################################################
######################## Error Code Block Series = 0600 #######################
###############################################################################
def run (self, gid, cidList, pgRange, override, save) :
'''This will check all the dependencies for a group and then
use XeTeX to render the whole group or a subset of components
and even a page range in a single component.'''
# import pdb; pdb.set_trace()
# There must be a cidList. If one was not passed, default to
# the group list
cidListSubFileName = ''
saveFile = ''
saveFileName = ''
if not cidList :
cidList = self.projectConfig['Groups'][gid]['cidList']
else :
# If there is a cidList, create an alternate ouput name.
# This is so if the file is saved it will have a unique
# name. the name needs to be ordered by ###-cid-gid.
# We need to do this sooner than later.
if len(cidList) > 1 :
cidListSubFileName = '-'.join(cidList)
else :
cid = cidList[0]
# Add a filler character to the ID
cnid = "{:0>3}".format(self.cidPtIdDict[cid])
cidListSubFileName = cnid + '-' + cid
# Create, if necessary, the gid.tex file
# First, go through and make/update any dependency files
self.makeSettingsTexFile()
# Now make the gid main setting file
self.makeGidTexFile(cidList)
# Dynamically create a dependency list for the render process
# Note: gidTexFile is remade on every run, do not test against that file
dep = [self.local.extTexFile, self.local.projectConfFile, self.local.layoutConfFile,
self.local.macroConfFile, self.local.illustrationConfFile, ]
# Add component dependency files
for cid in cidList :
cidUsfm = self.project.groups[gid].getCidPath(cid)
cidIlls = self.proj_illustration.getCidPiclistFile(cid)
for f in [cidUsfm, cidIlls] :
if os.path.exists(f) :
dep.append(f)
# Treat adjustment file separate
if self.cType == 'usfm' :
cidAdj = self.project.groups[gid].getCidAdjPath(cid)
if os.path.exists(cidAdj) :
dep.append(cidAdj)
# Call the renderer
# Create the environment that XeTeX will use. This will be temporarily set
# by subprocess.call() just before XeTeX is run.
texInputsLine = self.project.local.projHome + ':' \
+ self.local.projStyleFolder + ':' \
+ self.local.projTexFolder + ':' \
+ self.local.projMacPackFolder + ':' \
+ self.local.projMacroFolder + ':' \
+ self.local.projGidFolder + ':.'
# Create the environment dictionary that will be fed into subprocess.call()
#envDict = dict(os.environ)
envDict={}
# These are project environment vars
envDict['TEXINPUTS'] = texInputsLine
# These are XeTeX environment vars that are run if the internal (fast) version
# of XeTeX is being run, which is the default. If runExternalXetex is set to
# False, the following special environment vars will be run. If set to true,
# an external version of XeTeX, provided it is installed, will run with its own
# environment vars set elsewhere
runExternal = self.tools.str2bool(self.projectConfig['Managers'][self.cType + '_Xetex'].get('runExternalXetex', ''))
if not runExternal :
envDict['PATH'] = os.path.join(self.local.rapumaXetexFolder, 'bin', 'x86_64-linux')
envDict['TEXMFCNF'] = os.path.join(self.local.rapumaXetexFolder, 'texmf-local', 'web2c')
envDict['TEXFORMATS'] = os.path.join(self.local.rapumaXetexFolder, 'texmf-local', 'web2c', 'xetex')
# To help with debugging the following hook has been added. This is not
# something the user would ever use. It is only for developer diagnostics.
# for infomation on what integers can be used refer to this URL:
# http://www.dcs.ed.ac.uk/home/latex/Informatics/Obsolete/html/kpathsea/kpathsea.html
debugXetex = self.projectConfig['Managers'][self.cType + '_Xetex'].get('debugKpse', None)
if debugXetex :
try :
if int(debugXetex) > 0 :
envDict['KPATHSEA_DEBUG'] = debugXetex
self.log.writeToLog(self.errorCodes['1000'], [str(debugXetex), str(envDict)])
except :
self.log.writeToLog(self.errorCodes['1090'], [debugXetex])
else :
envDict.update(os.environ)
# Create the XeTeX command argument list that subprocess.call() will run with
# the environment vars we set above
cmds = ['xetex', '-output-directory=' + self.local.projGidFolder, self.local.gidTexFile]
# For debugging purposes, output the following DBG message
if self.projectConfig['Managers'][self.cType + '_Xetex'].has_key('freezeTexSettings') and \
self.tools.str2bool(self.projectConfig['Managers'][self.cType + '_Xetex']['freezeTexSettings']) :
self.log.writeToLog(self.errorCodes['0620'], [os.getcwd(), str(envDict), " ".join(cmds)])
# Run the XeTeX and collect the return code for analysis
try :
rCode = subprocess.call(cmds, env = envDict)
# Analyse the return code
if rCode == int(0) :
self.log.writeToLog(self.errorCodes['0625'], [self.local.gidTexFileName])
elif rCode in self.xetexErrorCodes :
self.log.writeToLog(self.errorCodes['0630'], [self.local.gidTexFileName, self.xetexErrorCodes[rCode], str(rCode)])
else :
self.log.writeToLog(self.errorCodes['0635'], [str(rCode)])
except Exception as e :
# If subprocess fails it might be because XeTeX did not execute
# we will try to report back something useful
self.log.writeToLog(self.errorCodes['0615'], [str(e)])
# Collect the page count and record in group (Write out at the end of the opp.)
self.projectConfig['Groups'][gid]['totalPages'] = str(PdfFileReader(open(self.local.gidPdfFile)).getNumPages())
# Write out any changes made to the project.conf file that happened during this opp.
self.tools.writeConfFile(self.projectConfig)
# Pull out pages if requested (use the same file for output)
if pgRange :
self.tools.pdftkPullPages(self.local.gidPdfFile, self.local.gidPdfFile, pgRange)
# The gidPdfFile is the residue of the last render and if approved, can be
# used for the binding process. In regard to saving and file naming, the
# gidPdfFile will be copied but never renamed. It must remain intact.
# If the user wants to save this file or use a custom name, do that now
if save and not override :
saveFileName = self.pid + '_' + gid
if cidListSubFileName :
saveFileName = saveFileName + '_' + cidListSubFileName
if pgRange :
saveFileName = saveFileName + '_pg(' + pgRange + ')'
# Add date stamp
saveFileName = saveFileName + '_' + self.tools.ymd()
# Add render file extention
saveFileName = saveFileName + '.pdf'
# Save this to the Deliverable folder (Make sure there is one)
if not os.path.isdir(self.local.projDeliverableFolder) :
os.makedirs(self.local.projDeliverableFolder)
# Final file name and path
saveFile = os.path.join(self.local.projDeliverableFolder, saveFileName)
# Copy, no news is good news
if shutil.copy(self.local.gidPdfFile, saveFile) :
self.log.writeToLog(self.errorCodes['0730'], [saveFileName])
else :
self.log.writeToLog(self.errorCodes['0720'], [saveFileName])
# If given, the override file name becomes the file name
if override :
saveFile = override
# With shutil.copy(), no news is good news
if shutil.copy(self.local.gidPdfFile, saveFile) :
self.log.writeToLog(self.errorCodes['0730'], [saveFileName])
else :
self.log.writeToLog(self.errorCodes['0720'], [saveFileName])
# Once we know the file is successfully generated, add a background if defined
viewFile = ''
if self.useBackground :
if saveFile :
viewFile = self.pg_back.addBackground(saveFile)
else :
viewFile = self.pg_back.addBackground(self.local.gidPdfFile)
# Add a timestamp and doc info if requested in addition to background
if self.useDocInfo :
if saveFile :
if os.path.isfile(viewFile) :
viewFile = self.pg_back.addDocInfo(viewFile)
else :
viewFile = self.pg_back.addDocInfo(saveFile)
else :
if os.path.isfile(viewFile) :
viewFile = self.pg_back.addDocInfo(viewFile)
else :
viewFile = self.pg_back.addDocInfo(self.local.gidPdfFile)
# Add a diagnostic layer to the rendered output. Normally this is
# not used with a normal background layer
if self.useDiagnostic :
if saveFile :
viewFile = self.fmt_diagnose.addTransparency(saveFile)
else :
viewFile = self.fmt_diagnose.addTransparency(self.local.gidPdfFile)
# To avoid confusion with file names, if this is a saved file,
# and it has a background, we need to remove the original, non-
# background file (remembering originals are kept in the group
# Component folder), then rename the -view version to whatever
# the saved name should be
if save or override :
if os.path.isfile(saveFile) and os.path.isfile(viewFile) :
# First remove
os.remove(saveFile)
# Next rename
os.rename(viewFile, saveFile)
##### Viewing #####
# First get the right file name to view
if saveFile :
# If there was a saveFile, that will be the viewFile
viewFile = saveFile
else :
# The view file in this case is just temporary
if not os.path.isfile(viewFile) :
viewFile = self.local.gidPdfFile.replace(gid + '.pdf', gid + '-view.pdf')
shutil.copy(self.local.gidPdfFile, viewFile)
# Now view it
if os.path.isfile(viewFile) :
if self.pdfViewerCmd :
# Add the file to the viewer command
self.pdfViewerCmd.append(viewFile)
# Run the XeTeX and collect the return code for analysis
try :
subprocess.Popen(self.pdfViewerCmd)
return True
except Exception as e :
# If we don't succeed, we should probably quite here
self.log.writeToLog(self.errorCodes['1005'], [str(e)])
else :
self.log.writeToLog(self.errorCodes['0710'])
else :
self.log.writeToLog(self.errorCodes['0700'], [self.tools.fName(viewFile)])
# If we made it this far, return True
return True
class ProjProcess (object) :
def __init__(self, pid, gid = None, projectConfig = None) :
'''Intitate the whole class and create the object.'''
self.pid = pid
self.tools = Tools()
self.user = UserConfig()
self.userConfig = self.user.userConfig
if projectConfig :
self.projectConfig = projectConfig
else :
self.proj_config = Config(self.pid)
self.proj_config.getProjectConfig()
self.projectConfig = self.proj_config.projectConfig
self.local = ProjLocal(pid, gid, self.projectConfig)
self.log = ProjLog(pid)
# Log messages for this module
self.errorCodes = {
'0000' : ['MSG', 'Placeholder message'],
'XPRT-000' : ['MSG', 'Messages for export issues (probably only in project.py)'],
'XPRT-005' : ['MSG', 'Unassigned error message ID.'],
'XPRT-010' : ['ERR', 'Export file name could not be formed with available configuration information.'],
'XPRT-020' : ['ERR', 'Unable to export: [<<1>>].'],
'XPRT-030' : ['MSG', 'Files exported to [<<1>>].'],
'XPRT-040' : ['MSG', 'Beginning export, please wait...'],
'XPRT-050' : ['MSG', 'Unassigned error message ID.'],
'1210' : ['MSG', 'Processes completed successfully on: [<<1>>] by [<<2>>]'],
'1220' : ['ERR', 'Processes for [<<1>>] failed. Script [<<2>>] returned this error: [<<3>>]'],
'1240' : ['MSG', 'Component group preprocessing [<<1>>] for group [<<2>>].'],
'1260' : ['ERR', 'Installed the default component preprocessing script. Editing will be required for it to work with your project.'],
'1265' : ['LOG', 'Component preprocessing script is already installed.'],
}
###############################################################################
############################### Export Functions ##############################
###############################################################################
####################### Error Code Block Series = 0200 ########################
###############################################################################
# FIXME: This needs to be rewritten
#def export (self, cType, cName, path = None, script = None, bundle = False, force = False) :
#'''Facilitate the exporting of project text. It is assumed that the
#text is clean and ready to go and if any extraneous publishing info
#has been injected into the text, it will be removed by an appropreate
#post-process that can be applied by this function. No validation
#will be initiated by this function.'''
## FIXME - Todo: add post processing script feature
## Probably need to create the component object now
#self.createComponent(cName)
## Figure out target path
#if path :
#path = self.tools.resolvePath(path)
#else :
#parentFolder = os.path.dirname(self.local.projHome)
#path = os.path.join(parentFolder, 'Export')
## Make target folder if needed
#if not os.path.isdir(path) :
#os.makedirs(path)
## Start a list for one or more files we will process
#fList = []
## Will need the stylesheet for copy
#projSty = self.projectConfig['Managers'][cType + '_Style']['mainStyleFile']
#projSty = os.path.join(self.local.projStyleFolder, projSty)
## Process as list of components
#self.log.writeToLog('XPRT-040')
#for cid in self.components[cName].getSubcomponentList(cName) :
#cidCName = self.components[cName].getRapumaCName(cid)
#ptName = PT_Tools(self).formPTName(cName, cid)
## Test, no name = no success
#if not ptName :
#self.log.writeToLog('XPRT-010')
#self.tools.dieNow()
#target = os.path.join(path, ptName)
#source = os.path.join(self.local.projComponentFolder, cidCName, cid + '.' + cType)
## If shutil.copy() spits anything back its bad news
#if shutil.copy(source, target) :
#self.log.writeToLog('XPRT-020', [self.tools.fName(target)])
#else :
#fList.append(target)
## Start the main process here
#if bundle :
#archFile = os.path.join(path, cName + '_' + self.tools.ymd() + '.zip')
## Hopefully, this is a one time operation but if force is not True,
## we will expand the file name so nothing is lost.
#if not force :
#if os.path.isfile(archFile) :
#archFile = os.path.join(path, cName + '_' + self.tools.fullFileTimeStamp() + '.zip')
#myzip = zipfile.ZipFile(archFile, 'w', zipfile.ZIP_DEFLATED)
#for f in fList :
## Create a string object from the contents of the file
#strObj = StringIO.StringIO()
#for l in open(f, "rb") :
#strObj.write(l)
## Write out string object to zip
#myzip.writestr(self.tools.fName(f), strObj.getvalue())
#strObj.close()
## Close out the zip and report
#myzip.close()
## Clean out the folder
#for f in fList :
#os.remove(f)
#self.log.writeToLog('XPRT-030', [self.tools.fName(archFile)])
#else :
#self.log.writeToLog('XPRT-030', [path])
#return True
###############################################################################
########################## Text Processing Functions ##########################
###############################################################################
######################## Error Code Block Series = 1200 #######################
###############################################################################
def turnOnOffPreprocess (self, gid, onOff) :
'''Turn on or off preprocessing on incoming component text.'''
self.projectConfig['Groups'][gid]['usePreprocessScript'] = onOff
self.tools.writeConfFile(self.projectConfig)
self.log.writeToLog(self.errorCodes['1240'], [str(onOff), gid])
def checkForPreprocessScript (self, gid) :
'''Check to see if a preprocess script is installed. If not, install the
default script and give a warning that the script is not complete.'''
# First make sure the Scripts folder is there
if not os.path.isdir(self.local.projScriptFolder) :
os.makedirs(self.local.projScriptFolder)
# Check and copy if needed
if not os.path.isfile(self.local.groupPreprocessFile) :
shutil.copy(self.local.rpmPreprocessFile, self.local.groupPreprocessFile)
self.tools.makeExecutable(self.local.groupPreprocessFile)
self.log.writeToLog(self.errorCodes['1260'])
else :
self.log.writeToLog(self.errorCodes['1265'])
def runProcessScript (self, target, scriptFile) :
'''Run a text processing script on a component. This assumes the
component and the script are valid and the component lock is turned
off. If not, you cannot expect any good to come of this.'''
# subprocess will fail if permissions are not set on the
# script we want to run. The correct permission should have
# been set when we did the installation.
err = subprocess.call([scriptFile, target])
if err == 0 :
self.log.writeToLog(self.errorCodes['1210'], [self.tools.fName(target), self.tools.fName(scriptFile)])
else :
self.log.writeToLog(self.errorCodes['1220'], [self.tools.fName(target), self.tools.fName(scriptFile), str(err)])
return False
return True
def scriptInstall (self, source, target) :
'''Install a script. A script can be a collection of items in
a zip file or a single .py script file.'''
scriptTargetFolder, fileName = os.path.split(target)
if self.tools.isExecutable(source) :
shutil.copy(source, target)
self.tools.makeExecutable(target)
elif self.tools.fName(source).split('.')[1].lower() == 'zip' :
myZip = zipfile.ZipFile(source, 'r')
for f in myZip.namelist() :
data = myZip.read(f, source)
# Pretty sure zip represents directory separator char as "/" regardless of OS
myPath = os.path.join(scriptTargetFolder, f.split("/")[-1])
try :
myFile = open(myPath, "wb")
myFile.write(data)
myFile.close()
except :
pass
myZip.close()
return True
else :
self.tools.dieNow('Script is an unrecognized type: ' + self.tools.fName(source) + ' Cannot continue with installation.')
def installPostProcess (self, cType, script, force = None) :
'''Install a post process script into the main components processing
folder for a specified component type. This script will be run on
every file of that type that is imported into the project. Some
projects will have their own specially developed post process
script. Use the "script" var to specify a process (which should be
bundled in a system compatable way). If "script" is not specified
we will copy in a default script that the user can modify. This is
currently limited to Python scripts only which do in-place processes
on the target files. The script needs to have the same name as the
zip file it is bundled in, except the extention is .py instead of
the bundle .zip extention.'''
# Define some internal vars
Ctype = cType.capitalize()
oldScript = ''
scriptName = os.path.split(script)[1]
scriptSourceFolder = os.path.split(script)[0]
scriptTarget = os.path.join(self.local.projScriptFolder, self.tools.fName(script).split('.')[0] + '.py')
if scriptName in self.projectConfig['CompTypes'][Ctype]['postprocessScripts'] :
oldScript = scriptName
# First check for prexsisting script record
if not force :
if oldScript :
self.log.writeToLog('POST-080', [oldScript])
return False
# In case this is a new project we may need to install a component
# type and make a process (components) folder
if not self.components[cType] :
self.tools.addComponentType(self.projectConfig, self.local, cType)
# Make the target folder if needed
if not os.path.isdir(self.local.projScriptFolder) :
os.makedirs(self.local.projScriptFolder)
# First check to see if there already is a script file, return if there is
if os.path.isfile(scriptTarget) and not force :
self.log.writeToLog('POST-082', [self.tools.fName(scriptTarget)])
return False
# No script found, we can proceed
if not os.path.isfile(scriptTarget) :
self.scriptInstall(script, scriptTarget)
if not os.path.isfile(scriptTarget) :
self.tools.dieNow('Failed to install script!: ' + self.tools.fName(scriptTarget))
self.log.writeToLog('POST-110', [self.tools.fName(scriptTarget)])
elif force :
self.scriptInstall(script, scriptTarget)
if not os.path.isfile(scriptTarget) :
self.tools.dieNow('Failed to install script!: ' + self.tools.fName(scriptTarget))
self.log.writeToLog('POST-115', [self.tools.fName(scriptTarget)])
# Record the script with the cType post process scripts list
scriptList = self.projectConfig['CompTypes'][Ctype]['postprocessScripts']
if self.tools.fName(scriptTarget) not in scriptList :
self.projectConfig['CompTypes'][Ctype]['postprocessScripts'] = self.tools.addToList(scriptList, self.tools.fName(scriptTarget))
self.tools.writeConfFile(self.projectConfig)
return True
def removePostProcess (self, cType) :
'''Remove (actually disconnect) a preprocess script from a
component type. This will not actually remove the script. That
would need to be done manually. Rather, this will remove the
script name entry from the component type so the process cannot
be accessed for this specific component type.'''
Ctype = cType.capitalize()
# Get old setting
old = self.projectConfig['CompTypes'][Ctype]['postprocessScripts']
# Reset the field to ''
if old != '' :
self.projectConfig['CompTypes'][Ctype]['postprocessScripts'] = ''
self.tools.writeConfFile(self.projectConfig)
self.log.writeToLog('POST-130', [old,Ctype])
else :
self.log.writeToLog('POST-135', [cType.capitalize()])
return True
class ProjData (object) :
def __init__(self, pid, gid = None) :
'''Intitate the whole class and create the object.'''
self.pid = pid
self.gid = gid
self.tools = Tools()
self.user = UserConfig()
self.userConfig = self.user.userConfig
self.local = ProjLocal(pid)
self.log = ProjLog(pid)
self.projHome = os.path.join(os.path.expanduser(self.userConfig['Resources']['projects']), self.pid)
self.projList = self.tools.getProjIdList(os.path.expanduser(self.userConfig['Resources']['projects']))
# Log messages for this module
self.errorCodes = {
'1220' : ['LOG', 'Project [<<1>>] already registered in the system.'],
'1240' : ['ERR', 'Could not find/open the Project configuration file for [<<1>>]. Project could not be registered!'],
'3410' : ['LOG', 'Backup file cull skipping: [<<1>>] Not a recognized Rapuma backup file name format.'],
'3510' : ['ERR', 'The path (or name) given is not valid: [<<1>>].'],
'3530' : ['MSG', 'Project backup: [<<1>>] has been restored to: [<<2>>]. A backup of the orginal project remains and must be manually removed.'],
'3550' : ['ERR', 'Project backup version request: [<<1>>] exceeds the maxium number which could be in storage which is: [<<2>>]. Request an earlier (lesser) version.'],
'3610' : ['ERR', 'The [<<1>>]. project is not registered. No backup was done.'],
'3620' : ['ERR', 'The path to the backup folder is not valid [<<1>>]. Please try again.'],
'3622' : ['ERR', 'The path to the backup folder is not set. Please set it and try again.'],
'3625' : ['ERR', 'The path given to the backup folder is not valid [<<1>>]. Please set the system backup path.'],
'3630' : ['MSG', 'Backup for [<<1>>] created and saved to: [<<2>>]'],
'4110' : ['MSG', 'Completed merging data.'],
'4120' : ['MSG', 'No files updated.'],
'4130' : ['MSG', 'Added: <<1>> file(s).'],
'4140' : ['MSG', 'Updated: <<1>> file(s)'],
'4150' : ['WRN', 'The project data in: [<<1>>] will be replaced with the data from: [<<2>>].'],
'4210' : ['MSG', 'Completed pulling/restoring data from the cloud.'],
'4220' : ['ERR', 'Cannot resolve path: [<<1>>]'],
'4250' : ['ERR', 'The cloud project [<<1>>] you want to pull from is owned by [<<2>>]. Use force (-f) to pull the project and change the local owner ID.'],
'4260' : ['ERR', 'The local project [<<1>>] is newer than the cloud copy. If you seriously want to overwrite it, use force (-f) to do so.'],
'4270' : ['MSG', 'Restored the project [<<1>>] from the cloud copy. Local copy is owned by [<<2>>].'],
}
###############################################################################
############################## General Functions ##############################
###############################################################################
####################### Error Code Block Series = 1000 ########################
###############################################################################
###############################################################################
########################## Archive Project Functions ##########################
###############################################################################
####################### Error Code Block Series = 2000 ########################
###############################################################################
def makeExcludeFileList (self, source) :
'''Return a list of files that are not necessary to be included in a backup
template or an archive. These will be all auto-generated files that containe system-
specific paths, etc.'''
excludeFiles = []
excludeTypes = ['delayed', 'log', 'notepages', 'parlocs', 'pdf', 'tex', 'piclist', 'adj', 'zip']
excludeFolders = ['Draft', 'Final', 'HelperScript', 'Proof']
# Process the excluded folders
for root, dirs, files in os.walk(source) :
for fileName in files :
if os.path.basename(root) in excludeFolders :
excludeFiles.append(os.path.join(root, fileName))
else :
# Get rid of edited backup files
if fileName[-1] == '~' :
excludeFiles.append(os.path.join(root, fileName))
continue
ext = os.path.splitext(fileName)[1][1:]
if ext in excludeTypes :
# A special indicator for file we want to keep
if fileName.find('-ext.') > 0 :
continue
return excludeFiles
# FIXME: Should archiveProject() use self.pid instead of explicitly passing in a pid?
def archiveProject (self, pid, path = None) :
'''Archive a project. Send the compressed archive file to the user-specified
archive folder. If none is specified, put the archive in cwd. If a valid
path is specified, send it to that location. Like backup, this too will
overwrite any existing file of the same name. The difference is that this
will also disable the project so it cannot be accesses by Rapuma. When a
project is archived, all work should cease on the project.'''
# Make a private project object just for archiving
aProject = Project(pid, self.gid)
# Set some paths and file names
archName = aProject.projectIDCode + '.rapuma'
userArchives = self.userConfig['Resources']['archive']
archTarget = ''
if path :
path = self.tools.resolvePath(path)
if os.path.isdir(path) :
archTarget = os.path.join(path, archName)
else :
self.tools.terminal('\nError: The path given is not valid: [' + path + ']\n')
self.tools.dieNow()
elif os.path.isdir(userArchives) :
archTarget = os.path.join(userArchives, archName)
elif os.path.isdir(os.path.dirname(aProject.local.projHome)) :
# Default to the dir just above the project
archTarget = os.path.dirname(aProject.local.projHome)
else :
self.tools.terminal('\nError: Cannot resolve a path to create the archive file!\n')
self.tools.dieNow()
# Get a list of files we don't want
excludeFiles = self.makeExcludeFileList(source)
self.zipUpProject(archTarget, excludeFiles)
# Rename the source dir to indicate it was archived
bakArchProjDir = aProject.local.projHome + '(archived)'
if os.path.isdir(bakArchProjDir) :
self.tools.terminal('\nError: Cannot complete archival process!\n')
self.tools.terminal('\nAnother archived version of this project exsits with the folder name of: ' + self.tools.fName(bakArchProjDir) + '\n')
self.tools.terminal('\nPlease remove or rename it and then repete the process.\n')
self.tools.dieNow()
else :
os.rename(aProject.local.projHome, bakArchProjDir)
# Finish here
self.tools.terminal('Archive for [' + pid + '] created and saved to: ' + archTarget + '\n')
def zipUpProject (self, target, excludeFiles = None) :
'''Zip up a project and deposit it to target location. Be sure to strip
out all all auto-created, user-specific files that could mess up a
transfer to another system. This goes for archives and backups'''
# import pdb; pdb.set_trace()
# In case an exclude list is not given
if not excludeFiles :
excludeFiles = []
# Do the zip magic here
root_len = len(self.local.projHome)
with zipfile.ZipFile(target, 'w', compression=zipfile.ZIP_DEFLATED) as myzip :
sys.stdout.write('Backing up files')
sys.stdout.flush()
for root, dirs, files in os.walk(self.local.projHome) :
# Chop off the part of the path we do not need to store
zip_root = os.path.abspath(root)[root_len:]
for f in files :
if os.path.join(root, f) in excludeFiles :
continue
if not f[-1] == '~' :
fn, fx = os.path.splitext(f)
fullpath = os.path.join(root, f)
zip_name = os.path.join(zip_root, f)
sys.stdout.write('.')
sys.stdout.flush()
myzip.write(fullpath, zip_name, zipfile.ZIP_DEFLATED)
# Add a space before the next message
print '\n'
# FIXME: Should restoreArchive() use self.pid instead of explicitly passing in a pid?
def restoreArchive (self, pid, targetPath, sourcePath = None) :
'''Restore a project from the user specified storage area or sourcePath if
specified. Use targetPath to specify where the project will be restored.
Rapuma will register the project there.'''
# Check to see if the user included the extension
try :
pid.split('.')[1] == 'rapuma'
archName = pid
pid = pid.split('.')[0]
except :
archName = pid + '.rapuma'
archSource = ''
archTarget = ''
userArchives = ''
# First look for the archive that is to be restored
if sourcePath :
if os.path.isdir(sourcePath) :
archSource = os.path.join(sourcePath, archName)
elif os.path.isdir(self.userConfig['Resources']['archive']) :
userArchives = self.userConfig['Resources']['archive']
archSource = os.path.join(userArchives, archName)
else :
self.tools.terminal('\nError: The path (or name) given is not valid: [' + archSource + ']\n')
self.tools.dieNow()
# Now set the target params
if targetPath :
if not os.path.isdir(targetPath) :
self.tools.terminal('\nError: The path given is not valid: [' + targetPath + ']\n')
self.tools.dieNow()
else :
archTarget = os.path.join(targetPath, pid)
# If we made it this far, extract the archive
with zipfile.ZipFile(archSource, 'r') as myzip :
myzip.extractall(archTarget)
# Permission for executables is lost in the zip, fix it here
for folder in ['Scripts', os.path.join('Macros', 'User')] :
self.tools.fixExecutables(os.path.join(archTarget, folder))
# FIXME: This will need some work
# Add project to local Rapuma project registry
# To do this we need to open up the restored project config file
# and pull out some settings.
local = ProjLocal(pid)
pc = Config(pid)
log = ProjLog(pid)
aProject = Project(pid, self.gid)
# import pdb; pdb.set_trace()
# Finish here
self.tools.terminal('\nRapuma archive [' + pid + '] has been restored to: ' + archTarget + '\n')
###############################################################################
########################### Backup Project Functions ##########################
###############################################################################
####################### Error Code Block Series = 3000 ########################
###############################################################################
def cullBackups (self, maxBak, bakDir) :
'''Remove any excess backups from the backup folder in
this project.'''
# Get number of maximum backups to store
maxStoreBackups = int(maxBak)
if not maxStoreBackups or maxStoreBackups == 0 :
maxStoreBackups = 1
# Build the cullList
cullList = []
files = os.listdir(bakDir)
for f in files :
try :
cullList.append(int(f.split('.')[0]))
except :
self.log.writeToLog(self.errorCodes['3410'], [f])
# Remove oldest file(s)
while len(cullList) > maxStoreBackups :
fn = min(cullList)
cullList.remove(min(cullList))
os.remove(os.path.join(bakDir, str(fn) + '.zip'))
def backupProject (self, targetPath=None) :
'''Backup a project. Send the compressed backup file with a date-stamp
file name to the user-specified backup folder. If a target path is
specified, put the archive there but use the PID in the name. If other
backups with the same name exist there, increment with a number.'''
# First see if this is even a valid project
if self.pid not in self.projList :
self.log.writeToLog(self.errorCodes['3610'], [self.pid])
# Set some paths and file names
if not targetPath :
# Now check for a valid location to backup to
if self.local.userLibBackup == '' :
self.log.writeToLog(self.errorCodes['3622'])
elif not os.path.exists(self.local.userLibBackup) :
self.log.writeToLog(self.errorCodes['3620'], [self.local.userLibBackup])
projBackupFolder = os.path.join(self.local.userLibBackup, self.pid)
backupTarget = os.path.join(projBackupFolder, self.tools.fullFileTimeStamp() + '.zip')
else :
projBackupFolder = self.tools.resolvePath(targetPath)
# Now check for a valid target path
if not os.path.exists(projBackupFolder) :
self.log.writeToLog(self.errorCodes['3625'], [targetPath])
backupTarget = self.tools.incrementFileName(os.path.join(projBackupFolder, self.pid + '.zip'))
# Make sure the dir is there
if not os.path.exists(projBackupFolder) :
os.makedirs(projBackupFolder)
# import pdb; pdb.set_trace()
# Zip up but use a list of files we don't want
self.zipUpProject(backupTarget, self.makeExcludeFileList(source))
# Cull out any excess backups
if not targetPath :
self.cullBackups(self.userConfig['System']['maxStoreBackups'], projBackupFolder)
# Finish here
pc = Config(self.pid)
pc.getProjectConfig()
pc.projectConfig['Backup']['lastBackup'] = self.tools.fullFileTimeStamp()
self.tools.writeConfFile(pc.projectConfig)
self.log.writeToLog(self.errorCodes['3630'], [self.pid,backupTarget])
return True
def backupRestore (self, backup, target = None) :
'''Restore a backup to the current or specified project.'''
# import pdb; pdb.set_trace()
if not target :
target = self.local.projHome
# Now remove the orginal
if os.path.exists(target) :
shutil.rmtree(target)
# Create an empty folder to restore to
os.makedirs(target)
# If we made it this far, extract the archive
with zipfile.ZipFile(backup, 'r') as myzip :
myzip.extractall(target)
return True
# def restoreLocalBackup (self, bakFile) :
# '''Restore from a project backup. As a project may have multiple backups in
# its backup folder, the user will need to provide a number from 1 to n (n being
# the number of backups in the folder, 1 being the most recent and n being the
# oldest). If no number is provided, 1, (the most recent) will be restored.'''
# # Adjust bNum if needed
# maxBak = int(self.userConfig['System']['maxStoreBackups'])
# if not bNum :
# bNum = 0
# else :
# bNum = int(bNum)
# if bNum <= 0 :
# bNum = 0
# elif bNum > maxBak :
# self.log.writeToLog(self.errorCodes['3550'], [str(bNum), str(maxBak)])
# else :
# bNum = bNum-1
# # Get vals we need
# projHome = self.getProjHome()
# projBackupFolder = self.tools.resolvePath(os.path.join(self.userConfig['Resources']['backup'], self.pid))
# # Get the archive file name
# files = os.listdir(projBackupFolder)
# fns = []
# for f in files :
# fns.append(int(f.split('.')[0]))
# # Sort the list, last (latest) first
# fns.sort(reverse=True)
# # Make file path/name
# backup = os.path.join(projBackupFolder, str(fns[bNum]) + '.zip')
# if not os.path.exists(backup) :
# self.log.writeToLog(self.errorCodes['3510'], [backup])
# # Restore the backup
# self.backupRestore(backup, projHome)
# # Permission for executables is lost in the zip, fix them here
# self.tools.fixExecutables(projHome)
# # Add helper scripts if needed
# if self.tools.str2bool(self.userConfig['System']['autoHelperScripts']) :
# ProjCommander(self.pid).updateScripts()
# # Finish here (We will leave the project backup in place)
# self.log.writeToLog(self.errorCodes['3530'], [self.tools.fName(backup),projHome])
def restoreExternalBackup (self, source, target = None, force = False) :
'''Restore a non-existant project from an external backup to a target folder.
If no target is provided the project will be installed in the default project
folder. The source path and ZIP file must be valid'''
# Get/make the (localized) project home reference
projHome = self.getProjHome(target)
# import pdb; pdb.set_trace()
# Create the source backup file name
# source = os.path.join(source, self.pid + '.zip')
# FIXME: This needs some review and rework
# Restore the backup
if self.backupRestore(source, projHome) :
# Permission for executables is lost in the zip, fix them here
self.tools.fixExecutables(projHome)
# If this is a new project we will need to register it now
self.registerProject(projHome)
# Add helper scripts if needed
if self.tools.str2bool(self.userConfig['System']['autoHelperScripts']) :
ProjCommander(self.pid).updateScripts()
# Finish here (We will leave the backup-backup in place)
self.tools.terminal('\nRapuma backup [' + self.pid + '] has been restored to: ' + projHome + '\n')
return True
###############################################################################
############################ Cloud Backup Functions ###########################
###############################################################################
####################### Error Code Block Series = 4000 ########################
###############################################################################
def isNewerThanCloud (self, cloud, projectConfig) :
'''Compare time stamps between the cloud and the local project.
Return True if the local project is newer or the same age as
the copy in the cloud. Return True if the project does not
exist in the local copy of the cloud.'''
# First see if it exists
cConfig = self.getConfig(cloud)
if not cConfig :
return True
elif not cConfig.has_key('Backup') :
return True
elif not cConfig['Backup'].has_key('lastCloudPush') :
return True
# Check local for key
if not projectConfig.has_key('Backup') :
return False
elif not projectConfig['Backup'].has_key('lastCloudPush') :
return False
# Compare if we made it this far
cStamp = cConfig['Backup']['lastCloudPush']
lStamp = projectConfig['Backup']['lastCloudPush']
if lStamp >= cStamp :
return True
def isNewerThanLocal (self, cloud, projectConfig) :
'''Compare time stamps between the cloud and the local project.
Return True if the cloud project is newer or the same age as
the local copy. Return True if the project does not exist in
as a local copy.'''
# First see if the local exists
if not projectConfig :
return True
# See if cloud is there and up-to-date
cloudConfig = self.getConfig(cloud)
if not cloudConfig :
return False
# Compare if we made it this far
cStamp = cloudConfig['Backup']['lastCloudPush']
# It is possible the local has never been pushed
# If that is the case, local is assumed older
try :
pStamp = projectConfig['Backup']['lastCloudPush']
except :
return False
if cStamp >= pStamp :
return True
def getConfig (self, projHome) :
'''Return a valid config object from cloud project.'''
# import pdb; pdb.set_trace()
projectConfigFile = os.path.join(projHome, 'Config', 'project.conf')
if os.path.exists(projectConfigFile) :
return ConfigObj(projectConfigFile, encoding='utf-8')
def getCloudOwner (self, cloud) :
'''Return the owner of a specified cloud project.'''
try :
return self.getConfig(cloud)['Backup']['ownerID']
except :
return None
def getLocalOwner (self) :
'''Return the owner of a specified cloud project.'''
return self.userConfig['System']['userID']
def sameOwner (self, cloud) :
'''Return True if the owner of a given cloud is the same as
the system user. Also return True if the cloud owner is not
present.'''
# First check for existence
if not self.getCloudOwner(cloud) :
return True
# Compare if we made it to this point
if self.getCloudOwner(cloud) == self.getLocalOwner() :
return True
def setCloudPushTime (self, projectConfig) :
'''Set/reset the lastPush time stamp setting.'''
projectConfig['Backup']['lastCloudPush'] = self.tools.fullFileTimeStamp()
self.tools.writeConfFile(projectConfig)
def buyCloud (self, projectConfig) :
'''Change the ownership on a project in the cloud by assigning
your userID to the local project cloudOwnerID. Then, using force
the next time the project is pushed to the cloud, you will own it.'''
projOwnerID = self.userConfig['System']['userID']
projectConfig['Backup']['ownerID'] = projOwnerID
self.tools.writeConfFile(projectConfig)
def buyLocal (self, projectConfig) :
'''Change the ownership on a local project by assigning your
userID to it.'''
projOwnerID = self.userConfig['System']['userID']
projectConfig['Backup']['ownerID'] = projOwnerID
self.tools.writeConfFile(projectConfig)
def replaceProject (self, source, target) :
'''This will completly replace an existing project (target)
with data from another project (source). This assumes
source and target are valid.'''
# We simply just get rid of the target before doing a merge
shutil.rmtree(target)
self.log.writeToLog(self.errorCodes['4150'], [target, source])
self.mergeProjects(source, target)
def mergeProjects(self, source, target) :
'''This will merge two Rapuma projects and try to preserve
data in the target that is newer than the source. This assumes
target and source are valid.'''
# Get a list of files we do not want
excludeFiles = self.makeExcludeFileList(source)
# Get a total list of files from the project
cn = 0
cr = 0
# Add space for output message
sys.stdout.write('\n')
sys.stdout.write('Merging files from: ' + source + ' to: ' + target)
sys.stdout.flush()
for folder, subs, files in os.walk(source):
for fileName in files:
# Do not include any backup files we find
if fileName[-1] == '~' :
continue
if os.path.join(folder, fileName) not in excludeFiles :
if not os.path.isdir(folder.replace(source, target)) :
os.makedirs(folder.replace(source, target))
targetFile = os.path.join(folder, fileName).replace(source, target)
sourceFile = os.path.join(folder, fileName)
if not os.path.isfile(targetFile) :
sys.stdout.write('.')
sys.stdout.flush()
shutil.copy(sourceFile, targetFile)
cn +=1
# Otherwise if the cloud file is older than
# the project file, refresh it
elif self.tools.isOlder(targetFile, sourceFile) :
if os.path.isfile(targetFile) :
os.remove(targetFile)
sys.stdout.write('.')
sys.stdout.flush()
shutil.copy(sourceFile, targetFile)
cr +=1
# Add space for next message
sys.stdout.write('\n')
# Report what happened
self.log.writeToLog(self.errorCodes['4110'])
if cn == 0 and cr == 0 :
self.log.writeToLog(self.errorCodes['4120'])
else :
if cn > 0 :
self.log.writeToLog(self.errorCodes['4130'], [str(cn)])
if cr > 0 :
self.log.writeToLog(self.errorCodes['4140'], [str(cr)])
return True
def getProjHome (self, tPath = None) :
'''Return a project home path by checking to see what the best path
might be. Provided path gets first dibs, then '''
if tPath :
if os.path.isfile(tPath) :
return self.local.projHome
elif self.tools.resolvePath(tPath) :
tPath = self.tools.resolvePath(tPath)
lastFolder = os.path.basename(tPath)
if lastFolder == self.pid :
return tPath
else :
return os.path.join(tPath, self.pid)
else :
self.log.writeToLog(self.errorCodes['4220'], [tPath])
elif self.local.projHome :
return self.local.projHome
else :
return self.tools.resolvePath(os.path.join(self.userConfig['Resources']['projects'], self.pid))
class ProjHyphenation (object) :
def __init__(self, pid, gid=None) :
'''Do the primary initialization for this class.'''
# import pdb; pdb.set_trace()
self.pid = pid
self.gid = gid
self.tools = Tools()
self.local = ProjLocal(pid)
self.user = UserConfig()
self.userConfig = self.user.userConfig
self.proj_config = Config(pid, gid)
self.proj_config.getProjectConfig()
self.projectConfig = self.proj_config.projectConfig
self.log = ProjLog(pid)
self.hyphenationOn = self.tools.str2bool(self.projectConfig['ProjectInfo']['hyphenationOn'])
# Get lid and sid, if these do not exist, we need to catch it during processing
self.plid = self.projectConfig['ProjectInfo']['languageCode']
self.psid = self.projectConfig['ProjectInfo']['scriptCode']
if gid :
self.glid = self.projectConfig['Groups'][gid]['groupLanguageCode']
self.gsid = self.projectConfig['Groups'][gid]['groupScriptCode']
# Determine the prefix for the target files, this should match the
# system for everthing to work.
if gid :
if self.glid and self.gsid :
self.prefix = self.glid + '-' + self.gsid + '_'
else :
self.prefix = self.plid + '-' + self.psid + '_'
else :
self.prefix = self.plid + '-' + self.psid + '_'
# File names
self.rpmHyphCharTexFile = self.local.rpmHyphCharTexFile
self.rpmHyphExcTexFile = self.local.rpmHyphExcTexFile
self.rpmHyphSetTexFile = self.local.rpmHyphSetTexFile
# Folder paths
self.projHyphenationFolder = self.local.projHyphenationFolder
self.rapumaHyphenationFolder = self.local.rapumaHyphenationFolder
# Log messages for this module
self.errorCodes = {
'0000' : ['MSG', 'Placeholder message'],
'1100' : ['ERR', 'Language and/or writing system codes for the project have not been properly set. Please set these values before continuing. Check Hyphenation documentation for more information.'],
'1200' : ['ERR', 'The path and/or file name given does not appear to be valid: [<<1>>]'],
'1300' : ['ERR', 'Rapuma is looking for a file named: [<<1>>], it cannot be found. Are all the files correctly named? Check Hyphenation documentation for more information.'],
'1400' : ['ERR', 'One or more hyphenation files were found in this project. Please use "remove" to get them out first, then "add" to replace with the files you want.'],
'1500' : ['MSG', 'Copied file: [<<1>>] to folder: [<<2>>]'],
'1550' : ['ERR', 'Copied file failed for file: [<<1>>]'],
'1600' : ['MSG', 'Added hyphenation files to the project.'],
'2000' : ['LOG', 'When trying to remove hyphenation files, this file was not found: [<<1>>]'],
'2100' : ['LOG', 'Set ProjectInfo/hyphenationOn to False, turning off hyphenation for the project.'],
'2600' : ['MSG', 'Removed all hyphenation files from the project.'],
'3500' : ['MSG', 'Updated file: [<<1>>]'],
'3600' : ['MSG', 'The updating of hyphenation files is complete.']
}
# Build some file names that are shared by other functions and modules
# Note these names will not be any good if the lid and sid are not there.
self.projHyphExcTexFile = os.path.join(self.projHyphenationFolder, self.prefix + self.tools.fName(self.rpmHyphExcTexFile))
self.projHyphCharTexFile = os.path.join(self.projHyphenationFolder, self.prefix + self.tools.fName(self.rpmHyphCharTexFile))
self.projHyphSetTexFile = os.path.join(self.projHyphenationFolder, self.prefix + self.tools.fName(self.rpmHyphSetTexFile))
self.projHyphFiles = [self.projHyphCharTexFile, self.projHyphExcTexFile, self.projHyphSetTexFile]
self.baseFileNames = [self.tools.fName(self.rpmHyphCharTexFile), self.tools.fName(self.rpmHyphExcTexFile), self.tools.fName(self.rpmHyphSetTexFile)]
###############################################################################
############################ Hyphenation Functions ############################
###############################################################################
######################## Error Code Block Series = 1000 #######################
###############################################################################
def crossCheckSettings (self) :
'''Cross check settings and die here if we are missing anything.'''
# May need to add more things to check
if not self.plid or not self.psid :
self.log.writeToLog(self.errorCodes['1100'])
def addHyphenationFiles (self, path = None) :
'''Import necessary hyphenation files from the specified path.
If no path is given and a file is not found in the project,
create place holder file(s) that the user will modify.'''
self.crossCheckSettings()
# If needed, logically assemble the target file names. This is what
# Rapuma is expecting to see.
if path :
# Check to see if the path given is valid. It should only be a folder, not a file.
if not os.path.isdir(path) :
self.log.writeToLog(self.errorCodes['1200'], [path])
# Check to see if the files we need are at the specified location
for f in self.baseFileNames :
if not os.path.isfile(os.path.join(path, self.prefix + f)) :
self.log.writeToLog(self.errorCodes['1300'], [self.prefix + f])
# Check to see if any of the hyphenation files are present
# in the project. If there are any, hault the process and advise
# the user to remove them first.
for f in self.baseFileNames :
if os.path.isfile(os.path.join(self.projHyphenationFolder, self.prefix, f)) :
self.log.writeToLog(self.errorCodes['1400'], [self.prefix + f])
# If we make it this far we should be good to go
if not os.path.isdir(self.projHyphenationFolder) :
os.makedirs(self.projHyphenationFolder)
if path :
# Copy user provided files
for f in self.baseFileNames :
if not shutil.copy(os.path.join(path, self.prefix + f), self.projHyphenationFolder) :
self.log.writeToLog(self.errorCodes['1500'], [f, self.projHyphenationFolder])
# Double check that it happened
if not os.path.isfile(os.path.join(path, self.prefix + f)) :
self.log.writeToLog(self.errorCodes['1550'], [f])
else :
# Copy system model files
for f in self.baseFileNames :
if not shutil.copy(os.path.join(self.rapumaHyphenationFolder, f), os.path.join(self.projHyphenationFolder, self.prefix + f)) :
self.log.writeToLog(self.errorCodes['1500'], [self.prefix + f, self.projHyphenationFolder])
# Double check that it happened
if not os.path.isfile(os.path.join(self.projHyphenationFolder, self.prefix + f)) :
self.log.writeToLog(self.errorCodes['1550'], [f])
# Report and return
self.log.writeToLog(self.errorCodes['1600'])
return True
def removeHyphenationFiles (self) :
'''Remove all the hyphenation files from the hyphenation folder.
This is currently not smart enough to turn off hyphenation at the
group level but will switch off hyphenation at the project level
to avoid problems at rendering time.'''
self.crossCheckSettings()
for f in self.projHyphFiles :
if os.path.isfile(f) :
os.remove(f)
else :
self.log.writeToLog(self.errorCodes['2000'], [self.tools.fName(f)])
# Just to be safe, turn off hyphenation for the project if needed
if self.hyphenationOn == True :
self.projectConfig['ProjectInfo']['hyphenationOn'] = 'False'
self.tools.writeConfFile(self.projectConfig)
self.log.writeToLog(self.errorCodes['2100'])
# Report and return
self.log.writeToLog(self.errorCodes['2600'])
return True
def updateHyphenationFiles (self, path) :
'''Update all the hyphenation files for a language in a project.
Add any that are not in the target folder. Overwrite any that are
in the target folder. Skip any that are not in the source path.
A path must be specified.'''
self.crossCheckSettings()
# Bulk update using all valid files found in a valid folder
if os.path.isdir(path) :
# Look for and copy the files to be updated in this folder.
for f in self.baseFileNames :
if os.path.isfile(os.path.join(path, self.prefix + f)) :
if not shutil.copy(os.path.join(path, self.prefix + f), os.path.join(self.projHyphenationFolder, self.prefix + f)) :
self.log.writeToLog(self.errorCodes['1500'], [self.prefix + f, self.projHyphenationFolder])
# Double check that it happened
if not os.path.isfile(os.path.join(self.projHyphenationFolder, self.prefix + f)) :
self.log.writeToLog(self.errorCodes['1550'], [f])
# Update using a single valid file
elif os.path.isfile(path) :
copied = False
# Validate file name
for f in self.baseFileNames :
if self.prefix + f == self.tools.fName(path) :
if not shutil.copy(path, self.prefix + f) :
self.log.writeToLog(self.errorCodes['1500'], [self.prefix + f, self.projHyphenationFolder])
# Double check that it happened
if not os.path.isfile(os.path.join(self.projHyphenationFolder, self.prefix + f)) :
self.log.writeToLog(self.errorCodes['1550'], [f])
# Neither file or folder found, throw error
else :
self.log.writeToLog(self.errorCodes['1200'], [path])
# Report and return
self.log.writeToLog(self.errorCodes['3600'])
return True