CVS log for rat/lonuserstate.pm

Up to [LON-CAPA] / rat

Request diff between arbitrary revisions

Keyword substitution: kv
Default branch: MAIN

- For 2.11
  Backport 1.150 (part), 1.169 (part), 1.170

- For 2.11.4 (modified)
  Include changes in 1.169 (modified), 1.170

- For 'Map not loaded' error on course initialization for a map in /res which
  user can edit switch server loads map (or parent map) in Authoring Space.

- Provide more information to privileged users if map could not be loaded
  during course initialization because file was missing.

- For 2.11.4 (modified)
  Include changes in rev. 1.168

  - Bug 6907
    Remove request.deeplink.target, if set, when deeplink no longer in effect.

- For 2.11.4 (modified)
  Include changes in 1.150, 1.151, 1.157, 1.164 (part), 1.165, 1.166, 1.167

- For 2.11
  Backport 1.161, 1.162, 1.163

- Bug 6907 Content in a course can be set to be deep-link only.
  - escape the components in each deeplinkonly_$rid item in the big hash.

- Bug 6907
  - Deep-linking when user has an existing LON-CAPA session, need to support
    case where role change is not needed, but course session update needed to
    enforce link protection (lti-based or key-based access control).

- Bug 6907 Content in a course can be set to be deep-link only.
  - deeplink parameter has 5 components:
    state, others, listing, scope, protect and menus.
  - if value of others component is hide, then resources besides deeplinked
    item(s) are not accessible to students.

- Bug 6907 Content in a course can be set to be deep-link only.
  If initial access is via a deep-link (/tiny/$domain/$uniqueid), and
  target folder/resource is deep-link only, access to resources, menus,
  and items listed in Course Contents controlled by deeplink parameter value.

- Typo in documentation.

- Change indents to standard 4 spaces.

- Only check for critical messages initializing course session, when
  readmap() is called from roles screen, and critical alerts are *not*
  blocked for selected course.

- For 2.11.3 (modified)
  Include changes in 1.158, 1.159, 1.160

- For 2.11
  Backport 1.159, 1.160

- Check for hiddenurl before checking for advanced user.

- Speed-up course loading and Course Contents display for users without adv
  priv if course contains several hidden folders and/or sub-folders.

- For 2.11.2 (modified).
  Include changes in 1.150, 1.151, 1.152, 1.155, 1.156

- For 2.11
  Backport 1.158

- URL for external resources in uploaded .page ("Composite page") changed
  to begin /ext/ (but are not wrapped).
- Printouts of external resources include title of item in course, and link
  unless encrypturl is set to yes for the resource.

- For 2.11.3 (modified)
  Include change in 1.150 omitted from changes included in 1.149.2.2.2.1

- For 2.11.3 (modified)
  Include changes in 1.150, 1.151

- For 2.11
  Backport 1.152, 1.153, 1.154, 1.156.

- Bug 6400
  - deeplink parameter determines whether deep-linked items are listed in
    and/or linked to in Course Contents and student's view of Grades

- Package globals should be initialized.

- For 2.11
  Backport 1.155.

- Package globals should be initialized.

- Use three-argument open() to separate file mode from the filename.

- New items added to big hash, where keys are map_breadcrumbs_$pc.
- Values differ from those for corresponding map_hierarchy_$pc items
  through omission of intermediate folders not shown in Course Contents.
- Used to genarate breadcrumb trail when displaying resource in course
  context contains with clickable links for folder hierarchy.

- Remove some blank lines.
- Fix typos in documentation.

- Bug 6754. Make LON-CAPA an LTI Tool Consumer (LTI 1.1).
  - Name as ext.tool (instead of exttool), so that parameters can be specified
    in packages.tab, based on extension.

- Bug 6754. Make LON-CAPA an LTI Tool Consumer (LTI 1.1). Work in progress.

- Coding style: keys()

- For folders with randomorder parameter set the order of resources needs to
  be randomized when CC switches to student role in course.
  - Don't use $env{'request.role.adv'} here because it will be set to
    $env{'user.adv'} -- as it does not get set in lonroles.pm based on the
    current role until later, i.e., after the call to
    Apache::lonuserstate::readmap().

- Exclude HTML tags from translation phrases.
 (Corresponding German translation file phrases and translations previously
  updated in rev 1.514).

- Bubblesheet grading of CODEd exams in which exam folder has either randomorder
  or randompick set causes new parameter (examcode) to be set at map level for
  a sepecific user each graded student.
