CVS log for loncom/interface/spreadsheet/Spreadsheet.pm

Up to [LON-CAPA] / loncom / interface / spreadsheet

Request diff between arbitrary revisions

Keyword substitution: kv
Default branch: MAIN

- Fix spelling.

Fix wording typos

- Internationalization: Added missing &mt() calls
- XHTML
- Standard styles

- Bug 6639
  - cells previously populated, but now updated to contain nothing, are skipped
    when cell contents are retrived using &get_values().
  - Spreadsheet functions: &NUM(), &BIN(), &SUM(), &MEAN, &STDDEV(), &PROD()
    &MAX(), &MIN(), &SUMMAX, &SUMMIN() all call &get_values().

Error messages:
- Reuse existing phrases; consistent wording
- Adjusted translation files de, es, zh
- Added error style

Wording: "CSV" (comma separated values) everywhere uppercase

Past tense of "occur" is "occurred" (rr!)
Also added some missing &mt() calls and corrected some other little typos

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

- backport 1.77

- if you change any sheets we'll need to expire it, not just the default one

- tabination

- add a &PARM() routine to SPRS
- document &PARM(), &MAXPARM(), &MINPARM()

- allow [&EXPANDSUM()] to span lines

- uniqueify the list parms so they don't substituted multiple times

- login was backwards

- wasn't properly defaulting to the standard system spreadsheets when
   accessing the SPRS for the first time
- add ability to reset a SPRS back to the system standard ones

- replacing incorrect E-oh-FFDD with E-zero-FFDD

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

Determination of parameters for spreadsheet now correctly cascades for cases where a user has multiple active groups. Also groups are passed in argument list for Spreadsheet object as array reference. Lastly lonnet::get_users_groups function modified to only return user's active groups, except in case when user status has expired (and default end access date for students has also passed), in which case user's groups which were still active less than 24 hours before default end date are also included in user's groups. [For consistency with students groups returned by loncoursedata::get_students_groups()].

Making group-based parameters apply in spreadsheet, using same cascading precedence scheme as used for parmset.

- #self->{'section'} never got set

Correct extremely low-quality submit.

Add parentheses around the result generated by EXPANDSUM.

- style police

Fix bug 4556 by introducing the ability to just view the source of the
spreadsheet, without any computation at all.

- allowing EXT to take a symb

- when spcifying rows with the * don't include the 0th row

- stupid typo bug

- sigh

- wasn't updating the internal memory spreadsheet cache when saving to the external remote spreadsheet cache, now both stay in sync

- no need to make the round trip since the env is no correct

- when changing the course env, need to also change the local users session environment

- fixes bug #4296 spreadsheet can't be edited

- BUG#4287

- BUG#4151 - spread on brand new course would fail to work

- cache the parses of the formulas when there are alot of %f it can take a while to parse through them

- err need to set filename in new

- only load the sprs once we actually need it (since if we have it cached no need to load it)

- no reason to expose the home server of either the course or the course

- @os and $f seem to be unused, commenting them out for now (save 0.03 seconds on the student level sheet)

- minimizing the number of elments in %t, and moving sheet_values to be out int Spreadsheet not in the safe space (student level sheet not taking aroun 0.5 seconds to compute)

- elminates the use of
   grep eval(/$re/) keys(%sheet_values)
which was a very slow operation

- converting everything to use &get_values instead which right now does the grep

- forward port 1.37.2.2

- er sort numerically?

- backport 1.42

- don't put empty cells in the spreadsheet

- ENV -> env

Updated to use loncommon::create_workbook.  Spreadsheets were slightly
modified to use formats.

Changed to use navmaps.

Safe space changes
Fix &EXT routine by including all appropriate context information (symb,
name, domain, section).
Fixed bug in which the symb was not actually available in the safe space
(used 'usymb' instead of 'symb' to denote the symb).

- trying to be UTF8 transparent

These fixes should go on S10 as soon as possible.

Spreadsheet.pm: Fix to handle the case when a spreadsheet object is
created without a valid username/domain passed to new().

assesscalc.pm: Fix to ignore stored data which does not contain the username
and domain.

lonspreadsheet.pm: Fix to not do stupid things that got us in this mess
in the first place (only accept form parameters which have values and do not
send out form parameters without values).

- don't study expressions

Fix to xml output of template cells.

Fix loading of spreadsheet xml from published space.  Commented out code
for xml output and fixed some for xml output.  For inclusion in 1.1.x.

Report errors in calculation even when outputing in Excel or CSV format.

Backport of changes to make spreadsheet report calculation errors and not
save bogus data.

Added new output mode at the course level.  It just displays the
students with a link to their spreadsheet.  Reworked how output options
are handled to be able to vary them by spreadsheet.  Reworked some confusing
(to me) localization code.

Fix bug in error reporting where errors in computation of the spreadsheet
were not reported and bad cache values were stored away.
Added in Spreadsheet: &set_badcalc, &badcalc, &set_calcerror, &calcerror,
and &html_report_error.  These are used to keep track of computation errors
and to report them to the user.  The &save_export_data routines were all
modified to not store data when an error has occured.

fix broken html

Internationalize and fix "seperate".

More sanity checking in &mask.

Complete rewrite of &mask to return more correct regular expressions.
This is to fix a bug where &mask("X15","X24") would return ^[X-X][5-4]$.
Now it returns ^[X-X](\d+)(?(?{$1>= 15 && $1<=24})|donotmatch)$, which is
actually clearer although it does not appear so at first glance.  A comment
was added to &mask to explain the regular expression.
POD documented &mask, added a debugging helper, and modified all of the
calls to &mask to wrap its result in an eval as such complexities require
using an eval.  I would reference a bug here but bugzilla is down.

