Annotation of loncom/interface/lonnavmaps.pm, revision 1.428
1.2 www 1: # The LearningOnline Network with CAPA
2: # Navigate Maps Handler
1.1 www 3: #
1.428 ! droeschl 4: # $Id: lonnavmaps.pm,v 1.427 2009/02/24 22:05:26 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.426 droeschl 868: $newBranchText = "<img src='$location/branch.gif' alt='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.424 schulted 965: $curMarkerBegin = '<em style="font-weight:bold;">';
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.281 albertel 1466: $result.=&show_linkitems($args->{'linkitems'});
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 .= "\n<table id=\"LC_nav_location\">\n<tbody>\n<tr>\n<td class=\"LC_current_location\"> </td>\n</tr>\n</tbody>\n</table>\n";
1490: $result .= "<br />\n";
1491:
1.132 bowersj2 1492: # Data
1.426 droeschl 1493: $result .= '<table id="LC_tableOfContent">' ."\n";
1494:
1.132 bowersj2 1495: my $res = "Apache::lonnavmaps::resource";
1496: my %condenseStatuses =
1497: ( $res->NETWORK_FAILURE => 1,
1498: $res->NOTHING_SET => 1,
1499: $res->CORRECT => 1 );
1.426 droeschl 1500: my @backgroundColors = ("LC_trEven", "LC_trOdd");
1.133 bowersj2 1501:
1502: # Shared variables
1503: $args->{'counter'} = 0; # counts the rows
1504: $args->{'indentLevel'} = 0;
1505: $args->{'isNewBranch'} = 0;
1.426 droeschl 1506: $args->{'condensed'} = 0;
1507:
1.428 ! droeschl 1508: my $location = &Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace_21.gif");
1.426 droeschl 1509: $args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='$location' alt='' />");
1.133 bowersj2 1510: $args->{'displayedHereMarker'} = 0;
1.132 bowersj2 1511:
1.190 bowersj2 1512: # If we're suppressing empty sequences, look for them here. Use DFS for speed,
1513: # since structure actually doesn't matter, except what map has what resources.
1514: if ($args->{'suppressEmptySequences'}) {
1515: my $dfsit = Apache::lonnavmaps::DFSiterator->new($navmap,
1516: $it->{FIRST_RESOURCE},
1517: $it->{FINISH_RESOURCE},
1518: {}, undef, 1);
1.222 bowersj2 1519: my $depth = 0;
1.190 bowersj2 1520: $dfsit->next();
1521: my $curRes = $dfsit->next();
1522: while ($depth > -1) {
1523: if ($curRes == $dfsit->BEGIN_MAP()) { $depth++; }
1524: if ($curRes == $dfsit->END_MAP()) { $depth--; }
1525:
1526: if (ref($curRes)) {
1527: # Parallel pre-processing: Do sequences have non-filtered-out children?
1.201 bowersj2 1528: if ($curRes->is_map()) {
1.190 bowersj2 1529: $curRes->{DATA}->{HAS_VISIBLE_CHILDREN} = 0;
1530: # Sequences themselves do not count as visible children,
1531: # unless those sequences also have visible children.
1532: # This means if a sequence appears, there's a "promise"
1533: # that there's something under it if you open it, somewhere.
1534: } else {
1535: # Not a sequence: if it's filtered, ignore it, otherwise
1536: # rise up the stack and mark the sequences as having children
1537: if (&$filterFunc($curRes)) {
1538: for my $sequence (@{$dfsit->getStack()}) {
1539: $sequence->{DATA}->{HAS_VISIBLE_CHILDREN} = 1;
1540: }
1541: }
1542: }
1543: }
1544: } continue {
1545: $curRes = $dfsit->next();
1546: }
1547: }
1548:
1.133 bowersj2 1549: my $displayedJumpMarker = 0;
1.132 bowersj2 1550: # Set up iteration.
1551: my $now = time();
1552: my $in24Hours = $now + 24 * 60 * 60;
1553: my $rownum = 0;
1554:
1.141 bowersj2 1555: # export "here" marker information
1556: $args->{'here'} = $here;
1557:
1.222 bowersj2 1558: $args->{'indentLevel'} = -1; # first BEGIN_MAP takes this to 0
1.270 albertel 1559: my @resources;
1560: my $code='';# sub { !(shift->is_map();) };
1561: if ($args->{'sort'} eq 'title') {
1.276 albertel 1562: my $oldFilterFunc = $filterFunc;
1563: my $filterFunc=
1564: sub {
1565: my ($res)=@_;
1566: if ($res->is_map()) { return 0;}
1567: return &$oldFilterFunc($res);
1568: };
1569: @resources=$navmap->retrieveResources(undef,$filterFunc);
1.296 albertel 1570: @resources= sort { &cmp_title($a,$b) } @resources;
1571: } elsif ($args->{'sort'} eq 'duedate') {
1572: my $oldFilterFunc = $filterFunc;
1573: my $filterFunc=
1574: sub {
1575: my ($res)=@_;
1576: if (!$res->is_problem()) { return 0;}
1577: return &$oldFilterFunc($res);
1578: };
1579: @resources=$navmap->retrieveResources(undef,$filterFunc);
1.289 raeburn 1580: @resources= sort {
1.270 albertel 1581: if ($a->duedate ne $b->duedate) {
1582: return $a->duedate cmp $b->duedate;
1583: }
1.296 albertel 1584: my $value=&cmp_title($a,$b);
1585: return $value;
1.270 albertel 1586: } @resources;
1.296 albertel 1587: } elsif ($args->{'sort'} eq 'discussion') {
1588: my $oldFilterFunc = $filterFunc;
1589: my $filterFunc=
1590: sub {
1591: my ($res)=@_;
1592: if (!$res->hasDiscussion() &&
1593: !$res->getFeedback() &&
1594: !$res->getErrors()) { return 0;}
1595: return &$oldFilterFunc($res);
1596: };
1597: @resources=$navmap->retrieveResources(undef,$filterFunc);
1598: @resources= sort { &cmp_title($a,$b) } @resources;
1.276 albertel 1599: } else {
1600: #unknow sort mechanism or default
1601: undef($args->{'sort'});
1.270 albertel 1602: }
1603:
1.276 albertel 1604:
1.270 albertel 1605: while (1) {
1606: if ($args->{'sort'}) {
1607: $curRes = shift(@resources);
1608: } else {
1609: $curRes = $it->next($closeAllPages);
1610: }
1611: if (!$curRes) { last; }
1612:
1.132 bowersj2 1613: # Maintain indentation level.
1614: if ($curRes == $it->BEGIN_MAP() ||
1615: $curRes == $it->BEGIN_BRANCH() ) {
1.133 bowersj2 1616: $args->{'indentLevel'}++;
1.132 bowersj2 1617: }
1618: if ($curRes == $it->END_MAP() ||
1619: $curRes == $it->END_BRANCH() ) {
1.133 bowersj2 1620: $args->{'indentLevel'}--;
1.132 bowersj2 1621: }
1622: # Notice new branches
1623: if ($curRes == $it->BEGIN_BRANCH()) {
1.133 bowersj2 1624: $args->{'isNewBranch'} = 1;
1625: }
1626:
1627: # If this isn't an actual resource, continue on
1628: if (!ref($curRes)) {
1629: next;
1.132 bowersj2 1630: }
1.133 bowersj2 1631:
1.143 bowersj2 1632: # If this has been filtered out, continue on
1633: if (!(&$filterFunc($curRes))) {
1634: $args->{'isNewBranch'} = 0; # Don't falsely remember this
1635: next;
1636: }
1.132 bowersj2 1637:
1.190 bowersj2 1638: # If this is an empty sequence and we're filtering them, continue on
1.201 bowersj2 1639: if ($curRes->is_map() && $args->{'suppressEmptySequences'} &&
1.190 bowersj2 1640: !$curRes->{DATA}->{HAS_VISIBLE_CHILDREN}) {
1641: next;
1642: }
1643:
1.153 bowersj2 1644: # If we're suppressing navmaps and this is a navmap, continue on
1645: if ($suppressNavmap && $curRes->src() =~ /^\/adm\/navmaps/) {
1646: next;
1647: }
1648:
1.191 bowersj2 1649: $args->{'counter'}++;
1650:
1.132 bowersj2 1651: # Does it have multiple parts?
1.133 bowersj2 1652: $args->{'multipart'} = 0;
1653: $args->{'condensed'} = 0;
1.132 bowersj2 1654: my @parts;
1655:
1656: # Decide what parts to show.
1.133 bowersj2 1657: if ($curRes->is_problem() && $showParts) {
1.132 bowersj2 1658: @parts = @{$curRes->parts()};
1.192 bowersj2 1659: $args->{'multipart'} = $curRes->multipart();
1.132 bowersj2 1660:
1661: if ($condenseParts) { # do the condensation
1.133 bowersj2 1662: if (!$args->{'condensed'}) {
1.132 bowersj2 1663: # Decide whether to condense based on similarity
1.192 bowersj2 1664: my $status = $curRes->status($parts[0]);
1665: my $due = $curRes->duedate($parts[0]);
1666: my $open = $curRes->opendate($parts[0]);
1.132 bowersj2 1667: my $statusAllSame = 1;
1668: my $dueAllSame = 1;
1669: my $openAllSame = 1;
1.192 bowersj2 1670: for (my $i = 1; $i < scalar(@parts); $i++) {
1.132 bowersj2 1671: if ($curRes->status($parts[$i]) != $status){
1672: $statusAllSame = 0;
1673: }
1674: if ($curRes->duedate($parts[$i]) != $due ) {
1675: $dueAllSame = 0;
1676: }
1677: if ($curRes->opendate($parts[$i]) != $open) {
1678: $openAllSame = 0;
1679: }
1680: }
1681: # $*allSame is true if all the statuses were
1682: # the same. Now, if they are all the same and
1683: # match one of the statuses to condense, or they
1684: # are all open with the same due date, or they are
1685: # all OPEN_LATER with the same open date, display the
1686: # status of the first non-zero part (to get the 'correct'
1687: # status right, since 0 is never 'correct' or 'open').
1688: if (($statusAllSame && defined($condenseStatuses{$status})) ||
1689: ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
1690: ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
1.192 bowersj2 1691: @parts = ($parts[0]);
1.133 bowersj2 1692: $args->{'condensed'} = 1;
1.132 bowersj2 1693: }
1694: }
1.198 bowersj2 1695: # Multipart problem with one part: always "condense" (happens
1696: # to match the desirable behavior)
1697: if ($curRes->countParts() == 1) {
1698: @parts = ($parts[0]);
1699: $args->{'condensed'} = 1;
1700: }
1.132 bowersj2 1701: }
1.157 bowersj2 1702: }
1.132 bowersj2 1703:
1704: # If the multipart problem was condensed, "forget" it was multipart
1705: if (scalar(@parts) == 1) {
1.133 bowersj2 1706: $args->{'multipart'} = 0;
1.192 bowersj2 1707: } else {
1708: # Add part 0 so we display it correctly.
1709: unshift @parts, '0';
1.132 bowersj2 1710: }
1.310 albertel 1711:
1712: {
1713: my ($src,$symb,$anchor,$stack);
1714: if ($args->{'sort'}) {
1715: my $it = $navmap->getIterator(undef, undef, undef, 1);
1716: while ( my $res=$it->next()) {
1717: if (ref($res) &&
1718: $res->symb() eq $curRes->symb()) { last; }
1719: }
1720: $stack=$it->getStack();
1721: } else {
1722: $stack=$it->getStack();
1723: }
1724: ($src,$symb,$anchor)=getLinkForResource($stack);
1725: if (defined($anchor)) { $anchor='#'.$anchor; }
1726: my $srcHasQuestion = $src =~ /\?/;
1727: $args->{"resourceLink"} = $src.
1728: ($srcHasQuestion?'&':'?') .
1.384 www 1729: 'symb=' . &escape($symb).$anchor;
1.310 albertel 1730: }
1.132 bowersj2 1731: # Now, we've decided what parts to show. Loop through them and
1732: # show them.
1.192 bowersj2 1733: foreach my $part (@parts) {
1.132 bowersj2 1734: $rownum ++;
1735: my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];
1736:
1.426 droeschl 1737: $result .= " <tr class='$backgroundColor'>\n";
1.134 bowersj2 1738:
1739: # Set up some data about the parts that the cols might want
1740: my $filter = $it->{FILTER};
1.270 albertel 1741:
1.132 bowersj2 1742: # Now, display each column.
1743: foreach my $col (@$cols) {
1.139 bowersj2 1744: my $colHTML = '';
1745: if (ref($col)) {
1746: $colHTML .= &$col($curRes, $part, $args);
1747: } else {
1748: $colHTML .= &{$preparedColumns[$col]}($curRes, $part, $args);
1749: }
1.132 bowersj2 1750:
1.133 bowersj2 1751: # If this is the first column and it's time to print
1752: # the anchor, do so
1753: if ($col == $cols->[0] &&
1754: $args->{'counter'} == $args->{'currentJumpIndex'} -
1.139 bowersj2 1755: $currentJumpDelta) {
1756: # Jam the anchor after the <td> tag;
1757: # necessary for valid HTML (which Mozilla requires)
1758: $colHTML =~ s/\>/\>\<a name="curloc" \/\>/;
1.133 bowersj2 1759: $displayedJumpMarker = 1;
1760: }
1.139 bowersj2 1761: $result .= $colHTML . "\n";
1.132 bowersj2 1762: }
1.139 bowersj2 1763: $result .= " </tr>\n";
1.140 bowersj2 1764: $args->{'isNewBranch'} = 0;
1.139 bowersj2 1765: }
1.153 bowersj2 1766:
1.139 bowersj2 1767: if ($r && $rownum % 20 == 0) {
1768: $r->print($result);
1769: $result = "";
1770: $r->rflush();
1.132 bowersj2 1771: }
1.156 bowersj2 1772: } continue {
1.208 bowersj2 1773: if ($r) {
1774: # If we have the connection, make sure the user is still connected
1775: my $c = $r->connection;
1776: if ($c->aborted()) {
1777: # Who cares what we do, nobody will see it anyhow.
1778: return '';
1779: }
1780: }
1.132 bowersj2 1781: }
1782:
1.134 bowersj2 1783: # Print out the part that jumps to #curloc if it exists
1.159 bowersj2 1784: # delay needed because the browser is processing the jump before
1785: # it finishes rendering, so it goes to the wrong place!
1786: # onload might be better, but this routine has no access to that.
1787: # On mozilla, the 0-millisecond timeout seems to prevent this;
1788: # it's quite likely this might fix other browsers, too, and
1789: # certainly won't hurt anything.
1.139 bowersj2 1790: if ($displayedJumpMarker) {
1.247 albertel 1791: $result .= "
1792: <script>
1793: if (location.href.indexOf('#curloc')==-1) {
1794: setTimeout(\"location += '#curloc';\", 0)
1795: }
1796: </script>";
1.134 bowersj2 1797: }
1798:
1.132 bowersj2 1799: $result .= "</table>";
1.140 bowersj2 1800:
1801: if ($r) {
1802: $r->print($result);
1803: $result = "";
1804: $r->rflush();
1805: }
1806:
1.132 bowersj2 1807: return $result;
1808: }
1809:
1.281 albertel 1810: sub add_linkitem {
1811: my ($linkitems,$name,$cmd,$text)=@_;
1812: $$linkitems{$name}{'cmd'}=$cmd;
1813: $$linkitems{$name}{'text'}=&mt($text);
1814: }
1815:
1816: sub show_linkitems {
1817: my ($linkitems)=@_;
1.312 albertel 1818: my @linkorder = ("blank","launchnav","closenav","firsthomework",
1819: "everything","uncompleted","changefolder","clearbubbles");
1.281 albertel 1820:
1821: my $result .= (<<ENDBLOCK);
1.283 raeburn 1822: <td align="left">
1.281 albertel 1823: <script type="text/javascript">
1824: function changeNavDisplay () {
1825: var navchoice = document.linkitems.toplink[document.linkitems.toplink.selectedIndex].value;
1826: ENDBLOCK
1827: foreach my $link (@linkorder) {
1828: $result.= "if (navchoice == '$link') {".
1829: $linkitems->{$link}{'cmd'}."}\n";
1830: }
1831: $result.='}
1832: </script>
1833: <form name="linkitems" method="post">
1.421 bisitz 1834: <span class="LC_nobreak"><select name="toplink">'."\n";
1.281 albertel 1835: foreach my $link (@linkorder) {
1836: if (defined($linkitems->{$link})) {
1837: if ($linkitems->{$link}{'text'} ne '') {
1838: $result .= ' <option value="'.$link.'">'.
1839: $linkitems->{$link}{'text'}."</option>\n";
1840: }
1841: }
1842: }
1843: $result .= '</select> <input type="button" name="chgnav"
1844: value="Go" onClick="javascript:changeNavDisplay()" />
1.421 bisitz 1845: </span></form></td>'."\n";
1.298 albertel 1846:
1.281 albertel 1847: return $result;
1848: }
1849:
1.133 bowersj2 1850: 1;
1851:
1.418 jms 1852:
1853:
1854:
1855:
1856:
1857:
1858:
1859:
1.133 bowersj2 1860: package Apache::lonnavmaps::navmap;
1861:
1862: =pod
1863:
1.216 bowersj2 1864: =head1 Object: Apache::lonnavmaps::navmap
1.133 bowersj2 1865:
1.217 bowersj2 1866: =head2 Overview
1.133 bowersj2 1867:
1.217 bowersj2 1868: The navmap object's job is to provide access to the resources
1869: in the course as Apache::lonnavmaps::resource objects, and to
1870: query and manage the relationship between those resource objects.
1871:
1872: Generally, you'll use the navmap object in one of three basic ways.
1873: In order of increasing complexity and power:
1874:
1875: =over 4
1876:
1.358 albertel 1877: =item * C<$navmap-E<gt>getByX>, where X is B<Id>, B<Symb> or B<MapPc> and getResourceByUrl. This provides
1.217 bowersj2 1878: various ways to obtain resource objects, based on various identifiers.
1879: Use this when you want to request information about one object or
1880: a handful of resources you already know the identities of, from some
1881: other source. For more about Ids, Symbs, and MapPcs, see the
1882: Resource documentation. Note that Url should be a B<last resort>,
1.358 albertel 1883: not your first choice; it only really works when there is only one
1.217 bowersj2 1884: instance of the resource in the course, which only applies to
1.358 albertel 1885: maps, and even that may change in the future (see the B<getResourceByUrl>
1886: documentation for more details.)
1.217 bowersj2 1887:
1888: =item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This
1889: retrieves resources matching some criterion and returns them
1890: in a flat array, with no structure information. Use this when
1891: you are manipulating a series of resources, based on what map
1892: the are in, but do not care about branching, or exactly how
1893: the maps and resources are related. This is the most common case.
1894:
1895: =item * C<$it = $navmap-E<gt>getIterator(args)>. This allows you traverse
1896: the course's navmap in various ways without writing the traversal
1897: code yourself. See iterator documentation below. Use this when
1898: you need to know absolutely everything about the course, including
1899: branches and the precise relationship between maps and resources.
1900:
1901: =back
1902:
1903: =head2 Creation And Destruction
1904:
1905: To create a navmap object, use the following function:
1.133 bowersj2 1906:
1907: =over 4
1908:
1.221 bowersj2 1909: =item * B<Apache::lonnavmaps::navmap-E<gt>new>():
1.133 bowersj2 1910:
1.221 bowersj2 1911: Creates a new navmap object. Returns the navmap object if this is
1912: successful, or B<undef> if not.
1.174 albertel 1913:
1.216 bowersj2 1914: =back
1915:
1916: =head2 Methods
1917:
1918: =over 4
1919:
1.174 albertel 1920: =item * B<getIterator>(first, finish, filter, condition):
1921:
1922: See iterator documentation below.
1.133 bowersj2 1923:
1924: =cut
1925:
1926: use strict;
1927: use GDBM_File;
1.320 albertel 1928: use Apache::lonnet;
1.397 albertel 1929: use LONCAPA;
1.133 bowersj2 1930:
1931: sub new {
1932: # magic invocation to create a class instance
1933: my $proto = shift;
1934: my $class = ref($proto) || $proto;
1935: my $self = {};
1936:
1937: # Resource cache stores navmap resources as we reference them. We generate
1938: # them on-demand so we don't pay for creating resources unless we use them.
1939: $self->{RESOURCE_CACHE} = {};
1940:
1941: # Network failure flag, if we accessed the course or user opt and
1942: # failed
1943: $self->{NETWORK_FAILURE} = 0;
1944:
1945: # tie the nav hash
1946:
1.168 bowersj2 1947: my %navmaphash;
1948: my %parmhash;
1.320 albertel 1949: my $courseFn = $env{"request.course.fn"};
1.220 bowersj2 1950: if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",
1.133 bowersj2 1951: &GDBM_READER(), 0640))) {
1952: return undef;
1953: }
1954:
1.220 bowersj2 1955: if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db",
1.133 bowersj2 1956: &GDBM_READER(), 0640)))
1957: {
1.170 matthew 1958: untie %{$self->{PARM_HASH}};
1.133 bowersj2 1959: return undef;
1960: }
1961:
1.199 bowersj2 1962: $self->{NAV_HASH} = \%navmaphash;
1.168 bowersj2 1963: $self->{PARM_HASH} = \%parmhash;
1.221 bowersj2 1964: $self->{PARM_CACHE} = {};
1.133 bowersj2 1965:
1966: bless($self);
1967:
1968: return $self;
1969: }
1970:
1.221 bowersj2 1971: sub generate_course_user_opt {
1.133 bowersj2 1972: my $self = shift;
1.221 bowersj2 1973: if ($self->{COURSE_USER_OPT_GENERATED}) { return; }
1.133 bowersj2 1974:
1.320 albertel 1975: my $uname=$env{'user.name'};
1976: my $udom=$env{'user.domain'};
1977: my $cid=$env{'request.course.id'};
1.326 albertel 1978: my $cdom=$env{'course.'.$cid.'.domain'};
1979: my $cnum=$env{'course.'.$cid.'.num'};
1.221 bowersj2 1980:
1.133 bowersj2 1981: # ------------------------------------------------- Get coursedata (if present)
1.326 albertel 1982: my $courseopt=&Apache::lonnet::get_courseresdata($cnum,$cdom);
1983: # Check for network failure
1984: if (!ref($courseopt)) {
1985: if ( $courseopt =~ /no.such.host/i || $courseopt =~ /con_lost/i) {
1.324 albertel 1986: $self->{NETWORK_FAILURE} = 1;
1.221 bowersj2 1987: }
1.326 albertel 1988: undef($courseopt);
1989: }
1.325 albertel 1990:
1.133 bowersj2 1991: # --------------------------------------------------- Get userdata (if present)
1.325 albertel 1992:
1.326 albertel 1993: my $useropt=&Apache::lonnet::get_userresdata($uname,$udom);
1994: # Check for network failure
1995: if (!ref($useropt)) {
1996: if ( $useropt =~ /no.such.host/i || $useropt =~ /con_lost/i) {
1.324 albertel 1997: $self->{NETWORK_FAILURE} = 1;
1.221 bowersj2 1998: }
1.326 albertel 1999: undef($useropt);
1.221 bowersj2 2000: }
2001:
1.326 albertel 2002: $self->{COURSE_OPT} = $courseopt;
2003: $self->{USER_OPT} = $useropt;
2004:
1.221 bowersj2 2005: $self->{COURSE_USER_OPT_GENERATED} = 1;
2006:
2007: return;
2008: }
2009:
2010: sub generate_email_discuss_status {
2011: my $self = shift;
1.259 raeburn 2012: my $symb = shift;
1.221 bowersj2 2013: if ($self->{EMAIL_DISCUSS_GENERATED}) { return; }
1.133 bowersj2 2014:
1.320 albertel 2015: my $cid=$env{'request.course.id'};
1.326 albertel 2016: my $cdom=$env{'course.'.$cid.'.domain'};
2017: my $cnum=$env{'course.'.$cid.'.num'};
1.221 bowersj2 2018:
2019: my %emailstatus = &Apache::lonnet::dump('email_status');
2020: my $logoutTime = $emailstatus{'logout'};
1.320 albertel 2021: my $courseLeaveTime = $emailstatus{'logout_'.$env{'request.course.id'}};
1.221 bowersj2 2022: $self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
2023: $courseLeaveTime : $logoutTime);
2024: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
2025: $cdom, $cnum);
1.259 raeburn 2026: my %lastread = &Apache::lonnet::dump('nohist_'.$cid.'_discuss',
1.320 albertel 2027: $env{'user.domain'},$env{'user.name'},'lastread');
1.259 raeburn 2028: my %lastreadtime = ();
1.394 raeburn 2029: foreach my $key (keys %lastread) {
2030: my $shortkey = $key;
2031: $shortkey =~ s/_lastread$//;
2032: $lastreadtime{$shortkey} = $lastread{$key};
1.259 raeburn 2033: }
2034:
1.221 bowersj2 2035: my %feedback=();
2036: my %error=();
1.325 albertel 2037: my @keys = &Apache::lonnet::getkeys('nohist_email',$env{'user.domain'},
2038: $env{'user.name'});
1.221 bowersj2 2039:
1.325 albertel 2040: foreach my $msgid (@keys) {
1.295 albertel 2041: if ((!$emailstatus{$msgid}) || ($emailstatus{$msgid} eq 'new')) {
1.395 raeburn 2042: my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid,
2043: $symb,$error) = &Apache::lonmsg::unpackmsgid($msgid);
1.396 raeburn 2044: &Apache::lonenc::check_decrypt(\$symb);
2045: if (($fromcid ne '') && ($fromcid ne $cid)) {
2046: next;
2047: }
1.395 raeburn 2048: if (defined($symb)) {
2049: if (defined($error) && $error == 1) {
2050: $error{$symb}.=','.$msgid;
2051: } else {
2052: $feedback{$symb}.=','.$msgid;
2053: }
2054: } else {
2055: my $plain=
2056: &LONCAPA::unescape(&LONCAPA::unescape($msgid));
2057: if ($plain=~/ \[([^\]]+)\]\:/) {
2058: my $url=$1;
2059: if ($plain=~/\:Error \[/) {
2060: $error{$url}.=','.$msgid;
2061: } else {
2062: $feedback{$url}.=','.$msgid;
2063: }
2064: }
2065: }
1.221 bowersj2 2066: }
1.211 bowersj2 2067: }
1.221 bowersj2 2068:
1.395 raeburn 2069: #symbs of resources that have feedbacks (will be urls pre-2.3)
1.221 bowersj2 2070: $self->{FEEDBACK} = \%feedback;
1.395 raeburn 2071: #or errors (will be urls pre 2.3)
1.295 albertel 2072: $self->{ERROR_MSG} = \%error;
1.221 bowersj2 2073: $self->{DISCUSSION_TIME} = \%discussiontime;
2074: $self->{EMAIL_STATUS} = \%emailstatus;
1.259 raeburn 2075: $self->{LAST_READ} = \%lastreadtime;
1.221 bowersj2 2076:
2077: $self->{EMAIL_DISCUSS_GENERATED} = 1;
2078: }
2079:
2080: sub get_user_data {
2081: my $self = shift;
2082: if ($self->{RETRIEVED_USER_DATA}) { return; }
1.211 bowersj2 2083:
1.221 bowersj2 2084: # Retrieve performance data on problems
1.320 albertel 2085: my %student_data = Apache::lonnet::currentdump($env{'request.course.id'},
2086: $env{'user.domain'},
2087: $env{'user.name'});
1.221 bowersj2 2088: $self->{STUDENT_DATA} = \%student_data;
1.133 bowersj2 2089:
1.221 bowersj2 2090: $self->{RETRIEVED_USER_DATA} = 1;
1.133 bowersj2 2091: }
2092:
1.354 raeburn 2093: sub get_discussion_data {
2094: my $self = shift;
2095: if ($self->{RETRIEVED_DISCUSSION_DATA}) {
1.366 albertel 2096: return $self->{DISCUSSION_DATA};
1.354 raeburn 2097: }
1.366 albertel 2098:
2099: $self->generate_email_discuss_status();
2100:
1.354 raeburn 2101: my $cid=$env{'request.course.id'};
2102: my $cdom=$env{'course.'.$cid.'.domain'};
2103: my $cnum=$env{'course.'.$cid.'.num'};
2104: # Retrieve discussion data for resources in course
1.367 albertel 2105: my %discussion_data = &Apache::lonnet::dumpstore($cid,$cdom,$cnum);
1.366 albertel 2106:
2107:
1.354 raeburn 2108: $self->{DISCUSSION_DATA} = \%discussion_data;
2109: $self->{RETRIEVED_DISCUSSION_DATA} = 1;
2110: return $self->{DISCUSSION_DATA};
2111: }
2112:
2113:
1.133 bowersj2 2114: # Internal function: Takes a key to look up in the nav hash and implements internal
2115: # memory caching of that key.
2116: sub navhash {
2117: my $self = shift; my $key = shift;
2118: return $self->{NAV_HASH}->{$key};
2119: }
2120:
1.217 bowersj2 2121: =pod
2122:
2123: =item * B<courseMapDefined>(): Returns true if the course map is defined,
2124: false otherwise. Undefined course maps indicate an error somewhere in
2125: LON-CAPA, and you will not be able to proceed with using the navmap.
2126: See the B<NAV> screen for an example of using this.
2127:
2128: =cut
2129:
1.133 bowersj2 2130: # Checks to see if coursemap is defined, matching test in old lonnavmaps
2131: sub courseMapDefined {
2132: my $self = shift;
1.320 albertel 2133: my $uri = &Apache::lonnet::clutter($env{'request.course.uri'});
1.133 bowersj2 2134:
2135: my $firstres = $self->navhash("map_start_$uri");
2136: my $lastres = $self->navhash("map_finish_$uri");
2137: return $firstres && $lastres;
2138: }
2139:
2140: sub getIterator {
2141: my $self = shift;
2142: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
1.314 albertel 2143: shift, undef, shift,
2144: shift, shift);
1.133 bowersj2 2145: return $iterator;
2146: }
2147:
2148: # Private method: Does the given resource (as a symb string) have
2149: # current discussion? Returns 0 if chat/mail data not extracted.
2150: sub hasDiscussion {
2151: my $self = shift;
2152: my $symb = shift;
1.221 bowersj2 2153: $self->generate_email_discuss_status();
2154:
1.133 bowersj2 2155: if (!defined($self->{DISCUSSION_TIME})) { return 0; }
2156:
2157: #return defined($self->{DISCUSSION_TIME}->{$symb});
1.259 raeburn 2158:
1.323 albertel 2159: # backward compatibility (bulletin boards used to be 'wrapped')
2160: my $ressymb = $self->wrap_symb($symb);
1.259 raeburn 2161: if ( defined ( $self->{LAST_READ}->{$ressymb} ) ) {
2162: return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_READ}->{$ressymb};
2163: } else {
1.266 raeburn 2164: # return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_CHECK}; # v.1.1 behavior
2165: 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 2166: }
1.133 bowersj2 2167: }
2168:
1.366 albertel 2169: sub last_post_time {
2170: my $self = shift;
2171: my $symb = shift;
2172: my $ressymb = $self->wrap_symb($symb);
2173: return $self->{DISCUSSION_TIME}->{$ressymb};
2174: }
2175:
1.393 raeburn 2176: sub discussion_info {
1.366 albertel 2177: my $self = shift;
2178: my $symb = shift;
1.393 raeburn 2179: my $filter = shift;
1.366 albertel 2180:
2181: $self->get_discussion_data();
1.372 raeburn 2182:
1.366 albertel 2183: my $ressymb = $self->wrap_symb($symb);
1.372 raeburn 2184: # keys used to store bulletinboard postings use 'unwrapped' symb.
1.397 albertel 2185: my $discsymb = &escape($self->unwrap_symb($ressymb));
1.372 raeburn 2186: my $version = $self->{DISCUSSION_DATA}{'version:'.$discsymb};
1.366 albertel 2187: if (!$version) { return; }
2188:
2189: my $prevread = $self->{LAST_READ}{$ressymb};
2190:
1.393 raeburn 2191: my $count = 0;
1.366 albertel 2192: my $hiddenflag = 0;
2193: my $deletedflag = 0;
1.393 raeburn 2194: my ($hidden,$deleted,%info);
1.366 albertel 2195:
2196: for (my $id=$version; $id>0; $id--) {
1.372 raeburn 2197: my $vkeys=$self->{DISCUSSION_DATA}{$id.':keys:'.$discsymb};
1.366 albertel 2198: my @keys=split(/:/,$vkeys);
2199: if (grep(/^hidden$/ ,@keys)) {
2200: if (!$hiddenflag) {
1.372 raeburn 2201: $hidden = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':hidden'};
1.366 albertel 2202: $hiddenflag = 1;
2203: }
2204: } elsif (grep(/^deleted$/,@keys)) {
2205: if (!$deletedflag) {
1.372 raeburn 2206: $deleted = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':deleted'};
1.366 albertel 2207: $deletedflag = 1;
2208: }
2209: } else {
1.393 raeburn 2210: if (($hidden !~/\.$id\./) && ($deleted !~/\.$id\./)) {
2211: if ($filter eq 'unread') {
2212: if ($prevread >= $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'}) {
2213: next;
2214: }
2215: }
2216: $count++;
2217: $info{$count}{'subject'} =
2218: $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':subject'};
2219: $info{$count}{'id'} = $id;
2220: $info{$count}{'timestamp'} = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'};
2221: }
1.366 albertel 2222: }
2223: }
2224: if (wantarray) {
1.393 raeburn 2225: return ($count,%info);
1.366 albertel 2226: }
1.393 raeburn 2227: return $count;
1.366 albertel 2228: }
2229:
1.321 raeburn 2230: sub wrap_symb {
1.322 albertel 2231: my $self = shift;
1.321 raeburn 2232: my $symb = shift;
1.373 albertel 2233: if ($symb =~ m-___(adm/[^/]+/[^/]+/)(\d+)(/bulletinboard)$-) {
1.322 albertel 2234: unless ($symb =~ m|adm/wrapper/adm|) {
2235: $symb = 'bulletin___'.$2.'___adm/wrapper/'.$1.$2.$3;
1.321 raeburn 2236: }
2237: }
1.322 albertel 2238: return $symb;
1.321 raeburn 2239: }
2240:
1.372 raeburn 2241: sub unwrap_symb {
2242: my $self = shift;
2243: my $ressymb = shift;
2244: my $discsymb = $ressymb;
1.373 albertel 2245: if ($ressymb =~ m-^(bulletin___\d+___)adm/wrapper/(adm/[^/]+/[^/]+/\d+/bulletinboard)$-) {
1.372 raeburn 2246: $discsymb = $1.$2;
2247: }
2248: return $discsymb;
2249: }
2250:
1.322 albertel 2251: # Private method: Does the given resource (as a symb string) have
2252: # current feedback? Returns the string in the feedback hash, which
2253: # will be false if it does not exist.
2254:
1.133 bowersj2 2255: sub getFeedback {
2256: my $self = shift;
2257: my $symb = shift;
1.395 raeburn 2258: my $source = shift;
1.133 bowersj2 2259:
1.221 bowersj2 2260: $self->generate_email_discuss_status();
2261:
1.133 bowersj2 2262: if (!defined($self->{FEEDBACK})) { return ""; }
2263:
1.395 raeburn 2264: my $feedback;
2265: if ($self->{FEEDBACK}->{$symb}) {
2266: $feedback = $self->{FEEDBACK}->{$symb};
2267: if ($self->{FEEDBACK}->{$source}) {
2268: $feedback .= ','.$self->{FEEDBACK}->{$source};
2269: }
2270: } else {
2271: if ($self->{FEEDBACK}->{$source}) {
2272: $feedback = $self->{FEEDBACK}->{$source};
2273: }
2274: }
2275: return $feedback;
1.133 bowersj2 2276: }
2277:
2278: # Private method: Get the errors for that resource (by source).
2279: sub getErrors {
2280: my $self = shift;
1.395 raeburn 2281: my $symb = shift;
1.133 bowersj2 2282: my $src = shift;
1.221 bowersj2 2283:
2284: $self->generate_email_discuss_status();
2285:
1.133 bowersj2 2286: if (!defined($self->{ERROR_MSG})) { return ""; }
1.395 raeburn 2287:
2288: my $errors;
2289: if ($self->{ERROR_MSG}->{$symb}) {
2290: $errors = $self->{ERROR_MSG}->{$symb};
2291: if ($self->{ERROR_MSG}->{$src}) {
2292: $errors .= ','.$self->{ERROR_MSG}->{$src};
2293: }
2294: } else {
2295: if ($self->{ERROR_MSG}->{$src}) {
2296: $errors = $self->{ERROR_MSG}->{$src};
2297: }
2298: }
2299: return $errors;
1.133 bowersj2 2300: }
2301:
2302: =pod
2303:
1.174 albertel 2304: =item * B<getById>(id):
2305:
2306: Based on the ID of the resource (1.1, 3.2, etc.), get a resource
2307: object for that resource. This method, or other methods that use it
2308: (as in the resource object) is the only proper way to obtain a
2309: resource object.
1.133 bowersj2 2310:
1.194 bowersj2 2311: =item * B<getBySymb>(symb):
2312:
2313: Based on the symb of the resource, get a resource object for that
2314: resource. This is one of the proper ways to get a resource object.
2315:
2316: =item * B<getMapByMapPc>(map_pc):
2317:
2318: Based on the map_pc of the resource, get a resource object for
2319: the given map. This is one of the proper ways to get a resource object.
2320:
1.133 bowersj2 2321: =cut
2322:
2323: # The strategy here is to cache the resource objects, and only construct them
2324: # as we use them. The real point is to prevent reading any more from the tied
1.398 banghart 2325: # hash than we have to, which should hopefully alleviate speed problems.
1.133 bowersj2 2326:
2327: sub getById {
2328: my $self = shift;
2329: my $id = shift;
2330:
2331: if (defined ($self->{RESOURCE_CACHE}->{$id}))
2332: {
2333: return $self->{RESOURCE_CACHE}->{$id};
2334: }
2335:
2336: # resource handles inserting itself into cache.
2337: # Not clear why the quotes are necessary, but as of this
2338: # writing it doesn't work without them.
2339: return "Apache::lonnavmaps::resource"->new($self, $id);
1.132 bowersj2 2340: }
1.133 bowersj2 2341:
1.172 bowersj2 2342: sub getBySymb {
2343: my $self = shift;
2344: my $symb = shift;
1.277 matthew 2345:
1.228 albertel 2346: my ($mapUrl, $id, $filename) = &Apache::lonnet::decode_symb($symb);
1.172 bowersj2 2347: my $map = $self->getResourceByUrl($mapUrl);
1.277 matthew 2348: my $returnvalue = undef;
2349: if (ref($map)) {
2350: $returnvalue = $self->getById($map->map_pc() .'.'.$id);
2351: }
2352: return $returnvalue;
1.194 bowersj2 2353: }
2354:
2355: sub getByMapPc {
2356: my $self = shift;
2357: my $map_pc = shift;
2358: my $map_id = $self->{NAV_HASH}->{'map_id_' . $map_pc};
2359: $map_id = $self->{NAV_HASH}->{'ids_' . $map_id};
2360: return $self->getById($map_id);
1.172 bowersj2 2361: }
2362:
1.133 bowersj2 2363: =pod
2364:
1.174 albertel 2365: =item * B<firstResource>():
2366:
2367: Returns a resource object reference corresponding to the first
2368: resource in the navmap.
1.133 bowersj2 2369:
2370: =cut
2371:
2372: sub firstResource {
2373: my $self = shift;
2374: my $firstResource = $self->navhash('map_start_' .
1.320 albertel 2375: &Apache::lonnet::clutter($env{'request.course.uri'}));
1.133 bowersj2 2376: return $self->getById($firstResource);
1.132 bowersj2 2377: }
1.133 bowersj2 2378:
2379: =pod
2380:
1.174 albertel 2381: =item * B<finishResource>():
2382:
2383: Returns a resource object reference corresponding to the last resource
2384: in the navmap.
1.133 bowersj2 2385:
2386: =cut
2387:
2388: sub finishResource {
2389: my $self = shift;
2390: my $firstResource = $self->navhash('map_finish_' .
1.320 albertel 2391: &Apache::lonnet::clutter($env{'request.course.uri'}));
1.133 bowersj2 2392: return $self->getById($firstResource);
1.132 bowersj2 2393: }
1.133 bowersj2 2394:
2395: # Parmval reads the parm hash and cascades the lookups. parmval_real does
2396: # the actual lookup; parmval caches the results.
2397: sub parmval {
2398: my $self = shift;
1.399 albertel 2399: my ($what,$symb,$recurse)=@_;
1.133 bowersj2 2400: my $hashkey = $what."|||".$symb;
2401:
2402: if (defined($self->{PARM_CACHE}->{$hashkey})) {
1.411 raeburn 2403: if (ref($self->{PARM_CACHE}->{$hashkey}) eq 'ARRAY') {
2404: if (defined($self->{PARM_CACHE}->{$hashkey}->[0])) {
2405: if (wantarray) {
2406: return @{$self->{PARM_CACHE}->{$hashkey}};
2407: } else {
2408: return $self->{PARM_CACHE}->{$hashkey}->[0];
2409: }
2410: }
2411: } else {
2412: return $self->{PARM_CACHE}->{$hashkey};
2413: }
1.133 bowersj2 2414: }
1.399 albertel 2415: my $result = $self->parmval_real($what, $symb, $recurse);
1.133 bowersj2 2416: $self->{PARM_CACHE}->{$hashkey} = $result;
1.405 albertel 2417: if (wantarray) {
1.411 raeburn 2418: return @{$result};
1.405 albertel 2419: }
2420: return $result->[0];
1.132 bowersj2 2421: }
2422:
1.133 bowersj2 2423: sub parmval_real {
2424: my $self = shift;
1.219 albertel 2425: my ($what,$symb,$recurse) = @_;
1.133 bowersj2 2426:
1.221 bowersj2 2427: # Make sure the {USER_OPT} and {COURSE_OPT} hashes are populated
2428: $self->generate_course_user_opt();
2429:
1.320 albertel 2430: my $cid=$env{'request.course.id'};
2431: my $csec=$env{'request.course.sec'};
1.350 raeburn 2432: my $cgroup='';
2433: my @cgrps=split(/:/,$env{'request.course.groups'});
2434: if (@cgrps > 0) {
2435: @cgrps = sort(@cgrps);
2436: $cgroup = $cgrps[0];
2437: }
1.320 albertel 2438: my $uname=$env{'user.name'};
2439: my $udom=$env{'user.domain'};
1.133 bowersj2 2440:
1.405 albertel 2441: unless ($symb) { return ['']; }
1.133 bowersj2 2442: my $result='';
2443:
1.226 www 2444: my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
1.383 albertel 2445: $mapname = &Apache::lonnet::deversion($mapname);
1.133 bowersj2 2446: # ----------------------------------------------------- Cascading lookup scheme
2447: my $rwhat=$what;
2448: $what=~s/^parameter\_//;
2449: $what=~s/\_/\./;
2450:
2451: my $symbparm=$symb.'.'.$what;
2452: my $mapparm=$mapname.'___(all).'.$what;
1.325 albertel 2453: my $usercourseprefix=$cid;
1.133 bowersj2 2454:
1.350 raeburn 2455: my $grplevel=$usercourseprefix.'.['.$cgroup.'].'.$what;
2456: my $grplevelr=$usercourseprefix.'.['.$cgroup.'].'.$symbparm;
2457: my $grplevelm=$usercourseprefix.'.['.$cgroup.'].'.$mapparm;
2458:
1.133 bowersj2 2459: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
2460: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
2461: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
2462:
2463: my $courselevel= $usercourseprefix.'.'.$what;
2464: my $courselevelr=$usercourseprefix.'.'.$symbparm;
2465: my $courselevelm=$usercourseprefix.'.'.$mapparm;
2466:
2467: my $useropt = $self->{USER_OPT};
2468: my $courseopt = $self->{COURSE_OPT};
2469: my $parmhash = $self->{PARM_HASH};
2470:
2471: # ---------------------------------------------------------- first, check user
2472: if ($uname and defined($useropt)) {
1.405 albertel 2473: if (defined($$useropt{$courselevelr})) { return [$$useropt{$courselevelr},'resource']; }
2474: if (defined($$useropt{$courselevelm})) { return [$$useropt{$courselevelm},'map']; }
2475: if (defined($$useropt{$courselevel})) { return [$$useropt{$courselevel},'course']; }
1.133 bowersj2 2476: }
2477:
2478: # ------------------------------------------------------- second, check course
1.350 raeburn 2479: if ($cgroup ne '' and defined($courseopt)) {
1.405 albertel 2480: if (defined($$courseopt{$grplevelr})) { return [$$courseopt{$grplevelr},'resource']; }
2481: if (defined($$courseopt{$grplevelm})) { return [$$courseopt{$grplevelm},'map']; }
2482: if (defined($$courseopt{$grplevel})) { return [$$courseopt{$grplevel},'course']; }
1.350 raeburn 2483: }
2484:
1.133 bowersj2 2485: if ($csec and defined($courseopt)) {
1.405 albertel 2486: if (defined($$courseopt{$seclevelr})) { return [$$courseopt{$seclevelr},'resource']; }
2487: if (defined($$courseopt{$seclevelm})) { return [$$courseopt{$seclevelm},'map']; }
2488: if (defined($$courseopt{$seclevel})) { return [$$courseopt{$seclevel},'course']; }
1.133 bowersj2 2489: }
2490:
2491: if (defined($courseopt)) {
1.405 albertel 2492: if (defined($$courseopt{$courselevelr})) { return [$$courseopt{$courselevelr},'resource']; }
1.133 bowersj2 2493: }
2494:
2495: # ----------------------------------------------------- third, check map parms
2496:
2497: my $thisparm=$$parmhash{$symbparm};
1.405 albertel 2498: if (defined($thisparm)) { return [$thisparm,'map']; }
1.133 bowersj2 2499:
2500: # ----------------------------------------------------- fourth , check default
2501:
1.246 albertel 2502: my $meta_rwhat=$rwhat;
2503: $meta_rwhat=~s/\./_/g;
2504: my $default=&Apache::lonnet::metadata($fn,$meta_rwhat);
1.405 albertel 2505: if (defined($default)) { return [$default,'resource']}
1.246 albertel 2506: $default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat);
1.405 albertel 2507: if (defined($default)) { return [$default,'resource']}
1.315 albertel 2508: # --------------------------------------------------- fifth, check more course
2509: if (defined($courseopt)) {
1.405 albertel 2510: if (defined($$courseopt{$courselevelm})) { return [$$courseopt{$courselevelm},'map']; }
2511: if (defined($$courseopt{$courselevel})) {
2512: my $ret = [$$courseopt{$courselevel},'course'];
2513: return $ret;
2514: }
1.315 albertel 2515: }
2516: # --------------------------------------------------- sixth , cascade up parts
1.133 bowersj2 2517:
2518: my ($space,@qualifier)=split(/\./,$rwhat);
2519: my $qualifier=join('.',@qualifier);
2520: unless ($space eq '0') {
1.160 albertel 2521: my @parts=split(/_/,$space);
2522: my $id=pop(@parts);
2523: my $part=join('_',@parts);
2524: if ($part eq '') { $part='0'; }
1.405 albertel 2525: my @partgeneral=$self->parmval($part.".$qualifier",$symb,1);
2526: if (defined($partgeneral[0])) { return \@partgeneral; }
1.133 bowersj2 2527: }
1.405 albertel 2528: if ($recurse) { return []; }
1.399 albertel 2529: my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$rwhat);
1.405 albertel 2530: if (defined($pack_def)) { return [$pack_def,'resource']; }
2531: return [''];
1.145 bowersj2 2532: }
2533:
1.174 albertel 2534: =pod
1.145 bowersj2 2535:
1.352 raeburn 2536: =item * B<getResourceByUrl>(url,multiple):
1.145 bowersj2 2537:
1.352 raeburn 2538: Retrieves a resource object by URL of the resource, unless the optional
1.398 banghart 2539: multiple parameter is included in which case an array of resource
1.352 raeburn 2540: objects is returned. If passed a resource object, it will simply return
2541: it, so it is safe to use this method in code like
2542: "$res = $navmap->getResourceByUrl($res)"
2543: if you're not sure if $res is already an object, or just a URL. If the
2544: resource appears multiple times in the course, only the first instance
2545: will be returned (useful for maps), unless the multiple parameter has
2546: been included, in which case all instances are returned in an array.
1.174 albertel 2547:
1.314 albertel 2548: =item * B<retrieveResources>(map, filterFunc, recursive, bailout, showall):
1.174 albertel 2549:
2550: The map is a specification of a map to retreive the resources from,
2551: either as a url or as an object. The filterFunc is a reference to a
2552: function that takes a resource object as its one argument and returns
2553: true if the resource should be included, or false if it should not
2554: be. If recursive is true, the map will be recursively examined,
2555: otherwise it will not be. If bailout is true, the function will return
1.314 albertel 2556: as soon as it finds a resource, if false it will finish. If showall is
2557: true it will not hide maps that contain nothing but one other map. By
2558: default, the map is the top-level map of the course, filterFunc is a
2559: function that always returns 1, recursive is true, bailout is false,
2560: showall is false. The resources will be returned in a list containing
2561: the resource objects for the corresponding resources, with B<no
2562: structure information> in the list; regardless of branching,
2563: recursion, etc., it will be a flat list.
1.174 albertel 2564:
2565: Thus, this is suitable for cases where you don't want the structure,
2566: just a list of all resources. It is also suitable for finding out how
2567: many resources match a given description; for this use, if all you
2568: want to know is if I<any> resources match the description, the bailout
2569: parameter will allow you to avoid potentially expensive enumeration of
2570: all matching resources.
1.145 bowersj2 2571:
1.318 albertel 2572: =item * B<hasResource>(map, filterFunc, recursive, showall):
1.145 bowersj2 2573:
1.398 banghart 2574: Convenience method for
1.146 bowersj2 2575:
1.318 albertel 2576: scalar(retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0
1.146 bowersj2 2577:
1.174 albertel 2578: which will tell whether the map has resources matching the description
2579: in the filter function.
1.146 bowersj2 2580:
1.352 raeburn 2581: =item * B<usedVersion>(url):
2582:
2583: Retrieves version infomation for a url. Returns the version (a number, or
2584: the string "mostrecent") for resources which have version information in
2585: the big hash.
2586:
1.145 bowersj2 2587: =cut
2588:
1.277 matthew 2589:
1.145 bowersj2 2590: sub getResourceByUrl {
2591: my $self = shift;
2592: my $resUrl = shift;
1.352 raeburn 2593: my $multiple = shift;
1.145 bowersj2 2594:
2595: if (ref($resUrl)) { return $resUrl; }
2596:
2597: $resUrl = &Apache::lonnet::clutter($resUrl);
2598: my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl};
1.352 raeburn 2599: if (!$resId) { return ''; }
2600: if ($multiple) {
2601: my @resources = ();
2602: my @resIds = split (/,/, $resId);
2603: foreach my $id (@resIds) {
1.353 raeburn 2604: my $resourceId = $self->getById($id);
2605: if ($resourceId) {
2606: push(@resources,$resourceId);
1.352 raeburn 2607: }
2608: }
2609: return @resources;
2610: } else {
2611: if ($resId =~ /,/) {
2612: $resId = (split (/,/, $resId))[0];
2613: }
2614: return $self->getById($resId);
1.145 bowersj2 2615: }
2616: }
2617:
2618: sub retrieveResources {
2619: my $self = shift;
2620: my $map = shift;
2621: my $filterFunc = shift;
2622: if (!defined ($filterFunc)) {
2623: $filterFunc = sub {return 1;};
2624: }
2625: my $recursive = shift;
2626: if (!defined($recursive)) { $recursive = 1; }
2627: my $bailout = shift;
2628: if (!defined($bailout)) { $bailout = 0; }
1.314 albertel 2629: my $showall = shift;
1.145 bowersj2 2630: # Create the necessary iterator.
2631: if (!ref($map)) { # assume it's a url of a map.
1.172 bowersj2 2632: $map = $self->getResourceByUrl($map);
1.145 bowersj2 2633: }
2634:
1.213 bowersj2 2635: # If nothing was passed, assume top-level map
2636: if (!$map) {
2637: $map = $self->getById('0.0');
2638: }
2639:
1.145 bowersj2 2640: # Check the map's validity.
1.213 bowersj2 2641: if (!$map->is_map()) {
1.145 bowersj2 2642: # Oh, to throw an exception.... how I'd love that!
2643: return ();
2644: }
2645:
1.146 bowersj2 2646: # Get an iterator.
2647: my $it = $self->getIterator($map->map_start(), $map->map_finish(),
1.314 albertel 2648: undef, $recursive, $showall);
1.146 bowersj2 2649:
2650: my @resources = ();
2651:
1.400 albertel 2652: if (&$filterFunc($map)) {
2653: push(@resources, $map);
2654: }
2655:
1.146 bowersj2 2656: # Run down the iterator and collect the resources.
1.222 bowersj2 2657: my $curRes;
2658:
2659: while ($curRes = $it->next()) {
1.146 bowersj2 2660: if (ref($curRes)) {
2661: if (!&$filterFunc($curRes)) {
2662: next;
2663: }
2664:
1.400 albertel 2665: push(@resources, $curRes);
1.146 bowersj2 2666:
2667: if ($bailout) {
2668: return @resources;
2669: }
2670: }
2671:
2672: }
2673:
2674: return @resources;
2675: }
2676:
2677: sub hasResource {
2678: my $self = shift;
2679: my $map = shift;
2680: my $filterFunc = shift;
2681: my $recursive = shift;
1.318 albertel 2682: my $showall = shift;
1.146 bowersj2 2683:
1.318 albertel 2684: return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0;
1.133 bowersj2 2685: }
1.51 bowersj2 2686:
1.352 raeburn 2687: sub usedVersion {
2688: my $self = shift;
2689: my $linkurl = shift;
2690: return $self->navhash("version_$linkurl");
2691: }
2692:
1.51 bowersj2 2693: 1;
2694:
2695: package Apache::lonnavmaps::iterator;
1.365 albertel 2696: use Scalar::Util qw(weaken);
1.320 albertel 2697: use Apache::lonnet;
2698:
1.51 bowersj2 2699: =pod
2700:
2701: =back
2702:
1.174 albertel 2703: =head1 Object: navmap Iterator
1.51 bowersj2 2704:
1.174 albertel 2705: An I<iterator> encapsulates the logic required to traverse a data
2706: structure. navmap uses an iterator to traverse the course map
2707: according to the criteria you wish to use.
2708:
2709: To obtain an iterator, call the B<getIterator>() function of a
2710: B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator
2711: directly.) This will return a reference to the iterator:
1.51 bowersj2 2712:
2713: C<my $resourceIterator = $navmap-E<gt>getIterator();>
2714:
2715: To get the next thing from the iterator, call B<next>:
2716:
2717: C<my $nextThing = $resourceIterator-E<gt>next()>
2718:
2719: getIterator behaves as follows:
2720:
2721: =over 4
2722:
1.174 albertel 2723: =item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap):
2724:
2725: All parameters are optional. firstResource is a resource reference
2726: corresponding to where the iterator should start. It defaults to
2727: navmap->firstResource() for the corresponding nav map. finishResource
2728: corresponds to where you want the iterator to end, defaulting to
2729: navmap->finishResource(). filterHash is a hash used as a set
2730: containing strings representing the resource IDs, defaulting to
2731: empty. Condition is a 1 or 0 that sets what to do with the filter
1.205 bowersj2 2732: hash: If a 0, then only resources that exist IN the filterHash will be
1.174 albertel 2733: recursed on. If it is a 1, only resources NOT in the filterHash will
2734: be recursed on. Defaults to 0. forceTop is a boolean value. If it is
2735: false (default), the iterator will only return the first level of map
2736: that is not just a single, 'redirecting' map. If true, the iterator
2737: will return all information, starting with the top-level map,
2738: regardless of content. returnTopMap, if true (default false), will
2739: cause the iterator to return the top-level map object (resource 0.0)
2740: before anything else.
2741:
2742: Thus, by default, only top-level resources will be shown. Change the
2743: condition to a 1 without changing the hash, and all resources will be
2744: shown. Changing the condition to 1 and including some values in the
2745: hash will allow you to selectively suppress parts of the navmap, while
2746: leaving it on 0 and adding things to the hash will allow you to
2747: selectively add parts of the nav map. See the handler code for
2748: examples.
2749:
2750: The iterator will return either a reference to a resource object, or a
2751: token representing something in the map, such as the beginning of a
2752: new branch. The possible tokens are:
2753:
2754: =over 4
1.51 bowersj2 2755:
1.222 bowersj2 2756: =item * B<END_ITERATOR>:
2757:
2758: The iterator has returned all that it's going to. Further calls to the
2759: iterator will just produce more of these. This is a "false" value, and
2760: is the only false value the iterator which will be returned, so it can
2761: be used as a loop sentinel.
2762:
1.217 bowersj2 2763: =item * B<BEGIN_MAP>:
1.51 bowersj2 2764:
1.174 albertel 2765: A new map is being recursed into. This is returned I<after> the map
2766: resource itself is returned.
1.51 bowersj2 2767:
1.217 bowersj2 2768: =item * B<END_MAP>:
1.174 albertel 2769:
2770: The map is now done.
1.51 bowersj2 2771:
1.217 bowersj2 2772: =item * B<BEGIN_BRANCH>:
1.70 bowersj2 2773:
1.174 albertel 2774: A branch is now starting. The next resource returned will be the first
2775: in that branch.
1.70 bowersj2 2776:
1.217 bowersj2 2777: =item * B<END_BRANCH>:
1.70 bowersj2 2778:
1.174 albertel 2779: The branch is now done.
1.51 bowersj2 2780:
2781: =back
2782:
1.174 albertel 2783: The tokens are retreivable via methods on the iterator object, i.e.,
2784: $iterator->END_MAP.
1.70 bowersj2 2785:
1.174 albertel 2786: Maps can contain empty resources. The iterator will automatically skip
2787: over such resources, but will still treat the structure
2788: correctly. Thus, a complicated map with several branches, but
2789: consisting entirely of empty resources except for one beginning or
2790: ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs,
2791: but only one resource will be returned.
1.116 bowersj2 2792:
1.242 matthew 2793: =back
2794:
1.222 bowersj2 2795: =head2 Normal Usage
2796:
2797: Normal usage of the iterator object is to do the following:
2798:
2799: my $it = $navmap->getIterator([your params here]);
2800: my $curRes;
2801: while ($curRes = $it->next()) {
2802: [your logic here]
2803: }
2804:
2805: Note that inside of the loop, it's frequently useful to check if
2806: "$curRes" is a reference or not with the reference function; only
2807: resource objects will be references, and any non-references will
2808: be the tokens described above.
2809:
2810: Also note there is some old code floating around that trys to track
2811: the depth of the iterator to see when it's done; do not copy that
1.398 banghart 2812: code. It is difficult to get right and harder to understand than
1.222 bowersj2 2813: this. They should be migrated to this new style.
1.51 bowersj2 2814:
2815: =cut
2816:
2817: # Here are the tokens for the iterator:
2818:
1.222 bowersj2 2819: sub END_ITERATOR { return 0; }
1.51 bowersj2 2820: sub BEGIN_MAP { return 1; } # begining of a new map
2821: sub END_MAP { return 2; } # end of the map
2822: sub BEGIN_BRANCH { return 3; } # beginning of a branch
2823: sub END_BRANCH { return 4; } # end of a branch
1.89 bowersj2 2824: sub FORWARD { return 1; } # go forward
2825: sub BACKWARD { return 2; }
1.51 bowersj2 2826:
1.96 bowersj2 2827: sub min {
2828: (my $a, my $b) = @_;
2829: if ($a < $b) { return $a; } else { return $b; }
2830: }
2831:
1.94 bowersj2 2832: sub new {
2833: # magic invocation to create a class instance
2834: my $proto = shift;
2835: my $class = ref($proto) || $proto;
2836: my $self = {};
2837:
1.300 albertel 2838: weaken($self->{NAV_MAP} = shift);
1.94 bowersj2 2839: return undef unless ($self->{NAV_MAP});
2840:
2841: # Handle the parameters
2842: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
2843: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
2844:
2845: # If the given resources are just the ID of the resource, get the
2846: # objects
2847: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
2848: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
2849: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
2850: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
2851:
2852: $self->{FILTER} = shift;
2853:
2854: # A hash, used as a set, of resource already seen
2855: $self->{ALREADY_SEEN} = shift;
2856: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
2857: $self->{CONDITION} = shift;
2858:
1.116 bowersj2 2859: # Do we want to automatically follow "redirection" maps?
2860: $self->{FORCE_TOP} = shift;
2861:
1.162 bowersj2 2862: # Do we want to return the top-level map object (resource 0.0)?
2863: $self->{RETURN_0} = shift;
2864: # have we done that yet?
2865: $self->{HAVE_RETURNED_0} = 0;
2866:
1.94 bowersj2 2867: # Now, we need to pre-process the map, by walking forward and backward
2868: # over the parts of the map we're going to look at.
1.96 bowersj2 2869:
1.97 bowersj2 2870: # The processing steps are exactly the same, except for a few small
2871: # changes, so I bundle those up in the following list of two elements:
2872: # (direction_to_iterate, VAL_name, next_resource_method_to_call,
2873: # first_resource).
2874: # This prevents writing nearly-identical code twice.
2875: my @iterations = ( [FORWARD(), 'TOP_DOWN_VAL', 'getNext',
2876: 'FIRST_RESOURCE'],
2877: [BACKWARD(), 'BOT_UP_VAL', 'getPrevious',
2878: 'FINISH_RESOURCE'] );
2879:
1.98 bowersj2 2880: my $maxDepth = 0; # tracks max depth
2881:
1.116 bowersj2 2882: # If there is only one resource in this map, and it's a map, we
2883: # want to remember that, so the user can ask for the first map
2884: # that isn't just a redirector.
2885: my $resource; my $resourceCount = 0;
2886:
1.209 bowersj2 2887: # Documentation on this algorithm can be found in the CVS repository at
2888: # /docs/lonnavdocs; these "**#**" markers correspond to documentation
2889: # in that file.
1.107 bowersj2 2890: # **1**
2891:
1.97 bowersj2 2892: foreach my $pass (@iterations) {
2893: my $direction = $pass->[0];
2894: my $valName = $pass->[1];
2895: my $nextResourceMethod = $pass->[2];
2896: my $firstResourceName = $pass->[3];
2897:
2898: my $iterator = Apache::lonnavmaps::DFSiterator->new($self->{NAV_MAP},
2899: $self->{FIRST_RESOURCE},
2900: $self->{FINISH_RESOURCE},
2901: {}, undef, 0, $direction);
1.96 bowersj2 2902:
1.97 bowersj2 2903: # prime the recursion
2904: $self->{$firstResourceName}->{DATA}->{$valName} = 0;
1.222 bowersj2 2905: $iterator->next();
1.97 bowersj2 2906: my $curRes = $iterator->next();
1.222 bowersj2 2907: my $depth = 1;
2908: while ($depth > 0) {
2909: if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
2910: if ($curRes == $iterator->END_MAP()) { $depth--; }
2911:
1.97 bowersj2 2912: if (ref($curRes)) {
1.116 bowersj2 2913: # If there's only one resource, this will save it
1.117 bowersj2 2914: # we have to filter empty resources from consideration here,
2915: # or even "empty", redirecting maps have two (start & finish)
2916: # or three (start, finish, plus redirector)
2917: if($direction == FORWARD && $curRes->src()) {
2918: $resource = $curRes; $resourceCount++;
2919: }
1.97 bowersj2 2920: my $resultingVal = $curRes->{DATA}->{$valName};
2921: my $nextResources = $curRes->$nextResourceMethod();
1.116 bowersj2 2922: my $nextCount = scalar(@{$nextResources});
1.104 bowersj2 2923:
1.116 bowersj2 2924: if ($nextCount == 1) { # **3**
1.97 bowersj2 2925: my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;
2926: $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
2927: }
2928:
1.116 bowersj2 2929: if ($nextCount > 1) { # **4**
1.97 bowersj2 2930: foreach my $res (@{$nextResources}) {
2931: my $current = $res->{DATA}->{$valName} || 999999999;
2932: $res->{DATA}->{$valName} = min($current, $resultingVal + 1);
2933: }
2934: }
2935: }
1.96 bowersj2 2936:
1.107 bowersj2 2937: # Assign the final val (**2**)
1.97 bowersj2 2938: if (ref($curRes) && $direction == BACKWARD()) {
1.98 bowersj2 2939: my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},
2940: $curRes->{DATA}->{BOT_UP_VAL});
2941:
2942: $curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;
2943: if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}
1.190 bowersj2 2944: }
1.222 bowersj2 2945:
2946: $curRes = $iterator->next();
1.96 bowersj2 2947: }
2948: }
1.94 bowersj2 2949:
1.116 bowersj2 2950: # Check: Was this only one resource, a map?
1.255 albertel 2951: if ($resourceCount == 1 && $resource->is_sequence() && !$self->{FORCE_TOP}) {
1.116 bowersj2 2952: my $firstResource = $resource->map_start();
2953: my $finishResource = $resource->map_finish();
2954: return
2955: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
2956: $finishResource, $self->{FILTER},
2957: $self->{ALREADY_SEEN},
1.314 albertel 2958: $self->{CONDITION},
2959: $self->{FORCE_TOP});
1.116 bowersj2 2960:
2961: }
2962:
1.98 bowersj2 2963: # Set up some bookkeeping information.
2964: $self->{CURRENT_DEPTH} = 0;
2965: $self->{MAX_DEPTH} = $maxDepth;
2966: $self->{STACK} = [];
2967: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1.222 bowersj2 2968: $self->{FINISHED} = 0; # When true, the iterator has finished
1.98 bowersj2 2969:
2970: for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) {
2971: push @{$self->{STACK}}, [];
2972: }
2973:
1.107 bowersj2 2974: # Prime the recursion w/ the first resource **5**
1.98 bowersj2 2975: push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};
2976: $self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;
2977:
2978: bless ($self);
2979:
2980: return $self;
2981: }
2982:
2983: sub next {
2984: my $self = shift;
1.256 albertel 2985: my $closeAllPages=shift;
1.222 bowersj2 2986: if ($self->{FINISHED}) {
2987: return END_ITERATOR();
2988: }
2989:
1.162 bowersj2 2990: # If we want to return the top-level map object, and haven't yet,
2991: # do so.
2992: if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {
2993: $self->{HAVE_RETURNED_0} = 1;
2994: return $self->{NAV_MAP}->getById('0.0');
2995: }
1.401 albertel 2996: if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0_BEGIN_MAP}) {
2997: $self->{HAVE_RETURNED_0_BEGIN_MAP} = 1;
2998: return $self->BEGIN_MAP();
2999: }
1.98 bowersj2 3000:
3001: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3002: # grab the next from the recursive iterator
1.256 albertel 3003: my $next = $self->{RECURSIVE_ITERATOR}->next($closeAllPages);
1.98 bowersj2 3004:
3005: # is it a begin or end map? If so, update the depth
3006: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
3007: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
3008:
3009: # Are we back at depth 0? If so, stop recursing
3010: if ($self->{RECURSIVE_DEPTH} == 0) {
3011: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3012: }
3013:
3014: return $next;
3015: }
3016:
3017: if (defined($self->{FORCE_NEXT})) {
3018: my $tmp = $self->{FORCE_NEXT};
3019: $self->{FORCE_NEXT} = undef;
3020: return $tmp;
3021: }
3022:
3023: # Have we not yet begun? If not, return BEGIN_MAP and
3024: # remember we've started.
3025: if ( !$self->{STARTED} ) {
3026: $self->{STARTED} = 1;
3027: return $self->BEGIN_MAP();
3028: }
3029:
3030: # Here's the guts of the iterator.
3031:
3032: # Find the next resource, if any.
3033: my $found = 0;
3034: my $i = $self->{MAX_DEPTH};
3035: my $newDepth;
3036: my $here;
3037: while ( $i >= 0 && !$found ) {
1.107 bowersj2 3038: if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6**
3039: $here = pop @{$self->{STACK}->[$i]}; # **7**
1.98 bowersj2 3040: $found = 1;
3041: $newDepth = $i;
3042: }
3043: $i--;
3044: }
3045:
3046: # If we still didn't find anything, we're done.
3047: if ( !$found ) {
3048: # We need to get back down to the correct branch depth
3049: if ( $self->{CURRENT_DEPTH} > 0 ) {
3050: $self->{CURRENT_DEPTH}--;
3051: return END_BRANCH();
3052: } else {
1.222 bowersj2 3053: $self->{FINISHED} = 1;
1.98 bowersj2 3054: return END_MAP();
3055: }
3056: }
3057:
1.104 bowersj2 3058: # If this is not a resource, it must be an END_BRANCH marker we want
3059: # to return directly.
1.107 bowersj2 3060: if (!ref($here)) { # **8**
1.104 bowersj2 3061: if ($here == END_BRANCH()) { # paranoia, in case of later extension
3062: $self->{CURRENT_DEPTH}--;
3063: return $here;
3064: }
3065: }
3066:
3067: # Otherwise, it is a resource and it's safe to store in $self->{HERE}
3068: $self->{HERE} = $here;
3069:
1.98 bowersj2 3070: # Get to the right level
3071: if ( $self->{CURRENT_DEPTH} > $newDepth ) {
3072: push @{$self->{STACK}->[$newDepth]}, $here;
3073: $self->{CURRENT_DEPTH}--;
3074: return END_BRANCH();
3075: }
3076: if ( $self->{CURRENT_DEPTH} < $newDepth) {
3077: push @{$self->{STACK}->[$newDepth]}, $here;
3078: $self->{CURRENT_DEPTH}++;
3079: return BEGIN_BRANCH();
3080: }
3081:
3082: # If we made it here, we have the next resource, and we're at the
3083: # right branch level. So let's examine the resource for where
3084: # we can get to from here.
3085:
3086: # So we need to look at all the resources we can get to from here,
3087: # categorize them if we haven't seen them, remember if we have a new
3088: my $nextUnfiltered = $here->getNext();
1.104 bowersj2 3089: my $maxDepthAdded = -1;
3090:
1.98 bowersj2 3091: for (@$nextUnfiltered) {
3092: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
1.104 bowersj2 3093: my $depth = $_->{DATA}->{DISPLAY_DEPTH};
3094: push @{$self->{STACK}->[$depth]}, $_;
1.98 bowersj2 3095: $self->{ALREADY_SEEN}->{$_->{ID}} = 1;
1.104 bowersj2 3096: if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; }
1.98 bowersj2 3097: }
3098: }
1.104 bowersj2 3099:
3100: # Is this the end of a branch? If so, all of the resources examined above
1.398 banghart 3101: # led to lower levels than the one we are currently at, so we push a END_BRANCH
1.104 bowersj2 3102: # marker onto the stack so we don't forget.
3103: # Example: For the usual A(BC)(DE)F case, when the iterator goes down the
3104: # BC branch and gets to C, it will see F as the only next resource, but it's
3105: # one level lower. Thus, this is the end of the branch, since there are no
3106: # more resources added to this level or above.
1.111 bowersj2 3107: # We don't do this if the examined resource is the finish resource,
3108: # because the condition given above is true, but the "END_MAP" will
3109: # take care of things and we should already be at depth 0.
1.104 bowersj2 3110: my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH};
1.111 bowersj2 3111: if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9**
1.104 bowersj2 3112: push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH();
3113: }
3114:
1.98 bowersj2 3115: # That ends the main iterator logic. Now, do we want to recurse
3116: # down this map (if this resource is a map)?
1.256 albertel 3117: if ( ($self->{HERE}->is_sequence() || (!$closeAllPages && $self->{HERE}->is_page())) &&
1.98 bowersj2 3118: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
3119: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3120: my $firstResource = $self->{HERE}->map_start();
3121: my $finishResource = $self->{HERE}->map_finish();
3122:
3123: $self->{RECURSIVE_ITERATOR} =
3124: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
3125: $finishResource, $self->{FILTER},
1.314 albertel 3126: $self->{ALREADY_SEEN},
3127: $self->{CONDITION},
3128: $self->{FORCE_TOP});
1.98 bowersj2 3129: }
3130:
1.116 bowersj2 3131: # If this is a blank resource, don't actually return it.
1.117 bowersj2 3132: # Should you ever find you need it, make sure to add an option to the code
3133: # that you can use; other things depend on this behavior.
1.138 bowersj2 3134: my $browsePriv = $self->{HERE}->browsePriv();
3135: if (!$self->{HERE}->src() ||
3136: (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
1.256 albertel 3137: return $self->next($closeAllPages);
1.116 bowersj2 3138: }
3139:
1.98 bowersj2 3140: return $self->{HERE};
3141:
3142: }
3143:
3144: =pod
3145:
1.174 albertel 3146: The other method available on the iterator is B<getStack>, which
3147: returns an array populated with the current 'stack' of maps, as
3148: references to the resource objects. Example: This is useful when
3149: making the navigation map, as we need to check whether we are under a
3150: page map to see if we need to link directly to the resource, or to the
3151: page. The first elements in the array will correspond to the top of
3152: the stack (most inclusive map).
1.98 bowersj2 3153:
3154: =cut
3155:
3156: sub getStack {
3157: my $self=shift;
3158:
3159: my @stack;
3160:
3161: $self->populateStack(\@stack);
3162:
3163: return \@stack;
3164: }
3165:
3166: # Private method: Calls the iterators recursively to populate the stack.
3167: sub populateStack {
3168: my $self=shift;
3169: my $stack = shift;
3170:
3171: push @$stack, $self->{HERE} if ($self->{HERE});
3172:
3173: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3174: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3175: }
1.94 bowersj2 3176: }
3177:
3178: 1;
3179:
3180: package Apache::lonnavmaps::DFSiterator;
1.365 albertel 3181: use Scalar::Util qw(weaken);
1.320 albertel 3182: use Apache::lonnet;
3183:
1.100 bowersj2 3184: # Not documented in the perldoc: This is a simple iterator that just walks
3185: # through the nav map and presents the resources in a depth-first search
3186: # fashion, ignorant of conditionals, randomized resources, etc. It presents
3187: # BEGIN_MAP and END_MAP, but does not understand branches at all. It is
3188: # useful for pre-processing of some kind, and is in fact used by the main
3189: # iterator that way, but that's about it.
3190: # One could imagine merging this into the init routine of the main iterator,
1.251 www 3191: # but this might as well be left separate, since it is possible some other
1.100 bowersj2 3192: # use might be found for it. - Jeremy
1.94 bowersj2 3193:
1.117 bowersj2 3194: # Unlike the main iterator, this DOES return all resources, even blank ones.
3195: # The main iterator needs them to correctly preprocess the map.
3196:
1.94 bowersj2 3197: sub BEGIN_MAP { return 1; } # begining of a new map
3198: sub END_MAP { return 2; } # end of the map
3199: sub FORWARD { return 1; } # go forward
3200: sub BACKWARD { return 2; }
3201:
1.100 bowersj2 3202: # Params: Nav map ref, first resource id/ref, finish resource id/ref,
3203: # filter hash ref (or undef), already seen hash or undef, condition
3204: # (as in main iterator), direction FORWARD or BACKWARD (undef->forward).
1.51 bowersj2 3205: sub new {
3206: # magic invocation to create a class instance
3207: my $proto = shift;
3208: my $class = ref($proto) || $proto;
3209: my $self = {};
3210:
1.300 albertel 3211: weaken($self->{NAV_MAP} = shift);
1.51 bowersj2 3212: return undef unless ($self->{NAV_MAP});
3213:
3214: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
3215: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
3216:
3217: # If the given resources are just the ID of the resource, get the
3218: # objects
3219: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
3220: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
3221: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
3222: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
3223:
3224: $self->{FILTER} = shift;
3225:
3226: # A hash, used as a set, of resource already seen
3227: $self->{ALREADY_SEEN} = shift;
1.140 bowersj2 3228: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1.63 bowersj2 3229: $self->{CONDITION} = shift;
1.89 bowersj2 3230: $self->{DIRECTION} = shift || FORWARD();
1.51 bowersj2 3231:
1.100 bowersj2 3232: # Flag: Have we started yet?
1.51 bowersj2 3233: $self->{STARTED} = 0;
3234:
3235: # Should we continue calling the recursive iterator, if any?
3236: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3237: # The recursive iterator, if any
3238: $self->{RECURSIVE_ITERATOR} = undef;
3239: # Are we recursing on a map, or a branch?
3240: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
3241: # And the count of how deep it is, so that this iterator can keep track of
3242: # when to pick back up again.
3243: $self->{RECURSIVE_DEPTH} = 0;
3244:
3245: # For keeping track of our branches, we maintain our own stack
1.100 bowersj2 3246: $self->{STACK} = [];
1.51 bowersj2 3247:
3248: # Start with the first resource
1.89 bowersj2 3249: if ($self->{DIRECTION} == FORWARD) {
1.100 bowersj2 3250: push @{$self->{STACK}}, $self->{FIRST_RESOURCE};
1.89 bowersj2 3251: } else {
1.100 bowersj2 3252: push @{$self->{STACK}}, $self->{FINISH_RESOURCE};
1.89 bowersj2 3253: }
1.51 bowersj2 3254:
3255: bless($self);
3256: return $self;
3257: }
3258:
3259: sub next {
3260: my $self = shift;
3261:
3262: # Are we using a recursive iterator? If so, pull from that and
3263: # watch the depth; we want to resume our level at the correct time.
1.98 bowersj2 3264: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1.51 bowersj2 3265: # grab the next from the recursive iterator
3266: my $next = $self->{RECURSIVE_ITERATOR}->next();
3267:
3268: # is it a begin or end map? Update depth if so
3269: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
3270: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
3271:
3272: # Are we back at depth 0? If so, stop recursing.
3273: if ($self->{RECURSIVE_DEPTH} == 0) {
3274: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3275: }
3276:
3277: return $next;
3278: }
3279:
3280: # Is there a current resource to grab? If not, then return
1.100 bowersj2 3281: # END_MAP, which will end the iterator.
3282: if (scalar(@{$self->{STACK}}) == 0) {
3283: return $self->END_MAP();
1.51 bowersj2 3284: }
3285:
3286: # Have we not yet begun? If not, return BEGIN_MAP and
3287: # remember that we've started.
3288: if ( !$self->{STARTED} ) {
3289: $self->{STARTED} = 1;
3290: return $self->BEGIN_MAP;
3291: }
3292:
3293: # Get the next resource in the branch
1.100 bowersj2 3294: $self->{HERE} = pop @{$self->{STACK}};
1.52 bowersj2 3295:
1.100 bowersj2 3296: # remember that we've seen this, so we don't return it again later
1.51 bowersj2 3297: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
3298:
3299: # Get the next possible resources
1.90 bowersj2 3300: my $nextUnfiltered;
1.89 bowersj2 3301: if ($self->{DIRECTION} == FORWARD()) {
1.90 bowersj2 3302: $nextUnfiltered = $self->{HERE}->getNext();
1.89 bowersj2 3303: } else {
1.90 bowersj2 3304: $nextUnfiltered = $self->{HERE}->getPrevious();
1.89 bowersj2 3305: }
1.51 bowersj2 3306: my $next = [];
3307:
3308: # filter the next possibilities to remove things we've
1.100 bowersj2 3309: # already seen.
1.394 raeburn 3310: foreach my $item (@$nextUnfiltered) {
3311: if (!defined($self->{ALREADY_SEEN}->{$item->{ID}})) {
3312: push @$next, $item;
1.52 bowersj2 3313: }
1.51 bowersj2 3314: }
3315:
3316: while (@$next) {
1.100 bowersj2 3317: # copy the next possibilities over to the stack
3318: push @{$self->{STACK}}, shift @$next;
1.51 bowersj2 3319: }
3320:
3321: # If this is a map and we want to recurse down it... (not filtered out)
1.70 bowersj2 3322: if ($self->{HERE}->is_map() &&
1.63 bowersj2 3323: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
1.51 bowersj2 3324: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3325: my $firstResource = $self->{HERE}->map_start();
3326: my $finishResource = $self->{HERE}->map_finish();
3327:
3328: $self->{RECURSIVE_ITERATOR} =
1.94 bowersj2 3329: Apache::lonnavmaps::DFSiterator->new ($self->{NAV_MAP}, $firstResource,
1.63 bowersj2 3330: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
1.91 bowersj2 3331: $self->{CONDITION}, $self->{DIRECTION});
1.51 bowersj2 3332: }
3333:
3334: return $self->{HERE};
1.190 bowersj2 3335: }
3336:
3337: # Identical to the full iterator methods of the same name. Hate to copy/paste
3338: # but I also hate to "inherit" either iterator from the other.
3339:
3340: sub getStack {
3341: my $self=shift;
3342:
3343: my @stack;
3344:
3345: $self->populateStack(\@stack);
3346:
3347: return \@stack;
3348: }
3349:
3350: # Private method: Calls the iterators recursively to populate the stack.
3351: sub populateStack {
3352: my $self=shift;
3353: my $stack = shift;
3354:
3355: push @$stack, $self->{HERE} if ($self->{HERE});
3356:
3357: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3358: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3359: }
1.51 bowersj2 3360: }
3361:
1.1 www 3362: 1;
1.2 www 3363:
1.51 bowersj2 3364: package Apache::lonnavmaps::resource;
1.365 albertel 3365: use Scalar::Util qw(weaken);
1.51 bowersj2 3366: use Apache::lonnet;
3367:
3368: =pod
3369:
1.217 bowersj2 3370: =head1 Object: resource
1.51 bowersj2 3371:
1.217 bowersj2 3372: X<resource, navmap object>
1.174 albertel 3373: A resource object encapsulates a resource in a resource map, allowing
3374: easy manipulation of the resource, querying the properties of the
3375: resource (including user properties), and represents a reference that
3376: can be used as the canonical representation of the resource by
3377: lonnavmap clients like renderers.
3378:
3379: A resource only makes sense in the context of a navmap, as some of the
3380: data is stored in the navmap object.
3381:
3382: You will probably never need to instantiate this object directly. Use
3383: Apache::lonnavmaps::navmap, and use the "start" method to obtain the
3384: starting resource.
1.51 bowersj2 3385:
1.188 bowersj2 3386: Resource objects respect the parameter_hiddenparts, which suppresses
3387: various parts according to the wishes of the map author. As of this
3388: writing, there is no way to override this parameter, and suppressed
3389: parts will never be returned, nor will their response types or ids be
3390: stored.
3391:
1.217 bowersj2 3392: =head2 Overview
1.51 bowersj2 3393:
1.217 bowersj2 3394: A B<Resource> is the most granular type of object in LON-CAPA that can
3395: be included in a course. It can either be a particular resource, like
3396: an HTML page, external resource, problem, etc., or it can be a
3397: container sequence, such as a "page" or a "map".
3398:
3399: To see a sequence from the user's point of view, please see the
3400: B<Creating a Course: Maps and Sequences> chapter of the Author's
3401: Manual.
3402:
3403: A Resource Object, once obtained from a navmap object via a B<getBy*>
3404: method of the navmap, or from an iterator, allows you to query
3405: information about that resource.
3406:
3407: Generally, you do not ever want to create a resource object yourself,
3408: so creation has been left undocumented. Always retrieve resources
3409: from navmap objects.
3410:
3411: =head3 Identifying Resources
3412:
3413: X<big hash>Every resource is identified by a Resource ID in the big hash that is
3414: unique to that resource for a given course. X<resource ID, in big hash>
3415: The Resource ID has the form #.#, where the first number is the same
3416: for every resource in a map, and the second is unique. For instance,
3417: for a course laid out like this:
3418:
3419: * Problem 1
3420: * Map
3421: * Resource 2
3422: * Resource 3
3423:
3424: C<Problem 1> and C<Map> will share a first number, and C<Resource 2>
3425: C<Resource 3> will share a first number. The second number may end up
3426: re-used between the two groups.
3427:
3428: The resource ID is only used in the big hash, but can be used in the
3429: context of a course to identify a resource easily. (For instance, the
3430: printing system uses it to record which resources from a sequence you
3431: wish to print.)
3432:
3433: X<symb> X<resource, symb>
3434: All resources also have B<symb>s, which uniquely identify a resource
3435: in a course. Many internal LON-CAPA functions expect a symb. A symb
3436: carries along with it the URL of the resource, and the map it appears
1.398 banghart 3437: in. Symbs are much larger than resource IDs.
1.51 bowersj2 3438:
3439: =cut
3440:
3441: sub new {
3442: # magic invocation to create a class instance
3443: my $proto = shift;
3444: my $class = ref($proto) || $proto;
3445: my $self = {};
3446:
1.300 albertel 3447: weaken($self->{NAV_MAP} = shift);
1.51 bowersj2 3448: $self->{ID} = shift;
3449:
3450: # Store this new resource in the parent nav map's cache.
3451: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
1.66 bowersj2 3452: $self->{RESOURCE_ERROR} = 0;
1.51 bowersj2 3453:
3454: # A hash that can be used by two-pass algorithms to store data
3455: # about this resource in. Not used by the resource object
3456: # directly.
3457: $self->{DATA} = {};
3458:
3459: bless($self);
3460:
3461: return $self;
3462: }
3463:
1.70 bowersj2 3464: # private function: simplify the NAV_HASH lookups we keep doing
3465: # pass the name, and to automatically append my ID, pass a true val on the
3466: # second param
3467: sub navHash {
3468: my $self = shift;
3469: my $param = shift;
3470: my $id = shift;
1.115 bowersj2 3471: return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:""));
1.70 bowersj2 3472: }
3473:
1.51 bowersj2 3474: =pod
3475:
1.217 bowersj2 3476: =head2 Methods
1.70 bowersj2 3477:
1.217 bowersj2 3478: Once you have a resource object, here's what you can do with it:
3479:
3480: =head3 Attribute Retrieval
3481:
3482: Every resource has certain attributes that can be retrieved and used:
1.70 bowersj2 3483:
3484: =over 4
3485:
1.217 bowersj2 3486: =item * B<ID>: Every resource has an ID that is unique for that
3487: resource in the course it is in. The ID is actually in the hash
3488: representing the resource, so for a resource object $res, obtain
3489: it via C<$res->{ID}).
3490:
1.174 albertel 3491: =item * B<compTitle>:
3492:
3493: Returns a "composite title", that is equal to $res->title() if the
3494: resource has a title, and is otherwise the last part of the URL (e.g.,
3495: "problem.problem").
3496:
3497: =item * B<ext>:
3498:
3499: Returns true if the resource is external.
3500:
3501: =item * B<kind>:
3502:
3503: Returns the kind of the resource from the compiled nav map.
3504:
3505: =item * B<randomout>:
1.106 bowersj2 3506:
1.174 albertel 3507: Returns true if this resource was chosen to NOT be shown to the user
3508: by the random map selection feature. In other words, this is usually
3509: false.
1.70 bowersj2 3510:
1.174 albertel 3511: =item * B<randompick>:
1.70 bowersj2 3512:
1.400 albertel 3513: Returns the number of randomly picked items for a map if the randompick
3514: feature is being used on the map.
3515:
3516: =item * B<randomorder>:
3517:
3518: Returns true for a map if the randomorder feature is being used on the
3519: map.
1.70 bowersj2 3520:
1.174 albertel 3521: =item * B<src>:
1.51 bowersj2 3522:
1.174 albertel 3523: Returns the source for the resource.
1.70 bowersj2 3524:
1.174 albertel 3525: =item * B<symb>:
1.70 bowersj2 3526:
1.174 albertel 3527: Returns the symb for the resource.
1.70 bowersj2 3528:
1.174 albertel 3529: =item * B<title>:
1.70 bowersj2 3530:
1.174 albertel 3531: Returns the title of the resource.
3532:
1.51 bowersj2 3533: =back
3534:
3535: =cut
3536:
3537: # These info functions can be used directly, as they don't return
3538: # resource information.
1.85 bowersj2 3539: sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
1.303 albertel 3540: sub encrypted { my $self=shift; return $self->navHash("encrypted_", 1); }
1.70 bowersj2 3541: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
1.85 bowersj2 3542: sub from { my $self=shift; return $self->navHash("from_", 1); }
1.217 bowersj2 3543: # considered private and undocumented
1.51 bowersj2 3544: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
3545: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
1.68 bowersj2 3546: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
3547: sub randompick {
3548: my $self = shift;
1.410 raeburn 3549: my $randompick = $self->parmval('randompick');
3550: return $randompick;
1.68 bowersj2 3551: }
1.400 albertel 3552: sub randomorder {
3553: my $self = shift;
1.410 raeburn 3554: my $randomorder = $self->parmval('randomorder');
3555: return ($randomorder =~ /^yes$/i);
1.400 albertel 3556: }
1.303 albertel 3557: sub link {
3558: my $self=shift;
3559: if ($self->encrypted()) { return &Apache::lonenc::encrypted($self->src); }
3560: return $self->src;
3561: }
1.51 bowersj2 3562: sub src {
3563: my $self=shift;
3564: return $self->navHash("src_", 1);
3565: }
1.303 albertel 3566: sub shown_symb {
3567: my $self=shift;
3568: if ($self->encrypted()) {return &Apache::lonenc::encrypted($self->symb());}
3569: return $self->symb();
3570: }
1.328 www 3571: sub id {
3572: my $self=shift;
3573: return $self->{ID};
3574: }
3575: sub enclosing_map_src {
3576: my $self=shift;
3577: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
3578: return $self->navHash('map_id_'.$first);
3579: }
1.51 bowersj2 3580: sub symb {
3581: my $self=shift;
3582: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
3583: my $symbSrc = &Apache::lonnet::declutter($self->src());
1.223 albertel 3584: my $symb = &Apache::lonnet::declutter($self->navHash('map_id_'.$first))
1.51 bowersj2 3585: . '___' . $second . '___' . $symbSrc;
1.223 albertel 3586: return &Apache::lonnet::symbclean($symb);
1.51 bowersj2 3587: }
1.321 raeburn 3588: sub wrap_symb {
3589: my $self = shift;
3590: return $self->{NAV_MAP}->wrap_symb($self->symb());
3591: }
1.213 bowersj2 3592: sub title {
3593: my $self=shift;
3594: if ($self->{ID} eq '0.0') {
3595: # If this is the top-level map, return the title of the course
3596: # since this map can not be titled otherwise.
1.320 albertel 3597: return $env{'course.'.$env{'request.course.id'}.'.description'};
1.213 bowersj2 3598: }
3599: return $self->navHash("title_", 1); }
1.217 bowersj2 3600: # considered private and undocumented
1.70 bowersj2 3601: sub to { my $self=shift; return $self->navHash("to_", 1); }
1.301 albertel 3602: sub condition {
3603: my $self=shift;
3604: my $undercond=$self->navHash("undercond_", 1);
3605: if (!defined($undercond)) { return 1; };
3606: my $condid=$self->navHash("condid_$undercond");
3607: if (!defined($condid)) { return 1; };
3608: my $condition=&Apache::lonnet::directcondval($condid);
3609: return $condition;
3610: }
1.342 albertel 3611: sub condval {
3612: my $self=shift;
1.359 albertel 3613: my ($pathname,$filename) =
3614: &Apache::lonnet::split_uri_for_cond($self->src());
1.342 albertel 3615:
3616: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
3617: /\&\Q$filename\E\:([\d\|]+)\&/);
3618: if ($match) {
3619: return &Apache::lonnet::condval($1);
3620: }
3621: return 0;
3622: }
1.106 bowersj2 3623: sub compTitle {
3624: my $self = shift;
3625: my $title = $self->title();
1.176 www 3626: $title=~s/\&colon\;/\:/gs;
1.106 bowersj2 3627: if (!$title) {
3628: $title = $self->src();
3629: $title = substr($title, rindex($title, '/') + 1);
3630: }
3631: return $title;
3632: }
1.399 albertel 3633:
1.70 bowersj2 3634: =pod
3635:
3636: B<Predicate Testing the Resource>
3637:
3638: These methods are shortcuts to deciding if a given resource has a given property.
3639:
3640: =over 4
3641:
1.174 albertel 3642: =item * B<is_map>:
3643:
3644: Returns true if the resource is a map type.
3645:
3646: =item * B<is_problem>:
1.70 bowersj2 3647:
1.174 albertel 3648: Returns true if the resource is a problem type, false
3649: otherwise. (Looks at the extension on the src field; might need more
3650: to work correctly.)
1.70 bowersj2 3651:
1.174 albertel 3652: =item * B<is_page>:
1.70 bowersj2 3653:
1.174 albertel 3654: Returns true if the resource is a page.
3655:
3656: =item * B<is_sequence>:
3657:
3658: Returns true if the resource is a sequence.
1.70 bowersj2 3659:
3660: =back
3661:
3662: =cut
3663:
1.256 albertel 3664: sub hasResource {
3665: my $self = shift;
3666: return $self->{NAV_MAP}->hasResource(@_);
3667: }
3668:
3669: sub retrieveResources {
3670: my $self = shift;
3671: return $self->{NAV_MAP}->retrieveResources(@_);
3672: }
1.70 bowersj2 3673:
1.369 albertel 3674: sub is_exam {
3675: my ($self,$part) = @_;
1.410 raeburn 3676: my $type = $self->parmval('type',$part);
3677: if ($type eq 'exam') {
1.369 albertel 3678: return 1;
3679: }
3680: if ($self->src() =~ /\.(exam)$/) {
3681: return 1;
3682: }
3683: return 0;
3684: }
1.70 bowersj2 3685: sub is_html {
1.51 bowersj2 3686: my $self=shift;
3687: my $src = $self->src();
1.70 bowersj2 3688: return ($src =~ /html$/);
1.51 bowersj2 3689: }
1.70 bowersj2 3690: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
3691: sub is_page {
1.51 bowersj2 3692: my $self=shift;
3693: my $src = $self->src();
1.205 bowersj2 3694: return $self->navHash("is_map_", 1) &&
3695: $self->navHash("map_type_" . $self->map_pc()) eq 'page';
1.51 bowersj2 3696: }
1.361 albertel 3697: sub is_practice {
3698: my $self=shift;
3699: my ($part) = @_;
1.410 raeburn 3700: my $type = $self->parmval('type',$part);
3701: if ($type eq 'practice') {
1.361 albertel 3702: return 1;
3703: }
3704: return 0;
3705: }
1.70 bowersj2 3706: sub is_problem {
1.51 bowersj2 3707: my $self=shift;
3708: my $src = $self->src();
1.361 albertel 3709: if ($src =~ /\.(problem|exam|quiz|assess|survey|form|library|task)$/) {
3710: return !($self->is_practice());
3711: }
3712: return 0;
1.256 albertel 3713: }
1.413 www 3714: sub is_raw_problem {
3715: my $self=shift;
3716: my $src = $self->src();
3717: if ($src =~ /\.(problem|exam|quiz|assess|survey|form|library|task)$/) {
3718: return 1;
3719: }
3720: return 0;
3721: }
3722:
1.256 albertel 3723: sub contains_problem {
3724: my $self=shift;
3725: if ($self->is_page()) {
3726: my $hasProblem=$self->hasResource($self,sub { $_[0]->is_problem() },1);
3727: return $hasProblem;
3728: }
3729: return 0;
1.51 bowersj2 3730: }
1.401 albertel 3731: sub map_contains_problem {
3732: my $self=shift;
3733: if ($self->is_map()) {
3734: my $has_problem=
3735: $self->hasResource($self,sub { $_[0]->is_problem() },1);
3736: return $has_problem;
3737: }
3738: return 0;
3739: }
1.70 bowersj2 3740: sub is_sequence {
1.51 bowersj2 3741: my $self=shift;
1.205 bowersj2 3742: return $self->navHash("is_map_", 1) &&
1.426 droeschl 3743: $self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
1.51 bowersj2 3744: }
1.261 matthew 3745: sub is_survey {
3746: my $self = shift();
3747: my $part = shift();
1.410 raeburn 3748: my $type = $self->parmval('type',$part);
3749: if ($type eq 'survey') {
1.261 matthew 3750: return 1;
3751: }
1.263 albertel 3752: if ($self->src() =~ /\.(survey)$/) {
1.261 matthew 3753: return 1;
3754: }
3755: return 0;
3756: }
1.360 albertel 3757: sub is_task {
3758: my $self=shift;
3759: my $src = $self->src();
3760: return ($src =~ /\.(task)$/)
3761: }
1.51 bowersj2 3762:
1.266 raeburn 3763: sub is_empty_sequence {
3764: my $self=shift;
3765: my $src = $self->src();
3766: return !$self->is_page() && $self->navHash("is_map_", 1) && !$self->navHash("map_type_" . $self->map_pc());
3767: }
3768:
1.101 bowersj2 3769: # Private method: Shells out to the parmval in the nav map, handler parts.
1.51 bowersj2 3770: sub parmval {
3771: my $self = shift;
3772: my $what = shift;
1.185 bowersj2 3773: my $part = shift;
3774: if (!defined($part)) {
3775: $part = '0';
3776: }
1.51 bowersj2 3777: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
3778: }
3779:
1.70 bowersj2 3780: =pod
3781:
3782: B<Map Methods>
3783:
1.174 albertel 3784: These methods are useful for getting information about the map
3785: properties of the resource, if the resource is a map (B<is_map>).
1.70 bowersj2 3786:
3787: =over 4
3788:
1.174 albertel 3789: =item * B<map_finish>:
3790:
3791: Returns a reference to a resource object corresponding to the finish
3792: resource of the map.
1.70 bowersj2 3793:
1.174 albertel 3794: =item * B<map_pc>:
1.70 bowersj2 3795:
1.174 albertel 3796: Returns the pc value of the map, which is the first number that
3797: appears in the resource ID of the resources in the map, and is the
3798: number that appears around the middle of the symbs of the resources in
3799: that map.
1.70 bowersj2 3800:
1.174 albertel 3801: =item * B<map_start>:
3802:
3803: Returns a reference to a resource object corresponding to the start
3804: resource of the map.
3805:
3806: =item * B<map_type>:
3807:
3808: Returns a string with the type of the map in it.
1.70 bowersj2 3809:
3810: =back
1.51 bowersj2 3811:
1.70 bowersj2 3812: =cut
1.51 bowersj2 3813:
3814: sub map_finish {
3815: my $self = shift;
3816: my $src = $self->src();
1.381 albertel 3817: $src = &Apache::lonnet::clutter($src);
1.51 bowersj2 3818: my $res = $self->navHash("map_finish_$src", 0);
3819: $res = $self->{NAV_MAP}->getById($res);
3820: return $res;
3821: }
1.70 bowersj2 3822: sub map_pc {
3823: my $self = shift;
1.381 albertel 3824: my $src = $self->src();
1.70 bowersj2 3825: return $self->navHash("map_pc_$src", 0);
3826: }
1.51 bowersj2 3827: sub map_start {
3828: my $self = shift;
3829: my $src = $self->src();
1.381 albertel 3830: $src = &Apache::lonnet::clutter($src);
1.51 bowersj2 3831: my $res = $self->navHash("map_start_$src", 0);
3832: $res = $self->{NAV_MAP}->getById($res);
3833: return $res;
3834: }
3835: sub map_type {
3836: my $self = shift;
3837: my $pc = $self->map_pc();
3838: return $self->navHash("map_type_$pc", 0);
3839: }
3840:
3841: #####
3842: # Property queries
3843: #####
3844:
3845: # These functions will be responsible for returning the CORRECT
3846: # VALUE for the parameter, no matter what. So while they may look
1.398 banghart 3847: # like direct calls to parmval, they can be more than that.
1.51 bowersj2 3848: # So, for instance, the duedate function should use the "duedatetype"
1.398 banghart 3849: # information, rather than the resource object user.
1.51 bowersj2 3850:
3851: =pod
3852:
3853: =head2 Resource Parameters
3854:
1.174 albertel 3855: In order to use the resource parameters correctly, the nav map must
3856: have been instantiated with genCourseAndUserOptions set to true, so
3857: the courseopt and useropt is read correctly. Then, you can call these
3858: functions to get the relevant parameters for the resource. Each
3859: function defaults to part "0", but can be directed to another part by
3860: passing the part as the parameter.
3861:
3862: These methods are responsible for getting the parameter correct, not
3863: merely reflecting the contents of the GDBM hashes. As we move towards
3864: dates relative to other dates, these methods should be updated to
3865: reflect that. (Then, anybody using these methods will not have to update
3866: their code.)
3867:
3868: =over 4
3869:
3870: =item * B<acc>:
3871:
3872: Get the Client IP/Name Access Control information.
1.51 bowersj2 3873:
1.174 albertel 3874: =item * B<answerdate>:
1.51 bowersj2 3875:
1.174 albertel 3876: Get the answer-reveal date for the problem.
3877:
1.211 bowersj2 3878: =item * B<awarded>:
3879:
3880: Gets the awarded value for the problem part. Requires genUserData set to
3881: true when the navmap object was created.
3882:
1.174 albertel 3883: =item * B<duedate>:
3884:
3885: Get the due date for the problem.
3886:
3887: =item * B<tries>:
3888:
3889: Get the number of tries the student has used on the problem.
3890:
3891: =item * B<maxtries>:
3892:
3893: Get the number of max tries allowed.
3894:
3895: =item * B<opendate>:
1.51 bowersj2 3896:
1.174 albertel 3897: Get the open date for the problem.
1.51 bowersj2 3898:
1.174 albertel 3899: =item * B<sig>:
1.51 bowersj2 3900:
1.174 albertel 3901: Get the significant figures setting.
1.51 bowersj2 3902:
1.174 albertel 3903: =item * B<tol>:
1.51 bowersj2 3904:
1.174 albertel 3905: Get the tolerance for the problem.
1.51 bowersj2 3906:
1.174 albertel 3907: =item * B<tries>:
1.51 bowersj2 3908:
1.174 albertel 3909: Get the number of tries the user has already used on the problem.
1.51 bowersj2 3910:
1.174 albertel 3911: =item * B<type>:
1.51 bowersj2 3912:
1.174 albertel 3913: Get the question type for the problem.
1.70 bowersj2 3914:
1.174 albertel 3915: =item * B<weight>:
1.51 bowersj2 3916:
1.174 albertel 3917: Get the weight for the problem.
1.51 bowersj2 3918:
3919: =back
3920:
3921: =cut
3922:
3923: sub acc {
3924: (my $self, my $part) = @_;
1.410 raeburn 3925: my $acc = $self->parmval("acc", $part);
3926: return $acc;
1.51 bowersj2 3927: }
3928: sub answerdate {
3929: (my $self, my $part) = @_;
3930: # Handle intervals
1.410 raeburn 3931: my $answerdatetype = $self->parmval("answerdate.type", $part);
3932: my $answerdate = $self->parmval("answerdate", $part);
3933: my $duedate = $self->parmval("duedate", $part);
3934: if ($answerdatetype eq 'date_interval') {
3935: $answerdate = $duedate + $answerdate;
1.51 bowersj2 3936: }
1.410 raeburn 3937: return $answerdate;
1.106 bowersj2 3938: }
1.211 bowersj2 3939: sub awarded {
3940: my $self = shift; my $part = shift;
1.221 bowersj2 3941: $self->{NAV_MAP}->get_user_data();
1.211 bowersj2 3942: if (!defined($part)) { $part = '0'; }
3943: return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'};
3944: }
1.382 albertel 3945: # this should work exactly like the copy in lonhomework.pm
1.51 bowersj2 3946: sub duedate {
3947: (my $self, my $part) = @_;
1.382 albertel 3948: my $date;
1.406 albertel 3949: my @interval=$self->parmval("interval", $part);
1.382 albertel 3950: my $due_date=$self->parmval("duedate", $part);
1.406 albertel 3951: if ($interval[0] =~ /\d+/) {
3952: my $first_access=&Apache::lonnet::get_first_access($interval[1],
3953: $self->symb);
1.382 albertel 3954: if (defined($first_access)) {
1.406 albertel 3955: my $interval = $first_access+$interval[0];
1.404 albertel 3956: $date = (!$due_date || $interval < $due_date) ? $interval
3957: : $due_date;
1.382 albertel 3958: } else {
3959: $date = $due_date;
3960: }
3961: } else {
3962: $date = $due_date;
1.260 albertel 3963: }
1.382 albertel 3964: return $date;
1.51 bowersj2 3965: }
1.334 albertel 3966: sub handgrade {
3967: (my $self, my $part) = @_;
1.399 albertel 3968: my @response_ids = $self->responseIds($part);
3969: if (@response_ids) {
3970: foreach my $response_id (@response_ids) {
1.410 raeburn 3971: my $handgrade = $self->parmval("handgrade",$part.'_'.$response_id);
3972: if (lc($handgrade) eq 'yes') {
1.399 albertel 3973: return 'yes';
3974: }
3975: }
3976: }
1.410 raeburn 3977: my $handgrade = $self->parmval("handgrade", $part);
3978: return $handgrade;
1.334 albertel 3979: }
1.51 bowersj2 3980: sub maxtries {
3981: (my $self, my $part) = @_;
1.410 raeburn 3982: my $maxtries = $self->parmval("maxtries", $part);
3983: return $maxtries;
1.51 bowersj2 3984: }
3985: sub opendate {
3986: (my $self, my $part) = @_;
1.410 raeburn 3987: my $opendatetype = $self->parmval("opendate.type", $part);
3988: my $opendate = $self->parmval("opendate", $part);
3989: if ($opendatetype eq 'date_interval') {
3990: my $duedate = $self->duedate($part);
3991: $opendate = $duedate - $opendate;
1.51 bowersj2 3992: }
1.410 raeburn 3993: return $opendate;
1.51 bowersj2 3994: }
1.185 bowersj2 3995: sub problemstatus {
3996: (my $self, my $part) = @_;
1.410 raeburn 3997: my $problemstatus = $self->parmval("problemstatus", $part);
3998: return lc($problemstatus);
1.185 bowersj2 3999: }
1.51 bowersj2 4000: sub sig {
4001: (my $self, my $part) = @_;
1.410 raeburn 4002: my $sig = $self->parmval("sig", $part);
4003: return $sig;
1.51 bowersj2 4004: }
4005: sub tol {
4006: (my $self, my $part) = @_;
1.410 raeburn 4007: my $tol = $self->parmval("tol", $part);
4008: return $tol;
1.51 bowersj2 4009: }
1.410 raeburn 4010: sub tries {
1.108 bowersj2 4011: my $self = shift;
4012: my $tries = $self->queryRestoreHash('tries', shift);
4013: if (!defined($tries)) { return '0';}
1.51 bowersj2 4014: return $tries;
4015: }
1.70 bowersj2 4016: sub type {
4017: (my $self, my $part) = @_;
1.410 raeburn 4018: my $type = $self->parmval("type", $part);
4019: return $type;
1.70 bowersj2 4020: }
1.109 bowersj2 4021: sub weight {
4022: my $self = shift; my $part = shift;
1.211 bowersj2 4023: if (!defined($part)) { $part = '0'; }
1.409 raeburn 4024: my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight',
4025: $self->symb(), $env{'user.domain'},
4026: $env{'user.name'},
4027: $env{'request.course.sec'});
4028: return $weight;
1.274 matthew 4029: }
4030: sub part_display {
4031: my $self= shift(); my $partID = shift();
4032: if (! defined($partID)) { $partID = '0'; }
4033: my $display=&Apache::lonnet::EXT('resource.'.$partID.'.display',
4034: $self->symb);
4035: if (! defined($display) || $display eq '') {
4036: $display = $partID;
4037: }
4038: return $display;
1.70 bowersj2 4039: }
1.51 bowersj2 4040:
4041: # Multiple things need this
4042: sub getReturnHash {
4043: my $self = shift;
4044:
4045: if (!defined($self->{RETURN_HASH})) {
1.84 bowersj2 4046: my %tmpHash = &Apache::lonnet::restore($self->symb());
1.51 bowersj2 4047: $self->{RETURN_HASH} = \%tmpHash;
4048: }
4049: }
4050:
4051: ######
4052: # Status queries
4053: ######
4054:
4055: # These methods query the status of problems.
4056:
4057: # If we need to count parts, this function determines the number of
4058: # parts from the metadata. When called, it returns a reference to a list
4059: # of strings corresponding to the parts. (Thus, using it in a scalar context
4060: # tells you how many parts you have in the problem:
4061: # $partcount = scalar($resource->countParts());
4062: # Don't use $self->{PARTS} directly because you don't know if it's been
4063: # computed yet.
4064:
4065: =pod
4066:
4067: =head2 Resource misc
4068:
4069: Misc. functions for the resource.
4070:
4071: =over 4
4072:
1.174 albertel 4073: =item * B<hasDiscussion>:
1.59 bowersj2 4074:
1.174 albertel 4075: Returns a false value if there has been discussion since the user last
4076: logged in, true if there has. Always returns false if the discussion
4077: data was not extracted when the nav map was constructed.
4078:
1.366 albertel 4079: =item * B<last_post_time>:
4080:
4081: Returns a false value if there hasn't been discussion otherwise returns
4082: unix timestamp of last time a discussion posting (or edit) was made.
4083:
1.393 raeburn 4084: =item * B<discussion_info>:
1.366 albertel 4085:
1.393 raeburn 4086: optional argument is a filter (currently can be 'unread');
4087: returns in scalar context the count of the number of discussion postings.
1.366 albertel 4088:
4089: returns in list context both the count of postings and a hash ref
1.393 raeburn 4090: containing information about the postings (subject, id, timestamp) in a hash.
4091:
4092: 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 4093:
1.174 albertel 4094: =item * B<getFeedback>:
4095:
4096: Gets the feedback for the resource and returns the raw feedback string
4097: for the resource, or the null string if there is no feedback or the
4098: email data was not extracted when the nav map was constructed. Usually
4099: used like this:
1.59 bowersj2 4100:
1.394 raeburn 4101: for my $url (split(/\,/, $res->getFeedback())) {
4102: my $link = &escape($url);
1.59 bowersj2 4103: ...
4104:
4105: and use the link as appropriate.
4106:
4107: =cut
4108:
4109: sub hasDiscussion {
4110: my $self = shift;
4111: return $self->{NAV_MAP}->hasDiscussion($self->symb());
4112: }
4113:
1.366 albertel 4114: sub last_post_time {
4115: my $self = shift;
4116: return $self->{NAV_MAP}->last_post_time($self->symb());
4117: }
4118:
1.393 raeburn 4119: sub discussion_info {
4120: my ($self,$filter) = @_;
4121: return $self->{NAV_MAP}->discussion_info($self->symb(),$filter);
1.366 albertel 4122: }
4123:
1.59 bowersj2 4124: sub getFeedback {
4125: my $self = shift;
1.124 bowersj2 4126: my $source = $self->src();
1.395 raeburn 4127: my $symb = $self->symb();
1.125 bowersj2 4128: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
1.395 raeburn 4129: return $self->{NAV_MAP}->getFeedback($symb,$source);
1.124 bowersj2 4130: }
4131:
4132: sub getErrors {
4133: my $self = shift;
4134: my $source = $self->src();
1.395 raeburn 4135: my $symb = $self->symb();
1.124 bowersj2 4136: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
1.395 raeburn 4137: return $self->{NAV_MAP}->getErrors($symb,$source);
1.59 bowersj2 4138: }
4139:
4140: =pod
4141:
1.174 albertel 4142: =item * B<parts>():
1.51 bowersj2 4143:
1.174 albertel 4144: Returns a list reference containing sorted strings corresponding to
1.193 bowersj2 4145: each part of the problem. Single part problems have only a part '0'.
4146: Multipart problems do not return their part '0', since they typically
4147: do not really matter.
1.174 albertel 4148:
4149: =item * B<countParts>():
4150:
4151: Returns the number of parts of the problem a student can answer. Thus,
4152: for single part problems, returns 1. For multipart, it returns the
1.193 bowersj2 4153: number of parts in the problem, not including psuedo-part 0.
1.51 bowersj2 4154:
1.290 matthew 4155: =item * B<countResponses>():
4156:
4157: Returns the total number of responses in the problem a student can answer.
4158:
4159: =item * B<responseTypes>():
4160:
4161: Returns a hash whose keys are the response types. The values are the number
4162: of times each response type is used. This is for the I<entire> problem, not
4163: just a single part.
4164:
1.192 bowersj2 4165: =item * B<multipart>():
4166:
1.193 bowersj2 4167: Returns true if the problem is multipart, false otherwise. Use this instead
4168: of countParts if all you want is multipart/not multipart.
1.192 bowersj2 4169:
1.187 bowersj2 4170: =item * B<responseType>($part):
4171:
4172: Returns the response type of the part, without the word "response" on the
4173: end. Example return values: 'string', 'essay', 'numeric', etc.
4174:
1.193 bowersj2 4175: =item * B<responseIds>($part):
1.187 bowersj2 4176:
1.193 bowersj2 4177: Retreives the response IDs for the given part as an array reference containing
4178: strings naming the response IDs. This may be empty.
1.187 bowersj2 4179:
1.51 bowersj2 4180: =back
4181:
4182: =cut
4183:
4184: sub parts {
4185: my $self = shift;
4186:
1.192 bowersj2 4187: if ($self->ext) { return []; }
1.67 bowersj2 4188:
1.51 bowersj2 4189: $self->extractParts();
4190: return $self->{PARTS};
4191: }
4192:
4193: sub countParts {
4194: my $self = shift;
4195:
4196: my $parts = $self->parts();
1.191 bowersj2 4197:
4198: # If I left this here, then it's not necessary.
4199: #my $delta = 0;
4200: #for my $part (@$parts) {
4201: # if ($part eq '0') { $delta--; }
4202: #}
1.66 bowersj2 4203:
4204: if ($self->{RESOURCE_ERROR}) {
4205: return 0;
4206: }
4207:
1.191 bowersj2 4208: return scalar(@{$parts}); # + $delta;
1.192 bowersj2 4209: }
4210:
1.290 matthew 4211: sub countResponses {
4212: my $self = shift;
4213: my $count;
1.293 matthew 4214: foreach my $part (@{$self->parts()}) {
4215: $count+= scalar($self->responseIds($part));
1.290 matthew 4216: }
4217: return $count;
4218: }
4219:
4220: sub responseTypes {
4221: my $self = shift;
1.291 albertel 4222: my %responses;
1.368 raeburn 4223: foreach my $part (@{$self->parts()}) {
1.290 matthew 4224: foreach my $responsetype ($self->responseType($part)) {
1.291 albertel 4225: $responses{$responsetype}++ if (defined($responsetype));
1.290 matthew 4226: }
4227: }
1.291 albertel 4228: return %responses;
1.290 matthew 4229: }
4230:
1.192 bowersj2 4231: sub multipart {
4232: my $self = shift;
4233: return $self->countParts() > 1;
1.51 bowersj2 4234: }
4235:
1.225 bowersj2 4236: sub singlepart {
4237: my $self = shift;
4238: return $self->countParts() == 1;
4239: }
4240:
1.187 bowersj2 4241: sub responseType {
1.184 bowersj2 4242: my $self = shift;
4243: my $part = shift;
4244:
4245: $self->extractParts();
1.235 albertel 4246: if (defined($self->{RESPONSE_TYPES}->{$part})) {
4247: return @{$self->{RESPONSE_TYPES}->{$part}};
4248: } else {
4249: return undef;
4250: }
1.187 bowersj2 4251: }
4252:
1.193 bowersj2 4253: sub responseIds {
1.187 bowersj2 4254: my $self = shift;
4255: my $part = shift;
4256:
4257: $self->extractParts();
1.235 albertel 4258: if (defined($self->{RESPONSE_IDS}->{$part})) {
4259: return @{$self->{RESPONSE_IDS}->{$part}};
4260: } else {
4261: return undef;
4262: }
1.184 bowersj2 4263: }
4264:
4265: # Private function: Extracts the parts information, both part names and
1.187 bowersj2 4266: # part types, and saves it.
1.51 bowersj2 4267: sub extractParts {
4268: my $self = shift;
4269:
1.153 bowersj2 4270: return if (defined($self->{PARTS}));
1.67 bowersj2 4271: return if ($self->ext);
1.51 bowersj2 4272:
4273: $self->{PARTS} = [];
4274:
1.181 bowersj2 4275: my %parts;
4276:
1.82 bowersj2 4277: # Retrieve part count, if this is a problem
4278: if ($self->is_problem()) {
1.240 albertel 4279: my $partorder = &Apache::lonnet::metadata($self->src(), 'partorder');
1.152 matthew 4280: my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
1.181 bowersj2 4281:
1.239 bowersj2 4282: if ($partorder) {
4283: my @parts;
4284: for my $part (split (/,/,$partorder)) {
4285: if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
4286: push @parts, $part;
1.241 albertel 4287: $parts{$part} = 1;
1.239 bowersj2 4288: }
4289: }
4290: $self->{PARTS} = \@parts;
4291: } else {
4292: if (!$metadata) {
4293: $self->{RESOURCE_ERROR} = 1;
4294: $self->{PARTS} = [];
4295: $self->{PART_TYPE} = {};
4296: return;
4297: }
1.394 raeburn 4298: foreach my $entry (split(/\,/,$metadata)) {
4299: if ($entry =~ /^(?:part|Task)_(.*)$/) {
1.239 bowersj2 4300: my $part = $1;
4301: # This floods the logs if it blows up
4302: if (defined($parts{$part})) {
1.241 albertel 4303: &Apache::lonnet::logthis("$part multiply defined in metadata for " . $self->symb());
4304: }
1.239 bowersj2 4305:
4306: # check to see if part is turned off.
4307:
4308: if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
4309: $parts{$part} = 1;
4310: }
4311: }
4312: }
4313: my @sortedParts = sort keys %parts;
4314: $self->{PARTS} = \@sortedParts;
1.51 bowersj2 4315: }
1.82 bowersj2 4316:
1.187 bowersj2 4317:
1.284 matthew 4318: # These hashes probably do not need names that end with "Hash"....
1.187 bowersj2 4319: my %responseIdHash;
4320: my %responseTypeHash;
4321:
1.189 bowersj2 4322:
4323: # Init the responseIdHash
1.394 raeburn 4324: foreach my $part (@{$self->{PARTS}}) {
4325: $responseIdHash{$part} = [];
1.189 bowersj2 4326: }
4327:
1.187 bowersj2 4328: # Now, the unfortunate thing about this is that parts, part name, and
1.239 bowersj2 4329: # response id are delimited by underscores, but both the part
1.187 bowersj2 4330: # name and response id can themselves have underscores in them.
4331: # So we have to use our knowlege of part names to figure out
4332: # where the part names begin and end, and even then, it is possible
4333: # to construct ambiguous situations.
1.379 albertel 4334: foreach my $data (split /,/, $metadata) {
4335: if ($data =~ /^([a-zA-Z]+)response_(.*)/
4336: || $data =~ /^(Task)_(.*)/) {
1.187 bowersj2 4337: my $responseType = $1;
4338: my $partStuff = $2;
4339: my $partIdSoFar = '';
4340: my @partChunks = split /_/, $partStuff;
4341: my $i = 0;
4342: for ($i = 0; $i < scalar(@partChunks); $i++) {
4343: if ($partIdSoFar) { $partIdSoFar .= '_'; }
4344: $partIdSoFar .= $partChunks[$i];
4345: if ($parts{$partIdSoFar}) {
4346: my @otherChunks = @partChunks[$i+1..$#partChunks];
4347: my $responseId = join('_', @otherChunks);
1.379 albertel 4348: if ($self->is_task()) {
4349: push(@{$responseIdHash{$partIdSoFar}},
4350: $partIdSoFar);
4351: } else {
4352: push(@{$responseIdHash{$partIdSoFar}},
4353: $responseId);
4354: }
4355: push(@{$responseTypeHash{$partIdSoFar}},
4356: $responseType);
1.187 bowersj2 4357: }
4358: }
4359: }
4360: }
1.264 albertel 4361: my $resorder = &Apache::lonnet::metadata($self->src(),'responseorder');
1.284 matthew 4362: #
4363: # Reorder the arrays in the %responseIdHash and %responseTypeHash
1.264 albertel 4364: if ($resorder) {
4365: my @resorder=split(/,/,$resorder);
4366: foreach my $part (keys(%responseIdHash)) {
1.286 albertel 4367: my $i=0;
4368: my %resids = map { ($_,$i++) } @{ $responseIdHash{$part} };
1.264 albertel 4369: my @neworder;
4370: foreach my $possibleid (@resorder) {
4371: if (exists($resids{$possibleid})) {
1.286 albertel 4372: push(@neworder,$resids{$possibleid});
1.264 albertel 4373: }
4374: }
1.286 albertel 4375: my @ids;
4376: my @type;
4377: foreach my $element (@neworder) {
4378: push (@ids,$responseIdHash{$part}->[$element]);
4379: push (@type,$responseTypeHash{$part}->[$element]);
4380: }
4381: $responseIdHash{$part}=\@ids;
4382: $responseTypeHash{$part}=\@type;
1.264 albertel 4383: }
4384: }
1.187 bowersj2 4385: $self->{RESPONSE_IDS} = \%responseIdHash;
4386: $self->{RESPONSE_TYPES} = \%responseTypeHash;
1.154 bowersj2 4387: }
4388:
1.51 bowersj2 4389: return;
4390: }
4391:
4392: =pod
4393:
4394: =head2 Resource Status
4395:
1.174 albertel 4396: Problem resources have status information, reflecting their various
4397: dates and completion statuses.
1.51 bowersj2 4398:
1.174 albertel 4399: There are two aspects to the status: the date-related information and
4400: the completion information.
1.51 bowersj2 4401:
1.174 albertel 4402: Idiomatic usage of these two methods would probably look something
4403: like
1.51 bowersj2 4404:
1.394 raeburn 4405: foreach my $part ($resource->parts()) {
4406: my $dateStatus = $resource->getDateStatus($part);
4407: my $completionStatus = $resource->getCompletionStatus($part);
1.51 bowersj2 4408:
1.70 bowersj2 4409: or
4410:
1.394 raeburn 4411: my $status = $resource->status($part);
1.70 bowersj2 4412:
1.51 bowersj2 4413: ... use it here ...
4414: }
4415:
1.174 albertel 4416: Which you use depends on exactly what you are looking for. The
4417: status() function has been optimized for the nav maps display and may
4418: not precisely match what you need elsewhere.
1.101 bowersj2 4419:
1.174 albertel 4420: The symbolic constants shown below can be accessed through the
4421: resource object: C<$res->OPEN>.
1.101 bowersj2 4422:
1.51 bowersj2 4423: =over 4
4424:
1.174 albertel 4425: =item * B<getDateStatus>($part):
4426:
4427: ($part defaults to 0). A convenience function that returns a symbolic
4428: constant telling you about the date status of the part. The possible
4429: return values are:
1.51 bowersj2 4430:
4431: =back
4432:
4433: B<Date Codes>
4434:
4435: =over 4
4436:
1.174 albertel 4437: =item * B<OPEN_LATER>:
4438:
4439: The problem will be opened later.
4440:
4441: =item * B<OPEN>:
4442:
4443: Open and not yet due.
4444:
1.51 bowersj2 4445:
1.174 albertel 4446: =item * B<PAST_DUE_ANSWER_LATER>:
1.51 bowersj2 4447:
1.174 albertel 4448: The due date has passed, but the answer date has not yet arrived.
1.59 bowersj2 4449:
1.174 albertel 4450: =item * B<PAST_DUE_NO_ANSWER>:
1.54 bowersj2 4451:
1.174 albertel 4452: The due date has passed and there is no answer opening date set.
1.51 bowersj2 4453:
1.174 albertel 4454: =item * B<ANSWER_OPEN>:
1.51 bowersj2 4455:
1.174 albertel 4456: The answer date is here.
4457:
4458: =item * B<NETWORK_FAILURE>:
4459:
4460: The information is unknown due to network failure.
1.51 bowersj2 4461:
4462: =back
4463:
4464: =cut
4465:
4466: # Apparently the compiler optimizes these into constants automatically
1.54 bowersj2 4467: sub OPEN_LATER { return 0; }
4468: sub OPEN { return 1; }
4469: sub PAST_DUE_NO_ANSWER { return 2; }
4470: sub PAST_DUE_ANSWER_LATER { return 3; }
4471: sub ANSWER_OPEN { return 4; }
4472: sub NOTHING_SET { return 5; }
4473: sub NETWORK_FAILURE { return 100; }
4474:
4475: # getDateStatus gets the date status for a given problem part.
4476: # Because answer date, due date, and open date are fully independent
4477: # (i.e., it is perfectly possible to *only* have an answer date),
4478: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
4479: # (past, future, none given). This function handles this with a decision
4480: # tree. Read the comments to follow the decision tree.
1.51 bowersj2 4481:
4482: sub getDateStatus {
4483: my $self = shift;
4484: my $part = shift;
4485: $part = "0" if (!defined($part));
1.54 bowersj2 4486:
4487: # Always return network failure if there was one.
1.51 bowersj2 4488: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4489:
4490: my $now = time();
4491:
1.53 bowersj2 4492: my $open = $self->opendate($part);
4493: my $due = $self->duedate($part);
4494: my $answer = $self->answerdate($part);
4495:
4496: if (!$open && !$due && !$answer) {
4497: # no data on the problem at all
4498: # should this be the same as "open later"? think multipart.
4499: return $self->NOTHING_SET;
4500: }
1.59 bowersj2 4501: if (!$open || $now < $open) {return $self->OPEN_LATER}
4502: if (!$due || $now < $due) {return $self->OPEN}
4503: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
4504: if ($answer) { return $self->ANSWER_OPEN; }
1.54 bowersj2 4505: return PAST_DUE_NO_ANSWER;
1.51 bowersj2 4506: }
4507:
4508: =pod
4509:
4510: B<>
4511:
4512: =over 4
4513:
1.174 albertel 4514: =item * B<getCompletionStatus>($part):
1.51 bowersj2 4515:
1.174 albertel 4516: ($part defaults to 0.) A convenience function that returns a symbolic
4517: constant telling you about the completion status of the part, with the
4518: following possible results:
4519:
4520: =back
1.51 bowersj2 4521:
4522: B<Completion Codes>
4523:
4524: =over 4
4525:
1.174 albertel 4526: =item * B<NOT_ATTEMPTED>:
4527:
4528: Has not been attempted at all.
4529:
4530: =item * B<INCORRECT>:
4531:
4532: Attempted, but wrong by student.
1.51 bowersj2 4533:
1.174 albertel 4534: =item * B<INCORRECT_BY_OVERRIDE>:
1.51 bowersj2 4535:
1.174 albertel 4536: Attempted, but wrong by instructor override.
1.51 bowersj2 4537:
1.174 albertel 4538: =item * B<CORRECT>:
1.51 bowersj2 4539:
1.174 albertel 4540: Correct or correct by instructor.
1.51 bowersj2 4541:
1.174 albertel 4542: =item * B<CORRECT_BY_OVERRIDE>:
1.51 bowersj2 4543:
1.174 albertel 4544: Correct by instructor override.
1.51 bowersj2 4545:
1.174 albertel 4546: =item * B<EXCUSED>:
4547:
4548: Excused. Not yet implemented.
4549:
4550: =item * B<NETWORK_FAILURE>:
4551:
4552: Information not available due to network failure.
4553:
4554: =item * B<ATTEMPTED>:
4555:
4556: Attempted, and not yet graded.
1.69 bowersj2 4557:
1.51 bowersj2 4558: =back
4559:
4560: =cut
4561:
1.53 bowersj2 4562: sub NOT_ATTEMPTED { return 10; }
4563: sub INCORRECT { return 11; }
4564: sub INCORRECT_BY_OVERRIDE { return 12; }
4565: sub CORRECT { return 13; }
4566: sub CORRECT_BY_OVERRIDE { return 14; }
4567: sub EXCUSED { return 15; }
1.69 bowersj2 4568: sub ATTEMPTED { return 16; }
1.51 bowersj2 4569:
4570: sub getCompletionStatus {
4571: my $self = shift;
1.332 albertel 4572: my $part = shift;
1.51 bowersj2 4573: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4574:
1.332 albertel 4575: my $status = $self->queryRestoreHash('solved', $part);
1.51 bowersj2 4576:
1.251 www 4577: # Left as separate if statements in case we ever do more with this
1.51 bowersj2 4578: if ($status eq 'correct_by_student') {return $self->CORRECT;}
1.288 albertel 4579: if ($status eq 'correct_by_scantron') {return $self->CORRECT;}
1.332 albertel 4580: if ($status eq 'correct_by_override') {
4581: return $self->CORRECT_BY_OVERRIDE;
4582: }
1.51 bowersj2 4583: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
4584: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
4585: if ($status eq 'excused') {return $self->EXCUSED; }
1.69 bowersj2 4586: if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
1.51 bowersj2 4587: return $self->NOT_ATTEMPTED;
1.108 bowersj2 4588: }
4589:
4590: sub queryRestoreHash {
4591: my $self = shift;
4592: my $hashentry = shift;
4593: my $part = shift;
1.185 bowersj2 4594: $part = "0" if (!defined($part) || $part eq '');
1.108 bowersj2 4595: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4596:
4597: $self->getReturnHash();
4598:
4599: return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry};
1.51 bowersj2 4600: }
4601:
4602: =pod
4603:
4604: B<Composite Status>
4605:
1.174 albertel 4606: Along with directly returning the date or completion status, the
4607: resource object includes a convenience function B<status>() that will
4608: combine the two status tidbits into one composite status that can
1.191 bowersj2 4609: represent the status of the resource as a whole. This method represents
4610: the concept of the thing we want to display to the user on the nav maps
4611: screen, which is a combination of completion and open status. The precise logic is
1.174 albertel 4612: documented in the comments of the status method. The following results
4613: may be returned, all available as methods on the resource object
1.185 bowersj2 4614: ($res->NETWORK_FAILURE): In addition to the return values that match
4615: the date or completion status, this function can return "ANSWER_SUBMITTED"
4616: if that problemstatus parameter value is set to No, suppressing the
4617: incorrect/correct feedback.
1.51 bowersj2 4618:
4619: =over 4
4620:
1.174 albertel 4621: =item * B<NETWORK_FAILURE>:
4622:
4623: The network has failed and the information is not available.
1.51 bowersj2 4624:
1.174 albertel 4625: =item * B<NOTHING_SET>:
1.53 bowersj2 4626:
1.174 albertel 4627: No dates have been set for this problem (part) at all. (Because only
4628: certain parts of a multi-part problem may be assigned, this can not be
4629: collapsed into "open later", as we do not know a given part will EVER
4630: be opened. For single part, this is the same as "OPEN_LATER".)
1.51 bowersj2 4631:
1.174 albertel 4632: =item * B<CORRECT>:
1.51 bowersj2 4633:
1.174 albertel 4634: For any reason at all, the part is considered correct.
1.54 bowersj2 4635:
1.174 albertel 4636: =item * B<EXCUSED>:
1.51 bowersj2 4637:
1.174 albertel 4638: For any reason at all, the problem is excused.
1.51 bowersj2 4639:
1.174 albertel 4640: =item * B<PAST_DUE_NO_ANSWER>:
1.51 bowersj2 4641:
1.174 albertel 4642: The problem is past due, not considered correct, and no answer date is
4643: set.
1.51 bowersj2 4644:
1.174 albertel 4645: =item * B<PAST_DUE_ANSWER_LATER>:
1.51 bowersj2 4646:
1.174 albertel 4647: The problem is past due, not considered correct, and an answer date in
4648: the future is set.
1.51 bowersj2 4649:
1.174 albertel 4650: =item * B<ANSWER_OPEN>:
4651:
4652: The problem is past due, not correct, and the answer is now available.
4653:
4654: =item * B<OPEN_LATER>:
4655:
4656: The problem is not yet open.
4657:
4658: =item * B<TRIES_LEFT>:
4659:
4660: The problem is open, has been tried, is not correct, but there are
4661: tries left.
4662:
4663: =item * B<INCORRECT>:
4664:
4665: The problem is open, and all tries have been used without getting the
4666: correct answer.
4667:
4668: =item * B<OPEN>:
4669:
4670: The item is open and not yet tried.
4671:
4672: =item * B<ATTEMPTED>:
4673:
4674: The problem has been attempted.
1.69 bowersj2 4675:
1.185 bowersj2 4676: =item * B<ANSWER_SUBMITTED>:
4677:
4678: An answer has been submitted, but the student should not see it.
4679:
1.51 bowersj2 4680: =back
4681:
4682: =cut
4683:
1.185 bowersj2 4684: sub TRIES_LEFT { return 20; }
4685: sub ANSWER_SUBMITTED { return 21; }
1.332 albertel 4686: sub PARTIALLY_CORRECT{ return 22; }
1.51 bowersj2 4687:
4688: sub status {
4689: my $self = shift;
4690: my $part = shift;
4691: if (!defined($part)) { $part = "0"; }
4692: my $completionStatus = $self->getCompletionStatus($part);
4693: my $dateStatus = $self->getDateStatus($part);
4694:
4695: # What we have is a two-dimensional matrix with 4 entries on one
4696: # dimension and 5 entries on the other, which we want to colorize,
1.54 bowersj2 4697: # plus network failure and "no date data at all".
1.51 bowersj2 4698:
1.222 bowersj2 4699: #if ($self->{RESOURCE_ERROR}) { return NETWORK_FAILURE; }
1.53 bowersj2 4700: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
1.51 bowersj2 4701:
1.408 raeburn 4702: my $suppressFeedback = 0;
4703: if (($self->problemstatus($part) eq 'no') ||
4704: ($self->problemstatus($part) eq 'no_feedback_ever')) {
4705: $suppressFeedback = 1;
4706: }
1.236 bowersj2 4707: # If there's an answer date and we're past it, don't
4708: # suppress the feedback; student should know
1.330 albertel 4709: if ($self->duedate($part) && $self->duedate($part) < time() &&
4710: $self->answerdate($part) && $self->answerdate($part) < time()) {
1.236 bowersj2 4711: $suppressFeedback = 0;
4712: }
1.185 bowersj2 4713:
1.51 bowersj2 4714: # There are a few whole rows we can dispose of:
1.53 bowersj2 4715: if ($completionStatus == CORRECT ||
4716: $completionStatus == CORRECT_BY_OVERRIDE ) {
1.332 albertel 4717: if ( $suppressFeedback ) { return ANSWER_SUBMITTED }
4718: my $awarded=$self->awarded($part);
4719: if ($awarded < 1 && $awarded > 0) {
4720: return PARTIALLY_CORRECT;
4721: } elsif ($awarded<1) {
4722: return INCORRECT;
4723: }
4724: return CORRECT;
1.69 bowersj2 4725: }
4726:
1.343 albertel 4727: # If it's WRONG... and not open
4728: if ( ($completionStatus == INCORRECT ||
4729: $completionStatus == INCORRECT_BY_OVERRIDE)
4730: && (!$self->opendate($part) || $self->opendate($part) > time()) ) {
4731: return INCORRECT;
4732: }
4733:
1.69 bowersj2 4734: if ($completionStatus == ATTEMPTED) {
4735: return ATTEMPTED;
1.53 bowersj2 4736: }
4737:
4738: # If it's EXCUSED, then return that no matter what
4739: if ($completionStatus == EXCUSED) {
4740: return EXCUSED;
1.51 bowersj2 4741: }
4742:
1.53 bowersj2 4743: if ($dateStatus == NOTHING_SET) {
4744: return NOTHING_SET;
1.51 bowersj2 4745: }
4746:
1.69 bowersj2 4747: # Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
4748: # by 4 matrix (date statuses).
1.51 bowersj2 4749:
1.54 bowersj2 4750: if ($dateStatus == PAST_DUE_ANSWER_LATER ||
1.59 bowersj2 4751: $dateStatus == PAST_DUE_NO_ANSWER ) {
1.272 albertel 4752: return $suppressFeedback ? ANSWER_SUBMITTED : $dateStatus;
1.51 bowersj2 4753: }
4754:
1.53 bowersj2 4755: if ($dateStatus == ANSWER_OPEN) {
4756: return ANSWER_OPEN;
1.51 bowersj2 4757: }
4758:
4759: # Now: (incorrect, incorrect_override, not_attempted) x
4760: # (open_later), (open)
4761:
1.53 bowersj2 4762: if ($dateStatus == OPEN_LATER) {
4763: return OPEN_LATER;
1.51 bowersj2 4764: }
4765:
4766: # If it's WRONG...
1.53 bowersj2 4767: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
1.51 bowersj2 4768: # and there are TRIES LEFT:
1.79 bowersj2 4769: if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) {
1.222 bowersj2 4770: return $suppressFeedback ? ANSWER_SUBMITTED : TRIES_LEFT;
1.51 bowersj2 4771: }
1.185 bowersj2 4772: return $suppressFeedback ? ANSWER_SUBMITTED : INCORRECT; # otherwise, return orange; student can't fix this
1.51 bowersj2 4773: }
4774:
4775: # Otherwise, it's untried and open
1.53 bowersj2 4776: return OPEN;
1.224 bowersj2 4777: }
4778:
4779: sub CLOSED { return 23; }
4780: sub ERROR { return 24; }
4781:
4782: =pod
4783:
4784: B<Simple Status>
4785:
4786: Convenience method B<simpleStatus> provides a "simple status" for the resource.
4787: "Simple status" corresponds to "which icon is shown on the
4788: Navmaps". There are six "simple" statuses:
4789:
4790: =over 4
4791:
4792: =item * B<CLOSED>: The problem is currently closed. (No icon shown.)
4793:
4794: =item * B<OPEN>: The problem is open and unattempted.
4795:
4796: =item * B<CORRECT>: The problem is correct for any reason.
4797:
4798: =item * B<INCORRECT>: The problem is incorrect and can still be
4799: completed successfully.
4800:
4801: =item * B<ATTEMPTED>: The problem has been attempted, but the student
4802: does not know if they are correct. (The ellipsis icon.)
4803:
4804: =item * B<ERROR>: There is an error retrieving information about this
4805: problem.
4806:
4807: =back
4808:
4809: =cut
4810:
4811: # This hash maps the composite status to this simple status, and
4812: # can be used directly, if you like
4813: my %compositeToSimple =
4814: (
4815: NETWORK_FAILURE() => ERROR,
4816: NOTHING_SET() => CLOSED,
4817: CORRECT() => CORRECT,
1.332 albertel 4818: PARTIALLY_CORRECT() => PARTIALLY_CORRECT,
1.224 bowersj2 4819: EXCUSED() => CORRECT,
4820: PAST_DUE_NO_ANSWER() => INCORRECT,
4821: PAST_DUE_ANSWER_LATER() => INCORRECT,
4822: ANSWER_OPEN() => INCORRECT,
4823: OPEN_LATER() => CLOSED,
4824: TRIES_LEFT() => OPEN,
4825: INCORRECT() => INCORRECT,
4826: OPEN() => OPEN,
4827: ATTEMPTED() => ATTEMPTED,
4828: ANSWER_SUBMITTED() => ATTEMPTED
4829: );
4830:
4831: sub simpleStatus {
4832: my $self = shift;
4833: my $part = shift;
4834: my $status = $self->status($part);
4835: return $compositeToSimple{$status};
1.225 bowersj2 4836: }
4837:
4838: =pod
4839:
4840: B<simpleStatusCount> will return an array reference containing, in
4841: this order, the number of OPEN, CLOSED, CORRECT, INCORRECT, ATTEMPTED,
4842: and ERROR parts the given problem has.
4843:
4844: =cut
4845:
4846: # This maps the status to the slot we want to increment
4847: my %statusToSlotMap =
4848: (
4849: OPEN() => 0,
4850: CLOSED() => 1,
4851: CORRECT() => 2,
4852: INCORRECT() => 3,
4853: ATTEMPTED() => 4,
4854: ERROR() => 5
4855: );
4856:
4857: sub statusToSlot { return $statusToSlotMap{shift()}; }
4858:
4859: sub simpleStatusCount {
4860: my $self = shift;
4861:
4862: my @counts = (0, 0, 0, 0, 0, 0, 0);
4863: foreach my $part (@{$self->parts()}) {
4864: $counts[$statusToSlotMap{$self->simpleStatus($part)}]++;
4865: }
4866:
4867: return \@counts;
1.191 bowersj2 4868: }
4869:
4870: =pod
4871:
4872: B<Completable>
4873:
4874: The completable method represents the concept of I<whether the student can
4875: currently do the problem>. If the student can do the problem, which means
4876: that it is open, there are tries left, and if the problem is manually graded
4877: or the grade is suppressed via problemstatus, the student has not tried it
4878: yet, then the method returns 1. Otherwise, it returns 0, to indicate that
4879: either the student has tried it and there is no feedback, or that for
4880: some reason it is no longer completable (not open yet, successfully completed,
4881: out of tries, etc.). As an example, this is used as the filter for the
4882: "Uncompleted Homework" option for the nav maps.
4883:
4884: If this does not quite meet your needs, do not fiddle with it (unless you are
4885: fixing it to better match the student's conception of "completable" because
4886: it's broken somehow)... make a new method.
4887:
4888: =cut
4889:
4890: sub completable {
4891: my $self = shift;
4892: if (!$self->is_problem()) { return 0; }
4893: my $partCount = $self->countParts();
4894:
4895: foreach my $part (@{$self->parts()}) {
4896: if ($part eq '0' && $partCount != 1) { next; }
4897: my $status = $self->status($part);
4898: # "If any of the parts are open, or have tries left (implies open),
4899: # and it is not "attempted" (manually graded problem), it is
4900: # not "complete"
1.216 bowersj2 4901: if ($self->getCompletionStatus($part) == ATTEMPTED() ||
4902: $status == ANSWER_SUBMITTED() ) {
4903: # did this part already, as well as we can
4904: next;
4905: }
4906: if ($status == OPEN() || $status == TRIES_LEFT()) {
4907: return 1;
4908: }
1.191 bowersj2 4909: }
4910:
4911: # If all the parts were complete, so was this problem.
1.216 bowersj2 4912: return 0;
1.51 bowersj2 4913: }
4914:
4915: =pod
4916:
4917: =head2 Resource/Nav Map Navigation
4918:
4919: =over 4
4920:
1.174 albertel 4921: =item * B<getNext>():
4922:
4923: Retreive an array of the possible next resources after this
4924: one. Always returns an array, even in the one- or zero-element case.
4925:
4926: =item * B<getPrevious>():
1.85 bowersj2 4927:
1.174 albertel 4928: Retreive an array of the possible previous resources from this
4929: one. Always returns an array, even in the one- or zero-element case.
1.51 bowersj2 4930:
4931: =cut
4932:
4933: sub getNext {
4934: my $self = shift;
4935: my @branches;
4936: my $to = $self->to();
1.85 bowersj2 4937: foreach my $branch ( split(/,/, $to) ) {
1.51 bowersj2 4938: my $choice = $self->{NAV_MAP}->getById($branch);
1.342 albertel 4939: #if (!$choice->condition()) { next; }
1.51 bowersj2 4940: my $next = $choice->goesto();
4941: $next = $self->{NAV_MAP}->getById($next);
4942:
1.131 bowersj2 4943: push @branches, $next;
1.85 bowersj2 4944: }
4945: return \@branches;
4946: }
4947:
4948: sub getPrevious {
4949: my $self = shift;
4950: my @branches;
4951: my $from = $self->from();
4952: foreach my $branch ( split /,/, $from) {
4953: my $choice = $self->{NAV_MAP}->getById($branch);
4954: my $prev = $choice->comesfrom();
4955: $prev = $self->{NAV_MAP}->getById($prev);
4956:
1.131 bowersj2 4957: push @branches, $prev;
1.51 bowersj2 4958: }
4959: return \@branches;
1.131 bowersj2 4960: }
4961:
4962: sub browsePriv {
4963: my $self = shift;
4964: if (defined($self->{BROWSE_PRIV})) {
4965: return $self->{BROWSE_PRIV};
4966: }
4967:
1.311 albertel 4968: $self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre',$self->src(),
4969: $self->symb());
1.51 bowersj2 4970: }
4971:
4972: =pod
1.2 www 4973:
1.51 bowersj2 4974: =back
1.2 www 4975:
1.51 bowersj2 4976: =cut
1.2 www 4977:
1.51 bowersj2 4978: 1;
1.2 www 4979:
1.51 bowersj2 4980: __END__
1.2 www 4981:
4982:
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