databases.py 26.1 KB
Newer Older
André Anjos's avatar
André Anjos committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :

###############################################################################
#                                                                             #
# Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/           #
# Contact: beat.support@idiap.ch                                              #
#                                                                             #
# This file is part of the beat.cmdline module of the BEAT platform.          #
#                                                                             #
# Commercial License Usage                                                    #
# Licensees holding valid commercial BEAT licenses may use this file in       #
# accordance with the terms contained in a written agreement between you      #
# and Idiap. For further information contact tto@idiap.ch                     #
#                                                                             #
# Alternatively, this file may be used under the terms of the GNU Affero      #
# Public License version 3 as published by the Free Software and appearing    #
# in the file LICENSE.AGPL included in the packaging of this file.            #
# The BEAT platform is distributed in the hope that it will be useful, but    #
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
# or FITNESS FOR A PARTICULAR PURPOSE.                                        #
#                                                                             #
# You should have received a copy of the GNU Affero Public License along      #
# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
#                                                                             #
###############################################################################

import os
29
import click
André Anjos's avatar
André Anjos committed
30
import glob
31
import random
Samuel GAIST's avatar
Samuel GAIST committed
32
import zmq
33

André Anjos's avatar
André Anjos committed
34
import logging
Samuel GAIST's avatar
Samuel GAIST committed
35

André Anjos's avatar
André Anjos committed
36
37
38

import simplejson

39
from beat.cmdline.scripts.click_helper import AliasedGroup
Samuel GAIST's avatar
Samuel GAIST committed
40
41
from beat.core.hash import toPath
from beat.core.hash import hashDataset
André Anjos's avatar
André Anjos committed
42
43
from beat.core.utils import NumpyJSONEncoder
from beat.core.database import Database
44
from beat.core.data import RemoteDataSource
45
46
47
from beat.core import dock
from beat.core import inputs
from beat.core import utils
André Anjos's avatar
André Anjos committed
48
49

from . import common
50
from .decorators import raise_on_error
André Anjos's avatar
André Anjos committed
51

Samuel GAIST's avatar
Samuel GAIST committed
52
logger = logging.getLogger(__name__)
André Anjos's avatar
André Anjos committed
53

54
55
56
57
CMD_DB_INDEX = 'index'
CMD_VIEW_OUTPUTS = 'databases_provider'


Samuel GAIST's avatar
Samuel GAIST committed
58
# ----------------------------------------------------------
59
60
61
62
63
64
65


def load_database_sets(configuration, database_name):
    # Process the name of the database
    parts = database_name.split('/')

    if len(parts) == 2:
Samuel GAIST's avatar
Samuel GAIST committed
66
67
68
        db_name = os.path.join(*parts[:2])
        protocol_filter = None
        set_filter = None
69
70

    elif len(parts) == 3:
Samuel GAIST's avatar
Samuel GAIST committed
71
72
73
        db_name = os.path.join(*parts[:2])
        protocol_filter = parts[2]
        set_filter = None
74
75

    elif len(parts) == 4:
Samuel GAIST's avatar
Samuel GAIST committed
76
77
78
        db_name = os.path.join(*parts[:2])
        protocol_filter = parts[2]
        set_filter = parts[3]
79
80

    else:
Samuel GAIST's avatar
Samuel GAIST committed
81
        logger.error("Database specification should have the format "
Samuel GAIST's avatar
Samuel GAIST committed
82
                     "`<database>/<version>/[<protocol>/[<set>]]', the value "
Samuel GAIST's avatar
Samuel GAIST committed
83
                     "you passed (%s) is not valid", database_name)
Samuel GAIST's avatar
Samuel GAIST committed
84
        return (None, None)
85
86
87

    # Load the dataformat
    dataformat_cache = {}
88
    database = Database(configuration.path,
Samuel GAIST's avatar
Samuel GAIST committed
89
                        db_name, dataformat_cache)
90
    if not database.valid:
Samuel GAIST's avatar
Samuel GAIST committed
91
92
93
94
        logger.error("Failed to load the database `%s':", db_name)
        for e in database.errors:
            logger.error('  * %s', e)
        return (None, None, None)
