Lucene query parser. More...

Inheritance diagram for ilLuceneQueryParser:

Collaboration diagram for ilLuceneQueryParser:

Public Member Functions
	__construct ($a_query_string)
	Constructor. More...

	parse ()
	parse query string More...

	parseAutoWildcard ()
	Append asterisk for remote search from global search form field. More...

	getQuery ()
	get query More...

Static Public Member Functions
static	validateQuery ($a_query)

Protected Member Functions
	replaceOwnerCallback ($matches)
	Replace owner callback (preg_replace_callback) More...

Static Protected Member Functions
static	checkAllowedCharacters ($query)
	Check allowed characters. More...

static	checkAsterisk ($query)
	Check asterisk. More...

static	checkAmpersands ($query)
	Check ampersands. More...

static	checkCaret ($query)
	Check carets. More...

static	checkSquiggle ($query)
	Check squiggles. More...

static	checkExclamationMark ($query)
	Check exclamation marks (replacement for NOT) More...

static	checkQuestionMark ($query)
	Check question mark (wild card single character) More...

static	checkParenthesis ($a_query)
	Check parenthesis. More...

static	checkPlusMinus ($a_query)
	Check plus minus. More...

static	checkANDORNOT ($a_query)
	Check AND OR NOT. More...

static	checkQuotes ($a_query)
	Check quotes. More...

static	checkColon ($a_query)
	Check colon. More...

Protected Attributes
	$query_string

	$parsed_query

Detailed Description

Lucene query parser.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 35 of file class.ilLuceneQueryParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilLuceneQueryParser::__construct ( $a_query_string )

Constructor.

Parameters

string query string

Returns

Definition at line 46 of file class.ilLuceneQueryParser.php.

     {
         $this->query_string = $a_query_string;
     }

Member Function Documentation

◆ checkAllowedCharacters()

static ilLuceneQueryParser::checkAllowedCharacters ( $query )

staticprotected

Check allowed characters.

Exceptions

LuceneQueryParserException

Definition at line 127 of file class.ilLuceneQueryParser.php.

References $query.

     {
         if (preg_match('/[^\pL0-9_+\-:.()\"*?&§€|!{}\[\]\^~\\@#\/$%\'= ]/u', $query) != 0) {
             throw new ilLuceneQueryParserException('lucene_err_allowed_characters');
         }
         return true;
     }

◆ checkAmpersands()

static ilLuceneQueryParser::checkAmpersands ( $query )

staticprotected

Check ampersands.

Exceptions

LuceneQueryParserException

Definition at line 151 of file class.ilLuceneQueryParser.php.

References $query.

     {
         if (preg_match('/[&]{2}/', $query) > 0) {
             if (preg_match('/^([\pL0-9_+\-:.()\"*?&|!{}\[\]\^~\\@#\/$%\'=]+( && )?[\pL0-9_+\-:.()\"*?|!{}\[\]\^~\\@#\/$%\'=]+[ ]*)+$/u', $query) == 0) {
                 throw new ilLuceneQueryParserException('lucene_err_ampersand');
             }
         }
         return true;
     }

◆ checkANDORNOT()

static ilLuceneQueryParser::checkANDORNOT ( $a_query )

staticprotected

Check AND OR NOT.

Exceptions

LuceneQueryParserException

Definition at line 267 of file class.ilLuceneQueryParser.php.

     {
         return true;
         
         if (preg_match('/^([\pL0-9_+\-:.()\"*?&|!{}\[\]\^~\\@\/#$%\'=]+\s*((AND )|(OR )|(AND NOT )|(NOT ))?[\pL0-9_+\-:.()\"*?&|!{}\[\]\^~\\@\/#$%\'=]+[ ]*)+$/u', $a_query) == 0) {
             throw new ilLuceneQueryParserException('lucene_err_and_or_not');
         }
         return true;
     }

◆ checkAsterisk()

static ilLuceneQueryParser::checkAsterisk ( $query )

staticprotected

Check asterisk.

Exceptions

LuceneQueryParserException

Definition at line 139 of file class.ilLuceneQueryParser.php.

References $query.

     {
         if (preg_match('/^[\*]*$|[\s]\*|^\*[^\s]/', $query) != 0) {
             throw new ilLuceneQueryParserException('lucene_err_asterisk');
         }
         return true;
     }

◆ checkCaret()

static ilLuceneQueryParser::checkCaret ( $query )

staticprotected

Check carets.

Exceptions

LuceneQueryParserException

Definition at line 165 of file class.ilLuceneQueryParser.php.

References $query.

