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