--- loncom/interface/lonpreferences.pm 2021/12/14 00:30:54 1.196.4.28 +++ loncom/interface/lonpreferences.pm 2024/03/01 14:23:23 1.196.4.28.2.3 @@ -1,7 +1,7 @@ # The LearningOnline Network # Preferences # -# $Id: lonpreferences.pm,v 1.196.4.28 2021/12/14 00:30:54 raeburn Exp $ +# $Id: lonpreferences.pm,v 1.196.4.28.2.3 2024/03/01 14:23:23 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -31,7 +31,6 @@ package Apache::lonpreferences; use strict; -use LONCAPA; use Apache::Constants qw(:common); use Apache::File; use Apache::loncommon(); @@ -40,6 +39,7 @@ use Apache::lonlocal; use Apache::lonnet; use LONCAPA::lonauthcgi(); use LONCAPA(); +use DateTime::TimeZone(); ################################################################ # Handler subroutines # @@ -2043,9 +2043,98 @@ sub author_space_settings { my $domain = $env{'user.domain'}; my %author_roles = &Apache::lonnet::get_my_roles($user,$domain,'userroles','',['au','ca','aa']); if (keys(%author_roles) > 0) { - $r->print(Apache::loncommon::start_page('Authoring Space Settings')); - $r->print(Apache::lonhtmlcommon::breadcrumbs('Authoring Space Settings')); - my %userenv = &Apache::lonnet::get('environment',['nocodemirror']); + my ($showdomdefs,$js,$args,@items); + my $returnurl = &HTML::Entities::encode($env{'form.returnurl'},'"<>&\''); + my $reqdmajor = 2; + my $reqdminor = 12; + my $loncaparev = &Apache::lonnet::get_server_loncaparev($env{'user.domain'},$env{'user.home'}); + my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/); + unless (($major eq '' && $minor eq '') || + ($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor))) { + @items = ('nocodemirror','copyright','sourceavail'); + $showdomdefs = 1; + $js = &toggle_options_js(); + my $onload; + foreach my $item (@items) { + $onload .= "javascript:toggleOptions(document.prefs,'$item','user_$item');" + } + $args = { 'add_entries' => { 'onload' => $onload } }; + } + $r->print(Apache::loncommon::start_page('Authoring Space Settings',$js,$args)); + $r->print(Apache::lonhtmlcommon::breadcrumbs('Authoring Space Settings')); + if ($showdomdefs) { + my %userenv = &Apache::lonnet::get('environment',\@items); + my %domdefs = &Apache::lonnet::get_domain_defaults($domain); + my %staticdefaults = ( + 'nocodemirror' => '0', + 'copyright' => 'default', + 'sourceavail' => 'closed', + ); + my %lt = &authoring_settings_text(); + my %titles = &authoring_settings_titles(); + $r->print("

$lt{'auss'}



\n". + '
'."\n". + ''."\n". + ''."\n"); + foreach my $item (@items) { + my ($domdef,$checkeddom,$checkeduser,$domdefdisplay,$divsty,$userelem); + $checkeddom = ' checked="checked"'; + $divsty = 'display:none'; + if (exists($domdefs{$item})) { + $domdef = $domdefs{$item}; + } else { + $domdef = $staticdefaults{$item}; + } + if ($item eq 'copyright') { + $domdefdisplay = &Apache::loncommon::copyrightdescription($domdef); + $userelem = &selectbox('userchoice_'.$item,$userenv{$item},'', + \&Apache::loncommon::copyrightdescription, + (grep !/^priv|custom$/,(&Apache::loncommon::copyrightids))); + } elsif ($item eq 'sourceavail') { + $domdefdisplay = &Apache::loncommon::source_copyrightdescription($domdef); + $userelem = &selectbox('userchoice_'.$item,$userenv{$item},'', + \&Apache::loncommon::source_copyrightdescription, + (&Apache::loncommon::source_copyrightids)); + } elsif ($item eq 'nocodemirror') { + if ($domdef) { + $domdefdisplay = $lt{'yes'}; + } else { + $domdefdisplay = $lt{'no'}; + } + my %checked; + $checked{'no'} = ' checked="checked"'; + if ($userenv{$item} eq 'yes') { + $checked{'yes'} = $checked{'no'}; + $checked{'no'} = ''; + } + $userelem = ''; + foreach my $choice ('yes','no') { + $userelem .= '   '; + } + $userelem .= ''; + } + if ($userenv{$item} ne '') { + $checkeduser = $checkeddom; + $checkeddom = ''; + $divsty = 'display:inline-block'; + } + $r->print(<<"END"); +

