wiki:DeveloperGuidelinesS3Framework

Version 29 (modified by Fran Boon, 12 years ago) ( diff )

Update what we use jQuery for

SahanaPy Framework

We have built an S3 framework as a higher level of abstraction on top of Web2Py.
This should be used by modules where possible, but if more power is needed then drop down a level of two (to T2, to base Web2Py or to raw Python).

gluon/tools.py is used for:

T2 is used for:

  • search

We extend the Auth/Crud/T2 classes in modules/sahana.py.
Patches to the framework should be done here.
If they're generic enough then they can be suggested to Massimo for moving upstream to Web2Py.

We extend the CRUD with a RESTlike controller.
This provides details on how to configure your Model & Controllers. Views may not be required, other than index.html

Mandatory

Each Controller should start like this (to populate the side navigation Menus):

module = 'module'
# Current Module (for sidebar title)
module_name = db(db.module.name==module).select()[0].name_nice
# Options Menu (available in all Functions' Views)
response.menu_options = [
    [T('Home'), False, URL(r=request, f='index')],
    [T('Add Person'), False, URL(r=request, f='person', args='create')],
    [T('List People'), False, URL(r=request, f='person')],
    [T('Search People'), False, URL(r=request, f='person', args='search')]
]

Each function needs to return this value to the view:

return dict(module_name=module_name)

All tables which are user-editable need to be protected for conflict resolution & synchronization using the predefined fields timestamp & uuidstamp.
These are defined in models/00_db.py:

# Reusable timestamp fields
timestamp = SQLTable(None,'timestamp',
            db.Field('created_on','datetime',
                          writable=False,
                          default=request.now),
            db.Field('modified_on','datetime',
                          writable=False,
                          default=request.now,update=request.now)) 

# We need UUIDs as part of database synchronization
import uuid
uuidstamp = SQLTable(None,'uuidstamp',
            db.Field('uuid',length=64,
                          writable=False,
                          default=uuid.uuid4()))

Optional

List output are made more functional by this .represent 'widget':

def shn_list_item(table, resource, action, display='table.name', extra=None):
    if extra:
        items = DIV(TR(TD(A(eval(display), _href=t2.action(resource, [action, table.id]))), TD(eval(extra))))
    else:
        items = DIV(A(eval(display), _href=t2.action(resource, [action, table.id])))
    return DIV(*items)

This is called in models/01_RESTlike_controller.py in the RESTlike Controller:

db.person.represent = lambda table:shn_list_item(table, resource='person', action='display', display='table.full_name')

Form labels can be set in a translatable manner using:

db.table.field.label = T("label")

Form field can be made to use a TEXTAREA by marking the field as being type 'text':

db.Field('field', 'text'),

Form field can be made to use a SELECT dropdown by setting the field as a lookup to another table...linked to the 'id' field to allow Database Synchronization, but displaying a more user-friendly field (such as 'name'):

db.Field('field', db.othertable),

db.table.field.requires = IS_NULL_OR(IS_IN_DB(db, 'othertable.id', 'othertable.name'))

Form field being required can be marked using:

db.table.field.comment = SPAN("*", _class="req")

Help for a form field can be set using:

A(SPAN("[Help]"), _class="tooltip", _title=T("Help Title|This is what this <a href='http://wikipedia.org/Field' target=_blank>field</a> is for."))

Different Flash styles can be set via:

session.error = T("Unsupported format!")
redirect(URL(r=request, f=resource))

or (in a Multiple Table form.accepts):

response.error = T("Form invalid!")

Supported styles are:

  • .warning
  • .error
  • .information
  • .confirmation (Default response.flash is styled like this)

Settings

System-wide settings have their default values set in models/00_db.py's s3_settings table.

Upon 1st run of the system, these settings are loaded into the database from where they can subsequently be edited to configure the running instance.

If these settings are required by all Views then can patch the session to see them in models/00_db.py's shn_sessions().
e.g. session.s3.debug is made available to the default layout.html this way.

If you wish to clean out all settings to import afresh, then close down Web2Py & delete all files from /databases)

Modules can set up their own configuration settings tables in a similar way (e.g. GIS does this)

jQuery

jQuery scripts are located in multiple places to provide for ease of maintenance & for performance gains:

  • If there is no need for server-side processing our scripts should be added to /static/scripts/S3/S3.js
  • If there is a need for server-side pre-processing, they should be added to /views/sahana_scripts_debug.html
    • Also needs manually copying to /views/sahana_scripts_min.html
  • Scripts from base Web2Py or T2 are stored in the appropriate areas of /static/scripts or /views/sahana_scripts_*.html

Specific widgets we use:

Conflict Detection

Sahana is a multi-user system so there is a potential for multiple users to be editing the same record at once.
We use T2 to handle this for us.

Add this field to each table which needs protecting (in models/module.py):

timestamp

This field is also used in Database Synchronization


DeveloperGuidelines

Note: See TracWiki for help on using the wiki.