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