fix: update unregistered contributor notifications and email templates

Author: Ostap-Zherebetskyi

api/nodes/serializers.py

@@ -28,7 +28,7 @@
 from django.core.exceptions import ValidationError
 from framework.auth.core import Auth
 from framework.exceptions import PermissionsError
-from osf.models import Tag, CollectionSubmission, NotificationType, OSFUser
+from osf.models import Tag, CollectionSubmission
 from rest_framework import serializers as ser
 from rest_framework import exceptions
 from addons.base.exceptions import InvalidAuthError, InvalidFolderError
@@ -1269,19 +1269,9 @@ def create(self, validated_data):
         if email_pref not in self.email_preferences:
             raise exceptions.ValidationError(f'{email_pref} is not a valid email preference.')
 
-        is_published = getattr(resource, 'is_published', False)
-        notification_type = {
-            'false': False,
-            'default': NotificationType.Type.NODE_CONTRIBUTOR_ADDED_DEFAULT,
-            'draft_registration': NotificationType.Type.DRAFT_REGISTRATION_CONTRIBUTOR_ADDED_DEFAULT,
-            'preprint': NotificationType.Type.PREPRINT_CONTRIBUTOR_ADDED_DEFAULT if is_published else False,
-        }.get(email_pref, False)
-        contributor = OSFUser.load(user_id)
-        notification_type = notification_type if email or (contributor and contributor.is_registered) else False
-
         try:
             contributor_dict = {
-                'auth': auth, 'user_id': user_id, 'email': email, 'full_name': full_name, 'notification_type': notification_type,
+                'auth': auth, 'user_id': user_id, 'email': email, 'full_name': full_name,
                 'bibliographic': bibliographic, 'index': index, 'permissions': permissions,
             }
             contributor_obj = resource.add_contributor_registered_or_not(**contributor_dict)

notifications.yaml

@@ -109,14 +109,14 @@ notification_types:
     tests: ['osf_tests/test_institution.py']
     template: 'website/templates/institution_deactivation.html.mako'
 
-  - name: user_invite_preprints_osf
+  - name: user_invite_osf_preprint
     subject: 'You have been added as a contributor to an OSF preprint.'
     __docs__: ...
     object_content_type_model_name: osfuser
     tests: []
     template: 'website/templates/invite_preprints_osf.html.mako'
 
-  - name: user_invite_preprints
+  - name: provider_user_invite_preprint
     subject: 'You have been invited to contribute to a preprint'
     __docs__: ...
     object_content_type_model_name: osfuser

osf/models/mixins.py

