PartSearchFilter.php

<?php

declare(strict_types=1);

/*
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 *  Copyright (C) 2019 - 2022 Jan Böhmer (https://github.com/jbtronics)
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published
 *  by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
namespace App\DataTables\Filters;
use App\DataTables\Filters\Constraints\AbstractConstraint;
use Doctrine\ORM\QueryBuilder;
use Doctrine\DBAL\ParameterType;

class PartSearchFilter implements FilterInterface
{

    /** @var boolean Whether to use regex for searching */
    protected bool $regex = false;

    /** @var bool Use name field for searching */
    protected bool $name = true;

    /** @var bool Use id field for searching */
    protected bool $dbId = false;

    /** @var bool Use category name for searching */
    protected bool $category = true;

    /** @var bool Use description for searching */
    protected bool $description = true;

    /** @var bool Use tags for searching */
    protected bool $tags = true;

    /** @var bool Use storelocation name for searching */
    protected bool $storelocation = true;

    /** @var bool Use comment field for searching */
    protected bool $comment = true;

    /** @var bool Use ordernr for searching */
    protected bool $ordernr = true;

    /** @var bool Use manufacturer product name for searching */
    protected bool $mpn = true;

    /** @var bool Use supplier name for searching */
    protected bool $supplier = false;

    /** @var bool Use manufacturer name for searching */
    protected bool $manufacturer = false;

    /** @var bool Use footprint name for searching */
    protected bool $footprint = false;

    /** @var bool Use Internal Part number for searching */
    protected bool $ipn = true;

    /** @var int Helper variable for hacky array_map variable injection */
    protected int $it = 0;

    public function __construct(
        /** @var string The string to query for */
        protected string $keyword
    )
    {
        // Transform keyword and trim excess spaces
        $keyword = trim(str_replace('+', ' ', $keyword));
    }

    protected function getFieldsToSearch(): array
    {
        $fields_to_search = [];

        if($this->name) {
            $fields_to_search[] = 'part.name';
        }
        if($this->category) {
            $fields_to_search[] = '_category.name';
        }
        if($this->description) {
            $fields_to_search[] = 'part.description';
        }
        if ($this->comment) {
            $fields_to_search[] = 'part.comment';
        }
        if($this->tags) {
            $fields_to_search[] = 'part.tags';
        }
        if($this->storelocation) {
            $fields_to_search[] = '_storelocations.name';
        }
        if($this->ordernr) {
            $fields_to_search[] = '_orderdetails.supplierpartnr';
        }
        if($this->mpn) {
            $fields_to_search[] = 'part.manufacturer_product_number';
        }
        if($this->supplier) {
            $fields_to_search[] = '_suppliers.name';
        }
        if($this->manufacturer) {
            $fields_to_search[] = '_manufacturer.name';
        }
        if($this->footprint) {
            $fields_to_search[] = '_footprint.name';
        }
        if ($this->ipn) {
            $fields_to_search[] = 'part.ipn';
        }

        return $fields_to_search;
    }

    public function apply(QueryBuilder $queryBuilder): void
    {
        $fields_to_search = $this->getFieldsToSearch();
        $is_numeric = preg_match('/^\d+$/', $this->keyword) === 1;

        // Add exact ID match only when the keyword is numeric
        $search_dbId = $is_numeric && (bool)$this->dbId;

        //If we have nothing to search for, do nothing
        if (($fields_to_search === [] && !$search_dbId) || $this->keyword === '') {
            return;
        }
      
        $expressions = [];
        $params = [];
        
        //Use equal expression to just search for exact numeric matches
        if ($search_dbId) {
            $expressions[] = $queryBuilder->expr()->eq('part.id', ':id_exact');
            $params[] = new \Doctrine\ORM\Query\Parameter('id_exact', (int) $this->keyword,
                ParameterType::INTEGER);
        }

        if ($this->regex) {
            //Convert the fields to search to a list of expressions
            $expressions = array_map(function (string $field): string {
                return sprintf("REGEXP(%s, :search_query) = TRUE", $field);
            }, $fields_to_search);
            
            //For regex, we pass the query as is, save html special chars
            $params[] = new \Doctrine\ORM\Query\Parameter('search_query', $this->keyword);
        } else {
            //Escape % and _ characters in the keyword
            $this->keyword = str_replace(['%', '_'], ['\%', '\_'], $this->keyword);

            //Split keyword on spaces, but limit token count
            $tokens = explode(' ', $this->keyword, 5);

            //Perform search of every single token in every selected field
            //AND-combine the results (all tokens must be present in any of the results)
            for ($i = 0; $i < sizeof($tokens); $i++) {
                $this->it = $i;
                $tokens[$i] = trim($tokens[$i]);
              
                //Skip empty words (e.g. because of multiple spaces)
                if ($tokens[$i] === '') {
                    continue;
                }
                //Convert the fields to search to a list of expressions
                $expressions = array_map(function (string $field): string {
                    return sprintf("ILIKE(%s, :search_query%u) = TRUE", $field, $this->it);
                }, $fields_to_search);
              
                //Aggregate the parameters for consolidated commission
                $params[] = new \Doctrine\ORM\Query\Parameter('search_query' . $i,
                                                              '%' . $tokens[$i] . '%');
            }
        }
        
        $queryBuilder->setParameters(
            new \Doctrine\Common\Collections\ArrayCollection($params)
        );
        //Guard condition
        if (!empty($expressions)) {
            //Add Or concatenation of the expressions to our query
            $queryBuilder->andWhere(
                $queryBuilder->expr()->orX(...$expressions)
            );
        }
    }

    public function getKeyword(): string
    {
        return $this->keyword;
    }

    public function setKeyword(string $keyword): PartSearchFilter
    {
        $this->keyword = $keyword;
        return $this;
    }

    public function isRegex(): bool
    {
        return $this->regex;
    }

    public function setRegex(bool $regex): PartSearchFilter
    {
        $this->regex = $regex;
        return $this;
    }

    public function isName(): bool
    {
        return $this->name;
    }

    public function setName(bool $name): PartSearchFilter
    {
        $this->name = $name;
        return $this;
    }

    public function isDbId(): bool
    {
        return $this->dbId;
    }

    public function setDbId(bool $dbId): PartSearchFilter
    {
        $this->dbId = $dbId;
        return $this;
    }

    public function isCategory(): bool
    {
        return $this->category;
    }

    public function setCategory(bool $category): PartSearchFilter
    {
        $this->category = $category;
        return $this;
    }

    public function isDescription(): bool
    {
        return $this->description;
    }

    public function setDescription(bool $description): PartSearchFilter
    {
        $this->description = $description;
        return $this;
    }

    public function isTags(): bool
    {
        return $this->tags;
    }

    public function setTags(bool $tags): PartSearchFilter
    {
        $this->tags = $tags;
        return $this;
    }

    public function isStorelocation(): bool
    {
        return $this->storelocation;
    }

    public function setStorelocation(bool $storelocation): PartSearchFilter
    {
        $this->storelocation = $storelocation;
        return $this;
    }

    public function isOrdernr(): bool
    {
        return $this->ordernr;
    }

    public function setOrdernr(bool $ordernr): PartSearchFilter
    {
        $this->ordernr = $ordernr;
        return $this;
    }

    public function isMpn(): bool
    {
        return $this->mpn;
    }

    public function setMpn(bool $mpn): PartSearchFilter
    {
        $this->mpn = $mpn;
        return $this;
    }

    public function isIPN(): bool
    {
        return $this->ipn;
    }

    public function setIPN(bool $ipn): PartSearchFilter
    {
        $this->ipn = $ipn;
        return $this;
    }

    public function isSupplier(): bool
    {
        return $this->supplier;
    }

    public function setSupplier(bool $supplier): PartSearchFilter
    {
        $this->supplier = $supplier;
        return $this;
    }

    public function isManufacturer(): bool
    {
        return $this->manufacturer;
    }

    public function setManufacturer(bool $manufacturer): PartSearchFilter
    {
        $this->manufacturer = $manufacturer;
        return $this;
    }

    public function isFootprint(): bool
    {
        return $this->footprint;
    }

    public function setFootprint(bool $footprint): PartSearchFilter
    {
        $this->footprint = $footprint;
        return $this;
    }

    public function isComment(): bool
    {
        return $this->comment;
    }

    public function setComment(bool $comment): PartSearchFilter
    {
        $this->comment = $comment;
        return $this;
    }

}