class Drupal_Apache_Solr_Service in Apache Solr Search 5.2

Same name and namespace in other branches

6 Drupal_Apache_Solr_Service.php \Drupal_Apache_Solr_Service
6.2 Drupal_Apache_Solr_Service.php \Drupal_Apache_Solr_Service

Hierarchy

class \Apache_Solr_Service
- class \Drupal_Apache_Solr_Service

Expanded class hierarchy of Drupal_Apache_Solr_Service

1 string reference to 'Drupal_Apache_Solr_Service'

apachesolr_get_solr in ./apachesolr.module: Factory method for solr singleton object. Structure allows for an arbitrary number of solr objects to be used based on the host, port, path combination. Get an instance like this: $solr = apachesolr_get_solr();

File

./Drupal_Apache_Solr_Service.php, line 21

View source

class Drupal_Apache_Solr_Service extends Apache_Solr_Service {
  protected $luke;
  protected $luke_cid;
  protected $stats;
  const LUKE_SERVLET = 'admin/luke';
  const STATS_SERVLET = 'admin/stats.jsp';

  /**
   * Call the /admin/ping servlet, to test the connection to the server.
   *
   * @param $timeout
   *   maximum time to wait for ping in seconds, -1 for unlimited (default 2).
   * @return
   *   (float) seconds taken to ping the server, FALSE if timeout occurs.
   */
  public function ping($timeout = 2) {
    $start = microtime(TRUE);
    if ($timeout <= 0.0) {
      $timeout = -1;
    }

    // Attempt a HEAD request to the solr ping url.
    list($data, $headers) = $this
      ->_makeHttpRequest($this->_pingUrl, 'HEAD', array(), NULL, $timeout);
    $response = new Apache_Solr_Response($data, $headers);
    if ($response
      ->getHttpStatus() == 200) {

      // Add 0.1 ms to the ping time so we never return 0.0.
      return microtime(TRUE) - $start + 0.0001;
    }
    else {
      return FALSE;
    }
  }

  /**
   * Sets $this->luke with the meta-data about the index from admin/luke.
   */
  protected function setLuke($num_terms = 0) {
    if (empty($this->luke[$num_terms])) {
      $url = $this
        ->_constructUrl(self::LUKE_SERVLET, array(
        'numTerms' => "{$num_terms}",
        'wt' => self::SOLR_WRITER,
      ));
      $this->luke[$num_terms] = $this
        ->_sendRawGet($url);
      cache_set($this->luke_cid, 'cache_apachesolr', serialize($this->luke));
    }
  }

  /**
   * Get just the field meta-data about the index.
   */
  public function getFields($num_terms = 0) {
    return $this
      ->getLuke($num_terms)->fields;
  }

  /**
   * Get meta-data about the index.
   */
  public function getLuke($num_terms = 0) {
    if (!isset($this->luke[$num_terms])) {
      $this
        ->setLuke($num_terms);
    }
    return $this->luke[$num_terms];
  }

  /**
   * Sets $this->stats with the information about the Solr Core form /admin/stats.jsp
   */
  protected function setStats() {
    $data = $this
      ->getLuke();

    // Only try to get stats if we have connected to the index.
    if (empty($this->stats) && isset($data->index->numDocs)) {
      $url = $this
        ->_constructUrl(self::STATS_SERVLET);
      $this->stats_cid = "apachesolr:stats:" . md5($url);
      $cache = cache_get($this->stats_cid, 'cache_apachesolr');
      if (isset($cache->data)) {
        $this->stats = simplexml_load_string(unserialize($cache->data));
      }
      else {
        $response = $this
          ->_sendRawGet($url);
        $this->stats = simplexml_load_string($response
          ->getRawResponse());
        cache_set($this->stats_cid, 'cache_apachesolr', serialize($response
          ->getRawResponse()));
      }
    }
  }

  /**
   * Get information about the Solr Core.
   *
   * Returns a Simple XMl document
   */
  public function getStats() {
    if (!isset($this->stats)) {
      $this
        ->setStats();
    }
    return $this->stats;
  }

