|
| 1 | +from django.contrib import admin, messages |
| 2 | +from django.core.exceptions import PermissionDenied |
| 3 | +from django.shortcuts import redirect |
| 4 | +from django.template.response import TemplateResponse |
| 5 | +from django.urls import reverse |
| 6 | +from django.utils.safestring import mark_safe |
| 7 | + |
| 8 | +from reviews.models import ReviewSession, UserReview |
| 9 | +from reviews.services import ReviewSessionService, ReviewItemService, ReviewVoteService |
| 10 | + |
| 11 | + |
| 12 | +class ReviewSessionAdminMixin: |
| 13 | + """Mixin providing common review session admin functionality.""" |
| 14 | + |
| 15 | + def get_review_session_service( |
| 16 | + self, review_session: ReviewSession |
| 17 | + ) -> ReviewSessionService: |
| 18 | + """Get a service instance for the review session.""" |
| 19 | + return ReviewSessionService(review_session) |
| 20 | + |
| 21 | + def get_review_item_service( |
| 22 | + self, review_session: ReviewSession |
| 23 | + ) -> ReviewItemService: |
| 24 | + """Get an item service instance for the review session.""" |
| 25 | + return ReviewItemService(review_session) |
| 26 | + |
| 27 | + def get_review_vote_service( |
| 28 | + self, review_session: ReviewSession |
| 29 | + ) -> ReviewVoteService: |
| 30 | + """Get a vote service instance for the review session.""" |
| 31 | + return ReviewVoteService(review_session) |
| 32 | + |
| 33 | + @admin.display(description="Review Item Screen") |
| 34 | + def go_to_review_screen(self, obj): |
| 35 | + if not obj.id: |
| 36 | + return "" |
| 37 | + |
| 38 | + if not obj.can_review_items: |
| 39 | + return "You cannot review." |
| 40 | + |
| 41 | + return mark_safe( |
| 42 | + f""" |
| 43 | + <a href="{reverse("admin:reviews-start", kwargs={"review_session_id": obj.id})}"> |
| 44 | + Go to review screen |
| 45 | + </a> |
| 46 | +""" |
| 47 | + ) |
| 48 | + |
| 49 | + @admin.display(description="Recap Screen") |
| 50 | + def go_to_recap_screen(self, obj): |
| 51 | + if not obj.id: |
| 52 | + return "" |
| 53 | + |
| 54 | + if not obj.can_see_recap_screen: |
| 55 | + return "You cannot see the recap of this session yet." |
| 56 | + |
| 57 | + return mark_safe( |
| 58 | + f""" |
| 59 | + <a href="{reverse("admin:reviews-recap", kwargs={"review_session_id": obj.id})}"> |
| 60 | + Go to recap screen |
| 61 | + </a> |
| 62 | +""" |
| 63 | + ) |
| 64 | + |
| 65 | + |
| 66 | +class ReviewSessionViewMixin: |
| 67 | + """Mixin providing review session view functionality.""" |
| 68 | + |
| 69 | + def review_start_view(self, request, review_session_id): |
| 70 | + """Handle the review start view.""" |
| 71 | + review_session = ReviewSession.objects.get(id=review_session_id) |
| 72 | + service = self.get_review_session_service(review_session) |
| 73 | + |
| 74 | + next_to_review = service.get_next_item_to_review(request.user) |
| 75 | + |
| 76 | + if not next_to_review: |
| 77 | + messages.warning(request, "No new proposal to review.") |
| 78 | + return redirect( |
| 79 | + reverse( |
| 80 | + "admin:reviews-recap", |
| 81 | + kwargs={"review_session_id": review_session_id}, |
| 82 | + ) |
| 83 | + ) |
| 84 | + |
| 85 | + return redirect( |
| 86 | + reverse( |
| 87 | + "admin:reviews-vote-view", |
| 88 | + kwargs={ |
| 89 | + "review_session_id": review_session_id, |
| 90 | + "review_item_id": next_to_review, |
| 91 | + }, |
| 92 | + ) |
| 93 | + ) |
| 94 | + |
| 95 | + def review_recap_view(self, request, review_session_id): |
| 96 | + """Handle the review recap view.""" |
| 97 | + review_session = ReviewSession.objects.get(id=review_session_id) |
| 98 | + service = self.get_review_session_service(review_session) |
| 99 | + |
| 100 | + if not service.can_user_review(request.user): |
| 101 | + raise PermissionDenied() |
| 102 | + |
| 103 | + if not service.can_see_recap_screen(): |
| 104 | + messages.error(request, "You cannot see the recap of this session yet.") |
| 105 | + return redirect( |
| 106 | + reverse( |
| 107 | + "admin:reviews_reviewsession_change", |
| 108 | + kwargs={"object_id": review_session_id}, |
| 109 | + ) |
| 110 | + ) |
| 111 | + |
| 112 | + if request.method == "POST": |
| 113 | + service.process_review_decisions(request) |
| 114 | + return redirect( |
| 115 | + reverse( |
| 116 | + "admin:reviews-recap", |
| 117 | + kwargs={"review_session_id": review_session_id}, |
| 118 | + ) |
| 119 | + ) |
| 120 | + |
| 121 | + item_service = self.get_review_item_service(review_session) |
| 122 | + context = dict( |
| 123 | + self.admin_site.each_context(request), |
| 124 | + request=request, |
| 125 | + **service.get_recap_context_data(request), |
| 126 | + ) |
| 127 | + |
| 128 | + template_name = item_service.get_recap_template_name() |
| 129 | + return TemplateResponse(request, template_name, context) |
| 130 | + |
| 131 | + def review_view(self, request, review_session_id, review_item_id): |
| 132 | + """Handle the individual review view.""" |
| 133 | + review_session = ReviewSession.objects.get(id=review_session_id) |
| 134 | + service = self.get_review_session_service(review_session) |
| 135 | + |
| 136 | + if not service.can_user_review(request.user): |
| 137 | + raise PermissionDenied() |
| 138 | + |
| 139 | + if request.method == "GET": |
| 140 | + return self._handle_review_get_request( |
| 141 | + request, review_session, review_item_id |
| 142 | + ) |
| 143 | + elif request.method == "POST": |
| 144 | + return self._handle_review_post_request( |
| 145 | + request, review_session, review_item_id |
| 146 | + ) |
| 147 | + |
| 148 | + def _handle_review_get_request(self, request, review_session, review_item_id): |
| 149 | + """Handle GET request for review view.""" |
| 150 | + # Get existing user review if any |
| 151 | + filter_options = {} |
| 152 | + if review_session.is_proposals_review: |
| 153 | + filter_options["proposal_id"] = review_item_id |
| 154 | + elif review_session.is_grants_review: |
| 155 | + filter_options["grant_id"] = review_item_id |
| 156 | + |
| 157 | + user_review = UserReview.objects.filter( |
| 158 | + user_id=request.user.id, |
| 159 | + review_session_id=review_session.id, |
| 160 | + **filter_options, |
| 161 | + ).first() |
| 162 | + |
| 163 | + item_service = self.get_review_item_service(review_session) |
| 164 | + context = dict( |
| 165 | + self.admin_site.each_context(request), |
| 166 | + **item_service.get_item_context_data(request, review_item_id, user_review), |
| 167 | + ) |
| 168 | + |
| 169 | + template_name = item_service.get_review_template_name() |
| 170 | + return TemplateResponse(request, template_name, context) |
| 171 | + |
| 172 | + def _handle_review_post_request(self, request, review_session, review_item_id): |
| 173 | + """Handle POST request for review view.""" |
| 174 | + from reviews.admin import SubmitVoteForm |
| 175 | + |
| 176 | + form = SubmitVoteForm(request.POST) |
| 177 | + form.is_valid() |
| 178 | + |
| 179 | + vote_service = self.get_review_vote_service(review_session) |
| 180 | + next_to_review = vote_service.process_vote_submission( |
| 181 | + request, review_item_id, form.cleaned_data |
| 182 | + ) |
| 183 | + |
| 184 | + if next_to_review is None: |
| 185 | + # Error occurred, should have been handled by service |
| 186 | + return |
| 187 | + |
| 188 | + seen = [str(id_) for id_ in form.cleaned_data.get("seen", "").split(",") if id_] |
| 189 | + seen.append(str(review_item_id)) |
| 190 | + exclude = form.cleaned_data.get("exclude", []) |
| 191 | + |
| 192 | + if not next_to_review: |
| 193 | + messages.warning( |
| 194 | + request, "No new items to review, showing an already seen one." |
| 195 | + ) |
| 196 | + service = self.get_review_session_service(review_session) |
| 197 | + next_to_review = service.get_next_item_to_review( |
| 198 | + request.user, skip_item=review_item_id, exclude=exclude |
| 199 | + ) |
| 200 | + |
| 201 | + if not next_to_review: |
| 202 | + messages.warning(request, "No new proposal to review.") |
| 203 | + return redirect( |
| 204 | + reverse( |
| 205 | + "admin:reviews-recap", |
| 206 | + kwargs={"review_session_id": review_session.id}, |
| 207 | + ) |
| 208 | + ) |
| 209 | + |
| 210 | + return redirect( |
| 211 | + reverse( |
| 212 | + "admin:reviews-vote-view", |
| 213 | + kwargs={ |
| 214 | + "review_session_id": review_session.id, |
| 215 | + "review_item_id": next_to_review, |
| 216 | + }, |
| 217 | + ) |
| 218 | + + f"?exclude={','.join(map(str, exclude))}&seen={','.join(seen)}" |
| 219 | + ) |
0 commit comments