- Parameter value is set to CODE on the student's bubblsheet exam.
- If used, requires course roles to be selected in a user session on a 2.11 server.
- Ensures resources are displayed in same order to student, and more importantly,
  ensures points totals will be correct in student's quickgrades view, if randompick
  was used.

- Correction to change in &unlink_tmpfiles() in rev 1.138.

- Bug 6619.
- Initialize global $errtext when lonuserstate::readmap() is called, to
  exclude errors accumulated in prior calls of lonuserstate::loadmap().

- Timestamp in user's env for when coursemap was last tied:
  $env{'request.course.tied'}.

- Fix typo in 1.139.

- Backport 1.141.

- More complete simplification: 8|8 -> 8
  - 8|8|8 -> 8 etc.
  - Scope remains for additional improvement, e.g.,  8|7|8 ->  8|7.

More comments.

More reverse engineering and commenting of the map load process.

1. Centralize tempdir location in unlink_tmpfiles.
2. Get rid of >dirty< next in parse_resource ... returning
  undef instead for zombie resources and checking in the
  loop that calls it.

- Bug 6135.
  - In regexp: correct path for tmp directory containg .db files which need to be
    unlinked.

- Method in lonnavmaps.pm to retrieve ordered list of IDs
  used in nested folders. Comma-separated lists are values in
  big hash for corresponding keys of the form: map_hierarchy_$pc.

- Bug 6239. Register "Course roster" (/adm/viewclasslist) if added to
  a course via Course Editor.

Bug #3504: Warn adv-users if there are version discrepancies,
make it clear which version is used.

- Backport 1.132, 1.133.

- Early out if $fn.db.lock (filehandle: LOCKFILE) cannot be opened.
- close file pointed to by LOCKFILE filehandle when all readmap actions complete.

Users occasionally prevented from initializing couse by missing .state file and corrupted $user_$course.db in /home/httpd/perl/tmp.

- Move code used to populate tied hashes for $user_$course.db and $user_$course_parms.db in /home/httpd/perl/tmp to subroutine - &build_tmp_hashes().
- Move code used to unlink old $user_$course.db and $user_$course_parms.db and $user_$course.state in /home/httpd/perl/tmp to subroutine - &unlink_tmpfiles().
- More detailed logging to lonnet.log for failed operations.
- Additional check for existence of $user_$course.state after hash population and/or busy wait to get lock and read of existing files.

- Backport 1.131.

- Starting with lonnet.pm rev 1.981, default for &lonnet::delenv() has been to \Q escape arg in regexp used to identify items in environment to delete.
  - No longer need to escape special characters in arg passed to lonnet::delenv().
- Call to lonnet::delenv() in rat/lonuserstate now includes second arg, because in this case first arg is to be treated as a regexp (so \Q escape is not wanted).

- Backport 1.130.

- Regular Expression for both http and https.

Added/updated/converted POD. Many files had their POD redone to new standards.

Change arguments accepted by lonnet::appenv() to:
1. reference to hash
2. (optional) reference to array.

Change all instances where lonnet::appenv() is called to replace first argument passed (originally a hash) to a reference to the hash.

- Modify lonnet.pm rev 1.35 code intended to prevent "dangerous" modifications of the environment, so it will actually do this.
- Allow these modifications to be made in certain instances:
   DC switching to adhoc role
   CC switching to a different course role in the current course.
   user self-enrolling as a student

- eliminate double declaration

- need to pass $beenhere along to detect map recursion

- backport 1.123

- BUG#5477 - improve error message readability

