From 2ec9e8af06fc44659b407c960cd161938e63d66f Mon Sep 17 00:00:00 2001
From: DonnieBLT <128622481+DonnieBLT@users.noreply.github.com>
Date: Mon, 24 Feb 2025 00:13:40 -0500
Subject: [PATCH 1/4] Implement referral code system with leaderboard

Related to #3697

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/OWASP-BLT/BLT/issues/3697?shareId=XXXX-XXXX-XXXX-XXXX).
---
 website/models.py                             | 11 ++++++
 .../includes/_leaderboard_widget.html         |  2 ++
 website/templates/leaderboard_eachmonth.html  |  2 ++
 website/templates/leaderboard_global.html     | 35 +++++++++++++++++++
 website/views/user.py                         |  2 ++
 5 files changed, 52 insertions(+)

diff --git a/website/models.py b/website/models.py
index b9f758c43..a746f94fd 100644
--- a/website/models.py
+++ b/website/models.py
@@ -632,6 +632,14 @@ class InviteFriend(models.Model):
     def __str__(self):
         return f"Invite from {self.sender}"
 
+    def increment_referral_clicks(self):
+        self.sender.userprofile.referral_clicks += 1
+        self.sender.userprofile.save()
+
+    def increment_referral_signups(self):
+        self.sender.userprofile.referral_signups += 1
+        self.sender.userprofile.save()
+
 
 def user_images_path(instance, filename):
     from django.template.defaultfilters import slugify
@@ -706,6 +714,9 @@ def check_team_membership(self):
     longest_streak = models.IntegerField(default=0)
     last_check_in = models.DateField(null=True, blank=True)
 
+    referral_clicks = models.PositiveIntegerField(default=0)
+    referral_signups = models.PositiveIntegerField(default=0)
+
     def avatar(self, size=36):
         if self.user_avatar:
             return self.user_avatar.url
diff --git a/website/templates/includes/_leaderboard_widget.html b/website/templates/includes/_leaderboard_widget.html
index 3f94914c3..8c3a0ccb4 100644
--- a/website/templates/includes/_leaderboard_widget.html
+++ b/website/templates/includes/_leaderboard_widget.html
@@ -136,6 +136,8 @@
                     {% endif %}
                 </a>
                 <span class="w-full overflow-clip font-semibold text-[#500000bd] text-[12px] mb-2">{{ leader.username }}</span>
+                <span class="w-full overflow-clip font-semibold text-[#500000bd] text-[12px] mb-2">Clicks: {{ leader.userprofile.referral_clicks }}</span>
+                <span class="w-full overflow-clip font-semibold text-[#500000bd] text-[12px] mb-2">Signups: {{ leader.userprofile.referral_signups }}</span>
                 <button type="button"
                         id="openModal-{{ leader.id }}"
                         class="btn btn-danger text-black"
diff --git a/website/templates/leaderboard_eachmonth.html b/website/templates/leaderboard_eachmonth.html
index befb83a04..3929dee1c 100644
--- a/website/templates/leaderboard_eachmonth.html
+++ b/website/templates/leaderboard_eachmonth.html
@@ -101,6 +101,8 @@ <h1 class="page-header">Monthly Leaderboard</h1>
                                     <span class="pull-right badge">${{ month.user.userprofile.winnings|default:""|floatformat }}</span>
                                 {% endif %}
                                 <span><kbd class="{{ month.user.userprofile.get_title_display }} titleuser">{{ month.user.userprofile.get_title_display }}</kbd></span>
+                                <span class="pull-right badge">Signups: {{ month.user.userprofile.referral_signups }}</span>
+                                <span class="pull-right badge">Clicks: {{ month.user.userprofile.referral_clicks }}</span>
                             {% endif %}
                         </div>
                     {% endfor %}
diff --git a/website/templates/leaderboard_global.html b/website/templates/leaderboard_global.html
index e63f4cc76..fa28d12b3 100644
--- a/website/templates/leaderboard_global.html
+++ b/website/templates/leaderboard_global.html
@@ -263,5 +263,40 @@ <h1 class="page-header">Global Leaderboard</h1>
                 {% endif %}
             </div>
         </div>
