Issue #3299866 by Masami, Ryo Yamashita, yas: Add the function to delete... (85525db8) · Commits · project / cloud

modules/cloud_dashboard/cloud_dashboard/src/constant/form_template/openstack/volume.ts

+12 −0

Changes for modules/cloud_dashboard/cloud_dashboard/src/constant/form_template/openstack/volume.ts: 12 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		@@ -28,6 +28,18 @@ const OPENSTACK_VOLUME_TEMPLATE: EntityFormTemplate[] = [
		}
		]
		},
		{
		cloudServiceProvider: 'openstack',
		entityName: 'volume',
		actionType: 'delete',
		entityRecords: [
		{
		type: 'label',
		text: 'Are you sure you want to delete the {{entityName}} {{name}}?'
		},
		],
		submitButtonLabel: 'Delete'
		},
		]

		export default OPENSTACK_VOLUME_TEMPLATE;

modules/cloud_service_providers/openstack/openstack.routing.yml

+15 −0

Changes for modules/cloud_service_providers/openstack/openstack.routing.yml: 15 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		@@ -875,6 +875,7 @@ entity.openstack_snapshot.edit:
		_custom_access: '\Drupal\cloud\Controller\CloudConfigController::access'
		options:
		perm: 'edit any openstack snapshot+edit own openstack snapshot'

		entity.openstack_volume.create:
		path: '/cloud_dashboard/openstack/{cloud_context}/openstack_volume/create'
		defaults:
		@@ -922,3 +923,17 @@ entity.openstack_volume.availability_zones:
		_custom_access: '\Drupal\cloud\Controller\CloudConfigController::access'
		options:
		perm: 'add openstack volume'

		entity.openstack_volume.delete:
		path: '/cloud_dashboard/openstack/{cloud_context}/openstack_volume/{entity_id}/delete'
		defaults:
		_controller: '\Drupal\openstack\Controller\ApiController::operateEntity'
		entity_type_id: openstack_volume
		command: delete
		methods: [POST]
		requirements:
		# Use custom access that will check for cloud_context and the desired permission.
		# Desired permission is passed as an option in the "perm" variable
		_custom_access: '\Drupal\cloud\Controller\CloudConfigController::access'
		options:
		perm: 'delete any openstack volume+delete own openstack volume'

modules/cloud_service_providers/openstack/src/Controller/ApiController.php

+4 −0

Changes for modules/cloud_service_providers/openstack/src/Controller/ApiController.php: 4 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		@@ -715,6 +715,10 @@ class ApiController extends ControllerBase implements ApiControllerInterface {
		$method_name = 'createOpenStackVolume';
		break;

		case 'delete_openstack_volume':
		$method_name = 'deleteOpenStackVolume';
		break;

		}

		// Execute the process.

modules/cloud_service_providers/openstack/src/Form/OpenStackVolumeDeleteForm.php

+16 −6

