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