Merge remote-tracking branch 'origin/master' into remove-doctype-from-search

Author: ericholscher

docs/conf.py

@@ -6,7 +6,6 @@
 import sys
 
 import sphinx_rtd_theme
-from recommonmark.parser import CommonMarkParser
 
 sys.path.insert(0, os.path.abspath('..'))
 sys.path.append(os.path.dirname(__file__))
@@ -29,13 +28,11 @@
     'doc_extensions',
     'sphinx_tabs.tabs',
     'sphinx-prompt',
+    'recommonmark',
 ]
 templates_path = ['_templates']
 
 source_suffix = ['.rst', '.md']
-source_parsers = {
-    '.md': CommonMarkParser,
-}
 
 master_doc = 'index'
 project = u'Read the Docs'

docs/faq.rst

@@ -233,7 +233,7 @@ We deploy readthedocs.org from the `rel` branch in our GitHub repository. You ca
 
 
 How can I avoid search results having a deprecated version of my docs?
----------------------------------------------------------------------
+----------------------------------------------------------------------
 
 If readers search something related to your docs in Google, it will probably return the most relevant version of your documentation.
 It may happen that this version is already deprecated and you want to stop Google indexing it as a result,

readthedocs/builds/views.py

@@ -3,6 +3,7 @@
 """Views for builds app."""
 
 import logging
+import textwrap
 
 from django.contrib import messages
 from django.contrib.auth.decorators import login_required
@@ -15,7 +16,10 @@
 from django.urls import reverse
 from django.utils.decorators import method_decorator
 from django.views.generic import DetailView, ListView
+from requests.utils import quote
+from urllib.parse import urlparse
 
+from readthedocs.doc_builder.exceptions import BuildEnvironmentError
 from readthedocs.builds.models import Build, Version
 from readthedocs.core.permissions import AdminPermission
 from readthedocs.core.utils import trigger_build
@@ -104,6 +108,49 @@ class BuildDetail(BuildBase, DetailView):
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         context['project'] = self.project
+
+        build = self.get_object()
+        if build.error != BuildEnvironmentError.GENERIC_WITH_BUILD_ID.format(build_id=build.pk):
+            # Do not suggest to open an issue if the error is not generic
+            return context
+
+        scheme = (
+            'https://github.com/rtfd/readthedocs.org/issues/new'
+            '?title={title}{build_id}'
+            '&body={body}'
+        )
+
+        # TODO: we could use ``.github/ISSUE_TEMPLATE.md`` here, but we would
+        # need to add some variables to it which could impact in the UX when
+        # filling an issue from the web
+        body = """
+        ## Details:
+
+        * Project URL: https://readthedocs.org/projects/{project_slug}/
+        * Build URL(if applicable): https://readthedocs.org{build_path}
+        * Read the Docs username(if applicable): {username}
+
+        ## Expected Result
+
+        *A description of what you wanted to happen*
+
+        ## Actual Result
+
+        *A description of what actually happened*""".format(
+            project_slug=self.project,
+            build_path=self.request.path,
+            username=self.request.user,
+        )
+
+        scheme_dict = {
+            'title': quote('Build error with build id #'),
+            'build_id': context['build'].id,
+            'body': quote(textwrap.dedent(body)),
+        }
+
+        issue_url = scheme.format(**scheme_dict)
+        issue_url = urlparse(issue_url).geturl()
+        context['issue_url'] = issue_url
         return context
 
 

readthedocs/core/symlink.py

@@ -152,10 +152,10 @@ def symlink_cnames(self, domain=None):
         if domain:
             domains = [domain]
         else:
-            domains = Domain.objects.filter(project=self.project)
+            domains = Domain.objects.filter(project=self.project).values_list('domain', flat=True)
         for dom in domains:
             log_msg = 'Symlinking CNAME: {} -> {}'.format(
-                dom.domain,
+                dom,
                 self.project.slug,
             )
             log.info(
@@ -167,13 +167,13 @@ def symlink_cnames(self, domain=None):
             )
 
             # CNAME to doc root
-            symlink = os.path.join(self.CNAME_ROOT, dom.domain)
+            symlink = os.path.join(self.CNAME_ROOT, dom)
             self.environment.run('ln', '-nsf', self.project_root, symlink)
 
             # Project symlink
             project_cname_symlink = os.path.join(
                 self.PROJECT_CNAME_ROOT,
-                dom.domain,
+                dom,
             )
             self.environment.run(
                 'ln',
@@ -183,16 +183,21 @@ def symlink_cnames(self, domain=None):
             )
 
     def remove_symlink_cname(self, domain):
-        """Remove CNAME symlink."""
-        log_msg = 'Removing symlink for CNAME {}'.format(domain.domain)
+        """
+        Remove CNAME symlink.
+
+        :param domain: domain for which symlink is to be removed
+        :type domain: str
+        """
+        log_msg = 'Removing symlink for CNAME {}'.format(domain)
         log.info(
             constants.LOG_TEMPLATE.format(
                 project=self.project.slug,
                 version='',
-                msg=log_msg,
+                msg=log_msg
             ),
         )
-        symlink = os.path.join(self.CNAME_ROOT, domain.domain)
+        symlink = os.path.join(self.CNAME_ROOT, domain)
         safe_unlink(symlink)
 
     def symlink_subprojects(self):

readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl

@@ -13,7 +13,6 @@
 # https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
 #
 
-from __future__ import absolute_import, division, print_function, unicode_literals
 
 import importlib
 import sys
@@ -82,9 +81,9 @@ context = {
         ("{{ slug }}", "{{ url }}"),{% endfor %}
     ],
     'slug': '{{ project.slug }}',
-    'name': '{{ project.name }}',
-    'rtd_language': '{{ project.language }}',
-    'programming_language': '{{ project.programming_language }}',
+    'name': u'{{ project.name }}',
+    'rtd_language': u'{{ project.language }}',
+    'programming_language': u'{{ project.programming_language }}',
     'canonical_url': '{{ project.get_canonical_url }}',
     'analytics_code': '{{ project.analytics_code }}',
     'single_version': {{ project.single_version }},

readthedocs/projects/forms.py

@@ -566,6 +566,14 @@ def save(self, commit=True):
         self.project.webhook_notifications.add(self.webhook)
         return self.project
 
+    def clean_url(self):
+        url = self.cleaned_data.get('url')
+        if not url:
+            raise forms.ValidationError(
+                _('This field is required.')
+            )
+        return url
+
     class Meta:
         model = WebHook
         fields = ['url']

readthedocs/projects/models.py

@@ -1199,15 +1199,15 @@ def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
         broadcast(
             type='app',
             task=tasks.symlink_domain,
-            args=[self.project.pk, self.pk],
+            args=[self.project.pk, self.domain],
         )
 
     def delete(self, *args, **kwargs):  # pylint: disable=arguments-differ
         from readthedocs.projects import tasks
         broadcast(
             type='app',
             task=tasks.symlink_domain,
-            args=[self.project.pk, self.pk, True],
+            args=[self.project.pk, self.domain, True],
         )
         super().delete(*args, **kwargs)
 

readthedocs/projects/notifications.py

@@ -2,9 +2,12 @@
 
 """Project notifications."""
 
+from django.urls import reverse
 from django.http import HttpRequest
+from django.utils.translation import ugettext_lazy as _
+from messages_extends.constants import ERROR_PERSISTENT
 
-from readthedocs.notifications import Notification
+from readthedocs.notifications import Notification, SiteNotification
 from readthedocs.notifications.constants import REQUIREMENT
 
 
@@ -16,6 +19,20 @@ class ResourceUsageNotification(Notification):
     level = REQUIREMENT
 
 
+class EmailConfirmNotification(SiteNotification):
+
+    failure_level = ERROR_PERSISTENT
+    failure_message = _(
+        'Your primary email address is not verified. '
+        'Please <a href="{{account_email_url}}">verify it here</a>.',
+    )
+
+    def get_context_data(self):
+        context = super(EmailConfirmNotification, self).get_context_data()
+        context.update({'account_email_url': reverse('account_email')})
+        return context
+
+
 class DeprecatedViewNotification(Notification):
 
     """Notification to alert user of a view that is going away."""

readthedocs/projects/tasks.py

@@ -1068,9 +1068,16 @@ def symlink_project(project_pk):
 
 
 @app.task(queue='web', throws=(BuildEnvironmentWarning,))
