Annotation of loncom/interface/lonnavmaps.pm, revision 1.156
1.72 bowersj2 1:
1.2 www 2: # The LearningOnline Network with CAPA
3: # Navigate Maps Handler
1.1 www 4: #
1.156 ! bowersj2 5: # $Id: lonnavmaps.pm,v 1.155 2003/03/08 21:16:38 bowersj2 Exp $
1.20 albertel 6: #
7: # Copyright Michigan State University Board of Trustees
8: #
9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
10: #
11: # LON-CAPA is free software; you can redistribute it and/or modify
12: # it under the terms of the GNU General Public License as published by
13: # the Free Software Foundation; either version 2 of the License, or
14: # (at your option) any later version.
15: #
16: # LON-CAPA is distributed in the hope that it will be useful,
17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19: # GNU General Public License for more details.
20: #
21: # You should have received a copy of the GNU General Public License
22: # along with LON-CAPA; if not, write to the Free Software
23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24: #
25: # /home/httpd/html/adm/gpl.txt
26: #
27: # http://www.lon-capa.org/
28: #
1.2 www 29: # (Page Handler
1.1 www 30: #
1.2 www 31: # (TeX Content Handler
1.1 www 32: #
1.2 www 33: # 05/29/00,05/30 Gerd Kortemeyer)
34: # 08/30,08/31,09/06,09/14,09/15,09/16,09/19,09/20,09/21,09/23,
35: # 10/02,10/10,10/14,10/16,10/18,10/19,10/31,11/6,11/14,11/16 Gerd Kortemeyer)
1.1 www 36: #
1.17 www 37: # 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer
1.21 www 38: # YEAR=2002
39: # 1/1 Gerd Kortemeyer
1.105 bowersj2 40: # Oct-Nov Jeremy Bowers
1.153 bowersj2 41: # YEAR=2003
42: # Jeremy Bowers ... lots of days
1.2 www 43:
1.1 www 44: package Apache::lonnavmaps;
45:
46: use strict;
1.2 www 47: use Apache::Constants qw(:common :http);
1.18 albertel 48: use Apache::loncommon();
1.150 www 49: use Apache::lonmenu();
1.73 bowersj2 50: use POSIX qw (floor strftime);
1.2 www 51:
1.130 www 52: my %navmaphash;
53: my %parmhash;
54:
1.133 bowersj2 55: # symbolic constants
56: sub SYMB { return 1; }
57: sub URL { return 2; }
58: sub NOTHING { return 3; }
59:
60: # Some data
61:
1.140 bowersj2 62: my $resObj = "Apache::lonnavmaps::resource";
63:
1.135 bowersj2 64: # Keep these mappings in sync with lonquickgrades, which uses the colors
65: # instead of the icons.
66: my %statusIconMap =
1.140 bowersj2 67: ( $resObj->NETWORK_FAILURE => '',
68: $resObj->NOTHING_SET => '',
69: $resObj->CORRECT => 'navmap.correct.gif',
70: $resObj->EXCUSED => 'navmap.correct.gif',
71: $resObj->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif',
72: $resObj->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif',
73: $resObj->ANSWER_OPEN => 'navmap.wrong.gif',
74: $resObj->OPEN_LATER => '',
75: $resObj->TRIES_LEFT => 'navmap.open.gif',
76: $resObj->INCORRECT => 'navmap.wrong.gif',
77: $resObj->OPEN => 'navmap.open.gif',
78: $resObj->ATTEMPTED => 'navmap.open.gif' );
1.135 bowersj2 79:
80: my %iconAltTags =
81: ( 'navmap.correct.gif' => 'Correct',
82: 'navmap.wrong.gif' => 'Incorrect',
83: 'navmap.open.gif' => 'Open' );
1.133 bowersj2 84:
1.136 bowersj2 85: # Defines a status->color mapping, null string means don't color
86: my %colormap =
1.140 bowersj2 87: ( $resObj->NETWORK_FAILURE => '',
88: $resObj->CORRECT => '',
89: $resObj->EXCUSED => '#3333FF',
90: $resObj->PAST_DUE_ANSWER_LATER => '',
91: $resObj->PAST_DUE_NO_ANSWER => '',
92: $resObj->ANSWER_OPEN => '#006600',
93: $resObj->OPEN_LATER => '',
94: $resObj->TRIES_LEFT => '',
95: $resObj->INCORRECT => '',
96: $resObj->OPEN => '',
97: $resObj->NOTHING_SET => '' );
1.136 bowersj2 98: # And a special case in the nav map; what to do when the assignment
99: # is not yet done and due in less then 24 hours
100: my $hurryUpColor = "#FF0000";
101:
1.130 www 102: sub cleanup {
103: if (tied(%navmaphash)){
104: &Apache::lonnet::logthis('Cleanup navmaps: navmaphash');
105: unless (untie(%navmaphash)) {
106: &Apache::lonnet::logthis('Failed cleanup navmaps: navmaphash');
107: }
108: }
109: if (tied(%parmhash)){
110: &Apache::lonnet::logthis('Cleanup navmaps: parmhash');
111: unless (untie(%parmhash)) {
112: &Apache::lonnet::logthis('Failed cleanup navmaps: parmhash');
113: }
114: }
115: }
116:
1.1 www 117: sub handler {
1.99 bowersj2 118: my $r = shift;
1.118 bowersj2 119: real_handler($r);
120: }
121:
122: sub real_handler {
123: my $r = shift;
1.2 www 124:
1.51 bowersj2 125: # Handle header-only request
126: if ($r->header_only) {
127: if ($ENV{'browser.mathml'}) {
128: $r->content_type('text/xml');
129: } else {
130: $r->content_type('text/html');
131: }
132: $r->send_http_header;
133: return OK;
134: }
135:
136: # Send header, don't cache this page
137: if ($ENV{'browser.mathml'}) {
138: $r->content_type('text/xml');
139: } else {
140: $r->content_type('text/html');
141: }
142: &Apache::loncommon::no_cache($r);
143: $r->send_http_header;
144:
1.106 bowersj2 145: # Create the nav map
1.51 bowersj2 146: my $navmap = Apache::lonnavmaps::navmap->new(
147: $ENV{"request.course.fn"}.".db",
1.80 bowersj2 148: $ENV{"request.course.fn"}."_parms.db", 1, 1);
1.51 bowersj2 149:
1.55 bowersj2 150:
151: if (!defined($navmap)) {
152: my $requrl = $r->uri;
153: $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
154: return HTTP_NOT_ACCEPTABLE;
155: }
1.64 bowersj2 156:
1.111 bowersj2 157: $r->print("<html><head>\n");
1.150 www 158: $r->print("<title>Navigate Course Contents</title>");
159: # ------------------------------------------------------------ Get query string
160: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register']);
161: # ----------------------------------------------------- Force menu registration
162: my $addentries='';
163: if ($ENV{'form.register'}) {
164: $addentries=' onLoad="'.&Apache::lonmenu::loadevents().
165: '" onUnload="'.&Apache::lonmenu::unloadevents().'"';
166: $r->print(&Apache::lonmenu::registerurl(1));
167: }
1.111 bowersj2 168:
1.64 bowersj2 169: # Header
1.150 www 170: $r->print('</head>'.
171: &Apache::loncommon::bodytag('Navigate Course Contents','',
1.151 www 172: $addentries,'','',$ENV{'form.register'}));
1.64 bowersj2 173: $r->print('<script>window.focus();</script>');
1.101 bowersj2 174:
1.124 bowersj2 175: $r->rflush();
176:
177: # Now that we've displayed some stuff to the user, init the navmap
178: $navmap->init();
179:
1.55 bowersj2 180:
1.95 bowersj2 181: $r->print('<br> ');
182: $r->rflush();
183:
1.55 bowersj2 184: # Check that it's defined
185: if (!($navmap->courseMapDefined())) {
186: $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
187: '</body></html>');
188: return OK;
189: }
190:
1.155 bowersj2 191: # See if there's only one map in the top-level... if so,
192: # automatically display it
193: my $iterator = $navmap->getIterator(undef, undef, undef, 0);
194: my $depth = 1;
195: $iterator->next();
196: my $curRes = $iterator->next();
197: my $sequenceCount = 0;
198: my $sequenceId;
199: while ($depth > 0) {
200: if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
201: if ($curRes == $iterator->END_MAP()) { $depth--; }
202:
203: if (ref($curRes) && $curRes->is_sequence()) {
204: $sequenceCount++;
205: $sequenceId = $curRes->map_pc();
206: }
207:
208: $curRes = $iterator->next();
209: }
210:
211: if ($sequenceCount == 1) {
212: # The automatic iterator creation in the render call
213: # will pick this up.
214: $ENV{'form.filter'} = "$sequenceId";
215: }
216:
1.133 bowersj2 217: # renderer call
1.140 bowersj2 218: my $render = render({ 'cols' => [0,1,2,3],
219: 'url' => '/adm/navmaps',
1.153 bowersj2 220: 'suppressNavmap' => 1,
1.140 bowersj2 221: 'r' => $r});
1.133 bowersj2 222:
1.126 bowersj2 223: $navmap->untieHashes();
1.51 bowersj2 224:
1.128 bowersj2 225: $r->print("</body></html>");
1.134 bowersj2 226: $r->rflush();
1.59 bowersj2 227:
1.51 bowersj2 228: return OK;
229: }
230:
231: # Convenience functions: Returns a string that adds or subtracts
232: # the second argument from the first hash, appropriate for the
233: # query string that determines which folders to recurse on
234: sub addToFilter {
235: my $hashIn = shift;
236: my $addition = shift;
237: my %hash = %$hashIn;
238: $hash{$addition} = 1;
239:
240: return join (",", keys(%hash));
241: }
242:
243: sub removeFromFilter {
244: my $hashIn = shift;
245: my $subtraction = shift;
246: my %hash = %$hashIn;
247:
248: delete $hash{$subtraction};
249: return join(",", keys(%hash));
250: }
251:
252: # Convenience function: Given a stack returned from getStack on the iterator,
253: # return the correct src() value.
254: # Later, this should add an anchor when we start putting anchors in pages.
255: sub getLinkForResource {
256: my $stack = shift;
257: my $res;
258:
259: # Check to see if there are any pages in the stack
260: foreach $res (@$stack) {
261: if (defined($res) && $res->is_page()) {
262: return $res->src();
263: }
264: }
265:
266: # Failing that, return the src of the last resource that is defined
267: # (when we first recurse on a map, it puts an undefined resource
268: # on the bottom because $self->{HERE} isn't defined yet, and we
269: # want the src for the map anyhow)
270: foreach (@$stack) {
271: if (defined($_)) { $res = $_; }
272: }
273:
274: return $res->src();
275: }
276:
1.53 bowersj2 277: # Convenience function: This seperates the logic of how to create
278: # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
279: # etc.) into a seperate function. It takes a resource object as the
280: # first parameter, and the part number of the resource as the second.
281: # It's basically a big switch statement on the status of the resource.
282:
283: sub getDescription {
284: my $res = shift;
285: my $part = shift;
1.69 bowersj2 286: my $status = $res->status($part);
1.53 bowersj2 287:
288: if ($status == $res->NETWORK_FAILURE) { return ""; }
289: if ($status == $res->NOTHING_SET) {
290: return "Not currently assigned.";
291: }
292: if ($status == $res->OPEN_LATER) {
1.73 bowersj2 293: return "Open " . timeToHumanString($res->opendate($part));
1.53 bowersj2 294: }
295: if ($status == $res->OPEN) {
1.79 bowersj2 296: if ($res->duedate($part)) {
1.73 bowersj2 297: return "Due " . timeToHumanString($res->duedate($part));
1.66 bowersj2 298: } else {
299: return "Open, no due date";
300: }
1.53 bowersj2 301: }
1.54 bowersj2 302: if ($status == $res->PAST_DUE_ANSWER_LATER) {
1.73 bowersj2 303: return "Answer open " . timeToHumanString($res->answerdate($part));
1.54 bowersj2 304: }
305: if ($status == $res->PAST_DUE_NO_ANSWER) {
1.73 bowersj2 306: return "Was due " . timeToHumanString($res->duedate($part));
1.53 bowersj2 307: }
308: if ($status == $res->ANSWER_OPEN) {
309: return "Answer available";
310: }
1.59 bowersj2 311: if ($status == $res->EXCUSED) {
1.66 bowersj2 312: return "Excused by instructor";
1.59 bowersj2 313: }
1.69 bowersj2 314: if ($status == $res->ATTEMPTED) {
315: return "Not yet graded.";
316: }
1.59 bowersj2 317: if ($status == $res->TRIES_LEFT) {
1.79 bowersj2 318: my $tries = $res->tries($part);
319: my $maxtries = $res->maxtries($part);
320: my $triesString = "";
321: if ($tries && $maxtries) {
322: $triesString = "<font size=\"-1\"><i>($tries of $maxtries tries used)</i></font>";
323: if ($maxtries > 1 && $maxtries - $tries == 1) {
324: $triesString = "<b>$triesString</b>";
325: }
326: }
1.66 bowersj2 327: if ($res->duedate()) {
1.73 bowersj2 328: return "Due " . timeToHumanString($res->duedate($part)) .
1.66 bowersj2 329: " $triesString";
330: } else {
331: return "No due date $triesString";
332: }
1.59 bowersj2 333: }
1.53 bowersj2 334: }
335:
1.115 bowersj2 336: # Convenience function, so others can use it: Is the problem due in less then
337: # 24 hours, and still can be done?
338:
339: sub dueInLessThen24Hours {
340: my $res = shift;
341: my $part = shift;
342: my $status = $res->status($part);
343:
344: return ($status == $res->OPEN() || $status == $res->ATTEMPTED() ||
345: $status == $res->TRIES_LEFT()) &&
346: $res->duedate() && $res->duedate() < time()+(24*60*60) &&
347: $res->duedate() > time();
348: }
349:
350: # Convenience function, so others can use it: Is there only one try remaining for the
351: # part, with more then one try to begin with, not due yet and still can be done?
352: sub lastTry {
353: my $res = shift;
354: my $part = shift;
355:
356: my $tries = $res->tries($part);
357: my $maxtries = $res->maxtries($part);
358: return $tries && $maxtries && $maxtries > 1 &&
359: $maxtries - $tries == 1 && $res->duedate() &&
360: $res->duedate() > time();
361: }
362:
1.101 bowersj2 363: # This puts a human-readable name on the ENV variable.
1.68 bowersj2 364: sub advancedUser {
365: return $ENV{'user.adv'};
366: }
367:
1.73 bowersj2 368:
369: # timeToHumanString takes a time number and converts it to a
370: # human-readable representation, meant to be used in the following
371: # manner:
372: # print "Due $timestring"
373: # print "Open $timestring"
374: # print "Answer available $timestring"
375: # Very, very, very, VERY English-only... goodness help a localizer on
376: # this func...
1.53 bowersj2 377: sub timeToHumanString {
1.58 albertel 378: my ($time) = @_;
379: # zero, '0' and blank are bad times
1.73 bowersj2 380: if (!$time) {
381: return 'never';
382: }
383:
384: my $now = time();
385:
386: my @time = localtime($time);
387: my @now = localtime($now);
388:
389: # Positive = future
390: my $delta = $time - $now;
391:
392: my $minute = 60;
393: my $hour = 60 * $minute;
394: my $day = 24 * $hour;
395: my $week = 7 * $day;
396: my $inPast = 0;
397:
398: # Logic in comments:
399: # Is it now? (extremely unlikely)
400: if ( $delta == 0 ) {
401: return "this instant";
402: }
403:
404: if ($delta < 0) {
405: $inPast = 1;
406: $delta = -$delta;
407: }
408:
409: if ( $delta > 0 ) {
1.101 bowersj2 410:
1.73 bowersj2 411: my $tense = $inPast ? " ago" : "";
412: my $prefix = $inPast ? "" : "in ";
1.101 bowersj2 413:
414: # Less then a minute
1.73 bowersj2 415: if ( $delta < $minute ) {
416: if ($delta == 1) { return "${prefix}1 second$tense"; }
417: return "$prefix$delta seconds$tense";
418: }
419:
1.101 bowersj2 420: # Less then an hour
1.73 bowersj2 421: if ( $delta < $hour ) {
422: # If so, use minutes
423: my $minutes = floor($delta / 60);
424: if ($minutes == 1) { return "${prefix}1 minute$tense"; }
425: return "$prefix$minutes minutes$tense";
426: }
427:
428: # Is it less then 24 hours away? If so,
429: # display hours + minutes
430: if ( $delta < $hour * 24) {
431: my $hours = floor($delta / $hour);
432: my $minutes = floor(($delta % $hour) / $minute);
433: my $hourString = "$hours hours";
434: my $minuteString = ", $minutes minutes";
435: if ($hours == 1) {
436: $hourString = "1 hour";
437: }
438: if ($minutes == 1) {
439: $minuteString = ", 1 minute";
440: }
441: if ($minutes == 0) {
442: $minuteString = "";
443: }
444: return "$prefix$hourString$minuteString$tense";
445: }
446:
447: # Less then 5 days away, display day of the week and
448: # HH:MM
449: if ( $delta < $day * 5 ) {
1.85 bowersj2 450: my $timeStr = strftime("%A, %b %e at %I:%M %P", localtime($time));
1.73 bowersj2 451: $timeStr =~ s/12:00 am/midnight/;
452: $timeStr =~ s/12:00 pm/noon/;
453: return ($inPast ? "last " : "next ") .
454: $timeStr;
455: }
456:
457: # Is it this year?
458: if ( $time[5] == $now[5]) {
459: # Return on Month Day, HH:MM meridian
460: my $timeStr = strftime("on %A, %b %e at %I:%M %P", localtime($time));
461: $timeStr =~ s/12:00 am/midnight/;
462: $timeStr =~ s/12:00 pm/noon/;
463: return $timeStr;
464: }
465:
466: # Not this year, so show the year
467: my $timeStr = strftime("on %A, %b %e %G at %I:%M %P", localtime($time));
468: $timeStr =~ s/12:00 am/midnight/;
469: $timeStr =~ s/12:00 pm/noon/;
470: return $timeStr;
1.58 albertel 471: }
1.53 bowersj2 472: }
473:
1.51 bowersj2 474:
1.133 bowersj2 475: =pod
476:
477: =head1 navmap renderer
478:
479: The navmaprenderer package provides a sophisticated rendering of the standard navigation maps interface into HTML. The provided nav map handler is actually just a glorified call to this.
480:
481: Because of the large number of parameters this function presents, instead of passing it arguments as is normal, pass it in an anonymous hash with the given options. This is because there is no obvious order you may wish to override these in and a hash is easier to read and understand then "undef, undef, undef, 1, undef, undef, renderButton, undef, 0" when you mostly want default behaviors.
482:
483: The package provides a function called 'render', called as Apache::lonnavmaps::renderer->render({}).
1.51 bowersj2 484:
1.133 bowersj2 485: =head2 Overview of Columns
1.51 bowersj2 486:
1.133 bowersj2 487: The renderer will build an HTML table for the navmap and return it. The table is consists of several columns, and a row for each resource (or possibly each part). You tell the renderer how many columns to create and what to place in each column, optionally using one or more of the preparent columns, and the renderer will assemble the table.
1.51 bowersj2 488:
1.133 bowersj2 489: Any additional generally useful column types should be placed in the renderer code here, so anybody can use it anywhere else. Any code specific to the current application (such as the addition of <input> elements in a column) should be placed in the code of the thing using the renderer.
1.51 bowersj2 490:
1.133 bowersj2 491: At the core of the renderer is the array reference COLS (see Example section below for how to pass this correctly). The COLS array will consist of entries of one of two types of things: Either an integer representing one of the pre-packaged column types, or a sub reference that takes a resource reference, a part number, and a reference to the argument hash passed to the renderer, and returns a string that will be inserted into the HTML representation as it.
1.51 bowersj2 492:
1.133 bowersj2 493: The pre-packaged column names are refered to by constants in the Apache::lonnavmaps::renderer namespace. The following currently exist:
1.51 bowersj2 494:
1.133 bowersj2 495: =over 4
1.51 bowersj2 496:
1.133 bowersj2 497: =item * B<resource>: The general info about the resource: Link, icon for the type, etc. The first column in the standard nav map display. This column also accepts the following parameter in the renderer hash:
1.51 bowersj2 498:
499: =over 4
500:
1.133 bowersj2 501: =item * B<resource_nolink>: If true, the resource will not be linked. Default: false, resource will have links.
502:
503: =item * B<resource_part_count>: If true (default), the resource will show a part count if the full part list is not displayed. If false, the resource will never show a part count.
504:
1.144 bowersj2 505: =item * B<resource_no_folder_link>: If true, the resource's folder will not be clickable to open or close it. Default is false.
506:
1.133 bowersj2 507: =back
1.51 bowersj2 508:
1.133 bowersj2 509: =item B<communication_status>: Whether there is discussion on the resource, email for the user, or (lumped in here) perl errors in the execution of the problem. This is the second column in the main nav map.
1.51 bowersj2 510:
1.133 bowersj2 511: =item B<quick_status>: An icon for the status of a problem, with four possible states: Correct, incorrect, open, or none (not open yet, not a problem). The third column of the standard navmap.
1.51 bowersj2 512:
1.133 bowersj2 513: =item B<long_status>: A text readout of the details of the current status of the problem, such as "Due in 22 hours". The fourth column of the standard navmap.
1.51 bowersj2 514:
1.133 bowersj2 515: =back
1.51 bowersj2 516:
1.133 bowersj2 517: If you add any others please be sure to document them here.
1.51 bowersj2 518:
1.133 bowersj2 519: An example of a column renderer that will show the ID number of a resource, along with the part name if any:
1.51 bowersj2 520:
1.133 bowersj2 521: sub {
522: my ($resource, $part, $params) = @_;
523: if ($part) { return '<td>' . $resource->{ID} . ' ' . $part . '</td>'; }
524: return '<td>' . $resource->{ID} . '</td>';
525: }
1.51 bowersj2 526:
1.133 bowersj2 527: Note these functions are responsible for the TD tags, which allow them to override vertical and horizontal alignment, etc.
1.130 www 528:
1.133 bowersj2 529: =head2 Parameters
1.115 bowersj2 530:
1.140 bowersj2 531: Most of these parameters are only useful if you are *not* using the folder interface (i.e., the default first column), which is probably the common case. If you are using this interface, then you should be able to get away with just using 'cols' (to specify the columns shown), 'url' (necessary for the folders to link to the current screen correctly), and possibly 'queryString' if your app calls for it. In that case, maintaining the state of the folders will be done automatically.
532:
1.133 bowersj2 533: =over 4
1.51 bowersj2 534:
1.144 bowersj2 535: =item * B<iterator>: A reference to a fresh ::iterator to use from the navmaps. The rendering will reflect the options passed to the iterator, so you can use that to just render a certain part of the course, if you like. If one is not passed, the renderer will attempt to construct one from ENV{'form.filter'} and ENV{'form.condition'} information, plus the 'iterator_map' parameter if any.
536:
537: =item * B<iterator_map>: If you are letting the renderer do the iterator handling, you can instruct the renderer to render only a particular map by passing it the source of the map you want to process, like '/res/103/jerf/navmap.course.sequence'.
1.140 bowersj2 538:
539: =item * B<navmap>: A reference to a navmap, used only if an iterator is not passed in. If this is necessary to make an iterator but it is not passed in, a new one will be constructed based on ENV info. This is useful to do basic error checking before passing it off to render.
1.92 bowersj2 540:
1.133 bowersj2 541: =item * B<cols>: An array reference
1.92 bowersj2 542:
1.133 bowersj2 543: =item * B<showParts>: A flag. If yes (default), a line for the resource itself, and a line for each part will be displayed. If not, only one line for each resource will be displayed.
1.51 bowersj2 544:
1.133 bowersj2 545: =item * B<condenseParts>: A flag. If yes (default), if all parts of the problem have the same status and that status is Nothing Set, Correct, or Network Failure, then only one line will be displayed for that resource anyhow. If no, all parts will always be displayed. If showParts is 0, this is ignored.
1.55 bowersj2 546:
1.140 bowersj2 547: =item * B<jumpCount>: A string identifying the URL to place the anchor 'curloc' at. Default to no anchor at all. It is the responsibility of the renderer user to ensure that the #curloc is in the URL. By default, determined through the use of the ENV{} 'jump' and 'jumpType' information.
1.84 bowersj2 548:
1.140 bowersj2 549: =item * B<hereURL>: A URL identifying where to place the 'here' marker. By default, will pull this from the ENV{'form.here*'} info.
1.51 bowersj2 550:
1.140 bowersj2 551: =item * B<hereSymb>: A Symb identifying where to place the 'here' marker. Default same as hereURL.
1.115 bowersj2 552:
1.133 bowersj2 553: =item * B<indentString>: A string identifying the indentation string to use. By default, this is a 25 pixel whitespace image with no alt text.
1.55 bowersj2 554:
1.133 bowersj2 555: =item * B<queryString>: A string which will be prepended to the query string used when the folders are opened or closed.
1.51 bowersj2 556:
1.133 bowersj2 557: =item * B<url>: The url the folders will link to, which should be the current page. Required if the resource info column is shown.
1.51 bowersj2 558:
1.140 bowersj2 559: =item * B<currentJumpIndex>: Describes the currently-open row number to cause the browser to jump to, because the user just opened that folder. By default, pulled from the Jump information in the ENV{'form.*'}.
1.139 bowersj2 560:
561: =item * B<r>: The standard Apache response object. If you pass this to the render, it will use it to flush the table every 20 rows and handle the rendering itself.
562:
1.140 bowersj2 563: =item * B<printKey>: If true, print the key that appears on the top of the standard navmaps. Default is false.
564:
565: =item * B<printCloseAll>: If true, print the "Close all folders" or "open all folders" links. Default is true.
566:
1.153 bowersj2 567: =item * B<filterFunc>: A function that takes the resource object as its only parameter and returns a true or false value. If true, the resource is displayed. If false, it is simply skipped in the display. By default, all resources are shown.
568:
569: =item * B<suppressNavmaps>: If true, will not display Navigate Content resources. Default to false.
1.143 bowersj2 570:
1.133 bowersj2 571: =back
1.51 bowersj2 572:
1.133 bowersj2 573: =head2 Additional Info
1.51 bowersj2 574:
1.133 bowersj2 575: In addition to the parameters you can pass to the renderer, which will be passed through unchange to the column renderers, the renderer will generate the following information which your renderer may find useful:
1.59 bowersj2 576:
1.145 bowersj2 577: If you want to know how many rows were printed, the 'counter' element of the hash passed into the render function will contain the count. You may want to check whether any resources were printed at all.
578:
1.133 bowersj2 579: =over 4
1.59 bowersj2 580:
1.133 bowersj2 581: =back
1.59 bowersj2 582:
1.133 bowersj2 583: =cut
1.59 bowersj2 584:
1.133 bowersj2 585: sub resource { return 0; }
586: sub communication_status { return 1; }
587: sub quick_status { return 2; }
588: sub long_status { return 3; }
1.124 bowersj2 589:
1.133 bowersj2 590: # Data for render_resource
1.51 bowersj2 591:
1.133 bowersj2 592: sub render_resource {
593: my ($resource, $part, $params) = @_;
1.51 bowersj2 594:
1.133 bowersj2 595: my $nonLinkedText = ''; # stuff after resource title not in link
1.51 bowersj2 596:
1.134 bowersj2 597: my $link = $params->{"resourceLink"};
598: my $src = $resource->src();
599: my $it = $params->{"iterator"};
1.133 bowersj2 600: my $filter = $it->{FILTER};
601:
602: my $title = $resource->compTitle();
603: if ($src =~ /^\/uploaded\//) {
604: $nonLinkedText=$title;
605: $title = '';
606: }
607: my $partLabel = "";
608: my $newBranchText = "";
609:
610: # If this is a new branch, label it so
611: if ($params->{'isNewBranch'}) {
612: $newBranchText = "<img src='/adm/lonIcons/branch.gif' border='0' />";
1.51 bowersj2 613: }
614:
1.133 bowersj2 615: # links to open and close the folder
616: my $linkopen = "<a href='$link'>";
617: my $linkclose = "</a>";
1.51 bowersj2 618:
1.133 bowersj2 619: # Default icon: HTML page
620: my $icon = "<img src='/adm/lonIcons/html.gif' alt='' border='0' />";
621:
622: if ($resource->is_problem()) {
1.156 ! bowersj2 623: if ($part eq "" || $params->{'condensed'}) {
1.133 bowersj2 624: $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border="0" />';
625: } else {
626: $icon = $params->{'indentString'};
627: }
628: }
1.51 bowersj2 629:
1.133 bowersj2 630: # Display the correct map icon to open or shut map
631: if ($resource->is_map()) {
632: my $mapId = $resource->map_pc();
633: my $nowOpen = !defined($filter->{$mapId});
634: if ($it->{CONDITION}) {
635: $nowOpen = !$nowOpen;
636: }
1.144 bowersj2 637:
638: if (!$params->{'resource_no_folder_link'}) {
639: $icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') . '.gif';
640: $icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />";
641:
642: $linkopen = "<a href='" . $params->{'url'} . '?' .
643: $params->{'queryString'} . '&filter=';
644: $linkopen .= ($nowOpen xor $it->{CONDITION}) ?
645: addToFilter($filter, $mapId) :
646: removeFromFilter($filter, $mapId);
647: $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
648: . $params->{'hereType'} . '&here=' .
649: &Apache::lonnet::escape($params->{'here'}) .
650: '&jumpType=' . SYMB() . '&jump=' .
651: &Apache::lonnet::escape($resource->symb()) .
652: "&folderManip=1'>";
653: } else {
654: # Don't allow users to manipulate folder
655: $icon = 'navmap.folder.' . ($nowOpen ? 'closed' : 'open') .
656: '.nomanip.gif';
657: $icon = "<img src='/adm/lonIcons/$icon' alt='' border='0' />";
658:
659: $linkopen = "";
660: $linkclose = "";
661: }
1.133 bowersj2 662: }
1.51 bowersj2 663:
1.133 bowersj2 664: if ($resource->randomout()) {
665: $nonLinkedText .= ' <i>(hidden)</i> ';
666: }
667:
668: # We're done preparing and finally ready to start the rendering
669: my $result = "<td align='left' valign='center'>";
1.140 bowersj2 670:
671: my $indentLevel = $params->{'indentLevel'};
672: if ($newBranchText) { $indentLevel--; }
673:
1.133 bowersj2 674: # print indentation
1.140 bowersj2 675: for (my $i = 0; $i < $indentLevel; $i++) {
1.133 bowersj2 676: $result .= $params->{'indentString'};
1.84 bowersj2 677: }
678:
1.133 bowersj2 679: # Decide what to display
680: $result .= "$newBranchText$linkopen$icon$linkclose";
681:
682: my $curMarkerBegin = '';
683: my $curMarkerEnd = '';
1.51 bowersj2 684:
1.133 bowersj2 685: # Is this the current resource?
686: if (!$params->{'displayedHereMarker'} &&
687: (($params->{'hereType'} == SYMB() &&
688: $resource->symb() eq $params->{'here'}) ||
689: ($params->{'hereType'} == URL() &&
690: $resource->src() eq $params->{'here'}))) {
691: $curMarkerBegin = '<font color="red" size="+2">> </font>';
692: $curMarkerEnd = '<font color="red" size="+2"><</font>';
1.51 bowersj2 693: }
694:
1.156 ! bowersj2 695: if ($resource->is_problem() && $part ne "" &&
1.133 bowersj2 696: !$params->{'condensed'}) {
697: $partLabel = " (Part $part)";
698: $title = "";
1.51 bowersj2 699: }
700:
1.133 bowersj2 701: if ($params->{'multipart'} && $params->{'condensed'}) {
702: $nonLinkedText .= ' (' . $resource->countParts() . ' parts)';
1.51 bowersj2 703: }
704:
1.144 bowersj2 705: if (!$params->{'resource_nolink'}) {
706: $result .= " $curMarkerBegin<a href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>";
707: } else {
708: $result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>";
709: }
1.51 bowersj2 710:
1.133 bowersj2 711: return $result;
712: }
1.51 bowersj2 713:
1.133 bowersj2 714: sub render_communication_status {
715: my ($resource, $part, $params) = @_;
1.134 bowersj2 716: my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = "";
717:
718: my $link = $params->{"resourceLink"};
719: my $linkopen = "<a href='$link'>";
720: my $linkclose = "</a>";
721:
722: if ($resource->hasDiscussion()) {
723: $discussionHTML = $linkopen .
724: '<img border="0" src="/adm/lonMisc/chat.gif" />' .
725: $linkclose;
726: }
727:
728: if ($resource->getFeedback()) {
729: my $feedback = $resource->getFeedback();
730: foreach (split(/\,/, $feedback)) {
731: if ($_) {
732: $feedbackHTML .= ' <a href="/adm/email?display='
733: . &Apache::lonnet::escape($_) . '">'
734: . '<img src="/adm/lonMisc/feedback.gif" '
735: . 'border="0" /></a>';
736: }
737: }
738: }
739:
740: if ($resource->getErrors()) {
741: my $errors = $resource->getErrors();
742: foreach (split(/,/, $errors)) {
743: if ($_) {
744: $errorHTML .= ' <a href="/adm/email?display='
745: . &Apache::lonnet::escape($_) . '">'
746: . '<img src="/adm/lonMisc/bomb.gif" '
747: . 'border="0" /></a>';
748: }
749: }
750: }
751:
752: return "<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML </td>";
753:
1.133 bowersj2 754: }
755: sub render_quick_status {
756: my ($resource, $part, $params) = @_;
1.135 bowersj2 757: my $result = "";
758: my $firstDisplayed = !$params->{'condensed'} &&
759: $params->{'multipart'} && $part eq "0";
760:
761: my $link = $params->{"resourceLink"};
762: my $linkopen = "<a href='$link'>";
763: my $linkclose = "</a>";
764:
765: if ($resource->is_problem() &&
766: !$firstDisplayed) {
767: my $icon = $statusIconMap{$resource->status($part)};
768: my $alt = $iconAltTags{$icon};
769: if ($icon) {
770: $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";
771: } else {
772: $result .= "<td width='30'> </td>\n";
773: }
774: } else { # not problem, no icon
775: $result .= "<td width='30'> </td>\n";
776: }
777:
778: return $result;
1.133 bowersj2 779: }
780: sub render_long_status {
781: my ($resource, $part, $params) = @_;
1.136 bowersj2 782: my $result = "<td align='right' valign='center'>\n";
783: my $firstDisplayed = !$params->{'condensed'} &&
784: $params->{'multipart'} && $part eq "0";
785:
786: my $color;
787: if ($resource->is_problem()) {
788: $color = $colormap{$resource->status};
789:
790: if (dueInLessThen24Hours($resource, $part) ||
791: lastTry($resource, $part)) {
792: $color = $hurryUpColor;
793: }
794: }
795:
796: if ($resource->kind() eq "res" &&
797: $resource->is_problem() &&
798: !$firstDisplayed) {
799: if ($color) {$result .= "<font color=\"$color\"><b>"; }
800: $result .= getDescription($resource, $part);
801: if ($color) {$result .= "</b></font>"; }
802: }
803: if ($resource->is_map() && advancedUser() && $resource->randompick()) {
804: $result .= '(randomly select ' . $resource->randompick() .')';
805: }
806:
807: $result .= " </td>\n";
808:
809: return $result;
1.51 bowersj2 810: }
811:
1.133 bowersj2 812: my @preparedColumns = (\&render_resource, \&render_communication_status,
813: \&render_quick_status, \&render_long_status);
1.132 bowersj2 814:
815: sub setDefault {
816: my ($val, $default) = @_;
817: if (!defined($val)) { return $default; }
818: return $val;
819: }
820:
821: sub render {
822: my $args = shift;
1.140 bowersj2 823: &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
824: my $result = '';
825:
1.132 bowersj2 826: # Configure the renderer.
827: my $cols = $args->{'cols'};
828: if (!defined($cols)) {
829: # no columns, no nav maps.
830: return '';
831: }
1.140 bowersj2 832: my $mustCloseNavMap = 0;
833: my $navmap;
834: if (defined($args->{'navmap'})) {
835: $navmap = $args->{'navmap'};
836: }
837:
838: my $queryString = $args->{'queryString'};
839: my $jumpToURL = $args->{'jumpToURL'};
840: my $jumpToSymb = $args->{'jumpToSymb'};
841: my $jumpType;
842: my $hereURL = $args->{'hereURL'};
843: my $hereSymb = $args->{'hereSymb'};
844: my $hereType;
845: my $here;
846: my $jump;
847: my $currentJumpIndex = setDefault($args->{'currentJumpIndex'}, 0);
1.153 bowersj2 848: my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0);
1.140 bowersj2 849: my $currentJumpDelta = 2; # change this to change how many resources are displayed
850: # before the current resource when using #current
851:
852: # If we were passed 'here' information, we are not rendering
853: # after a folder manipulation, and we were not passed an
854: # iterator, make sure we open the folders to show the "here"
855: # marker
856: my $filterHash = {};
857: # Figure out what we're not displaying
858: foreach (split(/\,/, $ENV{"form.filter"})) {
859: if ($_) {
860: $filterHash->{$_} = "1";
861: }
862: }
863:
864: my $condition = 0;
865: if ($ENV{'form.condition'}) {
866: $condition = 1;
867: }
868:
869: if (!$ENV{'form.folderManip'} && !defined($args->{'iterator'})) {
870: # Step 1: Check to see if we have a navmap
871: if (!defined($navmap)) {
872: $navmap = Apache::lonnavmaps::navmap->new(
873: $ENV{"request.course.fn"}.".db",
874: $ENV{"request.course.fn"}."_parms.db", 1, 1);
875: $mustCloseNavMap = 1;
876: }
877: $navmap->init();
878:
879: # Step two: Locate what kind of here marker is necessary
880: # Determine where the "here" marker is and where the screen jumps to.
881:
882: # We're coming from the remote. We have either a url, a symb, or nothing,
883: # and we need to figure out what.
884: # Preference: Symb
885:
886: if ($ENV{'form.symb'}) {
887: $hereType = $jumpType = SYMB();
888: $here = $jump = $ENV{'form.symb'};
889: } elsif ($ENV{'form.postdata'}) {
890: # couldn't find a symb, is there a URL?
891: my $currenturl = $ENV{'form.postdata'};
892: $currenturl=~s/^http\:\/\///;
893: $currenturl=~s/^[^\/]+//;
894:
895: $hereType = $jumpType = URL;
896: $here = $jump = $currenturl;
897: } else {
898: # Nothing
899: $hereType = $jumpType = NOTHING();
900: }
901: # Step three: Ensure the folders are open
902: my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
903: my $depth = 1;
904: $mapIterator->next(); # discard the first BEGIN_MAP
905: my $curRes = $mapIterator->next();
906: my $counter = 0;
907: my $found = 0;
908:
909: # We only need to do this if we need to open the maps to show the
910: # current position. This will change the counter so we can't count
911: # for the jump marker with this loop.
912: while ($depth > 0 && !$found) {
913: if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
914: if ($curRes == $mapIterator->END_MAP()) { $depth--; }
915:
916: if (ref($curRes) &&
917: ($hereType == SYMB() && $curRes->symb() eq $here) ||
918: (ref($curRes) && $hereType == URL() && $curRes->src() eq $here)) {
919: my $mapStack = $mapIterator->getStack();
920:
921: # Ensure the parent maps are open
922: for my $map (@{$mapStack}) {
923: if ($condition) {
924: undef $filterHash->{$map->map_pc()};
925: } else {
926: $filterHash->{$map->map_pc()} = 1;
927: }
928: }
929: $found = 1;
930: }
931:
932: $curRes = $mapIterator->next();
933: }
934:
935: # Since we changed the folders, (re-)locate the jump point, if any
936: $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
937: $depth = 1;
938: $mapIterator->next();
939: $curRes = $mapIterator->next();
940: my $foundJump = 0;
941:
942: while ($depth > 0 && !$foundJump) {
943: if ($curRes == $mapIterator->BEGIN_MAP()) { $depth++; }
944: if ($curRes == $mapIterator->END_MAP()) { $depth--; }
945: if (ref($curRes)) { $counter++; }
946:
947: if (ref($curRes) &&
948: (($jumpType == SYMB() && $curRes->symb() eq $jump) ||
949: ($jumpType == URL() && $curRes->src() eq $jump))) {
950:
951: # This is why we have to use the main iterator instead of the
952: # potentially faster DFS: The count has to be the same, so
953: # the order has to be the same, which DFS won't give us.
954: $currentJumpIndex = $counter;
955: $foundJump = 1;
956: }
957:
958: $curRes = $mapIterator->next();
959: }
960:
961: }
962: if ( !defined($args->{'iterator'}) && $ENV{'form.folderManip'} ) { # we came from a user's manipulation of the nav page
963: # If this is a click on a folder or something, we want to preserve the "here"
964: # from the querystring, and get the new "jump" marker
965: $hereType = $ENV{'form.hereType'};
966: $here = $ENV{'form.here'};
967: $jumpType = $ENV{'form.jumpType'} || NOTHING();
968: $jump = $ENV{'form.jump'};
969: }
970:
1.132 bowersj2 971: my $it = $args->{'iterator'};
972: if (!defined($it)) {
1.140 bowersj2 973: # Construct a default iterator based on $ENV{'form.'} information
974:
975: # Step 1: Check to see if we have a navmap
976: if (!defined($navmap)) {
977: $navmap = Apache::lonnavmaps::navmap->new(
978: $ENV{"request.course.fn"}.".db",
979: $ENV{"request.course.fn"}."_parms.db", 1, 1);
980: $mustCloseNavMap = 1;
981: }
982: # Paranoia: Make sure it's ready
983: $navmap->init();
984:
1.144 bowersj2 985: # See if we're being passed a specific map
986: if ($args->{'iterator_map'}) {
987: my $map = $args->{'iterator_map'};
1.145 bowersj2 988: $map = $navmap->getResourceByUrl($map);
1.144 bowersj2 989: my $firstResource = $map->map_start();
990: my $finishResource = $map->map_finish();
991:
992: $args->{'iterator'} = $it = $navmap->getIterator($firstResource, $finishResource, $filterHash, $condition);
993: } else {
994: $args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition);
995: }
1.132 bowersj2 996: }
997:
998: my $showParts = setDefault($args->{'showParts'}, 1);
999: my $condenseParts = setDefault($args->{'condenseParts'}, 1);
1.139 bowersj2 1000: # keeps track of when the current resource is found,
1001: # so we can back up a few and put the anchor above the
1002: # current resource
1003: my $r = $args->{'r'};
1.140 bowersj2 1004: my $printKey = $args->{'printKey'};
1005: my $printCloseAll = $args->{'printCloseAll'};
1006: if (!defined($printCloseAll)) { $printCloseAll = 1; }
1.143 bowersj2 1007: my $filterFunc = setDefault($args->{'filterFunc'},
1008: sub {return 1;});
1.144 bowersj2 1009:
1.140 bowersj2 1010: # Print key?
1011: if ($printKey) {
1012: $result .= '<table border="0" cellpadding="2" cellspacing="0">';
1013: my $date=localtime;
1014: $result.='<tr><td align="right" valign="bottom">Key: </td>';
1015: if ($navmap->{LAST_CHECK}) {
1016: $result .=
1017: '<img src="/adm/lonMisc/chat.gif"> New discussion since '.
1018: strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
1019: '</td><td align="center" valign="bottom"> '.
1020: '<img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'.
1021: '</td>';
1022: } else {
1023: $result .= '<td align="center" valign="bottom"> '.
1024: '<img src="/adm/lonMisc/chat.gif"> Discussions</td><td align="center" valign="bottom">'.
1025: ' <img src="/adm/lonMisc/feedback.gif"> New message (click to open)'.
1026: '</td>';
1027: }
1028:
1029: $result .= '</tr></table>';
1030: }
1031:
1032: if ($printCloseAll) {
1033: if ($condition) {
1034: $result.="<a href=\"navmaps?condition=0&filter=&$queryString" .
1035: "&hereType=$hereType&here=" . Apache::lonnet::escape($here) .
1036: "\">Close All Folders</a>";
1037: } else {
1038: $result.="<a href=\"navmaps?condition=1&filter=&$queryString" .
1039: "&hereType=$hereType&here=" . Apache::lonnet::escape($here) .
1040: "\">Open All Folders</a>";
1041: }
1.143 bowersj2 1042: $result .= "<br /><br />\n";
1.140 bowersj2 1043: }
1044:
1045: if ($r) {
1046: $r->print($result);
1047: $r->rflush();
1048: $result = "";
1049: }
1.132 bowersj2 1050: # End parameter setting
1.133 bowersj2 1051:
1.132 bowersj2 1052: # Data
1.140 bowersj2 1053: $result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n";
1.132 bowersj2 1054: my $res = "Apache::lonnavmaps::resource";
1055: my %condenseStatuses =
1056: ( $res->NETWORK_FAILURE => 1,
1057: $res->NOTHING_SET => 1,
1058: $res->CORRECT => 1 );
1059: my @backgroundColors = ("#FFFFFF", "#F6F6F6");
1.133 bowersj2 1060:
1061: # Shared variables
1062: $args->{'counter'} = 0; # counts the rows
1063: $args->{'indentLevel'} = 0;
1064: $args->{'isNewBranch'} = 0;
1065: $args->{'condensed'} = 0;
1066: $args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='/adm/lonIcons/whitespace1.gif' width='25' height='1' alt='' border='0' />");
1067: $args->{'displayedHereMarker'} = 0;
1.132 bowersj2 1068:
1.133 bowersj2 1069: my $displayedJumpMarker = 0;
1.132 bowersj2 1070: # Set up iteration.
1071: my $depth = 1;
1072: $it->next(); # discard initial BEGIN_MAP
1073: my $curRes = $it->next();
1074: my $now = time();
1075: my $in24Hours = $now + 24 * 60 * 60;
1076: my $rownum = 0;
1077:
1.141 bowersj2 1078: # export "here" marker information
1079: $args->{'here'} = $here;
1080: $args->{'hereType'} = $hereType;
1081:
1.132 bowersj2 1082: while ($depth > 0) {
1083: if ($curRes == $it->BEGIN_MAP()) { $depth++; }
1084: if ($curRes == $it->END_MAP()) { $depth--; }
1085:
1086: # Maintain indentation level.
1087: if ($curRes == $it->BEGIN_MAP() ||
1088: $curRes == $it->BEGIN_BRANCH() ) {
1.133 bowersj2 1089: $args->{'indentLevel'}++;
1.132 bowersj2 1090: }
1091: if ($curRes == $it->END_MAP() ||
1092: $curRes == $it->END_BRANCH() ) {
1.133 bowersj2 1093: $args->{'indentLevel'}--;
1.132 bowersj2 1094: }
1095: # Notice new branches
1096: if ($curRes == $it->BEGIN_BRANCH()) {
1.133 bowersj2 1097: $args->{'isNewBranch'} = 1;
1098: }
1099:
1100: # If this isn't an actual resource, continue on
1101: if (!ref($curRes)) {
1102: $curRes = $it->next();
1103: next;
1.132 bowersj2 1104: }
1.133 bowersj2 1105:
1106: $args->{'counter'}++;
1.143 bowersj2 1107:
1108: # If this has been filtered out, continue on
1109: if (!(&$filterFunc($curRes))) {
1110: $args->{'isNewBranch'} = 0; # Don't falsely remember this
1111: next;
1112: }
1.132 bowersj2 1113:
1.153 bowersj2 1114: # If we're suppressing navmaps and this is a navmap, continue on
1115: if ($suppressNavmap && $curRes->src() =~ /^\/adm\/navmaps/) {
1116: next;
1117: }
1118:
1.132 bowersj2 1119: # Does it have multiple parts?
1.133 bowersj2 1120: $args->{'multipart'} = 0;
1121: $args->{'condensed'} = 0;
1.132 bowersj2 1122: my @parts;
1123:
1124: # Decide what parts to show.
1.133 bowersj2 1125: if ($curRes->is_problem() && $showParts) {
1.132 bowersj2 1126: @parts = @{$curRes->parts()};
1.133 bowersj2 1127: $args->{'multipart'} = scalar(@parts) > 1;
1.132 bowersj2 1128:
1129: if ($condenseParts) { # do the condensation
1130: if (!$curRes->opendate("0")) {
1131: @parts = ("0");
1.133 bowersj2 1132: $args->{'condensed'} = 1;
1.132 bowersj2 1133: }
1.133 bowersj2 1134: if (!$args->{'condensed'}) {
1.132 bowersj2 1135: # Decide whether to condense based on similarity
1136: my $status = $curRes->status($parts[1]);
1137: my $due = $curRes->duedate($parts[1]);
1138: my $open = $curRes->opendate($parts[1]);
1139: my $statusAllSame = 1;
1140: my $dueAllSame = 1;
1141: my $openAllSame = 1;
1142: for (my $i = 2; $i < scalar(@parts); $i++) {
1143: if ($curRes->status($parts[$i]) != $status){
1144: $statusAllSame = 0;
1145: }
1146: if ($curRes->duedate($parts[$i]) != $due ) {
1147: $dueAllSame = 0;
1148: }
1149: if ($curRes->opendate($parts[$i]) != $open) {
1150: $openAllSame = 0;
1151: }
1152: }
1153: # $*allSame is true if all the statuses were
1154: # the same. Now, if they are all the same and
1155: # match one of the statuses to condense, or they
1156: # are all open with the same due date, or they are
1157: # all OPEN_LATER with the same open date, display the
1158: # status of the first non-zero part (to get the 'correct'
1159: # status right, since 0 is never 'correct' or 'open').
1160: if (($statusAllSame && defined($condenseStatuses{$status})) ||
1161: ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
1162: ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
1163: @parts = ($parts[1]);
1.133 bowersj2 1164: $args->{'condensed'} = 1;
1.132 bowersj2 1165: }
1166:
1167: }
1168: }
1.156 ! bowersj2 1169: }
1.132 bowersj2 1170:
1171: # If the multipart problem was condensed, "forget" it was multipart
1172: if (scalar(@parts) == 1) {
1.133 bowersj2 1173: $args->{'multipart'} = 0;
1.132 bowersj2 1174: }
1175:
1176: # Now, we've decided what parts to show. Loop through them and
1177: # show them.
1.156 ! bowersj2 1178: foreach my $part ('', @parts) {
! 1179: if ($part eq '0') {
! 1180: next;
! 1181: }
1.132 bowersj2 1182: $rownum ++;
1183: my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];
1184:
1185: $result .= " <tr bgcolor='$backgroundColor'>\n";
1.134 bowersj2 1186:
1187: # Set up some data about the parts that the cols might want
1188: my $filter = $it->{FILTER};
1189: my $stack = $it->getStack();
1190: my $src = getLinkForResource($stack);
1191:
1192: my $srcHasQuestion = $src =~ /\?/;
1193: $args->{"resourceLink"} = $src.
1194: ($srcHasQuestion?'&':'?') .
1.137 bowersj2 1195: 'symb=' . &Apache::lonnet::escape($curRes->symb());
1.132 bowersj2 1196:
1197: # Now, display each column.
1198: foreach my $col (@$cols) {
1.139 bowersj2 1199: my $colHTML = '';
1200: if (ref($col)) {
1201: $colHTML .= &$col($curRes, $part, $args);
1202: } else {
1203: $colHTML .= &{$preparedColumns[$col]}($curRes, $part, $args);
1204: }
1.132 bowersj2 1205:
1.133 bowersj2 1206: # If this is the first column and it's time to print
1207: # the anchor, do so
1208: if ($col == $cols->[0] &&
1209: $args->{'counter'} == $args->{'currentJumpIndex'} -
1.139 bowersj2 1210: $currentJumpDelta) {
1211: # Jam the anchor after the <td> tag;
1212: # necessary for valid HTML (which Mozilla requires)
1213: $colHTML =~ s/\>/\>\<a name="curloc" \/\>/;
1.133 bowersj2 1214: $displayedJumpMarker = 1;
1215: }
1.139 bowersj2 1216: $result .= $colHTML . "\n";
1.132 bowersj2 1217: }
1.139 bowersj2 1218: $result .= " </tr>\n";
1.140 bowersj2 1219: $args->{'isNewBranch'} = 0;
1.139 bowersj2 1220: }
1.153 bowersj2 1221:
1.139 bowersj2 1222: if ($r && $rownum % 20 == 0) {
1223: $r->print($result);
1224: $result = "";
1225: $r->rflush();
1.132 bowersj2 1226: }
1.156 ! bowersj2 1227: } continue {
1.132 bowersj2 1228: $curRes = $it->next();
1229: }
1230:
1.134 bowersj2 1231: # Print out the part that jumps to #curloc if it exists
1.139 bowersj2 1232: if ($displayedJumpMarker) {
1233: $result .= "<script>location += \"#curloc\";</script>\n";
1.134 bowersj2 1234: }
1235:
1.132 bowersj2 1236: $result .= "</table>";
1.140 bowersj2 1237:
1238: if ($r) {
1239: $r->print($result);
1240: $result = "";
1241: $r->rflush();
1242: }
1243:
1244: if ($mustCloseNavMap) { $navmap->untieHashes(); }
1.132 bowersj2 1245:
1246: return $result;
1247: }
1248:
1.133 bowersj2 1249: 1;
1250:
1251: package Apache::lonnavmaps::navmap;
1252:
1253: =pod
1254:
1255: lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, the Apache handler for the "Navigation Map" button, and a flexible prepared renderer for navigation maps that are easy to use anywhere.
1256:
1257: =head1 navmap object: Encapsulating the compiled nav map
1258:
1259: navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it.
1260:
1261: Most notably it provides a way to navigate the map sensibly and a flexible iterator that makes it easy to write various renderers based on nav maps.
1262:
1263: You must obtain resource objects through the navmap object.
1264:
1265: =head2 Methods
1266:
1267: =over 4
1268:
1269: =item * B<new>(navHashFile, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled nav map hash and parm hash given as filenames. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or B<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise.
1270:
1271: =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
1272:
1273: =cut
1274:
1275: use strict;
1276: use GDBM_File;
1277:
1278: sub new {
1279: # magic invocation to create a class instance
1280: my $proto = shift;
1281: my $class = ref($proto) || $proto;
1282: my $self = {};
1283:
1284: $self->{NAV_HASH_FILE} = shift;
1285: $self->{PARM_HASH_FILE} = shift;
1286: $self->{GENERATE_COURSE_USER_OPT} = shift;
1287: $self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;
1288:
1289: # Resource cache stores navmap resources as we reference them. We generate
1290: # them on-demand so we don't pay for creating resources unless we use them.
1291: $self->{RESOURCE_CACHE} = {};
1292:
1293: # Network failure flag, if we accessed the course or user opt and
1294: # failed
1295: $self->{NETWORK_FAILURE} = 0;
1296:
1297: # tie the nav hash
1298:
1299: if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
1300: &GDBM_READER(), 0640))) {
1301: return undef;
1302: }
1303:
1304: if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
1305: &GDBM_READER(), 0640)))
1306: {
1307: untie $self->{PARM_HASH};
1308: return undef;
1309: }
1310:
1311: $self->{HASH_TIED} = 1;
1312: $self->{NAV_HASH} = \%navmaphash;
1313: $self->{PARM_HASH} = \%parmhash;
1.140 bowersj2 1314: $self->{INITED} = 0;
1.133 bowersj2 1315:
1316: bless($self);
1317:
1318: return $self;
1319: }
1320:
1321: sub init {
1322: my $self = shift;
1.140 bowersj2 1323: if ($self->{INITED}) { return; }
1.133 bowersj2 1324:
1325: # If the course opt hash and the user opt hash should be generated,
1326: # generate them
1327: if ($self->{GENERATE_COURSE_USER_OPT}) {
1328: my $uname=$ENV{'user.name'};
1329: my $udom=$ENV{'user.domain'};
1330: my $uhome=$ENV{'user.home'};
1331: my $cid=$ENV{'request.course.id'};
1332: my $chome=$ENV{'course.'.$cid.'.home'};
1333: my ($cdom,$cnum)=split(/\_/,$cid);
1334:
1335: my $userprefix=$uname.'_'.$udom.'_';
1336:
1337: my %courserdatas; my %useropt; my %courseopt; my %userrdatas;
1338: unless ($uhome eq 'no_host') {
1339: # ------------------------------------------------- Get coursedata (if present)
1340: unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
1341: my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
1342: ':resourcedata',$chome);
1343: if ($reply!~/^error\:/) {
1344: $courserdatas{$cid}=$reply;
1345: $courserdatas{$cid.'.last_cache'}=time;
1346: }
1347: # check to see if network failed
1348: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1349: {
1350: $self->{NETWORK_FAILURE} = 1;
1351: }
1352: }
1353: foreach (split(/\&/,$courserdatas{$cid})) {
1354: my ($name,$value)=split(/\=/,$_);
1355: $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
1356: &Apache::lonnet::unescape($value);
1357: }
1358: # --------------------------------------------------- Get userdata (if present)
1359: unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
1360: my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
1361: if ($reply!~/^error\:/) {
1362: $userrdatas{$uname.'___'.$udom}=$reply;
1363: $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
1364: }
1365: # check to see if network failed
1366: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
1367: {
1368: $self->{NETWORK_FAILURE} = 1;
1369: }
1370: }
1371: foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
1372: my ($name,$value)=split(/\=/,$_);
1373: $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
1374: &Apache::lonnet::unescape($value);
1375: }
1376: $self->{COURSE_OPT} = \%courseopt;
1377: $self->{USER_OPT} = \%useropt;
1378: }
1379: }
1380:
1381: if ($self->{GENERATE_EMAIL_DISCUSS_STATUS}) {
1382: my $cid=$ENV{'request.course.id'};
1383: my ($cdom,$cnum)=split(/\_/,$cid);
1384:
1385: my %emailstatus = &Apache::lonnet::dump('email_status');
1386: my $logoutTime = $emailstatus{'logout'};
1387: my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
1388: $self->{LAST_CHECK} = ($courseLeaveTime < $logoutTime ?
1389: $courseLeaveTime : $logoutTime);
1390: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
1391: $cdom, $cnum);
1392: my %feedback=();
1393: my %error=();
1394: my $keys = &Apache::lonnet::reply('keys:'.
1395: $ENV{'user.domain'}.':'.
1396: $ENV{'user.name'}.':nohist_email',
1397: $ENV{'user.home'});
1398:
1399: foreach my $msgid (split(/\&/, $keys)) {
1400: $msgid=&Apache::lonnet::unescape($msgid);
1401: my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
1402: if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
1403: my ($what,$url)=($1,$2);
1404: my %status=
1405: &Apache::lonnet::get('email_status',[$msgid]);
1406: if ($status{$msgid}=~/^error\:/) {
1407: $status{$msgid}='';
1408: }
1409:
1410: if (($status{$msgid} eq 'new') ||
1411: (!$status{$msgid})) {
1412: if ($what eq 'Error') {
1413: $error{$url}.=','.$msgid;
1414: } else {
1415: $feedback{$url}.=','.$msgid;
1416: }
1417: }
1418: }
1419: }
1420:
1421: $self->{FEEDBACK} = \%feedback;
1422: $self->{ERROR_MSG} = \%error; # what is this? JB
1423: $self->{DISCUSSION_TIME} = \%discussiontime;
1424: $self->{EMAIL_STATUS} = \%emailstatus;
1425:
1426: }
1427:
1428: $self->{PARM_CACHE} = {};
1.140 bowersj2 1429: $self->{INITED} = 1;
1.133 bowersj2 1430: }
1431:
1432: # Internal function: Takes a key to look up in the nav hash and implements internal
1433: # memory caching of that key.
1434: sub navhash {
1435: my $self = shift; my $key = shift;
1436: return $self->{NAV_HASH}->{$key};
1437: }
1438:
1439: # Checks to see if coursemap is defined, matching test in old lonnavmaps
1440: sub courseMapDefined {
1441: my $self = shift;
1442: my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});
1443:
1444: my $firstres = $self->navhash("map_start_$uri");
1445: my $lastres = $self->navhash("map_finish_$uri");
1446: return $firstres && $lastres;
1447: }
1448:
1449: sub getIterator {
1450: my $self = shift;
1451: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
1452: shift, undef, shift);
1453: return $iterator;
1454: }
1455:
1456: # unties the hash when done
1457: sub untieHashes {
1458: my $self = shift;
1459: untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED});
1460: untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED});
1461: $self->{HASH_TIED} = 0;
1462: }
1463:
1464: # when the object is destroyed, be sure to untie all the hashes we tied.
1465: sub DESTROY {
1466: my $self = shift;
1467: $self->untieHashes();
1468: }
1469:
1470: # Private method: Does the given resource (as a symb string) have
1471: # current discussion? Returns 0 if chat/mail data not extracted.
1472: sub hasDiscussion {
1473: my $self = shift;
1474: my $symb = shift;
1475: if (!defined($self->{DISCUSSION_TIME})) { return 0; }
1476:
1477: #return defined($self->{DISCUSSION_TIME}->{$symb});
1478: return $self->{DISCUSSION_TIME}->{$symb} >
1479: $self->{LAST_CHECK};
1480: }
1481:
1482: # Private method: Does the given resource (as a symb string) have
1483: # current feedback? Returns the string in the feedback hash, which
1484: # will be false if it does not exist.
1485: sub getFeedback {
1486: my $self = shift;
1487: my $symb = shift;
1488:
1489: if (!defined($self->{FEEDBACK})) { return ""; }
1490:
1491: return $self->{FEEDBACK}->{$symb};
1492: }
1493:
1494: # Private method: Get the errors for that resource (by source).
1495: sub getErrors {
1496: my $self = shift;
1497: my $src = shift;
1498:
1499: if (!defined($self->{ERROR_MSG})) { return ""; }
1500: return $self->{ERROR_MSG}->{$src};
1501: }
1502:
1503: =pod
1504:
1505: =item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.
1506:
1507: =cut
1508:
1509: # The strategy here is to cache the resource objects, and only construct them
1510: # as we use them. The real point is to prevent reading any more from the tied
1511: # hash then we have to, which should hopefully alleviate speed problems.
1512: # Caching is just an incidental detail I throw in because it makes sense.
1513:
1514: sub getById {
1515: my $self = shift;
1516: my $id = shift;
1517:
1518: if (defined ($self->{RESOURCE_CACHE}->{$id}))
1519: {
1520: return $self->{RESOURCE_CACHE}->{$id};
1521: }
1522:
1523: # resource handles inserting itself into cache.
1524: # Not clear why the quotes are necessary, but as of this
1525: # writing it doesn't work without them.
1526: return "Apache::lonnavmaps::resource"->new($self, $id);
1.132 bowersj2 1527: }
1.133 bowersj2 1528:
1529: =pod
1530:
1531: =item * B<firstResource>(): Returns a resource object reference corresponding to the first resource in the navmap.
1532:
1533: =cut
1534:
1535: sub firstResource {
1536: my $self = shift;
1537: my $firstResource = $self->navhash('map_start_' .
1538: &Apache::lonnet::clutter($ENV{'request.course.uri'}));
1539: return $self->getById($firstResource);
1.132 bowersj2 1540: }
1.133 bowersj2 1541:
1542: =pod
1543:
1544: =item * B<finishResource>(): Returns a resource object reference corresponding to the last resource in the navmap.
1545:
1546: =cut
1547:
1548: sub finishResource {
1549: my $self = shift;
1550: my $firstResource = $self->navhash('map_finish_' .
1551: &Apache::lonnet::clutter($ENV{'request.course.uri'}));
1552: return $self->getById($firstResource);
1.132 bowersj2 1553: }
1.133 bowersj2 1554:
1555: # Parmval reads the parm hash and cascades the lookups. parmval_real does
1556: # the actual lookup; parmval caches the results.
1557: sub parmval {
1558: my $self = shift;
1559: my ($what,$symb)=@_;
1560: my $hashkey = $what."|||".$symb;
1561:
1562: if (defined($self->{PARM_CACHE}->{$hashkey})) {
1563: return $self->{PARM_CACHE}->{$hashkey};
1564: }
1565:
1566: my $result = $self->parmval_real($what, $symb);
1567: $self->{PARM_CACHE}->{$hashkey} = $result;
1568: return $result;
1.132 bowersj2 1569: }
1570:
1.133 bowersj2 1571: sub parmval_real {
1572: my $self = shift;
1573: my ($what,$symb) = @_;
1574:
1575: my $cid=$ENV{'request.course.id'};
1576: my $csec=$ENV{'request.course.sec'};
1577: my $uname=$ENV{'user.name'};
1578: my $udom=$ENV{'user.domain'};
1579:
1580: unless ($symb) { return ''; }
1581: my $result='';
1582:
1583: my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
1584:
1585: # ----------------------------------------------------- Cascading lookup scheme
1586: my $rwhat=$what;
1587: $what=~s/^parameter\_//;
1588: $what=~s/\_/\./;
1589:
1590: my $symbparm=$symb.'.'.$what;
1591: my $mapparm=$mapname.'___(all).'.$what;
1592: my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
1593:
1594: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
1595: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
1596: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
1597:
1598: my $courselevel= $usercourseprefix.'.'.$what;
1599: my $courselevelr=$usercourseprefix.'.'.$symbparm;
1600: my $courselevelm=$usercourseprefix.'.'.$mapparm;
1601:
1602: my $useropt = $self->{USER_OPT};
1603: my $courseopt = $self->{COURSE_OPT};
1604: my $parmhash = $self->{PARM_HASH};
1605:
1606: # ---------------------------------------------------------- first, check user
1607: if ($uname and defined($useropt)) {
1608: if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; }
1609: if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; }
1610: if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; }
1611: }
1612:
1613: # ------------------------------------------------------- second, check course
1614: if ($csec and defined($courseopt)) {
1615: if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
1616: if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
1617: if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; }
1618: }
1619:
1620: if (defined($courseopt)) {
1621: if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; }
1622: if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; }
1623: if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; }
1624: }
1625:
1626: # ----------------------------------------------------- third, check map parms
1627:
1628: my $thisparm=$$parmhash{$symbparm};
1629: if (defined($thisparm)) { return $thisparm; }
1630:
1631: # ----------------------------------------------------- fourth , check default
1632:
1633: my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
1634: if (defined($default)) { return $default}
1635:
1636: # --------------------------------------------------- fifth , cascade up parts
1637:
1638: my ($space,@qualifier)=split(/\./,$rwhat);
1639: my $qualifier=join('.',@qualifier);
1640: unless ($space eq '0') {
1641: my ($part,$id)=split(/\_/,$space);
1642: if ($id) {
1643: my $partgeneral=$self->parmval($part.".$qualifier",$symb);
1644: if (defined($partgeneral)) { return $partgeneral; }
1645: } else {
1646: my $resourcegeneral=$self->parmval("0.$qualifier",$symb);
1647: if (defined($resourcegeneral)) { return $resourcegeneral; }
1648: }
1649: }
1650: return '';
1.145 bowersj2 1651: }
1652:
1653: =pod
1654:
1655: =item * B<getResourceByUrl>(url): Retrieves a resource object by URL of the resource. If passed a resource object, it will simply return it, so it is safe to use this method in code like "$res = $navmap->getResourceByUrl($res)", if you're not sure if $res is already an object, or just a URL. If the resource appears multiple times in the course, only the first instance will be returned. As a result, this is probably useful only for maps.
1656:
1657: =item * B<retrieveResources>(map, filterFunc, recursive, bailout): The map is a specification of a map to retreive the resources from, either as a url or as an object. The filterFunc is a reference to a function that takes a resource object as its one argument and returns true if the resource should be included, or false if it should not be. If recursive is true, the map will be recursively examined, otherwise it will not be. If bailout is true, the function will return as soon as it finds a resource, if false it will finish. By default, the map is the top-level map of the course, filterFunc is a function that always returns 1, recursive is true, bailout is false. The resources will be returned in a list reference containing the resource objects for the corresponding resources, with B<no structure information> in the list; regardless of branching, recursion, etc., it will be a flat list.
1658:
1659: Thus, this is suitable for cases where you don't want the structure, just a list of all resources. It is also suitable for finding out how many resources match a given description; for this use, if all you want to know is if I<any> resources match the description, the bailout parameter will allow you to avoid potentially expensive enumeration of all matching resources.
1660:
1.146 bowersj2 1661: =item * B<hasResources>(map, filterFunc, recursive): Convience method for
1662:
1663: scalar(retrieveResources($map, $filterFunc, $recursive, 1)) > 0
1664:
1665: which will tell whether the map has resources matching the description in the filter function.
1666:
1.145 bowersj2 1667: =cut
1668:
1669: sub getResourceByUrl {
1670: my $self = shift;
1671: my $resUrl = shift;
1672:
1673: if (ref($resUrl)) { return $resUrl; }
1674:
1675: $resUrl = &Apache::lonnet::clutter($resUrl);
1676: my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl};
1677: if ($resId =~ /,/) {
1678: $resId = (split (/,/, $resId))[0];
1679: }
1680: if (!$resId) { return ''; }
1681: return $self->getById($resId);
1682: }
1683:
1684: sub retrieveResources {
1685: my $self = shift;
1686: my $map = shift;
1687: my $filterFunc = shift;
1688: if (!defined ($filterFunc)) {
1689: $filterFunc = sub {return 1;};
1690: }
1691: my $recursive = shift;
1692: if (!defined($recursive)) { $recursive = 1; }
1693: my $bailout = shift;
1694: if (!defined($bailout)) { $bailout = 0; }
1695:
1696: # Create the necessary iterator.
1697: if (!ref($map)) { # assume it's a url of a map.
1698: $map = $self->getMapByUrl($map);
1699: }
1700:
1701: # Check the map's validity.
1702: if (!$map || !$map->is_map()) {
1703: # Oh, to throw an exception.... how I'd love that!
1704: return ();
1705: }
1706:
1.146 bowersj2 1707: # Get an iterator.
1708: my $it = $self->getIterator($map->map_start(), $map->map_finish(),
1709: !$recursive);
1710:
1711: my @resources = ();
1712:
1713: # Run down the iterator and collect the resources.
1714: my $depth = 1;
1715: $it->next();
1716: my $curRes = $it->next();
1717:
1718: while ($depth > 0) {
1719: if ($curRes == $it->BEGIN_MAP()) {
1720: $depth++;
1721: }
1722: if ($curRes == $it->END_MAP()) {
1723: $depth--;
1724: }
1725:
1726: if (ref($curRes)) {
1727: if (!&$filterFunc($curRes)) {
1728: next;
1729: }
1730:
1731: push @resources, $curRes;
1732:
1733: if ($bailout) {
1734: return @resources;
1735: }
1736: }
1737:
1738: $curRes = $it->next();
1739: }
1740:
1741: return @resources;
1742: }
1743:
1744: sub hasResource {
1745: my $self = shift;
1746: my $map = shift;
1747: my $filterFunc = shift;
1748: my $recursive = shift;
1749:
1750: return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1)) > 0;
1.133 bowersj2 1751: }
1.51 bowersj2 1752:
1753: 1;
1754:
1755: package Apache::lonnavmaps::iterator;
1756:
1757: =pod
1758:
1759: =back
1760:
1761: =head1 navmap Iterator
1762:
1763: An I<iterator> encapsulates the logic required to traverse a data structure. navmap uses an iterator to traverse the course map according to the criteria you wish to use.
1764:
1765: To obtain an iterator, call the B<getIterator>() function of a B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator directly.) This will return a reference to the iterator:
1766:
1767: C<my $resourceIterator = $navmap-E<gt>getIterator();>
1768:
1769: To get the next thing from the iterator, call B<next>:
1770:
1771: C<my $nextThing = $resourceIterator-E<gt>next()>
1772:
1773: getIterator behaves as follows:
1774:
1775: =over 4
1776:
1.116 bowersj2 1777: =item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0. forceTop is a boolean value. If it is false (default), the iterator will only return the first level of map that is not just a single, 'redirecting' map. If true, the iterator will return all information, starting with the top-level map, regardless of content.
1.51 bowersj2 1778:
1.101 bowersj2 1779: Thus, by default, only top-level resources will be shown. Change the condition to a 1 without changing the hash, and all resources will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively suppress parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively add parts of the nav map. See the handler code for examples.
1.51 bowersj2 1780:
1781: The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are:
1782:
1783: =over 4
1784:
1.70 bowersj2 1785: =item * BEGIN_MAP: A new map is being recursed into. This is returned I<after> the map resource itself is returned.
1786:
1787: =item * END_MAP: The map is now done.
1788:
1789: =item * BEGIN_BRANCH: A branch is now starting. The next resource returned will be the first in that branch.
1790:
1791: =item * END_BRANCH: The branch is now done.
1.51 bowersj2 1792:
1793: =back
1794:
1.70 bowersj2 1795: The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.
1796:
1.116 bowersj2 1797: Maps can contain empty resources. The iterator will automatically skip over such resources, but will still treat the structure correctly. Thus, a complicated map with several branches, but consisting entirely of empty resources except for one beginning or ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs, but only one resource will be returned.
1798:
1.70 bowersj2 1799: =back
1.51 bowersj2 1800:
1801: =cut
1802:
1803: # Here are the tokens for the iterator:
1804:
1805: sub BEGIN_MAP { return 1; } # begining of a new map
1806: sub END_MAP { return 2; } # end of the map
1807: sub BEGIN_BRANCH { return 3; } # beginning of a branch
1808: sub END_BRANCH { return 4; } # end of a branch
1.89 bowersj2 1809: sub FORWARD { return 1; } # go forward
1810: sub BACKWARD { return 2; }
1.51 bowersj2 1811:
1.96 bowersj2 1812: sub min {
1813: (my $a, my $b) = @_;
1814: if ($a < $b) { return $a; } else { return $b; }
1815: }
1816:
1.107 bowersj2 1817: # In the CVS repository, documentation of this algorithm is included
1818: # in /doc/lonnavdocs, as a PDF and .tex source. Markers like **1**
1819: # will reference the same location in the text as the part of the
1820: # algorithm is running through.
1821:
1.94 bowersj2 1822: sub new {
1823: # magic invocation to create a class instance
1824: my $proto = shift;
1825: my $class = ref($proto) || $proto;
1826: my $self = {};
1827:
1828: $self->{NAV_MAP} = shift;
1829: return undef unless ($self->{NAV_MAP});
1830:
1831: # Handle the parameters
1832: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
1833: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
1834:
1835: # If the given resources are just the ID of the resource, get the
1836: # objects
1837: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
1838: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
1839: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
1840: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
1841:
1842: $self->{FILTER} = shift;
1843:
1844: # A hash, used as a set, of resource already seen
1845: $self->{ALREADY_SEEN} = shift;
1846: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1847: $self->{CONDITION} = shift;
1848:
1.116 bowersj2 1849: # Do we want to automatically follow "redirection" maps?
1850: $self->{FORCE_TOP} = shift;
1851:
1.94 bowersj2 1852: # Now, we need to pre-process the map, by walking forward and backward
1853: # over the parts of the map we're going to look at.
1.96 bowersj2 1854:
1.97 bowersj2 1855: # The processing steps are exactly the same, except for a few small
1856: # changes, so I bundle those up in the following list of two elements:
1857: # (direction_to_iterate, VAL_name, next_resource_method_to_call,
1858: # first_resource).
1859: # This prevents writing nearly-identical code twice.
1860: my @iterations = ( [FORWARD(), 'TOP_DOWN_VAL', 'getNext',
1861: 'FIRST_RESOURCE'],
1862: [BACKWARD(), 'BOT_UP_VAL', 'getPrevious',
1863: 'FINISH_RESOURCE'] );
1864:
1.98 bowersj2 1865: my $maxDepth = 0; # tracks max depth
1866:
1.116 bowersj2 1867: # If there is only one resource in this map, and it's a map, we
1868: # want to remember that, so the user can ask for the first map
1869: # that isn't just a redirector.
1870: my $resource; my $resourceCount = 0;
1871:
1.107 bowersj2 1872: # **1**
1873:
1.97 bowersj2 1874: foreach my $pass (@iterations) {
1875: my $direction = $pass->[0];
1876: my $valName = $pass->[1];
1877: my $nextResourceMethod = $pass->[2];
1878: my $firstResourceName = $pass->[3];
1879:
1880: my $iterator = Apache::lonnavmaps::DFSiterator->new($self->{NAV_MAP},
1881: $self->{FIRST_RESOURCE},
1882: $self->{FINISH_RESOURCE},
1883: {}, undef, 0, $direction);
1.96 bowersj2 1884:
1.97 bowersj2 1885: # prime the recursion
1886: $self->{$firstResourceName}->{DATA}->{$valName} = 0;
1.98 bowersj2 1887: my $depth = 0;
1.97 bowersj2 1888: $iterator->next();
1889: my $curRes = $iterator->next();
1.98 bowersj2 1890: while ($depth > -1) {
1.97 bowersj2 1891: if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
1892: if ($curRes == $iterator->END_MAP()) { $depth--; }
1.96 bowersj2 1893:
1.97 bowersj2 1894: if (ref($curRes)) {
1.116 bowersj2 1895: # If there's only one resource, this will save it
1.117 bowersj2 1896: # we have to filter empty resources from consideration here,
1897: # or even "empty", redirecting maps have two (start & finish)
1898: # or three (start, finish, plus redirector)
1899: if($direction == FORWARD && $curRes->src()) {
1900: $resource = $curRes; $resourceCount++;
1901: }
1.97 bowersj2 1902: my $resultingVal = $curRes->{DATA}->{$valName};
1903: my $nextResources = $curRes->$nextResourceMethod();
1.116 bowersj2 1904: my $nextCount = scalar(@{$nextResources});
1.104 bowersj2 1905:
1.116 bowersj2 1906: if ($nextCount == 1) { # **3**
1.97 bowersj2 1907: my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;
1908: $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
1909: }
1910:
1.116 bowersj2 1911: if ($nextCount > 1) { # **4**
1.97 bowersj2 1912: foreach my $res (@{$nextResources}) {
1913: my $current = $res->{DATA}->{$valName} || 999999999;
1914: $res->{DATA}->{$valName} = min($current, $resultingVal + 1);
1915: }
1916: }
1917: }
1.96 bowersj2 1918:
1.107 bowersj2 1919: # Assign the final val (**2**)
1.97 bowersj2 1920: if (ref($curRes) && $direction == BACKWARD()) {
1.98 bowersj2 1921: my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},
1922: $curRes->{DATA}->{BOT_UP_VAL});
1923:
1924: $curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;
1925: if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}
1926: }
1.97 bowersj2 1927: $curRes = $iterator->next();
1.96 bowersj2 1928: }
1929: }
1.94 bowersj2 1930:
1.116 bowersj2 1931: # Check: Was this only one resource, a map?
1932: if ($resourceCount == 1 && $resource->is_map() && !$self->{FORCE_TOP}) {
1933: my $firstResource = $resource->map_start();
1934: my $finishResource = $resource->map_finish();
1935: return
1936: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
1937: $finishResource, $self->{FILTER},
1938: $self->{ALREADY_SEEN},
1939: $self->{CONDITION}, 0);
1940:
1941: }
1942:
1.98 bowersj2 1943: # Set up some bookkeeping information.
1944: $self->{CURRENT_DEPTH} = 0;
1945: $self->{MAX_DEPTH} = $maxDepth;
1946: $self->{STACK} = [];
1947: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1948:
1949: for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) {
1950: push @{$self->{STACK}}, [];
1951: }
1952:
1.107 bowersj2 1953: # Prime the recursion w/ the first resource **5**
1.98 bowersj2 1954: push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};
1955: $self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;
1956:
1957: bless ($self);
1958:
1959: return $self;
1960: }
1961:
1962: sub next {
1963: my $self = shift;
1964:
1965: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1966: # grab the next from the recursive iterator
1967: my $next = $self->{RECURSIVE_ITERATOR}->next();
1968:
1969: # is it a begin or end map? If so, update the depth
1970: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
1971: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
1972:
1973: # Are we back at depth 0? If so, stop recursing
1974: if ($self->{RECURSIVE_DEPTH} == 0) {
1975: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1976: }
1977:
1978: return $next;
1979: }
1980:
1981: if (defined($self->{FORCE_NEXT})) {
1982: my $tmp = $self->{FORCE_NEXT};
1983: $self->{FORCE_NEXT} = undef;
1984: return $tmp;
1985: }
1986:
1987: # Have we not yet begun? If not, return BEGIN_MAP and
1988: # remember we've started.
1989: if ( !$self->{STARTED} ) {
1990: $self->{STARTED} = 1;
1991: return $self->BEGIN_MAP();
1992: }
1993:
1994: # Here's the guts of the iterator.
1995:
1996: # Find the next resource, if any.
1997: my $found = 0;
1998: my $i = $self->{MAX_DEPTH};
1999: my $newDepth;
2000: my $here;
2001: while ( $i >= 0 && !$found ) {
1.107 bowersj2 2002: if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6**
2003: $here = pop @{$self->{STACK}->[$i]}; # **7**
1.98 bowersj2 2004: $found = 1;
2005: $newDepth = $i;
2006: }
2007: $i--;
2008: }
2009:
2010: # If we still didn't find anything, we're done.
2011: if ( !$found ) {
2012: # We need to get back down to the correct branch depth
2013: if ( $self->{CURRENT_DEPTH} > 0 ) {
2014: $self->{CURRENT_DEPTH}--;
2015: return END_BRANCH();
2016: } else {
2017: return END_MAP();
2018: }
2019: }
2020:
1.104 bowersj2 2021: # If this is not a resource, it must be an END_BRANCH marker we want
2022: # to return directly.
1.107 bowersj2 2023: if (!ref($here)) { # **8**
1.104 bowersj2 2024: if ($here == END_BRANCH()) { # paranoia, in case of later extension
2025: $self->{CURRENT_DEPTH}--;
2026: return $here;
2027: }
2028: }
2029:
2030: # Otherwise, it is a resource and it's safe to store in $self->{HERE}
2031: $self->{HERE} = $here;
2032:
1.98 bowersj2 2033: # Get to the right level
2034: if ( $self->{CURRENT_DEPTH} > $newDepth ) {
2035: push @{$self->{STACK}->[$newDepth]}, $here;
2036: $self->{CURRENT_DEPTH}--;
2037: return END_BRANCH();
2038: }
2039: if ( $self->{CURRENT_DEPTH} < $newDepth) {
2040: push @{$self->{STACK}->[$newDepth]}, $here;
2041: $self->{CURRENT_DEPTH}++;
2042: return BEGIN_BRANCH();
2043: }
2044:
2045: # If we made it here, we have the next resource, and we're at the
2046: # right branch level. So let's examine the resource for where
2047: # we can get to from here.
2048:
2049: # So we need to look at all the resources we can get to from here,
2050: # categorize them if we haven't seen them, remember if we have a new
2051: my $nextUnfiltered = $here->getNext();
1.104 bowersj2 2052: my $maxDepthAdded = -1;
2053:
1.98 bowersj2 2054: for (@$nextUnfiltered) {
2055: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
1.104 bowersj2 2056: my $depth = $_->{DATA}->{DISPLAY_DEPTH};
2057: push @{$self->{STACK}->[$depth]}, $_;
1.98 bowersj2 2058: $self->{ALREADY_SEEN}->{$_->{ID}} = 1;
1.104 bowersj2 2059: if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; }
1.98 bowersj2 2060: }
2061: }
1.104 bowersj2 2062:
2063: # Is this the end of a branch? If so, all of the resources examined above
2064: # led to lower levels then the one we are currently at, so we push a END_BRANCH
2065: # marker onto the stack so we don't forget.
2066: # Example: For the usual A(BC)(DE)F case, when the iterator goes down the
2067: # BC branch and gets to C, it will see F as the only next resource, but it's
2068: # one level lower. Thus, this is the end of the branch, since there are no
2069: # more resources added to this level or above.
1.111 bowersj2 2070: # We don't do this if the examined resource is the finish resource,
2071: # because the condition given above is true, but the "END_MAP" will
2072: # take care of things and we should already be at depth 0.
1.104 bowersj2 2073: my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH};
1.111 bowersj2 2074: if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9**
1.104 bowersj2 2075: push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH();
2076: }
2077:
1.98 bowersj2 2078: # That ends the main iterator logic. Now, do we want to recurse
2079: # down this map (if this resource is a map)?
2080: if ($self->{HERE}->is_map() &&
2081: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
2082: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
2083: my $firstResource = $self->{HERE}->map_start();
2084: my $finishResource = $self->{HERE}->map_finish();
2085:
2086: $self->{RECURSIVE_ITERATOR} =
2087: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
2088: $finishResource, $self->{FILTER},
2089: $self->{ALREADY_SEEN}, $self->{CONDITION});
2090: }
2091:
1.116 bowersj2 2092: # If this is a blank resource, don't actually return it.
1.117 bowersj2 2093: # Should you ever find you need it, make sure to add an option to the code
2094: # that you can use; other things depend on this behavior.
1.138 bowersj2 2095: my $browsePriv = $self->{HERE}->browsePriv();
2096: if (!$self->{HERE}->src() ||
2097: (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
1.116 bowersj2 2098: return $self->next();
2099: }
2100:
1.98 bowersj2 2101: return $self->{HERE};
2102:
2103: }
2104:
2105: =pod
2106:
2107: The other method available on the iterator is B<getStack>, which returns an array populated with the current 'stack' of maps, as references to the resource objects. Example: This is useful when making the navigation map, as we need to check whether we are under a page map to see if we need to link directly to the resource, or to the page. The first elements in the array will correspond to the top of the stack (most inclusive map).
2108:
2109: =cut
2110:
2111: sub getStack {
2112: my $self=shift;
2113:
2114: my @stack;
2115:
2116: $self->populateStack(\@stack);
2117:
2118: return \@stack;
2119: }
2120:
2121: # Private method: Calls the iterators recursively to populate the stack.
2122: sub populateStack {
2123: my $self=shift;
2124: my $stack = shift;
2125:
2126: push @$stack, $self->{HERE} if ($self->{HERE});
2127:
2128: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
2129: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
2130: }
1.94 bowersj2 2131: }
2132:
2133: 1;
2134:
2135: package Apache::lonnavmaps::DFSiterator;
2136:
1.100 bowersj2 2137: # Not documented in the perldoc: This is a simple iterator that just walks
2138: # through the nav map and presents the resources in a depth-first search
2139: # fashion, ignorant of conditionals, randomized resources, etc. It presents
2140: # BEGIN_MAP and END_MAP, but does not understand branches at all. It is
2141: # useful for pre-processing of some kind, and is in fact used by the main
2142: # iterator that way, but that's about it.
2143: # One could imagine merging this into the init routine of the main iterator,
2144: # but this might as well be left seperate, since it is possible some other
2145: # use might be found for it. - Jeremy
1.94 bowersj2 2146:
1.117 bowersj2 2147: # Unlike the main iterator, this DOES return all resources, even blank ones.
2148: # The main iterator needs them to correctly preprocess the map.
2149:
1.94 bowersj2 2150: sub BEGIN_MAP { return 1; } # begining of a new map
2151: sub END_MAP { return 2; } # end of the map
2152: sub FORWARD { return 1; } # go forward
2153: sub BACKWARD { return 2; }
2154:
1.100 bowersj2 2155: # Params: Nav map ref, first resource id/ref, finish resource id/ref,
2156: # filter hash ref (or undef), already seen hash or undef, condition
2157: # (as in main iterator), direction FORWARD or BACKWARD (undef->forward).
1.51 bowersj2 2158: sub new {
2159: # magic invocation to create a class instance
2160: my $proto = shift;
2161: my $class = ref($proto) || $proto;
2162: my $self = {};
2163:
2164: $self->{NAV_MAP} = shift;
2165: return undef unless ($self->{NAV_MAP});
2166:
2167: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
2168: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
2169:
2170: # If the given resources are just the ID of the resource, get the
2171: # objects
2172: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
2173: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
2174: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
2175: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
2176:
2177: $self->{FILTER} = shift;
2178:
2179: # A hash, used as a set, of resource already seen
2180: $self->{ALREADY_SEEN} = shift;
1.140 bowersj2 2181: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1.63 bowersj2 2182: $self->{CONDITION} = shift;
1.89 bowersj2 2183: $self->{DIRECTION} = shift || FORWARD();
1.51 bowersj2 2184:
1.100 bowersj2 2185: # Flag: Have we started yet?
1.51 bowersj2 2186: $self->{STARTED} = 0;
2187:
2188: # Should we continue calling the recursive iterator, if any?
2189: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
2190: # The recursive iterator, if any
2191: $self->{RECURSIVE_ITERATOR} = undef;
2192: # Are we recursing on a map, or a branch?
2193: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
2194: # And the count of how deep it is, so that this iterator can keep track of
2195: # when to pick back up again.
2196: $self->{RECURSIVE_DEPTH} = 0;
2197:
2198: # For keeping track of our branches, we maintain our own stack
1.100 bowersj2 2199: $self->{STACK} = [];
1.51 bowersj2 2200:
2201: # Start with the first resource
1.89 bowersj2 2202: if ($self->{DIRECTION} == FORWARD) {
1.100 bowersj2 2203: push @{$self->{STACK}}, $self->{FIRST_RESOURCE};
1.89 bowersj2 2204: } else {
1.100 bowersj2 2205: push @{$self->{STACK}}, $self->{FINISH_RESOURCE};
1.89 bowersj2 2206: }
1.51 bowersj2 2207:
2208: bless($self);
2209: return $self;
2210: }
2211:
2212: sub next {
2213: my $self = shift;
2214:
2215: # Are we using a recursive iterator? If so, pull from that and
2216: # watch the depth; we want to resume our level at the correct time.
1.98 bowersj2 2217: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1.51 bowersj2 2218: # grab the next from the recursive iterator
2219: my $next = $self->{RECURSIVE_ITERATOR}->next();
2220:
2221: # is it a begin or end map? Update depth if so
2222: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
2223: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
2224:
2225: # Are we back at depth 0? If so, stop recursing.
2226: if ($self->{RECURSIVE_DEPTH} == 0) {
2227: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
2228: }
2229:
2230: return $next;
2231: }
2232:
2233: # Is there a current resource to grab? If not, then return
1.100 bowersj2 2234: # END_MAP, which will end the iterator.
2235: if (scalar(@{$self->{STACK}}) == 0) {
2236: return $self->END_MAP();
1.51 bowersj2 2237: }
2238:
2239: # Have we not yet begun? If not, return BEGIN_MAP and
2240: # remember that we've started.
2241: if ( !$self->{STARTED} ) {
2242: $self->{STARTED} = 1;
2243: return $self->BEGIN_MAP;
2244: }
2245:
2246: # Get the next resource in the branch
1.100 bowersj2 2247: $self->{HERE} = pop @{$self->{STACK}};
1.52 bowersj2 2248:
1.100 bowersj2 2249: # remember that we've seen this, so we don't return it again later
1.51 bowersj2 2250: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
2251:
2252: # Get the next possible resources
1.90 bowersj2 2253: my $nextUnfiltered;
1.89 bowersj2 2254: if ($self->{DIRECTION} == FORWARD()) {
1.90 bowersj2 2255: $nextUnfiltered = $self->{HERE}->getNext();
1.89 bowersj2 2256: } else {
1.90 bowersj2 2257: $nextUnfiltered = $self->{HERE}->getPrevious();
1.89 bowersj2 2258: }
1.51 bowersj2 2259: my $next = [];
2260:
2261: # filter the next possibilities to remove things we've
1.100 bowersj2 2262: # already seen.
1.51 bowersj2 2263: foreach (@$nextUnfiltered) {
1.52 bowersj2 2264: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
2265: push @$next, $_;
2266: }
1.51 bowersj2 2267: }
2268:
2269: while (@$next) {
1.100 bowersj2 2270: # copy the next possibilities over to the stack
2271: push @{$self->{STACK}}, shift @$next;
1.51 bowersj2 2272: }
2273:
2274: # If this is a map and we want to recurse down it... (not filtered out)
1.70 bowersj2 2275: if ($self->{HERE}->is_map() &&
1.63 bowersj2 2276: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
1.51 bowersj2 2277: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
2278: my $firstResource = $self->{HERE}->map_start();
2279: my $finishResource = $self->{HERE}->map_finish();
2280:
2281: $self->{RECURSIVE_ITERATOR} =
1.94 bowersj2 2282: Apache::lonnavmaps::DFSiterator->new ($self->{NAV_MAP}, $firstResource,
1.63 bowersj2 2283: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
1.91 bowersj2 2284: $self->{CONDITION}, $self->{DIRECTION});
1.51 bowersj2 2285: }
2286:
2287: return $self->{HERE};
2288: }
2289:
1.1 www 2290: 1;
1.2 www 2291:
1.51 bowersj2 2292: package Apache::lonnavmaps::resource;
2293:
2294: use Apache::lonnet;
2295:
2296: =pod
2297:
2298: =head1 Object: resource
2299:
2300: A resource object encapsulates a resource in a resource map, allowing easy manipulation of the resource, querying the properties of the resource (including user properties), and represents a reference that can be used as the canonical representation of the resource by lonnavmap clients like renderers.
2301:
2302: A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object.
2303:
1.140 bowersj2 2304: You will probably never need to instantiate this object directly. Use Apache::lonnavmaps::navmap, and use the "start" method to obtain the starting resource.
1.51 bowersj2 2305:
2306: =head2 Public Members
2307:
2308: resource objects have a hash called DATA ($resourceRef->{DATA}) that you can store whatever you want in. This allows you to easily do two-pass algorithms without worrying about managing your own resource->data hash.
2309:
2310: =head2 Methods
2311:
2312: =over 4
2313:
1.70 bowersj2 2314: =item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself. Very rarely, if ever, called directly. Use the nav map->getByID() method.
2315:
2316: =back
1.51 bowersj2 2317:
2318: =cut
2319:
2320: sub new {
2321: # magic invocation to create a class instance
2322: my $proto = shift;
2323: my $class = ref($proto) || $proto;
2324: my $self = {};
2325:
2326: $self->{NAV_MAP} = shift;
2327: $self->{ID} = shift;
2328:
2329: # Store this new resource in the parent nav map's cache.
2330: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
1.66 bowersj2 2331: $self->{RESOURCE_ERROR} = 0;
1.51 bowersj2 2332:
2333: # A hash that can be used by two-pass algorithms to store data
2334: # about this resource in. Not used by the resource object
2335: # directly.
2336: $self->{DATA} = {};
2337:
2338: bless($self);
2339:
2340: return $self;
2341: }
2342:
1.70 bowersj2 2343: # private function: simplify the NAV_HASH lookups we keep doing
2344: # pass the name, and to automatically append my ID, pass a true val on the
2345: # second param
2346: sub navHash {
2347: my $self = shift;
2348: my $param = shift;
2349: my $id = shift;
1.115 bowersj2 2350: return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:""));
1.70 bowersj2 2351: }
2352:
1.51 bowersj2 2353: =pod
2354:
1.70 bowersj2 2355: B<Metadata Retreival>
2356:
1.101 bowersj2 2357: These are methods that help you retrieve metadata about the resource: Method names are based on the fields in the compiled course representation.
1.70 bowersj2 2358:
2359: =over 4
2360:
1.106 bowersj2 2361: =item * B<compTitle>: Returns a "composite title", that is equal to $res->title() if the resource has a title, and is otherwise the last part of the URL (e.g., "problem.problem").
2362:
1.70 bowersj2 2363: =item * B<ext>: Returns true if the resource is external.
2364:
2365: =item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
2366:
2367: =item * B<kind>: Returns the kind of the resource from the compiled nav map.
2368:
1.101 bowersj2 2369: =item * B<randomout>: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature. In other words, this is usually false.
1.51 bowersj2 2370:
1.70 bowersj2 2371: =item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?)
2372:
2373: =item * B<src>: Returns the source for the resource.
2374:
2375: =item * B<symb>: Returns the symb for the resource.
2376:
2377: =item * B<title>: Returns the title of the resource.
2378:
2379: =item * B<to>: Returns the "to" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
1.51 bowersj2 2380:
2381: =back
2382:
2383: =cut
2384:
2385: # These info functions can be used directly, as they don't return
2386: # resource information.
1.85 bowersj2 2387: sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
1.70 bowersj2 2388: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
1.85 bowersj2 2389: sub from { my $self=shift; return $self->navHash("from_", 1); }
1.51 bowersj2 2390: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
2391: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
1.68 bowersj2 2392: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
2393: sub randompick {
2394: my $self = shift;
2395: return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .
2396: '.0.parameter_randompick'};
2397: }
1.51 bowersj2 2398: sub src {
2399: my $self=shift;
2400: return $self->navHash("src_", 1);
2401: }
2402: sub symb {
2403: my $self=shift;
2404: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
2405: my $symbSrc = &Apache::lonnet::declutter($self->src());
2406: return &Apache::lonnet::declutter(
2407: $self->navHash('map_id_'.$first))
2408: . '___' . $second . '___' . $symbSrc;
2409: }
1.70 bowersj2 2410: sub title { my $self=shift; return $self->navHash("title_", 1); }
2411: sub to { my $self=shift; return $self->navHash("to_", 1); }
1.106 bowersj2 2412: sub compTitle {
2413: my $self = shift;
2414: my $title = $self->title();
2415: if (!$title) {
2416: $title = $self->src();
2417: $title = substr($title, rindex($title, '/') + 1);
2418: }
2419: return $title;
2420: }
1.70 bowersj2 2421: =pod
2422:
2423: B<Predicate Testing the Resource>
2424:
2425: These methods are shortcuts to deciding if a given resource has a given property.
2426:
2427: =over 4
2428:
2429: =item * B<is_map>: Returns true if the resource is a map type.
2430:
2431: =item * B<is_problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field; might need more to work correctly.)
2432:
2433: =item * B<is_page>: Returns true if the resource is a page.
2434:
1.101 bowersj2 2435: =item * B<is_sequence>: Returns true if the resource is a sequence.
1.70 bowersj2 2436:
2437: =back
2438:
2439: =cut
2440:
2441:
2442: sub is_html {
1.51 bowersj2 2443: my $self=shift;
2444: my $src = $self->src();
1.70 bowersj2 2445: return ($src =~ /html$/);
1.51 bowersj2 2446: }
1.70 bowersj2 2447: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
2448: sub is_page {
1.51 bowersj2 2449: my $self=shift;
2450: my $src = $self->src();
1.70 bowersj2 2451: return ($src =~ /page$/);
1.51 bowersj2 2452: }
1.70 bowersj2 2453: sub is_problem {
1.51 bowersj2 2454: my $self=shift;
2455: my $src = $self->src();
1.70 bowersj2 2456: return ($src =~ /problem$/);
1.51 bowersj2 2457: }
1.70 bowersj2 2458: sub is_sequence {
1.51 bowersj2 2459: my $self=shift;
2460: my $src = $self->src();
1.70 bowersj2 2461: return ($src =~ /sequence$/);
1.51 bowersj2 2462: }
2463:
1.101 bowersj2 2464: # Private method: Shells out to the parmval in the nav map, handler parts.
1.51 bowersj2 2465: sub parmval {
2466: my $self = shift;
2467: my $what = shift;
2468: my $part = shift || "0";
2469: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
2470: }
2471:
1.70 bowersj2 2472: =pod
2473:
2474: B<Map Methods>
2475:
2476: These methods are useful for getting information about the map properties of the resource, if the resource is a map (B<is_map>).
2477:
2478: =over 4
2479:
2480: =item * B<map_finish>: Returns a reference to a resource object corresponding to the finish resource of the map.
2481:
2482: =item * B<map_pc>: Returns the pc value of the map, which is the first number that appears in the resource ID of the resources in the map, and is the number that appears around the middle of the symbs of the resources in that map.
2483:
2484: =item * B<map_start>: Returns a reference to a resource object corresponding to the start resource of the map.
2485:
2486: =item * B<map_type>: Returns a string with the type of the map in it.
2487:
2488: =back
1.51 bowersj2 2489:
1.70 bowersj2 2490: =cut
1.51 bowersj2 2491:
2492: sub map_finish {
2493: my $self = shift;
2494: my $src = $self->src();
1.144 bowersj2 2495: $src = Apache::lonnet::clutter($src);
1.51 bowersj2 2496: my $res = $self->navHash("map_finish_$src", 0);
2497: $res = $self->{NAV_MAP}->getById($res);
2498: return $res;
2499: }
1.70 bowersj2 2500: sub map_pc {
2501: my $self = shift;
2502: my $src = $self->src();
2503: return $self->navHash("map_pc_$src", 0);
2504: }
1.51 bowersj2 2505: sub map_start {
2506: my $self = shift;
2507: my $src = $self->src();
1.144 bowersj2 2508: $src = Apache::lonnet::clutter($src);
1.51 bowersj2 2509: my $res = $self->navHash("map_start_$src", 0);
2510: $res = $self->{NAV_MAP}->getById($res);
2511: return $res;
2512: }
2513: sub map_type {
2514: my $self = shift;
2515: my $pc = $self->map_pc();
2516: return $self->navHash("map_type_$pc", 0);
2517: }
2518:
2519:
2520:
2521: #####
2522: # Property queries
2523: #####
2524:
2525: # These functions will be responsible for returning the CORRECT
2526: # VALUE for the parameter, no matter what. So while they may look
2527: # like direct calls to parmval, they can be more then that.
2528: # So, for instance, the duedate function should use the "duedatetype"
2529: # information, rather then the resource object user.
2530:
2531: =pod
2532:
2533: =head2 Resource Parameters
2534:
1.70 bowersj2 2535: In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to part "0", but can be directed to another part by passing the part as the parameter.
1.51 bowersj2 2536:
2537: These methods are responsible for getting the parameter correct, not merely reflecting the contents of the GDBM hashes. As we move towards dates relative to other dates, these methods should be updated to reflect that. (Then, anybody using these methods won't have to update their code.)
2538:
2539: =over 4
2540:
2541: =item * B<acc>: Get the Client IP/Name Access Control information.
2542:
2543: =item * B<answerdate>: Get the answer-reveal date for the problem.
2544:
2545: =item * B<duedate>: Get the due date for the problem.
2546:
2547: =item * B<tries>: Get the number of tries the student has used on the problem.
2548:
2549: =item * B<maxtries>: Get the number of max tries allowed.
2550:
2551: =item * B<opendate>: Get the open date for the problem.
2552:
2553: =item * B<sig>: Get the significant figures setting.
2554:
2555: =item * B<tol>: Get the tolerance for the problem.
2556:
1.70 bowersj2 2557: =item * B<tries>: Get the number of tries the user has already used on the problem.
2558:
1.51 bowersj2 2559: =item * B<type>: Get the question type for the problem.
2560:
2561: =item * B<weight>: Get the weight for the problem.
2562:
2563: =back
2564:
2565: =cut
2566:
2567: sub acc {
2568: (my $self, my $part) = @_;
2569: return $self->parmval("acc", $part);
2570: }
2571: sub answerdate {
2572: (my $self, my $part) = @_;
2573: # Handle intervals
2574: if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
2575: return $self->duedate($part) +
2576: $self->parmval("answerdate", $part);
2577: }
2578: return $self->parmval("answerdate", $part);
1.106 bowersj2 2579: }
1.108 bowersj2 2580: sub awarded { my $self = shift; return $self->queryRestoreHash('awarded', shift); }
1.51 bowersj2 2581: sub duedate {
2582: (my $self, my $part) = @_;
2583: return $self->parmval("duedate", $part);
2584: }
2585: sub maxtries {
2586: (my $self, my $part) = @_;
2587: return $self->parmval("maxtries", $part);
2588: }
2589: sub opendate {
2590: (my $self, my $part) = @_;
2591: if ($self->parmval("opendate.type", $part) eq 'date_interval') {
2592: return $self->duedate($part) -
2593: $self->parmval("opendate", $part);
2594: }
2595: return $self->parmval("opendate");
2596: }
2597: sub sig {
2598: (my $self, my $part) = @_;
2599: return $self->parmval("sig", $part);
2600: }
2601: sub tol {
2602: (my $self, my $part) = @_;
2603: return $self->parmval("tol", $part);
2604: }
1.108 bowersj2 2605: sub tries {
2606: my $self = shift;
2607: my $tries = $self->queryRestoreHash('tries', shift);
2608: if (!defined($tries)) { return '0';}
1.51 bowersj2 2609: return $tries;
2610: }
1.70 bowersj2 2611: sub type {
2612: (my $self, my $part) = @_;
2613: return $self->parmval("type", $part);
2614: }
1.109 bowersj2 2615: sub weight {
2616: my $self = shift; my $part = shift;
1.70 bowersj2 2617: return $self->parmval("weight", $part);
2618: }
1.51 bowersj2 2619:
2620: # Multiple things need this
2621: sub getReturnHash {
2622: my $self = shift;
2623:
2624: if (!defined($self->{RETURN_HASH})) {
1.84 bowersj2 2625: my %tmpHash = &Apache::lonnet::restore($self->symb());
1.51 bowersj2 2626: $self->{RETURN_HASH} = \%tmpHash;
2627: }
2628: }
2629:
2630: ######
2631: # Status queries
2632: ######
2633:
2634: # These methods query the status of problems.
2635:
2636: # If we need to count parts, this function determines the number of
2637: # parts from the metadata. When called, it returns a reference to a list
2638: # of strings corresponding to the parts. (Thus, using it in a scalar context
2639: # tells you how many parts you have in the problem:
2640: # $partcount = scalar($resource->countParts());
2641: # Don't use $self->{PARTS} directly because you don't know if it's been
2642: # computed yet.
2643:
2644: =pod
2645:
2646: =head2 Resource misc
2647:
2648: Misc. functions for the resource.
2649:
2650: =over 4
2651:
1.59 bowersj2 2652: =item * B<hasDiscussion>: Returns a false value if there has been discussion since the user last logged in, true if there has. Always returns false if the discussion data was not extracted when the nav map was constructed.
2653:
2654: =item * B<getFeedback>: Gets the feedback for the resource and returns the raw feedback string for the resource, or the null string if there is no feedback or the email data was not extracted when the nav map was constructed. Usually used like this:
2655:
2656: for (split(/\,/, $res->getFeedback())) {
2657: my $link = &Apache::lonnet::escape($_);
2658: ...
2659:
2660: and use the link as appropriate.
2661:
2662: =cut
2663:
2664: sub hasDiscussion {
2665: my $self = shift;
2666: return $self->{NAV_MAP}->hasDiscussion($self->symb());
2667: }
2668:
2669: sub getFeedback {
2670: my $self = shift;
1.124 bowersj2 2671: my $source = $self->src();
1.125 bowersj2 2672: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
1.124 bowersj2 2673: return $self->{NAV_MAP}->getFeedback($source);
2674: }
2675:
2676: sub getErrors {
2677: my $self = shift;
2678: my $source = $self->src();
2679: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
2680: return $self->{NAV_MAP}->getErrors($source);
1.59 bowersj2 2681: }
2682:
2683: =pod
2684:
1.142 bowersj2 2685: =item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater than two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. Filtering part 0 if you want it is up to you.)
1.51 bowersj2 2686:
1.70 bowersj2 2687: =item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0. Thus, B<parts> may return an array with fewer parts in it then countParts might lead you to believe.
1.51 bowersj2 2688:
2689: =back
2690:
2691: =cut
2692:
2693: sub parts {
2694: my $self = shift;
2695:
1.67 bowersj2 2696: if ($self->ext) { return ['0']; }
2697:
1.51 bowersj2 2698: $self->extractParts();
2699: return $self->{PARTS};
2700: }
2701:
2702: sub countParts {
2703: my $self = shift;
2704:
2705: my $parts = $self->parts();
1.66 bowersj2 2706:
2707: if ($self->{RESOURCE_ERROR}) {
2708: return 0;
2709: }
2710:
2711: if (scalar(@{$parts}) < 2) { return 1;}
1.51 bowersj2 2712:
2713: return scalar(@{$parts}) - 1;
2714: }
2715:
2716: # Private function: Extracts the parts information and saves it
2717: sub extractParts {
2718: my $self = shift;
2719:
1.153 bowersj2 2720: return if (defined($self->{PARTS}));
1.67 bowersj2 2721: return if ($self->ext);
1.51 bowersj2 2722:
2723: $self->{PARTS} = [];
2724:
1.82 bowersj2 2725: # Retrieve part count, if this is a problem
2726: if ($self->is_problem()) {
1.152 matthew 2727: my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
1.82 bowersj2 2728: if (!$metadata) {
2729: $self->{RESOURCE_ERROR} = 1;
2730: $self->{PARTS} = [];
2731: return;
2732: }
2733: foreach (split(/\,/,$metadata)) {
1.152 matthew 2734: if ($_ =~ /^part_(.*)$/) {
1.147 bowersj2 2735: my $part = $1;
2736: # check to see if part is turned off.
1.149 matthew 2737: if (! Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
1.147 bowersj2 2738: push @{$self->{PARTS}}, $1;
2739: }
1.82 bowersj2 2740: }
1.51 bowersj2 2741: }
1.82 bowersj2 2742:
2743:
2744: my @sortedParts = sort @{$self->{PARTS}};
2745: $self->{PARTS} = \@sortedParts;
1.154 bowersj2 2746: }
2747:
1.51 bowersj2 2748: return;
2749: }
2750:
2751: =pod
2752:
2753: =head2 Resource Status
2754:
1.101 bowersj2 2755: Problem resources have status information, reflecting their various dates and completion statuses.
1.51 bowersj2 2756:
2757: There are two aspects to the status: the date-related information and the completion information.
2758:
2759: Idiomatic usage of these two methods would probably look something like
2760:
2761: foreach ($resource->parts()) {
2762: my $dateStatus = $resource->getDateStatus($_);
2763: my $completionStatus = $resource->getCompletionStatus($_);
2764:
1.70 bowersj2 2765: or
2766:
2767: my $status = $resource->status($_);
2768:
1.51 bowersj2 2769: ... use it here ...
2770: }
2771:
1.101 bowersj2 2772: Which you use depends on exactly what you are looking for. The status() function has been optimized for the nav maps display and may not precisely match what you need elsewhere.
2773:
2774: The symbolic constants shown below can be accessed through the resource object: $res->OPEN.
2775:
1.51 bowersj2 2776: =over 4
2777:
1.70 bowersj2 2778: =item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. The possible return values are:
1.51 bowersj2 2779:
2780: =back
2781:
2782: B<Date Codes>
2783:
2784: =over 4
2785:
2786: =item * B<OPEN_LATER>: The problem will be opened later.
2787:
2788: =item * B<OPEN>: Open and not yet due.
2789:
1.59 bowersj2 2790:
1.54 bowersj2 2791: =item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.
2792:
2793: =item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.
1.51 bowersj2 2794:
2795: =item * B<ANSWER_OPEN>: The answer date is here.
2796:
2797: =item * B<NETWORK_FAILURE>: The information is unknown due to network failure.
2798:
2799: =back
2800:
2801: =cut
2802:
2803: # Apparently the compiler optimizes these into constants automatically
1.54 bowersj2 2804: sub OPEN_LATER { return 0; }
2805: sub OPEN { return 1; }
2806: sub PAST_DUE_NO_ANSWER { return 2; }
2807: sub PAST_DUE_ANSWER_LATER { return 3; }
2808: sub ANSWER_OPEN { return 4; }
2809: sub NOTHING_SET { return 5; }
2810: sub NETWORK_FAILURE { return 100; }
2811:
2812: # getDateStatus gets the date status for a given problem part.
2813: # Because answer date, due date, and open date are fully independent
2814: # (i.e., it is perfectly possible to *only* have an answer date),
2815: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
2816: # (past, future, none given). This function handles this with a decision
2817: # tree. Read the comments to follow the decision tree.
1.51 bowersj2 2818:
2819: sub getDateStatus {
2820: my $self = shift;
2821: my $part = shift;
2822: $part = "0" if (!defined($part));
1.54 bowersj2 2823:
2824: # Always return network failure if there was one.
1.51 bowersj2 2825: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2826:
2827: my $now = time();
2828:
1.53 bowersj2 2829: my $open = $self->opendate($part);
2830: my $due = $self->duedate($part);
2831: my $answer = $self->answerdate($part);
2832:
2833: if (!$open && !$due && !$answer) {
2834: # no data on the problem at all
2835: # should this be the same as "open later"? think multipart.
2836: return $self->NOTHING_SET;
2837: }
1.59 bowersj2 2838: if (!$open || $now < $open) {return $self->OPEN_LATER}
2839: if (!$due || $now < $due) {return $self->OPEN}
2840: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
2841: if ($answer) { return $self->ANSWER_OPEN; }
1.54 bowersj2 2842: return PAST_DUE_NO_ANSWER;
1.51 bowersj2 2843: }
2844:
2845: =pod
2846:
2847: B<>
2848:
2849: =over 4
2850:
2851: =item * B<getCompletionStatus>($part): ($part defaults to 0.) A convenience function that returns a symbolic constant telling you about the completion status of the part, with the following possible results:
2852:
2853: =back
2854:
2855: B<Completion Codes>
2856:
2857: =over 4
2858:
2859: =item * B<NOT_ATTEMPTED>: Has not been attempted at all.
2860:
2861: =item * B<INCORRECT>: Attempted, but wrong by student.
2862:
2863: =item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override.
2864:
2865: =item * B<CORRECT>: Correct or correct by instructor.
2866:
2867: =item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override.
2868:
2869: =item * B<EXCUSED>: Excused. Not yet implemented.
2870:
2871: =item * B<NETWORK_FAILURE>: Information not available due to network failure.
2872:
1.69 bowersj2 2873: =item * B<ATTEMPTED>: Attempted, and not yet graded.
2874:
1.51 bowersj2 2875: =back
2876:
2877: =cut
2878:
1.53 bowersj2 2879: sub NOT_ATTEMPTED { return 10; }
2880: sub INCORRECT { return 11; }
2881: sub INCORRECT_BY_OVERRIDE { return 12; }
2882: sub CORRECT { return 13; }
2883: sub CORRECT_BY_OVERRIDE { return 14; }
2884: sub EXCUSED { return 15; }
1.69 bowersj2 2885: sub ATTEMPTED { return 16; }
1.51 bowersj2 2886:
2887: sub getCompletionStatus {
2888: my $self = shift;
2889: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2890:
1.108 bowersj2 2891: my $status = $self->queryRestoreHash('solved', shift);
1.51 bowersj2 2892:
2893: # Left as seperate if statements in case we ever do more with this
2894: if ($status eq 'correct_by_student') {return $self->CORRECT;}
2895: if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; }
2896: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
2897: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
2898: if ($status eq 'excused') {return $self->EXCUSED; }
1.69 bowersj2 2899: if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
1.51 bowersj2 2900: return $self->NOT_ATTEMPTED;
1.108 bowersj2 2901: }
2902:
2903: sub queryRestoreHash {
2904: my $self = shift;
2905: my $hashentry = shift;
2906: my $part = shift;
2907: $part = "0" if (!defined($part));
2908: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
2909:
2910: $self->getReturnHash();
2911:
2912: return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry};
1.51 bowersj2 2913: }
2914:
2915: =pod
2916:
2917: B<Composite Status>
2918:
1.101 bowersj2 2919: Along with directly returning the date or completion status, the resource object includes a convenience function B<status>() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE):
1.51 bowersj2 2920:
2921: =over 4
2922:
1.70 bowersj2 2923: =item * B<NETWORK_FAILURE>: The network has failed and the information is not available.
1.51 bowersj2 2924:
1.70 bowersj2 2925: =item * B<NOTHING_SET>: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".)
1.53 bowersj2 2926:
1.70 bowersj2 2927: =item * B<CORRECT>: For any reason at all, the part is considered correct.
1.51 bowersj2 2928:
1.70 bowersj2 2929: =item * B<EXCUSED>: For any reason at all, the problem is excused.
1.51 bowersj2 2930:
1.70 bowersj2 2931: =item * B<PAST_DUE_NO_ANSWER>: The problem is past due, not considered correct, and no answer date is set.
1.54 bowersj2 2932:
1.70 bowersj2 2933: =item * B<PAST_DUE_ANSWER_LATER>: The problem is past due, not considered correct, and an answer date in the future is set.
1.51 bowersj2 2934:
1.70 bowersj2 2935: =item * B<ANSWER_OPEN>: The problem is past due, not correct, and the answer is now available.
1.51 bowersj2 2936:
1.70 bowersj2 2937: =item * B<OPEN_LATER>: The problem is not yet open.
1.51 bowersj2 2938:
1.70 bowersj2 2939: =item * B<TRIES_LEFT>: The problem is open, has been tried, is not correct, but there are tries left.
1.51 bowersj2 2940:
1.70 bowersj2 2941: =item * B<INCORRECT>: The problem is open, and all tries have been used without getting the correct answer.
1.51 bowersj2 2942:
1.70 bowersj2 2943: =item * B<OPEN>: The item is open and not yet tried.
1.51 bowersj2 2944:
1.70 bowersj2 2945: =item * B<ATTEMPTED>: The problem has been attempted.
1.69 bowersj2 2946:
1.51 bowersj2 2947: =back
2948:
2949: =cut
2950:
2951: sub TRIES_LEFT { return 10; }
2952:
2953: sub status {
2954: my $self = shift;
2955: my $part = shift;
2956: if (!defined($part)) { $part = "0"; }
2957: my $completionStatus = $self->getCompletionStatus($part);
2958: my $dateStatus = $self->getDateStatus($part);
2959:
2960: # What we have is a two-dimensional matrix with 4 entries on one
2961: # dimension and 5 entries on the other, which we want to colorize,
1.54 bowersj2 2962: # plus network failure and "no date data at all".
1.51 bowersj2 2963:
1.53 bowersj2 2964: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
1.51 bowersj2 2965:
2966: # There are a few whole rows we can dispose of:
1.53 bowersj2 2967: if ($completionStatus == CORRECT ||
2968: $completionStatus == CORRECT_BY_OVERRIDE ) {
1.69 bowersj2 2969: return CORRECT;
2970: }
2971:
2972: if ($completionStatus == ATTEMPTED) {
2973: return ATTEMPTED;
1.53 bowersj2 2974: }
2975:
2976: # If it's EXCUSED, then return that no matter what
2977: if ($completionStatus == EXCUSED) {
2978: return EXCUSED;
1.51 bowersj2 2979: }
2980:
1.53 bowersj2 2981: if ($dateStatus == NOTHING_SET) {
2982: return NOTHING_SET;
1.51 bowersj2 2983: }
2984:
1.69 bowersj2 2985: # Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
2986: # by 4 matrix (date statuses).
1.51 bowersj2 2987:
1.54 bowersj2 2988: if ($dateStatus == PAST_DUE_ANSWER_LATER ||
1.59 bowersj2 2989: $dateStatus == PAST_DUE_NO_ANSWER ) {
1.54 bowersj2 2990: return $dateStatus;
1.51 bowersj2 2991: }
2992:
1.53 bowersj2 2993: if ($dateStatus == ANSWER_OPEN) {
2994: return ANSWER_OPEN;
1.51 bowersj2 2995: }
2996:
2997: # Now: (incorrect, incorrect_override, not_attempted) x
2998: # (open_later), (open)
2999:
1.53 bowersj2 3000: if ($dateStatus == OPEN_LATER) {
3001: return OPEN_LATER;
1.51 bowersj2 3002: }
3003:
3004: # If it's WRONG...
1.53 bowersj2 3005: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
1.51 bowersj2 3006: # and there are TRIES LEFT:
1.79 bowersj2 3007: if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) {
1.53 bowersj2 3008: return TRIES_LEFT;
1.51 bowersj2 3009: }
1.53 bowersj2 3010: return INCORRECT; # otherwise, return orange; student can't fix this
1.51 bowersj2 3011: }
3012:
3013: # Otherwise, it's untried and open
1.53 bowersj2 3014: return OPEN;
1.51 bowersj2 3015: }
3016:
3017: =pod
3018:
3019: =head2 Resource/Nav Map Navigation
3020:
3021: =over 4
3022:
1.101 bowersj2 3023: =item * B<getNext>(): Retreive an array of the possible next resources after this one. Always returns an array, even in the one- or zero-element case.
1.85 bowersj2 3024:
1.101 bowersj2 3025: =item * B<getPrevious>(): Retreive an array of the possible previous resources from this one. Always returns an array, even in the one- or zero-element case.
1.51 bowersj2 3026:
3027: =cut
3028:
3029: sub getNext {
3030: my $self = shift;
3031: my @branches;
3032: my $to = $self->to();
1.85 bowersj2 3033: foreach my $branch ( split(/,/, $to) ) {
1.51 bowersj2 3034: my $choice = $self->{NAV_MAP}->getById($branch);
3035: my $next = $choice->goesto();
3036: $next = $self->{NAV_MAP}->getById($next);
3037:
1.131 bowersj2 3038: push @branches, $next;
1.85 bowersj2 3039: }
3040: return \@branches;
3041: }
3042:
3043: sub getPrevious {
3044: my $self = shift;
3045: my @branches;
3046: my $from = $self->from();
3047: foreach my $branch ( split /,/, $from) {
3048: my $choice = $self->{NAV_MAP}->getById($branch);
3049: my $prev = $choice->comesfrom();
3050: $prev = $self->{NAV_MAP}->getById($prev);
3051:
1.131 bowersj2 3052: push @branches, $prev;
1.51 bowersj2 3053: }
3054: return \@branches;
1.131 bowersj2 3055: }
3056:
3057: sub browsePriv {
3058: my $self = shift;
3059: if (defined($self->{BROWSE_PRIV})) {
3060: return $self->{BROWSE_PRIV};
3061: }
3062:
3063: $self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre', $self->src());
1.51 bowersj2 3064: }
3065:
3066: =pod
1.2 www 3067:
1.51 bowersj2 3068: =back
1.2 www 3069:
1.51 bowersj2 3070: =cut
1.2 www 3071:
1.51 bowersj2 3072: 1;
1.2 www 3073:
1.51 bowersj2 3074: __END__
1.2 www 3075:
3076:
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