Skip to content

Commit 54e970b

Browse files
saadmk11saadmk11
authored
Merge branch 'master' into cleanup-sync_user-settings
2 parents 152355b + 2308f38 commit 54e970b

File tree

4 files changed

+72
-53
lines changed

4 files changed

+72
-53
lines changed

‎readthedocs/core/middleware.py

Lines changed: 29 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
log = logging.getLogger(__name__)
1616

17-
LOG_TEMPLATE = '(Middleware) {msg} [{host}{path}]'
17+
LOG_TEMPLATE = '(Middleware) %(msg)s [%(host)s%(path)s]'
1818

1919

2020
class SubdomainMiddleware(MiddlewareMixin):
@@ -73,10 +73,11 @@ def process_request(self, request):
7373
request.urlconf = settings.SUBDOMAIN_URLCONF
7474
request.domain_object = True
7575
log.debug(
76-
LOG_TEMPLATE.format(
77-
msg='Domain Object Detected: %s' % domain.domain,
76+
LOG_TEMPLATE,
77+
dict(
78+
{'msg': 'Domain Object Detected: %s' % 'domain'},
7879
**log_kwargs
79-
),
80+
)
8081
)
8182
break
8283
if (
@@ -87,28 +88,37 @@ def process_request(self, request):
8788
request.urlconf = settings.SUBDOMAIN_URLCONF
8889
request.rtdheader = True
8990
log.debug(
90-
LOG_TEMPLATE.format(
91-
msg='X-RTD-Slug header detected: %s' % request.slug,
91+
LOG_TEMPLATE,
92+
dict(
93+
{'msg': 'X-RTD-Slug header detected: %s' % request.slug},
9294
**log_kwargs
93-
),
95+
)
9496
)
9597
# Try header first, then DNS
9698
elif not hasattr(request, 'domain_object'):
9799
# Some person is CNAMEing to us without configuring a domain - 404.
98-
log.warning(LOG_TEMPLATE.format(msg='CNAME 404', **log_kwargs))
100+
log.warning(
101+
LOG_TEMPLATE,
102+
dict({'msg': 'CNAME 404'}, **log_kwargs)
103+
)
99104
return render(request, 'core/dns-404.html', context={'host': host}, status=404)
100105
# Google was finding crazy www.blah.readthedocs.org domains.
101106
# Block these explicitly after trying CNAME logic.
102107
if len(domain_parts) > 3 and not settings.DEBUG:
103108
# Stop www.fooo.readthedocs.org
104109
if domain_parts[0] == 'www':
105-
log.debug(LOG_TEMPLATE.format(
106-
msg='404ing long domain', **log_kwargs
107-
))
110+
log.debug(
111+
LOG_TEMPLATE,
112+
dict({'msg': '404ing long domain'}, **log_kwargs)
113+
)
108114
return HttpResponseBadRequest(_('Invalid hostname'))
109-
log.debug(LOG_TEMPLATE.format(
110-
msg='Allowing long domain name', **log_kwargs
111-
))
115+
log.debug(
116+
LOG_TEMPLATE,
117+
dict(
118+
{'msg': 'Allowing long domain name'},
119+
**log_kwargs
120+
)
121+
)
112122
# Normal request.
113123
return None
114124

@@ -166,8 +176,11 @@ def process_request(self, request):
166176
path = request.get_full_path()
167177
log_kwargs = dict(host=host, path=path)
168178
log.debug(
169-
LOG_TEMPLATE.
170-
format(msg='Handling single_version request', **log_kwargs),
179+
LOG_TEMPLATE,
180+
dict(
181+
{'msg': 'Handling single_version request'},
182+
**log_kwargs
183+
)
171184
)
172185

173186
return None

‎readthedocs/core/symlink.py

Lines changed: 36 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -97,11 +97,12 @@ def sanity_check(self):
9797
"""
9898
if os.path.islink(self.project_root) and not self.project.single_version:
9999
log.info(
100-
constants.LOG_TEMPLATE.format(
101-
project=self.project.slug,
102-
version='',
103-
msg='Removing single version symlink',
104-
),
100+
constants.LOG_TEMPLATE,
101+
{
102+
'project': self.project.slug,
103+
'version': '',
104+
'msg': 'Removing single version symlink',
105+
}
105106
)
106107
safe_unlink(self.project_root)
107108
safe_makedirs(self.project_root)
@@ -159,13 +160,13 @@ def symlink_cnames(self, domain=None):
159160
self.project.slug,
160161
)
161162
log.debug(
162-
constants.LOG_TEMPLATE.format(
163-
project=self.project.slug,
164-
version='',
165-
msg=log_msg,
166-
),
163+
constants.LOG_TEMPLATE,
164+
{
165+
'project': self.project.slug,
166+
'version': '',
167+
'msg': log_msg,
168+
}
167169
)
168-
169170
# CNAME to doc root
170171
symlink = os.path.join(self.CNAME_ROOT, dom)
171172
self.environment.run('ln', '-nsf', self.project_root, symlink)
@@ -191,11 +192,12 @@ def remove_symlink_cname(self, domain):
191192
"""
192193
log_msg = 'Removing symlink for CNAME {}'.format(domain)
193194
log.debug(
194-
constants.LOG_TEMPLATE.format(
195-
project=self.project.slug,
196-
version='',
197-
msg=log_msg
198-
),
195+
constants.LOG_TEMPLATE,
196+
{
197+
'project': self.project.slug,
198+
'version': '',
199+
'msg': log_msg,
200+
}
199201
)
200202
symlink = os.path.join(self.CNAME_ROOT, domain)
201203
safe_unlink(symlink)
@@ -226,11 +228,12 @@ def symlink_subprojects(self):
226228
to_slug,
227229
)
228230
log.debug(
229-
constants.LOG_TEMPLATE.format(
230-
project=self.project.slug,
231-
version='',
232-
msg=log_msg,
233-
),
231+
constants.LOG_TEMPLATE,
232+
{
233+
'project': self.project.slug,
234+
'version': '',
235+
'msg': log_msg,
236+
}
234237
)
235238
symlink = os.path.join(self.subproject_root, from_slug)
236239
docs_dir = os.path.join(
@@ -280,11 +283,12 @@ def symlink_translations(self):
280283

281284
log_msg = 'Symlinking translation: {}->{}'.format(language, slug)
282285
log.debug(
283-
constants.LOG_TEMPLATE.format(
284-
project=self.project.slug,
285-
version='',
286-
msg=log_msg,
287-
),
286+
constants.LOG_TEMPLATE,
287+
{
288+
'project': self.project.slug,
289+
'version': '',
290+
'msg': log_msg,
291+
}
288292
)
289293
symlink = os.path.join(self.project_root, language)
290294
docs_dir = os.path.join(self.WEB_ROOT, slug, language)
@@ -349,11 +353,12 @@ def symlink_versions(self):
349353
for version in version_queryset:
350354
log_msg = 'Symlinking Version: {}'.format(version)
351355
log.debug(
352-
constants.LOG_TEMPLATE.format(
353-
project=self.project.slug,
354-
version='',
355-
msg=log_msg,
356-
),
356+
constants.LOG_TEMPLATE,
357+
{
358+
'project': self.project.slug,
359+
'version': '',
360+
'msg': log_msg,
361+
}
357362
)
358363
symlink = os.path.join(version_dir, version.slug)
359364
docs_dir = os.path.join(

‎readthedocs/core/views/hooks.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,12 @@ def get_project_from_url(url):
119119

120120
def log_info(project, msg):
121121
log.info(
122-
constants.LOG_TEMPLATE.format(
123-
project=project,
124-
version='',
125-
msg=msg,
126-
),
122+
constants.LOG_TEMPLATE,
123+
{
124+
'project': project,
125+
'version': '',
126+
'msg': msg,
127+
}
127128
)
128129

129130

‎readthedocs/core/views/serve.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ def redirect_page_with_filename(request, project, subproject, filename): # pyli
135135
def _serve_401(request, project):
136136
res = render(request, '401.html')
137137
res.status_code = 401
138-
log.debug('Unauthorized access to {} documentation'.format(project.slug))
138+
log.debug('Unauthorized access to %s documentation', project.slug)
139139
return res
140140

141141

0 commit comments

Comments
 (0)