All sheets use the same safe space.  Tested, seems to work in basic cases.
Requires more testing.

There are downsides to making warnings fatal:
my %tmphash = &Apache::lonnet::dump(blah) crashes if the file does not
exist.  Not good.  I don't feel like detecting this right now, so I am
commenting out the use warnings stuff...

Clear package variables on both normal completion and on interruption.

Minor modifications brought about due to making warnings fatal.

HTML::Entities::encode does not encode backslash.  How annoying.
Do it ourselves to make sure formulas come up properly when editing
spreadsheet cells.

Bug 840, default spreadsheet should show proper available points on
excused and partially excused problems.

Fix bug 1221: due date changes not showing up in spreadsheet.
The issue is with expiration dates in &check_expiration_time()
1. Was using 'usymb' when we should have been using 'symb'.
2. We were not checking for the case in which all students have had the
   sheet associated with a given symb expired, as happens when you set
   a parameter for a problem.

Bug 1635: Handle ' and " cleanly.
&html_editable_cell:By default &HTML::Entities::encode does
not encode single quotes.  By passing our own list of things to encode
(or in this case, not to encode) we take care of all sorts of issues.

Bug 1729 - color hints on export/import rows.  The color of the export
row of the assessment sheet is the same as the import row of the
student sheet.  The export row of the student sheet is the same color
as the import rows of the course level sheet.

When changing the default assesscalc spreadsheet we now expire the
student level spreadsheets.

Remove unused code.  When the system tries to compute a spreadsheet
we first try to load the sheet from the class' directory.  If the
sheet is not present we then load the system default for that level.
This allows the user to make changes to a spreadsheet and save it
with the same name as the system default (default_sheetlevel).

Attempt to fix bug 1635.  Errors in quoting of parameters caused errors.

Reworked spreadsheet filename handling.

Fixes bugs 1513 and 1516. Every time a new row is added to a spreadsheet
the spreadsheet will be saved.
&set_row_numbers now actually keeps track of the maximum row found, which
can be useful if you need to add a new row...
Also fixed bug in caching of spreadsheets - was storing the 'join'd version
of the formulas when I expected a hash reference.

Added $spreadsheet->initialize() subroutine to take care of specific
initialization needed for each sheet.  assesscalc now has a list of
mandatory parameters (Bug 1514) but is running in to problems with
bug 1513.

Modification to &expandsum:  If we cannot locate the parameter, return '""'
instead of a string describing the parameter we could not find.  This
keeps a lack of a parameter from blowing up a cell computation.

Fix bug 1518 - spreadsheet temporary filename was changed if you edited
the default spreadsheet.

Fixes to allow loading of files from published resource space.
Removed superflous logthis calls.

Fix display of template rows to not show uneditable cells as editable.

CSV output implemented.

Added output selector and implemented excel output.

Moved $spreadsheet->display() to Spreadsheet.pm instead of having it reside
    three times in the descendents of the spreadsheet object.
Moved $spreadsheet->outsheet_excel() to Spreadsheet.pm for the same reason.
Created Spreadsheet::output_selector, which allows the user to select the
    output mode they desire.
Created $spreadsheet->excel_output_row which takes care of writing a row
    to an excel worksheet.
classcalc.pm, studentcalc.pm, and assesscalc.pm each had the same work done
on them:
  Created &excel_rows(), which writes the body of the spreadsheets to
     an excel file.
  Rewrote &get_title to return an array of title lines.
  Created &get_html_title to return an HTML version of the results of
     &get_title.

classcalc.pm and Spreadsheet.pm each have the following change:
    Created &html_header to return appropriate HTML for the spreadsheet.

No longer save the results of computation of temporary spreadsheets.
Added Spreadsheet->temporary() to handle the getting and setting of the flag
which indicates a spreadsheet is temporary.  studentcalc.pm and assesscalc.pm
check this flag before saving their export rows.

Added 'blackout' support.  A blackout occurs when an assessment has a part
flagged with 'problemstatus' equal to 'no'.  This prevents the display of
the students performance on the part until the answerdate has passed.

Spreadsheet.pm contains &blackout, which returns the blackout status of
the current spreadsheet.

assesscalc.pm contains code which
    a) causes the computation of the spreadsheet to determine the
       blackout status
    b) forces the recomputation of the spreadsheet if the user is a student.
  Obviously (b) is less than ideal and a new approach should be found.

studentcalc.pm's outsheet_html subroutine now supresses the display of the
export (aka 'summary') row, as well as the rows of any assessments which
are under blackout.

$spreadsheet->othersheets() returns ('Default') if it is unable to find any
other spreadsheets.

Nearly complete reworking of spreadsheet.

lonspreadsheet.pm holds a few utility functions and the handler, which
creates a spreadsheet and tells it to display itself.

Spreadsheet.pm is the base definition of the spreadsheet object.
classcalc.pm, studentcalc.pm, and assesscalc.pm are implementations of the
spreadsheets.

There are missing pieces - excel and csv output, limiting by section
permissions, the ability to add extra 'header' rows to the student and
course level sheets, and students are still allowed to view the assessment
level sheets (will disable this soon).

Computing and editing of the spreadsheet have been tested and have been
given a preliminary seal of approval.