fslinstaller.py 39.7 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
16
17
import                   os
import                   sys
import                   argparse
import                   contextlib
import                   getpass
Paul McCarthy's avatar
Paul McCarthy committed
18
import                   hashlib
19
20
21
22
23
24
import                   json
import                   logging
import                   platform
import                   shlex
import                   shutil
import                   tempfile
25
26
import                   threading
import                   time
27

28
29
30
31
32
# TODO check py2/3
import                   urllib
import urllib.parse   as urlparse
import urllib.request as urlrequest

33
34
35
36
37
38
try:                import queue
except ImportError: import Queue as queue


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

39
40
41
42

log = logging.getLogger(__name__)


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


class InvalidPassword(Exception):
    """Exception raised by Context.get_admin_password if the user gives an
    incorrect password.
    """


69
70
71
72
73
74
75
76
77
78
79
80
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.
    """


81
82
83
84
85
86
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
87
88
89
class Context(object):
    """Bag of information and settings created in main, and passed around
    this script.
90
91
92

    Several settings are lazily evaluated on first access, but once evaluated,
    their values are immutable.
Paul McCarthy's avatar
Paul McCarthy committed
93
94
95
    """

    def __init__(self, args):
96
97
98
        """Create the context with the argparse.Namespace object containing
        parsed command-line arguments.
        """
99

100
101
        self.args  = args
        self.shell = op.basename(os.environ['SHELL'])
Paul McCarthy's avatar
Paul McCarthy committed
102
103

        # These attributes are updated on-demand via
104
105
106
107
108
109
110
        # 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
111
112
        self.__need_admin     = None
        self.__admin_password = None
113
114
115


    def finalise_settings(self):
116
117
        """Finalise values for all information and settings in the Context.
        """
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
        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
151
152
        installer manifest) for the target platform and requested FSL/CUDA
        versions.
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
        """

        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
177
178
179
180


    @property
    def destdir(self):
181
182
183
184
185
        """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
186
        if self.__destdir is None:
187
188
189
190
191
192
193
194
195
196
            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
197
                response  = op.abspath(response)
198
                parentdir = op.dirname(response)
Paul McCarthy's avatar
Paul McCarthy committed
199
200
201
                if op.exists(parentdir):
                    break
                else:
202
203
                    printmsg('Destination directory {} does not '
                             'exist!'.format(parentdir), ERROR)
Paul McCarthy's avatar
Paul McCarthy committed
204

205
            self.__destdir = response
Paul McCarthy's avatar
Paul McCarthy committed
206
207
208
209
210
        return self.__destdir


    @property
    def need_admin(self):
211
212
213
        """Returns True if administrator privileges will be needed to install
        FSL.
        """
Paul McCarthy's avatar
Paul McCarthy committed
214
215
        if self.__need_admin is not None:
            return self.__need_admin
216
217
218
        parentdir = op.dirname(self.destdir)
        self.__need_admin = Context.check_need_admin(parentdir)
        return self.__need_admin
Paul McCarthy's avatar
Paul McCarthy committed
219
220
221
222


    @property
    def admin_password(self):
223
224
        """Returns the user's administrator password, prompting them if needed.
        """
Paul McCarthy's avatar
Paul McCarthy committed
225
226
227
228
229
230
231
232
233
234
235
        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):
236
        """Returns the FSL installer manifest as a dictionary. """
Paul McCarthy's avatar
Paul McCarthy committed
237
        if self.__manifest is None:
238
239
            self.__manifest = Context.download_manifest(self.args.manifest,
                                                        self.args.workdir)
Paul McCarthy's avatar
Paul McCarthy committed
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
        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',
255
256
257

            # M1 builds (and possbily ARM for Linux)
            # will be added in the future
Paul McCarthy's avatar
Paul McCarthy committed
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
            ('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
274
275
        string containing the 'X.Y' CUDA version, or None if CUDA is not
        supported.
Paul McCarthy's avatar
Paul McCarthy committed
276
277
278
279
280
281
282
        """

        try:
            output = sp.check_output('nvidia-smi')
        except (sp.CalledProcessError, FileNotFoundError):
            return None

283
        cudaver = '9.2'  # TODO
