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

Diff for /loncom/automation/batchcreatecourse.pm between versions 1.31 and 1.39

version 1.31, 2009/09/05 20:20:17 version 1.39, 2013/12/25 09:52:47
Line 56  use strict; Line 56  use strict;
 # <title>Underwater Basket Weaving</title>  # <title>Underwater Basket Weaving</title>
 # <crstype>Course</crstype>  # <crstype>Course</crstype>
 # <coursecode>ss05ubw101</coursecode>  # <coursecode>ss05ubw101</coursecode>
   # <defaultcredits>3</defaultcredits>
 # <coursehome>msul1</coursehome>  # <coursehome>msul1</coursehome>
 # <coursedomain>msu</coursedomain>  # <coursedomain>msu</coursedomain>
 # <reshome>/res/msu/</reshome>  # <reshome>/res/msu/</reshome>
Line 74  use strict; Line 75  use strict;
 # <topmap></topmap>  # <topmap></topmap>
 # <firstres>nav</firstres>  # <firstres>nav</firstres>
 # <crsquota>20</crsquota>  # <crsquota>20</crsquota>
   # <uniquecode>1</uniquecode>
 # <clonecrs>466011437c34194msul1</clonecrs>  # <clonecrs>466011437c34194msul1</clonecrs>
 # <clonedom>msu</clonedom>  # <clonedom>msu</clonedom>
 # <datemode>shift</datemode>  # <datemode>shift</datemode>
Line 122  use strict; Line 124  use strict;
 #   <lastname>Spartan</lastname>x  #   <lastname>Spartan</lastname>x
 #   <middlename></middlename>  #   <middlename></middlename>
 #   <studentID></studentID>  #   <studentID></studentID>
   #   <credits></credits>
 #   <roles></roles>  #   <roles></roles>
 #  </user>  #  </user>
 #  <user>  #  <user>
Line 149  use strict; Line 152  use strict;
 #  #
 # Many of these are binary options (corresponding to either checkboxes or  # Many of these are binary options (corresponding to either checkboxes or
 # radio buttons in the interactive CCRS page).  Examples include:  # radio buttons in the interactive CCRS page).  Examples include:
 # setpolicy, setcontent, setkeys, disableresdis, disablechat, openall  # setpolicy, setcontent, setkeys, disableresdis, disablechat, openall,
   # uniquecode
 #  #
 # A value of 1 between opening and closing tags is equivalent to a   # A value of 1 between opening and closing tags is equivalent to a 
 # checked checkbox or 'Yes' response in the original CCRS web page.  # checked checkbox or 'Yes' response in the original CCRS web page.
Line 159  use strict; Line 163  use strict;
 # firstres can be nav, syl, or blank for "Navigate Contents", Syllabus, or  # firstres can be nav, syl, or blank for "Navigate Contents", Syllabus, or
 # no entry respectively.  # no entry respectively.
 #   # 
 # crstype can be Course or Group  # crstype can be Course or Community
 #  #
 # crsquota is the total disk space permitted for course group portfolio files  # crsquota is the total disk space permitted for course group portfolio files
 # in all course groups.  # in all course groups.
