databases.py 24.2 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
29
30
#!/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/.           #
#                                                                             #
###############################################################################


"""Usage:
  %(prog)s databases list [--remote]
31
  %(prog)s databases path [<name>]...
André Anjos's avatar
André Anjos committed
32
33
34
35
36
37
  %(prog)s databases check [<name>]...
  %(prog)s databases pull [--force] [<name>]...
  %(prog)s databases push [--force] [--dry-run] [<name>]...
  %(prog)s databases diff <name>
  %(prog)s databases status
  %(prog)s databases version <name>
38
39
  %(prog)s databases index [--list | --delete | --checksum] [--uid=<uid>] [--db-root=<path>] [--docker] [<name>]...
  %(prog)s databases view [--exclude=<output>] [--uid=<uid>] [--db-root=<path>] [--docker] <set_name>
André Anjos's avatar
André Anjos committed
40
41
42
43
44
45
46
47
48
49
  %(prog)s databases --help


Arguments:
  <name>           Database name formated as "<database>/<version>"
  <set_name>       Set formatted as "<database>/<version>/<protocol>/<set>"


Commands:
  list      Lists all the databases available on the platform
50
  path      Displays local path of databases files
André Anjos's avatar
André Anjos committed
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
  check     Checks a local database for validity
  pull      Downloads the specified databases from the server
  push      Uploads databases to the server (must provide a valid admin token)
  diff      Shows changes between the local database and the remote version
  status    Shows (editing) status for all available databases
  version   Creates a new version of an existing database
  index     Indexes all outputs (of all sets) of a database.
  view      View the data of the specified dataset.


Options:
  --help              Display this screen
  --remote            Only acts on the remote copy of the database
  --exclude=<output>  When viewing, excludes this output
  --list              List index files matching output if they exist
  --delete            Delete index files matching output if they exist (also,
                      recursively deletes empty directories)
  --checksum          Checksums index files


Examples:

  To list all existing databases on your local prefix:

    $ %(prog)s db list

  To view the contents of a specific set

    $ %(prog)s db view simple/1/protocol/set

  To index the contents of a database

    $ %(prog)s db index simple/1

  To index the contents of a protocol on a database

    $ %(prog)s db index simple/1/double

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

    $ %(prog)s db index simple/1/double/double
"""

import os
import glob
96
import random
Samuel GAIST's avatar
Samuel GAIST committed
97
import zmq
98

André Anjos's avatar
André Anjos committed
99
import logging
Samuel GAIST's avatar
Samuel GAIST committed
100

André Anjos's avatar
André Anjos committed
101
102
103

import simplejson

Samuel GAIST's avatar
Samuel GAIST committed
104
105
from beat.core.hash import toPath
from beat.core.hash import hashDataset
André Anjos's avatar
André Anjos committed
106
107
from beat.core.utils import NumpyJSONEncoder
from beat.core.database import Database
108
from beat.core.data import load_data_index, RemoteDataSource
109
110
111
from beat.core import dock
from beat.core import inputs
from beat.core import utils
André Anjos's avatar
André Anjos committed
112
113
114

from . import common

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

117
118
119
120
CMD_DB_INDEX = 'index'
CMD_VIEW_OUTPUTS = 'databases_provider'


Samuel GAIST's avatar
Samuel GAIST committed
121
# ----------------------------------------------------------
122
123
124
125
126
127
128


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
129
130
131
        db_name = os.path.join(*parts[:2])
        protocol_filter = None
        set_filter = None
132
133

    elif len(parts) == 3:
Samuel GAIST's avatar
Samuel GAIST committed
134
135
136
        db_name = os.path.join(*parts[:2])
        protocol_filter = parts[2]
        set_filter = None
137
138

    elif len(parts) == 4:
Samuel GAIST's avatar
Samuel GAIST committed
139
140
141
        db_name = os.path.join(*parts[:2])
        protocol_filter = parts[2]
        set_filter = parts[3]
142
143

    else:
Samuel GAIST's avatar
Samuel GAIST committed
144
        logger.error("Database specification should have the format "
Samuel GAIST's avatar
Samuel GAIST committed
145
                     "`<database>/<version>/[<protocol>/[<set>]]', the value "
Samuel GAIST's avatar
Samuel GAIST committed
146
                     "you passed (%s) is not valid", database_name)
Samuel GAIST's avatar
Samuel GAIST committed
147
        return (None, None)
148
149
150

    # Load the dataformat
    dataformat_cache = {}
