fslinstaller.py 43.1 KB
Newer Older
1
#!/usr/bin/env python
2
3
4
#
# FSL installer script.
#
5
6


7
from __future__ import print_function, division, unicode_literals
8

9
10
11
import functools      as ft
import os.path        as op
import subprocess     as sp
12
import textwrap       as tw
13
14
15
import                   argparse
import                   contextlib
import                   getpass
Paul McCarthy's avatar
Paul McCarthy committed
16
import                   hashlib
17
18
import                   json
import                   logging
19
import                   os
20
import                   platform
21
import                   re
22
23
import                   shlex
import                   shutil
24
import                   sys
25
import                   tempfile
26
27
import                   threading
import                   time
28

29
# TODO check py2/3
30
31
32
33
34
35
36
37
try:
    import                   urllib
    import urllib.parse   as urlparse
    import urllib.request as urlrequest
except ImportError:
    import urllib2 as urllib
    import urllib2 as urlparse
    import urllib2 as urlrequest
38

39
40
41
42
43
44
try:                import queue
except ImportError: import Queue as queue


PY2 = sys.version[0] == '2'

45

46
47
48
log = logging.getLogger(__name__)


Paul McCarthy's avatar
Paul McCarthy committed
49
50
51
52
53
54
55
56
57
58
59
60
__version__ = '0.0.0'
"""Installer version number. This is automatically updated in release versions
whenever a new version is released.
"""


DEFAULT_INSTALLATION_DIRECTORY = '/usr/local/fsl'
"""Default FSL installation directory. """


FSL_INSTALLER_MANIFEST = 'http://18.133.213.73/installer/manifest,json'
"""URL to download the FSL installer manifest file from. The installer
61
62
63
64
65
manifest file is a JSON file which contains information about available FSL
versions.

See the Context.download_manifest function, and an example manifest file
in test/data/manifest.json, for more details.
Paul McCarthy's avatar
Paul McCarthy committed
66
67
68
"""


69
70
71
72
73
74
SUPPORTED_CUDAS = ['9.2', '10.2', '11.1']
"""Versions of CUDA that CUDA-capable FSL packages are built for. Used
by Context.identify_cuda. Must be in increasing order.
"""


Paul McCarthy's avatar
Paul McCarthy committed
75
76
77
78
79
80
class InvalidPassword(Exception):
    """Exception raised by Context.get_admin_password if the user gives an
    incorrect password.
    """


81
82
83
84
85
86
87
88
89
90
91
92
class UnknownVersion(Exception):
    """Exception raised by Context.build if the user has requested a FSL
    version that does not exist.
    """


class BuildNotAvailable(Exception):
    """Exception raised by Context.build if there is no available FSL version
    that matches the target platform and/or requested CUDA version.
    """


93
94
95
96
97
98
class UnsupportedPlatform(Exception):
    """Exception raised by the identify_platform function if FSL is not
    available on this platform.
    """


Paul McCarthy's avatar
Paul McCarthy committed
99
100
101
class Context(object):
    """Bag of information and settings created in main, and passed around
    this script.
102
103
104

    Several settings are lazily evaluated on first access, but once evaluated,
    their values are immutable.
Paul McCarthy's avatar
Paul McCarthy committed
105
106
107
    """

    def __init__(self, args):
108
109
110
        """Create the context with the argparse.Namespace object containing
        parsed command-line arguments.
        """
111

112
113
        self.args  = args
        self.shell = op.basename(os.environ['SHELL'])
Paul McCarthy's avatar
Paul McCarthy committed
114
115

        # These attributes are updated on-demand via
116
117
118
119
120
121
122
        # the property accessors defined below, or all
        # all updated via the finalise-settings method.
        self.__platform       = None
        self.__cuda           = None
        self.__manifest       = None
        self.__build          = None
        self.__destdir        = None
Paul McCarthy's avatar
Paul McCarthy committed
123
124
        self.__need_admin     = None
        self.__admin_password = None
125
126
127


    def finalise_settings(self):
128
129
        """Finalise values for all information and settings in the Context.
        """
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
        self.platform
        self.cuda
        self.manifest
        self.build
        self.destdir
        self.need_admin
        self.admin_password


    @property
    def platform(self):
        """The platform we are running on, e.g. "linux-64", "macos-64". """
        if self.__platform is None:
            self.__platform = Context.identify_platform()
        return self.__platform


    @property
    def cuda(self):
        """The available CUDA version, or a CUDA version requested by the user.
        """
        if self.__cuda is not None:
            return self.__cuda
        if self.args.cuda is not None:
            self.__cuda = self.args.cuda
        if self.__cuda is None:
            self.__cuda = Context.identify_cuda()
        return self.__cuda


    @property
    def build(self):
        """Returns a suitable FSL build (a dictionary entry from the FSL
163
164
        installer manifest) for the target platform and requested FSL/CUDA
        versions.
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
        """

        fslversion = self.args.fslversion

        if fslversion not in self.manifest['versions']:
            raise UnknownVersion(
                'FSL version {} is not available'.format(args.fslversion))

        if fslversion == 'latest':
            fslversion = self.manifest['versions']['latest']

        match = None

        for build in self.manifest['versions'][fslversion]:
            if build['platform']       == self.platform and \
               build.get('cuda', None) == self.cuda:
                match = build
                break
        else:
            raise BuildNotAvailable(
                'Cannot find a version of FSL matching platform '
                '{} and CUDA {}'.format(self.platform, self.cuda))

        return match
Paul McCarthy's avatar
Paul McCarthy committed
189
190
191
192


    @property
    def destdir(self):
193
194
195
        """Installation directory. If not specified at the command line, the
        user is prompted to enter a directory.
        """
196
197
198
199
200
201
202
203
204

        if self.__destdir is not None:
            return self.__destdir

        # The loop below validates the destination directory
        # both when specified at commmand line or
        # interactively.  In either case, if invalid, the
        # user is re-prompted to enter a new destination.
        destdir = None
