fslinstaller.py 41.2 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
log = logging.getLogger(__name__)


Paul McCarthy's avatar
Paul McCarthy committed
48
49
50
51
52
53
54
55
56
57
58
59
__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
60
61
62
63
64
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
65
66
67
"""


68
69
70
71
72
73
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
74
75
76
77
78
79
class InvalidPassword(Exception):
    """Exception raised by Context.get_admin_password if the user gives an
    incorrect password.
    """


80
81
82
83
84
85
86
87
88
89
90
91
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.
    """


92
93
94
95
96
97
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
98
99
100
class Context(object):
    """Bag of information and settings created in main, and passed around
    this script.
101
102
103

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

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

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

        # These attributes are updated on-demand via
115
116
117
118
119
120
121
        # 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
122
123
        self.__need_admin     = None
        self.__admin_password = None
124
125
126


    def finalise_settings(self):
127
128
        """Finalise values for all information and settings in the Context.
        """
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
        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
162
163
        installer manifest) for the target platform and requested FSL/CUDA
        versions.
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
        """

        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
188
189
190
191


    @property
    def destdir(self):
192
193
194
195
196
        """Installation directory. If not specified at the command line, the
        user is prompted to enter a directory.
        """
        if self.args.dest is not None:
            self.__destdir = op.abspath(self.args.dest)
Paul McCarthy's avatar
Paul McCarthy committed
197
        if self.__destdir is None:
198
199
200
201
202
203
204
205
206
207
            while True:
                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)
                if response == '':
                    response = DEFAULT_INSTALLATION_DIRECTORY
                    break
Paul McCarthy's avatar
Paul McCarthy committed
208
                response  = op.abspath(response)
209
                parentdir = op.dirname(response)
Paul McCarthy's avatar
Paul McCarthy committed
210
211
212
                if op.exists(parentdir):
                    break
                else:
213
214
                    printmsg('Destination directory {} does not '
                             'exist!'.format(parentdir), ERROR)
Paul McCarthy's avatar
Paul McCarthy committed
215

216
            self.__destdir = response
Paul McCarthy's avatar
Paul McCarthy committed
217
218
219
220
221
        return self.__destdir


    @property
    def need_admin(self):
222
223
224
        """Returns True if administrator privileges will be needed to install
        FSL.
        """
Paul McCarthy's avatar
Paul McCarthy committed
225
226
        if self.__need_admin is not None:
            return self.__need_admin
227
228
229
        parentdir = op.dirname(self.destdir)
        self.__need_admin = Context.check_need_admin(parentdir)
        return self.__need_admin
Paul McCarthy's avatar
Paul McCarthy committed
230
231
232
233


    @property
    def admin_password(self):
234
235
        """Returns the user's administrator password, prompting them if needed.
        """
Paul McCarthy's avatar
Paul McCarthy committed
236
237
238
239
240
241
242
243
244
245
246
        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):
247
        """Returns the FSL installer manifest as a dictionary. """
Paul McCarthy's avatar
Paul McCarthy committed
248
        if self.__manifest is None:
249
250
            self.__manifest = Context.download_manifest(self.args.manifest,
                                                        self.args.workdir)
Paul McCarthy's avatar
Paul McCarthy committed
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
        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',
266
267
268

            # M1 builds (and possbily ARM for Linux)
            # will be added in the future
