From 2c816f314a8f3cc46e72e31f34ed97b4e11d0449 Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 4 Aug 1999 12:13:27 +0000 Subject: new HTML manpages --- htdocs/docs/man/FS/UID.html | 160 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 htdocs/docs/man/FS/UID.html (limited to 'htdocs/docs/man/FS/UID.html') diff --git a/htdocs/docs/man/FS/UID.html b/htdocs/docs/man/FS/UID.html new file mode 100644 index 000000000..34444623a --- /dev/null +++ b/htdocs/docs/man/FS/UID.html @@ -0,0 +1,160 @@ + + +FS::UID - Subroutines for database login and assorted other stuff + + + + + + + +

+ + +

NAME

+FS::UID - Subroutines for database login and assorted other stuff + +

SYNOPSIS

  use FS::UID qw(adminsuidsetup cgisuidsetup dbh datasrc getotaker
+  checkeuid checkruid swapuid);
+

  adminsuidsetup $user;
+

  $cgi = new CGI;
+  $dbh = cgisuidsetup($cgi);
+

  $dbh = dbh;
+

  $datasrc = datasrc;
+

DESCRIPTION

+Provides a hodgepodge of subroutines. + +

SUBROUTINES

adminsuidsetup USER: +
+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). + +
cgisuidsetup CGI_object: +
+Stores the CGI (see the CGI manpage) object for later use. (CGI::Base is depriciated) Runs adminsuidsetup. + +
cgi: +
+Returns the CGI (see the CGI manpage) object. + +
dbh: +
+Returns the DBI database handle. + +
datasrc: +
+Returns the DBI data source. + +
getotaker: +
+Returns the current Freeside user. + +
cgisetotaker: +
+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. + +
checkeuid: +
+Returns true if effective UID is that of the freeside user. + +
checkruid: +
+Returns true if the real UID is that of the freeside user. + +
swapuid: +
+Swaps real and effective UIDs. + +
getsecrets [ USER ]: +
+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. + +

CALLBACKS

+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'};
+

VERSION

+$Id: UID.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+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. + +