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