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