[BACK]Return to ltiauth.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / lti

Diff for /loncom/lti/ltiauth.pm between versions 1.3 and 1.26

version 1.3, 2017/12/09 16:15:47 version 1.26, 2021/11/22 23:41:00
Line 36  use Apache::lonlocal; Line 36  use Apache::lonlocal;
 use Apache::lonnet;  use Apache::lonnet;
 use Apache::loncommon;  use Apache::loncommon;
 use Apache::lonacc;  use Apache::lonacc;
   use Apache::lonrequestcourse;
 use LONCAPA::ltiutils;  use LONCAPA::ltiutils;
   
 sub handler {  sub handler {
     my $r = shift;      my $r = shift;
     my $requri = $r->uri;      my $requri = $r->uri;
       my $hostname = $r->hostname;
 #  #
 # Retrieve data POSTed by LTI Consumer on launch    # Check for existing session, and temporarily delete any form items
   # in %env, if session exists
   #
       my %savedform;
       my $handle = &Apache::lonnet::check_for_valid_session($r);
       if ($handle ne '') {
           foreach my $key (sort(keys(%env))) {
               if ($key =~ /^form\.(.+)$/) {
                   $savedform{$1} = $env{$key};
                   delete($env{$key});
               }
           }
       }
   #
   # Retrieve data POSTed by LTI launch
 #  #
     &Apache::lonacc::get_posted_cgi($r);      &Apache::lonacc::get_posted_cgi($r);
     my $params = {};      my $params = {};
Line 51  sub handler { Line 67  sub handler {
             $params->{$1} = $env{$key};              $params->{$1} = $env{$key};
         }          }
     }      }
   #
   # Check for existing session, and restore temporarily
   # deleted form items to %env, if session exists.
   #
       if ($handle ne '') {
           if (keys(%savedform)) {
               foreach my $key (sort(keys(%savedform))) {
                   $env{'form.'.$key} = $savedform{$key};
               }
           }
       }
   
     unless (keys(%{$params})) {      unless (keys(%{$params})) {
         &invalid_request($r,1);          &invalid_request($r,1);
Line 71  sub handler { Line 98  sub handler {
 # Retrieve "internet domains" for all this institution's LON-CAPA  # Retrieve "internet domains" for all this institution's LON-CAPA
 # nodes.  # nodes.
 #  #
     my ($udom,$uname,$uhome,$cdom,$cnum,$symb,$mapurl,@intdoms);      my @intdoms;
     my $lonhost = $r->dir_config('lonHostID');      my $lonhost = $r->dir_config('lonHostID');
     my $internet_names = &Apache::lonnet::get_internet_names($lonhost);      my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
     if (ref($internet_names) eq 'ARRAY') {      if (ref($internet_names) eq 'ARRAY') {
         @intdoms = @{$internet_names};          @intdoms = @{$internet_names};
     }      }
   #
   # Determine course's domain in LON-CAPA
   # for basic launch using key and secret managed
   # in LON-CAPA course (i.e., uri begins /adm/launch)
   #
   
      my ($cdom,$cnum);
   
   # Note: "internet domain" for course's domain must be one of the
   # internet domains for the institution's LON-CAPA servers.
   #
       if ($requri =~ m{^/adm/launch(|/.*)$}) {
           my $tail = $1;
           if ($tail =~ m{^/tiny/($match_domain)/(\w+)$}) {
               my ($urlcdom,$urlcnum) = &course_from_tinyurl($tail);
               if (($urlcdom ne '') && ($urlcnum ne '')) {
                   $cdom = $urlcdom;
                   $cnum = $urlcnum;
                   my $primary_id = &Apache::lonnet::domain($cdom,'primary');
                   if ($primary_id ne '') {
                       my $intdom = &Apache::lonnet::internet_dom($primary_id);
                       if (($intdom ne '') && (grep(/^\Q$intdom\E$/,@intdoms))) {
   #
   # Retrieve information for LTI link protectors in course
   # where url was /adm/launch/tiny/$cdom/$uniqueid
   #
                           my (%crslti,%crslti_by_key,$itemid,$ltitype);
                           %crslti = &Apache::lonnet::get_course_lti($cnum,$cdom,'provider');
                           if (keys(%crslti)) {
                               foreach my $id (keys(%crslti)) {
                                   if (ref($crslti{$id}) eq 'HASH') {
                                       my $key = $crslti{$id}{'key'};
                                       push(@{$crslti_by_key{$key}},$id);
                                   }
                               }
                           }
   #
   # Verify the signed request using the secret for LTI link
   # protectors for which the key in the POSTed data matches
   # keys in the course configuration.
   #
   # Request is invalid if the signed request could not be verified
   # for the key and secret from LON-CAPA course configuration for
   # LTI link protectors or from LON-CAPA configuration for the
   # course's domain if there are LTI Providers which may be used.
   #
   # Determine if nonce in POSTed data has expired.
   # If unexpired, confirm it has not already been used.
   #
                           if (keys(%crslti)) {
                               $itemid = &get_lti_itemid($requri,$hostname,$params,\%crslti,\%crslti_by_key);
                           }
                           if (($itemid) && (ref($crslti{$itemid}) eq 'HASH')) {
                               $ltitype = 'c';
                               unless (&LONCAPA::ltiutils::check_nonce($params->{'oauth_nonce'},$params->{'oauth_timestamp'},
                                                                       $crslti{$itemid}{'lifetime'},$cdom,$r->dir_config('lonLTIDir'))) {
                                   &invalid_request($r,3);
                                   return OK;
                               }
                           } else {
                               my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
                               unless (keys(%lti) > 0) {
                                   &invalid_request($r,4);
                                   return OK;
                               }
                               my (%domlti_by_key,%domlti);
                               foreach my $id (keys(%lti)) {
                                   if (ref($lti{$id}) eq 'HASH') {
                                       my $key = $lti{$id}{'key'};
                                       if (!$lti{$itemid}{'requser'}) {
                                           push(@{$domlti_by_key{$key}},$id);
                                           $domlti{$id} = $lti{$id};
                                       }
                                   }
                               }
                               if (keys(%domlti)) {
                                   $itemid = &get_lti_itemid($requri,$hostname,$params,\%domlti,\%domlti_by_key);
                               }
                               if (($itemid) && (ref($domlti{$itemid}) eq 'HASH')) {
                                   $ltitype = 'd';
                                   unless (&LONCAPA::ltiutils::check_nonce($params->{'oauth_nonce'},$params->{'oauth_timestamp'},
                                                                           $domlti{$itemid}{'lifetime'},$cdom,
                                                                           $r->dir_config('lonLTIDir'))) {
                                       &invalid_request($r,5);
                                       return OK;
                                   }
                               }
                           }
                           if ($itemid) {
                               foreach my $key (%{$params}) {
                                   delete($env{'form.'.$key});
                               }
                               my $ltoken = &Apache::lonnet::tmpput({'linkprot' => $itemid.$ltitype.':'.$tail},
                                                                    $lonhost,'link');
                               if ($ltoken) {
                                   $r->internal_redirect($tail.'?ltoken='.$ltoken);
                                   $r->set_handlers('PerlHandler'=> undef);
                               } else {
                                   &invalid_request($r,6);
                               }
                           } else {
                               &invalid_request($r,7);
                           }
                       } else {
                           &invalid_request($r,8);
                       }
                   } else {
                       &invalid_request($r,9);
                   }
               } else {
                   &invalid_request($r,10);
               }
           } else {
               &invalid_request($r,11);
           }
           return OK;
       }
   
       my ($udom,$uname,$uhome,$symb,$mapurl);
   
 #  #
 # For user who launched LTI in Consumer, determine user's domain in   # For user who launched LTI in Consumer, determine user's domain in 
Line 139  sub handler { Line 285  sub handler {
 # Order is:  # Order is:
 #  #
 # (a) from custom_coursedomain item in POSTed data  # (a) from custom_coursedomain item in POSTed data
 # (b) from tail of requested URL (after /adm/lti) if it has format of a symb    # (b) from tail of requested URL (after /adm/lti/) if it has format of a symb  
 # (c) from tail of requested URL (after /adm/lti) if it has format of a map   # (c) from tail of requested URL (after /adm/lti) if it has format of a map 
 # (d) from tail of requested URL (after /adm/lti) if it has format /domain/courseID  # (d) from tail of requested URL (after /adm/lti) if it has format /domain/courseID
 # (e) from tail of requested URL (after /adm/lti) if it has format /tiny/domain/...  # (e) from tail of requested URL (after /adm/lti) if it has format /tiny/domain/\w+
 # i.e., a shortened URL (see bug #6400) -- not implemented yet.     #     i.e., a shortened URL (see bug #6400).
 # (f) same as user's domain   # (f) same as user's domain 
 #  #
 # Request invalid if custom_coursedomain is defined and is inconsistent with  # Request invalid if custom_coursedomain is defined and is inconsistent with
Line 172  sub handler { Line 318  sub handler {
         if ($tail =~ m{^/uploaded/($match_domain)/($match_courseid)/(?:default|supplemental)(?:|_\d+)\.(?:sequence|page)(|___\d+___.+)$}) {          if ($tail =~ m{^/uploaded/($match_domain)/($match_courseid)/(?:default|supplemental)(?:|_\d+)\.(?:sequence|page)(|___\d+___.+)$}) {
             ($urlcdom,$urlcnum,my $rest) = ($1,$2,$3);              ($urlcdom,$urlcnum,my $rest) = ($1,$2,$3);
             if (($cdom ne '') && ($cdom ne $urlcdom)) {              if (($cdom ne '') && ($cdom ne $urlcdom)) {
                 &invalid_request($r,3);                  &invalid_request($r,12);
                 return OK;                  return OK;
             }              }
             if ($rest eq '') {              if ($rest eq '') {
                 $mapurl = $tail;                  $mapurl = $tail;
             } else {              } else {
                 $symb = $tail;                  $symb = $tail;
                 $symb =~ s{^/+}{};                  $symb =~ s{^/}{};
               }
           } elsif ($tail =~ m{^/res/(?:$match_domain)/(?:$match_username)/.+\.(?:sequence|page)(|___\d+___.+)$}) {
               if ($1 eq '') {
                   $mapurl = $tail;
               } else {
                   $symb = $tail;
                   $symb =~ s{^/res/}{};
             }              }
 #FIXME Need to handle encrypted URLs   
         } elsif ($tail =~ m{^/($match_domain)/($match_courseid)$}) {          } elsif ($tail =~ m{^/($match_domain)/($match_courseid)$}) {
             ($urlcdom,$urlcnum) = ($1,$2);              ($urlcdom,$urlcnum) = ($1,$2);
             if (($cdom ne '') && ($cdom ne $urlcdom)) {              if (($cdom ne '') && ($cdom ne $urlcdom)) {
                 &invalid_request($r,4);                  &invalid_request($r,13);
                   return OK;
               }
           } elsif ($tail =~ m{^/tiny/($match_domain)/(\w+)$}) {
               ($urlcdom,$urlcnum) = &course_from_tinyurl($tail);
               if (($urlcdom eq '') || ($urlcnum eq '')) {
                   &invalid_request($r,14);
                 return OK;                  return OK;
             }              }
         }          }
Line 210  sub handler { Line 368  sub handler {
     }      }
   
 #  #
 # Retrieve information for LTI Consumers in course domain  # Retrieve information for LTI Consumers in course's domain
 # and populate hash --  %lti_by_key -- for which keys  # and populate hash --  %lti_by_key -- for which keys
 # are those defined in domain configuration for LTI.  # are those defined in domain configuration for LTI.
 #  #
     
     my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');      my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
     unless (keys(%lti) > 0) {      unless (keys(%lti) > 0) {
         &invalid_request($r,5);          &invalid_request($r,15);
         return OK;          return OK;
     }      }
     my %lti_by_key;      my %lti_by_key;
Line 233  sub handler { Line 391  sub handler {
 #  #
 # Verify the signed request using the secret for those  # Verify the signed request using the secret for those
 # Consumers for which the key in the POSTed data matches   # Consumers for which the key in the POSTed data matches 
 # keys in the domain configuration for LTI.  # keys in the course configuration or the domain configuration
   # for LTI.
 #  #
     my $hostname = $r->hostname;  
     my $protocol = 'http';  
     if ($ENV{'SERVER_PORT'} == 443) {  
         $protocol = 'https';  
     }  
   
     my ($itemid,$consumer_key,$secret,@ltiroles);      my $itemid = &get_lti_itemid($requri,$hostname,$params,\%lti,\%lti_by_key);
     $consumer_key = $params->{'oauth_consumer_key'};  
     if (ref($lti_by_key{$consumer_key}) eq 'ARRAY') {  
         foreach my $id (@{$lti_by_key{$consumer_key}}) {  
             if (ref($lti{$id}) eq 'HASH') {  
                 $secret = $lti{$id}{'secret'};  
                 my $request = Net::OAuth->request('request token')->from_hash($params,  
                                                    request_url => $protocol.'://'.$hostname.$requri,  
                                                    request_method => $env{'request.method'},  
                                                    consumer_secret => $secret,);  
                 if ($request->verify()) {  
                     $itemid = $id;  
                     last;  
                 }  
             }  
         }  
     }  
   
 #  #
 # Request is invalid if the signed request could not be verified  # Request is invalid if the signed request could not be verified
Line 265  sub handler { Line 403  sub handler {
 # configuration in LON-CAPA for that LTI Consumer.  # configuration in LON-CAPA for that LTI Consumer.
 #  #
     unless (($itemid) && (ref($lti{$itemid}) eq 'HASH')) {      unless (($itemid) && (ref($lti{$itemid}) eq 'HASH')) {
         &invalid_request($r,6);          &invalid_request($r,16);
         return OK;          return OK;
     }      }
   
Line 275  sub handler { Line 413  sub handler {
 #  #
     unless (&LONCAPA::ltiutils::check_nonce($params->{'oauth_nonce'},$params->{'oauth_timestamp'},      unless (&LONCAPA::ltiutils::check_nonce($params->{'oauth_nonce'},$params->{'oauth_timestamp'},
                                             $lti{$itemid}{'lifetime'},$cdom,$r->dir_config('lonLTIDir'))) {                                              $lti{$itemid}{'lifetime'},$cdom,$r->dir_config('lonLTIDir'))) {
         &invalid_request($r,7);          &invalid_request($r,17);
           return OK;
       }
   
   #
   # Determine if a username is required from the domain
   # configuration for the specific LTI Consumer
   #
   
       if (!$lti{$itemid}{'requser'}) {
           if ($tail =~ m{^/tiny/($match_domain)/(\w+)$}) {
               my $ltitype = 'd';
               foreach my $key (%{$params}) {
                   delete($env{'form.'.$key});
               }
               my $ltoken = &Apache::lonnet::tmpput({'linkprot' => $itemid.$ltitype.':'.$tail},
                                                      $lonhost);
               if ($ltoken) {
                   $r->internal_redirect($tail.'?ltoken='.$ltoken);
                   $r->set_handlers('PerlHandler'=> undef);
               } else {
                   &invalid_request($r,18);
               }
           } else {
               &invalid_request($r,19);
           }
         return OK;          return OK;
     }      }
   
 #  #
 # Determinine if source of username matches requirement from the   # Determine if source of username matches requirement from the 
 # domain configuration for the specific LTI Consumer.  # domain configuration for the specific LTI Consumer.
 #   # 
   
Line 308  sub handler { Line 471  sub handler {
 #  #
 # (a) from course mapping (if the link between Consumer "course" and   # (a) from course mapping (if the link between Consumer "course" and 
 # Provider "course" has been established previously).  # Provider "course" has been established previously).
 # (b) from tail of requested URL (after /adm/lti) if it has format of a symb  # (b) from tail of requested URL (after /adm/lti/) if it has format of a symb
 # (c) from tail of requested URL (after /adm/lti) if it has format of a map  # (c) from tail of requested URL (after /adm/lti) if it has format of a map
 # (d) from tail of requested URL (after /adm/lti) if it has format /domain/courseID  # (d) from tail of requested URL (after /adm/lti) if it has format /domain/courseID
 # (e) from tail of requested URL (after /adm/lti) if it has format /tiny/domain/...  # (e) from tail of requested URL (after /adm/lti) if it has format /tiny/domain/\w+
 # i.e., a shortened URL (see bug #6400) -- not implemented yet.  #     i.e., a shortened URL (see bug #6400).
 #  #
 # If Consumer course included in POSTed data points as a target course which  # If Consumer course included in POSTed data points as a target course which
 # has a format which matches a LON-CAPA courseID, but the course does not  # has a format which matches a LON-CAPA courseID, but the course does not
Line 335  sub handler { Line 498  sub handler {
             if ($consumers{$sourcecrs} =~ /^$match_courseid$/) {              if ($consumers{$sourcecrs} =~ /^$match_courseid$/) {
                 my $crshome = &Apache::lonnet::homeserver($consumers{$sourcecrs},$cdom);                  my $crshome = &Apache::lonnet::homeserver($consumers{$sourcecrs},$cdom);
                 if ($crshome =~ /(con_lost|no_host|no_such_host)/) {                  if ($crshome =~ /(con_lost|no_host|no_such_host)/) {
                     &invalid_request($r,8);                      &invalid_request($r,20);
                     return OK;                      return OK;
                 } else {                  } else {
                     $posscnum = $consumers{$sourcecrs};                      $posscnum = $consumers{$sourcecrs};
Line 347  sub handler { Line 510  sub handler {
     if ($urlcnum ne '') {      if ($urlcnum ne '') {
         if ($posscnum ne '') {          if ($posscnum ne '') {
             if ($posscnum ne $urlcnum) {              if ($posscnum ne $urlcnum) {
                 &invalid_request($r,9);                  &invalid_request($r,21);
                 return OK;                  return OK;
             } else {              } else {
                 $cnum = $posscnum;                  $cnum = $posscnum;
Line 355  sub handler { Line 518  sub handler {
         } else {          } else {
             my $crshome = &Apache::lonnet::homeserver($urlcnum,$cdom);              my $crshome = &Apache::lonnet::homeserver($urlcnum,$cdom);
             if ($crshome =~ /(con_lost|no_host|no_such_host)/) {              if ($crshome =~ /(con_lost|no_host|no_such_host)/) {
                 &invalid_request($r,10);                  &invalid_request($r,22);
                 return OK;                  return OK;
             } else {              } else {
                 $cnum = $urlcnum;                  $cnum = $urlcnum;
Line 366  sub handler { Line 529  sub handler {
     }      }
   
 #  #
 # Get LON-CAPA role to use from role-mapping of Consumer roles  # Get LON-CAPA role(s) to use from role-mapping of Consumer roles
 # defined in domain configuration for the appropriate LTI  # defined in domain configuration for the appropriate LTI
 # Consumer.  # Consumer.
 #  #
 # If multiple LON-CAPA roles are indicated, choose based  # If multiple LON-CAPA roles are indicated for the current user,
 # on the order: cc, in, ta, ep, st  # ordering (from first to last) is: cc/co, in, ta, ep, st.
 #  #
   
     my $reqrole;      my (@ltiroles,@lcroles);
       my @lcroleorder = ('cc','in','ta','ep','st');
     my @roleorder = ('cc','in','ta','ep','st');      my ($lcrolesref,$ltirolesref) = 
     if ($params->{'roles'} =~ /,/) {          &LONCAPA::ltiutils::get_lc_roles($params->{'roles'},
         @ltiroles = split(/\s*,\s*/,$params->{'role'});                                           \@lcroleorder,
     } else {                                           $lti{$itemid}{maproles});
         my $singlerole = $params->{'roles'};      if (ref($lcrolesref) eq 'ARRAY') {
         $singlerole =~ s/^\s|\s+$//g;          @lcroles = @{$lcrolesref};
         @ltiroles = ($singlerole);      }
     }      if (ref($ltirolesref) eq 'ARRAY') {
     if (@ltiroles) {          @ltiroles = @{$ltirolesref};
         if (ref($lti{$itemid}{maproles}) eq 'HASH') {  
             my %possroles;  
             map { $possroles{$lti{$itemid}{maproles}{$_}} = 1; } @ltiroles;  
             my @possibles = keys(%possroles);  
             if (@possibles == 1) {  
                 if (grep(/^\Q$possibles[0]\E$/,@roleorder)) {  
                     $reqrole = $possibles[0];  
   
                 }  
             } elsif (@possibles > 1) {  
                 foreach my $item (@roleorder) {  
                     if ($possroles{$item}) {  
                         $reqrole = $item;  
                         last;  
                     }  
                 }  
             }  
         }  
     }      }
   
 #  #
Line 419  sub handler { Line 564  sub handler {
                     foreach my $ltirole (@ltiroles) {                      foreach my $ltirole (@ltiroles) {
                         if (grep(/^\Q$ltirole\E$/,@{$lti{$itemid}{'makeuser'}})) {                          if (grep(/^\Q$ltirole\E$/,@{$lti{$itemid}{'makeuser'}})) {
                             $selfcreate = 1;                              $selfcreate = 1;
                               last;
                         }                          }
                     }                      }
                 }                  }
             }              }
             if ($selfcreate) {              if ($selfcreate) {
 #FIXME Do user creation here.                  my (%rulematch,%inst_results,%curr_rules,%got_rules,%alerts);
                 return OK                  my $domdesc = &Apache::lonnet::domain($udom,'description');
                   my %data = (
                       'permanentemail' => $env{'form.lis_person_contact_email_primary'},
                       'firstname'      => $env{'form.lis_person_name_given'},
                       'lastname'       => $env{'form.lis_person_name_family'},
                       'fullname'       => $env{'form.lis_person_name_full'},
                   );
                   my $result =
                       &LONCAPA::ltiutils::create_user($lti{$itemid},$uname,$udom,
                                                       $domdesc,\%data,\%alerts,\%rulematch,
                                                       \%inst_results,\%curr_rules,%got_rules);
                   if ($result eq 'notallowed') {
                       &invalid_request($r,23);
                   } elsif ($result eq 'ok') {
                       if (($ltiroles[0] eq 'Instructor') && ($lcroles[0] eq 'cc') && ($lti{$itemid}{'mapcrs'}) &&
                           ($lti{$itemid}{'makecrs'})) {
                           unless (&Apache::lonnet::usertools_access($uname,$udom,'lti','reload','requestcourses')) {
                               &Apache::lonnet::put('environment',{ 'requestcourses.lti' => 'autolimit=', },$udom,$uname);
                           }
                       }
                   } else {
                       &invalid_request($r,24);
                       return OK;
                   }
             } else {              } else {
                 &invalid_request($r,11);                  &invalid_request($r,25);
                 return OK;                  return OK;
             }               }
         }           }
     } else {      } else {
         &invalid_request($r,12);          &invalid_request($r,26);
         return OK;          return OK;
     }      }
   
 #  #
 # If no LON-CAPA course available, check if domain's configuration  # If no LON-CAPA course available, check if domain's configuration
 # for the specific LTI Consumer allows a new course to be created   # for the specific LTI Consumer allows a new course to be created 
 # (requires role in Consumer to be: Instructor).  # (requires role in Consumer to be: Instructor and Instructor to map to CC)
 #  #
   
       my $reqcrs;
     if ($cnum eq '') {      if ($cnum eq '') {
         if ((@ltiroles) && (grep(/^Instructor$/,@ltiroles)) &&          if ($lti{$itemid}{'crsinc'}) {
             ($lti{$itemid}{'mapcrs'})) {              if ((@ltiroles) && ($lti{$itemid}{'mapcrs'}) &&
 #FIXME Create a new LON-CAPA course here.                  ($ltiroles[0] eq 'Instructor') && ($lcroles[0] eq 'cc') && ($lti{$itemid}{'makecrs'})) {
             return OK;                  my (%can_request,%request_domains);
                   &Apache::lonnet::check_can_request($cdom,\%can_request,\%request_domains,$uname,$udom);
                   if ($can_request{'lti'}) {
                       $reqcrs = 1;
                       &lti_session($r,$itemid,$uname,$udom,$uhome,$lonhost,undef,$mapurl,$tail,
                                    $symb,$cdom,$cnum,$params,\@ltiroles,$lti{$itemid},\@lcroles,
                                    $reqcrs,$sourcecrs);
                   } else {
                       &invalid_request($r,27);
                   }
               } else {
                   &invalid_request($r,28);
               }
         } else {          } else {
             &invalid_request($r,13);              &lti_session($r,$itemid,$uname,$udom,$uhome,$lonhost,undef,$mapurl,$tail,
             return OK;                            $symb,$cdom,$cnum,$params,\@ltiroles,$lti{$itemid},\@lcroles,
                            $reqcrs,$sourcecrs);
         }          }
           return OK;
     }      }
   
 #  #
Line 458  sub handler { Line 642  sub handler {
 # indicated is cc, change role indicated to co.  # indicated is cc, change role indicated to co.
 #   # 
   
     if ($reqrole eq 'cc') {      my %crsenv;
       if ($lcroles[0] eq 'cc') {
         if (($cdom ne '') && ($cnum ne '')) {          if (($cdom ne '') && ($cnum ne '')) {
             my %crsenv = &Apache::lonnet::coursedescription($cnum.'_'.$cdom,{ 'one_time' => 1,});              %crsenv = &Apache::lonnet::coursedescription($cdom.'_'.$cnum,{ 'one_time' => 1,});
             if ($crsenv{'type'} eq 'Community') {              if ($crsenv{'type'} eq 'Community') {
                 $reqrole = 'co';                   $lcroles[0] = 'co';
               }
           }
       }
   
   #
   # Determine if user has a LON-CAPA role in the mapped LON-CAPA course.
   # If multiple LON-CAPA roles are available for the user's assigned LTI roles,
   # choose the first available LON-CAPA role in the order: cc/co, in, ta, ep, st
   #
   
       my ($role,$usec,$withsec);
       unless ((($lcroles[0] eq 'cc') || ($lcroles[0] eq 'co')) && (@lcroles == 1)) {
           if ($lti{$itemid}{'section'} ne '') {
               if ($lti{$itemid}{'section'} eq 'course_section_sourcedid') {
                   if ($env{'form.course_section_sourcedid'} !~ /\W/) {
                       $usec = $env{'form.course_section_sourcedid'};
                   }
               } elsif ($env{'form.'.$lti{$itemid}{'section'}} !~ /\W/) {
                   $usec = $env{'form.'.$lti{$itemid}{'section'}};
               }
           }
           if ($usec ne '') {
               $withsec = 1;
           }
       }
   
       if (@lcroles) {
           my %crsroles = &Apache::lonnet::get_my_roles($uname,$udom,'userroles',undef,\@lcroles,
                                                        [$cdom],$withsec);
           foreach my $reqrole (@lcroles) {
               if ($withsec) {
                   my $incsec;
                   if (($reqrole eq 'cc') || ($reqrole eq 'co')) {
                       $incsec = '';
                   } else {
                       $incsec = $usec;
                   }
                   if (exists($crsroles{$cnum.':'.$cdom.':'.$reqrole.':'.$incsec})) {
                       $role = $reqrole.'./'.$cdom.'/'.$cnum;
                       if ($incsec ne '') {
                           $role .= '/'.$usec;
                       }
                       last;
                   }
               } else {
                   if (exists($crsroles{$cnum.':'.$cdom.':'.$reqrole})) {
                       $role = $reqrole.'./'.$cdom.'/'.$cnum;
                       last;
                   }
             }              }
         }          }
     }      }
   
 #  #
 # Determine if user has required LON-CAPA role  # Determine if user can selfenroll
 # in the mapped LON-CAPA course.  
 #  #
   
     my $role;      my ($reqrole,$selfenrollrole);
     my %crsroles = &Apache::lonnet::get_my_roles($uname,$udom,'userroles',undef,[$reqrole],[$cdom]);      if ($role eq '') {
     if (exists($crsroles{$cnum.':'.$cdom.':'.$reqrole})) {          if ((@ltiroles) && (ref($lti{$itemid}{'selfenroll'}) eq 'ARRAY')) {
         $role = $reqrole.'./'.$cdom.'/'.$cnum;              foreach my $ltirole (@ltiroles) {
 #FIXME Need to accommodate sections                  if (grep(/^\Q$ltirole\E$/,@{$lti{$itemid}{'selfenroll'}})) {
     } elsif (ref($lti{$itemid}{'selfenroll'}) eq 'ARRAY') {                      if (ref($lti{$itemid}{maproles}) eq 'HASH') {
         if (grep(/^\Q$reqrole\E$/,@{$lti{$itemid}{'selfenroll'}})) {                          $reqrole = $lti{$itemid}{maproles}{$ltirole};
 #FIXME Do self-enrollment here                          last;
                       }
                   }
               }
           }
           if ($reqrole eq '') {
               &invalid_request($r,29);
             return OK;              return OK;
         } else {          } else {
             &invalid_request($r,14);              unless (%crsenv) {
                   %crsenv = &Apache::lonnet::coursedescription($cdom.'_'.$cnum);
               }
               my $default_enrollment_start_date = $crsenv{'default_enrollment_start_date'};
               my $default_enrollment_end_date   = $crsenv{'default_enrollment_end_date'};
               my $now = time;
               if ($default_enrollment_end_date && $default_enrollment_end_date <= $now) {
                   &invalid_request($r,30);
                   return OK;
               } elsif ($default_enrollment_start_date && $default_enrollment_start_date >$now) {
                   &invalid_request($r,31);
                   return OK;
               } else {
                   $selfenrollrole = $reqrole.'./'.$cdom.'/'.$cnum;
                   if (($withsec) && ($reqrole ne 'cc') && ($reqrole ne 'co')) {
                       if ($usec ne '') {
                           $selfenrollrole .= '/'.$usec;
                       }
                   }
               }
         }          }
     }      }
   
 #  #
 # Store consumer-to-LON-CAPA course mapping  # Store consumer-to-LON-CAPA course mapping
 #  #
   
     if (($sourcecrs ne '')  && ($consumers{$sourcecrs} eq '') && ($cnum ne '')) {      if (($sourcecrs ne '')  && ($consumers{$sourcecrs} eq '') && ($cnum ne '')) {
         &Apache::lonnet::put_dom('lticonsumers',{ $sourcecrs => $cnum },$cdom);          &Apache::lonnet::put_dom('lticonsumers',{ $sourcecrs => $cnum },$cdom);
     }      }
   
 #  #
 # Check if user should be hosted here or switched to another server.  # Start user session
 #  #
   
     &Apache::lonnet::logthis(" LTI authorized user: $uname:$udom role: $role course: $cdom\_$cnum");      &lti_session($r,$itemid,$uname,$udom,$uhome,$lonhost,$role,$mapurl,$tail,$symb,
                    $cdom,$cnum,$params,\@ltiroles,$lti{$itemid},\@lcroles,undef,$sourcecrs,
                    $selfenrollrole);
       return OK;
   }
   
   sub get_lti_itemid {
       my ($requri,$hostname,$params,$lti,$lti_by_key) = @_;
       return unless ((ref($params) eq 'HASH') && (ref($lti) eq 'HASH')  && (ref($lti_by_key) eq 'HASH'));
   
       if (exists($params->{'oauth_callback'})) {
           $Net::OAuth::PROTOCOL_VERSION = Net::OAuth::PROTOCOL_VERSION_1_0A;
       } else {
           $Net::OAuth::PROTOCOL_VERSION = Net::OAuth::PROTOCOL_VERSION_1_0;
       }
   
       my $protocol = 'http';
       if ($ENV{'SERVER_PORT'} == 443) {
           $protocol = 'https';
       }
   
       my ($itemid,$consumer_key,$secret);
       my $consumer_key = $params->{'oauth_consumer_key'};
       if (ref($lti_by_key->{$consumer_key}) eq 'ARRAY') {
           foreach my $id (@{$lti_by_key->{$consumer_key}}) {
               if (ref($lti->{$id}) eq 'HASH') {
                   $secret = $lti->{$id}{'secret'};
                   my $request = Net::OAuth->request('request token')->from_hash($params,
                                                      request_url => $protocol.'://'.$hostname.$requri,
                                                      request_method => $env{'request.method'},
                                                      consumer_secret => $secret,);
                   if ($request->verify()) {
                       $itemid = $id;
                       last;
                   }
               }
           }
       }
       return $itemid;
   }
   
   sub lti_enroll {
       my ($uname,$udom,$selfenrollrole) = @_;
       my $enrollresult;
       my ($role,$cdom,$cnum,$sec) =
              ($selfenrollrole =~ m{^(\w+)\./($match_domain)/($match_courseid)(?:|/(\w*))$});
       if (($cnum ne '') && ($cdom ne '')) {
           my $chome = &Apache::lonnet::homeserver($cnum,$cdom);
           if ($chome ne 'no_host') {
               my %coursehash = &Apache::lonnet::coursedescription($cdom.'_'.$cnum);
               my $start = $coursehash{'default_enrollment_start_date'};
               my $end = $coursehash{'default_enrollment_end_date'};
               $enrollresult = &LONCAPA::ltiutils::enrolluser($udom,$uname,$role,$cdom,$cnum,$sec,
                                                              $start,$end,1);
           }
       }
       return $enrollresult;
   }
   
   sub lti_reqcrs {
       my ($r,$cdom,$form,$uname,$udom) = @_;
       my (%can_request,%request_domains);
       &Apache::lonnet::check_can_request($cdom,\%can_request,\%request_domains,$uname,$udom);
       if ($can_request{'lti'}) {
           my %domconfig = &Apache::lonnet::get_dom('configuration',['requestcourses'],$cdom);
           my %domdefs = &Apache::lonnet::get_domain_defaults($cdom);
           &Apache::lonrequestcourse::print_textbook_form($r,$cdom,[$cdom],\%domdefs,
                                                          $domconfig{'requestcourses'},
                                                          \%can_request,'lti',$form);
       } else {
           $r->print(
                 &Apache::loncommon::start_page('Invalid LTI call',undef,{'only_body' => 1}).
                 &mt('Invalid LTI call').
                 &Apache::loncommon::end_page()
           );
       }
   }
   
   sub lti_session {
       my ($r,$itemid,$uname,$udom,$uhome,$lonhost,$role,$mapurl,$tail,$symb,$cdom,$cnum,
           $params,$ltiroles,$ltihash,$lcroles,$reqcrs,$sourcecrs,$selfenrollrole) = @_;
       return unless ((ref($params) eq 'HASH') && (ref($ltiroles) eq 'ARRAY') &&
                      (ref($ltihash) eq 'HASH') && (ref($lcroles) eq 'ARRAY'));
   #
   # Check if user should be hosted here or switched to another server.
   #
     $r->user($uname);      $r->user($uname);
       if ($cnum) {
           if ($role) {
               &Apache::lonnet::logthis(" LTI authorized user ($itemid): $uname:$udom, role: $role, course: $cdom\_$cnum");
           } elsif ($selfenrollrole =~ m{^(\w+)\./$cdom/$cnum}) {
               &Apache::lonnet::logthis(" LTI authorized user ($itemid): $uname:$udom, desired role: $1 course: $cdom\_$cnum");
           }
       } else {
           &Apache::lonnet::logthis(" LTI authorized user ($itemid): $uname:$udom, course dom: $cdom");
       }
     my ($is_balancer,$otherserver,$hosthere);      my ($is_balancer,$otherserver,$hosthere);
     ($is_balancer,$otherserver) =      ($is_balancer,$otherserver) =
         &Apache::lonnet::check_loadbalancing($uname,$udom,'login');          &Apache::lonnet::check_loadbalancing($uname,$udom,'login');
Line 507  sub handler { Line 860  sub handler {
             my $lowest_load;              my $lowest_load;
             ($otherserver,undef,undef,undef,$lowest_load) = &Apache::lonnet::choose_server($udom);              ($otherserver,undef,undef,undef,$lowest_load) = &Apache::lonnet::choose_server($udom);
             if ($lowest_load > 100) {              if ($lowest_load > 100) {
                 $otherserver = &Apache::lonnet::spareserver($lowest_load,$lowest_load,1,$udom);                  $otherserver = &Apache::lonnet::spareserver($r,$lowest_load,$lowest_load,1,$udom);
             }              }
         }          }
         if ($otherserver ne '') {          if ($otherserver ne '') {
Line 517  sub handler { Line 870  sub handler {
             }              }
         }          }
     }      }
       my $protocol = 'http';
       if ($ENV{'SERVER_PORT'} == 443) {
           $protocol = 'https';
       }
     if (($is_balancer) && (!$hosthere)) {      if (($is_balancer) && (!$hosthere)) {
         # login but immediately go to switch server.          # login but immediately go to switch server.
         &Apache::lonauth::success($r,$uname,$udom,$uhome,'noredirect');          &Apache::lonauth::success($r,$uname,$udom,$uhome,'noredirect');
           if (($ltihash->{'callback'}) && ($params->{$ltihash->{'callback'}})) {
               &LONCAPA::ltiutils::setup_logout_callback($uname,$udom,$otherserver,
                                                         $ltihash->{'key'},
                                                         $ltihash->{'secret'},
                                                         $params->{$ltihash->{'callback'}},
                                                         $r->dir_config('ltiIDsDir'),
                                                         $protocol,$r->hostname);
           }
         if ($symb) {          if ($symb) {
             $env{'form.symb'} = $symb;              $env{'form.symb'} = $symb;
               $env{'request.lti.uri'} = $tail;
           } else {
               if ($mapurl) {
                   $env{'form.origurl'} = $mapurl;
                   $env{'request.lti.uri'} = $mapurl;
               } elsif ($tail =~ m{^\Q/tiny/$cdom/\E\w+$}) {
                   $env{'form.origurl'} = $tail;
                   $env{'request.lti.uri'} = $tail;
               } elsif ($tail eq "/$cdom/$cnum") {
                   $env{'form.origurl'} = '/adm/navmaps';
                   $env{'request.lti.uri'} = $tail;
               } else {
                   unless ($tail eq '/adm/roles') {
                       if ($cnum) {
                           $env{'form.origurl'} = '/adm/navmaps';
                       }
                   }
               }
         }          }
         if ($role) {          if ($role) {
             $env{'form.role'} = $role;              $env{'form.role'} = $role;
         }          }
         if ($lti{$itemid}{'passback'}) {          if (($lcroles->[0] eq 'cc') && ($reqcrs)) {
               $env{'request.lti.reqcrs'} = 1;
               $env{'request.lti.reqrole'} = 'cc';
               $env{'request.lti.sourcecrs'} = $sourcecrs;
           }
           if ($selfenrollrole) {
               $env{'request.lti.selfenrollrole'} = $selfenrollrole;
               $env{'request.lti.sourcecrs'} = $sourcecrs;
           }
           if ($ltihash->{'passback'}) {
             if ($params->{'lis_result_sourcedid'}) {              if ($params->{'lis_result_sourcedid'}) {
                 $env{'request.lti.passbackid'} = $params->{'lis_result_sourcedid'};                  $env{'request.lti.passbackid'} = $params->{'lis_result_sourcedid'};
             }              }
Line 534  sub handler { Line 926  sub handler {
                 $env{'request.lti.passbackurl'} = $params->{'lis_outcome_service_url'};                  $env{'request.lti.passbackurl'} = $params->{'lis_outcome_service_url'};
             }              }
         }          }
         if (($lti{$itemid}{'roster'}) && (grep(/^Instructor$/,@ltiroles))) {          if (($ltihash->{'roster'}) && (grep(/^Instructor$/,@{$ltiroles}))) {
             if ($params->{'ext_ims_lis_memberships_id'}) {              if ($params->{'ext_ims_lis_memberships_id'}) {
                 $env{'request.lti.rosterid'} = $params->{'ext_ims_lis_memberships_id'};                   $env{'request.lti.rosterid'} = $params->{'ext_ims_lis_memberships_id'};
             }              }
             if ($params->{'ext_ims_lis_memberships_url'}) {              if ($params->{'ext_ims_lis_memberships_url'}) {
                 $env{'request.lti.rosterurl'} = $params->{'ext_ims_lis_memberships_url'};                  $env{'request.lti.rosterurl'} = $params->{'ext_ims_lis_memberships_url'};
             }              }
         }          }
         $env{'request.lti.login'} = 1;          $env{'request.lti.login'} = $itemid;
         foreach my $key (%{$params}) {          if ($params->{'launch_presentation_document_target'}) {
               $env{'request.lti.target'} = $params->{'launch_presentation_document_target'};
           }
           foreach my $key (keys(%{$params})) {
             delete($env{'form.'.$key});              delete($env{'form.'.$key});
         }          }
         my $redirecturl = '/adm/switchserver';          my $redirecturl = '/adm/switchserver';
Line 555  sub handler { Line 950  sub handler {
     } else {      } else {
         # need to login them in, so generate the need data that          # need to login them in, so generate the need data that
         # migrate expects to do login          # migrate expects to do login
         foreach my $key (%{$params}) {          foreach my $key (keys(%{$params})) {
             delete($env{'form.'.$key});              delete($env{'form.'.$key});
         }          }
           if (($ltihash->{'callback'}) && ($params->{$ltihash->{'callback'}})) {
               &LONCAPA::ltiutils::setup_logout_callback($uname,$udom,$lonhost,
                                                         $ltihash->{'key'},
                                                         $ltihash->{'secret'},
                                                         $params->{$ltihash->{'callback'}},
                                                         $r->dir_config('ltiIDsDir'),
                                                         $protocol,$r->hostname);
           }
         my $ip = $r->get_remote_host();          my $ip = $r->get_remote_host();
         my %info=('ip'        => $ip,          my %info=('ip'        => $ip,
                   'domain'    => $udom,                    'domain'    => $udom,
                   'username'  => $uname,                    'username'  => $uname,
                   'server'    => $lonhost,                    'server'    => $lonhost,
                   'lti.login' => 1,                    'lti.login' => $itemid,
                     'lti.uri'   => $tail,
                  );                   );
         if ($role) {          if ($role) {
             $info{'role'} = $role;              $info{'role'} = $role;
         }          }
         if ($symb) {          if ($symb) {
             $info{'symb'} = $symb;               $info{'symb'} = $symb;
         }          }
         if ($lti{$itemid}{'passback'}) {          if (($lcroles->[0] eq 'cc') && ($reqcrs)) {
               $info{'lti.reqcrs'} = 1;
               $info{'lti.reqrole'} = 'cc';
               $info{'lti.sourcecrs'} = $sourcecrs;
           }
           if ($selfenrollrole) {
               $info{'lti.selfenrollrole'} = $selfenrollrole;
           }
           if ($ltihash->{'passback'}) {
             if ($params->{'lis_result_sourcedid'}) {              if ($params->{'lis_result_sourcedid'}) {
                 $info{'lti.passbackid'} = $params->{'lis_result_sourcedid'}                  $info{'lti.passbackid'} = $params->{'lis_result_sourcedid'}
             }              }
Line 579  sub handler { Line 991  sub handler {
                 $info{'lti.passbackurl'} = $params->{'lis_outcome_service_url'}                  $info{'lti.passbackurl'} = $params->{'lis_outcome_service_url'}
             }              }
         }          }
         if (($lti{$itemid}{'roster'}) && (grep(/^Instructor$/,@ltiroles))) {          if (($ltihash->{'roster'}) && (grep(/^Instructor$/,@{$ltiroles}))) {
             if ($params->{'ext_ims_lis_memberships_id'}) {              if ($params->{'ext_ims_lis_memberships_id'}) {
                 $info{'lti.rosterid'} = $params->{'ext_ims_lis_memberships_id'};                  $info{'lti.rosterid'} = $params->{'ext_ims_lis_memberships_id'};
             }              }
Line 587  sub handler { Line 999  sub handler {
                 $info{'lti.rosterurl'} = $params->{'ext_ims_lis_memberships_url'};                  $info{'lti.rosterurl'} = $params->{'ext_ims_lis_memberships_url'};
             }              }
         }          }
           if ($params->{'launch_presentation_document_target'}) {
               $info{'lti.target'} = $params->{'launch_presentation_document_target'};
           }
   
         unless ($info{'symb'}) {          unless ($info{'symb'}) {
             if ($mapurl) {              if ($mapurl) {
                 $info{'origurl'} = $mapurl;                  $info{'origurl'} = $mapurl;
                 if ($mapurl =~ m{/default_\d+\.sequence$}) {              } elsif ($tail =~ m{^\Q/tiny/$cdom/\E\w+$}) {
                     $info{'origurl'} .=  (($mapurl =~/\?/)?'&':'?').'navmap=1';                  $info{'origurl'} = $tail;
                 }  
             } else {              } else {
                 unless ($tail eq '/adm/roles') {                  unless ($tail eq '/adm/roles') {
                     $info{'origurl'} = '/adm/navmaps';                      if ($cnum) {
                           $info{'origurl'} = '/adm/navmaps';
                       }
                 }                  }
             }              }
         }          }
Line 607  sub handler { Line 1024  sub handler {
         $r->internal_redirect('/adm/migrateuser');          $r->internal_redirect('/adm/migrateuser');
         $r->set_handlers('PerlHandler'=> undef);          $r->set_handlers('PerlHandler'=> undef);
     }      }
     return OK;      return;
 }  }
   
 sub invalid_request {  sub invalid_request {
Line 619  sub invalid_request { Line 1036  sub invalid_request {
     }      }
     &Apache::lonlocal::get_language_handle($r);      &Apache::lonlocal::get_language_handle($r);
     $r->print(      $r->print(
         &Apache::loncommon::start_page('Invalid LTI call').          &Apache::loncommon::start_page('Invalid LTI call','',{ 'only_body' => 1,}).
         &mt('Invalid LTI call [_1]',$num).          &mt('Invalid LTI call [_1]',$num).
         &Apache::loncommon::end_page());          &Apache::loncommon::end_page());
     return;      return;
 }  }
   
   sub course_from_tinyurl {
       my ($tail) = @_;
       my ($urlcdom,$urlcnum);
       if ($tail =~ m{^/tiny/($match_domain)/(\w+)$}) {
           ($urlcdom,my $key) = ($1,$2);
           my $tinyurl;
           my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$urlcdom."\0".$key);
           if (defined($cached)) {
               $tinyurl = $result;
           } else {
               my $configuname = &Apache::lonnet::get_domainconfiguser($urlcdom);
               my %currtiny = &Apache::lonnet::get('tiny',[$key],$urlcdom,$configuname);
               if ($currtiny{$key} ne '') {
                   $tinyurl = $currtiny{$key};
                   &Apache::lonnet::do_cache_new('tiny',$urlcdom."\0".$key,$currtiny{$key},600);
               }
           }
           if ($tinyurl ne '') {
               $urlcnum = (split(/\&/,$tinyurl))[0];
           }
       }
       return ($urlcdom,$urlcnum);
   }
   
 1;  1;
Removed from v.1.3  
changed lines
  Added in v.1.26

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