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