Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 80 additions & 53 deletions auth_oauth_environment/README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,42 @@
.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png
:target: https://www.gnu.org/licenses/agpl
:alt: License: AGPL-3

======================
Auth Oauth Environment
======================

This module extends the functionality of server environment to support OAuth
providers, and allows you to enable providers and set client_id key according
to environment. (Refer to module server_environment for more informations)
================================================
Auth oauth configuration with server_environment
================================================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:b787e16c08c7d8d3b53118cafeba8c96756be4e4b2a8405d57a351b746ea021e
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github
:target: https://github.com/OCA/server-env/tree/17.0/auth_oauth_environment
:alt: OCA/server-env
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-env-17-0/server-env-17-0-auth_oauth_environment
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=17.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module extends the functionality of server environment to support
OAuth providers, and allows you to enable providers and set client_id
key according to environment. (Refer to module server_environment for
more informations)

**Table of contents**

.. contents::
:local:

Installation
============
Expand All @@ -20,83 +48,82 @@ Configuration
=============

To configure this module, you need to add a section
``[auth_oauth.provider_simple_name]`` to you server_environment_files
configurations, where 'provider_simple_name' match the simplified name field on
``[auth_oauth.provider_name]`` to you server_environment_files

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to your server_environment_files

configurations, where 'provider_name' match the tech_name field on
auth.oauth.provider.

'provider_simple_name' is the first part (until first space character) in
lower case of provider name. Using existing providers, it could be either
``google``, ``odoo.com``, or ``facebook``.
'provider_name' is the first part (until first space character) in lower
case of provider name. Using existing providers, it could be either
``provider_google``, ``provider_openerp``, or ``provider_facebook``.

For example, if you want to activate Google and Odoo.com, your
server_environment_files should look like this ::
server_environment_files should look like this:

[auth_oauth.google]
enabled=True
client_id=123456789101-abcdefghijklmnopqrstuvwxyz000000
::

[auth_oauth.odoo.com]
enabled=True
[auth_oauth.provider_google]
client_id=123456789101-abcdefghijklmnopqrstuvwxyz000000
enabled=True

[auth_oauth.provider_openerp]
enabled=True

Any provider not being enabled through server_environment_files will be set as
disabled automatically.

If you want to define a new custom provider, you should pay attention to the
name to use in the server_environment_files. If you create a provider with
'Dummy auth provider' as its name, then the section should be named
``[auth_oauth.dummy]``.
Any provider not being enabled through server_environment_files will be
set as disabled automatically.

If you want to define a new custom provider, you should pay attention to
the tech name to use in the server_environment_files. If you create a
provider with 'provider_dummy' as its tech_name, then the section should
be named ``[auth_oauth.provider_dummy]``.

Usage
=====

Once configured, Odoo will read from server_environment_files the following
fields of auth.oauth.provider :

* Allowed (``enabled``)
* Client ID (``client_id``)
Once configured, Odoo will read from server_environment_files the
following fields of auth.oauth.provider :


Known issues / Roadmap
======================

* Due to the specific nature of this module, it cannot be tested on OCA runbot.
- Allowed (``enabled``)
- Client ID (``client_id``)

Bug Tracker
===========

Bugs are tracked on `GitHub Issues
<https://github.com/OCA/server-env/issues>`_. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-env/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-env/issues/new?body=module:%20auth_oauth_environment%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Images
------
Authors
-------

* Odoo Community Association: `Icon <https://odoo-community.org/logo.png>`_.
* Camptocamp SA

Contributors
------------

* Akim Juillerat <akim.juillerat@camptocamp.com>
- `Camptocamp <https://www.camptocamp.com>`__

Do not contact contributors directly about support or help with technical issues.
- Akim Juillerat akim.juillerat@camptocamp.com
- Vincent Van Rossem vincent.vanrossem@camptocamp.com>

Maintainer
----------
Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

To contribute to this module, please visit https://odoo-community.org.
This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/17.0/auth_oauth_environment>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
4 changes: 2 additions & 2 deletions auth_oauth_environment/__manifest__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
{
"name": "Auth oauth configuration with server_environment",
"version": "11.0.1.0.0",
"version": "17.0.1.0.0",
"category": "Tools",
"summary": "Configure mail servers with server_environment_files",
"author": "Camptocamp SA, Odoo Community Association (OCA)",
Expand All @@ -12,7 +12,7 @@
"auth_oauth",
"server_environment",
],
"data": ["views/auth_oauth_provider.xml"],
"data": ["data/auth_oauth_provider.xml"],
"auto_install": False,
"installable": True,
}
12 changes: 12 additions & 0 deletions auth_oauth_environment/data/auth_oauth_provider.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo noupdate="1">
<record id="auth_oauth.provider_openerp" model="auth.oauth.provider">
<field name="tech_name">provider_openerp</field>
</record>
<record id="auth_oauth.provider_facebook" model="auth.oauth.provider">
<field name="tech_name">provider_facebook</field>
</record>
<record id="auth_oauth.provider_google" model="auth.oauth.provider">
<field name="tech_name">provider_google</field>
</record>
</odoo>
1 change: 0 additions & 1 deletion auth_oauth_environment/models/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
from . import auth_oauth_provider
from . import res_config_settings
85 changes: 23 additions & 62 deletions auth_oauth_environment/models/auth_oauth_provider.py
Original file line number Diff line number Diff line change
@@ -1,75 +1,36 @@
# Copyright 2017 Camptocamp SA
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

