From 86146b80486e46827e1356c75e84fc85e01bd1e8 Mon Sep 17 00:00:00 2001
From: Johannes Meyer <johannes.meyer@netways.de>
Date: Tue, 26 May 2015 14:30:55 +0200
Subject: [PATCH] Introduce form AddMemberForm

refs #8826
---
 .../forms/Config/UserGroup/AddMemberForm.php  | 179 ++++++++++++++++++
 1 file changed, 179 insertions(+)
 create mode 100644 application/forms/Config/UserGroup/AddMemberForm.php

diff --git a/application/forms/Config/UserGroup/AddMemberForm.php b/application/forms/Config/UserGroup/AddMemberForm.php
new file mode 100644
index 000000000..6a57df3b4
--- /dev/null
+++ b/application/forms/Config/UserGroup/AddMemberForm.php
@@ -0,0 +1,179 @@
+<?php
+/* Icinga Web 2 | (c) 2013-2015 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Forms\Config\UserGroup;
+
+use Exception;
+use Icinga\Data\Extensible;
+use Icinga\Data\Filter\Filter;
+use Icinga\Data\Selectable;
+use Icinga\Web\Form;
+use Icinga\Web\Notification;
+
+/**
+ * Form for adding one or more group members
+ */
+class AddMemberForm extends Form
+{
+    /**
+     * The data source to fetch users from
+     *
+     * @var Selectable
+     */
+    protected $ds;
+
+    /**
+     * The user group backend to use
+     *
+     * @var Extensible
+     */
+    protected $backend;
+
+    /**
+     * The group to add members for
+     *
+     * @var string
+     */
+    protected $groupName;
+
+    /**
+     * Set the data source to fetch users from
+     *
+     * @param   Selectable  $ds
+     *
+     * @return  $this
+     */
+    public function setDataSource(Selectable $ds)
+    {
+        $this->ds = $ds;
+        return $this;
+    }
+
+    /**
+     * Set the user group backend to use
+     *
+     * @param   Extensible  $backend
+     *
+     * @return  $this
+     */
+    public function setBackend(Extensible $backend)
+    {
+        $this->backend = $backend;
+        return $this;
+    }
+
+    /**
+     * Set the group to add members for
+     *
+     * @param   string  $groupName
+     *
+     * @return  $this
+     */
+    public function setGroupName($groupName)
+    {
+        $this->groupName = $groupName;
+        return $this;
+    }
+
+    /**
+     * Create and add elements to this form
+     *
+     * @param   array   $formData   The data sent by the user
+     */
+    public function createElements(array $formData)
+    {
+        // TODO(jom): Fetching already existing members to prevent the user from mistakenly creating duplicate
+        // memberships (no matter whether the data source permits it or not, a member does never need to be
+        // added more than once) should be kept at backend level (GroupController::fetchUsers) but this does
+        // not work currently as our ldap protocol stuff is unable to handle our filter implementation..
+        $members = $this->backend
+            ->select()
+            ->from('group_membership', array('user_name'))
+            ->where('group_name', $this->groupName)
+            ->fetchColumn();
+        $filter = empty($members) ? Filter::matchAll() : Filter::not(Filter::where('user_name', $members));
+
+        $users = $this->ds->select()->from('user', array('user_name'))->applyFilter($filter)->fetchColumn();
+        if (! empty($users)) {
+            $this->addElement(
+                'multiselect',
+                'user_name',
+                array(
+                    'multiOptions'  => array_combine($users, $users),
+                    'label'         => $this->translate('Backend Users'),
+                    'description'   => $this->translate(
+                        'Select one or more users (fetched from your user backends) to add as group member'
+                    ),
+                    'class'         => 'grant-permissions'
+                )
+            );
+        }
+
+        $this->addElement(
+            'textarea',
+            'users',
+            array(
+                'required'      => empty($users),
+                'label'         => $this->translate('Users'),
+                'description'   => $this->translate(
+                    'Provide one or more usernames separated by comma to add as group member'
+                )
+            )
+        );
+
+        $this->setTitle(sprintf($this->translate('Add members for group %s'), $this->groupName));
+        $this->setSubmitLabel($this->translate('Add'));
+    }
+
+    /**
+     * Insert the members for the group
+     *
+     * @return  bool
+     */
+    public function onSuccess()
+    {
+        $userNames = $this->getValue('user_name') ?: array();
+        if (($users = $this->getValue('users'))) {
+            $userNames = array_merge($userNames, array_map('trim', explode(',', $users)));
+        }
+
+        if (empty($userNames)) {
+            $this->info($this->translate(
+                'Please provide at least one username, either by choosing one '
+                . 'in the list or by manually typing one in the text box below'
+            ));
+            return false;
+        }
+
+        $single = null;
+        foreach ($userNames as $userName) {
+            try {
+                $this->backend->insert(
+                    'group_membership',
+                    array(
+                        'group_name'    => $this->groupName,
+                        'user_name'     => $userName
+                    )
+                );
+            } catch (Exception $e) {
+                Notification::error(sprintf(
+                    $this->translate('Failed to add "%s" as group member for "%s"'),
+                    $userName,
+                    $this->groupName
+                ));
+                $this->error($e->getMessage());
+                return false;
+            }
+
+            $single = $single === null;
+        }
+
+        if ($single) {
+            Notification::success(sprintf($this->translate('Group member "%s" added successfully'), $userName));
+        } else {
+            Notification::success($this->translate('Group members added successfully'));
+        }
+
+        return true;
+    }
+}