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