205
        if self.args.dest is not None:
206
207
208
209
210
211
212
            response = self.args.dest
        else:
            response = None

        while destdir is None:

            if response is None:
213
214
215
216
217
218
                printmsg('Where do you want to install FSL?',
                         IMPORTANT, EMPHASIS)
                printmsg('Press enter to install to the default location [{}]'
                         .format(DEFAULT_INSTALLATION_DIRECTORY), INFO)
                response = prompt('FSL installation directory:', QUESTION)
                response = response.rstrip(op.sep)
219

220
221
                if response == '':
                    response = DEFAULT_INSTALLATION_DIRECTORY
222
223
224
225
226
227
228
229
230
231
232

            response  = op.abspath(response)
            parentdir = op.dirname(response)
            if op.exists(parentdir):
                destdir = response
            else:
                printmsg('Destination directory {} does not '
                         'exist!'.format(parentdir), ERROR)
                response = None

        self.__destdir = destdir
Paul McCarthy's avatar
Paul McCarthy committed
233
234
235
236
237
        return self.__destdir


    @property
    def need_admin(self):
238
239
240
        """Returns True if administrator privileges will be needed to install
        FSL.
        """
Paul McCarthy's avatar
Paul McCarthy committed
241
242
        if self.__need_admin is not None:
            return self.__need_admin
243
244
245
        parentdir = op.dirname(self.destdir)
        self.__need_admin = Context.check_need_admin(parentdir)
        return self.__need_admin
Paul McCarthy's avatar
Paul McCarthy committed
246
247
248
249


    @property
    def admin_password(self):
250
251
        """Returns the user's administrator password, prompting them if needed.
        """
Paul McCarthy's avatar
Paul McCarthy committed
252
253
254
255
256
257
258
259
260
261
262
        if self.__admin_password is not None:
            return self.__admin_password
        if self.__need_admin == False:
            return None
        if self.__destdir is None:
            raise RuntimeError('Destination directory has not been set')
        self.__admin_password = Context.get_admin_password()


    @property
    def manifest(self):
263
        """Returns the FSL installer manifest as a dictionary. """
Paul McCarthy's avatar
Paul McCarthy committed
264
        if self.__manifest is None:
265
266
            self.__manifest = Context.download_manifest(self.args.manifest,
                                                        self.args.workdir)
Paul McCarthy's avatar
Paul McCarthy committed
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
        return self.__manifest


    @staticmethod
    def identify_platform():
        """Figures out what platform we are running on. Returns a platform
        identifier string - one of:

          - "linux-64" (Linux, x86_64)
          - "macos-64" (macOS, x86_64)
        """

        platforms = {
            ('linux',  'x86_64') : 'linux-64',
            ('darwin', 'x86_64') : 'linux-64',
282
283
284

            # M1 builds (and possbily ARM for Linux)
            # will be added in the future
Paul McCarthy's avatar
Paul McCarthy committed
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
            ('darwin', 'arm64')  : 'macos-64',
        }

        system = platform.system().lower()
        cpu    = platform.machine()
        key    = (system, cpu)

        if key not in platforms:
            raise UnsupportedPlatform()

        return platforms[key]


    @staticmethod
    def identify_cuda():
        """Identifies the CUDA version supported on the platform. Returns a
301
302
        string containing the 'X.Y' CUDA version, or None if CUDA is not
        supported.
Paul McCarthy's avatar
Paul McCarthy committed
303
304
        """

305
306
307
        if getattr(Context.identify_cuda, 'no_cuda', False):
            return None

Paul McCarthy's avatar
Paul McCarthy committed
308
        try:
309
            output = Process.check_output('nvidia-smi')
310
        except Exception:
311
            Context.identify_cuda.no_cuda = True
Paul McCarthy's avatar
Paul McCarthy committed
312
313
            return None

314
315
316
317
318
319
320
321
        pat   = r'CUDA Version: (\S+)'
        lines = output.split('\n')
        for line in lines:
            match = re.search(pat, line)
            if match:
                cudaver = match.group(1)
                break
        else:
322
            Context.identify_cuda.no_cuda = True
323
            return None
Paul McCarthy's avatar
Paul McCarthy committed
324
325
326

        # Return the most suitable CUDA
        # version that we have a build for
327
328
329
        for supported in reversed(SUPPORTED_CUDAS):
            if float(cudaver) >= float(supported):
                return supported
Paul McCarthy's avatar
Paul McCarthy committed
330

331
        Context.identify_cuda.no_cuda = True
332
        return None
Paul McCarthy's avatar
Paul McCarthy committed
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348


    @staticmethod
    def check_need_admin(dirname):
        """Returns True if dirname needs administrator privileges to write to,
        False otherwise.
        """
        # TODO os.supports_effective_ids added in python 3.3
        return not os.access(dirname, os.W_OK | os.X_OK)


    @staticmethod
    def get_admin_password():
        """Prompt the user for their administrator password."""

        def validate_admin_password(password):
349
350
351
            proc = sudo_popen(['true'], password)
            proc.communicate()
            return proc.returncode == 0
Paul McCarthy's avatar
Paul McCarthy committed
352

Paul McCarthy's avatar
Paul McCarthy committed
353
354
355
356
357
358
359
        for attempt in range(3):
            if attempt == 0:
                msg = 'Your administrator password is needed to ' \
                      'install FSL: '
            else:
                msg = 'Your administrator password is needed to ' \
                      'install FSL [attempt {} of 3]:'.format(attempt + 1)
360
            printmsg(msg, IMPORTANT, end='')
Paul McCarthy's avatar
Paul McCarthy committed
361
362
363
            password = getpass.getpass('')
            valid    = validate_admin_password(password)

Paul McCarthy's avatar
Paul McCarthy committed
364
            if valid:
365
                printmsg('Password accepted', INFO)
Paul McCarthy's avatar
Paul McCarthy committed
366
367
368
                break
            else:
                printmsg('Incorrect password', WARNING)
