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