options.php 15.8 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(
Nigel McNie's avatar
Nigel McNie committed
60
61
        'sitename' => array(
            'type'         => 'text',
62
63
            'title'        => get_string('sitename', 'admin'),
            'description'  => get_string('sitenamedescription', 'admin'),
Nigel McNie's avatar
Nigel McNie committed
64
            'defaultvalue' => get_config('sitename'),
Penny Leach's avatar
Penny Leach committed
65
            'help'         => true,
Nigel McNie's avatar
Nigel McNie committed
66
        ),
67
        'lang' => array(
Nigel McNie's avatar
Nigel McNie committed
68
            'type'         => 'select',
69
70
            'title'        => get_string('language', 'admin'),
            'description'  => get_string('sitelanguagedescription', 'admin'),
71
            'defaultvalue' => get_config('lang'),
Nigel McNie's avatar
Nigel McNie committed
72
73
            'collapseifoneoption' => true,
            'options'      => $langoptions,
Penny Leach's avatar
Penny Leach committed
74
            'help'         => true,
Nigel McNie's avatar
Nigel McNie committed
75
        ),
76
77
78
79
        'country' => array(
            'type'         => 'select',
            'title'        => get_string('country', 'admin'),
            'description'  => get_string('sitecountrydescription', 'admin'),
80
81
            'defaultvalue' => get_config('country'),
            'options'      => array('' => get_string('nocountryselected')) + $countries,
82
83
            'help'         => true,
        ),
Nigel McNie's avatar
Nigel McNie committed
84
85
        'theme' => array(
            'type'         => 'select',
86
            'title'        => get_string('theme'),
87
            'description'  => get_string('sitethemedescription', 'admin'),
Nigel McNie's avatar
Nigel McNie committed
88
89
90
            'defaultvalue' => get_config('theme'),
            'collapseifoneoption' => true,
            'options'      => $themeoptions,
Penny Leach's avatar
Penny Leach committed
91
            'help'         => true,
Nigel McNie's avatar
Nigel McNie committed
92
        ),
93
94
        'searchplugin' => array(
            'type'         => 'select',
95
96
            'title'        => get_string('searchplugin', 'admin'),
            'description'  => get_string('searchplugindescription', 'admin'),
97
98
99
            'defaultvalue' => get_config('searchplugin'),
            'collapseifoneoption' => true,
            'options'      => $searchpluginoptions,
Penny Leach's avatar
Penny Leach committed
100
            'help'         => true,
101
        ),
Nigel McNie's avatar
Nigel McNie committed
102
103
        'viruschecking' => array(
            'type'         => 'checkbox',
104
105
            'title'        => get_string('viruschecking', 'admin'),
            'description'  => get_string('viruscheckingdescription', 'admin'),
Nigel McNie's avatar
Nigel McNie committed
106
            'defaultvalue' => get_config('viruschecking'),
Penny Leach's avatar
Penny Leach committed
107
            'help'         => true,
Nigel McNie's avatar
Nigel McNie committed
108
109
110
        ),
        'pathtoclam' => array(
            'type'         => 'text',
111
112
            'title'        => get_string('pathtoclam', 'admin'),
            'description'  => get_string('pathtoclamdescription', 'admin'),
Nigel McNie's avatar
Nigel McNie committed
113
            'defaultvalue' => get_config('pathtoclam'),
Penny Leach's avatar
Penny Leach committed
114
            'help'         => true,
Nigel McNie's avatar
Nigel McNie committed
115
116
117
118
        ),
        'sessionlifetime' => array(
            'type'         => 'text',
            'size'         => 4,
119
120
            'title'        => get_string('sessionlifetime', 'admin'),
            'description'  => get_string('sessionlifetimedescription', 'admin'),
Nigel McNie's avatar
Nigel McNie committed
121
            'defaultvalue' => get_config('session_timeout') / 60,
122
            'rules'        => array('integer' => true, 'minvalue' => 1, 'maxvalue' => 10000000),
Penny Leach's avatar
Penny Leach committed
123
            'help'         => true,
Nigel McNie's avatar
Nigel McNie committed
124
125
126
        ),
        'allowpublicviews' => array(
            'type'         => 'select',
127
128
            'title'        => get_string('allowpublicviews', 'admin'),
            'description'  => get_string('allowpublicviewsdescription', 'admin'),
Nigel McNie's avatar
Nigel McNie committed
129
130
            'defaultvalue' => get_config('allowpublicviews'),
            'options'      => $yesno,
Penny Leach's avatar
Penny Leach committed
131
            'help'         => true,
Nigel McNie's avatar
Nigel McNie committed
132
        ),
133
134
135
136
137
138
139
140
        'allowpublicprofiles' => array(
            'type'         => 'select',
            'title'        => get_string('allowpublicprofiles', 'admin'),
            'description'  => get_string('allowpublicprofilesdescription', 'admin'),
            'defaultvalue' => get_config('allowpublicprofiles'),
            'options'      => $yesno,
            'help'         => true,
        ),
141
142
143
144
145
146
147
148
149
150
151
        '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'),
            ),
        ),
