--- doc/loncapafiles/Attic/loncapafiles.html 2001/02/13 19:20:33 1.54 +++ doc/loncapafiles/Attic/loncapafiles.html 2001/03/08 19:00:23 1.71 @@ -161,7 +161,8 @@ browser and can only be seen be examinin - + @@ -191,7 +192,16 @@ browser and can only be seen be examinin -define handlers, set parameters +This file has two major functions. +For the Apache web server, it defines a global +access configuration which defines what server options (Indexes", "Includes", +"FollowSymLinks", "ExecCGI", or "MultiViews") are associated +with specific directories ("/", "/home/httpd/html", "/home/httpd/cgi-bin", +and "/usr/doc"). For the LON-CAPA network server and perl module +handlers, it defines machine specific settings (lonHostID, lonRole, +lonAdmEMail, lonDefDomain, lonLoadLim, lonExpire, and lonReceipt) +and internal machine settings for specific directories, socket ports, +and browser detection logic. configure @@ -209,19 +219,41 @@ define handlers, set parameters -main server configuration file +This is the main server configuration file. The settings here are +more or less standard for the Apache web server. Most notably (and +importantly!), perl handling and mod_perl are enabled in this configuration +file. -name space configuration +

+This file configures the "name space" of the Apache web server. +srm.conf +defines when specific perl modules should be called to handle a given +request. This definition is a function of both the name of the perl module, +and a specific regular expression associated with the URL, such as +"^/res/.*\.page". +

+

+Here is an example entry: +

+<LocationMatch "^/res/.*\.page$>
+SetHandler perl-script
+PerlHandler Apache::lonpage
+</LocationMatch>
+
+

 -set paths to modules; invoked by access.conf +This file provides initializations for perl handlers. It adjusts what +the module path space is (so as to include /home/httpd/lib/perl/Apache) as +well as causing the Apache module to be used for every perl handler. +startup.pl is invoked by access.conf. @@ -329,7 +361,17 @@ proxy server -remote command interpreter +This is a remote command interpreter on a TCP LON-CAPA network layer. +It accepts and processes incoming requests from other LON-CAPA machines +on the network. lond's functionality is self-contained in the sense +that it does not reference (import, require, use) any other file +described in this document. There are only 15 subroutines in this +script, however the make_new_child subroutine is quite +complex since it parses and responds about 29 different types of +network requests (i.e. enc, ping, pong, ekey, load, auth, passwd, +makeuser, home, update, unsub, sub, log, put, rolesput, get, eget, +del, keys, dump, store, restore, querysend, queryreply, idput, idget, +tmpput, tmpget, and ls). @@ -414,6 +456,48 @@ Table which has hash data necessary for + + +Metadata display handler. + +works/unverified + + + + +Handler to resolve ambiguous file locations. + +works/unverified + + + + +Handler to set resource parameters inside of the RAT based on metadata. + +works/unverified + + + + +Handler for showing sequence objects of educational resources. + +works/unverified + + + + +Creates a new course and assigns course coordinator. + +works/unverified + + + + +Creates a new user and/or changes user privileges + +works/unverified + + Produces simple LectureOnline-like student assessment performance chart @@ -423,7 +507,8 @@ Produces simple LectureOnline-like stude -Produces simple LectureOnline-like student assessment performance chart +Makes a table out of the previous attempts. Inputs result_from_symbread, +user, domain, home_server, course_id works/unverified @@ -700,7 +785,10 @@ handles request to the CAPA homework pro -access to for a LON-CAPA user session +(This module, like loncacc.pm also authenticates with cookies.) +lonacc.pm coordinates access to a wide range of administrative-type +functions (e.g. roles, logout, annotations, and bookmarks) as well +as coordinating access to educational resources. @@ -712,7 +800,16 @@ access handler for file transfers -access to construction area +This module provides access to an educational resource construction area. +This module is invoked by the URL-related pattern syntax +LocationMatch "^/priv.*" or LocationMatch "^/\~.*". +Authentication of user identity +is coordinated through cookies. The abbreviation "cacc" corresponds +to "construction-space access"). If the cookie handle is invalid, then +this module returns a forbidden status and makes appropriate log entries. +If the cookie handle is valid, status is determined to be okay (and, +for the "priv"-type access, the resource is delivered by the +lonconstruct module). @@ -742,9 +839,15 @@ replication -roles picking +This perl handling module reads in the available roles available +for a LON-CAPA user (different courses, different privileges, etc) +and produces a form-element HTML page which allows the user to select +which role he wishes to exercise in the LON-CAPA system. For instance, +a user may want to select between being a student in a thermodynamics +physics course or a teaching assistant for an introductory calculus +class. - + @@ -754,7 +857,16 @@ cross server filesystem browser -interface to lonc +This file is an interface to the lonc processes of the LON-CAPA network +as well as set of elaborated functions for handling information necessary +for navigating through a given cluster of LON-CAPA machines within a domain. +There are over 40 specialized functions in this module which handle +the reading and transmission of metadata, user information +(ids, names, environments, roles, logs), file information (storage, reading, +directories, extensions, replication, embedded styles and descriptors), +educational resources (course descriptions, section names and numbers), +url hashing (to assign roles on a url basis), and translating abbreviated +symbols to and from more descriptive phrases or explanations.