app/soc/logic/helper/notifications.py
author Lennard de Rijk <ljvderijk@gmail.com>
Sun, 15 Mar 2009 22:32:05 +0000
changeset 1887 8b71f4e58f39
parent 1648 11c74138c56d
child 1890 a8a5da24212c
permissions -rw-r--r--
Changed notifications helper to properly use the fact that from_user is not a required property. The list template has changed to reflect this. The naming is open for discussion but note that if it is decided to change it that it also needs to be changed in the public.html template. Patch by: Lennard de Rijk Reviewed by: to-be-reviewed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
     1
#!/usr/bin/python2.5
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
     2
#
1308
35b75ffcbb37 Partially reverted "Update the copyright notice for 2009."
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1307
diff changeset
     3
# Copyright 2008 the Melange authors.
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
     4
#
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
     5
# Licensed under the Apache License, Version 2.0 (the "License");
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
     6
# you may not use this file except in compliance with the License.
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
     7
# You may obtain a copy of the License at
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
     8
#
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
     9
#   http://www.apache.org/licenses/LICENSE-2.0
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    10
#
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    11
# Unless required by applicable law or agreed to in writing, software
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    12
# distributed under the License is distributed on an "AS IS" BASIS,
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    13
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    14
# See the License for the specific language governing permissions and
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    15
# limitations under the License.
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    16
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    17
"""Helper functions for sending out notifications.
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    18
"""
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    19
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    20
__authors__ = [
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    21
  '"Lennard de Rijk" <ljvderijk@gmail.com>',
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    22
  ]
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    23
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    24
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    25
import os
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    26
import time
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    27
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    28
from django.template import loader
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    29
from django.utils.encoding import force_unicode
970
8b5611d5b053 Use ugettext instead of ugettext_lazy
Sverre Rabbelier <srabbelier@gmail.com>
parents: 930
diff changeset
    30
from django.utils.translation import ugettext
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    31
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    32
# We cannot import soc.logic.models notification nor user here
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    33
# due to cyclic imports
1548
15caebd3304d Denormalize accounts before trying to send e-mail
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1546
diff changeset
    34
from soc.logic import accounts
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    35
from soc.logic import dicts
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    36
from soc.logic import mail_dispatcher
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    37
from soc.views.helper import redirects
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    38
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    39
import soc.views.models as model_view
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    40
import soc.logic.models as model_logic
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    41
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    42
970
8b5611d5b053 Use ugettext instead of ugettext_lazy
Sverre Rabbelier <srabbelier@gmail.com>
parents: 930
diff changeset
    43
DEF_NEW_NOTIFICATION_MSG = ugettext(
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    44
  "You have received a new Notification.")
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    45
970
8b5611d5b053 Use ugettext instead of ugettext_lazy
Sverre Rabbelier <srabbelier@gmail.com>
parents: 930
diff changeset
    46
DEF_INVITATION_MSG_FMT = ugettext(
915
27c656c01591 Added verbose role name to the request model.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 870
diff changeset
    47
    "Invitation to become a %(role_verbose)s for %(group)s.")
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    48
1138
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
    49
DEF_NEW_GROUP_MSG_FMT = ugettext(
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
    50
    "Your %(application_type)s for %(group_name)s has been accepted.")
821
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
    51
1450
688648dfe42c Use site name and noreply address when sending emails
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
    52
DEF_WELCOME_MSG_FMT = ugettext("Welcome to %(site_name)s, %(name)s,")
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    53
1648
11c74138c56d Remove unused variables and imports, fix too long lines in soc.logic.helper.notifications module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1563
diff changeset
    54
DEF_GROUP_INVITE_NOTIFICATION_TEMPLATE = 'soc/notification/messages/' \
11c74138c56d Remove unused variables and imports, fix too long lines in soc.logic.helper.notifications module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1563
diff changeset
    55
    'invitation.html'
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    56
1138
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
    57
