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