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