class CiviCRMBaseView(BrowserView):
"""A base browser view for getting information from a CiviCRM
server using its REST API interface.
"""
def __call__(self):
"""Open a connection to the CiviCRM server using the
configuration information stored on the registry and the
current user account.
:raises: Forbidden
"""
url = api.portal.get_registry_record(URL_RECORD)
site_key = api.portal.get_registry_record(SITE_KEY_RECORD)
api_key = api.user.get_current().getProperty('api_key', None)
# can not open connection to server if no api_key is provided
if not api_key:
raise Forbidden(
'No API key defined. You can not access CiviCRM server.')
# for now, we can use any kind of connection
# in the future, we must enforce use_ssl=True
# as CiviCRM stores personal information of users
use_ssl = urlparse(url).scheme == 'https'
self.civicrm = CiviCRM(
url, site_key, api_key, use_ssl=use_ssl, timeout=TIMEOUT)
@property
def _validate_contact_id(self):
"""Return True if the contact_id from the request is valid.
:raises: Forbidden
"""
id = self.request.form.get('contact_id', None)
if id is None:
raise Forbidden('contact_id was not set.')
else:
try:
id = int(id)
except ValueError:
raise Forbidden('contact_id is not an integer.')
return True
@timecall(immediate=INMEDIATE_TIMING)
def _get_contact(self, contact_id):
"""Return a contact from a CiviCRM server.
:param contact_id: [required] the id of the contact to search for
:type contact_ids: int
:returns: dictionary with contact information
"""
return self.civicrm.getsingle('Contact', contact_id=contact_id)
@ram.cache(lambda method, self, contact_id: (time() // TTL, contact_id))
def get_contact(self, contact_id):
"""Cached version of the _get_contact() function."""
return self._get_contact(contact_id)
def __call__(self):
"""Open a connection to the CiviCRM server using the
configuration information stored on the registry and the
current user account.
:raises: Forbidden
"""
url = api.portal.get_registry_record(URL_RECORD)
site_key = api.portal.get_registry_record(SITE_KEY_RECORD)
api_key = api.user.get_current().getProperty('api_key', None)
# can not open connection to server if no api_key is provided
if not api_key:
raise Forbidden(
'No API key defined. You can not access CiviCRM server.')
# for now, we can use any kind of connection
# in the future, we must enforce use_ssl=True
# as CiviCRM stores personal information of users
use_ssl = urlparse(url).scheme == 'https'
self.civicrm = CiviCRM(
url, site_key, api_key, use_ssl=use_ssl, timeout=TIMEOUT)
