/core/packages/simplesearch-1.9-pl/modCategory/1959218a0a36e4671ecc829ac12facfc/0/simplesearch/model/simplesearch/driver/simplesearchdriversolr.class.php

<?php
/**
 * SimpleSearch
 *
 * Copyright 2010-11 by Shaun McCormick <shaun+sisea@modx.com>
 *
 * This file is part of SimpleSearch, a simple search component for MODx
 * Revolution. It is loosely based off of AjaxSearch for MODx Evolution by
 * coroico/kylej, minus the ajax.
 *
 * SimpleSearch is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 *
 * SimpleSearch is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * SimpleSearch; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
 * Suite 330, Boston, MA 02111-1307 USA
 *
 * @package simplesearch
 */
require_once dirname(__FILE__) . '/simplesearchdriver.class.php';
/**
 * Solr search driver for SimpleSearch. This requires a few things to run:
 *
 * - The PECL Solr package, found here: http://pecl.php.net/package/solr
 * - A working schema.xml file and running Solr instance.
 *
 * A sample schema.xml file is provided for you in the core/components/simplesearch/docs/
 * directory. Rename the file from solr.schema.xml to schema.xml and put in
 * the appropriate conf/ directory in your preferred Solr core. You may
 * customize the schema as you feel the need.
 *
 * @package simplesearch
 */
class SimpleSearchDriverSolr extends SimpleSearchDriver {
    /** @var array An array of connection properties for our SolrClient */
    private $_connectionOptions = array();
    /** @var A reference to the SolrClient object */
    public $client;

    /**
     * Initialize the Solr client, and setup settings for the client.
     * 
     * @return void
     */
    public function initialize() {
        $this->_connectionOptions = array(
            'hostname' => $this->modx->getOption('sisea.solr.hostname',null,'127.0.0.1'),
            'port' => $this->modx->getOption('sisea.solr.port',null,'8983'),
            'path' => $this->modx->getOption('sisea.solr.path',null,''),
            'login' => $this->modx->getOption('sisea.solr.username',null,''),
            'password' => $this->modx->getOption('sisea.solr.password',null,''),
            'timeout' => $this->modx->getOption('sisea.solr.timeout',null,30),
            'secure' => $this->modx->getOption('sisea.solr.ssl',null,false),
            'ssl_cert' => $this->modx->getOption('sisea.solr.ssl_cert',null,''),
            'ssl_key' => $this->modx->getOption('sisea.solr.ssl_key',null,''),
            'ssl_keypassword' => $this->modx->getOption('sisea.solr.ssl_keypassword',null,''),
            'ssl_cainfo' => $this->modx->getOption('sisea.solr.ssl_cainfo',null,''),
            'ssl_capath' => $this->modx->getOption('sisea.solr.ssl_capath',null,''),
            'proxy_host' => $this->modx->getOption('sisea.solr.proxy_host',null,''),
            'proxy_port' => $this->modx->getOption('sisea.solr.proxy_port',null,''),
            'proxy_login' => $this->modx->getOption('sisea.solr.proxy_username',null,''),
            'proxy_password' => $this->modx->getOption('sisea.solr.proxy_password',null,''),
        );

        try {
            $this->client = new SolrClient($this->_connectionOptions);
        } catch (Exception $e) {
            $this->modx->log(xPDO::LOG_LEVEL_ERROR,'Error connecting to Solr server: '.$e->getMessage());
        }
    }

