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