c358e9205a899c61c0f0d93f477d87c6b14ea981
3 * Fonctions utiles pour le Porte Plume
5 * @plugin Porte Plume pour SPIP
7 * @package SPIP\PortePlume\BarreOutils
10 if (!defined('_ECRIRE_INC_VERSION')) {
15 * Objet contenant les différents paramètres definissant une barre d'outils
16 * Markitup et permettant d'agir dessus
19 * $barre = new Barre_Outil($description);
21 * @package SPIP\PortePlume\BarreOutils
25 * Identifiant HTML de la barre
27 * @todo À supprimer car non utilisé !
33 * Nom de la barre d'outil
37 public $nameSpace = '';
42 * @todo À supprimer car non utilisé !
48 * Option de markitup : rafraîchir la prévisu ?
50 * @todo À supprimer car non utilisé !
53 public $previewAutoRefresh = false;
56 * Option de markitup : nom de la fonction de prévisu
58 * @todo À supprimer car on le redéfini dans l'appel javascript !
61 public $previewParserPath = '';
64 * Option de markitup : que faire sur l'appuie de Entrée ?
68 public $onEnter = array();
71 * Option de markitup : que faire sur l'appuie de Shift+Entrée ?
73 * @example array('keepDefault'=>false, 'replaceWith'=>"\n_ ")
76 public $onShiftEnter = array();
79 * Option de markitup : que faire sur l'appuie de Control+Entrée ?
83 public $onCtrlEnter = array();
86 * Option de markitup : que faire sur l'appuie d'une tabulation ?
90 public $onTab = array();
93 * Option de markitup : Code JS à exécuter avant une insertion
97 public $beforeInsert = '';
100 * Option de markitup : Code JS à exécuter après une insertion
104 public $afterInsert = '';
107 * Description des outils/boutons et leurs sous boutons éventuels
111 public $markupSet = array();
114 * Fonctions JS supplémentaires à écrire après la déclaration JSON
115 * des outils. Ces fonctions peuvent servir aux boutons.
119 public $functions = '';
122 * Liste des paramètres valides pour une description d'outils (markupSet)
126 private $_liste_params_autorises = array(
132 // sur multiline, avant les lignes selectionnees
134 // sur multiline, apres les lignes selectionnees
136 // remplace par ce texte lorsqu'il n'y a pas de selection
146 // appelle un sous menu
149 // nom affiche au survol
151 // raccourcis clavier
153 // classe css utilisee
155 // langues dont le bouton doit apparaitre - array
157 // langues dont le bouton ne doit pas apparaitre - array
159 // '','word','line' : type de selection (normale, aux mots les plus proches, a la ligne la plus proche)
161 // open/close sur chaque ligne (mais replace est applique sur l'ensemble de la selection)
163 // pour faire comme si on faisait systematiquement un control+shift
164 // (et replace est applique sur chaque ligne de la selection)
171 // cacher ou afficher facilement des boutons
173 // donner un identifiant unique au bouton (pour le php)
180 * Initialise la barre avec les paramètres transmis
181 * en n'adressant que les paramètres effectivement valides
184 * @param array $params Paramètres de la barre d'outil
187 public function __construct($params = array()) {
188 foreach ($params as $p => $v) {
189 if (isset($this->$p)) {
190 // si tableau, on verifie les entrees
192 $v = $this->verif_params($p, $v);
201 * Vérifie que les paramètres d'une clé existent
202 * et retourne un tableau des paramètres valides
205 * Clé à vérifier (ex: 'markupSet')
206 * @param array $params
207 * Paramètres de cette clé (description des boutons ou sous boutons)
209 * Paramètres, soustrait de ceux qui ne sont pas valides
211 public function verif_params($nom, $params = array()) {
212 // si markupset, on boucle sur les items
213 if (stripos($nom, 'markupSet') !== false) {
214 foreach ($params as $i => $v) {
215 $params[$i] = $this->verif_params($i, $v);
217 } // sinon on teste la validite
219 foreach ($params as $p => $v) {
220 if (!in_array($p, $this->_liste_params_autorises
)) {
230 * Permet d'affecter des paramètres à un élément de la barre
232 * La fonction retourne les paramètres, de sorte qu'on peut s'en servir
233 * pour simplement récupérer ceux-ci.
235 * Il est possible d'affecter des paramètres avant/après l'élément trouvé
236 * en definisant une valeur différente pour le $lieu : 'dedans','avant','apres'
237 * par defaut 'dedans' (modifie l'élément trouvé).
239 * Lorsqu'on demande d'insérer avant ou après, la fonction retourne
240 * les paramètres inserés
242 * @param array $tableau
243 * Tableau ou chercher les elements (sert pour la recursion)
244 * @param string $identifiant
245 * Identifiant du bouton a afficher
246 * @param array $params
247 * Paramètres à affecter à la trouvaille (ou avant ou après).
248 * Peut être un tableau clé/valeur ou un tableau de tableaux
249 * clé/valeur (sauf pour $lieu = dedans)
250 * @param string $lieu
251 * Lieu d'affectation des paramètres (dedans, avant, apres)
252 * @param bool $plusieurs
253 * Définit si $params est une forme simple (tableau cle/valeur)
254 * ou comporte plusieurs boutons (tableau de tableaux cle/valeur).
256 * Paramètres de l'élément modifié ou paramètres ajoutés
257 * False si l'identifiant cherché n'est pas trouvé
259 public function affecter(&$tableau, $identifiant, $params = array(), $lieu = 'dedans', $plusieurs = false) {
260 static $cle_de_recherche = 'id'; // ou className ?
262 if ($tableau === null) {// utile ?
263 $tableau = &$this->markupSet
;
266 if (!in_array($lieu, array('dedans', 'avant', 'apres'))) {
270 // present en premiere ligne ?
272 foreach ($tableau as $i => $v) {
273 if (isset($v[$cle_de_recherche]) and ($v[$cle_de_recherche] == $identifiant)) {
278 // si trouve, affectations
279 if (($trouve !== false)) {
281 // verifier que les insertions sont correctes
282 $les_params = ($plusieurs ?
$params : array($params));
283 foreach ($les_params as $i => $un_params) {
284 $les_params[$i] = $this->verif_params($identifiant, $un_params);
287 // dedans on merge ($params uniquement tableau cle/valeur)
288 if ($lieu == 'dedans' && !$plusieurs) {
289 return $tableau[$trouve] = array_merge($tableau[$trouve], $les_params[0]);
290 } // avant ou apres, on insere ($params peut etre tableau cle/valeur ou tableau de tableaux cle/valeur)
291 elseif ($lieu == 'avant') {
292 array_splice($tableau, $trouve, 0, $les_params);
295 } elseif ($lieu == 'apres') {
296 array_splice($tableau, $trouve +
1, 0, $les_params);
302 return $tableau[$trouve];
305 // recursivons sinon !
306 foreach ($tableau as $i => $v) {
308 foreach ($v as $m => $n) {
310 and ($r = $this->affecter($tableau[$i][$m], $identifiant, $params, $lieu, $plusieurs))) {
322 * Permet d'affecter des paramètres à tous les éléments de la barre
323 * ou à une liste d'identifiants d'éléments indiqués.
325 * @param array $tableau
326 * Tableau où chercher les éléments
327 * @param array $params
328 * Paramètres à affecter aux éléments
330 * Tableau d'identifiants particuliers à qui on affecte les paramètres.
331 * Si vide, tous les identifiants seront modifiés
333 * false si aucun paramètre à affecter, true sinon.
335 public function affecter_a_tous(&$tableau, $params = array(), $ids = array()) {
340 if ($tableau === null) {
341 $tableau = &$this->markupSet
;
344 $params = $this->verif_params('divers', $params);
346 // merge de premiere ligne
347 foreach ($tableau as $i => &$v) {
348 if (!$ids or in_array($v['id'], $ids)) {
349 $tableau[$i] = array_merge($tableau[$i], $params);
351 // recursion si sous-menu
352 if (isset($tableau[$i]['dropMenu'])) {
353 $this->affecter_a_tous($tableau[$i]['dropMenu'], $params, $ids);
362 * Affecte les valeurs des paramètres indiqués au bouton demandé
363 * et retourne l'ensemble des paramètres du bouton (sinon false)
366 * @param string|array $identifiant
367 * Identifiant du ou des boutons.
368 * @param array $params
369 * Paramètres de l'ajout (tableau paramètre=>valeur)
371 * false si l'identifiant n'a pas été trouvé
372 * true si plusieurs identifiants,
373 * array sinon : description de l'identifiant cherché.
375 public function set($identifiant, $params = array()) {
376 // prudence tout de meme a pas tout modifier involontairement (si array)
381 if (is_string($identifiant)) {
382 return $this->affecter($this->markupSet
, $identifiant, $params);
383 } elseif (is_array($identifiant)) {
384 return $this->affecter_a_tous($this->markupSet
, $params, $identifiant);
391 * Retourne les parametres du bouton demande
394 * @param string|array $identifiant
395 * Identifiant du ou des boutons.
397 * false si l'identifiant n'est pas trouvé
398 * array sinon : Description de l'identifiant cherché.
400 public function get($identifiant) {
401 if ($a = $this->affecter($this->markupSet
, $identifiant)) {
410 * Affiche le ou les boutons demandés
413 * @param string|array $identifiant
414 * Identifiant du ou des boutons
416 * false si l'identifiant n'a pas été trouvé
417 * true si plusieurs identifiants,
418 * array sinon : description de l'identifiant cherché.
420 public function afficher($identifiant) {
421 return $this->set($identifiant, array('display' => true));
426 * Cache le ou les boutons demandés
429 * @param string|array $identifiant
430 * Identifiant du ou des boutons
432 * false si l'identifiant n'a pas été trouvé
433 * true si plusieurs identifiants,
434 * array sinon : description de l'identifiant cherché.
436 public function cacher($identifiant) {
437 return $this->set($identifiant, array('display' => false));
442 * Affiche tous les boutons
446 * false si aucun paramètre à affecter, true sinon.
448 public function afficherTout() {
449 return $this->affecter_a_tous($this->markupSet
, array('display' => true));
453 * Cache tous les boutons
457 * false si aucun paramètre à affecter, true sinon.
459 public function cacherTout() {
460 return $this->affecter_a_tous($this->markupSet
, array('display' => false));
465 * Ajoute un bouton ou quelque chose, avant un autre déjà présent
468 * @param string $identifiant
469 * Identifiant du bouton où l'on doit se situer
470 * @param array $params
471 * Paramètres de l'ajout.
472 * Description d'un bouton (tableau clé/valeurs).
474 * Paramètres ajoutés avant
475 * False si l'identifiant cherché n'est pas trouvé
477 public function ajouterAvant($identifiant, $params) {
478 return $this->affecter($this->markupSet
, $identifiant, $params, 'avant');
482 * Ajoute plusieurs boutons, avant un autre déjà présent
485 * @param string $identifiant
486 * Identifiant du bouton où l'on doit se situer
487 * @param array $tableau_params
488 * Paramètres de l'ajout.
489 * Description de plusieurs boutons (tableau de tableaux clé/valeurs).
491 * Paramètres ajoutés avant
492 * False si l'identifiant cherché n'est pas trouvé
494 public function ajouterPlusieursAvant($identifiant, $tableau_params) {
495 return $this->affecter($this->markupSet
, $identifiant, $tableau_params, 'avant', true);
499 * Ajoute un bouton ou quelque chose, après un autre déjà présent
502 * @param string $identifiant
503 * Identifiant du bouton où l'on doit se situer
504 * @param array $params
505 * Paramètres de l'ajout.
506 * Description d'un bouton (tableau clé/valeurs).
508 * Paramètres ajoutés après
509 * False si l'identifiant cherché n'est pas trouvé
511 public function ajouterApres($identifiant, $params) {
512 return $this->affecter($this->markupSet
, $identifiant, $params, 'apres');
516 * Ajoute plusieurs boutons, après un autre déjà présent
519 * @param string $identifiant
520 * Identifiant du bouton où l'on doit se situer
521 * @param array $tableau_params
522 * Paramètres de l'ajout.
523 * Description de plusieurs boutons (tableau de tableaux clé/valeurs).
525 * Paramètres ajoutés après
526 * False si l'identifiant cherché n'est pas trouvé
528 public function ajouterPlusieursApres($identifiant, $tableau_params) {
529 return $this->affecter($this->markupSet
, $identifiant, $tableau_params, 'apres', true);
533 * Ajoute une fonction JS qui pourra être utilisée par les boutons
536 * @param string $fonction Code de la fonction JS
539 public function ajouterFonction($fonction) {
540 if (false === strpos($this->functions
, $fonction)) {
541 $this->functions
.= "\n" . $fonction . "\n";
546 * Supprimer les éléments non affichés (display:false)
547 * Et les séparateurs (li vides) selon la configuration
549 * @param array $tableau Tableau de description des outils
552 public function enlever_elements_non_affiches(&$tableau) {
553 if ($tableau === null) { // utile ?
554 $tableau = &$this->markupSet
;
557 foreach ($tableau as $p => &$v) {
558 if (isset($v['display']) and !$v['display']) {
560 // remettre les cles automatiques sinon json les affiche et ça plante.
561 $tableau = array_values($tableau);
563 // sinon, on lance une recursion sur les sous-menus
564 if (isset($v['dropMenu']) and is_array($v['dropMenu'])) {
565 $this->enlever_elements_non_affiches($tableau[$p]['dropMenu']);
566 // si le sous-menu est vide
567 // on enleve le sous menu.
568 // mais pas le parent ($tableau[$p]), qui peut effectuer une action.
569 if (empty($tableau[$p]['dropMenu'])) {
570 unset($tableau[$p]['dropMenu']);
578 * Enlève les séparateurs pour améliorer l'accessibilité
579 * au détriment du stylage possible de ces séparateurs.
581 * Le bouton précédent le séparateur reçoit une classe CSS 'separateur_avant'
582 * Celui apres 'separateur_apres'
584 * @param array $tableau
585 * Tableau de description des outils
588 public function enlever_separateurs(&$tableau) {
589 if ($tableau === null) { // utile ?
590 $tableau = &$this->markupSet
;
594 foreach ($tableau as $p => &$v) {
595 if (isset($v['separator']) and $v['separator']) {
596 if (isset($tableau[$p - 1])) {
597 if (!isset($tableau[$p - 1]['className'])) {
598 $tableau[$p - 1]['className'] = '';
600 $tableau[$p - 1]['className'] .= ' separateur_avant';
602 if (isset($tableau[$p +
1])) {
603 if (!isset($tableau[$p +
1]['className'])) {
604 $tableau[$p +
1]['className'] = '';
606 $tableau[$p +
1]['className'] .= " separateur separateur_apres $v[id]";
609 // remettre les cles automatiques sinon json les affiche et ça plante.
610 $tableau = array_values($tableau);
612 // sinon, on lance une recursion sur les sous-menus
613 if (isset($v['dropMenu']) and is_array($v['dropMenu'])) {
614 #$this->enlever_separateurs($tableau[$p]['dropMenu']);
621 * Supprime les éléments vides (uniquement à la racine de l'objet)
622 * et uniquement si chaîne ou tableau.
624 * Supprime les paramètres privés
625 * Supprime les paramètres inutiles a markitup/json dans les paramètres markupSet
626 * (id, display, icone)
628 public function enlever_parametres_inutiles() {
629 foreach ($this as $p => $v) {
630 if ($p == 'markupSet') {
634 if (is_array($v) or is_string($v)) {
637 } elseif ($p == 'functions') {
641 foreach ($this->markupSet
as $p => $v) {
642 foreach ($v as $n => $m) {
643 if (in_array($n, array('id', 'display'))) {
644 unset($this->markupSet
[$p][$n]);
648 unset($this->_liste_params_autorises
);
653 * Crée la sortie json pour le javascript des paramètres de la barre
655 * @return string Déclaration json de la barre
657 public function creer_json() {
659 $type = $barre->nameSpace;
660 $fonctions = $barre->functions
;
662 $barre->enlever_elements_non_affiches($this->markupSet
);
663 $barre->enlever_separateurs($this->markupSet
);
664 $barre->enlever_parametres_inutiles();
666 $json = Barre_outils
::json_export($barre);
668 // on lance la transformation des &chose; en veritables caracteres
669 // sinon markitup restitue « au lieu de « directement
670 // lorsqu'on clique sur l'icone
671 include_spip('inc/charsets');
672 $json = unicode2charset(html2unicode($json));
674 return "\n\nbarre_outils_$type = " . $json . "\n\n $fonctions";
678 * Transforme une variable PHP dans un équivalent javascript (json)
680 * Copié depuis ecrire/inc/json, mais modifié pour que les fonctions
681 * JavaScript ne soient pas encapsulées dans une chaîne (string)
684 * @param mixed $var the variable
685 * @return string|boolean
686 * - string : js script
687 * - boolean false if error
689 public function json_export($var) {
694 case is_string($var):
695 if (strtolower(substr(ltrim($var), 0, 8)) == 'function') {
699 return '"' . addcslashes($var, "\"\\\n\r") . '"';
701 return $var ?
'true' : 'false';
702 case is_scalar($var):
704 case is_object($var):
705 $var = get_object_vars($var);
708 $keys = array_keys($var);
709 $ikey = count($keys);
710 while (!$asso && $ikey--) {
711 $asso = $ikey !== $keys[$ikey];
716 foreach ($var as $key => $elt) {
717 $ret .= $sep . '"' . $key . '":' . Barre_outils
::json_export($elt);
724 foreach ($var as $elt) {
725 $ret .= $sep . Barre_outils
::json_export($elt);
739 * Crée le code CSS pour les images des icones des barres d'outils
741 * S'appuie sur la description des jeux de barres disponibles et cherche
742 * une fonction barre_outils_($barre)_icones pour chaque barre et
743 * l'exécute si existe, attendant alors en retour un tableau de couples :
744 * nom de l'outil => nom de l'image
746 * @pipeline_appel porte_plume_lien_classe_vers_icone
748 * @return string Déclaration CSS des icones
750 function barre_outils_css_icones() {
751 // recuperer la liste, extraire les icones
755 if (!$barres = barre_outils_liste()) {
759 // liste des classes css et leur correspondance avec une icone
760 $classe2icone = array();
761 foreach ($barres as $barre) {
762 include_spip('barre_outils/' . $barre);
763 if ($f = charger_fonction($barre . '_icones', 'barre_outils', true)) {
764 if (is_array($icones = $f())) {
765 $classe2icone = array_merge($classe2icone, $icones);
771 * Permettre aux plugins d'étendre les icones connues du porte plume
773 * On passe la liste des icones connues au pipeline pour ceux qui
774 * ajoutent de simples icones à des barres existantes
776 * @pipeline_appel porte_plume_lien_classe_vers_icone
777 * @var array $classe2icone
778 * Couples identifiant de bouton => nom de l'image (ou tableau)
779 * Dans le cas d'un tableau, cela indique une sprite : (nom de l'image , position haut, position bas)
780 * Exemple : 'outil_header1' => array('spt-v1.png','-10px -226px')
782 $classe2icone = pipeline('porte_plume_lien_classe_vers_icone', $classe2icone);
785 foreach ($classe2icone as $n => $i) {
788 $pos = 'background-position:' . end($i);
791 if (file_exists($i)) {
794 $file = find_in_path("icones_barre/$i");
797 $css .= "\n.markItUp .$n>a>em {background-image:url(" . protocole_implicite(url_absolue($file)) . ");$pos}";
806 * Retourne une instance de Barre_outils
807 * crée à partir du type de barre demandé
809 * Une fonction barre_outils_{type}_dist() retournant la barre doit
813 * Type de barre (ex: 'edition')
814 * @return Barre_Outils|bool
815 * La barre d'outil si la fonction a été trouvée, false sinon
817 function barre_outils_initialiser($set) {
818 if ($f = charger_fonction($set, 'barre_outils')) {
819 // retourne une instance de l'objet Barre_outils
827 * Retourne la liste des barres d'outils connues
830 * Tableau des noms de barres d'outils trouvées
831 * False si on ne trouve aucune barre.
833 function barre_outils_liste() {
839 // on recupere l'ensemble des barres d'outils connues
840 if (!$sets = find_all_in_path('barre_outils/', '.*[.]php')
843 spip_log("[Scandale] Porte Plume ne trouve pas de barre d'outils !");
849 foreach ($sets as $fichier => $adresse) {
850 $sets[$fichier] = substr($fichier, 0, -4); // juste le nom
857 * Filtre appliquant les traitements SPIP d'un champ
859 * Applique les filtres prévus sur un champ (et eventuellement un type d'objet)
860 * sur un texte donné. Sécurise aussi le texte en appliquant safehtml().
862 * Ce mécanisme est à préférer au traditionnel #TEXTE*|propre
864 * traitements_previsu() consulte la globale $table_des_traitements et
865 * applique le traitement adequat. Si aucun traitement n'est trouvé,
866 * alors propre() est appliqué.
868 * @package SPIP\PortePlume\Fonctions
869 * @see champs_traitements() dans public/references.php
870 * @global table_des_traitements
872 * @param string $texte
874 * @param string $nom_champ
875 * Nom du champ (nom de la balise, en majuscules)
876 * @param string $type_objet
877 * L'objet a qui appartient le champ (en minuscules)
878 * @param string $connect
879 * Nom du connecteur de base de données
881 * Texte traité avec les filtres déclarés pour le champ.
883 function traitements_previsu($texte, $nom_champ = '', $type_objet = '', $connect = null) {
884 include_spip('public/interfaces'); // charger les traitements
886 global $table_des_traitements;
887 if (!strlen($nom_champ) ||
!isset($table_des_traitements[$nom_champ])) {
888 $texte = propre($texte, $connect);
890 include_spip('base/abstract_sql');
891 $table = table_objet($type_objet);
892 $ps = $table_des_traitements[$nom_champ];
894 $ps = $ps[(strlen($table) && isset($ps[$table])) ?
$table : 0];
897 $texte = propre($texte, $connect);
899 // [FIXME] Éviter une notice sur le eval suivant qui ne connait
900 // pas la Pile ici. C'est pas tres joli...
901 $Pile = array(0 => array());
902 // remplacer le placeholder %s par le texte fourni
903 eval('$texte=' . str_replace('%s', '$texte', $ps) . ';');
906 // il faut toujours securiser le texte prévisualisé car il peut contenir n'importe quoi
907 // et servir de support a une attaque xss ou vol de cookie admin
908 // on ne peut donc se fier au statut de l'auteur connecté car le contenu ne vient pas
910 return safehtml($texte);
917 * Retourne la définition de la barre markitup désignée.
918 * (cette déclaration est au format json)
920 * Deux pipelines 'porte_plume_pre_charger' et 'porte_plume_charger'
921 * permettent de récuperer l'objet de classe Barre_outil
922 * avant son export en json pour modifier des elements.
924 * @pipeline_appel porte_plume_barre_pre_charger
925 * Charge des nouveaux boutons au besoin
926 * @pipeline_appel porte_plume_barre_charger
927 * Affiche ou cache certains boutons
929 * @return string Déclaration json
931 function porte_plume_creer_json_markitup() {
932 // on recupere l'ensemble des barres d'outils connues
933 include_spip('porte_plume_fonctions');
934 if (!$sets = barre_outils_liste()) {
938 // 1) On initialise tous les jeux de barres
940 foreach ($sets as $set) {
941 if (($barre = barre_outils_initialiser($set)) and is_object($barre)) {
942 $barres[$set] = $barre;
949 * Charger des nouveaux boutons au besoin
952 * $barre = &$flux['spip'];
953 * $barre->ajouterApres('bold',array(params));
954 * $barre->ajouterAvant('bold',array(params));
956 * $bold = $barre->get('bold');
957 * $bold['id'] = 'bold2';
958 * $barre->ajouterApres('italic',$bold);
959 * @pipeline_appel porte_plume_barre_pre_charger
961 $barres = pipeline('porte_plume_barre_pre_charger', $barres);
967 * Cacher ou afficher certains boutons au besoin
970 * $barre = &$flux['spip'];
971 * $barre->afficher('bold');
972 * $barre->cacher('bold');
974 * $barre->cacherTout();
975 * $barre->afficher(array('bold','italic','header1'));
976 * @pipeline_appel porte_plume_barre_charger
978 $barres = pipeline('porte_plume_barre_charger', $barres);
981 // 4 On crée les jsons
983 foreach ($barres as $set => $barre) {
984 $json .= $barre->creer_json();