cone.firebase 0.1__tar.gz

cone_firebase-0.1/CHANGES.rst

@@ -0,0 +1,7 @@
+Changes
+=======
+
+0.1 (2025-10-25)
+----------------
+
+- Initial

cone_firebase-0.1/LICENSE.rst

@@ -0,0 +1,27 @@
+License
+=======
+
+Copyright (c) 2021, BlueDynamics Alliance, Austria
+Copyright (c) 2021, Cone Contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cone_firebase-0.1/MANIFEST.in

@@ -0,0 +1,3 @@
+include *.rst
+recursive-include src *
+recursive-exclude src *.pyc *.pyo

cone_firebase-0.1/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: cone.firebase
+Version: 0.1
+Summary: Firebase integration for cone.app
+Home-page: http://github.com/conestack/cone.firebase
+Author: Cone Contributors
+Author-email: dev@conestack.org
+License: Simplified BSD
+Keywords: node pyramid cone web
+Classifier: Environment :: Web Environment
+Classifier: Programming Language :: Python
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+License-File: LICENSE.rst
+Requires-Dist: proto-plus==1.18.1
+Requires-Dist: google-api-core==1.26.3
+Requires-Dist: google-api-python-client==2.2.0
+Requires-Dist: google-auth==1.29.0
+Requires-Dist: google-auth-httplib2==0.1.0
+Requires-Dist: google-auth-oauthlib==0.4.6
+Requires-Dist: google-cloud-core==1.6.0
+Requires-Dist: google-cloud-firestore==2.1.0
+Requires-Dist: google-cloud-storage==1.37.1
+Requires-Dist: google-crc32c==1.1.2
+Requires-Dist: google-pasta==0.2.0
+Requires-Dist: google-resumable-media==1.2.0
+Requires-Dist: googleapis-common-protos==1.53.0
+Requires-Dist: setuptools
+Requires-Dist: cone.app<1.1.0
+Requires-Dist: requests
+Requires-Dist: firebase_admin==4.5.3
+Provides-Extra: test
+Requires-Dist: zope.testrunner; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+.. image:: https://img.shields.io/pypi/v/cone.firebase.svg
+    :target: https://pypi.python.org/pypi/cone.firebase
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/cone.firebase.svg
+    :target: https://pypi.python.org/pypi/cone.firebase
+    :alt: Number of PyPI downloads
+
+.. image:: https://travis-ci.org/bluedynamics/cone.firebase.svg?branch=master
+    :target: https://travis-ci.org/bluedynamics/cone.firebase
+
+.. image:: https://coveralls.io/repos/github/bluedynamics/cone.firebase/badge.svg?branch=master
+    :target: https://coveralls.io/github/bluedynamics/cone.firebase?branch=master
+
+
+This package provides a firebase integration in to cone.app.
+
+
+Installation
+------------
+
+Include ``cone.firebase`` to install dependencies in your application's
+``setup.py``.
+
+
+Configuration
+-------------
+
+Adopt your application config ini file to define firebase related API keys.
+
+.. code-block:: ini
+
+    [app:my_app]
+    use = egg:cone.app#main
+
+    cone.plugins =
+        cone.firebase
+
+    cone.authenticator = firebase
+
+    firebase.web_api_key = xxx
+    firebase.service_account_json_file = path/to/service_account.json
+
+also in your ugm.xml you can optionally add the `firebase_user` checkbox:
+
+.. code-block:: xml
+
+    <users_form_attrmap>
+        ...
+        <elem>
+            <key>firebase_user</key>
+            <value>Firebase User</value>
+        </elem>
+    </users_form_attrmap>
+
+When you want to upgrade an existing user to FB, you can do this by checking
+`firebase_user` in the user edit form, butt attention: you have to manually
+enter the password since the firebase API expects the password in cleartext.
+
+Contributors
+============
+
+- Robert Niederreiter
+- Phil Auersperg
+
+
+Changes
+=======
+
+0.1 (2025-10-25)
+----------------
+
+- Initial
+
+
+License
+=======
+
+Copyright (c) 2021, BlueDynamics Alliance, Austria
+Copyright (c) 2021, Cone Contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cone_firebase-0.1/README.rst

