3 /***************************************************************************\
4 * SPIP, Systeme de publication pour l'internet *
6 * Copyright (c) 2001-2016 *
7 * Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James *
9 * Ce programme est un logiciel libre distribue sous licence GNU/GPL. *
10 * Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. *
11 \***************************************************************************/
14 if (!defined('_ECRIRE_INC_VERSION')) return;
15 // ajouter define('_CREER_DIR_PLAT', true); dans mes_options pour restaurer
16 // le fonctionnement des faux repertoires en .plat
17 define('_CREER_DIR_PLAT', false);
18 if (!defined('_TEST_FILE_EXISTS')) define('_TEST_FILE_EXISTS', preg_match(',(online|free)[.]fr$,', isset($_ENV["HTTP_HOST"]) ?
$_ENV["HTTP_HOST"] : ""));
20 #define('_SPIP_LOCK_MODE',0); // ne pas utiliser de lock (deconseille)
21 #define('_SPIP_LOCK_MODE',1); // utiliser le flock php
22 #define('_SPIP_LOCK_MODE',2); // utiliser le nfslock de spip
24 if (_SPIP_LOCK_MODE
==2)
25 include_spip('inc/nfslock');
27 $GLOBALS['liste_verrous'] = array();
28 // http://doc.spip.org/@spip_fopen_lock
29 function spip_fopen_lock($fichier,$mode,$verrou){
30 if (_SPIP_LOCK_MODE
==1){
31 if ($fl = @fopen
($fichier,$mode))
36 elseif(_SPIP_LOCK_MODE
==2) {
37 if (($verrou = spip_nfslock($fichier)) && ($fl = @fopen
($fichier,$mode))){
38 $GLOBALS['liste_verrous'][$fl] = array($fichier,$verrou);
43 return @fopen
($fichier,$mode);
45 // http://doc.spip.org/@spip_fclose_unlock
46 function spip_fclose_unlock($handle){
47 if (_SPIP_LOCK_MODE
==1){
48 @flock
($handle, LOCK_UN
);
50 elseif(_SPIP_LOCK_MODE
==2) {
51 spip_nfsunlock(reset($GLOBALS['liste_verrous'][$handle]),end($GLOBALS['liste_verrous'][$handle]));
52 unset($GLOBALS['liste_verrous'][$handle]);
54 return @fclose
($handle);
58 // http://doc.spip.org/@spip_file_get_contents
59 function spip_file_get_contents ($fichier) {
60 if (substr($fichier, -3) != '.gz') {
61 if (function_exists('file_get_contents')
63 // quand on est sous window on ne sait pas si file_get_contents marche
64 // on essaye : si ca retourne du contenu alors c'est bon
65 // sinon on fait un file() pour avoir le coeur net
66 ($contenu = @file_get_contents
($fichier))
67 OR _OS_SERVEUR
!= 'windows')
71 $contenu = @file
($fichier);
73 $contenu = @gzfile
($fichier);
74 return is_array($contenu)?
join('', $contenu):(string)$contenu;
78 // 'phpcheck' => 'oui' # verifier qu'on a bien du php
79 // dezippe automatiquement les fichiers .gz
80 // http://doc.spip.org/@lire_fichier
81 function lire_fichier ($fichier, &$contenu, $options=false) {
83 // inutile car si le fichier n'existe pas, le lock va renvoyer false juste apres
84 // economisons donc les acces disque, sauf chez free qui rale pour un rien
85 if (_TEST_FILE_EXISTS
AND !@file_exists
($fichier))
88 #spip_timer('lire_fichier');
90 // pas de @ sur spip_fopen_lock qui est silencieux de toute facon
91 if ($fl = spip_fopen_lock($fichier, 'r', LOCK_SH
)) {
92 // lire le fichier avant tout
93 $contenu = spip_file_get_contents($fichier);
95 // le fichier a-t-il ete supprime par le locker ?
96 // on ne verifie que si la tentative de lecture a echoue
97 // pour discriminer un contenu vide d'un fichier absent
98 // et eviter un acces disque
99 if (!$contenu AND !@file_exists
($fichier)) {
100 spip_fclose_unlock($fl);
105 spip_fclose_unlock($fl);
109 if ($options['phpcheck'] == 'oui')
110 $ok &= (preg_match(",[?]>\n?$,", $contenu));
112 #spip_log("$fread $fichier ".spip_timer('lire_fichier'));
114 spip_log("echec lecture $fichier");
122 // Ecrire un fichier de maniere un peu sure
124 // zippe les fichiers .gz
125 // http://doc.spip.org/@ecrire_fichier
126 function ecrire_fichier ($fichier, $contenu, $ignorer_echec = false, $truncate=true) {
128 #spip_timer('ecrire_fichier');
130 // verrouiller le fichier destination
131 if ($fp = spip_fopen_lock($fichier, 'a',LOCK_EX
)) {
132 // ecrire les donnees, compressees le cas echeant
133 // (on ouvre un nouveau pointeur sur le fichier, ce qui a l'avantage
134 // de le recreer si le locker qui nous precede l'avait supprime...)
135 if (substr($fichier, -3) == '.gz')
136 $contenu = gzencode($contenu);
137 // si c'est une ecriture avec troncation , on fait plutot une ecriture complete a cote suivie unlink+rename
138 // pour etre sur d'avoir une operation atomique
139 // y compris en NFS : http://www.ietf.org/rfc/rfc1094.txt
140 // sauf sous wintruc ou ca ne marche pas
142 if ($truncate AND _OS_SERVEUR
!= 'windows'){
143 if (!function_exists('creer_uniqid'))
144 include_spip('inc/acces');
145 $id = creer_uniqid();
146 // on ouvre un pointeur sur un fichier temporaire en ecriture +raz
147 if ($fp2 = spip_fopen_lock("$fichier.$id", 'w',LOCK_EX
)) {
148 $s = @fputs
($fp2, $contenu, $a = strlen($contenu));
150 spip_fclose_unlock($fp2);
151 spip_fclose_unlock($fp);
152 // unlink direct et pas spip_unlink car on avait deja le verrou
153 // a priori pas besoin car rename ecrase la cible
154 // @unlink($fichier);
155 // le rename aussitot, atomique quand on est pas sous windows
156 // au pire on arrive en second en cas de concourance, et le rename echoue
157 // --> on a la version de l'autre process qui doit etre identique
158 @rename
("$fichier.$id",$fichier);
159 // precaution en cas d'echec du rename
160 if (!_TEST_FILE_EXISTS
OR @file_exists
("$fichier.$id"))
161 @unlink
("$fichier.$id");
163 $ok = file_exists($fichier);
166 // echec mais penser a fermer ..
167 spip_fclose_unlock($fp);
169 // sinon ou si methode precedente a echoueee
170 // on se rabat sur la methode ancienne
172 // ici on est en ajout ou sous windows, cas desespere
175 $s = @fputs
($fp, $contenu, $a = strlen($contenu));
178 spip_fclose_unlock($fp);
181 // liberer le verrou et fermer le fichier
182 @chmod
($fichier, _SPIP_CHMOD
& 0666);
184 if (strpos($fichier,".php")!==false){
185 spip_clear_opcode_cache(realpath($fichier));
191 if (!$ignorer_echec){
192 include_spip('inc/autoriser');
193 if (autoriser('chargerftp'))
194 raler_fichier($fichier);
195 spip_unlink($fichier);
197 spip_log("Ecriture fichier $fichier impossible",_LOG_INFO_IMPORTANTE
);
202 * Ecrire un contenu dans un fichier encapsule en php pour en empecher l'acces en l'absence
204 * @param string $fichier
205 * @param <type> $contenu
206 * @param <type> $ecrire_quand_meme
207 * @param <type> $truncate
209 function ecrire_fichier_securise ($fichier, $contenu, $ecrire_quand_meme = false, $truncate=true) {
210 if (substr($fichier,-4) !== '.php')
211 spip_log('Erreur de programmation: '.$fichier.' doit finir par .php');
212 $contenu = "<"."?php die ('Acces interdit'); ?".">\n" . $contenu;
213 return ecrire_fichier($fichier, $contenu, $ecrire_quand_meme, $truncate);
217 * Lire un fichier encapsule en php
218 * @param <type> $fichier
219 * @param <type> $contenu
220 * @param <type> $options
222 function lire_fichier_securise ($fichier, &$contenu, $options=false) {
223 if ($res = lire_fichier($fichier,$contenu,$options)){
224 $contenu = substr($contenu,strlen("<"."?php die ('Acces interdit'); ?".">\n"));
229 // http://doc.spip.org/@raler_fichier
230 function raler_fichier($fichier)
232 include_spip('inc/minipres');
233 $dir = dirname($fichier);
235 echo minipres(_T('texte_inc_meta_2'), "<h4 style='color: red'>"
236 . _T('texte_inc_meta_1', array('fichier' => $fichier))
238 . generer_url_ecrire('install', "etape=chmod&test_dir=$dir")
240 . _T('texte_inc_meta_2')
242 . _T('texte_inc_meta_3',
243 array('repertoire' => joli_repertoire($dir)))
249 // Retourne Vrai si son premier argument a ete cree il y a moins de N secondes
252 // http://doc.spip.org/@jeune_fichier
253 function jeune_fichier($fichier, $n)
255 if (!file_exists($fichier)) return false;
256 if (!$c = @filemtime
($fichier)) return false;
257 return (time()-$n <= $c);
261 // Supprimer le fichier de maniere sympa (flock)
263 // http://doc.spip.org/@supprimer_fichier
264 function supprimer_fichier($fichier, $lock=true) {
265 if (!@file_exists
($fichier))
269 // verrouiller le fichier destination
270 if (!$fp = spip_fopen_lock($fichier, 'a', LOCK_EX
))
274 spip_fclose_unlock($fp);
278 return @unlink
($fichier);
281 // Supprimer brutalement, si le fichier existe
282 // http://doc.spip.org/@spip_unlink
283 function spip_unlink($f) {
285 supprimer_fichier($f,false);
293 * clearstatcache adapte a la version PHP
294 * @param bool $clear_realpath_cache
295 * @param null $filename
297 function spip_clearstatcache($clear_realpath_cache = false, $filename=null){
298 if (!defined('PHP_VERSION_ID') || PHP_VERSION_ID
< 50300) {
299 // Below PHP 5.3, clearstatcache does not accept any function parameters.
300 return clearstatcache();
303 return clearstatcache($clear_realpath_cache, $filename);
310 * Invalidates a PHP file from any active opcode caches.
312 * If the opcode cache does not support the invalidation of individual files,
313 * the entire cache will be flushed.
314 * kudo : http://cgit.drupalcode.org/drupal/commit/?id=be97f50
316 * @param string $filepath
317 * The absolute path of the PHP file to invalidate.
319 function spip_clear_opcode_cache($filepath) {
320 spip_clearstatcache(TRUE, $filepath);
323 if (function_exists('opcache_invalidate')) {
324 opcache_invalidate($filepath, TRUE);
327 if (function_exists('apc_delete_file')) {
328 // apc_delete_file() throws a PHP warning in case the specified file was
330 // @see http://php.net/apc-delete-file
331 @apc_delete_file
($filepath);
336 * si opcache est actif et en mode validate_timestamps
337 * le timestamp ne sera checke qu'apres revalidate_freq s
338 * il faut donc attendre ce temps la pour etre sur qu'on va bien beneficier de la recompilation
339 * NB c'est une config foireuse deconseillee de opcode cache mais malheureusement utilisee par Octave
340 * cf http://stackoverflow.com/questions/25649416/when-exactly-does-php-5-5-opcache-check-file-timestamp-based-on-revalidate-freq
341 * et http://wiki.mikejung.biz/PHP_OPcache
343 * Ne fait rien en dehors de ce cas
346 function spip_attend_invalidation_opcode_cache(){
347 if (function_exists('opcache_get_configuration')
348 AND @ini_get
('opcache.enable')
349 AND @ini_get
('opcache.validate_timestamps')
350 AND $duree = @ini_get
('opcache.revalidate_freq') ) {
356 * Suppression complete d'un repertoire.
358 * http://www.php.net/manual/en/function.rmdir.php#92050
360 * @param string $dir Chemin du repertoire
361 * @return bool Suppression reussie.
363 function supprimer_repertoire($dir) {
364 if (!file_exists($dir)) return true;
365 if (!is_dir($dir) ||
is_link($dir)) return @unlink
($dir);
367 foreach (scandir($dir) as $item) {
368 if ($item == '.' ||
$item == '..') continue;
369 if (!supprimer_repertoire($dir . "/" . $item)) {
370 @chmod
($dir . "/" . $item, 0777);
371 if (!supprimer_repertoire($dir . "/" . $item)) return false;
380 // Retourne $base/${subdir}/ si le sous-repertoire peut etre cree,
381 // $base/${subdir}_ sinon ; $nobase signale qu'on ne veut pas de $base/
382 // On peut aussi ne donner qu'un seul argument,
383 // subdir valant alors ce qui suit le dernier / dans $base
385 // http://doc.spip.org/@sous_repertoire
386 function sous_repertoire($base, $subdir='', $nobase = false, $tantpis=false) {
387 static $dirs = array();
389 $base = str_replace("//", "/", $base);
391 # suppr le dernier caractere si c'est un / ou un _
392 $base = rtrim($base, '/_');
394 if (!strlen($subdir)) {
395 $n = strrpos($base, "/");
396 if ($n === false) return $nobase ?
'' : ($base .'/');
397 $subdir = substr($base, $n+
1);
398 $base = substr($base, 0, $n+
1);
401 $subdir = str_replace("/", "", $subdir);
404 $baseaff = $nobase ?
'' : $base;
405 if (isset($dirs[$base.$subdir]))
406 return $baseaff.$dirs[$base.$subdir];
409 if (_CREER_DIR_PLAT
AND @file_exists
("$base${subdir}.plat"))
410 return $baseaff.($dirs[$base.$subdir] = "${subdir}_");
412 $path = $base.$subdir; # $path = 'IMG/distant/pdf' ou 'IMG/distant_pdf'
414 if (file_exists("$path/.ok"))
415 return $baseaff.($dirs[$base.$subdir] = "$subdir/");
417 @mkdir
($path, _SPIP_CHMOD
);
418 @chmod
($path, _SPIP_CHMOD
);
420 if (is_dir($path) && is_writable($path)) {
421 @touch
("$path/.ok");
422 spip_log("creation $base$subdir/");
423 return $baseaff.($dirs[$base.$subdir] = "$subdir/");
426 // en cas d'echec c'est peut etre tout simplement que le disque est plein :
427 // l'inode du fichier dir_test existe, mais impossible d'y mettre du contenu
428 // => sauf besoin express (define dans mes_options), ne pas creer le .plat
430 AND $f = @fopen
("$base${subdir}.plat", "w"))
433 spip_log("echec creation $base${subdir}");
434 if ($tantpis) return '';
436 $base = preg_replace(',^' . _DIR_RACINE
.',', '',$base);
438 raler_fichier($base . '/.plat');
440 spip_log("faux sous-repertoire $base${subdir}");
441 return $baseaff.($dirs[$base.$subdir] = "${subdir}_");
445 // Cette fonction parcourt recursivement le repertoire $dir, et renvoie les
446 // fichiers dont le chemin verifie le pattern (preg) donne en argument.
447 // En cas d'echec retourne un array() vide
449 // Usage: array preg_files('ecrire/data/', '[.]lock$');
451 // Attention, afin de conserver la compatibilite avec les repertoires '.plat'
452 // si $dir = 'rep/sous_rep_' au lieu de 'rep/sous_rep/' on scanne 'rep/' et on
453 // applique un pattern '^rep/sous_rep_'
454 // si $recurs vaut false, la fonction ne descend pas dans les sus repertoires
456 // http://doc.spip.org/@preg_files
457 function preg_files($dir, $pattern=-1 /* AUTO */, $maxfiles = 10000, $recurs=array()) {
462 // revenir au repertoire racine si on a recu dossier/truc
463 // pour regarder dossier/truc/ ne pas oublier le / final
464 $dir = preg_replace(',/[^/]*$,', '', $dir);
465 if ($dir == '') $dir = '.';
467 if (@is_dir
($dir) AND is_readable($dir) AND $d = @opendir
($dir)) {
468 while (($f = readdir($d)) !== false && ($nbfiles<$maxfiles)) {
469 if ($f[0] != '.' # ignorer . .. .svn etc
471 AND $f != 'remove.txt'
472 AND is_readable($f = "$dir/$f")) {
474 if (preg_match(";$pattern;iS", $f))
480 else if (is_dir($f) AND is_array($recurs)){
482 if (!is_string($rp) OR !strlen($rp)) $rp=$f; # realpath n'est peut etre pas autorise
483 if (!isset($recurs[$rp])) {
485 $beginning = $fichiers;
486 $end = preg_files("$f/", $pattern,
487 $maxfiles-$nbfiles, $recurs);
488 $fichiers = array_merge((array)$beginning, (array)$end);
489 $nbfiles = count($fichiers);