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