3 /***************************************************************************\
4 * SPIP, Systeme de publication pour l'internet *
6 * Copyright (c) 2001-2012 *
7 * Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James *
9 * Ce programme est un logiciel libre distribue sous licence GNU/GPL. *
10 * Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
11 \***************************************************************************/
14 * Définition des noeuds de l'arbre de syntaxe abstraite
16 * @package SPIP\Compilateur\AST
19 if (!defined('_ECRIRE_INC_VERSION')) return;
23 * Description d'un contexte de compilation
25 * Objet simple pour stocker le nom du fichier, la ligne, la boucle
26 * permettant entre autre de localiser le lieu d'une erreur de compilation.
27 * Cette structure est nécessaire au traitement d'erreur à l'exécution.
29 * Le champ code est inutilisé dans cette classe seule, mais harmonise
30 * le traitement d'erreurs.
32 * @package SPIP\Compilateur\AST
36 * Description du squelette
38 * Sert pour la gestion d'erreur et la production de code dependant du contexte
40 * Peut contenir les index :
41 * - nom : Nom du fichier de cache
42 * - gram : Nom de la grammaire du squelette (détermine le phraseur à utiliser)
43 * - sourcefile : Chemin du squelette
44 * - squelette : Code du squelette
45 * - id_mere : Identifiant de la boucle parente
46 * - documents : Pour embed et img dans les textes
47 * - session : Pour un cache sessionné par auteur
48 * - niv : Niveau de tabulation
51 public $descr = array();
54 * Identifiant de la boucle
56 public $id_boucle = '';
59 * Numéro de ligne dans le code source du squelette
69 * Résultat de la compilation: toujours une expression PHP
76 * Description d'un texte
78 * @package SPIP\Compilateur\AST
84 public $type = 'texte';
92 * Contenu avant le texte.
94 * Vide ou apostrophe simple ou double si le texte en était entouré
95 * @var string|array */
99 * Contenu après le texte.
101 * Vide ou apostrophe simple ou double si le texte en était entouré
102 * @var string|array */
106 * Numéro de ligne dans le code source du squelette
112 * Description d'une inclusion de squelette
114 * @package SPIP\Compilateur\AST
120 public $type = 'include';
123 * Nom d'un fichier inclu
125 * - Objet Texte si inclusion d'un autre squelette
126 * - chaîne si inclusion d'un fichier PHP directement
127 * @var string|Texte */
131 * Inutilisé, propriété générique de l'AST
132 * @var string|array */
136 * Inutilisé, propriété générique de l'AST
137 * @var string|array */
141 * Numéro de ligne dans le code source du squelette
146 * Valeurs des paramètres
148 public $param = array();
153 * Description d'une boucle
155 * @package SPIP\Compilateur\AST
161 public $type = 'boucle';
164 * Identifiant de la boucle
169 * Identifiant de la boucle parente
171 public $id_parent ='';
174 * Partie optionnelle avant
175 * @var string|array */
179 * Pour chaque élément
180 * @var string|array */
184 * Partie optionnelle après
185 * @var string|array */
189 * Partie alternative, si pas de résultat dans la boucle
190 * @var string|array */
194 * La boucle doit-elle sélectionner la langue ?
195 * @var string|null */
199 * Alias de table d'application de la requête ou nom complet de la table SQL
200 * @var string|null */
201 public $type_requete;
204 * La table est elle optionnelle ?
206 * Si oui, aucune erreur ne sera générée si la table demandée n'est pas présente
208 public $table_optionnelle = false;
211 * Nom du fichier de connexion
213 public $sql_serveur = '';
216 * Paramètres de la boucle
218 * Description des paramètres passés à la boucle, qui servent ensuite
219 * au calcul des critères
222 public $param = array();
225 * Critères de la boucle
227 public $criteres = array();
230 * Textes insérés entre 2 éléments de boucle (critère inter)
232 public $separateur = array();
235 * Liste des jointures possibles avec cette table
237 * Les jointures par défaut de la table sont complétées en priorité
238 * des jointures déclarées explicitement sur la boucle
239 * @see base_trouver_table_dist()
241 public $jointures = array();
244 * Jointures explicites avec cette table
246 * Ces jointures sont utilisées en priorité par rapport aux jointures
247 * normales possibles pour retrouver les colonnes demandées extérieures
249 * @var string|bool */
250 public $jointures_explicites = false;
253 * Nom de la variable PHP stockant le noms de doublons utilisés "$doublons_index"
254 * @var string|null */
257 var $partie, $total_parties,$mode_partie='';
258 var $externe = ''; # appel a partir d'une autre boucle (recursion)
259 // champs pour la construction de la requete SQL
260 var $select = array();
262 var $from_type = array();
263 var $where = array();
265 var $having = array();
267 var $group = array();
268 var $order = array();
269 var $default_order = array();
273 var $sous_requete = false;
274 var $hierarchie = '';
275 var $statut = false; # definition/surcharge du statut des elements retournes
276 // champs pour la construction du corps PHP
281 var $numrows = false;
282 var $cptrows = false;
285 * Description du squelette
287 * Sert pour la gestion d'erreur et la production de code dependant du contexte
289 * Peut contenir les index :
290 * - nom : Nom du fichier de cache
291 * - gram : Nom de la grammaire du squelette (détermine le phraseur à utiliser)
292 * - sourcefile : Chemin du squelette
293 * - squelette : Code du squelette
294 * - id_mere : Identifiant de la boucle parente
295 * - documents : Pour embed et img dans les textes
296 * - session : Pour un cache sessionné par auteur
297 * - niv : Niveau de tabulation
300 public $descr = array();
303 * Numéro de ligne dans le code source du squelette
308 var $modificateur = array(); // table pour stocker les modificateurs de boucle tels que tout, plat ..., utilisable par les plugins egalement
310 var $iterateur = ''; // type d'iterateur
312 // obsoletes, conserves provisoirement pour compatibilite
319 * Description d'un critère de boucle
321 * Sous-noeud de Boucle
323 * @package SPIP\Compilateur\AST
329 public $type = 'critere';
332 * Opérateur (>, <, >=, IN, ...)
333 * @var null|string */
337 * Présence d'une négation (truc !op valeur)
338 * @var null|string */
342 * Présence d'une exclusion (!truc op valeur)
343 * @var null|string */
347 * Paramètres du critère
348 * - $param[0] : élément avant l'opérateur
349 * - $param[1..n] : éléments après l'opérateur
351 var $param = array();
354 * Numéro de ligne dans le code source du squelette
360 * Description d'un champ (balise SPIP)
362 * @package SPIP\Compilateur\AST
368 public $type = 'champ';
371 * Nom du champ demandé. Exemple 'ID_ARTICLE'
372 * @var string|null */
376 * Identifiant de la boucle parente si explicité
377 * @var string|null */
378 public $nom_boucle= '';
381 * Partie optionnelle avant
382 * @var null|string|array */
386 * Partie optionnelle après
387 * @var null|string|array */
391 * Étoiles : annuler des automatismes
393 * - '*' annule les filtres automatiques
394 * - '**' annule en plus les protections de scripts
395 * @var null|string */
399 * Arguments et filtres explicites sur la balise
400 * - $param[0] contient les arguments de la balise
401 * - $param[1..n] contient les filtres à appliquer à la balise
403 public $param = array();
406 * Source des filtres (compatibilité) (?)
408 public $fonctions = array();
411 * Identifiant de la boucle
413 public $id_boucle = '';
416 * AST du squelette, liste de toutes les boucles
421 * Alias de table d'application de la requête ou nom complet de la table SQL
422 * @var string|null */
423 public $type_requete;
426 * Résultat de la compilation: toujours une expression PHP
431 * Interdire les scripts
433 * false si on est sûr de cette balise
434 * @see interdire_scripts()
436 public $interdire_scripts = true;
439 * Description du squelette
441 * Sert pour la gestion d'erreur et la production de code dependant du contexte
443 * Peut contenir les index :
444 * - nom : Nom du fichier de cache
445 * - gram : Nom de la grammaire du squelette (détermine le phraseur à utiliser)
446 * - sourcefile : Chemin du squelette
447 * - squelette : Code du squelette
448 * - id_mere : Identifiant de la boucle parente
449 * - documents : Pour embed et img dans les textes
450 * - session : Pour un cache sessionné par auteur
451 * - niv : Niveau de tabulation
454 public $descr = array();
457 * Numéro de ligne dans le code source du squelette
462 * Drapeau pour reperer les balises calculées par une fonction explicite
464 public $balise_calculee = false;
469 * Description d'une chaîne de langue
475 public $type = 'idiome';
478 * Clé de traduction demandée. Exemple 'item_oui'
480 public $nom_champ = "";
483 * Module de langue où chercher la clé de traduction. Exemple 'medias'
488 * Arguments à passer à la chaîne
490 public $arg = array();
493 * Filtres à appliquer au résultat
495 public $param = array();
498 * Source des filtres (compatibilité) (?)
500 public $fonctions = array();
503 * Inutilisé, propriété générique de l'AST
504 * @var string|array */
508 * Inutilisé, propriété générique de l'AST
509 * @var string|array */
513 * Identifiant de la boucle
515 public $id_boucle = '';
518 * AST du squelette, liste de toutes les boucles
523 * Alias de table d'application de la requête ou nom complet de la table SQL
524 * @var string|null */
525 public $type_requete;
528 * Résultat de la compilation: toujours une expression PHP
533 * Interdire les scripts
534 * @see interdire_scripts()
536 public $interdire_scripts = false;
539 * Description du squelette
541 * Sert pour la gestion d'erreur et la production de code dependant du contexte
543 * Peut contenir les index :
544 * - nom : Nom du fichier de cache
545 * - gram : Nom de la grammaire du squelette (détermine le phraseur à utiliser)
546 * - sourcefile : Chemin du squelette
547 * - squelette : Code du squelette
548 * - id_mere : Identifiant de la boucle parente
549 * - documents : Pour embed et img dans les textes
550 * - session : Pour un cache sessionné par auteur
551 * - niv : Niveau de tabulation
554 public $descr = array();
557 * Numéro de ligne dans le code source du squelette
563 * Description d'un texte polyglotte (<multi>)
565 * @package SPIP\Compilateur\AST
571 public $type = 'polyglotte';
574 * Tableau des traductions possibles classées par langue
576 * Tableau code de langue => texte
578 var $traductions = array();
581 * Numéro de ligne dans le code source du squelette
588 global $table_criteres_infixes;
589 $table_criteres_infixes = array('<', '>', '<=', '>=', '==', '===', '!=', '!==', '<>', '?');
591 global $exception_des_connect;
592 $exception_des_connect[] = ''; // ne pas transmettre le connect='' par les inclure
597 * Déclarer les interfaces de la base pour le compilateur
599 * On utilise une fonction qui initialise les valeurs,
600 * sans écraser d'eventuelles prédéfinition dans mes_options
601 * et les envoie dans un pipeline
604 * @link http://doc.spip.org/@declarer_interfaces
608 function declarer_interfaces(){
609 global $exceptions_des_tables, $table_des_tables, $table_date, $table_titre, $table_statut;
611 $table_des_tables['articles']='articles';
612 $table_des_tables['auteurs']='auteurs';
613 $table_des_tables['rubriques']='rubriques';
614 $table_des_tables['hierarchie']='rubriques';
616 // definition des statuts de publication
617 global $tables_statut;
618 $table_statut = array();
621 // tableau des tables de jointures
622 // Ex: gestion du critere {id_mot} dans la boucle(ARTICLES)
623 global $tables_jointures;
624 $tables_jointures = array();
625 $tables_jointures['spip_jobs'][] = 'jobs_liens';
627 global $exceptions_des_jointures;
628 #$exceptions_des_jointures['titre_mot'] = array('spip_mots', 'titre'); // pour exemple
629 $exceptions_des_jointures['profondeur'] = array('spip_rubriques', 'profondeur');
631 global $table_des_traitements;
633 define('_TRAITEMENT_TYPO', 'typo(%s, "TYPO", $connect, $Pile[0])');
634 define('_TRAITEMENT_RACCOURCIS', 'propre(%s, $connect, $Pile[0])');
635 define('_TRAITEMENT_TYPO_SANS_NUMERO', 'typo(supprimer_numero(%s), "TYPO", $connect, $Pile[0])');
637 $table_des_traitements['BIO'][]= _TRAITEMENT_RACCOURCIS
;
638 $table_des_traitements['CHAPO'][]= _TRAITEMENT_RACCOURCIS
;
639 $table_des_traitements['DATE'][]= 'normaliser_date(%s)';
640 $table_des_traitements['DATE_REDAC'][]= 'normaliser_date(%s)';
641 $table_des_traitements['DATE_MODIF'][]= 'normaliser_date(%s)';
642 $table_des_traitements['DATE_NOUVEAUTES'][]= 'normaliser_date(%s)';
643 $table_des_traitements['DESCRIPTIF'][]= _TRAITEMENT_RACCOURCIS
;
644 $table_des_traitements['INTRODUCTION'][]= 'PtoBR('. _TRAITEMENT_RACCOURCIS
.')';
645 $table_des_traitements['NOM_SITE_SPIP'][]= _TRAITEMENT_TYPO
;
646 $table_des_traitements['NOM'][]= _TRAITEMENT_TYPO_SANS_NUMERO
;
647 $table_des_traitements['AUTEUR'][]= _TRAITEMENT_TYPO
;
648 $table_des_traitements['PS'][]= _TRAITEMENT_RACCOURCIS
;
649 $table_des_traitements['SOURCE'][]= _TRAITEMENT_TYPO
;
650 $table_des_traitements['SOUSTITRE'][]= _TRAITEMENT_TYPO
;
651 $table_des_traitements['SURTITRE'][]= _TRAITEMENT_TYPO
;
652 $table_des_traitements['TAGS'][]= '%s';
653 $table_des_traitements['TEXTE'][]= _TRAITEMENT_RACCOURCIS
;
654 $table_des_traitements['TITRE'][]= _TRAITEMENT_TYPO_SANS_NUMERO
;
655 $table_des_traitements['TYPE'][]= _TRAITEMENT_TYPO
;
656 $table_des_traitements['DESCRIPTIF_SITE_SPIP'][]= _TRAITEMENT_RACCOURCIS
;
657 $table_des_traitements['SLOGAN_SITE_SPIP'][]= _TRAITEMENT_TYPO
;
658 $table_des_traitements['ENV'][]= 'entites_html(%s,true)';
660 // valeur par defaut pour les balises non listees ci-dessus
661 $table_des_traitements['*'][]= false; // pas de traitement, mais permet au compilo de trouver la declaration suivante
662 // toujours securiser les DATA
663 $table_des_traitements['*']['DATA']= 'safehtml(%s)';
664 // expliciter pour VALEUR qui est un champ calcule et ne sera pas protege par le catch-all *
665 $table_des_traitements['VALEUR']['DATA']= 'safehtml(%s)';
668 // gerer l'affectation en 2 temps car si le pipe n'est pas encore declare, on ecrase les globales
669 $interfaces = pipeline('declarer_tables_interfaces',
671 'table_des_tables'=>$table_des_tables,
672 'exceptions_des_tables'=>$exceptions_des_tables,
673 'table_date'=>$table_date,
674 'table_titre'=>$table_titre,
675 'tables_jointures'=>$tables_jointures,
676 'exceptions_des_jointures'=>$exceptions_des_jointures,
677 'table_des_traitements'=>$table_des_traitements,
678 'table_statut'=>$table_statut,
681 $table_des_tables = $interfaces['table_des_tables'];
682 $exceptions_des_tables = $interfaces['exceptions_des_tables'];
683 $table_date = $interfaces['table_date'];
684 $table_titre = $interfaces['table_titre'];
685 $tables_jointures = $interfaces['tables_jointures'];
686 $exceptions_des_jointures = $interfaces['exceptions_des_jointures'];
687 $table_des_traitements = $interfaces['table_des_traitements'];
688 $table_statut = $interfaces['table_statut'];
692 declarer_interfaces();