Add mastodon.update_profile action to Mastodon integration (#167444)

Author: tr4nt0r

homeassistant/components/mastodon/const.py

@@ -23,3 +23,16 @@
 ATTR_LANGUAGE = "language"
 ATTR_DURATION = "duration"
 ATTR_HIDE_NOTIFICATIONS = "hide_notifications"
+
+ATTR_DISPLAY_NAME = "display_name"
+ATTR_NOTE = "note"
+ATTR_AVATAR = "avatar"
+ATTR_AVATAR_MIME_TYPE = "avatar_mime_type"
+ATTR_HEADER = "header"
+ATTR_HEADER_MIME_TYPE = "header_mime_type"
+ATTR_LOCKED = "locked"
+ATTR_BOT = "bot"
+ATTR_DISCOVERABLE = "discoverable"
+ATTR_FIELDS = "fields"
+ATTR_ATTRIBUTION_DOMAINS = "attribution_domains"
+ATTR_VALUE = "value"

homeassistant/components/mastodon/icons.json

@@ -43,6 +43,9 @@
     },
     "unmute_account": {
       "service": "mdi:account-voice"
+    },
+    "update_profile": {
+      "service": "mdi:account-edit"
     }
   }
 }

homeassistant/components/mastodon/services.py

@@ -4,18 +4,22 @@
 from enum import StrEnum
 from functools import partial
 from math import isfinite
+from pathlib import Path
 from typing import Any
 
 from mastodon import Mastodon
 from mastodon.Mastodon import (
     Account,
     MastodonAPIError,
     MastodonNotFoundError,
+    MastodonUnauthorizedError,
     MediaAttachment,
 )
 import voluptuous as vol
 
-from homeassistant.const import ATTR_CONFIG_ENTRY_ID
+from homeassistant.components import camera, image
+from homeassistant.components.media_source import async_resolve_media
+from homeassistant.const import ATTR_CONFIG_ENTRY_ID, ATTR_NAME
 from homeassistant.core import (
     HomeAssistant,
     ServiceCall,
@@ -25,20 +29,34 @@
 )
 from homeassistant.exceptions import HomeAssistantError, ServiceValidationError
 from homeassistant.helpers import config_validation as cv, service
+from homeassistant.helpers.selector import MediaSelector
 
 from .const import (
     ATTR_ACCOUNT_NAME,
+    ATTR_ATTRIBUTION_DOMAINS,
+    ATTR_AVATAR,
+    ATTR_AVATAR_MIME_TYPE,
+    ATTR_BOT,
     ATTR_CONTENT_WARNING,
+    ATTR_DISCOVERABLE,
+    ATTR_DISPLAY_NAME,
     ATTR_DURATION,
+    ATTR_FIELDS,
+    ATTR_HEADER,
+    ATTR_HEADER_MIME_TYPE,
     ATTR_HIDE_NOTIFICATIONS,
     ATTR_IDEMPOTENCY_KEY,
     ATTR_LANGUAGE,
+    ATTR_LOCKED,
     ATTR_MEDIA,
     ATTR_MEDIA_DESCRIPTION,
     ATTR_MEDIA_WARNING,
+    ATTR_NOTE,
     ATTR_STATUS,
+    ATTR_VALUE,
     ATTR_VISIBILITY,
     DOMAIN,
+    LOGGER,
 )
 from .coordinator import MastodonConfigEntry
 from .utils import get_media_type
@@ -98,6 +116,24 @@ class StatusVisibility(StrEnum):
     }
 )
 
+SERVICE_UPDATE_PROFILE = "update_profile"
+SERVICE_UPDATE_PROFILE_SCHEMA = vol.Schema(
+    {
+        vol.Required(ATTR_CONFIG_ENTRY_ID): str,
+        vol.Optional(ATTR_DISPLAY_NAME): str,
+        vol.Optional(ATTR_NOTE): str,
+        vol.Optional(ATTR_AVATAR): MediaSelector({"accept": ["image/*"]}),
+        vol.Optional(ATTR_HEADER): MediaSelector({"accept": ["image/*"]}),
+        vol.Optional(ATTR_LOCKED): bool,
+        vol.Optional(ATTR_BOT): bool,
+        vol.Optional(ATTR_DISCOVERABLE): bool,
+        vol.Optional(ATTR_FIELDS): vol.All(
+            cv.ensure_list, vol.Length(max=4), [dict[str, str]]
+        ),
+        vol.Optional(ATTR_ATTRIBUTION_DOMAINS): vol.All(cv.ensure_list, [str]),
+    }
+)
+
 
 @callback
 def async_setup_services(hass: HomeAssistant) -> None:
@@ -124,6 +160,13 @@ def async_setup_services(hass: HomeAssistant) -> None:
     hass.services.async_register(
         DOMAIN, SERVICE_POST, _async_post, schema=SERVICE_POST_SCHEMA
     )
+    hass.services.async_register(
+        DOMAIN,
+        SERVICE_UPDATE_PROFILE,
+        _async_update_profile,
+        schema=SERVICE_UPDATE_PROFILE_SCHEMA,
+        supports_response=SupportsResponse.ONLY,
+    )
 
 
 async def _async_account_lookup(
@@ -319,3 +362,71 @@ def _post(hass: HomeAssistant, client: Mastodon, **kwargs: Any) -> None:
             translation_domain=DOMAIN,
             translation_key="unable_to_send_message",
         ) from err
+
+
+async def _async_update_profile(call: ServiceCall) -> ServiceResponse:
+    """Update profile information."""
+    params = dict(call.data.copy())
+
+    entry: MastodonConfigEntry = service.async_get_config_entry(
+        call.hass, DOMAIN, params.pop(ATTR_CONFIG_ENTRY_ID)
+    )
+    client = entry.runtime_data.client
+
+    if avatar := params.pop(ATTR_AVATAR, None):
+        params[ATTR_AVATAR], params[ATTR_AVATAR_MIME_TYPE] = await _resolve_media(
+            call.hass, avatar
+        )
+    if header := params.pop(ATTR_HEADER, None):
+        params[ATTR_HEADER], params[ATTR_HEADER_MIME_TYPE] = await _resolve_media(
+            call.hass, header
+        )
+    if fields := params.get(ATTR_FIELDS):
+        params[ATTR_FIELDS] = [
+            (field[ATTR_NAME].strip(), field[ATTR_VALUE].strip())
+            for field in fields
+            if field[ATTR_NAME].strip()
+        ]
+    try:
+        return await call.hass.async_add_executor_job(
+            lambda: client.account_update_credentials(**params)
+        )
+    except MastodonUnauthorizedError as error:
+        entry.async_start_reauth(call.hass)
+        raise HomeAssistantError(
+            translation_domain=DOMAIN,
+            translation_key="auth_failed",
+        ) from error
+    except MastodonAPIError as err:
+        LOGGER.debug("Full exception:", exc_info=err)
+        raise HomeAssistantError(
+            translation_domain=DOMAIN,
+            translation_key="unable_to_update_profile",
+        ) from err
+
+
+async def _resolve_media(
+    hass: HomeAssistant, media_source: dict[str, str]
+) -> tuple[bytes | Path, str | None]:
+    """Resolve media from a media source."""
+    media_content_id: str = media_source["media_content_id"]
+    if media_content_id.startswith("media-source://camera/"):
+        entity_id = media_content_id.removeprefix("media-source://camera/")
+        snapshot = await camera.async_get_image(hass, entity_id)
+        return snapshot.content, snapshot.content_type
+
+    if media_content_id.startswith("media-source://image/"):
+        entity_id = media_content_id.removeprefix("media-source://image/")
+        img = await image.async_get_image(hass, entity_id)
+        return img.content, img.content_type
+
+    media = await async_resolve_media(hass, media_source["media_content_id"], None)
+
+    if media.path is None:
+        raise ServiceValidationError(
+            translation_domain=DOMAIN,
+            translation_key="media_source_not_supported",
+            translation_placeholders={"media_content_id": media_content_id},
+        )
+
+    return media.path, media.mime_type

homeassistant/components/mastodon/services.yaml

@@ -1,6 +1,6 @@
 get_account:
   fields:
-    config_entry_id:
+    config_entry_id: &config_entry_id
       required: true
       selector:
         config_entry:
@@ -11,11 +11,7 @@ get_account:
         text:
 mute_account:
   fields:
-    config_entry_id:
-      required: true
-      selector:
-        config_entry:
-          integration: mastodon
+    config_entry_id: *config_entry_id
     account_name:
       required: true
       selector:
@@ -32,22 +28,14 @@ mute_account:
         boolean:
 unmute_account:
   fields:
-    config_entry_id:
-      required: true
-      selector:
-        config_entry:
-          integration: mastodon
+    config_entry_id: *config_entry_id
     account_name:
       required: true
       selector:
         text:
 post:
   fields:
-    config_entry_id:
-      required: true
-      selector:
-        config_entry:
-          integration: mastodon
+    config_entry_id: *config_entry_id
     status:
       required: true
       selector:
@@ -282,3 +270,55 @@ post:
       required: true
       selector:
         boolean:
+update_profile:
+  fields:
+    config_entry_id: *config_entry_id
+    display_name:
+      selector:
+        text:
+    note:
+      selector:
+        text:
+          multiline: true
+    avatar:
+      required: false
+      selector:
+        media:
+          accept:
+            - "image/*"
+    header:
+      required: false
+      selector:
+        media:
+          accept:
+            - "image/*"
+    locked:
+      selector:
+        boolean:
+    bot:
+      selector:
+        boolean:
+    discoverable:
+      selector:
+        boolean:
+    fields:
+      selector:
+        object:
+          label_field: "value"
+          description_field: "name"
+          multiple: true
+          translation_key: fields
+          fields:
+            name:
+              required: true
+              selector:
+                text:
+            value:
+              required: true
+              selector:
+                text:
+    attribution_domains:
+      selector:
+        text:
+          multiple: true
+          type: url

homeassistant/components/mastodon/strings.json

@@ -104,6 +104,9 @@
     "idempotency_key_too_short": {
       "message": "Idempotency key must be at least 4 characters long."
     },
+    "media_source_not_supported": {
+      "message": "Media source {media_content_id} is not supported."
+    },
     "mute_duration_too_long": {
       "message": "Mute duration is too long."
     },
@@ -122,11 +125,26 @@
     "unable_to_unmute_account": {
       "message": "Unable to unmute account \"{account_name}\""
     },
+    "unable_to_update_profile": {
+      "message": "Unable to update profile."
+    },
     "unable_to_upload_image": {
       "message": "Unable to upload image {media_path}."
     }
   },
   "selector": {
+    "fields": {
+      "fields": {
+        "name": {
+          "description": "The label for this field.",
+          "name": "Label"
+        },
+        "value": {
+          "description": "The value for this field.",
+          "name": "Value"
+        }
+      }
+    },
     "post_visibility": {
       "options": {
         "direct": "Direct - Mentioned accounts only",
@@ -228,6 +246,52 @@
         }
       },
       "name": "Unmute account"
+    },
+    "update_profile": {
+      "description": "Updates your Mastodon profile information and pictures.",
+      "fields": {
+        "attribution_domains": {
+          "description": "Websites allowed to credit you. Protects from false attributions. Note that setting attribution domains will replace all existing attribution domains, not just the ones specified here.",
+          "name": "Attribution domains"
+        },
+        "avatar": {
+          "description": "An image to set as your profile picture. WEBP, PNG, or JPG. At most 8 MB. Will be downscaled to 400x400px.",
+          "name": "Profile picture"
+        },
+        "bot": {
+          "description": "Signal to others that the account mainly performs automated actions.",
+          "name": "Automated account"
+        },
+        "config_entry_id": {
+          "description": "Select the Mastodon account to update the profile of.",
+          "name": "[%key:component::mastodon::services::post::fields::config_entry_id::name%]"
+        },
+        "discoverable": {
+          "description": "Whether your profile should be discoverable. Public posts and the profile may be featured or recommended across Mastodon.",
+          "name": "Discoverable"
+        },
+        "display_name": {
+          "description": "The display name to set on your profile.",
+          "name": "Display name"
+        },
+        "fields": {
+          "description": "Additional profile fields as key-value pairs. Your homepage, pronouns, age, anything you want. Note that updating fields will replace all existing fields, not just the ones specified here.",
+          "name": "Extra fields"
+        },
+        "header": {
+          "description": "An image to set as your profile header. WEBP, PNG, or JPG. At most 8 MB. Will be downscaled to 1500x500px.",
+          "name": "Header picture"
+        },
+        "locked": {
+          "description": "Whether to lock your profile. A locked profile requires you to approve followers and hides your posts from non-followers.",
+          "name": "Lock profile"
+        },
+        "note": {
+          "description": "The bio to set on your profile. You can @mention other people or #hashtags.",
+          "name": "Bio"
+        }
+      },
+      "name": "Update profile"
     }
   }
 }