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