--- loncom/auth/lonacc.pm	2001/12/06 21:03:02	1.24
+++ loncom/auth/lonacc.pm	2001/12/15 20:40:23	1.25
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # Cookie Based Access Handler
 #
-# $Id: lonacc.pm,v 1.24 2001/12/06 21:03:02 www Exp $
+# $Id: lonacc.pm,v 1.25 2001/12/15 20:40:23 harris41 Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -25,10 +25,16 @@
 #
 # http://www.lon-capa.org/
 #
+# YEAR=1999
 # 5/21/99,5/22,5/29,5/31,6/15,16/11,22/11,
+# YEAR=2000
 # 01/06,01/13,05/31,06/01,09/06,09/25,09/28,10/30,11/6,
 # 12/25,12/26,
+# YEAR=2001
 # 01/06/01,05/28,8/11,9/26,11/29 Gerd Kortemeyer
+# 12/15 Scott Harrison
+#
+###
 
 package Apache::lonacc;
 
@@ -36,6 +42,7 @@ use strict;
 use Apache::Constants qw(:common :http :methods);
 use Apache::File;
 use Apache::lonnet;
+use Apache::loncommon();
 use CGI::Cookie();
 use Fcntl qw(:flock);
 
@@ -160,7 +167,7 @@ sub handler {
           if ($ENV{'request.course.id'}) {
 	    &Apache::lonnet::countacc($requrl);
             $requrl=~/\.(\w+)$/;
-            if (&Apache::lonnet::fileembstyle($1) eq 'ssi') {
+            if (&Apache::loncommon::fileembstyle($1) eq 'ssi') {
 # ------------------------------------- This is serious stuff, get symb and log
 		my $symb=&Apache::lonnet::symbread;
                 $ENV{'request.symb'}=$symb;
@@ -194,3 +201,65 @@ sub handler {
 
 1;
 __END__
+
+=head1 NAME
+
+Apache::lonacc - Cookie Based Access Handler
+
+=head1 SYNOPSIS
+
+Invoked (for various locations) by /etc/httpd/conf/srm.conf:
+
+ PerlAccessHandler       Apache::lonacc
+
+=head1 INTRODUCTION
+
+This module enables cookie based authentication and is used
+to control access for many different LON-CAPA URIs.
+
+Whenever the client sends the cookie back to the server, 
+this cookie is handled by either lonacc.pm or loncacc.pm
+(see srm.conf for what is invoked when).  If
+the cookie is missing or invalid, the user is re-challenged
+for login information.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 HANDLER SUBROUTINE
+
+This routine is called by Apache and mod_perl.
+
+=over 4
+
+=item *
+
+transfer profile into environment
+
+=item *
+
+load POST parameters
+
+=item *
+
+check access
+
+=item *
+
+if allowed, get symb, log, generate course statistics if applicable
+
+=item *
+
+otherwise return error
+
+=item *
+
+see if public resource
+
+=item *
+
+store attempted access
+
+=back
+
+=cut