151
    database = Database(configuration.path,
Samuel GAIST's avatar
Samuel GAIST committed
152
                        db_name, dataformat_cache)
153
    if not database.valid:
Samuel GAIST's avatar
Samuel GAIST committed
154
155
156
157
        logger.error("Failed to load the database `%s':", db_name)
        for e in database.errors:
            logger.error('  * %s', e)
        return (None, None, None)
158
159
160
161
162

    # Filter the protocols
    protocols = database.protocol_names

    if protocol_filter is not None:
Samuel GAIST's avatar
Samuel GAIST committed
163
164
165
166
        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))
167

Samuel GAIST's avatar
Samuel GAIST committed
168
            return (None, None, None)
169

Samuel GAIST's avatar
Samuel GAIST committed
170
        protocols = [protocol_filter]
171
172
173
174
175

    # Filter the sets
    loaded_sets = []

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

Samuel GAIST's avatar
Samuel GAIST committed
178
179
180
        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
181
182
183
                             "set `%s' - choose one of `%s'",
                             db_name, protocol_name, set_filter,
                             ', '.join(sets))
Samuel GAIST's avatar
Samuel GAIST committed
184
                return (None, None, None)
185

Samuel GAIST's avatar
Samuel GAIST committed
186
            sets = [z for z in sets if z == set_filter]
187

Samuel GAIST's avatar
Samuel GAIST committed
188
189
        loaded_sets.extend([(protocol_name, set_name,
                             database.set(protocol_name, set_name))
Samuel GAIST's avatar
Samuel GAIST committed
190
                            for set_name in sets])
191
192
193
194

    return (db_name, database, loaded_sets)


Samuel GAIST's avatar
Samuel GAIST committed
195
# ----------------------------------------------------------
196
197


198
199
def start_db_container(configuration, cmd, host,
                       db_name, protocol_name, set_name, database, db_set,
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
                       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
219
        if excluded_outputs is not None and output_name in excluded_outputs:
220
221
            continue

222
        dataset_hash = hashDataset(db_name, protocol_name, set_name)
223
        db_configuration['inputs'][output_name] = dict(
Samuel GAIST's avatar
Samuel GAIST committed
224
225
226
227
228
229
230
            database=db_name,
            protocol=protocol_name,
            set=set_name,
            output=output_name,
            channel=set_name,
            hash=dataset_hash,
            path=toPath(dataset_hash, '.db')
231
232
233
234
235
236
237
238
239
240
241
        )

    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)

242
    database.export(tmp_prefix)
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

    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
