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