95
96
97
98
99

    # Filter the protocols
    protocols = database.protocol_names

    if protocol_filter is not None:
Samuel GAIST's avatar
Samuel GAIST committed
100
101
102
103
        if protocol_filter not in protocols:
            logger.error("The database `%s' does not have the protocol `%s' - "
                         "choose one of `%s'", db_name, protocol_filter,
                         ', '.join(protocols))
104

Samuel GAIST's avatar
Samuel GAIST committed
105
            return (None, None, None)
106

Samuel GAIST's avatar
Samuel GAIST committed
107
        protocols = [protocol_filter]
108
109
110
111
112

    # Filter the sets
    loaded_sets = []

    for protocol_name in protocols:
Samuel GAIST's avatar
Samuel GAIST committed
113
        sets = database.set_names(protocol_name)
114

Samuel GAIST's avatar
Samuel GAIST committed
115
116
117
        if set_filter is not None:
            if set_filter not in sets:
                logger.error("The database/protocol `%s/%s' does not have the "
Samuel GAIST's avatar
Samuel GAIST committed
118
119
120
                             "set `%s' - choose one of `%s'",
                             db_name, protocol_name, set_filter,
                             ', '.join(sets))
Samuel GAIST's avatar
Samuel GAIST committed
121
                return (None, None, None)
122

Samuel GAIST's avatar
Samuel GAIST committed
123
            sets = [z for z in sets if z == set_filter]
124

Samuel GAIST's avatar
Samuel GAIST committed
125
126
        loaded_sets.extend([(protocol_name, set_name,
                             database.set(protocol_name, set_name))
Samuel GAIST's avatar
Samuel GAIST committed
127
                            for set_name in sets])
128
129
130
131

    return (db_name, database, loaded_sets)


Samuel GAIST's avatar
Samuel GAIST committed
132
# ----------------------------------------------------------
133
134


135
136
def start_db_container(configuration, cmd, host,
                       db_name, protocol_name, set_name, database, db_set,
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
                       excluded_outputs=None, uid=None, db_root=None):

    input_list = inputs.InputList()

    input_group = inputs.InputGroup(set_name, restricted_access=False)
    input_list.add(input_group)

    db_configuration = {
        'inputs': {},
        'channel': set_name,
    }

    if uid is not None:
        db_configuration['datasets_uid'] = uid

    if db_root is not None:
        db_configuration['datasets_root_path'] = db_root

    for output_name, dataformat_name in db_set['outputs'].items():
Samuel GAIST's avatar
Samuel GAIST committed
156
        if excluded_outputs is not None and output_name in excluded_outputs:
157
158
            continue

159
        dataset_hash = hashDataset(db_name, protocol_name, set_name)
160
        db_configuration['inputs'][output_name] = dict(
Samuel GAIST's avatar
Samuel GAIST committed
161
162
163
164
165
166
167
            database=db_name,
            protocol=protocol_name,
            set=set_name,
            output=output_name,
            channel=set_name,
            hash=dataset_hash,
            path=toPath(dataset_hash, '.db')
168
169
170
171
172
173
174
175
176
177
178
        )

    db_tempdir = utils.temporary_directory()

    with open(os.path.join(db_tempdir, 'configuration.json'), 'wb') as f:
        simplejson.dump(db_configuration, f, indent=4)

    tmp_prefix = os.path.join(db_tempdir, 'prefix')
    if not os.path.exists(tmp_prefix):
        os.makedirs(tmp_prefix)

179
    database.export(tmp_prefix)
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

    if db_root is None:
        json_path = os.path.join(tmp_prefix, 'databases', db_name + '.json')

        with open(json_path, 'r') as f:
            db_data = simplejson.load(f)

        database_path = db_data['root_folder']
        db_data['root_folder'] = os.path.join('/databases', db_name)

        with open(json_path, 'w') as f:
            simplejson.dump(db_data, f, indent=4)

    try:
        db_envkey = host.db2docker([db_name])
    except:
Samuel GAIST's avatar
Samuel GAIST committed
196
        raise RuntimeError("No environment found for the database `%s' "
197
198
199
200
201
202
                           "- available environments are %s" % (
                               db_name,
                               ", ".join(host.db_environments.keys())))

    # Creation of the container
    # Note: we only support one databases image loaded at the same time
