Subversion Repositories Applications.wikini

Rev

Rev 45 | Rev 49 | Go to most recent revision | Details | Compare with Previous | 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 {
16
 
17
	private $wiki = null;
18
	private $pageNom = null;
19
	private $section = null;
20
	private $creerPage = false;
21
	private $templateDefaut = null;
22
 
23
	private $retour = null;
24
	private $formats_retour = array('text/plain','text/html');
25
	private $format_texte;
26
 
27
	const MIME_JSON = 'application/json';
28
	const MIME_HTML = 'text/html';
29
	const MIME_TEXT = 'text/plain';
30
 
31
	public function consulter($ressources, $parametres) {
32
 
33
		try {
34
			$this->definirValeurParDefautDesParametres();
35
			$this->verifierParametres($parametres);
36
			$this->analyserParametres($ressources, $parametres);
37
 
38
			$page = $this->consulterPage($this->pageNom, $this->section);
39
 
40
			if($page == null && $this->creerPage) {
41
				$this->creerPageAPartirTemplate($this->pageNom, $this->templateDefaut);
42
				$page = $this->consulterPage($this->pageNom, $this->section);
43
			}
44
 
45
			$retour = $this->formaterRetour($page);
46
 
47
			$this->envoyerContenuJson($retour);
48
		} catch (Exception $e) {
49
			$this->envoyerErreur($e);
50
		}
51
	}
52
 
53
	private function definirValeurParDefautDesParametres() {
54
		if (isset($this->parametres['txt_format']) == false) {
55
			$this->parametres['txt_format'] = 'text/plain';
56
		}
57
	}
58
 
59
	private function verifierParametres($parametres) {
60
		$erreurs = array();
61
 
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
		}
68
 
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
		}
73
 
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
		}
78
 
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
		}
83
 
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
		}
88
 
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
	}
95
 
96
	private function analyserParametres($ressources, $parametres) {
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
	}
112
 
113
	private function consulterPage($page, $section = null) {
114
 
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);
122
 
123
		if ($page != null) {
124
			$page["body"] = $this->convertirTexteWikiVersEncodageAppli($page['body']);
125
			if($section != null) {
126
				$page["body"] = $this->decouperPageSection($page["body"], $section);
127
			}
128
		}
129
 
130
		return $page;
131
	}
132
 
133
	private function decouperPageSection($contenu_page, $section) {
134
		$section_retour = '';
135
		if (is_numeric($section)) {
136
			$section_retour =  $this->getSectionParNumero($contenu_page, $section);
137
		} else {
138
			$section_retour =  $this->getSectionParTitre($contenu_page, $section, false);
139
		}
140
		return $section_retour;
141
	}
142
 
143
	public function getSectionParNumero($page, $num) {
144
		preg_match_all('/(=[=]+[ ]*)(.[.^=]*)+[ ]*=[=]+[.]*/i', $page, $sections, PREG_OFFSET_CAPTURE);
145
		$sectionTxt = '';
146
		$debut_section = 0;
147
		$lg_page = strlen($page);
148
		$fin_section = $lg_page;
149
 
150
		if ($num <= count($sections[1]) && $num > 0) {
151
 
152
			$debut_section = $sections[1][$num - 1][1];
153
			$separateur = trim($sections[1][$num - 1][0]);
154
			$separateur_trouve = false;
155
 
156
			for ($i = $num; $i < count($sections[1]); $i++) {
157
				$fin_section = $sections[1][$i][1];
158
				if($separateur == trim($sections[1][$i][0])) {
159
					$separateur_trouve = true;
160
					break;
161
				}
162
			}
163
 
164
			$fin_section = $separateur_trouve ? $fin_section : $lg_page;
165
			$sectionTxt = substr($page, $debut_section, $fin_section - $debut_section);
166
 
167
		} else {
168
			$sectionTxt = '';
169
		}
170
 
171
		return $sectionTxt;
172
	}
