From 1c88ea885113cb5ea82fdd691bfbe2014f213918 Mon Sep 17 00:00:00 2001
From: Aevann <randomname42029@gmail.com>
Date: Tue, 13 Feb 2024 15:00:58 +0200
Subject: [PATCH] add ping group description

---
 files/classes/group.py                        |  1 +
 files/routes/groups.py                        | 27 +++++++++++++++++++
 files/templates/group_memberships.html        | 25 +++++++++++++++++
 files/templates/groups.html                   |  6 +++++
 .../20240213-add-ping-group-description.sql   |  1 +
 5 files changed, 60 insertions(+)
 create mode 100644 migrations/20240213-add-ping-group-description.sql

diff --git a/files/classes/group.py b/files/classes/group.py
index a02a7eef9..4e34a1521 100644
--- a/files/classes/group.py
+++ b/files/classes/group.py
@@ -15,6 +15,7 @@ class Group(Base):
 	name = Column(String, primary_key=True)
 	created_utc = Column(Integer)
 	owner_id = Column(Integer, ForeignKey("users.id"))
+	description = Column(String)
 
 	memberships = relationship("GroupMembership", primaryjoin="GroupMembership.group_name==Group.name", order_by="GroupMembership.approved_utc")
 	owner = relationship("User", primaryjoin="Group.owner_id==User.id")
diff --git a/files/routes/groups.py b/files/routes/groups.py
index 324b4ab3c..5c2183c9a 100644
--- a/files/routes/groups.py
+++ b/files/routes/groups.py
@@ -333,3 +333,30 @@ def group_usurp(v, group_name):
 	g.db.add(group)
 
 	return {"message": f'You have usurped control of !{group.name} successfully!'}
+
+@app.post("/!<group_name>/description")
+@limiter.limit('1/second', scope=rpath)
+@limiter.limit('1/second', scope=rpath, key_func=get_ID)
+@limiter.limit(DEFAULT_RATELIMIT, deduct_when=lambda response: response.status_code < 400)
+@limiter.limit(DEFAULT_RATELIMIT, deduct_when=lambda response: response.status_code < 400, key_func=get_ID)
+@auth_required
+def group_change_description(v, group_name):
+	group_name = group_name.strip().lower()
+
+	group = g.db.get(Group, group_name)
+	if not group: abort(404)
+
+	if v.id != group.owner_id:
+		abort(403, f"Only the group owner (@{group.owner.username}) can change the description!")
+
+	description = request.values.get('description')
+
+	if description:
+		description = description.strip()
+	else:
+		description = None
+
+	group.description = description
+	g.db.add(group)
+
+	return {"message": 'Description changed successfully!'}
diff --git a/files/templates/group_memberships.html b/files/templates/group_memberships.html
index cc7005dd6..bcb9543dc 100644
--- a/files/templates/group_memberships.html
+++ b/files/templates/group_memberships.html
@@ -13,6 +13,31 @@
 		<button id="apply-{{group}}" type="button" class="mt-4 {% if v.id in group.membership_user_ids %}d-none{% endif %} btn btn-success btn-block" data-nonce="{{g.nonce}}" data-onclick="postToastSwitch(this,'/!{{group}}/apply','leave-{{group}}','apply-{{group}}','d-none')">{% if group.name != 'verifiedrich' %}Apply to {% endif %}Join</button>
 	{% endif %}
 
+	{% if v.id == group.owner_id %}
+		<h5 class="mt-5">!{{group}} Description</h3>
+		<form class="mt-3" action="/!{{group.name}}/description" method="post" data-nonce="{{g.nonce}}" data-onsubmit="sendFormXHR(this)">
+			<div class="container pb-0" style="background-color: transparent !important">
+				<div class="row">
+					<div class="col col-md-6 px-0 py-3 py-md-0">
+						<div class="body">
+							<input hidden name="formkey" value="{{v|formkey}}">
+							<input maxlength="100" class="form-control" type="text" name="description" {% if group.description %}value="{{group.description}}"{% endif %}>
+							<small>Limit of 100 characters</small>
+							<div class="footer">
+								<div class="d-flex">
+									<button type="submit" class="btn btn-primary ml-auto">Submit</button>
+								</div>
+							</div>
+						</div>
+					</div>
+				</div>
+			</div>
+		</form>
+	{% elif group.description %}
+		<h5 class="mt-5">!{{group}} Description</h3>
+		<p class="mb-2">{{group.description}}</p>
+	{% endif %}
+
 	<br>
 	{% macro process_memberships(memberships, name) %}
 		<h5 class="my-3">!{{group}} {{name}}</h5>
diff --git a/files/templates/groups.html b/files/templates/groups.html
index e9f62e1b8..1cccac400 100644
--- a/files/templates/groups.html
+++ b/files/templates/groups.html
@@ -33,6 +33,7 @@
 						<th>#</th>
 						<th>Name</th>
 						<th class="members">Members</th>
+						<th>Description</th>
 						<th>Created on</th>
 					</tr>
 				</thead>
@@ -56,6 +57,11 @@
 								<button id="apply-{{group}}" type="button" class="ml-3 ml-md-5 {% if v.id in group.membership_user_ids %}d-none{% endif %} btn btn-primary" data-nonce="{{g.nonce}}" data-onclick="postToastSwitch(this,'/!{{group}}/apply','leave-{{group}}','apply-{{group}}','d-none')">{% if group.name != 'verifiedrich' %}Apply to {% endif %}Join</button>
 							{% endif %}
 						</td>
+						<td>
+							{% if group.description %}
+								{{group.description}}
+							{% endif %}
+						</td>
 						<td data-time="{{group.created_utc}}"></td>
 					</tr>
 				{% endfor %}
diff --git a/migrations/20240213-add-ping-group-description.sql b/migrations/20240213-add-ping-group-description.sql
new file mode 100644
index 000000000..1b571536c
--- /dev/null
+++ b/migrations/20240213-add-ping-group-description.sql
@@ -0,0 +1 @@
+alter table groups add column description varchar(100) default '' not null;