@@ -14209,13 +13369,13 @@ The first argument is required, all othe
$priv is the privilege being checked.
$uri contains additional information about what is being checked for access (e.g.,
-URL, course ID etc.).
+URL, course ID etc.).
$symb is the unique resource instance identifier in a course; if needed,
-but not provided, it will be retrieved via a call to &symbread().
-$role is the role for which a priv is being checked (only used if priv is evb).
-$clientip is the user's IP address (only used when checking for access to portfolio
+but not provided, it will be retrieved via a call to &symbread().
+$role is the role for which a priv is being checked (only used if priv is evb).
+$clientip is the user's IP address (only used when checking for access to portfolio
files).
-$noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
+$noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
prevents recursive calls to &allowed.
F: full access
@@ -14243,10 +13403,9 @@ in which case the null string is returne
=item *
-definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
-define a custom role rolename set privileges in format of lonTabs/roles.tab
-for system, domain, and course level. $uname and $udom are optional (current
-user's username and domain will be used when either of $uname or $udom are absent.
+definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
+role rolename set privileges in format of lonTabs/roles.tab for system, domain,
+and course level
=item *
@@ -14277,9 +13436,9 @@ provided for types, will default to retu
=item *
in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
-user: $uname:$udom has a role in the course: $cdom_$cnum.
+user: $uname:$udom has a role in the course: $cdom_$cnum.
-Additional optional arguments are: $type (if role checking is to be restricted
+Additional optional arguments are: $type (if role checking is to be restricted
to certain user status types -- previous (expired roles), active (currently
available roles) or future (roles available in the future), and
$hideprivileged -- if true will not report course roles for users who
@@ -14450,8 +13609,6 @@ Inputs:
=item $credits, number of credits student will earn from this class
-=item $instsec, institutional course section code for student
-
=back
@@ -14518,7 +13675,7 @@ values that are the resource value. I b
versions are also returned.
get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
-supplemental content area. This routine caches the number of files for
+supplemental content area. This routine caches the number of files for
10 minutes.
=back
@@ -14555,88 +13712,6 @@ Returns:
=back
-=head2 Bubblesheet Configuration
-
-=over 4
-
-=item *
-
-get_scantron_config($which)
-
-$which - the name of the configuration to parse from the file.
-
-Parses and returns the bubblesheet configuration line selected as a
-hash of configuration file fields.
-
-
-Returns:
- If the named configuration is not in the file, an empty
- hash is returned.
-
- a hash with the fields
- name - internal name for the this configuration setup
- description - text to display to operator that describes this config
- CODElocation - if 0 or the string 'none'
- - no CODE exists for this config
- if -1 || the string 'letter'
- - a CODE exists for this config and is
- a string of letters
- Unsupported value (but planned for future support)
- if a positive integer
- - The CODE exists as the first n items from
- the question section of the form
- if the string 'number'
- - The CODE exists for this config and is
- a string of numbers
- CODEstart - (only matter if a CODE exists) column in the line where
- the CODE starts
- CODElength - length of the CODE
- IDstart - column where the student/employee ID starts
- IDlength - length of the student/employee ID info
- Qstart - column where the information from the bubbled
- 'questions' start
- Qlength - number of columns comprising a single bubble line from
- the sheet. (usually either 1 or 10)
- Qon - either a single character representing the character used
- to signal a bubble was chosen in the positional setup, or
- the string 'letter' if the letter of the chosen bubble is
- in the final, or 'number' if a number representing the
- chosen bubble is in the file (1->A 0->J)
- Qoff - the character used to represent that a bubble was
- left blank
- PaperID - if the scanning process generates a unique number for each
- sheet scanned the column that this ID number starts in
- PaperIDlength - number of columns that comprise the unique ID number
- for the sheet of paper
- FirstName - column that the first name starts in
- FirstNameLength - number of columns that the first name spans
- LastName - column that the last name starts in
- LastNameLength - number of columns that the last name spans
- BubblesPerRow - number of bubbles available in each row used to
- bubble an answer. (If not specified, 10 assumed).
-
-
-=item *
-
-get_scantronformat_file($cdom)
-
-$cdom - the course's domain (optional); if not supplied, uses
-domain for current $env{'request.course.id'}.
-
-Returns an array containing lines from the scantron format file for
-the domain of the course.
-
-If a url for a custom.tab file is listed in domain's configuration.db,
-lines are from this file.
-
-Otherwise, if a default.tab has been published in RES space by the
-domainconfig user, lines are from this file.
-
-Otherwise, fall back to getting lines from the legacy file on the
-local server: /home/httpd/lonTabs/default_scantronformat.tab
-
-=back
-
=head2 Resource Subroutines
=over 4
@@ -14703,20 +13778,20 @@ will be stored for query
=item *
-symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
-return symbolic list entry (all arguments optional).
+symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
+return symbolic list entry (all arguments optional).
-Args: filename is the filename (including path) for the file for which a symb
-is required; donotrecurse, if true will prevent calls to allowed() being made
-to check access status if more than one resource was found in the bighash
-(see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
-a randompick); ignorecachednull, if true will prevent a symb of '' being
+Args: filename is the filename (including path) for the file for which a symb
+is required; donotrecurse, if true will prevent calls to allowed() being made
+to check access status if more than one resource was found in the bighash
+(see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
+a randompick); ignorecachednull, if true will prevent a symb of '' being
returned if $env{$cache_str} is defined as ''; checkforblock if true will
cause possible symbs to be checked to determine if they are subject to content
blocking, if so they will not be included as possible symbs; possibles is a
-ref to a hash, which, as a side effect, will be populated with all possible
+ref to a hash, which, as a side effect, will be populated with all possible
symbs (content blocking not tested).
-
+
returns the data handle
=item *
@@ -14726,9 +13801,9 @@ and is a possible symb for the URL in $t
resource that the user accessed using /enc/ returns a 1 on success, 0
on failure, user must be in a course, as it assumes the existence of
the course initial hash, and uses $env('request.course.id'}. The third
-arg is an optional reference to a scalar. If this arg is passed in the
+arg is an optional reference to a scalar. If this arg is passed in the
call to symbverify, it will be set to 1 if the symb has been set to be
-encrypted; otherwise it will be null.
+encrypted; otherwise it will be null.
=item *
@@ -14781,13 +13856,13 @@ expirespread($uname,$udom,$stype,$usymb)
devalidate($symb) : devalidate temporary spreadsheet calculations,
forcing spreadsheet to reevaluate the resource scores next time.
-=item *
+=item *
can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
when viewing in course context.
input: six args -- filename (decluttered), course number, course domain,
- url, symb (if registered) and group (if this is a
+ url, symb (if registered) and group (if this is a
group item -- e.g., bulletin board, group page etc.).
output: array of five scalars --
@@ -14795,15 +13870,15 @@ when viewing in course context.
$home -- homeserver of resource (i.e., for author if published,
or course if uploaded.).
$switchserver -- 1 if server switch will be needed.
- $forceedit -- 1 if icon/link should be to go to edit mode
+ $forceedit -- 1 if icon/link should be to go to edit mode
$forceview -- 1 if icon/link should be to go to view mode
=item *
is_course_upload($file,$cnum,$cdom)
-Used in course context to determine if current file was uploaded to
-the course (i.e., would be found in /userfiles/docs on the course's
+Used in course context to determine if current file was uploaded to
+the course (i.e., would be found in /userfiles/docs on the course's
homeserver.
input: 3 args -- filename (decluttered), course number and course domain.
@@ -14817,20 +13892,20 @@ homeserver.
=item *
-store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
+store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
permanently for this url; hashref needs to be given and should be a \%hashname;
the remaining args aren't required and if they aren't passed or are '' they will
-be derived from the env (with the exception of $laststore, which is an
+be derived from the env (with the exception of $laststore, which is an
optional arg used when a user's submission is stored in grading).
$laststore is $version=$timestamp, where $version is the most recent version
number retrieved for the corresponding $symb in the $namespace db file, and
$timestamp is the timestamp for that transaction (UNIX time).
-$laststore is currently only passed when cstore() is called by
+$laststore is currently only passed when cstore() is called by
structuretags::finalize_storage().
=item *
-cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
+cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
but uses critical subroutine
=item *
@@ -14968,7 +14043,7 @@ server ($udom and $uhome are optional)
=item *
-get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
+get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
for: authentication, language, quotas, timezone, date locale, and portal URL in
the target domain.
@@ -15023,7 +14098,7 @@ for course's uploaded content.
=over
=item
-canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
+canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
communityquota, textbookquota
=back
@@ -15034,7 +14109,7 @@ on your servers.
=over
-=item
+=item
remotesessions, hostedsessions
=back
@@ -15042,10 +14117,10 @@ remotesessions, hostedsessions
=back
In cases where a domain coordinator has never used the "Set Domain Configuration"
-utility to create a configuration.db file on a domain's primary library server
+utility to create a configuration.db file on a domain's primary library server
only the following domain defaults: auth_def, auth_arg_def, lang_def
-- corresponding values are authentication type (internal, krb4, krb5,
-or localauth), initial password or a kerberos realm, language (e.g., en-us) --
+or localauth), initial password or a kerberos realm, language (e.g., en-us) --
will be available. Values are retrieved from cache (if current), unless the
optional $ignore_cache arg is true, or from domain's configuration.db (if available),
or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
@@ -15328,7 +14403,6 @@ userspace, probably shouldn't be called
formname: same as for userfileupload()
fname: filename (including subdirectories) for the file
parser: if 'parse', will parse (html) file to extract references to objects, links etc.
- if hashref, and context is scantron, will convert csv format to standard format
allfiles: reference to hash used to store objects found by parser
codebase: reference to hash used for codebases of java objects found by parser
thumbwidth: width (pixels) of thumbnail to be created for uploaded image
@@ -15474,8 +14548,8 @@ Returns:
get_timebased_id():
-Attempts to get a unique timestamp-based suffix for use with items added to a
-course via the Course Editor (e.g., folders, composite pages,
+Attempts to get a unique timestamp-based suffix for use with items added to a
+course via the Course Editor (e.g., folders, composite pages,
group bulletin boards).
Args: (first three required; six others optional)
@@ -15486,24 +14560,24 @@ Args: (first three required; six others
2. keyid (alphanumeric): name of temporary locking key in hash,
e.g., num, boardids
-3. namespace: name of gdbm file used to store suffixes already assigned;
+3. namespace: name of gdbm file used to store suffixes already assigned;
file will be named nohist_namespace.db
4. cdom: domain of course; default is current course domain from %env
5. cnum: course number; default is current course number from %env
-6. idtype: set to concat if an additional digit is to be appended to the
+6. idtype: set to concat if an additional digit is to be appended to the
unix timestamp to form the suffix, if the plain timestamp is already
- in use. Default is to not do this, but simply increment the unix
+ in use. Default is to not do this, but simply increment the unix
timestamp by 1 until a unique key is obtained.
7. who: holder of locking key; defaults to user:domain for user.
-8. locktries: number of attempts to obtain a lock (sleep of 1s before
+8. locktries: number of attempts to obtain a lock (sleep of 1s before
retrying); default is 3.
-9. maxtries: number of attempts to obtain a unique suffix; default is 20.
+9. maxtries: number of attempts to obtain a unique suffix; default is 20.
Returns:
500 Internal Server Error
Internal Server Error
The server encountered an internal error or
misconfiguration and was unable to complete
your request.
Please contact the server administrator at
root@localhost to inform them of the time this error occurred,
and the actions you performed just before this error.
More information about this error may be available
in the server error log.