nextcloud / server

lib/private/Files/Cache/QuerySearchHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -85,7 +85,7 @@
 
 	/**
 	 * @param IQueryBuilder $builder
-	 * @param ISearchOperator $operator
+	 * @param ISearchOperator $operators
 	 */
 	public function searchOperatorArrayToDBExprArray(IQueryBuilder $builder, array $operators) {
 		return array_map(function ($operator) use ($builder) {

Indentation +176 added lines, -176 removed lines

@@ -34,180 +34,180 @@
  * Tools for transforming search queries into database queries
  */
 class QuerySearchHelper {
-	static protected $searchOperatorMap = [
-		ISearchComparison::COMPARE_LIKE => 'iLike',
-		ISearchComparison::COMPARE_EQUAL => 'eq',
-		ISearchComparison::COMPARE_GREATER_THAN => 'gt',
-		ISearchComparison::COMPARE_GREATER_THAN_EQUAL => 'gte',
-		ISearchComparison::COMPARE_LESS_THAN => 'lt',
-		ISearchComparison::COMPARE_LESS_THAN_EQUAL => 'lte'
-	];
-
-	static protected $searchOperatorNegativeMap = [
-		ISearchComparison::COMPARE_LIKE => 'notLike',
-		ISearchComparison::COMPARE_EQUAL => 'neq',
-		ISearchComparison::COMPARE_GREATER_THAN => 'lte',
-		ISearchComparison::COMPARE_GREATER_THAN_EQUAL => 'lt',
-		ISearchComparison::COMPARE_LESS_THAN => 'gte',
-		ISearchComparison::COMPARE_LESS_THAN_EQUAL => 'lt'
-	];
-
-	const TAG_FAVORITE = '_$!<Favorite>!$_';
-
-	/** @var IMimeTypeLoader */
-	private $mimetypeLoader;
-
-	/**
-	 * QuerySearchUtil constructor.
-	 *
-	 * @param IMimeTypeLoader $mimetypeLoader
-	 */
-	public function __construct(IMimeTypeLoader $mimetypeLoader) {
-		$this->mimetypeLoader = $mimetypeLoader;
-	}
-
-	/**
-	 * Whether or not the tag tables should be joined to complete the search
-	 *
-	 * @param ISearchOperator $operator
-	 * @return boolean
-	 */
-	public function shouldJoinTags(ISearchOperator $operator) {
-		if ($operator instanceof ISearchBinaryOperator) {
-			return array_reduce($operator->getArguments(), function ($shouldJoin, ISearchOperator $operator) {
-				return $shouldJoin || $this->shouldJoinTags($operator);
-			}, false);
-		} else if ($operator instanceof ISearchComparison) {
-			return $operator->getField() === 'tagname' || $operator->getField() === 'favorite';
-		}
-		return false;
-	}
-
-	/**
-	 * @param IQueryBuilder $builder
-	 * @param ISearchOperator $operator
-	 */
-	public function searchOperatorArrayToDBExprArray(IQueryBuilder $builder, array $operators) {
-		return array_map(function ($operator) use ($builder) {
-			return $this->searchOperatorToDBExpr($builder, $operator);
-		}, $operators);
-	}
-
-	public function searchOperatorToDBExpr(IQueryBuilder $builder, ISearchOperator $operator) {
-		$expr = $builder->expr();
-		if ($operator instanceof ISearchBinaryOperator) {
-			switch ($operator->getType()) {
-				case ISearchBinaryOperator::OPERATOR_NOT:
-					$negativeOperator = $operator->getArguments()[0];
-					if ($negativeOperator instanceof ISearchComparison) {
-						return $this->searchComparisonToDBExpr($builder, $negativeOperator, self::$searchOperatorNegativeMap);
-					} else {
-						throw new \InvalidArgumentException('Binary operators inside "not" is not supported');
-					}
-				case ISearchBinaryOperator::OPERATOR_AND:
-					return call_user_func_array([$expr, 'andX'], $this->searchOperatorArrayToDBExprArray($builder, $operator->getArguments()));
-				case ISearchBinaryOperator::OPERATOR_OR:
-					return call_user_func_array([$expr, 'orX'], $this->searchOperatorArrayToDBExprArray($builder, $operator->getArguments()));
-				default:
-					throw new \InvalidArgumentException('Invalid operator type: ' . $operator->getType());
-			}
-		} else if ($operator instanceof ISearchComparison) {
-			return $this->searchComparisonToDBExpr($builder, $operator, self::$searchOperatorMap);
-		} else {
-			throw new \InvalidArgumentException('Invalid operator type: ' . get_class($operator));
-		}
-	}
-
-	private function searchComparisonToDBExpr(IQueryBuilder $builder, ISearchComparison $comparison, array $operatorMap) {
-		$this->validateComparison($comparison);
-
-		list($field, $value, $type) = $this->getOperatorFieldAndValue($comparison);
-		if (isset($operatorMap[$type])) {
-			$queryOperator = $operatorMap[$type];
-			return $builder->expr()->$queryOperator($field, $this->getParameterForValue($builder, $value));
-		} else {
-			throw new \InvalidArgumentException('Invalid operator type: ' . $comparison->getType());
-		}
-	}
-
-	private function getOperatorFieldAndValue(ISearchComparison $operator) {
-		$field = $operator->getField();
-		$value = $operator->getValue();
-		$type = $operator->getType();
-		if ($field === 'mimetype') {
-			if ($operator->getType() === ISearchComparison::COMPARE_EQUAL) {
-				$value = $this->mimetypeLoader->getId($value);
-			} else if ($operator->getType() === ISearchComparison::COMPARE_LIKE) {
-				// transform "mimetype='foo/%'" to "mimepart='foo'"
-				if (preg_match('|(.+)/%|', $value, $matches)) {
-					$field = 'mimepart';
-					$value = $this->mimetypeLoader->getId($matches[1]);
-					$type = ISearchComparison::COMPARE_EQUAL;
-				}
-				if (strpos($value, '%') !== false) {
-					throw new \InvalidArgumentException('Unsupported query value for mimetype: ' . $value . ', only values in the format "mime/type" or "mime/%" are supported');
-				}
-			}
-		} else if ($field === 'favorite') {
-			$field = 'tag.category';
-			$value = self::TAG_FAVORITE;
-		} else if ($field === 'tagname') {
-			$field = 'tag.category';
-		}
-		return [$field, $value, $type];
-	}
-
-	private function validateComparison(ISearchComparison $operator) {
-		$types = [
-			'mimetype' => 'string',
-			'mtime' => 'integer',
-			'name' => 'string',
-			'size' => 'integer',
-			'tagname' => 'string',
-			'favorite' => 'boolean',
-			'fileid' => 'integer'
-		];
-		$comparisons = [
-			'mimetype' => ['eq', 'like'],
-			'mtime' => ['eq', 'gt', 'lt', 'gte', 'lte'],
-			'name' => ['eq', 'like'],
-			'size' => ['eq', 'gt', 'lt', 'gte', 'lte'],
-			'tagname' => ['eq', 'like'],
-			'favorite' => ['eq'],
-			'fileid' => ['eq']
-		];
-
-		if (!isset($types[$operator->getField()])) {
-			throw new \InvalidArgumentException('Unsupported comparison field ' . $operator->getField());
-		}
-		$type = $types[$operator->getField()];
-		if (gettype($operator->getValue()) !== $type) {
-			throw new \InvalidArgumentException('Invalid type for field ' . $operator->getField());
-		}
-		if (!in_array($operator->getType(), $comparisons[$operator->getField()])) {
-			throw new \InvalidArgumentException('Unsupported comparison for field  ' . $operator->getField() . ': ' . $operator->getType());
-		}
-	}
-
-	private function getParameterForValue(IQueryBuilder $builder, $value) {
-		if ($value instanceof \DateTime) {
-			$value = $value->getTimestamp();
-		}
-		if (is_numeric($value)) {
-			$type = IQueryBuilder::PARAM_INT;
-		} else {
-			$type = IQueryBuilder::PARAM_STR;
-		}
-		return $builder->createNamedParameter($value, $type);
-	}
-
-	/**
-	 * @param IQueryBuilder $query
-	 * @param ISearchOrder[] $orders
-	 */
-	public function addSearchOrdersToQuery(IQueryBuilder $query, array $orders) {
-		foreach ($orders as $order) {
-			$query->addOrderBy($order->getField(), $order->getDirection());
-		}
-	}
+    static protected $searchOperatorMap = [
+        ISearchComparison::COMPARE_LIKE => 'iLike',
+        ISearchComparison::COMPARE_EQUAL => 'eq',
+        ISearchComparison::COMPARE_GREATER_THAN => 'gt',
+        ISearchComparison::COMPARE_GREATER_THAN_EQUAL => 'gte',
+        ISearchComparison::COMPARE_LESS_THAN => 'lt',
+        ISearchComparison::COMPARE_LESS_THAN_EQUAL => 'lte'
+    ];
+
+    static protected $searchOperatorNegativeMap = [
+        ISearchComparison::COMPARE_LIKE => 'notLike',
+        ISearchComparison::COMPARE_EQUAL => 'neq',
+        ISearchComparison::COMPARE_GREATER_THAN => 'lte',
+        ISearchComparison::COMPARE_GREATER_THAN_EQUAL => 'lt',
+        ISearchComparison::COMPARE_LESS_THAN => 'gte',
+        ISearchComparison::COMPARE_LESS_THAN_EQUAL => 'lt'
+    ];
+
+    const TAG_FAVORITE = '_$!<Favorite>!$_';
+
+    /** @var IMimeTypeLoader */
+    private $mimetypeLoader;
+
+    /**
+     * QuerySearchUtil constructor.
+     *
+     * @param IMimeTypeLoader $mimetypeLoader
+     */
+    public function __construct(IMimeTypeLoader $mimetypeLoader) {
+        $this->mimetypeLoader = $mimetypeLoader;
+    }
+
+    /**
+     * Whether or not the tag tables should be joined to complete the search
+     *
+     * @param ISearchOperator $operator
+     * @return boolean
+     */
+    public function shouldJoinTags(ISearchOperator $operator) {
+        if ($operator instanceof ISearchBinaryOperator) {
+            return array_reduce($operator->getArguments(), function ($shouldJoin, ISearchOperator $operator) {
+                return $shouldJoin || $this->shouldJoinTags($operator);
+            }, false);
+        } else if ($operator instanceof ISearchComparison) {
+            return $operator->getField() === 'tagname' || $operator->getField() === 'favorite';
+        }
+        return false;
+    }
+
+    /**
+     * @param IQueryBuilder $builder
+     * @param ISearchOperator $operator
+     */
+    public function searchOperatorArrayToDBExprArray(IQueryBuilder $builder, array $operators) {
+        return array_map(function ($operator) use ($builder) {
+            return $this->searchOperatorToDBExpr($builder, $operator);
+        }, $operators);
+    }
+
+    public function searchOperatorToDBExpr(IQueryBuilder $builder, ISearchOperator $operator) {
+        $expr = $builder->expr();
+        if ($operator instanceof ISearchBinaryOperator) {
+            switch ($operator->getType()) {
+                case ISearchBinaryOperator::OPERATOR_NOT:
+                    $negativeOperator = $operator->getArguments()[0];
+                    if ($negativeOperator instanceof ISearchComparison) {
+                        return $this->searchComparisonToDBExpr($builder, $negativeOperator, self::$searchOperatorNegativeMap);
+                    } else {
+                        throw new \InvalidArgumentException('Binary operators inside "not" is not supported');
+                    }
+                case ISearchBinaryOperator::OPERATOR_AND:
+                    return call_user_func_array([$expr, 'andX'], $this->searchOperatorArrayToDBExprArray($builder, $operator->getArguments()));
+                case ISearchBinaryOperator::OPERATOR_OR:
+                    return call_user_func_array([$expr, 'orX'], $this->searchOperatorArrayToDBExprArray($builder, $operator->getArguments()));
+                default:
+                    throw new \InvalidArgumentException('Invalid operator type: ' . $operator->getType());
+            }
+        } else if ($operator instanceof ISearchComparison) {
+            return $this->searchComparisonToDBExpr($builder, $operator, self::$searchOperatorMap);
+        } else {
+            throw new \InvalidArgumentException('Invalid operator type: ' . get_class($operator));
+        }
+    }
+
+    private function searchComparisonToDBExpr(IQueryBuilder $builder, ISearchComparison $comparison, array $operatorMap) {
+        $this->validateComparison($comparison);
+
+        list($field, $value, $type) = $this->getOperatorFieldAndValue($comparison);
+        if (isset($operatorMap[$type])) {
+            $queryOperator = $operatorMap[$type];
+            return $builder->expr()->$queryOperator($field, $this->getParameterForValue($builder, $value));
+        } else {
+            throw new \InvalidArgumentException('Invalid operator type: ' . $comparison->getType());
+        }
+    }
+
+    private function getOperatorFieldAndValue(ISearchComparison $operator) {
+        $field = $operator->getField();
+        $value = $operator->getValue();
+        $type = $operator->getType();
+        if ($field === 'mimetype') {
+            if ($operator->getType() === ISearchComparison::COMPARE_EQUAL) {
+                $value = $this->mimetypeLoader->getId($value);
+            } else if ($operator->getType() === ISearchComparison::COMPARE_LIKE) {
+                // transform "mimetype='foo/%'" to "mimepart='foo'"
+                if (preg_match('|(.+)/%|', $value, $matches)) {
+                    $field = 'mimepart';
+                    $value = $this->mimetypeLoader->getId($matches[1]);
+                    $type = ISearchComparison::COMPARE_EQUAL;
+                }
+                if (strpos($value, '%') !== false) {
+                    throw new \InvalidArgumentException('Unsupported query value for mimetype: ' . $value . ', only values in the format "mime/type" or "mime/%" are supported');
+                }
+            }
+        } else if ($field === 'favorite') {
+            $field = 'tag.category';
+            $value = self::TAG_FAVORITE;
+        } else if ($field === 'tagname') {
+            $field = 'tag.category';
+        }
+        return [$field, $value, $type];
+    }
+
+    private function validateComparison(ISearchComparison $operator) {
+        $types = [
+            'mimetype' => 'string',
+            'mtime' => 'integer',
+            'name' => 'string',
+            'size' => 'integer',
+            'tagname' => 'string',
+            'favorite' => 'boolean',
+            'fileid' => 'integer'
+        ];
+        $comparisons = [
+            'mimetype' => ['eq', 'like'],
+            'mtime' => ['eq', 'gt', 'lt', 'gte', 'lte'],
+            'name' => ['eq', 'like'],
+            'size' => ['eq', 'gt', 'lt', 'gte', 'lte'],
+            'tagname' => ['eq', 'like'],
+            'favorite' => ['eq'],
+            'fileid' => ['eq']
+        ];
+
+        if (!isset($types[$operator->getField()])) {
+            throw new \InvalidArgumentException('Unsupported comparison field ' . $operator->getField());
+        }
+        $type = $types[$operator->getField()];
+        if (gettype($operator->getValue()) !== $type) {
+            throw new \InvalidArgumentException('Invalid type for field ' . $operator->getField());
+        }
+        if (!in_array($operator->getType(), $comparisons[$operator->getField()])) {
+            throw new \InvalidArgumentException('Unsupported comparison for field  ' . $operator->getField() . ': ' . $operator->getType());
+        }
+    }
+
+    private function getParameterForValue(IQueryBuilder $builder, $value) {
+        if ($value instanceof \DateTime) {
+            $value = $value->getTimestamp();
+        }
+        if (is_numeric($value)) {
+            $type = IQueryBuilder::PARAM_INT;
+        } else {
+            $type = IQueryBuilder::PARAM_STR;
+        }
+        return $builder->createNamedParameter($value, $type);
+    }
+
+    /**
+     * @param IQueryBuilder $query
+     * @param ISearchOrder[] $orders
+     */
+    public function addSearchOrdersToQuery(IQueryBuilder $query, array $orders) {
+        foreach ($orders as $order) {
+            $query->addOrderBy($order->getField(), $order->getDirection());
+        }
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -74,7 +74,7 @@ 
 	 */
 	public function shouldJoinTags(ISearchOperator $operator) {
 		if ($operator instanceof ISearchBinaryOperator) {
-			return array_reduce($operator->getArguments(), function ($shouldJoin, ISearchOperator $operator) {
+			return array_reduce($operator->getArguments(), function($shouldJoin, ISearchOperator $operator) {
 				return $shouldJoin || $this->shouldJoinTags($operator);
 			}, false);
 		} else if ($operator instanceof ISearchComparison) {
@@ -88,7 +88,7 @@ 
 	 * @param ISearchOperator $operator
 	 */
 	public function searchOperatorArrayToDBExprArray(IQueryBuilder $builder, array $operators) {
-		return array_map(function ($operator) use ($builder) {
+		return array_map(function($operator) use ($builder) {
 			return $this->searchOperatorToDBExpr($builder, $operator);
 		}, $operators);
 	}
@@ -109,12 +109,12 @@ 
 				case ISearchBinaryOperator::OPERATOR_OR:
 					return call_user_func_array([$expr, 'orX'], $this->searchOperatorArrayToDBExprArray($builder, $operator->getArguments()));
 				default:
-					throw new \InvalidArgumentException('Invalid operator type: ' . $operator->getType());
+					throw new \InvalidArgumentException('Invalid operator type: '.$operator->getType());
 			}
 		} else if ($operator instanceof ISearchComparison) {
 			return $this->searchComparisonToDBExpr($builder, $operator, self::$searchOperatorMap);
 		} else {
-			throw new \InvalidArgumentException('Invalid operator type: ' . get_class($operator));
+			throw new \InvalidArgumentException('Invalid operator type: '.get_class($operator));
 		}
 	}
 
@@ -126,7 +126,7 @@ 
 			$queryOperator = $operatorMap[$type];
 			return $builder->expr()->$queryOperator($field, $this->getParameterForValue($builder, $value));
 		} else {
-			throw new \InvalidArgumentException('Invalid operator type: ' . $comparison->getType());
+			throw new \InvalidArgumentException('Invalid operator type: '.$comparison->getType());
 		}
 	}
 
@@ -145,7 +145,7 @@ 
 					$type = ISearchComparison::COMPARE_EQUAL;
 				}
 				if (strpos($value, '%') !== false) {
-					throw new \InvalidArgumentException('Unsupported query value for mimetype: ' . $value . ', only values in the format "mime/type" or "mime/%" are supported');
+					throw new \InvalidArgumentException('Unsupported query value for mimetype: '.$value.', only values in the format "mime/type" or "mime/%" are supported');
 				}
 			}
 		} else if ($field === 'favorite') {
@@ -178,14 +178,14 @@ 
 		];
 
 		if (!isset($types[$operator->getField()])) {
-			throw new \InvalidArgumentException('Unsupported comparison field ' . $operator->getField());
+			throw new \InvalidArgumentException('Unsupported comparison field '.$operator->getField());
 		}
 		$type = $types[$operator->getField()];
 		if (gettype($operator->getValue()) !== $type) {
-			throw new \InvalidArgumentException('Invalid type for field ' . $operator->getField());
+			throw new \InvalidArgumentException('Invalid type for field '.$operator->getField());
 		}
 		if (!in_array($operator->getType(), $comparisons[$operator->getField()])) {
-			throw new \InvalidArgumentException('Unsupported comparison for field  ' . $operator->getField() . ': ' . $operator->getType());
+			throw new \InvalidArgumentException('Unsupported comparison for field  '.$operator->getField().': '.$operator->getType());
 		}
 	}