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
|
"""
module for deploying askbot
"""
import os.path
import sys
import django
from optparse import OptionParser
from askbot.deployment import messages
from askbot.deployment.messages import print_message
from askbot.deployment import path_utils
from askbot.utils import console
from askbot.utils.functions import generate_random_key
DATABASE_ENGINE_CHOICES = ('1', '2', '3', '4')
def askbot_setup():
"""basic deployment procedure
asks user several questions, then either creates
new deployment (in the case of new installation)
or gives hints on how to add askbot to an existing
Django project
"""
parser = OptionParser(usage = "%prog [options]")
parser.add_option(
"-v", "--verbose",
dest = "verbosity",
type = "int",
default = 1,
help = "verbosity level available values 0, 1, 2."
)
parser.add_option(
"-n", "--dir-name",
dest = "dir_name",
default = None,
help = "Directory where you want to install."
)
parser.add_option(
'-e', '--db-engine',
dest='database_engine',
action='store',
type='choice',
choices=DATABASE_ENGINE_CHOICES,
default=None,
help='Database engine, type 1 for postgresql, 2 for sqlite, 3 for mysql'
)
parser.add_option(
"-d", "--db-name",
dest = "database_name",
default = None,
help = "The database name"
)
parser.add_option(
"-u", "--db-user",
dest = "database_user",
default = None,
help = "The database user"
)
parser.add_option(
"-p", "--db-password",
dest = "database_password",
default = None,
help = "the database password"
)
parser.add_option(
"--domain",
dest = "domain_name",
default = None,
help = "the domain name of the instance"
)
parser.add_option(
"--append-settings",
dest = "local_settings",
default = '',
help = "Extra settings file to append custom settings"
)
parser.add_option(
"--force",
dest="force",
action='store_true',
default=False,
help = "Force overwrite settings.py file"
)
try:
options = parser.parse_args()[0]
#ask users to give missing parameters
#todo: make this more explicit here
if options.verbosity >= 1:
print messages.DEPLOY_PREAMBLE
directory = path_utils.clean_directory(options.dir_name)
while directory is None:
directory = path_utils.get_install_directory(force=options.force)
options.dir_name = directory
if options.database_engine not in DATABASE_ENGINE_CHOICES:
options.database_engine = console.choice_dialog(
'Please select database engine:\n1 - for postgresql, '
'2 - for sqlite, 3 - for mysql, 4 - oracle',
choices=DATABASE_ENGINE_CHOICES
)
options_dict = vars(options)
if options.force is False:
options_dict = collect_missing_options(options_dict)
database_engine_codes = {
'1': 'postgresql_psycopg2',
'2': 'sqlite3',
'3': 'mysql',
'4': 'oracle'
}
database_engine = database_engine_codes[options.database_engine]
options_dict['database_engine'] = database_engine
deploy_askbot(options_dict)
if database_engine == 'postgresql_psycopg2':
try:
import psycopg2
except ImportError:
print '\nNEXT STEPS: install python binding for postgresql'
print 'pip install psycopg2\n'
elif database_engine == 'mysql':
try:
import _mysql
except ImportError:
print '\nNEXT STEP: install python binding for mysql'
print 'pip install mysql-python\n'
except KeyboardInterrupt:
print "\n\nAborted."
sys.exit(1)
#separated all the directory creation process to make it more useful
def deploy_askbot(options):
"""function that creates django project files,
all the neccessary directories for askbot,
and the log file
"""
create_new_project = False
if os.path.exists(options['dir_name']):
if path_utils.has_existing_django_project(options['dir_name']):
create_new_project = bool(options.force)
else:
create_new_project = True
else:
create_new_project = True
path_utils.create_path(options['dir_name'])
if django.VERSION[0] > 1:
raise Exception(
'Django framework with major version > 1 is not supported'
)
if django.VERSION[1] < 3:
#force people install the django-staticfiles app
options['staticfiles_app'] = ''
else:
options['staticfiles_app'] = "'django.contrib.staticfiles',"
if django.VERSION[1] <=3:
auth_context_processor = 'django.core.context_processors.auth'
else:
auth_context_processor = 'django.contrib.auth.context_processors.auth'
options['auth_context_processor'] = auth_context_processor
verbosity = options['verbosity']
path_utils.deploy_into(
options['dir_name'],
new_project=create_new_project,
verbosity=verbosity,
context=options
)
help_file = path_utils.get_path_to_help_file()
if create_new_project:
print_message(
messages.HOW_TO_DEPLOY_NEW % {'help_file': help_file},
verbosity
)
else:
print_message(
messages.HOW_TO_ADD_ASKBOT_TO_DJANGO % {'help_file': help_file},
verbosity
)
def collect_missing_options(options_dict):
options_dict['secret_key'] = generate_random_key()
if options_dict['database_engine'] == '2':#sqlite
while True:
value = console.simple_dialog(
'Please enter database file name'
)
database_file_name = None
if os.path.isfile(value):
message = 'file %s exists, use it anyway?' % value
if console.get_yes_or_no(message) == 'yes':
database_file_name = value
elif os.path.isdir(value):
print '%s is a directory, choose another name' % value
elif value in path_utils.FILES_TO_CREATE:
print 'name %s cannot be used for the database name' % value
elif value == path_utils.LOG_DIR_NAME:
print 'name %s cannot be used for the database name' % value
else:
database_file_name = value
if database_file_name:
options_dict['database_name'] = database_file_name
return options_dict
else:#others
for key in ('database_name', 'database_user', 'database_password'):
if options_dict[key] is None:
key_name = key.replace('_', ' ')
value = console.simple_dialog(
'\nPlease enter %s' % key_name,
required=True
)
options_dict[key] = value
return options_dict
|
