Subversion Repositories Applications.wikini

Rev

Rev 40 | Rev 42 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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