From 800da9ec3b2bf201bee6c9016e32f80d854d6509 Mon Sep 17 00:00:00 2001 From: Akim Juillerat Date: Wed, 13 Dec 2017 12:36:02 +0100 Subject: [PATCH 1/5] Create module auth_oauth_environment --- auth_oauth_environment/README.rst | 102 ++++++++++++++++++ auth_oauth_environment/__init__.py | 1 + auth_oauth_environment/__manifest__.py | 20 ++++ auth_oauth_environment/models/__init__.py | 2 + .../models/auth_oauth_provider.py | 61 +++++++++++ .../models/res_config_settings.py | 39 +++++++ .../views/auth_oauth_provider.xml | 16 +++ 7 files changed, 241 insertions(+) create mode 100644 auth_oauth_environment/README.rst create mode 100644 auth_oauth_environment/__init__.py create mode 100644 auth_oauth_environment/__manifest__.py create mode 100644 auth_oauth_environment/models/__init__.py create mode 100644 auth_oauth_environment/models/auth_oauth_provider.py create mode 100644 auth_oauth_environment/models/res_config_settings.py create mode 100644 auth_oauth_environment/views/auth_oauth_provider.xml diff --git a/auth_oauth_environment/README.rst b/auth_oauth_environment/README.rst new file mode 100644 index 000000000..11da697af --- /dev/null +++ b/auth_oauth_environment/README.rst @@ -0,0 +1,102 @@ +.. 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) + +Installation +============ + +To install this module, you need to have the server_environment module +installed and properly configured. + +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. + +'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``. + +For example, if you want to activate Google and Odoo.com, your +server_environment_files should look like this :: + + [auth_oauth.google] + enabled=True + client_id=123456789101-abcdefghijklmnopqrstuvwxyz000000 + + [auth_oauth.odoo.com] + 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]``. + + +Usage +===== + +Once configured, Odoo will read from server_environment_files the following +fields of auth.oauth.provider : + +* Allowed (``enabled``) +* Client ID (``client_id``) + + +Known issues / Roadmap +====================== + +* Due to the specific nature of this module, it cannot be tested on OCA runbot. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub 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. + +Credits +======= + +Images +------ + +* Odoo Community Association: `Icon `_. + +Contributors +------------ + +* Akim Juillerat + +Do not contact contributors directly about support or help with technical issues. + +Maintainer +---------- + +.. 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. diff --git a/auth_oauth_environment/__init__.py b/auth_oauth_environment/__init__.py new file mode 100644 index 000000000..0650744f6 --- /dev/null +++ b/auth_oauth_environment/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/auth_oauth_environment/__manifest__.py b/auth_oauth_environment/__manifest__.py new file mode 100644 index 000000000..13eedd1a7 --- /dev/null +++ b/auth_oauth_environment/__manifest__.py @@ -0,0 +1,20 @@ +# Copyright 2017 Camptocamp SA +# 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', + 'category': 'Tools', + 'summary': 'Configure mail servers with server_environment_files', + 'author': "Camptocamp SA, Odoo Community Association (OCA)", + 'license': 'AGPL-3', + 'website': 'http://odoo-community.org', + 'depends': [ + 'auth_oauth', + 'server_environment', + ], + 'data': [ + 'views/auth_oauth_provider.xml' + ], + 'auto_install': False, + 'installable': True, +} diff --git a/auth_oauth_environment/models/__init__.py b/auth_oauth_environment/models/__init__.py new file mode 100644 index 000000000..ed3b7b3a9 --- /dev/null +++ b/auth_oauth_environment/models/__init__.py @@ -0,0 +1,2 @@ +from . import auth_oauth_provider +from . import res_config_settings diff --git a/auth_oauth_environment/models/auth_oauth_provider.py b/auth_oauth_environment/models/auth_oauth_provider.py new file mode 100644 index 000000000..392f74ba7 --- /dev/null +++ b/auth_oauth_environment/models/auth_oauth_provider.py @@ -0,0 +1,61 @@ +# 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 fields, models, api, _ +from odoo.addons.server_environment import serv_config + + +class AuthOAuthProvider(models.Model): + + _inherit = 'auth.oauth.provider' + + managed_by_env = fields.Boolean(compute='_compute_server_env') + client_id = fields.Char(string='Client ID', compute='_compute_server_env') + enabled = fields.Boolean(string='Allowed', compute='_compute_server_env', + store=True) + + @api.depends('name') + def _compute_server_env(self): + + base_section = 'auth_oauth' + + for provider in self: + + provider_simple_name = provider.name.split(' ')[0].lower() + provider_section_name = '.'.join( + [base_section, provider_simple_name]) + + vals = {} + + 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) + + @api.model + def fields_view_get(self, view_id=None, view_type='form', toolbar=False, + submenu=False): + res = super(AuthOAuthProvider, self).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)) + + node.set('help', _('This field is managed through server ' + 'environment')) + res['arch'] = etree.tostring(doc, encoding='unicode') + return res diff --git a/auth_oauth_environment/models/res_config_settings.py b/auth_oauth_environment/models/res_config_settings.py new file mode 100644 index 000000000..99846fc75 --- /dev/null +++ b/auth_oauth_environment/models/res_config_settings.py @@ -0,0 +1,39 @@ +# 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 models, api, _ + + +class ResConfigSettings(models.TransientModel): + + _inherit = 'res.config.settings' + + @api.model + def fields_view_get(self, view_id=None, view_type='form', toolbar=False, + submenu=False): + res = super(ResConfigSettings, self).fields_view_get( + view_id=view_id, view_type=view_type, toolbar=toolbar, + submenu=submenu) + + google_provider = self.env.ref('auth_oauth.provider_google', + raise_if_not_found=False) + + if google_provider and google_provider.managed_by_env: + readonly_fields = ['module_auth_oauth', + 'auth_oauth_google_enabled', + 'auth_oauth_google_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)) + + node.set('help', _('This field is managed through server ' + 'environment')) + res['arch'] = etree.tostring(doc, encoding='unicode') + return res diff --git a/auth_oauth_environment/views/auth_oauth_provider.xml b/auth_oauth_environment/views/auth_oauth_provider.xml new file mode 100644 index 000000000..2cd19ea0a --- /dev/null +++ b/auth_oauth_environment/views/auth_oauth_provider.xml @@ -0,0 +1,16 @@ + + + + auth.oauth.provider.form.inherit + auth.oauth.provider + + + + + + + {'readonly': [('managed_by_env', '=', True)]} + + + + From 1df0cc59762e75d98f4b7dc4d9d93ecd7f90184f Mon Sep 17 00:00:00 2001 From: Akim Juillerat Date: Wed, 13 Dec 2017 14:24:47 +0100 Subject: [PATCH 2/5] Do not store enabled, code improvements --- .../models/auth_oauth_provider.py | 33 ++++++++++++------- 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/auth_oauth_environment/models/auth_oauth_provider.py b/auth_oauth_environment/models/auth_oauth_provider.py index 392f74ba7..0292477b2 100644 --- a/auth_oauth_environment/models/auth_oauth_provider.py +++ b/auth_oauth_environment/models/auth_oauth_provider.py @@ -13,33 +13,42 @@ 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', - store=True) + search='_search_enabled') - @api.depends('name') def _compute_server_env(self): - - base_section = 'auth_oauth' - for provider in self: - - provider_simple_name = provider.name.split(' ')[0].lower() - provider_section_name = '.'.join( - [base_section, provider_simple_name]) - + provider_section_name = provider._get_provider_section_name() vals = {} 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.one + def _get_provider_section_name(self): + return '.'.join(['auth_oauth', self.provider_simple_name]) + @api.model def fields_view_get(self, view_id=None, view_type='form', toolbar=False, submenu=False): From 2cfe8826625d354fc273eac2192d74eb8d3ccee4 Mon Sep 17 00:00:00 2001 From: Yannick Vaucher Date: Thu, 21 Dec 2017 18:54:29 +0100 Subject: [PATCH 3/5] Fix list type error on section_name --- .../models/auth_oauth_provider.py | 3 ++- .../static/description/icon.png | Bin 0 -> 9455 bytes 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 auth_oauth_environment/static/description/icon.png diff --git a/auth_oauth_environment/models/auth_oauth_provider.py b/auth_oauth_environment/models/auth_oauth_provider.py index 0292477b2..d9399403c 100644 --- a/auth_oauth_environment/models/auth_oauth_provider.py +++ b/auth_oauth_environment/models/auth_oauth_provider.py @@ -45,8 +45,9 @@ def _compute_simple_name(self): for provider in self: provider.provider_simple_name = provider.name.split(' ')[0].lower() - @api.one + @api.multi def _get_provider_section_name(self): + self.ensure_one() return '.'.join(['auth_oauth', self.provider_simple_name]) @api.model diff --git a/auth_oauth_environment/static/description/icon.png b/auth_oauth_environment/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 From 583c9fa0e88bd5236acc8dbd2546edfee6ba2388 Mon Sep 17 00:00:00 2001 From: Vincent Van Rossem Date: Wed, 19 Nov 2025 10:15:55 +0100 Subject: [PATCH 4/5] [IMP] auth_oauth_environment: pre-commit auto fixes --- auth_oauth_environment/__manifest__.py | 28 ++++----- .../models/auth_oauth_provider.py | 60 ++++++++++--------- .../models/res_config_settings.py | 43 +++++++------ auth_oauth_environment/pyproject.toml | 3 + .../views/auth_oauth_provider.xml | 6 +- 5 files changed, 76 insertions(+), 64 deletions(-) create mode 100644 auth_oauth_environment/pyproject.toml diff --git a/auth_oauth_environment/__manifest__.py b/auth_oauth_environment/__manifest__.py index 13eedd1a7..a5ea1147e 100644 --- a/auth_oauth_environment/__manifest__.py +++ b/auth_oauth_environment/__manifest__.py @@ -1,20 +1,18 @@ # Copyright 2017 Camptocamp SA # 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', - 'category': 'Tools', - 'summary': 'Configure mail servers with server_environment_files', - 'author': "Camptocamp SA, Odoo Community Association (OCA)", - 'license': 'AGPL-3', - 'website': 'http://odoo-community.org', - 'depends': [ - 'auth_oauth', - 'server_environment', + "name": "Auth oauth configuration with server_environment", + "version": "11.0.1.0.0", + "category": "Tools", + "summary": "Configure mail servers with server_environment_files", + "author": "Camptocamp SA, Odoo Community Association (OCA)", + "license": "AGPL-3", + "website": "https://github.com/OCA/server-env", + "depends": [ + "auth_oauth", + "server_environment", ], - 'data': [ - 'views/auth_oauth_provider.xml' - ], - 'auto_install': False, - 'installable': True, + "data": ["views/auth_oauth_provider.xml"], + "auto_install": False, + "installable": True, } diff --git a/auth_oauth_environment/models/auth_oauth_provider.py b/auth_oauth_environment/models/auth_oauth_provider.py index d9399403c..69d753583 100644 --- a/auth_oauth_environment/models/auth_oauth_provider.py +++ b/auth_oauth_environment/models/auth_oauth_provider.py @@ -2,21 +2,23 @@ # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). import json + from lxml import etree -from odoo import fields, models, api, _ +from odoo import _, api, fields, models + from odoo.addons.server_environment import serv_config class AuthOAuthProvider(models.Model): + _inherit = "auth.oauth.provider" - _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') + 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" + ) def _compute_server_env(self): for provider in self: @@ -24,48 +26,50 @@ def _compute_server_env(self): vals = {} if serv_config.has_section(provider_section_name): - - vals.update({'managed_by_env': True}) + vals.update({"managed_by_env": True}) vals.update(serv_config.items(provider_section_name)) else: - vals.update({'managed_by_env': False, 'enabled': False}) + 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'): + 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)] + 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() + 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]) + return ".".join(["auth_oauth", self.provider_simple_name]) @api.model - def fields_view_get(self, view_id=None, view_type='form', toolbar=False, - submenu=False): - res = super(AuthOAuthProvider, self).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']) + 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') + node.set("readonly", "1") modifiers = json.loads(node.get("modifiers")) - modifiers['readonly'] = True + modifiers["readonly"] = True node.set("modifiers", json.dumps(modifiers)) - node.set('help', _('This field is managed through server ' - 'environment')) - res['arch'] = etree.tostring(doc, encoding='unicode') + node.set( + "help", _("This field is managed through server " "environment") + ) + res["arch"] = etree.tostring(doc, encoding="unicode") return res diff --git a/auth_oauth_environment/models/res_config_settings.py b/auth_oauth_environment/models/res_config_settings.py index 99846fc75..adb4f416c 100644 --- a/auth_oauth_environment/models/res_config_settings.py +++ b/auth_oauth_environment/models/res_config_settings.py @@ -2,38 +2,43 @@ # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). import json + from lxml import etree -from odoo import models, api, _ +from odoo import _, api, models class ResConfigSettings(models.TransientModel): - - _inherit = 'res.config.settings' + _inherit = "res.config.settings" @api.model - def fields_view_get(self, view_id=None, view_type='form', toolbar=False, - submenu=False): - res = super(ResConfigSettings, self).fields_view_get( - view_id=view_id, view_type=view_type, toolbar=toolbar, - submenu=submenu) + 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 + ) - google_provider = self.env.ref('auth_oauth.provider_google', - raise_if_not_found=False) + google_provider = self.env.ref( + "auth_oauth.provider_google", raise_if_not_found=False + ) if google_provider and google_provider.managed_by_env: - readonly_fields = ['module_auth_oauth', - 'auth_oauth_google_enabled', - 'auth_oauth_google_client_id'] - doc = etree.XML(res['arch']) + readonly_fields = [ + "module_auth_oauth", + "auth_oauth_google_enabled", + "auth_oauth_google_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') + node.set("readonly", "1") modifiers = json.loads(node.get("modifiers")) - modifiers['readonly'] = True + modifiers["readonly"] = True node.set("modifiers", json.dumps(modifiers)) - node.set('help', _('This field is managed through server ' - 'environment')) - res['arch'] = etree.tostring(doc, encoding='unicode') + node.set( + "help", _("This field is managed through server " "environment") + ) + res["arch"] = etree.tostring(doc, encoding="unicode") return res diff --git a/auth_oauth_environment/pyproject.toml b/auth_oauth_environment/pyproject.toml new file mode 100644 index 000000000..4231d0ccc --- /dev/null +++ b/auth_oauth_environment/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/auth_oauth_environment/views/auth_oauth_provider.xml b/auth_oauth_environment/views/auth_oauth_provider.xml index 2cd19ea0a..39ecafe58 100644 --- a/auth_oauth_environment/views/auth_oauth_provider.xml +++ b/auth_oauth_environment/views/auth_oauth_provider.xml @@ -1,4 +1,4 @@ - + auth.oauth.provider.form.inherit @@ -9,7 +9,9 @@ - {'readonly': [('managed_by_env', '=', True)]} + {'readonly': [('managed_by_env', '=', True)]} From 2bd79d33c5087da8afa6c7f8cf1f4131b3f1b3db Mon Sep 17 00:00:00 2001 From: Vincent Van Rossem Date: Wed, 19 Nov 2025 13:20:01 +0100 Subject: [PATCH 5/5] [MIG] auth_oauth_environment: Migration to 17.0 --- auth_oauth_environment/README.rst | 133 +++-- auth_oauth_environment/__manifest__.py | 4 +- .../data/auth_oauth_provider.xml | 12 + auth_oauth_environment/models/__init__.py | 1 - .../models/auth_oauth_provider.py | 81 +-- .../models/res_config_settings.py | 44 -- auth_oauth_environment/readme/CONFIGURE.md | 27 + auth_oauth_environment/readme/CONTRIBUTORS.md | 3 + auth_oauth_environment/readme/DESCRIPTION.md | 3 + auth_oauth_environment/readme/INSTALL.md | 2 + auth_oauth_environment/readme/USAGE.md | 5 + .../static/description/index.html | 473 ++++++++++++++++++ auth_oauth_environment/tests/__init__.py | 1 + .../tests/test_auth_oauth_environment.py | 19 + .../views/auth_oauth_provider.xml | 18 - 15 files changed, 642 insertions(+), 184 deletions(-) create mode 100644 auth_oauth_environment/data/auth_oauth_provider.xml delete mode 100644 auth_oauth_environment/models/res_config_settings.py create mode 100644 auth_oauth_environment/readme/CONFIGURE.md create mode 100644 auth_oauth_environment/readme/CONTRIBUTORS.md create mode 100644 auth_oauth_environment/readme/DESCRIPTION.md create mode 100644 auth_oauth_environment/readme/INSTALL.md create mode 100644 auth_oauth_environment/readme/USAGE.md create mode 100644 auth_oauth_environment/static/description/index.html create mode 100644 auth_oauth_environment/tests/__init__.py create mode 100644 auth_oauth_environment/tests/test_auth_oauth_environment.py delete mode 100644 auth_oauth_environment/views/auth_oauth_provider.xml diff --git a/auth_oauth_environment/README.rst b/auth_oauth_environment/README.rst index 11da697af..e13a6b8ed 100644 --- a/auth_oauth_environment/README.rst +++ b/auth_oauth_environment/README.rst @@ -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 ============ @@ -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 +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 -`_. 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 `_. +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 `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Images ------- +Authors +------- -* Odoo Community Association: `Icon `_. +* Camptocamp SA Contributors ------------ -* Akim Juillerat +- `Camptocamp `__ -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 `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/auth_oauth_environment/__manifest__.py b/auth_oauth_environment/__manifest__.py index a5ea1147e..d754a386b 100644 --- a/auth_oauth_environment/__manifest__.py +++ b/auth_oauth_environment/__manifest__.py @@ -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)", @@ -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, } diff --git a/auth_oauth_environment/data/auth_oauth_provider.xml b/auth_oauth_environment/data/auth_oauth_provider.xml new file mode 100644 index 000000000..0927d0f96 --- /dev/null +++ b/auth_oauth_environment/data/auth_oauth_provider.xml @@ -0,0 +1,12 @@ + + + + provider_openerp + + + provider_facebook + + + provider_google + + diff --git a/auth_oauth_environment/models/__init__.py b/auth_oauth_environment/models/__init__.py index ed3b7b3a9..4bc62d3ab 100644 --- a/auth_oauth_environment/models/__init__.py +++ b/auth_oauth_environment/models/__init__.py @@ -1,2 +1 @@ from . import auth_oauth_provider -from . import res_config_settings diff --git a/auth_oauth_environment/models/auth_oauth_provider.py b/auth_oauth_environment/models/auth_oauth_provider.py index 69d753583..65ba5ddfb 100644 --- a/auth_oauth_environment/models/auth_oauth_provider.py +++ b/auth_oauth_environment/models/auth_oauth_provider.py @@ -1,75 +1,24 @@ # 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 import api, models 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" - ) - - def _compute_server_env(self): - for provider in self: - provider_section_name = provider._get_provider_section_name() - vals = {} - - 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]) + _name = "auth.oauth.provider" + _inherit = ["auth.oauth.provider", "server.env.techname.mixin", "server.env.mixin"] + + @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)) - - node.set( - "help", _("This field is managed through server " "environment") - ) - res["arch"] = etree.tostring(doc, encoding="unicode") - return res + def _server_env_global_section_name(self): + return "auth_oauth" diff --git a/auth_oauth_environment/models/res_config_settings.py b/auth_oauth_environment/models/res_config_settings.py deleted file mode 100644 index adb4f416c..000000000 --- a/auth_oauth_environment/models/res_config_settings.py +++ /dev/null @@ -1,44 +0,0 @@ -# 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, models - - -class ResConfigSettings(models.TransientModel): - _inherit = "res.config.settings" - - @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 - ) - - google_provider = self.env.ref( - "auth_oauth.provider_google", raise_if_not_found=False - ) - - if google_provider and google_provider.managed_by_env: - readonly_fields = [ - "module_auth_oauth", - "auth_oauth_google_enabled", - "auth_oauth_google_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)) - - node.set( - "help", _("This field is managed through server " "environment") - ) - res["arch"] = etree.tostring(doc, encoding="unicode") - return res diff --git a/auth_oauth_environment/readme/CONFIGURE.md b/auth_oauth_environment/readme/CONFIGURE.md new file mode 100644 index 000000000..9ac4dcd74 --- /dev/null +++ b/auth_oauth_environment/readme/CONFIGURE.md @@ -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]``. diff --git a/auth_oauth_environment/readme/CONTRIBUTORS.md b/auth_oauth_environment/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..a8a8313d1 --- /dev/null +++ b/auth_oauth_environment/readme/CONTRIBUTORS.md @@ -0,0 +1,3 @@ +- [Camptocamp](https://www.camptocamp.com) + - Akim Juillerat + - Vincent Van Rossem > diff --git a/auth_oauth_environment/readme/DESCRIPTION.md b/auth_oauth_environment/readme/DESCRIPTION.md new file mode 100644 index 000000000..d4a49f689 --- /dev/null +++ b/auth_oauth_environment/readme/DESCRIPTION.md @@ -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) diff --git a/auth_oauth_environment/readme/INSTALL.md b/auth_oauth_environment/readme/INSTALL.md new file mode 100644 index 000000000..9b4807850 --- /dev/null +++ b/auth_oauth_environment/readme/INSTALL.md @@ -0,0 +1,2 @@ +To install this module, you need to have the server_environment module +installed and properly configured. diff --git a/auth_oauth_environment/readme/USAGE.md b/auth_oauth_environment/readme/USAGE.md new file mode 100644 index 000000000..dd4e95b7f --- /dev/null +++ b/auth_oauth_environment/readme/USAGE.md @@ -0,0 +1,5 @@ +Once configured, Odoo will read from server_environment_files the following +fields of auth.oauth.provider : + +* Allowed (``enabled``) +* Client ID (``client_id``) diff --git a/auth_oauth_environment/static/description/index.html b/auth_oauth_environment/static/description/index.html new file mode 100644 index 000000000..273af186a --- /dev/null +++ b/auth_oauth_environment/static/description/index.html @@ -0,0 +1,473 @@ + + + + + +Auth oauth configuration with server_environment + + + +
+

