loncom/interface/lonnavmaps.pm - diff

Return to lonnavmaps.pm CVS log

Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonnavmaps.pm between versions 1.53 and 1.59

version 1.53, 2002/09/24 03:48:18	version 1.59, 2002/10/01 19:15:22
Line 124 sub parmval {	Line 124 sub parmval {
my $courselevelm=$usercourseprefix.'.'.$mapparm;	my $courselevelm=$usercourseprefix.'.'.$mapparm;

# ---------------------------------------------------------- first, check user	# ---------------------------------------------------------- first, check user
if ($uname) {	if (defined($uname)) {
if ($useropt{$courselevelr}) { return $useropt{$courselevelr}; }	if (defined($useropt{$courselevelr})) { return $useropt{$courselevelr}; }
if ($useropt{$courselevelm}) { return $useropt{$courselevelm}; }	if (defined($useropt{$courselevelm})) { return $useropt{$courselevelm}; }
if ($useropt{$courselevel}) { return $useropt{$courselevel}; }	if (defined($useropt{$courselevel})) { return $useropt{$courselevel}; }
}	}

# ------------------------------------------------------- second, check course	# ------------------------------------------------------- second, check course
if ($csec) {	if (defined($csec)) {
if ($courseopt{$seclevelr}) { return $courseopt{$seclevelr}; }	if (defined($courseopt{$seclevelr})) { return $courseopt{$seclevelr}; }
if ($courseopt{$seclevelm}) { return $courseopt{$seclevelm}; }	if (defined($courseopt{$seclevelm})) { return $courseopt{$seclevelm}; }
if ($courseopt{$seclevel}) { return $courseopt{$seclevel}; }	if (defined($courseopt{$seclevel})) { return $courseopt{$seclevel}; }
}	}

if ($courseopt{$courselevelr}) { return $courseopt{$courselevelr}; }	if (defined($courseopt{$courselevelr})) { return $courseopt{$courselevelr}; }
if ($courseopt{$courselevelm}) { return $courseopt{$courselevelm}; }	if (defined($courseopt{$courselevelm})) { return $courseopt{$courselevelm}; }
if ($courseopt{$courselevel}) { return $courseopt{$courselevel}; }	if (defined($courseopt{$courselevel})) { return $courseopt{$courselevel}; }

# ----------------------------------------------------- third, check map parms	# ----------------------------------------------------- third, check map parms

my $thisparm=$parmhash{$symbparm};	my $thisparm=$parmhash{$symbparm};
if ($thisparm) { return $thisparm; }	if (defined($thisparm)) { return $thisparm; }

# ----------------------------------------------------- fourth , check default	# ----------------------------------------------------- fourth , check default

my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');	my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
if ($default) { return $default}	if (defined($default)) { return $default}

# --------------------------------------------------- fifth , cascade up parts	# --------------------------------------------------- fifth , cascade up parts

Line 159 sub parmval {	Line 159 sub parmval {
my ($part,$id)=split(/\_/,$space);	my ($part,$id)=split(/\_/,$space);
if ($id) {	if ($id) {
my $partgeneral=&parmval($part.".$qualifier",$symb);	my $partgeneral=&parmval($part.".$qualifier",$symb);
if ($partgeneral) { return $partgeneral; }	if (defined($partgeneral)) { return $partgeneral; }
} else {	} else {
my $resourcegeneral=&parmval("0.$qualifier",$symb);	my $resourcegeneral=&parmval("0.$qualifier",$symb);
if ($resourcegeneral) { return $resourcegeneral; }	if (defined($resourcegeneral)) { return $resourcegeneral; }
}	}
}	}
return '';	return '';
Line 827 sub new_handle {	Line 827 sub new_handle {
$ENV{"request.course.fn"}.".db",	$ENV{"request.course.fn"}.".db",
$ENV{"request.course.fn"}."_parms.db", 1);	$ENV{"request.course.fn"}."_parms.db", 1);

# Grab a resource object so we have access to the constants; this
# is technically not proper, but should be harmless
my $res = $navmap->firstResource();

# Defines a status->color mapping, null string means don't color
my %colormap =
( $res->NETWORK_FAILURE => '',
$res->CORRECT => '#BBFFBB',
$res->EXCUSED => '#BBBBFF',
$res->PAST_DUE => '#FFAA00',
$res->ANSWER_OPEN => '#FF00AA',
$res->OPEN_LATER => '',
$res->TRIES_LEFT => '#FFFF00',
$res->INCORRECT => '#FFAA00',
$res->OPEN => '#FFFF88',
$res->NOTHING_SET => '' );

if (!defined($navmap)) {	if (!defined($navmap)) {
my $requrl = $r->uri;	my $requrl = $r->uri;
Line 850 sub new_handle {	Line 834 sub new_handle {
return HTTP_NOT_ACCEPTABLE;	return HTTP_NOT_ACCEPTABLE;
}	}

	# Check that it's defined
	if (!($navmap->courseMapDefined())) {
	$r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
	'</body></html>');
	return OK;
	}

	# Grab a resource object so we have access to the constants; this
	# is technically not proper, but should be harmless
	my $res = $navmap->firstResource();

	# Defines a status->color mapping, null string means don't color
	my %colormap =
	( $res->NETWORK_FAILURE => '',
	$res->CORRECT => '',
	$res->EXCUSED => '#BBBBFF',
	$res->PAST_DUE_ANSWER_LATER => '',
	$res->PAST_DUE_NO_ANSWER => '',
	$res->ANSWER_OPEN => '#CCFFCC',
	$res->OPEN_LATER => '',
	$res->TRIES_LEFT => '',
	$res->INCORRECT => '',
	$res->OPEN => '',
	$res->NOTHING_SET => '' );
	# 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
	my $hurryUpColor = "#FFCCCC";

	my %statusIconMap =
	( $res->NETWORK_FAILURE => '',
	$res->NOTHING_SET => '',
	$res->CORRECT => 'navmap.correct.gif',
	$res->EXCUSED => 'navmap.correct.gif',
	$res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif',
	$res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif',
	$res->ANSWER_OPEN => 'navmap.wrong.gif',
	$res->OPEN_LATER => '',
	$res->TRIES_LEFT => 'navmap.open.gif',
	$res->INCORRECT => 'navmap.wrong.gif',
	$res->OPEN => 'navmap.open.gif' );

	my %condenseStatuses =
	( $res->NETWORK_FAILURE => 1,
	$res->NOTHING_SET => 1,
	$res->CORRECT => 1,
	$res->OPEN => 1 );

my %filterHash;	my %filterHash;
# Figure out what we're not displaying	# Figure out what we're not displaying
foreach (split(/\,/, $ENV{"form.filter"})) {	foreach (split(/\,/, $ENV{"form.filter"})) {
Line 859 sub new_handle {	Line 890 sub new_handle {
}	}

# Begin the HTML table	# Begin the HTML table
# two columns: the title/icon on the left, the info on the right	# four cols: resource + indent, chat+feedback, icon, text string
$r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");	$r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");

my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash);	my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash);
my $curRes = $mapIterator->next();	my $curRes = $mapIterator->next();
undef $res; # so we don't accidentally use it later	undef $res; # so we don't accidentally use it later
my $indentLevel = -1;	my $indentLevel = -1;
my $indentString = "        ";	my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\"/>";

my $isNewBranch = 0;	my $isNewBranch = 0;
	my $now = time();
	my $in24Hours = $now + 24 * 60 * 60;

while ($curRes != $mapIterator->END_NAV_MAP) {	while ($curRes != $mapIterator->END_NAV_MAP) {
if ($curRes == $mapIterator->BEGIN_MAP() \|\|	if ($curRes == $mapIterator->BEGIN_MAP() \|\|
Line 885 sub new_handle {	Line 918 sub new_handle {

if (ref($curRes) && $curRes->src()) {	if (ref($curRes) && $curRes->src()) {

	# Step one: Decide which parts to show
my @parts;	my @parts;
if ($curRes->is_problem()) {	if ($curRes->is_problem()) {
	# Is it multipart?
@parts = @{$curRes->parts()};	@parts = @{$curRes->parts()};
if (scalar(@parts) > 1) { shift(@parts); }
	my $multipart = scalar(@parts) > 1;

	if ($multipart) {
	# If it's multipart, see if part 0 is "open"
	# if it is, display all parts, if it isn't,
	# just display first
	if (!$curRes->opendate("0")) {
	@parts = ("0"); # just display the zero-th part
	} else {
	# Otherwise, only display part 0 if we want to
	# attach feedback or email information to it
	if (!$curRes->hasDiscussion() && !$curRes->getFeedback()) {
	shift @parts;
	} else {
	# If there's discussion or feedback, that counts
	# as a difference, so display the parts.

	# Now, we decide whether to condense the
	# parts due to similarity
	my $status = $curRes->status($parts[0]);
	my $allSame = 1;
	for (my $i = 1; $i < scalar(@parts); $i++) {
	if ($curRes->status($parts[$i]) != $status){
	$allSame = 0;
	}
	}

	# $allSame is true if all the statuses were
	# the same. Now, if they are all the same and
	# match one of the statuses to condense, then
	# only display part 0.
	if ($allSame && defined($condenseStatuses{$status})){
	@parts = ("0");
	}
	}
	}
	}

} else {	} else {
@parts[0] = "0"; # this is to get past foreach loop below	@parts[0] = "0"; # this is to get past foreach loop below
# you can consider a non-problem resource as a resource	# you can consider a non-problem resource as a resource
# with only one part without loss	# with only one part without loss
}	}

	# Step two: Show the parts
foreach my $part (@parts) {	foreach my $part (@parts) {

	my $deltalevel = 0; # for inserting the branch icon

# For each thing we're displaying...	# For each thing we're displaying...

Line 914 sub new_handle {	Line 990 sub new_handle {
# If this is a new branch, label it so	# If this is a new branch, label it so
# (temporary, this should be an icon w/ alt text)	# (temporary, this should be an icon w/ alt text)
if ($isNewBranch) {	if ($isNewBranch) {
$newBranchText = "NB -> ";	$newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";
$isNewBranch = 0;	$isNewBranch = 0;
	$deltalevel = 1;
}	}

# links to open and close the folders	# links to open and close the folders
Line 951 sub new_handle {	Line 1028 sub new_handle {
}	}
}	}

	# FIRST ROW: The resource indentation, branch icon, and name
$r->print(" <tr><td align=\"left\" valign=\"top\">\n");	$r->print(" <tr><td align=\"left\" valign=\"top\">\n");

# print indentation	# print indentation
for (my $i = 0; $i < $indentLevel; $i++) {	for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {
$r->print($indentString);	$r->print($indentString);
}	}

Line 963 sub new_handle {	Line 1041 sub new_handle {

if ($curRes->is_problem() && $part != "0") { $partLabel = " (Part $part)"; }	if ($curRes->is_problem() && $part != "0") { $partLabel = " (Part $part)"; }

$r->print(" <a href=\"$link\">$title$partLabel</a></td>".	$r->print(" <a href=\"$link\">$title$partLabel</a></td>");
"<td $colorizer align=\"right\">\n");
	my $discussionHTML = ""; my $feedbackHTML = "";

	# SECOND ROW: Is there text or feedback?
	if ($curRes->hasDiscussion()) {
	$discussionHTML = $linkopen .
	'<img border="0" src="/adm/lonMisc/chat.gif" />' .
	$linkclose;
	}

	if ($curRes->getFeedback()) {
	my $feedback = $curRes->getFeedback();
	foreach (split(/\,/, $feedback)) {
	if ($_) {
	$feedbackHTML .= ' <a href="/adm/email?display='
	. &Apache::lonnet::escape($_) . '">'
	. '<img src="/adm/lonMisc/feedback.gif" '
	. 'border="0" /></a>';
	}
	}
	}

	$r->print("<td align=\"left\">$discussionHTML$feedbackHTML</td>");

	# THIRD ROW: Problem status icon
	if ($curRes->is_problem()) {
	my $icon = $statusIconMap{$curRes->status()};
	if ($icon) {
	$r->print("<td width=\"50\" align=\"right\">$linkopen<img src=\"/adm/lonIcons/$icon\" border=\"0\" />$linkclose</td>\n");
	} else {
	$r->print("<td></td>\n");
	}
	} else { # not problem, no icon
	$r->print("<td></td>\n");
	}

	# FOURTH ROW: Text description
	$r->print("<td $colorizer align=\"right\">\n");

if ($curRes->kind() eq "res" and	if ($curRes->kind() eq "res" and
$curRes->is_problem() ) {	$curRes->is_problem() ) {
$r->print (getDescription($curRes, $part));	$r->print (getDescription($curRes, $part));
}	}

	$r->print("</td></tr>\n");
}	}
}	}
$curRes = $mapIterator->next();	$curRes = $mapIterator->next();
Line 977 sub new_handle {	Line 1094 sub new_handle {

$r->print("</table></body></html>");	$r->print("</table></body></html>");

	$navmap->untieHashes();

return OK;	return OK;
}	}

Line 1045 sub getDescription {	Line 1164 sub getDescription {
return "Opens: " . timeToHumanString($res->opendate($part));	return "Opens: " . timeToHumanString($res->opendate($part));
}	}
if ($status == $res->OPEN) {	if ($status == $res->OPEN) {
return "Due: " . timeToHumanString($res->duedate($part));	if ($res->duedate()) {
	return "Due: $status " . timeToHumanString($res->duedate($part));
	} else {
	return "Open, no due date";
	}
	}
	if ($status == $res->PAST_DUE_ANSWER_LATER) {
	return "Answer opens: " . timeToHumanString($res->answerdate($part));
}	}
if ($status == $res->PAST_DUE) {	if ($status == $res->PAST_DUE_NO_ANSWER) {
return "Answer: " . timeToHumanString($res->duedate($part));	return "Was Due: " . timeToHumanString($res->duedate($part));
}	}
if ($status == $res->ANSWER_OPEN) {	if ($status == $res->ANSWER_OPEN) {
return "Answer available";	return "Answer available";
}	}
	if ($status == $res->EXCUSED) {
	return "Excused by instructor";
	}
	if ($status == $res->TRIES_LEFT) {
	my $tries = $res->tries();
	my $maxtries = $res->maxtries();
	my $triesString = "($tries of $maxtries tries used)";
	if ($res->duedate()) {
	return "Due: $status " . timeToHumanString($res->duedate($part)) .
	" $triesString";
	} else {
	return "No due date $triesString";
	}
	}
}	}

# I want to change this into something more human-friendly. For	# I want to change this into something more human-friendly. For
# now, this is a simple call to localtime. The final function	# now, this is a simple call to localtime. The final function
# probably belongs in loncommon.	# probably belongs in loncommon.
sub timeToHumanString {	sub timeToHumanString {
return localtime(shift);	my ($time) = @_;
	# zero, '0' and blank are bad times
	if ($time) {
	return localtime($time);
	} else {
	return 'Never';
	}
}	}

1;	1;
Line 1087 You must obtain resource objects through	Line 1232 You must obtain resource objects through

=over 4	=over 4

=item * B<new>(filename, parmHashFile, genCourseAndUserOptions): Binds a new navmap object to the compiled course representation and parmHashFile. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. Returns the navmap object if this is successful, or B<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise.	=item * B<new>(filename, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled course representation and parmHashFile. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or 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): See iterator documentation below.	=item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.

Line 1105 sub new {	Line 1250 sub new {
$self->{NAV_HASH_FILE} = shift;	$self->{NAV_HASH_FILE} = shift;
$self->{PARM_HASH_FILE} = shift;	$self->{PARM_HASH_FILE} = shift;
$self->{GENERATE_COURSE_USER_OPT} = shift;	$self->{GENERATE_COURSE_USER_OPT} = shift;
	$self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;

# Resource cache stores navmapresource's as we reference them. We generate	# Resource cache stores navmapresource's 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 1182 sub new {	Line 1328 sub new {
$useropt{$userprefix.&Apache::lonnet::unescape($name)}=	$useropt{$userprefix.&Apache::lonnet::unescape($name)}=
&Apache::lonnet::unescape($value);	&Apache::lonnet::unescape($value);
}	}
$self->{COURSE_OPT} = \%courseopt;	$self->{COURSE_OPT} = \%courseopt;
$self->{USER_OPT} = \%useropt;	$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}='';
	}

	if (($status{$msgid} eq 'new') \|\|
	(!$status{$msgid})) {
	if ($what eq 'Error') {
	$error{$url}.=','.$msgid;
	} else {
	$feedback{$url}.=','.$msgid;
	}
	}
	}
	}

	$self->{FEEDBACK} = \%feedback;
	$self->{ERROR_MSG} = \%error; # what is this? JB
	$self->{DISCUSSION_TIME} = \%discussiontime;
	$self->{EMAIL_STATUS} = \%emailstatus;

	}

bless($self);	bless($self);

return $self;	return $self;
}	}

	# Checks to see if coursemap is defined, matching test in old lonnavmaps
	sub courseMapDefined {
	my $self = shift;
	my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});

	my $firstres = $self->{NAV_HASH}->{"map_start_$uri"};
	my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"};
	return $firstres && $lastres;
	}

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,
Line 1213 sub DESTROY {	Line 1416 sub DESTROY {
$self->untieHashes();	$self->untieHashes();
}	}

	# Private function: Does the given resource (as a symb string) have
	# current discussion? Returns 0 if chat/mail data not extracted.
	sub hasDiscussion {
	my $self = shift;
	my $symb = shift;
	if (!defined($self->{DISCUSSION_TIME})) { return 0; }

	return $self->{DISCUSSION_TIME}->{$symb} >
	$self->{LAST_CHECK};
	}

	# Private function: Does the given resource (as a symb string) have
	# current feedback? Returns the string in the feedback hash, which
	# will be false if it does not exist.
	sub getFeedback {
	my $self = shift;
	my $symb = shift;

	if (!defined($self->{FEEDBACK})) { return ""; }

	return $self->{FEEDBACK}->{$symb};
	}

