# All files / src/app/ceph/rgw/rgw-user-form rgw-user-form.component.ts

49% Statements 123/251
60.38% Branches 32/53
36.54% Functions 19/52
47.7% Lines 114/239

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    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
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    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
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    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
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    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
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615
    616
    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    6921x
    1x
    1x

    1x
    1x
    1x
    1x

    1x
    1x
    1x
    1x

    1x
    1x
    1x

    1x
    1x
    1x
    1x

    1x

    17x
    17x
    17x
    17x

    17x
    17x
    17x
    17x

    17x
    17x
    17x
    17x
    17x
    17x
    17x
    17x

    17x
    17x
    17x
    17x
    17x
    17x

    1x
    17x

    17x

    17x

    17x

    17x

    17x

    17x

    17x

    17x

    17x
    17x
    17x

    17x

    17x

    1x
    2x

    3x

    3x

    2x
    2x

    2x

    1x
    1x
    1x

    3x

    2x
    2x

    1x

    1x

    69x

    6x

    2x

    4x
    4x

    1x

    1x

    1x

    1x

    1x

    2x

    2x

    2x

    2x

    3x

    1x

    1x

    1x

    1x

    1x

    2x
    2x
    6x

    3x
    3x

    15x

    3x
    3x

    15x

    1x

    1x

    1x

    1x

    1x
    2x
    2x
    8x
    8x

    2x

    1x

    1x

    1x

    1x
     import { Component, OnInit } from '@angular/core';
    import { AbstractControl, ValidationErrors, Validators } from '@angular/forms';
    import { ActivatedRoute, Router } from '@angular/router';

    import { I18n } from '@ngx-translate/i18n-polyfill';
    import * as _ from 'lodash';
    import { BsModalService } from 'ngx-bootstrap/modal';
    import { forkJoin as observableForkJoin, Observable } from 'rxjs';

    import { RgwUserService } from '../../../shared/api/rgw-user.service';
    import { ActionLabelsI18n, URLVerbs } from '../../../shared/constants/app.constants';
    import { NotificationType } from '../../../shared/enum/notification-type.enum';
    import { CdFormBuilder } from '../../../shared/forms/cd-form-builder';
    import { CdFormGroup } from '../../../shared/forms/cd-form-group';
    import { CdValidators, isEmptyInputValue } from '../../../shared/forms/cd-validators';
    import { FormatterService } from '../../../shared/services/formatter.service';
    import { NotificationService } from '../../../shared/services/notification.service';
    import { RgwUserCapability } from '../models/rgw-user-capability';
    import { RgwUserS3Key } from '../models/rgw-user-s3-key';
    import { RgwUserSubuser } from '../models/rgw-user-subuser';
    import { RgwUserSwiftKey } from '../models/rgw-user-swift-key';
    import { RgwUserCapabilityModalComponent } from '../rgw-user-capability-modal/rgw-user-capability-modal.component';
    import { RgwUserS3KeyModalComponent } from '../rgw-user-s3-key-modal/rgw-user-s3-key-modal.component';
    import { RgwUserSubuserModalComponent } from '../rgw-user-subuser-modal/rgw-user-subuser-modal.component';
    import { RgwUserSwiftKeyModalComponent } from '../rgw-user-swift-key-modal/rgw-user-swift-key-modal.component';

    @Component({
      selector: 'cd-rgw-user-form',
      template: require('./rgw-user-form.component.html'),
      styles: []
    })
    export class RgwUserFormComponent implements OnInit {
      userForm: CdFormGroup;
      editing = false;
      error = false;
      loading = false;
      submitObservables: Observable<Object>[] = [];

      subusers: RgwUserSubuser[] = [];
      s3Keys: RgwUserS3Key[] = [];
      swiftKeys: RgwUserSwiftKey[] = [];
      capabilities: RgwUserCapability[] = [];

      action: string;
      resource: string;
      subuserLabel: string;
      s3keyLabel: string;
      capabilityLabel: string;

      constructor(
        private formBuilder: CdFormBuilder,
        private route: ActivatedRoute,
        private router: Router,
        private rgwUserService: RgwUserService,
        private bsModalService: BsModalService,
        private notificationService: NotificationService,
        private i18n: I18n,
        public actionLabels: ActionLabelsI18n
      ) {
        this.resource = this.i18n('user');
        this.subuserLabel = this.i18n('subuser');
        this.s3keyLabel = this.i18n('S3 Key');
        this.capabilityLabel = this.i18n('capability');
        this.createForm();
        this.listenToChanges();
      }

      createForm() {
        this.userForm = this.formBuilder.group({
          // General
          uid: [
            null,
            [Validators.required],
            [CdValidators.unique(this.rgwUserService.exists, this.rgwUserService)]
          ],
          display_name: [null, [Validators.required]],
          email: [
            null,
            [CdValidators.email],
            [CdValidators.unique(this.rgwUserService.emailExists, this.rgwUserService)]
          ],
          max_buckets: [1000, [Validators.required, Validators.min(0)]],
          suspended: [false],
          // S3 key
          generate_key: [true],
          access_key: [null, [CdValidators.requiredIf({ generate_key: false })]],
          secret_key: [null, [CdValidators.requiredIf({ generate_key: false })]],
          // User quota
          user_quota_enabled: [false],
          user_quota_max_size_unlimited: [true],
          user_quota_max_size: [
            null,
            [
              CdValidators.requiredIf({
                user_quota_enabled: true,
                user_quota_max_size_unlimited: false
              }),
              this.quotaMaxSizeValidator
            ]
          ],
          user_quota_max_objects_unlimited: [true],
          user_quota_max_objects: [
            null,
            [
              Validators.min(0),
              CdValidators.requiredIf({
                user_quota_enabled: true,
                user_quota_max_objects_unlimited: false
              })
            ]
          ],
          // Bucket quota
          bucket_quota_enabled: [false],
          bucket_quota_max_size_unlimited: [true],
          bucket_quota_max_size: [
            null,
            [
              CdValidators.requiredIf({
                bucket_quota_enabled: true,
                bucket_quota_max_size_unlimited: false
              }),
              this.quotaMaxSizeValidator
            ]
          ],
          bucket_quota_max_objects_unlimited: [true],
          bucket_quota_max_objects: [
            null,
            [
              Validators.min(0),
              CdValidators.requiredIf({
                bucket_quota_enabled: true,
                bucket_quota_max_objects_unlimited: false
              })
            ]
          ]
        });
      }

      listenToChanges() {
        // Reset the validation status of various controls, especially those that are using
        // the 'requiredIf' validator. This is necessary because the controls itself are not
        // validated again if the status of their prerequisites have been changed.
        this.userForm.get('generate_key').valueChanges.subscribe(() => {
          ['access_key', 'secret_key'].forEach((path) => {
            this.userForm.get(path).updateValueAndValidity({ onlySelf: true });
          });
        });
        this.userForm.get('user_quota_enabled').valueChanges.subscribe(() => {
          ['user_quota_max_size', 'user_quota_max_objects'].forEach((path) => {
            this.userForm.get(path).updateValueAndValidity({ onlySelf: true });
          });
        });
        this.userForm.get('user_quota_max_size_unlimited').valueChanges.subscribe(() => {
          this.userForm.get('user_quota_max_size').updateValueAndValidity({ onlySelf: true });
        });
        this.userForm.get('user_quota_max_objects_unlimited').valueChanges.subscribe(() => {
          this.userForm.get('user_quota_max_objects').updateValueAndValidity({ onlySelf: true });
        });
        this.userForm.get('bucket_quota_enabled').valueChanges.subscribe(() => {
          ['bucket_quota_max_size', 'bucket_quota_max_objects'].forEach((path) => {
            this.userForm.get(path).updateValueAndValidity({ onlySelf: true });
          });
        });
        this.userForm.get('bucket_quota_max_size_unlimited').valueChanges.subscribe(() => {
          this.userForm.get('bucket_quota_max_size').updateValueAndValidity({ onlySelf: true });
        });
        this.userForm.get('bucket_quota_max_objects_unlimited').valueChanges.subscribe(() => {
          this.userForm.get('bucket_quota_max_objects').updateValueAndValidity({ onlySelf: true });
        });
      }

      ngOnInit() {
        this.editing = this.router.url.startsWith(`/rgw/user/${URLVerbs.EDIT}`);
        this.action = this.editing ? this.actionLabels.EDIT : this.actionLabels.CREATE;
        // Process route parameters.
        this.route.params.subscribe((params: { uid: string }) => {
          if (!params.hasOwnProperty('uid')) {
            return;
          }
          const uid = decodeURIComponent(params.uid);
          this.loading = true;
          // Load the user and quota information.
          const observables = [];
          observables.push(this.rgwUserService.get(uid));
          observables.push(this.rgwUserService.getQuota(uid));
          observableForkJoin(observables).subscribe(
            (resp: any[]) => {
              this.loading = false;
              // Get the default values.
              const defaults = _.clone(this.userForm.value);
              // Extract the values displayed in the form.
              let value = _.pick(resp[0], _.keys(this.userForm.value));
              // Map the quota values.
              ['user', 'bucket'].forEach((type) => {
                const quota = resp[1][type + '_quota'];
                value[type + '_quota_enabled'] = quota.enabled;
                if (quota.max_size < 0) {
                  value[type + '_quota_max_size_unlimited'] = true;
                  value[type + '_quota_max_size'] = null;
                } else {
                  value[type + '_quota_max_size_unlimited'] = false;
                  value[type + '_quota_max_size'] = `${quota.max_size} B`;
                }
                if (quota.max_objects < 0) {
                  value[type + '_quota_max_objects_unlimited'] = true;
                  value[type + '_quota_max_objects'] = null;
                } else {
                  value[type + '_quota_max_objects_unlimited'] = false;
                  value[type + '_quota_max_objects'] = quota.max_objects;
                }
              });
              // Merge with default values.
              value = _.merge(defaults, value);
              // Update the form.
              this.userForm.setValue(value);

              // Get the sub users.
              this.subusers = resp[0].subusers;

              // Get the keys.
              this.s3Keys = resp[0].keys;
              this.swiftKeys = resp[0].swift_keys;

              // Process the capabilities.
              const mapPerm = { 'read, write': '*' };
              resp[0].caps.forEach((cap) => {
                if (cap.perm in mapPerm) {
                  cap.perm = mapPerm[cap.perm];
                }
              });
              this.capabilities = resp[0].caps;
            },
            (error) => {
              this.error = error;
            }
          );
        });
      }

      goToListView() {
        this.router.navigate(['/rgw/user']);
      }

      onSubmit() {
        let notificationTitle: string;
        // Exit immediately if the form isn't dirty.
        if (this.userForm.pristine) {
          this.goToListView();
          return;
        }
        const uid = this.userForm.getValue('uid');
        if (this.editing) {
          // Edit
          if (this._isGeneralDirty()) {
            const args = this._getUpdateArgs();
            this.submitObservables.push(this.rgwUserService.update(uid, args));
          }
          notificationTitle = this.i18n('Updated Object Gateway user "{{uid}}"', { uid: uid });
        } else {
          // Add
          const args = this._getCreateArgs();
          this.submitObservables.push(this.rgwUserService.create(args));
          notificationTitle = this.i18n('Created Object Gateway user "{{uid}}"', { uid: uid });
        }
        // Check if user quota has been modified.
        if (this._isUserQuotaDirty()) {
          const userQuotaArgs = this._getUserQuotaArgs();
          this.submitObservables.push(this.rgwUserService.updateQuota(uid, userQuotaArgs));
        }
        // Check if bucket quota has been modified.
        if (this._isBucketQuotaDirty()) {
          const bucketQuotaArgs = this._getBucketQuotaArgs();
          this.submitObservables.push(this.rgwUserService.updateQuota(uid, bucketQuotaArgs));
        }
        // Finally execute all observables.
        observableForkJoin(this.submitObservables).subscribe(
          () => {
            this.notificationService.show(NotificationType.success, notificationTitle);
            this.goToListView();
          },
          () => {
            // Reset the 'Submit' button.
            this.userForm.setErrors({ cdSubmitButton: true });
          }
        );
      }

      /**
       * Validate the quota maximum size, e.g. 1096, 1K, 30M. Only integer numbers are valid,
       * something like 1.9M is not recognized as valid.
       */
      quotaMaxSizeValidator(control: AbstractControl): ValidationErrors | null {
        if (isEmptyInputValue(control.value)) {
          return null;
        }
        const m = RegExp('^(\\d+)\\s*(B|K(B|iB)?|M(B|iB)?|G(B|iB)?|T(B|iB)?)?$', 'i').exec(
          control.value
        );
        if (m === null) {
          return { quotaMaxSize: true };
        }
        const bytes = new FormatterService().toBytes(control.value);
        return bytes < 1024 ? { quotaMaxSize: true } : null;
      }

      /**
       * Add/Update a subuser.
       */
      setSubuser(subuser: RgwUserSubuser, index?: number) {
        const mapPermissions = {
          'full-control': 'full',
          'read-write': 'readwrite'
        };
        const uid = this.userForm.getValue('uid');
        const args = {
          subuser: subuser.id,
          access:
            subuser.permissions in mapPermissions
              ? mapPermissions[subuser.permissions]
              : subuser.permissions,
          key_type: 'swift',
          secret_key: subuser.secret_key,
          generate_secret: subuser.generate_secret ? 'true' : 'false'
        };
        this.submitObservables.push(this.rgwUserService.createSubuser(uid, args));
        if (_.isNumber(index)) {
          // Modify
          // Create an observable to modify the subuser when the form is submitted.
          this.subusers[index] = subuser;
        } else {
          // Add
          // Create an observable to add the subuser when the form is submitted.
          this.subusers.push(subuser);
          // Add a Swift key. If the secret key is auto-generated, then visualize
          // this to the user by displaying a notification instead of the key.
          this.swiftKeys.push({
            user: subuser.id,
            secret_key: subuser.generate_secret ? 'Apply your changes first...' : subuser.secret_key
          });
        }
        // Mark the form as dirty to be able to submit it.
        this.userForm.markAsDirty();
      }

      /**
       * Delete a subuser.
       * @param {number} index The subuser to delete.
       */
      deleteSubuser(index: number) {
        const subuser = this.subusers[index];
        // Create an observable to delete the subuser when the form is submitted.
        this.submitObservables.push(
          this.rgwUserService.deleteSubuser(this.userForm.getValue('uid'), subuser.id)
        );
        // Remove the associated S3 keys.
        this.s3Keys = this.s3Keys.filter((key) => {
          return key.user !== subuser.id;
        });
        // Remove the associated Swift keys.
        this.swiftKeys = this.swiftKeys.filter((key) => {
          return key.user !== subuser.id;
        });
        // Remove the subuser to update the UI.
        this.subusers.splice(index, 1);
        // Mark the form as dirty to be able to submit it.
        this.userForm.markAsDirty();
      }

      /**
       * Add/Update a capability.
       */
      setCapability(cap: RgwUserCapability, index?: number) {
        const uid = this.userForm.getValue('uid');
        if (_.isNumber(index)) {
          // Modify
          const oldCap = this.capabilities[index];
          // Note, the RadosGW Admin OPS API does not support the modification of
          // user capabilities. Because of that it is necessary to delete it and
          // then to re-add the capability with its new value/permission.
          this.submitObservables.push(
            this.rgwUserService.deleteCapability(uid, oldCap.type, oldCap.perm)
          );
          this.submitObservables.push(this.rgwUserService.addCapability(uid, cap.type, cap.perm));
          this.capabilities[index] = cap;
        } else {
          // Add
          // Create an observable to add the capability when the form is submitted.
          this.submitObservables.push(this.rgwUserService.addCapability(uid, cap.type, cap.perm));
          this.capabilities.push(cap);
        }
        // Mark the form as dirty to be able to submit it.
        this.userForm.markAsDirty();
      }

      /**
       * Delete the given capability:
       * - Delete it from the local array to update the UI
       * - Create an observable that will be executed on form submit
       * @param {number} index The capability to delete.
       */
      deleteCapability(index: number) {
        const cap = this.capabilities[index];
        // Create an observable to delete the capability when the form is submitted.
        this.submitObservables.push(
          this.rgwUserService.deleteCapability(this.userForm.getValue('uid'), cap.type, cap.perm)
        );
        // Remove the capability to update the UI.
        this.capabilities.splice(index, 1);
        // Mark the form as dirty to be able to submit it.
        this.userForm.markAsDirty();
      }

      /**
       * Add/Update a S3 key.
       */
      setS3Key(key: RgwUserS3Key, index?: number) {
        if (_.isNumber(index)) {
          // Modify
          // Nothing to do here at the moment.
        } else {
          // Add
          // Split the key's user name into its user and subuser parts.
          const userMatches = key.user.match(/([^:]+)(:(.+))?/);
          // Create an observable to add the S3 key when the form is submitted.
          const uid = userMatches[1];
          const args = {
            subuser: userMatches[2] ? userMatches[3] : '',
            generate_key: key.generate_key ? 'true' : 'false',
            access_key: key.access_key,
            secret_key: key.secret_key
          };
          this.submitObservables.push(this.rgwUserService.addS3Key(uid, args));
          // If the access and the secret key are auto-generated, then visualize
          // this to the user by displaying a notification instead of the key.
          this.s3Keys.push({
            user: key.user,
            access_key: key.generate_key ? 'Apply your changes first...' : key.access_key,
            secret_key: key.generate_key ? 'Apply your changes first...' : key.secret_key
          });
        }
        // Mark the form as dirty to be able to submit it.
        this.userForm.markAsDirty();
      }

      /**
       * Delete a S3 key.
       * @param {number} index The S3 key to delete.
       */
      deleteS3Key(index: number) {
        const key = this.s3Keys[index];
        // Create an observable to delete the S3 key when the form is submitted.
        this.submitObservables.push(
          this.rgwUserService.deleteS3Key(this.userForm.getValue('uid'), key.access_key)
        );
        // Remove the S3 key to update the UI.
        this.s3Keys.splice(index, 1);
        // Mark the form as dirty to be able to submit it.
        this.userForm.markAsDirty();
      }

      /**
       * Show the specified subuser in a modal dialog.
       * @param {number | undefined} index The subuser to show.
       */
      showSubuserModal(index?: number) {
        const uid = this.userForm.getValue('uid');
        const modalRef = this.bsModalService.show(RgwUserSubuserModalComponent);
        if (_.isNumber(index)) {
          // Edit
          const subuser = this.subusers[index];
          modalRef.content.setEditing();
          modalRef.content.setValues(uid, subuser.id, subuser.permissions);
        } else {
          // Add
          modalRef.content.setEditing(false);
          modalRef.content.setValues(uid);
          modalRef.content.setSubusers(this.subusers);
        }
        modalRef.content.submitAction.subscribe((subuser: RgwUserSubuser) => {
          this.setSubuser(subuser, index);
        });
      }

      /**
       * Show the specified S3 key in a modal dialog.
       * @param {number | undefined} index The S3 key to show.
       */
      showS3KeyModal(index?: number) {
        const modalRef = this.bsModalService.show(RgwUserS3KeyModalComponent);
        if (_.isNumber(index)) {
          // View
          const key = this.s3Keys[index];
          modalRef.content.setViewing();
          modalRef.content.setValues(key.user, key.access_key, key.secret_key);
        } else {
          // Add
          const candidates = this._getS3KeyUserCandidates();
          modalRef.content.setViewing(false);
          modalRef.content.setUserCandidates(candidates);
          modalRef.content.submitAction.subscribe((key: RgwUserS3Key) => {
            this.setS3Key(key);
          });
        }
      }

      /**
       * Show the specified Swift key in a modal dialog.
       * @param {number} index The Swift key to show.
       */
      showSwiftKeyModal(index: number) {
        const modalRef = this.bsModalService.show(RgwUserSwiftKeyModalComponent);
        const key = this.swiftKeys[index];
        modalRef.content.setValues(key.user, key.secret_key);
      }

      /**
       * Show the specified capability in a modal dialog.
       * @param {number | undefined} index The S3 key to show.
       */
      showCapabilityModal(index?: number) {
        const modalRef = this.bsModalService.show(RgwUserCapabilityModalComponent);
        if (_.isNumber(index)) {
          // Edit
          const cap = this.capabilities[index];
          modalRef.content.setEditing();
          modalRef.content.setValues(cap.type, cap.perm);
        } else {
          // Add
          modalRef.content.setEditing(false);
          modalRef.content.setCapabilities(this.capabilities);
        }
        modalRef.content.submitAction.subscribe((cap: RgwUserCapability) => {
          this.setCapability(cap, index);
        });
      }

      /**
       * Check if the general user settings (display name, email, ...) have been modified.
       * @return {Boolean} Returns TRUE if the general user settings have been modified.
       */
      private _isGeneralDirty(): boolean {
        return ['display_name', 'email', 'max_buckets', 'suspended'].some((path) => {
          return this.userForm.get(path).dirty;
        });
      }

      /**
       * Check if the user quota has been modified.
       * @return {Boolean} Returns TRUE if the user quota has been modified.
       */
      private _isUserQuotaDirty(): boolean {
        return [
          'user_quota_enabled',
          'user_quota_max_size_unlimited',
          'user_quota_max_size',
          'user_quota_max_objects_unlimited',
          'user_quota_max_objects'
        ].some((path) => {
          return this.userForm.get(path).dirty;
        });
      }

      /**
       * Check if the bucket quota has been modified.
       * @return {Boolean} Returns TRUE if the bucket quota has been modified.
       */
      private _isBucketQuotaDirty(): boolean {
        return [
          'bucket_quota_enabled',
          'bucket_quota_max_size_unlimited',
          'bucket_quota_max_size',
          'bucket_quota_max_objects_unlimited',
          'bucket_quota_max_objects'
        ].some((path) => {
          return this.userForm.get(path).dirty;
        });
      }

      /**
       * Helper function to get the arguments of the API request when a new
       * user is created.
       */
      private _getCreateArgs() {
        const result = {
          uid: this.userForm.getValue('uid'),
          display_name: this.userForm.getValue('display_name'),
          suspended: this.userForm.getValue('suspended'),
          email: '',
          max_buckets: this.userForm.getValue('max_buckets'),
          generate_key: this.userForm.getValue('generate_key'),
          access_key: '',
          secret_key: ''
        };
        const email = this.userForm.getValue('email');
        if (_.isString(email) && email.length > 0) {
          _.merge(result, { email: email });
        }
        const generateKey = this.userForm.getValue('generate_key');
        if (!generateKey) {
          _.merge(result, {
            generate_key: false,
            access_key: this.userForm.getValue('access_key'),
            secret_key: this.userForm.getValue('secret_key')
          });
        }
        return result;
      }

      /**
       * Helper function to get the arguments for the API request when the user
       * configuration has been modified.
       */
      private _getUpdateArgs() {
        const result = {};
        const keys = ['display_name', 'email', 'max_buckets', 'suspended'];
        for (const key of keys) {
          result[key] = this.userForm.getValue(key);
        }
        return result;
      }

      /**
       * Helper function to get the arguments for the API request when the user
       * quota configuration has been modified.
       */
      private _getUserQuotaArgs(): object {
        const result = {
          quota_type: 'user',
          enabled: this.userForm.getValue('user_quota_enabled'),
          max_size_kb: -1,
          max_objects: -1
        };
        if (!this.userForm.getValue('user_quota_max_size_unlimited')) {
          // Convert the given value to bytes.
          const bytes = new FormatterService().toBytes(this.userForm.getValue('user_quota_max_size'));
          // Finally convert the value to KiB.
          result['max_size_kb'] = (bytes / 1024).toFixed(0) as any;
        }
        if (!this.userForm.getValue('user_quota_max_objects_unlimited')) {
          result['max_objects'] = this.userForm.getValue('user_quota_max_objects');
        }
        return result;
      }

      /**
       * Helper function to get the arguments for the API request when the bucket
       * quota configuration has been modified.
       */
      private _getBucketQuotaArgs(): object {
        const result = {
          quota_type: 'bucket',
          enabled: this.userForm.getValue('bucket_quota_enabled'),
          max_size_kb: -1,
          max_objects: -1
        };
        if (!this.userForm.getValue('bucket_quota_max_size_unlimited')) {
          // Convert the given value to bytes.
          const bytes = new FormatterService().toBytes(this.userForm.getValue('bucket_quota_max_size'));
          // Finally convert the value to KiB.
          result['max_size_kb'] = (bytes / 1024).toFixed(0) as any;
        }
        if (!this.userForm.getValue('bucket_quota_max_objects_unlimited')) {
          result['max_objects'] = this.userForm.getValue('bucket_quota_max_objects');
        }
        return result;
      }

      /**
       * Helper method to get the user candidates for S3 keys.
       * @returns {Array} Returns a list of user identifiers.
       */
      private _getS3KeyUserCandidates() {
        let result = [];
        // Add the current user id.
        const uid = this.userForm.getValue('uid');
        if (_.isString(uid) && !_.isEmpty(uid)) {
          result.push(uid);
        }
        // Append the subusers.
        this.subusers.forEach((subUser) => {
          result.push(subUser.id);
        });
        // Note that it's possible to create multiple S3 key pairs for a user,
        // thus we append already configured users, too.
        this.s3Keys.forEach((key) => {
          result.push(key.user);
        });
        result = _.uniq(result);
        return result;
      }
    }