@@ -0,0 +1,64 @@
+.. image:: https://img.shields.io/pypi/v/cone.firebase.svg
+    :target: https://pypi.python.org/pypi/cone.firebase
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/cone.firebase.svg
+    :target: https://pypi.python.org/pypi/cone.firebase
+    :alt: Number of PyPI downloads
+
+.. image:: https://travis-ci.org/bluedynamics/cone.firebase.svg?branch=master
+    :target: https://travis-ci.org/bluedynamics/cone.firebase
+
+.. image:: https://coveralls.io/repos/github/bluedynamics/cone.firebase/badge.svg?branch=master
+    :target: https://coveralls.io/github/bluedynamics/cone.firebase?branch=master
+
+
+This package provides a firebase integration in to cone.app.
+
+
+Installation
+------------
+
+Include ``cone.firebase`` to install dependencies in your application's
+``setup.py``.
+
+
+Configuration
+-------------
+
+Adopt your application config ini file to define firebase related API keys.
+
+.. code-block:: ini
+
+    [app:my_app]
+    use = egg:cone.app#main
+
+    cone.plugins =
+        cone.firebase
+
+    cone.authenticator = firebase
+
+    firebase.web_api_key = xxx
+    firebase.service_account_json_file = path/to/service_account.json
+
+also in your ugm.xml you can optionally add the `firebase_user` checkbox:
+
+.. code-block:: xml
+
+    <users_form_attrmap>
+        ...
+        <elem>
+            <key>firebase_user</key>
+            <value>Firebase User</value>
+        </elem>
+    </users_form_attrmap>
+
+When you want to upgrade an existing user to FB, you can do this by checking
+`firebase_user` in the user edit form, butt attention: you have to manually
+enter the password since the firebase API expects the password in cleartext.
+
+Contributors
+============
+
+- Robert Niederreiter
+- Phil Auersperg

cone_firebase-0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cone_firebase-0.1/setup.py

@@ -0,0 +1,72 @@
+from setuptools import find_packages
+from setuptools import setup
+from setuptools.command.test import test
+import os
+
+
+def read_file(name):
+    with open(os.path.join(os.path.dirname(__file__), name)) as f:
+        return f.read()
+
+
+version = '0.1'
+shortdesc = 'Firebase integration for cone.app'
+longdesc = '\n\n'.join([read_file(name) for name in [
+    'README.rst',
+    'CHANGES.rst',
+    'LICENSE.rst'
+]])
+
+
+class Test(test):
+
+    def run_tests(self):
+        from cone.firebase import tests
+        tests.run_tests()
+
+
+setup(
+    name='cone.firebase',
+    version=version,
+    description=shortdesc,
+    long_description=longdesc,
+    classifiers=[
+        'Environment :: Web Environment',
+        'Programming Language :: Python',
+        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
+    ],
+    keywords='node pyramid cone web',
+    author='Cone Contributors',
+    author_email='dev@conestack.org',
+    url='http://github.com/conestack/cone.firebase',
+    license='Simplified BSD',
+    packages=find_packages('src'),
+    package_dir={'': 'src'},
+    namespace_packages=['cone'],
+    include_package_data=True,
+    zip_safe=False,
+    install_requires=[
+        'proto-plus==1.18.1',
+        'google-api-core==1.26.3',
+        'google-api-python-client==2.2.0',
+        'google-auth==1.29.0',
+        'google-auth-httplib2==0.1.0',
+        'google-auth-oauthlib==0.4.6',
+        'google-cloud-core==1.6.0',
+        'google-cloud-firestore==2.1.0',
+        'google-cloud-storage==1.37.1',
+        'google-crc32c==1.1.2',
+        'google-pasta==0.2.0',
+        'google-resumable-media==1.2.0',
+        'googleapis-common-protos==1.53.0',
+
+        'setuptools',
+        'cone.app<1.1.0',
+        'requests',
+        'firebase_admin==4.5.3',
+        # 'protobuf==3.15.8'
+    ],
+    extras_require=dict(test=['zope.testrunner']),
+    tests_require=['zope.testrunner'],
+    cmdclass=dict(test=Test)
+)

