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