-=item checkauth
-
- ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
-
-Verifies that the user is authorized to run this script. If
-the user is authorized, a (userid, cookie, session-id, flags)
-quadruple is returned. If the user is not authorized but does
-not have the required privilege (see $flagsrequired below), it
-displays an error page and exits. Otherwise, it displays the
-login page and exits.
-
-Note that C<&checkauth> will return if and only if the user
-is authorized, so it should be called early on, before any
-unfinished operations (e.g., if you've opened a file, then
-C<&checkauth> won't close it for you).
-
-C<$query> is the CGI object for the script calling C<&checkauth>.
-
-The C<$noauth> argument is optional. If it is set, then no
-authorization is required for the script.
-
-C<&checkauth> fetches user and session information from C<$query> and
-ensures that the user is authorized to run scripts that require
-authorization.
-
-The C<$flagsrequired> argument specifies the required privileges
-the user must have if the username and password are correct.
-It should be specified as a reference-to-hash; keys in the hash
-should be the "flags" for the user, as specified in the Members
-intranet module. Any key specified must correspond to a "flag"
-in the userflags table. E.g., { circulate => 1 } would specify
-that the user must have the "circulate" privilege in order to
-proceed. To make sure that access control is correct, the
-C<$flagsrequired> parameter must be specified correctly.
-
-The C<$type> argument specifies whether the template should be
-retrieved from the opac or intranet directory tree. "opac" is
-assumed if it is not specified; however, if C<$type> is specified,
-"intranet" is assumed if it is not "opac".
-
-If C<$query> does not have a valid session ID associated with it
-(i.e., the user has not logged in) or if the session has expired,
-C<&checkauth> presents the user with a login page (from the point of
-view of the original script, C<&checkauth> does not return). Once the
-user has authenticated, C<&checkauth> restarts the original script
-(this time, C<&checkauth> returns).
-
-The login page is provided using a HTML::Template, which is set in the
-systempreferences table or at the top of this file. The variable C<$type>
-selects which template to use, either the opac or the intranet
-authentification template.
-
-C<&checkauth> returns a user ID, a cookie, and a session ID. The
-cookie should be sent back to the browser; it verifies that the user
-has authenticated.
-
-=cut
-
-sub checkauth {
- my $query = shift;
-
-# $authnotrequired will be set for scripts which will run without authentication
- my $authnotrequired = shift;
- my $flagsrequired = shift;
- my $type = shift;
- $type = 'opac' unless $type;
-
- my $dbh = C4::Context->dbh;
- my $timeout = C4::Context->preference('timeout');
- $timeout = 600 unless $timeout;
-
- my $template_name;
- if ( $type eq 'opac' ) {
- $template_name = "opac-auth.tmpl";
- }
- else {
- $template_name = "auth.tmpl";
- }
-
- # state variables
- my $loggedin = 0;
- my %info;
- my ( $userid, $cookie, $sessionID, $flags, $envcookie );
- my $logout = $query->param('logout.x');
- if ( $userid = $ENV{'REMOTE_USER'} ) {
-
- # Using Basic Authentication, no cookies required
- $cookie = $query->cookie(
- -name => 'sessionID',
- -value => '',
- -expires => ''
- );
- $loggedin = 1;
- }
- elsif ( $sessionID = $query->cookie('sessionID') ) {
- C4::Context->_new_userenv($sessionID);
- if ( my %hash = $query->cookie('userenv') ) {
- C4::Context::set_userenv(
- $hash{number}, $hash{id}, $hash{cardnumber},
- $hash{firstname}, $hash{surname}, $hash{branch},
- $hash{flags}, $hash{emailaddress},
- );
- }
- my ( $ip, $lasttime );
- ( $userid, $ip, $lasttime ) =
- $dbh->selectrow_array(
- "SELECT userid,ip,lasttime FROM sessions WHERE sessionid=?",
- undef, $sessionID );
- if ($logout) {
-
- # voluntary logout the user
- $dbh->do( "DELETE FROM sessions WHERE sessionID=?",
- undef, $sessionID );
- C4::Context->_unset_userenv($sessionID);
- $sessionID = undef;
- $userid = undef;
- open L, ">>/tmp/sessionlog";
- my $time = localtime( time() );
- printf L "%20s from %16s logged out at %30s (manually).\n", $userid,
- $ip, $time;
- close L;
- }
- if ($userid) {
- if ( $lasttime < time() - $timeout ) {
-
- # timed logout
- $info{'timed_out'} = 1;
- $dbh->do( "DELETE FROM sessions WHERE sessionID=?",
- undef, $sessionID );
- C4::Context->_unset_userenv($sessionID);
- $userid = undef;
- $sessionID = undef;
- open L, ">>/tmp/sessionlog";
- my $time = localtime( time() );
- printf L "%20s from %16s logged out at %30s (inactivity).\n",
- $userid, $ip, $time;
- close L;
- }
- elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
-
- # Different ip than originally logged in from
- $info{'oldip'} = $ip;
- $info{'newip'} = $ENV{'REMOTE_ADDR'};
- $info{'different_ip'} = 1;
- $dbh->do( "DELETE FROM sessions WHERE sessionID=?",
- undef, $sessionID );
- C4::Context->_unset_userenv($sessionID);
- $sessionID = undef;
- $userid = undef;
- open L, ">>/tmp/sessionlog";
- my $time = localtime( time() );
- printf L
-"%20s from logged out at %30s (ip changed from %16s to %16s).\n",
- $userid, $time, $ip, $info{'newip'};
- close L;
- }
- else {
- $cookie = $query->cookie(
- -name => 'sessionID',
- -value => $sessionID,
- -expires => ''
- );
- $dbh->do( "UPDATE sessions SET lasttime=? WHERE sessionID=?",
- undef, ( time(), $sessionID ) );
- $flags = haspermission( $dbh, $userid, $flagsrequired );
- if ($flags) {
- $loggedin = 1;
- }
- else {
- $info{'nopermission'} = 1;
- }
- }
- }
- }
- unless ($userid) {
- $sessionID = int( rand() * 100000 ) . '-' . time();
- $userid = $query->param('userid');
- my $password = $query->param('password');
- C4::Context->_new_userenv($sessionID);
- my ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password );
- if ($return) {
- $dbh->do( "DELETE FROM sessions WHERE sessionID=? AND userid=?",
- undef, ( $sessionID, $userid ) );
- $dbh->do(
-"INSERT INTO sessions (sessionID, userid, ip,lasttime) VALUES (?, ?, ?, ?)",
- undef,
- ( $sessionID, $userid, $ENV{'REMOTE_ADDR'}, time() )
- );
- open L, ">>/tmp/sessionlog";
- my $time = localtime( time() );
- printf L "%20s from %16s logged in at %30s.\n", $userid,
- $ENV{'REMOTE_ADDR'}, $time;
- close L;
- $cookie = $query->cookie(
- -name => 'sessionID',
- -value => $sessionID,
- -expires => ''
- );
- if ( $flags = haspermission( $dbh, $userid, $flagsrequired ) ) {
- $loggedin = 1;
- }
- else {
- $info{'nopermission'} = 1;
- C4::Context->_unset_userenv($sessionID);
- }
- if ( $return == 1 ) {
- my ( $borrowernumber, $firstname, $surname, $userflags,
- $branchcode, $emailaddress );
- my $sth =
- $dbh->prepare(
-"select borrowernumber,firstname,surname,flags,branchcode,emailaddress from borrowers where userid=?"
- );
- $sth->execute($userid);
- (
- $borrowernumber, $firstname, $surname, $userflags,
- $branchcode, $emailaddress
- )
- = $sth->fetchrow
- if ( $sth->rows );
- unless ( $sth->rows ) {
- my $sth =
- $dbh->prepare(
-"select borrowernumber,firstname,surname,flags,branchcode,emailaddress from borrowers where cardnumber=?"
- );
- $sth->execute($cardnumber);
- (
- $borrowernumber, $firstname, $surname, $userflags,
- $branchcode, $emailaddress
- )
- = $sth->fetchrow
- if ( $sth->rows );
- unless ( $sth->rows ) {
- $sth->execute($userid);
- (
- $borrowernumber, $firstname, $surname, $userflags,
- $branchcode, $emailaddress
- )
- = $sth->fetchrow
- if ( $sth->rows );
- }
- }
- my $hash =
- C4::Context::set_userenv( $borrowernumber, $userid,
- $cardnumber, $firstname, $surname, $branchcode, $userflags,
- $emailaddress, );
- $envcookie = $query->cookie(
- -name => 'userenv',
- -value => $hash,
- -expires => ''
- );
- }
- elsif ( $return == 2 ) {
-
- #We suppose the user is the superlibrarian
- my $hash = C4::Context::set_userenv(
- 0,
- 0,
- C4::Context->config('user'),
- C4::Context->config('user'),
- C4::Context->config('user'),
- "",
- 1,
- C4::Context->preference('KohaAdminEmailAddress')
- );
- $envcookie = $query->cookie(
- -name => 'userenv',
- -value => $hash,
- -expires => ''
- );
- }
- }
- else {
- if ($userid) {
- $info{'invalid_username_or_password'} = 1;
- C4::Context->_unset_userenv($sessionID);
- }
- }
- }
- my $insecure = C4::Context->boolean_preference('insecure');
-
- # finished authentification, now respond
- if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
- {
-
- # successful login
- unless ($cookie) {
- $cookie = $query->cookie(
- -name => 'sessionID',
- -value => '',
- -expires => ''
- );
- }
- if ($envcookie) {
- return ( $userid, [ $cookie, $envcookie ], $sessionID, $flags );
- }
- else {
- return ( $userid, $cookie, $sessionID, $flags );
- }
- }
-
- # else we have a problem...
- # get the inputs from the incoming query
- my @inputs = ();
- foreach my $name ( param $query) {
- (next) if ( $name eq 'userid' || $name eq 'password' );
- my $value = $query->param($name);
- push @inputs, { name => $name, value => $value };