Skip to content
GitLab
Switch branch/tag
Find file Normal viewHistoryPermalink
Utils.php 7.39 KB
Newer Older
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
1
2
3
4
5
6
7 
<?php
/**
 * This software is governed by the CeCILL-B license. If a copy of this license
 * is not distributed with this file, you can obtain one at
 * http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.txt
 *
 * Authors of STUdS (initial project): Guilhem BORGHESI (borghesi@unistra.fr) and Raphaël DROZ
Olivier Perez's avatar
Merge branch 'bugfix/typo-in-comment-header' into 'develop'    
Olivier Perez committed
8 
 * Authors of Framadate/OpenSondage: Framasoft (https://github.com/framasoft)
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
9
10
11
12
13
14
15
16
17
18
19
20 
 *
 * =============================
 *
 * Ce logiciel est régi par la licence CeCILL-B. Si une copie de cette licence
 * ne se trouve pas avec ce fichier vous pouvez l'obtenir sur
 * http://www.cecill.info/licences/Licence_CeCILL-B_V1-fr.txt
 *
 * Auteurs de STUdS (projet initial) : Guilhem BORGHESI (borghesi@unistra.fr) et Raphaël DROZ
 * Auteurs de Framadate/OpenSondage : Framasoft (https://github.com/framasoft)
 */
namespace Framadate;
Thomas Citharel's avatar
Merge branch 'develop'    
Thomas Citharel committed
21
22 
use Parsedown;
Olivier PEREZ's avatar
Parse markdown on classic votes    
Olivier PEREZ committed
23 
class Utils {
FramaJosephK's avatar
Retouches après série de merges    
FramaJosephK committed
24
25
26 
    /**
     * @return string Server name
     */
Olivier PEREZ's avatar
Parse markdown on classic votes    
Olivier PEREZ committed
27 
    public static function get_server_name() {
Imre Jonk's avatar
Set URLs to https if HTTP X-Forwarded-Proto=https    
Imre Jonk committed
28 
        $scheme = ((isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'on') || (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] === 'https')) ? 'https' : 'http';
Luc Didry's avatar
Fix $_SERVER['SERVER_PORT'] handling    
Luc Didry committed
29 
        $port = in_array($_SERVER['SERVER_PORT'], ['80', '443'], true) ? '' : ':' . $_SERVER['SERVER_PORT'];
Olivier PEREZ's avatar
Refactoring some code:    
Olivier PEREZ committed
30
31 
        $dirname = dirname($_SERVER['SCRIPT_NAME']);
        $dirname = $dirname === '\\' ? '/' : $dirname . '/';
Olivier PEREZ's avatar
Fix pb when host on domain name starting with 'admin'    
Olivier PEREZ committed
32 
        $dirname = str_replace('/admin', '', $dirname);
Olivier PEREZ's avatar
Remove '/action' when calculating server URL    
Olivier PEREZ committed
33 
        $dirname = str_replace('/action', '', $dirname);
Olivier PEREZ's avatar
Host can now force URL, used behind a reverse-proxy    
Olivier PEREZ committed
34 
        $server_name = (defined('APP_URL') ? APP_URL : $_SERVER['SERVER_NAME']) . $port . $dirname;
Olivier PEREZ's avatar
Parse markdown on classic votes    
Olivier PEREZ committed
35
Olivier PEREZ's avatar
Fix usage of markdown    
Olivier PEREZ committed
36 
        return $scheme . '://' . preg_replace('#//+#', '/', $server_name);
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
37
38 
    }
Olivier PEREZ's avatar
Move mail sending to class \Framadate\Service\MailService    
Olivier PEREZ committed
39
40
41
42 
    /**
     * @param string $title
     * @deprecated
     */