-def symlink_domain(project_pk, domain_pk, delete=False):
+def symlink_domain(project_pk, domain, delete=False):
+    """
+    Symlink domain.
+
+    :param project_pk: project's pk
+    :type project_pk: int
+    :param domain: domain for the symlink
+    :type domain: str
+    """
     project = Project.objects.get(pk=project_pk)
-    domain = Domain.objects.get(pk=domain_pk)
     for symlink in [PublicSymlink, PrivateSymlink]:
         sym = symlink(project=project)
         if delete:

readthedocs/projects/views/private.py

@@ -60,6 +60,7 @@
 )
 from readthedocs.projects.signals import project_import
 from readthedocs.projects.views.base import ProjectAdminMixin, ProjectSpamMixin
+from readthedocs.projects.notifications import EmailConfirmNotification
 
 from ..tasks import retry_domain_verification
 
@@ -78,9 +79,27 @@ class ProjectDashboard(PrivateViewMixin, ListView):
     model = Project
     template_name = 'projects/project_dashboard.html'
 
+    def validate_primary_email(self, user):
+        """
+        Sends a persistent error notification.
+
+        Checks if the user has a primary email or if the primary email
+        is verified or not. Sends a persistent error notification if
+        either of the condition is False.
+        """
+        email_qs = user.emailaddress_set.filter(primary=True)
+        email = email_qs.first()
+        if not email or not email.verified:
+            notification = EmailConfirmNotification(user=user, success=False)
+            notification.send()
+
     def get_queryset(self):
         return Project.objects.dashboard(self.request.user)
 
+    def get(self, request, *args, **kwargs):
+        self.validate_primary_email(request.user)
+        return super(ProjectDashboard, self).get(self, request, *args, **kwargs)
+
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
 
@@ -529,19 +548,18 @@ def project_notifications(request, project_slug):
         slug=project_slug,
     )
 
-    email_form = EmailHookForm(data=request.POST or None, project=project)
-    webhook_form = WebHookForm(data=request.POST or None, project=project)
+    email_form = EmailHookForm(data=None, project=project)
+    webhook_form = WebHookForm(data=None, project=project)
 
     if request.method == 'POST':
-        if email_form.is_valid():
-            email_form.save()
-        if webhook_form.is_valid():
-            webhook_form.save()
-        project_dashboard = reverse(
-            'projects_notifications',
-            args=[project.slug],
-        )
-        return HttpResponseRedirect(project_dashboard)
+        if 'email' in request.POST.keys():
+            email_form = EmailHookForm(data=request.POST, project=project)
+            if email_form.is_valid():
+                email_form.save()
+        elif 'url' in request.POST.keys():
+            webhook_form = WebHookForm(data=request.POST, project=project)
+            if webhook_form.is_valid():
+                webhook_form.save()
 
     emails = project.emailhook_notifications.all()
     urls = project.webhook_notifications.all()

readthedocs/rtd_tests/files/conf.py

@@ -13,7 +13,7 @@
             '.md': CommonMarkParser,
         }
 master_doc = 'index'
-project = 'Pip'
+project = u'Pip'
 copyright = str(datetime.now().year)
 version = '0.8.1'
 release = '0.8.1'
@@ -23,6 +23,6 @@
 html_theme = 'sphinx_rtd_theme'
 file_insertion_enabled = False
 latex_documents = [
-  ('index', 'pip.tex', 'Pip Documentation',
-   '', 'manual'),
+  ('index', 'pip.tex', u'Pip Documentation',
+   u'', 'manual'),
 ]

readthedocs/rtd_tests/tests/test_notifications.py

@@ -9,6 +9,7 @@
 from django.test import TestCase
 from django.test.utils import override_settings
 from messages_extends.models import Message as PersistentMessage
+from allauth.account.models import EmailAddress
 
 from readthedocs.builds.models import Build
 from readthedocs.notifications import Notification, SiteNotification
@@ -166,6 +167,9 @@ class TestNotification(SiteNotification):
             success_level = INFO_NON_PERSISTENT
 
         user = fixture.get(User)
+        # Setting the primary and verified email address of the user
+        email = fixture.get(EmailAddress, user=user, primary=True, verified=True)
+
         n = TestNotification(user, True)
         backend = SiteBackend(request=None)