=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<query>, C<flagsrequired> and C<authnotrequired>
- to C<&checkauth> (in this module) to perform authentification.
- See C<&checkauth> for an explanation of these parameters.
-
- The C<template_name> 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<USER_INFO>. Also the
- C<sessionID> 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<gettemplate> 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<query>, C<flagsrequired> and C<authnotrequired>
+ to C<&checkauth> (in this module) to perform authentification.
+ See C<&checkauth> for an explanation of these parameters.
+
+ The C<template_name> 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<USER_INFO>. Also the
+ C<sessionID> 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<gettemplate> sub can be found in the
+ Output.pm module.
=cut
} elsif($mylibraryfirst){
$opac_name = C4::Branch::GetBranchName($mylibraryfirst);
}
+ my $checkstyle = C4::Context->preference("opaccolorstylesheet");
+ if ($checkstyle =~ /http/)
+ {
+ $template->param( opacexternalsheet => $checkstyle);
+ } else
+ {
+ my $opaccolorstylesheet = C4::Context->preference("opaccolorstylesheet");
+ $template->param( opaccolorstylesheet => $opaccolorstylesheet);
+ }
$template->param(
AmazonContent => "" . C4::Context->preference("AmazonContent"),
AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
hidelostitems => C4::Context->preference("hidelostitems"),
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"),
opaccredits => "" . C4::Context->preference("opaccredits"),
return ( $template, $borrowernumber, $cookie, $flags);
}
- =item checkauth
+ =head2 checkauth
($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
value of each key in the C<flagsrequired> hash takes on an additional
meaning, e.g.,
- =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.
my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
my $template = gettemplate( $template_name, $type, $query );
$template->param(branchloop => \@branch_loop,);
+ my $checkstyle = C4::Context->preference("opaccolorstylesheet");
+ if ($checkstyle =~ /\//)
+ {
+ $template->param( opacexternalsheet => $checkstyle);
+ } else
+ {
+ my $opaccolorstylesheet = C4::Context->preference("opaccolorstylesheet");
+ $template->param( opaccolorstylesheet => $opaccolorstylesheet);
+ }
$template->param(
login => 1,
INPUTS => \@inputs,
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"),
exit;
}
- =item check_api_auth
+ =head2 check_api_auth
($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
Possible return values in C<$status> are:
- =over 4
+ =over
=item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
}
}
- =item check_cookie_auth
+ =head2 check_cookie_auth
($status, $sessionId) = check_api_auth($cookie, $userflags);
Possible return values in C<$status> are:
- =over 4
+ =over
=item "ok" -- user authenticated; C<$sessionID> have valid values.
}
}
- =item get_session
+ =head2 get_session
use CGI::Session;
my $session = get_session($sessionID);
return 0;
}
- =item getuserflags
+ =head2 getuserflags
my $authflags = getuserflags($flags, $userid, [$dbh]);
return $userflags;
}
- =item get_user_subpermissions
-
- =over 4
+ =head2 get_user_subpermissions
- 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
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
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
return $all_perms;
}
- =item haspermission
+ =head2 haspermission
$flags = ($userid, $flagsrequired);
1;
__END__
- =back
-
=head1 SEE ALSO
CGI(3)
projects / koha.git / commitdiff