  /**
   * Get summary information about the Solr Core.
   */
  public function getStatsSummary() {
    $stats = $this
      ->getStats();
    $summary = array(
      '@pending_docs' => '',
      '@autocommit_time_seconds' => '',
      '@autocommit_time' => '',
      '@deletes_by_id' => '',
      '@deletes_by_query' => '',
      '@deletes_total' => '',
      '@schema_version' => '',
      '@core_name' => '',
    );
    if (!empty($stats)) {
      $docs_pending_xpath = $stats
        ->xpath('//stat[@name="docsPending"]');
      $summary['@pending_docs'] = (int) trim($docs_pending_xpath[0]);
      $max_time_xpath = $stats
        ->xpath('//stat[@name="autocommit maxTime"]');
      $max_time = (int) trim(current($max_time_xpath));

      // Convert to seconds.
      $summary['@autocommit_time_seconds'] = $max_time / 1000;
      $summary['@autocommit_time'] = format_interval($max_time / 1000);
      $deletes_id_xpath = $stats
        ->xpath('//stat[@name="deletesById"]');
      $summary['@deletes_by_id'] = (int) trim($deletes_id_xpath[0]);
      $deletes_query_xpath = $stats
        ->xpath('//stat[@name="deletesByQuery"]');
      $summary['@deletes_by_query'] = (int) trim($deletes_query_xpath[0]);
      $summary['@deletes_total'] = $summary['@deletes_by_id'] + $summary['@deletes_by_query'];
      $schema = $stats
        ->xpath('/solr/schema[1]');
      $summary['@schema_version'] = trim($schema[0]);
      $core = $stats
        ->xpath('/solr/core[1]');
      $summary['@core_name'] = trim($core[0]);
    }
    return $summary;
  }

  /**
   * Clear cached Solr data.
   */
  public function clearCache() {

    // Don't clear cached data if the server is unavailable.
    if (@$this
      ->ping()) {
      $this
        ->_clearCache();
    }
    else {
      throw new Exception('No Solr instance available when trying to clear the cache.');
    }
  }
  protected function _clearCache() {
    cache_clear_all("apachesolr:luke:", 'cache_apachesolr', TRUE);
    cache_clear_all("apachesolr:stats:", 'cache_apachesolr', TRUE);
    $this->luke = array();
    $this->stats = NULL;
  }

  /**
   * Clear the cache whenever we commit changes.
   *
   * @see Apache_Solr_Service::commit()
   */
  public function commit($optimize = TRUE, $waitFlush = TRUE, $waitSearcher = TRUE, $timeout = 3600) {
    parent::commit($optimize, $waitFlush, $waitSearcher, $timeout);
    $this
      ->_clearCache();
  }

  /**
   * Construct the Full URLs for the three servlets we reference
   *
   * @see Apache_Solr_Service::_initUrls()
   */
  protected function _initUrls() {
    parent::_initUrls();
    $this->_lukeUrl = $this
      ->_constructUrl(self::LUKE_SERVLET, array(
      'numTerms' => '0',
      'wt' => self::SOLR_WRITER,
    ));
  }

  /**
   * Make a request to a servlet (a path) that's not a standard path.
   *
   * @param string $servlet
   *   A path to be added to the base Solr path. e.g. 'extract/tika'
   *
   * @param array $params
   *   Any request parameters when constructing the URL.
   *
   * @param string $method
   *   'GET', 'POST', 'PUT', or 'HEAD'.
   *
   * @param array $request_headers
   *   Keyed array of header names and values.  Should include 'Content-Type'
   *   for POST or PUT.
   *
   * @param string $rawPost
   *   Must be an empty string unless method is POST or PUT.
   *
   * @param float $timeout
   *   Read timeout in seconds or FALSE.
   *
   * @return
   *  Apache_Solr_Response object
   */
  public function makeServletRequest($servlet, $params = array(), $method = 'GET', $request_headers = array(), $rawPost = '', $timeout = FALSE) {
    if ($method == 'GET' || $method == 'HEAD') {

      // Make sure we are not sending a request body.
      $rawPost = '';
    }

    // Add default params.
    $params += array(
      'wt' => self::SOLR_WRITER,
    );
    $url = $this
      ->_constructUrl($servlet, $params);
    list($data, $headers) = $this
      ->_makeHttpRequest($url, $method, $request_headers, $rawPost, $timeout);
    $response = new Apache_Solr_Response($data, $headers, $this->_createDocuments, $this->_collapseSingleValueArrays);
    $code = (int) $response
      ->getHttpStatus();
    if ($code != 200) {
      $message = $response
        ->getHttpStatusMessage();
      if ($code >= 400 && $code != 403 && $code != 404) {

        // Add details, like Solr's exception message.
        $message .= $response
          ->getRawResponse();
      }
      throw new Exception('"' . $code . '" Status: ' . $message);
    }
    return $response;
  }

