--- loncom/interface/courseprefs.pm 2010/02/22 15:59:28 1.8.2.8 +++ loncom/interface/courseprefs.pm 2010/01/18 20:14:25 1.21 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Handler to set configuration settings for a course # -# $Id: courseprefs.pm,v 1.8.2.8 2010/02/22 15:59:28 raeburn Exp $ +# $Id: courseprefs.pm,v 1.21 2010/01/18 20:14:25 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -28,185 +28,6 @@ ############################################################### ############################################################## -=pod - -=head1 NAME - -courseprefs- Handler to set/modify course configuration - -=head1 SYNOPSIS - -courseprefs provides an interface for setting general course configuration - -=head1 DESCRIPTION - -This module is used for configuration of a course - -=head1 INTERNAL SUBROUTINES - -=over - -=item get_allitems() - -=item print_config_box() - -=item process_changes() - -=item get_sec_str() - -=item check_clone() - -=item store_changes() - -=item update_env() - -=item display_disallowed() - -=item get_course() - -=item get_jscript() - -=item cloners_javascript() - -=item print_courseinfo() - -=item new_cloners_dom_row() - -=item can_modify_catsettings() - -=item assign_course_categories() - -=item print_localization() - -=item get_lang_choices() - -=item print_feedback() - -=item user_table() - -=item select_recipient() - -=item select_sections() - -=item print_discussion() - -=item role_checkboxes() - -=item print_classlists() - -=item print_appearance() - -=item print_grading() - -=item print_printouts() - -=item print_spreadsheet() - -=item print_bridgetasks() - -=item print_other() - -=item get_other_items() - -=item item_table_row_start() - -=item item_table_row_end() - -=item yes_no_radio() - -=item select_from_options() - -=item make_item_rows() - -Creates table used to display and set course configuration items. - -Inputs: $cdom,$items,$ordered,$settings,$rowtotal,$crstype -where $cdom is course's domain, $items is HASH ref for current config -item, $ordered is ARRAY ref of items to include in row in -display order, $settings is HASH ref of current values forrow, -$rowtotal is SCALAR ref used to accumulate row count, $crstype is -course type. - -Returns: $datatable -HTML mark-up of data table which accumulates individual rows. - -=item nothidepriv_row() - -Creates row containing form elements used to display and set -whether Domain coordinators who are currently included in -advanced course user .db file for a course are to be hidden (e.g., -in syllabus, or from course user lists). - -Inputs: $cdom,$item,$settings,$crstype -where $cdom is course domain, item is nothideprivileged, $settings is -HASH ref of the current values for nothideprivileged, $crstype is -course type (Course or Community). - -Returns: $datatable -HTML mark-up for Privileged users (Domain Coordinators) in staff listing. - -=item print_hdrfmt_row() - -Creates row containing form elements used to display and set -substitution items and text to be used in the header included -on printouts. - -Inputs: $item,$settings -where $item is print_header_format, and $settings is a HASH ref -of the current values stored for print_header_format. - -Returns: $output -HTML mark-up containing Javascript functions: reOrder() and getIndexByName() -used to dynamically update position selectboxes, and HTML table elements -for the "Print header format" row. - -=item position_selector() - -Creates a select box which can be used to reorder substitutions -and text included in a printout header. - -Inputs: $pos,$num,$maxnum -where $pos is current position, $num is the unique identifier, -and $maxnum is the total number of items (both substitutions -and text in the printout header. - -Returns: $output -HTML mark-up for the selectbox and a hidden form element containing -the current position. - -=item substitution_selector() - -Creates a combination of select box for choosing an item -(student name, course ID or assignment note) to substitute, -and a corresponding size limit in the header used for printouts. - -Inputs: $num,$subst,$limit,$crstype -where $num is the unique identifier, $subst is the current -substitution (n,c or a, for name, course or note respectively, -$limit is the current size limit (integer), and $crstype is -course type - course or community. - -Returns: $output -HTML mark-up for selectbox and textbox (separate table cells). - -=item change_clone() - -Modifies the list of courses a user can clone (stored -in the user's environment.db file), called when a -change is made to the list of users allowed to clone -a course. - -Inputs: $action,$cloner -where $action is add or drop, and $cloner is identity of -user for whom cloning ability is to be changed in course. - -Returns: nothing - -=back - -=cut - - package Apache::courseprefs; use strict; @@ -272,7 +93,6 @@ sub handler { gens => 'General community settings', idnu => 'Community ID or number', desc => 'Community Description', - ownr => 'Community Owner', catg => 'Categorize community', excc => 'Exclude from community catalog', clon => 'Users allowed to clone community', @@ -298,7 +118,6 @@ sub handler { gens => 'General course settings', idnu => 'Course ID or number', desc => 'Course Description', - ownr => 'Course Owner', catg => 'Categorize course', excc => 'Exclude from course catalog', clon => 'Users allowed to clone course', @@ -342,13 +161,10 @@ sub handler { 'courseinfo' => { text => $lt{'gens'}, help => 'Course_Environment', - header => [{col1 => 'Setting', - col2 => 'Value'}], - ordered => ['owner','description','courseid','categories', - 'hidefromcat','cloners','externalsyllabus', - 'url','rolenames'], + ordered => ['description','courseid','categories', + 'hidefromcat','externalsyllabus', + 'cloners','url','rolenames'], itemtext => { - owner => $lt{'ownr'}, description => $lt{'desc'}, courseid => $lt{'idnu'}, categories => $lt{'catg'}, @@ -360,10 +176,8 @@ sub handler { }, }, 'localization' => - { text => 'Language/TimeZone/Locale', + { text => 'Language & Time Localization', help => 'Course_Environment', - header => [{col1 => 'Setting', - col2 => 'Value',}], ordered => ['languages','timezone','datelocale'], itemtext => { languages => 'Languages used', @@ -375,9 +189,7 @@ sub handler { { text => 'Feedback messages', help => 'Course_Environment', header => [{col1 => 'Questions about:', - col2 => 'Recipients'}, - {col1 => 'Questions about:', - col2 => 'Custom Text'}], + col2 => 'Recipients'}], ordered => ['question.email','comment.email','policy.email'], itemtext => { 'question.email' => 'Resource Content', @@ -388,8 +200,6 @@ sub handler { 'discussion' => { text => 'Discussion and Chat', help => 'Course_Environment', - header => [{col1 => 'Setting', - col2 => 'Value',}], ordered => ['plc.roles.denied','plc.users.denied', 'pch.roles.denied','pch.users.denied', 'allow_limited_html_in_feedback', @@ -399,7 +209,7 @@ sub handler { 'plc.users.denied' => 'No Resource Discussion', 'pch.roles.denied' => 'No Chat room use', 'pch.users.denied' => 'No Chat room use', - allow_limited_html_in_feedback => 'Allow limited HTML in discussion posts', + allow_limited_html_in_feedback => 'Allow limited HTML in discussion', allow_discussion_post_editing => 'Users can edit/delete own discussion posts', }, }, @@ -428,13 +238,11 @@ sub handler { 'appearance' => { text => 'Display of resources ', help => 'Course_Environment', - header => [{col1 => 'Setting', - col2 => 'Value'}], ordered => ['default_xml_style','pageseparators', 'disable_receipt_display','texengine', 'tthoptions'], itemtext => { - default_xml_style => 'Default XML Style File', + default_xml_style => 'Default XML style file', pageseparators => 'Visibly Separate Items on Pages', disable_receipt_display => 'Disable display of problem receipts', texengine => 'Force use of a specific math rendering engine', @@ -444,8 +252,6 @@ sub handler { 'grading' => { text => 'Grading', help => 'Course_Environment', - header => [{col1 => 'Setting', - col2 => 'Value',}], ordered => ['grading','rndseed', 'receiptalg','disablesigfigs'], itemtext => { @@ -459,24 +265,21 @@ sub handler { 'printouts' => { text => 'Printout generation', help => 'Course_Environment', - header => [{col1 => 'Setting', - col2 => 'Value',}], ordered => ['problem_stream_switch','suppress_tries', 'default_paper_size','print_header_format', - 'disableexampointprint'], + 'disableexampointprint','canuse_pdfforms'], itemtext => { problem_stream_switch => 'Allow problems to be split over pages', suppress_tries => 'Suppress number of tries in printing', default_paper_size => 'Default paper type', print_header_format => 'Print header format', disableexampointprint => 'Disable automatically printing point values on exams', + canuse_pdfforms => 'Users can print problems as PDF forms and upload later for grading', }, }, 'spreadsheet' => { text => 'Spreadsheets', help => 'Course_Environment', - header => [{col1 => 'Setting', - col2 => 'Value'}], ordered => ['spreadsheet_default_classcalc', 'spreadsheet_default_studentcalc', 'spreadsheet_default_assesscalc','hideemptyrows'], @@ -490,8 +293,6 @@ sub handler { 'bridgetasks' => { text => 'Bridge tasks', help => 'Course_Environment', - header => [{col1 => 'Setting', - col2 => 'Value'}], ordered => ['task_messages','task_grading', 'suppress_embed_prompt'], itemtext => { @@ -547,21 +348,20 @@ sub print_config_box { my $itemtext = $item->{'itemtext'}; my $rowtotal = 0; my $output = - ' - - '."\n". - ''; + '

