You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
516 lines
18 KiB
516 lines
18 KiB
<?php
|
|
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle 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 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle 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 Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* @package core
|
|
* @subpackage search
|
|
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/** @see lexer.php */
|
|
require_once($CFG->libdir.'/lexer.php');
|
|
|
|
/** Constants for the various types of tokens */
|
|
|
|
define("TOKEN_USER","0");
|
|
define("TOKEN_META","1");
|
|
define("TOKEN_EXACT","2");
|
|
define("TOKEN_NEGATE","3");
|
|
define("TOKEN_STRING","4");
|
|
define("TOKEN_USERID","5");
|
|
define("TOKEN_DATEFROM","6");
|
|
define("TOKEN_DATETO","7");
|
|
define("TOKEN_INSTANCE","8");
|
|
define("TOKEN_TAGS","9");
|
|
|
|
/**
|
|
* Class to hold token/value pairs after they're parsed.
|
|
*
|
|
* @package moodlecore
|
|
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class search_token {
|
|
private $value;
|
|
private $type;
|
|
|
|
public function __construct($type,$value){
|
|
$this->type = $type;
|
|
$this->value = $this->sanitize($value);
|
|
|
|
}
|
|
|
|
/**
|
|
* Old syntax of class constructor. Deprecated in PHP7.
|
|
*
|
|
* @deprecated since Moodle 3.1
|
|
*/
|
|
public function search_token($type, $value) {
|
|
debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
|
|
self::__construct($type, $value);
|
|
}
|
|
|
|
// Try to clean up user input to avoid potential security issues.
|
|
// Need to think about this some more.
|
|
|
|
function sanitize($userstring){
|
|
return htmlspecialchars($userstring);
|
|
}
|
|
function getValue(){
|
|
return $this->value;
|
|
}
|
|
function getType(){
|
|
return $this->type;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* This class does the heavy lifting of lexing the search string into tokens.
|
|
* Using a full-blown lexer is probably overkill for this application, but
|
|
* might be useful for other tasks.
|
|
*
|
|
* @package moodlecore
|
|
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class search_lexer extends Lexer{
|
|
|
|
public function __construct(&$parser){
|
|
|
|
// Call parent constructor.
|
|
parent::__construct($parser);
|
|
|
|
//Set up the state machine and pattern matches for transitions.
|
|
|
|
// Patterns to handle strings of the form datefrom:foo
|
|
|
|
// If we see the string datefrom: while in the base accept state, start
|
|
// parsing a username and go to the indatefrom state.
|
|
$this->addEntryPattern("datefrom:\S+","accept","indatefrom");
|
|
|
|
// Snarf everything into the username until we see whitespace, then exit
|
|
// back to the base accept state.
|
|
$this->addExitPattern("\s","indatefrom");
|
|
|
|
|
|
// If we see the string tags: while in the base accept state, start
|
|
// parsing tags and go to the intags state.
|
|
$this->addEntryPattern("tags:\S+","accept","intags");
|
|
|
|
// Snarf everything into the tags until we see whitespace, then exit
|
|
// back to the base accept state.
|
|
$this->addExitPattern("\s","intags");
|
|
|
|
// Patterns to handle strings of the form dateto:foo
|
|
|
|
// If we see the string dateto: while in the base accept state, start
|
|
// parsing a username and go to the indateto state.
|
|
$this->addEntryPattern("dateto:\S+","accept","indateto");
|
|
|
|
// Snarf everything into the username until we see whitespace, then exit
|
|
// back to the base accept state.
|
|
$this->addExitPattern("\s","indateto");
|
|
|
|
|
|
// Patterns to handle strings of the form instance:foo
|
|
|
|
// If we see the string instance: while in the base accept state, start
|
|
// parsing for instance number and go to the ininstance state.
|
|
$this->addEntryPattern("instance:\S+","accept","ininstance");
|
|
|
|
// Snarf everything into the username until we see whitespace, then exit
|
|
// back to the base accept state.
|
|
$this->addExitPattern("\s","ininstance");
|
|
|
|
|
|
// Patterns to handle strings of the form userid:foo
|
|
|
|
// If we see the string userid: while in the base accept state, start
|
|
// parsing a username and go to the inuserid state.
|
|
$this->addEntryPattern("userid:\S+","accept","inuserid");
|
|
|
|
// Snarf everything into the username until we see whitespace, then exit
|
|
// back to the base accept state.
|
|
$this->addExitPattern("\s","inuserid");
|
|
|
|
|
|
// Patterns to handle strings of the form user:foo
|
|
|
|
// If we see the string user: while in the base accept state, start
|
|
// parsing a username and go to the inusername state.
|
|
$this->addEntryPattern("user:\S+","accept","inusername");
|
|
|
|
// Snarf everything into the username until we see whitespace, then exit
|
|
// back to the base accept state.
|
|
$this->addExitPattern("\s","inusername");
|
|
|
|
|
|
// Patterns to handle strings of the form meta:foo
|
|
|
|
// If we see the string meta: while in the base accept state, start
|
|
// parsing a username and go to the inmeta state.
|
|
$this->addEntryPattern("subject:\S+","accept","inmeta");
|
|
|
|
// Snarf everything into the meta token until we see whitespace, then exit
|
|
// back to the base accept state.
|
|
$this->addExitPattern("\s","inmeta");
|
|
|
|
|
|
// Patterns to handle required exact match strings (+foo) .
|
|
|
|
// If we see a + sign while in the base accept state, start
|
|
// parsing an exact match string and enter the inrequired state
|
|
$this->addEntryPattern("\+\S+","accept","inrequired");
|
|
// When we see white space, exit back to accept state.
|
|
$this->addExitPattern("\s","inrequired");
|
|
|
|
// Handle excluded strings (-foo)
|
|
|
|
// If we see a - sign while in the base accept state, start
|
|
// parsing an excluded string and enter the inexcluded state
|
|
$this->addEntryPattern("\-\S+","accept","inexcluded");
|
|
// When we see white space, exit back to accept state.
|
|
$this->addExitPattern("\s","inexcluded");
|
|
|
|
|
|
// Patterns to handle quoted strings.
|
|
|
|
// If we see a quote while in the base accept state, start
|
|
// parsing a quoted string and enter the inquotedstring state.
|
|
// Grab everything until we see the closing quote.
|
|
|
|
$this->addEntryPattern("\"[^\"]+","accept","inquotedstring");
|
|
|
|
// When we see a closing quote, reenter the base accept state.
|
|
$this->addExitPattern("\"","inquotedstring");
|
|
|
|
// Patterns to handle ordinary, nonquoted words.
|
|
|
|
// When we see non-whitespace, snarf everything into the nonquoted word
|
|
// until we see whitespace again.
|
|
$this->addEntryPattern("\S+","accept","plainstring");
|
|
|
|
// Once we see whitespace, reenter the base accept state.
|
|
$this->addExitPattern("\s","plainstring");
|
|
|
|
}
|
|
|
|
/**
|
|
* Old syntax of class constructor. Deprecated in PHP7.
|
|
*
|
|
* @deprecated since Moodle 3.1
|
|
*/
|
|
public function search_lexer(&$parser) {
|
|
debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
|
|
self::__construct($parser);
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* This class takes care of sticking the proper token type/value pairs into
|
|
* the parsed token array.
|
|
* Most functions in this class should only be called by the lexer, the
|
|
* one exception being getParseArray() which returns the result.
|
|
*
|
|
* @package moodlecore
|
|
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class search_parser {
|
|
private $tokens;
|
|
|
|
// This function is called by the code that's interested in the result of the parse operation.
|
|
function get_parsed_array(){
|
|
return $this->tokens;
|
|
}
|
|
|
|
/*
|
|
* Functions below this are part of the state machine for the parse
|
|
* operation and should not be called directly.
|
|
*/
|
|
|
|
// Base state. No output emitted.
|
|
function accept() {
|
|
return true;
|
|
}
|
|
|
|
// State for handling datefrom:foo constructs. Potentially emits a token.
|
|
function indatefrom($content){
|
|
if (strlen($content) < 10) { // State exit or missing parameter.
|
|
return true;
|
|
}
|
|
// Strip off the datefrom: part and add the reminder to the parsed token array
|
|
$param = trim(substr($content,9));
|
|
$this->tokens[] = new search_token(TOKEN_DATEFROM,$param);
|
|
return true;
|
|
}
|
|
|
|
// State for handling dateto:foo constructs. Potentially emits a token.
|
|
function indateto($content){
|
|
if (strlen($content) < 8) { // State exit or missing parameter.
|
|
return true;
|
|
}
|
|
// Strip off the dateto: part and add the reminder to the parsed token array
|
|
$param = trim(substr($content,7));
|
|
$this->tokens[] = new search_token(TOKEN_DATETO,$param);
|
|
return true;
|
|
}
|
|
|
|
// State for handling tags:tagname,tagname constructs. Potentially emits a token.
|
|
function intags($content){
|
|
if (strlen($content) < 5) { // State exit or missing parameter.
|
|
return true;
|
|
}
|
|
// Strip off the tags: part and add the reminder to the parsed token array
|
|
$param = trim(substr($content,5));
|
|
$this->tokens[] = new search_token(TOKEN_TAGS,$param);
|
|
return true;
|
|
}
|
|
|
|
// State for handling instance:foo constructs. Potentially emits a token.
|
|
function ininstance($content){
|
|
if (strlen($content) < 10) { // State exit or missing parameter.
|
|
return true;
|
|
}
|
|
// Strip off the instance: part and add the reminder to the parsed token array
|
|
$param = trim(substr($content,9));
|
|
$this->tokens[] = new search_token(TOKEN_INSTANCE,$param);
|
|
return true;
|
|
}
|
|
|
|
|
|
// State for handling userid:foo constructs. Potentially emits a token.
|
|
function inuserid($content){
|
|
if (strlen($content) < 8) { // State exit or missing parameter.
|
|
return true;
|
|
}
|
|
// Strip off the userid: part and add the reminder to the parsed token array
|
|
$param = trim(substr($content,7));
|
|
$this->tokens[] = new search_token(TOKEN_USERID,$param);
|
|
return true;
|
|
}
|
|
|
|
|
|
// State for handling user:foo constructs. Potentially emits a token.
|
|
function inusername($content){
|
|
if (strlen($content) < 6) { // State exit or missing parameter.
|
|
return true;
|
|
}
|
|
// Strip off the user: part and add the reminder to the parsed token array
|
|
$param = trim(substr($content,5));
|
|
$this->tokens[] = new search_token(TOKEN_USER,$param);
|
|
return true;
|
|
}
|
|
|
|
|
|
// State for handling meta:foo constructs. Potentially emits a token.
|
|
function inmeta($content){
|
|
if (strlen($content) < 9) { // Missing parameter.
|
|
return true;
|
|
}
|
|
// Strip off the meta: part and add the reminder to the parsed token array.
|
|
$param = trim(substr($content,8));
|
|
$this->tokens[] = new search_token(TOKEN_META,$param);
|
|
return true;
|
|
}
|
|
|
|
|
|
// State entered when we've seen a required string (+foo). Potentially
|
|
// emits a token.
|
|
function inrequired($content){
|
|
if (strlen($content) < 2) { // State exit or missing parameter, don't emit.
|
|
return true;
|
|
}
|
|
// Strip off the + sign and add the reminder to the parsed token array.
|
|
$this->tokens[] = new search_token(TOKEN_EXACT,substr($content,1));
|
|
return true;
|
|
}
|
|
|
|
// State entered when we've seen an excluded string (-foo). Potentially
|
|
// emits a token.
|
|
function inexcluded($content){
|
|
if (strlen($content) < 2) { // State exit or missing parameter.
|
|
return true;
|
|
}
|
|
// Strip off the -sign and add the reminder to the parsed token array.
|
|
$this->tokens[] = new search_token(TOKEN_NEGATE,substr($content,1));
|
|
return true;
|
|
}
|
|
|
|
|
|
// State entered when we've seen a quoted string. Potentially emits a token.
|
|
function inquotedstring($content){
|
|
if (strlen($content) < 2) { // State exit or missing parameter.
|
|
return true;
|
|
}
|
|
// Strip off the opening quote and add the reminder to the parsed token array.
|
|
$this->tokens[] = new search_token(TOKEN_STRING,substr($content,1));
|
|
return true;
|
|
}
|
|
|
|
// State entered when we've seen an ordinary, non-quoted word. Potentially
|
|
// emits a token.
|
|
function plainstring($content){
|
|
if (trim($content) === '') { // State exit
|
|
return true;
|
|
}
|
|
// Add the string to the parsed token array.
|
|
$this->tokens[] = new search_token(TOKEN_STRING,$content);
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Primitive function to generate a SQL string from a parse tree
|
|
* using TEXT indexes. If searches aren't suitable to use TEXT
|
|
* this function calls the default search_generate_SQL() one.
|
|
*
|
|
* @deprecated since Moodle 2.9 MDL-48939
|
|
* @todo MDL-48940 This will be deleted in Moodle 3.2
|
|
* @see search_generate_SQL()
|
|
*/
|
|
function search_generate_text_SQL($parsetree, $datafield, $metafield, $mainidfield, $useridfield,
|
|
$userfirstnamefield, $userlastnamefield, $timefield, $instancefield) {
|
|
debugging('search_generate_text_SQL() is deprecated, please use search_generate_SQL() instead.', DEBUG_DEVELOPER);
|
|
|
|
return search_generate_SQL($parsetree, $datafield, $metafield, $mainidfield, $useridfield,
|
|
$userfirstnamefield, $userlastnamefield, $timefield, $instancefield);
|
|
}
|
|
|
|
/**
|
|
* Primitive function to generate a SQL string from a parse tree.
|
|
* Parameters:
|
|
*
|
|
* $parsetree should be a parse tree generated by a
|
|
* search_lexer/search_parser combination.
|
|
* Other fields are database table names to search.
|
|
*
|
|
* @global object
|
|
* @global object
|
|
*/
|
|
function search_generate_SQL($parsetree, $datafield, $metafield, $mainidfield, $useridfield,
|
|
$userfirstnamefield, $userlastnamefield, $timefield, $instancefield,
|
|
$tagfields = []) {
|
|
global $CFG, $DB;
|
|
static $p = 0;
|
|
|
|
if ($DB->sql_regex_supported()) {
|
|
$REGEXP = $DB->sql_regex(true);
|
|
$NOTREGEXP = $DB->sql_regex(false);
|
|
}
|
|
|
|
$params = array();
|
|
|
|
$ntokens = count($parsetree);
|
|
if ($ntokens == 0) {
|
|
return "";
|
|
}
|
|
|
|
$SQLString = '';
|
|
$nexttagfield = 0;
|
|
for ($i=0; $i<$ntokens; $i++){
|
|
if ($i > 0) {// We have more than one clause, need to tack on AND
|
|
$SQLString .= ' AND ';
|
|
}
|
|
|
|
$type = $parsetree[$i]->getType();
|
|
$value = $parsetree[$i]->getValue();
|
|
|
|
/// Under Oracle and MSSQL, transform TOKEN searches into STRING searches and trim +- chars
|
|
if (!$DB->sql_regex_supported()) {
|
|
$value = trim($value, '+-');
|
|
if ($type == TOKEN_EXACT) {
|
|
$type = TOKEN_STRING;
|
|
}
|
|
}
|
|
|
|
$name1 = 'sq'.$p++;
|
|
$name2 = 'sq'.$p++;
|
|
|
|
switch($type){
|
|
case TOKEN_STRING:
|
|
$SQLString .= "((".$DB->sql_like($datafield, ":$name1", false).") OR (".$DB->sql_like($metafield, ":$name2", false)."))";
|
|
$params[$name1] = "%$value%";
|
|
$params[$name2] = "%$value%";
|
|
break;
|
|
case TOKEN_EXACT:
|
|
$SQLString .= "(($datafield $REGEXP :$name1) OR ($metafield $REGEXP :$name2))";
|
|
$params[$name1] = "[[:<:]]".$value."[[:>:]]";
|
|
$params[$name2] = "[[:<:]]".$value."[[:>:]]";
|
|
break;
|
|
case TOKEN_META:
|
|
if ($metafield != '') {
|
|
$SQLString .= "(".$DB->sql_like($metafield, ":$name1", false).")";
|
|
$params[$name1] = "%$value%";
|
|
}
|
|
break;
|
|
case TOKEN_USER:
|
|
$SQLString .= "(($mainidfield = $useridfield) AND ((".$DB->sql_like($userfirstnamefield, ":$name1", false).") OR (".$DB->sql_like($userlastnamefield, ":$name2", false).")))";
|
|
$params[$name1] = "%$value%";
|
|
$params[$name2] = "%$value%";
|
|
break;
|
|
case TOKEN_USERID:
|
|
$SQLString .= "($useridfield = :$name1)";
|
|
$params[$name1] = $value;
|
|
break;
|
|
case TOKEN_INSTANCE:
|
|
$SQLString .= "($instancefield = :$name1)";
|
|
$params[$name1] = $value;
|
|
break;
|
|
case TOKEN_DATETO:
|
|
$SQLString .= "($timefield <= :$name1)";
|
|
$params[$name1] = $value;
|
|
break;
|
|
case TOKEN_DATEFROM:
|
|
$SQLString .= "($timefield >= :$name1)";
|
|
$params[$name1] = $value;
|
|
break;
|
|
case TOKEN_TAGS:
|
|
$sqlstrings = [];
|
|
foreach (explode(',', $value) as $tag) {
|
|
$paramname = $name1 . '_' . $nexttagfield;
|
|
if (isset($tagfields[$nexttagfield])) {
|
|
$sqlstrings[] = "($tagfields[$nexttagfield] = :$paramname)";
|
|
$params[$paramname] = $tag;
|
|
} else if (!isset($tagfields[$nexttagfield]) && !isset($stoppedprocessingtags)) {
|
|
// Show a debugging message the first time we hit this.
|
|
$stoppedprocessingtags = true;
|
|
\core\notification::add(get_string('toomanytags'), \core\notification::WARNING);
|
|
}
|
|
$nexttagfield++;
|
|
}
|
|
$SQLString .= implode(' AND ', $sqlstrings);
|
|
break;
|
|
case TOKEN_NEGATE:
|
|
$SQLString .= "(NOT ((".$DB->sql_like($datafield, ":$name1", false).") OR (".$DB->sql_like($metafield, ":$name2", false).")))";
|
|
$params[$name1] = "%$value%";
|
|
$params[$name2] = "%$value%";
|
|
break;
|
|
default:
|
|
return '';
|
|
|
|
}
|
|
}
|
|
return array($SQLString, $params);
|
|
}
|
|
|