Surface "abandoned" state on projects in UI

readthedocs/projects/admin.py

@@ -11,13 +11,17 @@
 from django.contrib import admin, messages
 from django.contrib.admin.actions import delete_selected
 from django.utils.translation import ugettext_lazy as _
+from django.db.models import F, Value
+from django.db.models.functions import Concat
+from django.conf import settings
 from guardian.admin import GuardedModelAdmin
 
 from readthedocs.builds.models import Version
 from readthedocs.core.models import UserProfile
 from readthedocs.core.utils import broadcast
 from readthedocs.notifications.views import SendNotificationView
 from readthedocs.redirects.models import Redirect
+from readthedocs.core.utils import send_email
 
 from .forms import FeatureForm
 from .models import (
@@ -126,7 +130,12 @@ class ProjectAdmin(GuardedModelAdmin):
                VersionInline, DomainInline]
     readonly_fields = ('feature_flags',)
     raw_id_fields = ('users', 'main_language_project')
-    actions = ['send_owner_email', 'ban_owner']
+    actions = [
+        'send_owner_email',
+        'ban_owner',
+        'mark_as_abandoned',
+        'request_namespace',
+    ]
 
     def feature_flags(self, obj):
         return ', '.join([str(f.get_feature_display()) for f in obj.features])
@@ -177,6 +186,61 @@ def delete_selected_and_artifacts(self, request, queryset):
                 broadcast(type='app', task=remove_dir, args=[project.doc_path])
         return delete_selected(self, request, queryset)
 
+    def mark_as_abandoned(self, request, queryset):
+        """
+        Marks selected projects as abandoned.
+
+        It adds '-abandoned' to the slug, marks
+        Project.is_abandoned and sends an email to the user
+        notifying the change and link to the new project/docs
+        page.
+        """
+        # Change project's slug and mark it as abandoned.
+        queryset.update(
+            slug=Concat('slug', Value('-abandoned')),
+            is_abandoned=True
+        )
+
+        # Notifying users via email.
+        qs_iterator = queryset.iterator()
+        for project in qs_iterator:
+            users = project.users.get_queryset()
+            for user in users:
+                new_proj_url = '{}{}'.format(settings.PRODUCTION_DOMAIN, project.get_absolute_url())
+                send_email(
+                    recipient=user.email,
+                    subject='Project {} marked as abandoned'.format(project.name),
+                    template='projects/email/abandon_project_confirm.txt',
+                    template_html='projects/email/abandon_project_confirm.html',
+                    context={
+                        'proj_name': project.name,
+                        'proj_slug': project.slug,
+                        'proj_detail_url': new_proj_url,
+                    }
+                )
+            success_msg = 'Project {} is marked as abandoned'.format(project.name)
+            self.message_user(request, success_msg, level=messages.SUCCESS)
+
+    mark_as_abandoned.short_description = 'Mark as abandoned'
+
+    def request_namespace(self, request, queryset):
+        """Notify user that their project's namespace has been requested via email"""
+        qs_iterator = queryset.iterator()
+        for project in qs_iterator:
+            users = project.users.get_queryset()
+            for user in users:
+                send_email(
+                    recipient=user.email,
+                    subject='Rename request for abandoned project',
+                    template='projects/email/abandon_project.txt',
+                    template_html='projects/email/abandon_project.html',
+                    context={'proj_name': project.name}
+                )
+                success_msg = 'Email sent to {}'.format(user.email)
+                self.message_user(request, success_msg, level=messages.SUCCESS)
+
+    request_namespace.short_description = 'Request namespace'
+
     def get_actions(self, request):
         actions = super(ProjectAdmin, self).get_actions(request)
         actions['delete_selected'] = (

readthedocs/projects/migrations/0036_add_is_abandoned_field.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.16 on 2018-12-13 10:35
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('projects', '0035_container_time_limit_as_integer'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='project',
+            name='is_abandoned',
+            field=models.BooleanField(default=False, verbose_name='Is abandoned'),
+        ),
+    ]

readthedocs/projects/models.py

@@ -179,6 +179,7 @@ class Project(models.Model):
                     'Leave blank if you want us to find it for you.'))
 
     featured = models.BooleanField(_('Featured'), default=False)
+    is_abandoned = models.BooleanField(_('Is abandoned'), default=False)
     skip = models.BooleanField(_('Skip'), default=False)
     install_project = models.BooleanField(
         _('Install Project'),

readthedocs/rtd_tests/tests/projects/test_admin_actions.py

@@ -4,6 +4,8 @@
 from django.contrib.auth.models import User
 from django import urls
 from django.test import TestCase
+from django.conf import settings
+from django.contrib import messages
 
 from readthedocs.core.models import UserProfile
 from readthedocs.projects.models import Project
@@ -77,3 +79,64 @@ def test_project_delete(self, broadcast):
                 type='app', task=remove_dir, args=[self.project.doc_path]
             ),
         ])
