Веб-контролери¶

Контролери¶

Контролери мають забезпечувати розширюваність, подібно до Model, але не можуть використовувати той самий механізм, оскільки передумови (база даних із завантаженими модулями) ще можуть бути недоступні (наприклад, база даних не створена) , або база даних не вибрана).

Таким чином, контролери забезпечують власний механізм розширення, окремий від механізму моделей:

Контролери створюються шляхом успадкування від Controller. Маршрути визначаються за допомогою методів, прикрашених route():

class MyController(odoo.http.Controller):
    @route('/some_url', auth='public')
    def handler(self):
        return stuff()

Щоб замінити контролер, успадкуйте з його класу та перевизначте відповідні методи, повторно показуючи їх, якщо необхідно:

class Extension(MyController):
    @route()
    def handler(self):
        do_before()
        return super(Extension, self).handler()

прикрашання за допомогою route() необхідне, щоб метод (і маршрут) залишався видимим: якщо метод перевизначено без прикрашання, він буде «не опублікований»
декоратори всіх методів поєднуються, якщо декоратор методу, що перекриває, не має аргументів, усі попередні будуть збережені, будь-який наданий аргумент замінить попередньо визначені, наприклад:
```
class Restrict(MyController):
    @route(auth='user')
    def handler(self):
        return super(Restrict, self).handler()
```
змінить /some_url з загальнодоступної автентифікації на користувача (потрібно ввійти в систему)

API¶

Маршрути¶

@odoo.http.route(route=None, **routing)[source]¶

Decorate a controller method in order to route incoming requests matching the given URL and options to the decorated method.

Попередження

It is mandatory to re-decorate any method that is overridden in controller extensions but the arguments can be omitted. See Controller for more details.

Параметри

route (Union[str, Iterable[str]]) – The paths that the decorated method is serving. Incoming HTTP request paths matching this route will be routed to this decorated method. See werkzeug routing documentation for the format of route expressions.
type (str) – The type of request, either 'json' or 'http'. It describes where to find the request parameters and how to serialize the response.
auth (str) –
The authentication method, one of the following:
- 'user': The user must be authenticated and the current request will be executed using the rights of the user.
- 'public': The user may or may not be authenticated. If he isn’t, the current request will be executed using the shared Public user.
- 'none': The method is always active, even if there is no database. Mainly used by the framework and authentication modules. The request code will not have any facilities to access the current user.
methods (Iterable[str]) – A list of http methods (verbs) this route applies to. If not specified, all methods are allowed.
cors (str) – Значення директиви Access-Control-Allow-Origin cors.
csrf (bool) – Whether CSRF protection should be enabled for the route. Enabled by default for 'http'-type requests, disabled by default for 'json'-type requests.
handle_params_access_error (Callable[[Exception], Response]) – Implement a custom behavior if an error occurred when retrieving the record from the URL parameters (access error or missing error).

Запит¶

The request object is automatically set on odoo.http.request at the start of the request.

class odoo.http.Request(httprequest)[source]¶

Wrapper around the incoming HTTP request with deserialized request parameters, session utilities and request dispatching logic.

update_env(user=None, context=None, su=None)[source]¶

Update the environment of the current request.

Параметри

user (int or res.users record) – optional user/user id to change the current user
context (dict) – optional context dictionary to change the current context
su (bool) – optional boolean to change the superuser mode

update_context(**overrides)[source]¶: Override the environment context of the current request with the values of overrides. To replace the entire context, please use update_env() instead.

csrf_token(time_limit=None)[source]¶

Створює та повертає маркер CSRF для поточного сеансу

Параметри: time_limit (Optional[int]) – the CSRF token should only be valid for the specified duration (in second), by default 48h, None for the token to be valid as long as the current user’s session is.
Повертає: Рядок маркера ASCII
Тип повернення: str

validate_csrf(csrf)[source]¶

Is the given csrf token valid ?

Параметри: csrf (str) – The token to validate.
Повертає: True when valid, False when not.
Тип повернення: bool

default_lang()[source]¶

Returns default user language according to request specification

Повертає: Preferred language if specified or „en_US“
Тип повернення: str

get_http_params()[source]¶

Extract key=value pairs from the query string and the forms present in the body (both application/x-www-form-urlencoded and multipart/form-data).

Повертає: The merged key-value pairs.
Тип повернення: dict

make_response(data, headers=None, cookies=None, status=200)[source]¶

Помічник для відповідей не у форматі HTML або відповідей у форматі HTML із спеціальними заголовками відповідей або файлами cookie.

Хоча обробники можуть просто повернути розмітку HTML сторінки, яку вони хочуть надіслати як рядок, якщо повертаються дані, що не є HTML, їм потрібно створити повний об’єкт відповіді, інакше повернуті дані не будуть правильно інтерпретовані клієнтами.

Параметри

data (str) – тіло відповіді
status (int) – http status code
headers ([(name, value)]) – Заголовки HTTP для встановлення у відповіді
cookies (collections.abc.Mapping) – файли cookie для встановлення на клієнті

Повертає

