initial commit

kirby/src/Cms/Roles.php

@@ -0,0 +1,147 @@
+<?php
+
+namespace Kirby\Cms;
+
+/**
+ * Extension of the Collection class that
+ * introduces `Roles::factory()` to convert an
+ * array of role definitions into a proper
+ * collection with Role objects. It also has
+ * a `Roles::load()` method that handles loading
+ * role definitions from disk.
+ *
+ * @package   Kirby Cms
+ * @author    Bastian Allgeier <bastian@getkirby.com>
+ * @link      https://getkirby.com
+ * @copyright Bastian Allgeier
+ * @license   https://getkirby.com/license
+ *
+ * @extends \Kirby\Cms\Collection<\Kirby\Cms\Role>
+ */
+class Roles extends Collection
+{
+	/**
+	 * All registered roles methods
+	 */
+	public static array $methods = [];
+
+	/**
+	 * Returns a filtered list of all
+	 * roles that can be changed by the
+	 * current user
+	 *
+	 * Use with `$kirby->roles()`. For retrieving
+	 * which roles are available for a specific user,
+	 * use `$user->roles()` without additional filters.
+	 *
+	 * @return $this|static
+	 * @throws \Exception
+	 */
+	public function canBeChanged(): static
+	{
+		if (App::instance()->user()?->isAdmin() !== true) {
+			return $this->filter(function ($role) {
+				$newUser = new User([
+					'email' => 'test@getkirby.com',
+					'role'  => $role->id()
+				]);
+
+				return $newUser->permissions()->can('changeRole');
+			});
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Returns a filtered list of all
+	 * roles that can be created by the
+	 * current user.
+	 *
+	 * Use with `$kirby->roles()`.
+	 *
+	 * @return $this|static
+	 * @throws \Exception
+	 */
+	public function canBeCreated(): static
+	{
+		if (App::instance()->user()?->isAdmin() !== true) {
+			return $this->filter(function ($role) {
+				$newUser = new User([
+					'email' => 'test@getkirby.com',
+					'role'  => $role->id()
+				]);
+
+				return $newUser->permissions()->can('create');
+			});
+		}
+
+		return $this;
+	}
+
+	public static function factory(array $roles, array $inject = []): static
+	{
+		$collection = new static();
+
+		// read all user blueprints
+		foreach ($roles as $props) {
+			$role = Role::factory($props, $inject);
+			$collection->set($role->id(), $role);
+		}
+
+		// always include the admin role
+		if ($collection->find('admin') === null) {
+			$collection->set('admin', Role::defaultAdmin());
+		}
+
+		// return the collection sorted by name
+		return $collection->sort('name', 'asc');
+	}
+
+	public static function load(string|null $root = null, array $inject = []): static
+	{
+		$kirby = App::instance();
+		$roles = new static();
+
+		// load roles from plugins
+		foreach ($kirby->extensions('blueprints') as $name => $blueprint) {
+			if (str_starts_with($name, 'users/') === false) {
+				continue;
+			}
+
+			// callback option can be return array or blueprint file path
+			if (is_callable($blueprint) === true) {
+				$blueprint = $blueprint($kirby);
+			}
+
+			$role = match (is_array($blueprint)) {
+				true  => Role::factory($blueprint, $inject),
+				false => Role::load($blueprint, $inject)
+			};
+
+			$roles->set($role->id(), $role);
+		}
+
+		// load roles from directory
+		if ($root !== null) {
+			foreach (glob($root . '/*.yml') as $file) {
+				$filename = basename($file);
+
+				if ($filename === 'default.yml') {
+					continue;
+				}
+
+				$role = Role::load($file, $inject);
+				$roles->set($role->id(), $role);
+			}
+		}
+
+		// always include the admin role
+		if ($roles->find('admin') === null) {
+			$roles->set('admin', Role::defaultAdmin($inject));
+		}
+
+		// return the collection sorted by name
+		return $roles->sort('name', 'asc');
+	}
+}