Auth oauth configuration with server_environment

+ + +

Beta License: AGPL-3 OCA/server-env Translate me on Weblate Try me on Runboat

+

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

+ +
+

Installation

+

To install this module, you need to have the server_environment module +installed and properly configured.

+
+
+

Configuration

+

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].

+
+
+

Usage

+

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

+
    +
  • Allowed (enabled)
    • +
  • Client ID (client_id)
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp SA
    • +
+
+ +
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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.

+

This module is part of the OCA/server-env project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/auth_oauth_environment/tests/__init__.py b/auth_oauth_environment/tests/__init__.py new file mode 100644 index 000000000..8656ffddb --- /dev/null +++ b/auth_oauth_environment/tests/__init__.py @@ -0,0 +1 @@ +from . import test_auth_oauth_environment diff --git a/auth_oauth_environment/tests/test_auth_oauth_environment.py b/auth_oauth_environment/tests/test_auth_oauth_environment.py new file mode 100644 index 000000000..ea9719405 --- /dev/null +++ b/auth_oauth_environment/tests/test_auth_oauth_environment.py @@ -0,0 +1,19 @@ +# Copyright 2024 Camptocamp (https://www.camptocamp.com). +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html) + + +from odoo.addons.server_environment.tests.common import ServerEnvironmentCase + +custom_config = """ +[auth_oauth.provider_google] +client_id = YOUR_OAUTH_GOOGLE_CLIENT_ID +enabled = True +""" + + +class TestAuthOAuthEnvironment(ServerEnvironmentCase): + def test_auth_oauth_provider(self): + provider_google = self.env.ref("auth_oauth.provider_google", False) + with self.load_config(public=custom_config): + self.assertEqual(provider_google.client_id, "YOUR_OAUTH_GOOGLE_CLIENT_ID") + self.assertTrue(provider_google.enabled) diff --git a/auth_oauth_environment/views/auth_oauth_provider.xml b/auth_oauth_environment/views/auth_oauth_provider.xml deleted file mode 100644 index 39ecafe58..000000000 --- a/auth_oauth_environment/views/auth_oauth_provider.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - - auth.oauth.provider.form.inherit - auth.oauth.provider - - - - - - - {'readonly': [('managed_by_env', '=', True)]} - - - -