SelectQuery::selectFieldIsValid() - Code Metrics - lagdo/jaxon-dbadmin - Measure and Improve Code Quality continuously with Scrutinizer

SelectQuery::selectFieldIsValid() B
last analyzed 2025-09-18 00:05 UTC

↳ Parent: SelectQuery
Complexity

Conditions	7
Paths	22
Size

Total Lines	11
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	7
eloc	9
c	1
b	0
f	0
nc	22
nop	2
dl	0
loc	11
rs	8.8333
<?php

namespace Lagdo\DbAdmin\Db\Facades\Select;

use Lagdo\DbAdmin\Admin\Traits\InputFieldTrait;
use Lagdo\DbAdmin\Db\Facades\AbstractFacade;
use Lagdo\DbAdmin\Driver\Entity\IndexEntity;
use Lagdo\DbAdmin\Driver\Entity\TableFieldEntity;
use Lagdo\DbAdmin\Driver\Entity\TableSelectEntity;
use Lagdo\Facades\Logger;
use Exception;

use function count;
use function implode;
use function intval;
use function in_array;
use function preg_match;
use function strtoupper;
use function str_replace;


class SelectQuery extends AbstractFacade
{
    use InputFieldTrait;

    use SelectTrait;


    /**
     * Get required data for select on tables
     *
     * @param SelectEntity $selectEntity
     *
     * @return SelectEntity
     * @throws Exception
     */
    public function prepareSelect(SelectEntity $selectEntity): SelectEntity
    {
        $this->setDefaultOptions($selectEntity);

        // From select.inc.php
        $selectEntity->fields = $this->driver->fields($selectEntity->table);
        $selectEntity->fields = $this->driver->fields($selectEntity->table);
        $this->setFieldsOptions($selectEntity);
        if (!$selectEntity->columns && $this->driver->support("table")) {

            throw new Exception($this->utils->trans->lang('Unable to select the table') .
                ($selectEntity->fields ? "." : ": " . $this->driver->error()));
        }

        $selectEntity->indexes = $this->driver->indexes($selectEntity->table);
        $this->setForeignKeys($selectEntity);
        $this->setSelectColumns($selectEntity);

        $this->setSelectWhere($selectEntity);
        $this->setSelectOrder($selectEntity);
        $this->setSelectLimit($selectEntity);
        $this->setPrimaryKey($selectEntity);

        // $set = null;
        // if(isset($rights["insert"]) || !this->driver->support("table")) {
        //     $set = "";
        //     foreach((array) $queryOptions["where"] as $val) {
        //         if($foreignKeys[$val["col"]] && count($foreignKeys[$val["col"]]) == 1 && ($val["op"] == "="
        //             || (!$val["op"] && !preg_match('~[_%]~', $val["val"])) // LIKE in Editor
        //         )) {
        //             $set .= "&set" . urlencode("[" . $this->driver->bracketEscape($val["col"]) . "]") . "=" . urlencode($val["val"]);
        //         }
        //     }
        // }
        // $this->admin->selectLinks($tableStatus, $set);

        // if($page == "last")
        // {
        //     $isGroup = count($group) < count($select);
        //     $found_rows = $this->driver->result($this->driver->getRowCountQuery($table, $where, $isGroup, $group));
        //     $page = \floor(\max(0, $found_rows - 1) / $limit);
        // }

        $this->setSelectOptions($selectEntity);
        $this->setSelectEntity($selectEntity);
        $this->setSelectQuery($selectEntity);

        return $selectEntity;
    }

    /**
     * @param SelectEntity $selectEntity
     *
     * @return void
     */
    private function setDefaultOptions(SelectEntity $selectEntity): void
    {
        $defaultOptions = [
            'columns' => [],
            'where' => [],
            'order' => [],
            'desc' => [],
            'fulltext' => [],
            'limit' => '50',
            'text_length' => '100',
            'page' => '1',
        ];
        foreach ($defaultOptions as $name => $value) {
            if (!isset($this->utils->input->values[$name])) {
                $this->utils->input->values[$name] = $value;
            }
            if (!isset($selectEntity->queryOptions[$name])) {
                $selectEntity->queryOptions[$name] = $value;
            }
        }
        $page = intval($selectEntity->queryOptions['page']);
        if ($page > 0) {
            $page -= 1; // Page numbers start at 0 here, instead of 1.
        }
        $selectEntity->queryOptions['page'] = $page;
        $selectEntity->page = $page;
    }