    /**
     * Run the search against a sanitized query string via Solr.
     *
     * @param string $string
     * @param array $scriptProperties The scriptProperties array from the SimpleSearch snippet
     * @return array
     */
    public function search($string,array $scriptProperties = array()) {
        /** @var SolrQuery $query */
        $query = new SolrQuery();
        $query->setQuery($string);

    	/* set limit */
        $perPage = $this->modx->getOption('perPage',$scriptProperties,10);
    	if (!empty($perPage)) {
            $offset = $this->modx->getOption('start',$scriptProperties,0);
            $offsetIndex = $this->modx->getOption('offsetIndex',$scriptProperties,'sisea_offset');
            if (isset($_REQUEST[$offsetIndex])) $offset = (int)$_REQUEST[$offsetIndex];
            $query->setStart($offset);
            $query->setRows($perPage);
    	}

        /* add fields to search */
    	$fields = $this->modx->getFields('modResource');
        foreach ($fields as $fieldName => $default) {
            $query->addField($fieldName);
        }

        $includeTVs = $this->modx->getOption('includeTVs',$scriptProperties,false);
        if ($includeTVs) {
            $sql = $this->modx->newQuery('modTemplateVar');
            $sql->select($this->modx->getSelectColumns('modTemplateVar','','',array('id','name')));
            $sql->sortby($this->modx->escape('name'),'ASC');
            $sql->prepare();
            $sql = $sql->toSql();
            $tvs = $this->modx->query($sql);
            if ($tvs && $tvs instanceof PDOStatement) {
                while ($tv = $tvs->fetch(PDO::FETCH_ASSOC)) {
                    $query->addField($tv['name']);
                }
            }
        }

        /* handle hidemenu option */
        $hideMenu = $this->modx->getOption('hideMenu',$scriptProperties,2);
        if ($hideMenu != 2) {
            $query->addFilterQuery('hidemenu:'.($hideMenu ? 1 : 0));
        }

        /* handle contexts */
        $contexts = $this->modx->getOption('contexts',$scriptProperties,'');
        $contexts = !empty($contexts) ? $contexts : $this->modx->context->get('key');
        $contexts = implode(' ',explode(',',$contexts));
    	$query->addFilterQuery('context_key:('.$contexts.')');

        /* handle restrict search to these IDs */
        $ids = $this->modx->getOption('ids',$scriptProperties,'');
    	if (!empty($ids)) {
            $idType = $this->modx->getOption('idType',$this->config,'parents');
            $depth = $this->modx->getOption('depth',$this->config,10);
            $ids = $this->processIds($ids,$idType,$depth);
            $query->addFilterQuery('id:('.implode(' ',$ids).')');
        }

        /* handle exclude IDs from search */
        $exclude = $this->modx->getOption('exclude',$scriptProperties,'');
        if (!empty($exclude)) {
            $exclude = $this->cleanIds($exclude);
            $exclude = implode(' ',explode(',', $exclude));
            $query->addFilterQuery('-id:('.$exclude.')');
        }

        /* basic always-on conditions */
        $query->addFilterQuery('published:1');
        $query->addFilterQuery('searchable:1');
        $query->addFilterQuery('deleted:0');

        /* sorting */
        if (!empty($scriptProperties['sortBy'])) {
            $sortDir = $this->modx->getOption('sortDir',$scriptProperties,'desc');
            $sortDirs = explode(',',$sortDir);
            $sortBys = explode(',',$scriptProperties['sortBy']);
            $dir = 'desc';
            for ($i=0;$i<count($sortBys);$i++) {
                if (isset($sortDirs[$i])) {
                    $dir= $sortDirs[$i];
                }
                $dir = strtolower($dir) == 'asc' ? SolrQuery::ORDER_ASC : SolrQuery::ORDER_DESC;
                $query->addSortField($sortBys[$i],$dir);
            }
        }

        /* prepare response array */
        $response = array(
            'total' => 0,
            'start' => !empty($offset) ? $offset : 0,
            'limit' => $perPage,
            'status' => 0,
            'query_time' => 0,
            'results' => array(),
        );
        
        /* query Solr */
        try {
            $queryResponse = $this->client->query($query);
            $responseObject = $queryResponse->getResponse();
            if ($responseObject) {
                $response['total'] = $responseObject->response->numFound;
                $response['query_time'] = $responseObject->responseHeader->QTime;
                $response['status'] = $responseObject->responseHeader->status;
                $response['results'] = array();
                if (!empty($responseObject->response->docs)) {
                    foreach ($responseObject->response->docs as $doc) {
                        $d = array();
                        foreach ($doc as $k => $v) {
                            $d[$k] = $v;
                        }
                        /** @var modResource $resource */
                        $resource = $this->modx->newObject($d['class_key']);
                        if ($resource->checkPolicy('list')) {
                            $response['results'][] = $d;
                        }
                    }
                }
            }
        } catch (Exception $e) {
            $this->modx->log(xPDO::LOG_LEVEL_ERROR,'Error running query on Solr server: '.$e->getMessage());
        }
        return $response;
    }

    /**
     * Index a Resource.
     *
     * @param array $fields
     * @return boolean
     */
    public function index(array $fields = array()) {
        if (isset($fields['searchable']) && empty($fields['searchable'])) return false;
        if (isset($fields['published']) && empty($fields['published'])) return false;
        if (isset($fields['deleted']) && !empty($fields['deleted'])) return false;

        $document = new SolrInputDocument();
        $dateFields = array('createdon','editedon','deletedon','publishedon');
        foreach ($fields as $fieldName => $value) {
            if (is_string($fieldName) && !is_array($value) && !is_object($value)) {
                if (in_array($fieldName,$dateFields)) {
                    $value = ''.strftime('%Y-%m-%dT%H:%M:%SZ',strtotime($value));
                    $fields[$fieldName] = $value;
                }
                $document->addField($fieldName,$value);
            }
        }
        $this->modx->log(modX::LOG_LEVEL_DEBUG,'[SimpleSearch] Indexing Resource: '.print_r($fields,true));
        $response = false;
        try {
            $response = $this->client->addDocument($document);
        } catch (Exception $e) {
            $this->modx->log(xPDO::LOG_LEVEL_ERROR,'Error adding Document to index on Solr server: '.$e->getMessage());
        }
        $this->commit();
        return $response;
    }

    /**
     * Remove a Resource from the Solr index.
     *
     * @param string|int $id
     * @return boolean
     */
    public function removeIndex($id) {
        $this->modx->log(modX::LOG_LEVEL_DEBUG,'[SimpleSearch] Removing Resource From Index: '.$id);
        $this->client->deleteById($id);
        $this->commit();
    }

    /**
     * Commit the operation to the Solr core.
     * 
     * @return void
     */
    public function commit() {
        try {
            $this->client->commit();
        } catch (Exception $e) {
            $this->modx->log(xPDO::LOG_LEVEL_ERROR,'Error committing query on Solr server: '.$e->getMessage());
        }
    }
}