Paul McCarthy's avatar
Paul McCarthy committed
369
370
371
372
373
374
375
376

        if not valid:
            raise InvalidPassword()

        return password


    @staticmethod
377
    def download_manifest(url, workdir=None):
Paul McCarthy's avatar
Paul McCarthy committed
378
379
380
381
        """Downloads the installer manifest file, which contains information
        about available FSL vesrions, and the most recent version number of the
        installer (this script).

382
383
384
        The manifest file is a JSON file. Lines beginning
        with a double-forward-slash are ignored. See test/data/manifes.json
        for an example.
Paul McCarthy's avatar
Paul McCarthy committed
385
386
387
388
        """

        log.debug('Downloading FSL installer manifest from %s', url)

389
        with tempdir(workdir):
Paul McCarthy's avatar
Paul McCarthy committed
390
391
            download_file(url, 'manifest.json')
            with open('manifest.json') as f:
392
393
394
395
                lines = f.readlines()

        # Drop comments
        lines = [l for l in lines if not l.lstrip().startswith('//')]
Paul McCarthy's avatar
Paul McCarthy committed
396

397
        return json.loads('\n'.join(lines))
Paul McCarthy's avatar
Paul McCarthy committed
398
399


400
401
402
403
404
405
406
407
408
409
410
411
# List of modifiers which can be used to change how
# a message is printed by the printmsg function.
INFO      = 1
IMPORTANT = 2
QUESTION  = 3
PROMPT    = 4
WARNING   = 5
ERROR     = 6
EMPHASIS  = 7
UNDERLINE = 8
RESET     = 9
ANSICODES = {
412
413
414
415
416
417
418
419
420
    INFO      : '\033[37m',         # Light grey
    IMPORTANT : '\033[92m',         # Green
    QUESTION  : '\033[36m\033[4m',  # Blue+underline
    PROMPT    : '\033[36m\033[1m',  # Bright blue+bold
    WARNING   : '\033[93m',         # Yellow
    ERROR     : '\033[91m',         # Red
    EMPHASIS  : '\033[1m',          # White+bold
    UNDERLINE : '\033[4m',          # Underline
    RESET     : '\033[0m',          # Used internally
421
422
423
}


424
def printmsg(msg='', *msgtypes, **kwargs):
425
426
427
428
429
430
    """Prints msg according to the ANSI codes provided in msgtypes.
    All other keyword arguments are passed through to the print function.
    """
    msgcodes = [ANSICODES[t] for t in msgtypes]
    msgcodes = ''.join(msgcodes)
    print('{}{}{}'.format(msgcodes, msg, ANSICODES[RESET]), **kwargs)
431
    sys.stdout.flush()
432
433
434
435
436
437


def prompt(prompt, *msgtypes, **kwargs):
    """Prompts the user for some input. msgtypes and kwargs are passed
    through to the printmsg function.
    """
438
    printmsg(prompt, *msgtypes, end='', **kwargs)
439
440
441

    if PY2: return raw_input(' ').strip()
    else:   return input(    ' ').strip()
442
443


444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
class Progress(object):
    """Simple progress reporter. Displays one of the following:

       - If both a value and total are provided, a progress bar is shown
       - If only a value is provided, a cumulative count is shown
       - If nothing is provided, a spinner is shown.

    Use as a context manager, and call the update method to report progress,
    e,g:

        with Progress('%') as p:
            for i in range(100):
                p.update(i + 1, 100)
    """

    def __init__(self,
                 label='',
                 transform=None,
                 fmt='{:.1f}',
                 total=None,
                 width=None):
        """Create a Progress reporter.

        :arg label:     Units (e.g. "MB", "%",)

        :arg transform: Function to transform values (see e.g.
                        Progress.bytes_to_mb)

        :arg fmt:       Template string used to format value / total.

        :arg total:     Maximum value - overrides the total value passed to
                        the update method.

        :arg width:     Maximum width, if a progress bar is displayed. Default
                        is to automatically infer the terminal width (see
                        Progress.get_terminal_width).
        """

        if transform is None:
            transform = Progress.default_transform

        self.width     = width
        self.fmt       = fmt.format
        self.total     = total
        self.label     = label
        self.transform = transform

        # used by the spin function
        self.__last_spin = None

    @staticmethod
    def default_transform(val, total):
        return val, total

    @staticmethod
    def bytes_to_mb(val, total):
        if val   is not None: val   = val   / 1048576
        if total is not None: total = total / 1048576
        return val, total

    @staticmethod
    def percent(val, total):
        if val is None or total is None:
            return val, total
        return 100 * (val / total), 100

    def __enter__(self):
        return self

    def __exit__(self, *args, **kwargs):
        printmsg()

    def update(self, value=None, total=None):

        if total is None:
            total = self.total

        value, total = self.transform(value, total)

        if value is None and total is None:
            self.spin()
        elif value is not None and total is None:
            self.count(value)
        elif value is not None and total is not None:
            self.progress(value, total)

    def spin(self):

        symbols = ['|', '/', '-',  '\\']

        if self.__last_spin is not None: last = self.__last_spin
        else:                            last = symbols[-1]

        idx  = symbols.index(last)
        idx  = (idx + 1) % len(symbols)
        this = symbols[idx]

        printmsg(this, end='\r')
        self.__last_spin = this

    def count(self, value):
        value = self.fmt(value)
        line  = '{}{} ...'.format(value, self.label)
        printmsg(line, end='\r')

    def progress(self, value, total):

551
        value = min(value, total)
552
553
554
555
556
557

        # arbitrary fallback of 50 columns if
        # terminal width cannot be determined
        if self.width is None: width = Progress.get_terminal_width(50)
        else:                  width = self.width

558
559
560
561
562
563
        fvalue = self.fmt(value)
        ftotal = self.fmt(total)
        suffix = '{} / {} {}'.format(fvalue, ftotal, self.label).rstrip()

        # +5: - square brackets around bar
        #     - space between bar and tally
564
        #     - space+spin at the end
