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