CVS log for loncom/interface/lonhelper.pm

Up to [LON-CAPA] / loncom / interface

Request diff between arbitrary revisions

Keyword substitution: kv
Default branch: MAIN

- For 2.11
  Backport 1.203

- For 2.11.4 (modified)
  Include changes in 1.204

- For 2.11.4 (modified)
  Include changes in 1.203

- Bug 6907
  - Support printout option: "Selected Resources from selected folder in course"
    in sessions launched via deep-link.

- Include printout icon in "Tools" above listing of course contents unless
  course is empty. Options include:
  - Print items not in a folder (if any exist)
  - Print items in a selected folder
  Privileged users can also print selected folder for selected users or CODEs.
- When displaying list of resources to select exclude any /adm/navmaps items
  themselves.

- For 2.11
  Backport 1.202

- Group separator in $env{'request.course.groups'} is : not , .

- For 2.11
  Backport 1.199, 1.200, 1.201

- Eliminate: "minute() is a read-only accessor" from log spew.

- Bug 6791. Links launched as modal pop-ups for resources listing in
  "Select Resource(s)" to print UI.

- xhtml. Satisfy w3c validation

- Bug 4373.
  Parameter helper can set map-level parameters which apply recursively to
  subfolders.

- Bug 5349
  - Users with mdg priv (i.e., Course Coordinators) can set/delete/display
    any group-level parameters in the course.
  - Users without mdg priv (i.e., Instructors) can only set/delete/display
    group-level parameters for groups to which they belong.
    - Can also display group-level parameters for a specific resource or
      map (from Content Settings in Functions menu when viewing resource)
      for any group in the course, but can only set/modify/delete those
      for groups to which they belong.
  -  When parameter helper is used by a user without mdg priv in course
     (i.e., Instructor) changes may only be made for groups to which user
     belongs.

- Bug 5349
  - When parameter helper is used by a user with a section-specific role,
    changes may only be made for users in that section.

- Bug 5439
  - Actually use requiredpriv attribute in determining access to helper.
  - For a user with a role tied to a section do not offer parameter setting
    for other than students in that section.

- Fix quotes.

- Coding style: keys()

Corrected rev. 1.191 - scope of &mt() call

Internationalization: Added missing &mt() calls

