def test_weak_match(self):
"""Matching is best based on first 2 characters."""
self.assertEqual(get_best_supported_lang("es-MX"), "es")
self.assertEqual(get_best_supported_lang("pt-BR"), "pt")
self.assertEqual(get_best_supported_lang("en-ZA"), "en")
self.assertEqual(get_best_supported_lang("zh-CN"), "zh-TW")
self.assertEqual(get_best_supported_lang("zh"), "zh-TW")
def subscribe_main(request):
"""Subscription view for use with client side JS"""
form = SubscribeForm(request.POST)
if form.is_valid():
data = form.cleaned_data
if email_is_blocked(data['email']):
statsd.incr('news.views.subscribe_main.email_blocked')
# don't let on there's a problem
return respond_ok(request, data)
data['format'] = data.pop('fmt') or 'H'
if data['lang']:
if not language_code_is_valid(data['lang']):
data['lang'] = 'en'
# if lang not provided get the best one from the accept-language header
else:
lang = get_best_request_lang(request)
if lang:
data['lang'] = lang
else:
del data['lang']
# now ensure that if we do have a lang that it's a supported one
if 'lang' in data:
data['lang'] = get_best_supported_lang(data['lang'])
# if source_url not provided we should store the referrer header
# NOTE this is not a typo; Referrer is misspelled in the HTTP spec
# https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.36
if not data['source_url'] and request.META.get('HTTP_REFERER'):
referrer = request.META['HTTP_REFERER']
if SOURCE_URL_RE.match(referrer):
statsd.incr('news.views.subscribe_main.use_referrer')
data['source_url'] = referrer
if is_ratelimited(request, group='basket.news.views.subscribe_main',
key=lambda x, y: '%s-%s' % (':'.join(data['newsletters']), data['email']),
rate=EMAIL_SUBSCRIBE_RATE_LIMIT, increment=True):
statsd.incr('subscribe.ratelimited')
return respond_error(request, form, 'Rate limit reached', 429)
try:
upsert_user.delay(SUBSCRIBE, data, start_time=time())
except Exception:
return respond_error(request, form, 'Unknown error', 500)
return respond_ok(request, data)
else:
# form is invalid
if request.is_ajax():
return HttpResponseJSON({
'status': 'error',
'errors': format_form_errors(form.errors),
'errors_by_field': form.errors,
}, 400)
else:
return render(request, 'news/formerror.html', {'form': form}, status=400)
def test_exact_codes(self):
"""2 or 5 character code that's in the list is valid"""
self.assertEqual(get_best_supported_lang('es'), 'es')
self.assertEqual(get_best_supported_lang('zh-TW'), 'zh-TW')
def test_empty_string(self):
"""Empty string is accepted as a language code"""
self.assertEqual(get_best_supported_lang(''), 'en')
def test_weak_match(self):
"""Matching is best based on first 2 characters."""
self.assertEqual(get_best_supported_lang('es-MX'), 'es')
self.assertEqual(get_best_supported_lang('pt-BR'), 'pt')
self.assertEqual(get_best_supported_lang('en-ZA'), 'en')
self.assertEqual(get_best_supported_lang('zh-CN'), 'zh-TW')
def test_exact_codes(self):
"""2 or 5 character code that's in the list is valid"""
self.assertEqual(get_best_supported_lang("es"), "es")
self.assertEqual(get_best_supported_lang("zh-TW"), "zh-TW")
def update_user_task(request,
api_call_type,
data=None,
optin=False,
sync=False):
"""Call the update_user task async with the right parameters.
If sync==True, be sure to include the token in the response.
Otherwise, basket can just do everything in the background.
"""
data = data or request.POST.dict()
newsletters = parse_newsletters_csv(data.get("newsletters"))
if newsletters:
if api_call_type == SUBSCRIBE:
all_newsletters = (newsletter_and_group_slugs() +
get_transactional_message_ids())
else:
all_newsletters = newsletter_slugs()
private_newsletters = newsletter_private_slugs()
for nl in newsletters:
if nl not in all_newsletters:
return HttpResponseJSON(
{
"status": "error",
"desc": "invalid newsletter",
"code": errors.BASKET_INVALID_NEWSLETTER,
},
400,
)
if api_call_type != UNSUBSCRIBE and nl in private_newsletters:
if not is_authorized(request, data.get("email")):
return HttpResponseJSON(
{
"status": "error",
"desc":
"private newsletter subscription requires a valid API key or OAuth",
"code": errors.BASKET_AUTH_ERROR,
},
401,
)
if "lang" in data:
if not language_code_is_valid(data["lang"]):
data["lang"] = "en"
elif "accept_lang" in data:
lang = get_best_language(get_accept_languages(data["accept_lang"]))
if lang:
data["lang"] = lang
del data["accept_lang"]
# if lang not provided get the best one from the accept-language header
else:
lang = get_best_request_lang(request)
if lang:
data["lang"] = lang
# now ensure that if we do have a lang that it's a supported one
if "lang" in data:
data["lang"] = get_best_supported_lang(data["lang"])
email = data.get("email")
token = data.get("token")
if not (email or token):
return HttpResponseJSON(
{
"status": "error",
"desc": MSG_EMAIL_OR_TOKEN_REQUIRED,
"code": errors.BASKET_USAGE_ERROR,
},
400,
)
if optin:
data["optin"] = True
if api_call_type == SUBSCRIBE and email and data.get("newsletters"):
# only rate limit here so we don't rate limit errors.
if is_ratelimited(
request,
group="basket.news.views.update_user_task.subscribe",
key=lambda x, y: "%s-%s" % (data["newsletters"], email),
rate=EMAIL_SUBSCRIBE_RATE_LIMIT,
increment=True,
):
raise Ratelimited()
if api_call_type == SET and token and data.get("newsletters"):
# only rate limit here so we don't rate limit errors.
if is_ratelimited(
request,
group="basket.news.views.update_user_task.set",
key=lambda x, y: "%s-%s" % (data["newsletters"], token),
rate=EMAIL_SUBSCRIBE_RATE_LIMIT,
increment=True,
):
raise Ratelimited()
if sync:
statsd.incr("news.views.subscribe.sync")
if settings.MAINTENANCE_MODE and not settings.MAINTENANCE_READ_ONLY:
# save what we can
upsert_user.delay(api_call_type, data, start_time=time())
# have to error since we can't return a token
return HttpResponseJSON(
{
"status": "error",
"desc": "sync is not available in maintenance mode",
"code": errors.BASKET_NETWORK_FAILURE,
},
400,
)
try:
user_data = get_user_data(email=email, token=token)
except NewsletterException as e:
return newsletter_exception_response(e)
if not user_data:
if not email:
# must have email to create a user
return HttpResponseJSON(
{
"status": "error",
"desc": MSG_EMAIL_OR_TOKEN_REQUIRED,
"code": errors.BASKET_USAGE_ERROR,
},
400,
)
token, created = upsert_contact(api_call_type, data, user_data)
return HttpResponseJSON({
"status": "ok",
"token": token,
"created": created
})
else:
upsert_user.delay(api_call_type, data, start_time=time())
return HttpResponseJSON({"status": "ok"})
def process_newsletter_subscribe(data):
"""Process a MoFo newsletter subscription."""
data = data["form"]
data["lang"] = get_best_supported_lang(data["lang"])
upsert_user(SUBSCRIBE, data)
def test_weak_match(self):
"""Matching is best based on first 2 characters."""
self.assertEqual(get_best_supported_lang('es-MX'), 'es')
self.assertEqual(get_best_supported_lang('pt-BR'), 'pt')
self.assertEqual(get_best_supported_lang('en-ZA'), 'en')
self.assertEqual(get_best_supported_lang('zh-CN'), 'zh-TW')
def process_newsletter_subscribe(data):
data = data['form']
data['lang'] = get_best_supported_lang(data['lang'])
upsert_user(SUBSCRIBE, data)
def update_user_task(request, api_call_type, data=None, optin=False, sync=False):
"""Call the update_user task async with the right parameters.
If sync==True, be sure to include the token in the response.
Otherwise, basket can just do everything in the background.
"""
data = data or request.POST.dict()
newsletters = parse_newsletters_csv(data.get('newsletters'))
if newsletters:
if api_call_type == SUBSCRIBE:
all_newsletters = newsletter_and_group_slugs() + get_transactional_message_ids()
else:
all_newsletters = newsletter_slugs()
private_newsletters = newsletter_private_slugs()
for nl in newsletters:
if nl not in all_newsletters:
return HttpResponseJSON({
'status': 'error',
'desc': 'invalid newsletter',
'code': errors.BASKET_INVALID_NEWSLETTER,
}, 400)
if api_call_type != UNSUBSCRIBE and nl in private_newsletters:
if not is_authorized(request, data.get('email')):
return HttpResponseJSON({
'status': 'error',
'desc': 'private newsletter subscription requires a valid API key or OAuth',
'code': errors.BASKET_AUTH_ERROR,
}, 401)
if 'lang' in data:
if not language_code_is_valid(data['lang']):
data['lang'] = 'en'
elif 'accept_lang' in data:
lang = get_best_language(get_accept_languages(data['accept_lang']))
if lang:
data['lang'] = lang
del data['accept_lang']
# if lang not provided get the best one from the accept-language header
else:
lang = get_best_request_lang(request)
if lang:
data['lang'] = lang
# now ensure that if we do have a lang that it's a supported one
if 'lang' in data:
data['lang'] = get_best_supported_lang(data['lang'])
email = data.get('email')
token = data.get('token')
if not (email or token):
return HttpResponseJSON({
'status': 'error',
'desc': MSG_EMAIL_OR_TOKEN_REQUIRED,
'code': errors.BASKET_USAGE_ERROR,
}, 400)
if optin:
data['optin'] = True
if api_call_type == SUBSCRIBE and email and data.get('newsletters'):
# only rate limit here so we don't rate limit errors.
if is_ratelimited(request, group='basket.news.views.update_user_task.subscribe',
key=lambda x, y: '%s-%s' % (data['newsletters'], email),
rate=EMAIL_SUBSCRIBE_RATE_LIMIT, increment=True):
raise Ratelimited()
if api_call_type == SET and token and data.get('newsletters'):
# only rate limit here so we don't rate limit errors.
if is_ratelimited(request, group='basket.news.views.update_user_task.set',
key=lambda x, y: '%s-%s' % (data['newsletters'], token),
rate=EMAIL_SUBSCRIBE_RATE_LIMIT, increment=True):
raise Ratelimited()
if sync:
statsd.incr('news.views.subscribe.sync')
if settings.MAINTENANCE_MODE and not settings.MAINTENANCE_READ_ONLY:
# save what we can
upsert_user.delay(api_call_type, data, start_time=time())
# have to error since we can't return a token
return HttpResponseJSON({
'status': 'error',
'desc': 'sync is not available in maintenance mode',
'code': errors.BASKET_NETWORK_FAILURE,
}, 400)
try:
user_data = get_user_data(email=email, token=token)
except NewsletterException as e:
return newsletter_exception_response(e)
if not user_data:
if not email:
# must have email to create a user
return HttpResponseJSON({
'status': 'error',
'desc': MSG_EMAIL_OR_TOKEN_REQUIRED,
'code': errors.BASKET_USAGE_ERROR,
}, 400)
token, created = upsert_contact(api_call_type, data, user_data)
return HttpResponseJSON({
'status': 'ok',
'token': token,
'created': created,
})
else:
upsert_user.delay(api_call_type, data, start_time=time())
return HttpResponseJSON({
'status': 'ok',
})
def process_newsletter_subscribe(data):
data = data["form"]
data["lang"] = get_best_supported_lang(data["lang"])
upsert_user(SUBSCRIBE, data)
def test_invalid_codes(self):
"""A code that's not in the list gets the default."""
self.assertEqual(get_best_supported_lang("hi"), "en")
self.assertEqual(get_best_supported_lang("hi-IN"), "en")
self.assertEqual(get_best_supported_lang("dude"), "en")
def test_case_insensitive(self):
"""Matching is not case sensitive"""
self.assertEqual(get_best_supported_lang("ES"), "es")
self.assertEqual(get_best_supported_lang("es-MX"), "es")
self.assertEqual(get_best_supported_lang("PT-br"), "pt")
def test_case_insensitive(self):
"""Matching is not case sensitive"""
self.assertEqual(get_best_supported_lang('ES'), 'es')
self.assertEqual(get_best_supported_lang('es-MX'), 'es')
self.assertEqual(get_best_supported_lang('PT-br'), 'pt')
def test_invalid_codes(self):
"""A code that's not in the list gets the default."""
self.assertEqual(get_best_supported_lang('hi'), 'en')
self.assertEqual(get_best_supported_lang('hi-IN'), 'en')
self.assertEqual(get_best_supported_lang('dude'), 'en')
def test_empty_string(self):
"""Empty string is accepted as a language code"""
self.assertEqual(get_best_supported_lang(''), 'en')
def subscribe_main(request):
"""Subscription view for use with client side JS"""
form = SubscribeForm(request.POST)
if form.is_valid():
data = form.cleaned_data
if email_is_blocked(data['email']):
statsd.incr('news.views.subscribe_main.email_blocked')
# don't let on there's a problem
return respond_ok(request, data)
data['format'] = data.pop('fmt') or 'H'
if data['lang']:
if not language_code_is_valid(data['lang']):
data['lang'] = 'en'
# if lang not provided get the best one from the accept-language header
else:
lang = get_best_request_lang(request)
if lang:
data['lang'] = lang
else:
del data['lang']
# now ensure that if we do have a lang that it's a supported one
if 'lang' in data:
data['lang'] = get_best_supported_lang(data['lang'])
# if source_url not provided we should store the referrer header
# NOTE this is not a typo; Referrer is misspelled in the HTTP spec
# https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.36
if not data['source_url'] and request.META.get('HTTP_REFERER'):
referrer = request.META['HTTP_REFERER']
if SOURCE_URL_RE.match(referrer):
statsd.incr('news.views.subscribe_main.use_referrer')
data['source_url'] = referrer
if is_ratelimited(request,
group='basket.news.views.subscribe_main',
key=lambda x, y: '%s-%s' %
(':'.join(data['newsletters']), data['email']),
rate=EMAIL_SUBSCRIBE_RATE_LIMIT,
increment=True):
statsd.incr('subscribe.ratelimited')
return respond_error(request, form, 'Rate limit reached', 429)
try:
upsert_user.delay(SUBSCRIBE, data, start_time=time())
except Exception:
return respond_error(request, form, 'Unknown error', 500)
return respond_ok(request, data)
else:
# form is invalid
if request.is_ajax():
return HttpResponseJSON(
{
'status': 'error',
'errors': format_form_errors(form.errors),
'errors_by_field': form.errors,
}, 400)
else:
return render(request,
'news/formerror.html', {'form': form},
status=400)
def test_exact_codes(self):
"""2 or 5 character code that's in the list is valid"""
self.assertEqual(get_best_supported_lang('es'), 'es')
self.assertEqual(get_best_supported_lang('zh-TW'), 'zh-TW')
def process_newsletter_subscribe(data):
data = data['form']
data['lang'] = get_best_supported_lang(data['lang'])
upsert_user(SUBSCRIBE, data)
def test_case_insensitive(self):
"""Matching is not case sensitive"""
self.assertEqual(get_best_supported_lang('ES'), 'es')
self.assertEqual(get_best_supported_lang('es-MX'), 'es')
self.assertEqual(get_best_supported_lang('PT-br'), 'pt')
def subscribe_main(request):
"""Subscription view for use with client side JS"""
form = SubscribeForm(request.POST)
if form.is_valid():
data = form.cleaned_data
if email_is_blocked(data["email"]):
statsd.incr("news.views.subscribe_main.email_blocked")
# don't let on there's a problem
return respond_ok(request, data)
data["format"] = data.pop("fmt") or "H"
if data["lang"]:
if not language_code_is_valid(data["lang"]):
data["lang"] = "en"
# if lang not provided get the best one from the accept-language header
else:
lang = get_best_request_lang(request)
if lang:
data["lang"] = lang
else:
del data["lang"]
# now ensure that if we do have a lang that it's a supported one
if "lang" in data:
data["lang"] = get_best_supported_lang(data["lang"])
# if source_url not provided we should store the referrer header
# NOTE this is not a typo; Referrer is misspelled in the HTTP spec
# https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.36
if not data["source_url"] and request.META.get("HTTP_REFERER"):
referrer = request.META["HTTP_REFERER"]
if SOURCE_URL_RE.match(referrer):
statsd.incr("news.views.subscribe_main.use_referrer")
data["source_url"] = referrer
if is_ratelimited(
request,
group="basket.news.views.subscribe_main",
key=lambda x, y: "%s-%s" %
(":".join(data["newsletters"]), data["email"]),
rate=EMAIL_SUBSCRIBE_RATE_LIMIT,
increment=True,
):
statsd.incr("subscribe.ratelimited")
return respond_error(request, form, "Rate limit reached", 429)
try:
upsert_user.delay(SUBSCRIBE, data, start_time=time())
except Exception:
return respond_error(request, form, "Unknown error", 500)
return respond_ok(request, data)
else:
# form is invalid
if request.is_ajax():
return HttpResponseJSON(
{
"status": "error",
"errors": format_form_errors(form.errors),
"errors_by_field": form.errors,
},
400,
)
else:
return render(request,
"news/formerror.html", {"form": form},
status=400)
def test_invalid_codes(self):
"""A code that's not in the list gets the default."""
self.assertEqual(get_best_supported_lang('hi'), 'en')
self.assertEqual(get_best_supported_lang('hi-IN'), 'en')
self.assertEqual(get_best_supported_lang('dude'), 'en')
