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