Statistics
| Branch: | Tag: | Revision:

root / snf-astakos-app / astakos / im / functions.py @ e9083112

History | View | Annotate | Download (9.9 kB)

1
# Copyright 2011 GRNET S.A. All rights reserved.
2
# 
3
# Redistribution and use in source and binary forms, with or
4
# without modification, are permitted provided that the following
5
# conditions are met:
6
# 
7
#   1. Redistributions of source code must retain the above
8
#      copyright notice, this list of conditions and the following
9
#      disclaimer.
10
# 
11
#   2. Redistributions in binary form must reproduce the above
12
#      copyright notice, this list of conditions and the following
13
#      disclaimer in the documentation and/or other materials
14
#      provided with the distribution.
15
# 
16
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27
# POSSIBILITY OF SUCH DAMAGE.
28
# 
29
# The views and conclusions contained in the software and
30
# documentation are those of the authors and should not be
31
# interpreted as representing official policies, either expressed
32
# or implied, of GRNET S.A.
33

    
34
import logging
35
import socket
36

    
37
from django.utils.translation import ugettext as _
38
from django.template.loader import render_to_string
39
from django.core.mail import send_mail
40
from django.core.urlresolvers import reverse
41
from django.core.exceptions import ValidationError
42
from django.template import Context, loader
43
from django.contrib.auth import login as auth_login, logout as auth_logout
44
from django.http import HttpRequest
45

    
46
from urllib import quote
47
from urlparse import urljoin
48
from smtplib import SMTPException
49
from datetime import datetime
50
from functools import wraps
51

    
52
from astakos.im.settings import DEFAULT_CONTACT_EMAIL, DEFAULT_FROM_EMAIL, \
53
    SITENAME, BASEURL, DEFAULT_ADMIN_EMAIL, LOGGING_LEVEL
54
from astakos.im.models import Invitation, AstakosUser
55

    
56
logger = logging.getLogger(__name__)
57

    
58
def logged(func, msg):
59
    @wraps(func)
60
    def with_logging(*args, **kwargs):
61
        email = ''
62
        user = None
63
        if len(args) == 2 and isinstance(args[1], AstakosUser):
64
            user = args[1]
65
        elif len(args) == 1 and isinstance(args[0], HttpRequest):
66
            request = args[0]
67
            user = request.user
68
        email = user.email if user and user.is_authenticated() else ''
69
        r = func(*args, **kwargs)
70
        if LOGGING_LEVEL:
71
            logger._log(LOGGING_LEVEL, msg % email, [])
72
        return r
73
    return with_logging
74

    
75
login = logged(auth_login, '%s logged in.')
76
logout = logged(auth_logout, '%s logged out.')
77

    
78
def send_verification(user, template_name='im/activation_email.txt'):
79
    """
80
    Send email to user to verify his/her email and activate his/her account.
81
    
82
    Raises SendVerificationError
83
    """
84
    url = '%s?auth=%s&next=%s' % (urljoin(BASEURL, reverse('astakos.im.views.activate')),
85
                                    quote(user.auth_token),
86
                                    quote(urljoin(BASEURL, reverse('astakos.im.views.index'))))
87
    message = render_to_string(template_name, {
88
            'user': user,
89
            'url': url,
90
            'baseurl': BASEURL,
91
            'site_name': SITENAME,
92
            'support': DEFAULT_CONTACT_EMAIL})
93
    sender = DEFAULT_FROM_EMAIL
94
    try:
95
        send_mail('%s alpha2 testing account activation is needed' % SITENAME, message, sender, [user.email])
96
    except (SMTPException, socket.error) as e:
97
        logger.exception(e)
98
        raise SendVerificationError()
99
    else:
100
        msg = 'Sent activation %s' % user.email
101
        logger._log(LOGGING_LEVEL, msg, [])
102

    
103
def send_activation(user, template_name='im/activation_email.txt'):
104
    send_verification(user, template_name)
105
    user.activation_sent = datetime.now()
106
    user.save()
107

    
108
def send_admin_notification(user, template_name='im/admin_notification.txt'):
109
    """
110
    Send email to DEFAULT_ADMIN_EMAIL to notify for a new user registration.
111
    
112
    Raises SendNotificationError
113
    """
114
    if not DEFAULT_ADMIN_EMAIL:
115
        return
116
    message = render_to_string(template_name, {
117
            'user': user,
118
            'baseurl': BASEURL,
119
            'site_name': SITENAME,
120
            'support': DEFAULT_CONTACT_EMAIL})
121
    sender = DEFAULT_FROM_EMAIL
122
    try:
123
        send_mail('%s alpha2 testing account notification' % SITENAME, message, sender, [DEFAULT_ADMIN_EMAIL])
124
    except (SMTPException, socket.error) as e:
125
        logger.exception(e)
126
        raise SendNotificationError()
127
    else:
128
        msg = 'Sent admin notification for user %s' % user.email
129
        logger._log(LOGGING_LEVEL, msg, [])
130

    
131
def send_invitation(invitation, template_name='im/invitation.txt'):
132
    """
133
    Send invitation email.
134
    
135
    Raises SendInvitationError
136
    """
137
    subject = _('Invitation to %s alpha2 testing' % SITENAME)
138
    url = '%s?code=%d' % (urljoin(BASEURL, reverse('astakos.im.views.index')), invitation.code)
