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