options.php 23.3 KB
Newer Older
Nigel McNie's avatar
Nigel McNie committed
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
5
 * Copyright (C) 2006-2009 Catalyst IT Ltd and others; see:
 *                         http://wiki.mahara.org/Contributors
Nigel McNie's avatar
Nigel McNie committed
6
 *
Francois Marier's avatar
Francois Marier committed
7
8
9
10
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
Nigel McNie's avatar
Nigel McNie committed
11
 *
Francois Marier's avatar
Francois Marier committed
12
13
14
15
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
Nigel McNie's avatar
Nigel McNie committed
16
 *
Francois Marier's avatar
Francois Marier committed
17
18
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
Nigel McNie's avatar
Nigel McNie committed
19
20
21
 *
 * @package    mahara
 * @subpackage admin
22
 * @author     Catalyst IT Ltd
Nigel McNie's avatar
Nigel McNie committed
23
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
24
 * @copyright  (C) 2006-2009 Catalyst IT Ltd http://catalyst.net.nz
Nigel McNie's avatar
Nigel McNie committed
25
26
27
 *
 */

28
29
define('INTERNAL', 1);
define('ADMIN', 1);
30
define('MENUITEM', 'configsite/siteoptions');
31
32
33
define('SECTION_PLUGINTYPE', 'core');
define('SECTION_PLUGINNAME', 'admin');
define('SECTION_PAGE', 'siteoptions');
Nigel McNie's avatar
Nigel McNie committed
34
35
36

require(dirname(dirname(dirname(__FILE__))) . '/init.php');
require_once('pieforms/pieform.php');
37
require_once('searchlib.php');
38
require_once('antispam.php');
Nigel McNie's avatar
Nigel McNie committed
39
define('TITLE', get_string('siteoptions', 'admin'));
Nigel McNie's avatar
Nigel McNie committed
40
41

$langoptions = get_languages();
42
$themeoptions = get_all_themes();
Nigel McNie's avatar
Nigel McNie committed
43
44
45
$yesno = array(true  => get_string('yes'),
               false => get_string('no'));

46
47
$searchpluginoptions = get_search_plugins();

48
49
$countries = getoptions_country();

50
51
$spamtraps = available_spam_traps();

52
$siteoptionform = array(
Penny Leach's avatar
Penny Leach committed
53
54
55
56
57
    'name'       => 'siteoptions',
    'jsform'     => true,
    'renderer'   => 'table',
    'plugintype' => 'core',
    'pluginname' => 'admin',
58
    'jssuccesscallback' => 'checkReload',
Penny Leach's avatar
Penny Leach committed
59
    'elements'   => array(
60
61
62
        'sitesettings' => array(
            'type'         => 'fieldset',
            'collapsible'  => true,
63
            'collapsed'    => true,
64
65
66
67
68
69
70
71
            'legend'       => get_string('sitesettingslegend', 'admin'),
            'elements'     => array(
                'sitename' => array(
                    'type'         => 'text',
                    'title'        => get_string('sitename', 'admin'),
                    'description'  => get_string('sitenamedescription', 'admin'),
                    'defaultvalue' => get_config('sitename'),
                    'help'         => true,
72
                    'disabled'     => in_array('sitename', $OVERRIDDEN),
73
74
75
76
77
78
79
80
81
                ),
                'lang' => array(
                    'type'         => 'select',
                    'title'        => get_string('language', 'admin'),
                    'description'  => get_string('sitelanguagedescription', 'admin'),
                    'defaultvalue' => get_config('lang'),
                    'collapseifoneoption' => true,
                    'options'      => $langoptions,
                    'help'         => true,
82
                    'disabled'     => in_array('lang', $OVERRIDDEN),
83
84
85
86
87
88
89
90
                ),
                'country' => array(
                    'type'         => 'select',
                    'title'        => get_string('country', 'admin'),
                    'description'  => get_string('sitecountrydescription', 'admin'),
                    'defaultvalue' => get_config('country'),
                    'options'      => array('' => get_string('nocountryselected')) + $countries,
                    'help'         => true,
91
                    'disabled'     => in_array('country', $OVERRIDDEN),
92
93
94
95
96
97
98
99
100
                ),
                'theme' => array(
                    'type'         => 'select',
                    'title'        => get_string('theme'),
                    'description'  => get_string('sitethemedescription', 'admin'),
                    'defaultvalue' => get_config('theme'),
                    'collapseifoneoption' => true,
                    'options'      => $themeoptions,
                    'help'         => true,
101
                    'disabled'     => in_array('theme', $OVERRIDDEN),
102
103
104
105
106
107
                ),
                'homepageinfo' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('homepageinfo', 'admin'),
                    'description'  => get_string('homepageinfodescription', 'admin'),
                    'defaultvalue' => get_config('homepageinfo'),
108
                    'disabled'     => in_array('homepageinfo', $OVERRIDDEN),
109
110
111
112
113
114
115
                ),
                'registration_sendweeklyupdates' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('sendweeklyupdates', 'admin'),
                    'description'  => get_string('sendweeklyupdatesdescription', 'admin'),
                    'defaultvalue' => get_config('registration_sendweeklyupdates'),
                    'help'         => true,
116
                    'disabled'     => in_array('registration_sendweeklyupdates', $OVERRIDDEN),
117
                ),
118
119
            ),
        ),
