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 * API d'édition de liens
16 * @package SPIP\Liens\API
19 if (!defined('_ECRIRE_INC_VERSION')) return;
25 * Teste l'existence de la table de liaison xxx_liens d'un objet
28 * @param string $objet
31 * - false si l'objet n'est pas associable.
32 * - array(clé primaire, nom de la table de lien) si associable
34 function objet_associable($objet){
35 $trouver_table = charger_fonction('trouver_table','base');
36 $table_sql = table_objet_sql($objet);
39 if ($primary = id_table_objet($objet)
40 AND $trouver_table($l = $table_sql."_liens")
41 AND !preg_match(',[^\w],',$primary)
42 AND !preg_match(',[^\w],',$l))
43 return array($primary,$l);
45 spip_log("Objet $objet non associable : ne dispose pas d'une cle primaire $primary OU d'une table liens $l");
50 * Associer un ou des objets à des objets listés
52 * $objets_source et $objets_lies sont de la forme
53 * array($objet=>$id_objets,...)
54 * $id_objets peut lui meme etre un scalaire ou un tableau pour une liste d'objets du meme type
55 * ou de la forme array("NOT",$id_objets) pour une selection par exclusion
57 * Les objets sources sont les pivots qui portent les liens
58 * et pour lesquels une table spip_xxx_liens existe
59 * (auteurs, documents, mots)
61 * on peut passer optionnellement une qualification du (des) lien(s) qui sera
62 * alors appliquee dans la foulee.
63 * En cas de lot de liens, c'est la meme qualification qui est appliquee a tous
66 * @param array $objets_source
67 * @param array|string $objets_lies
68 * @param array $qualif
71 function objet_associer($objets_source, $objets_lies, $qualif = null){
72 $modifs = objet_traiter_liaisons('lien_insert', $objets_source, $objets_lies);
75 objet_qualifier_liens($objets_source, $objets_lies, $qualif);
77 return $modifs; // pas d'erreur
82 * Dissocier un (ou des) objet(s) des objets listés
84 * $objets_source et $objets sont de la forme
85 * array($objet=>$id_objets,...)
86 * $id_objets peut lui meme etre un scalaire ou un tableau pour une liste d'objets du meme type
88 * Les objets sources sont les pivots qui portent les liens
89 * et pour lesquels une table spip_xxx_liens existe
90 * (auteurs, documents, mots)
92 * un * pour $objet,$id_objet permet de traiter par lot
93 * seul le type de l'objet source ne peut pas accepter de joker et doit etre explicite
96 * @param array $objets_source
97 * @param array|string $objets_lies
100 function objet_dissocier($objets_source,$objets_lies){
101 return objet_traiter_liaisons('lien_delete',$objets_source,$objets_lies);
107 * Qualifier le lien entre un (ou des) objet(s) et des objets listés
109 * $objets_source et $objets sont de la forme
110 * array($objet=>$id_objets,...)
111 * $id_objets peut lui meme etre un scalaire ou un tableau pour une liste d'objets du meme type
113 * Les objets sources sont les pivots qui portent les liens
114 * et pour lesquels une table spip_xxx_liens existe
115 * (auteurs, documents, mots)
117 * un * pour $objet,$id_objet permet de traiter par lot
118 * seul le type de l'objet source ne peut pas accepter de joker et doit etre explicite
121 * @param array $objets_source
122 * @param array|string $objets_lies
123 * @param array $qualif
126 function objet_qualifier_liens($objets_source,$objets_lies,$qualif){
127 return objet_traiter_liaisons('lien_set',$objets_source,$objets_lies,$qualif);
132 * Trouver les liens entre objets
134 * $objets_source et $objets sont de la forme
135 * array($objet=>$id_objets,...)
136 * $id_objets peut lui meme etre un scalaire ou un tableau pour une liste d'objets du meme type
138 * Les objets sources sont les pivots qui portent les liens
139 * et pour lesquels une table spip_xxx_liens existe
140 * (auteurs, documents, mots)
142 * un * pour $objet,$id_objet permet de traiter par lot
143 * seul le type de l'objet source ne peut pas accepter de joker et doit etre explicite
145 * renvoie une liste de tableaux decrivant chaque lien
146 * dans lequel objet_source et objet_lie sont aussi affectes avec l'id de chaque
150 * array('id_document'=>23,'objet'=>'article','id_objet'=>12,'vu'=>'oui',
151 * 'document'=>23,'article'=>12)
155 * @param array $objets_source
156 * @param array|string $objets_lies
159 function objet_trouver_liens($objets_source,$objets_lies){
160 return objet_traiter_liaisons('lien_find',$objets_source,$objets_lies);
165 * Nettoyer les liens morts vers des objets qui n'existent plus
167 * $objets_source et $objets sont de la forme
168 * array($objet=>$id_objets,...)
169 * $id_objets peut lui meme etre un scalaire ou un tableau pour une liste d'objets du meme type
171 * Les objets sources sont les pivots qui portent les liens
172 * et pour lesquels une table spip_xxx_liens existe
173 * (auteurs, documents, mots)
175 * un * pour $objet,$id_objet permet de traiter par lot
176 * seul le type de l'objet source ne peut pas accepter de joker et doit etre explicite
179 * @param array $objets_source
180 * @param array|string $objets_lies
183 function objet_optimiser_liens($objets_source,$objets_lies){
184 return objet_traiter_liaisons('lien_optimise',$objets_source,$objets_lies);
189 * Dupliquer tous les liens entrant ou sortants d'un objet
190 * vers un autre (meme type d'objet, mais id different)
191 * si $types est fourni, seuls les liens depuis/vers les types listes seront copies
192 * si $exclure_types est fourni, les liens depuis/vers les types listes seront ignores
195 * @param string $objet
196 * @param int $id_source
197 * @param int $id_cible
198 * @param array $types
199 * @param array $exclure_types
201 * Nombre de liens copiés
203 function objet_dupliquer_liens($objet,$id_source,$id_cible,$types=null,$exclure_types=null){
204 include_spip('base/objets');
205 $tables = lister_tables_objets_sql();
207 foreach($tables as $table_sql => $infos){
209 (is_null($types) OR in_array($infos['type'],$types))
210 AND (is_null($exclure_types) OR !in_array($infos['type'],$exclure_types))
212 if (objet_associable($infos['type'])){
213 $liens = (($infos['type']==$objet)?
214 objet_trouver_liens(array($objet=>$id_source),'*')
216 objet_trouver_liens(array($infos['type']=>'*'),array($objet=>$id_source)));
217 foreach($liens as $lien){
219 if ($infos['type']==$objet){
220 objet_associer(array($objet=>$id_cible),array($lien['objet']=>$lien[$lien['objet']]),$lien);
223 objet_associer(array($infos['type']=>$lien[$infos['type']]),array($objet=>$id_cible),$lien);
233 * Fonctions techniques
234 * ne pas les appeler directement
239 * Fonction générique qui
240 * applique une operation de liaison entre un ou des objets et des objets listés
241 * $objets_source et $objets_lies sont de la forme
242 * array($objet=>$id_objets,...)
243 * $id_objets peut lui meme etre un scalaire ou un tableau pour une liste d'objets du meme type
245 * Les objets sources sont les pivots qui portent les liens
246 * et pour lesquels une table spip_xxx_liens existe
247 * (auteurs, documents, mots)
249 * on peut passer optionnellement une qualification du (des) lien(s) qui sera
250 * alors appliquee dans la foulee.
251 * En cas de lot de liens, c'est la meme qualification qui est appliquee a tous
254 * @param string $operation
255 * @param array $objets_source
256 * @param array $objets_lies
258 * @return bool|int|array
260 function objet_traiter_liaisons($operation,$objets_source,$objets_lies, $set = null){
261 // accepter une syntaxe minimale pour supprimer tous les liens
262 if ($objets_lies=='*') $objets_lies = array('*'=>'*');
263 $modifs = 0; // compter le nombre de modifications
265 foreach($objets_source as $objet=>$ids){
266 if ($a = objet_associable($objet)) {
267 list($primary,$l) = $a;
270 elseif(reset($ids)=="NOT"){
271 // si on demande un array('NOT',...) => recuperer la liste d'ids correspondants
272 $where = lien_where($primary,$ids,'*','*');
273 $ids = sql_allfetsel($primary,$l,$where);
274 $ids = array_map('reset',$ids);
276 foreach($ids as $id) {
277 $res = $operation($objet,$primary,$l,$id,$objets_lies,$set);
279 spip_log("objet_traiter_liaisons [Echec] : $operation sur $objet/$primary/$l/$id",_LOG_ERREUR
);
283 $modifs=($modifs?
(is_array($res)?
array_merge($modifs,$res):$modifs+
$res):$res);
290 return ($echec?
false:$modifs); // pas d'erreur
295 * Sous fonction insertion
296 * qui traite les liens pour un objet source dont la clé primaire
297 * et la table de lien sont fournies
299 * $objets et de la forme
300 * array($objet=>$id_objets,...)
302 * Retourne le nombre d'insertions realisees
305 * @param string $objet_source
306 * @param string $primary
307 * @param sgring $table_lien
309 * @param array $objets
312 function lien_insert($objet_source,$primary,$table_lien,$id,$objets) {
315 foreach($objets as $objet => $id_objets){
316 if (!is_array($id_objets)) $id_objets = array($id_objets);
317 foreach($id_objets as $id_objet) {
318 $objet = ($objet=='*')?
$objet:objet_type($objet); # securite
319 // Envoyer aux plugins
320 $id_objet = pipeline('pre_edition_lien',
323 'table_lien' => $table_lien,
324 'objet_source' => $objet_source,
325 'id_objet_source' => $id,
327 'id_objet' => $id_objet,
333 if ($id_objet=intval($id_objet)
337 array('id_objet='.intval($id_objet), 'objet='.sql_quote($objet), $primary.'='.intval($id))))
340 $e = sql_insertq($table_lien, array('id_objet' => $id_objet, 'objet'=>$objet, $primary=>$id));
343 lien_propage_date_modif($objet,$id_objet);
344 lien_propage_date_modif($objet_source,$id);
345 // Envoyer aux plugins
346 pipeline('post_edition_lien',
349 'table_lien' => $table_lien,
350 'objet_source' => $objet_source,
351 'id_objet_source' => $id,
353 'id_objet' => $id_objet,
365 return ($echec?
false:$ins);
369 * Fabriquer la condition where en tenant compte des jokers *
372 * @param string $primary
373 * @param int|string|array $id_source
374 * @param string $objet
375 * @param int|string|array $id_objet
378 function lien_where($primary, $id_source, $objet, $id_objet){
379 if ((!is_array($id_source) AND !strlen($id_source))
381 OR (!is_array($id_objet) AND !strlen($id_objet)))
382 return array("0=1"); // securite
385 if (is_array($id_source) AND reset($id_source)=="NOT"){
386 $not = array_shift($id_source);
387 $id_source = reset($id_source);
390 if ($id_source!=='*')
391 $where[] = (is_array($id_source)?
sql_in(addslashes($primary),array_map('intval',$id_source),$not):addslashes($primary) . ($not?
"<>":"=") . intval($id_source));
393 $where[] = "0=1"; // idiot mais quand meme
396 if (is_array($id_objet) AND reset($id_objet)=="NOT"){
397 $not = array_shift($id_objet);
398 $id_objet = reset($id_objet);
402 $where[] = "objet=".sql_quote($objet);
404 $where[] = (is_array($id_objet)?
sql_in('id_objet',array_map('intval',$id_objet),$not):"id_objet" . ($not?
"<>":"=") . intval($id_objet));
406 $where[] = "0=1"; // idiot mais quand meme
412 * Sous fonction suppression
413 * qui traite les liens pour un objet source dont la clé primaire
414 * et la table de lien sont fournies
416 * $objets et de la forme
417 * array($objet=>$id_objets,...)
418 * un * pour $id,$objet,$id_objets permet de traiter par lot
421 * @param string $objet_source
422 * @param string $primary
423 * @param sgring $table_lien
425 * @param array $objets
428 function lien_delete($objet_source,$primary,$table_lien,$id,$objets){
432 foreach($objets as $objet => $id_objets){
433 $objet = ($objet=='*')?
$objet:objet_type($objet); # securite
434 if (!is_array($id_objets) OR reset($id_objets)=="NOT") $id_objets = array($id_objets);
435 foreach($id_objets as $id_objet) {
436 // id_objet peut valoir '*'
437 $where = lien_where($primary, $id, $objet, $id_objet);
438 // lire les liens existants pour propager la date de modif
439 $liens = sql_allfetsel("$primary,id_objet,objet",$table_lien,$where);
440 // iterer sur les liens pour permettre aux plugins de gerer
441 foreach($liens as $l){
442 // Envoyer aux plugins
443 $id_o = pipeline('pre_edition_lien',
446 'table_lien' => $table_lien,
447 'objet_source' => $objet_source,
448 'id_objet_source' => $l[$primary],
449 'objet' => $l['objet'],
450 'id_objet' => $l['id_objet'],
453 'data' => $l['id_objet']
456 if ($id_o=intval($id_o)){
457 $where = lien_where($primary, $l[$primary], $l['objet'], $id_o);
458 $e = sql_delete($table_lien, $where);
461 lien_propage_date_modif($l['objet'],$id_o);
462 lien_propage_date_modif($objet_source,$l[$primary]);
466 $retire[] = array('source'=>array($objet_source=>$l[$primary]),'lien'=>array($l['objet']=>$id_o),'type'=>$l['objet'],'id'=>$id_o);
467 // Envoyer aux plugins
468 pipeline('post_edition_lien',
471 'table_lien' => $table_lien,
472 'objet_source' => $objet_source,
473 'id_objet_source' => $l[$primary],
474 'objet' => $l['objet'],
485 pipeline('trig_supprimer_objets_lies',$retire);
487 return ($echec?
false:$dels);
492 * Sous fonction optimisation
493 * qui nettoie les liens morts (vers un objet inexistant)
494 * pour un objet source dont la clé primaire
495 * et la table de lien sont fournies
497 * $objets et de la forme
498 * array($objet=>$id_objets,...)
499 * un * pour $id,$objet,$id_objets permet de traiter par lot
502 * @param string $objet_source
503 * @param string $primary
504 * @param sgring $table_lien
506 * @param array $objets
509 function lien_optimise($objet_source,$primary,$table_lien,$id,$objets){
510 include_spip('genie/optimiser');
513 foreach($objets as $objet => $id_objets){
514 $objet = ($objet=='*')?
$objet:objet_type($objet); # securite
515 if (!is_array($id_objets) OR reset($id_objets)=="NOT") $id_objets = array($id_objets);
516 foreach($id_objets as $id_objet) {
517 $where = lien_where($primary, $id, $objet, $id_objet);
518 # les liens vers un objet inexistant
519 $r = sql_select("DISTINCT objet",$table_lien,$where);
520 while ($t = sql_fetch($r)){
522 $spip_table_objet = table_objet_sql($type);
523 $id_table_objet = id_table_objet($type);
524 $res = sql_select("L.$primary AS id,L.id_objet",
525 // la condition de jointure inclue L.objet='xxx' pour ne joindre que les bonnes lignes
526 // du coups toutes les lignes avec un autre objet ont un id_xxx=NULL puisque LEFT JOIN
527 // il faut les eliminier en repetant la condition dans le where L.objet='xxx'
529 LEFT JOIN $spip_table_objet AS O
530 ON (O.$id_table_objet=L.id_objet AND L.objet=".sql_quote($type).")",
531 "L.objet=".sql_quote($type)." AND O.$id_table_objet IS NULL");
532 // sur une cle primaire composee, pas d'autres solutions que de virer un a un
533 while ($row = sql_fetch($res)){
534 $e = sql_delete($table_lien, array("$primary=".$row['id'],"id_objet=".$row['id_objet'],"objet=".sql_quote($type)));
537 spip_log("Entree ".$row['id']."/".$row['id_objet']."/$type supprimee dans la table $table_lien",_LOG_INFO_IMPORTANTE
);
542 # les liens depuis un objet inexistant
543 $table_source = table_objet_sql($objet_source);
544 // filtrer selon $id, $objet, $id_objet eventuellement fournis
545 // (en general '*' pour chaque)
546 $where = lien_where("L.$primary", $id, $objet, $id_objet);
547 $where[] = "O.$primary IS NULL";
548 $res = sql_select("L.$primary AS id",
549 "$table_lien AS L LEFT JOIN $table_source AS O ON L.$primary=O.$primary",
551 $dels+
= optimiser_sansref($table_lien, $primary, $res);
554 return ($echec?
false:$dels);
559 * Sous fonction qualification
560 * qui traite les liens pour un objet source dont la clé primaire
561 * et la table de lien sont fournies
563 * $objets et de la forme
564 * array($objet=>$id_objets,...)
565 * un * pour $id,$objet,$id_objets permet de traiter par lot
568 * $qualif = array('vu'=>'oui');
571 * @param string $objet_source
572 * @param string $primary
573 * @param sgring $table_lien
575 * @param array $objets
576 * @param array $qualif
579 function lien_set($objet_source,$primary,$table_lien,$id,$objets,$qualif){
584 // nettoyer qualif qui peut venir directement d'un objet_trouver_lien :
585 unset($qualif[$primary]);
586 unset($qualif[$objet_source]);
587 if (isset($qualif['objet'])) {
588 unset($qualif[$qualif['objet']]);
590 unset($qualif['objet']);
591 unset($qualif['id_objet']);
592 foreach($objets as $objet => $id_objets){
593 $objet = ($objet=='*')?
$objet:objet_type($objet); # securite
594 if (!is_array($id_objets) OR reset($id_objets)=="NOT") $id_objets = array($id_objets);
595 foreach($id_objets as $id_objet) {
596 $where = lien_where($primary, $id, $objet, $id_objet);
597 $e = sql_updateq($table_lien,$qualif,$where);
604 return ($echec?
false:$ok);
608 * Sous fonction trouver
609 * qui cherche les liens pour un objet source dont la clé primaire
610 * et la table de lien sont fournies
612 * $objets et de la forme
613 * array($objet=>$id_objets,...)
614 * un * pour $id,$objet,$id_objets permet de traiter par lot
618 * @param string $objet_source
619 * @param string $primary
620 * @param sgring $table_lien
622 * @param array $objets
625 function lien_find($objet_source,$primary,$table_lien,$id,$objets){
627 foreach($objets as $objet => $id_objets){
628 $objet = ($objet=='*')?
$objet:objet_type($objet); # securite
629 // lien_where prend en charge les $id_objets sous forme int ou array
630 $where = lien_where($primary, $id, $objet, $id_objets);
631 $liens = sql_allfetsel('*',$table_lien,$where);
632 // ajouter les entrees objet_source et objet cible par convenance
633 foreach($liens as $l) {
634 $l[$objet_source] = $l[$primary];
635 $l[$objet] = $l['id_objet'];
643 * Propager la date_modif sur les objets dont un lien a été modifié
646 * @param string $objet
647 * @param array|int $ids
649 function lien_propage_date_modif($objet,$ids){
650 $trouver_table = charger_fonction('trouver_table','base');
652 $table = table_objet_sql($objet);
653 if ($desc = $trouver_table($table)
654 AND isset($desc['field']['date_modif'])){
655 $primary = id_table_objet($objet);
656 $where = (is_array($ids)?
sql_in($primary, array_map('intval',$ids)):"$primary=".intval($ids));
657 sql_updateq($table, array('date_modif'=>date('Y-m-d H:i:s')), $where);