+        <div class="leaderboard-section">
+            <div class="leaderboard-title">Referral Leaderboard</div>
+            <div class="list-group">
+                {% if referral_leaderboard %}
+                    {% for leader in referral_leaderboard %}
+                        <div class="list-group-item">
+                            {% if leader.userprofile.avatar %}
+                                <img src="{{ leader.userprofile.avatar }}"
+                                     class="img-responsive img-thumbnail profileimage"
+                                     alt="{{ leader.username }}"
+                                     width="50px"
+                                     height="50px">
+                            {% elif leader.socialaccount_set.all.0.get_avatar_url %}
+                                <img src="{{ leader.socialaccount_set.all.0.get_avatar_url }}"
+                                     class="img-responsive img-thumbnail profileimage"
+                                     alt="username"
+                                     width="50px"
+                                     height="50px">
+                            {% else %}
+                                <img src="{% gravatar_url leader.email 50 %}"
+                                     class="img-responsive img-thumbnail profileimage"
+                                     alt="username"
+                                     width="50px"
+                                     height="50px">
+                            {% endif %}
+                            <a href="{% url 'profile' slug=leader.username %}">{{ leader.username }}</a>
+                            <span class="pull-right badge">{{ leader.userprofile.referral_signups }} Signups</span>
+                            <span class="pull-right badge">{{ leader.userprofile.referral_clicks }} Clicks</span>
+                        </div>
+                    {% endfor %}
+                {% else %}
+                    <p class="text-red-900">No referral data available</p>
+                {% endif %}
+            </div>
+        </div>
     </div>
 {% endblock content %}
diff --git a/website/views/user.py b/website/views/user.py
index 9bfb0c230..ec107f5e2 100644
--- a/website/views/user.py
+++ b/website/views/user.py
@@ -64,6 +64,7 @@ def handle_user_signup(request, user, **kwargs):
             invite = InviteFriend.objects.get(referral_code=referral_token)
             invite.recipients.add(user)
             invite.point_by_referral += 2
+            invite.increment_referral_signups()
             invite.save()
             reward_sender_with_points(invite.sender)
             del request.session["ref"]
@@ -727,6 +728,7 @@ def referral_signup(request):
     if referral_token:
         try:
             invite = InviteFriend.objects.get(referral_code=referral_token)
+            invite.increment_referral_clicks()
             request.session["ref"] = referral_token
         except InviteFriend.DoesNotExist:
             messages.error(request, "Invalid referral token")

From 313b48e9c63d1857e866a9775640732e80e8ac9d Mon Sep 17 00:00:00 2001
From: DonnieBLT <128622481+DonnieBLT@users.noreply.github.com>
Date: Mon, 24 Feb 2025 00:38:20 -0500
Subject: [PATCH 2/4]


From 1efb72c78fd17d1e2a8058351500d4d3912e6d7a Mon Sep 17 00:00:00 2001
From: DonnieBLT <128622481+DonnieBLT@users.noreply.github.com>
Date: Mon, 24 Feb 2025 00:54:19 -0500
Subject: [PATCH 3/4]


From 2124b54f428622dc82fb27856fb1f85a0a605287 Mon Sep 17 00:00:00 2001
From: DonnieBLT <128622481+DonnieBLT@users.noreply.github.com>
Date: Mon, 24 Feb 2025 00:54:54 -0500
Subject: [PATCH 4/4]

---
 .../migrations/0209_add_referral_fields.py    | 23 +++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 website/migrations/0209_add_referral_fields.py

diff --git a/website/migrations/0209_add_referral_fields.py b/website/migrations/0209_add_referral_fields.py
new file mode 100644
index 000000000..f1f966c5a
--- /dev/null
+++ b/website/migrations/0209_add_referral_fields.py
@@ -0,0 +1,23 @@
+# Generated by Django 3.2.7 on 2023-09-15 12:00
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('website', '0208_auto_20230915_1159'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='userprofile',
+            name='referral_clicks',
+            field=models.PositiveIntegerField(default=0),
+        ),
+        migrations.AddField(
+            model_name='userprofile',
+            name='referral_signups',
+            field=models.PositiveIntegerField(default=0),
+        ),
+    ]