120
121
122
        'usersettings' => array(
            'type'         => 'fieldset',
            'collapsible'  => true,
123
            'collapsed'    => true,
124
125
126
127
128
129
130
            'legend'       => get_string('usersettingslegend', 'admin'),
            'elements'     => array(
                'userscanchooseviewthemes' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('userscanchooseviewthemes', 'admin'),
                    'description'  => get_string('userscanchooseviewthemesdescription', 'admin'),
                    'defaultvalue' => get_config('userscanchooseviewthemes'),
131
                    'disabled'     => in_array('userscanchooseviewthemes', $OVERRIDDEN),
132
133
134
135
136
137
138
                ),
                'remoteavatars' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('remoteavatars', 'admin'),
                    'description'  => get_string('remoteavatarsdescription', 'admin'),
                    'defaultvalue' => get_config('remoteavatars'),
                    'help'         => true,
139
                    'disabled'     => in_array('remoteavatars', $OVERRIDDEN),
140
141
142
143
144
145
                ),
                'userscanhiderealnames' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('userscanhiderealnames', 'admin'),
                    'description'  => get_string('userscanhiderealnamesdescription', 'admin'),
                    'defaultvalue' => get_config('userscanhiderealnames'),
146
                    'disabled'     => in_array('userscanhiderealnames', $OVERRIDDEN),
147
148
149
150
151
152
                ),
                'anonymouscomments' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('anonymouscomments', 'admin'),
                    'description'  => get_string('anonymouscommentsdescription', 'admin'),
                    'defaultvalue' => get_config('anonymouscomments'),
153
                    'disabled'     => in_array('anonymouscomments', $OVERRIDDEN),
154
                ),
155
            ),
156
        ),
157
158
159
        'searchsettings' => array(
            'type'         => 'fieldset',
            'collapsible'  => true,
160
            'collapsed'    => true,
161
162
163
164
165
166
167
168
169
170
            'legend'       => get_string('searchsettingslegend', 'admin'),
            'elements'     => array(
                'searchplugin' => array(
                    'type'         => 'select',
                    'title'        => get_string('searchplugin', 'admin'),
                    'description'  => get_string('searchplugindescription', 'admin'),
                    'defaultvalue' => get_config('searchplugin'),
                    'collapseifoneoption' => true,
                    'options'      => $searchpluginoptions,
                    'help'         => true,
171
                    'disabled'     => in_array('searchplugin', $OVERRIDDEN),
172
173
174
175
176
177
                ),
                'showselfsearchsideblock' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('showselfsearchsideblock', 'admin'),
                    'description'  => get_string('showselfsearchsideblockdescription', 'admin'),
                    'defaultvalue' => get_config('showselfsearchsideblock'),
178
                    'disabled'     => in_array('showselfsearchsideblock', $OVERRIDDEN),
179
180
                ),
            ),
181
        ),
182
183
184
        'institutionsettings' => array(
            'type'         => 'fieldset',
            'collapsible'  => true,
185
            'collapsed'    => true,
186
187
188
189
190
191
192
193
            'legend'       => get_string('institutionsettingslegend', 'admin'),
            'elements'     => array(
                'usersallowedmultipleinstitutions' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('usersallowedmultipleinstitutions', 'admin'),
                    'description'  => get_string('usersallowedmultipleinstitutionsdescription', 'admin'),
                    'defaultvalue' => get_config('usersallowedmultipleinstitutions'),
                    'help'         => true,
194
                    'disabled'     => in_array('usersallowedmultipleinstitutions', $OVERRIDDEN),
195
196
197
198
199
200
201
                ),
                'institutionexpirynotification' => array(
                    'type'         => 'expiry',
                    'title'        => get_string('institutionexpirynotification', 'admin'),
                    'description'  => get_string('institutionexpirynotificationdescription', 'admin'),
                    'defaultvalue' => get_config('institutionexpirynotification'),
                    'help'         => true,
202
                    'disabled'     => in_array('institutionexpirynotification', $OVERRIDDEN),
203
204
205
206
207
208
209
                ),
                'institutionautosuspend' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('institutionautosuspend', 'admin'),
                    'description'  => get_string('institutionautosuspenddescription', 'admin'),
                    'defaultvalue' => get_config('institutionautosuspend'),
                    'help'         => true,
210
                    'disabled'     => in_array('institutionautosuspend', $OVERRIDDEN),
211
212
                ),
            ),
