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