  /**
   * Put Luke meta-data from the cache into $this->luke when we instantiate.
   *
   * @see Apache_Solr_Service::__construct()
   */
  public function __construct($host = 'localhost', $port = 8180, $path = '/solr/') {
    parent::__construct($host, $port, $path);
    $this->luke_cid = "apachesolr:luke:" . md5($this->_lukeUrl);
    $cache = cache_get($this->luke_cid, 'cache_apachesolr');
    if (isset($cache->data)) {
      $this->luke = unserialize($cache->data);
    }
  }

  /**
   * Central method for making a get operation against this Solr Server
   *
   * @see Apache_Solr_Service::_sendRawGet()
   */
  protected function _sendRawGet($url, $timeout = FALSE) {
    list($data, $headers) = $this
      ->_makeHttpRequest($url, 'GET', array(), '', $timeout);
    $response = new Apache_Solr_Response($data, $headers, $this->_createDocuments, $this->_collapseSingleValueArrays);
    $code = (int) $response
      ->getHttpStatus();
    if ($code != 200) {
      $message = $response
        ->getHttpStatusMessage();
      if ($code >= 400 && $code != 403 && $code != 404) {

        // Add details, like Solr's exception message.
        $message .= $response
          ->getRawResponse();
      }
      throw new Exception('"' . $code . '" Status: ' . $message);
    }
    return $response;
  }

  /**
   * Central method for making a post operation against this Solr Server
   *
   * @see Apache_Solr_Service::_sendRawGet()
   */
  protected function _sendRawPost($url, $rawPost, $timeout = FALSE, $contentType = 'text/xml; charset=UTF-8') {
    $request_headers = array(
      'Content-Type' => $contentType,
    );
    list($data, $headers) = $this
      ->_makeHttpRequest($url, 'POST', $request_headers, $rawPost, $timeout);
    $response = new Apache_Solr_Response($data, $headers, $this->_createDocuments, $this->_collapseSingleValueArrays);
    $code = (int) $response
      ->getHttpStatus();
    if ($code != 200) {
      $message = $response
        ->getHttpStatusMessage();
      if ($code >= 400 && $code != 403 && $code != 404) {

        // Add details, like Solr's exception message.
        $message .= $response
          ->getRawResponse();
      }
      throw new Exception('"' . $code . '" Status: ' . $message);
    }
    return $response;
  }
  protected function _makeHttpRequest($url, $method = 'GET', $headers = array(), $content = '', $timeout = FALSE) {

    // Set a response timeout
    if ($timeout) {
      $default_socket_timeout = ini_set('default_socket_timeout', $timeout);
    }
    $result = drupal_http_request($url, $headers, $method, $content);

    // Restore the response timeout
    if ($timeout) {
      ini_set('default_socket_timeout', $default_socket_timeout);
    }

    // This will no longer be needed after http://drupal.org/node/345591 is committed
    $responses = array(
      0 => 'Request failed',
      100 => 'Continue',
      101 => 'Switching Protocols',
      200 => 'OK',
      201 => 'Created',
      202 => 'Accepted',
      203 => 'Non-Authoritative Information',
      204 => 'No Content',
      205 => 'Reset Content',
      206 => 'Partial Content',
      300 => 'Multiple Choices',
      301 => 'Moved Permanently',
      302 => 'Found',
      303 => 'See Other',
      304 => 'Not Modified',
      305 => 'Use Proxy',
      307 => 'Temporary Redirect',
      400 => 'Bad Request',
      401 => 'Unauthorized',
      402 => 'Payment Required',
      403 => 'Forbidden',
      404 => 'Not Found',
      405 => 'Method Not Allowed',
      406 => 'Not Acceptable',
      407 => 'Proxy Authentication Required',
      408 => 'Request Time-out',
      409 => 'Conflict',
      410 => 'Gone',
      411 => 'Length Required',
      412 => 'Precondition Failed',
      413 => 'Request Entity Too Large',
      414 => 'Request-URI Too Large',
      415 => 'Unsupported Media Type',
      416 => 'Requested range not satisfiable',
      417 => 'Expectation Failed',
      500 => 'Internal Server Error',
      501 => 'Not Implemented',
      502 => 'Bad Gateway',
      503 => 'Service Unavailable',
      504 => 'Gateway Time-out',
      505 => 'HTTP Version not supported',
    );
    if (!isset($result->code) || $result->code < 0) {
      $result->code = 0;
    }
    if (isset($result->error)) {
      $responses[0] .= ': ' . check_plain($result->error);
    }
    if (!isset($result->data)) {
      $result->data = '';
    }
    if (!isset($responses[$result->code])) {
      $result->code = floor($result->code / 100) * 100;
    }
    $protocol = "HTTP/1.1";
    $headers[] = "{$protocol} {$result->code} {$responses[$result->code]}";
    if (isset($result->headers)) {
      foreach ($result->headers as $name => $value) {
        $headers[] = "{$name}: {$value}";
      }
    }
    return array(
      $result->data,
      $headers,
    );
  }

}