203
204
205
206
207
    CONTAINER_PREFIX = '/beat/prefix'
    CONTAINER_CACHE = '/beat/cache'

    database_port = random.randint(51000, 60000)
    if cmd == CMD_VIEW_OUTPUTS:
Samuel GAIST's avatar
Samuel GAIST committed
208
209
210
211
212
213
        db_cmd = [
            cmd,
            '0.0.0.0:{}'.format(database_port),
            CONTAINER_PREFIX,
            CONTAINER_CACHE
        ]
214
    else:
Samuel GAIST's avatar
Samuel GAIST committed
215
216
217
218
219
220
221
222
        db_cmd = [
            cmd,
            CONTAINER_PREFIX,
            CONTAINER_CACHE,
            db_name,
            protocol_name,
            set_name
        ]
223
224

    databases_container = host.create_container(db_envkey, db_cmd)
225
    if cmd == CMD_VIEW_OUTPUTS:
Samuel GAIST's avatar
Samuel GAIST committed
226
227
        databases_container.add_port(
            database_port, database_port, host_address=host.ip)
228
229
    databases_container.add_volume(db_tempdir, '/beat/prefix')
    databases_container.add_volume(configuration.cache, '/beat/cache')
230
231

    # Specify the volumes to mount inside the container
Samuel GAIST's avatar
Samuel GAIST committed
232
    if 'datasets_root_path' not in db_configuration:
Samuel GAIST's avatar
Samuel GAIST committed
233
234
        databases_container.add_volume(
            database_path, os.path.join('/databases', db_name))
235
236
237
238
239
240
241
    else:
        databases_container.add_volume(db_configuration['datasets_root_path'],
                                       db_configuration['datasets_root_path'])

    # Start the container
    host.start(databases_container)

242
    if cmd == CMD_VIEW_OUTPUTS:
Samuel GAIST's avatar
Samuel GAIST committed
243
244
245
246
247
        # Communicate with container
        zmq_context = zmq.Context()
        db_socket = zmq_context.socket(zmq.PAIR)
        db_address = 'tcp://{}:{}'.format(host.ip, database_port)
        db_socket.connect(db_address)
248

Samuel GAIST's avatar
Samuel GAIST committed
249
        for output_name, dataformat_name in db_set['outputs'].items():
Samuel GAIST's avatar
Samuel GAIST committed
250
251
            if excluded_outputs is not None and \
               output_name in excluded_outputs:
Samuel GAIST's avatar
Samuel GAIST committed
252
                continue
253

Samuel GAIST's avatar
Samuel GAIST committed
254
255
256
            data_source = RemoteDataSource()
            data_source.setup(db_socket, output_name,
                              dataformat_name, configuration.path)
257

Samuel GAIST's avatar
Samuel GAIST committed
258
259
260
261
            input_ = inputs.Input(output_name,
                                  database.dataformats[dataformat_name],
                                  data_source)
            input_group.add(input_)
262

Samuel GAIST's avatar
Samuel GAIST committed
263
        return (databases_container, db_socket, zmq_context, input_list)
264
265

    return databases_container
266
267


Samuel GAIST's avatar
Samuel GAIST committed
268
# ----------------------------------------------------------
269
270