Olivier PEREZ's avatar
Parse markdown on classic votes    
Olivier PEREZ committed
43 
    public static function print_header($title = '') {
Olivier PEREZ's avatar
Replace $html_lang by $locale    
Olivier PEREZ committed
44 
        global $locale;
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
45
46 

        echo '<!DOCTYPE html>
Olivier PEREZ's avatar
Replace $html_lang by $locale    
Olivier PEREZ committed
47 
    <html lang="' . $locale . '">
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
48 
    <head>
Spanti Nicola (RyDroid)'s avatar
Minor modifications to Utils.php    
Spanti Nicola (RyDroid) committed
49 
        <meta charset="utf-8" />';
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
50
Olivier PEREZ's avatar
Parse markdown on classic votes    
Olivier PEREZ committed
51 
        if (!empty($title)) {
Spanti Nicola (RyDroid)'s avatar
Minor modifications to Utils.php    
Spanti Nicola (RyDroid) committed
52
53
54 
            echo '<title>' . stripslashes($title) . ' - ' . NOMAPPLICATION . '</title>';
        } else {
            echo '<title>' . NOMAPPLICATION . '</title>';
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
55
56
57 
        }

        echo '
Spanti Nicola (RyDroid)'s avatar
Minor modifications to Utils.php    
Spanti Nicola (RyDroid) committed
58
59
60
61
62 
        <link rel="stylesheet" href="' . self::get_server_name() . 'css/bootstrap.min.css" />
        <link rel="stylesheet" href="' . self::get_server_name() . 'css/datepicker3.css" />
        <link rel="stylesheet" href="' . self::get_server_name() . 'css/style.css" />
        <link rel="stylesheet" href="' . self::get_server_name() . 'css/frama.css" />
        <link rel="stylesheet" href="' . self::get_server_name() . 'css/print.css" media="print" />
Thomas Citharel's avatar
update jquery    
Thomas Citharel committed
63 
        <script type="text/javascript" src="' . self::get_server_name() . 'js/jquery-1.12.4.min.js"></script>
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
64 
        <script type="text/javascript" src="' . self::get_server_name() . 'js/bootstrap.min.js"></script>
Markus Jung's avatar
Avoid warnings due to non-existant 'en' datepicker locale    
Markus Jung committed
65 
        <script type="text/javascript" src="' . self::get_server_name() . 'js/bootstrap-datepicker.js"></script>';
Thomas Citharel's avatar
Run php-cs-fixer with a custom config. This may break a lot of things    
Thomas Citharel committed
66 
        if ('en' !== $locale) {
Markus Jung's avatar
Avoid warnings due to non-existant 'en' datepicker locale    
Markus Jung committed
67
68
69
70 
        	   echo '
        <script type="text/javascript" src="' . self::get_server_name() . 'js/locales/bootstrap-datepicker.' . $locale . '.js"></script>';
        }
        echo '
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
71 
        <script type="text/javascript" src="' . self::get_server_name() . 'js/core.js"></script>';
Olivier PEREZ's avatar
Install: Redirections between Install and Index    
Olivier PEREZ committed
72 
        if (is_file($_SERVER['DOCUMENT_ROOT'] . "/nav/nav.js")) {
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
73
74
75
76
77
78 
            echo '<script src="/nav/nav.js" id="nav_js" type="text/javascript" charset="utf-8"></script><!-- /Framanav -->';
        }

        echo '
    </head>
    <body>
FramaJosephK's avatar
The big one    
FramaJosephK committed
79 
    <div class="container ombre">';
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
80
81
82 
    }

    /**
Antonin's avatar
Editing vote by link with unique id    
Antonin committed
83
84
85
86 
     * Function allowing to generate poll's url
     * @param   string $id The poll's id
     * @param   bool $admin True to generate an admin URL, false for a public one
     * @param   string $vote_id (optional) The vote's unique id
Thomas Citharel's avatar
Fix URL Routing for actions    
Thomas Citharel committed
87
88 
     * @param null $action
     * @param null $action_value
Antonin's avatar
Editing vote by link with unique id    
Antonin committed
89 
     * @return  string The poll's URL.
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
90 
     */
