--- loncom/homework/lonhomework.pm	2018/09/21 04:37:36	1.344.2.10
+++ loncom/homework/lonhomework.pm	2024/02/27 17:10:23	1.344.2.10.4.7
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # The LON-CAPA Homework handler
 #
-# $Id: lonhomework.pm,v 1.344.2.10 2018/09/21 04:37:36 raeburn Exp $
+# $Id: lonhomework.pm,v 1.344.2.10.4.7 2024/02/27 17:10:23 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -49,15 +49,22 @@ use Apache::matchresponse();
 use Apache::chemresponse();
 use Apache::functionplotresponse();
 use Apache::drawimage();
+use Apache::loncourseuser();
+use Apache::grades();
 use Apache::Constants qw(:common);
 use Apache::loncommon();
+use Apache::lonparmset();
+use Apache::lonnavmaps();
 use Apache::lonlocal;
+use LONCAPA qw(:DEFAULT :match);
+use LONCAPA::ltiutils();
 use Time::HiRes qw( gettimeofday tv_interval );
 use HTML::Entities();
 use File::Copy();
 
 # FIXME - improve commenting
 
+my $registered_cleanup;
 
 BEGIN {
     &Apache::lonxml::register_insert();
@@ -155,9 +162,19 @@ sub get_target {
                 return ('web','answer');
             } elsif (($env{'form.problemmode'} eq 'saveedit') ||
                      ($env{'form.problemmode'} eq 'undo')) {
-                return ('modified','no_output_web','edit');
+                my %editors = &Apache::loncommon::permitted_editors();
+                if ($editors{'edit'}) {
+                    return ('modified','no_output_web','edit');
+                } else {
+                    return ('web');
+                }
             } elsif ($env{'form.problemmode'} eq 'edit') {
-		return ('no_output_web','edit');
+                my %editors = &Apache::loncommon::permitted_editors();
+                if ($editors{'edit'}) {
+		    return ('no_output_web','edit');
+                } else {
+                    return ('web');
+                }
 	    } else {
 		return ('web');
 	    }
@@ -188,7 +205,7 @@ sub proctor_checked_in {
     if ($type eq 'Task') {
 	my $version=$Apache::lonhomework::history{'resource.0.version'};
 	$key ="resource.$version.0.checkedin";
-    } elsif ($type eq 'problem') {
+    } elsif (($type eq 'problem') || ($type eq 'tool')) {
 	$key ='resource.0.checkedin';
     }
     # backward compatability, used to be username@domain, 
@@ -203,7 +220,6 @@ sub proctor_checked_in {
 	    return 1;
 	}
     }
-    
     return 0;
 }
 
