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