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