Merge pull request #31 from gcsolaroli/master

Updated build scripts

4 files changed, 29 insertions, 13 deletions

diff --git a/backend/php/properties/php.properties.json b/backend/php/properties/php.properties.json
index 8ce703a..dd25b09 100644
--- a/backend/php/properties/php.properties.json
+++ b/backend/php/properties/php.properties.json
@@ -1,9 +1,9 @@
 {
         "request.path": "index.php",
-        "should.pay.toll": "false"
+        "should.pay.toll": "false",
 
         "development.settings": {
                 "url": "http://localhost/php/clipperz"
         }
 
-}
\ No newline at end of file
+}
diff --git a/scripts/builder/backendBuilder.py b/scripts/builder/backendBuilder.py
index 3e61955..5b91678 100644
--- a/scripts/builder/backendBuilder.py
+++ b/scripts/builder/backendBuilder.py
@@ -1,118 +1,131 @@
 #!/usr/bin/env python
 # -*- coding: UTF-8 -*-
 
 import sys, os, json
 import shutil
 import hashlib
 
 import main
 
 #===================================================================
 
 
 class BackendBuilder(object):
         
         def __init__ (self, projectTargetDir, frontends, versions, settings):
                 self.projectTargetDir = projectTargetDir
                 self.frontends = frontends
                 self.versions = versions
                 self.settings = settings
 
         # --------------------------------------------------------------------------
         
         def name (self):
                 raise NotImplementedError()
 
         
         def relativePath (self):
                 raise NotImplementedError()
 
         
         def compileCode (self):
                 raise NotImplementedError()
 
         
         def createPackage (self):
                 raise NotImplementedError()
 
         # --------------------------------------------------------------------------
 
         def sourceFolder (self):
                 return os.path.join(main.projectBaseDir() , 'backend', self.relativePath(), 'src')
 
 
         def tempFolder (self):
                 return os.path.join(self.projectTargetDir, '.tmp', self.relativePath())
                 
 
         def frontEndTempFolder (self):
                 return self.tempFolder()
 
 
         def developmentTargetFolder (self):
                 return os.path.join(self.projectTargetDir, 'development', self.relativePath())
 
         def targetFolder (self):
                 return os.path.join(self.projectTargetDir, self.relativePath())
                 
         # --------------------------------------------------------------------------
         
         def writeToFolder (self, folder, filename, content):
                 file = open(os.path.join(folder, filename), 'w')
                 file.write(content.encode('utf-8'))
                 file.close()
                 
 
         def configureIndexContent (self, indexContent, requestPathPrefix = ".."):
                 result = indexContent
                 result = result.replace( '@request.path@',    requestPathPrefix + '/' + self.settings['request.path']    )
                 result = result.replace( '@should.pay.toll@', self.settings['should.pay.toll'] )
 
                 return result
         
 
         def logChecksums (self, content, message):
                         md5Digest       = hashlib.md5(content.encode('utf-8')).hexdigest()
                         shaDigest       = hashlib.sha1(content.encode('utf-8')).hexdigest()
                         sha256Digest= hashlib.sha256(content.encode('utf-8')).hexdigest()
                 print message + ": " + md5Digest + " (md5)"
                 print message + ": " + shaDigest + " (sha1)"
                 print message + ": " + sha256Digest + " (sha256)"
                 
         
         def shouldCompileCode (self):
                 return ('debug' in self.versions) or ('install' in self.versions)
 
 
         def run (self):
                 print self.name() + " - RUN"
 
                 if self.shouldCompileCode():
                         self.compileCode()
                 
                         for frontend in self.frontends:
+                                if (frontend.module == frontend.submodule):
+                                        submoduleExtension = ''
+                                else:
+                                        submoduleExtension = '.' + frontend.submodule
+
                                 main.createFolder(os.path.join(self.frontEndTempFolder(), frontend.module))
 
                                 if 'debug' in self.versions:
                                         frontend.copyResourcesToFolder(self.frontEndTempFolder())
 
                                         index = self.configureIndexContent(frontend.assemble(assemblyMode='DEBUG', versionType='DEBUG'))
