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