File:
[LON-CAPA] /
loncom /
cgi /
loncgi.pm
Revision
1.12:
download - view:
text,
annotated -
select for diffs
Fri Oct 21 20:00:30 2011 UTC (12 years, 10 months ago) by
raeburn
Branches:
MAIN
CVS tags:
version_2_10_X,
version_2_10_1,
loncapaMITrelate_1,
language_hyphenation_merge,
language_hyphenation,
HEAD,
BZ4492-merge,
BZ4492-feature_horizontal_radioresponse,
BZ4492-feature_Support_horizontal_radioresponse,
BZ4492-Support_horizontal_radioresponse
- New routine: loncgi::cgi_header() generates HTTP response headers using CGI.pm
- New arg in lonauthcgi::can_view() - $domain (optional),
used if $page is needed for a specific domain.
- New return value: either 1, or a &-separated list of domains for which access is
allowed.
#
# LON-CAPA helpers for cgi-bin scripts
#
# $Id: loncgi.pm,v 1.12 2011/10/21 20:00:30 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY 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 LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
#############################################
#############################################
=pod
=head1 NAME
loncgi
=head1 SYNOPSIS
Provides subroutines for checking a LON-CAPA cookie, loading the user's
environment, and retrieving arguments passed in via a CGI's Query String.
=head1 Subroutines
=over 4
=cut
#############################################
#############################################
package LONCAPA::loncgi;
use strict;
use warnings FATAL=>'all';
no warnings 'uninitialized';
use lib '/home/httpd/lib/perl/';
use CGI qw(:standard);
use CGI::Cookie();
use MIME::Types();
use Fcntl qw(:flock);
use LONCAPA;
use LONCAPA::Configuration();
use GDBM_File;
use Apache::lonlocal;
my $lonidsdir;
BEGIN {
my $perlvar=LONCAPA::Configuration::read_conf('loncapa.conf');
delete $perlvar->{'lonReceipt'};
$lonidsdir = $perlvar->{'lonIDsDir'};
}
#############################################
#############################################
=pod
=item check_cookie_and_load_env()
Inputs: 1 ( optional). When called from a handler in mod_perl,
pass in the request object.
Returns: 1 if the user has a LON-CAPA cookie 0 if not.
Loads the users environment into the %env hash if the cookie is correct.
=cut
#############################################
#############################################
sub check_cookie_and_load_env {
my ($r) = @_;
my %cookies;
if (ref($r)) {
%cookies = CGI::Cookie->fetch($r);
} else {
%cookies = CGI::Cookie->fetch();
}
if (exists($cookies{'lonID'}) &&
-e "$lonidsdir/".$cookies{'lonID'}->value.".id") {
# cookie found
&transfer_profile_to_env($cookies{'lonID'}->value);
return 1;
} else {
# No cookie found
return 0;
}
}
#############################################
#############################################
=pod
=item check_cookie()
Inputs: none
Returns: 1 if the user has a LON-CAPA cookie and 0 if not.
=cut
#############################################
#############################################
sub check_cookie {
my %cookies=fetch CGI::Cookie;
if (exists($cookies{'lonID'}) &&
-e "$lonidsdir/".$cookies{'lonID'}->value.".id") {
# cookie found
return 1;
} else {
# No cookie found
return 0;
}
}
#############################################
#############################################
=pod
=item transfer_profile_to_env()
Load the users environment into the %env hash.
Inputs: $handle, the name of the users LON-CAPA cookie.
Returns: undef
=cut
#############################################
#############################################
sub transfer_profile_to_env {
my ($handle)=@_;
if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_READER(),
0640)) {
%Apache::lonnet::env = %disk_env;
untie(%disk_env);
}
$Apache::lonnet::env{'user.environment'} = "$lonidsdir/$handle.id";
return undef;
}
#############################################
#############################################
=pod
=item missing_cookie_msg()
Inputs: none
Returns: HTML for a page indicating cookie information absent.
=cut
#############################################
#############################################
sub missing_cookie_msg {
my %lt = &Apache::lonlocal::texthash (
cook => 'Bad Cookie',
your => 'Your cookie information is incorrect.',
);
return <<END;
<html>
<head><title>$lt{'cook'}</title></head>
<body>
$lt{'your'}
</body>
</html>
END
}
#############################################
#############################################
=pod
=cgi_getitems()
Inputs: $query (the CGI query string), and $getitems, a reference to a hash
Returns: nothing
Side Effects: populates $getitems hash ref with key => value
where each key is the name of the form item in the query string
and value is an array of corresponding values.
=cut
#############################################
#############################################
sub cgi_getitems {
my ($query,$getitems)= @_;
foreach (split(/&/,$query)) {
my ($name, $value) = split(/=/,$_);
$name = &unescape($name);
$value =~ tr/+/ /;
$value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
push(@{$$getitems{$name}},$value);
}
return;
}
#############################################
#############################################
=pod
=cgi_header()
Inputs: $contenttype - Content Type (e.g., text/html or text/plain)
$nocache - Boolean 1 = nocache
Returns: HTTP Response headers constructed using CGI.pm
=cut
#############################################
#############################################
sub cgi_header {
my ($contenttype,$nocache) = @_;
my $mimetypes = MIME::Types->new;
my %headers;
if ($contenttype ne '') {
if ($mimetypes->type($contenttype) ne '') {
$headers{'-type'} = $contenttype;
}
}
if ($nocache) {
$headers{'-expires'} = 'now';
}
if (%headers) {
return CGI::header(%headers);
}
return;
}
=pod
=back
=cut
1;
__END__
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>