Changeset 2644 for package_branches

Timestamp:

Dec 19, 2009, 10:00:06 PM (15 years ago)

Author:

price

Message:

view.py: clean up remote_user_login

Remove dead code, and make the docstring clear about what the function is
actually doing.

File:

• package_branches/invirt-web/cherrypy/code/view.py (modified) (1 diff)

package_branches/invirt-web/cherrypy/code/view.py

@@ -116 +116 @@
 
 def remote_user_login():
-    """Get the current user based on the SSL or GSSAPI environment
-variables and store it in the request object's login variable. This
-conforms to the CherryPy API:
-http://www.cherrypy.org/wiki/RequestObject#login
+    """Get remote user from SSL or GSSAPI, and store in request object.
 
-If the user is logged in successfully, cherrypy.request.login is set
-to the username. If the user failed to log in, cherrypy.request.login
-is set to False. If the user did not attempt authentication,
-cherrypy.request.login is set to None."""
+Get the current user based on environment variables set by SSL or
+GSSAPI, and store it in the attribute cherrpy.request.login.
+
+Per the CherryPy API (http://www.cherrypy.org/wiki/RequestObject#login),
+the attribute is set to the username on successful login, to False on
+failed login, and is left at None if the user attempted no authentication.
+"""
     environ = cherrypy.request.wsgi_environ
     user = environ.get('REMOTE_USER')
     if user is None:
         return
-    else:
-        cherrypy.request.login = None # clear what cherrypy put there
-
     if environ.get('AUTH_TYPE') == 'Negotiate':
         # Convert the krb5 principal into a krb4 username
         if not user.endswith('@%s' % config.kerberos.realm):
-            cherrypy.request.login = False # failed to login
+            cherrypy.request.login = False # failed to log in
         else:
             cherrypy.request.login = user.split('@')[0].replace('/', '.')