Usermanagement

---

Detailed Description

A complete role based user management implementation.

Usage

After enabling user management, check if the UserController is correctly installed at /app/controllers/user.controller.php. If not, create your own, and derive it from UserBaseController. You can disable or enable features like user registration, login, mail on password loss etc. by overloading the function get_features_policy().

The user management is roled based, whereas roles can be defined in table userroles. By default three roles are set: "Admin", "Editor", and "User". There also is a System user role, which however should not be assignable to users, so it is not stored in userroles table.

Users can have more than one role. They will always have at least one, though. This role is by default "User", you may change it by redefining APP_USER_DEFAULT_ROLE.

Routing and Caching

Use AccessRenderDecorator to allow access to a route only for logged in users or users with given roles. See UserBaseController for some examples.

The AnonymousCacheManager should be used as default cache. It will disable cache for logged in users. Change /app/ww/index.php and replace creating the PageData instance with this code:

 $cache_manager = new AnonymousCacheManager();
 $page_data = new PageData($cache_manager, $_GET, $_POST);

Attention:

It is a common pitfall to forget this! Your users' data may become public if you do!

Views

If user management is enabled, all views are extended by two variables:

• $current_user: The current user (DAOUsers) or false, if no user is logged in
• $is_logged_in: True if user is logged in, false otherwise

Pasword Hashing

The usermanagement offers several different password hashing methods. See ConfigUsermanagement for details. Default is "md5". This choice has been made for compatability reasons. Most likely, though, salted md5 (portable phpass) will become the default in the near future, since this is usually regarded more safe.

You may however want to enable salted md5 right away. Do so by defining APP_USER_HASH_TYPE:

 define('APP_USER_HASH_TYPE', 'pas2p');

The system will automatically update the password hash on login, if a user's hash type differs from the default one. This makes it safe to change the hash type at any time.

Update from 0.5 to 0.5.1 or later

With 0.5.1 release a "hash_type" field has been added to users table, along with some changes regarding DB consistency. If you do not use Systemupdate module, please run the SQL in [module]/install/updates/0001_hash_type.sql manually.

Additionally, some changes have been made to the config options. Namely

• Usermanagement config moved to Config class
• Names of configuration defines have been unified:
  • USER_DEFAULT_ROLE => APP_USER_DEFAULT_ROLE
  • APP_DEFAULT_PAGE_USER => APP_USER_APP_DEFAULT_PAGE
  • APP_DEFAULT_PAGE_ADMIN => has been removed

If you are not sure, if this has consequences for your code, set APP_VERSION_MAX to 0.5:

 define('APP_VERSION_MAX', 0.5);

This will enable a compatibility layer. In most cases, however, transition should be smooth, since default values usually don't get modified.

Classes
class	AccessRenderDecorator
	Allow access only for logged in users (of given role). More...
class	AdminDashboard
	Default dashboard implementation for admins. More...
class	AnonymousCacheManager
	Cache manager that caches only if user is not logged in. More...
class	ChangeemailConfirmationHandler
	Confirm email change. More...
class	ConfigUsermanagement
	Usermanagement config options. More...
class	CreateaccountConfirmationHandler
	Confirm account creation. More...
class	CreatePermanentloginsCommand
	Create a permanent login. More...
class	CreateUsersBaseCommand
	Create a user command to be overloaded. More...
class	CreateUsersCommand
	Create a user. More...
class	DAOPermanentlogins
	Table Definition for permanentlogins. More...
class	DAOSystemUsers
	A fake user class to use as system user. More...
class	DAOUserroles
	Table Definition for userroles. More...
class	DAOUsers
	Table Definition for users. More...
class	DashboardBase
	Dashboard base class. More...
class	DefaultDashboard
	Default dashboard for all users. More...
class	EditorDashboard
	Default dashboard for editor. More...
class	EndPermanentloginsCommand
	End a permanent login. More...
class	FilterUsername
	Filter name and emial for user name. More...
interface	IDashboard
	Interface for Dashboard implementations. More...
interface	IHashAlgorithm
	Interface for Hash algorithm implementations. More...
class	LoginknownUsersBaseCommand
	Login known user command to be overloaded. More...
class	LoginknownUsersCommand
	Login known user. More...
class	LoginUsersBaseCommand
	Login command to be overloaded. More...
class	LoginUsersCommand
	Login. More...
class	LogoutUsersBaseCommand
	Logout command to be overloaded. More...
class	LogoutUsersCommand
	Logout. More...
class	Md5Hash
	Calculates an MD5 hash. More...
