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