PApp::UserObs - manage user and access rights
use PApp::UserObs; # this module is obsolete
This is an obsolete module. See also the PApp::User module for additional documentation.
Return true when user has the "admin" access right.
- known_user_p [access]
Check wether the current user is already known in the access database. Returns his username (login) if yes, and
If the optional argument
accessis given, it additionally checks wether the user has the given access right (even if not logged in).
- update_username [$userid, ]$user
Change the login-name of the current user (or the user with id $userid) to
$userand return the userid. If another user of that name already exists, do nothing and return
- choose_username $stem
Guess a more-or-less viable but very probable unique username from the stem given. To create a new username that is unique, use something like this pseudo-code:
while not update_username $username; do $username = choose_username $username done
- update_password $pass
Set the (non-crypted) password of the current user to
undef, the password will be deleted and the user cannot log-in using
verify_loginanymore. This is not the same as an empty password, which is just that: a valid password with length zero.
- update_comment $comment
Change the comment field for the current user by setting it to
- username [$userid]
Return the username of the user with id
$useridor of the current user, if no arguments are given.
- userid $username
Return the userid associated with the given user.
- $uid = user_create
Creates a new anonymous user and returns her user-id.
- user_login $userid[, $level]
Log out the current user, switch to the userid
$useridand UNCONDITIONALLY FETCH ACCESS RIGHTS FROM THE USER DB. For a safer interface using a password, see
$useridis zero creates a new user without any access rights but keeps the state otherwise unchanged. You might want to call
save_prefsto save the user preferences (for the current application only, the other preferences currently are discarded).
$levelargument can be used to differentiate between various levels of certainty (1 == http-password, 3 = tls-password, 4 = tls-certificate). The default is 1.
Log the current user out (remove any access rights fromt he current session).
This surl-cookie (see
PApp::surllogs the user out (see
user_logout) when the link is followed.
- user_delete $userid
Deletes the given userid from the system, i.e. the user with the given ID can no longer log-in or do useful things. Other sessions using this userid will get errors, so don't use this function lightly.
- verify_login $user, $pass
Try to login as user $user, with pass $pass. If the password verifies correctly, switch the userid (if necessary), add any access rights and return true. Otherwise, return false and do nothing else.
Unlike the unix password system, empty password fields (i.e. set to undef) never log-in successfully using this function.
- grpname $gid
Return the group name associated with the given id.
- newgrp $grpname, $comment
Create a new group with the given name, updates the comment only if the group already exists.
- rmgrp $group
Delete the group with the given name.
Marc Lehmann <email@example.com> http://home.schmorp.de/