source: spip-zone/_plugins_/polyhierarchie/branches/v2.0/urls/arbopoly.php @ 100811

Last change on this file since 100811 was 100811, checked in by cedric@…, 3 years ago

un peu de refactoring de code, plus malin et extensible

File size: 16.3 KB
Line 
1<?php
2
3/***************************************************************************\
4 *  SPIP, Systeme de publication pour l'internet                           *
5 *                                                                         *
6 *  Copyright (c) 2001-2016                                                *
7 *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
8 *                                                                         *
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\***************************************************************************/
12
13if (!defined("_ECRIRE_INC_VERSION")) {
14        return;
15} // securiser
16
17# donner un exemple d'url pour le formulaire de choix
18define('URLS_ARBOPOLY_EXEMPLE', '/article/titre');
19# specifier le form de config utilise pour ces urls
20define('URLS_ARBOPOLY_CONFIG', 'arbo');
21
22// TODO: une interface permettant de verifier qu'on veut effectivment modifier
23// une adresse existante
24defined('CONFIRMER_MODIFIER_URL') || define('CONFIRMER_MODIFIER_URL', false);
25
26include_spip('urls/arbo');
27
28/**
29 * Renseigner les infos les plus recentes de l'url d'un objet
30 * et de quoi la (re)construire si besoin
31 *
32 * @param string $type
33 * @param int $id_objet
34 * @param array $contexte
35 * @return bool|null|array
36 */
37function renseigner_url_arbopoly($type, $id_objet, $contexte = array()) {
38        $urls = array();
39        $trouver_table = charger_fonction('trouver_table', 'base');
40        $desc = $trouver_table(table_objet($type));
41        $table = $desc['table'];
42        $col_id = @$desc['key']["PRIMARY KEY"];
43        if (!$col_id) {
44                return false;
45        } // Quand $type ne reference pas une table
46        $id_objet = intval($id_objet);
47
48        $id_parent = (isset($contexte['id_parent'])?$contexte['id_parent']:null);
49
50        $champ_titre = $desc['titre'] ? $desc['titre'] : 'titre';
51
52        // parent
53        $champ_parent = url_arbo_parent($type);
54        $sel_parent = ', 0 as parent';
55        $order_by_parent = "";
56        if ($champ_parent) {
57                // si un parent est fourni est qu'il est polyhierarchique, on recherche une URL pour ce parent
58                if ($id_parent
59                        and reset($champ_parent) == 'id_rubrique'
60                        and sql_getfetsel('id_parent','spip_rubriques_liens','id_parent='.intval($id_parent).' AND objet='.sql_quote($type).' AND id_objet='.intval($id_objet))) {
61                        $sel_parent = ", ".intval($id_parent) . ' as parent';
62                        // trouver l'url qui matche le parent en premier
63                        $order_by_parent = "U.id_parent=".intval($id_parent)." DESC, ";
64                }
65                // sinon on prend son parent direct fourni par $champ_parent
66                else {
67                        $sel_parent = ", O." . reset($champ_parent) . ' as parent';
68                        // trouver l'url qui matche le parent en premier
69                        $order_by_parent = "O." . reset($champ_parent) . "=U.id_parent DESC, ";
70                }
71        }
72        //  Recuperer une URL propre correspondant a l'objet.
73        $row = sql_fetsel("U.url, U.date, U.id_parent, U.perma, $champ_titre $sel_parent",
74                "$table AS O LEFT JOIN spip_urls AS U ON (U.type='$type' AND U.id_objet=O.$col_id)",
75                "O.$col_id=$id_objet",
76                '',
77                $order_by_parent . 'U.perma DESC, U.date DESC', 1);
78        if ($row) {
79                $urls[$type][$id_objet] = $row;
80                $urls[$type][$id_objet]['type_parent'] = $champ_parent ? end($champ_parent) : '';
81        }
82
83        return isset($urls[$type][$id_objet]) ? $urls[$type][$id_objet] : null;
84}
85
86/**
87 * Retrouver/Calculer l'ensemble des segments d'url d'un objet
88 *
89 * @param string $type
90 * @param int $id_objet
91 * @param array $contexte
92 *   id_parent : rubrique parent
93 * @return string
94 */
95function declarer_url_arbopoly($type, $id_objet, $contexte = array()) {
96        static $urls = array();
97        // utiliser un cache memoire pour aller plus vite
98        if (!is_null($C = Cache())) {
99                return $C;
100        }
101        ksort($contexte);
102        $hash = json_encode($contexte);
103
104        // Se contenter de cette URL si elle existe ;
105        // sauf si on invoque par "voir en ligne" avec droit de modifier l'url
106
107        // l'autorisation est verifiee apres avoir calcule la nouvelle url propre
108        // car si elle ne change pas, cela ne sert a rien de verifier les autorisations
109        // qui requetent en base
110        $modifier_url = (defined('_VAR_URLS') and _VAR_URLS);
111
112        if (!isset($urls[$type][$id_objet][$hash]) or $modifier_url) {
113                $r = renseigner_url_arbopoly($type, $id_objet, $contexte);
114                // Quand $type ne reference pas une table
115                if ($r === false) {
116                        return false;
117                }
118
119                if (!is_null($r)) {
120                        $urls[$type][$id_objet][$hash] = $r;
121                }
122        }
123
124        if (!isset($urls[$type][$id_objet][$hash])) {
125                return "";
126        } # objet inexistant
127
128        $u = &$urls[$type][$id_objet][$hash];
129        $url_propre = $u['url'];
130
131        // si on a trouve l'url
132        // et que le parent est bon
133        // et (permanente ou pas de demande de modif)
134        if (!is_null($url_propre)
135                and $u['id_parent'] == $u['parent']
136                and ($u['perma'] or !$modifier_url)
137        ) {
138                return declarer_url_arbo_rec($url_propre, $type,
139                        isset($u['parent']) ? $u['parent'] : 0,
140                        isset($u['type_parent']) ? $u['type_parent'] : null);
141        }
142
143        // Si URL inconnue ou maj forcee sur une url non permanente, recreer une url
144        $url = $url_propre;
145        if (is_null($url_propre) or ($modifier_url and !$u['perma'])) {
146                $url = pipeline('arbo_creer_chaine_url',
147                        array(
148                                'data' => $url_propre,  // le vieux url_propre
149                                'objet' => array_merge($u, array('type' => $type, 'id_objet' => $id_objet)
150                                )
151                        )
152                );
153
154                // Eviter de tamponner les URLs a l'ancienne (cas d'un article
155                // intitule "auteur2")
156                include_spip('inc/urls');
157                $objets = urls_liste_objets();
158                if (preg_match(',^(' . $objets . ')[0-9]*$,', $url, $r)
159                        and $r[1] != $type
160                ) {
161                        $url = $url . _url_arbo_sep_id . $id_objet;
162                }
163        }
164
165
166        // Pas de changement d'url ni de parent
167        if ($url == $url_propre
168                and $u['id_parent'] == $u['parent']
169        ) {
170                return declarer_url_arbo_rec($url_propre, $type, $u['parent'], $u['type_parent']);
171        }
172
173        // verifier l'autorisation, maintenant qu'on est sur qu'on va agir
174        if ($modifier_url) {
175                include_spip('inc/autoriser');
176                $modifier_url = autoriser('modifierurl', $type, $id_objet);
177        }
178        // Verifier si l'utilisateur veut effectivement changer l'URL
179        if ($modifier_url
180                and CONFIRMER_MODIFIER_URL
181                and $url_propre
182                // on essaye pas de regenerer une url en -xxx (suffixe id anti collision)
183                and $url != preg_replace('/' . preg_quote(_url_propres_sep_id, '/') . '.*/', '', $url_propre)
184        ) {
185                $confirmer = true;
186        } else {
187                $confirmer = false;
188        }
189
190        if ($confirmer and !_request('ok')) {
191                die("vous changez d'url ? $url_propre -&gt; $url");
192        }
193
194        $set = array(
195                'url' => $url,
196                'type' => $type,
197                'id_objet' => $id_objet,
198                'id_parent' => $u['parent'],
199                'perma' => intval($u['perma'])
200        );
201        include_spip('action/editer_url');
202        if (url_insert($set, $confirmer, _url_arbo_sep_id)) {
203                $u['url'] = $set['url'];
204                $u['id_parent'] = $set['id_parent'];
205        } else {
206                // l'insertion a echoue,
207                //serveur out ? retourner au mieux
208                $u['url'] = $url_propre;
209        }
210
211        return declarer_url_arbo_rec($u['url'], $type, $u['parent'], $u['type_parent']);
212}
213
214/**
215 * Generer l'url arbo complete constituee des segments + debut + fin
216 *
217 * @param string $type
218 * @param int $id
219 * @param string $args
220 * @param string $ancre
221 * @return string
222 */
223function _generer_url_arbopoly($type, $id, $args = '', $ancre = '') {
224
225        if ($generer_url_externe = charger_fonction("generer_url_$type", 'urls', true)) {
226                $url = $generer_url_externe($id, $args, $ancre);
227                if (null != $url) {
228                        return $url;
229                }
230        }
231
232        // Mode propre
233        $c = array();
234        $propre = declarer_url_arbopoly($type, $id, $c);
235        parse_str($args, $contexte);
236        $champ_parent = url_arbo_parent($type);
237        if ($champ_parent
238          and $champ_parent = reset($champ_parent)
239          and isset($contexte[$champ_parent]) and $contexte[$champ_parent]) {
240                $c['id_parent'] = $contexte[$champ_parent];
241                $propre_contexte = declarer_url_arbopoly($type, $id, $c);
242                if ($propre_contexte !== $propre) {
243                        $propre = $propre_contexte;
244                        unset($contexte[$champ_parent]);
245                        $args = http_build_query($contexte);
246                }
247        }
248
249
250        if ($propre === false) {
251                return '';
252        } // objet inconnu. raccourci ?
253
254        if ($propre) {
255                $url = _debut_urls_arbo
256                        . rtrim($propre, '/')
257                        . url_arbo_terminaison($type);
258        } else {
259
260                // objet connu mais sans possibilite d'URL lisible, revenir au defaut
261                include_spip('base/connect_sql');
262                $id_type = id_table_objet($type);
263                $url = get_spip_script('./') . "?" . _SPIP_PAGE . "=$type&$id_type=$id";
264        }
265
266        // Ajouter les args
267        if ($args) {
268                $url .= ((strpos($url, '?') === false) ? '?' : '&') . $args;
269        }
270
271        // Ajouter l'ancre
272        if ($ancre) {
273                $url .= "#$ancre";
274        }
275
276        return _DIR_RACINE . $url;
277}
278
279
280/**
281 * API : retourner l'url d'un objet si i est numerique
282 * ou decoder cette url si c'est une chaine
283 * array([contexte],[type],[url_redirect],[fond]) : url decodee
284 *
285 * http://code.spip.net/@urls_arbo_dist
286 *
287 * @param string|int $i
288 * @param string $entite
289 * @param string|array $args
290 * @param string $ancre
291 * @return array|string
292 */
293function urls_arbopoly_dist($i, $entite, $args = '', $ancre = '') {
294        if (is_numeric($i)) {
295                return _generer_url_arbopoly($entite, $i, $args, $ancre);
296        }
297
298        // traiter les injections du type domaine.org/spip.php/cestnimportequoi/ou/encore/plus/rubrique23
299        if ($GLOBALS['profondeur_url'] > 0 and $entite == 'sommaire') {
300                $entite = 'type_urls';
301        }
302
303        // recuperer les &debut_xx;
304        if (is_array($args)) {
305                $contexte = $args;
306        } else {
307                parse_str($args, $contexte);
308        }
309
310        $url = $i;
311        $id_objet = $type = 0;
312        $url_redirect = null;
313
314        // Migration depuis anciennes URLs ?
315        // traiter les injections domain.tld/spip.php/n/importe/quoi/rubrique23
316        if ($GLOBALS['profondeur_url'] <= 0
317                and $_SERVER['REQUEST_METHOD'] != 'POST'
318        ) {
319                include_spip('inc/urls');
320                $r = nettoyer_url_page($i, $contexte);
321                if ($r) {
322                        list($contexte, $type, , , $suite) = $r;
323                        $_id = id_table_objet($type);
324                        $id_objet = $contexte[$_id];
325                        $url_propre = generer_url_entite($id_objet, $type);
326                        if (strlen($url_propre)
327                                and !strstr($url, $url_propre)
328                        ) {
329                                list(, $hash) = array_pad(explode('#', $url_propre), 2, null);
330                                $args = array();
331                                foreach (array_filter(explode('&', $suite)) as $fragment) {
332                                        if ($fragment != "$_id=$id_objet") {
333                                                $args[] = $fragment;
334                                        }
335                                }
336                                $url_redirect = generer_url_entite($id_objet, $type, join('&', array_filter($args)), $hash);
337
338                                return array($contexte, $type, $url_redirect, $type);
339                        }
340                }
341        }
342        /* Fin compatibilite anciennes urls */
343
344        // Chercher les valeurs d'environnement qui indiquent l'url-propre
345        $url_propre = preg_replace(',[?].*,', '', $url);
346
347        // Mode Query-String ?
348        if (!$url_propre
349                and preg_match(',[?]([^=/?&]+)(&.*)?$,', $url, $r)
350        ) {
351                $url_propre = $r[1];
352        }
353
354        if (!$url_propre
355                or $url_propre == _DIR_RESTREINT_ABS
356                or $url_propre == _SPIP_SCRIPT
357        ) {
358                return;
359        } // qu'est-ce qu'il veut ???
360
361
362        include_spip('base/abstract_sql'); // chercher dans la table des URLS
363
364        // Revenir en utf-8 si encodage type %D8%A7 (farsi)
365        $url_propre = rawurldecode($url_propre);
366
367        // Compatibilite avec .htm/.html et autres terminaisons
368        $t = array_diff(array_unique(array_merge(array('.html', '.htm', '/'), url_arbo_terminaison(''))), array(''));
369        if (count($t)) {
370                $url_propre = preg_replace('{('
371                        . implode('|', array_map('preg_quote', $t)) . ')$}i', '', $url_propre);
372        }
373
374        if (strlen($url_propre) and !preg_match(',^[^/]*[.]php,', $url_propre)) {
375                $parents_vus = array();
376
377                // recuperer tous les objets de larbo xxx/article/yyy/mot/zzzz
378                // on parcourt les segments de gauche a droite
379                // pour pouvoir contextualiser un segment par son parent
380                $url_arbo = explode('/', $url_propre);
381                $url_arbo_new = array();
382                $dernier_parent_vu = false;
383                $objet_segments = 0;
384                while (count($url_arbo) > 0) {
385                        $type = null;
386                        if (count($url_arbo) > 1) {
387                                $type = array_shift($url_arbo);
388                        }
389                        $url_segment = array_shift($url_arbo);
390                        // Rechercher le segment de candidat
391                        // si on est dans un contexte de parent, donne par le segment precedent,
392                        // prefixer le segment recherche avec ce contexte
393                        $cp = "0"; // par defaut : parent racine, id=0
394                        if ($dernier_parent_vu) {
395                                $cp = $parents_vus[$dernier_parent_vu];
396                        }
397                        // d'abord recherche avec prefixe parent, en une requete car aucun risque de colision
398                        $row = sql_fetsel('id_objet, type, url',
399                                'spip_urls',
400                                is_null($type)
401                                        ? "url=" . sql_quote($url_segment, '', 'TEXT')
402                                        : sql_in('url', array("$type/$url_segment", $type)),
403                                '',
404                                // en priorite celui qui a le bon parent et les deux segments
405                                // puis le bon parent avec 1 segment
406                                // puis un parent indefini (le 0 de preference) et les deux segments
407                                // puis un parent indefini (le 0 de preference) et 1 segment
408                                (intval($cp) ? "id_parent=" . intval($cp) . " DESC, " : "id_parent>=0 DESC, ") . "segments DESC, id_parent"
409                        );
410                        if ($row) {
411                                if (!is_null($type) and $row['url'] == $type) {
412                                        array_unshift($url_arbo, $url_segment);
413                                        $url_segment = $type;
414                                        $type = null;
415                                }
416                                $type = $row['type'];
417                                $col_id = id_table_objet($type);
418
419                                // le plus a droite l'emporte pour des objets presents plusieurs fois dans l'url (ie rubrique)
420                                $contexte[$col_id] = $row['id_objet'];
421
422                                $type_parent = '';
423                                if ($p = url_arbo_parent($type)) {
424                                        $type_parent = end($p);
425                                }
426                                // l'entite la plus a droite l'emporte, si le type de son parent a ete vu
427                                // sinon c'est un segment contextuel supplementaire a ignorer
428                                // ex : rub1/article/art1/mot1 : il faut ignorer le mot1, la vrai url est celle de l'article
429                                if (!$entite
430                                        or $dernier_parent_vu == $type_parent
431                                ) {
432                                        if ($objet_segments == 0) {
433                                                $entite = $type;
434                                        }
435                                } // sinon on change d'objet concerne
436                                else {
437                                        $objet_segments++;
438                                }
439
440                                $url_arbo_new[$objet_segments]['id_objet'] = $row['id_objet'];
441                                $url_arbo_new[$objet_segments]['objet'] = $type;
442                                $url_arbo_new[$objet_segments]['segment'][] = $row['url'];
443
444                                // on note le dernier parent vu de chaque type
445                                $parents_vus[$dernier_parent_vu = $type] = $row['id_objet'];
446                        } else {
447                                // un segment est inconnu
448                                if ($entite == '' or $entite == 'type_urls') {
449                                        // on genere une 404 comme il faut si on ne sait pas ou aller
450                                        return array(array(), '404');
451                                }
452                                // ici on a bien reconnu un segment en amont, mais le segment en cours est inconnu
453                                // on pourrait renvoyer sur le dernier segment identifie
454                                // mais de fait l'url entiere est inconnu : 404 aussi
455                                // mais conserver le contexte qui peut contenir un fond d'ou venait peut etre $entite (reecriture urls)
456                                return array($contexte, '404');
457                        }
458                }
459
460                if (count($url_arbo_new)) {
461                        $caller = debug_backtrace();
462                        $caller = $caller[1]['function'];
463                        // si on est appele par un autre module d'url c'est du decodage d'une ancienne URL
464                        // ne pas regenerer des segments arbo, mais rediriger vers la nouvelle URL
465                        // dans la nouvelle forme
466                        if (strncmp($caller, "urls_", 5) == 0 and $caller !== "urls_decoder_url") {
467                                // en absolue, car assembler ne gere pas ce cas particulier
468                                include_spip('inc/filtres_mini');
469                                $col_id = id_table_objet($entite);
470                                $url_new = generer_url_entite($contexte[$col_id], $entite);
471                                // securite contre redirection infinie
472                                if ($url_new !== $url_propre
473                                        and rtrim($url_new, "/") !== rtrim($url_propre, "/")
474                                ) {
475                                        $url_redirect = url_absolue($url_new);
476                                }
477                        } else {
478                                foreach ($url_arbo_new as $k => $o) {
479                                        $c = array();
480                                        if (isset($parents_vus['rubrique'])) {
481                                                $c['id_parent'] = $parents_vus['rubrique'];
482                                        }
483                                        if ($s = declarer_url_arbopoly($o['objet'], $o['id_objet'], $c)) {
484                                                $url_arbo_new[$k] = $s;
485                                        } else {
486                                                $url_arbo_new[$k] = implode('/', $o['segment']);
487                                        }
488                                }
489                                $url_arbo_new = ltrim(implode('/', $url_arbo_new), '/');
490
491                                if ($url_arbo_new !== $url_propre) {
492                                        $url_redirect = $url_arbo_new;
493                                        // en absolue, car assembler ne gere pas ce cas particulier
494                                        include_spip('inc/filtres_mini');
495                                        $url_redirect = url_absolue($url_redirect);
496                                }
497                        }
498                }
499
500                // gerer le retour depuis des urls propres
501                if (($entite == '' or $entite == 'type_urls')
502                        and $GLOBALS['profondeur_url'] <= 0
503                ) {
504                        $urls_anciennes = charger_fonction('propres', 'urls');
505
506                        return $urls_anciennes($url_propre, $entite, $contexte);
507                }
508        }
509        if ($entite == '' or $entite == 'type_urls' /* compat .htaccess 2.0 */) {
510                if ($type) {
511                        $entite = objet_type($type);
512                } else {
513                        // Si ca ressemble a une URL d'objet, ce n'est pas la home
514                        // et on provoque un 404
515                        if (preg_match(',^[^\.]+(\.html)?$,', $url)) {
516                                $entite = '404';
517                                $contexte['erreur'] = ''; // qu'afficher ici ?  l'url n'existe pas... on ne sait plus dire de quel type d'objet il s'agit
518                        }
519                }
520        }
521        define('_SET_HTML_BASE', 1);
522
523        return array($contexte, $entite, $url_redirect, null);
524}
Note: See TracBrowser for help on using the repository browser.