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