Merge branch 'master' into 'production'

Release 0.7.3

See merge request !35

.gitignore

@@ -3,7 +3,7 @@
 .pydevproject
 *.pyc
 .settings/
-_db*.py*
+_*db*.py*
 cache/
 cron/
 databases

controllers/default.py

@@ -2,6 +2,9 @@
 """ Controllers
 
 """
+from plugin_event import ADMIN
+
+
 @auth.requires(True, requires_login=not request.is_local)
 def index():
     """Main Controller to run the application launching the plugin dbui.

docs/api/generated/plugin_event.CoreUi.rst

@@ -11,7 +11,7 @@ plugin_event.CoreUi
    .. autosummary::
       :toctree: ui/
 
-      ~CoreUi.define
+      ~CoreUi.configure
       ~CoreUi.domains
       ~CoreUi.events
       ~CoreUi.fundings

docs/api/generated/plugin_event.ReportUi.rst

@@ -11,7 +11,7 @@ plugin_event.ReportUi
    .. autosummary::
       :toctree: ui/
 
-      ~ReportUi.define
+      ~ReportUi.configure
       ~ReportUi.lists2
       ~ReportUi.metrics2d2
 

docs/api/generated/plugin_event.SelectorUi.rst

@@ -12,7 +12,7 @@ plugin_event.SelectorUi
    .. autosummary::
       :toctree: ui/
 
-      ~SelectorUi.define
+      ~SelectorUi.configure
       ~SelectorUi.selector_list
       ~SelectorUi.selector_metric2d
       ~SelectorUi.selector_source

docs/api/generated/plugin_event.ViewportUi.rst

@@ -11,7 +11,7 @@ plugin_event.ViewportUi
    .. autosummary::
       :toctree: ui/
 
-      ~ViewportUi.define
+      ~ViewportUi.configure
       ~ViewportUi.app_node
       ~ViewportUi.configure_node
       ~ViewportUi.event_node

docs/api/generated/ui/plugin_event.CoreUi.configure.rst

+plugin_event.CoreUi.configure
+=============================
+
+.. currentmodule:: plugin_event
+
+.. automethod:: CoreUi.configure
\ No newline at end of file

docs/api/generated/ui/plugin_event.CoreUi.define.rst

-plugin_event.CoreUi.define
-==========================
-
-.. currentmodule:: plugin_event
-
-.. automethod:: CoreUi.define
\ No newline at end of file

docs/api/generated/ui/plugin_event.ReportUi.configure.rst

+plugin_event.ReportUi.configure
+===============================
+
+.. currentmodule:: plugin_event
+
+.. automethod:: ReportUi.configure
\ No newline at end of file

docs/api/generated/ui/plugin_event.ReportUi.define.rst

-plugin_event.ReportUi.define
-============================
-
-.. currentmodule:: plugin_event
-
-.. automethod:: ReportUi.define
\ No newline at end of file

docs/api/generated/ui/plugin_event.SelectorUi.configure.rst

+plugin_event.SelectorUi.configure
+=================================
+
+.. currentmodule:: plugin_event
+
+.. automethod:: SelectorUi.configure
\ No newline at end of file

docs/api/generated/ui/plugin_event.SelectorUi.define.rst

-plugin_event.SelectorUi.define
-==============================
-
-.. currentmodule:: plugin_event
-
-.. automethod:: SelectorUi.define
\ No newline at end of file

docs/api/generated/ui/plugin_event.ViewportUi.configure.rst

+plugin_event.ViewportUi.configure
+=================================
+
+.. currentmodule:: plugin_event
+
+.. automethod:: ViewportUi.configure
\ No newline at end of file

docs/api/generated/ui/plugin_event.ViewportUi.define.rst

-plugin_event.ViewportUi.define
-==============================
-
-.. currentmodule:: plugin_event
-
-.. automethod:: ViewportUi.define
\ No newline at end of file

models/access.py

-# -*- coding: utf-8 -*-
-""" access
-
-    setup the connection to the databases.
-    Define constants for the different role
-
-"""
-# Migration flags
-MIGRATE = False
-MIGRATE_USER = False
-
-# Roles
-ID_ADMIN, ADMIN, DEF_ADMIN = 1, "admin", "administrators, team leader,..."
-ID_USER, USER, DEF_USER = 2, "user", "project leader,..."
-
-#.............................................................................
-#
-# MYSQL database
-#
-
-try:
-    mysql = DBURIS[request.application]
-    db = DAL(mysql, lazy_tables=False, migrate_enabled=MIGRATE, pool_size=10)
-except:
-    raise HTTP(500, T("Can't access the MySQL database !!!"))
-
-#.............................................................................
-#
-# virtual database
-#
-
-virtdb = DAL(None)

models/auth.py

-# -*- coding: utf-8 -*-
-""" authentication
-
-    user identification and role
-
-"""
-from gluon.tools import Auth
-
-
-#
-# User logging
-# Approval is required for newly registered users
-#
-auth = Auth(db, hmac_key=Auth.get_or_create_key())
-
-auth.define_tables(migrate=MIGRATE_USER)
-auth.settings.create_user_groups = False
-auth.settings.mailer = None
-auth.settings.registration_requires_approval = True
-auth.settings.registration_requires_verification = False
-auth.settings.remember_me_form = False
-auth.settings.reset_password_requires_verification = True
-
-# go to the login page after change password, logout and registration
-auth.settings.change_password_next = URL('user', args='login')
-auth.settings.logout_next = URL('user', args='login')
-auth.settings.register_next = URL('user', args='login')
-
-# create user and admin groups
-if not db(db.auth_group.id).count():
-    db.auth_group.insert(id=ID_ADMIN, role=ADMIN, description=T(DEF_ADMIN))
-    db.auth_group.insert(id=ID_USER, role=USER, description=T(DEF_USER))
-
-# Newly registered users go in the user group
-auth.settings.everybody_group_id = ID_USER
-
-# The first user is auto approved and get all privilege (admin)
-if not db(db.auth_user.id).count():
-    auth.settings.everybody_group_id = ID_ADMIN
-    auth.settings.registration_requires_approval = False
-
-# tune authentication fields for the extJS interface
-db.auth_user.registration_key.readable = True
-db.auth_user.registration_key.writable = True
-
-db.auth_membership.user_id.label = 'User'
-db.auth_membership.group_id.label = 'Group'
-
-db.auth_membership.user_id.requires = \
-IS_IN_DB(db, 'auth_user.last_name')
-
-# HACK
-# JSON conversion of datetime failed in the action plugin_dbui.dbui_conf
-# Convert the date in advance help
-# TODO: implement a proper datetime conversion when running json.dumps()
-db.auth_event.time_stamp.default = db.auth_event.time_stamp.default.isoformat()
-db.auth_cas.created_on.default = db.auth_cas.created_on.default.isoformat()
-

models/common_settings.py → models/main.py

 # -*- coding: utf-8 -*-
-""" Common settings
+""" main
 
-Model instantiate the database table as well as the UI configuration.
-It is tune to only satisfy the need of the controller, function pair.
+Instantiate the database connection, model database tables and configure the
+user interface. It is tune to only satisfy the need of the controller,
+function pair.
 
 Note:
-    The model expose to controllers several global variables:
+    Expose to controllers several global variables:
 
         * auth
+        * db
+        * virtdb
         * directSvc
 
+    They can be retrieved in module via the protocol "current".
+
 """
