Annotation of loncom/interface/lonnavmaps.pm, revision 1.527
1.481 foxr 1: # The LearningOnline Network with CAPA
1.2 www 2: # Navigate Maps Handler
1.1 www 3: #
1.527 ! raeburn 4: # $Id: lonnavmaps.pm,v 1.526 2016/11/26 01:47:04 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:
! 1691: my ($is_ssl,$cdom,$cnum);
! 1692: if ($ENV{'SERVER_PORT'} == 443) {
! 1693: $is_ssl = 1;
! 1694: }
! 1695: if ($env{'request.course.id'}) {
! 1696: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
! 1697: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
! 1698: }
1.276 albertel 1699:
1.270 albertel 1700: while (1) {
1701: if ($args->{'sort'}) {
1702: $curRes = shift(@resources);
1703: } else {
1704: $curRes = $it->next($closeAllPages);
1705: }
1706: if (!$curRes) { last; }
1707:
1.132 bowersj2 1708: # Maintain indentation level.
1709: if ($curRes == $it->BEGIN_MAP() ||
1710: $curRes == $it->BEGIN_BRANCH() ) {
1.133 bowersj2 1711: $args->{'indentLevel'}++;
1.132 bowersj2 1712: }
1713: if ($curRes == $it->END_MAP() ||
1714: $curRes == $it->END_BRANCH() ) {
1.133 bowersj2 1715: $args->{'indentLevel'}--;
1.132 bowersj2 1716: }
1717: # Notice new branches
1718: if ($curRes == $it->BEGIN_BRANCH()) {
1.133 bowersj2 1719: $args->{'isNewBranch'} = 1;
1720: }
1721:
1722: # If this isn't an actual resource, continue on
1723: if (!ref($curRes)) {
1724: next;
1.132 bowersj2 1725: }
1.133 bowersj2 1726:
1.143 bowersj2 1727: # If this has been filtered out, continue on
1728: if (!(&$filterFunc($curRes))) {
1729: $args->{'isNewBranch'} = 0; # Don't falsely remember this
1730: next;
1731: }
1.132 bowersj2 1732:
1.190 bowersj2 1733: # If this is an empty sequence and we're filtering them, continue on
1.518 raeburn 1734: $args->{'mapHidden'} = 0;
1735: if (($curRes->is_map()) && (!$curRes->{DATA}->{HAS_VISIBLE_CHILDREN})) {
1736: if ($args->{'suppressEmptySequences'}) {
1737: next;
1738: } else {
1739: my $mapname = &Apache::lonnet::declutter($curRes->src());
1740: $mapname = &Apache::lonnet::deversion($mapname);
1741: if (lc($navmap->get_mapparam(undef,$mapname,"0.hiddenresource")) eq 'yes') {
1742: if ($userCanSeeHidden) {
1743: $args->{'mapHidden'} = 1;
1744: } else {
1745: next;
1746: }
1747: }
1748: }
1.190 bowersj2 1749: }
1750:
1.153 bowersj2 1751: # If we're suppressing navmaps and this is a navmap, continue on
1752: if ($suppressNavmap && $curRes->src() =~ /^\/adm\/navmaps/) {
1753: next;
1754: }
1755:
1.191 bowersj2 1756: $args->{'counter'}++;
1757:
1.132 bowersj2 1758: # Does it have multiple parts?
1.133 bowersj2 1759: $args->{'multipart'} = 0;
1760: $args->{'condensed'} = 0;
1.132 bowersj2 1761: my @parts;
1762:
1763: # Decide what parts to show.
1.133 bowersj2 1764: if ($curRes->is_problem() && $showParts) {
1.132 bowersj2 1765: @parts = @{$curRes->parts()};
1.192 bowersj2 1766: $args->{'multipart'} = $curRes->multipart();
1.132 bowersj2 1767:
1768: if ($condenseParts) { # do the condensation
1.133 bowersj2 1769: if (!$args->{'condensed'}) {
1.132 bowersj2 1770: # Decide whether to condense based on similarity
1.192 bowersj2 1771: my $status = $curRes->status($parts[0]);
1772: my $due = $curRes->duedate($parts[0]);
1773: my $open = $curRes->opendate($parts[0]);
1.132 bowersj2 1774: my $statusAllSame = 1;
1775: my $dueAllSame = 1;
1776: my $openAllSame = 1;
1.192 bowersj2 1777: for (my $i = 1; $i < scalar(@parts); $i++) {
1.132 bowersj2 1778: if ($curRes->status($parts[$i]) != $status){
1779: $statusAllSame = 0;
1780: }
1781: if ($curRes->duedate($parts[$i]) != $due ) {
1782: $dueAllSame = 0;
1783: }
1784: if ($curRes->opendate($parts[$i]) != $open) {
1785: $openAllSame = 0;
1786: }
1787: }
1788: # $*allSame is true if all the statuses were
1789: # the same. Now, if they are all the same and
1790: # match one of the statuses to condense, or they
1791: # are all open with the same due date, or they are
1792: # all OPEN_LATER with the same open date, display the
1793: # status of the first non-zero part (to get the 'correct'
1794: # status right, since 0 is never 'correct' or 'open').
1795: if (($statusAllSame && defined($condenseStatuses{$status})) ||
1796: ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
1797: ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
1.192 bowersj2 1798: @parts = ($parts[0]);
1.133 bowersj2 1799: $args->{'condensed'} = 1;
1.132 bowersj2 1800: }
1801: }
1.198 bowersj2 1802: # Multipart problem with one part: always "condense" (happens
1803: # to match the desirable behavior)
1804: if ($curRes->countParts() == 1) {
1805: @parts = ($parts[0]);
1806: $args->{'condensed'} = 1;
1807: }
1.132 bowersj2 1808: }
1.157 bowersj2 1809: }
1.132 bowersj2 1810:
1811: # If the multipart problem was condensed, "forget" it was multipart
1812: if (scalar(@parts) == 1) {
1.133 bowersj2 1813: $args->{'multipart'} = 0;
1.192 bowersj2 1814: } else {
1815: # Add part 0 so we display it correctly.
1816: unshift @parts, '0';
1.132 bowersj2 1817: }
1.310 albertel 1818:
1819: {
1820: my ($src,$symb,$anchor,$stack);
1821: if ($args->{'sort'}) {
1822: my $it = $navmap->getIterator(undef, undef, undef, 1);
1823: while ( my $res=$it->next()) {
1824: if (ref($res) &&
1825: $res->symb() eq $curRes->symb()) { last; }
1826: }
1827: $stack=$it->getStack();
1828: } else {
1829: $stack=$it->getStack();
1830: }
1831: ($src,$symb,$anchor)=getLinkForResource($stack);
1.527 ! raeburn 1832: my $srcHasQuestion = $src =~ /\?/;
! 1833: if ($env{'request.course.id'}) {
! 1834: if (($src =~ m{^\Q/public/$cdom/$cnum/syllabus\E($|\?)}) && ($is_ssl) &&
! 1835: ($env{'course.'.$env{'request.course.id'}.'.externalsyllabus'} =~ m{^http://})) {
! 1836: $src .= ($srcHasQuestion? '&' : '?') . 'usehttp=1';
! 1837: $srcHasQuestion = 1;
! 1838: }
! 1839: }
1.310 albertel 1840: if (defined($anchor)) { $anchor='#'.$anchor; }
1841: $args->{"resourceLink"} = $src.
1.449 bisitz 1842: ($srcHasQuestion?'&':'?') .
1.384 www 1843: 'symb=' . &escape($symb).$anchor;
1.310 albertel 1844: }
1.132 bowersj2 1845: # Now, we've decided what parts to show. Loop through them and
1846: # show them.
1.192 bowersj2 1847: foreach my $part (@parts) {
1.132 bowersj2 1848: $rownum ++;
1849:
1.431 schulted 1850: $result .= &Apache::loncommon::start_data_table_row();
1.134 bowersj2 1851:
1852: # Set up some data about the parts that the cols might want
1853: my $filter = $it->{FILTER};
1.270 albertel 1854:
1.132 bowersj2 1855: # Now, display each column.
1856: foreach my $col (@$cols) {
1.139 bowersj2 1857: my $colHTML = '';
1858: if (ref($col)) {
1859: $colHTML .= &$col($curRes, $part, $args);
1860: } else {
1861: $colHTML .= &{$preparedColumns[$col]}($curRes, $part, $args);
1862: }
1.132 bowersj2 1863:
1.133 bowersj2 1864: # If this is the first column and it's time to print
1865: # the anchor, do so
1866: if ($col == $cols->[0] &&
1867: $args->{'counter'} == $args->{'currentJumpIndex'} -
1.139 bowersj2 1868: $currentJumpDelta) {
1869: # Jam the anchor after the <td> tag;
1870: # necessary for valid HTML (which Mozilla requires)
1871: $colHTML =~ s/\>/\>\<a name="curloc" \/\>/;
1.133 bowersj2 1872: $displayedJumpMarker = 1;
1873: }
1.139 bowersj2 1874: $result .= $colHTML . "\n";
1.132 bowersj2 1875: }
1.431 schulted 1876: $result .= &Apache::loncommon::end_data_table_row();
1.140 bowersj2 1877: $args->{'isNewBranch'} = 0;
1.139 bowersj2 1878: }
1.153 bowersj2 1879:
1.139 bowersj2 1880: if ($r && $rownum % 20 == 0) {
1881: $r->print($result);
1882: $result = "";
1883: $r->rflush();
1.132 bowersj2 1884: }
1.156 bowersj2 1885: } continue {
1.208 bowersj2 1886: if ($r) {
1887: # If we have the connection, make sure the user is still connected
1888: my $c = $r->connection;
1889: if ($c->aborted()) {
1890: # Who cares what we do, nobody will see it anyhow.
1891: return '';
1892: }
1893: }
1.132 bowersj2 1894: }
1.486 raeburn 1895:
1896: $result.=&Apache::loncommon::end_data_table();
1.132 bowersj2 1897:
1.134 bowersj2 1898: # Print out the part that jumps to #curloc if it exists
1.159 bowersj2 1899: # delay needed because the browser is processing the jump before
1900: # it finishes rendering, so it goes to the wrong place!
1901: # onload might be better, but this routine has no access to that.
1902: # On mozilla, the 0-millisecond timeout seems to prevent this;
1903: # it's quite likely this might fix other browsers, too, and
1904: # certainly won't hurt anything.
1.139 bowersj2 1905: if ($displayedJumpMarker) {
1.449 bisitz 1906: $result .= &Apache::lonhtmlcommon::scripttag("
1.247 albertel 1907: if (location.href.indexOf('#curloc')==-1) {
1908: setTimeout(\"location += '#curloc';\", 0)
1909: }
1.449 bisitz 1910: ");
1.134 bowersj2 1911: }
1912:
1.140 bowersj2 1913: if ($r) {
1914: $r->print($result);
1915: $result = "";
1916: $r->rflush();
1917: }
1918:
1.132 bowersj2 1919: return $result;
1920: }
1921:
1.281 albertel 1922: sub add_linkitem {
1923: my ($linkitems,$name,$cmd,$text)=@_;
1924: $$linkitems{$name}{'cmd'}=$cmd;
1925: $$linkitems{$name}{'text'}=&mt($text);
1926: }
1927:
1.430 schulted 1928: sub show_linkitems_toolbar {
1.476 raeburn 1929: my ($args,$condition) = @_;
1.478 raeburn 1930: my $result;
1.476 raeburn 1931: if (ref($args) eq 'HASH') {
1932: if (ref($args->{'linkitems'}) eq 'HASH') {
1.478 raeburn 1933: my $numlinks = scalar(keys(%{$args->{'linkitems'}}));
1934: if ($numlinks > 1) {
1935: $result = '<td>'.
1936: &Apache::loncommon::help_open_menu('Navigation Screen','Navigation_Screen',
1937: undef,'RAT').
1938: '</td>'.
1939: '<td> </td>'.
1940: '<td class="LC_middle">'.&mt('Tools:').'</td>';
1941: }
1942: $result .= '<td align="left">'."\n".
1943: '<ul id="LC_toolbar">';
1.476 raeburn 1944: my @linkorder = ('firsthomework','everything','uncompleted',
1945: 'changefolder','clearbubbles','edittoplevel');
1946: foreach my $link (@linkorder) {
1947: if (ref($args->{'linkitems'}{$link}) eq 'HASH') {
1948: if ($args->{'linkitems'}{$link}{'text'} ne '') {
1949: $args->{'linkitems'}{$link}{'cmd'}=~s/"/'/g;
1950: if ($args->{'linkitems'}{$link}{'cmd'}) {
1.478 raeburn 1951: my $link_id = 'LC_content_toolbar_'.$link;
1.476 raeburn 1952: if ($link eq 'changefolder') {
1953: if ($condition) {
1954: $link_id='LC_content_toolbar_changefolder_toggled';
1955: } else {
1956: $link_id='LC_content_toolbar_changefolder';
1957: }
1958: }
1959: $result .= '<li><a href="#" '.
1960: 'onclick="'.$args->{'linkitems'}{$link}{'cmd'}.'" '.
1961: 'id="'.$link_id.'" '.
1962: 'class="LC_toolbarItem" '.
1963: 'title="'.$args->{'linkitems'}{$link}{'text'}.'">'.
1964: '</a></li>'."\n";
1.446 raeburn 1965: }
1966: }
1967: }
1968: }
1.476 raeburn 1969: $result .= '</ul>'.
1.486 raeburn 1970: '</td>';
1.478 raeburn 1971: if (($numlinks==1) && (exists($args->{'linkitems'}{'edittoplevel'}))) {
1972: $result .= '<td><a href="'.$args->{'linkitems'}{'edittoplevel'}{'cmd'}.'">'.
1973: &mt('Content Editor').'</a></td>';
1974: }
1.476 raeburn 1975: }
1976: if ($args->{'sort_html'}) {
1977: $result .= '<td> </td><td> </td><td> </td>'.
1978: '<td align="right">'.$args->{'sort_html'}.'</td>';
1.446 raeburn 1979: }
1.430 schulted 1980: }
1.478 raeburn 1981: if ($result) {
1982: $result = "<table><tr>$result</tr></table>";
1983: }
1.430 schulted 1984: return $result;
1985: }
1986:
1.133 bowersj2 1987: 1;
1988:
1.418 jms 1989:
1990:
1991:
1992:
1993:
1994:
1995:
1996:
1.133 bowersj2 1997: package Apache::lonnavmaps::navmap;
1998:
1999: =pod
2000:
1.216 bowersj2 2001: =head1 Object: Apache::lonnavmaps::navmap
1.133 bowersj2 2002:
1.217 bowersj2 2003: =head2 Overview
1.133 bowersj2 2004:
1.217 bowersj2 2005: The navmap object's job is to provide access to the resources
2006: in the course as Apache::lonnavmaps::resource objects, and to
2007: query and manage the relationship between those resource objects.
2008:
2009: Generally, you'll use the navmap object in one of three basic ways.
2010: In order of increasing complexity and power:
2011:
2012: =over 4
2013:
1.358 albertel 2014: =item * C<$navmap-E<gt>getByX>, where X is B<Id>, B<Symb> or B<MapPc> and getResourceByUrl. This provides
1.217 bowersj2 2015: various ways to obtain resource objects, based on various identifiers.
2016: Use this when you want to request information about one object or
2017: a handful of resources you already know the identities of, from some
2018: other source. For more about Ids, Symbs, and MapPcs, see the
2019: Resource documentation. Note that Url should be a B<last resort>,
1.358 albertel 2020: not your first choice; it only really works when there is only one
1.217 bowersj2 2021: instance of the resource in the course, which only applies to
1.358 albertel 2022: maps, and even that may change in the future (see the B<getResourceByUrl>
2023: documentation for more details.)
1.217 bowersj2 2024:
2025: =item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This
2026: retrieves resources matching some criterion and returns them
2027: in a flat array, with no structure information. Use this when
2028: you are manipulating a series of resources, based on what map
2029: the are in, but do not care about branching, or exactly how
2030: the maps and resources are related. This is the most common case.
2031:
2032: =item * C<$it = $navmap-E<gt>getIterator(args)>. This allows you traverse
2033: the course's navmap in various ways without writing the traversal
2034: code yourself. See iterator documentation below. Use this when
2035: you need to know absolutely everything about the course, including
2036: branches and the precise relationship between maps and resources.
2037:
2038: =back
2039:
2040: =head2 Creation And Destruction
2041:
2042: To create a navmap object, use the following function:
1.133 bowersj2 2043:
2044: =over 4
2045:
1.221 bowersj2 2046: =item * B<Apache::lonnavmaps::navmap-E<gt>new>():
1.133 bowersj2 2047:
1.221 bowersj2 2048: Creates a new navmap object. Returns the navmap object if this is
2049: successful, or B<undef> if not.
1.174 albertel 2050:
1.216 bowersj2 2051: =back
2052:
2053: =head2 Methods
2054:
2055: =over 4
2056:
1.174 albertel 2057: =item * B<getIterator>(first, finish, filter, condition):
2058:
2059: See iterator documentation below.
1.133 bowersj2 2060:
2061: =cut
2062:
2063: use strict;
2064: use GDBM_File;
1.320 albertel 2065: use Apache::lonnet;
1.397 albertel 2066: use LONCAPA;
1.133 bowersj2 2067:
2068: sub new {
2069: # magic invocation to create a class instance
2070: my $proto = shift;
2071: my $class = ref($proto) || $proto;
2072: my $self = {};
1.501 raeburn 2073: bless($self); # So we can call change_user if necessary
1.133 bowersj2 2074:
1.453 www 2075: $self->{USERNAME} = shift || $env{'user.name'};
2076: $self->{DOMAIN} = shift || $env{'user.domain'};
1.491 raeburn 2077: $self->{CODE} = shift;
1.496 raeburn 2078: $self->{NOHIDE} = shift;
1.453 www 2079:
1.465 foxr 2080:
2081:
1.133 bowersj2 2082: # Resource cache stores navmap resources as we reference them. We generate
2083: # them on-demand so we don't pay for creating resources unless we use them.
2084: $self->{RESOURCE_CACHE} = {};
2085:
2086: # Network failure flag, if we accessed the course or user opt and
2087: # failed
2088: $self->{NETWORK_FAILURE} = 0;
2089:
1.465 foxr 2090: # We can only tie the nav hash as done below if the username/domain
2091: # match the env one. Otherwise change_user does everything we need...since we can't
1.501 raeburn 2092: # assume there are course hashes for the specific requested user:domain
2093: # Note: change_user is also called if we need the nav hash when printing CODEd
2094: # assignments or printing an exam, in which the enclosing folder for the items in
2095: # the exam has hidden set.
1.465 foxr 2096: #
1.133 bowersj2 2097:
1.501 raeburn 2098: if (($self->{USERNAME} eq $env{'user.name'}) && ($self->{DOMAIN} eq $env{'user.domain'}) &&
2099: !$self->{CODE} && !$self->{NOHIDE}) {
1.465 foxr 2100:
2101: # tie the nav hash
2102:
2103: my %navmaphash;
2104: my %parmhash;
2105: my $courseFn = $env{"request.course.fn"};
2106: if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",
2107: &GDBM_READER(), 0640))) {
2108: return undef;
2109: }
2110:
2111: if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db",
2112: &GDBM_READER(), 0640)))
2113: {
2114: untie %{$self->{PARM_HASH}};
2115: return undef;
2116: }
2117:
2118: $self->{NAV_HASH} = \%navmaphash;
2119: $self->{PARM_HASH} = \%parmhash;
2120: $self->{PARM_CACHE} = {};
2121: } else {
1.496 raeburn 2122: $self->change_user($self->{USERNAME}, $self->{DOMAIN}, $self->{CODE}, $self->{NOHIDE});
1.133 bowersj2 2123: }
1.470 foxr 2124:
1.465 foxr 2125: return $self;
2126: }
2127:
2128: #
2129: # In some instances it is useful to be able to dynamically change the
2130: # username/domain associated with a navmap (e.g. to navigate for someone
2131: # else besides the current user...if sufficiently privileged.
2132: # Parameters:
2133: # user - New user.
2134: # domain- Domain the user belongs to.
1.491 raeburn 2135: # code - Anonymous CODE in use.
1.465 foxr 2136: # Implicit inputs:
2137: #
2138: sub change_user {
2139: my $self = shift;
2140: $self->{USERNAME} = shift;
2141: $self->{DOMAIN} = shift;
1.491 raeburn 2142: $self->{CODE} = shift;
1.496 raeburn 2143: $self->{NOHIDE} = shift;
1.465 foxr 2144:
2145: # If the hashes are already tied make sure to break that bond:
2146:
2147: untie %{$self->{NAV_HASH}};
2148: untie %{$self->{PARM_HASH}};
2149:
2150: # The assumption is that we have to
2151: # use lonmap here to re-read the hash and from it reconstruct
2152: # new big and parameter hashes. An implicit assumption at this time
2153: # is that the course file is probably not created locally yet
2154: # an that we will therefore just read without tying.
2155:
2156: my ($cdom, $cnum) = split(/\_/, $env{'request.course.id'});
2157:
2158: my %big_hash;
1.496 raeburn 2159: &Apache::lonmap::loadmap($cnum, $cdom, $self->{USERNAME}, $self->{DOMAIN}, $self->{CODE}, $self->{NOHIDE}, \%big_hash);
1.465 foxr 2160: $self->{NAV_HASH} = \%big_hash;
2161:
1.470 foxr 2162:
2163:
1.514 raeburn 2164: # Now clear the parm cache and reconstruct the parm hash from the big_hash
1.465 foxr 2165: # param.xxxx keys.
2166:
2167: $self->{PARM_CACHE} = {};
1.133 bowersj2 2168:
1.465 foxr 2169: my %parm_hash = {};
1.504 raeburn 2170: foreach my $key (keys(%big_hash)) {
1.465 foxr 2171: if ($key =~ /^param\./) {
2172: my $param_key = $key;
2173: $param_key =~ s/^param\.//;
2174: $parm_hash{$param_key} = $big_hash{$key};
2175: }
1.133 bowersj2 2176: }
2177:
1.465 foxr 2178: $self->{PARM_HASH} = \%parm_hash;
2179:
1.500 raeburn 2180: }
1.133 bowersj2 2181:
1.221 bowersj2 2182: sub generate_course_user_opt {
1.133 bowersj2 2183: my $self = shift;
1.221 bowersj2 2184: if ($self->{COURSE_USER_OPT_GENERATED}) { return; }
1.133 bowersj2 2185:
1.453 www 2186: my $uname=$self->{USERNAME};
2187: my $udom=$self->{DOMAIN};
2188:
1.320 albertel 2189: my $cid=$env{'request.course.id'};
1.326 albertel 2190: my $cdom=$env{'course.'.$cid.'.domain'};
2191: my $cnum=$env{'course.'.$cid.'.num'};
1.221 bowersj2 2192:
1.133 bowersj2 2193: # ------------------------------------------------- Get coursedata (if present)
1.326 albertel 2194: my $courseopt=&Apache::lonnet::get_courseresdata($cnum,$cdom);
2195: # Check for network failure
2196: if (!ref($courseopt)) {
2197: if ( $courseopt =~ /no.such.host/i || $courseopt =~ /con_lost/i) {
1.324 albertel 2198: $self->{NETWORK_FAILURE} = 1;
1.221 bowersj2 2199: }
1.326 albertel 2200: undef($courseopt);
2201: }
1.325 albertel 2202:
1.133 bowersj2 2203: # --------------------------------------------------- Get userdata (if present)
1.325 albertel 2204:
1.326 albertel 2205: my $useropt=&Apache::lonnet::get_userresdata($uname,$udom);
2206: # Check for network failure
2207: if (!ref($useropt)) {
2208: if ( $useropt =~ /no.such.host/i || $useropt =~ /con_lost/i) {
1.324 albertel 2209: $self->{NETWORK_FAILURE} = 1;
1.221 bowersj2 2210: }
1.326 albertel 2211: undef($useropt);
1.221 bowersj2 2212: }
2213:
1.326 albertel 2214: $self->{COURSE_OPT} = $courseopt;
2215: $self->{USER_OPT} = $useropt;
2216:
1.221 bowersj2 2217: $self->{COURSE_USER_OPT_GENERATED} = 1;
2218:
2219: return;
2220: }
2221:
1.485 foxr 2222:
2223:
1.221 bowersj2 2224: sub generate_email_discuss_status {
2225: my $self = shift;
1.259 raeburn 2226: my $symb = shift;
1.221 bowersj2 2227: if ($self->{EMAIL_DISCUSS_GENERATED}) { return; }
1.133 bowersj2 2228:
1.320 albertel 2229: my $cid=$env{'request.course.id'};
1.326 albertel 2230: my $cdom=$env{'course.'.$cid.'.domain'};
2231: my $cnum=$env{'course.'.$cid.'.num'};
1.221 bowersj2 2232:
1.454 www 2233: my %emailstatus = &Apache::lonnet::dump('email_status',$self->{DOMAIN},$self->{USERNAME});
1.221 bowersj2 2234: my $logoutTime = $emailstatus{'logout'};
1.320 albertel 2235: my $courseLeaveTime = $emailstatus{'logout_'.$env{'request.course.id'}};
1.221 bowersj2 2236: $self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
2237: $courseLeaveTime : $logoutTime);
2238: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
2239: $cdom, $cnum);
1.259 raeburn 2240: my %lastread = &Apache::lonnet::dump('nohist_'.$cid.'_discuss',
1.453 www 2241: $self->{DOMAIN},$self->{USERNAME},'lastread');
1.259 raeburn 2242: my %lastreadtime = ();
1.504 raeburn 2243: foreach my $key (keys(%lastread)) {
1.394 raeburn 2244: my $shortkey = $key;
2245: $shortkey =~ s/_lastread$//;
2246: $lastreadtime{$shortkey} = $lastread{$key};
1.259 raeburn 2247: }
2248:
1.221 bowersj2 2249: my %feedback=();
2250: my %error=();
1.453 www 2251: my @keys = &Apache::lonnet::getkeys('nohist_email',$self->{DOMAIN},
2252: $self->{USERNAME});
1.221 bowersj2 2253:
1.325 albertel 2254: foreach my $msgid (@keys) {
1.295 albertel 2255: if ((!$emailstatus{$msgid}) || ($emailstatus{$msgid} eq 'new')) {
1.395 raeburn 2256: my ($sendtime,$shortsubj,$fromname,$fromdomain,$status,$fromcid,
2257: $symb,$error) = &Apache::lonmsg::unpackmsgid($msgid);
1.396 raeburn 2258: &Apache::lonenc::check_decrypt(\$symb);
2259: if (($fromcid ne '') && ($fromcid ne $cid)) {
2260: next;
2261: }
1.395 raeburn 2262: if (defined($symb)) {
2263: if (defined($error) && $error == 1) {
2264: $error{$symb}.=','.$msgid;
2265: } else {
2266: $feedback{$symb}.=','.$msgid;
2267: }
2268: } else {
2269: my $plain=
2270: &LONCAPA::unescape(&LONCAPA::unescape($msgid));
2271: if ($plain=~/ \[([^\]]+)\]\:/) {
2272: my $url=$1;
2273: if ($plain=~/\:Error \[/) {
2274: $error{$url}.=','.$msgid;
2275: } else {
2276: $feedback{$url}.=','.$msgid;
2277: }
2278: }
2279: }
1.221 bowersj2 2280: }
1.211 bowersj2 2281: }
1.221 bowersj2 2282:
1.395 raeburn 2283: #symbs of resources that have feedbacks (will be urls pre-2.3)
1.221 bowersj2 2284: $self->{FEEDBACK} = \%feedback;
1.395 raeburn 2285: #or errors (will be urls pre 2.3)
1.295 albertel 2286: $self->{ERROR_MSG} = \%error;
1.221 bowersj2 2287: $self->{DISCUSSION_TIME} = \%discussiontime;
2288: $self->{EMAIL_STATUS} = \%emailstatus;
1.259 raeburn 2289: $self->{LAST_READ} = \%lastreadtime;
1.221 bowersj2 2290:
2291: $self->{EMAIL_DISCUSS_GENERATED} = 1;
2292: }
2293:
2294: sub get_user_data {
2295: my $self = shift;
2296: if ($self->{RETRIEVED_USER_DATA}) { return; }
1.211 bowersj2 2297:
1.221 bowersj2 2298: # Retrieve performance data on problems
1.320 albertel 2299: my %student_data = Apache::lonnet::currentdump($env{'request.course.id'},
1.453 www 2300: $self->{DOMAIN},
2301: $self->{USERNAME});
1.221 bowersj2 2302: $self->{STUDENT_DATA} = \%student_data;
1.133 bowersj2 2303:
1.221 bowersj2 2304: $self->{RETRIEVED_USER_DATA} = 1;
1.133 bowersj2 2305: }
2306:
1.354 raeburn 2307: sub get_discussion_data {
2308: my $self = shift;
2309: if ($self->{RETRIEVED_DISCUSSION_DATA}) {
1.366 albertel 2310: return $self->{DISCUSSION_DATA};
1.354 raeburn 2311: }
1.366 albertel 2312:
2313: $self->generate_email_discuss_status();
2314:
1.354 raeburn 2315: my $cid=$env{'request.course.id'};
2316: my $cdom=$env{'course.'.$cid.'.domain'};
2317: my $cnum=$env{'course.'.$cid.'.num'};
2318: # Retrieve discussion data for resources in course
1.367 albertel 2319: my %discussion_data = &Apache::lonnet::dumpstore($cid,$cdom,$cnum);
1.366 albertel 2320:
2321:
1.354 raeburn 2322: $self->{DISCUSSION_DATA} = \%discussion_data;
2323: $self->{RETRIEVED_DISCUSSION_DATA} = 1;
2324: return $self->{DISCUSSION_DATA};
2325: }
2326:
2327:
1.133 bowersj2 2328: # Internal function: Takes a key to look up in the nav hash and implements internal
2329: # memory caching of that key.
2330: sub navhash {
2331: my $self = shift; my $key = shift;
2332: return $self->{NAV_HASH}->{$key};
2333: }
2334:
1.217 bowersj2 2335: =pod
2336:
2337: =item * B<courseMapDefined>(): Returns true if the course map is defined,
2338: false otherwise. Undefined course maps indicate an error somewhere in
2339: LON-CAPA, and you will not be able to proceed with using the navmap.
2340: See the B<NAV> screen for an example of using this.
2341:
2342: =cut
2343:
1.133 bowersj2 2344: # Checks to see if coursemap is defined, matching test in old lonnavmaps
2345: sub courseMapDefined {
2346: my $self = shift;
1.320 albertel 2347: my $uri = &Apache::lonnet::clutter($env{'request.course.uri'});
1.133 bowersj2 2348:
2349: my $firstres = $self->navhash("map_start_$uri");
2350: my $lastres = $self->navhash("map_finish_$uri");
2351: return $firstres && $lastres;
2352: }
2353:
2354: sub getIterator {
2355: my $self = shift;
2356: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
1.314 albertel 2357: shift, undef, shift,
2358: shift, shift);
1.133 bowersj2 2359: return $iterator;
2360: }
2361:
2362: # Private method: Does the given resource (as a symb string) have
2363: # current discussion? Returns 0 if chat/mail data not extracted.
2364: sub hasDiscussion {
2365: my $self = shift;
2366: my $symb = shift;
1.221 bowersj2 2367: $self->generate_email_discuss_status();
2368:
1.133 bowersj2 2369: if (!defined($self->{DISCUSSION_TIME})) { return 0; }
2370:
2371: #return defined($self->{DISCUSSION_TIME}->{$symb});
1.259 raeburn 2372:
1.323 albertel 2373: # backward compatibility (bulletin boards used to be 'wrapped')
2374: my $ressymb = $self->wrap_symb($symb);
1.259 raeburn 2375: if ( defined ( $self->{LAST_READ}->{$ressymb} ) ) {
2376: return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_READ}->{$ressymb};
2377: } else {
1.266 raeburn 2378: # return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_CHECK}; # v.1.1 behavior
2379: 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 2380: }
1.133 bowersj2 2381: }
2382:
1.366 albertel 2383: sub last_post_time {
2384: my $self = shift;
2385: my $symb = shift;
2386: my $ressymb = $self->wrap_symb($symb);
2387: return $self->{DISCUSSION_TIME}->{$ressymb};
2388: }
2389:
1.393 raeburn 2390: sub discussion_info {
1.366 albertel 2391: my $self = shift;
2392: my $symb = shift;
1.393 raeburn 2393: my $filter = shift;
1.366 albertel 2394:
2395: $self->get_discussion_data();
1.372 raeburn 2396:
1.366 albertel 2397: my $ressymb = $self->wrap_symb($symb);
1.372 raeburn 2398: # keys used to store bulletinboard postings use 'unwrapped' symb.
1.397 albertel 2399: my $discsymb = &escape($self->unwrap_symb($ressymb));
1.372 raeburn 2400: my $version = $self->{DISCUSSION_DATA}{'version:'.$discsymb};
1.366 albertel 2401: if (!$version) { return; }
2402:
2403: my $prevread = $self->{LAST_READ}{$ressymb};
2404:
1.393 raeburn 2405: my $count = 0;
1.366 albertel 2406: my $hiddenflag = 0;
2407: my $deletedflag = 0;
1.393 raeburn 2408: my ($hidden,$deleted,%info);
1.366 albertel 2409:
2410: for (my $id=$version; $id>0; $id--) {
1.372 raeburn 2411: my $vkeys=$self->{DISCUSSION_DATA}{$id.':keys:'.$discsymb};
1.366 albertel 2412: my @keys=split(/:/,$vkeys);
2413: if (grep(/^hidden$/ ,@keys)) {
2414: if (!$hiddenflag) {
1.372 raeburn 2415: $hidden = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':hidden'};
1.366 albertel 2416: $hiddenflag = 1;
2417: }
2418: } elsif (grep(/^deleted$/,@keys)) {
2419: if (!$deletedflag) {
1.372 raeburn 2420: $deleted = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':deleted'};
1.366 albertel 2421: $deletedflag = 1;
2422: }
2423: } else {
1.393 raeburn 2424: if (($hidden !~/\.$id\./) && ($deleted !~/\.$id\./)) {
2425: if ($filter eq 'unread') {
2426: if ($prevread >= $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'}) {
2427: next;
2428: }
2429: }
2430: $count++;
2431: $info{$count}{'subject'} =
2432: $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':subject'};
2433: $info{$count}{'id'} = $id;
2434: $info{$count}{'timestamp'} = $self->{DISCUSSION_DATA}{$id.':'.$discsymb.':timestamp'};
2435: }
1.366 albertel 2436: }
2437: }
2438: if (wantarray) {
1.393 raeburn 2439: return ($count,%info);
1.366 albertel 2440: }
1.393 raeburn 2441: return $count;
1.366 albertel 2442: }
2443:
1.321 raeburn 2444: sub wrap_symb {
1.322 albertel 2445: my $self = shift;
1.321 raeburn 2446: my $symb = shift;
1.373 albertel 2447: if ($symb =~ m-___(adm/[^/]+/[^/]+/)(\d+)(/bulletinboard)$-) {
1.322 albertel 2448: unless ($symb =~ m|adm/wrapper/adm|) {
2449: $symb = 'bulletin___'.$2.'___adm/wrapper/'.$1.$2.$3;
1.321 raeburn 2450: }
2451: }
1.322 albertel 2452: return $symb;
1.321 raeburn 2453: }
2454:
1.372 raeburn 2455: sub unwrap_symb {
2456: my $self = shift;
2457: my $ressymb = shift;
2458: my $discsymb = $ressymb;
1.373 albertel 2459: if ($ressymb =~ m-^(bulletin___\d+___)adm/wrapper/(adm/[^/]+/[^/]+/\d+/bulletinboard)$-) {
1.372 raeburn 2460: $discsymb = $1.$2;
2461: }
2462: return $discsymb;
2463: }
2464:
1.322 albertel 2465: # Private method: Does the given resource (as a symb string) have
2466: # current feedback? Returns the string in the feedback hash, which
2467: # will be false if it does not exist.
2468:
1.133 bowersj2 2469: sub getFeedback {
2470: my $self = shift;
2471: my $symb = shift;
1.395 raeburn 2472: my $source = shift;
1.133 bowersj2 2473:
1.221 bowersj2 2474: $self->generate_email_discuss_status();
2475:
1.133 bowersj2 2476: if (!defined($self->{FEEDBACK})) { return ""; }
2477:
1.395 raeburn 2478: my $feedback;
2479: if ($self->{FEEDBACK}->{$symb}) {
2480: $feedback = $self->{FEEDBACK}->{$symb};
2481: if ($self->{FEEDBACK}->{$source}) {
2482: $feedback .= ','.$self->{FEEDBACK}->{$source};
2483: }
2484: } else {
2485: if ($self->{FEEDBACK}->{$source}) {
2486: $feedback = $self->{FEEDBACK}->{$source};
2487: }
2488: }
2489: return $feedback;
1.133 bowersj2 2490: }
2491:
2492: # Private method: Get the errors for that resource (by source).
2493: sub getErrors {
2494: my $self = shift;
1.395 raeburn 2495: my $symb = shift;
1.133 bowersj2 2496: my $src = shift;
1.221 bowersj2 2497:
2498: $self->generate_email_discuss_status();
2499:
1.133 bowersj2 2500: if (!defined($self->{ERROR_MSG})) { return ""; }
1.395 raeburn 2501:
2502: my $errors;
2503: if ($self->{ERROR_MSG}->{$symb}) {
2504: $errors = $self->{ERROR_MSG}->{$symb};
2505: if ($self->{ERROR_MSG}->{$src}) {
2506: $errors .= ','.$self->{ERROR_MSG}->{$src};
2507: }
2508: } else {
2509: if ($self->{ERROR_MSG}->{$src}) {
2510: $errors = $self->{ERROR_MSG}->{$src};
2511: }
2512: }
2513: return $errors;
1.133 bowersj2 2514: }
2515:
2516: =pod
2517:
1.174 albertel 2518: =item * B<getById>(id):
2519:
2520: Based on the ID of the resource (1.1, 3.2, etc.), get a resource
2521: object for that resource. This method, or other methods that use it
2522: (as in the resource object) is the only proper way to obtain a
2523: resource object.
1.133 bowersj2 2524:
1.194 bowersj2 2525: =item * B<getBySymb>(symb):
2526:
2527: Based on the symb of the resource, get a resource object for that
2528: resource. This is one of the proper ways to get a resource object.
2529:
1.448 raeburn 2530: =item * B<getByMapPc>(map_pc):
1.194 bowersj2 2531:
2532: Based on the map_pc of the resource, get a resource object for
2533: the given map. This is one of the proper ways to get a resource object.
2534:
1.133 bowersj2 2535: =cut
2536:
2537: # The strategy here is to cache the resource objects, and only construct them
2538: # as we use them. The real point is to prevent reading any more from the tied
1.398 banghart 2539: # hash than we have to, which should hopefully alleviate speed problems.
1.133 bowersj2 2540:
2541: sub getById {
2542: my $self = shift;
2543: my $id = shift;
2544:
2545: if (defined ($self->{RESOURCE_CACHE}->{$id}))
2546: {
2547: return $self->{RESOURCE_CACHE}->{$id};
2548: }
2549:
2550: # resource handles inserting itself into cache.
2551: # Not clear why the quotes are necessary, but as of this
2552: # writing it doesn't work without them.
2553: return "Apache::lonnavmaps::resource"->new($self, $id);
1.132 bowersj2 2554: }
1.133 bowersj2 2555:
1.172 bowersj2 2556: sub getBySymb {
2557: my $self = shift;
2558: my $symb = shift;
1.277 matthew 2559:
1.228 albertel 2560: my ($mapUrl, $id, $filename) = &Apache::lonnet::decode_symb($symb);
1.172 bowersj2 2561: my $map = $self->getResourceByUrl($mapUrl);
1.277 matthew 2562: my $returnvalue = undef;
2563: if (ref($map)) {
2564: $returnvalue = $self->getById($map->map_pc() .'.'.$id);
2565: }
2566: return $returnvalue;
1.194 bowersj2 2567: }
2568:
2569: sub getByMapPc {
2570: my $self = shift;
2571: my $map_pc = shift;
2572: my $map_id = $self->{NAV_HASH}->{'map_id_' . $map_pc};
2573: $map_id = $self->{NAV_HASH}->{'ids_' . $map_id};
2574: return $self->getById($map_id);
1.172 bowersj2 2575: }
2576:
1.133 bowersj2 2577: =pod
2578:
1.174 albertel 2579: =item * B<firstResource>():
2580:
2581: Returns a resource object reference corresponding to the first
2582: resource in the navmap.
1.133 bowersj2 2583:
2584: =cut
2585:
2586: sub firstResource {
2587: my $self = shift;
2588: my $firstResource = $self->navhash('map_start_' .
1.320 albertel 2589: &Apache::lonnet::clutter($env{'request.course.uri'}));
1.133 bowersj2 2590: return $self->getById($firstResource);
1.132 bowersj2 2591: }
1.133 bowersj2 2592:
2593: =pod
2594:
1.174 albertel 2595: =item * B<finishResource>():
2596:
2597: Returns a resource object reference corresponding to the last resource
2598: in the navmap.
1.133 bowersj2 2599:
2600: =cut
2601:
2602: sub finishResource {
2603: my $self = shift;
2604: my $firstResource = $self->navhash('map_finish_' .
1.320 albertel 2605: &Apache::lonnet::clutter($env{'request.course.uri'}));
1.133 bowersj2 2606: return $self->getById($firstResource);
1.132 bowersj2 2607: }
1.133 bowersj2 2608:
2609: # Parmval reads the parm hash and cascades the lookups. parmval_real does
2610: # the actual lookup; parmval caches the results.
2611: sub parmval {
2612: my $self = shift;
1.399 albertel 2613: my ($what,$symb,$recurse)=@_;
1.133 bowersj2 2614: my $hashkey = $what."|||".$symb;
1.459 foxr 2615: my $cache = $self->{PARM_CACHE};
1.133 bowersj2 2616: if (defined($self->{PARM_CACHE}->{$hashkey})) {
1.411 raeburn 2617: if (ref($self->{PARM_CACHE}->{$hashkey}) eq 'ARRAY') {
2618: if (defined($self->{PARM_CACHE}->{$hashkey}->[0])) {
2619: if (wantarray) {
2620: return @{$self->{PARM_CACHE}->{$hashkey}};
2621: } else {
2622: return $self->{PARM_CACHE}->{$hashkey}->[0];
2623: }
2624: }
2625: } else {
2626: return $self->{PARM_CACHE}->{$hashkey};
2627: }
1.133 bowersj2 2628: }
1.515 raeburn 2629:
1.399 albertel 2630: my $result = $self->parmval_real($what, $symb, $recurse);
1.133 bowersj2 2631: $self->{PARM_CACHE}->{$hashkey} = $result;
1.405 albertel 2632: if (wantarray) {
1.411 raeburn 2633: return @{$result};
1.405 albertel 2634: }
2635: return $result->[0];
1.132 bowersj2 2636: }
2637:
1.485 foxr 2638:
1.133 bowersj2 2639: sub parmval_real {
2640: my $self = shift;
1.219 albertel 2641: my ($what,$symb,$recurse) = @_;
1.133 bowersj2 2642:
1.485 foxr 2643:
1.221 bowersj2 2644: # Make sure the {USER_OPT} and {COURSE_OPT} hashes are populated
2645: $self->generate_course_user_opt();
2646:
1.320 albertel 2647: my $cid=$env{'request.course.id'};
2648: my $csec=$env{'request.course.sec'};
1.350 raeburn 2649: my $cgroup='';
2650: my @cgrps=split(/:/,$env{'request.course.groups'});
2651: if (@cgrps > 0) {
2652: @cgrps = sort(@cgrps);
2653: $cgroup = $cgrps[0];
2654: }
1.453 www 2655: my $uname=$self->{USERNAME};
2656: my $udom=$self->{DOMAIN};
1.133 bowersj2 2657:
1.405 albertel 2658: unless ($symb) { return ['']; }
1.133 bowersj2 2659: my $result='';
2660:
1.226 www 2661: my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
1.383 albertel 2662: $mapname = &Apache::lonnet::deversion($mapname);
1.515 raeburn 2663: my ($recursed,@recurseup);
2664:
1.133 bowersj2 2665: # ----------------------------------------------------- Cascading lookup scheme
2666: my $rwhat=$what;
2667: $what=~s/^parameter\_//;
2668: $what=~s/\_/\./;
2669:
2670: my $symbparm=$symb.'.'.$what;
1.515 raeburn 2671: my $recurseparm=$mapname.'___(rec).'.$what;
1.133 bowersj2 2672: my $mapparm=$mapname.'___(all).'.$what;
1.325 albertel 2673: my $usercourseprefix=$cid;
1.515 raeburn 2674:
1.485 foxr 2675:
2676:
1.350 raeburn 2677: my $grplevel=$usercourseprefix.'.['.$cgroup.'].'.$what;
2678: my $grplevelr=$usercourseprefix.'.['.$cgroup.'].'.$symbparm;
1.515 raeburn 2679: my $grpleveli=$usercourseprefix.'.['.$cgroup.'].'.$recurseparm;
1.350 raeburn 2680: my $grplevelm=$usercourseprefix.'.['.$cgroup.'].'.$mapparm;
2681:
1.485 foxr 2682:
1.133 bowersj2 2683: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
2684: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
1.515 raeburn 2685: my $secleveli=$usercourseprefix.'.['.$csec.'].'.$recurseparm;
1.133 bowersj2 2686: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
2687:
1.485 foxr 2688:
1.133 bowersj2 2689: my $courselevel= $usercourseprefix.'.'.$what;
2690: my $courselevelr=$usercourseprefix.'.'.$symbparm;
1.515 raeburn 2691: my $courseleveli=$usercourseprefix.'.'.$recurseparm;
1.133 bowersj2 2692: my $courselevelm=$usercourseprefix.'.'.$mapparm;
2693:
1.485 foxr 2694:
1.133 bowersj2 2695: my $useropt = $self->{USER_OPT};
2696: my $courseopt = $self->{COURSE_OPT};
2697: my $parmhash = $self->{PARM_HASH};
2698:
2699: # ---------------------------------------------------------- first, check user
2700: if ($uname and defined($useropt)) {
1.405 albertel 2701: if (defined($$useropt{$courselevelr})) { return [$$useropt{$courselevelr},'resource']; }
2702: if (defined($$useropt{$courselevelm})) { return [$$useropt{$courselevelm},'map']; }
1.515 raeburn 2703: if (defined($$useropt{$courseleveli})) { return [$$useropt{$courseleveli},'map']; }
2704: unless ($recursed) {
2705: @recurseup = $self->recurseup_maps($mapname);
2706: $recursed = 1;
2707: }
2708: foreach my $item (@recurseup) {
2709: my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;
1.526 raeburn 2710: if (defined($$useropt{$norecursechk})) {
2711: if ($what =~ /\.(encrypturl|hiddenresource)$/) {
2712: return [$$useropt{$norecursechk},'map'];
2713: } else {
2714: last;
2715: }
2716: }
1.515 raeburn 2717: my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;
2718: if (defined($$useropt{$recursechk})) { return [$$useropt{$recursechk},'map']; }
2719: }
1.405 albertel 2720: if (defined($$useropt{$courselevel})) { return [$$useropt{$courselevel},'course']; }
1.133 bowersj2 2721: }
2722:
2723: # ------------------------------------------------------- second, check course
1.350 raeburn 2724: if ($cgroup ne '' and defined($courseopt)) {
1.405 albertel 2725: if (defined($$courseopt{$grplevelr})) { return [$$courseopt{$grplevelr},'resource']; }
2726: if (defined($$courseopt{$grplevelm})) { return [$$courseopt{$grplevelm},'map']; }
1.515 raeburn 2727: if (defined($$courseopt{$grpleveli})) { return [$$courseopt{$grpleveli},'map']; }
2728: unless ($recursed) {
2729: @recurseup = $self->recurseup_maps($mapname);
2730: $recursed = 1;
2731: }
2732: foreach my $item (@recurseup) {
2733: my $norecursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(all).'.$what;
1.526 raeburn 2734: if (defined($$courseopt{$norecursechk})) {
2735: if ($what =~ /\.(encrypturl|hiddenresource)$/) {
2736: return [$$courseopt{$norecursechk},'map'];
2737: } else {
2738: last;
2739: }
2740: }
1.515 raeburn 2741: my $recursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(rec).'.$what;
2742: if (defined($$courseopt{$recursechk})) { return [$$courseopt{$recursechk},'map']; }
2743: }
1.405 albertel 2744: if (defined($$courseopt{$grplevel})) { return [$$courseopt{$grplevel},'course']; }
1.350 raeburn 2745: }
2746:
1.515 raeburn 2747: if ($csec ne '' and defined($courseopt)) {
1.405 albertel 2748: if (defined($$courseopt{$seclevelr})) { return [$$courseopt{$seclevelr},'resource']; }
2749: if (defined($$courseopt{$seclevelm})) { return [$$courseopt{$seclevelm},'map']; }
1.515 raeburn 2750: if (defined($$courseopt{$secleveli})) { return [$$courseopt{$secleveli},'map']; }
2751: unless ($recursed) {
2752: @recurseup = $self->recurseup_maps($mapname);
2753: $recursed = 1;
2754: }
2755: foreach my $item (@recurseup) {
2756: my $norecursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(all).'.$what;
1.526 raeburn 2757: if (defined($$courseopt{$norecursechk})) {
2758: if ($what =~ /\.(encrypturl|hiddenresource)$/) {
2759: return [$$courseopt{$norecursechk},'map'];
2760: } else {
2761: last;
2762: }
2763: }
1.515 raeburn 2764: my $recursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(rec).'.$what;
2765: if (defined($$courseopt{$recursechk})) { return [$$courseopt{$recursechk},'map']; }
2766: }
1.405 albertel 2767: if (defined($$courseopt{$seclevel})) { return [$$courseopt{$seclevel},'course']; }
1.133 bowersj2 2768: }
2769:
2770: if (defined($courseopt)) {
1.405 albertel 2771: if (defined($$courseopt{$courselevelr})) { return [$$courseopt{$courselevelr},'resource']; }
1.133 bowersj2 2772: }
2773:
2774: # ----------------------------------------------------- third, check map parms
2775:
2776: my $thisparm=$$parmhash{$symbparm};
1.405 albertel 2777: if (defined($thisparm)) { return [$thisparm,'map']; }
1.133 bowersj2 2778:
2779: # ----------------------------------------------------- fourth , check default
2780:
1.246 albertel 2781: my $meta_rwhat=$rwhat;
2782: $meta_rwhat=~s/\./_/g;
2783: my $default=&Apache::lonnet::metadata($fn,$meta_rwhat);
1.405 albertel 2784: if (defined($default)) { return [$default,'resource']}
1.246 albertel 2785: $default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat);
1.405 albertel 2786: if (defined($default)) { return [$default,'resource']}
1.315 albertel 2787: # --------------------------------------------------- fifth, check more course
2788: if (defined($courseopt)) {
1.405 albertel 2789: if (defined($$courseopt{$courselevelm})) { return [$$courseopt{$courselevelm},'map']; }
1.515 raeburn 2790: if (defined($$courseopt{$courseleveli})) { return [$$courseopt{$courseleveli},'map']; }
2791: unless ($recursed) {
2792: @recurseup = $self->recurseup_maps($mapname);
2793: $recursed = 1;
2794: }
2795: foreach my $item (@recurseup) {
2796: my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;
1.526 raeburn 2797: if (defined($$courseopt{$norecursechk})) {
2798: if ($what =~ /\.(encrypturl|hiddenresource)$/) {
2799: return [$$courseopt{$norecursechk},'map'];
2800: } else {
2801: last;
2802: }
2803: }
1.515 raeburn 2804: my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;
2805: if (defined($$courseopt{$recursechk})) {
2806: return [$$courseopt{$recursechk},'map'];
2807: }
2808: }
1.405 albertel 2809: if (defined($$courseopt{$courselevel})) {
2810: my $ret = [$$courseopt{$courselevel},'course'];
2811: return $ret;
2812: }
1.315 albertel 2813: }
2814: # --------------------------------------------------- sixth , cascade up parts
1.133 bowersj2 2815:
2816: my ($space,@qualifier)=split(/\./,$rwhat);
2817: my $qualifier=join('.',@qualifier);
2818: unless ($space eq '0') {
1.160 albertel 2819: my @parts=split(/_/,$space);
2820: my $id=pop(@parts);
2821: my $part=join('_',@parts);
2822: if ($part eq '') { $part='0'; }
1.405 albertel 2823: my @partgeneral=$self->parmval($part.".$qualifier",$symb,1);
2824: if (defined($partgeneral[0])) { return \@partgeneral; }
1.133 bowersj2 2825: }
1.405 albertel 2826: if ($recurse) { return []; }
1.399 albertel 2827: my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$rwhat);
1.405 albertel 2828: if (defined($pack_def)) { return [$pack_def,'resource']; }
2829: return [''];
1.145 bowersj2 2830: }
1.515 raeburn 2831:
2832: sub recurseup_maps {
2833: my ($self,$mapname) = @_;
2834: my @recurseup;
1.517 raeburn 2835: if ($mapname) {
1.519 raeburn 2836: my $res = $self->getResourceByUrl($mapname);
2837: if (ref($res)) {
2838: my @pcs = split(/,/,$res->map_hierarchy());
2839: shift(@pcs);
2840: if (@pcs) {
2841: @recurseup = map { &Apache::lonnet::declutter($self->getByMapPc($_)->src()); } reverse(@pcs);
2842: }
1.517 raeburn 2843: }
1.515 raeburn 2844: }
2845: return @recurseup;
2846: }
2847:
1.485 foxr 2848: #
2849: # Determines the open/close dates for printing a map that
2850: # encloses a resource.
2851: #
2852: sub map_printdates {
2853: my ($self, $res, $part) = @_;
2854:
2855:
2856:
2857:
2858:
1.518 raeburn 2859: my $opendate = $self->get_mapparam($res->symb(),'',"$part.printstartdate");
2860: my $closedate= $self->get_mapparam($res->symb(),'',"$part.printenddate");
1.485 foxr 2861:
2862:
2863: return ($opendate, $closedate);
2864: }
2865:
2866: sub get_mapparam {
1.518 raeburn 2867: my ($self, $symb, $mapname, $what) = @_;
1.485 foxr 2868:
2869: # Ensure the course option hash is populated:
2870:
2871: $self->generate_course_user_opt();
2872:
2873: # Get the course id and section if there is one.
2874:
2875: my $cid=$env{'request.course.id'};
2876: my $csec=$env{'request.course.sec'};
2877: my $cgroup='';
2878: my @cgrps=split(/:/,$env{'request.course.groups'});
2879: if (@cgrps > 0) {
2880: @cgrps = sort(@cgrps);
2881: $cgroup = $cgrps[0];
2882: }
2883: my $uname=$self->{USERNAME};
2884: my $udom=$self->{DOMAIN};
2885:
1.518 raeburn 2886: unless ($symb || $mapname) { return; }
1.485 foxr 2887: my $result='';
1.516 raeburn 2888: my ($recursed,@recurseup);
1.485 foxr 2889:
2890:
2891: # Figure out which map we are in.
2892:
1.518 raeburn 2893: if ($symb && !$mapname) {
2894: my ($id,$fn);
2895: ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
2896: $mapname = &Apache::lonnet::deversion($mapname);
2897: }
1.485 foxr 2898:
2899:
2900: my $rwhat=$what;
2901: $what=~s/^parameter\_//;
2902: $what=~s/\_/\./;
2903:
2904: # Build the hash keys for the lookup:
2905:
2906: my $mapparm=$mapname.'___(all).'.$what;
1.515 raeburn 2907: my $recurseparm=$mapname.'___(rec).'.$what;
1.485 foxr 2908: my $usercourseprefix=$cid;
2909:
2910:
1.515 raeburn 2911: my $grplevelm = "$usercourseprefix.[$cgroup].$mapparm";
2912: my $seclevelm = "$usercourseprefix.[$csec].$mapparm";
2913: my $courselevelm = "$usercourseprefix.$mapparm";
2914:
2915: my $grpleveli = "$usercourseprefix.[$cgroup].$recurseparm";
2916: my $secleveli = "$usercourseprefix.[$csec].$recurseparm";
2917: my $courseleveli = "$usercourseprefix.$recurseparm";
1.485 foxr 2918:
2919: # Get handy references to the hashes we need in $self:
2920:
2921: my $useropt = $self->{USER_OPT};
2922: my $courseopt = $self->{COURSE_OPT};
2923: my $parmhash = $self->{PARM_HASH};
2924:
2925: # Check per user
2926:
2927:
2928:
2929: if ($uname and defined($useropt)) {
1.515 raeburn 2930: if (defined($$useropt{$courselevelm})) {
2931: return $$useropt{$courselevelm};
1.485 foxr 2932: }
1.515 raeburn 2933: if (defined($$useropt{$courseleveli})) {
2934: return $$useropt{$courseleveli};
2935: }
1.516 raeburn 2936: unless ($recursed) {
2937: @recurseup = $self->recurseup_maps($mapname);
2938: $recursed = 1;
2939: }
2940: foreach my $item (@recurseup) {
2941: my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;
1.526 raeburn 2942: if (defined($$useropt{$norecursechk})) {
2943: if ($what =~ /\.(encrypturl|hiddenresource)$/) {
2944: return $$useropt{$norecursechk};
2945: } else {
2946: last;
2947: }
2948: }
1.516 raeburn 2949: my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;
2950: if (defined($$useropt{$recursechk})) {
2951: return $$useropt{$recursechk};
2952: }
2953: }
1.485 foxr 2954: }
2955:
2956: # Check course -- group
2957:
2958:
2959:
2960: if ($cgroup ne '' and defined ($courseopt)) {
1.515 raeburn 2961: if (defined($$courseopt{$grplevelm})) {
2962: return $$courseopt{$grplevelm};
1.485 foxr 2963: }
1.515 raeburn 2964: if (defined($$courseopt{$grpleveli})) {
2965: return $$courseopt{$grpleveli};
2966: }
1.516 raeburn 2967: unless ($recursed) {
2968: @recurseup = $self->recurseup_maps($mapname);
2969: $recursed = 1;
2970: }
2971: foreach my $item (@recurseup) {
2972: my $norecursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(all).'.$what;
1.526 raeburn 2973: if (defined($$courseopt{$norecursechk})) {
2974: if ($what =~ /\.(encrypturl|hiddenresource)$/) {
2975: return $$courseopt{$norecursechk};
2976: } else {
2977: last;
2978: }
2979: }
1.516 raeburn 2980: my $recursechk=$usercourseprefix.'.['.$cgroup.'].'.$item.'___(rec).'.$what;
2981: if (defined($$courseopt{$recursechk})) {
2982: return $$courseopt{$recursechk};
2983: }
2984: }
1.485 foxr 2985: }
2986:
2987: # Check course -- section
2988:
2989:
1.516 raeburn 2990: if ($csec ne '' and defined($courseopt)) {
1.515 raeburn 2991: if (defined($$courseopt{$seclevelm})) {
2992: return $$courseopt{$seclevelm};
1.485 foxr 2993: }
1.515 raeburn 2994: if (defined($$courseopt{$secleveli})) {
2995: return $$courseopt{$secleveli};
2996: }
1.516 raeburn 2997: unless ($recursed) {
2998: @recurseup = $self->recurseup_maps($mapname);
2999: $recursed = 1;
3000: }
3001: foreach my $item (@recurseup) {
3002: my $norecursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(all).'.$what;
1.526 raeburn 3003: if (defined($$courseopt{$norecursechk})) {
3004: if ($what =~ /\.(encrypturl|hiddenresource)$/) {
3005: return $$courseopt{$norecursechk};
3006: } else {
3007: last;
3008: }
3009: }
1.516 raeburn 3010: my $recursechk=$usercourseprefix.'.['.$csec.'].'.$item.'___(rec).'.$what;
3011: if (defined($$courseopt{$recursechk})) {
3012: return $$courseopt{$recursechk};
3013: }
3014: }
1.485 foxr 3015: }
3016: # Check the map parameters themselves:
3017:
1.518 raeburn 3018: if ($symb) {
3019: my $symbparm=$symb.'.'.$what;
3020: my $thisparm = $$parmhash{$symbparm};
3021: if (defined($thisparm)) {
3022: return $thisparm;
3023: }
1.485 foxr 3024: }
3025:
3026:
3027: # Additional course parameters:
3028:
3029: if (defined($courseopt)) {
1.515 raeburn 3030: if (defined($$courseopt{$courselevelm})) {
3031: return $$courseopt{$courselevelm};
1.485 foxr 3032: }
1.516 raeburn 3033: unless ($recursed) {
3034: @recurseup = $self->recurseup_maps($mapname);
3035: $recursed = 1;
3036: }
3037: if (@recurseup) {
3038: foreach my $item (@recurseup) {
3039: my $norecursechk=$usercourseprefix.'.'.$item.'___(all).'.$what;
1.526 raeburn 3040: if (defined($$courseopt{$norecursechk})) {
3041: if ($what =~ /\.(encrypturl|hiddenresource)$/) {
3042: return $$courseopt{$norecursechk};
3043: } else {
3044: last;
3045: }
3046: }
1.516 raeburn 3047: my $recursechk=$usercourseprefix.'.'.$item.'___(rec).'.$what;
3048: if (defined($$courseopt{$recursechk})) {
3049: return $$courseopt{$recursechk};
3050: }
3051: }
3052: }
1.485 foxr 3053: }
1.516 raeburn 3054: return undef; # Undefined if we got here.
1.485 foxr 3055: }
3056:
3057: sub course_printdates {
3058: my ($self, $symb, $part) = @_;
3059:
3060:
3061: my $opendate = $self->getcourseparam($symb, $part . '.printstartdate');
3062: my $closedate = $self->getcourseparam($symb, $part . '.printenddate');
3063: return ($opendate, $closedate);
3064:
3065: }
3066:
3067: sub getcourseparam {
3068: my ($self, $symb, $what) = @_;
3069:
3070: $self->generate_course_user_opt(); # If necessary populate the hashes.
3071:
3072: my $uname = $self->{USERNAME};
3073: my $udom = $self->{DOMAIN};
3074:
3075: # Course, section, group ids come from the env:
3076:
3077: my $cid = $env{'request.course.id'};
3078: my $csec = $env{'request.course.sec'};
3079: my $cgroup = ''; # Assume no group
3080:
3081: my @cgroups = split(/:/, $env{'request.course.groups'});
3082: if(@cgroups > 0) {
3083: @cgroups = sort(@cgroups);
3084: $cgroup = $cgroups[0]; # There is a course group.
3085: }
3086: my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
3087: $mapname = &Apache::lonnet::deversion($mapname);
3088:
3089: #
3090: # Make the various lookup keys:
3091: #
3092:
3093: $what=~s/^parameter\_//;
3094: $what=~s/\_/\./;
3095:
3096: # Local refs to the hashes we're going to look at:
3097:
3098: my $useropt = $self->{USER_OPT};
3099: my $courseopt = $self->{COURSE_OPT};
3100:
3101: #
3102: # We want the course level stuff from the way
3103: # parmval_real operates
1.513 raeburn 3104: # TODO: Factor some of this stuff out of
1.485 foxr 3105: # both parmval_real and here
3106: #
3107: my $courselevel = $cid . '.' . $what;
3108: my $grplevel = $cid . '.[' . $cgroup . ']' . $what;
3109: my $seclevel = $cid . '.[' . $csec . ']' . $what;
3110:
3111:
3112: # Try for the user's course level option:
3113:
3114: if ($uname and defined($useropt)) {
3115: if (defined($$useropt{$courselevel})) {
3116: return $$useropt{$courselevel};
3117: }
3118: }
3119: # Try for the group's course level option:
3120:
1.513 raeburn 3121: if ($cgroup ne '' and defined($courseopt)) {
1.485 foxr 3122: if (defined($$courseopt{$grplevel})) {
3123: return $$courseopt{$grplevel};
3124: }
3125: }
3126:
3127: # Try for section level parameters:
3128:
1.513 raeburn 3129: if ($csec ne '' and defined($courseopt)) {
1.485 foxr 3130: if (defined($$courseopt{$seclevel})) {
3131: return $$courseopt{$seclevel};
3132: }
3133: }
1.513 raeburn 3134: # Try for 'additional' course parameters:
1.485 foxr 3135:
3136: if (defined($courseopt)) {
3137: if (defined($$courseopt{$courselevel})) {
3138: return $$courseopt{$courselevel};
3139: }
3140: }
3141: return undef;
3142:
3143: }
3144:
1.145 bowersj2 3145:
1.174 albertel 3146: =pod
1.145 bowersj2 3147:
1.352 raeburn 3148: =item * B<getResourceByUrl>(url,multiple):
1.145 bowersj2 3149:
1.352 raeburn 3150: Retrieves a resource object by URL of the resource, unless the optional
1.398 banghart 3151: multiple parameter is included in which case an array of resource
1.352 raeburn 3152: objects is returned. If passed a resource object, it will simply return
3153: it, so it is safe to use this method in code like
3154: "$res = $navmap->getResourceByUrl($res)"
3155: if you're not sure if $res is already an object, or just a URL. If the
3156: resource appears multiple times in the course, only the first instance
3157: will be returned (useful for maps), unless the multiple parameter has
3158: been included, in which case all instances are returned in an array.
1.174 albertel 3159:
1.505 raeburn 3160: =item * B<retrieveResources>(map, filterFunc, recursive, bailout, showall, noblockcheck):
1.174 albertel 3161:
3162: The map is a specification of a map to retreive the resources from,
3163: either as a url or as an object. The filterFunc is a reference to a
3164: function that takes a resource object as its one argument and returns
3165: true if the resource should be included, or false if it should not
3166: be. If recursive is true, the map will be recursively examined,
3167: otherwise it will not be. If bailout is true, the function will return
1.314 albertel 3168: as soon as it finds a resource, if false it will finish. If showall is
1.505 raeburn 3169: true it will not hide maps that contain nothing but one other map. The
3170: noblockcheck arg is propagated to become the sixth arg in the call to
3171: lonnet::allowed when checking a resource's availability during collection
3172: of resources using the iterator. noblockcheck needs to be true if
3173: retrieveResources() was called by a routine that itself was called by
3174: lonnet::allowed, in order to avoid recursion. By default the map
3175: is the top-level map of the course, filterFunc is a function that
3176: always returns 1, recursive is true, bailout is false, showall is
3177: false. The resources will be returned in a list containing the
3178: resource objects for the corresponding resources, with B<no structure
3179: information> in the list; regardless of branching, recursion, etc.,
3180: it will be a flat list.
1.174 albertel 3181:
3182: Thus, this is suitable for cases where you don't want the structure,
3183: just a list of all resources. It is also suitable for finding out how
3184: many resources match a given description; for this use, if all you
3185: want to know is if I<any> resources match the description, the bailout
3186: parameter will allow you to avoid potentially expensive enumeration of
3187: all matching resources.
1.145 bowersj2 3188:
1.318 albertel 3189: =item * B<hasResource>(map, filterFunc, recursive, showall):
1.145 bowersj2 3190:
1.398 banghart 3191: Convenience method for
1.146 bowersj2 3192:
1.318 albertel 3193: scalar(retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0
1.146 bowersj2 3194:
1.174 albertel 3195: which will tell whether the map has resources matching the description
3196: in the filter function.
1.146 bowersj2 3197:
1.352 raeburn 3198: =item * B<usedVersion>(url):
3199:
3200: Retrieves version infomation for a url. Returns the version (a number, or
3201: the string "mostrecent") for resources which have version information in
3202: the big hash.
1.448 raeburn 3203:
1.145 bowersj2 3204: =cut
3205:
1.277 matthew 3206:
1.145 bowersj2 3207: sub getResourceByUrl {
3208: my $self = shift;
3209: my $resUrl = shift;
1.352 raeburn 3210: my $multiple = shift;
1.145 bowersj2 3211:
3212: if (ref($resUrl)) { return $resUrl; }
3213:
3214: $resUrl = &Apache::lonnet::clutter($resUrl);
3215: my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl};
1.352 raeburn 3216: if (!$resId) { return ''; }
3217: if ($multiple) {
3218: my @resources = ();
3219: my @resIds = split (/,/, $resId);
3220: foreach my $id (@resIds) {
1.353 raeburn 3221: my $resourceId = $self->getById($id);
3222: if ($resourceId) {
3223: push(@resources,$resourceId);
1.352 raeburn 3224: }
3225: }
3226: return @resources;
3227: } else {
3228: if ($resId =~ /,/) {
3229: $resId = (split (/,/, $resId))[0];
3230: }
3231: return $self->getById($resId);
1.145 bowersj2 3232: }
3233: }
3234:
3235: sub retrieveResources {
3236: my $self = shift;
3237: my $map = shift;
3238: my $filterFunc = shift;
3239: if (!defined ($filterFunc)) {
3240: $filterFunc = sub {return 1;};
3241: }
3242: my $recursive = shift;
3243: if (!defined($recursive)) { $recursive = 1; }
3244: my $bailout = shift;
3245: if (!defined($bailout)) { $bailout = 0; }
1.314 albertel 3246: my $showall = shift;
1.506 raeburn 3247: my $noblockcheck = shift;
1.145 bowersj2 3248: # Create the necessary iterator.
3249: if (!ref($map)) { # assume it's a url of a map.
1.172 bowersj2 3250: $map = $self->getResourceByUrl($map);
1.145 bowersj2 3251: }
3252:
1.213 bowersj2 3253: # If nothing was passed, assume top-level map
3254: if (!$map) {
3255: $map = $self->getById('0.0');
3256: }
3257:
1.145 bowersj2 3258: # Check the map's validity.
1.213 bowersj2 3259: if (!$map->is_map()) {
1.145 bowersj2 3260: # Oh, to throw an exception.... how I'd love that!
3261: return ();
3262: }
3263:
1.146 bowersj2 3264: # Get an iterator.
3265: my $it = $self->getIterator($map->map_start(), $map->map_finish(),
1.314 albertel 3266: undef, $recursive, $showall);
1.146 bowersj2 3267:
3268: my @resources = ();
3269:
1.400 albertel 3270: if (&$filterFunc($map)) {
3271: push(@resources, $map);
3272: }
3273:
1.146 bowersj2 3274: # Run down the iterator and collect the resources.
1.222 bowersj2 3275: my $curRes;
3276:
1.505 raeburn 3277: while ($curRes = $it->next(undef,$noblockcheck)) {
1.146 bowersj2 3278: if (ref($curRes)) {
3279: if (!&$filterFunc($curRes)) {
3280: next;
3281: }
3282:
1.400 albertel 3283: push(@resources, $curRes);
1.146 bowersj2 3284:
3285: if ($bailout) {
3286: return @resources;
3287: }
3288: }
3289:
3290: }
3291:
3292: return @resources;
3293: }
3294:
3295: sub hasResource {
3296: my $self = shift;
3297: my $map = shift;
3298: my $filterFunc = shift;
3299: my $recursive = shift;
1.318 albertel 3300: my $showall = shift;
1.146 bowersj2 3301:
1.318 albertel 3302: return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0;
1.133 bowersj2 3303: }
1.51 bowersj2 3304:
1.352 raeburn 3305: sub usedVersion {
3306: my $self = shift;
3307: my $linkurl = shift;
3308: return $self->navhash("version_$linkurl");
3309: }
3310:
1.51 bowersj2 3311: 1;
3312:
3313: package Apache::lonnavmaps::iterator;
1.365 albertel 3314: use Scalar::Util qw(weaken);
1.320 albertel 3315: use Apache::lonnet;
3316:
1.51 bowersj2 3317: =pod
3318:
3319: =back
3320:
1.174 albertel 3321: =head1 Object: navmap Iterator
1.51 bowersj2 3322:
1.174 albertel 3323: An I<iterator> encapsulates the logic required to traverse a data
3324: structure. navmap uses an iterator to traverse the course map
3325: according to the criteria you wish to use.
3326:
3327: To obtain an iterator, call the B<getIterator>() function of a
3328: B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator
3329: directly.) This will return a reference to the iterator:
1.51 bowersj2 3330:
3331: C<my $resourceIterator = $navmap-E<gt>getIterator();>
3332:
3333: To get the next thing from the iterator, call B<next>:
3334:
3335: C<my $nextThing = $resourceIterator-E<gt>next()>
3336:
3337: getIterator behaves as follows:
3338:
3339: =over 4
3340:
1.174 albertel 3341: =item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap):
3342:
3343: All parameters are optional. firstResource is a resource reference
3344: corresponding to where the iterator should start. It defaults to
3345: navmap->firstResource() for the corresponding nav map. finishResource
3346: corresponds to where you want the iterator to end, defaulting to
3347: navmap->finishResource(). filterHash is a hash used as a set
3348: containing strings representing the resource IDs, defaulting to
3349: empty. Condition is a 1 or 0 that sets what to do with the filter
1.205 bowersj2 3350: hash: If a 0, then only resources that exist IN the filterHash will be
1.174 albertel 3351: recursed on. If it is a 1, only resources NOT in the filterHash will
3352: be recursed on. Defaults to 0. forceTop is a boolean value. If it is
3353: false (default), the iterator will only return the first level of map
3354: that is not just a single, 'redirecting' map. If true, the iterator
3355: will return all information, starting with the top-level map,
3356: regardless of content. returnTopMap, if true (default false), will
3357: cause the iterator to return the top-level map object (resource 0.0)
3358: before anything else.
3359:
3360: Thus, by default, only top-level resources will be shown. Change the
3361: condition to a 1 without changing the hash, and all resources will be
3362: shown. Changing the condition to 1 and including some values in the
3363: hash will allow you to selectively suppress parts of the navmap, while
3364: leaving it on 0 and adding things to the hash will allow you to
3365: selectively add parts of the nav map. See the handler code for
3366: examples.
3367:
3368: The iterator will return either a reference to a resource object, or a
3369: token representing something in the map, such as the beginning of a
3370: new branch. The possible tokens are:
3371:
3372: =over 4
1.51 bowersj2 3373:
1.222 bowersj2 3374: =item * B<END_ITERATOR>:
3375:
3376: The iterator has returned all that it's going to. Further calls to the
3377: iterator will just produce more of these. This is a "false" value, and
3378: is the only false value the iterator which will be returned, so it can
3379: be used as a loop sentinel.
3380:
1.217 bowersj2 3381: =item * B<BEGIN_MAP>:
1.51 bowersj2 3382:
1.174 albertel 3383: A new map is being recursed into. This is returned I<after> the map
3384: resource itself is returned.
1.51 bowersj2 3385:
1.217 bowersj2 3386: =item * B<END_MAP>:
1.174 albertel 3387:
3388: The map is now done.
1.51 bowersj2 3389:
1.217 bowersj2 3390: =item * B<BEGIN_BRANCH>:
1.70 bowersj2 3391:
1.174 albertel 3392: A branch is now starting. The next resource returned will be the first
3393: in that branch.
1.70 bowersj2 3394:
1.217 bowersj2 3395: =item * B<END_BRANCH>:
1.70 bowersj2 3396:
1.174 albertel 3397: The branch is now done.
1.51 bowersj2 3398:
3399: =back
3400:
1.174 albertel 3401: The tokens are retreivable via methods on the iterator object, i.e.,
3402: $iterator->END_MAP.
1.70 bowersj2 3403:
1.174 albertel 3404: Maps can contain empty resources. The iterator will automatically skip
3405: over such resources, but will still treat the structure
3406: correctly. Thus, a complicated map with several branches, but
3407: consisting entirely of empty resources except for one beginning or
3408: ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs,
3409: but only one resource will be returned.
1.116 bowersj2 3410:
1.242 matthew 3411: =back
3412:
1.222 bowersj2 3413: =head2 Normal Usage
3414:
3415: Normal usage of the iterator object is to do the following:
3416:
3417: my $it = $navmap->getIterator([your params here]);
3418: my $curRes;
3419: while ($curRes = $it->next()) {
3420: [your logic here]
3421: }
3422:
3423: Note that inside of the loop, it's frequently useful to check if
3424: "$curRes" is a reference or not with the reference function; only
3425: resource objects will be references, and any non-references will
3426: be the tokens described above.
3427:
1.505 raeburn 3428: The next() routine can take two (optional) arguments:
3429: closeAllPages - if true will not recurse down a .page
3430: noblockcheck - passed to browsePriv() for passing as sixth arg to
3431: call to lonnet::allowed. This needs to be set if retrieveResources
3432: was already called from another routine called within lonnet::allowed,
3433: so as to prevent recursion.
3434:
1.506 raeburn 3435: Also note there is some old code floating around that tries to track
1.222 bowersj2 3436: the depth of the iterator to see when it's done; do not copy that
1.398 banghart 3437: code. It is difficult to get right and harder to understand than
1.222 bowersj2 3438: this. They should be migrated to this new style.
1.51 bowersj2 3439:
3440: =cut
3441:
3442: # Here are the tokens for the iterator:
3443:
1.222 bowersj2 3444: sub END_ITERATOR { return 0; }
1.51 bowersj2 3445: sub BEGIN_MAP { return 1; } # begining of a new map
3446: sub END_MAP { return 2; } # end of the map
3447: sub BEGIN_BRANCH { return 3; } # beginning of a branch
3448: sub END_BRANCH { return 4; } # end of a branch
1.89 bowersj2 3449: sub FORWARD { return 1; } # go forward
3450: sub BACKWARD { return 2; }
1.51 bowersj2 3451:
1.96 bowersj2 3452: sub min {
3453: (my $a, my $b) = @_;
3454: if ($a < $b) { return $a; } else { return $b; }
3455: }
3456:
1.94 bowersj2 3457: sub new {
3458: # magic invocation to create a class instance
3459: my $proto = shift;
3460: my $class = ref($proto) || $proto;
3461: my $self = {};
3462:
1.300 albertel 3463: weaken($self->{NAV_MAP} = shift);
1.94 bowersj2 3464: return undef unless ($self->{NAV_MAP});
3465:
1.454 www 3466: $self->{USERNAME} = $self->{NAV_MAP}->{USERNAME};
3467: $self->{DOMAIN} = $self->{NAV_MAP}->{DOMAIN};
3468:
1.94 bowersj2 3469: # Handle the parameters
3470: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
3471: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
3472:
3473: # If the given resources are just the ID of the resource, get the
3474: # objects
3475: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
3476: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
3477: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
3478: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
3479:
3480: $self->{FILTER} = shift;
3481:
3482: # A hash, used as a set, of resource already seen
3483: $self->{ALREADY_SEEN} = shift;
3484: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
3485: $self->{CONDITION} = shift;
3486:
1.116 bowersj2 3487: # Do we want to automatically follow "redirection" maps?
3488: $self->{FORCE_TOP} = shift;
3489:
1.162 bowersj2 3490: # Do we want to return the top-level map object (resource 0.0)?
3491: $self->{RETURN_0} = shift;
3492: # have we done that yet?
3493: $self->{HAVE_RETURNED_0} = 0;
3494:
1.94 bowersj2 3495: # Now, we need to pre-process the map, by walking forward and backward
3496: # over the parts of the map we're going to look at.
1.96 bowersj2 3497:
1.97 bowersj2 3498: # The processing steps are exactly the same, except for a few small
3499: # changes, so I bundle those up in the following list of two elements:
3500: # (direction_to_iterate, VAL_name, next_resource_method_to_call,
3501: # first_resource).
3502: # This prevents writing nearly-identical code twice.
3503: my @iterations = ( [FORWARD(), 'TOP_DOWN_VAL', 'getNext',
3504: 'FIRST_RESOURCE'],
3505: [BACKWARD(), 'BOT_UP_VAL', 'getPrevious',
3506: 'FINISH_RESOURCE'] );
3507:
1.98 bowersj2 3508: my $maxDepth = 0; # tracks max depth
3509:
1.116 bowersj2 3510: # If there is only one resource in this map, and it's a map, we
3511: # want to remember that, so the user can ask for the first map
3512: # that isn't just a redirector.
3513: my $resource; my $resourceCount = 0;
3514:
1.209 bowersj2 3515: # Documentation on this algorithm can be found in the CVS repository at
3516: # /docs/lonnavdocs; these "**#**" markers correspond to documentation
3517: # in that file.
1.107 bowersj2 3518: # **1**
3519:
1.97 bowersj2 3520: foreach my $pass (@iterations) {
3521: my $direction = $pass->[0];
3522: my $valName = $pass->[1];
3523: my $nextResourceMethod = $pass->[2];
3524: my $firstResourceName = $pass->[3];
3525:
3526: my $iterator = Apache::lonnavmaps::DFSiterator->new($self->{NAV_MAP},
3527: $self->{FIRST_RESOURCE},
3528: $self->{FINISH_RESOURCE},
3529: {}, undef, 0, $direction);
1.96 bowersj2 3530:
1.97 bowersj2 3531: # prime the recursion
3532: $self->{$firstResourceName}->{DATA}->{$valName} = 0;
1.222 bowersj2 3533: $iterator->next();
1.97 bowersj2 3534: my $curRes = $iterator->next();
1.222 bowersj2 3535: my $depth = 1;
3536: while ($depth > 0) {
3537: if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
3538: if ($curRes == $iterator->END_MAP()) { $depth--; }
3539:
1.97 bowersj2 3540: if (ref($curRes)) {
1.116 bowersj2 3541: # If there's only one resource, this will save it
1.117 bowersj2 3542: # we have to filter empty resources from consideration here,
3543: # or even "empty", redirecting maps have two (start & finish)
3544: # or three (start, finish, plus redirector)
3545: if($direction == FORWARD && $curRes->src()) {
3546: $resource = $curRes; $resourceCount++;
3547: }
1.97 bowersj2 3548: my $resultingVal = $curRes->{DATA}->{$valName};
3549: my $nextResources = $curRes->$nextResourceMethod();
1.116 bowersj2 3550: my $nextCount = scalar(@{$nextResources});
1.104 bowersj2 3551:
1.116 bowersj2 3552: if ($nextCount == 1) { # **3**
1.97 bowersj2 3553: my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;
3554: $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
3555: }
3556:
1.116 bowersj2 3557: if ($nextCount > 1) { # **4**
1.97 bowersj2 3558: foreach my $res (@{$nextResources}) {
3559: my $current = $res->{DATA}->{$valName} || 999999999;
3560: $res->{DATA}->{$valName} = min($current, $resultingVal + 1);
3561: }
3562: }
3563: }
1.96 bowersj2 3564:
1.107 bowersj2 3565: # Assign the final val (**2**)
1.97 bowersj2 3566: if (ref($curRes) && $direction == BACKWARD()) {
1.98 bowersj2 3567: my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},
3568: $curRes->{DATA}->{BOT_UP_VAL});
3569:
3570: $curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;
3571: if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}
1.190 bowersj2 3572: }
1.222 bowersj2 3573:
3574: $curRes = $iterator->next();
1.96 bowersj2 3575: }
3576: }
1.94 bowersj2 3577:
1.116 bowersj2 3578: # Check: Was this only one resource, a map?
1.255 albertel 3579: if ($resourceCount == 1 && $resource->is_sequence() && !$self->{FORCE_TOP}) {
1.116 bowersj2 3580: my $firstResource = $resource->map_start();
3581: my $finishResource = $resource->map_finish();
1.500 raeburn 3582: return Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
3583: $finishResource, $self->{FILTER},
3584: $self->{ALREADY_SEEN},
3585: $self->{CONDITION},
3586: $self->{FORCE_TOP});
1.116 bowersj2 3587: }
3588:
1.98 bowersj2 3589: # Set up some bookkeeping information.
3590: $self->{CURRENT_DEPTH} = 0;
3591: $self->{MAX_DEPTH} = $maxDepth;
3592: $self->{STACK} = [];
3593: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1.222 bowersj2 3594: $self->{FINISHED} = 0; # When true, the iterator has finished
1.98 bowersj2 3595:
3596: for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) {
3597: push @{$self->{STACK}}, [];
3598: }
3599:
1.107 bowersj2 3600: # Prime the recursion w/ the first resource **5**
1.98 bowersj2 3601: push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};
3602: $self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;
3603:
3604: bless ($self);
3605: return $self;
3606: }
3607:
3608: sub next {
3609: my $self = shift;
1.256 albertel 3610: my $closeAllPages=shift;
1.505 raeburn 3611: my $noblockcheck = shift;
1.222 bowersj2 3612: if ($self->{FINISHED}) {
3613: return END_ITERATOR();
3614: }
3615:
1.162 bowersj2 3616: # If we want to return the top-level map object, and haven't yet,
3617: # do so.
3618: if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {
3619: $self->{HAVE_RETURNED_0} = 1;
1.470 foxr 3620: my $nextTopLevel = $self->{NAV_MAP}->getById('0.0');
1.162 bowersj2 3621: return $self->{NAV_MAP}->getById('0.0');
3622: }
1.401 albertel 3623: if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0_BEGIN_MAP}) {
3624: $self->{HAVE_RETURNED_0_BEGIN_MAP} = 1;
3625: return $self->BEGIN_MAP();
3626: }
1.98 bowersj2 3627:
3628: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3629: # grab the next from the recursive iterator
1.256 albertel 3630: my $next = $self->{RECURSIVE_ITERATOR}->next($closeAllPages);
1.98 bowersj2 3631:
3632: # is it a begin or end map? If so, update the depth
3633: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
3634: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
3635:
3636: # Are we back at depth 0? If so, stop recursing
3637: if ($self->{RECURSIVE_DEPTH} == 0) {
3638: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3639: }
3640: return $next;
3641: }
3642:
3643: if (defined($self->{FORCE_NEXT})) {
3644: my $tmp = $self->{FORCE_NEXT};
3645: $self->{FORCE_NEXT} = undef;
3646: return $tmp;
3647: }
3648:
3649: # Have we not yet begun? If not, return BEGIN_MAP and
3650: # remember we've started.
3651: if ( !$self->{STARTED} ) {
3652: $self->{STARTED} = 1;
3653: return $self->BEGIN_MAP();
3654: }
3655:
3656: # Here's the guts of the iterator.
3657:
3658: # Find the next resource, if any.
3659: my $found = 0;
3660: my $i = $self->{MAX_DEPTH};
3661: my $newDepth;
3662: my $here;
3663: while ( $i >= 0 && !$found ) {
1.107 bowersj2 3664: if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6**
3665: $here = pop @{$self->{STACK}->[$i]}; # **7**
1.98 bowersj2 3666: $found = 1;
3667: $newDepth = $i;
3668: }
3669: $i--;
3670: }
3671:
3672: # If we still didn't find anything, we're done.
3673: if ( !$found ) {
3674: # We need to get back down to the correct branch depth
3675: if ( $self->{CURRENT_DEPTH} > 0 ) {
3676: $self->{CURRENT_DEPTH}--;
3677: return END_BRANCH();
3678: } else {
1.222 bowersj2 3679: $self->{FINISHED} = 1;
1.98 bowersj2 3680: return END_MAP();
3681: }
3682: }
3683:
1.104 bowersj2 3684: # If this is not a resource, it must be an END_BRANCH marker we want
3685: # to return directly.
1.107 bowersj2 3686: if (!ref($here)) { # **8**
1.104 bowersj2 3687: if ($here == END_BRANCH()) { # paranoia, in case of later extension
3688: $self->{CURRENT_DEPTH}--;
3689: return $here;
3690: }
3691: }
3692:
3693: # Otherwise, it is a resource and it's safe to store in $self->{HERE}
3694: $self->{HERE} = $here;
3695:
1.98 bowersj2 3696: # Get to the right level
3697: if ( $self->{CURRENT_DEPTH} > $newDepth ) {
3698: push @{$self->{STACK}->[$newDepth]}, $here;
3699: $self->{CURRENT_DEPTH}--;
3700: return END_BRANCH();
3701: }
3702: if ( $self->{CURRENT_DEPTH} < $newDepth) {
3703: push @{$self->{STACK}->[$newDepth]}, $here;
3704: $self->{CURRENT_DEPTH}++;
3705: return BEGIN_BRANCH();
3706: }
3707:
3708: # If we made it here, we have the next resource, and we're at the
3709: # right branch level. So let's examine the resource for where
3710: # we can get to from here.
3711:
3712: # So we need to look at all the resources we can get to from here,
3713: # categorize them if we haven't seen them, remember if we have a new
3714: my $nextUnfiltered = $here->getNext();
1.470 foxr 3715:
3716:
1.104 bowersj2 3717: my $maxDepthAdded = -1;
3718:
1.98 bowersj2 3719: for (@$nextUnfiltered) {
3720: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
1.104 bowersj2 3721: my $depth = $_->{DATA}->{DISPLAY_DEPTH};
3722: push @{$self->{STACK}->[$depth]}, $_;
1.98 bowersj2 3723: $self->{ALREADY_SEEN}->{$_->{ID}} = 1;
1.104 bowersj2 3724: if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; }
1.98 bowersj2 3725: }
3726: }
1.104 bowersj2 3727:
3728: # Is this the end of a branch? If so, all of the resources examined above
1.398 banghart 3729: # led to lower levels than the one we are currently at, so we push a END_BRANCH
1.104 bowersj2 3730: # marker onto the stack so we don't forget.
3731: # Example: For the usual A(BC)(DE)F case, when the iterator goes down the
3732: # BC branch and gets to C, it will see F as the only next resource, but it's
3733: # one level lower. Thus, this is the end of the branch, since there are no
3734: # more resources added to this level or above.
1.111 bowersj2 3735: # We don't do this if the examined resource is the finish resource,
3736: # because the condition given above is true, but the "END_MAP" will
3737: # take care of things and we should already be at depth 0.
1.104 bowersj2 3738: my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH};
1.111 bowersj2 3739: if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9**
1.104 bowersj2 3740: push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH();
3741: }
3742:
1.98 bowersj2 3743: # That ends the main iterator logic. Now, do we want to recurse
3744: # down this map (if this resource is a map)?
1.256 albertel 3745: if ( ($self->{HERE}->is_sequence() || (!$closeAllPages && $self->{HERE}->is_page())) &&
1.98 bowersj2 3746: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
3747: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3748: my $firstResource = $self->{HERE}->map_start();
3749: my $finishResource = $self->{HERE}->map_finish();
3750: $self->{RECURSIVE_ITERATOR} =
3751: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
3752: $finishResource, $self->{FILTER},
1.314 albertel 3753: $self->{ALREADY_SEEN},
3754: $self->{CONDITION},
3755: $self->{FORCE_TOP});
1.98 bowersj2 3756: }
3757:
1.116 bowersj2 3758: # If this is a blank resource, don't actually return it.
1.117 bowersj2 3759: # Should you ever find you need it, make sure to add an option to the code
3760: # that you can use; other things depend on this behavior.
1.505 raeburn 3761: my $browsePriv = $self->{HERE}->browsePriv($noblockcheck);
1.138 bowersj2 3762: if (!$self->{HERE}->src() ||
3763: (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
1.256 albertel 3764: return $self->next($closeAllPages);
1.116 bowersj2 3765: }
3766:
1.98 bowersj2 3767: return $self->{HERE};
3768:
3769: }
3770:
3771: =pod
3772:
1.174 albertel 3773: The other method available on the iterator is B<getStack>, which
3774: returns an array populated with the current 'stack' of maps, as
3775: references to the resource objects. Example: This is useful when
3776: making the navigation map, as we need to check whether we are under a
3777: page map to see if we need to link directly to the resource, or to the
3778: page. The first elements in the array will correspond to the top of
3779: the stack (most inclusive map).
1.98 bowersj2 3780:
3781: =cut
3782:
3783: sub getStack {
3784: my $self=shift;
3785:
3786: my @stack;
3787:
3788: $self->populateStack(\@stack);
3789:
3790: return \@stack;
3791: }
3792:
3793: # Private method: Calls the iterators recursively to populate the stack.
3794: sub populateStack {
3795: my $self=shift;
3796: my $stack = shift;
3797:
3798: push @$stack, $self->{HERE} if ($self->{HERE});
3799:
3800: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3801: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3802: }
1.94 bowersj2 3803: }
3804:
3805: 1;
3806:
3807: package Apache::lonnavmaps::DFSiterator;
1.365 albertel 3808: use Scalar::Util qw(weaken);
1.320 albertel 3809: use Apache::lonnet;
3810:
1.100 bowersj2 3811: # Not documented in the perldoc: This is a simple iterator that just walks
3812: # through the nav map and presents the resources in a depth-first search
3813: # fashion, ignorant of conditionals, randomized resources, etc. It presents
3814: # BEGIN_MAP and END_MAP, but does not understand branches at all. It is
3815: # useful for pre-processing of some kind, and is in fact used by the main
3816: # iterator that way, but that's about it.
3817: # One could imagine merging this into the init routine of the main iterator,
1.251 www 3818: # but this might as well be left separate, since it is possible some other
1.100 bowersj2 3819: # use might be found for it. - Jeremy
1.94 bowersj2 3820:
1.117 bowersj2 3821: # Unlike the main iterator, this DOES return all resources, even blank ones.
3822: # The main iterator needs them to correctly preprocess the map.
3823:
1.94 bowersj2 3824: sub BEGIN_MAP { return 1; } # begining of a new map
3825: sub END_MAP { return 2; } # end of the map
3826: sub FORWARD { return 1; } # go forward
3827: sub BACKWARD { return 2; }
3828:
1.100 bowersj2 3829: # Params: Nav map ref, first resource id/ref, finish resource id/ref,
3830: # filter hash ref (or undef), already seen hash or undef, condition
3831: # (as in main iterator), direction FORWARD or BACKWARD (undef->forward).
1.51 bowersj2 3832: sub new {
3833: # magic invocation to create a class instance
3834: my $proto = shift;
3835: my $class = ref($proto) || $proto;
3836: my $self = {};
3837:
1.300 albertel 3838: weaken($self->{NAV_MAP} = shift);
1.51 bowersj2 3839: return undef unless ($self->{NAV_MAP});
3840:
1.454 www 3841: $self->{USERNAME} = $self->{NAV_MAP}->{USERNAME};
3842: $self->{DOMAIN} = $self->{NAV_MAP}->{DOMAIN};
3843:
1.51 bowersj2 3844: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
3845: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
3846:
3847: # If the given resources are just the ID of the resource, get the
3848: # objects
3849: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
3850: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
3851: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
3852: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
3853:
3854: $self->{FILTER} = shift;
3855:
3856: # A hash, used as a set, of resource already seen
3857: $self->{ALREADY_SEEN} = shift;
1.140 bowersj2 3858: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1.63 bowersj2 3859: $self->{CONDITION} = shift;
1.89 bowersj2 3860: $self->{DIRECTION} = shift || FORWARD();
1.51 bowersj2 3861:
1.100 bowersj2 3862: # Flag: Have we started yet?
1.51 bowersj2 3863: $self->{STARTED} = 0;
3864:
3865: # Should we continue calling the recursive iterator, if any?
3866: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3867: # The recursive iterator, if any
3868: $self->{RECURSIVE_ITERATOR} = undef;
3869: # Are we recursing on a map, or a branch?
3870: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
3871: # And the count of how deep it is, so that this iterator can keep track of
3872: # when to pick back up again.
3873: $self->{RECURSIVE_DEPTH} = 0;
3874:
3875: # For keeping track of our branches, we maintain our own stack
1.100 bowersj2 3876: $self->{STACK} = [];
1.51 bowersj2 3877:
3878: # Start with the first resource
1.89 bowersj2 3879: if ($self->{DIRECTION} == FORWARD) {
1.100 bowersj2 3880: push @{$self->{STACK}}, $self->{FIRST_RESOURCE};
1.89 bowersj2 3881: } else {
1.100 bowersj2 3882: push @{$self->{STACK}}, $self->{FINISH_RESOURCE};
1.89 bowersj2 3883: }
1.51 bowersj2 3884:
3885: bless($self);
3886: return $self;
3887: }
3888:
3889: sub next {
3890: my $self = shift;
3891:
3892: # Are we using a recursive iterator? If so, pull from that and
3893: # watch the depth; we want to resume our level at the correct time.
1.98 bowersj2 3894: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1.51 bowersj2 3895: # grab the next from the recursive iterator
3896: my $next = $self->{RECURSIVE_ITERATOR}->next();
3897:
3898: # is it a begin or end map? Update depth if so
3899: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
3900: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
3901:
3902: # Are we back at depth 0? If so, stop recursing.
3903: if ($self->{RECURSIVE_DEPTH} == 0) {
3904: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3905: }
3906:
3907: return $next;
3908: }
3909:
3910: # Is there a current resource to grab? If not, then return
1.100 bowersj2 3911: # END_MAP, which will end the iterator.
3912: if (scalar(@{$self->{STACK}}) == 0) {
3913: return $self->END_MAP();
1.51 bowersj2 3914: }
3915:
3916: # Have we not yet begun? If not, return BEGIN_MAP and
3917: # remember that we've started.
3918: if ( !$self->{STARTED} ) {
3919: $self->{STARTED} = 1;
3920: return $self->BEGIN_MAP;
3921: }
3922:
3923: # Get the next resource in the branch
1.100 bowersj2 3924: $self->{HERE} = pop @{$self->{STACK}};
1.52 bowersj2 3925:
1.100 bowersj2 3926: # remember that we've seen this, so we don't return it again later
1.51 bowersj2 3927: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
3928:
3929: # Get the next possible resources
1.90 bowersj2 3930: my $nextUnfiltered;
1.89 bowersj2 3931: if ($self->{DIRECTION} == FORWARD()) {
1.90 bowersj2 3932: $nextUnfiltered = $self->{HERE}->getNext();
1.89 bowersj2 3933: } else {
1.90 bowersj2 3934: $nextUnfiltered = $self->{HERE}->getPrevious();
1.89 bowersj2 3935: }
1.51 bowersj2 3936: my $next = [];
3937:
3938: # filter the next possibilities to remove things we've
1.100 bowersj2 3939: # already seen.
1.394 raeburn 3940: foreach my $item (@$nextUnfiltered) {
3941: if (!defined($self->{ALREADY_SEEN}->{$item->{ID}})) {
3942: push @$next, $item;
1.52 bowersj2 3943: }
1.51 bowersj2 3944: }
3945:
3946: while (@$next) {
1.100 bowersj2 3947: # copy the next possibilities over to the stack
3948: push @{$self->{STACK}}, shift @$next;
1.51 bowersj2 3949: }
3950:
3951: # If this is a map and we want to recurse down it... (not filtered out)
1.70 bowersj2 3952: if ($self->{HERE}->is_map() &&
1.63 bowersj2 3953: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
1.51 bowersj2 3954: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3955: my $firstResource = $self->{HERE}->map_start();
3956: my $finishResource = $self->{HERE}->map_finish();
3957:
3958: $self->{RECURSIVE_ITERATOR} =
1.94 bowersj2 3959: Apache::lonnavmaps::DFSiterator->new ($self->{NAV_MAP}, $firstResource,
1.63 bowersj2 3960: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
1.91 bowersj2 3961: $self->{CONDITION}, $self->{DIRECTION});
1.51 bowersj2 3962: }
3963:
3964: return $self->{HERE};
1.190 bowersj2 3965: }
3966:
3967: # Identical to the full iterator methods of the same name. Hate to copy/paste
3968: # but I also hate to "inherit" either iterator from the other.
3969:
3970: sub getStack {
3971: my $self=shift;
3972:
3973: my @stack;
3974:
3975: $self->populateStack(\@stack);
3976:
3977: return \@stack;
3978: }
3979:
3980: # Private method: Calls the iterators recursively to populate the stack.
3981: sub populateStack {
3982: my $self=shift;
3983: my $stack = shift;
3984:
3985: push @$stack, $self->{HERE} if ($self->{HERE});
3986:
3987: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3988: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3989: }
1.51 bowersj2 3990: }
3991:
1.1 www 3992: 1;
1.2 www 3993:
1.51 bowersj2 3994: package Apache::lonnavmaps::resource;
1.365 albertel 3995: use Scalar::Util qw(weaken);
1.51 bowersj2 3996: use Apache::lonnet;
3997:
3998: =pod
3999:
1.217 bowersj2 4000: =head1 Object: resource
1.51 bowersj2 4001:
1.217 bowersj2 4002: X<resource, navmap object>
1.174 albertel 4003: A resource object encapsulates a resource in a resource map, allowing
4004: easy manipulation of the resource, querying the properties of the
4005: resource (including user properties), and represents a reference that
4006: can be used as the canonical representation of the resource by
4007: lonnavmap clients like renderers.
4008:
4009: A resource only makes sense in the context of a navmap, as some of the
4010: data is stored in the navmap object.
4011:
4012: You will probably never need to instantiate this object directly. Use
4013: Apache::lonnavmaps::navmap, and use the "start" method to obtain the
4014: starting resource.
1.51 bowersj2 4015:
1.188 bowersj2 4016: Resource objects respect the parameter_hiddenparts, which suppresses
4017: various parts according to the wishes of the map author. As of this
4018: writing, there is no way to override this parameter, and suppressed
4019: parts will never be returned, nor will their response types or ids be
4020: stored.
4021:
1.217 bowersj2 4022: =head2 Overview
1.51 bowersj2 4023:
1.217 bowersj2 4024: A B<Resource> is the most granular type of object in LON-CAPA that can
4025: be included in a course. It can either be a particular resource, like
4026: an HTML page, external resource, problem, etc., or it can be a
4027: container sequence, such as a "page" or a "map".
4028:
4029: To see a sequence from the user's point of view, please see the
4030: B<Creating a Course: Maps and Sequences> chapter of the Author's
4031: Manual.
4032:
4033: A Resource Object, once obtained from a navmap object via a B<getBy*>
4034: method of the navmap, or from an iterator, allows you to query
4035: information about that resource.
4036:
4037: Generally, you do not ever want to create a resource object yourself,
4038: so creation has been left undocumented. Always retrieve resources
4039: from navmap objects.
4040:
4041: =head3 Identifying Resources
4042:
4043: X<big hash>Every resource is identified by a Resource ID in the big hash that is
4044: unique to that resource for a given course. X<resource ID, in big hash>
4045: The Resource ID has the form #.#, where the first number is the same
4046: for every resource in a map, and the second is unique. For instance,
4047: for a course laid out like this:
4048:
4049: * Problem 1
4050: * Map
4051: * Resource 2
4052: * Resource 3
4053:
4054: C<Problem 1> and C<Map> will share a first number, and C<Resource 2>
4055: C<Resource 3> will share a first number. The second number may end up
4056: re-used between the two groups.
4057:
4058: The resource ID is only used in the big hash, but can be used in the
4059: context of a course to identify a resource easily. (For instance, the
4060: printing system uses it to record which resources from a sequence you
4061: wish to print.)
4062:
4063: X<symb> X<resource, symb>
4064: All resources also have B<symb>s, which uniquely identify a resource
4065: in a course. Many internal LON-CAPA functions expect a symb. A symb
4066: carries along with it the URL of the resource, and the map it appears
1.398 banghart 4067: in. Symbs are much larger than resource IDs.
1.51 bowersj2 4068:
4069: =cut
4070:
4071: sub new {
4072: # magic invocation to create a class instance
4073: my $proto = shift;
4074: my $class = ref($proto) || $proto;
4075: my $self = {};
4076:
1.300 albertel 4077: weaken($self->{NAV_MAP} = shift);
1.51 bowersj2 4078: $self->{ID} = shift;
4079:
1.454 www 4080: $self->{USERNAME} = $self->{NAV_MAP}->{USERNAME};
4081: $self->{DOMAIN} = $self->{NAV_MAP}->{DOMAIN};
4082:
1.51 bowersj2 4083: # Store this new resource in the parent nav map's cache.
4084: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
1.66 bowersj2 4085: $self->{RESOURCE_ERROR} = 0;
1.51 bowersj2 4086:
1.479 raeburn 4087: $self->{DUEDATE_CACHE} = undef;
4088:
1.51 bowersj2 4089: # A hash that can be used by two-pass algorithms to store data
4090: # about this resource in. Not used by the resource object
4091: # directly.
4092: $self->{DATA} = {};
1.508 damieng 4093:
1.51 bowersj2 4094: bless($self);
4095:
1.508 damieng 4096: # This is a speed optimization, to avoid calling symb() too often.
4097: $self->{SYMB} = $self->symb();
1.515 raeburn 4098:
1.51 bowersj2 4099: return $self;
4100: }
4101:
1.70 bowersj2 4102: # private function: simplify the NAV_HASH lookups we keep doing
4103: # pass the name, and to automatically append my ID, pass a true val on the
4104: # second param
4105: sub navHash {
4106: my $self = shift;
4107: my $param = shift;
4108: my $id = shift;
1.441 raeburn 4109: my $arg = $param . ($id?$self->{ID}:"");
1.451 raeburn 4110: if (ref($self) && ref($self->{NAV_MAP}) && defined($arg)) {
1.441 raeburn 4111: return $self->{NAV_MAP}->navhash($arg);
4112: }
4113: return;
1.70 bowersj2 4114: }
4115:
1.51 bowersj2 4116: =pod
4117:
1.217 bowersj2 4118: =head2 Methods
1.70 bowersj2 4119:
1.217 bowersj2 4120: Once you have a resource object, here's what you can do with it:
4121:
4122: =head3 Attribute Retrieval
4123:
4124: Every resource has certain attributes that can be retrieved and used:
1.70 bowersj2 4125:
4126: =over 4
4127:
1.217 bowersj2 4128: =item * B<ID>: Every resource has an ID that is unique for that
4129: resource in the course it is in. The ID is actually in the hash
4130: representing the resource, so for a resource object $res, obtain
4131: it via C<$res->{ID}).
4132:
1.174 albertel 4133: =item * B<compTitle>:
4134:
4135: Returns a "composite title", that is equal to $res->title() if the
4136: resource has a title, and is otherwise the last part of the URL (e.g.,
4137: "problem.problem").
4138:
4139: =item * B<ext>:
4140:
4141: Returns true if the resource is external.
4142:
4143: =item * B<kind>:
4144:
4145: Returns the kind of the resource from the compiled nav map.
4146:
4147: =item * B<randomout>:
1.106 bowersj2 4148:
1.174 albertel 4149: Returns true if this resource was chosen to NOT be shown to the user
4150: by the random map selection feature. In other words, this is usually
4151: false.
1.70 bowersj2 4152:
1.174 albertel 4153: =item * B<randompick>:
1.70 bowersj2 4154:
1.400 albertel 4155: Returns the number of randomly picked items for a map if the randompick
4156: feature is being used on the map.
4157:
4158: =item * B<randomorder>:
4159:
4160: Returns true for a map if the randomorder feature is being used on the
4161: map.
1.70 bowersj2 4162:
1.174 albertel 4163: =item * B<src>:
1.51 bowersj2 4164:
1.174 albertel 4165: Returns the source for the resource.
1.70 bowersj2 4166:
1.174 albertel 4167: =item * B<symb>:
1.70 bowersj2 4168:
1.174 albertel 4169: Returns the symb for the resource.
1.70 bowersj2 4170:
1.174 albertel 4171: =item * B<title>:
1.70 bowersj2 4172:
1.174 albertel 4173: Returns the title of the resource.
4174:
1.51 bowersj2 4175: =back
4176:
4177: =cut
4178:
4179: # These info functions can be used directly, as they don't return
4180: # resource information.
1.85 bowersj2 4181: sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
1.303 albertel 4182: sub encrypted { my $self=shift; return $self->navHash("encrypted_", 1); }
1.70 bowersj2 4183: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
1.85 bowersj2 4184: sub from { my $self=shift; return $self->navHash("from_", 1); }
1.217 bowersj2 4185: # considered private and undocumented
1.51 bowersj2 4186: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
4187: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
1.68 bowersj2 4188: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
4189: sub randompick {
4190: my $self = shift;
1.410 raeburn 4191: my $randompick = $self->parmval('randompick');
4192: return $randompick;
1.68 bowersj2 4193: }
1.400 albertel 4194: sub randomorder {
4195: my $self = shift;
1.410 raeburn 4196: my $randomorder = $self->parmval('randomorder');
4197: return ($randomorder =~ /^yes$/i);
1.400 albertel 4198: }
1.303 albertel 4199: sub link {
4200: my $self=shift;
4201: if ($self->encrypted()) { return &Apache::lonenc::encrypted($self->src); }
4202: return $self->src;
4203: }
1.51 bowersj2 4204: sub src {
4205: my $self=shift;
4206: return $self->navHash("src_", 1);
4207: }
1.303 albertel 4208: sub shown_symb {
4209: my $self=shift;
1.508 damieng 4210: if ($self->encrypted()) {return &Apache::lonenc::encrypted($self->{SYMB});}
4211: return $self->{SYMB};
1.303 albertel 4212: }
1.328 www 4213: sub id {
4214: my $self=shift;
4215: return $self->{ID};
4216: }
4217: sub enclosing_map_src {
4218: my $self=shift;
4219: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
4220: return $self->navHash('map_id_'.$first);
4221: }
1.51 bowersj2 4222: sub symb {
4223: my $self=shift;
1.523 damieng 4224: if (defined $self->{SYMB}) { return $self->{SYMB}; }
1.51 bowersj2 4225: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
4226: my $symbSrc = &Apache::lonnet::declutter($self->src());
1.223 albertel 4227: my $symb = &Apache::lonnet::declutter($self->navHash('map_id_'.$first))
1.51 bowersj2 4228: . '___' . $second . '___' . $symbSrc;
1.223 albertel 4229: return &Apache::lonnet::symbclean($symb);
1.51 bowersj2 4230: }
1.321 raeburn 4231: sub wrap_symb {
4232: my $self = shift;
1.508 damieng 4233: return $self->{NAV_MAP}->wrap_symb($self->{SYMB});
1.321 raeburn 4234: }
1.213 bowersj2 4235: sub title {
4236: my $self=shift;
4237: if ($self->{ID} eq '0.0') {
4238: # If this is the top-level map, return the title of the course
4239: # since this map can not be titled otherwise.
1.320 albertel 4240: return $env{'course.'.$env{'request.course.id'}.'.description'};
1.213 bowersj2 4241: }
4242: return $self->navHash("title_", 1); }
1.217 bowersj2 4243: # considered private and undocumented
1.70 bowersj2 4244: sub to { my $self=shift; return $self->navHash("to_", 1); }
1.301 albertel 4245: sub condition {
4246: my $self=shift;
4247: my $undercond=$self->navHash("undercond_", 1);
4248: if (!defined($undercond)) { return 1; };
4249: my $condid=$self->navHash("condid_$undercond");
4250: if (!defined($condid)) { return 1; };
4251: my $condition=&Apache::lonnet::directcondval($condid);
4252: return $condition;
4253: }
1.342 albertel 4254: sub condval {
4255: my $self=shift;
1.359 albertel 4256: my ($pathname,$filename) =
4257: &Apache::lonnet::split_uri_for_cond($self->src());
1.342 albertel 4258:
4259: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
4260: /\&\Q$filename\E\:([\d\|]+)\&/);
4261: if ($match) {
4262: return &Apache::lonnet::condval($1);
4263: }
4264: return 0;
4265: }
1.106 bowersj2 4266: sub compTitle {
4267: my $self = shift;
4268: my $title = $self->title();
1.176 www 4269: $title=~s/\&colon\;/\:/gs;
1.106 bowersj2 4270: if (!$title) {
4271: $title = $self->src();
4272: $title = substr($title, rindex($title, '/') + 1);
4273: }
4274: return $title;
4275: }
1.399 albertel 4276:
1.70 bowersj2 4277: =pod
4278:
4279: B<Predicate Testing the Resource>
4280:
4281: These methods are shortcuts to deciding if a given resource has a given property.
4282:
4283: =over 4
4284:
1.174 albertel 4285: =item * B<is_map>:
4286:
4287: Returns true if the resource is a map type.
4288:
4289: =item * B<is_problem>:
1.70 bowersj2 4290:
1.174 albertel 4291: Returns true if the resource is a problem type, false
4292: otherwise. (Looks at the extension on the src field; might need more
4293: to work correctly.)
1.70 bowersj2 4294:
1.174 albertel 4295: =item * B<is_page>:
1.70 bowersj2 4296:
1.174 albertel 4297: Returns true if the resource is a page.
4298:
4299: =item * B<is_sequence>:
4300:
4301: Returns true if the resource is a sequence.
1.70 bowersj2 4302:
4303: =back
4304:
4305: =cut
4306:
1.256 albertel 4307: sub hasResource {
4308: my $self = shift;
4309: return $self->{NAV_MAP}->hasResource(@_);
4310: }
4311:
4312: sub retrieveResources {
4313: my $self = shift;
4314: return $self->{NAV_MAP}->retrieveResources(@_);
4315: }
1.70 bowersj2 4316:
1.369 albertel 4317: sub is_exam {
4318: my ($self,$part) = @_;
1.410 raeburn 4319: my $type = $self->parmval('type',$part);
4320: if ($type eq 'exam') {
1.369 albertel 4321: return 1;
4322: }
4323: if ($self->src() =~ /\.(exam)$/) {
4324: return 1;
4325: }
4326: return 0;
4327: }
1.70 bowersj2 4328: sub is_html {
1.51 bowersj2 4329: my $self=shift;
4330: my $src = $self->src();
1.70 bowersj2 4331: return ($src =~ /html$/);
1.51 bowersj2 4332: }
1.70 bowersj2 4333: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
4334: sub is_page {
1.51 bowersj2 4335: my $self=shift;
4336: my $src = $self->src();
1.205 bowersj2 4337: return $self->navHash("is_map_", 1) &&
4338: $self->navHash("map_type_" . $self->map_pc()) eq 'page';
1.51 bowersj2 4339: }
1.361 albertel 4340: sub is_practice {
4341: my $self=shift;
4342: my ($part) = @_;
1.410 raeburn 4343: my $type = $self->parmval('type',$part);
4344: if ($type eq 'practice') {
1.361 albertel 4345: return 1;
4346: }
4347: return 0;
4348: }
1.70 bowersj2 4349: sub is_problem {
1.51 bowersj2 4350: my $self=shift;
4351: my $src = $self->src();
1.466 www 4352: if ($src =~ /$LONCAPA::assess_re/) {
1.361 albertel 4353: return !($self->is_practice());
4354: }
4355: return 0;
1.256 albertel 4356: }
1.443 foxr 4357: #
4358: # The has below is the set of status that are considered 'incomplete'
4359: #
4360: my %incomplete_hash =
4361: (
4362: TRIES_LEFT() => 1,
4363: OPEN() => 1,
4364: ATTEMPTED() => 1
4365:
4366: );
4367: #
4368: # Return tru if a problem is incomplete... for now incomplete means that
4369: # any part of the problem is incomplete.
4370: # Note that if the resources is not a problem, 0 is returned.
4371: #
4372: sub is_incomplete {
4373: my $self = shift;
4374: if ($self->is_problem()) {
4375: foreach my $part (@{$self->parts()}) {
4376: if (exists($incomplete_hash{$self->status($part)})) {
4377: return 1;
4378: }
4379: }
4380: }
4381: return 0;
4382:
4383: }
1.413 www 4384: sub is_raw_problem {
4385: my $self=shift;
4386: my $src = $self->src();
1.466 www 4387: if ($src =~ /$LONCAPA::assess_re/) {
1.413 www 4388: return 1;
4389: }
4390: return 0;
4391: }
4392:
1.256 albertel 4393: sub contains_problem {
4394: my $self=shift;
4395: if ($self->is_page()) {
4396: my $hasProblem=$self->hasResource($self,sub { $_[0]->is_problem() },1);
4397: return $hasProblem;
4398: }
4399: return 0;
1.51 bowersj2 4400: }
1.401 albertel 4401: sub map_contains_problem {
4402: my $self=shift;
4403: if ($self->is_map()) {
4404: my $has_problem=
4405: $self->hasResource($self,sub { $_[0]->is_problem() },1);
4406: return $has_problem;
4407: }
4408: return 0;
4409: }
1.70 bowersj2 4410: sub is_sequence {
1.51 bowersj2 4411: my $self=shift;
1.205 bowersj2 4412: return $self->navHash("is_map_", 1) &&
1.426 droeschl 4413: $self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
1.51 bowersj2 4414: }
1.261 matthew 4415: sub is_survey {
4416: my $self = shift();
4417: my $part = shift();
1.410 raeburn 4418: my $type = $self->parmval('type',$part);
1.444 raeburn 4419: if (($type eq 'survey') || ($type eq 'surveycred')) {
1.261 matthew 4420: return 1;
4421: }
1.263 albertel 4422: if ($self->src() =~ /\.(survey)$/) {
1.261 matthew 4423: return 1;
4424: }
4425: return 0;
4426: }
1.444 raeburn 4427: sub is_anonsurvey {
4428: my $self = shift();
4429: my $part = shift();
4430: my $type = $self->parmval('type',$part);
4431: if (($type eq 'anonsurvey') || ($type eq 'anonsurveycred')) {
4432: return 1;
4433: }
4434: return 0;
4435: }
1.360 albertel 4436: sub is_task {
4437: my $self=shift;
4438: my $src = $self->src();
4439: return ($src =~ /\.(task)$/)
4440: }
1.51 bowersj2 4441:
1.266 raeburn 4442: sub is_empty_sequence {
4443: my $self=shift;
4444: my $src = $self->src();
4445: return !$self->is_page() && $self->navHash("is_map_", 1) && !$self->navHash("map_type_" . $self->map_pc());
4446: }
4447:
1.101 bowersj2 4448: # Private method: Shells out to the parmval in the nav map, handler parts.
1.51 bowersj2 4449: sub parmval {
4450: my $self = shift;
4451: my $what = shift;
1.185 bowersj2 4452: my $part = shift;
4453: if (!defined($part)) {
4454: $part = '0';
4455: }
1.508 damieng 4456: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->{SYMB});
1.51 bowersj2 4457: }
4458:
1.70 bowersj2 4459: =pod
4460:
4461: B<Map Methods>
4462:
1.174 albertel 4463: These methods are useful for getting information about the map
4464: properties of the resource, if the resource is a map (B<is_map>).
1.70 bowersj2 4465:
4466: =over 4
4467:
1.174 albertel 4468: =item * B<map_finish>:
4469:
4470: Returns a reference to a resource object corresponding to the finish
4471: resource of the map.
1.70 bowersj2 4472:
1.174 albertel 4473: =item * B<map_pc>:
1.70 bowersj2 4474:
1.174 albertel 4475: Returns the pc value of the map, which is the first number that
4476: appears in the resource ID of the resources in the map, and is the
4477: number that appears around the middle of the symbs of the resources in
4478: that map.
1.70 bowersj2 4479:
1.174 albertel 4480: =item * B<map_start>:
4481:
4482: Returns a reference to a resource object corresponding to the start
4483: resource of the map.
4484:
4485: =item * B<map_type>:
4486:
4487: Returns a string with the type of the map in it.
1.70 bowersj2 4488:
1.497 raeburn 4489: =item * B<map_hierarchy>:
1.448 raeburn 4490:
4491: Returns a string with a comma-separated ordered list of map_pc IDs
4492: for the hierarchy of maps containing a map, with the top level
4493: map first, then descending to deeper levels, with the enclosing map last.
4494:
1.70 bowersj2 4495: =back
1.51 bowersj2 4496:
1.70 bowersj2 4497: =cut
1.51 bowersj2 4498:
4499: sub map_finish {
4500: my $self = shift;
4501: my $src = $self->src();
1.381 albertel 4502: $src = &Apache::lonnet::clutter($src);
1.51 bowersj2 4503: my $res = $self->navHash("map_finish_$src", 0);
4504: $res = $self->{NAV_MAP}->getById($res);
4505: return $res;
4506: }
1.70 bowersj2 4507: sub map_pc {
4508: my $self = shift;
1.381 albertel 4509: my $src = $self->src();
1.70 bowersj2 4510: return $self->navHash("map_pc_$src", 0);
4511: }
1.51 bowersj2 4512: sub map_start {
4513: my $self = shift;
4514: my $src = $self->src();
1.381 albertel 4515: $src = &Apache::lonnet::clutter($src);
1.51 bowersj2 4516: my $res = $self->navHash("map_start_$src", 0);
4517: $res = $self->{NAV_MAP}->getById($res);
4518: return $res;
4519: }
4520: sub map_type {
4521: my $self = shift;
4522: my $pc = $self->map_pc();
4523: return $self->navHash("map_type_$pc", 0);
4524: }
1.448 raeburn 4525: sub map_hierarchy {
4526: my $self = shift;
4527: my $pc = $self->map_pc();
4528: return $self->navHash("map_hierarchy_$pc", 0);
4529: }
1.51 bowersj2 4530:
4531: #####
4532: # Property queries
4533: #####
4534:
4535: # These functions will be responsible for returning the CORRECT
4536: # VALUE for the parameter, no matter what. So while they may look
1.398 banghart 4537: # like direct calls to parmval, they can be more than that.
1.51 bowersj2 4538: # So, for instance, the duedate function should use the "duedatetype"
1.398 banghart 4539: # information, rather than the resource object user.
1.51 bowersj2 4540:
4541: =pod
4542:
4543: =head2 Resource Parameters
4544:
1.174 albertel 4545: In order to use the resource parameters correctly, the nav map must
4546: have been instantiated with genCourseAndUserOptions set to true, so
4547: the courseopt and useropt is read correctly. Then, you can call these
4548: functions to get the relevant parameters for the resource. Each
4549: function defaults to part "0", but can be directed to another part by
4550: passing the part as the parameter.
4551:
4552: These methods are responsible for getting the parameter correct, not
4553: merely reflecting the contents of the GDBM hashes. As we move towards
4554: dates relative to other dates, these methods should be updated to
4555: reflect that. (Then, anybody using these methods will not have to update
4556: their code.)
4557:
4558: =over 4
4559:
1.485 foxr 4560:
1.459 foxr 4561: =item * B<printable>
4562:
4563: returns true if the current date is such that the
4564: specified resource part is printable.
4565:
1.485 foxr 4566:
1.459 foxr 4567: =item * B<resprintable>
4568:
4569: Returns true if all parts in the resource are printable making the
4570: entire resource printable.
4571:
4572: =item * B<acc>
1.174 albertel 4573:
4574: Get the Client IP/Name Access Control information.
1.51 bowersj2 4575:
1.174 albertel 4576: =item * B<answerdate>:
1.51 bowersj2 4577:
1.174 albertel 4578: Get the answer-reveal date for the problem.
4579:
1.211 bowersj2 4580: =item * B<awarded>:
4581:
4582: Gets the awarded value for the problem part. Requires genUserData set to
4583: true when the navmap object was created.
4584:
1.174 albertel 4585: =item * B<duedate>:
4586:
4587: Get the due date for the problem.
4588:
4589: =item * B<tries>:
4590:
4591: Get the number of tries the student has used on the problem.
4592:
4593: =item * B<maxtries>:
4594:
4595: Get the number of max tries allowed.
4596:
4597: =item * B<opendate>:
1.51 bowersj2 4598:
1.174 albertel 4599: Get the open date for the problem.
1.51 bowersj2 4600:
1.174 albertel 4601: =item * B<sig>:
1.51 bowersj2 4602:
1.174 albertel 4603: Get the significant figures setting.
1.51 bowersj2 4604:
1.174 albertel 4605: =item * B<tol>:
1.51 bowersj2 4606:
1.174 albertel 4607: Get the tolerance for the problem.
1.51 bowersj2 4608:
1.174 albertel 4609: =item * B<tries>:
1.51 bowersj2 4610:
1.174 albertel 4611: Get the number of tries the user has already used on the problem.
1.51 bowersj2 4612:
1.174 albertel 4613: =item * B<type>:
1.51 bowersj2 4614:
1.174 albertel 4615: Get the question type for the problem.
1.70 bowersj2 4616:
1.174 albertel 4617: =item * B<weight>:
1.51 bowersj2 4618:
1.174 albertel 4619: Get the weight for the problem.
1.51 bowersj2 4620:
4621: =back
4622:
4623: =cut
4624:
1.485 foxr 4625:
4626:
4627:
1.459 foxr 4628: sub printable {
4629:
4630: my ($self, $part) = @_;
4631:
4632: # The following cases apply:
1.487 foxr 4633: # - If a start date is not set, it is replaced by the open date.
4634: # - Ditto for start/open replaced by content open.
4635: # - If neither start nor printdates are set the part is printable.
1.459 foxr 4636: # - Start date set but no end date: Printable if now >= start date.
4637: # - End date set but no start date: Printable if now <= end date.
4638: # - both defined: printable if start <= now <= end
4639: #
1.487 foxr 4640:
4641: # Get the print open/close dates for the resource.
4642:
4643: my $start = $self->parmval("printstartdate", $part);
4644: my $end = $self->parmval("printenddate", $part);
4645:
4646: if (!$start) {
4647: $start = $self->parmval("opendate", $part);
4648: }
4649: if (!$start) {
4650: $start = $self->parmval("contentopen", $part);
4651: }
4652:
4653:
1.459 foxr 4654: my $now = time();
4655:
1.487 foxr 4656:
1.459 foxr 4657: my $startok = 1;
4658: my $endok = 1;
4659:
1.460 foxr 4660: if ((defined $start) && ($start ne '')) {
1.459 foxr 4661: $startok = $start <= $now;
4662: }
1.460 foxr 4663: if ((defined $end) && ($end != '')) {
1.459 foxr 4664: $endok = $end >= $now;
4665: }
4666: return $startok && $endok;
4667: }
4668:
4669: sub resprintable {
4670: my $self = shift;
4671:
4672: # get parts...or realize there are no parts.
4673:
1.460 foxr 4674: my $partsref = $self->parts();
4675: my @parts = @$partsref;
4676:
1.489 raeburn 4677: if (!@parts) {
1.459 foxr 4678: return $self->printable(0);
4679: } else {
1.460 foxr 4680: foreach my $part (@parts) {
4681: if (!$self->printable($part)) {
4682: return 0;
4683: }
1.459 foxr 4684: }
4685: return 1;
4686: }
4687: }
4688:
1.51 bowersj2 4689: sub acc {
4690: (my $self, my $part) = @_;
1.410 raeburn 4691: my $acc = $self->parmval("acc", $part);
4692: return $acc;
1.51 bowersj2 4693: }
4694: sub answerdate {
4695: (my $self, my $part) = @_;
4696: # Handle intervals
1.410 raeburn 4697: my $answerdatetype = $self->parmval("answerdate.type", $part);
4698: my $answerdate = $self->parmval("answerdate", $part);
4699: my $duedate = $self->parmval("duedate", $part);
4700: if ($answerdatetype eq 'date_interval') {
4701: $answerdate = $duedate + $answerdate;
1.51 bowersj2 4702: }
1.410 raeburn 4703: return $answerdate;
1.106 bowersj2 4704: }
1.211 bowersj2 4705: sub awarded {
4706: my $self = shift; my $part = shift;
1.221 bowersj2 4707: $self->{NAV_MAP}->get_user_data();
1.211 bowersj2 4708: if (!defined($part)) { $part = '0'; }
1.508 damieng 4709: return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}}->{'resource.'.$part.'.awarded'};
1.211 bowersj2 4710: }
1.432 raeburn 4711: sub taskversion {
4712: my $self = shift; my $part = shift;
4713: $self->{NAV_MAP}->get_user_data();
4714: if (!defined($part)) { $part = '0'; }
1.508 damieng 4715: return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}}->{'resource.'.$part.'.version'};
1.432 raeburn 4716: }
4717: sub taskstatus {
4718: my $self = shift; my $part = shift;
4719: $self->{NAV_MAP}->get_user_data();
4720: if (!defined($part)) { $part = '0'; }
1.508 damieng 4721: return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}}->{'resource.'.$self->taskversion($part).'.'.$part.'.status'};
1.432 raeburn 4722: }
4723: sub solved {
4724: my $self = shift; my $part = shift;
4725: $self->{NAV_MAP}->get_user_data();
4726: if (!defined($part)) { $part = '0'; }
1.508 damieng 4727: return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}}->{'resource.'.$part.'.solved'};
1.432 raeburn 4728: }
4729: sub checkedin {
4730: my $self = shift; my $part = shift;
4731: $self->{NAV_MAP}->get_user_data();
4732: if (!defined($part)) { $part = '0'; }
4733: if ($self->is_task()) {
4734: my $version = $self->taskversion($part);
1.508 damieng 4735: 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 4736: } else {
1.508 damieng 4737: 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 4738: }
4739: }
1.382 albertel 4740: # this should work exactly like the copy in lonhomework.pm
1.459 foxr 4741: # Why is there a copy in lonhomework? Why not centralized?
4742: #
4743: # TODO: Centralize duedate.
4744: #
4745:
1.51 bowersj2 4746: sub duedate {
4747: (my $self, my $part) = @_;
1.479 raeburn 4748: if (defined ($self->{DUEDATE_CACHE}->{$part})) {
4749: return $self->{DUEDATE_CACHE}->{$part};
4750: }
1.382 albertel 4751: my $date;
1.406 albertel 4752: my @interval=$self->parmval("interval", $part);
1.382 albertel 4753: my $due_date=$self->parmval("duedate", $part);
1.520 raeburn 4754: if ($interval[0] =~ /^(\d+)/) {
4755: my $timelimit = $1;
4756: my $first_access=&Apache::lonnet::get_first_access($interval[1],
4757: $self->{SYMB});
1.382 albertel 4758: if (defined($first_access)) {
1.520 raeburn 4759: my $interval = $first_access+$timelimit;
1.404 albertel 4760: $date = (!$due_date || $interval < $due_date) ? $interval
4761: : $due_date;
1.382 albertel 4762: } else {
4763: $date = $due_date;
4764: }
4765: } else {
4766: $date = $due_date;
1.260 albertel 4767: }
1.479 raeburn 4768: $self->{DUEDATE_CACHE}->{$part} = $date;
1.382 albertel 4769: return $date;
1.51 bowersj2 4770: }
1.334 albertel 4771: sub handgrade {
4772: (my $self, my $part) = @_;
1.399 albertel 4773: my @response_ids = $self->responseIds($part);
4774: if (@response_ids) {
4775: foreach my $response_id (@response_ids) {
1.410 raeburn 4776: my $handgrade = $self->parmval("handgrade",$part.'_'.$response_id);
4777: if (lc($handgrade) eq 'yes') {
1.399 albertel 4778: return 'yes';
4779: }
4780: }
4781: }
1.410 raeburn 4782: my $handgrade = $self->parmval("handgrade", $part);
4783: return $handgrade;
1.334 albertel 4784: }
1.51 bowersj2 4785: sub maxtries {
4786: (my $self, my $part) = @_;
1.410 raeburn 4787: my $maxtries = $self->parmval("maxtries", $part);
4788: return $maxtries;
1.51 bowersj2 4789: }
4790: sub opendate {
4791: (my $self, my $part) = @_;
1.410 raeburn 4792: my $opendatetype = $self->parmval("opendate.type", $part);
4793: my $opendate = $self->parmval("opendate", $part);
4794: if ($opendatetype eq 'date_interval') {
4795: my $duedate = $self->duedate($part);
4796: $opendate = $duedate - $opendate;
1.51 bowersj2 4797: }
1.410 raeburn 4798: return $opendate;
1.51 bowersj2 4799: }
1.185 bowersj2 4800: sub problemstatus {
4801: (my $self, my $part) = @_;
1.410 raeburn 4802: my $problemstatus = $self->parmval("problemstatus", $part);
4803: return lc($problemstatus);
1.185 bowersj2 4804: }
1.51 bowersj2 4805: sub sig {
4806: (my $self, my $part) = @_;
1.410 raeburn 4807: my $sig = $self->parmval("sig", $part);
4808: return $sig;
1.51 bowersj2 4809: }
4810: sub tol {
4811: (my $self, my $part) = @_;
1.410 raeburn 4812: my $tol = $self->parmval("tol", $part);
4813: return $tol;
1.51 bowersj2 4814: }
1.410 raeburn 4815: sub tries {
1.108 bowersj2 4816: my $self = shift;
4817: my $tries = $self->queryRestoreHash('tries', shift);
4818: if (!defined($tries)) { return '0';}
1.51 bowersj2 4819: return $tries;
4820: }
1.70 bowersj2 4821: sub type {
4822: (my $self, my $part) = @_;
1.410 raeburn 4823: my $type = $self->parmval("type", $part);
4824: return $type;
1.70 bowersj2 4825: }
1.109 bowersj2 4826: sub weight {
4827: my $self = shift; my $part = shift;
1.211 bowersj2 4828: if (!defined($part)) { $part = '0'; }
1.409 raeburn 4829: my $weight = &Apache::lonnet::EXT('resource.'.$part.'.weight',
1.508 damieng 4830: $self->{SYMB}, $self->{DOMAIN},
1.453 www 4831: $self->{USERNAME},
1.409 raeburn 4832: $env{'request.course.sec'});
4833: return $weight;
1.274 matthew 4834: }
4835: sub part_display {
4836: my $self= shift(); my $partID = shift();
4837: if (! defined($partID)) { $partID = '0'; }
4838: my $display=&Apache::lonnet::EXT('resource.'.$partID.'.display',
1.514 raeburn 4839: $self->{SYMB});
1.274 matthew 4840: if (! defined($display) || $display eq '') {
4841: $display = $partID;
4842: }
4843: return $display;
1.70 bowersj2 4844: }
1.432 raeburn 4845: sub slot_control {
4846: my $self=shift(); my $part = shift();
4847: if (!defined($part)) { $part = '0'; }
4848: my $useslots = $self->parmval("useslots", $part);
4849: my $availablestudent = $self->parmval("availablestudent", $part);
4850: my $available = $self->parmval("available", $part);
4851: return ($useslots,$availablestudent,$available);
4852: }
1.51 bowersj2 4853:
4854: # Multiple things need this
4855: sub getReturnHash {
4856: my $self = shift;
4857:
4858: if (!defined($self->{RETURN_HASH})) {
1.524 damieng 4859: #my %tmpHash = &Apache::lonnet::restore($self->{SYMB},undef,$self->{DOMAIN},$self->{USERNAME});
4860: #$self->{RETURN_HASH} = \%tmpHash;
4861: # When info is retrieved for several resources (as when rendering a directory),
4862: # it is much faster to use the user profile dump and avoid repeated lonnet requests
4863: # (especially since lonnet::currentdump is using Lond directly whenever possible,
4864: # and lonnet::restore is not at this point).
4865: $self->{NAV_MAP}->get_user_data();
4866: $self->{RETURN_HASH} = $self->{NAV_MAP}->{STUDENT_DATA}->{$self->{SYMB}};
1.51 bowersj2 4867: }
4868: }
4869:
4870: ######
4871: # Status queries
4872: ######
4873:
4874: # These methods query the status of problems.
4875:
4876: # If we need to count parts, this function determines the number of
4877: # parts from the metadata. When called, it returns a reference to a list
4878: # of strings corresponding to the parts. (Thus, using it in a scalar context
4879: # tells you how many parts you have in the problem:
4880: # $partcount = scalar($resource->countParts());
4881: # Don't use $self->{PARTS} directly because you don't know if it's been
4882: # computed yet.
4883:
4884: =pod
4885:
4886: =head2 Resource misc
4887:
4888: Misc. functions for the resource.
4889:
4890: =over 4
4891:
1.174 albertel 4892: =item * B<hasDiscussion>:
1.59 bowersj2 4893:
1.174 albertel 4894: Returns a false value if there has been discussion since the user last
4895: logged in, true if there has. Always returns false if the discussion
4896: data was not extracted when the nav map was constructed.
4897:
1.366 albertel 4898: =item * B<last_post_time>:
4899:
4900: Returns a false value if there hasn't been discussion otherwise returns
4901: unix timestamp of last time a discussion posting (or edit) was made.
4902:
1.393 raeburn 4903: =item * B<discussion_info>:
1.366 albertel 4904:
1.393 raeburn 4905: optional argument is a filter (currently can be 'unread');
4906: returns in scalar context the count of the number of discussion postings.
1.366 albertel 4907:
4908: returns in list context both the count of postings and a hash ref
1.393 raeburn 4909: containing information about the postings (subject, id, timestamp) in a hash.
4910:
4911: 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 4912:
1.174 albertel 4913: =item * B<getFeedback>:
4914:
4915: Gets the feedback for the resource and returns the raw feedback string
4916: for the resource, or the null string if there is no feedback or the
4917: email data was not extracted when the nav map was constructed. Usually
4918: used like this:
1.59 bowersj2 4919:
1.394 raeburn 4920: for my $url (split(/\,/, $res->getFeedback())) {
4921: my $link = &escape($url);
1.59 bowersj2 4922: ...
4923:
4924: and use the link as appropriate.
4925:
4926: =cut
4927:
4928: sub hasDiscussion {
4929: my $self = shift;
1.508 damieng 4930: return $self->{NAV_MAP}->hasDiscussion($self->{SYMB});
1.59 bowersj2 4931: }
4932:
1.366 albertel 4933: sub last_post_time {
4934: my $self = shift;
1.508 damieng 4935: return $self->{NAV_MAP}->last_post_time($self->{SYMB});
1.366 albertel 4936: }
4937:
1.393 raeburn 4938: sub discussion_info {
4939: my ($self,$filter) = @_;
1.508 damieng 4940: return $self->{NAV_MAP}->discussion_info($self->{SYMB},$filter);
1.366 albertel 4941: }
4942:
1.59 bowersj2 4943: sub getFeedback {
4944: my $self = shift;
1.124 bowersj2 4945: my $source = $self->src();
1.508 damieng 4946: my $symb = $self->{SYMB};
1.125 bowersj2 4947: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
1.395 raeburn 4948: return $self->{NAV_MAP}->getFeedback($symb,$source);
1.124 bowersj2 4949: }
4950:
4951: sub getErrors {
4952: my $self = shift;
4953: my $source = $self->src();
1.508 damieng 4954: my $symb = $self->{SYMB};
1.124 bowersj2 4955: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
1.395 raeburn 4956: return $self->{NAV_MAP}->getErrors($symb,$source);
1.59 bowersj2 4957: }
4958:
4959: =pod
4960:
1.174 albertel 4961: =item * B<parts>():
1.51 bowersj2 4962:
1.174 albertel 4963: Returns a list reference containing sorted strings corresponding to
1.193 bowersj2 4964: each part of the problem. Single part problems have only a part '0'.
4965: Multipart problems do not return their part '0', since they typically
4966: do not really matter.
1.174 albertel 4967:
4968: =item * B<countParts>():
4969:
4970: Returns the number of parts of the problem a student can answer. Thus,
4971: for single part problems, returns 1. For multipart, it returns the
1.193 bowersj2 4972: number of parts in the problem, not including psuedo-part 0.
1.51 bowersj2 4973:
1.290 matthew 4974: =item * B<countResponses>():
4975:
4976: Returns the total number of responses in the problem a student can answer.
4977:
4978: =item * B<responseTypes>():
4979:
4980: Returns a hash whose keys are the response types. The values are the number
4981: of times each response type is used. This is for the I<entire> problem, not
4982: just a single part.
4983:
1.192 bowersj2 4984: =item * B<multipart>():
4985:
1.193 bowersj2 4986: Returns true if the problem is multipart, false otherwise. Use this instead
4987: of countParts if all you want is multipart/not multipart.
1.192 bowersj2 4988:
1.187 bowersj2 4989: =item * B<responseType>($part):
4990:
4991: Returns the response type of the part, without the word "response" on the
4992: end. Example return values: 'string', 'essay', 'numeric', etc.
4993:
1.193 bowersj2 4994: =item * B<responseIds>($part):
1.187 bowersj2 4995:
1.193 bowersj2 4996: Retreives the response IDs for the given part as an array reference containing
4997: strings naming the response IDs. This may be empty.
1.187 bowersj2 4998:
1.51 bowersj2 4999: =back
5000:
5001: =cut
5002:
5003: sub parts {
5004: my $self = shift;
5005:
1.192 bowersj2 5006: if ($self->ext) { return []; }
1.67 bowersj2 5007:
1.51 bowersj2 5008: $self->extractParts();
5009: return $self->{PARTS};
5010: }
5011:
5012: sub countParts {
5013: my $self = shift;
5014:
5015: my $parts = $self->parts();
1.191 bowersj2 5016:
5017: # If I left this here, then it's not necessary.
5018: #my $delta = 0;
5019: #for my $part (@$parts) {
5020: # if ($part eq '0') { $delta--; }
5021: #}
1.66 bowersj2 5022:
5023: if ($self->{RESOURCE_ERROR}) {
5024: return 0;
5025: }
5026:
1.191 bowersj2 5027: return scalar(@{$parts}); # + $delta;
1.192 bowersj2 5028: }
5029:
1.290 matthew 5030: sub countResponses {
5031: my $self = shift;
5032: my $count;
1.293 matthew 5033: foreach my $part (@{$self->parts()}) {
5034: $count+= scalar($self->responseIds($part));
1.290 matthew 5035: }
5036: return $count;
5037: }
5038:
5039: sub responseTypes {
5040: my $self = shift;
1.291 albertel 5041: my %responses;
1.368 raeburn 5042: foreach my $part (@{$self->parts()}) {
1.290 matthew 5043: foreach my $responsetype ($self->responseType($part)) {
1.291 albertel 5044: $responses{$responsetype}++ if (defined($responsetype));
1.290 matthew 5045: }
5046: }
1.291 albertel 5047: return %responses;
1.290 matthew 5048: }
5049:
1.192 bowersj2 5050: sub multipart {
5051: my $self = shift;
5052: return $self->countParts() > 1;
1.51 bowersj2 5053: }
5054:
1.225 bowersj2 5055: sub singlepart {
5056: my $self = shift;
5057: return $self->countParts() == 1;
5058: }
5059:
1.187 bowersj2 5060: sub responseType {
1.184 bowersj2 5061: my $self = shift;
5062: my $part = shift;
5063:
5064: $self->extractParts();
1.235 albertel 5065: if (defined($self->{RESPONSE_TYPES}->{$part})) {
5066: return @{$self->{RESPONSE_TYPES}->{$part}};
5067: } else {
5068: return undef;
5069: }
1.187 bowersj2 5070: }
5071:
1.193 bowersj2 5072: sub responseIds {
1.187 bowersj2 5073: my $self = shift;
5074: my $part = shift;
5075:
5076: $self->extractParts();
1.235 albertel 5077: if (defined($self->{RESPONSE_IDS}->{$part})) {
5078: return @{$self->{RESPONSE_IDS}->{$part}};
5079: } else {
5080: return undef;
5081: }
1.184 bowersj2 5082: }
5083:
5084: # Private function: Extracts the parts information, both part names and
1.187 bowersj2 5085: # part types, and saves it.
1.51 bowersj2 5086: sub extractParts {
5087: my $self = shift;
5088:
1.153 bowersj2 5089: return if (defined($self->{PARTS}));
1.67 bowersj2 5090: return if ($self->ext);
1.51 bowersj2 5091:
5092: $self->{PARTS} = [];
5093:
1.181 bowersj2 5094: my %parts;
5095:
1.82 bowersj2 5096: # Retrieve part count, if this is a problem
5097: if ($self->is_problem()) {
1.240 albertel 5098: my $partorder = &Apache::lonnet::metadata($self->src(), 'partorder');
1.152 matthew 5099: my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
1.181 bowersj2 5100:
1.239 bowersj2 5101: if ($partorder) {
5102: my @parts;
5103: for my $part (split (/,/,$partorder)) {
1.508 damieng 5104: if (!Apache::loncommon::check_if_partid_hidden($part, $self->{SYMB})) {
1.239 bowersj2 5105: push @parts, $part;
1.241 albertel 5106: $parts{$part} = 1;
1.239 bowersj2 5107: }
5108: }
5109: $self->{PARTS} = \@parts;
5110: } else {
5111: if (!$metadata) {
5112: $self->{RESOURCE_ERROR} = 1;
5113: $self->{PARTS} = [];
5114: $self->{PART_TYPE} = {};
5115: return;
5116: }
1.394 raeburn 5117: foreach my $entry (split(/\,/,$metadata)) {
5118: if ($entry =~ /^(?:part|Task)_(.*)$/) {
1.239 bowersj2 5119: my $part = $1;
5120: # This floods the logs if it blows up
5121: if (defined($parts{$part})) {
1.508 damieng 5122: &Apache::lonnet::logthis("$part multiply defined in metadata for " . $self->{SYMB});
1.241 albertel 5123: }
1.239 bowersj2 5124:
5125: # check to see if part is turned off.
5126:
1.508 damieng 5127: if (!Apache::loncommon::check_if_partid_hidden($part, $self->{SYMB})) {
1.239 bowersj2 5128: $parts{$part} = 1;
5129: }
5130: }
5131: }
1.504 raeburn 5132: my @sortedParts = sort(keys(%parts));
1.239 bowersj2 5133: $self->{PARTS} = \@sortedParts;
1.51 bowersj2 5134: }
1.82 bowersj2 5135:
1.187 bowersj2 5136:
1.284 matthew 5137: # These hashes probably do not need names that end with "Hash"....
1.187 bowersj2 5138: my %responseIdHash;
5139: my %responseTypeHash;
5140:
1.189 bowersj2 5141:
5142: # Init the responseIdHash
1.394 raeburn 5143: foreach my $part (@{$self->{PARTS}}) {
5144: $responseIdHash{$part} = [];
1.189 bowersj2 5145: }
5146:
1.187 bowersj2 5147: # Now, the unfortunate thing about this is that parts, part name, and
1.239 bowersj2 5148: # response id are delimited by underscores, but both the part
1.187 bowersj2 5149: # name and response id can themselves have underscores in them.
5150: # So we have to use our knowlege of part names to figure out
5151: # where the part names begin and end, and even then, it is possible
5152: # to construct ambiguous situations.
1.504 raeburn 5153: foreach my $data (split(/,/, $metadata)) {
1.379 albertel 5154: if ($data =~ /^([a-zA-Z]+)response_(.*)/
5155: || $data =~ /^(Task)_(.*)/) {
1.187 bowersj2 5156: my $responseType = $1;
5157: my $partStuff = $2;
5158: my $partIdSoFar = '';
1.504 raeburn 5159: my @partChunks = split(/_/, $partStuff);
1.187 bowersj2 5160: my $i = 0;
5161: for ($i = 0; $i < scalar(@partChunks); $i++) {
5162: if ($partIdSoFar) { $partIdSoFar .= '_'; }
5163: $partIdSoFar .= $partChunks[$i];
5164: if ($parts{$partIdSoFar}) {
5165: my @otherChunks = @partChunks[$i+1..$#partChunks];
5166: my $responseId = join('_', @otherChunks);
1.379 albertel 5167: if ($self->is_task()) {
5168: push(@{$responseIdHash{$partIdSoFar}},
5169: $partIdSoFar);
5170: } else {
5171: push(@{$responseIdHash{$partIdSoFar}},
5172: $responseId);
5173: }
5174: push(@{$responseTypeHash{$partIdSoFar}},
5175: $responseType);
1.187 bowersj2 5176: }
5177: }
5178: }
5179: }
1.264 albertel 5180: my $resorder = &Apache::lonnet::metadata($self->src(),'responseorder');
1.284 matthew 5181: #
5182: # Reorder the arrays in the %responseIdHash and %responseTypeHash
1.264 albertel 5183: if ($resorder) {
5184: my @resorder=split(/,/,$resorder);
5185: foreach my $part (keys(%responseIdHash)) {
1.286 albertel 5186: my $i=0;
5187: my %resids = map { ($_,$i++) } @{ $responseIdHash{$part} };
1.264 albertel 5188: my @neworder;
5189: foreach my $possibleid (@resorder) {
5190: if (exists($resids{$possibleid})) {
1.286 albertel 5191: push(@neworder,$resids{$possibleid});
1.264 albertel 5192: }
5193: }
1.286 albertel 5194: my @ids;
5195: my @type;
5196: foreach my $element (@neworder) {
5197: push (@ids,$responseIdHash{$part}->[$element]);
5198: push (@type,$responseTypeHash{$part}->[$element]);
5199: }
5200: $responseIdHash{$part}=\@ids;
5201: $responseTypeHash{$part}=\@type;
1.264 albertel 5202: }
5203: }
1.187 bowersj2 5204: $self->{RESPONSE_IDS} = \%responseIdHash;
5205: $self->{RESPONSE_TYPES} = \%responseTypeHash;
1.154 bowersj2 5206: }
5207:
1.51 bowersj2 5208: return;
5209: }
5210:
5211: =pod
5212:
5213: =head2 Resource Status
5214:
1.174 albertel 5215: Problem resources have status information, reflecting their various
5216: dates and completion statuses.
1.51 bowersj2 5217:
1.174 albertel 5218: There are two aspects to the status: the date-related information and
5219: the completion information.
1.51 bowersj2 5220:
1.174 albertel 5221: Idiomatic usage of these two methods would probably look something
5222: like
1.51 bowersj2 5223:
1.394 raeburn 5224: foreach my $part ($resource->parts()) {
5225: my $dateStatus = $resource->getDateStatus($part);
5226: my $completionStatus = $resource->getCompletionStatus($part);
1.51 bowersj2 5227:
1.70 bowersj2 5228: or
5229:
1.394 raeburn 5230: my $status = $resource->status($part);
1.70 bowersj2 5231:
1.51 bowersj2 5232: ... use it here ...
5233: }
5234:
1.174 albertel 5235: Which you use depends on exactly what you are looking for. The
5236: status() function has been optimized for the nav maps display and may
5237: not precisely match what you need elsewhere.
1.101 bowersj2 5238:
1.174 albertel 5239: The symbolic constants shown below can be accessed through the
5240: resource object: C<$res->OPEN>.
1.101 bowersj2 5241:
1.51 bowersj2 5242: =over 4
5243:
1.174 albertel 5244: =item * B<getDateStatus>($part):
5245:
5246: ($part defaults to 0). A convenience function that returns a symbolic
5247: constant telling you about the date status of the part. The possible
5248: return values are:
1.51 bowersj2 5249:
5250: =back
5251:
5252: B<Date Codes>
5253:
5254: =over 4
5255:
1.174 albertel 5256: =item * B<OPEN_LATER>:
5257:
5258: The problem will be opened later.
5259:
5260: =item * B<OPEN>:
5261:
5262: Open and not yet due.
5263:
1.51 bowersj2 5264:
1.174 albertel 5265: =item * B<PAST_DUE_ANSWER_LATER>:
1.51 bowersj2 5266:
1.174 albertel 5267: The due date has passed, but the answer date has not yet arrived.
1.59 bowersj2 5268:
1.174 albertel 5269: =item * B<PAST_DUE_NO_ANSWER>:
1.54 bowersj2 5270:
1.174 albertel 5271: The due date has passed and there is no answer opening date set.
1.51 bowersj2 5272:
1.174 albertel 5273: =item * B<ANSWER_OPEN>:
1.51 bowersj2 5274:
1.174 albertel 5275: The answer date is here.
5276:
5277: =item * B<NETWORK_FAILURE>:
5278:
5279: The information is unknown due to network failure.
1.51 bowersj2 5280:
5281: =back
5282:
5283: =cut
5284:
5285: # Apparently the compiler optimizes these into constants automatically
1.54 bowersj2 5286: sub OPEN_LATER { return 0; }
5287: sub OPEN { return 1; }
5288: sub PAST_DUE_NO_ANSWER { return 2; }
5289: sub PAST_DUE_ANSWER_LATER { return 3; }
5290: sub ANSWER_OPEN { return 4; }
1.432 raeburn 5291: sub NOTHING_SET { return 5; }
1.54 bowersj2 5292: sub NETWORK_FAILURE { return 100; }
5293:
5294: # getDateStatus gets the date status for a given problem part.
5295: # Because answer date, due date, and open date are fully independent
5296: # (i.e., it is perfectly possible to *only* have an answer date),
5297: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
5298: # (past, future, none given). This function handles this with a decision
5299: # tree. Read the comments to follow the decision tree.
1.51 bowersj2 5300:
5301: sub getDateStatus {
5302: my $self = shift;
5303: my $part = shift;
5304: $part = "0" if (!defined($part));
1.54 bowersj2 5305:
5306: # Always return network failure if there was one.
1.51 bowersj2 5307: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
5308:
5309: my $now = time();
5310:
1.53 bowersj2 5311: my $open = $self->opendate($part);
5312: my $due = $self->duedate($part);
5313: my $answer = $self->answerdate($part);
5314:
5315: if (!$open && !$due && !$answer) {
5316: # no data on the problem at all
5317: # should this be the same as "open later"? think multipart.
5318: return $self->NOTHING_SET;
5319: }
1.59 bowersj2 5320: if (!$open || $now < $open) {return $self->OPEN_LATER}
5321: if (!$due || $now < $due) {return $self->OPEN}
5322: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
5323: if ($answer) { return $self->ANSWER_OPEN; }
1.54 bowersj2 5324: return PAST_DUE_NO_ANSWER;
1.51 bowersj2 5325: }
5326:
5327: =pod
5328:
5329: B<>
5330:
5331: =over 4
5332:
1.174 albertel 5333: =item * B<getCompletionStatus>($part):
1.51 bowersj2 5334:
1.174 albertel 5335: ($part defaults to 0.) A convenience function that returns a symbolic
5336: constant telling you about the completion status of the part, with the
5337: following possible results:
5338:
5339: =back
1.51 bowersj2 5340:
5341: B<Completion Codes>
5342:
5343: =over 4
5344:
1.174 albertel 5345: =item * B<NOT_ATTEMPTED>:
5346:
5347: Has not been attempted at all.
5348:
5349: =item * B<INCORRECT>:
5350:
5351: Attempted, but wrong by student.
1.51 bowersj2 5352:
1.174 albertel 5353: =item * B<INCORRECT_BY_OVERRIDE>:
1.51 bowersj2 5354:
1.174 albertel 5355: Attempted, but wrong by instructor override.
1.51 bowersj2 5356:
1.174 albertel 5357: =item * B<CORRECT>:
1.51 bowersj2 5358:
1.174 albertel 5359: Correct or correct by instructor.
1.51 bowersj2 5360:
1.174 albertel 5361: =item * B<CORRECT_BY_OVERRIDE>:
1.51 bowersj2 5362:
1.174 albertel 5363: Correct by instructor override.
1.51 bowersj2 5364:
1.174 albertel 5365: =item * B<EXCUSED>:
5366:
5367: Excused. Not yet implemented.
5368:
5369: =item * B<NETWORK_FAILURE>:
5370:
5371: Information not available due to network failure.
5372:
5373: =item * B<ATTEMPTED>:
5374:
5375: Attempted, and not yet graded.
1.69 bowersj2 5376:
1.450 raeburn 5377: =item * B<CREDIT_ATTEMPTED>:
5378:
5379: Attempted, and credit received for attempt (survey and anonymous survey only).
5380:
1.51 bowersj2 5381: =back
5382:
5383: =cut
5384:
1.53 bowersj2 5385: sub NOT_ATTEMPTED { return 10; }
5386: sub INCORRECT { return 11; }
5387: sub INCORRECT_BY_OVERRIDE { return 12; }
5388: sub CORRECT { return 13; }
5389: sub CORRECT_BY_OVERRIDE { return 14; }
5390: sub EXCUSED { return 15; }
1.69 bowersj2 5391: sub ATTEMPTED { return 16; }
1.450 raeburn 5392: sub CREDIT_ATTEMPTED { return 17; }
1.51 bowersj2 5393:
5394: sub getCompletionStatus {
5395: my $self = shift;
1.332 albertel 5396: my $part = shift;
1.51 bowersj2 5397: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
5398:
1.332 albertel 5399: my $status = $self->queryRestoreHash('solved', $part);
1.51 bowersj2 5400:
1.251 www 5401: # Left as separate if statements in case we ever do more with this
1.51 bowersj2 5402: if ($status eq 'correct_by_student') {return $self->CORRECT;}
1.288 albertel 5403: if ($status eq 'correct_by_scantron') {return $self->CORRECT;}
1.332 albertel 5404: if ($status eq 'correct_by_override') {
5405: return $self->CORRECT_BY_OVERRIDE;
5406: }
1.51 bowersj2 5407: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
5408: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
5409: if ($status eq 'excused') {return $self->EXCUSED; }
1.69 bowersj2 5410: if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
1.450 raeburn 5411: if ($status eq 'credit_attempted') {
5412: if ($self->is_anonsurvey($part) || $self->is_survey($part)) {
5413: return $self->CREDIT_ATTEMPTED;
5414: } else {
5415: return $self->ATTEMPTED;
5416: }
5417: }
1.51 bowersj2 5418: return $self->NOT_ATTEMPTED;
1.108 bowersj2 5419: }
5420:
5421: sub queryRestoreHash {
5422: my $self = shift;
5423: my $hashentry = shift;
5424: my $part = shift;
1.185 bowersj2 5425: $part = "0" if (!defined($part) || $part eq '');
1.108 bowersj2 5426: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
5427:
5428: $self->getReturnHash();
5429:
5430: return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry};
1.51 bowersj2 5431: }
5432:
5433: =pod
5434:
5435: B<Composite Status>
5436:
1.174 albertel 5437: Along with directly returning the date or completion status, the
5438: resource object includes a convenience function B<status>() that will
5439: combine the two status tidbits into one composite status that can
1.191 bowersj2 5440: represent the status of the resource as a whole. This method represents
5441: the concept of the thing we want to display to the user on the nav maps
5442: screen, which is a combination of completion and open status. The precise logic is
1.174 albertel 5443: documented in the comments of the status method. The following results
5444: may be returned, all available as methods on the resource object
1.185 bowersj2 5445: ($res->NETWORK_FAILURE): In addition to the return values that match
5446: the date or completion status, this function can return "ANSWER_SUBMITTED"
5447: if that problemstatus parameter value is set to No, suppressing the
5448: incorrect/correct feedback.
1.51 bowersj2 5449:
5450: =over 4
5451:
1.174 albertel 5452: =item * B<NETWORK_FAILURE>:
5453:
5454: The network has failed and the information is not available.
1.51 bowersj2 5455:
1.174 albertel 5456: =item * B<NOTHING_SET>:
1.53 bowersj2 5457:
1.174 albertel 5458: No dates have been set for this problem (part) at all. (Because only
5459: certain parts of a multi-part problem may be assigned, this can not be
5460: collapsed into "open later", as we do not know a given part will EVER
5461: be opened. For single part, this is the same as "OPEN_LATER".)
1.51 bowersj2 5462:
1.174 albertel 5463: =item * B<CORRECT>:
1.51 bowersj2 5464:
1.174 albertel 5465: For any reason at all, the part is considered correct.
1.54 bowersj2 5466:
1.174 albertel 5467: =item * B<EXCUSED>:
1.51 bowersj2 5468:
1.174 albertel 5469: For any reason at all, the problem is excused.
1.51 bowersj2 5470:
1.174 albertel 5471: =item * B<PAST_DUE_NO_ANSWER>:
1.51 bowersj2 5472:
1.174 albertel 5473: The problem is past due, not considered correct, and no answer date is
5474: set.
1.51 bowersj2 5475:
1.174 albertel 5476: =item * B<PAST_DUE_ANSWER_LATER>:
1.51 bowersj2 5477:
1.174 albertel 5478: The problem is past due, not considered correct, and an answer date in
5479: the future is set.
1.51 bowersj2 5480:
1.174 albertel 5481: =item * B<ANSWER_OPEN>:
5482:
5483: The problem is past due, not correct, and the answer is now available.
5484:
5485: =item * B<OPEN_LATER>:
5486:
5487: The problem is not yet open.
5488:
5489: =item * B<TRIES_LEFT>:
5490:
5491: The problem is open, has been tried, is not correct, but there are
5492: tries left.
5493:
5494: =item * B<INCORRECT>:
5495:
5496: The problem is open, and all tries have been used without getting the
5497: correct answer.
5498:
5499: =item * B<OPEN>:
5500:
5501: The item is open and not yet tried.
5502:
5503: =item * B<ATTEMPTED>:
5504:
5505: The problem has been attempted.
1.69 bowersj2 5506:
1.450 raeburn 5507: =item * B<CREDIT_ATTEMPTED>:
5508:
5509: The problem has been attempted, and credit given for the attempt (survey and anonymous survey only).
5510:
1.185 bowersj2 5511: =item * B<ANSWER_SUBMITTED>:
5512:
5513: An answer has been submitted, but the student should not see it.
5514:
1.51 bowersj2 5515: =back
5516:
5517: =cut
5518:
1.432 raeburn 5519: sub TRIES_LEFT { return 20; }
5520: sub ANSWER_SUBMITTED { return 21; }
5521: sub PARTIALLY_CORRECT { return 22; }
5522:
5523: sub RESERVED_LATER { return 30; }
5524: sub RESERVED { return 31; }
5525: sub RESERVED_LOCATION { return 32; }
5526: sub RESERVABLE { return 33; }
5527: sub RESERVABLE_LATER { return 34; }
5528: sub NOTRESERVABLE { return 35; }
5529: sub NOT_IN_A_SLOT { return 36; }
5530: sub NEEDS_CHECKIN { return 37; }
5531: sub WAITING_FOR_GRADE { return 38; }
5532: sub UNKNOWN { return 39; }
1.51 bowersj2 5533:
5534: sub status {
5535: my $self = shift;
5536: my $part = shift;
5537: if (!defined($part)) { $part = "0"; }
5538: my $completionStatus = $self->getCompletionStatus($part);
5539: my $dateStatus = $self->getDateStatus($part);
5540:
5541: # What we have is a two-dimensional matrix with 4 entries on one
5542: # dimension and 5 entries on the other, which we want to colorize,
1.54 bowersj2 5543: # plus network failure and "no date data at all".
1.51 bowersj2 5544:
1.222 bowersj2 5545: #if ($self->{RESOURCE_ERROR}) { return NETWORK_FAILURE; }
1.53 bowersj2 5546: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
1.51 bowersj2 5547:
1.408 raeburn 5548: my $suppressFeedback = 0;
5549: if (($self->problemstatus($part) eq 'no') ||
5550: ($self->problemstatus($part) eq 'no_feedback_ever')) {
5551: $suppressFeedback = 1;
5552: }
1.236 bowersj2 5553: # If there's an answer date and we're past it, don't
5554: # suppress the feedback; student should know
1.330 albertel 5555: if ($self->duedate($part) && $self->duedate($part) < time() &&
5556: $self->answerdate($part) && $self->answerdate($part) < time()) {
1.236 bowersj2 5557: $suppressFeedback = 0;
5558: }
1.185 bowersj2 5559:
1.51 bowersj2 5560: # There are a few whole rows we can dispose of:
1.53 bowersj2 5561: if ($completionStatus == CORRECT ||
5562: $completionStatus == CORRECT_BY_OVERRIDE ) {
1.332 albertel 5563: if ( $suppressFeedback ) { return ANSWER_SUBMITTED }
5564: my $awarded=$self->awarded($part);
5565: if ($awarded < 1 && $awarded > 0) {
5566: return PARTIALLY_CORRECT;
5567: } elsif ($awarded<1) {
5568: return INCORRECT;
5569: }
5570: return CORRECT;
1.69 bowersj2 5571: }
5572:
1.343 albertel 5573: # If it's WRONG... and not open
5574: if ( ($completionStatus == INCORRECT ||
5575: $completionStatus == INCORRECT_BY_OVERRIDE)
5576: && (!$self->opendate($part) || $self->opendate($part) > time()) ) {
5577: return INCORRECT;
5578: }
5579:
1.69 bowersj2 5580: if ($completionStatus == ATTEMPTED) {
5581: return ATTEMPTED;
1.53 bowersj2 5582: }
5583:
1.450 raeburn 5584: if ($completionStatus == CREDIT_ATTEMPTED) {
5585: return CREDIT_ATTEMPTED;
5586: }
5587:
1.53 bowersj2 5588: # If it's EXCUSED, then return that no matter what
5589: if ($completionStatus == EXCUSED) {
5590: return EXCUSED;
1.51 bowersj2 5591: }
5592:
1.53 bowersj2 5593: if ($dateStatus == NOTHING_SET) {
5594: return NOTHING_SET;
1.51 bowersj2 5595: }
5596:
1.69 bowersj2 5597: # Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
5598: # by 4 matrix (date statuses).
1.51 bowersj2 5599:
1.54 bowersj2 5600: if ($dateStatus == PAST_DUE_ANSWER_LATER ||
1.59 bowersj2 5601: $dateStatus == PAST_DUE_NO_ANSWER ) {
1.272 albertel 5602: return $suppressFeedback ? ANSWER_SUBMITTED : $dateStatus;
1.51 bowersj2 5603: }
5604:
1.53 bowersj2 5605: if ($dateStatus == ANSWER_OPEN) {
5606: return ANSWER_OPEN;
1.51 bowersj2 5607: }
5608:
5609: # Now: (incorrect, incorrect_override, not_attempted) x
5610: # (open_later), (open)
5611:
1.53 bowersj2 5612: if ($dateStatus == OPEN_LATER) {
5613: return OPEN_LATER;
1.51 bowersj2 5614: }
5615:
5616: # If it's WRONG...
1.53 bowersj2 5617: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
1.51 bowersj2 5618: # and there are TRIES LEFT:
1.79 bowersj2 5619: if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) {
1.222 bowersj2 5620: return $suppressFeedback ? ANSWER_SUBMITTED : TRIES_LEFT;
1.51 bowersj2 5621: }
1.185 bowersj2 5622: return $suppressFeedback ? ANSWER_SUBMITTED : INCORRECT; # otherwise, return orange; student can't fix this
1.51 bowersj2 5623: }
5624:
5625: # Otherwise, it's untried and open
1.473 raeburn 5626: return OPEN;
1.224 bowersj2 5627: }
5628:
1.432 raeburn 5629: sub check_for_slot {
5630: my $self = shift;
5631: my $part = shift;
1.508 damieng 5632: my $symb = $self->{SYMB};
1.432 raeburn 5633: my ($use_slots,$available,$availablestudent) = $self->slot_control($part);
5634: if (($use_slots ne '') && ($use_slots !~ /^\s*no\s*$/i)) {
5635: my @slots = (split(/:/,$availablestudent),split(/:/,$available));
5636: my $cid=$env{'request.course.id'};
5637: my $cdom=$env{'course.'.$cid.'.domain'};
5638: my $cnum=$env{'course.'.$cid.'.num'};
5639: my $now = time;
1.473 raeburn 5640: my $num_usable_slots = 0;
1.522 raeburn 5641: my ($checkedin,$checkedinslot,%consumed_uniq,%slots);
1.432 raeburn 5642: if (@slots > 0) {
1.522 raeburn 5643: %slots=&Apache::lonnet::get('slots',[@slots],$cdom,$cnum);
1.432 raeburn 5644: if (&Apache::lonnet::error(%slots)) {
5645: return (UNKNOWN);
5646: }
1.473 raeburn 5647: my @sorted_slots = &Apache::loncommon::sorted_slots(\@slots,\%slots,'starttime');
1.432 raeburn 5648: foreach my $slot_name (@sorted_slots) {
1.473 raeburn 5649: next if (!defined($slots{$slot_name}) || !ref($slots{$slot_name}));
1.432 raeburn 5650: my $end = $slots{$slot_name}->{'endtime'};
5651: my $start = $slots{$slot_name}->{'starttime'};
5652: my $ip = $slots{$slot_name}->{'ip'};
5653: if ($self->simpleStatus() == OPEN) {
5654: if ($end > $now) {
1.473 raeburn 5655: if ($start > $now) {
5656: return (RESERVED_LATER,$start,$slot_name);
5657: } else {
5658: if ($ip ne '') {
5659: if (!&Apache::loncommon::check_ip_acc($ip)) {
1.503 raeburn 5660: return (RESERVED_LOCATION,$end,$slot_name);
1.432 raeburn 5661: }
5662: }
1.473 raeburn 5663: my @proctors;
5664: if ($slots{$slot_name}->{'proctor'} ne '') {
5665: @proctors = split(',',$slots{$slot_name}->{'proctor'});
5666: }
5667: if (@proctors > 0) {
5668: ($checkedin,$checkedinslot) = $self->checkedin();
5669: unless ((grep(/^\Q$checkedin\E/,@proctors)) &&
5670: ($checkedinslot eq $slot_name)) {
5671: return (NEEDS_CHECKIN,undef,$slot_name);
1.472 raeburn 5672: }
1.432 raeburn 5673: }
1.473 raeburn 5674: return (RESERVED,$end,$slot_name);
1.432 raeburn 5675: }
5676: }
1.473 raeburn 5677: } elsif ($end > $now) {
5678: $num_usable_slots ++;
1.432 raeburn 5679: }
5680: }
1.522 raeburn 5681: my ($is_correct,$wait_for_grade);
1.432 raeburn 5682: if ($self->is_task()) {
5683: my $taskstatus = $self->taskstatus();
5684: $is_correct = (($taskstatus eq 'pass') ||
5685: ($self->solved() =~ /^correct_/));
1.522 raeburn 5686: unless ($taskstatus =~ /^(?:pass|fail)$/) {
5687: $wait_for_grade = 1;
5688: }
1.432 raeburn 5689: } else {
1.522 raeburn 5690: unless ($self->completable()) {
5691: $wait_for_grade = 1;
5692: }
5693: unless (($self->problemstatus($part) eq 'no') ||
5694: ($self->problemstatus($part) eq 'no_feedback_ever')) {
5695: $is_correct = ($self->solved($part) =~ /^correct_/);
5696: $wait_for_grade = 0;
5697: }
1.432 raeburn 5698: }
5699: ($checkedin,$checkedinslot) = $self->checkedin();
5700: if ($checkedin) {
1.522 raeburn 5701: if (ref($slots{$checkedinslot}) eq 'HASH') {
5702: $consumed_uniq{$checkedinslot} = $slots{$checkedinslot}{'uniqueperiod'};
5703: }
5704: if ($wait_for_grade) {
1.432 raeburn 5705: return (WAITING_FOR_GRADE);
5706: } elsif ($is_correct) {
5707: return (CORRECT);
5708: }
5709: }
1.473 raeburn 5710: if ($num_usable_slots) {
5711: return(NOT_IN_A_SLOT);
5712: }
5713: }
5714: my $reservable = &Apache::lonnet::get_reservable_slots($cnum,$cdom,$env{'user.name'},
5715: $env{'user.domain'});
5716: if (ref($reservable) eq 'HASH') {
1.511 raeburn 5717: my ($map) = &Apache::lonnet::decode_symb($symb);
1.473 raeburn 5718: if ((ref($reservable->{'now_order'}) eq 'ARRAY') && (ref($reservable->{'now'}) eq 'HASH')) {
1.474 raeburn 5719: foreach my $slot (reverse (@{$reservable->{'now_order'}})) {
1.510 raeburn 5720: my $canuse;
5721: if ($reservable->{'now'}{$slot}{'symb'} eq '') {
5722: $canuse = 1;
5723: } else {
5724: my %oksymbs;
5725: my @slotsymbs = split(/\s*,\s*/,$reservable->{'now'}{$slot}{'symb'});
5726: map { $oksymbs{$_} = 1; } @slotsymbs;
5727: if ($oksymbs{$symb}) {
5728: $canuse = 1;
5729: } else {
5730: foreach my $item (@slotsymbs) {
5731: if ($item =~ /\.(page|sequence)$/) {
5732: (undef,undef, my $sloturl) = &Apache::lonnet::decode_symb($item);
5733: if (($map ne '') && ($map eq $sloturl)) {
5734: $canuse = 1;
5735: last;
5736: }
5737: }
5738: }
5739: }
5740: }
5741: if ($canuse) {
1.522 raeburn 5742: if ($checkedin) {
5743: if (ref($consumed_uniq{$checkedinslot}) eq 'ARRAY') {
5744: my ($uniqstart,$uniqend)=@{$consumed_uniq{$checkedinslot}};
5745: if ($reservable->{'now'}{$slot}{'uniqueperiod'} =~ /^(\d+),(\d+)$/) {
5746: my ($new_uniq_start,$new_uniq_end) = ($1,$2);
5747: next if (!
5748: ($uniqstart < $new_uniq_start && $uniqend < $new_uniq_start) ||
5749: ($uniqstart > $new_uniq_end && $uniqend > $new_uniq_end ));
5750: }
5751: }
5752: }
1.473 raeburn 5753: return(RESERVABLE,$reservable->{'now'}{$slot}{'endreserve'});
5754: }
5755: }
1.432 raeburn 5756: }
1.473 raeburn 5757: if ((ref($reservable->{'future_order'}) eq 'ARRAY') && (ref($reservable->{'future'}) eq 'HASH')) {
1.474 raeburn 5758: foreach my $slot (@{$reservable->{'future_order'}}) {
1.510 raeburn 5759: my $canuse;
5760: if ($reservable->{'future'}{$slot}{'symb'} eq '') {
5761: $canuse = 1;
5762: } elsif ($reservable->{'future'}{$slot}{'symb'} =~ /,/) {
5763: my %oksymbs;
5764: my @slotsymbs = split(/\s*,\s*/,$reservable->{'future'}{$slot}{'symb'});
5765: map { $oksymbs{$_} = 1; } @slotsymbs;
5766: if ($oksymbs{$symb}) {
5767: $canuse = 1;
5768: } else {
5769: foreach my $item (@slotsymbs) {
5770: if ($item =~ /\.(page|sequence)$/) {
5771: (undef,undef, my $sloturl) = &Apache::lonnet::decode_symb($item);
5772: if (($map ne '') && ($map eq $sloturl)) {
5773: $canuse = 1;
5774: last;
5775: }
5776: }
5777: }
5778: }
5779: } elsif ($reservable->{'future'}{$slot}{'symb'} eq $symb) {
5780: $canuse = 1;
5781: }
5782: if ($canuse) {
1.522 raeburn 5783: if ($checkedin) {
5784: if (ref($consumed_uniq{$checkedinslot}) eq 'ARRAY') {
5785: my ($uniqstart,$uniqend)=@{$consumed_uniq{$checkedinslot}};
5786: if ($reservable->{'future'}{$slot}{'uniqueperiod'} =~ /^(\d+),(\d+)$/) {
5787: my ($new_uniq_start,$new_uniq_end) = ($1,$2);
5788: next if (!
5789: ($uniqstart < $new_uniq_start && $uniqend < $new_uniq_start) ||
5790: ($uniqstart > $new_uniq_end && $uniqend > $new_uniq_end ));
5791: }
5792: }
5793: }
1.473 raeburn 5794: return(RESERVABLE_LATER,$reservable->{'future'}{$slot}{'startreserve'});
5795: }
5796: }
1.432 raeburn 5797: }
5798: }
1.473 raeburn 5799: return(NOTRESERVABLE);
1.432 raeburn 5800: }
5801: return;
5802: }
5803:
1.224 bowersj2 5804: sub CLOSED { return 23; }
5805: sub ERROR { return 24; }
5806:
5807: =pod
5808:
5809: B<Simple Status>
5810:
5811: Convenience method B<simpleStatus> provides a "simple status" for the resource.
5812: "Simple status" corresponds to "which icon is shown on the
5813: Navmaps". There are six "simple" statuses:
5814:
5815: =over 4
5816:
5817: =item * B<CLOSED>: The problem is currently closed. (No icon shown.)
5818:
5819: =item * B<OPEN>: The problem is open and unattempted.
5820:
5821: =item * B<CORRECT>: The problem is correct for any reason.
5822:
5823: =item * B<INCORRECT>: The problem is incorrect and can still be
5824: completed successfully.
5825:
5826: =item * B<ATTEMPTED>: The problem has been attempted, but the student
5827: does not know if they are correct. (The ellipsis icon.)
5828:
5829: =item * B<ERROR>: There is an error retrieving information about this
5830: problem.
5831:
5832: =back
5833:
5834: =cut
5835:
5836: # This hash maps the composite status to this simple status, and
5837: # can be used directly, if you like
5838: my %compositeToSimple =
5839: (
5840: NETWORK_FAILURE() => ERROR,
5841: NOTHING_SET() => CLOSED,
5842: CORRECT() => CORRECT,
1.332 albertel 5843: PARTIALLY_CORRECT() => PARTIALLY_CORRECT,
1.224 bowersj2 5844: EXCUSED() => CORRECT,
5845: PAST_DUE_NO_ANSWER() => INCORRECT,
5846: PAST_DUE_ANSWER_LATER() => INCORRECT,
5847: ANSWER_OPEN() => INCORRECT,
5848: OPEN_LATER() => CLOSED,
5849: TRIES_LEFT() => OPEN,
5850: INCORRECT() => INCORRECT,
5851: OPEN() => OPEN,
5852: ATTEMPTED() => ATTEMPTED,
1.450 raeburn 5853: CREDIT_ATTEMPTED() => CORRECT,
1.224 bowersj2 5854: ANSWER_SUBMITTED() => ATTEMPTED
5855: );
5856:
5857: sub simpleStatus {
5858: my $self = shift;
5859: my $part = shift;
5860: my $status = $self->status($part);
5861: return $compositeToSimple{$status};
1.225 bowersj2 5862: }
5863:
5864: =pod
5865:
5866: B<simpleStatusCount> will return an array reference containing, in
5867: this order, the number of OPEN, CLOSED, CORRECT, INCORRECT, ATTEMPTED,
5868: and ERROR parts the given problem has.
5869:
5870: =cut
5871:
5872: # This maps the status to the slot we want to increment
5873: my %statusToSlotMap =
5874: (
5875: OPEN() => 0,
5876: CLOSED() => 1,
5877: CORRECT() => 2,
5878: INCORRECT() => 3,
5879: ATTEMPTED() => 4,
5880: ERROR() => 5
5881: );
5882:
5883: sub statusToSlot { return $statusToSlotMap{shift()}; }
5884:
5885: sub simpleStatusCount {
5886: my $self = shift;
5887:
5888: my @counts = (0, 0, 0, 0, 0, 0, 0);
5889: foreach my $part (@{$self->parts()}) {
5890: $counts[$statusToSlotMap{$self->simpleStatus($part)}]++;
5891: }
5892:
5893: return \@counts;
1.191 bowersj2 5894: }
5895:
5896: =pod
5897:
5898: B<Completable>
5899:
5900: The completable method represents the concept of I<whether the student can
5901: currently do the problem>. If the student can do the problem, which means
5902: that it is open, there are tries left, and if the problem is manually graded
5903: or the grade is suppressed via problemstatus, the student has not tried it
5904: yet, then the method returns 1. Otherwise, it returns 0, to indicate that
5905: either the student has tried it and there is no feedback, or that for
5906: some reason it is no longer completable (not open yet, successfully completed,
5907: out of tries, etc.). As an example, this is used as the filter for the
5908: "Uncompleted Homework" option for the nav maps.
5909:
5910: If this does not quite meet your needs, do not fiddle with it (unless you are
5911: fixing it to better match the student's conception of "completable" because
5912: it's broken somehow)... make a new method.
5913:
5914: =cut
5915:
5916: sub completable {
5917: my $self = shift;
5918: if (!$self->is_problem()) { return 0; }
5919: my $partCount = $self->countParts();
5920:
5921: foreach my $part (@{$self->parts()}) {
5922: if ($part eq '0' && $partCount != 1) { next; }
5923: my $status = $self->status($part);
5924: # "If any of the parts are open, or have tries left (implies open),
5925: # and it is not "attempted" (manually graded problem), it is
5926: # not "complete"
1.216 bowersj2 5927: if ($self->getCompletionStatus($part) == ATTEMPTED() ||
1.450 raeburn 5928: $self->getCompletionStatus($part) == CREDIT_ATTEMPTED() ||
1.216 bowersj2 5929: $status == ANSWER_SUBMITTED() ) {
5930: # did this part already, as well as we can
5931: next;
5932: }
5933: if ($status == OPEN() || $status == TRIES_LEFT()) {
5934: return 1;
5935: }
1.191 bowersj2 5936: }
5937:
5938: # If all the parts were complete, so was this problem.
1.216 bowersj2 5939: return 0;
1.51 bowersj2 5940: }
5941:
5942: =pod
5943:
1.507 raeburn 5944: B<Answerable>
5945:
5946: The answerable method differs from the completable method in its handling of problem parts
5947: for which feedback on correctness is suppressed, but the student still has tries left, and
5948: the problem part is not past due, (i.e., the student could submit a different answer if
5949: he/she so chose). For that case completable will return 0, whereas answerable will return 1.
5950:
5951: =cut
5952:
5953: sub answerable {
5954: my $self = shift;
5955: if (!$self->is_problem()) { return 0; }
5956: my $partCount = $self->countParts();
5957: foreach my $part (@{$self->parts()}) {
5958: if ($part eq '0' && $partCount != 1) { next; }
5959: my $status = $self->status($part);
5960: if ($self->getCompletionStatus($part) == ATTEMPTED() ||
5961: $self->getCompletionStatus($part) == CREDIT_ATTEMPTED() ||
5962: $status == ANSWER_SUBMITTED() ) {
5963: if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) {
5964: return 1;
5965: }
5966: }
5967: if ($status == OPEN() || $status == TRIES_LEFT() || $status == NETWORK_FAILURE()) {
5968: return 1;
5969: }
5970: }
5971: # None of the parts were answerable, so neither is this problem.
5972: return 0;
5973: }
5974:
5975: =pod
5976:
1.51 bowersj2 5977: =head2 Resource/Nav Map Navigation
5978:
5979: =over 4
5980:
1.174 albertel 5981: =item * B<getNext>():
5982:
5983: Retreive an array of the possible next resources after this
5984: one. Always returns an array, even in the one- or zero-element case.
5985:
5986: =item * B<getPrevious>():
1.85 bowersj2 5987:
1.174 albertel 5988: Retreive an array of the possible previous resources from this
5989: one. Always returns an array, even in the one- or zero-element case.
1.51 bowersj2 5990:
5991: =cut
5992:
5993: sub getNext {
5994: my $self = shift;
5995: my @branches;
5996: my $to = $self->to();
1.85 bowersj2 5997: foreach my $branch ( split(/,/, $to) ) {
1.51 bowersj2 5998: my $choice = $self->{NAV_MAP}->getById($branch);
1.342 albertel 5999: #if (!$choice->condition()) { next; }
1.51 bowersj2 6000: my $next = $choice->goesto();
6001: $next = $self->{NAV_MAP}->getById($next);
6002:
1.131 bowersj2 6003: push @branches, $next;
1.85 bowersj2 6004: }
6005: return \@branches;
6006: }
6007:
6008: sub getPrevious {
6009: my $self = shift;
6010: my @branches;
6011: my $from = $self->from();
1.504 raeburn 6012: foreach my $branch ( split(/,/, $from)) {
1.85 bowersj2 6013: my $choice = $self->{NAV_MAP}->getById($branch);
6014: my $prev = $choice->comesfrom();
6015: $prev = $self->{NAV_MAP}->getById($prev);
6016:
1.131 bowersj2 6017: push @branches, $prev;
1.51 bowersj2 6018: }
6019: return \@branches;
1.131 bowersj2 6020: }
6021:
6022: sub browsePriv {
6023: my $self = shift;
1.505 raeburn 6024: my $noblockcheck = shift;
1.131 bowersj2 6025: if (defined($self->{BROWSE_PRIV})) {
6026: return $self->{BROWSE_PRIV};
6027: }
6028:
1.311 albertel 6029: $self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre',$self->src(),
1.508 damieng 6030: $self->{SYMB},undef,
1.505 raeburn 6031: undef,$noblockcheck);
1.51 bowersj2 6032: }
6033:
6034: =pod
1.2 www 6035:
1.51 bowersj2 6036: =back
1.2 www 6037:
1.51 bowersj2 6038: =cut
1.2 www 6039:
1.51 bowersj2 6040: 1;
1.2 www 6041:
1.51 bowersj2 6042: __END__
1.2 www 6043:
6044:
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