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