Add CINDER_LOCALEDIR env variable

Part of fixing bug #995287

Syncs these two commits from oslo-incubator:

  Support overriding oslo localedir too
  Add a gettextutils.install() helper function

to get a new gettextutils.install() function which allows the default
localedir to be overwritten via an environment variable.

Note that gettextutils.install() must be called before any other cinder
modules are imported since some modules attempt to translate strings
at import time (e.g. in cinder.flags). This is broken and inefficient,
but fixing it involves adding something like sphinx's l_() function and
would be very invaisve.

Change-Id: I86562b3a65d371673bb21f7179eecc7602bc0775

bin/cinder-all

@@ -30,7 +30,6 @@ continue attempting to launch the rest of the services.
 import eventlet
 eventlet.monkey_patch()
 
-import gettext
 import os
 import sys
 
@@ -40,7 +39,8 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(
 if os.path.exists(os.path.join(possible_topdir, "cinder", "__init__.py")):
     sys.path.insert(0, possible_topdir)
 
-gettext.install('cinder', unicode=1)
+from cinder.openstack.common import gettextutils
+gettextutils.install('cinder')
 
 from cinder import flags
 from cinder.openstack.common import log as logging

bin/cinder-api

@@ -26,7 +26,6 @@
 import eventlet
 eventlet.monkey_patch()
 
-import gettext
 import os
 import sys
 
@@ -36,7 +35,8 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(
 if os.path.exists(os.path.join(possible_topdir, "cinder", "__init__.py")):
     sys.path.insert(0, possible_topdir)
 
-gettext.install('cinder', unicode=1)
+from cinder.openstack.common import gettextutils
+gettextutils.install('cinder')
 
 from cinder import flags
 from cinder.openstack.common import log as logging

bin/cinder-backup

@@ -17,7 +17,6 @@
 
 """Starter script for Cinder Volume Backup."""
 
-import gettext
 import os
 import sys
 
@@ -33,7 +32,8 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(possible_topdir, 'cinder', '__init__.py')):
     sys.path.insert(0, possible_topdir)
 
-gettext.install('cinder', unicode=1)
+from cinder.openstack.common import gettextutils
+gettextutils.install('cinder')
 
 from cinder import flags
 from cinder.openstack.common import log as logging

bin/cinder-clear-rabbit-queues

@@ -24,7 +24,6 @@
 """
 
 import datetime
-import gettext
 import os
 import sys
 import time
@@ -37,8 +36,8 @@ POSSIBLE_TOPDIR = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(POSSIBLE_TOPDIR, 'cinder', '__init__.py')):
     sys.path.insert(0, POSSIBLE_TOPDIR)
 
-gettext.install('cinder', unicode=1)
-
+from cinder.openstack.common import gettextutils
+gettextutils.install('cinder')
 
 from oslo.config import cfg
 

bin/cinder-manage

@@ -54,7 +54,6 @@
   CLI interface for cinder management.
 """
 
-import gettext
 import os
 import sys
 import uuid
@@ -72,7 +71,8 @@ POSSIBLE_TOPDIR = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(POSSIBLE_TOPDIR, 'cinder', '__init__.py')):
     sys.path.insert(0, POSSIBLE_TOPDIR)
 
-gettext.install('cinder', unicode=1)
+from cinder.openstack.common import gettextutils
+gettextutils.install('cinder')
 
 from oslo.config import cfg
 

bin/cinder-scheduler

@@ -22,7 +22,6 @@
 import eventlet
 eventlet.monkey_patch()
 
-import gettext
 import os
 import sys
 
@@ -34,7 +33,8 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(possible_topdir, 'cinder', '__init__.py')):
     sys.path.insert(0, possible_topdir)
 
-gettext.install('cinder', unicode=1)
+from cinder.openstack.common import gettextutils
+gettextutils.install('cinder')
 
 from cinder import flags
 from cinder.openstack.common import log as logging

bin/cinder-volume

@@ -22,7 +22,6 @@
 import eventlet
 eventlet.monkey_patch()
 
-import gettext
 import os
 import sys
 
@@ -34,7 +33,8 @@ possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(possible_topdir, 'cinder', '__init__.py')):
     sys.path.insert(0, possible_topdir)
 
-gettext.install('cinder', unicode=1)
+from cinder.openstack.common import gettextutils
+gettextutils.install('cinder')
 
 from cinder import flags
 from cinder.openstack.common import log as logging

bin/cinder-volume-usage-audit

@@ -34,7 +34,6 @@
         Jan 1 through Dec 31 of the previous year.
 """
 
-import gettext
 import os
 import sys
 import traceback
@@ -47,7 +46,9 @@ POSSIBLE_TOPDIR = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
 if os.path.exists(os.path.join(POSSIBLE_TOPDIR, 'cinder', '__init__.py')):
     sys.path.insert(0, POSSIBLE_TOPDIR)
 
-gettext.install('cinder', unicode=1)
+from cinder.openstack.common import gettextutils
+gettextutils.install('cinder')
+
 from cinder import context
 from cinder import db
 from cinder import flags

doc/source/devref/il8n.rst

@@ -24,8 +24,8 @@ in cinder/tests/test_localization.py.
 
 The ``_()`` function is brought into the global scope by doing::
 
-    import gettext
-    gettext.install("cinder", unicode=1)
+    from cinder.openstack.common import gettextutils
+    gettextutils.install("cinder")
 
 These lines are needed in any toplevel script before any cinder modules are
 imported. If this code is missing, it may result in an error that looks like::