Merge tag '2.8.4' into rel

Author: ericholscher

.codecov.yml

@@ -1,2 +1,5 @@
-comment:
-  layout: "diff, files"
+comment: off
+coverage:
+  status:
+    project: off
+

CHANGELOG.rst

@@ -1,3 +1,36 @@
+Version 2.8.4
+-------------
+
+:Date: December 17, 2018
+
+* `@davidfischer <http://github.com/davidfischer>`__: Tweak sidebar ad priority (`#5005 <https://github.com/rtfd/readthedocs.org/pull/5005>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Backport jquery 2432 to Read the Docs (`#5001 <https://github.com/rtfd/readthedocs.org/pull/5001>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Remove codecov comments and project coverage CI status (`#4996 <https://github.com/rtfd/readthedocs.org/pull/4996>`__)
+* `@stsewd <http://github.com/stsewd>`__: Remove `LOCAL_GIT_BRANCHES` from settings (`#4993 <https://github.com/rtfd/readthedocs.org/pull/4993>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Link update on FAQ page (`#4988 <https://github.com/rtfd/readthedocs.org/pull/4988>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Only use remote branches for our syncing. (`#4984 <https://github.com/rtfd/readthedocs.org/pull/4984>`__)
+* `@humitos <http://github.com/humitos>`__: Sanitize output and chunk it at DATA_UPLOAD_MAX_MEMORY_SIZE (`#4982 <https://github.com/rtfd/readthedocs.org/pull/4982>`__)
+* `@humitos <http://github.com/humitos>`__: Modify DB field for container_time_limit to be an integer (`#4979 <https://github.com/rtfd/readthedocs.org/pull/4979>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Remove deprecated imports from "urlresolvers" (`#4976 <https://github.com/rtfd/readthedocs.org/pull/4976>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Workaround for a django-storages bug (`#4963 <https://github.com/rtfd/readthedocs.org/pull/4963>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Release 2.8.3 (`#4961 <https://github.com/rtfd/readthedocs.org/pull/4961>`__)
+* `@monsij <http://github.com/monsij>`__: Remove -e option (`#4960 <https://github.com/rtfd/readthedocs.org/pull/4960>`__)
+* `@nutann3 <http://github.com/nutann3>`__: Update "install Sphinx" URL (`#4959 <https://github.com/rtfd/readthedocs.org/pull/4959>`__)
+* `@stsewd <http://github.com/stsewd>`__: Shallow git clone (`#4939 <https://github.com/rtfd/readthedocs.org/pull/4939>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Validate profile form fields (`#4910 <https://github.com/rtfd/readthedocs.org/pull/4910>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Calculate actual ad views (`#4885 <https://github.com/rtfd/readthedocs.org/pull/4885>`__)
+* `@humitos <http://github.com/humitos>`__: Allow all /api/v2/ CORS if the Domain is known (`#4880 <https://github.com/rtfd/readthedocs.org/pull/4880>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Disable django.security.DisallowedHost from logging (`#4879 <https://github.com/rtfd/readthedocs.org/pull/4879>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Remove 'Sphinx Template Changes' From Docs (`#4878 <https://github.com/rtfd/readthedocs.org/pull/4878>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Make form for adopting project a choice field (`#4841 <https://github.com/rtfd/readthedocs.org/pull/4841>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Add 'Branding' under the 'Business Info' section and 'Guidelines' on 'Design Docs' (`#4830 <https://github.com/rtfd/readthedocs.org/pull/4830>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Raise 404 at SubdomainMiddleware if the project does not exist. (`#4795 <https://github.com/rtfd/readthedocs.org/pull/4795>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Add help_text in the form for adopting a project (`#4781 <https://github.com/rtfd/readthedocs.org/pull/4781>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Remove /embed API endpoint (`#4771 <https://github.com/rtfd/readthedocs.org/pull/4771>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Improve unexpected error message when build fails (`#4754 <https://github.com/rtfd/readthedocs.org/pull/4754>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Change the way of using login_required decorator (`#4723 <https://github.com/rtfd/readthedocs.org/pull/4723>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Fix the form for adopting a project (`#4721 <https://github.com/rtfd/readthedocs.org/pull/4721>`__)
+
 Version 2.8.3
 -------------
 

docs/faq.rst

@@ -153,7 +153,7 @@ We think that our theme is badass, and better than the default for many reasons.
 I want to use the Read the Docs theme locally
 ---------------------------------------------
 
-There is a repository for that: https://github.com/snide/sphinx_rtd_theme.
+There is a repository for that: https://github.com/rtfd/sphinx_rtd_theme.
 Simply follow the instructions in the README.
 
 Image scaling doesn't work in my documentation

media/javascript/jquery/jquery-2.0.3.min.js

@@ -13,7 +13,7 @@
 
 from builtins import object
 from django.contrib.auth.decorators import login_required
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from django.http import (
     HttpResponseForbidden,
     HttpResponsePermanentRedirect,

media/javascript/jquery/jquery-2.0.3.min.js

@@ -9,7 +9,7 @@
 from django.contrib.sessions.middleware import SessionMiddleware
 from django.core.cache import cache
 from django.core.exceptions import MultipleObjectsReturned, ObjectDoesNotExist
-from django.core.urlresolvers import get_urlconf, set_urlconf
+from django.urls.base import get_urlconf, set_urlconf
 from django.http import Http404, HttpResponseBadRequest
 from django.utils.deprecation import MiddlewareMixin
 from django.utils.translation import ugettext_lazy as _

readthedocs/builds/views.py

@@ -13,6 +13,7 @@
 from django.db.models import Q, Count
 from django.dispatch import receiver
 from future.backports.urllib.parse import urlparse
+from rest_framework.permissions import SAFE_METHODS
 
 from readthedocs.oauth.models import RemoteOrganization
 from readthedocs.projects.models import Project, Domain
@@ -49,6 +50,12 @@ def decide_if_cors(sender, request, **kwargs):  # pylint: disable=unused-argumen
     if request.path_info.startswith('/api/v2/sustainability'):
         return True
 
+    # Don't do domain checking for APIv2 when the Domain is known
+    if request.path_info.startswith('/api/v2/') and request.method in SAFE_METHODS:
+        domain = Domain.objects.filter(domain__icontains=host)
+        if domain.exists():
+            return True
+
     valid_url = False
     for url in WHITELIST_URLS:
         if request.path_info.startswith(url):
@@ -69,7 +76,7 @@ def decide_if_cors(sender, request, **kwargs):  # pylint: disable=unused-argumen
 
         domain = Domain.objects.filter(
             Q(domain__icontains=host),
-            Q(project=project) | Q(project__subprojects__child=project)
+            Q(project=project) | Q(project__subprojects__child=project),
         )
         if domain.exists():
             return True

readthedocs/core/middleware.py

@@ -67,6 +67,9 @@ function create_sidebar_placement() {
         if (!offset || offset.top > $(window).height()) {
             // If this is off screen, lower the priority
             priority = constants.LOW_PROMO_PRIORITY;
+        } else if (bowser && !bowser.mobile) {
+            // If this isn't mobile, then the ad will be ATF, so raise the priority
+            priority = constants.MAXIMUM_PROMO_PRIORITY;
         }
 
         return {

readthedocs/core/signals.py

@@ -6,6 +6,7 @@
     absolute_import, division, print_function, unicode_literals)
 
 import logging
+import json
 import os
 import re
 import socket
@@ -186,6 +187,9 @@ def sanitize_output(self, output):
                avoid PostgreSQL db to fail:
                https://code.djangoproject.com/ticket/28201
 
+            3. Chunk at around ``DATA_UPLOAD_MAX_MEMORY_SIZE`` bytes to be sent
+               over the API call request
+
         :param output: stdout/stderr to be sanitized
         :type output: bytes
 
@@ -198,6 +202,25 @@ def sanitize_output(self, output):
             sanitized = sanitized.replace('\x00', '')
         except (TypeError, AttributeError):
             sanitized = None
+
+        # Chunk the output data to be less than ``DATA_UPLOAD_MAX_MEMORY_SIZE``
+        output_length = len(output) if output else 0
+        # Left some extra space for the rest of the request data
+        threshold = 512 * 1024  # 512Kb
+        allowed_length = settings.DATA_UPLOAD_MAX_MEMORY_SIZE - threshold
+        if output_length > allowed_length:
+            log.info(
+                'Command output is too big: project=[%s] version=[%s] build=[%s] command=[%s]',  # noqa
+                self.build_env.project.slug,
+                self.build_env.version.slug,
+                self.build_env.build.get('id'),
+                self.get_command(),
+            )
+            sanitized = sanitized[:allowed_length]
+            sanitized += '\n\n\nOutput is too big. Chunked at {} bytes'.format(
+                allowed_length,
+            )
+
         return sanitized
 
     def get_command(self):

readthedocs/core/static-src/core/js/doc-embed/sponsorship.js

@@ -2,13 +2,17 @@
 """Gold subscription views."""
 
 from __future__ import (
-    absolute_import, division, print_function, unicode_literals)
+    absolute_import,
+    division,
+    print_function,
+    unicode_literals
+)
 
 from django.conf import settings
 from django.contrib import messages
 from django.contrib.auth.decorators import login_required
 from django.contrib.messages.views import SuccessMessageMixin
-from django.core.urlresolvers import reverse, reverse_lazy
+from django.urls import reverse, reverse_lazy
 from django.http import HttpResponseRedirect
 from django.shortcuts import get_object_or_404, render
 from django.utils.translation import ugettext_lazy as _

readthedocs/core/static/core/js/readthedocs-doc-embed.js

@@ -2,7 +2,7 @@
 
 from __future__ import absolute_import
 from django.contrib import admin
-from django.core import urlresolvers
+from django import urls
 from django.utils.safestring import mark_safe
 from pygments.formatters import HtmlFormatter
 
@@ -96,7 +96,7 @@ def exchanges(self, obj):
         JSONField doesn't do well with fieldsets for whatever reason. This is
         just to link to the exchanges.
         """
-        url = urlresolvers.reverse('admin:{0}_{1}_changelist'.format(
+        url = urls.reverse('admin:{0}_{1}_changelist'.format(
             HttpExchange._meta.app_label,  # pylint: disable=protected-access
             HttpExchange._meta.model_name,  # pylint: disable=protected-access
         ))

readthedocs/doc_builder/environments.py

@@ -10,7 +10,7 @@
 from allauth.socialaccount.models import SocialAccount
 from django.conf import settings
 from django.contrib.auth.models import User
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from django.core.validators import URLValidator
 from django.db import models
 from django.db.models import Q

readthedocs/gold/views.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 from __future__ import division, print_function, unicode_literals
 
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from django.utils.translation import ugettext_lazy as _
 from messages_extends.constants import ERROR_PERSISTENT
 

readthedocs/integrations/admin.py

@@ -7,7 +7,7 @@
 import re
 
 from django.conf import settings
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from requests.exceptions import RequestException
 from allauth.socialaccount.providers.bitbucket_oauth2.views import (
     BitbucketOAuth2Adapter)

readthedocs/oauth/models.py

@@ -7,7 +7,7 @@
 import re
 
 from django.conf import settings
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from requests.exceptions import RequestException
 from allauth.socialaccount.models import SocialToken
 from allauth.socialaccount.providers.github.views import GitHubOAuth2Adapter

readthedocs/oauth/notifications.py

@@ -9,7 +9,7 @@
 
 from allauth.socialaccount.providers.gitlab.views import GitLabOAuth2Adapter
 from django.conf import settings
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from requests.exceptions import RequestException
 
 from readthedocs.builds.utils import get_gitlab_username_repo

readthedocs/oauth/services/bitbucket.py

@@ -12,7 +12,7 @@
 from django.contrib.auth import logout
 from django.contrib.auth.decorators import login_required
 from django.contrib.auth.models import User
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from django.http import HttpResponseRedirect
 from django.shortcuts import get_object_or_404, redirect, render
 from django.utils.translation import ugettext_lazy as _

readthedocs/oauth/services/github.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.16 on 2018-12-10 11:19
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('projects', '0034_remove_unused_project_model_fields'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='project',
+            name='container_time_limit',
+            field=models.IntegerField(blank=True, null=True, verbose_name='Container time limit in seconds'),
+        ),
+    ]

readthedocs/oauth/services/gitlab.py

@@ -11,7 +11,7 @@
 
 from django.conf import settings
 from django.contrib.auth.models import User
-from django.core.urlresolvers import NoReverseMatch, reverse
+from django.urls import NoReverseMatch, reverse
 from django.db import models
 from django.utils.encoding import python_2_unicode_compatible
 from django.utils.translation import ugettext_lazy as _
@@ -138,8 +138,11 @@ class Project(models.Model):
         _('Container memory limit'), max_length=10, null=True, blank=True,
         help_text=_('Memory limit in Docker format '
                     '-- example: <code>512m</code> or <code>1g</code>'))
-    container_time_limit = models.CharField(
-        _('Container time limit'), max_length=10, null=True, blank=True)
+    container_time_limit = models.IntegerField(
+        _('Container time limit in seconds'),
+        null=True,
+        blank=True,
+    )
     build_queue = models.CharField(
         _('Alternate build queue id'), max_length=32, null=True, blank=True)
     allow_promos = models.BooleanField(

readthedocs/profiles/views.py

@@ -26,7 +26,7 @@
 from builtins import str
 from celery.exceptions import SoftTimeLimitExceeded
 from django.conf import settings
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from django.db.models import Q
 from django.utils import timezone
 from django.utils.translation import ugettext_lazy as _

readthedocs/projects/migrations/0035_container_time_limit_as_integer.py

@@ -8,7 +8,7 @@
 from datetime import timedelta
 
 from django.conf import settings
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from django.http import HttpResponseRedirect
 from django.shortcuts import get_object_or_404
 from django.utils import timezone

readthedocs/projects/models.py

@@ -16,7 +16,7 @@
 from django.contrib import messages
 from django.contrib.auth.decorators import login_required
 from django.contrib.auth.models import User
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from django.http import (
     Http404,
     HttpResponseBadRequest,

readthedocs/projects/tasks.py

@@ -16,7 +16,7 @@
 from django.contrib import messages
 from django.contrib.auth.models import User
 from django.core.cache import cache
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from django.http import Http404, HttpResponse, HttpResponseRedirect
 from django.shortcuts import get_object_or_404, render
 from django.views.decorators.cache import never_cache

readthedocs/projects/views/base.py

@@ -9,7 +9,7 @@
 
 import logging
 
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from redis import ConnectionError
 from rest_framework import decorators, permissions
 from rest_framework.renderers import JSONRenderer

readthedocs/projects/views/private.py

@@ -2,7 +2,7 @@
 import django_dynamic_fixture as fixture
 from django.contrib.admin.helpers import ACTION_CHECKBOX_NAME
 from django.contrib.auth.models import User
-from django.core import urlresolvers
+from django import urls
 from django.test import TestCase
 
 from readthedocs.core.models import UserProfile
@@ -33,7 +33,7 @@ def test_project_ban_owner(self):
             'index': 0,
         }
         resp = self.client.post(
-            urlresolvers.reverse('admin:projects_project_changelist'),
+            urls.reverse('admin:projects_project_changelist'),
             action_data
         )
         self.assertTrue(self.project.users.filter(profile__banned=True).exists())
@@ -51,7 +51,7 @@ def test_project_ban_multiple_owners(self):
             'index': 0,
         }
         resp = self.client.post(
-            urlresolvers.reverse('admin:projects_project_changelist'),
+            urls.reverse('admin:projects_project_changelist'),
             action_data
         )
         self.assertFalse(self.project.users.filter(profile__banned=True).exists())
@@ -68,7 +68,7 @@ def test_project_delete(self, broadcast):
             'post': 'yes',
         }
         resp = self.client.post(
-            urlresolvers.reverse('admin:projects_project_changelist'),
+            urls.reverse('admin:projects_project_changelist'),
             action_data
         )
         self.assertFalse(Project.objects.filter(pk=self.project.pk).exists())

readthedocs/projects/views/public.py

@@ -14,7 +14,7 @@
 from allauth.socialaccount.models import SocialAccount
 from builtins import str
 from django.contrib.auth.models import User
-from django.core.urlresolvers import reverse
+from django.urls import reverse
 from django.http import QueryDict
 from django.test import TestCase
 from django.utils import six