Paul McCarthy's avatar
Paul McCarthy committed
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
            ('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
285
286
        string containing the 'X.Y' CUDA version, or None if CUDA is not
        supported.
Paul McCarthy's avatar
Paul McCarthy committed
287
288
289
        """

        try:
290
            output = Process.run('nvidia-smi', check_output=True)
291
        except Exception:
Paul McCarthy's avatar
Paul McCarthy committed
292
293
            return None

294
295
296
297
298
299
300
301
302
        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:
            return None
Paul McCarthy's avatar
Paul McCarthy committed
303
304
305

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

310
        return None
Paul McCarthy's avatar
Paul McCarthy committed
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326


    @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):
327
328
329
            proc = sudo_popen(['true'], password)
            proc.communicate()
            return proc.returncode == 0
Paul McCarthy's avatar
Paul McCarthy committed
330

Paul McCarthy's avatar
Paul McCarthy committed
331
332
333
334
335
336
337
338
        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)
            printmsg(msg, IMPORTANT, end='', flush=True)
Paul McCarthy's avatar
Paul McCarthy committed
339
340
341
            password = getpass.getpass('')
            valid    = validate_admin_password(password)

Paul McCarthy's avatar
Paul McCarthy committed
342
            if valid:
343
                printmsg('Password accepted', INFO)
Paul McCarthy's avatar
Paul McCarthy committed
344
345
346
                break
            else:
                printmsg('Incorrect password', WARNING)
Paul McCarthy's avatar
Paul McCarthy committed
347
348
349
350
351
352
353
354

        if not valid:
            raise InvalidPassword()

        return password


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

360
361
        The manifest file is a JSON file with the following structure (lines
        beginning with two forward-slashes are ignored):
Paul McCarthy's avatar
Paul McCarthy committed
362

363
          {
Paul McCarthy's avatar
Paul McCarthy committed
364
              "installer" : {
365
366
367
368
369
370
371
372
373
374

                  // Latest version of installer script
                  "version" : "1.2.3",

                  // URL to download installer script
                  "url"     : "http://abc.com/fslinstaller.py"

                  // SHA256 checksum of installer script
                  "sha256"  : "ab238........."
              },
Paul McCarthy's avatar
Paul McCarthy committed
375
376
              "versions" : {

377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
                  // Latest must be present, and must
                  // contain the version number of the
                  // latest release
                  "latest" : "6.1.0",
                  "6.1.0"  : {
                      'linux-64' : {
                          "environment" : "http;//abc.com/fsl-6.1.0-linux-64.yml",
                          "sha256"      : "ab23456...",
                      }
                      'macos-64' : {
                          "environment" : "http;//abc.com/fsl-6.1.0-macos-64.yml",
                          "sha256"      : "ab23456...",
                      }
                      'linux-64-cuda9.2' : {
                          "environment" : "http;//abc.com/fsl-6.1.0-linux-64-cuda9.2.yml",
                          "sha256"      : "ab23456...",
                      }
                      'linux-64-cuda10.2' : {
                          "environment" : "http;//abc.com/fsl-6.1.0-linux-64-cuda10.2.yml",
                          "sha256"      : "ab23456...",
                      }
                  }
                  "6.1.1" : {
                      ...
                  }
Paul McCarthy's avatar
Paul McCarthy committed
402
              }
403
          }
Paul McCarthy's avatar
Paul McCarthy committed
404
405
406
407
        """

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

408
        with tempdir(workdir):
Paul McCarthy's avatar
Paul McCarthy committed
409
410
            download_file(url, 'manifest.json')
            with open('manifest.json') as f:
411
412
413
414
                lines = f.readlines()

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

416
        return json.loads('\n'.join(lines))
Paul McCarthy's avatar
Paul McCarthy committed
417
418


419
420
421
422
423
424
425
426
427
428
429
430
# 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 = {
431
432
433
434
435
436
437
438
439
    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
440
441
442
}


443
def printmsg(msg='', *msgtypes, **kwargs):
444
445
446
447
448
449
    """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)
450
    sys.stdout.flush()
451
452
453
454
455
456


def prompt(prompt, *msgtypes, **kwargs):
    """Prompts the user for some input. msgtypes and kwargs are passed
    through to the printmsg function.
    """
457
    printmsg(prompt, *msgtypes, end='', **kwargs)
458
459
460

    if PY2: return raw_input(' ').strip()
    else:   return input(    ' ').strip()
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
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
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):

570
571
        overflow = value > total
        value    = min(value, total)
572
573
574
575
576
577

        # 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

578
579
580
581
582
583
584
585
        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
        #     - space+spin in case of overflow
        width     = width - (len(suffix) + 5)
586
587
        completed = int(round(width * (value  / total)))
        remaining = width - completed
588
589
590
        progress  = '[{}{}] {}'.format('#' * completed,
                                       ' ' * remaining,
                                       suffix)
591

592
593
594
595
596
        printmsg(progress, end='')
        if overflow:
            printmsg(' ', end='')
            self.spin()
        printmsg(end='\r')
597
598
599
600
601
602
603


    @staticmethod
    def get_terminal_width(fallback=None):
        """Return the number of columns in the current terminal, or fallback
        if it cannot be determined.
        """
604
605
        # os.get_terminal_size added in python
        # 3.3, so we try and call tput instead
606
        try:
607
            result = Process.run('tput cols', check_output=True)
608
            return int(result.strip())
609
        except Exception:
610
611
612
            return fallback


613
@contextlib.contextmanager
614
615
616
617
618
619
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.
620
621
    """

