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