aboutsummaryrefslogtreecommitdiffstats
path: root/src/scripts/install.py
blob: 5b6be7ce453b0f7f191d205bddfb8953a22405f3 (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
#!/usr/bin/python

"""
Botan install script
(C) 2014,2015 Jack Lloyd

Distributed under the terms of the Botan license
"""

import errno
import logging
import optparse
import os
import shutil
import string
import sys

if 'dont_write_bytecode' in sys.__dict__:
    sys.dont_write_bytecode = True

from botan_version import release_major, release_minor, release_patch
import combine_relnotes

def parse_command_line(args):

    parser = optparse.OptionParser()

    parser.add_option('--verbose', action='store_true', default=False,
                      help='Show debug messages')
    parser.add_option('--quiet', action='store_true', default=False,
                      help='Show only warnings and errors')

    build_group = optparse.OptionGroup(parser, 'Source options')
    build_group.add_option('--build-dir', metavar='DIR', default='build',
                           help='Location of build output (default \'%default\')')
    parser.add_option_group(build_group)

    install_group = optparse.OptionGroup(parser, 'Installation options')
    install_group.add_option('--destdir', default='/usr/local',
                             help='Set output directory (default %default)')
    install_group.add_option('--bindir', default='bin', metavar='DIR',
                             help='Set binary subdir (default %default)')
    install_group.add_option('--libdir', default='lib', metavar='DIR',
                             help='Set library subdir (default %default)')
    install_group.add_option('--includedir', default='include', metavar='DIR',
                             help='Set include subdir (default %default)')
    install_group.add_option('--docdir', default='share/doc', metavar='DIR',
                             help='Set documentation subdir (default %default)')
    install_group.add_option('--pkgconfigdir', default='pkgconfig', metavar='DIR',
                             help='Set pkgconfig subdir (default %default)')

    install_group.add_option('--versioned-include-dir', metavar='SUFFIX_DIR',
                             default='botan-%d.%d' % (release_major, release_minor),
                             help='Name of versioned include dir')
    install_group.add_option('--doc-dir-suffix', metavar='V',
                             default='-%d.%d.%d' % (release_major, release_minor, release_patch),
                             help='Set optional suffix on doc dir (default \'%default\')')

    install_group.add_option('--umask', metavar='MASK', default='022',
                             help='Umask to set (default %default)')
    parser.add_option_group(install_group)

    (options, args) = parser.parse_args(args)

    def log_level():
        if options.verbose:
            return logging.DEBUG
        if options.quiet:
            return logging.WARNING
        return logging.INFO

    logging.getLogger().setLevel(log_level())

    return (options, args)

def makedirs(dirname, exist_ok = True):
    try:
        logging.debug('Creating directory %s' % (dirname))
        os.makedirs(dirname)
    except OSError as e:
        if e.errno != errno.EEXIST or not exist_ok:
            raise e

def license_text(rst_license):
    end_of_rst = 'terms::'
    contents = open(rst_license).read()
    x = contents.find(end_of_rst) + len(end_of_rst)

    lines = contents[x:].split('\n')

    while lines[0] == '':
        lines.pop(0)

    leading_ws = min([len(l) - len(l.lstrip(' ')) for l in lines if l != ''])

    return '\n'.join([l[leading_ws:] for l in lines])

def main(args = None):
    if args is None:
        args = sys.argv

    logging.basicConfig(stream = sys.stdout,
                        format = '%(levelname) 7s: %(message)s')

    (options, args) = parse_command_line(args)

    exe_mode = 0o777

    if 'umask' in os.__dict__:
        umask = int(options.umask, 8)
        logging.debug('Setting umask to %s' % oct(umask))
        os.umask(int(options.umask, 8))
        exe_mode &= (umask ^ 0o777)

    def copy_executable(src, dest):
        shutil.copyfile(src, dest)
        logging.debug('Copied %s to %s' % (src, dest))
        os.chmod(dest, exe_mode)

    build_vars = eval(open(os.path.join(options.build_dir, 'build_config.py')).read())

    def process_template(template_str):
        class PercentSignTemplate(string.Template):
            delimiter = '%'

        try:
            template = PercentSignTemplate(template_str)
            return template.substitute(build_vars)
        except KeyError as e:
            raise Exception('Unbound var %s in template' % (e))
        except Exception as e:
            raise Exception('Exception %s in template' % (e))

    bin_dir = os.path.join(options.destdir, options.bindir)
    lib_dir = os.path.join(options.destdir, options.libdir)
    doc_dir = os.path.join(options.destdir, options.docdir)
    include_dir = os.path.join(options.destdir, options.includedir)
    botan_doc_dir = os.path.join(doc_dir, 'botan' + options.doc_dir_suffix)

    versioned_include_dir = os.path.join(include_dir, options.versioned_include_dir)

    botan_include_dir = os.path.join(versioned_include_dir, 'botan')

    out_dir = process_template('%{out_dir}')
    app_exe = process_template('botan%{program_suffix}')

    for d in [options.destdir, lib_dir, bin_dir, doc_dir, botan_include_dir]:
        makedirs(d)

    build_include_dir = os.path.join(options.build_dir, 'include', 'botan')

    for include in os.listdir(build_include_dir):
        if include == 'internal':
            continue
        shutil.copyfile(os.path.join(build_include_dir, include),
                        os.path.join(botan_include_dir, include))

    static_lib = process_template('%{lib_prefix}%{libname}.%{static_suffix}')
    shutil.copyfile(static_lib, os.path.join(lib_dir, os.path.basename(static_lib)))

    if bool(build_vars['with_shared_lib']):
        shared_lib = process_template('%{lib_prefix}%{libname}.%{so_suffix}.%{so_abi_rev}.%{version_patch}')
        soname = process_template('%{lib_prefix}%{libname}.%{so_suffix}.%{so_abi_rev}')
        baselib = process_template('%{lib_prefix}%{libname}.%{so_suffix}')

        copy_executable(shared_lib, os.path.join(lib_dir, os.path.basename(shared_lib)))

        prev_cwd = os.getcwd()

        try:
            os.chdir(lib_dir)

            try:
                os.unlink(soname)
            except OSError as e:
                if e.errno != errno.ENOENT:
                    raise e

            try:
                os.unlink(baselib)
            except OSError as e:
                if e.errno != errno.ENOENT:
                    raise e

            os.symlink(shared_lib, soname)
            os.symlink(soname, baselib)
        finally:
            os.chdir(prev_cwd)

    copy_executable(os.path.join(out_dir, app_exe), os.path.join(bin_dir, app_exe))

    if 'botan_config' in build_vars:
        copy_executable(build_vars['botan_config'],
                        os.path.join(bin_dir, os.path.basename(build_vars['botan_config'])))

    if 'botan_pkgconfig' in build_vars:
        pkgconfig_dir = os.path.join(options.destdir, options.libdir, options.pkgconfigdir)
        makedirs(pkgconfig_dir)
        shutil.copyfile(build_vars['botan_pkgconfig'],
                        os.path.join(pkgconfig_dir, os.path.basename(build_vars['botan_pkgconfig'])))

    shutil.rmtree(botan_doc_dir, True)
    shutil.copytree(build_vars['doc_output_dir'], botan_doc_dir)

    with open(os.path.join(botan_doc_dir, 'license.txt'), 'w+') as lic:
        lic.write(license_text('doc/license.rst'))

    with combine_relnotes.open_for_utf8(os.path.join(botan_doc_dir, 'news.txt'), 'w+') as news:
        news.write(combine_relnotes.combine_relnotes('doc/relnotes', False))

    logging.info('Botan %s installation complete', build_vars['version'])

if __name__ == '__main__':
    try:
        sys.exit(main())
    except Exception as e:
        logging.error('Failure: %s' % (e))
        import traceback
        logging.info(traceback.format_exc())
        sys.exit(1)