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