'.&mt($item->{text}).'

+
 '. + &Apache::loncommon::help_open_topic($item->{'help'}).''; if (($action eq 'feedback') || ($action eq 'classlists')) { $output .= ' -
- - - - - - - '. &Apache::loncommon::end_data_table_row(); $num ++; - } elsif (&Apache::lonnet::homeserver($uname,$udom) ne 'no_host') { - unless (grep(/^\Q$entry\E$/,@cloners)) { - push(@cloners,$entry); - } + } else { + push(@cloners,$entry); } } } @@ -1695,18 +1469,6 @@ sub print_courseinfo { $datatable .= ''. &Apache::lonhtmlcommon::textbox($item.'_display',$settings->{$item}, $items{$item}{size},$launcher); - } elsif ($item eq 'owner') { - my $owner = $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'}; - if ($owner =~ /:/) { - my ($ownername,$ownerdom) = split(':',$owner); - $owner = &Apache::loncommon::plainname($ownername,$ownerdom); - } elsif ($owner ne '') { - $owner = &Apache::loncommon::plainname($owner,$cdom); - } else { - $owner = &mt('None specified'); - } - my $domdesc = &Apache::lonnet::domain($cdom,'description'); - $datatable .= $owner; } else { $datatable .= &Apache::lonhtmlcommon::textbox($item,$settings->{$item},$items{$item}{size}); } @@ -1871,16 +1633,16 @@ sub print_localization { } my %items = ( languages => { - text => &mt($itemtext->{'languages'}).'
'. - &mt("(will override user's preference)"), + text => ''.&mt($itemtext->{'languages'}).'
'. + &mt("(overrides individual user preference)"), input => 'selectbox', }, timezone => { - text => &mt($itemtext->{'timezone'}), + text => ''.&mt($itemtext->{'timezone'}).'', input => 'selectbox', }, datelocale => { - text => &mt($itemtext->{'datelocale'}), + text => ''.&mt($itemtext->{'datelocale'}).'', input => 'selectbox', }, ); @@ -1998,7 +1760,11 @@ sub print_feedback { foreach my $item (@{$ordered}) { $count ++; - $datatable .= &item_table_row_start($items{$item}{text},$count); + if ($position eq 'top') { + $datatable .= &item_table_row_start($items{$item}{text},$count); + } else { + $datatable .= &item_table_row_start($items{$item}{text}."
(Custom text)",$count, "advanced"); + } if ($position eq 'top') { my $includeempty = 0; $datatable .= &user_table($cdom,$item,\@sections, @@ -2462,7 +2228,7 @@ sub print_grading { }, 'rndseed' => { text => ''.&mt($itemtext->{'rndseed'}).''. - ''.'
'. + ''.'
'. &mt('Modifying this will make problems have different numbers and answers!'). '', input => 'selectbox', @@ -2534,6 +2300,16 @@ sub print_printouts { text => ''.&mt($itemtext->{'disableexampointprint'}).'', input => 'radio', }, + canuse_pdfforms => { + text => ''.&mt($itemtext->{'canuse_pdfforms'}).'', + input => 'selectbox', + options => { + 1 => &mt('Yes'), + 0 => &mt('No'), + }, + order => ['1','0'], + nullval => 'None specified - use domain default', + } ); return &make_item_rows($cdom,\%items,$ordered,$settings,$rowtotal,$crstype); } @@ -2664,15 +2440,13 @@ sub get_other_items { } sub item_table_row_start { - my ($text,$count) = @_; + my ($text,$count,$add_class) = @_; my $output; - if ($count%2) { - $output .= ''; - } else { - $output .= ''; - } + my $css_class = ($count % 2) ? 'LC_odd_row' : 'LC_even_row'; + $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq ''); + $output .= ''."\n";; $output .= '
'. - &mt($item->{text}).' '. - &Apache::loncommon::help_open_topic($item->{'help'}).'
- - +
'; + if (exists $item->{'header'}->[0]->{'col1'} || + exists $item->{'header'}->[0]->{'col2'}) { + $output .= ' + - '; + '; + } $rowtotal ++; if ($action eq 'feedback') { $output .= &print_feedback('top',$cdom,$settings,$ordered,$itemtext,\$rowtotal); @@ -570,10 +370,6 @@ sub print_config_box { } $output .= '
'.&mt($item->{'header'}->[0]->{'col1'}).' '.&mt($item->{'header'}->[0]->{'col2'}).'
-
'; @@ -584,25 +380,27 @@ sub print_config_box { $output .= &print_classlists('middle',$cdom,$settings,$itemtext,\$rowtotal,$crstype). '
'.&mt($item->{'header'}->[1]->{'col1'}).'
-
- - - - - '; +
'.&mt($item->{'header'}->[2]->{'col1'}).''.&mt($item->{'header'}->[2]->{'col2'}).'
'; + if (exists $item->{'header'}->[0]->{'col1'} || + exists $item->{'header'}->[0]->{'col2'}) { + $output .= ' + + + + '; + } } } else { $output .= ' - - - -
'.&mt($item->{'header'}->[0]->{'col1'}).''.&mt($item->{'header'}->[0]->{'col2'}).'
- - +
'; + if (exists $item->{'header'}->[0]->{'col1'} || + exists $item->{'header'}->[0]->{'col2'}) { + $output .= ' + - '; + '; + } } $rowtotal ++; if ($action eq 'courseinfo') { @@ -630,9 +428,7 @@ sub print_config_box { } $output .= '
'.&mt($item->{'header'}->[0]->{'col1'}).' '.&mt($item->{'header'}->[0]->{'col2'}).'
-

'; +'; return ($output,$rowtotal); } @@ -749,14 +545,10 @@ sub process_changes { my @cloners = split(',',$env{'form.'.$entry}); my @okcloners; foreach my $cloner (@cloners) { - $cloner =~ s/^\s+//; - $cloner =~ s/\s+$//; - unless ($cloner eq '') { - my ($uname,$udom) = split(':',$cloner); - if (&check_clone($udom,$disallowed,$uname) eq 'ok') { - if (!grep(/^\Q$cloner\E$/,@okcloners)) { - push(@okcloners,$cloner); - } + my ($uname,$udom) = split(':',$cloner); + if (&check_clone($udom,$disallowed,$uname) eq 'ok') { + if (!grep(/^\Q$cloner\E$/,@okcloners)) { + push(@okcloners,$cloner); } } } @@ -1046,7 +838,7 @@ sub check_clone { sub store_changes { my ($cdom,$cnum,$prefs_order,$actions,$prefs,$values,$changes,$crstype) = @_; my ($chome,$output); - my (%storehash,@delkeys,@need_env_update,@oldcloner); + my (%storehash,@delkeys,@need_env_update); if ((ref($values) eq 'HASH') && (ref($changes) eq 'HASH')) { %storehash = %{$values}; } else { @@ -1171,13 +963,19 @@ sub store_changes { if (defined($yesno{$key})) { $displayval = &mt('No'); if ($changes->{$item}{$key} eq 'yes') { - $displayval = &mt('Yes'); + $displayval = &mt('Yes'); } } elsif (($key =~ /^default_enrollment_(start|end)_date$/) && ($displayval)) { $displayval = &Apache::lonlocal::locallocaltime($displayval); } elsif ($key eq 'categories') { $displayval = $env{'form.categories_display'}; - } + } elsif ($key eq 'canuse_pdfforms') { + if ($changes->{$item}{$key} eq '1') { + $displayval = &mt('Yes'); + } elsif ($changes->{$item}{$key} eq '0') { + $displayval = &mt('No'); + } + } if ($changes->{$item}{$key} eq '') { push(@delkeys,$key); $output .= '
  • '.&mt('Deleted setting for [_1]', @@ -1195,16 +993,6 @@ sub store_changes { } $storehash{$key} = $changes->{$item}{$key}; } - if ($key eq 'cloners') { - # Get existing cloners - my %clonenames = - &Apache::lonnet::dump('environment',$cdom,$cnum,'cloners'); - if ($clonenames{'cloners'} =~ /,/) { - @oldcloner = split(/\s*\,\s*/,$clonenames{'cloners'}); - } else { - $oldcloner[0] = $clonenames{'cloners'}; - } - } if (($key eq 'description') || ($key eq 'cloners') || ($key eq 'hidefromcat') || ($key eq 'categories')) { push(@need_env_update,$key); @@ -1224,14 +1012,6 @@ sub store_changes { } } if (&Apache::lonnet::put('environment',\%storehash,$cdom,$cnum) eq 'ok') { - if (ref($changes) eq 'HASH') { - if (ref($changes->{'courseinfo'}) eq 'HASH') { - if (exists($changes->{'courseinfo'}{'cloners'})) { - &change_clone($cdom,$cnum,$changes->{'courseinfo'}{'cloners'}, - \@oldcloner); - } - } - } if (@delkeys) { if (&Apache::lonnet::del('environment',\@delkeys,$cdom,$cnum) ne 'ok') { $output .= '
    '; @@ -1241,10 +1021,10 @@ sub store_changes { $output .= &mt('An error occurred when removing course settings which are no longer in use.'); } $output .= ''; - } - } else { - foreach my $key (@delkeys) { - &Apache::lonnet::delenv('course.'.$cdom.'_'.$cnum.'.'.$key); + } else { + foreach my $key (@delkeys) { + &Apache::lonnet::delenv('course.'.$cdom.'_'.$cnum.'.'.$key); + } } } if (@need_env_update) { @@ -1527,15 +1307,13 @@ sub print_courseinfo { '', input => 'textbox', size => '40', + advanced => 1 }, 'description' => { text => ''.&mt($itemtext->{'description'}).'', input => 'textbox', size => '25', }, - 'owner' => { - text => ''.&mt($itemtext->{'owner'}).'', - }, 'courseid' => { text => ''.&mt($itemtext->{'courseid'}).'
    '.'('. &mt('internal, optional').')', @@ -1544,15 +1322,17 @@ sub print_courseinfo { }, 'cloners' => { text => ''.&mt($itemtext->{'cloners'}).'
    '. - &mt('Owner and Coordinators included automatically'), + &mt('Coordinators included automatically'), input => 'textbox', size => '40', + advanced => 1 }, 'rolenames' => { text => ''.&mt($itemtext->{'rolenames'}).'
    '. '('.$replace.')', input => 'textbox', size => '20', + advanced => 1 }, 'externalsyllabus' => { text => ''.&mt($itemtext->{'externalsyllabus'}).'
    ('. @@ -1581,7 +1361,11 @@ sub print_courseinfo { next if (!$can_categorize); } $count ++; - $datatable .= &item_table_row_start($items{$item}{text},$count); + if (exists $items{$item}{advanced} && $items{$item}{advanced} == 1) { + $datatable .= &item_table_row_start($items{$item}{text},$count,"advanced"); + } else { + $datatable .= &item_table_row_start($items{$item}{text},$count); + } if ($items{$item}{input} eq 'radio') { $datatable .= &yesno_radio($item,$settings); } elsif ($item eq 'cloners') { @@ -1616,19 +1400,11 @@ sub print_courseinfo { if (@entries > 0) { foreach my $entry (@entries) { my ($uname,$udom) = split(/:/,$entry); - my ($uname,$udom) = split(/:/,$entry); - if ($udom =~ /^$match_domain$/) { - unless (&Apache::lonnet::domain($udom)) { - next; - } - } else { - next; - } if ($uname eq '*') { $datatable .= &Apache::loncommon::start_data_table_row(). '
    		• '. - &mt('Any user in domain:').' '.$udom. + &mt('Domain:').' '.$udom. '
    '. '
    '.$text. - ''; + ''; return $output; } @@ -2868,9 +2642,9 @@ sub print_hdrfmt_row { $currstr .= ''.&mt('Current print header:').' '. $settings->{$item}.'
    '; my @current = split(/(%\d*[nca])/,$settings->{$item}); - foreach my $val (@current) { - unless ($val eq '') { - push(@curr,$val); + foreach my $item (@current) { + unless ($item eq '') { + push(@curr,$item); } } $currnum = @curr; @@ -3023,66 +2797,4 @@ sub substitution_selector { return $output; } -sub change_clone { - my ($cdom,$cnum,$clonelist,$oldcloner) = @_; - my $clone_crs = $cnum.':'.$cdom; - if ($cnum && $cdom) { - my $clone_crs = $cnum.':'.$cdom; - my @allowclone; - if ($clonelist =~ /,/) { - @allowclone = split(',',$clonelist); - } else { - $allowclone[0] = $clonelist; - } - foreach my $currclone (@allowclone) { - if (!grep(/^$currclone$/,@$oldcloner)) { - if ($currclone ne '*') { - my ($uname,$udom) = split(/:/,$currclone); - if ($uname && $udom && $uname ne '*') { - if (&Apache::lonnet::homeserver($uname,$udom) ne 'no_host') { - my %currclonecrs = &Apache::lonnet::dump('environment',$udom,$uname,'cloneable'); - if ($currclonecrs{'cloneable'} !~ /\Q$clone_crs\E/) { - if ($currclonecrs{'cloneable'} eq '') { - $currclonecrs{'cloneable'} = $clone_crs; - } else { - $currclonecrs{'cloneable'} .= ','.$clone_crs; - } - &Apache::lonnet::put('environment',\%currclonecrs,$udom,$uname); - } - } - } - } - } - } - foreach my $oldclone (@$oldcloner) { - if (!grep(/^\Q$oldclone\E$/,@allowclone)) { - if ($oldclone ne '*') { - my ($uname,$udom) = split(/:/,$oldclone); - if ($uname && $udom && $uname ne '*' ) { - if (&Apache::lonnet::homeserver($uname,$udom) ne 'no_host') { - my %currclonecrs = &Apache::lonnet::dump('environment',$udom,$uname,'cloneable'); - my %newclonecrs = (); - if ($currclonecrs{'cloneable'} =~ /\Q$clone_crs\E/) { - if ($currclonecrs{'cloneable'} =~ /,/) { - my @currclonecrs = split/,/,$currclonecrs{'cloneable'}; - foreach my $crs (@currclonecrs) { - if ($crs ne $clone_crs) { - $newclonecrs{'cloneable'} .= $crs.','; - } - } - $newclonecrs{'cloneable'} =~ s/,$//; - } else { - $newclonecrs{'cloneable'} = ''; - } - &Apache::lonnet::put('environment',\%newclonecrs,$udom,$uname); - } - } - } - } - } - } - } - return; -} - 1;