DEF_NEW_GROUP_TEMPLATE = 'soc/group/messages/accepted.html'
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    58
818
ddd102e82107 Fixed whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 792
diff changeset
    59
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    60
def sendInviteNotification(entity):
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    61
  """Sends out an invite notification to the user the request is for.
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    62
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    63
  Args:
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    64
    entity : A request containing the information needed to create the message
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    65
  """
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    66
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    67
  # get the user the request is for
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    68
  properties = {'link_id': entity.link_id }
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    69
  to_user = model_logic.user.logic.getForFields(properties, unique=True)
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    70
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    71
  invitation_url = "http://%(host)s%(index)s" % {
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    72
      'host' : os.environ['HTTP_HOST'],
930
7e88fba647b1 Added missing changes from r1522.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 915
diff changeset
    73
      'index': redirects.getInviteProcessRedirect(entity, None),
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    74
      }
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    75
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    76
  message_properties = {
915
27c656c01591 Added verbose role name to the request model.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 870
diff changeset
    77
      'role_verbose' : entity.role_verbose,
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    78
      'group': entity.scope.name,
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    79
      'invitation_url': invitation_url,
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    80
      }
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
    81
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    82
  subject = DEF_INVITATION_MSG_FMT % {
915
27c656c01591 Added verbose role name to the request model.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 870
diff changeset
    83
      'role_verbose' : entity.role_verbose,
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    84
      'group' : entity.scope.name
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    85
      }
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    86
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    87
  template = DEF_GROUP_INVITE_NOTIFICATION_TEMPLATE
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    88
1887
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
    89
  from_user = model_logic.user.logic.getForCurrentAccount()
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
    90
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
    91
  sendNotification(to_user, from_user, message_properties, subject, template)
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    92
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
    93
1138
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
    94
def sendNewGroupNotification(entity, params):
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
    95
  """Sends out an invite notification to the applicant of the group.
821
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
    96
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
    97
  Args:
1138
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
    98
    entity : An accepted group application
821
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
    99
  """
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   100
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   101
  to_user = entity.applicant
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   102
1138
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
   103
  url = "http://%(host)s%(redirect)s" % {
1511
3342ce7a495c Fix some whitespace damadge and a style fix
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1508
diff changeset
   104
      'redirect': redirects.getApplicantRedirect(entity,
1138
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
   105
      {'url_name': params['group_url_name']}),
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
   106
      'host': os.environ['HTTP_HOST'],
821
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   107
      }
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   108
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   109
  message_properties = {
1533
50fb3a9b6615 Fix for Issue 218.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1512
diff changeset
   110
      'application_type': params['name'],
50fb3a9b6615 Fix for Issue 218.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1512
diff changeset
   111
      'group_type': params['group_name'],
1138
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
   112
      'group_name': entity.name,
821
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   113
      'url': url,
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   114
      }
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   115
1138
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
   116
  subject = DEF_NEW_GROUP_MSG_FMT % {
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
   117
      'application_type': params['name'],
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
   118
      'group_name': entity.name,
821
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   119
      }
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   120
1138
18ef39338211 Refactored review and reviewoverview out of club_app.py
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1115
diff changeset
   121
  template = DEF_NEW_GROUP_TEMPLATE
821
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   122
1887
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
   123
  sendNotification(to_user, None, message_properties, subject, template)
821
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   124
5afe16b2e86b Send a notifcation if a club application is accepted
Sverre Rabbelier <srabbelier@gmail.com>
parents: 820
diff changeset
   125
1887
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
   126
def sendNotification(to_user, from_user, message_properties, subject, template):
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
   127
  """Sends out a notification to the specified user.
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   128
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   129
  Args:
831
cbe033fedde8 Add missing dots in docstrings. Add sendNotification parameters description to docstring in soc.logic.helper module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 821
diff changeset
   130
    to_user : user to which the notification will be send
1887
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
   131
    from_user: user from who sends the notifications (None iff sent by site)
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
   132
    message_properties : message properties
831
cbe033fedde8 Add missing dots in docstrings. Add sendNotification parameters description to docstring in soc.logic.helper module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 821
diff changeset
   133
    subject : subject of notification email
cbe033fedde8 Add missing dots in docstrings. Add sendNotification parameters description to docstring in soc.logic.helper module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 821
diff changeset
   134
    template : template used for generating notification
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   135
  """
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   136
1887
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
   137
  if from_user:
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
   138
    sender_name = from_user.name
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
   139
  else:
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
   140
    site_entity = model_logic.site.logic.getSingleton()
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
   141
    sender_name = 'The %s Team' %(site_entity.site_name)
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   142
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   143
  new_message_properties = {
1887
8b71f4e58f39 Changed notifications helper to properly use the fact that from_user is not a required property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1648
diff changeset
   144
      'sender_name': sender_name,
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   145
      'to_name': to_user.name,
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   146
      }
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   147
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   148
  message_properties = dicts.merge(message_properties, new_message_properties)
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   149
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   150
  message = loader.render_to_string(template, dictionary=message_properties)
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   151
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   152
  fields = {
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   153
      'from_user' : from_user,
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   154
      'subject': subject,
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   155
      'message' : message,
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   156
      'scope' : to_user,
1059
17221b578fe7 prefixing the link_id of a notification with a t for time to agree to the new link_id pattern.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 970
diff changeset
   157
      'link_id' :'t%i' % (time.time()),
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   158
      'scope_path' : to_user.link_id
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   159
  }
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   160
1512
97c4a718d6f4 Remove updateOrCreateFromFields and it's uses
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1511
diff changeset
   161
  key_name = model_logic.notification.logic.getKeyNameFromFields(fields)