=pod	=pod

=item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.	=item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.
Line 1307 sub parmval {	Line 1533 sub parmval {

# ---------------------------------------------------------- first, check user	# ---------------------------------------------------------- first, check user
if ($uname and defined($useropt)) {	if ($uname and defined($useropt)) {
if ($$useropt{$courselevelr}) { return $$useropt{$courselevelr}; }	if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; }
if ($$useropt{$courselevelm}) { return $$useropt{$courselevelm}; }	if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; }
if ($$useropt{$courselevel}) { return $$useropt{$courselevel}; }	if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; }
}	}

# ------------------------------------------------------- second, check course	# ------------------------------------------------------- second, check course
if ($csec and defined($courseopt)) {	if ($csec and defined($courseopt)) {
if ($$courseopt{$seclevelr}) { return $$courseopt{$seclevelr}; }	if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
if ($$courseopt{$seclevelm}) { return $$courseopt{$seclevelm}; }	if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
if ($$courseopt{$seclevel}) { return $$courseopt{$seclevel}; }	if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; }
}	}

if (defined($courseopt)) {	if (defined($courseopt)) {
if ($$courseopt{$courselevelr}) { return $$courseopt{$courselevelr}; }	if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; }
if ($$courseopt{$courselevelm}) { return $$courseopt{$courselevelm}; }	if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; }
if ($$courseopt{$courselevel}) { return $$courseopt{$courselevel}; }	if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; }
}	}

