├── .gitignore ├── .travis.yml ├── LICENSE ├── MANIFEST.in ├── README.rst ├── manage.py ├── setup.py ├── tests ├── __init__.py └── test_middleware.py ├── user_language_middleware ├── __init__.py ├── middleware.py └── settings.py └── version.txt /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | dist/ 3 | *.egg-info/ 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | 3 | env: 4 | - DJANGO_VERSION=2.1 5 | - DJANGO_VERSION=2.0 6 | - DJANGO_VERSION=1.11 7 | - DJANGO_VERSION=1.10 8 | - DJANGO_VERSION=1.9 9 | - DJANGO_VERSION=1.8 10 | 11 | python: 12 | - 2.7 13 | - 3.4 14 | - 3.5 15 | - 3.6 16 | 17 | matrix: 18 | exclude: 19 | - env: DJANGO_VERSION=2.0 20 | python: 2.7 21 | - env: DJANGO_VERSION=2.1 22 | python: 2.7 23 | - env: DJANGO_VERSION=2.1 24 | python: 3.4 25 | 26 | install: 27 | - pip install Django==${DJANGO_VERSION} 28 | - if [[ $TRAVIS_PYTHON_VERSION == 2.* ]]; then pip install mock; fi 29 | - pip install flake8 30 | 31 | script: 32 | - ./manage.py test 33 | - flake8 user_language_middleware tests 34 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [2018] [Laura Barluzzi] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include version.txt 2 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ************************ 2 | User Language Middleware 3 | ************************ 4 | 5 | .. image:: https://travis-ci.org/laura-barluzzi/django-user-language-middleware.svg?branch=master 6 | :target: https://travis-ci.org/laura-barluzzi/django-user-language-middleware 7 | .. image:: https://img.shields.io/pypi/v/django-user-language-middleware.svg 8 | :target: https://pypi.python.org/pypi/django-user-language-middleware/ 9 | 10 | What's this? 11 | ============ 12 | 13 | This package contains a middleware that activates translations based on the 14 | language field in the user model. This enables easy user-specific localization 15 | of a Django application: just add a language string field to the user model, 16 | install this middleware and you're good to go! 17 | 18 | Usage 19 | ===== 20 | 21 | Add a language field to your user model: 22 | 23 | .. code-block:: python 24 | 25 | class User(auth_base.AbstractBaseUser, auth.PermissionsMixin): 26 | # ... 27 | language = models.CharField(max_length=10, 28 | choices=settings.LANGUAGES, 29 | default=settings.LANGUAGE_CODE) 30 | 31 | Install the middleware from pip: 32 | 33 | .. code-block:: sh 34 | 35 | pip install django-user-language-middleware 36 | 37 | and then add it to your middleware class list to listen to requests: 38 | 39 | .. code-block:: python 40 | 41 | MIDDLEWARE = [ # Or MIDDLEWARE_CLASSES on Django < 1.10 42 | ... 43 | 'user_language_middleware.UserLanguageMiddleware', 44 | ... 45 | ] 46 | 47 | Supported versions 48 | ================== 49 | 50 | Python: 51 | 52 | - 2.7 53 | - 3.4 to 3.6 54 | 55 | Django: 56 | 57 | - 1.8 to 1.11 58 | - 2.0 59 | -------------------------------------------------------------------------------- /manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import os 3 | import sys 4 | 5 | if __name__ == "__main__": 6 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "user_language_middleware.settings") 7 | try: 8 | from django.core.management import execute_from_command_line 9 | except ImportError: 10 | # The above import may fail for some other reason. Ensure that the 11 | # issue is really that Django is missing to avoid masking other 12 | # exceptions on Python 2. 13 | try: 14 | import django 15 | except ImportError: 16 | raise ImportError( 17 | "Couldn't import Django. Are you sure it's installed and " 18 | "available on your PYTHONPATH environment variable? Did you " 19 | "forget to activate a virtual environment?" 20 | ) 21 | raise 22 | execute_from_command_line(sys.argv) 23 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | from __future__ import unicode_literals 3 | 4 | from setuptools import find_packages 5 | from setuptools import setup 6 | 7 | 8 | with open('README.rst') as fobj: 9 | long_description = fobj.read() 10 | 11 | 12 | with open('version.txt') as fobj: 13 | version = fobj.read() 14 | 15 | 16 | setup( 17 | name='django-user-language-middleware', 18 | version=version, 19 | author='Laura Barluzzi', 20 | author_email='laura@koalacoder.com', 21 | packages=find_packages(exclude=['tests']), 22 | url='https://github.com/laura-barluzzi/django-user-language-middleware', 23 | download_url='https://pypi.python.org/pypi/django-user-language-middleware', 24 | license='Apache Software License', 25 | description='Django middleware to translate with language in user model', 26 | long_description=long_description, 27 | install_requires=[ 28 | 'Django>=1.8' 29 | ], 30 | python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*', 31 | classifiers=[ 32 | 'Environment :: Web Environment', 33 | 'Framework :: Django', 34 | 'Framework :: Django :: 1.10', 35 | 'Framework :: Django :: 1.11', 36 | 'Framework :: Django :: 1.8', 37 | 'Framework :: Django :: 1.9', 38 | 'Framework :: Django :: 2.0', 39 | 'Framework :: Django :: 2.1', 40 | 'Intended Audience :: Developers', 41 | 'License :: OSI Approved :: Apache Software License', 42 | 'Operating System :: OS Independent', 43 | 'Programming Language :: Python :: 2.7', 44 | 'Programming Language :: Python :: 3.4', 45 | 'Programming Language :: Python :: 3.5', 46 | 'Programming Language :: Python :: 3.6', 47 | 'Topic :: Software Development :: Libraries :: Application Frameworks', 48 | 'Topic :: Software Development :: Libraries :: Python Modules', 49 | 'Topic :: Software Development :: Localization' 50 | ]) 51 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/laura-barluzzi/django-user-language-middleware/7b746c7356f0f5cfd16d3023a8f0ad14c016f399/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_middleware.py: -------------------------------------------------------------------------------- 1 | try: 2 | from unittest.mock import Mock 3 | from unittest.mock import patch 4 | except ImportError: 5 | from mock import Mock 6 | from mock import patch 7 | 8 | from django.test import SimpleTestCase 9 | 10 | from user_language_middleware import UserLanguageMiddleware 11 | from user_language_middleware import middleware 12 | 13 | 14 | class UserLanguageMiddlewareTest(SimpleTestCase): 15 | def setUp(self): 16 | self.mock_request = Mock() 17 | self.mock_response = Mock() 18 | self.LANGUAGE_SESSION_KEY = '' 19 | self.mock_request.session = {self.LANGUAGE_SESSION_KEY: ''} 20 | self.ulm = UserLanguageMiddleware() 21 | 22 | @patch.object(middleware, 'translation') 23 | def test_process_response_user_not_authenticated(self, mock_translation): 24 | self.mock_request.user.is_authenticated = False 25 | res = self.ulm.process_response(self.mock_request, self.mock_response) 26 | assert 0 == mock_translation.activate.call_count 27 | assert res is self.mock_response 28 | 29 | @patch.object(middleware, 'translation') 30 | def test_process_response_with_same_language(self, mock_translation): 31 | self.mock_request.user.is_authenticated = True 32 | self.mock_request.user.language = 'en' 33 | mock_translation.get_language.return_value = 'en' 34 | res = self.ulm.process_response(self.mock_request, self.mock_response) 35 | assert 0 == mock_translation.activate.call_count 36 | assert res is self.mock_response 37 | 38 | @patch.object(middleware, 'translation') 39 | def test_process_response_activate_user_language(self, mock_translation): 40 | self.mock_request.user.is_authenticated = True 41 | self.mock_request.user.language = 'fr' 42 | mock_translation.get_language.return_value = 'en' 43 | user_lang = self.mock_request.user.language 44 | session_lang = self.mock_request.session 45 | session_lang[self.LANGUAGE_SESSION_KEY] = user_lang 46 | res = self.ulm.process_response(self.mock_request, self.mock_response) 47 | assert 1 == mock_translation.activate.call_count 48 | assert 'fr' == session_lang[self.LANGUAGE_SESSION_KEY] 49 | assert res is self.mock_response 50 | 51 | @patch.object(middleware, 'translation') 52 | def test_process_response_no_language(self, mock_translation): 53 | del self.mock_request.user.language 54 | res = self.ulm.process_response(self.mock_request, self.mock_response) 55 | assert 0 == mock_translation.activate.call_count 56 | assert res is self.mock_response 57 | 58 | @patch.object(middleware, 'translation') 59 | def test_process_response_no_user(self, mock_translation): 60 | del self.mock_request.user 61 | res = self.ulm.process_response(self.mock_request, self.mock_response) 62 | assert 0 == mock_translation.activate.call_count 63 | assert res is self.mock_response 64 | -------------------------------------------------------------------------------- /user_language_middleware/__init__.py: -------------------------------------------------------------------------------- 1 | from .middleware import UserLanguageMiddleware # noqa: F401 2 | -------------------------------------------------------------------------------- /user_language_middleware/middleware.py: -------------------------------------------------------------------------------- 1 | import django 2 | from django.utils import translation 3 | 4 | 5 | def is_django_greater_than_1_10(): 6 | main_version = django.VERSION[0] 7 | if main_version > 1: 8 | return True 9 | 10 | sub_version = django.VERSION[1] 11 | if main_version == 1 and sub_version >= 10: 12 | return True 13 | 14 | return False 15 | 16 | 17 | if is_django_greater_than_1_10(): 18 | from django.utils.deprecation import MiddlewareMixin 19 | superclass = MiddlewareMixin 20 | else: 21 | superclass = object 22 | 23 | 24 | class UserLanguageMiddleware(superclass): 25 | def process_response(self, request, response): 26 | user = getattr(request, 'user', None) 27 | if not user: 28 | return response 29 | 30 | if not user.is_authenticated: 31 | return response 32 | 33 | user_language = getattr(user, 'language', None) 34 | if not user_language: 35 | return response 36 | 37 | current_language = translation.get_language() 38 | if user_language == current_language: 39 | return response 40 | 41 | translation.activate(user_language) 42 | request.session[translation.LANGUAGE_SESSION_KEY] = user_language 43 | 44 | return response 45 | -------------------------------------------------------------------------------- /user_language_middleware/settings.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) 4 | 5 | SECRET_KEY = '*%_@(6abic2&&gbdam#o&+*i_wej0r*bpwi1i)ul@&#%wqiyo1' 6 | 7 | DATABASES = { 8 | 'default': { 9 | 'ENGINE': 'django.db.backends.sqlite3', 10 | 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /version.txt: -------------------------------------------------------------------------------- 1 | 0.0.3 2 | --------------------------------------------------------------------------------