web.php 73.8 KB
Newer Older
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
 * Copyright (C) 2006-2008 Catalyst IT Ltd (http://www.catalyst.net.nz)
5
 *
Francois Marier's avatar
Francois Marier committed
6
7
8
9
 * 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.
10
 *
Francois Marier's avatar
Francois Marier committed
11
12
13
14
 * 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.
15
 *
Francois Marier's avatar
Francois Marier committed
16
17
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19
20
 *
 * @package    mahara
 * @subpackage core
21
 * @author     Catalyst IT Ltd
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
23
 * @copyright  (C) 2006-2008 Catalyst IT Ltd http://catalyst.net.nz
24
25
26
27
28
29
 * @copyright  (C) portions from Moodle, (C) Martin Dougiamas http://dougiamas.com
 */

defined('INTERNAL') || die();


30
function &smarty_core() {
31
    require_once('smarty/libs/Smarty.class.php');
32
33
34
35
36
37
38
    $smarty =& new Smarty();
    
    $theme = theme_setup();
    $themepaths = themepaths();

    $smarty->template_dir = $theme->template_dir;

39
40
    check_dir_exists(get_config('dataroot') . 'smarty/compile/' . $theme->theme);
    check_dir_exists(get_config('dataroot') . 'smarty/cache/' . $theme->theme);
41
42
43
    $smarty->compile_dir   = get_config('dataroot') . 'smarty/compile/' . $theme->theme;
    $smarty->cache_dir     = get_config('dataroot') . 'smarty/cache/' . $theme->theme;
    $smarty->plugins_dir[] = get_config('libroot') . 'smarty/mahara/';
44
45
46
47
48
49
50
51
52
53
54
55
56
57

    $smarty->assign('THEMEURL', get_config('themeurl'));
    $smarty->assign('WWWROOT', get_config('wwwroot'));

    $theme_list = array();
    foreach ($themepaths['mahara'] as $themepath) {
        $theme_list[$themepath] = theme_get_url($themepath);
    }
    $smarty->assign('THEMELIST', json_encode($theme_list));

    return $smarty;
}


58
59
60
61
62
63
64
/**
 * This function creates a Smarty object and sets it up for use within our
 * podclass app, setting up some variables.
 *
 * The variables that it sets up are:
 *
 * - THEMEURL: The base url for static content
65
 * - WWWROOT: The base url for the Mahara system
66
67
68
69
70
 * - USER: The user object
 * - JAVASCRIPT: A list of javascript files to include in the header.  This
 *   list is passed into this function (see below).
 * - HEADERS: An array of any further headers to set.  Each header is just
 *   straight HTML (see below).
71
72
 * - PUBLIC: Set true if this page is a public page
 * - MAINNAV: Array defining the main navigation
73
 *
74
75
76
77
78
 * @param $javascript A list of javascript includes.  Each include should be just
 *                    the name of a file, and reside in {$THEMEURL}js/{filename}
 * @param $headers    A list of additional headers.  These are to be specified as
 *                    actual HTML.
 * @param $strings    A list of language strings required by the javascript code.
79
80
 * @return Smarty
 */
81
82

//smarty(array('js/tablerenderer.js', 'artefact/file/js/filebrowser.js'))
83
function &smarty($javascript = array(), $headers = array(), $pagestrings = array(), $extraconfig = array()) {
84
    global $USER, $SESSION;
85
86
87
88
89
90
91
92
93
94
95

    if (!is_array($headers)) {
        $headers = array();
    }
    if (!is_array($pagestrings)) {
        $pagestrings = array();
    }
    if (!is_array($extraconfig)) {
        $extraconfig = array();
    }

Martyn Smith's avatar
Martyn Smith committed
96
    $SIDEBLOCKS = array();
97

98
99
    $smarty = smarty_core();

100
    $wwwroot = get_config('wwwroot');
101
    // NOTE: not using jswwwroot - it seems to wreck image paths if you 
102
    // drag them around the wysiwyg editor
103
    $jswwwroot = json_encode($wwwroot);
Martyn Smith's avatar
Martyn Smith committed
104
105

    $theme_list = array();
106
107

    $smarty->assign('searchform', searchform());
108
109
110
111
    
    if (function_exists('pieform_get_headdata')) {
        $headers = array_merge($headers, pieform_get_headdata());
    }
112

113
    // Insert the appropriate javascript tags 
114
    $javascript_array = array();
115
    $jsroot = $wwwroot . 'js/';
116

Richard Mansfield's avatar
Richard Mansfield committed
117
    // TinyMCE must be included first for some reason we're not sure about
118
    $checkarray = array(&$javascript, &$headers);
119
    $found_tinymce = false;
120
    foreach ($checkarray as &$check) {
121
122
123
124
        if (($key = array_search('tinymce', $check)) !== false || ($key = array_search('tinytinymce', $check)) !== false) {
            if (!$found_tinymce) {
                $found_tinymce = $check[$key];
                $javascript_array[] = $jsroot . 'tinymce/tiny_mce.js';
125
126
127
128
129
                $content_css = json_encode(theme_get_url('style/tinymce.css'));
                $language = substr(current_language(), 0, 2);
                $execcommand = '';
                if (isset($extraconfig['tinymcecommandcallback'])) {
                    $execcommand = 'execcommand_callback: "' . $extraconfig['tinymcecommandcallback'] . '",';
130
                }
131

132
133
                    if ($check[$key] == 'tinymce') {
                        $tinymce_config = <<<EOF
134
    mode: "none",
135
    theme: "advanced",
136
    plugins: "table,emotions,iespell,inlinepopups,paste",
137
    theme_advanced_buttons1 : "bold,italic,underline,strikethrough,separator,forecolor,backcolor,separator,justifyleft,justifycenter,justifyright,justifyfull,separator,hr,emotions,image,iespell,cleanup,separator,link,unlink,separator,code",
138
    theme_advanced_buttons2 : "bullist,numlist,separator,tablecontrols,separator,cut,copy,paste,pasteword",
139
    theme_advanced_buttons3 : "fontselect,separator,fontsizeselect,separator,formatselect",
140
    theme_advanced_toolbar_location : "top",
141
142
    theme_advanced_toolbar_align : "left",
    //width: '512',
143
EOF;
144
145
146
                    }
                    else {
                        $tinymce_config = <<<EOF
147
    mode: "textareas",
148
149
    editor_selector: 'tinywysiwyg',
    theme: "advanced",
150
    plugins: "fullscreen,inlinepopups",
151
152
    theme_advanced_buttons1 : "bold,italic,underline,separator,justifyleft,justifycenter,justifyright,justifyfull",
    theme_advanced_buttons2 : "bullist,numlist,separator,link,unlink,separator,code,fullscreen",
153
154
    theme_advanced_buttons3 : "",
    theme_advanced_toolbar_location : "top",
155
    theme_advanced_toolbar_align : "left",
156
157
158
159
    fullscreen_new_window: true,
    fullscreen_settings: {
        theme: "advanced",
        plugins: "table,emotions,iespell,inlinepopups,paste",
160
        theme_advanced_buttons1 : "bold,italic,underline,strikethrough,separator,forecolor,backcolor,separator,justifyleft,justifycenter,justifyright,justifyfull,separator,hr,emotions,image,iespell,cleanup,separator,link,unlink,separator,code",
161
162
163
        theme_advanced_buttons2 : "bullist,numlist,separator,tablecontrols,separator,cut,copy,paste,pasteword",
        theme_advanced_buttons3 : "fontselect,separator,fontsizeselect,separator,formatselect"
    },
164
EOF;
165
                }
166

167
                $headers[] = <<<EOF
168
169
170
171
<script type="text/javascript">
tinyMCE.init({
    button_tile_map: true,
    {$tinymce_config}
172
    {$execcommand}
173
    language: '{$language}',
174
    content_css : {$content_css},
175
    //document_base_url: {$jswwwroot},
176
    relative_urls: false
177
178
179
180
});
</script>

EOF;
181
182
183
184
185
186
187
                unset($check[$key]);
            }
            else {
                if ($check[$key] != $found_tinymce) {
                    log_warn('Two differently configured tinyMCE instances have been asked for on this page! This is not possible');
                }
                unset($check[$key]);
188
            }
189
        }
190
191
    }

192
193
    if (get_config('developermode')) {
        $javascript_array[] = $jsroot . 'MochiKit/MochiKit.js';
194
195
196
197
        $javascript_array[] = $jsroot . 'MochiKit/Position.js';
        $javascript_array[] = $jsroot . 'MochiKit/Color.js';
        $javascript_array[] = $jsroot . 'MochiKit/Visual.js';
        $javascript_array[] = $jsroot . 'MochiKit/DragAndDrop.js';
198
        $javascript_array[] = $jsroot . 'MochiKit/Format.js';
199
200
201
202
    }
    else {
        $javascript_array[] = $jsroot . 'MochiKit/Packed.js';
    }
Martyn Smith's avatar
Martyn Smith committed
203
    $javascript_array[] = $jsroot . 'keyboardNavigation.js';
204

205
    $strings = array();
206
207
208
209
210
211
212
213
214
    foreach ($pagestrings as $k => $v) {
        if (is_array($v)) {
            foreach ($v as $tag) {
                $strings[$tag] = get_raw_string($tag, $k);
            }
        }
        else {
            $strings[$k] = get_raw_string($k, $v);
        }
215
216
    }

217
    $jsstrings = jsstrings();
Martyn Smith's avatar
Martyn Smith committed
218
    $themepaths = themepaths();
219

Richard Mansfield's avatar
Richard Mansfield committed
220
    foreach ($javascript as $jsfile) {
221
222
223
224
        // For now, if there's no path in the js file, assume it's in
        // $jsroot and append '.js' to the name.  Later we may want to
        // ensure all smarty() calls include the full path to the js
        // file, with the proper extension.
225
        if (strpos($jsfile, '/') === false) {
226
            $javascript_array[] = $jsroot . $jsfile . '.js';
227
            if (isset($jsstrings[$jsfile])) {
228
229
230
                foreach ($jsstrings[$jsfile] as $section => $tags) {
                    foreach ($tags as $tag) {
                        $strings[$tag] = get_raw_string($tag, $section);
231
232
233
                    }
                }
            }
Martyn Smith's avatar
Martyn Smith committed
234
235
236
237
238
            if (isset($themepaths[$jsfile])) {
                foreach ($themepaths[$jsfile] as $themepath) {
                    $theme_list[$themepath] = theme_get_url($themepath);
                }
            }
239
240
        }
        else {
241
            // A .js file with a fully specified path
242
            $javascript_array[] = $wwwroot . $jsfile;
243
244
245
246
247
248
            // If $jsfile is from a plugin (i.e. plugintype/pluginname/js/foo.js)
            // Then get js strings from static function jsstrings in plugintype/pluginname/lib.php 
            $bits = explode('/', $jsfile);
            if (count($bits) == 4) {
                safe_require($bits[0], $bits[1]);
                $pluginclass = generate_class_name($bits[0], $bits[1]);
249
                $name = substr($bits[3], 0, strpos($bits[3], '.js'));
250
251
                if (is_callable(array($pluginclass, 'jsstrings'))) {
                    $tempstrings = call_static_method($pluginclass, 'jsstrings', $name);
252
253
254
                    foreach ($tempstrings as $section => $tags) {
                        foreach ($tags as $tag) {
                            $strings[$tag] = get_raw_string($tag, $section);
255
256
                        }
                    }
Richard Mansfield's avatar
Richard Mansfield committed
257
                }
258
259
260
261
262
263
264
265
266
                if (is_callable(array($pluginclass, 'jshelp'))) {
                    $tempstrings = call_static_method($pluginclass, 'jshelp', $name);
                    foreach ($tempstrings as $section => $tags) {
                        foreach ($tags as $tag) {
                            $strings[$tag . '.help'] = get_help_icon($bits[0], $bits[1], null, null,
                                                                     null, $tag);
                        }
                    }
                }
Martyn Smith's avatar
Martyn Smith committed
267
268
269
270
271
272
                if (is_callable(array($pluginclass, 'themepaths'))) {
                    $tmpthemepaths = call_static_method($pluginclass, 'themepaths', $name);
                    foreach ($tmpthemepaths as $themepath) {
                        $theme_list[$themepath] = theme_get_url($themepath);
                    }
                }
Martyn Smith's avatar
Martyn Smith committed
273
            }
Martyn Smith's avatar
Martyn Smith committed
274
        }
275
    }
276
277

    $javascript_array[] = $jsroot . 'mahara.js';
278
279
280
281
282
283
    if (get_config('developermode')) {
        $javascript_array[] = $jsroot . 'debug.js';
        if (isset($_SERVER['HTTP_USER_AGENT']) && false === stripos($_SERVER['HTTP_USER_AGENT'], 'gecko')) {
            $javascript_array[] = $jsroot . 'firebug/firebug.js';
        }
    }
284

285
286
287
    foreach ($jsstrings['mahara'] as $section => $tags) {
        foreach ($tags as $tag) {
            $strings[$tag] = get_raw_string($tag, $section);
288
289
        }
    }
290
291
292
293
294
    if (isset($extraconfig['themepaths']) && is_array($extraconfig['themepaths'])) {
        foreach ($extraconfig['themepaths'] as $themepath) {
            $theme_list[$themepath] = theme_get_url($themepath);
        }
    }
295

296
    $stringjs = '<script type="text/javascript">';
297
    $stringjs .= 'var strings = ' . json_encode($strings) . ';';
298
299
    $stringjs .= '</script>';

300
301
302
303
304
305
306
307

    // stylesheet set up - if we're in a plugin also get its stylesheet
    $stylesheets = array_reverse(theme_get_url('style/style.css', null, true));
    if (defined('SECTION_PLUGINTYPE') && defined('SECTION_PLUGINNAME') && SECTION_PLUGINTYPE != 'core') {
        if ($pluginsheets = theme_get_url('style/style.css', SECTION_PLUGINTYPE . '/' . SECTION_PLUGINNAME . '/', true)) {
            $stylesheets = array_merge($stylesheets, array_reverse($pluginsheets));
        }
    }
308
309
310
    if (get_config('developermode')) {
        $stylesheets[] = get_config('wwwroot') . 'theme/debug.css';
    }
311

312
313
314
315
316
317
318
319
320
    // look for extra stylesheets
    if (isset($extraconfig['stylesheets']) && is_array($extraconfig['stylesheets'])) {
        foreach ($extraconfig['stylesheets'] as $extrasheet) {
            if ($sheet = theme_get_url($extrasheet)) {
                $stylesheets[] = $sheet;
            }
        }
    }

321
    $smarty->assign('STRINGJS', $stringjs);
322

323
    $smarty->assign('STYLESHEETLIST', $stylesheets);
324
325
326
327
    if (!empty($theme_list)) {
        // this gets assigned in smarty_core, but do it again here if it's changed locally
        $smarty->assign('THEMELIST', json_encode(array_merge((array)json_decode($smarty->get_template_vars('THEMELIST')),  $theme_list))); 
    }
328

329

330
331
332
333
334
    $sitename = get_config('sitename');
    if (!$sitename) {
       $sitename = 'Mahara';
    }

Martyn Smith's avatar
Martyn Smith committed
335
    if (defined('TITLE')) {
336
        $smarty->assign('PAGETITLE', TITLE . ' - ' . $sitename);
337
        $smarty->assign('heading', TITLE);
Martyn Smith's avatar
Martyn Smith committed
338
339
    }
    else {
340
        $smarty->assign('PAGETITLE', $sitename);
Martyn Smith's avatar
Martyn Smith committed
341
342
    }

343
344
    $sitename = get_config('sitename');
    $smarty->assign('title', $sitename);
345
    $smarty->assign('hiddenheading', $sitename);
346

347
348
349
    if (defined('PUBLIC')) {
        $smarty->assign('PUBLIC', true);
    }
350
351
352
    if (defined('ADMIN')) {
        $smarty->assign('ADMIN', true);
    }
353
354
355
    if (defined('INSTITUTIONALADMIN')) {
        $smarty->assign('INSTITUTIONALADMIN', true);
    }
356

357
358
    $smarty->assign('LOGGEDIN', $USER->is_logged_in());
    if ($USER->is_logged_in()) {
359
        $smarty->assign('MAINNAV', main_nav());
360
    }
361
362
    else {
        $smarty->assign('sitedefaultlang', get_string('sitedefault', 'admin') . ' (' . 
363
                        get_string_from_language(get_config('lang'), 'thislanguage') . ')');
364
365
        $smarty->assign('LANGUAGES', get_languages());
    }
366

367
    $smarty->assign_by_ref('USER', $USER);
368
    $smarty->assign('SESSKEY', $USER->get('sesskey'));
369
    $smarty->assign_by_ref('JAVASCRIPT', $javascript_array);
370
    $smarty->assign_by_ref('HEADERS', $headers);
371
    $smarty->assign('SITECLOSED', get_config('siteclosed'));
372

373
374
    if ((!isset($extraconfig['pagehelp']) || $extraconfig['pagehelp'] !== false)
        and $help = has_page_help()) {
375
376
377
        $smarty->assign('PAGEHELPNAME', $help[0]);
        $smarty->assign('PAGEHELPICON', $help[1]);
    }
378
    if (defined('GROUP')) {
379
        require_once('group.php');
380
        $smarty->assign('GROUP', group_current_group());
381
        $smarty->assign('GROUPNAV', group_get_menu_tabs());
382
    }
383

Martyn Smith's avatar
Martyn Smith committed
384
    // ---------- sideblock stuff ----------
385
    if (!defined('INSTALLER') && (!defined('MENUITEM') || substr(MENUITEM, 0, 5) != 'admin')) {
386
387
388
389
390
        if (get_config('installed')) {
            $data = site_menu();
            if (!empty($data)) {
                $smarty->assign('SITEMENU', site_menu());
                $SIDEBLOCKS[] = array(
391
                    'name'   => 'linksandresources',
392
393
394
395
396
397
398
                    'weight' => 10,
                    'data'   => $data,
                );
            }
        }

        if ($USER->is_logged_in() && defined('MENUITEM') && substr(MENUITEM, 0, 11) == 'myportfolio') {
Clare Lenihan's avatar
Clare Lenihan committed
399
            $SIDEBLOCKS[] = array(
400
401
402
                'name'   => 'selfsearch',
                'weight' => 0,
                'data'   => array(),
Clare Lenihan's avatar
Clare Lenihan committed
403
404
            );
        }
Clare Lenihan's avatar
Clare Lenihan committed
405

406
407
408
409
410
411
412
        if($USER->is_logged_in()) {
            $SIDEBLOCKS[] = array(
                'name'   => 'profile',
                'weight' => -20,
                'data'   => profile_sideblock()
            );
        }
Martyn Smith's avatar
Martyn Smith committed
413

Richard Mansfield's avatar
Richard Mansfield committed
414
415
416
417
418
419
420
421
422
        if(defined('GROUP')) {
            $SIDEBLOCKS[] = array(
                'name'   => 'group',
                'weight' => -10,
                'data'   => group_sideblock()
            );
        }

        if (!$USER->is_logged_in()) {
423
            $SIDEBLOCKS[] = array(
424
425
426
427
428
429
                'name'   => 'login',
                'weight' => -10,
                'id'     => 'loginbox',
                'data'   => array(
                    'loginform' => auth_generate_login_form(),
                ),
430
431
            );
        }
432

433
434
435
436
437
438
439
440
441
        if (get_config('enablenetworking')) {
            require_once(get_config('docroot') .'api/xmlrpc/lib.php');
            if ($USER->is_logged_in() && $ssopeers = get_service_providers($USER->authinstance)) {
                $SIDEBLOCKS[] = array(
                    'name'   => 'ssopeers',
                    'weight' => 1,
                    'data'   => $ssopeers,
                );
            }
Martyn Smith's avatar
Martyn Smith committed
442
443
        }

444
445
446
447
448
        if (isset($extraconfig['sideblocks']) && is_array($extraconfig['sideblocks'])) {
            foreach ($extraconfig['sideblocks'] as $sideblock) {
                $SIDEBLOCKS[] = $sideblock;
            }
        }
Martyn Smith's avatar
Martyn Smith committed
449

450
451
        usort($SIDEBLOCKS, create_function('$a,$b', 'if ($a["weight"] == $b["weight"]) return 0; return ($a["weight"] < $b["weight"]) ? -1 : 1;'));

452
        $smarty->assign('userauthinstance', $SESSION->get('authinstance'));
453
        $smarty->assign('SIDEBLOCKS', $SIDEBLOCKS);
454
455
456
457
458
459
460
461
462

        if ($USER->get('parentuser')) {
            $smarty->assign('USERMASQUERADING', true);
            $smarty->assign('masqueradedetails', get_string('youaremasqueradingas', 'mahara', display_name($USER)));
            $smarty->assign('becomeyouagain',
                ' <a href="' . hsc($wwwroot) . 'admin/users/changeuser.php?restore=1">'
                . get_string('becomeadminagain', 'admin', $USER->get('parentuser')->name)
                . '</a>');
        }
463
    }
Martyn Smith's avatar
Martyn Smith committed
464

465
466
467
    return $smarty;
}

468
469
/** 
 * Returns the lists of strings used in the .js files
470
 * @return array                   
471
472
 */

473
function jsstrings() {
Martyn Smith's avatar
Martyn Smith committed
474
    return array(
475
476
477
       'mahara' => array(                        // js file
            'mahara' => array(                   // section
                'namedfieldempty',               // string name
478
                'processing',
479
480
481
                'requiredfieldempty',
                'unknownerror',
                'loading',
Martyn Smith's avatar
Martyn Smith committed
482
                'showtags',
483
484
                'unreadmessages',
                'unreadmessage',
485
486
                'pendingfriend',
                'pendingfriends',
487
                'couldnotgethelp',
488
489
490
491
492
493
                'password',
                'username',
                'login',
                'sessiontimedout',
                'loginfailed',
                'home',
494
                'youhavenottaggedanythingyet',
495
            ),
496
497
        ),
        'tablerenderer' => array(
498
499
500
501
502
503
            'mahara' => array(
                'firstpage',
                'nextpage',
                'prevpage',
                'lastpage',
            )
504
        ),
505
        'friends' => array(
506
            'group' => array(
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
                'confirmremovefriend',
                'seeallviews',
                'noviewstosee',
                'sendmessage',
                'whymakemeyourfriend',
                'approverequest',
                'denyrequest',
                'pending',
                'removefromfriendslist',
                'views',
                'trysearchingforfriends',
                'nobodyawaitsfriendapproval',
                'sendfriendrequest',
                'addtomyfriends',
                'friendshiprequested',
                'userdoesntwantfriends',
                'existingfriend',
                'nosearchresultsfound',
525
                'reason',
526
                'requestfriendship',
527
                'cancel',
528
529
            ),
        ),
530
531
532
        'views' => array(
            'view' => array(
                'confirmdeleteblockinstance',
533
                'blocksinstructionajax',
534
535
            ),
        ),
536
537
538
539
540
541
542
543
544
        'adminusersearch' => array(
            'admin' => array(
                'suspenduser',
                'suspensionreason',
            ),
            'mahara' => array(
                'cancel',
            ),
        ),
Martyn Smith's avatar
Martyn Smith committed
545
546
547
    );
}

Martyn Smith's avatar
Martyn Smith committed
548
function themepaths() {
549
550
551
552
553
554
555
556
557

    static $paths;
    if (empty($paths)) {
        $paths = array(
            'mahara' => array(
                'images/icon_close.gif',
                'images/failure.gif',
                'images/loading.gif',
                'images/success.gif',
558
                'images/icon_problem.gif',
559
560
561
562
563
                'images/icon_help.gif',
            ),
        );
    }
    return $paths;
Martyn Smith's avatar
Martyn Smith committed
564
565
}

566
567
568
569
570
571
/** 
 * Takes an array of string identifiers and returns an array of the
 * corresponding strings, quoted for use in inline javascript here
 * docs.
 */

572
573
574
575
function quotestrings($strings) {
    $qstrings = array();
    foreach ($strings as $section => $tags) {
        foreach ($tags as $tag) {
576
            $qstrings[$tag] = json_encode(get_string($tag, $section));
577
        }
578
    }
579
    return $qstrings;
580
581
}

582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
/** 
 * This function sets up and caches info about the current selected theme
 * contains inheritance path (used for locating images) and template dirs
 * and potentially more stuff later ( like mime header to send (html vs xhtml))
 * @return object
 */

function theme_setup() {
    
    static $theme;

    if (!empty($theme)) {
        return $theme;
    }
    
    $theme = new StdClass;
598
599
600
601
602
603
604
    global $USER;
    if (!empty($USER)) {
        $theme->theme = $USER->get('theme');
    }
    if (empty($theme->theme)) {
        $theme->theme = get_config('theme');
    }
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
    $theme->path = get_config('docroot') . 'theme/' . $theme->theme . '/';
    $theme->template_dir = array($theme->path . 'templates/');
    $theme->inheritance = array($theme->theme);

    $parent = $theme->theme;

    while (true) {
        if (!$parent = theme_get_parent($parent)) {
            break;
        }
        if ($parent != 'default') {
            $theme->template_dir[] = get_config('docroot') . 'theme/' . $parent . '/templates/';
            $theme->inheritance[] = $parent;
        }
    }

621
    // always put the default theme at the top of the tree, unless we're already it
622
623
624
625
626
627
628
629
630
    // Logic here: If you want your theme to be _completely_ independent (e.g. 
    // you are happy to write/copy the templates etc), then set $theme->parent 
    // = null; in your theme config.php.
    //
    // If you don't set $theme->parent to anything, then the default theme will 
    // be assumed to be the parent.
    //
    // You can of course set $theme->parent to be another theme if you want
    if (!is_null($parent) && $theme->theme != 'default') {
631
        $theme->template_dir[] = get_config('docroot')  . 'theme/default/templates/';
632
        $theme->inheritance[] = 'default';
633
    }
634

635
636
637
638
639
640
641
642
643
644
645
    return $theme;
}

/** 
 * helper function to walk up the inheritance tree and find a parent
 * @param $currtheme the name of the theme to find the parent for
 * @return parent name or false
 */
function theme_get_parent($currtheme) {

    // look for a config file 
646
647
648
    if (is_readable(get_config('docroot') . 'theme/' . $currtheme . '/config.php')) {
        require(get_config('docroot') . 'theme/' . $currtheme. '/config.php');
        if (!empty($theme->parent) && is_dir(get_config('docroot') . 'theme/' . $theme->parent)) {
649
650
            return $theme->parent;
        }
651
652
653
        if (array_key_exists('parent', $theme) && is_null($theme->parent)) {
            return null;
        }
654
655
656
657
658
659
660
661
662
663
    }
    return false;
}

/** 
 * This function returns the full url to an image
 * Always use it to get image urls
 * @param $imagelocation path to image relative to theme/$theme/static/
 * @param $pluginlocation path to plugin relative to docroot
 */
664
function theme_get_url($location, $pluginlocation='', $all = false) {
665
    $theme = theme_setup();
666
    $list = array();
667
668

    foreach ($theme->inheritance as $themedir) {
669
670
671
672
673
674
675
        if (is_readable(get_config('docroot') . $pluginlocation . 'theme/' . $themedir . '/static/' . $location)) {
            if ($all) {
                $list[] = get_config('wwwroot') . $pluginlocation . 'theme/' . $themedir . '/static/' . $location;
            }
            else {
                return get_config('wwwroot') . $pluginlocation . 'theme/' . $themedir . '/static/' . $location;
            }
676
677
        }
    }
678
679
680
681
    if ($all) {
        return $list;
    }
    return;
682
683
}

684
685
686
687
688
689
/** 
 * This function returns the full path to an image
 * Always use it to get image paths
 * @param $imagelocation path to image relative to theme/$theme/static/
 * @param $pluginlocation path to plugin relative to docroot
 */
690
function theme_get_path($location, $pluginlocation='') {
691
692
693
    $theme = theme_setup();

    foreach ($theme->inheritance as $themedir) {
694
695
        if (is_readable(get_config('docroot') . $pluginlocation . 'theme/' . $themedir . '/static/' . $location)) {
            return get_config('docroot') . $pluginlocation . 'theme/' . $themedir . '/static/' . $location;
696
697
698
699
        }
    }
}

700
701
702
703
704
/**
 * This function sends headers suitable for all JSON returning scripts.
 *
 */
function json_headers() {
705
    // @todo Catalyst IT Ltd
706
707
    // header('Content-type: text/x-json');
    header('Content-type: text/plain');
Martyn Smith's avatar
Martyn Smith committed
708
    header('Pragma: no-cache');
709
710
}

Richard Mansfield's avatar
Richard Mansfield committed
711
/**
712
 * This function sends a JSON message, and ends the script.
Richard Mansfield's avatar
Richard Mansfield committed
713
 *
714
715
716
717
718
719
720
721
 * Scripts receiving replies will recieve a JSON array with two fields:
 *
 *  - error: True or false depending on whether the request was successful
 *  - message: JSON data representing a message sent back from the script
 *
 * @param boolean $error   Whether the script ended in an error or not
 * @param string  $message A message to pass back to the user, can be an
 *                         array of JSON data
Richard Mansfield's avatar
Richard Mansfield committed
722
 */
723
function json_reply($error, $message, $returncode=0) {
Richard Mansfield's avatar
Richard Mansfield committed
724
    json_headers();
725
    echo json_encode(array('error' => $error, 'message' => $message, 'returnCode' => $returncode));
726
    perf_to_log();
Richard Mansfield's avatar
Richard Mansfield committed
727
728
729
    exit;
}

730
function _param_retrieve($name) {
731
732
733
734
735
736
737
    // prefer post
    if (isset($_POST[$name])) {
        $value = $_POST[$name];
    } 
    else if (isset($_GET[$name])) {
        $value = $_GET[$name];
    }
738
    else if (func_num_args() == 2) {
739
740
741
        $php_work_around = func_get_arg(1);
        return array($php_work_around, true);
    }
742
    else {
743
744
745
        throw new ParameterException("Missing parameter '$name' and no default supplied");
    }

746
    return array($value, false);
747
748
}

Martyn Smith's avatar
Martyn Smith committed
749
750
751
752
753
754
755
756
757
758
759
/**
 * This function returns a GET or POST parameter with optional default.  If the
 * default isn't specified and the parameter hasn't been sent, a
 * ParameterException exception is thrown
 *
 * @param string The GET or POST parameter you want returned
 * @param mixed [optional] the default value for this parameter
 *
 * @return string The value of the parameter
 *
 */
Martyn Smith's avatar
Martyn Smith committed
760
function param_variable($name) {
761
762
763
    $args = func_get_args();
    list ($value) = call_user_func_array('_param_retrieve', $args);
    return $value;
Martyn Smith's avatar
Martyn Smith committed
764
765
766
767
768
769
770
771
772
773
774
}

/**
 * This function returns a GET or POST parameter as an integer with optional
 * default.  If the default isn't specified and the parameter hasn't been sent,
 * a ParameterException exception is thrown. Likewise, if the parameter isn't a
 * valid integer, a ParameterException exception is thrown
 *
 * @param string The GET or POST parameter you want returned
 * @param mixed [optional] the default value for this parameter
 *
Nigel McNie's avatar
Nigel McNie committed
775
 * @return int The value of the parameter
Martyn Smith's avatar
Martyn Smith committed
776
777
 *
 */
Martyn Smith's avatar
Martyn Smith committed
778
function param_integer($name) {
779
780
781
782
783
784
    $args = func_get_args();

    list ($value, $defaultused) = call_user_func_array('_param_retrieve', $args);

    if ($defaultused) {
        return $value;
Martyn Smith's avatar
Martyn Smith committed
785
786
787
788
789
790
    }

    if (preg_match('/^\d+$/',$value)) {
        return (int)$value;
    }

791
    throw new ParameterException("The '$name' parameter is not an integer");
Martyn Smith's avatar
Martyn Smith committed
792
793
}

Martyn Smith's avatar
Martyn Smith committed
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
/**
 * This function returns a GET or POST parameter as an alpha string with optional
 * default.  If the default isn't specified and the parameter hasn't been sent,
 * a ParameterException exception is thrown. Likewise, if the parameter isn't a
 * valid alpha string, a ParameterException exception is thrown
 *
 * Valid characters are a-z and A-Z
 *
 * @param string The GET or POST parameter you want returned
 * @param mixed [optional] the default value for this parameter
 *
 * @return string The value of the parameter
 *
 */
function param_alpha($name) {
809
810
811
812
813
814
    $args = func_get_args();

    list ($value, $defaultused) = call_user_func_array('_param_retrieve', $args);

    if ($defaultused) {
        return $value;
Martyn Smith's avatar
Martyn Smith committed
815
816
    }

Richard Mansfield's avatar
Richard Mansfield committed
817
    if (preg_match('/^[a-zA-Z]+$/',$value)) {
Martyn Smith's avatar
Martyn Smith committed
818
819
820
        return $value;
    }

821
    throw new ParameterException("The '$name' parameter is not alphabetical only");
Martyn Smith's avatar
Martyn Smith committed
822
823
}

824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
/**
 * This function returns a GET or POST parameter as an alphanumeric string with optional
 * default.  If the default isn't specified and the parameter hasn't been sent,
 * a ParameterException exception is thrown. Likewise, if the parameter isn't a
 * valid alpha string, a ParameterException exception is thrown
 *
 * Valid characters are a-z and A-Z and 0-9
 *
 * @param string The GET or POST parameter you want returned
 * @param mixed [optional] the default value for this parameter
 *
 * @return string The value of the parameter
 *
 */
function param_alphanum($name) {
    $args = func_get_args();

    list ($value, $defaultused) = call_user_func_array('_param_retrieve', $args);

    if ($defaultused) {
        return $value;
    }

    if (preg_match('/^[a-zA-Z0-9]+$/',$value)) {
        return $value;
    }

851
    throw new ParameterException("The '$name' parameter is not alphanumeric only");
852
853
}

854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
/**
 * This function returns a GET or POST parameter as an alphanumeric string with optional
 * default.  If the default isn't specified and the parameter hasn't been sent,
 * a ParameterException exception is thrown. Likewise, if the parameter isn't a
 * valid alpha string, a ParameterException exception is thrown
 *
 * Valid characters are a-z and A-Z and 0-9 and _ and - and .
 *
 * @param string The GET or POST parameter you want returned
 * @param mixed [optional] the default value for this parameter
 *
 * @return string The value of the parameter
 *
 */
function param_alphanumext($name) {
    $args = func_get_args();

    list ($value, $defaultused) = call_user_func_array('_param_retrieve', $args);

    if ($defaultused) {
        return $value;
    }

    if (preg_match('/^[a-zA-Z0-9_.-]+$/',$value)) {
        return $value;
    }

881
    throw new ParameterException("The '$name' parameter contains invalid characters");
882
883
}

Martyn Smith's avatar
Martyn Smith committed
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
/**
 * This function returns a GET or POST parameter as an array of integers with optional
 * default.  If the default isn't specified and the parameter hasn't been sent,
 * a ParameterException exception is thrown. Likewise, if the parameter isn't a
 * valid integer list , a ParameterException exception is thrown.
 *
 * An integer list is integers separated by commas (with optional whitespace),
 * or just whitespace which indicates an empty list
 *
 * @param string The GET or POST parameter you want returned
 * @param mixed [optional] the default value for this parameter
 *
 * @return array The value of the parameter
 *
 */
function param_integer_list($name) {
900
901
902
903
904
905
    $args = func_get_args();

    list ($value, $defaultused) = call_user_func_array('_param_retrieve', $args);

    if ($defaultused) {
        return $value;
Martyn Smith's avatar
Martyn Smith committed
906
907
908
909
910
911
912
913
914
915
    }

    if ($value == '') {
        return array();
    }

    if (preg_match('/^(\d+(,\d+)*)$/',$value)) {
        return array_map('intval', explode(',', $value));
    }

916
    throw new ParameterException("The '$name' parameter is not an integer list");
Martyn Smith's avatar
Martyn Smith committed
917
918
}

Martyn Smith's avatar
Martyn Smith committed
919
920
921
922
923
/**
 * This function returns a GET or POST parameter as a boolean.
 *
 * @param string The GET or POST parameter you want returned
 *
Donal McMullan's avatar
Donal McMullan committed
924
 * @return bool The value of the parameter
Martyn Smith's avatar
Martyn Smith committed
925
926
 *
 */
Martyn Smith's avatar
Martyn Smith committed
927
function param_boolean($name) {
928
929
    
    list ($value) = _param_retrieve($name, false);
Martyn Smith's avatar
Martyn Smith committed
930

931
    if (empty($value) || $value == 'off' || $value == 'no' || $value == 'false') {
Martyn Smith's avatar
Martyn Smith committed
932
933
934
935
936
937
938
        return false;
    }
    else {
        return true;
    }
}

939
/**
940
941
942
 * NOTE: this function is only meant to be used by get_imagesize_parameters(),
 * which you should use in your scripts.
 *
943
944
945
946
947
948
949
 * This function returns a GET or POST parameter as a two element array 
 * repesenting an allowed width and height value for a resized image. If the 
 * default isn't specified and the parameter hasn't been sent, a 
 * ParameterException is thrown. Likewise, if the parameter isn't a valid size 
 * dimension, a ParameterException is thrown.
 *
 * A size parameter is a string, in the form /\d+x\d+/ - e.g. 200x150. The 
950
951
 * width and height are not allowed to be greater than the configured allowed
 * maximums - config variables imagemaxwidth and imagemaxheight.
952
953
954
955
956
957
 *
 * You call this function like so:
 *
 * list($width, $height) = param_imagesize('size');
 *
 * @param string The GET or POST parameter you want returned.
958
 * TODO: i18n for the error messages
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
 */
function param_imagesize($name) {
    $args = func_get_args();

    list ($value, $defaultused) = call_user_func_array('_param_retrieve', $args);

    if ($defaultused) {
        return $value;
    }

    if (!preg_match('/\d+x\d+/', $value)) {
        throw new ParameterException('Invalid size for image specified');
    }

    list($width, $height) = explode('x', $value);
974
    if ($width > get_config('imagemaxwidth') || $height > get_config('imagemaxheight')) {
975
976
        throw new ParameterException('Requested image size is too big');
    }
977
978
    if ($width < 16 || $height < 16) {
        throw new ParameterException('Requested image size is too small');
979
    }
980
981
982
983
984
985
986
987
988
    return array('w' => $width, 'h' => $height);
}

/**
 * Works out what size a requested image should be, based on request parameters
 *
 * The result of this function can be passed to get_dataroot_image_path to 
 * retrieve the filesystem path of the appropriate image
 */
989
990
991
992
993
994
995
996
997
function get_imagesize_parameters($sizeparam='size', $widthparam='width', $heightparam='height',
    $maxsizeparam='maxsize', $maxwidthparam='maxwidth', $maxheightparam='maxheight') {

    $size      = param_imagesize($sizeparam, '');
    $width     = param_integer($widthparam, 0);
    $height    = param_integer($heightparam, 0);
    $maxsize   = param_integer($maxsizeparam, 0);
    $maxwidth  = param_integer($maxwidthparam, 0);
    $maxheight = param_integer($maxheightparam, 0);
998

999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
    $imagemaxwidth  = get_config('imagemaxwidth');
    $imagemaxheight = get_config('imagemaxheight');

    if ($size) {
        return $size;
    }
    if ($maxsize) {
        if ($maxsize > $imagemaxwidth && $maxsize > $imagemaxheight) {
            throw new ParameterException('Requested image size is too big');
        }
        if ($maxsize < 16) {
            throw new ParameterException('Requested image size is too small');
        }
        return $maxsize;
    }
    if ($width) {
        if ($width > $imagemaxwidth) {
            throw new ParameterException('Requested image size is too big');
        }
        if ($width < 16) {
            throw new ParameterException('Requested image size is too small');
        }
        return array('w' => $width);
    }
    if ($height) {
        if ($height > $imagemaxheight) {
            throw new ParameterException('Requested image size is too big');
        }
        if ($height < 16) {
            throw new ParameterException('Requested image size is too small');
        }
        return array('h' => $height);
    }
1032
    $max = array();
1033
1034
1035
1036
1037
1038
1039
    if ($maxwidth) {
        if ($maxwidth > $imagemaxwidth) {
            throw new ParameterException('Requested image size is too big');
        }
        if ($maxwidth < 16) {
            throw new ParameterException('Requested image size is too small');
        }
1040
        $max['maxw'] = $maxwidth;
1041
1042
1043
1044
1045
1046
1047
1048
    }
    if ($maxheight) {
        if ($maxheight > $imagemaxheight) {
            throw new ParameterException('Requested image size is too big');
        }
        if ($maxheight < 16) {
            throw new ParameterException('Requested image size is too small');
        }
1049
1050
1051
1052
        $max['maxh'] = $maxheight;
    }
    if (!empty($max)) {
        return $max;
1053
    }
1054
    return null;
1055
1056
}

1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
/**
 * Gets a cookie, respecting the configured cookie prefix
 *
 * @param string $name The name of the cookie to get the value of
 * @return string      The value of the cookie, or null if the cookie does not
 *                     exist.
 */
function get_cookie($name) {
    $name = get_config('cookieprefix') . $name;
    return (isset($_COOKIE[$name])) ? $_COOKIE[$name] : null;
}

/**
 * Sets a cookie, respecting the configured cookie prefix
 *
 * @param string $name    The name of the cookie
 * @param string $value   The value for the cookie
 * @param int    $expires The unix timestamp of the time the cookie should expire
 * @todo path/domain/secure: should be set automatically by this function if possible (?)
 */
function set_cookie($name, $value='', $expires=0, $path='', $domain='', $secure=false) {
    $name = get_config('cookieprefix') . $name;
    setcookie($name, $value, $expires, $path, $domain, $secure);
}

Martyn Smith's avatar
Martyn Smith committed
1082
1083
1084
1085
1086
1087
1088
/**
 * Returns an assoc array of countrys suitable for use with the "select" form
 * element
 *
 * @return array Associative array of countrycodes => countrynames
 */
function getoptions_country() {
1089
1090
1091
1092
    static $countries;
    if (!empty($countries)) {
        return $countries;
    }
1093
    $codes = array(
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
        'af',
        'ax',
        'al',
        'dz',
        'as',
        'ad',
        'ao',
        'ai',
        'aq',
        'ag',
        'ar',
        'am',
        'aw',
        'au',
        'at',
        'az',
        'bs',
        'bh',
        'bd',
        'bb',
        'by',
        'be',
        'bz',
        'bj',
        'bm',
        'bt',
        'bo',
        'ba',
        'bw',
        'bv',
        'br',
        'io',
        'bn',
        'bg',
        'bf',
        'bi',
        'kh',
        'cm',
        'ca',
        'cv',
        'ky',
        'cf',
        'td',
        'cl',
        'cn',
        'cx',
        'cc',
        'co',
        'km',
        'cg',
        'cd',
        'ck',
        'cr',
        'ci',
        'hr',
        'cu',
        'cy',
        'cz',
        'dk',
        'dj',
        'dm',
        'do',
        'ec',
        'eg',
        'sv',
        'gq',
        'er',
        'ee',
        'et',
        'fk',
        'fo',
        'fj',
        'fi',
        'fr',
        'gf',
        'pf',
        'tf',
        'ga',
        'gm',
        'ge',
        'de',
        'gh',
        'gi',
        'gr',
        'gl',
        'gd',
        'gp',
        'gu',
        'gt',
        'gg',
        'gn',
        'gw',
        'gy',
        'ht',
        'hm',
        'va',
        'hn',
        'hk',
        'hu',
        'is',
        'in',
        'id',
        'ir',
        'iq',
        'ie',
        'im',
        'il',
        'it',
        'jm',
        'jp',
        'je',
        'jo',
        'kz',
        'ke',
        'ki',
        'kp',
        'kr',
        'kw',
        'kg',
        'la',
        'lv',
        'lb',
        'ls',
        'lr',
        'ly',
        'li',
        'lt',
        'lu',
        'mo',
        'mk',
        'mg',
        'mw',
        'my',
        'mv',
        'ml',
        'mt',
        'mh',
        'mq',
        'mr',
        'mu',
        'yt',
        'mx',
        'fm',
        'md',
        'mc',
        'mn',
        'ms',
        'ma',
        'mz',
        'mm',
        'na',
        'nr',
        'np',
        'nl',
        'an',
        'nc',
        'nz',
        'ni',
        'ne',
        'ng',
        'nu',
        'nf',
        'mp',
        'no',
        'om',
        'pk',
        'pw',
        'ps',
        'pa',
        'pg',
        'py',
        'pe',
        'ph',
        'pn',
        'pl',
        'pt',
        'pr',
        'qa',
        're',
        'ro',
        'ru',
        'rw',
        'sh',
        'kn',
        'lc',
        'pm',
        'vc',
        'ws',
        'sm',
        'st',
        'sa',
        'sn',
        'cs',
        'sc',
        'sl',
        'sg',
        'sk',
        'si',
        'sb',
        'so',
        'za',
        'gs',
        'es',
        'lk',
        'sd',
        'sr',
        'sj',
        'sz',
        'se',
        'ch',
        'sy',
        'tw',
        'tj',
        'tz',
        'th',
        'tl',
        'tg',
        'tk',
        'to',
        'tt',
        'tn',
        'tr',
        'tm',
        'tc',
        'tv',
        'ug',
        'ua',
        'ae',
        'gb',
        'us',
        'um',
        'uy',
        'uz',
        'vu',
        've',
        'vn',
        'vg',
        'vi',
        'wf',
        'eh',
        'ye',
        'zm',
        'zw',
    );

1339
1340
1341
1342
    foreach ($codes as $c) {
        $countries[$c] = get_string("country.{$c}");
    };
    uasort($countries, 'strcoll');