Referenced by validateQuery().

     {
         if (preg_match('/[^\\\]\^([^\s]*[^0-9.]+)|[^\\\]\^$/', $query) != 0) {
             throw new ilLuceneQueryParserException('lucene_err_caret');
         }
         return true;
     }

Here is the caller graph for this function:

◆ checkColon()

static ilLuceneQueryParser::checkColon ( $a_query )

staticprotected

Check colon.

Exceptions

LuceneQueryParserException

Definition at line 306 of file class.ilLuceneQueryParser.php.

     {
         if (preg_match('/[^\\\\s]:[\s]|[^\\\\s]:$|[\s][^\\]?:|^[^\\\\s]?:/', $a_query) != 0) {
             throw new ilLuceneQueryParserException('lucene_err_colon');
         }
         return true;
     }

◆ checkExclamationMark()

static ilLuceneQueryParser::checkExclamationMark ( $query )

staticprotected

Check exclamation marks (replacement for NOT)

Exceptions

LuceneQueryParserException

Definition at line 189 of file class.ilLuceneQueryParser.php.

References $query.

     {
         if (preg_match('/^[^!]*$|^([\pL0-9_+\-:.()\"*?&|!{}\[\]\^~\\@#\/$%\'=]+( ! )?[\pL0-9_+\-:.()\"*?&|!{}\[\]\^~\\@#\/$%\'=]+[ ]*)+$/u', $query, $matches) == 0) {
             throw new ilLuceneQueryParserException('lucene_err_exclamation_mark');
         }
         return true;
     }

◆ checkParenthesis()

static ilLuceneQueryParser::checkParenthesis ( $a_query )

staticprotected

Check parenthesis.

Exceptions

LuceneQueryParserException

Definition at line 213 of file class.ilLuceneQueryParser.php.

References array.

Referenced by validateQuery().

     {
         $hasLft = false;
         $hasRgt = false;
         
         $matchLft = 0;
         $matchRgt = 0;
         
         $tmp = array();
         
         if (($matchLft = preg_match_all('/[(]/', $a_query, $tmp)) > 0) {
             $hasLft = true;
         }
         if (($matchRgt = preg_match_all('/[)]/', $a_query, $tmp)) > 0) {
             $hasRgt = true;
         }
         
         if (!$hasLft || !$hasRgt) {
             return true;
         }
         
         
         if (($hasLft && !$hasRgt) || ($hasRgt && !$hasLft)) {
             throw new ilLuceneQueryParserException('lucene_err_parenthesis_not_closed');
         }
         
         if ($matchLft !== $matchRgt) {
             throw new ilLuceneQueryParserException('lucene_err_parenthesis_not_closed');
         }
         
         if (preg_match('/\(\s*\)/', $a_query) > 0) {
             throw new ilLuceneQueryParserException('lucene_err_parenthesis_empty');
         }
         return true;
     }

Here is the caller graph for this function:

◆ checkPlusMinus()

static ilLuceneQueryParser::checkPlusMinus ( $a_query )

staticprotected

Check plus minus.

Exceptions

LuceneQueryParserException

Definition at line 254 of file class.ilLuceneQueryParser.php.

     {
         if (preg_match('/^[^\n+\-]*$|^([+-]?\s*[\pL0-9_:.()\"*?&|!{}\[\]\^~\\@#\/$%\'=]+[ ]?)+$/u', $a_query) == 0) {
             throw new ilLuceneQueryParserException('lucene_err_plus_minus');
         }
         return true;
     }

◆ checkQuestionMark()

static ilLuceneQueryParser::checkQuestionMark ( $query )

staticprotected

Check question mark (wild card single character)

Exceptions

LuceneQueryParserException

Definition at line 201 of file class.ilLuceneQueryParser.php.

References $query.

     {
         if (preg_match('/^(\?)|([^\pL0-9_+\-:.()\"*?&|!{}\[\]\^~\\@#\/$%\'=]\?+)/u', $query, $matches) != 0) {
             throw new ilLuceneQueryParserException('lucene_err_question_mark');
         }
         return true;
     }

◆ checkQuotes()

static ilLuceneQueryParser::checkQuotes ( $a_query )

staticprotected

Check quotes.

Exceptions

LuceneQueryParserException

Definition at line 282 of file class.ilLuceneQueryParser.php.

Referenced by validateQuery().

     {
         $matches = preg_match_all('/"/', $a_query, $tmp);
         
         if ($matches == 0) {
             return true;
         }
         
         if (($matches % 2) > 0) {
             throw new ilLuceneQueryParserException('lucene_err_quotes');
         }
 
         if (preg_match('/"\s*"/', $a_query) > 0) {
             throw new ilLuceneQueryParserException('lucene_err_quotes_not_empty');
         }
         return true;
     }