152
153
154
155
156
157
158
159
160
161
162
        '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,
        ),
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
        'defaultaccountlifetime' => array(
            'type'         => 'expiry',
            'title'        => get_string('defaultaccountlifetime', 'admin'),
            'description'  => get_string('defaultaccountlifetimedescription', 'admin'),
            'defaultvalue' => get_config('defaultaccountlifetime'),
            'help'         => true,
        ),
        'defaultaccountinactiveexpire' => array(
            'type'         => 'expiry',
            'title'        => get_string('defaultaccountinactiveexpire', 'admin'),
            'description'  => get_string('defaultaccountinactiveexpiredescription', 'admin'),
            'defaultvalue' => get_config('defaultaccountinactiveexpire'),
            'help'         => true,
        ),
        'defaultaccountinactivewarn' => array(
            'type'         => 'expiry',
            'title'        => get_string('defaultaccountinactivewarn', 'admin'),
            'description'  => get_string('defaultaccountinactivewarndescription', 'admin'),
            'defaultvalue' => get_config('defaultaccountinactivewarn'),
            'help'         => true,
        ),
184
185
        'usersallowedmultipleinstitutions' => array(
            'type'         => 'checkbox',
186
187
            'title'        => get_string('usersallowedmultipleinstitutions', 'admin'),
            'description'  => get_string('usersallowedmultipleinstitutionsdescription', 'admin'),
188
            'defaultvalue' => get_config('usersallowedmultipleinstitutions'),
189
            'help'         => true,
190
        ),
191
192
193
194
195
196
197
        'registration_sendweeklyupdates' => array(
            'type'         => 'checkbox',
            'title'        => get_string('sendweeklyupdates', 'admin'),
            'description'  => get_string('sendweeklyupdatesdescription', 'admin'),
            'defaultvalue' => get_config('registration_sendweeklyupdates'),
            'help'         => true,
        ),
198
199
200
201
        'institutionexpirynotification' => array(
            'type'         => 'expiry',
            'title'        => get_string('institutionexpirynotification', 'admin'),
            'description'  => get_string('institutionexpirynotificationdescription', 'admin'),
202
            'defaultvalue' => get_config('institutionexpirynotification'),
203
204
            'help'         => true,
        ),
205
206
207
208
209
210
211
        'institutionautosuspend' => array(
            'type'         => 'checkbox',
            'title'        => get_string('institutionautosuspend', 'admin'),
            'description'  => get_string('institutionautosuspenddescription', 'admin'),
            'defaultvalue' => get_config('institutionautosuspend'),
            'help'         => true,
        ),
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
        'showselfsearchsideblock' => array(
            'type'         => 'checkbox',
            'title'        => get_string('showselfsearchsideblock', 'admin'),
            'description'  => get_string('showselfsearchsideblockdescription', 'admin'),
            'defaultvalue' => get_config('showselfsearchsideblock'),
        ),
        'showtagssideblock' => array(
            'type'         => 'checkbox',
            'title'        => get_string('showtagssideblock', 'admin'),
            'description'  => get_string('showtagssideblockdescription', 'admin'),
            'defaultvalue' => get_config('showtagssideblock'),
        ),
        '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),
        ),
232
233
234
235
236
237
        'viewmicroheaders' => array(
            'type'         => 'checkbox',
            'title'        => get_string('smallviewheaders', 'admin'),
            'description'  => get_string('smallviewheadersdescription', 'admin'),
            'defaultvalue' => get_config('viewmicroheaders'),
        ),
238
239
240
241
242
243
        'userscanchooseviewthemes' => array(
            'type'         => 'checkbox',
            'title'        => get_string('userscanchooseviewthemes', 'admin'),
            'description'  => get_string('userscanchooseviewthemesdescription', 'admin'),
            'defaultvalue' => get_config('userscanchooseviewthemes'),
        ),