Antonin's avatar
Merge remote-tracking branch 'upstream/develop' into develop    
Antonin committed
91 
    public static function getUrlSondage($id, $admin = false, $vote_id = '', $action = null, $action_value = null) {
Olivier PEREZ's avatar
Move URL encore to Utils::getUrlSondage    
Olivier PEREZ committed
92 
        // URL-Encode $action_value
Thomas Citharel's avatar
Fix URL Routing for actions    
Thomas Citharel committed
93 
        $action_value = $action_value ? Utils::base64url_encode($action_value) : null;
Olivier PEREZ's avatar
Move URL encore to Utils::getUrlSondage    
Olivier PEREZ committed
94
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
95
96 
        if (URL_PROPRE) {
            if ($admin === true) {
Olivier PEREZ's avatar
Don't redirect to studs when you edit a vote from adminstuds    
Olivier PEREZ committed
97 
                $url = self::get_server_name() . $id . '/admin';
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
98 
            } else {
Olivier PEREZ's avatar
Fix usage of markdown    
Olivier PEREZ committed
99 
                $url = self::get_server_name() . $id;
Olivier PEREZ's avatar
Don't redirect to studs when you edit a vote from adminstuds    
Olivier PEREZ committed
100 
            }
Thomas Citharel's avatar
Run php-cs-fixer with a custom config. This may break a lot of things    
Thomas Citharel committed
101 
            if ($vote_id !== '') {
Olivier PEREZ's avatar
Fix usage of markdown    
Olivier PEREZ committed
102 
                $url .= '/vote/' . $vote_id . "#edit";
Thomas Citharel's avatar
Fix generating URL issue with type check    
Thomas Citharel committed
103
104 
            } elseif ($action) {
                if ($action_value) {
Olivier PEREZ's avatar
Encode action values in base64 instead of url_encode (because of UrlRewrite)    
Olivier PEREZ committed
105
106
107
108 
                    $url .= '/action/' . $action . '/' . $action_value;
                } else {
                    $url .= '/action/' . $action;
                }
Antonin's avatar
Changing some actions from POST to GET.    
Antonin committed
109 
            }
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
110
111 
        } else {
            if ($admin === true) {
Olivier PEREZ's avatar
Don't redirect to studs when you edit a vote from adminstuds    
Olivier PEREZ committed
112 
                $url = self::get_server_name() . 'adminstuds.php?poll=' . $id;
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
113 
            } else {
Olivier PEREZ's avatar
Don't redirect to studs when you edit a vote from adminstuds    
Olivier PEREZ committed
114
115 
                $url = self::get_server_name() . 'studs.php?poll=' . $id;
            }
Thomas Citharel's avatar
Run php-cs-fixer with a custom config. This may break a lot of things    
Thomas Citharel committed
116 
            if ($vote_id !== '') {
Olivier PEREZ's avatar
Fix usage of markdown    
Olivier PEREZ committed
117 
                $url .= '&vote=' . $vote_id . "#edit";
Thomas Citharel's avatar
Run php-cs-fixer with a custom config. This may break a lot of things    
Thomas Citharel committed
118
119 
            } elseif ($action !== null)  {
                if ($action_value !== null) {
Olivier PEREZ's avatar
Encode action values in base64 instead of url_encode (because of UrlRewrite)    
Olivier PEREZ committed
120
121
122
123 
                    $url .= '&' . $action . "=" . $action_value;
                } else {
                    $url .= '&' . $action . "=";
                }
Antonin's avatar
Changing some actions from POST to GET.    
Antonin committed
124 
            }
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
125
126
127
128
129 
        }

        return $url;
    }
Olivier PEREZ's avatar
Remove old code + Add doc    
Olivier PEREZ committed
130
131 
    /**
     * This method pretty prints an object to the page framed by pre tags.
Olivier PEREZ's avatar
Parse markdown on classic votes    
Olivier PEREZ committed
132 
     *
Olivier PEREZ's avatar
admin: Add availability to add a slot to a poll    
Olivier PEREZ committed
133 
     * @param mixed $object The object to print.
Olivier PEREZ's avatar
Remove old code + Add doc    
Olivier PEREZ committed
134 
     */
Olivier PEREZ's avatar
Move mail sending to class \Framadate\Service\MailService    
Olivier PEREZ committed
135 
    public static function debug($object) {
Olivier PEREZ's avatar
Refactor on choix_autre.php    
Olivier PEREZ committed
136
137
138
139 
        echo '<pre>';
        print_r($object);
        echo '</pre>';
    }
Olivier PEREZ's avatar
Define a prefix for database table names.    
Olivier PEREZ committed
140
141
142
143 

    public static function table($tableName) {
        return TABLENAME_PREFIX . $tableName;
    }
