www/prive/formulaires/editer_liens.php

   1 <?php
   2 /***************************************************************************\
   3  *  SPIP, Systeme de publication pour l'internet                           *
   4  *                                                                         *
   5  *  Copyright (c) 2001-2019                                                *
   6  *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
   7  *                                                                         *
   8  *  Ce programme est un logiciel libre distribue sous licence GNU/GPL.     *
   9  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
  10 \***************************************************************************/
  11
  12 /**
  13  * Gestion du formulaire d'édition de liens
  14  *
  15  * @package SPIP\Core\Formulaires
  16  **/
  17 if (!defined('_ECRIRE_INC_VERSION')) {
  18         return;
  19 }
  20
  21
  22 /**
  23  * Retrouve la source et l'objet de la liaison
  24  *
  25  * À partir des 3 premiers paramètres transmis au formulaire,
  26  * la fonction retrouve :
  27  * - l'objet dont on utilise sa table de liaison (table_source)
  28  * - l'objet et id_objet sur qui on lie des éléments (objet, id_objet)
  29  * - l'objet que l'on veut lier dessus (objet_lien)
  30  *
  31  * @param string $a
  32  * @param string|int $b
  33  * @param int|string $c
  34  * @return array
  35  *   ($table_source,$objet,$id_objet,$objet_lien)
  36  */
  37 function determine_source_lien_objet($a, $b, $c) {
  38         $table_source = $objet_lien = $objet = $id_objet = null;
  39         // auteurs, article, 23 :
  40         // associer des auteurs à l'article 23, sur la table pivot spip_auteurs_liens
  41         if (is_numeric($c) and !is_numeric($b)) {
  42                 $table_source = table_objet($a);
  43                 $objet_lien = objet_type($a);
  44                 $objet = objet_type($b);
  45                 $id_objet = $c;
  46         }
  47         // article, 23, auteurs
  48         // associer des auteurs à l'article 23, sur la table pivot spip_articles_liens
  49         if (is_numeric($b) and !is_numeric($c)) {
  50                 $table_source = table_objet($c);
  51                 $objet_lien = objet_type($a);
  52                 $objet = objet_type($a);
  53                 $id_objet = $b;
  54         }
  55
  56         return array($table_source, $objet, $id_objet, $objet_lien);
  57 }
  58
  59 /**
  60  * Chargement du formulaire d'édition de liens
  61  *
  62  * #FORMULAIRE_EDITER_LIENS{auteurs,article,23}
  63  *   pour associer des auteurs à l'article 23, sur la table pivot spip_auteurs_liens
  64  * #FORMULAIRE_EDITER_LIENS{article,23,auteurs}
  65  *   pour associer des auteurs à l'article 23, sur la table pivot spip_articles_liens
  66  * #FORMULAIRE_EDITER_LIENS{articles,auteur,12}
  67  *   pour associer des articles à l'auteur 12, sur la table pivot spip_articles_liens
  68  * #FORMULAIRE_EDITER_LIENS{auteur,12,articles}
  69  *   pour associer des articles à l'auteur 12, sur la table pivot spip_auteurs_liens
  70  *
  71  * @param string $a
  72  * @param string|int $b
  73  * @param int|string $c
  74  * @param array|bool $options
  75  *    - Si array, tableau d'options
  76  *    - Si bool : valeur de l'option 'editable' uniquement
  77  *
  78  * @return array
  79  */
  80 function formulaires_editer_liens_charger_dist($a, $b, $c, $options = array()) {
  81
  82         // compat avec ancienne signature ou le 4eme argument est $editable
  83         if (!is_array($options)) {
  84                 $options = array('editable' => $options);
  85         } elseif (!isset($options['editable'])) {
  86                 $options['editable'] = true;
  87         }
  88
  89         $editable = $options['editable'];
  90
  91         list($table_source, $objet, $id_objet, $objet_lien) = determine_source_lien_objet($a, $b, $c);
  92         if (!$table_source or !$objet or !$objet_lien or !$id_objet) {
  93                 return false;
  94         }
  95
  96         $objet_source = objet_type($table_source);
  97         $table_sql_source = table_objet_sql($objet_source);
  98
  99         // verifier existence de la table xxx_liens
 100         include_spip('action/editer_liens');
 101         if (!objet_associable($objet_lien)) {
 102                 return false;
 103         }
 104
 105         // L'éditabilité :) est définie par un test permanent (par exemple "associermots") ET le 4ème argument
 106         include_spip('inc/autoriser');
 107         $editable = ($editable and autoriser('associer' . $table_source, $objet, $id_objet)
 108                 and autoriser('modifier', $objet, $id_objet));
 109
 110         if (!$editable and !count(objet_trouver_liens(
 111                 array($objet_lien => '*'),
 112                 array(($objet_lien == $objet_source ? $objet : $objet_source) => $id_objet)
 113         ))) {
 114                 return false;
 115         }
 116
 117         // squelettes de vue et de d'association
 118         // ils sont différents si des rôles sont définis.
 119         $skel_vue = $table_source . '_lies';
 120         $skel_ajout = $table_source . '_associer';
 121
 122         // description des roles
 123         include_spip('inc/roles');
 124         if ($roles = roles_presents($objet_source, $objet)) {
 125                 // on demande de nouveaux squelettes en conséquence
 126                 $skel_vue = $table_source . '_roles_lies';
 127                 $skel_ajout = $table_source . '_roles_associer';
 128         }
 129
 130         $valeurs = array(
 131                 'id' => "$table_source-$objet-$id_objet-$objet_lien", // identifiant unique pour les id du form
 132                 '_vue_liee' => $skel_vue,
 133                 '_vue_ajout' => $skel_ajout,
 134                 '_objet_lien' => $objet_lien,
 135                 'id_lien_ajoute' => _request('id_lien_ajoute'),
 136                 'objet' => $objet,
 137                 'id_objet' => $id_objet,
 138                 'objet_source' => $objet_source,
 139                 'table_source' => $table_source,
 140                 'recherche' => '',
 141                 'visible' => 0,
 142                 'ajouter_lien' => '',
 143                 'supprimer_lien' => '',
 144                 'qualifier_lien' => '',
 145                 '_roles' => $roles, # description des roles
 146                 '_oups' => _request('_oups'),
 147                 'editable' => $editable,
 148         );
 149
 150         // les options non definies dans $valeurs sont passees telles quelles au formulaire html
 151         $valeurs = array_merge($options, $valeurs);
 152
 153         return $valeurs;
 154 }
 155
 156 /**
 157  * Traiter le post des informations d'édition de liens
 158  *
 159  * Les formulaires peuvent poster dans quatre variables
 160  * - ajouter_lien et supprimer_lien
 161  * - remplacer_lien
 162  * - qualifier_lien
 163  *
 164  * Les deux premières peuvent être de trois formes différentes :
 165  * ajouter_lien[]="objet1-id1-objet2-id2"
 166  * ajouter_lien[objet1-id1-objet2-id2]="nimportequoi"
 167  * ajouter_lien['clenonnumerique']="objet1-id1-objet2-id2"
 168  * Dans ce dernier cas, la valeur ne sera prise en compte
 169  * que si _request('clenonnumerique') est vrai (submit associé a l'input)
 170  *
 171  * remplacer_lien doit être de la forme
 172  * remplacer_lien[objet1-id1-objet2-id2]="objet3-id3-objet2-id2"
 173  * ou objet1-id1 est celui qu'on enleve et objet3-id3 celui qu'on ajoute
 174  *
 175  * qualifier_lien doit être de la forme, et sert en complément de ajouter_lien
 176  * qualifier_lien[objet1-id1-objet2-id2][role] = array("role1", "autre_role")
 177  * qualifier_lien[objet1-id1-objet2-id2][valeur] = array("truc", "chose")
 178  * produira 2 liens chacun avec array("role"=>"role1","valeur"=>"truc") et array("role"=>"autre_role","valeur"=>"chose")
 179  *
 180  * @param string $a
 181  * @param string|int $b
 182  * @param int|string $c
 183  * @param array|bool $options
 184  *    - Si array, tableau d'options
 185  *    - Si bool : valeur de l'option 'editable' uniquement
 186  *
 187  * @return array
 188  */
 189 function formulaires_editer_liens_traiter_dist($a, $b, $c, $options = array()) {
 190         // compat avec ancienne signature ou le 4eme argument est $editable
 191         if (!is_array($options)) {
 192                 $options = array('editable' => $options);
 193         } elseif (!isset($options['editable'])) {
 194                 $options['editable'] = true;
 195         }
 196
 197         $editable = $options['editable'];
 198
 199         $res = array('editable' => $editable ? true : false);
 200         list($table_source, $objet, $id_objet, $objet_lien) = determine_source_lien_objet($a, $b, $c);
 201         if (!$table_source or !$objet or !$objet_lien) {
 202                 return $res;
 203         }
 204
 205
 206         if (_request('tout_voir')) {
 207                 set_request('recherche', '');
 208         }
 209
 210         include_spip('inc/autoriser');
 211         if (autoriser('modifier', $objet, $id_objet)) {
 212                 // annuler les suppressions du coup d'avant !
 213                 if (_request('annuler_oups')
 214                         and $oups = _request('_oups')
 215                         and $oups = unserialize($oups)
 216                 ) {
 217                         if ($oups_objets = charger_fonction("editer_liens_oups_{$table_source}_{$objet}_{$objet_lien}", 'action', true)) {
 218                                 $oups_objets($oups);
 219                         } else {
 220                                 $objet_source = objet_type($table_source);
 221                                 include_spip('action/editer_liens');
 222                                 foreach ($oups as $oup) {
 223                                         if ($objet_lien == $objet_source) {
 224                                                 objet_associer(array($objet_source => $oup[$objet_source]), array($objet => $oup[$objet]), $oup);
 225                                         } else {
 226                                                 objet_associer(array($objet => $oup[$objet]), array($objet_source => $oup[$objet_source]), $oup);
 227                                         }
 228                                 }
 229                         }
 230                         # oups ne persiste que pour la derniere action, si suppression
 231                         set_request('_oups');
 232                 }
 233
 234                 $supprimer = _request('supprimer_lien');
 235                 $ajouter = _request('ajouter_lien');
 236
 237                 // il est possible de preciser dans une seule variable un remplacement :
 238                 // remplacer_lien[old][new]
 239                 if ($remplacer = _request('remplacer_lien')) {
 240                         foreach ($remplacer as $k => $v) {
 241                                 if ($old = lien_verifier_action($k, '')) {
 242                                         foreach (is_array($v) ? $v : array($v) as $kn => $vn) {
 243                                                 if ($new = lien_verifier_action($kn, $vn)) {
 244                                                         $supprimer[$old] = 'x';
 245                                                         $ajouter[$new] = '+';
 246                                                 }
 247                                         }
 248                                 }
 249                         }
 250                 }
 251
 252                 if ($supprimer) {
 253                         if ($supprimer_objets = charger_fonction(
 254                                 "editer_liens_supprimer_{$table_source}_{$objet}_{$objet_lien}",
 255                                 'action',
 256                                 true
 257                         )) {
 258                                 $oups = $supprimer_objets($supprimer);
 259                         } else {
 260                                 include_spip('action/editer_liens');
 261                                 $oups = array();
 262
 263                                 foreach ($supprimer as $k => $v) {
 264                                         if ($lien = lien_verifier_action($k, $v)) {
 265                                                 $lien = explode('-', $lien);
 266                                                 list($objet_source, $ids, $objet_lie, $idl, $role) = $lien;
 267                                                 // appliquer une condition sur le rôle si défini ('*' pour tous les roles)
 268                                                 $cond = (!is_null($role) ? array('role' => $role) : array());
 269                                                 if ($objet_lien == $objet_source) {
 270                                                         $oups = array_merge(
 271                                                                 $oups,
 272                                                                 objet_trouver_liens(array($objet_source => $ids), array($objet_lie => $idl), $cond)
 273                                                         );
 274                                                         objet_dissocier(array($objet_source => $ids), array($objet_lie => $idl), $cond);
 275                                                 } else {
 276                                                         $oups = array_merge(
 277                                                                 $oups,
 278                                                                 objet_trouver_liens(array($objet_lie => $idl), array($objet_source => $ids), $cond)
 279                                                         );
 280                                                         objet_dissocier(array($objet_lie => $idl), array($objet_source => $ids), $cond);
 281                                                 }
 282                                         }
 283                                 }
 284                         }
 285                         set_request('_oups', $oups ? serialize($oups) : null);
 286                 }
 287
 288                 if ($ajouter) {
 289                         if ($ajouter_objets = charger_fonction("editer_liens_ajouter_{$table_source}_{$objet}_{$objet_lien}", 'action', true)
 290                         ) {
 291                                 $ajout_ok = $ajouter_objets($ajouter);
 292                         } else {
 293                                 $ajout_ok = false;
 294                                 include_spip('action/editer_liens');
 295                                 foreach ($ajouter as $k => $v) {
 296                                         if ($lien = lien_verifier_action($k, $v)) {
 297                                                 $ajout_ok = true;
 298                                                 list($objet1, $ids, $objet2, $idl) = explode('-', $lien);
 299                                                 $qualifs = lien_retrouver_qualif($objet_lien, $lien);
 300                                                 if ($objet_lien == $objet1) {
 301                                                         lien_ajouter_liaisons($objet1, $ids, $objet2, $idl, $qualifs);
 302                                                 } else {
 303                                                         lien_ajouter_liaisons($objet2, $idl, $objet1, $ids, $qualifs);
 304                                                 }
 305                                                 set_request('id_lien_ajoute', $ids);
 306                                         }
 307                                 }
 308                         }
 309                         # oups ne persiste que pour la derniere action, si suppression
 310                         # une suppression suivie d'un ajout dans le meme hit est un remplacement
 311                         # non annulable !
 312                         if ($ajout_ok) {
 313                                 set_request('_oups');
 314                         }
 315                 }
 316         }
 317
 318
 319         return $res;
 320 }
 321
 322
 323 /**
 324  * Retrouver l'action de liaision demandée
 325  *
 326  * Les formulaires envoient une action dans un tableau ajouter_lien
 327  * ou supprimer_lien
 328  *
 329  * L'action est de la forme : objet1-id1-objet2-id2
 330  * ou de la forme : objet1-id1-objet2-id2-role
 331  *
 332  * L'action peut-être indiquée dans la clé ou dans la valeur.
 333  * Si elle est indiquee dans la valeur et que la clé est non numérique,
 334  * on ne la prend en compte que si un submit avec la clé a été envoyé
 335  *
 336  * @internal
 337  * @param string $k Clé du tableau
 338  * @param string $v Valeur du tableau
 339  * @return string Action demandée si trouvée, sinon ''
 340  */
 341 function lien_verifier_action($k, $v) {
 342         $action = '';
 343         if (preg_match(',^\w+-[\w*]+-[\w*]+-[\w*]+(-[\w*])?,', $k)) {
 344                 $action = $k;
 345         }
 346         if (preg_match(',^\w+-[\w*]+-[\w*]+-[\w*]+(-[\w*])?,', $v)) {
 347                 if (is_numeric($k)) {
 348                         $action = $v;
 349                 }
 350                 if (_request($k)) {
 351                         $action = $v;
 352                 }
 353         }
 354         // ajout un role null fictif (plus pratique) si pas défini
 355         if ($action and count(explode('-', $action)) == 4) {
 356                 $action .= '-';
 357         }
 358
 359         return $action;
 360 }
 361
 362
 363 /**
 364  * Retrouve le ou les qualificatifs postés avec une liaison demandée
 365  *
 366  * @internal
 367  * @param string $objet_lien
 368  *    objet qui porte le lien
 369  * @param string $lien
 370  *   Action du lien
 371  * @return array
 372  *   Liste des qualifs pour chaque lien. Tableau vide s'il n'y en a pas.
 373  **/
 374 function lien_retrouver_qualif($objet_lien, $lien) {
 375         // un role est défini dans la liaison
 376         $defs = explode('-', $lien);
 377         list($objet1, , $objet2, , $role) = $defs;
 378         if ($objet_lien == $objet1) {
 379                 $colonne_role = roles_colonne($objet1, $objet2);
 380         } else {
 381                 $colonne_role = roles_colonne($objet2, $objet1);
 382         }
 383
 384         // cas ou le role est defini en 5e argument de l'action sur le lien (suppression, ajout rapide sans autre attribut)
 385         if ($role) {
 386                 return array(
 387                         // un seul lien avec ce role
 388                         array($colonne_role => $role)
 389                 );
 390         }
 391
 392         // retrouver les rôles postés pour cette liaison, s'il y en a.
 393         $qualifier_lien = _request('qualifier_lien');
 394         if (!$qualifier_lien or !is_array($qualifier_lien)) {
 395                 return array();
 396         }
 397
 398         // pas avec l'action complete (incluant le role)
 399         $qualif = array();
 400         if ((!isset($qualifier_lien[$lien]) or !$qualif = $qualifier_lien[$lien])
 401                 and count($defs) == 5
 402         ) {
 403                 // on tente avec l'action sans le role
 404                 array_pop($defs);
 405                 $lien = implode('-', $defs);
 406                 if (!isset($qualifier_lien[$lien]) or !$qualif = $qualifier_lien[$lien]) {
 407                         $qualif = array();
 408                 }
 409         }
 410
 411         // $qualif de la forme array(role=>array(...),valeur=>array(...),....)
 412         // on le reforme en array(array(role=>..,valeur=>..,..),array(role=>..,valeur=>..,..),...)
 413         $qualifs = array();
 414         while (count($qualif)) {
 415                 $q = array();
 416                 foreach ($qualif as $att => $values) {
 417                         if (is_array($values)) {
 418                                 $q[$att] = array_shift($qualif[$att]);
 419                                 if (!count($qualif[$att])) {
 420                                         unset($qualif[$att]);
 421                                 }
 422                         } else {
 423                                 $q[$att] = $values;
 424                                 unset($qualif[$att]);
 425                         }
 426                 }
 427                 // pas de rôle vide
 428                 if (!$colonne_role or !isset($q[$colonne_role]) or $q[$colonne_role]) {
 429                         $qualifs[] = $q;
 430                 }
 431         }
 432
 433         return $qualifs;
 434 }
 435
 436 /**
 437  * Ajoute les liens demandés en prenant éventuellement en compte le rôle
 438  *
 439  * Appelle la fonction objet_associer. L'appelle autant de fois qu'il y
 440  * a de rôles demandés pour cette liaison.
 441  *
 442  * @internal
 443  * @param string $objet_source Objet source de la liaison (qui a la table de liaison)
 444  * @param array|string $ids Identifiants pour l'objet source
 445  * @param string $objet_lien Objet à lier
 446  * @param array|string $idl Identifiants pour l'objet lié
 447  * @param array $qualifs
 448  * @return void
 449  **/
 450 function lien_ajouter_liaisons($objet_source, $ids, $objet_lien, $idl, $qualifs) {
 451
 452         // retrouver la colonne de roles s'il y en a a lier
 453         if (is_array($qualifs) and count($qualifs)) {
 454                 foreach ($qualifs as $qualif) {
 455                         objet_associer(array($objet_source => $ids), array($objet_lien => $idl), $qualif);
 456                 }
 457         } else {
 458                 objet_associer(array($objet_source => $ids), array($objet_lien => $idl));
 459         }
 460 }