244
245
246
247
248
249
250
        'remoteavatars' => array(
            'type'         => 'checkbox',
            'title'        => get_string('remoteavatars', 'admin'),
            'description'  => get_string('remoteavatarsdescription', 'admin'),
            'defaultvalue' => get_config('remoteavatars'),
            'help'         => true,
        ),
251
252
253
254
255
256
        'userscanhiderealnames' => array(
            'type'         => 'checkbox',
            'title'        => get_string('userscanhiderealnames', 'admin'),
            'description'  => get_string('userscanhiderealnamesdescription', 'admin'),
            'defaultvalue' => get_config('userscanhiderealnames'),
        ),
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
        'antispam' => array(
            'type'         => 'select',
            'title'        => get_string('antispam', 'admin'),
            'description'  => get_string('antispamdescription', 'admin'),
            'defaultvalue' => get_config('antispam'),
            'options'      => $spamtraps,
            'help'         => true,
        ),
        'spamhaus' => array(
            'type'         => 'checkbox',
            'title'        => get_string('spamhaus', 'admin'),
            'description'  => get_string('spamhausdescription', 'admin'),
            'defaultvalue' => get_config('spamhaus'),
            'help'         => true,
        ),
        'surbl' => array(
            'type'         => 'checkbox',
            'title'        => get_string('surbl', 'admin'),
            'description'  => get_string('surbldescription', 'admin'),
            'defaultvalue' => get_config('surbl'),
            'help'         => true,
278
        ),
279
280
281
282
283
284
        'anonymouscomments' => array(
            'type'         => 'checkbox',
            'title'        => get_string('anonymouscomments', 'admin'),
            'description'  => get_string('anonymouscommentsdescription', 'admin'),
            'defaultvalue' => get_config('anonymouscomments'),
        ),
Nigel McNie's avatar
Nigel McNie committed
285
    )
286
287
288
289
290
291
292
293
);

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

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

295
function siteoptions_fail(Pieform $form, $field) {
296
297
298
299
    $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
300
301
}

302
function siteoptions_submit(Pieform $form, $values) {
303
304
305
    $fields = array(
        'sitename','lang','theme', 'pathtoclam',
        'defaultaccountlifetime', 'defaultaccountinactiveexpire', 'defaultaccountinactivewarn',
306
        'allowpublicviews', 'allowpublicprofiles', 'creategroups', 'createpublicgroups', 'searchplugin',
307
        'registration_sendweeklyupdates', 'institutionexpirynotification', 'institutionautosuspend',
308
        'showselfsearchsideblock', 'showtagssideblock',
309
        'tagssideblockmaxtags', 'country', 'viewmicroheaders', 'userscanchooseviewthemes',
310
        'remoteavatars', 'userscanhiderealnames', 'antispam', 'spamhaus', 'surbl', 'anonymouscomments',
311
    );
312
    $oldlanguage = get_config('lang');
313
    $oldtheme = get_config('theme');
Nigel McNie's avatar
Nigel McNie committed
314
315
    foreach ($fields as $field) {
        if (!set_config($field, $values[$field])) {
316
            siteoptions_fail($form, $field);
Nigel McNie's avatar
Nigel McNie committed
317
318
        }
    }
319
320
321
322
323
    if ($oldlanguage != $values['lang']) {
        safe_require('artefact', 'file');
        ArtefactTypeFolder::change_public_folder_name($oldlanguage, $values['lang']);
    }
    
Nigel McNie's avatar
Nigel McNie committed
324
325
    // submitted sessionlifetime is in minutes; db entry session_timeout is in seconds
    if (!set_config('session_timeout', $values['sessionlifetime'] * 60)) {
326
        siteoptions_fail($form, 'sessionlifetime');
Nigel McNie's avatar
Nigel McNie committed
327
328
    }
    // Submitted value is on/off; database entry should be 1/0
329
330
331
332
    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
333
    }
334

335
336
337
338
339
340
341
342
343
344
    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',
            ));
        }
    }

345
346
    $message = get_string('siteoptionsset', 'admin');
    if ($oldtheme != $values['theme']) {
347
        global $USER;
348
        $message .= '  ' . get_string('usersseenewthemeonlogin', 'admin');
349
        $USER->update_theme();
350
351
    }
    $form->reply(PIEFORM_OK, array('message' => $message, 'goto' => '/admin/site/options.php'));
Nigel McNie's avatar
Nigel McNie committed
352
353
}

354
355
356
$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
357
$smarty->assign('PAGEHEADING', hsc(get_string('siteoptions', 'admin')));
358
$smarty->display('admin/site/options.tpl');
Nigel McNie's avatar
Nigel McNie committed
359
360

?>