settings.py
11.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
"""
Django settings for pyros project.
Generated by 'django-admin startproject' using Django 1.9.4.
For more information on this file, see
https://docs.djangoproject.com/en/1.9/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/1.9/ref/settings/
"""
''' DO NOT TOUCH THESE VARIABLES
"pyros.py simulator_development" will automatically set them to "True"
'''
# FOR SIMULATOR (TODO: remove because not used)
SIMULATOR = False
# For majordome_test.py:
# cd src/majordome/
# ./majordome_test.py
MAJORDOME_TEST = False
# Set MYSQL to False if you want to use SQLITE
# This line MUST NOT be changed at all except from changing True/False
# (or install_requirements script will become invalid)
MYSQL = True
# Dictionary containing all the versions for the different modules
# IMPORTANT : It must be updated at every commit !
MODULES_VERSIONS = {
"Alert Manager" : "0.2.4",
"Analyzer" : "0.1.2",
"Dashboard" : "0.1.1",
"Majordome" : "0.1.4",
"Monitoring" : "0.1.3",
"Observation Manager" : "0.1.3",
"Routine Manager" : "0.1.2",
"Scheduler" : "0.1.2",
"User Manager" : "0.1.1",
"Device" : "0.1.1"
}
import os,re,platform
# duplicate from the same function in pyros.py ...
def set_environment_variables_if_not_configured(env_path: str,env_sample_path: str)->None:
"""
Set environment variables if they aren't defined in the current environment.
Get the variables from .env file if it exists or create this file using a copy of the env_sample
Args:
env_path (str): path to .env file
env_sample_path (str): path to .env-sample file
"""
is_environment_variables_not_defined = os.environ.get("MYSQL_PYROS_LOGIN") == None or os.environ.get("MYSQL_PYROS_PWD") == None or os.environ.get("MYSQL_TCP_PORT") == None
if(is_environment_variables_not_defined):
print("Some environment variables are not configured...")
try:
with open(env_path,"r") as env_file:
print("Reading env file")
for line in env_file:
if(line.startswith("#") and not line.strip()):
continue
else:
key,value = line.split("=")
# setting variables as environment variables
os.environ[key] = value
except:
print(f".env not found at {ENV_PATH}, creating a file at this path from the .env-sample file stored at {ENV_SAMPLE_PATH}\n \
values from .env-sample will be used as environment variables")
with open(env_sample_path,'r') as env_sample_file:
with open(env_path,"w") as env_file:
for env_sample_line in env_sample_file:
if(env_sample_line.startswith("#") or not env_sample_line.strip()):
continue
key,value = env_sample_line.split("=")
os.environ[key] = value
env_file.write(env_sample_line)
else:
print("The environment variables are already configured, skipping this step...")
# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
# Output folder for images
#TODO: c'est quoi ce dossier ? existe-t-il vraiment ???
OUTPUT_FOLDER = os.path.join(BASE_DIR, "../images_folder")
# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/1.9/howto/deployment/checklist/
# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = '0*@w)$rq4x1c2w!c#gn58*$*u$w=s8uw2zpr_c3nj*u%qlxc23'
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True
try:
WITH_DOCKER=os.environ['WITH_DOCKER']
except KeyError:
WITH_DOCKER = False
if type(WITH_DOCKER) is str and re.match("^y$|^Y$|^yes$|^Yes$",WITH_DOCKER.rstrip()) != None :
WITH_DOCKER = True
else :
WITH_DOCKER = False
HTTP_PORT = ""
ENV_PATH="../../../../docker/.env"
ENV_SAMPLE_PATH="../../../../docker/.env-sample"
# default value of mysql port
MYSQL_PORT = "3306"
SQL_USER = ""
SQL_PWD = ""
ALLOWED_HOSTS = ['localhost', '127.0.0.1', 'pyros.irap.omp.eu']
# defining variables when using Docker
if WITH_DOCKER:
ALLOWED_HOSTS.append('0.0.0.0')
HTTP_PORT = ":8000"
try:
MYSQL_PORT = os.environ['MYSQL_TCP_PORT'].strip()
SQL_USER = os.environ["MYSQL_PYROS_LOGIN"].strip()
SQL_PWD = os.environ["MYSQL_PYROS_PWD"].strip()
except:
set_environment_variables_if_not_configured(ENV_PATH,ENV_SAMPLE_PATH)
# TODO : Change ALLOWED_HOSTS depending if you are using docker with windows (the domain is "localhost") or docker with another OS (the domain is "0.0.0.0"). If you are running PyROS without Docker, the domain is "localhost".
DEFAULT_DOMAIN = f'{ALLOWED_HOSTS[0]}{HTTP_PORT}'
# Application definition
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
# (EP) For debug_toolbar
'django.contrib.staticfiles',
'debug_toolbar',
# for using "./manage.py graph_models" with graphviz:
# (https://projects.irap.omp.eu/projects/pyros/wiki/Project_Development#django-extensions-and-graphviz-useful-for-generating-an-image-of-all-the-models-and-their-relationships)
'django_extensions',
'test_without_migrations',
'bootstrap3',
# PYROS APPS
'dashboard',
'scheduler',
'common',
'alert_manager',
'analyzer',
'majordome',
'monitoring',
'observation_manager',
'routine_manager',
'user_manager',
'devices',
#'kombu.transport.django'
]
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
# For debug_toolbar
'debug_toolbar.middleware.DebugToolbarMiddleware',
]
ROOT_URLCONF = 'pyros.urls'
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [os.path.join(BASE_DIR, 'misc/templates')],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
},
},
]
WSGI_APPLICATION = 'pyros.wsgi.application'
FIXTURE_DIRS = (
'misc/fixtures/',
)
EMAIL_HOST = 'smtp.gmail.com'
EMAIL_PORT = 587
EMAIL_HOST_USER = 'pyrostnc'
EMAIL_HOST_PASSWORD = 'PyROSTNC7!'
EMAIL_USE_TLS = True
LOGIN_URL = "/"
# DATABASE CONFIG
'''
From MySQL 5.7 onwards and on fresh installs of MySQL 5.6,
the default value of the sql_mode option contains STRICT_TRANS_TABLES.
That option escalates warnings into errors when data are truncated upon insertion,
so Django highly recommends activating a strict mode for MySQL to prevent data loss
(either STRICT_TRANS_TABLES or STRICT_ALL_TABLES)
'''
mysql_options = { 'init_command': "SET sql_mode='STRICT_TRANS_TABLES'" }
# DEFAULT (NORMAL) RUN MODE, use pyros (normal) database
if MYSQL:
DATABASES = {
'default': {
'OPTIONS': mysql_options,
'ENGINE': 'django.db.backends.mysql',
'NAME': 'pyros',
'USER': SQL_USER,
'PASSWORD': SQL_PWD,
'PORT': MYSQL_PORT,
'''
(See https://docs.djangoproject.com/fr/2.1/topics/testing/overview/#the-test-database)
Optional, but this allows to remember the default django test database name
(and even to rename it if needed).
For this DB, you need to do this in mysql :
GRANT ALL PRIVILEGES ON test_pyros.* TO 'pyros_user'@'localhost';
'''
'TEST': {
'NAME': 'test_pyros',
},
}
}
if WITH_DOCKER:
# add host and port to connect to the database
DATABASES['default']['HOST'] = 'db'
DATABASES['default']['PORT'] = '3306'
else:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
# SIMULATOR==True ==> 'TEST (simu)' RUN MODE, use pyros_test database
if SIMULATOR:
DATABASES = {
'default': {
'OPTIONS': mysql_options,
'ENGINE': 'django.db.backends.mysql',
'NAME': 'pyros_test',
'USER': 'pyros',
'PASSWORD': 'DjangoPyros'
}
}
if MAJORDOME_TEST: DATABASES['default']['NAME'] = 'pyros_test'
AUTH_USER_MODEL = 'common.PyrosUser'
# Password validation
# https://docs.djangoproject.com/en/1.9/ref/settings/#auth-password-validators
AUTH_PASSWORD_VALIDATORS = [
{
'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
},
]
# Internationalization
# https://docs.djangoproject.com/en/1.9/topics/i18n/
LANGUAGE_CODE = 'en-us'
#LANGUAGE_CODE = 'fr-FR'
# UTC = FR - 2h in summer
# UTC = FR - 1h in winter
TIME_ZONE = 'UTC'
#TIME_ZONE = 'Europe/Paris'
# If you set this to False, Django will make some optimizations so as not
# to load the internationalization machinery.
USE_I18N = True
# If you set this to False, Django will not format dates, numbers and
# calendars according to the current locale.
USE_L10N = True
# EP change
# If you set this to False, Django will not use timezone-aware datetimes.
# If true => "updated" fields in weatherwatch or sitewatch will be saved as UTC time
# If false => "updated" fields in weatherwatch or sitewatch will be saved as UTC+1 time (French time)
# (Was) Necessary for "pyros test" (no more necessary now because fixtures dates have been converted to naive format without time zone) :
# Necessary for ENV monitoring :
#USE_TZ = False
USE_TZ = True
# To find the media files {{ MEDIA_URL }}
MEDIA_URL = '/public/static/media/'
# To find the static files in the app/static/app/... folders
STATIC_URL = '/public/static/'
#STATIC_URL = '/static/'
# To find the static files in src/static/. Any local directory can be added to this list.
STATICFILES_DIRS = (
os.path.join(BASE_DIR, "misc", "static"),
)
# Used for deployment (DEBUG = False). Need to run "python manage.py collectstatic" to fill it.
STATIC_ROOT = os.path.join(os.path.dirname(BASE_DIR), 'public', 'static')
# EP added
if not DEBUG:
'''
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
'LOCATION': '127.0.0.1:11211',
}
}
'''
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.filebased.FileBasedCache',
'LOCATION': '/var/tmp/django_cache',
}
}
else:
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.dummy.DummyCache',
}
}
# from django.core.cache import cache
# cache.clear()