- Suppress link to edit folder/page when lonnavmaps::render(() is used by
  helper to display course contents (e.g., when selecting whihc problems
  to print in a course).

- &constructaccess() moved from loncacc.pm to lonnet.pm
  - to facilitate re-use, and separate from handler,
  - for use in lonnet.pm (use Apache::Constants() not supported there.

- Can define end time for student schedulable slot reservations.
- Wording change for slot helper to clarify what 'Any time' means
  for slot reservations, or for when slot is uniquely selectable.

- use lonDocRoot perlvar in place of static string: '/home/httpd/html'.

Being able to list directories in construction space again

- use lonDocRoot perlvar in place of static string: '/home/httpd/html'.

Bug #1320

- Change to way lonnet::dirlist() reports an error condition (i.e., no_host,
  con_lost, no_such_dir, empty etc.) when retrieving directory list information
  with ls3, ls2 or ls.
  - error is passed as second item in a pair of return values.
  - first item in return values is a reference to an array of actual files.

- Backport 1.182.

- xhtml. type="string" not valid type in <input />
- add some spaces in <input /> tag to improve readability.

- Backport 1.181.

- xhtml -- action in <form> tag for helpform
- HTML markup for recent printouts need to be within body of HTML
  for valid xhtml, and to avoid case where browse displays blank page.

- For 2.10 reverse 1.179, remote control retained in 2.10.

BZ7407 -
1. Allow multiple strings in a single helper page with validators on all.
2. Fix up the validator for the second string in printing coded assignments so
   that is recognizes that a string there is not compatible with entries
   in the prior section of the helper page.

In process of removing remote control, remote navmap and different icon modes code
Also some minor refactoring.

Add documentation for the new widgets that can appear in columns of the
resource chooser helper element.

Memorize the previous extra vskip values.

Parametrization, last helper step:
- Corrected unbalanced HTML tags (added </p> and </ul>)
- Prepared previous button (currently not fully functional, see comments)
- Added info style to info message about confirmation of correctness
- Replaced button text "Finish Helper" by "Save" to stress that a click on the button is needed to save the settings
  (This was reported by CCs to be confusing)
- Removed deprecated <center> tag

Course Initialization, last helper step:
- Consistent Wording: button text "Save"
- Removed deprecated <center> tag; consistent button alignment

- Adjusted and updated translation phrases and added some missing phrases
  (de.pm, zh.pm)

Helper screen optimizations:
- Removed unnecessary und inflexible table structure
  (also accessibility enhancement)
- Moved "Previous" and "Next" buttons to left top / left bottom of the page
  (Ergonmical enhancement: No massive horizontal eye and mouse movement needed anymore on big screens to access buttons; less confusion for screens with only little content)
- Simplified code for "Previous" and "Next" buttons
- Don't display headline in italics anymore

Added breadcrumbs to helper.
This currently covers only basic call and general "Helper" crumb.

Redesign: no separate accessibility interface, cleaning up a bit

XHTML: Attributes in lower-case only (<form method="post" ...)

BZ 4360  Added code to post processing stage of <resource> tag.
If the form.VARNAME_forminput variable for an OPTION_VAR is not defined,
act as if it's set to ''...that is no options selected.  Otherwise,
if someone unselects all options, the prior, saved setting is used.

consistent wording, short button names.

- Backport 1.169.

- Check that navmap object could be created to avoid ISE.
  - Log to lonnet.log if navmap object undefined.

- Backport 1.168.

Replaced
  <nobr>...</nobr>
by
  <span class="LC_nobreak">...</span>

- lonsearchcat.pm: Added missing start tag for nobreak area
- lonsurveyreports.pm: Added missing end tag for nobreak area

- Separated HTML formats from translations:
    Moved HTML tags from text to parameters and changed related German translations.
    More changes like this needed.
- Added some missing translations, e.g. for lonprintout.pm
- Optimized/corrected some translations

Bug 5792.
Date/time selectors in helper now make use of a course-wide time zone (or the default time zone for the domain if no course-specific one set).

Bug 5783.
- Don't prepend $perlvar{'lonDocRoot'} to $ulsdir when using lond::ls3() to list files in a directory in CSTR.

- backport 1.164

- for those using the perl mechanism of building the CHOICES array by hand,
  they need to take care of &mt() the label, use of the xml mechanism
  will auto mt for the user  (Which will result in not trying to translate
  problem titles)

- BUG#5387
   - resttimes helper wasn't including the top level sequence
     when attempting to reset inital access times for groups of users

- add ability for some message to get marked as warnign or error messages

- some ttranslation improvements

- change wizard to helper
- add a help attribute to the <state>
- <helpicon> wasn't displaying the internal text
- if the firstthing in a state was a <helpicon> the
   nextstate wasn't taking effect

- adding a <helpicon> tag to the helper

- dont show the header for no existant sections of users
- mt the headers

Form element name changed from selectedusers.forminput to selectedusers_forminput so attributes can be obtained via javascript calls for this element.

Add headers prior to the various sections of the student prompt
so the users have >some< idea what they're choosing. request 3809

- adding a <skip> mechanism so that states can defiine for themselves when they shouldn't be seen

- use was not added to the subpackage

1. If necessary restrict student selection to those in the
   section for which the user has advanced roles.
2. Revert the switch of &Apache::lonnet::escape -> escape back since
   there was no sub escape defined (yet?).

&Apache::lonnet::unescape -> &unescape
&Apache::lonnet::escape -> &escape

&coursegroups() and &get_group_settings() moved to longroup.pm, which contains general utility functions for asking about groups.  Also contains &group_changes() which is used to add/drop group memberships as a result of role changes, as determined by group settings for auto-add and auto-drop. 'none' and 'all' are now reserved words which may not be used as section or group names, so they can be used instead of _all and _none  when specifying auto-add and auto-drop settings for all sections or no section roles.

- BUG# 4733, only student specific parameters were actually getting set by the helper (due to level changes)

Allow specification of the form name in student selector too.

Separated the stuff to render student selection lists into a separate
pacakge: lonselstudent.

Factor out student/staff enumeration from the helper.. all this stuff is so that
we can try to use those functions to generate a similar student/staff choice
list in the lonmsgdisplay.pm module.

More work to make renering a student list indepedendent of a helper if need be.

Continue to separate student display into an independent sub and
clean up some dead stuff.

Bit by bit pulling the render_student_list into an independently callable
sub and doing some cleanup.

- sort section listing so
     - 'No section' heads the list
     - case insenstive
- Group selctor also list in case insensitive order

- changing loncommon::coursegroups to be easier to use

BUG/ENH 3809 - Helper improvements.
  o Restricted the action of the listboxes to the segments to which they were
    tied.
  o Removed dead javascript that will no longer be used.

- xhtml wants onclick
- style police
- reorder to be current, then future, then past

Revamped helper per Felicia's desires..still need some cleanup as follows:
- Remove dead javascript
- Restrict the (de)selections of the listboxes to the segment of the form
  they live in.
- See if we can make the student picker code independent of the helper so
  non helper student pickers can use them..alternatively switch those over
  to helper.
BUG 3809

- slight improvment to data defaulting
- any time is two words
- it's evaluating the validation code

- add <validator> support to <date> widget
- need to reorganize the current value finder for <date>

Added relatedvalue and relateddefault attributes to <choice> in <choices>
element.  This allows a text input to be associated with a choice.
e.g. <choice computer="1" relatedvalue="somevariable" relateddefault="42"> ...
The value in the text box goes into $helper->{VARS}->{somevariable}
and the text box is initially displaying 42.

- start_page

- <section> by default now also includes groups but can be forced to be only sections through the 'onlysections' attribute

- allow empty section fo group selections

Enh. request 3809: Got the expired students separated from the
unexpired students now.

Enh request 3809 - Move stuff around on the student selection page
for the print helper.. put all the fancy choice stuff and sort order at top.

- don't set the min to zero when resorting from a previously set value Bug#4613

- use style file link didn't actually work (BUG#4575)

Add support for setting of parameters for course groups.  Work stll needed to deal with the case where no course groups exist.

- don't specify the target if we aren't using the remote

- <defaultvalue> in <student> works now

- handles better the case where defaultvalue doesn't return anything of note

- making <defaultvalue> work for <resource>

- okay can spec out proctors now
- helper <student> selector now allows empty choices as a possibility

- just need a commit

- style police

- multiple minutes appear multiple times need to pick the first one in the list

- anytime deslects if they interact with the time elements

- add the ability for a <date> to return an 'anytime'
- allow <date> <defaultvalue> to actually work

- put the most common minute selctions first

- the state restriction wasn't taking effect
- don't need to show the selectors when selcting only 1 user
- restrict the height of the multi selector to no more than 5 intems

- addign <label>s

- correcting the html
- xhtmlize

enhancement bug: Improve the user interface for selecting
students from multiple sections.

<script> fixups

- checked, asleected updates
- for and to attributes need to start with a letter not a number

- file selector in helper was assuming directory user was trying to print belonged to the default domain of the machine (which isn't tru on multi domain machines)

- BUG#4202

- BUG$4194, okay map level setting is good

- BUG#4194 okay can now set dates

- final confirmation screen in helper wasn't showing the full name of the user

- BUG$4194, helper works now for
   - full course, all resources, maxtries
     (off to thest the rest)

- most of BUG#4194, needed to
   - modify the 'level' value passed to take in account the changed ordering
     of the res/map defaults
   - need to pass more data to parmset to get it to enter table mode and set
     the parameter

- stupid silly typo.

- ENV -> env fixup

- removing a typo

- ENV -> env

Fix up the regexp matching for remembering <resource> option values.

BZ 3173:
  Save the pagebreak positions as course paramters to that they can be
reproduced.  Note that at present, what is saved is the set of symbnames
in front of which a pagebreak should occur.  No printing context is
saved.  This means that if you later print multiple resources which overlap
with a prior multiple resource print, you will have some pagebreaks pre-set.
This may not be wholly bad, but is probably not wholly good either.

- BUG#3940, throw an error when they don't specify what to print

- <html> -> &Apache::lonxml::xmlbegin, thus valid doctypes are now getting output, Yeah! StandardsCmpliance

- backing out the encoding changes for now

- some xhtml cleanups
- one icon -> lonhttpd

- implement BUG#2123, Parameter helper needs to work with problem parts
	- additionally the helper now passes along info so that table display mode at the end is limited to just the resource/part/parameter that was changed

- Bug#3839, [] in a resource title confused &mt, on &mt when the text is in a .helper and isn't dynamically generated

- get rid of a typo that prevented 'activeonly' from be respected in the student selector
- rework <final> so that it generally more useful

bug 3759 - clean up formatting of student selection and sorting buttons.

Implement page/column breaks forced between arbitrary resources on the page.
There are few design compromises that need to be documented here:
- Checkboxes in the helper could only be put prior to the actual resource.
  Therefore pagebreaks will come >prior< to the resource the check is at.
  This seems a bit more visually intuitive than to have the checkbox first and then
  the pagebreak after the resource.
- There's a nasty design tension about what to do if they check a page break
  for a resource they decided not to print (I'm devious to even think about this):
  I had two choices on how to mange the page break locations
  o An array of page break resources.
  o A hash of page break resources.
  The problem with a hash is that it is not order preserving which is a problem if the
  user can print out the same resource several times on a print job.  This is not
  as strange a case as you may think.. consider a resource that's boiler-plate.
  The problem with an array is that if the user checks a resource which is not in the
  printed set that throws things off since, again, given the possibility of repeated
  resources I don't see a reliable way to get back in step with the resources.
  I chose the latter relying on 'intelligent use' of the user interface.. which
  I know is a mistake, so I'm supplementing this with documentation of the
  problem/issue for others to see.

Bugzilla enhancement: 2968
   Added <option> tag to lonhelper and using it within lonprintout.pm to
>display< a checkbox to allow the user to select where \nepages will land.
NOTE NOTE NOTE:  The functionality of actually inserting the \newpage
where the user wants it is not yet implemented.

Defect 3290  -- and perhaps some others.
Fix systematic quoting problems in html elements.  There were cases
where value = ' .HTML::Entities::encode(something, '...')
did not include ' in the set of 'bad' characters that needed quoting.
I believe all of these cases have been hunted down and squashed.

- fixes bug#3350 hopefully for good.
    - $navmaps objects never actaully got cleaned up due the resource objects in it holding a reference back to the navmap object, this meant the hashes didn't get untied and that we leaked memory
    - needs WeakRef

use <label> around radio & checkbox inputs.  Only on those inputs whose
labels are generated in the helper, not navmaps, so inputs where you select
a resource or folder are not affected.

- when priting from a Co-Author CSTR dir, everything looked unpublished (BUG#2540)

- BUG#3043, directory listing was in case sensitive order

- removing log spew

Bug 2213 (localize helpers) is finally done. See course.initialization.helper as well.

Bug 2855 (Priniting for expired students) is fixed. But I am ready to return to this bug if your reaction would be negative (I mean Guy Albertelli). I changed option "Select for Section/Group" on "Select Current Students for Sectopn/Group" and added option "Unselect Expired Students". The last is excessive to my opinion but some users wanted to have this option as well.

Removed spaces.

Last correction.

Corrected till the end.

Corrections to remove html from statements.

Corrected localization for changing parameters.

Localization of warning messages from parameter.helper is done.

- removing the copy/pasted Javascript code

Semicolons are your friend.

- I think this might be more translatable

Added some localization statements.

 Some localization.

Corrected header.

Some localization is done.

Some localization.

- trying to be UTF8 transparent

- add the ability to have .pages summarized
- Make it so that you can choose to print a page or not print a page, don't allow people to pick and choose resources gfrom inside of a .page
- BUG#2851,

Typos: "separate"

- BUG#2575, course init helper now returns user to a more normal location
- DOCS if it is a new course, Overview PARM if the course is cloned,
and NAV maps if the course is given a specifed top-level map.

Fixed bad html on last page of helpers.  How did any of these helpers ever
work with this bug in there?

Added use for Apache::lonlocal.

- ain't a wizard

Correct error caused by poor merging with Alex's code.

Some more internationalization. I think I got all the hard stuff I know
how to do; there's still some parameterization and I'm not doing the
internationalization of the stuff Alex is doing in this commit.

Last update to imlement unselection of student's group.

- removing 1.56

Last change is restorted - added unselect for section/group.

- removing 1.54

Added unselection for section/group of students.

 Bug 2227 (Select which student to print needs to be easier) is fixed. You can select only "active" students or you can select by sections.

Not a typo. ;-)

- typo

Localizing lonhelper.

Also squashed a new bug in the helper; seems the behavior of the
Time::Local::timelocal has changed; instead of coercing Feb. 31 into
Mar. 3, it dies. May be related to locale change, may be a change in
newer perls. Don't care to investigate, since this new code will catch
either dieing or silent coercion and use it as an error. (Dieing was
impolite, though, hosed the server for no good reason. I would have left
the old behavion and added a 'strict' parameter, I think...)

Fixing problems for printing.

Docs updates, new features for resources, and now, support changing
weights in the parameter helper.

- better search for metadata when directory in CSTR
- understand ~ CSTR space directories

Allows helpers to use the status display.

Send the user to the parmset overview screen when re-initing the course
if the course is cloned.

Documentation updates for lonhelper.pm (apparently), and fixes bug 2104.

Oops!

Add a "dropdown" choice to the helper routines, for use on the print
screens.

lonnavmaps are now maximally lazy; no processing is performed until it
is needed, except in cases where it makes sense to grab all data for the
course at a time.

As a result, the Apache::lonnavmaps::navmap->new() call no longer needs
any arguments; it assumes you're using the current user's navmaps and
generates the other data as needed.

Should fix 1867.

"student" option now allows a parameter that allows you to select
course personnel as well, but this will have a problem with multiple
roles for the same person. Still, this is an improvement, if not a final
fix...

Adds validator support to lonhelper, added validator support to the
string, and fixed the parameter helper final state to support tries.

Hopefully fix bug 1174 to everyone's satisfaction.

Send users to the menu at end of helper, not navmaps.

Fixes bug 1511.

Added in a fairly simple "string" type helper entry which allows the
user to manipulate a simple string. <string> honors defaultvalue.

Also gave <final> the ability to specify an override to the helper
environment to force the user to reinitialize the course at the end of
the helper, which was necessary for the course intialization wizard.

This broke all helpers.

My best guess on how this happened was a ^K^K going to the wrong window
and I never noticed, because I can neither think of nor remember a
reason for whacking this line, which was like *the critical* line to the
functioning of the helper.

Fix #1447, show actual title on files screen.

Allow specification of required priviledges to use a helper.

Change the next/previous formatting, drop some of the extra space.

For bug 1306 and some other things.

When filtering resources out of the nav maps, such as in printing when
the user is allowed to select just problems out of the course, it is
common that there are folders that contain no problems. Thus, before
this patch those folders just sat there, empty and open, which is a
visually confusing UI state, even to me, so I imagine the users would
be even worse off.

The navmaps part of this patch allows you to specify a parameter such
that empty maps should be suppressed, so they don't display and confuse
the user. The lonhelper part of this patch passes that parameter through
for resource elements. The lonprintout part of this patch turns
that feature on for "print problems from this course", so that empty
folders no longer show up there.

This turned out to require pleasently little code in lonnavmaps, by
putting it in the right place. The real functionality is all in about 20
lines (without comments).

No longer pass things on the querystring. Seems to be working.

This commit is to fix up the parameter helper. Fixed student name
breakage. Now the parameter helper does a better job (i.e., it *does*
a job) of showing the user where they would have entered the parameter
with the advanced interface. Hopefully this won't cause too many
problems...

also included in this commit because it wasn't worth trying to mask it
out is the beginning of some more infrastructure I will be using for the
course initialization wizard, that allow the helper writer to bundle
the logic for selecting the default value, display the value, and
finally set the value all in the same geographical place in the helper,
putting all the logic for a single preference in the same place. Pretty
cool, if I do say so myself. ;-)

Add the ability for <choices> elements to accept no choices at all without
erroring out.

* Fixed heisenbug that caused wierd stuff to happen if the handler
  tried to access file-scoped variables. See lengthy comment at the
  beginning of the commit message for a discussion; feel free to discuss
  it with me if it still doesn't make sense. (I think this may have had
  something to do with the global variable troubles in the past.)

* Added "finalcode" and "defaultvalue" tags, intended for use in the
  course initialization helper. <choices> now respects <defaultvalue>.

* If there are fewer then five choices in a multi-choice <choice>, don't
  display the "Select All" and "Unselect All" buttons, as they are
  visually clumsy.

 Small check where we are (construction space or resources space) added.

Update to lonhelper.pm

HACK HACK HACK

Makes the "Select Published" and "Unselect Published" work in Netscape 4.
See lengthy comment explaining why it's done this way.

****'in Netscape 4.

Add the ability to select or unselect published files.

File states now show problem statuses.

Add section to student identifier returned when using the student state.

When more then two elements that have a "checkall" button are in the
same state, the "check all" buttons should only apply to the particular
*element* they are clicking the "Check All" button for, not all
check boxes on the screen.

Resource panels have new options "toponly" to avoid recursion.

Enhanced documentation for creating helpers by code.

Fixed some features with the preprocessing that was supposed to work;
states are supposed to have the opportunity to bypass themselves. The
page format element does this (if the user did not select one col, it
skips itself). For a variety of reasons this was not working.

Makes the paper state work on my machine.

Add "Select All" and "Unselect All" button to the resource selector,
and fix some of the other "Select All" buttons.

Add multiple selection capability to the resource object.

Make it possible to create helpers manually, by exposing the functionality
necessary to do that.

Student and section selection should work now.

* "die" now explicitly used when subroutine compilations fail so the
  web server error log has an indication what the problem is, instead of
  silently failing.
* Added section choosing routine. May not completely work yet.
* Added eval tag, which allows the user to programmatically specify a
  message to print, which turned out to be necessary.

Brain-o: <message> should take nextstate as an attribute, not a sub-tag,
and we can do away with the <message_text> entirely.

<nextstate> is OK for the rest of the tags that use it, I think, because
it doesn't cause such clumsiness.

I plead temporary insanity.

Added DATA hash to the helper, for use by helper writers.

Add the "condition" and "exec" tags for executing code and conditionally
dropping selected parts of the helper XML. This gives me most of the tools
I need to replicate current wizards.

Dynamically register and unregister the helper tags when we see the
<helper> and </helper> tags, making my worries about namespace pollution
go away.

This goes a long ways towards cleaning up a lot of the worst problems.
Elements now prevent states from advancing if there is an error, and
they print error messages now.

There are still some data-loss cases if you routinely use multiple
elements where both of them might have user-input errors, but by-and-large
that should not be a normal wizard, so I'm not inclined to blow time
fixing those corner cases until a situation develops where we need to.

Checkpoint checkin. Most of the states need some sort of brushing up, but
it's largely working now. The persistent storage actually works now. All
but the special final param setting wizard state are in there in some form.
Still need to re-write the registration functions to dynamically push and
pop the wizard-only tags onto lonxml's recognition stack as needed so I
don't worry about namespaces.

Progressing through the states now works and <message> elements are
now confirmed to be working.

Basic infrastructure in place; can actually successfully display stuff
based on the XML now.

Depends on some other files that aren't in the CVS repository, so this
won't work for anyone else, but I am rocking now. A file is being read
off the disk and being processed through lonxml... in other words, all
the hard parts I wasn't sure about. It's mostly typing from here.

Beginning work on the XML file handlerr for lonhelper (formerly the wizard).
Beginning work on the .helper XML handler for lon-helper files.