820
56eec9c8bb47 Factor out sendNotification from sendInviteNotification
Sverre Rabbelier <srabbelier@gmail.com>
parents: 818
diff changeset
   162
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   163
  # create and put a new notification in the datastore
1512
97c4a718d6f4 Remove updateOrCreateFromFields and it's uses
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1511
diff changeset
   164
  model_logic.notification.logic.updateOrCreateFromKeyName(fields, key_name)
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   165
818
ddd102e82107 Fixed whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 792
diff changeset
   166
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   167
def sendNewNotificationMessage(notification_entity):
831
cbe033fedde8 Add missing dots in docstrings. Add sendNotification parameters description to docstring in soc.logic.helper module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 821
diff changeset
   168
  """Sends an email to a user about a new notification.
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   169
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   170
    Args:
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   171
      notification_entity: Notification about which the message should be sent
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   172
  """
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   173
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   174
  # create the url to show this notification
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   175
  notification_url = "http://%(host)s%(index)s" % {
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   176
      'host' : os.environ['HTTP_HOST'],
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   177
      'index': redirects.getPublicRedirect(notification_entity,
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   178
          model_view.notification.view.getParams())}
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   179
1546
cc54ada3cf1b Using getDefaultMailSender for welcome and notification messages.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1533
diff changeset
   180
  sender = mail_dispatcher.getDefaultMailSender()
1563
1d3db748990a Fixed site_entity not being assigned a value because site_logic was not defined.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1561
diff changeset
   181
  site_entity = model_logic.site.logic.getSingleton()
1561
fe1b141bfc2c Replaced 'Melange' with site_name where appropriate
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1560
diff changeset
   182
  site_name = site_entity.site_name
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   183
1550
a872030dc3ca getDefaultMailSender now returns a tuple (name, email adress).
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1548
diff changeset
   184
  # get the default mail sender
a872030dc3ca getDefaultMailSender now returns a tuple (name, email adress).
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1548
diff changeset
   185
  default_sender = mail_dispatcher.getDefaultMailSender()
a872030dc3ca getDefaultMailSender now returns a tuple (name, email adress).
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1548
diff changeset
   186
a872030dc3ca getDefaultMailSender now returns a tuple (name, email adress).
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1548
diff changeset
   187
  if not default_sender:
1546
cc54ada3cf1b Using getDefaultMailSender for welcome and notification messages.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1533
diff changeset
   188
    # no valid sender found, abort
cc54ada3cf1b Using getDefaultMailSender for welcome and notification messages.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1533
diff changeset
   189
    return
1550
a872030dc3ca getDefaultMailSender now returns a tuple (name, email adress).
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1548
diff changeset
   190
  else:
a872030dc3ca getDefaultMailSender now returns a tuple (name, email adress).
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1548
diff changeset
   191
    (sender_name, sender) = default_sender
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   192
1548
15caebd3304d Denormalize accounts before trying to send e-mail
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1546
diff changeset
   193
  to = accounts.denormalizeAccount(notification_entity.scope.account).email()