class	OnetimeloginConfirmationHandler
	Confirm onetime login (lost password). More...
class	Pas2fHash
	Calculates a hash using PHPPass 0.2 in full mode. More...
class	Pas2pHash
	Calculates a hash using PHPPass 0.2 in portable mode. More...
class	PermanentLogins
	Helper functions around permant logins. More...
class	RegisterUsersBaseCommand
	Register command to be overloaded. More...
class	RegisterUsersCommand
	Register. More...
class	RestartsessionUsersBaseCommand
	Restart session before logign in user - created salted session id. More...
class	RestartsessionUsersCommand
	Login. More...
class	Sha1Hash
	Calculates an SHA1 hash. More...
class	StatusAnyUsersCommand
	Command to set status. More...
class	UpdateUsersBaseCommand
	Update a user. More...
class	UpdateUsersCommand
	Update a user. More...
class	UserBaseController
	Basic user controller, offers log in, logout etc. More...
class	UserRoles
	Helpers for user role retrieval. More...
class	Users
	Usermanagement Business Logic. More...
class	UsersAccessControl
	User Access Control for Users. More...
class	UsersViewEventSink
	Catch view events to extend rendering. More...
class	ValidateUsersBaseCommand
	Validate a user before create, update etc. More...
class	ValidateUsersCommand
	Validate a user. More...
Functions
	users_load_translations ($languages)
	Users translations.

---

Function Documentation

users_load_translations

(

$

languages

)

Users translations.

Author:

Gerd Riesselmann

