www/plugins/crayons/crayons_fonctions.php

   1 <?php
   2 /**
   3  * Crayons
   4  * plugin for spip
   5  * (c) Fil, toggg 2006-2014
   6  * licence GPL
   7  *
   8  * @package SPIP\Crayons\Fonctions
   9  */
  10
  11 if (!defined("_ECRIRE_INC_VERSION")) return;
  12
  13 if (!defined('_DEBUG_CRAYONS')) {
  14         /**
  15          * Débuguer les crayons
  16          *
  17          * Mettre a true dans mes_options pour avoir les crayons non compresses
  18          */
  19         define('_DEBUG_CRAYONS', false);
  20 }
  21
  22 /**
  23  * Dire rapidement si ca vaut le coup de chercher des droits
  24  *
  25  * @return bool
  26 **/
  27 function analyse_droits_rapide_dist() {
  28         return isset($GLOBALS['auteur_session']['statut']);
  29 }
  30
  31 /**
  32  * Ajouter la gestion des crayons dans l'espace privé
  33  *
  34  * @pipeline header_prive
  35  * @uses Crayons_preparer_page()
  36  *
  37  * @param string $head
  38  *     Contenu du header
  39  * @return string
  40  *     Contenu du header
  41 **/
  42 function Crayons_insert_head($head) {
  43         // verifie la presence d'une meta crayons, si c'est vide
  44         // on ne cherche meme pas a traiter l'espace prive
  45         $config_espace_prive = @unserialize($GLOBALS['meta']['crayons']);
  46         if (empty($config_espace_prive)) {
  47                 return $head;
  48         }
  49
  50         // verifie que l'edition de l'espace prive est autorisee
  51         if (isset($config_espace_prive['espaceprive'])
  52         and $config_espace_prive['espaceprive'] == 'on') {
  53                 // determine les pages (exec) crayonnables
  54                 if (($config_espace_prive['exec_autorise'] == '*') ||
  55                         in_array(_request('exec'), explode(',', $config_espace_prive['exec_autorise']))) {
  56                         // Calcul des droits
  57                         include_spip('inc/crayons');
  58                         $head = Crayons_preparer_page($head, '*', wdgcfg(), 'head');
  59                 }
  60         }
  61
  62         // retourne l'entete modifiee
  63         return $head;
  64 }
  65
  66 /**
  67  * Ajouter la gestion des crayons dans l'espace public
  68  *
  69  * @pipeline affichage_final
  70  * @uses analyse_droits_rapide_dist()
  71  * @uses Crayons_preparer_page()
  72  * @note
  73  *     Le pipeline affichage_final est executé à chaque hit sur toute la page
  74  *
  75  * @param string $page
  76  *     Contenu de la page à envoyer au navigateur
  77  * @return string
  78  *     Contenu de la page à envoyer au navigateur
  79 **/
  80 function &Crayons_affichage_final(&$page) {
  81
  82         // ne pas se fatiguer si le visiteur n'a aucun droit
  83         if (!(function_exists('analyse_droits_rapide')?analyse_droits_rapide():analyse_droits_rapide_dist())) {
  84                 return $page;
  85         }
  86
  87         // sinon regarder rapidement si la page a des classes crayon
  88         if (strpos($page, 'crayon')===false) {
  89                 return $page;
  90         }
  91
  92         // voir un peu plus precisement lesquelles
  93         include_spip('inc/crayons');
  94         if (!preg_match_all(_PREG_CRAYON, $page, $regs, PREG_SET_ORDER)) {
  95                 return $page;
  96         }
  97
  98         $wdgcfg = wdgcfg();
  99
 100         // calculer les droits sur ces crayons
 101         include_spip('inc/autoriser');
 102         $droits = array();
 103         $droits_accordes = 0;
 104         foreach ($regs as $reg) {
 105                 list(,$crayon,$type,$champ,$id) = $reg;
 106                 if (_DEBUG_CRAYONS) {
 107                         spip_log("autoriser('modifier', $type, $id, NULL, array('champ'=>$champ))", "crayons_distant");
 108                 }
 109                 if (autoriser('modifier', $type, $id, null, array('champ'=>$champ))) {
 110                         if (!isset($droits['.' . $crayon])) {
 111                                 $droits['.' . $crayon] = 0;
 112                         }
 113                         $droits['.' . $crayon]++;
 114                         $droits_accordes ++;
 115                 }
 116         }
 117
 118         // et les signaler dans la page
 119         if ($droits_accordes == count($regs)) { // tous les droits
 120                 $page = Crayons_preparer_page($page, '*', $wdgcfg);
 121         } elseif ($droits) { // seulement certains droits, preciser lesquels
 122                 $page = Crayons_preparer_page($page, join(',', array_keys($droits)), $wdgcfg);
 123         }
 124
 125         return $page;
 126 }
 127
 128 /**
 129  * Ajoute les scripts css et js nécessaires aux crayons dans le code HTML
 130  *
 131  * @uses crayons_var2js()
 132  *
 133  * @param string $page
 134  *     Code HTML de la page complète ou du header seulement
 135  * @param string $droits
 136  *     - Liste de css définissant les champs crayonnables
 137  *       (séparés par virgule) dont l'édition est autorisée
 138  *     - "*" si tous sont autorisés
 139  * @param array $wdgcfg
 140  *     Description de la configuration des crayons (attribut => valeur)
 141  * @param string $mode
 142  *     - page : toute la page est présente dans `$page`
 143  *     - head : seul le header est présent dans `$page`
 144  * @return
 145 **/
 146 function &Crayons_preparer_page(&$page, $droits, $wdgcfg = array(), $mode = 'page') {
 147         /**
 148          * Si pas forcer_lang, on charge le contrôleur dans la langue que l'utilisateur a dans le privé
 149          */
 150         if (!isset($GLOBALS['forcer_lang']) or !$GLOBALS['forcer_lang'] or ($GLOBALS['forcer_lang'] === 'non')) {
 151                 lang_select($GLOBALS['auteur_session']['lang']);
 152         }
 153
 154         $jsFile = generer_url_public('crayons.js');
 155         if (_DEBUG_CRAYONS) {
 156                 $jsFile = parametre_url($jsFile, 'debug_crayons', 1, '&');
 157         }
 158         include_spip('inc/filtres'); // rien que pour direction_css() :(
 159         $cssFile = direction_css(find_in_path('crayons.css'));
 160
 161         $config = crayons_var2js(array(
 162                 'imgPath' => dirname(find_in_path('images/crayon.png')),
 163                 'droits' => $droits,
 164                 'dir_racine' => _DIR_RACINE,
 165                 'self' => self('&'),
 166                 'txt' => array(
 167                         'error' => _U('crayons:svp_copier_coller'),
 168                         'sauvegarder' => $wdgcfg['msgAbandon'] ? _U('crayons:sauvegarder') : ''
 169                 ),
 170                 'img' => array(
 171                         'searching' => array(
 172                                 'txt' => _U('crayons:veuillez_patienter')
 173                         ),
 174                         'crayon' => array(
 175                                 'txt' => _U('crayons:editer')
 176                         ),
 177                         'edit' => array(
 178                                 'txt' => _U('crayons:editer_tout')
 179                         ),
 180                         'img-changed' => array(
 181                                 'txt' => _U('crayons:deja_modifie')
 182                         )
 183                 ),
 184                 'cfg' => $wdgcfg
 185         ));
 186
 187
 188         // Est-ce que PortePlume est la ?
 189         $meta_crayon = isset($GLOBALS['meta']['crayons']) ? unserialize($GLOBALS['meta']['crayons']): array();
 190         $pp = '';
 191         if (isset($meta_crayon['barretypo']) && $meta_crayon['barretypo']) {
 192                 if (function_exists('chercher_filtre')
 193                 and $f = chercher_filtre('info_plugin')
 194                 and $f('PORTE_PLUME','est_actif')) {
 195
 196                         $pp = <<<EOF
 197 cQuery(function() {
 198         if (typeof onAjaxLoad == 'function') {
 199                 function barrebouilles_crayons() {
 200                         $('.formulaire_crayon textarea.crayon-active')
 201                         .barre_outils('edition');
 202                 }
 203                 onAjaxLoad(barrebouilles_crayons);
 204         }
 205 });
 206 EOF;
 207
 208                 }
 209         }
 210
 211
 212         $incCSS = "<link rel=\"stylesheet\" href=\"{$cssFile}\" type=\"text/css\" media=\"all\" />";
 213         $incJS = <<<EOH
 214 <script type="text/javascript">/* <![CDATA[ */
 215 var configCrayons;
 216 function startCrayons() {
 217         configCrayons = new cQuery.prototype.cfgCrayons({$config});
 218         cQuery.fn.crayonsstart();
 219 {$pp}
 220 }
 221 var cr = document.createElement('script');
 222 cr.type = 'text/javascript'; cr.async = true;
 223 cr.src = '{$jsFile}\x26callback=startCrayons';
 224 var s = document.getElementsByTagName('script')[0];
 225 s.parentNode.insertBefore(cr, s);
 226 /* ]]> */</script>
 227
 228 EOH;
 229
 230         if ($mode == 'head') {
 231                 return $page = $page . $incJS . $incCSS; //js inline avant les css, sinon ca bloque le chargement
 232         }
 233
 234         $pos_head = strpos($page, '</head>');
 235         if ($pos_head === false) {
 236                 return $page;
 237         }
 238
 239         // js inline avant la premiere css, ou sinon avant la fin du head
 240         $pos_link = strpos($page, '<link ');
 241         if (!$pos_link) {
 242                 $pos_link = $pos_head;
 243         }
 244         $page = substr_replace($page, $incJS, $pos_link, 0);
 245
 246         // css avant la fin du head
 247         $pos_head = strpos($page, '</head>');
 248                 $page = substr_replace($page, $incCSS, $pos_head, 0);
 249
 250         return $page;
 251 }
 252
 253 /**
 254  * Balise indiquant un champ SQL crayonnable
 255  *
 256  * @note
 257  *   Si cette fonction est absente, `balise_EDIT_dist()` déclarée par SPIP
 258  *   ne retourne rien
 259  *
 260  * @example
 261  *     ```
 262  *     <div class="#EDIT{texte}">#TEXTE</div>
 263  *     <div class="#EDIT{ps}">#PS</div>
 264  *     ```
 265  *
 266  * @param Champ $p
 267  *   Pile au niveau de la balise
 268  * @return Champ
 269  *   Pile complétée par le code à générer
 270 **/
 271 function balise_EDIT($p) {
 272
 273         // le code compile de ce qui se trouve entre les {} de la balise
 274         $label = interprete_argument_balise(1, $p);
 275
 276         // Verification si l'on est dans le cas d'une meta
 277         // #EDIT{meta-descriptif_site} ou #EDIT{meta-demo/truc}
 278         if (preg_match('/meta-(.*)\'/', $label, $meta)) {
 279                 $type = 'meta';
 280                 $label= 'valeur';
 281                 $primary = $meta[1];
 282                 $p->code = "classe_boucle_crayon('"
 283                         . $type
 284                         ."','"
 285                         .$label
 286                         ."',"
 287                         . "str_replace('/', '__', '$primary')" # chaque / doit être remplacé pour CSS.
 288                         .").' '";
 289                 $p->interdire_scripts = false;
 290                 return $p;
 291         }
 292
 293         $i_boucle = $p->nom_boucle ? $p->nom_boucle : $p->id_boucle;
 294         // #EDIT hors boucle? ne rien faire
 295         if (!isset($p->boucles[$i_boucle]) or !$type = ($p->boucles[$i_boucle]->type_requete)) {
 296                 $p->code = "''";
 297                 $p->interdire_scripts = false;
 298                 return $p;
 299         }
 300
 301         // crayon sur une base distante 'nua__article-intro-5'
 302         if ($distant = $p->boucles[$i_boucle]->sql_serveur) {
 303                 $type = $distant.'__'.$type;
 304         }
 305
 306         // le compilateur 1.9.2 ne calcule pas primary pour les tables secondaires
 307         // il peut aussi arriver une table sans primary (par ex: une vue)
 308         if (!($primary = $p->boucles[$i_boucle]->primary)) {
 309                 include_spip('inc/vieilles_defs'); # 1.9.2 pour trouver_def_table
 310                 if (function_exists('trouver_def_table')) {
 311                         list($nom, $desc) = trouver_def_table(
 312                                 $p->boucles[$i_boucle]->type_requete,
 313                                 $p->boucles[$i_boucle]
 314                         );
 315                         $primary = $desc['key']['PRIMARY KEY'];
 316                 }
 317         }
 318         // On rajoute ici un debug dans le cas où aucune clé primaire n'est trouvée.
 319         // Cela peut se présenter par exemple si on utilise #EDIT{monchamp} directement
 320         // dans une boucle CONDITION sans faire référence au nom de la boucle d'au dessus.
 321         if (!$primary) {
 322                 erreur_squelette(_T('crayons:absence_cle_primaire'), $p);
 323         }
 324
 325         $primary = explode(',', $primary);
 326         $id = array();
 327         foreach ($primary as $key) {
 328                 $id[] = champ_sql(trim($key), $p);
 329         }
 330         $primary = implode(".'-'.", $id);
 331
 332         $p->code = "classe_boucle_crayon('"
 333                 . $type
 334                 ."',"
 335                 .sinon($label, "''")
 336                 .","
 337                 . $primary
 338                 .").' '";
 339         $p->interdire_scripts = false;
 340         return $p;
 341 }
 342
 343 /**
 344  * Balise indiquant une configuration crayonnable
 345  *
 346  * @example
 347  *     ```
 348  *     <div class="#EDIT_CONFIG{descriptif_site}">#DESCRIPTIF_SITE_SPIP</div>
 349  *     <div class="#EDIT_CONFIG{demo/truc}">#CONFIG{demo/truc}</div>
 350  *     ```
 351  *
 352  * @param Champ $p
 353  *   Pile au niveau de la balise
 354  * @return Champ
 355  *   Pile complétée par le code à générer
 356 **/
 357 function balise_EDIT_CONFIG_dist($p) {
 358
 359         // le code compile de ce qui se trouve entre les {} de la balise
 360         $config = interprete_argument_balise(1, $p);
 361         if (!$config) {
 362                 return $p;
 363         }
 364
 365         // chaque / du nom de config doit être transformé pour css.
 366         // nous utiliserons '__' à la place.
 367
 368         $type = 'meta';
 369         $label= 'valeur';
 370
 371         $p->code = "classe_boucle_crayon('"
 372                 . $type
 373                 . "','"
 374                 . $label
 375                 . "',"
 376                 . "str_replace('/', '__', $config)"
 377                 . ").' '";
 378         $p->interdire_scripts = false;
 379         return $p;
 380 }
 381
 382 /**
 383  * Crée le controleur du crayon indiqué par la classe CSS
 384  *
 385  * @param string $class
 386  *   Class CSS de crayon tel que créé par #EDIT
 387  * @return string
 388  *   HTML du crayon, sinon texte d'erreur
 389 **/
 390 function creer_le_crayon($class) {
 391         include_spip('inc/crayons');
 392         include_spip('action/crayons_html');
 393         $a = affiche_controleur($class, array('w' => 485, 'h' => 300, 'wh' => 500));
 394         return $a['$erreur'] ? $a['$erreur'] : $a['$html'];
 395 }
 396
 397 /**
 398  * Balise `#CRAYON` affichant un formulaire de crayon
 399  *
 400  * SI `?edit=1;`
 401  *
 402  * @example
 403  *    ```
 404  *    #CRAYON{ps}
 405  *    ```
 406  *
 407  * @param Champ $p
 408  *   Pile au niveau de la balise
 409  * @return Champ
 410  *   Pile complétée par le code à générer
 411 **/
 412 function balise_CRAYON($p) {
 413         $p = balise_EDIT($p);
 414         $p->code = 'creer_le_crayon('.$p->code.')';
 415         return $p;
 416 }
 417
 418
 419 /**
 420  * Donne la classe CSS crayon
 421  *
 422  * En fonction :
 423  * - du type de la boucle
 424  *   (attention aux exceptions pour `#EDIT` dans les boucles HIERARCHIE et SITES)
 425  * - du champ demande (vide, + ou se terminant par + : (+)classe type--id)
 426  * - de l'id courant
 427  *
 428  * @param string $type
 429  *   Type d'objet, ou "meta" pour un champ de configuration
 430  * @param string $champ
 431  *   Champ SQL concerné
 432  * @param int|string $id
 433  *   Identifiant de la ligne sql
 434  * @return string
 435  *   Classes CSS (à ajouter dans le HTML à destination du javascript de Crayons)
 436 **/
 437 function classe_boucle_crayon($type, $champ, $id) {
 438         // $type = objet_type($type);
 439         $type = $type[strlen($type) - 1] == 's' ?
 440                 substr($type, 0, -1) :
 441                 str_replace(
 442                         array('hierarchie','syndication'),
 443                         array('rubrique','site'),
 444                         $type
 445                 );
 446
 447         $plus = (substr($champ, -1) == '+' and $champ = substr($champ, 0, -1))
 448                 ? " $type--$id"
 449                 : '';
 450
 451         // test rapide pour verifier que l'id est valide (a-zA-Z0-9)
 452         if (false !== strpos($id, ' ')) {
 453                 spip_log("L'identifiant ($id) ne pourra être géré ($type | $champ)", 'crayons');
 454                 return 'crayon_id_ingerable';
 455         }
 456
 457         return 'crayon ' . $type . '-' . $champ . '-' . $id . $plus;
 458 }
 459
 460 ?>