Subversion Repositories Applications.wikini

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
46 jpm 1
<?php
2
// declare(encoding='UTF-8');
3
/**
4
 * Web service de consultation d'un page wiki
5
 *
6
 * @category	php 5.2
7
 * @package		wapi
8
 * @author		Aurélien Peronnet < aurelien@tela-botanica.org>
9
 * @author		Jean-Pascal Milcent < jpm@tela-botanica.org>
10
 * @copyright	Copyright (c) 2011, Tela Botanica (accueil@tela-botanica.org)
11
 * @license		http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
12
 * @license		http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
13
 * @version		$Id$
14
 */
15
class Pages extends Service {
49 aurelien 16
 
46 jpm 17
	private $wiki = null;
18
	private $pageNom = null;
19
	private $section = null;
20
	private $creerPage = false;
21
	private $templateDefaut = null;
49 aurelien 22
 
23
	private $retour = 'txt';
46 jpm 24
	private $formats_retour = array('text/plain','text/html');
25
	private $format_texte;
49 aurelien 26
 
46 jpm 27
	const MIME_JSON = 'application/json';
28
	const MIME_HTML = 'text/html';
29
	const MIME_TEXT = 'text/plain';
49 aurelien 30
 
46 jpm 31
	public function consulter($ressources, $parametres) {
49 aurelien 32
 
46 jpm 33
		try {
34
			$this->definirValeurParDefautDesParametres();
35
			$this->verifierParametres($parametres);
36
			$this->analyserParametres($ressources, $parametres);
49 aurelien 37
 
46 jpm 38
			$page = $this->consulterPage($this->pageNom, $this->section);
49 aurelien 39
 
46 jpm 40
			if($page == null && $this->creerPage) {
41
				$this->creerPageAPartirTemplate($this->pageNom, $this->templateDefaut);
42
				$page = $this->consulterPage($this->pageNom, $this->section);
43
			}
49 aurelien 44
 
46 jpm 45
			$retour = $this->formaterRetour($page);
49 aurelien 46
 
46 jpm 47
			$this->envoyerContenuJson($retour);
48
		} catch (Exception $e) {
49
			$this->envoyerErreur($e);
50
		}
51
	}
49 aurelien 52
 
46 jpm 53
	private function definirValeurParDefautDesParametres() {
54
		if (isset($this->parametres['txt_format']) == false) {
55
			$this->parametres['txt_format'] = 'text/plain';
56
		}
57
	}
49 aurelien 58
 
46 jpm 59
	private function verifierParametres($parametres) {
60
		$erreurs = array();
49 aurelien 61
 
46 jpm 62
		if (isset($parametres['txt_format'])) {
63
			if(!in_array($parametres['txt_format'], $this->formats_retour)) {
64
				$message = "La valeur du paramètre 'txt.format' peut seulement prendre les valeurs : text/plain et text/html.";
65
				$erreurs[] = $message;
66
			}
67
		}
49 aurelien 68
 
46 jpm 69
		if (isset($parametres['txt_section_position']) && !is_numeric($parametres['txt_section_position'])) {
70
			$message = "La valeur du paramètre 'txt.section.position' peut seulement prendre des valeurs numeriques";
71
			$erreurs[] = $message;
72
		}
49 aurelien 73
 
46 jpm 74
		if (isset($parametres['txt_section_titre']) && trim($parametres['txt_section_titre']) == '') {
75
			$message = "La valeur du paramètre 'txt.section.titre' ne peut pas être vide si celui-ci est présent";
76
			$erreurs[] = $message;
77
		}
49 aurelien 78
 
46 jpm 79
		if (isset($parametres['txt_section_titre']) && trim($parametres['txt_section_titre']) == '') {
80
			$message = "La valeur du paramètre 'txt.section.titre' ne peut pas être vide si celui-ci est présent";
81
			$erreurs[] = $message;
82
		}
49 aurelien 83
 
46 jpm 84
		if (isset($parametres['txt_template']) && trim($parametres['txt_template']) == '') {
85
			$message = "La valeur du paramètre 'txt_template' ne peut pas être vide si celui-ci est présent";
86
			$erreurs[] = $message;
87
		}
49 aurelien 88
 
46 jpm 89
		if (count($erreurs) > 0) {
90
			$message = implode('<br />', $erreurs);
91
			$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
92
			throw new Exception($message, $code);
93
		}
94
	}
49 aurelien 95
 
96
	private function analyserParametres($ressources, $parametres) {
46 jpm 97
		$this->pageNom = $ressources[0];
98
		if (isset($parametres['txt_section_titre'])) {
99
			$this->section = $parametres['txt_section_titre'];
100
		}
101
		if (isset($parametres['txt_section_position'])) {
102
			$this->section = $parametres['txt_section_position'];
103
		}
104
		if (isset($parametres['txt_format'])) {
105
			$this->retour = $parametres['txt_format'];
106
		}
107
		if (isset($parametres['txt_template'])) {
108
			$this->creerPage = true;
109
			$this->templateDefaut = $parametres['txt_template'];
110
		}
111
	}
49 aurelien 112
 
46 jpm 113
	private function consulterPage($page, $section = null) {
49 aurelien 114
 
46 jpm 115
		$this->wiki = Registre::get('wikiApi');
116
		// La variable globale wiki est déclarée par les wiki et leurs plugins
117
		// un bug lié à certains plugin impose de la redéclarer et la réaffecter
118
		global $wiki;
119
		$wiki = $this->wiki;
120
		$this->wiki->setPageCourante($this->pageNom);
121
		$page = $this->wiki->LoadPage($page);
49 aurelien 122
 
46 jpm 123
		if ($page != null) {
49 aurelien 124
			// attention les wikis sont souvent en ISO !
46 jpm 125
			$page["body"] = $this->convertirTexteWikiVersEncodageAppli($page['body']);
126
			if($section != null) {
49 aurelien 127
				$sections_tab = explode(',', $section);
128
				if(count($sections_tab) > 1) {
129
					foreach($sections_tab as $section_t) {
130
						$page["sections"][$section_t] = $this->decouperPageSection($page["body"], $section_t);
131
					}
132
				} else {
133
					$page["body"] = $this->decouperPageSection($page["body"], $section);
134
				}
135
 
46 jpm 136
			}
137
		}
49 aurelien 138
 
46 jpm 139
		return $page;
140
	}
49 aurelien 141
 
46 jpm 142
	private function decouperPageSection($contenu_page, $section) {
143
		$section_retour = '';
144
		if (is_numeric($section)) {
145
			$section_retour =  $this->getSectionParNumero($contenu_page, $section);
146
		} else {
147
			$section_retour =  $this->getSectionParTitre($contenu_page, $section, false);
148
		}
149
		return $section_retour;
150
	}
49 aurelien 151
 
46 jpm 152
	public function getSectionParNumero($page, $num) {
153
		preg_match_all('/(=[=]+[ ]*)(.[.^=]*)+[ ]*=[=]+[.]*/i', $page, $sections, PREG_OFFSET_CAPTURE);
154
		$sectionTxt = '';
155
		$debut_section = 0;
156
		$lg_page = strlen($page);
157
		$fin_section = $lg_page;
49 aurelien 158
 
159
		if ($num <= count($sections[1]) && $num > 0) {
160
 
46 jpm 161
			$debut_section = $sections[1][$num - 1][1];
162
			$separateur = trim($sections[1][$num - 1][0]);
163
			$separateur_trouve = false;
49 aurelien 164
 
46 jpm 165
			for ($i = $num; $i < count($sections[1]); $i++) {
166
				$fin_section = $sections[1][$i][1];
167
				if($separateur == trim($sections[1][$i][0])) {
168
					$separateur_trouve = true;
169
					break;
170
				}
171
			}
49 aurelien 172
 
46 jpm 173
			$fin_section = $separateur_trouve ? $fin_section : $lg_page;
174
			$sectionTxt = substr($page, $debut_section, $fin_section - $debut_section);
49 aurelien 175
 
46 jpm 176
		} else {
177
			$sectionTxt = '';
178
		}
179
 
180
		return $sectionTxt;
181
	}
49 aurelien 182
 
46 jpm 183
	public function getSectionParTitre($page, $titre, $inclure_titre = false) {
184
		$section = '';
185
		$reg_exp = '/((=[=]+)[ ]*'.preg_quote(trim($titre), '/').'[ ]*=[=]+)[.]*/i';
186
		$match = preg_split($reg_exp, $page, 2, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
187
		if (count($match) > 3) {
188
			$section = explode(trim($match[2]), $match[3], 2);
189
			$section = $section[0];
190
			$section = ($inclure_titre) ? $match[1].$section : $section;
191
		} elseif (count($match) == 3) {
192
			$section = explode(trim($match[1]), $match[2], 2);
193
			$section = $section[0];
194
			$section = ($inclure_titre) ? $match[0].$section : $section;
195
		} else {
196
			$section = "";
197
		}
49 aurelien 198
 
46 jpm 199
		return $section;
200
	}
49 aurelien 201
 
46 jpm 202
	private function formaterRetour($page) {
203
 
204
		$mime = null;
205
		$texte = '';
49 aurelien 206
 
46 jpm 207
		switch ($this->retour) {
208
			case self::MIME_HTML:
209
				$texte = $this->wiki->Format($page["body"], "wakka");
49 aurelien 210
				if(!empty($page["sections"])) {
211
					foreach($page["sections"] as &$page_section) {
212
						$page_section = $this->wiki->Format($page_section, "wakka");
213
					}
214
				}
46 jpm 215
				$mime = self::MIME_HTML;
216
				break;
217
			default:
218
				$texte = $page["body"];
219
				$mime = self::MIME_TEXT;
220
		}
49 aurelien 221
 
46 jpm 222
		$url = $this->wiki->Href("", $this->pageNom);
49 aurelien 223
 
46 jpm 224
		$retour = array('id' => $this->pageNom,
225
				'titre' => $this->pageNom,
226
				'mime' => $mime,
227
				'texte' => $texte,
49 aurelien 228
				'sections' => $page["sections"],
46 jpm 229
				'href' => $url);
49 aurelien 230
 
46 jpm 231
		return $retour;
232
	}
49 aurelien 233
 
46 jpm 234
	private function creerPageAPartirTemplate($tag_page_a_creer, $tag_template) {
235
		$page_template = $this->consulterPage($tag_template);
236
		$corps_nouvelle_page = ($page_template != null) ? $page_template['body'] : '';
237
		// si le template n'existe pas, la page créée sera vide
49 aurelien 238
		$ecriture = $this->ecrirePage($tag_page_a_creer, $corps_nouvelle_page);
239
 
46 jpm 240
		return $ecriture;
241
	}
49 aurelien 242
 
46 jpm 243
	public function ajouter($ressources, $requeteDonnees) {
244
		return $this->modifier($ressources, $requeteDonnees);
245
	}
49 aurelien 246
 
46 jpm 247
	public function modifier($ressources, $requeteDonnees) {
248
 
249
		$requeteDonnees['pageTag'] = $ressources[0];
250
		$this->verifierParametresEcriture($requeteDonnees);
251
		$this->analyserParametresEcriture($requeteDonnees);
252
		$this->wiki = Registre::get('wikiApi');
253
		$this->wiki->setPageCourante($this->pageNom);
49 aurelien 254
 
46 jpm 255
		$texte = $requeteDonnees['pageContenu'];
256
		$page = $this->consulterPage($this->pageNom);
49 aurelien 257
 
46 jpm 258
		if ($page != null) {
49 aurelien 259
			$corps = ($this->section != null) ? $this->remplacerSection($this->section, $texte, $page['body']) : $texte;
46 jpm 260
		} else {
261
			$corps = $texte;
49 aurelien 262
		}
263
 
46 jpm 264
		$ecriture = $this->ecrirePage($this->pageNom, $corps);
49 aurelien 265
 
46 jpm 266
		if ($ecriture) {
267
			$this->envoyerCreationEffectuee();
268
		} else {
269
			$message = 'Impossible de créer ou modifier la page';
270
			$code = RestServeur::HTTP_CODE_ERREUR;
271
			throw new Exception($message, $code);
272
		}
49 aurelien 273
 
46 jpm 274
		return $ecriture;
275
	}
49 aurelien 276
 
46 jpm 277
	/**
49 aurelien 278
	 *
279
	 * Si la section demandée existe dans la page, renvoie un tableau contenant le numéro de caractère de
46 jpm 280
	 * début de la section, après son titre, ainsi que la longeur du titre
281
	 * @param string $titre de la section
282
	 * @param string $page contenu de la page wiki
283
	 * @return tableau associatif tel que décrit ici
284
	 */
285
	private function getInformationsPositionSection($titre, $page) {
49 aurelien 286
 
46 jpm 287
		preg_match_all('/(=[=]+[ ]*'.preg_quote(trim($titre), '/').'[ ]*=[=]+[.]*)/i', $page, $sections, PREG_OFFSET_CAPTURE);
288
		$longueur_titre = 0;
289
		$debut_section_apres_titre = 0;
49 aurelien 290
 
46 jpm 291
		if (count($sections) > 0 && is_array($sections[0]) && count($sections[0][0]) >= 2) {
292
			$longueur_titre = mb_strlen($sections[0][0][0]);
293
			$debut_section_apres_titre = $sections[0][0][1] + $longueur_titre;
294
		}
49 aurelien 295
 
46 jpm 296
		// ATTENTION : début contient le numéro du caractere de début de la section, après le titre
297
		$infos = array('debut' => $debut_section_apres_titre,
298
						'longueur_titre' => $longueur_titre
299
				);
49 aurelien 300
 
46 jpm 301
		return $infos;
302
	}
49 aurelien 303
 
46 jpm 304
	private function remplacerSection($titre_section, $section_remplacement, $corps) {
49 aurelien 305
 
46 jpm 306
		// insertion d'un saut de ligne pour empêcher de casser le titre, lorsque le titre
307
		// suivant vient directement après la section, sans saut de ligne ni espace
308
		$section_remplacement = "\n".$section_remplacement."\n";
309
		$section_page_originale = $this->getSectionParTitre($corps, $titre_section, true);
310
		$infos_section = $this->getInformationsPositionSection($titre_section, $corps);
311
		$nb_caracteres_a_remplacer = mb_strlen($section_page_originale) - $infos_section['longueur_titre'];
49 aurelien 312
 
46 jpm 313
		$nouveau_contenu = substr_replace($corps, $section_remplacement, $infos_section['debut'], $nb_caracteres_a_remplacer);
49 aurelien 314
 
46 jpm 315
		return $nouveau_contenu;
316
	}
49 aurelien 317
 
46 jpm 318
	private function ecrirePage($nom_page, $contenu) {
49 aurelien 319
 
46 jpm 320
		$texte_encode = $this->convertirTexteAppliVersEncodageWiki($contenu);
321
		$ecriture = $this->wiki->SavePage($nom_page, $texte_encode, "", true);
49 aurelien 322
 
46 jpm 323
		return $ecriture;
324
	}
49 aurelien 325
 
46 jpm 326
	private function analyserParametresEcriture($parametres) {
327
		$this->pageNom = $parametres['pageTag'];
328
		$this->section = isset($parametres['pageSectionTitre']) ? $parametres['pageSectionTitre'] : null;
329
	}
49 aurelien 330
 
46 jpm 331
	private function verifierParametresEcriture($parametres) {
49 aurelien 332
 
46 jpm 333
		$erreurs = array();
49 aurelien 334
 
46 jpm 335
		if (!isset($parametres['pageContenu'])) {
336
			$message = "Le paramètre pageContenu est obligatoire";
337
			$erreurs[] = $message;
338
		}
49 aurelien 339
 
46 jpm 340
		if (!isset($parametres['pageTag']) || trim($parametres['pageTag']) == '') {
341
			$message = "Le paramètre pageTag est obligatoire";
342
			$erreurs[] = $message;
343
		}
49 aurelien 344
 
46 jpm 345
		if (isset($parametres['pageSectionTitre']) && $parametres['pageSectionTitre'] == '') {
346
			$message = "Le paramètre pageSectionTitre ne doit pas être vide s'il est présent";
347
			$erreurs[] = $message;
348
		}
49 aurelien 349
 
46 jpm 350
		if (count($erreurs) > 0) {
351
			$message = implode('<br />', $erreurs);
352
			$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
353
			throw new Exception($message, $code);
354
		}
355
	}
49 aurelien 356
 
46 jpm 357
	private function convertirTexteWikiVersEncodageAppli($texte) {
358
		if (Config::get('encodage_appli') != Config::get('encodage_wiki')) {
359
			$texte = mb_convert_encoding($texte,Config::get('encodage_appli'),Config::get('encodage_wiki'));
360
		}
361
		return $texte;
362
	}
49 aurelien 363
 
46 jpm 364
	private function convertirTexteAppliVersEncodageWiki($texte) {
365
		if (Config::get('encodage_appli') != Config::get('encodage_wiki')) {
366
			$texte = mb_convert_encoding($texte,Config::get('encodage_wiki'),Config::get('encodage_appli'));
367
		}
368
		return $texte;
369
	}
49 aurelien 370
}
30 aurelien 371
?>