Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion src/Asset/Conditions/VolumeConditionRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use CraftCms\Cms\Asset\Elements\Asset;
use CraftCms\Cms\Condition\BaseMultiSelectConditionRule;
use CraftCms\Cms\Condition\Contracts\ConditionInterface;
use CraftCms\Cms\Database\Table;
use CraftCms\Cms\Element\Conditions\Contracts\ElementConditionRuleInterface;
use CraftCms\Cms\Element\Conditions\Contracts\ElementQueryConditionRuleInterface;
use CraftCms\Cms\Element\Contracts\ElementInterface;
Expand Down Expand Up @@ -48,7 +49,7 @@ protected function options(): array

public function modifyQuery(Builder $query, ElementQueryInterface $elementQuery): void
{
AssetQuery::applyVolumeId($query, $this->paramValue(fn ($uid) => Volumes::getVolumeByUid($uid)->id ?? null));
AssetQuery::applyVolumeId($query, $this->paramIds(Table::VOLUMES, fn ($uid) => Volumes::getVolumeByUid($uid)->id ?? null));
Comment thread
riasvdv marked this conversation as resolved.
Resolved
}

public function matchElement(ElementInterface $element): bool
Expand Down
26 changes: 26 additions & 0 deletions src/Condition/BaseMultiSelectConditionRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
use CraftCms\Cms\Ui\Contracts\Node;
use CraftCms\Cms\Ui\Controls\Combobox;
use CraftCms\Cms\Ui\Nodes\Field;
use Illuminate\Support\Facades\DB;
use Override;
use RuntimeException;

Expand Down Expand Up @@ -164,6 +165,31 @@ protected function paramValue(?callable $normalizeValue = null): string|array|nu
};
}

/**
* Returns the IDs of the rows in a table that the rule selects, for query methods that only accept a list of IDs.
*
* A “not” or “has a value” rule becomes the IDs it leaves in, rather than a param value for the query to parse.
*
* @param string $table The table that holds the selectable rows, which must have a `dateDeleted` column.
* @param callable $normalizeValue Method that returns the row ID for a selected value.
* @return int[]|null
*/
protected function paramIds(string $table, callable $normalizeValue): ?array
{
$value = $this->paramValue($normalizeValue);

if ($value === null) {
return null;
}

return DB::table($table)
->whereNumericParam('id', $value)
->whereNull('dateDeleted')
->pluck('id')
->map(fn ($id) => (int) $id)
->all();
}

