diff options
| author | stephanchrst <stephanchrst@gmail.com> | 2022-05-10 21:51:50 +0700 |
|---|---|---|
| committer | stephanchrst <stephanchrst@gmail.com> | 2022-05-10 21:51:50 +0700 |
| commit | 3751379f1e9a4c215fb6eb898b4ccc67659b9ace (patch) | |
| tree | a44932296ef4a9b71d5f010906253d8c53727726 /addons/google_calendar/utils | |
| parent | 0a15094050bfde69a06d6eff798e9a8ddf2b8c21 (diff) | |
initial commit 2
Diffstat (limited to 'addons/google_calendar/utils')
| -rw-r--r-- | addons/google_calendar/utils/__init__.py | 4 | ||||
| -rw-r--r-- | addons/google_calendar/utils/google_calendar.py | 104 | ||||
| -rw-r--r-- | addons/google_calendar/utils/google_event.py | 198 |
3 files changed, 306 insertions, 0 deletions
diff --git a/addons/google_calendar/utils/__init__.py b/addons/google_calendar/utils/__init__.py new file mode 100644 index 00000000..e8ec7702 --- /dev/null +++ b/addons/google_calendar/utils/__init__.py @@ -0,0 +1,4 @@ +# -*- coding: utf-8 -*- +# Part of Odoo. See LICENSE file for full copyright and licensing details. +from . import google_calendar +from . import google_event diff --git a/addons/google_calendar/utils/google_calendar.py b/addons/google_calendar/utils/google_calendar.py new file mode 100644 index 00000000..7d4467e3 --- /dev/null +++ b/addons/google_calendar/utils/google_calendar.py @@ -0,0 +1,104 @@ +# -*- coding: utf-8 -*- +# Part of Odoo. See LICENSE file for full copyright and licensing details. + +from uuid import uuid4 +import requests +import json +import logging + +from odoo import api, _ +from odoo.tools import exception_to_unicode +from odoo.addons.google_calendar.utils.google_event import GoogleEvent +from odoo.addons.google_account.models.google_service import TIMEOUT + + +_logger = logging.getLogger(__name__) + +def requires_auth_token(func): + def wrapped(self, *args, **kwargs): + if not kwargs.get('token'): + raise AttributeError("An authentication token is required") + return func(self, *args, **kwargs) + return wrapped + +class InvalidSyncToken(Exception): + pass + +class GoogleCalendarService(): + + def __init__(self, google_service): + self.google_service = google_service + + @requires_auth_token + def get_events(self, sync_token=None, token=None, timeout=TIMEOUT): + url = "/calendar/v3/calendars/primary/events" + headers = {'Content-type': 'application/json'} + params = {'access_token': token} + if sync_token: + params['syncToken'] = sync_token + try: + status, data, time = self.google_service._do_request(url, params, headers, method='GET', timeout=timeout) + except requests.HTTPError as e: + if e.response.status_code == 410 and 'fullSyncRequired' in str(e.response.content): + raise InvalidSyncToken("Invalid sync token. Full sync required") + raise e + + events = data.get('items', []) + next_page_token = data.get('nextPageToken') + while next_page_token: + params = {'access_token': token, 'pageToken': next_page_token} + status, data, time = self.google_service._do_request(url, params, headers, method='GET', timeout=timeout) + next_page_token = data.get('nextPageToken') + events += data.get('items', []) + + next_sync_token = data.get('nextSyncToken') + default_reminders = data.get('defaultReminders') + + return GoogleEvent(events), next_sync_token, default_reminders + + @requires_auth_token + def insert(self, values, token=None, timeout=TIMEOUT): + url = "/calendar/v3/calendars/primary/events?sendUpdates=all" + headers = {'Content-type': 'application/json', 'Authorization': 'Bearer %s' % token} + if not values.get('id'): + values['id'] = uuid4().hex + self.google_service._do_request(url, json.dumps(values), headers, method='POST', timeout=timeout) + return values['id'] + + @requires_auth_token + def patch(self, event_id, values, token=None, timeout=TIMEOUT): + url = "/calendar/v3/calendars/primary/events/%s?sendUpdates=all" % event_id + headers = {'Content-type': 'application/json', 'Authorization': 'Bearer %s' % token} + self.google_service._do_request(url, json.dumps(values), headers, method='PUT', timeout=timeout) + + @requires_auth_token + def delete(self, event_id, token=None, timeout=TIMEOUT): + url = "/calendar/v3/calendars/primary/events/%s?sendUpdates=all" % event_id + headers = {'Content-type': 'application/json'} + params = {'access_token': token} + try: + self.google_service._do_request(url, params, headers=headers, method='DELETE', timeout=timeout) + except requests.HTTPError as e: + # For some unknown reason Google can also return a 403 response when the event is already cancelled. + if e.response.status_code not in (410, 403): + raise e + _logger.info("Google event %s was already deleted" % event_id) + + + ################################# + ## MANAGE CONNEXION TO GMAIL ## + ################################# + + + def is_authorized(self, user): + return bool(user.sudo().google_calendar_rtoken) + + def _get_calendar_scope(self, RO=False): + readonly = '.readonly' if RO else '' + return 'https://www.googleapis.com/auth/calendar%s' % (readonly) + + def _google_authentication_url(self, from_url='http://www.odoo.com'): + return self.google_service._get_authorize_uri(from_url, service='calendar', scope=self._get_calendar_scope()) + + def _can_authorize_google(self, user): + return user.has_group('base.group_erp_manager') diff --git a/addons/google_calendar/utils/google_event.py b/addons/google_calendar/utils/google_event.py new file mode 100644 index 00000000..ed691dc6 --- /dev/null +++ b/addons/google_calendar/utils/google_event.py @@ -0,0 +1,198 @@ +# -*- coding: utf-8 -*- +# Part of Odoo. See LICENSE file for full copyright and licensing details. +from odoo.api import model +from odoo.tools.sql import existing_tables +import pytz +import logging +from typing import Iterator, Mapping +from collections import abc +from dateutil.parser import parse +from dateutil.relativedelta import relativedelta + + +from odoo import _ + +_logger = logging.getLogger(__name__) + + +class GoogleEvent(abc.Set): + """This helper class holds the values of a Google event. + Inspired by Odoo recordset, one instance can be a single Google event or a + (immutable) set of Google events. + All usual set operations are supported (union, intersection, etc). + + A list of all attributes can be found in the API documentation. + https://developers.google.com/calendar/v3/reference/events#resource + + :param iterable: iterable of GoogleCalendar instances or iterable of dictionnaries + + """ + + def __init__(self, iterable=()): + self._events = {} + for item in iterable: + if isinstance(item, self.__class__): + self._events[item.id] = item._events[item.id] + elif isinstance(item, Mapping): + self._events[item.get('id')] = item + else: + raise ValueError("Only %s or iterable of dict are supported" % self.__class__.__name__) + + def __iter__(self) -> Iterator['GoogleEvent']: + return iter(GoogleEvent([vals]) for vals in self._events.values()) + + def __contains__(self, google_event): + return google_event.id in self._events + + def __len__(self): + return len(self._events) + + def __bool__(self): + return bool(self._events) + + def __getattr__(self, name): + # ensure_one + try: + event, = self._events.keys() + except ValueError: + raise ValueError("Expected singleton: %s" % self) + event_id = list(self._events.keys())[0] + return self._events[event_id].get(name) + + def __repr__(self): + return '%s%s' % (self.__class__.__name__, self.ids) + + @property + def ids(self): + return tuple(e.id for e in self) + + @property + def rrule(self): + if self.recurrence and 'RRULE:' in self.recurrence[0]: # LUL TODO what if there are something else in the list? + return self.recurrence[0][6:] # skip "RRULE:" in the rrule string + + def odoo_id(self, env): + self.odoo_ids(env) # load ids + return self._odoo_id + + def _meta_odoo_id(self, dbname): + """Returns the Odoo id stored in the Google Event metadata. + This id might not actually exists in the database. + """ + properties = self.extendedProperties and (self.extendedProperties.get('shared', {}) or self.extendedProperties.get('private', {})) or {} + o_id = properties.get('%s_odoo_id' % dbname) + if o_id: + return int(o_id) + + def odoo_ids(self, env): + ids = tuple(e._odoo_id for e in self if e._odoo_id) + if len(ids) == len(self): + return ids + model = self._get_model(env) + found = self._load_odoo_ids_from_db(env, model) + unsure = self - found + if unsure: + unsure._load_odoo_ids_from_metadata(env, model) + + return tuple(e._odoo_id for e in self) + + def _load_odoo_ids_from_metadata(self, env, model): + unsure_odoo_ids = tuple(e._meta_odoo_id(env.cr.dbname) for e in self) + odoo_events = model.browse(_id for _id in unsure_odoo_ids if _id) + + # Extended properties are copied when splitting a recurrence Google side. + # Hence, we may have two Google recurrences linked to the same Odoo id. + # Therefore, we only consider Odoo records without google id when trying + # to match events. + o_ids = odoo_events.exists().filtered(lambda e: not e.google_id).ids + for e in self: + odoo_id = e._meta_odoo_id(env.cr.dbname) + if odoo_id in o_ids: + e._events[e.id]['_odoo_id'] = odoo_id + + def _load_odoo_ids_from_db(self, env, model): + odoo_events = model.with_context(active_test=False)._from_google_ids(self.ids) + mapping = {e.google_id: e.id for e in odoo_events} # {google_id: odoo_id} + existing_google_ids = odoo_events.mapped('google_id') + for e in self: + odoo_id = mapping.get(e.id) + if odoo_id: + e._events[e.id]['_odoo_id'] = odoo_id + return self.filter(lambda e: e.id in existing_google_ids) + + + def owner(self, env): + # Owner/organizer could be desynchronised between Google and Odoo. + # Let userA, userB be two new users (never synced to Google before). + # UserA creates an event in Odoo (he is the owner) but userB syncs first. + # There is no way to insert the event into userA's calendar since we don't have + # any authentication access. The event is therefore inserted into userB's calendar + # (he is the organizer in Google). The "real" owner (in Odoo) is stored as an + # extended property. There is currently no support to "transfert" ownership when + # userA syncs his calendar the first time. + real_owner_id = self.extendedProperties and self.extendedProperties.get('shared', {}).get('%s_owner_id' % env.cr.dbname) + try: + # If we create an event without user_id, the event properties will be 'false' + # and python will interpret this a a NoneType, that's why we have the 'except TypeError' + real_owner_id = int(real_owner_id) + except (ValueError, TypeError): + real_owner_id = False + real_owner = real_owner_id and env['res.users'].browse(real_owner_id) or env['res.users'] + if real_owner_id and real_owner.exists(): + return real_owner + elif self.organizer and self.organizer.get('self'): + return env.user + elif self.organizer and self.organizer.get('email'): + # In Google: 1 email = 1 user; but in Odoo several users might have the same email :/ + return env['res.users'].search([('email', '=', self.organizer.get('email'))], limit=1) + else: + return env['res.users'] + + def filter(self, func) -> 'GoogleEvent': + return GoogleEvent(e for e in self if func(e)) + + def clear_type_ambiguity(self, env): + ambiguous_events = self.filter(GoogleEvent._is_type_ambiguous) + recurrences = ambiguous_events._load_odoo_ids_from_db(env, env['calendar.recurrence']) + for recurrence in recurrences: + self._events[recurrence.id]['recurrence'] = True + for event in ambiguous_events - recurrences: + self._events[event.id]['recurrence'] = False + + def is_recurrence(self): + if self._is_type_ambiguous(): + _logger.warning("Ambiguous event type: cannot accurately tell whether a cancelled event is a recurrence or not") + return bool(self.recurrence) + + def is_recurrent(self): + return bool(self.recurringEventId or self.is_recurrence()) + + def is_cancelled(self): + return self.status == 'cancelled' + + def is_recurrence_outlier(self): + return bool(self.originalStartTime) + + def cancelled(self): + return self.filter(lambda e: e.status == 'cancelled') + + def exists(self, env) -> 'GoogleEvent': + recurrences = self.filter(GoogleEvent.is_recurrence) + events = self - recurrences + recurrences.odoo_ids(env) + events.odoo_ids(env) + + return self.filter(lambda e: e._odoo_id) + + def _is_type_ambiguous(self): + """For cancelled events/recurrences, Google only send the id and + the cancelled status. There is no way to know if it was a recurrence + or simple event.""" + return self.is_cancelled() and 'recurrence' not in self._events[self.id] + + def _get_model(self, env): + if all(e.is_recurrence() for e in self): + return env['calendar.recurrence'] + if all(not e.is_recurrence() for e in self): + return env['calendar.event'] + raise TypeError("Mixing Google events and Google recurrences") |