Line 176  use strict; Line 180  use strict;
 #                    /home/httpd/perl/tmp/addcourse/$dom/auto/pending if $context = auto  #                    /home/httpd/perl/tmp/addcourse/$dom/auto/pending if $context = auto
 #                    /home/httpd/perl/tmp/addcourse/$dom/web/$uname_$udom/pending if $context = web  #                    /home/httpd/perl/tmp/addcourse/$dom/web/$uname_$udom/pending if $context = web
 #                      #                    
 # inputs (five)  -  requests - ref to array of filename(s) containing course requests   # inputs (six)   -  requests - ref to array of filename(s) containing course requests 
 #                   courseids - ref to hash to store LON-CAPA course ids of new courses   #                   courseids - ref to hash to store LON-CAPA course ids of new courses 
 #                   context - auto if called from command line, web if called from browser  #                   context - auto if called from command line, web if called from browser
 #                   dom - domain for which the course is being created  #                   dom - domain for which the course is being created
 #                   uname - username of DC who is requesting course creation  #                   uname - username of DC who is requesting course creation
 #                   udom - domain of DC who is requesting course creation  #                   udom - domain of DC who is requesting course creation
 #    #  
 # outputs (three)  -  output - text recording user roles added etc.  # outputs (four)  -  output - text recording user roles added etc.
 #                     logmsg - text to be logged  #                    logmsg - text to be logged
 #                     keysmsg - text containing link(s) to manage keys page(s)   #                    keysmsg - text containing link(s) to manage keys page(s) 
   #                    codehash - reference to hash containing courseID => unique code
   #                               where unique code is a 6 character code, to distribute
   #                               to students as a shortcut to the course.
 #############################################################  #############################################################
   
 sub create_courses {  sub create_courses {
Line 197  sub create_courses { Line 204  sub create_courses {
     open(FILE,"<$$perlvarref{'lonTabDir'}.'/rolesplain.tab");      open(FILE,"<$$perlvarref{'lonTabDir'}.'/rolesplain.tab");
     my @rolesplain = <FILE>;      my @rolesplain = <FILE>;
     close(FILE);      close(FILE);
     foreach (@rolesplain) {      foreach my $item (@rolesplain) {
         if ($_ =~ /^(st|ta|ex|ad|in|cc):([\w\s]+)$/) {          if ($item =~ /^(st|ta|ep|ad|in|cc|co):([\w\s]+):?([\w\s]*)/) {
             $longroles{$1} = $2;              $longroles{'Course'}{$1} = $2;
               $longroles{'Community'}{$1} = $3;
         }          }
     }      }
     my ($logmsg,$keysmsg,$newusermsg,$addresult);      my ($logmsg,$keysmsg,$newusermsg,$addresult,%codehash);
     my %enrollcount = ();      my %enrollcount = ();
     my $newcoursedir = $$perlvarref{'lonDaemons'}.'/tmp/addcourse/'.$dom.'/'.$context;      my $newcoursedir = LONCAPA::tempdir().'/addcourse/'.$dom.'/'.$context;
     if ($context eq 'auto') {      if ($context eq 'auto') {
         $newcoursedir .= '/pending';          $newcoursedir .= '/pending';
     } else {      } else {
Line 221  sub create_courses { Line 229  sub create_courses {
                 &parse_coursereqs($newcoursedir.'/'.$request, \%details);                  &parse_coursereqs($newcoursedir.'/'.$request, \%details);
                 foreach my $num (sort(keys(%details))) {                  foreach my $num (sort(keys(%details))) {
                     my $reqdetails = $details{$num};                      my $reqdetails = $details{$num};
                     my $courseid = &build_course($dom,$num,$context,$reqdetails,\%longroles,\$logmsg,\$newusermsg,\$addresult,\%enrollcount,\$output,\$keysmsg);                      my $code;
                       my $courseid = 
                           &build_course($dom,$num,$context,$reqdetails,\%longroles,\$logmsg,\$newusermsg,
                                         \$addresult,\%enrollcount,\$output,\$keysmsg,undef,undef,undef,undef,\$code);
                     if ($courseid =~m{^/$match_domain/$match_courseid}) {                      if ($courseid =~m{^/$match_domain/$match_courseid}) {
                         $$courseids{$courseid} = $details{$num}{'class'};                          $$courseids{$courseid} = $details{$num}{'class'};
                           if ($code) {
                               $codehash{$courseid} = $code;
                           }
                     }                      }
                 }                  }
             }              }
         }          }
     }      }
     return ($output,$logmsg,$keysmsg);      return ($output,$logmsg,$keysmsg,\%codehash);
 }  }
   
 #############################################################  #############################################################
