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