kallithea Files · docs/usage/locking.rst

Files @ 58931c2b6b0c

Branch filter:

Location: kallithea/docs/usage/locking.rst

58931c2b6b0c 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

domruf

lock: fix encoding error when Mercurial emits a localized warning with the Kallithea "repository locked" message

Mercurial use (utf8) encoded localized messages. Things failed when it tried to
convert the encoded Mercurial format string to unicode so it could insert
Kallithea's unicode (but ascii compatible) "repository locked" exception
string.

That could for example be reproduced by running the (manual) vcs test
test_push_on_locked_repo_by_other_user_hg with environment LANG=de_DE for the
server side.

To fix this, make sure the "repository locked" message is encoded so Mercurial
handles it correctly.

.. _locking:

==================
Repository locking
==================

Kallithea has a *repository locking* feature, disabled by default. When
enabled, every initial clone and every pull gives users (with write permission)
the exclusive right to do a push.

When repository locking is enabled, repositories get a ``locked`` flag.
The hg/git commands ``hg/git clone``, ``hg/git pull``,
and ``hg/git push`` influence this state:

- A ``clone`` or ``pull`` action locks the target repository
  if the user has write/admin permissions on this repository.

- Kallithea will remember the user who locked the repository so only this
  specific user can unlock the repo by performing a ``push``
  command.

- Every other command on a locked repository from this user and every command
  from any other user will result in an HTTP return code 423 (Locked).
  Additionally, the HTTP error will mention the user that locked the repository
  (e.g., “repository <repo> locked by user <user>”).

Each repository can be manually unlocked by an administrator from the
repository settings menu.