259
        raise RuntimeError("No environment found for the database `%s' "
260
261
262
263
264
265
                           "- 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
266
267
268
269
270
    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
271
272
273
274
275
276
        db_cmd = [
            cmd,
            '0.0.0.0:{}'.format(database_port),
            CONTAINER_PREFIX,
            CONTAINER_CACHE
        ]
277
    else:
Samuel GAIST's avatar
Samuel GAIST committed
278
279
280
281
282
283
284
285
        db_cmd = [
            cmd,
            CONTAINER_PREFIX,
            CONTAINER_CACHE,
            db_name,
            protocol_name,
            set_name
        ]
286
287

    databases_container = host.create_container(db_envkey, db_cmd)
288
    if cmd == CMD_VIEW_OUTPUTS:
Samuel GAIST's avatar
Samuel GAIST committed
289
290
        databases_container.add_port(
            database_port, database_port, host_address=host.ip)
291
292
    databases_container.add_volume(db_tempdir, '/beat/prefix')
    databases_container.add_volume(configuration.cache, '/beat/cache')
293
294

    # Specify the volumes to mount inside the container
Samuel GAIST's avatar
Samuel GAIST committed
295
    if 'datasets_root_path' not in db_configuration:
Samuel GAIST's avatar
Samuel GAIST committed
296
297
        databases_container.add_volume(
            database_path, os.path.join('/databases', db_name))
298
299
300
301
302
303
304
    else:
        databases_container.add_volume(db_configuration['datasets_root_path'],
                                       db_configuration['datasets_root_path'])

    # Start the container
    host.start(databases_container)

305
    if cmd == CMD_VIEW_OUTPUTS:
Samuel GAIST's avatar
Samuel GAIST committed
306
307
308
309
310
        # 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)
311

Samuel GAIST's avatar
Samuel GAIST committed
312
        for output_name, dataformat_name in db_set['outputs'].items():
Samuel GAIST's avatar
Samuel GAIST committed
313
314
            if excluded_outputs is not None and \
               output_name in excluded_outputs:
Samuel GAIST's avatar
Samuel GAIST committed
315
                continue
316

Samuel GAIST's avatar
Samuel GAIST committed
317
318
319
            data_source = RemoteDataSource()
            data_source.setup(db_socket, output_name,
                              dataformat_name, configuration.path)
320

Samuel GAIST's avatar
Samuel GAIST committed
321
322
323
324
            input_ = inputs.Input(output_name,
                                  database.dataformats[dataformat_name],
                                  data_source)
            input_group.add(input_)
325

Samuel GAIST's avatar
Samuel GAIST committed
326
        return (databases_container, db_socket, zmq_context, input_list)
327
328

    return databases_container
329
330


Samuel GAIST's avatar
Samuel GAIST committed
331
# ----------------------------------------------------------
332
333


André Anjos's avatar
André Anjos committed
334
def pull(webapi, prefix, names, force, indentation, format_cache):
Samuel GAIST's avatar
Samuel GAIST committed
335
    """Copies databases (and required dataformats) from the server.
André Anjos's avatar
André Anjos committed
336

Samuel GAIST's avatar
Samuel GAIST committed
337
    Parameters:
André Anjos's avatar
André Anjos committed
338

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

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

André Anjos's avatar
André Anjos committed
345
346
347
348
349
      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
350

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

Samuel GAIST's avatar
Samuel GAIST committed
354
355
356
      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
357

Samuel GAIST's avatar
Samuel GAIST committed
358
359
      format_cache (dict): A dictionary containing all dataformats already
        downloaded.
André Anjos's avatar
André Anjos committed
360
361


Samuel GAIST's avatar
Samuel GAIST committed
362
    Returns:
André Anjos's avatar
André Anjos committed
363

Samuel GAIST's avatar
Samuel GAIST committed
364
365
      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
366
        otherwise, different than zero (POSIX compliance).
André Anjos's avatar
André Anjos committed
367

Samuel GAIST's avatar
Samuel GAIST committed
368
    """
André Anjos's avatar
André Anjos committed
369

Samuel GAIST's avatar
Samuel GAIST committed
370
    from .dataformats import pull as dataformats_pull
André Anjos's avatar
André Anjos committed
371

Samuel GAIST's avatar
Samuel GAIST committed
372
    status, names = common.pull(webapi, prefix, 'database', names,
Samuel GAIST's avatar
Samuel GAIST committed
373
374
                                ['declaration', 'code', 'description'],
                                force, indentation)
André Anjos's avatar
André Anjos committed
375

Samuel GAIST's avatar
Samuel GAIST committed
376
377
378
379
380
    # 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
381

Samuel GAIST's avatar
Samuel GAIST committed
382
383
384
    # 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
385

Samuel GAIST's avatar
Samuel GAIST committed
386
    return status + df_status
André Anjos's avatar
André Anjos committed
387
388


Samuel GAIST's avatar
Samuel GAIST committed
389
# ----------------------------------------------------------
André Anjos's avatar
André Anjos committed
390
391


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

394
395
    names = common.make_up_local_list(configuration.path, 'database', names)
    retcode = 0
André Anjos's avatar
André Anjos committed
396

Philip ABBET's avatar
Philip ABBET committed
397
    if docker:
Samuel GAIST's avatar
Samuel GAIST committed
398
        host = dock.Host(raise_on_errors=False)
André Anjos's avatar
André Anjos committed
399

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

Samuel GAIST's avatar
Samuel GAIST committed
403
404
405
406
407
        (db_name, database, sets) = load_database_sets(
            configuration, database_name)
        if database is None:
            retcode += 1
            continue
André Anjos's avatar
André Anjos committed
408

Samuel GAIST's avatar
Samuel GAIST committed
409
410
        for protocol_name, set_name, db_set in sets:
            if not docker:
411
412
413
414
415
416
417
                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
418

Samuel GAIST's avatar
Samuel GAIST committed
419
420
421
                if view is None:
                    retcode += 1
                    continue
422

Samuel GAIST's avatar
Samuel GAIST committed
423
                dataset_hash = hashDataset(db_name, protocol_name, set_name)
424
425
426
427
428
429
430
431
432
                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
433

Samuel GAIST's avatar
Samuel GAIST committed
434
435
436
            else:
                databases_container = \
                    start_db_container(configuration, CMD_DB_INDEX,
Samuel GAIST's avatar
Samuel GAIST committed
437
438
                                       host, db_name, protocol_name, set_name,
                                       database, db_set,
Samuel GAIST's avatar
Samuel GAIST committed
439
440
441
442
443
                                       uid=uid, db_root=db_root
                                       )
                status = host.wait(databases_container)
                if status != 0:
                    retcode += 1
André Anjos's avatar
André Anjos committed
444

445
    return retcode
André Anjos's avatar
André Anjos committed
446
447


Samuel GAIST's avatar
Samuel GAIST committed
448
# ----------------------------------------------------------
André Anjos's avatar
André Anjos committed
449
450


451
def list_index_files(configuration, names):
452

453
    names = common.make_up_local_list(configuration.path, 'database', names)
454

455
    retcode = 0
456

457
458
    for database_name in names:
        logger.info("Listing database %s indexes...", database_name)
459

Samuel GAIST's avatar
Samuel GAIST committed
460
461
        (db_name, database, sets) = load_database_sets(
            configuration, database_name)
462
463
464
        if database is None:
            retcode += 1
            continue
André Anjos's avatar
André Anjos committed
465

466
        for protocol_name, set_name, db_set in sets:
467
468
469
470
471
            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)