a response object.

Тип повернення

Response

make_json_response(data, headers=None, cookies=None, status=200)[source]¶

Helper for JSON responses, it json-serializes data and sets the Content-Type header accordingly if none is provided.

Параметри

data – the data that will be json-serialized into the response body
status (int) – http status code
headers (List[(str, str)]) – Заголовки HTTP для встановлення у відповіді
cookies (collections.abc.Mapping) – файли cookie для встановлення на клієнті

Тип повернення

Response

not_found(description=None)[source]¶: Ярлик для відповіді HTTP 404 (Не знайдено)

render(template, qcontext=None, lazy=True, **kw)[source]¶

Відкладений рендеринг шаблону QWeb.

Фактична візуалізація заданого шаблону відбудеться після завершення розсилки. Тим часом шаблон і/або qcontext можна змінити або навіть замінити статичною відповіддю.

Параметри

template (str) – шаблон для візуалізації
qcontext (dict) – Візуалізація контексту для використання
lazy (bool) – чи слід відкласти візуалізацію шаблону до останнього можливого моменту
kw (dict) – пересилається до об’єкта Werkzeug Response

class odoo.http.JsonRPCDispatcher(request)[source]¶

classmethod is_compatible_with(request)[source]¶: Determine if the current request is compatible with this dispatcher.

dispatch(endpoint, args)[source]¶

JSON-RPC 2 over HTTP.

Our implementation differs from the specification on two points:

The method member of the JSON-RPC request payload is ignored as the HTTP path is already used to route the request to the controller.
We only support parameter structures by-name, i.e. the params member of the JSON-RPC request payload MUST be a JSON Object and not a JSON Array.

In addition, it is possible to pass a context that replaces the session context via a special context argument that is removed prior to calling the endpoint.

Successful request:

--> {"jsonrpc": "2.0", "method": "call", "params": {"arg1": "val1" }, "id": null}

<-- {"jsonrpc": "2.0", "result": { "res1": "val1" }, "id": null}

Запит викликає помилку:

--> {"jsonrpc": "2.0", "method": "call", "params": {"arg1": "val1" }, "id": null}

<-- {"jsonrpc": "2.0", "error": {"code": 1, "message": "End user error message.", "data": {"code": "codestring", "debug": "traceback" } }, "id": null}

handle_error(exc: Exception) → collections.abc.Callable[source]¶

Handle any exception that occurred while dispatching a request to a type='json' route. Also handle exceptions that occurred when no route matched the request path, that no fallback page could be delivered and that the request Content-Type was json.

Параметри: exc – the exception that occurred.
Повертає: a WSGI application

class odoo.http.HttpDispatcher(request)[source]¶

classmethod is_compatible_with(request)[source]¶: Determine if the current request is compatible with this dispatcher.

dispatch(endpoint, args)[source]¶

Perform http-related actions such as deserializing the request body and query-string and checking cors/csrf while dispatching a request to a type='http' route.

See load() method for the compatible endpoint return types.

handle_error(exc: Exception) → collections.abc.Callable[source]¶

Handle any exception that occurred while dispatching a request to a type='http' route. Also handle exceptions that occurred when no route matched the request path, when no fallback page could be delivered and that the request Content-Type was not json.

Параметри: exc (Exception) – the exception that occurred.
Повертає: a WSGI application

Відповідь¶

class odoo.http.Response(*args, **kw)[source]¶

Outgoing HTTP response with body, status, headers and qweb support. In addition to the werkzeug.wrappers.Response parameters, this class’s constructor can take the following additional parameters for QWeb Lazy Rendering.

Параметри

template (str) – шаблон для візуалізації
qcontext (dict) – Візуалізація контексту для використання
uid (int) – Ідентифікатор користувача для виклику рендерингу ir.ui.view, None для використання користувача запиту (за замовчуванням)

ці атрибути доступні як параметри в об’єкті Response і можуть бути змінені в будь-який час перед відтворенням

Також розкриває всі атрибути та методи werkzeug.wrappers.Response.

classmethod load(result, fname='<function>')[source]¶

Convert the return value of an endpoint into a Response.

Параметри

result (Union[Response, werkzeug.wrappers.BaseResponse, werkzeug.exceptions.HTTPException, str, bytes, NoneType]) – The endpoint return value to load the Response from.
fname (str) – The endpoint function name wherefrom the result emanated, used for logging.

Повертає

The created Response.

Тип повернення

Response

Викликає

TypeError – When result type is none of the above- mentioned type.

render()[source]¶: Renders the Response’s template, returns the result.

flatten()[source]¶: Примусово відтворює шаблон відповіді, встановлює результат як тіло відповіді та скасовує template

set_cookie(key, value='', max_age=None, expires=- 1, path='/', domain=None, secure=False, httponly=False, samesite=None, cookie_type='required')[source]¶: The default expires in Werkzeug is None, which means a session cookie. We want to continue to support the session cookie, but not by default. Now the default is arbitrary 1 year. So if you want a cookie of session, you have to explicitly pass expires=None.

Edit on GitHub