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