472

473
    return retcode
474
475


Samuel GAIST's avatar
Samuel GAIST committed
476
# ----------------------------------------------------------
477
478


479
def delete_index_files(configuration, names):
480

481
    names = common.make_up_local_list(configuration.path, 'database', names)
482

483
    retcode = 0
484

485
486
    for database_name in names:
        logger.info("Deleting database %s indexes...", database_name)
487

Samuel GAIST's avatar
Samuel GAIST committed
488
489
        (db_name, database, sets) = load_database_sets(
            configuration, database_name)
490
491
492
        if database is None:
            retcode += 1
            continue
493

494
495
        for protocol_name, set_name, db_set in sets:
            for output_name in db_set['outputs'].keys():
496
497
498
499
                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])
500

501
502
503
                for g in glob.glob(basename + '.*'):
                    logger.info("removing `%s'...", g)
                    os.unlink(g)
504

505
506
                common.recursive_rmdir_if_empty(os.path.dirname(basename),
                                                configuration.cache)
507

508
    return retcode
509
510


Samuel GAIST's avatar
Samuel GAIST committed
511
# ----------------------------------------------------------
512

André Anjos's avatar
André Anjos committed
513

514
515
def view_outputs(configuration, dataset_name, excluded_outputs=None, uid=None,
                 db_root=None, docker=False):
André Anjos's avatar
André Anjos committed
516

517
518
    def data_to_json(data, indent):
        value = common.stringify(data.as_dict())
André Anjos's avatar
André Anjos committed
519

520
521
522
523
524
525
        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
526

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

529
530
531
532
    # 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
533

534
535
536
    (protocol_name, set_name, db_set) = sets[0]

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

540
541
    # Setup the view so the outputs can be used
    if not docker:
Samuel GAIST's avatar
Samuel GAIST committed
542
        view = database.view(protocol_name, set_name)
543

544
545
        if view is None:
            return 1
546
547
548
549
550
551
552

        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
553
554
            if excluded_outputs is not None and \
               output_name in excluded_outputs:
555
556
                continue

Samuel GAIST's avatar
Samuel GAIST committed
557
558
559
            input = inputs.Input(output_name,
                                 database.dataformats[dataformat_name],
                                 view.data_sources[output_name])
560
561
            input_group.add(input)

562
563
564
565
    else:
        host = dock.Host(raise_on_errors=False)

        (databases_container, db_socket, zmq_context, input_list) = \
566
            start_db_container(configuration, CMD_VIEW_OUTPUTS,
Samuel GAIST's avatar
Samuel GAIST committed
567
568
569
570
                               host, db_name, protocol_name,
                               set_name, database, db_set,
                               excluded_outputs=excluded_outputs,
                               uid=uid, db_root=db_root)
571

572
        input_group = input_list.group(set_name)
André Anjos's avatar
André Anjos committed
573

574
575
576
    # Display the data
    try:
        previous_start = -1
André Anjos's avatar
André Anjos committed
577

578
579
        while input_group.hasMoreData():
            input_group.next()
André Anjos's avatar
André Anjos committed
580

581
582
            start = input_group.data_index
            end = input_group.data_index_end
André Anjos's avatar
André Anjos committed
583

584
585
            if start != previous_start:
                print(80 * '-')
André Anjos's avatar
André Anjos committed
586

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

Samuel GAIST's avatar
Samuel GAIST committed
589
590
591
                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
592

593
594
                for input in whole_inputs:
                    label = ' - ' + str(input.name) + ': '