271
def pull_impl(webapi, prefix, names, force, indentation, format_cache):
Samuel GAIST's avatar
Samuel GAIST committed
272
    """Copies databases (and required dataformats) from the server.
André Anjos's avatar
André Anjos committed
273

Samuel GAIST's avatar
Samuel GAIST committed
274
    Parameters:
André Anjos's avatar
André Anjos committed
275

Samuel GAIST's avatar
Samuel GAIST committed
276
277
      webapi (object): An instance of our WebAPI class, prepared to access the
        BEAT server of interest
André Anjos's avatar
André Anjos committed
278

Samuel GAIST's avatar
Samuel GAIST committed
279
280
      prefix (str): A string representing the root of the path in which the
        user objects are stored
André Anjos's avatar
André Anjos committed
281

André Anjos's avatar
André Anjos committed
282
283
284
285
286
      names (:py:class:`list`): A list of strings, each representing the unique
        relative path of the objects to retrieve or a list of usernames from
        which to retrieve objects. If the list is empty, then we pull all
        available objects of a given type. If no user is set, then pull all
        public objects of a given type.
André Anjos's avatar
André Anjos committed
287

Samuel GAIST's avatar
Samuel GAIST committed
288
289
      force (bool): If set to ``True``, then overwrites local changes with the
        remotely retrieved copies.
André Anjos's avatar
André Anjos committed
290

Samuel GAIST's avatar
Samuel GAIST committed
291
292
293
      indentation (int): The indentation level, useful if this function is
        called recursively while downloading different object types. This is
        normally set to ``0`` (zero).
André Anjos's avatar
André Anjos committed
294

Samuel GAIST's avatar
Samuel GAIST committed
295
296
      format_cache (dict): A dictionary containing all dataformats already
        downloaded.
André Anjos's avatar
André Anjos committed
297
298


Samuel GAIST's avatar
Samuel GAIST committed
299
    Returns:
André Anjos's avatar
André Anjos committed
300

Samuel GAIST's avatar
Samuel GAIST committed
301
302
      int: Indicating the exit status of the command, to be reported back to
        the calling process. This value should be zero if everything works OK,
Samuel GAIST's avatar
Samuel GAIST committed
303
        otherwise, different than zero (POSIX compliance).
André Anjos's avatar
André Anjos committed
304

Samuel GAIST's avatar
Samuel GAIST committed
305
    """
André Anjos's avatar
André Anjos committed
306

307
    from .dataformats import pull_impl as dataformats_pull
André Anjos's avatar
André Anjos committed
308

Samuel GAIST's avatar
Samuel GAIST committed
309
    status, names = common.pull(webapi, prefix, 'database', names,
Samuel GAIST's avatar
Samuel GAIST committed
310
311
                                ['declaration', 'code', 'description'],
                                force, indentation)
André Anjos's avatar
André Anjos committed
312

Samuel GAIST's avatar
Samuel GAIST committed
313
314
315
316
317
    # see what dataformats one needs to pull
    dataformats = []
    for name in names:
        obj = Database(prefix, name)
        dataformats.extend(obj.dataformats.keys())
André Anjos's avatar
André Anjos committed
318

Samuel GAIST's avatar
Samuel GAIST committed
319
320
321
    # downloads any formats to which we depend on
    df_status = dataformats_pull(webapi, prefix, dataformats, force,
                                 indentation + 2, format_cache)
André Anjos's avatar
André Anjos committed
322

Samuel GAIST's avatar
Samuel GAIST committed
323
    return status + df_status
André Anjos's avatar
André Anjos committed
324
325


Samuel GAIST's avatar
Samuel GAIST committed
326
# ----------------------------------------------------------
André Anjos's avatar
André Anjos committed
327
328


329
def index_outputs(configuration, names, uid=None, db_root=None, docker=False):
André Anjos's avatar
André Anjos committed
330

331
332
    names = common.make_up_local_list(configuration.path, 'database', names)
    retcode = 0
André Anjos's avatar
André Anjos committed
333

Philip ABBET's avatar
Philip ABBET committed
334
    if docker:
Samuel GAIST's avatar
Samuel GAIST committed
335
        host = dock.Host(raise_on_errors=False)
André Anjos's avatar
André Anjos committed
336

337
    for database_name in names:
Samuel GAIST's avatar
Samuel GAIST committed
338
        logger.info("Indexing database %s...", database_name)
André Anjos's avatar
André Anjos committed
339

Samuel GAIST's avatar
Samuel GAIST committed
340
341
342
343
344
        (db_name, database, sets) = load_database_sets(
            configuration, database_name)
        if database is None:
            retcode += 1
            continue
André Anjos's avatar
André Anjos committed
345

Samuel GAIST's avatar
Samuel GAIST committed
346
347
        for protocol_name, set_name, db_set in sets:
            if not docker:
348
349
350
351
352
353
354
                try:
                    view = database.view(protocol_name, set_name)
                except SyntaxError as error:
                    logger.error("Failed to load the database `%s':",
                                 database_name)
                    logger.error('  * Syntax error: %s', error)
                    view = None
