summaryrefslogtreecommitdiff
path: root/app/helpers.php
blob: cd6d630e8ddc9ecf9062cd01db8d1b49ab9b88e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
<?php

namespace Helper;

/**
 * Template helpers
 *
 */

use Core\Security;
use Core\Template;
use Core\Tool;
use Parsedown\Parsedown;

/**
 * Append a CSRF token to a query string
 *
 * @return string
 */
function param_csrf()
{
    return '&amp;csrf_token='.Security::getCSRFToken();
}

/**
 * Add a Javascript asset
 *
 * @param  string   $filename   Filename
 * @return string
 */
function js($filename)
{
    return '<script type="text/javascript" src="'.$filename.'?'.filemtime($filename).'"></script>';
}

/**
 * Add a stylesheet asset
 *
 * @param  string   $filename   Filename
 * @return string
 */
function css($filename)
{
    return '<link rel="stylesheet" href="'.$filename.'?'.filemtime($filename).'" media="screen">';
}

/**
 * Load a template
 *
 * @param  string    $name    Template name
 * @param  array     $args    Template parameters
 * @return string
 */
function template($name, array $args = array())
{
    $tpl = new Template;
    return $tpl->load($name, $args);
}

/**
 * Check if the given user_id is the connected user
 *
 * @param  integer   $user_id   User id
 * @return boolean
 */
function is_current_user($user_id)
{
    return $_SESSION['user']['id'] == $user_id;
}

/**
 * Check if the current user is administrator
 *
 * @return boolean
 */
function is_admin()
{
    return $_SESSION['user']['is_admin'] == 1;
}

/**
 * Return the username
 *
 * @param  array    $user   User properties (optional)
 * @return string
 */
function get_username(array $user = array())
{
    return ! empty($user) ? ($user['name'] ?: $user['username'])
                : ($_SESSION['user']['name'] ?: $_SESSION['user']['username']);
}

/**
 * Get the current user id
 *
 * @return integer
 */
function get_user_id()
{
    return $_SESSION['user']['id'];
}

/**
 * Markdown transformation
 *
 * @param  string    $text     Markdown content
 * @param  array     $link     Link parameters for replacement
 * @return string
 */
function markdown($text, array $link = array('controller' => 'task', 'action' => 'show', 'params' => array()))
{
    $html = Parsedown::instance()
                ->setMarkupEscaped(true) # escapes markup (HTML)
                ->text($text);

    // Replace task #123 by a link to the task
    $html = preg_replace_callback('!#(\d+)!i', function($matches) use ($link) {
        return a(
            $matches[0],
            $link['controller'],
            $link['action'],
            $link['params'] + array('task_id' => $matches[1])
        );
    }, $html);

    return $html;
}

/**
 * Get the current URL without the querystring
 *
 * @return string
 */
function get_current_base_url()
{
    $url = Tool::isHTTPS() ? 'https://' : 'http://';
    $url .= $_SERVER['SERVER_NAME'];
    $url .= $_SERVER['SERVER_PORT'] == 80 || $_SERVER['SERVER_PORT'] == 443 ? '' : ':'.$_SERVER['SERVER_PORT'];
    $url .= dirname($_SERVER['PHP_SELF']) !== '/' ? dirname($_SERVER['PHP_SELF']).'/' : '/';

    return $url;
}

/**
 * HTML escaping
 *
 * @param  string   $value    Value to escape
 * @return string
 */
function escape($value)
{
    return htmlspecialchars($value, ENT_QUOTES, 'UTF-8', false);
}

/**
 * Dispplay the flash session message
 *
 * @param  string   $html   HTML wrapper
 * @return string
 */
function flash($html)
{
    $data = '';

    if (isset($_SESSION['flash_message'])) {
        $data = sprintf($html, escape($_SESSION['flash_message']));
        unset($_SESSION['flash_message']);
    }

    return $data;
}

/**
 * Display the flash session error message
 *
 * @param  string    $html    HTML wrapper
 * @return string
 */
function flash_error($html)
{
    $data = '';

    if (isset($_SESSION['flash_error_message'])) {
        $data = sprintf($html, escape($_SESSION['flash_error_message']));
        unset($_SESSION['flash_error_message']);
    }

    return $data;
}