213
        ),
214
215
216
        'accountsettings' => array(
            'type'         => 'fieldset',
            'collapsible'  => true,
217
            'collapsed'    => true,
218
219
220
221
222
223
224
225
226
227
            'legend'       => get_string('accountsettingslegend', 'admin'),
            'elements'     => array(
                'sessionlifetime' => array(
                    'type'         => 'text',
                    'size'         => 4,
                    'title'        => get_string('sessionlifetime', 'admin'),
                    'description'  => get_string('sessionlifetimedescription', 'admin'),
                    'defaultvalue' => get_config('session_timeout') / 60,
                    'rules'        => array('integer' => true, 'minvalue' => 1, 'maxvalue' => 10000000),
                    'help'         => true,
228
                    'disabled'     => in_array('session_timeout', $OVERRIDDEN),
229
230
231
232
233
234
235
                ),
                'defaultaccountlifetime' => array(
                    'type'         => 'expiry',
                    'title'        => get_string('defaultaccountlifetime', 'admin'),
                    'description'  => get_string('defaultaccountlifetimedescription', 'admin'),
                    'defaultvalue' => get_config('defaultaccountlifetime'),
                    'help'         => true,
236
                    'disabled'     => in_array('defaultaccountlifetime', $OVERRIDDEN),
237
238
239
240
241
242
243
                ),
                'defaultaccountinactiveexpire' => array(
                    'type'         => 'expiry',
                    'title'        => get_string('defaultaccountinactiveexpire', 'admin'),
                    'description'  => get_string('defaultaccountinactiveexpiredescription', 'admin'),
                    'defaultvalue' => get_config('defaultaccountinactiveexpire'),
                    'help'         => true,
244
                    'disabled'     => in_array('defaultaccountinactiveexpire', $OVERRIDDEN),
245
246
247
248
249
250
251
                ),
                'defaultaccountinactivewarn' => array(
                    'type'         => 'expiry',
                    'title'        => get_string('defaultaccountinactivewarn', 'admin'),
                    'description'  => get_string('defaultaccountinactivewarndescription', 'admin'),
                    'defaultvalue' => get_config('defaultaccountinactivewarn'),
                    'help'         => true,
252
                    'disabled'     => in_array('defaultaccountinactivewarn', $OVERRIDDEN),
253
254
                ),
            ),
255
        ),
256
257
258
        'securitysettings' => array(
            'type'         => 'fieldset',
            'collapsible'  => true,
259
            'collapsed'    => true,
260
261
262
263
264
265
266
267
            'legend'       => get_string('securitysettingslegend', 'admin'),
            'elements'     => array(
                'viruschecking' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('viruschecking', 'admin'),
                    'description'  => get_string('viruscheckingdescription', 'admin'),
                    'defaultvalue' => get_config('viruschecking'),
                    'help'         => true,
268
                    'disabled'     => in_array('viruschecking', $OVERRIDDEN),
269
270
271
272
273
274
275
                ),
                'pathtoclam' => array(
                    'type'         => 'text',
                    'title'        => get_string('pathtoclam', 'admin'),
                    'description'  => get_string('pathtoclamdescription', 'admin'),
                    'defaultvalue' => get_config('pathtoclam'),
                    'help'         => true,
276
                    'disabled'     => in_array('pathtoclam', $OVERRIDDEN),
277
278
279
280
281
282
283
284
                ),
                'antispam' => array(
                    'type'         => 'select',
                    'title'        => get_string('antispam', 'admin'),
                    'description'  => get_string('antispamdescription', 'admin'),
                    'defaultvalue' => get_config('antispam'),
                    'options'      => $spamtraps,
                    'help'         => true,
285
                    'disabled'     => in_array('antispam', $OVERRIDDEN),
286
287
288
289
290
291
292
                ),
                'spamhaus' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('spamhaus', 'admin'),
                    'description'  => get_string('spamhausdescription', 'admin'),
                    'defaultvalue' => get_config('spamhaus'),
                    'help'         => true,
293
                    'disabled'     => in_array('spamhaus', $OVERRIDDEN),
294
295
296
297
298
299
300
                ),
                'surbl' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('surbl', 'admin'),
                    'description'  => get_string('surbldescription', 'admin'),
                    'defaultvalue' => get_config('surbl'),
                    'help'         => true,
