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