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