FS::UID - Subroutines for database login and assorted other stuff
use FS::UID qw(adminsuidsetup cgisuidsetup dbh datasrc getotaker checkeuid checkruid swapuid);
adminsuidsetup $user;
$cgi = new CGI; $dbh = cgisuidsetup($cgi);
$dbh = dbh;
$datasrc = datasrc;
Provides a hodgepodge of subroutines.
Sets the user to USER (see config.html from the base documentation). Cleans the environment. Make sure the script is running as freeside, or setuid freeside. Opens a connection to the database. Swaps real and effective UIDs. Runs any defined callbacks (see below). Returns the DBI database handle (usually you don't need this).
Stores the CGI (see the CGI manpage) object for later use. (CGI::Base is depriciated) Runs adminsuidsetup.
Returns the CGI (see the CGI manpage) object.
Returns the DBI database handle.
Returns the DBI data source.
Returns the current Freeside user.
Sets and returns the CGI REMOTE_USER. $cgi should be defined as a CGI.pm object. Support for CGI::Base and derived classes is depriciated.
Returns true if effective UID is that of the freeside user.
Returns true if the real UID is that of the freeside user.
Swaps real and effective UIDs.
Sets the user to USER, if supplied. Sets and returns the DBI datasource, username and password for this user from the `/usr/local/etc/freeside/mapsecrets' file.
Warning: this interface is likely to change in future releases.
A package can install a callback to be run in adminsuidsetup by putting a coderef into the hash %FS::UID::callback :
$coderef = sub { warn "Hi, I'm returning your call!" }; $FS::UID::callback{'Package::Name'};
$Id: UID.html,v 1.2 2000-03-03 18:22:42 ivan Exp $
Too many package-global variables.
Not OO.
No capabilities yet. When mod_perl and Authen::DBI are implemented, cgisuidsetup will go away as well.
Goes through contortions to support non-OO syntax with multiple datasrc's.
Callbacks are inelegant.
FS::Record, the CGI manpage, DBI, config.html from the base documentation.