1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
|
"""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, cast
from urllib.request import pathname2url
try:
from pydantic.v1 import Field, root_validator, validator
except ImportError:
from pydantic import ( # type: ignore
Field,
root_validator,
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)
def _validate_datetime(values: dict[str, Any], key: str) -> dict[str, Any]:
"""Validate date/datetime request fields are set properly."""
if time := values.get(key):
values[key] = time.replace(microsecond=0)
return values
def _validate_datetimes(values: dict[str, Any]) -> dict[str, Any]:
"""Validate the date or datetime fields are set properly."""
values = _validate_datetime(values, "start_time")
values = _validate_datetime(values, "end_time")
return values
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")
"""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.json(exclude_none=True, by_alias=True)),
single_events=Boolean.TRUE,
order_by=OrderBy.START_TIME,
)
@validator("start_time", always=True)
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
@root_validator
def _check_datetime(cls, values: dict[str, Any]) -> dict[str, Any]:
"""Validate the date or datetime fields are set properly."""
return _validate_datetimes(values)
class Config:
"""Pydantic model configuration."""
allow_population_by_field_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.json(exclude_none=True, by_alias=True))
)
@validator("start_time", always=True)
def _default_start_time(cls, value: datetime.datetime) -> datetime.datetime:
"""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(alias="singleEvents")
order_by: Optional[OrderBy] = Field(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.json(exclude_none=True, by_alias=True, exclude={"calendar_id"})
),
)
@root_validator
def check_datetime(cls, values: dict[str, Any]) -> dict[str, Any]:
"""Validate the date or datetime fields are set properly."""
return _validate_datetimes(values)
@root_validator
def check_sync_token_fields(cls, values: dict[str, Any]) -> dict[str, Any]:
"""Validate the set of fields present when using a sync token."""
if not values.get("sync_token"):
return values
if (
values.get("order_by")
or values.get("search")
or values.get("time_min")
or values.get("time_max")
):
raise ValueError(
f"Specified request params not compatible with sync_token: {values}"
)
return values
class Config:
"""Model configuration."""
allow_population_by_field_name = True
class _ListEventsResponseModel(SyncableResponse):
"""Api response containing a list of events."""
items: List[Event] = []
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.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)
)
)
return Event(**result)
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.update_forward_refs()
return _ListEventsResponseModel(**result)
async def async_create_event(
self,
calendar_id: str,
event: Event,
) -> None:
"""Create an event on the specified calendar."""
body = json.loads(event.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."""
@root_validator
def check_datetime(cls, values: dict[str, Any]) -> dict[str, Any]:
"""Validate the date or datetime fields are set properly."""
return _validate_datetimes(values)
class Config:
"""Model configuration."""
allow_population_by_field_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.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.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
|