From ed5b76f5660325db2a5c0743150ca326cae407cb Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Sun, 5 Mar 2017 23:35:57 -0800 Subject: [PATCH] zilencer: Move feedback code to zerver/lib/feedback. --- zerver/lib/feedback.py | 75 ++++++++++++++++++++++++++++++++++++++++++ zilencer/urls.py | 6 ++-- zilencer/views.py | 74 ++--------------------------------------- 3 files changed, 82 insertions(+), 73 deletions(-) create mode 100644 zerver/lib/feedback.py diff --git a/zerver/lib/feedback.py b/zerver/lib/feedback.py new file mode 100644 index 0000000000..67a7d84630 --- /dev/null +++ b/zerver/lib/feedback.py @@ -0,0 +1,75 @@ +from __future__ import absolute_import + +from typing import Any, Dict, Optional, Text + +from zerver.lib.actions import internal_send_message +from zerver.lib.redis_utils import get_redis_client +from zerver.models import get_realm, get_user_profile_by_email, \ + get_realm_by_email_domain, UserProfile, Realm + +import time + +client = get_redis_client() + +def realm_for_email(email): + # type: (str) -> Optional[Realm] + try: + user = get_user_profile_by_email(email) + return user.realm + except UserProfile.DoesNotExist: + pass + + return get_realm_by_email_domain(email) + +def has_enough_time_expired_since_last_message(sender_email, min_delay): + # type: (Text, float) -> bool + # This function returns a boolean, but it also has the side effect + # of noting that a new message was received. + key = 'zilencer:feedback:%s' % (sender_email,) + t = int(time.time()) + last_time = client.getset(key, t) + if last_time is None: + return True + delay = t - int(last_time) + return delay > min_delay + +def get_ticket_number(): + # type: () -> int + num_file = '/var/tmp/.feedback-bot-ticket-number' + try: + ticket_number = int(open(num_file).read()) + 1 + except Exception: + ticket_number = 1 + open(num_file, 'w').write('%d' % (ticket_number,)) + return ticket_number + +def deliver_feedback_by_zulip(message): + # type: (Dict[str, Any]) -> None + subject = "%s" % (message["sender_email"],) + + if len(subject) > 60: + subject = subject[:57].rstrip() + "..." + + content = u'' + sender_email = message['sender_email'] + + # We generate ticket numbers if it's been more than a few minutes + # since their last message. This avoids some noise when people use + # enter-send. + need_ticket = has_enough_time_expired_since_last_message(sender_email, 180) + + if need_ticket: + ticket_number = get_ticket_number() + content += '\n~~~' + content += '\nticket Z%03d (@support please ack)' % (ticket_number,) + content += '\nsender: %s' % (message['sender_full_name'],) + content += '\nemail: %s' % (sender_email,) + if 'sender_domain' in message: + content += '\nrealm: %s' % (message['sender_domain'],) + content += '\n~~~' + content += '\n\n' + + content += message['content'] + + internal_send_message(realm_for_email("feedback@zulip.com"), "feedback@zulip.com", + "stream", "support", subject, content) diff --git a/zilencer/urls.py b/zilencer/urls.py index a35a768692..cdcf4770ec 100644 --- a/zilencer/urls.py +++ b/zilencer/urls.py @@ -1,10 +1,12 @@ from django.conf.urls import url, include +from typing import Any + from zerver.lib.rest import rest_dispatch + import zilencer.views import zerver.views.report -i18n_urlpatterns = [ -] +i18n_urlpatterns = [] # type: Any # Zilencer views following the REST API style v1_api_and_json_patterns = [ diff --git a/zilencer/views.py b/zilencer/views.py index 713d5fba45..0deebb9987 100644 --- a/zilencer/views.py +++ b/zilencer/views.py @@ -6,87 +6,19 @@ from django.http import HttpResponse, HttpRequest from zilencer.models import Deployment from zerver.decorator import has_request_variables, REQ -from zerver.lib.actions import internal_send_message from zerver.lib.error_notify import do_report_error -from zerver.lib.redis_utils import get_redis_client -from zerver.lib.response import json_error, json_response +from zerver.lib.feedback import deliver_feedback_by_zulip from zerver.lib.validator import check_dict -from zerver.models import get_realm, get_user_profile_by_email, \ - get_realm_by_email_domain, UserProfile, Realm -import time - -from typing import Dict, Optional, Any, Text - -client = get_redis_client() - -def has_enough_time_expired_since_last_message(sender_email, min_delay): - # type: (Text, float) -> bool - # This function returns a boolean, but it also has the side effect - # of noting that a new message was received. - key = 'zilencer:feedback:%s' % (sender_email,) - t = int(time.time()) - last_time = client.getset(key, t) - if last_time is None: - return True - delay = t - int(last_time) - return delay > min_delay - -def get_ticket_number(): - # type: () -> int - num_file = '/var/tmp/.feedback-bot-ticket-number' - try: - ticket_number = int(open(num_file).read()) + 1 - except Exception: - ticket_number = 1 - open(num_file, 'w').write('%d' % (ticket_number,)) - return ticket_number +from typing import Any, Dict, Text @has_request_variables def submit_feedback(request, deployment, message=REQ(validator=check_dict([]))): # type: (HttpRequest, Deployment, Dict[str, Text]) -> HttpResponse - subject = "%s" % (message["sender_email"],) - - if len(subject) > 60: - subject = subject[:57].rstrip() + "..." - - content = u'' - sender_email = message['sender_email'] - - # We generate ticket numbers if it's been more than a few minutes - # since their last message. This avoids some noise when people use - # enter-send. - need_ticket = has_enough_time_expired_since_last_message(sender_email, 180) - - if need_ticket: - ticket_number = get_ticket_number() - content += '\n~~~' - content += '\nticket Z%03d (@support please ack)' % (ticket_number,) - content += '\nsender: %s' % (message['sender_full_name'],) - content += '\nemail: %s' % (sender_email,) - if 'sender_domain' in message: - content += '\nrealm: %s' % (message['sender_domain'],) - content += '\n~~~' - content += '\n\n' - - content += message['content'] - - internal_send_message(realm_for_email("feedback@zulip.com"), "feedback@zulip.com", - "stream", "support", subject, content) - + deliver_feedback_by_zulip(message) return HttpResponse(message['sender_email']) @has_request_variables def report_error(request, deployment, type=REQ(), report=REQ(validator=check_dict([]))): # type: (HttpRequest, Deployment, Text, Dict[str, Any]) -> HttpResponse return do_report_error(deployment.name, type, report) - -def realm_for_email(email): - # type: (str) -> Optional[Realm] - try: - user = get_user_profile_by_email(email) - return user.realm - except UserProfile.DoesNotExist: - pass - - return get_realm_by_email_domain(email)