Overview
Comment: | Modernisation de Plugin.php |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | dev |
Files: | files | file ages | folders |
SHA1: |
7fb77dba15c62957564c2d9943cedfa4 |
User & Date: | bohwaz on 2017-05-03 07:24:41 |
Other Links: | branch diff | manifest | tags |
Context
2017-05-04
| ||
07:37 | Vérification de signature à l'import de DB check-in: 4066ce8971 user: bohwaz tags: dev | |
2017-05-03
| ||
07:24 | Modernisation de Plugin.php check-in: 7fb77dba15 user: bohwaz tags: dev | |
07:24 | Les méthodes de compatibilité antérieure doivent avoir le même comportement qu'avant et ne pas utiliser les générateurs check-in: 8a5e92420a user: bohwaz tags: dev | |
Changes
Modified src/include/lib/Garradin/Plugin.php from [9153e82c84] to [3815e1aa10].
︙ | ︙ | |||
31 32 33 34 35 36 37 | * 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(); | | | | | | | | 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 | * 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->first('SELECT * FROM plugins WHERE id = ?;', $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); if (!is_array($this->plugin->config)) { $this->plugin->config = []; } $this->id = $id; } /** * Enregistrer les changements dans la config */ public function __destruct() { if ($this->config_changed) { $db = DB::getInstance(); $db->update('plugins', ['config' => json_encode($this->plugin->config)], 'id = \'' . $this->id . '\''); } } /** * Renvoie le chemin absolu vers l'archive du plugin * @return string Chemin PHAR vers l'archive |
︙ | ︙ | |||
81 82 83 84 85 86 87 | * @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)) { | | | | | | | | | 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 | * @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 (property_exists($this->plugin->config, $key)) { 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; } $this->config_changed = true; 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 (property_exists($this->plugin, $key)) { return $this->plugin->$key; } return null; } /** * Renvoie l'identifiant du plugin |
︙ | ︙ | |||
223 224 225 226 227 228 229 | $plugin = $this; include $this->path() . '/uninstall.php'; } unlink(PLUGINS_ROOT . '/' . $this->id . '.tar.gz'); $db = DB::getInstance(); | | | | | | | < | | > > | 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 | $plugin = $this; include $this->path() . '/uninstall.php'; } unlink(PLUGINS_ROOT . '/' . $this->id . '.tar.gz'); $db = DB::getInstance(); $db->delete('plugins_signaux', 'plugin = ?', $this->id); return $db->delete('plugins', '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 = (object) parse_ini_file($this->path() . '/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($this->path() . '/upgrade.php')) { $plugin = $this; include $this->path() . '/upgrade.php'; } $infos = (object) parse_ini_file($this->path() . '/garradin_plugin.ini', false); return DB::getInstance()->update('plugins', ['version' => $infos->version], 'id = :id', ['id' => $this->id] ); } /** * Associer un signal à un callback du plugin * @param string $signal Nom du signal (par exemple boucle.agenda pour la boucle de type AGENDA) * @param mixed $callback Callback, sous forme d'un nom de fonction ou de méthode statique * @return boolean TRUE |
︙ | ︙ | |||
305 306 307 308 309 310 311 | /** * Liste des plugins installés (en DB) * @return array Liste des plugins triés par nom */ static public function listInstalled() { $db = DB::getInstance(); | | | | | 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 | /** * Liste des plugins installés (en DB) * @return array Liste des plugins triés par nom */ static public function listInstalled() { $db = DB::getInstance(); $plugins = $db->getAssocKey('SELECT id, * FROM plugins ORDER BY nom;'); $system = explode(',', PLUGINS_SYSTEM); foreach ($plugins as &$row) { $row->system = in_array($row->id, $system); } return $plugins; } /** * 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->getAssoc('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() |
︙ | ︙ | |||
348 349 350 351 352 353 354 | if (!preg_match('!^([a-z0-9_.-]+)\.tar\.gz$!', $file, $match)) continue; if (array_key_exists($match[1], $installed)) continue; | | | 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 | if (!preg_match('!^([a-z0-9_.-]+)\.tar\.gz$!', $file, $match)) continue; if (array_key_exists($match[1], $installed)) continue; $list[$match[1]] = (object) parse_ini_file('phar://' . PLUGINS_ROOT . '/' . $match[1] . '.tar.gz/garradin_plugin.ini', false); } $dir->close(); return $list; } |
︙ | ︙ | |||
370 371 372 373 374 375 376 | if (Static_Cache::expired('plugins_list', 3600 * 24)) { $url = parse_url(PLUGINS_URL); $context_options = [ 'ssl' => [ 'verify_peer' => TRUE, | < < | 371 372 373 374 375 376 377 378 379 380 381 382 383 384 | if (Static_Cache::expired('plugins_list', 3600 * 24)) { $url = parse_url(PLUGINS_URL); $context_options = [ 'ssl' => [ 'verify_peer' => TRUE, 'verify_depth' => 5, 'CN_match' => $url['host'], 'SNI_enabled' => true, 'SNI_server_name' => $url['host'], 'disable_compression' => true, ] ]; |
︙ | ︙ | |||
504 505 506 507 508 509 510 | } if (!file_exists('phar://' . PLUGINS_ROOT . '/' . $id . '.tar.gz/garradin_plugin.ini')) { throw new UserException('L\'archive '.$id.'.tar.gz n\'est pas une extension Garradin : fichier garradin_plugin.ini manquant.'); } | | | | | | | | | | | | | | | | | | 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 | } if (!file_exists('phar://' . PLUGINS_ROOT . '/' . $id . '.tar.gz/garradin_plugin.ini')) { throw new UserException('L\'archive '.$id.'.tar.gz n\'est pas une extension Garradin : fichier garradin_plugin.ini manquant.'); } $infos = (object) parse_ini_file('phar://' . PLUGINS_ROOT . '/' . $id . '.tar.gz/garradin_plugin.ini', false); $required = ['nom', 'description', 'auteur', 'url', 'version', 'menu', 'config']; foreach ($required as $key) { if (!property_exists($infos, $key)) { throw new \RuntimeException('Le fichier garradin_plugin.ini ne contient pas d\'entrée "'.$key.'".'); } } if (!empty($infos->min_version) && !version_compare(garradin_version(), $infos->min_version, '>=')) { throw new \RuntimeException('Le plugin '.$id.' nécessite Garradin version '.$infos->min_version.' ou supérieure.'); } if (!empty($infos->menu) && !file_exists('phar://' . PLUGINS_ROOT . '/' . $id . '.tar.gz/www/admin/index.php')) { throw new \RuntimeException('Le plugin '.$id.' ne comporte pas de fichier www/admin/index.php alors qu\'il demande à figurer au menu.'); } $config = ''; if ((bool)$infos->config) { if (!file_exists('phar://' . PLUGINS_ROOT . '/' . $id . '.tar.gz/config.json')) { throw new \RuntimeException('L\'archive '.$id.'.tar.gz ne comporte pas de fichier config.json alors que le plugin nécessite le stockage d\'une configuration.'); } if (!file_exists('phar://' . PLUGINS_ROOT . '/' . $id . '.tar.gz/www/admin/config.php')) { throw new \RuntimeException('L\'archive '.$id.'.tar.gz ne comporte pas de fichier www/admin/config.php alors que le plugin nécessite le stockage d\'une configuration.'); } $config = json_decode(file_get_contents('phar://' . PLUGINS_ROOT . '/' . $id . '.tar.gz/config.json')); if (is_null($config)) { throw new \RuntimeException('config.json invalide. Code erreur JSON: ' . json_last_error()); } $config = json_encode($config); } $db = DB::getInstance(); $db->insert('plugins', [ 'id' => $id, 'officiel' => (int)(bool)$official, 'nom' => $infos->nom, 'description'=> $infos->description, 'auteur' => $infos->auteur, 'url' => $infos->url, 'version' => $infos->version, 'menu' => (int)(bool)$infos->menu, 'config' => $config, ]); if (file_exists('phar://' . PLUGINS_ROOT . '/' . $id . '.tar.gz/install.php')) { $plugin = new Plugin($id); include 'phar://' . PLUGINS_ROOT . '/' . $id . '.tar.gz/install.php'; } return true; } /** * Renvoie la version installée d'un plugin ou FALSE s'il n'est pas installé * @param string $id Identifiant du plugin * @return mixed Numéro de version du plugin ou FALSE */ static public function getInstalledVersion($id) { return DB::getInstance()->first('SELECT version FROM plugins WHERE id = ?;', $id); } /** * Déclenche le signal donné auprès des plugins enregistrés * @param string $signal Nom du signal * @param array $params Paramètres du callback (array ou null) * @return NULL NULL si aucun plugin n'a été appelé, true sinon */ static public function fireSignal($signal, $params = null, &$return = null) { $list = DB::getInstance()->get('SELECT * FROM plugins_signaux WHERE signal = ?;', $signal); foreach ($list as $row) { if (!in_array($row['plugin'], self::$signal_files)) { require_once 'phar://' . PLUGINS_ROOT . '/' . $row['plugin'] . '.tar.gz/signals.php'; } |
︙ | ︙ |