565
        width     = width - (len(suffix) + 5)
566
567
        completed = int(round(width * (value  / total)))
        remaining = width - completed
568
569
570
        progress  = '[{}{}] {}'.format('#' * completed,
                                       ' ' * remaining,
                                       suffix)
571

572
        printmsg(progress, end='')
573
574
        printmsg(' ', end='')
        self.spin()
575
        printmsg(end='\r')
576
577
578
579
580
581
582


    @staticmethod
    def get_terminal_width(fallback=None):
        """Return the number of columns in the current terminal, or fallback
        if it cannot be determined.
        """
583
        # os.get_terminal_size added in python
584
585
586
587
        # 3.3, so we try it but fall back to tput
        if hasattr(os, 'get_terminal_size'):
            return os.get_terminal_size()[0]

588
        try:
589
            result = Process.check_output('tput cols', log_output=False)
590
            return int(result.strip())
591
        except Exception:
592
593
594
            return fallback


595
@contextlib.contextmanager
596
597
598
599
600
601
def tempdir(override_dir=None):
    """Returns a context manager which creates, changes into, and returns a
    temporary directory, and then deletes it on exit.

    If override_dir is not None, instead of creating and changing into a
    temporary directory, this function just changes into override_dir.
602
603
    """

604
605
606
    if override_dir is None: tmpdir = tempfile.mkdtemp()
    else:                    tmpdir = override_dir

607
608
609
    prevdir = os.getcwd()

    try:
610
611
        os.chdir(tmpdir)
        yield tmpdir
612
613
614

    finally:
        os.chdir(prevdir)
615
616
        if override_dir is None:
            shutil.rmtree(tmpdir)
617
618
619
620
621
622
623
624
625
626
627
628
629
630


def memoize(f):
    """Decorator to memoize a function. """

    cache = f.cache = {}
    def g(*args, **kwargs):
        key = (f, tuple(args), frozenset(kwargs.items()))
        if key not in cache:
            cache[key] = f(*args, **kwargs)
        return cache[key]
    return g


Paul McCarthy's avatar
Paul McCarthy committed
631
632
633
634
class ChecksumError(Exception):
    """Exception raised by the sha256 function if a file checksume does
    not match the expected checksum.
    """
635
636


637
def sha256(filename, check_against=None, blocksize=1048576):
Paul McCarthy's avatar
Paul McCarthy committed
638
639
640
    """Calculate the SHA256 checksum of the given file. If check_against
    is provided, it is compared against the calculated checksum, and an
    error is raised if they are not the same.
641
642
    """

Paul McCarthy's avatar
Paul McCarthy committed
643
    hashobj = hashlib.sha256()
644

Paul McCarthy's avatar
Paul McCarthy committed
645
646
647
648
649
650
    with open(filename, 'rb') as f:
        while True:
            block = f.read(blocksize)
            if len(block) == 0:
                break
            hashobj.update(block)
651

Paul McCarthy's avatar
Paul McCarthy committed
652
653
    checksum = hashobj.hexdigest()

654
    if check_against is not None:
Paul McCarthy's avatar
Paul McCarthy committed
655
        if checksum != check_against:
656
657
658
659
            raise ChecksumError('File {} does not match expected checksum '
                                '({})'.format(filename, check_against))

    return checksum
660
661


Paul McCarthy's avatar
Paul McCarthy committed
662
663
664
665
class DownloadFailed(Exception):
    """Exception type raised by the download_file function if a
    download fails for some reason.
    """
666
667


668
def download_file(url, destination, progress=None, blocksize=131072):
Paul McCarthy's avatar
Paul McCarthy committed
669
670
    """Download a file from url, saving it to destination. """

671
672
    def default_progress(downloaded, total):
        pass
Paul McCarthy's avatar
Paul McCarthy committed
673

674
675
676
677
    if progress is None:
        progress = default_progress

    log.debug('Downloading %s ...', url)
Paul McCarthy's avatar
Paul McCarthy committed
678

679
    req = None
Paul McCarthy's avatar
Paul McCarthy committed
680
    try:
681
682
683
684
        # py2: urlopen result cannot be
        # used as a context manager
        req = urlrequest.urlopen(url)
        with open(destination, 'wb') as outf:
Paul McCarthy's avatar
Paul McCarthy committed
685
686
687
688
689
690

            try:             total = int(req.headers['content-length'])
            except KeyError: total = None

            downloaded = 0

Paul McCarthy's avatar
Paul McCarthy committed
691
            progress(downloaded, total)
Paul McCarthy's avatar
Paul McCarthy committed
692
693
694
695
696
697
            while True:
                block = req.read(blocksize)
                if len(block) == 0:
                    break
                downloaded += len(block)
                outf.write(block)
698
                progress(downloaded, total)
Paul McCarthy's avatar
Paul McCarthy committed
699

700
701
702
703
    except Exception:
        raise DownloadFailed('A network error has occurred while '
                             'trying to download {}'.format(url))
    finally:
704
705
        if req:
            req.close()
Paul McCarthy's avatar
Paul McCarthy committed
706
707


708
class Process(object):
709
    """Container for a subprocess.Popen object, allowing non-blocking
710
711
712
713
714
715
716
    line-based access to its standard output and error streams via separate
    queues, while logging all outputs.

    Don't create a Process directly - use one of the following static methods:
     - Process.check_output
     - Process.check_call
     - Process.monitor_progress
717
718
    """

719

720
    def __init__(self, cmd, admin=False, ctx=None, log_output=True, **kwargs):
721
722
        """Run the specified command. Starts threads to capture stdout and
        stderr.
723

724
725
726
727
728
729
730
        :arg cmd:        Command to run - passed directly to subprocess.Popen
        :arg admin:      Run the command with administrative privileges
        :arg ctx:        The installer Context. Only used for admin password -
                         can be None if admin is False.
        :arg log_output: If True, the command and all of its stdout/stderr are
                         logged.
        :arg kwargs:     Passed to subprocess.Popen
731
        """
