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