André Anjos's avatar
André Anjos committed
355

Samuel GAIST's avatar
Samuel GAIST committed
356
357
358
                if view is None:
                    retcode += 1
                    continue
359

Samuel GAIST's avatar
Samuel GAIST committed
360
                dataset_hash = hashDataset(db_name, protocol_name, set_name)
361
362
363
364
365
366
367
368
369
                try:
                    view.index(os.path.join(configuration.cache,
                                            toPath(dataset_hash, '.db')))
                except RuntimeError as error:
                  logger.error("Failed to load the database `%s':",
                               database_name)
                  logger.error('  * Runtime error %s', error)
                  retcode += 1
                  continue
370

Samuel GAIST's avatar
Samuel GAIST committed
371
372
373
            else:
                databases_container = \
                    start_db_container(configuration, CMD_DB_INDEX,
Samuel GAIST's avatar
Samuel GAIST committed
374
375
                                       host, db_name, protocol_name, set_name,
                                       database, db_set,
Samuel GAIST's avatar
Samuel GAIST committed
376
377
378
379
380
                                       uid=uid, db_root=db_root
                                       )
                status = host.wait(databases_container)
                if status != 0:
                    retcode += 1
André Anjos's avatar
André Anjos committed
381

382
    return retcode
André Anjos's avatar
André Anjos committed
383
384


Samuel GAIST's avatar
Samuel GAIST committed
385
# ----------------------------------------------------------
André Anjos's avatar
André Anjos committed
386
387


388
def list_index_files(configuration, names):
389

390
    names = common.make_up_local_list(configuration.path, 'database', names)
391

392
    retcode = 0
393

394
395
    for database_name in names:
        logger.info("Listing database %s indexes...", database_name)
396

Samuel GAIST's avatar
Samuel GAIST committed
397
398
        (db_name, database, sets) = load_database_sets(
            configuration, database_name)
399
400
401
        if database is None:
            retcode += 1
            continue
André Anjos's avatar
André Anjos committed
402

403
        for protocol_name, set_name, db_set in sets:
404
405
406
407
408
            dataset_hash = hashDataset(db_name, protocol_name, set_name)
            index_filename = toPath(dataset_hash)
            basename = os.path.splitext(index_filename)[0]
            for g in glob.glob(basename + '.*'):
                logger.info(g)
409

410
    return retcode
411
412


Samuel GAIST's avatar
Samuel GAIST committed
413
# ----------------------------------------------------------
414
415


416
def delete_index_files(configuration, names):
417

418
    names = common.make_up_local_list(configuration.path, 'database', names)
419

420
    retcode = 0
421

422
423
    for database_name in names:
        logger.info("Deleting database %s indexes...", database_name)
424

Samuel GAIST's avatar
Samuel GAIST committed
425
426
        (db_name, database, sets) = load_database_sets(
            configuration, database_name)
427
428
429
        if database is None:
            retcode += 1
            continue
430

431
432
        for protocol_name, set_name, db_set in sets:
            for output_name in db_set['outputs'].keys():
433
434
435
436
                dataset_hash = hashDataset(db_name, protocol_name, set_name)
                index_filename = toPath(dataset_hash)
                basename = os.path.join(configuration.cache,
                                        os.path.splitext(index_filename)[0])
437

438
439
440
                for g in glob.glob(basename + '.*'):
                    logger.info("removing `%s'...", g)
                    os.unlink(g)
441

442
443
                common.recursive_rmdir_if_empty(os.path.dirname(basename),
                                                configuration.cache)
444

445
    return retcode
446
447


Samuel GAIST's avatar
Samuel GAIST committed
448
# ----------------------------------------------------------
449

André Anjos's avatar
André Anjos committed
450

451
452
def view_outputs(configuration, dataset_name, excluded_outputs=None, uid=None,
                 db_root=None, docker=False):
André Anjos's avatar
André Anjos committed
453

454
455
    def data_to_json(data, indent):
        value = common.stringify(data.as_dict())
André Anjos's avatar
André Anjos committed
456

