kallithea Changeset - 9937ae52f167

Changeset - 9937ae52f167

Parent rev.

Child rev.

[Not reviewed]

default

0 4 0

Mads Kiilerich - 7 years ago 2018-06-09 16:28:33
mads@kiilerich.com

hg: set encoding to utf-8 by default to always show unicode characters correctly

Unicode characters would be shown as '?' if Kallithea was launched in a LANG=C
environment (or similar).

The problem could be solved by setting HGENCODING before launching Kallithea or
before importing Mercurial. These are often not good solutions.

Instead, introduce a hgencoding config setting that triggers monkey patching of
Mercurial.

4 files changed with 15 insertions and 1 deletions:

development.ini

docs/setup.rst

kallithea/config/app_cfg.py

kallithea/lib/paster_commands/template.ini.mako

0 comments (0 inline, 0 general)

development.ini

➞

Show inline comments

@@ @@ -157,12 +157,15 @@ api_access_controllers_whitelist = @@
 #    FilesController:archivefile
 ## default encoding used to convert from and to unicode
 ## can be also a comma separated list of encoding in case of mixed encodings
 default_encoding = utf8
 ## Set Mercurial encoding, similar to setting HGENCODING before launching Kallithea
 hgencoding = utf-8
 ## issue tracker for Kallithea (leave blank to disable, absent for default)
 #bugtracker = https://bitbucket.org/conservancy/kallithea/issues
 ## issue tracking mapping for commit messages, comments, PR descriptions, ...
 ## Refer to the documentation ("Integration with issue trackers") for more details.

docs/setup.rst

➞

Show inline comments

@@ @@ -630,12 +630,15 @@ By default, Kallithea uses UTF-8 encodin @@
 This is configurable as ``default_encoding`` in the .ini file.
 This affects many parts in Kallithea including user names, filenames, and
 encoding of commit messages. In addition Kallithea can detect if the ``chardet``
 library is installed. If ``chardet`` is detected Kallithea will fallback to it
 when there are encode/decode errors.
 The Mercurial encoding is configurable as ``hgencoding``. It is similar to
 setting the ``HGENCODING`` environment variable, but will override it.
 Celery configuration
 --------------------
 Kallithea can use the distributed task queue system Celery_ to run tasks like
 cloning repositories or sending emails.
@@ @@ -891,13 +894,12 @@ WSGIDaemonProcess to set the name of the @@
 Example WSGI dispatch script:
 .. code-block:: python
     import os
     os.environ["HGENCODING"] = "UTF-8"
     os.environ['PYTHON_EGG_CACHE'] = '/srv/kallithea/.egg-cache'
     # sometimes it's needed to set the current dir
     os.chdir('/srv/kallithea/')
     import site

kallithea/config/app_cfg.py

➞

Show inline comments

@@ @@ -25,12 +25,13 @@ from tg import hooks @@
 from tg.configuration import AppConfig
 from tg.support.converters import asbool
 import alembic.config
 from alembic.script.base import ScriptDirectory
 from alembic.migration import MigrationContext
 from sqlalchemy import create_engine
 import mercurial
 from kallithea.lib.middleware.https_fixup import HttpsFixup
 from kallithea.lib.middleware.simplegit import SimpleGit
 from kallithea.lib.middleware.simplehg import SimpleHg
 from kallithea.lib.auth import set_available_permissions
 from kallithea.lib.utils import load_rcextensions, make_ui, set_app_settings, set_vcs_config, \
@@ @@ -116,12 +117,17 @@ else: @@
     enable_debugbar(base_config)
 def setup_configuration(app):
     config = app.config
     # Mercurial sets encoding at module import time, so we have to monkey patch it
     hgencoding = config.get('hgencoding')
     if hgencoding:
         mercurial.encoding.encoding = hgencoding
     if config.get('ignore_alembic_revision', False):
         log.warn('database alembic revision checking is disabled')
     else:
         dbconf = config['sqlalchemy.url']
         alembic_cfg = alembic.config.Config()
         alembic_cfg.set_main_option('script_location', 'kallithea:alembic')

kallithea/lib/paster_commands/template.ini.mako

➞

Show inline comments

@@ @@ -251,12 +251,15 @@ api_access_controllers_whitelist = @@
 #    FilesController:archivefile
 <%text>## default encoding used to convert from and to unicode</%text>
 <%text>## can be also a comma separated list of encoding in case of mixed encodings</%text>
 default_encoding = utf8
 <%text>## Set Mercurial encoding, similar to setting HGENCODING before launching Kallithea</%text>
 hgencoding = utf-8
 <%text>## issue tracker for Kallithea (leave blank to disable, absent for default)</%text>
 #bugtracker = https://bitbucket.org/conservancy/kallithea/issues
 <%text>## issue tracking mapping for commit messages, comments, PR descriptions, ...</%text>
 <%text>## Refer to the documentation ("Integration with issue trackers") for more details.</%text>

0 comments (0 inline, 0 general)