Add delete service action to OneDrive integration

homeassistant/components/onedrive/icons.json

@@ -22,6 +22,9 @@
     }
   },
   "services": {
+    "delete": {
+      "service": "mdi:cloud-remove"
+    },
     "upload": {
       "service": "mdi:cloud-upload"
     }

homeassistant/components/onedrive/services.py

@@ -4,7 +4,7 @@
 
 import asyncio
 from dataclasses import asdict
-from pathlib import Path
+from pathlib import Path, PurePosixPath
 from typing import cast
 
 from onedrive_personal_sdk.exceptions import OneDriveException
@@ -21,11 +21,12 @@
 from homeassistant.exceptions import HomeAssistantError
 from homeassistant.helpers import config_validation as cv, service
 
-from .const import DOMAIN
+from .const import CONF_DELETE_PERMANENTLY, DOMAIN
 from .coordinator import OneDriveConfigEntry
 
 CONF_CONFIG_ENTRY_ID = "config_entry_id"
 CONF_DESTINATION_FOLDER = "destination_folder"
+CONF_DESTINATION_PATH = "destination_path"
 
 UPLOAD_SERVICE = "upload"
 UPLOAD_SERVICE_SCHEMA = vol.Schema(
@@ -35,6 +36,17 @@
         vol.Required(CONF_DESTINATION_FOLDER): cv.string,
     }
 )
+
+DELETE_SERVICE = "delete"
+DELETE_SERVICE_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_CONFIG_ENTRY_ID): cv.string,
+        vol.Required(CONF_DESTINATION_PATH): vol.All(
+            cv.ensure_list, vol.Length(min=1), [cv.string]
+        ),
+    }
+)
+
 CONTENT_SIZE_LIMIT = 250 * 1024 * 1024
 
 
@@ -78,6 +90,29 @@ def _read_file_contents(
     return results
 
 
+def _raise_invalid_destination_path(destination_path: str) -> None:
+    raise HomeAssistantError(
+        translation_domain=DOMAIN,
+        translation_key="invalid_destination_path",
+        translation_placeholders={"destination_path": destination_path},
+    )
+
+
+def _validate_destination_path(destination_path: str) -> str:
+    """Validate and normalize a remote destination path.
+
+    Returns the normalized path or raises HomeAssistantError.
+    """
+    normalized = destination_path.strip("/")
+    if not normalized:
+        _raise_invalid_destination_path(destination_path)
+    parts = PurePosixPath(normalized).parts
+    for part in parts:
+        if part == ".." or ":" in part:
+            _raise_invalid_destination_path(destination_path)
+    return str(PurePosixPath(normalized))
+
+
 @callback
 def async_setup_services(hass: HomeAssistant) -> None:
     """Register OneDrive services."""
@@ -124,6 +159,50 @@ async def async_handle_upload(call: ServiceCall) -> ServiceResponse:
             return {"files": [asdict(item_result) for item_result in upload_results]}
         return None
 
+    async def async_handle_delete(call: ServiceCall) -> None:
+        """Delete one or more files from OneDrive."""
+        config_entry: OneDriveConfigEntry = service.async_get_config_entry(
+            hass, DOMAIN, call.data[CONF_CONFIG_ENTRY_ID]
+        )
+        client = config_entry.runtime_data.client
+        delete_permanently = config_entry.options.get(CONF_DELETE_PERMANENTLY, False)
+        file_paths = [
+            _validate_destination_path(p)
+            for p in cast(list[str], call.data[CONF_DESTINATION_PATH])
+        ]
+
+        try:
+            approot_id = (await client.get_approot()).id
+        except OneDriveException as err:
+            raise HomeAssistantError(
+                translation_domain=DOMAIN,
+                translation_key="connection_error",
+            ) from err
+
+        results = await asyncio.gather(
+            *[
+                client.delete_drive_item(
+                    f"{approot_id}:/{file_path}:", delete_permanently
+                )
+                for file_path in file_paths
+            ],
+            return_exceptions=True,
+        )
+        failures: list[tuple[str, OneDriveException]] = []
+        for file_path, result in zip(file_paths, results, strict=True):
+            if isinstance(result, OneDriveException):
+                failures.append((file_path, result))
+        if failures:
+            raise HomeAssistantError(
+                translation_domain=DOMAIN,
+                translation_key="delete_error",
+                translation_placeholders={
+                    "paths": ", ".join(f"`{path}`" for path, _ in failures)
+                },
+            ) from ExceptionGroup(
+                "OneDrive delete errors", [err for _, err in failures]
+            )
+
     hass.services.async_register(
         DOMAIN,
         UPLOAD_SERVICE,
@@ -132,3 +211,10 @@ async def async_handle_upload(call: ServiceCall) -> ServiceResponse:
         supports_response=SupportsResponse.OPTIONAL,
         description_placeholders={"example_image_path": "/config/www/image.jpg"},
     )
+
+    hass.services.async_register(
+        DOMAIN,
+        DELETE_SERVICE,
+        async_handle_delete,
+        schema=DELETE_SERVICE_SCHEMA,
+    )

homeassistant/components/onedrive/services.yaml

@@ -14,3 +14,16 @@ upload:
       required: true
       selector:
         text:
+
+delete:
+  fields:
+    config_entry_id:
+      required: true
+      selector:
+        config_entry:
+          integration: onedrive
+    destination_path:
+      required: true
+      selector:
+        text:
+          multiple: true

homeassistant/components/onedrive/strings.json

@@ -90,9 +90,15 @@
     "authentication_failed": {
       "message": "Authentication failed"
     },
+    "connection_error": {
+      "message": "[%key:component::onedrive::config::abort::connection_error%]"
+    },
     "create_folder_error": {
       "message": "Failed to create folder: {message}"
     },
+    "delete_error": {
+      "message": "Failed to delete from OneDrive: {paths}"
+    },
     "failed_to_get_folder": {
       "message": "Failed to get {folder} folder"
     },
@@ -105,6 +111,9 @@
     "filenames_do_not_exist": {
       "message": "The following files do not exist: {filenames}"
     },
+    "invalid_destination_path": {
+      "message": "Invalid destination path `{destination_path}`: must be non-empty, must not contain `:` or `..` path segments"
+    },
     "no_access_to_path": {
       "message": "Cannot read {filename}, no access to path; `allowlist_external_dirs` may need to be adjusted in `configuration.yaml`"
     },
@@ -142,6 +151,21 @@
     }
   },
   "services": {
+    "delete": {
+      "description": "Deletes one or more files from OneDrive.",
+      "fields": {
+        "config_entry_id": {
+          "description": "The config entry representing the OneDrive you want to delete from.",
+          "name": "Config entry ID"
+        },
+        "destination_path": {
+          "description": "One or more paths to files inside the OneDrive app folder (Apps/Home Assistant) to delete.",
+          "example": "[\"photos/snapshots/image.jpg\", \"photos/snapshots/image2.jpg\"]",
+          "name": "Destination paths"
+        }
+      },
+      "name": "Delete files"
+    },
     "upload": {
       "description": "Uploads one or more files to OneDrive.",
       "fields": {
@@ -150,7 +174,7 @@
           "name": "Config entry ID"
         },
         "destination_folder": {
-          "description": "Folder inside the Home Assistant app folder (Apps/Home Assistant) you want to upload the files to. Will be created if it does not exist.",
+          "description": "Folder inside the OneDrive app folder (Apps/Home Assistant) you want to upload the files to. Will be created if it does not exist.",
           "example": "photos/snapshots",
           "name": "Destination folder"
         },