Subversion Repositories Applications.wikini

Rev

Rev 39 | Rev 41 | 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
 
31 aurelien 23
	private $retour = 'txt';
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
 
39 aurelien 40
			// on devrait normalement renvoyer une erreur 404 mais
41
			// l'api de consultation d'url du framework prend mal en compte
42
			// le 404 et ne permet pas de le traiter quand on le recoit
40 aurelien 43
			if($page == null && $this->creerPage) {
44
				$this->creerPageAPartirTemplate($this->pageNom, $this->templateDefaut);
45
				$page = $this->consulterPage($this->pageNom, $this->section);
46
			}
47
 
33 aurelien 48
			$retour = $this->formaterRetour($page);
49
 
50
			$this->envoyerContenuJson($retour);
51
		} catch (Exception $e) {
52
			$this->envoyerErreur($e);
30 aurelien 53
		}
54
	}
55
 
31 aurelien 56
	private function definirValeurParDefautDesParametres() {
57
		if (isset($this->parametres['txt_format']) == false) {
36 aurelien 58
			$this->parametres['txt_format'] = 'text/plain';
31 aurelien 59
		}
60
	}
61
 
30 aurelien 62
	private function verifierParametres($parametres) {
33 aurelien 63
		$erreurs = array();
64
 
31 aurelien 65
		if (isset($parametres['txt_format'])) {
66
			if(!in_array($parametres['txt_format'], $this->formats_retour)) {
35 aurelien 67
				$message = "La valeur du paramètre 'txt.format' peut seulement prendre les valeurs : text/plain et text/html.";
33 aurelien 68
				$erreurs[] = $message;
30 aurelien 69
			}
70
		}
31 aurelien 71
 
37 aurelien 72
		if (isset($parametres['txt_section_position']) && !is_numeric($parametres['txt_section_position'])) {
33 aurelien 73
			$message = "La valeur du paramètre 'txt.section.position' peut seulement prendre des valeurs numeriques";
74
			$erreurs[] = $message;
31 aurelien 75
		}
76
 
37 aurelien 77
		if (isset($parametres['txt_section_titre']) && trim($parametres['txt_section_titre']) == '') {
33 aurelien 78
			$message = "La valeur du paramètre 'txt.section.titre' ne peut pas être vide si celui-ci est présent";
79
			$erreurs[] = $message;
80
		}
40 aurelien 81
 
82
		if (isset($parametres['txt_section_titre']) && trim($parametres['txt_section_titre']) == '') {
83
			$message = "La valeur du paramètre 'txt.section.titre' ne peut pas être vide si celui-ci est présent";
84
			$erreurs[] = $message;
85
		}
86
 
87
		if (isset($parametres['txt_template']) && trim($parametres['txt_template']) == '') {
88
			$message = "La valeur du paramètre 'txt_template' ne peut pas être vide si celui-ci est présent";
89
			$erreurs[] = $message;
90
		}
33 aurelien 91
 
92
		if (count($erreurs) > 0) {
93
			$message = implode('<br />', $erreurs);
94
			$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
95
			throw new Exception($message, $code);
96
		}
97
	}
98
 
99
	private function analyserParametres($ressources, $parametres) {
100
		$this->pageNom = $ressources[0];
37 aurelien 101
		if (isset($parametres['txt_section_titre'])) {
31 aurelien 102
			$this->section = $parametres['txt_section_titre'];
103
		}
37 aurelien 104
		if (isset($parametres['txt_section_position'])) {
33 aurelien 105
			$this->section = $parametres['txt_section_position'];
106
		}
107
		if (isset($parametres['txt_format'])) {
108
			$this->retour = $parametres['txt_format'];
109
		}
40 aurelien 110
		if (isset($parametres['txt_template'])) {
111
			$this->creerPage = true;
112
			$this->templateDefaut = $parametres['txt_template'];
113
		}
30 aurelien 114
	}
31 aurelien 115
 
35 aurelien 116
	private function consulterPage($page, $section = null) {
36 aurelien 117
 
31 aurelien 118
		$this->wiki = Registre::get('wikiApi');
119
		$this->wiki->setPageCourante($this->pageNom);
120
		$page = $this->wiki->LoadPage($page);
37 aurelien 121
 
122
		if ($page != null) {
36 aurelien 123
			// attention les wikis sont souvent en ISO !
124
			$page["body"] = $this->convertirTexteWikiVersEncodageAppli($page['body']);
125
			if($section != null) {
126
				$page["body"] = $this->decouperPageSection($page["body"], $section);
127
			}
31 aurelien 128
		}
129
 
130
		return $page;
131
	}
132
 
35 aurelien 133
	private function decouperPageSection($contenu_page, $section) {
31 aurelien 134
		$section_retour = '';
37 aurelien 135
		if (is_numeric($section)) {
31 aurelien 136
			$section_retour =  $this->getSectionParNumero($contenu_page, $section);
137
		} else {
39 aurelien 138
			$section_retour =  $this->getSectionParTitre($contenu_page, $section, false);
31 aurelien 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
 
37 aurelien 150
		if ($num <= count($sections[1]) && $num > 0) {
31 aurelien 151
 
152
			$debut_section = $sections[1][$num - 1][1];
153
			$separateur = trim($sections[1][$num - 1][0]);
154
			$separateur_trouve = false;
155
 
37 aurelien 156
			for ($i = $num; $i < count($sections[1]); $i++) {
31 aurelien 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);
37 aurelien 166
 
31 aurelien 167
		} else {
168
			$sectionTxt = '';
37 aurelien 169
		}
31 aurelien 170
 
171
		return $sectionTxt;
172
	}
173
 
39 aurelien 174
	public function getSectionParTitre($page, $titre, $inclure_titre = false) {
31 aurelien 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);
37 aurelien 178
		if (count($match) > 3) {
31 aurelien 179
			$section = explode(trim($match[2]), $match[3], 2);
39 aurelien 180
			$section = $section[0];
181
			$section = ($inclure_titre) ? $match[1].$section : $section;
37 aurelien 182
		} elseif (count($match) == 3) {
31 aurelien 183
			$section = explode(trim($match[1]), $match[2], 2);
39 aurelien 184
			$section = $section[0];
185
			$section = ($inclure_titre) ? $match[0].$section : $section;
31 aurelien 186
		} else {
187
			$section = "";
188
		}
189
 
190
		return $section;
191
	}
