annotate sat_pubsub/const.py @ 414:ccb2a22ea0fc

Python 3 port: /!\ Python 3.6+ is now needed to use SàT Pubsub /!\ instability may occur and features may not be working anymore, this will improve with time The same procedure as in backend has been applied (check backend commit ab2696e34d29 logs for details). Python minimal version has been updated in setup.py
author Goffi <goffi@goffi.org>
date Fri, 16 Aug 2019 12:53:33 +0200
parents c56a728412f1
children c21f31355ab9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
414
ccb2a22ea0fc Python 3 port:
Goffi <goffi@goffi.org>
parents: 405
diff changeset
1 #!/usr/bin/env python3
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
2 #-*- coding: utf-8 -*-
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
3
384
aa3a464df605 dates update
Goffi <goffi@goffi.org>
parents: 369
diff changeset
4 # Copyright (c) 2012-2019 Jérôme Poisson
312
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
5 # Copyright (c) 2013-2016 Adrien Cossa
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
6 # Copyright (c) 2003-2011 Ralph Meijer
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
7
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
8
312
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
9 # This program is free software: you can redistribute it and/or modify
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
10 # it under the terms of the GNU Affero General Public License as published by
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
11 # the Free Software Foundation, either version 3 of the License, or
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
12 # (at your option) any later version.
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
13
312
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
14 # This program is distributed in the hope that it will be useful,
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
17 # GNU Affero General Public License for more details.
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
18
312
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
19 # You should have received a copy of the GNU Affero General Public License
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
20 # along with this program. If not, see <http://www.gnu.org/licenses/>.
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
21 # --
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
22
312
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
23 # This program is based on Idavoll (http://idavoll.ik.nu/),
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
24 # originaly written by Ralph Meijer (http://ralphm.net/blog/)
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
25 # It is sublicensed under AGPL v3 (or any later version) as allowed by the original
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
26 # license.
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
27
312
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
28 # --
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
29
312
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
30 # Here is a copy of the original license:
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
31
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
32 # Copyright (c) 2003-2011 Ralph Meijer
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
33
312
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
34 # Permission is hereby granted, free of charge, to any person obtaining
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
35 # a copy of this software and associated documentation files (the
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
36 # "Software"), to deal in the Software without restriction, including
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
37 # without limitation the rights to use, copy, modify, merge, publish,
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
38 # distribute, sublicense, and/or sell copies of the Software, and to
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
39 # permit persons to whom the Software is furnished to do so, subject to
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
40 # the following conditions:
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
41
312
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
42 # The above copyright notice and this permission notice shall be
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
43 # included in all copies or substantial portions of the Software.
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
44
312
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
45 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
46 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
47 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
48 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
49 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
50 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
5d7c3787672e fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents: 311
diff changeset
51 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
52
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
53
322
54d90c73b8b5 mam: various improvments:
Goffi <goffi@goffi.org>
parents: 312
diff changeset
54 NS_CLIENT = 'jabber:client'
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
55 NS_GROUPBLOG_PREFIX = 'urn:xmpp:groupblog:'
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
56 NS_ITEM_CONFIG = "http://jabber.org/protocol/pubsub#item-config"
301
05c875a13a62 categories are now stored in a dedicated table if item contain an atom entry:
Goffi <goffi@goffi.org>
parents: 294
diff changeset
57 NS_ATOM = "http://www.w3.org/2005/Atom"
322
54d90c73b8b5 mam: various improvments:
Goffi <goffi@goffi.org>
parents: 312
diff changeset
58 NS_FORWARD = 'urn:xmpp:forward:0'
352
efbdca10f0fb schema: node schema implementation
Goffi <goffi@goffi.org>
parents: 330
diff changeset
59 NS_SCHEMA = 'https://salut-a-toi/protocol/schema:0'
efbdca10f0fb schema: node schema implementation
Goffi <goffi@goffi.org>
parents: 330
diff changeset
60 NS_SCHEMA_RESTRICT = 'https://salut-a-toi/protocol/schema#restrict:0'
efbdca10f0fb schema: node schema implementation
Goffi <goffi@goffi.org>
parents: 330
diff changeset
61
250
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
62 OPT_ACCESS_MODEL = 'pubsub#access_model'
eb14b8d30cba fine tuning per-item permissions
Goffi <goffi@goffi.org>
parents:
diff changeset
63 OPT_ROSTER_GROUPS_ALLOWED = 'pubsub#roster_groups_allowed'
294
df1edebb0466 PEP implementation, draft (huge patch sorry):
Goffi <goffi@goffi.org>
parents: 283
diff changeset
64 OPT_PERSIST_ITEMS = "pubsub#persist_items"
df1edebb0466 PEP implementation, draft (huge patch sorry):
Goffi <goffi@goffi.org>
parents: 283
diff changeset
65 OPT_DELIVER_PAYLOADS = "pubsub#deliver_payloads"
df1edebb0466 PEP implementation, draft (huge patch sorry):
Goffi <goffi@goffi.org>
parents: 283
diff changeset
66 OPT_SEND_LAST_PUBLISHED_ITEM = "pubsub#send_last_published_item"
260
f0cd02c032b3 publish model management
Goffi <goffi@goffi.org>
parents: 259
diff changeset
67 OPT_PUBLISH_MODEL = 'pubsub#publish_model'
367
a772f7dac930 backend, storage(pgsql): creation/update date + serial ids:
Goffi <goffi@goffi.org>
parents: 365
diff changeset
68 OPT_SERIAL_IDS = 'pubsub#serial_ids'
403
1dc606612405 implemented experimental "consistent_publisher" option:
Goffi <goffi@goffi.org>
parents: 384
diff changeset
69 OPT_CONSISTENT_PUBLISHER = 'pubsub#consistent_publisher'
259
6fe7da6b4b32 node "roster" access model management
Goffi <goffi@goffi.org>
parents: 255
diff changeset
70 VAL_AMODEL_OPEN = 'open'
354
18b983fe9e1b backend: added "presence" access_model:
Goffi <goffi@goffi.org>
parents: 352
diff changeset
71 VAL_AMODEL_PRESENCE = 'presence'
330
82d1259b3e36 backend, pgsql storage: better items/notification handling, various fixes:
Goffi <goffi@goffi.org>
parents: 323
diff changeset
72 VAL_AMODEL_PUBLISHER_ROSTER = 'publisher-roster'
82d1259b3e36 backend, pgsql storage: better items/notification handling, various fixes:
Goffi <goffi@goffi.org>
parents: 323
diff changeset
73 VAL_AMODEL_WHITELIST = 'whitelist'
82d1259b3e36 backend, pgsql storage: better items/notification handling, various fixes:
Goffi <goffi@goffi.org>
parents: 323
diff changeset
74 VAL_AMODEL_PUBLISH_ONLY = 'publish-only'
82d1259b3e36 backend, pgsql storage: better items/notification handling, various fixes:
Goffi <goffi@goffi.org>
parents: 323
diff changeset
75 VAL_AMODEL_SELF_PUBLISHER = 'self-publisher'
259
6fe7da6b4b32 node "roster" access model management
Goffi <goffi@goffi.org>
parents: 255
diff changeset
76 VAL_AMODEL_DEFAULT = VAL_AMODEL_OPEN
330
82d1259b3e36 backend, pgsql storage: better items/notification handling, various fixes:
Goffi <goffi@goffi.org>
parents: 323
diff changeset
77 VAL_AMODEL_ALL = (VAL_AMODEL_OPEN, VAL_AMODEL_PUBLISHER_ROSTER, VAL_AMODEL_WHITELIST, VAL_AMODEL_PUBLISH_ONLY, VAL_AMODEL_SELF_PUBLISHER)
260
f0cd02c032b3 publish model management
Goffi <goffi@goffi.org>
parents: 259
diff changeset
78 VAL_PMODEL_PUBLISHERS = 'publishers'
f0cd02c032b3 publish model management
Goffi <goffi@goffi.org>
parents: 259
diff changeset
79 VAL_PMODEL_SUBSCRIBERS = 'subscribers'
f0cd02c032b3 publish model management
Goffi <goffi@goffi.org>
parents: 259
diff changeset
80 VAL_PMODEL_OPEN = 'open'
f0cd02c032b3 publish model management
Goffi <goffi@goffi.org>
parents: 259
diff changeset
81 VAL_PMODEL_DEFAULT = VAL_PMODEL_PUBLISHERS
322
54d90c73b8b5 mam: various improvments:
Goffi <goffi@goffi.org>
parents: 312
diff changeset
82 VAL_RSM_MAX_DEFAULT = 10 # None for no limit
278
8a71486c3e95 implements RSM (XEP-0059)
souliane <souliane@mailoo.org>
parents: 263
diff changeset
83 FLAG_ENABLE_RSM = True
280
798cb8962c0b MAM (XEP-0313) support: first draft
souliane <souliane@mailoo.org>
parents: 278
diff changeset
84 FLAG_ENABLE_MAM = True
323
8496af26be45 mam: added filtering by category
Goffi <goffi@goffi.org>
parents: 322
diff changeset
85 MAM_FILTER_CATEGORY = 'http://salut-a-toi.org/protocols/mam_filter_category'