$acct = new Account(read/write [, timeout]);

Creates a new account object.

read/write - boolean set to True if the existing session needs to be writeable. Defaults to readOnly.

timeout - the number of seconds to wait for a lock. Defaults to 60 seconds.

returns a reference to the Account object.

returns a path to the account database file

$acct->print();
    $acct->print(user);

returns the string-ified version of the entire session, or just the contents of test testNum, if specified.

$exp = $acct->hasExpired;

Returns 1 if the license has been recorded as expired, and 0 if it has not.

Returns the time when the high water mark in terms of logged in users was hit, or the current time if no high water mark is defined.

Returns the maximum number of users ever logged in, or 0 if no high water mark is defined.

$setting = $acct->sessClear(user, sid, name ) ;

clears out the setting from the session data structure.

Returns nothing.

$setting = $acct->sessSet(user, sid, name [, value] );

returns the individual setting, or undef if it is not defined. If a value is provided, it updates the setting data structure with the new setting for "name".

$setting = $acct->setting(user, name [, value] );

returns the individual setting, or undef if it is not defined. If a value is provided, it updates the setting data structure with the new setting for "name".

$fullname = $acct->fullname(userId [, includeUID]) ;

userId - an id of a user in the database

includeUID - a boolean. If true then include the userID after the fullname in parens. Defaults to false.

Returns the fullname for the user, or the userId if there is no fullname.

$setRef = $acct->clear(user, setting) ;

Removes the setting from the user, if the user has one at all.

Returns nothing.

$last = $acct->lastChange ( [time() ] );

A major change is defined as one that changes the list of users and/or the list of users that have access to specific test suites.

Returns the last time. If the optional parameter is supplied, sets the last change time to then.

$setRef = $userInfo->settings( user [, settings ] );

returns a reference to the settings hash within the user's data structure, or replaces the settings hash with an updated version and marks the data structure as dirty.

@list = $acct->sessionList( [ sortDir [, $uname ] ] );

returns a list of all sessions, or sessions for only a specific user.

each list item is a reference to a hash containing:

$acct->release() ;

$acct->remove(user);

Returns 1 on success. Returns 0 if there was no such user or if there is no write access to the database.

Note that this will rebuild the userHash, including the per-suite user hash for any suites to which this user had access.

$acct->numUsers();

returns the number of users in the database.

Flushes the database to disk

$acct->buildUserHash( [ $suiteListRef ] ) ;

suiteListRef is a reference to a list of test suite names that also need updating. If not defined, then all suites are updated. If the list is empty, then no suites are updated.

Rebuilds the internal userhash structure. Returns nothing.

$acct->renameSuite(oldname, newname);

Will traverse the database and update settings to reference the new suite name.

%hash = $acct->userHash();

returns a hash whose keys are the short names, and values are the fullnames of each user. The list is based upon an internal cache that is maintained by the object itself.

$acct->userList();

returns a sorted array of the names of the defined users.

userList( [ Suite [, perm] ] )

Returns a sorted array that includes only the users with access to suite Suite. If Suite is not specified, then just returns all the users defined in the system.

$acct->userInfo(username);
    $acct->userInfo(username, dataHash);

username is the user account data

dataHash is a hash of fields for the user. If you "undef" a field, then its contents will be removed.

Defined attributes for a user include:

fullname

the full name of the user.

email

the email address of the user.

groups

the comma-separated list of "groups" in which this user is a member.

phoneNumber

the phone number of the user.

password

the password for the user.

logintime

the time the user logged in.

accesstime

the time the user last accessed the system.

totalTime

The total time this user has been logged into the system.

disabled

Boolean that indicates if this account is currently disabled.

forceChange

Force the change of the user's password on the next login.

returns the handle to the userInfo hash.

$username = $acct->findUser($username) ;

Returns the original user name or, if caseInsensitive is enabled, the username that matches.

$hRef = $acct->userPerms( suite ) ;

Suite is the name of a test suite.

Returns a reference to a hash mapping userids to the permission number for each user who has any access to the suite at all.

$output = $acct->zonePicker(formName, varname, current);

formName is the name for this form on the page.

varname is the name of the HTML form variable to use.

current is the current setting.

Returns the HTML to generate the timezone picker selection elements.

$acct->suite( suiteName) ;

suiteName is the name of a suite. The account object will remember that you are working in the context of that suite for purposes of evaluation user permissions.

$acct->SQL_updateAccountList( suite [, ulistRef ] ) ;

suite is the name of the suite to update.

ulistRef is a reference to a list of users who have access to this suite.

Updates the master user table with all userids and associated data. Updates the authentication table with information about the auth level for each user with access to the suite.

In the situation where multiple suites share the same database space/ table space, this is wildly inefficient. But it doesn't happen all that often, so...

Returns nothing.

my $tname = $sdb->SQL_tname;

Returns the name of the table for this object.

@tlist = $sdb->SQL_tlist;

@rows = $acc->SQL_tableDef( table )

table is the name of the table to generate.

Returns a list of rows for the table.

$account->SQL_createTables( );

Returns nothing.