namespace Drupal\entity;
-use Drupal\Core\Entity\ContentEntityTypeInterface;
-use Drupal\Core\Entity\EntityHandlerInterface;
-use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
use Drupal\Core\Entity\EntityTypeInterface;
-use Drupal\Core\StringTranslation\StringTranslationTrait;
-use Drupal\user\EntityOwnerInterface;
-use Symfony\Component\DependencyInjection\ContainerInterface;
/**
- * Provides generic entity permissions.
+ * Provides generic entity permissions which are still cacheable.
*
- * Supports both entity_type and bundle granularities.
- * Supports entity ownership (own/any permissions).
+ * This includes:
+ *
+ * - administer $entity_type
+ * - access $entity_type overview
+ * - view $entity_type
+ * - view own unpublished $entity_type
+ * - update (own|any) ($bundle) $entity_type
+ * - delete (own|any) ($bundle) $entity_type
+ * - create $bundle $entity_type
+ *
+ * This class does not support "view own ($bundle) $entity_type", because this
+ * results in caching per user. If you need this use case, please use
+ * \Drupal\entity\UncacheableEntityPermissionProvider instead.
*
* Intended for content entity types, since config entity types usually rely
* on a single "administer" permission.
* @see \Drupal\entity\EntityAccessControlHandler
* @see \Drupal\entity\EntityPermissions
*/
-class EntityPermissionProvider implements EntityPermissionProviderInterface, EntityHandlerInterface {
-
- use StringTranslationTrait;
-
- /**
- * The entity type bundle info.
- *
- * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
- */
- protected $entityTypeBundleInfo;
-
- /**
- * Constructs a new EntityPermissionProvider object.
- *
- * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
- * The entity type bundle info.
- */
- public function __construct(EntityTypeBundleInfoInterface $entity_type_bundle_info) {
- $this->entityTypeBundleInfo = $entity_type_bundle_info;
- }
-
- /**
- * {@inheritdoc}
- */
- public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
- return new static(
- $container->get('entity_type.bundle.info')
- );
- }
+class EntityPermissionProvider extends EntityPermissionProviderBase {
/**
* {@inheritdoc}
*/
public function buildPermissions(EntityTypeInterface $entity_type) {
$entity_type_id = $entity_type->id();
- $has_owner = $entity_type->isSubclassOf(EntityOwnerInterface::class);
- $singular_label = $entity_type->getSingularLabel();
$plural_label = $entity_type->getPluralLabel();
- $permissions = [];
- $permissions["administer {$entity_type_id}"] = [
- 'title' => $this->t('Administer @type', ['@type' => $plural_label]),
- 'restrict access' => TRUE,
- ];
- $permissions["access {$entity_type_id} overview"] = [
- 'title' => $this->t('Access the @type overview page', ['@type' => $plural_label]),
- ];
- // View permissions are the same for both granularities.
- if ($has_owner) {
- $permissions["view any {$entity_type_id}"] = [
- 'title' => $this->t('View any @type', [
- '@type' => $singular_label,
- ]),
- ];
- $permissions["view own {$entity_type_id}"] = [
- 'title' => $this->t('View own @type', [
- '@type' => $plural_label,
- ]),
- ];
- }
- else {
- $permissions["view {$entity_type_id}"] = [
- 'title' => $this->t('View @type', [
- '@type' => $plural_label,
- ]),
- ];
- }
- // Generate the other permissions based on granularity.
- if ($entity_type->getPermissionGranularity() == 'entity_type') {
- $permissions += $this->buildEntityTypePermissions($entity_type);
- }
- else {
- $permissions += $this->buildBundlePermissions($entity_type);
- }
+ $permissions = parent::buildPermissions($entity_type);
- foreach ($permissions as $name => $permission) {
- // Permissions are grouped by provider on admin/people/permissions.
- $permissions[$name]['provider'] = $entity_type->getProvider();
- // TranslatableMarkup objects don't sort properly.
- $permissions[$name]['title'] = (string) $permission['title'];
- }
-
- return $permissions;
- }
-
- /**
- * Builds permissions for the entity_type granularity.
- *
- * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
- * The entity type.
- *
- * @return array
- * The permissions.
- */
- protected function buildEntityTypePermissions(EntityTypeInterface $entity_type) {
- $entity_type_id = $entity_type->id();
- $has_owner = $entity_type->isSubclassOf(EntityOwnerInterface::class);
- $singular_label = $entity_type->getSingularLabel();
- $plural_label = $entity_type->getPluralLabel();
-
- $permissions = [];
- $permissions["create {$entity_type_id}"] = [
- 'title' => $this->t('Create @type', [
+ // View permissions are the same for both granularities.
+ $permissions["view {$entity_type_id}"] = [
+ 'title' => $this->t('View @type', [
'@type' => $plural_label,
]),
];
- if ($has_owner) {
- $permissions["update any {$entity_type_id}"] = [
- 'title' => $this->t('Update any @type', [
- '@type' => $singular_label,
- ]),
- ];
- $permissions["update own {$entity_type_id}"] = [
- 'title' => $this->t('Update own @type', [
- '@type' => $plural_label,
- ]),
- ];
- $permissions["delete any {$entity_type_id}"] = [
- 'title' => $this->t('Delete any @type', [
- '@type' => $singular_label,
- ]),
- ];
- $permissions["delete own {$entity_type_id}"] = [
- 'title' => $this->t('Delete own @type', [
- '@type' => $plural_label,
- ]),
- ];
- }
- else {
- $permissions["update {$entity_type_id}"] = [
- 'title' => $this->t('Update @type', [
- '@type' => $plural_label,
- ]),
- ];
- $permissions["delete {$entity_type_id}"] = [
- 'title' => $this->t('Delete @type', [
- '@type' => $plural_label,
- ]),
- ];
- }
- return $permissions;
+ return $this->processPermissions($permissions, $entity_type);
}
- /**
- * Builds permissions for the bundle granularity.
- *
- * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
- * The entity type.
- *
- * @return array
- * The permissions.
- */
- protected function buildBundlePermissions(EntityTypeInterface $entity_type) {
- $entity_type_id = $entity_type->id();
- $bundles = $this->entityTypeBundleInfo->getBundleInfo($entity_type_id);
- $has_owner = $entity_type->isSubclassOf(EntityOwnerInterface::class);
- $singular_label = $entity_type->getSingularLabel();
- $plural_label = $entity_type->getPluralLabel();
-
- $permissions = [];
- foreach ($bundles as $bundle_name => $bundle_info) {
- $permissions["create {$bundle_name} {$entity_type_id}"] = [
- 'title' => $this->t('@bundle: Create @type', [
- '@bundle' => $bundle_info['label'],
- '@type' => $plural_label,
- ]),
- ];
-
- if ($has_owner) {
- $permissions["update any {$bundle_name} {$entity_type_id}"] = [
- 'title' => $this->t('@bundle: Update any @type', [
- '@bundle' => $bundle_info['label'],
- '@type' => $singular_label,
- ]),
- ];
- $permissions["update own {$bundle_name} {$entity_type_id}"] = [
- 'title' => $this->t('@bundle: Update own @type', [
- '@bundle' => $bundle_info['label'],
- '@type' => $plural_label,
- ]),
- ];
- $permissions["delete any {$bundle_name} {$entity_type_id}"] = [
- 'title' => $this->t('@bundle: Delete any @type', [
- '@bundle' => $bundle_info['label'],
- '@type' => $singular_label,
- ]),
- ];
- $permissions["delete own {$bundle_name} {$entity_type_id}"] = [
- 'title' => $this->t('@bundle: Delete own @type', [
- '@bundle' => $bundle_info['label'],
- '@type' => $plural_label,
- ]),
- ];
- }
- else {
- $permissions["update {$bundle_name} {$entity_type_id}"] = [
- 'title' => $this->t('@bundle: Update @type', [
- '@bundle' => $bundle_info['label'],
- '@type' => $plural_label,
- ]),
- ];
- $permissions["delete {$bundle_name} {$entity_type_id}"] = [
- 'title' => $this->t('@bundle: Delete @type', [
- '@bundle' => $bundle_info['label'],
- '@type' => $plural_label,
- ]),
- ];
- }
- }
-
- return $permissions;
- }
}
projects / yaffs-website / blobdiff