Subversion Repositories Applications.wikini

Rev

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