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