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