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