139
    message = render_to_string('im/invitation.txt', {
140
                'invitation': invitation,
141
                'url': url,
142
                'baseurl': BASEURL,
143
                'site_name': SITENAME,
144
                'support': DEFAULT_CONTACT_EMAIL})
145
    sender = DEFAULT_FROM_EMAIL
146
    try:
147
        send_mail(subject, message, sender, [invitation.username])
148
    except (SMTPException, socket.error) as e:
149
        logger.exception(e)
150
        raise SendInvitationError()
151
    else:
152
        msg = 'Sent invitation %s' % invitation
153
        logger._log(LOGGING_LEVEL, msg, [])
154

    
155
def send_greeting(user, email_template_name='im/welcome_email.txt'):
156
    """
157
    Send welcome email.
158
    
159
    Raises SMTPException, socket.error
160
    """
161
    subject = _('Welcome to %s alpha2 testing' % SITENAME)
162
    message = render_to_string(email_template_name, {
163
                'user': user,
164
                'url': urljoin(BASEURL, reverse('astakos.im.views.index')),
165
                'baseurl': BASEURL,
166
                'site_name': SITENAME,
167
                'support': DEFAULT_CONTACT_EMAIL})
168
    sender = DEFAULT_FROM_EMAIL
169
    try:
170
        send_mail(subject, message, sender, [user.email])
171
    except (SMTPException, socket.error) as e:
172
        logger.exception(e)
173
        raise SendGreetingError()
174
    else:
175
        msg = 'Sent greeting %s' % user.email
176
        logger._log(LOGGING_LEVEL, msg, [])
177

    
178
def send_feedback(msg, data, user, email_template_name='im/feedback_mail.txt'):
179
    subject = _("Feedback from %s alpha2 testing" % SITENAME)
180
    from_email = user.email
181
    recipient_list = [DEFAULT_CONTACT_EMAIL]
182
    content = render_to_string(email_template_name, {
183
        'message': msg,
184
        'data': data,
185
        'user': user})
186
    try:
187
        send_mail(subject, content, from_email, recipient_list)
188
    except (SMTPException, socket.error) as e:
189
        logger.exception(e)
190
        raise SendFeedbackError()
191
    else:
192
        msg = 'Sent feedback from %s' % user.email
193
        logger._log(LOGGING_LEVEL, msg, [])
194

    
195
def send_change_email(ec, request, email_template_name='registration/email_change_email.txt'):
196
    try:
197
        url = reverse('email_change_confirm',
198
                      kwargs={'activation_key':ec.activation_key})
199
        url = request.build_absolute_uri(url)
200
        t = loader.get_template(email_template_name)
201
        c = {'url': url, 'site_name': SITENAME}
202
        from_email = DEFAULT_FROM_EMAIL
203
        send_mail(_("Email change on %s alpha2 testing") % SITENAME,
204
            t.render(Context(c)), from_email, [ec.new_email_address])
205
    except (SMTPException, socket.error) as e:
206
        logger.exception(e)
207
        raise ChangeEmailError()
208
    else:
209
        msg = 'Sent change email for %s' % ec.user.email
210
        logger._log(LOGGING_LEVEL, msg, [])
211

    
212
def activate(user, email_template_name='im/welcome_email.txt'):
213
    """
214
    Activates the specific user and sends email.
215
    
216
    Raises SendGreetingError, ValidationError
217
    """
218
    user.is_active = True
219
    user.save()
220
    send_greeting(user, email_template_name)
221

    
222
def invite(invitation, inviter, email_template_name='im/welcome_email.txt'):
223
    """
224
    Send an invitation email and upon success reduces inviter's invitation by one.
225
    
226
    Raises SendInvitationError
227
    """
228
    invitation.inviter = inviter
229
    invitation.save()
230
    send_invitation(invitation, email_template_name)
231
    inviter.invitations = max(0, inviter.invitations - 1)
232
    inviter.save()
233

    
234
def set_user_credibility(email, has_credits):
235
    try:
236
        user = AstakosUser.objects.get(email=email, is_active=True)
237
        user.has_credits = has_credits
238
        user.save()
239
    except AstakosUser.DoesNotExist, e:
240
        logger.exception(e)
241
    except ValidationError, e:
242
        logger.exception(e)
243

    
244
class SendMailError(Exception):
245
    pass
246

    
247
class SendAdminNotificationError(SendMailError):
248
    def __init__(self):
249
        self.message = _('Failed to send notification')
250
        super(SendAdminNotificationError, self).__init__()
251

    
252
class SendVerificationError(SendMailError):
253
    def __init__(self):
254
        self.message = _('Failed to send verification')
255
        super(SendVerificationError, self).__init__()
256

    
257
class SendInvitationError(SendMailError):
258
    def __init__(self):
259
        self.message = _('Failed to send invitation')
260
        super(SendInvitationError, self).__init__()
261

    
262
class SendGreetingError(SendMailError):
263
    def __init__(self):
264
        self.message = _('Failed to send greeting')
265
        super(SendGreetingError, self).__init__()
266

    
267
class SendFeedbackError(SendMailError):
268
    def __init__(self):
269
        self.message = _('Failed to send feedback')
270
        super(SendFeedbackError, self).__init__()
271

    
272
class ChangeEmailError(SendMailError):
273
    def __init__(self):
274
        self.message = _('Failed to send change email')
275
        super(ChangeEmailError, self).__init__()