[PLUGINS] +crayons
[lhc/web/clavette_www.git] / www / plugins / crayons / crayons_fonctions.php
diff --git a/www/plugins/crayons/crayons_fonctions.php b/www/plugins/crayons/crayons_fonctions.php
new file mode 100644 (file)
index 0000000..5cb3280
--- /dev/null
@@ -0,0 +1,462 @@
+<?php\r
+/**\r
+ * Crayons\r
+ * plugin for spip\r
+ * (c) Fil, toggg 2006-2014\r
+ * licence GPL\r
+ *\r
+ * @package SPIP\Crayons\Fonctions\r
+ */\r
+\r
+if (!defined("_ECRIRE_INC_VERSION")) return;\r
+\r
+if (!defined('_DEBUG_CRAYONS')) {\r
+       /**\r
+        * Débuguer les crayons\r
+        *\r
+        * Mettre a true dans mes_options pour avoir les crayons non compresses\r
+        */\r
+       define('_DEBUG_CRAYONS', false);\r
+}\r
+\r
+/**\r
+ * Dire rapidement si ca vaut le coup de chercher des droits\r
+ *\r
+ * @return bool\r
+**/\r
+function analyse_droits_rapide_dist() {\r
+       return isset($GLOBALS['auteur_session']['statut']);\r
+}\r
+\r
+/**\r
+ * Ajouter la gestion des crayons dans l'espace privé\r
+ *\r
+ * @pipeline header_prive\r
+ * @uses Crayons_preparer_page()\r
+ *\r
+ * @param string $head\r
+ *     Contenu du header\r
+ * @return string\r
+ *     Contenu du header\r
+**/\r
+function Crayons_insert_head($head) {\r
+       // verifie la presence d'une meta crayons, si c'est vide\r
+       // on ne cherche meme pas a traiter l'espace prive\r
+       $config_espace_prive = @unserialize($GLOBALS['meta']['crayons']);\r
+       if (empty($config_espace_prive)) {\r
+               return $head;\r
+       }\r
+\r
+       // verifie que l'edition de l'espace prive est autorisee\r
+       if (isset($config_espace_prive['espaceprive'])\r
+       and $config_espace_prive['espaceprive'] == 'on') {\r
+               // determine les pages (exec) crayonnables\r
+               if (($config_espace_prive['exec_autorise'] == '*') ||\r
+                       in_array(_request('exec'), explode(',', $config_espace_prive['exec_autorise']))) {\r
+                       // Calcul des droits\r
+                       include_spip('inc/crayons');\r
+                       $head = Crayons_preparer_page($head, '*', wdgcfg(), 'head');\r
+               }\r
+       }\r
+\r
+       // retourne l'entete modifiee\r
+       return $head;\r
+}\r
+\r
+/**\r
+ * Ajouter la gestion des crayons dans l'espace public\r
+ *\r
+ * @pipeline affichage_final\r
+ * @uses analyse_droits_rapide_dist()\r
+ * @uses Crayons_preparer_page()\r
+ * @note\r
+ *     Le pipeline affichage_final est executé à chaque hit sur toute la page\r
+ *\r
+ * @param string $page\r
+ *     Contenu de la page à envoyer au navigateur\r
+ * @return string\r
+ *     Contenu de la page à envoyer au navigateur\r
+**/\r
+function &Crayons_affichage_final(&$page) {\r
+\r
+       // ne pas se fatiguer si le visiteur n'a aucun droit\r
+       if (!(function_exists('analyse_droits_rapide')?analyse_droits_rapide():analyse_droits_rapide_dist())) {\r
+               return $page;\r
+       }\r
+\r
+       // sinon regarder rapidement si la page a des classes crayon\r
+       if (strpos($page, 'crayon')===false) {\r
+               return $page;\r
+       }\r
+\r
+       // voir un peu plus precisement lesquelles\r
+       include_spip('inc/crayons');\r
+       if (!preg_match_all(_PREG_CRAYON, $page, $regs, PREG_SET_ORDER)) {\r
+               return $page;\r
+       }\r
+\r
+       $wdgcfg = wdgcfg();\r
+\r
+       // calculer les droits sur ces crayons\r
+       include_spip('inc/autoriser');\r
+       $droits = array();\r
+       $droits_accordes = 0;\r
+       foreach ($regs as $reg) {\r
+               list(,$crayon,$type,$champ,$id) = $reg;\r
+               if (_DEBUG_CRAYONS) {\r
+                       spip_log("autoriser('modifier', $type, $id, NULL, array('champ'=>$champ))", "crayons_distant");\r
+               }\r
+               if (autoriser('modifier', $type, $id, null, array('champ'=>$champ))) {\r
+                       if (!isset($droits['.' . $crayon])) {\r
+                               $droits['.' . $crayon] = 0;\r
+                       }\r
+                       $droits['.' . $crayon]++;\r
+                       $droits_accordes ++;\r
+               }\r
+       }\r
+\r
+       // et les signaler dans la page\r
+       if ($droits_accordes == count($regs)) { // tous les droits\r
+               $page = Crayons_preparer_page($page, '*', $wdgcfg);\r
+       } elseif ($droits) { // seulement certains droits, preciser lesquels\r
+               $page = Crayons_preparer_page($page, join(',', array_keys($droits)), $wdgcfg);\r
+       }\r
+\r
+       return $page;\r
+}\r
+\r
+/**\r
+ * Ajoute les scripts css et js nécessaires aux crayons dans le code HTML\r
+ *\r
+ * @uses crayons_var2js()\r
+ *\r
+ * @param string $page\r
+ *     Code HTML de la page complète ou du header seulement\r
+ * @param string $droits\r
+ *     - Liste de css définissant les champs crayonnables\r
+ *       (séparés par virgule) dont l'édition est autorisée\r
+ *     - "*" si tous sont autorisés\r
+ * @param array $wdgcfg\r
+ *     Description de la configuration des crayons (attribut => valeur)\r
+ * @param string $mode\r
+ *     - page : toute la page est présente dans `$page`\r
+ *     - head : seul le header est présent dans `$page`\r
+ * @return\r
+**/\r
+function &Crayons_preparer_page(&$page, $droits, $wdgcfg = array(), $mode = 'page') {\r
+       /**\r
+        * Si pas forcer_lang, on charge le contrôleur dans la langue que l'utilisateur a dans le privé\r
+        */\r
+       if (!isset($GLOBALS['forcer_lang']) or !$GLOBALS['forcer_lang'] or ($GLOBALS['forcer_lang'] === 'non')) {\r
+               lang_select($GLOBALS['auteur_session']['lang']);\r
+       }\r
+\r
+       $jsFile = generer_url_public('crayons.js');\r
+       if (_DEBUG_CRAYONS) {\r
+               $jsFile = parametre_url($jsFile, 'debug_crayons', 1, '&');\r
+       }\r
+       include_spip('inc/filtres'); // rien que pour direction_css() :(\r
+       $cssFile = direction_css(find_in_path('crayons.css'));\r
+\r
+       $config = crayons_var2js(array(\r
+               'imgPath' => dirname(find_in_path('images/crayon.png')),\r
+               'droits' => $droits,\r
+               'dir_racine' => _DIR_RACINE,\r
+               'self' => self('&'),\r
+               'txt' => array(\r
+                       'error' => _U('crayons:svp_copier_coller'),\r
+                       'sauvegarder' => $wdgcfg['msgAbandon'] ? _U('crayons:sauvegarder') : ''\r
+               ),\r
+               'img' => array(\r
+                       'searching' => array(\r
+                               'txt' => _U('crayons:veuillez_patienter')\r
+                       ),\r
+                       'crayon' => array(\r
+                               'txt' => _U('crayons:editer')\r
+                       ),\r
+                       'edit' => array(\r
+                               'txt' => _U('crayons:editer_tout')\r
+                       ),\r
+                       'img-changed' => array(\r
+                               'txt' => _U('crayons:deja_modifie')\r
+                       )\r
+               ),\r
+               'cfg' => $wdgcfg\r
+       ));\r
+\r
+\r
+       // Est-ce que PortePlume est la ?\r
+       $meta_crayon = isset($GLOBALS['meta']['crayons']) ? unserialize($GLOBALS['meta']['crayons']): array();\r
+       $pp = '';\r
+       if (isset($meta_crayon['barretypo']) && $meta_crayon['barretypo']) {\r
+               if (function_exists('chercher_filtre')\r
+               and $f = chercher_filtre('info_plugin')\r
+               and $f('PORTE_PLUME','est_actif')) {\r
+\r
+                       $pp = <<<EOF\r
+cQuery(function() {\r
+       if (typeof onAjaxLoad == 'function') {\r
+               function barrebouilles_crayons() {\r
+                       $('.formulaire_crayon textarea.crayon-active')\r
+                       .barre_outils('edition');\r
+               }\r
+               onAjaxLoad(barrebouilles_crayons);\r
+       }\r
+});\r
+EOF;\r
+\r
+               }\r
+       }\r
+\r
+\r
+       $incCSS = "<link rel=\"stylesheet\" href=\"{$cssFile}\" type=\"text/css\" media=\"all\" />";\r
+       $incJS = <<<EOH\r
+<script type="text/javascript">/* <![CDATA[ */\r
+var configCrayons;\r
+function startCrayons() {\r
+       configCrayons = new cQuery.prototype.cfgCrayons({$config});\r
+       cQuery.fn.crayonsstart();\r
+{$pp}\r
+}\r
+var cr = document.createElement('script');\r
+cr.type = 'text/javascript'; cr.async = true;\r
+cr.src = '{$jsFile}\x26callback=startCrayons';\r
+var s = document.getElementsByTagName('script')[0];\r
+s.parentNode.insertBefore(cr, s);\r
+/* ]]> */</script>\r
+\r
+EOH;\r
+\r
+       if ($mode == 'head') {\r
+               //js inline avant les css, sinon ca bloque le chargement\r
+               $page = $page . $incJS . $incCSS;\r
+               return $page; \r
+       }\r
+\r
+       $pos_head = strpos($page, '</head>');\r
+       if ($pos_head === false) {\r
+               return $page;\r
+       }\r
+\r
+       // js inline avant la premiere css, ou sinon avant la fin du head\r
+       $pos_link = strpos($page, '<link ');\r
+       if (!$pos_link) {\r
+               $pos_link = $pos_head;\r
+       }\r
+       $page = substr_replace($page, $incJS, $pos_link, 0);\r
+\r
+       // css avant la fin du head\r
+       $pos_head = strpos($page, '</head>');\r
+               $page = substr_replace($page, $incCSS, $pos_head, 0);\r
+\r
+       return $page;\r
+}\r
+\r
+/**\r
+ * Balise indiquant un champ SQL crayonnable\r
+ *\r
+ * @note\r
+ *   Si cette fonction est absente, `balise_EDIT_dist()` déclarée par SPIP\r
+ *   ne retourne rien\r
+ *\r
+ * @example\r
+ *     ```\r
+ *     <div class="#EDIT{texte}">#TEXTE</div>\r
+ *     <div class="#EDIT{ps}">#PS</div>\r
+ *     ```\r
+ *\r
+ * @param Champ $p\r
+ *   Pile au niveau de la balise\r
+ * @return Champ\r
+ *   Pile complétée par le code à générer\r
+**/\r
+function balise_EDIT($p) {\r
+\r
+       // le code compile de ce qui se trouve entre les {} de la balise\r
+       $label = interprete_argument_balise(1, $p);\r
+\r
+       // Verification si l'on est dans le cas d'une meta\r
+       // #EDIT{meta-descriptif_site} ou #EDIT{meta-demo/truc}\r
+       if (preg_match('/meta-(.*)\'/', $label, $meta)) {\r
+               $type = 'meta';\r
+               $label= 'valeur';\r
+               $primary = $meta[1];\r
+               $p->code = "classe_boucle_crayon('"\r
+                       . $type\r
+                       ."','"\r
+                       .$label\r
+                       ."',"\r
+                       . "str_replace('/', '__', '$primary')" # chaque / doit être remplacé pour CSS.\r
+                       .").' '";\r
+               $p->interdire_scripts = false;\r
+               return $p;\r
+       }\r
+\r
+       $i_boucle = $p->nom_boucle ? $p->nom_boucle : $p->id_boucle;\r
+       // #EDIT hors boucle? ne rien faire\r
+       if (!isset($p->boucles[$i_boucle]) or !$type = ($p->boucles[$i_boucle]->type_requete)) {\r
+               $p->code = "''";\r
+               $p->interdire_scripts = false;\r
+               return $p;\r
+       }\r
+\r
+       // crayon sur une base distante 'nua__article-intro-5'\r
+       if ($distant = $p->boucles[$i_boucle]->sql_serveur) {\r
+               $type = $distant.'__'.$type;\r
+       }\r
+\r
+       // le compilateur 1.9.2 ne calcule pas primary pour les tables secondaires\r
+       // il peut aussi arriver une table sans primary (par ex: une vue)\r
+       if (!($primary = $p->boucles[$i_boucle]->primary)) {\r
+               include_spip('inc/vieilles_defs'); # 1.9.2 pour trouver_def_table\r
+               if (function_exists('trouver_def_table')) {\r
+                       list($nom, $desc) = trouver_def_table(\r
+                               $p->boucles[$i_boucle]->type_requete,\r
+                               $p->boucles[$i_boucle]\r
+                       );\r
+                       $primary = $desc['key']['PRIMARY KEY'];\r
+               }\r
+       }\r
+       // On rajoute ici un debug dans le cas où aucune clé primaire n'est trouvée.\r
+       // Cela peut se présenter par exemple si on utilise #EDIT{monchamp} directement\r
+       // dans une boucle CONDITION sans faire référence au nom de la boucle d'au dessus.\r
+       if (!$primary) {\r
+               erreur_squelette(_T('crayons:absence_cle_primaire'), $p);\r
+       }\r
+\r
+       $primary = explode(',', $primary);\r
+       $id = array();\r
+       foreach ($primary as $key) {\r
+               $id[] = champ_sql(trim($key), $p);\r
+       }\r
+       $primary = implode(".'-'.", $id);\r
+\r
+       $p->code = "classe_boucle_crayon('"\r
+               . $type\r
+               ."',"\r
+               .sinon($label, "''")\r
+               .","\r
+               . $primary\r
+               .").' '";\r
+       $p->interdire_scripts = false;\r
+       return $p;\r
+}\r
+\r
+/**\r
+ * Balise indiquant une configuration crayonnable\r
+ *\r
+ * @example\r
+ *     ```\r
+ *     <div class="#EDIT_CONFIG{descriptif_site}">#DESCRIPTIF_SITE_SPIP</div>\r
+ *     <div class="#EDIT_CONFIG{demo/truc}">#CONFIG{demo/truc}</div>\r
+ *     ```\r
+ *\r
+ * @param Champ $p\r
+ *   Pile au niveau de la balise\r
+ * @return Champ\r
+ *   Pile complétée par le code à générer\r
+**/\r
+function balise_EDIT_CONFIG_dist($p) {\r
+\r
+       // le code compile de ce qui se trouve entre les {} de la balise\r
+       $config = interprete_argument_balise(1, $p);\r
+       if (!$config) {\r
+               return $p;\r
+       }\r
+\r
+       // chaque / du nom de config doit être transformé pour css.\r
+       // nous utiliserons '__' à la place.\r
+\r
+       $type = 'meta';\r
+       $label= 'valeur';\r
+\r
+       $p->code = "classe_boucle_crayon('"\r
+               . $type\r
+               . "','"\r
+               . $label\r
+               . "',"\r
+               . "str_replace('/', '__', $config)"\r
+               . ").' '";\r
+       $p->interdire_scripts = false;\r
+       return $p;\r
+}\r
+\r
+/**\r
+ * Crée le controleur du crayon indiqué par la classe CSS\r
+ *\r
+ * @param string $class\r
+ *   Class CSS de crayon tel que créé par #EDIT\r
+ * @return string\r
+ *   HTML du crayon, sinon texte d'erreur\r
+**/\r
+function creer_le_crayon($class) {\r
+       include_spip('inc/crayons');\r
+       include_spip('action/crayons_html');\r
+       $a = affiche_controleur($class, array('w' => 485, 'h' => 300, 'wh' => 500));\r
+       return $a['$erreur'] ? $a['$erreur'] : $a['$html'];\r
+}\r
+\r
+/**\r
+ * Balise `#CRAYON` affichant un formulaire de crayon\r
+ *\r
+ * SI `?edit=1;`\r
+ *\r
+ * @example\r
+ *    ```\r
+ *    #CRAYON{ps}\r
+ *    ```\r
+ *\r
+ * @param Champ $p\r
+ *   Pile au niveau de la balise\r
+ * @return Champ\r
+ *   Pile complétée par le code à générer\r
+**/\r
+function balise_CRAYON($p) {\r
+       $p = balise_EDIT($p);\r
+       $p->code = 'creer_le_crayon('.$p->code.')';\r
+       return $p;\r
+}\r
+\r
+\r
+/**\r
+ * Donne la classe CSS crayon\r
+ *\r
+ * En fonction :\r
+ * - du type de la boucle\r
+ *   (attention aux exceptions pour `#EDIT` dans les boucles HIERARCHIE et SITES)\r
+ * - du champ demande (vide, + ou se terminant par + : (+)classe type--id)\r
+ * - de l'id courant\r
+ *\r
+ * @param string $type\r
+ *   Type d'objet, ou "meta" pour un champ de configuration\r
+ * @param string $champ\r
+ *   Champ SQL concerné\r
+ * @param int|string $id\r
+ *   Identifiant de la ligne sql\r
+ * @return string\r
+ *   Classes CSS (à ajouter dans le HTML à destination du javascript de Crayons)\r
+**/\r
+function classe_boucle_crayon($type, $champ, $id) {\r
+       // $type = objet_type($type);\r
+       $type = $type[strlen($type) - 1] == 's' ?\r
+               substr($type, 0, -1) :\r
+               str_replace(\r
+                       array('hierarchie','syndication'),\r
+                       array('rubrique','site'),\r
+                       $type\r
+               );\r
+\r
+       $plus = (substr($champ, -1) == '+' and $champ = substr($champ, 0, -1))\r
+               ? " $type--$id"\r
+               : '';\r
+\r
+       // test rapide pour verifier que l'id est valide (a-zA-Z0-9)\r
+       if (false !== strpos($id, ' ')) {\r
+               spip_log("L'identifiant ($id) ne pourra être géré ($type | $champ)", 'crayons');\r
+               return 'crayon_id_ingerable';\r
+       }\r
+\r
+       return 'crayon ' . $type . '-' . $champ . '-' . $id . $plus;\r
+}\r
+\r
+?>\r