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