-                                        self.writeToFolder(self.frontEndTempFolder(), os.path.join(frontend.module, 'index_debug.html'), index)
+                                        self.writeToFolder(self.frontEndTempFolder(), os.path.join(frontend.module, 'index_debug' + submoduleExtension + '.html'), index)
                                 
                                 if 'install' in self.versions:
                                         index = self.configureIndexContent(frontend.assemble())
-                                        self.writeToFolder(self.frontEndTempFolder(), os.path.join(frontend.module, 'index.html'), index)
+                                        self.writeToFolder(self.frontEndTempFolder(), os.path.join(frontend.module, 'index' + submoduleExtension + '.html'), index)
 
-                                        self.logChecksums(index, "[" + self.name() + " - " + frontend.module + "] index.html checksum")
+                                        self.logChecksums(index, "[" + self.name() + " - " + frontend.module + "] index" + submoduleExtension + ".html checksum")
                         
                         self.createPackage()
 
                 if 'development' in self.versions:
                         for frontend in self.frontends:
+                                if (frontend.module == frontend.submodule):
+                                        submoduleExtension = ''
+                                else:
+                                        submoduleExtension = '.' + frontend.submodule
+
+                                print "FRONTEND module: " + frontend.module
+                                print "FRONTEND submodule: " + frontend.submodule
+
                                 main.createFolder(os.path.join(self.developmentTargetFolder(), frontend.module))
 
                                 index = self.configureIndexContent(frontend.assemble(assemblyMode='DEVELOPMENT', versionType='DEBUG'), self.settings['development.settings']['url'])
-                                self.writeToFolder(self.developmentTargetFolder(), os.path.join(frontend.module, 'index.html'), index)
+                                self.writeToFolder(self.developmentTargetFolder(), os.path.join(frontend.module, 'index' + submoduleExtension + '.html'), index)
 
         
 #===================================================================
diff --git a/scripts/builder/frontendBuilder.py b/scripts/builder/frontendBuilder.py
index dae837b..1f0f92f 100644
--- a/scripts/builder/frontendBuilder.py
+++ b/scripts/builder/frontendBuilder.py
@@ -1,389 +1,390 @@
 #!/usr/bin/env python
 # -*- coding: UTF-8 -*-
 
 import sys, os, re
 import cssmin
 import jsmin
 import codecs
 import shutil
 import StringIO
 import urllib
 
 import main
 
 class FrontendBuilder(object):
 
         def __init__ (self, frontend, settings, repositoryVersion):
                 if '.' in frontend:
                         moduleComponents = frontend.split('.')
                         self.module = moduleComponents[0]
                         self.submodule = moduleComponents[1]
                 else:
                         self.module = frontend
                         self.submodule = frontend
 
                 self.settings = settings
                 self.projectDir = main.projectBaseDir()
                 # self.repository = repository.repositoryWithPath(self.projectDir)
                 self.repositoryVersion = repositoryVersion
                 self.processedFiles = {}
                 
 
         def log (self, message):
                 print "frontend [" + self.module + "]: " + message
         
 
         def absolutePathForSources (self):
                 return os.path.join(self.projectDir, 'frontend', self.module)
 
         
         def absolutePathForSourceFile (self, basePath, file):
                 return os.path.join(self.absolutePathForSources(), basePath, file)
         
 
         def absolutePathForTargetFile (self, folder, basePath, file):
                 return os.path.join(folder, self.module, basePath, file)
 
 
         def filterFiles (self, files):
                 result = []
                 
                 for file in files:
                         if file.startswith('--'):
                                 pass
                         else:
                                 result.append(file)
                         
                 return result
         
 
         def copyResources (self, sourceFolder, destinationFolder, fileType):
                 for file in self.filterFiles(self.settings[fileType]):
                         src = self.absolutePathForSourceFile(fileType, file)
                         dst = self.absolutePathForTargetFile(destinationFolder, fileType, file)
                         main.createFolder(os.path.dirname(dst))
                         shutil.copy2(src, dst)
                 
 
         def copyResourcesToFolder (self, targetFolder):
                 self.copyResources(self.projectDir, targetFolder, 'css')
                 self.copyResources(self.projectDir, targetFolder, 'js')
         
 
         def loadFilesContent (self, basePath, files):
                 result = ""
                 
                 for file in self.filterFiles(files):
                         try:
                                 fileHandler = codecs.open(self.absolutePathForSourceFile(basePath, file), 'r', 'utf-8')
                         except:
                                 print "FILE: " + file
 
                         result += fileHandler.read() + '\n'
                         fileHandler.close()
                         
                 return result
         
 
         def template (self):
                 processedFile = 'html_template'
                 if not self.processedFiles.has_key(processedFile):
