1: # The LearningOnline Network with CAPA
2: # Handler to set domain-wide configuration settings
3: #
4: # $Id: lonconfigsettings.pm,v 1.21.4.13.2.2 2022/02/07 12:00:27 raeburn Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA#
23: # /home/httpd/html/adm/gpl.txt
24: #
25: # http://www.lon-capa.org/
26: #
27: #
28: ###############################################################
29: ##############################################################
30:
31: package Apache::lonconfigsettings;
32:
33: use strict;
34: use Apache::lonnet;
35: use Apache::loncommon();
36: use Apache::lonhtmlcommon();
37: use Apache::lonlocal;
38: use Apache::courseclassifier();
39: use LONCAPA qw(:DEFAULT :match);
40:
41: sub print_header {
42: my ($r,$phase,$context,$jscript,$container,$instcode,$dom,$values) = @_;
43: my ($pagetitle,$brcrumtitle,$action,$call_category_check,$instcode_check,
44: $crstype,@actions,@code_order);
45: if ($phase eq 'display') {
46: @actions = &Apache::loncommon::get_env_multiple('form.actions');
47: }
48: if ($context eq 'domain') {
49: ($pagetitle, $brcrumtitle) = ('View/Modify Domain Settings','View/Modify Domain Settings');
50: $action = '/adm/domainprefs';
51: if ($phase eq 'display') {
52: if (grep(/^coursecategories$/,@actions)) {
53: $call_category_check = qq|
54: if (formname == document.display) {
55: if (!categoryCheck(formname)) {
56: return;
57: }
58: }
59: |;
60: }
61: }
62: } else {
63: $crstype = &Apache::loncommon::course_type();
64: if ($crstype eq 'Community') {
65: ($pagetitle,$brcrumtitle) = ('Community Configuration','Community Configuration');
66: } else {
67: ($pagetitle,$brcrumtitle) = ('Course Configuration','Course Configuration');
68: }
69: $action = '/adm/courseprefs';
70: if ($phase eq 'display') {
71: if (grep(/^courseinfo$/,@actions)) {
72: my %codedefaults;
73: &Apache::lonnet::auto_instcode_defaults($env{'request.role.domain'},\%codedefaults,
74: \@code_order);
75: if (@code_order) {
76: my $noinstcodestr = &mt('You indicated cloning based on category, but did not select any categories.');
77: &js_escape(\$noinstcodestr);
78: $instcode_check = <<"ENDSCRIPT";
79: if (formname == document.display) {
80: if (formname.cloners_instcode.length) {
81: for (var j=0; j<formname.cloners_instcode.length; j++) {
82: if (formname.cloners_instcode[j].checked) {
83: if (formname.cloners_instcode[j].value == 1) {
84: var codes;
85: if (document.getElementsByClassName) {
86: codes = document.getElementsByClassName('LC_cloners_instcodes');
87: } else {
88: codes = getElementsByClassName(document.body,'LC_cloners_instcodes');
89: }
90: if (codes.length) {
91: var gotcode = 0;
92: for (var i=0; i<codes.length; i++) {
93: if (codes[i].selectedIndex != 0) {
94: gotcode = 1;
95: break;
96: }
97: }
98: if (!gotcode) {
99: for (var k=0; k<formname.cloners_instcode.length; k++) {
100: if (formname.cloners_instcode[k].value == 0) {
101: formname.cloners_instcode[k].checked = true;
102: }
103: }
104: toggleCloners(document.display.cloners_instcode);
105: alert('$noinstcodestr');
106: return false;
107: }
108: }
109: }
110: }
111: }
112: }
113: }
114:
115: ENDSCRIPT
116: }
117: }
118: }
119: }
120: my $alert = &mt('You must select at least one functionality type to display.');
121: &js_escape(\$alert);
122: my $js = '
123: <script type="text/javascript">
124: // <![CDATA[
125:
126: function changePage(formname,newphase) {
127: formname.phase.value = newphase;
128: numchecked = 0;
129: if (formname == document.pickactions) {
130: if (formname.actions.length > 0) {
131: for (var i = 0; i<formname.actions.length; i++) {
132: if (formname.actions[i].checked) {
133: numchecked ++;
134: }
135: }
136: } else {
137: if (formname.actions.checked) {
138: numchecked ++;
139: }
140: }
141: if (numchecked > 0) {
142: formname.submit();
143: } else {
144: alert("'.$alert.'");
145: return;
146: }
147: }
148: '.$instcode_check.$call_category_check.'
149: formname.submit();
150: }'."\n";
151: if ($phase eq 'pickactions') {
152: $js .= &Apache::lonhtmlcommon::color_picker();
153: $js .=
154: &Apache::lonhtmlcommon::set_form_elements({actions => 'checkbox'})."\n";
155: } elsif ($phase eq 'display') {
156: $js .= &Apache::lonhtmlcommon::color_picker();
157: $js .= &color_pick_js()."\n";
158: }
159: $js .= &Apache::loncommon::viewport_size_js().'
160:
161: // ]]>
162: </script>
163: ';
164: if ($jscript) {
165: $js .= "
166:
167: $jscript
168:
169: ";
170: }
171: my $additem;
172: if ($phase eq 'pickactions') {
173: my %loaditems = (
174: 'onload' => "setFormElements(document.pickactions);",
175: );
176: $additem = {'add_entries' => \%loaditems,};
177: } elsif ($phase eq 'display') {
178: if ($context eq 'domain') {
179: my $onload;
180: if (grep(/^coursedefaults$/,@actions)) {
181: $onload = "toggleDisplay(document.display,'cloneinstcode');".
182: "toggleDisplay(document.display,'credits');".
183: "toggleDisplay(document.display,'studentsubmission');";
184: }
185: if (grep(/^selfcreation$/,@actions)) {
186: my $prefix = 'cancreate_emailverified';
187: my $customclass = 'LC_selfcreate_email';
188: my $classprefix = 'LC_canmodify_emailusername_';
189: my $optionsprefix = 'LC_options_emailusername_';
190: $onload .= "toggleRows(document.display,'cancreate_email','selfassign','$customclass','$classprefix','$optionsprefix');";
191: my ($othertitle,$usertypes,$types) = &Apache::loncommon::sorted_inst_types($dom);
192: my $hascustom;
193: my ($emailrules,$emailruleorder) = &Apache::lonnet::inst_userrules($dom,'email');
194: if (ref($emailrules) eq 'HASH') {
195: if (keys(%{$emailrules}) > 0) {
196: $hascustom = 'cancreate_emailrule';
197: }
198: }
199: my @posstypes;
200: if (ref($types) eq 'ARRAY') {
201: @posstypes = @{$types};
202: push(@posstypes,'default');
203: foreach my $type (@posstypes) {
204: $onload .= "toggleEmailOptions(document.display,'cancreate_emailoptions','$hascustom',".
205: "'cancreate_emaildomain','$type');";
206: }
207: } else {
208: $onload .= "toggleEmailOptions(document.display,'cancreate_emailoptions','$hascustom',".
209: "'cancreate_emaildomain','default');";
210: }
211: }
212: if (grep(/^contacts$/,@actions)) {
213: my $customclass = 'LC_helpdesk_override';
214: my $optionsprefix = 'LC_options_helpdesk_';
215: $onload .= "toggleHelpdeskRow(document.display,'overrides','$customclass','$optionsprefix');";
216: }
217: if (grep(/^ltitools$/,@actions)) {
218: $onload .= "toggleLTITools(document.display,'user','add');";
219: if (ref($values) eq 'HASH') {
220: if (ref($values->{'ltitools'}) eq 'HASH') {
221: my $numltitools = scalar(keys(%{$values->{'ltitools'}}));
222: for (my $i=0; $i<$numltitools; $i++) {
223: $onload .= "toggleLTITools(document.display,'user','$i');";
224: }
225: }
226: }
227: }
228: if (grep(/^wafproxy$/,@actions)) {
229: $onload .= "toggleWAF();checkWAF();updateWAF();";
230: }
231: if (grep(/^scantron$/,@actions)) {
232: $onload .= "toggleScantron(document.display);";
233: }
234: if (grep(/^autoupdate$/,@actions)) {
235: $onload .= "toggleLastActiveDays(document.display);";
236: }
237: if (grep(/^autoenroll$/,@actions)) {
238: $onload .= "toggleFailsafe(document.display);";
239: }
240: if (grep(/^login$/,@actions)) {
241: my %domservers = &Apache::lonnet::get_servers($dom);
242: foreach my $server (sort(keys(%domservers))) {
243: $onload .= "toggleSamlOptions(document.display,'$server');";
244: }
245: }
246: if ($onload) {
247: my %loaditems = (
248: 'onload' => $onload,
249: );
250: $additem = {'add_entries' => \%loaditems,};
251: }
252: } elsif ($context eq 'course') {
253: my $onload;
254: if (grep(/^courseinfo$/,@actions)) {
255: if (@code_order) {
256: $onload = "courseSet('','load');toggleCloners(document.display.cloners_instcode);";
257: }
258: }
259: if (grep(/^linkprotection$/,@actions)) {
260: if (ref($values) eq 'HASH') {
261: if (ref($values->{'linkprotection'}) eq 'HASH') {
262: my $ltiauth;
263: if (exists($env{'course.'.$env{'request.course.id'}.'.internal.ltiauth'})) {
264: $ltiauth = $env{'course.'.$env{'request.course.id'}.'.internal.ltiauth'};
265: } else {
266: my %domdefs = &Apache::lonnet::get_domain_defaults($dom);
267: $ltiauth = $domdefs{'crsltiauth'};
268: }
269: my $posslti = scalar(keys(%{$values->{'linkprotection'}}));
270: for (my $i=0; $i<=$posslti; $i++) {
271: my $num = $i;
272: if ($i == $posslti) {
273: $num = 'add';
274: }
275: if (ref($values->{'linkprotection'}->{$i}) eq 'HASH') {
276: if ($values->{'linkprotection'}->{$i}->{'usable'}) {
277: $onload .= "toggleLTI(document.display,'$num','secret');";
278: }
279: }
280: if ($ltiauth) {
281: $onload .= "toggleLTIReqUser(document.display,'requser','optional','1','block','$num');".
282: "toggleLTIReqUser(document.display,'mapuser','userfield','other','inline-block','$num');";
283: }
284: }
285: }
286: }
287: }
288: if ($onload) {
289: my %loaditems = (
290: 'onload' => $onload,
291: );
292: $additem = {'add_entries' => \%loaditems,};
293: }
294: }
295: }
296: $r->print(&Apache::loncommon::start_page($pagetitle,$js,$additem));
297: $r->print(&Apache::lonhtmlcommon::breadcrumbs($brcrumtitle));
298: $r->print('
299: <form name="parmform" action="">
300: <input type="hidden" name="pres_marker" />
301: <input type="hidden" name="pres_type" />
302: <input type="hidden" name="pres_value" />
303: </form>
304: ');
305: $r->print('<form method="post" name="'.$phase.'" action="'.$action.'"'.
306: ' enctype="multipart/form-data">');
307: return;
308: }
309:
310: sub print_footer {
311: my ($r,$phase,$newphase,$button_text,$actions,$container,$parm_permission) = @_;
312: $button_text = &mt($button_text);
313: $r->print('<input type="hidden" name="phase" value="" />');
314: if (defined($env{'form.origin'})) {
315: $r->print('<input type="hidden" name="origin" value="'.$env{'form.origin'}.'" />'."\n");
316: }
317: if (($phase eq 'display') || ($phase eq 'process')) {
318: if (ref($actions) eq 'ARRAY') {
319: foreach my $item (@{$actions}) {
320: $r->print('<input type="hidden" name="actions" value="'.$item.'" />'."\n");
321: }
322: }
323: }
324: my $dest='"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
325: if ($phase eq 'process') {
326: $r->print(
327: &Apache::lonhtmlcommon::actionbox(
328: ['<a href='.$dest.'>'.$button_text.'</a>']));
329: } else {
330: my $onclick;
331: if ($phase eq 'display') {
332: $onclick = '"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
333: } else {
334: $onclick = '"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
335: }
336: my $showbutton = 1;
337: if (ref($parm_permission) eq 'HASH') {
338: unless (($parm_permission->{'process'}) || ($newphase eq 'display')) {
339: $showbutton = 0;
340: }
341: }
342: if ($showbutton) {
343: $r->print('<p><input type="button" name="store" value="'.
344: $button_text.'" onclick='.$onclick.' /></p>');
345: }
346: }
347: if ($phase eq 'process') {
348: $r->print('</form>');
349: $r->print(&Apache::loncommon::end_page());
350: }
351: return;
352: }
353:
354: sub make_changes {
355: my ($r,$dom,$phase,$context,$prefs_order,$prefs,$values,$confname,$roles,
356: $allitems,$container,$parm_permission) = @_;
357: my %brcrumtext = &get_crumb_text();
358: my @actions = &Apache::loncommon::get_env_multiple('form.actions');
359: my ($numchanged,%changes,%disallowed);
360: &Apache::lonhtmlcommon::add_breadcrumb
361: ({href=>"javascript:changePage(document.$phase,'display')",
362: text=>$brcrumtext{$context}},
363: {href=>"javascript:changePage(document.$phase,'$phase')",
364: text=>"Updated"});
365: &print_header($r,$phase,$context,undef,$container);
366: my ($crstype,%lastact,$errors);
367: if ($context eq 'course') {
368: $crstype = &Apache::loncommon::course_type();
369: }
370: if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH') &&
371: (ref($prefs) eq 'HASH')) {
372: foreach my $item (@{$prefs_order}) {
373: if (grep(/^\Q$item\E$/,@actions)) {
374: if ($context eq 'domain') {
375: $r->print('<h3>'.&mt($prefs->{$item}{'text'}).'</h3>'.
376: &Apache::domainprefs::process_changes($r,$dom,
377: $confname,$item,$roles,$values,\%lastact));
378: } else {
379: $changes{$item} = {};
380: $errors =
381: &Apache::courseprefs::process_changes($dom,$confname,$item,$values,
382: $prefs->{$item},$changes{$item},
383: $allitems,\%disallowed,$crstype);
384: if (keys(%{$changes{$item}}) > 0) {
385: $numchanged ++;
386: }
387: }
388: }
389: }
390: }
391: if ($context eq 'course') {
392: if ($numchanged) {
393: my $message = &Apache::courseprefs::store_changes($dom,$confname,$prefs_order,\@actions,
394: $prefs,$values,\%changes,$crstype);
395: $r->print(&Apache::loncommon::confirmwrapper($message));
396: } else {
397: if ($crstype eq 'Community') {
398: $r->print(&Apache::loncommon::confirmwrapper(&mt("No changes made to community configuration.")));
399: } else {
400: $r->print(&Apache::loncommon::confirmwrapper(&mt("No changes made to course configuration.")));
401: }
402: }
403: if (keys(%disallowed) > 0) {
404: $r->print('<p>');
405: foreach my $item ('cloners','rolenames','feedback','discussion','localization') {
406: if (ref($disallowed{$item}) eq 'HASH') {
407: if (keys(%{$disallowed{$item}}) > 0) {
408: $r->print(&Apache::courseprefs::display_disallowed($item,$disallowed{$item},
409: $prefs,$crstype));
410: }
411: }
412: }
413: $r->print('</p>');
414: }
415: if ($errors) {
416: $r->print('<p>'.$errors.'</p>');
417: }
418: }
419: $r->print('<p>');
420: my $footer_text = 'Back to configuration display';
421: if ($context eq 'course') {
422: $footer_text = 'Back to display/edit settings';
423: }
424: &print_footer($r,$phase,'display',$footer_text,\@actions,$container,$parm_permission);
425: $r->print('</p>');
426: return \%lastact;
427: }
428:
429: sub display_settings {
430: my ($r,$dom,$phase,$context,$prefs_order,$prefs,$values,$confname,$jscript,
431: $allitems,$crstype,$container,$parm_permission) = @_;
432: my %brcrumtext = &get_crumb_text();
433: my @actions = &Apache::loncommon::get_env_multiple('form.actions');
434: &Apache::lonhtmlcommon::add_breadcrumb
435: ({href=>"javascript:changePage(document.$phase,'display')",
436: text=>"Display/Edit Settings"});
437: my $instcode;
438: if (ref($values) eq 'HASH') {
439: $instcode = $values->{'internal.coursecode'};
440: }
441: &print_header($r,$phase,$context,$jscript,$container,$instcode,$dom,$values);
442: my $divwidth = 900;
443: if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH') && (ref($values) eq 'HASH')) {
444: if (@actions > 0) {
445: my $rowsum = 0;
446: my (%output,%rowtotal,@items);
447: foreach my $item (@{$prefs_order}) {
448: if (grep(/^\Q$item\E$/,@actions)) {
449: push(@items,$item);
450: if ($context eq 'domain') {
451: my $settings;
452: if (ref($values) eq 'HASH') {
453: $settings = $values->{$item};
454: }
455: if ($item eq 'usersessions') {
456: $r->print('<script type="text/javascript">'."\n".
457: '// <![CDATA['."\n".
458: &Apache::loncommon::check_uncheck_jscript()."\n".
459: '// ]]>'."\n".
460: '</script>'."\n");
461: } elsif ($item eq 'selfcreation') {
462: if (ref($values) eq 'HASH') {
463: $settings = $values->{'usercreation'};
464: }
465: } elsif ($item eq 'defaults') {
466: if (ref($values->{'inststatus'}) eq 'HASH') {
467: if (ref($values->{'defaults'}) eq 'HASH') {
468: $settings = {%{$values->{'inststatus'}},%{$values->{'defaults'}}};
469: } else {
470: $settings = $values->{'inststatus'};
471: }
472: } else {
473: my ($othertitle,$usertypes,$types) = &Apache::loncommon::sorted_inst_types($dom);
474: my $inststatus = {
475: inststatustypes => $usertypes,
476: inststatusorder => $types,
477: inststatusguest => [],
478: };
479: if (ref($values->{defaults}) eq 'HASH') {
480: $settings = {%{$inststatus},%{$values->{'defaults'}}};
481: } else {
482: $settings = $inststatus;
483: }
484: }
485: }
486: ($output{$item},$rowtotal{$item}) =
487: &Apache::domainprefs::print_config_box($r,$dom,$confname,
488: $phase,$item,$prefs->{$item},$settings);
489: } else {
490: ($output{$item},$rowtotal{$item}) =
491: &Apache::courseprefs::print_config_box($r,$dom,$confname,$phase,
492: $item,$prefs->{$item},$values,$allitems,$crstype,$parm_permission);
493: }
494: $rowsum += $rowtotal{$item};
495: }
496: }
497: $r->print('<div id="prefs" style="max-width:'.$divwidth.'px;margin: 10px auto 10px auto;">');
498: for (my $i=0; $i<@items; $i++) {
499: $r->print($output{$items[$i]});
500: }
501: $r->print('</div>');
502: $r->print(&print_footer($r,$phase,'process','Save Changes',\@actions,$container,$parm_permission));
503: } else {
504: $r->print('<input type="hidden" name="phase" value="" />'.
505: '<span class="LC_error">'.&mt('No settings chosen').
506: '</span>');
507: }
508: $r->print('</form>');
509: }
510: $r->print(&Apache::loncommon::end_page());
511: return;
512: }
513:
514: sub display_choices {
515: my ($r,$phase,$context,$prefs_order,$prefs,$container,$parm_permission) = @_;
516: if ($phase eq '') {
517: $phase = 'pickactions';
518: }
519: my %helphash;
520: &print_header($r,$phase,$context,undef,$container);
521: $r->print('<script type="text/javascript">'."\n".
522: '// <![CDATA['."\n".
523: &Apache::loncommon::check_uncheck_jscript()."\n".
524: '// ]]>'."\n".
525: '</script>'."\n");
526: my $heading = &mt('Settings to display/modify');
527: if (ref($parm_permission) eq 'HASH') {
528: unless ($parm_permission->{'process'}) {
529: $heading = &mt('Settings to display');
530: }
531: }
532: $r->print('<h3>'.$heading.'</h3>'.
533: '<div><input type="button" value="'.&mt('check all').'" '.
534: 'onclick="javascript:checkAll(document.pickactions.actions)"'.
535: ' />'.(' 'x2).
536: '<input type="button" value="'.&mt('uncheck all').'" '.
537: 'onclick="javascript:uncheckAll(document.pickactions.actions)" />'.
538: "\n".
539: '</div><div class="LC_left_float">');
540: my ($numitems,$maxincol,$firstthird,$secondthird,$seconddiv,$thirddiv,$count);
541: if (ref($prefs_order) eq 'ARRAY') {
542: $numitems = @{$prefs_order};
543: }
544: my $numcols = 3;
545: $maxincol = int($numitems/$numcols);
546: if ($numitems%$numcols) {
547: $maxincol ++;
548: }
549: $firstthird = $maxincol;
550: $secondthird = $firstthird + $maxincol;
551: $count = 0;
552: if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH')) {
553: foreach my $item (@{$prefs_order}) {
554: $r->print('<h4>'.
555: &Apache::loncommon::help_open_topic($prefs->{$item}->{'help'}).
556: '<label><input type="checkbox" name="actions" value="'.$item.
557: '" /> '.&mt($prefs->{$item}->{'text'}).'</label></h4>');
558: $count ++;
559: if ((!$seconddiv) && ($count >= $firstthird)) {
560: $r->print('</div>'."\n".'<div class="LC_left_float">'."\n");
561: $seconddiv = 1;
562: }
563: if ((!$thirddiv) && ($count >= $secondthird)) {
564: $r->print('</div>'."\n".'<div class="LC_left_float">'."\n");
565: $thirddiv = 1;
566: }
567: }
568: }
569: $r->print('</div><div style="padding:0;clear:both;margin:0;border:0"></div>');
570: $r->print(&print_footer($r,$phase,'display','Display',undef,$container,$parm_permission));
571: $r->print('</form>');
572: $r->print(&Apache::loncommon::end_page());
573: return;
574: }
575:
576: sub color_pick_js {
577: my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition();
578: my $output = <<"ENDCOL";
579:
580: $pjump_def
581:
582: function psub() {
583: modalWindow.close();
584: if (document.parmform.pres_marker.value!='') {
585: if (document.parmform.pres_type.value!='') {
586: eval('document.display.'+
587: document.parmform.pres_marker.value+
588: '.value=document.parmform.pres_value.value;');
589: }
590: } else {
591: document.parmform.pres_value.value='';
592: document.parmform.pres_marker.value='';
593: }
594: }
595:
596: function get_id (span_id) {
597: if (document.getElementById) {
598: return document.getElementById(span_id);
599: }
600: if (document.all) {
601: return document.all[span_id];
602: }
603: return false;
604: }
605:
606: function colchg_span (span_id_str,new_color_item) {
607: var span_ref = get_id(span_id_str);
608: if (span_ref.style) { span_ref = span_ref.style; }
609: span_ref.background = new_color_item.value;
610: span_ref.backgroundColor = new_color_item.value;
611: span_ref.bgColor = new_color_item.value;
612: }
613:
614: ENDCOL
615: return $output;
616: }
617:
618: sub get_crumb_text {
619: my %brcrumbtext = (
620: domain => 'Domain Settings',
621: course => 'Display/Edit Settings',
622: );
623: return %brcrumbtext;
624: }
625:
626: 1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>