/**
* Returns whether the condition rule matches the given value.
*
Expand Down
7 changes: 3 additions & 4 deletions src/Element/Conditions/SiteGroupConditionRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

use CraftCms\Cms\Condition\BaseMultiSelectConditionRule;
use CraftCms\Cms\Condition\Contracts\ConditionInterface;
use CraftCms\Cms\Database\Table;
use CraftCms\Cms\Element\Conditions\Contracts\ElementConditionRuleInterface;
use CraftCms\Cms\Element\Conditions\Contracts\ElementQueryConditionRuleInterface;
use CraftCms\Cms\Element\Contracts\ElementInterface;
Expand Down Expand Up @@ -51,10 +52,8 @@ protected function options(): array

public function modifyQuery(Builder $query, ElementQueryInterface $elementQuery): void
{
$siteIds = Collection::make((array) $this->paramValue())
->map(fn (string $uid) => SiteGroups::getGroupByUid($uid))
->filter(fn (?SiteGroup $group) => $group !== null)
->map(fn (SiteGroup $group) => Sites::getEditableSitesByGroupId($group->id))
$siteIds = Collection::make($this->paramIds(Table::SITEGROUPS, fn (string $uid) => SiteGroups::getGroupByUid($uid)->id ?? null) ?? [])
->map(fn (int $groupId) => Sites::getEditableSitesByGroupId($groupId))
->flatten(1)
->map(fn (Site $site) => $site->id)
->all();
Expand Down
6 changes: 6 additions & 0 deletions src/Element/Queries/Concerns/Asset/QueriesAssetLocation.php
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ protected function initQueriesAssetLocation(): void

public static function applyVolumeId(BuilderContract $query, mixed $value): void
{
if ($value === []) {
$query->whereRaw('0 = 1');

return;
}

if (! $value) {
return;
}
Expand Down
34 changes: 25 additions & 9 deletions src/Element/Queries/Concerns/Asset/QueriesAssetProperties.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
namespace CraftCms\Cms\Element\Queries\Concerns\Asset;

use CraftCms\Cms\Asset\AssetsHelper;
use CraftCms\Cms\Database\QueryParam;
use CraftCms\Cms\Element\Enums\ElementQueryParamType;
use CraftCms\Cms\Element\Queries\AssetQuery;
use CraftCms\Cms\Element\Queries\Attributes\ElementQueryParam;
Expand Down Expand Up @@ -113,19 +114,34 @@ public static function applyKind(BuilderContract $query, mixed $value): void
return;
}

$query->where(function (Builder $query) use ($value) {
$query->whereParam('assets.kind', $value);
$param = QueryParam::parse($value);
$kinds = AssetsHelper::getFileKinds();

$kinds = AssetsHelper::getFileKinds();
// Files with a kind’s extensions count as that kind too, so excluding the kind excludes them as well.
if ($param->operator === QueryParam::NOT) {
$query->where(function (Builder $query) use ($value, $param, $kinds) {
$query->whereParam('assets.kind', $value);

foreach ((array) $value as $kind) {
if (! isset($kinds[$kind])) {
continue;
foreach ($param->values as $kind) {
foreach ($kinds[$kind]['extensions'] ?? [] as $extension) {
$query->whereNotLike('assets.filename', "%.$extension");
}
}
});

foreach ($kinds[$kind]['extensions'] as $extension) {
$query->orWhereLike('assets.filename', "%.$extension");
}
return;
}

$query->where(function (Builder $query) use ($param, $kinds) {
foreach ($param->values as $kind) {
$query->where(function (Builder $query) use ($kind, $kinds) {
// The kind is already parsed, so keep whereParam() from splitting its commas or reading it as an operator.
$query->whereParam('assets.kind', [QueryParam::OR, $kind]);

foreach ($kinds[$kind]['extensions'] ?? [] as $extension) {
$query->orWhereLike('assets.filename', "%.$extension");
}
}, boolean: $param->operator);
}
});
}
Expand Down
6 changes: 6 additions & 0 deletions src/Element/Queries/Concerns/Entry/QueriesEntryTypes.php
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@ protected function initQueriesEntryTypes(): void

public static function applyTypeId(Builder $query, mixed $value): void
{
if ($value === []) {
$query->whereRaw('0 = 1');

return;
}

if (! $value) {
return;
}
Expand Down
24 changes: 14 additions & 10 deletions src/Entry/Conditions/SectionConditionRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

use CraftCms\Cms\Condition\BaseMultiSelectConditionRule;
use CraftCms\Cms\Condition\Contracts\ConditionInterface;
use CraftCms\Cms\Database\Table;
use CraftCms\Cms\Element\Conditions\Contracts\ElementConditionRuleInterface;
use CraftCms\Cms\Element\Conditions\Contracts\ElementQueryConditionRuleInterface;
use CraftCms\Cms\Element\Conditions\HintableConditionRuleTrait;
Expand Down Expand Up @@ -73,22 +74,25 @@ protected function options(): array

public function modifyQuery(Builder $query, ElementQueryInterface $elementQuery): void
{
if ($this->operator === self::OPERATOR_NOT_EMPTY) {
$sectionIds = Sections::getAllSectionIds()->values()->all();
} else {
$sectionIds = $this->paramValue(fn ($uid) => Sections::getSectionByUid($uid)->id ?? null);
}
$sectionIds = $this->paramIds(Table::SECTIONS, fn ($uid) => Sections::getSectionByUid($uid)->id ?? null);

EntryQuery::applySectionId($query, $sectionIds, $elementQuery);
// Unlike EntryQuery::applySectionId(), this leaves the query’s structure settings alone,
// since other rules in an “or” group can match entries in other sections.
if ($sectionIds !== null) {
$query->whereIn('entries.sectionId', $sectionIds);
}
}

public function matchElement(ElementInterface $element): bool
{
/** @var Entry $element */
if ($this->operator === self::OPERATOR_NOT_EMPTY) {
return $element->getSection() !== null;
if ($this->operator !== self::OPERATOR_NOT_EMPTY && $this->getValues() === []) {
return true;
}

return $this->matchValue($element->getSection()?->uid);
/** @var Entry $element */
$section = $element->getSection();

// The query only lists entries in sections, so sectionless entries, such as nested ones, don't match.
return $section !== null && $this->matchValue($section->uid);
}
}
4 changes: 3 additions & 1 deletion src/Entry/Conditions/SectionTypeConditionRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,9 @@ public function modifyQuery(Builder $query, ElementQueryInterface $elementQuery)
->values()
->all();

