add bulk add_contributor_registered_or_not method

Author: antkryt

api/nodes/serializers.py

@@ -1226,104 +1226,80 @@ def create(self, validated_data):
         node = self.context['resource']
         auth = Auth(request.user)
 
-        with transaction.atomic():
-            results = []
-            registered_items = []
-            unregistered_items = []
-
-            for item in validated_data:
-                if item.get('_id') and not item.get('user', {}).get('email'):
-                    registered_items.append(item)
-                else:
-                    unregistered_items.append(item)
-
-            def _perm(item):
-                return osf_permissions.get_contributor_proposed_permissions(item)
-
-            if registered_items:
-                # Load users once and build a mapping to reuse
-                user_map = {}
-                for item in registered_items:
-                    user_id = item.get('_id')
-                    if user_id and user_id not in user_map:
-                        user = OSFUser.load(user_id)
-                        if not user:
-                            raise exceptions.NotFound(detail=f"User {user_id} not found")
-                        user_map[user_id] = user
-
-                contrib_dicts = []
-                for item in registered_items:
-                    user = user_map[item.get('_id')]
-                    contrib_dicts.append({
-                        'user': user,
-                        'permissions': _perm(item),
-                        'visible': item.get('bibliographic'),
-                    })
-                contribs = node.add_contributors(contrib_dicts, auth=auth, log=True, save=True)
-                results.extend(contribs)
-
-                child_to_items = {}
-                for item in registered_items:
-                    child_nodes = item.get('child_nodes')
-                    if child_nodes:
-                        for child_id in child_nodes:
-                            child_to_items.setdefault(child_id, []).append(item)
-
-                for child_id, items in child_to_items.items():
-                    child = AbstractNode.load(child_id)
-                    if not child:
-                        continue
-                    child_contribs = []
-                    for item in items:
-                        child_contribs.append({
-                            'user': user_map[item.get('_id')],
-                            'permissions': _perm(item),
-                            'visible': item.get('bibliographic'),
-                        })
-                    child.add_contributors(child_contribs, auth=auth, log=True, save=True)
-
-            for item in unregistered_items:
-                id = item.get('_id')
+        def _perm(item):
+            return osf_permissions.get_contributor_proposed_permissions(item)
+
+        send_email_default = request.GET.get('send_email') or self.context['default_email']
+        # Preload users once and pass through to the bulk method (also reused for children)
+        user_ids = {item.get('_id') for item in validated_data if item.get('_id')}
+        user_map = {}
+        if user_ids:
+            for u in OSFUser.objects.filter(guids___id__in=user_ids):
+                user_map[u._id] = u
+
+        payload = []
+        for item in validated_data:
+            uid = item.get('_id')
+            user = user_map.get(uid)
+            email = item.get('user', {}).get('email', None)
+            full_name = item.get('full_name') or (user.fullname if user and not user.is_registered else None)
+            if not uid and not full_name:
+                raise exceptions.ValidationError(detail='A user ID or full name must be provided to add a contributor.')
+            payload.append({
+                'user_id': uid,
+                'user': user,
+                'email': email,
+                'full_name': full_name,
+                'send_email': send_email_default,
+                'permissions': _perm(item),
+                'bibliographic': item.get('bibliographic'),
+                'index': item.get('_order') if '_order' in item else None,
+            })
+
+        try:
+            contribs = node.add_contributors_registered_or_not(payload, auth=auth, save=True)
+        except ValidationError as e:
+            raise exceptions.ValidationError(detail=e.messages[0])
+        except ValueError as e:
+            raise exceptions.NotFound(detail=e.args[0])
+
+        child_to_items = {}
+        for item in validated_data:
+            child_nodes = item.get('child_nodes')
+            if child_nodes:
+                for child_id in child_nodes:
+                    child_to_items.setdefault(child_id, []).append(item)
+
+        for child_id, items in child_to_items.items():
+            child = AbstractNode.load(child_id)
+            if not child:
+                continue
+            child_payload = []
+            for item in items:
+                uid = item.get('_id')
+                user = user_map.get(uid)
                 email = item.get('user', {}).get('email', None)
-                full_name = item.get('full_name')
-                bibliographic = item.get('bibliographic')
-                index = item.get('_order') if '_order' in item else None
-                send_email = request.GET.get('send_email') or self.context['default_email']
-                permissions = _perm(item)
+                full_name = item.get('full_name') or (user.fullname if user and not user.is_registered else None)
+                if not uid and not full_name:
+                    raise exceptions.ValidationError(detail='A user ID or full name must be provided to add a contributor.')
+                child_payload.append({
+                    'user_id': uid,
+                    'user': user,
+                    'email': email,
+                    'full_name': full_name,
+                    'send_email': send_email_default,
+                    'permissions': _perm(item),
+                    'bibliographic': item.get('bibliographic'),
+                    'index': item.get('_order') if '_order' in item else None,
+                })
+            try:
+                child.add_contributors_registered_or_not(child_payload, auth=auth, save=True)
+            except ValidationError as e:
+                raise exceptions.ValidationError(detail=e.messages[0])
+            except ValueError as e:
+                raise exceptions.NotFound(detail=e.args[0])
 
