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 ()

Static Public Member Functions
static	validateQuery ($a_query)

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
string	$query_string

string	$parsed_query = ''

Detailed Description

Lucene query parser.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilLuceneQueryParser::__construct ( $a_query_string )

Constructor.

Parameters

string query string

Reimplemented in ilLuceneAdvancedQueryParser.

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

    {
        $this->query_string = $a_query_string;
    }

Member Function Documentation

◆ checkAllowedCharacters()

static ilLuceneQueryParser::checkAllowedCharacters ( string $query )

staticprotected

Check allowed characters.

Exceptions

ilLuceneQueryParserException

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

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

References $query.

◆ checkAmpersands()

static ilLuceneQueryParser::checkAmpersands ( string $query )

staticprotected

Check ampersands.

Exceptions

ilLuceneQueryParserException

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

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

References $query.

◆ checkANDORNOT()

static ilLuceneQueryParser::checkANDORNOT ( string $a_query )

staticprotected

Check AND OR NOT.

Exceptions

ilLuceneQueryParserException

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

                                                            : bool
    {
        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 ( string $query )

staticprotected

Check asterisk.

Exceptions

ilLuceneQueryParserException

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

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

References $query.

◆ checkCaret()

static ilLuceneQueryParser::checkCaret ( string $query )

staticprotected

Check carets.

Exceptions

ilLuceneQueryParserException

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

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

References $query.

Referenced by validateQuery().

Here is the caller graph for this function:

◆ checkColon()

static ilLuceneQueryParser::checkColon ( string $a_query )

staticprotected

Check colon.

Exceptions

ilLuceneQueryParserException

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

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

◆ checkExclamationMark()

static ilLuceneQueryParser::checkExclamationMark ( string $query )

staticprotected

Check exclamation marks (replacement for NOT)

Exceptions

ilLuceneQueryParserException

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

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

References $query.

◆ checkParenthesis()

static ilLuceneQueryParser::checkParenthesis ( string $a_query )

staticprotected

Check parenthesis.

Exceptions

ilLuceneQueryParserException

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

                                                               : bool
    {
        $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;
    }

Referenced by validateQuery().

Here is the caller graph for this function:

◆ checkPlusMinus()

static ilLuceneQueryParser::checkPlusMinus ( string $a_query )

staticprotected

Check plus minus.

Exceptions

ilLuceneQueryParserException

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

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

◆ checkQuestionMark()

static ilLuceneQueryParser::checkQuestionMark ( string $query )

staticprotected

Check question mark (wild card single character)

Exceptions

ilLuceneQueryParserException

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

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

References $query.

◆ checkQuotes()

static ilLuceneQueryParser::checkQuotes ( string $a_query )

staticprotected

Check quotes.

Exceptions

ilLuceneQueryParserException

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

                                                          : bool
    {
        $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;
    }

Referenced by validateQuery().

Here is the caller graph for this function:

◆ checkSquiggle()

static ilLuceneQueryParser::checkSquiggle ( string $query )

staticprotected

Check squiggles.

Exceptions

ilLuceneQueryParserException

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

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

References $query.

Referenced by validateQuery().

Here is the caller graph for this function:

◆ getQuery()

ilLuceneQueryParser::getQuery ( )

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

                              : string
    {
        return $this->parsed_query;
    }

References $parsed_query.

◆ parse()

ilLuceneQueryParser::parse ( )

parse query string

Returns: void

Reimplemented in ilMailLuceneQueryParser, and ilLuceneAdvancedQueryParser.

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

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

References $query_string.

◆ parseAutoWildcard()

ilLuceneQueryParser::parseAutoWildcard ( )

Append asterisk for remote search from global search form field.

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

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

◆ replaceOwnerCallback()

ilLuceneQueryParser::replaceOwnerCallback ( array $matches )

protected

Replace owner callback (preg_replace_callback)

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

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

References ilObjUser\_loginExists().

Here is the call graph for this function:

◆ validateQuery()

static ilLuceneQueryParser::validateQuery ( $a_query )

static

Exceptions

ilLuceneQueryParserException

Todo:: add multi byte query validation.

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

                                                  : bool
    {
        #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;
    }

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

Referenced by ilMailQuickFilterInputGUI\checkInput(), ilLuceneQueryInputGUI\checkInput(), ilSearchLuceneQueryParserTest\testFailedParenthesis(), and ilSearchLuceneQueryParserTest\testValidation().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $parsed_query

string ilLuceneQueryParser::$parsed_query = ''

protected

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

Referenced by getQuery().

◆ $query_string

string ilLuceneQueryParser::$query_string

protected

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

Referenced by ilMailLuceneQueryParser\parse(), and 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