--- loncom/interface/loncommon.pm	2006/08/04 18:56:20	1.442
+++ loncom/interface/loncommon.pm	2006/09/12 22:13:05	1.453
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common routines
 #
-# $Id: loncommon.pm,v 1.442 2006/08/04 18:56:20 albertel Exp $
+# $Id: loncommon.pm,v 1.453 2006/09/12 22:13:05 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -64,6 +64,7 @@ use HTML::Entities;
 use Apache::lonhtmlcommon();
 use Apache::loncoursedata();
 use Apache::lontexconvert();
+use Apache::lonclonecourse();
 use LONCAPA;
 
 my $readit;
@@ -256,7 +257,7 @@ of the element the selection from the se
 sub browser_and_searcher_javascript {
     my ($mode)=@_;
     if (!defined($mode)) { $mode='edit'; }
-    my $resurl=&lastresurl();
+    my $resurl=&escape_single(&lastresurl());
     return <<END;
 // <!-- BEGIN LON-CAPA Internal
     var editbrowser = null;
@@ -728,9 +729,7 @@ sub update_help_link {
     my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
     my $output .= <<"ENDOUTPUT";
 <script type="text/javascript">
-// <!-- BEGIN LON-CAPA Internal
 banner_link = '$banner_link';
-// END LON-CAPA Internal -->
 </script>
 ENDOUTPUT
     return $output;
@@ -2108,6 +2107,9 @@ sub noteswrapper {
 
 sub aboutmewrapper {
     my ($link,$username,$domain,$target)=@_;
+    if (!defined($username)  && !defined($domain)) {
+        return;
+    }
     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
 	($target?' target="$target"':'').' title="'.&mt('View this users personal page').'">'.$link.'</a>';
 }
@@ -2138,7 +2140,9 @@ sub track_student_link {
         $target = '';
     }
     if ($start) { $link.='&amp;start='.$start; }
-    return qq{<a href="$link" title="$title" $target>$linktext</a>};
+    
+    return qq{<a href="$link" title="$title" $target>$linktext</a>}.
+	&help_open_topic('View_recent_activity');
 }
 
 =pod
@@ -3180,6 +3184,7 @@ sub standard_css {
 
     my $border = ($env{'browser.type'} eq 'explorer') ? '0px 2px 0px 2px'
 	                                              : '0px 3px 0px 4px';
+
     return <<END;
 h1, h2, h3, th { font-family: $sans }
 a:focus { color: red; background: yellow } 
@@ -3364,7 +3369,8 @@ table.LC_aboutme_port tr.LC_even_row td
 table.LC_data_table tr.LC_data_table_highlight td {
   background-color: $data_table_darker;
 }
-table.LC_data_table tr.LC_empty_row td {
+table.LC_data_table tr.LC_empty_row td,
+table.LC_whatsnew tr.LC_empty_row td {
   background-color: #FFFFFF;
   font-weight: bold;
   font-style: italic;
@@ -3372,6 +3378,29 @@ table.LC_data_table tr.LC_empty_row td {
   padding: 8px;
 }
 
+table.LC_whatsnew {
+}
+
+table.LC_whatsnew tr th,
+table.LC_whatsnew tr.LC_info_row td {
+  background-color: #CCC;
+  font-weight: bold;
+  font-size: small;
+  text-align: right;
+}
+table.LC_whatsnew tr td {
+  background-color: #FFF;
+  font-size: small;
+  text-align: right;
+}
+table.LC_whatsnew tr td.LC_first_item {
+  text-align: left;
+}
+
+table.LC_whatsnew tr.LC_odd_row td {
+  background-color: #EEE;
+}
+
 table.LC_calendar {
   border: 1px solid #000000;
   border-collapse: collapse;
@@ -3698,6 +3727,7 @@ sub headtag {
     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
     my $url = join(':',$env{'user.name'},$env{'user.domain'},
 		   #time(),
+		   $Apache::lonnet::perlvar{'lonVersion'},
 		   $env{'environment.color.timestamp'},
 		   $function,$domain,$bgcolor);
 
@@ -5505,6 +5535,377 @@ sub restore_course_settings {
 ############################################################
 ############################################################
 
+sub commit_customrole {
+    my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_;
+    my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.'@'.$three.' in '.$url.
+                         ($start?', '.&mt('starting').' '.localtime($start):'').
+                         ($end?', ending '.localtime($end):'').': <b>'.
+              &Apache::lonnet::assigncustomrole(
+                 $udom,$uname,$url,$three,$four,$five,$end,$start).
+                 '</b><br />';
+    return $output;
+}
+
+sub commit_standardrole {
+    my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec) = @_;
+    my $output;
+    my $logmsg;
+    if ($three eq 'st') {
+        my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec);
+        if (($result =~ /^error/) || ($result eq 'not_in_class') || ($result eq 'unknown_course')) {
+            $output = "Error: $result\n"; 
+        } else {
+            $output = &mt('Assigning').' '.$three.' in '.$url.
+               ($start?', '.&mt('starting').' '.localtime($start):'').
+               ($end?', '.&mt('ending').' '.localtime($end):'').
+               ': <b>'.$result.'</b><br />'.
+               &mt('Add to classlist').': <b>ok</b><br />';
+        }
+    } else {
+        $output = &mt('Assigning').' '.$three.' in '.$url.
+               ($start?', '.&mt('starting').' '.localtime($start):'').
+               ($end?', '.&mt('ending').' '.localtime($end):'').': <b>'.
+               &Apache::lonnet::assignrole(
+                   $udom,$uname,$url,$three,$end,$start).
+                   '</b><br />';
+    }
+    return $output;
+}
+
+sub commit_studentrole {
+    my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec) = @_;
+    my $linefeed =  '<br />'."\n";
+    my $result;
+    if (defined($one) && defined($two)) {
+        my $cid=$one.'_'.$two;
+        my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
+        my $secchange = 0;
+        my $expire_role_result;
+        my $modify_section_result;
+        unless ($oldsec eq '-1') {
+            unless ($sec eq $oldsec) {
+                $secchange = 1;
+                my $uurl='/'.$cid;
+                $uurl=~s/\_/\//g;
+                if ($oldsec) {
+                    $uurl.='/'.$oldsec;
+                }
+                $expire_role_result = &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',time);
+                $result = $expire_role_result;
+            }
+        }
+        if (($expire_role_result eq 'ok') || ($secchange == 0)) {
+            $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid);
+            if ($modify_section_result =~ /^ok/) {
+                if ($secchange == 1) {
+                    $$logmsg .= "Section for $uname switched from old section: $oldsec to new section: $sec".$linefeed;
+                } elsif ($oldsec eq '-1') {
+                    $$logmsg .= "New student role for $uname in section $sec in course $cid".$linefeed;
+                } else {
+                    $$logmsg .= "Student $uname assigned to unchanged section $sec in course $cid".$linefeed;
+                }
+            } else {
+                $$logmsg .= "Error when attempting section change for $uname from old section $oldsec to new section: $sec in course $cid -error: $modify_section_result".$linefeed;
+            }
+            $result = $modify_section_result;
+        } elsif ($secchange == 1) {
+            $$logmsg .= "Error when attempting to expire role for $uname in old section $oldsec in course $cid -error: $expire_role_result".$linefeed;
+        }
+    } else {
+        $$logmsg .= "Incomplete course id defined.  Addition of user $uname from domain $udom to course $one\_$two, section $sec not completed.$linefeed";
+        $result = "error: incomplete course id\n";
+    }
+    return $result;
+}
+
+############################################################
+############################################################
+
+sub construct_course {
+    my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname) = @_;
+    my $outcome;
+
+#
+# Open course
+#
+    my $crstype = lc($args->{'crstype'});
+    my %cenv=();
+    $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
+                                             $args->{'cdescr'},
+                                             $args->{'curl'},
+                                             $args->{'course_home'},
+                                             $args->{'nonstandard'},
+                                             $args->{'crscode'},
+                                             $args->{'ccuname'}.':'.
+                                             $args->{'ccdomain'},
+                                             $args->{'crstype'});
+
+    # Note: The testing routines depend on this being output; see 
+    # Utils::Course. This needs to at least be output as a comment
+    # if anyone ever decides to not show this, and Utils::Course::new
+    # will need to be suitably modified.
+    $outcome .= &mt('New LON-CAPA [_1] ID: [_2]<br />',$crstype,$$courseid);
+#
+# Check if created correctly
+#
+    ($$crsudom,$$crsunum)=($$courseid=~/^\/(\w+)\/(\w+)$/);
+    my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
+    $outcome .= &mt('Created on').': '.$crsuhome.'<br>';
+#
+# Are we cloning?
+#
+    my $cloneid='';
+    if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
+	$cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
+        my ($clonecrsudom,$clonecrsunum)=($cloneid=~/^\/(\w+)\/(\w+)$/);
+	my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
+	if ($clonehome eq 'no_host') {
+	    $outcome .=
+    '<br /><font color="red">'.&mt('Attempting to clone non-existing [_1]',$crstype).' '.$cloneid.'</font>';
+	} else {
+	    $outcome .= 
+    '<br /><font color="green">'.&mt('Cloning [_1] from [_2]',$crstype,$clonehome).'</font>';
+	    my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
+# Copy all files
+	    &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid);
+# Restore URL
+	    $cenv{'url'}=$oldcenv{'url'};
+# Restore title
+	    $cenv{'description'}=$oldcenv{'description'};
+# restore grading mode
+	    if (defined($oldcenv{'grading'})) {
+		$cenv{'grading'}=$oldcenv{'grading'};
+	    }
+# Mark as cloned
+	    $cenv{'clonedfrom'}=$cloneid;
+	    delete($cenv{'default_enrollment_start_date'});
+	    delete($cenv{'default_enrollment_end_date'});
+	}
+    }
+#
+# Set environment (will override cloned, if existing)
+#
+    my @sections = ();
+    my @xlists = ();
+    if ($args->{'crstype'}) {
+        $cenv{'type'}=$args->{'crstype'};
+    }
+    if ($args->{'crsid'}) {
+        $cenv{'courseid'}=$args->{'crsid'};
+    }
+    if ($args->{'crscode'}) {
+        $cenv{'internal.coursecode'}=$args->{'crscode'};
+    }
+    if ($args->{'crsquota'} ne '') {
+        $cenv{'internal.coursequota'}=$args->{'crsquota'};
+    } else {
+        $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
+    }
+    if ($args->{'ccuname'}) {
+        $cenv{'internal.courseowner'} = $args->{'ccuname'}.
+                                        ':'.$args->{'ccdomain'};
+    } else {
+        $cenv{'internal.courseowner'} = $args->{'curruser'};
+    }
+
+    my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
+    if ($args->{'crssections'}) {
+        $cenv{'internal.sectionnums'} = '';
+        if ($args->{'crssections'} =~ m/,/) {
+            @sections = split/,/,$args->{'crssections'};
+        } else {
+            $sections[0] = $args->{'crssections'};
+        }
+        if (@sections > 0) {
+            foreach my $item (@sections) {
+                my ($sec,$gp) = split/:/,$item;
+                my $class = $args->{'crscode'}.$sec;
+                my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
+                $cenv{'internal.sectionnums'} .= $item.',';
+                unless ($addcheck eq 'ok') {
+                    push @badclasses, $class;
+                }
+            }
+            $cenv{'internal.sectionnums'} =~ s/,$//;
+        }
+    }
+# do not hide course coordinator from staff listing, 
+# even if privileged
+    $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
+# add crosslistings
+    if ($args->{'crsxlist'}) {
+        $cenv{'internal.crosslistings'}='';
+        if ($args->{'crsxlist'} =~ m/,/) {
+            @xlists = split/,/,$args->{'crsxlist'};
+        } else {
+            $xlists[0] = $args->{'crsxlist'};
+        }
+        if (@xlists > 0) {
+            foreach my $item (@xlists) {
+                my ($xl,$gp) = split/:/,$item;
+                my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
+                $cenv{'internal.crosslistings'} .= $item.',';
+                unless ($addcheck eq 'ok') {
+                    push @badclasses, $xl;
+                }
+            }
+            $cenv{'internal.crosslistings'} =~ s/,$//;
+        }
+    }
+    if ($args->{'autoadds'}) {
+        $cenv{'internal.autoadds'}=$args->{'autoadds'};
+    }
+    if ($args->{'autodrops'}) {
+        $cenv{'internal.autodrops'}=$args->{'autodrops'};
+    }
+# check for notification of enrollment changes
+    my @notified = ();
+    if ($args->{'notify_owner'}) {
+        if ($args->{'ccuname'} ne '') {
+            push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
+        }
+    }
+    if ($args->{'notify_dc'}) {
+        if ($uname ne '') { 
+            push(@notified,$uname.'@'.$udom);
+        }
+    }
+    if (@notified > 0) {
+        my $notifylist;
+        if (@notified > 1) {
+            $notifylist = join(',',@notified);
+        } else {
+            $notifylist = $notified[0];
+        }
+        $cenv{'internal.notifylist'} = $notifylist;
+    }
+    if (@badclasses > 0) {
+        my %lt=&Apache::lonlocal::texthash(
+                'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.  However, if automated course roster updates are enabled for this class, these particular sections/crosslistings will not contribute towards enrollment, because the user identified as the course owner for this LON-CAPA course',
+                'dnhr' => 'does not have rights to access enrollment in these classes',
+                'adby' => 'as determined by the policies of your institution on access to official classlists'
+        );
+        $outcome .= '<font color="red">'.$lt{'tclb'}.' ('.$cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.' ('.$lt{'adby'}.').<br /><ul>'."\n";
+        foreach (@badclasses) {
+            $outcome .= "<li>$_</li>\n";
+        }
+        $outcome .= "</ul><br /><br /></font>\n";
+    }
+    if ($args->{'no_end_date'}) {
+        $args->{'endaccess'} = 0;
+    }
+    $cenv{'internal.autostart'}=$args->{'enrollstart'};
+    $cenv{'internal.autoend'}=$args->{'enrollend'};
+    $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
+    $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
+    if ($args->{'showphotos'}) {
+      $cenv{'internal.showphotos'}=$args->{'showphotos'};
+    }
+    $cenv{'internal.authtype'} = $args->{'authtype'};
+    $cenv{'internal.autharg'} = $args->{'autharg'}; 
+    if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
+        if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
+            $outcome .= '<font color="red" size="+1">'.
+                      &mt('As you did not include the default Kerberos domain to be used for authentication in this class, the institutional data used by the automated enrollment process must include the Kerberos domain for each new student').'</font></p>';
+        }
+    }
+    if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
+       if ($args->{'setpolicy'}) {
+           $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
+       }
+       if ($args->{'setcontent'}) {
+           $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
+       }
+    }
+    if ($args->{'reshome'}) {
+	$cenv{'reshome'}=$args->{'reshome'}.'/';
+	$cenv{'reshome'}=~s/\/+$/\//;
+    }
+#
+# course has keyed access
+#
+    if ($args->{'setkeys'}) {
+       $cenv{'keyaccess'}='yes';
+    }
+# if specified, key authority is not course, but user
+# only active if keyaccess is yes
+    if ($args->{'keyauth'}) {
+	$args->{'keyauth'}=~s/[^\w\@]//g;
+	if ($args->{'keyauth'}) {
+	    $cenv{'keyauth'}=$args->{'keyauth'};
+	}
+    }
+
+    if ($args->{'disresdis'}) {
+        $cenv{'pch.roles.denied'}='st';
+    }
+    if ($args->{'disablechat'}) {
+        $cenv{'plc.roles.denied'}='st';
+    }
+
+    # Record we've not yet viewed the Course Initialization Helper for this 
+    # course
+    $cenv{'course.helper.not.run'} = 1;
+    #
+    # Use new Randomseed
+    #
+    $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
+    $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
+    #
+    # The encryption code and receipt prefix for this course
+    #
+    $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
+    $cenv{'internal.encpref'}=100+int(9*rand(99));
+    #
+    # By default, use standard grading
+    if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
+
+    $outcome .= ('<br />'.&mt('Setting environment').': '.                 
+          &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).'<br>');
+#
+# Open all assignments
+#
+    if ($args->{'openall'}) {
+       my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
+       my %storecontent = ($storeunder         => time,
+                           $storeunder.'.type' => 'date_start');
+       
+       $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
+                 ('resourcedata',\%storecontent,$$crsudom,$$crsunum).'<br>';
+   }
+#
+# Set first page
+#
+    unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
+	    || ($cloneid)) {
+	use LONCAPA::map;
+	$outcome .= &mt('Setting first resource').': ';
+
+	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
+        my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
+
+        $outcome .= ($fatal?$errtext:'read ok').' - ';
+        my $title; my $url;
+        if ($args->{'firstres'} eq 'syl') {
+	    $title='Syllabus';
+            $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
+        } else {
+            $title='Navigate Contents';
+            $url='/adm/navmaps';
+        }
+
+        $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
+	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
+
+	if ($errtext) { $fatal=2; }
+        $outcome .= ($fatal?$errtext:'write ok').'<br />';
+    }
+    return $outcome;
+}
+
+############################################################
+############################################################
+
 sub course_type {
     my ($cid) = @_;
     if (!defined($cid)) {
@@ -5549,6 +5950,15 @@ sub lonhttpdurl {
     return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
 }
 
+sub absolute_url {
+    my ($host_name) = @_;
+    my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
+    if ($host_name eq '') {
+	$host_name = $ENV{'SERVER_NAME'};
+    }
+    return $protocol.$host_name;
+}
+
 sub connection_aborted {
     my ($r)=@_;
     $r->print(" ");$r->rflush();