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