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