Changes for modules/cloud_service_providers/openstack/src/Form/OpenStackVolumeDeleteForm.php: 16 added lines, 6 removed lines.
Original line number	Diff line number	Diff line
		@@ -14,6 +14,7 @@ use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
		use Drupal\Core\Entity\EntityTypeManager;
		use Drupal\Core\Messenger\Messenger;
		use Drupal\Core\Plugin\CachedDiscoveryClearerInterface;
		use Drupal\openstack\Service\OpenStackOperationsServiceInterface;
		use Drupal\openstack\Service\OpenStackServiceFactoryInterface;
		use Symfony\Component\DependencyInjection\ContainerInterface;

		@@ -31,6 +32,13 @@ class OpenStackVolumeDeleteForm extends VolumeDeleteForm {
		*/
		protected $openStackServiceFactory;

		/**
		* The OpenStack operations Service.
		*
		* @var \Drupal\openstack\Service\OpenStackOperationsServiceInterface
		*/
		protected $openStackOperationsService;

		/**
		* OpenStackVolumeDeleteForm constructor.
		*
		@@ -56,6 +64,8 @@ class OpenStackVolumeDeleteForm extends VolumeDeleteForm {
		* The entity link render service.
		* @param \Drupal\cloud\Plugin\cloud\config\CloudConfigPluginManagerInterface $cloud_config_plugin_manager
		* The cloud service provider plugin manager (CloudConfigPluginManager).
		* @param \Drupal\openstack\Service\OpenStackOperationsServiceInterface $openstack_operations_service
		* The OpenStack Operations service.
		*/
		public function __construct(OpenStackServiceFactoryInterface $openstack_service_factory,
		Ec2ServiceInterface $ec2_service,
		@@ -67,7 +77,8 @@ class OpenStackVolumeDeleteForm extends VolumeDeleteForm {
		CacheBackendInterface $cacheRender,
		CachedDiscoveryClearerInterface $plugin_cache_clearer,
		EntityLinkRendererInterface $entity_link_renderer,
		CloudConfigPluginManagerInterface $cloud_config_plugin_manager) {
		CloudConfigPluginManagerInterface $cloud_config_plugin_manager,
		OpenStackOperationsServiceInterface $openstack_operations_service) {
		parent::__construct(
		$ec2_service,
		$entity_repository,
		@@ -81,6 +92,7 @@ class OpenStackVolumeDeleteForm extends VolumeDeleteForm {
		$cloud_config_plugin_manager
		);
		$this->openStackServiceFactory = $openstack_service_factory;
		$this->openStackOperationsService = $openstack_operations_service;
		}

		/**
		@@ -104,7 +116,8 @@ class OpenStackVolumeDeleteForm extends VolumeDeleteForm {
		$container->get('cache.render'),
		$container->get('plugin.cache_clearer'),
		$container->get('entity.link_renderer'),
		$container->get('plugin.manager.cloud_config_plugin')
		$container->get('plugin.manager.cloud_config_plugin'),
		$container->get('openstack.operations')
		);
		}

		@@ -117,10 +130,7 @@ class OpenStackVolumeDeleteForm extends VolumeDeleteForm {
		* The current form state.
		*/
		public function submitForm(array &$form, FormStateInterface $form_state): void {
		$entity = $this->entity;
		// Switch OpenStack EC2 or REST service based on $entity->getCloudContext().
		$this->ec2Service = $this->openStackServiceFactory->get($entity->getCloudContext());
		parent::submitForm($form, $form_state);
		$this->openStackOperationsService->deleteOpenStackVolume($this->entity, $form, $form_state);
		}

		}

modules/cloud_service_providers/openstack/src/Service/OpenStackOperationsService.php

+57 −0

Changes for modules/cloud_service_providers/openstack/src/Service/OpenStackOperationsService.php: 57 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		@@ -2220,6 +2220,63 @@ class OpenStackOperationsService implements OpenStackOperationsServiceInterface
		return TRUE;
		}

		/**
		* {@inheritdoc}
		*/
		public function deleteOpenStackVolume(VolumeInterface $entity, array &$form, FormStateInterface $form_state): bool {
		/** @var \Drupal\aws_cloud\Entity\Ec2\VolumeInterface $entity */
		$this->entity = $entity;

		$this->ec2Service = $this->openStackServiceFactory->get($entity->getCloudContext());
		$this->awsCloudOperationsService->setEc2Service($this->ec2Service);
		return $this->deleteVolume($form, $form_state);
		}

		/**
		* Delete a volume.
		*
		* @param array $form
		* An associative array containing the structure of the form.
		* @param \Drupal\Core\Form\FormStateInterface $form_state
		* The current state of the form.
		*
		* @throws \Drupal\Core\Entity\EntityStorageException
		* @throws \Drupal\Core\Entity\EntityMalformedException
		*/
		private function deleteVolume(array &$form, FormStateInterface $form_state): bool {
		$entity = $this->entity;
		$this->ec2Service->setCloudContext($entity->getCloudContext());

		$form_state->setRedirect("view.{$entity->getEntityTypeId()}.list", ['cloud_context' => $entity->getCloudContext()]);

		$result = $this->ec2Service->deleteVolume([
		'VolumeId' => $entity->getVolumeId(),
		]);

		// If $result is NULL, some error should have occurred
		// when calling the AWS API.
		if ($result === NULL) {
		$this->processOperationErrorStatus($entity, 'deleted');
		return FALSE;
		}

		if (!empty($result['SendToWorker'])) {
		$this->messenger->addStatus($this->t('The @type @label has been deleted remotely.', [
		'@type' => $entity->getEntityType()->getSingularLabel(),
		'@label' => $entity->getName(),
		]));
		return TRUE;
		}

		$entity->delete();

		$this->messenger->addStatus($this->getDeletionMessage());
		$this->logDeletionMessage();
		$this->clearCacheValues($entity->getCacheTags());
		$this->dispatchSubmitEvent($entity);
		return TRUE;
		}

		/**
		* Helper method to load instance by ID.
		*