Line 252  sub parse_coursereqs { Line 266  sub parse_coursereqs {
     my $xlist = 0;      my $xlist = 0;
     my $userkey = '';      my $userkey = '';
     my $role = '';      my $role = '';
     my @items = ('title','optional_id','coursecode','coursehome','reshome','nonstandard','adds','drops','topmap','firstres','clonecrs','clonedom','datemode','dateshift','showphotos','setpolicy','setcontent','setkeys','keyauth','disresdis','disablechat','openall','notify_owner','notify_dc','crstype','crsquota');      my @items = ('title','optional_id','coursecode','defaultcredits','coursehome','reshome','nonstandard','adds','drops','topmap','firstres','clonecrs','clonedom','datemode','dateshift','showphotos','setpolicy','setcontent','setkeys','keyauth','disresdis','disablechat','openall','notify_owner','notify_dc','crstype','crsquota','uniquecode');
       my @possroles = qw(st ad ep ta in cc co);
     my @dateitems = ('enrollstart','enrollend','accessstart','accessend');      my @dateitems = ('enrollstart','enrollend','accessstart','accessend');
     my @useritems = ('autharg','authtype','firstname','generation','lastname','middlename','studentID');      my @useritems = ('autharg','authtype','firstname','generation','lastname','middlename','studentID');
     my $p = HTML::Parser->new      my $p = HTML::Parser->new
Line 272  sub parse_coursereqs { Line 287  sub parse_coursereqs {
                  }                   }
                  if ("@state" eq "class users user roles role") {                   if ("@state" eq "class users user roles role") {
                      $role = $attr->{id};                       $role = $attr->{id};
                      if ($role =~ /^(st|ad|ep|ta|in|cc)$/) {                       if (grep(/^\Q$role\E$/,@possroles)) {
                          push(@{$$details{$num}{'users'}{$userkey}{'roles'}}, $role);                             push(@{$$details{$num}{'users'}{$userkey}{'roles'}}, $role);  
                          %{$$details{$num}{'users'}{$userkey}{$role}} = ();                           %{$$details{$num}{'users'}{$userkey}{$role}} = ();
                          @{$$details{$num}{'users'}{$userkey}{$role}{'usec'}} = ();                           @{$$details{$num}{'users'}{$userkey}{$role}{'usec'}} = ();
Line 318  sub parse_coursereqs { Line 333  sub parse_coursereqs {
                     @{$$details{$num}{'users'}{$userkey}{'roles'}} = ();                      @{$$details{$num}{'users'}{$userkey}{'roles'}} = ();
                  } elsif ("@state" eq "class users user email") {                   } elsif ("@state" eq "class users user email") {
                     $$details{$num}{'users'}{$userkey}{'emailaddr'} = $text;                      $$details{$num}{'users'}{$userkey}{'emailaddr'} = $text;
                     $$details{$num}{'users'}{$userkey}{'emailenc'} = &Apache::lonnet::escape($text);                       $$details{$num}{'users'}{$userkey}{'emailenc'} = &LONCAPA::escape($text); 
                  } elsif ("@state" eq "class users user roles role start") {                   } elsif ("@state" eq "class users user roles role start") {
                      if ($role =~ /^(st|ad|ep|ta|in|cc)$/) {                       if (grep(/^\Q$role\E$/,@possroles)) {
                          $$details{$num}{'users'}{$userkey}{$role}{'start'} = &process_date($text);                           $$details{$num}{'users'}{$userkey}{$role}{'start'} = &process_date($text);
                      }                       }
                  } elsif ("@state" eq "class users user roles role end") {                   } elsif ("@state" eq "class users user roles role end") {
                      if ($role =~ /^(st|ad|ep|ta|in|cc)$/) {                       if (grep(/^\Q$role\E$/,@possroles)) {
                          $$details{$num}{'users'}{$userkey}{$role}{'end'} = &process_date($text);                           $$details{$num}{'users'}{$userkey}{$role}{'end'} = &process_date($text);
                      }                       }
                  } elsif ("@state" eq "class users user roles role usec") {                   } elsif ("@state" eq "class users user roles role usec") {
                      if ($role =~ /^(st|ad|ep|ta|in|cc)$/) {                       if (grep(/^\Q$role\E$/,@possroles)) {
                          unless ($text eq '') {                           unless ($text eq '') {
                              push(@{$$details{$num}{'users'}{$userkey}{$role}{'usec'}},$text);                               push(@{$$details{$num}{'users'}{$userkey}{$role}{'usec'}},$text);
                          }                           }
Line 381  sub parse_coursereqs { Line 396  sub parse_coursereqs {
 #   ref to scalar used to accumulate results of new user additions  #   ref to scalar used to accumulate results of new user additions
 #   ref to hash of enrollment counts for different roles  #   ref to hash of enrollment counts for different roles
 #   ref to scalar used to accumulate information about added roles  #   ref to scalar used to accumulate information about added roles
 #   ref to scalar used to accumulate  
 #   ref to scalar used to accumulate information about access keys  #   ref to scalar used to accumulate information about access keys
 #   domain of DC creating course  #   domain of DC creating course
 #   username of DC creating course     #   username of DC creating course   
 #   optional course number, if unique course number already obtained (e.g., for  #   optional course number, if unique course number already obtained (e.g., for
 #       course requests submitted via course request form.   #       course requests submitted via course request form.
   #   optional category
   #   optional ref to scalar for six character unique identifier
 #  #
 # outputs  # outputs
 #   LON-CAPA courseID for new (created) course  #   LON-CAPA courseID for new (created) course
Line 394  sub parse_coursereqs { Line 410  sub parse_coursereqs {
 #########################################################  #########################################################
   
 sub build_course {  sub build_course {
     my ($cdom,$num,$context,$details,$longroles,$logmsg,$newusermsg,$addresult,$enrollcount,$output,$keysmsg,$udom,$uname,$cnum,$category) = @_;      my ($cdom,$num,$context,$details,$longroles,$logmsg,$newusermsg,$addresult,
           $enrollcount,$output,$keysmsg,$udom,$uname,$cnum,$category,$coderef) = @_;
     return unless (ref($details) eq 'HASH');      return unless (ref($details) eq 'HASH');
     my $owner_uname = $details->{'owner'};      my $owner_uname = $details->{'owner'};
     my $owner_domain = $details->{'domain'};      my $owner_domain = $details->{'domain'};
Line 403  sub build_course { Line 420  sub build_course {
     my $xliststr = '';      my $xliststr = '';
     my $noenddate = '';      my $noenddate = '';
     my $outcome;      my $outcome;
     my ($courseid,$crsudom,$crsunum);      my ($courseid,$crsudom,$crsunum,$crstype,$ccrole,$rolenames);
       if ($details->{'crstype'} eq 'Community') {
           $crstype = $details->{'crstype'};
           $ccrole ='co';
           if (ref($longroles) eq 'HASH') {
               $rolenames = $longroles->{'Community'};
           }
       } else {
           $crstype = 'Course';
           $ccrole = 'cc';
           if (ref($longroles) eq 'HASH') {
               $rolenames = $longroles->{'Course'};
           }
       }
     my $linefeed;      my $linefeed;
     if ($context eq 'auto') {      if ($context eq 'auto') {
         $linefeed = "\n";          $linefeed = "\n";
Line 419  sub build_course { Line 449  sub build_course {
     }      }
     my $firstres =  $details->{'firstres'};      my $firstres =  $details->{'firstres'};
     if ($firstres eq '') {      if ($firstres eq '') {
         $firstres = 'syl';          if ($crstype eq 'Community') {
               $firstres = 'nav';
           } else {
               $firstres = 'syl';
           }
     }      }
     foreach my $secid (sort(keys(%{$details->{'sections'}}))) {      foreach my $secid (sort(keys(%{$details->{'sections'}}))) {
         $sectionstr .= $details->{'sections'}{$secid}{'inst'}.':'.$details->{'sections'}{$secid}{'loncapa'}.',';          $sectionstr .= $details->{'sections'}{$secid}{'inst'}.':'.$details->{'sections'}{$secid}{'loncapa'}.',';
Line 453  sub build_course { Line 487  sub build_course {
                     'cid' => '',                      'cid' => '',
                     'context' => 'createowner',                      'context' => 'createowner',
                     'linefeed' => $linefeed,                      'linefeed' => $linefeed,
                     'role' => 'cc',                      'role' => $ccrole,
                    };                     };
         $outcome = &LONCAPA::Enrollment::create_newuser($ownerargs,$logmsg,$newusermsg,$enrollcount,$addresult,$longroles,\%courseinfo,$context);          $outcome = &LONCAPA::Enrollment::create_newuser($ownerargs,$logmsg,$newusermsg,$enrollcount,$addresult,$rolenames,\%courseinfo,$context);
     } else {      } else {
         $outcome = 'ok';          $outcome = 'ok';
     }      }
Line 475  sub build_course { Line 509  sub build_course {
                course_home =>  $details->{'coursehome'},                 course_home =>  $details->{'coursehome'},
                nonstandard => $details->{'nonstandard'},                 nonstandard => $details->{'nonstandard'},
                crscode => $details->{'coursecode'},                 crscode => $details->{'coursecode'},
                  defaultcredits => $details->{'defaultcredits'},
                crsquota => $details->{'crsquota'},                 crsquota => $details->{'crsquota'},
                  uniquecode => $details->{'uniquecode'},
                clonecourse => $details->{'clonecrs'},                 clonecourse => $details->{'clonecrs'},
                clonedomain => $details->{'clonedom'},                 clonedomain => $details->{'clonedom'},
                datemode => $details->{'datemode'},                 datemode => $details->{'datemode'},
Line 511  sub build_course { Line 547  sub build_course {
             $$logmsg .= &mt('Invalid home server for course').': '.$details->{'coursehome'};              $$logmsg .= &mt('Invalid home server for course').': '.$details->{'coursehome'};
             return;              return;
         }          }
         my ($success, $msg) = &Apache::loncommon::construct_course($courseargs,$logmsg,\$courseid,\$crsudom,\$crsunum,$udom,$uname,$context,$cnum,$category);          my ($success, $msg) = 
               &Apache::loncommon::construct_course($courseargs,$logmsg,\$courseid,\$crsudom,\$crsunum,
                                                    $udom,$uname,$context,$cnum,$category,$coderef);
  $$logmsg .= $msg;   $$logmsg .= $msg;
         if (!$success) {          if (!$success) {
             return;              return;
Line 521  sub build_course { Line 559  sub build_course {
     }      }
           
 #  #
 # Make owner a course coordinator  # Make owner a coordinator
 #  #
     if (($owner_domain) && ($owner_uname)) {      if (($owner_domain) && ($owner_uname)) {
         &Apache::lonnet::assignrole($owner_domain,$owner_uname,$courseid,'cc','','','','',$context);          &Apache::lonnet::assignrole($owner_domain,$owner_uname,$courseid,$ccrole,'','','','',$context);
     }      }
   
 #  #
 # Process other reqested users  # Process other reqested users
 #  #
     my @courseroles = qw(st ep ta in cc);  
       my @courseroles = qw(st ep ta in);
       push(@courseroles,$ccrole);
     if (&owner_is_dc($owner_uname,$owner_domain,$crsudom)) {      if (&owner_is_dc($owner_uname,$owner_domain,$crsudom)) {
         push(@courseroles,'ad');          push(@courseroles,'ad');
     }      }
Line 567  sub build_course { Line 607  sub build_course {
                     }                      }
                 }                  }
                 my $firstsec;                  my $firstsec;
                 unless (($firstrole eq 'cc') || ($firstrole eq ''))  {                  unless (($firstrole eq $ccrole) || ($firstrole eq ''))  {
                     $firstsec = $details->{'users'}{$userkey}{$firstrole}{'usec'}[0];                      $firstsec = $details->{'users'}{$userkey}{$firstrole}{'usec'}[0];
                 }                  }
                 my $userargs = {                  my $userargs = {
Line 590  sub build_course { Line 630  sub build_course {
                     'cdom' => $crsudom,                      'cdom' => $crsudom,
                     'context' => 'createcourse',                      'context' => 'createcourse',
                     'linefeed' => $linefeed,                      'linefeed' => $linefeed,
                     'role' => $details->{'users'}{$userkey}{'roles'}[0],                       'role' => $details->{'users'}{$userkey}{'roles'}[0],
                    };                     };
                   if ($userargs->{'role'} eq 'st') {
                       if (exists($details->{'users'}{$userkey}{'credits'})) {  
                           $userargs->{'credits'} = $details->{'users'}{$userkey}{'credits'};
                           $userargs->{'credits'} =~ s/[^\d\.]//g;
                       }
                   }
                 $outcome = &LONCAPA::Enrollment::create_newuser($userargs,$logmsg,$newusermsg,$enrollcount,$addresult,$longroles,\%courseinfo,$context);                  $outcome = &LONCAPA::Enrollment::create_newuser($userargs,$logmsg,$newusermsg,$enrollcount,$addresult,$longroles,\%courseinfo,$context);
 # now add other roles and other sections.  # now add other roles and other sections.
                 if ($outcome eq 'ok') {                  if ($outcome eq 'ok') {
                     if ((($firstrole ne 'st') && ($firstrole ne 'cc') && ($firstrole ne '')) && (@{$details->{'users'}{$userkey}{$firstrole}{'usec'}} > 1)) {                      if ((($firstrole ne 'st') && ($firstrole ne $ccrole) && ($firstrole ne '')) && (@{$details->{'users'}{$userkey}{$firstrole}{'usec'}} > 1)) {
                         for (my $i=1; $i<@{$details->{'users'}{$userkey}{$firstrole}{'usec'}}; $i++) {                          for (my $i=1; $i<@{$details->{'users'}{$userkey}{$firstrole}{'usec'}}; $i++) {
                             my $curr_role = $firstrole;                              my $curr_role = $firstrole;
                             my $start = $details->{'users'}{$userkey}{$curr_role}{'start'};                              my $start = $details->{'users'}{$userkey}{$curr_role}{'start'};
Line 622  sub build_course { Line 668  sub build_course {
                                 if ($usec ne '') {                                  if ($usec ne '') {
                                     $url .= '/'.$usec;                                      $url .= '/'.$usec;
                                 }                                  }
                                 $$output .= &Apache::loncommon::commit_studentrole(\$stulogmsg,$userdom,$username,$url,$curr_role,$start,$end,$crsudom,$crsunum,$usec,$context);                                  my $credits;
                             } elsif ($curr_role eq 'cc') {                                  if (exists($details->{'users'}{$userkey}{'credits'})) {
                                       $credits = $details->{'users'}{$userkey}{'credits'};
                                       $credits =~ s/[^\d\.]//g;
                                   }
                                   $$output .= &Apache::loncommon::commit_studentrole(\$stulogmsg,$userdom,$username,$url,$curr_role,$start,$end,$crsudom,$crsunum,$usec,$context,$credits);
                               } elsif ($curr_role eq $ccrole) {
                                 $url = '/'.$crsudom.'/'.$crsunum;                                  $url = '/'.$crsudom.'/'.$crsunum;
                                 my $usec = '';                                  my $usec = '';
                                 $$output .=                                  $$output .=
Line 663  sub build_course { Line 714  sub build_course {
                         if ($usec ne '') {                          if ($usec ne '') {
                             $url .= '/'.$usec;                              $url .= '/'.$usec;
                         }                          }
                         $$output .= &Apache::loncommon::commit_studentrole(\$stulogmsg,$userdom,$username,$url,$curr_role,$start,$end,$crsudom,$crsunum,$usec,$context);                          my $credits;
                           if (exists($details->{'users'}{$userkey}{'credits'})) {
                               $credits = $details->{'users'}{$userkey}{'credits'};
                               $credits =~ s/[^\d\.]//g;
                           }
                           $$output .= &Apache::loncommon::commit_studentrole(\$stulogmsg,$userdom,$username,$url,$curr_role,$start,$end,$crsudom,$crsunum,$usec,$context,$credits);
                     } elsif ((grep(/^\Q$curr_role\E$/,@courseroles)) ||                      } elsif ((grep(/^\Q$curr_role\E$/,@courseroles)) ||
                                      ($curr_role =~ m{^cr/$match_domain/$match_username/[^/]+$})) {                                       ($curr_role =~ m{^cr/$match_domain/$match_username/[^/]+$})) {
                         if (@{$details->{'users'}{$userkey}{$curr_role}{'usec'}} > 0) {                          if (@{$details->{'users'}{$userkey}{$curr_role}{'usec'}} > 0) {
Removed from v.1.31  
changed lines
  Added in v.1.39

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