CVS log for loncom/interface/lonsupportreq.pm

Up to [LON-CAPA] / loncom / interface

Request diff between arbitrary revisions

Keyword substitution: kv
Default branch: MAIN

- For 2.11
  Backport 1.106

- Default action for delivery of email from helpdesk form on misconfigured
  LON-CAPA node has been changed.

- For 2.11
  Backport 1.105

- If no code titles have been set for institutional course codes, but
  "Ask Helpdesk" is used in course context for an "official" course,
  populate the coursecode textbox with the value for the current course.

- For 2.11
  Backport 1.104

- Bug 6955
  Cc field omitted from "Ask helpdesk" form for authenticated users subject
  to IP-based communication blocking, when "Messaging" selected for blocking.

- For 2.11
  Backport 1.103

- Fix typo in rev. 1.94.

- For 2.11
  Backport 1.101, 1.102

- Typo.

- Retrieval of requestor's IP address centralized in lonnet::get_requestor_ip()
- Domain configuration to allow domain's LON-CAPA nodes to operate behind a
  WAF/Reverse Proxy using aliased hostname (CNAME).
- Web requests from other nodes bypass the WAF as their requests are made
  directly to the server hostname (A record); same for internal LON-CAPA
  connections for lonc -> lond.

- Provide 'Reply To' address set in lonmsg.pm when calling mime_email() in
  loncommon.pm
- Update documentation for mime_email().

- For 2.11
  Backport 1.93, 1.94 (part)

- For 2.11
  Backport 1.80 (part), 1.97, 1.98, 1.99

- Need for javascript files depends on session status.

- Prepend LC_ to id of hidden form element used in client-side checking for
  uploaded file size, for purposes of namespacing.

- Prepend LC_ to class name in client-side checking for uploaded file size,
  for purposes of namespacing.

- For 2.11
  Backport 1.91

- For 2.11
  Backport 1.94 (part), 1.96

- Self-cataloging of courses based on institutional code is cached for 1 hour.

- Course, section and URL fields not included in "Ask helpdesk" form when
  LON-CAPA is LTI Provider. (LTI Consumer infoemation included instead).

- Remove protocol and hostname from origurl (where "Ask Helpdesk was called).
- Actually set $requname (used to determine institutional status).

- For 2.11.2 (modified).
  - Include changes in rev. 1.93.

- Domain configuration to override domain's helpdesk settings for e-mail
  recipients, and optionally added text, based on requester's affiliation
  (e.g., faculty, staff or student).

- Remove assignment to unused scalar (removed in rev. 1.90).

- Use 'secure' attribute for session cookie on servers using Apache/SSL.

- For 2.11
  - Backport 1.81 (part), 1.88, 1.87, 1.88, 1.89, 1.90

- Eliminate extra scalar.

- Remove trailing white space. No code changes.

- Show attachment size in MB.

- Maximum file size allowed for file uploaded to "Ask Helpdesk" form can
  be set as a domain configuration.  Default is 1 MB.

- For 2.11
  - Backport 1.83, 1.84, 1.85.

- Helpdesk web form
  - Domain configuration to specify which form fields besides E-mail address,
    Subject, and Description should be shown (some can be required fields).
  - Domain configuration to send submitted form to specified e-mail address(es)
    for user from other domains -- if no recipient set in user's domain for help).
  - Domain configuration to automatically include a specified string in the e-mail
    sent -- either prepended to the subject, or to the body.
  - If form is visited by a logged-in user with a role selected in an official
    course, the user can change the course code in the linked select boxes,
    in order to ask about a different course.

- Second arg in courseclassifier::javascript_code_selections() changed to ref
  to array.

- Remove whitespace.

- Remove unused item.

- For 2.11
  - Backport 1.82

- Support version 2 of Google reCAPTCHA.

New function to send email (with an attachment)

loncommon.pm contains &mime_email() to build and send emails using MIME::Lite.  The
functionality is based on the previous code in lonsupportreq.pm.  Now both
lonsupportreq.pm and lonmsg.pm call mime_email().

Files attached to LON-CAPA messages (normal or critical) will now be included in the
external email if the "Send copy to permanent e-mail address (if known)" option is
selected.  Attachments were previously only sent internally and stripped from the
external email.

This should resolve bug #6723.

File size checking for uploaded files

A new javascript file, file_upload.js, handles client side file size checking.
The function, checkUploadSize(), accepts an html file input element and a maximum
file size (in bytes) as input.  If the size of the file to be uploaded exceeds the
size allowed, a message is displayed the the element is cleared.  Server side
checking is still used if it passes this test.

Loading file_upload.js adds event handlers to file input elements with
class="flUpload".
    <input type="file" class="flUpload" />

It also looks for a hidden element with id="free_space" that contains the maximum
upload size.
    <input type="hidden" id="free_space" value="$free_space" />

The free space is usually calculated by subtracting a user's disk usage from their
quota allowance.  In some cases it is a fixed value.

I have implemented this for every upload instance I could find.  These include:
* Message attachments
* Authoring space
* Portfolio
* Course editor
* Essay response problems
* Helpdesk request forms
* RSS feed uploads

fixed bug 6782, and escaped most localized messages used in Javascript blocks to make sure bugs like that do not happen again

- Help students to easily find out which fields are required and which not.
    - Add marker to all required fields and display info text to explain.
  (corresponding to lonevaluate.pm 1.30)

- Warning style for warning message about too big attachment size

- Additional info about rev. 1.76:
Standard style for note to students

Temporary disable required message accidently introduced in rev. 1.76. Commit/Log entry was meant for lonevaluate.pm 1.30.
Required fields marker: Work still in progress.

Help students to easily find out which fields are required and which not.
- Add marker to all required fields and display info text to explain.
- Improve/consistent layout of feedback if not correctly filled in.

Improved and consistent navigation and layout by using actionbox and confirm_success

- Move &cleanup_html() from lonsupportreq.pm to loncommon.pm to facilitate
  reuse.
- Validation.

XHTML: action attribute in <form> tag required (dummy attribute added)

- For 2.10.
  - Backport 1.70, 1.71.

- Eliminate duplicate code.

- Additional entity conversions for CC field (authenticated users only)
  to proof against XSS

- Sanity checking.
- Additional entity conversions to proof against XSS.

- "Contact Helpdesk" form (as used by users who are not logged in), can require
   CAPTCHA validation.  Default is not to require CAPTCHA.

- Use custom log-in help page if defined for user's domain (or default domain
  if no user domain).

