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

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

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