fernando/luos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

BUG 0000 herbert> SOLR implementation in PMOS2

Browse Source 
Solr support in PMOS2 includes:
Functionality:
- Implementation of Home views (Inbox, Draft, Participated, Unassigned). The views return fast results.
- Include read, unread, all,  and process filter in inbox View.
- Include process filter in draft view.
- Include started by me, completed by me, all, process, and status filter in participated view.
- Include process filter in unassigned view.
- Improved search functionality (search in user defined variables): Use the following syntax to search in process (user defined) variables. {variable_name}:{search_word} ex1:"causal:20*" where causal is the variable defined by the user.
  + Use of wildcards in search: Use * as wildcard at the begin or end of word
  + Multiple conditions in search: Separate multiple conditions by space ex2:"Materiales causal:20*" means that we are searching for the word Materiales and the causal that begin with 20.
  + Search in dates (interval ): Format=> {variable_date}:[yyyy-mm-dd TO yyyy-mm-dd]
    Local date not UTC date required
    ex: FechaRegistro:[2011-04-15 TO 2011-04-30] //registros con fecha entre el 2011-04-15 y el 2011-04-30.
  + we can use the wildcard *:
    ex: FechaRegistro:[* TO 2011-04-30] //registros con fecha menor o igual a 2011-04-30.
    FechaRegistro:[2011-04-15 TO *] //registros con fecha mayor o igual a 2011-04-15.
  + Search of exact phrases. format: {variable}:"frase a buscar"
    ex: Cliente:"Jesus Marin"

- Application update function.
	+ The function is called every time a change is detected in the application's data including the related delegations.
- Use of cache to improve performance

Not included:
- Order of task, sent by, and due date columns.

Pending:
- Advanced search view using faceted lists.
This commit is contained in:
Erik Amaru Ortiz
2012-05-15 10:56:48 -04:00
parent 444b745536
commit 1a8545df8a
29 changed files with 5198 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

432
workflow/engine/classes/class.solr.php Normal file
View File