+
+    @mock.patch('readthedocs.projects.admin.send_email')
+    def test_request_namespace(self, mock_send_email):
+        """Test the requesting of project's namespace"""
+        action_data = {
+            ACTION_CHECKBOX_NAME: [self.project.pk],
+            'action': 'request_namespace',
+        }
+        resp = self.client.post(
+            urls.reverse('admin:projects_project_changelist'),
+            action_data
+        )
+
+        proj = self.project
+        self.assertEqual(proj.users.get_queryset().count(), 1)
+        user = proj.users.get_queryset().first()
+
+        mock_send_email.assert_called_once_with(
+            recipient=user.email,
+            subject='Rename request for abandoned project', 
+            template='projects/email/abandon_project.txt', 
+            template_html='projects/email/abandon_project.html',
+            context={'proj_name': proj.name} 
+        )
+
+    @mock.patch('readthedocs.projects.admin.send_email')
+    def test_mark_as_abandoned(self, mock_send_email):
+        """Test the marking of project as abandoned"""
+        project = fixture.get(Project, users=[self.admin])
+        action_data = {
+            ACTION_CHECKBOX_NAME: [project.pk],
+            'action': 'mark_as_abandoned',
+        }
+
+        proj_old_slug = project.slug
+        self.assertEqual(project.users.get_queryset().count(), 1)
+        user = project.users.get_queryset().first()
+
+        resp = self.client.post(
+            urls.reverse('admin:projects_project_changelist'),
+            action_data,
+        )
+
+        project.refresh_from_db()
+        proj_new_slug = '{}-abandoned'.format(proj_old_slug)
+        self.assertEqual(project.get_absolute_url(), '/projects/{}/'.format(proj_new_slug))
+        proj_new_url = '{}{}'.format(settings.PRODUCTION_DOMAIN, project.get_absolute_url())
+
+        self.assertTrue(project.is_abandoned, True)
+        self.assertEqual(project.slug, proj_new_slug)
+        mock_send_email.assert_called_once_with(
+            recipient=user.email,
+            subject='Project {} marked as abandoned'.format(project.name),
+            template='projects/email/abandon_project_confirm.txt',
+            template_html='projects/email/abandon_project_confirm.html',
+            context={
+                'proj_name': project.name,
+                'proj_slug': proj_new_slug,
+                'proj_detail_url': proj_new_url,
+            }
+        )

readthedocs/templates/core/project_detail_right.html

@@ -4,6 +4,12 @@
 {% load gravatar %}
 {% load projects_tags %}
 
+{% block abandoned %}
+  {% if project.is_abandoned %}
+    <p class="notification">This project is abandoned.</p>
+  {% endif %}
+{% endblock %}
+
 {% block repo %}
   {% if project.repo %}
     <h3>{% trans "Repository" %}</h3>

readthedocs/templates/projects/email/abandon_project.html

@@ -0,0 +1,19 @@
+{% extends "core/email/common.html" %}
+
+{% block top-right %}
+  {{ proj_name }}
+{% endblock %}
+
+{% block content %}
+  <p>
+    We've had a request from one of our users for the project name {{ proj_name }} on Read the Docs. You are the current owner, and we wanted to reach out to you in accordance with our Abandoned Project policy (<a href="http://docs.readthedocs.io/en/latest/abandoned-projects.html">http://docs.readthedocs.io/en/latest/abandoned-projects.html</a>).
+  </p>
+
+  <p>
+    Since this is a fork of the existing owners project, {{ proj_name }}, you must show us the additional work that has been done in order to keep the new project name, that is different than the existing version of the project.
+  </p>
+
+  <p>
+    Please reply to this email either allowing or disallowing the transfer of the name on Read the Docs within 6 weeks, otherwise we will take the action of *initiating the transfer to a new owner* by default.
+  </p>
+{% endblock %}

readthedocs/templates/projects/email/abandon_project.txt

@@ -0,0 +1,6 @@
+{% extends "core/email/common.txt" %}
+{% block content %}
+We've had a request from one of our users for the project name {name} on Read the Docs. You are the current owner, and we wanted to reach out to you in accordance with our Abandoned Project policy (http://docs.readthedocs.io/en/latest/abandoned-projects.html).
+Since this is a fork of the existing owners project, {name}, you must show us the additional work that has been done in order to keep the new project name, that is different than the existing version of the project.
+Please reply to this email either allowing or disallowing the transfer of the name on Read the Docs within 6 weeks, otherwise we will take the action of *initiating the transfer to a new owner* by default.
+{% endblock %}

readthedocs/templates/projects/email/abandon_project_confirm.html

@@ -0,0 +1,15 @@
+{% extends "core/email/common.html" %}
+
+{% block top-right %}
+  {{ proj_name }}
+{% endblock %}
+
+{% block content %}
+  <p>
+    Your project {{ proj_name }} is marked as abandoned since you did not respond to the email sent earlier.
+  </p>
+
+  <p>
+    Link for the project is now <a href="{{ proj_detail_url }}">{{ proj_detail_url }}</a>.
+  </p>
+{% endblock %}

readthedocs/templates/projects/email/abandon_project_confirm.txt

@@ -0,0 +1,5 @@
+{% extends "core/email/common.txt" %}
+{% block content %}
+Your project {{ proj_name }} is marked as abandoned since you did not respond to the email sent earlier.
+Link for the project is now {{ proj_detail_url }}.
+{% endblock %}