Files
server-backend/base_suspend_security/README.rst
Pedro M. Baeza 4ee3ee65c4 [FIX] base_suspend_security: Adapt to upstream
On 9af8b31d921dcccb7bcf230271fd3ef4R4329, a new keyword argument was added
for `_browse`, so any overriding needs to add that argument, as it's the case
for this module.
2019-02-13 15:42:13 +01:00

65 lines
2.1 KiB
ReStructuredText

.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
:alt: License: AGPL-3
Suspend security
================
This module was written to allow you to call code with some `uid` while being sure no security checks (`ir.model.access` and `ir.rule`) are done. In this way, it's the same as `sudo()`, but the crucial difference is that the code still runs with the original user id. This can be important for inherited code that calls workflow functions, subscribes the current user to some object, etc.
Usually, you'll be in in the situation to want something like this if you inherit from a module you can't or don't want to change, and call `super()`.
Installation
============
This version is only valid for being used since Odoo commit
9af8b31d921dcccb7bcf230271fd3ef4R4329 (merged on 2019-02-04).
Usage
=====
To use this module, you need to:
* depend on this module
* call `yourmodel.suspend_security().function_to_run()`, just the same as you would use `sudo()`
For further information, please visit:
* https://www.odoo.com/forum/help-1
Known issues / Roadmap
======================
* the magic works by wrapping uid in a marker class, so if some code unwraps this in the calling tree, security checks will be reenabled
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.
Credits
=======
Contributors
------------
* Holger Brunn <hbrunn@therp.nl>
* Laurent Mignon <laurent.mignon@acsone.eu>
* Frédéric Garbely <frederic.garbely@braintec-group.com>
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 http://odoo-community.org.