    /**
     * @param SelectEntity $selectEntity
     *
     * @return void
     */
    private function setFieldsOptions(SelectEntity $selectEntity): void
    {
        $selectEntity->rights = []; // privilege => 0
        $selectEntity->columns = []; // selectable columns
        $selectEntity->textLength = 0;
        foreach ($selectEntity->fields as $key => $field) {
            $name = $this->admin->fieldName($field);
            if (isset($field->privileges["select"]) && $name != "") {
                $selectEntity->columns[$key] = html_entity_decode(strip_tags($name), ENT_QUOTES);
                if ($this->admin->isShortable($field)) {
                    $this->setSelectTextLength($selectEntity);
                }
            }
            $selectEntity->rights[] = $field->privileges;
        }
    }

    /**
     * Find out foreign keys for each column
     *
     * @param SelectEntity $selectEntity
     *
     * @return void
     */
    private function setForeignKeys(SelectEntity $selectEntity): void
    {
        $selectEntity->foreignKeys = [];
        foreach ($this->driver->foreignKeys($selectEntity->table) as $foreignKey) {
            foreach ($foreignKey->source as $val) {
                $selectEntity->foreignKeys[$val][] = $foreignKey;
            }
        }
    }

    /**
     * @param array $value
     *
     * @return bool
     */
    private function colHasValidValue(array $value): bool
    {
        return $value['fun'] === 'count' ||
            ($value['col'] !== '' && (!$value['fun'] ||
                in_array($value['fun'], $this->driver->functions()) ||
                in_array($value['fun'], $this->driver->grouping())));
    }

    /**
     * @param array $where AND conditions
     * @param array $foreignKeys
     *
     * @return bool
     */
    // private function setSelectEmail(array $where, array $foreignKeys)
    // {
    //     return false;
    // }

    /**
     * Apply SQL function
     *
     * @param string $function
     * @param string $column escaped column identifier
     *
     * @return string
     */
    public function applySqlFunction(string $function, string $column): string
    {
        if (!$function) {
            return $column;
        }
        if ($function === 'unixepoch') {
            return "DATETIME($column, '$function')";
        }
        if ($function === 'count distinct') {
            return "COUNT(DISTINCT $column)";
        }
        return strtoupper($function) . "($column)";
    }

    /**
     * @param SelectEntity $selectEntity
     *
     * @return void
     */
    private function setSelectColumns(SelectEntity $selectEntity): void
    {
        $selectEntity->select = []; // select expressions, empty for *
        $selectEntity->group = []; // expressions without aggregation - will be used for GROUP BY if an aggregation function is used
        $values = $this->utils->input->values;
        foreach ($values['columns'] as $key => $value) {
            if ($this->colHasValidValue($value)) {
                $column = '*';
                if ($value['col'] !== '') {
                    $column = $this->driver->escapeId($value['col']);
                }
                $selectEntity->select[$key] = $this->applySqlFunction($value['fun'], $column);
                if (!in_array($value['fun'], $this->driver->grouping())) {
                    $selectEntity->group[] = $selectEntity->select[$key];
                }
            }
        }
    }

    /**
     * @param array $value
     * @param array $fields
     *
     * @return string
     */
    private function getWhereCondition(array $value, array $fields): string
    {
        $op = $value['op'];
        $val = $value['val'];
        $col = $value['col'];
        if (preg_match('~IN$~', $op)) {
            $in = $this->driver->processLength($val);
            return " $op " . ($in !== '' ? $in : '(NULL)');
        }
        if ($op === 'SQL') {
            return ' ' . $val; // SQL injection
        }
        if ($op === 'LIKE %%') {
            return ' LIKE ' . $this->getUnconvertedFieldValue($fields[$col], "%$val%");
        }
        if ($op === 'ILIKE %%') {
            return ' ILIKE ' . $this->getUnconvertedFieldValue($fields[$col], "%$val%");
        }
        if ($op === 'FIND_IN_SET') {
            return ')';
        }
        if (!preg_match('~NULL$~', $op)) {
            return " $op " . $this->getUnconvertedFieldValue($fields[$col], $val);
        }
        return " $op";
    }

    /**
     * @param TableFieldEntity $field
     * @param array $value
     *
     * @return bool
     */
    private function selectFieldIsValid(TableFieldEntity $field, array $value): bool
    {
        $op = $value['op'];
        $val = $value['val'];
        $in = preg_match('~IN$~', $op) ? ',' : '';
        return (preg_match('~^[-\d.' . $in . ']+$~', $val) ||
                !preg_match('~' . $this->driver->numberRegex() . '|bit~', $field->type)) &&
            (!preg_match("~[\x80-\xFF]~", $val) ||
                preg_match('~char|text|enum|set~', $field->type)) &&
            (!preg_match('~date|timestamp~', $field->type) ||
                preg_match('~^\d+-\d+-\d+~', $val));
    }

