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