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