536 lines
23 KiB
Python
536 lines
23 KiB
Python
import unicodecsv as csv
|
|
import json
|
|
import requests
|
|
import datetime
|
|
import io
|
|
from urllib.parse import urljoin
|
|
|
|
from flask import request, url_for, render_template, redirect, \
|
|
jsonify, flash, make_response, Response, g, \
|
|
session, abort, render_template_string
|
|
from flask_login import current_user, login_required
|
|
from flask_cors import cross_origin
|
|
from jinja2.exceptions import TemplateNotFound
|
|
|
|
from formspree import settings
|
|
from formspree.stuff import DB, TEMPLATES
|
|
from formspree.utils import request_wants_json, jsonerror, IS_VALID_EMAIL, \
|
|
url_domain, valid_url, send_email
|
|
from .helpers import http_form_to_dict, ordered_storage, referrer_to_path, \
|
|
remove_www, referrer_to_baseurl, sitewide_file_check, \
|
|
verify_captcha, temp_store_hostname, get_temp_hostname, \
|
|
HASH, assign_ajax, KEYS_EXCLUDED_FROM_EMAIL
|
|
from .models import Form, Submission
|
|
|
|
|
|
def thanks():
|
|
if request.args.get('next') and not valid_url(request.args.get('next')):
|
|
return render_template('error.html',
|
|
title='Invalid URL', text='An invalid URL was supplied'), 400
|
|
return render_template('forms/thanks.html', next=request.args.get('next'))
|
|
|
|
|
|
@cross_origin(allow_headers=['Accept', 'Content-Type',
|
|
'X-Requested-With', 'Authorization'])
|
|
@ordered_storage
|
|
def send(email_or_string):
|
|
'''
|
|
Main endpoint, finds or creates the form row from the database,
|
|
checks validity and state of the form and sends either form data
|
|
or verification to email.
|
|
'''
|
|
|
|
g.log = g.log.bind(target=email_or_string)
|
|
|
|
if request.method == 'GET':
|
|
if request_wants_json():
|
|
return jsonerror(405, {'error': "Please submit POST request."})
|
|
else:
|
|
return render_template('info.html',
|
|
title='Form should POST',
|
|
text='Make sure your form has the <span '
|
|
'class="code"><strong>method="POST"'
|
|
'</strong></span> attribute'), 405
|
|
|
|
if request.form:
|
|
received_data, sorted_keys = http_form_to_dict(request.form)
|
|
else:
|
|
received_data = request.get_json() or {}
|
|
sorted_keys = received_data.keys()
|
|
|
|
sorted_keys = [k for k in sorted_keys if k not in KEYS_EXCLUDED_FROM_EMAIL]
|
|
|
|
# NOTE: host in this function generally refers to the referrer hostname.
|
|
|
|
try:
|
|
# Get stored hostname from redis (from captcha)
|
|
host, referrer = get_temp_hostname(received_data['_host_nonce'])
|
|
except KeyError:
|
|
host, referrer = referrer_to_path(request.referrer), request.referrer
|
|
except ValueError as err:
|
|
g.log.error('Invalid hostname stored on Redis.', err=err)
|
|
return render_template(
|
|
'error.html',
|
|
title='Unable to submit form',
|
|
text='<p>We had a problem identifying to whom we should have submitted this form. Please try submitting again. If it fails once more, please let us know at {email}</p>'.format(
|
|
email=settings.CONTACT_EMAIL,
|
|
)
|
|
), 500
|
|
|
|
if not host:
|
|
if request_wants_json():
|
|
return jsonerror(400, {'error': "Invalid \"Referrer\" header"})
|
|
else:
|
|
return render_template(
|
|
'error.html',
|
|
title='Unable to submit form',
|
|
text='<p>Make sure you open this page through a web server, Formspree will not work in pages browsed as HTML files. Also make sure that you\'re posting to <b>{host}{path}</b>.</p><p>For geeks: could not find the "Referrer" header.</p>'.format(
|
|
host=settings.SERVICE_URL,
|
|
path=request.path
|
|
)
|
|
), 400
|
|
|
|
g.log = g.log.bind(host=host, wants='json' if request_wants_json() else 'html')
|
|
|
|
if not IS_VALID_EMAIL(email_or_string):
|
|
# in this case it can be a hashid identifying a
|
|
# form generated from the dashboard
|
|
hashid = email_or_string
|
|
form = Form.get_with_hashid(hashid)
|
|
|
|
if form:
|
|
# Check if it has been assigned about using AJAX or not
|
|
assign_ajax(form, request_wants_json())
|
|
|
|
if form.disabled:
|
|
# owner has disabled the form, so it should not receive any submissions
|
|
if request_wants_json():
|
|
return jsonerror(403, {'error': 'Form not active'})
|
|
else:
|
|
return render_template('error.html',
|
|
title='Form not active',
|
|
text='The owner of this form has disabled this form and it is no longer accepting submissions. Your submissions was not accepted'), 403
|
|
email = form.email
|
|
|
|
if not form.host:
|
|
# add the host to the form
|
|
form.host = host
|
|
DB.session.add(form)
|
|
DB.session.commit()
|
|
|
|
# it is an error when
|
|
# form is not sitewide, and submission came from a different host
|
|
# form is sitewide, but submission came from a host rooted somewhere else, or
|
|
elif (not form.sitewide and
|
|
# ending slashes can be safely ignored here:
|
|
form.host.rstrip('/') != host.rstrip('/')) or \
|
|
(form.sitewide and \
|
|
# removing www from both sides makes this a neutral operation:
|
|
not remove_www(host).startswith(remove_www(form.host))
|
|
):
|
|
g.log.info('Submission rejected. From a different host than confirmed.')
|
|
if request_wants_json():
|
|
return jsonerror(403, {
|
|
'error': "Submission from different host than confirmed",
|
|
'submitted': host, 'confirmed': form.host
|
|
})
|
|
else:
|
|
return render_template('error.html',
|
|
title='Check form address',
|
|
text='This submission came from "%s" but the form was\
|
|
confirmed for address "%s"' % (host, form.host)), 403
|
|
else:
|
|
# no form row found. it is an error.
|
|
g.log.info('Submission rejected. No form found for this target.')
|
|
if request_wants_json():
|
|
return jsonerror(400, {'error': "Invalid email address"})
|
|
else:
|
|
return render_template('error.html',
|
|
title='Check email address',
|
|
text='Email address %s is not formatted correctly' \
|
|
% str(email_or_string)), 400
|
|
else:
|
|
# in this case, it is a normal email
|
|
email = email_or_string.lower()
|
|
|
|
# get the form for this request
|
|
form = Form.query.filter_by(hash=HASH(email, host)).first()
|
|
|
|
# or create it if it doesn't exist
|
|
if not form:
|
|
if request_wants_json():
|
|
# Can't create a new ajax form unless from the dashboard
|
|
ajax_error_str = "To prevent spam, only " + \
|
|
settings.UPGRADED_PLAN_NAME + \
|
|
" accounts may create AJAX forms."
|
|
return jsonerror(400, {'error': ajax_error_str})
|
|
elif url_domain(settings.SERVICE_URL) in host:
|
|
# Bad user is trying to submit a form spoofing formspree.io
|
|
g.log.info('User attempting to create new form spoofing SERVICE_URL. Ignoring.')
|
|
return render_template(
|
|
'error.html',
|
|
title='Unable to submit form',
|
|
text='Sorry'), 400
|
|
else:
|
|
# all good, create form
|
|
form = Form(email, host)
|
|
|
|
# Check if it has been assigned using AJAX or not
|
|
assign_ajax(form, request_wants_json())
|
|
|
|
if form.disabled:
|
|
g.log.info('submission rejected. Form is disabled.')
|
|
if request_wants_json():
|
|
return jsonerror(403, {'error': 'Form not active'})
|
|
else:
|
|
return render_template('error.html',
|
|
title='Form not active',
|
|
text='The owner of this form has disabled this form and it is no longer accepting submissions. Your submissions was not accepted'), 403
|
|
|
|
# If form exists and is confirmed, send email
|
|
# otherwise send a confirmation email
|
|
if form.confirmed:
|
|
captcha_verified = verify_captcha(received_data, request)
|
|
needs_captcha = not (request_wants_json() or
|
|
captcha_verified or
|
|
settings.TESTING)
|
|
|
|
# check if captcha is disabled
|
|
if form.has_feature('dashboard'):
|
|
needs_captcha = needs_captcha and not form.captcha_disabled
|
|
|
|
if needs_captcha:
|
|
data_copy = received_data.copy()
|
|
# Temporarily store hostname in redis while doing captcha
|
|
nonce = temp_store_hostname(form.host, request.referrer)
|
|
data_copy['_host_nonce'] = nonce
|
|
action = urljoin(settings.API_ROOT, email_or_string)
|
|
try:
|
|
if '_language' in received_data:
|
|
return render_template(
|
|
'forms/captcha_lang/{}.html'.format(received_data['_language']),
|
|
data=data_copy,
|
|
sorted_keys=sorted_keys,
|
|
action=action,
|
|
lang=received_data['_language']
|
|
)
|
|
except TemplateNotFound:
|
|
g.log.error('Requested language not found for reCAPTCHA page, defaulting to English', referrer=request.referrer, lang=received_data['_language'])
|
|
pass
|
|
|
|
return render_template('forms/captcha.html',
|
|
data=data_copy,
|
|
sorted_keys=sorted_keys,
|
|
action=action,
|
|
lang=None)
|
|
|
|
status = form.send(received_data, sorted_keys, referrer)
|
|
else:
|
|
status = form.send_confirmation(store_data=received_data)
|
|
|
|
# Respond to the request accordingly to the status code
|
|
if status['code'] == Form.STATUS_EMAIL_SENT:
|
|
if request_wants_json():
|
|
return jsonify({'success': "email sent", 'next': status['next']})
|
|
else:
|
|
return redirect(status['next'], code=302)
|
|
elif status['code'] == Form.STATUS_NO_EMAIL:
|
|
if request_wants_json():
|
|
return jsonify({'success': "no email sent, access submission archive on {} dashboard".format(settings.SERVICE_NAME), 'next': status['next']})
|
|
else:
|
|
return redirect(status['next'], code=302)
|
|
elif status['code'] == Form.STATUS_EMAIL_EMPTY:
|
|
if request_wants_json():
|
|
return jsonerror(400, {'error': "Can't send an empty form"})
|
|
else:
|
|
return render_template(
|
|
'error.html',
|
|
title='Can\'t send an empty form',
|
|
text=u'<p>Make sure you have placed the <a href="http://www.w3schools.com/tags/att_input_name.asp" target="_blank"><code>"name"</code> attribute</a> in all your form elements. Also, to prevent empty form submissions, take a look at the <a href="http://www.w3schools.com/tags/att_input_required.asp" target="_blank"><code>"required"</code> property</a>.</p><p>This error also happens when you have an <code>"enctype"</code> attribute set in your <code><form></code>, so make sure you don\'t.</p><p><a href="{}">Return to form</a></p>'.format(referrer)
|
|
), 400
|
|
elif status['code'] == Form.STATUS_CONFIRMATION_SENT or \
|
|
status['code'] == Form.STATUS_CONFIRMATION_DUPLICATED:
|
|
|
|
if request_wants_json():
|
|
return jsonify({'success': "confirmation email sent"})
|
|
else:
|
|
return render_template('forms/confirmation_sent.html',
|
|
email=email,
|
|
host=host,
|
|
resend=status['code'] == Form.STATUS_CONFIRMATION_DUPLICATED
|
|
)
|
|
elif status['code'] == Form.STATUS_OVERLIMIT:
|
|
if request_wants_json():
|
|
return jsonify({'error': "form over quota"})
|
|
else:
|
|
return render_template('error.html', title='Form over quota', text='It looks like this form is getting a lot of submissions and ran out of its quota. Try contacting this website through other means or try submitting again later.'), 402
|
|
|
|
elif status['code'] == Form.STATUS_REPLYTO_ERROR:
|
|
if request_wants_json():
|
|
return jsonerror(500, {'error': "_replyto or email field has not been sent correctly"})
|
|
else:
|
|
return render_template(
|
|
'error.html',
|
|
title='Invalid email address',
|
|
text=u'You entered <span class="code">{address}</span>. That is an invalid email address. Please correct the form and try to submit again <a href="{back}">here</a>.<p style="font-size: small">This could also be a problem with the form. For example, there could be two fields with <span class="code">_replyto</span> or <span class="code">email</span> name attribute. If you suspect the form is broken, please contact the form owner and ask them to investigate</p>'''.format(address=status['address'], back=status['referrer'])
|
|
), 400
|
|
|
|
# error fallback -- shouldn't happen
|
|
if request_wants_json():
|
|
return jsonerror(500, {'error': "Unable to send email"})
|
|
else:
|
|
return render_template(
|
|
'error.html',
|
|
title='Unable to send email',
|
|
text=u'Unable to send email. If you can, please send the link to your form and the error information to <b>{email}</b>. And send them the following: <p><pre><code>{message}</code></pre></p>'.format(message=json.dumps(status), email=settings.CONTACT_EMAIL)
|
|
), 500
|
|
|
|
|
|
def resend_confirmation(email):
|
|
g.log = g.log.bind(email=email, host=request.form.get('host'))
|
|
g.log.info('Resending confirmation.')
|
|
|
|
if verify_captcha(request.form, request):
|
|
# check if this email is listed on SendGrid's bounces
|
|
r = requests.get('https://api.sendgrid.com/api/bounces.get.json',
|
|
params={
|
|
'email': email,
|
|
'api_user': settings.SENDGRID_USERNAME,
|
|
'api_key': settings.SENDGRID_PASSWORD
|
|
}
|
|
)
|
|
if r.ok and len(r.json()) and 'reason' in r.json()[0]:
|
|
# tell the user to verify his mailbox
|
|
reason = r.json()[0]['reason']
|
|
g.log.info('Email is blocked on SendGrid. Telling the user.')
|
|
if request_wants_json():
|
|
resp = jsonify({'error': "Verify your mailbox, we can't reach it.", 'reason': reason})
|
|
else:
|
|
resp = make_response(render_template('info.html',
|
|
title='Verify the availability of your mailbox',
|
|
text="We encountered an error when trying to deliver the confirmation message to <b>" + email + "</b> at the first time we tried. For spam reasons, we will not try again until we are sure the problem is fixed. Here's the reason:</p><p><center><i>" + reason + "</i></center></p><p>Please make sure this problem is not happening still, then go to <a href='/unblock/" + email + "'>this page</a> to unblock your address.</p><p>After you have unblocked the address, please try to resend the confirmation again.</p>"
|
|
))
|
|
return resp
|
|
# ~~~
|
|
# if there's no bounce, we proceed to resend the confirmation.
|
|
|
|
form = Form.query.filter_by(hash=HASH(email, request.form['host'])).first()
|
|
if not form:
|
|
if request_wants_json():
|
|
return jsonerror(400, {'error': "This form does not exist."})
|
|
else:
|
|
return render_template('error.html',
|
|
title='Check email address',
|
|
text='This form does not exist.'), 400
|
|
form.confirm_sent = False
|
|
status = form.send_confirmation()
|
|
if status['code'] == Form.STATUS_CONFIRMATION_SENT:
|
|
if request_wants_json():
|
|
return jsonify({'success': "confirmation email sent"})
|
|
else:
|
|
return render_template('forms/confirmation_sent.html',
|
|
email=email,
|
|
host=request.form['host'],
|
|
resend=status['code'] == Form.STATUS_CONFIRMATION_DUPLICATED
|
|
)
|
|
|
|
# fallback response -- should happen only when the recaptcha is failed.
|
|
g.log.warning('Failed to resend confirmation.')
|
|
return render_template('error.html',
|
|
title='Unable to send email',
|
|
text='Please make sure you pass the <i>reCaptcha</i> test before submitting.'), 500
|
|
|
|
|
|
def unblock_email(email):
|
|
if request.method == 'POST':
|
|
g.log = g.log.bind(email=email)
|
|
g.log.info('Unblocking email on SendGrid.')
|
|
|
|
if verify_captcha(request.form, request):
|
|
# clear the bounce from SendGrid
|
|
r = requests.post(
|
|
'https://api.sendgrid.com/api/bounces.delete.json',
|
|
data={
|
|
'email': email,
|
|
'api_user': settings.SENDGRID_USERNAME,
|
|
'api_key': settings.SENDGRID_PASSWORD
|
|
}
|
|
)
|
|
if r.ok and r.json()['message'] == 'success':
|
|
g.log.info('Unblocked address.')
|
|
return render_template('info.html',
|
|
title='Successfully unblocked email address!',
|
|
text='You should be able to receive emails from Formspree again.')
|
|
else:
|
|
g.log.warning('Failed to unblock email on SendGrid.')
|
|
return render_template('error.html',
|
|
title='Failed to unblock address.',
|
|
text=email + ' is not a valid address or wasn\'t blocked on our side.')
|
|
|
|
# fallback response -- should happen only when the recaptcha is failed.
|
|
g.log.warning('Failed to unblock email. reCaptcha test failed.')
|
|
return render_template('error.html',
|
|
title='Unable to unblock email',
|
|
text='Please make sure you pass the <i>reCaptcha</i> test before '
|
|
'submitting.'), 500
|
|
|
|
elif request.method == 'GET':
|
|
return render_template('forms/unblock_email.html', email=email), 200
|
|
|
|
|
|
def request_unconfirm_form(form_id):
|
|
'''
|
|
This endpoints triggers a confirmation email that directs users to the
|
|
GET version of unconfirm_form.
|
|
'''
|
|
|
|
# repel bots
|
|
if not request.user_agent.browser:
|
|
return ''
|
|
|
|
form = Form.query.get(form_id)
|
|
|
|
unconfirm_url = url_for(
|
|
'unconfirm_form',
|
|
form_id=form.id,
|
|
digest=form.unconfirm_digest(),
|
|
_external=True
|
|
)
|
|
send_email(
|
|
to=form.email,
|
|
subject='Unsubscribe from form at {}'.format(form.host),
|
|
html=render_template_string(TEMPLATES.get('unsubscribe-confirmation.html'),
|
|
url=unconfirm_url,
|
|
email=form.email,
|
|
host=form.host),
|
|
text=render_template('email/unsubscribe-confirmation.txt',
|
|
url=unconfirm_url,
|
|
email=form.email,
|
|
host=form.host),
|
|
sender=settings.DEFAULT_SENDER,
|
|
)
|
|
|
|
return render_template('info.html',
|
|
title='Link sent to your address',
|
|
text="We've sent an email to {} with a link to finish "
|
|
"unsubscribing.".format(form.email)), 200
|
|
|
|
|
|
def unconfirm_form(form_id, digest):
|
|
'''
|
|
Here we check the digest for a form and handle the unconfirmation.
|
|
Also works for List-Unsubscribe triggered POSTs.
|
|
When GET, give the user the option to unsubscribe from other forms as well.
|
|
'''
|
|
form = Form.query.get(form_id)
|
|
success = form.unconfirm_with_digest(digest)
|
|
|
|
if request.method == 'GET':
|
|
if success:
|
|
other_forms = Form.query.filter_by(confirmed=True, email=form.email)
|
|
|
|
session['unconfirming'] = form.email
|
|
|
|
return render_template('forms/unconfirm.html',
|
|
other_forms=other_forms,
|
|
disabled_form=form
|
|
), 200
|
|
else:
|
|
return render_template('error.html',
|
|
title='Not a valid link',
|
|
text='This unconfirmation link is not valid.'), 400
|
|
|
|
if request.method == 'POST':
|
|
if success:
|
|
return '', 200
|
|
else:
|
|
return abort(401)
|
|
|
|
|
|
def unconfirm_multiple():
|
|
unconfirming_for_email = session.get('unconfirming')
|
|
if not unconfirming_for_email:
|
|
return render_template('error.html',
|
|
title='Forbidden',
|
|
text="You're not allowed to unconfirm these forms."), 401
|
|
|
|
for form_id in request.form.getlist('form_ids'):
|
|
form = Form.query.get(form_id)
|
|
if form.email == unconfirming_for_email:
|
|
form.confirmed = False
|
|
DB.session.add(form)
|
|
DB.session.commit()
|
|
|
|
return render_template('info.html',
|
|
title='Success',
|
|
text='The selected forms were unconfirmed successfully.'), 200
|
|
|
|
|
|
def confirm_email(nonce):
|
|
'''
|
|
Confirmation emails point to this endpoint
|
|
It either rejects the confirmation or
|
|
flags associated email+host to be confirmed
|
|
'''
|
|
|
|
# get the form for this request
|
|
form = Form.confirm(nonce)
|
|
|
|
if not form:
|
|
return render_template('error.html',
|
|
title='Not a valid link',
|
|
text='Confirmation token not found.<br />Please check the link and try again.'), 400
|
|
|
|
else:
|
|
return render_template('forms/email_confirmed.html', email=form.email, host=form.host)
|
|
|
|
|
|
@login_required
|
|
def serve_dashboard(hashid=None, s=None):
|
|
return render_template('forms/dashboard.html')
|
|
|
|
|
|
@login_required
|
|
def export_submissions(hashid, format=None):
|
|
if not current_user.has_feature('dashboard'):
|
|
return jsonerror(402, {'error': "Please upgrade your account."})
|
|
|
|
form = Form.get_with_hashid(hashid)
|
|
for cont in form.controllers:
|
|
if cont.id == current_user.id: break
|
|
else:
|
|
return abort(401)
|
|
|
|
submissions, fields = form.submissions_with_fields()
|
|
|
|
if format == 'json':
|
|
return Response(
|
|
json.dumps({
|
|
'host': form.host,
|
|
'email': form.email,
|
|
'fields': fields,
|
|
'submissions': submissions
|
|
}, sort_keys=True, indent=2),
|
|
mimetype='application/json',
|
|
headers={
|
|
'Content-Disposition': 'attachment; filename=form-%s-submissions-%s.json' \
|
|
% (hashid, datetime.datetime.now().isoformat().split('.')[0])
|
|
}
|
|
)
|
|
elif format == 'csv':
|
|
out = io.BytesIO()
|
|
|
|
w = csv.DictWriter(out, fieldnames=['id'] + fields, encoding='utf-8')
|
|
w.writeheader()
|
|
for sub in submissions:
|
|
w.writerow(sub)
|
|
|
|
return Response(
|
|
out.getvalue(),
|
|
mimetype='text/csv',
|
|
headers={
|
|
'Content-Disposition': 'attachment; filename=form-%s-submissions-%s.csv' \
|
|
% (hashid, datetime.datetime.now().isoformat().split('.')[0])
|
|
}
|
|
)
|