732

733
734
735
736
737
738
739
740
741
742
743
        self.ctx        = ctx
        self.cmd        = cmd
        self.admin      = admin
        self.log_output = log_output
        self.stdoutq    = queue.Queue()
        self.stderrq    = queue.Queue()

        if log_output:
            log.debug('Running %s [as admin: %s]', cmd, admin)

        self.popen = Process.popen(self.cmd, self.admin, self.ctx)
744

745
        # threads for consuming stdout/stderr
746
747
        self.stdout_thread = threading.Thread(
            target=Process.forward_stream,
748
            args=(self.popen, self.stdoutq, cmd, 'stdout', log_output))
749
750
        self.stderr_thread = threading.Thread(
            target=Process.forward_stream,
751
            args=(self.popen, self.stderrq, cmd, 'stderr', log_output))
752

753
754
755
756
        self.stdout_thread.daemon = True
        self.stderr_thread.daemon = True
        self.stdout_thread.start()
        self.stderr_thread.start()
757
758


759
760
761
762
763
764
765
766
767
    def wait(self):
        """Waits for the process to terminate, then waits for the stdout
        and stderr consumer threads to finish.
        """
        self.popen.wait()
        self.stdout_thread.join()
        self.stderr_thread.join()


768
769
770
771
772
773
774
775
776
777
778
    @property
    def returncode(self):
        """Process return code. Returns None until the process has terminated,
        and the stdout/stderr consumer threads have finished.
        """
        if self.popen.returncode is None: return None
        if self.stdout_thread.is_alive(): return None
        if self.stderr_thread.is_alive(): return None
        return self.popen.returncode


779
    @staticmethod
780
    def check_output(cmd, *args, **kwargs):
781
782
783
        """Behaves like subprocess.check_output. Runs the given command, then
        waits until it finishes, and return its standard output. An error
        is raised if the process returns a non-zero exit code.
784

785
        :arg cmd: The command to run, as a string
786
787
        """

788
        proc = Process(cmd, *args, **kwargs)
789
        proc.wait()
790

791
        if proc.returncode != 0:
792
793
            raise RuntimeError(cmd)

794
795
796
797
798
799
800
801
        stdout = ''
        while True:
            try:
                stdout += proc.stdoutq.get_nowait()
            except queue.Empty:
                break

        return stdout
802
803
804


    @staticmethod
805
    def check_call(cmd, *args, **kwargs):
806
807
808
809
        """Behaves like subprocess.check_call. Runs the given command, then
        waits until it finishes. An error is raised if the process returns a
        non-zero exit code.

810
        :arg cmd: The command to run, as a string
811
        """
812
        proc = Process(cmd, *args, **kwargs)
813
        proc.wait()
814
        if proc.returncode != 0:
815
816
817
818
            raise RuntimeError(cmd)


    @staticmethod
819
    def monitor_progress(cmd, total=None, *args, **kwargs):
820
821
822
823
824
825
826
827
828
829
        """Runs the given command, and shows a progress bar under the
        assumption that cmd will produce "total" number of lines of output.
        """
        if total is None: label = None
        else:             label = '%'

        with Progress(label=label,
                      fmt='{:.0f}',
                      transform=Progress.percent) as prog:

830
            proc   = Process(cmd, *args, **kwargs)
831
832
833
834
            nlines = 0

            prog.update(nlines, total)

835
            while proc.returncode is None:
836
                try:
837
838
                    line    = proc.stdoutq.get(timeout=0.5)
                    nlines += 1
839
                except queue.Empty:
840
                    pass
841
842
843
844
845

                prog.update(nlines, total)


    @staticmethod
846
    def forward_stream(popen, queue, cmd, streamname, log_output):
847
848
849
850
851
852
853
        """Reads lines from stream and pushes them onto queue until popen
        is finished. Logs every line.

        :arg popen:      subprocess.Popen object
        :arg queue:      queue.Queue to push lines onto
        :arg cmd:        string - the command that is running
        :arg streamname: string - 'stdout' or 'stderr'
854
        :arg log_output: If True, log all stdout/stderr.
855
856
857
858
859
860
861
862
863
864
865
866
        """

        if streamname == 'stdout': stream = popen.stdout
        else:                      stream = popen.stderr

        while popen.returncode is None:
            line = stream.readline().decode('utf-8')
            popen.poll()
            if line == '':
                break
            else:
                queue.put(line)
867
868
                if log_output:
                    log.debug('%s [%s]: %s', cmd, streamname, line.rstrip())
869
870
871
872
873

        # process finished, flush the stream
        line = stream.readline().decode('utf-8')
        while line != '':
            queue.put(line)
874
875
            if log_output:
                log.debug('%s [%s]: %s', cmd, streamname, line)
876
877
878
879
880
881
882
            line = stream.readline().decode('utf-8')


    @staticmethod
    def popen(cmd, admin=False, ctx=None):
        """Runs the given command via subprocess.Popen, as administrator if
        requested.
883
884
885
886
887
888
889
890
891

        :arg cmd:   The command to run, as a string

        :arg admin: Whether to run with administrative privileges

        :arg ctx:   The installer Context object. Only required if admin is
                    True.

        :returns:   The subprocess.Popen object.
892
893
894
895
896
897
898
        """

        admin = admin and os.getuid() != 0

        if admin: password = ctx.password
        else:     password = None

899
        cmd    = shlex.split(cmd)
900
        kwargs = dict(stdin=sp.PIPE, stdout=sp.PIPE, stderr=sp.PIPE)
901
902
903
904
905
906
907
908

        if admin: proc = Process.sudo_popen(cmd, password, **kwargs)
        else:     proc = sp.Popen(          cmd, **kwargs)

        return proc


    @staticmethod
909
910
911
    def sudo_popen(cmd, password, **kwargs):
        """Runs "sudo cmd" using subprocess.Popen. Used by Process.popen.
        Assumes that kwargs contains stdin=sp.PIPE
912
        """