Olivier PEREZ's avatar
Parse markdown on classic votes    
Olivier PEREZ committed
144
Antonin's avatar
Markdown pour la description    
Antonin committed
145 
    public static function markdown($md, $clear=false, $line=true) {
Thomas Citharel's avatar
Merge branch 'develop'    
Thomas Citharel committed
146 
        $parseDown = new Parsedown();
Olivier PEREZ's avatar
Parse markdown on classic votes    
Olivier PEREZ committed
147
Antonin's avatar
Markdown pour la description    
Antonin committed
148 
        $parseDown
Antonin's avatar
Using the library    
Antonin committed
149 
            ->setMarkupEscaped(true)
Antonin's avatar
Markdown pour la description    
Antonin committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163 
            ->setBreaksEnabled(true)
            ->setUrlsLinked(false);

        if ($line) {
            $html  = $parseDown->line($md);
        } else {
            $md = preg_replace_callback(
                '#( ){2,}#',
                function ($m) {
                    return str_repeat('&nbsp;', strlen($m[0]));
                },
                $md
            );
            $html  = $parseDown->text($md);
Olivier PEREZ's avatar
Parse markdown on classic votes    
Olivier PEREZ committed
164
165 
        }
Antonin's avatar
Using the library    
Antonin committed
166 
        $text = strip_tags($html);
Olivier PEREZ's avatar
Parse markdown on classic votes    
Olivier PEREZ committed
167
Olivier PEREZ's avatar
CSV Export: Implements export for classical polls    
Olivier PEREZ committed
168
169
170 
        return $clear ? $text : $html;
    }
Olivier PEREZ's avatar
Improve management of errors in infos_sondage page    
Olivier PEREZ committed
171
172
173
174 
    public static function htmlEscape($html) {
        return htmlentities($html, ENT_HTML5 | ENT_QUOTES);
    }
Antonin's avatar
Adapting html escape for emails    
Antonin committed
175 
    public static function htmlMailEscape($html) {
Antonin's avatar
Removing useless UTF-8 specification    
Antonin committed
176 
        return htmlspecialchars($html, ENT_HTML5 | ENT_QUOTES);
Antonin's avatar
Adapting html escape for emails    
Antonin committed
177
178 
    }
Olivier PEREZ's avatar
CSV Export: Implements export for classical polls    
Olivier PEREZ committed
179
180
181
182 
    public static function csvEscape($text) {
        $escaped = str_replace('"', '""', $text);
        $escaped = str_replace("\r\n", '', $escaped);
        $escaped = str_replace("\n", '', $escaped);
framartin's avatar
Sanitize names to avoid Formula Injections on CSV export    
framartin committed
183 
        $escaped = preg_replace("/^(=|\+|\-|\@)/", "'$1", $escaped);
Olivier PEREZ's avatar
CSV Export: Implements export for classical polls    
Olivier PEREZ committed
184
185
186
187
188
189
190
191
192 

        return '"' . $escaped . '"';
    }

    public static function cleanFilename($title) {
        $cleaned = preg_replace('[^a-zA-Z0-9._-]', '_', $title);
        $cleaned = preg_replace(' {2,}', ' ', $cleaned);

        return $cleaned;
Olivier PEREZ's avatar
Parse markdown on classic votes    
Olivier PEREZ committed
193 
    }
Olivier PEREZ's avatar
Smartysize infos_creation, and rename it to create_poll    
Olivier PEREZ committed
194
Olivier Perez's avatar
Fix back links to create_poll.php + Use values in session if _post is not present    
Olivier Perez committed
195 
    public static function fromPostOrDefault($postKey, $default = '') {
Antonin's avatar
Removing php escape and completing template ones.    
Antonin committed
196 
        return !empty($_POST[$postKey]) ? $_POST[$postKey] : $default;
Olivier PEREZ's avatar
Smartysize infos_creation, and rename it to create_poll    
Olivier PEREZ committed
197 
    }
Olivier PEREZ's avatar
Encode action values in base64 instead of url_encode (because of UrlRewrite)    
Olivier PEREZ committed
198
199
200
201
202
203 

    public static function base64url_encode($input) {
        return rtrim(strtr(base64_encode($input), '+/', '-_'), '=');
    }

    public static function base64url_decode($input) {
Thomas Citharel's avatar
Run php-cs-fixer with a custom config. This may break a lot of things    
Thomas Citharel committed
204 
        return base64_decode(str_pad(strtr($input, '-_', '+/'), strlen($input) % 4, '=', STR_PAD_RIGHT), true);
Olivier PEREZ's avatar
Encode action values in base64 instead of url_encode (because of UrlRewrite)    
Olivier PEREZ committed
205 
    }
FramaJosephK's avatar
Mise à jour du dépôt avec la dernière version sur Github  
FramaJosephK committed
206 
}