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