913

914
915
916
917
        cmd  = ['sudo', '-S', '-k'] + cmd
        proc = sp.Popen(cmd, **kwargs)
        proc.stdin.write('{}\n'.format(password))
        return proc
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938


def list_available_versions(ctx):
    """Lists available FSL versions. """
    printmsg('Available FSL versions:', EMPHASIS)
    for version in ctx.manifest['versions']:
        if version == 'latest':
            continue
        printmsg(version, IMPORTANT, EMPHASIS)
        for build in ctx.manifest['versions'][version]:
            if build.get('cuda', '').strip() != '':
                template = '  {platform} [CUDA {cuda}]'
            else:
                template = '  {platform}'
            printmsg(template.format(**build), EMPHASIS, end=' ')
            printmsg(build['environment'], INFO)


def install_miniconda(ctx):
    """Downloads the miniconda/miniforge installer, and installs it to the
    destination directory.
939
940

    This function assumes that it is run within a temporary/scratch directory.
941
942
    """

943
    metadata = ctx.manifest['miniconda'][ctx.platform]
944
945
946
    url      = metadata['url']
    checksum = metadata['sha256']
    output   = metadata.get('output', '').strip()
947

948
949
    if output == '': output = None
    else:            output = int(output)
Paul McCarthy's avatar
Paul McCarthy committed
950

951
952
    # Download
    printmsg('Downloading miniconda from {}...'.format(url))
953
954
955
956
    with Progress('MB', transform=Progress.bytes_to_mb) as prog:
        download_file(url, 'miniforge.sh', prog.update)
    if not ctx.args.no_checksum:
        sha256('miniforge.sh', checksum)
957
958

    # Install
959
    printmsg('Installing miniconda at {}...'.format(ctx.destdir))
960
    cmd = 'sh miniforge.sh -b -p {}'.format(ctx.destdir)
961
    Process.monitor_progress(cmd, output, ctx.need_admin, ctx)
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996

    # Create .condarc config file
    condarc = tw.dedent("""
    # Putting a .condarc file into the root environment
    # directory will override ~/.condarc if it exists,
    # but will not override a system condarc (e.g. at
    # /etc/condarc/condarc). There is currently no
    # workaround for this - see:
    #  - https://github.com/conda/conda/issues/8599
    #  - https://github.com/conda/conda/issues/8804

    # Try and make package downloads more robust
    remote_read_timeout_secs:    240
    remote_connect_timeout_secs: 20
    remote_max_retries:          10
    remote_backoff_factor:       5
    safety_checks:               warn

    # Channel priority is important. In older versions
    # of FSL we placed the FSL conda channel at the
    # bottom (lowest priority) for legacy reasons (to
    # ensure that conda-forge versions of e.g. VTK were
    # preferred over legacy FSL conda versions).
    #
    # https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-channels.html
    channel_priority: strict
    channels:
      - http://18.133.213.73/production/
      - conda-forge
      - defaults
    """)

    with open('.condarc', 'wt') as f:
        f.write(condarc)

997
998
    Process.check_call('cp .condarc {}'.format(ctx.destdir),
                       ctx.need_admin, ctx)
999
1000
1001


def install_fsl(ctx):
1002
    """Install FSL into ctx.destdir (which is assumed to be a miniconda
1003
    installation.
1004
1005

    This function assumes that it is run within a temporary/scratch directory.
1006
1007
    """

1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
    build    = ctx.build
    url      = build['environment']
    checksum = build['sha256']
    output   = build.get('output', None)

    if output == '': output = None
    else:            output = int(output)

    printmsg('Downloading FSL environment specification '
             'from {}...'.format(url))
    download_file(url, 'environment.yml')

    conda = op.join(ctx.destdir, 'bin', 'conda')
    cmd   = conda + ' env update -n base -f environment.yml'

    printmsg('Installing FSL into {}...'.format(ctx.destdir))

    env = os.environ.copy()
    env['FSL_CREATE_WRAPPER_SCRIPTS'] = '1'

1028
    Process.monitor_progress(cmd, output, ctx.need_admin, ctx, env=env)
1029

1030

1031
1032
1033
1034
1035
1036
def post_install_cleanup(ctx):
    """Cleans up the FSL directory after installation. """

    conda = op.join(ctx.destdir, 'bin', 'conda')
    cmd   = conda + ' clean -y --all'

1037
    Process.check_call(cmd, ctx.need_admin, ctx)
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054


def patch_file(filename, searchline, numlines, content):
    """Used by configure_shell and configure_matlab. Adds to, modifies,
    or creates the specified file.

    If a line matching searchline is found in the file, numlines (starting
    from searchline) are replaced with content.

    Otherwise, content is appended to the end of the file.
    """

    content = content.split('\n')

    if op.isfile(filename):
        with open(filename) as f:
            lines = [l.strip() for l in f.readlines()]
1055
    else:
1056
        lines = []
1057

1058
1059
1060
1061
    # replace block
    try:
        idx   = lines.index(searchline)
        lines = lines[:idx] + content + lines[idx + numlines:]
1062

1063
1064
1065
    # append to end
    except ValueError:
        lines = lines + [''] + content
1066

1067
1068
    with open(filename, 'wt') as f:
        f.write('\n'.join(lines))
1069
1070