Definition at line 8 of file users.translations.php.

                                             {
        return array(
                'E-mail' => array(
                        'de' => 'E-Mail'
                ),
                'Registered since' => array(
                        'de' => 'Mitglied seit'
                ),
                'Username or password are wrong. Please try again.' => array(
                        'de' => 'Benutzername oder Passwort waren falsch. Bitte versuchen Sie es noch einmal.'
                ),
                'Your account has not yet been activated' => array(
                        'en' => 'Your account has not yet been activated. Please activate it using the url that has been mailed to you.',
                        'de' => 'Ihr Zugang wurde noch nicht aktiviert. Bitte aktivieren Sie Ihren Zugang mit dem Link, der Ihnen per E-Mail zugegangen ist.'
                ),
                'Activation code could not be created' => array(
                        'en' => 'Activation code could not be created. Please try again',
                        'de' => 'Aktivierungscode konnte nicht erzeugt werden. Bitte versuchen Sie es noch einmal.'
                ),
                'No password' => array(
                        'en' => 'Please enter a password',
                        'de' => 'Bitte geben Sie Ihr Passwort ein'
                ),
                'Your registration' => array(
                        'de' => 'Ihre Registrierung'
                ),
                'Change e-mail address' => array(
                        'de' => 'E-Mail-Adresse ändern'
                ),
                'Administer catalogue' => array(
                        'de' => 'Katalog verwalten'
                ),
                'My catalogue' => array(
                        'de' => 'Mein Katalog'
                ),
                'Edit and administer entries and user settings' => array(
                        'de' => 'Einträge und Benutzereinstellungen ändern und verwalten'
                ),
                'Login' => array(
                        'de' => 'Anmelden'
                ),
                'Log into %app%' => array(
                        'de' => 'In %app% einloggen'
                ),
                'Register' => array(
                        'de' => 'Registrieren'
                ),
                'Registered user can add and edit entries' => array(
                        'de' => 'Registrierte Benutzer können Einträge anlegen und ändern'
                ),
                'Logged in as %user%' => array(
                        'de' => 'Angemeldet als %user%'
                ),
                'Logout' => array(
                        'de' => 'Abmelden'
                ),
                'Quit %app%' => array(
                        'de' => '%app% verlassen'
                ),
                'Confirmation' => array(
                        'de' => 'Bestätigung'
                ),
                'Edit user %name%' => array(
                        'de' => 'Benutzerdaten für %name% ändern'
                ),
                'All users' => array(
                        'de' => 'Alle Benutzer'
                ),
                'Already logged in' => array(
                        'en' => 'You are already logged in',
                        'de' => 'Sie sind bereits angemeldet'
                ),
                'Password and password confirmation are different' => array(
                        'de' => 'Passwort und Bestätigung stimmen nicht überein'
                ),
                'Please agree to the Terms of Service' => array(
                        'de' => 'Bitte stimmen Sie den Allgemeinen Geschäftsbedingungen sowie den Datenschutzbestimmungen zu.'
                ),
                'Your registration request has been created' => array(
                        'de' => 'Ihre Registrierung wurde angelegt. Eine E-Mail mit Ihren Zugangsdaten sowie einem Bestätigungslink ist unterwegs.'
                ),
                'Your changes have been stored' => array(
                        'de' => 'Ihre Änderungen wurden gespeichert'
                ),
                'admin' => array(
                        'en' => 'Admin',
                        'de' => 'Administrator'
                ),
                'user' => array(
                        'en' => 'User',
                        'de' => 'Normaler Benutzer'
                ),
                'editor' => array(
                        'en' => 'Editor',
                        'de' => 'Redakteur'
                ),
                'VALIDATOR' => array(
                        'en' => 'Validator',
                        'de' => 'Eingangsprüfer'
                ),
                'Admin' => array(
                        'de' => 'Administrator'
                ),
                'User' => array(
                        'de' => 'Normaler Benutzer'
                ),
                'Editor' => array(
                        'de' => 'Redakteur'
                ),
                'Unconfirmed' => array(
                        'de' => 'Nicht bestätigt'
                ),
                'Deleted' => array(
                        'de' => 'Gelöscht'
                ),
                'Banned' => array(
                        'de' => 'Gebannt'
                ),
                'Active' => array(
                        'de' => 'Aktiv'
                ),
                'Edit User' => array(
                        'de' => 'Benutzerdaten ändern'
                ),
                'Your account was set to "%status%"' => array(
                        'de' => 'Ihr Account wurde auf "%status%" gesetzt'
                ),
                'Show User\'s Entries' => array(
                        'de' => 'Einträge des Benutzers'
                ),
                'You are not allowed to login' => array(
                        'de' => 'Sie haben kein Recht, sich anzumelden'
                ),
                'Edit Acount' => array(
                        'de' => 'Zugangsdaten ändern'
                ),
                'Edit your account settings' => array(
                        'de' => 'Benutzername und Password ändern'
                ),      
                'An user with this email address aready exists' => array (
                        'de' => 'Es existiert bereits ein Benutzer mit dieser E-Mail-Adresse.'
                ),
                'Delete Account' => array(
                        'de' => 'Mitgliedschaft beenden'
                ),
                'Delete your account' => array(
                        'de' => 'Löscht Ihren Account und Ihre persönlichen Daten'
                ),
                'Your account has been deleted' => array(
                        'de' => 'Ihre Mitgliedschaft wurde beendet und Ihre persönlichen Daten werden umgehend gelöscht'
                ),
                'No user set to delete' => array(
                        'de' => 'Delete User Command: Es wurde kein Benutzer gesetzt'   
                ),
                'User Role' => array(
                        'de' => 'Berechtigung'
                ),
                'Lost password' => array(
                        'de' => 'Passwort vergessen'
                ),
                'Your one time login request has been created' => array(
                        'de' => 'Es wurde ein einmaliges Login für Sie eingerichtet. Bitte prüfen Sie Ihre E-Mail.'
                ),
                'Unknown email' => array(
                        'de' => 'Unbekannte E-Mail-Adresse'
                ),
                'One time login' => array(
                        'de' => 'Einmaliges automatisches Login'
                ),
                'Resend Activation Mail' => array(
                        'de' => 'Aktivierungsmail erneut zuschicken'
                ),
                'Your activation information mail has been send to you again' => array(
                        'de' => 'Ihre Aktivierungsmail wurde Ihnen erneut zugeschickt.'
                ),
                'Your account already has been activated, use you email address and password to log in.' => array(
                        'de' => 'Ihr Zugang wurde bereits freigeschaltet. Melden Sie sich mit Ihrer E-Mail-Adresse und Ihrem Passwort an.'
                ),
                'You activation request already has expired.' => array(
                        'de' => 'Ihre Aktivierung ist nicht länger gültig und wurde gelöscht.'
                ),
                'You are now logged in. Feel comfortable.' => array(
                        'de' => 'Hallo! Sie sind nun eingeloggt.'
                ),
                'Please enter your username and password and click <strong>Login</strong>.' => array(
                        'de' => 'Bitte geben Sie Ihren Benutzernamen und Ihr Passwort ein und drücken dann auf <strong>Anmelden</strong>.'
                ),
                'Forgot password?' => array(
                        'de' => 'Passwort vergessen?'
                ),
                'Username:' => array(
                        'de' => 'Benutzername:'
                ),
                'Password:' => array(
                        'de' => 'Passwort:'
                ),
                'Registered, but got no confirmation mail?' => array(
                        'de' => 'Registriert, aber noch keine Bestätigungs-Mail bekommen?'
                ),
                'Stay logged in.' => array(
                        'de' => 'Eingeloggt bleiben, nachdem der Browser geschlossen wurde'
                ),
                'Click here to become a member.' => array(
                        'de' => 'Klicken Sie hier, um Mitglied zu werden'
                ),
                'Welcome! You are now logged in.' => array(
                        'de' => 'Willkommen! Sie sind nun eingeloggt.'
                ),
                'Application Management' => array(
                        'de' => 'Administration'
                ),
                'Your links' => array(
                        'de' => 'Persönliche Einstellungen'
                ),
                'List unconfirmed users' => array(
                        'de' => 'Unbestätigte Benutzer auflisten'
                ),
                'List all users' => array(
                        'de' => 'Alle Benutzer auflisten'
                ),
                'Edit your account' => array(
                        'de' => 'Benutzerdaten ändern'
                ),
                'Welcome %name' => array(
                        'de' => 'Willkommen, %name!'
                ),
                'Not registered yet?' => array(
                        'de' => 'Noch kein Mitglied?'
                ),
                'Your personal site' => array(
                        'de' => 'Kontrollzentrum'
                ),
                'Content Management' => array(
                        'de' => 'Inhalte verwalten'
                ),
                'User Menu' => array(
                        'de' => 'Benutzermenu'
                ),
                'You have been logged out' => array(
                        'de' => 'Sie wurden abgemeldet'
                ),
                'Become a member' => array(
                        'de' => 'Mitglied werden'
                ),
                'Fill in the fields and click <strong>Register</strong> to become a member. You will get an e-mail with a confirmation link afterwards.' => array(
                        'de' => 'Füllen Sie die Felder aus und klicken anschließend <strong>Registrieren</strong> um ein Mitglied zu werden. Sie bekommen anschließend eine E-Mail mit einem Bestätigungslink.' 
                ),
                'If you enter your e-mail address, the system will send you a link to log you in for once. You then will be able to change your password.' => array(
                        'de' => 'Geben Sie Ihre E-Mail-Adresse ein. Das System schickt Ihnen einen Link, mit dem Sie sich einmalig einloggen können. Dort können Sie dann Ihr Passwort ändern.'
                ),
                'Please enter your e-mail address and click <strong>Submit</strong> afterwards.' => array(
                        'de' => 'Bitte geben Sie Ihre E-Mail-Adresse ein und klicken anschließend auf <strong>Absenden</strong>'
                ),
                'Submit' => array(
                        'de' => 'Absenden'
                ),
                'Lost Password' => array(
                        'de' => 'Passwort vergessen'
                ),
                'If you registered but did not receive an activation e-mail, you can force the mail to be resend by filling out the form and clicking on <strong>Resend</strong> below' => array(
                        'de' => 'Wenn Sie sich registriert haben, aber keine Aktivierungs-E-Mail bekommen haben, können Sie sich diese hier erneut zuschicken lassen. Tragen Sie dazu Ihre E-Mail-Adresse und klicken dann auf <strong>Erneut zusenden</strong>.' 
                ),
                'Please check, if the mail has been blocked as spam, before trying to resend.' => array(
                        'de' => 'Bitte prüfen Sie vorher, ob Ihr Mail-Programm oder Ihr Mail-Provider die Aktivierungsnachricht irrtümlich als Spam eingestuft haben.'
                ),
                'Resend' => array(
                        'de' => 'Erneut zusenden'
                ),
                'Edit' => array(
                        'de' => 'Bearbeiten'
                ),
                'Change Account Data' => array(
                        'de' => 'Benutzerkonto Bearbeiten'
                ),
                'Fill out the fields below and click <strong>Save</strong> to save your data.' => array(
                        'de' => 'Füllen Sie die Felder aus und klicken Sie dann <strong>Speichern</strong> um die Daten zu übernehmen.'
                ),
                'If the e-mail changes, you will get a mail send to the new address to confirm this address exists.' => array(
                        'de' => 'Wenn sich Ihre E-Mail-Adresse ändert erhalten Sie eine Mail an die neue Adresse, um diese zu verifizieren.'
                ),
                'Repeat Password:' => array(
                        'de' => 'Passwort wiederholen:'
                ),
                'Leave these fields empty to not change the password.' => array(
                        'de' => 'Lassen Sie deise Felder leer um das Passwort nicht zu ändern.'
                ),              
                'E-mail:' => array(
                        'de' => 'E-Mail:'
                ),              
                'Save' => array(
                        'de' => 'Speichern'
                ),
                'Users' => array(
                        'de' => 'Benutzer'
                )               
        );
}