EntryQuery::applySectionId($query, $sectionIds, $elementQuery);
// Unlike EntryQuery::applySectionId(), this leaves the query’s structure settings alone,
// since other rules in an “or” group can match entries in other sections.
$query->whereIn('entries.sectionId', $sectionIds);
}

public function matchElement(ElementInterface $element): bool
Expand Down
4 changes: 2 additions & 2 deletions src/Entry/Conditions/TypeConditionRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

use CraftCms\Cms\Condition\BaseMultiSelectConditionRule;
use CraftCms\Cms\Condition\Contracts\ConditionInterface;
use CraftCms\Cms\Database\Table;
use CraftCms\Cms\Element\Conditions\Contracts\ElementConditionRuleInterface;
use CraftCms\Cms\Element\Conditions\Contracts\ElementQueryConditionRuleInterface;
use CraftCms\Cms\Element\Contracts\ElementInterface;
Expand Down Expand Up @@ -62,8 +63,7 @@ protected function options(): array

public function modifyQuery(Builder $query, ElementQueryInterface $elementQuery): void
{
EntryQuery::applyTypeId($query, $this->paramValue(fn ($uid) => EntryTypes::getEntryTypeByUid($uid)->id ?? null));
;
EntryQuery::applyTypeId($query, $this->paramIds(Table::ENTRYTYPES, fn ($uid) => EntryTypes::getEntryTypeByUid($uid)->id ?? null));
Comment thread
riasvdv marked this conversation as resolved.
Resolved
}

public function matchElement(ElementInterface $element): bool
Expand Down
12 changes: 10 additions & 2 deletions src/User/Conditions/AffiliatedSiteConditionRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
use CraftCms\Cms\Element\Conditions\Contracts\ElementQueryConditionRuleInterface;
use CraftCms\Cms\Element\Contracts\ElementInterface;
use CraftCms\Cms\Element\Queries\Contracts\ElementQueryInterface;
use CraftCms\Cms\Element\Queries\UserQuery;
use CraftCms\Cms\Site\Data\Site;
use CraftCms\Cms\Support\Facades\Sites;
use CraftCms\Cms\User\Elements\User;
Expand Down Expand Up @@ -49,7 +48,16 @@ protected function options(): array

public function modifyQuery(Builder $query, ElementQueryInterface $elementQuery): void
{
UserQuery::applyAffiliatedSiteId($query, $this->paramValue(fn ($uid) => Sites::getSiteByUid($uid, true)->id ?? null));
$siteIds = $this->paramValue(fn ($uid) => Sites::getSiteByUid($uid, true)->id ?? null);

if ($siteIds === null) {
return;
}

// Users without an affiliated site aren't affiliated with the excluded sites either.
$query->where(fn (Builder $query) => $query
->whereNumericParam('users.affiliatedSiteId', $siteIds)
->when($this->operator === self::OPERATOR_NOT_IN, fn (Builder $query) => $query->orWhereNull('users.affiliatedSiteId')));
}

