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