--- loncom/interface/lonnavdisplay.pm 2009/05/19 13:56:07 1.12 +++ loncom/interface/lonnavdisplay.pm 2024/07/02 02:13:19 1.43 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA -# Navigate Maps Handler +# Navigate Maps Display Handler # -# $Id: lonnavdisplay.pm,v 1.12 2009/05/19 13:56:07 droeschl Exp $ +# $Id: lonnavdisplay.pm,v 1.43 2024/07/02 02:13:19 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -30,14 +30,16 @@ package Apache::lonnavdisplay; use strict; -use Apache::Constants qw(:common :http); +use Apache::Constants qw(:common :http REDIRECT); use Apache::lonmenu(); use Apache::loncommon(); use Apache::lonnavmaps(); use Apache::lonhtmlcommon(); use Apache::lonnet; use Apache::lonlocal; -use Time::HiRes qw( gettimeofday tv_interval ); +use Apache::londocs(); +use Apache::lonuserstate; +use LONCAPA::ltiutils; sub handler { my $r = shift; @@ -46,124 +48,144 @@ sub handler { sub real_handler { my $r = shift; - #my $t0=[&gettimeofday()]; # Handle header-only request if ($r->header_only) { - if ($env{'browser.mathml'}) { - &Apache::loncommon::content_type($r,'text/xml'); - } else { - &Apache::loncommon::content_type($r,'text/html'); - } + &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; return OK; } - # Send header, don't cache this page - if ($env{'browser.mathml'}) { - &Apache::loncommon::content_type($r,'text/xml'); - } else { + # Check for critical messages and redirect if present. + my ($redirect,$url) = &Apache::loncommon::critical_redirect(300,'contents'); + if ($redirect) { &Apache::loncommon::content_type($r,'text/html'); + $r->header_out(Location => $url); + return REDIRECT; } - &Apache::loncommon::no_cache($r); - my %toplinkitems=(); - &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'blank','', - "Select Action"); - if ($ENV{QUERY_STRING} eq 'collapseExternal') { - &Apache::lonnet::put('environment',{'remotenavmap' => 'off'}); - &Apache::lonnet::appenv({'environment.remotenavmap' => 'off'}); - my $menu=&Apache::lonmenu::reopenmenu(); - my $navstatus=&Apache::lonmenu::get_nav_status(); - if ($menu) { - $menu=(<send_http_header; - my $js =<<"ENDSUBM"; - -ENDSUBM - $r->print(&Apache::loncommon::start_page(undef,$js, - {'only_body' => 1, - 'bgcolor' => '#FFFFFF', - 'add_entries' => - {'onload' => - "submitthis()"}}). - &Apache::loncommon::end_page()); +# ------------------------------------------------------------ Get query string + &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['sort', + 'showOnlyHomework', + 'postsymb']); + # Check if course needs to be re-initialized + my $loncaparev = $r->dir_config('lonVersion'); + my ($result,@reinit) = &Apache::loncommon::needs_coursereinit($loncaparev); + my %prog_state=(); + my $closure; + if ($result eq 'switch') { + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + $r->print(&Apache::loncommon::check_release_result(@reinit)); return OK; } - if ($ENV{QUERY_STRING} =~ /^launchExternal/) { - &Apache::lonnet::put('environment',{'remotenavmap' => 'on'}); - &Apache::lonnet::appenv({'environment.remotenavmap' => 'on'}); - my $menu=&Apache::lonmenu::reopenmenu(); - my $navstatus=&Apache::lonmenu::get_nav_status(); - if ($menu) { - $r->print(< - swmenu=$menu - swmenu.clearTimeout(swmenu.menucltim); - $navstatus - -MENU - } - } - if ($ENV{QUERY_STRING} eq 'turningOffExternal') { - $env{'environment.remotenavmap'}='off'; + my ($cid,$cnum,$cdom); + if ($result) { + $cid = $env{'request.course.id'}; + $cnum = $env{'course.'.$cid.'.num'}; + $cdom = $env{'course.'.$cid.'.domain'}; + } + if (($result eq 'main') || ($result eq 'both')) { + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + &startpage($r); + my $preamble = '
'. + '
'. + &mt('Your course session is being updated because of recent changes by course personnel.'). + ' '.&mt('Please be patient').'.
'. + '
'; + $closure = < +// + +ENDCLOSE + %prog_state = &Apache::lonhtmlcommon::Create_PrgWin($r,undef,$preamble); + &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,&mt('Updating course')); + $r->rflush(); + my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum",\%prog_state,$r); + &Apache::lonhtmlcommon::Update_PrgWin($r,\%prog_state,&mt('Finished!')); + if ($ferr) { + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + $r->print($closure.&Apache::loncommon::end_page()); + my $requrl = $r->uri; + $env{'user.error.msg'}="$requrl:bre:0:0:Course not initialized"; + $env{'user.reinit'} = 1; + return HTTP_NOT_ACCEPTABLE; + } + } + if (($result eq 'both') || ($result eq 'supp')) { + my $possdel; + if ($result eq 'supp') { + $possdel = 1; + } + my ($supplemental,$refs_updated) = &Apache::loncommon::get_supplemental($cnum,$cdom,'',$possdel); + unless ($refs_updated) { + &Apache::loncommon::set_supp_httprefs($cnum,$cdom,$supplemental,$possdel); + } + } + + my $course_type = &Apache::loncommon::course_type(); + if (($course_type eq 'Placement') && (!$env{'request.role.adv'})) { + my $furl = &Apache::lonpageflip::first_accessible_resource(); + if ($result eq 'update') { + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + $r->print($closure.&Apache::loncommon::end_page()); + return OK; + } else { + unless ($furl eq '/adm/navmaps') { + &Apache::loncommon::content_type($r,'text/html'); + $r->header_out(Location => $furl); + return REDIRECT; + } + } + } + + if ($env{'request.lti.login'}) { + if ($env{'request.lti.uri'} ne '') { + my $cid = $env{'request.course.id'}; + my $cnum = $env{'course.'.$cid.'.num'}; + my $cdom = $env{'course.'.$cid.'.domain'}; + my ($scope,$url) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},$cdom,$cnum); + if (($scope eq 'map') || ($scope eq 'resource')) { + &Apache::loncommon::content_type($r,'text/html'); + $r->header_out(Location => $url); + return REDIRECT; + } + } } # Create the nav map my $navmap = Apache::lonnavmaps::navmap->new(); if (!defined($navmap)) { + if ($result eq 'update') { + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + $r->print($closure.&Apache::loncommon::end_page()); + } my $requrl = $r->uri; $env{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized"; $env{'user.reinit'} = 1; return HTTP_NOT_ACCEPTABLE; } - $r->send_http_header; -# ------------------------------------------------------------ Get query string - &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register','sort','showOnlyHomework','postsymb']); - -# ----------------------------------------------------- Force menu registration - my $body_only=''; - my $js; - if ($env{'environment.remotenavmap'} eq 'on') { - $js=''; - $body_only=1; + if ($result eq 'update') { + $r->rflush(); + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + $r->print($closure); + $r->rflush(); + } else { + # Send header, don't cache this page + &Apache::loncommon::content_type($r,'text/html'); + $r->send_http_header; + &startpage($r); } - # Header - my $course_type = &Apache::loncommon::course_type(); - $r->print(&Apache::loncommon::start_page(#'Navigate '.$course_type. - 'Course Contents', - $js, - {'only_body' => $body_only, - 'force_register' => $env{'form.register'}, - 'bread_crumbs' => [{text => mt('Course Content') }],})); - $r->print(''); - - $r->rflush(); + &startContentScreen($r,'navmaps',$course_type); + unless ($result eq 'update') { + $r->rflush(); + } # Check that it's defined if (!($navmap->courseMapDefined())) { @@ -174,21 +196,32 @@ MENU return OK; } - # See if there's only one map in the top-level, if we don't - # already have a filter... if so, automatically display it - # (older code; should use retrieveResources) - if ($ENV{QUERY_STRING} !~ /filter/) { - my $iterator = $navmap->getIterator(undef, undef, undef, 0); - my $curRes; - my $sequenceCount = 0; - my $sequenceId; - while ($curRes = $iterator->next()) { - if (ref($curRes) && $curRes->is_sequence()) { + my %toplinkitems=(); + my @resources = $navmap->retrieveResources(); + my $sequenceCount = 0; + my $problemCount = 0; + my $notaprobCount = 0; + my $sequenceId; + my $notools; + foreach my $curRes (@resources) { + if (ref($curRes)) { + if ($curRes->is_sequence()) { $sequenceCount++; $sequenceId = $curRes->map_pc(); + } elsif ($curRes->is_problem()) { + $problemCount ++; + } else { + $notaprobCount ++; } } - + } + if (($sequenceCount == 1) && (!$problemCount) && ($notaprobCount <= 1)) { + $notools = 1; + } + + # If there's only one map in the top-level and we don't + # already have a filter, automatically display it + if ($ENV{QUERY_STRING} !~ /filter/) { if ($sequenceCount == 1) { # The automatic iterator creation in the render call # will pick this up. We know the condition because @@ -198,27 +231,6 @@ MENU } } - if ($ENV{QUERY_STRING} eq 'launchExternal') { - $r->print(' -
-
'); - $r->print(' - '); - } - - if ($env{'environment.remotenavmap'} ne 'on') { - $r->print(&launch_win('link','yes',\%toplinkitems)); - } - if ($env{'environment.remotenavmap'} eq 'on') { - &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'closenav', - 'collapse()', - "Close navigation window"); - } - - # Check to see if the student is jumping to next open, do-able problem if ($ENV{QUERY_STRING} =~ /^jumpToFirstHomework/) { # Find the next homework problem that they can do. @@ -261,9 +273,12 @@ MENU .""); } } else { - &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'firsthomework', - 'location.href="navmaps?jumpToFirstHomework"', - "Show my first due problem"); + my $link = '/adm/navmaps?jumpToFirstHomework'; + unless ($notools) { + &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'firsthomework', + 'location.href="'.$link.'"', + "Show my first due problem"); + } } my $suppressEmptySequences = 0; @@ -278,33 +293,40 @@ MENU $filterFunc = sub { my $res = shift; return $res->completable() || $res->is_map(); }; + my $link = '/adm/navmaps?sort='.$env{'form.sort'}; &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'everything', - 'location.href="navmaps?sort='.$env{'form.sort'}.'"', - "Show everything"); + 'location.href="'.$link.'"', + 'Show everything'); $r->print("".&mt("Uncompleted Problems").""); $env{'form.filter'} = ''; $env{'form.condition'} = 1; $resource_no_folder_link = 1; } else { - &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'uncompleted', - 'location.href="navmaps?sort='.$env{'form.sort'}. - '&showOnlyHomework=1"', - "Show only uncompleted problems"); + my $link = '/adm/navmaps?sort='.$env{'form.sort'}.'&showOnlyHomework=1'; + unless ($notools) { + &Apache::lonnavmaps::add_linkitem(\%toplinkitems,'uncompleted', + 'location.href="'.$link.'"', + 'Show only uncompleted problems'); + } } my %selected=($env{'form.sort'} => ' selected="selected"'); - my $sort_html=("
- - - ".&mt('Sort by:')." - + '.&mt('Sort by:').' + -
"); + '); + } # renderer call my $renderArgs = { 'cols' => [0,1,2,3], 'sort' => $env{'form.sort'}, @@ -317,7 +339,9 @@ MENU 'sort_html'=> $sort_html, 'r' => $r, 'caller' => 'navmapsdisplay', - 'linkitems' => \%toplinkitems}; + 'linkitems' => \%toplinkitems, + 'notools' => $notools}; + my $render = &Apache::lonnavmaps::render($renderArgs); # If no resources were printed, print a reassuring message so the @@ -329,42 +353,60 @@ MENU $r->print("

".&mt("This course is empty.")."

"); } } - #my $td=&tv_interval($t0); - #$r->print("
$td"); - + &endContentScreen($r); $r->print(&Apache::loncommon::end_page()); $r->rflush(); return OK; } -sub launch_win { - my ($mode,$script,$toplinkitems,$firsttime)=@_; - my $result; - if ($script ne 'no') { - $result.=''); + return; +} + +sub startContentScreen { + my ($r,$mode,$course_type)=@_; + + $r->print("\n".''."\n"); + $r->print('
'); +} + +sub endContentScreen { + my ($r)=@_; + $r->print('
'); } 1;