Class List Method List File List

# Class: Yast::LdapPopupClass

Inherits:
  Module
  - Object
  - Module
  - Yast::LdapPopupClass
  show all
Defined in:
  ../../src/modules/LdapPopup.rb

## Instance Method Summary (collapse)

- - (Hash) AddDefaultValue(available, conflicts)

  Popup for adding new default value (default value is template's attribute).

- - (Object) BrowseTree(root_dn)

  Popup for browsing LDAP tree and selecting the DN WARNING we expect that LDAP connection is already correctly initialized ! given, the search for available bases will be done automatically.

- - (Array) EditAttribute(settings)

  Generic popup for editing attribute's value.

- - (Object) InitAndBrowseTree(root_dn, connection)

  Open the LDAP Browse popup and initialize initialize LDAP connection before.

- - (Object) main
- - (Hash) NewModule(available, conflicts)

  Popup for adding new configuration module.

## Instance Method Details

### - (`Hash`) AddDefaultValue(available, conflicts)

Popup for adding new default value (default value is template's attribute)

Parameters:

- conflicts (`Array`) —

  list of attributes already set

- available (`Array`) —

  list of possible attributes

Returns:

- (`Hash`) —

  of new “default value” (contains attribute name and value)

    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
    # File '../../src/modules/LdapPopup.rb', line 549

    def AddDefaultValue(available, conflicts)
      available = deep_copy(available)
      conflicts = deep_copy(conflicts)
      # help text 1/3
      help_text = _(
        "<p>Here, set the values of attributes belonging\n" +
          "to an object using the current template. Such values are used as defaults when\n" +
          "the new object is created.</p>\n"
      ) +
        # // help text 2/3 do not translate "defaultObjectClass"
        # _("<p>The list of attributes provided in <b>Attribute Name</b> is the
        # list of allowed attributes for objects described in the \"defaultObjectClass\"
        # entry of the current template.</p>
        # ") +

        # help text 3/3 do not translate "homedirectory"
        _(
          "<p>You can use special syntax to create attribute\n" +
            "values from existing ones. The expression <i>%attr_name</i> will be replaced\n" +
            "with the value of attribute \"attr_name\" (for example, use \"/home/%uid\"\n" +
            "as a value of \"homeDirectory\").</p>\n"
        )

      available = Builtins.filter(
        Convert.convert(available, :from => "list", :to => "list <string>")
      ) { |attr2| !Builtins.contains(conflicts, attr2) }

      UI.OpenDialog(
        Opt(:decorated),
        HBox(
          HSpacing(1),
          VBox(
            HSpacing(50),
            VSpacing(0.5),
            # combobox label
            Left(
              ComboBox(
                Id(:attr),
                Opt(:editable),
                _("Attribute &Name"),
                available
              )
            ),
            VSpacing(0.5),
            # textentry label
            InputField(Id(:val), Opt(:hstretch), _("Attribute &Value")),
            VSpacing(0.5),
            ButtonBox(
              PushButton(Id(:ok), Opt(:default, :key_F10), Label.OKButton),
              PushButton(Id(:cancel), Opt(:key_F9), Label.CancelButton),
              PushButton(Id(:help), Opt(:key_F2), Label.HelpButton)
            ),
            VSpacing(0.5)
          ),
          HSpacing(1)
        )
      )
      result = nil
      new_value = ""
      attr = ""

      UI.SetFocus(Id(:attr))
      while true
        result = UI.UserInput
        if result == :cancel
          new_value = ""
          break
        end
        Wizard.ShowHelp(help_text) if result == :help
        if result == :ok
          attr = Convert.to_string(UI.QueryWidget(Id(:attr), :Value))
          new_value = Convert.to_string(UI.QueryWidget(Id(:val), :Value))
          break
        end
      end
      UI.CloseDialog
      { "attr" => attr, "value" => new_value }
    end

### - (`Object`) BrowseTree(root_dn)

Popup for browsing LDAP tree and selecting the DN WARNING we expect that LDAP connection is already correctly initialized ! given, the search for available bases will be done automatically

Parameters:

- root_dn (`String`) —

  the starting point (root of tree); if empty string is

Returns:

- DN of selected item, empty string when canceled

    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
    # File '../../src/modules/LdapPopup.rb', line 49

    def BrowseTree(root_dn)
      # get display mode
      display_info = UI.GetDisplayInfo
      textmode = Ops.get_boolean(display_info, "TextMode", true)

      # map of already read subtrees
      dns = {}
      # selected DN (return value)
      current_dn = ""

      contents = HBox(
        VSpacing(20),
        VBox(
          HSpacing(70),
          VSpacing(0.2),
          HBox(
            HSpacing(),
            ReplacePoint(Id(:reptree), Tree(Id(:tree), root_dn, [])),
            HSpacing()
          ),
          textmode ?
            HBox(
              HSpacing(1.5),
              PushButton(Id(:ok), Opt(:key_F10), Label.OKButton),
              PushButton(Id(:cancel), Opt(:key_F9), Label.CancelButton),
              # button label
              Right(PushButton(Id(:open), Opt(:key_F6), _("&Open"))),
              HSpacing(1.5)
            ) :
            ButtonBox(
              PushButton(Id(:ok), Opt(:key_F10), Label.OKButton),
              PushButton(Id(:cancel), Opt(:key_F9), Label.CancelButton)
            ),
          VSpacing(0.2)
        )
      )

      UI.OpenDialog(Opt(:decorated), contents)

      items = []
      out = Convert.convert(
        SCR.Read(
          path(".ldap.search"),
          {
            "base_dn"      => root_dn,
            "scope"        => root_dn != "" ? 0 : 1,
            "dn_only"      => true,
            "not_found_ok" => true
          }
        ),
        :from => "any",
        :to   => "list <string>"
      )
      items = Builtins.maplist(out) do |dn|
        Ops.set(dns, dn, false)
        Item(dn, false, [])
      end if Ops.greater_than(
        Builtins.size(out),
        0
      )

      if Ops.greater_than(Builtins.size(items), 0)
        UI.ReplaceWidget(
          Id(:reptree),
          textmode ?
            Tree(Id(:tree), root_dn, items) :
            Tree(Id(:tree), Opt(:notify), root_dn, items)
        )
        # no item is selected
        UI.ChangeWidget(:tree, :CurrentItem, nil)
      elsif root_dn == ""
        bases = Convert.to_list(
          SCR.Read(
            path(".ldap.search"),
            { "base_dn" => "", "scope" => 0, "attrs" => ["namingContexts"] }
          )
        )
        if Ops.greater_than(Builtins.size(bases), 0)
          items = Builtins.maplist(
            Ops.get_list(bases, [0, "namingContexts"], [])
          ) { |dn| Item(dn, false, []) }
        end
        if Ops.greater_than(Builtins.size(items), 0)
          UI.ReplaceWidget(
            Id(:reptree),
            textmode ?
              Tree(Id(:tree), root_dn, items) :
              Tree(Id(:tree), Opt(:notify), root_dn, items)
          )
          UI.ChangeWidget(:tree, :CurrentItem, nil)
        end
      end

      UI.SetFocus(Id(:tree)) if textmode

      subdns = []
      open_items = {}

      update_items = lambda do |its|
        its = deep_copy(its)
        Builtins.maplist(its) do |it|
          dn = Ops.get_string(it, 0, "")
          next Item(dn, true, Builtins.maplist(subdns) { |k| Item(k, false, []) }) if dn == current_dn
          last = Ops.subtract(Builtins.size(it), 1)
          next deep_copy(it) if Builtins.size(Ops.get_list(it, last, [])) == 0
          # `OpenItems doesn't work in ncurses...
          open = Builtins.haskey(open_items, dn) && !textmode
          Item(dn, open, update_items.call(Ops.get_list(it, last, [])))
        end
      end

      retval = root_dn
      while true
        ret = UI.UserInput
        if ret == :tree || ret == :open
          current_dn = Convert.to_string(
            UI.QueryWidget(Id(:tree), :CurrentItem)
          )
          if !Ops.get(dns, current_dn, false)
            subdns = Convert.convert(
              SCR.Read(
                path(".ldap.search"),
                {
                  "base_dn"      => current_dn,
                  "scope"        => 1,
                  "dn_only"      => true,
                  "not_found_ok" => true
                }
              ),
              :from => "any",
              :to   => "list <string>"
            )
            Ops.set(dns, current_dn, true)
            if Ops.greater_than(Builtins.size(subdns), 0)
              open_items = Convert.to_map(UI.QueryWidget(:tree, :OpenItems))
              items = update_items.call(items)
              UI.ReplaceWidget(
                Id(:reptree),
                textmode ?
                  Tree(Id(:tree), root_dn, items) :
                  Tree(Id(:tree), Opt(:notify), root_dn, items)
              )
              UI.ChangeWidget(Id(:tree), :CurrentItem, current_dn)
              open_items = {}
            end
          end
          UI.SetFocus(Id(:tree)) if textmode
        end
        if ret == :cancel
          retval = ""
          break
        end
        if ret == :ok
          dn = Convert.to_string(UI.QueryWidget(Id(:tree), :CurrentItem))
          if dn != nil
            retval = dn
          else
            retval = current_dn
          end
          break
        end
      end
      UI.CloseDialog
      retval
    end

### - (`Array`) EditAttribute(settings)

Generic popup for editing attribute's value

Parameters:

- map —

  with settings, it could have these keys: "attr" attribute name "value" current attribute values "conflicts" list of forbidden values (e.g. existing 'cn' values) "single" if attribute can have only one value "offer" list of possible values for current attribute (e.g. existing groups for "secondaryGroup" attribute) "browse" if Browse LDAP Tree widget should be provided for choosing DN

Returns:

- (`Array`) —

  of atrtibute values (edited or unchanged)

    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
    # File '../../src/modules/LdapPopup.rb', line 252

    def EditAttribute(settings)
      settings = deep_copy(settings)
      attr = Ops.get_string(settings, "attr", "")
      value = Ops.get_list(settings, "value", [])
      conflicts = Ops.get_list(settings, "conflicts", [])
      offer = Ops.get_list(settings, "offer", [])
      single = Ops.get_boolean(settings, "single", false)
      browse = Ops.get_boolean(settings, "browse", false)

      # help text 1/3
      help_text = _("<p>Set the new value for the current attribute.</p>") +
        # help text 2/3
        _(
          "<p>If the attribute can have more values, add new entries\n" +
            "with <b>Add Value</b>. Sometimes the button contains the list of\n" +
            "possible values to use for the current attribute.\n" +
            "If the value of the edited attribute should be a distinguished name (DN),\n" +
            "it is possible to choose it from the LDAP tree using <b>Browse</b>.\n" +
            "</p>\n"
        )

      desc = Ldap.AttributeDescription(attr)

      if desc != ""
        # help text 3/3, %1 is attribute name, description follows.
        # The description will be not translated: maybe add a note
        # "available only in english" to the sentence for other languages?
        # Example:
        # "<p>The description of attribute \"%1\"<br>(available only in english):</p>"
        # or:
        # "<p>The description (only in english) of attribute \"%1\":<br></p>"
        help_text = Ops.add(
          Ops.add(
            help_text,
            Builtins.sformat(
              _("<p>The description of attribute \"%1\":<br></p>"),
              attr
            )
          ),
          Builtins.sformat("<p><i>%1</i></p>", desc)
        )
      end

      org_value = deep_copy(value)
      value_size = Builtins.size(value)

      # horizontal size of popup for
      hsize = Ops.add(Builtins.size(Ops.get(value, 0, "")), 10)

      # Helper for creating items for EditAttribute Popup
      generate_value_list = lambda do
        ret = VBox()
        if single
          ret = Builtins.add(
            ret,
            InputField(
              Id(0),
              Opt(:hstretch),
              # textentry label
              Builtins.sformat(_("&Value of \"%1\" Attribute"), attr),
              Ops.get(value, 0, "")
            )
          )
        else
          ret = Builtins.add(
            ret,
            InputField(
              Id(0),
              Opt(:hstretch),
              # textentry label
              Builtins.sformat(_("&Values of \"%1\" Attribute"), attr),
              Ops.get(value, 0, "")
            )
          )
          i = 1
          while Ops.less_than(i, value_size)
            ret = Builtins.add(
              ret,
              InputField(Id(i), Opt(:hstretch), "", Ops.get(value, i, ""))
            )
            if Ops.greater_than(
                Builtins.size(Ops.add(Ops.get(value, i, ""), 10)),
                hsize
              )
              hsize = Ops.add(Builtins.size(Ops.get(value, i, "")), 10)
            end
            i = Ops.add(i, 1)
          end
        end
        deep_copy(ret)
      end

      values = generate_value_list.call
      # button label
      add_button = PushButton(Id(:new), Opt(:key_F3), _("&Add Value"))

      if Ops.greater_than(Builtins.size(offer), 0) || browse
        # menubutton item (default value)
        mb = [Item(Id(:new), _("&Empty Entry"))]
        mb = Builtins.add(mb, Item(Id(:browse), _("Bro&wse"))) if browse
        Builtins.foreach(
          Convert.convert(offer, :from => "list", :to => "list <string>")
        ) { |it| mb = Builtins.add(mb, Item(Id(it), it)) }
        # button label
        add_button = MenuButton(Id(:mb), Opt(:key_F3), _("&Add Value"), mb)
      end

      UI.OpenDialog(
        Opt(:decorated),
        HBox(
          HSpacing(1),
          VBox(
            HSpacing(Ops.greater_than(hsize, 50) ? hsize : 50),
            ReplacePoint(Id(:rp), values),
            single ?
              ButtonBox(
                PushButton(Id(:ok), Opt(:default, :key_F10), Label.OKButton),
                PushButton(Id(:cancel), Opt(:key_F9), Label.CancelButton),
                PushButton(Id(:help), Opt(:key_F2), Label.HelpButton)
              ) :
              ButtonBox(
                PushButton(Id(:ok), Opt(:default, :key_F10), Label.OKButton),
                PushButton(Id(:cancel), Opt(:key_F9), Label.CancelButton),
                PushButton(Id(:help), Opt(:key_F2), Label.HelpButton),
                add_button
              )
          ),
          HSpacing(1)
        )
      )
      result = nil
      new_value = []

      value_size = 1 if value_size == 0
      UI.SetFocus(Id(Ops.subtract(value_size, 1)))
      while true
        result = UI.UserInput
        if result == :cancel
          new_value = deep_copy(org_value)
          break
        end
        Wizard.ShowHelp(help_text) if result == :help
        if result == :new || Builtins.contains(offer, result) ||
            result == :browse
          j = 0
          value = []
          while Ops.less_than(j, value_size)
            value = Builtins.add(
              value,
              Convert.to_string(UI.QueryWidget(Id(j), :Value))
            )
            j = Ops.add(j, 1)
          end
          if Builtins.contains(offer, result) &&
              Ops.get(value, Ops.subtract(value_size, 1), "") == ""
            # relace last empty entry
            Ops.set(
              value,
              Ops.subtract(value_size, 1),
              Convert.to_string(result)
            )
          elsif result == :browse
            Ops.set(value, Ops.subtract(value_size, 1), BrowseTree(""))
          else
            # add new entry
            value = Builtins.add(
              value,
              result == :new ? "" : Convert.to_string(result)
            )
            value_size = Ops.add(value_size, 1)
          end
          UI.ReplaceWidget(Id(:rp), generate_value_list.call)
          UI.SetFocus(Id(Ops.subtract(value_size, 1)))
        end
        if result == :ok
          j = 0
          duplicate = false
          new_value = []
          while Ops.less_than(j, value_size) && !duplicate
            v = Convert.to_string(UI.QueryWidget(Id(j), :Value))
            if !Builtins.contains(org_value, v) &&
                Builtins.contains(conflicts, v)
              #error popup
              Popup.Error(
                Builtins.sformat(
                  _(
                    "The value '%1' already exists.\nPlease select another one."
                  ),
                  v
                )
              )
              duplicate = true
            end
            new_value = Builtins.add(new_value, v) if v != ""
            j = Ops.add(j, 1)
          end
          next if duplicate
          break
        end
      end
      UI.CloseDialog
      deep_copy(new_value)
    end

### - (`Object`) InitAndBrowseTree(root_dn, connection)

Open the LDAP Browse popup and initialize initialize LDAP connection before. (see ldap agent '.ldap' Execute call documentation) given, the search for available bases will be done automatically

Parameters:

- connection (`Hash`) —

  init map with information passed to ldap agent

- root_dn (`String`) —

  the starting point (root of tree); if empty string is

Returns:

- DN of selected item, empty string when canceled

    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    # File '../../src/modules/LdapPopup.rb', line 222

    def InitAndBrowseTree(root_dn, connection)
      connection = deep_copy(connection)
      args = Ops.greater_than(Builtins.size(connection), 0) ?
        connection :
        {
          "hostname"   => Ldap.GetFirstServer(Ldap.server),
          "port"       => Ldap.GetFirstPort(Ldap.server),
          "use_tls"    => Ldap.ldap_tls ? "yes" : "no",
          "cacertdir"  => Ldap.tls_cacertdir,
          "cacertfile" => Ldap.tls_cacertfile
        }
      error = Ldap.LDAPInitWithTLSCheck(args)
      if error != ""
        Ldap.LDAPErrorMessage("init", error)
        return root_dn
      end
      BrowseTree(root_dn)
    end

### - (`Object`) main

    34
    35
    36
    37
    38
    39
    40
    41
    42
    # File '../../src/modules/LdapPopup.rb', line 34

    def main
      Yast.import "UI"
      textdomain "ldap-client"

      Yast.import "Ldap"
      Yast.import "Label"
      Yast.import "Popup"
      Yast.import "Wizard"
    end

### - (`Hash`) NewModule(available, conflicts)

Popup for adding new configuration module

Parameters:

- conflicts (`Array`) —

  list of forbidden names ('cn' values)

- available (`Array`) —

  list of possible object classes for new module

Returns:

- (`Hash`) —

  of new module (contains its name and object class)

    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
    # File '../../src/modules/LdapPopup.rb', line 460

    def NewModule(available, conflicts)
      available = deep_copy(available)
      conflicts = deep_copy(conflicts)
      descriptions = {
        # description of configuration object
        "suseuserconfiguration"  => _(
          "Configuration of user management tools"
        ),
        # description of configuration object
        "susegroupconfiguration" => _(
          "Configuration of group management tools"
        )
      }
      # label
      r_buttons = VBox(Left(Label(_("Object Class of New Module"))))
      Builtins.foreach(
        Convert.convert(available, :from => "list", :to => "list <string>")
      ) do |class2|
        desc = class2
        if Ops.get_string(descriptions, class2, "") != ""
          desc = Builtins.sformat(
            "%1 (%2)",
            class2,
            Ops.get_string(descriptions, class2, "")
          )
        end
        r_buttons = Builtins.add(
          r_buttons,
          Left(RadioButton(Id(class2), desc, true))
        )
      end
      UI.OpenDialog(
        Opt(:decorated),
        HBox(
          HSpacing(1),
          VBox(
            HSpacing(50),
            RadioButtonGroup(Id(:rb), r_buttons),
            InputField(
              Id(:cn),
              Opt(:hstretch),
              # textentry label, do not translate "cn"
              _("&Name of New Module (\"cn\" Value)")
            ),
            ButtonBox(
              PushButton(Id(:ok), Opt(:default, :key_F10), Label.OKButton),
              PushButton(Id(:cancel), Opt(:key_F9), Label.CancelButton)
            )
          ),
          HSpacing(1)
        )
      )
      result = nil
      new_value = ""
      _class = ""

      UI.SetFocus(Id(:cn))
      while true
        result = UI.UserInput
        if result == :cancel
          new_value = ""
          break
        end
        if result == :ok
          new_value = Convert.to_string(UI.QueryWidget(Id(:cn), :Value))
          if Builtins.contains(conflicts, new_value)
            #error popup
            Popup.Error(
              _("The entered value already exists.\nSelect another one.\n")
            )
            next
          end
          if new_value == ""
            #error popup
            Popup.Error(_("Enter the module name."))
            next
          end
          _class = Convert.to_string(UI.QueryWidget(Id(:rb), :CurrentButton))
          break
        end
      end
      UI.CloseDialog
      { "class" => _class, "cn" => new_value }
    end