--- loncom/interface/loncommon.pm 2007/06/22 17:42:46 1.538 +++ loncom/interface/loncommon.pm 2007/07/11 20:37:52 1.549 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common routines # -# $Id: loncommon.pm,v 1.538 2007/06/22 17:42:46 albertel Exp $ +# $Id: loncommon.pm,v 1.549 2007/07/11 20:37:52 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -240,7 +240,7 @@ Inputs: formname, elementname formname and elementname specify the name of the html form and the name of the element the selection from the search results will be placed in. -=back + =cut sub browser_and_searcher_javascript { @@ -524,7 +524,8 @@ function uncheckAll(field) { if (field.length > 0) { for (i = 0; i < field.length; i++) { field[i].checked = false ; - } } else { + } + } else { field.checked = false ; } } @@ -1078,7 +1079,7 @@ sub changable_area { =pod =back - + =head1 Excel and CSV file utility routines =over 4 @@ -1212,7 +1213,7 @@ sub create_workbook { =item * create_text_file -Create a file to write to and eventually make available to the usre. +Create a file to write to and eventually make available to the user. If file creation fails, outputs an error message on the request object and return undefs. @@ -2119,6 +2120,19 @@ sub getnames { } } +# -------------------------------------------------------------------- getemails +=pod + +=item * getemails($uname,$udom) + +Gets a user's email information and returns it as a hash with keys: +notification, critnotification, permanentemail + +For notification and critnotification, values are comma-separated lists +of e-mail address(es); for permanentemail, value is a single e-mail address. + +=cut + sub getemails { my ($uname,$udom)=@_; if ($udom eq 'public' && $uname eq 'public') { @@ -2666,7 +2680,6 @@ sub get_student_answers { $moreenv{'grade_target'}='answer'; %moreenv=(%form,%moreenv); $feedurl = &Apache::lonnet::clutter($feedurl); - &Apache::lonenc::check_encrypt(\$feedurl); my $userview=&Apache::lonnet::ssi($feedurl,%moreenv); return $userview; } @@ -3325,7 +3338,7 @@ sub designparm { =back -=head1 HTTP Helpers +=head1 HTML Helpers =over 4 @@ -3619,20 +3632,12 @@ sub make_attr_string { =pod -=back - -=head1 HTML Helpers - -=over 4 - =item * &endbodytag() Returns a uniform footer for LON-CAPA web pages. Inputs: none -=back - =cut sub endbodytag { @@ -3649,8 +3654,6 @@ sub endbodytag { =pod -=over 4 - =item * &standard_css() Returns a style sheet @@ -3661,8 +3664,6 @@ Inputs: (all optional) function -> force usage of a specific rolish color scheme bgcolor -> override the default page bgcolor -=back - =cut sub standard_css { @@ -3734,9 +3735,22 @@ form, .inline { display: inline; } .LC_diff_added { color: green; } +.LC_unknown { + color: yellow; +} + .LC_icon { border: 0px; } +.LC_indexer_icon { + border: 0px; + height: 22px; +} +.LC_docs_spacer { + width: 25px; + height: 1px; + border: 0px; +} .LC_internal_info { color: #999; @@ -4406,7 +4420,74 @@ table.LC_prior_match tr td { } span.LC_nobreak { - white-space: nowrap; + white-space: nowrap; +} + +table.LC_docs_documents { + background: #BBBBBB; + border-width: 0px; + border-collapse: collapse; +} + +table.LC_docs_documents td.LC_docs_document { + border: 2px solid black; + padding: 4px; +} + +.LC_docs_course_commands div { + float: left; + border: 4px solid #AAAAAA; + padding: 4px; + background: #DDDDCC; +} + +.LC_docs_entry_move { + border: 0px; + border-collapse: collapse; +} + +.LC_docs_entry_move td { + border: 2px solid #BBBBBB; + background: #DDDDDD; +} + +.LC_docs_editor td.LC_docs_entry_commands { + background: #DDDDDD; + font-size: x-small; +} +.LC_docs_copy { + color: #000099; +} +.LC_docs_cut { + color: #550044; +} +.LC_docs_rename { + color: #009900; +} +.LC_docs_remove { + color: #990000; +} + +.LC_docs_reinit_warn, +.LC_docs_ext_edit { + font-size: x-small; +} + +.LC_docs_editor td.LC_docs_entry_title, +.LC_docs_editor td.LC_docs_entry_icon { + background: #FFFFBB; +} +.LC_docs_editor td.LC_docs_entry_parameter { + background: #BBBBFF; + font-size: x-small; + white-space: nowrap; +} + +table.LC_docs_adddocs td, +table.LC_docs_adddocs th { + border: 1px solid #BBBBBB; + padding: 4px; + background: #DDDDDD; } END @@ -4414,8 +4495,6 @@ END =pod -=over 4 - =item * &headtag() Returns a uniform footer for LON-CAPA web pages. @@ -4439,8 +4518,6 @@ Inputs: $title - optional title for the no_auto_mt_title -> prevent &mt()ing the title arg -=back - =cut sub headtag { @@ -4496,16 +4573,12 @@ ADDMETA =pod -=over 4 - =item * &font_settings() Returns neccessary to set the proper encoding Inputs: none -=back - =cut sub font_settings { @@ -4522,16 +4595,12 @@ sub font_settings { =pod -=over 4 - =item * &xml_begin() Returns the needed doctype and Inputs: none -=back - =cut sub xml_begin { @@ -4556,16 +4625,12 @@ sub xml_begin { =pod -=over 4 - =item * &endheadtag() Returns a uniform for LON-CAPA web pages. Inputs: none -=back - =cut sub endheadtag { @@ -4574,8 +4639,6 @@ sub endheadtag { =pod -=over 4 - =item * &head() Returns a uniform complete .. section for LON-CAPA web pages. @@ -4583,8 +4646,6 @@ Returns a uniform complete .. -=back - =cut sub head { @@ -4594,8 +4655,6 @@ sub head { =pod -=over 4 - =item * &start_page() Returns a complete .. section for LON-CAPA web pages. @@ -4634,8 +4693,6 @@ Inputs: $title - optional title for the no_auto_mt_title -> prevent &mt()ing the title arg -=back - =cut sub start_page { @@ -4687,8 +4744,6 @@ sub start_page { =pod -=over 4 - =item * &head() Returns a complete section for LON-CAPA web pages. @@ -4846,10 +4901,61 @@ sub simple_error_page { } } +=pod + +=item * &inhibit_menu_check($arg) + +Checks for a inhibitmenu state and generates output to preserve it + +Inputs: $arg - can be any of + - undef - in which case the return value is a string + to add into arguments list of a uri + - 'input' - in which case the return value is a HTML +
field of type hidden to + preserve the value + - a url - in which case the return value is the url with + the neccesary cgi args added to preserve the + inhibitmenu state + - a ref to a url - no return value, but the string is + updated to include the neccessary cgi + args to preserve the inhibitmenu state + +=cut + +sub inhibit_menu_check { + my ($arg) = @_; + &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']); + if ($arg eq 'input') { + if ($env{'form.inhibitmenu'}) { + return ''; + } else { + return + } + } + if ($env{'form.inhibitmenu'}) { + if (ref($arg)) { + $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'}; + } elsif ($arg eq '') { + $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'}; + } else { + $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'}; + } + } + if (!ref($arg)) { + return $arg; + } +} + ############################################### =pod +=back + +=head1 User Information Routines + +=over 4 + =item * &get_users_function() Used by &bodytag to determine the current users primary role. @@ -4877,7 +4983,7 @@ sub get_users_function { =pod -=item * &check_user_status +=item * &check_user_status() Determines current status of supplied role for a specific user. Roles can be active, previous or future. @@ -5412,6 +5518,12 @@ sub get_secgrprole_info { =pod +=back + +=head1 HTTP Helpers + +=over 4 + =item * get_unprocessed_cgi($query,$possible_names) Modify the %env hash to contain unprocessed CGI form parameters held in @@ -6449,35 +6561,53 @@ sub commit_customrole { } sub commit_standardrole { - my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec) = @_; - my $output; - my $logmsg; + my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_; + my ($output,$logmsg,$linefeed); + if ($context eq 'auto') { + $linefeed = "\n"; + } else { + $linefeed = "
\n"; + } 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')) { + my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end, + $one,$two,$sec,$context); + if (($result =~ /^error/) || ($result eq 'not_in_class') || + ($result eq 'unknown_course')) { $output = "Error: $result\n"; } else { - $output = &mt('Assigning').' '.$three.' in '.$url. + $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url. ($start?', '.&mt('starting').' '.localtime($start):''). - ($end?', '.&mt('ending').' '.localtime($end):''). - ': '.$result.'
'. - &mt('Add to classlist').': ok
'; + ($end?', '.&mt('ending').' '.localtime($end):'').': '; + if ($context eq 'auto') { + $output .= $result.$linefeed.&mt('Add to classlist').': ok'; + } else { + $output .= ''.$result.''.$linefeed. + &mt('Add to classlist').': ok'; + } + $output .= $linefeed; } } else { $output = &mt('Assigning').' '.$three.' in '.$url. ($start?', '.&mt('starting').' '.localtime($start):''). - ($end?', '.&mt('ending').' '.localtime($end):'').': '. - &Apache::lonnet::assignrole( - $udom,$uname,$url,$three,$end,$start). - '
'; + ($end?', '.&mt('ending').' '.localtime($end):'').': '; + my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start); + if ($context eq 'auto') { + $output .= $result.$linefeed; + } else { + $output .= ''.$result.''.$linefeed; + } } return $output; } sub commit_studentrole { - my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec) = @_; - my $linefeed = '
'."\n"; - my $result; + my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_; + my ($result,$linefeed); + if ($context eq 'auto') { + $linefeed = "\n"; + } else { + $linefeed = '
'."\n"; + } if (defined($one) && defined($two)) { my $cid=$one.'_'.$two; my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid); @@ -6524,9 +6654,12 @@ sub commit_studentrole { ############################################################ sub construct_course { - my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname) = @_; + my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_; my $outcome; - + my $linefeed = '
'."\n"; + if ($context eq 'auto') { + $linefeed = "\n"; + } # # Open course # @@ -6546,27 +6679,65 @@ sub construct_course { # 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]
',$crstype,$$courseid); + $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed; + # # Check if created correctly # ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid); my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom); - $outcome .= &mt('Created on').': '.$crsuhome.'
'; + $outcome .= &mt('Created on').': '.$crsuhome.$linefeed; # # Are we cloning? # my $cloneid=''; if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) { + my $can_clone = 0; $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'}; my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid); my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom); + my $clonemsg; if ($clonehome eq 'no_host') { - $outcome .= - '
'.&mt('Attempting to clone non-existing [_1]',$crstype).' '.$cloneid.''; + $clonemsg = &mt('Attempting to clone non-existing [_1]',$crstype); + if ($context eq 'auto') { + $outcome .= $clonemsg; + } else { + $outcome .= ''.$clonemsg.''; + } + $outcome .= $linefeed; } else { - $outcome .= - '
'.&mt('Cloning [_1] from [_2]',$crstype,$clonehome).''; + my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1}); + if ($env{'request.role.domain'} eq $args->{'form.clonedomain'}) { + $can_clone = 1; + } else { + my %clonehash = &Apache::lonnet::get('environment',['cloners'], + $args->{'clonedomain'},$args->{'clonecourse'}); + my @cloners = split(/,/,$clonehash{'cloners'}); + my %roleshash = + &Apache::lonnet::get_my_roles($args->{'ccuname'}, + $args->{'ccdomain'},'userroles',['active'],['cc'], + [$args->{'clonedomain'}]); + if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) { + $can_clone = 1; + } else { + $clonemsg = &mt('The new course was not cloned from an existing course because the course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}); + if ($context eq 'auto') { + $outcome .= $clonemsg; + } else { + $outcome .= ''.$clonemsg.''; + } + $outcome .= $linefeed; + } + } + } + if ($can_clone) { + $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome); + if ($context eq 'auto') { + $outcome = $clonemsg; + } else { + $outcome .= ''.$clonemsg.''; + } + $outcome .= $linefeed; my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum); # Copy all files &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid); @@ -6687,11 +6858,24 @@ sub construct_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 .= ''.$lt{'tclb'}.' ('.$cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.' ('.$lt{'adby'}.').