/**
 * Format a file size
 *
 * @param  integer  $size        Size in bytes
 * @param  integer  $precision   Precision
 * @return string
 */
function format_bytes($size, $precision = 2)
{
    $base = log($size) / log(1024);
    $suffixes = array('', 'k', 'M', 'G', 'T');

    return round(pow(1024, $base - floor($base)), $precision).$suffixes[(int)floor($base)];
}

/**
 * Truncate a long text
 *
 * @param  string    $value         Text
 * @param  integer   $max_length    Max Length
 * @param  string    $end           Text end
 * @return string
 */
function summary($value, $max_length = 85, $end = '[...]')
{
    $length = strlen($value);

    if ($length > $max_length) {
        return substr($value, 0, $max_length).' '.$end;
    }

    return $value;
}

/**
 * Return true if needle is contained in the haystack
 *
 * @param  string   $haystack   Haystack
 * @param  string   $needle     Needle
 * @return boolean
 */
function contains($haystack, $needle)
{
    return strpos($haystack, $needle) !== false;
}

/**
 * Return a value from a dictionary
 *
 * @param  mixed   $id              Key
 * @param  array   $listing         Dictionary
 * @param  string  $default_value   Value displayed when the key doesn't exists
 * @return string
 */
function in_list($id, array $listing, $default_value = '?')
{
    if (isset($listing[$id])) {
        return escape($listing[$id]);
    }

    return $default_value;
}

/**
 * Display the form error class
 *
 * @param array   $errors   Error list
 * @param string  $name     Field name
 * @return string
 */
function error_class(array $errors, $name)
{
    return ! isset($errors[$name]) ? '' : ' form-error';
}

/**
 * Display a list of form errors
 *
 * @param array   $errors   List of errors
 * @param string  $name     Field name
 * @return string
 */
function error_list(array $errors, $name)
{
    $html = '';

    if (isset($errors[$name])) {

        $html .= '<ul class="form-errors">';

        foreach ($errors[$name] as $error) {
            $html .= '<li>'.escape($error).'</li>';
        }

        $html .= '</ul>';
    }

    return $html;
}

/**
 * Get an escaped form value
 *
 * @param  mixed  $values  Values
 * @param  string $name    Field name
 * @return string
 */
function form_value($values, $name)
{
    if (isset($values->$name)) {
        return 'value="'.escape($values->$name).'"';
    }

    return isset($values[$name]) ? 'value="'.escape($values[$name]).'"' : '';
}

/**
 * Hidden CSRF token field
 *
 * @return string
 */
function form_csrf()
{
    return '<input type="hidden" name="csrf_token" value="'.Security::getCSRFToken().'"/>';
}

/**
 * Display a hidden form field
 *
 * @param  string  $name    Field name
 * @param  array   $values  Form values
 * @return string
 */
function form_hidden($name, array $values = array())
{
    return '<input type="hidden" name="'.$name.'" id="form-'.$name.'" '.form_value($values, $name).'/>';
}

/**
 * Display a select field
 *
 * @param  string  $name     Field name
 * @param  array   $options  Options
 * @param  array   $values   Form values
 * @param  array   $errors   Form errors
 * @param  string  $class    CSS class
 * @return string
 */
function form_select($name, array $options, array $values = array(), array $errors = array(), $class = '')
{
    $html = '<select name="'.$name.'" id="form-'.$name.'" class="'.$class.'">';

    foreach ($options as $id => $value) {

        $html .= '<option value="'.escape($id).'"';

        if (isset($values->$name) && $id == $values->$name) $html .= ' selected="selected"';
        if (isset($values[$name]) && $id == $values[$name]) $html .= ' selected="selected"';

        $html .= '>'.escape($value).'</option>';
    }

    $html .= '</select>';
    $html .= error_list($errors, $name);

    return $html;
}

/**
 * Display a radio field group
 *
 * @param  string  $name     Field name
 * @param  array   $options  Options
 * @param  array   $values   Form values
 * @return string
 */
function form_radios($name, array $options, array $values = array())
{
    $html = '';

    foreach ($options as $value => $label) {
        $html .= form_radio($name, $label, $value, isset($values[$name]) && $values[$name] == $value);
    }

    return $html;
}

