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

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

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