1: # The LearningOnline Network with CAPA
2: # Navigate Maps Handler
3: #
4: # $Id: lonnavmaps.pm,v 1.444.2.1 2010/05/18 20:30:08 raeburn Exp $
5:
6: #
7: # Copyright Michigan State University Board of Trustees
8: #
9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
10: #
11: # LON-CAPA is free software; you can redistribute it and/or modify
12: # it under the terms of the GNU General Public License as published by
13: # the Free Software Foundation; either version 2 of the License, or
14: # (at your option) any later version.
15: #
16: # LON-CAPA is distributed in the hope that it will be useful,
17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19: # GNU General Public License for more details.
20: #
21: # You should have received a copy of the GNU General Public License
22: # along with LON-CAPA; if not, write to the Free Software
23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24: #
25: # /home/httpd/html/adm/gpl.txt
26: #
27: # http://www.lon-capa.org/
28: #
29: ###
30:
31: =pod
32:
33: =head1 NAME
34:
35: Apache::lonnavmaps - Subroutines to handle and render the navigation
36:
37: =head1 SYNOPSIS
38:
39: Handles navigational maps.
40:
41: The main handler generates the navigational listing for the course,
42: the other objects export this information in a usable fashion for
43: other modules.
44:
45:
46: This is part of the LearningOnline Network with CAPA project
47: described at http://www.lon-capa.org.
48:
49:
50: =head1 OVERVIEW
51:
52: X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the
53: course structure and caches it in what is often referred to as the
54: "big hash" X<big hash>. You can see it if you are logged into
55: LON-CAPA, in a course, by going to /adm/test. (You may need to
56: tweak the /home/httpd/lonTabs/htpasswd file to view it.) The
57: content of the hash will be under the heading "Big Hash".
58:
59: Big Hash contains, among other things, how resources are related
60: to each other (next/previous), what resources are maps, which
61: resources are being chosen to not show to the student (for random
62: selection), and a lot of other things that can take a lot of time
63: to compute due to the amount of data that needs to be collected and
64: processed.
65:
66: Apache::lonnavmaps provides an object model for manipulating this
67: information in a higher-level fashion than directly manipulating
68: the hash. It also provides access to several auxilary functions
69: that aren't necessarily stored in the Big Hash, but are a per-
70: resource sort of value, like whether there is any feedback on
71: a given resource.
72:
73: Apache::lonnavmaps also abstracts away branching, and someday,
74: conditions, for the times where you don't really care about those
75: things.
76:
77: Apache::lonnavmaps also provides fairly powerful routines for
78: rendering navmaps, and last but not least, provides the navmaps
79: view for when the user clicks the NAV button.
80:
81: B<Note>: Apache::lonnavmaps I<only> works for the "currently
82: logged in user"; if you want things like "due dates for another
83: student" lonnavmaps can not directly retrieve information like
84: that. You need the EXT function. This module can still help,
85: because many things, such as the course structure, are constant
86: between users, and Apache::lonnavmaps can help by providing
87: symbs for the EXT call.
88:
89: The rest of this file will cover the provided rendering routines,
90: which can often be used without fiddling with the navmap object at
91: all, then documents the Apache::lonnavmaps::navmap object, which
92: is the key to accessing the Big Hash information, covers the use
93: of the Iterator (which provides the logic for traversing the
94: somewhat-complicated Big Hash data structure), documents the
95: Apache::lonnavmaps::Resource objects that are returned by
96:
97: =head1 Subroutine: render
98:
99: The navmap renderer package provides a sophisticated rendering of the
100: standard navigation maps interface into HTML. The provided nav map
101: handler is actually just a glorified call to this.
102:
103: Because of the large number of parameters this function accepts,
104: instead of passing it arguments as is normal, pass it in an anonymous
105: hash with the desired options.
106:
107: The package provides a function called 'render', called as
108: Apache::lonnavmaps::render({}).
109:
110: =head2 Overview of Columns
111:
112: The renderer will build an HTML table for the navmap and return
113: it. The table consists of several columns, and a row for each
114: resource (or possibly each part). You tell the renderer how many
115: columns to create and what to place in each column, optionally using
116: one or more of the prepared columns, and the renderer will assemble
117: the table.
118:
119: Any additional generally useful column types should be placed in the
120: renderer code here, so anybody can use it anywhere else. Any code
121: specific to the current application (such as the addition of <input>
122: elements in a column) should be placed in the code of the thing using
123: the renderer.
124:
125: At the core of the renderer is the array reference COLS (see Example
126: section below for how to pass this correctly). The COLS array will
127: consist of entries of one of two types of things: Either an integer
128: representing one of the pre-packaged column types, or a sub reference
129: that takes a resource reference, a part number, and a reference to the
130: argument hash passed to the renderer, and returns a string that will
131: be inserted into the HTML representation as it.
132:
133: All other parameters are ways of either changing how the columns
134: are printing, or which rows are shown.
135:
136: The pre-packaged column names are refered to by constants in the
137: Apache::lonnavmaps namespace. The following currently exist:
138:
139: =over 4
140:
141: =item * B<Apache::lonnavmaps::resource>:
142:
143: The general info about the resource: Link, icon for the type, etc. The
144: first column in the standard nav map display. This column provides the
145: indentation effect seen in the B<NAV> screen. This column also accepts
146: the following parameters in the renderer hash:
147:
148: =over 4
149:
150: =item * B<resource_nolink>: default false
151:
152: If true, the resource will not be linked. By default, all non-folder
153: resources are linked.
154:
155: =item * B<resource_part_count>: default true
156:
157: If true, the resource will show a part count B<if> the full
158: part list is not displayed. (See "condense_parts" later.) If false,
159: the resource will never show a part count.
160:
161: =item * B<resource_no_folder_link>:
162:
163: If true, the resource's folder will not be clickable to open or close
164: it. Default is false. True implies printCloseAll is false, since you
165: can't close or open folders when this is on anyhow.
166:
167: =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:
482: use POSIX qw (floor strftime);
483: use Time::HiRes qw( gettimeofday tv_interval );
484: use LONCAPA;
485: use DateTime();
486:
487: # symbolic constants
488: sub SYMB { return 1; }
489: sub URL { return 2; }
490: sub NOTHING { return 3; }
491:
492: # Some data
493:
494: my $resObj = "Apache::lonnavmaps::resource";
495:
496: # Keep these mappings in sync with lonquickgrades, which usesthe colors
497: # instead of the icons.
498: my %statusIconMap =
499: (
500: $resObj->CLOSED => '',
501: $resObj->OPEN => 'navmap.open.gif',
502: $resObj->CORRECT => 'navmap.correct.gif',
503: $resObj->PARTIALLY_CORRECT => 'navmap.partial.gif',
504: $resObj->INCORRECT => 'navmap.wrong.gif',
505: $resObj->ATTEMPTED => 'navmap.ellipsis.gif',
506: $resObj->ERROR => ''
507: );
508:
509: my %iconAltTags = #texthash does not work here
510: ( 'navmap.correct.gif' => 'Correct',
511: 'navmap.wrong.gif' => 'Incorrect',
512: 'navmap.open.gif' => 'Open',
513: 'navmap.partial.gif' => 'Partially Correct',
514: 'navmap.ellipsis.gif' => 'Attempted',
515: );
516:
517: # Defines a status->color mapping, null string means don't color
518: my %colormap =
519: ( $resObj->NETWORK_FAILURE => '',
520: $resObj->CORRECT => '',
521: $resObj->EXCUSED => '#3333FF',
522: $resObj->PAST_DUE_ANSWER_LATER => '',
523: $resObj->PAST_DUE_NO_ANSWER => '',
524: $resObj->ANSWER_OPEN => '#006600',
525: $resObj->OPEN_LATER => '',
526: $resObj->TRIES_LEFT => '',
527: $resObj->INCORRECT => '',
528: $resObj->OPEN => '',
529: $resObj->NOTHING_SET => '',
530: $resObj->ATTEMPTED => '',
531: $resObj->ANSWER_SUBMITTED => '',
532: $resObj->PARTIALLY_CORRECT => '#006600'
533: );
534: # And a special case in the nav map; what to do when the assignment
535: # is not yet done and due in less than 24 hours
536: my $hurryUpColor = "#FF0000";
537:
538: my $future_slots_checked = 0;
539: my $future_slots = 0;
540:
541: sub close {
542: if ($env{'environment.remotenavmap'} ne 'on') { return ''; }
543: return(<<ENDCLOSE);
544: <script type="text/javascript">
545: window.status='Accessing Nav Control';
546: menu=window.open("/adm/rat/empty.html","loncapanav",
547: "height=600,width=400,scrollbars=1");
548: window.status='Closing Nav Control';
549: menu.close();
550: window.status='Done.';
551: </script>
552: ENDCLOSE
553: }
554:
555: sub update {
556: if ($env{'environment.remotenavmap'} ne 'on') { return ''; }
557: if (!$env{'request.course.id'}) { return ''; }
558: if ($ENV{'REQUEST_URI'}=~m|^/adm/navmaps|) { return ''; }
559: return(<<ENDUPDATE);
560: <form name="navform"></form>
561: <script type="text/javascript">
562: this.document.navform.action='/adm/navmaps#curloc';
563: this.document.navform.target='loncapanav';
564: this.document.navform.submit();
565: </script>
566: ENDUPDATE
567: }
568:
569:
570: sub addToFilter {
571: my $hashIn = shift;
572: my $addition = shift;
573: my %hash = %$hashIn;
574: $hash{$addition} = 1;
575:
576: return join (",", keys(%hash));
577: }
578:
579: sub removeFromFilter {
580: my $hashIn = shift;
581: my $subtraction = shift;
582: my %hash = %$hashIn;
583:
584: delete $hash{$subtraction};
585: return join(",", keys(%hash));
586: }
587:
588: sub getLinkForResource {
589: my $stack = shift;
590: my $res;
591:
592: # Check to see if there are any pages in the stack
593: foreach $res (@$stack) {
594: if (defined($res)) {
595: my $anchor;
596: if ($res->is_page()) {
597: foreach my $item (@$stack) { if (defined($item)) { $anchor = $item; } }
598: $anchor=&escape($anchor->shown_symb());
599: return ($res->link(),$res->shown_symb(),$anchor);
600: }
601: # in case folder was skipped over as "only sequence"
602: my ($map,$id,$src)=&Apache::lonnet::decode_symb($res->symb());
603: if ($map=~/\.page$/) {
604: my $url=&Apache::lonnet::clutter($map);
605: $anchor=&escape($res->shown_symb());
606: return ($url,$res->shown_symb(),$anchor);
607: }
608: }
609: }
610:
611: # Failing that, return the src of the last resource that is defined
612: # (when we first recurse on a map, it puts an undefined resource
613: # on the bottom because $self->{HERE} isn't defined yet, and we
614: # want the src for the map anyhow)
615: foreach my $item (@$stack) {
616: if (defined($item)) { $res = $item; }
617: }
618:
619: if ($res) {
620: return ($res->link(),$res->shown_symb());
621: }
622: return;
623: }
624:
625:
626:
627: sub getDescription {
628: my $res = shift;
629: my $part = shift;
630: my $status = $res->status($part);
631:
632: my $open = $res->opendate($part);
633: my $due = $res->duedate($part);
634: my $answer = $res->answerdate($part);
635:
636: if ($status == $res->NETWORK_FAILURE) {
637: return &mt("Having technical difficulties; please check status later");
638: }
639: if ($status == $res->NOTHING_SET) {
640: return &mt("Not currently assigned.");
641: }
642: if ($status == $res->OPEN_LATER) {
643: return &mt("Open ") .timeToHumanString($open,'start');
644: }
645: if ($res->simpleStatus($part) == $res->OPEN) {
646: unless (&Apache::lonnet::allowed('mgr',$env{'request.course.id'})) {
647: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
648: if ($slot_status == $res->UNKNOWN) {
649: return &mt('Reservation status unknown');
650: } elsif ($slot_status == $res->RESERVED) {
651: return &mt('Reserved - ends [_1]',
652: timeToHumanString($slot_time,'end'));
653: } elsif ($slot_status == $res->RESERVED_LOCATION) {
654: return &mt('Reserved - specific location(s) - ends [_1]',
655: timeToHumanString($slot_time,'end'));
656: } elsif ($slot_status == $res->RESERVED_LATER) {
657: return &mt('Reserved - next open [_1]',
658: timeToHumanString($slot_time,'start'));
659: } elsif ($slot_status == $res->RESERVABLE) {
660: return &mt('Reservable ending [_1]',
661: timeToHumanString($slot_time,'end'));
662: } elsif ($slot_status == $res->RESERVABLE_LATER) {
663: return &mt('Reservable starting [_1]',
664: timeToHumanString($slot_time,'start'));
665: } elsif ($slot_status == $res->NOT_IN_A_SLOT) {
666: return &mt('Reserve a time/place to work');
667: } elsif ($slot_status == $res->NOTRESERVABLE) {
668: return &mt('Reservation not available');
669: } elsif ($slot_status == $res->WAITING_FOR_GRADE) {
670: return &mt('Submission in grading queue');
671: }
672: }
673: }
674: if ($status == $res->OPEN) {
675: if ($due) {
676: if ($res->is_practice()) {
677: return &mt("Closes ")." " .timeToHumanString($due,'start');
678: } else {
679: return &mt("Due")." " .timeToHumanString($due,'end');
680: }
681: } else {
682: return &mt("Open, no due date");
683: }
684: }
685: if ($status == $res->PAST_DUE_ANSWER_LATER) {
686: return &mt("Answer open")." " .timeToHumanString($answer,'start');
687: }
688: if ($status == $res->PAST_DUE_NO_ANSWER) {
689: if ($res->is_practice()) {
690: return &mt("Closed")." " . timeToHumanString($due,'start');
691: } else {
692: return &mt("Was due")." " . timeToHumanString($due,'end');
693: }
694: }
695: if (($status == $res->ANSWER_OPEN || $status == $res->PARTIALLY_CORRECT)
696: && $res->handgrade($part) ne 'yes') {
697: return &mt("Answer available");
698: }
699: if ($status == $res->EXCUSED) {
700: return &mt("Excused by instructor");
701: }
702: if ($status == $res->ATTEMPTED) {
703: if ($res->is_anonsurvey($part) || $res->is_survey($part)) {
704: return &mt("Survey submission recorded");
705: } else {
706: return &mt("Answer submitted, not yet graded");
707: }
708: }
709: if ($status == $res->TRIES_LEFT) {
710: my $tries = $res->tries($part);
711: my $maxtries = $res->maxtries($part);
712: my $triesString = "";
713: if ($tries && $maxtries) {
714: $triesString = '<font size="-1"><i>('.&mt('[_1] of [quant,_2,try,tries] used',$tries,$maxtries).')</i></font>';
715: if ($maxtries > 1 && $maxtries - $tries == 1) {
716: $triesString = "<b>$triesString</b>";
717: }
718: }
719: if ($due) {
720: return &mt("Due")." " . timeToHumanString($due,'end') .
721: " $triesString";
722: } else {
723: return &mt("No due date")." $triesString";
724: }
725: }
726: if ($status == $res->ANSWER_SUBMITTED) {
727: return &mt('Answer submitted');
728: }
729: }
730:
731:
732: sub dueInLessThan24Hours {
733: my $res = shift;
734: my $part = shift;
735: my $status = $res->status($part);
736:
737: return ($status == $res->OPEN() ||
738: $status == $res->TRIES_LEFT()) &&
739: $res->duedate($part) && $res->duedate($part) < time()+(24*60*60) &&
740: $res->duedate($part) > time();
741: }
742:
743:
744: sub lastTry {
745: my $res = shift;
746: my $part = shift;
747:
748: my $tries = $res->tries($part);
749: my $maxtries = $res->maxtries($part);
750: return $tries && $maxtries && $maxtries > 1 &&
751: $maxtries - $tries == 1 && $res->duedate($part) &&
752: $res->duedate($part) > time();
753: }
754:
755:
756: sub advancedUser {
757: return $env{'request.role.adv'};
758: }
759:
760: sub timeToHumanString {
761: my ($time,$type,$format) = @_;
762:
763: # zero, '0' and blank are bad times
764: if (!$time) {
765: return &mt('never');
766: }
767: unless (&Apache::lonlocal::current_language()=~/^en/) {
768: return &Apache::lonlocal::locallocaltime($time);
769: }
770: my $now = time();
771:
772: # Positive = future
773: my $delta = $time - $now;
774:
775: my $minute = 60;
776: my $hour = 60 * $minute;
777: my $day = 24 * $hour;
778: my $week = 7 * $day;
779: my $inPast = 0;
780:
781: # Logic in comments:
782: # Is it now? (extremely unlikely)
783: if ( $delta == 0 ) {
784: return "this instant";
785: }
786:
787: if ($delta < 0) {
788: $inPast = 1;
789: $delta = -$delta;
790: }
791:
792: if ( $delta > 0 ) {
793:
794: my $tense = $inPast ? " ago" : "";
795: my $prefix = $inPast ? "" : "in ";
796:
797: # Less than a minute
798: if ( $delta < $minute ) {
799: if ($delta == 1) { return "${prefix}1 second$tense"; }
800: return "$prefix$delta seconds$tense";
801: }
802:
803: # Less than an hour
804: if ( $delta < $hour ) {
805: # If so, use minutes
806: my $minutes = floor($delta / 60);
807: if ($minutes == 1) { return "${prefix}1 minute$tense"; }
808: return "$prefix$minutes minutes$tense";
809: }
810:
811: # Is it less than 24 hours away? If so,
812: # display hours + minutes
813: if ( $delta < $hour * 24) {
814: my $hours = floor($delta / $hour);
815: my $minutes = floor(($delta % $hour) / $minute);
816: my $hourString = "$hours hours";
817: my $minuteString = ", $minutes minutes";
818: if ($hours == 1) {
819: $hourString = "1 hour";
820: }
821: if ($minutes == 1) {
822: $minuteString = ", 1 minute";
823: }
824: if ($minutes == 0) {
825: $minuteString = "";
826: }
827: return "$prefix$hourString$minuteString$tense";
828: }
829:
830: my $dt = DateTime->from_epoch(epoch => $time)
831: ->set_time_zone(&Apache::lonlocal::gettimezone());
832:
833: # If there's a caller supplied format, use it.
834:
835: if ($format ne '') {
836: my $timeStr = $dt->strftime($format);
837: return $timeStr.' ('.$dt->time_zone_short_name().')';
838: }
839:
840: # Less than 5 days away, display day of the week and
841: # HH:MM
842:
843: if ( $delta < $day * 5 ) {
844: my $timeStr = $dt->strftime("%A, %b %e at %I:%M %P (%Z)");
845: $timeStr =~ s/12:00 am/00:00/;
846: $timeStr =~ s/12:00 pm/noon/;
847: return ($inPast ? "last " : "this ") .
848: $timeStr;
849: }
850:
851: my $conjunction='on';
852: if ($type eq 'start') {
853: $conjunction='at';
854: } elsif ($type eq 'end') {
855: $conjunction='by';
856: }
857: # Is it this year?
858: my $dt_now = DateTime->from_epoch(epoch => $now)
859: ->set_time_zone(&Apache::lonlocal::gettimezone());
860: if ( $dt->year() == $dt_now->year()) {
861: # Return on Month Day, HH:MM meridian
862: my $timeStr = $dt->strftime("$conjunction %A, %b %e at %I:%M %P (%Z)");
863: $timeStr =~ s/12:00 am/00:00/;
864: $timeStr =~ s/12:00 pm/noon/;
865: return $timeStr;
866: }
867:
868: # Not this year, so show the year
869: my $timeStr =
870: $dt->strftime("$conjunction %A, %b %e %Y at %I:%M %P (%Z)");
871: $timeStr =~ s/12:00 am/00:00/;
872: $timeStr =~ s/12:00 pm/noon/;
873: return $timeStr;
874: }
875: }
876:
877:
878: sub resource { return 0; }
879: sub communication_status { return 1; }
880: sub quick_status { return 2; }
881: sub long_status { return 3; }
882: sub part_status_summary { return 4; }
883:
884: sub render_resource {
885: my ($resource, $part, $params) = @_;
886:
887: my $nonLinkedText = ''; # stuff after resource title not in link
888:
889: my $link = $params->{"resourceLink"};
890:
891: # The URL part is not escaped at this point, but the symb is...
892:
893: my $src = $resource->src();
894: my $it = $params->{"iterator"};
895: my $filter = $it->{FILTER};
896:
897: my $title = $resource->compTitle();
898:
899: my $partLabel = "";
900: my $newBranchText = "";
901: my $location=&Apache::loncommon::lonhttpdurl("/adm/lonIcons");
902: # If this is a new branch, label it so
903: if ($params->{'isNewBranch'}) {
904: $newBranchText = "<img src='$location/branch.gif' alt=".mt('Branch')." />";
905: }
906:
907: # links to open and close the folder
908:
909: my $whitespace = $location.'/whitespace_21.gif';
910: my $linkopen = "<img src='$whitespace' alt='' />"."<a href=\"$link\">";
911: my $linkclose = "</a>";
912:
913: # Default icon: unknown page
914: my $icon = "<img class=\"LC_contentImage\" src='$location/unknown.gif' alt='' />";
915:
916: if ($resource->is_problem()) {
917: if ($part eq '0' || $params->{'condensed'}) {
918: $icon = '<img class="LC_contentImage" src="'.$location.'/';
919: if ($resource->is_task()) {
920: $icon .= 'task.gif" alt="'.&mt('Task');
921: } else {
922: $icon .= 'problem.gif" alt="'.&mt('Problem');
923: }
924: $icon .='" />';
925: } else {
926: $icon = $params->{'indentString'};
927: }
928: } else {
929: $icon = "<img class=\"LC_contentImage\" src='".&Apache::loncommon::icon($resource->src)."' alt='' />";
930: }
931:
932: # Display the correct map icon to open or shut map
933: if ($resource->is_map()) {
934: my $mapId = $resource->map_pc();
935: my $nowOpen = !defined($filter->{$mapId});
936: if ($it->{CONDITION}) {
937: $nowOpen = !$nowOpen;
938: }
939:
940: my $folderType = $resource->is_sequence() ? 'folder' : 'page';
941: my $title=$resource->title;
942: $title=~s/\"/\&qout;/g;
943: if (!$params->{'resource_no_folder_link'}) {
944: $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif';
945: $icon = "<img src='$location/arrow." . ($nowOpen ? 'closed' : 'open') . ".gif' alt='' />"
946: ."<img class=\"LC_contentImage\" src='$location/$icon' alt=\""
947: .($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" />";
948: $linkopen = "<a href=\"" . $params->{'url'} . '?' .
949: $params->{'queryString'} . '&filter=';
950: $linkopen .= ($nowOpen xor $it->{CONDITION}) ?
951: addToFilter($filter, $mapId) :
952: removeFromFilter($filter, $mapId);
953: $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
954: . $params->{'hereType'} . '&here=' .
955: &escape($params->{'here'}) .
956: '&jump=' .
957: &escape($resource->symb()) .
958: "&folderManip=1\">";
959:
960: } else {
961: # Don't allow users to manipulate folder
962: $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif';
963: $icon = "<img class=\"LC_space\" src='$whitespace' alt='' />"."<img class=\"LC_contentImage\" src='$location/$icon' alt=\"".($nowOpen ? &mt('Open Folder') : &mt('Close Folder')).' '.$title."\" />";
964:
965: $linkopen = "";
966: $linkclose = "";
967: }
968: }
969:
970: if ($resource->randomout()) {
971: $nonLinkedText .= ' <i>('.&mt('hidden').')</i> ';
972: }
973: if (!$resource->condval()) {
974: $nonLinkedText .= ' <i>('.&mt('conditionally hidden').')</i> ';
975: }
976: if (($resource->is_practice()) && ($resource->is_raw_problem())) {
977: $nonLinkedText .=' <font color="green"><b>'.&mt('not graded').'</b></font>';
978: }
979:
980: # We're done preparing and finally ready to start the rendering
981: my $result = '<td class="LC_middle">';
982: my $newfolderType = $resource->is_sequence() ? 'folder' : 'page';
983:
984: my $indentLevel = $params->{'indentLevel'};
985: if ($newBranchText) { $indentLevel--; }
986:
987: # print indentation
988: for (my $i = 0; $i < $indentLevel; $i++) {
989: $result .= $params->{'indentString'};
990: }
991:
992: # Decide what to display
993: $result .= "$newBranchText$linkopen$icon$linkclose";
994:
995: my $curMarkerBegin = '';
996: my $curMarkerEnd = '';
997:
998: # Is this the current resource?
999: if (!$params->{'displayedHereMarker'} &&
1000: $resource->symb() eq $params->{'here'} ) {
1001: $curMarkerBegin = '<em>';
1002: $curMarkerEnd = '</em>';
1003: $params->{'displayedHereMarker'} = 1;
1004: }
1005:
1006: if ($resource->is_problem() && $part ne '0' &&
1007: !$params->{'condensed'}) {
1008: my $displaypart=$resource->part_display($part);
1009: $partLabel = " (".&mt('Part: [_1]', $displaypart).")";
1010: if ($link!~/\#/) { $link.='#'.&escape($part); }
1011: $title = "";
1012: }
1013:
1014: if ($params->{'condensed'} && $resource->countParts() > 1) {
1015: $nonLinkedText .= ' ('.&mt('[_1] parts', $resource->countParts()).')';
1016: }
1017:
1018: my $target;
1019: if ($env{'environment.remotenavmap'} eq 'on') {
1020: $target=' target="loncapaclient" ';
1021: }
1022: if (!$params->{'resource_nolink'} && !$resource->is_sequence() && !$resource->is_empty_sequence) {
1023: $result .= "$curMarkerBegin<a $target href=\"$link\">$title$partLabel</a>$curMarkerEnd$nonLinkedText</td>";
1024: } else {
1025: $result .= "$curMarkerBegin$linkopen$title$partLabel</a>$curMarkerEnd$nonLinkedText</td>";
1026: }
1027:
1028: return $result;
1029: }
1030:
1031: sub render_communication_status {
1032: my ($resource, $part, $params) = @_;
1033: my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = "";
1034:
1035: my $link = $params->{"resourceLink"};
1036: my $target;
1037: if ($env{'environment.remotenavmap'} eq 'on') {
1038: $target=' target="loncapaclient" ';
1039: }
1040: my $linkopen = "<a $target href=\"$link\">";
1041: my $linkclose = "</a>";
1042: my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");
1043: if ($resource->hasDiscussion()) {
1044: $discussionHTML = $linkopen .
1045: '<img alt="'.&mt('New Discussion').'" src="'.$location.'/chat.gif" title="'.&mt('New Discussion').'"/>' .
1046: $linkclose;
1047: }
1048:
1049: if ($resource->getFeedback()) {
1050: my $feedback = $resource->getFeedback();
1051: foreach my $msgid (split(/\,/, $feedback)) {
1052: if ($msgid) {
1053: $feedbackHTML .= ' <a '.$target.' href="/adm/email?display='
1054: . &escape($msgid) . '">'
1055: . '<img alt="'.&mt('New E-mail').'" src="'.$location.'/feedback.gif" title="'.&mt('New E-mail').'"/></a>';
1056: }
1057: }
1058: }
1059:
1060: if ($resource->getErrors()) {
1061: my $errors = $resource->getErrors();
1062: my $errorcount = 0;
1063: foreach my $msgid (split(/,/, $errors)) {
1064: last if ($errorcount>=10); # Only output 10 bombs maximum
1065: if ($msgid) {
1066: $errorcount++;
1067: $errorHTML .= ' <a '.$target.' href="/adm/email?display='
1068: . &escape($msgid) . '">'
1069: . '<img alt="'.&mt('New Error').'" src="'.$location.'/bomb.gif" title="'.&mt('New Error').'"/></a>';
1070: }
1071: }
1072: }
1073:
1074: if ($params->{'multipart'} && $part != '0') {
1075: $discussionHTML = $feedbackHTML = $errorHTML = '';
1076: }
1077: return "<td class=\"LC_middle\">$discussionHTML$feedbackHTML$errorHTML </td>";
1078:
1079: }
1080: sub render_quick_status {
1081: my ($resource, $part, $params) = @_;
1082: my $result = "";
1083: my $firstDisplayed = !$params->{'condensed'} &&
1084: $params->{'multipart'} && $part eq "0";
1085:
1086: my $link = $params->{"resourceLink"};
1087: my $target;
1088: if ($env{'environment.remotenavmap'} eq 'on') {
1089: $target=' target="loncapaclient" ';
1090: }
1091: my $linkopen = "<a $target href=\"$link\">";
1092: my $linkclose = "</a>";
1093:
1094: $result .= '<td class="LC_middle">';
1095: if ($resource->is_problem() &&
1096: !$firstDisplayed) {
1097: my $icon = $statusIconMap{$resource->simpleStatus($part)};
1098: my $alt = $iconAltTags{$icon};
1099: if ($icon) {
1100: my $location=
1101: &Apache::loncommon::lonhttpdurl("/adm/lonIcons/$icon");
1102: $result .= $linkopen.'<img src="'.$location.'" alt="'.&mt($alt).'" title="'.&mt($alt).'" />'.$linkclose;
1103: } else {
1104: $result .= " ";
1105: }
1106: } else { # not problem, no icon
1107: $result .= " ";
1108: }
1109: $result .= "</td>\n";
1110: return $result;
1111: }
1112: sub render_long_status {
1113: my ($resource, $part, $params) = @_;
1114: my $result = '<td class="LC_middle LC_right">';
1115: my $firstDisplayed = !$params->{'condensed'} &&
1116: $params->{'multipart'} && $part eq "0";
1117:
1118: my $color;
1119: if ($resource->is_problem() || $resource->is_practice()) {
1120: $color = $colormap{$resource->status};
1121:
1122: if (dueInLessThan24Hours($resource, $part) ||
1123: lastTry($resource, $part)) {
1124: $color = $hurryUpColor;
1125: }
1126: }
1127:
1128: if ($resource->kind() eq "res" &&
1129: ($resource->is_problem() || $resource->is_practice()) &&
1130: !$firstDisplayed) {
1131: if ($color) {$result .= "<font color=\"$color\"><b>"; }
1132: $result .= getDescription($resource, $part);
1133: if ($color) {$result .= "</b></font>"; }
1134: }
1135: if ($resource->is_map() && &advancedUser() && $resource->randompick()) {
1136: $result .= &mt('(randomly select [_1])', $resource->randompick());
1137: }
1138: if ($resource->is_map() && &advancedUser() && $resource->randomorder()) {
1139: $result .= &mt('(randomly ordered)');
1140: }
1141:
1142: # Debugging code
1143: #$result .= " " . $resource->awarded($part) . '/' . $resource->weight($part) .
1144: # ' - Part: ' . $part;
1145:
1146: $result .= "</td>\n";
1147:
1148: return $result;
1149: }
1150:
1151: # Colors obtained by taking the icons, matching the colors, and
1152: # possibly reducing the Value (HSV) of the color, if it's too bright
1153: # for text, generally by one third or so.
1154: my %statusColors =
1155: (
1156: $resObj->CLOSED => '#000000',
1157: $resObj->OPEN => '#998b13',
1158: $resObj->CORRECT => '#26933f',
1159: $resObj->INCORRECT => '#c48207',
1160: $resObj->ATTEMPTED => '#a87510',
1161: $resObj->ERROR => '#000000'
1162: );
1163: my %statusStrings =
1164: (
1165: $resObj->CLOSED => 'Not yet open',
1166: $resObj->OPEN => 'Open',
1167: $resObj->CORRECT => 'Correct',
1168: $resObj->INCORRECT => 'Incorrect',
1169: $resObj->ATTEMPTED => 'Attempted',
1170: $resObj->ERROR => 'Network Error'
1171: );
1172: my @statuses = ($resObj->CORRECT, $resObj->ATTEMPTED, $resObj->INCORRECT, $resObj->OPEN, $resObj->CLOSED, $resObj->ERROR);
1173:
1174: sub render_parts_summary_status {
1175: my ($resource, $part, $params) = @_;
1176: if (!$resource->is_problem() && !$resource->contains_problem) { return '<td></td>'; }
1177: if ($params->{showParts}) {
1178: return '<td></td>';
1179: }
1180:
1181: my $td = "<td align='right'>\n";
1182: my $endtd = "</td>\n";
1183: my @probs;
1184:
1185: if ($resource->contains_problem) {
1186: @probs=$resource->retrieveResources($resource,sub { $_[0]->is_problem() },1,0);
1187: } else {
1188: @probs=($resource);
1189: }
1190: my $return;
1191: my %overallstatus;
1192: my $totalParts;
1193: foreach my $resource (@probs) {
1194: # If there is a single part, just show the simple status
1195: if ($resource->singlepart()) {
1196: my $status = $resource->simpleStatus(${$resource->parts}[0]);
1197: $overallstatus{$status}++;
1198: $totalParts++;
1199: next;
1200: }
1201: # Now we can be sure the $part doesn't really matter.
1202: my $statusCount = $resource->simpleStatusCount();
1203: my @counts;
1204: foreach my $status (@statuses) {
1205: # decouple display order from the simpleStatusCount order
1206: my $slot = Apache::lonnavmaps::resource::statusToSlot($status);
1207: if ($statusCount->[$slot]) {
1208: $overallstatus{$status}+=$statusCount->[$slot];
1209: $totalParts+=$statusCount->[$slot];
1210: }
1211: }
1212: }
1213: $return.= $td . $totalParts . ' parts: ';
1214: foreach my $status (@statuses) {
1215: if ($overallstatus{$status}) {
1216: $return.="<font color='" . $statusColors{$status} .
1217: "'>" . $overallstatus{$status} . ' '
1218: . $statusStrings{$status} . "</font>";
1219: }
1220: }
1221: $return.= $endtd;
1222: return $return;
1223: }
1224:
1225: my @preparedColumns = (\&render_resource, \&render_communication_status,
1226: \&render_quick_status, \&render_long_status,
1227: \&render_parts_summary_status);
1228:
1229: sub setDefault {
1230: my ($val, $default) = @_;
1231: if (!defined($val)) { return $default; }
1232: return $val;
1233: }
1234:
1235: sub cmp_title {
1236: my ($atitle,$btitle) = (lc($_[0]->compTitle),lc($_[1]->compTitle));
1237: $atitle=~s/^\s*//;
1238: $btitle=~s/^\s*//;
1239: return $atitle cmp $btitle;
1240: }
1241:
1242: sub render {
1243: my $args = shift;
1244: &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
1245: my $result = '';
1246: # Configure the renderer.
1247: my $cols = $args->{'cols'};
1248: if (!defined($cols)) {
1249: # no columns, no nav maps.
1250: return '';
1251: }
1252: my $navmap;
1253: if (defined($args->{'navmap'})) {
1254: $navmap = $args->{'navmap'};
1255: }
1256:
1257: my $r = $args->{'r'};
1258: my $queryString = $args->{'queryString'};
1259: my $jump = $args->{'jump'};
1260: my $here = $args->{'here'};
1261: my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0);
1262: my $closeAllPages = setDefault($args->{'closeAllPages'}, 0);
1263: my $currentJumpDelta = 2; # change this to change how many resources are displayed
1264: # before the current resource when using #current
1265:
1266: # If we were passed 'here' information, we are not rendering
1267: # after a folder manipulation, and we were not passed an
1268: # iterator, make sure we open the folders to show the "here"
1269: # marker
1270: my $filterHash = {};
1271: # Figure out what we're not displaying
1272: foreach my $item (split(/\,/, $env{"form.filter"})) {
1273: if ($item) {
1274: $filterHash->{$item} = "1";
1275: }
1276: }
1277:
1278: # Filter: Remember filter function and add our own filter: Refuse
1279: # to show hidden resources unless the user can see them.
1280: my $userCanSeeHidden = advancedUser();
1281: my $filterFunc = setDefault($args->{'filterFunc'},
1282: sub {return 1;});
1283: if (!$userCanSeeHidden) {
1284: # Without renaming the filterfunc, the server seems to go into
1285: # an infinite loop
1286: my $oldFilterFunc = $filterFunc;
1287: $filterFunc = sub { my $res = shift; return !$res->randomout() &&
1288: &$oldFilterFunc($res);};
1289: }
1290:
1291: my $condition = 0;
1292: if ($env{'form.condition'}) {
1293: $condition = 1;
1294: }
1295:
1296: if (!$env{'form.folderManip'} && !defined($args->{'iterator'})) {
1297: # Step 1: Check to see if we have a navmap
1298: if (!defined($navmap)) {
1299: $navmap = Apache::lonnavmaps::navmap->new();
1300: if (!defined($navmap)) {
1301: # no longer in course
1302: return '<span class="LC_error">'.&mt('No course selected').'</span><br />
1303: <a href="/adm/roles">'.&mt('Select a course').'</a><br />';
1304: }
1305: }
1306:
1307: # Step two: Locate what kind of here marker is necessary
1308: # Determine where the "here" marker is and where the screen jumps to.
1309:
1310: if ($env{'form.postsymb'} ne '') {
1311: $here = $jump = &Apache::lonnet::symbclean($env{'form.postsymb'});
1312: } elsif ($env{'form.postdata'} ne '') {
1313: # couldn't find a symb, is there a URL?
1314: my $currenturl = $env{'form.postdata'};
1315: #$currenturl=~s/^http\:\/\///;
1316: #$currenturl=~s/^[^\/]+//;
1317:
1318: $here = $jump = &Apache::lonnet::symbread($currenturl);
1319: }
1320: if ($here eq '') {
1321: my $last;
1322: if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1323: &GDBM_READER(),0640)) {
1324: $last=$hash{'last_known'};
1325: untie(%hash);
1326: }
1327: if ($last) { $here = $jump = $last; }
1328: }
1329:
1330: # Step three: Ensure the folders are open
1331: my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
1332: my $curRes;
1333: my $found = 0;
1334:
1335: # We only need to do this if we need to open the maps to show the
1336: # current position. This will change the counter so we can't count
1337: # for the jump marker with this loop.
1338: while ($here && ($curRes = $mapIterator->next()) && !$found) {
1339: if (ref($curRes) && $curRes->symb() eq $here) {
1340: my $mapStack = $mapIterator->getStack();
1341:
1342: # Ensure the parent maps are open
1343: for my $map (@{$mapStack}) {
1344: if ($condition) {
1345: undef $filterHash->{$map->map_pc()};
1346: } else {
1347: $filterHash->{$map->map_pc()} = 1;
1348: }
1349: }
1350: $found = 1;
1351: }
1352: }
1353: }
1354:
1355: if ( !defined($args->{'iterator'}) && $env{'form.folderManip'} ) { # we came from a user's manipulation of the nav page
1356: # If this is a click on a folder or something, we want to preserve the "here"
1357: # from the querystring, and get the new "jump" marker
1358: $here = $env{'form.here'};
1359: $jump = $env{'form.jump'};
1360: }
1361:
1362: my $it = $args->{'iterator'};
1363: if (!defined($it)) {
1364: # Construct a default iterator based on $env{'form.'} information
1365:
1366: # Step 1: Check to see if we have a navmap
1367: if (!defined($navmap)) {
1368: $navmap = Apache::lonnavmaps::navmap->new();
1369: if (!defined($navmap)) {
1370: # no longer in course
1371: return '<span class="LC_error">'.&mt('No course selected').'</span><br />
1372: <a href="/adm/roles">'.&mt('Select a course').'</a><br />';
1373: }
1374: }
1375:
1376: # See if we're being passed a specific map
1377: if ($args->{'iterator_map'}) {
1378: my $map = $args->{'iterator_map'};
1379: $map = $navmap->getResourceByUrl($map);
1380: my $firstResource = $map->map_start();
1381: my $finishResource = $map->map_finish();
1382:
1383: $args->{'iterator'} = $it = $navmap->getIterator($firstResource, $finishResource, $filterHash, $condition);
1384: } else {
1385: $args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition,undef,$args->{'include_top_level_map'});
1386: }
1387: }
1388:
1389: # (re-)Locate the jump point, if any
1390: # Note this does not take filtering or hidden into account... need
1391: # to be fixed?
1392: my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
1393: my $curRes;
1394: my $foundJump = 0;
1395: my $counter = 0;
1396:
1397: while (($curRes = $mapIterator->next()) && !$foundJump) {
1398: if (ref($curRes)) { $counter++; }
1399:
1400: if (ref($curRes) && $jump eq $curRes->symb()) {
1401:
1402: # This is why we have to use the main iterator instead of the
1403: # potentially faster DFS: The count has to be the same, so
1404: # the order has to be the same, which DFS won't give us.
1405: $args->{'currentJumpIndex'} = $counter;
1406: $foundJump = 1;
1407: }
1408: }
1409:
1410: my $showParts = setDefault($args->{'showParts'}, 1);
1411: my $condenseParts = setDefault($args->{'condenseParts'}, 1);
1412: # keeps track of when the current resource is found,
1413: # so we can back up a few and put the anchor above the
1414: # current resource
1415: my $printKey = $args->{'printKey'};
1416: my $printCloseAll = $args->{'printCloseAll'};
1417: if (!defined($printCloseAll)) { $printCloseAll = 1; }
1418:
1419: # Print key?
1420: if ($printKey) {
1421: $result .= '<table border="0" cellpadding="2" cellspacing="0">';
1422: $result.='<tr><td align="right" valign="bottom">Key: </td>';
1423: my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");
1424: if ($navmap->{LAST_CHECK}) {
1425: $result .=
1426: '<img src="'.$location.'/chat.gif" alt="" /> '.&mt('New discussion since').' '.
1427: strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
1428: '</td><td align="center" valign="bottom"> '.
1429: '<img src="'.$location.'/feedback.gif" alt="" /> '.&mt('New message (click to open)').'<p>'.
1430: '</td>';
1431: } else {
1432: $result .= '<td align="center" valign="bottom"> '.
1433: '<img src="'.$location.'/chat.gif" alt="" /> '.&mt('Discussions').'</td><td align="center" valign="bottom">'.
1434: ' <img src="'.$location.'/feedback.gif" alt="" /> '.&mt('New message (click to open)').
1435: '</td>';
1436: }
1437:
1438: $result .= '</tr></table>';
1439: }
1440:
1441: if ($printCloseAll && !$args->{'resource_no_folder_link'}) {
1442: my ($link,$text);
1443: if ($condition) {
1444: $link='navmaps?condition=0&filter=&'.$queryString.
1445: '&here='.&escape($here);
1446: $text='Close all folders';
1447: } else {
1448: $link='navmaps?condition=1&filter=&'.$queryString.
1449: '&here='.&escape($here);
1450: $text='Open all folders';
1451: }
1452: if ($env{'form.register'}) {
1453: $link .= '&register='.$env{'form.register'};
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 ($env{'form.register'}) {
1476: $result .= '<input type="hidden" name="register" value="'.$env{'form.register'}.'" />';
1477: }
1478: if ($args->{'sort'} eq 'discussion') {
1479: my $totdisc = 0;
1480: my $haveDisc = '';
1481: my @allres=$navmap->retrieveResources();
1482: foreach my $resource (@allres) {
1483: if ($resource->hasDiscussion()) {
1484: $haveDisc .= $resource->wrap_symb().':';
1485: $totdisc ++;
1486: }
1487: }
1488: if ($totdisc > 0) {
1489: $haveDisc =~ s/:$//;
1490: $result .= (<<END);
1491: <input type="hidden" name="navmaps" value="$haveDisc" />
1492: </form>
1493: END
1494: }
1495: }
1496: $result.='</form>';
1497: }
1498:
1499: if ($args->{'caller'} eq 'navmapsdisplay') {
1500: $result .= '<table><tr><td>'.
1501: &Apache::loncommon::help_open_menu('Navigation Screen','Navigation_Screen',undef,'RAT').'</td>';
1502: if ($env{'environment.remotenavmap'} ne 'on') {
1503: $result .= '<td> </td>';
1504: } else {
1505: $result .= '</tr><tr>';
1506: }
1507: $result.='<td class="LC_middle">'.&mt('Tools:').'</td>';
1508: $result.=&show_linkitems_toolbar($args->{'linkitems'});
1509: if ($args->{'sort_html'}) {
1510: if ($env{'environment.remotenavmap'} ne 'on') {
1511: $result.='<td> </td><td> </td><td> </td>'.
1512: '<td align="right">'.$args->{'sort_html'}.'</td></tr>';
1513: } else {
1514: $result.='</tr><tr><td align="left"><br />'.
1515: $args->{'sort_html'}.'</td></tr>';
1516: }
1517: }
1518: $result .= '</table>';
1519: } elsif ($args->{'sort_html'}) {
1520: $result.=$args->{'sort_html'};
1521: }
1522:
1523: #$result .= "<br />\n";
1524: if ($r) {
1525: $r->print($result);
1526: $r->rflush();
1527: $result = "";
1528: }
1529: # End parameter setting
1530:
1531: $result .= "<br />\n";
1532:
1533: # Data
1534: $result.=&Apache::loncommon::start_data_table("LC_tableOfContent");
1535:
1536: my $res = "Apache::lonnavmaps::resource";
1537: my %condenseStatuses =
1538: ( $res->NETWORK_FAILURE => 1,
1539: $res->NOTHING_SET => 1,
1540: $res->CORRECT => 1 );
1541:
1542: # Shared variables
1543: $args->{'counter'} = 0; # counts the rows
1544: $args->{'indentLevel'} = 0;
1545: $args->{'isNewBranch'} = 0;
1546: $args->{'condensed'} = 0;
1547:
1548: my $location = &Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace_21.gif");
1549: $args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='$location' alt='' />");
1550: $args->{'displayedHereMarker'} = 0;
1551:
1552: # If we're suppressing empty sequences, look for them here. Use DFS for speed,
1553: # since structure actually doesn't matter, except what map has what resources.
1554: if ($args->{'suppressEmptySequences'}) {
1555: my $dfsit = Apache::lonnavmaps::DFSiterator->new($navmap,
1556: $it->{FIRST_RESOURCE},
1557: $it->{FINISH_RESOURCE},
1558: {}, undef, 1);
1559: my $depth = 0;
1560: $dfsit->next();
1561: my $curRes = $dfsit->next();
1562: while ($depth > -1) {
1563: if ($curRes == $dfsit->BEGIN_MAP()) { $depth++; }
1564: if ($curRes == $dfsit->END_MAP()) { $depth--; }
1565:
1566: if (ref($curRes)) {
1567: # Parallel pre-processing: Do sequences have non-filtered-out children?
1568: if ($curRes->is_map()) {
1569: $curRes->{DATA}->{HAS_VISIBLE_CHILDREN} = 0;
1570: # Sequences themselves do not count as visible children,
1571: # unless those sequences also have visible children.
1572: # This means if a sequence appears, there's a "promise"
1573: # that there's something under it if you open it, somewhere.
1574: } else {
1575: # Not a sequence: if it's filtered, ignore it, otherwise
1576: # rise up the stack and mark the sequences as having children
1577: if (&$filterFunc($curRes)) {
1578: for my $sequence (@{$dfsit->getStack()}) {
1579: $sequence->{DATA}->{HAS_VISIBLE_CHILDREN} = 1;
1580: }
1581: }
1582: }
1583: }
1584: } continue {
1585: $curRes = $dfsit->next();
1586: }
1587: }
1588:
1589: my $displayedJumpMarker = 0;
1590: # Set up iteration.
1591: my $now = time();
1592: my $in24Hours = $now + 24 * 60 * 60;
1593: my $rownum = 0;
1594:
1595: # export "here" marker information
1596: $args->{'here'} = $here;
1597:
1598: $args->{'indentLevel'} = -1; # first BEGIN_MAP takes this to 0
1599: my @resources;
1600: my $code='';# sub { !(shift->is_map();) };
1601: if ($args->{'sort'} eq 'title') {
1602: my $oldFilterFunc = $filterFunc;
1603: my $filterFunc=
1604: sub {
1605: my ($res)=@_;
1606: if ($res->is_map()) { return 0;}
1607: return &$oldFilterFunc($res);
1608: };
1609: @resources=$navmap->retrieveResources(undef,$filterFunc);
1610: @resources= sort { &cmp_title($a,$b) } @resources;
1611: } elsif ($args->{'sort'} eq 'duedate') {
1612: my $oldFilterFunc = $filterFunc;
1613: my $filterFunc=
1614: sub {
1615: my ($res)=@_;
1616: if (!$res->is_problem()) { return 0;}
1617: return &$oldFilterFunc($res);
1618: };
1619: @resources=$navmap->retrieveResources(undef,$filterFunc);
1620: @resources= sort {
1621: if ($a->duedate ne $b->duedate) {
1622: return $a->duedate cmp $b->duedate;
1623: }
1624: my $value=&cmp_title($a,$b);
1625: return $value;
1626: } @resources;
1627: } elsif ($args->{'sort'} eq 'discussion') {
1628: my $oldFilterFunc = $filterFunc;
1629: my $filterFunc=
1630: sub {
1631: my ($res)=@_;
1632: if (!$res->hasDiscussion() &&
1633: !$res->getFeedback() &&
1634: !$res->getErrors()) { return 0;}
1635: return &$oldFilterFunc($res);
1636: };
1637: @resources=$navmap->retrieveResources(undef,$filterFunc);
1638: @resources= sort { &cmp_title($a,$b) } @resources;
1639: } else {
1640: #unknow sort mechanism or default
1641: undef($args->{'sort'});
1642: }
1643:
1644:
1645: while (1) {
1646: if ($args->{'sort'}) {
1647: $curRes = shift(@resources);
1648: } else {
1649: $curRes = $it->next($closeAllPages);
1650: }
1651: if (!$curRes) { last; }
1652:
1653: # Maintain indentation level.
1654: if ($curRes == $it->BEGIN_MAP() ||
1655: $curRes == $it->BEGIN_BRANCH() ) {
1656: $args->{'indentLevel'}++;
1657: }
1658: if ($curRes == $it->END_MAP() ||
1659: $curRes == $it->END_BRANCH() ) {
1660: $args->{'indentLevel'}--;
1661: }
1662: # Notice new branches
1663: if ($curRes == $it->BEGIN_BRANCH()) {
1664: $args->{'isNewBranch'} = 1;
1665: }
1666:
1667: # If this isn't an actual resource, continue on
1668: if (!ref($curRes)) {
1669: next;
1670: }
1671:
1672: # If this has been filtered out, continue on
1673: if (!(&$filterFunc($curRes))) {
1674: $args->{'isNewBranch'} = 0; # Don't falsely remember this
1675: next;
1676: }
1677:
1678: # If this is an empty sequence and we're filtering them, continue on
1679: if ($curRes->is_map() && $args->{'suppressEmptySequences'} &&
1680: !$curRes->{DATA}->{HAS_VISIBLE_CHILDREN}) {
1681: next;
1682: }
1683:
1684: # If we're suppressing navmaps and this is a navmap, continue on
1685: if ($suppressNavmap && $curRes->src() =~ /^\/adm\/navmaps/) {
1686: next;
1687: }
1688:
1689: $args->{'counter'}++;
1690:
1691: # Does it have multiple parts?
1692: $args->{'multipart'} = 0;
1693: $args->{'condensed'} = 0;
1694: my @parts;
1695:
1696: # Decide what parts to show.
1697: if ($curRes->is_problem() && $showParts) {
1698: @parts = @{$curRes->parts()};
1699: $args->{'multipart'} = $curRes->multipart();
1700:
1701: if ($condenseParts) { # do the condensation
1702: if (!$args->{'condensed'}) {
1703: # Decide whether to condense based on similarity
1704: my $status = $curRes->status($parts[0]);
1705: my $due = $curRes->duedate($parts[0]);
1706: my $open = $curRes->opendate($parts[0]);
1707: my $statusAllSame = 1;
1708: my $dueAllSame = 1;
1709: my $openAllSame = 1;
1710: for (my $i = 1; $i < scalar(@parts); $i++) {
1711: if ($curRes->status($parts[$i]) != $status){
1712: $statusAllSame = 0;
1713: }
1714: if ($curRes->duedate($parts[$i]) != $due ) {
1715: $dueAllSame = 0;
1716: }
1717: if ($curRes->opendate($parts[$i]) != $open) {
1718: $openAllSame = 0;
1719: }
1720: }
1721: # $*allSame is true if all the statuses were
1722: # the same. Now, if they are all the same and
1723: # match one of the statuses to condense, or they
1724: # are all open with the same due date, or they are
1725: # all OPEN_LATER with the same open date, display the
1726: # status of the first non-zero part (to get the 'correct'
1727: # status right, since 0 is never 'correct' or 'open').
1728: if (($statusAllSame && defined($condenseStatuses{$status})) ||
1729: ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
1730: ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
1731: @parts = ($parts[0]);
1732: $args->{'condensed'} = 1;
1733: }
1734: }
1735: # Multipart problem with one part: always "condense" (happens
1736: # to match the desirable behavior)
1737: if ($curRes->countParts() == 1) {
1738: @parts = ($parts[0]);
1739: $args->{'condensed'} = 1;
1740: }
1741: }
1742: }
1743:
1744: # If the multipart problem was condensed, "forget" it was multipart
1745: if (scalar(@parts) == 1) {
1746: $args->{'multipart'} = 0;
1747: } else {
1748: # Add part 0 so we display it correctly.
1749: unshift @parts, '0';
1750: }
1751:
1752: {
1753: my ($src,$symb,$anchor,$stack);
1754: if ($args->{'sort'}) {
1755: my $it = $navmap->getIterator(undef, undef, undef, 1);
1756: while ( my $res=$it->next()) {
1757: if (ref($res) &&
1758: $res->symb() eq $curRes->symb()) { last; }
1759: }
1760: $stack=$it->getStack();
1761: } else {
1762: $stack=$it->getStack();
1763: }
1764: ($src,$symb,$anchor)=getLinkForResource($stack);
1765: if (defined($anchor)) { $anchor='#'.$anchor; }
1766: my $srcHasQuestion = $src =~ /\?/;
1767: $args->{"resourceLink"} = $src.
1768: ($srcHasQuestion?'&':'?') .
1769: 'symb=' . &escape($symb).$anchor;
1770: }
1771: # Now, we've decided what parts to show. Loop through them and
1772: # show them.
1773: foreach my $part (@parts) {
1774: $rownum ++;
1775:
1776: $result .= &Apache::loncommon::start_data_table_row();
1777:
1778: # Set up some data about the parts that the cols might want
1779: my $filter = $it->{FILTER};
1780:
1781: # Now, display each column.
1782: foreach my $col (@$cols) {
1783: my $colHTML = '';
1784: if (ref($col)) {
1785: $colHTML .= &$col($curRes, $part, $args);
1786: } else {
1787: $colHTML .= &{$preparedColumns[$col]}($curRes, $part, $args);
1788: }
1789:
1790: # If this is the first column and it's time to print
1791: # the anchor, do so
1792: if ($col == $cols->[0] &&
1793: $args->{'counter'} == $args->{'currentJumpIndex'} -
1794: $currentJumpDelta) {
1795: # Jam the anchor after the <td> tag;
1796: # necessary for valid HTML (which Mozilla requires)
1797: $colHTML =~ s/\>/\>\<a name="curloc" \/\>/;
1798: $displayedJumpMarker = 1;
1799: }
1800: $result .= $colHTML . "\n";
1801: }
1802: $result .= &Apache::loncommon::end_data_table_row();
1803: $args->{'isNewBranch'} = 0;
1804: }
1805:
1806: if ($r && $rownum % 20 == 0) {
1807: $r->print($result);
1808: $result = "";
1809: $r->rflush();
1810: }
1811: } continue {
1812: if ($r) {
1813: # If we have the connection, make sure the user is still connected
1814: my $c = $r->connection;
1815: if ($c->aborted()) {
1816: # Who cares what we do, nobody will see it anyhow.
1817: return '';
1818: }
1819: }
1820: }
1821:
1822: # Print out the part that jumps to #curloc if it exists
1823: # delay needed because the browser is processing the jump before
1824: # it finishes rendering, so it goes to the wrong place!
1825: # onload might be better, but this routine has no access to that.
1826: # On mozilla, the 0-millisecond timeout seems to prevent this;
1827: # it's quite likely this might fix other browsers, too, and
1828: # certainly won't hurt anything.
1829: if ($displayedJumpMarker) {
1830: $result .= "
1831: <script>
1832: if (location.href.indexOf('#curloc')==-1) {
1833: setTimeout(\"location += '#curloc';\", 0)
1834: }
1835: </script>";
1836: }
1837:
1838: $result.=&Apache::loncommon::end_data_table();
1839:
1840: if ($r) {
1841: $r->print($result);
1842: $result = "";
1843: $r->rflush();
1844: }
1845:
1846: return $result;
1847: }
1848:
1849: sub add_linkitem {
1850: my ($linkitems,$name,$cmd,$text)=@_;
1851: $$linkitems{$name}{'cmd'}=$cmd;
1852: $$linkitems{$name}{'text'}=&mt($text);
1853: }
1854:
1855: sub show_linkitems_toolbar {
1856: my ($linkitems,$condition)=@_;
1857: my @linkorder = ("launchnav","closenav","firsthomework",
1858: "everything","uncompleted","changefolder","clearbubbles");
1859: my $result .='<td align="left">'."\n".
1860: '<span class="LC_nobreak">'."\n".
1861: '<ul id="LC_toolbar">';
1862: foreach my $link (@linkorder) {
1863: my $link_id = 'LC_content_toolbar_'.$link;
1864: if (defined($linkitems->{$link})) {
1865: if ($linkitems->{$link}{'text'} ne '') {
1866: $linkitems->{$link}{'cmd'}=~s/"/'/g;
1867: if ($linkitems->{$link}{'cmd'}) {
1868: if ($link eq 'changefolder') {
1869: if ($condition) {
1870: $link_id='LC_content_toolbar_changefolder_toggled';
1871: } else {
1872: $link_id='LC_content_toolbar_changefolder';
1873: }
1874: }
1875: $result .= '<li><a href="#" '.
1876: 'onclick="'.$linkitems->{$link}{'cmd'}.'" '.
1877: 'id="'.$link_id.'" '.
1878: 'class="LC_toolbarItem" '.
1879: 'title="'.$linkitems->{$link}{'text'}.'">'.
1880: '</a></li>'."\n";
1881: }
1882: }
1883: }
1884: }
1885: $result .= '</ul>'.
1886: '</span></td>'."\n";
1887: return $result;
1888: }
1889:
1890:
1891: 1;
1892:
1893:
1894:
1895:
1896:
1897:
1898:
1899:
1900:
1901: package Apache::lonnavmaps::navmap;
1902:
1903: =pod
1904:
1905: =head1 Object: Apache::lonnavmaps::navmap
1906:
1907: =head2 Overview
1908:
1909: The navmap object's job is to provide access to the resources
1910: in the course as Apache::lonnavmaps::resource objects, and to
1911: query and manage the relationship between those resource objects.
1912:
1913: Generally, you'll use the navmap object in one of three basic ways.
1914: In order of increasing complexity and power:
1915:
1916: =over 4
1917:
1918: =item * C<$navmap-E<gt>getByX>, where X is B<Id>, B<Symb> or B<MapPc> and getResourceByUrl. This provides
1919: various ways to obtain resource objects, based on various identifiers.
1920: Use this when you want to request information about one object or
1921: a handful of resources you already know the identities of, from some
1922: other source. For more about Ids, Symbs, and MapPcs, see the
1923: Resource documentation. Note that Url should be a B<last resort>,
1924: not your first choice; it only really works when there is only one
1925: instance of the resource in the course, which only applies to
1926: maps, and even that may change in the future (see the B<getResourceByUrl>
1927: documentation for more details.)
1928:
1929: =item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This
1930: retrieves resources matching some criterion and returns them
1931: in a flat array, with no structure information. Use this when
1932: you are manipulating a series of resources, based on what map
1933: the are in, but do not care about branching, or exactly how
1934: the maps and resources are related. This is the most common case.
1935:
1936: =item * C<$it = $navmap-E<gt>getIterator(args)>. This allows you traverse
1937: the course's navmap in various ways without writing the traversal
1938: code yourself. See iterator documentation below. Use this when
1939: you need to know absolutely everything about the course, including
1940: branches and the precise relationship between maps and resources.
1941:
1942: =back
1943:
1944: =head2 Creation And Destruction
1945:
1946: To create a navmap object, use the following function:
1947:
1948: =over 4
1949:
1950: =item * B<Apache::lonnavmaps::navmap-E<gt>new>():
1951:
1952: Creates a new navmap object. Returns the navmap object if this is
1953: successful, or B<undef> if not.
1954:
1955: =back
1956:
1957: =head2 Methods
1958:
1959: =over 4
1960:
1961: =item * B<getIterator>(first, finish, filter, condition):
1962:
1963: See iterator documentation below.
1964:
1965: =cut
1966:
1967: use strict;
1968: use GDBM_File;
1969: use Apache::lonnet;
1970: use LONCAPA;
1971:
1972: sub new {
1973: # magic invocation to create a class instance
1974: my $proto = shift;
1975: my $class = ref($proto) || $proto;
1976: my $self = {};
1977:
1978: # Resource cache stores navmap resources as we reference them. We generate
1979: # them on-demand so we don't pay for creating resources unless we use them.
1980: $self->{RESOURCE_CACHE} = {};
1981:
1982: # Network failure flag, if we accessed the course or user opt and
1983: # failed
1984: $self->{NETWORK_FAILURE} = 0;
1985:
1986: # tie the nav hash
1987:
1988: my %navmaphash;
1989: my %parmhash;
1990: my $courseFn = $env{"request.course.fn"};
1991: if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",
1992: &GDBM_READER(), 0640))) {
1993: return undef;
1994: }
1995:
1996: if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db",
1997: &GDBM_READER(), 0640)))
1998: {
1999: untie %{$self->{PARM_HASH}};
2000: return undef;
2001: }
2002:
2003: $self->{NAV_HASH} = \%navmaphash;
2004: $self->{PARM_HASH} = \%parmhash;
2005: $self->{PARM_CACHE} = {};
2006:
2007: bless($self);
2008:
2009: return $self;
2010: }
2011:
2012: sub generate_course_user_opt {
2013: my $self = shift;
2014: if ($self->{COURSE_USER_OPT_GENERATED}) { return; }
2015:
2016: my $uname=$env{'user.name'};
2017: my $udom=$env{'user.domain'};
2018: my $cid=$env{'request.course.id'};
2019: my $cdom=$env{'course.'.$cid.'.domain'};
2020: my $cnum=$env{'course.'.$cid.'.num'};
2021:
2022: # ------------------------------------------------- Get coursedata (if present)
2023: my $courseopt=&Apache::lonnet::get_courseresdata($cnum,$cdom);
2024: # Check for network failure
2025: if (!ref($courseopt)) {
2026: if ( $courseopt =~ /no.such.host/i || $courseopt =~ /con_lost/i) {
2027: $self->{NETWORK_FAILURE} = 1;
2028: }
2029: undef($courseopt);
2030: }
2031:
2032: # --------------------------------------------------- Get userdata (if present)
2033:
2034: my $useropt=&Apache::lonnet::get_userresdata($uname,$udom);
2035: # Check for network failure
2036: if (!ref($useropt)) {
2037: if ( $useropt =~ /no.such.host/i || $useropt =~ /con_lost/i) {
2038: $self->{NETWORK_FAILURE} = 1;
2039: }
2040: undef($useropt);
2041: }
2042:
2043: $self->{COURSE_OPT} = $courseopt;
2044: $self->{USER_OPT} = $useropt;
2045:
2046: $self->{COURSE_USER_OPT_GENERATED} = 1;
2047:
2048: return;
2049: }
2050:
2051: sub generate_email_discuss_status {
2052: my $self = shift;
2053: my $symb = shift;
2054: if ($self->{EMAIL_DISCUSS_GENERATED}) { return; }
2055:
2056: my $cid=$env{'request.course.id'};
2057: my $cdom=$env{'course.'.$cid.'.domain'};
2058: my $cnum=$env{'course.'.$cid.'.num'};
2059:
2060: my %emailstatus = &Apache::lonnet::dump('email_status');
2061: my $logoutTime = $emailstatus{'logout'};
2062: my $courseLeaveTime = $emailstatus{'logout_'.$env{'request.course.id'}};
2063: $self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
2064: $courseLeaveTime : $logoutTime);
2065: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
2066: $cdom, $cnum);
2067: my %lastread = &Apache::lonnet::dump('nohist_'.$cid.'_discuss',
2068: $env{'user.domain'},$env{'user.name'},'lastread');
2069: my %lastreadtime = ();
2070: foreach my $key (keys %lastread) {
2071: my $shortkey = $key;
2072: $shortkey =~ s/_lastread$//;
2073: $lastreadtime{$shortkey} = $lastread{$key};
2074: }
2075:
2076: my %feedback=();
2077: my %error=();
2078: my @keys = &Apache::lonnet::getkeys('nohist_email',$env{'user.domain'},
2079: $env{'user.name'});
2080:
2081: foreach my $msgid (@keys) {
2082: if ((!$emailstatus{$msgid}) || ($emailstatus{$msgid} eq 'new')) {
2083: my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid,
2084: $symb,$error) = &Apache::lonmsg::unpackmsgid($msgid);
2085: &Apache::lonenc::check_decrypt(\$symb);
2086: if (($fromcid ne '') && ($fromcid ne $cid)) {
2087: next;
2088: }
2089: if (defined($symb)) {
2090: if (defined($error) && $error == 1) {
2091: $error{$symb}.=','.$msgid;
2092: } else {
2093: $feedback{$symb}.=','.$msgid;
2094: }
2095: } else {
2096: my $plain=
2097: &LONCAPA::unescape(&LONCAPA::unescape($msgid));
2098: if ($plain=~/ \[([^\]]+)\]\:/) {
2099: my $url=$1;
2100: if ($plain=~/\:Error \[/) {
2101: $error{$url}.=','.$msgid;
2102: } else {
2103: $feedback{$url}.=','.$msgid;
2104: }
2105: }
2106: }
2107: }
2108: }
2109:
2110: #symbs of resources that have feedbacks (will be urls pre-2.3)
2111: $self->{FEEDBACK} = \%feedback;
2112: #or errors (will be urls pre 2.3)
2113: $self->{ERROR_MSG} = \%error;
2114: $self->{DISCUSSION_TIME} = \%discussiontime;
2115: $self->{EMAIL_STATUS} = \%emailstatus;
2116: $self->{LAST_READ} = \%lastreadtime;
2117:
2118: $self->{EMAIL_DISCUSS_GENERATED} = 1;
2119: }
2120:
2121: sub get_user_data {
2122: my $self = shift;
2123: if ($self->{RETRIEVED_USER_DATA}) { return; }
2124:
2125: # Retrieve performance data on problems
2126: my %student_data = Apache::lonnet::currentdump($env{'request.course.id'},
2127: $env{'user.domain'},
2128: $env{'user.name'});
2129: $self->{STUDENT_DATA} = \%student_data;
2130:
2131: $self->{RETRIEVED_USER_DATA} = 1;
2132: }
2133:
2134: sub get_discussion_data {
2135: my $self = shift;
2136: if ($self->{RETRIEVED_DISCUSSION_DATA}) {
2137: return $self->{DISCUSSION_DATA};
2138: }
2139:
2140: $self->generate_email_discuss_status();
2141:
2142: my $cid=$env{'request.course.id'};
2143: my $cdom=$env{'course.'.$cid.'.domain'};
2144: my $cnum=$env{'course.'.$cid.'.num'};
2145: # Retrieve discussion data for resources in course
2146: my %discussion_data = &Apache::lonnet::dumpstore($cid,$cdom,$cnum);
2147:
2148:
2149: $self->{DISCUSSION_DATA} = \%discussion_data;
2150: $self->{RETRIEVED_DISCUSSION_DATA} = 1;
2151: return $self->{DISCUSSION_DATA};
2152: }
2153:
2154:
2155: # Internal function: Takes a key to look up in the nav hash and implements internal
2156: # memory caching of that key.
2157: sub navhash {
2158: my $self = shift; my $key = shift;
2159: return $self->{NAV_HASH}->{$key};
2160: }
2161:
2162: =pod
2163:
2164: =item * B<courseMapDefined>(): Returns true if the course map is defined,
2165: false otherwise. Undefined course maps indicate an error somewhere in
2166: LON-CAPA, and you will not be able to proceed with using the navmap.
2167: See the B<NAV> screen for an example of using this.
2168:
2169: =cut
2170:
2171: # Checks to see if coursemap is defined, matching test in old lonnavmaps
2172: sub courseMapDefined {
2173: my $self = shift;
2174: my $uri = &Apache::lonnet::clutter($env{'request.course.uri'});
2175:
2176: my $firstres = $self->navhash("map_start_$uri");
2177: my $lastres = $self->navhash("map_finish_$uri");
2178: return $firstres && $lastres;
2179: }
2180:
2181: sub getIterator {
2182: my $self = shift;
2183: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
2184: shift, undef, shift,
2185: shift, shift);
2186: return $iterator;
2187: }
2188:
2189: # Private method: Does the given resource (as a symb string) have
2190: # current discussion? Returns 0 if chat/mail data not extracted.
2191: sub hasDiscussion {
2192: my $self = shift;
2193: my $symb = shift;
2194: $self->generate_email_discuss_status();
2195:
2196: if (!defined($self->{DISCUSSION_TIME})) { return 0; }
2197:
2198: #return defined($self->{DISCUSSION_TIME}->{$symb});
2199:
2200: # backward compatibility (bulletin boards used to be 'wrapped')
2201: my $ressymb = $self->wrap_symb($symb);
2202: if ( defined ( $self->{LAST_READ}->{$ressymb} ) ) {
2203: return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_READ}->{$ressymb};
2204: } else {
2205: # return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_CHECK}; # v.1.1 behavior
2206: 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).
2207: }
2208: }
2209:
2210: sub last_post_time {
2211: my $self = shift;
2212: my $symb = shift;
2213: my $ressymb = $self->wrap_symb($symb);
2214: return $self->{DISCUSSION_TIME}->{$ressymb};
2215: }
2216:
2217: sub discussion_info {
2218: my $self = shift;
2219: my $symb = shift;
2220: my $filter = shift;
2221:
2222: $self->get_discussion_data();
2223:
2224: my $ressymb = $self->wrap_symb($symb);
2225: # keys used to store bulletinboard postings use 'unwrapped' symb.
2226: my $discsymb = &escape($self->unwrap_symb($ressymb));
2227: my $version = $self->{DISCUSSION_DATA}{'version:'.$discsymb};
2228: if (!$version) { return; }
2229:
2230: my $prevread = $self->{LAST_READ}{$ressymb};
2231:
2232: my $count = 0;
2233: my $hiddenflag = 0;
2234: my $deletedflag = 0;
2235: my ($hidden,$deleted,%info);
2236:
2237: for (my $id=$version; $id>0; $id--) {
2238: my $vkeys=$self->{DISCUSSION_DATA}{$id.':keys:'.$discsymb};
2239: my @keys=split(/:/,$vkeys);
2240: if (grep(/^hidden$/ ,@keys)) {
2241: if (!$hiddenflag) {
2242: $hidden = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':hidden'};
2243: $hiddenflag = 1;
2244: }
2245: } elsif (grep(/^deleted$/,@keys)) {
2246: if (!$deletedflag) {
2247: $deleted = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':deleted'};
2248: $deletedflag = 1;
2249: }
2250: } else {
2251: if (($hidden !~/\.$id\./) && ($deleted !~/\.$id\./)) {
2252: if ($filter eq 'unread') {
2253: if ($prevread >= $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'}) {
2254: next;
2255: }
2256: }
2257: $count++;
2258: $info{$count}{'subject'} =
2259: $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':subject'};
2260: $info{$count}{'id'} = $id;
2261: $info{$count}{'timestamp'} = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'};
2262: }
2263: }
2264: }
2265: if (wantarray) {
2266: return ($count,%info);
2267: }
2268: return $count;
2269: }
2270:
2271: sub wrap_symb {
2272: my $self = shift;
2273: my $symb = shift;
2274: if ($symb =~ m-___(adm/[^/]+/[^/]+/)(\d+)(/bulletinboard)$-) {
2275: unless ($symb =~ m|adm/wrapper/adm|) {
2276: $symb = 'bulletin___'.$2.'___adm/wrapper/'.$1.$2.$3;
2277: }
2278: }
2279: return $symb;
2280: }
2281:
2282: sub unwrap_symb {
2283: my $self = shift;
2284: my $ressymb = shift;
2285: my $discsymb = $ressymb;
2286: if ($ressymb =~ m-^(bulletin___\d+___)adm/wrapper/(adm/[^/]+/[^/]+/\d+/bulletinboard)$-) {
2287: $discsymb = $1.$2;
2288: }
2289: return $discsymb;
2290: }
2291:
2292: # Private method: Does the given resource (as a symb string) have
2293: # current feedback? Returns the string in the feedback hash, which
2294: # will be false if it does not exist.
2295:
2296: sub getFeedback {
2297: my $self = shift;
2298: my $symb = shift;
2299: my $source = shift;
2300:
2301: $self->generate_email_discuss_status();
2302:
2303: if (!defined($self->{FEEDBACK})) { return ""; }
2304:
2305: my $feedback;
2306: if ($self->{FEEDBACK}->{$symb}) {
2307: $feedback = $self->{FEEDBACK}->{$symb};
2308: if ($self->{FEEDBACK}->{$source}) {
2309: $feedback .= ','.$self->{FEEDBACK}->{$source};
2310: }
2311: } else {
2312: if ($self->{FEEDBACK}->{$source}) {
2313: $feedback = $self->{FEEDBACK}->{$source};
2314: }
2315: }
2316: return $feedback;
2317: }
2318:
2319: # Private method: Get the errors for that resource (by source).
2320: sub getErrors {
2321: my $self = shift;
2322: my $symb = shift;
2323: my $src = shift;
2324:
2325: $self->generate_email_discuss_status();
2326:
2327: if (!defined($self->{ERROR_MSG})) { return ""; }
2328:
2329: my $errors;
2330: if ($self->{ERROR_MSG}->{$symb}) {
2331: $errors = $self->{ERROR_MSG}->{$symb};
2332: if ($self->{ERROR_MSG}->{$src}) {
2333: $errors .= ','.$self->{ERROR_MSG}->{$src};
2334: }
2335: } else {
2336: if ($self->{ERROR_MSG}->{$src}) {
2337: $errors = $self->{ERROR_MSG}->{$src};
2338: }
2339: }
2340: return $errors;
2341: }
2342:
2343: =pod
2344:
2345: =item * B<getById>(id):
2346:
2347: Based on the ID of the resource (1.1, 3.2, etc.), get a resource
2348: object for that resource. This method, or other methods that use it
2349: (as in the resource object) is the only proper way to obtain a
2350: resource object.
2351:
2352: =item * B<getBySymb>(symb):
2353:
2354: Based on the symb of the resource, get a resource object for that
2355: resource. This is one of the proper ways to get a resource object.
2356:
2357: =item * B<getMapByMapPc>(map_pc):
2358:
2359: Based on the map_pc of the resource, get a resource object for
2360: the given map. This is one of the proper ways to get a resource object.
2361:
2362: =cut
2363:
2364: # The strategy here is to cache the resource objects, and only construct them
2365: # as we use them. The real point is to prevent reading any more from the tied
2366: # hash than we have to, which should hopefully alleviate speed problems.
2367:
2368: sub getById {
2369: my $self = shift;
2370: my $id = shift;
2371:
2372: if (defined ($self->{RESOURCE_CACHE}->{$id}))
2373: {
2374: return $self->{RESOURCE_CACHE}->{$id};
2375: }
2376:
2377: # resource handles inserting itself into cache.
2378: # Not clear why the quotes are necessary, but as of this
2379: # writing it doesn't work without them.
2380: return "Apache::lonnavmaps::resource"->new($self, $id);
2381: }
2382:
2383: sub getBySymb {
2384: my $self = shift;
2385: my $symb = shift;
2386:
2387: my ($mapUrl, $id, $filename) = &Apache::lonnet::decode_symb($symb);
2388: my $map = $self->getResourceByUrl($mapUrl);
2389: my $returnvalue = undef;
2390: if (ref($map)) {
2391: $returnvalue = $self->getById($map->map_pc() .'.'.$id);
2392: }
2393: return $returnvalue;
2394: }
2395:
2396: sub getByMapPc {
2397: my $self = shift;
2398: my $map_pc = shift;
2399: my $map_id = $self->{NAV_HASH}->{'map_id_' . $map_pc};
2400: $map_id = $self->{NAV_HASH}->{'ids_' . $map_id};
2401: return $self->getById($map_id);
2402: }
2403:
2404: =pod
2405:
2406: =item * B<firstResource>():
2407:
2408: Returns a resource object reference corresponding to the first
2409: resource in the navmap.
2410:
2411: =cut
2412:
2413: sub firstResource {
2414: my $self = shift;
2415: my $firstResource = $self->navhash('map_start_' .
2416: &Apache::lonnet::clutter($env{'request.course.uri'}));
2417: return $self->getById($firstResource);
2418: }
2419:
2420: =pod
2421:
2422: =item * B<finishResource>():
2423:
2424: Returns a resource object reference corresponding to the last resource
2425: in the navmap.
2426:
2427: =cut
2428:
2429: sub finishResource {
2430: my $self = shift;
2431: my $firstResource = $self->navhash('map_finish_' .
2432: &Apache::lonnet::clutter($env{'request.course.uri'}));
2433: return $self->getById($firstResource);
2434: }
2435:
2436: # Parmval reads the parm hash and cascades the lookups. parmval_real does
2437: # the actual lookup; parmval caches the results.
2438: sub parmval {
2439: my $self = shift;
2440: my ($what,$symb,$recurse)=@_;
2441: my $hashkey = $what."|||".$symb;
2442:
2443: if (defined($self->{PARM_CACHE}->{$hashkey})) {
2444: if (ref($self->{PARM_CACHE}->{$hashkey}) eq 'ARRAY') {
2445: if (defined($self->{PARM_CACHE}->{$hashkey}->[0])) {
2446: if (wantarray) {
2447: return @{$self->{PARM_CACHE}->{$hashkey}};
2448: } else {
2449: return $self->{PARM_CACHE}->{$hashkey}->[0];
2450: }
2451: }
2452: } else {
2453: return $self->{PARM_CACHE}->{$hashkey};
2454: }
2455: }
2456: my $result = $self->parmval_real($what, $symb, $recurse);
2457: $self->{PARM_CACHE}->{$hashkey} = $result;
2458: if (wantarray) {
2459: return @{$result};
2460: }
2461: return $result->[0];
2462: }
2463:
2464: sub parmval_real {
2465: my $self = shift;
2466: my ($what,$symb,$recurse) = @_;
2467:
2468: # Make sure the {USER_OPT} and {COURSE_OPT} hashes are populated
2469: $self->generate_course_user_opt();
2470:
2471: my $cid=$env{'request.course.id'};
2472: my $csec=$env{'request.course.sec'};
2473: my $cgroup='';
2474: my @cgrps=split(/:/,$env{'request.course.groups'});
2475: if (@cgrps > 0) {
2476: @cgrps = sort(@cgrps);
2477: $cgroup = $cgrps[0];
2478: }
2479: my $uname=$env{'user.name'};
2480: my $udom=$env{'user.domain'};
2481:
2482: unless ($symb) { return ['']; }
2483: my $result='';
2484:
2485: my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
2486: $mapname = &Apache::lonnet::deversion($mapname);
2487: # ----------------------------------------------------- Cascading lookup scheme
2488: my $rwhat=$what;
2489: $what=~s/^parameter\_//;
2490: $what=~s/\_/\./;
2491:
2492: my $symbparm=$symb.'.'.$what;
2493: my $mapparm=$mapname.'___(all).'.$what;
2494: my $usercourseprefix=$cid;
2495:
2496: my $grplevel=$usercourseprefix.'.['.$cgroup.'].'.$what;
2497: my $grplevelr=$usercourseprefix.'.['.$cgroup.'].'.$symbparm;
2498: my $grplevelm=$usercourseprefix.'.['.$cgroup.'].'.$mapparm;
2499:
2500: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
2501: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
2502: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
2503:
2504: my $courselevel= $usercourseprefix.'.'.$what;
2505: my $courselevelr=$usercourseprefix.'.'.$symbparm;
2506: my $courselevelm=$usercourseprefix.'.'.$mapparm;
2507:
2508: my $useropt = $self->{USER_OPT};
2509: my $courseopt = $self->{COURSE_OPT};
2510: my $parmhash = $self->{PARM_HASH};
2511:
2512: # ---------------------------------------------------------- first, check user
2513: if ($uname and defined($useropt)) {
2514: if (defined($$useropt{$courselevelr})) { return [$$useropt{$courselevelr},'resource']; }
2515: if (defined($$useropt{$courselevelm})) { return [$$useropt{$courselevelm},'map']; }
2516: if (defined($$useropt{$courselevel})) { return [$$useropt{$courselevel},'course']; }
2517: }
2518:
2519: # ------------------------------------------------------- second, check course
2520: if ($cgroup ne '' and defined($courseopt)) {
2521: if (defined($$courseopt{$grplevelr})) { return [$$courseopt{$grplevelr},'resource']; }
2522: if (defined($$courseopt{$grplevelm})) { return [$$courseopt{$grplevelm},'map']; }
2523: if (defined($$courseopt{$grplevel})) { return [$$courseopt{$grplevel},'course']; }
2524: }
2525:
2526: if ($csec and defined($courseopt)) {
2527: if (defined($$courseopt{$seclevelr})) { return [$$courseopt{$seclevelr},'resource']; }
2528: if (defined($$courseopt{$seclevelm})) { return [$$courseopt{$seclevelm},'map']; }
2529: if (defined($$courseopt{$seclevel})) { return [$$courseopt{$seclevel},'course']; }
2530: }
2531:
2532: if (defined($courseopt)) {
2533: if (defined($$courseopt{$courselevelr})) { return [$$courseopt{$courselevelr},'resource']; }
2534: }
2535:
2536: # ----------------------------------------------------- third, check map parms
2537:
2538: my $thisparm=$$parmhash{$symbparm};
2539: if (defined($thisparm)) { return [$thisparm,'map']; }
2540:
2541: # ----------------------------------------------------- fourth , check default
2542:
2543: my $meta_rwhat=$rwhat;
2544: $meta_rwhat=~s/\./_/g;
2545: my $default=&Apache::lonnet::metadata($fn,$meta_rwhat);
2546: if (defined($default)) { return [$default,'resource']}
2547: $default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat);
2548: if (defined($default)) { return [$default,'resource']}
2549: # --------------------------------------------------- fifth, check more course
2550: if (defined($courseopt)) {
2551: if (defined($$courseopt{$courselevelm})) { return [$$courseopt{$courselevelm},'map']; }
2552: if (defined($$courseopt{$courselevel})) {
2553: my $ret = [$$courseopt{$courselevel},'course'];
2554: return $ret;
2555: }
2556: }
2557: # --------------------------------------------------- sixth , cascade up parts
2558:
2559: my ($space,@qualifier)=split(/\./,$rwhat);
2560: my $qualifier=join('.',@qualifier);
2561: unless ($space eq '0') {
2562: my @parts=split(/_/,$space);
2563: my $id=pop(@parts);
2564: my $part=join('_',@parts);
2565: if ($part eq '') { $part='0'; }
2566: my @partgeneral=$self->parmval($part.".$qualifier",$symb,1);
2567: if (defined($partgeneral[0])) { return \@partgeneral; }
2568: }
2569: if ($recurse) { return []; }
2570: my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$rwhat);
2571: if (defined($pack_def)) { return [$pack_def,'resource']; }
2572: return [''];
2573: }
2574:
2575: =pod
2576:
2577: =item * B<getResourceByUrl>(url,multiple):
2578:
2579: Retrieves a resource object by URL of the resource, unless the optional
2580: multiple parameter is included in which case an array of resource
2581: objects is returned. If passed a resource object, it will simply return
2582: it, so it is safe to use this method in code like
2583: "$res = $navmap->getResourceByUrl($res)"
2584: if you're not sure if $res is already an object, or just a URL. If the
2585: resource appears multiple times in the course, only the first instance
2586: will be returned (useful for maps), unless the multiple parameter has
2587: been included, in which case all instances are returned in an array.
2588:
2589: =item * B<retrieveResources>(map, filterFunc, recursive, bailout, showall):
2590:
2591: The map is a specification of a map to retreive the resources from,
2592: either as a url or as an object. The filterFunc is a reference to a
2593: function that takes a resource object as its one argument and returns
2594: true if the resource should be included, or false if it should not
2595: be. If recursive is true, the map will be recursively examined,
2596: otherwise it will not be. If bailout is true, the function will return
2597: as soon as it finds a resource, if false it will finish. If showall is
2598: true it will not hide maps that contain nothing but one other map. By
2599: default, the map is the top-level map of the course, filterFunc is a
2600: function that always returns 1, recursive is true, bailout is false,
2601: showall is false. The resources will be returned in a list containing
2602: the resource objects for the corresponding resources, with B<no
2603: structure information> in the list; regardless of branching,
2604: recursion, etc., it will be a flat list.
2605:
2606: Thus, this is suitable for cases where you don't want the structure,
2607: just a list of all resources. It is also suitable for finding out how
2608: many resources match a given description; for this use, if all you
2609: want to know is if I<any> resources match the description, the bailout
2610: parameter will allow you to avoid potentially expensive enumeration of
2611: all matching resources.
2612:
2613: =item * B<hasResource>(map, filterFunc, recursive, showall):
2614:
2615: Convenience method for
2616:
2617: scalar(retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0
2618:
2619: which will tell whether the map has resources matching the description
2620: in the filter function.
2621:
2622: =item * B<usedVersion>(url):
2623:
2624: Retrieves version infomation for a url. Returns the version (a number, or
2625: the string "mostrecent") for resources which have version information in
2626: the big hash.
2627:
2628: =cut
2629:
2630:
2631: sub getResourceByUrl {
2632: my $self = shift;
2633: my $resUrl = shift;
2634: my $multiple = shift;
2635:
2636: if (ref($resUrl)) { return $resUrl; }
2637:
2638: $resUrl = &Apache::lonnet::clutter($resUrl);
2639: my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl};
2640: if (!$resId) { return ''; }
2641: if ($multiple) {
2642: my @resources = ();
2643: my @resIds = split (/,/, $resId);
2644: foreach my $id (@resIds) {
2645: my $resourceId = $self->getById($id);
2646: if ($resourceId) {
2647: push(@resources,$resourceId);
2648: }
2649: }
2650: return @resources;
2651: } else {
2652: if ($resId =~ /,/) {
2653: $resId = (split (/,/, $resId))[0];
2654: }
2655: return $self->getById($resId);
2656: }
2657: }
2658:
2659: sub retrieveResources {
2660: my $self = shift;
2661: my $map = shift;
2662: my $filterFunc = shift;
2663: if (!defined ($filterFunc)) {
2664: $filterFunc = sub {return 1;};
2665: }
2666: my $recursive = shift;
2667: if (!defined($recursive)) { $recursive = 1; }
2668: my $bailout = shift;
2669: if (!defined($bailout)) { $bailout = 0; }
2670: my $showall = shift;
2671: # Create the necessary iterator.
2672: if (!ref($map)) { # assume it's a url of a map.
2673: $map = $self->getResourceByUrl($map);
2674: }
2675:
2676: # If nothing was passed, assume top-level map
2677: if (!$map) {
2678: $map = $self->getById('0.0');
2679: }
2680:
2681: # Check the map's validity.
2682: if (!$map->is_map()) {
2683: # Oh, to throw an exception.... how I'd love that!
2684: return ();
2685: }
2686:
2687: # Get an iterator.
2688: my $it = $self->getIterator($map->map_start(), $map->map_finish(),
2689: undef, $recursive, $showall);
2690:
2691: my @resources = ();
2692:
2693: if (&$filterFunc($map)) {
2694: push(@resources, $map);
2695: }
2696:
2697: # Run down the iterator and collect the resources.
2698: my $curRes;
2699:
2700: while ($curRes = $it->next()) {
2701: if (ref($curRes)) {
2702: if (!&$filterFunc($curRes)) {
2703: next;
2704: }
2705:
2706: push(@resources, $curRes);
2707:
2708: if ($bailout) {
2709: return @resources;
2710: }
2711: }
2712:
2713: }
2714:
2715: return @resources;
2716: }
2717:
2718: sub hasResource {
2719: my $self = shift;
2720: my $map = shift;
2721: my $filterFunc = shift;
2722: my $recursive = shift;
2723: my $showall = shift;
2724:
2725: return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0;
2726: }
2727:
2728: sub usedVersion {
2729: my $self = shift;
2730: my $linkurl = shift;
2731: return $self->navhash("version_$linkurl");
2732: }
2733:
2734: 1;
2735:
2736: package Apache::lonnavmaps::iterator;
2737: use Scalar::Util qw(weaken);
2738: use Apache::lonnet;
2739:
2740: =pod
2741:
2742: =back
2743:
2744: =head1 Object: navmap Iterator
2745:
2746: An I<iterator> encapsulates the logic required to traverse a data
2747: structure. navmap uses an iterator to traverse the course map
2748: according to the criteria you wish to use.
2749:
2750: To obtain an iterator, call the B<getIterator>() function of a
2751: B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator
2752: directly.) This will return a reference to the iterator:
2753:
2754: C<my $resourceIterator = $navmap-E<gt>getIterator();>
2755:
2756: To get the next thing from the iterator, call B<next>:
2757:
2758: C<my $nextThing = $resourceIterator-E<gt>next()>
2759:
2760: getIterator behaves as follows:
2761:
2762: =over 4
2763:
2764: =item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap):
2765:
2766: All parameters are optional. firstResource is a resource reference
2767: corresponding to where the iterator should start. It defaults to
2768: navmap->firstResource() for the corresponding nav map. finishResource
2769: corresponds to where you want the iterator to end, defaulting to
2770: navmap->finishResource(). filterHash is a hash used as a set
2771: containing strings representing the resource IDs, defaulting to
2772: empty. Condition is a 1 or 0 that sets what to do with the filter
2773: hash: If a 0, then only resources that exist IN the filterHash will be
2774: recursed on. If it is a 1, only resources NOT in the filterHash will
2775: be recursed on. Defaults to 0. forceTop is a boolean value. If it is
2776: false (default), the iterator will only return the first level of map
2777: that is not just a single, 'redirecting' map. If true, the iterator
2778: will return all information, starting with the top-level map,
2779: regardless of content. returnTopMap, if true (default false), will
2780: cause the iterator to return the top-level map object (resource 0.0)
2781: before anything else.
2782:
2783: Thus, by default, only top-level resources will be shown. Change the
2784: condition to a 1 without changing the hash, and all resources will be
2785: shown. Changing the condition to 1 and including some values in the
2786: hash will allow you to selectively suppress parts of the navmap, while
2787: leaving it on 0 and adding things to the hash will allow you to
2788: selectively add parts of the nav map. See the handler code for
2789: examples.
2790:
2791: The iterator will return either a reference to a resource object, or a
2792: token representing something in the map, such as the beginning of a
2793: new branch. The possible tokens are:
2794:
2795: =over 4
2796:
2797: =item * B<END_ITERATOR>:
2798:
2799: The iterator has returned all that it's going to. Further calls to the
2800: iterator will just produce more of these. This is a "false" value, and
2801: is the only false value the iterator which will be returned, so it can
2802: be used as a loop sentinel.
2803:
2804: =item * B<BEGIN_MAP>:
2805:
2806: A new map is being recursed into. This is returned I<after> the map
2807: resource itself is returned.
2808:
2809: =item * B<END_MAP>:
2810:
2811: The map is now done.
2812:
2813: =item * B<BEGIN_BRANCH>:
2814:
2815: A branch is now starting. The next resource returned will be the first
2816: in that branch.
2817:
2818: =item * B<END_BRANCH>:
2819:
2820: The branch is now done.
2821:
2822: =back
2823:
2824: The tokens are retreivable via methods on the iterator object, i.e.,
2825: $iterator->END_MAP.
2826:
2827: Maps can contain empty resources. The iterator will automatically skip
2828: over such resources, but will still treat the structure
2829: correctly. Thus, a complicated map with several branches, but
2830: consisting entirely of empty resources except for one beginning or
2831: ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs,
2832: but only one resource will be returned.
2833:
2834: =back
2835:
2836: =head2 Normal Usage
2837:
2838: Normal usage of the iterator object is to do the following:
2839:
2840: my $it = $navmap->getIterator([your params here]);
2841: my $curRes;
2842: while ($curRes = $it->next()) {
2843: [your logic here]
2844: }
2845:
2846: Note that inside of the loop, it's frequently useful to check if
2847: "$curRes" is a reference or not with the reference function; only
2848: resource objects will be references, and any non-references will
2849: be the tokens described above.
2850:
2851: Also note there is some old code floating around that trys to track
2852: the depth of the iterator to see when it's done; do not copy that
2853: code. It is difficult to get right and harder to understand than
2854: this. They should be migrated to this new style.
2855:
2856: =cut
2857:
2858: # Here are the tokens for the iterator:
2859:
2860: sub END_ITERATOR { return 0; }
2861: sub BEGIN_MAP { return 1; } # begining of a new map
2862: sub END_MAP { return 2; } # end of the map
2863: sub BEGIN_BRANCH { return 3; } # beginning of a branch
2864: sub END_BRANCH { return 4; } # end of a branch
2865: sub FORWARD { return 1; } # go forward
2866: sub BACKWARD { return 2; }
2867:
2868: sub min {
2869: (my $a, my $b) = @_;
2870: if ($a < $b) { return $a; } else { return $b; }
2871: }
2872:
2873: sub new {
2874: # magic invocation to create a class instance
2875: my $proto = shift;
2876: my $class = ref($proto) || $proto;
2877: my $self = {};
2878:
2879: weaken($self->{NAV_MAP} = shift);
2880: return undef unless ($self->{NAV_MAP});
2881:
2882: # Handle the parameters
2883: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
2884: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
2885:
2886: # If the given resources are just the ID of the resource, get the
2887: # objects
2888: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
2889: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
2890: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
2891: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
2892:
2893: $self->{FILTER} = shift;
2894:
2895: # A hash, used as a set, of resource already seen
2896: $self->{ALREADY_SEEN} = shift;
2897: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
2898: $self->{CONDITION} = shift;
2899:
2900: # Do we want to automatically follow "redirection" maps?
2901: $self->{FORCE_TOP} = shift;
2902:
2903: # Do we want to return the top-level map object (resource 0.0)?
2904: $self->{RETURN_0} = shift;
2905: # have we done that yet?
2906: $self->{HAVE_RETURNED_0} = 0;
2907:
2908: # Now, we need to pre-process the map, by walking forward and backward
2909: # over the parts of the map we're going to look at.
2910:
2911: # The processing steps are exactly the same, except for a few small
2912: # changes, so I bundle those up in the following list of two elements:
2913: # (direction_to_iterate, VAL_name, next_resource_method_to_call,
2914: # first_resource).
2915: # This prevents writing nearly-identical code twice.
2916: my @iterations = ( [FORWARD(), 'TOP_DOWN_VAL', 'getNext',
2917: 'FIRST_RESOURCE'],
2918: [BACKWARD(), 'BOT_UP_VAL', 'getPrevious',
2919: 'FINISH_RESOURCE'] );
2920:
2921: my $maxDepth = 0; # tracks max depth
2922:
2923: # If there is only one resource in this map, and it's a map, we
2924: # want to remember that, so the user can ask for the first map
2925: # that isn't just a redirector.
2926: my $resource; my $resourceCount = 0;
2927:
2928: # Documentation on this algorithm can be found in the CVS repository at
2929: # /docs/lonnavdocs; these "**#**" markers correspond to documentation
2930: # in that file.
2931: # **1**
2932:
2933: foreach my $pass (@iterations) {
2934: my $direction = $pass->[0];
2935: my $valName = $pass->[1];
2936: my $nextResourceMethod = $pass->[2];
2937: my $firstResourceName = $pass->[3];
2938:
2939: my $iterator = Apache::lonnavmaps::DFSiterator->new($self->{NAV_MAP},
2940: $self->{FIRST_RESOURCE},
2941: $self->{FINISH_RESOURCE},
2942: {}, undef, 0, $direction);
2943:
2944: # prime the recursion
2945: $self->{$firstResourceName}->{DATA}->{$valName} = 0;
2946: $iterator->next();
2947: my $curRes = $iterator->next();
2948: my $depth = 1;
2949: while ($depth > 0) {
2950: if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
2951: if ($curRes == $iterator->END_MAP()) { $depth--; }
2952:
2953: if (ref($curRes)) {
2954: # If there's only one resource, this will save it
2955: # we have to filter empty resources from consideration here,
2956: # or even "empty", redirecting maps have two (start & finish)
2957: # or three (start, finish, plus redirector)
2958: if($direction == FORWARD && $curRes->src()) {
2959: $resource = $curRes; $resourceCount++;
2960: }
2961: my $resultingVal = $curRes->{DATA}->{$valName};
2962: my $nextResources = $curRes->$nextResourceMethod();
2963: my $nextCount = scalar(@{$nextResources});
2964:
2965: if ($nextCount == 1) { # **3**
2966: my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;
2967: $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
2968: }
2969:
2970: if ($nextCount > 1) { # **4**
2971: foreach my $res (@{$nextResources}) {
2972: my $current = $res->{DATA}->{$valName} || 999999999;
2973: $res->{DATA}->{$valName} = min($current, $resultingVal + 1);
2974: }
2975: }
2976: }
2977:
2978: # Assign the final val (**2**)
2979: if (ref($curRes) && $direction == BACKWARD()) {
2980: my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},
2981: $curRes->{DATA}->{BOT_UP_VAL});
2982:
2983: $curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;
2984: if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}
2985: }
2986:
2987: $curRes = $iterator->next();
2988: }
2989: }
2990:
2991: # Check: Was this only one resource, a map?
2992: if ($resourceCount == 1 && $resource->is_sequence() && !$self->{FORCE_TOP}) {
2993: my $firstResource = $resource->map_start();
2994: my $finishResource = $resource->map_finish();
2995: return
2996: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
2997: $finishResource, $self->{FILTER},
2998: $self->{ALREADY_SEEN},
2999: $self->{CONDITION},
3000: $self->{FORCE_TOP});
3001:
3002: }
3003:
3004: # Set up some bookkeeping information.
3005: $self->{CURRENT_DEPTH} = 0;
3006: $self->{MAX_DEPTH} = $maxDepth;
3007: $self->{STACK} = [];
3008: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3009: $self->{FINISHED} = 0; # When true, the iterator has finished
3010:
3011: for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) {
3012: push @{$self->{STACK}}, [];
3013: }
3014:
3015: # Prime the recursion w/ the first resource **5**
3016: push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};
3017: $self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;
3018:
3019: bless ($self);
3020:
3021: return $self;
3022: }
3023:
3024: sub next {
3025: my $self = shift;
3026: my $closeAllPages=shift;
3027: if ($self->{FINISHED}) {
3028: return END_ITERATOR();
3029: }
3030:
3031: # If we want to return the top-level map object, and haven't yet,
3032: # do so.
3033: if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {
3034: $self->{HAVE_RETURNED_0} = 1;
3035: return $self->{NAV_MAP}->getById('0.0');
3036: }
3037: if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0_BEGIN_MAP}) {
3038: $self->{HAVE_RETURNED_0_BEGIN_MAP} = 1;
3039: return $self->BEGIN_MAP();
3040: }
3041:
3042: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3043: # grab the next from the recursive iterator
3044: my $next = $self->{RECURSIVE_ITERATOR}->next($closeAllPages);
3045:
3046: # is it a begin or end map? If so, update the depth
3047: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
3048: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
3049:
3050: # Are we back at depth 0? If so, stop recursing
3051: if ($self->{RECURSIVE_DEPTH} == 0) {
3052: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3053: }
3054:
3055: return $next;
3056: }
3057:
3058: if (defined($self->{FORCE_NEXT})) {
3059: my $tmp = $self->{FORCE_NEXT};
3060: $self->{FORCE_NEXT} = undef;
3061: return $tmp;
3062: }
3063:
3064: # Have we not yet begun? If not, return BEGIN_MAP and
3065: # remember we've started.
3066: if ( !$self->{STARTED} ) {
3067: $self->{STARTED} = 1;
3068: return $self->BEGIN_MAP();
3069: }
3070:
3071: # Here's the guts of the iterator.
3072:
3073: # Find the next resource, if any.
3074: my $found = 0;
3075: my $i = $self->{MAX_DEPTH};
3076: my $newDepth;
3077: my $here;
3078: while ( $i >= 0 && !$found ) {
3079: if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6**
3080: $here = pop @{$self->{STACK}->[$i]}; # **7**
3081: $found = 1;
3082: $newDepth = $i;
3083: }
3084: $i--;
3085: }
3086:
3087: # If we still didn't find anything, we're done.
3088: if ( !$found ) {
3089: # We need to get back down to the correct branch depth
3090: if ( $self->{CURRENT_DEPTH} > 0 ) {
3091: $self->{CURRENT_DEPTH}--;
3092: return END_BRANCH();
3093: } else {
3094: $self->{FINISHED} = 1;
3095: return END_MAP();
3096: }
3097: }
3098:
3099: # If this is not a resource, it must be an END_BRANCH marker we want
3100: # to return directly.
3101: if (!ref($here)) { # **8**
3102: if ($here == END_BRANCH()) { # paranoia, in case of later extension
3103: $self->{CURRENT_DEPTH}--;
3104: return $here;
3105: }
3106: }
3107:
3108: # Otherwise, it is a resource and it's safe to store in $self->{HERE}
3109: $self->{HERE} = $here;
3110:
3111: # Get to the right level
3112: if ( $self->{CURRENT_DEPTH} > $newDepth ) {
3113: push @{$self->{STACK}->[$newDepth]}, $here;
3114: $self->{CURRENT_DEPTH}--;
3115: return END_BRANCH();
3116: }
3117: if ( $self->{CURRENT_DEPTH} < $newDepth) {
3118: push @{$self->{STACK}->[$newDepth]}, $here;
3119: $self->{CURRENT_DEPTH}++;
3120: return BEGIN_BRANCH();
3121: }
3122:
3123: # If we made it here, we have the next resource, and we're at the
3124: # right branch level. So let's examine the resource for where
3125: # we can get to from here.
3126:
3127: # So we need to look at all the resources we can get to from here,
3128: # categorize them if we haven't seen them, remember if we have a new
3129: my $nextUnfiltered = $here->getNext();
3130: my $maxDepthAdded = -1;
3131:
3132: for (@$nextUnfiltered) {
3133: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
3134: my $depth = $_->{DATA}->{DISPLAY_DEPTH};
3135: push @{$self->{STACK}->[$depth]}, $_;
3136: $self->{ALREADY_SEEN}->{$_->{ID}} = 1;
3137: if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; }
3138: }
3139: }
3140:
3141: # Is this the end of a branch? If so, all of the resources examined above
3142: # led to lower levels than the one we are currently at, so we push a END_BRANCH
3143: # marker onto the stack so we don't forget.
3144: # Example: For the usual A(BC)(DE)F case, when the iterator goes down the
3145: # BC branch and gets to C, it will see F as the only next resource, but it's
3146: # one level lower. Thus, this is the end of the branch, since there are no
3147: # more resources added to this level or above.
3148: # We don't do this if the examined resource is the finish resource,
3149: # because the condition given above is true, but the "END_MAP" will
3150: # take care of things and we should already be at depth 0.
3151: my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH};
3152: if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9**
3153: push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH();
3154: }
3155:
3156: # That ends the main iterator logic. Now, do we want to recurse
3157: # down this map (if this resource is a map)?
3158: if ( ($self->{HERE}->is_sequence() || (!$closeAllPages && $self->{HERE}->is_page())) &&
3159: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
3160: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3161: my $firstResource = $self->{HERE}->map_start();
3162: my $finishResource = $self->{HERE}->map_finish();
3163:
3164: $self->{RECURSIVE_ITERATOR} =
3165: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
3166: $finishResource, $self->{FILTER},
3167: $self->{ALREADY_SEEN},
3168: $self->{CONDITION},
3169: $self->{FORCE_TOP});
3170: }
3171:
3172: # If this is a blank resource, don't actually return it.
3173: # Should you ever find you need it, make sure to add an option to the code
3174: # that you can use; other things depend on this behavior.
3175: my $browsePriv = $self->{HERE}->browsePriv();
3176: if (!$self->{HERE}->src() ||
3177: (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
3178: return $self->next($closeAllPages);
3179: }
3180:
3181: return $self->{HERE};
3182:
3183: }
3184:
3185: =pod
3186:
3187: The other method available on the iterator is B<getStack>, which
3188: returns an array populated with the current 'stack' of maps, as
3189: references to the resource objects. Example: This is useful when
3190: making the navigation map, as we need to check whether we are under a
3191: page map to see if we need to link directly to the resource, or to the
3192: page. The first elements in the array will correspond to the top of
3193: the stack (most inclusive map).
3194:
3195: =cut
3196:
3197: sub getStack {
3198: my $self=shift;
3199:
3200: my @stack;
3201:
3202: $self->populateStack(\@stack);
3203:
3204: return \@stack;
3205: }
3206:
3207: # Private method: Calls the iterators recursively to populate the stack.
3208: sub populateStack {
3209: my $self=shift;
3210: my $stack = shift;
3211:
3212: push @$stack, $self->{HERE} if ($self->{HERE});
3213:
3214: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3215: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3216: }
3217: }
3218:
3219: 1;
3220:
3221: package Apache::lonnavmaps::DFSiterator;
3222: use Scalar::Util qw(weaken);
3223: use Apache::lonnet;
3224:
3225: # Not documented in the perldoc: This is a simple iterator that just walks
3226: # through the nav map and presents the resources in a depth-first search
3227: # fashion, ignorant of conditionals, randomized resources, etc. It presents
3228: # BEGIN_MAP and END_MAP, but does not understand branches at all. It is
3229: # useful for pre-processing of some kind, and is in fact used by the main
3230: # iterator that way, but that's about it.
3231: # One could imagine merging this into the init routine of the main iterator,
3232: # but this might as well be left separate, since it is possible some other
3233: # use might be found for it. - Jeremy
3234:
3235: # Unlike the main iterator, this DOES return all resources, even blank ones.
3236: # The main iterator needs them to correctly preprocess the map.
3237:
3238: sub BEGIN_MAP { return 1; } # begining of a new map
3239: sub END_MAP { return 2; } # end of the map
3240: sub FORWARD { return 1; } # go forward
3241: sub BACKWARD { return 2; }
3242:
3243: # Params: Nav map ref, first resource id/ref, finish resource id/ref,
3244: # filter hash ref (or undef), already seen hash or undef, condition
3245: # (as in main iterator), direction FORWARD or BACKWARD (undef->forward).
3246: sub new {
3247: # magic invocation to create a class instance
3248: my $proto = shift;
3249: my $class = ref($proto) || $proto;
3250: my $self = {};
3251:
3252: weaken($self->{NAV_MAP} = shift);
3253: return undef unless ($self->{NAV_MAP});
3254:
3255: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
3256: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
3257:
3258: # If the given resources are just the ID of the resource, get the
3259: # objects
3260: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
3261: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
3262: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
3263: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
3264:
3265: $self->{FILTER} = shift;
3266:
3267: # A hash, used as a set, of resource already seen
3268: $self->{ALREADY_SEEN} = shift;
3269: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
3270: $self->{CONDITION} = shift;
3271: $self->{DIRECTION} = shift || FORWARD();
3272:
3273: # Flag: Have we started yet?
3274: $self->{STARTED} = 0;
3275:
3276: # Should we continue calling the recursive iterator, if any?
3277: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3278: # The recursive iterator, if any
3279: $self->{RECURSIVE_ITERATOR} = undef;
3280: # Are we recursing on a map, or a branch?
3281: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
3282: # And the count of how deep it is, so that this iterator can keep track of
3283: # when to pick back up again.
3284: $self->{RECURSIVE_DEPTH} = 0;
3285:
3286: # For keeping track of our branches, we maintain our own stack
3287: $self->{STACK} = [];
3288:
3289: # Start with the first resource
3290: if ($self->{DIRECTION} == FORWARD) {
3291: push @{$self->{STACK}}, $self->{FIRST_RESOURCE};
3292: } else {
3293: push @{$self->{STACK}}, $self->{FINISH_RESOURCE};
3294: }
3295:
3296: bless($self);
3297: return $self;
3298: }
3299:
3300: sub next {
3301: my $self = shift;
3302:
3303: # Are we using a recursive iterator? If so, pull from that and
3304: # watch the depth; we want to resume our level at the correct time.
3305: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3306: # grab the next from the recursive iterator
3307: my $next = $self->{RECURSIVE_ITERATOR}->next();
3308:
3309: # is it a begin or end map? Update depth if so
3310: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
3311: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
3312:
3313: # Are we back at depth 0? If so, stop recursing.
3314: if ($self->{RECURSIVE_DEPTH} == 0) {
3315: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3316: }
3317:
3318: return $next;
3319: }
3320:
3321: # Is there a current resource to grab? If not, then return
3322: # END_MAP, which will end the iterator.
3323: if (scalar(@{$self->{STACK}}) == 0) {
3324: return $self->END_MAP();
3325: }
3326:
3327: # Have we not yet begun? If not, return BEGIN_MAP and
3328: # remember that we've started.
3329: if ( !$self->{STARTED} ) {
3330: $self->{STARTED} = 1;
3331: return $self->BEGIN_MAP;
3332: }
3333:
3334: # Get the next resource in the branch
3335: $self->{HERE} = pop @{$self->{STACK}};
3336:
3337: # remember that we've seen this, so we don't return it again later
3338: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
3339:
3340: # Get the next possible resources
3341: my $nextUnfiltered;
3342: if ($self->{DIRECTION} == FORWARD()) {
3343: $nextUnfiltered = $self->{HERE}->getNext();
3344: } else {
3345: $nextUnfiltered = $self->{HERE}->getPrevious();
3346: }
3347: my $next = [];
3348:
3349: # filter the next possibilities to remove things we've
3350: # already seen.
3351: foreach my $item (@$nextUnfiltered) {
3352: if (!defined($self->{ALREADY_SEEN}->{$item->{ID}})) {
3353: push @$next, $item;
3354: }
3355: }
3356:
3357: while (@$next) {
3358: # copy the next possibilities over to the stack
3359: push @{$self->{STACK}}, shift @$next;
3360: }
3361:
3362: # If this is a map and we want to recurse down it... (not filtered out)
3363: if ($self->{HERE}->is_map() &&
3364: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
3365: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3366: my $firstResource = $self->{HERE}->map_start();
3367: my $finishResource = $self->{HERE}->map_finish();
3368:
3369: $self->{RECURSIVE_ITERATOR} =
3370: Apache::lonnavmaps::DFSiterator->new ($self->{NAV_MAP}, $firstResource,
3371: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
3372: $self->{CONDITION}, $self->{DIRECTION});
3373: }
3374:
3375: return $self->{HERE};
3376: }
3377:
3378: # Identical to the full iterator methods of the same name. Hate to copy/paste
3379: # but I also hate to "inherit" either iterator from the other.
3380:
3381: sub getStack {
3382: my $self=shift;
3383:
3384: my @stack;
3385:
3386: $self->populateStack(\@stack);
3387:
3388: return \@stack;
3389: }
3390:
3391: # Private method: Calls the iterators recursively to populate the stack.
3392: sub populateStack {
3393: my $self=shift;
3394: my $stack = shift;
3395:
3396: push @$stack, $self->{HERE} if ($self->{HERE});
3397:
3398: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3399: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3400: }
3401: }
3402:
3403: 1;
3404:
3405: package Apache::lonnavmaps::resource;
3406: use Scalar::Util qw(weaken);
3407: use Apache::lonnet;
3408:
3409: =pod
3410:
3411: =head1 Object: resource
3412:
3413: X<resource, navmap object>
3414: A resource object encapsulates a resource in a resource map, allowing
3415: easy manipulation of the resource, querying the properties of the
3416: resource (including user properties), and represents a reference that
3417: can be used as the canonical representation of the resource by
3418: lonnavmap clients like renderers.
3419:
3420: A resource only makes sense in the context of a navmap, as some of the
3421: data is stored in the navmap object.
3422:
3423: You will probably never need to instantiate this object directly. Use
3424: Apache::lonnavmaps::navmap, and use the "start" method to obtain the
3425: starting resource.
3426:
3427: Resource objects respect the parameter_hiddenparts, which suppresses
3428: various parts according to the wishes of the map author. As of this
3429: writing, there is no way to override this parameter, and suppressed
3430: parts will never be returned, nor will their response types or ids be
3431: stored.
3432:
3433: =head2 Overview
3434:
3435: A B<Resource> is the most granular type of object in LON-CAPA that can
3436: be included in a course. It can either be a particular resource, like
3437: an HTML page, external resource, problem, etc., or it can be a
3438: container sequence, such as a "page" or a "map".
3439:
3440: To see a sequence from the user's point of view, please see the
3441: B<Creating a Course: Maps and Sequences> chapter of the Author's
3442: Manual.
3443:
3444: A Resource Object, once obtained from a navmap object via a B<getBy*>
3445: method of the navmap, or from an iterator, allows you to query
3446: information about that resource.
3447:
3448: Generally, you do not ever want to create a resource object yourself,
3449: so creation has been left undocumented. Always retrieve resources
3450: from navmap objects.
3451:
3452: =head3 Identifying Resources
3453:
3454: X<big hash>Every resource is identified by a Resource ID in the big hash that is
3455: unique to that resource for a given course. X<resource ID, in big hash>
3456: The Resource ID has the form #.#, where the first number is the same
3457: for every resource in a map, and the second is unique. For instance,
3458: for a course laid out like this:
3459:
3460: * Problem 1
3461: * Map
3462: * Resource 2
3463: * Resource 3
3464:
3465: C<Problem 1> and C<Map> will share a first number, and C<Resource 2>
3466: C<Resource 3> will share a first number. The second number may end up
3467: re-used between the two groups.
3468:
3469: The resource ID is only used in the big hash, but can be used in the
3470: context of a course to identify a resource easily. (For instance, the
3471: printing system uses it to record which resources from a sequence you
3472: wish to print.)
3473:
3474: X<symb> X<resource, symb>
3475: All resources also have B<symb>s, which uniquely identify a resource
3476: in a course. Many internal LON-CAPA functions expect a symb. A symb
3477: carries along with it the URL of the resource, and the map it appears
3478: in. Symbs are much larger than resource IDs.
3479:
3480: =cut
3481:
3482: sub new {
3483: # magic invocation to create a class instance
3484: my $proto = shift;
3485: my $class = ref($proto) || $proto;
3486: my $self = {};
3487:
3488: weaken($self->{NAV_MAP} = shift);
3489: $self->{ID} = shift;
3490:
3491: # Store this new resource in the parent nav map's cache.
3492: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
3493: $self->{RESOURCE_ERROR} = 0;
3494:
3495: # A hash that can be used by two-pass algorithms to store data
3496: # about this resource in. Not used by the resource object
3497: # directly.
3498: $self->{DATA} = {};
3499:
3500: bless($self);
3501:
3502: return $self;
3503: }
3504:
3505: # private function: simplify the NAV_HASH lookups we keep doing
3506: # pass the name, and to automatically append my ID, pass a true val on the
3507: # second param
3508: sub navHash {
3509: my $self = shift;
3510: my $param = shift;
3511: my $id = shift;
3512: my $arg = $param . ($id?$self->{ID}:"");
3513: if (defined($arg)) {
3514: return $self->{NAV_MAP}->navhash($arg);
3515: }
3516: return;
3517: }
3518:
3519: =pod
3520:
3521: =head2 Methods
3522:
3523: Once you have a resource object, here's what you can do with it:
3524:
3525: =head3 Attribute Retrieval
3526:
3527: Every resource has certain attributes that can be retrieved and used:
3528:
3529: =over 4
3530:
3531: =item * B<ID>: Every resource has an ID that is unique for that
3532: resource in the course it is in. The ID is actually in the hash
3533: representing the resource, so for a resource object $res, obtain
3534: it via C<$res->{ID}).
3535:
3536: =item * B<compTitle>:
3537:
3538: Returns a "composite title", that is equal to $res->title() if the
3539: resource has a title, and is otherwise the last part of the URL (e.g.,
3540: "problem.problem").
3541:
3542: =item * B<ext>:
3543:
3544: Returns true if the resource is external.
3545:
3546: =item * B<kind>:
3547:
3548: Returns the kind of the resource from the compiled nav map.
3549:
3550: =item * B<randomout>:
3551:
3552: Returns true if this resource was chosen to NOT be shown to the user
3553: by the random map selection feature. In other words, this is usually
3554: false.
3555:
3556: =item * B<randompick>:
3557:
3558: Returns the number of randomly picked items for a map if the randompick
3559: feature is being used on the map.
3560:
3561: =item * B<randomorder>:
3562:
3563: Returns true for a map if the randomorder feature is being used on the
3564: map.
3565:
3566: =item * B<src>:
3567:
3568: Returns the source for the resource.
3569:
3570: =item * B<symb>:
3571:
3572: Returns the symb for the resource.
3573:
3574: =item * B<title>:
3575:
3576: Returns the title of the resource.
3577:
3578: =back
3579:
3580: =cut
3581:
3582: # These info functions can be used directly, as they don't return
3583: # resource information.
3584: sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
3585: sub encrypted { my $self=shift; return $self->navHash("encrypted_", 1); }
3586: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
3587: sub from { my $self=shift; return $self->navHash("from_", 1); }
3588: # considered private and undocumented
3589: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
3590: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
3591: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
3592: sub randompick {
3593: my $self = shift;
3594: my $randompick = $self->parmval('randompick');
3595: return $randompick;
3596: }
3597: sub randomorder {
3598: my $self = shift;
3599: my $randomorder = $self->parmval('randomorder');
3600: return ($randomorder =~ /^yes$/i);
3601: }
3602: sub link {
3603: my $self=shift;
3604: if ($self->encrypted()) { return &Apache::lonenc::encrypted($self->src); }
3605: return $self->src;
3606: }
3607: sub src {
3608: my $self=shift;
3609: return $self->navHash("src_", 1);
3610: }
3611: sub shown_symb {
3612: my $self=shift;
3613: if ($self->encrypted()) {return &Apache::lonenc::encrypted($self->symb());}
3614: return $self->symb();
3615: }
3616: sub id {
3617: my $self=shift;
3618: return $self->{ID};
3619: }
3620: sub enclosing_map_src {
3621: my $self=shift;
3622: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
3623: return $self->navHash('map_id_'.$first);
3624: }
3625: sub symb {
3626: my $self=shift;
3627: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
3628: my $symbSrc = &Apache::lonnet::declutter($self->src());
3629: my $symb = &Apache::lonnet::declutter($self->navHash('map_id_'.$first))
3630: . '___' . $second . '___' . $symbSrc;
3631: return &Apache::lonnet::symbclean($symb);
3632: }
3633: sub wrap_symb {
3634: my $self = shift;
3635: return $self->{NAV_MAP}->wrap_symb($self->symb());
3636: }
3637: sub title {
3638: my $self=shift;
3639: if ($self->{ID} eq '0.0') {
3640: # If this is the top-level map, return the title of the course
3641: # since this map can not be titled otherwise.
3642: return $env{'course.'.$env{'request.course.id'}.'.description'};
3643: }
3644: return $self->navHash("title_", 1); }
3645: # considered private and undocumented
3646: sub to { my $self=shift; return $self->navHash("to_", 1); }
3647: sub condition {
3648: my $self=shift;
3649: my $undercond=$self->navHash("undercond_", 1);
3650: if (!defined($undercond)) { return 1; };
3651: my $condid=$self->navHash("condid_$undercond");
3652: if (!defined($condid)) { return 1; };
3653: my $condition=&Apache::lonnet::directcondval($condid);
3654: return $condition;
3655: }
3656: sub condval {
3657: my $self=shift;
3658: my ($pathname,$filename) =
3659: &Apache::lonnet::split_uri_for_cond($self->src());
3660:
3661: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
3662: /\&\Q$filename\E\:([\d\|]+)\&/);
3663: if ($match) {
3664: return &Apache::lonnet::condval($1);
3665: }
3666: return 0;
3667: }
3668: sub compTitle {
3669: my $self = shift;
3670: my $title = $self->title();
3671: $title=~s/\&colon\;/\:/gs;
3672: if (!$title) {
3673: $title = $self->src();
3674: $title = substr($title, rindex($title, '/') + 1);
3675: }
3676: return $title;
3677: }
3678:
3679: =pod
3680:
3681: B<Predicate Testing the Resource>
3682:
3683: These methods are shortcuts to deciding if a given resource has a given property.
3684:
3685: =over 4
3686:
3687: =item * B<is_map>:
3688:
3689: Returns true if the resource is a map type.
3690:
3691: =item * B<is_problem>:
3692:
3693: Returns true if the resource is a problem type, false
3694: otherwise. (Looks at the extension on the src field; might need more
3695: to work correctly.)
3696:
3697: =item * B<is_page>:
3698:
3699: Returns true if the resource is a page.
3700:
3701: =item * B<is_sequence>:
3702:
3703: Returns true if the resource is a sequence.
3704:
3705: =back
3706:
3707: =cut
3708:
3709: sub hasResource {
3710: my $self = shift;
3711: return $self->{NAV_MAP}->hasResource(@_);
3712: }
3713:
3714: sub retrieveResources {
3715: my $self = shift;
3716: return $self->{NAV_MAP}->retrieveResources(@_);
3717: }
3718:
3719: sub is_exam {
3720: my ($self,$part) = @_;
3721: my $type = $self->parmval('type',$part);
3722: if ($type eq 'exam') {
3723: return 1;
3724: }
3725: if ($self->src() =~ /\.(exam)$/) {
3726: return 1;
3727: }
3728: return 0;
3729: }
3730: sub is_html {
3731: my $self=shift;
3732: my $src = $self->src();
3733: return ($src =~ /html$/);
3734: }
3735: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
3736: sub is_page {
3737: my $self=shift;
3738: my $src = $self->src();
3739: return $self->navHash("is_map_", 1) &&
3740: $self->navHash("map_type_" . $self->map_pc()) eq 'page';
3741: }
3742: sub is_practice {
3743: my $self=shift;
3744: my ($part) = @_;
3745: my $type = $self->parmval('type',$part);
3746: if ($type eq 'practice') {
3747: return 1;
3748: }
3749: return 0;
3750: }
3751: sub is_problem {
3752: my $self=shift;
3753: my $src = $self->src();
3754: if ($src =~ /\.(problem|exam|quiz|assess|survey|form|library|task)$/) {
3755: return !($self->is_practice());
3756: }
3757: return 0;
3758: }
3759: #
3760: # The has below is the set of status that are considered 'incomplete'
3761: #
3762: my %incomplete_hash =
3763: (
3764: TRIES_LEFT() => 1,
3765: OPEN() => 1,
3766: ATTEMPTED() => 1
3767:
3768: );
3769: #
3770: # Return tru if a problem is incomplete... for now incomplete means that
3771: # any part of the problem is incomplete.
3772: # Note that if the resources is not a problem, 0 is returned.
3773: #
3774: sub is_incomplete {
3775: my $self = shift;
3776: if ($self->is_problem()) {
3777: &Apache::lonnet::logthis('is problem');
3778: foreach my $part (@{$self->parts()}) {
3779: &Apache::lonnet::logthis("$part status ".$self->status($part));
3780: if (exists($incomplete_hash{$self->status($part)})) {
3781: return 1;
3782: }
3783: }
3784: }
3785: return 0;
3786:
3787: }
3788: sub is_raw_problem {
3789: my $self=shift;
3790: my $src = $self->src();
3791: if ($src =~ /\.(problem|exam|quiz|assess|survey|form|library|task)$/) {
3792: return 1;
3793: }
3794: return 0;
3795: }
3796:
3797: sub contains_problem {
3798: my $self=shift;
3799: if ($self->is_page()) {
3800: my $hasProblem=$self->hasResource($self,sub { $_[0]->is_problem() },1);
3801: return $hasProblem;
3802: }
3803: return 0;
3804: }
3805: sub map_contains_problem {
3806: my $self=shift;
3807: if ($self->is_map()) {
3808: my $has_problem=
3809: $self->hasResource($self,sub { $_[0]->is_problem() },1);
3810: return $has_problem;
3811: }
3812: return 0;
3813: }
3814: sub is_sequence {
3815: my $self=shift;
3816: return $self->navHash("is_map_", 1) &&
3817: $self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
3818: }
3819: sub is_survey {
3820: my $self = shift();
3821: my $part = shift();
3822: my $type = $self->parmval('type',$part);
3823: if (($type eq 'survey') || ($type eq 'surveycred')) {
3824: return 1;
3825: }
3826: if ($self->src() =~ /\.(survey)$/) {
3827: return 1;
3828: }
3829: return 0;
3830: }
3831: sub is_anonsurvey {
3832: my $self = shift();
3833: my $part = shift();
3834: my $type = $self->parmval('type',$part);
3835: if (($type eq 'anonsurvey') || ($type eq 'anonsurveycred')) {
3836: return 1;
3837: }
3838: return 0;
3839: }
3840: sub is_task {
3841: my $self=shift;
3842: my $src = $self->src();
3843: return ($src =~ /\.(task)$/)
3844: }
3845:
3846: sub is_empty_sequence {
3847: my $self=shift;
3848: my $src = $self->src();
3849: return !$self->is_page() && $self->navHash("is_map_", 1) && !$self->navHash("map_type_" . $self->map_pc());
3850: }
3851:
3852: # Private method: Shells out to the parmval in the nav map, handler parts.
3853: sub parmval {
3854: my $self = shift;
3855: my $what = shift;
3856: my $part = shift;
3857: if (!defined($part)) {
3858: $part = '0';
3859: }
3860: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
3861: }
3862:
3863: =pod
3864:
3865: B<Map Methods>
3866:
3867: These methods are useful for getting information about the map
3868: properties of the resource, if the resource is a map (B<is_map>).
3869:
3870: =over 4
3871:
3872: =item * B<map_finish>:
3873:
3874: Returns a reference to a resource object corresponding to the finish
3875: resource of the map.
3876:
3877: =item * B<map_pc>:
3878:
3879: Returns the pc value of the map, which is the first number that
3880: appears in the resource ID of the resources in the map, and is the
3881: number that appears around the middle of the symbs of the resources in
3882: that map.
3883:
3884: =item * B<map_start>:
3885:
3886: Returns a reference to a resource object corresponding to the start
3887: resource of the map.
3888:
3889: =item * B<map_type>:
3890:
3891: Returns a string with the type of the map in it.
3892:
3893: =back
3894:
3895: =cut
3896:
3897: sub map_finish {
3898: my $self = shift;
3899: my $src = $self->src();
3900: $src = &Apache::lonnet::clutter($src);
3901: my $res = $self->navHash("map_finish_$src", 0);
3902: $res = $self->{NAV_MAP}->getById($res);
3903: return $res;
3904: }
3905: sub map_pc {
3906: my $self = shift;
3907: my $src = $self->src();
3908: return $self->navHash("map_pc_$src", 0);
3909: }
3910: sub map_start {
3911: my $self = shift;
3912: my $src = $self->src();
3913: $src = &Apache::lonnet::clutter($src);
3914: my $res = $self->navHash("map_start_$src", 0);
3915: $res = $self->{NAV_MAP}->getById($res);
3916: return $res;
3917: }
3918: sub map_type {
3919: my $self = shift;
3920: my $pc = $self->map_pc();
3921: return $self->navHash("map_type_$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