erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

plugin XEP-0277, doc: conflict is now checked and avoided if user_friendly_id_suffix is False, doc updated

Browse source
This commit is contained in:
Goffi 2023-12-05 13:39:03 +01:00
commit d80c4e89dc
2 changed files with 29 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/libervia-cli/blog.rst
View file

@ -17,11 +17,17 @@ The `set` and `edit` commands support a range of options for customizing blog po
``--no-id-suffix``
This option removes the randomly generated suffix from the auto-generated, user-friendly ID. The suffix is initially added to ensure unique IDs, especially useful when two posts have similar titles. Use this option with caution, as it may lead to ID conflicts and potential overwriting of existing posts.
This option removes the randomly generated suffix from the auto-generated,
user-friendly ID. The suffix is initially added to ensure unique IDs, especially useful
when two posts have similar titles.
.. warning::
.. note::
Use this option judiciously to avoid unintended overwriting of blog posts.
When the ``--no-id-suffix`` option is selected, an extra validation is performed to
check for ID uniqueness. If an existing item already uses the same ID, a suffix is
added to the new ID regardless of the option, ensuring no existing content is
overwritten. This additional check incurs a slight performance impact due to the
extra request needed.
``--alt-link URL [MEDIA_TYPE]``

22
libervia/backend/plugins/plugin_xep_0277.py
View file

@ -1068,8 +1068,26 @@ class XEP_0277(object):
if item_id is None:
if data.get("user_friendly_id", True):
item_id = self.friendly_id(data)
else:
item_id = str(shortuuid.uuid())
if not data.get("user_friendly_id_suffix", True):
# we have no random suffix, which can lead to conflict, so we check if
# the item doesn't already exist, and change ID if it's the case.
try:
items, __ = await self._p.get_items(
client,
service,
node,
item_ids = [item_id]
)
except exceptions.NotFound:
pass
else:
# the item already exists
log.info(
f"there is already an item with ID {item_id}, we have to "
' set the "user_friendly_id_suffix" flag.'
)
data["user_friendly_id_suffix"] = True
item_id = self.friendly_id(data)
try:
await self._manage_comments(client, data, service, node, item_id, access=None)