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