summaryrefslogtreecommitdiffstats
path: root/app/helpers.php
blob: 8765fc63d5b1cbca9cb875fbc85ab88935fd87e5 (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
<?php

/**
 * Register polyfills for old PHP versions.
 * 
 * This way, the real function will only be called if it
 * is available, and we won't force the use of our own 
 * implementation.
 */
function register_polyfills()
{
    if (!function_exists('hash_equals')) {
        function hash_equals($known_string, $user_string) {
            call_user_func_array('_hash_equals', func_get_args());
        }
    }
}

register_polyfills();

/**
 * Path to the _custom_ directory.
 *
 * @param  string $file Append this filename to the returned path.
 * @return string
 */
function custom_path($file = '')
{
    return __DIR__.'/../custom' . (!empty($file) ? '/'.$file : '');
}

/**
 * Path to the _views_ directory.
 *
 * @param  string $file Append this filename to the returned path.
 * @return string
 */
function views_path($file = '')
{
    return custom_path('views/install.tpl.php');
}

/**
 * Path to the _admin_ directory.
 *
 * @param  string $file Append this filename to the returned path.
 * @return string
 */
function admin_path($file = '')
{
    return __DIR__.'/../admin' . (!empty($file) ? '/'.$file : '');
}

/**
 * Is moonmoon installed?
 *
 * @return bool
 */
function is_installed()
{
    return file_exists(custom_path('config.yml')) && file_exists(custom_path('people.opml'));
}

/**
 * Shortcut to Simplel10n::getString().
 *
 * @param  string $str
 * @param  string $comment
 * @return string
 */
function _g($str, $comment='')
{
    return Simplel10n::getString($str, $comment);
}

/**
 * Reset the moonmoon instance.
 */
function removeCustomFiles()
{
    $toRemove = [
        custom_path('config.yml'),
        custom_path('people.opml'),
        custom_path('people.opml.bak'),
        custom_path('cache')
    ];

    foreach ($toRemove as $path) {
        if (file_exists($path)) {
            unlink($path);
        }
    }
}

/**
 * Compare two strings in a constant-time manner.
 *
 * It returns `true` if both strings are exactly the same
 * (same size and same value).
 *
 * @param  string $known_string
 * @param  string $user_string
 * @return bool
 */
function _hash_equals($known_string = '', $user_string = '')
{
    // In our case, it's not problematic if `$known_string`'s 
    // size leaks, we will only compare password hashes and 
    // CSRF tokens—their size is already somehow public.
    if (!is_string($known_string) || !is_string($user_string) 
         || strlen($known_string) !== strlen($user_string)) {
        return false;
    }

    $ret = 0;    

    // Do not stop the comparison when a difference is found,
    // always completely compare them.
    for ($i = 0; $i < strlen($known_string); $i++) {
        $ret |=  (ord($known_string[$i]) ^ ord($user_string[$i]));
    }   

    return !$ret;
}