- forward port 1.118.2.2 (BUG#3960) random ordering of resources
   - better randomizing then 1.118.2.2
   - adv users get resources in ordered state

- conditions get stored intoa file delimited by newlines, thus need to ensure the conditions are newline free

- count each usage of a specific mapalias, if the same one occurs multiple
  times throw an error message out

- appears advanced rat can leaving <param> deifitions for deleted resources
  hanging around, ignore any mapalias that are set to apply to resources
  that don't exist

- xhtml
- protect the rig in the regexp

- random ordering now works of parameter settings
- londocs has a check box for flipping random order on and off

(Currently all users are affected, probably need to disable for adv users)

- actually use a randompickseed if set

- implements the internals for randomizing the order of resources in a map
   - works by ignoring all <link>s in the map, collecting the list
     of resources and then <link>s them in a random order
     it throws all of that away and then makes a random linear map
   - works correctly with 'pick n resources'

   - TODO
      - currently always on and does all maps, needs conversion to using a parm
      - currently different ordering everytime you reinit a course
      - currently affects everyone

grppg replaces with smppg for group homepages.  Context determined from course domain and course number in URL.

Fixes so more menu buttons are provided when group page is accessed via Navigation controls (i.e., as a registered resource).  Other changes so grppg behaves like smppg.

Bug #1223: error when first resource is hidden
Also: error when first resource is encrypted

Closing filehandle after reading.

Bug #4370: better warning if there are errors during course initialization,
e.g., a map included more than once.

- removing unned use of Apache::File

- forward port 1.107.2.3

- keep both the old (unversioned) and new (version) keys

- remove debug line

- removing debug line

- backport 1.109 1.110

- making map_start map_finish_ map_pc_ entires contain a versioned url (the same thing src_ has)

- expression factoring was not correctly testing for the second test to succeed and get a valid subexpression

- not completely sure why I need to do this so newly logged in users can acquire a role but it seems needed

- optimize the 'no conditions' case

- no free of any use of $_

- changing the way conditions are stored, no longer are they a complete
  definiton of all of the individual expresssions but now allow the use
  of _<num>.<num> which point to another condition
- directcondval now understands the existance of these condition pointers,
  looks them up and recurses into docondval to evaluate them

- killing some usages of $_
- some style hanges

- backport 1.101 to 1.99

- reverting expirement for now

- expiremental change to conditions

- elminating a regexp that does little but take a long time to do it
- the 0th condition is by definition always true

- BUG#4635 ext resources that ended in / caused oddities

- reverting back to using /adm/coursedocs/showdoc/ to display all unk style resources
- adding new embed style 'wrp' to force /adm/wrapper/ing of 'wrp' files
- symbs don't include /adm/wrapper/ or /adm/coursedocs/showdoc/
- decluttered urls don't include /adm/wrapper/ or /adm/coursedocs/showdoc/
- cluttered urls _do_ include /adm/wrapper/ or /adm/coursedocs/showdoc/

- doesn't really need it

If LON-CAPA does not know what to do with a file, put a wrapper around, so
navigation gets preserved.

- reverting back to deleting the DB files on init

Bug #4241 - don't decode entities while parsing.

- make lonwhats new faster (BUG#4240)

parmset shows correct part numbers in descriptions
pprm has "show all" button
versioning works again

Bug #882: ID management, get old idx back

- can now modify the sequence resource parameters in PARM

- setting hiddenresource to no, makes sure the resource is not hidden by
    making sure the resource is not in the hidden hash

- BUG #4080

- ENV -> env

Replace Apache::File() with open() so lonuserstate can be called outside Apache.

- BUG#3995, could get 'Could not initlize this course' errors when really we were trying to init the course in several different apache children.

- stop userstate from buiding symbs by hand

- ws cleanup

- with to new caching mechanism this early cache seeding doesn't gain us anything

- encrypturl doens't work in 1.2.X so make it just hide them

 - eradicating some of the last few places that don't use getitle and thus don;t get : right, and don;t default back to file name (BUG#3587)

- don't encrypt src_ just mark that it needs to be

- conditions weren't properly cascading along,
    - code asumed a empty finish state, and thus could grab the condition that
      was needed to get into the finish state as the starting point for the condition
      for the resource after a nested map, need to instead pass the end condition up
      the recursion chain

- map conditions work

- PARMing of hidden,encrypturl works now

- leave the /uploaded URLs of ssi able documents alone

Hiding and encrypting complete folder trees by making the respective
settings recursive.

- Somewhat amazed at how easy this was should with these changes
   - uploaded .html/.page (all ssi type docs) now
       - get parsed
       - can be printed
       - get default parameters
       - are no longer wrapper ed

- .problems are still somewhat issue oriented though (need real metadata support for uploaded)

Bug #2944: double listing of randompick (with and without part 0)

Continued work on hidden and encrypted URLs

Open up the wonderful can of worms of hidden and encrypted URLs and folders.

Do not prepend /adm/wrapper if URI for uploaded item is for a page.
This allows "non-res" pages to be uploaded via DOCS, e.g., pages created from processing of an IMS package.

Bug #2381: External URLs with query string work now. Bighash's ids now do
not have query strings anymore.

Yep, there is going to be somebody naming their file "0".

This should go into 1.1.

Bug #2498: empty src was turned into directory reference. For 1.1.

Bug #2453: pretty bad, fix should go into 1.1

Since the publisher does not longer change every URL into an absolute path,
and we are officially allowing relative sources in maps, we have to have
lonuserstate do a hreflocation of map source with respect to the map
location.

Remove debugging code.

Do not explicitly request most recent versions of files.

Two subroutines will need caching:

* lonnet::fixversion
& lonnet::getversion

Bug #531: Nail down versions of resources.

Needless to say that this now causes all kinds of little nasty follow-up bugs
with ambiguous resources, etc., so do not use yet.

Starting to do stuff: looks like the explicit version picking works now.

- takes care of more of BUG#55
   - added new parameter to packages .tab and away to associate parameters with only part 0
   - map level parameters work again

At least a few loose ends regarding versioning, unfortunately much more to
come.

Just saving my work on consistent versioning, several things need fixing.

- titlecache now uses the common cahcing infrastructure

- changed titlecache to also store a time

- understands new rndseed setup

- better as string comparison

- the continuing adventures of ).problem and the server crashes he causes

declutter earlier to also remove query strings.

* Start using library routines in lonuserstate and lonpageflip (ancient code)
* Have lontest show symbhash
* Have is_on_map filter for wrapper

Still working on running syllabus, etc, without /adm/wrapper.

Taking Bulletin Board, Simple Page, Navigate, Syllabus, and About Me out of
lonwrapper, and starting to deal with the consequences.

Introduces new "randomly pick random seed" parameter. However, just for the
record: having the same sequence more than once within the same sequence
does neither work for rids. Let's just say that this is a feature, not a
bug.

If you want the same randomization of the same sequence twice, you need to
have two different parent sequences, and use the same seed.

- converted to use the non-perl random number generator
- randomness more stable, keys off the second number in the rid not the first

best wishes to all.

Do not jump to a sequence as first resource. This avoids two bugs:
a) part of Bug #963 - courses with /uploaded-sequence as first
   resource now work