Paul McCarthy's avatar
Paul McCarthy committed
284
285
286
287
        match   = None

        # Return the most suitable CUDA
        # version that we have a build for
288
289
290
291
        available_cudas = ['9.2', '10.2', '11.1']
        for available in reversed(supported_cudas):
            if float(cudaver) <= float(available):
                match = available
Paul McCarthy's avatar
Paul McCarthy committed
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
                break

        return match


    @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):
311
312
313
            proc = sudo_popen(['true'], password)
            proc.communicate()
            return proc.returncode == 0
Paul McCarthy's avatar
Paul McCarthy committed
314

Paul McCarthy's avatar
Paul McCarthy committed
315
316
317
318
319
320
321
322
        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
323
324
325
            password = getpass.getpass('')
            valid    = validate_admin_password(password)

Paul McCarthy's avatar
Paul McCarthy committed
326
            if valid:
327
                printmsg('Password accepted', INFO)
Paul McCarthy's avatar
Paul McCarthy committed
328
329
330
                break
            else:
                printmsg('Incorrect password', WARNING)
Paul McCarthy's avatar
Paul McCarthy committed
331
332
333
334
335
336
337
338

        if not valid:
            raise InvalidPassword()

        return password


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

344
345
        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
346

347
          {
Paul McCarthy's avatar
Paul McCarthy committed
348
              "installer" : {
349
350
351
352
353
354
355
356
357
358

                  // 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
359
360
              "versions" : {

361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
                  // 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
386
              }
387
          }
Paul McCarthy's avatar
Paul McCarthy committed
388
389
390
391
        """

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

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

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

400
        return json.loads('\n'.join(lines))
Paul McCarthy's avatar
Paul McCarthy committed
401
402


403
404
405
406
407
408
409
410
411
412
413
414
# 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 = {
415
416
417
418
419
420
421
422
423
    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
424
425
426
}


427
def printmsg(msg='', *msgtypes, **kwargs):
428
429
430
431
432
433
    """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)
434
    sys.stdout.flush()
435
436
437
438
439
440


def prompt(prompt, *msgtypes, **kwargs):
    """Prompts the user for some input. msgtypes and kwargs are passed
    through to the printmsg function.
    """
441
442
    printmsg(prompt, *msgtypes, end='', **kwargs)
    return input(' ').strip()
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
551
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):

552
553
        overflow = value > total
        value    = min(value, total)
554
555
556
557
558
559

        # 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

560
561
562
563
564
565
566
567
        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)
568
569
        completed = int(round(width * (value  / total)))
        remaining = width - completed
570
571
572
        progress  = '[{}{}] {}'.format('#' * completed,
                                       ' ' * remaining,
                                       suffix)
573

574
575
576
577
578
        printmsg(progress, end='')
        if overflow:
            printmsg(' ', end='')
            self.spin()
        printmsg(end='\r')
579
580
581
582
583
584
585
586
587
588
589
590
591
592


    @staticmethod
    def get_terminal_width(fallback=None):
        """Return the number of columns in the current terminal, or fallback
        if it cannot be determined.
        """
        # os.get_terminal_size added in python 3.3
        try:
            return int(sp.check_output('tput cols'.split()).strip())
        except (OSError, FileNotFoundError):
            return fallback


593
@contextlib.contextmanager
594
595
596
597
598
599
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.
600
601
    """

602
603
604
    if override_dir is None: tmpdir = tempfile.mkdtemp()
    else:                    tmpdir = override_dir

605
606
607
    prevdir = os.getcwd()

    try:
608
609
        os.chdir(tmpdir)
        yield tmpdir
610
611
612

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


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
629
630
631
632
class ChecksumError(Exception):
    """Exception raised by the sha256 function if a file checksume does
    not match the expected checksum.
    """
633
634


635
def sha256(filename, check_against=None, blocksize=1048576):
Paul McCarthy's avatar
Paul McCarthy committed
636
637
638
    """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.
