Annotation of loncom/interface/lonnavmaps.pm, revision 1.420

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>