/**
 * Display a radio field
 *
 * @param  string  $name      Field name
 * @param  string  $label     Form label
 * @param  string  $value     Form value
 * @param  boolean $selected  Field selected or not
 * @param  string  $class     CSS class
 * @return string
 */
function form_radio($name, $label, $value, $selected = false, $class = '')
{
    return '<label><input type="radio" name="'.$name.'" class="'.$class.'" value="'.escape($value).'" '.($selected ? 'selected="selected"' : '').'>'.escape($label).'</label>';
}

/**
 * Display a checkbox field
 *
 * @param  string  $name      Field name
 * @param  string  $label     Form label
 * @param  string  $value     Form value
 * @param  boolean $checked   Field selected or not
 * @param  string  $class     CSS class
 * @return string
 */
function form_checkbox($name, $label, $value, $checked = false, $class = '')
{
    return '<label><input type="checkbox" name="'.$name.'" class="'.$class.'" value="'.escape($value).'" '.($checked ? 'checked="checked"' : '').'>&nbsp;'.escape($label).'</label>';
}

/**
 * Display a form label
 *
 * @param  string  $name        Field name
 * @param  string  $label       Form label
 * @param  array   $attributes  HTML attributes
 * @return string
 */
function form_label($label, $name, array $attributes = array())
{
    return '<label for="form-'.$name.'" '.implode(' ', $attributes).'>'.escape($label).'</label>';
}

/**
 * Display a textarea
 *
 * @param  string  $name        Field name
 * @param  array   $values      Form values
 * @param  array   $errors      Form errors
 * @param  array   $attributes  HTML attributes
 * @param  string  $class       CSS class
 * @return string
 */
function form_textarea($name, $values = array(), array $errors = array(), array $attributes = array(), $class = '')
{
    $class .= error_class($errors, $name);

    $html = '<textarea name="'.$name.'" id="form-'.$name.'" class="'.$class.'" ';
    $html .= implode(' ', $attributes).'>';
    $html .= isset($values->$name) ? escape($values->$name) : isset($values[$name]) ? $values[$name] : '';
    $html .= '</textarea>';
    if (in_array('required', $attributes)) $html .= '<span class="form-required">*</span>';
    $html .= error_list($errors, $name);

    return $html;
}

/**
 * Display a input field
 *
 * @param  string  $type        HMTL input tag type
 * @param  string  $name        Field name
 * @param  array   $values      Form values
 * @param  array   $errors      Form errors
 * @param  array   $attributes  HTML attributes
 * @param  string  $class       CSS class
 * @return string
 */
function form_input($type, $name, $values = array(), array $errors = array(), array $attributes = array(), $class = '')
{
    $class .= error_class($errors, $name);

    $html = '<input type="'.$type.'" name="'.$name.'" id="form-'.$name.'" '.form_value($values, $name).' class="'.$class.'" ';
    $html .= implode(' ', $attributes).'/>';
    if (in_array('required', $attributes)) $html .= '<span class="form-required">*</span>';
    $html .= error_list($errors, $name);

    return $html;
}

/**
 * Display a text field
 *
 * @param  string  $name        Field name
 * @param  array   $values      Form values
 * @param  array   $errors      Form errors
 * @param  array   $attributes  HTML attributes
 * @param  string  $class       CSS class
 * @return string
 */
function form_text($name, $values = array(), array $errors = array(), array $attributes = array(), $class = '')
{
    return form_input('text', $name, $values, $errors, $attributes, $class);
}

/**
 * Display a password field
 *
 * @param  string  $name        Field name
 * @param  array   $values      Form values
 * @param  array   $errors      Form errors
 * @param  array   $attributes  HTML attributes
 * @param  string  $class       CSS class
 * @return string
 */
function form_password($name, $values = array(), array $errors = array(), array $attributes = array(), $class = '')
{
    return form_input('password', $name, $values, $errors, $attributes, $class);
}

/**
 * Display an email field
 *
 * @param  string  $name        Field name
 * @param  array   $values      Form values
 * @param  array   $errors      Form errors
 * @param  array   $attributes  HTML attributes
 * @param  string  $class       CSS class
 * @return string
 */
