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