\n"; + my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}. + ' ('.$lt{'adby'}.')'; + if ($context eq 'auto') { + $outcome .= $badclass_msg.$linefeed; + $outcome .= ''.$badclass_msg.$linefeed.'

\n"; + } + } } if ($args->{'no_end_date'}) { $args->{'endaccess'} = 0; @@ -6707,8 +6891,13 @@ sub construct_course { $cenv{'internal.autharg'} = $args->{'autharg'}; if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) { if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') { - $outcome .= ''. - &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').'

'; + my $krb_msg = &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'); + if ($context eq 'auto') { + $outcome .= $krb_msg; + } else { + $outcome .= ''.$krb_msg.''; + } + $outcome .= $linefeed; } } if (($args->{'ccdomain'}) && ($args->{'ccuname'})) { @@ -6764,8 +6953,8 @@ sub construct_course { # By default, use standard grading if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; } - $outcome .= ('
'.&mt('Setting environment').': '. - &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).'
'); + $outcome .= $linefeed.&mt('Setting environment').': '. + &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed; # # Open all assignments # @@ -6775,7 +6964,7 @@ sub construct_course { $storeunder.'.type' => 'date_start'); $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput - ('resourcedata',\%storecontent,$$crsudom,$$crsunum).'
'; + ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed; } # # Set first page @@ -6802,7 +6991,7 @@ sub construct_course { (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1); if ($errtext) { $fatal=2; } - $outcome .= ($fatal?$errtext:'write ok').'
'; + $outcome .= ($fatal?$errtext:'write ok').$linefeed; } return $outcome; }