-                try:
-                    contributor_obj = node.add_contributor_registered_or_not(
-                        auth=auth,
-                        user_id=id,
-                        email=email,
-                        full_name=full_name,
-                        send_email=send_email,
-                        permissions=permissions,
-                        bibliographic=bibliographic,
-                        index=index,
-                        save=True,
-                    )
-                    results.append(contributor_obj)
-                    child_nodes = item.get('child_nodes')
-                    if child_nodes:
-                        for child in AbstractNode.objects.filter(guids___id__in=child_nodes):
-                            child.add_contributor_registered_or_not(
-                                auth=auth,
-                                user_id=id,
-                                email=email,
-                                full_name=full_name,
-                                send_email=send_email,
-                                permissions=permissions,
-                                bibliographic=bibliographic,
-                                index=index,
-                                save=True,
-                            )
-                except ValidationError as e:
-                    raise exceptions.ValidationError(detail=e.messages[0])
-                except ValueError as e:
-                    raise exceptions.NotFound(detail=e.args[0])
-
-            return results
+        return contribs
 
 
 class NodeContributorsCreateSerializer(NodeContributorsSerializer):

osf/models/mixins.py

@@ -1507,7 +1507,8 @@ def add_contributors(self, contributors, auth=None, log=True, save=False):
         return self.contributor_set.filter(user__in=users)
 
     def add_unregistered_contributor(self, fullname, email, auth, send_email=None,
-                                     visible=True, permissions=None, save=True, existing_user=None):
+                                     visible=True, permissions=None, save=True, existing_user=None,
+                                     log=True):
         """Add a non-registered contributor to the project.
 
         :param str fullname: The full name of the person.
@@ -1555,7 +1556,7 @@ def add_unregistered_contributor(self, fullname, email, auth, send_email=None,
 
         self.add_contributor(
             contributor, permissions=permissions, auth=auth,
-            visible=visible, send_email=send_email, log=True, save=False
+            visible=visible, send_email=send_email, log=log, save=False
         )
         self._add_related_source_tags(contributor)
         if save:
@@ -1564,12 +1565,13 @@ def add_unregistered_contributor(self, fullname, email, auth, send_email=None,
 
     def add_contributor_registered_or_not(self, auth, user_id=None,
                                           full_name=None, email=None, send_email=None,
-                                          permissions=None, bibliographic=True, index=None, save=True):
+                                          permissions=None, bibliographic=True, index=None, save=True,
+                                          user=None, log=True):
         OSFUser = apps.get_model('osf.OSFUser')
         send_email = send_email or self.contributor_email_template
 
         if user_id:
-            contributor = OSFUser.load(user_id)
+            contributor = user or OSFUser.load(user_id)
             if not contributor:
                 raise ValueError(f'User with id {user_id} was not found.')
 
@@ -1578,7 +1580,7 @@ def add_contributor_registered_or_not(self, auth, user_id=None,
 
             if contributor.is_registered:
                 contributor = self.add_contributor(contributor=contributor, auth=auth, visible=bibliographic,
-                                                   permissions=permissions, send_email=send_email, save=save)
+                                                   permissions=permissions, send_email=send_email, save=save, log=log)
             else:
                 if not full_name:
                     raise ValueError(
@@ -1588,7 +1590,7 @@ def add_contributor_registered_or_not(self, auth, user_id=None,
                 contributor = self.add_unregistered_contributor(
                     fullname=full_name, email=contributor.username, auth=auth,
                     send_email=send_email, permissions=permissions,
-                    visible=bibliographic, existing_user=contributor, save=save
+                    visible=bibliographic, existing_user=contributor, save=save, log=log
                 )
 
         else:
@@ -1604,12 +1606,13 @@ def add_contributor_registered_or_not(self, auth, user_id=None,
                     send_email=send_email,
                     permissions=permissions,
                     save=save,
+                    log=log,
                 )
             else:
                 contributor = self.add_unregistered_contributor(
                     fullname=full_name, email=email, auth=auth,
                     send_email=send_email, permissions=permissions,
-                    visible=bibliographic, save=save
+                    visible=bibliographic, save=save, log=log
                 )
 
         auth.user.email_last_sent = timezone.now()
@@ -1621,6 +1624,55 @@ def add_contributor_registered_or_not(self, auth, user_id=None,
         contributor_obj = self.contributor_set.get(user=contributor)
         return contributor_obj
 
+    def add_contributors_registered_or_not(self, contributors, auth=None, log=True, save=False):
+        """Add multiple contributors using the unified registered-or-not path.
+
+        Each item should be a dictionary with keys compatible with
+        `add_contributor_registered_or_not`, e.g.:
+            {
+                'user_id': '<user guid>',
+                'user': '<OSFUser>' or None,
+                'email': '<email>' or None,
+                'full_name': '<full name>' or None,
+                'send_email': '<email preference>' or None,
+                'permissions': <permission string>,
+                'bibliographic': <bool>,
+                'index': <int or None>,
+            }
+        """
+        results = []
+
+        for item in contributors:
+            contributor_obj = self.add_contributor_registered_or_not(
+                auth=auth,
+                user_id=item.get('user_id'),
+                user=item.get('user'),
+                full_name=item.get('full_name'),
+                email=item.get('email'),
+                send_email=item.get('send_email') or getattr(self, 'contributor_email_template', None),
+                permissions=item.get('permissions'),
+                bibliographic=item.get('bibliographic', True),
+                index=item.get('index'),
+                save=False,
+                log=False,
+            )
+            results.append(contributor_obj)
+
+        if log and results:
+            params = self.log_params
+            params['contributors'] = [c.user._id for c in results]
+            self.add_log(
+                action=self.log_class.CONTRIB_ADDED,
+                params=params,
+                auth=auth,
+                save=False,
+            )
+
+        if save:
+            self.save()
+
+        return results
+
     def replace_contributor(self, old, new):
         """
         Replacing unregistered contributor with a verified user