@@ -1499,7 +1499,6 @@ def add_contributors(
             auth=None,
             log=True,
             save=False,
-            notification_type=NotificationType.Type.NODE_CONTRIBUTOR_ADDED_DEFAULT
     ):
         """Add multiple contributors
 
@@ -1521,7 +1520,6 @@ def add_contributors(
                 auth=auth,
                 log=False,
                 save=False,
-                notification_type=notification_type
             )
         if log and contributors:
             params = self.log_params
@@ -1543,7 +1541,6 @@ def add_unregistered_contributor(
             fullname,
             email,
             auth,
-            notification_type=False,
             visible=True,
             permissions=None,
             existing_user=None
@@ -1592,6 +1589,18 @@ def add_unregistered_contributor(
             else:
                 raise e
 
+        from osf.models import AbstractNode, Preprint, DraftRegistration
+
+        if isinstance(self, AbstractNode):
+            notification_type = NotificationType.Type.USER_INVITE_DEFAULT
+        elif isinstance(self, Preprint):
+            if self.provider.is_default:
+                notification_type = NotificationType.Type.USER_INVITE_OSF_PREPRINT
+            else:
+                notification_type = NotificationType.Type.PROVIDER_USER_INVITE_PREPRINT
+        elif isinstance(self, DraftRegistration):
+            notification_type = NotificationType.Type.USER_INVITE_DRAFT_REGISTRATION
+
         self.add_contributor(
             contributor,
             permissions=permissions,
@@ -1610,7 +1619,6 @@ def add_contributor_registered_or_not(self,
                                           user_id=None,
                                           full_name=None,
                                           email=None,
-                                          notification_type=None,
                                           permissions=None,
                                           bibliographic=True,
                                           index=None):
@@ -1629,7 +1637,6 @@ def add_contributor_registered_or_not(self,
                     auth=auth,
                     visible=bibliographic,
                     permissions=permissions,
-                    notification_type=notification_type,
                     save=True
                 )
             else:
@@ -1642,7 +1649,6 @@ def add_contributor_registered_or_not(self,
                     fullname=full_name,
                     email=contributor.username,
                     auth=auth,
-                    notification_type=notification_type,
                     permissions=permissions,
                     visible=bibliographic,
                     existing_user=contributor,
@@ -1658,7 +1664,6 @@ def add_contributor_registered_or_not(self,
                     contributor=contributor,
                     auth=auth,
                     visible=bibliographic,
-                    notification_type=notification_type,
                     permissions=permissions,
                     save=True
                 )
@@ -1667,7 +1672,6 @@ def add_contributor_registered_or_not(self,
                     fullname=full_name,
                     email=email,
                     auth=auth,
-                    notification_type=notification_type,
                     permissions=permissions,
                     visible=bibliographic
                 )

website/project/views/contributor.py

@@ -629,6 +629,10 @@ def notify_added_contributor(resource, contributor, notification_type, auth=None
     throttle = kwargs.get('throttle', settings.CONTRIBUTOR_ADDED_EMAIL_THROTTLE)
     if notification_type and check_email_throttle(contributor, notification_type, throttle=throttle):
         return
+
+    claim_url = None
+    if not contributor.is_confirmed:
+        claim_url = contributor.get_claim_url(resource._primary_key, external=True)
     referrer_name = getattr(getattr(auth, 'user', None), 'fullname', '') if auth else ''
     notification_type.instance.emit(
         user=contributor,
@@ -651,7 +655,8 @@ def notify_added_contributor(resource, contributor, notification_type, auth=None
             'can_change_preferences': False,
             'logo': logo,
             'osf_contact_email': settings.OSF_CONTACT_EMAIL,
-            'preprint_list': ''.join(f"- {p['absolute_url']}\n" for p in serialize_preprints(resource, user=None)) if isinstance(resource, Node) else '- (none)\n'
+            'preprint_list': ''.join(f"- {p['absolute_url']}\n" for p in serialize_preprints(resource, user=None)) if isinstance(resource, Node) else '- (none)\n',
+            'claim_url': claim_url,
         }
     )
 

website/templates/contributor_added_preprints_osf.html.mako

@@ -5,9 +5,9 @@
   <td style="border-collapse: collapse;">
     Hello ${user_fullname},<br>
     <br>
-    ${referrer_text}} to the preprint "${node_title}" on the Open Science Framework: ${node_absolute_url}<br>
+    ${referrer_text} to the preprint <a href="${node_absolute_url}">${node_title}</a> on the Open Science Framework.<br>
     <br>
-    If you are erroneously being associated with "${node_title}," then you may visit the preprint and remove yourself as a contributor.<br>
+    If you are erroneously being associated with <a href="${node_absolute_url}">${node_title}</a>, then you may visit the preprint and remove yourself as a contributor.<br>
     <br>
     Sincerely,<br>
     <br>

website/templates/invite_default.html.mako

@@ -8,17 +8,15 @@
     %>
     Hello ${user_fullname},<br>
     <br>
-    You have been added by ${referrer_fullname} as a contributor to the project "${node_title}" on the Open Science Framework. To set a password for your account, visit:<br>
+    You have been added by ${referrer_name} as a contributor to the project <a href="${node_absolute_url}">${node_title}</a> on the Open Science Framework.<br>
     <br>
-    ${claim_url}<br>
+    <a href="${claim_url}">Click here</a> to set a password for your account.<br>
     <br>
-    Once you have set a password, you will be able to make contributions to "${node_title}" and create your own projects. You will automatically be subscribed to notification emails for this project. To change your email notification preferences, visit your project or your user settings: ${domain + "settings/notifications/"}<br>
-    <br>
-    To preview "${node_title}" click the following link: ${node_absolute_url}<br>
+    Once you have set a password, you will be able to make contributions to <a href="${node_absolute_url}">${node_title}</a> and create your own projects. You will automatically be subscribed to notification emails for this project. To change your email notification preferences, visit your project or your user <a href="${domain + "settings/notifications/"}">settings</a><br>
     <br>
     (NOTE: if this project is private, you will not be able to view it until you have confirmed your account)<br>
     <br>
-    If you are not ${user_fullname} or you are erroneously being associated with "${node_title}" then email ${osf_contact_email} with the subject line "Claiming Error" to report the problem.<br>
+    If you are not ${user_fullname} or you are erroneously being associated with <a href="${node_absolute_url}">${node_title}</a> then email ${osf_contact_email} with the subject line "Claiming Error" to report the problem.<br>
     <br>
     Sincerely,<br>
     <br>

website/templates/invite_draft_registration.html.mako

@@ -5,14 +5,14 @@
   <td style="border-collapse: collapse;">
     Hello ${user_fullname},
     <p>
-    ${referrer_fullname} has added you as a contributor on
-    % if not node.title or node.title == 'Untitled':
+    ${referrer_name} has added you as a contributor on
+    % if not node_title or node_title == 'Untitled':
       <a href="${node_absolute_url}">a new registration draft</a>
     % else:
       a new registration draft titled <a href="${node_absolute_url}">${node_title}</a>
     % endif
     to be submitted for inclusion in the
-	<a href="${domain}/registries/${node_provider__id if node.provider else 'osf'}">${registry_text}</a>.
+	<a href="${domain}/registries/${branded_service__id if branded_service__id else 'osf'}">${registry_text}</a>.
     </p>
     <p>
     <a href="${claim_url}">Click here</a> to set a password for your account.
@@ -24,7 +24,7 @@
     </p>
     <p>
     If you are not ${user_fullname} or if you have been erroneously associated with
-    % if not node.title or node.title == 'Untitled':
+    % if not node_title or node_title == 'Untitled':
 	  this registration draft
     % else:
       "${node_title}"

website/templates/invite_preprints.html.mako

@@ -5,25 +5,23 @@
   <td style="border-collapse: collapse;">
     Hello ${user_fullname},<br>
     <br>
-    You have been added by ${referrer_fullname} as a contributor to the ${branded_service_preprint_word} "${node_title}" on ${branded_service_name}, powered by the Open Science Framework. To set a password for your account, visit:<br>
+    You have been added by ${referrer_name} as a contributor to the ${branded_service_preprint_word}  <a href="${node_absolute_url}">${node_title}</a> on ${branded_service_name}, powered by the Open Science Framework.<br>
     <br>
-    ${claim_url}<br>
+    <a href="${claim_url}">Click here</a> to set a password for your account.<br>
     <br>
-    Once you have set a password, you will be able to make contributions to "${node_title}" and create your own ${branded_service_preprint_word}. You will automatically be subscribed to notification emails for this ${branded_service_preprint_word}. To change your email notification preferences, visit your user settings: ${domain + "settings/notifications/"}<br>
-    <br>
-    To preview "${node_title}" click the following link: ${node_absolute_url}<br>
+    Once you have set a password, you will be able to make contributions to <a href="${node_absolute_url}">${node_title}</a> and create your own ${branded_service_preprint_word}. You will automatically be subscribed to notification emails for this ${branded_service_preprint_word}. To change your email notification preferences, visit your user <a href="${domain + "settings/notifications/"}">settings</a><br>
     <br>
     (NOTE: if this preprint is unpublished, you will not be able to view it until you have confirmed your account)<br>
     <br>
-    If you are not ${user_fullname} or you have been erroneously associated with "${node_title}", then email contact+${branded_service._id}@osf.io with the subject line "Claiming Error" to report the problem.<br>
+    If you are not ${user_fullname} or you have been erroneously associated with <a href="${node_absolute_url}">${node_title}</a>, then email contact+${branded_service__id}@osf.io with the subject line "Claiming Error" to report the problem.<br>
     <br>
     Sincerely,<br>
     <br>
     Your ${branded_service_name} and OSF teams<br>
     <br>
-    Want more information? Visit https://osf.io/preprints/${branded_service._id} to learn about ${branded_service_name} or https://osf.io/ to learn about the Open Science Framework, or https://cos.io/ for information about its supporting organization, the Center for Open Science.<br>
+    Want more information? Visit https://osf.io/preprints/${branded_service__id} to learn about ${branded_service_name} or https://osf.io/ to learn about the Open Science Framework, or https://cos.io/ for information about its supporting organization, the Center for Open Science.<br>
     <br>
-    Questions? Email support+${branded_service._id}@osf.io<br>
+    Questions? Email support+${branded_service__id}@osf.io<br>
 
 </tr>
 </%def>

website/templates/invite_preprints_osf.html.mako

@@ -5,17 +5,15 @@
   <td style="border-collapse: collapse;">
     Hello ${user_fullname},<br>
     <br>
-    You have been added by ${referrer_fullname} as a contributor to the preprint "${node_title}" on the Open Science Framework. To set a password for your account, visit:<br>
+    You have been added by ${referrer_name} as a contributor to the preprint <a href="${node_absolute_url}">${node_title}</a> on the Open Science Framework.<br>
     <br>
-    ${claim_url}<br>
+    <a href="${claim_url}">Click here</a> to set a password for your account.<br>
     <br>
-    Once you have set a password, you will be able to make contributions to "${node_title}" and create your own preprints and projects. You will automatically be subscribed to notification emails for this preprint. To change your email notification preferences, visit your user settings: ${domain + "settings/notifications/"}<br>
-    <br>
-    To preview "${node_title}" click the following link: ${node_absolute_url}<br>
+    Once you have set a password, you will be able to make contributions to  <a href="${node_absolute_url}">${node_title}</a> and create your own preprints and projects. You will automatically be subscribed to notification emails for this preprint. To change your email notification preferences, visit your user <a href="${domain + "settings/notifications/"}">settings</a><br>
     <br>
     (NOTE: if this preprint is unpublished, you will not be able to view it until you have confirmed your account)<br>
     <br>
-    If you are not ${user_fullname} or you are erroneously being associated with "${node_title}" then email ${osf_contact_email} with the subject line "Claiming Error" to report the problem.<br>
+    If you are not ${user_fullname} or you are erroneously being associated with  <a href="${node_absolute_url}">${node_title}</a> then email ${osf_contact_email} with the subject line "Claiming Error" to report the problem.<br>
     <br>
     Sincerely,<br>
     <br>