import json

from lxml import etree

from odoo import _, api, fields, models

from odoo.addons.server_environment import serv_config
from odoo.exceptions import UserError


class AuthOAuthProvider(models.Model):
_inherit = "auth.oauth.provider"

managed_by_env = fields.Boolean(compute="_compute_server_env")
provider_simple_name = fields.Char(compute="_compute_simple_name")
client_id = fields.Char(string="Client ID", compute="_compute_server_env")
enabled = fields.Boolean(
string="Allowed", compute="_compute_server_env", search="_search_enabled"
)
_name = "auth.oauth.provider"
_inherit = ["auth.oauth.provider", "server.env.techname.mixin", "server.env.mixin"]

def _compute_server_env(self):
for provider in self:
provider_section_name = provider._get_provider_section_name()
vals = {}
enabled = fields.Boolean(search="_search_enabled")

if serv_config.has_section(provider_section_name):
vals.update({"managed_by_env": True})
vals.update(serv_config.items(provider_section_name))
else:
vals.update({"managed_by_env": False, "enabled": False})
provider.update(vals)

def _search_enabled(self, operator, value):
enabled_provider_ids = []
for provider in self.search([]):
provider_section_name = provider._get_provider_section_name()
if serv_config.has_option(
provider_section_name, "enabled"
) and serv_config.get(provider_section_name, "enabled"):
enabled_provider_ids.append(provider.id)
return [("id", "in", enabled_provider_ids)]

@api.multi
def _compute_simple_name(self):
for provider in self:
provider.provider_simple_name = provider.name.split(" ")[0].lower()

@api.multi
def _get_provider_section_name(self):
self.ensure_one()
return ".".join(["auth_oauth", self.provider_simple_name])
@property
def _server_env_fields(self):
base_fields = super()._server_env_fields
oauth_fields = {
"client_id": {},
"enabled": {},
}
oauth_fields.update(base_fields)
return oauth_fields

@api.model
def fields_view_get(
self, view_id=None, view_type="form", toolbar=False, submenu=False
):
res = super().fields_view_get(
view_id=view_id, view_type=view_type, toolbar=toolbar, submenu=submenu
)
readonly_fields = ["enabled", "client_id"]
doc = etree.XML(res["arch"])
for ro_field in readonly_fields:
for node in doc.xpath("//field[@name='%s']" % ro_field):
node.set("readonly", "1")
modifiers = json.loads(node.get("modifiers"))
modifiers["readonly"] = True
node.set("modifiers", json.dumps(modifiers))
def _server_env_global_section_name(self):
return "auth_oauth"

node.set(
"help", _("This field is managed through server " "environment")
)
res["arch"] = etree.tostring(doc, encoding="unicode")
return res
@api.model
def _search_enabled(self, operator, value):
if operator not in ["=", "!="] or not isinstance(value, bool):
raise UserError(_("Operation not supported"))
if operator != "=":
value = not value
enabled = self.search([]).filtered(lambda p: p.enabled)
return [("id", "in" if value else "not in", enabled.ids)]
44 changes: 0 additions & 44 deletions auth_oauth_environment/models/res_config_settings.py

This file was deleted.

27 changes: 27 additions & 0 deletions auth_oauth_environment/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
To configure this module, you need to add a section
``[auth_oauth.provider_name]`` to you server_environment_files
configurations, where 'provider_name' match the tech_name field on
auth.oauth.provider.

'provider_name' is the first part (until first space character) in
lower case of provider name. Using existing providers, it could be either
``provider_google``, ``provider_openerp``, or ``provider_facebook``.

For example, if you want to activate Google and Odoo.com, your
server_environment_files should look like this:
```
[auth_oauth.provider_google]
client_id=123456789101-abcdefghijklmnopqrstuvwxyz000000
enabled=True

[auth_oauth.provider_openerp]
enabled=True
```

Any provider not being enabled through server_environment_files will be set as
disabled automatically.

If you want to define a new custom provider, you should pay attention to the
tech name to use in the server_environment_files. If you create a provider with
'provider_dummy' as its tech_name, then the section should be named
``[auth_oauth.provider_dummy]``.
3 changes: 3 additions & 0 deletions auth_oauth_environment/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- [Camptocamp](https://www.camptocamp.com)
- Akim Juillerat <akim.juillerat@camptocamp.com>
- Vincent Van Rossem <vincent.vanrossem@camptocamp.com>>
3 changes: 3 additions & 0 deletions auth_oauth_environment/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
This module extends the functionality of server environment to support OAuth
providers, and allows you to enable providers and set client_id key according
to environment. (Refer to module server_environment for more informations)
2 changes: 2 additions & 0 deletions auth_oauth_environment/readme/INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
To install this module, you need to have the server_environment module
installed and properly configured.
Loading