1071
def configure_shell(ctx):
1072
    """Configures the user's shell environment (e.g. ~/.bash_profile). """
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157

    bourne_shells  = ['sh', 'bash', 'zsh', 'dash']
    csh_shells     = ['csh', 'tcsh']

    # we edit the first file that exists
    # in the list of candidate profile files,
    shell_profiles = {'sh'   : ['.profile'],
                      'bash' : ['.bash_profile', '.profile'],
                      'dash' : ['.bash_profile', '.profile'],
                      'zsh'  : ['.zprofile'],
                      'csh'  : ['.cshrc'],
                      'tcsh' : ['.tcshrc']}

    # Do not change the format of these configurations -
    # they are kept exactly as-is for compatibility with
    # legacy FSL installations, i.e. so we can modify
    # profiles with an existing configuration from older
    # FSL versions
    bourne_cfg = tw.dedent("""
    # FSL Setup
    FSLDIR={fsldir}
    PATH=${{FSLDIR}}/share/fsl/bin:${{PATH}}
    export FSLDIR PATH
    . ${{FSLDIR}}/etc/fslconf/fsl.sh
    """).format(fsldir=ctx.destdir)

    csh_cfg = tw.dedent("""
    # FSL Setup
    setenv FSLDIR {fsldir}
    setenv PATH ${{FSLDIR}}/share/fsl/bin:${{PATH}}
    source ${{FSLDIR}}/etc/fslconf/fsl.csh
    """).format(fsldir=ctx.destdir)

    if ctx.shell not in bourne_shells + csh_shells:
        printmsg('Shell {} not recognised - skipping environment '
                 'setup'.format(ctx.shell), WARNING, EMPHASIS)
        return

    if ctx.shell in bourne_shells: cfg = bourne_cfg
    else:                          cfg = csh_cfg

    # find the profile file to edit
    profile    = None
    candidates = [op.join(ctx.args.homedir, p)
                  for p in shell_profiles[ctx.shell]]
    for candidate in candidates:
        if op.isfile(candidate):
            profile = candidate
            break

    # if no candidate profile files
    # exist, fall back to the first one
    if profile is None:
        profile = candidates[0]

    printmsg('Adding FSL configuration to {}'.format(profile))

    patch_file(profile, '# FSL Setup', len(cfg.split('\n')), cfg)


def configure_matlab(ctx):
    """Creates/appends FSL configuration code to ~/Documents/MATLAB/startup.m.
    """

    # Do not change the format of this configuration -
    # see in-line comments in configure_shell.
    cfg = tw.dedent("""
    % FSL Setup
    setenv( 'FSLDIR', '{fsldir}' );
    setenv('FSLOUTPUTTYPE', 'NIFTI_GZ');
    fsldir = getenv('FSLDIR');
    fsldirmpath = sprintf('%s/etc/matlab',fsldir);
    path(path, fsldirmpath);
    clear fsldir fsldirmpath;
    """).format(fsldir=ctx.destdir)

    matlab_dir = op.expanduser(op.join(ctx.args.homedir, 'Documents', 'MATLAB'))
    startup_m  = op.join(matlab_dir, 'startup.m')

    if not op.exists(matlab_dir):
        os.makedirs(matlab_dir)

    printmsg('Adding FSL configuration to {}'.format(startup_m))

    patch_file(startup_m, '% FSL Setup', len(cfg.split('\n')), cfg)
1158
1159


Paul McCarthy's avatar
Paul McCarthy committed
1160
def self_update(ctx):
1161
    """Checks to see if a newer version of the installer (this script) is
1162
    available and if so, downloads it to a temporary file, and runs it in
Paul McCarthy's avatar
Paul McCarthy committed
1163
    place of this script.
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
    """

    @ft.total_ordering
    class Version(object):
        """Class to hold and compare FSL installer version strings.  Version
        strings must be of the form X.Y.Z, where X, Y, and Z are all integers.
        """
        def __init__(self, verstr):
            major, minor, patch = verstr.split('.')[:3]
            self.verstr         = verstr
            self.major          = int(major)
            self.minor          = int(minor)
            self.patch          = int(patch)

        def __str__(self):
            return self.verstr

        def __eq__(self, other):
            return all((self.major == other.major,
                        self.minor == other.minor,
                        self.patch == other.patch))

        def __lt__(self, other):
            for p1, p2 in zip((self.major,  self.minor,  self.patch),
                              (other.major, other.minor, other.patch)):
                if p1 < p2: return True
                if p1 > p2: return False
            return False

    thisver   = Version(__version__)
Paul McCarthy's avatar
Paul McCarthy committed
1194
    latestver = Version(ctx.manifest['installer']['version'])
1195
1196
1197
1198
1199
1200

    if latestver <= thisver:
        log.debug('Installer is up to date (this vesrion: %s, '
                  'latest version: %s)', thisver, latestver)
        return

Paul McCarthy's avatar
Paul McCarthy committed
1201
1202
    log.debug('New version of installer is available '
              '(%s) - self-updating', latestver)
1203

1204
1205
    tmpf = tempfile.NamedTemporaryFile(
        prefix='new_fslinstaller', delete=False, dir=ctx.args.workdir)
Paul McCarthy's avatar
Paul McCarthy committed
1206
1207
    tmpf.close()
    tmpf = tmpf.name
1208

Paul McCarthy's avatar
Paul McCarthy committed
1209
    download_file(ctx.manifest['installer']['url'], tmpf)
1210

1211
    if not ctx.args.no_checksum:
1212
        sha256(tmpf, ctx.manifest['installer']['sha256'])
1213

Paul McCarthy's avatar
Paul McCarthy committed
1214
1215
1216
    cmd = [sys.executable, tmpf] + sys.argv[1:]
    log.debug('Running new installer: %s', cmd)
    os.execv(sys.executable, cmd)
1217
1218


1219
def overwrite_destdir(ctx):
1220
1221
1222
    """Called by main if the destination directory already exists.  Asks the
    user if they want to overwrite it and, if they say yes, removes the
    existing destination directory. Otherwise exits.
1223
    """
1224
1225
1226
1227
1228
1229
1230
1231
1232

    if not ctx.args.overwrite:
        printmsg('Destination directory [{}] already exists!'
                 .format(ctx.destdir), WARNING, EMPHASIS)
        response = prompt('Do you want to overwrite it [N/y]?',
                          WARNING, EMPHASIS)
        if response.lower() not in ('y', 'yes'):
            printmsg('Aborting installation', ERROR, EMPHASIS)
            sys.exit(1)
1233
1234

    printmsg('Deleting directory {}'.format(ctx.destdir), IMPORTANT)