cone_firebase-0.1/src/cone/__init__.py

@@ -0,0 +1 @@
+__import__('pkg_resources').declare_namespace(__name__)

cone_firebase-0.1/src/cone/firebase/__init__.py

@@ -0,0 +1,87 @@
+from cone.app import main_hook
+from cone.app.interfaces import IAuthenticator
+from cone.firebase.authentication import FirebaseAuthenticator
+from cone.ugm.browser.principal import user_field
+from yafowil.base import factory
+import firebase_admin
+import json
+import logging
+
+
+logger = logging.getLogger('cone.firebase')
+
+
+class FirebaseConfig(object):
+    web_api_key = None
+    service_account_json = None
+
+    def __init__(self, web_api_key, service_account_json_file):
+        self.web_api_key = web_api_key
+        with open(service_account_json_file, 'r') as f:
+            self.service_account_json = json.loads(f.read())
+
+
+# FirebaseConfig singleton
+config = None
+
+
+def load_firebase_config(settings):
+    global config
+    config = FirebaseConfig(
+        settings['firebase.web_api_key'],
+        settings['firebase.service_account_json_file']
+    )
+
+
+def initialize_firebase_admin():
+    service_account_json = config.service_account_json
+    cred = firebase_admin.credentials.Certificate(service_account_json)
+    if not firebase_admin._apps:
+        firebase_admin.initialize_app(cred)
+
+
+@user_field('firebase_user')
+def firebase_user_field_factory(form, label, value):
+    return factory(
+        'field:label:help:error:checkbox',
+        value=value,
+        props={
+            'label': label,
+            'datatype': bool,
+            'help': "shall this user also be managed in Firebase?",
+        })
+
+
+@user_field('email_verified')
+def email_verified(form, label, value):
+    return factory(
+        'field:label:help:error:checkbox',
+        value=value,
+        props={
+            'label': label,
+            'datatype': bool,
+            'help': "is user verified by email?",
+        })
+
+
+@user_field('fullname')
+def fullname_field_factory(form, label, value):
+    return factory(
+        'field:label:error:text',
+        value=value,
+        props={
+            'label': label,
+            'datatype': str,
+            'required': "fullname not given"
+        })
+
+
+@main_hook
+def initialize_firebase(config, global_config, settings):
+    load_firebase_config(settings)
+    initialize_firebase_admin()
+    config.registry.registerUtility(
+        FirebaseAuthenticator,
+        IAuthenticator,
+        'firebase'
+    )

cone_firebase-0.1/src/cone/firebase/api.py

@@ -0,0 +1,5 @@
+from cone.firebase.management import get_device_tokens_for_user  # noqa
+from cone.firebase.management import register_device_token_for_user  # noqa
+from cone.firebase.messaging import send_message  # noqa
+from cone.firebase.messaging import send_message_to_user  # noqa
+from cone.firebase.messaging import send_messages  # noqa

cone_firebase-0.1/src/cone/firebase/authentication.py

