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