version 1.403, 2007/10/18 21:08:08
|
version 1.423.4.1, 2009/09/23 14:28:33
|
Line 27
|
Line 27
|
# |
# |
### |
### |
|
|
|
=pod |
|
|
|
=head1 NAME |
|
|
|
Apache::lonnavmaps - Subroutines to handle and render the navigation |
|
|
|
=head1 SYNOPSIS |
|
|
|
Handles navigational maps. |
|
|
|
The main handler generates the navigational listing for the course, |
|
the other objects export this information in a usable fashion for |
|
other modules. |
|
|
|
|
|
This is part of the LearningOnline Network with CAPA project |
|
described at http://www.lon-capa.org. |
|
|
|
|
|
=head1 OVERVIEW |
|
|
|
X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the |
|
course structure and caches it in what is often referred to as the |
|
"big hash" X<big hash>. You can see it if you are logged into |
|
LON-CAPA, in a course, by going to /adm/test. (You may need to |
|
tweak the /home/httpd/lonTabs/htpasswd file to view it.) The |
|
content of the hash will be under the heading "Big Hash". |
|
|
|
Big Hash contains, among other things, how resources are related |
|
to each other (next/previous), what resources are maps, which |
|
resources are being chosen to not show to the student (for random |
|
selection), and a lot of other things that can take a lot of time |
|
to compute due to the amount of data that needs to be collected and |
|
processed. |
|
|
|
Apache::lonnavmaps provides an object model for manipulating this |
|
information in a higher-level fashion than directly manipulating |
|
the hash. It also provides access to several auxilary functions |
|
that aren't necessarily stored in the Big Hash, but are a per- |
|
resource sort of value, like whether there is any feedback on |
|
a given resource. |
|
|
|
Apache::lonnavmaps also abstracts away branching, and someday, |
|
conditions, for the times where you don't really care about those |
|
things. |
|
|
|
Apache::lonnavmaps also provides fairly powerful routines for |
|
rendering navmaps, and last but not least, provides the navmaps |
|
view for when the user clicks the NAV button. |
|
|
|
B<Note>: Apache::lonnavmaps I<only> works for the "currently |
|
logged in user"; if you want things like "due dates for another |
|
student" lonnavmaps can not directly retrieve information like |
|
that. You need the EXT function. This module can still help, |
|
because many things, such as the course structure, are constant |
|
between users, and Apache::lonnavmaps can help by providing |
|
symbs for the EXT call. |
|
|
|
The rest of this file will cover the provided rendering routines, |
|
which can often be used without fiddling with the navmap object at |
|
all, then documents the Apache::lonnavmaps::navmap object, which |
|
is the key to accessing the Big Hash information, covers the use |
|
of the Iterator (which provides the logic for traversing the |
|
somewhat-complicated Big Hash data structure), documents the |
|
Apache::lonnavmaps::Resource objects that are returned by |
|
|
|
=head1 Subroutine: render |
|
|
|
The navmap renderer package provides a sophisticated rendering of the |
|
standard navigation maps interface into HTML. The provided nav map |
|
handler is actually just a glorified call to this. |
|
|
|
Because of the large number of parameters this function accepts, |
|
instead of passing it arguments as is normal, pass it in an anonymous |
|
hash with the desired options. |
|
|
|
The package provides a function called 'render', called as |
|
Apache::lonnavmaps::render({}). |
|
|
|
=head2 Overview of Columns |
|
|
|
The renderer will build an HTML table for the navmap and return |
|
it. The table consists of several columns, and a row for each |
|
resource (or possibly each part). You tell the renderer how many |
|
columns to create and what to place in each column, optionally using |
|
one or more of the prepared columns, and the renderer will assemble |
|
the table. |
|
|
|
Any additional generally useful column types should be placed in the |
|
renderer code here, so anybody can use it anywhere else. Any code |
|
specific to the current application (such as the addition of <input> |
|
elements in a column) should be placed in the code of the thing using |
|
the renderer. |
|
|
|
At the core of the renderer is the array reference COLS (see Example |
|
section below for how to pass this correctly). The COLS array will |
|
consist of entries of one of two types of things: Either an integer |
|
representing one of the pre-packaged column types, or a sub reference |
|
that takes a resource reference, a part number, and a reference to the |
|
argument hash passed to the renderer, and returns a string that will |
|
be inserted into the HTML representation as it. |
|
|
|
All other parameters are ways of either changing how the columns |
|
are printing, or which rows are shown. |
|
|
|
The pre-packaged column names are refered to by constants in the |
|
Apache::lonnavmaps namespace. The following currently exist: |
|
|
|
=over 4 |
|
|
|
=item * B<Apache::lonnavmaps::resource>: |
|
|
|
The general info about the resource: Link, icon for the type, etc. The |
|
first column in the standard nav map display. This column provides the |
|
indentation effect seen in the B<NAV> screen. This column also accepts |
|
the following parameters in the renderer hash: |
|
|
|
=over 4 |
|
|
|
=item * B<resource_nolink>: default false |
|
|
|
If true, the resource will not be linked. By default, all non-folder |
|
resources are linked. |
|
|
|
=item * B<resource_part_count>: default true |
|
|
|
If true, the resource will show a part count B<if> the full |
|
part list is not displayed. (See "condense_parts" later.) If false, |
|
the resource will never show a part count. |
|
|
|
=item * B<resource_no_folder_link>: |
|
|
|
If true, the resource's folder will not be clickable to open or close |
|
it. Default is false. True implies printCloseAll is false, since you |
|
can't close or open folders when this is on anyhow. |
|
|
|
=back |
|
|
|
=item * B<Apache::lonnavmaps::communication_status>: |
|
|
|
Whether there is discussion on the resource, email for the user, or |
|
(lumped in here) perl errors in the execution of the problem. This is |
|
the second column in the main nav map. |
|
|
|
=item * B<Apache::lonnavmaps::quick_status>: |
|
|
|
An icon for the status of a problem, with five possible states: |
|
Correct, incorrect, open, awaiting grading (for a problem where the |
|
computer's grade is suppressed, or the computer can't grade, like |
|
essay problem), or none (not open yet, not a problem). The |
|
third column of the standard navmap. |
|
|
|
=item * B<Apache::lonnavmaps::long_status>: |
|
|
|
A text readout of the details of the current status of the problem, |
|
such as "Due in 22 hours". The fourth column of the standard navmap. |
|
|
|
=item * B<Apache::lonnavmaps::part_status_summary>: |
|
|
|
A text readout summarizing the status of the problem. If it is a |
|
single part problem, will display "Correct", "Incorrect", |
|
"Not yet open", "Open", "Attempted", or "Error". If there are |
|
multiple parts, this will output a string that in HTML will show a |
|
status of how many parts are in each status, in color coding, trying |
|
to match the colors of the icons within reason. |
|
|
|
Note this only makes sense if you are I<not> showing parts. If |
|
C<showParts> is true (see below), this column will not output |
|
anything. |
|
|
|
=back |
|
|
|
If you add any others please be sure to document them here. |
|
|
|
An example of a column renderer that will show the ID number of a |
|
resource, along with the part name if any: |
|
|
|
sub { |
|
my ($resource, $part, $params) = @_; |
|
if ($part) { return '<td>' . $resource->{ID} . ' ' . $part . '</td>'; } |
|
return '<td>' . $resource->{ID} . '</td>'; |
|
} |
|
|
|
Note these functions are responsible for the TD tags, which allow them |
|
to override vertical and horizontal alignment, etc. |
|
|
|
=head2 Parameters |
|
|
|
Minimally, you should be |
|
able to get away with just using 'cols' (to specify the columns |
|
shown), 'url' (necessary for the folders to link to the current screen |
|
correctly), and possibly 'queryString' if your app calls for it. In |
|
that case, maintaining the state of the folders will be done |
|
automatically. |
|
|
|
=over 4 |
|
|
|
=item * B<iterator>: default: constructs one from %env |
|
|
|
A reference to a fresh ::iterator to use from the navmaps. The |
|
rendering will reflect the options passed to the iterator, so you can |
|
use that to just render a certain part of the course, if you like. If |
|
one is not passed, the renderer will attempt to construct one from |
|
env{'form.filter'} and env{'form.condition'} information, plus the |
|
'iterator_map' parameter if any. |
|
|
|
=item * B<iterator_map>: default: not used |
|
|
|
If you are letting the renderer do the iterator handling, you can |
|
instruct the renderer to render only a particular map by passing it |
|
the source of the map you want to process, like |
|
'/res/103/jerf/navmap.course.sequence'. |
|
|
|
=item * B<include_top_level_map>: default: false |
|
|
|
If you need to include the top level map (meaning the course) in the |
|
rendered output set this to true |
|
|
|
=item * B<navmap>: default: constructs one from %env |
|
|
|
A reference to a navmap, used only if an iterator is not passed in. If |
|
this is necessary to make an iterator but it is not passed in, a new |
|
one will be constructed based on env info. This is useful to do basic |
|
error checking before passing it off to render. |
|
|
|
=item * B<r>: default: must be passed in |
|
|
|
The standard Apache response object. This must be passed to the |
|
renderer or the course hash will be locked. |
|
|
|
=item * B<cols>: default: empty (useless) |
|
|
|
An array reference |
|
|
|
=item * B<showParts>:default true |
|
|
|
A flag. If true, a line for the resource itself, and a line |
|
for each part will be displayed. If not, only one line for each |
|
resource will be displayed. |
|
|
|
=item * B<condenseParts>: default true |
|
|
|
A flag. If true, if all parts of the problem have the same |
|
status and that status is Nothing Set, Correct, or Network Failure, |
|
then only one line will be displayed for that resource anyhow. If no, |
|
all parts will always be displayed. If showParts is 0, this is |
|
ignored. |
|
|
|
=item * B<jumpCount>: default: determined from %env |
|
|
|
A string identifying the URL to place the anchor 'curloc' at. |
|
It is the responsibility of the renderer user to |
|
ensure that the #curloc is in the URL. By default, determined through |
|
the use of the env{} 'jump' information, and should normally "just |
|
work" correctly. |
|
|
|
=item * B<here>: default: empty string |
|
|
|
A Symb identifying where to place the 'here' marker. The empty |
|
string means no marker. |
|
|
|
=item * B<indentString>: default: 25 pixel whitespace image |
|
|
|
A string identifying the indentation string to use. |
|
|
|
=item * B<queryString>: default: empty |
|
|
|
A string which will be prepended to the query string used when the |
|
folders are opened or closed. You can use this to pass |
|
application-specific values. |
|
|
|
=item * B<url>: default: none |
|
|
|
The url the folders will link to, which should be the current |
|
page. Required if the resource info column is shown, and you |
|
are allowing the user to open and close folders. |
|
|
|
=item * B<currentJumpIndex>: default: no jumping |
|
|
|
Describes the currently-open row number to cause the browser to jump |
|
to, because the user just opened that folder. By default, pulled from |
|
the Jump information in the env{'form.*'}. |
|
|
|
=item * B<printKey>: default: false |
|
|
|
If true, print the key that appears on the top of the standard |
|
navmaps. |
|
|
|
=item * B<printCloseAll>: default: true |
|
|
|
If true, print the "Close all folders" or "open all folders" |
|
links. |
|
|
|
=item * B<filterFunc>: default: sub {return 1;} (accept everything) |
|
|
|
A function that takes the resource object as its only parameter and |
|
returns a true or false value. If true, the resource is displayed. If |
|
false, it is simply skipped in the display. |
|
|
|
=item * B<suppressEmptySequences>: default: false |
|
|
|
If you're using a filter function, and displaying sequences to orient |
|
the user, then frequently some sequences will be empty. Setting this to |
|
true will cause those sequences not to display, so as not to confuse the |
|
user into thinking that if the sequence is there there should be things |
|
under it; for example, see the "Show Uncompleted Homework" view on the |
|
B<NAV> screen. |
|
|
|
=item * B<suppressNavmaps>: default: false |
|
|
|
If true, will not display Navigate Content resources. |
|
|
|
=back |
|
|
|
=head2 Additional Info |
|
|
|
In addition to the parameters you can pass to the renderer, which will |
|
be passed through unchange to the column renderers, the renderer will |
|
generate the following information which your renderer may find |
|
useful: |
|
|
|
=over 4 |
|
|
|
=item * B<counter>: |
|
|
|
Contains the number of rows printed. Useful after calling the render |
|
function, as you can detect whether anything was printed at all. |
|
|
|
=item * B<isNewBranch>: |
|
|
|
Useful for renderers: If this resource is currently the first resource |
|
of a new branch, this will be true. The Resource column (leftmost in the |
|
navmaps screen) uses this to display the "new branch" icon |
|
|
|
=back |
|
|
|
=cut |
|
|
|
|
|
=head1 SUBROUTINES |
|
|
|
=over |
|
|
|
=item update() |
|
|
|
=item addToFilter() |
|
|
|
Convenience functions: Returns a string that adds or subtracts |
|
the second argument from the first hash, appropriate for the |
|
query string that determines which folders to recurse on |
|
|
|
=item removeFromFilter() |
|
|
|
=item getLinkForResource() |
|
|
|
Convenience function: Given a stack returned from getStack on the iterator, |
|
return the correct src() value. |
|
|
|
=item getDescription() |
|
|
|
Convenience function: This separates the logic of how to create |
|
the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned", |
|
etc.) into a separate function. It takes a resource object as the |
|
first parameter, and the part number of the resource as the second. |
|
It's basically a big switch statement on the status of the resource. |
|
|
|
=item dueInLessThan24Hours() |
|
|
|
Convenience function, so others can use it: Is the problem due in less than 24 hours, and still can be done? |
|
|
|
=item lastTry() |
|
|
|
Convenience function, so others can use it: Is there only one try remaining for the |
|
part, with more than one try to begin with, not due yet and still can be done? |
|
|
|
=item advancedUser() |
|
|
|
This puts a human-readable name on the env variable. |
|
|
|
=item timeToHumanString() |
|
|
|
timeToHumanString takes a time number and converts it to a |
|
human-readable representation, meant to be used in the following |
|
manner: |
|
|
|
=over 4 |
|
|
|
=item * print "Due $timestring" |
|
|
|
=item * print "Open $timestring" |
|
|
|
=item * print "Answer available $timestring" |
|
|
|
=back |
|
|
|
Very, very, very, VERY English-only... goodness help a localizer on |
|
this func... |
|
|
|
=item resource() |
|
|
|
returns 0 |
|
|
|
=item communication_status() |
|
|
|
returns 1 |
|
|
|
=item quick_status() |
|
|
|
returns 2 |
|
|
|
=item long_status() |
|
|
|
returns 3 |
|
|
|
=item part_status_summary() |
|
|
|
returns 4 |
|
|
|
=item render_resource() |
|
|
|
=item render_communication_status() |
|
|
|
=item render_quick_status() |
|
|
|
=item render_long_status() |
|
|
|
=item render_parts_summary_status() |
|
|
|
=item setDefault() |
|
|
|
=item cmp_title() |
|
|
|
=item render() |
|
|
|
=item add_linkitem() |
|
|
|
=item show_linkitems() |
|
|
|
=back |
|
|
|
=cut |
|
|
package Apache::lonnavmaps; |
package Apache::lonnavmaps; |
|
|
use strict; |
use strict; |
Line 88 my %colormap =
|
Line 530 my %colormap =
|
# is not yet done and due in less than 24 hours |
# is not yet done and due in less than 24 hours |
my $hurryUpColor = "#FF0000"; |
my $hurryUpColor = "#FF0000"; |
|
|
|
my $future_slots_checked = 0; |
|
my $future_slots = 0; |
|
|
sub close { |
sub close { |
if ($env{'environment.remotenavmap'} ne 'on') { return ''; } |
if ($env{'environment.remotenavmap'} ne 'on') { return ''; } |
return(<<ENDCLOSE); |
return(<<ENDCLOSE); |
Line 116 this.document.navform.submit();
|
Line 561 this.document.navform.submit();
|
ENDUPDATE |
ENDUPDATE |
} |
} |
|
|
# Convenience functions: Returns a string that adds or subtracts |
|
# the second argument from the first hash, appropriate for the |
|
# query string that determines which folders to recurse on |
|
sub addToFilter { |
sub addToFilter { |
my $hashIn = shift; |
my $hashIn = shift; |
my $addition = shift; |
my $addition = shift; |
Line 137 sub removeFromFilter {
|
Line 580 sub removeFromFilter {
|
return join(",", keys(%hash)); |
return join(",", keys(%hash)); |
} |
} |
|
|
# Convenience function: Given a stack returned from getStack on the iterator, |
|
# return the correct src() value. |
|
sub getLinkForResource { |
sub getLinkForResource { |
my $stack = shift; |
my $stack = shift; |
my $res; |
my $res; |
Line 176 sub getLinkForResource {
|
Line 617 sub getLinkForResource {
|
return; |
return; |
} |
} |
|
|
# Convenience function: This separates the logic of how to create |
|
# the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned", |
|
# etc.) into a separate function. It takes a resource object as the |
|
# first parameter, and the part number of the resource as the second. |
|
# It's basically a big switch statement on the status of the resource. |
|
|
|
sub getDescription { |
sub getDescription { |
my $res = shift; |
my $res = shift; |
my $part = shift; |
my $part = shift; |
my $status = $res->status($part); |
my $status = $res->status($part); |
|
|
|
my $open = $res->opendate($part); |
|
my $due = $res->duedate($part); |
|
my $answer = $res->answerdate($part); |
|
|
if ($status == $res->NETWORK_FAILURE) { |
if ($status == $res->NETWORK_FAILURE) { |
return &mt("Having technical difficulties; please check status later"); |
return &mt("Having technical difficulties; please check status later"); |
} |
} |
Line 194 sub getDescription {
|
Line 635 sub getDescription {
|
return &mt("Not currently assigned."); |
return &mt("Not currently assigned."); |
} |
} |
if ($status == $res->OPEN_LATER) { |
if ($status == $res->OPEN_LATER) { |
return "Open " . timeToHumanString($res->opendate($part),'start'); |
return &mt("Open ") .timeToHumanString($open,'start'); |
|
} |
|
if ($res->simpleStatus($part) == $res->OPEN) { |
|
unless (&Apache::lonnet::allowed('mgr',$env{'request.course.id'})) { |
|
my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part); |
|
if ($slot_status == $res->UNKNOWN) { |
|
return &mt('Reservation status unknown'); |
|
} elsif ($slot_status == $res->RESERVED) { |
|
return &mt('Reserved - ends [_1]', |
|
timeToHumanString($slot_time,'end')); |
|
} elsif ($slot_status == $res->RESERVED_LOCATION) { |
|
return &mt('Reserved - specific location(s) - ends [_1]', |
|
timeToHumanString($slot_time,'end')); |
|
} elsif ($slot_status == $res->RESERVED_LATER) { |
|
return &mt('Reserved - next open [_1]', |
|
timeToHumanString($slot_time,'start')); |
|
} elsif ($slot_status == $res->RESERVABLE) { |
|
return &mt('Reservable ending [_1]', |
|
timeToHumanString($slot_time,'end')); |
|
} elsif ($slot_status == $res->RESERVABLE_LATER) { |
|
return &mt('Reservable starting [_1]', |
|
timeToHumanString($slot_time,'start')); |
|
} elsif ($slot_status == $res->NOT_IN_A_SLOT) { |
|
return &mt('Reserve a time/place to work'); |
|
} elsif ($slot_status == $res->NOTRESERVABLE) { |
|
return &mt('Reservation not available'); |
|
} elsif ($slot_status == $res->WAITING_FOR_GRADE) { |
|
return &mt('Submission in grading queue'); |
|
} |
|
} |
} |
} |
if ($status == $res->OPEN) { |
if ($status == $res->OPEN) { |
if ($res->duedate($part)) { |
if ($due) { |
if ($res->is_practice()) { |
if ($res->is_practice()) { |
return &mt("Closes ")." " .timeToHumanString($res->duedate($part),'start'); |
return &mt("Closes ")." " .timeToHumanString($due,'start'); |
} else { |
} else { |
return &mt("Due")." " .timeToHumanString($res->duedate($part),'end'); |
return &mt("Due")." " .timeToHumanString($due,'end'); |
} |
} |
} else { |
} else { |
return &mt("Open, no due date"); |
return &mt("Open, no due date"); |
} |
} |
} |
} |
if ($status == $res->PAST_DUE_ANSWER_LATER) { |
if ($status == $res->PAST_DUE_ANSWER_LATER) { |
return &mt("Answer open")." " . timeToHumanString($res->answerdate($part),'start'); |
return &mt("Answer open")." " .timeToHumanString($answer,'start'); |
} |
} |
if ($status == $res->PAST_DUE_NO_ANSWER) { |
if ($status == $res->PAST_DUE_NO_ANSWER) { |
if ($res->is_practice()) { |
if ($res->is_practice()) { |
return &mt("Closed")." " . timeToHumanString($res->duedate($part),'start'); |
return &mt("Closed")." " . timeToHumanString($due,'start'); |
} else { |
} else { |
return &mt("Was due")." " . timeToHumanString($res->duedate($part),'end'); |
return &mt("Was due")." " . timeToHumanString($due,'end'); |
} |
} |
} |
} |
if (($status == $res->ANSWER_OPEN || $status == $res->PARTIALLY_CORRECT) |
if (($status == $res->ANSWER_OPEN || $status == $res->PARTIALLY_CORRECT) |
Line 232 sub getDescription {
|
Line 702 sub getDescription {
|
my $maxtries = $res->maxtries($part); |
my $maxtries = $res->maxtries($part); |
my $triesString = ""; |
my $triesString = ""; |
if ($tries && $maxtries) { |
if ($tries && $maxtries) { |
$triesString = "<font size=\"-1\"><i>($tries of $maxtries tries used)</i></font>"; |
$triesString = '<font size="-1"><i>('.&mt('[_1] of [quant,_2,try,tries] used',$tries,$maxtries).')</i></font>'; |
if ($maxtries > 1 && $maxtries - $tries == 1) { |
if ($maxtries > 1 && $maxtries - $tries == 1) { |
$triesString = "<b>$triesString</b>"; |
$triesString = "<b>$triesString</b>"; |
} |
} |
} |
} |
if ($res->duedate($part)) { |
if ($due) { |
return &mt("Due")." " . timeToHumanString($res->duedate($part),'end') . |
return &mt("Due")." " . timeToHumanString($due,'end') . |
" $triesString"; |
" $triesString"; |
} else { |
} else { |
return &mt("No due date")." $triesString"; |
return &mt("No due date")." $triesString"; |
Line 249 sub getDescription {
|
Line 719 sub getDescription {
|
} |
} |
} |
} |
|
|
# Convenience function, so others can use it: Is the problem due in less than |
|
# 24 hours, and still can be done? |
|
|
|
sub dueInLessThan24Hours { |
sub dueInLessThan24Hours { |
my $res = shift; |
my $res = shift; |
Line 263 sub dueInLessThan24Hours {
|
Line 731 sub dueInLessThan24Hours {
|
$res->duedate($part) > time(); |
$res->duedate($part) > time(); |
} |
} |
|
|
# Convenience function, so others can use it: Is there only one try remaining for the |
|
# part, with more than one try to begin with, not due yet and still can be done? |
|
sub lastTry { |
sub lastTry { |
my $res = shift; |
my $res = shift; |
my $part = shift; |
my $part = shift; |
Line 276 sub lastTry {
|
Line 743 sub lastTry {
|
$res->duedate($part) > time(); |
$res->duedate($part) > time(); |
} |
} |
|
|
# This puts a human-readable name on the env variable. |
|
|
|
sub advancedUser { |
sub advancedUser { |
return $env{'request.role.adv'}; |
return $env{'request.role.adv'}; |
} |
} |
|
|
|
|
# timeToHumanString takes a time number and converts it to a |
|
# human-readable representation, meant to be used in the following |
|
# manner: |
|
# print "Due $timestring" |
|
# print "Open $timestring" |
|
# print "Answer available $timestring" |
|
# Very, very, very, VERY English-only... goodness help a localizer on |
|
# this func... |
|
|
|
|
|
sub timeToHumanString { |
sub timeToHumanString { |
my ($time,$type,$format) = @_; |
my ($time,$type,$format) = @_; |
|
|
Line 411 sub timeToHumanString {
|
Line 866 sub timeToHumanString {
|
} |
} |
|
|
|
|
=pod |
|
|
|
=head1 NAME |
|
|
|
Apache::lonnavmap - Subroutines to handle and render the navigation |
|
maps |
|
|
|
=head1 SYNOPSIS |
|
|
|
The main handler generates the navigational listing for the course, |
|
the other objects export this information in a usable fashion for |
|
other modules. |
|
|
|
=head1 OVERVIEW |
|
|
|
X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the |
|
course structure and caches it in what is often referred to as the |
|
"big hash" X<big hash>. You can see it if you are logged into |
|
LON-CAPA, in a course, by going to /adm/test. (You may need to |
|
tweak the /home/httpd/lonTabs/htpasswd file to view it.) The |
|
content of the hash will be under the heading "Big Hash". |
|
|
|
Big Hash contains, among other things, how resources are related |
|
to each other (next/previous), what resources are maps, which |
|
resources are being chosen to not show to the student (for random |
|
selection), and a lot of other things that can take a lot of time |
|
to compute due to the amount of data that needs to be collected and |
|
processed. |
|
|
|
Apache::lonnavmaps provides an object model for manipulating this |
|
information in a higher-level fashion than directly manipulating |
|
the hash. It also provides access to several auxilary functions |
|
that aren't necessarily stored in the Big Hash, but are a per- |
|
resource sort of value, like whether there is any feedback on |
|
a given resource. |
|
|
|
Apache::lonnavmaps also abstracts away branching, and someday, |
|
conditions, for the times where you don't really care about those |
|
things. |
|
|
|
Apache::lonnavmaps also provides fairly powerful routines for |
|
rendering navmaps, and last but not least, provides the navmaps |
|
view for when the user clicks the NAV button. |
|
|
|
B<Note>: Apache::lonnavmaps I<only> works for the "currently |
|
logged in user"; if you want things like "due dates for another |
|
student" lonnavmaps can not directly retrieve information like |
|
that. You need the EXT function. This module can still help, |
|
because many things, such as the course structure, are constant |
|
between users, and Apache::lonnavmaps can help by providing |
|
symbs for the EXT call. |
|
|
|
The rest of this file will cover the provided rendering routines, |
|
which can often be used without fiddling with the navmap object at |
|
all, then documents the Apache::lonnavmaps::navmap object, which |
|
is the key to accessing the Big Hash information, covers the use |
|
of the Iterator (which provides the logic for traversing the |
|
somewhat-complicated Big Hash data structure), documents the |
|
Apache::lonnavmaps::Resource objects that are returned by |
|
|
|
=head1 Subroutine: render |
|
|
|
The navmap renderer package provides a sophisticated rendering of the |
|
standard navigation maps interface into HTML. The provided nav map |
|
handler is actually just a glorified call to this. |
|
|
|
Because of the large number of parameters this function accepts, |
|
instead of passing it arguments as is normal, pass it in an anonymous |
|
hash with the desired options. |
|
|
|
The package provides a function called 'render', called as |
|
Apache::lonnavmaps::render({}). |
|
|
|
=head2 Overview of Columns |
|
|
|
The renderer will build an HTML table for the navmap and return |
|
it. The table consists of several columns, and a row for each |
|
resource (or possibly each part). You tell the renderer how many |
|
columns to create and what to place in each column, optionally using |
|
one or more of the prepared columns, and the renderer will assemble |
|
the table. |
|
|
|
Any additional generally useful column types should be placed in the |
|
renderer code here, so anybody can use it anywhere else. Any code |
|
specific to the current application (such as the addition of <input> |
|
elements in a column) should be placed in the code of the thing using |
|
the renderer. |
|
|
|
At the core of the renderer is the array reference COLS (see Example |
|
section below for how to pass this correctly). The COLS array will |
|
consist of entries of one of two types of things: Either an integer |
|
representing one of the pre-packaged column types, or a sub reference |
|
that takes a resource reference, a part number, and a reference to the |
|
argument hash passed to the renderer, and returns a string that will |
|
be inserted into the HTML representation as it. |
|
|
|
All other parameters are ways of either changing how the columns |
|
are printing, or which rows are shown. |
|
|
|
The pre-packaged column names are refered to by constants in the |
|
Apache::lonnavmaps namespace. The following currently exist: |
|
|
|
=over 4 |
|
|
|
=item * B<Apache::lonnavmaps::resource>: |
|
|
|
The general info about the resource: Link, icon for the type, etc. The |
|
first column in the standard nav map display. This column provides the |
|
indentation effect seen in the B<NAV> screen. This column also accepts |
|
the following parameters in the renderer hash: |
|
|
|
=over 4 |
|
|
|
=item * B<resource_nolink>: default false |
|
|
|
If true, the resource will not be linked. By default, all non-folder |
|
resources are linked. |
|
|
|
=item * B<resource_part_count>: default true |
|
|
|
If true, the resource will show a part count B<if> the full |
|
part list is not displayed. (See "condense_parts" later.) If false, |
|
the resource will never show a part count. |
|
|
|
=item * B<resource_no_folder_link>: |
|
|
|
If true, the resource's folder will not be clickable to open or close |
|
it. Default is false. True implies printCloseAll is false, since you |
|
can't close or open folders when this is on anyhow. |
|
|
|
=back |
|
|
|
=item * B<Apache::lonnavmaps::communication_status>: |
|
|
|
Whether there is discussion on the resource, email for the user, or |
|
(lumped in here) perl errors in the execution of the problem. This is |
|
the second column in the main nav map. |
|
|
|
=item * B<Apache::lonnavmaps::quick_status>: |
|
|
|
An icon for the status of a problem, with five possible states: |
|
Correct, incorrect, open, awaiting grading (for a problem where the |
|
computer's grade is suppressed, or the computer can't grade, like |
|
essay problem), or none (not open yet, not a problem). The |
|
third column of the standard navmap. |
|
|
|
=item * B<Apache::lonnavmaps::long_status>: |
|
|
|
A text readout of the details of the current status of the problem, |
|
such as "Due in 22 hours". The fourth column of the standard navmap. |
|
|
|
=item * B<Apache::lonnavmaps::part_status_summary>: |
|
|
|
A text readout summarizing the status of the problem. If it is a |
|
single part problem, will display "Correct", "Incorrect", |
|
"Not yet open", "Open", "Attempted", or "Error". If there are |
|
multiple parts, this will output a string that in HTML will show a |
|
status of how many parts are in each status, in color coding, trying |
|
to match the colors of the icons within reason. |
|
|
|
Note this only makes sense if you are I<not> showing parts. If |
|
C<showParts> is true (see below), this column will not output |
|
anything. |
|
|
|
=back |
|
|
|
If you add any others please be sure to document them here. |
|
|
|
An example of a column renderer that will show the ID number of a |
|
resource, along with the part name if any: |
|
|
|
sub { |
|
my ($resource, $part, $params) = @_; |
|
if ($part) { return '<td>' . $resource->{ID} . ' ' . $part . '</td>'; } |
|
return '<td>' . $resource->{ID} . '</td>'; |
|
} |
|
|
|
Note these functions are responsible for the TD tags, which allow them |
|
to override vertical and horizontal alignment, etc. |
|
|
|
=head2 Parameters |
|
|
|
Minimally, you should be |
|
able to get away with just using 'cols' (to specify the columns |
|
shown), 'url' (necessary for the folders to link to the current screen |
|
correctly), and possibly 'queryString' if your app calls for it. In |
|
that case, maintaining the state of the folders will be done |
|
automatically. |
|
|
|
=over 4 |
|
|
|
=item * B<iterator>: default: constructs one from %env |
|
|
|
A reference to a fresh ::iterator to use from the navmaps. The |
|
rendering will reflect the options passed to the iterator, so you can |
|
use that to just render a certain part of the course, if you like. If |
|
one is not passed, the renderer will attempt to construct one from |
|
env{'form.filter'} and env{'form.condition'} information, plus the |
|
'iterator_map' parameter if any. |
|
|
|
=item * B<iterator_map>: default: not used |
|
|
|
If you are letting the renderer do the iterator handling, you can |
|
instruct the renderer to render only a particular map by passing it |
|
the source of the map you want to process, like |
|
'/res/103/jerf/navmap.course.sequence'. |
|
|
|
=item * B<include_top_level_map>: default: false |
|
|
|
If you need to include the top level map (meaning the course) in the |
|
rendered output set this to true |
|
|
|
=item * B<navmap>: default: constructs one from %env |
|
|
|
A reference to a navmap, used only if an iterator is not passed in. If |
|
this is necessary to make an iterator but it is not passed in, a new |
|
one will be constructed based on env info. This is useful to do basic |
|
error checking before passing it off to render. |
|
|
|
=item * B<r>: default: must be passed in |
|
|
|
The standard Apache response object. This must be passed to the |
|
renderer or the course hash will be locked. |
|
|
|
=item * B<cols>: default: empty (useless) |
|
|
|
An array reference |
|
|
|
=item * B<showParts>:default true |
|
|
|
A flag. If true, a line for the resource itself, and a line |
|
for each part will be displayed. If not, only one line for each |
|
resource will be displayed. |
|
|
|
=item * B<condenseParts>: default true |
|
|
|
A flag. If true, if all parts of the problem have the same |
|
status and that status is Nothing Set, Correct, or Network Failure, |
|
then only one line will be displayed for that resource anyhow. If no, |
|
all parts will always be displayed. If showParts is 0, this is |
|
ignored. |
|
|
|
=item * B<jumpCount>: default: determined from %env |
|
|
|
A string identifying the URL to place the anchor 'curloc' at. |
|
It is the responsibility of the renderer user to |
|
ensure that the #curloc is in the URL. By default, determined through |
|
the use of the env{} 'jump' information, and should normally "just |
|
work" correctly. |
|
|
|
=item * B<here>: default: empty string |
|
|
|
A Symb identifying where to place the 'here' marker. The empty |
|
string means no marker. |
|
|
|
=item * B<indentString>: default: 25 pixel whitespace image |
|
|
|
A string identifying the indentation string to use. |
|
|
|
=item * B<queryString>: default: empty |
|
|
|
A string which will be prepended to the query string used when the |
|
folders are opened or closed. You can use this to pass |
|
application-specific values. |
|
|
|
=item * B<url>: default: none |
|
|
|
The url the folders will link to, which should be the current |
|
page. Required if the resource info column is shown, and you |
|
are allowing the user to open and close folders. |
|
|
|
=item * B<currentJumpIndex>: default: no jumping |
|
|
|
Describes the currently-open row number to cause the browser to jump |
|
to, because the user just opened that folder. By default, pulled from |
|
the Jump information in the env{'form.*'}. |
|
|
|
=item * B<printKey>: default: false |
|
|
|
If true, print the key that appears on the top of the standard |
|
navmaps. |
|
|
|
=item * B<printCloseAll>: default: true |
|
|
|
If true, print the "Close all folders" or "open all folders" |
|
links. |
|
|
|
=item * B<filterFunc>: default: sub {return 1;} (accept everything) |
|
|
|
A function that takes the resource object as its only parameter and |
|
returns a true or false value. If true, the resource is displayed. If |
|
false, it is simply skipped in the display. |
|
|
|
=item * B<suppressEmptySequences>: default: false |
|
|
|
If you're using a filter function, and displaying sequences to orient |
|
the user, then frequently some sequences will be empty. Setting this to |
|
true will cause those sequences not to display, so as not to confuse the |
|
user into thinking that if the sequence is there there should be things |
|
under it; for example, see the "Show Uncompleted Homework" view on the |
|
B<NAV> screen. |
|
|
|
=item * B<suppressNavmaps>: default: false |
|
|
|
If true, will not display Navigate Content resources. |
|
|
|
=back |
|
|
|
=head2 Additional Info |
|
|
|
In addition to the parameters you can pass to the renderer, which will |
|
be passed through unchange to the column renderers, the renderer will |
|
generate the following information which your renderer may find |
|
useful: |
|
|
|
=over 4 |
|
|
|
=item * B<counter>: |
|
|
|
Contains the number of rows printed. Useful after calling the render |
|
function, as you can detect whether anything was printed at all. |
|
|
|
=item * B<isNewBranch>: |
|
|
|
Useful for renderers: If this resource is currently the first resource |
|
of a new branch, this will be true. The Resource column (leftmost in the |
|
navmaps screen) uses this to display the "new branch" icon |
|
|
|
=back |
|
|
|
=cut |
|
|
|
sub resource { return 0; } |
sub resource { return 0; } |
sub communication_status { return 1; } |
sub communication_status { return 1; } |
sub quick_status { return 2; } |
sub quick_status { return 2; } |
Line 774 sub render_resource {
|
Line 897 sub render_resource {
|
my $location=&Apache::loncommon::lonhttpdurl("/adm/lonIcons"); |
my $location=&Apache::loncommon::lonhttpdurl("/adm/lonIcons"); |
# If this is a new branch, label it so |
# If this is a new branch, label it so |
if ($params->{'isNewBranch'}) { |
if ($params->{'isNewBranch'}) { |
$newBranchText = "<img src='$location/branch.gif' border='0' alt='Branch' />"; |
$newBranchText = '<img src="'.$location.'/branch.gif" border="0" alt="'. |
|
&mt('Branch').'" />'; |
} |
} |
|
|
# links to open and close the folder |
# links to open and close the folder |
Line 850 sub render_resource {
|
Line 974 sub render_resource {
|
if (!$resource->condval()) { |
if (!$resource->condval()) { |
$nonLinkedText .= ' <i>('.&mt('conditionally hidden').')</i> '; |
$nonLinkedText .= ' <i>('.&mt('conditionally hidden').')</i> '; |
} |
} |
|
if (($resource->is_practice()) && ($resource->is_raw_problem())) { |
|
$nonLinkedText .=' <font color="green"><b>'.&mt('not graded').'</b></font>'; |
|
} |
|
|
# We're done preparing and finally ready to start the rendering |
# We're done preparing and finally ready to start the rendering |
my $result = "<td align='left' valign='middle'>"; |
my $result = "<td align='left' valign='middle'>"; |
|
|
Line 872 sub render_resource {
|
Line 999 sub render_resource {
|
# Is this the current resource? |
# Is this the current resource? |
if (!$params->{'displayedHereMarker'} && |
if (!$params->{'displayedHereMarker'} && |
$resource->symb() eq $params->{'here'} ) { |
$resource->symb() eq $params->{'here'} ) { |
$curMarkerBegin = '<font color="red" size="+2">></font>'; |
$curMarkerBegin = '<span class="LC_fontcolor_red LC_fontsize_large">></span>'; |
$curMarkerEnd = '<font color="red" size="+2"><</font>'; |
$curMarkerEnd = '<span class="LC_fontcolor_red LC_fontsize_large"><</span>'; |
$params->{'displayedHereMarker'} = 1; |
$params->{'displayedHereMarker'} = 1; |
} |
} |
|
|
Line 926 sub render_communication_status {
|
Line 1053 sub render_communication_status {
|
if ($msgid) { |
if ($msgid) { |
$feedbackHTML .= ' <a '.$target.' href="/adm/email?display=' |
$feedbackHTML .= ' <a '.$target.' href="/adm/email?display=' |
. &escape($msgid) . '">' |
. &escape($msgid) . '">' |
. '<img alt="'.&mt('New Email').'" src="'.$location.'/feedback.gif" ' |
. '<img alt="'.&mt('New E-mail').'" src="'.$location.'/feedback.gif" ' |
. 'border="0" /></a>'; |
. 'border="0" /></a>'; |
} |
} |
} |
} |
Line 1175 sub render {
|
Line 1302 sub render {
|
if (!defined($navmap)) { |
if (!defined($navmap)) { |
$navmap = Apache::lonnavmaps::navmap->new(); |
$navmap = Apache::lonnavmaps::navmap->new(); |
if (!defined($navmap)) { |
if (!defined($navmap)) { |
# no londer in course |
# no longer in course |
return '<span class="LC_error">'.&mt('No course selected').'</span><br /> |
return '<span class="LC_error">'.&mt('No course selected').'</span><br /> |
<a href="/adm/roles">'.&mt('Select a course').'</a><br />'; |
<a href="/adm/roles">'.&mt('Select a course').'</a><br />'; |
} |
} |
Line 1243 sub render {
|
Line 1370 sub render {
|
# Step 1: Check to see if we have a navmap |
# Step 1: Check to see if we have a navmap |
if (!defined($navmap)) { |
if (!defined($navmap)) { |
$navmap = Apache::lonnavmaps::navmap->new(); |
$navmap = Apache::lonnavmaps::navmap->new(); |
|
if (!defined($navmap)) { |
|
# no longer in course |
|
return '<span class="LC_error">'.&mt('No course selected').'</span><br /> |
|
<a href="/adm/roles">'.&mt('Select a course').'</a><br />'; |
|
} |
} |
} |
|
|
# See if we're being passed a specific map |
# See if we're being passed a specific map |
Line 1295 sub render {
|
Line 1427 sub render {
|
my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc"); |
my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc"); |
if ($navmap->{LAST_CHECK}) { |
if ($navmap->{LAST_CHECK}) { |
$result .= |
$result .= |
'<img src="'.$location.'/chat.gif"> '.&mt('New discussion since').' '. |
'<img src="'.$location.'/chat.gif" alt="" /> '.&mt('New discussion since').' '. |
strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})). |
strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})). |
'</td><td align="center" valign="bottom"> '. |
'</td><td align="center" valign="bottom"> '. |
'<img src="'.$location.'/feedback.gif"> '.&mt('New message (click to open)').'<p>'. |
'<img src="'.$location.'/feedback.gif" alt="" /> '.&mt('New message (click to open)').'<p>'. |
'</td>'; |
'</td>'; |
} else { |
} else { |
$result .= '<td align="center" valign="bottom"> '. |
$result .= '<td align="center" valign="bottom"> '. |
'<img src="'.$location.'/chat.gif"> '.&mt('Discussions').'</td><td align="center" valign="bottom">'. |
'<img src="'.$location.'/chat.gif" alt="" /> '.&mt('Discussions').'</td><td align="center" valign="bottom">'. |
' <img src="'.$location.'/feedback.gif"> '.&mt('New message (click to open)'). |
' <img src="'.$location.'/feedback.gif" alt="" /> '.&mt('New message (click to open)'). |
'</td>'; |
'</td>'; |
} |
} |
|
|
Line 1734 ENDBLOCK
|
Line 1866 ENDBLOCK
|
$result.='} |
$result.='} |
</script> |
</script> |
<form name="linkitems" method="post"> |
<form name="linkitems" method="post"> |
<nobr><select name="toplink">'."\n"; |
<span class="LC_nobreak"><select name="toplink">'."\n"; |
foreach my $link (@linkorder) { |
foreach my $link (@linkorder) { |
if (defined($linkitems->{$link})) { |
if (defined($linkitems->{$link})) { |
if ($linkitems->{$link}{'text'} ne '') { |
if ($linkitems->{$link}{'text'} ne '') { |
Line 1745 ENDBLOCK
|
Line 1877 ENDBLOCK
|
} |
} |
$result .= '</select> <input type="button" name="chgnav" |
$result .= '</select> <input type="button" name="chgnav" |
value="Go" onClick="javascript:changeNavDisplay()" /> |
value="Go" onClick="javascript:changeNavDisplay()" /> |
</nobr></form></td>'."\n"; |
</span></form></td>'."\n"; |
|
|
return $result; |
return $result; |
} |
} |
|
|
1; |
1; |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
package Apache::lonnavmaps::navmap; |
package Apache::lonnavmaps::navmap; |
|
|
=pod |
=pod |
Line 2295 sub parmval {
|
Line 2435 sub parmval {
|
my $hashkey = $what."|||".$symb; |
my $hashkey = $what."|||".$symb; |
|
|
if (defined($self->{PARM_CACHE}->{$hashkey})) { |
if (defined($self->{PARM_CACHE}->{$hashkey})) { |
return $self->{PARM_CACHE}->{$hashkey}; |
if (ref($self->{PARM_CACHE}->{$hashkey}) eq 'ARRAY') { |
|
if (defined($self->{PARM_CACHE}->{$hashkey}->[0])) { |
|
if (wantarray) { |
|
return @{$self->{PARM_CACHE}->{$hashkey}}; |
|
} else { |
|
return $self->{PARM_CACHE}->{$hashkey}->[0]; |
|
} |
|
} |
|
} else { |
|
return $self->{PARM_CACHE}->{$hashkey}; |
|
} |
} |
} |
|
|
my $result = $self->parmval_real($what, $symb, $recurse); |
my $result = $self->parmval_real($what, $symb, $recurse); |
$self->{PARM_CACHE}->{$hashkey} = $result; |
$self->{PARM_CACHE}->{$hashkey} = $result; |
return $result; |
if (wantarray) { |
|
return @{$result}; |
|
} |
|
return $result->[0]; |
} |
} |
|
|
sub parmval_real { |
sub parmval_real { |
Line 2321 sub parmval_real {
|
Line 2473 sub parmval_real {
|
my $uname=$env{'user.name'}; |
my $uname=$env{'user.name'}; |
my $udom=$env{'user.domain'}; |
my $udom=$env{'user.domain'}; |
|
|
unless ($symb) { return ''; } |
unless ($symb) { return ['']; } |
my $result=''; |
my $result=''; |
|
|
my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb); |
my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb); |
Line 2353 sub parmval_real {
|
Line 2505 sub parmval_real {
|
|
|
# ---------------------------------------------------------- first, check user |
# ---------------------------------------------------------- first, check user |
if ($uname and defined($useropt)) { |
if ($uname and defined($useropt)) { |
if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; } |
if (defined($$useropt{$courselevelr})) { return [$$useropt{$courselevelr},'resource']; } |
if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; } |
if (defined($$useropt{$courselevelm})) { return [$$useropt{$courselevelm},'map']; } |
if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; } |
if (defined($$useropt{$courselevel})) { return [$$useropt{$courselevel},'course']; } |
} |
} |
|
|
# ------------------------------------------------------- second, check course |
# ------------------------------------------------------- second, check course |
if ($cgroup ne '' and defined($courseopt)) { |
if ($cgroup ne '' and defined($courseopt)) { |
if (defined($$courseopt{$grplevelr})) { return $$courseopt{$grplevelr}; } |
if (defined($$courseopt{$grplevelr})) { return [$$courseopt{$grplevelr},'resource']; } |
if (defined($$courseopt{$grplevelm})) { return $$courseopt{$grplevelm}; } |
if (defined($$courseopt{$grplevelm})) { return [$$courseopt{$grplevelm},'map']; } |
if (defined($$courseopt{$grplevel})) { return $$courseopt{$grplevel}; } |
if (defined($$courseopt{$grplevel})) { return [$$courseopt{$grplevel},'course']; } |
} |
} |
|
|
if ($csec and defined($courseopt)) { |
if ($csec and defined($courseopt)) { |
if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; } |
if (defined($$courseopt{$seclevelr})) { return [$$courseopt{$seclevelr},'resource']; } |
if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; } |
if (defined($$courseopt{$seclevelm})) { return [$$courseopt{$seclevelm},'map']; } |
if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; } |
if (defined($$courseopt{$seclevel})) { return [$$courseopt{$seclevel},'course']; } |
} |
} |
|
|
if (defined($courseopt)) { |
if (defined($courseopt)) { |
if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; } |
if (defined($$courseopt{$courselevelr})) { return [$$courseopt{$courselevelr},'resource']; } |
} |
} |
|
|
# ----------------------------------------------------- third, check map parms |
# ----------------------------------------------------- third, check map parms |
|
|
my $thisparm=$$parmhash{$symbparm}; |
my $thisparm=$$parmhash{$symbparm}; |
if (defined($thisparm)) { return $thisparm; } |
if (defined($thisparm)) { return [$thisparm,'map']; } |
|
|
# ----------------------------------------------------- fourth , check default |
# ----------------------------------------------------- fourth , check default |
|
|
my $meta_rwhat=$rwhat; |
my $meta_rwhat=$rwhat; |
$meta_rwhat=~s/\./_/g; |
$meta_rwhat=~s/\./_/g; |
my $default=&Apache::lonnet::metadata($fn,$meta_rwhat); |
my $default=&Apache::lonnet::metadata($fn,$meta_rwhat); |
if (defined($default)) { return $default} |
if (defined($default)) { return [$default,'resource']} |
$default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat); |
$default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat); |
if (defined($default)) { return $default} |
if (defined($default)) { return [$default,'resource']} |
|
|
# --------------------------------------------------- fifth, check more course |
# --------------------------------------------------- fifth, check more course |
if (defined($courseopt)) { |
if (defined($courseopt)) { |
if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; } |
if (defined($$courseopt{$courselevelm})) { return [$$courseopt{$courselevelm},'map']; } |
if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; } |
if (defined($$courseopt{$courselevel})) { |
|
my $ret = [$$courseopt{$courselevel},'course']; |
|
return $ret; |
|
} |
} |
} |
|
|
# --------------------------------------------------- sixth , cascade up parts |
# --------------------------------------------------- sixth , cascade up parts |
|
|
my ($space,@qualifier)=split(/\./,$rwhat); |
my ($space,@qualifier)=split(/\./,$rwhat); |
Line 2404 sub parmval_real {
|
Line 2557 sub parmval_real {
|
my $id=pop(@parts); |
my $id=pop(@parts); |
my $part=join('_',@parts); |
my $part=join('_',@parts); |
if ($part eq '') { $part='0'; } |
if ($part eq '') { $part='0'; } |
my $partgeneral=$self->parmval($part.".$qualifier",$symb,1); |
my @partgeneral=$self->parmval($part.".$qualifier",$symb,1); |
if (defined($partgeneral)) { return $partgeneral; } |
if (defined($partgeneral[0])) { return \@partgeneral; } |
} |
} |
if ($recurse) { return undef; } |
if ($recurse) { return []; } |
my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$rwhat); |
my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$rwhat); |
if (defined($pack_def)) { return $pack_def; } |
if (defined($pack_def)) { return [$pack_def,'resource']; } |
return ''; |
return ['']; |
} |
} |
|
|
=pod |
=pod |
Line 3428 sub kind { my $self=shift; return $self-
|
Line 3581 sub kind { my $self=shift; return $self-
|
sub randomout { my $self=shift; return $self->navHash("randomout_", 1); } |
sub randomout { my $self=shift; return $self->navHash("randomout_", 1); } |
sub randompick { |
sub randompick { |
my $self = shift; |
my $self = shift; |
return $self->parmval('randompick'); |
my $randompick = $self->parmval('randompick'); |
|
return $randompick; |
} |
} |
sub randomorder { |
sub randomorder { |
my $self = shift; |
my $self = shift; |
return ($self->parmval('randomorder') =~ /^yes$/i); |
my $randomorder = $self->parmval('randomorder'); |
|
return ($randomorder =~ /^yes$/i); |
} |
} |
sub link { |
sub link { |
my $self=shift; |
my $self=shift; |
Line 3553 sub retrieveResources {
|
Line 3708 sub retrieveResources {
|
|
|
sub is_exam { |
sub is_exam { |
my ($self,$part) = @_; |
my ($self,$part) = @_; |
if ($self->parmval('type',$part) eq 'exam') { |
my $type = $self->parmval('type',$part); |
|
if ($type eq 'exam') { |
return 1; |
return 1; |
} |
} |
if ($self->src() =~ /\.(exam)$/) { |
if ($self->src() =~ /\.(exam)$/) { |
Line 3576 sub is_page {
|
Line 3732 sub is_page {
|
sub is_practice { |
sub is_practice { |
my $self=shift; |
my $self=shift; |
my ($part) = @_; |
my ($part) = @_; |
if ($self->parmval('type',$part) eq 'practice') { |
my $type = $self->parmval('type',$part); |
|
if ($type eq 'practice') { |
return 1; |
return 1; |
} |
} |
return 0; |
return 0; |
Line 3589 sub is_problem {
|
Line 3746 sub is_problem {
|
} |
} |
return 0; |
return 0; |
} |
} |
|
sub is_raw_problem { |
|
my $self=shift; |
|
my $src = $self->src(); |
|
if ($src =~ /\.(problem|exam|quiz|assess|survey|form|library|task)$/) { |
|
return 1; |
|
} |
|
return 0; |
|
} |
|
|
sub contains_problem { |
sub contains_problem { |
my $self=shift; |
my $self=shift; |
if ($self->is_page()) { |
if ($self->is_page()) { |
Line 3614 sub is_sequence {
|
Line 3780 sub is_sequence {
|
sub is_survey { |
sub is_survey { |
my $self = shift(); |
my $self = shift(); |
my $part = shift(); |
my $part = shift(); |
if ($self->parmval('type',$part) eq 'survey') { |
my $type = $self->parmval('type',$part); |
|
if ($type eq 'survey') { |
return 1; |
return 1; |
} |
} |
if ($self->src() =~ /\.(survey)$/) { |
if ($self->src() =~ /\.(survey)$/) { |
Line 3790 Get the weight for the problem.
|
Line 3957 Get the weight for the problem.
|
|
|
sub acc { |
sub acc { |
(my $self, my $part) = @_; |
(my $self, my $part) = @_; |
return $self->parmval("acc", $part); |
my $acc = $self->parmval("acc", $part); |
|
return $acc; |
} |
} |
sub answerdate { |
sub answerdate { |
(my $self, my $part) = @_; |
(my $self, my $part) = @_; |
# Handle intervals |
# Handle intervals |
if ($self->parmval("answerdate.type", $part) eq 'date_interval') { |
my $answerdatetype = $self->parmval("answerdate.type", $part); |
return $self->duedate($part) + |
my $answerdate = $self->parmval("answerdate", $part); |
$self->parmval("answerdate", $part); |
my $duedate = $self->parmval("duedate", $part); |
|
if ($answerdatetype eq 'date_interval') { |
|
$answerdate = $duedate + $answerdate; |
} |
} |
return $self->parmval("answerdate", $part); |
return $answerdate; |
} |
} |
sub awarded { |
sub awarded { |
my $self = shift; my $part = shift; |
my $self = shift; my $part = shift; |
Line 3807 sub awarded {
|
Line 3977 sub awarded {
|
if (!defined($part)) { $part = '0'; } |
if (!defined($part)) { $part = '0'; } |
return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'}; |
return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'}; |
} |
} |
|
sub taskversion { |
|
my $self = shift; my $part = shift; |
|
$self->{NAV_MAP}->get_user_data(); |
|
if (!defined($part)) { $part = '0'; } |
|
return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.version'}; |
|
} |
|
sub taskstatus { |
|
my $self = shift; my $part = shift; |
|
$self->{NAV_MAP}->get_user_data(); |
|
if (!defined($part)) { $part = '0'; } |
|
return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$self->taskversion($part).'.'.$part.'.status'}; |
|
} |
|
sub solved { |
|
my $self = shift; my $part = shift; |
|
$self->{NAV_MAP}->get_user_data(); |
|
if (!defined($part)) { $part = '0'; } |
|
return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.solved'}; |
|
} |
|
sub checkedin { |
|
my $self = shift; my $part = shift; |
|
$self->{NAV_MAP}->get_user_data(); |
|
if (!defined($part)) { $part = '0'; } |
|
if ($self->is_task()) { |
|
my $version = $self->taskversion($part); |
|
return ($self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$version .'.'.$part.'.checkedin'},$self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$version .'.'.$part.'.checkedin.slot'}); |
|
} else { |
|
return ($self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.checkedin'},$self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.checkedin.slot'}); |
|
} |
|
} |
# this should work exactly like the copy in lonhomework.pm |
# this should work exactly like the copy in lonhomework.pm |
sub duedate { |
sub duedate { |
(my $self, my $part) = @_; |
(my $self, my $part) = @_; |
my $date; |
my $date; |
my $interval=$self->parmval("interval", $part); |
my @interval=$self->parmval("interval", $part); |
my $due_date=$self->parmval("duedate", $part); |
my $due_date=$self->parmval("duedate", $part); |
if ($interval =~ /\d+/) { |
if ($interval[0] =~ /\d+/) { |
my $first_access=&Apache::lonnet::get_first_access('map',$self->symb); |
my $first_access=&Apache::lonnet::get_first_access($interval[1], |
|
$self->symb); |
if (defined($first_access)) { |
if (defined($first_access)) { |
$interval = $first_access+$interval; |
my $interval = $first_access+$interval[0]; |
$date = ($interval < $due_date)? $interval : $due_date; |
$date = (!$due_date || $interval < $due_date) ? $interval |
|
: $due_date; |
} else { |
} else { |
$date = $due_date; |
$date = $due_date; |
} |
} |
Line 3831 sub handgrade {
|
Line 4032 sub handgrade {
|
my @response_ids = $self->responseIds($part); |
my @response_ids = $self->responseIds($part); |
if (@response_ids) { |
if (@response_ids) { |
foreach my $response_id (@response_ids) { |
foreach my $response_id (@response_ids) { |
if (lc($self->parmval("handgrade",$part.'_'.$response_id)) |
my $handgrade = $self->parmval("handgrade",$part.'_'.$response_id); |
eq 'yes') { |
if (lc($handgrade) eq 'yes') { |
return 'yes'; |
return 'yes'; |
} |
} |
} |
} |
} |
} |
return $self->parmval("handgrade", $part); |
my $handgrade = $self->parmval("handgrade", $part); |
|
return $handgrade; |
} |
} |
sub maxtries { |
sub maxtries { |
(my $self, my $part) = @_; |
(my $self, my $part) = @_; |
return $self->parmval("maxtries", $part); |
my $maxtries = $self->parmval("maxtries", $part); |
|
return $maxtries; |
} |
} |
sub opendate { |
sub opendate { |
(my $self, my $part) = @_; |
(my $self, my $part) = @_; |
if ($self->parmval("opendate.type", $part) eq 'date_interval') { |
my $opendatetype = $self->parmval("opendate.type", $part); |
return $self->duedate($part) - |
my $opendate = $self->parmval("opendate", $part); |
$self->parmval("opendate", $part); |
if ($opendatetype eq 'date_interval') { |
|
my $duedate = $self->duedate($part); |
|
$opendate = $duedate - $opendate; |
} |
} |
return $self->parmval("opendate"); |
return $opendate; |
} |
} |
sub problemstatus { |
sub problemstatus { |
(my $self, my $part) = @_; |
(my $self, my $part) = @_; |
return lc $self->parmval("problemstatus", $part); |
my $problemstatus = $self->parmval("problemstatus", $part); |
|
return lc($problemstatus); |
} |
} |
sub sig { |
sub sig { |
(my $self, my $part) = @_; |
(my $self, my $part) = @_; |
return $self->parmval("sig", $part); |
my $sig = $self->parmval("sig", $part); |
|
return $sig; |
} |
} |
sub tol { |
sub tol { |
(my $self, my $part) = @_; |
(my $self, my $part) = @_; |
return $self->parmval("tol", $part); |
my $tol = $self->parmval("tol", $part); |
|
return $tol; |
} |
} |
sub tries { |
sub tries { |
my $self = shift; |
my $self = shift; |
my $tries = $self->queryRestoreHash('tries', shift); |
my $tries = $self->queryRestoreHash('tries', shift); |
if (!defined($tries)) { return '0';} |
if (!defined($tries)) { return '0';} |
Line 3871 sub tries {
|
Line 4079 sub tries {
|
} |
} |
sub type { |
sub type { |
(my $self, my $part) = @_; |
(my $self, my $part) = @_; |
return $self->parmval("type", $part); |
my $type = $self->parmval("type", $part); |
|
return $type; |
} |
} |
sub weight { |
sub weight { |
my $self = shift; my $part = shift; |
my $self = shift; my $part = shift; |
if (!defined($part)) { $part = '0'; } |
if (!defined($part)) { $part = '0'; } |
return &Apache::lonnet::EXT('resource.'.$part.'.weight', |
my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight', |
$self->symb(), $env{'user.domain'}, |
$self->symb(), $env{'user.domain'}, |
$env{'user.name'}, |
$env{'user.name'}, |
$env{'request.course.sec'}); |
$env{'request.course.sec'}); |
|
return $weight; |
} |
} |
sub part_display { |
sub part_display { |
my $self= shift(); my $partID = shift(); |
my $self= shift(); my $partID = shift(); |
Line 3891 sub part_display {
|
Line 4101 sub part_display {
|
} |
} |
return $display; |
return $display; |
} |
} |
|
sub slot_control { |
|
my $self=shift(); my $part = shift(); |
|
if (!defined($part)) { $part = '0'; } |
|
my $useslots = $self->parmval("useslots", $part); |
|
my $availablestudent = $self->parmval("availablestudent", $part); |
|
my $available = $self->parmval("available", $part); |
|
return ($useslots,$availablestudent,$available); |
|
} |
|
|
# Multiple things need this |
# Multiple things need this |
sub getReturnHash { |
sub getReturnHash { |
Line 4539 sub TRIES_LEFT { return 20; }
|
Line 4757 sub TRIES_LEFT { return 20; }
|
sub ANSWER_SUBMITTED { return 21; } |
sub ANSWER_SUBMITTED { return 21; } |
sub PARTIALLY_CORRECT{ return 22; } |
sub PARTIALLY_CORRECT{ return 22; } |
|
|
|
sub RESERVED_LATER { return 30; } |
|
sub RESERVED { return 31; } |
|
sub RESERVED_LOCATION { return 32; } |
|
sub RESERVABLE { return 33; } |
|
sub RESERVABLE_LATER { return 34; } |
|
sub NOTRESERVABLE { return 35; } |
|
sub NOT_IN_A_SLOT { return 36; } |
|
sub NEEDS_CHECKIN { return 37; } |
|
sub WAITING_FOR_GRADE { return 38; } |
|
sub UNKNOWN { return 39; } |
|
|
sub status { |
sub status { |
my $self = shift; |
my $self = shift; |
my $part = shift; |
my $part = shift; |
Line 4553 sub status {
|
Line 4782 sub status {
|
#if ($self->{RESOURCE_ERROR}) { return NETWORK_FAILURE; } |
#if ($self->{RESOURCE_ERROR}) { return NETWORK_FAILURE; } |
if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; } |
if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; } |
|
|
my $suppressFeedback = $self->problemstatus($part) eq 'no'; |
my $suppressFeedback = 0; |
|
if (($self->problemstatus($part) eq 'no') || |
|
($self->problemstatus($part) eq 'no_feedback_ever')) { |
|
$suppressFeedback = 1; |
|
} |
# If there's an answer date and we're past it, don't |
# If there's an answer date and we're past it, don't |
# suppress the feedback; student should know |
# suppress the feedback; student should know |
if ($self->duedate($part) && $self->duedate($part) < time() && |
if ($self->duedate($part) && $self->duedate($part) < time() && |
Line 4626 sub status {
|
Line 4859 sub status {
|
return OPEN; |
return OPEN; |
} |
} |
|
|
|
sub check_for_slot { |
|
my $self = shift; |
|
my $part = shift; |
|
my ($use_slots,$available,$availablestudent) = $self->slot_control($part); |
|
if (($use_slots ne '') && ($use_slots !~ /^\s*no\s*$/i)) { |
|
my @slots = (split(/:/,$availablestudent),split(/:/,$available)); |
|
my $cid=$env{'request.course.id'}; |
|
my $cdom=$env{'course.'.$cid.'.domain'}; |
|
my $cnum=$env{'course.'.$cid.'.num'}; |
|
my $now = time; |
|
if (@slots > 0) { |
|
my %slots=&Apache::lonnet::get('slots',[@slots],$cdom,$cnum); |
|
if (&Apache::lonnet::error(%slots)) { |
|
return (UNKNOWN); |
|
} |
|
my @sorted_slots = &Apache::loncommon::sorted_slots(\@slots,\%slots); |
|
my ($checkedin,$checkedinslot); |
|
foreach my $slot_name (@sorted_slots) { |
|
next if (!defined($slots{$slot_name}) || |
|
!ref($slots{$slot_name})); |
|
my $end = $slots{$slot_name}->{'endtime'}; |
|
my $start = $slots{$slot_name}->{'starttime'}; |
|
my $ip = $slots{$slot_name}->{'ip'}; |
|
if ($self->simpleStatus() == OPEN) { |
|
my $startreserve = $slots{$slot_name}->{'startreserve'}; |
|
my @proctors; |
|
if ($slots{$slot_name}->{'proctor'} ne '') { |
|
@proctors = split(',',$slots{$slot_name}->{'proctor'}); |
|
} |
|
if ($end > $now) { |
|
($checkedin,$checkedinslot) = $self->checkedin(); |
|
if ($startreserve < $now) { |
|
if ($start > $now) { |
|
return (RESERVED_LATER,$start,$slot_name); |
|
} else { |
|
if ($ip ne '') { |
|
if (!&Apache::loncommon::check_ip_acc($ip)) { |
|
return (RESERVED_LOCATION,$ip,$slot_name); |
|
} |
|
} |
|
if (@proctors > 0) { |
|
unless ((grep(/^\Q$checkedin\E/,@proctors)) && |
|
($checkedinslot eq $slot_name)) { |
|
return (NEEDS_CHECKIN,undef,$slot_name); |
|
} |
|
} |
|
return (RESERVED,$end,$slot_name); |
|
} |
|
} else { |
|
if ($start > $now) { |
|
return (RESERVABLE,$startreserve,$slot_name); |
|
} |
|
} |
|
} |
|
} |
|
} |
|
my ($is_correct,$got_grade); |
|
if ($self->is_task()) { |
|
my $taskstatus = $self->taskstatus(); |
|
$is_correct = (($taskstatus eq 'pass') || |
|
($self->solved() =~ /^correct_/)); |
|
$got_grade = ($self->solved() =~ /^(?:pass|fail)$/); |
|
} else { |
|
$got_grade = 1; |
|
$is_correct = ($self->solved() =~ /^correct_/); |
|
} |
|
($checkedin,$checkedinslot) = $self->checkedin(); |
|
if ($checkedin) { |
|
if (!$got_grade) { |
|
return (WAITING_FOR_GRADE); |
|
} elsif ($is_correct) { |
|
return (CORRECT); |
|
} |
|
} |
|
return(NOT_IN_A_SLOT); |
|
} else { |
|
if (!$future_slots_checked) { |
|
$future_slots = &get_future_slots($cdom,$cnum,$now); |
|
$future_slots_checked = 1; |
|
} |
|
if ($future_slots) { |
|
return(NOT_IN_A_SLOT); |
|
} |
|
return(NOTRESERVABLE); |
|
} |
|
} |
|
return; |
|
} |
|
|
|
sub get_future_slots { |
|
my ($cdom,$cnum,$now) = @_; |
|
my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum); |
|
my $future_slots = 0; |
|
foreach my $slot (keys(%slots)) { |
|
if (($slots{$slot}->{'starttime'} > $now) && |
|
($slots{$slot}->{'endtime'} > $now)) { |
|
$future_slots ++; |
|
} |
|
} |
|
return $future_slots; |
|
} |
|
|
sub CLOSED { return 23; } |
sub CLOSED { return 23; } |
sub ERROR { return 24; } |
sub ERROR { return 24; } |
|
|