spip_nursit/plugins-dist/dist/nursit/memoization/public/cacher.php
2023-06-01 17:30:12 +02:00

382 lines
14 KiB
PHP

<?php
/***************************************************************************\
* SPIP, Systeme de publication pour l'internet *
* *
* Copyright (c) 2001-2018 *
* 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;
// par defaut pas de progressivite d'invalidation du cache : duree=0
if (!defined("_DUREE_INVALIDATION_PROGRESSIVE_CACHE"))
define("_DUREE_INVALIDATION_PROGRESSIVE_CACHE",0);
// https://code.spip.net/@generer_nom_fichier_cache
function generer_nom_fichier_cache($contexte, $page) {
// l'indicateur sert a savoir un peu de quoi il s'agit
// quand on regarde dans le cache ; on le met a la fin
// du nom pour que ca "melange" mieux sous memcache
$indicateur = is_array($page)
? $page['contexte_implicite']['cache'] # SPIP 2.1
: strval($page); # SPIP 2.0 ou autre
return
'cache:'
. md5(var_export(array($contexte, $page),true).'-'.$GLOBALS['dossier_squelettes'].'-'.(isset($GLOBALS['marqueur'])?$GLOBALS['marqueur']:''))
. '-' . $indicateur;
}
// Parano : on signe le cache, afin d'interdire un hack d'injection
// si le stockage est partagé (ie memcache, apcu...)
function cache_signature(&$page) {
if (!isset($GLOBALS['meta']['cache_signature'])){
include_spip('inc/acces');
include_spip('auth/sha256.inc');
$sigfunc = function_exists('_nano_sha256') ? '_nano_sha256' : 'md5';
ecrire_meta('cache_signature', $sigfunc($_SERVER["DOCUMENT_ROOT"] . $_SERVER["SERVER_SIGNATURE"] . creer_uniqid()), 'non');
}
return crc32($GLOBALS['meta']['cache_signature'].$page['texte']);
}
/**
* gestion des delais d'expiration du cache...
* $page passee par reference pour accelerer
*
* La fonction retourne
* 1 si il faut mettre le cache a jour
* 0 si le cache est valide
* -1 si il faut calculer sans stocker en cache
*
* @param array $page
* @param int $date
* @return int -1|0|1
*/
/// https://code.spip.net/@cache_valide
function cache_valide(&$page, $date) {
$now = $_SERVER['REQUEST_TIME'];
// Apparition d'un nouvel article post-date ?
if (isset($GLOBALS['meta']['post_dates'])
and $GLOBALS['meta']['post_dates'] == 'non'
and isset($GLOBALS['meta']['date_prochain_postdate'])
and $now > $GLOBALS['meta']['date_prochain_postdate']
) {
spip_log('Un article post-date invalide le cache');
include_spip('inc/rubriques');
calculer_prochain_postdate(true);
}
if (defined('_VAR_NOCACHE') AND _VAR_NOCACHE) return -1;
if (isset($GLOBALS['meta']['cache_inhib']) AND $_SERVER['REQUEST_TIME'] AND $_SERVER['REQUEST_TIME']<$GLOBALS['meta']['cache_inhib']) return -1;
if (isset($GLOBALS['var_nocache']) AND $GLOBALS['var_nocache']) return -1;
if (defined('_NO_CACHE')) return (_NO_CACHE==0 AND !isset($page['texte']))?1:_NO_CACHE;
// pas de cache ? on le met a jour, sauf pour les bots (on leur calcule la page sans mise en cache)
if (!$page OR !isset($page['texte']) OR !isset($page['entetes']['X-Spip-Cache'])) return _IS_BOT?-1:1;
// controle de la signature
if ($page['sig'] !== cache_signature($page))
return _IS_BOT?-1:1;
// #CACHE{n,statique} => on n'invalide pas avec derniere_modif
// cf. ecrire/public/balises.php, balise_CACHE_dist()
if (!isset($page['entetes']['X-Spip-Statique']) OR $page['entetes']['X-Spip-Statique'] !== 'oui') {
// Cache invalide par la meta 'derniere_modif'
// sauf pour les bots, qui utilisent toujours le cache
if (!_IS_BOT
AND !empty($GLOBALS['derniere_modif_invalide'])
AND !empty($GLOBALS['meta']['derniere_modif'])
AND $date < $GLOBALS['meta']['derniere_modif']){
// pour les admins on invalide tout de suite pour leur permettre de voir les modifs
if (isset($GLOBALS['visiteur_session']['statut'])
AND $GLOBALS['visiteur_session']['statut']=='0minirezo')
return 1;
// pour les autres on invalide progressivement pour repartir la charge
// avec une fonction de probabilite lineaire qui vaut
// 5% quand t=derniere_modif
// 100% quand t=derniere_modif+_DUREE_INVALIDATION_PROGRESSIVE_CACHE
static $refresh_ok = null;
if (is_null($refresh_ok)){
$dt = $_SERVER['REQUEST_TIME']-$GLOBALS['meta']['derniere_modif'];
if ($dt>=_DUREE_INVALIDATION_PROGRESSIVE_CACHE){
$refresh_ok = 1;
#spip_log("Cache refresh systematique : REFRESH", "dbgcache");
}
else {
if (_DUREE_INVALIDATION_PROGRESSIVE_CACHE){
$coeff = (1-$dt/_DUREE_INVALIDATION_PROGRESSIVE_CACHE);
$seuil = 15; // 15% de probabilite au depart
$prob = mt_rand(1, $seuil+(100-$seuil)*$coeff);
$refresh_ok = ($prob<$seuil ? 1 : 0);
#spip_log("Cache refresh progresif dt=$dt coeff=$coeff p=$prob" . ($refresh_ok ? " : REFRESH" : ""), "dbgcache");
}
else {
$refresh_ok = 1;
# spip_log("Cache refresh PAS progresif REQUEST_TIME=".$_SERVER['REQUEST_TIME'].", derniere_modif=".$GLOBALS['meta']['derniere_modif']." dt=$dt", "erreur_memoization");
};
}
}
// si pas de refresh force on laisse la main a la comparaison de date
// selon duree de cache
if ($refresh_ok)
return 1;
}
}
// Sinon comparer l'age du fichier a sa duree de cache
$duree = intval($page['entetes']['X-Spip-Cache']);
$cache_mark = (isset($GLOBALS['meta']['cache_mark'])?$GLOBALS['meta']['cache_mark']:0);
if ($duree == 0) #CACHE{0}
return -1;
// sauf pour les bots, qui utilisent toujours le cache
else if ((!_IS_BOT AND $date + $duree < $now)
# le cache est anterieur a la derniere purge : l'ignorer, meme pour les bots
OR $date<$cache_mark) {
if (_IS_BOT) return -1;
// si la charge est trop elevee on accepte de prendre un vieux cache
$load = function_exists('sys_getloadavg') ? sys_getloadavg() : array(0);
if ($load[0]>20) {
spip_log('load eleve ('. intval($load[0]).'), utilisation du cache pour '.var_export($page['source'],true).' sur '.self(), 'debug');
return 0;
}
// sinon on calcule
return 1;
} else {
return 0;
}
}
// Creer le fichier cache
# Passage par reference de $page par souci d'economie
// https://code.spip.net/@creer_cache
function creer_cache(&$page, &$chemin_cache, &$memo) {
// Ne rien faire si on est en preview, debug, ou si une erreur
// grave s'est presentee (compilation du squelette, MySQL, etc)
// le cas var_nocache ne devrait jamais arriver ici (securite)
// le cas spip_interdire_cache correspond a une ereur SQL grave non anticipable
if ((defined('_VAR_NOCACHE') AND _VAR_NOCACHE)
OR (isset($GLOBALS['var_nocache']) AND $GLOBALS['var_nocache']) // compat SPIP 2.x
OR defined('spip_interdire_cache'))
return;
// Si la page c1234 a un invalideur de session 'zz', sauver dans
// 'tmp/cache/MD5(chemin_cache)_zz'
if (isset($page['invalideurs'])
AND isset($page['invalideurs']['session'])) {
// on verifie que le contenu du chemin cache indique seulement
// "cache sessionne" ; sa date indique la date de validite
// des caches sessionnes
if (!is_array($tmp = $memo->get($chemin_cache))) {
$tmp = array(
'invalideurs' => array('session' => ''),
'lastmodified' => $_SERVER['REQUEST_TIME']
);
$ok = $memo->set($chemin_cache, $tmp);
spip_log((_IS_BOT?"Bot:":"")."Creation du cache sessionne $chemin_cache ". $memo->methode() ." pour "
. $page['entetes']['X-Spip-Cache']." secondes". ($ok?'':' (erreur!)'));
}
$chemin_cache .= '_'.$page['invalideurs']['session'];
}
// ajouter la date de production dans le cache lui meme
// (qui contient deja sa duree de validite)
$page['lastmodified'] = $_SERVER['REQUEST_TIME'];
// signer le contenu
$page['sig']= cache_signature($page);
// compresser si elle est > 16 ko
if (strlen($page['texte']) > 16384
AND function_exists('gzcompress')) {
$page['texte'] = gzcompress($z = $page['texte']);
$page['gz'] = true;
}
// memoizer...
// on ajoute une heure histoire de pouvoir tourner
// sur le cache quand la base de donnees est plantee (a tester)
$ok = $memo->set($chemin_cache, $page, 3600+$page['entetes']['X-Spip-Cache']);
// retablir le texte pour l'afficher
if (isset($z)) {
$page['texte'] = $z;
unset($page['gz']);
}
spip_log((_IS_BOT?"Bot:":"")."Creation du cache $chemin_cache ". $memo->methode() ." pour "
. $page['entetes']['X-Spip-Cache']." secondes". ($ok?'':' (erreur!)'));
// Inserer ses invalideurs
/* compat SPIP 1.9 : ne pas appeler les invalideurs du tout */
if (!(isset($GLOBALS['spip_version']) AND $GLOBALS['spip_version']<2)) {
include_spip('inc/invalideur');
maj_invalideurs($chemin_cache, $page);
}
}
// purger un petit cache (tidy ou recherche) qui ne doit pas contenir de
// vieux fichiers ; (cette fonction ne sert que dans des plugins obsoletes)
// https://code.spip.net/@nettoyer_petit_cache
function nettoyer_petit_cache($prefix, $duree = 300) {
// determiner le repertoire a purger : 'tmp/CACHE/rech/'
$dircache = sous_repertoire(_DIR_CACHE,$prefix);
if (spip_touch($dircache.'purger_'.$prefix, $duree, true)) {
foreach (preg_files($dircache,'[.]txt$') as $f) {
if ($_SERVER['REQUEST_TIME'] - (@file_exists($f)?@filemtime($f):0) > $duree)
spip_unlink($f);
}
}
}
// Interface du gestionnaire de cache
// Si son 3e argument est non vide, elle passe la main a creer_cache
// Sinon, elle recoit un contexte (ou le construit a partir de REQUEST_URI)
// et affecte les 4 autres parametres recus par reference:
// - use_cache qui vaut
// -1 s'il faut calculer la page sans la mettre en cache
// 0 si on peut utiliser un cache existant
// 1 s'il faut calculer la page et la mettre en cache
// - chemin_cache qui est le chemin d'acces au fichier ou vide si pas cachable
// - page qui est le tableau decrivant la page, si le cache la contenait
// - lastmodified qui vaut la date de derniere modif du fichier.
// Elle retourne '' si tout va bien
// un message d'erreur si le calcul de la page est totalement impossible
// https://code.spip.net/@public_cacher_dist
function public_cacher($contexte, &$use_cache, &$chemin_cache, &$page, &$lastmodified) {
$chemin_cache_session = false;
static $memo;
if (!isset($memo)) {
// cas d'un appel depuis un fichier options charge avant celui de memoization
if (!class_exists("MCache")){
include_spip("memoization_options");
}
$memo = new MCache(MCache::config_methode());
}
// Second appel, destine a l'enregistrement du cache sur le disque
if (isset($chemin_cache)) return creer_cache($page, $chemin_cache, $memo);
// Toute la suite correspond au premier appel
$contexte_implicite = $page['contexte_implicite'];
// Cas ignorant le cache car completement dynamique
if (
(!empty($_SERVER['REQUEST_METHOD']) and $_SERVER['REQUEST_METHOD'] === 'POST')
OR (substr($contexte_implicite['cache'],0,8)=='modeles/')
OR (_request('connect'))
// Mode auteur authentifie appelant de ecrire/ : il ne faut rien lire du cache
// et n'y ecrire que la compilation des squelettes (pas les pages produites)
// car les references aux repertoires ne sont pas relatifs a l'espace public
OR test_espace_prive()) {
$use_cache = -1;
$lastmodified = 0;
$chemin_cache = "";
$page = array();
return;
}
// Controler l'existence d'un cache nous correspondant
$chemin_cache = generer_nom_fichier_cache($contexte, $page);
$lastmodified = 0;
// charger le cache s'il existe
if (!is_array($page = $memo->get($chemin_cache)))
$page = array();
// s'il est sessionne, charger celui correspondant a notre session
if (isset($page['invalideurs'])
AND isset($page['invalideurs']['session'])) {
$chemin_cache_session = $chemin_cache . '_' . spip_session();
if (is_array($page_session = $memo->get($chemin_cache_session))
AND $page_session['lastmodified'] >= $page['lastmodified'])
$page = $page_session;
else
$page = array();
}
// dezip si on l'a zipe
if (isset($page['gz'])) {
$page['texte'] = gzuncompress($page['texte']);
unset($page['gz']);
}
// Si un calcul, recalcul [ou preview, mais c'est recalcul] est demande,
// on supprime le cache
if (((isset($GLOBALS['var_mode']) && $GLOBALS['var_mode']) OR (defined('_VAR_MODE') && _VAR_MODE)) &&
(isset($_COOKIE['spip_session'])
|| isset($_COOKIE['spip_admin'])
|| @file_exists(_ACCESS_FILE_NAME))
) {
$page = array('contexte_implicite'=>$contexte_implicite); // ignorer le cache deja lu
include_spip('inc/invalideur');
if (function_exists('retire_caches')) retire_caches($chemin_cache); # API invalideur inutile
$memo->del($chemin_cache);
if ($chemin_cache_session)
$memo->del($chemin_cache_session);
}
// $delais par defaut (pour toutes les pages sans #CACHE{})
if (!isset($GLOBALS['delais'])) {
if (!defined('_DUREE_CACHE_DEFAUT')) {
define('_DUREE_CACHE_DEFAUT', 24*3600);
}
$GLOBALS['delais'] = _DUREE_CACHE_DEFAUT;
}
// determiner la validite de la page
if ($page) {
$use_cache = cache_valide($page, isset($page['lastmodified']) ? $page['lastmodified']:null);
// le contexte implicite n'est pas stocke dans le cache, mais il y a equivalence
// par le nom du cache. On le reinjecte donc ici pour utilisation eventuelle au calcul
$page['contexte_implicite'] = $contexte_implicite;
if (!$use_cache)
return;
} else {
$page = array('contexte_implicite'=>$contexte_implicite);
$use_cache = cache_valide($page,0); // fichier cache absent : provoque le calcul
}
// Si pas valide mais pas de connexion a la base, le garder quand meme
if (!spip_connect()) {
if (isset($page['texte'])) {
$use_cache = 0;
}
else {
include_spip('inc/config');
spip_log("Erreur base de donnees, impossible utiliser " . lire_config('memoization/methode') . " $chemin_cache");
include_spip('inc/minipres');
return minipres(_T('info_travaux_titre'), _T('titre_probleme_technique'));
}
}
if ($use_cache < 0) $chemin_cache = '';
return;
}
// Faut-il decompresser ce cache ?
// (passage par reference pour alleger)
// https://code.spip.net/@gunzip_page
function gunzip_page(&$page) {
if (!empty($page['gz'])) {
$page['texte'] = gzuncompress($page['texte']);
$page['gz'] = false; // ne pas gzuncompress deux fois une meme page
}
}