-                        self.processedFiles[processedFile] = self.loadFilesContent('html', ['index_template.html'])
+                        #self.processedFiles[processedFile] = self.loadFilesContent('html', ['index_template.html'])
+                        self.processedFiles[processedFile] = self.loadFilesContent('html', [self.settings['html.template']])
                         
                 return self.processedFiles[processedFile]
         
 
         def cssminCompressor (self, css):
                 # package found here:
                 # - http://stackoverflow.com/questions/222581/python-script-for-minifying-css/2396777#2396777
                 # actual downloaded version: http://pypi.python.org/pypi/cssmin/0.1.4
                 return cssmin.cssmin(css)
         
 
         def regexCssCompressor (self, css):
                 # http://stackoverflow.com/questions/222581/python-script-for-minifying-css/223689#223689
                 
                 # remove comments - this will break a lot of hacks :-P
                 css = re.sub( r'\s*/\*\s*\*/', "$$HACK1$$", css ) # preserve IE<6 comment hack
                 css = re.sub( r'/\*[\s\S]*?\*/', "", css )
                 css = css.replace( "$$HACK1$$", '/**/' ) # preserve IE<6 comment hack
 
                 # url() doesn't need quotes
                 css = re.sub( r'url\((["\'])([^)]*)\1\)', r'url(\2)', css )
 
                 # spaces may be safely collapsed as generated content will collapse them anyway
                 css = re.sub( r'\s+', ' ', css )
 
                 # shorten collapsable colors: #aabbcc to #abc
                 css = re.sub( r'#([0-9a-f])\1([0-9a-f])\2([0-9a-f])\3(\s|;)', r'#\1\2\3\4', css )
 
                 # fragment values can loose zeros
                 css = re.sub( r':\s*0(\.\d+([cm]m|e[mx]|in|p[ctx]))\s*;', r':\1;', css )
 
                 for rule in re.findall( r'([^{]+){([^}]*)}', css ):
 
                     # we don't need spaces around operators
                     selectors = [re.sub( r'(?<=[\[\(>+=])\s+|\s+(?=[=~^$*|>+\]\)])', r'', selector.strip() ) for selector in rule[0].split( ',' )]
 
                     # order is important, but we still want to discard repetitions
                     properties = {}
                     porder = []
                     for prop in re.findall( '(.*?):(.*?)(;|$)', rule[1] ):
                         key = prop[0].strip().lower()
                         if key not in porder: porder.append( key )
                         properties[ key ] = prop[1].strip()
                 
                     # output rule if it contains any declarations
                     if properties:
                         print "%s{%s}" % ( ','.join( selectors ), ''.join(['%s:%s;' % (key, properties[key]) for key in porder])[:-1] )
                 
                 return css
         
 
         def compressCSS (self, css):
                 self.log("compressing CSS")
                 #return self.regexCssCompressor(css)
                 return self.cssminCompressor(css)
         
 
         #==========================================================================
 
         def compressJS_jsmin (self, js, description):
                 self.log("compressing " + description + " code")
                 original = StringIO.StringIO(js)
                 output = StringIO.StringIO()
                 
                 jsMinifier = jsmin.JavascriptMinify()
                 jsMinifier.minify(original, output)
                 
                 result = output.getvalue()
                 
                 original.close()
                 output.close()
                 
                 return result
 
         def compressJS_closureCompiler (self, js, description):
                         #Googles Closure compiler
                         #java -jar compiler.jar --js=in1.js --js=in2.js ... --js_output_file=out.js
                 
                 result = js
                 
                 return result
         
 
         def compressJS (self, js, description):
                 return self.compressJS_jsmin(js, description)
                 #return self.compressJS_closureCompiler(js, description)
         
 
         #==========================================================================
 
         def packBookmarklet (self, bookmakeletCode, version):
                 replacers = [
                                 ('isLoginForm',                         'ilf'),
                                 ('findLoginForm',               'flf'),
                                 ('findLoginForm',               'flf'),
                                 ('formParameters',              'fp' ),
                                 ('pageParameters',              'pp' ),
                                 ('serializeJSON',               'sj' ),
                                 ('reprString',                  'rs' ),
                                 ('logFormParameters',   'lfp'),
                                 ('loadClipperzBookmarklet','lcb'),
                                 ('loginForm',                   'lf' ),
                                 ('parameters',                  'p'  ),
                                 ('inputElementValues',  'iev'),
                 ]
                 result = self.compressJS(bookmakeletCode, version + " bookmarklet")
                 
                         result = re.sub('\n', ' ', result)      #Fit all in a single line
                         # result = re.sub('\s+', ' ', result)   #Collapse "redundant" spaces. WARNING: this could have some evil side effects on constant strings used inside to code!!
                 # result = re.sub('\s?([,\+=\(\)\{\};])\s?', '\\1', result)
                 
                 for replacer in replacers:
                         result = re.sub(replacer[0], replacer[1], result)
                 
         #               <!--    escaping required to handle the bookmarklet code within the javascript code     -->
                         result = re.sub('\://',                 '%3a%2f%2f',result)
                         result = re.sub('/',            '%2f',          result)
         #               result = re.sub('"',            '%22',          result)
                         result = re.sub('"',            '\\"',          result)
                         result = re.sub('\"',           '%22',          result)
                         result = re.sub('\'',           '%22',          result)
                         result = re.sub('\\\\',                 '%5c',          result)
                 result = result.strip()
                 result = 'javascript:' + result
 
         #       replacers = [
         #                       ('aForm',                       '_1' ),
         #                       ('inputFields',                 '_2' ),
         #                       ('passwordFieldsFound','_3' ),
         #                       ('aDocument',           '_6' ),
         #                       ('aLevel',                      '_7' ),
         #               #       ('result',                      '_8' ),
         #                       ('documentForms',       '_9' ),
         #                       ('iFrames',                     '_c' ),
         #                       ('anInputElement',      '_d' ),
         #                       ('options',                     '_f' ),
         #                       ('option',                      '_12'),
         #                       ('aLoginForm',          '_13'),
         #               #       ('action',                      '_17'),
         #                       ('radioValues',                 '_18'),
         #                       ('radioValueName',      '_19'),
         #                       ('inputElement',        '_1a'),
         #                       ('elementValues',       '_1b'),
         #                       ('radioValue',          '_1c'),
         #                       ('values',                      '_1d'),
         #                       ('objtype',                     '_21'),
         #                       ('useKey',                      '_27'),
         #                       ('bookmarkletDiv',      '_28'),
         #                       ('someParameters',      '_29'),
         #                       ('anException',                 '_2a'),
         #                       ('newDiv',                      '_2b'),
         #                       ('base_url',            '_2c'),
         #                       ('help_url',            '_2d'),
         #                       ('logo_image_url',      '_2e'),
         #               ('background_image_url','_2f'),
         #                       ('close_image_url',     '_30'),
         #               #('bookmarklet_textarea','_31'),
         #                       ('innerHTML',           '_32'),
         #       ]
         #       for replacer in replacers:
         #               result = re.sub('([^\.])' + replacer[0], '\\1' + replacer[1], result)
 
         #       replacers = [
         #                       ('headNode',            '_1' ),
         #                       ('clipperzScriptNode','_2' ),
         #       ]
         #       for replacer in replacers:
         #               result = re.sub('([^\.])' + replacer[0], '\\1' + replacer[1], result)
 
         #       result = re.sub(';', ';\n', result)
                 
                 return result
                 
         
 
         def bookmarklet (self):
                 cacheKey = 'bookmarklet'
                 if not self.processedFiles.has_key(cacheKey):
                         result = 'bookmarklet="' + self.packBookmarklet(self.loadFilesContent('js', ['Bookmarklet.js']), "regular") + '";bookmarklet_ie="' + self.packBookmarklet(self.loadFilesContent('js', ['Bookmarklet_IE.js']), "IE") + '";'
                         self.processedFiles[cacheKey] = result
                 else:
                         result = self.processedFiles[cacheKey]
                 
                 return result
         
 
         def replaceTemplatePlaceholders (self, pageTitle, copyright, css, code, jsLoadMode, version, versionType):
                 result = self.template()
                 
                         result = result.replace('@page.title@',                                         pageTitle,      1)
                         result = result.replace('@copyright@',                                  copyright,      1)
                         result = result.replace('@css@',                                                css,            1)
                         #result = result.replace('@bookmarklet@',                               bookmarklet,1)
                         result = result.replace('@application.version@',                version,        1)
                         result = result.replace('@application.version.type@',   versionType,1)
                         result = result.replace('@js_' + jsLoadMode + '@',              code,           1)
 
                 result = re.sub('@js_[^@]+@', '', result)
 
                 return result
         
 
         def assembleCopyrightHeader (self):
                 processedFile = 'copyright'
                 if not self.processedFiles.has_key(processedFile):
                         #self.log("assembling copyright header")
                         copyrightValues = self.settings['copyright.values']
                         license = self.loadFilesContent('../../properties', ['license.txt'])
                         result  = self.loadFilesContent('properties', ['creditsAndCopyrights.txt'])
                         
                         result = re.sub('@clipperz.license@', license, result)
                         for key in copyrightValues:
                                 result = re.sub('@'+key+'@', copyrightValues[key], result)
                         
                         self.processedFiles[processedFile] = result
                         
                 return self.processedFiles[processedFile]
         
 
         def cssTagsForFiles (self, basePath, files):
                 #<link rel="stylesheet" type="text/css" href="./css/reset-min.css" />
                 return '\n'.join(map(lambda file: '<link rel="stylesheet" type="text/css" href="' + basePath + '/' + file + '" />', files))
         
 
         def cssTagForContent (self, content):
                 return '<style type="text/css">' + content + '</style>'
         
 
         def scriptTagsForFiles (self, basePath, files):
                 #<script type='text/javascript' src='./js/src/bookmarklet.js'></script>