public function matchElement(ElementInterface $element): bool
Expand Down
29 changes: 29 additions & 0 deletions tests/Feature/Asset/Conditions/AssetConditionRulesTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,35 @@
expect($query->count())->toBe(1)
->and($query->one()->volumeId)->toBe($volume1->id);
});

it('modifyQuery excludes assets in the selected volumes', function () {
$volume1 = Volume::factory()->create(['fs' => 'test-disk']);
$volume2 = Volume::factory()->create(['fs' => 'test-disk']);
$folder1 = VolumeFolderModel::factory()->create(['volumeId' => $volume1->id]);
$folder2 = VolumeFolderModel::factory()->create(['volumeId' => $volume2->id]);
AssetModel::factory()->create(['volumeId' => $volume1->id, 'folderId' => $folder1->id]);
AssetModel::factory()->create(['volumeId' => $volume2->id, 'folderId' => $folder2->id]);

app()->forgetInstance(Volumes::class);

$condition = new AssetCondition(Asset::class);
$rule = $condition->createConditionRule(VolumeConditionRule::class);
$rule->operator = 'ni';
$rule->values = [$volume1->uid];

$query = Asset::find()->volumeId([$volume1->id, $volume2->id]);
$query->where(fn (Builder $builder) => $rule->modifyQuery($builder, $query));

expect($query->count())->toBe(1)
->and($query->one()->volumeId)->toBe($volume2->id);

$rule->values = app(Volumes::class)->getAllVolumes()->pluck('uid')->all();

$query = Asset::find()->volumeId([$volume1->id, $volume2->id]);
$query->where(fn (Builder $builder) => $rule->modifyQuery($builder, $query));

expect($query->count())->toBe(0);
});
});

describe('WidthConditionRule', function () {
Expand Down
15 changes: 15 additions & 0 deletions tests/Feature/Element/Conditions/ElementConditionRulesTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -581,6 +581,21 @@ function createRelatedEntries(int $count = 3): array

expect($query->count())->toBeGreaterThan(0);
});

it('modifyQuery excludes entries in sites of the selected site groups', function () {
createEntryWithAttributes();
$groupUid = Sites::getPrimarySite()->getGroup()->uid;

[, $rule] = createElementRule(SiteGroupConditionRule::class, [
'operator' => 'ni',
'values' => [$groupUid],
]);

$query = Entry::find();
$query->where(fn (Builder $builder) => $rule->modifyQuery($builder, $query));

expect($query->count())->toBe(0);
});
});

describe('HasDescendantsRule', function () {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,31 @@
['not *filename*', 0],
]);

test('kind', function () {
test('kind', function (mixed $param, int $expectedCount) {
Asset::factory()->create(['kind' => 'image', 'filename' => 'file.jpg']);
Asset::factory()->create(['kind' => 'unknown', 'filename' => 'file.jpg']);
Asset::factory()->create(['kind' => 'audio', 'filename' => 'file.mp3']);
Asset::factory()->create(['kind' => 'unknown', 'filename' => 'file.xyz']);

expect(assetQuery()->count())->toBe(3);
expect(assetQuery()->kind('image')->count())->toBe(2);
expect(assetQuery()->kind($param)->count())->toBe($expectedCount);
})->with([
['image', 2],
['image, audio', 3],
['not image', 2],
[['not', 'image', 'audio'], 1],
['and image, audio', 0],
[['and', 'image'], 2],
]);

test('kind keeps escaped commas in a kind', function () {
Asset::factory()->create(['kind' => 'drawing,cad', 'filename' => 'file.dwg']);

expect(assetQuery()->kind('drawing\,cad')->count())->toBe(1);
});

test('kind matches extensions that several kinds share', function () {
Asset::factory()->create(['kind' => 'unknown', 'filename' => 'file.ogg']);
Asset::factory()->create(['kind' => 'audio', 'filename' => 'file.mp3']);

expect(assetQuery()->kind('and audio, video')->count())->toBe(1);
});
Loading
Loading