"""Client library for talking to Google APIs. This is the primary class to use when talking to Google. This library defines the API service `GoogleCalendarService` as well as the request and response messages for things like listing the available calendars, or events on a calendar. This library also contains apis for local storage of calendars an events in `CalendarListStoreService` and `CalendarEventStoreService`. See the `sync` library for more details on how to async down calendars and events to local storage. All of the request and response messages here use [pydantic](https://pydantic-docs.helpmanual.io/) for parsing and validation of the constraints of the API. The API fields in the request and response methods are mirroring the Google Calendar API methods, so see the [reference](https://developers.google.com/calendar/api/v3/reference) for details. """ from __future__ import annotations import asyncio import datetime import enum import json import logging from collections.abc import AsyncIterator, Awaitable, Callable from typing import Any, List, Optional, Self, TypeVar, Union, cast from urllib.request import pathname2url from pydantic import ConfigDict, Field, field_validator, model_validator from .auth import AbstractAuth from .const import ITEMS from .model import ( EVENT_FIELDS, CalendarBaseModel, Calendar, CalendarBasic, Event, EventStatusEnum, SyntheticEventId, ) from .store import CalendarStore from .timeline import Timeline, calendar_timeline __all__ = [ "GoogleCalendarService", "CalendarListStoreService", "CalendarEventStoreService", "CalendarListRequest", "CalendarListResponse", "ListEventsRequest", "SyncEventsRequest", "ListEventsResponse", "LocalCalendarListResponse", "LocalListEventsRequest", "LocalListEventsResponse", "Boolean", "Range", ] _LOGGER = logging.getLogger(__name__) EVENT_PAGE_SIZE = 1000 # pylint: disable=line-too-long EVENT_API_FIELDS = f"kind,nextPageToken,nextSyncToken,items({EVENT_FIELDS})" CALENDAR_ID = "calendarId" CALENDAR_LIST_URL = "users/me/calendarList" CALENDAR_GET_URL = "calendars/{calendar_id}" CALENDAR_EVENTS_URL = "calendars/{calendar_id}/events" CALENDAR_EVENT_ID_URL = "calendars/{calendar_id}/events/{event_id}" INSTANCES_URL = "calendars/{calendar_id}/events/{event_id}/instances" class SyncableRequest(CalendarBaseModel): """Base class for a request that supports sync.""" page_token: Optional[str] = Field(default=None, alias="pageToken") """Token specifying which result page to return.""" sync_token: Optional[str] = Field(default=None, alias="syncToken") """Token obtained from the last page of results of a previous request.""" class SyncableResponse(CalendarBaseModel): """Base class for an API response that supports sync.""" page_token: Optional[str] = Field(default=None, alias="nextPageToken") """Token used to access the next page of this results.""" sync_token: Optional[str] = Field(default=None, alias="nextSyncToken") """Token used at a later point in time to retrieve entries changed.""" class CalendarListRequest(SyncableRequest): """Api request to return a list of calendars.""" class CalendarListResponse(SyncableResponse): """Api response containing a list of calendars.""" items: List[Calendar] = [] """The calendars on the user's calendar list.""" def now() -> datetime.datetime: """Helper method to facilitate mocking in tests.""" return datetime.datetime.now(datetime.timezone.utc) _RequestT = TypeVar( "_RequestT", bound="Union[ListEventsRequest, _RawListEventsRequest, LocalListEventsRequest]" ) def _validate_datetime(self: _RequestT, key: str) -> _RequestT: """Validate date/datetime request fields are set properly.""" if time := self.__dict__.get(key): self.__dict__[key] = time.replace(microsecond=0) return self def _validate_datetimes(self: _RequestT) -> _RequestT: """Validate the date or datetime fields are set properly.""" self = _validate_datetime(self, "start_time") self = _validate_datetime(self, "end_time") return self class ListEventsRequest(SyncableRequest): """Api request to list events.""" calendar_id: str = Field(alias="calendarId") """Calendar identifier.""" start_time: Optional[datetime.datetime] = Field( default=None, alias="timeMin", validate_default=True ) """Lower bound (exclusive) for an event's end time to filter by.""" end_time: Optional[datetime.datetime] = Field(default=None, alias="timeMax") """Upper bound (exclusive) for an event's start time to filter by.""" search: Optional[str] = Field(default=None, alias="q") """Free text search terms to find events that match these terms This matches the summary, description, location, attendee's displayName, attendee's email. """ def to_request(self) -> _RawListEventsRequest: """Convert to the raw API request for sending to the API.""" return _RawListEventsRequest( **json.loads(self.model_dump_json(exclude_none=True, by_alias=True)), single_events=Boolean.TRUE, order_by=OrderBy.START_TIME, ) @field_validator("start_time") @classmethod def _default_start_time(cls, value: datetime.datetime | None) -> datetime.datetime: """Select a default start time value of not specified.""" if value is None: return now() return value @model_validator(mode="after") def _check_datetime(self) -> Self: """Validate the date or datetime fields are set properly.""" return _validate_datetimes(self) model_config = ConfigDict(populate_by_name=True) class SyncEventsRequest(ListEventsRequest): """Api request to list events when used in the context of sync. This differs from a normal ListEventsRequest in that it handles differences between initial sync and follow up syncs with a sync token (which has fewer fields allowed). This also does not expand recurring events into single events since the local event store handles this. """ def to_request(self) -> _RawListEventsRequest: """Disables default value behavior.""" return _RawListEventsRequest( **json.loads(self.model_dump_json(exclude_none=True, by_alias=True)) ) @field_validator("start_time") @classmethod def _default_start_time( # type: ignore[override] cls, value: datetime.datetime | None ) -> datetime.datetime | None: """Disables default value behavior.""" return value class OrderBy(str, enum.Enum): """Represents the order of events returned.""" START_TIME = "startTime" """Order events by start time.""" UPDATED = "updated" """Order by event update time.""" class Boolean(str, enum.Enum): "Hack to support custom json encoding in pydantic." "" TRUE = "true" FALSE = "false" class _RawListEventsRequest(CalendarBaseModel): """Api request to list events. This is used internally to have separate validation between list event requests and sync requests. """ calendar_id: str = Field(alias="calendarId") max_results: int = Field(default=EVENT_PAGE_SIZE, alias="maxResults") single_events: Optional[Boolean] = Field(default=None, alias="singleEvents") order_by: Optional[OrderBy] = Field(default=None, alias="orderBy") fields: str = Field(default=EVENT_API_FIELDS) page_token: Optional[str] = Field(default=None, alias="pageToken") sync_token: Optional[str] = Field(default=None, alias="syncToken") start_time: Optional[datetime.datetime] = Field(default=None, alias="timeMin") end_time: Optional[datetime.datetime] = Field(default=None, alias="timeMax") search: Optional[str] = Field(default=None, alias="q") def as_dict(self) -> dict[str, Any]: """Return the object as a json dict.""" return cast( dict[str, Any], json.loads( self.model_dump_json( exclude_none=True, by_alias=True, exclude={"calendar_id"} ) ), ) @model_validator(mode="after") def check_datetime(self) -> Self: """Validate the date or datetime fields are set properly.""" return _validate_datetimes(self) @model_validator(mode="after") def check_sync_token_fields(self) -> Self: """Validate the set of fields present when using a sync token.""" if not self.sync_token: return self if ( self.order_by or self.search or self.start_time or self.end_time ): raise ValueError( f"Specified request params not compatible with sync_token: {self}" ) return self model_config = ConfigDict(populate_by_name=True) class _ListEventsResponseModel(SyncableResponse): """Api response containing a list of events.""" items: List[Event] = [] @model_validator(mode="before") @classmethod def _propagate_calendar_id(cls, values: dict[str, Any]) -> dict[str, Any]: """Propagate the calendar id attribute down to the events in the response. This is used so that we can access the "calendar_id" attribute on the event to make other parsing decisions. """ if not (calendar_id := values.get("private_calendar_id")): return values for item in values.get("items", []): item["private_calendar_id"] = calendar_id return values class ListEventsResponse: """Api response containing a list of events.""" def __init__( self, model: _ListEventsResponseModel, get_next_page: ( Callable[[str | None], Awaitable[_ListEventsResponseModel]] | None ) = None, ) -> None: """initialize ListEventsResponse.""" self._model = model self._get_next_page = get_next_page @property def items(self) -> list[Event]: """Return the calendar event items in the response.""" return self._model.items @property def sync_token(self) -> str | None: """Return the sync token in the response.""" return self._model.sync_token @property def page_token(self) -> str | None: """Return the page token in the response.""" return self._model.page_token async def __aiter__(self) -> AsyncIterator[ListEventsResponse]: """Async iterator to traverse through pages of responses.""" response = self while response is not None: yield response if not response.page_token or not self._get_next_page: break page_result = await self._get_next_page(response.page_token) response = ListEventsResponse(page_result) class GoogleCalendarService: """Calendar service interface to Google. The `GoogleCalendarService` is the primary API service for this library. It supports operations like listing calendars, or events. """ def __init__( self, auth: AbstractAuth, ) -> None: """Init the Google Calendar service.""" self._auth = auth async def async_list_calendars( self, request: CalendarListRequest | None = None ) -> CalendarListResponse: """Return the list of calendars the user has added to their list.""" params = {} if request: params = json.loads(request.model_dump_json(exclude_none=True, by_alias=True)) result = await self._auth.get_json(CALENDAR_LIST_URL, params=params) return CalendarListResponse(**result) async def async_get_calendar(self, calendar_id: str) -> CalendarBasic: """Return the calendar with the specified id.""" result = await self._auth.get_json( CALENDAR_GET_URL.format(calendar_id=calendar_id) ) return CalendarBasic(**result) async def async_get_event(self, calendar_id: str, event_id: str) -> Event: """Return an event based on the event id.""" result = await self._auth.get_json( CALENDAR_EVENT_ID_URL.format( calendar_id=pathname2url(calendar_id), event_id=pathname2url(event_id) ) ) event = Event(**result, private_calendar_id=calendar_id) return event async def async_list_events( self, request: ListEventsRequest, ) -> ListEventsResponse: """Return the list of events.""" async def get_next_page(page_token: str | None) -> _ListEventsResponseModel: if page_token is not None: request.page_token = page_token return await self.async_list_events_page(request) page_result = await get_next_page(None) result = ListEventsResponse(page_result, get_next_page) return result async def async_list_events_page( self, request: ListEventsRequest, ) -> _ListEventsResponseModel: """Return the list of events. This is primarily intended to be an internal method used to page through events using the async generator provided by `async_list_events`. """ params = request.to_request().as_dict() result = await self._auth.get_json( CALENDAR_EVENTS_URL.format(calendar_id=pathname2url(request.calendar_id)), params=params, ) _ListEventsResponseModel.model_rebuild() response = _ListEventsResponseModel( **result, private_calendar_id=request.calendar_id ) return response async def async_create_event( self, calendar_id: str, event: Event, ) -> None: """Create an event on the specified calendar.""" body = json.loads(event.model_dump_json(exclude_unset=True, by_alias=True)) await self._auth.post( CALENDAR_EVENTS_URL.format(calendar_id=pathname2url(calendar_id)), json=body, ) async def async_patch_event( self, calendar_id: str, event_id: str, body: dict[str, Any], ) -> None: """Updates an event using patch semantics, with raw API data.""" await self._auth.request( "patch", CALENDAR_EVENT_ID_URL.format( calendar_id=pathname2url(calendar_id), event_id=pathname2url(event_id) ), json=body, ) async def async_delete_event( self, calendar_id: str, event_id: str, ) -> None: """Delete an event on the specified calendar.""" await self._auth.request( "delete", CALENDAR_EVENT_ID_URL.format( calendar_id=pathname2url(calendar_id), event_id=pathname2url(event_id) ), ) class LocalCalendarListResponse(CalendarBaseModel): """Api response containing a list of calendars.""" calendars: List[Calendar] = [] """The list of calendars.""" class LocalListEventsRequest(CalendarBaseModel): """Api request to list events from the local event store.""" start_time: datetime.datetime = Field(default_factory=now) """Lower bound (exclusive) for an event's end time to filter by.""" end_time: Optional[datetime.datetime] = Field(default=None) """Upper bound (exclusive) for an event's start time to filter by.""" @model_validator(mode="after") def check_datetime(self) -> Self: """Validate the date or datetime fields are set properly.""" return _validate_datetimes(self) model_config = ConfigDict(populate_by_name=True) class LocalListEventsResponse(CalendarBaseModel): """Api response containing a list of events.""" events: List[Event] = Field(default_factory=list) """Events returned from the local store.""" class CalendarListStoreService: """Performs calendar list lookups from the local store.""" def __init__(self, store: CalendarStore) -> None: """Initialize CalendarEventStoreService.""" self._store = store async def async_list_calendars( self, ) -> LocalCalendarListResponse: """Return the set of events matching the criteria.""" store_data = await self._store.async_load() or {} store_data.setdefault(ITEMS, {}) items = store_data.get(ITEMS, {}) return LocalCalendarListResponse( calendars=[Calendar(**item) for item in items.values()] ) class Range(str, enum.Enum): """Specifies an effective range of recurrence instances for a recurrence id. This is used when modifying a recurrence rule and specifying that the action applies to all events following the specified event. """ NONE = "NONE" """No range is specified, just a single instance.""" THIS_AND_FUTURE = "THISANDFUTURE" """The range of the recurrence identifier and all subsequent values.""" class CalendarEventStoreService: """Performs event lookups from the local store. A CalendarEventStoreService should not be instantiated directly, and instead created from a `gcal_sync.sync.CalendarEventSyncManager`. """ def __init__( self, store: CalendarStore, calendar_id: str, api: GoogleCalendarService, ) -> None: """Initialize CalendarEventStoreService.""" self._store = store self._calendar_id = calendar_id self._api = api async def async_list_events( self, request: LocalListEventsRequest, ) -> LocalListEventsResponse: """Return the set of events matching the criteria.""" timeline = await self.async_get_timeline() if request.end_time: return LocalListEventsResponse( events=list( timeline.overlapping( request.start_time, request.end_time, ) ) ) return LocalListEventsResponse( events=list(timeline.active_after(request.start_time)) ) async def async_get_timeline( self, tzinfo: datetime.tzinfo | None = None ) -> Timeline: """Get the timeline of events.""" if tzinfo is None: tzinfo = datetime.timezone.utc events_data = await self._lookup_events_data() _LOGGER.debug("Created timeline of %d events", len(events_data)) def _build_timeline() -> Timeline: """Build the timeline of events, which can take some time to parse.""" event_objects = [Event(**data) for data in events_data.values()] return calendar_timeline(event_objects, tzinfo) loop = asyncio.get_event_loop() return await loop.run_in_executor(None, _build_timeline) async def async_add_event(self, event: Event) -> None: """Add the specified event to the calendar. You should sync the event store after adding an event. """ _LOGGER.debug("Adding event: %s", event) await self._api.async_create_event(self._calendar_id, event) async def async_delete_event( self, ical_uuid: str, event_id: str | None = None, recurrence_range: Range = Range.NONE, ) -> None: """Delete the event from the calendar. This method is used to delete an existing event. For a recurring event either the whole event or instances of an event may be deleted. As a result, it operates in terms of iCalUUID which is fixed across instances of recurring events. To delete the complete range of a recurring event, the `ical_uuid` for the event must be specified without a `event_id`. To delete individual instances or a range of instances of a recurring event both the `ical_uuid` and `event_id` can be specified. The `recurrence_range` determines if its just the individual event (`Range.NONE`) or also including events going forward (`Range.THIS_AND_FUTURE`) The local store may be used in some scenarios to determine the appropriate commands to send to the calendar API, so it may be operating on stale data. You should sync the event store after performing a delete operation to ensure the store reflects the latest information from the server """ event = await self._lookup_ical_uuid(ical_uuid) if not event or not event.id: raise ValueError(f"Event does not exist: {ical_uuid} or malformed") if ( event_id and recurrence_range == Range.THIS_AND_FUTURE and SyntheticEventId.parse(event_id).dtstart == event.start.value ): # Editing the first instance and all forward is the same as deleting # the entire series so don't bother forking a new event event_id = None if not event_id or not event.recurrence: # Deleting a single event or entire series of a recurring event await self._api.async_delete_event(self._calendar_id, event.id) return synthetic_event_id = SyntheticEventId.parse(event_id) if synthetic_event_id.original_event_id != event.id: raise ValueError( f"Mismatched ids ical_uuid={ical_uuid} and event_id={event_id}" ) if recurrence_range == Range.NONE: # A single recurrence instance is removed, marked as cancelled cancelled_event = Event( id=event_id, # Event instance status=EventStatusEnum.CANCELLED, start=event.start, end=event.end, ) body = json.loads(cancelled_event.model_dump_json(exclude_unset=True, by_alias=True)) del body["start"] del body["end"] await self._api.async_patch_event(self._calendar_id, event_id, body) return # Assumes any recurrence deletion is valid, and that overwriting # the "until" value will not produce more instances. if not (recur := event.recur): raise ValueError(f"Unable to update RRULE, does not conform: {recur}") if len(recur.rrule) > 1: raise ValueError(f"Can't update event with multiple RRULE: {recur.rrule}") # Stop recurring events before the specified date. This assumes that # setting the "until" field won't create more instances by changing count. # UNTIL is inclusive so it can't include the specified exdate. FREQ=DAILY # is the lowest frequency supported so subtracting one day is # safe and works for both dates and datetimes. recur.rrule[0].count = 0 recur.rrule[0].until = synthetic_event_id.dtstart - datetime.timedelta(days=1) updated_event = Event( id=event.id, # Primary event recurrence=recur.as_recurrence(), start=event.start, end=event.end, ) body = json.loads(updated_event.model_dump_json(exclude_unset=True, by_alias=True)) del body["start"] del body["end"] await self._api.async_patch_event(self._calendar_id, event.id, body) async def _lookup_events_data(self) -> dict[str, Any]: """Loookup the raw events storage dictionary.""" store_data = await self._store.async_load() or {} store_data.setdefault(ITEMS, {}) return store_data.get(ITEMS, {}) # type: ignore[no-any-return] async def _lookup_ical_uuid(self, ical_uuid: str) -> Event | None: """Find the specified event by id in the local store.""" events_data = await self._lookup_events_data() for data in events_data.values(): if (event_uuid := data.get("ical_uuid")) and event_uuid == ical_uuid: return Event(**data) return None