-                return '\n'.join(map(lambda file: '<script type="text/javascript" src="' + basePath + '/' + file + '"></script>', files))
+                return '\n'.join(map(lambda file: '<script type="text/javascript" src="' + basePath + '/' + file + '" charset="utf-8"></script>', files))
         
 
         def scriptTagForContent (self, content):
                 return '<script>' + content + '</script>'
         
 
         def assembleVersion (self, pageTitle, copyright, css, js, jsLoadMode, version, versionType):
                 cacheKey = version + "-" + versionType
                 if not self.processedFiles.has_key(cacheKey):
                         result = self.replaceTemplatePlaceholders(pageTitle, copyright, css, js, jsLoadMode, version, versionType)
                         self.processedFiles[cacheKey] = result
                 else:
                         result = self.processedFiles[cacheKey]
                 
                 #self.log("# cacheKey:\n" + result)
                 return result
         
 
         def assemble (self, assemblyMode='INSTALL', versionType='LIVE'):
 
                 if versionType == 'LIVE':
                         pageTitle = "Clipperz - " + self.module
                 else:
                         pageTitle = "Clipperz - " + self.module + " [" + versionType + " - " + assemblyMode +"]"
 
                 if assemblyMode == 'INSTALL':
                         copyright = self.assembleCopyrightHeader()
                                 css     =self.cssTagForContent(self.compressCSS(self.loadFilesContent('css', self.settings['css'])))
                                 js      =self.scriptTagForContent(
                                                 self.bookmarklet() +
                                                 '\n' +
                                                 self.compressJS(self.loadFilesContent('js', self.settings['js']), "application")
                                         )
                         jsLoadMode = 'EMBEDDED'
 
                 elif assemblyMode == 'DEBUG':
                         copyright = self.assembleCopyrightHeader()
                                 css     =self.cssTagsForFiles('./css', self.filterFiles(self.settings['css']))
                                 js      =self.scriptTagForContent(self.bookmarklet()) + \
                                          '\n' + \
                                         self.scriptTagsForFiles('./js', self.filterFiles(self.settings['js']))
                         jsLoadMode = 'LINKED'
 
                 elif assemblyMode == 'DEVELOPMENT':
                         copyright = ""
                                 css     =self.cssTagsForFiles('file://' + str(os.path.join(self.absolutePathForSources(), 'css')), self.filterFiles(self.settings['css']))
                                 js      =self.scriptTagForContent(self.bookmarklet()) + \
                                          '\n' + \
                                         self.scriptTagsForFiles('file://' + str(os.path.join(self.absolutePathForSources(), 'js')), self.filterFiles(self.settings['js']))
                         jsLoadMode = 'LINKED'
 
                 else:
                         raise NotImplementedError()
 
                 return self.assembleVersion(
                                 pageTitle       = pageTitle,
                                 copyright       = copyright,
                                 css                     = css,
                                 js                      = js,
                                 jsLoadMode      = jsLoadMode,
                                 version                 = self.repositoryVersion,
                                 versionType     = versionType
                 )
 
 
 
 
diff --git a/scripts/builder/repository.py b/scripts/builder/repository.py
index 89db9a5..f8528c2 100644
--- a/scripts/builder/repository.py
+++ b/scripts/builder/repository.py
@@ -1,75 +1,77 @@
 #!/usr/bin/env python
 # -*- coding: UTF-8 -*-
 
 
 def repositoryWithPath (path):
         try:
-                from dulwich.repo import Repo
+                from git import Repo
 
                 repo = Repo(path)
                 result = GitRepository(repo, path)
-        except:
+        except ImportError:
+                print "Failed to import git, please install http://gitorious.org/git-python"
+        #except:
                 from mercurial import ui, hg
 
                 repo = hg.repository(ui.ui(), path)
                 result = HgRepository(repo, path)
 
         return result
 
 
 #===================================================================
 
 
 class Repository(object):
 
         def __init__ (self, repository, path):
                 self.repository = repository
                 self.path = path
 
 
         def revision (self):
                 raise NotImplementedError()
         
 
         def areTherePendingChanges (self):
                 raise NotImplementedError()
 
 
         def version (self):
                 result = self.revision()
                 if self.areTherePendingChanges():
                         result = '>>> ' + result + ' <<<'
 
                 # print "VERSION: " + result
                 return result
 
 
 #===================================================================
 
 
 class GitRepository(Repository):
 
         def revision (self):
-                return repository.refs['HEAD']
-        
+                return self.repository.head.commit.hexsha
+
 
         def areTherePendingChanges (self):
-                return repository.is_dirty()
+                return self.repository.is_dirty()
 
 
 #===================================================================
 
 
 class HgRepository(Repository):
                 #http://mercurial.selenic.com/wiki/MercurialApi
 
         def revision (self):
                 return 'hg:' + str(self.repository['tip'])
         
 
         def areTherePendingChanges (self):
                 # TODO: FIXME: repository.status() does not report 'unknown(?)' files. :(
                 return not all(map(lambda fileList: len(fileList) == 0, self.repository.status()))
 
 
 #===================================================================