summaryrefslogtreecommitdiffstats
path: root/pykolab/setup/setup_roundcube.py
blob: 7c7964d904476e020f2d92a96f2a741071fc75a7 (plain)
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
365
366
367
368
369
370
371
372
373
374
# -*- coding: utf-8 -*-
# Copyright 2010-2013 Kolab Systems AG (http://www.kolabsys.com)
#
# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

import codecs
import grp
import hashlib
import os
import random
import re
import subprocess
import sys
import time

from Cheetah.Template import Template

import components

import pykolab

from pykolab import utils
from pykolab.constants import *
from pykolab.translate import _

# pylint: disable=invalid-name
log = pykolab.getLogger('pykolab.setup')
conf = pykolab.getConf()


def __init__():
    components.register('roundcube', execute, description=description(), after=['mysql', 'ldap'])


def description():
    return _("Setup Roundcube.")


def execute(*args, **kw):
    print >> sys.stderr, utils.multiline_message(
        """
            Please supply a password for the MySQL user 'roundcube'.
            This password will be used by the Roundcube webmail
            interface.
        """
    )

    mysql_roundcube_password = utils.ask_question(
        "MySQL roundcube password",
        default=utils.generate_password(),
        password=True,
        confirm=True
    )

    conf.mysql_roundcube_password = mysql_roundcube_password

    rc_settings = {
        'des_key': re.sub(
            r'[^a-zA-Z0-9]',
            "",
            "%s%s" % (
                hashlib.md5("%s" % random.random()).digest().encode("base64"),
                hashlib.md5("%s" % random.random()).digest().encode("base64")
            )
        )[:24],

        'imap_admin_login': conf.get('cyrus-imap', 'admin_login'),
        'imap_admin_password': conf.get('cyrus-imap', 'admin_password'),
        'ldap_base_dn': conf.get('ldap', 'base_dn'),
        'ldap_group_base_dn': conf.get('ldap', 'group_base_dn'),
        'ldap_group_filter': conf.get('ldap', 'group_filter'),
        'ldap_ldap_uri': conf.get('ldap', 'ldap_uri'),
        'ldap_resource_base_dn': conf.get('ldap', 'resource_base_dn'),
        'ldap_resource_filter': conf.get('ldap', 'resource_filter'),
        'ldap_service_bind_dn': conf.get('ldap', 'service_bind_dn'),
        'ldap_service_bind_pw': conf.get('ldap', 'service_bind_pw'),
        'ldap_user_base_dn': conf.get('ldap', 'user_base_dn'),
        'ldap_user_filter': conf.get('ldap', 'user_filter'),
        'primary_domain': conf.get('kolab', 'primary_domain'),
        'mysql_uri': 'mysqli://roundcube:%s@localhost/roundcube' % (mysql_roundcube_password),
        'conf': conf
    }

    rc_paths = [
        "/usr/share/roundcubemail/",
        "/usr/share/roundcube/",
        "/srv/www/roundcubemail/",
        "/var/www/roundcubemail/"
    ]

    rcpath = ''
    for rc_path in rc_paths:
        if os.path.isdir(rc_path):
            rcpath = rc_path
            break

    if not os.path.isdir(rcpath):
        log.error("Roundcube installation path not found.")
        return

    if os.access(rcpath + 'skins/kolab/', os.R_OK):
        rc_settings['skin'] = 'kolab'
    elif os.access(rcpath + 'skins/enterprise/', os.R_OK):
        rc_settings['skin'] = 'enterprise'
    elif os.access(rcpath + 'skins/chameleon/', os.R_OK):
        rc_settings['skin'] = 'chameleon'
    else:
        rc_settings['skin'] = 'larry'

    want_files = [
        'acl.inc.php',
        'calendar.inc.php',
        'config.inc.php',
        'kolab_addressbook.inc.php',
        'kolab_auth.inc.php',
        'kolab_delegation.inc.php',
        'kolab_files.inc.php',
        'kolab_folders.inc.php',
        'libkolab.inc.php',
        'managesieve.inc.php',
        'owncloud.inc.php',
        'password.inc.php',
        'recipient_to_contact.inc.php',
        'terms.html',
        'terms.inc.php'
    ]

    for want_file in want_files:
        template_file = None
        if os.path.isfile('/etc/kolab/templates/roundcubemail/%s.tpl' % (want_file)):
            template_file = '/etc/kolab/templates/roundcubemail/%s.tpl' % (want_file)
        elif os.path.isfile('/usr/share/kolab/templates/roundcubemail/%s.tpl' % (want_file)):
            template_file = '/usr/share/kolab/templates/roundcubemail/%s.tpl' % (want_file)

        if template_file is not None:
            # pylint: disable=logging-not-lazy
            log.debug("Using template file %r" % (template_file), level=8)
            filep = codecs.open(template_file, 'r', encoding='utf-8')
            template_definition = filep.read()
            filep.close()

            t = Template(template_definition, searchList=[rc_settings])
            # pylint: disable=logging-not-lazy
            log.debug(
                "Successfully compiled template %r, writing out to %r" % (
                    template_file,
                    want_file
                ),
                level=8
            )

            filep = None
            if os.path.isdir('/etc/roundcubemail'):
                filep = codecs.open('/etc/roundcubemail/%s' % (want_file), 'w', encoding='utf-8')
            elif os.path.isdir('/etc/roundcube'):
                filep = codecs.open('/etc/roundcube/%s' % (want_file), 'w', encoding='utf-8')

            if filep is not None:
                filep.write(t.respond())
                filep.close()

    schema_files = []

    # pylint: disable=too-many-nested-blocks
    for root, directories, filenames in os.walk('/usr/share/doc/'):
        directories.sort()
        for directory in directories:
            if directory.startswith("roundcubemail"):
                for _root, _directories, _filenames in os.walk(os.path.join(root, directory)):
                    for filename in _filenames:
                        if filename.startswith('mysql.initial') and filename.endswith('.sql'):
                            schema_filepath = os.path.join(_root, filename)
                            if schema_filepath not in schema_files:
                                schema_files.append(schema_filepath)

                if schema_files:
                    break

        if schema_files:
            break

    for root, directories, filenames in os.walk(rcpath + 'plugins/calendar/drivers/kolab/'):
        for filename in filenames:
            if filename.startswith('mysql') and filename.endswith('.sql'):
                schema_filepath = os.path.join(root, filename)
                if schema_filepath not in schema_files:
                    schema_files.append(schema_filepath)

    for root, directories, filenames in os.walk(rcpath + 'plugins/libkolab/'):
        for filename in filenames:
            if filename.startswith('mysql') and filename.endswith('.sql'):
                schema_filepath = os.path.join(root, filename)
                if schema_filepath not in schema_files:
                    schema_files.append(schema_filepath)

    for root, directories, filenames in os.walk('/usr/share/doc/'):
        directories.sort()
        for directory in directories:
            if directory.startswith("chwala"):
                for _root, _directories, _filenames in os.walk(os.path.join(root, directory)):
                    for filename in _filenames:
                        if filename.startswith('mysql.initial') and filename.endswith('.sql'):
                            schema_filepath = os.path.join(_root, filename)
                            if schema_filepath not in schema_files:
                                schema_files.append(schema_filepath)

                if len(schema_files) > 0:
                    break
        if len(schema_files) > 0:
            break

    if not os.path.isfile('/tmp/kolab-setup-my.cnf'):
        print >> sys.stderr, utils.multiline_message(
                """Please supply the MySQL root password (use 'unix_socket' for socket based authentication)"""
            )

        mysql_root_password = utils.ask_question(
                _("MySQL root password"),
                password=True
            )

        socket_path = None
        socket_paths = [
            "/var/lib/mysql/mysql.sock",
            "/var/run/mysqld/mysqld.sock",
            "/var/run/mysql/mysql.sock"
        ]
        for sp in socket_paths:
            if os.path.exists(sp):
                socket_path = sp

        if mysql_root_password == "unix_socket" and socket_path is not None:
            data = """
[mysql]
user=root
password=
host=localhost
socket=%s
""" % (socket_path)
        else:
            data = """
[mysql]
user=root
password='%s'
host=%s
""" % (mysql_root_password, conf.mysqlhost)

        fp = open('/tmp/kolab-setup-my.cnf', 'w')
        os.chmod('/tmp/kolab-setup-my.cnf', 600)
        fp.write(data)
        fp.close()

    p1 = subprocess.Popen(['echo', 'create database roundcube;'], stdout=subprocess.PIPE)
    p2 = subprocess.Popen(['mysql', '--defaults-file=/tmp/kolab-setup-my.cnf'], stdin=p1.stdout)
    p1.stdout.close()
    p2.communicate()

    p1 = subprocess.Popen(
        [
            'echo',
            'GRANT ALL PRIVILEGES ON roundcube.* TO \'roundcube\'@\'localhost\' IDENTIFIED BY \'%s\';' % (
                mysql_roundcube_password
            )
        ],
        stdout=subprocess.PIPE
    )
    p2 = subprocess.Popen(['mysql', '--defaults-file=/tmp/kolab-setup-my.cnf'], stdin=p1.stdout)
    p1.stdout.close()
    p2.communicate()

    for schema_file in schema_files:
        p1 = subprocess.Popen(['cat', schema_file], stdout=subprocess.PIPE)
        p2 = subprocess.Popen(
            [
                'mysql',
                '--defaults-file=/tmp/kolab-setup-my.cnf',
                'roundcube'
            ],
            stdin=p1.stdout
        )

        p1.stdout.close()
        p2.communicate()

    p1 = subprocess.Popen(['echo', 'FLUSH PRIVILEGES;'], stdout=subprocess.PIPE)
    p2 = subprocess.Popen(['mysql', '--defaults-file=/tmp/kolab-setup-my.cnf'], stdin=p1.stdout)
    p1.stdout.close()
    p2.communicate()

    time.sleep(2)

    # Find Roundcube configuration that is not readable by the
    # webserver user/group.
    if os.path.isdir('/etc/roundcubemail/'):
        rccpath = "/etc/roundcubemail/"
    elif os.path.isdir('/etc/roundcube/'):
        rccpath = "/etc/roundcube"
    else:
        log.warning("Cannot find the configuration directory for roundcube.")
        rccpath = None

    root_uid = 0

    webserver_gid = None

    for webserver_group in ['apache', 'www-data', 'www']:
        try:
            # pylint: disable=unused-variable
            (a, b, webserver_gid, d) = grp.getgrnam(webserver_group)
            break

        # pylint: disable=broad-except
        except Exception:
            pass

    if webserver_gid is not None:
        if rccpath is not None:
            for root, directories, filenames in os.walk(rccpath):
                for filename in filenames:
                    try:
                        os.chown(
                            os.path.join(root, filename),
                            root_uid,
                            webserver_gid
                        )

                    # pylint: disable=broad-except
                    except Exception:
                        pass

    httpservice = 'httpd.service'

    if os.path.isfile('/usr/lib/systemd/system/apache2.service'):
        httpservice = 'apache2.service'

    if os.path.isfile('/lib/systemd/system/apache2.service'): # Debian 9
        httpservice = 'apache2.service'

    if os.path.isdir('/lib/systemd/system/apache2.service.d'):
        httpservice = 'apache2.service'

    if os.path.isfile('/bin/systemctl'):
        subprocess.call(['/bin/systemctl', 'restart', httpservice])
    elif os.path.isfile('/sbin/service'):
        subprocess.call(['/sbin/service', 'httpd', 'restart'])
    elif os.path.isfile('/usr/sbin/service'):
        subprocess.call(['/usr/sbin/service', 'apache2', 'restart'])
    else:
        log.error("Could not start the webserver server service.")

    if os.path.isfile('/bin/systemctl'):
        subprocess.call(['/bin/systemctl', 'enable', httpservice])
    elif os.path.isfile('/sbin/chkconfig'):
        subprocess.call(['/sbin/chkconfig', 'httpd', 'on'])
    elif os.path.isfile('/usr/sbin/update-rc.d'):
        subprocess.call(['/usr/sbin/update-rc.d', 'apache2', 'defaults'])
    else:
        log.error(
            "Could not configure to start on boot, the webserver server service."
        )