Compare commits

...

5 Commits

Author SHA1 Message Date
Lance Pioch
52e5d676a8 Fix PHPStan type errors for custom permission array shapes 2026-02-07 23:49:42 -05:00
Lance Pioch
efe541fb73 Fix PHPStan errors for permission data array shape 2026-02-07 23:40:03 -05:00
Lance Pioch
b183a75c36 Allow plugins to pass custom labels and descriptions for subuser permissions 2026-02-07 23:20:20 -05:00
Lance Pioch
892490176c Support plugin translation namespaces for custom subuser permissions
Adds a translationPrefix parameter to registerCustomPermissions() so
plugins can specify their own namespaced translation keys instead of
being limited to the panel's server/user.permissions.* keys.
2026-02-07 22:31:02 -05:00
Lance Pioch
f95d9b414a Add translatable subuser permission labels with graceful fallbacks (#2069) 2026-02-06 09:20:30 -05:00
3 changed files with 65 additions and 14 deletions

View File

@@ -77,17 +77,30 @@ class SubuserResource extends Resource
$options = [];
$descriptions = [];
$translationPrefix = $data['translationPrefix'] ?? 'server/user.permissions.';
$customDescriptions = $data['descriptions'] ?? [];
foreach ($data['permissions'] as $permission) {
$options[$permission] = str($permission)->headline();
$descriptions[$permission] = trans('server/user.permissions.' . $data['name'] . '_' . str($permission)->replace('-', '_'));
if (isset($customDescriptions[$permission])) {
$descriptions[$permission] = $customDescriptions[$permission];
} else {
$descKey = $translationPrefix . $data['name'] . '_' . str($permission)->replace('-', '_');
$descriptions[$permission] = trans()->has($descKey) ? trans($descKey) : null;
}
$permissionsArray[$data['name']][] = $permission;
}
$tabLabelKey = $translationPrefix . $data['name'];
$groupDescKey = $translationPrefix . $data['name'] . '_desc';
$tabs[] = Tab::make($data['name'])
->label(str($data['name'])->headline())
->label($data['label'] ?? (trans()->has($tabLabelKey) ? trans($tabLabelKey) : str($data['name'])->headline()))
->schema([
Section::make()
->description(trans('server/user.permissions.' . $data['name'] . '_desc'))
->description($data['description'] ?? (trans()->has($groupDescKey) ? trans($groupDescKey) : null))
->icon($data['icon'])
->contained(false)
->schema([

View File

@@ -33,11 +33,17 @@ class Subuser extends Model implements Validatable
*/
public const RESOURCE_NAME = 'server_subuser';
/** @var array<string, array{name: string, hidden: ?bool, icon: ?string, permissions: string[]}> */
/** @var array<string, array{name: string, hidden?: ?bool, icon?: ?string, permissions: string[], translationPrefix?: string, label?: string, description?: string, descriptions?: array<string, string>}> */
protected static array $customPermissions = [];
/** @param string[] $permissions */
public static function registerCustomPermissions(string $name, array $permissions, ?string $icon = null, ?bool $hidden = null): void
/**
* @param string[] $permissions
* @param ?string $label Custom label for the permission tab (overrides translation lookup)
* @param ?string $description Custom description for the permission group (overrides translation lookup)
* @param ?array<string, string> $descriptions Custom descriptions keyed by permission name (overrides translation lookup)
* @param ?string $translationPrefix Translation prefix for looking up labels/descriptions (e.g. 'my-plugin::permissions.')
*/
public static function registerCustomPermissions(string $name, array $permissions, ?string $icon = null, ?bool $hidden = null, ?string $translationPrefix = null, ?string $label = null, ?string $description = null, ?array $descriptions = null): void
{
$customPermission = static::$customPermissions[$name] ?? [];
@@ -52,6 +58,22 @@ class Subuser extends Model implements Validatable
$customPermission['hidden'] = $hidden;
}
if (!is_null($translationPrefix)) {
$customPermission['translationPrefix'] = $translationPrefix;
}
if (!is_null($label)) {
$customPermission['label'] = $label;
}
if (!is_null($description)) {
$customPermission['description'] = $description;
}
if (!is_null($descriptions)) {
$customPermission['descriptions'] = array_merge($customPermission['descriptions'] ?? [], $descriptions);
}
static::$customPermissions[$name] = $customPermission;
}
@@ -93,7 +115,7 @@ class Subuser extends Model implements Validatable
return $this->belongsTo(User::class);
}
/** @return array<array{name: string, hidden: bool, icon: string, permissions: string[]}> */
/** @return array<array{name: string, hidden: bool, icon: string, permissions: string[], translationPrefix?: ?string, label?: ?string, description?: ?string, descriptions?: array<string, string>}> */
public static function allPermissionData(): array
{
$allPermissions = [];
@@ -106,22 +128,28 @@ class Subuser extends Model implements Validatable
'hidden' => $subuserPermission->isHidden(),
'icon' => $subuserPermission->getIcon(),
'permissions' => array_merge($allPermissions[$group]['permissions'] ?? [], [$permission]),
'translationPrefix' => null,
'label' => null,
'description' => null,
'descriptions' => [],
];
}
foreach (static::$customPermissions as $customPermission) {
$name = $customPermission['name'];
$groupData = $allPermissions[$name] ?? [];
$existing = $allPermissions[$name] ?? null;
$groupData = [
$allPermissions[$name] = [
'name' => $name,
'hidden' => $customPermission['hidden'] ?? $groupData['hidden'] ?? false,
'icon' => $customPermission['icon'] ?? $groupData['icon'],
'permissions' => array_unique(array_merge($groupData['permissions'] ?? [], $customPermission['permissions'])),
'hidden' => $customPermission['hidden'] ?? ($existing !== null ? $existing['hidden'] : false),
'icon' => $customPermission['icon'] ?? ($existing !== null ? $existing['icon'] : null),
'permissions' => array_unique(array_merge($existing !== null ? $existing['permissions'] : [], $customPermission['permissions'])),
'translationPrefix' => ($customPermission['translationPrefix'] ?? null) ?? ($existing !== null ? $existing['translationPrefix'] : null),
'label' => ($customPermission['label'] ?? null) ?? ($existing !== null ? $existing['label'] : null),
'description' => ($customPermission['description'] ?? null) ?? ($existing !== null ? $existing['description'] : null),
'descriptions' => array_merge($existing !== null ? $existing['descriptions'] : [], $customPermission['descriptions'] ?? []),
];
$allPermissions[$name] = $groupData;
}
return array_values($allPermissions);

View File

@@ -17,6 +17,16 @@ return [
'notification_failed' => 'Failed to invite user!',
'permissions' => [
'title' => 'Permissions',
'control' => 'Control',
'user' => 'User',
'file' => 'File',
'backup' => 'Backup',
'schedule' => 'Schedule',
'database' => 'Database',
'allocation' => 'Allocation',
'startup' => 'Startup',
'settings' => 'Settings',
'activity' => 'Activity',
'activity_desc' => 'Permissions that control a user\'s access to the server activity logs.',
'startup_desc' => 'Permissions that control a user\'s ability to view this server\'s startup parameters.',
'settings_desc' => 'Permissions that control a user\'s ability to modify this server\'s settings.',