# ----------------------------------------------------- third, check map parms	# ----------------------------------------------------- third, check map parms

my $thisparm=$$parmhash{$symbparm};	my $thisparm=$$parmhash{$symbparm};
if ($thisparm) { return $thisparm; }	if (defined($thisparm)) { return $thisparm; }

# ----------------------------------------------------- fourth , check default	# ----------------------------------------------------- fourth , check default

my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');	my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
if ($default) { return $default}	if (defined($default)) { return $default}

# --------------------------------------------------- fifth , cascade up parts	# --------------------------------------------------- fifth , cascade up parts

Line 1343 sub parmval {	Line 1569 sub parmval {
my ($part,$id)=split(/\_/,$space);	my ($part,$id)=split(/\_/,$space);
if ($id) {	if ($id) {
my $partgeneral=$self->parmval($part.".$qualifier",$symb);	my $partgeneral=$self->parmval($part.".$qualifier",$symb);
if ($partgeneral) { return $partgeneral; }	if (defined($partgeneral)) { return $partgeneral; }
} else {	} else {
my $resourcegeneral=$self->parmval("0.$qualifier",$symb);	my $resourcegeneral=$self->parmval("0.$qualifier",$symb);
if ($resourcegeneral) { return $resourcegeneral; }	if (defined($resourcegeneral)) { return $resourcegeneral; }
}	}
}	}
return '';	return '';
Line 1945 Misc. functions for the resource.	Line 2171 Misc. functions for the resource.

