inc-cache.php3

<?php

/***************************************************************************\
 *  SPIP, Systeme de publication pour l'internet                           *
 *                                                                         *
 *  Copyright (c) 2001-2006                                                *
 *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
 *                                                                         *
 *  Ce programme est un logiciel libre distribue sous licence GNU/GPL.     *
 *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
\***************************************************************************/

if (!defined("_ECRIRE_INC_VERSION")) return;

//
// Le format souhaite : "CACHE/a/bout-d-url.md5(.gz)"
// Attention a modifier simultanement le sanity check de
// la fonction retire_cache()
//
function generer_nom_fichier_cache($contexte, $fond) {
	global $_SERVER;
	global $flag_gz;

	if ($contexte === NULL) {
		$fichier_requete = nettoyer_uri();
	} else {
		$fichier_requete = $fond;
		foreach ($contexte as $var=>$val)
			$fichier_requete .= "&$var=$val";
	}

	$fichier_cache = ereg_replace('^/+', '', $fichier_requete);
	$fichier_cache = ereg_replace('\.[a-zA-Z0-9]*', '', $fichier_cache);
	$fichier_cache = ereg_replace('&[^&]+=([^&]+)', '&\1', $fichier_cache);
	$fichier_cache = rawurlencode(strtr($fichier_cache, '/&-', '--_'));
	if (strlen($fichier_cache) > 24)
		$fichier_cache = substr(ereg_replace('([a-zA-Z]{1,3})[^-]*-',
		'\1-', $fichier_cache), -22);

	// Pour la page d'accueil
	if (!$fichier_cache)
		$fichier_cache = 'INDEX-';

	// morceau de md5 selon HOST et $fond
	$md_cache = md5($fichier_requete . $_SERVER['HTTP_HOST'] . $fond);
	$fichier_cache .= '.'.substr($md_cache, 1, 8);

	// Sous-repertoires 0...9a..f/
	$subdir = creer_repertoire(_DIR_CACHE, substr($md_cache, 0, 1));

	include_ecrire('inc_acces');
	verifier_htaccess(_DIR_CACHE);

	$gzip = $flag_gz ? '.gz' : '';

	return _DIR_CACHE . $subdir.$fichier_cache.$gzip;
}

//
// Destruction des fichiers caches invalides
//

// Securite : est sur que c'est un cache
function retire_cache($cache) {

	if (preg_match('|^' . preg_quote(_DIR_CACHE) .
		"([0-9a-f]/)?([0-9]+/)?[^.][\-_\%0-9a-z]+\.[0-9a-f]+(\.gz)?$|i",
		       $cache)) {
		// supprimer le fichier (de facon propre)
		supprimer_fichier($cache);
	} else
		spip_log("Impossible de retirer $cache");
}

