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