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

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

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