301
                    'disabled'     => in_array('surbl', $OVERRIDDEN),
302
303
                ),
            ),
304
        ),
305
306
307
        'generalsettings' => array(
            'type'         => 'fieldset',
            'collapsible'  => true,
308
            'collapsed'    => true,
309
310
311
312
313
314
315
316
317
            'legend'       => get_string('generalsettingslegend', 'admin'),
            'elements'     => array(
                'allowpublicviews' => array(
                    'type'         => 'select',
                    'title'        => get_string('allowpublicviews', 'admin'),
                    'description'  => get_string('allowpublicviewsdescription', 'admin'),
                    'defaultvalue' => get_config('allowpublicviews'),
                    'options'      => $yesno,
                    'help'         => true,
318
                    'disabled'     => in_array('allowpublicviews', $OVERRIDDEN),
319
320
321
322
323
324
325
326
                ),
                'allowpublicprofiles' => array(
                    'type'         => 'select',
                    'title'        => get_string('allowpublicprofiles', 'admin'),
                    'description'  => get_string('allowpublicprofilesdescription', 'admin'),
                    'defaultvalue' => get_config('allowpublicprofiles'),
                    'options'      => $yesno,
                    'help'         => true,
327
                    'disabled'     => in_array('allowpublicprofiles', $OVERRIDDEN),
328
329
330
331
332
333
334
335
336
337
                ),
                'creategroups' => array(
                    'type'         => 'select',
                    'title'        => get_string('whocancreategroups', 'admin'),
                    'description'  => get_string('whocancreategroupsdescription', 'admin'),
                    'defaultvalue' => get_config('creategroups'),
                    'options'      => array(
                        'admins' => get_string('adminsonly', 'admin'),
                        'staff'  => get_string('adminsandstaffonly', 'admin'),
                        'all'    => get_string('Everyone', 'admin'),
338
                    'disabled'     => in_array('creategroups', $OVERRIDDEN),
339
340
341
342
343
344
345
346
347
348
349
350
                    ),
                ),
                'createpublicgroups' => array(
                    'type'         => 'select',
                    'title'        => get_string('whocancreatepublicgroups', 'admin'),
                    'description'  => get_string('whocancreatepublicgroupsdescription', 'admin'),
                    'defaultvalue' => get_config('createpublicgroups'),
                    'options'      => array(
                        'admins' => get_string('adminsonly', 'admin'),
                        'all' => get_string('Everyone', 'admin'),
                    ),
                    'help'         => true,
351
                    'disabled'     => in_array('createpublicgroups', $OVERRIDDEN),
352
353
354
355
356
357
                ),
                'showtagssideblock' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('showtagssideblock', 'admin'),
                    'description'  => get_string('showtagssideblockdescription', 'admin'),
                    'defaultvalue' => get_config('showtagssideblock'),
358
                    'disabled'     => in_array('showtagssideblock', $OVERRIDDEN),
359
360
361
362
363
364
365
366
                ),
                'tagssideblockmaxtags' => array(
                    'type'         => 'text',
                    'size'         => 4,
                    'title'        => get_string('tagssideblockmaxtags', 'admin'),
                    'description'  => get_string('tagssideblockmaxtagsdescription', 'admin'),
                    'defaultvalue' => get_config('tagssideblockmaxtags'),
                    'rules'        => array('integer' => true, 'minvalue' => 0, 'maxvalue' => 1000),
367
                    'disabled'     => in_array('tagssideblockmaxtags', $OVERRIDDEN),
368
369
370
371
372
373
                ),
                'viewmicroheaders' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('smallviewheaders', 'admin'),
                    'description'  => get_string('smallviewheadersdescription', 'admin'),
                    'defaultvalue' => get_config('viewmicroheaders'),
374
375
376
377
378
379
380
381
                    'disabled'     => in_array('viewmicroheaders', $OVERRIDDEN),
                ),
                'showonlineuserssideblock' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('showonlineuserssideblock', 'admin'),
                    'description'  => get_string('showonlineuserssideblockdescription', 'admin'),
                    'defaultvalue' => get_config('showonlineuserssideblock'),
                    'disabled'     => in_array('showonlineuserssideblock', $OVERRIDDEN),
382
                ),
383
384
385
386
387
388
389
                'registerterms' => array(
                    'type'         => 'checkbox',
                    'title'        => get_string('registerterms', 'admin'),
                    'description'  => get_string('registertermsdescription', 'admin'),
                    'defaultvalue' => get_config('registerterms'),
                    'disabled'     => in_array('registerterms', $OVERRIDDEN),
                ),
