<?php
/**
 * @package Spin
 * @copyright InterNLnet, 2007
 */

/**
 * This class implements a caching system which uses a memcache
 * server to store the cached data.
 *
 * @package Spin
 * @subpackage Modules
 */
class spinmod_cache_xcache
{
  // {{{ Class variables

  /** 
   * The username for xcache admin 
   *
   * @var string
   */
  private $username;

  /**
   * The password for xcache admin
   *
   * @var string
   */
  private $password;
  // }}}

  // {{{ Object constructor
  public function __construct()
  {
    global $spin;

    // Check if the xcache PHP module is available.
    if (!extension_loaded('xcache')) throw new CacheConfigError(
      "The xcache caching backend is enabled, but PHP lacks xcache " .
      "support. Either use a differen backend or install the " .
      "PHP xcache extension."
    );

    // Check if the php ini variable xcache.var_size isset.
    if (@ini_get("xcache.var_size") <= 0)
      throw new CacheConfigError(
        "xcache.var_size is either 0 or too small to enable var data caching"
      );

    // Load the username and password from the config
    $this->username = $spin->config->cache['xcache.username'];
    $this->password = $spin->config->cache['xcache.password'];

    if (!$this->username || !$this->password)
      throw new CacheConfigError(
        "The xcache caching backend is enabled, but the username " .
        "and/or password are not set in the configuration"
      );
  }
  // }}}

  // {{{ Method: put()
  public function put($bin, $key, $val, $ttl = 300, $version = NULL)
  {
    @xcache_set($bin.'_'.$key, array($val,$version), $ttl);
  }
  // }}}

  // {{{ Method: get()
  public function get($bin, $key, $version = NULL)
  {
    @$get = xcache_get($bin.'_'.$key); 

    if (is_array($get) && count($get) &&
        ($version == NULL || $get[1] != NULL && $get[1] == $version)) {
      return $get[0];
    }

    return NULL;
  }
  // }}}

  // {{{ Method: del()
  public function del($bin, $key)
  {
    @xcache_unset($bin.'_'.$key);
  }
  // }}}

  // {{{ Method: purge()
  public function purge()
  {
    // Login for xcache admin
    // Oh if you find this ugly, blame the xcache guys.
    $_SERVER["PHP_AUTH_USER"] = $this->username;
    $_SERVER["PHP_AUTH_PW"] = $this->password;

    @xcache_clear_cache(XC_TYPE_VAR, 0);
  }
  // }}}
}

?>