Overview
Comment: | Documentation et lecture simple des fichiers non-PHP plutôt qu'inclusion |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA1: |
9577053997ca390083fee3c1e079a190 |
User & Date: | bohwaz on 2014-03-20 20:06:19 |
Other Links: | manifest | tags |
Context
2014-03-21
| ||
03:43 | Mise en avant des numéros dans les listes check-in: 84fea36049 user: bohwaz tags: trunk | |
2014-03-20
| ||
20:06 | Documentation et lecture simple des fichiers non-PHP plutôt qu'inclusion check-in: 9577053997 user: bohwaz tags: trunk | |
19:39 | Suppression de plugin + vérifications check-in: 1cb7db96ca user: bohwaz tags: trunk | |
Changes
Modified src/include/class.plugin.php from [f5203581aa] to [d045d686cc].
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 | <?php namespace Garradin; class Plugin { protected $id = null; protected $plugin = null; public function __construct($id) { $db = DB::getInstance(); $this->plugin = $db->simpleQuerySingle('SELECT * FROM plugins WHERE id = ?;', true, $id); if (!$this->plugin) { throw new UserException('Ce plugin n\'existe pas ou n\'est pas installé correctement.'); } $this->plugin['config'] = json_decode($this->plugin['config'], true); if (!is_array($this->plugin['config'])) { $this->plugin['config'] = []; } $this->id = $id; } public function getConfig($key = null) { if (is_null($key)) { return $this->plugin['config']; } if (array_key_exists($key, $this->plugin['config'])) { return $this->plugin['config'][$key]; } return null; } public function setConfig($key, $value = null) { if (is_null($value)) { unset($this->plugin['config'][$key]); } else { $this->plugin['config'][$key] = $value; } $db = DB::getInstance(); $db->simpleUpdate('plugins', ['config' => json_encode($this->plugin['config'])], 'id = \'' . $this->id . '\''); return true; } public function getInfos($key = null) { if (is_null($key)) { return $this->plugin; } if (array_key_exists($key, $this->plugin)) { return $this->plugin[$key]; } return null; } public function id() { return $this->id; } public function call($file) { $forbidden = ['install.php', 'garradin_plugin.ini', 'upgrade.php', 'uninstall.php', 'signals.php']; if (in_array($file, $forbidden)) { throw new UserException('Le fichier ' . $file . ' ne peut être appelé par cette méthode.'); } if (!file_exists('phar://' . PLUGINS_PATH . '/' . $this->id . '.phar/' . $file)) { throw new UserException('Le fichier ' . $file . ' n\'existe pas dans le plugin ' . $this->id); } $plugin = $this; global $tpl, $config, $user, $membres; | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 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 | <?php namespace Garradin; class Plugin { protected $id = null; protected $plugin = null; protected $mimes = [ 'css' => 'text/css', 'gif' => 'image/gif', 'htm' => 'text/html', 'html' => 'text/html', 'ico' => 'image/x-ico', 'jpe' => 'image/jpeg', 'jpg' => 'image/jpeg', 'jpeg' => 'image/jpeg', 'js' => 'application/x-javascript', 'pdf' => 'application/pdf', 'png' => 'image/png', 'swf' => 'application/shockwave-flash', 'xml' => 'text/xml', 'svg' => 'image/svg+xml', ]; /** * Construire un objet Plugin pour un plugin * @param string $id Identifiant du plugin * @throws UserException Si le plugin n'est pas installé (n'existe pas en DB) */ public function __construct($id) { $db = DB::getInstance(); $this->plugin = $db->simpleQuerySingle('SELECT * FROM plugins WHERE id = ?;', true, $id); if (!$this->plugin) { throw new UserException('Ce plugin n\'existe pas ou n\'est pas installé correctement.'); } $this->plugin['config'] = json_decode($this->plugin['config'], true); if (!is_array($this->plugin['config'])) { $this->plugin['config'] = []; } $this->id = $id; } /** * Renvoie une entrée de la configuration ou la configuration complète * @param string $key Clé à rechercher, ou NULL si on désire toutes les entrées de la * @return mixed L'entrée demandée (mixed), ou l'intégralité de la config (array), * ou NULL si l'entrée demandée n'existe pas. */ public function getConfig($key = null) { if (is_null($key)) { return $this->plugin['config']; } if (array_key_exists($key, $this->plugin['config'])) { return $this->plugin['config'][$key]; } return null; } /** * Enregistre une entrée dans la configuration du plugin * @param string $key Clé à modifier * @param mixed $value Valeur à enregistrer, choisir NULL pour effacer cette clé de la configuration * @return boolean TRUE si tout se passe bien */ public function setConfig($key, $value = null) { if (is_null($value)) { unset($this->plugin['config'][$key]); } else { $this->plugin['config'][$key] = $value; } $db = DB::getInstance(); $db->simpleUpdate('plugins', ['config' => json_encode($this->plugin['config'])], 'id = \'' . $this->id . '\''); return true; } /** * Renvoie une information ou toutes les informations sur le plugin * @param string $key Clé de l'info à retourner, ou NULL pour recevoir toutes les infos * @return mixed Info demandée ou tableau des infos. */ public function getInfos($key = null) { if (is_null($key)) { return $this->plugin; } if (array_key_exists($key, $this->plugin)) { return $this->plugin[$key]; } return null; } /** * Renvoie l'identifiant du plugin * @return string Identifiant du plugin */ public function id() { return $this->id; } /** * Inclure un fichier depuis le plugin (dynamique ou statique) * @param string $file Chemin du fichier à aller chercher : si c'est un .php il sera inclus, * sinon il sera juste affiché * @return void * @throws UserException Si le fichier n'existe pas ou fait partie des fichiers qui ne peuvent * être appelés que par des méthodes de Plugin. * @throws RuntimeException Si le chemin indiqué tente de sortir du contexte du PHAR */ public function call($file) { $file = preg_replace('!^[./]*!', '', $file); if (preg_match('!(?:\.\.|[/\\]\.|\.[/\\])!', $file)) { throw new \RuntimeException('Chemin de fichier incorrect.'); } $forbidden = ['install.php', 'garradin_plugin.ini', 'upgrade.php', 'uninstall.php', 'signals.php']; if (in_array($file, $forbidden)) { throw new UserException('Le fichier ' . $file . ' ne peut être appelé par cette méthode.'); } if (!file_exists('phar://' . PLUGINS_PATH . '/' . $this->id . '.phar/' . $file)) { throw new UserException('Le fichier ' . $file . ' n\'existe pas dans le plugin ' . $this->id); } $plugin = $this; global $tpl, $config, $user, $membres; if (substr($file, -4) === '.php') { include 'phar://' . PLUGINS_PATH . '/' . $this->id . '.phar/' . $file; } else { // Récupération du type MIME à partir de l'extension $ext = substr($file, strrpos($file, '.')+1); if (isset($this->mimes[$ext])) { $mime = $this->mimes[$ext]; } else { $mime = 'text/plain'; } header('Content-Type: ' .$this->mimes[$ext]); header('Content-Length: ' . filesize('phar://' . PLUGINS_PATH . '/' . $this->id . '.phar/' . $file)); readfile('phar://' . PLUGINS_PATH . '/' . $this->id . '.phar/' . $file); } } /** * Désinstaller le plugin * @return boolean TRUE si la suppression a fonctionné */ public function uninstall() { if (file_exists('phar://' . PLUGINS_PATH . '/' . $this->id . '.phar/uninstall.php')) { include 'phar://' . PLUGINS_PATH . '/' . $this->id . '.phar/uninstall.php'; } unlink(PLUGINS_PATH . '/' . $this->id . '.phar'); $db = DB::getInstance(); return $db->simpleExec('DELETE FROM plugins WHERE id = ?;', $this->id); } /** * Renvoie TRUE si le plugin a besoin d'être mis à jour * (si la version notée dans la DB est différente de la version notée dans garradin_plugin.ini) * @return boolean TRUE si le plugin doit être mis à jour, FALSE sinon */ public function needUpgrade() { $infos = parse_ini_file('phar://' . PLUGINS_PATH . '/' . $this->id . '.phar/garradin_plugin.ini', false); if (version_compare($this->plugin['version'], $infos['version'], '!=')) return true; return false; } /** * Mettre à jour le plugin * Appelle le fichier upgrade.php dans l'archive si celui-ci existe. * @return boolean TRUE si tout a fonctionné */ public function upgrade() { if (file_exists('phar://' . PLUGINS_PATH . '/' . $this->id . '.phar/upgrade.php')) { include 'phar://' . PLUGINS_PATH . '/' . $this->id . '.phar/upgrade.php'; } $db = DB::getInstance(); return $db->simpleUpdate('plugins', 'id = \''.$db->escapeString($this->id).'\'', ['version' => $infos['version']]); } /** * Liste des plugins installés (en DB) * @return array Liste des plugins triés par nom */ static public function listInstalled() { $db = DB::getInstance(); return $db->simpleStatementFetchAssocKey('SELECT id, * FROM plugins ORDER BY nom;'); } /** * Liste les plugins qui doivent être affichés dans le menu * @return array Tableau associatif id => nom (ou un tableau vide si aucun plugin ne doit être affiché) */ static public function listMenu() { $db = DB::getInstance(); return $db->simpleStatementFetchAssoc('SELECT id, nom FROM plugins WHERE menu = 1 ORDER BY nom;'); } /** * Liste les plugins téléchargés mais non installés * @return array Liste des plugins téléchargés */ static public function listDownloaded() { $installed = self::listInstalled(); $list = []; $dir = dir(PLUGINS_PATH); |
︙ | ︙ | |||
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | } $dir->close(); return $list; } static public function listOfficial() { if (Static_Cache::expired('plugins_list', 3600 * 24)) { $url = parse_url(PLUGINS_URL); $context_options = [ 'ssl' => [ 'verify_peer' => TRUE, 'cafile' => ROOT . '/include/data/cacert.pem', 'verify_depth' => 5, 'CN_match' => $url['host'], ] ]; $context = stream_context_create($context_options); | > > > > > > | 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 | } $dir->close(); return $list; } /** * Liste des plugins officiels depuis le repository signé * @return array Liste des plugins */ static public function listOfficial() { // La liste est stockée en cache une heure pour ne pas tuer le serveur distant if (Static_Cache::expired('plugins_list', 3600 * 24)) { $url = parse_url(PLUGINS_URL); $context_options = [ 'ssl' => [ 'verify_peer' => TRUE, // On vérifie en utilisant le certificat maître de CACert 'cafile' => ROOT . '/include/data/cacert.pem', 'verify_depth' => 5, 'CN_match' => $url['host'], ] ]; $context = stream_context_create($context_options); |
︙ | ︙ | |||
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 | $result = Static_Cache::get('plugins_list'); } $list = json_decode($result, true); return $list; } static public function checkHash($id) { $list = self::fetchOfficialList(); if (!array_key_exists($id, $list)) return null; $hash = sha1_file(PLUGINS_PATH . '/' . $id . '.phar'); return ($hash === $list[$id]['hash']); } static public function isOfficial($id) { $list = self::fetchOfficialList(); return array_key_exists($id, $list); } static public function download($id) { $list = self::fetchOfficialList(); if (!array_key_exists($id, $list)) { throw new \LogicException($id . ' n\'est pas un plugin officiel (absent de la liste)'); | > > > > > > > > > > > > > > > > > > | 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 | $result = Static_Cache::get('plugins_list'); } $list = json_decode($result, true); return $list; } /** * Vérifier le hash du plugin $id pour voir s'il correspond au hash du fichier téléchargés * @param string $id Identifiant du plugin * @return boolean TRUE si le hash correspond (intégrité OK), sinon FALSE */ static public function checkHash($id) { $list = self::fetchOfficialList(); if (!array_key_exists($id, $list)) return null; $hash = sha1_file(PLUGINS_PATH . '/' . $id . '.phar'); return ($hash === $list[$id]['hash']); } /** * Est-ce que le plugin est officiel ? * @param string $id Identifiant du plugin * @return boolean TRUE si le plugin est officiel, FALSE sinon */ static public function isOfficial($id) { $list = self::fetchOfficialList(); return array_key_exists($id, $list); } /** * Télécharge un plugin depuis le repository officiel, et l'installe * @param string $id Identifiant du plugin * @return boolean TRUE si ça marche * @throws LogicException Si le plugin n'est pas dans la liste des plugins officiels * @throws UserException Si le plugin est déjà installé ou que le téléchargement a échoué * @throws RuntimeException Si l'archive téléchargée est corrompue (intégrité du hash ne correspond pas) */ static public function download($id) { $list = self::fetchOfficialList(); if (!array_key_exists($id, $list)) { throw new \LogicException($id . ' n\'est pas un plugin officiel (absent de la liste)'); |
︙ | ︙ | |||
271 272 273 274 275 276 277 | } self::install($id, true); return true; } | > > > > > > | < < < < < | 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 | } self::install($id, true); return true; } /** * Installer un plugin * @param string $id Identifiant du plugin * @param boolean $official TRUE si le plugin est officiel * @return boolean TRUE si tout a fonctionné */ static public function install($id, $official = false) { if (!file_exists('phar://' . PLUGINS_PATH . '/' . $id . '.phar')) { throw new \RuntimeException('Le plugin ' . $id . ' ne semble pas exister et ne peut donc être installé.'); } if (!file_exists('phar://' . PLUGINS_PATH . '/' . $id . '.phar/garradin_plugin.ini')) { throw new UserException('L\'archive '.$id.'.phar n\'est pas une extension Garradin : fichier garradin_plugin.ini manquant.'); } if (!file_exists('phar://' . PLUGINS_PATH . '/' . $id . '.phar/index.php')) { |
︙ | ︙ |