=over 4	=over 4

	=item * B<hasDiscussion>: Returns a false value if there has been discussion since the user last logged in, true if there has. Always returns false if the discussion data was not extracted when the nav map was constructed.

	=item * B<getFeedback>: Gets the feedback for the resource and returns the raw feedback string for the resource, or the null string if there is no feedback or the email data was not extracted when the nav map was constructed. Usually used like this:

	for (split(/\,/, $res->getFeedback())) {
	my $link = &Apache::lonnet::escape($_);
	...

	and use the link as appropriate.

	=cut

	sub hasDiscussion {
	my $self = shift;
	return $self->{NAV_MAP}->hasDiscussion($self->symb());
	}

	sub getFeedback {
	my $self = shift;
	return $self->{NAV_MAP}->getFeedback($self->symb());
	}

	=pod

=item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. You may or may not wish to filter out part 0.)	=item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. You may or may not wish to filter out part 0.)

=item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0.	=item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0.
Line 2012 Idiomatic usage of these two methods wou	Line 2262 Idiomatic usage of these two methods wou

=over 4	=over 4

=item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part, with the following possible results:	=item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. You should still check to see if there is a due date at all, if you care about that. The possible return values are:

=back	=back

Line 2024 B<Date Codes>	Line 2274 B<Date Codes>

