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