@@ -0,0 +1,76 @@
+from cone.app import security
+from cone.app import ugm_backend
+from cone.app.interfaces import IAuthenticator
+from zope.interface import implementer
+import cone.firebase
+import json
+import requests
+
+
+REST_API_URL_LOGIN = f"https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword"
+
+
+def sign_in_with_email_and_password(email, password, api_key, return_secure_token = True):
+    """
+    borrowed from here:
+    https://github.com/billydh/python-firebase-admin-sdk-demo/blob/master/sign_in_with_email_and_password.py
+    """
+
+    try:
+        payload = json.dumps({
+            "email": email or "",
+            "password": password or "",
+            "returnSecureToken": return_secure_token
+        })
+    except Exception as ex:
+        cone.firebase.logger.error(f"error encoding email: {email} and password: {password}")
+        raise
+
+    r = requests.post(REST_API_URL_LOGIN,
+                      params={"key": api_key},
+                      data=payload)
+
+    return r.json()
+
+
+@implementer(IAuthenticator)
+class FirebaseAuthenticator:
+
+    @classmethod
+    def authenticate(cls, uid: str, pwd: str) -> str:
+        """
+        does firebase authentication and in the case of success
+        checks if the uid exists in self.users, if not it creates the user there
+        when fb login is unsuccessful delegates it to
+        :return: login of logged in user
+        """
+
+        res = sign_in_with_email_and_password(uid, pwd, cone.firebase.config.web_api_key)
+
+        ugm = ugm_backend.ugm
+        users = ugm.users
+
+        if res.get("kind") == 'identitytoolkit#VerifyPasswordResponse':
+            id = res["localId"]
+            if id not in users:
+                users.create(
+                    id,
+                    login="email",
+                    email=res["email"],
+                    fullname=res.get("displayName"),
+                    registered=res["registered"],
+                    idtoken=res["idToken"]
+                )
+            # else:
+            #    user email aktualisieren
+
+            user = users[id]
+            if hasattr(users, "on_authenticated"):
+                users.on_authenticated(res["localId"])
+            # user.passwd(None, pwd)  # it is to decide if we need local pwds
+            return id
+        else:
+            # if not found in firebase login locally
+            auth = users.authenticate(uid, pwd)
+            if auth:
+                return uid

cone_firebase-0.1/src/cone/firebase/management.py

