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