457
458
459
460
461
462
        value = simplejson.dumps(value, indent=4, cls=NumpyJSONEncoder) \
            .replace('"BEAT_LIST_DELIMITER[', '[') \
            .replace(']BEAT_LIST_DELIMITER"', ']') \
            .replace('"...",', '...') \
            .replace('"BEAT_LIST_SIZE(', '(') \
            .replace(')BEAT_LIST_SIZE"', ')')
André Anjos's avatar
André Anjos committed
463

464
        return ('\n' + ' ' * indent).join(value.split('\n'))
André Anjos's avatar
André Anjos committed
465

466
467
468
469
    # Load the infos about the database set
    (db_name, database, sets) = load_database_sets(configuration, dataset_name)
    if (database is None) or (len(sets) != 1):
        return 1
André Anjos's avatar
André Anjos committed
470

471
472
473
    (protocol_name, set_name, db_set) = sets[0]

    if excluded_outputs is not None:
Samuel GAIST's avatar
Samuel GAIST committed
474
475
        excluded_outputs = map(lambda x: x.strip(),
                               excluded_outputs.split(','))
André Anjos's avatar
André Anjos committed
476

477
478
    # Setup the view so the outputs can be used
    if not docker:
Samuel GAIST's avatar
Samuel GAIST committed
479
        view = database.view(protocol_name, set_name)
480

481
482
        if view is None:
            return 1
483
484
485
486
487
488
489

        dataset_hash = hashDataset(db_name, protocol_name, set_name)
        view.setup(os.path.join(configuration.cache,
                                toPath(dataset_hash, '.db')), pack=False)
        input_group = inputs.InputGroup(set_name, restricted_access=False)

        for output_name, dataformat_name in db_set['outputs'].items():
Samuel GAIST's avatar
Samuel GAIST committed
490
491
            if excluded_outputs is not None and \
               output_name in excluded_outputs:
492
493
                continue

Samuel GAIST's avatar
Samuel GAIST committed
494
495
496
            input = inputs.Input(output_name,
                                 database.dataformats[dataformat_name],
                                 view.data_sources[output_name])
497
498
            input_group.add(input)

499
500
501
502
    else:
        host = dock.Host(raise_on_errors=False)

        (databases_container, db_socket, zmq_context, input_list) = \
503
            start_db_container(configuration, CMD_VIEW_OUTPUTS,
Samuel GAIST's avatar
Samuel GAIST committed
504
505
506
507
                               host, db_name, protocol_name,
                               set_name, database, db_set,
                               excluded_outputs=excluded_outputs,
                               uid=uid, db_root=db_root)
508

509
        input_group = input_list.group(set_name)
André Anjos's avatar
André Anjos committed
510

511
512
513
    # Display the data
    try:
        previous_start = -1
André Anjos's avatar
André Anjos committed
514

515
516
        while input_group.hasMoreData():
            input_group.next()
André Anjos's avatar
André Anjos committed
517

518
519
            start = input_group.data_index
            end = input_group.data_index_end
André Anjos's avatar
André Anjos committed
520

521
522
            if start != previous_start:
                print(80 * '-')
André Anjos's avatar
André Anjos committed
523

524
                print('FROM %d TO %d' % (start, end))
André Anjos's avatar
André Anjos committed
525

Samuel GAIST's avatar
Samuel GAIST committed
526
527
528
                whole_inputs = [input_ for input_ in input_group
                                if input_.data_index == start and
                                input_.data_index_end == end]
André Anjos's avatar
André Anjos committed
529

530
531
                for input in whole_inputs:
                    label = ' - ' + str(input.name) + ': '
532
                    print(label + data_to_json(input.data, len(label)))
André Anjos's avatar
André Anjos committed
533

534
                previous_start = start
André Anjos's avatar
André Anjos committed
535

Samuel GAIST's avatar
Samuel GAIST committed
536
537
538
539
540
            selected_inputs = \
                [input_ for input_ in input_group
                 if input_.data_index == input_group.first_data_index and
                 (input_.data_index != start or
                  input_.data_index_end != end)]
André Anjos's avatar
André Anjos committed
541

542
            grouped_inputs = {}
Samuel GAIST's avatar
Samuel GAIST committed
543
544
545
            for input_ in selected_inputs:
                key = (input_.data_index, input_.data_index_end)
                if key not in grouped_inputs:
546
547
                    grouped_inputs[key] = []
                grouped_inputs[key].append(input)
André Anjos's avatar
André Anjos committed
548

549
            sorted_keys = sorted(grouped_inputs.keys())
550
551
552

            for key in sorted_keys:
                print
553
                print('  FROM %d TO %d' % key)
554
555
556

                for input in grouped_inputs[key]:
                    label = '   - ' + str(input.name) + ': '
557
                    print(label + data_to_json(input.data, len(label)))
André Anjos's avatar
André Anjos committed
558
559

    except Exception as e:
560
561
562
563
        logger.error("Failed to retrieve the next data: %s", e)
        return 1

    return 0
André Anjos's avatar
André Anjos committed
564

565

Samuel GAIST's avatar
Samuel GAIST committed
566
# ----------------------------------------------------------
André Anjos's avatar
André Anjos committed
567
568


569
@click.group(cls=AliasedGroup)
570
@click.pass_context
571
def databases(ctx):
572
573
    """Database commands"""
    pass
574

Samuel GAIST's avatar
Samuel GAIST committed
575

576
@databases.command()
577
578
579
@click.option('--remote', help='Only acts on the remote copy of the database.',
              is_flag=True)
@click.pass_context
580
@raise_on_error
581
582
def list(ctx, remote):
    '''Lists all the databases available on the platform.
583

584
    To list all existing databases on your local prefix:
585

586
        $ beat databases list
587
588
589
    '''
    configuration = ctx.meta['config']
    if remote:
590
        with common.make_webapi(configuration) as webapi:
591
592
593
594
595
            return common.display_remote_list(webapi, 'database')
    else:
        return common.display_local_list(configuration.path, 'database')


596
597
598
@databases.command()
@click.argument('names', nargs=-1)
@click.pass_context
599
@raise_on_error
600
601
602
603
604
605
606
607
608
609
610
611
def path(ctx, names):
  '''Displays local path of databases files

  Example:
    $ beat databases path xxx
  '''
  return common.display_local_path(ctx.meta['config'].path, 'database', names)


@databases.command()
@click.argument('name', nargs=1)
@click.pass_context
612
@raise_on_error
613
614
615
616
617
618
619
620
621
622
623
624
def edit(ctx, name):
  '''Edit local database file

  Example:
    $ beat databases edit xxx
  '''
  return common.edit_local_file(ctx.meta['config'].path,
                                ctx.meta['config'].editor, 'database',
                                name)



625
@databases.command()
626
627
@click.argument('db_names', nargs=-1)
@click.pass_context
628
@raise_on_error
629
630
631
def check(ctx, db_names):
    '''Checks a local database for validity.

632
    $ beat databases check [<name>]...
633
634
635
636
637
638
639

    <name>:
        Database name formatted as "<database>/<version>"
    '''
    return common.check(ctx.meta['config'].path, 'database', db_names)


640
@databases.command()
641
@click.argument('db_names', nargs=-1)
642
@click.option('--force', help='Performs operation regardless of conflicts',
643
644
              is_flag=True)
@click.pass_context
645
@raise_on_error
646
647
648
def pull(ctx, db_names, force):
    '''Downloads the specified databases from the server.

649
       $ beat databases pull [<name>]...
650
651
652
653
654
655
656
657
658

    <name>:
        Database name formatted as "<database>/<version>"
    '''
    configuration = ctx.meta['config']
    with common.make_webapi(configuration) as webapi:
        return pull_impl(webapi, configuration.path, db_names, force, 0, {})


659
@databases.command()
660
@click.argument('db_names', nargs=-1)
661
@click.option('--force', help='Performs operation regardless of conflicts',
662
663
664
665
              is_flag=True)
@click.option('--dry-run', help='Dry run',
              is_flag=True)
@click.pass_context
666
@raise_on_error
667
668
669
def push(ctx, db_names, force, dry_run):
    '''Uploads databases to the server (must provide a valid admin token).

670
    $ beat databases push [<name>]...
671
672
673
674
675
676
677
678
679
680
681
682
683

    <name>:
        Database name formatted as "<database>/<version>"

    '''
    configuration = ctx.meta['config']
    with common.make_webapi(configuration) as webapi:
        return common.push(webapi, configuration.path, 'database',
                           db_names, ['name', 'declaration',
                                      'code', 'description'],
                           {}, force, dry_run, 0)


