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