622
623
624
    if override_dir is None: tmpdir = tempfile.mkdtemp()
    else:                    tmpdir = override_dir

625
626
627
    prevdir = os.getcwd()

    try:
628
629
        os.chdir(tmpdir)
        yield tmpdir
630
631
632

    finally:
        os.chdir(prevdir)
633
634
        if override_dir is None:
            shutil.rmtree(tmpdir)
635
636
637
638
639
640
641
642
643
644
645
646
647
648


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
649
650
651
652
class ChecksumError(Exception):
    """Exception raised by the sha256 function if a file checksume does
    not match the expected checksum.
    """
653
654


655
def sha256(filename, check_against=None, blocksize=1048576):
Paul McCarthy's avatar
Paul McCarthy committed
656
657
658
    """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.
659
660
    """

Paul McCarthy's avatar
Paul McCarthy committed
661
    hashobj = hashlib.sha256()
662

Paul McCarthy's avatar
Paul McCarthy committed
663
664
665
666
667
668
    with open(filename, 'rb') as f:
        while True:
            block = f.read(blocksize)
            if len(block) == 0:
                break
            hashobj.update(block)
669

Paul McCarthy's avatar
Paul McCarthy committed
670
671
    checksum = hashobj.hexdigest()

672
    if check_against is not None:
Paul McCarthy's avatar
Paul McCarthy committed
673
        if checksum != check_against:
674
675
676
677
            raise ChecksumError('File {} does not match expected checksum '
                                '({})'.format(filename, check_against))

    return checksum
678
679


Paul McCarthy's avatar
Paul McCarthy committed
680
681
682
683
class DownloadFailed(Exception):
    """Exception type raised by the download_file function if a
    download fails for some reason.
    """
684
685


Paul McCarthy's avatar
Paul McCarthy committed
686
def download_file(url, destination, progress=None, blocksize=1048576):
Paul McCarthy's avatar
Paul McCarthy committed
687
688
    """Download a file from url, saving it to destination. """

689
690
    def default_progress(downloaded, total):
        pass
Paul McCarthy's avatar
Paul McCarthy committed
691

692
693
694
695
    if progress is None:
        progress = default_progress

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

    try:
698
699
700
701
        # 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
702
703
704
705
706
707

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

            downloaded = 0

Paul McCarthy's avatar
Paul McCarthy committed
708
            progress(downloaded, total)
Paul McCarthy's avatar
Paul McCarthy committed
709
710
711
712
713
714
            while True:
                block = req.read(blocksize)
                if len(block) == 0:
                    break
                downloaded += len(block)
                outf.write(block)
715
                progress(downloaded, total)
Paul McCarthy's avatar
Paul McCarthy committed
716

717
718
719
720
721
722
    except Exception:
        raise
        raise DownloadFailed('A network error has occurred while '
                             'trying to download {}'.format(url))
    finally:
        req.close()
Paul McCarthy's avatar
Paul McCarthy committed
723
724


725
class Process(object):
726
727
    """Container for a subprocess.Popen object, allowing non-blocking
    access to its standard output and error streams via separate queues.
728
729
730
    """

    def __init__(self, ctx, cmd, admin, **kwargs):
731
732
733
734
735
736
737
        """Run the specified command.

        :arg ctx:    The installer Context
        :arg cmd:    Command to run - passed directly to subprocess.Popen
        :arg admin:  Run the command with administrative privileges
        :arg kwargs: Passed to subprocess.Popen
        """
738

739
740
741
742
743
        self.ctx     = ctx
        self.cmd     = cmd
        self.admin   = admin
        self.stdoutq = queue.Queue()
        self.stderrq = queue.Queue()
744
        self.popen   = Process.run(self.cmd, self.admin, self.ctx)
745

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

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


760
761
    @staticmethod
    def forward_stream(popen, stream, queue):
762
763
764
        """Reads lines from stream and pushes them onto queue until popen
        is finished.
        """
765

766
767
768
769
770
771
772
        while popen.returncode is None:
            line = stream.readline()
            popen.poll()
            if line == '':
                break
            else:
                queue.put(line)
773

774
775
776
777
778
        # process finished, flush the stream
        line = stream.readline()
        while line != '':
            queue.put(line)
            line = stream.readline()
779

