'''This file contains basic classes that will be added into any user application for creating the basic structure of the application "Tool" which is the set of web pages used for configuring the application.''' # ------------------------------------------------------------------------------ import types import appy.gen as gen # Prototypical instances of every type ----------------------------------------- class Protos: protos = {} # List of attributes that can't be given to a Type constructor notInit = ('id', 'type', 'pythonType', 'slaves', 'isSelect', 'hasLabel', 'hasDescr', 'hasHelp', 'required', 'filterable', 'validable', 'isBack', 'sync', 'pageName', 'masterName') @classmethod def get(self, appyType): '''Returns a prototype instance for p_appyType.''' className = appyType.__class__.__name__ isString = (className == 'String') if isString: # For Strings, we create one prototype per format, because default # values may change according to format. className += str(appyType.format) if className in self.protos: return self.protos[className] # The prototype does not exist yet: create it if isString: proto = appyType.__class__(format=appyType.format) # Now, we fake to be able to detect default values proto.format = 0 else: proto = appyType.__class__() self.protos[className] = proto return proto # ------------------------------------------------------------------------------ class ModelClass: '''This class is the abstract class of all predefined application classes used in the Appy model: Tool, User, etc. All methods and attributes of those classes are part of the Appy machinery and are prefixed with _appy_ in order to avoid name conflicts with user-defined parts of the application model.''' # In any ModelClass subclass we need to declare attributes in the following # list (including back attributes), to keep track of attributes order. _appy_attributes = [] folder = False @classmethod def _appy_getTypeBody(klass, appyType, wrapperName): '''This method returns the code declaration for p_appyType.''' typeArgs = '' proto = Protos.get(appyType) for name, value in appyType.__dict__.iteritems(): # Some attrs can't be given to the constructor if name in Protos.notInit: continue # If the given value corresponds to the default value, don't give it if value == getattr(proto, name): continue if name == 'layouts': # For Tool attributes we do not copy layout info. Indeed, most # fields added to the Tool are config-related attributes whose # layouts must be standard. if klass.__name__ == 'Tool': continue layouts = appyType.getInputLayouts() # For the Translation class that has potentially thousands of # attributes, the most used layout is cached in a global var in # named "tfw" in wrappers.py. if (klass.__name__ == 'Translation') and \ (layouts == '{"edit":"f","cell":"f","view":"f",}'): value = 'tfw' else: value = appyType.getInputLayouts() elif (name == 'klass') and value and (value == klass): # This is a auto-Ref (a Ref that references the klass itself). # At this time, we can't reference the class that is still being # defined. So we initialize it to None. The post-init of the # field must be done manually in wrappers.py. value = 'None' elif isinstance(value, basestring): value = '"%s"' % value elif isinstance(value, gen.Ref): if not value.isBack: continue value = klass._appy_getTypeBody(value, wrapperName) elif type(value) == type(ModelClass): moduleName = value.__module__ if moduleName.startswith('appy.gen'): value = value.__name__ else: value = '%s.%s' % (moduleName, value.__name__) elif isinstance(value, gen.Selection): value = 'Selection("%s")' % value.methodName elif isinstance(value, gen.Group): value = 'Grp("%s")' % value.name elif isinstance(value, gen.Page): value = 'pges["%s"]' % value.name elif callable(value): className = wrapperName if (appyType.type == 'Ref') and appyType.isBack: className = value.im_class.__name__ value = '%s.%s' % (className, value.__name__) typeArgs += '%s=%s,' % (name, value) return '%s(%s)' % (appyType.__class__.__name__, typeArgs) @classmethod def _appy_getBody(klass): '''This method returns the code declaration of this class. We will dump this in wrappers.py in the Zope product.''' className = klass.__name__ # Determine the name of the class and its wrapper. Because so much # attributes can be generated on a TranslationWrapper, shortcutting it # to 'TW' may reduce the generated file from several kilobytes. if className == 'Translation': wrapperName = 'WT' else: wrapperName = 'W%s' % className res = 'class %s(%s):\n' % (className, wrapperName) # Tool must be folderish if klass.folder: res += ' folder=True\n' # First, scan all attributes, determine all used pages and create a # dict with it. It will prevent us from creating a new Page instance # for every field. pages = {} layouts = [] for name in klass._appy_attributes: exec 'appyType = klass.%s' % name if appyType.page.name not in pages: pages[appyType.page.name] = appyType.page res += ' pges = {' for page in pages.itervalues(): # Determine page show pageShow = page.show if isinstance(pageShow, basestring): pageShow='"%s"' % pageShow elif callable(pageShow): pageShow = '%s.%s' % (wrapperName, pageShow.__name__) res += '"%s":Pge("%s", show=%s),'% (page.name, page.name, pageShow) res += '}\n' # Secondly, dump every (not Ref.isBack) attribute for name in klass._appy_attributes: exec 'appyType = klass.%s' % name if (appyType.type == 'Ref') and appyType.isBack: continue typeBody = klass._appy_getTypeBody(appyType, wrapperName) res += ' %s=%s\n' % (name, typeBody) return res # The User class --------------------------------------------------------------- class User(ModelClass): _appy_attributes = ['title', 'name', 'firstName', 'login', 'password1', 'password2', 'email', 'roles', 'source', 'groups', 'toTool'] # All methods defined below are fake. Real versions are in the wrapper. title = gen.String(show=False, indexed=True) gm = {'group': 'main', 'width': 25} def showName(self): pass name = gen.String(show=showName, **gm) firstName = gen.String(show=showName, **gm) def showEmail(self): pass email = gen.String(show=showEmail, **gm) # Where is this user stored? By default, in the ZODB. But the user can be # stored in an external LDAP (source='ldap'). source = gen.String(show=False, default='zodb', layouts='f', **gm) gm['multiplicity'] = (1,1) def showLogin(self): pass def validateLogin(self): pass login = gen.String(show=showLogin, validator=validateLogin, indexed=True, **gm) def showPassword(self): pass def validatePassword(self): pass password1 = gen.String(format=gen.String.PASSWORD, show=showPassword, validator=validatePassword, **gm) password2 = gen.String(format=gen.String.PASSWORD, show=showPassword, **gm) gm['multiplicity'] = (0, None) def showRoles(self): pass roles = gen.String(show=showRoles, indexed=True, validator=gen.Selection('getGrantableRoles'), **gm) # The Group class -------------------------------------------------------------- class Group(ModelClass): _appy_attributes = ['title', 'login', 'roles', 'users', 'toTool2'] # All methods defined below are fake. Real versions are in the wrapper. m = {'group': 'main', 'width': 25, 'indexed': True} title = gen.String(multiplicity=(1,1), **m) def showLogin(self): pass def validateLogin(self): pass login = gen.String(show=showLogin, validator=validateLogin, multiplicity=(1,1), **m) roles = gen.String(validator=gen.Selection('getGrantableRoles'), multiplicity=(0,None), **m) users = gen.Ref(User, multiplicity=(0,None), add=False, link=True, back=gen.Ref(attribute='groups', show=User.showRoles, multiplicity=(0,None)), showHeaders=True, shownInfo=('title', 'login')) # The Translation class -------------------------------------------------------- class Translation(ModelClass): _appy_attributes = ['po', 'title', 'sourceLanguage', 'trToTool'] # All methods defined below are fake. Real versions are in the wrapper. title = gen.String(show=False, indexed=True) actionsPage = gen.Page('actions') def getPoFile(self): pass po = gen.Action(action=getPoFile, page=actionsPage, result='filetmp') sourceLanguage = gen.String(page=actionsPage, width=4) def label(self): pass def show(self, name): pass # The Page class --------------------------------------------------------------- class Page(ModelClass): _appy_attributes = ['title', 'content', 'pages', 'parent', 'toTool3'] folder = True title = gen.String(show='edit', multiplicity=(1,1), indexed=True) content = gen.String(format=gen.String.XHTML, layouts='f') # Pages can contain other pages. def showSubPages(self): pass pages = gen.Ref(None, multiplicity=(0,None), add=True, link=False, back=gen.Ref(attribute='parent', show=False), show=showSubPages, navigable=True) Page.pages.klass = Page setattr(Page, Page.pages.back.attribute, Page.pages.back) # The Tool class --------------------------------------------------------------- # Prefixes of the fields generated on the Tool. toolFieldPrefixes = ('podTemplate', 'formats', 'resultColumns', 'numberOfSearchColumns', 'searchFields') defaultToolFields = ('title', 'mailHost', 'mailEnabled', 'mailFrom', 'appyVersion', 'dateFormat', 'hourFormat', 'users', 'connectedUsers', 'groups', 'translations', 'loadTranslationsAtStartup', 'pages', 'unoEnabledPython', 'openOfficePort', 'numberOfResultsPerPage') class Tool(ModelClass): # In a ModelClass we need to declare attributes in the following list. _appy_attributes = list(defaultToolFields) folder = True # Tool attributes def isManager(self): pass def isManagerEdit(self): pass lf = {'layouts':'f'} title = gen.String(show=False, page=gen.Page('main', show=False), default='Configuration', **lf) mailHost = gen.String(default='localhost:25', **lf) mailEnabled = gen.Boolean(default=False, **lf) mailFrom = gen.String(default='info@appyframework.org', **lf) appyVersion = gen.String(**lf) dateFormat = gen.String(default='%d/%m/%Y', **lf) hourFormat = gen.String(default='%H:%M', **lf) # Ref(User) will maybe be transformed into Ref(CustomUserClass). userPage = gen.Page('users', show=isManager) users = gen.Ref(User, multiplicity=(0,None), add=True, link=False, back=gen.Ref(attribute='toTool', show=False), page=userPage, queryable=True, queryFields=('title', 'login'), show=isManager, showHeaders=True, shownInfo=('title', 'login', 'roles')) def computeConnectedUsers(self): pass connectedUsers = gen.Computed(method=computeConnectedUsers, page=userPage, plainText=False, show=isManager) groups = gen.Ref(Group, multiplicity=(0,None), add=True, link=False, back=gen.Ref(attribute='toTool2', show=False), page=gen.Page('groups', show=isManager), show=isManager, queryable=True, queryFields=('title', 'login'), showHeaders=True, shownInfo=('title', 'login', 'roles')) pt = gen.Page('translations', show=isManager) translations = gen.Ref(Translation, multiplicity=(0,None), add=False, link=False, show='view', page=pt, back=gen.Ref(attribute='trToTool', show=False)) loadTranslationsAtStartup = gen.Boolean(default=True, show=False, page=pt, layouts='f') pages = gen.Ref(Page, multiplicity=(0,None), add=True, link=False, show='view', back=gen.Ref(attribute='toTool3', show=False), page=gen.Page('pages', show=isManager)) # Document generation page dgp = {'page': gen.Page('documents', show=isManagerEdit)} def validPythonWithUno(self, value): pass # Real method in the wrapper unoEnabledPython = gen.String(default='/usr/bin/python', show=False, validator=validPythonWithUno, **dgp) openOfficePort = gen.Integer(default=2002, show=False, **dgp) # User interface page numberOfResultsPerPage = gen.Integer(default=30, page=gen.Page('userInterface', show=False)) @classmethod def _appy_clean(klass): toClean = [] for k, v in klass.__dict__.iteritems(): if not k.startswith('__') and (not k.startswith('_appy_')): if k not in defaultToolFields: toClean.append(k) for k in toClean: exec 'del klass.%s' % k klass._appy_attributes = list(defaultToolFields) klass.folder = True # ------------------------------------------------------------------------------