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