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

Diff for /loncom/interface/selfenroll.pm between versions 1.25 and 1.36

version 1.25, 2010/01/16 16:13:42 version 1.36, 2021/05/04 18:47:36
Line 35  use Apache::loncommon; Line 35  use Apache::loncommon;
 use Apache::lonlocal;  use Apache::lonlocal;
 use Apache::createaccount;  use Apache::createaccount;
 use Apache::loncoursequeueadmin;  use Apache::loncoursequeueadmin;
   use Apache::lonuserutils;
 use LONCAPA qw(:DEFAULT :match);  use LONCAPA qw(:DEFAULT :match);
   
 sub handler {  sub handler {
Line 54  sub handler { Line 55  sub handler {
     &Apache::lonlocal::get_language_handle($r);      &Apache::lonlocal::get_language_handle($r);
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['courseid']);      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['courseid']);
     my $js = &Apache::createaccount::catreturn_js();      my $js = &Apache::createaccount::catreturn_js();
     my ($coursechk,$courseid) = &validate_course_id($env{'form.courseid'});  
     if ($coursechk ne 'ok') {      my $courseid = Apache::lonnet::is_course($env{'form.courseid'});
         &page_header($r,$courseid,$js);  
       unless ($courseid) {
           &page_header($r,$env{'form.courseid'},$js);
         $r->print('<h3>'.&mt('Self-enrollment error').'</h3>'.          $r->print('<h3>'.&mt('Self-enrollment error').'</h3>'.
                   '<span class="LC_error">'.                    '<span class="LC_error">'.
                   &mt('Invalid domain or course number').'</span>');                    &mt('Invalid domain or course number').'</span>');
Line 81  sub handler { Line 84  sub handler {
         $knownuser,$selfenroll_access_start,$selfenroll_access_end,          $knownuser,$selfenroll_access_start,$selfenroll_access_end,
         $selfenroll_section,$selfenroll_future,%curr_role,$cdomdesc,          $selfenroll_section,$selfenroll_future,%curr_role,$cdomdesc,
         $selfenroll_approval,$selfenroll_limit,$selfenroll_cap,          $selfenroll_approval,$selfenroll_limit,$selfenroll_cap,
         $selfenroll_notifylist,$owner);          $selfenroll_notifylist,$owner,$crstype);
     $selfenroll_types = $coursehash{'internal.selfenroll_types'};      $selfenroll_types = $coursehash{'internal.selfenroll_types'};
     $selfenroll_registered =  $coursehash{'internal.selfenroll_registered'};      $selfenroll_registered =  $coursehash{'internal.selfenroll_registered'};
     $selfenroll_section = $coursehash{'internal.selfenroll_section'};      $selfenroll_section = $coursehash{'internal.selfenroll_section'};
Line 92  sub handler { Line 95  sub handler {
     $selfenroll_approval = $coursehash{'internal.selfenroll_approval'};      $selfenroll_approval = $coursehash{'internal.selfenroll_approval'};
     $selfenroll_notifylist = $coursehash{'internal.selfenroll_notifylist'};      $selfenroll_notifylist = $coursehash{'internal.selfenroll_notifylist'};
     $owner = $coursehash{'internal.courseowner'};      $owner = $coursehash{'internal.courseowner'};
       $crstype = $coursehash{'internal.type'};
       if ($crstype eq '') {
           $crstype = 'Course';
       }
     my $nospace;      my $nospace;
     if ($selfenroll_types ne '') {      if ($selfenroll_types ne '') {
         my $start = $coursehash{'internal.selfenroll_start_date'};          my $start = $coursehash{'internal.selfenroll_start_date'};
Line 214  sub handler { Line 221  sub handler {
     if ($sso_url eq '') {      if ($sso_url eq '') {
         $sso_url = $login_path;          $sso_url = $login_path;
     }      }
     $missing_formitem = &mt('The link to the requested page could not be followed.')."\\n".&mt('The placeholder for the courseID is absent.');      $missing_formitem = &mt('The link to the requested page could not be followed.')."\n".&mt('The placeholder for the courseID is absent.');
       &js_escape(\$missing_formitem);
     if ($knownuser) {      if ($knownuser) {
         if (keys(%curr_role)) {          if (keys(%curr_role)) {
             $r->print('<h3>'.&mt('Self-enrollment unavailable').'</h3>'.              $r->print('<h3>'.&mt('Self-enrollment unavailable').'</h3>'.
Line 225  sub handler { Line 233  sub handler {
         &process_self_enroll($r,$cdom,$cnum,$selfenroll_types,$selfenroll_registered,          &process_self_enroll($r,$cdom,$cnum,$selfenroll_types,$selfenroll_registered,
                              $selfenroll_access_start,$selfenroll_access_end,                               $selfenroll_access_start,$selfenroll_access_end,
                              $selfenroll_section,$now,$selfenroll_approval,                               $selfenroll_section,$now,$selfenroll_approval,
                              $selfenroll_notifylist,$owner);                               $selfenroll_notifylist,$owner,$crstype,$lonhost,$handle);
     } elsif ($env{'form.phase'} eq 'login') {      } elsif ($env{'form.phase'} eq 'login') {
         my $submit_text = &mt('Log in');          my $submit_text = &mt('Log in');
         $r->print('<h3>'.&mt('Log-in to LON-CAPA').'</h3>');          $r->print('<h3>'.&mt('Log-in to LON-CAPA').'</h3>');
Line 342  sub enrollment_limit_check { Line 350  sub enrollment_limit_check {
 sub page_header {  sub page_header {
     my ($r,$courseid,$js,$desc) = @_;      my ($r,$courseid,$js,$desc) = @_;
     my $start_page =      my $start_page =
         &Apache::loncommon::start_page('Self-enroll in a LON-CAPA course',$js,          &Apache::loncommon::start_page('Self-enroll in a LON-CAPA course',$js);
                                        {'no_inline_link'   => 1,});  
     $r->print($start_page);      $r->print($start_page);
     &Apache::lonhtmlcommon::clear_breadcrumbs();      &Apache::lonhtmlcommon::clear_breadcrumbs();
     &Apache::createaccount::selfenroll_crumbs($r,$courseid,$desc);      &Apache::createaccount::selfenroll_crumbs($r,$courseid,$desc);
Line 359  sub page_footer { Line 366  sub page_footer {
     return;      return;
 }  }
   
 sub validate_course_id {  
     my ($courseid) = @_;  
     my ($cdom,$cnum) = ($env{'form.courseid'} =~ /^($match_domain)_($match_courseid)$/);  
     if ($cdom ne '' && $cnum ne '') {  
         if (&Apache::lonnet::is_course($cdom,$cnum)) {  
             return ('ok',$courseid);  
         }  
     }   
     return;  
 }  
   
 sub user_is_known {  sub user_is_known {
     my $known = 0;      my $known = 0;
     if ($env{'user.name'} ne '' && $env{'user.name'} ne 'public'      if ($env{'user.name'} ne '' && $env{'user.name'} ne 'public'
Line 415  sub has_role { Line 411  sub has_role {
 sub process_self_enroll {  sub process_self_enroll {
     my ($r,$cdom,$cnum,$selfenroll_types,$selfenroll_registered,      my ($r,$cdom,$cnum,$selfenroll_types,$selfenroll_registered,
         $selfenroll_access_start,$selfenroll_access_end,$selfenroll_section,          $selfenroll_access_start,$selfenroll_access_end,$selfenroll_section,
         $now,$selfenroll_approval,$selfenroll_notifylist,$owner) = @_;          $now,$selfenroll_approval,$selfenroll_notifylist,$owner,$crstype,$lonhost,$handle) = @_;
     my $udom = $env{'user.domain'};      my $udom = $env{'user.domain'};
     my $uname = $env{'user.name'};      my $uname = $env{'user.name'};
     my $selfenroll = 0;      my $selfenroll = 0;
Line 442  sub process_self_enroll { Line 438  sub process_self_enroll {
         if ($selfenroll_section eq 'none') {          if ($selfenroll_section eq 'none') {
             $usec = '';              $usec = '';
         }          }
           my $instcid;
         if ($selfenroll_registered) {          if ($selfenroll_registered) {
             my ($registered,$instsec,$message) = &check_registered($cdom,$cnum);              my ($registered,$instsec,$instcid,$message) = &check_registered($cdom,$cnum);
             $usec = $instsec;              $usec = $instsec;
             if (!$registered) {              if (!$registered) {
                 $r->print('<h3>'.&mt('Self-enrollment unavailable').'</h3>'.&mt('Self-enrollment is restricted to students officially registered for this course.').'<br />');                  $r->print('<h3>'.&mt('Self-enrollment unavailable').'</h3>'.
                             &mt('Self-enrollment is restricted to students officially registered for this course.').'<br />');
                 if ($message) {                  if ($message) {
                     $r->print($message);                      $r->print($message);
                 } else {                  } else {
Line 457  sub process_self_enroll { Line 455  sub process_self_enroll {
         }          }
         if ($selfenroll_approval) {          if ($selfenroll_approval) {
             my $outcome =               my $outcome = 
                 &store_selfenroll_request($udom,$uname,$usec,$cdom,$cnum,                  &store_selfenroll_request($r,$udom,$uname,$usec,$cdom,$cnum,
                                           $selfenroll_notifylist,$owner);                                            $selfenroll_notifylist,$owner,
                                             $selfenroll_approval,$crstype,$lonhost,$handle);
             $r->print($outcome);              $r->print($outcome);
         } else {          } else {
             my $enrollresult =               my $enrollresult = 
                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,                  &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,
                         undef,undef,$usec,$selfenroll_access_end,$selfenroll_access_start,                          undef,undef,$usec,$selfenroll_access_end,$selfenroll_access_start,
                        'selfenroll',undef,$cdom.'_'.$cnum,$selfenroll);                         'selfenroll',undef,$cdom.'_'.$cnum,$selfenroll,'selfenroll','',$instcid);
             if ($enrollresult eq 'ok') {              if ($enrollresult eq 'ok') {
                 my (%userroles,%newrole,%newgroups);                  my (%userroles,%newrole,%newgroups);
                 my $role = 'st';                  my $role = 'st';
Line 536  sub user_can_selfenroll { Line 535  sub user_can_selfenroll {
 }  }
   
 sub store_selfenroll_request {  sub store_selfenroll_request {
     my ($udom,$uname,$usec,$cdom,$cnum,$selfenroll_notifylist,$owner) = @_;      my ($r,$udom,$uname,$usec,$cdom,$cnum,$selfenroll_notifylist,$owner,
           $selfenroll_approval,$crstype,$lonhost,$handle) = @_;
     my $namespace = 'selfenrollrequests';      my $namespace = 'selfenrollrequests';
     my $output;      my $output;
     my $now = time;      my $now = time;
     my %existing =       my %existing = 
         &Apache::lonnet::get($namespace,[$uname.':'.$udom],$cdom,$cnum);          &Apache::lonnet::get($namespace,[$uname.':'.$udom],$cdom,$cnum);
     if ($existing{$uname.':'.$udom}) {      if ($existing{$uname.':'.$udom}) {
         $output = &mt('A self-enrollment request already exists for you for this course.').'<br />'.&mt('Your earlier request is in a queue awaiting action by a Course Coordinator.').          my $status;
                   '<br /><br />'.&Apache::loncoursequeueadmin::queued_selfenrollment();          $output = &mt('A self-enrollment request already exists for you for this course.').'<br />';
           my %info = &Apache::lonnet::get($namespace,[$cdom.'_'.$cnum],$udom,$uname);
           if (ref($info{$cdom.'_'.$cnum}) eq 'HASH') {
               $status = $info{$cdom.'_'.$cnum}{'status'};
           }
           if ($status eq 'pending') {
               my $token = $info{$cdom.'_'.$cnum}{'token'};
               my ($statusupdate,$pendingform) = &pending_selfenrollment_form($r,$cdom,$cnum,$crstype,$token,$lonhost);
               if ($statusupdate eq 'pending') {
                   $output .= $pendingform;
               }
           } else {
               $output .= &mt('Your earlier request is in a queue awaiting action by a Course Coordinator.').
                          '<br /><br />'.&Apache::loncoursequeueadmin::queued_selfenrollment();
           }
     } else {      } else {
         my %selfenroll = (          my %selfenroll = (
                             $uname.':'.$udom => $now.':'.$usec,                              $uname.':'.$udom => $now.':'.$usec,
                          );                           );
         my $putresult = &Apache::lonnet::put($namespace,\%selfenroll,$cdom,$cnum);          my $putresult = &Apache::lonnet::put($namespace,\%selfenroll,$cdom,$cnum);
           my $status = 'request';
           if ($selfenroll_approval eq '2') {
               $status = 'pending';
           } 
         if ($putresult eq 'ok') {          if ($putresult eq 'ok') {
             my %userenroll = (              my %userenroll = (
                                $cdom.'_'.$cnum =>  {                                 $cdom.'_'.$cnum =>  {
                                                       timestamp => $now,                                                        timestamp => $now,
                                                       section   => $usec,                                                        section   => $usec,
                                                       status    => 'request',                                                         status    => $status,
                                                    });                                                     });
               my $token;
               if ($status eq 'pending') {
                   $token = &Apache::lonnet::tmpput(\%selfenroll,$lonhost);
                   $userenroll{$cdom.'_'.$cnum}{'token'} = $token;
                   $userenroll{$cdom.'_'.$cnum}{'lonhost'} = $lonhost;
                   $userenroll{$cdom.'_'.$cnum}{'handle'} = $handle; 
               } 
             my $warning;              my $warning;
             my $userresult = &Apache::lonnet::put($namespace,\%userenroll,$udom,$uname);              my $userresult = &Apache::lonnet::put($namespace,\%userenroll,$udom,$uname);
             if ($userresult ne 'ok') {              if ($userresult ne 'ok') {
                 $warning = &mt('An error occurred saving a personal record of your request.');                  $warning = &mt('An error occurred saving a personal record of your request.');
             }              }
             $output = &mt('Your request for self-enrollment has been recorded.').'<br />'.              $output = &mt('Your request for self-enrollment has been recorded.').'<br />';
                       &mt('A message will be sent to your LON-CAPA account when the course coordinator takes action on your request.').'<br />'.              if ($status eq 'pending') {
                       &mt('To access your LON-CAPA message, go to the Main Menu and click on "Send and Receive Messages".').'<br />';                  my ($statusupdate,$pendingform) = &pending_selfenrollment_form($r,$cdom,$cnum,$crstype,$token,$lonhost);
             my %emails = &Apache::loncommon::getemails($uname,$udom);                  if ($statusupdate eq 'request') {
             if (($emails{'permanentemail'} ne '') || ($emails{'notification'} ne '')) {                      $status = $statusupdate;
                 my $address = $emails{'permanentemail'};                  } else {
                 if ($address eq '') {                      $output .= $pendingform;
                     $address = $emails{'notification'};                  }
                 }              }
                 $output.= &mt('An e-mail will also be sent to: [_1] when this occurs.',$address).'<br />';              if ($status eq 'request') {
             }                  $output .= &mt('A message will be sent to your LON-CAPA account when the course coordinator takes action on your request.').'<br />'.
             if ($warning) {                              &mt('To access your LON-CAPA message, go to the Main Menu and click on "Send and Receive Messages".').'<br />';
                 $output .= '<span class="LC_warning">'.$warning.'</span><br />';                  my %emails = &Apache::loncommon::getemails($uname,$udom);
             }                  if (($emails{'permanentemail'} ne '') || ($emails{'notification'} ne '')) {
                       my $address = $emails{'permanentemail'};
             $output .= &Apache::loncoursequeueadmin::queued_selfenrollment();                      if ($address eq '') {
                           $address = $emails{'notification'};
             if ($selfenroll_notifylist) {                      }
                 my $fullname = &Apache::loncommon::plainname($uname,$udom);                      $output.= &mt('An e-mail will also be sent to: [_1] when this occurs.',$address).'<br />';
                 my %courseinfo = &Apache::lonnet::coursedescription($cdom.'_'.$cnum);                  }
                 my $coursedesc = $courseinfo{'description'};                  if ($warning) { 
                 &Apache::loncoursequeueadmin::send_selfserve_notification(                      $output .= '<span class="LC_warning">'.$warning.'</span><br />';
                     $selfenroll_notifylist,$fullname,$cdom.'_'.$cnum,                  }
                     $coursedesc,$now,'selfenrollreq',$owner);                  $output .= &Apache::loncoursequeueadmin::queued_selfenrollment();
   
                   if ($selfenroll_notifylist) {
                       my $fullname = &Apache::loncommon::plainname($uname,$udom);
                       my %courseinfo = &Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                       my $coursedesc = $courseinfo{'description'};
                       &Apache::loncoursequeueadmin::send_selfserve_notification(
                           $selfenroll_notifylist,$fullname,$cdom.'_'.$cnum,
                           $coursedesc,$now,'selfenrollreq',$owner);
                   }
             }              }
         } else {          } else {
             $output = '<span class="LC_error">'.&mt('An error occurred when recording your request.').'</span>';              $output = '<span class="LC_error">'.&mt('An error occurred when recording your request.').'</span>';
Line 595  sub store_selfenroll_request { Line 629  sub store_selfenroll_request {
     return $output;      return $output;
 }  }
   
   sub pending_selfenrollment_form {
       my ($r,$cdom,$cnum,$crstype,$token,$lonhost) = @_;
       my ($status,$output);
       my $coursetype = &Apache::lonuserutils::get_extended_type($cdom,$cnum,$crstype);
       my %postvalues = (
                         'username'   => $env{'user.name'},
                         'domain'     => $env{'user.domain'},
                         'course'     => $cdom.'_'.$cnum,
                         'coursetype' => $coursetype,
                                    );
       my %domconfig = &Apache::lonnet::get_dom('configuration',['selfenrollment'],$cdom);
   
       if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
           my ($url,$buttontext,$code,@fields);
           if (ref($domconfig{'selfenrollment'}{'validation'}) eq 'HASH') {
               my %courseinfo = &Apache::lonnet::coursedescription($cdom.'_'.$cnum,{ 'one_time' => 1});
               $postvalues{'uniquecode'} = $courseinfo{'internal.uniquecode'};
               $postvalues{'description'} = $courseinfo{'description'};
               $url = $domconfig{'selfenrollment'}{'validation'}{'url'};
               if (ref($domconfig{'selfenrollment'}{'validation'}{'fields'}) eq 'ARRAY') {
                   @fields = @{$domconfig{'selfenrollment'}{'validation'}{'fields'}};
               }
               $buttontext = $domconfig{'selfenrollment'}{'validation'}{'button'};
   
               $output .= $domconfig{'selfenrollment'}{'validation'}{'markup'};
               if (($url =~ m{^(https?\://|/)}) && (@fields > 0)) {
                   $output .= '<form name="selfenrollvalidation" action="'.$url.'" method="post">'."\n";
                   foreach my $field (@fields) {
                       if ($postvalues{$field}) {
                           $output .= '<input type="hidden" name="'.$field.'" value="'.$postvalues{$field}.'" />'."\n";
                       }
                   }
                   if ($buttontext eq '') {
                       $buttontext = &mt('Complete my enrollment');
                   }
                   my $hostname = &Apache::lonnet::hostname($lonhost);
                   my $protocol = $Apache::lonnet::protocol{$lonhost};
                   $protocol = 'http' if ($protocol ne 'https');
                   my $alias = &Apache::lonnet::use_proxy_alias($r,$lonhost);
                   $hostname = $alias if ($alias ne '');
                   my $enroller = $protocol.'://'.$hostname.'/cgi-bin/enrollqueued.pl';
                   $output .= '<input type="hidden" name="enroller" value="'.$enroller.'" />'."\n".
                              '<input type="hidden" name="token" value="'.$token.'" />'."\n".
                              '<input type="submit" name="validate" value="'.$buttontext.'" />'."\n".
                              '</form>'."\n";
                   $status = 'pending';
               } else {
                   $status = 'request';
               }
           }
       } else {
           $status = 'request';
       }
       return ($status,$output);
   }
   
 sub jump_to_role {  sub jump_to_role {
     my ($role) = @_;      my ($role) = @_;
     my $output = <<"END";      my $output = <<"END";
Line 699  sub print_selfenroll_types { Line 789  sub print_selfenroll_types {
   
 sub check_registered {  sub check_registered {
     my ($cdom,$cnum) = @_;      my ($cdom,$cnum) = @_;
     my ($registered,$instsec,$message);      my ($registered,$instsec,$instcid,$message);
     my %settings = &Apache::lonnet::get('environment',['internal.coursecode',      my %settings = &Apache::lonnet::get('environment',['internal.coursecode',
                                         'internal.sectionnums',                                          'internal.sectionnums',
                                         'internal.crosslistings'],$cdom,$cnum);                                          'internal.crosslistings'],$cdom,$cnum);
Line 719  sub check_registered { Line 809  sub check_registered {
                     if (defined($enrolled{$env{'user.name'}})) {                      if (defined($enrolled{$env{'user.name'}})) {
                         $registered = 1;                          $registered = 1;
                         $instsec = $LC_code{$class};                          $instsec = $LC_code{$class};
                           $instcid = $class;
                         last;                          last;
                     }                      }
                 }                  }
Line 731  sub check_registered { Line 822  sub check_registered {
     } else {      } else {
         $message = &mt('As no institutional course sections are currently associated with this course, your registration status is undetermined.');           $message = &mt('As no institutional course sections are currently associated with this course, your registration status is undetermined.'); 
     }      }
     return ($registered,$instsec,$message);      return ($registered,$instsec,$instcid,$message);
 }  }
   
 1;  1;
Removed from v.1.25  
changed lines
  Added in v.1.36

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