@@ -0,0 +1,181 @@
+from cone.app import ugm_backend
+from cone.ugm.events import UserCreatedEvent
+from cone.ugm.events import UserDeletedEvent
+from cone.ugm.events import UserModifiedEvent
+from firebase_admin import auth
+from firebase_admin.auth import UserNotFoundError
+from pyramid.security import remember
+from typing import List
+from typing import Tuple
+from yafowil.base import ExtractionError
+from zope.event import classhandler
+import cone.firebase
+
+
+FIREBASE_DEVICE_TOKENS = "firebase_device_tokens"
+
+
+@classhandler.handler(UserCreatedEvent)
+def on_user_created(event: UserCreatedEvent):
+    user = event.principal
+    email = user.attrs["mail"]
+    uid = user.attrs["id"]
+    # if firebase_user checkbox is not installed, we want to add all users to FB
+    if "firebase_user" not in user.attrs or user.attrs["firebase_user"]:
+        if email:
+            user_record = create_firebase_user(user, event.password)
+            cone.firebase.logger.info(f"user {uid} added to firebase with email {email} -> {user_record.__dict__}")
+        else:
+            cone.firebase.logger.warn(f"user {uid} has no email -> not added to firebase")
+
+
+def create_firebase_user(user, password):
+    fullname = user.attrs["fullname"]
+    user_record = auth.create_user(
+        uid=user.attrs["id"],
+        email=user.attrs["mail"],
+        # phone_number='+15555550100',
+        # email_verified=True,
+        password=password,
+        display_name=fullname,
+        # photo_url='http://www.example.com/12345678/photo.png',
+        disabled=False
+    )
+    user.attrs["login"] = "mail"
+    return user_record
+
+
+@classhandler.handler(UserModifiedEvent)
+def on_user_modified(event: UserModifiedEvent):
+    user = event.principal
+    email = user.attrs["mail"]
+    uid = user.attrs["id"]
+    try:
+        fbuser = auth.get_user(uid)
+    except UserNotFoundError:
+        # user does not exist in firebase, lets push it to fb, the password has to be specified by hand, otherwise the
+        # hashed password will be set in fb!
+        if user.attrs.get("firebase_user", False):
+            cone.firebase.logger.warn(f"user wth id {uid} not found in firebase, creating it in fb")
+            if not user.attrs["fullname"]:
+                raise ExtractionError("Fullname not given")
+            fbuser = create_firebase_user(user, event.password)
+            cone.firebase.logger.warn(f"created user wth id {uid} in fb")
+        else:
+            fbuser = None
+            cone.firebase.logger.warn(f"user wth id {uid} not found in firebase")
+
+    if email and fbuser:
+        fullname = user.attrs["fullname"]
+        password = event.password
+
+        params = dict(
+            email=email,
+            # phone_number='+15555550100',
+            display_name=fullname,
+            disabled=False)
+
+        if event.password:
+            params["password"] = event.password
+
+        res = auth.update_user(
+            uid,
+            **params
+        )
+        cone.firebase.logger.info(f"user {uid} changes promoted to firebase with email {email} -> {res}")
+    else:
+        cone.firebase.logger.warn(f"user {uid} has no email -> not added to firebase")
+
+
+@classhandler.handler(UserDeletedEvent)
+def on_user_deleted(event):
+    user = event.principal
+    uid = user.attrs["id"]
+    try:
+        fbuser = auth.get_user(uid)
+        auth.delete_user(uid)
+        cone.firebase.logger.info(f"user with id {uid} deleted in firebase")
+    except UserNotFoundError:
+        cone.firebase.logger.warn(f"user with id {uid} not found in firebase -> user not deleted in fb")
+
+
+def authenticate_with_id_token(request, id_token: str) -> Tuple[str, str]:
+    """
+    uses the firebase ID token to login without password
+    needs installed UGM user folder located at AppRoot()["users"]
+
+    :return: tuple (user_id, auth token)
+    """
+    # users = AppRoot()["users"]
+    cone.firebase.logger.info(f"loggin in with firebase id token: {id_token}")
+    ugm = ugm_backend.ugm
+    users = ugm.users
+    res = auth.verify_id_token(id_token)
+    user_id = res["user_id"]
+    if user_id not in users:
+        # TODO: creation shall take place in security.authenticate()
+        cone.firebase.logger.info(f"user with id {user_id} not stored locally - creating")
+        users.create(
+            user_id,
+            login="email",
+            email=res["email"],
+            fullname=res.get("name", ""),
+            email_verified=res["email_verified"],
+            phone=res.get("phone_number", ""),
+            idtoken=id_token
+        )
+        cone.firebase.logger.info(f"user with {user_id} successfully created")
+
+    return user_id, remember(request, user_id)
+
+
+def register_device_token_for_user(login: str, token: str) -> List[str]:
+    """
+    registers a device token for a given user
+    :param login: email or uid
+    :param token: firebase device token
+    """
+    users = ugm_backend.ugm.users
+    if login not in users:
+        uid = users.id_for_login(login)
+    else:
+        uid = login
+
+    user = users[uid]
+    tokens = user.attrs.get(FIREBASE_DEVICE_TOKENS, []) or []
+    if token not in tokens:
+        user.attrs[FIREBASE_DEVICE_TOKENS] = list(tokens) + [token]
+
+    return user.attrs[FIREBASE_DEVICE_TOKENS]
+
+
+def unregister_device_token_for_user(login: str, token: str):
+    """
+    registers a device token for a given user
+    :param login: email or uid
+    :param token: firebase device token
+    """
+    users = ugm_backend.ugm.users
+    if login not in users:
+        uid = users.id_for_login(login)
+    else:
+        uid = login
+
+    user = users[uid]
+    tokens = user.attrs.get(FIREBASE_DEVICE_TOKENS, []) or []
+    if token in tokens:
+        user.attrs[FIREBASE_DEVICE_TOKENS] = [tok for tok in tokens if token != tok]
+
+
+def get_device_tokens_for_user(login: str) -> List[str]:
+    users = ugm_backend.ugm.users
+    if login not in users:
+        uid = users.id_for_login(login)
+    else:
+        uid = login
+
+    if uid in users:
+        user = users[uid]
+        return user.attrs.get(FIREBASE_DEVICE_TOKENS, []) or []
+    else:
+        return []