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