mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2025-12-08 10:38:15 +01:00
417726f7b1
# Fix: Execute bits in git and shebangs Some files had the execute bit improperly set to enabled. Some scripts did not have a correct shebang.
551 lines
14 KiB
PHP
551 lines
14 KiB
PHP
<?php
|
|
/*
|
|
* File: Query.php
|
|
* Category: -
|
|
* Author: M. Goldenbaum
|
|
* Created: 21.07.18 18:54
|
|
* Updated: -
|
|
*
|
|
* Description:
|
|
* -
|
|
*/
|
|
|
|
namespace Webklex\PHPIMAP\Query;
|
|
|
|
use Closure;
|
|
use Illuminate\Support\Str;
|
|
use Webklex\PHPIMAP\Exceptions\InvalidWhereQueryCriteriaException;
|
|
use Webklex\PHPIMAP\Exceptions\MethodNotFoundException;
|
|
use Webklex\PHPIMAP\Exceptions\MessageSearchValidationException;
|
|
|
|
/**
|
|
* Class WhereQuery
|
|
*
|
|
* @package Webklex\PHPIMAP\Query
|
|
*
|
|
* @method WhereQuery all()
|
|
* @method WhereQuery answered()
|
|
* @method WhereQuery deleted()
|
|
* @method WhereQuery new()
|
|
* @method WhereQuery old()
|
|
* @method WhereQuery recent()
|
|
* @method WhereQuery seen()
|
|
* @method WhereQuery unanswered()
|
|
* @method WhereQuery undeleted()
|
|
* @method WhereQuery unflagged()
|
|
* @method WhereQuery unseen()
|
|
* @method WhereQuery not()
|
|
* @method WhereQuery unkeyword($value)
|
|
* @method WhereQuery to($value)
|
|
* @method WhereQuery text($value)
|
|
* @method WhereQuery subject($value)
|
|
* @method WhereQuery since($date)
|
|
* @method WhereQuery on($date)
|
|
* @method WhereQuery keyword($value)
|
|
* @method WhereQuery from($value)
|
|
* @method WhereQuery flagged()
|
|
* @method WhereQuery cc($value)
|
|
* @method WhereQuery body($value)
|
|
* @method WhereQuery before($date)
|
|
* @method WhereQuery bcc($value)
|
|
* @method WhereQuery inReplyTo($value)
|
|
* @method WhereQuery messageId($value)
|
|
*
|
|
* @mixin Query
|
|
*/
|
|
class WhereQuery extends Query {
|
|
|
|
/**
|
|
* @var array $available_criteria
|
|
*/
|
|
protected $available_criteria = [
|
|
'OR', 'AND',
|
|
'ALL', 'ANSWERED', 'BCC', 'BEFORE', 'BODY', 'CC', 'DELETED', 'FLAGGED', 'FROM', 'KEYWORD',
|
|
'NEW', 'NOT', 'OLD', 'ON', 'RECENT', 'SEEN', 'SINCE', 'SUBJECT', 'TEXT', 'TO',
|
|
'UNANSWERED', 'UNDELETED', 'UNFLAGGED', 'UNKEYWORD', 'UNSEEN', 'UID'
|
|
];
|
|
|
|
/**
|
|
* Magic method in order to allow alias usage of all "where" methods in an optional connection with "NOT"
|
|
* @param string $name
|
|
* @param array|null $arguments
|
|
*
|
|
* @return mixed
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
* @throws MethodNotFoundException
|
|
*/
|
|
public function __call($name, $arguments) {
|
|
$that = $this;
|
|
|
|
$name = Str::camel($name);
|
|
|
|
if (strtolower(substr($name, 0, 3)) === 'not') {
|
|
$that = $that->whereNot();
|
|
$name = substr($name, 3);
|
|
}
|
|
|
|
if (strpos(strtolower($name), "where") === false) {
|
|
$method = 'where' . ucfirst($name);
|
|
} else {
|
|
$method = lcfirst($name);
|
|
}
|
|
|
|
if (method_exists($this, $method) === true) {
|
|
return call_user_func_array([$that, $method], $arguments);
|
|
}
|
|
|
|
throw new MethodNotFoundException("Method " . self::class . '::' . $method . '() is not supported');
|
|
}
|
|
|
|
/**
|
|
* Validate a given criteria
|
|
* @param $criteria
|
|
*
|
|
* @return string
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
protected function validate_criteria($criteria) {
|
|
$criteria = strtoupper($criteria);
|
|
if (substr($criteria, 0, 7) === "CUSTOM ") {
|
|
return substr($criteria, 7);
|
|
}
|
|
if (in_array($criteria, $this->available_criteria) === false) {
|
|
throw new InvalidWhereQueryCriteriaException();
|
|
}
|
|
|
|
return $criteria;
|
|
}
|
|
|
|
|
|
/**
|
|
* Register search parameters
|
|
* @param mixed $criteria
|
|
* @param null $value
|
|
*
|
|
* @return $this
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*
|
|
* Examples:
|
|
* $query->from("someone@email.tld")->seen();
|
|
* $query->whereFrom("someone@email.tld")->whereSeen();
|
|
* $query->where([["FROM" => "someone@email.tld"], ["SEEN"]]);
|
|
* $query->where(["FROM" => "someone@email.tld"])->where(["SEEN"]);
|
|
* $query->where(["FROM" => "someone@email.tld", "SEEN"]);
|
|
* $query->where("FROM", "someone@email.tld")->where("SEEN");
|
|
*/
|
|
public function where($criteria, $value = null): WhereQuery {
|
|
if (is_array($criteria)) {
|
|
foreach ($criteria as $key => $value) {
|
|
if (is_numeric($key)) {
|
|
$this->where($value);
|
|
}else{
|
|
$this->where($key, $value);
|
|
}
|
|
}
|
|
} else {
|
|
$this->push_search_criteria($criteria, $value);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Push a given search criteria and value pair to the search query
|
|
* @param $criteria string
|
|
* @param $value mixed
|
|
*
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
protected function push_search_criteria(string $criteria, $value){
|
|
$criteria = $this->validate_criteria($criteria);
|
|
$value = $this->parse_value($value);
|
|
|
|
if ($value === null || $value === '') {
|
|
$this->query->push([$criteria]);
|
|
} else {
|
|
$this->query->push([$criteria, $value]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param Closure $closure
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function orWhere(Closure $closure = null) {
|
|
$this->query->push(['OR']);
|
|
if ($closure !== null) $closure($this);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @param Closure $closure
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function andWhere(Closure $closure = null) {
|
|
$this->query->push(['AND']);
|
|
if ($closure !== null) $closure($this);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereAll() {
|
|
return $this->where('ALL');
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereAnswered() {
|
|
return $this->where('ANSWERED');
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereBcc($value) {
|
|
return $this->where('BCC', $value);
|
|
}
|
|
|
|
/**
|
|
* @param mixed $value
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
* @throws MessageSearchValidationException
|
|
*/
|
|
public function whereBefore($value) {
|
|
$date = $this->parse_date($value);
|
|
return $this->where('BEFORE', $date);
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereBody($value) {
|
|
return $this->where('BODY', $value);
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereCc($value) {
|
|
return $this->where('CC', $value);
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereDeleted() {
|
|
return $this->where('DELETED');
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereFlagged($value) {
|
|
return $this->where('FLAGGED', $value);
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereFrom($value) {
|
|
return $this->where('FROM', $value);
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereKeyword($value) {
|
|
return $this->where('KEYWORD', $value);
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereNew() {
|
|
return $this->where('NEW');
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereNot() {
|
|
return $this->where('NOT');
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereOld() {
|
|
return $this->where('OLD');
|
|
}
|
|
|
|
/**
|
|
* @param mixed $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws MessageSearchValidationException
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereOn($value) {
|
|
$date = $this->parse_date($value);
|
|
return $this->where('ON', $date);
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereRecent() {
|
|
return $this->where('RECENT');
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereSeen() {
|
|
return $this->where('SEEN');
|
|
}
|
|
|
|
/**
|
|
* @param mixed $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws MessageSearchValidationException
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereSince($value) {
|
|
$date = $this->parse_date($value);
|
|
return $this->where('SINCE', $date);
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereSubject($value) {
|
|
return $this->where('SUBJECT', $value);
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereText($value) {
|
|
return $this->where('TEXT', $value);
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereTo($value) {
|
|
return $this->where('TO', $value);
|
|
}
|
|
|
|
/**
|
|
* @param string $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereUnkeyword($value) {
|
|
return $this->where('UNKEYWORD', $value);
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereUnanswered() {
|
|
return $this->where('UNANSWERED');
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereUndeleted() {
|
|
return $this->where('UNDELETED');
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereUnflagged() {
|
|
return $this->where('UNFLAGGED');
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereUnseen() {
|
|
return $this->where('UNSEEN');
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereNoXSpam() {
|
|
return $this->where("CUSTOM X-Spam-Flag NO");
|
|
}
|
|
|
|
/**
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereIsXSpam() {
|
|
return $this->where("CUSTOM X-Spam-Flag YES");
|
|
}
|
|
|
|
/**
|
|
* Search for a specific header value
|
|
* @param $header
|
|
* @param $value
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereHeader($header, $value) {
|
|
return $this->where("CUSTOM HEADER $header $value");
|
|
}
|
|
|
|
/**
|
|
* Search for a specific message id
|
|
* @param $messageId
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereMessageId($messageId) {
|
|
return $this->whereHeader("Message-ID", $messageId);
|
|
}
|
|
|
|
/**
|
|
* Search for a specific message id
|
|
* @param $messageId
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereInReplyTo($messageId) {
|
|
return $this->whereHeader("In-Reply-To", $messageId);
|
|
}
|
|
|
|
/**
|
|
* @param $country_code
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereLanguage($country_code) {
|
|
return $this->where("Content-Language $country_code");
|
|
}
|
|
|
|
/**
|
|
* Get message be it UID.
|
|
*
|
|
* @param int|string $uid
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereUid($uid)
|
|
{
|
|
return $this->where('UID', $uid);
|
|
}
|
|
|
|
/**
|
|
* Get messages by their UIDs.
|
|
*
|
|
* @param array<int, int> $uids
|
|
*
|
|
* @return WhereQuery
|
|
* @throws InvalidWhereQueryCriteriaException
|
|
*/
|
|
public function whereUidIn($uids)
|
|
{
|
|
$uids = implode(',', $uids);
|
|
return $this->where('UID', $uids);
|
|
}
|
|
|
|
/**
|
|
* Apply the callback if the given "value" is truthy.
|
|
* copied from @url https://github.com/laravel/framework/blob/8.x/src/Illuminate/Support/Traits/Conditionable.php
|
|
*
|
|
* @param mixed $value
|
|
* @param callable $callback
|
|
* @param callable|null $default
|
|
|
|
* @return $this|mixed
|
|
*/
|
|
public function when($value, $callback, $default = null) {
|
|
if ($value) {
|
|
return $callback($this, $value) ?: $this;
|
|
} elseif ($default) {
|
|
return $default($this, $value) ?: $this;
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Apply the callback if the given "value" is falsy.
|
|
* copied from @url https://github.com/laravel/framework/blob/8.x/src/Illuminate/Support/Traits/Conditionable.php
|
|
*
|
|
* @param mixed $value
|
|
* @param callable $callback
|
|
* @param callable|null $default
|
|
|
|
* @return $this|mixed
|
|
*/
|
|
public function unless($value, $callback, $default = null) {
|
|
if (! $value) {
|
|
return $callback($this, $value) ?: $this;
|
|
} elseif ($default) {
|
|
return $default($this, $value) ?: $this;
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
} |