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