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