639
640
    """

Paul McCarthy's avatar
Paul McCarthy committed
641
    hashobj = hashlib.sha256()
642

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

Paul McCarthy's avatar
Paul McCarthy committed
650
651
    checksum = hashobj.hexdigest()

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

    return checksum
658
659


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


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

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

672
673
674
675
    if progress is None:
        progress = default_progress

    log.debug('Downloading %s ...', url)
Paul McCarthy's avatar
Paul McCarthy committed
676
677
678
679
680
681
682
683
684
685

    try:
        with urlrequest.urlopen(url) as req, \
             open(destination, 'wb') as outf:

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

            downloaded = 0

Paul McCarthy's avatar
Paul McCarthy committed
686
            progress(downloaded, total)
Paul McCarthy's avatar
Paul McCarthy committed
687
688
689
690
691
692
            while True:
                block = req.read(blocksize)
                if len(block) == 0:
                    break
                downloaded += len(block)
                outf.write(block)
693
                progress(downloaded, total)
Paul McCarthy's avatar
Paul McCarthy committed
694
695

    except urllib.error.HTTPError as e:
696
697
        raise DownloadFailed('A network error has occurred while trying '
                             'to download {}'.format(destname))
Paul McCarthy's avatar
Paul McCarthy committed
698
699


700
class Process(object):
701
702
    """Container for a subprocess.Popen object, allowing non-blocking
    access to its standard output and error streams via separate queues.
703
704
705
    """

    def __init__(self, ctx, cmd, admin, **kwargs):
706
707
708
709
710
711
712
        """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
        """
713

714
715
716
717
718
719
        self.ctx     = ctx
        self.cmd     = cmd
        self.admin   = admin
        self.stdoutq = queue.Queue()
        self.stderrq = queue.Queue()
        self.popen   = Process.run(self.ctx, self.cmd, self.admin)
720

721
722
723
724
725
726
727
        # 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))
728

729
730
731
732
        self.stdout_thread.daemon = True
        self.stderr_thread.daemon = True
        self.stdout_thread.start()
        self.stderr_thread.start()
733
734


735
736
737
    @staticmethod
    def forward_stream(popen, stream, queue):
        """Runs cmd, and pushes lines from its stdout to the queue. """
738

739
740
741
742
743
744
745
        while popen.returncode is None:
            line = stream.readline()
            popen.poll()
            if line == '':
                break
            else:
                queue.put(line)
746

747
748
749
750
751
        # process finished, flush the stream
        line = stream.readline()
        while line != '':
            queue.put(line)
            line = stream.readline()
752

753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808

    @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
    def run(ctx, cmd, admin=False):
        """Starts the given command, as administrator if requested. Returns
        the subprocess.Popen object.
        """

        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)

        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
809
810
811

            prog.update(nlines, total)

812
813
814
815
816
817
818
819
820
            while proc.popen.returncode is None:

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

                nlines += 1
                prog.update(nlines, total)
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841


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.
842
843

    This function assumes that it is run within a temporary/scratch directory.
844
845
    """

846
847
848
849
    metadata = ctx.manifest['installer']['miniconda'][ctx.platform]
    url      = metadata['url']
    checksum = metadata['sha256']
    output   = metadata.get('output', '').strip()
850

851
852
    if output == '': output = None
    else:            output = int(output)
Paul McCarthy's avatar
Paul McCarthy committed
853

854
855
    # Download
    printmsg('Downloading miniconda from {}...'.format(url))
856
857
858
859
    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)
860
861

    # Install
862
    printmsg('Installing miniconda at {}...'.format(ctx.destdir))
863
    cmd = 'sh miniforge.sh -b -p {}'.format(ctx.destdir)
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
    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)

900
901
    Process.run(
        ctx, 'cp .condarc {}'.format(ctx.destdir, admin=ctx.need_admin))
902
903
904


def install_fsl(ctx):
905
    """Install FSL into ctx.destdir (which is assumed to be a miniconda
906
    installation.
907
908

    This function assumes that it is run within a temporary/scratch directory.
909
910
    """

911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
    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)

933

934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
def post_install_cleanup(ctx):
    """Cleans up the FSL directory after installation. """

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

    Process.run(ctx, cmd, output, admin=ctx.need_admin)


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()]
958
    else:
959
        lines = []
960

961
962
963
964
    # replace block
    try:
        idx   = lines.index(searchline)
        lines = lines[:idx] + content + lines[idx + numlines:]
