X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=C4%2FAuth.pm;h=2c6809b9936c8adb7ccd44cecff387e26aad9eea;hb=e57dadf762101cfb7371c3d2c93e8163a2ace69f;hp=b98c828078ba9be04af03c87f5a0925c6a4f173a;hpb=f295d4d22349a9e8cc270a847c25ba5f19ff5372;p=koha.git diff --git a/C4/Auth.pm b/C4/Auth.pm index b98c828078..2c6809b993 100644 --- a/C4/Auth.pm +++ b/C4/Auth.pm @@ -1,7 +1,3 @@ - -# -*- tab-width: 8 -*- -# NOTE: This file uses 8-character tabs; do not change the tab size! - package C4::Auth; # Copyright 2000-2002 Katipo Communications @@ -17,12 +13,15 @@ package C4::Auth; # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR # A PARTICULAR PURPOSE. See the GNU General Public License for more details. # -# You should have received a copy of the GNU General Public License along with -# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place, -# Suite 330, Boston, MA 02111-1307 USA +# You should have received a copy of the GNU General Public License along +# with Koha; if not, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. use strict; +#use warnings; FIXME - Bug 2505 use Digest::MD5 qw(md5_base64); +use Storable qw(thaw freeze); +use URI::Escape; use CGI::Session; require Exporter; @@ -32,22 +31,30 @@ use C4::Members; use C4::Koha; use C4::Branch; # GetBranches use C4::VirtualShelves; +use POSIX qw/strftime/; # use utf8; -use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap); +use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout); BEGIN { $VERSION = 3.02; # set version for version checking - $debug = $ENV{DEBUG} || 0 ; + $debug = $ENV{DEBUG}; @ISA = qw(Exporter); - @EXPORT = qw(&checkauth &get_template_and_user); + @EXPORT = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions); @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &get_all_subpermissions &get_user_subpermissions); %EXPORT_TAGS = (EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)]); $ldap = C4::Context->config('useldapserver') || 0; + $cas = C4::Context->preference('casAuthentication'); + $caslogout = C4::Context->preference('casLogout'); if ($ldap) { require C4::Auth_with_ldap; # no import import C4::Auth_with_ldap qw(checkpw_ldap); } + if ($cas) { + require C4::Auth_with_cas; # no import + import C4::Auth_with_cas qw(checkpw_cas login_cas logout_cas login_cas_url); + } + } =head1 NAME @@ -62,7 +69,7 @@ C4::Auth - Authenticates Koha users my $query = new CGI; - my ($template, $borrowernumber, $cookie) + my ($template, $borrowernumber, $cookie) = get_template_and_user( { template_name => "opac-main.tmpl", @@ -77,44 +84,46 @@ C4::Auth - Authenticates Koha users =head1 DESCRIPTION - The main function of this module is to provide - authentification. However the get_template_and_user function has - been provided so that a users login information is passed along - automatically. This gets loaded into the template. +The main function of this module is to provide +authentification. However the get_template_and_user function has +been provided so that a users login information is passed along +automatically. This gets loaded into the template. =head1 FUNCTIONS -=over 2 - -=item get_template_and_user - - my ($template, $borrowernumber, $cookie) - = get_template_and_user( - { - template_name => "opac-main.tmpl", - query => $query, - type => "opac", - authnotrequired => 1, - flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' }, - } - ); - - This call passes the C, C and C - to C<&checkauth> (in this module) to perform authentification. - See C<&checkauth> for an explanation of these parameters. - - The C is then used to find the correct template for - the page. The authenticated users details are loaded onto the - template in the HTML::Template LOOP variable C. Also the - C is passed to the template. This can be used in templates - if cookies are disabled. It needs to be put as and input to every - authenticated page. - - More information on the C sub can be found in the - Output.pm module. +=head2 get_template_and_user + + my ($template, $borrowernumber, $cookie) + = get_template_and_user( + { + template_name => "opac-main.tmpl", + query => $query, + type => "opac", + authnotrequired => 1, + flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' }, + } + ); + +This call passes the C, C and C +to C<&checkauth> (in this module) to perform authentification. +See C<&checkauth> for an explanation of these parameters. + +The C is then used to find the correct template for +the page. The authenticated users details are loaded onto the +template in the HTML::Template LOOP variable C. Also the +C is passed to the template. This can be used in templates +if cookies are disabled. It needs to be put as and input to every +authenticated page. + +More information on the C sub can be found in the +Output.pm module. =cut +my $SEARCH_HISTORY_INSERT_SQL =<param( bartotal => $total->{'bartotal'}, ) if ($total->{'bartotal'} > scalar (@$barshelves)); } - $borrowernumber = getborrowernumber($user); + $borrowernumber = getborrowernumber($user) if defined($user); + my ( $borr ) = GetMemberDetails( $borrowernumber ); my @bordat; $bordat[0] = $borr; $template->param( "USER_INFO" => \@bordat ); - + my $all_perms = get_all_subpermissions(); my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow - editcatalogue updatecharges management tools editauthorities serials reports); + editcatalogue updatecharges management tools editauthorities serials reports acquisition); # We are going to use the $flags returned by checkauth # to create the template's parameters that will indicate # which menus the user can access. @@ -184,7 +194,7 @@ sub get_template_and_user { $template->param( CAN_user_updatecharges => 1 ); $template->param( CAN_user_acquisition => 1 ); $template->param( CAN_user_management => 1 ); - $template->param( CAN_user_tools => 1 ); + $template->param( CAN_user_tools => 1 ); $template->param( CAN_user_editauthorities => 1 ); $template->param( CAN_user_serials => 1 ); $template->param( CAN_user_reports => 1 ); @@ -196,24 +206,16 @@ sub get_template_and_user { } } - if (C4::Context->preference('GranularPermissions')) { - if ( $flags ) { - foreach my $module (keys %$all_perms) { - if ( $flags->{$module} == 1) { - foreach my $subperm (keys %{ $all_perms->{$module} }) { - $template->param( "CAN_user_${module}_${subperm}" => 1 ); - } - } elsif ( ref($flags->{$module}) ) { - foreach my $subperm (keys %{ $flags->{$module} } ) { - $template->param( "CAN_user_${module}_${subperm}" => 1 ); - } - } - } - } - } else { + if ( $flags ) { foreach my $module (keys %$all_perms) { - foreach my $subperm (keys %{ $all_perms->{$module} }) { - $template->param( "CAN_user_${module}_${subperm}" => 1 ); + if ( $flags->{$module} == 1) { + foreach my $subperm (keys %{ $all_perms->{$module} }) { + $template->param( "CAN_user_${module}_${subperm}" => 1 ); + } + } elsif ( ref($flags->{$module}) ) { + foreach my $subperm (keys %{ $flags->{$module} } ) { + $template->param( "CAN_user_${module}_${subperm}" => 1 ); + } } } } @@ -228,6 +230,46 @@ sub get_template_and_user { } } } + # Logged-in opac search history + # If the requested template is an opac one and opac search history is enabled + if ($in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory')) { + my $dbh = C4::Context->dbh; + my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?"; + my $sth = $dbh->prepare($query); + $sth->execute($borrowernumber); + + # If at least one search has already been performed + if ($sth->fetchrow_array > 0) { + # We show the link in opac + $template->param(ShowOpacRecentSearchLink => 1); + } + + # And if there's a cookie with searches performed when the user was not logged in, + # we add them to the logged-in search history + my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches'); + if ($searchcookie){ + $searchcookie = uri_unescape($searchcookie); + my @recentSearches = @{thaw($searchcookie) || []}; + if (@recentSearches) { + my $sth = $dbh->prepare($SEARCH_HISTORY_INSERT_SQL); + $sth->execute( $borrowernumber, + $in->{'query'}->cookie("CGISESSID"), + $_->{'query_desc'}, + $_->{'query_cgi'}, + $_->{'total'}, + $_->{'time'}, + ) foreach @recentSearches; + + # And then, delete the cookie's content + my $newsearchcookie = $in->{'query'}->cookie( + -name => 'KohaOpacRecentSearches', + -value => freeze([]), + -expires => '' + ); + $cookie = [$cookie, $newsearchcookie]; + } + } + } } else { # if this is an anonymous session, setup to display public lists... @@ -243,16 +285,41 @@ sub get_template_and_user { $template->param( js_widgets => $in->{'js_widgets'} ); $template->param( sessionID => $sessionID ); - - my ($total, $pubshelves) = C4::Context->get_shelves_userenv(); # an anonymous user has no 'barshelves'... - if (defined(($pubshelves))) { - $template->param( pubshelves => scalar (@$pubshelves), - pubshelvesloop => $pubshelves, - ); - $template->param( pubtotal => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar (@$pubshelves)); - } + + my ($total, $pubshelves) = C4::Context->get_shelves_userenv(); # an anonymous user has no 'barshelves'... + if (defined(($pubshelves))) { + $template->param( pubshelves => scalar (@$pubshelves), + pubshelvesloop => $pubshelves, + ); + $template->param( pubtotal => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar (@$pubshelves)); + } - } + } + # Anonymous opac search history + # If opac search history is enabled and at least one search has already been performed + if (C4::Context->preference('EnableOpacSearchHistory')) { + my $searchcookie = $in->{'query'}->cookie('KohaOpacRecentSearches'); + if ($searchcookie){ + $searchcookie = uri_unescape($searchcookie); + my @recentSearches = @{thaw($searchcookie) || []}; + # We show the link in opac + if (@recentSearches) { + $template->param(ShowOpacRecentSearchLink => 1); + } + } + } + + if(C4::Context->preference('dateformat')){ + if(C4::Context->preference('dateformat') eq "metric"){ + $template->param(dateformat_metric => 1); + } elsif(C4::Context->preference('dateformat') eq "us"){ + $template->param(dateformat_us => 1); + } else { + $template->param(dateformat_iso => 1); + } + } else { + $template->param(dateformat_iso => 1); + } # these template parameters are set the same regardless of $in->{'type'} $template->param( @@ -265,15 +332,20 @@ sub get_template_and_user { LoginSurname => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu", TagsEnabled => C4::Context->preference("TagsEnabled"), hide_marc => C4::Context->preference("hide_marc"), - dateformat => C4::Context->preference("dateformat"), - 'item-level_itypes' => C4::Context->preference('item-level_itypes'), + item_level_itypes => C4::Context->preference('item-level_itypes'), patronimages => C4::Context->preference("patronimages"), singleBranchMode => C4::Context->preference("singleBranchMode"), - ); + XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"), + XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"), + using_https => $in->{'query'}->https() ? 1 : 0, + noItemTypeImages => C4::Context->preference("noItemTypeImages"), + ); if ( $in->{'type'} eq "intranet" ) { $template->param( AmazonContent => C4::Context->preference("AmazonContent"), + AmazonCoverImages => C4::Context->preference("AmazonCoverImages"), + AmazonEnabled => C4::Context->preference("AmazonEnabled"), AmazonSimilarItems => C4::Context->preference("AmazonSimilarItems"), AutoLocation => C4::Context->preference("AutoLocation"), "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1, @@ -284,60 +356,82 @@ sub get_template_and_user { IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"), LibraryName => C4::Context->preference("LibraryName"), LoginBranchname => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:"insecure"), - TemplateEncoding => C4::Context->preference("TemplateEncoding"), advancedMARCEditor => C4::Context->preference("advancedMARCEditor"), canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'), intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"), + IntranetFavicon => C4::Context->preference("IntranetFavicon"), intranetreadinghistory => C4::Context->preference("intranetreadinghistory"), intranetstylesheet => C4::Context->preference("intranetstylesheet"), + IntranetUserCSS => C4::Context->preference("IntranetUserCSS"), intranetuserjs => C4::Context->preference("intranetuserjs"), - noItemTypeImages => C4::Context->preference("noItemTypeImages"), + intranetbookbag => C4::Context->preference("intranetbookbag"), suggestion => C4::Context->preference("suggestion"), virtualshelves => C4::Context->preference("virtualshelves"), + StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"), + NoZebra => C4::Context->preference('NoZebra'), ); } else { warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' ); + #TODO : replace LibraryName syspref with 'system name', and remove this html processing my $LibraryNameTitle = C4::Context->preference("LibraryName"); $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi; $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg; + # variables passed from CGI: opac_css_override and opac_search_limits. + my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'}; + my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'}; + my $opac_name = ''; + if (($opac_search_limit =~ /branch:(\w+)/ && $opac_limit_override) || $in->{'query'}->param('limit') =~ /branch:(\w+)/){ + $opac_name = $1; # opac_search_limit is a branch, so we use it. + } elsif (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'}) { + $opac_name = C4::Context->userenv->{'branch'}; + } $template->param( AmazonContent => "" . C4::Context->preference("AmazonContent"), AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"), AuthorisedValueImages => C4::Context->preference("AuthorisedValueImages"), + BranchesLoop => GetBranchesLoop($opac_name), LibraryName => "" . C4::Context->preference("LibraryName"), LibraryNameTitle => "" . $LibraryNameTitle, LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"", - OPACAmazonSimilarItems => "" . C4::Context->preference("OPACAmazonSimilarItems"), + OPACAmazonEnabled => C4::Context->preference("OPACAmazonEnabled"), + OPACAmazonSimilarItems => C4::Context->preference("OPACAmazonSimilarItems"), + OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"), + OPACAmazonReviews => C4::Context->preference("OPACAmazonReviews"), OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"), + OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"), OPACItemHolds => C4::Context->preference("OPACItemHolds"), OPACShelfBrowser => "". C4::Context->preference("OPACShelfBrowser"), OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"), OPACUserCSS => "". C4::Context->preference("OPACUserCSS"), OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"), OpacAuthorities => C4::Context->preference("OpacAuthorities"), - OPACBaseURL => ($in->{'query'}->https() ? "https://" : "http://") . - $ENV{'SERVER_NAME'} . + OPACBaseURL => ($in->{'query'}->https() ? "https://" : "http://") . $ENV{'SERVER_NAME'} . ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"), + opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'}, + opac_search_limit => $opac_search_limit, + opac_limit_override => $opac_limit_override, OpacBrowser => C4::Context->preference("OpacBrowser"), OpacCloud => C4::Context->preference("OpacCloud"), OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"), OpacNav => "" . C4::Context->preference("OpacNav"), OpacPasswordChange => C4::Context->preference("OpacPasswordChange"), + OPACPatronDetails => C4::Context->preference("OPACPatronDetails"), + OPACPrivacy => C4::Context->preference("OPACPrivacy"), + OPACFinesTab => C4::Context->preference("OPACFinesTab"), OpacTopissue => C4::Context->preference("OpacTopissue"), RequestOnOpac => C4::Context->preference("RequestOnOpac"), - TemplateEncoding => "". C4::Context->preference("TemplateEncoding"), 'Version' => C4::Context->preference('Version'), - XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"), - XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"), hidelostitems => C4::Context->preference("hidelostitems"), - mylibraryfirst => C4::Context->preference("SearchMyLibraryFirst"), + mylibraryfirst => (C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv) ? C4::Context->userenv->{'branch'} : '', + opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"), + opaccolorstylesheet => "" . C4::Context->preference("opaccolorstylesheet"), + opacstylesheet => "" . C4::Context->preference("opacstylesheet"), opacbookbag => "" . C4::Context->preference("opacbookbag"), - opaccolorstylesheet => "". C4::Context->preference("opaccolorstylesheet"), opaccredits => "" . C4::Context->preference("opaccredits"), + OpacFavicon => C4::Context->preference("OpacFavicon"), opacheader => "" . C4::Context->preference("opacheader"), - opaclanguagesdisplay => "". C4::Context->preference("opaclanguagesdisplay"), - opaclayoutstylesheet => "". C4::Context->preference("opaclayoutstylesheet"), + opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"), opacreadinghistory => C4::Context->preference("opacreadinghistory"), opacsmallimage => "" . C4::Context->preference("opacsmallimage"), opacuserjs => C4::Context->preference("opacuserjs"), @@ -345,19 +439,38 @@ sub get_template_and_user { reviewson => C4::Context->preference("reviewson"), suggestion => "" . C4::Context->preference("suggestion"), virtualshelves => "" . C4::Context->preference("virtualshelves"), + OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"), + OpacAddMastheadLibraryPulldown => C4::Context->preference("OpacAddMastheadLibraryPulldown"), + OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"), + OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"), + SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"), + SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"), + SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"), + SyndeticsTOC => C4::Context->preference("SyndeticsTOC"), + SyndeticsSummary => C4::Context->preference("SyndeticsSummary"), + SyndeticsEditions => C4::Context->preference("SyndeticsEditions"), + SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"), + SyndeticsReviews => C4::Context->preference("SyndeticsReviews"), + SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"), + SyndeticsAwards => C4::Context->preference("SyndeticsAwards"), + SyndeticsSeries => C4::Context->preference("SyndeticsSeries"), + SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"), ); + + $template->param(OpacPublic => '1') if ($template->param( 'loggedinusername') || C4::Context->preference("OpacPublic")); } + $template->param(listloop=>[{shelfname=>"Freelist", shelfnumber=>110}]); return ( $template, $borrowernumber, $cookie, $flags); } -=item checkauth +=head2 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 due to -insufficent privileges (see $flagsrequired below), it +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. @@ -385,21 +498,22 @@ 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. -If the GranularPermissions system preference is ON, the -value of each key in the C hash takes on an additional -meaning, e.g., +Koha also has a concept of sub-permissions, also known as +granular permissions. This makes the value of each key +in the C hash take on an additional +meaning, i.e., -=item 1 + 1 The user must have access to all subfunctions of the module specified by the hash key. -=item * + * The user must have access to at least one subfunction of the module specified by the hash key. -=item specific permission, e.g., 'export_catalog' + specific permission, e.g., 'export_catalog' The user must have access to the specific subfunction list, which must correspond to a row in the permissions table. @@ -418,7 +532,7 @@ user has authenticated, C<&checkauth> restarts the original script 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 +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 @@ -442,7 +556,7 @@ sub _version_check ($$) { if ($type ne 'opac') { warn "Install required, redirecting to Installer"; print $query->redirect("/cgi-bin/koha/installer/install.pl"); - } + } else { warn "OPAC Install required, redirecting to maintenance"; print $query->redirect("/cgi-bin/koha/maintenance.pl"); @@ -466,7 +580,7 @@ sub _version_check ($$) { } else { warn sprintf("OPAC: " . $warning, 'maintenance'); print $query->redirect("/cgi-bin/koha/maintenance.pl"); - } + } exit; } } @@ -511,7 +625,7 @@ sub checkauth { ); $loggedin = 1; } - elsif ( $sessionID = $query->cookie("CGISESSID")) { # assignment, not comparison + elsif ( $sessionID = $query->cookie("CGISESSID")) { # assignment, not comparison my $session = get_session($sessionID); C4::Context->_new_userenv($sessionID); my ($ip, $lasttime, $sessiontype); @@ -532,11 +646,10 @@ sub checkauth { $userid = $session->param('id'); $sessiontype = $session->param('sessiontype'); } - - if ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) ) { - #if a user enters an id ne to the id in the current session, we need to log them in... - #first we need to clear the anonymous session... - $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id'); + if ( ($query->param('koha_login_context')) && ($query->param('userid') ne $session->param('id')) ) { + #if a user enters an id ne to the id in the current session, we need to log them in... + #first we need to clear the anonymous session... + $debug and warn "query id = " . $query->param('userid') . " but session id = " . $session->param('id'); $session->flush; $session->delete(); C4::Context->_unset_userenv($sessionID); @@ -545,45 +658,49 @@ sub checkauth { } elsif ($logout) { # voluntary logout the user - $session->flush; + $session->flush; $session->delete(); C4::Context->_unset_userenv($sessionID); - _session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,localtime); + _session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime)); $sessionID = undef; $userid = undef; + + if ($cas and $caslogout) { + logout_cas($query); + } + } + elsif ( $lasttime < time() - $timeout ) { + # timed logout + $info{'timed_out'} = 1; + $session->delete(); + C4::Context->_unset_userenv($sessionID); + _session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime)); + $userid = undef; + $sessionID = undef; + } + 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; + $session->delete(); + C4::Context->_unset_userenv($sessionID); + _session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'}); + $sessionID = undef; + $userid = undef; + } + else { + $cookie = $query->cookie( CGISESSID => $session->id ); + $session->param('lasttime',time()); + unless ( $sessiontype eq 'anon' ) { #if this is an anonymous session, we want to update the session, but not behave as if they are logged in... + $flags = haspermission($userid, $flagsrequired); + if ($flags) { + $loggedin = 1; + } else { + $info{'nopermission'} = 1; + } + } } - elsif ( $lasttime < time() - $timeout ) { - # timed logout - $info{'timed_out'} = 1; - $session->delete(); - C4::Context->_unset_userenv($sessionID); - _session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,localtime); - $userid = undef; - $sessionID = undef; - } - 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; - $session->delete(); - C4::Context->_unset_userenv($sessionID); - _session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,localtime, $info{'newip'}); - $sessionID = undef; - $userid = undef; - } - else { - $cookie = $query->cookie( CGISESSID => $session->id ); - $session->param('lasttime',time()); - unless ( $sessiontype eq 'anon' ) { #if this is an anonymous session, we want to update the session, but not behave as if they are logged in... - $flags = haspermission( $dbh, $userid, $flagsrequired ); - if ($flags) { - $loggedin = 1; - } else { - $info{'nopermission'} = 1; - } - } - } } unless ($userid || $sessionID) { #we initiate a session prior to checking for a username to allow for anonymous sessions... @@ -591,12 +708,21 @@ sub checkauth { my $sessionID = $session->id; C4::Context->_new_userenv($sessionID); $cookie = $query->cookie(CGISESSID => $sessionID); - if ( $userid = $query->param('userid') ) { + $userid = $query->param('userid'); + if ($cas || $userid) { my $password = $query->param('password'); - my ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password ); - if ($return) { - _session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},localtime); - if ( $flags = haspermission( $dbh, $userid, $flagsrequired ) ) { + my ($return, $cardnumber); + if ($cas && $query->param('ticket')) { + my $retuserid; + ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query ); + $userid = $retuserid; + $info{'invalidCasLogin'} = 1 unless ($return); + } else { + ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query ); + } + if ($return) { + _session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime)); + if ( $flags = haspermission( $userid, $flagsrequired ) ) { $loggedin = 1; } else { @@ -718,7 +844,7 @@ sub checkauth { $session->param('barshelves', $barshelves->[0]); $session->param('pubshelves', $pubshelves->[0]); $session->param('totshelves', $total); - + C4::Context::set_shelves_userenv('bar',$barshelves->[0]); C4::Context::set_shelves_userenv('pub',$pubshelves->[0]); C4::Context::set_shelves_userenv('tot',$total); @@ -730,7 +856,7 @@ sub checkauth { } } } # END if ( $userid = $query->param('userid') ) - elsif ($type eq "opac") { + elsif ($type eq "opac") { # if we are here this is an anonymous session; add public lists to it and a few other items... # anonymous sessions are created only for the OPAC $debug and warn "Initiating an anonymous session..."; @@ -744,7 +870,7 @@ sub checkauth { $session->param('totshelves', $total); C4::Context::set_shelves_userenv('pub',$pubshelves->[0]); C4::Context::set_shelves_userenv('tot',$total); - + # setting a couple of other session vars... $session->param('ip',$session->remote_addr()); $session->param('lasttime',time()); @@ -768,11 +894,11 @@ sub checkauth { # AUTH rejected, show the login/password template, after checking the DB. # # - + # get the inputs from the incoming query my @inputs = (); foreach my $name ( param $query) { - (next) if ( $name eq 'userid' || $name eq 'password' ); + (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' ); my $value = $query->param($name); push @inputs, { name => $name, value => $value }; } @@ -789,12 +915,14 @@ sub checkauth { $template->param( login => 1, INPUTS => \@inputs, + casAuthentication => C4::Context->preference("casAuthentication"), suggestion => C4::Context->preference("suggestion"), virtualshelves => C4::Context->preference("virtualshelves"), LibraryName => C4::Context->preference("LibraryName"), opacuserlogin => C4::Context->preference("opacuserlogin"), OpacNav => C4::Context->preference("OpacNav"), opaccredits => C4::Context->preference("opaccredits"), + OpacFavicon => C4::Context->preference("OpacFavicon"), opacreadinghistory => C4::Context->preference("opacreadinghistory"), opacsmallimage => C4::Context->preference("opacsmallimage"), opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"), @@ -809,19 +937,28 @@ sub checkauth { opacheader => C4::Context->preference("opacheader"), TagsEnabled => C4::Context->preference("TagsEnabled"), OPACUserCSS => C4::Context->preference("OPACUserCSS"), + opacstylesheet => C4::Context->preference("opacstylesheet"), intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"), intranetstylesheet => C4::Context->preference("intranetstylesheet"), + intranetbookbag => C4::Context->preference("intranetbookbag"), IntranetNav => C4::Context->preference("IntranetNav"), intranetuserjs => C4::Context->preference("intranetuserjs"), - TemplateEncoding => C4::Context->preference("TemplateEncoding"), IndependantBranches=> C4::Context->preference("IndependantBranches"), AutoLocation => C4::Context->preference("AutoLocation"), - wrongip => $info{'wrongip'} + wrongip => $info{'wrongip'}, ); - + + $template->param( OpacPublic => C4::Context->preference("OpacPublic")); $template->param( loginprompt => 1 ) unless $info{'nopermission'}; + if ($cas) { + $template->param( + casServerUrl => login_cas_url(), + invalidCasLogin => $info{'invalidCasLogin'} + ); + } + my $self_url = $query->url( -absolute => 1 ); $template->param( url => $self_url, @@ -839,7 +976,7 @@ sub checkauth { exit; } -=item check_api_auth +=head2 check_api_auth ($status, $cookie, $sessionId) = check_api_auth($query, $userflags); @@ -859,7 +996,7 @@ are OK. Possible return values in C<$status> are: -=over 4 +=over =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values. @@ -941,7 +1078,7 @@ sub check_api_auth { } else { my $cookie = $query->cookie( CGISESSID => $session->id ); $session->param('lasttime',time()); - my $flags = haspermission( $dbh, $userid, $flagsrequired ); + my $flags = haspermission($userid, $flagsrequired); if ($flags) { return ("ok", $cookie, $sessionID); } else { @@ -957,14 +1094,21 @@ sub check_api_auth { } } else { # new login - my $userid = $query->param('userid'); - my $password = $query->param('password'); + my $userid = $query->param('userid'); + my $password = $query->param('password'); unless ($userid and $password) { # caller did something wrong, fail the authenticateion return ("failed", undef, undef); } - my ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password ); - if ($return and haspermission( $dbh, $userid, $flagsrequired)) { + my ($return, $cardnumber); + if ($cas && $query->param('ticket')) { + my $retuserid; + ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, $password, $query ); + $userid = $retuserid; + } else { + ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query ); + } + if ($return and haspermission( $userid, $flagsrequired)) { my $session = get_session(""); return ("failed", undef, undef) unless $session; @@ -1051,7 +1195,7 @@ sub check_api_auth { $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress')); $session->param('ip',$session->remote_addr()); $session->param('lasttime',time()); - } + } C4::Context::set_userenv( $session->param('number'), $session->param('id'), $session->param('cardnumber'), $session->param('firstname'), @@ -1063,10 +1207,10 @@ sub check_api_auth { } else { return ("failed", undef, undef); } - } + } } -=item check_cookie_auth +=head2 check_cookie_auth ($status, $sessionId) = check_api_auth($cookie, $userflags); @@ -1079,7 +1223,7 @@ have been authenticated in the usual way. Possible return values in C<$status> are: -=over 4 +=over =item "ok" -- user authenticated; C<$sessionID> have valid values. @@ -1159,7 +1303,7 @@ sub check_cookie_auth { return ("expired", undef); } else { $session->param('lasttime',time()); - my $flags = haspermission( $dbh, $userid, $flagsrequired ); + my $flags = haspermission($userid, $flagsrequired); if ($flags) { return ("ok", $sessionID); } else { @@ -1175,13 +1319,13 @@ sub check_cookie_auth { } } -=item get_session +=head2 get_session use CGI::Session; my $session = get_session($sessionID); Given a session ID, retrieve the CGI::Session object used to store -the session's state. The session object can be used to store +the session's state. The session object can be used to store data that needs to be accessed by different scripts during a user's session. @@ -1210,13 +1354,22 @@ sub get_session { sub checkpw { - my ( $dbh, $userid, $password ) = @_; + my ( $dbh, $userid, $password, $query ) = @_; if ($ldap) { - $debug and print STDERR "## checkpw - checking LDAP\n"; + $debug and print "## checkpw - checking LDAP\n"; my ($retval,$retcard) = checkpw_ldap(@_); # EXTERNAL AUTH ($retval) and return ($retval,$retcard); } + if ($cas && $query->param('ticket')) { + $debug and print STDERR "## checkpw - checking CAS\n"; + # In case of a CAS authentication, we use the ticket instead of the password + my $ticket = $query->param('ticket'); + my ($retval,$retcard,$retuserid) = checkpw_cas($dbh, $ticket, $query); # EXTERNAL AUTH + ($retval) and return ($retval,$retcard,$retuserid); + return 0; + } + # INTERNAL AUTH my $sth = $dbh->prepare( @@ -1227,7 +1380,7 @@ sub checkpw { my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname, $surname, $branchcode, $flags ) = $sth->fetchrow; - if ( md5_base64($password) eq $md5password ) { + if ( md5_base64($password) eq $md5password and $md5password ne "!") { C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber, $firstname, $surname, $branchcode, $flags ); @@ -1270,12 +1423,14 @@ sub checkpw { return 0; } -=item getuserflags +=head2 getuserflags + + my $authflags = getuserflags($flags, $userid, [$dbh]); - $authflags = getuserflags($flags,$dbh); Translates integer flags into permissions strings hash. C<$flags> is the integer userflags value ( borrowers.userflags ) +C<$userid> is the members.userid, used for building subpermissions C<$authflags> is a hashref of permissions =cut @@ -1283,7 +1438,7 @@ C<$authflags> is a hashref of permissions sub getuserflags { my $flags = shift; my $userid = shift; - my $dbh = shift; + my $dbh = @_ ? shift : C4::Context->dbh; my $userflags; $flags = 0 unless $flags; my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags"); @@ -1308,24 +1463,20 @@ sub getuserflags { return $userflags; } -=item get_user_subpermissions +=head2 get_user_subpermissions -=over 4 - -my $user_perm_hashref = get_user_subpermissions($userid); - -=back + $user_perm_hashref = get_user_subpermissions($userid); Given the userid (note, not the borrowernumber) of a staff user, -return a hashref of hashrefs of the specific subpermissions +return a hashref of hashrefs of the specific subpermissions accorded to the user. An example return is -{ + { tools => { export_catalog => 1, import_patrons => 1, } -} + } The top-level hash-key is a module or function code from userflags.flag, while the second-level key is a code @@ -1341,7 +1492,7 @@ sub get_user_subpermissions { my $userid = shift; my $dbh = C4::Context->dbh; - my $sth = $dbh->prepare("SELECT flag, code + my $sth = $dbh->prepare("SELECT flag, user_permissions.code FROM user_permissions JOIN permissions USING (module_bit, code) JOIN userflags ON (module_bit = bit) @@ -1356,13 +1507,9 @@ sub get_user_subpermissions { return $user_perms; } -=item get_all_subpermissions - -=over 4 +=head2 get_all_subpermissions -my $perm_hashref = get_all_subpermissions(); - -=back + my $perm_hashref = get_all_subpermissions(); Returns a hashref of hashrefs defining all specific permissions currently defined. The return value @@ -1386,11 +1533,11 @@ sub get_all_subpermissions { return $all_perms; } -=item haspermission +=head2 haspermission - $flags = ($dbh,$member,$flagsrequired); + $flags = ($userid, $flagsrequired); -C<$member> may be either userid or overloaded with $borrower hashref from GetMemberDetails. +C<$userid> the userid of the member C<$flags> is a hashref of required flags like C<$borrower-<{authflags}> Returns member's flags or 0 if a permission is not met. @@ -1398,41 +1545,30 @@ Returns member's flags or 0 if a permission is not met. =cut sub haspermission { - my ( $dbh, $userid, $flagsrequired ) = @_; - my ($flags,$intflags); - $dbh=C4::Context->dbh unless($dbh); - if(ref($userid)) { - $intflags = $userid->{'flags'}; - } else { - my $sth = $dbh->prepare("SELECT flags FROM borrowers WHERE userid=?"); - $sth->execute($userid); - my ($intflags) = $sth->fetchrow; - $flags = getuserflags( $intflags, $userid, $dbh ); - } + my ($userid, $flagsrequired) = @_; + my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?"); + $sth->execute($userid); + my $flags = getuserflags( $sth->fetchrow(), $userid ); if ( $userid eq C4::Context->config('user') ) { # Super User Account from /etc/koha.conf $flags->{'superlibrarian'} = 1; } - if ( $userid eq 'demo' && C4::Context->config('demo') ) { + elsif ( $userid eq 'demo' && C4::Context->config('demo') ) { # Demo user that can do "anything" (demo=1 in /etc/koha.conf) $flags->{'superlibrarian'} = 1; } return $flags if $flags->{superlibrarian}; foreach my $module ( keys %$flagsrequired ) { - if (C4::Context->preference('GranularPermissions')) { - my $subperm = $flagsrequired->{$module}; - if ($subperm eq '*') { - return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) ); - } else { - return 0 unless ( $flags->{$module} == 1 or - ( ref($flags->{$module}) and - exists $flags->{$module}->{$subperm} and - $flags->{$module}->{$subperm} == 1 - ) - ); - } + my $subperm = $flagsrequired->{$module}; + if ($subperm eq '*') { + return 0 unless ( $flags->{$module} == 1 or ref($flags->{$module}) ); } else { - return 0 unless ( $flags->{$module} ); + return 0 unless ( $flags->{$module} == 1 or + ( ref($flags->{$module}) and + exists $flags->{$module}->{$subperm} and + $flags->{$module}->{$subperm} == 1 + ) + ); } } return $flags; @@ -1442,6 +1578,10 @@ sub haspermission { sub getborrowernumber { my ($userid) = @_; + my $userenv = C4::Context->userenv; + if ( defined( $userenv ) && ref( $userenv ) eq 'HASH' && $userenv->{number} ) { + return $userenv->{number}; + } my $dbh = C4::Context->dbh; for my $field ( 'userid', 'cardnumber' ) { my $sth = @@ -1459,8 +1599,6 @@ END { } # module clean-up code here (global destructor) 1; __END__ -=back - =head1 SEE ALSO CGI(3)