595
                    print(label + data_to_json(input.data, len(label)))
André Anjos's avatar
André Anjos committed
596

597
                previous_start = start
André Anjos's avatar
André Anjos committed
598

Samuel GAIST's avatar
Samuel GAIST committed
599
600
601
602
603
            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
604

605
            grouped_inputs = {}
Samuel GAIST's avatar
Samuel GAIST committed
606
607
608
            for input_ in selected_inputs:
                key = (input_.data_index, input_.data_index_end)
                if key not in grouped_inputs:
609
610
                    grouped_inputs[key] = []
                grouped_inputs[key].append(input)
André Anjos's avatar
André Anjos committed
611

612
            sorted_keys = sorted(grouped_inputs.keys())
613
614
615

            for key in sorted_keys:
                print
616
                print('  FROM %d TO %d' % key)
617
618
619

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

    except Exception as e:
623
624
625
626
        logger.error("Failed to retrieve the next data: %s", e)
        return 1

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

628

Samuel GAIST's avatar
Samuel GAIST committed
629
# ----------------------------------------------------------
André Anjos's avatar
André Anjos committed
630
631
632
633


def process(args):

634
635
636
637
    uid = int(args['--uid']) if args['--uid'] is not None else None
    configuration = args['config']
    db_names = args['<name>']

Samuel GAIST's avatar
Samuel GAIST committed
638
639
    if args['list']:
        if args['--remote']:
640
            with common.make_webapi(configuration) as webapi:
Samuel GAIST's avatar
Samuel GAIST committed
641
642
                return common.display_remote_list(webapi, 'database')
        else:
643
            return common.display_local_list(configuration.path, 'database')
Samuel GAIST's avatar
Samuel GAIST committed
644

645
    elif args['path']:
646
647
        return common.display_local_path(configuration.path, 'database', db_names)

Samuel GAIST's avatar
Samuel GAIST committed
648
    elif args['check']:
649
        return common.check(configuration.path, 'database', db_names)
Samuel GAIST's avatar
Samuel GAIST committed
650
651

    elif args['pull']:
652
653
        with common.make_webapi(configuration) as webapi:
            return pull(webapi, configuration.path, db_names,
Samuel GAIST's avatar
Samuel GAIST committed
654
655
656
                        args['--force'], 0, {})

    elif args['push']:
657
658
659
660
        with common.make_webapi(configuration) as webapi:
            return common.push(webapi, configuration.path, 'database',
                               db_names, ['name', 'declaration',
                                          'code', 'description'],
Samuel GAIST's avatar
Samuel GAIST committed
661
662
663
                               {}, args['--force'], args['--dry-run'], 0)

    elif args['diff']:
664
665
666
667
        with common.make_webapi(configuration) as webapi:
            return common.diff(webapi, configuration.path, 'database',
                               db_names[0],
                               ['declaration', 'code', 'description'])
Samuel GAIST's avatar
Samuel GAIST committed
668
669

    elif args['status']:
670
671
        with common.make_webapi(configuration) as webapi:
            return common.status(webapi, configuration.path, 'database')[0]
Samuel GAIST's avatar
Samuel GAIST committed
672
673

    elif args['version']:
674
675
        return common.new_version(configuration.path, 'database',
                                  db_names[0])
Samuel GAIST's avatar
Samuel GAIST committed
676
677
678

    elif args['view']:
        if args['--exclude']:
679
680
681
682
683
            return view_outputs(configuration, args['<set_name>'],
                                args['--exclude'],
                                uid=uid,
                                db_root=args['--db-root'],
                                docker=args['--docker'])
Samuel GAIST's avatar
Samuel GAIST committed
684
        else:
685
686
687
688
            return view_outputs(configuration, args['<set_name>'],
                                uid=uid,
                                db_root=args['--db-root'],
                                docker=args['--docker'])
Samuel GAIST's avatar
Samuel GAIST committed
689
690
691

    elif args['index']:
        if args['--list']:
692
            return list_index_files(configuration, db_names)
Samuel GAIST's avatar
Samuel GAIST committed
693
        elif args['--delete']:
694
            return delete_index_files(configuration, db_names)
Samuel GAIST's avatar
Samuel GAIST committed
695
        else:
696
697
698
699
            return index_outputs(configuration, db_names,
                                 uid=uid,
                                 db_root=args['--db-root'],
                                 docker=args['--docker'])
Samuel GAIST's avatar
Samuel GAIST committed
700
701
702
703

    # Should not happen
    logger.error("unrecognized `databases' subcommand")
    return 1