- xhtml.
- Use default enctype for form unless user has authenticated, in which case
  set to multipart/form-data, since ability to upload screenshot file is
  available for authenticated users.

- Customization for MITrelate
  - Remove unused item
  - Fix typo

- Customization for MITrelate.
  - Course information not required.

- Corrected closing tag for display of attachment filename
- Standard style/confirmwrapper for confirmation
- Enhanced code readability - reverse code order of confirmation: first standard case, then error case
- Optimized mt calls: don't concatenate; exclude styles from translation phrase
- Updated and added related phrases in de.pm

- Bug 5528.
  - Set header correctly for e-mail sent by "Ask Helpdesk" form.
    lonsupportreq.pm uses MIME::Lite from CPAN (as attachments may be inluded)    unlike lonmsg.pm and lonnotify.pm which use Mail::Send from CPAN.

- Institutional code compiled from selections in linked select boxes does
  not need regular expressions used in search of nohist_courseids.db when
  usd for helpdesk e-mail.

- Scope.

- Customization for GCI_3
  - Backport 1.62.

- Eliminate javascript error on loading of help request form where all
  institutional codes are null.

- Customization for GCI_3.
  - Backport 1.60, 1.61.

- Eliminate duplicate declaration.

- Self-creation of account with e-mail address as username.
  - Link to helpdesk support form includes username and e-mail address in query
    string if new account is requested for an account which already exists.

- Backport 1.59.

- Help Link to support form for public pages, if support mail recipient defined.
  For: /adm/createaccount, /adm/coursecatalog, /adm/resetpw, and syllabus pages.

- Customization for GCI_3
  - Eliminating fields which are not needed in this context.

Bug #5528:
Explicitly send character encoding UTF-8 in outgoing e-mail to ensure correct character display in user's e-mail client:
- Notification e-mails
- Broadcast e-mails (DC)
- Helpdesk requests

Character encoding of special chars in e-mail subject still dysfunctional (as before)

- Bug 6333.
  Ensure that form element names for select boxes for institutional codes
  are always named Year, Semester, Department, Number, for consistency with
  names used in javascript to update select box items dynamically.

- Bug 5848.
  Assembly of institutional code from components conforms to order defined in
  localenroll::instcode_defaults().

- Backport 1.56

- User: public:public does not count as a logged in user.
- Domain Configuration can include one or Bcc recipients of helpdesk email.

- Padding (CSS style for fieldset legends not part of 2.9).

- Add <b></b> as CSS styling of fieldset legend is not part of 2.9.

Replaced special styles for helpdesk request pages by standard pick_box styles.
Actual difference was only a limited width which moved directly to lonsupportreq.pm.

- Better choice of default domain for multi-domain servers.
- Use HTML entities in user input echoed on request confirmation page.

Replaced hardcoded styles for fieldset legends by CSS:
- legends are nearly always wanted to be in bold:
  Added style and removed now unnecessary <b> tags
- Padding wanted for legend texts:
  Added style and removed now unnecessary &nbsp;

consistent wording of e-mail, message, metadata

Localization:
- Get rid of \' inside mt arguments (avoid delimiter rebuild issues in synch.pl)
- Other related mt call optimizations
- de.pm: some other wording improvments

- Alternation of css styles uses two-element @css.
- Cc field only available to logged-in users.

- Move help.png help icon from /res into /adm/help so it is available for users are not logged into LON-CAPA on servers where lonhttpd points at port 80.
- Revert to use of calls to lonhttpd in in those cases where they had been eliminated in the switch of help icon to the current (tango) icon (3/24/2008).

