Annotation of loncom/html/adm/help/tex/Guts_Apache_Env.tex, revision 1.1
1.1 ! bowersj2 1: The environment is accessible through the global hash named \%ENV.
! 2: In addition to the standard variables placed in the environment by
! 3: the Apache server, LON-CAPA places a lot of information in the \%ENV.
! 4: You can see this information by going to \texttt{/adm/test}; the top
! 5: part of that screen will show your current \%ENV. (You may need to
! 6: modify \texttt{/home/httpd/lonTabs/htpasswd} before you can view that
! 7: handler and change the password for \texttt{lonadm}.)
! 8:
! 9: Many of the environment variables are primarily useful to the authentication
! 10: and permission routines (such as \texttt{Apache::lonnet::allowed}),
! 11: and are very rarely directly manipulated.
! 12:
! 13: Generally, the \%ENV is informally organized into {}``namespaces'',
! 14: such as {}``browser'' (containing browser information), {}``course''
! 15: (containing course-specific information), etc. For the following table,
! 16: the full name of the variable is the name shown on the left, prepended
! 17: by the section it is in. For instance, the first \%ENV member shown
! 18: below is \$ENV\{'browser.mathml'\}. Only generally useful portions
! 19: of the \%ENV are covered here.
! 20:
! 21: \begin{longtable}{|c|c|}
! 22: \hline
! 23: \textbf{\%ENV name}&
! 24: \textbf{Description}\tabularnewline
! 25: \hline
! 26: \endfirsthead
! 27: \textbf{browser:}&
! 28: \tabularnewline
! 29: \hline
! 30: .mathml&
! 31: if true, browser support MathML\tabularnewline
! 32: \hline
! 33: .os&
! 34: indicates OS of browser\tabularnewline
! 35: \hline
! 36: .type&
! 37: indicates type of browser ({}``ie'', {}``mozilla'', etc)\tabularnewline
! 38: \hline
! 39: .version&
! 40: version of the browser\tabularnewline
! 41: \hline
! 42: \textbf{environment:}&
! 43: \tabularnewline
! 44: \hline
! 45: .firstname&
! 46: user's firstname\tabularnewline
! 47: \hline
! 48: .generation&
! 49: user's generation ({}``1st'', {}``jr.'', etc)\tabularnewline
! 50: \hline
! 51: .id&
! 52: institution-specific ID number\tabularnewline
! 53: \hline
! 54: .lastname&
! 55: user's lastname\tabularnewline
! 56: \hline
! 57: .middlename&
! 58: user's middle name\tabularnewline
! 59: \hline
! 60: .remote&
! 61: 'on' if the user has the remote open\tabularnewline
! 62: \hline
! 63: \textbf{request:}&
! 64: \tabularnewline
! 65: \hline
! 66: .course.fn&
! 67: {}``full name'' of the course directory\tabularnewline
! 68: \hline
! 69: .course.id&
! 70: ID of the course currently logged into\tabularnewline
! 71: \hline
! 72: .course.sec&
! 73: current section of the course the user is in\tabularnewline
! 74: \hline
! 75: .course.uri&
! 76: URI of the top-level map\tabularnewline
! 77: \hline
! 78: .filename&
! 79: requested filename for current request\tabularnewline
! 80: \hline
! 81: .host&
! 82: originating IP of request\tabularnewline
! 83: \hline
! 84: .role&
! 85: full role designation for the course\tabularnewline
! 86: \hline
! 87: .role.adv&
! 88: whether the user is {}``advanced''; generally don't use\tabularnewline
! 89: \hline
! 90: .role.domain&
! 91: domain of the current course\tabularnewline
! 92: \hline
! 93: \textbf{user:}&
! 94: \tabularnewline
! 95: \hline
! 96: .adv&
! 97: whether the user is {}``advanced''; generally don't use\tabularnewline
! 98: \hline
! 99: .author&
! 100: whether the user is an author\tabularnewline
! 101: \hline
! 102: .domain&
! 103: domain the user is from\tabularnewline
! 104: \hline
! 105: .home&
! 106: user's home server\tabularnewline
! 107: \hline
! 108: .name&
! 109: user's login name\tabularnewline
! 110: \hline
! 111: \end{longtable}
! 112:
! 113: Other variables are frequently available, and you can add new ones
! 114: easily; see \texttt{Apache::lonnet::appenv()} and friends.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>