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