Subversion Repositories Applications.wikini

Rev

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