New Tango help icon - the old one looked way too much like the "broken image" symbol in many browsers.

Localization:
- Added missing &mt()
- Optimized some &mt() calls

Bugs 3047, 5570.  Ccs can be specified in the help request form which sends e-mail to he helpdesk.

- Make loncommon::build_recipient_list() more generally applicable.
- Eliminate duplicate addresses in recipient list
- Use loncommon::build_recipient_list() to provide recipient email list for
  help support form and package update alerts.

- css replacement for existing data tabling (nested tables).
- use lonhtml::pick_box()
- remove variables no longer used ($tablecolor, $fontcolor, $vlinkcolor etc.)
- use HTML::Entities::encode() to encode form input
- style (remove unless, change delimiters in regexps etc.)
- change message to students
- do not display blank fields when echoing data submitted on receipt page
- use LC_nobreak span for link items in help link in "Contact Helpdesk" page linked from log-in page.
- a few wording changes

Making javascript used to validate e-mail addresses more widely available.

- need to initalize the language handle

Lost a $ somehow.

bug 3825 subject and description required in support requests

internationalization

style: eliminate $_, sort(), keys()

- more re fix ups

Moving routines used by lonsupportreq.pm, lonnotify.pm and coursecatalog.pm to courseclassifier.pm

Eliminate $_.  In this case the change also corrects the behavior of sort_cats() -- now limits selectable semesters to those for which courses actually exist for the specified year.

Include 'Course' as type filter when retrieving course IDs and course codes for population of connected Year, Semester, Department and Number select boxes.

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

- moving get_posted_cgi from loncommon to lonacc

- change add_entries to pass the hash

-start_page
-eliminate calls to bodytag in favor of start_page
- elimintate call to xmlbegin

 - some start_page work

- converting some interface pages to stop generating </body> <head> </head> </html> and use the helper functions instead

Make code used to construct connected Year-Semester-Department-Course select boxes usable by other forms (e.g., by lonnotify.pm), by passing in $formname as parameter.

Bug 3912.  DCs can use courseID (e.g., 257472759ae4061msul1) as a filter when using pickcourse.

Record lonID if user's cookie contains one.

Fix ups following %ENV -> %env switch, so that items that are really in %ENV are still recorded.

- ENV -> env

- adding missing GPL headers

- <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

Reset initial coursecode item if page is reloaded. Use short code for any code items where long code is missing.  If institutional sections exist, default to 'Select' in select box.

Only display 'Getting started guide' link if a file exists at /home/httpd/html/adm/gettingstarted.html.  Also allow 'Back to last location' to point to a different server -- allows linking from an institution's custom LON-CAP help page (e.g., loncapa.msu.edu or help.loncapa.org).

More generic.  Will now support short codes and long codes for all items, e.g. year could be 04 short, 2004 long; semester fs short, Fall long, department phy short, physics long. Short used as option value in select boxes, long as text displayed for each option.  Short and long codes and item titles all determined by call to &localenroll:instcode_format() on domain's library server (via lonnet:auto_instcode_format().

Retrieve domain information from query string (if one was passed in from 'Contact Helpdesk' link on log-in page). Actually store course information from select boxes and include in message sent to SupportEmail address.  Make more generic and less MSU specific.

xhtml compliance.

Remove surplus <br /> tag.

Fix bug #3489.

Clean-up of html and javascript. Set domain to show default domain if called from log-in screen.

Add some links and preamble to display of support request form, when helpdesk is called from log-in page. Change default color.

More comprehensive checking of valid e-mail address if browser supports javascript regex.

Get posted form params for case where lonsupportreq.pm is called from link on log-in page, i.e., without use of lonacc.

Adding storage of course owner to nohist_courseids.db.  Pick course can permits use of institutional code and/or username of course owner as filters.

- missed } in last backport

Add select boxes for choice of institutional code, when 'Ask Helpdesk' form is called when the use has not selected a role (e.g., from the log-in page, prior to log-in).

 bacport 1.9

Bug #3454.

- don't overwrite $to's value until after we have generated the error message that uses $to's value

Remove debugging print to STDERR calls.
Work-in-progress on implementing javascript-driven mutually-dependent select boxes to offer choice of year, semester, department, course number, and section.

Discussion postings associated with resources and bulletin boards now searchable.

Help support form allows user to include an uploaded file. Two perl modules required:
MIME::Types (used to determine mime-type of uploaded file) and MIME::Lite used to include file attachment in e-mail message sent to support e-mail address.

- stupid %ENV problem again

- use .gif

- don=t uset $r->content_type or locale won't work

Integration of help icons in breadcrumb trail into a single icon. Click on icon to open new window with gateway to help options within frameset (or within main window if pop-ups blocked).  Help options include inline topic help, support request form, FAQ-o-matic, and bug reporting (all contextualized).  Option to collect form parameter information from page displaying help icon currently disabled.

Some work required:
lonsupportreq.pm - replace call to Mail::Send with more sophisticated CPAN module (e.g., Mail::Sender that allows specification of from: address and attachments.