780
781
782
783
784
785
786
787
788
789
790
791
792
793

    @staticmethod
    def sudo_popen(cmd, password, **kwargs):
        """Runs "sudo cmd" using subprocess.Popen.
        Assumes that kwargs contains stdin=sp.PIPE
        """

        cmd  = ['sudo', '-S', '-k'] + cmd
        proc = sp.Popen(cmd, **kwargs)
        proc.stdin.write('{}\n'.format(password))
        return proc


    @staticmethod
794
    def run(cmd, admin=False, ctx=None, check_output=False):
795
        """Starts the given command, as administrator if requested. Returns
796
797
798
799
800
801
802
803
804
805
806
807
808
        the subprocess.Popen object (unless check_output is True).

        :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.

        :arg check_output: Behave like subprocess.check_output - wait until
                           command has finished, and return its standard
                           output. An error is raised if the process returns
                           a non-zero exit code.
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
        """

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

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

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

        cmd = shlex.split(cmd)

        # set universal_newlines to force text
        # based stdin/out on both py2 and py3
        kwargs = dict(stdin=sp.PIPE,
                      stdout=sp.PIPE,
                      stderr=sp.PIPE,
                      universal_newlines=True)

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

830
831
832
833
834
835
        if check_output:
            proc.wait()
            if proc.returncode != 0:
                raise RuntimeError(cmd)
            return proc.stdout.read()

836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
        return proc


    @staticmethod
    def monitor_progress(ctx, cmd, total=None, **kwargs):
        """Creates a Process object to run cmd, 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:

            proc   = Process(ctx, cmd, **kwargs)
            nlines = 0
854
855
856

            prog.update(nlines, total)

857
858
859
860
861
862
863
864
865
            while proc.popen.returncode is None:

                try:
                    line = proc.stdoutq.get(timeout=1)
                except queue.Empty:
                    continue

                nlines += 1
                prog.update(nlines, total)
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886


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.
887
888

    This function assumes that it is run within a temporary/scratch directory.
889
890
    """

891
    metadata = ctx.manifest['miniconda'][ctx.platform]
892
893
894
    url      = metadata['url']
    checksum = metadata['sha256']
    output   = metadata.get('output', '').strip()
895

896
897
    if output == '': output = None
    else:            output = int(output)
Paul McCarthy's avatar
Paul McCarthy committed
898

899
900
    # Download
    printmsg('Downloading miniconda from {}...'.format(url))
901
902
903
904
    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)
905
906

    # Install
907
    printmsg('Installing miniconda at {}...'.format(ctx.destdir))
908
    cmd = 'sh miniforge.sh -b -p {}'.format(ctx.destdir)
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
    Process.monitor_progress(ctx, cmd, output, admin=ctx.need_admin)

    # 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)

945
    Process.run('cp .condarc {}'.format(ctx.destdir), ctx.need_admin, ctx)
946
947
948


def install_fsl(ctx):
949
    """Install FSL into ctx.destdir (which is assumed to be a miniconda
950
    installation.
951
952

    This function assumes that it is run within a temporary/scratch directory.
953
954
    """

955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
    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'

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

977

978
979
980
981
982
983
def post_install_cleanup(ctx):
    """Cleans up the FSL directory after installation. """

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

984
    Process.run(cmd, ctx.need_admin, ctx)
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001


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()]
1002
    else:
1003
        lines = []
1004

1005
1006
1007
1008
    # replace block
    try:
        idx   = lines.index(searchline)
        lines = lines[:idx] + content + lines[idx + numlines:]
1009

1010
1011
1012
    # append to end
    except ValueError:
        lines = lines + [''] + content
1013

1014
1015
    with open(filename, 'wt') as f:
        f.write('\n'.join(lines))
1016
1017


1018
def configure_shell(ctx):
1019
    """Configures the user's shell environment (e.g. ~/.bash_profile). """
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
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

    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)
1105
1106


Paul McCarthy's avatar
Paul McCarthy committed
1107
def self_update(ctx):
1108
    """Checks to see if a newer version of the installer (this script) is
1109
    available and if so, downloads it to a temporary file, and runs it in
Paul McCarthy's avatar
Paul McCarthy committed
1110
    place of this script.
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
    """

    @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
1141
    latestver = Version(ctx.manifest['installer']['version'])
1142
1143
1144
1145
1146
1147

    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
1148
1149
    log.debug('New version of installer is available '
              '(%s) - self-updating', latestver)
1150

Paul McCarthy's avatar
Paul McCarthy committed
1151
1152
1153
    tmpf = tempfile.NamedTemporaryFile(delete=False)
    tmpf.close()
    tmpf = tmpf.name