@@ -0,0 +1,432 @@
<?php
class BpmnEngine_SearchIndexAccess_Solr {
const SOLR_VERSION = '&version=2.2';
private $solrIsEnabled = false;
private $solrHost = "";
function __construct($solrIsEnabled = false, $solrHost = "") {
// use the parameters to initialize class
$this->solrIsEnabled = $solrIsEnabled;
$this->solrHost = $solrHost;
}
/**
* Verify if the Solr service is available
* @gearman = false
* @rest = false
* @background = false
*
* @return bool
*/
function isEnabled() {
// verify solr server response
return $this->solrIsEnabled;
}
/**
* Returns the total number of indexed documents
* @gearman = false
* @rest = false
* @background = false
*
* @param
* workspace: workspace name
* @return total
*/
function getNumberDocuments($workspace) {
if (! $this->solrIsEnabled)
return;
// get configuration information in base to workspace parameter
// get total number of documents in registry
$solrIntruct = $this->solrHost;
$solrIntruct .= $workspace;
$solrIntruct .= "/select/?q=*:*";
$solrIntruct .= self::SOLR_VERSION;
$solrIntruct .= "&start=0&rows=0&echoParams=none&wt=json";
$handlerTotal = curl_init ( $solrIntruct );
curl_setopt ( $handlerTotal, CURLOPT_RETURNTRANSFER, true );
$responseTotal = curl_exec ( $handlerTotal );
curl_close ( $handlerTotal );
// verify the result of solr
$responseSolrTotal = json_decode ( $responseTotal, true );
if ($responseSolrTotal['responseHeader']['status'] != 0) {
throw new Exception ( "Error returning the total number of documents in Solr." );
}
$numTotalDocs = $responseSolrTotal ['response'] ['numFound'];
return $numTotalDocs;
}
/**
* Execute a query in base to Request data
* @gearman = false
* @rest = false
* @background = false
*
* @return solr response
*/
function executeQuery($solrRequestData) {
if (! $this->solrIsEnabled)
return;
$solrIntruct = '';
// get configuration information in base to workspace parameter
$workspace = $solrRequestData->workspace;
// format request
$query = empty ( $solrRequestData->searchText ) ? '*:*' : $solrRequestData->searchText;
$query = rawurlencode ( $query );
$start = '&start=' . $solrRequestData->startAfter;
$rows = '&rows=' . $solrRequestData->pageSize;
$fieldList = '';
$cols = $solrRequestData->includeCols;
if (! empty ( $cols )) {
$fieldList = "&fl=" . implode ( ",", $cols );
}
$sort = '';
if ($solrRequestData->numSortingCols > 0) {
$sort = '&sort=';
for($i = 0; $i < $solrRequestData->numSortingCols; $i ++) {
$sort .= $solrRequestData->sortCols [$i] . "%20" . $solrRequestData->sortDir [$i] . ",";
}
$sort = substr_replace ( $sort, "", - 1 );
}
$resultFormat = empty ( $solrRequestData->resultFormat ) ? '' : '&wt=' . $solrRequestData->resultFormat;
$filters = '';
$aFilters = explode ( ',', $solrRequestData->filterText );
foreach ( $aFilters as $value ) {
$filters .= '&fq=' . urlencode ( $value );
}
$solrIntruct = $this->solrHost;
$solrIntruct .= $workspace;
$solrIntruct .= "/select/?q=$query";
$solrIntruct .= "&echoParams=none";
$solrIntruct .= self::SOLR_VERSION;
$solrIntruct .= $start;
$solrIntruct .= $rows;
$solrIntruct .= $fieldList;
$solrIntruct .= $sort;
$solrIntruct .= $filters;
$solrIntruct .= $resultFormat;
// send query
// search the cases in base to datatable parameters
$handler = curl_init ( $solrIntruct );
curl_setopt ( $handler, CURLOPT_RETURNTRANSFER, true );
$response = curl_exec ( $handler );
curl_close ( $handler );
// decode
$responseSolr = json_decode ( $response, true );
if ($responseSolr['responseHeader']['status'] != 0) {
throw new Exception ( "Error executing query to Solr." );
}
return $responseSolr;
}
/**
* Insert or Update document index
* @gearman = false
* @rest = false
* @background = false
*
* @return solr response
*/
function updateDocument($solrUpdateDocument) {
if (! $this->solrIsEnabled)
return;
$solrIntruct = '';
// get configuration information in base to workspace parameter
$solrIntruct = $this->solrHost;
$solrIntruct .= $solrUpdateDocument->workspace;
$solrIntruct .= "/update";
$handler = curl_init ( $solrIntruct );
curl_setopt ( $handler, CURLOPT_RETURNTRANSFER, true );
curl_setopt ( $handler, CURLOPT_HTTPHEADER, array (
'Content-type:application/xml'
) ); // -H
curl_setopt ( $handler, CURLOPT_BINARYTRANSFER, TRUE ); // --data-binary
curl_setopt ( $handler, CURLOPT_POSTFIELDS, $solrUpdateDocument->document ); // data
$response = curl_exec ( $handler );
curl_close ( $handler );
$swOk = strpos ( $response, '<int name="status">0</int>' );
if (! $swOk) {
throw new Exception ( "Error updating document in Solr." );
}
}
/**
* Commit the changes since the last commit
* @gearman = false
* @rest = false
* @background = false
*
* @return solr response
*/
function commitChanges($workspace) {
if (! $this->solrIsEnabled)
return;
$solrIntruct = '';
// get configuration information in base to workspace parameter
$solrIntruct = $this->solrHost;
$solrIntruct .= $workspace;
$solrIntruct .= "/update";
$handler = curl_init ( $solrIntruct );
curl_setopt ( $handler, CURLOPT_RETURNTRANSFER, true );
curl_setopt ( $handler, CURLOPT_HTTPHEADER, array (
'Content-type:application/xml'
) ); // -H
curl_setopt ( $handler, CURLOPT_BINARYTRANSFER, TRUE ); // --data-binary
curl_setopt ( $handler, CURLOPT_POSTFIELDS, "<commit/>" ); // data
$response = curl_exec ( $handler );
curl_close ( $handler );
$swOk = strpos ( $response, '<int name="status">0</int>' );
if (! $swOk) {
throw new Exception ( "Error commiting changes in Solr." );
}
}
/**
* Commit the changes since the last commit
* @gearman = false
* @rest = false
* @background = false
*
* @return solr response
*/
function rollbackChanges($workspace) {
if (! $this->solrIsEnabled)
return;
$solrIntruct = '';
// get configuration information in base to workspace parameter
$solrIntruct = $this->solrHost;
$solrIntruct .= $workspace;
$solrIntruct .= "/update";
$handler = curl_init ( $solrIntruct );
curl_setopt ( $handler, CURLOPT_RETURNTRANSFER, true );
curl_setopt ( $handler, CURLOPT_HTTPHEADER, array (
'Content-type:application/xml'
) ); // -H
curl_setopt ( $handler, CURLOPT_BINARYTRANSFER, TRUE ); // --data-binary
curl_setopt ( $handler, CURLOPT_POSTFIELDS, "<rollback/>" ); // data
$response = curl_exec ( $handler );
curl_close ( $handler );
$swOk = strpos ( $response, '<int name="status">0</int>' );
if (! $swOk) {
throw new Exception ( "Error rolling back changes in Solr." );
}
}
/**
* Insert or Update document index
* @gearman = false
* @rest = false
* @background = false
*
* @return solr response
*/
function optimizeChanges($workspace) {
if (! $this->solrIsEnabled)
return;
$solrIntruct = '';
// get configuration information in base to workspace parameter
$solrIntruct = $this->solrHost;
$solrIntruct .= $workspace;
$solrIntruct .= "/update";
$handler = curl_init ( $solrIntruct );
curl_setopt ( $handler, CURLOPT_RETURNTRANSFER, true );
curl_setopt ( $handler, CURLOPT_HTTPHEADER, array (
'Content-type:application/xml'
) ); // -H
curl_setopt ( $handler, CURLOPT_BINARYTRANSFER, TRUE ); // --data-binary
curl_setopt ( $handler, CURLOPT_POSTFIELDS, "<optimize/>" ); // data
$response = curl_exec ( $handler );
curl_close ( $handler );
$swOk = strpos ( $response, '<int name="status">0</int>' );
if (! $swOk) {
throw new Exception ( "Error optimizing changes in Solr." );
}
}
function getListIndexedStoredFields($workspace) {
if (! $this->solrIsEnabled)
return;
$solrIntruct = '';
// get configuration information in base to workspace parameter
$solrIntruct = $this->solrHost;
$solrIntruct .= $workspace;
$solrIntruct .= "/admin/luke?numTerms=0&wt=json";
$handler = curl_init ( $solrIntruct );
curl_setopt ( $handler, CURLOPT_RETURNTRANSFER, true );
$response = curl_exec ( $handler );
curl_close ( $handler );
// decode
$responseSolr = json_decode ( $response, true );
if ($responseSolr['responseHeader']['status'] != 0) {
throw new Exception ( "Error getting index fields in Solr." );
}
return $responseSolr;
}
/**
* Delete all documents from index
* @gearman = false
* @rest = false
* @background = false
*
* @return solr response
*/
function deleteAllDocuments($workspace) {
if (! $this->solrIsEnabled)
return;
// $registry = Zend_Registry::getInstance();
$solrIntruct = '';
// get configuration information in base to workspace parameter
$solrIntruct = $this->solrHost;
$solrIntruct .= $workspace;
$solrIntruct .= "/update";
$handler = curl_init ( $solrIntruct );
curl_setopt ( $handler, CURLOPT_RETURNTRANSFER, true );
curl_setopt ( $handler, CURLOPT_HTTPHEADER, array (
'Content-type:application/xml'
) ); // -H
curl_setopt ( $handler, CURLOPT_BINARYTRANSFER, TRUE ); // --data-binary
curl_setopt ( $handler, CURLOPT_POSTFIELDS, "<delete><query>*:*</query></delete>" ); // data
$response = curl_exec ( $handler );
curl_close ( $handler );
$swOk = strpos ( $response, '<int name="status">0</int>' );
if (! $swOk) {
throw new Exception ( "Error deleting all documents in Solr." );
}
}
/**
* Delete specified documents from index
* @gearman = false
* @rest = false
* @background = false
*
* @return solr response
*/
function deleteDocument($workspace, $idQuery) {
if (! $this->solrIsEnabled)
return;
// $registry = Zend_Registry::getInstance();
$solrIntruct = '';
// get configuration information in base to workspace parameter
$solrIntruct = $this->solrHost;
$solrIntruct .= $workspace;
$solrIntruct .= "/update";
$handler = curl_init ( $solrIntruct );
curl_setopt ( $handler, CURLOPT_RETURNTRANSFER, true );
curl_setopt ( $handler, CURLOPT_HTTPHEADER, array (
'Content-type:application/xml'
) ); // -H
curl_setopt ( $handler, CURLOPT_BINARYTRANSFER, TRUE ); // --data-binary
curl_setopt ( $handler, CURLOPT_POSTFIELDS, "<delete><query>" . $idQuery . "</query></delete>" ); // data
$response = curl_exec ( $handler );
curl_close ( $handler );
$swOk = strpos ( $response, '<int name="status">0</int>' );
if (! $swOk) {
throw new Exception ( "Error deleting document in Solr." );
}
}
/**
* Execute a query in base to Request data
*
* @param Entity_FacetRequest $facetRequestEntity
* @return solr response: list of facets array
*/
function getFacetsList($facetRequest) {
if (! $this->solrIsEnabled)
return;
$solrIntruct = '';
// get configuration information in base to workspace parameter
$workspace = $facetRequest->workspace;
// format request
$query = empty ( $facetRequest->searchText ) ? '*:*' : $facetRequest->searchText;
$query = rawurlencode ( $query );
$start = '&start=0';
$rows = '&rows=0';
$facets = '&facet=on&facet.mincount=1&facet.limit=20'; // enable facet and
// only return facets
// with minimun one
// instance
foreach ( $facetRequest->facetFields as $value ) {
$facets .= '&facet.field=' . $value;
}
foreach ( $facetRequest->facetQueries as $value ) {
$facets .= '&facet.query=' . $value;
}
if (! empty ( $facetRequest->facetDates )) {
foreach ( $facetRequest->facetDates as $value ) {
$facets .= '&facet.date=' . $value;
}
$facets .= '&facet.date.start=' . $facetRequest->facetDatesStart;
$facets .= '&facet.date.end=' . $facetRequest->facetDatesEnd;
$facets .= '&facet.date.gap=' . $facetRequest->facetDateGap;
}
$filters = '';
foreach ( $facetRequest->filters as $value ) {
$filters .= '&fq=' . $value;
}
// echo "<pre>";
$resultFormat = '&wt=json';
$solrIntruct = $this->solrHost;
$solrIntruct .= $workspace;
$solrIntruct .= "/select/?q=$query";
$solrIntruct .= "&echoParams=none";
$solrIntruct .= self::SOLR_VERSION;
$solrIntruct .= $start;
$solrIntruct .= $rows;
$solrIntruct .= $facets;
$solrIntruct .= $filters;
$solrIntruct .= $resultFormat;
// send query
// search the cases in base to datatable parameters
$handler = curl_init ( $solrIntruct );
curl_setopt ( $handler, CURLOPT_RETURNTRANSFER, true );
$response = curl_exec ( $handler );
curl_close ( $handler );
// decode
$responseSolr = json_decode ( $response, true );
if ($responseSolr['responseHeader']['status'] != 0) {
throw new Exception ( "Error getting faceted list from Solr." );
}
return $responseSolr;
}
}