1235
    Process.check_call('rm -r {}'.format(ctx.destdir), ctx.need_admin, ctx)
1236
1237


1238
1239
1240
1241
def parse_args(argv=None):
    """Parse command-line arguments, returns an argparse.Namespace object. """

    helps = {
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258

        'version'      : 'Print installer version number and exit',
        'listversions' : 'List available FSL versions and exit',
        'dest'         : 'Install FSL into this folder (default: '
                         '{})'.format(DEFAULT_INSTALLATION_DIRECTORY),
        'overwrite'    : 'Delete destination directory without '
                         'asking, if it already exists',
        'no_env'       : 'Do not modify your shell or MATLAB configuration '
                         'implies --no_shell and --no_matlab)',
        'no_shell'     : 'Do not modify your shell configuration',
        'no_matlab'    : 'Do not modify your MATLAB configuration',
        'fslversion'   : 'Install this specific version of FSL',
        'cuda'         : 'Install FSL for this CUDA version (default: '
                         'automatically detected)',

        # Do not automatically update the installer script,
        'no_self_update' : argparse.SUPPRESS,
Paul McCarthy's avatar
Paul McCarthy committed
1259
1260

        # Path to local installer manifest file
1261
        'manifest'       : argparse.SUPPRESS,
Paul McCarthy's avatar
Paul McCarthy committed
1262
1263

        # Print debugging messages
1264
        'debug'          : argparse.SUPPRESS,
1265
1266

        # Disable SHA256 checksum validation of downloaded files
1267
        'no_checksum'    : argparse.SUPPRESS,
1268

1269
1270
1271
1272
1273
1274
1275
1276
        # Store temp files in this directory
        # rather than in a temporary directory
        'workdir'        : argparse.SUPPRESS,

        # Treat this directory as user's home directory,
        # for the purposes of shell configuration. Must
        # already exist.
        'homedir'        : argparse.SUPPRESS,
1277
1278
1279
    }

    parser = argparse.ArgumentParser()
1280
1281

    # regular options
1282
1283
1284
1285
    parser.add_argument('-v', '--version', action='version',
                        version=__version__, help=helps['version'])
    parser.add_argument('-d', '--dest', metavar='DESTDIR',
                        help=helps['dest'])
1286
1287
    parser.add_argument('-o', '--overwrite', action='store_true',
                        help=helps['overwrite'])
1288
1289
    parser.add_argument('-l', '--listversions', action='store_true',
                        help=helps['listversions'])
1290
1291
1292
1293
1294
1295
    parser.add_argument('-e', '--no_env', action='store_true',
                        help=helps['no_env'])
    parser.add_argument('-s', '--no_shell', action='store_true',
                        help=helps['no_shell'])
    parser.add_argument('-m', '--no_matlab', action='store_true',
                        help=helps['no_matlab'])
1296
1297
    parser.add_argument('-V', '--fslversion', default='latest',
                        help=helps['version'])
1298
    parser.add_argument('-c', '--cuda', help=helps['cuda'])
1299

1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
    # hidden options
    parser.add_argument('-k', '--no_checksum', action='store_true',
                        help=helps['no_checksum'])
    parser.add_argument('-w', '--workdir', help=helps['workdir'])
    parser.add_argument('-i', '--homedir', help=helps['homedir'],
                        default=op.expanduser('~'))
    parser.add_argument('-a', '--manifest', default=FSL_INSTALLER_MANIFEST,
                        help=helps['manifest'])
    parser.add_argument('-u', '--no_self_update', action='store_true',
                        help=helps['no_self_update'])

1311
    args = parser.parse_args(argv)
1312

1313
1314
1315
1316
1317
1318
    args.homedir = op.abspath(args.homedir)
    if not op.isdir(args.homedir):
        printmsg('Home directory {} does not exist!'.format(args.homedir),
                 ERROR, EMPHASIS)
        sys.exit(1)

1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
    if os.getuid() == 0:
        printmsg('Running the installer script as root user - disabling '
                 'environment configuration', WARNING, EMPHASIS)
        args.no_env = True

    if args.no_env:
        args.no_shell  = True
        args.no_matlab = True

    if args.workdir is not None:
        args.workdir = op.abspath(args.workdir)
        if not op.exists(args.workdir):
            os.mkdir(args.workdir)

1333
    return args
1334
1335


1336
def config_logging(ctx):
1337
    """Configures logging. Log messages are directed to
1338
    $TMPDIR/fslinstaller.log, or workdir/fslinstaller.log
1339
    """
1340
1341
1342
1343
    if ctx.args.workdir is not None: logdir = ctx.args.workdir
    else:                            logdir = tempfile.gettempdir()

    logfile   = op.join(logdir, 'fslinstaller.log')
1344
1345
1346
1347
1348
1349
1350
1351
    handler   = logging.FileHandler(logfile)
    formatter = logging.Formatter(
        '%(asctime)s %(filename)s:%(lineno)4d: %(message)s', '%H:%M:%S')
    handler.setFormatter(formatter)
    log.addHandler(handler)
    log.setLevel(logging.DEBUG)


1352
def main(argv=None):
1353
1354
1355
    """Installer entry point. Downloads and installs miniconda and FSL, and
    configures the user's environment.
    """
1356
1357

    args = parse_args(argv)
Paul McCarthy's avatar
Paul McCarthy committed
1358
1359
    ctx  = Context(args)

1360
    config_logging(ctx)
1361
1362
1363

    log.debug(' '.join(sys.argv))

1364
    if not args.no_self_update:
Paul McCarthy's avatar
Paul McCarthy committed
1365
        self_update(ctx)
1366

1367
1368
    printmsg('FSL installer version:', EMPHASIS, UNDERLINE, end='')
    printmsg(' ' + __version__ + '\n')
1369
1370

    if args.listversions:
Paul McCarthy's avatar
Paul McCarthy committed
1371
        list_available_versions(ctx)
1372
1373
        sys.exit(0)

1374
1375
    ctx.finalise_settings()