    /**
     * @param array $value
     * @param array $fields
     *
     * @return string
     */
    private function getSelectExpression(array $value, array $fields): string
    {
        $op = $value['op'];
        $col = $value['col'];
        $prefix = '';
        if ($op === 'FIND_IN_SET') {
            $prefix = $op .'(' . $this->driver->quote($value['val']) . ', ';
        }
        $condition = $this->getWhereCondition($value, $fields);
        if ($col !== '') {
            return $prefix . $this->driver->convertSearch($this->driver->escapeId($col),
                    $value, $fields[$col]) . $condition;
        }
        // find anywhere
        $clauses = [];
        foreach ($fields as $name => $field) {
            if ($this->selectFieldIsValid($field, $value)) {
                $clauses[] = $prefix . $this->driver->convertSearch($this->driver->escapeId($name),
                        $value, $field) . $condition;
            }
        }
        if (empty($clauses)) {
            return '1 = 0';
        }
        return '(' . implode(' OR ', $clauses) . ')';
    }

    /**
     * @param IndexEntity $index
     * @param int $i
     *
     * @return string
     */
    private function getMatchExpression(IndexEntity $index, int $i): string
    {
        $columns = array_map(function ($column) {
            return $this->driver->escapeId($column);
        }, $index->columns);
        $fulltext = $this->utils->input->values['fulltext'][$i] ?? '';
        $match = $this->driver->quote($fulltext);
        if (isset($this->utils->input->values['boolean'][$i])) {
            $match .= ' IN BOOLEAN MODE';
        }
        return 'MATCH (' . implode(', ', $columns) . ') AGAINST (' . $match . ')';
    }

    /**
     * @param SelectEntity $selectEntity
     *
     * @return void
     */
    private function setSelectWhere(SelectEntity $selectEntity): void
    {
        $selectEntity->where = [];
        foreach ($selectEntity->indexes as $i => $index) {
            $fulltext = $this->utils->input->values['fulltext'][$i] ?? '';
            if ($index->type === 'FULLTEXT' && $fulltext !== '') {
                $selectEntity->where[] = $this->getMatchExpression($index, $i);
            }
        }
        foreach ((array) $this->utils->input->values['where'] as $value) {
            if (($value['col'] !== '' ||  $value['val'] !== '') &&
                in_array($value['op'], $this->driver->operators())) {
                $selectEntity->where[] = $this
                    ->getSelectExpression($value, $selectEntity->fields);
            }
        }
    }

    /**
     * @param SelectEntity $selectEntity
     *
     * @return void
     */
    private function setSelectOrder(SelectEntity $selectEntity): void
    {
        $values = $this->utils->input->values;
        $selectEntity->order = [];
        foreach ($values['order'] as $key => $value) {
            if ($value !== '') {
                $regexp = '~^((COUNT\(DISTINCT |[A-Z0-9_]+\()(`(?:[^`]|``)+`|"(?:[^"]|"")+")\)|COUNT\(\*\))$~';
                if (preg_match($regexp, $value) !== false) {
                    $value = $this->driver->escapeId($value);
                }
                if (isset($values['desc'][$key]) && intval($values['desc'][$key]) !== 0) {
                    $value .= ' DESC';
                }
                $selectEntity->order[] = $value;
            }
        }
    }

    /**
     * @param SelectEntity $selectEntity
     *
     * @return void
     */
    private function setSelectLimit(SelectEntity $selectEntity): void
    {
        $selectEntity->limit = intval($this->utils->input->values['limit'] ?? 50);
    }

    /**
     * @param SelectEntity $selectEntity
     *
     * @return void
     */
    private function setSelectTextLength(SelectEntity $selectEntity): void
    {
        $selectEntity->textLength = intval($this->utils->input->values['text_length'] ?? 100);
    }

