Skip to content

Enforce sort direction in dql. Do not allowing ordering when disabled. #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
curry684 merged 2 commits into from
Jul 23, 2025
Merged

Enforce sort direction in dql. Do not allowing ordering when disabled. #389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c20c6f
Enforce sort direction in dql. Do not allowing ordering when disabled.
craigh Jul 14, 2025
d39e207
mb_strtolower
craigh Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/DataTable.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,10 @@ public function addOrderBy($column, string $direction = self::SORT_ASCENDING)
if (!$column instanceof AbstractColumn) {
$column = is_int($column) ? $this->getColumn($column) : $this->getColumnByName((string) $column);
}
$this->options['order'][] = [$column->getIndex(), $direction];
if (false !== $this->getOption('ordering')) {
Comment thread
craigh marked this conversation as resolved.
$direction = self::SORT_ASCENDING === mb_strtolower($direction) ? self::SORT_ASCENDING : self::SORT_DESCENDING;
$this->options['order'][] = [$column->getIndex(), $direction];
}

return $this;
}
Expand Down
10 changes: 8 additions & 2 deletions src/DataTableState.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,10 @@ public function setGlobalSearch(string $globalSearch): static

public function addOrderBy(AbstractColumn $column, string $direction = DataTable::SORT_ASCENDING): static
{
$this->orderBy[] = [$column, $direction];
if (false !== $this->dataTable->getOption('ordering')) {
Comment thread
craigh marked this conversation as resolved.
$direction = DataTable::SORT_ASCENDING === mb_strtolower($direction) ? DataTable::SORT_ASCENDING : DataTable::SORT_DESCENDING;
$this->orderBy[] = [$column, $direction];
}

return $this;
}
Expand All @@ -199,7 +202,10 @@ public function getOrderBy(): array
*/
public function setOrderBy(array $orderBy = []): static
{
$this->orderBy = $orderBy;
$this->orderBy = [];
foreach ($orderBy as [$column, $direction]) {
$this->addOrderBy($column, $direction);
}

return $this;
}
Expand Down
32 changes: 30 additions & 2 deletions tests/Unit/DataTableTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,10 @@ public function testFactoryRemembersInstances(): void
public function testDataTableState(): void
{
$datatable = $this->createMockDataTable();
$datatable->add('foo', TextColumn::class)->setMethod(Request::METHOD_GET);
$datatable
->add('foo', TextColumn::class)
->add('bar', TextColumn::class)
->setMethod(Request::METHOD_GET);
$datatable->handleRequest(Request::create('/?_dt=' . $datatable->getName()));
$state = $datatable->getState();

Expand All @@ -91,13 +94,20 @@ public function testDataTableState(): void
$state->setStart(5);
$state->setLength(10);
$state->setGlobalSearch('foo');
$state->setOrderBy([[0, 'asc'], [1, 'desc']]);
$state->setOrderBy([

@curry684 curry684 Jul 22, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As noted at #388 (comment) I would revert injecting semi-SQL here as it's confusing. Do the input sanitation tests in the new test case.

[$datatable->getColumn(0), 'asc'],
[$datatable->getColumn(1), 'desc0"XOR(if(now()=sysdate(),sleep(15),0))XOR"Z'], // intentional sql-injection test
]);
$state->setColumnSearch($datatable->getColumn(0), 'bar');

$this->assertSame(5, $state->getStart());
$this->assertSame(10, $state->getLength());
$this->assertSame('foo', $state->getGlobalSearch());
$this->assertCount(2, $state->getOrderBy());
foreach ($state->getOrderBy() as $order) {
// ensure sql-injection failed
$this->assertContains($order[1], [DataTable::SORT_ASCENDING, DataTable::SORT_DESCENDING]);
}
$this->assertSame('bar', $state->getSearchColumns(onlySearchable: false)['foo']['search']);

// Test boundaries
Expand Down Expand Up @@ -133,6 +143,24 @@ public function testDataTableStateSearchColumns(): void
$this->assertSame('foo', $searchColumns['foo']['search']);
}

/**
* If ordering is false, ensure columns are not ordered.
*/
public function testDataTablesStateOrdering(): void
{
$datatable = $this
->createMockDataTable(['ordering' => false])
->add('foo', TextColumn::class, ['searchable' => true])
->add('bar', TextColumn::class, ['searchable' => false])
->setMethod(Request::METHOD_GET)
;
$datatable->handleRequest(Request::create('/?_dt=' . $datatable->getName()));

$state = $datatable->getState();
$state->addOrderBy($datatable->getColumn(0), DataTable::SORT_DESCENDING);
$this->assertEmpty($state->getOrderBy());
}

public function testPostMethod(): void
{
$datatable = $this->createMockDataTable();
Expand Down