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