    /**
     * @param SelectEntity $selectEntity
     *
     * @return void
     */
    private function setPrimaryKey(SelectEntity $selectEntity): void
    {
        $primary = null;
        $selectEntity->unselected = [];
        foreach ($selectEntity->indexes as $index) {
            if ($index->type === "PRIMARY") {
                $primary = array_flip($index->columns);
                $selectEntity->unselected = ($selectEntity->select ? $primary : []);
                foreach ($selectEntity->unselected as $key => $val) {
                    if (in_array($this->driver->escapeId($key), $selectEntity->select)) {
                        unset($selectEntity->unselected[$key]);
                    }
                }
                break;
            }
        }

        $oid = $selectEntity->tableStatus->oid;
        if ($oid && !$primary) {
            /*$primary = */$selectEntity->unselected = [$oid => 0];
            // Make an index for the OID
            $index = new IndexEntity();
            $index->type = "PRIMARY";
            $index->columns = [$oid];
            $selectEntity->indexes[] = $index;
        }
    }

    /**
     * @param SelectEntity $selectEntity
     *
     * @return void
     */
    public function setSelectQuery(SelectEntity $selectEntity): void
    {
        $query = $this->driver->buildSelectQuery($selectEntity->tableSelect);
        // From adminer.inc.php
        $selectEntity->query = str_replace("\n", " ", $query);
    }

    /**
     * @param SelectEntity $selectEntity
     *
     * @return void
     */
    private function setSelectOptions(SelectEntity $selectEntity): void
    {
        $selectEntity->options = [
            'columns' => $this->getColumnsOptions($selectEntity->select,
                $selectEntity->columns, $selectEntity->queryOptions),
            'filters' => $this->getFiltersOptions($selectEntity->columns,
                $selectEntity->indexes, $selectEntity->queryOptions),
            'sorting' => $this->getSortingOptions($selectEntity->columns,
                $selectEntity->queryOptions),
            'limit' => $this->getLimitOptions($selectEntity->limit),
            'length' => $this->getLengthOptions($selectEntity->textLength),
            // 'action' => $this->getActionOptions($selectEntity->indexes),
        ];
    }

    /**
     * @param SelectEntity $selectEntity
     *
     * @return void
     */
    private function setSelectEntity(SelectEntity $selectEntity): void
    {
        $select2 = $selectEntity->select;
        $group2 = $selectEntity->group;
        if (empty($select2)) {
            $select2[] = "*";
            $convert_fields = $this->driver->convertFields($selectEntity->columns,
                $selectEntity->fields, $selectEntity->select);
            if ($convert_fields) {
                $select2[] = substr($convert_fields, 2);
            }
        }
        foreach ($selectEntity->select as $key => $val) {
            $field = $fields[$this->driver->unescapeId($val)] ?? null;

            if ($field && ($as = $this->driver->convertField($field))) {
                $select2[$key] = "$as AS $val";
            }
        }
        $isGroup = count($selectEntity->group) < count($selectEntity->select);
        if (!$isGroup && !empty($unselected)) {

            foreach ($unselected as $key => $val) {
                $select2[] = $this->driver->escapeId($key);
                if (!empty($group2)) {
                    $group2[] = $this->driver->escapeId($key);
                }
            }
        }

        // From driver.inc.php
        $selectEntity->tableSelect = new TableSelectEntity($selectEntity->table,
            $select2, $selectEntity->where, $group2, $selectEntity->order,
            $selectEntity->limit, $selectEntity->page);
    }

    /**
     * Print action box in select
     *
     * @param array $indexes
     *
     * @return array
     */
    // private function getActionOptions(array $indexes)
    // {
    //     $columns = [];
    //     foreach ($indexes as $index) {
    //         $current_key = \reset($index->columns);
    //         if ($index->type != "FULLTEXT" && $current_key) {
    //             $columns[$current_key] = 1;
    //         }
    //     }
    //     $columns[""] = 1;
    //     return ['columns' => $columns];
    // }

    /**
     * Print command box in select
     *
     * @return bool whether to print default commands
     */
    // private function getCommandOptions()
    // {
    //     return !$this->driver->isInformationSchema($this->driver->database());
    // }

    /**
     * Print import box in select
     *
     * @return bool whether to print default import
     */
    // private function getImportOptions()
    // {
    //     return !$this->driver->isInformationSchema($this->driver->database());
    // }

    /**
     * Print extra text in the end of a select form
     *
     * @param array $emailFields Fields holding e-mails
     * @param array $columns Selectable columns
     *
     * @return array
     */
    // private function getEmailOptions(array $emailFields, array $columns)
    // {
    // }
}

lagdo / jaxon-dbadmin

SelectQuery::selectFieldIsValid() B last analyzed 2025-09-18 00:05 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SelectQuery::selectFieldIsValid() B
last analyzed 2025-09-18 00:05 UTC