$titles{$item}

+

$lt{'curd'}: $domdefdisplay

+

+    +

+
+$lt{'ousv'} +$userelem +


+END + } + $r->print('
'. + ''. + '
'."\n"); + } else { my $constchecked=''; if ($env{'environment.nocodemirror'}) { $constchecked=' checked="checked"'; @@ -2053,7 +2142,6 @@ sub author_space_settings { my $text=&mt('By default, CodeMirror an editor with advanced functionality for editing code is activated for authors.'); my $cmoff=&mt('Deactivate CodeMirror. This can improve performance on slow computers and accessibility.'); my $change=&mt('Save'); - my $returnurl = &HTML::Entities::encode($env{'form.returnurl'},'"<>&\''); $r->print(< @@ -2063,6 +2151,7 @@ sub author_space_settings { ENDSCREEN + } } } @@ -2072,6 +2161,8 @@ sub change_authoring_settings { my $domain = $env{'user.domain'}; my %author_roles = &Apache::lonnet::get_my_roles($user,$domain,'userroles','',['au','ca','aa']); if (keys(%author_roles) > 0) { + my $message; + if (0) { my %ausettings=('environment.nocodemirror' => ''); if ($env{'form.cmoff'}) { $ausettings{'environment.nocodemirror'}='yes'; } &Apache::lonnet::put('environment',\%ausettings); @@ -2082,25 +2173,143 @@ sub change_authoring_settings { } else { $status=&mt('off'); } - my $message=&Apache::lonhtmlcommon::confirm_success(&mt('Set [_1] to [_2]',''.&mt('Deactivate CodeMirror in Authoring Space').'',''.$status.'')); + $message=&Apache::lonhtmlcommon::confirm_success(&mt('Set [_1] to [_2]',''.&mt('Deactivate CodeMirror in Authoring Space').'',''.$status.'')); $message=&Apache::loncommon::confirmwrapper($message); - if ($env{'form.returnurl'}) { - &do_redirect($r,$env{'form.returnurl'},$message); - } else { - &print_main_menu($r,$message); + } else { + my @items = ('nocodemirror','copyright','sourceavail'); + my %oldsettings = &Apache::lonnet::get('environment',\@items); + my %domdefs = &Apache::lonnet::get_domain_defaults($domain); + my %lt = &authoring_settings_text(); + my %titles = &authoring_settings_titles(); + my ($result,%newsettings,%changes,@delete,@unchanged,@delerrors,@adderrors); + foreach my $item (@items) { + if ($env{'form.'.$item} eq 'dom') { + if ($oldsettings{$item} eq '') { + push(@unchanged,$item); + } else { + push(@delete,$item); + } + } elsif ($env{'form.'.$item} eq 'user') { + my $newval = $env{'form.userchoice_'.$item}; + my @possibles; + if ($item eq 'nocodemirror') { + if ($newval =~ /^yes|no$/) { + $newsettings{$item} = $newval; + } + } elsif ($item eq 'copyright') { + @possibles = (grep !/^priv|custom$/,(&Apache::loncommon::copyrightids)); + if (grep(/^\Q$newval\E$/,@possibles)) { + $newsettings{$item} = $newval; + } + } elsif ($item eq 'sourceavail') { + @possibles = (&Apache::loncommon::source_copyrightids); + if (grep(/^\Q$newval\E$/,@possibles)) { + $newsettings{$item} = $newval; + } + } + if ($oldsettings{$item} eq $newsettings{$item}) { + push(@unchanged,$item); + } else { + $changes{$item} = $newsettings{$item}; + } + } + } + if (@delete) { + if (&Apache::lonnet::del('environment',\@delete) eq 'ok') { + foreach my $key (@delete) { + &Apache::lonnet::delenv('environment.'.$key); + } + } else { + @delerrors = @delete; + } + } + if (keys(%changes)) { + if (&Apache::lonnet::put('environment',\%changes) eq 'ok') { + my %newenvhash; + map {$newenvhash{'environment.'.$_} = $changes{$_}; } (keys(%changes)); + &Apache::lonnet::appenv(\%newenvhash); + } else { + foreach my $item (@items) { + if (exists($changes{$item})) { + push(@adderrors,$item); + } + } + } } + if (@adderrors) { + $result = &mt('An error occurred when saving user-specific settings for').': '. + join(', ', map { $titles{$_} } @adderrors); + $message = &Apache::loncommon::confirmwrapper(&Apache::lonhtmlcommon::confirm_success($result,1)); + } elsif (keys(%changes)) { + $result = &mt('User-specific settings saved:').''; + $message = &Apache::loncommon::confirmwrapper(&Apache::lonhtmlcommon::confirm_success($result)); + } + if (@delerrors) { + $result = &mt('An error occurred when deleting user-specific settings for').':'; + $message .= &Apache::loncommon::confirmwrapper(&Apache::lonhtmlcommon::confirm_success($result,1)); + } elsif (@delete) { + $result = &mt('Set use of domain default for').':'; + $message .= &Apache::loncommon::confirmwrapper(&Apache::lonhtmlcommon::confirm_success($result)); + } + if (@unchanged) { + $result = &mt('No changes made for').':'; + $message .= &Apache::loncommon::confirmwrapper(&Apache::lonhtmlcommon::confirm_success($result)); + } + } + if ($env{'form.returnurl'}) { + &do_redirect($r,$env{'form.returnurl'},$message); + } else { + &print_main_menu($r,$message); + } } } +sub authoring_settings_text { + return &Apache::lonlocal::texthash( + 'auss' => 'Authoring Space Settings', + 'used' => 'Use domain default', + 'usyo' => 'Use your own user-specific setting', + 'curd' => 'Current domain default is', + 'ousv' => 'Own user-specific value', + 'save' => 'Save', + 'yes' => 'Deactivated', + 'no' => 'Activated', + ); +} + +sub authoring_settings_titles { + return &Apache::lonlocal::texthash( + 'nocodemirror' => 'CodeMirror for EditXML editor', + 'copyright' => 'Default Copyright/Distribution in new metadata file', + 'sourceavail' => 'Default Source Available in new metadata file', + ); +} + sub lockednameschanger { my $r = shift; - &Apache::lonhtmlcommon::add_breadcrumb( - { href => '/adm/preferences?action=changelockednames', - text => 'Automatic name changes'}); - $r->print(Apache::loncommon::start_page('Automatic name changes')); - $r->print(Apache::lonhtmlcommon::breadcrumbs('Allow/disallow name updates')); my %userenv = &Apache::lonnet::get('environment',['lockedname']); my $lockedname=''; + my $ended; if (&can_toggle_namelocking()) { if ($userenv{'lockedname'}) { $lockedname = ' checked="checked"'; @@ -2118,6 +2327,11 @@ sub lockednameschanger { } } if (keys(%updateable)) { + &Apache::lonhtmlcommon::add_breadcrumb( + { href => '/adm/preferences?action=changelockednames', + text => 'Automatic name changes'}); + $r->print(Apache::loncommon::start_page('Automatic name changes')); + $r->print(Apache::lonhtmlcommon::breadcrumbs('Allow/disallow name updates')); my %longnames = &Apache::lonlocal::texthash ( firstname => 'First Name', middlename => 'Middle Name', @@ -2144,11 +2358,14 @@ ENDSCREEN } else { my $message = &mt('Based on your institutional affiliation no name information is automatically updated for your LON-CAPA account.'); &print_main_menu($r,$message); + $ended = 1; } } else { my $message = &mt('You are not permitted to set a user preference for automatic name updates for your LON-CAPA account.'); &print_main_menu($r,$message); + $ended = 1; } + return $ended; } sub verify_and_change_lockednames { @@ -2179,6 +2396,90 @@ sub verify_and_change_lockednames { &print_main_menu($r,$message); } +sub timezonechanger { + my $r = shift; + my $uname = $env{'user.name'}; + my $udom = $env{'user.domain'}; + if (&Apache::lonnet::usertools_access($uname,$udom,'timezone')) { + my $js = &toggle_options_js(); + my %loaditems = ( + onload => "javascript:toggleOptions(document.prefs,'settimezone','LC_timezone_selector');", + ); + my $args = { 'add_entries' => \%loaditems }; + &Apache::lonhtmlcommon::add_breadcrumb( + { href => '/adm/preferences?action=', + text => 'Set Your Time Zone'}); + $r->print(Apache::loncommon::start_page('Set Your Time Zone',$js,$args)); + $r->print(Apache::lonhtmlcommon::breadcrumbs('Set Your Time Zone')); + my %userenv = &Apache::lonnet::get('environment',['timezone']); + my $timezone = $userenv{'timezone'}; + my %lt = &Apache::lonlocal::texthash( + lctz => 'Use Time Zone set by LON-CAPA', + owntz => 'Use Time Zone set by you', + save => 'Save', + ); + my (%checked,$tzsty); + if ($userenv{'timezone'} ne '') { + $checked{'owntz'} = ' checked="checked"'; + $tzsty = 'inline-block'; + } else { + $checked{'lctz'} = ' checked="checked"'; + $tzsty = 'none'; + } + my $onclick = ' onclick="javascript:toggleOptions(this.form,'."'settimezone','LC_timezone_selector'".');"'; + my $selector = &Apache::loncommon::select_timezone('timezone',$timezone,undef,1); + $r->print(<<"END"); +
+ + +     +
  +$selector +


+ +
+END + } + return; +} + +sub verify_and_change_timezone { + my $r = shift; + my $currtimezone = $env{'environment.timezone'}; + my $newtimezone; + if ($env{'form.settimezone'}) { + $newtimezone = $env{'form.timezone'}; + if (DateTime::TimeZone->is_valid_name($env{'form.timezone'})) { + $newtimezone = $env{'form.timezone'}; + } + } + my $message=''; + if ($newtimezone) { + if ($newtimezone eq $currtimezone) { + $message = &mt('Time Zone settings unchanged'); + } else { + &Apache::lonnet::put('environment',{'timezone' => $newtimezone}); + &Apache::lonnet::appenv({'environment.timezone' => $newtimezone}); + $message=&Apache::lonhtmlcommon::confirm_success( + &mt('Set [_1] to [_2]', + ''.&mt('Your Time Zone').'', + '"'.$newtimezone.'".')). + '
'; + } + } elsif ($currtimezone) { + &Apache::lonnet::del('environment',['timezone']); + &Apache::lonnet::delenv('environment.timezone'); + $message=&Apache::lonhtmlcommon::confirm_success(&mt('Time Zone now set by LON-CAPA')); + } else { + $message = &mt('Time Zone settings unchanged'); + } + $message=&Apache::loncommon::confirmwrapper($message); + &print_main_menu($r,$message); + return; +} + sub print_main_menu { my ($r, $message) = @_; # Determine current authentication method @@ -2193,6 +2494,11 @@ my %permissions; if (&Apache::lonnet::usertools_access($user,$domain,'aboutme')) { $permissions{'aboutme'} = 'F'; } +if (&Apache::lonnet::usertools_access($user,$domain,'timezone')) { + $permissions{'timezone'} = 'F'; +} +my %author_roles = &Apache::lonnet::get_my_roles($user,$domain,'userroles','',['au']); +my %author_coauthor_roles = &Apache::lonnet::get_my_roles($user,$domain,'userroles','',['au','ca','aa']); my @menu= ({ categorytitle=>'Personal Data', items =>[ @@ -2235,6 +2541,14 @@ my @menu= icon => 'dismath.png', linktitle => 'Change how math is displayed.' }, + { + linktext => 'Time Zone', + url => '/adm/preferences?action=changetimezone', + permission => $permissions{'timezone'}, + #help => '', + icon => 'timezone.png', + linktitle => 'Set your time zone.', + } ] }, { categorytitle=>'Page Display Settings', @@ -2273,6 +2587,33 @@ my @menu= }, ] }, + ); +if (keys(%author_coauthor_roles) > 0) { + push(@menu, + { categorytitle=>'Authoring Settings', + items => [ + { + linktext => 'Authoring Space Configuration', + url => '/adm/preferences?action=authorsettings', + permission => 'F', + icon => 'codemirror.png', + linktitle => 'Settings for your authoring space.', + }, + ] + }, + ); + if (keys(%author_roles) > 0) { + push(@{ $menu[4]->{items} }, { + linktext => 'Restrict Domain Coordinator Access', + url => '/adm/preferences?action=changedomcoord', + permission => 'F', + #help => '', + icon => 'system-lock-screen.png', + linktitle => 'Restrict domain coordinator access.', + }); + } +} +push(@menu, { categorytitle=>'Other', items =>[ { linktext => 'Register Response Devices ("Clickers")', @@ -2287,7 +2628,7 @@ my @menu= ); if ($currentauth =~ /^(unix|internal):/) { -push(@{ $menu[0]->{items} }, { + push(@{ $menu[0]->{items} }, { linktext => 'Password', url => '/adm/preferences?action=changepass', permission => 'F', @@ -2297,7 +2638,7 @@ push(@{ $menu[0]->{items} }, { }); } if ($env{'environment.remote'} eq 'off') { -push(@{ $menu[1]->{items} }, { + push(@{ $menu[1]->{items} }, { linktext => 'Launch Remote Control', url => '/adm/remote?url=/adm/preferences&action=launch', permission => 'F', @@ -2327,22 +2668,10 @@ push(@{ $menu[1]->{items} }, { }); } - my %author_roles = &Apache::lonnet::get_my_roles($user,$domain,'userroles','',['au']); - if (keys(%author_roles) > 0) { -push(@{ $menu[4]->{items} }, { - linktext => 'Restrict Domain Coordinator Access', - url => '/adm/preferences?action=changedomcoord', - permission => 'F', - #help => '', - icon => 'system-lock-screen.png', - linktitle => 'Restrict domain coordinator access.', - }); - } - if (&Apache::lonnet::allowed('whn',$env{'request.course.id'}) || &Apache::lonnet::allowed('whn',$env{'request.course.id'}.'/' .$env{'request.course.sec'})) { -push(@{ $menu[4]->{items} }, { +push(@{ $menu[-1]->{items} }, { linktext => 'Course Initialization', url => '/adm/preferences?action=changecourseinit', permission => 'F', @@ -2353,19 +2682,8 @@ push(@{ $menu[4]->{items} }, { } - my %author_coauthor_roles = &Apache::lonnet::get_my_roles($user,$domain,'userroles','',['au','ca','aa']); - if (keys(%author_coauthor_roles) > 0) { - push(@{ $menu[4]->{items} }, { - linktext => 'Authoring Space Configuration', - url => '/adm/preferences?action=authorsettings', - permission => 'F', - icon => 'codemirror.png', - linktitle => 'Settings for your authoring space.', - }); - } - if (&can_toggle_debug()) { -push(@{ $menu[4]->{items} }, { +push(@{ $menu[-1]->{items} }, { linktext => 'Toggle Debug Messages (Currently '.($env{'user.debug'} ? 'on)' : 'off)'), url => '/adm/preferences?action=debugtoggle', permission => 'F', @@ -2508,10 +2826,14 @@ sub handler { &print_main_menu($r); $ended = 1; } elsif ($env{'form.action'} eq 'changelockednames') { - &lockednameschanger($r); + $ended = &lockednameschanger($r); } elsif ($env{'form.action'} eq 'verify_and_change_lockednames') { &verify_and_change_lockednames($r); $ended = 1; + } elsif ($env{'form.action'} eq 'changetimezone') { + &timezonechanger($r); + } elsif ($env{'form.action'} eq 'verify_and_change_timezone') { + &verify_and_change_timezone($r); } # Properly end the HTML page of all preference pages @@ -2593,13 +2915,66 @@ sub updateable_userinfo { sub do_redirect { my ($r,$url,$msg) = @_; $r->print( - &Apache::loncommon::start_page('Switching Server ...',undef, - {'redirect' => [0.5,$url]}). + &Apache::loncommon::start_page('Loading ...',undef, + {'redirect' => [2,$url]}). '
'."\n". "$msg\n". &Apache::loncommon::end_page()); return; } +sub toggle_options_js { + return <<"ENDSCRIPT"; + +ENDSCRIPT +} + +sub selectbox { + my ($name,$value,$readonly,$functionref,@idlist)=@_; + my $selout = ''; + return $selout; +} + 1; __END__