function form_email($name, $values = array(), array $errors = array(), array $attributes = array(), $class = '')
{
    return form_input('email', $name, $values, $errors, $attributes, $class);
}

/**
 * Display a date field
 *
 * @param  string  $name        Field name
 * @param  array   $values      Form values
 * @param  array   $errors      Form errors
 * @param  array   $attributes  HTML attributes
 * @param  string  $class       CSS class
 * @return string
 */
function form_date($name, $values = array(), array $errors = array(), array $attributes = array(), $class = '')
{
    return form_input('date', $name, $values, $errors, $attributes, $class);
}

/**
 * Display a number field
 *
 * @param  string  $name        Field name
 * @param  array   $values      Form values
 * @param  array   $errors      Form errors
 * @param  array   $attributes  HTML attributes
 * @param  string  $class       CSS class
 * @return string
 */
function form_number($name, $values = array(), array $errors = array(), array $attributes = array(), $class = '')
{
    return form_input('number', $name, $values, $errors, $attributes, $class);
}

/**
 * Display a numeric field (allow decimal number)
 *
 * @param  string  $name        Field name
 * @param  array   $values      Form values
 * @param  array   $errors      Form errors
 * @param  array   $attributes  HTML attributes
 * @param  string  $class       CSS class
 * @return string
 */
function form_numeric($name, $values = array(), array $errors = array(), array $attributes = array(), $class = '')
{
    return form_input('text', $name, $values, $errors, $attributes, $class.' form-numeric');
}

/**
 * Link
 *
 * a('link', 'task', 'show', array('task_id' => $task_id))
 *
 * @param  string   $label       Link label
 * @param  string   $controller  Controller name
 * @param  string   $action      Action name
 * @param  array    $params      Url parameters
 * @param  boolean  $csrf        Add a CSRF token
 * @param  string   $class       CSS class attribute
 * @return string
 */
function a($label, $controller, $action, array $params = array(), $csrf = false, $class = '')
{
    return '<a href="'.u($controller, $action, $params, $csrf).'" class="'.$class.'"/>'.$label.'</a>';
}

/**
 * URL query string
 *
 * u('task', 'show', array('task_id' => $task_id))
 *
 * @param  string   $controller  Controller name
 * @param  string   $action      Action name
 * @param  array    $params      Url parameters
 * @param  boolean  $csrf        Add a CSRF token
 * @return string
 */
function u($controller, $action, array $params = array(), $csrf = false)
{
    $html = '?controller='.$controller.'&amp;action='.$action;

    if ($csrf) {
        $params['csrf_token'] = Security::getCSRFToken();
    }

    foreach ($params as $key => $value) {
        $html .= '&amp;'.$key.'='.$value;
    }

    return $html;
}

/**
 * Pagination links
 *
 * @param  array    $pagination    Pagination information
 * @return string
 */
function paginate(array $pagination)
{
    extract($pagination);

    $html = '<div id="pagination">';
    $html .= '<span id="pagination-previous">';

    if ($pagination['offset'] > 0) {
        $offset = $pagination['offset'] - $limit;
        $html .= a('&larr; '.t('Previous'), $controller, $action, $params + compact('offset', 'order', 'direction'));
    }
    else {
        $html .= '&larr; '.t('Previous');
    }

    $html .= '</span>';
    $html .= '<span id="pagination-next">';

    if (($total - $pagination['offset']) > $limit) {
        $offset = $pagination['offset'] + $limit;
        $html .= a(t('Next').' &rarr;', $controller, $action, $params + compact('offset', 'order', 'direction'));
    }
    else {
        $html .= t('Next').' &rarr;';
    }

    $html .= '</span>';
    $html .= '</div>';

    return $html;
}

/**
 * Column sorting (work with pagination)
 *
 * @param  string   $label         Column title
 * @param  string   $column        SQL column name
 * @param  array    $pagination    Pagination information
 * @return string
 */
function order($label, $column, array $pagination)
{
    extract($pagination);

    $prefix = '';

    if ($order === $column) {
        $prefix = $direction === 'DESC' ? '&#9660; ' : '&#9650; ';
        $direction = $direction === 'DESC' ? 'ASC' : 'DESC';
    }

    $order = $column;

    return $prefix.a($label, $controller, $action, $params + compact('offset', 'order', 'direction'));
}