feature to send abandoned project mail

Author: bansalnitish

readthedocs/projects/forms.py

@@ -114,7 +114,16 @@ def clean_name(self):
         name = self.cleaned_data.get('name', '')
         if not self.instance.pk:
             potential_slug = slugify(name)
-            if Project.objects.filter(slug=potential_slug).exists():
+            project_exist = Project.objects.filter(slug=potential_slug).exists()
+            if project_exist:
+                project = Project.objects.get(slug=potential_slug)
+                for user in project.users.all():
+                    if user.is_superuser:
+                        email = user.email
+                if project.is_abandoned:
+                    self.fields['abandon'] = forms.CharField(widget=forms.HiddenInput())
+                    self.fields['mail_id'] = forms.EmailField(initial=email, widget=forms.HiddenInput())
+                    self.fields['proj_name'] = forms.CharField(initial=name, widget=forms.HiddenInput())
                 raise forms.ValidationError(
                     _('Invalid project name, a project already exists with that name'))  # yapf: disable # noqa
         return name

readthedocs/projects/models.py

@@ -8,6 +8,7 @@
 import logging
 import os
 from builtins import object  # pylint: disable=redefined-builtin
+from datetime import datetime
 
 from django.conf import settings
 from django.contrib.auth.models import User
@@ -558,6 +559,22 @@ def conf_dir(self, version=LATEST):
         if conf_file:
             return os.path.dirname(conf_file)
 
+    @property
+    def is_abandoned(self):
+        """Is project abandoned."""
+        if self.has_good_build:
+            latest_build = self.get_latest_build()
+            if latest_build:
+                latest_build_date = latest_build.date
+                today = datetime.today()
+                diff = today - latest_build_date
+                # Latest build a year ago.
+                if diff > 365:
+                    return True
+                return False
+            return False
+        return True
+
     @property
     def is_type_sphinx(self):
         """Is project type Sphinx."""

readthedocs/projects/urls/private.py

@@ -103,6 +103,10 @@
     url(r'^(?P<project_slug>[-\w]+)/advertising/$',
         ProjectAdvertisingUpdate.as_view(),
         name='projects_advertising'),
+
+    url(r'^import/manual/send_mail/$',
+        private.send_mail,
+        name='send_mail'),
 ]
 
 domain_urls = [

readthedocs/projects/views/private.py

@@ -26,7 +26,7 @@
 from readthedocs.builds.forms import AliasForm, VersionForm
 from readthedocs.builds.models import Version, VersionAlias
 from readthedocs.core.mixins import ListViewWithForm, LoginRequiredMixin
-from readthedocs.core.utils import broadcast, trigger_build
+from readthedocs.core.utils import broadcast, trigger_build, send_email
 from readthedocs.integrations.models import HttpExchange, Integration
 from readthedocs.oauth.services import registry
 from readthedocs.oauth.utils import attach_webhook, update_webhook
@@ -264,6 +264,22 @@ def is_advanced(self):
         return data.get('advanced', True)
 
 
+def send_mail(request):
+    """Sends abandoned project email."""
+    email = request.POST.get('mail_id')
+    proj_name = request.POST.get('proj_name')
+    context = {'proj_name': proj_name}
+    subject = 'Rename request for abandoned project'
+    send_email(
+        recipient=email,
+        subject=subject,
+        template='projects/email/abandon_project.txt',
+        template_html='projects/email/abandon_project.html',
+        context=context)
+    messages.success(request, _('Mail sent!'))
+    return HttpResponseRedirect(request.META.get('HTTP_REFERER', '/'))
+
+
 class ImportDemoView(PrivateViewMixin, View):
 
     """View to pass request on to import form to import demo project."""

readthedocs/templates/projects/email/abandon_project.html

@@ -0,0 +1,13 @@
+{% extends "core/email/common.html" %}
+
+{% load i18n %}
+
+{% 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 (http://docs.readthedocs.io/en/latest/abandoned-projects.html).
+    </p>
+
+    <p>
+      Please reply at [email protected] 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,9 @@
+{% extends "core/email/common.txt" %}
+
+{% load i18n %}
+
+{% block content %}
+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 (http://docs.readthedocs.io/en/latest/abandoned-projects.html).
+
+Please reply at [email protected] 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/import_base.html

@@ -5,6 +5,13 @@
 
 {% block content %}
   <div class="module wizard wizard-project">
+    {% if wizard.form.fields.abandon %}
+      <form action="{% url "send_mail" %}" method="post">
+        {% csrf_token %}
+        <input type="hidden" name="mail_id" value="{{ wizard.form.fields.mail_id.initial }}">
+        <input type="hidden" name="proj_name" value="{{ wizard.form.fields.proj_name.initial }}">
+        <input type="submit" name="submit-btn" value="{% trans "Email project owner with our abandoned project email" %}">
+    {% endif %}
     <form action="{% url "projects_import_manual" %}" method="post">
 
       {% csrf_token %}