--- loncom/interface/lonnavmaps.pm 2002/09/26 16:56:21 1.55 +++ loncom/interface/lonnavmaps.pm 2002/10/03 19:08:14 1.61 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Navigate Maps Handler # -# $Id: lonnavmaps.pm,v 1.55 2002/09/26 16:56:21 bowersj2 Exp $ +# $Id: lonnavmaps.pm,v 1.61 2002/10/03 19:08:14 bowersj2 Exp $ # # Copyright Michigan State University Board of Trustees # @@ -124,32 +124,32 @@ sub parmval { my $courselevelm=$usercourseprefix.'.'.$mapparm; # ---------------------------------------------------------- first, check user - if ($uname) { - if ($useropt{$courselevelr}) { return $useropt{$courselevelr}; } - if ($useropt{$courselevelm}) { return $useropt{$courselevelm}; } - if ($useropt{$courselevel}) { return $useropt{$courselevel}; } + if (defined($uname)) { + if (defined($useropt{$courselevelr})) { return $useropt{$courselevelr}; } + if (defined($useropt{$courselevelm})) { return $useropt{$courselevelm}; } + if (defined($useropt{$courselevel})) { return $useropt{$courselevel}; } } # ------------------------------------------------------- second, check course - if ($csec) { - if ($courseopt{$seclevelr}) { return $courseopt{$seclevelr}; } - if ($courseopt{$seclevelm}) { return $courseopt{$seclevelm}; } - if ($courseopt{$seclevel}) { return $courseopt{$seclevel}; } + if (defined($csec)) { + if (defined($courseopt{$seclevelr})) { return $courseopt{$seclevelr}; } + if (defined($courseopt{$seclevelm})) { return $courseopt{$seclevelm}; } + if (defined($courseopt{$seclevel})) { return $courseopt{$seclevel}; } } - if ($courseopt{$courselevelr}) { return $courseopt{$courselevelr}; } - if ($courseopt{$courselevelm}) { return $courseopt{$courselevelm}; } - if ($courseopt{$courselevel}) { return $courseopt{$courselevel}; } + if (defined($courseopt{$courselevelr})) { return $courseopt{$courselevelr}; } + if (defined($courseopt{$courselevelm})) { return $courseopt{$courselevelm}; } + if (defined($courseopt{$courselevel})) { return $courseopt{$courselevel}; } # ----------------------------------------------------- third, check map parms my $thisparm=$parmhash{$symbparm}; - if ($thisparm) { return $thisparm; } + if (defined($thisparm)) { return $thisparm; } # ----------------------------------------------------- fourth , check default my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default'); - if ($default) { return $default} + if (defined($default)) { return $default} # --------------------------------------------------- fifth , cascade up parts @@ -159,10 +159,10 @@ sub parmval { my ($part,$id)=split(/\_/,$space); if ($id) { my $partgeneral=&parmval($part.".$qualifier",$symb); - if ($partgeneral) { return $partgeneral; } + if (defined($partgeneral)) { return $partgeneral; } } else { my $resourcegeneral=&parmval("0.$qualifier",$symb); - if ($resourcegeneral) { return $resourcegeneral; } + if (defined($resourcegeneral)) { return $resourcegeneral; } } } return ''; @@ -848,16 +848,37 @@ sub new_handle { # Defines a status->color mapping, null string means don't color my %colormap = ( $res->NETWORK_FAILURE => '', - $res->CORRECT => '#BBFFBB', + $res->CORRECT => '', $res->EXCUSED => '#BBBBFF', - $res->PAST_DUE_ANSWER_LATER => '#FFAA00', - $res->PAST_DUE_NO_ANSWER => '#FFAA00', - $res->ANSWER_OPEN => '#FF00AA', + $res->PAST_DUE_ANSWER_LATER => '', + $res->PAST_DUE_NO_ANSWER => '', + $res->ANSWER_OPEN => '#CCFFCC', $res->OPEN_LATER => '', - $res->TRIES_LEFT => '#FFFF00', - $res->INCORRECT => '#FFAA00', - $res->OPEN => '#FFFF88', + $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 ); my %filterHash; # Figure out what we're not displaying @@ -868,16 +889,18 @@ sub new_handle { } # 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('' ."\n"); my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash); my $curRes = $mapIterator->next(); undef $res; # so we don't accidentally use it later my $indentLevel = -1; - my $indentString = "        "; + my $indentString = "\"\""; my $isNewBranch = 0; + my $now = time(); + my $in24Hours = $now + 24 * 60 * 60; while ($curRes != $mapIterator->END_NAV_MAP) { if ($curRes == $mapIterator->BEGIN_MAP() || @@ -894,17 +917,76 @@ sub new_handle { if (ref($curRes) && $curRes->src()) { - my @parts; + # Step one: Decide which parts to show + my @parts = @{$curRes->parts()}; + my $multipart = scalar(@parts) > 1; + my $condensed = 0; + if ($curRes->is_problem()) { - @parts = @{$curRes->parts()}; - if (scalar(@parts) > 1) { shift(@parts); } + # Is it multipart? + + 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[1]); + my $due = $curRes->duedate($parts[1]); + my $open = $curRes->opendaute($parts[1]); + my $statusAllSame = 1; + my $dueAllSame = 1; + my $openAllSame = 1; + for (my $i = 2; $i < scalar(@parts); $i++) { + if ($curRes->status($parts[$i]) != $status){ + $statusAllSame = 0; + } + if ($curRes->duedate($parts[$i]) != $due ) { + $dueAllSame = 0; + } + if ($curRes->opendate($parts[$i]) != $open) { + $openAllSame = 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, or they + # are all open with the same due date, or they are + # all OPEN_LATER with the same open date, display the + # status of the first non-zero part (to get the 'correct' + # status right, since 0 is never 'correct' or 'open'). + if (($statusAllSame && defined($condenseStatuses{$status})) || + ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)|| + ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){ + @parts = ($parts[1]); + $condensed = 1; + } + } + } + } + } else { @parts[0] = "0"; # this is to get past foreach loop below # you can consider a non-problem resource as a resource # with only one part without loss } + # Step two: Show the parts foreach my $part (@parts) { + + my $deltalevel = 0; # for inserting the branch icon # For each thing we're displaying... @@ -923,17 +1005,22 @@ sub new_handle { # If this is a new branch, label it so # (temporary, this should be an icon w/ alt text) if ($isNewBranch) { - $newBranchText = "NB -> "; + $newBranchText = ""; $isNewBranch = 0; + $deltalevel = 1; } # links to open and close the folders my $linkopen = ""; my $linkclose = ""; - my $icon = "html.gif"; + my $icon = "\"\""; if ($curRes->is_problem()) { - $icon = "problem.gif"; + if ($part eq "0" || $condensed) { + $icon = ''; + } else { + $icon = $indentString; + } } # Display the correct icon, link to open or shut map @@ -942,6 +1029,7 @@ sub new_handle { my $nowOpen = !defined($filterHash{$mapId}); $icon = $nowOpen ? "folder_opened.gif" : "folder_closed.gif"; + $icon = "\"\""; $linkopen = "print(" "); + + my $discussionHTML = ""; my $feedbackHTML = ""; + + # SECOND ROW: Is there text or feedback? + if ($curRes->hasDiscussion()) { + $discussionHTML = $linkopen . + '' . + $linkclose; + } + + if ($curRes->getFeedback()) { + my $feedback = $curRes->getFeedback(); + foreach (split(/\,/, $feedback)) { + if ($_) { + $feedbackHTML .= ' ' + . ''; + } + } + } + + $r->print(""); + + # Is this the first displayed part of a multi-part problem + # that has not been condensed, so we should suppress these two + # columns? + my $firstDisplayed = !$condensed && $multipart && $part eq "0"; + + # THIRD ROW: Problem status icon + if ($curRes->is_problem() && + !$firstDisplayed) { + my $icon = $statusIconMap{$curRes->status($part)}; + if ($icon) { + $r->print("\n"); + } else { + $r->print("\n"); + } + } else { # not problem, no icon + $r->print("\n"); + } - $r->print(" $title$partLabel". - "\n"); } } $curRes = $mapIterator->next(); @@ -986,6 +1123,8 @@ sub new_handle { $r->print("
\n"); # print indentation - for (my $i = 0; $i < $indentLevel; $i++) { + for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) { $r->print($indentString); } - $r->print(" ${newBranchText}${linkopen}\"\"${linkclose}\n"); + $r->print(" ${newBranchText}${linkopen}$icon${linkclose}\n"); - if ($curRes->is_problem() && $part != "0") { $partLabel = " (Part $part)"; } + if ($curRes->is_problem() && $part != "0" && !$condensed) { + $partLabel = " (Part $part)"; + $title = ""; + } + + $r->print(" $title$partLabel$discussionHTML$feedbackHTML$linkopen$linkclose\n"); + # FOURTH ROW: Text description + $r->print("\n"); - if ($curRes->kind() eq "res" and - $curRes->is_problem() ) { + if ($curRes->kind() eq "res" && + $curRes->is_problem() && + !$firstDisplayed) { $r->print (getDescription($curRes, $part)); } + + $r->print("
"); + $navmap->untieHashes(); + return OK; } @@ -1054,10 +1193,14 @@ sub getDescription { return "Opens: " . timeToHumanString($res->opendate($part)); } if ($status == $res->OPEN) { - return "Due: $status " . 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: " . timeToHumanString($res->answerdate($part)); + return "Answer opens: " . timeToHumanString($res->answerdate($part)); } if ($status == $res->PAST_DUE_NO_ANSWER) { return "Was Due: " . timeToHumanString($res->duedate($part)); @@ -1065,13 +1208,33 @@ sub getDescription { if ($status == $res->ANSWER_OPEN) { 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 # now, this is a simple call to localtime. The final function # probably belongs in loncommon. sub timeToHumanString { - return localtime(shift); + my ($time) = @_; + # zero, '0' and blank are bad times + if ($time) { + return localtime($time); + } else { + return 'Never'; + } } 1; @@ -1138,6 +1301,7 @@ sub new { if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE}, &GDBM_READER(), 0640))) { + untie $self->{PARM_HASH}; return undef; } $self->{PARM_HASH} = \%parmhash; @@ -1204,11 +1368,11 @@ sub new { my ($cdom,$cnum)=split(/\_/,$cid); my %emailstatus = &Apache::lonnet::dump('email_status'); - my logoutTime = $emailstatus{'logout'}; - my courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}}; + 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', + my %discussiontime = &Apache::lonnet::dump('discussiontimes', $cdom, $cnum); my %feedback=(); my %error=(); @@ -1256,8 +1420,8 @@ 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'}; + my $firstres = $self->{NAV_HASH}->{"map_start_$uri"}; + my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"}; return $firstres && $lastres; } @@ -1271,8 +1435,8 @@ sub getIterator { # unties the hash when done sub untieHashes { my $self = shift; - untie $self->{NAV_HASH} if ($self->{HASH_TIED}); - untie $self->{PARM_HASH} if ($self->{HASH_TIED}); + untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED}); + untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED}); $self->{HASH_TIED} = 0; } @@ -1282,6 +1446,29 @@ sub DESTROY { $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 =item * B(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. @@ -1376,33 +1563,33 @@ sub parmval { # ---------------------------------------------------------- first, check user if ($uname and defined($useropt)) { - if ($$useropt{$courselevelr}) { return $$useropt{$courselevelr}; } - if ($$useropt{$courselevelm}) { return $$useropt{$courselevelm}; } - if ($$useropt{$courselevel}) { return $$useropt{$courselevel}; } + if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; } + if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; } + if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; } } # ------------------------------------------------------- second, check course if ($csec and defined($courseopt)) { - if ($$courseopt{$seclevelr}) { return $$courseopt{$seclevelr}; } - if ($$courseopt{$seclevelm}) { return $$courseopt{$seclevelm}; } - if ($$courseopt{$seclevel}) { return $$courseopt{$seclevel}; } + if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; } + if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; } + if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; } } if (defined($courseopt)) { - if ($$courseopt{$courselevelr}) { return $$courseopt{$courselevelr}; } - if ($$courseopt{$courselevelm}) { return $$courseopt{$courselevelm}; } - if ($$courseopt{$courselevel}) { return $$courseopt{$courselevel}; } + if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; } + if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; } + if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; } } # ----------------------------------------------------- third, check map parms my $thisparm=$$parmhash{$symbparm}; - if ($thisparm) { return $thisparm; } + if (defined($thisparm)) { return $thisparm; } # ----------------------------------------------------- fourth , check default my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default'); - if ($default) { return $default} + if (defined($default)) { return $default} # --------------------------------------------------- fifth , cascade up parts @@ -1412,10 +1599,10 @@ sub parmval { my ($part,$id)=split(/\_/,$space); if ($id) { my $partgeneral=$self->parmval($part.".$qualifier",$symb); - if ($partgeneral) { return $partgeneral; } + if (defined($partgeneral)) { return $partgeneral; } } else { my $resourcegeneral=$self->parmval("0.$qualifier",$symb); - if ($resourcegeneral) { return $resourcegeneral; } + if (defined($resourcegeneral)) { return $resourcegeneral; } } } return ''; @@ -2014,6 +2201,30 @@ Misc. functions for the resource. =over 4 +=item * B: 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: 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(): 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(): 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. @@ -2081,7 +2292,7 @@ Idiomatic usage of these two methods wou =over 4 -=item * B($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($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 @@ -2093,6 +2304,7 @@ B =item * B: Open and not yet due. + =item * B: The due date has passed, but the answer date has not yet arrived. =item * B: The due date has passed and there is no answer opening date set. @@ -2140,10 +2352,10 @@ sub getDateStatus { # should this be the same as "open later"? think multipart. return $self->NOTHING_SET; } - 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; }; + 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; } @@ -2216,7 +2428,7 @@ Along with directly returning the date o =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. @@ -2274,7 +2486,7 @@ sub status { # by 4 matrix (date status). if ($dateStatus == PAST_DUE_ANSWER_LATER || - $dateStatus == PAST_DUE_NO_ANSWER) { + $dateStatus == PAST_DUE_NO_ANSWER ) { return $dateStatus; } @@ -2326,9 +2538,12 @@ sub getNext { my $next = $choice->goesto(); $next = $self->{NAV_MAP}->getById($next); - # Don't remember it if we've already seen it + # Don't remember it if we've already seen it or if + # the student doesn't have browse priviledges + my $browsePriv = &Apache::lonnet::allowed('bre', $self->src); if (!defined($alreadySeenHash) || - !defined($alreadySeenHash->{$next->{ID}})) { + !defined($alreadySeenHash->{$next->{ID}}) || + ($browsePriv ne '2' && $browsePriv ne 'F')) { push @branches, $next; } }