Annotation of loncom/interface/lonnavmaps.pm, revision 1.246
1.2 www 1: # The LearningOnline Network with CAPA
2: # Navigate Maps Handler
1.1 www 3: #
1.246 ! albertel 4: # $Id: lonnavmaps.pm,v 1.245 2004/02/10 22:12:46 www Exp $
1.20 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.245 www 28: ###
1.2 www 29:
1.1 www 30: package Apache::lonnavmaps;
31:
32: use strict;
1.2 www 33: use Apache::Constants qw(:common :http);
1.18 albertel 34: use Apache::loncommon();
1.150 www 35: use Apache::lonmenu();
1.229 www 36: use Apache::lonlocal;
1.73 bowersj2 37: use POSIX qw (floor strftime);
1.192 bowersj2 38: use Data::Dumper; # for debugging, not always used
1.2 www 39:
1.133 bowersj2 40: # symbolic constants
41: sub SYMB { return 1; }
42: sub URL { return 2; }
43: sub NOTHING { return 3; }
44:
45: # Some data
46:
1.140 bowersj2 47: my $resObj = "Apache::lonnavmaps::resource";
48:
1.135 bowersj2 49: # Keep these mappings in sync with lonquickgrades, which uses the colors
50: # instead of the icons.
51: my %statusIconMap =
1.224 bowersj2 52: (
53: $resObj->CLOSED => '',
54: $resObj->OPEN => 'navmap.open.gif',
55: $resObj->CORRECT => 'navmap.correct.gif',
56: $resObj->INCORRECT => 'navmap.wrong.gif',
57: $resObj->ATTEMPTED => 'navmap.ellipsis.gif',
58: $resObj->ERROR => ''
59: );
1.135 bowersj2 60:
61: my %iconAltTags =
62: ( 'navmap.correct.gif' => 'Correct',
63: 'navmap.wrong.gif' => 'Incorrect',
64: 'navmap.open.gif' => 'Open' );
1.133 bowersj2 65:
1.136 bowersj2 66: # Defines a status->color mapping, null string means don't color
67: my %colormap =
1.140 bowersj2 68: ( $resObj->NETWORK_FAILURE => '',
69: $resObj->CORRECT => '',
70: $resObj->EXCUSED => '#3333FF',
71: $resObj->PAST_DUE_ANSWER_LATER => '',
72: $resObj->PAST_DUE_NO_ANSWER => '',
73: $resObj->ANSWER_OPEN => '#006600',
74: $resObj->OPEN_LATER => '',
75: $resObj->TRIES_LEFT => '',
76: $resObj->INCORRECT => '',
77: $resObj->OPEN => '',
1.207 bowersj2 78: $resObj->NOTHING_SET => '',
79: $resObj->ATTEMPTED => '',
80: $resObj->ANSWER_SUBMITTED => ''
81: );
1.136 bowersj2 82: # And a special case in the nav map; what to do when the assignment
83: # is not yet done and due in less then 24 hours
84: my $hurryUpColor = "#FF0000";
1.130 www 85:
1.1 www 86: sub handler {
1.99 bowersj2 87: my $r = shift;
1.118 bowersj2 88: real_handler($r);
89: }
90:
91: sub real_handler {
92: my $r = shift;
1.2 www 93:
1.51 bowersj2 94: # Handle header-only request
95: if ($r->header_only) {
96: if ($ENV{'browser.mathml'}) {
1.232 www 97: &Apache::loncommon::content_type($r,'text/xml');
1.51 bowersj2 98: } else {
1.232 www 99: &Apache::loncommon::content_type($r,'text/html');
1.51 bowersj2 100: }
101: $r->send_http_header;
102: return OK;
103: }
104:
105: # Send header, don't cache this page
106: if ($ENV{'browser.mathml'}) {
1.232 www 107: &Apache::loncommon::content_type($r,'text/xml');
1.51 bowersj2 108: } else {
1.232 www 109: &Apache::loncommon::content_type($r,'text/html');
1.51 bowersj2 110: }
111: &Apache::loncommon::no_cache($r);
112: $r->send_http_header;
113:
1.106 bowersj2 114: # Create the nav map
1.221 bowersj2 115: my $navmap = Apache::lonnavmaps::navmap->new();
1.51 bowersj2 116:
1.55 bowersj2 117: if (!defined($navmap)) {
118: my $requrl = $r->uri;
119: $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
120: return HTTP_NOT_ACCEPTABLE;
121: }
1.64 bowersj2 122:
1.111 bowersj2 123: $r->print("<html><head>\n");
1.229 www 124: $r->print("<title>".&mt('Navigate Course Contents')."</title>");
1.150 www 125: # ------------------------------------------------------------ Get query string
126: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']);
1.158 bowersj2 127:
1.150 www 128: # ----------------------------------------------------- Force menu registration
129: my $addentries='';
130: if ($ENV{'form.register'}) {
131: $addentries=' onLoad="'.&Apache::lonmenu::loadevents().
132: '" onUnload="'.&Apache::lonmenu::unloadevents().'"';
133: $r->print(&Apache::lonmenu::registerurl(1));
134: }
1.111 bowersj2 135:
1.64 bowersj2 136: # Header
1.150 www 137: $r->print('</head>'.
138: &Apache::loncommon::bodytag('Navigate Course Contents','',
1.151 www 139: $addentries,'','',$ENV{'form.register'}));
1.64 bowersj2 140: $r->print('<script>window.focus();</script>');
1.101 bowersj2 141:
1.124 bowersj2 142: $r->rflush();
143:
1.55 bowersj2 144: # Check that it's defined
145: if (!($navmap->courseMapDefined())) {
146: $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
147: '</body></html>');
148: return OK;
149: }
150:
1.178 bowersj2 151: # See if there's only one map in the top-level, if we don't
152: # already have a filter... if so, automatically display it
1.222 bowersj2 153: # (older code; should use retrieveResources)
1.179 bowersj2 154: if ($ENV{QUERY_STRING} !~ /filter/) {
1.178 bowersj2 155: my $iterator = $navmap->getIterator(undef, undef, undef, 0);
1.222 bowersj2 156: my $curRes;
1.178 bowersj2 157: my $sequenceCount = 0;
158: my $sequenceId;
1.222 bowersj2 159: while ($curRes = $iterator->next()) {
1.178 bowersj2 160: if (ref($curRes) && $curRes->is_sequence()) {
161: $sequenceCount++;
162: $sequenceId = $curRes->map_pc();
1.179 bowersj2 163: }
1.178 bowersj2 164: }
165:
166: if ($sequenceCount == 1) {
167: # The automatic iterator creation in the render call
168: # will pick this up. We know the condition because
169: # the defined($ENV{'form.filter'}) also ensures this
170: # is a fresh call.
171: $ENV{'form.filter'} = "$sequenceId";
1.155 bowersj2 172: }
173: }
174:
1.191 bowersj2 175: my $jumpToFirstHomework = 0;
1.184 bowersj2 176: # Check to see if the student is jumping to next open, do-able problem
177: if ($ENV{QUERY_STRING} eq 'jumpToFirstHomework') {
1.191 bowersj2 178: $jumpToFirstHomework = 1;
1.184 bowersj2 179: # Find the next homework problem that they can do.
180: my $iterator = $navmap->getIterator(undef, undef, undef, 1);
1.222 bowersj2 181: my $curRes;
1.184 bowersj2 182: my $foundDoableProblem = 0;
183: my $problemRes;
184:
1.222 bowersj2 185: while (($curRes = $iterator->next()) && !$foundDoableProblem) {
1.184 bowersj2 186: if (ref($curRes) && $curRes->is_problem()) {
187: my $status = $curRes->status();
1.191 bowersj2 188: if ($curRes->completable()) {
1.184 bowersj2 189: $problemRes = $curRes;
190: $foundDoableProblem = 1;
191:
192: # Pop open all previous maps
193: my $stack = $iterator->getStack();
194: pop @$stack; # last resource in the stack is the problem
195: # itself, which we don't need in the map stack
196: my @mapPcs = map {$_->map_pc()} @$stack;
197: $ENV{'form.filter'} = join(',', @mapPcs);
198:
199: # Mark as both "here" and "jump"
200: $ENV{'form.postsymb'} = $curRes->symb();
201: }
202: }
203: }
204:
205: # If we found no problems, print a note to that effect.
206: if (!$foundDoableProblem) {
207: $r->print("<font size='+2'>All homework assignments have been completed.</font><br /><br />");
208: }
209: } else {
210: $r->print("<a href='navmaps?jumpToFirstHomework'>" .
1.229 www 211: &mt("Go To My First Homework Problem")."</a> ");
1.184 bowersj2 212: }
213:
1.191 bowersj2 214: my $suppressEmptySequences = 0;
215: my $filterFunc = undef;
1.201 bowersj2 216: my $resource_no_folder_link = 0;
217:
1.191 bowersj2 218: # Display only due homework.
219: my $showOnlyHomework = 0;
220: if ($ENV{QUERY_STRING} eq 'showOnlyHomework') {
221: $showOnlyHomework = 1;
222: $suppressEmptySequences = 1;
223: $filterFunc = sub { my $res = shift;
1.201 bowersj2 224: return $res->completable() || $res->is_map();
1.191 bowersj2 225: };
1.229 www 226: $r->print("<p><font size='+2'>".&mt("Uncompleted Homework")."</font></p>");
1.191 bowersj2 227: $ENV{'form.filter'} = '';
228: $ENV{'form.condition'} = 1;
1.201 bowersj2 229: $resource_no_folder_link = 1;
1.191 bowersj2 230: } else {
231: $r->print("<a href='navmaps?showOnlyHomework'>" .
1.229 www 232: &mt("Show Only Uncompleted Homework")."</a> ");
1.191 bowersj2 233: }
234:
1.133 bowersj2 235: # renderer call
1.191 bowersj2 236: my $renderArgs = { 'cols' => [0,1,2,3],
237: 'url' => '/adm/navmaps',
238: 'navmap' => $navmap,
239: 'suppressNavmap' => 1,
240: 'suppressEmptySequences' => $suppressEmptySequences,
241: 'filterFunc' => $filterFunc,
1.201 bowersj2 242: 'resource_no_folder_link' => $resource_no_folder_link,
1.191 bowersj2 243: 'r' => $r};
244: my $render = render($renderArgs);
245: $navmap->untieHashes();
1.133 bowersj2 246:
1.191 bowersj2 247: # If no resources were printed, print a reassuring message so the
248: # user knows there was no error.
249: if ($renderArgs->{'counter'} == 0) {
250: if ($showOnlyHomework) {
1.229 www 251: $r->print("<p><font size='+1'>".&mt("All homework is currently completed").".</font></p>");
1.191 bowersj2 252: } else { # both jumpToFirstHomework and normal use the same: course must be empty
253: $r->print("<p><font size='+1'>This course is empty.</font></p>");
254: }
255: }
1.51 bowersj2 256:
1.128 bowersj2 257: $r->print("</body></html>");
1.134 bowersj2 258: $r->rflush();
1.59 bowersj2 259:
1.51 bowersj2 260: return OK;
261: }
262:
263: # Convenience functions: Returns a string that adds or subtracts
264: # the second argument from the first hash, appropriate for the
265: # query string that determines which folders to recurse on
266: sub addToFilter {
267: my $hashIn = shift;
268: my $addition = shift;
269: my %hash = %$hashIn;
270: $hash{$addition} = 1;
271:
272: return join (",", keys(%hash));
273: }
274:
275: sub removeFromFilter {
276: my $hashIn = shift;
277: my $subtraction = shift;
278: my %hash = %$hashIn;
279:
280: delete $hash{$subtraction};
281: return join(",", keys(%hash));
282: }
283:
284: # Convenience function: Given a stack returned from getStack on the iterator,
285: # return the correct src() value.
286: # Later, this should add an anchor when we start putting anchors in pages.
287: sub getLinkForResource {
288: my $stack = shift;
289: my $res;
290:
291: # Check to see if there are any pages in the stack
292: foreach $res (@$stack) {
293: if (defined($res) && $res->is_page()) {
294: return $res->src();
295: }
296: }
297:
298: # Failing that, return the src of the last resource that is defined
299: # (when we first recurse on a map, it puts an undefined resource
300: # on the bottom because $self->{HERE} isn't defined yet, and we
301: # want the src for the map anyhow)
302: foreach (@$stack) {
303: if (defined($_)) { $res = $_; }
304: }
305:
306: return $res->src();
307: }
308:
1.53 bowersj2 309: # Convenience function: This seperates the logic of how to create
310: # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
311: # etc.) into a seperate function. It takes a resource object as the
312: # first parameter, and the part number of the resource as the second.
313: # It's basically a big switch statement on the status of the resource.
314:
315: sub getDescription {
316: my $res = shift;
317: my $part = shift;
1.69 bowersj2 318: my $status = $res->status($part);
1.53 bowersj2 319:
1.182 bowersj2 320: if ($status == $res->NETWORK_FAILURE) {
1.229 www 321: return &mt("Having technical difficulties; please check status later");
1.182 bowersj2 322: }
1.53 bowersj2 323: if ($status == $res->NOTHING_SET) {
1.229 www 324: return &mt("Not currently assigned.");
1.53 bowersj2 325: }
326: if ($status == $res->OPEN_LATER) {
1.73 bowersj2 327: return "Open " . timeToHumanString($res->opendate($part));
1.53 bowersj2 328: }
329: if ($status == $res->OPEN) {
1.79 bowersj2 330: if ($res->duedate($part)) {
1.229 www 331: return &mt("Due")." " .timeToHumanString($res->duedate($part));
1.66 bowersj2 332: } else {
1.229 www 333: return &mt("Open, no due date");
1.66 bowersj2 334: }
1.53 bowersj2 335: }
1.54 bowersj2 336: if ($status == $res->PAST_DUE_ANSWER_LATER) {
1.229 www 337: return &mt("Answer open")." " . timeToHumanString($res->answerdate($part));
1.54 bowersj2 338: }
339: if ($status == $res->PAST_DUE_NO_ANSWER) {
1.229 www 340: return &mt("Was due")." " . timeToHumanString($res->duedate($part));
1.53 bowersj2 341: }
342: if ($status == $res->ANSWER_OPEN) {
1.229 www 343: return &mt("Answer available");
1.53 bowersj2 344: }
1.59 bowersj2 345: if ($status == $res->EXCUSED) {
1.229 www 346: return &mt("Excused by instructor");
1.59 bowersj2 347: }
1.69 bowersj2 348: if ($status == $res->ATTEMPTED) {
1.229 www 349: return &mt("Answer submitted, not yet graded");
1.69 bowersj2 350: }
1.59 bowersj2 351: if ($status == $res->TRIES_LEFT) {
1.79 bowersj2 352: my $tries = $res->tries($part);
353: my $maxtries = $res->maxtries($part);
354: my $triesString = "";
355: if ($tries && $maxtries) {
356: $triesString = "<font size=\"-1\"><i>($tries of $maxtries tries used)</i></font>";
357: if ($maxtries > 1 && $maxtries - $tries == 1) {
358: $triesString = "<b>$triesString</b>";
359: }
360: }
1.244 albertel 361: if ($res->duedate($part)) {
1.229 www 362: return &mt("Due")." " . timeToHumanString($res->duedate($part)) .
1.66 bowersj2 363: " $triesString";
364: } else {
1.229 www 365: return &mt("No due date")." $triesString";
1.66 bowersj2 366: }
1.59 bowersj2 367: }
1.185 bowersj2 368: if ($status == $res->ANSWER_SUBMITTED) {
1.229 www 369: return &mt('Answer submitted');
1.185 bowersj2 370: }
1.53 bowersj2 371: }
372:
1.115 bowersj2 373: # Convenience function, so others can use it: Is the problem due in less then
374: # 24 hours, and still can be done?
375:
376: sub dueInLessThen24Hours {
377: my $res = shift;
378: my $part = shift;
379: my $status = $res->status($part);
380:
1.207 bowersj2 381: return ($status == $res->OPEN() ||
1.115 bowersj2 382: $status == $res->TRIES_LEFT()) &&
1.244 albertel 383: $res->duedate($part) && $res->duedate($part) < time()+(24*60*60) &&
384: $res->duedate($part) > time();
1.115 bowersj2 385: }
386:
387: # Convenience function, so others can use it: Is there only one try remaining for the
388: # part, with more then one try to begin with, not due yet and still can be done?
389: sub lastTry {
390: my $res = shift;
391: my $part = shift;
392:
393: my $tries = $res->tries($part);
394: my $maxtries = $res->maxtries($part);
395: return $tries && $maxtries && $maxtries > 1 &&
1.244 albertel 396: $maxtries - $tries == 1 && $res->duedate($part) &&
397: $res->duedate($part) > time();
1.115 bowersj2 398: }
399:
1.101 bowersj2 400: # This puts a human-readable name on the ENV variable.
1.177 www 401:
1.68 bowersj2 402: sub advancedUser {
1.177 www 403: return $ENV{'request.role.adv'};
1.68 bowersj2 404: }
405:
1.73 bowersj2 406:
407: # timeToHumanString takes a time number and converts it to a
408: # human-readable representation, meant to be used in the following
409: # manner:
410: # print "Due $timestring"
411: # print "Open $timestring"
412: # print "Answer available $timestring"
413: # Very, very, very, VERY English-only... goodness help a localizer on
414: # this func...
1.53 bowersj2 415: sub timeToHumanString {
1.58 albertel 416: my ($time) = @_;
417: # zero, '0' and blank are bad times
1.73 bowersj2 418: if (!$time) {
1.229 www 419: return &mt('never');
1.73 bowersj2 420: }
1.231 www 421: unless (&Apache::lonlocal::current_language()=~/^en/) {
1.237 www 422: return &Apache::lonlocal::locallocaltime($time);
1.229 www 423: }
1.73 bowersj2 424: my $now = time();
425:
426: my @time = localtime($time);
427: my @now = localtime($now);
428:
429: # Positive = future
430: my $delta = $time - $now;
431:
432: my $minute = 60;
433: my $hour = 60 * $minute;
434: my $day = 24 * $hour;
435: my $week = 7 * $day;
436: my $inPast = 0;
437:
438: # Logic in comments:
439: # Is it now? (extremely unlikely)
440: if ( $delta == 0 ) {
441: return "this instant";
442: }
443:
444: if ($delta < 0) {
445: $inPast = 1;
446: $delta = -$delta;
447: }
448:
449: if ( $delta > 0 ) {
1.101 bowersj2 450:
1.73 bowersj2 451: my $tense = $inPast ? " ago" : "";
452: my $prefix = $inPast ? "" : "in ";
1.101 bowersj2 453:
454: # Less then a minute
1.73 bowersj2 455: if ( $delta < $minute ) {
456: if ($delta == 1) { return "${prefix}1 second$tense"; }
457: return "$prefix$delta seconds$tense";
458: }
459:
1.101 bowersj2 460: # Less then an hour
1.73 bowersj2 461: if ( $delta < $hour ) {
462: # If so, use minutes
463: my $minutes = floor($delta / 60);
464: if ($minutes == 1) { return "${prefix}1 minute$tense"; }
465: return "$prefix$minutes minutes$tense";
466: }
467:
468: # Is it less then 24 hours away? If so,
469: # display hours + minutes
470: if ( $delta < $hour * 24) {
471: my $hours = floor($delta / $hour);
472: my $minutes = floor(($delta % $hour) / $minute);
473: my $hourString = "$hours hours";
474: my $minuteString = ", $minutes minutes";
475: if ($hours == 1) {
476: $hourString = "1 hour";
477: }
478: if ($minutes == 1) {
479: $minuteString = ", 1 minute";
480: }
481: if ($minutes == 0) {
482: $minuteString = "";
483: }
484: return "$prefix$hourString$minuteString$tense";
485: }
486:
487: # Less then 5 days away, display day of the week and
488: # HH:MM
489: if ( $delta < $day * 5 ) {
1.85 bowersj2 490: my $timeStr = strftime("%A, %b %e at %I:%M %P", localtime($time));
1.238 albertel 491: $timeStr =~ s/12:00 am/00:00/;
1.73 bowersj2 492: $timeStr =~ s/12:00 pm/noon/;
493: return ($inPast ? "last " : "next ") .
494: $timeStr;
495: }
496:
497: # Is it this year?
498: if ( $time[5] == $now[5]) {
499: # Return on Month Day, HH:MM meridian
500: my $timeStr = strftime("on %A, %b %e at %I:%M %P", localtime($time));
1.238 albertel 501: $timeStr =~ s/12:00 am/00:00/;
1.73 bowersj2 502: $timeStr =~ s/12:00 pm/noon/;
503: return $timeStr;
504: }
505:
506: # Not this year, so show the year
507: my $timeStr = strftime("on %A, %b %e %G at %I:%M %P", localtime($time));
1.238 albertel 508: $timeStr =~ s/12:00 am/00:00/;
1.73 bowersj2 509: $timeStr =~ s/12:00 pm/noon/;
510: return $timeStr;
1.58 albertel 511: }
1.53 bowersj2 512: }
513:
1.51 bowersj2 514:
1.133 bowersj2 515: =pod
516:
1.174 albertel 517: =head1 NAME
518:
1.217 bowersj2 519: Apache::lonnavmap - Subroutines to handle and render the navigation
520: maps
1.174 albertel 521:
522: =head1 SYNOPSIS
523:
524: The main handler generates the navigational listing for the course,
525: the other objects export this information in a usable fashion for
1.205 bowersj2 526: other modules.
1.133 bowersj2 527:
1.216 bowersj2 528: =head1 OVERVIEW
529:
1.217 bowersj2 530: X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the
1.218 bowersj2 531: course structure and caches it in what is often referred to as the
532: "big hash" X<big hash>. You can see it if you are logged into
533: LON-CAPA, in a course, by going to /adm/test. (You may need to
534: tweak the /home/httpd/lonTabs/htpasswd file to view it.) The
535: content of the hash will be under the heading "Big Hash".
1.216 bowersj2 536:
537: Big Hash contains, among other things, how resources are related
538: to each other (next/previous), what resources are maps, which
539: resources are being chosen to not show to the student (for random
540: selection), and a lot of other things that can take a lot of time
541: to compute due to the amount of data that needs to be collected and
542: processed.
543:
544: Apache::lonnavmaps provides an object model for manipulating this
545: information in a higher-level fashion then directly manipulating
546: the hash. It also provides access to several auxilary functions
547: that aren't necessarily stored in the Big Hash, but are a per-
548: resource sort of value, like whether there is any feedback on
549: a given resource.
550:
551: Apache::lonnavmaps also abstracts away branching, and someday,
552: conditions, for the times where you don't really care about those
553: things.
554:
555: Apache::lonnavmaps also provides fairly powerful routines for
556: rendering navmaps, and last but not least, provides the navmaps
557: view for when the user clicks the NAV button.
558:
559: B<Note>: Apache::lonnavmaps I<only> works for the "currently
560: logged in user"; if you want things like "due dates for another
561: student" lonnavmaps can not directly retrieve information like
562: that. You need the EXT function. This module can still help,
563: because many things, such as the course structure, are constant
564: between users, and Apache::lonnavmaps can help by providing
565: symbs for the EXT call.
566:
567: The rest of this file will cover the provided rendering routines,
568: which can often be used without fiddling with the navmap object at
569: all, then documents the Apache::lonnavmaps::navmap object, which
570: is the key to accessing the Big Hash information, covers the use
571: of the Iterator (which provides the logic for traversing the
572: somewhat-complicated Big Hash data structure), documents the
573: Apache::lonnavmaps::Resource objects that are returned by
574:
1.205 bowersj2 575: =head1 Subroutine: render
1.133 bowersj2 576:
1.174 albertel 577: The navmap renderer package provides a sophisticated rendering of the
578: standard navigation maps interface into HTML. The provided nav map
579: handler is actually just a glorified call to this.
1.133 bowersj2 580:
1.216 bowersj2 581: Because of the large number of parameters this function accepts,
1.174 albertel 582: instead of passing it arguments as is normal, pass it in an anonymous
1.216 bowersj2 583: hash with the desired options.
1.174 albertel 584:
585: The package provides a function called 'render', called as
1.205 bowersj2 586: Apache::lonnavmaps::render({}).
1.51 bowersj2 587:
1.133 bowersj2 588: =head2 Overview of Columns
1.51 bowersj2 589:
1.174 albertel 590: The renderer will build an HTML table for the navmap and return
591: it. The table is consists of several columns, and a row for each
592: resource (or possibly each part). You tell the renderer how many
593: columns to create and what to place in each column, optionally using
1.205 bowersj2 594: one or more of the prepared columns, and the renderer will assemble
1.174 albertel 595: the table.
596:
597: Any additional generally useful column types should be placed in the
598: renderer code here, so anybody can use it anywhere else. Any code
599: specific to the current application (such as the addition of <input>
600: elements in a column) should be placed in the code of the thing using
601: the renderer.
602:
603: At the core of the renderer is the array reference COLS (see Example
604: section below for how to pass this correctly). The COLS array will
605: consist of entries of one of two types of things: Either an integer
606: representing one of the pre-packaged column types, or a sub reference
607: that takes a resource reference, a part number, and a reference to the
608: argument hash passed to the renderer, and returns a string that will
609: be inserted into the HTML representation as it.
610:
1.216 bowersj2 611: All other parameters are ways of either changing how the columns
612: are printing, or which rows are shown.
613:
1.174 albertel 614: The pre-packaged column names are refered to by constants in the
1.205 bowersj2 615: Apache::lonnavmaps namespace. The following currently exist:
1.51 bowersj2 616:
1.174 albertel 617: =over 4
1.51 bowersj2 618:
1.216 bowersj2 619: =item * B<Apache::lonnavmaps::resource>:
1.51 bowersj2 620:
1.174 albertel 621: The general info about the resource: Link, icon for the type, etc. The
1.216 bowersj2 622: first column in the standard nav map display. This column provides the
623: indentation effect seen in the B<NAV> screen. This column also accepts
1.205 bowersj2 624: the following parameters in the renderer hash:
1.51 bowersj2 625:
1.133 bowersj2 626: =over 4
1.51 bowersj2 627:
1.216 bowersj2 628: =item * B<resource_nolink>: default false
1.51 bowersj2 629:
1.216 bowersj2 630: If true, the resource will not be linked. By default, all non-folder
631: resources are linked.
1.174 albertel 632:
1.216 bowersj2 633: =item * B<resource_part_count>: default true
1.51 bowersj2 634:
1.216 bowersj2 635: If true, the resource will show a part count B<if> the full
636: part list is not displayed. (See "condense_parts" later.) If false,
637: the resource will never show a part count.
1.133 bowersj2 638:
1.174 albertel 639: =item * B<resource_no_folder_link>:
1.133 bowersj2 640:
1.174 albertel 641: If true, the resource's folder will not be clickable to open or close
642: it. Default is false. True implies printCloseAll is false, since you
643: can't close or open folders when this is on anyhow.
1.144 bowersj2 644:
1.133 bowersj2 645: =back
1.51 bowersj2 646:
1.225 bowersj2 647: =item * B<Apache::lonnavmaps::communication_status>:
1.174 albertel 648:
649: Whether there is discussion on the resource, email for the user, or
650: (lumped in here) perl errors in the execution of the problem. This is
651: the second column in the main nav map.
652:
1.225 bowersj2 653: =item * B<Apache::lonnavmaps::quick_status>:
1.51 bowersj2 654:
1.216 bowersj2 655: An icon for the status of a problem, with five possible states:
656: Correct, incorrect, open, awaiting grading (for a problem where the
657: computer's grade is suppressed, or the computer can't grade, like
658: essay problem), or none (not open yet, not a problem). The
1.174 albertel 659: third column of the standard navmap.
1.51 bowersj2 660:
1.225 bowersj2 661: =item * B<Apache::lonnavmaps::long_status>:
1.174 albertel 662:
663: A text readout of the details of the current status of the problem,
664: such as "Due in 22 hours". The fourth column of the standard navmap.
1.51 bowersj2 665:
1.225 bowersj2 666: =item * B<Apache::lonnavmaps::part_status_summary>:
667:
668: A text readout summarizing the status of the problem. If it is a
669: single part problem, will display "Correct", "Incorrect",
670: "Not yet open", "Open", "Attempted", or "Error". If there are
671: multiple parts, this will output a string that in HTML will show a
672: status of how many parts are in each status, in color coding, trying
673: to match the colors of the icons within reason.
674:
675: Note this only makes sense if you are I<not> showing parts. If
676: C<showParts> is true (see below), this column will not output
677: anything.
678:
1.133 bowersj2 679: =back
1.51 bowersj2 680:
1.133 bowersj2 681: If you add any others please be sure to document them here.
1.51 bowersj2 682:
1.174 albertel 683: An example of a column renderer that will show the ID number of a
684: resource, along with the part name if any:
1.51 bowersj2 685:
1.133 bowersj2 686: sub {
687: my ($resource, $part, $params) = @_;
688: if ($part) { return '<td>' . $resource->{ID} . ' ' . $part . '</td>'; }
689: return '<td>' . $resource->{ID} . '</td>';
690: }
1.51 bowersj2 691:
1.174 albertel 692: Note these functions are responsible for the TD tags, which allow them
693: to override vertical and horizontal alignment, etc.
1.130 www 694:
1.133 bowersj2 695: =head2 Parameters
1.115 bowersj2 696:
1.217 bowersj2 697: Minimally, you should be
1.174 albertel 698: able to get away with just using 'cols' (to specify the columns
699: shown), 'url' (necessary for the folders to link to the current screen
700: correctly), and possibly 'queryString' if your app calls for it. In
701: that case, maintaining the state of the folders will be done
702: automatically.
1.140 bowersj2 703:
1.133 bowersj2 704: =over 4
1.51 bowersj2 705:
1.216 bowersj2 706: =item * B<iterator>: default: constructs one from %ENV
1.174 albertel 707:
708: A reference to a fresh ::iterator to use from the navmaps. The
709: rendering will reflect the options passed to the iterator, so you can
710: use that to just render a certain part of the course, if you like. If
711: one is not passed, the renderer will attempt to construct one from
712: ENV{'form.filter'} and ENV{'form.condition'} information, plus the
713: 'iterator_map' parameter if any.
714:
1.216 bowersj2 715: =item * B<iterator_map>: default: not used
1.174 albertel 716:
717: If you are letting the renderer do the iterator handling, you can
718: instruct the renderer to render only a particular map by passing it
719: the source of the map you want to process, like
720: '/res/103/jerf/navmap.course.sequence'.
721:
1.216 bowersj2 722: =item * B<navmap>: default: constructs one from %ENV
1.174 albertel 723:
724: A reference to a navmap, used only if an iterator is not passed in. If
725: this is necessary to make an iterator but it is not passed in, a new
726: one will be constructed based on ENV info. This is useful to do basic
727: error checking before passing it off to render.
728:
1.216 bowersj2 729: =item * B<r>: default: must be passed in
1.174 albertel 730:
731: The standard Apache response object. This must be passed to the
732: renderer or the course hash will be locked.
733:
1.216 bowersj2 734: =item * B<cols>: default: empty (useless)
1.174 albertel 735:
736: An array reference
737:
1.216 bowersj2 738: =item * B<showParts>:default true
1.174 albertel 739:
1.216 bowersj2 740: A flag. If true, a line for the resource itself, and a line
1.174 albertel 741: for each part will be displayed. If not, only one line for each
742: resource will be displayed.
743:
1.216 bowersj2 744: =item * B<condenseParts>: default true
1.174 albertel 745:
1.216 bowersj2 746: A flag. If true, if all parts of the problem have the same
1.174 albertel 747: status and that status is Nothing Set, Correct, or Network Failure,
748: then only one line will be displayed for that resource anyhow. If no,
749: all parts will always be displayed. If showParts is 0, this is
750: ignored.
751:
1.216 bowersj2 752: =item * B<jumpCount>: default: determined from %ENV
1.174 albertel 753:
1.216 bowersj2 754: A string identifying the URL to place the anchor 'curloc' at.
755: It is the responsibility of the renderer user to
1.174 albertel 756: ensure that the #curloc is in the URL. By default, determined through
757: the use of the ENV{} 'jump' information, and should normally "just
758: work" correctly.
1.144 bowersj2 759:
1.216 bowersj2 760: =item * B<here>: default: empty string
1.140 bowersj2 761:
1.216 bowersj2 762: A Symb identifying where to place the 'here' marker. The empty
763: string means no marker.
1.92 bowersj2 764:
1.216 bowersj2 765: =item * B<indentString>: default: 25 pixel whitespace image
1.164 bowersj2 766:
1.216 bowersj2 767: A string identifying the indentation string to use.
1.92 bowersj2 768:
1.216 bowersj2 769: =item * B<queryString>: default: empty
1.51 bowersj2 770:
1.174 albertel 771: A string which will be prepended to the query string used when the
1.216 bowersj2 772: folders are opened or closed. You can use this to pass
773: application-specific values.
1.55 bowersj2 774:
1.216 bowersj2 775: =item * B<url>: default: none
1.84 bowersj2 776:
1.174 albertel 777: The url the folders will link to, which should be the current
1.216 bowersj2 778: page. Required if the resource info column is shown, and you
779: are allowing the user to open and close folders.
1.115 bowersj2 780:
1.216 bowersj2 781: =item * B<currentJumpIndex>: default: no jumping
1.55 bowersj2 782:
1.174 albertel 783: Describes the currently-open row number to cause the browser to jump
784: to, because the user just opened that folder. By default, pulled from
785: the Jump information in the ENV{'form.*'}.
1.51 bowersj2 786:
1.216 bowersj2 787: =item * B<printKey>: default: false
1.51 bowersj2 788:
1.174 albertel 789: If true, print the key that appears on the top of the standard
1.216 bowersj2 790: navmaps.
1.139 bowersj2 791:
1.216 bowersj2 792: =item * B<printCloseAll>: default: true
1.140 bowersj2 793:
1.174 albertel 794: If true, print the "Close all folders" or "open all folders"
1.216 bowersj2 795: links.
1.140 bowersj2 796:
1.216 bowersj2 797: =item * B<filterFunc>: default: sub {return 1;} (accept everything)
1.153 bowersj2 798:
1.174 albertel 799: A function that takes the resource object as its only parameter and
800: returns a true or false value. If true, the resource is displayed. If
1.216 bowersj2 801: false, it is simply skipped in the display.
1.174 albertel 802:
1.216 bowersj2 803: =item * B<suppressEmptySequences>: default: false
1.190 bowersj2 804:
805: If you're using a filter function, and displaying sequences to orient
806: the user, then frequently some sequences will be empty. Setting this to
807: true will cause those sequences not to display, so as not to confuse the
808: user into thinking that if the sequence is there there should be things
1.216 bowersj2 809: under it; for example, see the "Show Uncompleted Homework" view on the
810: B<NAV> screen.
1.190 bowersj2 811:
1.216 bowersj2 812: =item * B<suppressNavmaps>: default: false
1.174 albertel 813:
1.216 bowersj2 814: If true, will not display Navigate Content resources.
1.143 bowersj2 815:
1.133 bowersj2 816: =back
1.51 bowersj2 817:
1.133 bowersj2 818: =head2 Additional Info
1.51 bowersj2 819:
1.174 albertel 820: In addition to the parameters you can pass to the renderer, which will
821: be passed through unchange to the column renderers, the renderer will
822: generate the following information which your renderer may find
823: useful:
824:
1.216 bowersj2 825: =over 4
826:
827: =item * B<counter>:
1.145 bowersj2 828:
1.216 bowersj2 829: Contains the number of rows printed. Useful after calling the render
830: function, as you can detect whether anything was printed at all.
831:
832: =item * B<isNewBranch>:
833:
834: Useful for renderers: If this resource is currently the first resource
835: of a new branch, this will be true. The Resource column (leftmost in the
836: navmaps screen) uses this to display the "new branch" icon
1.59 bowersj2 837:
1.133 bowersj2 838: =back
1.59 bowersj2 839:
1.133 bowersj2 840: =cut
1.59 bowersj2 841:
1.133 bowersj2 842: sub resource { return 0; }
843: sub communication_status { return 1; }
844: sub quick_status { return 2; }
845: sub long_status { return 3; }
1.225 bowersj2 846: sub part_status_summary { return 4; }
1.51 bowersj2 847:
1.133 bowersj2 848: sub render_resource {
849: my ($resource, $part, $params) = @_;
1.51 bowersj2 850:
1.133 bowersj2 851: my $nonLinkedText = ''; # stuff after resource title not in link
1.51 bowersj2 852:
1.134 bowersj2 853: my $link = $params->{"resourceLink"};
854: my $src = $resource->src();
855: my $it = $params->{"iterator"};
1.133 bowersj2 856: my $filter = $it->{FILTER};
857:
858: my $title = $resource->compTitle();
859: if ($src =~ /^\/uploaded\//) {
860: $nonLinkedText=$title;
861: $title = '';
862: }
863: my $partLabel = "";
864: my $newBranchText = "";
865:
866: # If this is a new branch, label it so
867: if ($params->{'isNewBranch'}) {
868: $newBranchText = "<img src='/adm/lonIcons/branch.gif' border='0' />";
1.51 bowersj2 869: }
870:
1.133 bowersj2 871: # links to open and close the folder
872: my $linkopen = "<a href='$link'>";
873: my $linkclose = "</a>";
1.51 bowersj2 874:
1.204 albertel 875: # Default icon: unknown page
876: my $icon = "<img src='/adm/lonIcons/unknown.gif' alt='' border='0' />";
1.133 bowersj2 877:
878: if ($resource->is_problem()) {
1.192 bowersj2 879: if ($part eq '0' || $params->{'condensed'}) {
1.133 bowersj2 880: $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border="0" />';
881: } else {
882: $icon = $params->{'indentString'};
883: }
1.204 albertel 884: } else {
1.243 albertel 885: $icon = "<img src='".&Apache::loncommon::icon($resource->src).
886: "' alt='' border='0' />";
1.133 bowersj2 887: }
1.51 bowersj2 888:
1.133 bowersj2 889: # Display the correct map icon to open or shut map
890: if ($resource->is_map()) {
891: my $mapId = $resource->map_pc();
892: my $nowOpen = !defined($filter->{$mapId});
893: if ($it->{CONDITION}) {
894: $nowOpen = !$nowOpen;
895: }
1.144 bowersj2 896:
1.205 bowersj2 897: my $folderType = $resource->is_sequence() ? 'folder' : 'page';
898:
1.144 bowersj2 899: if (!$params->{'resource_no_folder_link'}) {
1.205 bowersj2 900: $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif';
1.144 bowersj2 901: $icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />";
902:
903: $linkopen = "<a href='" . $params->{'url'} . '?' .
904: $params->{'queryString'} . '&filter=';
905: $linkopen .= ($nowOpen xor $it->{CONDITION}) ?
906: addToFilter($filter, $mapId) :
907: removeFromFilter($filter, $mapId);
908: $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
909: . $params->{'hereType'} . '&here=' .
910: &Apache::lonnet::escape($params->{'here'}) .
1.159 bowersj2 911: '&jump=' .
1.144 bowersj2 912: &Apache::lonnet::escape($resource->symb()) .
913: "&folderManip=1'>";
914: } else {
915: # Don't allow users to manipulate folder
1.205 bowersj2 916: $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') .
1.144 bowersj2 917: '.nomanip.gif';
918: $icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />";
919:
920: $linkopen = "";
921: $linkclose = "";
922: }
1.133 bowersj2 923: }
1.51 bowersj2 924:
1.133 bowersj2 925: if ($resource->randomout()) {
926: $nonLinkedText .= ' <i>(hidden)</i> ';
927: }
928:
929: # We're done preparing and finally ready to start the rendering
930: my $result = "<td align='left' valign='center'>";
1.140 bowersj2 931:
932: my $indentLevel = $params->{'indentLevel'};
933: if ($newBranchText) { $indentLevel--; }
934:
1.133 bowersj2 935: # print indentation
1.140 bowersj2 936: for (my $i = 0; $i < $indentLevel; $i++) {
1.133 bowersj2 937: $result .= $params->{'indentString'};
1.84 bowersj2 938: }
939:
1.133 bowersj2 940: # Decide what to display
941: $result .= "$newBranchText$linkopen$icon$linkclose";
942:
943: my $curMarkerBegin = '';
944: my $curMarkerEnd = '';
1.51 bowersj2 945:
1.133 bowersj2 946: # Is this the current resource?
1.158 bowersj2 947: if (!$params->{'displayedHereMarker'} &&
948: $resource->symb() eq $params->{'here'} ) {
1.133 bowersj2 949: $curMarkerBegin = '<font color="red" size="+2">> </font>';
950: $curMarkerEnd = '<font color="red" size="+2"><</font>';
1.158 bowersj2 951: $params->{'displayedHereMarker'} = 1;
1.51 bowersj2 952: }
953:
1.192 bowersj2 954: if ($resource->is_problem() && $part ne '0' &&
1.133 bowersj2 955: !$params->{'condensed'}) {
1.245 www 956: my $displaypart=&Apache::lonnet::EXT('resource.'.$part.'.display',
957: $resource->symb());
958: unless ($displaypart) { $displaypart=$part; }
959: $partLabel = " (Part: $displaypart)";
960: $link.='#'.&Apache::lonnet::escape($part);
1.133 bowersj2 961: $title = "";
1.51 bowersj2 962: }
963:
1.163 bowersj2 964: if ($params->{'condensed'} && $resource->countParts() > 1) {
1.133 bowersj2 965: $nonLinkedText .= ' (' . $resource->countParts() . ' parts)';
1.51 bowersj2 966: }
967:
1.203 bowersj2 968: if (!$params->{'resource_nolink'} && $src !~ /^\/uploaded\// &&
1.205 bowersj2 969: !$resource->is_sequence()) {
1.144 bowersj2 970: $result .= " $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>";
971: } else {
972: $result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>";
973: }
1.51 bowersj2 974:
1.133 bowersj2 975: return $result;
976: }
1.51 bowersj2 977:
1.133 bowersj2 978: sub render_communication_status {
979: my ($resource, $part, $params) = @_;
1.134 bowersj2 980: my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = "";
981:
982: my $link = $params->{"resourceLink"};
983: my $linkopen = "<a href='$link'>";
984: my $linkclose = "</a>";
985:
986: if ($resource->hasDiscussion()) {
987: $discussionHTML = $linkopen .
988: '<img border="0" src="/adm/lonMisc/chat.gif" />' .
989: $linkclose;
990: }
991:
992: if ($resource->getFeedback()) {
993: my $feedback = $resource->getFeedback();
994: foreach (split(/\,/, $feedback)) {
995: if ($_) {
996: $feedbackHTML .= ' <a href="/adm/email?display='
997: . &Apache::lonnet::escape($_) . '">'
998: . '<img src="/adm/lonMisc/feedback.gif" '
999: . 'border="0" /></a>';
1000: }
1001: }
1002: }
1003:
1004: if ($resource->getErrors()) {
1005: my $errors = $resource->getErrors();
1006: foreach (split(/,/, $errors)) {
1007: if ($_) {
1008: $errorHTML .= ' <a href="/adm/email?display='
1009: . &Apache::lonnet::escape($_) . '">'
1010: . '<img src="/adm/lonMisc/bomb.gif" '
1011: . 'border="0" /></a>';
1012: }
1013: }
1.197 bowersj2 1014: }
1015:
1016: if ($params->{'multipart'} && $part != '0') {
1017: $discussionHTML = $feedbackHTML = $errorHTML = '';
1.134 bowersj2 1018: }
1019:
1020: return "<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML </td>";
1021:
1.133 bowersj2 1022: }
1023: sub render_quick_status {
1024: my ($resource, $part, $params) = @_;
1.135 bowersj2 1025: my $result = "";
1026: my $firstDisplayed = !$params->{'condensed'} &&
1027: $params->{'multipart'} && $part eq "0";
1028:
1029: my $link = $params->{"resourceLink"};
1030: my $linkopen = "<a href='$link'>";
1031: my $linkclose = "</a>";
1032:
1033: if ($resource->is_problem() &&
1034: !$firstDisplayed) {
1.224 bowersj2 1035:
1036: my $icon = $statusIconMap{$resource->simpleStatus($part)};
1.135 bowersj2 1037: my $alt = $iconAltTags{$icon};
1038: if ($icon) {
1039: $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";
1040: } else {
1041: $result .= "<td width='30'> </td>\n";
1042: }
1043: } else { # not problem, no icon
1044: $result .= "<td width='30'> </td>\n";
1045: }
1046:
1047: return $result;
1.133 bowersj2 1048: }
1049: sub render_long_status {
1050: my ($resource, $part, $params) = @_;
1.136 bowersj2 1051: my $result = "<td align='right' valign='center'>\n";
1052: my $firstDisplayed = !$params->{'condensed'} &&
1053: $params->{'multipart'} && $part eq "0";
1054:
1055: my $color;
1.212 bowersj2 1056: if ($resource->is_problem()) {
1.136 bowersj2 1057: $color = $colormap{$resource->status};
1058:
1059: if (dueInLessThen24Hours($resource, $part) ||
1060: lastTry($resource, $part)) {
1061: $color = $hurryUpColor;
1062: }
1063: }
1064:
1065: if ($resource->kind() eq "res" &&
1066: $resource->is_problem() &&
1067: !$firstDisplayed) {
1068: if ($color) {$result .= "<font color=\"$color\"><b>"; }
1069: $result .= getDescription($resource, $part);
1070: if ($color) {$result .= "</b></font>"; }
1071: }
1072: if ($resource->is_map() && advancedUser() && $resource->randompick()) {
1073: $result .= '(randomly select ' . $resource->randompick() .')';
1074: }
1.210 bowersj2 1075:
1.213 bowersj2 1076: # Debugging code
1077: #$result .= " " . $resource->awarded($part) . '/' . $resource->weight($part) .
1078: # ' - Part: ' . $part;
1079:
1.210 bowersj2 1080: $result .= "</td>\n";
1.136 bowersj2 1081:
1082: return $result;
1.51 bowersj2 1083: }
1084:
1.227 bowersj2 1085: # Colors obtained by taking the icons, matching the colors, and
1086: # possibly reducing the Value (HSV) of the color, if it's too bright
1087: # for text, generally by one third or so.
1.225 bowersj2 1088: my %statusColors =
1089: (
1090: $resObj->CLOSED => '#000000',
1.227 bowersj2 1091: $resObj->OPEN => '#998b13',
1092: $resObj->CORRECT => '#26933f',
1093: $resObj->INCORRECT => '#c48207',
1094: $resObj->ATTEMPTED => '#a87510',
1.225 bowersj2 1095: $resObj->ERROR => '#000000'
1096: );
1097: my %statusStrings =
1098: (
1099: $resObj->CLOSED => 'Not yet open',
1100: $resObj->OPEN => 'Open',
1101: $resObj->CORRECT => 'Correct',
1102: $resObj->INCORRECT => 'Incorrect',
1103: $resObj->ATTEMPTED => 'Attempted',
1104: $resObj->ERROR => 'Network Error'
1105: );
1106: my @statuses = ($resObj->CORRECT, $resObj->ATTEMPTED, $resObj->INCORRECT, $resObj->OPEN, $resObj->CLOSED, $resObj->ERROR);
1107:
1108: use Data::Dumper;
1109: sub render_parts_summary_status {
1110: my ($resource, $part, $params) = @_;
1111: if (!$resource->is_problem()) { return '<td></td>'; }
1112: if ($params->{showParts}) {
1113: return '<td></td>';
1114: }
1115:
1116: my $td = "<td align='right'>\n";
1117: my $endtd = "</td>\n";
1118:
1119: # If there is a single part, just show the simple status
1120: if ($resource->singlepart()) {
1121: my $status = $resource->simpleStatus('0');
1122: return $td . "<font color='" . $statusColors{$status} . "'>"
1123: . $statusStrings{$status} . "</font>" . $endtd;
1124: }
1125:
1126: # Now we can be sure the $part doesn't really matter.
1127: my $statusCount = $resource->simpleStatusCount();
1128: my @counts;
1129: foreach my $status(@statuses) {
1130: # decouple display order from the simpleStatusCount order
1131: my $slot = Apache::lonnavmaps::resource::statusToSlot($status);
1132: if ($statusCount->[$slot]) {
1133: push @counts, "<font color='" . $statusColors{$status} .
1134: "'>" . $statusCount->[$slot] . ' '
1135: . $statusStrings{$status} . "</font>";
1136: }
1137: }
1138:
1.227 bowersj2 1139: return $td . $resource->countParts() . ' parts: ' . join (', ', @counts) . $endtd;
1.225 bowersj2 1140: }
1141:
1.133 bowersj2 1142: my @preparedColumns = (\&render_resource, \&render_communication_status,
1.225 bowersj2 1143: \&render_quick_status, \&render_long_status,
1144: \&render_parts_summary_status);
1.132 bowersj2 1145:
1146: sub setDefault {
1147: my ($val, $default) = @_;
1148: if (!defined($val)) { return $default; }
1149: return $val;
1150: }
1151:
1152: sub render {
1153: my $args = shift;
1.140 bowersj2 1154: &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
1155: my $result = '';
1156:
1.132 bowersj2 1157: # Configure the renderer.
1158: my $cols = $args->{'cols'};
1159: if (!defined($cols)) {
1160: # no columns, no nav maps.
1161: return '';
1162: }
1.140 bowersj2 1163: my $mustCloseNavMap = 0;
1164: my $navmap;
1165: if (defined($args->{'navmap'})) {
1166: $navmap = $args->{'navmap'};
1167: }
1168:
1.158 bowersj2 1169: my $r = $args->{'r'};
1.140 bowersj2 1170: my $queryString = $args->{'queryString'};
1.159 bowersj2 1171: my $jump = $args->{'jump'};
1.158 bowersj2 1172: my $here = $args->{'here'};
1.153 bowersj2 1173: my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0);
1.140 bowersj2 1174: my $currentJumpDelta = 2; # change this to change how many resources are displayed
1175: # before the current resource when using #current
1176:
1177: # If we were passed 'here' information, we are not rendering
1178: # after a folder manipulation, and we were not passed an
1179: # iterator, make sure we open the folders to show the "here"
1180: # marker
1181: my $filterHash = {};
1182: # Figure out what we're not displaying
1183: foreach (split(/\,/, $ENV{"form.filter"})) {
1184: if ($_) {
1185: $filterHash->{$_} = "1";
1186: }
1187: }
1188:
1.191 bowersj2 1189: # Filter: Remember filter function and add our own filter: Refuse
1190: # to show hidden resources unless the user can see them.
1191: my $userCanSeeHidden = advancedUser();
1192: my $filterFunc = setDefault($args->{'filterFunc'},
1193: sub {return 1;});
1194: if (!$userCanSeeHidden) {
1195: # Without renaming the filterfunc, the server seems to go into
1196: # an infinite loop
1197: my $oldFilterFunc = $filterFunc;
1198: $filterFunc = sub { my $res = shift; return !$res->randomout() &&
1199: &$oldFilterFunc($res);};
1200: }
1201:
1.140 bowersj2 1202: my $condition = 0;
1203: if ($ENV{'form.condition'}) {
1204: $condition = 1;
1205: }
1206:
1207: if (!$ENV{'form.folderManip'} && !defined($args->{'iterator'})) {
1208: # Step 1: Check to see if we have a navmap
1209: if (!defined($navmap)) {
1.221 bowersj2 1210: $navmap = Apache::lonnavmaps::navmap->new();
1.140 bowersj2 1211: $mustCloseNavMap = 1;
1212: }
1213:
1214: # Step two: Locate what kind of here marker is necessary
1215: # Determine where the "here" marker is and where the screen jumps to.
1216:
1.175 bowersj2 1217: if ($ENV{'form.postsymb'}) {
1218: $here = $jump = $ENV{'form.postsymb'};
1.140 bowersj2 1219: } elsif ($ENV{'form.postdata'}) {
1220: # couldn't find a symb, is there a URL?
1221: my $currenturl = $ENV{'form.postdata'};
1.158 bowersj2 1222: #$currenturl=~s/^http\:\/\///;
1223: #$currenturl=~s/^[^\/]+//;
1.140 bowersj2 1224:
1.158 bowersj2 1225: $here = $jump = &Apache::lonnet::symbread($currenturl);
1.140 bowersj2 1226: }
1.158 bowersj2 1227:
1.140 bowersj2 1228: # Step three: Ensure the folders are open
1229: my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
1.222 bowersj2 1230: my $curRes;
1.140 bowersj2 1231: my $found = 0;
1232:
1233: # We only need to do this if we need to open the maps to show the
1234: # current position. This will change the counter so we can't count
1235: # for the jump marker with this loop.
1.222 bowersj2 1236: while (($curRes = $mapIterator->next()) && !$found) {
1.158 bowersj2 1237: if (ref($curRes) && $curRes->symb() eq $here) {
1.140 bowersj2 1238: my $mapStack = $mapIterator->getStack();
1239:
1240: # Ensure the parent maps are open
1241: for my $map (@{$mapStack}) {
1242: if ($condition) {
1243: undef $filterHash->{$map->map_pc()};
1244: } else {
1245: $filterHash->{$map->map_pc()} = 1;
1246: }
1247: }
1248: $found = 1;
1249: }
1250: }
1.159 bowersj2 1251: }
1.140 bowersj2 1252:
1253: if ( !defined($args->{'iterator'}) && $ENV{'form.folderManip'} ) { # we came from a user's manipulation of the nav page
1254: # If this is a click on a folder or something, we want to preserve the "here"
1255: # from the querystring, and get the new "jump" marker
1256: $here = $ENV{'form.here'};
1257: $jump = $ENV{'form.jump'};
1258: }
1259:
1.132 bowersj2 1260: my $it = $args->{'iterator'};
1261: if (!defined($it)) {
1.140 bowersj2 1262: # Construct a default iterator based on $ENV{'form.'} information
1263:
1264: # Step 1: Check to see if we have a navmap
1265: if (!defined($navmap)) {
1.221 bowersj2 1266: $navmap = Apache::lonnavmaps::navmap->new();
1.140 bowersj2 1267: $mustCloseNavMap = 1;
1268: }
1269:
1.144 bowersj2 1270: # See if we're being passed a specific map
1271: if ($args->{'iterator_map'}) {
1272: my $map = $args->{'iterator_map'};
1.145 bowersj2 1273: $map = $navmap->getResourceByUrl($map);
1.144 bowersj2 1274: my $firstResource = $map->map_start();
1275: my $finishResource = $map->map_finish();
1276:
1277: $args->{'iterator'} = $it = $navmap->getIterator($firstResource, $finishResource, $filterHash, $condition);
1278: } else {
1279: $args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition);
1280: }
1.132 bowersj2 1281: }
1282:
1.159 bowersj2 1283: # (re-)Locate the jump point, if any
1.191 bowersj2 1284: # Note this does not take filtering or hidden into account... need
1285: # to be fixed?
1.159 bowersj2 1286: my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
1.222 bowersj2 1287: my $curRes;
1.159 bowersj2 1288: my $foundJump = 0;
1289: my $counter = 0;
1290:
1.222 bowersj2 1291: while (($curRes = $mapIterator->next()) && !$foundJump) {
1.159 bowersj2 1292: if (ref($curRes)) { $counter++; }
1293:
1294: if (ref($curRes) && $jump eq $curRes->symb()) {
1295:
1296: # This is why we have to use the main iterator instead of the
1297: # potentially faster DFS: The count has to be the same, so
1298: # the order has to be the same, which DFS won't give us.
1299: $args->{'currentJumpIndex'} = $counter;
1300: $foundJump = 1;
1301: }
1302: }
1303:
1.132 bowersj2 1304: my $showParts = setDefault($args->{'showParts'}, 1);
1305: my $condenseParts = setDefault($args->{'condenseParts'}, 1);
1.139 bowersj2 1306: # keeps track of when the current resource is found,
1307: # so we can back up a few and put the anchor above the
1308: # current resource
1.140 bowersj2 1309: my $printKey = $args->{'printKey'};
1310: my $printCloseAll = $args->{'printCloseAll'};
1311: if (!defined($printCloseAll)) { $printCloseAll = 1; }
1.144 bowersj2 1312:
1.140 bowersj2 1313: # Print key?
1314: if ($printKey) {
1315: $result .= '<table border="0" cellpadding="2" cellspacing="0">';
1316: my $date=localtime;
1317: $result.='<tr><td align="right" valign="bottom">Key: </td>';
1318: if ($navmap->{LAST_CHECK}) {
1319: $result .=
1.230 www 1320: '<img src="/adm/lonMisc/chat.gif"> '.&mt('New discussion since').' '.
1.140 bowersj2 1321: strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
1322: '</td><td align="center" valign="bottom"> '.
1.230 www 1323: '<img src="/adm/lonMisc/feedback.gif"> '.&mt('New message (click to open)').'<p>'.
1.140 bowersj2 1324: '</td>';
1325: } else {
1326: $result .= '<td align="center" valign="bottom"> '.
1.230 www 1327: '<img src="/adm/lonMisc/chat.gif"> '.&mt('Discussions').'</td><td align="center" valign="bottom">'.
1328: ' <img src="/adm/lonMisc/feedback.gif"> '.&mt('New message (click to open)').
1.140 bowersj2 1329: '</td>';
1330: }
1331:
1332: $result .= '</tr></table>';
1333: }
1334:
1.172 bowersj2 1335: if ($printCloseAll && !$args->{'resource_no_folder_link'}) {
1.140 bowersj2 1336: if ($condition) {
1337: $result.="<a href=\"navmaps?condition=0&filter=&$queryString" .
1.158 bowersj2 1338: "&here=" . Apache::lonnet::escape($here) .
1.230 www 1339: "\">".&mt('Close All Folders')."</a>";
1.140 bowersj2 1340: } else {
1341: $result.="<a href=\"navmaps?condition=1&filter=&$queryString" .
1.158 bowersj2 1342: "&here=" . Apache::lonnet::escape($here) .
1.230 www 1343: "\">".&mt('Open All Folders')."</a>";
1.140 bowersj2 1344: }
1.143 bowersj2 1345: $result .= "<br /><br />\n";
1.140 bowersj2 1346: }
1347:
1348: if ($r) {
1349: $r->print($result);
1350: $r->rflush();
1351: $result = "";
1352: }
1.132 bowersj2 1353: # End parameter setting
1.133 bowersj2 1354:
1.132 bowersj2 1355: # Data
1.140 bowersj2 1356: $result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n";
1.132 bowersj2 1357: my $res = "Apache::lonnavmaps::resource";
1358: my %condenseStatuses =
1359: ( $res->NETWORK_FAILURE => 1,
1360: $res->NOTHING_SET => 1,
1361: $res->CORRECT => 1 );
1362: my @backgroundColors = ("#FFFFFF", "#F6F6F6");
1.133 bowersj2 1363:
1364: # Shared variables
1365: $args->{'counter'} = 0; # counts the rows
1366: $args->{'indentLevel'} = 0;
1367: $args->{'isNewBranch'} = 0;
1368: $args->{'condensed'} = 0;
1369: $args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='/adm/lonIcons/whitespace1.gif' width='25' height='1' alt='' border='0' />");
1370: $args->{'displayedHereMarker'} = 0;
1.132 bowersj2 1371:
1.190 bowersj2 1372: # If we're suppressing empty sequences, look for them here. Use DFS for speed,
1373: # since structure actually doesn't matter, except what map has what resources.
1374: if ($args->{'suppressEmptySequences'}) {
1375: my $dfsit = Apache::lonnavmaps::DFSiterator->new($navmap,
1376: $it->{FIRST_RESOURCE},
1377: $it->{FINISH_RESOURCE},
1378: {}, undef, 1);
1.222 bowersj2 1379: my $depth = 0;
1.190 bowersj2 1380: $dfsit->next();
1381: my $curRes = $dfsit->next();
1382: while ($depth > -1) {
1383: if ($curRes == $dfsit->BEGIN_MAP()) { $depth++; }
1384: if ($curRes == $dfsit->END_MAP()) { $depth--; }
1385:
1386: if (ref($curRes)) {
1387: # Parallel pre-processing: Do sequences have non-filtered-out children?
1.201 bowersj2 1388: if ($curRes->is_map()) {
1.190 bowersj2 1389: $curRes->{DATA}->{HAS_VISIBLE_CHILDREN} = 0;
1390: # Sequences themselves do not count as visible children,
1391: # unless those sequences also have visible children.
1392: # This means if a sequence appears, there's a "promise"
1393: # that there's something under it if you open it, somewhere.
1394: } else {
1395: # Not a sequence: if it's filtered, ignore it, otherwise
1396: # rise up the stack and mark the sequences as having children
1397: if (&$filterFunc($curRes)) {
1398: for my $sequence (@{$dfsit->getStack()}) {
1399: $sequence->{DATA}->{HAS_VISIBLE_CHILDREN} = 1;
1400: }
1401: }
1402: }
1403: }
1404: } continue {
1405: $curRes = $dfsit->next();
1406: }
1407: }
1408:
1.133 bowersj2 1409: my $displayedJumpMarker = 0;
1.132 bowersj2 1410: # Set up iteration.
1411: my $now = time();
1412: my $in24Hours = $now + 24 * 60 * 60;
1413: my $rownum = 0;
1414:
1.141 bowersj2 1415: # export "here" marker information
1416: $args->{'here'} = $here;
1417:
1.222 bowersj2 1418: $args->{'indentLevel'} = -1; # first BEGIN_MAP takes this to 0
1419: while ($curRes = $it->next()) {
1.132 bowersj2 1420: # Maintain indentation level.
1421: if ($curRes == $it->BEGIN_MAP() ||
1422: $curRes == $it->BEGIN_BRANCH() ) {
1.133 bowersj2 1423: $args->{'indentLevel'}++;
1.132 bowersj2 1424: }
1425: if ($curRes == $it->END_MAP() ||
1426: $curRes == $it->END_BRANCH() ) {
1.133 bowersj2 1427: $args->{'indentLevel'}--;
1.132 bowersj2 1428: }
1429: # Notice new branches
1430: if ($curRes == $it->BEGIN_BRANCH()) {
1.133 bowersj2 1431: $args->{'isNewBranch'} = 1;
1432: }
1433:
1434: # If this isn't an actual resource, continue on
1435: if (!ref($curRes)) {
1436: next;
1.132 bowersj2 1437: }
1.133 bowersj2 1438:
1.143 bowersj2 1439: # If this has been filtered out, continue on
1440: if (!(&$filterFunc($curRes))) {
1441: $args->{'isNewBranch'} = 0; # Don't falsely remember this
1442: next;
1443: }
1.132 bowersj2 1444:
1.190 bowersj2 1445: # If this is an empty sequence and we're filtering them, continue on
1.201 bowersj2 1446: if ($curRes->is_map() && $args->{'suppressEmptySequences'} &&
1.190 bowersj2 1447: !$curRes->{DATA}->{HAS_VISIBLE_CHILDREN}) {
1448: next;
1449: }
1450:
1.153 bowersj2 1451: # If we're suppressing navmaps and this is a navmap, continue on
1452: if ($suppressNavmap && $curRes->src() =~ /^\/adm\/navmaps/) {
1453: next;
1454: }
1455:
1.191 bowersj2 1456: $args->{'counter'}++;
1457:
1.132 bowersj2 1458: # Does it have multiple parts?
1.133 bowersj2 1459: $args->{'multipart'} = 0;
1460: $args->{'condensed'} = 0;
1.132 bowersj2 1461: my @parts;
1462:
1463: # Decide what parts to show.
1.133 bowersj2 1464: if ($curRes->is_problem() && $showParts) {
1.132 bowersj2 1465: @parts = @{$curRes->parts()};
1.192 bowersj2 1466: $args->{'multipart'} = $curRes->multipart();
1.132 bowersj2 1467:
1468: if ($condenseParts) { # do the condensation
1469: if (!$curRes->opendate("0")) {
1.162 bowersj2 1470: @parts = ();
1.133 bowersj2 1471: $args->{'condensed'} = 1;
1.132 bowersj2 1472: }
1.133 bowersj2 1473: if (!$args->{'condensed'}) {
1.132 bowersj2 1474: # Decide whether to condense based on similarity
1.192 bowersj2 1475: my $status = $curRes->status($parts[0]);
1476: my $due = $curRes->duedate($parts[0]);
1477: my $open = $curRes->opendate($parts[0]);
1.132 bowersj2 1478: my $statusAllSame = 1;
1479: my $dueAllSame = 1;
1480: my $openAllSame = 1;
1.192 bowersj2 1481: for (my $i = 1; $i < scalar(@parts); $i++) {
1.132 bowersj2 1482: if ($curRes->status($parts[$i]) != $status){
1483: $statusAllSame = 0;
1484: }
1485: if ($curRes->duedate($parts[$i]) != $due ) {
1486: $dueAllSame = 0;
1487: }
1488: if ($curRes->opendate($parts[$i]) != $open) {
1489: $openAllSame = 0;
1490: }
1491: }
1492: # $*allSame is true if all the statuses were
1493: # the same. Now, if they are all the same and
1494: # match one of the statuses to condense, or they
1495: # are all open with the same due date, or they are
1496: # all OPEN_LATER with the same open date, display the
1497: # status of the first non-zero part (to get the 'correct'
1498: # status right, since 0 is never 'correct' or 'open').
1499: if (($statusAllSame && defined($condenseStatuses{$status})) ||
1500: ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
1501: ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
1.192 bowersj2 1502: @parts = ($parts[0]);
1.133 bowersj2 1503: $args->{'condensed'} = 1;
1.132 bowersj2 1504: }
1505: }
1.198 bowersj2 1506: # Multipart problem with one part: always "condense" (happens
1507: # to match the desirable behavior)
1508: if ($curRes->countParts() == 1) {
1509: @parts = ($parts[0]);
1510: $args->{'condensed'} = 1;
1511: }
1.132 bowersj2 1512: }
1.157 bowersj2 1513: }
1.132 bowersj2 1514:
1515: # If the multipart problem was condensed, "forget" it was multipart
1516: if (scalar(@parts) == 1) {
1.133 bowersj2 1517: $args->{'multipart'} = 0;
1.192 bowersj2 1518: } else {
1519: # Add part 0 so we display it correctly.
1520: unshift @parts, '0';
1.132 bowersj2 1521: }
1522:
1523: # Now, we've decided what parts to show. Loop through them and
1524: # show them.
1.192 bowersj2 1525: foreach my $part (@parts) {
1.132 bowersj2 1526: $rownum ++;
1527: my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];
1528:
1529: $result .= " <tr bgcolor='$backgroundColor'>\n";
1.134 bowersj2 1530:
1531: # Set up some data about the parts that the cols might want
1532: my $filter = $it->{FILTER};
1533: my $stack = $it->getStack();
1534: my $src = getLinkForResource($stack);
1535:
1536: my $srcHasQuestion = $src =~ /\?/;
1537: $args->{"resourceLink"} = $src.
1538: ($srcHasQuestion?'&':'?') .
1.137 bowersj2 1539: 'symb=' . &Apache::lonnet::escape($curRes->symb());
1.132 bowersj2 1540:
1541: # Now, display each column.
1542: foreach my $col (@$cols) {
1.139 bowersj2 1543: my $colHTML = '';
1544: if (ref($col)) {
1545: $colHTML .= &$col($curRes, $part, $args);
1546: } else {
1547: $colHTML .= &{$preparedColumns[$col]}($curRes, $part, $args);
1548: }
1.132 bowersj2 1549:
1.133 bowersj2 1550: # If this is the first column and it's time to print
1551: # the anchor, do so
1552: if ($col == $cols->[0] &&
1553: $args->{'counter'} == $args->{'currentJumpIndex'} -
1.139 bowersj2 1554: $currentJumpDelta) {
1555: # Jam the anchor after the <td> tag;
1556: # necessary for valid HTML (which Mozilla requires)
1557: $colHTML =~ s/\>/\>\<a name="curloc" \/\>/;
1.133 bowersj2 1558: $displayedJumpMarker = 1;
1559: }
1.139 bowersj2 1560: $result .= $colHTML . "\n";
1.132 bowersj2 1561: }
1.139 bowersj2 1562: $result .= " </tr>\n";
1.140 bowersj2 1563: $args->{'isNewBranch'} = 0;
1.139 bowersj2 1564: }
1.153 bowersj2 1565:
1.139 bowersj2 1566: if ($r && $rownum % 20 == 0) {
1567: $r->print($result);
1568: $result = "";
1569: $r->rflush();
1.132 bowersj2 1570: }
1.156 bowersj2 1571: } continue {
1.208 bowersj2 1572: if ($r) {
1573: # If we have the connection, make sure the user is still connected
1574: my $c = $r->connection;
1575: if ($c->aborted()) {
1576: # Who cares what we do, nobody will see it anyhow.
1577: return '';
1578: }
1579: }
1.132 bowersj2 1580: }
1581:
1.134 bowersj2 1582: # Print out the part that jumps to #curloc if it exists
1.159 bowersj2 1583: # delay needed because the browser is processing the jump before
1584: # it finishes rendering, so it goes to the wrong place!
1585: # onload might be better, but this routine has no access to that.
1586: # On mozilla, the 0-millisecond timeout seems to prevent this;
1587: # it's quite likely this might fix other browsers, too, and
1588: # certainly won't hurt anything.
1.139 bowersj2 1589: if ($displayedJumpMarker) {
1.159 bowersj2 1590: $result .= "<script>setTimeout(\"location += '#curloc';\", 0)</script>\n";
1.134 bowersj2 1591: }
1592:
1.132 bowersj2 1593: $result .= "</table>";
1.140 bowersj2 1594:
1595: if ($r) {
1596: $r->print($result);
1597: $result = "";
1598: $r->rflush();
1599: }
1600:
1.175 bowersj2 1601: if ($mustCloseNavMap) { $navmap->untieHashes(); }
1.132 bowersj2 1602:
1603: return $result;
1604: }
1605:
1.133 bowersj2 1606: 1;
1607:
1608: package Apache::lonnavmaps::navmap;
1609:
1610: =pod
1611:
1.216 bowersj2 1612: =head1 Object: Apache::lonnavmaps::navmap
1.133 bowersj2 1613:
1.217 bowersj2 1614: =head2 Overview
1.133 bowersj2 1615:
1.217 bowersj2 1616: The navmap object's job is to provide access to the resources
1617: in the course as Apache::lonnavmaps::resource objects, and to
1618: query and manage the relationship between those resource objects.
1619:
1620: Generally, you'll use the navmap object in one of three basic ways.
1621: In order of increasing complexity and power:
1622:
1623: =over 4
1624:
1625: =item * C<$navmap-E<gt>getByX>, where X is B<Id>, B<Symb>, B<Url> or B<MapPc>. This provides
1626: various ways to obtain resource objects, based on various identifiers.
1627: Use this when you want to request information about one object or
1628: a handful of resources you already know the identities of, from some
1629: other source. For more about Ids, Symbs, and MapPcs, see the
1630: Resource documentation. Note that Url should be a B<last resort>,
1631: not your first choice; it only works when there is only one
1632: instance of the resource in the course, which only applies to
1633: maps, and even that may change in the future.
1634:
1635: =item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This
1636: retrieves resources matching some criterion and returns them
1637: in a flat array, with no structure information. Use this when
1638: you are manipulating a series of resources, based on what map
1639: the are in, but do not care about branching, or exactly how
1640: the maps and resources are related. This is the most common case.
1641:
1642: =item * C<$it = $navmap-E<gt>getIterator(args)>. This allows you traverse
1643: the course's navmap in various ways without writing the traversal
1644: code yourself. See iterator documentation below. Use this when
1645: you need to know absolutely everything about the course, including
1646: branches and the precise relationship between maps and resources.
1647:
1648: =back
1649:
1650: =head2 Creation And Destruction
1651:
1652: To create a navmap object, use the following function:
1.133 bowersj2 1653:
1654: =over 4
1655:
1.221 bowersj2 1656: =item * B<Apache::lonnavmaps::navmap-E<gt>new>():
1.133 bowersj2 1657:
1.221 bowersj2 1658: Creates a new navmap object. Returns the navmap object if this is
1659: successful, or B<undef> if not.
1.174 albertel 1660:
1.216 bowersj2 1661: =back
1662:
1.217 bowersj2 1663: When you are done with the $navmap object, you I<must> call
1664: $navmap->untieHashes(), or you'll prevent the current user from using that
1665: course until the web server is restarted. (!)
1666:
1.216 bowersj2 1667: =head2 Methods
1668:
1669: =over 4
1670:
1.174 albertel 1671: =item * B<getIterator>(first, finish, filter, condition):
1672:
1673: See iterator documentation below.
1.133 bowersj2 1674:
1675: =cut
1676:
1677: use strict;
1678: use GDBM_File;
1679:
1680: sub new {
1681: # magic invocation to create a class instance
1682: my $proto = shift;
1683: my $class = ref($proto) || $proto;
1684: my $self = {};
1685:
1686: # Resource cache stores navmap resources as we reference them. We generate
1687: # them on-demand so we don't pay for creating resources unless we use them.
1688: $self->{RESOURCE_CACHE} = {};
1689:
1690: # Network failure flag, if we accessed the course or user opt and
1691: # failed
1692: $self->{NETWORK_FAILURE} = 0;
1693:
1694: # tie the nav hash
1695:
1.168 bowersj2 1696: my %navmaphash;
1697: my %parmhash;
1.220 bowersj2 1698: my $courseFn = $ENV{"request.course.fn"};
1699: if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",
1.133 bowersj2 1700: &GDBM_READER(), 0640))) {
1701: return undef;
1702: }
1703:
1.220 bowersj2 1704: if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db",
1.133 bowersj2 1705: &GDBM_READER(), 0640)))
1706: {
1.170 matthew 1707: untie %{$self->{PARM_HASH}};
1.133 bowersj2 1708: return undef;
1709: }
1710:
1.199 bowersj2 1711: $self->{NAV_HASH} = \%navmaphash;
1.168 bowersj2 1712: $self->{PARM_HASH} = \%parmhash;
1.221 bowersj2 1713: $self->{PARM_CACHE} = {};
1.133 bowersj2 1714:
1715: bless($self);
1716:
1717: return $self;
1718: }
1719:
1.221 bowersj2 1720: sub generate_course_user_opt {
1.133 bowersj2 1721: my $self = shift;
1.221 bowersj2 1722: if ($self->{COURSE_USER_OPT_GENERATED}) { return; }
1.133 bowersj2 1723:
1.221 bowersj2 1724: my $uname=$ENV{'user.name'};
1725: my $udom=$ENV{'user.domain'};
1726: my $uhome=$ENV{'user.home'};
1727: my $cid=$ENV{'request.course.id'};
1728: my $chome=$ENV{'course.'.$cid.'.home'};
1729: my ($cdom,$cnum)=split(/\_/,$cid);
1730:
1731: my $userprefix=$uname.'_'.$udom.'_';
1732:
1733: my %courserdatas; my %useropt; my %courseopt; my %userrdatas;
1734: unless ($uhome eq 'no_host') {
1.133 bowersj2 1735: # ------------------------------------------------- Get coursedata (if present)
1.221 bowersj2 1736: unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
1737: my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
1738: ':resourcedata',$chome);
1739: # Check for network failure
1740: if ( $reply =~ /no.such.host/i || $reply =~ /con_lost/i) {
1741: $self->{NETWORK_FAILURE} = 1;
1742: } elsif ($reply!~/^error\:/) {
1743: $courserdatas{$cid}=$reply;
1744: $courserdatas{$cid.'.last_cache'}=time;
1745: }
1746: }
1747: foreach (split(/\&/,$courserdatas{$cid})) {
1748: my ($name,$value)=split(/\=/,$_);
1749: $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
1750: &Apache::lonnet::unescape($value);
1751: }
1.133 bowersj2 1752: # --------------------------------------------------- Get userdata (if present)
1.221 bowersj2 1753: unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
1754: my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
1755: if ($reply!~/^error\:/) {
1756: $userrdatas{$uname.'___'.$udom}=$reply;
1757: $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
1758: }
1759: # check to see if network failed
1760: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1761: {
1762: $self->{NETWORK_FAILURE} = 1;
1763: }
1764: }
1765: foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
1766: my ($name,$value)=split(/\=/,$_);
1767: $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
1768: &Apache::lonnet::unescape($value);
1769: }
1770: $self->{COURSE_OPT} = \%courseopt;
1771: $self->{USER_OPT} = \%useropt;
1772: }
1773:
1774: $self->{COURSE_USER_OPT_GENERATED} = 1;
1775:
1776: return;
1777: }
1778:
1779: sub generate_email_discuss_status {
1780: my $self = shift;
1781: if ($self->{EMAIL_DISCUSS_GENERATED}) { return; }
1.133 bowersj2 1782:
1.221 bowersj2 1783: my $cid=$ENV{'request.course.id'};
1784: my ($cdom,$cnum)=split(/\_/,$cid);
1785:
1786: my %emailstatus = &Apache::lonnet::dump('email_status');
1787: my $logoutTime = $emailstatus{'logout'};
1788: my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
1789: $self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
1790: $courseLeaveTime : $logoutTime);
1791: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
1792: $cdom, $cnum);
1793: my %feedback=();
1794: my %error=();
1795: my $keys = &Apache::lonnet::reply('keys:'.
1796: $ENV{'user.domain'}.':'.
1797: $ENV{'user.name'}.':nohist_email',
1798: $ENV{'user.home'});
1799:
1800: foreach my $msgid (split(/\&/, $keys)) {
1801: $msgid=&Apache::lonnet::unescape($msgid);
1802: my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
1803: if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
1804: my ($what,$url)=($1,$2);
1805: my %status=
1806: &Apache::lonnet::get('email_status',[$msgid]);
1807: if ($status{$msgid}=~/^error\:/) {
1808: $status{$msgid}='';
1809: }
1810:
1811: if (($status{$msgid} eq 'new') ||
1812: (!$status{$msgid})) {
1813: if ($what eq 'Error') {
1814: $error{$url}.=','.$msgid;
1815: } else {
1816: $feedback{$url}.=','.$msgid;
1817: }
1818: }
1819: }
1.211 bowersj2 1820: }
1.221 bowersj2 1821:
1822: $self->{FEEDBACK} = \%feedback;
1823: $self->{ERROR_MSG} = \%error; # what is this? JB
1824: $self->{DISCUSSION_TIME} = \%discussiontime;
1825: $self->{EMAIL_STATUS} = \%emailstatus;
1826:
1827: $self->{EMAIL_DISCUSS_GENERATED} = 1;
1828: }
1829:
1830: sub get_user_data {
1831: my $self = shift;
1832: if ($self->{RETRIEVED_USER_DATA}) { return; }
1.211 bowersj2 1833:
1.221 bowersj2 1834: # Retrieve performance data on problems
1835: my %student_data = Apache::lonnet::currentdump($ENV{'request.course.id'},
1836: $ENV{'user.domain'},
1837: $ENV{'user.name'});
1838: $self->{STUDENT_DATA} = \%student_data;
1.133 bowersj2 1839:
1.221 bowersj2 1840: $self->{RETRIEVED_USER_DATA} = 1;
1.133 bowersj2 1841: }
1842:
1843: # Internal function: Takes a key to look up in the nav hash and implements internal
1844: # memory caching of that key.
1845: sub navhash {
1846: my $self = shift; my $key = shift;
1847: return $self->{NAV_HASH}->{$key};
1848: }
1849:
1.217 bowersj2 1850: =pod
1851:
1852: =item * B<courseMapDefined>(): Returns true if the course map is defined,
1853: false otherwise. Undefined course maps indicate an error somewhere in
1854: LON-CAPA, and you will not be able to proceed with using the navmap.
1855: See the B<NAV> screen for an example of using this.
1856:
1857: =cut
1858:
1.133 bowersj2 1859: # Checks to see if coursemap is defined, matching test in old lonnavmaps
1860: sub courseMapDefined {
1861: my $self = shift;
1862: my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});
1863:
1864: my $firstres = $self->navhash("map_start_$uri");
1865: my $lastres = $self->navhash("map_finish_$uri");
1866: return $firstres && $lastres;
1867: }
1868:
1869: sub getIterator {
1870: my $self = shift;
1871: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
1872: shift, undef, shift);
1873: return $iterator;
1874: }
1875:
1876: # unties the hash when done
1877: sub untieHashes {
1.168 bowersj2 1878: my $self = shift;
1.170 matthew 1879: untie %{$self->{NAV_HASH}};
1880: untie %{$self->{PARM_HASH}};
1.133 bowersj2 1881: }
1882:
1883: # Private method: Does the given resource (as a symb string) have
1884: # current discussion? Returns 0 if chat/mail data not extracted.
1885: sub hasDiscussion {
1886: my $self = shift;
1887: my $symb = shift;
1.221 bowersj2 1888:
1889: $self->generate_email_discuss_status();
1890:
1.133 bowersj2 1891: if (!defined($self->{DISCUSSION_TIME})) { return 0; }
1892:
1893: #return defined($self->{DISCUSSION_TIME}->{$symb});
1894: return $self->{DISCUSSION_TIME}->{$symb} >
1895: $self->{LAST_CHECK};
1896: }
1897:
1898: # Private method: Does the given resource (as a symb string) have
1899: # current feedback? Returns the string in the feedback hash, which
1900: # will be false if it does not exist.
1901: sub getFeedback {
1902: my $self = shift;
1903: my $symb = shift;
1904:
1.221 bowersj2 1905: $self->generate_email_discuss_status();
1906:
1.133 bowersj2 1907: if (!defined($self->{FEEDBACK})) { return ""; }
1908:
1909: return $self->{FEEDBACK}->{$symb};
1910: }
1911:
1912: # Private method: Get the errors for that resource (by source).
1913: sub getErrors {
1914: my $self = shift;
1915: my $src = shift;
1.221 bowersj2 1916:
1917: $self->generate_email_discuss_status();
1918:
1.133 bowersj2 1919: if (!defined($self->{ERROR_MSG})) { return ""; }
1920: return $self->{ERROR_MSG}->{$src};
1921: }
1922:
1923: =pod
1924:
1.174 albertel 1925: =item * B<getById>(id):
1926:
1927: Based on the ID of the resource (1.1, 3.2, etc.), get a resource
1928: object for that resource. This method, or other methods that use it
1929: (as in the resource object) is the only proper way to obtain a
1930: resource object.
1.133 bowersj2 1931:
1.194 bowersj2 1932: =item * B<getBySymb>(symb):
1933:
1934: Based on the symb of the resource, get a resource object for that
1935: resource. This is one of the proper ways to get a resource object.
1936:
1937: =item * B<getMapByMapPc>(map_pc):
1938:
1939: Based on the map_pc of the resource, get a resource object for
1940: the given map. This is one of the proper ways to get a resource object.
1941:
1.133 bowersj2 1942: =cut
1943:
1944: # The strategy here is to cache the resource objects, and only construct them
1945: # as we use them. The real point is to prevent reading any more from the tied
1946: # hash then we have to, which should hopefully alleviate speed problems.
1947:
1948: sub getById {
1949: my $self = shift;
1950: my $id = shift;
1951:
1952: if (defined ($self->{RESOURCE_CACHE}->{$id}))
1953: {
1954: return $self->{RESOURCE_CACHE}->{$id};
1955: }
1956:
1957: # resource handles inserting itself into cache.
1958: # Not clear why the quotes are necessary, but as of this
1959: # writing it doesn't work without them.
1960: return "Apache::lonnavmaps::resource"->new($self, $id);
1.132 bowersj2 1961: }
1.133 bowersj2 1962:
1.172 bowersj2 1963: sub getBySymb {
1964: my $self = shift;
1965: my $symb = shift;
1.228 albertel 1966: my ($mapUrl, $id, $filename) = &Apache::lonnet::decode_symb($symb);
1.172 bowersj2 1967: my $map = $self->getResourceByUrl($mapUrl);
1968: return $self->getById($map->map_pc() . '.' . $id);
1.194 bowersj2 1969: }
1970:
1971: sub getByMapPc {
1972: my $self = shift;
1973: my $map_pc = shift;
1974: my $map_id = $self->{NAV_HASH}->{'map_id_' . $map_pc};
1975: $map_id = $self->{NAV_HASH}->{'ids_' . $map_id};
1976: return $self->getById($map_id);
1.172 bowersj2 1977: }
1978:
1.133 bowersj2 1979: =pod
1980:
1.174 albertel 1981: =item * B<firstResource>():
1982:
1983: Returns a resource object reference corresponding to the first
1984: resource in the navmap.
1.133 bowersj2 1985:
1986: =cut
1987:
1988: sub firstResource {
1989: my $self = shift;
1990: my $firstResource = $self->navhash('map_start_' .
1991: &Apache::lonnet::clutter($ENV{'request.course.uri'}));
1992: return $self->getById($firstResource);
1.132 bowersj2 1993: }
1.133 bowersj2 1994:
1995: =pod
1996:
1.174 albertel 1997: =item * B<finishResource>():
1998:
1999: Returns a resource object reference corresponding to the last resource
2000: in the navmap.
1.133 bowersj2 2001:
2002: =cut
2003:
2004: sub finishResource {
2005: my $self = shift;
2006: my $firstResource = $self->navhash('map_finish_' .
2007: &Apache::lonnet::clutter($ENV{'request.course.uri'}));
2008: return $self->getById($firstResource);
1.132 bowersj2 2009: }
1.133 bowersj2 2010:
2011: # Parmval reads the parm hash and cascades the lookups. parmval_real does
2012: # the actual lookup; parmval caches the results.
2013: sub parmval {
2014: my $self = shift;
2015: my ($what,$symb)=@_;
2016: my $hashkey = $what."|||".$symb;
2017:
2018: if (defined($self->{PARM_CACHE}->{$hashkey})) {
2019: return $self->{PARM_CACHE}->{$hashkey};
2020: }
2021:
2022: my $result = $self->parmval_real($what, $symb);
2023: $self->{PARM_CACHE}->{$hashkey} = $result;
2024: return $result;
1.132 bowersj2 2025: }
2026:
1.133 bowersj2 2027: sub parmval_real {
2028: my $self = shift;
1.219 albertel 2029: my ($what,$symb,$recurse) = @_;
1.133 bowersj2 2030:
1.221 bowersj2 2031: # Make sure the {USER_OPT} and {COURSE_OPT} hashes are populated
2032: $self->generate_course_user_opt();
2033:
1.133 bowersj2 2034: my $cid=$ENV{'request.course.id'};
2035: my $csec=$ENV{'request.course.sec'};
2036: my $uname=$ENV{'user.name'};
2037: my $udom=$ENV{'user.domain'};
2038:
2039: unless ($symb) { return ''; }
2040: my $result='';
2041:
1.226 www 2042: my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
1.133 bowersj2 2043:
2044: # ----------------------------------------------------- Cascading lookup scheme
2045: my $rwhat=$what;
2046: $what=~s/^parameter\_//;
2047: $what=~s/\_/\./;
2048:
2049: my $symbparm=$symb.'.'.$what;
2050: my $mapparm=$mapname.'___(all).'.$what;
2051: my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
2052:
2053: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
2054: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
2055: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
2056:
2057: my $courselevel= $usercourseprefix.'.'.$what;
2058: my $courselevelr=$usercourseprefix.'.'.$symbparm;
2059: my $courselevelm=$usercourseprefix.'.'.$mapparm;
2060:
2061: my $useropt = $self->{USER_OPT};
2062: my $courseopt = $self->{COURSE_OPT};
2063: my $parmhash = $self->{PARM_HASH};
2064:
2065: # ---------------------------------------------------------- first, check user
2066: if ($uname and defined($useropt)) {
2067: if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; }
2068: if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; }
2069: if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; }
2070: }
2071:
2072: # ------------------------------------------------------- second, check course
2073: if ($csec and defined($courseopt)) {
2074: if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
2075: if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
2076: if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; }
2077: }
2078:
2079: if (defined($courseopt)) {
2080: if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; }
2081: if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; }
2082: if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; }
2083: }
2084:
2085: # ----------------------------------------------------- third, check map parms
2086:
2087: my $thisparm=$$parmhash{$symbparm};
2088: if (defined($thisparm)) { return $thisparm; }
2089:
2090: # ----------------------------------------------------- fourth , check default
2091:
1.246 ! albertel 2092: my $meta_rwhat=$rwhat;
! 2093: $meta_rwhat=~s/\./_/g;
! 2094: my $default=&Apache::lonnet::metadata($fn,$meta_rwhat);
! 2095: if (defined($default)) { return $default}
! 2096: $default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat);
1.133 bowersj2 2097: if (defined($default)) { return $default}
2098:
2099: # --------------------------------------------------- fifth , cascade up parts
2100:
2101: my ($space,@qualifier)=split(/\./,$rwhat);
2102: my $qualifier=join('.',@qualifier);
2103: unless ($space eq '0') {
1.160 albertel 2104: my @parts=split(/_/,$space);
2105: my $id=pop(@parts);
2106: my $part=join('_',@parts);
2107: if ($part eq '') { $part='0'; }
1.219 albertel 2108: my $partgeneral=$self->parmval($part.".$qualifier",$symb,1);
1.160 albertel 2109: if (defined($partgeneral)) { return $partgeneral; }
1.133 bowersj2 2110: }
1.219 albertel 2111: if ($recurse) { return undef; }
2112: my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$what);
2113: if (defined($pack_def)) { return $pack_def; }
1.133 bowersj2 2114: return '';
1.145 bowersj2 2115: }
2116:
1.174 albertel 2117: =pod
1.145 bowersj2 2118:
1.174 albertel 2119: =item * B<getResourceByUrl>(url):
1.145 bowersj2 2120:
1.174 albertel 2121: Retrieves a resource object by URL of the resource. If passed a
2122: resource object, it will simply return it, so it is safe to use this
2123: method in code like "$res = $navmap->getResourceByUrl($res)", if
2124: you're not sure if $res is already an object, or just a URL. If the
2125: resource appears multiple times in the course, only the first instance
2126: will be returned. As a result, this is probably useful only for maps.
2127:
2128: =item * B<retrieveResources>(map, filterFunc, recursive, bailout):
2129:
2130: The map is a specification of a map to retreive the resources from,
2131: either as a url or as an object. The filterFunc is a reference to a
2132: function that takes a resource object as its one argument and returns
2133: true if the resource should be included, or false if it should not
2134: be. If recursive is true, the map will be recursively examined,
2135: otherwise it will not be. If bailout is true, the function will return
2136: as soon as it finds a resource, if false it will finish. By default,
2137: the map is the top-level map of the course, filterFunc is a function
2138: that always returns 1, recursive is true, bailout is false. The
2139: resources will be returned in a list containing the resource objects
2140: for the corresponding resources, with B<no structure information> in
2141: the list; regardless of branching, recursion, etc., it will be a flat
2142: list.
2143:
2144: Thus, this is suitable for cases where you don't want the structure,
2145: just a list of all resources. It is also suitable for finding out how
2146: many resources match a given description; for this use, if all you
2147: want to know is if I<any> resources match the description, the bailout
2148: parameter will allow you to avoid potentially expensive enumeration of
2149: all matching resources.
1.145 bowersj2 2150:
1.174 albertel 2151: =item * B<hasResources>(map, filterFunc, recursive):
1.145 bowersj2 2152:
1.174 albertel 2153: Convience method for
1.146 bowersj2 2154:
2155: scalar(retrieveResources($map, $filterFunc, $recursive, 1)) > 0
2156:
1.174 albertel 2157: which will tell whether the map has resources matching the description
2158: in the filter function.
1.146 bowersj2 2159:
1.145 bowersj2 2160: =cut
2161:
2162: sub getResourceByUrl {
2163: my $self = shift;
2164: my $resUrl = shift;
2165:
2166: if (ref($resUrl)) { return $resUrl; }
2167:
2168: $resUrl = &Apache::lonnet::clutter($resUrl);
2169: my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl};
2170: if ($resId =~ /,/) {
2171: $resId = (split (/,/, $resId))[0];
2172: }
2173: if (!$resId) { return ''; }
2174: return $self->getById($resId);
2175: }
2176:
2177: sub retrieveResources {
2178: my $self = shift;
2179: my $map = shift;
2180: my $filterFunc = shift;
2181: if (!defined ($filterFunc)) {
2182: $filterFunc = sub {return 1;};
2183: }
2184: my $recursive = shift;
2185: if (!defined($recursive)) { $recursive = 1; }
2186: my $bailout = shift;
2187: if (!defined($bailout)) { $bailout = 0; }
2188:
2189: # Create the necessary iterator.
2190: if (!ref($map)) { # assume it's a url of a map.
1.172 bowersj2 2191: $map = $self->getResourceByUrl($map);
1.145 bowersj2 2192: }
2193:
1.213 bowersj2 2194: # If nothing was passed, assume top-level map
2195: if (!$map) {
2196: $map = $self->getById('0.0');
2197: }
2198:
1.145 bowersj2 2199: # Check the map's validity.
1.213 bowersj2 2200: if (!$map->is_map()) {
1.145 bowersj2 2201: # Oh, to throw an exception.... how I'd love that!
2202: return ();
2203: }
2204:
1.146 bowersj2 2205: # Get an iterator.
2206: my $it = $self->getIterator($map->map_start(), $map->map_finish(),
1.215 bowersj2 2207: undef, $recursive);
1.146 bowersj2 2208:
2209: my @resources = ();
2210:
2211: # Run down the iterator and collect the resources.
1.222 bowersj2 2212: my $curRes;
2213:
2214: while ($curRes = $it->next()) {
1.146 bowersj2 2215: if (ref($curRes)) {
2216: if (!&$filterFunc($curRes)) {
2217: next;
2218: }
2219:
2220: push @resources, $curRes;
2221:
2222: if ($bailout) {
2223: return @resources;
2224: }
2225: }
2226:
2227: }
2228:
2229: return @resources;
2230: }
2231:
2232: sub hasResource {
2233: my $self = shift;
2234: my $map = shift;
2235: my $filterFunc = shift;
2236: my $recursive = shift;
2237:
2238: return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1)) > 0;
1.133 bowersj2 2239: }
1.51 bowersj2 2240:
2241: 1;
2242:
2243: package Apache::lonnavmaps::iterator;
2244:
2245: =pod
2246:
2247: =back
2248:
1.174 albertel 2249: =head1 Object: navmap Iterator
1.51 bowersj2 2250:
1.174 albertel 2251: An I<iterator> encapsulates the logic required to traverse a data
2252: structure. navmap uses an iterator to traverse the course map
2253: according to the criteria you wish to use.
2254:
2255: To obtain an iterator, call the B<getIterator>() function of a
2256: B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator
2257: directly.) This will return a reference to the iterator:
1.51 bowersj2 2258:
2259: C<my $resourceIterator = $navmap-E<gt>getIterator();>
2260:
2261: To get the next thing from the iterator, call B<next>:
2262:
2263: C<my $nextThing = $resourceIterator-E<gt>next()>
2264:
2265: getIterator behaves as follows:
2266:
2267: =over 4
2268:
1.174 albertel 2269: =item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap):
2270:
2271: All parameters are optional. firstResource is a resource reference
2272: corresponding to where the iterator should start. It defaults to
2273: navmap->firstResource() for the corresponding nav map. finishResource
2274: corresponds to where you want the iterator to end, defaulting to
2275: navmap->finishResource(). filterHash is a hash used as a set
2276: containing strings representing the resource IDs, defaulting to
2277: empty. Condition is a 1 or 0 that sets what to do with the filter
1.205 bowersj2 2278: hash: If a 0, then only resources that exist IN the filterHash will be
1.174 albertel 2279: recursed on. If it is a 1, only resources NOT in the filterHash will
2280: be recursed on. Defaults to 0. forceTop is a boolean value. If it is
2281: false (default), the iterator will only return the first level of map
2282: that is not just a single, 'redirecting' map. If true, the iterator
2283: will return all information, starting with the top-level map,
2284: regardless of content. returnTopMap, if true (default false), will
2285: cause the iterator to return the top-level map object (resource 0.0)
2286: before anything else.
2287:
2288: Thus, by default, only top-level resources will be shown. Change the
2289: condition to a 1 without changing the hash, and all resources will be
2290: shown. Changing the condition to 1 and including some values in the
2291: hash will allow you to selectively suppress parts of the navmap, while
2292: leaving it on 0 and adding things to the hash will allow you to
2293: selectively add parts of the nav map. See the handler code for
2294: examples.
2295:
2296: The iterator will return either a reference to a resource object, or a
2297: token representing something in the map, such as the beginning of a
2298: new branch. The possible tokens are:
2299:
2300: =over 4
1.51 bowersj2 2301:
1.222 bowersj2 2302: =item * B<END_ITERATOR>:
2303:
2304: The iterator has returned all that it's going to. Further calls to the
2305: iterator will just produce more of these. This is a "false" value, and
2306: is the only false value the iterator which will be returned, so it can
2307: be used as a loop sentinel.
2308:
1.217 bowersj2 2309: =item * B<BEGIN_MAP>:
1.51 bowersj2 2310:
1.174 albertel 2311: A new map is being recursed into. This is returned I<after> the map
2312: resource itself is returned.
1.51 bowersj2 2313:
1.217 bowersj2 2314: =item * B<END_MAP>:
1.174 albertel 2315:
2316: The map is now done.
1.51 bowersj2 2317:
1.217 bowersj2 2318: =item * B<BEGIN_BRANCH>:
1.70 bowersj2 2319:
1.174 albertel 2320: A branch is now starting. The next resource returned will be the first
2321: in that branch.
1.70 bowersj2 2322:
1.217 bowersj2 2323: =item * B<END_BRANCH>:
1.70 bowersj2 2324:
1.174 albertel 2325: The branch is now done.
1.51 bowersj2 2326:
2327: =back
2328:
1.174 albertel 2329: The tokens are retreivable via methods on the iterator object, i.e.,
2330: $iterator->END_MAP.
1.70 bowersj2 2331:
1.174 albertel 2332: Maps can contain empty resources. The iterator will automatically skip
2333: over such resources, but will still treat the structure
2334: correctly. Thus, a complicated map with several branches, but
2335: consisting entirely of empty resources except for one beginning or
2336: ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs,
2337: but only one resource will be returned.
1.116 bowersj2 2338:
1.242 matthew 2339: =back
2340:
1.222 bowersj2 2341: =head2 Normal Usage
2342:
2343: Normal usage of the iterator object is to do the following:
2344:
2345: my $it = $navmap->getIterator([your params here]);
2346: my $curRes;
2347: while ($curRes = $it->next()) {
2348: [your logic here]
2349: }
2350:
2351: Note that inside of the loop, it's frequently useful to check if
2352: "$curRes" is a reference or not with the reference function; only
2353: resource objects will be references, and any non-references will
2354: be the tokens described above.
2355:
2356: Also note there is some old code floating around that trys to track
2357: the depth of the iterator to see when it's done; do not copy that
2358: code. It is difficult to get right and harder to understand then
2359: this. They should be migrated to this new style.
1.51 bowersj2 2360:
2361: =cut
2362:
2363: # Here are the tokens for the iterator:
2364:
1.222 bowersj2 2365: sub END_ITERATOR { return 0; }
1.51 bowersj2 2366: sub BEGIN_MAP { return 1; } # begining of a new map
2367: sub END_MAP { return 2; } # end of the map
2368: sub BEGIN_BRANCH { return 3; } # beginning of a branch
2369: sub END_BRANCH { return 4; } # end of a branch
1.89 bowersj2 2370: sub FORWARD { return 1; } # go forward
2371: sub BACKWARD { return 2; }
1.51 bowersj2 2372:
1.96 bowersj2 2373: sub min {
2374: (my $a, my $b) = @_;
2375: if ($a < $b) { return $a; } else { return $b; }
2376: }
2377:
1.94 bowersj2 2378: sub new {
2379: # magic invocation to create a class instance
2380: my $proto = shift;
2381: my $class = ref($proto) || $proto;
2382: my $self = {};
2383:
2384: $self->{NAV_MAP} = shift;
2385: return undef unless ($self->{NAV_MAP});
2386:
2387: # Handle the parameters
2388: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
2389: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
2390:
2391: # If the given resources are just the ID of the resource, get the
2392: # objects
2393: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
2394: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
2395: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
2396: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
2397:
2398: $self->{FILTER} = shift;
2399:
2400: # A hash, used as a set, of resource already seen
2401: $self->{ALREADY_SEEN} = shift;
2402: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
2403: $self->{CONDITION} = shift;
2404:
1.116 bowersj2 2405: # Do we want to automatically follow "redirection" maps?
2406: $self->{FORCE_TOP} = shift;
2407:
1.162 bowersj2 2408: # Do we want to return the top-level map object (resource 0.0)?
2409: $self->{RETURN_0} = shift;
2410: # have we done that yet?
2411: $self->{HAVE_RETURNED_0} = 0;
2412:
1.94 bowersj2 2413: # Now, we need to pre-process the map, by walking forward and backward
2414: # over the parts of the map we're going to look at.
1.96 bowersj2 2415:
1.97 bowersj2 2416: # The processing steps are exactly the same, except for a few small
2417: # changes, so I bundle those up in the following list of two elements:
2418: # (direction_to_iterate, VAL_name, next_resource_method_to_call,
2419: # first_resource).
2420: # This prevents writing nearly-identical code twice.
2421: my @iterations = ( [FORWARD(), 'TOP_DOWN_VAL', 'getNext',
2422: 'FIRST_RESOURCE'],
2423: [BACKWARD(), 'BOT_UP_VAL', 'getPrevious',
2424: 'FINISH_RESOURCE'] );
2425:
1.98 bowersj2 2426: my $maxDepth = 0; # tracks max depth
2427:
1.116 bowersj2 2428: # If there is only one resource in this map, and it's a map, we
2429: # want to remember that, so the user can ask for the first map
2430: # that isn't just a redirector.
2431: my $resource; my $resourceCount = 0;
2432:
1.209 bowersj2 2433: # Documentation on this algorithm can be found in the CVS repository at
2434: # /docs/lonnavdocs; these "**#**" markers correspond to documentation
2435: # in that file.
1.107 bowersj2 2436: # **1**
2437:
1.97 bowersj2 2438: foreach my $pass (@iterations) {
2439: my $direction = $pass->[0];
2440: my $valName = $pass->[1];
2441: my $nextResourceMethod = $pass->[2];
2442: my $firstResourceName = $pass->[3];
2443:
2444: my $iterator = Apache::lonnavmaps::DFSiterator->new($self->{NAV_MAP},
2445: $self->{FIRST_RESOURCE},
2446: $self->{FINISH_RESOURCE},
2447: {}, undef, 0, $direction);
1.96 bowersj2 2448:
1.97 bowersj2 2449: # prime the recursion
2450: $self->{$firstResourceName}->{DATA}->{$valName} = 0;
1.222 bowersj2 2451: $iterator->next();
1.97 bowersj2 2452: my $curRes = $iterator->next();
1.222 bowersj2 2453: my $depth = 1;
2454: while ($depth > 0) {
2455: if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
2456: if ($curRes == $iterator->END_MAP()) { $depth--; }
2457:
1.97 bowersj2 2458: if (ref($curRes)) {
1.116 bowersj2 2459: # If there's only one resource, this will save it
1.117 bowersj2 2460: # we have to filter empty resources from consideration here,
2461: # or even "empty", redirecting maps have two (start & finish)
2462: # or three (start, finish, plus redirector)
2463: if($direction == FORWARD && $curRes->src()) {
2464: $resource = $curRes; $resourceCount++;
2465: }
1.97 bowersj2 2466: my $resultingVal = $curRes->{DATA}->{$valName};
2467: my $nextResources = $curRes->$nextResourceMethod();
1.116 bowersj2 2468: my $nextCount = scalar(@{$nextResources});
1.104 bowersj2 2469:
1.116 bowersj2 2470: if ($nextCount == 1) { # **3**
1.97 bowersj2 2471: my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;
2472: $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
2473: }
2474:
1.116 bowersj2 2475: if ($nextCount > 1) { # **4**
1.97 bowersj2 2476: foreach my $res (@{$nextResources}) {
2477: my $current = $res->{DATA}->{$valName} || 999999999;
2478: $res->{DATA}->{$valName} = min($current, $resultingVal + 1);
2479: }
2480: }
2481: }
1.96 bowersj2 2482:
1.107 bowersj2 2483: # Assign the final val (**2**)
1.97 bowersj2 2484: if (ref($curRes) && $direction == BACKWARD()) {
1.98 bowersj2 2485: my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},
2486: $curRes->{DATA}->{BOT_UP_VAL});
2487:
2488: $curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;
2489: if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}
1.190 bowersj2 2490: }
1.222 bowersj2 2491:
2492: $curRes = $iterator->next();
1.96 bowersj2 2493: }
2494: }
1.94 bowersj2 2495:
1.116 bowersj2 2496: # Check: Was this only one resource, a map?
2497: if ($resourceCount == 1 && $resource->is_map() && !$self->{FORCE_TOP}) {
2498: my $firstResource = $resource->map_start();
2499: my $finishResource = $resource->map_finish();
2500: return
2501: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
2502: $finishResource, $self->{FILTER},
2503: $self->{ALREADY_SEEN},
2504: $self->{CONDITION}, 0);
2505:
2506: }
2507:
1.98 bowersj2 2508: # Set up some bookkeeping information.
2509: $self->{CURRENT_DEPTH} = 0;
2510: $self->{MAX_DEPTH} = $maxDepth;
2511: $self->{STACK} = [];
2512: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1.222 bowersj2 2513: $self->{FINISHED} = 0; # When true, the iterator has finished
1.98 bowersj2 2514:
2515: for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) {
2516: push @{$self->{STACK}}, [];
2517: }
2518:
1.107 bowersj2 2519: # Prime the recursion w/ the first resource **5**
1.98 bowersj2 2520: push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};
2521: $self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;
2522:
2523: bless ($self);
2524:
2525: return $self;
2526: }
2527:
2528: sub next {
2529: my $self = shift;
1.162 bowersj2 2530:
1.222 bowersj2 2531: if ($self->{FINISHED}) {
2532: return END_ITERATOR();
2533: }
2534:
1.162 bowersj2 2535: # If we want to return the top-level map object, and haven't yet,
2536: # do so.
2537: if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {
2538: $self->{HAVE_RETURNED_0} = 1;
2539: return $self->{NAV_MAP}->getById('0.0');
2540: }
1.98 bowersj2 2541:
2542: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
2543: # grab the next from the recursive iterator
2544: my $next = $self->{RECURSIVE_ITERATOR}->next();
2545:
2546: # is it a begin or end map? If so, update the depth
2547: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
2548: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
2549:
2550: # Are we back at depth 0? If so, stop recursing
2551: if ($self->{RECURSIVE_DEPTH} == 0) {
2552: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
2553: }
2554:
2555: return $next;
2556: }
2557:
2558: if (defined($self->{FORCE_NEXT})) {
2559: my $tmp = $self->{FORCE_NEXT};
2560: $self->{FORCE_NEXT} = undef;
2561: return $tmp;
2562: }
2563:
2564: # Have we not yet begun? If not, return BEGIN_MAP and
2565: # remember we've started.
2566: if ( !$self->{STARTED} ) {
2567: $self->{STARTED} = 1;
2568: return $self->BEGIN_MAP();
2569: }
2570:
2571: # Here's the guts of the iterator.
2572:
2573: # Find the next resource, if any.
2574: my $found = 0;
2575: my $i = $self->{MAX_DEPTH};
2576: my $newDepth;
2577: my $here;
2578: while ( $i >= 0 && !$found ) {
1.107 bowersj2 2579: if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6**
2580: $here = pop @{$self->{STACK}->[$i]}; # **7**
1.98 bowersj2 2581: $found = 1;
2582: $newDepth = $i;
2583: }
2584: $i--;
2585: }
2586:
2587: # If we still didn't find anything, we're done.
2588: if ( !$found ) {
2589: # We need to get back down to the correct branch depth
2590: if ( $self->{CURRENT_DEPTH} > 0 ) {
2591: $self->{CURRENT_DEPTH}--;
2592: return END_BRANCH();
2593: } else {
1.222 bowersj2 2594: $self->{FINISHED} = 1;
1.98 bowersj2 2595: return END_MAP();
2596: }
2597: }
2598:
1.104 bowersj2 2599: # If this is not a resource, it must be an END_BRANCH marker we want
2600: # to return directly.
1.107 bowersj2 2601: if (!ref($here)) { # **8**
1.104 bowersj2 2602: if ($here == END_BRANCH()) { # paranoia, in case of later extension
2603: $self->{CURRENT_DEPTH}--;
2604: return $here;
2605: }
2606: }
2607:
2608: # Otherwise, it is a resource and it's safe to store in $self->{HERE}
2609: $self->{HERE} = $here;
2610:
1.98 bowersj2 2611: # Get to the right level
2612: if ( $self->{CURRENT_DEPTH} > $newDepth ) {
2613: push @{$self->{STACK}->[$newDepth]}, $here;
2614: $self->{CURRENT_DEPTH}--;
2615: return END_BRANCH();
2616: }
2617: if ( $self->{CURRENT_DEPTH} < $newDepth) {
2618: push @{$self->{STACK}->[$newDepth]}, $here;
2619: $self->{CURRENT_DEPTH}++;
2620: return BEGIN_BRANCH();
2621: }
2622:
2623: # If we made it here, we have the next resource, and we're at the
2624: # right branch level. So let's examine the resource for where
2625: # we can get to from here.
2626:
2627: # So we need to look at all the resources we can get to from here,
2628: # categorize them if we haven't seen them, remember if we have a new
2629: my $nextUnfiltered = $here->getNext();
1.104 bowersj2 2630: my $maxDepthAdded = -1;
2631:
1.98 bowersj2 2632: for (@$nextUnfiltered) {
2633: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
1.104 bowersj2 2634: my $depth = $_->{DATA}->{DISPLAY_DEPTH};
2635: push @{$self->{STACK}->[$depth]}, $_;
1.98 bowersj2 2636: $self->{ALREADY_SEEN}->{$_->{ID}} = 1;
1.104 bowersj2 2637: if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; }
1.98 bowersj2 2638: }
2639: }
1.104 bowersj2 2640:
2641: # Is this the end of a branch? If so, all of the resources examined above
2642: # led to lower levels then the one we are currently at, so we push a END_BRANCH
2643: # marker onto the stack so we don't forget.
2644: # Example: For the usual A(BC)(DE)F case, when the iterator goes down the
2645: # BC branch and gets to C, it will see F as the only next resource, but it's
2646: # one level lower. Thus, this is the end of the branch, since there are no
2647: # more resources added to this level or above.
1.111 bowersj2 2648: # We don't do this if the examined resource is the finish resource,
2649: # because the condition given above is true, but the "END_MAP" will
2650: # take care of things and we should already be at depth 0.
1.104 bowersj2 2651: my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH};
1.111 bowersj2 2652: if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9**
1.104 bowersj2 2653: push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH();
2654: }
2655:
1.98 bowersj2 2656: # That ends the main iterator logic. Now, do we want to recurse
2657: # down this map (if this resource is a map)?
2658: if ($self->{HERE}->is_map() &&
2659: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
2660: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
2661: my $firstResource = $self->{HERE}->map_start();
2662: my $finishResource = $self->{HERE}->map_finish();
2663:
2664: $self->{RECURSIVE_ITERATOR} =
2665: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
2666: $finishResource, $self->{FILTER},
2667: $self->{ALREADY_SEEN}, $self->{CONDITION});
2668: }
2669:
1.116 bowersj2 2670: # If this is a blank resource, don't actually return it.
1.117 bowersj2 2671: # Should you ever find you need it, make sure to add an option to the code
2672: # that you can use; other things depend on this behavior.
1.138 bowersj2 2673: my $browsePriv = $self->{HERE}->browsePriv();
2674: if (!$self->{HERE}->src() ||
2675: (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
1.116 bowersj2 2676: return $self->next();
2677: }
2678:
1.98 bowersj2 2679: return $self->{HERE};
2680:
2681: }
2682:
2683: =pod
2684:
1.174 albertel 2685: The other method available on the iterator is B<getStack>, which
2686: returns an array populated with the current 'stack' of maps, as
2687: references to the resource objects. Example: This is useful when
2688: making the navigation map, as we need to check whether we are under a
2689: page map to see if we need to link directly to the resource, or to the
2690: page. The first elements in the array will correspond to the top of
2691: the stack (most inclusive map).
1.98 bowersj2 2692:
2693: =cut
2694:
2695: sub getStack {
2696: my $self=shift;
2697:
2698: my @stack;
2699:
2700: $self->populateStack(\@stack);
2701:
2702: return \@stack;
2703: }
2704:
2705: # Private method: Calls the iterators recursively to populate the stack.
2706: sub populateStack {
2707: my $self=shift;
2708: my $stack = shift;
2709:
2710: push @$stack, $self->{HERE} if ($self->{HERE});
2711:
2712: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
2713: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
2714: }
1.94 bowersj2 2715: }
2716:
2717: 1;
2718:
2719: package Apache::lonnavmaps::DFSiterator;
2720:
1.100 bowersj2 2721: # Not documented in the perldoc: This is a simple iterator that just walks
2722: # through the nav map and presents the resources in a depth-first search
2723: # fashion, ignorant of conditionals, randomized resources, etc. It presents
2724: # BEGIN_MAP and END_MAP, but does not understand branches at all. It is
2725: # useful for pre-processing of some kind, and is in fact used by the main
2726: # iterator that way, but that's about it.
2727: # One could imagine merging this into the init routine of the main iterator,
2728: # but this might as well be left seperate, since it is possible some other
2729: # use might be found for it. - Jeremy
1.94 bowersj2 2730:
1.117 bowersj2 2731: # Unlike the main iterator, this DOES return all resources, even blank ones.
2732: # The main iterator needs them to correctly preprocess the map.
2733:
1.94 bowersj2 2734: sub BEGIN_MAP { return 1; } # begining of a new map
2735: sub END_MAP { return 2; } # end of the map
2736: sub FORWARD { return 1; } # go forward
2737: sub BACKWARD { return 2; }
2738:
1.100 bowersj2 2739: # Params: Nav map ref, first resource id/ref, finish resource id/ref,
2740: # filter hash ref (or undef), already seen hash or undef, condition
2741: # (as in main iterator), direction FORWARD or BACKWARD (undef->forward).
1.51 bowersj2 2742: sub new {
2743: # magic invocation to create a class instance
2744: my $proto = shift;
2745: my $class = ref($proto) || $proto;
2746: my $self = {};
2747:
2748: $self->{NAV_MAP} = shift;
2749: return undef unless ($self->{NAV_MAP});
2750:
2751: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
2752: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
2753:
2754: # If the given resources are just the ID of the resource, get the
2755: # objects
2756: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
2757: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
2758: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
2759: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
2760:
2761: $self->{FILTER} = shift;
2762:
2763: # A hash, used as a set, of resource already seen
2764: $self->{ALREADY_SEEN} = shift;
1.140 bowersj2 2765: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1.63 bowersj2 2766: $self->{CONDITION} = shift;
1.89 bowersj2 2767: $self->{DIRECTION} = shift || FORWARD();
1.51 bowersj2 2768:
1.100 bowersj2 2769: # Flag: Have we started yet?
1.51 bowersj2 2770: $self->{STARTED} = 0;
2771:
2772: # Should we continue calling the recursive iterator, if any?
2773: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
2774: # The recursive iterator, if any
2775: $self->{RECURSIVE_ITERATOR} = undef;
2776: # Are we recursing on a map, or a branch?
2777: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
2778: # And the count of how deep it is, so that this iterator can keep track of
2779: # when to pick back up again.
2780: $self->{RECURSIVE_DEPTH} = 0;
2781:
2782: # For keeping track of our branches, we maintain our own stack
1.100 bowersj2 2783: $self->{STACK} = [];
1.51 bowersj2 2784:
2785: # Start with the first resource
1.89 bowersj2 2786: if ($self->{DIRECTION} == FORWARD) {
1.100 bowersj2 2787: push @{$self->{STACK}}, $self->{FIRST_RESOURCE};
1.89 bowersj2 2788: } else {
1.100 bowersj2 2789: push @{$self->{STACK}}, $self->{FINISH_RESOURCE};
1.89 bowersj2 2790: }
1.51 bowersj2 2791:
2792: bless($self);
2793: return $self;
2794: }
2795:
2796: sub next {
2797: my $self = shift;
2798:
2799: # Are we using a recursive iterator? If so, pull from that and
2800: # watch the depth; we want to resume our level at the correct time.
1.98 bowersj2 2801: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1.51 bowersj2 2802: # grab the next from the recursive iterator
2803: my $next = $self->{RECURSIVE_ITERATOR}->next();
2804:
2805: # is it a begin or end map? Update depth if so
2806: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
2807: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
2808:
2809: # Are we back at depth 0? If so, stop recursing.
2810: if ($self->{RECURSIVE_DEPTH} == 0) {
2811: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
2812: }
2813:
2814: return $next;
2815: }
2816:
2817: # Is there a current resource to grab? If not, then return
1.100 bowersj2 2818: # END_MAP, which will end the iterator.
2819: if (scalar(@{$self->{STACK}}) == 0) {
2820: return $self->END_MAP();
1.51 bowersj2 2821: }
2822:
2823: # Have we not yet begun? If not, return BEGIN_MAP and
2824: # remember that we've started.
2825: if ( !$self->{STARTED} ) {
2826: $self->{STARTED} = 1;
2827: return $self->BEGIN_MAP;
2828: }
2829:
2830: # Get the next resource in the branch
1.100 bowersj2 2831: $self->{HERE} = pop @{$self->{STACK}};
1.52 bowersj2 2832:
1.100 bowersj2 2833: # remember that we've seen this, so we don't return it again later
1.51 bowersj2 2834: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
2835:
2836: # Get the next possible resources
1.90 bowersj2 2837: my $nextUnfiltered;
1.89 bowersj2 2838: if ($self->{DIRECTION} == FORWARD()) {
1.90 bowersj2 2839: $nextUnfiltered = $self->{HERE}->getNext();
1.89 bowersj2 2840: } else {
1.90 bowersj2 2841: $nextUnfiltered = $self->{HERE}->getPrevious();
1.89 bowersj2 2842: }
1.51 bowersj2 2843: my $next = [];
2844:
2845: # filter the next possibilities to remove things we've
1.100 bowersj2 2846: # already seen.
1.51 bowersj2 2847: foreach (@$nextUnfiltered) {
1.52 bowersj2 2848: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
2849: push @$next, $_;
2850: }
1.51 bowersj2 2851: }
2852:
2853: while (@$next) {
1.100 bowersj2 2854: # copy the next possibilities over to the stack
2855: push @{$self->{STACK}}, shift @$next;
1.51 bowersj2 2856: }
2857:
2858: # If this is a map and we want to recurse down it... (not filtered out)
1.70 bowersj2 2859: if ($self->{HERE}->is_map() &&
1.63 bowersj2 2860: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
1.51 bowersj2 2861: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
2862: my $firstResource = $self->{HERE}->map_start();
2863: my $finishResource = $self->{HERE}->map_finish();
2864:
2865: $self->{RECURSIVE_ITERATOR} =
1.94 bowersj2 2866: Apache::lonnavmaps::DFSiterator->new ($self->{NAV_MAP}, $firstResource,
1.63 bowersj2 2867: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
1.91 bowersj2 2868: $self->{CONDITION}, $self->{DIRECTION});
1.51 bowersj2 2869: }
2870:
2871: return $self->{HERE};
1.190 bowersj2 2872: }
2873:
2874: # Identical to the full iterator methods of the same name. Hate to copy/paste
2875: # but I also hate to "inherit" either iterator from the other.
2876:
2877: sub getStack {
2878: my $self=shift;
2879:
2880: my @stack;
2881:
2882: $self->populateStack(\@stack);
2883:
2884: return \@stack;
2885: }
2886:
2887: # Private method: Calls the iterators recursively to populate the stack.
2888: sub populateStack {
2889: my $self=shift;
2890: my $stack = shift;
2891:
2892: push @$stack, $self->{HERE} if ($self->{HERE});
2893:
2894: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
2895: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
2896: }
1.51 bowersj2 2897: }
2898:
1.1 www 2899: 1;
1.2 www 2900:
1.51 bowersj2 2901: package Apache::lonnavmaps::resource;
2902:
2903: use Apache::lonnet;
2904:
2905: =pod
2906:
1.217 bowersj2 2907: =head1 Object: resource
1.51 bowersj2 2908:
1.217 bowersj2 2909: X<resource, navmap object>
1.174 albertel 2910: A resource object encapsulates a resource in a resource map, allowing
2911: easy manipulation of the resource, querying the properties of the
2912: resource (including user properties), and represents a reference that
2913: can be used as the canonical representation of the resource by
2914: lonnavmap clients like renderers.
2915:
2916: A resource only makes sense in the context of a navmap, as some of the
2917: data is stored in the navmap object.
2918:
2919: You will probably never need to instantiate this object directly. Use
2920: Apache::lonnavmaps::navmap, and use the "start" method to obtain the
2921: starting resource.
1.51 bowersj2 2922:
1.188 bowersj2 2923: Resource objects respect the parameter_hiddenparts, which suppresses
2924: various parts according to the wishes of the map author. As of this
2925: writing, there is no way to override this parameter, and suppressed
2926: parts will never be returned, nor will their response types or ids be
2927: stored.
2928:
1.217 bowersj2 2929: =head2 Overview
1.51 bowersj2 2930:
1.217 bowersj2 2931: A B<Resource> is the most granular type of object in LON-CAPA that can
2932: be included in a course. It can either be a particular resource, like
2933: an HTML page, external resource, problem, etc., or it can be a
2934: container sequence, such as a "page" or a "map".
2935:
2936: To see a sequence from the user's point of view, please see the
2937: B<Creating a Course: Maps and Sequences> chapter of the Author's
2938: Manual.
2939:
2940: A Resource Object, once obtained from a navmap object via a B<getBy*>
2941: method of the navmap, or from an iterator, allows you to query
2942: information about that resource.
2943:
2944: Generally, you do not ever want to create a resource object yourself,
2945: so creation has been left undocumented. Always retrieve resources
2946: from navmap objects.
2947:
2948: =head3 Identifying Resources
2949:
2950: X<big hash>Every resource is identified by a Resource ID in the big hash that is
2951: unique to that resource for a given course. X<resource ID, in big hash>
2952: The Resource ID has the form #.#, where the first number is the same
2953: for every resource in a map, and the second is unique. For instance,
2954: for a course laid out like this:
2955:
2956: * Problem 1
2957: * Map
2958: * Resource 2
2959: * Resource 3
2960:
2961: C<Problem 1> and C<Map> will share a first number, and C<Resource 2>
2962: C<Resource 3> will share a first number. The second number may end up
2963: re-used between the two groups.
2964:
2965: The resource ID is only used in the big hash, but can be used in the
2966: context of a course to identify a resource easily. (For instance, the
2967: printing system uses it to record which resources from a sequence you
2968: wish to print.)
2969:
2970: X<symb> X<resource, symb>
2971: All resources also have B<symb>s, which uniquely identify a resource
2972: in a course. Many internal LON-CAPA functions expect a symb. A symb
2973: carries along with it the URL of the resource, and the map it appears
2974: in. Symbs are much larger then resource IDs.
1.51 bowersj2 2975:
2976: =cut
2977:
2978: sub new {
2979: # magic invocation to create a class instance
2980: my $proto = shift;
2981: my $class = ref($proto) || $proto;
2982: my $self = {};
2983:
2984: $self->{NAV_MAP} = shift;
2985: $self->{ID} = shift;
2986:
2987: # Store this new resource in the parent nav map's cache.
2988: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
1.66 bowersj2 2989: $self->{RESOURCE_ERROR} = 0;
1.51 bowersj2 2990:
2991: # A hash that can be used by two-pass algorithms to store data
2992: # about this resource in. Not used by the resource object
2993: # directly.
2994: $self->{DATA} = {};
2995:
2996: bless($self);
2997:
2998: return $self;
2999: }
3000:
1.70 bowersj2 3001: # private function: simplify the NAV_HASH lookups we keep doing
3002: # pass the name, and to automatically append my ID, pass a true val on the
3003: # second param
3004: sub navHash {
3005: my $self = shift;
3006: my $param = shift;
3007: my $id = shift;
1.115 bowersj2 3008: return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:""));
1.70 bowersj2 3009: }
3010:
1.51 bowersj2 3011: =pod
3012:
1.217 bowersj2 3013: =head2 Methods
1.70 bowersj2 3014:
1.217 bowersj2 3015: Once you have a resource object, here's what you can do with it:
3016:
3017: =head3 Attribute Retrieval
3018:
3019: Every resource has certain attributes that can be retrieved and used:
1.70 bowersj2 3020:
3021: =over 4
3022:
1.217 bowersj2 3023: =item * B<ID>: Every resource has an ID that is unique for that
3024: resource in the course it is in. The ID is actually in the hash
3025: representing the resource, so for a resource object $res, obtain
3026: it via C<$res->{ID}).
3027:
1.174 albertel 3028: =item * B<compTitle>:
3029:
3030: Returns a "composite title", that is equal to $res->title() if the
3031: resource has a title, and is otherwise the last part of the URL (e.g.,
3032: "problem.problem").
3033:
3034: =item * B<ext>:
3035:
3036: Returns true if the resource is external.
3037:
3038: =item * B<kind>:
3039:
3040: Returns the kind of the resource from the compiled nav map.
3041:
3042: =item * B<randomout>:
1.106 bowersj2 3043:
1.174 albertel 3044: Returns true if this resource was chosen to NOT be shown to the user
3045: by the random map selection feature. In other words, this is usually
3046: false.
1.70 bowersj2 3047:
1.174 albertel 3048: =item * B<randompick>:
1.70 bowersj2 3049:
1.174 albertel 3050: Returns true for a map if the randompick feature is being used on the
3051: map. (?)
1.70 bowersj2 3052:
1.174 albertel 3053: =item * B<src>:
1.51 bowersj2 3054:
1.174 albertel 3055: Returns the source for the resource.
1.70 bowersj2 3056:
1.174 albertel 3057: =item * B<symb>:
1.70 bowersj2 3058:
1.174 albertel 3059: Returns the symb for the resource.
1.70 bowersj2 3060:
1.174 albertel 3061: =item * B<title>:
1.70 bowersj2 3062:
1.174 albertel 3063: Returns the title of the resource.
3064:
1.51 bowersj2 3065: =back
3066:
3067: =cut
3068:
3069: # These info functions can be used directly, as they don't return
3070: # resource information.
1.85 bowersj2 3071: sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
1.70 bowersj2 3072: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
1.85 bowersj2 3073: sub from { my $self=shift; return $self->navHash("from_", 1); }
1.217 bowersj2 3074: # considered private and undocumented
1.51 bowersj2 3075: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
3076: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
1.68 bowersj2 3077: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
3078: sub randompick {
3079: my $self = shift;
3080: return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .
3081: '.0.parameter_randompick'};
3082: }
1.51 bowersj2 3083: sub src {
3084: my $self=shift;
3085: return $self->navHash("src_", 1);
3086: }
3087: sub symb {
3088: my $self=shift;
3089: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
3090: my $symbSrc = &Apache::lonnet::declutter($self->src());
1.223 albertel 3091: my $symb = &Apache::lonnet::declutter($self->navHash('map_id_'.$first))
1.51 bowersj2 3092: . '___' . $second . '___' . $symbSrc;
1.223 albertel 3093: return &Apache::lonnet::symbclean($symb);
1.51 bowersj2 3094: }
1.213 bowersj2 3095: sub title {
3096: my $self=shift;
3097: if ($self->{ID} eq '0.0') {
3098: # If this is the top-level map, return the title of the course
3099: # since this map can not be titled otherwise.
3100: return $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
3101: }
3102: return $self->navHash("title_", 1); }
1.217 bowersj2 3103: # considered private and undocumented
1.70 bowersj2 3104: sub to { my $self=shift; return $self->navHash("to_", 1); }
1.106 bowersj2 3105: sub compTitle {
3106: my $self = shift;
3107: my $title = $self->title();
1.176 www 3108: $title=~s/\&colon\;/\:/gs;
1.106 bowersj2 3109: if (!$title) {
3110: $title = $self->src();
3111: $title = substr($title, rindex($title, '/') + 1);
3112: }
3113: return $title;
3114: }
1.70 bowersj2 3115: =pod
3116:
3117: B<Predicate Testing the Resource>
3118:
3119: These methods are shortcuts to deciding if a given resource has a given property.
3120:
3121: =over 4
3122:
1.174 albertel 3123: =item * B<is_map>:
3124:
3125: Returns true if the resource is a map type.
3126:
3127: =item * B<is_problem>:
1.70 bowersj2 3128:
1.174 albertel 3129: Returns true if the resource is a problem type, false
3130: otherwise. (Looks at the extension on the src field; might need more
3131: to work correctly.)
1.70 bowersj2 3132:
1.174 albertel 3133: =item * B<is_page>:
1.70 bowersj2 3134:
1.174 albertel 3135: Returns true if the resource is a page.
3136:
3137: =item * B<is_sequence>:
3138:
3139: Returns true if the resource is a sequence.
1.70 bowersj2 3140:
3141: =back
3142:
3143: =cut
3144:
3145:
3146: sub is_html {
1.51 bowersj2 3147: my $self=shift;
3148: my $src = $self->src();
1.70 bowersj2 3149: return ($src =~ /html$/);
1.51 bowersj2 3150: }
1.70 bowersj2 3151: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
3152: sub is_page {
1.51 bowersj2 3153: my $self=shift;
3154: my $src = $self->src();
1.205 bowersj2 3155: return $self->navHash("is_map_", 1) &&
3156: $self->navHash("map_type_" . $self->map_pc()) eq 'page';
1.51 bowersj2 3157: }
1.70 bowersj2 3158: sub is_problem {
1.51 bowersj2 3159: my $self=shift;
3160: my $src = $self->src();
1.70 bowersj2 3161: return ($src =~ /problem$/);
1.51 bowersj2 3162: }
1.70 bowersj2 3163: sub is_sequence {
1.51 bowersj2 3164: my $self=shift;
3165: my $src = $self->src();
1.205 bowersj2 3166: return $self->navHash("is_map_", 1) &&
3167: $self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
1.51 bowersj2 3168: }
3169:
1.101 bowersj2 3170: # Private method: Shells out to the parmval in the nav map, handler parts.
1.51 bowersj2 3171: sub parmval {
3172: my $self = shift;
3173: my $what = shift;
1.185 bowersj2 3174: my $part = shift;
3175: if (!defined($part)) {
3176: $part = '0';
3177: }
1.51 bowersj2 3178: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
3179: }
3180:
1.70 bowersj2 3181: =pod
3182:
3183: B<Map Methods>
3184:
1.174 albertel 3185: These methods are useful for getting information about the map
3186: properties of the resource, if the resource is a map (B<is_map>).
1.70 bowersj2 3187:
3188: =over 4
3189:
1.174 albertel 3190: =item * B<map_finish>:
3191:
3192: Returns a reference to a resource object corresponding to the finish
3193: resource of the map.
1.70 bowersj2 3194:
1.174 albertel 3195: =item * B<map_pc>:
1.70 bowersj2 3196:
1.174 albertel 3197: Returns the pc value of the map, which is the first number that
3198: appears in the resource ID of the resources in the map, and is the
3199: number that appears around the middle of the symbs of the resources in
3200: that map.
1.70 bowersj2 3201:
1.174 albertel 3202: =item * B<map_start>:
3203:
3204: Returns a reference to a resource object corresponding to the start
3205: resource of the map.
3206:
3207: =item * B<map_type>:
3208:
3209: Returns a string with the type of the map in it.
1.70 bowersj2 3210:
3211: =back
1.51 bowersj2 3212:
1.70 bowersj2 3213: =cut
1.51 bowersj2 3214:
3215: sub map_finish {
3216: my $self = shift;
3217: my $src = $self->src();
1.144 bowersj2 3218: $src = Apache::lonnet::clutter($src);
1.51 bowersj2 3219: my $res = $self->navHash("map_finish_$src", 0);
3220: $res = $self->{NAV_MAP}->getById($res);
3221: return $res;
3222: }
1.70 bowersj2 3223: sub map_pc {
3224: my $self = shift;
3225: my $src = $self->src();
3226: return $self->navHash("map_pc_$src", 0);
3227: }
1.51 bowersj2 3228: sub map_start {
3229: my $self = shift;
3230: my $src = $self->src();
1.144 bowersj2 3231: $src = Apache::lonnet::clutter($src);
1.51 bowersj2 3232: my $res = $self->navHash("map_start_$src", 0);
3233: $res = $self->{NAV_MAP}->getById($res);
3234: return $res;
3235: }
3236: sub map_type {
3237: my $self = shift;
3238: my $pc = $self->map_pc();
3239: return $self->navHash("map_type_$pc", 0);
3240: }
3241:
3242: #####
3243: # Property queries
3244: #####
3245:
3246: # These functions will be responsible for returning the CORRECT
3247: # VALUE for the parameter, no matter what. So while they may look
3248: # like direct calls to parmval, they can be more then that.
3249: # So, for instance, the duedate function should use the "duedatetype"
3250: # information, rather then the resource object user.
3251:
3252: =pod
3253:
3254: =head2 Resource Parameters
3255:
1.174 albertel 3256: In order to use the resource parameters correctly, the nav map must
3257: have been instantiated with genCourseAndUserOptions set to true, so
3258: the courseopt and useropt is read correctly. Then, you can call these
3259: functions to get the relevant parameters for the resource. Each
3260: function defaults to part "0", but can be directed to another part by
3261: passing the part as the parameter.
3262:
3263: These methods are responsible for getting the parameter correct, not
3264: merely reflecting the contents of the GDBM hashes. As we move towards
3265: dates relative to other dates, these methods should be updated to
3266: reflect that. (Then, anybody using these methods will not have to update
3267: their code.)
3268:
3269: =over 4
3270:
3271: =item * B<acc>:
3272:
3273: Get the Client IP/Name Access Control information.
1.51 bowersj2 3274:
1.174 albertel 3275: =item * B<answerdate>:
1.51 bowersj2 3276:
1.174 albertel 3277: Get the answer-reveal date for the problem.
3278:
1.211 bowersj2 3279: =item * B<awarded>:
3280:
3281: Gets the awarded value for the problem part. Requires genUserData set to
3282: true when the navmap object was created.
3283:
1.174 albertel 3284: =item * B<duedate>:
3285:
3286: Get the due date for the problem.
3287:
3288: =item * B<tries>:
3289:
3290: Get the number of tries the student has used on the problem.
3291:
3292: =item * B<maxtries>:
3293:
3294: Get the number of max tries allowed.
3295:
3296: =item * B<opendate>:
1.51 bowersj2 3297:
1.174 albertel 3298: Get the open date for the problem.
1.51 bowersj2 3299:
1.174 albertel 3300: =item * B<sig>:
1.51 bowersj2 3301:
1.174 albertel 3302: Get the significant figures setting.
1.51 bowersj2 3303:
1.174 albertel 3304: =item * B<tol>:
1.51 bowersj2 3305:
1.174 albertel 3306: Get the tolerance for the problem.
1.51 bowersj2 3307:
1.174 albertel 3308: =item * B<tries>:
1.51 bowersj2 3309:
1.174 albertel 3310: Get the number of tries the user has already used on the problem.
1.51 bowersj2 3311:
1.174 albertel 3312: =item * B<type>:
1.51 bowersj2 3313:
1.174 albertel 3314: Get the question type for the problem.
1.70 bowersj2 3315:
1.174 albertel 3316: =item * B<weight>:
1.51 bowersj2 3317:
1.174 albertel 3318: Get the weight for the problem.
1.51 bowersj2 3319:
3320: =back
3321:
3322: =cut
3323:
3324: sub acc {
3325: (my $self, my $part) = @_;
3326: return $self->parmval("acc", $part);
3327: }
3328: sub answerdate {
3329: (my $self, my $part) = @_;
3330: # Handle intervals
3331: if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
3332: return $self->duedate($part) +
3333: $self->parmval("answerdate", $part);
3334: }
3335: return $self->parmval("answerdate", $part);
1.106 bowersj2 3336: }
1.211 bowersj2 3337: sub awarded {
3338: my $self = shift; my $part = shift;
1.221 bowersj2 3339: $self->{NAV_MAP}->get_user_data();
1.211 bowersj2 3340: if (!defined($part)) { $part = '0'; }
3341: return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'};
3342: }
1.51 bowersj2 3343: sub duedate {
3344: (my $self, my $part) = @_;
3345: return $self->parmval("duedate", $part);
3346: }
3347: sub maxtries {
3348: (my $self, my $part) = @_;
3349: return $self->parmval("maxtries", $part);
3350: }
3351: sub opendate {
3352: (my $self, my $part) = @_;
3353: if ($self->parmval("opendate.type", $part) eq 'date_interval') {
3354: return $self->duedate($part) -
3355: $self->parmval("opendate", $part);
3356: }
3357: return $self->parmval("opendate");
3358: }
1.185 bowersj2 3359: sub problemstatus {
3360: (my $self, my $part) = @_;
1.236 bowersj2 3361: return lc $self->parmval("problemstatus", $part);
1.185 bowersj2 3362: }
1.51 bowersj2 3363: sub sig {
3364: (my $self, my $part) = @_;
3365: return $self->parmval("sig", $part);
3366: }
3367: sub tol {
3368: (my $self, my $part) = @_;
3369: return $self->parmval("tol", $part);
3370: }
1.108 bowersj2 3371: sub tries {
3372: my $self = shift;
3373: my $tries = $self->queryRestoreHash('tries', shift);
3374: if (!defined($tries)) { return '0';}
1.51 bowersj2 3375: return $tries;
3376: }
1.70 bowersj2 3377: sub type {
3378: (my $self, my $part) = @_;
3379: return $self->parmval("type", $part);
3380: }
1.109 bowersj2 3381: sub weight {
3382: my $self = shift; my $part = shift;
1.211 bowersj2 3383: if (!defined($part)) { $part = '0'; }
3384: return &Apache::lonnet::EXT('resource.'.$part.'.weight',
3385: $self->symb(), $ENV{'user.domain'},
3386: $ENV{'user.name'},
3387: $ENV{'request.course.sec'});
3388:
1.70 bowersj2 3389: }
1.51 bowersj2 3390:
3391: # Multiple things need this
3392: sub getReturnHash {
3393: my $self = shift;
3394:
3395: if (!defined($self->{RETURN_HASH})) {
1.84 bowersj2 3396: my %tmpHash = &Apache::lonnet::restore($self->symb());
1.51 bowersj2 3397: $self->{RETURN_HASH} = \%tmpHash;
3398: }
3399: }
3400:
3401: ######
3402: # Status queries
3403: ######
3404:
3405: # These methods query the status of problems.
3406:
3407: # If we need to count parts, this function determines the number of
3408: # parts from the metadata. When called, it returns a reference to a list
3409: # of strings corresponding to the parts. (Thus, using it in a scalar context
3410: # tells you how many parts you have in the problem:
3411: # $partcount = scalar($resource->countParts());
3412: # Don't use $self->{PARTS} directly because you don't know if it's been
3413: # computed yet.
3414:
3415: =pod
3416:
3417: =head2 Resource misc
3418:
3419: Misc. functions for the resource.
3420:
3421: =over 4
3422:
1.174 albertel 3423: =item * B<hasDiscussion>:
1.59 bowersj2 3424:
1.174 albertel 3425: Returns a false value if there has been discussion since the user last
3426: logged in, true if there has. Always returns false if the discussion
3427: data was not extracted when the nav map was constructed.
3428:
3429: =item * B<getFeedback>:
3430:
3431: Gets the feedback for the resource and returns the raw feedback string
3432: for the resource, or the null string if there is no feedback or the
3433: email data was not extracted when the nav map was constructed. Usually
3434: used like this:
1.59 bowersj2 3435:
3436: for (split(/\,/, $res->getFeedback())) {
3437: my $link = &Apache::lonnet::escape($_);
3438: ...
3439:
3440: and use the link as appropriate.
3441:
3442: =cut
3443:
3444: sub hasDiscussion {
3445: my $self = shift;
3446: return $self->{NAV_MAP}->hasDiscussion($self->symb());
3447: }
3448:
3449: sub getFeedback {
3450: my $self = shift;
1.124 bowersj2 3451: my $source = $self->src();
1.125 bowersj2 3452: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
1.124 bowersj2 3453: return $self->{NAV_MAP}->getFeedback($source);
3454: }
3455:
3456: sub getErrors {
3457: my $self = shift;
3458: my $source = $self->src();
3459: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
3460: return $self->{NAV_MAP}->getErrors($source);
1.59 bowersj2 3461: }
3462:
3463: =pod
3464:
1.174 albertel 3465: =item * B<parts>():
1.51 bowersj2 3466:
1.174 albertel 3467: Returns a list reference containing sorted strings corresponding to
1.193 bowersj2 3468: each part of the problem. Single part problems have only a part '0'.
3469: Multipart problems do not return their part '0', since they typically
3470: do not really matter.
1.174 albertel 3471:
3472: =item * B<countParts>():
3473:
3474: Returns the number of parts of the problem a student can answer. Thus,
3475: for single part problems, returns 1. For multipart, it returns the
1.193 bowersj2 3476: number of parts in the problem, not including psuedo-part 0.
1.51 bowersj2 3477:
1.192 bowersj2 3478: =item * B<multipart>():
3479:
1.193 bowersj2 3480: Returns true if the problem is multipart, false otherwise. Use this instead
3481: of countParts if all you want is multipart/not multipart.
1.192 bowersj2 3482:
1.187 bowersj2 3483: =item * B<responseType>($part):
3484:
3485: Returns the response type of the part, without the word "response" on the
3486: end. Example return values: 'string', 'essay', 'numeric', etc.
3487:
1.193 bowersj2 3488: =item * B<responseIds>($part):
1.187 bowersj2 3489:
1.193 bowersj2 3490: Retreives the response IDs for the given part as an array reference containing
3491: strings naming the response IDs. This may be empty.
1.187 bowersj2 3492:
1.51 bowersj2 3493: =back
3494:
3495: =cut
3496:
3497: sub parts {
3498: my $self = shift;
3499:
1.192 bowersj2 3500: if ($self->ext) { return []; }
1.67 bowersj2 3501:
1.51 bowersj2 3502: $self->extractParts();
3503: return $self->{PARTS};
3504: }
3505:
3506: sub countParts {
3507: my $self = shift;
3508:
3509: my $parts = $self->parts();
1.191 bowersj2 3510:
3511: # If I left this here, then it's not necessary.
3512: #my $delta = 0;
3513: #for my $part (@$parts) {
3514: # if ($part eq '0') { $delta--; }
3515: #}
1.66 bowersj2 3516:
3517: if ($self->{RESOURCE_ERROR}) {
3518: return 0;
3519: }
3520:
1.191 bowersj2 3521: return scalar(@{$parts}); # + $delta;
1.192 bowersj2 3522: }
3523:
3524: sub multipart {
3525: my $self = shift;
3526: return $self->countParts() > 1;
1.51 bowersj2 3527: }
3528:
1.225 bowersj2 3529: sub singlepart {
3530: my $self = shift;
3531: return $self->countParts() == 1;
3532: }
3533:
1.187 bowersj2 3534: sub responseType {
1.184 bowersj2 3535: my $self = shift;
3536: my $part = shift;
3537:
3538: $self->extractParts();
1.235 albertel 3539: if (defined($self->{RESPONSE_TYPES}->{$part})) {
3540: return @{$self->{RESPONSE_TYPES}->{$part}};
3541: } else {
3542: return undef;
3543: }
1.187 bowersj2 3544: }
3545:
1.193 bowersj2 3546: sub responseIds {
1.187 bowersj2 3547: my $self = shift;
3548: my $part = shift;
3549:
3550: $self->extractParts();
1.235 albertel 3551: if (defined($self->{RESPONSE_IDS}->{$part})) {
3552: return @{$self->{RESPONSE_IDS}->{$part}};
3553: } else {
3554: return undef;
3555: }
1.184 bowersj2 3556: }
3557:
3558: # Private function: Extracts the parts information, both part names and
1.187 bowersj2 3559: # part types, and saves it.
1.51 bowersj2 3560: sub extractParts {
3561: my $self = shift;
3562:
1.153 bowersj2 3563: return if (defined($self->{PARTS}));
1.67 bowersj2 3564: return if ($self->ext);
1.51 bowersj2 3565:
3566: $self->{PARTS} = [];
3567:
1.181 bowersj2 3568: my %parts;
3569:
1.82 bowersj2 3570: # Retrieve part count, if this is a problem
3571: if ($self->is_problem()) {
1.240 albertel 3572: my $partorder = &Apache::lonnet::metadata($self->src(), 'partorder');
1.152 matthew 3573: my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
1.181 bowersj2 3574:
1.239 bowersj2 3575: if ($partorder) {
3576: my @parts;
3577: for my $part (split (/,/,$partorder)) {
3578: if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
3579: push @parts, $part;
1.241 albertel 3580: $parts{$part} = 1;
1.239 bowersj2 3581: }
3582: }
3583: $self->{PARTS} = \@parts;
3584: } else {
3585: if (!$metadata) {
3586: $self->{RESOURCE_ERROR} = 1;
3587: $self->{PARTS} = [];
3588: $self->{PART_TYPE} = {};
3589: return;
3590: }
3591: foreach (split(/\,/,$metadata)) {
3592: if ($_ =~ /^part_(.*)$/) {
3593: my $part = $1;
3594: # This floods the logs if it blows up
3595: if (defined($parts{$part})) {
1.241 albertel 3596: &Apache::lonnet::logthis("$part multiply defined in metadata for " . $self->symb());
3597: }
1.239 bowersj2 3598:
3599: # check to see if part is turned off.
3600:
3601: if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
3602: $parts{$part} = 1;
3603: }
3604: }
3605: }
3606: my @sortedParts = sort keys %parts;
3607: $self->{PARTS} = \@sortedParts;
1.51 bowersj2 3608: }
1.82 bowersj2 3609:
1.187 bowersj2 3610:
3611: my %responseIdHash;
3612: my %responseTypeHash;
3613:
1.189 bowersj2 3614:
3615: # Init the responseIdHash
3616: foreach (@{$self->{PARTS}}) {
3617: $responseIdHash{$_} = [];
3618: }
3619:
1.187 bowersj2 3620: # Now, the unfortunate thing about this is that parts, part name, and
1.239 bowersj2 3621: # response id are delimited by underscores, but both the part
1.187 bowersj2 3622: # name and response id can themselves have underscores in them.
3623: # So we have to use our knowlege of part names to figure out
3624: # where the part names begin and end, and even then, it is possible
3625: # to construct ambiguous situations.
3626: foreach (split /,/, $metadata) {
3627: if ($_ =~ /^([a-zA-Z]+)response_(.*)/) {
3628: my $responseType = $1;
3629: my $partStuff = $2;
3630: my $partIdSoFar = '';
3631: my @partChunks = split /_/, $partStuff;
3632: my $i = 0;
3633: for ($i = 0; $i < scalar(@partChunks); $i++) {
3634: if ($partIdSoFar) { $partIdSoFar .= '_'; }
3635: $partIdSoFar .= $partChunks[$i];
3636: if ($parts{$partIdSoFar}) {
3637: my @otherChunks = @partChunks[$i+1..$#partChunks];
3638: my $responseId = join('_', @otherChunks);
1.188 bowersj2 3639: push @{$responseIdHash{$partIdSoFar}}, $responseId;
1.233 matthew 3640: push @{$responseTypeHash{$partIdSoFar}}, $responseType;
1.187 bowersj2 3641: }
3642: }
3643: }
3644: }
3645: $self->{RESPONSE_IDS} = \%responseIdHash;
3646: $self->{RESPONSE_TYPES} = \%responseTypeHash;
1.154 bowersj2 3647: }
3648:
1.51 bowersj2 3649: return;
3650: }
3651:
3652: =pod
3653:
3654: =head2 Resource Status
3655:
1.174 albertel 3656: Problem resources have status information, reflecting their various
3657: dates and completion statuses.
1.51 bowersj2 3658:
1.174 albertel 3659: There are two aspects to the status: the date-related information and
3660: the completion information.
1.51 bowersj2 3661:
1.174 albertel 3662: Idiomatic usage of these two methods would probably look something
3663: like
1.51 bowersj2 3664:
3665: foreach ($resource->parts()) {
3666: my $dateStatus = $resource->getDateStatus($_);
3667: my $completionStatus = $resource->getCompletionStatus($_);
3668:
1.70 bowersj2 3669: or
3670:
3671: my $status = $resource->status($_);
3672:
1.51 bowersj2 3673: ... use it here ...
3674: }
3675:
1.174 albertel 3676: Which you use depends on exactly what you are looking for. The
3677: status() function has been optimized for the nav maps display and may
3678: not precisely match what you need elsewhere.
1.101 bowersj2 3679:
1.174 albertel 3680: The symbolic constants shown below can be accessed through the
3681: resource object: C<$res->OPEN>.
1.101 bowersj2 3682:
1.51 bowersj2 3683: =over 4
3684:
1.174 albertel 3685: =item * B<getDateStatus>($part):
3686:
3687: ($part defaults to 0). A convenience function that returns a symbolic
3688: constant telling you about the date status of the part. The possible
3689: return values are:
1.51 bowersj2 3690:
3691: =back
3692:
3693: B<Date Codes>
3694:
3695: =over 4
3696:
1.174 albertel 3697: =item * B<OPEN_LATER>:
3698:
3699: The problem will be opened later.
3700:
3701: =item * B<OPEN>:
3702:
3703: Open and not yet due.
3704:
1.51 bowersj2 3705:
1.174 albertel 3706: =item * B<PAST_DUE_ANSWER_LATER>:
1.51 bowersj2 3707:
1.174 albertel 3708: The due date has passed, but the answer date has not yet arrived.
1.59 bowersj2 3709:
1.174 albertel 3710: =item * B<PAST_DUE_NO_ANSWER>:
1.54 bowersj2 3711:
1.174 albertel 3712: The due date has passed and there is no answer opening date set.
1.51 bowersj2 3713:
1.174 albertel 3714: =item * B<ANSWER_OPEN>:
1.51 bowersj2 3715:
1.174 albertel 3716: The answer date is here.
3717:
3718: =item * B<NETWORK_FAILURE>:
3719:
3720: The information is unknown due to network failure.
1.51 bowersj2 3721:
3722: =back
3723:
3724: =cut
3725:
3726: # Apparently the compiler optimizes these into constants automatically
1.54 bowersj2 3727: sub OPEN_LATER { return 0; }
3728: sub OPEN { return 1; }
3729: sub PAST_DUE_NO_ANSWER { return 2; }
3730: sub PAST_DUE_ANSWER_LATER { return 3; }
3731: sub ANSWER_OPEN { return 4; }
3732: sub NOTHING_SET { return 5; }
3733: sub NETWORK_FAILURE { return 100; }
3734:
3735: # getDateStatus gets the date status for a given problem part.
3736: # Because answer date, due date, and open date are fully independent
3737: # (i.e., it is perfectly possible to *only* have an answer date),
3738: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
3739: # (past, future, none given). This function handles this with a decision
3740: # tree. Read the comments to follow the decision tree.
1.51 bowersj2 3741:
3742: sub getDateStatus {
3743: my $self = shift;
3744: my $part = shift;
3745: $part = "0" if (!defined($part));
1.54 bowersj2 3746:
3747: # Always return network failure if there was one.
1.51 bowersj2 3748: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
3749:
3750: my $now = time();
3751:
1.53 bowersj2 3752: my $open = $self->opendate($part);
3753: my $due = $self->duedate($part);
3754: my $answer = $self->answerdate($part);
3755:
3756: if (!$open && !$due && !$answer) {
3757: # no data on the problem at all
3758: # should this be the same as "open later"? think multipart.
3759: return $self->NOTHING_SET;
3760: }
1.59 bowersj2 3761: if (!$open || $now < $open) {return $self->OPEN_LATER}
3762: if (!$due || $now < $due) {return $self->OPEN}
3763: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
3764: if ($answer) { return $self->ANSWER_OPEN; }
1.54 bowersj2 3765: return PAST_DUE_NO_ANSWER;
1.51 bowersj2 3766: }
3767:
3768: =pod
3769:
3770: B<>
3771:
3772: =over 4
3773:
1.174 albertel 3774: =item * B<getCompletionStatus>($part):
1.51 bowersj2 3775:
1.174 albertel 3776: ($part defaults to 0.) A convenience function that returns a symbolic
3777: constant telling you about the completion status of the part, with the
3778: following possible results:
3779:
3780: =back
1.51 bowersj2 3781:
3782: B<Completion Codes>
3783:
3784: =over 4
3785:
1.174 albertel 3786: =item * B<NOT_ATTEMPTED>:
3787:
3788: Has not been attempted at all.
3789:
3790: =item * B<INCORRECT>:
3791:
3792: Attempted, but wrong by student.
1.51 bowersj2 3793:
1.174 albertel 3794: =item * B<INCORRECT_BY_OVERRIDE>:
1.51 bowersj2 3795:
1.174 albertel 3796: Attempted, but wrong by instructor override.
1.51 bowersj2 3797:
1.174 albertel 3798: =item * B<CORRECT>:
1.51 bowersj2 3799:
1.174 albertel 3800: Correct or correct by instructor.
1.51 bowersj2 3801:
1.174 albertel 3802: =item * B<CORRECT_BY_OVERRIDE>:
1.51 bowersj2 3803:
1.174 albertel 3804: Correct by instructor override.
1.51 bowersj2 3805:
1.174 albertel 3806: =item * B<EXCUSED>:
3807:
3808: Excused. Not yet implemented.
3809:
3810: =item * B<NETWORK_FAILURE>:
3811:
3812: Information not available due to network failure.
3813:
3814: =item * B<ATTEMPTED>:
3815:
3816: Attempted, and not yet graded.
1.69 bowersj2 3817:
1.51 bowersj2 3818: =back
3819:
3820: =cut
3821:
1.53 bowersj2 3822: sub NOT_ATTEMPTED { return 10; }
3823: sub INCORRECT { return 11; }
3824: sub INCORRECT_BY_OVERRIDE { return 12; }
3825: sub CORRECT { return 13; }
3826: sub CORRECT_BY_OVERRIDE { return 14; }
3827: sub EXCUSED { return 15; }
1.69 bowersj2 3828: sub ATTEMPTED { return 16; }
1.51 bowersj2 3829:
3830: sub getCompletionStatus {
3831: my $self = shift;
3832: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
3833:
1.108 bowersj2 3834: my $status = $self->queryRestoreHash('solved', shift);
1.51 bowersj2 3835:
3836: # Left as seperate if statements in case we ever do more with this
3837: if ($status eq 'correct_by_student') {return $self->CORRECT;}
3838: if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; }
3839: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
3840: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
3841: if ($status eq 'excused') {return $self->EXCUSED; }
1.69 bowersj2 3842: if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
1.51 bowersj2 3843: return $self->NOT_ATTEMPTED;
1.108 bowersj2 3844: }
3845:
3846: sub queryRestoreHash {
3847: my $self = shift;
3848: my $hashentry = shift;
3849: my $part = shift;
1.185 bowersj2 3850: $part = "0" if (!defined($part) || $part eq '');
1.108 bowersj2 3851: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
3852:
3853: $self->getReturnHash();
3854:
3855: return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry};
1.51 bowersj2 3856: }
3857:
3858: =pod
3859:
3860: B<Composite Status>
3861:
1.174 albertel 3862: Along with directly returning the date or completion status, the
3863: resource object includes a convenience function B<status>() that will
3864: combine the two status tidbits into one composite status that can
1.191 bowersj2 3865: represent the status of the resource as a whole. This method represents
3866: the concept of the thing we want to display to the user on the nav maps
3867: screen, which is a combination of completion and open status. The precise logic is
1.174 albertel 3868: documented in the comments of the status method. The following results
3869: may be returned, all available as methods on the resource object
1.185 bowersj2 3870: ($res->NETWORK_FAILURE): In addition to the return values that match
3871: the date or completion status, this function can return "ANSWER_SUBMITTED"
3872: if that problemstatus parameter value is set to No, suppressing the
3873: incorrect/correct feedback.
1.51 bowersj2 3874:
3875: =over 4
3876:
1.174 albertel 3877: =item * B<NETWORK_FAILURE>:
3878:
3879: The network has failed and the information is not available.
1.51 bowersj2 3880:
1.174 albertel 3881: =item * B<NOTHING_SET>:
1.53 bowersj2 3882:
1.174 albertel 3883: No dates have been set for this problem (part) at all. (Because only
3884: certain parts of a multi-part problem may be assigned, this can not be
3885: collapsed into "open later", as we do not know a given part will EVER
3886: be opened. For single part, this is the same as "OPEN_LATER".)
1.51 bowersj2 3887:
1.174 albertel 3888: =item * B<CORRECT>:
1.51 bowersj2 3889:
1.174 albertel 3890: For any reason at all, the part is considered correct.
1.54 bowersj2 3891:
1.174 albertel 3892: =item * B<EXCUSED>:
1.51 bowersj2 3893:
1.174 albertel 3894: For any reason at all, the problem is excused.
1.51 bowersj2 3895:
1.174 albertel 3896: =item * B<PAST_DUE_NO_ANSWER>:
1.51 bowersj2 3897:
1.174 albertel 3898: The problem is past due, not considered correct, and no answer date is
3899: set.
1.51 bowersj2 3900:
1.174 albertel 3901: =item * B<PAST_DUE_ANSWER_LATER>:
1.51 bowersj2 3902:
1.174 albertel 3903: The problem is past due, not considered correct, and an answer date in
3904: the future is set.
1.51 bowersj2 3905:
1.174 albertel 3906: =item * B<ANSWER_OPEN>:
3907:
3908: The problem is past due, not correct, and the answer is now available.
3909:
3910: =item * B<OPEN_LATER>:
3911:
3912: The problem is not yet open.
3913:
3914: =item * B<TRIES_LEFT>:
3915:
3916: The problem is open, has been tried, is not correct, but there are
3917: tries left.
3918:
3919: =item * B<INCORRECT>:
3920:
3921: The problem is open, and all tries have been used without getting the
3922: correct answer.
3923:
3924: =item * B<OPEN>:
3925:
3926: The item is open and not yet tried.
3927:
3928: =item * B<ATTEMPTED>:
3929:
3930: The problem has been attempted.
1.69 bowersj2 3931:
1.185 bowersj2 3932: =item * B<ANSWER_SUBMITTED>:
3933:
3934: An answer has been submitted, but the student should not see it.
3935:
1.51 bowersj2 3936: =back
3937:
3938: =cut
3939:
1.185 bowersj2 3940: sub TRIES_LEFT { return 20; }
3941: sub ANSWER_SUBMITTED { return 21; }
1.51 bowersj2 3942:
3943: sub status {
3944: my $self = shift;
3945: my $part = shift;
3946: if (!defined($part)) { $part = "0"; }
3947: my $completionStatus = $self->getCompletionStatus($part);
3948: my $dateStatus = $self->getDateStatus($part);
3949:
3950: # What we have is a two-dimensional matrix with 4 entries on one
3951: # dimension and 5 entries on the other, which we want to colorize,
1.54 bowersj2 3952: # plus network failure and "no date data at all".
1.51 bowersj2 3953:
1.222 bowersj2 3954: #if ($self->{RESOURCE_ERROR}) { return NETWORK_FAILURE; }
1.53 bowersj2 3955: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
1.51 bowersj2 3956:
1.236 bowersj2 3957: my $suppressFeedback = $self->problemstatus($part) eq 'no';
3958: # If there's an answer date and we're past it, don't
3959: # suppress the feedback; student should know
3960: if ($self->answerdate($part) && $self->answerdate($part) < time()) {
3961: $suppressFeedback = 0;
3962: }
1.185 bowersj2 3963:
1.51 bowersj2 3964: # There are a few whole rows we can dispose of:
1.53 bowersj2 3965: if ($completionStatus == CORRECT ||
3966: $completionStatus == CORRECT_BY_OVERRIDE ) {
1.185 bowersj2 3967: return $suppressFeedback? ANSWER_SUBMITTED : CORRECT;
1.69 bowersj2 3968: }
3969:
3970: if ($completionStatus == ATTEMPTED) {
3971: return ATTEMPTED;
1.53 bowersj2 3972: }
3973:
3974: # If it's EXCUSED, then return that no matter what
3975: if ($completionStatus == EXCUSED) {
3976: return EXCUSED;
1.51 bowersj2 3977: }
3978:
1.53 bowersj2 3979: if ($dateStatus == NOTHING_SET) {
3980: return NOTHING_SET;
1.51 bowersj2 3981: }
3982:
1.69 bowersj2 3983: # Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
3984: # by 4 matrix (date statuses).
1.51 bowersj2 3985:
1.54 bowersj2 3986: if ($dateStatus == PAST_DUE_ANSWER_LATER ||
1.59 bowersj2 3987: $dateStatus == PAST_DUE_NO_ANSWER ) {
1.54 bowersj2 3988: return $dateStatus;
1.51 bowersj2 3989: }
3990:
1.53 bowersj2 3991: if ($dateStatus == ANSWER_OPEN) {
3992: return ANSWER_OPEN;
1.51 bowersj2 3993: }
3994:
3995: # Now: (incorrect, incorrect_override, not_attempted) x
3996: # (open_later), (open)
3997:
1.53 bowersj2 3998: if ($dateStatus == OPEN_LATER) {
3999: return OPEN_LATER;
1.51 bowersj2 4000: }
4001:
4002: # If it's WRONG...
1.53 bowersj2 4003: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
1.51 bowersj2 4004: # and there are TRIES LEFT:
1.79 bowersj2 4005: if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) {
1.222 bowersj2 4006: return $suppressFeedback ? ANSWER_SUBMITTED : TRIES_LEFT;
1.51 bowersj2 4007: }
1.185 bowersj2 4008: return $suppressFeedback ? ANSWER_SUBMITTED : INCORRECT; # otherwise, return orange; student can't fix this
1.51 bowersj2 4009: }
4010:
4011: # Otherwise, it's untried and open
1.53 bowersj2 4012: return OPEN;
1.224 bowersj2 4013: }
4014:
4015: sub CLOSED { return 23; }
4016: sub ERROR { return 24; }
4017:
4018: =pod
4019:
4020: B<Simple Status>
4021:
4022: Convenience method B<simpleStatus> provides a "simple status" for the resource.
4023: "Simple status" corresponds to "which icon is shown on the
4024: Navmaps". There are six "simple" statuses:
4025:
4026: =over 4
4027:
4028: =item * B<CLOSED>: The problem is currently closed. (No icon shown.)
4029:
4030: =item * B<OPEN>: The problem is open and unattempted.
4031:
4032: =item * B<CORRECT>: The problem is correct for any reason.
4033:
4034: =item * B<INCORRECT>: The problem is incorrect and can still be
4035: completed successfully.
4036:
4037: =item * B<ATTEMPTED>: The problem has been attempted, but the student
4038: does not know if they are correct. (The ellipsis icon.)
4039:
4040: =item * B<ERROR>: There is an error retrieving information about this
4041: problem.
4042:
4043: =back
4044:
4045: =cut
4046:
4047: # This hash maps the composite status to this simple status, and
4048: # can be used directly, if you like
4049: my %compositeToSimple =
4050: (
4051: NETWORK_FAILURE() => ERROR,
4052: NOTHING_SET() => CLOSED,
4053: CORRECT() => CORRECT,
4054: EXCUSED() => CORRECT,
4055: PAST_DUE_NO_ANSWER() => INCORRECT,
4056: PAST_DUE_ANSWER_LATER() => INCORRECT,
4057: ANSWER_OPEN() => INCORRECT,
4058: OPEN_LATER() => CLOSED,
4059: TRIES_LEFT() => OPEN,
4060: INCORRECT() => INCORRECT,
4061: OPEN() => OPEN,
4062: ATTEMPTED() => ATTEMPTED,
4063: ANSWER_SUBMITTED() => ATTEMPTED
4064: );
4065:
4066: sub simpleStatus {
4067: my $self = shift;
4068: my $part = shift;
4069: my $status = $self->status($part);
4070: return $compositeToSimple{$status};
1.225 bowersj2 4071: }
4072:
4073: =pod
4074:
4075: B<simpleStatusCount> will return an array reference containing, in
4076: this order, the number of OPEN, CLOSED, CORRECT, INCORRECT, ATTEMPTED,
4077: and ERROR parts the given problem has.
4078:
4079: =cut
4080:
4081: # This maps the status to the slot we want to increment
4082: my %statusToSlotMap =
4083: (
4084: OPEN() => 0,
4085: CLOSED() => 1,
4086: CORRECT() => 2,
4087: INCORRECT() => 3,
4088: ATTEMPTED() => 4,
4089: ERROR() => 5
4090: );
4091:
4092: sub statusToSlot { return $statusToSlotMap{shift()}; }
4093:
4094: sub simpleStatusCount {
4095: my $self = shift;
4096:
4097: my @counts = (0, 0, 0, 0, 0, 0, 0);
4098: foreach my $part (@{$self->parts()}) {
4099: $counts[$statusToSlotMap{$self->simpleStatus($part)}]++;
4100: }
4101:
4102: return \@counts;
1.191 bowersj2 4103: }
4104:
4105: =pod
4106:
4107: B<Completable>
4108:
4109: The completable method represents the concept of I<whether the student can
4110: currently do the problem>. If the student can do the problem, which means
4111: that it is open, there are tries left, and if the problem is manually graded
4112: or the grade is suppressed via problemstatus, the student has not tried it
4113: yet, then the method returns 1. Otherwise, it returns 0, to indicate that
4114: either the student has tried it and there is no feedback, or that for
4115: some reason it is no longer completable (not open yet, successfully completed,
4116: out of tries, etc.). As an example, this is used as the filter for the
4117: "Uncompleted Homework" option for the nav maps.
4118:
4119: If this does not quite meet your needs, do not fiddle with it (unless you are
4120: fixing it to better match the student's conception of "completable" because
4121: it's broken somehow)... make a new method.
4122:
4123: =cut
4124:
4125: sub completable {
4126: my $self = shift;
4127: if (!$self->is_problem()) { return 0; }
4128: my $partCount = $self->countParts();
4129:
4130: foreach my $part (@{$self->parts()}) {
4131: if ($part eq '0' && $partCount != 1) { next; }
4132: my $status = $self->status($part);
4133: # "If any of the parts are open, or have tries left (implies open),
4134: # and it is not "attempted" (manually graded problem), it is
4135: # not "complete"
1.216 bowersj2 4136: if ($self->getCompletionStatus($part) == ATTEMPTED() ||
4137: $status == ANSWER_SUBMITTED() ) {
4138: # did this part already, as well as we can
4139: next;
4140: }
4141: if ($status == OPEN() || $status == TRIES_LEFT()) {
4142: return 1;
4143: }
1.191 bowersj2 4144: }
4145:
4146: # If all the parts were complete, so was this problem.
1.216 bowersj2 4147: return 0;
1.51 bowersj2 4148: }
4149:
4150: =pod
4151:
4152: =head2 Resource/Nav Map Navigation
4153:
4154: =over 4
4155:
1.174 albertel 4156: =item * B<getNext>():
4157:
4158: Retreive an array of the possible next resources after this
4159: one. Always returns an array, even in the one- or zero-element case.
4160:
4161: =item * B<getPrevious>():
1.85 bowersj2 4162:
1.174 albertel 4163: Retreive an array of the possible previous resources from this
4164: one. Always returns an array, even in the one- or zero-element case.
1.51 bowersj2 4165:
4166: =cut
4167:
4168: sub getNext {
4169: my $self = shift;
4170: my @branches;
4171: my $to = $self->to();
1.85 bowersj2 4172: foreach my $branch ( split(/,/, $to) ) {
1.51 bowersj2 4173: my $choice = $self->{NAV_MAP}->getById($branch);
4174: my $next = $choice->goesto();
4175: $next = $self->{NAV_MAP}->getById($next);
4176:
1.131 bowersj2 4177: push @branches, $next;
1.85 bowersj2 4178: }
4179: return \@branches;
4180: }
4181:
4182: sub getPrevious {
4183: my $self = shift;
4184: my @branches;
4185: my $from = $self->from();
4186: foreach my $branch ( split /,/, $from) {
4187: my $choice = $self->{NAV_MAP}->getById($branch);
4188: my $prev = $choice->comesfrom();
4189: $prev = $self->{NAV_MAP}->getById($prev);
4190:
1.131 bowersj2 4191: push @branches, $prev;
1.51 bowersj2 4192: }
4193: return \@branches;
1.131 bowersj2 4194: }
4195:
4196: sub browsePriv {
4197: my $self = shift;
4198: if (defined($self->{BROWSE_PRIV})) {
4199: return $self->{BROWSE_PRIV};
4200: }
4201:
4202: $self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre', $self->src());
1.51 bowersj2 4203: }
4204:
4205: =pod
1.2 www 4206:
1.51 bowersj2 4207: =back
1.2 www 4208:
1.51 bowersj2 4209: =cut
1.2 www 4210:
1.51 bowersj2 4211: 1;
1.2 www 4212:
1.51 bowersj2 4213: __END__
1.2 www 4214:
4215:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonnavmaps.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface