[LON-CAPA-cvs] cvs: loncom /auth lonacc.pm lonlogout.pm

jms lon-capa-cvs-allow@mail.lon-capa.org
Tue, 25 Nov 2008 14:19:07 -0000


jms		Tue Nov 25 14:19:07 2008 EDT

  Modified files:              
    /loncom/auth	lonlogout.pm lonacc.pm 
  Log:
  POD documentation changes
  
Index: loncom/auth/lonlogout.pm
diff -u loncom/auth/lonlogout.pm:1.35 loncom/auth/lonlogout.pm:1.36
--- loncom/auth/lonlogout.pm:1.35	Thu Nov 20 15:19:22 2008
+++ loncom/auth/lonlogout.pm	Tue Nov 25 14:19:07 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # Logout Handler
 #
-# $Id: lonlogout.pm,v 1.35 2008/11/20 15:19:22 jms Exp $
+# $Id: lonlogout.pm,v 1.36 2008/11/25 14:19:07 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,6 +26,19 @@
 # http://www.lon-capa.org/
 #
 
+=head1 NAME
+
+Apache::lonlogout
+
+=head1 SYNOPSIS
+
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+
+=cut
+
 package Apache::lonlogout;
 
 use strict;
@@ -154,21 +167,6 @@
 __END__
 
 
-=head1 NAME
-
-Apache::lonlogout
-
-=head1 SYNOPSIS
-
-
-This is part of the LearningOnline Network with CAPA project
-described at http://www.lon-capa.org.
-
-=head1 HANDLER SUBROUTINE
-
-
-=cut
-
 
 
 
Index: loncom/auth/lonacc.pm
diff -u loncom/auth/lonacc.pm:1.120 loncom/auth/lonacc.pm:1.121
--- loncom/auth/lonacc.pm:1.120	Thu Nov 20 14:37:52 2008
+++ loncom/auth/lonacc.pm	Tue Nov 25 14:19:07 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # Cookie Based Access Handler
 #
-# $Id: lonacc.pm,v 1.120 2008/11/20 14:37:52 jms Exp $
+# $Id: lonacc.pm,v 1.121 2008/11/25 14:19:07 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -27,6 +27,72 @@
 #
 ###
 
+=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;
 
@@ -156,12 +222,16 @@
     $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) = @_;
@@ -182,11 +252,17 @@
     return 'ok';
 }
 
-# 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
+=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
 
 sub sso_login {
     my ($r,$handle) = @_;
@@ -461,65 +537,9 @@
 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
\ No newline at end of file
+=cut
+