390
            ),
391
        ),
Nigel McNie's avatar
Nigel McNie committed
392
    )
393
394
395
396
397
398
399
400
);

$siteoptionform['elements']['submit'] = array(
    'type'  => 'submit',
    'value' => get_string('updatesiteoptions', 'admin')
);

$siteoptionform = pieform($siteoptionform);
Nigel McNie's avatar
Nigel McNie committed
401

402
function siteoptions_fail(Pieform $form, $field) {
403
404
405
406
    $form->reply(PIEFORM_ERR, array(
        'message' => get_string('setsiteoptionsfailed', 'admin', get_string($field, 'admin')),
        'goto'    => '/admin/site/options.php',
    ));
Nigel McNie's avatar
Nigel McNie committed
407
408
}

409
function siteoptions_submit(Pieform $form, $values) {
410
411
412
    $fields = array(
        'sitename','lang','theme', 'pathtoclam',
        'defaultaccountlifetime', 'defaultaccountinactiveexpire', 'defaultaccountinactivewarn',
413
        'allowpublicviews', 'allowpublicprofiles', 'creategroups', 'createpublicgroups', 'searchplugin',
414
        'registration_sendweeklyupdates', 'institutionexpirynotification', 'institutionautosuspend',
415
        'showselfsearchsideblock', 'showtagssideblock',
416
        'tagssideblockmaxtags', 'country', 'viewmicroheaders', 'userscanchooseviewthemes',
417
        'remoteavatars', 'userscanhiderealnames', 'antispam', 'spamhaus', 'surbl', 'anonymouscomments',
418
        'homepageinfo', 'showonlineuserssideblock', 'registerterms',
419
    );
420
    $oldlanguage = get_config('lang');
421
    $oldtheme = get_config('theme');
Nigel McNie's avatar
Nigel McNie committed
422
423
    foreach ($fields as $field) {
        if (!set_config($field, $values[$field])) {
424
            siteoptions_fail($form, $field);
Nigel McNie's avatar
Nigel McNie committed
425
426
        }
    }
427
428
429
430
431
    if ($oldlanguage != $values['lang']) {
        safe_require('artefact', 'file');
        ArtefactTypeFolder::change_public_folder_name($oldlanguage, $values['lang']);
    }
    
Nigel McNie's avatar
Nigel McNie committed
432
433
    // submitted sessionlifetime is in minutes; db entry session_timeout is in seconds
    if (!set_config('session_timeout', $values['sessionlifetime'] * 60)) {
434
        siteoptions_fail($form, 'sessionlifetime');
Nigel McNie's avatar
Nigel McNie committed
435
436
    }
    // Submitted value is on/off; database entry should be 1/0
437
438
439
440
    foreach(array('viruschecking', 'usersallowedmultipleinstitutions') as $checkbox) {
        if (!set_config($checkbox, (int) ($values[$checkbox] == 'on'))) {
            siteoptions_fail($form, $checkbox);
        }
Nigel McNie's avatar
Nigel McNie committed
441
    }
442

443
444
445
446
447
448
449
450
451
452
    if ($values['viruschecking'] == 'on') {
        $pathtoclam = escapeshellcmd(trim(get_config('pathtoclam')));
        if (!$pathtoclam || !file_exists($pathtoclam) && !is_executable($pathtoclam)) {
            $form->reply(PIEFORM_ERR, array(
                'message' => get_string('clamlost', 'mahara', $pathtoclam),
                'goto'    => '/admin/site/options.php',
            ));
        }
    }

453
454
    $message = get_string('siteoptionsset', 'admin');
    if ($oldtheme != $values['theme']) {
455
        global $USER;
456
        $message .= '  ' . get_string('usersseenewthemeonlogin', 'admin');
457
        $USER->update_theme();
458
459
    }
    $form->reply(PIEFORM_OK, array('message' => $message, 'goto' => '/admin/site/options.php'));
Nigel McNie's avatar
Nigel McNie committed
460
461
}

462
463
464
$thispage = json_encode(get_config('wwwroot') . 'admin/site/options.php');
$smarty = smarty(array('adminsiteoptions'));
$smarty->assign('siteoptionform', $siteoptionform);
Richard Mansfield's avatar
Richard Mansfield committed
465
$smarty->assign('PAGEHEADING', hsc(get_string('siteoptions', 'admin')));
466
$smarty->display('admin/site/options.tpl');
Nigel McNie's avatar
Nigel McNie committed
467
468

?>