[CalendarServer-changes] [7366] CalendarServer/branches/users/glyph/misc-portability-fixes/txdav/ base/datastore/dbapiclient.py

[source_changes at macosforge.org]

Revision: 7366
          http://trac.macosforge.org/projects/calendarserver/changeset/7366
Author:   glyph at apple.com
Date:     2011-04-27 11:44:08 -0700 (Wed, 27 Apr 2011)
Log Message:
-----------
Set NLS_LANG, and attempt to explain why it's done this way.

Modified Paths:
--------------
    CalendarServer/branches/users/glyph/misc-portability-fixes/txdav/base/datastore/dbapiclient.py

Modified: CalendarServer/branches/users/glyph/misc-portability-fixes/txdav/base/datastore/dbapiclient.py
===================================================================
--- CalendarServer/branches/users/glyph/misc-portability-fixes/txdav/base/datastore/dbapiclient.py	2011-04-27 18:43:38 UTC (rev 7365)
+++ CalendarServer/branches/users/glyph/misc-portability-fixes/txdav/base/datastore/dbapiclient.py	2011-04-27 18:44:08 UTC (rev 7366)
@@ -20,6 +20,26 @@
 from twext.enterprise.util import mapOracleOutputType
 
 try:
+    import os
+    # In order to encode and decode values going to and from the database,
+    # cx_Oracle depends on Oracle's NLS support, which in turn relies upon
+    # libclntsh's reading of environment variables.  It doesn't matter what the
+    # database language is; the database may contain iCalendar data in many
+    # languages, but we MUST set NLS_LANG to a value that includes an encoding
+    # (character set?) that includes all of Unicode, so that the connection can
+    # encode and decode any valid unicode data.  This is not to encode and
+    # decode bytes, but rather, to faithfully relay Python unicode strings to
+    # the database.  The default connection encoding is US-ASCII, which is
+    # definitely no good.  NLS_LANG needs to be set before the first call to
+    # connect(), not actually before the module gets imported, but this is as
+    # good a place as any.  I am explicitly setting this rather than inheriting
+    # it, because it's not a configuration value in the sense that multiple
+    # values may possibly be correct; _only_ UTF-8 is ever correct to work with
+    # our software, and other values will fail CalDAVTester.  (The state is,
+    # however, process-global; after the first call to connect(), all
+    # subsequent connections inherit this encoding even if the environment
+    # variable changes.) -glyph
+    os.environ['NLS_LANG'] = '.UTF8'
     import cx_Oracle
 except ImportError:
     cx_Oracle = None
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20110427/a2eb4809/attachment-0001.html>