@@ -212,7 +228,7 @@ sub check_slot_access {
 
     # does it pass normal muster
     my ($status,$datemsg)=&check_access($id,$symb);
-    
+
     my $useslots = &Apache::lonnet::EXT("resource.0.useslots",$symb);
     if ($useslots ne 'resource' && $useslots ne 'map' 
 	&& $useslots ne 'map_map') {
@@ -292,7 +308,7 @@ sub check_slot_access {
 	     || $Apache::lonhomework::history{"resource.0.solved"} =~ /^correct_/ );
 	$checkedin =
 	    $Apache::lonhomework::history{"resource.$version.0.checkedin"};
-    } elsif ($type eq 'problem') {
+    } elsif (($type eq 'problem') || ($type eq 'tool')) {
         $checkin = 'resource.0.checkedin';
 	$checkedin  = $Apache::lonhomework::history{$checkin};
     }
@@ -301,7 +317,7 @@ sub check_slot_access {
         my %slot=&Apache::lonnet::get_slot($checkinslot);
         $consumed_uniq = $slot{'uniqueperiod'};
     }
-    if ($type eq 'problem') {
+    if (($type eq 'problem') || ($type eq 'tool')) {
         if ((ref($partlist) eq 'ARRAY') && (@{$partlist} > 0)) {
             my ($numcorrect,$numgraded) = (0,0);
             foreach my $part (@{$partlist}) {
@@ -360,8 +376,9 @@ sub check_slot_access {
     # However, the problem is not closed, and potentially, another slot might be
     # used to gain access to it to work on it, until the due date is reached, and the
     # problem then becomes CLOSED.  Therefore return the slotstatus - 
-    # (which will be one of: NOT_IN_A_SLOT, RESERVABLE, RESERVABLE_LATER, or NOTRESERVABLE.
-    if (!defined($slot_name) && $type eq 'problem') {
+    # (which will be one of: NOT_IN_A_SLOT, RESERVABLE, RESERVABLE_LATER, or NOTRESERVABLE).
+
+    if (!defined($slot_name) && (($type eq 'problem') || ($type eq 'tool'))) {
         if ($slotstatus eq 'NOT_IN_A_SLOT') {
             if (!$num_usable_slots) {
                 if ($env{'request.course.id'}) {
@@ -445,7 +462,7 @@ sub check_slot_access {
     }
 
     if ( $is_correct) {
-	if ($type eq 'problem') {
+	if (($type eq 'problem') || ($type eq 'tool')) {
 	    return ($status);
 	}
 	return ('SHOW_ANSWER');
@@ -716,6 +733,9 @@ sub setuppermissions {
 	$env{'request.course.sec'} !~ /^\s*$/) {
 	$viewgrades = &Apache::lonnet::allowed('vgr',$env{'request.course.id'}.
                                                '/'.$env{'request.course.sec'});
+        if ($viewgrades) {
+            $Apache::lonhomework::viewgradessec = $env{'request.course.sec'};
+        }
     }
     $Apache::lonhomework::viewgrades = $viewgrades;
 
@@ -733,6 +753,9 @@ sub setuppermissions {
 	$modifygrades = 
 	    &Apache::lonnet::allowed('mgr',$env{'request.course.id'}.
 				     '/'.$env{'request.course.sec'});
+        if ($modifygrades) {
+            $Apache::lonhomework::modifygradessec = $env{'request.course.sec'};
+        }
     }
     $Apache::lonhomework::modifygrades = $modifygrades;
 
@@ -751,7 +774,9 @@ sub setuppermissions {
 sub unset_permissions {
     undef($Apache::lonhomework::queuegrade);
     undef($Apache::lonhomework::modifygrades);
+    undef($Apache::lonhomework::modifygradessec);
     undef($Apache::lonhomework::viewgrades);
+    undef($Apache::lonhomework::viewgradessec);
     undef($Apache::lonhomework::browse);
 }
 
@@ -850,7 +875,7 @@ STATE
 
 sub analyze_header {
     my ($request) = @_;
-    my $js = &Apache::structuretags::setmode_javascript();
+    my $js = &Apache::lonxml::setmode_javascript();
 
     # Breadcrumbs
     my $brcrum = [{'href' => &Apache::loncommon::authorspace($request->uri),
@@ -866,18 +891,26 @@ sub analyze_header {
                                        {'bread_crumbs' => $brcrum,})
        .&Apache::loncommon::head_subbox(
                 &Apache::loncommon::CSTR_pageheader());
+    my %lt = &Apache::lonlocal::texthash(
+                 edit => 'Edit',
+                 editxml => 'EditXML',
+             );
     $result .= 
             '<form name="lonhomework" method="post" action="'.
 	    &HTML::Entities::encode($env{'request.uri'},'<>&"').'">'.
             '<input type="hidden" name="problemmode" value="'.
             $env{'form.problemmode'}.'" />'.
 	    &Apache::structuretags::remember_problem_state().'
-            <div class="LC_edit_problem_analyze_header">
-            <input type="button" name="submitmode" value="'.&mt("EditXML").'" '.
-            'onclick="javascript:setmode(this.form,'."'editxml'".')" />
-            <input type="button" name="submitmode" value="'.&mt('Edit').'" '.
-            'onclick="javascript:setmode(this.form,'."'edit'".')" />
-            <hr />
+            <div class="LC_edit_problem_analyze_header">';
+     my %editors = &Apache::loncommon::permitted_editors();
+     foreach my $item ('editxml','edit') {
+         next unless ($editors{$item});
+         $result .= '<input type="button" name="submitmode" value="'.$lt{$item}.'" '.
+                    'onclick="javascript:setmode(this.form,'."'$item'".')" />'.
+                    "\n";
+     }
+     $result .=
+            '<hr />
             <input type="button" name="submitmode" value="'.&mt("View").'" '.
             'onclick="javascript:setmode(this.form,'."'view'".')" />
             <hr />
@@ -1062,9 +1095,8 @@ sub editxmlmode {
 
 	$problem='';
     }
-
     if (($env{'form.problemmode'} eq 'saveeditxml') ||
-        ($env{'form.problemmode'} eq 'saveviewxml') || 
+        ($env{'form.problemmode'} eq 'saveviewxml') ||
         ($env{'form.problemmode'} eq 'undoxml')) {
 	my $error=&handle_save_or_undo($request,\$problem,
 				       \$env{'form.editxmltext'});
@@ -1083,7 +1115,7 @@ sub editxmlmode {
 	my $js =
 	    &Apache::edit::js_change_detection(). 
 	    &Apache::loncommon::resize_textarea_js().
-            &Apache::structuretags::setmode_javascript().
+            &Apache::lonxml::setmode_javascript().
             &Apache::lonhtmlcommon::dragmath_js("EditMathPopup");
 
     # Breadcrumbs
@@ -1121,7 +1153,8 @@ sub editxmlmode {
 
     $result .= '<ol class="LC_primary_menu" style="display:inline-block;font-size:90%;vertical-align:middle;">';
 
-    unless ($env{'environment.nocodemirror'}) {
+    my $nocodemirror = &Apache::loncommon::nocodemirror();
+    unless ($nocodemirror) {
         # dropdown menus
         $result .= Apache::lonmenu::create_submenu("#", "",
             &mt("Problem Templates"), template_dropdown_datastructure());
@@ -1153,7 +1186,7 @@ sub editxmlmode {
         '</textarea> <div id="LC_aftertextarea"> </div> </form>';
 
     my $resource = $env{'request.ambiguous'};
-    unless($env{'environment.nocodemirror'}){
+    unless ($nocodemirror) {
         $result .= '<link rel="stylesheet" href="/adm/codemirror/codemirror-combined-xml.css">
         <script src="/adm/codemirror/codemirror-compressed-xml.js"></script>
         <script>
@@ -1200,7 +1233,7 @@ sub editxmlmode {
 #    Render the page in whatever target desired.
 #
 sub renderpage {
-    my ($request,$file,$targets,$return_string) = @_;
+    my ($request,$file,$targets,$return_string,$donebuttonmsg,$viewasuser,$symb) = @_;
 
     my @targets = @{$targets || [&get_target()]};
     &Apache::lonhomework::showhashsubset(\%env,'form.');
@@ -1239,6 +1272,10 @@ sub renderpage {
 	if ($target eq 'answer') { &showhash(%Apache::lonhomework::history); }
 	if ($target eq 'web') {&Apache::lonhomework::showhashsubset(\%env,'^form');}
 
+        if (($target eq 'web') && ($viewasuser ne '') && ($symb ne '')) {
+            $env{'request.user_in_effect'} = $viewasuser;
+        }
+
 	&Apache::lonxml::debug("Should be parsing now");
 	$result .= &Apache::lonxml::xmlparse($request, $target, $problem,
 					     &setup_vars($target),%mystyle);
@@ -1251,6 +1288,11 @@ sub renderpage {
 	    if ($target eq 'analyze') {
 		$result=&Apache::lonnet::hashref2str(\%Apache::lonhomework::analyze);
 		undef(%Apache::lonhomework::analyze);
+            } elsif ($target eq 'web') {
+                if ($donebuttonmsg) {
+                    $result =~ s{</body>}{};
+                    $result.= &Apache::loncommon::confirmwrapper(&Apache::lonhtmlcommon::confirm_success($donebuttonmsg,1))."\n</body>";
+                }
 	    }
 	    #my $td=&tv_interval($t0);
 	    #if ( $Apache::lonxml::debug) {
@@ -1259,15 +1301,23 @@ sub renderpage {
 	    #}
 #	    $request->print($result);
 	    $overall_result.=$result;
+            if (($target eq 'web') && ($viewasuser ne '') && ($symb ne '')) {
+                my ($vuname,$vudom) = split(/:/,$viewasuser);
+                $overall_result .= &Apache::grades::view_as_user($symb,$vuname,$vudom).
+                                   '</body></html>';
+            }
 #	    $request->rflush();
 	}
+        if (($target eq 'web') && ($viewasuser ne '') && ($symb ne '')) {
+            undef($env{'request.user_in_effect'});
+        }
 	#$request->print(":Result ends");
 	#my $td=&tv_interval($t0);
     }
     if (!$return_string) {
 	&Apache::lonxml::add_messages(\$overall_result);
-	$request->print($overall_result);   
-	$request->rflush();   
+	$request->print($overall_result);
+	$request->rflush();
     } else {
 	return $overall_result;
     }
@@ -1278,7 +1328,6 @@ sub finished_parsing {
     undef($Apache::lonhomework::parsing_a_task);
 }
 
-
 # function extracted from get_template_html
 # returns "key" -> list
 # key: path of template
@@ -1466,6 +1515,70 @@ sub update_construct_style {
     }
 }
 
+#
+# Sets interval for current user so time left will be zero, either for the entire folder
+# containing the current resource, or just the resource, depending on value of first item
+# in interval array retrieved from EXT("resource.0.interval");
+#
+sub zero_timer {
+    my ($symb) = @_;
+    my ($hastimeleft,$first_access,$now);
+    my @interval=&Apache::lonnet::EXT("resource.0.interval",$symb);
+    if (@interval > 1) {
+        if ($interval[1] eq 'course') {
+            return ('fail',&mt('Ending of timed events not supported for intervals set course-wide'));
+        } else {
+            my $now = time;
+            my $first_access=&Apache::lonnet::get_first_access($interval[1],$symb);
+            if ($first_access > 0) {
+                my ($timelimit,$donesuffix) = split(/_/,$interval[0],2);
+                if ($donesuffix =~ /^done(?:|\:[^\:]+\:)(.*)$/) {
+                    my ($dummy,$proctor,$secret) = split(/_/,$1);
+                    if (($proctor) && ($secret ne '')) {
+                        my $key = $env{'form.LC_interval_done_proctorpass'};
+                        $key =~ s/^\s+//;
+                        $key =~ s/\s+$//;
+                        if ($env{'form.LC_interval_done_proctorpass'} ne $secret) {
+                            return ('fail',
+                                   &mt('Incorrect key entered by proctor'));
+                        }
+                    }
+                    if ($first_access+$timelimit > $now) {
+                        my $done_time = $now - $first_access;
+                        my $snum = 1;
+                        if ($interval[1] eq 'map') {
+                            $snum = 2;
+                        }
+                        my $result =
+                            &Apache::lonparmset::storeparm_by_symb_inner($symb,'0_interval',
+                                                                         $snum,$done_time,
+                                                                         'date_interval',
+                                                                         $env{'user.name'},
+                                                                         $env{'user.domain'});
+                        if ($result eq '') {
+                            # Record action in "User Notes"
+                            &Apache::lonmsg::store_instructor_comment(
+                                'Pressed Done button for symb:<br />'.$symb,
+                                $env{'user.name'}, $env{'user.domain'});
+                            return ('ok');
+                        } else {
+                            return ('fail',&mt('Error ending timed event: [_1]',$result));
+                        }
+                    } else {
+                        return ('fail',&mt('Timed event already ended'));
+                    }
+                } else {
+                    return ('fail',&mt('Timed event can not be ended before the time limit'));
+                }
+            } else {
+                return ('fail',&mt('Timer not yet started for this timed event'));
+            }
+        }
+    } else {
+        return ('fail',&mt('No timer in use'));
+    }
+    return();
+}
 
 sub handler {
     #my $t0 = [&gettimeofday()];
@@ -1478,9 +1591,9 @@ sub handler {
     my $file=&Apache::lonnet::filelocation("",$request->uri);
 
     #check if we know where we are
-    if ($env{'request.course.fn'} && !&Apache::lonnet::symbread('','',1,1)) { 
+    if ($env{'request.course.fn'} && !&Apache::lonnet::symbread('','',1,1)) {
 	# if we are browsing we might not be able to know where we are
-	if ($Apache::lonhomework::browse ne 'F' && 
+	if ($Apache::lonhomework::browse ne 'F' &&
 	    $env{'request.state'} ne "construct") {
 	    #should know where we are, so ask
 	    &unset_permissions();
@@ -1492,6 +1605,7 @@ sub handler {
 	&unset_permissions();
 	return OK;
     }
+
     &Apache::lonxml::debug("Permissions:$Apache::lonhomework::browse:$Apache::lonhomework::viewgrades:$Apache::lonhomework::modifygrades:$Apache::lonhomework::queuegrade");
     &Apache::lonxml::debug("Problem Mode ".$env{'form.problemmode'});
     my ($symb) = &Apache::lonnet::whichuser();
@@ -1508,7 +1622,13 @@ sub handler {
                      ($env{'form.problemmode'} eq 'saveeditxml') ||
                      ($env{'form.problemmode'} eq 'saveviewxml') ||
                      ($env{'form.problemmode'} eq 'undoxml')) {
-		&editxmlmode($request,$file);
+                my %editors = &Apache::loncommon::permitted_editors();
+                if (($editors{'xml'}) || ($env{'form.problemmode'} eq 'saveviewxml') || ($env{'form.problemmode'} eq 'undoxml')) {
+		    &editxmlmode($request,$file);
+                } else {
+                    &update_construct_style();
+                    &renderpage($request,$file);
+                }
 	    } elsif ($env{'form.problemmode'} eq 'calcanswers') {
 		&analyze($request,$file);
 	    } else {
@@ -1522,9 +1642,49 @@ sub handler {
 	    &newproblem($request);
 	}
     } else {
+        # Set the event timer to zero if the "done button" was clicked.  The button is
+        # part of the doneButton form created in lonmenu.pm
+        my ($donebuttonresult,$donemsg,$viewasuser);
+        if ($symb && $env{'form.LC_interval_done'} eq 'true') {
+            ($donebuttonresult,$donemsg) = &zero_timer($symb);
+            undef($env{'form.LC_interval_done'});
+            undef($env{'form.LC_interval_done_proctorpass'});
+        }
+        if (($env{'form.LC_viewas'} ne '') && $symb && $env{'request.course.id'} &&
+            ($Apache::lonhomework::viewgrades || $Apache::lonhomework::modifygrades)) {
+            if ($env{'form.LC_viewas'} =~ /^($match_username):($match_domain)$/) {
+                my ($possuname,$possudom) = ($1,$2);
+                my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
+                my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+                my ($canview,$posssec);
+                if ($env{'request.course.sec'} ne '') {
+                    if ($Apache::lonhomework::modifygradessec eq $env{'request.course.sec'}) {
+                        $canview = 'section';
+                        $posssec = $env{'request.course.sec'};
+                    } elsif ($Apache::lonhomework::viewgradessec eq $env{'request.course.sec'}) {
+                        $canview = 'section';
+                        $posssec = $env{'request.course.sec'};
+                    }
+                }
+                my $crstype = &Apache::loncommon::course_type();
+                if (&Apache::loncourseuser::is_course_user($possudom,$possuname,$cdom,$cnum,
+                                                           $canview,$crstype,$posssec)) {
+                    $viewasuser = $possuname.':'.$possudom;
+                }
+            }
+            undef($env{'form.LC_viewas'});
+        }
 	# just render the page normally outside of construction space
 	&Apache::lonxml::debug("not construct");
-	&renderpage($request,$file);
+        undef(@Apache::lonhomework::ltipassback);
+	&renderpage($request,$file,undef,undef,$donemsg,$viewasuser,$symb);
+        if (@Apache::lonhomework::ltipassback) {
+            unless ($registered_cleanup) {
+                my $handlers = $request->get_handlers('PerlCleanupHandler');
+                $request->set_handlers('PerlCleanupHandler' =>
+                                       [\&do_ltipassback,@{$handlers}]);
+            }
+        }
     }
     #my $td=&tv_interval($t0);
     #&Apache::lonxml::debug("Spent $td seconds processing");
@@ -1709,5 +1869,89 @@ sub convert_for_js {
     return $return;
 }
 
+sub do_ltipassback {
+    if (@Apache::lonhomework::ltipassback) {
+        foreach my $item (@Apache::lonhomework::ltipassback) {
+            if (ref($item) eq 'HASH') {
+                if ((ref($item->{'lti'}) eq 'HASH') && ($item->{'cid'} =~ /^($match_domain)_($match_courseid)$/)) {
+                    my ($cdom,$cnum) = ($1,$2);
+                    my $msgformat = $item->{'lti'}->{'passbackformat'};
+                    my $sigmethod = 'HMAC-SHA1';
+                    my $ltinum = $item->{'ltinum'};
+                    my $id = $item->{'pbid'};
+                    my $url = $item->{'pburl'};
+                    my $type = $item->{'pbtype'};
+                    my $scope = $item->{'scope'};
+                    my $map = $item->{'pbmap'};
+                    my $symb = $item->{'pbsymb'};
+                    my $uname = $item->{'uname'};
+                    my $udom = $item->{'udom'};
+                    my $keynum = $item->{'lti'}->{'cipher'};
+                    my $crsdef = $item->{'crsdef'};
+                    my $scoretype = $item->{'format'};
+                    my ($total,$possible);
+                    if ($scope eq 'resource') {
+                        $total = $item->{'total'};
+                        $possible = $item->{'possible'};
+                    } elsif (($scope eq 'map') || ($scope eq 'nonrec')) {
+                        ($total,$possible) = &get_lti_score($uname,$udom,$map,$scope);
+                    } elsif ($scope eq 'course') {
+                        ($total,$possible) = &get_lti_score($uname,$udom);
+                    }
+                    if (($id ne '') && ($url ne '') && ($possible)) {
+                        &LONCAPA::ltiutils::send_grade($cdom,$cnum,$crsdef,$type,$ltinum,$keynum,$id,$url,$scoretype,$sigmethod,$msgformat,$total,$possible);
+                    }
+                }
+            }
+        }
+        undef(@Apache::lonhomework::ltipassback);
+    }
+}
+
+sub get_lti_score {
+    my ($uname,$udom,$mapurl,$scope) = @_;
+    my $navmap = Apache::lonnavmaps::navmap->new($uname,$udom);
+    if (ref($navmap)) {
+        my $iterator;
+        if ($mapurl ne '') {
+            my $map = $navmap->getResourceByUrl($mapurl);
+            my $firstres = $map->map_start();
+            my $finishres = $map->map_finish();
+            my $recursive = 1;
+            if ($scope eq 'nonrec') {
+                $recursive = 0;
+            }
+            $iterator = $navmap->getIterator($firstres,$finishres,undef,$recursive);
+        } else {
+            $iterator = $navmap->getIterator(undef,undef,undef,1);
+        }
+        if (ref($iterator)) {
+            my $depth = 1;
+            my $total = 0;
+            my $possible = 0;
+            $iterator->next(); # ignore first BEGIN_MAP
+            my $curRes = $iterator->next();
+            while ( $depth > 0 ) {
+                if ($curRes == $iterator->BEGIN_MAP()) {$depth++;}
+                if ($curRes == $iterator->END_MAP()) { $depth--; }
+                if (ref($curRes) && $curRes->is_gradable() && !$curRes->randomout) {
+                    my $parts = $curRes->parts();
+                    foreach my $part (@{$parts}) {
+                        next if ($curRes->solved($part) eq 'excused');
+                        $total += $curRes->weight($part) * $curRes->awarded($part);
+                        $possible += $curRes->weight($part);
+                    }
+                }
+                $curRes = $iterator->next();
+            }
+            if ($total > $possible) {
+                $total = $possible;
+            }
+            return ($total,$possible);
+        }
+    }
+    return;
+}
+
 1;
 __END__