192
 
193
	private function formaterRetour($page) {
194
 
33 aurelien 195
		$mime = null;
196
		$texte = '';
197
 
37 aurelien 198
		switch ($this->retour) {
35 aurelien 199
			case self::MIME_HTML:
33 aurelien 200
				$texte = $this->wiki->Format($page["body"], "wakka");
201
				$mime = self::MIME_HTML;
31 aurelien 202
				break;
203
			default:
33 aurelien 204
				$texte = $page["body"];
205
				$mime = self::MIME_TEXT;
31 aurelien 206
		}
33 aurelien 207
 
35 aurelien 208
		$url = $this->wiki->Href("", $this->pageNom);
209
 
33 aurelien 210
		$retour = array('id' => $this->pageNom,
211
				'titre' => $this->pageNom,
212
				'mime' => $mime,
213
				'texte' => $texte,
40 aurelien 214
				'href' => $url);
33 aurelien 215
 
31 aurelien 216
		return $retour;
217
	}
35 aurelien 218
 
40 aurelien 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
 
35 aurelien 228
	public function ajouter($ressources, $requeteDonnees) {
229
		return $this->modifier($ressources, $requeteDonnees);
230
	}
231
 
232
	public function modifier($ressources, $requeteDonnees) {
37 aurelien 233
 
234
		$requeteDonnees['pageTag'] = $ressources[0];
36 aurelien 235
		$this->verifierParametresEcriture($requeteDonnees);
236
		$this->analyserParametresEcriture($requeteDonnees);
35 aurelien 237
		$this->wiki = Registre::get('wikiApi');
238
		$this->wiki->setPageCourante($this->pageNom);
239
 
37 aurelien 240
		$texte = $requeteDonnees['pageContenu'];
35 aurelien 241
		$page = $this->consulterPage($this->pageNom);
36 aurelien 242
 
37 aurelien 243
		if ($page != null) {
36 aurelien 244
			$corps = ($this->section != null) ? $this->remplacerSection($this->section, $texte, $page['body']) : $texte;
245
		} else {
246
			$corps = $texte;
35 aurelien 247
		}
37 aurelien 248
 
36 aurelien 249
		$ecriture = $this->ecrirePage($this->pageNom, $corps);
37 aurelien 250
 
251
		if ($ecriture) {
35 aurelien 252
			$this->envoyerCreationEffectuee();
253
		} else {
36 aurelien 254
			$message = 'Impossible de créer ou modifier la page';
255
			$code = RestServeur::HTTP_CODE_ERREUR;
256
			throw new Exception($message, $code);
35 aurelien 257
		}
258
 
259
		return $ecriture;
260
	}
261
 
39 aurelien 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) {
38 aurelien 271
 
39 aurelien 272
		preg_match_all('/(=[=]+[ ]*'.preg_quote(trim($titre), '/').'[ ]*=[=]+[.]*)/i', $page, $sections, PREG_OFFSET_CAPTURE);
273
		$longueur_titre = 0;
274
		$debut_section_apres_titre = 0;
38 aurelien 275
 
39 aurelien 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
 
40 aurelien 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
39 aurelien 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);
38 aurelien 299
 
39 aurelien 300
		return $nouveau_contenu;
36 aurelien 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) {
37 aurelien 312
		$this->pageNom = $parametres['pageTag'];
39 aurelien 313
		$this->section = isset($parametres['pageSectionTitre']) ? $parametres['pageSectionTitre'] : null;
36 aurelien 314
	}
315
 
316
	private function verifierParametresEcriture($parametres) {
317
 
318
		$erreurs = array();
319
 
40 aurelien 320
		if (!isset($parametres['pageContenu'])) {
37 aurelien 321
			$message = "Le paramètre pageContenu est obligatoire";
36 aurelien 322
			$erreurs[] = $message;
323
		}
324
 
40 aurelien 325
		if (!isset($parametres['pageTag']) || trim($parametres['pageTag']) == '') {
37 aurelien 326
			$message = "Le paramètre pageTag est obligatoire";
36 aurelien 327
			$erreurs[] = $message;
328
		}
329
 
40 aurelien 330
		if (isset($parametres['pageSectionTitre']) && $parametres['pageSectionTitre'] == '') {
39 aurelien 331
			$message = "Le paramètre pageSectionTitre ne doit pas être vide s'il est présent";
332
			$erreurs[] = $message;
333
		}
334
 
36 aurelien 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
 
35 aurelien 342
	private function convertirTexteWikiVersEncodageAppli($texte) {
40 aurelien 343
		if (Config::get('encodage_appli') != Config::get('encodage_wiki')) {
35 aurelien 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) {
40 aurelien 350
		if (Config::get('encodage_appli') != Config::get('encodage_wiki')) {
35 aurelien 351
			$texte = mb_convert_encoding($texte,Config::get('encodage_wiki'),Config::get('encodage_appli'));
352
		}
353
		return $texte;
354
	}
30 aurelien 355
}
356
?>