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

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

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