+from _mydb import DBURIS
+from gluon import current
+
 from plugin_dbui import (configure_forms,
                          configure_grids,
                          Dbui)
 
-from plugin_event import (Core,
+from plugin_event import (configure_auth,
+                          Core,
                           CoreUi,
                           Event,
                           Report,
@@ -23,9 +32,33 @@ from plugin_event import (Core,
                           Selector,
                           ViewportUi)
 
+# ............................................................................
+#
+# Connection to databases
+#
 
-ctrl = request.controller
-fnct = request.function
+try:
+    mysql = DBURIS[request.application]
+    db = DAL(mysql,
+             lazy_tables=False,
+             migrate_enabled=False,
+             pool_size=10)
+
+except RuntimeError:
+    raise HTTP(500, T("Can't access the MySQL database !!!"))
+
+virtdb = DAL(None)
+
+current.db = db
+current.virtdb = virtdb
+
+# ............................................................................
+#
+# Authentication
+#
+
+auth = configure_auth(db, migrate_user=False)
+current.auth = auth
 
 # ............................................................................
 #
@@ -40,8 +73,12 @@ T.lazy = True                                       # lazy translation
 #
 # Plugin dbui configuration
 #
-is_dbui = (ctrl == "plugin_dbui") and \
-          fnct in ("debug", "documentations", "dbui_conf", "index")
+ctrl = request.controller
+fnct = request.function
+
+is_dbui = \
+    (ctrl == "plugin_dbui") \
+    and fnct in ("debug", "documentations", "dbui_conf", "index")
 
 if is_dbui:
     Dbui.define_paths(
@@ -67,8 +104,9 @@ if is_dbui:
 # Create the database models
 #
 
-is_db = (ctrl == "plugin_dbui" and fnct in ("call", "csv", "dbui_conf")) \
-        or (ctrl == "plugin_event")
+is_db = \
+    (ctrl == "plugin_dbui" and fnct in ("call", "csv", "dbui_conf")) \
+    or (ctrl == "plugin_event")
 
 if is_db:
 
@@ -114,10 +152,10 @@ if ctrl == "plugin_dbui" and fnct in ("call", "dbui_conf"):
                  "pGridRowEditorDblClick",
                  "pGridToolbar"])
 
-    # tune the user interface
-    CoreUi.define(db, T)
-    ReportUi.define(db, T)
+    # configure the user interface for the main tables
+    CoreUi.configure(db, T)
+    ReportUi.configure(db, T)
 
-    # configure the main viewport
+    # configure the viewport
     if fnct == "dbui_conf":
-        ViewportUi.define(db, T, virtdb)
+        ViewportUi.configure(db, T, virtdb)

modules/plugin_event/__init__.py

 # -*- coding: utf-8 -*-
 
+from auth import (ADMIN,
+                  configure_auth,
+                  ID_ADMIN,
+                  ID_USER,
+                  USER)
+
 from callbacks import (INHIBIT_CASCADE_DELETE,
                        ON_CREATE_LISTS2,
                        ON_UPDATE_LISTS2)

modules/plugin_event/auth.py

+# -*- coding: utf-8 -*-
+""" auth
+
+    * Customise the authentication
+
+"""
+from gluon.html import URL
+from gluon.tools import Auth
+from gluon.validators import IS_IN_DB
+
+
+# Constant for admin role
+ID_ADMIN = 1
+ADMIN = "admin"
+DEF_ADMIN = "administrators, ..."
+
+# constant for user role
+ID_USER = 2
+USER = "user",
+DEF_USER = "team leader,,..."
+
+
+def configure_auth(db, migrate_user=False):
+    """Configure the authentication process
+
+    Args:
+        db (gluon.dal.DAL): database connection
+        migrate_user (bool):
+
+    Returns:
+        gluon.tools.Auth
+
+    """
+    #
+    # User logging
+    # Approval is required for newly registered users
+    #
+    auth = Auth(db, hmac_key=Auth.get_or_create_key())
+
+    auth.define_tables(migrate=migrate_user)
+    auth.settings.create_user_groups = False
+    auth.settings.mailer = None
+    auth.settings.registration_requires_approval = True
+    auth.settings.registration_requires_verification = False
+    auth.settings.remember_me_form = False
+    auth.settings.reset_password_requires_verification = True
+
+    # go to the login page after change password, logout and registration
+    auth.settings.change_password_next = URL('user', args='login')
+    auth.settings.logout_next = URL('user', args='login')
+    auth.settings.register_next = URL('user', args='login')
+
+    # create user and admin groups
+    if not db(db.auth_group.id).count():
+        db.auth_group.insert(id=ID_ADMIN, role=ADMIN, description=T(DEF_ADMIN))
+        db.auth_group.insert(id=ID_USER, role=USER, description=T(DEF_USER))
+
+    # Newly registered users go in the user group
+    auth.settings.everybody_group_id = ID_USER
+
+    # The first user is auto approved and get all privilege (admin)
+    if not db(db.auth_user.id).count():
+        auth.settings.everybody_group_id = ID_ADMIN
+        auth.settings.registration_requires_approval = False
+
+    # tune authentication fields for the extJS interface
+    db.auth_user.registration_key.readable = True
+    db.auth_user.registration_key.writable = True
+
+    db.auth_membership.user_id.label = 'User'
+    db.auth_membership.group_id.label = 'Group'
+
+    db.auth_membership.user_id.requires = IS_IN_DB(db, 'auth_user.last_name')
+
+    # HACK
+    # JSON conversion of datetime failed in the action plugin_dbui.dbui_conf
+    # Convert the date in advance help
+    db.auth_event.time_stamp.default = \
+        db.auth_event.time_stamp.default.isoformat()
+
+    db.auth_cas.created_on.default = \
+        db.auth_cas.created_on.default.isoformat()
+
+    return auth

modules/plugin_event/callbacks.py

@@ -33,7 +33,7 @@ def INHIBIT_CASCADE_DELETE(myset):
         bool: ``True`` when the delete is inhibited
 
     """
-    db, T = current.globalenv['db'], current.T
+    db, T = current.db, current.T
     field = myset.query.first
 
     # protection
@@ -130,7 +130,7 @@ def ON_UPDATE_LISTS2(myset, values):
         or ("columns" in values and len(values["columns"]) > 0):
         return False
 
-    db = current.globalenv['db']
+    db = current.db
 
     # get the id_events and source
     if "id_events" not in values or "source" not in values: