views: manage users in patch attention list

* List view: show number of users interested in a specific patch
* Detail view: show a list of users who are interested in the patch
    * Allow users to add/remove interest in a patch
    * Allow managers to remove interested user from a patch

Signed-off-by: Victor Accarini <[email protected]>

Author: andrepapoti

htdocs/css/style.css

@@ -288,6 +288,18 @@ table.patch-meta tr th, table.patch-meta tr td {
     text-decoration: underline;
 }
 
+.patchinterest {
+    display: inline-block;
+    border-radius: 7px;
+    min-width: 0.9em;
+    padding: 0 2px;
+    text-align: center;
+}
+
+.patchinterest.exists {
+    background-color: #82ca9d;
+}
+
 .patchlistchecks {
     display: inline-block;
     border-radius: 7px;
@@ -344,6 +356,18 @@ table.patch-meta tr th, table.patch-meta tr td {
     font-family: "DejaVu Sans Mono", fixed;
 }
 
+.submission-attention-set {
+    display: flex;
+    flex-wrap: wrap;
+    align-items: center;
+    gap: 8px;
+}
+
+button[class*=interest-action] {
+    padding: 0.2em 0.5em;
+    border-radius: 4px;
+}
+
 div[class^="comment-status-bar-"] {
     display: flex;
     flex-wrap: wrap;

patchwork/forms.py

@@ -252,8 +252,27 @@ def save(self, instance, commit=True):
             if field.is_no_change(data[f.name]):
                 continue
 
+            if f.name == 'review_status':
+                if data[f.name]:
+                    self.instance.planning_to_review.add(self.user)
+                else:
+                    self.instance.planning_to_review.remove(self.user)
+                continue
+
             setattr(instance, f.name, data[f.name])
 
         if commit:
             instance.save()
         return instance
+
+    def review_status_only(self):
+        review_status_only = True
+        field_names = set(self.fields.keys())
+        field_names.discard({'review_status', 'action'})
+
+        for field_name in field_names:
+            data = self.data.get(field_name, '*')
+            if data != '*':
+                review_status_only = False
+
+        return review_status_only

patchwork/models.py

@@ -582,7 +582,7 @@ def save(self, *args, **kwargs):
 
         self.refresh_tag_counts()
 
-    def is_editable(self, user):
+    def is_editable(self, user, declare_interest_only=False):
         if not user.is_authenticated:
             return False
 
@@ -593,7 +593,8 @@ def is_editable(self, user):
         if self.project.is_editable(user):
             self._edited_by = user
             return True
-        return False
+
+        return declare_interest_only
 
     @staticmethod
     def filter_unique_checks(checks):

patchwork/templates/patchwork/partials/patch-list.html

@@ -80,6 +80,10 @@
           <span title="Success / Warning / Fail">S/W/F</span>
         </th>
 
+        <th>
+          <span title="Declared review interest">Review Interest</span>
+        </th>
+
         <th>
 {% if not order.editable %}
 {% if order.name == "date" %}
@@ -182,6 +186,7 @@
         </td>
         <td id="patch-tags:{{patch.id}}" class="text-nowrap">{{ patch|patch_tags }}</td>
         <td id="patch-checks:{{patch.id}}" class="text-nowrap">{{ patch|patch_checks }}</td>
+        <td id="patch-interest:{{patch.id}}" class="text-nowrap">{{ patch|patch_interest }}</td>
         <td id="patch-date:{{patch.id}}" class="text-nowrap">{{ patch.date|date:"Y-m-d" }}</td>
         <td id="patch-submitter:{{patch.id}}">{{ patch.submitter|personify:project }}</td>
         <td id="patch-delegate:{{patch.id}}">{{ patch.delegate.username }}</td>

patchwork/templates/patchwork/submission.html

@@ -187,6 +187,34 @@ <h2>Message</h2>
   </pre>
 </div>
 
+<div class="submission-attention-set">
+  <h2>Users pending actions</h2>
+  {% if user.is_authenticated and user not in attention_set %}
+  <form id="declare-review-form" method="post">
+    {% csrf_token %}
+    <input type="hidden" name="action" value="add-interest">
+    <button type="submit" class="btn-default interest-action-add">Declare interest</button>
+  </form>
+  {% endif %}
+</div>
+{% if attention_set %}
+  <ul>
+    {% for set_user in attention_set %}
+      <li>
+        <form id="declare-review-form" method="post">
+        {% csrf_token %}
+        <input type="hidden" name="action" value="remove-interest">
+          <input type="hidden" name="attention_set" value="{{set_user.id}}">
+        {{ set_user.username }} ({{ set_user.email }})
+        {% if set_user == user or is_maintainer %}
+            <button type="submit" class="btn-link"><span class="glyphicon glyphicon-trash" ></span></button>
+        {% endif %}
+        </form>
+      </li>
+    {% endfor %}
+  </ul>
+{% endif %}
+
 {% for item in comments %}
 {% if forloop.first %}
 <h2>Comments</h2>

patchwork/templatetags/patch.py

@@ -75,3 +75,18 @@ def patch_commit_display(patch):
     return mark_safe(
         '<a href="%s">%s</a>' % (escape(fmt.format(commit)), escape(commit))
     )
+
+
+@register.filter(name='patch_interest')
+def patch_interest(patch):
+    reviews = patch.attention_set.count()
+    review_title = (
+        f'has {reviews} interested reviewers'
+        if reviews > 0
+        else 'no interested reviewers'
+    )
+    review_class = 'exists' if reviews > 0 else ''
+    return mark_safe(
+        '<span class="patchinterest %s" title="%s">%s</span>'
+        % (review_class, review_title, reviews if reviews > 0 else '-')
+    )

patchwork/views/__init__.py

@@ -242,7 +242,9 @@ def generic_list(
         if data and data.get('form', '') == 'patch-list-form':
             data_tmp = data
 
-        properties_form = MultiplePatchForm(project, data=data_tmp)
+        properties_form = MultiplePatchForm(
+            project, data=data_tmp, user=request.user
+        )
         create_bundle_form = CreateBundleForm()
 
     if request.method == 'POST' and data.get('form') == 'patch-list-form':
@@ -344,7 +346,7 @@ def process_multiplepatch_form(request, form, action, patches, context):
 
     changed_patches = 0
     for patch in patches:
-        if not patch.is_editable(request.user):
+        if not patch.is_editable(request.user, form.review_status_only()):
             errors.append(
                 "You don't have permissions to edit patch '%s'" % patch.name
             )

patchwork/views/patch.py

@@ -4,6 +4,7 @@
 # SPDX-License-Identifier: GPL-2.0-or-later
 
 from django.contrib import messages
+from django.contrib.auth.models import User
 from django.http import Http404
 from django.http import HttpResponse
 from django.http import HttpResponseForbidden
@@ -16,6 +17,7 @@
 from patchwork.forms import PatchForm
 from patchwork.models import Cover
 from patchwork.models import Patch
+from patchwork.models import PatchAttentionSet
 from patchwork.models import Project
 from patchwork.views import generic_list
 from patchwork.views import set_bundle
@@ -61,6 +63,10 @@ def patch_detail(request, project_id, msgid):
 
     editable = patch.is_editable(request.user)
     context = {'project': patch.project}
+    is_maintainer = (
+        request.user.is_authenticated
+        and project in request.user.profile.maintainer_projects.all()
+    )
 
     form = None
     create_bundle_form = None
@@ -80,6 +86,50 @@ def patch_detail(request, project_id, msgid):
             errors = set_bundle(
                 request, project, action, request.POST, [patch]
             )
+        elif action in ['add-interest', 'remove-interest']:
+            if request.user.is_authenticated:
+                if action == 'add-interest':
+                    PatchAttentionSet.objects.get_or_create(
+                        patch=patch, user=request.user
+                    )
+                    message = (
+                        'You have declared interest in reviewing this patch'
+                    )
+                else:
+                    user_id = request.POST.get('attention_set')
+
+                    if is_maintainer or user_id == str(request.user.id):
+                        rm_user = User.objects.get(pk=user_id)
+                        PatchAttentionSet.objects.filter(
+                            patch=patch, user=rm_user
+                        ).delete()
+
+                        rm_user_name = (
+                            f"'{rm_user.username}'"
+                            if rm_user != request.user
+                            else 'yourself'
+                        )
+                        message = (
+                            f"You removed {rm_user_name} from patch's "
+                            'attention list'
+                        )
+
+                        patch.save()
+                        messages.success(
+                            request,
+                            message,
+                        )
+                    else:
+                        messages.error(
+                            request,
+                            "You can't remove another user interest in this "
+                            'patch',
+                        )
+            else:
+                messages.error(
+                    request,
+                    'You must be logged in to change the user attention list.',
+                )
 
         elif not editable:
             return HttpResponseForbidden()
@@ -93,6 +143,13 @@ def patch_detail(request, project_id, msgid):
     if request.user.is_authenticated:
         context['bundles'] = request.user.bundles.all()
 
+    attention_set = [
+        data.user for data in PatchAttentionSet.objects.filter(patch=patch)
+    ]
+
+    context['attention_set'] = attention_set
+    context['is_maintainer'] = is_maintainer
+
     comments = patch.comments.all()
     comments = comments.select_related('submitter')
     comments = comments.only(