965

966
967
968
    # append to end
    except ValueError:
        lines = lines + [''] + content
969

970
971
    with open(filename, 'wt') as f:
        f.write('\n'.join(lines))
972
973


974
def configure_shell(ctx):
975
    """Configures the user's shell environment (e.g. ~/.bash_profile). """
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
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

    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)
1061
1062


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

    @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
1097
    latestver = Version(ctx.manifest['installer']['version'])
1098
1099
1100
1101
1102
1103

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

Paul McCarthy's avatar
Paul McCarthy committed
1107
1108
1109
    tmpf = tempfile.NamedTemporaryFile(delete=False)
    tmpf.close()
    tmpf = tmpf.name
1110

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

1113
    if not ctx.args.no_checksum:
1114
        sha256(tmpf, ctx.manifest['installer']['sha256'])
1115

Paul McCarthy's avatar
Paul McCarthy committed
1116
1117
1118
    cmd = [sys.executable, tmpf] + sys.argv[1:]
    log.debug('Running new installer: %s', cmd)
    os.execv(sys.executable, cmd)
1119
1120


1121
def overwrite_destdir(ctx):
1122
1123
1124
    """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.
1125
    """
1126
1127
1128
1129
1130
1131
1132
1133
1134

    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)
1135
1136
1137
1138
1139

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


1140
1141
1142
1143
def parse_args(argv=None):
    """Parse command-line arguments, returns an argparse.Namespace object. """

    helps = {
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160

        '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
1161
1162

        # Path to local installer manifest file
1163
        'manifest'       : argparse.SUPPRESS,
Paul McCarthy's avatar
Paul McCarthy committed
1164
1165

        # Print debugging messages
1166
        'debug'          : argparse.SUPPRESS,
1167
1168

        # Disable SHA256 checksum validation of downloaded files
1169
        'no_checksum'    : argparse.SUPPRESS,
1170

1171
1172
1173
1174
1175
1176
1177
1178
        # 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,
1179
1180
1181
    }

    parser = argparse.ArgumentParser()
1182
1183

    # regular options
1184
1185
1186
1187
    parser.add_argument('-v', '--version', action='version',
                        version=__version__, help=helps['version'])
    parser.add_argument('-d', '--dest', metavar='DESTDIR',
                        help=helps['dest'])
1188
1189
    parser.add_argument('-o', '--overwrite', action='store_true',
                        help=helps['overwrite'])
1190
1191
    parser.add_argument('-l', '--listversions', action='store_true',
                        help=helps['listversions'])
1192
1193
1194
1195
1196
1197
    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'])
1198
1199
    parser.add_argument('-V', '--fslversion', default='latest',
                        help=helps['version'])
1200
    parser.add_argument('-c', '--cuda', help=helps['cuda'])
1201

1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
    # 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'])

1215
    args = parser.parse_args(argv)
1216

1217
    logging.basicConfig()
1218
1219
    if args.debug: logging.getLogger().setLevel(logging.DEBUG)
    else:          logging.getLogger().setLevel(logging.WARNING)
1220

1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
    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)

1235
    return args
1236
1237
1238


def main(argv=None):
1239
1240
1241
    """Installer entry point. Downloads and installs miniconda and FSL, and
    configures the user's environment.
    """
1242
1243

    args = parse_args(argv)
Paul McCarthy's avatar
Paul McCarthy committed
1244
1245
    ctx  = Context(args)

1246
    if not args.no_self_update:
Paul McCarthy's avatar
Paul McCarthy committed
1247
        self_update(ctx)
1248

1249
1250
    printmsg('FSL installer version:', EMPHASIS, UNDERLINE, end='')
    printmsg(' ' + __version__ + '\n')
1251
1252

    if args.listversions:
Paul McCarthy's avatar
Paul McCarthy committed
1253
        list_available_versions(ctx)
1254
1255
        sys.exit(0)

1256
1257
    ctx.finalise_settings()

1258
    with tempdir(args.workdir):
1259

1260
1261
1262
1263
        if op.exists(ctx.destdir):
           overwrite_destdir(ctx)

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

1265
        install_miniconda(ctx)
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
        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)
1276
1277
1278
1279


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