--- loncom/auth/lonacc.pm	2008/12/10 16:42:51	1.116.2.1
+++ loncom/auth/lonacc.pm	2008/12/10 16:28:03	1.123
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # Cookie Based Access Handler
 #
-# $Id: lonacc.pm,v 1.116.2.1 2008/12/10 16:42:51 raeburn Exp $
+# $Id: lonacc.pm,v 1.123 2008/12/10 16:28:03 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -27,6 +27,73 @@
 #
 ###
 
+=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
+
+=head1 NOTABLE SUBROUTINES
+
+=over
+
+=cut
+
+
 package Apache::lonacc;
 
 use strict;
@@ -93,7 +160,7 @@ sub get_posted_cgi {
                     if (ref($fields) eq 'ARRAY') {
                         next if (!grep(/^\Q$name\E$/,@{$fields}));
                     }
-		    if ($fname) {
+                    if ($fname) {
                         if ($env{'form.symb'} ne '') {
                             my $size = (length($value))/(1024.0 * 1024.0);
                             if (&upload_size_allowed($name,$size,$fname) eq 'ok') {
@@ -102,14 +169,14 @@ sub get_posted_cgi {
                                 &Apache::loncommon::add_to_env("form.$name",$value);
                             }
                         } else {
-			    $env{"form.$name.filename"}=$fname;
-			    $env{"form.$name.mimetype"}=$fmime;
+                            $env{"form.$name.filename"}=$fname;
+                            $env{"form.$name.mimetype"}=$fmime;
                             &Apache::loncommon::add_to_env("form.$name",$value);
                         }
-		    } else {
-			$value=~s/\s+$//s;
+                    } else {
+                        $value=~s/\s+$//s;
                         &Apache::loncommon::add_to_env("form.$name",$value);
-		    }
+                    }
 		}
 		if ($i<$#lines) {
 		    $i++;
@@ -155,13 +222,17 @@ sub get_posted_cgi {
     $r->headers_in->unset('Content-length');
 }
 
-#
-# Perform size checks for file uploads to essayresponse items in course context.
-#
-# Add form.HWFILESIZE.$part_$id to %env with file size (MB)
-# If file exceeds maximum allowed size, add form.HWFILETOOBIG.$part_$id to %env.
-#
+=pod
+
+=item upload_size_allowed()
+
+	Perform size checks for file uploads to essayresponse items in course context.
+	
+	Add form.HWFILESIZE.$part_$id to %env with file size (MB)
+	If file exceeds maximum allowed size, add form.HWFILETOOBIG.$part_$id to %env.
 
+=cut
+ 
 sub upload_size_allowed {
     my ($name,$size,$fname) = @_;
     if ($name =~ /^HWFILE(\w+)$/) {
@@ -182,12 +253,18 @@ sub upload_size_allowed {
     return 'ok';
 }
 
+=pod
+
+=item sso_login()
+
+	handle the case of the single sign on user, at this point $r->user 
+	will be set and valid now need to find the loncapa user info and possibly
+	balance them
+	returns OK if it was a SSO and user was handled
+        undef if not SSO or no means to hanle the user
+        
+=cut
 
-# handle the case of the single sign on user, at this point $r->user 
-# will be set and valid now need to find the loncapa user info and possibly
-# balance them
-# returns OK if it was a SSO and user was handled
-#         undef if not SSO or no means to hanle the user
 sub sso_login {
     my ($r,$handle) = @_;
 
@@ -275,7 +352,6 @@ sub handler {
         return OK;
     }
 
-    
     my $handle = &Apache::lonnet::check_for_valid_session($r);
 
     my $result = &sso_login($r,$handle);
@@ -461,64 +537,9 @@ 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
+=pod
 
 =back
 
 =cut
+