=item * B<OPEN>: Open and not yet due.	=item * B<OPEN>: Open and not yet due.

=item * B<PAST_DUE>: The due date has passed, but the answer date has not yet arrived.
	=item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.

	=item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.

=item * B<ANSWER_OPEN>: The answer date is here.	=item * B<ANSWER_OPEN>: The answer date is here.

Line 2035 B<Date Codes>	Line 2288 B<Date Codes>
=cut	=cut

# Apparently the compiler optimizes these into constants automatically	# Apparently the compiler optimizes these into constants automatically
sub OPEN_LATER { return 0; }	sub OPEN_LATER { return 0; }
sub OPEN { return 1; }	sub OPEN { return 1; }
sub PAST_DUE { return 2; }	sub PAST_DUE_NO_ANSWER { return 2; }
sub ANSWER_OPEN { return 3; }	sub PAST_DUE_ANSWER_LATER { return 3; }
sub NOTHING_SET { return 4; }	sub ANSWER_OPEN { return 4; }
sub NETWORK_FAILURE { return 100; }	sub NOTHING_SET { return 5; }
	sub NETWORK_FAILURE { return 100; }

	# getDateStatus gets the date status for a given problem part.
	# Because answer date, due date, and open date are fully independent
	# (i.e., it is perfectly possible to only have an answer date),
	# we have to completely cover the 3x3 maxtrix of (answer, due, open) x
	# (past, future, none given). This function handles this with a decision
	# tree. Read the comments to follow the decision tree.

