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