version 1.201, 2003/06/12 20:36:41
|
version 1.498, 2014/01/19 21:12:35
|
Line 2
|
Line 2
|
# Navigate Maps Handler |
# Navigate Maps Handler |
# |
# |
# $Id$ |
# $Id$ |
|
|
# |
# |
# Copyright Michigan State University Board of Trustees |
# Copyright Michigan State University Board of Trustees |
# |
# |
Line 25
|
Line 26
|
# |
# |
# http://www.lon-capa.org/ |
# http://www.lon-capa.org/ |
# |
# |
# (Page Handler |
### |
# |
|
# (TeX Content Handler |
=pod |
# |
|
# 05/29/00,05/30 Gerd Kortemeyer) |
=head1 NAME |
# 08/30,08/31,09/06,09/14,09/15,09/16,09/19,09/20,09/21,09/23, |
|
# 10/02,10/10,10/14,10/16,10/18,10/19,10/31,11/6,11/14,11/16 Gerd Kortemeyer) |
Apache::lonnavmaps - Subroutines to handle and render the navigation |
# |
|
# 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer |
=head1 SYNOPSIS |
# YEAR=2002 |
|
# 1/1 Gerd Kortemeyer |
Handles navigational maps. |
# Oct-Nov Jeremy Bowers |
|
# YEAR=2003 |
The main handler generates the navigational listing for the course, |
# Jeremy Bowers ... lots of days |
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. |
|
|
|
=item * B<map_no_edit_link>: |
|
|
|
If true, the title of the folder or page will not be followed by an |
|
icon/link to direct editing of a folder or composite page, originally |
|
added via the Course Editor. |
|
|
|
=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_toolbar() |
|
|
|
=back |
|
|
|
=cut |
|
|
package Apache::lonnavmaps; |
package Apache::lonnavmaps; |
|
|
use strict; |
use strict; |
use Apache::Constants qw(:common :http); |
use GDBM_File; |
use Apache::loncommon(); |
use Apache::loncommon(); |
use Apache::lonmenu(); |
use Apache::lonenc(); |
|
use Apache::lonlocal; |
|
use Apache::lonnet; |
|
use Apache::lonmap; |
|
|
use POSIX qw (floor strftime); |
use POSIX qw (floor strftime); |
use Data::Dumper; # for debugging, not always used |
use Time::HiRes qw( gettimeofday tv_interval ); |
|
use LONCAPA; |
|
use DateTime(); |
|
use HTML::Entities; |
|
|
|
# For debugging |
|
|
|
use Data::Dumper; |
|
|
|
|
# symbolic constants |
# symbolic constants |
sub SYMB { return 1; } |
sub SYMB { return 1; } |
Line 58 sub NOTHING { return 3; }
|
Line 506 sub NOTHING { return 3; }
|
|
|
my $resObj = "Apache::lonnavmaps::resource"; |
my $resObj = "Apache::lonnavmaps::resource"; |
|
|
# Keep these mappings in sync with lonquickgrades, which uses the colors |
# Keep these mappings in sync with lonquickgrades, which usesthe colors |
# instead of the icons. |
# instead of the icons. |
my %statusIconMap = |
my %statusIconMap = |
( $resObj->NETWORK_FAILURE => '', |
( |
$resObj->NOTHING_SET => '', |
$resObj->CLOSED => '', |
$resObj->CORRECT => 'navmap.correct.gif', |
$resObj->OPEN => 'navmap.open.gif', |
$resObj->EXCUSED => 'navmap.correct.gif', |
$resObj->CORRECT => 'navmap.correct.gif', |
$resObj->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif', |
$resObj->PARTIALLY_CORRECT => 'navmap.partial.gif', |
$resObj->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif', |
$resObj->INCORRECT => 'navmap.wrong.gif', |
$resObj->ANSWER_OPEN => 'navmap.wrong.gif', |
$resObj->ATTEMPTED => 'navmap.ellipsis.gif', |
$resObj->OPEN_LATER => '', |
$resObj->ERROR => '' |
$resObj->TRIES_LEFT => 'navmap.open.gif', |
); |
$resObj->INCORRECT => 'navmap.wrong.gif', |
|
$resObj->OPEN => 'navmap.open.gif', |
my %iconAltTags = #texthash does not work here |
$resObj->ATTEMPTED => 'navmap.ellipsis.gif', |
( 'navmap.correct.gif' => 'Correct', |
$resObj->ANSWER_SUBMITTED => '' ); |
'navmap.wrong.gif' => 'Incorrect', |
|
'navmap.open.gif' => 'Is Open', |
my %iconAltTags = |
'navmap.partial.gif' => 'Partially Correct', |
( 'navmap.correct.gif' => 'Correct', |
'navmap.ellipsis.gif' => 'Attempted', |
'navmap.wrong.gif' => 'Incorrect', |
); |
'navmap.open.gif' => 'Open' ); |
|
|
|
# Defines a status->color mapping, null string means don't color |
# Defines a status->color mapping, null string means don't color |
my %colormap = |
my %colormap = |
Line 92 my %colormap =
|
Line 539 my %colormap =
|
$resObj->TRIES_LEFT => '', |
$resObj->TRIES_LEFT => '', |
$resObj->INCORRECT => '', |
$resObj->INCORRECT => '', |
$resObj->OPEN => '', |
$resObj->OPEN => '', |
$resObj->NOTHING_SET => '' ); |
$resObj->NOTHING_SET => '', |
|
$resObj->ATTEMPTED => '', |
|
$resObj->CREDIT_ATTEMPTED => '', |
|
$resObj->ANSWER_SUBMITTED => '', |
|
$resObj->PARTIALLY_CORRECT => '#006600' |
|
); |
# And a special case in the nav map; what to do when the assignment |
# And a special case in the nav map; what to do when the assignment |
# is not yet done and due in less then 24 hours |
# is not yet done and due in less than 24 hours |
my $hurryUpColor = "#FF0000"; |
my $hurryUpColor = "#FF0000"; |
|
|
sub handler { |
|
my $r = shift; |
|
real_handler($r); |
|
} |
|
|
|
sub real_handler { |
|
my $r = shift; |
|
|
|
# Handle header-only request |
|
if ($r->header_only) { |
|
if ($ENV{'browser.mathml'}) { |
|
$r->content_type('text/xml'); |
|
} else { |
|
$r->content_type('text/html'); |
|
} |
|
$r->send_http_header; |
|
return OK; |
|
} |
|
|
|
# Send header, don't cache this page |
|
if ($ENV{'browser.mathml'}) { |
|
$r->content_type('text/xml'); |
|
} else { |
|
$r->content_type('text/html'); |
|
} |
|
&Apache::loncommon::no_cache($r); |
|
$r->send_http_header; |
|
|
|
# Create the nav map |
|
my $navmap = Apache::lonnavmaps::navmap->new( |
|
$ENV{"request.course.fn"}.".db", |
|
$ENV{"request.course.fn"}."_parms.db", 1, 1); |
|
|
|
|
|
if (!defined($navmap)) { |
|
my $requrl = $r->uri; |
|
$ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized"; |
|
return HTTP_NOT_ACCEPTABLE; |
|
} |
|
|
|
$r->print("<html><head>\n"); |
|
$r->print("<title>Navigate Course Contents</title>"); |
|
# ------------------------------------------------------------ Get query string |
|
&Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']); |
|
|
|
# ----------------------------------------------------- Force menu registration |
|
my $addentries=''; |
|
if ($ENV{'form.register'}) { |
|
$addentries=' onLoad="'.&Apache::lonmenu::loadevents(). |
|
'" onUnload="'.&Apache::lonmenu::unloadevents().'"'; |
|
$r->print(&Apache::lonmenu::registerurl(1)); |
|
} |
|
|
|
# Header |
|
$r->print('</head>'. |
|
&Apache::loncommon::bodytag('Navigate Course Contents','', |
|
$addentries,'','',$ENV{'form.register'})); |
|
$r->print('<script>window.focus();</script>'); |
|
|
|
$r->rflush(); |
|
|
|
# Now that we've displayed some stuff to the user, init the navmap |
|
$navmap->init(); |
|
|
|
$r->print('<br> '); |
|
$r->rflush(); |
|
|
|
# Check that it's defined |
|
if (!($navmap->courseMapDefined())) { |
|
$r->print('<font size="+2" color="red">Coursemap undefined.</font>' . |
|
'</body></html>'); |
|
return OK; |
|
} |
|
|
|
# See if there's only one map in the top-level, if we don't |
|
# already have a filter... if so, automatically display it |
|
if ($ENV{QUERY_STRING} !~ /filter/) { |
|
my $iterator = $navmap->getIterator(undef, undef, undef, 0); |
|
my $depth = 1; |
|
$iterator->next(); |
|
my $curRes = $iterator->next(); |
|
my $sequenceCount = 0; |
|
my $sequenceId; |
|
while ($depth > 0) { |
|
if ($curRes == $iterator->BEGIN_MAP()) { $depth++; } |
|
if ($curRes == $iterator->END_MAP()) { $depth--; } |
|
|
|
if (ref($curRes) && $curRes->is_sequence()) { |
|
$sequenceCount++; |
|
$sequenceId = $curRes->map_pc(); |
|
} |
|
|
|
$curRes = $iterator->next(); |
|
} |
|
|
|
if ($sequenceCount == 1) { |
|
# The automatic iterator creation in the render call |
|
# will pick this up. We know the condition because |
|
# the defined($ENV{'form.filter'}) also ensures this |
|
# is a fresh call. |
|
$ENV{'form.filter'} = "$sequenceId"; |
|
} |
|
} |
|
|
|
my $jumpToFirstHomework = 0; |
|
# Check to see if the student is jumping to next open, do-able problem |
|
if ($ENV{QUERY_STRING} eq 'jumpToFirstHomework') { |
|
$jumpToFirstHomework = 1; |
|
# Find the next homework problem that they can do. |
|
my $iterator = $navmap->getIterator(undef, undef, undef, 1); |
|
my $depth = 1; |
|
$iterator->next(); |
|
my $curRes = $iterator->next(); |
|
my $foundDoableProblem = 0; |
|
my $problemRes; |
|
|
|
while ($depth > 0 && !$foundDoableProblem) { |
|
if ($curRes == $iterator->BEGIN_MAP()) { $depth++; } |
|
if ($curRes == $iterator->END_MAP()) { $depth--; } |
|
|
|
if (ref($curRes) && $curRes->is_problem()) { |
|
my $status = $curRes->status(); |
|
if ($curRes->completable()) { |
|
$problemRes = $curRes; |
|
$foundDoableProblem = 1; |
|
|
|
# Pop open all previous maps |
|
my $stack = $iterator->getStack(); |
|
pop @$stack; # last resource in the stack is the problem |
|
# itself, which we don't need in the map stack |
|
my @mapPcs = map {$_->map_pc()} @$stack; |
|
$ENV{'form.filter'} = join(',', @mapPcs); |
|
|
|
# Mark as both "here" and "jump" |
|
$ENV{'form.postsymb'} = $curRes->symb(); |
|
} |
|
} |
|
} continue { |
|
$curRes = $iterator->next(); |
|
} |
|
|
|
# If we found no problems, print a note to that effect. |
|
if (!$foundDoableProblem) { |
|
$r->print("<font size='+2'>All homework assignments have been completed.</font><br /><br />"); |
|
} |
|
} else { |
|
$r->print("<a href='navmaps?jumpToFirstHomework'>" . |
|
"Go To My First Homework Problem</a><br />"); |
|
} |
|
|
|
my $suppressEmptySequences = 0; |
|
my $filterFunc = undef; |
|
my $resource_no_folder_link = 0; |
|
|
|
# Display only due homework. |
|
my $showOnlyHomework = 0; |
|
if ($ENV{QUERY_STRING} eq 'showOnlyHomework') { |
|
$showOnlyHomework = 1; |
|
$suppressEmptySequences = 1; |
|
$filterFunc = sub { my $res = shift; |
|
return $res->completable() || $res->is_map(); |
|
}; |
|
$r->print("<p><font size='+2'>Uncompleted Homework</font></p>"); |
|
$ENV{'form.filter'} = ''; |
|
$ENV{'form.condition'} = 1; |
|
$resource_no_folder_link = 1; |
|
} else { |
|
$r->print("<a href='navmaps?showOnlyHomework'>" . |
|
"Show Only Uncompleted Homework</a><br />"); |
|
} |
|
|
|
# renderer call |
|
my $renderArgs = { 'cols' => [0,1,2,3], |
|
'url' => '/adm/navmaps', |
|
'navmap' => $navmap, |
|
'suppressNavmap' => 1, |
|
'suppressEmptySequences' => $suppressEmptySequences, |
|
'filterFunc' => $filterFunc, |
|
'resource_no_folder_link' => $resource_no_folder_link, |
|
'r' => $r}; |
|
my $render = render($renderArgs); |
|
$navmap->untieHashes(); |
|
|
|
# If no resources were printed, print a reassuring message so the |
|
# user knows there was no error. |
|
if ($renderArgs->{'counter'} == 0) { |
|
if ($showOnlyHomework) { |
|
$r->print("<p><font size='+1'>All homework is currently completed.</font></p>"); |
|
} else { # both jumpToFirstHomework and normal use the same: course must be empty |
|
$r->print("<p><font size='+1'>This course is empty.</font></p>"); |
|
} |
|
} |
|
|
|
$r->print("</body></html>"); |
|
$r->rflush(); |
|
|
|
return OK; |
|
} |
|
|
|
# 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 317 sub removeFromFilter {
|
Line 567 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. |
|
# Later, this should add an anchor when we start putting anchors in pages. |
|
sub getLinkForResource { |
sub getLinkForResource { |
my $stack = shift; |
my $stack = shift; |
my $res; |
my $res; |
|
|
# Check to see if there are any pages in the stack |
# Check to see if there are any pages in the stack |
foreach $res (@$stack) { |
foreach $res (@$stack) { |
if (defined($res) && $res->is_page()) { |
if (defined($res)) { |
return $res->src(); |
my $anchor; |
|
if ($res->is_page()) { |
|
foreach my $item (@$stack) { if (defined($item)) { $anchor = $item; } } |
|
$anchor=&escape($anchor->shown_symb()); |
|
return ($res->link(),$res->shown_symb(),$anchor); |
|
} |
|
# in case folder was skipped over as "only sequence" |
|
my ($map,$id,$src)=&Apache::lonnet::decode_symb($res->symb()); |
|
if ($map=~/\.page$/) { |
|
my $url=&Apache::lonnet::clutter($map); |
|
$anchor=&escape($res->shown_symb()); |
|
return ($url,$res->shown_symb(),$anchor); |
|
} |
} |
} |
} |
} |
|
|
Line 335 sub getLinkForResource {
|
Line 594 sub getLinkForResource {
|
# (when we first recurse on a map, it puts an undefined resource |
# (when we first recurse on a map, it puts an undefined resource |
# on the bottom because $self->{HERE} isn't defined yet, and we |
# on the bottom because $self->{HERE} isn't defined yet, and we |
# want the src for the map anyhow) |
# want the src for the map anyhow) |
foreach (@$stack) { |
foreach my $item (@$stack) { |
if (defined($_)) { $res = $_; } |
if (defined($item)) { $res = $item; } |
} |
} |
|
|
return $res->src(); |
if ($res) { |
|
return ($res->link(),$res->shown_symb()); |
|
} |
|
return; |
} |
} |
|
|
# Convenience function: This seperates the logic of how to create |
|
# the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned", |
|
# etc.) into a seperate 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 "Having technical difficulties; please check status later"; |
return &mt("Having technical difficulties; please check status later"); |
} |
} |
if ($status == $res->NOTHING_SET) { |
if ($status == $res->NOTHING_SET) { |
return "Not currently assigned."; |
return &Apache::lonhtmlcommon::direct_parm_link(&mt('Not currently assigned'),$res->symb(),'opendate',$part); |
} |
} |
if ($status == $res->OPEN_LATER) { |
if ($status == $res->OPEN_LATER) { |
return "Open " . timeToHumanString($res->opendate($part)); |
return &mt("Open [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($open,'start'),$res->symb(),'opendate',$part)); |
|
} |
|
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, reservations close [_1]', |
|
timeToHumanString($slot_time,'end')); |
|
} elsif ($slot_status == $res->RESERVABLE_LATER) { |
|
return &mt('Reservable, reservations open [_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) { |
return "Due " . timeToHumanString($res->duedate($part)); |
if ($res->is_practice()) { |
|
return &mt("Closes [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($due,'start'),$res->symb(),'duedate',$part)); |
|
} else { |
|
return &mt("Due [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($due,'end'),$res->symb(),'duedate',$part)); |
|
} |
} else { |
} else { |
return "Open, no due date"; |
return &Apache::lonhtmlcommon::direct_parm_link(&mt("Open, no due date"),$res->symb(),'duedate',$part); |
} |
} |
} |
} |
if ($status == $res->PAST_DUE_ANSWER_LATER) { |
if ($status == $res->PAST_DUE_ANSWER_LATER) { |
return "Answer open " . timeToHumanString($res->answerdate($part)); |
return &mt("Answer open [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($answer,'start'),$res->symb(),'answerdate',$part)); |
} |
} |
if ($status == $res->PAST_DUE_NO_ANSWER) { |
if ($status == $res->PAST_DUE_NO_ANSWER) { |
return "Was due " . timeToHumanString($res->duedate($part)); |
if ($res->is_practice()) { |
} |
return &mt("Closed [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($due,'start'),$res->symb(),'answerdate,duedate',$part)); |
if ($status == $res->ANSWER_OPEN) { |
} else { |
return "Answer available"; |
return &mt("Was due [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($due,'end'),$res->symb(),'answerdate,duedate',$part)); |
|
} |
|
} |
|
if (($status == $res->ANSWER_OPEN || $status == $res->PARTIALLY_CORRECT) |
|
&& $res->handgrade($part) ne 'yes') { |
|
return &Apache::lonhtmlcommon::direct_parm_link(&mt("Answer available"),$res->symb(),'answerdate,duedate',$part); |
} |
} |
if ($status == $res->EXCUSED) { |
if ($status == $res->EXCUSED) { |
return "Excused by instructor"; |
return &mt("Excused by instructor"); |
} |
} |
if ($status == $res->ATTEMPTED) { |
if ($status == $res->ATTEMPTED) { |
return "Answer submitted, not yet graded."; |
if ($res->is_anonsurvey($part) || $res->is_survey($part)) { |
|
return &mt("Survey submission recorded"); |
|
} else { |
|
return &mt("Answer submitted, not yet graded"); |
|
} |
|
} |
|
if ($status == $res->CREDIT_ATTEMPTED) { |
|
if ($res->is_anonsurvey($part) || $res->is_survey($part)) { |
|
return &mt("Credit for survey submission"); |
|
} |
} |
} |
if ($status == $res->TRIES_LEFT) { |
if ($status == $res->TRIES_LEFT) { |
my $tries = $res->tries($part); |
my $tries = $res->tries($part); |
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 = '<span class="LC_fontsize_medium"><i>('.&mt('[_1] of [quant,_2,try,tries] used',$tries,$maxtries).')</i></span>'; |
if ($maxtries > 1 && $maxtries - $tries == 1) { |
if ($maxtries > 1 && $maxtries - $tries == 1) { |
$triesString = "<b>$triesString</b>"; |
$triesString = "<b>$triesString</b>"; |
} |
} |
} |
} |
if ($res->duedate()) { |
if ($due) { |
return "Due " . timeToHumanString($res->duedate($part)) . |
return &mt("Due [_1]",&Apache::lonhtmlcommon::direct_parm_link(&timeToHumanString($due,'end'),$res->symb(),'duedate',$part)) . |
" $triesString"; |
" $triesString"; |
} else { |
} else { |
return "No due date $triesString"; |
return &Apache::lonhtmlcommon::direct_parm_link(&mt("No due date"),$res->symb(),'duedate',$part)." $triesString"; |
} |
} |
} |
} |
if ($status == $res->ANSWER_SUBMITTED) { |
if ($status == $res->ANSWER_SUBMITTED) { |
return 'Answer submitted'; |
return &mt('Answer submitted'); |
} |
} |
} |
} |
|
|
# Convenience function, so others can use it: Is the problem due in less then |
|
# 24 hours, and still can be done? |
|
|
|
sub dueInLessThen24Hours { |
sub dueInLessThan24Hours { |
my $res = shift; |
my $res = shift; |
my $part = shift; |
my $part = shift; |
my $status = $res->status($part); |
my $status = $res->status($part); |
|
|
return ($status == $res->OPEN() || $status == $res->ATTEMPTED() || |
return ($status == $res->OPEN() || |
$status == $res->TRIES_LEFT()) && |
$status == $res->TRIES_LEFT()) && |
$res->duedate() && $res->duedate() < time()+(24*60*60) && |
$res->duedate($part) && $res->duedate($part) < time()+(24*60*60) && |
$res->duedate() > time(); |
$res->duedate($part) > time(); |
} |
} |
|
|
# Convenience function, so others can use it: Is there only one try remaining for the |
|
# part, with more then 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 429 sub lastTry {
|
Line 735 sub lastTry {
|
my $tries = $res->tries($part); |
my $tries = $res->tries($part); |
my $maxtries = $res->maxtries($part); |
my $maxtries = $res->maxtries($part); |
return $tries && $maxtries && $maxtries > 1 && |
return $tries && $maxtries && $maxtries > 1 && |
$maxtries - $tries == 1 && $res->duedate() && |
$maxtries - $tries == 1 && $res->duedate($part) && |
$res->duedate() > 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) = @_; |
my ($time,$type,$format) = @_; |
|
|
# zero, '0' and blank are bad times |
# zero, '0' and blank are bad times |
if (!$time) { |
if (!$time) { |
return 'never'; |
return &mt('never'); |
} |
} |
|
unless (&Apache::lonlocal::current_language()=~/^en/) { |
|
return &Apache::lonlocal::locallocaltime($time); |
|
} |
my $now = time(); |
my $now = time(); |
|
|
my @time = localtime($time); |
|
my @now = localtime($now); |
|
|
|
# Positive = future |
# Positive = future |
my $delta = $time - $now; |
my $delta = $time - $now; |
|
|
Line 485 sub timeToHumanString {
|
Line 781 sub timeToHumanString {
|
my $tense = $inPast ? " ago" : ""; |
my $tense = $inPast ? " ago" : ""; |
my $prefix = $inPast ? "" : "in "; |
my $prefix = $inPast ? "" : "in "; |
|
|
# Less then a minute |
# Less than a minute |
if ( $delta < $minute ) { |
if ( $delta < $minute ) { |
if ($delta == 1) { return "${prefix}1 second$tense"; } |
if ($delta == 1) { return "${prefix}1 second$tense"; } |
return "$prefix$delta seconds$tense"; |
return "$prefix$delta seconds$tense"; |
} |
} |
|
|
# Less then an hour |
# Less than an hour |
if ( $delta < $hour ) { |
if ( $delta < $hour ) { |
# If so, use minutes |
# If so, use minutes; or minutes, seconds (if format requires) |
my $minutes = floor($delta / 60); |
my $minutes = floor($delta / 60); |
|
if (($format ne '') && ($format =~ /\%(T|S)/)) { |
|
my $display; |
|
if ($minutes == 1) { |
|
$display = "${prefix}1 minute"; |
|
} else { |
|
$display = "$prefix$minutes minutes"; |
|
} |
|
my $seconds = $delta % $minute; |
|
if ($seconds == 0) { |
|
$display .= $tense; |
|
} elsif ($seconds == 1) { |
|
$display .= ", 1 second$tense"; |
|
} else { |
|
$display .= ", $seconds seconds$tense"; |
|
} |
|
return $display; |
|
} |
if ($minutes == 1) { return "${prefix}1 minute$tense"; } |
if ($minutes == 1) { return "${prefix}1 minute$tense"; } |
return "$prefix$minutes minutes$tense"; |
return "$prefix$minutes minutes$tense"; |
} |
} |
|
|
# Is it less then 24 hours away? If so, |
# Is it less than 24 hours away? If so, |
# display hours + minutes |
# display hours + minutes, (and + seconds, if format specified it) |
if ( $delta < $hour * 24) { |
if ( $delta < $hour * 24) { |
my $hours = floor($delta / $hour); |
my $hours = floor($delta / $hour); |
my $minutes = floor(($delta % $hour) / $minute); |
my $minutes = floor(($delta % $hour) / $minute); |
Line 515 sub timeToHumanString {
|
Line 828 sub timeToHumanString {
|
if ($minutes == 0) { |
if ($minutes == 0) { |
$minuteString = ""; |
$minuteString = ""; |
} |
} |
|
if (($format ne '') && ($format =~ /\%(T|S)/)) { |
|
my $display = "$prefix$hourString$minuteString"; |
|
my $seconds = $delta-(($hours * $hour)+($minutes * $minute)); |
|
if ($seconds == 0) { |
|
$display .= $tense; |
|
} elsif ($seconds == 1) { |
|
$display .= ", 1 second$tense"; |
|
} else { |
|
$display .= ", $seconds seconds$tense"; |
|
} |
|
return $display; |
|
} |
return "$prefix$hourString$minuteString$tense"; |
return "$prefix$hourString$minuteString$tense"; |
} |
} |
|
|
# Less then 5 days away, display day of the week and |
# Date/time is more than 24 hours away |
|
|
|
my $dt = DateTime->from_epoch(epoch => $time) |
|
->set_time_zone(&Apache::lonlocal::gettimezone()); |
|
|
|
# If there's a caller supplied format, use it, unless it only displays |
|
# H:M:S or H:M. |
|
|
|
if (($format ne '') && ($format ne '%T') && ($format ne '%R')) { |
|
my $timeStr = $dt->strftime($format); |
|
return $timeStr.' ('.$dt->time_zone_short_name().')'; |
|
} |
|
|
|
# Less than 5 days away, display day of the week and |
# HH:MM |
# HH:MM |
|
|
if ( $delta < $day * 5 ) { |
if ( $delta < $day * 5 ) { |
my $timeStr = strftime("%A, %b %e at %I:%M %P", localtime($time)); |
my $timeStr = $dt->strftime("%A, %b %e at %I:%M %P (%Z)"); |
$timeStr =~ s/12:00 am/midnight/; |
$timeStr =~ s/12:00 am/00:00/; |
$timeStr =~ s/12:00 pm/noon/; |
$timeStr =~ s/12:00 pm/noon/; |
return ($inPast ? "last " : "next ") . |
return ($inPast ? "last " : "this ") . |
$timeStr; |
$timeStr; |
} |
} |
|
|
|
my $conjunction='on'; |
|
if ($type eq 'start') { |
|
$conjunction='at'; |
|
} elsif ($type eq 'end') { |
|
$conjunction='by'; |
|
} |
# Is it this year? |
# Is it this year? |
if ( $time[5] == $now[5]) { |
my $dt_now = DateTime->from_epoch(epoch => $now) |
|
->set_time_zone(&Apache::lonlocal::gettimezone()); |
|
if ( $dt->year() == $dt_now->year()) { |
# Return on Month Day, HH:MM meridian |
# Return on Month Day, HH:MM meridian |
my $timeStr = strftime("on %A, %b %e at %I:%M %P", localtime($time)); |
my $timeStr = $dt->strftime("$conjunction %A, %b %e at %I:%M %P (%Z)"); |
$timeStr =~ s/12:00 am/midnight/; |
$timeStr =~ s/12:00 am/00:00/; |
$timeStr =~ s/12:00 pm/noon/; |
$timeStr =~ s/12:00 pm/noon/; |
return $timeStr; |
return $timeStr; |
} |
} |
|
|
# Not this year, so show the year |
# Not this year, so show the year |
my $timeStr = strftime("on %A, %b %e %G at %I:%M %P", localtime($time)); |
my $timeStr = |
$timeStr =~ s/12:00 am/midnight/; |
$dt->strftime("$conjunction %A, %b %e %Y at %I:%M %P (%Z)"); |
|
$timeStr =~ s/12:00 am/00:00/; |
$timeStr =~ s/12:00 pm/noon/; |
$timeStr =~ s/12:00 pm/noon/; |
return $timeStr; |
return $timeStr; |
} |
} |
} |
} |
|
|
|
|
=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 Object: 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 presents, |
|
instead of passing it arguments as is normal, pass it in an anonymous |
|
hash with the given options. This is because there is no obvious order |
|
you may wish to override these in and a hash is easier to read and |
|
understand then "undef, undef, undef, 1, undef, undef, renderButton, |
|
undef, 0" when you mostly want default behaviors. |
|
|
|
The package provides a function called 'render', called as |
|
Apache::lonnavmaps::renderer->render({}). |
|
|
|
=head2 Overview of Columns |
|
|
|
The renderer will build an HTML table for the navmap and return |
|
it. The table is 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 preparent 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. |
|
|
|
The pre-packaged column names are refered to by constants in the |
|
Apache::lonnavmaps::renderer namespace. The following currently exist: |
|
|
|
=over 4 |
|
|
|
=item * B<resource>: |
|
|
|
The general info about the resource: Link, icon for the type, etc. The |
|
first column in the standard nav map display. This column also accepts |
|
the following parameter in the renderer hash: |
|
|
|
=over 4 |
|
|
|
=item * B<resource_nolink>: |
|
|
|
If true, the resource will not be linked. Default: false, resource |
|
will have links. |
|
|
|
=item * B<resource_part_count>: |
|
|
|
If true (default), the resource will show a part count if the full |
|
part list is not displayed. 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<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<quick_status>: |
|
|
|
An icon for the status of a problem, with four possible states: |
|
Correct, incorrect, open, or none (not open yet, not a problem). The |
|
third column of the standard navmap. |
|
|
|
=item B<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. |
|
|
|
=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 |
|
|
|
Most of these parameters are only useful if you are *not* using the |
|
folder interface (i.e., the default first column), which is probably |
|
the common case. If you are using this interface, then 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>: |
|
|
|
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>: |
|
|
|
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<navmap>: |
|
|
|
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>: |
|
|
|
The standard Apache response object. This must be passed to the |
|
renderer or the course hash will be locked. |
|
|
|
=item * B<cols>: |
|
|
|
An array reference |
|
|
|
=item * B<showParts>: |
|
|
|
A flag. If yes (default), 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>: |
|
|
|
A flag. If yes (default), 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>: |
|
|
|
A string identifying the URL to place the anchor 'curloc' at. Default |
|
to no anchor at all. 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>: |
|
|
|
A Symb identifying where to place the 'here' marker. Default empty, |
|
which means no marker. |
|
|
|
=item * B<indentString>: |
|
|
|
A string identifying the indentation string to use. By default, this |
|
is a 25 pixel whitespace image with no alt text. |
|
|
|
=item * B<queryString>: |
|
|
|
A string which will be prepended to the query string used when the |
|
folders are opened or closed. |
|
|
|
=item * B<url>: |
|
|
|
The url the folders will link to, which should be the current |
|
page. Required if the resource info column is shown. |
|
|
|
=item * B<currentJumpIndex>: |
|
|
|
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>: |
|
|
|
If true, print the key that appears on the top of the standard |
|
navmaps. Default is false. |
|
|
|
=item * B<printCloseAll>: |
|
|
|
If true, print the "Close all folders" or "open all folders" |
|
links. Default is true. |
|
|
|
=item * B<filterFunc>: |
|
|
|
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. By default, all resources |
|
are shown. |
|
|
|
=item * B<suppressEmptySequences>: |
|
|
|
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. |
|
|
|
=item * B<suppressNavmaps>: |
|
|
|
If true, will not display Navigate Content resources. Default to |
|
false. |
|
|
|
=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: |
|
|
|
If you want to know how many rows were printed, the 'counter' element |
|
of the hash passed into the render function will contain the |
|
count. You may want to check whether any resources were printed at |
|
all. |
|
|
|
=over 4 |
|
|
|
=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; } |
sub long_status { return 3; } |
sub long_status { return 3; } |
|
sub part_status_summary { return 4; } |
# Data for render_resource |
|
|
|
sub render_resource { |
sub render_resource { |
my ($resource, $part, $params) = @_; |
my ($resource, $part, $params) = @_; |
|
|
|
my $editmapLink; |
my $nonLinkedText = ''; # stuff after resource title not in link |
my $nonLinkedText = ''; # stuff after resource title not in link |
|
|
my $link = $params->{"resourceLink"}; |
my $link = $params->{"resourceLink"}; |
|
|
|
# The URL part is not escaped at this point, but the symb is... |
|
|
my $src = $resource->src(); |
my $src = $resource->src(); |
my $it = $params->{"iterator"}; |
my $it = $params->{"iterator"}; |
my $filter = $it->{FILTER}; |
my $filter = $it->{FILTER}; |
|
|
my $title = $resource->compTitle(); |
my $title = $resource->compTitle(); |
if ($src =~ /^\/uploaded\//) { |
|
$nonLinkedText=$title; |
|
$title = ''; |
|
} |
|
my $partLabel = ""; |
my $partLabel = ""; |
my $newBranchText = ""; |
my $newBranchText = ""; |
|
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='/adm/lonIcons/branch.gif' border='0' />"; |
$newBranchText = "<img src='$location/branch.gif' alt=".mt('Branch')." />"; |
} |
} |
|
|
# links to open and close the folder |
# links to open and close the folder |
my $linkopen = "<a href='$link'>"; |
|
|
my $whitespace = $location.'/whitespace_21.gif'; |
|
my $linkopen = "<img src='$whitespace' alt='' />"."<a href=\"$link\">"; |
my $linkclose = "</a>"; |
my $linkclose = "</a>"; |
|
|
# Default icon: HTML page |
# Default icon: unknown page |
my $icon = "<img src='/adm/lonIcons/html.gif' alt='' border='0' />"; |
my $icon = "<img class=\"LC_contentImage\" src='$location/unknown.gif' alt='' />"; |
|
|
if ($resource->is_problem()) { |
if ($resource->is_problem()) { |
if ($part eq '0' || $params->{'condensed'}) { |
if ($part eq '0' || $params->{'condensed'}) { |
$icon = '<img src="/adm/lonIcons/problem.gif" alt="" border="0" />'; |
$icon = '<img class="LC_contentImage" src="'.$location.'/'; |
|
if ($resource->is_task()) { |
|
$icon .= 'task.gif" alt="'.&mt('Task'); |
|
} else { |
|
$icon .= 'problem.gif" alt="'.&mt('Problem'); |
|
} |
|
$icon .='" />'; |
} else { |
} else { |
$icon = $params->{'indentString'}; |
$icon = $params->{'indentString'}; |
} |
} |
|
} else { |
|
$icon = "<img class=\"LC_contentImage\" src='".&Apache::loncommon::icon($resource->src)."' alt='' />"; |
} |
} |
|
|
# Display the correct map icon to open or shut map |
# Display the correct map icon to open or shut map |
Line 857 sub render_resource {
|
Line 956 sub render_resource {
|
if ($it->{CONDITION}) { |
if ($it->{CONDITION}) { |
$nowOpen = !$nowOpen; |
$nowOpen = !$nowOpen; |
} |
} |
|
|
|
my $folderType = $resource->is_sequence() ? 'folder' : 'page'; |
|
my $title=$resource->title; |
|
$title=~s/\"/\&qout;/g; |
if (!$params->{'resource_no_folder_link'}) { |
if (!$params->{'resource_no_folder_link'}) { |
$icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . '.gif'; |
$icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif'; |
$icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />"; |
$icon = "<img src='$location/arrow." . ($nowOpen ? 'closed' : 'open') . ".gif' alt='' />" |
|
."<img class=\"LC_contentImage\" src='$location/$icon' alt=\"" |
$linkopen = "<a href='" . $params->{'url'} . '?' . |
.($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" />"; |
$params->{'queryString'} . '&filter='; |
$linkopen = "<a href=\"" . $params->{'url'} . '?' . |
|
$params->{'queryString'} . '&filter='; |
$linkopen .= ($nowOpen xor $it->{CONDITION}) ? |
$linkopen .= ($nowOpen xor $it->{CONDITION}) ? |
addToFilter($filter, $mapId) : |
addToFilter($filter, $mapId) : |
removeFromFilter($filter, $mapId); |
removeFromFilter($filter, $mapId); |
$linkopen .= "&condition=" . $it->{CONDITION} . '&hereType=' |
$linkopen .= "&condition=" . $it->{CONDITION} . '&hereType=' |
. $params->{'hereType'} . '&here=' . |
. $params->{'hereType'} . '&here=' . |
&Apache::lonnet::escape($params->{'here'}) . |
&escape($params->{'here'}) . |
'&jump=' . |
'&jump=' . |
&Apache::lonnet::escape($resource->symb()) . |
&escape($resource->symb()) . |
"&folderManip=1'>"; |
"&folderManip=1\">"; |
|
|
} else { |
} else { |
# Don't allow users to manipulate folder |
# Don't allow users to manipulate folder |
$icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . |
$icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif'; |
'.nomanip.gif'; |
$icon = "<img class=\"LC_space\" src='$whitespace' alt='' />"."<img class=\"LC_contentImage\" src='$location/$icon' alt=\"".($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" />"; |
$icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />"; |
|
|
|
$linkopen = ""; |
$linkopen = ""; |
$linkclose = ""; |
$linkclose = ""; |
} |
} |
|
if ((&Apache::lonnet::allowed('mdc',$env{'request.course.id'})) && |
|
($resource->symb=~/\_\_\_[^\_]+\_\_\_uploaded/)) { |
|
if (!$params->{'map_no_edit_link'}) { |
|
my $icon = &Apache::loncommon::lonhttpdurl('/res/adm/pages').'/editmap.png'; |
|
$editmapLink=' '. |
|
'<a href="/adm/coursedocs?command=directnav&symb='.&escape($resource->symb()).'">'. |
|
'<img src="'.$icon.'" alt="'.&mt('Edit Content').'" title="'.&mt('Edit Content').'" />'. |
|
'</a>'; |
|
} |
|
} |
} |
} |
|
|
if ($resource->randomout()) { |
if ($resource->randomout()) { |
$nonLinkedText .= ' <i>(hidden)</i> '; |
$nonLinkedText .= ' <span class="LC_warning">('.&mt('hidden').')</span> '; |
|
} |
|
if (!$resource->condval()) { |
|
$nonLinkedText .= ' <span class="LC_info">('.&mt('conditionally hidden').')</span> '; |
|
} |
|
if (($resource->is_practice()) && ($resource->is_raw_problem())) { |
|
$nonLinkedText .=' <span class="LC_info"><b>'.&mt('not graded').'</b></span>'; |
} |
} |
|
|
# We're done preparing and finally ready to start the rendering |
|
my $result = "<td align='left' valign='center'>"; |
|
|
|
|
# We're done preparing and finally ready to start the rendering |
|
my $result = '<td class="LC_middle">'; |
|
my $newfolderType = $resource->is_sequence() ? 'folder' : 'page'; |
|
|
my $indentLevel = $params->{'indentLevel'}; |
my $indentLevel = $params->{'indentLevel'}; |
if ($newBranchText) { $indentLevel--; } |
if ($newBranchText) { $indentLevel--; } |
|
|
Line 908 sub render_resource {
|
Line 1028 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>'; |
unless ($resource->is_map()) { |
$curMarkerEnd = '<font color="red" size="+2"><</font>'; |
$curMarkerBegin = '<span class="LC_current_nav_location">'; |
$params->{'displayedHereMarker'} = 1; |
$curMarkerEnd = '</span>'; |
|
} |
|
$params->{'displayedHereMarker'} = 1; |
} |
} |
|
|
if ($resource->is_problem() && $part ne '0' && |
if ($resource->is_problem() && $part ne '0' && |
!$params->{'condensed'}) { |
!$params->{'condensed'}) { |
$partLabel = " (Part $part)"; |
my $displaypart=$resource->part_display($part); |
|
$partLabel = " (".&mt('Part: [_1]', $displaypart).")"; |
|
if ($link!~/\#/) { $link.='#'.&escape($part); } |
$title = ""; |
$title = ""; |
} |
} |
|
|
if ($params->{'condensed'} && $resource->countParts() > 1) { |
if ($params->{'condensed'} && $resource->countParts() > 1) { |
$nonLinkedText .= ' (' . $resource->countParts() . ' parts)'; |
$nonLinkedText .= ' ('.&mt('[_1] parts', $resource->countParts()).')'; |
} |
} |
|
|
if (!$params->{'resource_nolink'}) { |
if (!$params->{'resource_nolink'} && !$resource->is_sequence() && !$resource->is_empty_sequence) { |
$result .= " $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>"; |
$result .= "$curMarkerBegin<a href=\"$link\">$title$partLabel</a>$curMarkerEnd$editmapLink$nonLinkedText</td>"; |
} else { |
} else { |
$result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>"; |
$result .= "$curMarkerBegin$linkopen$title$partLabel</a>$curMarkerEnd$editmapLink$nonLinkedText</td>"; |
} |
} |
|
|
return $result; |
return $result; |
Line 937 sub render_communication_status {
|
Line 1061 sub render_communication_status {
|
my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = ""; |
my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = ""; |
|
|
my $link = $params->{"resourceLink"}; |
my $link = $params->{"resourceLink"}; |
my $linkopen = "<a href='$link'>"; |
my $linkopen = "<a href=\"$link\">"; |
my $linkclose = "</a>"; |
my $linkclose = "</a>"; |
|
my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc"); |
|
|
if ($resource->hasDiscussion()) { |
if ($resource->hasDiscussion()) { |
$discussionHTML = $linkopen . |
$discussionHTML = $linkopen . |
'<img border="0" src="/adm/lonMisc/chat.gif" />' . |
'<img alt="'.&mt('New Discussion').'" src="'.$location.'/chat.gif" title="'.&mt('New Discussion').'"/>' . |
$linkclose; |
$linkclose; |
} |
} |
|
|
if ($resource->getFeedback()) { |
if ($resource->getFeedback()) { |
my $feedback = $resource->getFeedback(); |
my $feedback = $resource->getFeedback(); |
foreach (split(/\,/, $feedback)) { |
foreach my $msgid (split(/\,/, $feedback)) { |
if ($_) { |
if ($msgid) { |
$feedbackHTML .= ' <a href="/adm/email?display=' |
$feedbackHTML .= ' <a href="/adm/email?display=' |
. &Apache::lonnet::escape($_) . '">' |
. &escape($msgid) . '">' |
. '<img src="/adm/lonMisc/feedback.gif" ' |
. '<img alt="'.&mt('New E-mail').'" src="'.$location.'/feedback.gif" title="'.&mt('New E-mail').'"/></a>'; |
. 'border="0" /></a>'; |
|
} |
} |
} |
} |
} |
} |
|
|
if ($resource->getErrors()) { |
if ($resource->getErrors()) { |
my $errors = $resource->getErrors(); |
my $errors = $resource->getErrors(); |
foreach (split(/,/, $errors)) { |
my $errorcount = 0; |
if ($_) { |
foreach my $msgid (split(/,/, $errors)) { |
|
last if ($errorcount>=10); # Only output 10 bombs maximum |
|
if ($msgid) { |
|
$errorcount++; |
$errorHTML .= ' <a href="/adm/email?display=' |
$errorHTML .= ' <a href="/adm/email?display=' |
. &Apache::lonnet::escape($_) . '">' |
. &escape($msgid) . '">' |
. '<img src="/adm/lonMisc/bomb.gif" ' |
. '<img alt="'.&mt('New Error').'" src="'.$location.'/bomb.gif" title="'.&mt('New Error').'"/></a>'; |
. 'border="0" /></a>'; |
|
} |
} |
} |
} |
} |
} |
Line 973 sub render_communication_status {
|
Line 1099 sub render_communication_status {
|
if ($params->{'multipart'} && $part != '0') { |
if ($params->{'multipart'} && $part != '0') { |
$discussionHTML = $feedbackHTML = $errorHTML = ''; |
$discussionHTML = $feedbackHTML = $errorHTML = ''; |
} |
} |
|
return "<td class=\"LC_middle\">$discussionHTML$feedbackHTML$errorHTML </td>"; |
return "<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML </td>"; |
|
|
|
} |
} |
sub render_quick_status { |
sub render_quick_status { |
Line 984 sub render_quick_status {
|
Line 1109 sub render_quick_status {
|
$params->{'multipart'} && $part eq "0"; |
$params->{'multipart'} && $part eq "0"; |
|
|
my $link = $params->{"resourceLink"}; |
my $link = $params->{"resourceLink"}; |
my $linkopen = "<a href='$link'>"; |
my $linkopen = "<a href=\"$link\">"; |
my $linkclose = "</a>"; |
my $linkclose = "</a>"; |
|
|
|
$result .= '<td class="LC_middle">'; |
if ($resource->is_problem() && |
if ($resource->is_problem() && |
!$firstDisplayed) { |
!$firstDisplayed) { |
my $icon = $statusIconMap{$resource->status($part)}; |
my $icon = $statusIconMap{$resource->simpleStatus($part)}; |
my $alt = $iconAltTags{$icon}; |
my $alt = $iconAltTags{$icon}; |
if ($icon) { |
if ($icon) { |
$result .= "<td width='30' valign='center' width='50' align='right'>$linkopen<img width='25' height='25' src='/adm/lonIcons/$icon' border='0' alt='$alt' />$linkclose</td>\n"; |
my $location= |
|
&Apache::loncommon::lonhttpdurl("/adm/lonIcons/$icon"); |
|
$result .= $linkopen.'<img src="'.$location.'" alt="'.&mt($alt).'" title="'.&mt($alt).'" />'.$linkclose; |
} else { |
} else { |
$result .= "<td width='30'> </td>\n"; |
$result .= " "; |
} |
} |
} else { # not problem, no icon |
} else { # not problem, no icon |
$result .= "<td width='30'> </td>\n"; |
$result .= " "; |
} |
} |
|
$result .= "</td>\n"; |
return $result; |
return $result; |
} |
} |
sub render_long_status { |
sub render_long_status { |
my ($resource, $part, $params) = @_; |
my ($resource, $part, $params) = @_; |
my $result = "<td align='right' valign='center'>\n"; |
my $result = '<td class="LC_middle LC_right">'; |
my $firstDisplayed = !$params->{'condensed'} && |
my $firstDisplayed = !$params->{'condensed'} && |
$params->{'multipart'} && $part eq "0"; |
$params->{'multipart'} && $part eq "0"; |
|
|
my $color; |
my $color; |
if ($resource->is_problem() && ($resource->countParts() <= 1 || $part ne '') ) { |
my $info = ''; |
|
if ($resource->is_problem() || $resource->is_practice()) { |
$color = $colormap{$resource->status}; |
$color = $colormap{$resource->status}; |
|
|
if (dueInLessThen24Hours($resource, $part) || |
if (dueInLessThan24Hours($resource, $part) || |
lastTry($resource, $part)) { |
lastTry($resource, $part)) { |
$color = $hurryUpColor; |
$color = $hurryUpColor; |
|
$info = ' title="'.&mt('Due in less than 24 hours!').'"'; |
} |
} |
} |
} |
|
|
if ($resource->kind() eq "res" && |
if ($resource->kind() eq "res" && |
$resource->is_problem() && |
$resource->is_raw_problem() && |
!$firstDisplayed) { |
!$firstDisplayed) { |
if ($color) {$result .= "<font color=\"$color\"><b>"; } |
if ($color) {$result .= '<span style="color:'.$color.'"'.$info.'><b>'; } |
$result .= getDescription($resource, $part); |
$result .= getDescription($resource, $part); |
if ($color) {$result .= "</b></font>"; } |
if ($color) {$result .= "</b></span>"; } |
|
} |
|
if ($resource->is_map() && &advancedUser() && $resource->randompick()) { |
|
$result .= &mt('(randomly select [_1])', $resource->randompick()); |
} |
} |
if ($resource->is_map() && advancedUser() && $resource->randompick()) { |
if ($resource->is_map() && &advancedUser() && $resource->randomorder()) { |
$result .= '(randomly select ' . $resource->randompick() .')'; |
$result .= &mt('(randomly ordered)'); |
} |
} |
|
|
|
# Debugging code |
|
#$result .= " " . $resource->awarded($part) . '/' . $resource->weight($part) . |
|
# ' - Part: ' . $part; |
|
|
|
$result .= "</td>\n"; |
|
|
return $result; |
return $result; |
} |
} |
|
|
|
# Colors obtained by taking the icons, matching the colors, and |
|
# possibly reducing the Value (HSV) of the color, if it's too bright |
|
# for text, generally by one third or so. |
|
my %statusColors = |
|
( |
|
$resObj->CLOSED => '#000000', |
|
$resObj->OPEN => '#998b13', |
|
$resObj->CORRECT => '#26933f', |
|
$resObj->INCORRECT => '#c48207', |
|
$resObj->ATTEMPTED => '#a87510', |
|
$resObj->ERROR => '#000000' |
|
); |
|
my %statusStrings = |
|
( |
|
$resObj->CLOSED => 'Not yet open', |
|
$resObj->OPEN => 'Open', |
|
$resObj->CORRECT => 'Correct', |
|
$resObj->INCORRECT => 'Incorrect', |
|
$resObj->ATTEMPTED => 'Attempted', |
|
$resObj->ERROR => 'Network Error' |
|
); |
|
my @statuses = ($resObj->CORRECT, $resObj->ATTEMPTED, $resObj->INCORRECT, $resObj->OPEN, $resObj->CLOSED, $resObj->ERROR); |
|
|
|
sub render_parts_summary_status { |
|
my ($resource, $part, $params) = @_; |
|
if (!$resource->is_problem() && !$resource->contains_problem) { return '<td></td>'; } |
|
if ($params->{showParts}) { |
|
return '<td></td>'; |
|
} |
|
|
|
my $td = "<td align='right'>\n"; |
|
my $endtd = "</td>\n"; |
|
my @probs; |
|
|
|
if ($resource->contains_problem) { |
|
@probs=$resource->retrieveResources($resource,sub { $_[0]->is_problem() },1,0); |
|
} else { |
|
@probs=($resource); |
|
} |
|
my $return; |
|
my %overallstatus; |
|
my $totalParts; |
|
foreach my $resource (@probs) { |
|
# If there is a single part, just show the simple status |
|
if ($resource->singlepart()) { |
|
my $status = $resource->simpleStatus(${$resource->parts}[0]); |
|
$overallstatus{$status}++; |
|
$totalParts++; |
|
next; |
|
} |
|
# Now we can be sure the $part doesn't really matter. |
|
my $statusCount = $resource->simpleStatusCount(); |
|
my @counts; |
|
foreach my $status (@statuses) { |
|
# decouple display order from the simpleStatusCount order |
|
my $slot = Apache::lonnavmaps::resource::statusToSlot($status); |
|
if ($statusCount->[$slot]) { |
|
$overallstatus{$status}+=$statusCount->[$slot]; |
|
$totalParts+=$statusCount->[$slot]; |
|
} |
|
} |
|
} |
|
$return.= $td . $totalParts . ' parts: '; |
|
foreach my $status (@statuses) { |
|
if ($overallstatus{$status}) { |
|
$return.='<span style="color:' . $statusColors{$status} |
|
. '">' . $overallstatus{$status} . ' ' |
|
. $statusStrings{$status} . '</span>'; |
|
} |
|
} |
|
$return.= $endtd; |
|
return $return; |
|
} |
|
|
my @preparedColumns = (\&render_resource, \&render_communication_status, |
my @preparedColumns = (\&render_resource, \&render_communication_status, |
\&render_quick_status, \&render_long_status); |
\&render_quick_status, \&render_long_status, |
|
\&render_parts_summary_status); |
|
|
sub setDefault { |
sub setDefault { |
my ($val, $default) = @_; |
my ($val, $default) = @_; |
Line 1041 sub setDefault {
|
Line 1255 sub setDefault {
|
return $val; |
return $val; |
} |
} |
|
|
|
sub cmp_title { |
|
my ($atitle,$btitle) = (lc($_[0]->compTitle),lc($_[1]->compTitle)); |
|
$atitle=~s/^\s*//; |
|
$btitle=~s/^\s*//; |
|
return $atitle cmp $btitle; |
|
} |
|
|
sub render { |
sub render { |
my $args = shift; |
my $args = shift; |
&Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); |
&Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING}); |
my $result = ''; |
my $result = ''; |
|
|
# Configure the renderer. |
# Configure the renderer. |
my $cols = $args->{'cols'}; |
my $cols = $args->{'cols'}; |
if (!defined($cols)) { |
if (!defined($cols)) { |
# no columns, no nav maps. |
# no columns, no nav maps. |
return ''; |
return ''; |
} |
} |
my $mustCloseNavMap = 0; |
|
my $navmap; |
my $navmap; |
if (defined($args->{'navmap'})) { |
if (defined($args->{'navmap'})) { |
$navmap = $args->{'navmap'}; |
$navmap = $args->{'navmap'}; |
Line 1063 sub render {
|
Line 1282 sub render {
|
my $jump = $args->{'jump'}; |
my $jump = $args->{'jump'}; |
my $here = $args->{'here'}; |
my $here = $args->{'here'}; |
my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0); |
my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0); |
|
my $closeAllPages = setDefault($args->{'closeAllPages'}, 0); |
my $currentJumpDelta = 2; # change this to change how many resources are displayed |
my $currentJumpDelta = 2; # change this to change how many resources are displayed |
# before the current resource when using #current |
# before the current resource when using #current |
|
|
Line 1072 sub render {
|
Line 1292 sub render {
|
# marker |
# marker |
my $filterHash = {}; |
my $filterHash = {}; |
# Figure out what we're not displaying |
# Figure out what we're not displaying |
foreach (split(/\,/, $ENV{"form.filter"})) { |
foreach my $item (split(/\,/, $env{"form.filter"})) { |
if ($_) { |
if ($item) { |
$filterHash->{$_} = "1"; |
$filterHash->{$item} = "1"; |
} |
} |
} |
} |
|
|
Line 1092 sub render {
|
Line 1312 sub render {
|
} |
} |
|
|
my $condition = 0; |
my $condition = 0; |
if ($ENV{'form.condition'}) { |
if ($env{'form.condition'}) { |
$condition = 1; |
$condition = 1; |
} |
} |
|
|
if (!$ENV{'form.folderManip'} && !defined($args->{'iterator'})) { |
if (!$env{'form.folderManip'} && !defined($args->{'iterator'})) { |
# 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(); |
$ENV{"request.course.fn"}.".db", |
if (!defined($navmap)) { |
$ENV{"request.course.fn"}."_parms.db", 1, 1); |
# no longer in course |
$mustCloseNavMap = 1; |
return '<span class="LC_error">'.&mt('No course selected').'</span><br /> |
} |
<a href="/adm/roles">'.&mt('Select a course').'</a><br />'; |
$navmap->init(); |
} |
|
} |
|
|
# Step two: Locate what kind of here marker is necessary |
# Step two: Locate what kind of here marker is necessary |
# Determine where the "here" marker is and where the screen jumps to. |
# Determine where the "here" marker is and where the screen jumps to. |
|
|
if ($ENV{'form.postsymb'}) { |
if ($env{'form.postsymb'} ne '') { |
$here = $jump = $ENV{'form.postsymb'}; |
$here = $jump = &Apache::lonnet::symbclean($env{'form.postsymb'}); |
} elsif ($ENV{'form.postdata'}) { |
} elsif ($env{'form.postdata'} ne '') { |
# couldn't find a symb, is there a URL? |
# couldn't find a symb, is there a URL? |
my $currenturl = $ENV{'form.postdata'}; |
my $currenturl = $env{'form.postdata'}; |
#$currenturl=~s/^http\:\/\///; |
#$currenturl=~s/^http\:\/\///; |
#$currenturl=~s/^[^\/]+//; |
#$currenturl=~s/^[^\/]+//; |
|
|
$here = $jump = &Apache::lonnet::symbread($currenturl); |
$here = $jump = &Apache::lonnet::symbread($currenturl); |
} |
} |
|
if ($here eq '') { |
|
my $last; |
|
if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db', |
|
&GDBM_READER(),0640)) { |
|
$last=$hash{'last_known'}; |
|
untie(%hash); |
|
} |
|
if ($last) { $here = $jump = $last; } |
|
} |
|
|
# Step three: Ensure the folders are open |
# Step three: Ensure the folders are open |
my $mapIterator = $navmap->getIterator(undef, undef, undef, 1); |
my $mapIterator = $navmap->getIterator(undef, undef, undef, 1); |
my $depth = 1; |
my $curRes; |
$mapIterator->next(); # discard the first BEGIN_MAP |
|
my $curRes = $mapIterator->next(); |
|
my $found = 0; |
my $found = 0; |
|
|
# We only need to do this if we need to open the maps to show the |
# We only need to do this if we need to open the maps to show the |
# current position. This will change the counter so we can't count |
# current position. This will change the counter so we can't count |
# for the jump marker with this loop. |
# for the jump marker with this loop. |
while ($depth > 0 && !$found) { |
while ($here && ($curRes = $mapIterator->next()) && !$found) { |
if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } |
|
if ($curRes == $mapIterator->END_MAP()) { $depth--; } |
|
|
|
if (ref($curRes) && $curRes->symb() eq $here) { |
if (ref($curRes) && $curRes->symb() eq $here) { |
my $mapStack = $mapIterator->getStack(); |
my $mapStack = $mapIterator->getStack(); |
|
|
Line 1147 sub render {
|
Line 1372 sub render {
|
} |
} |
$found = 1; |
$found = 1; |
} |
} |
|
|
$curRes = $mapIterator->next(); |
|
} |
} |
} |
} |
|
|
if ( !defined($args->{'iterator'}) && $ENV{'form.folderManip'} ) { # we came from a user's manipulation of the nav page |
if ( !defined($args->{'iterator'}) && $env{'form.folderManip'} ) { # we came from a user's manipulation of the nav page |
# If this is a click on a folder or something, we want to preserve the "here" |
# If this is a click on a folder or something, we want to preserve the "here" |
# from the querystring, and get the new "jump" marker |
# from the querystring, and get the new "jump" marker |
$here = $ENV{'form.here'}; |
$here = $env{'form.here'}; |
$jump = $ENV{'form.jump'}; |
$jump = $env{'form.jump'}; |
} |
} |
|
|
my $it = $args->{'iterator'}; |
my $it = $args->{'iterator'}; |
if (!defined($it)) { |
if (!defined($it)) { |
# Construct a default iterator based on $ENV{'form.'} information |
# Construct a default iterator based on $env{'form.'} information |
|
|
# 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($r, |
$navmap = Apache::lonnavmaps::navmap->new(); |
$ENV{"request.course.fn"}.".db", |
if (!defined($navmap)) { |
$ENV{"request.course.fn"}."_parms.db", 1, 1); |
# no longer in course |
$mustCloseNavMap = 1; |
return '<span class="LC_error">'.&mt('No course selected').'</span><br /> |
|
<a href="/adm/roles">'.&mt('Select a course').'</a><br />'; |
|
} |
} |
} |
# Paranoia: Make sure it's ready |
|
$navmap->init(); |
|
|
|
# See if we're being passed a specific map |
# See if we're being passed a specific map |
if ($args->{'iterator_map'}) { |
if ($args->{'iterator_map'}) { |
Line 1182 sub render {
|
Line 1405 sub render {
|
|
|
$args->{'iterator'} = $it = $navmap->getIterator($firstResource, $finishResource, $filterHash, $condition); |
$args->{'iterator'} = $it = $navmap->getIterator($firstResource, $finishResource, $filterHash, $condition); |
} else { |
} else { |
$args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition); |
$args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition,undef,$args->{'include_top_level_map'}); |
} |
} |
} |
} |
|
|
# (re-)Locate the jump point, if any |
# (re-)Locate the jump point, if any |
# Note this does not take filtering or hidden into account... need |
# Note this does not take filtering or hidden into account... need |
# to be fixed? |
# to be fixed? |
my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0); |
my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0); |
my $depth = 1; |
my $curRes; |
$mapIterator->next(); |
|
my $curRes = $mapIterator->next(); |
|
my $foundJump = 0; |
my $foundJump = 0; |
my $counter = 0; |
my $counter = 0; |
|
|
while ($depth > 0 && !$foundJump) { |
while (($curRes = $mapIterator->next()) && !$foundJump) { |
if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; } |
|
if ($curRes == $mapIterator->END_MAP()) { $depth--; } |
|
if (ref($curRes)) { $counter++; } |
if (ref($curRes)) { $counter++; } |
|
|
if (ref($curRes) && $jump eq $curRes->symb()) { |
if (ref($curRes) && $jump eq $curRes->symb()) { |
Line 1209 sub render {
|
Line 1428 sub render {
|
$args->{'currentJumpIndex'} = $counter; |
$args->{'currentJumpIndex'} = $counter; |
$foundJump = 1; |
$foundJump = 1; |
} |
} |
|
|
$curRes = $mapIterator->next(); |
|
} |
} |
|
|
my $showParts = setDefault($args->{'showParts'}, 1); |
my $showParts = setDefault($args->{'showParts'}, 1); |
Line 1221 sub render {
|
Line 1438 sub render {
|
my $printKey = $args->{'printKey'}; |
my $printKey = $args->{'printKey'}; |
my $printCloseAll = $args->{'printCloseAll'}; |
my $printCloseAll = $args->{'printCloseAll'}; |
if (!defined($printCloseAll)) { $printCloseAll = 1; } |
if (!defined($printCloseAll)) { $printCloseAll = 1; } |
|
|
# Print key? |
# Print key? |
if ($printKey) { |
if ($printKey) { |
$result .= '<table border="0" cellpadding="2" cellspacing="0">'; |
$result .= '<table border="0" cellpadding="2" cellspacing="0">'; |
my $date=localtime; |
|
$result.='<tr><td align="right" valign="bottom">Key: </td>'; |
$result.='<tr><td align="right" valign="bottom">Key: </td>'; |
|
my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc"); |
if ($navmap->{LAST_CHECK}) { |
if ($navmap->{LAST_CHECK}) { |
$result .= |
$result .= |
'<img src="/adm/lonMisc/chat.gif"> 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="/adm/lonMisc/feedback.gif"> 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="/adm/lonMisc/chat.gif"> Discussions</td><td align="center" valign="bottom">'. |
'<img src="'.$location.'/chat.gif" alt="" /> '.&mt('Discussions').'</td><td align="center" valign="bottom">'. |
' <img src="/adm/lonMisc/feedback.gif"> New message (click to open)'. |
' <img src="'.$location.'/feedback.gif" alt="" /> '.&mt('New message (click to open)'). |
'</td>'; |
'</td>'; |
} |
} |
|
|
Line 1245 sub render {
|
Line 1462 sub render {
|
} |
} |
|
|
if ($printCloseAll && !$args->{'resource_no_folder_link'}) { |
if ($printCloseAll && !$args->{'resource_no_folder_link'}) { |
|
my ($link,$text); |
if ($condition) { |
if ($condition) { |
$result.="<a href=\"navmaps?condition=0&filter=&$queryString" . |
$link='navmaps?condition=0&filter=&'.$queryString. |
"&here=" . Apache::lonnet::escape($here) . |
'&here='.&escape($here); |
"\">Close All Folders</a>"; |
$text='Close all folders'; |
} else { |
} else { |
$result.="<a href=\"navmaps?condition=1&filter=&$queryString" . |
$link='navmaps?condition=1&filter=&'.$queryString. |
"&here=" . Apache::lonnet::escape($here) . |
'&here='.&escape($here); |
"\">Open All Folders</a>"; |
$text='Open all folders'; |
|
} |
|
if ($env{'form.register'}) { |
|
$link .= '&register='.$env{'form.register'}; |
|
} |
|
if ($args->{'caller'} eq 'navmapsdisplay') { |
|
unless ($args->{'notools'}) { |
|
&add_linkitem($args->{'linkitems'},'changefolder', |
|
"location.href='$link'",$text); |
|
} |
|
} else { |
|
$result.= '<a href="'.$link.'">'.&mt($text).'</a>'; |
|
} |
|
$result .= "\n"; |
|
} |
|
|
|
# Check for any unread discussions in all resources. |
|
if (($args->{'caller'} eq 'navmapsdisplay') && (!$args->{'notools'})) { |
|
&add_linkitem($args->{'linkitems'},'clearbubbles', |
|
'document.clearbubbles.submit()', |
|
'Mark all posts read'); |
|
my $time=time; |
|
my $querystr = &HTML::Entities::encode($ENV{'QUERY_STRING'},'<>&"'); |
|
$result .= (<<END); |
|
<form name="clearbubbles" method="post" action="/adm/feedback"> |
|
<input type="hidden" name="navurl" value="$querystr" /> |
|
<input type="hidden" name="navtime" value="$time" /> |
|
END |
|
if ($env{'form.register'}) { |
|
$result .= '<input type="hidden" name="register" value="'.$env{'form.register'}.'" />'; |
|
} |
|
if ($args->{'sort'} eq 'discussion') { |
|
my $totdisc = 0; |
|
my $haveDisc = ''; |
|
my @allres=$navmap->retrieveResources(); |
|
foreach my $resource (@allres) { |
|
if ($resource->hasDiscussion()) { |
|
$haveDisc .= $resource->wrap_symb().':'; |
|
$totdisc ++; |
|
} |
|
} |
|
if ($totdisc > 0) { |
|
$haveDisc =~ s/:$//; |
|
$result .= (<<END); |
|
<input type="hidden" name="navmaps" value="$haveDisc" /> |
|
</form> |
|
END |
|
} |
|
} |
|
$result.='</form>'; |
|
} |
|
if (($args->{'caller'} eq 'navmapsdisplay') && |
|
(&Apache::lonnet::allowed('mdc',$env{'request.course.id'}))) { |
|
my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; |
|
my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; |
|
if ($env{'course.'.$env{'request.course.id'}.'.url'} eq |
|
"uploaded/$cdom/$cnum/default.sequence") { |
|
&add_linkitem($args->{'linkitems'},'edittoplevel', |
|
"javascript:gocmd('/adm/coursedocs','editdocs');", |
|
'Content Editor'); |
} |
} |
$result .= "<br /><br />\n"; |
} |
} |
|
|
|
|
if ($args->{'caller'} eq 'navmapsdisplay') { |
|
$result .= &show_linkitems_toolbar($args,$condition); |
|
} elsif ($args->{'sort_html'}) { |
|
$result.=$args->{'sort_html'}; |
|
} |
|
|
|
#$result .= "<br />\n"; |
if ($r) { |
if ($r) { |
$r->print($result); |
$r->print($result); |
$r->rflush(); |
$r->rflush(); |
$result = ""; |
$result = ""; |
} |
} |
# End parameter setting |
# End parameter setting |
|
|
|
$result .= "<br />\n"; |
|
|
# Data |
# Data |
$result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n"; |
$result.=&Apache::loncommon::start_data_table("LC_tableOfContent"); |
|
|
my $res = "Apache::lonnavmaps::resource"; |
my $res = "Apache::lonnavmaps::resource"; |
my %condenseStatuses = |
my %condenseStatuses = |
( $res->NETWORK_FAILURE => 1, |
( $res->NETWORK_FAILURE => 1, |
$res->NOTHING_SET => 1, |
$res->NOTHING_SET => 1, |
$res->CORRECT => 1 ); |
$res->CORRECT => 1 ); |
my @backgroundColors = ("#FFFFFF", "#F6F6F6"); |
|
|
|
# Shared variables |
# Shared variables |
$args->{'counter'} = 0; # counts the rows |
$args->{'counter'} = 0; # counts the rows |
$args->{'indentLevel'} = 0; |
$args->{'indentLevel'} = 0; |
$args->{'isNewBranch'} = 0; |
$args->{'isNewBranch'} = 0; |
$args->{'condensed'} = 0; |
$args->{'condensed'} = 0; |
$args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='/adm/lonIcons/whitespace1.gif' width='25' height='1' alt='' border='0' />"); |
|
|
my $location = &Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace_21.gif"); |
|
$args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='$location' alt='' />"); |
$args->{'displayedHereMarker'} = 0; |
$args->{'displayedHereMarker'} = 0; |
|
|
# If we're suppressing empty sequences, look for them here. Use DFS for speed, |
# If we're suppressing empty sequences, look for them here. Use DFS for speed, |
Line 1288 sub render {
|
Line 1575 sub render {
|
$it->{FIRST_RESOURCE}, |
$it->{FIRST_RESOURCE}, |
$it->{FINISH_RESOURCE}, |
$it->{FINISH_RESOURCE}, |
{}, undef, 1); |
{}, undef, 1); |
$depth = 0; |
my $depth = 0; |
$dfsit->next(); |
$dfsit->next(); |
my $curRes = $dfsit->next(); |
my $curRes = $dfsit->next(); |
while ($depth > -1) { |
while ($depth > -1) { |
Line 1320 sub render {
|
Line 1607 sub render {
|
|
|
my $displayedJumpMarker = 0; |
my $displayedJumpMarker = 0; |
# Set up iteration. |
# Set up iteration. |
$depth = 1; |
|
$it->next(); # discard initial BEGIN_MAP |
|
$curRes = $it->next(); |
|
my $now = time(); |
my $now = time(); |
my $in24Hours = $now + 24 * 60 * 60; |
my $in24Hours = $now + 24 * 60 * 60; |
my $rownum = 0; |
my $rownum = 0; |
Line 1330 sub render {
|
Line 1614 sub render {
|
# export "here" marker information |
# export "here" marker information |
$args->{'here'} = $here; |
$args->{'here'} = $here; |
|
|
while ($depth > 0) { |
$args->{'indentLevel'} = -1; # first BEGIN_MAP takes this to 0 |
if ($curRes == $it->BEGIN_MAP()) { $depth++; } |
my @resources; |
if ($curRes == $it->END_MAP()) { $depth--; } |
my $code='';# sub { !(shift->is_map();) }; |
|
if ($args->{'sort'} eq 'title') { |
|
my $oldFilterFunc = $filterFunc; |
|
my $filterFunc= |
|
sub { |
|
my ($res)=@_; |
|
if ($res->is_map()) { return 0;} |
|
return &$oldFilterFunc($res); |
|
}; |
|
@resources=$navmap->retrieveResources(undef,$filterFunc); |
|
@resources= sort { &cmp_title($a,$b) } @resources; |
|
} elsif ($args->{'sort'} eq 'duedate') { |
|
my $oldFilterFunc = $filterFunc; |
|
my $filterFunc= |
|
sub { |
|
my ($res)=@_; |
|
if (!$res->is_problem()) { return 0;} |
|
return &$oldFilterFunc($res); |
|
}; |
|
@resources=$navmap->retrieveResources(undef,$filterFunc); |
|
@resources= sort { |
|
if ($a->duedate ne $b->duedate) { |
|
return $a->duedate cmp $b->duedate; |
|
} |
|
my $value=&cmp_title($a,$b); |
|
return $value; |
|
} @resources; |
|
} elsif ($args->{'sort'} eq 'discussion') { |
|
my $oldFilterFunc = $filterFunc; |
|
my $filterFunc= |
|
sub { |
|
my ($res)=@_; |
|
if (!$res->hasDiscussion() && |
|
!$res->getFeedback() && |
|
!$res->getErrors()) { return 0;} |
|
return &$oldFilterFunc($res); |
|
}; |
|
@resources=$navmap->retrieveResources(undef,$filterFunc); |
|
@resources= sort { &cmp_title($a,$b) } @resources; |
|
} else { |
|
#unknow sort mechanism or default |
|
undef($args->{'sort'}); |
|
} |
|
|
|
|
|
while (1) { |
|
if ($args->{'sort'}) { |
|
$curRes = shift(@resources); |
|
} else { |
|
$curRes = $it->next($closeAllPages); |
|
} |
|
if (!$curRes) { last; } |
|
|
# Maintain indentation level. |
# Maintain indentation level. |
if ($curRes == $it->BEGIN_MAP() || |
if ($curRes == $it->BEGIN_MAP() || |
Line 1383 sub render {
|
Line 1718 sub render {
|
$args->{'multipart'} = $curRes->multipart(); |
$args->{'multipart'} = $curRes->multipart(); |
|
|
if ($condenseParts) { # do the condensation |
if ($condenseParts) { # do the condensation |
if (!$curRes->opendate("0")) { |
|
@parts = (); |
|
$args->{'condensed'} = 1; |
|
} |
|
if (!$args->{'condensed'}) { |
if (!$args->{'condensed'}) { |
# Decide whether to condense based on similarity |
# Decide whether to condense based on similarity |
my $status = $curRes->status($parts[0]); |
my $status = $curRes->status($parts[0]); |
Line 1436 sub render {
|
Line 1767 sub render {
|
# Add part 0 so we display it correctly. |
# Add part 0 so we display it correctly. |
unshift @parts, '0'; |
unshift @parts, '0'; |
} |
} |
|
|
|
{ |
|
my ($src,$symb,$anchor,$stack); |
|
if ($args->{'sort'}) { |
|
my $it = $navmap->getIterator(undef, undef, undef, 1); |
|
while ( my $res=$it->next()) { |
|
if (ref($res) && |
|
$res->symb() eq $curRes->symb()) { last; } |
|
} |
|
$stack=$it->getStack(); |
|
} else { |
|
$stack=$it->getStack(); |
|
} |
|
($src,$symb,$anchor)=getLinkForResource($stack); |
|
if (defined($anchor)) { $anchor='#'.$anchor; } |
|
my $srcHasQuestion = $src =~ /\?/; |
|
$args->{"resourceLink"} = $src. |
|
($srcHasQuestion?'&':'?') . |
|
'symb=' . &escape($symb).$anchor; |
|
} |
# Now, we've decided what parts to show. Loop through them and |
# Now, we've decided what parts to show. Loop through them and |
# show them. |
# show them. |
foreach my $part (@parts) { |
foreach my $part (@parts) { |
$rownum ++; |
$rownum ++; |
my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)]; |
|
|
|
$result .= " <tr bgcolor='$backgroundColor'>\n"; |
$result .= &Apache::loncommon::start_data_table_row(); |
|
|
# Set up some data about the parts that the cols might want |
# Set up some data about the parts that the cols might want |
my $filter = $it->{FILTER}; |
my $filter = $it->{FILTER}; |
my $stack = $it->getStack(); |
|
my $src = getLinkForResource($stack); |
|
|
|
my $srcHasQuestion = $src =~ /\?/; |
|
$args->{"resourceLink"} = $src. |
|
($srcHasQuestion?'&':'?') . |
|
'symb=' . &Apache::lonnet::escape($curRes->symb()); |
|
|
|
# Now, display each column. |
# Now, display each column. |
foreach my $col (@$cols) { |
foreach my $col (@$cols) { |
my $colHTML = ''; |
my $colHTML = ''; |
Line 1476 sub render {
|
Line 1818 sub render {
|
} |
} |
$result .= $colHTML . "\n"; |
$result .= $colHTML . "\n"; |
} |
} |
$result .= " </tr>\n"; |
$result .= &Apache::loncommon::end_data_table_row(); |
$args->{'isNewBranch'} = 0; |
$args->{'isNewBranch'} = 0; |
} |
} |
|
|
Line 1486 sub render {
|
Line 1828 sub render {
|
$r->rflush(); |
$r->rflush(); |
} |
} |
} continue { |
} continue { |
$curRes = $it->next(); |
if ($r) { |
|
# If we have the connection, make sure the user is still connected |
|
my $c = $r->connection; |
|
if ($c->aborted()) { |
|
# Who cares what we do, nobody will see it anyhow. |
|
return ''; |
|
} |
|
} |
} |
} |
|
|
|
$result.=&Apache::loncommon::end_data_table(); |
|
|
# Print out the part that jumps to #curloc if it exists |
# Print out the part that jumps to #curloc if it exists |
# delay needed because the browser is processing the jump before |
# delay needed because the browser is processing the jump before |
Line 1497 sub render {
|
Line 1848 sub render {
|
# it's quite likely this might fix other browsers, too, and |
# it's quite likely this might fix other browsers, too, and |
# certainly won't hurt anything. |
# certainly won't hurt anything. |
if ($displayedJumpMarker) { |
if ($displayedJumpMarker) { |
$result .= "<script>setTimeout(\"location += '#curloc';\", 0)</script>\n"; |
$result .= &Apache::lonhtmlcommon::scripttag(" |
|
if (location.href.indexOf('#curloc')==-1) { |
|
setTimeout(\"location += '#curloc';\", 0) |
|
} |
|
"); |
} |
} |
|
|
$result .= "</table>"; |
|
|
|
if ($r) { |
if ($r) { |
$r->print($result); |
$r->print($result); |
$result = ""; |
$result = ""; |
$r->rflush(); |
$r->rflush(); |
} |
} |
|
|
if ($mustCloseNavMap) { $navmap->untieHashes(); } |
return $result; |
|
} |
|
|
|
sub add_linkitem { |
|
my ($linkitems,$name,$cmd,$text)=@_; |
|
$$linkitems{$name}{'cmd'}=$cmd; |
|
$$linkitems{$name}{'text'}=&mt($text); |
|
} |
|
|
|
sub show_linkitems_toolbar { |
|
my ($args,$condition) = @_; |
|
my $result; |
|
if (ref($args) eq 'HASH') { |
|
if (ref($args->{'linkitems'}) eq 'HASH') { |
|
my $numlinks = scalar(keys(%{$args->{'linkitems'}})); |
|
if ($numlinks > 1) { |
|
$result = '<td>'. |
|
&Apache::loncommon::help_open_menu('Navigation Screen','Navigation_Screen', |
|
undef,'RAT'). |
|
'</td>'. |
|
'<td> </td>'. |
|
'<td class="LC_middle">'.&mt('Tools:').'</td>'; |
|
} |
|
$result .= '<td align="left">'."\n". |
|
'<ul id="LC_toolbar">'; |
|
my @linkorder = ('firsthomework','everything','uncompleted', |
|
'changefolder','clearbubbles','edittoplevel'); |
|
foreach my $link (@linkorder) { |
|
if (ref($args->{'linkitems'}{$link}) eq 'HASH') { |
|
if ($args->{'linkitems'}{$link}{'text'} ne '') { |
|
$args->{'linkitems'}{$link}{'cmd'}=~s/"/'/g; |
|
if ($args->{'linkitems'}{$link}{'cmd'}) { |
|
my $link_id = 'LC_content_toolbar_'.$link; |
|
if ($link eq 'changefolder') { |
|
if ($condition) { |
|
$link_id='LC_content_toolbar_changefolder_toggled'; |
|
} else { |
|
$link_id='LC_content_toolbar_changefolder'; |
|
} |
|
} |
|
$result .= '<li><a href="#" '. |
|
'onclick="'.$args->{'linkitems'}{$link}{'cmd'}.'" '. |
|
'id="'.$link_id.'" '. |
|
'class="LC_toolbarItem" '. |
|
'title="'.$args->{'linkitems'}{$link}{'text'}.'">'. |
|
'</a></li>'."\n"; |
|
} |
|
} |
|
} |
|
} |
|
$result .= '</ul>'. |
|
'</td>'; |
|
if (($numlinks==1) && (exists($args->{'linkitems'}{'edittoplevel'}))) { |
|
$result .= '<td><a href="'.$args->{'linkitems'}{'edittoplevel'}{'cmd'}.'">'. |
|
&mt('Content Editor').'</a></td>'; |
|
} |
|
} |
|
if ($args->{'sort_html'}) { |
|
$result .= '<td> </td><td> </td><td> </td>'. |
|
'<td align="right">'.$args->{'sort_html'}.'</td>'; |
|
} |
|
} |
|
if ($result) { |
|
$result = "<table><tr>$result</tr></table>"; |
|
} |
return $result; |
return $result; |
} |
} |
|
|
1; |
1; |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
package Apache::lonnavmaps::navmap; |
package Apache::lonnavmaps::navmap; |
|
|
=pod |
=pod |
|
|
lonnavmaps provides functions and objects for dealing with the |
=head1 Object: Apache::lonnavmaps::navmap |
compiled course hashes generated when a user enters the course, the |
|
Apache handler for the "Navigation Map" button, and a flexible |
|
prepared renderer for navigation maps that are easy to use anywhere. |
|
|
|
=head1 Object: navmap |
=head2 Overview |
|
|
Encapsulating the compiled nav map |
The navmap object's job is to provide access to the resources |
|
in the course as Apache::lonnavmaps::resource objects, and to |
|
query and manage the relationship between those resource objects. |
|
|
navmap is an object that encapsulates a compiled course map and |
Generally, you'll use the navmap object in one of three basic ways. |
provides a reasonable interface to it. |
In order of increasing complexity and power: |
|
|
Most notably it provides a way to navigate the map sensibly and a |
=over 4 |
flexible iterator that makes it easy to write various renderers based |
|
on nav maps. |
|
|
|
You must obtain resource objects through the navmap object. |
=item * C<$navmap-E<gt>getByX>, where X is B<Id>, B<Symb> or B<MapPc> and getResourceByUrl. This provides |
|
various ways to obtain resource objects, based on various identifiers. |
|
Use this when you want to request information about one object or |
|
a handful of resources you already know the identities of, from some |
|
other source. For more about Ids, Symbs, and MapPcs, see the |
|
Resource documentation. Note that Url should be a B<last resort>, |
|
not your first choice; it only really works when there is only one |
|
instance of the resource in the course, which only applies to |
|
maps, and even that may change in the future (see the B<getResourceByUrl> |
|
documentation for more details.) |
|
|
|
=item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This |
|
retrieves resources matching some criterion and returns them |
|
in a flat array, with no structure information. Use this when |
|
you are manipulating a series of resources, based on what map |
|
the are in, but do not care about branching, or exactly how |
|
the maps and resources are related. This is the most common case. |
|
|
|
=item * C<$it = $navmap-E<gt>getIterator(args)>. This allows you traverse |
|
the course's navmap in various ways without writing the traversal |
|
code yourself. See iterator documentation below. Use this when |
|
you need to know absolutely everything about the course, including |
|
branches and the precise relationship between maps and resources. |
|
|
=head2 Methods |
=back |
|
|
|
=head2 Creation And Destruction |
|
|
|
To create a navmap object, use the following function: |
|
|
=over 4 |
=over 4 |
|
|
=item * B<new>(navHashFile, parmHashFile, genCourseAndUserOptions, |
=item * B<Apache::lonnavmaps::navmap-E<gt>new>(): |
genMailDiscussStatus): |
|
|
|
Binds a new navmap object to the compiled nav map hash and parm hash |
Creates a new navmap object. Returns the navmap object if this is |
given as filenames. genCourseAndUserOptions is a flag saying whether |
successful, or B<undef> if not. |
the course options and user options hash should be generated. This is |
|
for when you are using the parameters of the resources that require |
=back |
them; see documentation in resource object |
|
documentation. genMailDiscussStatus causes the nav map to retreive |
=head2 Methods |
information about the email and discussion status of |
|
resources. Returns the navmap object if this is successful, or |
=over 4 |
B<undef> if not. You must check for undef; errors will occur when you |
|
try to use the other methods otherwise. |
|
|
|
=item * B<getIterator>(first, finish, filter, condition): |
=item * B<getIterator>(first, finish, filter, condition): |
|
|
Line 1563 See iterator documentation below.
|
Line 2007 See iterator documentation below.
|
|
|
use strict; |
use strict; |
use GDBM_File; |
use GDBM_File; |
|
use Apache::lonnet; |
|
use LONCAPA; |
|
|
sub new { |
sub new { |
# magic invocation to create a class instance |
# magic invocation to create a class instance |
my $proto = shift; |
my $proto = shift; |
my $class = ref($proto) || $proto; |
my $class = ref($proto) || $proto; |
my $self = {}; |
my $self = {}; |
|
bless($self); # So we can call change_user if neceesary |
|
|
|
$self->{USERNAME} = shift || $env{'user.name'}; |
|
$self->{DOMAIN} = shift || $env{'user.domain'}; |
|
$self->{CODE} = shift; |
|
$self->{NOHIDE} = shift; |
|
|
|
|
$self->{NAV_HASH_FILE} = shift; |
|
$self->{PARM_HASH_FILE} = shift; |
|
$self->{GENERATE_COURSE_USER_OPT} = shift; |
|
$self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift; |
|
|
|
# Resource cache stores navmap resources as we reference them. We generate |
# Resource cache stores navmap resources as we reference them. We generate |
# them on-demand so we don't pay for creating resources unless we use them. |
# them on-demand so we don't pay for creating resources unless we use them. |
Line 1583 sub new {
|
Line 2032 sub new {
|
# failed |
# failed |
$self->{NETWORK_FAILURE} = 0; |
$self->{NETWORK_FAILURE} = 0; |
|
|
# tie the nav hash |
# We can only tie the nav hash as done below if the username/domain |
|
# match the env one. Otherwise change_user does everything we need...since we can't |
|
# assume there are course hashes for the specific requested user@domamin: |
|
# |
|
|
|
if (($self->{USERNAME} eq $env{'user.name'}) && ($self->{DOMAIN} eq $env{'user.domain'}) && !$self->{CODE}) { |
|
|
|
# tie the nav hash |
|
|
|
my %navmaphash; |
|
my %parmhash; |
|
my $courseFn = $env{"request.course.fn"}; |
|
if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db", |
|
&GDBM_READER(), 0640))) { |
|
return undef; |
|
} |
|
|
|
if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db", |
|
&GDBM_READER(), 0640))) |
|
{ |
|
untie %{$self->{PARM_HASH}}; |
|
return undef; |
|
} |
|
|
|
$self->{NAV_HASH} = \%navmaphash; |
|
$self->{PARM_HASH} = \%parmhash; |
|
$self->{PARM_CACHE} = {}; |
|
} else { |
|
$self->change_user($self->{USERNAME}, $self->{DOMAIN}, $self->{CODE}, $self->{NOHIDE}); |
|
} |
|
|
|
return $self; |
|
} |
|
|
|
# |
|
# In some instances it is useful to be able to dynamically change the |
|
# username/domain associated with a navmap (e.g. to navigate for someone |
|
# else besides the current user...if sufficiently privileged. |
|
# Parameters: |
|
# user - New user. |
|
# domain- Domain the user belongs to. |
|
# code - Anonymous CODE in use. |
|
# Implicit inputs: |
|
# |
|
sub change_user { |
|
my $self = shift; |
|
$self->{USERNAME} = shift; |
|
$self->{DOMAIN} = shift; |
|
$self->{CODE} = shift; |
|
$self->{NOHIDE} = shift; |
|
|
|
# If the hashes are already tied make sure to break that bond: |
|
|
|
untie %{$self->{NAV_HASH}}; |
|
untie %{$self->{PARM_HASH}}; |
|
|
my %navmaphash; |
# The assumption is that we have to |
my %parmhash; |
# use lonmap here to re-read the hash and from it reconstruct |
if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE}, |
# new big and parameter hashes. An implicit assumption at this time |
&GDBM_READER(), 0640))) { |
# is that the course file is probably not created locally yet |
return undef; |
# an that we will therefore just read without tying. |
|
|
|
my ($cdom, $cnum) = split(/\_/, $env{'request.course.id'}); |
|
|
|
my %big_hash; |
|
&Apache::lonmap::loadmap($cnum, $cdom, $self->{USERNAME}, $self->{DOMAIN}, $self->{CODE}, $self->{NOHIDE}, \%big_hash); |
|
$self->{NAV_HASH} = \%big_hash; |
|
|
|
|
|
|
|
# Now clear the parm cache and reconstruct the parm hash fromt he big_hash |
|
# param.xxxx keys. |
|
|
|
$self->{PARM_CACHE} = {}; |
|
|
|
my %parm_hash = {}; |
|
foreach my $key (keys %big_hash) { |
|
if ($key =~ /^param\./) { |
|
my $param_key = $key; |
|
$param_key =~ s/^param\.//; |
|
$parm_hash{$param_key} = $big_hash{$key}; |
|
} |
} |
} |
|
|
|
$self->{PARM_HASH} = \%parm_hash; |
|
|
|
|
|
|
if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, |
} |
&GDBM_READER(), 0640))) |
|
{ |
sub generate_course_user_opt { |
untie %{$self->{PARM_HASH}}; |
my $self = shift; |
return undef; |
if ($self->{COURSE_USER_OPT_GENERATED}) { return; } |
|
|
|
my $uname=$self->{USERNAME}; |
|
my $udom=$self->{DOMAIN}; |
|
|
|
my $cid=$env{'request.course.id'}; |
|
my $cdom=$env{'course.'.$cid.'.domain'}; |
|
my $cnum=$env{'course.'.$cid.'.num'}; |
|
|
|
# ------------------------------------------------- Get coursedata (if present) |
|
my $courseopt=&Apache::lonnet::get_courseresdata($cnum,$cdom); |
|
# Check for network failure |
|
if (!ref($courseopt)) { |
|
if ( $courseopt =~ /no.such.host/i || $courseopt =~ /con_lost/i) { |
|
$self->{NETWORK_FAILURE} = 1; |
|
} |
|
undef($courseopt); |
} |
} |
|
|
$self->{NAV_HASH} = \%navmaphash; |
# --------------------------------------------------- Get userdata (if present) |
$self->{PARM_HASH} = \%parmhash; |
|
$self->{INITED} = 0; |
my $useropt=&Apache::lonnet::get_userresdata($uname,$udom); |
|
# Check for network failure |
|
if (!ref($useropt)) { |
|
if ( $useropt =~ /no.such.host/i || $useropt =~ /con_lost/i) { |
|
$self->{NETWORK_FAILURE} = 1; |
|
} |
|
undef($useropt); |
|
} |
|
|
bless($self); |
$self->{COURSE_OPT} = $courseopt; |
|
$self->{USER_OPT} = $useropt; |
return $self; |
|
|
$self->{COURSE_USER_OPT_GENERATED} = 1; |
|
|
|
return; |
} |
} |
|
|
sub init { |
|
|
|
|
sub generate_email_discuss_status { |
my $self = shift; |
my $self = shift; |
if ($self->{INITED}) { return; } |
my $symb = shift; |
|
if ($self->{EMAIL_DISCUSS_GENERATED}) { return; } |
|
|
# If the course opt hash and the user opt hash should be generated, |
my $cid=$env{'request.course.id'}; |
# generate them |
my $cdom=$env{'course.'.$cid.'.domain'}; |
if ($self->{GENERATE_COURSE_USER_OPT}) { |
my $cnum=$env{'course.'.$cid.'.num'}; |
my $uname=$ENV{'user.name'}; |
|
my $udom=$ENV{'user.domain'}; |
my %emailstatus = &Apache::lonnet::dump('email_status',$self->{DOMAIN},$self->{USERNAME}); |
my $uhome=$ENV{'user.home'}; |
my $logoutTime = $emailstatus{'logout'}; |
my $cid=$ENV{'request.course.id'}; |
my $courseLeaveTime = $emailstatus{'logout_'.$env{'request.course.id'}}; |
my $chome=$ENV{'course.'.$cid.'.home'}; |
$self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ? |
my ($cdom,$cnum)=split(/\_/,$cid); |
$courseLeaveTime : $logoutTime); |
|
my %discussiontime = &Apache::lonnet::dump('discussiontimes', |
my $userprefix=$uname.'_'.$udom.'_'; |
$cdom, $cnum); |
|
my %lastread = &Apache::lonnet::dump('nohist_'.$cid.'_discuss', |
my %courserdatas; my %useropt; my %courseopt; my %userrdatas; |
$self->{DOMAIN},$self->{USERNAME},'lastread'); |
unless ($uhome eq 'no_host') { |
my %lastreadtime = (); |
# ------------------------------------------------- Get coursedata (if present) |
foreach my $key (keys %lastread) { |
unless ((time-$courserdatas{$cid.'.last_cache'})<240) { |
my $shortkey = $key; |
my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum. |
$shortkey =~ s/_lastread$//; |
':resourcedata',$chome); |
$lastreadtime{$shortkey} = $lastread{$key}; |
# Check for network failure |
} |
if ( $reply =~ /no.such.host/i || $reply =~ /con_lost/i) { |
|
$self->{NETWORK_FAILURE} = 1; |
my %feedback=(); |
} elsif ($reply!~/^error\:/) { |
my %error=(); |
$courserdatas{$cid}=$reply; |
my @keys = &Apache::lonnet::getkeys('nohist_email',$self->{DOMAIN}, |
$courserdatas{$cid.'.last_cache'}=time; |
$self->{USERNAME}); |
} |
|
} |
foreach my $msgid (@keys) { |
foreach (split(/\&/,$courserdatas{$cid})) { |
if ((!$emailstatus{$msgid}) || ($emailstatus{$msgid} eq 'new')) { |
my ($name,$value)=split(/\=/,$_); |
my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid, |
$courseopt{$userprefix.&Apache::lonnet::unescape($name)}= |
$symb,$error) = &Apache::lonmsg::unpackmsgid($msgid); |
&Apache::lonnet::unescape($value); |
&Apache::lonenc::check_decrypt(\$symb); |
|
if (($fromcid ne '') && ($fromcid ne $cid)) { |
|
next; |
} |
} |
# --------------------------------------------------- Get userdata (if present) |
if (defined($symb)) { |
unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) { |
if (defined($error) && $error == 1) { |
my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome); |
$error{$symb}.=','.$msgid; |
if ($reply!~/^error\:/) { |
} else { |
$userrdatas{$uname.'___'.$udom}=$reply; |
$feedback{$symb}.=','.$msgid; |
$userrdatas{$uname.'___'.$udom.'.last_cache'}=time; |
|
} |
|
# check to see if network failed |
|
elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i ) |
|
{ |
|
$self->{NETWORK_FAILURE} = 1; |
|
} |
|
} |
|
foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) { |
|
my ($name,$value)=split(/\=/,$_); |
|
$useropt{$userprefix.&Apache::lonnet::unescape($name)}= |
|
&Apache::lonnet::unescape($value); |
|
} |
|
$self->{COURSE_OPT} = \%courseopt; |
|
$self->{USER_OPT} = \%useropt; |
|
} |
|
} |
|
|
|
if ($self->{GENERATE_EMAIL_DISCUSS_STATUS}) { |
|
my $cid=$ENV{'request.course.id'}; |
|
my ($cdom,$cnum)=split(/\_/,$cid); |
|
|
|
my %emailstatus = &Apache::lonnet::dump('email_status'); |
|
my $logoutTime = $emailstatus{'logout'}; |
|
my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}}; |
|
$self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ? |
|
$courseLeaveTime : $logoutTime); |
|
my %discussiontime = &Apache::lonnet::dump('discussiontimes', |
|
$cdom, $cnum); |
|
my %feedback=(); |
|
my %error=(); |
|
my $keys = &Apache::lonnet::reply('keys:'. |
|
$ENV{'user.domain'}.':'. |
|
$ENV{'user.name'}.':nohist_email', |
|
$ENV{'user.home'}); |
|
|
|
foreach my $msgid (split(/\&/, $keys)) { |
|
$msgid=&Apache::lonnet::unescape($msgid); |
|
my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid)); |
|
if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) { |
|
my ($what,$url)=($1,$2); |
|
my %status= |
|
&Apache::lonnet::get('email_status',[$msgid]); |
|
if ($status{$msgid}=~/^error\:/) { |
|
$status{$msgid}=''; |
|
} |
} |
|
} else { |
if (($status{$msgid} eq 'new') || |
my $plain= |
(!$status{$msgid})) { |
&LONCAPA::unescape(&LONCAPA::unescape($msgid)); |
if ($what eq 'Error') { |
if ($plain=~/ \[([^\]]+)\]\:/) { |
$error{$url}.=','.$msgid; |
my $url=$1; |
|
if ($plain=~/\:Error \[/) { |
|
$error{$url}.=','.$msgid; |
} else { |
} else { |
$feedback{$url}.=','.$msgid; |
$feedback{$url}.=','.$msgid; |
} |
} |
} |
} |
} |
} |
} |
} |
|
} |
$self->{FEEDBACK} = \%feedback; |
|
$self->{ERROR_MSG} = \%error; # what is this? JB |
#symbs of resources that have feedbacks (will be urls pre-2.3) |
$self->{DISCUSSION_TIME} = \%discussiontime; |
$self->{FEEDBACK} = \%feedback; |
$self->{EMAIL_STATUS} = \%emailstatus; |
#or errors (will be urls pre 2.3) |
|
$self->{ERROR_MSG} = \%error; |
} |
$self->{DISCUSSION_TIME} = \%discussiontime; |
|
$self->{EMAIL_STATUS} = \%emailstatus; |
|
$self->{LAST_READ} = \%lastreadtime; |
|
|
|
$self->{EMAIL_DISCUSS_GENERATED} = 1; |
|
} |
|
|
$self->{PARM_CACHE} = {}; |
sub get_user_data { |
$self->{INITED} = 1; |
my $self = shift; |
|
if ($self->{RETRIEVED_USER_DATA}) { return; } |
|
|
|
# Retrieve performance data on problems |
|
my %student_data = Apache::lonnet::currentdump($env{'request.course.id'}, |
|
$self->{DOMAIN}, |
|
$self->{USERNAME}); |
|
$self->{STUDENT_DATA} = \%student_data; |
|
|
|
$self->{RETRIEVED_USER_DATA} = 1; |
} |
} |
|
|
|
sub get_discussion_data { |
|
my $self = shift; |
|
if ($self->{RETRIEVED_DISCUSSION_DATA}) { |
|
return $self->{DISCUSSION_DATA}; |
|
} |
|
|
|
$self->generate_email_discuss_status(); |
|
|
|
my $cid=$env{'request.course.id'}; |
|
my $cdom=$env{'course.'.$cid.'.domain'}; |
|
my $cnum=$env{'course.'.$cid.'.num'}; |
|
# Retrieve discussion data for resources in course |
|
my %discussion_data = &Apache::lonnet::dumpstore($cid,$cdom,$cnum); |
|
|
|
|
|
$self->{DISCUSSION_DATA} = \%discussion_data; |
|
$self->{RETRIEVED_DISCUSSION_DATA} = 1; |
|
return $self->{DISCUSSION_DATA}; |
|
} |
|
|
|
|
# Internal function: Takes a key to look up in the nav hash and implements internal |
# Internal function: Takes a key to look up in the nav hash and implements internal |
# memory caching of that key. |
# memory caching of that key. |
sub navhash { |
sub navhash { |
Line 1724 sub navhash {
|
Line 2275 sub navhash {
|
return $self->{NAV_HASH}->{$key}; |
return $self->{NAV_HASH}->{$key}; |
} |
} |
|
|
|
=pod |
|
|
|
=item * B<courseMapDefined>(): Returns true if the course map is defined, |
|
false otherwise. Undefined course maps indicate an error somewhere in |
|
LON-CAPA, and you will not be able to proceed with using the navmap. |
|
See the B<NAV> screen for an example of using this. |
|
|
|
=cut |
|
|
# Checks to see if coursemap is defined, matching test in old lonnavmaps |
# Checks to see if coursemap is defined, matching test in old lonnavmaps |
sub courseMapDefined { |
sub courseMapDefined { |
my $self = shift; |
my $self = shift; |
my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'}); |
my $uri = &Apache::lonnet::clutter($env{'request.course.uri'}); |
|
|
my $firstres = $self->navhash("map_start_$uri"); |
my $firstres = $self->navhash("map_start_$uri"); |
my $lastres = $self->navhash("map_finish_$uri"); |
my $lastres = $self->navhash("map_finish_$uri"); |
Line 1737 sub courseMapDefined {
|
Line 2297 sub courseMapDefined {
|
sub getIterator { |
sub getIterator { |
my $self = shift; |
my $self = shift; |
my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift, |
my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift, |
shift, undef, shift); |
shift, undef, shift, |
|
shift, shift); |
return $iterator; |
return $iterator; |
} |
} |
|
|
# unties the hash when done |
|
sub untieHashes { |
|
my $self = shift; |
|
untie %{$self->{NAV_HASH}}; |
|
untie %{$self->{PARM_HASH}}; |
|
} |
|
|
|
# Private method: Does the given resource (as a symb string) have |
# Private method: Does the given resource (as a symb string) have |
# current discussion? Returns 0 if chat/mail data not extracted. |
# current discussion? Returns 0 if chat/mail data not extracted. |
sub hasDiscussion { |
sub hasDiscussion { |
my $self = shift; |
my $self = shift; |
my $symb = shift; |
my $symb = shift; |
|
$self->generate_email_discuss_status(); |
|
|
if (!defined($self->{DISCUSSION_TIME})) { return 0; } |
if (!defined($self->{DISCUSSION_TIME})) { return 0; } |
|
|
#return defined($self->{DISCUSSION_TIME}->{$symb}); |
#return defined($self->{DISCUSSION_TIME}->{$symb}); |
return $self->{DISCUSSION_TIME}->{$symb} > |
|
$self->{LAST_CHECK}; |
# backward compatibility (bulletin boards used to be 'wrapped') |
|
my $ressymb = $self->wrap_symb($symb); |
|
if ( defined ( $self->{LAST_READ}->{$ressymb} ) ) { |
|
return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_READ}->{$ressymb}; |
|
} else { |
|
# return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_CHECK}; # v.1.1 behavior |
|
return $self->{DISCUSSION_TIME}->{$ressymb} > 0; # in 1.2 will display speech bubble icons for all items with posts until marked as read (even if read in v 1.1). |
|
} |
|
} |
|
|
|
sub last_post_time { |
|
my $self = shift; |
|
my $symb = shift; |
|
my $ressymb = $self->wrap_symb($symb); |
|
return $self->{DISCUSSION_TIME}->{$ressymb}; |
|
} |
|
|
|
sub discussion_info { |
|
my $self = shift; |
|
my $symb = shift; |
|
my $filter = shift; |
|
|
|
$self->get_discussion_data(); |
|
|
|
my $ressymb = $self->wrap_symb($symb); |
|
# keys used to store bulletinboard postings use 'unwrapped' symb. |
|
my $discsymb = &escape($self->unwrap_symb($ressymb)); |
|
my $version = $self->{DISCUSSION_DATA}{'version:'.$discsymb}; |
|
if (!$version) { return; } |
|
|
|
my $prevread = $self->{LAST_READ}{$ressymb}; |
|
|
|
my $count = 0; |
|
my $hiddenflag = 0; |
|
my $deletedflag = 0; |
|
my ($hidden,$deleted,%info); |
|
|
|
for (my $id=$version; $id>0; $id--) { |
|
my $vkeys=$self->{DISCUSSION_DATA}{$id.':keys:'.$discsymb}; |
|
my @keys=split(/:/,$vkeys); |
|
if (grep(/^hidden$/ ,@keys)) { |
|
if (!$hiddenflag) { |
|
$hidden = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':hidden'}; |
|
$hiddenflag = 1; |
|
} |
|
} elsif (grep(/^deleted$/,@keys)) { |
|
if (!$deletedflag) { |
|
$deleted = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':deleted'}; |
|
$deletedflag = 1; |
|
} |
|
} else { |
|
if (($hidden !~/\.$id\./) && ($deleted !~/\.$id\./)) { |
|
if ($filter eq 'unread') { |
|
if ($prevread >= $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'}) { |
|
next; |
|
} |
|
} |
|
$count++; |
|
$info{$count}{'subject'} = |
|
$self->{DISCUSSION_DATA}{$id.':'.$discsymb.':subject'}; |
|
$info{$count}{'id'} = $id; |
|
$info{$count}{'timestamp'} = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'}; |
|
} |
|
} |
|
} |
|
if (wantarray) { |
|
return ($count,%info); |
|
} |
|
return $count; |
|
} |
|
|
|
sub wrap_symb { |
|
my $self = shift; |
|
my $symb = shift; |
|
if ($symb =~ m-___(adm/[^/]+/[^/]+/)(\d+)(/bulletinboard)$-) { |
|
unless ($symb =~ m|adm/wrapper/adm|) { |
|
$symb = 'bulletin___'.$2.'___adm/wrapper/'.$1.$2.$3; |
|
} |
|
} |
|
return $symb; |
|
} |
|
|
|
sub unwrap_symb { |
|
my $self = shift; |
|
my $ressymb = shift; |
|
my $discsymb = $ressymb; |
|
if ($ressymb =~ m-^(bulletin___\d+___)adm/wrapper/(adm/[^/]+/[^/]+/\d+/bulletinboard)$-) { |
|
$discsymb = $1.$2; |
|
} |
|
return $discsymb; |
} |
} |
|
|
# Private method: Does the given resource (as a symb string) have |
# Private method: Does the given resource (as a symb string) have |
# current feedback? Returns the string in the feedback hash, which |
# current feedback? Returns the string in the feedback hash, which |
# will be false if it does not exist. |
# will be false if it does not exist. |
|
|
sub getFeedback { |
sub getFeedback { |
my $self = shift; |
my $self = shift; |
my $symb = shift; |
my $symb = shift; |
|
my $source = shift; |
|
|
|
$self->generate_email_discuss_status(); |
|
|
if (!defined($self->{FEEDBACK})) { return ""; } |
if (!defined($self->{FEEDBACK})) { return ""; } |
|
|
return $self->{FEEDBACK}->{$symb}; |
my $feedback; |
|
if ($self->{FEEDBACK}->{$symb}) { |
|
$feedback = $self->{FEEDBACK}->{$symb}; |
|
if ($self->{FEEDBACK}->{$source}) { |
|
$feedback .= ','.$self->{FEEDBACK}->{$source}; |
|
} |
|
} else { |
|
if ($self->{FEEDBACK}->{$source}) { |
|
$feedback = $self->{FEEDBACK}->{$source}; |
|
} |
|
} |
|
return $feedback; |
} |
} |
|
|
# Private method: Get the errors for that resource (by source). |
# Private method: Get the errors for that resource (by source). |
sub getErrors { |
sub getErrors { |
my $self = shift; |
my $self = shift; |
|
my $symb = shift; |
my $src = shift; |
my $src = shift; |
|
|
|
$self->generate_email_discuss_status(); |
|
|
if (!defined($self->{ERROR_MSG})) { return ""; } |
if (!defined($self->{ERROR_MSG})) { return ""; } |
return $self->{ERROR_MSG}->{$src}; |
|
|
my $errors; |
|
if ($self->{ERROR_MSG}->{$symb}) { |
|
$errors = $self->{ERROR_MSG}->{$symb}; |
|
if ($self->{ERROR_MSG}->{$src}) { |
|
$errors .= ','.$self->{ERROR_MSG}->{$src}; |
|
} |
|
} else { |
|
if ($self->{ERROR_MSG}->{$src}) { |
|
$errors = $self->{ERROR_MSG}->{$src}; |
|
} |
|
} |
|
return $errors; |
} |
} |
|
|
=pod |
=pod |
Line 1795 resource object.
|
Line 2470 resource object.
|
Based on the symb of the resource, get a resource object for that |
Based on the symb of the resource, get a resource object for that |
resource. This is one of the proper ways to get a resource object. |
resource. This is one of the proper ways to get a resource object. |
|
|
=item * B<getMapByMapPc>(map_pc): |
=item * B<getByMapPc>(map_pc): |
|
|
Based on the map_pc of the resource, get a resource object for |
Based on the map_pc of the resource, get a resource object for |
the given map. This is one of the proper ways to get a resource object. |
the given map. This is one of the proper ways to get a resource object. |
Line 1804 the given map. This is one of the proper
|
Line 2479 the given map. This is one of the proper
|
|
|
# The strategy here is to cache the resource objects, and only construct them |
# The strategy here is to cache the resource objects, and only construct them |
# as we use them. The real point is to prevent reading any more from the tied |
# as we use them. The real point is to prevent reading any more from the tied |
# hash then we have to, which should hopefully alleviate speed problems. |
# hash than we have to, which should hopefully alleviate speed problems. |
# Caching is just an incidental detail I throw in because it makes sense. |
|
|
|
sub getById { |
sub getById { |
my $self = shift; |
my $self = shift; |
Line 1825 sub getById {
|
Line 2499 sub getById {
|
sub getBySymb { |
sub getBySymb { |
my $self = shift; |
my $self = shift; |
my $symb = shift; |
my $symb = shift; |
my ($mapUrl, $id, $filename) = split (/___/, $symb); |
|
|
my ($mapUrl, $id, $filename) = &Apache::lonnet::decode_symb($symb); |
my $map = $self->getResourceByUrl($mapUrl); |
my $map = $self->getResourceByUrl($mapUrl); |
return $self->getById($map->map_pc() . '.' . $id); |
my $returnvalue = undef; |
|
if (ref($map)) { |
|
$returnvalue = $self->getById($map->map_pc() .'.'.$id); |
|
} |
|
return $returnvalue; |
} |
} |
|
|
sub getByMapPc { |
sub getByMapPc { |
Line 1850 resource in the navmap.
|
Line 2529 resource in the navmap.
|
sub firstResource { |
sub firstResource { |
my $self = shift; |
my $self = shift; |
my $firstResource = $self->navhash('map_start_' . |
my $firstResource = $self->navhash('map_start_' . |
&Apache::lonnet::clutter($ENV{'request.course.uri'})); |
&Apache::lonnet::clutter($env{'request.course.uri'})); |
return $self->getById($firstResource); |
return $self->getById($firstResource); |
} |
} |
|
|
Line 1866 in the navmap.
|
Line 2545 in the navmap.
|
sub finishResource { |
sub finishResource { |
my $self = shift; |
my $self = shift; |
my $firstResource = $self->navhash('map_finish_' . |
my $firstResource = $self->navhash('map_finish_' . |
&Apache::lonnet::clutter($ENV{'request.course.uri'})); |
&Apache::lonnet::clutter($env{'request.course.uri'})); |
return $self->getById($firstResource); |
return $self->getById($firstResource); |
} |
} |
|
|
Line 1874 sub finishResource {
|
Line 2553 sub finishResource {
|
# the actual lookup; parmval caches the results. |
# the actual lookup; parmval caches the results. |
sub parmval { |
sub parmval { |
my $self = shift; |
my $self = shift; |
my ($what,$symb)=@_; |
my ($what,$symb,$recurse)=@_; |
my $hashkey = $what."|||".$symb; |
my $hashkey = $what."|||".$symb; |
|
my $cache = $self->{PARM_CACHE}; |
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); |
|
$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 { |
my $self = shift; |
my $self = shift; |
my ($what,$symb) = @_; |
my ($what,$symb,$recurse) = @_; |
|
|
my $cid=$ENV{'request.course.id'}; |
|
my $csec=$ENV{'request.course.sec'}; |
|
my $uname=$ENV{'user.name'}; |
|
my $udom=$ENV{'user.domain'}; |
|
|
|
unless ($symb) { return ''; } |
# Make sure the {USER_OPT} and {COURSE_OPT} hashes are populated |
my $result=''; |
$self->generate_course_user_opt(); |
|
|
|
my $cid=$env{'request.course.id'}; |
|
my $csec=$env{'request.course.sec'}; |
|
my $cgroup=''; |
|
my @cgrps=split(/:/,$env{'request.course.groups'}); |
|
if (@cgrps > 0) { |
|
@cgrps = sort(@cgrps); |
|
$cgroup = $cgrps[0]; |
|
} |
|
my $uname=$self->{USERNAME}; |
|
my $udom=$self->{DOMAIN}; |
|
|
my ($mapname,$id,$fn)=split(/\_\_\_/,$symb); |
unless ($symb) { return ['']; } |
|
my $result=''; |
|
|
|
my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb); |
|
$mapname = &Apache::lonnet::deversion($mapname); |
# ----------------------------------------------------- Cascading lookup scheme |
# ----------------------------------------------------- Cascading lookup scheme |
my $rwhat=$what; |
my $rwhat=$what; |
$what=~s/^parameter\_//; |
$what=~s/^parameter\_//; |
Line 1907 sub parmval_real {
|
Line 2609 sub parmval_real {
|
|
|
my $symbparm=$symb.'.'.$what; |
my $symbparm=$symb.'.'.$what; |
my $mapparm=$mapname.'___(all).'.$what; |
my $mapparm=$mapname.'___(all).'.$what; |
my $usercourseprefix=$uname.'_'.$udom.'_'.$cid; |
my $usercourseprefix=$cid; |
|
|
|
|
|
|
|
my $grplevel=$usercourseprefix.'.['.$cgroup.'].'.$what; |
|
my $grplevelr=$usercourseprefix.'.['.$cgroup.'].'.$symbparm; |
|
my $grplevelm=$usercourseprefix.'.['.$cgroup.'].'.$mapparm; |
|
|
|
|
my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what; |
my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what; |
my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm; |
my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm; |
my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm; |
my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm; |
|
|
|
|
my $courselevel= $usercourseprefix.'.'.$what; |
my $courselevel= $usercourseprefix.'.'.$what; |
my $courselevelr=$usercourseprefix.'.'.$symbparm; |
my $courselevelr=$usercourseprefix.'.'.$symbparm; |
my $courselevelm=$usercourseprefix.'.'.$mapparm; |
my $courselevelm=$usercourseprefix.'.'.$mapparm; |
|
|
|
|
my $useropt = $self->{USER_OPT}; |
my $useropt = $self->{USER_OPT}; |
my $courseopt = $self->{COURSE_OPT}; |
my $courseopt = $self->{COURSE_OPT}; |
my $parmhash = $self->{PARM_HASH}; |
my $parmhash = $self->{PARM_HASH}; |
|
|
# ---------------------------------------------------------- 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 (defined($$courseopt{$grplevelr})) { return [$$courseopt{$grplevelr},'resource']; } |
|
if (defined($$courseopt{$grplevelm})) { return [$$courseopt{$grplevelm},'map']; } |
|
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']; } |
if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; } |
|
if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; } |
|
} |
} |
|
|
# ----------------------------------------------------- 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 $default=&Apache::lonnet::metadata($fn,$rwhat.'.default'); |
my $meta_rwhat=$rwhat; |
if (defined($default)) { return $default} |
$meta_rwhat=~s/\./_/g; |
|
my $default=&Apache::lonnet::metadata($fn,$meta_rwhat); |
# --------------------------------------------------- fifth , cascade up parts |
if (defined($default)) { return [$default,'resource']} |
|
$default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat); |
|
if (defined($default)) { return [$default,'resource']} |
|
# --------------------------------------------------- fifth, check more course |
|
if (defined($courseopt)) { |
|
if (defined($$courseopt{$courselevelm})) { return [$$courseopt{$courselevelm},'map']; } |
|
if (defined($$courseopt{$courselevel})) { |
|
my $ret = [$$courseopt{$courselevel},'course']; |
|
return $ret; |
|
} |
|
} |
|
# --------------------------------------------------- sixth , cascade up parts |
|
|
my ($space,@qualifier)=split(/\./,$rwhat); |
my ($space,@qualifier)=split(/\./,$rwhat); |
my $qualifier=join('.',@qualifier); |
my $qualifier=join('.',@qualifier); |
Line 1960 sub parmval_real {
|
Line 2686 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); |
my @partgeneral=$self->parmval($part.".$qualifier",$symb,1); |
if (defined($partgeneral)) { return $partgeneral; } |
if (defined($partgeneral[0])) { return \@partgeneral; } |
} |
} |
return ''; |
if ($recurse) { return []; } |
|
my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$rwhat); |
|
if (defined($pack_def)) { return [$pack_def,'resource']; } |
|
return ['']; |
|
} |
|
# |
|
# Determines the open/close dates for printing a map that |
|
# encloses a resource. |
|
# |
|
sub map_printdates { |
|
my ($self, $res, $part) = @_; |
|
|
|
|
|
|
|
|
|
|
|
my $opendate = $self->get_mapparam($res->symb(), "$part.printstartdate"); |
|
my $closedate= $self->get_mapparam($res->symb(), "$part.printenddate"); |
|
|
|
|
|
return ($opendate, $closedate); |
} |
} |
|
|
|
sub get_mapparam { |
|
my ($self, $symb, $what) = @_; |
|
|
|
# Ensure the course option hash is populated: |
|
|
|
$self->generate_course_user_opt(); |
|
|
|
# Get the course id and section if there is one. |
|
|
|
my $cid=$env{'request.course.id'}; |
|
my $csec=$env{'request.course.sec'}; |
|
my $cgroup=''; |
|
my @cgrps=split(/:/,$env{'request.course.groups'}); |
|
if (@cgrps > 0) { |
|
@cgrps = sort(@cgrps); |
|
$cgroup = $cgrps[0]; |
|
} |
|
my $uname=$self->{USERNAME}; |
|
my $udom=$self->{DOMAIN}; |
|
|
|
unless ($symb) { return ['']; } |
|
my $result=''; |
|
|
|
|
|
# Figure out which map we are in. |
|
|
|
my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb); |
|
$mapname = &Apache::lonnet::deversion($mapname); |
|
|
|
|
|
my $rwhat=$what; |
|
$what=~s/^parameter\_//; |
|
$what=~s/\_/\./; |
|
|
|
# Build the hash keys for the lookup: |
|
|
|
my $symbparm=$symb.'.'.$what; |
|
my $mapparm=$mapname.'___(all).'.$what; |
|
my $usercourseprefix=$cid; |
|
|
|
|
|
my $grplevel = "$usercourseprefix.[$cgroup].$mapparm"; |
|
my $seclevel = "$usercourseprefix.[$csec].$mapparm"; |
|
my $courselevel = "$usercourseprefix.$mapparm"; |
|
|
|
|
|
# Get handy references to the hashes we need in $self: |
|
|
|
my $useropt = $self->{USER_OPT}; |
|
my $courseopt = $self->{COURSE_OPT}; |
|
my $parmhash = $self->{PARM_HASH}; |
|
|
|
# Check per user |
|
|
|
|
|
|
|
if ($uname and defined($useropt)) { |
|
if (defined($$useropt{$courselevel})) { |
|
return $$useropt{$courselevel}; |
|
} |
|
} |
|
|
|
# Check course -- group |
|
|
|
|
|
|
|
if ($cgroup ne '' and defined ($courseopt)) { |
|
if (defined($$courseopt{$grplevel})) { |
|
return $$courseopt{$grplevel}; |
|
} |
|
} |
|
|
|
# Check course -- section |
|
|
|
|
|
|
|
|
|
|
|
if ($csec and defined($courseopt)) { |
|
if (defined($$courseopt{$seclevel})) { |
|
return $$courseopt{$seclevel}; |
|
} |
|
} |
|
# Check the map parameters themselves: |
|
|
|
my $thisparm = $$parmhash{$symbparm}; |
|
if (defined($thisparm)) { |
|
return $thisparm; |
|
} |
|
|
|
|
|
# Additional course parameters: |
|
|
|
if (defined($courseopt)) { |
|
if (defined($$courseopt{$courselevel})) { |
|
return $$courseopt{$courselevel}; |
|
} |
|
} |
|
return undef; # Unefined if we got here. |
|
} |
|
|
|
sub course_printdates { |
|
my ($self, $symb, $part) = @_; |
|
|
|
|
|
my $opendate = $self->getcourseparam($symb, $part . '.printstartdate'); |
|
my $closedate = $self->getcourseparam($symb, $part . '.printenddate'); |
|
return ($opendate, $closedate); |
|
|
|
} |
|
|
|
sub getcourseparam { |
|
my ($self, $symb, $what) = @_; |
|
|
|
$self->generate_course_user_opt(); # If necessary populate the hashes. |
|
|
|
my $uname = $self->{USERNAME}; |
|
my $udom = $self->{DOMAIN}; |
|
|
|
# Course, section, group ids come from the env: |
|
|
|
my $cid = $env{'request.course.id'}; |
|
my $csec = $env{'request.course.sec'}; |
|
my $cgroup = ''; # Assume no group |
|
|
|
my @cgroups = split(/:/, $env{'request.course.groups'}); |
|
if(@cgroups > 0) { |
|
@cgroups = sort(@cgroups); |
|
$cgroup = $cgroups[0]; # There is a course group. |
|
} |
|
my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb); |
|
$mapname = &Apache::lonnet::deversion($mapname); |
|
|
|
# |
|
# Make the various lookup keys: |
|
# |
|
|
|
$what=~s/^parameter\_//; |
|
$what=~s/\_/\./; |
|
|
|
|
|
my $symbparm = $symb . '.' . $what; |
|
my $mapparm=$mapname.'___(all).'.$what; |
|
|
|
# Local refs to the hashes we're going to look at: |
|
|
|
my $useropt = $self->{USER_OPT}; |
|
my $courseopt = $self->{COURSE_OPT}; |
|
|
|
# |
|
# We want the course level stuff from the way |
|
# parmval_real operates |
|
# TODO: Fator some of this stuff out of |
|
# both parmval_real and here |
|
# |
|
my $courselevel = $cid . '.' . $what; |
|
my $grplevel = $cid . '.[' . $cgroup . ']' . $what; |
|
my $seclevel = $cid . '.[' . $csec . ']' . $what; |
|
|
|
|
|
# Try for the user's course level option: |
|
|
|
if ($uname and defined($useropt)) { |
|
if (defined($$useropt{$courselevel})) { |
|
return $$useropt{$courselevel}; |
|
} |
|
} |
|
# Try for the group's course level option: |
|
|
|
if ($uname ne '' and defined($courseopt)) { |
|
if (defined($$courseopt{$grplevel})) { |
|
return $$courseopt{$grplevel}; |
|
} |
|
} |
|
|
|
# Try for section level parameters: |
|
|
|
if ($csec and defined($courseopt)) { |
|
if (defined($$courseopt{$seclevel})) { |
|
return $$courseopt{$seclevel}; |
|
} |
|
} |
|
# Try for 'additional' course parameterse: |
|
|
|
if (defined($courseopt)) { |
|
if (defined($$courseopt{$courselevel})) { |
|
return $$courseopt{$courselevel}; |
|
} |
|
} |
|
return undef; |
|
|
|
} |
|
|
|
|
=pod |
=pod |
|
|
=item * B<getResourceByUrl>(url): |
=item * B<getResourceByUrl>(url,multiple): |
|
|
Retrieves a resource object by URL of the resource. If passed a |
Retrieves a resource object by URL of the resource, unless the optional |
resource object, it will simply return it, so it is safe to use this |
multiple parameter is included in which case an array of resource |
method in code like "$res = $navmap->getResourceByUrl($res)", if |
objects is returned. If passed a resource object, it will simply return |
you're not sure if $res is already an object, or just a URL. If the |
it, so it is safe to use this method in code like |
resource appears multiple times in the course, only the first instance |
"$res = $navmap->getResourceByUrl($res)" |
will be returned. As a result, this is probably useful only for maps. |
if you're not sure if $res is already an object, or just a URL. If the |
|
resource appears multiple times in the course, only the first instance |
|
will be returned (useful for maps), unless the multiple parameter has |
|
been included, in which case all instances are returned in an array. |
|
|
=item * B<retrieveResources>(map, filterFunc, recursive, bailout): |
=item * B<retrieveResources>(map, filterFunc, recursive, bailout, showall): |
|
|
The map is a specification of a map to retreive the resources from, |
The map is a specification of a map to retreive the resources from, |
either as a url or as an object. The filterFunc is a reference to a |
either as a url or as an object. The filterFunc is a reference to a |
Line 1985 function that takes a resource object as
|
Line 2928 function that takes a resource object as
|
true if the resource should be included, or false if it should not |
true if the resource should be included, or false if it should not |
be. If recursive is true, the map will be recursively examined, |
be. If recursive is true, the map will be recursively examined, |
otherwise it will not be. If bailout is true, the function will return |
otherwise it will not be. If bailout is true, the function will return |
as soon as it finds a resource, if false it will finish. By default, |
as soon as it finds a resource, if false it will finish. If showall is |
the map is the top-level map of the course, filterFunc is a function |
true it will not hide maps that contain nothing but one other map. By |
that always returns 1, recursive is true, bailout is false. The |
default, the map is the top-level map of the course, filterFunc is a |
resources will be returned in a list containing the resource objects |
function that always returns 1, recursive is true, bailout is false, |
for the corresponding resources, with B<no structure information> in |
showall is false. The resources will be returned in a list containing |
the list; regardless of branching, recursion, etc., it will be a flat |
the resource objects for the corresponding resources, with B<no |
list. |
structure information> in the list; regardless of branching, |
|
recursion, etc., it will be a flat list. |
|
|
Thus, this is suitable for cases where you don't want the structure, |
Thus, this is suitable for cases where you don't want the structure, |
just a list of all resources. It is also suitable for finding out how |
just a list of all resources. It is also suitable for finding out how |
Line 2000 want to know is if I<any> resources matc
|
Line 2944 want to know is if I<any> resources matc
|
parameter will allow you to avoid potentially expensive enumeration of |
parameter will allow you to avoid potentially expensive enumeration of |
all matching resources. |
all matching resources. |
|
|
=item * B<hasResources>(map, filterFunc, recursive): |
=item * B<hasResource>(map, filterFunc, recursive, showall): |
|
|
Convience method for |
Convenience method for |
|
|
scalar(retrieveResources($map, $filterFunc, $recursive, 1)) > 0 |
scalar(retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0 |
|
|
which will tell whether the map has resources matching the description |
which will tell whether the map has resources matching the description |
in the filter function. |
in the filter function. |
|
|
|
=item * B<usedVersion>(url): |
|
|
|
Retrieves version infomation for a url. Returns the version (a number, or |
|
the string "mostrecent") for resources which have version information in |
|
the big hash. |
|
|
=cut |
=cut |
|
|
|
|
sub getResourceByUrl { |
sub getResourceByUrl { |
my $self = shift; |
my $self = shift; |
my $resUrl = shift; |
my $resUrl = shift; |
|
my $multiple = shift; |
|
|
if (ref($resUrl)) { return $resUrl; } |
if (ref($resUrl)) { return $resUrl; } |
|
|
$resUrl = &Apache::lonnet::clutter($resUrl); |
$resUrl = &Apache::lonnet::clutter($resUrl); |
my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl}; |
my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl}; |
if ($resId =~ /,/) { |
|
$resId = (split (/,/, $resId))[0]; |
|
} |
|
if (!$resId) { return ''; } |
if (!$resId) { return ''; } |
return $self->getById($resId); |
if ($multiple) { |
|
my @resources = (); |
|
my @resIds = split (/,/, $resId); |
|
foreach my $id (@resIds) { |
|
my $resourceId = $self->getById($id); |
|
if ($resourceId) { |
|
push(@resources,$resourceId); |
|
} |
|
} |
|
return @resources; |
|
} else { |
|
if ($resId =~ /,/) { |
|
$resId = (split (/,/, $resId))[0]; |
|
} |
|
return $self->getById($resId); |
|
} |
} |
} |
|
|
sub retrieveResources { |
sub retrieveResources { |
Line 2037 sub retrieveResources {
|
Line 3001 sub retrieveResources {
|
if (!defined($recursive)) { $recursive = 1; } |
if (!defined($recursive)) { $recursive = 1; } |
my $bailout = shift; |
my $bailout = shift; |
if (!defined($bailout)) { $bailout = 0; } |
if (!defined($bailout)) { $bailout = 0; } |
|
my $showall = shift; |
# Create the necessary iterator. |
# Create the necessary iterator. |
if (!ref($map)) { # assume it's a url of a map. |
if (!ref($map)) { # assume it's a url of a map. |
$map = $self->getResourceByUrl($map); |
$map = $self->getResourceByUrl($map); |
} |
} |
|
|
|
# If nothing was passed, assume top-level map |
|
if (!$map) { |
|
$map = $self->getById('0.0'); |
|
} |
|
|
# Check the map's validity. |
# Check the map's validity. |
if (!$map || !$map->is_map()) { |
if (!$map->is_map()) { |
# Oh, to throw an exception.... how I'd love that! |
# Oh, to throw an exception.... how I'd love that! |
return (); |
return (); |
} |
} |
|
|
# Get an iterator. |
# Get an iterator. |
my $it = $self->getIterator($map->map_start(), $map->map_finish(), |
my $it = $self->getIterator($map->map_start(), $map->map_finish(), |
!$recursive); |
undef, $recursive, $showall); |
|
|
my @resources = (); |
my @resources = (); |
|
|
|
if (&$filterFunc($map)) { |
|
push(@resources, $map); |
|
} |
|
|
# Run down the iterator and collect the resources. |
# Run down the iterator and collect the resources. |
my $depth = 1; |
my $curRes; |
$it->next(); |
|
my $curRes = $it->next(); |
while ($curRes = $it->next()) { |
|
|
while ($depth > 0) { |
|
if ($curRes == $it->BEGIN_MAP()) { |
|
$depth++; |
|
} |
|
if ($curRes == $it->END_MAP()) { |
|
$depth--; |
|
} |
|
|
|
if (ref($curRes)) { |
if (ref($curRes)) { |
if (!&$filterFunc($curRes)) { |
if (!&$filterFunc($curRes)) { |
next; |
next; |
} |
} |
|
|
push @resources, $curRes; |
push(@resources, $curRes); |
|
|
if ($bailout) { |
if ($bailout) { |
return @resources; |
return @resources; |
} |
} |
} |
} |
|
|
$curRes = $it->next(); |
|
} |
} |
|
|
return @resources; |
return @resources; |
Line 2091 sub hasResource {
|
Line 3054 sub hasResource {
|
my $map = shift; |
my $map = shift; |
my $filterFunc = shift; |
my $filterFunc = shift; |
my $recursive = shift; |
my $recursive = shift; |
|
my $showall = shift; |
|
|
return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1)) > 0; |
return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0; |
|
} |
|
|
|
sub usedVersion { |
|
my $self = shift; |
|
my $linkurl = shift; |
|
return $self->navhash("version_$linkurl"); |
} |
} |
|
|
1; |
1; |
|
|
package Apache::lonnavmaps::iterator; |
package Apache::lonnavmaps::iterator; |
|
use Scalar::Util qw(weaken); |
|
use Apache::lonnet; |
|
|
=pod |
=pod |
|
|
Line 2132 corresponds to where you want the iterat
|
Line 3104 corresponds to where you want the iterat
|
navmap->finishResource(). filterHash is a hash used as a set |
navmap->finishResource(). filterHash is a hash used as a set |
containing strings representing the resource IDs, defaulting to |
containing strings representing the resource IDs, defaulting to |
empty. Condition is a 1 or 0 that sets what to do with the filter |
empty. Condition is a 1 or 0 that sets what to do with the filter |
hash: If a 0, then only resource that exist IN the filterHash will be |
hash: If a 0, then only resources that exist IN the filterHash will be |
recursed on. If it is a 1, only resources NOT in the filterHash will |
recursed on. If it is a 1, only resources NOT in the filterHash will |
be recursed on. Defaults to 0. forceTop is a boolean value. If it is |
be recursed on. Defaults to 0. forceTop is a boolean value. If it is |
false (default), the iterator will only return the first level of map |
false (default), the iterator will only return the first level of map |
Line 2156 new branch. The possible tokens are:
|
Line 3128 new branch. The possible tokens are:
|
|
|
=over 4 |
=over 4 |
|
|
=item * BEGIN_MAP: |
=item * B<END_ITERATOR>: |
|
|
|
The iterator has returned all that it's going to. Further calls to the |
|
iterator will just produce more of these. This is a "false" value, and |
|
is the only false value the iterator which will be returned, so it can |
|
be used as a loop sentinel. |
|
|
|
=item * B<BEGIN_MAP>: |
|
|
A new map is being recursed into. This is returned I<after> the map |
A new map is being recursed into. This is returned I<after> the map |
resource itself is returned. |
resource itself is returned. |
|
|
=item * END_MAP: |
=item * B<END_MAP>: |
|
|
The map is now done. |
The map is now done. |
|
|
=item * BEGIN_BRANCH: |
=item * B<BEGIN_BRANCH>: |
|
|
A branch is now starting. The next resource returned will be the first |
A branch is now starting. The next resource returned will be the first |
in that branch. |
in that branch. |
|
|
=item * END_BRANCH: |
=item * B<END_BRANCH>: |
|
|
The branch is now done. |
The branch is now done. |
|
|
Line 2188 but only one resource will be returned.
|
Line 3167 but only one resource will be returned.
|
|
|
=back |
=back |
|
|
|
=head2 Normal Usage |
|
|
|
Normal usage of the iterator object is to do the following: |
|
|
|
my $it = $navmap->getIterator([your params here]); |
|
my $curRes; |
|
while ($curRes = $it->next()) { |
|
[your logic here] |
|
} |
|
|
|
Note that inside of the loop, it's frequently useful to check if |
|
"$curRes" is a reference or not with the reference function; only |
|
resource objects will be references, and any non-references will |
|
be the tokens described above. |
|
|
|
Also note there is some old code floating around that trys to track |
|
the depth of the iterator to see when it's done; do not copy that |
|
code. It is difficult to get right and harder to understand than |
|
this. They should be migrated to this new style. |
|
|
=cut |
=cut |
|
|
# Here are the tokens for the iterator: |
# Here are the tokens for the iterator: |
|
|
|
sub END_ITERATOR { return 0; } |
sub BEGIN_MAP { return 1; } # begining of a new map |
sub BEGIN_MAP { return 1; } # begining of a new map |
sub END_MAP { return 2; } # end of the map |
sub END_MAP { return 2; } # end of the map |
sub BEGIN_BRANCH { return 3; } # beginning of a branch |
sub BEGIN_BRANCH { return 3; } # beginning of a branch |
Line 2204 sub min {
|
Line 3204 sub min {
|
if ($a < $b) { return $a; } else { return $b; } |
if ($a < $b) { return $a; } else { return $b; } |
} |
} |
|
|
# In the CVS repository, documentation of this algorithm is included |
|
# in /doc/lonnavdocs, as a PDF and .tex source. Markers like **1** |
|
# will reference the same location in the text as the part of the |
|
# algorithm is running through. |
|
|
|
sub new { |
sub new { |
# magic invocation to create a class instance |
# magic invocation to create a class instance |
my $proto = shift; |
my $proto = shift; |
my $class = ref($proto) || $proto; |
my $class = ref($proto) || $proto; |
my $self = {}; |
my $self = {}; |
|
|
$self->{NAV_MAP} = shift; |
weaken($self->{NAV_MAP} = shift); |
return undef unless ($self->{NAV_MAP}); |
return undef unless ($self->{NAV_MAP}); |
|
|
|
$self->{USERNAME} = $self->{NAV_MAP}->{USERNAME}; |
|
$self->{DOMAIN} = $self->{NAV_MAP}->{DOMAIN}; |
|
|
# Handle the parameters |
# Handle the parameters |
$self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource(); |
$self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource(); |
$self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource(); |
$self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource(); |
Line 2264 sub new {
|
Line 3262 sub new {
|
# that isn't just a redirector. |
# that isn't just a redirector. |
my $resource; my $resourceCount = 0; |
my $resource; my $resourceCount = 0; |
|
|
|
# Documentation on this algorithm can be found in the CVS repository at |
|
# /docs/lonnavdocs; these "**#**" markers correspond to documentation |
|
# in that file. |
# **1** |
# **1** |
|
|
foreach my $pass (@iterations) { |
foreach my $pass (@iterations) { |
Line 2279 sub new {
|
Line 3280 sub new {
|
|
|
# prime the recursion |
# prime the recursion |
$self->{$firstResourceName}->{DATA}->{$valName} = 0; |
$self->{$firstResourceName}->{DATA}->{$valName} = 0; |
my $depth = 0; |
$iterator->next(); |
$iterator->next(); |
|
my $curRes = $iterator->next(); |
my $curRes = $iterator->next(); |
while ($depth > -1) { |
my $depth = 1; |
if ($curRes == $iterator->BEGIN_MAP()) { $depth++; } |
while ($depth > 0) { |
if ($curRes == $iterator->END_MAP()) { $depth--; } |
if ($curRes == $iterator->BEGIN_MAP()) { $depth++; } |
|
if ($curRes == $iterator->END_MAP()) { $depth--; } |
|
|
if (ref($curRes)) { |
if (ref($curRes)) { |
# If there's only one resource, this will save it |
# If there's only one resource, this will save it |
# we have to filter empty resources from consideration here, |
# we have to filter empty resources from consideration here, |
Line 2319 sub new {
|
Line 3320 sub new {
|
$curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth; |
$curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth; |
if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;} |
if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;} |
} |
} |
} continue { |
|
$curRes = $iterator->next(); |
$curRes = $iterator->next(); |
} |
} |
} |
} |
|
|
# Check: Was this only one resource, a map? |
# Check: Was this only one resource, a map? |
if ($resourceCount == 1 && $resource->is_map() && !$self->{FORCE_TOP}) { |
if ($resourceCount == 1 && $resource->is_sequence() && !$self->{FORCE_TOP}) { |
my $firstResource = $resource->map_start(); |
my $firstResource = $resource->map_start(); |
my $finishResource = $resource->map_finish(); |
my $finishResource = $resource->map_finish(); |
return |
my $result; |
Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource, |
$result = Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource, |
$finishResource, $self->{FILTER}, |
$finishResource, $self->{FILTER}, |
$self->{ALREADY_SEEN}, |
$self->{ALREADY_SEEN}, |
$self->{CONDITION}, 0); |
$self->{CONDITION}, |
|
$self->{FORCE_TOP}); |
|
return $result; |
|
|
|
|
} |
} |
|
|
Line 2341 sub new {
|
Line 3345 sub new {
|
$self->{MAX_DEPTH} = $maxDepth; |
$self->{MAX_DEPTH} = $maxDepth; |
$self->{STACK} = []; |
$self->{STACK} = []; |
$self->{RECURSIVE_ITERATOR_FLAG} = 0; |
$self->{RECURSIVE_ITERATOR_FLAG} = 0; |
|
$self->{FINISHED} = 0; # When true, the iterator has finished |
|
|
for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) { |
for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) { |
push @{$self->{STACK}}, []; |
push @{$self->{STACK}}, []; |
Line 2351 sub new {
|
Line 3356 sub new {
|
$self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1; |
$self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1; |
|
|
bless ($self); |
bless ($self); |
|
|
return $self; |
return $self; |
} |
} |
|
|
sub next { |
sub next { |
my $self = shift; |
my $self = shift; |
|
my $closeAllPages=shift; |
|
if ($self->{FINISHED}) { |
|
return END_ITERATOR(); |
|
} |
|
|
# If we want to return the top-level map object, and haven't yet, |
# If we want to return the top-level map object, and haven't yet, |
# do so. |
# do so. |
if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) { |
if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) { |
$self->{HAVE_RETURNED_0} = 1; |
$self->{HAVE_RETURNED_0} = 1; |
|
my $nextTopLevel = $self->{NAV_MAP}->getById('0.0'); |
return $self->{NAV_MAP}->getById('0.0'); |
return $self->{NAV_MAP}->getById('0.0'); |
} |
} |
|
if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0_BEGIN_MAP}) { |
|
$self->{HAVE_RETURNED_0_BEGIN_MAP} = 1; |
|
return $self->BEGIN_MAP(); |
|
} |
|
|
if ($self->{RECURSIVE_ITERATOR_FLAG}) { |
if ($self->{RECURSIVE_ITERATOR_FLAG}) { |
# grab the next from the recursive iterator |
# grab the next from the recursive iterator |
my $next = $self->{RECURSIVE_ITERATOR}->next(); |
my $next = $self->{RECURSIVE_ITERATOR}->next($closeAllPages); |
|
|
# is it a begin or end map? If so, update the depth |
# is it a begin or end map? If so, update the depth |
if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; } |
if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; } |
Line 2377 sub next {
|
Line 3390 sub next {
|
if ($self->{RECURSIVE_DEPTH} == 0) { |
if ($self->{RECURSIVE_DEPTH} == 0) { |
$self->{RECURSIVE_ITERATOR_FLAG} = 0; |
$self->{RECURSIVE_ITERATOR_FLAG} = 0; |
} |
} |
|
|
return $next; |
return $next; |
} |
} |
|
|
Line 2417 sub next {
|
Line 3429 sub next {
|
$self->{CURRENT_DEPTH}--; |
$self->{CURRENT_DEPTH}--; |
return END_BRANCH(); |
return END_BRANCH(); |
} else { |
} else { |
|
$self->{FINISHED} = 1; |
return END_MAP(); |
return END_MAP(); |
} |
} |
} |
} |
Line 2452 sub next {
|
Line 3465 sub next {
|
# So we need to look at all the resources we can get to from here, |
# So we need to look at all the resources we can get to from here, |
# categorize them if we haven't seen them, remember if we have a new |
# categorize them if we haven't seen them, remember if we have a new |
my $nextUnfiltered = $here->getNext(); |
my $nextUnfiltered = $here->getNext(); |
|
|
|
|
my $maxDepthAdded = -1; |
my $maxDepthAdded = -1; |
|
|
for (@$nextUnfiltered) { |
for (@$nextUnfiltered) { |
Line 2464 sub next {
|
Line 3479 sub next {
|
} |
} |
|
|
# Is this the end of a branch? If so, all of the resources examined above |
# Is this the end of a branch? If so, all of the resources examined above |
# led to lower levels then the one we are currently at, so we push a END_BRANCH |
# led to lower levels than the one we are currently at, so we push a END_BRANCH |
# marker onto the stack so we don't forget. |
# marker onto the stack so we don't forget. |
# Example: For the usual A(BC)(DE)F case, when the iterator goes down the |
# Example: For the usual A(BC)(DE)F case, when the iterator goes down the |
# BC branch and gets to C, it will see F as the only next resource, but it's |
# BC branch and gets to C, it will see F as the only next resource, but it's |
Line 2480 sub next {
|
Line 3495 sub next {
|
|
|
# That ends the main iterator logic. Now, do we want to recurse |
# That ends the main iterator logic. Now, do we want to recurse |
# down this map (if this resource is a map)? |
# down this map (if this resource is a map)? |
if ($self->{HERE}->is_map() && |
if ( ($self->{HERE}->is_sequence() || (!$closeAllPages && $self->{HERE}->is_page())) && |
(defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) { |
(defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) { |
$self->{RECURSIVE_ITERATOR_FLAG} = 1; |
$self->{RECURSIVE_ITERATOR_FLAG} = 1; |
my $firstResource = $self->{HERE}->map_start(); |
my $firstResource = $self->{HERE}->map_start(); |
my $finishResource = $self->{HERE}->map_finish(); |
my $finishResource = $self->{HERE}->map_finish(); |
|
|
$self->{RECURSIVE_ITERATOR} = |
$self->{RECURSIVE_ITERATOR} = |
Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource, |
Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource, |
$finishResource, $self->{FILTER}, |
$finishResource, $self->{FILTER}, |
$self->{ALREADY_SEEN}, $self->{CONDITION}); |
$self->{ALREADY_SEEN}, |
|
$self->{CONDITION}, |
|
$self->{FORCE_TOP}); |
} |
} |
|
|
# If this is a blank resource, don't actually return it. |
# If this is a blank resource, don't actually return it. |
Line 2498 sub next {
|
Line 3514 sub next {
|
my $browsePriv = $self->{HERE}->browsePriv(); |
my $browsePriv = $self->{HERE}->browsePriv(); |
if (!$self->{HERE}->src() || |
if (!$self->{HERE}->src() || |
(!($browsePriv eq 'F') && !($browsePriv eq '2')) ) { |
(!($browsePriv eq 'F') && !($browsePriv eq '2')) ) { |
return $self->next(); |
return $self->next($closeAllPages); |
} |
} |
|
|
return $self->{HERE}; |
return $self->{HERE}; |
Line 2542 sub populateStack {
|
Line 3558 sub populateStack {
|
1; |
1; |
|
|
package Apache::lonnavmaps::DFSiterator; |
package Apache::lonnavmaps::DFSiterator; |
|
use Scalar::Util qw(weaken); |
|
use Apache::lonnet; |
|
|
# Not documented in the perldoc: This is a simple iterator that just walks |
# Not documented in the perldoc: This is a simple iterator that just walks |
# through the nav map and presents the resources in a depth-first search |
# through the nav map and presents the resources in a depth-first search |
Line 2550 package Apache::lonnavmaps::DFSiterator;
|
Line 3568 package Apache::lonnavmaps::DFSiterator;
|
# useful for pre-processing of some kind, and is in fact used by the main |
# useful for pre-processing of some kind, and is in fact used by the main |
# iterator that way, but that's about it. |
# iterator that way, but that's about it. |
# One could imagine merging this into the init routine of the main iterator, |
# One could imagine merging this into the init routine of the main iterator, |
# but this might as well be left seperate, since it is possible some other |
# but this might as well be left separate, since it is possible some other |
# use might be found for it. - Jeremy |
# use might be found for it. - Jeremy |
|
|
# Unlike the main iterator, this DOES return all resources, even blank ones. |
# Unlike the main iterator, this DOES return all resources, even blank ones. |
Line 2570 sub new {
|
Line 3588 sub new {
|
my $class = ref($proto) || $proto; |
my $class = ref($proto) || $proto; |
my $self = {}; |
my $self = {}; |
|
|
$self->{NAV_MAP} = shift; |
weaken($self->{NAV_MAP} = shift); |
return undef unless ($self->{NAV_MAP}); |
return undef unless ($self->{NAV_MAP}); |
|
|
|
$self->{USERNAME} = $self->{NAV_MAP}->{USERNAME}; |
|
$self->{DOMAIN} = $self->{NAV_MAP}->{DOMAIN}; |
|
|
$self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource(); |
$self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource(); |
$self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource(); |
$self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource(); |
|
|
Line 2669 sub next {
|
Line 3690 sub next {
|
|
|
# filter the next possibilities to remove things we've |
# filter the next possibilities to remove things we've |
# already seen. |
# already seen. |
foreach (@$nextUnfiltered) { |
foreach my $item (@$nextUnfiltered) { |
if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) { |
if (!defined($self->{ALREADY_SEEN}->{$item->{ID}})) { |
push @$next, $_; |
push @$next, $item; |
} |
} |
} |
} |
|
|
Line 2724 sub populateStack {
|
Line 3745 sub populateStack {
|
1; |
1; |
|
|
package Apache::lonnavmaps::resource; |
package Apache::lonnavmaps::resource; |
|
use Scalar::Util qw(weaken); |
use Apache::lonnet; |
use Apache::lonnet; |
|
|
=pod |
=pod |
|
|
=head1 Object: resource |
=head1 Object: resource |
|
|
|
X<resource, navmap object> |
A resource object encapsulates a resource in a resource map, allowing |
A resource object encapsulates a resource in a resource map, allowing |
easy manipulation of the resource, querying the properties of the |
easy manipulation of the resource, querying the properties of the |
resource (including user properties), and represents a reference that |
resource (including user properties), and represents a reference that |
Line 2750 writing, there is no way to override thi
|
Line 3772 writing, there is no way to override thi
|
parts will never be returned, nor will their response types or ids be |
parts will never be returned, nor will their response types or ids be |
stored. |
stored. |
|
|
=head2 Public Members |
=head2 Overview |
|
|
resource objects have a hash called DATA ($resourceRef->{DATA}) that |
|
you can store whatever you want in. This allows you to easily do |
|
two-pass algorithms without worrying about managing your own |
|
resource->data hash. |
|
|
|
=head2 Methods |
|
|
|
=over 4 |
|
|
|
=item * B<new>($navmapRef, $idString): |
|
|
|
The first arg is a reference to the parent navmap object. The second |
A B<Resource> is the most granular type of object in LON-CAPA that can |
is the idString of the resource itself. Very rarely, if ever, called |
be included in a course. It can either be a particular resource, like |
directly. Use the nav map->getByID() method. |
an HTML page, external resource, problem, etc., or it can be a |
|
container sequence, such as a "page" or a "map". |
=back |
|
|
To see a sequence from the user's point of view, please see the |
|
B<Creating a Course: Maps and Sequences> chapter of the Author's |
|
Manual. |
|
|
|
A Resource Object, once obtained from a navmap object via a B<getBy*> |
|
method of the navmap, or from an iterator, allows you to query |
|
information about that resource. |
|
|
|
Generally, you do not ever want to create a resource object yourself, |
|
so creation has been left undocumented. Always retrieve resources |
|
from navmap objects. |
|
|
|
=head3 Identifying Resources |
|
|
|
X<big hash>Every resource is identified by a Resource ID in the big hash that is |
|
unique to that resource for a given course. X<resource ID, in big hash> |
|
The Resource ID has the form #.#, where the first number is the same |
|
for every resource in a map, and the second is unique. For instance, |
|
for a course laid out like this: |
|
|
|
* Problem 1 |
|
* Map |
|
* Resource 2 |
|
* Resource 3 |
|
|
|
C<Problem 1> and C<Map> will share a first number, and C<Resource 2> |
|
C<Resource 3> will share a first number. The second number may end up |
|
re-used between the two groups. |
|
|
|
The resource ID is only used in the big hash, but can be used in the |
|
context of a course to identify a resource easily. (For instance, the |
|
printing system uses it to record which resources from a sequence you |
|
wish to print.) |
|
|
|
X<symb> X<resource, symb> |
|
All resources also have B<symb>s, which uniquely identify a resource |
|
in a course. Many internal LON-CAPA functions expect a symb. A symb |
|
carries along with it the URL of the resource, and the map it appears |
|
in. Symbs are much larger than resource IDs. |
|
|
=cut |
=cut |
|
|
Line 2777 sub new {
|
Line 3827 sub new {
|
my $class = ref($proto) || $proto; |
my $class = ref($proto) || $proto; |
my $self = {}; |
my $self = {}; |
|
|
$self->{NAV_MAP} = shift; |
weaken($self->{NAV_MAP} = shift); |
$self->{ID} = shift; |
$self->{ID} = shift; |
|
|
|
$self->{USERNAME} = $self->{NAV_MAP}->{USERNAME}; |
|
$self->{DOMAIN} = $self->{NAV_MAP}->{DOMAIN}; |
|
|
# Store this new resource in the parent nav map's cache. |
# Store this new resource in the parent nav map's cache. |
$self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self; |
$self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self; |
$self->{RESOURCE_ERROR} = 0; |
$self->{RESOURCE_ERROR} = 0; |
|
|
|
$self->{DUEDATE_CACHE} = undef; |
|
|
# A hash that can be used by two-pass algorithms to store data |
# A hash that can be used by two-pass algorithms to store data |
# about this resource in. Not used by the resource object |
# about this resource in. Not used by the resource object |
# directly. |
# directly. |
Line 2801 sub navHash {
|
Line 3856 sub navHash {
|
my $self = shift; |
my $self = shift; |
my $param = shift; |
my $param = shift; |
my $id = shift; |
my $id = shift; |
return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:"")); |
my $arg = $param . ($id?$self->{ID}:""); |
|
if (ref($self) && ref($self->{NAV_MAP}) && defined($arg)) { |
|
return $self->{NAV_MAP}->navhash($arg); |
|
} |
|
return; |
} |
} |
|
|
=pod |
=pod |
|
|
B<Metadata Retreival> |
=head2 Methods |
|
|
These are methods that help you retrieve metadata about the resource: |
Once you have a resource object, here's what you can do with it: |
Method names are based on the fields in the compiled course |
|
representation. |
=head3 Attribute Retrieval |
|
|
|
Every resource has certain attributes that can be retrieved and used: |
|
|
=over 4 |
=over 4 |
|
|
|
=item * B<ID>: Every resource has an ID that is unique for that |
|
resource in the course it is in. The ID is actually in the hash |
|
representing the resource, so for a resource object $res, obtain |
|
it via C<$res->{ID}). |
|
|
=item * B<compTitle>: |
=item * B<compTitle>: |
|
|
Returns a "composite title", that is equal to $res->title() if the |
Returns a "composite title", that is equal to $res->title() if the |
Line 2824 resource has a title, and is otherwise t
|
Line 3890 resource has a title, and is otherwise t
|
|
|
Returns true if the resource is external. |
Returns true if the resource is external. |
|
|
=item * B<goesto>: |
|
|
|
Returns the "goesto" value from the compiled nav map. (It is likely |
|
you want to use B<getNext> instead.) |
|
|
|
=item * B<kind>: |
=item * B<kind>: |
|
|
Returns the kind of the resource from the compiled nav map. |
Returns the kind of the resource from the compiled nav map. |
Line 2841 false.
|
Line 3902 false.
|
|
|
=item * B<randompick>: |
=item * B<randompick>: |
|
|
Returns true for a map if the randompick feature is being used on the |
Returns the number of randomly picked items for a map if the randompick |
map. (?) |
feature is being used on the map. |
|
|
|
=item * B<randomorder>: |
|
|
|
Returns true for a map if the randomorder feature is being used on the |
|
map. |
|
|
=item * B<src>: |
=item * B<src>: |
|
|
Line 2856 Returns the symb for the resource.
|
Line 3922 Returns the symb for the resource.
|
|
|
Returns the title of the resource. |
Returns the title of the resource. |
|
|
=item * B<to>: |
|
|
|
Returns the "to" value from the compiled nav map. (It is likely you |
|
want to use B<getNext> instead.) |
|
|
|
=back |
=back |
|
|
=cut |
=cut |
Line 2868 want to use B<getNext> instead.)
|
Line 3929 want to use B<getNext> instead.)
|
# These info functions can be used directly, as they don't return |
# These info functions can be used directly, as they don't return |
# resource information. |
# resource information. |
sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); } |
sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); } |
|
sub encrypted { my $self=shift; return $self->navHash("encrypted_", 1); } |
sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; } |
sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; } |
sub from { my $self=shift; return $self->navHash("from_", 1); } |
sub from { my $self=shift; return $self->navHash("from_", 1); } |
|
# considered private and undocumented |
sub goesto { my $self=shift; return $self->navHash("goesto_", 1); } |
sub goesto { my $self=shift; return $self->navHash("goesto_", 1); } |
sub kind { my $self=shift; return $self->navHash("kind_", 1); } |
sub kind { my $self=shift; return $self->navHash("kind_", 1); } |
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->{NAV_MAP}->{PARM_HASH}->{$self->symb . |
my $randompick = $self->parmval('randompick'); |
'.0.parameter_randompick'}; |
return $randompick; |
|
} |
|
sub randomorder { |
|
my $self = shift; |
|
my $randomorder = $self->parmval('randomorder'); |
|
return ($randomorder =~ /^yes$/i); |
|
} |
|
sub link { |
|
my $self=shift; |
|
if ($self->encrypted()) { return &Apache::lonenc::encrypted($self->src); } |
|
return $self->src; |
} |
} |
sub src { |
sub src { |
my $self=shift; |
my $self=shift; |
return $self->navHash("src_", 1); |
return $self->navHash("src_", 1); |
} |
} |
|
sub shown_symb { |
|
my $self=shift; |
|
if ($self->encrypted()) {return &Apache::lonenc::encrypted($self->symb());} |
|
return $self->symb(); |
|
} |
|
sub id { |
|
my $self=shift; |
|
return $self->{ID}; |
|
} |
|
sub enclosing_map_src { |
|
my $self=shift; |
|
(my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/; |
|
return $self->navHash('map_id_'.$first); |
|
} |
sub symb { |
sub symb { |
my $self=shift; |
my $self=shift; |
(my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/; |
(my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/; |
my $symbSrc = &Apache::lonnet::declutter($self->src()); |
my $symbSrc = &Apache::lonnet::declutter($self->src()); |
return &Apache::lonnet::declutter( |
my $symb = &Apache::lonnet::declutter($self->navHash('map_id_'.$first)) |
$self->navHash('map_id_'.$first)) |
|
. '___' . $second . '___' . $symbSrc; |
. '___' . $second . '___' . $symbSrc; |
|
return &Apache::lonnet::symbclean($symb); |
|
} |
|
sub wrap_symb { |
|
my $self = shift; |
|
return $self->{NAV_MAP}->wrap_symb($self->symb()); |
} |
} |
sub title { my $self=shift; return $self->navHash("title_", 1); } |
sub title { |
|
my $self=shift; |
|
if ($self->{ID} eq '0.0') { |
|
# If this is the top-level map, return the title of the course |
|
# since this map can not be titled otherwise. |
|
return $env{'course.'.$env{'request.course.id'}.'.description'}; |
|
} |
|
return $self->navHash("title_", 1); } |
|
# considered private and undocumented |
sub to { my $self=shift; return $self->navHash("to_", 1); } |
sub to { my $self=shift; return $self->navHash("to_", 1); } |
|
sub condition { |
|
my $self=shift; |
|
my $undercond=$self->navHash("undercond_", 1); |
|
if (!defined($undercond)) { return 1; }; |
|
my $condid=$self->navHash("condid_$undercond"); |
|
if (!defined($condid)) { return 1; }; |
|
my $condition=&Apache::lonnet::directcondval($condid); |
|
return $condition; |
|
} |
|
sub condval { |
|
my $self=shift; |
|
my ($pathname,$filename) = |
|
&Apache::lonnet::split_uri_for_cond($self->src()); |
|
|
|
my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~ |
|
/\&\Q$filename\E\:([\d\|]+)\&/); |
|
if ($match) { |
|
return &Apache::lonnet::condval($1); |
|
} |
|
return 0; |
|
} |
sub compTitle { |
sub compTitle { |
my $self = shift; |
my $self = shift; |
my $title = $self->title(); |
my $title = $self->title(); |
Line 2902 sub compTitle {
|
Line 4022 sub compTitle {
|
} |
} |
return $title; |
return $title; |
} |
} |
|
|
=pod |
=pod |
|
|
B<Predicate Testing the Resource> |
B<Predicate Testing the Resource> |
Line 2932 Returns true if the resource is a sequen
|
Line 4053 Returns true if the resource is a sequen
|
|
|
=cut |
=cut |
|
|
|
sub hasResource { |
|
my $self = shift; |
|
return $self->{NAV_MAP}->hasResource(@_); |
|
} |
|
|
|
sub retrieveResources { |
|
my $self = shift; |
|
return $self->{NAV_MAP}->retrieveResources(@_); |
|
} |
|
|
|
sub is_exam { |
|
my ($self,$part) = @_; |
|
my $type = $self->parmval('type',$part); |
|
if ($type eq 'exam') { |
|
return 1; |
|
} |
|
if ($self->src() =~ /\.(exam)$/) { |
|
return 1; |
|
} |
|
return 0; |
|
} |
sub is_html { |
sub is_html { |
my $self=shift; |
my $self=shift; |
my $src = $self->src(); |
my $src = $self->src(); |
Line 2942 sub is_map { my $self=shift; return defi
|
Line 4083 sub is_map { my $self=shift; return defi
|
sub is_page { |
sub is_page { |
my $self=shift; |
my $self=shift; |
my $src = $self->src(); |
my $src = $self->src(); |
return ($src =~ /page$/); |
return $self->navHash("is_map_", 1) && |
|
$self->navHash("map_type_" . $self->map_pc()) eq 'page'; |
|
} |
|
sub is_practice { |
|
my $self=shift; |
|
my ($part) = @_; |
|
my $type = $self->parmval('type',$part); |
|
if ($type eq 'practice') { |
|
return 1; |
|
} |
|
return 0; |
} |
} |
sub is_problem { |
sub is_problem { |
my $self=shift; |
my $self=shift; |
my $src = $self->src(); |
my $src = $self->src(); |
return ($src =~ /problem$/); |
if ($src =~ /$LONCAPA::assess_re/) { |
|
return !($self->is_practice()); |
|
} |
|
return 0; |
|
} |
|
# |
|
# The has below is the set of status that are considered 'incomplete' |
|
# |
|
my %incomplete_hash = |
|
( |
|
TRIES_LEFT() => 1, |
|
OPEN() => 1, |
|
ATTEMPTED() => 1 |
|
|
|
); |
|
# |
|
# Return tru if a problem is incomplete... for now incomplete means that |
|
# any part of the problem is incomplete. |
|
# Note that if the resources is not a problem, 0 is returned. |
|
# |
|
sub is_incomplete { |
|
my $self = shift; |
|
if ($self->is_problem()) { |
|
foreach my $part (@{$self->parts()}) { |
|
if (exists($incomplete_hash{$self->status($part)})) { |
|
return 1; |
|
} |
|
} |
|
} |
|
return 0; |
|
|
|
} |
|
sub is_raw_problem { |
|
my $self=shift; |
|
my $src = $self->src(); |
|
if ($src =~ /$LONCAPA::assess_re/) { |
|
return 1; |
|
} |
|
return 0; |
|
} |
|
|
|
sub contains_problem { |
|
my $self=shift; |
|
if ($self->is_page()) { |
|
my $hasProblem=$self->hasResource($self,sub { $_[0]->is_problem() },1); |
|
return $hasProblem; |
|
} |
|
return 0; |
|
} |
|
sub map_contains_problem { |
|
my $self=shift; |
|
if ($self->is_map()) { |
|
my $has_problem= |
|
$self->hasResource($self,sub { $_[0]->is_problem() },1); |
|
return $has_problem; |
|
} |
|
return 0; |
} |
} |
sub is_sequence { |
sub is_sequence { |
my $self=shift; |
my $self=shift; |
|
return $self->navHash("is_map_", 1) && |
|
$self->navHash("map_type_" . $self->map_pc()) eq 'sequence'; |
|
} |
|
sub is_survey { |
|
my $self = shift(); |
|
my $part = shift(); |
|
my $type = $self->parmval('type',$part); |
|
if (($type eq 'survey') || ($type eq 'surveycred')) { |
|
return 1; |
|
} |
|
if ($self->src() =~ /\.(survey)$/) { |
|
return 1; |
|
} |
|
return 0; |
|
} |
|
sub is_anonsurvey { |
|
my $self = shift(); |
|
my $part = shift(); |
|
my $type = $self->parmval('type',$part); |
|
if (($type eq 'anonsurvey') || ($type eq 'anonsurveycred')) { |
|
return 1; |
|
} |
|
return 0; |
|
} |
|
sub is_task { |
|
my $self=shift; |
my $src = $self->src(); |
my $src = $self->src(); |
return ($src =~ /sequence$/); |
return ($src =~ /\.(task)$/) |
|
} |
|
|
|
sub is_empty_sequence { |
|
my $self=shift; |
|
my $src = $self->src(); |
|
return !$self->is_page() && $self->navHash("is_map_", 1) && !$self->navHash("map_type_" . $self->map_pc()); |
} |
} |
|
|
# Private method: Shells out to the parmval in the nav map, handler parts. |
# Private method: Shells out to the parmval in the nav map, handler parts. |
Line 2996 resource of the map.
|
Line 4235 resource of the map.
|
|
|
Returns a string with the type of the map in it. |
Returns a string with the type of the map in it. |
|
|
|
=item * B<map_hierarchy>: |
|
|
|
Returns a string with a comma-separated ordered list of map_pc IDs |
|
for the hierarchy of maps containing a map, with the top level |
|
map first, then descending to deeper levels, with the enclosing map last. |
|
|
=back |
=back |
|
|
=cut |
=cut |
Line 3003 Returns a string with the type of the ma
|
Line 4248 Returns a string with the type of the ma
|
sub map_finish { |
sub map_finish { |
my $self = shift; |
my $self = shift; |
my $src = $self->src(); |
my $src = $self->src(); |
$src = Apache::lonnet::clutter($src); |
$src = &Apache::lonnet::clutter($src); |
my $res = $self->navHash("map_finish_$src", 0); |
my $res = $self->navHash("map_finish_$src", 0); |
$res = $self->{NAV_MAP}->getById($res); |
$res = $self->{NAV_MAP}->getById($res); |
return $res; |
return $res; |
Line 3016 sub map_pc {
|
Line 4261 sub map_pc {
|
sub map_start { |
sub map_start { |
my $self = shift; |
my $self = shift; |
my $src = $self->src(); |
my $src = $self->src(); |
$src = Apache::lonnet::clutter($src); |
$src = &Apache::lonnet::clutter($src); |
my $res = $self->navHash("map_start_$src", 0); |
my $res = $self->navHash("map_start_$src", 0); |
$res = $self->{NAV_MAP}->getById($res); |
$res = $self->{NAV_MAP}->getById($res); |
return $res; |
return $res; |
Line 3026 sub map_type {
|
Line 4271 sub map_type {
|
my $pc = $self->map_pc(); |
my $pc = $self->map_pc(); |
return $self->navHash("map_type_$pc", 0); |
return $self->navHash("map_type_$pc", 0); |
} |
} |
|
sub map_hierarchy { |
|
my $self = shift; |
|
my $pc = $self->map_pc(); |
|
return $self->navHash("map_hierarchy_$pc", 0); |
|
} |
|
|
##### |
##### |
# Property queries |
# Property queries |
Line 3035 sub map_type {
|
Line 4283 sub map_type {
|
|
|
# These functions will be responsible for returning the CORRECT |
# These functions will be responsible for returning the CORRECT |
# VALUE for the parameter, no matter what. So while they may look |
# VALUE for the parameter, no matter what. So while they may look |
# like direct calls to parmval, they can be more then that. |
# like direct calls to parmval, they can be more than that. |
# So, for instance, the duedate function should use the "duedatetype" |
# So, for instance, the duedate function should use the "duedatetype" |
# information, rather then the resource object user. |
# information, rather than the resource object user. |
|
|
=pod |
=pod |
|
|
Line 3058 their code.)
|
Line 4306 their code.)
|
|
|
=over 4 |
=over 4 |
|
|
=item * B<acc>: |
|
|
=item * B<printable> |
|
|
|
returns true if the current date is such that the |
|
specified resource part is printable. |
|
|
|
|
|
=item * B<resprintable> |
|
|
|
Returns true if all parts in the resource are printable making the |
|
entire resource printable. |
|
|
|
=item * B<acc> |
|
|
Get the Client IP/Name Access Control information. |
Get the Client IP/Name Access Control information. |
|
|
Line 3066 Get the Client IP/Name Access Control in
|
Line 4326 Get the Client IP/Name Access Control in
|
|
|
Get the answer-reveal date for the problem. |
Get the answer-reveal date for the problem. |
|
|
|
=item * B<awarded>: |
|
|
|
Gets the awarded value for the problem part. Requires genUserData set to |
|
true when the navmap object was created. |
|
|
=item * B<duedate>: |
=item * B<duedate>: |
|
|
Get the due date for the problem. |
Get the due date for the problem. |
Line 3106 Get the weight for the problem.
|
Line 4371 Get the weight for the problem.
|
|
|
=cut |
=cut |
|
|
|
|
|
|
|
|
|
sub printable { |
|
|
|
my ($self, $part) = @_; |
|
|
|
# The following cases apply: |
|
# - If a start date is not set, it is replaced by the open date. |
|
# - Ditto for start/open replaced by content open. |
|
# - If neither start nor printdates are set the part is printable. |
|
# - Start date set but no end date: Printable if now >= start date. |
|
# - End date set but no start date: Printable if now <= end date. |
|
# - both defined: printable if start <= now <= end |
|
# |
|
|
|
# Get the print open/close dates for the resource. |
|
|
|
my $start = $self->parmval("printstartdate", $part); |
|
my $end = $self->parmval("printenddate", $part); |
|
|
|
if (!$start) { |
|
$start = $self->parmval("opendate", $part); |
|
} |
|
if (!$start) { |
|
$start = $self->parmval("contentopen", $part); |
|
} |
|
|
|
|
|
my $now = time(); |
|
|
|
|
|
my $startok = 1; |
|
my $endok = 1; |
|
|
|
if ((defined $start) && ($start ne '')) { |
|
$startok = $start <= $now; |
|
} |
|
if ((defined $end) && ($end != '')) { |
|
$endok = $end >= $now; |
|
} |
|
return $startok && $endok; |
|
} |
|
|
|
sub resprintable { |
|
my $self = shift; |
|
|
|
# get parts...or realize there are no parts. |
|
|
|
my $partsref = $self->parts(); |
|
my @parts = @$partsref; |
|
|
|
if (!@parts) { |
|
return $self->printable(0); |
|
} else { |
|
foreach my $part (@parts) { |
|
if (!$self->printable($part)) { |
|
return 0; |
|
} |
|
} |
|
return 1; |
|
} |
|
} |
|
|
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 $answerdate; |
|
} |
|
sub awarded { |
|
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.'.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'}); |
} |
} |
return $self->parmval("answerdate", $part); |
|
} |
} |
sub awarded { my $self = shift; return $self->queryRestoreHash('awarded', shift); } |
# this should work exactly like the copy in lonhomework.pm |
|
# Why is there a copy in lonhomework? Why not centralized? |
|
# |
|
# TODO: Centralize duedate. |
|
# |
|
|
sub duedate { |
sub duedate { |
(my $self, my $part) = @_; |
(my $self, my $part) = @_; |
return $self->parmval("duedate", $part); |
if (defined ($self->{DUEDATE_CACHE}->{$part})) { |
|
return $self->{DUEDATE_CACHE}->{$part}; |
|
} |
|
my $date; |
|
my @interval=$self->parmval("interval", $part); |
|
my $due_date=$self->parmval("duedate", $part); |
|
if ($interval[0] =~ /\d+/) { |
|
my $first_access=&Apache::lonnet::get_first_access($interval[1], |
|
$self->symb); |
|
if (defined($first_access)) { |
|
my $interval = $first_access+$interval[0]; |
|
$date = (!$due_date || $interval < $due_date) ? $interval |
|
: $due_date; |
|
} else { |
|
$date = $due_date; |
|
} |
|
} else { |
|
$date = $due_date; |
|
} |
|
$self->{DUEDATE_CACHE}->{$part} = $date; |
|
return $date; |
|
} |
|
sub handgrade { |
|
(my $self, my $part) = @_; |
|
my @response_ids = $self->responseIds($part); |
|
if (@response_ids) { |
|
foreach my $response_id (@response_ids) { |
|
my $handgrade = $self->parmval("handgrade",$part.'_'.$response_id); |
|
if (lc($handgrade) eq 'yes') { |
|
return 'yes'; |
|
} |
|
} |
|
} |
|
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 $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 3156 sub tries {
|
Line 4568 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; |
return $self->parmval("weight", $part); |
if (!defined($part)) { $part = '0'; } |
|
my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight', |
|
$self->symb(), $self->{DOMAIN}, |
|
$self->{USERNAME}, |
|
$env{'request.course.sec'}); |
|
return $weight; |
|
} |
|
sub part_display { |
|
my $self= shift(); my $partID = shift(); |
|
if (! defined($partID)) { $partID = '0'; } |
|
my $display=&Apache::lonnet::EXT('resource.'.$partID.'.display', |
|
$self->symb); |
|
if (! defined($display) || $display eq '') { |
|
$display = $partID; |
|
} |
|
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 |
Line 3168 sub getReturnHash {
|
Line 4604 sub getReturnHash {
|
my $self = shift; |
my $self = shift; |
|
|
if (!defined($self->{RETURN_HASH})) { |
if (!defined($self->{RETURN_HASH})) { |
my %tmpHash = &Apache::lonnet::restore($self->symb()); |
my %tmpHash = &Apache::lonnet::restore($self->symb(),undef,$self->{DOMAIN},$self->{USERNAME}); |
$self->{RETURN_HASH} = \%tmpHash; |
$self->{RETURN_HASH} = \%tmpHash; |
} |
} |
} |
} |
Line 3201 Returns a false value if there has been
|
Line 4637 Returns a false value if there has been
|
logged in, true if there has. Always returns false if the discussion |
logged in, true if there has. Always returns false if the discussion |
data was not extracted when the nav map was constructed. |
data was not extracted when the nav map was constructed. |
|
|
|
=item * B<last_post_time>: |
|
|
|
Returns a false value if there hasn't been discussion otherwise returns |
|
unix timestamp of last time a discussion posting (or edit) was made. |
|
|
|
=item * B<discussion_info>: |
|
|
|
optional argument is a filter (currently can be 'unread'); |
|
returns in scalar context the count of the number of discussion postings. |
|
|
|
returns in list context both the count of postings and a hash ref |
|
containing information about the postings (subject, id, timestamp) in a hash. |
|
|
|
Default is to return counts for all postings. However if called with a second argument set to 'unread', will return information about only unread postings. |
|
|
=item * B<getFeedback>: |
=item * B<getFeedback>: |
|
|
Gets the feedback for the resource and returns the raw feedback string |
Gets the feedback for the resource and returns the raw feedback string |
Line 3208 for the resource, or the null string if
|
Line 4659 for the resource, or the null string if
|
email data was not extracted when the nav map was constructed. Usually |
email data was not extracted when the nav map was constructed. Usually |
used like this: |
used like this: |
|
|
for (split(/\,/, $res->getFeedback())) { |
for my $url (split(/\,/, $res->getFeedback())) { |
my $link = &Apache::lonnet::escape($_); |
my $link = &escape($url); |
... |
... |
|
|
and use the link as appropriate. |
and use the link as appropriate. |
Line 3221 sub hasDiscussion {
|
Line 4672 sub hasDiscussion {
|
return $self->{NAV_MAP}->hasDiscussion($self->symb()); |
return $self->{NAV_MAP}->hasDiscussion($self->symb()); |
} |
} |
|
|
|
sub last_post_time { |
|
my $self = shift; |
|
return $self->{NAV_MAP}->last_post_time($self->symb()); |
|
} |
|
|
|
sub discussion_info { |
|
my ($self,$filter) = @_; |
|
return $self->{NAV_MAP}->discussion_info($self->symb(),$filter); |
|
} |
|
|
sub getFeedback { |
sub getFeedback { |
my $self = shift; |
my $self = shift; |
my $source = $self->src(); |
my $source = $self->src(); |
|
my $symb = $self->symb(); |
if ($source =~ /^\/res\//) { $source = substr $source, 5; } |
if ($source =~ /^\/res\//) { $source = substr $source, 5; } |
return $self->{NAV_MAP}->getFeedback($source); |
return $self->{NAV_MAP}->getFeedback($symb,$source); |
} |
} |
|
|
sub getErrors { |
sub getErrors { |
my $self = shift; |
my $self = shift; |
my $source = $self->src(); |
my $source = $self->src(); |
|
my $symb = $self->symb(); |
if ($source =~ /^\/res\//) { $source = substr $source, 5; } |
if ($source =~ /^\/res\//) { $source = substr $source, 5; } |
return $self->{NAV_MAP}->getErrors($source); |
return $self->{NAV_MAP}->getErrors($symb,$source); |
} |
} |
|
|
=pod |
=pod |
Line 3250 Returns the number of parts of the probl
|
Line 4713 Returns the number of parts of the probl
|
for single part problems, returns 1. For multipart, it returns the |
for single part problems, returns 1. For multipart, it returns the |
number of parts in the problem, not including psuedo-part 0. |
number of parts in the problem, not including psuedo-part 0. |
|
|
|
=item * B<countResponses>(): |
|
|
|
Returns the total number of responses in the problem a student can answer. |
|
|
|
=item * B<responseTypes>(): |
|
|
|
Returns a hash whose keys are the response types. The values are the number |
|
of times each response type is used. This is for the I<entire> problem, not |
|
just a single part. |
|
|
=item * B<multipart>(): |
=item * B<multipart>(): |
|
|
Returns true if the problem is multipart, false otherwise. Use this instead |
Returns true if the problem is multipart, false otherwise. Use this instead |
Line 3296 sub countParts {
|
Line 4769 sub countParts {
|
return scalar(@{$parts}); # + $delta; |
return scalar(@{$parts}); # + $delta; |
} |
} |
|
|
|
sub countResponses { |
|
my $self = shift; |
|
my $count; |
|
foreach my $part (@{$self->parts()}) { |
|
$count+= scalar($self->responseIds($part)); |
|
} |
|
return $count; |
|
} |
|
|
|
sub responseTypes { |
|
my $self = shift; |
|
my %responses; |
|
foreach my $part (@{$self->parts()}) { |
|
foreach my $responsetype ($self->responseType($part)) { |
|
$responses{$responsetype}++ if (defined($responsetype)); |
|
} |
|
} |
|
return %responses; |
|
} |
|
|
sub multipart { |
sub multipart { |
my $self = shift; |
my $self = shift; |
return $self->countParts() > 1; |
return $self->countParts() > 1; |
} |
} |
|
|
|
sub singlepart { |
|
my $self = shift; |
|
return $self->countParts() == 1; |
|
} |
|
|
sub responseType { |
sub responseType { |
my $self = shift; |
my $self = shift; |
my $part = shift; |
my $part = shift; |
|
|
$self->extractParts(); |
$self->extractParts(); |
return $self->{RESPONSE_TYPE}->{$part}; |
if (defined($self->{RESPONSE_TYPES}->{$part})) { |
|
return @{$self->{RESPONSE_TYPES}->{$part}}; |
|
} else { |
|
return undef; |
|
} |
} |
} |
|
|
sub responseIds { |
sub responseIds { |
Line 3314 sub responseIds {
|
Line 4816 sub responseIds {
|
my $part = shift; |
my $part = shift; |
|
|
$self->extractParts(); |
$self->extractParts(); |
return $self->{RESPONSE_IDS}->{$part}; |
if (defined($self->{RESPONSE_IDS}->{$part})) { |
|
return @{$self->{RESPONSE_IDS}->{$part}}; |
|
} else { |
|
return undef; |
|
} |
} |
} |
|
|
# Private function: Extracts the parts information, both part names and |
# Private function: Extracts the parts information, both part names and |
Line 3331 sub extractParts {
|
Line 4837 sub extractParts {
|
|
|
# Retrieve part count, if this is a problem |
# Retrieve part count, if this is a problem |
if ($self->is_problem()) { |
if ($self->is_problem()) { |
|
my $partorder = &Apache::lonnet::metadata($self->src(), 'partorder'); |
my $metadata = &Apache::lonnet::metadata($self->src(), 'packages'); |
my $metadata = &Apache::lonnet::metadata($self->src(), 'packages'); |
if (!$metadata) { |
|
$self->{RESOURCE_ERROR} = 1; |
|
$self->{PARTS} = []; |
|
$self->{PART_TYPE} = {}; |
|
return; |
|
} |
|
foreach (split(/\,/,$metadata)) { |
|
if ($_ =~ /^part_(.*)$/) { |
|
my $part = $1; |
|
# This floods the logs if it blows up |
|
if (defined($parts{$part})) { |
|
Apache::lonnet::logthis("$part multiply defined in metadata for " . $self->symb()); |
|
} |
|
|
|
# check to see if part is turned off. |
if ($partorder) { |
|
my @parts; |
if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) { |
for my $part (split (/,/,$partorder)) { |
$parts{$part} = 1; |
if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) { |
} |
push @parts, $part; |
} |
$parts{$part} = 1; |
|
} |
|
} |
|
$self->{PARTS} = \@parts; |
|
} else { |
|
if (!$metadata) { |
|
$self->{RESOURCE_ERROR} = 1; |
|
$self->{PARTS} = []; |
|
$self->{PART_TYPE} = {}; |
|
return; |
|
} |
|
foreach my $entry (split(/\,/,$metadata)) { |
|
if ($entry =~ /^(?:part|Task)_(.*)$/) { |
|
my $part = $1; |
|
# This floods the logs if it blows up |
|
if (defined($parts{$part})) { |
|
&Apache::lonnet::logthis("$part multiply defined in metadata for " . $self->symb()); |
|
} |
|
|
|
# check to see if part is turned off. |
|
|
|
if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) { |
|
$parts{$part} = 1; |
|
} |
|
} |
|
} |
|
my @sortedParts = sort keys %parts; |
|
$self->{PARTS} = \@sortedParts; |
} |
} |
|
|
|
|
my @sortedParts = sort keys %parts; |
|
$self->{PARTS} = \@sortedParts; |
|
|
|
|
# These hashes probably do not need names that end with "Hash".... |
my %responseIdHash; |
my %responseIdHash; |
my %responseTypeHash; |
my %responseTypeHash; |
|
|
|
|
# Init the responseIdHash |
# Init the responseIdHash |
foreach (@{$self->{PARTS}}) { |
foreach my $part (@{$self->{PARTS}}) { |
$responseIdHash{$_} = []; |
$responseIdHash{$part} = []; |
} |
} |
|
|
# Now, the unfortunate thing about this is that parts, part name, and |
# Now, the unfortunate thing about this is that parts, part name, and |
# response if are delimited by underscores, but both the part |
# response id are delimited by underscores, but both the part |
# name and response id can themselves have underscores in them. |
# name and response id can themselves have underscores in them. |
# So we have to use our knowlege of part names to figure out |
# So we have to use our knowlege of part names to figure out |
# where the part names begin and end, and even then, it is possible |
# where the part names begin and end, and even then, it is possible |
# to construct ambiguous situations. |
# to construct ambiguous situations. |
foreach (split /,/, $metadata) { |
foreach my $data (split /,/, $metadata) { |
if ($_ =~ /^([a-zA-Z]+)response_(.*)/) { |
if ($data =~ /^([a-zA-Z]+)response_(.*)/ |
|
|| $data =~ /^(Task)_(.*)/) { |
my $responseType = $1; |
my $responseType = $1; |
my $partStuff = $2; |
my $partStuff = $2; |
my $partIdSoFar = ''; |
my $partIdSoFar = ''; |
my @partChunks = split /_/, $partStuff; |
my @partChunks = split /_/, $partStuff; |
my $i = 0; |
my $i = 0; |
|
|
for ($i = 0; $i < scalar(@partChunks); $i++) { |
for ($i = 0; $i < scalar(@partChunks); $i++) { |
if ($partIdSoFar) { $partIdSoFar .= '_'; } |
if ($partIdSoFar) { $partIdSoFar .= '_'; } |
$partIdSoFar .= $partChunks[$i]; |
$partIdSoFar .= $partChunks[$i]; |
if ($parts{$partIdSoFar}) { |
if ($parts{$partIdSoFar}) { |
my @otherChunks = @partChunks[$i+1..$#partChunks]; |
my @otherChunks = @partChunks[$i+1..$#partChunks]; |
my $responseId = join('_', @otherChunks); |
my $responseId = join('_', @otherChunks); |
push @{$responseIdHash{$partIdSoFar}}, $responseId; |
if ($self->is_task()) { |
$responseTypeHash{$partIdSoFar} = $responseType; |
push(@{$responseIdHash{$partIdSoFar}}, |
last; |
$partIdSoFar); |
|
} else { |
|
push(@{$responseIdHash{$partIdSoFar}}, |
|
$responseId); |
|
} |
|
push(@{$responseTypeHash{$partIdSoFar}}, |
|
$responseType); |
} |
} |
} |
} |
} |
} |
} |
} |
|
my $resorder = &Apache::lonnet::metadata($self->src(),'responseorder'); |
|
# |
|
# Reorder the arrays in the %responseIdHash and %responseTypeHash |
|
if ($resorder) { |
|
my @resorder=split(/,/,$resorder); |
|
foreach my $part (keys(%responseIdHash)) { |
|
my $i=0; |
|
my %resids = map { ($_,$i++) } @{ $responseIdHash{$part} }; |
|
my @neworder; |
|
foreach my $possibleid (@resorder) { |
|
if (exists($resids{$possibleid})) { |
|
push(@neworder,$resids{$possibleid}); |
|
} |
|
} |
|
my @ids; |
|
my @type; |
|
foreach my $element (@neworder) { |
|
push (@ids,$responseIdHash{$part}->[$element]); |
|
push (@type,$responseTypeHash{$part}->[$element]); |
|
} |
|
$responseIdHash{$part}=\@ids; |
|
$responseTypeHash{$part}=\@type; |
|
} |
|
} |
$self->{RESPONSE_IDS} = \%responseIdHash; |
$self->{RESPONSE_IDS} = \%responseIdHash; |
$self->{RESPONSE_TYPES} = \%responseTypeHash; |
$self->{RESPONSE_TYPES} = \%responseTypeHash; |
} |
} |
Line 3415 the completion information.
|
Line 4963 the completion information.
|
Idiomatic usage of these two methods would probably look something |
Idiomatic usage of these two methods would probably look something |
like |
like |
|
|
foreach ($resource->parts()) { |
foreach my $part ($resource->parts()) { |
my $dateStatus = $resource->getDateStatus($_); |
my $dateStatus = $resource->getDateStatus($part); |
my $completionStatus = $resource->getCompletionStatus($_); |
my $completionStatus = $resource->getCompletionStatus($part); |
|
|
or |
or |
|
|
my $status = $resource->status($_); |
my $status = $resource->status($part); |
|
|
... use it here ... |
... use it here ... |
} |
} |
Line 3482 sub OPEN { return 1; }
|
Line 5030 sub OPEN { return 1; }
|
sub PAST_DUE_NO_ANSWER { return 2; } |
sub PAST_DUE_NO_ANSWER { return 2; } |
sub PAST_DUE_ANSWER_LATER { return 3; } |
sub PAST_DUE_ANSWER_LATER { return 3; } |
sub ANSWER_OPEN { return 4; } |
sub ANSWER_OPEN { return 4; } |
sub NOTHING_SET { return 5; } |
sub NOTHING_SET { return 5; } |
sub NETWORK_FAILURE { return 100; } |
sub NETWORK_FAILURE { return 100; } |
|
|
# getDateStatus gets the date status for a given problem part. |
# getDateStatus gets the date status for a given problem part. |
Line 3568 Information not available due to network
|
Line 5116 Information not available due to network
|
|
|
Attempted, and not yet graded. |
Attempted, and not yet graded. |
|
|
|
=item * B<CREDIT_ATTEMPTED>: |
|
|
|
Attempted, and credit received for attempt (survey and anonymous survey only). |
|
|
=back |
=back |
|
|
=cut |
=cut |
Line 3579 sub CORRECT { return 13; }
|
Line 5131 sub CORRECT { return 13; }
|
sub CORRECT_BY_OVERRIDE { return 14; } |
sub CORRECT_BY_OVERRIDE { return 14; } |
sub EXCUSED { return 15; } |
sub EXCUSED { return 15; } |
sub ATTEMPTED { return 16; } |
sub ATTEMPTED { return 16; } |
|
sub CREDIT_ATTEMPTED { return 17; } |
|
|
sub getCompletionStatus { |
sub getCompletionStatus { |
my $self = shift; |
my $self = shift; |
|
my $part = shift; |
return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); |
return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE}); |
|
|
my $status = $self->queryRestoreHash('solved', shift); |
my $status = $self->queryRestoreHash('solved', $part); |
|
|
# Left as seperate if statements in case we ever do more with this |
# Left as separate if statements in case we ever do more with this |
if ($status eq 'correct_by_student') {return $self->CORRECT;} |
if ($status eq 'correct_by_student') {return $self->CORRECT;} |
if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; } |
if ($status eq 'correct_by_scantron') {return $self->CORRECT;} |
|
if ($status eq 'correct_by_override') { |
|
return $self->CORRECT_BY_OVERRIDE; |
|
} |
if ($status eq 'incorrect_attempted') {return $self->INCORRECT; } |
if ($status eq 'incorrect_attempted') {return $self->INCORRECT; } |
if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; } |
if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; } |
if ($status eq 'excused') {return $self->EXCUSED; } |
if ($status eq 'excused') {return $self->EXCUSED; } |
if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; } |
if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; } |
|
if ($status eq 'credit_attempted') { |
|
if ($self->is_anonsurvey($part) || $self->is_survey($part)) { |
|
return $self->CREDIT_ATTEMPTED; |
|
} else { |
|
return $self->ATTEMPTED; |
|
} |
|
} |
return $self->NOT_ATTEMPTED; |
return $self->NOT_ATTEMPTED; |
} |
} |
|
|
Line 3682 The item is open and not yet tried.
|
Line 5246 The item is open and not yet tried.
|
|
|
The problem has been attempted. |
The problem has been attempted. |
|
|
|
=item * B<CREDIT_ATTEMPTED>: |
|
|
|
The problem has been attempted, and credit given for the attempt (survey and anonymous survey only). |
|
|
=item * B<ANSWER_SUBMITTED>: |
=item * B<ANSWER_SUBMITTED>: |
|
|
An answer has been submitted, but the student should not see it. |
An answer has been submitted, but the student should not see it. |
Line 3690 An answer has been submitted, but the st
|
Line 5258 An answer has been submitted, but the st
|
|
|
=cut |
=cut |
|
|
sub TRIES_LEFT { return 20; } |
sub TRIES_LEFT { return 20; } |
sub ANSWER_SUBMITTED { return 21; } |
sub ANSWER_SUBMITTED { return 21; } |
|
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; |
Line 3704 sub status {
|
Line 5284 sub status {
|
# dimension and 5 entries on the other, which we want to colorize, |
# dimension and 5 entries on the other, which we want to colorize, |
# plus network failure and "no date data at all". |
# plus network failure and "no date data at all". |
|
|
|
#if ($self->{RESOURCE_ERROR}) { return NETWORK_FAILURE; } |
if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; } |
if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; } |
|
|
my $suppressFeedback = lc($self->parmval("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 |
|
# suppress the feedback; student should know |
|
if ($self->duedate($part) && $self->duedate($part) < time() && |
|
$self->answerdate($part) && $self->answerdate($part) < time()) { |
|
$suppressFeedback = 0; |
|
} |
|
|
# There are a few whole rows we can dispose of: |
# There are a few whole rows we can dispose of: |
if ($completionStatus == CORRECT || |
if ($completionStatus == CORRECT || |
$completionStatus == CORRECT_BY_OVERRIDE ) { |
$completionStatus == CORRECT_BY_OVERRIDE ) { |
return $suppressFeedback? ANSWER_SUBMITTED : CORRECT; |
if ( $suppressFeedback ) { return ANSWER_SUBMITTED } |
|
my $awarded=$self->awarded($part); |
|
if ($awarded < 1 && $awarded > 0) { |
|
return PARTIALLY_CORRECT; |
|
} elsif ($awarded<1) { |
|
return INCORRECT; |
|
} |
|
return CORRECT; |
|
} |
|
|
|
# If it's WRONG... and not open |
|
if ( ($completionStatus == INCORRECT || |
|
$completionStatus == INCORRECT_BY_OVERRIDE) |
|
&& (!$self->opendate($part) || $self->opendate($part) > time()) ) { |
|
return INCORRECT; |
} |
} |
|
|
if ($completionStatus == ATTEMPTED) { |
if ($completionStatus == ATTEMPTED) { |
return ATTEMPTED; |
return ATTEMPTED; |
} |
} |
|
|
|
if ($completionStatus == CREDIT_ATTEMPTED) { |
|
return CREDIT_ATTEMPTED; |
|
} |
|
|
# If it's EXCUSED, then return that no matter what |
# If it's EXCUSED, then return that no matter what |
if ($completionStatus == EXCUSED) { |
if ($completionStatus == EXCUSED) { |
return EXCUSED; |
return EXCUSED; |
Line 3732 sub status {
|
Line 5341 sub status {
|
|
|
if ($dateStatus == PAST_DUE_ANSWER_LATER || |
if ($dateStatus == PAST_DUE_ANSWER_LATER || |
$dateStatus == PAST_DUE_NO_ANSWER ) { |
$dateStatus == PAST_DUE_NO_ANSWER ) { |
return $dateStatus; |
return $suppressFeedback ? ANSWER_SUBMITTED : $dateStatus; |
} |
} |
|
|
if ($dateStatus == ANSWER_OPEN) { |
if ($dateStatus == ANSWER_OPEN) { |
Line 3750 sub status {
|
Line 5359 sub status {
|
if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) { |
if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) { |
# and there are TRIES LEFT: |
# and there are TRIES LEFT: |
if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) { |
if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) { |
return TRIES_LEFT; |
return $suppressFeedback ? ANSWER_SUBMITTED : TRIES_LEFT; |
} |
} |
return $suppressFeedback ? ANSWER_SUBMITTED : INCORRECT; # otherwise, return orange; student can't fix this |
return $suppressFeedback ? ANSWER_SUBMITTED : INCORRECT; # otherwise, return orange; student can't fix this |
} |
} |
|
|
# Otherwise, it's untried and open |
# Otherwise, it's untried and open |
return OPEN; |
return OPEN; |
|
} |
|
|
|
sub check_for_slot { |
|
my $self = shift; |
|
my $part = shift; |
|
my $symb = $self->symb(); |
|
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; |
|
my $num_usable_slots = 0; |
|
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,'starttime'); |
|
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) { |
|
if ($end > $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); |
|
} |
|
} |
|
my @proctors; |
|
if ($slots{$slot_name}->{'proctor'} ne '') { |
|
@proctors = split(',',$slots{$slot_name}->{'proctor'}); |
|
} |
|
if (@proctors > 0) { |
|
($checkedin,$checkedinslot) = $self->checkedin(); |
|
unless ((grep(/^\Q$checkedin\E/,@proctors)) && |
|
($checkedinslot eq $slot_name)) { |
|
return (NEEDS_CHECKIN,undef,$slot_name); |
|
} |
|
} |
|
return (RESERVED,$end,$slot_name); |
|
} |
|
} |
|
} elsif ($end > $now) { |
|
$num_usable_slots ++; |
|
} |
|
} |
|
my ($is_correct,$got_grade); |
|
if ($self->is_task()) { |
|
my $taskstatus = $self->taskstatus(); |
|
$is_correct = (($taskstatus eq 'pass') || |
|
($self->solved() =~ /^correct_/)); |
|
$got_grade = ($taskstatus =~ /^(?: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); |
|
} |
|
} |
|
if ($num_usable_slots) { |
|
return(NOT_IN_A_SLOT); |
|
} |
|
} |
|
my $reservable = &Apache::lonnet::get_reservable_slots($cnum,$cdom,$env{'user.name'}, |
|
$env{'user.domain'}); |
|
if (ref($reservable) eq 'HASH') { |
|
if ((ref($reservable->{'now_order'}) eq 'ARRAY') && (ref($reservable->{'now'}) eq 'HASH')) { |
|
foreach my $slot (reverse (@{$reservable->{'now_order'}})) { |
|
if (($reservable->{'now'}{$slot}{'symb'} eq '') || |
|
($reservable->{'now'}{$slot}{'symb'} eq $symb)) { |
|
return(RESERVABLE,$reservable->{'now'}{$slot}{'endreserve'}); |
|
} |
|
} |
|
} |
|
if ((ref($reservable->{'future_order'}) eq 'ARRAY') && (ref($reservable->{'future'}) eq 'HASH')) { |
|
foreach my $slot (@{$reservable->{'future_order'}}) { |
|
if (($reservable->{'future'}{$slot}{'symb'} eq '') || |
|
($reservable->{'future'}{$slot}{'symb'} eq $symb)) { |
|
return(RESERVABLE_LATER,$reservable->{'future'}{$slot}{'startreserve'}); |
|
} |
|
} |
|
} |
|
} |
|
return(NOTRESERVABLE); |
|
} |
|
return; |
|
} |
|
|
|
sub CLOSED { return 23; } |
|
sub ERROR { return 24; } |
|
|
|
=pod |
|
|
|
B<Simple Status> |
|
|
|
Convenience method B<simpleStatus> provides a "simple status" for the resource. |
|
"Simple status" corresponds to "which icon is shown on the |
|
Navmaps". There are six "simple" statuses: |
|
|
|
=over 4 |
|
|
|
=item * B<CLOSED>: The problem is currently closed. (No icon shown.) |
|
|
|
=item * B<OPEN>: The problem is open and unattempted. |
|
|
|
=item * B<CORRECT>: The problem is correct for any reason. |
|
|
|
=item * B<INCORRECT>: The problem is incorrect and can still be |
|
completed successfully. |
|
|
|
=item * B<ATTEMPTED>: The problem has been attempted, but the student |
|
does not know if they are correct. (The ellipsis icon.) |
|
|
|
=item * B<ERROR>: There is an error retrieving information about this |
|
problem. |
|
|
|
=back |
|
|
|
=cut |
|
|
|
# This hash maps the composite status to this simple status, and |
|
# can be used directly, if you like |
|
my %compositeToSimple = |
|
( |
|
NETWORK_FAILURE() => ERROR, |
|
NOTHING_SET() => CLOSED, |
|
CORRECT() => CORRECT, |
|
PARTIALLY_CORRECT() => PARTIALLY_CORRECT, |
|
EXCUSED() => CORRECT, |
|
PAST_DUE_NO_ANSWER() => INCORRECT, |
|
PAST_DUE_ANSWER_LATER() => INCORRECT, |
|
ANSWER_OPEN() => INCORRECT, |
|
OPEN_LATER() => CLOSED, |
|
TRIES_LEFT() => OPEN, |
|
INCORRECT() => INCORRECT, |
|
OPEN() => OPEN, |
|
ATTEMPTED() => ATTEMPTED, |
|
CREDIT_ATTEMPTED() => CORRECT, |
|
ANSWER_SUBMITTED() => ATTEMPTED |
|
); |
|
|
|
sub simpleStatus { |
|
my $self = shift; |
|
my $part = shift; |
|
my $status = $self->status($part); |
|
return $compositeToSimple{$status}; |
|
} |
|
|
|
=pod |
|
|
|
B<simpleStatusCount> will return an array reference containing, in |
|
this order, the number of OPEN, CLOSED, CORRECT, INCORRECT, ATTEMPTED, |
|
and ERROR parts the given problem has. |
|
|
|
=cut |
|
|
|
# This maps the status to the slot we want to increment |
|
my %statusToSlotMap = |
|
( |
|
OPEN() => 0, |
|
CLOSED() => 1, |
|
CORRECT() => 2, |
|
INCORRECT() => 3, |
|
ATTEMPTED() => 4, |
|
ERROR() => 5 |
|
); |
|
|
|
sub statusToSlot { return $statusToSlotMap{shift()}; } |
|
|
|
sub simpleStatusCount { |
|
my $self = shift; |
|
|
|
my @counts = (0, 0, 0, 0, 0, 0, 0); |
|
foreach my $part (@{$self->parts()}) { |
|
$counts[$statusToSlotMap{$self->simpleStatus($part)}]++; |
|
} |
|
|
|
return \@counts; |
} |
} |
|
|
=pod |
=pod |
Line 3790 sub completable {
|
Line 5590 sub completable {
|
# "If any of the parts are open, or have tries left (implies open), |
# "If any of the parts are open, or have tries left (implies open), |
# and it is not "attempted" (manually graded problem), it is |
# and it is not "attempted" (manually graded problem), it is |
# not "complete" |
# not "complete" |
if (!(($status == OPEN() || $status == TRIES_LEFT()) |
if ($self->getCompletionStatus($part) == ATTEMPTED() || |
&& $self->getCompletionStatus($part) != ATTEMPTED() |
$self->getCompletionStatus($part) == CREDIT_ATTEMPTED() || |
&& $status != ANSWER_SUBMITTED())) { |
$status == ANSWER_SUBMITTED() ) { |
return 0; |
# did this part already, as well as we can |
} |
next; |
|
} |
|
if ($status == OPEN() || $status == TRIES_LEFT()) { |
|
return 1; |
|
} |
} |
} |
|
|
# If all the parts were complete, so was this problem. |
# If all the parts were complete, so was this problem. |
return 1; |
return 0; |
} |
} |
|
|
=pod |
=pod |
Line 3825 sub getNext {
|
Line 5629 sub getNext {
|
my $to = $self->to(); |
my $to = $self->to(); |
foreach my $branch ( split(/,/, $to) ) { |
foreach my $branch ( split(/,/, $to) ) { |
my $choice = $self->{NAV_MAP}->getById($branch); |
my $choice = $self->{NAV_MAP}->getById($branch); |
|
#if (!$choice->condition()) { next; } |
my $next = $choice->goesto(); |
my $next = $choice->goesto(); |
$next = $self->{NAV_MAP}->getById($next); |
$next = $self->{NAV_MAP}->getById($next); |
|
|
Line 3853 sub browsePriv {
|
Line 5658 sub browsePriv {
|
return $self->{BROWSE_PRIV}; |
return $self->{BROWSE_PRIV}; |
} |
} |
|
|
$self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre', $self->src()); |
$self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre',$self->src(), |
|
$self->symb()); |
} |
} |
|
|
=pod |
=pod |