sub getDateStatus {	sub getDateStatus {
my $self = shift;	my $self = shift;
my $part = shift;	my $part = shift;
$part = "0" if (!defined($part));	$part = "0" if (!defined($part));

	# Always return network failure if there was one.
return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});	return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});

my $now = time();	my $now = time();
Line 2054 sub getDateStatus {	Line 2317 sub getDateStatus {
my $due = $self->duedate($part);	my $due = $self->duedate($part);
my $answer = $self->answerdate($part);	my $answer = $self->answerdate($part);

if ($open && $now < $open) {return $self->OPEN_LATER};
if ($due && $now < $due) {return $self->OPEN};
if ($answer && $now < $answer) {return $self->PAST_DUE};
if (!$open && !$due && !$answer) {	if (!$open && !$due && !$answer) {
# no data on the problem at all	# no data on the problem at all
# should this be the same as "open later"? think multipart.	# should this be the same as "open later"? think multipart.
return $self->NOTHING_SET;	return $self->NOTHING_SET;
}	}
return $self->ANSWER_OPEN;	if (!$open \|\| $now < $open) {return $self->OPEN_LATER}
	if (!$due \|\| $now < $due) {return $self->OPEN}
	if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
	if ($answer) { return $self->ANSWER_OPEN; }
	return PAST_DUE_NO_ANSWER;
}	}