Members

Name	Modifiers	Type	Description
Apache_Solr_Service::$_collapseSingleValueArrays	protected	property	Whether {@link Apache_Solr_Response} objects should have multivalue fields with only a single value collapsed to appear as a single value would.
Apache_Solr_Service::$_createDocuments	protected	property	Whether {@link Apache_Solr_Response} objects should create {@link Apache_Solr_Document}s in the returned parsed data
Apache_Solr_Service::$_host	protected	property	Server identification strings
Apache_Solr_Service::$_namedListTreatment	protected	property	How NamedLists should be formatted in the output. This specifically effects facet counts. Valid values are {@link Apache_Solr_Service::NAMED_LIST_MAP} (default) or {@link Apache_Solr_Service::NAMED_LIST_FLAT}.
Apache_Solr_Service::$_postContext	protected	property	Stream context for posting
Apache_Solr_Service::$_queryDelimiter	protected	property	Query delimiters. Someone might want to be able to change these (to use & instead of & for example), so I've provided them.
Apache_Solr_Service::$_updateUrl	protected	property	Constructed servlet full path URLs
Apache_Solr_Service::$_urlsInited	protected	property	Keep track of whether our URLs have been constructed
Apache_Solr_Service::add	public	function	Raw Add Method. Takes a raw post body and sends it to the update service. Post body should be a complete and well formed "add" xml document.
Apache_Solr_Service::addDocument	public	function	Add a Solr Document to the index
Apache_Solr_Service::addDocuments	public	function	Add an array of Solr Documents to the index all at once
Apache_Solr_Service::delete	public	function	Raw Delete Method. Takes a raw post body and sends it to the update service. Body should be a complete and well formed "delete" xml document
Apache_Solr_Service::deleteById	public	function	Create a delete document based on document ID
Apache_Solr_Service::deleteByQuery	public	function	Create a delete document based on a query and submit it
Apache_Solr_Service::escape	public static	function	Escape a value for special query characters such as ':', '(', ')', '*', '?', etc.
Apache_Solr_Service::escapePhrase	public static	function	Escape a value meant to be contained in a phrase for special query characters
Apache_Solr_Service::getCollapseSingleValueArrays	public	function	Get the current state of the collapse single value arrays flag.
Apache_Solr_Service::getCreateDocuments	public	function	Get the current state of teh create documents flag.
Apache_Solr_Service::getHost	public	function	Returns the set host
Apache_Solr_Service::getNamedListTreatment	public	function	Get the current setting for named list treatment.
Apache_Solr_Service::getPath	public	function	Get the set path.
Apache_Solr_Service::getPort	public	function	Get the set port
Apache_Solr_Service::NAMED_LIST_FLAT		constant	NamedList Treatment constants
Apache_Solr_Service::NAMED_LIST_MAP		constant
Apache_Solr_Service::optimize	public	function	Send an optimize command. Will be synchronous unless both wait parameters are set to false.
Apache_Solr_Service::phrase	public static	function	Convenience function for creating phrase syntax from a value
Apache_Solr_Service::PING_SERVLET		constant	Servlet mappings
Apache_Solr_Service::search	public	function	Simple Search interface
Apache_Solr_Service::SEARCH_SERVLET		constant
Apache_Solr_Service::setCollapseSingleValueArrays	public	function	Set the collapse single value arrays flag.
Apache_Solr_Service::setCreateDocuments	public	function	Set the create documents flag. This determines whether {@link Apache_Solr_Response} objects will parse the response and create {@link Apache_Solr_Document} instances in place.
Apache_Solr_Service::setHost	public	function	Set the host used. If empty will fallback to constants
Apache_Solr_Service::setNamedListTreatmet	public	function	Set how NamedLists should be formatted in the response data. This mainly effects the facet counts format.
Apache_Solr_Service::setPath	public	function	Set the path used. If empty will fallback to constants
Apache_Solr_Service::setPort	public	function	Set the port used. If empty will fallback to constants
Apache_Solr_Service::setQueryDelimiter	public	function	Set the string used to separate the path form the query string. Defaulted to '?'
Apache_Solr_Service::setQueryStringDelimiter	public	function	Set the string used to separate the parameters in thequery string Defaulted to '&'
Apache_Solr_Service::SOLR_VERSION		constant	Response version we support
Apache_Solr_Service::SOLR_WRITER		constant	Response writer we support
Apache_Solr_Service::threads	public	function	Call the /admin/threads servlet and retrieve information about all threads in the Solr servlet's thread group. Useful for diagnostics.
Apache_Solr_Service::THREADS_SERVLET		constant
Apache_Solr_Service::UPDATE_SERVLET		constant
Apache_Solr_Service::_constructUrl	protected	function	Return a valid http URL given this server's host, port and path and a provided servlet name
Apache_Solr_Service::_documentToXmlFragment	protected	function	Create an XML fragment from a {@link Apache_Solr_Document} instance appropriate for use inside a Solr add call
Drupal_Apache_Solr_Service::$luke	protected	property
Drupal_Apache_Solr_Service::$luke_cid	protected	property
Drupal_Apache_Solr_Service::$stats	protected	property
Drupal_Apache_Solr_Service::clearCache	public	function	Clear cached Solr data.
Drupal_Apache_Solr_Service::commit	public	function	Clear the cache whenever we commit changes. Overrides Apache_Solr_Service::commit
Drupal_Apache_Solr_Service::getFields	public	function	Get just the field meta-data about the index.
Drupal_Apache_Solr_Service::getLuke	public	function	Get meta-data about the index.
Drupal_Apache_Solr_Service::getStats	public	function	Get information about the Solr Core.
Drupal_Apache_Solr_Service::getStatsSummary	public	function	Get summary information about the Solr Core.
Drupal_Apache_Solr_Service::LUKE_SERVLET		constant
Drupal_Apache_Solr_Service::makeServletRequest	public	function	Make a request to a servlet (a path) that's not a standard path.
Drupal_Apache_Solr_Service::ping	public	function	Call the /admin/ping servlet, to test the connection to the server. Overrides Apache_Solr_Service::ping
Drupal_Apache_Solr_Service::setLuke	protected	function	Sets $this->luke with the meta-data about the index from admin/luke.
Drupal_Apache_Solr_Service::setStats	protected	function	Sets $this->stats with the information about the Solr Core form /admin/stats.jsp
Drupal_Apache_Solr_Service::STATS_SERVLET		constant
Drupal_Apache_Solr_Service::_clearCache	protected	function
Drupal_Apache_Solr_Service::_initUrls	protected	function	Construct the Full URLs for the three servlets we reference Overrides Apache_Solr_Service::_initUrls
Drupal_Apache_Solr_Service::_makeHttpRequest	protected	function
Drupal_Apache_Solr_Service::_sendRawGet	protected	function	Central method for making a get operation against this Solr Server Overrides Apache_Solr_Service::_sendRawGet
Drupal_Apache_Solr_Service::_sendRawPost	protected	function	Central method for making a post operation against this Solr Server Overrides Apache_Solr_Service::_sendRawPost
Drupal_Apache_Solr_Service::__construct	public	function	Put Luke meta-data from the cache into $this->luke when we instantiate. Overrides Apache_Solr_Service::__construct

You are here

class Drupal_Apache_Solr_Service in Apache Solr Search 5.2

Hierarchy

File

Members

API Navigation