b) jumping to a sequence which has a sequence as first resource

Fill lonnet::titlecache, toward Bug #793.

Bug 790

Checks for versioning privileges

Toward bug 531.

Can address most recent version.
Can find out with lonnet::getversion what the most recent version is
Shows versions in lonmeta

Continuing work on simple pages and ad hoc bulletin boards.

Simple pages sort of work, bulletin boards not yet.

"showdoc" needs to be URL-encode like all the other functionality in order to
properly register with the remote. Remote has now additional fields to store symb, but
nothing is done with them yet. Eventually, this should improve navigation and contents
display for resources showing up multiple times.

Now handles uploaded folders like maps.

BUGFIX tmp file mechanism for lonratedt
  - display right after "Save" and "Revert"

Can override ratedt tmp-mechanism for coursedocs
Does NAV as resource in coursemaps
Start on showdoc mechanism for uploaded docs in main sequence

Various new functionality for "ad hoc" courses.

"uploaded" is starting to become recognized top-level in addition to
adm and priv. Problem to work around: /res is always stripped by default in
declutter.

Use lonnet standard routine to determine map filenames and read them

- BUG#574

Add symb after existing query string, if present.

Fixes problem with empty very first resources in course. Was caught by
"allowed" before changes towards random pick went in.

Since in &pickrandom the leftovers of @currentids are what will be deleted,
one needs to elimate $rndpick many elements.

Put randomout into %ENV

Add randomout also to environment, so that it is available to &allowed
without opening hash.

Bug 567
Sets title, src, ids, and is_map in course-hash
for top-level map under resource-ID "0.0".

Towards bug 150.

Puts "randomout_(resID)" into coursemap hash for resources that are
randomly NOT selected based on randompick parameter.

Toward bug 305

Now reads mapalias parameters into bighash, e.g., mapalias_fred=4.2

Bug 500.
Pipe symbol was interpreted as "or" in the regular expression that added
additional conditions to the access of a resource. Only occured if a resource
appeared at least three times.

adding in POD documentation; changing void context map statements to
foreach statements; removing references to Apache::lonnet::fileembstyle
and using Apache::loncommon::fileembstyle -Scott Harrison

GPL

Access to "no-URL" is allowed.

Runaway condition on empty URLs hopefully fixed.

Works now except for page flip.

Finds very first URL for lonroles to jump to.

Implementation of "part" in param

Parameter mechanism changes

Reads resource parameters

Now calls EXT instead of varval

Replace & by []

New function to calculate state string in environment.

Clear out junk from session environment, and puts in http referers

Multiple appearances of the same resource taken care of in look-up info that
lonnet::allowed uses

Logs errors for the author

lonuserstate cleans up symb table, lonpageflip contributes to it

Eliminate type course

Now takes courseid as only parameter

Get rid of /res

Condition number with more than 1 digit bug

New versions development

State now course specific in environment

Writes access info to environment

Conditions implemented

Work in progress on lonuserstate, better connections for code.html

Translates XML course maps into binary format for browsing
Work in progress, not functional yet.