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