www/ecrire/inc/flock.php

   1 <?php
   2
   3 /***************************************************************************\
   4  *  SPIP, Systeme de publication pour l'internet                           *
   5  *                                                                         *
   6  *  Copyright (c) 2001-2011                                                *
   7  *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
   8  *                                                                         *
   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 \***************************************************************************/
  12
  13
  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$,', $_ENV["HTTP_HOST"]));
  19
  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
  23
  24 if (_SPIP_LOCK_MODE==2)
  25         include_spip('inc/nfslock');
  26
  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))
  32                         // verrou
  33                         @flock($fl, $verrou);
  34                 return $fl;
  35         }
  36         elseif(_SPIP_LOCK_MODE==2) {
  37                 if (($verrou = spip_nfslock($fichier)) && ($fl = @fopen($fichier,$mode))){
  38                         $GLOBALS['liste_verrous'][$fl] = array($fichier,$verrou);
  39                         return $fl;
  40                 }
  41                 else return false;
  42         }
  43         return @fopen($fichier,$mode);
  44 }
  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);
  49         }
  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]);
  53         }
  54         return @fclose($handle);
  55 }
  56
  57
  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')
  62                 AND (
  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')
  68                 )
  69                         return $contenu;
  70                 else
  71                         $contenu = @file($fichier);
  72         } else
  73                         $contenu = @gzfile($fichier);
  74         return is_array($contenu)?join('', $contenu):(string)$contenu;
  75 }
  76
  77 // options = array(
  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) {
  82         $contenu = '';
  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))
  86                 return false;
  87
  88         #spip_timer('lire_fichier');
  89
  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);
  94
  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);
 101                         return false;
 102                 }
 103
 104                 // liberer le verrou
 105                 spip_fclose_unlock($fl);
 106
 107                 // Verifications
 108                 $ok = true;
 109                 if ($options['phpcheck'] == 'oui')
 110                         $ok &= (preg_match(",[?]>\n?$,", $contenu));
 111
 112                 #spip_log("$fread $fichier ".spip_timer('lire_fichier'));
 113                 if (!$ok)
 114                         spip_log("echec lecture $fichier");
 115
 116                 return $ok;
 117         }
 118         return false;
 119 }
 120
 121 //
 122 // Ecrire un fichier de maniere un peu sure
 123 // $ecrire_quand_meme ne sert plus mais est conservee dans l'appel pour compatibilite
 124 //
 125 // zippe les fichiers .gz
 126 // http://doc.spip.org/@ecrire_fichier
 127 function ecrire_fichier ($fichier, $contenu, $ecrire_quand_meme = false, $truncate=true) {
 128
 129         #spip_timer('ecrire_fichier');
 130
 131         // verrouiller le fichier destination
 132         if ($fp = spip_fopen_lock($fichier, 'a',LOCK_EX)) {
 133         // ecrire les donnees, compressees le cas echeant
 134         // (on ouvre un nouveau pointeur sur le fichier, ce qui a l'avantage
 135         // de le recreer si le locker qui nous precede l'avait supprime...)
 136                 if (substr($fichier, -3) == '.gz')
 137                         $contenu = gzencode($contenu);
 138                 // si c'est une ecriture avec troncation , on fait plutot une ecriture complete a cote suivie unlink+rename
 139                 // pour etre sur d'avoir une operation atomique
 140                 // y compris en NFS : http://www.ietf.org/rfc/rfc1094.txt
 141                 // sauf sous wintruc ou ca ne marche pas
 142                 $ok = false;
 143                 if ($truncate AND _OS_SERVEUR != 'windows'){
 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));
 149                                 $ok = ($s == $a);
 150                                 spip_fclose_unlock($fp2);
 151                                 spip_fclose_unlock($fp);
 152                                 // unlink direct et pas spip_unlink car on avait deja le verrou
 153                                 @unlink($fichier);
 154                                 // le rename aussitot, atomique quand on est pas sous windows
 155                                 // au pire on arrive en second en cas de concourance, et le rename echoue
 156                                 // --> on a la version de l'autre process qui doit etre identique
 157                                 @rename("$fichier.$id",$fichier);
 158                                 // precaution en cas d'echec du rename
 159                                 if (!_TEST_FILE_EXISTS OR @file_exists("$fichier.$id"))
 160                                         @unlink("$fichier.$id");
 161                                 if ($ok)
 162                                         $ok = file_exists($fichier);
 163                         }
 164                         else
 165                                 // echec mais penser a fermer ..
 166                                 spip_fclose_unlock($fp);
 167                 }
 168                 // sinon ou si methode precedente a echoueee
 169                 // on se rabat sur la methode ancienne
 170                 if (!$ok){
 171                         // ici on est en ajout ou sous windows, cas desespere
 172                         if ($truncate)
 173                                 @ftruncate($fp,0);
 174                         $s = @fputs($fp, $contenu, $a = strlen($contenu));
 175
 176                         $ok = ($s == $a);
 177                         spip_fclose_unlock($fp);
 178                 }
 179
 180         // liberer le verrou et fermer le fichier
 181                 @chmod($fichier, _SPIP_CHMOD & 0666);
 182                 if ($ok) return $ok;
 183         }
 184
 185         include_spip('inc/autoriser');
 186         if (autoriser('chargerftp'))
 187                 raler_fichier($fichier);
 188         spip_unlink($fichier);
 189         return false;
 190 }
 191
 192 /**
 193  * Ecrire un contenu dans un fichier encapsule en php pour en empecher l'acces en l'absence
 194  * de htaccess
 195  * @param string $fichier
 196  * @param <type> $contenu
 197  * @param <type> $ecrire_quand_meme
 198  * @param <type> $truncate
 199  */
 200 function ecrire_fichier_securise ($fichier, $contenu, $ecrire_quand_meme = false, $truncate=true) {
 201         if (substr($fichier,-4) !== '.php')
 202                 spip_log('Erreur de programmation: '.$fichier.' doit finir par .php');
 203         $contenu = "<"."?php die ('Acces interdit'); ?".">\n" . $contenu;
 204         return ecrire_fichier($fichier, $contenu, $ecrire_quand_meme, $truncate);
 205 }
 206
 207 /**
 208  * Lire un fichier encapsule en php
 209  * @param <type> $fichier
 210  * @param <type> $contenu
 211  * @param <type> $options
 212  */
 213 function lire_fichier_securise ($fichier, &$contenu, $options=false) {
 214         if ($res = lire_fichier($fichier,$contenu,$options)){
 215                 $contenu = substr($contenu,strlen("<"."?php die ('Acces interdit'); ?".">\n"));
 216         }
 217         return $res;
 218 }
 219
 220 // http://doc.spip.org/@raler_fichier
 221 function raler_fichier($fichier)
 222 {
 223         include_spip('inc/minipres');
 224         $dir = dirname($fichier);
 225         http_status(401);
 226         echo minipres(_T('texte_inc_meta_2'), "<h4 style='color: red'>"
 227                 . _T('texte_inc_meta_1', array('fichier' => $fichier))
 228                 . " <a href='"
 229                 . generer_url_ecrire('install', "etape=chmod&test_dir=$dir")
 230                 . "'>"
 231                 . _T('texte_inc_meta_2')
 232                 . "</a> "
 233                 . _T('texte_inc_meta_3',
 234                      array('repertoire' => joli_repertoire($dir)))
 235                 . "</h4>\n");
 236         exit;
 237 }
 238
 239 //
 240 // Retourne Vrai si son premier argument a ete cree il y a moins de N secondes
 241 //
 242
 243 // http://doc.spip.org/@jeune_fichier
 244 function jeune_fichier($fichier, $n)
 245 {
 246         if (!file_exists($fichier)) return false;
 247         if (!$c = @filemtime($fichier)) return false;
 248         return (time()-$n <= $c);
 249 }
 250
 251 //
 252 // Supprimer le fichier de maniere sympa (flock)
 253 //
 254 // http://doc.spip.org/@supprimer_fichier
 255 function supprimer_fichier($fichier, $lock=true) {
 256         if (!@file_exists($fichier))
 257                 return true;
 258
 259         if ($lock) {
 260                 // verrouiller le fichier destination
 261                 if (!$fp = spip_fopen_lock($fichier, 'a', LOCK_EX))
 262                         return false;
 263
 264                 // liberer le verrou
 265                 spip_fclose_unlock($fp);
 266         }
 267
 268         // supprimer
 269         return @unlink($fichier);
 270 }
 271 // Supprimer brutalement, si le fichier existe
 272 // http://doc.spip.org/@spip_unlink
 273 function spip_unlink($f) {
 274         if (!is_dir($f))
 275                 supprimer_fichier($f,false);
 276         else {
 277                 @unlink("$f/.ok");
 278                 @rmdir($f);
 279         }
 280 }
 281
 282 //
 283 // Retourne $base/${subdir}/ si le sous-repertoire peut etre cree,
 284 // $base/${subdir}_ sinon ; $nobase signale qu'on ne veut pas de $base/
 285 // On peut aussi ne donner qu'un seul argument,
 286 // subdir valant alors ce qui suit le dernier / dans $base
 287 //
 288 // http://doc.spip.org/@sous_repertoire
 289 function sous_repertoire($base, $subdir='', $nobase = false, $tantpis=false) {
 290         static $dirs = array();
 291
 292         $base = str_replace("//", "/", $base);
 293
 294         # suppr le dernier caractere si c'est un / ou un _
 295         $base = rtrim($base, '/_');
 296
 297         if (!strlen($subdir)) {
 298                 $n = strrpos($base, "/");
 299                 if ($n === false) return $nobase ? '' : ($base .'/');
 300                 $subdir = substr($base, $n+1);
 301                 $base = substr($base, 0, $n+1);
 302         } else {
 303                 $base .= '/';
 304                 $subdir = str_replace("/", "", $subdir);
 305         }
 306
 307         $baseaff = $nobase ? '' : $base;
 308         if (isset($dirs[$base.$subdir]))
 309                 return $baseaff.$dirs[$base.$subdir];
 310
 311
 312         if (_CREER_DIR_PLAT AND @file_exists("$base${subdir}.plat"))
 313                 return $baseaff.($dirs[$base.$subdir] = "${subdir}_");
 314
 315         $path = $base.$subdir; # $path = 'IMG/distant/pdf' ou 'IMG/distant_pdf'
 316
 317         if (file_exists("$path/.ok"))
 318                 return $baseaff.($dirs[$base.$subdir] = "$subdir/");
 319
 320         @mkdir($path, _SPIP_CHMOD);
 321         @chmod($path, _SPIP_CHMOD);
 322
 323         $ok = false;
 324         if ($test = @fopen("$path/dir_test.php", "w")) {
 325                 @fputs($test, '<'.'?php $ok = true; ?'.'>');
 326                 @fclose($test);
 327                 @include("$path/dir_test.php");
 328                 spip_unlink("$path/dir_test.php");
 329         }
 330         if ($ok) {
 331                 @touch ("$path/.ok");
 332                 spip_log("creation $base$subdir/");
 333                 return $baseaff.($dirs[$base.$subdir] = "$subdir/");
 334         }
 335
 336         // en cas d'echec c'est peut etre tout simplement que le disque est plein :
 337         // l'inode du fichier dir_test existe, mais impossible d'y mettre du contenu
 338         // => sauf besoin express (define dans mes_options), ne pas creer le .plat
 339         if (_CREER_DIR_PLAT
 340         AND $f = @fopen("$base${subdir}.plat", "w"))
 341                 fclose($f);
 342         else {
 343                 spip_log("echec creation $base${subdir}");
 344                 if ($tantpis) return '';
 345                 if (!_DIR_RESTREINT)
 346                         $base = preg_replace(',^' . _DIR_RACINE .',', '',$base);
 347                 if ($test) $base .= $subdir;
 348                 raler_fichier($base . '/.ok');
 349         }
 350         spip_log("faux sous-repertoire $base${subdir}");
 351         return $baseaff.($dirs[$base.$subdirs] = "${subdir}_");
 352 }
 353
 354 //
 355 // Cette fonction parcourt recursivement le repertoire $dir, et renvoie les
 356 // fichiers dont le chemin verifie le pattern (preg) donne en argument.
 357 // En cas d'echec retourne un array() vide
 358 //
 359 // Usage: array preg_files('ecrire/data/', '[.]lock$');
 360 //
 361 // Attention, afin de conserver la compatibilite avec les repertoires '.plat'
 362 // si $dir = 'rep/sous_rep_' au lieu de 'rep/sous_rep/' on scanne 'rep/' et on
 363 // applique un pattern '^rep/sous_rep_'
 364 // si $recurs vaut false, la fonction ne descend pas dans les sus repertoires
 365 //
 366 // http://doc.spip.org/@preg_files
 367 function preg_files($dir, $pattern=-1 /* AUTO */, $maxfiles = 10000, $recurs=array()) {
 368         $nbfiles = 0;
 369         if ($pattern == -1)
 370                 $pattern = "^$dir";
 371         $fichiers = array();
 372         // revenir au repertoire racine si on a recu dossier/truc
 373         // pour regarder dossier/truc/ ne pas oublier le / final
 374         $dir = preg_replace(',/[^/]*$,', '', $dir);
 375         if ($dir == '') $dir = '.';
 376
 377         if (@is_dir($dir) AND is_readable($dir) AND $d = @opendir($dir)) {
 378                 while (($f = readdir($d)) !== false && ($nbfiles<$maxfiles)) {
 379                         if ($f[0] != '.' # ignorer . .. .svn etc
 380                         AND $f != 'CVS'
 381                         AND $f != 'remove.txt'
 382                         AND is_readable($f = "$dir/$f")) {
 383                                 if (is_file($f)) {
 384                                         if (preg_match(";$pattern;iS", $f))
 385                                         {
 386                                                 $fichiers[] = $f;
 387                                                 $nbfiles++;
 388                                         }
 389                                 }
 390                                 else if (is_dir($f) AND is_array($recurs)){
 391                                         $rp = @realpath($f);
 392                                         if (!is_string($rp) OR !strlen($rp)) $rp=$f; # realpath n'est peut etre pas autorise
 393                                         if (!isset($recurs[$rp])) {
 394                                                 $recurs[$rp] = true;
 395                                                 $beginning = $fichiers;
 396                                                 $end = preg_files("$f/", $pattern,
 397                                                         $maxfiles-$nbfiles, $recurs);
 398                                                 $fichiers = array_merge((array)$beginning, (array)$end);
 399                                                 $nbfiles = count($fichiers);
 400                                         }
 401                                 }
 402                         }
 403                 }
 404                 closedir($d);
 405         }
 406         sort($fichiers);
 407         return $fichiers;
 408 }
 409
 410 ?>