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