=pod	=pod
Line 2134 Along with directly returning the date o	Line 2398 Along with directly returning the date o

=item * NETWORK_FAILURE: The network has failed and the information is not available.	=item * NETWORK_FAILURE: The network has failed and the information is not available.

=item * NOTHING_SET: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened.)	=item * NOTHING_SET: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".)

=item * CORRECT: For any reason at all, the part is considered correct.	=item * CORRECT: For any reason at all, the part is considered correct.

=item * EXCUSED: For any reason at all, the problem is excused.	=item * EXCUSED: For any reason at all, the problem is excused.

=item * PAST_DUE: The problem is past due, and not considered correct.	=item * PAST_DUE_NO_ANSWER: The problem is past due, not considered correct, and no answer date is set.

	=item * PAST_DUE_ANSWER_LATER: The problem is past due, not considered correct, and an answer date in the future is set.

=item * ANSWER_OPEN: The problem is past due, not correct, and the answer is now available.	=item * ANSWER_OPEN: The problem is past due, not correct, and the answer is now available.

Line 2167 sub status {	Line 2433 sub status {

# What we have is a two-dimensional matrix with 4 entries on one	# What we have is a two-dimensional matrix with 4 entries on one
# 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".	# plus network failure and "no date data at all".

if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }	if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }

Line 2189 sub status {	Line 2455 sub status {
# Now we're down to a 3 (incorrect, incorrect_override, not_attempted)	# Now we're down to a 3 (incorrect, incorrect_override, not_attempted)
# by 4 matrix (date status).	# by 4 matrix (date status).

if ($dateStatus == PAST_DUE) {	if ($dateStatus == PAST_DUE_ANSWER_LATER \|\|
return PAST_DUE;	$dateStatus == PAST_DUE_NO_ANSWER ) {
	return $dateStatus;
}	}

if ($dateStatus == ANSWER_OPEN) {	if ($dateStatus == ANSWER_OPEN) {

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.53
changed lines
	Added in v.1.59