Add or remove members from {{ groupname }} here. Hit the Apply button to save your changes.
-
Note that Groups must always have at least one member.
-
+
Other users
@@ -31,7 +29,7 @@
@@ -40,7 +38,7 @@
-
+
{{ groupname }}
@@ -61,7 +59,7 @@
@@ -70,17 +68,5 @@
-
-
-
-
-
{% endblock content %}
diff --git a/lumi2/usermanager.py b/lumi2/usermanager.py
index a8b1e10..7e22538 100644
--- a/lumi2/usermanager.py
+++ b/lumi2/usermanager.py
@@ -367,11 +367,11 @@ class GroupUpdateForm(FlaskForm):
)
-@bp.route("/groups/update/", methods=("GET", "POST"))
+@bp.route("/groups/update/")
def group_update(groupname: str):
"""Detail and Update view for a group.
- Shows a form allowing the modification of user memberships for this group.
+ Shows a table allowing the modification of user memberships for this group.
"""
try:
@@ -387,36 +387,10 @@ def group_update(groupname: str):
members = {user for user in group.members}
non_members = {user for user in ldap.get_users(conn)} - members
- form = GroupUpdateForm()
-
- if request.method == 'GET':
- form.updated_members.data = dumps([user.username for user in members])
- else:
- try:
- updated_usernames_list = loads(form.updated_members.data)
- except JSONDecodeError:
- abort(400)
- if not isinstance(updated_usernames_list, list):
- abort(400)
- updated_members = set()
- for username in updated_usernames_list:
- if not isinstance(username, str):
- abort(400)
- try:
- updated_members.add(ldap.get_user(conn, username))
- except ldap.EntryNotFoundException:
- abort(400)
- if not len(updated_members):
- abort(400)
- ldap.update_group(conn, Group(group.groupname, updated_members))
- flash(f"The Group '{group.groupname}' was updated.")
- # TODO redirect to group list view
- return redirect(url_for('usermanager.group_update', groupname=group.groupname))
conn.unbind()
return render_template(
'usermanager/group_edit.html',
- form=form,
groupname=group.groupname,
members=members,
non_members=non_members,
diff --git a/lumi2/webapi.py b/lumi2/webapi.py
index d54a029..090351e 100644
--- a/lumi2/webapi.py
+++ b/lumi2/webapi.py
@@ -1,10 +1,11 @@
-from json import JSONEncoder, JSONDecoder, loads, dumps
+from json import JSONEncoder, JSONDecoder, loads, dumps, JSONDecodeError
-from flask import Blueprint
+from flask import Blueprint, request
from flask_restful import Resource
import lumi2.ldap as ldap
from lumi2.usermodel import User, Group
+from lumi2.exceptions import InvalidStringFormatException
class UserEncoder(JSONEncoder):
@@ -57,8 +58,106 @@ class UserResource(Resource):
}
+def get_group_from_json(input_dict: dict) -> Group:
+ """Creates a Group object using the input dictionary.
+
+ The input must be a dictionary of the following format:
+
+ {
+ "group": {
+ "groupname": "mygroup",
+ "members": [
+ "alice",
+ "bob",
+ "carlie"
+ ]
+ }
+ }
+
+ Returns
+ -------
+ Group
+ The Group object equivalent to the input dict.
+
+ Raises
+ ------
+ TypeError
+ If the input is not of type dict.
+ json.JSONDecodeError
+ If the input string is not valid JSON.
+ lumi2.ldap.EntryNotFoundException
+ If any of the users listed as members do not exist.
+ ValueError
+ If the input string's format is incorrect, or if the list of Group
+ members is empty.
+ """
+
+ if not isinstance(input_dict, dict):
+ raise ValueError(f"Expected a dictionary but got: '{type(input_dict)}'.")
+ if len(input_dict) != 1 or 'group' not in input_dict.keys():
+ raise ValueError(f"Expected exactly one entry called 'group'.")
+
+ group_dict = input_dict['group']
+ if not isinstance(group_dict, dict):
+ raise ValueError(f"Expected a dictionary but got: '{type(group_dict)}'.")
+ if len(group_dict.keys()) != 2:
+ raise ValueError("Invalid number of keys in Group entry.")
+ for required_key in ['groupname', 'members']:
+ if required_key not in group_dict.keys():
+ raise ValueError(f"Expected a key called '{required_key}' in Group entry.")
+
+ groupname = group_dict['groupname']
+ if not isinstance(groupname, str):
+ raise ValueError("Expected the value for 'groupname' to be a string.")
+ try:
+ Group.assert_is_valid_groupname(groupname)
+ except InvalidStringFormatException as e:
+ raise ValueError(f"Invalid group name: {e}")
+
+ member_usernames = group_dict['members']
+ if not isinstance(member_usernames, list):
+ raise ValueError("Expected the value for 'members' to be a list.")
+ if not len(member_usernames):
+ raise ValueError("Group must have at least one member.")
+ members = set()
+ conn = ldap.get_connection()
+ for username in member_usernames:
+ if not isinstance(username, str):
+ raise ValueError("Member list may contain only strings.")
+ members.add(ldap.get_user(conn, username))
+
+ conn.unbind()
+ return Group(groupname, members)
+
+
class GroupResource(Resource):
- def get(self, groupname):
+ """The GroupResource represents a Group object in the REST API.
+
+ In JSON, a Group is represented as follows:
+ {
+ "groupname": "mygroup",
+ "members": [
+ "alice",
+ "bob",
+ "charlie"
+ ]
+ }
+ """
+
+ def get(self, groupname: str):
+ """Retrieves the group specified by the groupname as a JSON object.
+
+ Attributes
+ ----------
+ groupname : str
+ The name of the group to be retrieved.
+
+ Returns
+ -------
+ json : str , status : int
+ A JSON string and HTTP status code.
+ If the request was handled successfully,
+ """
try:
conn = ldap.get_connection()
except:
@@ -74,3 +173,96 @@ class GroupResource(Resource):
"members": [user.username for user in group.members],
}
}
+
+ def put(self, groupname):
+ try:
+ conn = ldap.get_connection()
+ except:
+ return 500
+ try:
+ # Make sure the requested group exists
+ group = ldap.get_group(conn, groupname)
+ except ldap.EntryNotFoundException:
+ conn.unbind()
+ return {"message": f"Group '{groupname}' does not exist."}, 400
+ try:
+ # Parse the JSON-submitted group
+ group = get_group_from_json(request.get_json())
+ except JSONDecodeError as e:
+ conn.unbind()
+ return {"message": f"Invalid JSON format: {e}"}, 400
+ except ValueError as e:
+ conn.unbind()
+ return {"message": f"Invalid string format: {e}"}, 400
+ except ldap.EntryNotFoundException as e:
+ conn.unbind()
+ return {"message": f"Entry not found: {e}"}
+ if not group.groupname == groupname:
+ conn.unbind()
+ return {"message": "Groupname mismatch between endpoint and submitted data."}
+
+ ldap.update_group(conn, group)
+ conn.unbind()
+ return {
+ "group": {
+ "groupname": group.groupname,
+ "members": [user.username for user in group.members],
+ }
+ }
+
+
+ def add_user_to_group(self, groupname):
+ """Accepts a PUT request to add a user to the specified Group.
+
+ The request data must be a JSON string of the following format:
+
+ {
+ "username": "my-user"
+ }
+
+ The user must exist on the server.
+ If the user is already a group member, no action is taken.
+ """
+
+ try:
+ conn = ldap.get_connection()
+ except:
+ return 500
+ try:
+ group = ldap.get_group(conn, groupname)
+ except ldap.EntryNotFoundException:
+ conn.unbind()
+ return {"message": f"Group '{groupname}' does not exist."}, 404
+
+ container_dict = request.get_json()
+ if not isinstance(container_dict, dict):
+ conn.unbind()
+ return {"message": "Invalid data: expected a JSON object."}, 400
+ if len(container_dict.keys()) != 1:
+ conn.unbind()
+ return {"message": "Invalid data: too many keys (expected 1)."}, 400
+ if not "username" in container_dict.keys():
+ conn.unbind()
+ return {"message": "Invalid data: no 'username' key found."}, 400
+ username = container_dict['username']
+ if not isinstance(username, str):
+ conn.unbind()
+ return {"message": "Invalid data: 'username' must be a string."}, 400
+ try:
+ User.assert_is_valid_username(username)
+ except InvalidStringFormatException as e:
+ conn.unbind()
+ return {"message": f"Invalid username: {e}"}, 400
+ try:
+ user = ldap.get_user(conn, username)
+ except ldap.EntryNotFoundException as e:
+ conn.unbind()
+ return {"message": f"User '{username}' does not exist."}, 400
+ if username in group.members:
+ conn.unbind()
+ return {"username": username}, 200
+
+ group.members.add(user)
+ ldap.update_group(conn, group)
+ conn.unbind()
+ return {"username": username}, 200