+
# -*- tab-width: 8 -*-
# NOTE: This file uses 8-character tabs; do not change the tab size!
use Digest::MD5 qw(md5_base64);
use CGI::Session;
-
require Exporter;
use C4::Context;
use C4::Output; # to get the template
use C4::Members;
use C4::Koha;
use C4::Branch; # GetBranches
+use C4::VirtualShelves;
# use utf8;
-# use Net::LDAP;
-# use Net::LDAP qw(:all);
-
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
-
-# set the version for version checking
-$VERSION = 3.00;
+use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap);
+
+BEGIN {
+ $VERSION = 3.02; # set version for version checking
+ $debug = $ENV{DEBUG} || 0 ;
+ @ISA = qw(Exporter);
+ @EXPORT = qw(&checkauth &get_template_and_user);
+ @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;
+ if ($ldap) {
+ require C4::Auth_with_ldap; # no import
+ import C4::Auth_with_ldap qw(checkpw_ldap);
+ }
+}
=head1 NAME
use CGI;
use C4::Auth;
+ use C4::Output;
my $query = new CGI;
query => $query,
type => "opac",
authnotrequired => 1,
- flagsrequired => {borrow => 1},
+ flagsrequired => {borrow => 1, catalogue => '*', tools => 'import_patrons' },
}
);
- print $query->header(
- -type => 'utf-8',
- -cookie => $cookie
- ), $template->output;
-
+ output_html_with_http_headers $query, $cookie, $template->output;
=head1 DESCRIPTION
=over 2
-=cut
-
-@ISA = qw(Exporter);
-@EXPORT = qw(
- &checkauth
- &get_template_and_user
-);
-
=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},
- }
- );
+ 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<query>, C<flagsrequired> and C<authnotrequired>
to C<&checkauth> (in this module) to perform authentification.
my $insecure = C4::Context->preference('insecure');
if ($user or $insecure) {
- # load the template variables for stylesheets and JavaScript
- $template->param( css_libs => $in->{'css_libs'} );
- $template->param( css_module => $in->{'css_module'} );
- $template->param( css_page => $in->{'css_page'} );
- $template->param( css_widgets => $in->{'css_widgets'} );
+ # load the template variables for stylesheets and JavaScript
+ $template->param( css_libs => $in->{'css_libs'} );
+ $template->param( css_module => $in->{'css_module'} );
+ $template->param( css_page => $in->{'css_page'} );
+ $template->param( css_widgets => $in->{'css_widgets'} );
$template->param( js_libs => $in->{'js_libs'} );
$template->param( js_module => $in->{'js_module'} );
$template->param( js_page => $in->{'js_page'} );
$template->param( js_widgets => $in->{'js_widgets'} );
- # user info
+ # user info
$template->param( loggedinusername => $user );
$template->param( sessionID => $sessionID );
+ my ($total, $pubshelves, $barshelves) = C4::Context->get_shelves_userenv();
+ if (defined($pubshelves)) {
+ $template->param( pubshelves => scalar (@$pubshelves),
+ pubshelvesloop => $pubshelves,
+ );
+ $template->param( pubtotal => $total->{'pubtotal'}, ) if ($total->{'pubtotal'} > scalar (@$pubshelves));
+ }
+ if (defined($barshelves)) {
+ $template->param( barshelves => scalar (@$barshelves),
+ barshelvesloop => $barshelves,
+ );
+ $template->param( bartotal => $total->{'bartotal'}, ) if ($total->{'bartotal'} > scalar (@$barshelves));
+ }
+
$borrowernumber = getborrowernumber($user);
- my ( $borr, $alternativeflags ) =
- GetMemberDetails( $borrowernumber );
+ 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);
# 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.
$template->param( CAN_user_catalogue => 1 );
$template->param( CAN_user_parameters => 1 );
$template->param( CAN_user_borrowers => 1 );
- $template->param( CAN_user_permission => 1 );
+ $template->param( CAN_user_permissions => 1 );
$template->param( CAN_user_reserveforothers => 1 );
$template->param( CAN_user_borrow => 1 );
$template->param( CAN_user_editcatalogue => 1 );
- $template->param( CAN_user_updatecharge => 1 );
+ $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_editauthorities => 1 );
$template->param( CAN_user_serials => 1 );
$template->param( CAN_user_reports => 1 );
+ $template->param( CAN_user_staffaccess => 1 );
+ foreach my $module (keys %$all_perms) {
+ foreach my $subperm (keys %{ $all_perms->{$module} }) {
+ $template->param( "CAN_user_${module}_${subperm}" => 1 );
+ }
+ }
}
- if ( $flags && $flags->{circulate} == 1 ) {
- $template->param( CAN_user_circulate => 1 );
- }
-
- if ( $flags && $flags->{catalogue} == 1 ) {
- $template->param( CAN_user_catalogue => 1 );
- }
-
- if ( $flags && $flags->{parameters} == 1 ) {
- $template->param( CAN_user_parameters => 1 );
- $template->param( CAN_user_management => 1 );
- }
-
- if ( $flags && $flags->{borrowers} == 1 ) {
- $template->param( CAN_user_borrowers => 1 );
- }
-
- if ( $flags && $flags->{permissions} == 1 ) {
- $template->param( CAN_user_permission => 1 );
+ 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 {
+ foreach my $module (keys %$all_perms) {
+ foreach my $subperm (keys %{ $all_perms->{$module} }) {
+ $template->param( "CAN_user_${module}_${subperm}" => 1 );
+ }
+ }
}
- if ( $flags && $flags->{reserveforothers} == 1 ) {
- $template->param( CAN_user_reserveforothers => 1 );
+ if ($flags) {
+ foreach my $module (keys %$flags) {
+ if ( $flags->{$module} == 1 or ref($flags->{$module}) ) {
+ $template->param( "CAN_user_$module" => 1 );
+ if ($module eq "parameters") {
+ $template->param( CAN_user_management => 1 );
+ }
+ }
+ }
}
+ }
+ else { # if this is an anonymous session, setup to display public lists...
- if ( $flags && $flags->{borrow} == 1 ) {
- $template->param( CAN_user_borrow => 1 );
- }
+ # load the template variables for stylesheets and JavaScript
+ $template->param( css_libs => $in->{'css_libs'} );
+ $template->param( css_module => $in->{'css_module'} );
+ $template->param( css_page => $in->{'css_page'} );
+ $template->param( css_widgets => $in->{'css_widgets'} );
- if ( $flags && $flags->{editcatalogue} == 1 ) {
- $template->param( CAN_user_editcatalogue => 1 );
- }
+ $template->param( js_libs => $in->{'js_libs'} );
+ $template->param( js_module => $in->{'js_module'} );
+ $template->param( js_page => $in->{'js_page'} );
+ $template->param( js_widgets => $in->{'js_widgets'} );
- if ( $flags && $flags->{updatecharges} == 1 ) {
- $template->param( CAN_user_updatecharge => 1 );
+ $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));
}
- if ( $flags && $flags->{acquisition} == 1 ) {
- $template->param( CAN_user_acquisition => 1 );
- }
+ }
- if ( $flags && $flags->{tools} == 1 ) {
- $template->param( CAN_user_tools => 1 );
- }
-
- if ( $flags && $flags->{editauthorities} == 1 ) {
- $template->param( CAN_user_editauthorities => 1 );
- }
-
- if ( $flags && $flags->{serials} == 1 ) {
- $template->param( CAN_user_serials => 1 );
- }
+ # these template parameters are set the same regardless of $in->{'type'}
+ $template->param(
+ "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
+ EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
+ GoogleJackets => C4::Context->preference("GoogleJackets"),
+ KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
+ LoginBranchcode => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
+ LoginFirstname => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
+ 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'),
+ patronimages => C4::Context->preference("patronimages"),
+ singleBranchMode => C4::Context->preference("singleBranchMode"),
+ 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"),
+ );
- if ( $flags && $flags->{reports} == 1 ) {
- $template->param( CAN_user_reports => 1 );
- }
- }
if ( $in->{'type'} eq "intranet" ) {
$template->param(
- intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
- intranetstylesheet => C4::Context->preference("intranetstylesheet"),
- IntranetNav => C4::Context->preference("IntranetNav"),
- intranetuserjs => C4::Context->preference("intranetuserjs"),
- TemplateEncoding => C4::Context->preference("TemplateEncoding"),
- AmazonContent => C4::Context->preference("AmazonContent"),
- LibraryName => C4::Context->preference("LibraryName"),
- LoginBranchcode => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
- LoginBranchname => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:"insecure"),
- LoginFirstname => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
- LoginSurname => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
- AutoLocation => C4::Context->preference("AutoLocation"),
- hide_marc => C4::Context->preference("hide_marc"),
- patronimages => C4::Context->preference("patronimages"),
+ AmazonEnabled => C4::Context->preference("AmazonEnabled"),
+ AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
+ AmazonSimilarItems => C4::Context->preference("AmazonSimilarItems"),
+ AutoLocation => C4::Context->preference("AutoLocation"),
"BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
- advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
- suggestion => C4::Context->preference("suggestion"),
- virtualshelves => C4::Context->preference("virtualshelves"),
- LibraryName => C4::Context->preference("LibraryName"),
- KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
- IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
- IndependantBranches => C4::Context->preference("IndependantBranches"),
+ CircAutocompl => C4::Context->preference("CircAutocompl"),
+ FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
+ IndependantBranches => C4::Context->preference("IndependantBranches"),
+ IntranetNav => C4::Context->preference("IntranetNav"),
+ 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"),
+ intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
+ intranetstylesheet => C4::Context->preference("intranetstylesheet"),
+ intranetuserjs => C4::Context->preference("intranetuserjs"),
+ noItemTypeImages => C4::Context->preference("noItemTypeImages"),
+ suggestion => C4::Context->preference("suggestion"),
+ virtualshelves => C4::Context->preference("virtualshelves"),
+ StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
);
}
else {
my $LibraryNameTitle = C4::Context->preference("LibraryName");
$LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
$LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
- $template->param(
- KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
- suggestion => "" . C4::Context->preference("suggestion"),
- virtualshelves => "" . C4::Context->preference("virtualshelves"),
- OpacNav => "" . C4::Context->preference("OpacNav"),
- opacheader => "" . C4::Context->preference("opacheader"),
- opaccredits => "" . C4::Context->preference("opaccredits"),
- opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
- opaclargeimage => "" . C4::Context->preference("opaclargeimage"),
- opaclayoutstylesheet => "". C4::Context->preference("opaclayoutstylesheet"),
- opaccolorstylesheet => "". C4::Context->preference("opaccolorstylesheet"),
- opaclanguagesdisplay => "". C4::Context->preference("opaclanguagesdisplay"),
- opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
- opacbookbag => "" . C4::Context->preference("opacbookbag"),
- TemplateEncoding => "". C4::Context->preference("TemplateEncoding"),
- AmazonContent => "" . C4::Context->preference("AmazonContent"),
- LibraryName => "" . C4::Context->preference("LibraryName"),
- LibraryNameTitle => "" . $LibraryNameTitle,
- LoginBranchcode => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
- LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
- LoginFirstname => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
- LoginSurname => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
- OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
- opacreadinghistory => C4::Context->preference("opacreadinghistory"),
- opacuserjs => C4::Context->preference("opacuserjs"),
- OpacCloud => C4::Context->preference("OpacCloud"),
- OpacTopissue => C4::Context->preference("OpacTopissue"),
- OpacAuthorities => C4::Context->preference("OpacAuthorities"),
- OpacBrowser => C4::Context->preference("OpacBrowser"),
- RequestOnOpac => C4::Context->preference("RequestOnOpac"),
- reviewson => C4::Context->preference("reviewson"),
- hide_marc => C4::Context->preference("hide_marc"),
- patronimages => C4::Context->preference("patronimages"),
- mylibraryfirst => C4::Context->preference("SearchMyLibraryFirst"),
- "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
+ $template->param(
+ AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
+ AuthorisedValueImages => C4::Context->preference("AuthorisedValueImages"),
+ LibraryName => "" . C4::Context->preference("LibraryName"),
+ LibraryNameTitle => "" . $LibraryNameTitle,
+ LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
+ OPACAmazonEnabled => C4::Context->preference("OPACAmazonEnabled"),
+ OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
+ OPACAmazonSimilarItems => "" . C4::Context->preference("OPACAmazonSimilarItems"),
+ OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
+ 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'} .
+ ($ENV{'SERVER_PORT'} eq ($in->{'query'}->https() ? "443" : "80") ? '' : ":$ENV{'SERVER_PORT'}"),
+ 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"),
+ 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"),
+ opacbookbag => "" . C4::Context->preference("opacbookbag"),
+ opaccolorstylesheet => "". C4::Context->preference("opaccolorstylesheet"),
+ opaccredits => "" . C4::Context->preference("opaccredits"),
+ opacheader => "" . C4::Context->preference("opacheader"),
+ opaclanguagesdisplay => "". C4::Context->preference("opaclanguagesdisplay"),
+ opaclayoutstylesheet => "". C4::Context->preference("opaclayoutstylesheet"),
+ opacreadinghistory => C4::Context->preference("opacreadinghistory"),
+ opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
+ opacuserjs => C4::Context->preference("opacuserjs"),
+ opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
+ reviewson => C4::Context->preference("reviewson"),
+ suggestion => "" . C4::Context->preference("suggestion"),
+ virtualshelves => "" . C4::Context->preference("virtualshelves"),
+ OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
);
}
- return ( $template, $borrowernumber, $cookie );
+ return ( $template, $borrowernumber, $cookie, $flags);
}
=item checkauth
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
+quadruple is returned. If the user is not authorized due to
+insufficent privileges (see $flagsrequired below), it
displays an error page and exits. Otherwise, it displays the
login page and exits.
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<flagsrequired> hash takes on an additional
+meaning, e.g.,
+
+=item 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'
+
+The user must have access to the specific subfunction list, which
+must correspond to a row in the permissions table.
+
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,
=cut
-sub checkauth {
+sub _version_check ($$) {
+ my $type = shift;
my $query = shift;
- # warn "Checking Auth";
- # $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 $version;
# If Version syspref is unavailable, it means Koha is beeing installed,
# and so we must redirect to OPAC maintenance page or to the WebInstaller
- warn "about to check version";
- unless (C4::Context->preference('Version')) {
+ # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
+ if (C4::Context->preference('OpacMaintenance') && $type eq 'opac') {
+ warn "OPAC Install required, redirecting to maintenance";
+ print $query->redirect("/cgi-bin/koha/maintenance.pl");
+ }
+ unless ($version = C4::Context->preference('Version')) { # assignment, not comparison
if ($type ne 'opac') {
warn "Install required, redirecting to Installer";
print $query->redirect("/cgi-bin/koha/installer/install.pl");
exit;
}
+ # check that database and koha version are the same
+ # there is no DB version, it's a fresh install,
+ # go to web installer
+ # there is a DB version, compare it to the code version
+ my $kohaversion=C4::Context::KOHAVERSION;
+ # remove the 3 last . to have a Perl number
+ $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
+ $debug and print STDERR "kohaversion : $kohaversion\n";
+ if ($version < $kohaversion){
+ my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
+ if ($type ne 'opac'){
+ warn sprintf($warning, 'Installer');
+ print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
+ } else {
+ warn sprintf("OPAC: " . $warning, 'maintenance');
+ print $query->redirect("/cgi-bin/koha/maintenance.pl");
+ }
+ exit;
+ }
+}
+
+sub _session_log {
+ (@_) or return 0;
+ open L, ">>/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
+ printf L join("\n",@_);
+ close L;
+}
+sub checkauth {
+ my $query = shift;
+ $debug and warn "Checking Auth";
+ # $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');
+ # days
+ if ($timeout =~ /(\d+)[dD]/) {
+ $timeout = $1 * 86400;
+ };
+ $timeout = 600 unless $timeout;
+
+ _version_check($type,$query);
# state variables
my $loggedin = 0;
my %info;
- my ( $userid, $cookie, $sessionID, $flags );
+ my ( $userid, $cookie, $sessionID, $flags, $barshelves, $pubshelves );
my $logout = $query->param('logout.x');
+
if ( $userid = $ENV{'REMOTE_USER'} ) {
# Using Basic Authentication, no cookies required
$cookie = $query->cookie(
);
$loggedin = 1;
}
- elsif ( $sessionID = $query->cookie("CGISESSID")) {
-<<<<<<< HEAD:C4/Auth.pm
- my $storage_method = C4::Context->preference('SessionStorage');
- my $session;
- if ($storage_method eq 'mysql'){
- $session = new CGI::Session("driver:MySQL", $sessionID, {Handle=>$dbh});
- }
- else {
- # catch all defaults to tmp should work on all systems
- $session = new CGI::Session("driver:File", $sessionID, {Directory=>'/tmp'});
- }
-=======
-# my $session = new CGI::Session("driver:MySQL", $sessionID, {Handle=>$dbh});
- my $session = new CGI::Session("driver:File", $sessionID, {Directory=>'/tmp'});
->>>>>>> Commenting out some noisy warns:C4/Auth.pm
+ elsif ( $sessionID = $query->cookie("CGISESSID")) { # assignment, not comparison
+ my $session = get_session($sessionID);
C4::Context->_new_userenv($sessionID);
+ my ($ip, $lasttime, $sessiontype);
if ($session){
C4::Context::set_userenv(
$session->param('number'), $session->param('id'),
$session->param('branchname'), $session->param('flags'),
$session->param('emailaddress'), $session->param('branchprinter')
);
-# warn "".$session->param('cardnumber').", ".$session->param('firstname').",
-# ".$session->param('surname').", ".$session->param('branch');
+ C4::Context::set_shelves_userenv('bar',$session->param('barshelves'));
+ C4::Context::set_shelves_userenv('pub',$session->param('pubshelves'));
+ C4::Context::set_shelves_userenv('tot',$session->param('totshelves'));
+ $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
+ $ip = $session->param('ip');
+ $lasttime = $session->param('lasttime');
+ $userid = $session->param('id');
+ $sessiontype = $session->param('sessiontype');
}
- my $ip;
- my $lasttime;
- if ($session) {
- $ip = $session->param('ip');
- $lasttime = $session->param('lasttime');
- $userid = $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);
+ $sessionID = undef;
+ $userid = undef;
}
-
-
- if ($logout) {
-
+ elsif ($logout) {
# voluntary logout the user
-
$session->flush;
- $session->delete();
+ $session->delete();
C4::Context->_unset_userenv($sessionID);
+ _session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,localtime);
$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;
- $session->delete();
- 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;
- $session->delete();
- 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( CGISESSID => $session->id );
- $session->param('lasttime',time());
+ 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 {
+ } else {
$info{'nopermission'} = 1;
}
}
}
}
- unless ($userid) {
- my $storage_method = C4::Context->preference('SessionStorage');
- my $session;
- if ($storage_method eq 'mysql'){
- $session = new CGI::Session("driver:MySQL", $sessionID, {Handle=>$dbh});
- }
- else {
- # catch all defaults to tmp should work on all systems
- $session = new CGI::Session("driver:File", $sessionID, {Directory=>'/tmp'});
- }
-
- my $sessionID;
- if ($session) {
- $sessionID = $session->id;
- }
- $userid = $query->param('userid');
- C4::Context->_new_userenv($sessionID);
- my $password = $query->param('password');
+ unless ($userid || $sessionID) {
+ #we initiate a session prior to checking for a username to allow for anonymous sessions...
+ my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
+ my $sessionID = $session->id;
C4::Context->_new_userenv($sessionID);
- my ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password );
- if ($return) {
- 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(CGISESSID => $sessionID);
- if ( $flags = haspermission( $dbh, $userid, $flagsrequired ) ) {
- $loggedin = 1;
+ $cookie = $query->cookie(CGISESSID => $sessionID);
+ if ( $userid = $query->param('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 ) ) {
+ $loggedin = 1;
+ }
+ else {
+ $info{'nopermission'} = 1;
+ C4::Context->_unset_userenv($sessionID);
+ }
+
+ my ($borrowernumber, $firstname, $surname, $userflags,
+ $branchcode, $branchname, $branchprinter, $emailaddress);
+
+ if ( $return == 1 ) {
+ my $select = "
+ SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
+ branches.branchname as branchname,
+ branches.branchprinter as branchprinter,
+ email
+ FROM borrowers
+ LEFT JOIN branches on borrowers.branchcode=branches.branchcode
+ ";
+ my $sth = $dbh->prepare("$select where userid=?");
+ $sth->execute($userid);
+ unless ($sth->rows) {
+ $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
+ $sth = $dbh->prepare("$select where cardnumber=?");
+ $sth->execute($cardnumber);
+ unless ($sth->rows) {
+ $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
+ $sth->execute($userid);
+ unless ($sth->rows) {
+ $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
+ }
+ }
+ }
+ if ($sth->rows) {
+ ($borrowernumber, $firstname, $surname, $userflags,
+ $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
+ $debug and print STDERR "AUTH_3 results: " .
+ "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
+ } else {
+ print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
+ }
+
+# launch a sequence to check if we have a ip for the branch, i
+# if we have one we replace the branchcode of the userenv by the branch bound in the ip.
+
+ my $ip = $ENV{'REMOTE_ADDR'};
+ # if they specify at login, use that
+ if ($query->param('branch')) {
+ $branchcode = $query->param('branch');
+ $branchname = GetBranchName($branchcode);
+ }
+ my $branches = GetBranches();
+ if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
+ # we have to check they are coming from the right ip range
+ my $domain = $branches->{$branchcode}->{'branchip'};
+ if ($ip !~ /^$domain/){
+ $loggedin=0;
+ $info{'wrongip'} = 1;
+ }
+ }
+
+ my @branchesloop;
+ foreach my $br ( keys %$branches ) {
+ # now we work with the treatment of ip
+ my $domain = $branches->{$br}->{'branchip'};
+ if ( $domain && $ip =~ /^$domain/ ) {
+ $branchcode = $branches->{$br}->{'branchcode'};
+
+ # new op dev : add the branchprinter and branchname in the cookie
+ $branchprinter = $branches->{$br}->{'branchprinter'};
+ $branchname = $branches->{$br}->{'branchname'};
+ }
+ }
+ $session->param('number',$borrowernumber);
+ $session->param('id',$userid);
+ $session->param('cardnumber',$cardnumber);
+ $session->param('firstname',$firstname);
+ $session->param('surname',$surname);
+ $session->param('branch',$branchcode);
+ $session->param('branchname',$branchname);
+ $session->param('flags',$userflags);
+ $session->param('emailaddress',$emailaddress);
+ $session->param('ip',$session->remote_addr());
+ $session->param('lasttime',time());
+ $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
+ }
+ elsif ( $return == 2 ) {
+ #We suppose the user is the superlibrarian
+ $borrowernumber = 0;
+ $session->param('number',0);
+ $session->param('id',C4::Context->config('user'));
+ $session->param('cardnumber',C4::Context->config('user'));
+ $session->param('firstname',C4::Context->config('user'));
+ $session->param('surname',C4::Context->config('user'));
+ $session->param('branch','NO_LIBRARY_SET');
+ $session->param('branchname','NO_LIBRARY_SET');
+ $session->param('flags',1);
+ $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'),
+ $session->param('surname'), $session->param('branch'),
+ $session->param('branchname'), $session->param('flags'),
+ $session->param('emailaddress'), $session->param('branchprinter')
+ );
+
+ # Grab borrower's shelves and public shelves and add them to the session
+ # $row_count determines how many records are returned from the db query
+ # and the number of lists to be displayed of each type in the 'Lists' button drop down
+ my $row_count = 10; # FIXME:This probably should be a syspref
+ my ($total, $totshelves, $barshelves, $pubshelves);
+ ($barshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(1, $row_count, $borrowernumber);
+ $total->{'bartotal'} = $totshelves;
+ ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
+ $total->{'pubtotal'} = $totshelves;
+ $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);
}
else {
- $info{'nopermission'} = 1;
+ if ($userid) {
+ $info{'invalid_username_or_password'} = 1;
+ C4::Context->_unset_userenv($sessionID);
+ }
+ }
+ } # END if ( $userid = $query->param('userid') )
+ 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...";
+
+ # Grab the public shelves and add to the session...
+ my $row_count = 20; # FIXME:This probably should be a syspref
+ my ($total, $totshelves, $pubshelves);
+ ($pubshelves, $totshelves) = C4::VirtualShelves::GetRecentShelves(2, $row_count, undef);
+ $total->{'pubtotal'} = $totshelves;
+ $session->param('pubshelves', $pubshelves->[0]);
+ $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());
+ $session->param('sessiontype','anon');
+ }
+ } # END unless ($userid)
+ my $insecure = C4::Context->boolean_preference('insecure');
+
+ # finished authentification, now respond
+ if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
+ {
+ # successful login
+ unless ($cookie) {
+ $cookie = $query->cookie( CGISESSID => '' );
+ }
+ return ( $userid, $cookie, $sessionID, $flags );
+ }
+
+#
+#
+# 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' );
+ my $value = $query->param($name);
+ push @inputs, { name => $name, value => $value };
+ }
+ # get the branchloop, which we need for authentication
+ my $branches = GetBranches();
+ my @branch_loop;
+ for my $branch_hash (sort keys %$branches) {
+ push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
+ }
+
+ my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
+ my $template = gettemplate( $template_name, $type, $query );
+ $template->param(branchloop => \@branch_loop,);
+ $template->param(
+ login => 1,
+ INPUTS => \@inputs,
+ 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"),
+ opacreadinghistory => C4::Context->preference("opacreadinghistory"),
+ opacsmallimage => C4::Context->preference("opacsmallimage"),
+ opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
+ opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
+ opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
+ opacuserjs => C4::Context->preference("opacuserjs"),
+ opacbookbag => "" . C4::Context->preference("opacbookbag"),
+ OpacCloud => C4::Context->preference("OpacCloud"),
+ OpacTopissue => C4::Context->preference("OpacTopissue"),
+ OpacAuthorities => C4::Context->preference("OpacAuthorities"),
+ OpacBrowser => C4::Context->preference("OpacBrowser"),
+ opacheader => C4::Context->preference("opacheader"),
+ TagsEnabled => C4::Context->preference("TagsEnabled"),
+ OPACUserCSS => C4::Context->preference("OPACUserCSS"),
+ intranetcolorstylesheet =>
+ C4::Context->preference("intranetcolorstylesheet"),
+ intranetstylesheet => C4::Context->preference("intranetstylesheet"),
+ 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'}
+ );
+
+ $template->param( loginprompt => 1 ) unless $info{'nopermission'};
+
+ my $self_url = $query->url( -absolute => 1 );
+ $template->param(
+ url => $self_url,
+ LibraryName => C4::Context->preference("LibraryName"),
+ );
+ $template->param( \%info );
+# $cookie = $query->cookie(CGISESSID => $session->id
+# );
+ print $query->header(
+ -type => 'text/html',
+ -charset => 'utf-8',
+ -cookie => $cookie
+ ),
+ $template->output;
+ exit;
+}
+
+=item check_api_auth
+
+ ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
+
+Given a CGI query containing the parameters 'userid' and 'password' and/or a session
+cookie, determine if the user has the privileges specified by C<$userflags>.
+
+C<check_api_auth> is is meant for authenticating users of web services, and
+consequently will always return and will not attempt to redirect the user
+agent.
+
+If a valid session cookie is already present, check_api_auth will return a status
+of "ok", the cookie, and the Koha session ID.
+
+If no session cookie is present, check_api_auth will check the 'userid' and 'password
+parameters and create a session cookie and Koha session if the supplied credentials
+are OK.
+
+Possible return values in C<$status> are:
+
+=over 4
+
+=item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
+
+=item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
+
+=item "maintenance" -- DB is in maintenance mode; no login possible at the moment
+
+=item "expired -- session cookie has expired; API user should resubmit userid and password
+
+=back
+
+=cut
+
+sub check_api_auth {
+ my $query = shift;
+ my $flagsrequired = shift;
+
+ my $dbh = C4::Context->dbh;
+ my $timeout = C4::Context->preference('timeout');
+ $timeout = 600 unless $timeout;
+
+ unless (C4::Context->preference('Version')) {
+ # database has not been installed yet
+ return ("maintenance", undef, undef);
+ }
+ my $kohaversion=C4::Context::KOHAVERSION;
+ $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
+ if (C4::Context->preference('Version') < $kohaversion) {
+ # database in need of version update; assume that
+ # no API should be called while databsae is in
+ # this condition.
+ return ("maintenance", undef, undef);
+ }
+
+ # FIXME -- most of what follows is a copy-and-paste
+ # of code from checkauth. There is an obvious need
+ # for refactoring to separate the various parts of
+ # the authentication code, but as of 2007-11-19 this
+ # is deferred so as to not introduce bugs into the
+ # regular authentication code for Koha 3.0.
+
+ # see if we have a valid session cookie already
+ # however, if a userid parameter is present (i.e., from
+ # a form submission, assume that any current cookie
+ # is to be ignored
+ my $sessionID = undef;
+ unless ($query->param('userid')) {
+ $sessionID = $query->cookie("CGISESSID");
+ }
+ if ($sessionID) {
+ my $session = get_session($sessionID);
+ C4::Context->_new_userenv($sessionID);
+ if ($session) {
+ C4::Context::set_userenv(
+ $session->param('number'), $session->param('id'),
+ $session->param('cardnumber'), $session->param('firstname'),
+ $session->param('surname'), $session->param('branch'),
+ $session->param('branchname'), $session->param('flags'),
+ $session->param('emailaddress'), $session->param('branchprinter')
+ );
+
+ my $ip = $session->param('ip');
+ my $lasttime = $session->param('lasttime');
+ my $userid = $session->param('id');
+ if ( $lasttime < time() - $timeout ) {
+ # time out
+ $session->delete();
C4::Context->_unset_userenv($sessionID);
+ $userid = undef;
+ $sessionID = undef;
+ return ("expired", undef, undef);
+ } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
+ # IP address changed
+ $session->delete();
+ C4::Context->_unset_userenv($sessionID);
+ $userid = undef;
+ $sessionID = undef;
+ return ("expired", undef, undef);
+ } else {
+ my $cookie = $query->cookie( CGISESSID => $session->id );
+ $session->param('lasttime',time());
+ my $flags = haspermission( $dbh, $userid, $flagsrequired );
+ if ($flags) {
+ return ("ok", $cookie, $sessionID);
+ } else {
+ $session->delete();
+ C4::Context->_unset_userenv($sessionID);
+ $userid = undef;
+ $sessionID = undef;
+ return ("failed", undef, undef);
+ }
}
+ } else {
+ return ("expired", undef, undef);
+ }
+ } else {
+ # new login
+ 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 $session = get_session("");
+ return ("failed", undef, undef) unless $session;
+
+ my $sessionID = $session->id;
+ C4::Context->_new_userenv($sessionID);
+ my $cookie = $query->cookie(CGISESSID => $sessionID);
if ( $return == 1 ) {
my (
$borrowernumber, $firstname, $surname,
$borrowernumber, $firstname, $surname,
$userflags, $branchcode, $branchname,
$branchprinter, $emailaddress
- )
- = $sth->fetchrow
- if ( $sth->rows );
-
-# warn "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress";
- unless ( $sth->rows ) {
- my $sth =
- $dbh->prepare(
+ ) = $sth->fetchrow if ( $sth->rows );
+
+ unless ($sth->rows ) {
+ my $sth = $dbh->prepare(
"select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, branches.branchprinter as branchprinter, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
);
$sth->execute($cardnumber);
$borrowernumber, $firstname, $surname,
$userflags, $branchcode, $branchname,
$branchprinter, $emailaddress
- )
- = $sth->fetchrow
- if ( $sth->rows );
+ ) = $sth->fetchrow if ( $sth->rows );
-# warn "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress";
unless ( $sth->rows ) {
$sth->execute($userid);
(
$borrowernumber, $firstname, $surname, $userflags,
$branchcode, $branchname, $branchprinter, $emailaddress
- )
- = $sth->fetchrow
- if ( $sth->rows );
+ ) = $sth->fetchrow if ( $sth->rows );
}
}
-# launch a sequence to check if we have a ip for the branch, if we have one we replace the branchcode of the userenv by the branch bound in the ip.
my $ip = $ENV{'REMOTE_ADDR'};
# if they specify at login, use that
if ($query->param('branch')) {
$session->param('emailaddress',$emailaddress);
$session->param('ip',$session->remote_addr());
$session->param('lasttime',time());
-# warn "".$session->param('cardnumber').", ".$session->param('firstname').",
-# ".$session->param('surname').", ".$session->param('branch');
- }
- elsif ( $return == 2 ) {
+ } elsif ( $return == 2 ) {
#We suppose the user is the superlibrarian
- $session->param('number',0);
- $session->param('id',C4::Context->config('user'));
- $session->param('cardnumber',C4::Context->config('user'));
- $session->param('firstname',C4::Context->config('user'));
- $session->param('surname',C4::Context->config('user'));
- $session->param('branch','NO_LIBRARY_SET');
- $session->param('branchname','NO_LIBRARY_SET');
- $session->param('flags',1);
- $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
- $session->param('ip',$session->remote_addr());
- $session->param('lasttime',time());
- }
- if ($session){
- C4::Context::set_userenv(
- $session->param('number'), $session->param('id'),
- $session->param('cardnumber'), $session->param('firstname'),
- $session->param('surname'), $session->param('branch'),
- $session->param('branchname'), $session->param('flags'),
- $session->param('emailaddress'), $session->param('branchprinter')
- );
- }
+ $session->param('number',0);
+ $session->param('id',C4::Context->config('user'));
+ $session->param('cardnumber',C4::Context->config('user'));
+ $session->param('firstname',C4::Context->config('user'));
+ $session->param('surname',C4::Context->config('user'));
+ $session->param('branch','NO_LIBRARY_SET');
+ $session->param('branchname','NO_LIBRARY_SET');
+ $session->param('flags',1);
+ $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'),
+ $session->param('surname'), $session->param('branch'),
+ $session->param('branchname'), $session->param('flags'),
+ $session->param('emailaddress'), $session->param('branchprinter')
+ );
+ return ("ok", $cookie, $sessionID);
+ } else {
+ return ("failed", undef, undef);
}
+ }
+}
- else {
- if ($userid) {
- $info{'invalid_username_or_password'} = 1;
+=item check_cookie_auth
+
+ ($status, $sessionId) = check_api_auth($cookie, $userflags);
+
+Given a CGISESSID cookie set during a previous login to Koha, determine
+if the user has the privileges specified by C<$userflags>.
+
+C<check_cookie_auth> is meant for authenticating special services
+such as tools/upload-file.pl that are invoked by other pages that
+have been authenticated in the usual way.
+
+Possible return values in C<$status> are:
+
+=over 4
+
+=item "ok" -- user authenticated; C<$sessionID> have valid values.
+
+=item "failed" -- credentials are not correct; C<$sessionid> are undef
+
+=item "maintenance" -- DB is in maintenance mode; no login possible at the moment
+
+=item "expired -- session cookie has expired; API user should resubmit userid and password
+
+=back
+
+=cut
+
+sub check_cookie_auth {
+ my $cookie = shift;
+ my $flagsrequired = shift;
+
+ my $dbh = C4::Context->dbh;
+ my $timeout = C4::Context->preference('timeout');
+ $timeout = 600 unless $timeout;
+
+ unless (C4::Context->preference('Version')) {
+ # database has not been installed yet
+ return ("maintenance", undef);
+ }
+ my $kohaversion=C4::Context::KOHAVERSION;
+ $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
+ if (C4::Context->preference('Version') < $kohaversion) {
+ # database in need of version update; assume that
+ # no API should be called while databsae is in
+ # this condition.
+ return ("maintenance", undef);
+ }
+
+ # FIXME -- most of what follows is a copy-and-paste
+ # of code from checkauth. There is an obvious need
+ # for refactoring to separate the various parts of
+ # the authentication code, but as of 2007-11-23 this
+ # is deferred so as to not introduce bugs into the
+ # regular authentication code for Koha 3.0.
+
+ # see if we have a valid session cookie already
+ # however, if a userid parameter is present (i.e., from
+ # a form submission, assume that any current cookie
+ # is to be ignored
+ unless (defined $cookie and $cookie) {
+ return ("failed", undef);
+ }
+ my $sessionID = $cookie;
+ my $session = get_session($sessionID);
+ C4::Context->_new_userenv($sessionID);
+ if ($session) {
+ C4::Context::set_userenv(
+ $session->param('number'), $session->param('id'),
+ $session->param('cardnumber'), $session->param('firstname'),
+ $session->param('surname'), $session->param('branch'),
+ $session->param('branchname'), $session->param('flags'),
+ $session->param('emailaddress'), $session->param('branchprinter')
+ );
+
+ my $ip = $session->param('ip');
+ my $lasttime = $session->param('lasttime');
+ my $userid = $session->param('id');
+ if ( $lasttime < time() - $timeout ) {
+ # time out
+ $session->delete();
+ C4::Context->_unset_userenv($sessionID);
+ $userid = undef;
+ $sessionID = undef;
+ return ("expired", undef);
+ } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
+ # IP address changed
+ $session->delete();
+ C4::Context->_unset_userenv($sessionID);
+ $userid = undef;
+ $sessionID = undef;
+ return ("expired", undef);
+ } else {
+ $session->param('lasttime',time());
+ my $flags = haspermission( $dbh, $userid, $flagsrequired );
+ if ($flags) {
+ return ("ok", $sessionID);
+ } else {
+ $session->delete();
C4::Context->_unset_userenv($sessionID);
+ $userid = undef;
+ $sessionID = undef;
+ return ("failed", undef);
}
}
+ } else {
+ return ("expired", undef);
}
- my $insecure = C4::Context->boolean_preference('insecure');
+}
- # finished authentification, now respond
- if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
- {
- # successful login
- unless ($cookie) {
- $cookie = $query->cookie( CGISESSID => ''
- );
- }
- return ( $userid, $cookie, $sessionID, $flags );
+=item get_session
- }
+ use CGI::Session;
+ my $session = get_session($sessionID);
-#
-#
-# 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' );
- my $value = $query->param($name);
- push @inputs, { name => $name, value => $value };
- }
- # get the branchloop, which we need for authentication
- my $branches = GetBranches();
- my @branch_loop;
- for my $branch_hash (keys %$branches) {
- push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
- }
+Given a session ID, retrieve the CGI::Session object 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.
- # check that database and koha version are the same
- # there is no DB version, it's a fresh install,
- # go to web installer
- # there is a DB version, compare it to the code version
- my $kohaversion=C4::Context::KOHAVERSION;
- # remove the 3 last . to have a Perl number
- $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
-# warn "kohaversion : $kohaversion";
- if (C4::Context->preference('Version') < $kohaversion){
- if ($type ne 'opac'){
- warn "Database update needed, redirecting to Installer. Database is ".C4::Context->preference('Version')." and Koha is : ".C4::Context->config("kohaversion");
- print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
- } else {
- warn "OPAC :Database update needed, redirecting to maintenance. Database is ".C4::Context->preference('Version')." and Koha is : ".C4::Context->config("kohaversion");
- print $query->redirect("/cgi-bin/koha/maintenance.pl");
- }
- exit;
+If the C<$sessionID> parameter is an empty string, a new session
+will be created.
+
+=cut
+
+sub get_session {
+ my $sessionID = shift;
+ my $storage_method = C4::Context->preference('SessionStorage');
+ my $dbh = C4::Context->dbh;
+ my $session;
+ if ($storage_method eq 'mysql'){
+ $session = new CGI::Session("driver:MySQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
}
- my $template_name;
- if ( $type eq 'opac' ) {
- $template_name = "opac-auth.tmpl";
+ elsif ($storage_method eq 'Pg') {
+ $session = new CGI::Session("driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, {Handle=>$dbh});
}
else {
- $template_name = "auth.tmpl";
+ # catch all defaults to tmp should work on all systems
+ $session = new CGI::Session("driver:File;serializer:yaml;id:md5", $sessionID, {Directory=>'/tmp'});
}
- my $template = gettemplate( $template_name, $type, $query );
- $template->param(branchloop => \@branch_loop,);
- $template->param(
- login => 1,
- INPUTS => \@inputs,
- suggestion => C4::Context->preference("suggestion"),
- virtualshelves => C4::Context->preference("virtualshelves"),
- opaclargeimage => C4::Context->preference("opaclargeimage"),
- LibraryName => C4::Context->preference("LibraryName"),
- OpacNav => C4::Context->preference("OpacNav"),
- opaccredits => C4::Context->preference("opaccredits"),
- opacreadinghistory => C4::Context->preference("opacreadinghistory"),
- opacsmallimage => C4::Context->preference("opacsmallimage"),
- opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
- opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
- opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
- opacuserjs => C4::Context->preference("opacuserjs"),
-
- intranetcolorstylesheet =>
- C4::Context->preference("intranetcolorstylesheet"),
- intranetstylesheet => C4::Context->preference("intranetstylesheet"),
- IntranetNav => C4::Context->preference("IntranetNav"),
- intranetuserjs => C4::Context->preference("intranetuserjs"),
- TemplateEncoding => C4::Context->preference("TemplateEncoding"),
- IndependantBranches => C4::Context->preference("IndependantBranches"),
- );
- $template->param( loginprompt => 1 ) unless $info{'nopermission'};
-
- my $self_url = $query->url( -absolute => 1 );
- $template->param(
- url => $self_url,
- LibraryName => => C4::Context->preference("LibraryName"),
- );
- $template->param( \%info );
-# $cookie = $query->cookie(CGISESSID => $session->id
-# );
- print $query->header(
- -type => 'text/html',
- -charset => 'utf-8',
- -cookie => $cookie
- ),
- $template->output;
- exit;
+ return $session;
}
sub checkpw {
my ( $dbh, $userid, $password ) = @_;
+ if ($ldap) {
+ $debug and print STDERR "## checkpw - checking LDAP\n";
+ my ($retval,$retcard) = checkpw_ldap(@_); # EXTERNAL AUTH
+ ($retval) and return ($retval,$retcard);
+ }
# INTERNAL AUTH
my $sth =
return 0;
}
+=item getuserflags
+
+ $authflags = getuserflags($flags,$dbh);
+Translates integer flags into permissions strings hash.
+
+C<$flags> is the integer userflags value ( borrowers.userflags )
+C<$authflags> is a hashref of permissions
+
+=cut
+
sub getuserflags {
- my $cardnumber = shift;
- my $dbh = shift;
+ my $flags = shift;
+ my $userid = shift;
+ my $dbh = shift;
my $userflags;
- my $sth = $dbh->prepare("SELECT flags FROM borrowers WHERE cardnumber=?");
- $sth->execute($cardnumber);
- my ($flags) = $sth->fetchrow;
$flags = 0 unless $flags;
- $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
+ my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
$sth->execute;
while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
$userflags->{$flag} = 0;
}
}
+
+ # get subpermissions and merge with top-level permissions
+ my $user_subperms = get_user_subpermissions($userid);
+ foreach my $module (keys %$user_subperms) {
+ next if $userflags->{$module} == 1; # user already has permission for everything in this module
+ $userflags->{$module} = $user_subperms->{$module};
+ }
+
return $userflags;
}
+=item get_user_subpermissions
+
+=over 4
+
+my $user_perm_hashref = get_user_subpermissions($userid);
+
+=back
+
+Given the userid (note, not the borrowernumber) of a staff user,
+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
+from permissions.
+
+The results of this function do not give a complete picture
+of the functions that a staff user can access; it is also
+necessary to check borrowers.flags.
+
+=cut
+
+sub get_user_subpermissions {
+ my $userid = shift;
+
+ my $dbh = C4::Context->dbh;
+ my $sth = $dbh->prepare("SELECT flag, user_permissions.code
+ FROM user_permissions
+ JOIN permissions USING (module_bit, code)
+ JOIN userflags ON (module_bit = bit)
+ JOIN borrowers USING (borrowernumber)
+ WHERE userid = ?");
+ $sth->execute($userid);
+
+ my $user_perms = {};
+ while (my $perm = $sth->fetchrow_hashref) {
+ $user_perms->{$perm->{'flag'}}->{$perm->{'code'}} = 1;
+ }
+ return $user_perms;
+}
+
+=item get_all_subpermissions
+
+=over 4
+
+my $perm_hashref = get_all_subpermissions();
+
+=back
+
+Returns a hashref of hashrefs defining all specific
+permissions currently defined. The return value
+has the same structure as that of C<get_user_subpermissions>,
+except that the innermost hash value is the description
+of the subpermission.
+
+=cut
+
+sub get_all_subpermissions {
+ my $dbh = C4::Context->dbh;
+ my $sth = $dbh->prepare("SELECT flag, code, description
+ FROM permissions
+ JOIN userflags ON (module_bit = bit)");
+ $sth->execute();
+
+ my $all_perms = {};
+ while (my $perm = $sth->fetchrow_hashref) {
+ $all_perms->{$perm->{'flag'}}->{$perm->{'code'}} = $perm->{'description'};
+ }
+ return $all_perms;
+}
+
+=item haspermission
+
+ $flags = ($dbh,$member,$flagsrequired);
+
+C<$member> may be either userid or overloaded with $borrower hashref from GetMemberDetails.
+C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
+
+Returns member's flags or 0 if a permission is not met.
+
+=cut
+
sub haspermission {
my ( $dbh, $userid, $flagsrequired ) = @_;
- my $sth = $dbh->prepare("SELECT cardnumber FROM borrowers WHERE userid=?");
- $sth->execute($userid);
- my ($cardnumber) = $sth->fetchrow;
- ($cardnumber) || ( $cardnumber = $userid );
- my $flags = getuserflags( $cardnumber, $dbh );
- my $configfile;
+ 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 );
+ }
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') ) {
-
# Demo user that can do "anything" (demo=1 in /etc/koha.conf)
$flags->{'superlibrarian'} = 1;
}
return $flags if $flags->{superlibrarian};
- foreach ( keys %$flagsrequired ) {
- return $flags if $flags->{$_};
+ 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
+ )
+ );
+ }
+ } else {
+ return 0 unless ( $flags->{$module} );
+ }
}
- return 0;
+ return $flags;
+ #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
}
+
sub getborrowernumber {
my ($userid) = @_;
my $dbh = C4::Context->dbh;