// Supprimer les caches marques "x"
function retire_caches($chemin = '') {

	// recuperer la liste des caches voues a la suppression
	$suppr = array();

	// En priorite le cache qu'on appelle maintenant
	if ($chemin) {
		$q = spip_query("SELECT fichier FROM spip_caches
		WHERE fichier = '".addslashes($chemin)."' AND type='x' LIMIT 1");
		if ($r = spip_fetch_array($q))
			$suppr[$r['fichier']] = true;
	}

	// Et puis une centaine d'autres
	if ($GLOBALS['meta']['invalider_caches']) {
		$compte = 1;
		effacer_meta('invalider_caches'); # concurrence
		ecrire_metas();

		$q = spip_query("SELECT fichier FROM spip_caches
		WHERE type='x' LIMIT 100");
		while ($r = spip_fetch_array($q)) {
			$compte ++;	# compte le nombre de resultats vus (y compris doublons)
			$suppr[$r['fichier']] = true;
		}
	}

	if ($n = count($suppr)) {
		spip_log ("Retire $n caches");
		foreach ($suppr as $cache => $ignore)
			retire_cache($cache);
		spip_query("DELETE FROM spip_caches WHERE "
		.calcul_mysql_in('fichier', "'".join("','",array_keys($suppr))."'") );
	}

	// Si on a regarde (compte > 0), signaler s'il reste des caches invalides
	if ($compte > 0) {
		if ($compte > 100) # s'il y en a 101 c'est qu'on n'a pas fini
			ecrire_meta('invalider_caches', 'oui');
		else
			effacer_meta('invalider');
		ecrire_metas();
	}
}

// gestion des delais par specification a l'exterieur du squelette

function cache_valide($chemin_cache, $contenu, $date) {
	global $delais;

	if (!isset($delais)) $delais = 3600;

	if (!$delais) return -1;

	if (!$contenu) return $delais;

	if ((time() - $date) > $delais) return $delais;

	return 0;
}

// gestion des delais par specification a l'interieur du squelette

function cache_valide_autodetermine($chemin_cache, $page, $date) {

	if (!$page) return 1;

	if (strlen($duree = $page['entetes']['X-Spip-Cache']))
		return ($date + intval($duree) > time()) ? 0 : $t;

	// squelette ancienne maniere, on se rabat sur le vieux modele
	return cache_valide($chemin_cache, $contenu, $date);
}

// retourne le nom du fichier cache, 
// et affecte le param use_cache avec un nombre N:
// < 0 s'il faut calculer la page sans la mettre en cache
// = 0 si on peut utiliser un cache existant
// > 0 s'il faut calculer la page et le mette en cache pendant N secondes
//

function determiner_cache(&$use_cache, $contexte, $fond) {
	global $_SERVER;

	// pour tester si la base est dispo

	include_local(_FILE_CONNECT);

	// cas ignorant le cache car complement dynamique
	if ($_SERVER['REQUEST_METHOD'] == 'POST') {
		$use_cache = -1;
		return array('','',0);
	}
	
	$chemin_cache = generer_nom_fichier_cache($contexte, $fond);

	// cas sans jamais de calcul pour raison interne
	if ($_SERVER['REQUEST_METHOD'] == 'HEAD') {
		$use_cache = 0;
		return array($chemin_cache, @filemtime($chemin_cache), 0);
	}

	// Faut-il effacer des pages invalidees (en particulier ce cache-ci) ?
	if ($GLOBALS['meta']['invalider'] AND $GLOBALS['db_ok']) {
		include_ecrire('inc_meta');
		lire_metas();
		retire_caches($chemin_cache);
	}

	// cas sans jamais de cache pour raison interne
	if ($GLOBALS['var_mode'] &&
		($GLOBALS['_COOKIE']['spip_session']
		 || $GLOBALS['_COOKIE']['spip_admin']
		 || @file_exists(_ACCESS_FILE_NAME))) {
	    supprimer_fichier($chemin_cache);
	}

	$ok = lire_fichier($chemin_cache, $page);
	$time = @filemtime($chemin_cache);
	$page = restaurer_meta_donnees ($page);
	$use_cache = cache_valide_autodetermine($chemin_cache, $page, $time);

	if (!$use_cache AND $ok) return array($chemin_cache, $page, $time);

	// Si pas valide mais pas de connexion a la base, le garder quand meme

	if (!$GLOBALS['db_ok']) {
		if (file_exists($chemin_cache))
  			$use_cache = 0 ;
		else {
			spip_log("Erreur base de donnees, impossible utiliser $chemin_cache");
			include_ecrire('inc_minipres');
			minipres(_T('info_travaux_titre'),  _T('titre_probleme_technique'));
		}
	}

	return array((($use_cache < 0) ? "" : $chemin_cache), $page, $time);
}

// Passage par reference juste par souci d'economie

function creer_cache(&$page, $chemin_cache, $duree) {
	// Entrer dans la base les invalideurs calcules par le compilateur
	// (et supprimer les anciens)

	// arbitrage entre ancien et nouveau modele de delai:
	// primaute a la duree de vie de la page donnee a l'interieur de la page 
	if (strlen($t = $page['entetes']['X-Spip-Cache']))
		$duree = intval($t);

	include_ecrire('inc_invalideur');
	maj_invalideurs($chemin_cache, $page['invalideurs'], $duree);

	// Enregistrer le fichier cache qui contient
	// 1) la carte d'identite de la page (ses "globals", genre id_article=7)
	// 2) son contenu
	$page['signal']['process_ins'] = $page['process_ins'];
	$page['signal']['entetes'] = $page['entetes'];
	$r = ecrire_fichier($chemin_cache,
		"<!-- "
		. str_replace("\n", " ", serialize($page['signal']))
		. " -->\n"
		. $page['texte']);

	// Nouveau cache : creer un invalideur 't' fixant la date
	// d'expiration et la taille du fichier
	if ($r) {
			// Ici on ajoute 3600s pour eviter toute concurrence
			// entre un invalideur et un appel public de page
		$bedtime = time() + $duree + 3600;
		$taille = @filesize($chemin_cache);
		$fichier = addslashes($chemin_cache);
		spip_query("INSERT IGNORE INTO spip_caches (fichier,id,type,taille) VALUES ('$fichier','$bedtime','t','$taille')");
	}
}

function restaurer_meta_donnees ($contenu) {

	if (preg_match("/^<!-- ([^\n]*) -->\n/ms", $contenu, $match)) {
		$meta_donnees = unserialize($match[1]);
		if (is_array($meta_donnees)) {
			foreach ($meta_donnees as $var=>$val) {
				$page[$var] = $val;
			}
		}

	}

	$page['texte'] = substr($contenu, strlen($match[0]));
	return $page;
}


// purger un petit cache (tidy ou recherche) qui ne doit pas contenir de
// vieux fichiers
function nettoyer_petit_cache($prefix, $duree = 300) {
	// determiner le repertoire a purger : 'CACHE/rech/'
	$dircache = _DIR_CACHE.creer_repertoire(_DIR_CACHE,$prefix);
	if (spip_touch($dircache.'purger_'.$prefix, $duree, true)) {
		if ($h = @opendir($dircache)) {
			while (($f = @readdir($h)) !== false) {
				if (preg_match(',^'.$prefix.'_,', $f)
				AND time() - filemtime("$dircache$f") > $duree) {
					@unlink("$dircache$f");
					@unlink("$dircache$f.err"); # pour tidy
				}
			}
		}
	}
}

?>