[SPIP] +2.1.12
[velocampus/web/www.git] / www / plugins / auto / cfg / depots / tablepack.php
diff --git a/www/plugins/auto/cfg/depots/tablepack.php b/www/plugins/auto/cfg/depots/tablepack.php
new file mode 100644 (file)
index 0000000..ddb9190
--- /dev/null
@@ -0,0 +1,390 @@
+<?php
+
+/**
+ * Plugin générique de configuration pour SPIP
+ *
+ * @license    GNU/GPL
+ * @package    plugins
+ * @subpackage cfg
+ * @category   outils
+ * @copyright  (c) toggg, marcimat 2007-2008
+ * @link       http://www.spip-contrib.net/
+ * @version    $Id: tablepack.php 36744 2010-03-29 02:31:19Z gilles.vincent@gmail.com $
+ */
+
+if (!defined("_ECRIRE_INC_VERSION")) return;
+
+
+/**
+ * Storage serialise dans extra de spip_auteurs ou autre
+ *
+ *
+ * Cette classe retrouve et met a jour les donnees serialisees dans une colonne d'une table
+ * par défaut : colonne 'cfg' et table 'spip_auteurs'
+ * ici, cfg_id est obligatoire ... peut-être mappé sur l'auteur courant (a voir)
+ *
+ *
+ * pour #CONFIG{xxx} ou lire_config('xxx') si xxx demarre par
+ * - ~ on utilise la colonne 'cfg' de spip_auteurs
+ *   - ~ tout court veut dire l'auteur connecte,
+ *   - ~123 celui de l'auteur 123
+ *
+ * Pour utiliser une autre colonne, il faut renseigner @colonne
+ * - ~@extra/champ ou
+ * - ~id_auteur@prefs/champ
+ *
+ * Pour recuperer des valeurs d'une table particuliere,
+ * il faut utiliser 'table:id/champ' ou 'table@colonne:id/champ'
+ * - table:123 contenu de la colonne 'cfg' de l'enregistrement id 123 de "table"
+ * - rubriques@extra:3/qqc  rubrique 3, colonne extra, champ 'qqc'
+ *
+ * "table" est un nom de table ou un raccourci comme "article"
+ * on peut croiser plusieurs id comme spip_auteurs_articles:6:123
+ * (mais il n'y a pas d'extra dans spip_auteurs_articles ...)
+ * Le 2eme argument de la balise est la valeur defaut comme pour la dist
+ *
+ * @package    plugins
+ * @subpackage cfg
+ */
+class cfg_depot_tablepack
+{
+       /**
+        * Les champs manipulés
+        * @var Array
+        */
+       var $champs = array();
+
+       /**
+        * Si on passe par cfg_id, ça fait..
+        * Heu.. Quelque chose d'utile ?
+        * @var Array
+        */
+       var $champs_id = array();
+
+       /**
+        * Les valeurs en dépôt
+        * @var Array
+        */
+       var $val = array();
+
+       /**
+        * Les différents paramètres : Tables, Colonnes, cfg_id, et Casier
+        * @var Array
+        */
+       var $param = array();
+
+       /**
+        * Pour gestion de l'affichage en succès ou échec
+        * @var Array
+        */
+       var $messages = array('message_ok'=>array(), 'message_erreur'=>array(), 'erreurs'=>array());
+
+       /**
+        * Arbre
+        * @var Array
+        */
+       var $_arbre = array();
+
+       /**
+        * Le WHERE permettant de retrouver l'Arbre
+        * @var Array
+        */
+       var $_id = array();
+
+       /**
+        * Base de l'arbre
+        * @var Array
+        */
+       var $_base = null;
+
+       /**
+        * Où on est dans l'arbre $this->_arbre
+        * @var &Array
+        */
+       var $_ici = null;
+       
+       /**
+        * version du depot
+        * @var int
+        */
+       var $version = 2;
+       
+       /**
+        * Dépôt dans les attributs de la classe
+        *
+        * @param Array $params
+        */
+       function cfg_depot_tablepack($params=array())
+       {
+               foreach ($params as $o=>$v) {
+                       $this->$o = $v;
+               }       
+       }
+       
+       /**
+        * charge la base (racine) et le point de l'arbre sur lequel on se trouve (ici)
+        *
+        * @param boolean $lire # inutilisé
+        * @return <type>
+        */
+       function charger($lire = false){
+               if (!$this->param['colonne'])   $this->param['colonne'] = 'cfg';
+
+               // colid : nom de la colonne primary key
+               if ($this->param['table']) {
+                       list($this->param['table'], $colid) = $this->get_table_id($this->param['table']);
+
+                       // renseigner les liens id=valeur
+                       $id = explode('/',$this->param['cfg_id']);
+                       foreach ($colid as $n=>$c) {
+                               if (isset($id[$n])) {
+                                       $this->_id[$c] = $id[$n];
+                               }
+                       }
+               }
+               
+               if (!$this->param['cfg_id']) {
+                       $this->messages['message_erreur'][] = _T('cfg:id_manquant');
+                       return false;
+               }
+               
+               // verifier que la colonne existe
+               if (!$this->verifier_colonne()) {
+                       return false;
+               } else {
+                       // recuperer la valeur du champ de la table sql
+                       $this->_where = array();
+                       foreach ($this->_id as $nom => $id) {
+                               $this->_where[] = $nom . '=' . sql_quote($id);
+                       }
+                       
+                       $this->_base = ($d = sql_getfetsel($this->param['colonne'], $this->param['table'], $this->_where)) ? unserialize($d) : array();
+               }       
+               $this->_arbre = array();
+               $this->_ici = &$this->_base;
+               $this->_ici = &$this->monte_arbre($this->_ici, $this->param['nom']);
+               $this->_ici = &$this->monte_arbre($this->_ici, $this->param['casier']);
+               return true;
+       }
+       
+       /**
+        * recuperer les valeurs.
+        *
+        * @return Array
+        */
+       function lire()
+       {
+               // charger
+               if (!$this->charger(true)){
+                       return array(true, null);       
+               }
+               $ici = &$this->_ici;
+
+               // utile ??
+               if ($this->param['cfg_id']) {
+                       $cles = explode('/', $this->param['cfg_id']);
+                       foreach ($this->champs_id as $i => $name) {
+                               $ici[$name] = $cles[$i];
+                       }
+               }
+       
+               // s'il y a des champs demandes, ne retourner que ceux-ci
+               if (count($this->champs)){
+                       $val = array();
+                       foreach ($this->champs as $name => $def) {
+                               $val[$name] = $ici[$name];
+                       }
+                       $ici = $val;
+               }
+               return array(true, $ici);
+       }
+
+
+       /**
+        * ecrit chaque enregistrement pour chaque champ.
+        *
+        * @return Array
+        */
+       function ecrire()
+       {
+               // charger
+               if (!$this->charger()){
+                       return array(false, $this->val, $this->messages);       
+               }
+               $ici = &$this->_ici;
+               
+               if ($this->champs){
+                       foreach ($this->champs as $name => $def) {
+                               if (isset($def['id'])) continue;
+                               $ici[$name] = $this->val[$name];
+                       }
+               } else {
+                       $ici = $this->val;      
+               }
+
+               $ok = sql_updateq($this->param['table'], array($this->param['colonne'] => serialize($this->_base)), $this->_where);     
+               return array($ok, $ici);
+       }
+       
+       
+       /**
+        * supprime chaque enregistrement pour chaque champ.
+        *
+        * @return Array
+        */
+       function effacer(){
+               // charger
+               if (!$this->charger()){
+                       return array(false, $this->val, $this->messages);       
+               }
+               $ici = &$this->_ici;
+               if ($this->champs){
+                       foreach ($this->champs as $name => $def) {
+                               if (isset($def['id'])) continue;
+                               unset($ici[$name]);
+                       }
+               }
+                       
+               // supprimer les dossiers vides
+               for ($i = count($this->_arbre); $i--; ) {
+                       if ($this->_arbre[$i][0][$this->_arbre[$i][1]]) {
+                               break;
+                       }
+                       unset($this->_arbre[$i][0][$this->_arbre[$i][1]]);
+               }
+               $ok = sql_updateq($this->param['table'], array($this->param['colonne'] => serialize($this->_base)), $this->_where);     
+               return array($ok, array());
+       }
+       
+       
+       /**
+        * charger les arguments de
+        * - lire_config(tablepack::table@colonne:id/nom/casier/champ)
+        * - lire_config(tablepack::~id_auteur@colonne/chemin/champ)
+        * - lire_config(tablepack::~@colonne/chemin/champ
+        *
+        * @param <type> $args
+        * @return <type>
+        */
+       function charger_args($args){
+               $args = explode('/',$args);
+               // cas ~id_auteur/
+               if ($args[0][0] == '~'){
+                       $table = 'spip_auteurs';
+                       $colid = array('id_auteur');
+                       list($auteur, $colonne) = explode('@',array_shift($args));
+                       if (count($auteur)>1){
+                               $id = substr($auteur,1);
+                       } else {
+                               $id = $GLOBALS['auteur_session'] ? $GLOBALS['auteur_session']['id_auteur'] : '';
+                       }
+               // cas table:id/
+               // peut etre table:id:id/ si la table a 2 cles
+               } else {
+                       list($table, $id) = explode(':',array_shift($args),2);
+                       list($table, $colonne) = explode('@',$table);
+                       list($table, $colid) = $this->get_table_id($table);
+               }
+               $this->param['cfg_id'] = $id;
+               $this->param['colonne'] = $colonne ? $colonne : 'cfg';
+               $this->param['table'] = $table ? $table : 'spip_auteurs';
+               if ($champ = array_pop($args)) {
+                       $this->champs = array($champ=>true);
+               }
+               $this->param['casier'] = implode('/',$args);
+               
+               // renseigner les liens id=valeur
+               $id = explode(':',$id);
+               foreach ($colid as $n=>$c) {
+                       if (isset($id[$n])) {
+                               $this->_id[$c] = $id[$n];
+                       }
+               }
+
+               return true;    
+       }
+       
+       
+       /**
+        * se positionner dans le tableau arborescent
+        *
+        * @param <type> $base
+        * @param <type> $chemin
+        * @return <type>
+        */
+
+       function & monte_arbre(&$base, $chemin){
+               if (!$chemin) {
+                       return $base;
+               }
+               if (!is_array($chemin)) {
+                       $chemin = explode('/', $chemin);
+               }
+               if (!is_array($base)) {
+                       $base = array();
+               }
+               
+               foreach ($chemin as $dossier) {
+                       if (!isset($base[$dossier])) {
+                               $base[$dossier] = array();
+                       }
+                       $this->_arbre[] = array(&$base, $dossier);
+                       $base = &$base[$dossier];
+               }
+               
+               return $base;
+       }
+       
+
+       /**
+        *
+        * @param <type> $creer
+        * @return <type>
+        */
+       function verifier_colonne($creer = false) {
+               if (!$this->param['table'])
+                       return false;
+               $col = sql_showtable($table = $this->param['table']);
+               if (!is_array($col['field']) OR !array_key_exists($colonne = $this->param['colonne'], $col['field'])) {
+                       if ($creer
+                       && $colonne
+                       && sql_alter('TABLE '.$this->param['table'] . ' ADD ' . $colonne . 'TEXT NOT NULL DEFAULT \'\'')) {
+                               return true;
+                       }
+                       return false;
+               }
+               return true;
+       }
+
+
+       /**
+        * Cherche le vrai nom d'une table ainsi que ses cles primaires
+        *
+        * @param <type> $table
+        * @return <type>
+        */
+       function get_table_id($table) { 
+               static $catab = array(
+                       'tables_principales' => 'base/serial',
+                       'tables_auxiliaires' => 'base/auxiliaires',
+               );
+               $try = array($table, 'spip_' . $table);
+               foreach ($catab as $categ => $catinc) {
+                       include_spip($catinc);
+                       foreach ($try as $nom) {
+                               if (isset($GLOBALS[$categ][$nom])) {
+                                       return array($nom,
+                                               preg_split('/\s*,\s*/', $GLOBALS[$categ][$nom]['key']['PRIMARY KEY']));
+                               }
+                       }
+               }
+               if ($try = table_objet($table)) {
+                       return array('spip_' . $try, array(id_table_objet($table)));
+               }
+               return array(false, false);
+       }
+
+}
+
+
+?>