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