Package lemon :: Package auth
[show private | hide private]
[frames | no frames]

Package lemon.auth

PHP-style authorisation functions.

Version:

    File Version 0.1 for LEMON 0.2
    
Usage:

    session = lemon.session.SessionDB(cursor, appName)  # Retrieve the session or create a new one
    auth    = lemon.auth.AuthDB(session)                # Create auth object from the session information
    
    if auth.isValid():                                  # See if the User is logged on else present login form.
        user = a.getUser()                              # Return a user object containing user's details.
        user.Password                                   # Access the data via attributes or dict style.
        user.getStatus()                                # Retrieve the entry for the appName column.

ToDO:

    addUser, RemoveUser etc.
    gadfly
    create the database if not already there?? 
    definately need config file similar to php.ini
    
    Sort out the ridiculous template situation with emailing etc.

Submodules
  • drivers: Drivers for the Auth Module...
    • base: PHP-style authorisation functions.
    • db: PHP-style authorisation functions.
  • manager: PHP-style authorisation functions.
    • drivers: Drivers for the Auth Manager module.
      • base: PHP-style authorisation functions.
      • db: PHP-style authorisation functions.
  • template: The default HTML templates associated with the Auth module.

Classes
Auth  

Exceptions
AuthError Error Class for the Session Module.

Function Summary
  start(session, storage, database, expire, idle, loginForm, autoLogin, autoRedirect, redirect, includeQuery, stickyData, reminderForm, email, app, accessDenied, emailMessage, htmlPage)
The preffered method to start the auth classes.

Variable Summary
str __author__ = 'James Gardner [email: james at xecos.com]'...
str __credits__ = 'Guido van Rossum, for an excellent progra...
str __date__ = '02 July 2003'
str __version__ = '0.2'

Function Details

start(session, storage='db', database=None, expire=1440, idle=600, loginForm=None, autoLogin=True, autoRedirect=True, redirect=None, includeQuery=False, stickyData={}, reminderForm=None, email=None, app=None, accessDenied=None, emailMessage=None, htmlPage=None)

The preffered method to start the auth classes.

Variable Details

__author__

Type:
str
Value:
'James Gardner [email: james at xecos.com]'                            

__credits__

Type:
str
Value:
'Guido van Rossum, for an excellent programming language.'             

__date__

Type:
str
Value:
'02 July 2003'                                                         

__version__

Type:
str
Value:
'0.2'                                                                  

Generated by Epydoc 2.0 on Mon Nov 10 15:08:02 2003 http://epydoc.sf.net