#!/usr/bin/python3 """ Run as: python3 thisscript.py "/bundles/directory" "/website/template/root/directory/ All sub-directories of bundles directory will be scanned for activity bundles i.e. .xo files. """ import glob import json import os import shutil import sys from urllib.parse import quote as strToHtmlFmt import zipfile from GeneralFunctions.DataStructureManipulations import ( StrListToDictionary ) from GeneralFunctions.InputOutput import ( WriteTextFiles, WriteBinaryToFile ) from GeneralFunctions.OS import CreateDir """ FIXME: paths hard coded UNIX style & most likely will not work on Windows. Use code written for IMM to handle it. """ class extractData: def findInfoFiles(self, bundle): infoFiles = [] for File in bundle.namelist(): if File.endswith("activity/activity.info"): infoFiles.append(File) return infoFiles def copyBundle(self, bundleSrc, activityName): shutil.copy2( bundleSrc, self.websiteDir+"bundles/"+activityName+".xo" ) def createDirectories(self): assert CreateDir(self.websiteDir+"app") assert CreateDir(self.websiteDir+"icons") assert CreateDir(self.websiteDir+"bundles") assert CreateDir(self.websiteDir+"js") def extractActivityInfo(self, infoFilePath, zipFile): infoList = [] infoList = zipFile.read( infoFilePath).decode("utf-8").split('\n') return StrListToDictionary(infoList) def extractInfoAndIconFromBundles(self): for bundlePath in self.activityBundles: bundle = zipfile.ZipFile(bundlePath, "r") infoFiles = self.findInfoFiles(bundle) if len(infoFiles) != 1: self.bundlesNotExactlyOneInfoFile.append(bundlePath) else: infoDict = self.extractActivityInfo(infoFiles[0], bundle) self.bundlesInfoList.append(infoDict) # FIXME: create seprate function for it # extract and copy icon activityName = infoDict.get("name") if type(activityName) == str: iconRelativePath = infoDict.get("icon") if type(iconRelativePath) == str: iconFolder = infoFiles[0][:infoFiles[0].rfind("/")+1] iconAbsolutePath = ( iconFolder+iconRelativePath+".svg") if iconAbsolutePath in bundle.namelist(): icon = bundle.read(iconAbsolutePath) iconPath = ( self.websiteDir+"icons/" + activityName + ".svg" ) WriteBinaryToFile(iconPath, icon) else: # Continue without icon since non-fatal error self.iconErrorBundles.append(bundlePath) bundle.close() # FIXME: uncomment below function. # Disabled sometime during development as time consuming self.copyBundle(bundlePath, activityName) bundle.close() def findBundles(self): self.activityBundles = glob.glob( self.bundlesDir+"**/*.xo", recursive=True ) def generateAppsHtmlPages(self): iconsDir = "../icons/" bundlesDir = "../bundles/" for appInfo in self.indexDictList: pathName = strToHtmlFmt(appInfo["name"], safe='') html = ( '\n\n\n' + appInfo["name"] + '\n\n\n\n\n' '\n

' + appInfo["name"] + '

\n' '

Summary

' + appInfo["summary"] + '

Description

' + appInfo["description"] + '

Tags' '

' + tag + '

Download

\n
\n\n' ) WriteTextFiles( self.websiteDir+"./app/" + appInfo["name"] + ".html", html ) """ Only those which are specified in map will be added to index. If an entry or value does not exist in infoJSON than empty entry will be created for it. appends keys rather than replacing where multiple map to same """ # FIXME: Simplify logic: replace str, tuple, list etc. with 'string' & 'array' def generateIndex( self, infoToIndexMap={ "name": ("name", "string"), "summary": ("summary", "string"), "description": ("description", "string"), "tag": ("tags", "array"), "tags": ("tags", "array"), "categories": ("tags", "array"), "category": ("tags", "array") } ): unexpectedInputError = ( "main.py generateIndex() : expect only str, list or tuple as " "kwargs -> value[1] but found " ) i2IMap = infoToIndexMap for obj in json.loads(self.infoJson): indexDict = {} for k, v in obj.items(): if k in i2IMap: # add new entry/key to app index if k not in indexDict: if i2IMap[k][1] == "string": indexDict[i2IMap[k][0]] = v elif i2IMap[k][1] == "array": if v.find(';') >= 0: indexDict[i2IMap[k][0]] = v.split(';') else: indexDict[i2IMap[k][0]] = v.split() # Append to existing entry/key to app index else: if i2IMap[k][1] == "string": indexDict[i2IMap[k][0]] += ' '+v elif i2IMap[k][1] == "array": if v.find(';') >= 0: indexDict[i2IMap[k][0]] += v.split(';') else: indexDict[i2IMap[k][0]] += v.split() else: print(unexpectedInputError, i2IMap[k][1]) sys.exit(1) # Create entry/key with empty value for keys not present # in activity.info for k, v in i2IMap.items(): if v[0] not in indexDict: if v[1] == "string": indexDict[v[0]] = "" elif v[1] == "array": indexDict[v[0]] = () else: print(unexpectedInputError, v[1]) sys.exit(1) self.indexDictList.append(indexDict) self.indexJs = ( "search.assignIndex(" + json.dumps(self.indexDictList, indent=4) + ")" ) def generateInfoJson(self): self.infoJson = json.dumps(self.bundlesInfoList, indent=4) def __init__(self, bundlesDir, websiteDir): """ FIXME: WARNING:: some files may be missing such as some app may not have icon (use a placeholder icon for them) Some bundles are not successfully processed (html page + bundle copy) but are not in error logs as well. There are 495 bundles in Tony's repo, 479 successfully processed but showing fatal error of 12 only, i.e. 4 missing. """ self.bundlesDir = bundlesDir self.websiteDir = websiteDir self.activityBundles = [] self.bundlesNotZipFiles = [] self.bundlesNotExactlyOneInfoFile = [] self.bundlesInfoList = [] self.infoJson = '' self.indexDictList = [] self.miscErrorBundles = [] self.iconErrorBundles = [] self.createDirectories() self.findBundles() self.purgeBundlesNotZipFile() self.extractInfoAndIconFromBundles() self.generateInfoJson() self.generateIndex() self.generateAppsHtmlPages() self.writeFiles() #self.copyBundles() def purgeBundlesNotZipFile(self): activityBundles = [] for bundle in self.activityBundles: if zipfile.is_zipfile(bundle): activityBundles.append(bundle) else: self.bundlesNotZipFiles.append(bundle) self.activityBundles = activityBundles def writeFiles(self): """ Files which are not continuously written during the process Eg. Html, icon and bundles are written while processing each bundle """ WriteTextFiles(self.websiteDir+"info.json", self.infoJson) WriteTextFiles(self.websiteDir+"js/index.js", self.indexJs) WriteTextFiles( self.websiteDir+"bundlesNotExactlyOneInfoFile.txt", self.bundlesNotExactlyOneInfoFile ) WriteTextFiles( self.websiteDir+"bundlesNotZipFiles.txt", self.bundlesNotZipFiles ) WriteTextFiles( self.websiteDir+"miscErrorBundles.txt", self.miscErrorBundles ) WriteTextFiles( self.websiteDir+"iconErrorBundles.txt", self.iconErrorBundles ) def processArguments(): variables = {} if len(sys.argv) == 3: variables["programDir"] = os.path.dirname( os.path.realpath(sys.argv[0]))+'/' variables["bundlesDir"] = os.path.realpath(sys.argv[1])+'/' variables["websiteDir"] = os.path.realpath(sys.argv[2])+'/' else: print( "Please give exactly two arguments to program.\n" "1. root directory of all activity bundles to be included " "in website\n" "2. root directory of website template\n" ) sys.exit(1) return variables def main(): variables = processArguments() extractData(variables["bundlesDir"], variables["websiteDir"]) if __name__ == "__main__": main()