15caebd3304d Denormalize accounts before trying to send e-mail
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1546
diff changeset
   194
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   195
  # create the message contents
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   196
  messageProperties = {
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   197
      'to_name': notification_entity.scope.name,
1550
a872030dc3ca getDefaultMailSender now returns a tuple (name, email adress).
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1548
diff changeset
   198
      'sender_name': sender_name,
1548
15caebd3304d Denormalize accounts before trying to send e-mail
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1546
diff changeset
   199
      'to': to,
1546
cc54ada3cf1b Using getDefaultMailSender for welcome and notification messages.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1533
diff changeset
   200
      'sender': sender,
1561
fe1b141bfc2c Replaced 'Melange' with site_name where appropriate
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1560
diff changeset
   201
      'site_name': site_name,
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   202
      'subject': force_unicode(DEF_NEW_NOTIFICATION_MSG),
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   203
      'notification' : notification_entity,
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   204
      'notification_url' : notification_url
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   205
      }
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   206
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   207
  # send out the message using the default new notification template
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   208
  mail_dispatcher.sendMailFromTemplate('soc/mail/new_notification.html',
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   209
                                       messageProperties)
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   210
818
ddd102e82107 Fixed whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 792
diff changeset
   211
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   212
def sendWelcomeMessage(user_entity):
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   213
  """Sends out a welcome message to a user.
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   214
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   215
    Args:
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   216
      user_entity: User entity which the message should be send to
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   217
  """
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   218
1546
cc54ada3cf1b Using getDefaultMailSender for welcome and notification messages.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1533
diff changeset
   219
  # get site name
cc54ada3cf1b Using getDefaultMailSender for welcome and notification messages.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1533
diff changeset
   220
  site_entity = model_logic.site.logic.getSingleton()
1450
688648dfe42c Use site name and noreply address when sending emails
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   221
  site_name = site_entity.site_name
688648dfe42c Use site name and noreply address when sending emails
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   222
1546
cc54ada3cf1b Using getDefaultMailSender for welcome and notification messages.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1533
diff changeset
   223
  # get the default mail sender
1550
a872030dc3ca getDefaultMailSender now returns a tuple (name, email adress).
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1548
diff changeset
   224
  default_sender = mail_dispatcher.getDefaultMailSender()
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   225
1550
a872030dc3ca getDefaultMailSender now returns a tuple (name, email adress).
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1548
diff changeset
   226
  if not default_sender:
1546
cc54ada3cf1b Using getDefaultMailSender for welcome and notification messages.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1533
diff changeset
   227
    # no valid sender found, should not happen but abort anyway
cc54ada3cf1b Using getDefaultMailSender for welcome and notification messages.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1533
diff changeset
   228
    return
1550
a872030dc3ca getDefaultMailSender now returns a tuple (name, email adress).
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1548
diff changeset
   229
  else:
1560
656aace0b15f Catch mail exceptions and use get_current_user
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1550
diff changeset
   230
    sender_name, sender = default_sender
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   231
1548
15caebd3304d Denormalize accounts before trying to send e-mail
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1546
diff changeset
   232
  to = accounts.denormalizeAccount(user_entity.account).email()
15caebd3304d Denormalize accounts before trying to send e-mail
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1546
diff changeset
   233
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   234
  # create the message contents
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   235
  messageProperties = {
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   236
      'to_name': user_entity.name,
1550
a872030dc3ca getDefaultMailSender now returns a tuple (name, email adress).
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1548
diff changeset
   237
      'sender_name': sender_name,
1450
688648dfe42c Use site name and noreply address when sending emails
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   238
      'site_name': site_name,
1548
15caebd3304d Denormalize accounts before trying to send e-mail
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1546
diff changeset
   239
      'to': to,
1546
cc54ada3cf1b Using getDefaultMailSender for welcome and notification messages.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1533
diff changeset
   240
      'sender': sender,
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   241
      'subject': DEF_WELCOME_MSG_FMT % {
1450
688648dfe42c Use site name and noreply address when sending emails
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   242
          'site_name': site_name,
792
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   243
          'name': user_entity.name
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   244
          }
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   245
      }
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   246
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   247
  # send out the message using the default welcome template
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   248
  mail_dispatcher.sendMailFromTemplate('soc/mail/welcome.html',
3cc6bea5c632 Fixed line-ending and whitespace damage
Sverre Rabbelier <srabbelier@gmail.com>
parents: 784
diff changeset
   249
                                       messageProperties)