Here is the caller graph for this function:

◆ checkSquiggle()

static ilLuceneQueryParser::checkSquiggle ( $query )

staticprotected

Check squiggles.

Exceptions

LuceneQueryParserException

Definition at line 177 of file class.ilLuceneQueryParser.php.

References $query.

Referenced by validateQuery().

     {
         if (preg_match('/[^\\\]*~[^\s]*[^0-9\s]+/', $query, $matches) != 0) {
             throw new ilLuceneQueryParserException('lucene_err_squiggle');
         }
         return true;
     }

Here is the caller graph for this function:

◆ getQuery()

ilLuceneQueryParser::getQuery ( )

get query

Returns

Definition at line 80 of file class.ilLuceneQueryParser.php.

References $parsed_query.

     {
         return $this->parsed_query;
     }

◆ parse()

ilLuceneQueryParser::parse ( )

parse query string

Returns

Definition at line 55 of file class.ilLuceneQueryParser.php.

References array.

Referenced by ilLuceneUserSearchGUI\performSearch(), and ilLuceneSearchGUI\showSavedResults().

     {
         $this->parsed_query = preg_replace_callback('/(owner:)\s?([A-Za-z0-9_\.\+\*\@!\$\%\~\-]+)/', array($this,'replaceOwnerCallback'), $this->query_string);
     }

Here is the caller graph for this function:

◆ parseAutoWildcard()

ilLuceneQueryParser::parseAutoWildcard ( )

Append asterisk for remote search from global search form field.

Returns: boolean

Definition at line 64 of file class.ilLuceneQueryParser.php.

     {
         $this->parsed_query = trim($this->query_string);
         if (stristr($this->parsed_query, '*')) {
             return true;
         }
         if (substr($this->parsed_query, -1) !== '"') {
             $this->parsed_query .= '*';
         }
         return true;
     }

◆ replaceOwnerCallback()

ilLuceneQueryParser::replaceOwnerCallback ( $matches )

protected

Replace owner callback (preg_replace_callback)

Definition at line 88 of file class.ilLuceneQueryParser.php.

References ilObjUser\_loginExists().

     {
         if (isset($matches[2])) {
             if ($usr_id = ilObjUser::_loginExists($matches[2])) {
                 return $matches[1] . $usr_id;
             }
         }
         return $matches[0];
     }

Here is the call graph for this function:

◆ validateQuery()

static ilLuceneQueryParser::validateQuery ( $a_query )

static

Exceptions

LuceneQueryParserException

Definition at line 102 of file class.ilLuceneQueryParser.php.

References checkCaret(), checkParenthesis(), checkQuotes(), and checkSquiggle().

Referenced by ilMailQuickFilterInputGUI\checkInput(), and ilLuceneQueryInputGUI\checkInput().

     {
         // TODO
         // First replace all quote characters
 
         
         #ilLuceneQueryParser::checkAllowedCharacters($a_query);
         #ilLuceneQueryParser::checkAsterisk($a_query);
         #ilLuceneQueryParser::checkAmpersands($a_query);
         ilLuceneQueryParser::checkCaret($a_query);
         ilLuceneQueryParser::checkSquiggle($a_query);
         #ilLuceneQueryParser::checkExclamationMark($a_query);
         #ilLuceneQueryParser::checkQuestionMark($a_query);
         ilLuceneQueryParser::checkParenthesis($a_query);
         #ilLuceneQueryParser::checkPlusMinus($a_query);
         #ilLuceneQueryParser::checkANDORNOT($a_query);
         ilLuceneQueryParser::checkQuotes($a_query);
         #ilLuceneQueryParser::checkColon($a_query);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $parsed_query

ilLuceneQueryParser::$parsed_query

protected

Definition at line 38 of file class.ilLuceneQueryParser.php.

Referenced by getQuery().

◆ $query_string

ilLuceneQueryParser::$query_string

protected

Definition at line 37 of file class.ilLuceneQueryParser.php.

Referenced by ilMailLuceneQueryParser\parse().

The documentation for this class was generated from the following file:

Services/Search/classes/Lucene/class.ilLuceneQueryParser.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkAllowedCharacters()

◆ checkAmpersands()

◆ checkANDORNOT()

◆ checkAsterisk()

◆ checkCaret()

◆ checkColon()

◆ checkExclamationMark()

◆ checkParenthesis()

◆ checkPlusMinus()

◆ checkQuestionMark()

◆ checkQuotes()

◆ checkSquiggle()

◆ getQuery()

◆ parse()

◆ parseAutoWildcard()

◆ replaceOwnerCallback()

◆ validateQuery()

Field Documentation

◆ $parsed_query

◆ $query_string