684
@databases.command()
685
686
@click.argument('db_names', nargs=-1)
@click.pass_context
687
@raise_on_error
688
689
690
def diff(ctx, db_names):
    '''Shows changes between the local database and the remote version.

691
    $ beat databases diff [<name>]...
692
693
694
695
696
697
698
699
700
701
702
703
704

    <name>:
        Database name formatted as "<database>/<version>"
    '''
    configuration = ctx.meta['config']
    if len(db_names) < 1:
        raise click.ClickException("Requires at least one database name")
    with common.make_webapi(configuration) as webapi:
        return common.diff(webapi, configuration.path, 'database',
                           db_names[0],
                           ['declaration', 'code', 'description'])


705
@databases.command()
706
@click.pass_context
707
@raise_on_error
708
709
710
711
712
713
714
def status(ctx):
    '''Shows (editing) status for all available databases'''
    configuration = ctx.meta['config']
    with common.make_webapi(configuration) as webapi:
        return common.status(webapi, configuration.path, 'database')[0]


715
@databases.command()
716
717
@click.argument('db_names', nargs=-1)
@click.pass_context
718
@raise_on_error
719
720
721
def version(ctx, db_names):
    '''Creates a new version of an existing database.

722
    $ beat databases version [<name>]...
723
724
725
726
727
728
729
730
731
732
733

    <name>:
        Database name formatted as "<database>/<version>"

    '''
    configuration = ctx.meta['config']
    if len(db_names) < 1:
        raise click.ClickException("Requires at least one database name")
    return common.new_version(configuration.path, 'database', db_names[0])


734
@databases.command()
735
736
737
738
739
740
@click.argument('db_names', nargs=-1)
@click.option('--list', help='List index files matching output if they exist',
              is_flag=True)
@click.option('--delete', help='Delete index files matching output if they '
              'exist (also, recursively deletes empty directories)',
              is_flag=True)
741
742
@click.option('--checksum', help='Checksums index files', is_flag=True,
              default=True)
743
744
745
746
@click.option('--uid', type=click.INT, default=None)
@click.option('--db-root', help="Database root")
@click.option('--docker', is_flag=True)
@click.pass_context
747
@raise_on_error
748
749
750
751
752
def index(ctx, db_names, list, delete, checksum, uid, db_root, docker):
    '''Indexes all outputs (of all sets) of a database.

    To index the contents of a database

753
        $ beat databases index simple/1
754
755
756

    To index the contents of a protocol on a database

757
        $ beat databases index simple/1/double
758
759
760

    To index the contents of a set in a protocol on a database

761
        $ beat databases index simple/1/double/double
762
763
    '''
    configuration = ctx.meta['config']
764
    code = 1
765
    if list:
766
        code = list_index_files(configuration, db_names)
767
    elif delete:
768
        code = delete_index_files(configuration, db_names)
769
    elif checksum:
770
771
772
        code = index_outputs(configuration, db_names, uid=uid,
                             db_root=db_root, docker=docker)
    return code
Samuel GAIST's avatar
Samuel GAIST committed
773

774
775
@databases.command()
@click.argument('set_name', nargs=1)
776
777
778
779
780
781
@click.option('--exclude', help='When viewing, excludes this output',
              default=None)
@click.option('--uid', type=click.INT, default=None)
@click.option('--db-root', help="Database root")
@click.option('--docker', is_flag=True)
@click.pass_context
782
@raise_on_error
783
784
785
786
787
def view(ctx, set_name, exclude, uid, db_root, docker):
    '''View the data of the specified dataset.

    To view the contents of a specific set

788
    $ beat databases view simple/1/protocol/set
789
790
791
792
793
794
795
796
797
    '''
    configuration = ctx.meta['config']
    if exclude is not None:
        return view_outputs(
            configuration, set_name, exclude, uid=uid, db_root=db_root,
            docker=docker)
    return view_outputs(
        configuration, set_name, uid=uid, db_root=db_root, docker=docker
    )