173
 
174
	public function getSectionParTitre($page, $titre, $inclure_titre = false) {
175
		$section = '';
176
		$reg_exp = '/((=[=]+)[ ]*'.preg_quote(trim($titre), '/').'[ ]*=[=]+)[.]*/i';
177
		$match = preg_split($reg_exp, $page, 2, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
178
		if (count($match) > 3) {
179
			$section = explode(trim($match[2]), $match[3], 2);
180
			$section = $section[0];
181
			$section = ($inclure_titre) ? $match[1].$section : $section;
182
		} elseif (count($match) == 3) {
183
			$section = explode(trim($match[1]), $match[2], 2);
184
			$section = $section[0];
185
			$section = ($inclure_titre) ? $match[0].$section : $section;
186
		} else {
187
			$section = "";
188
		}
189
 
190
		return $section;
191
	}
192
 
193
	private function formaterRetour($page) {
194
 
195
		$mime = null;
196
		$texte = '';
197
 
198
		switch ($this->retour) {
199
			case self::MIME_HTML:
200
				$texte = $this->wiki->Format($page["body"], "wakka");
201
				$mime = self::MIME_HTML;
202
				break;
203
			default:
204
				$texte = $page["body"];
205
				$mime = self::MIME_TEXT;
206
		}
207
 
208
		$url = $this->wiki->Href("", $this->pageNom);
209
 
210
		$retour = array('id' => $this->pageNom,
211
				'titre' => $this->pageNom,
212
				'mime' => $mime,
213
				'texte' => $texte,
214
				'href' => $url);
215
 
216
		return $retour;
217
	}
218
 
219
	private function creerPageAPartirTemplate($tag_page_a_creer, $tag_template) {
220
		$page_template = $this->consulterPage($tag_template);
221
		$corps_nouvelle_page = ($page_template != null) ? $page_template['body'] : '';
222
		// si le template n'existe pas, la page créée sera vide
223
		$ecriture = $this->ecrirePage($tag_page_a_creer, $corps_nouvelle_page);
224
 
225
		return $ecriture;
226
	}
227
 
228
	public function ajouter($ressources, $requeteDonnees) {
229
		return $this->modifier($ressources, $requeteDonnees);
230
	}
231
 
232
	public function modifier($ressources, $requeteDonnees) {
233
 
234
		$requeteDonnees['pageTag'] = $ressources[0];
235
		$this->verifierParametresEcriture($requeteDonnees);
236
		$this->analyserParametresEcriture($requeteDonnees);
237
		$this->wiki = Registre::get('wikiApi');
238
		$this->wiki->setPageCourante($this->pageNom);
239
 
240
		$texte = $requeteDonnees['pageContenu'];
241
		$page = $this->consulterPage($this->pageNom);
242
 
243
		if ($page != null) {
244
			$corps = ($this->section != null) ? $this->remplacerSection($this->section, $texte, $page['body']) : $texte;
245
		} else {
246
			$corps = $texte;
247
		}
248
 
249
		$ecriture = $this->ecrirePage($this->pageNom, $corps);
250
 
251
		if ($ecriture) {
252
			$this->envoyerCreationEffectuee();
253
		} else {
254
			$message = 'Impossible de créer ou modifier la page';
255
			$code = RestServeur::HTTP_CODE_ERREUR;
256
			throw new Exception($message, $code);
257
		}
258
 
259
		return $ecriture;
260
	}
261
 
262
	/**
263
	 *
264
	 * Si la section demandée existe dans la page, renvoie un tableau contenant le numéro de caractère de
265
	 * début de la section, après son titre, ainsi que la longeur du titre
266
	 * @param string $titre de la section
267
	 * @param string $page contenu de la page wiki
268
	 * @return tableau associatif tel que décrit ici
269
	 */
270
	private function getInformationsPositionSection($titre, $page) {
271
 
272
		preg_match_all('/(=[=]+[ ]*'.preg_quote(trim($titre), '/').'[ ]*=[=]+[.]*)/i', $page, $sections, PREG_OFFSET_CAPTURE);
273
		$longueur_titre = 0;
274
		$debut_section_apres_titre = 0;
275
 
276
		if (count($sections) > 0 && is_array($sections[0]) && count($sections[0][0]) >= 2) {
277
			$longueur_titre = mb_strlen($sections[0][0][0]);
278
			$debut_section_apres_titre = $sections[0][0][1] + $longueur_titre;
279
		}
280
 
281
		// ATTENTION : début contient le numéro du caractere de début de la section, après le titre
282
		$infos = array('debut' => $debut_section_apres_titre,
283
						'longueur_titre' => $longueur_titre
284
				);
285
 
286
		return $infos;
287
	}
288
 
289
	private function remplacerSection($titre_section, $section_remplacement, $corps) {
290
 
291
		// insertion d'un saut de ligne pour empêcher de casser le titre, lorsque le titre
292
		// suivant vient directement après la section, sans saut de ligne ni espace
293
		$section_remplacement = "\n".$section_remplacement."\n";
294
		$section_page_originale = $this->getSectionParTitre($corps, $titre_section, true);
295
		$infos_section = $this->getInformationsPositionSection($titre_section, $corps);
296
		$nb_caracteres_a_remplacer = mb_strlen($section_page_originale) - $infos_section['longueur_titre'];
297
 
298
		$nouveau_contenu = substr_replace($corps, $section_remplacement, $infos_section['debut'], $nb_caracteres_a_remplacer);
299
 
300
		return $nouveau_contenu;
301
	}
302
 
303
	private function ecrirePage($nom_page, $contenu) {
304
 
305
		$texte_encode = $this->convertirTexteAppliVersEncodageWiki($contenu);
306
		$ecriture = $this->wiki->SavePage($nom_page, $texte_encode, "", true);
307
 
308
		return $ecriture;
309
	}
310
 
311
	private function analyserParametresEcriture($parametres) {
312
		$this->pageNom = $parametres['pageTag'];
313
		$this->section = isset($parametres['pageSectionTitre']) ? $parametres['pageSectionTitre'] : null;
314
	}
315
 
316
	private function verifierParametresEcriture($parametres) {
317
 
318
		$erreurs = array();
319
 
320
		if (!isset($parametres['pageContenu'])) {
321
			$message = "Le paramètre pageContenu est obligatoire";
322
			$erreurs[] = $message;
323
		}
324
 
325
		if (!isset($parametres['pageTag']) || trim($parametres['pageTag']) == '') {
326
			$message = "Le paramètre pageTag est obligatoire";
327
			$erreurs[] = $message;
328
		}
329
 
330
		if (isset($parametres['pageSectionTitre']) && $parametres['pageSectionTitre'] == '') {
331
			$message = "Le paramètre pageSectionTitre ne doit pas être vide s'il est présent";
332
			$erreurs[] = $message;
333
		}
334
 
335
		if (count($erreurs) > 0) {
336
			$message = implode('<br />', $erreurs);
337
			$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
338
			throw new Exception($message, $code);
339
		}
340
	}
341
 
342
	private function convertirTexteWikiVersEncodageAppli($texte) {
343
		if (Config::get('encodage_appli') != Config::get('encodage_wiki')) {
344
			$texte = mb_convert_encoding($texte,Config::get('encodage_appli'),Config::get('encodage_wiki'));
345
		}
346
		return $texte;
347
	}
348
 
349
	private function convertirTexteAppliVersEncodageWiki($texte) {
350
		if (Config::get('encodage_appli') != Config::get('encodage_wiki')) {
351
			$texte = mb_convert_encoding($texte,Config::get('encodage_wiki'),Config::get('encodage_appli'));
352
		}
353
		return $texte;
354
	}
355
}
30 aurelien 356
?>