source: spip-zone/_plugins_/iterateurs/public/iterateur.php @ 44794

Last change on this file since 44794 was 44794, checked in by fil@…, 10 years ago

prendre en compte le critere {cle IN a,b} ou {valeur !IN 1,2} dans les boucles DATA (shaphyr)

File size: 13.1 KB
Line 
1<?php
2
3
4/***************************************************************************\
5 *  SPIP, Systeme de publication pour l'internet                           *
6 *                                                                         *
7 *  Copyright (c) 2001-2011                                                *
8 *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
9 *                                                                         *
10 *  Ce programme est un logiciel libre distribue sous licence GNU/GPL.     *
11 *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
12\***************************************************************************/
13
14if (!defined('_ECRIRE_INC_VERSION')) return;
15
16/**
17 * Fabrique d'iterateur
18 * permet de charger n'importe quel iterateur IterateurXXX
19 * fourni dans le fichier iterateurs/xxx.php
20 *
21 */
22class IterFactory{
23        public static function create($iterateur, $command, $info=null){
24
25                // cas des SI {si expression} analises tres tot
26                // pour eviter le chargement de tout iterateur
27                if (isset($command['si'])) {
28                        foreach ($command['si'] as $si) {
29                                if (!$si) {
30                                        return new IterDecorator(new EmptyIterator(), $command, $info);
31                                }
32                        }
33                }
34
35                // chercher un iterateur PHP existant (par exemple dans SPL)
36                // (il faudrait passer l'argument ->serveur
37                // pour etre certain qu'on est sur un "php:")
38                if (class_exists($iterateur)) {
39                        $a = isset($command['args']) ? $command['args'] : array() ;
40
41                        // permettre de passer un Iterateur directement {args #ITERATEUR} :
42                        // si on recoit deja un iterateur en argument, on l'utilise
43                        if (count($a)==1 and is_object($a[0]) and is_subclass_of($a[0], 'Iterator')) {
44                                $iter = $a[0];
45
46                        // sinon, on cree un iterateur du type donne
47                        } else {                                                       
48                                // arguments de creation de l'iterateur...
49                                // (pas glop)
50                                try {
51                                        switch (count($a)) {
52                                                case 0:    $iter = new $iterateur();  break;
53                                                case 1:    $iter = new $iterateur($a[0]);  break;
54                                                case 2:    $iter = new $iterateur($a[0], $a[1]);  break;
55                                                case 3:    $iter = new $iterateur($a[0], $a[1], $a[2]);  break;
56                                                case 4:    $iter = new $iterateur($a[0], $a[1], $a[2], $a[3]);  break;
57                                        }
58                                } catch (Exception $e) {
59                                        spip_log("Erreur de chargement de l'iterateur $iterateur");
60                                        spip_log($e->getMessage());
61                                        $iter = new EmptyIterator();
62                                }
63                        }
64                } else {
65                        // chercher la classe d'iterateur
66                        // IterateurXXX
67                        // definie dans le fichier iterateurs/xxx.php
68                        $class = "Iterateur".$iterateur;
69                        if (!include_spip("iterateur/" . strtolower($iterateur))
70                          OR !class_exists($class)) {
71                                die("Iterateur $iterateur non trouv&#233;");
72                                // si l'iterateur n'existe pas, on se rabat sur le generique
73                                $iter = new EmptyIterator();
74                        } else {
75                                $iter = new $class($command, $info);
76                        }
77                }
78                return new IterDecorator($iter, $command, $info);
79        }
80}
81
82
83
84
85class IterDecorator extends FilterIterator {
86        private $iter;
87
88        /**
89         * Conditions de filtrage
90         * ie criteres de selection
91         * @var array
92         */
93        protected $filtre = array();
94
95        /**
96         * Fonction de filtrage compilee a partir des criteres de filtre
97         * @var string
98         */
99        protected $func_filtre = null;
100
101        /**
102         * Critere {offset, limit}
103         * @var int
104         * @var int
105         */
106        protected $offset = null;
107        protected $limit = null;
108
109        /**
110         * nombre d'elements recuperes depuis la position 0,
111         * en tenant compte des filtres
112         * @var int
113         */
114        protected $fetched=0;
115
116        /**
117         * Drapeau a activer en cas d'echec
118         * (select SQL errone, non chargement des DATA, etc)
119         */
120        public function err() {
121                if (method_exists($this->iter, 'err'))
122                        return $this->iter->err();
123                if (property_exists($this->iter, 'err'))
124                        return $this->iter->err;
125                return false;
126        }
127
128        public function __construct(Iterator $iter, $command, $info){
129                parent::__construct($iter);
130                parent::rewind(); // remettre a la premiere position (bug? connu de FilterIterator)
131               
132                // recuperer l'iterateur transmis
133                $this->iter = $this->getInnerIterator();
134                $this->command = $command;
135                $this->info = $info;
136                $this->pos = 0;
137                $this->fetched = 0;
138
139                // chercher la liste des champs a retourner par
140                // fetch si l'objet ne les calcule pas tout seul
141                if (!method_exists($this->iter, 'fetch')) {
142                        $this->calculer_select();
143                        $this->calculer_filtres();
144                }
145
146                $this->err = $this->iter->err;
147
148                $this->total = $this->count();
149        }
150
151
152        // calcule les elements a retournes par fetch()
153        // enleve les elements inutiles du select()
154        //
155        private function calculer_select() {
156                if ($select = &$this->command['select']) {
157                        foreach($select as $s) {
158                                // /!\ $s = '.nom'
159                                if ($s[0] == '.') {
160                                        $s = substr($s, 1);
161                                }
162                                $this->select[] = $s;
163                        }
164                }
165        }
166
167        // recuperer la valeur d'une balise #X
168        // en fonction des methodes
169        // et proprietes disponibles
170        public function get_select($nom) {
171                if (is_object($this->iter)
172                AND method_exists($this->iter, $nom)) {
173                        try {
174                                return $this->iter->$nom();
175                        } catch(Exception $e) {
176                                // #GETCHILDREN sur un fichier de DirectoryIterator ...
177                                spip_log("Methode $nom en echec sur " . get_class($this->iter));
178                                spip_log("Cela peut être normal : retour d'une ligne de resultat ne pouvant pas calculer cette methode");
179                                return '';
180                        }
181                }
182                /*
183                if (property_exists($this->iter, $nom)) {
184                        return $this->iter->$nom;
185                }*/
186                // cle et valeur par defaut
187                // ICI PLANTAGE SI ON NE CONTROLE PAS $nom
188                if (in_array($nom, array('cle', 'valeur'))
189                AND method_exists($this, $nom)) {
190                        return $this->$nom();
191                }
192
193                // Par defaut chercher en xpath dans la valeur()
194                return Iterateurs_table_valeur($this->valeur(), $nom);
195        }
196
197       
198        private function calculer_filtres() {
199               
200                // Issu de calculer_select() de public/composer L.519
201                // [todo] externaliser...
202                //
203                // retirer les criteres vides:
204                // {X ?} avec X absent de l'URL
205                // {par #ENV{X}} avec X absent de l'URL
206                // IN sur collection vide (ce dernier devrait pouvoir etre fait a la compil)
207                if ($where = &$this->command['where']) {
208                        $menage = false;
209                        foreach($where as $k => $v) { 
210                                if (is_array($v)){
211                                        if ((count($v)>=2) && ($v[0]=='REGEXP') && ($v[2]=="'.*'")) $op= false;
212                                        elseif ((count($v)>=2) && ($v[0]=='LIKE') && ($v[2]=="'%'")) $op= false;
213                                        else $op = $v[0] ? $v[0] : $v;
214                                } else $op = $v;
215                                if ((!$op) OR ($op==1) OR ($op=='0=0')) {
216                                        unset($where[$k]);
217                                        $menage = true;
218                                }
219                                // traiter {cle IN a,b} ou {valeur !IN a,b}
220                                if (preg_match(',^\(\(([\w/]+)(\s+NOT)?\s+IN\s+(\(.*\))\)\)$,', $op, $regs)) {
221                                        $this->ajouter_filtre($regs[1], 'IN', $regs[3], $regs[2]);
222                                        unset($op);
223                                }
224                        }
225                        foreach($where as $k => $v) {
226                                // 3 possibilites : count($v) =
227                                // * 1 : {x y} ; on recoit $v[0] = y
228                                // * 2 : {x !op y} ; on recoit $v[0] = 'NOT', $v[1] = array() // array du type {x op y}
229                                // * 3 : {x op y} ; on recoit $v[0] = 'op', $v[1] = x, $v[2] = y
230
231                                // 1 : forcement traite par un critere, on passe
232                                if (count($v) == 1) {
233                                        continue;
234                                }
235                                if (count($v) == 2) {
236                                        $this->ajouter_filtre($v[1][1], $v[1][0], $v[1][2], 'NOT');
237                                }
238                                if (count($v) == 3) {
239                                        $this->ajouter_filtre($v[1], $v[0], $v[2]);
240                                }
241                        }
242                }
243
244                // critere {2,7}
245                if ($this->command['limit']) {
246                        $limit = explode(',',$this->command['limit']);
247                        $this->offset = $limit[0];
248                        $this->limit = $limit[1];
249                }
250
251                // Creer la fonction de filtrage sur $this
252                if ($this->filtre) {
253                        $this->func_filtre = create_function('$me', $b = 'return ('.join(') AND (', $this->filtre).');');
254                }
255        }
256
257
258
259        protected function ajouter_filtre($cle, $op, $valeur, $not=false) {
260                if (method_exists($this->iter, 'exception_des_criteres')) {
261                        if (in_array($cle, $this->iter->exception_des_criteres())) {
262                                return;
263                        }
264                }
265                # [todo ?] analyser le filtre pour refuser ce qu'on ne sait pas traiter ?
266                # mais c'est normalement deja opere par calculer_critere_infixe()
267                # qui regarde la description 'desc' (en casse reelle d'ailleurs : {isDir=1}
268                # ne sera pas vu si l'on a defini desc['field']['isdir'] pour que #ISDIR soit present.
269                # il faudrait peut etre definir les 2 champs isDir et isdir... a reflechir...
270               
271                # if (!in_array($cle, array('cle', 'valeur')))
272                #       return;
273
274                $a = '$me->get_select(\''.$cle.'\')';
275
276                $filtre = '';
277               
278                if ($op == 'REGEXP') {
279                        $filtre = 'match('.$a.', '.str_replace('\"', '"', $valeur).')';
280                        $op = '';
281                } else if ($op == 'LIKE') {
282                        $valeur = str_replace(array('\"', '_', '%'), array('"', '.', '.*'), preg_quote($valeur));
283                        $filtre = 'match('.$a.', '.$valeur.')';
284                        $op = '';
285                } else if ($op == '=') {
286                        $op = '==';
287                } else if ($op == 'IN') {
288                        $filtre = 'in_array('.$a.', array'.$valeur.')';
289                        $op = '';
290                } else if (!in_array($op, array('<','<=', '>', '>='))) {
291                        spip_log('operateur non reconnu ' . $op); // [todo] mettre une erreur de squelette
292                        $op = '';
293                }
294       
295                if ($op)
296                        $filtre = $a.$op.str_replace('\"', '"', $valeur);
297
298                if ($not)
299                        $filtre = "!($filtre)";
300                       
301                if ($filtre) {
302                        $this->filtre[] = $filtre;
303                }
304        }
305
306       
307        public function next(){
308                $this->pos++;
309                parent::next();
310        }
311
312        /**
313         * revient au depart
314         * @return void
315         */
316        public function rewind() {
317                $this->pos = 0;
318                $this->fetched = 0;
319                parent::rewind();
320        }
321
322
323        # Extension SPIP des iterateurs PHP
324        /**
325         * type de l'iterateur
326         * @var string
327         */
328        protected $type;
329
330        /**
331         * parametres de l'iterateur
332         * @var array
333         */
334        protected $command;
335
336        /**
337         * infos de compilateur
338         * @var array
339         */
340        protected $info;
341
342        /**
343         * position courante de l'iterateur
344         * @var int
345         */
346        protected $pos=null;
347
348        /**
349         * nombre total resultats dans l'iterateur
350         * @var int
351         */
352        protected $total=null;
353
354        /**
355         * nombre maximal de recherche pour $total
356         * si l'iterateur n'implemente pas de fonction specifique
357         */
358         protected $max=100000;
359
360
361        /**
362         * Liste des champs a inserer dans les $row
363         * retournes par ->fetch()
364         */
365         protected $select=array();
366
367         
368        /**
369         * aller a la position absolue n,
370         * comptee depuis le debut
371         *
372         * @param int $n
373         *   absolute pos
374         * @param string $continue
375         *   param for sql_ api
376         * @return bool
377         *   success or fail if not implemented
378         */
379        public function seek($n=0, $continue=null) {
380                if ($this->func_filtre OR !method_exists($this->iter, 'seek') OR !$this->iter->seek($n)) {
381                        $this->seek_loop($n);
382                }
383                $this->pos = $n;
384                $this->fetched = $n;
385                return true;
386        }
387
388        /*
389         * aller a la position $n en parcourant
390         * un par un tous les elements
391         */
392        private function seek_loop($n) {
393                if ($this->pos > $n)
394                        $this->rewind();
395
396                while ($this->pos < $n AND $this->valid()) {
397                        $this->next();
398                }
399               
400                return true;
401        }
402
403        /**
404         * Avancer de $saut pas
405         * @param  $saut
406         * @param  $max
407         * @return int
408         */
409        public function skip($saut, $max=null){
410                // pas de saut en arriere autorise pour cette fonction
411                if (($saut=intval($saut))<=0) return $this->pos;
412                $seek = $this->pos + $saut;
413                // si le saut fait depasser le maxi, on libere la resource
414                // et on sort
415                if (is_null($max))
416                        $max = $this->count();
417
418                if ($seek>=$max OR $seek>=$this->count()) {
419                        // sortie plus rapide que de faire next() jusqu'a la fin !
420                        $this->free();
421                  return $max;
422                }
423
424          $this->seek($seek);
425          return $this->pos;
426        }
427
428        /**
429         * Renvoyer un tableau des donnees correspondantes
430         * a la position courante de l'iterateur
431         * en controlant si on respecte le filtre
432         * Appliquer aussi le critere {offset,limit}
433         *
434         * @return array|bool
435         */
436        public function fetch() {
437                if (method_exists($this->iter, 'fetch')) {
438                        return $this->iter->fetch();
439                } else {
440
441                        while ($this->valid()
442                        AND (
443                                !$this->accept()
444                                OR (isset($this->offset) AND $this->fetched++ < $this->offset)
445                        ))
446                                $this->next();
447
448                        if (!$this->valid())
449                                return false;
450
451                        if (isset($this->limit)
452                        AND $this->fetched > $this->offset + $this->limit)
453                                return false;
454
455                        $r = array();
456                        foreach ($this->select as $nom) {
457                                $r[$nom] = $this->get_select($nom);
458                        }
459                        $this->next();
460                        return $r;
461                }
462        }
463
464        // retourner la cle pour #CLE
465        public function cle() {
466                return $this->key();
467        }
468       
469        // retourner la valeur pour #VALEUR
470        public function valeur() {
471                # attention PHP est mechant avec les objets, parfois il ne les
472                # clone pas proprement (directoryiterator sous php 5.2.2)
473                # on se rabat sur la version __toString()
474                if (is_object($v = $this->current())) {
475                        if (method_exists($v, '__toString'))
476                                $v = $v->__toString();
477                        else
478                                $v = (array) $v;
479                }
480                return $v;
481        }
482
483        /**
484         * Accepte-t-on l'entree courante lue ?
485         * On execute les filtres pour le savoir.
486        **/
487        public function accept() {
488                if ($f = $this->func_filtre) {
489                        return $f($this);
490                }
491                return true;
492        }
493
494        /**
495         * liberer la ressource
496         * @return bool
497         */
498        public function free() {
499                if (method_exists($this->iter, 'free')) {
500                        $this->iter->free();
501                }
502                $this->pos = $this->total = 0;
503                return true;
504        }
505
506        /**
507         * Compter le nombre total de resultats
508         * pour #TOTAL_BOUCLE
509         * @return int
510         */
511        public function count() {
512                if (is_null($this->total)) {
513                        if (method_exists($this->iter, 'count')
514                        AND !$this->func_filtre) {
515                                return $this->total = $this->iter->count();
516                        } else {
517                                // compter les lignes et rembobiner
518                                $total = 0;
519                                $pos = $this->pos; // sauver la position
520                                $this->rewind();
521                                while ($this->fetch() and $total < $this->max) {
522                                        $total++;
523                                }
524                                $this->seek($pos);
525                                $this->total = $total;
526                        }
527                }
528
529                return $this->total;
530        }
531       
532}
533
534
535?>
Note: See TracBrowser for help on using the repository browser.