1154

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

1157
    if not ctx.args.no_checksum:
1158
        sha256(tmpf, ctx.manifest['installer']['sha256'])
1159

Paul McCarthy's avatar
Paul McCarthy committed
1160
1161
1162
    cmd = [sys.executable, tmpf] + sys.argv[1:]
    log.debug('Running new installer: %s', cmd)
    os.execv(sys.executable, cmd)
1163
1164


1165
def overwrite_destdir(ctx):
1166
1167
1168
    """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.
1169
    """
1170
1171
1172
1173
1174
1175
1176
1177
1178

    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)
1179
1180

    printmsg('Deleting directory {}'.format(ctx.destdir), IMPORTANT)
1181
    Process.run('rm -r {}'.format(ctx.destdir), ctx.need_admin, ctx)
1182
1183


1184
1185
1186
1187
def parse_args(argv=None):
    """Parse command-line arguments, returns an argparse.Namespace object. """

    helps = {
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204

        '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
1205
1206

        # Path to local installer manifest file
1207
        'manifest'       : argparse.SUPPRESS,
Paul McCarthy's avatar
Paul McCarthy committed
1208
1209

        # Print debugging messages
1210
        'debug'          : argparse.SUPPRESS,
1211
1212

        # Disable SHA256 checksum validation of downloaded files
1213
        'no_checksum'    : argparse.SUPPRESS,
1214

1215
1216
1217
1218
1219
1220
1221
1222
        # 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,
1223
1224
1225
    }

    parser = argparse.ArgumentParser()
1226
1227

    # regular options
1228
1229
1230
1231
    parser.add_argument('-v', '--version', action='version',
                        version=__version__, help=helps['version'])
    parser.add_argument('-d', '--dest', metavar='DESTDIR',
                        help=helps['dest'])
1232
1233
    parser.add_argument('-o', '--overwrite', action='store_true',
                        help=helps['overwrite'])
1234
1235
    parser.add_argument('-l', '--listversions', action='store_true',
                        help=helps['listversions'])
1236
1237
1238
1239
1240
1241
    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'])
1242
1243
    parser.add_argument('-V', '--fslversion', default='latest',
                        help=helps['version'])
1244
    parser.add_argument('-c', '--cuda', help=helps['cuda'])
1245

1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
    # 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('-D', '--debug', action='store_true',
                        help=helps['debug'])
    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'])

1259
    args = parser.parse_args(argv)
1260

1261
    logging.basicConfig()
1262
1263
    if args.debug: logging.getLogger().setLevel(logging.DEBUG)
    else:          logging.getLogger().setLevel(logging.WARNING)
1264

1265
1266
1267
1268
1269
1270
1271
    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)

1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
    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)

1286
    return args
1287
1288
1289


def main(argv=None):
1290
1291
1292
    """Installer entry point. Downloads and installs miniconda and FSL, and
    configures the user's environment.
    """
1293
1294

    args = parse_args(argv)
Paul McCarthy's avatar
Paul McCarthy committed
1295
1296
    ctx  = Context(args)

1297
    if not args.no_self_update:
Paul McCarthy's avatar
Paul McCarthy committed
1298
        self_update(ctx)
1299

1300
1301
    printmsg('FSL installer version:', EMPHASIS, UNDERLINE, end='')
    printmsg(' ' + __version__ + '\n')
1302
1303

    if args.listversions:
Paul McCarthy's avatar
Paul McCarthy committed
1304
        list_available_versions(ctx)
1305
1306
        sys.exit(0)

1307
1308
    ctx.finalise_settings()

1309
    with tempdir(args.workdir):
1310

1311
1312
1313
1314
        if op.exists(ctx.destdir):
           overwrite_destdir(ctx)

        printmsg('\nInstalling FSL into {}\n'.format(ctx.destdir), EMPHASIS)
1315

1316
        install_miniconda(ctx)
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
        install_fsl(ctx)
        post_install_cleanup(ctx)

    if not args.no_shell:  configure_shell( ctx)
    if not args.no_matlab: configure_matlab(ctx)

    printmsg('\nFSL successfully installed\n', IMPORTANT)
    if not args.no_env:
        printmsg('Open a new terminal, or log out and log back in, '
                 'for the environment changes to take effect.', INFO)
1327
1328
1329
1330


if __name__ == '__main__':
    sys.exit(main())