Merge pull request #11162 from opaduchak/fix/ENG-8145

[ENG-8145] Added manual doi setting for registrations and preprints

Author: cslzchen

api/preprints/serializers.py

@@ -38,7 +38,9 @@
 from api.institutions.utils import update_institutions_if_user_associated
 from api.preprints.fields import DOIField
 from api.taxonomies.serializers import TaxonomizableSerializerMixin
+from api.waffle.utils import flag_is_active
 from framework.exceptions import PermissionsError, UnpublishedPendingPreprintVersionExists
+from osf import features
 from website.project import signals as project_signals
 from osf.exceptions import NodeStateError, PreprintStateError
 from osf.models import (
@@ -106,7 +108,6 @@ class PreprintSerializer(TaxonomizableSerializerMixin, MetricsSerializerMixin, J
     ])
 
     id = IDField(source='_id', read_only=True)
-    manual_guid = ser.CharField(write_only=True, required=False, allow_null=True)
     type = TypeField()
 
     date_created = VersionedDateTimeField(source='created', read_only=True)
@@ -500,17 +501,25 @@ class PreprintCreateSerializer(PreprintSerializer):
     # Overrides PreprintSerializer to make id nullable, adds `create`
     # TODO: add better Docstrings
     id = IDField(source='_id', required=False, allow_null=True)
+    manual_guid = ser.CharField(write_only=True, required=False, allow_null=True)
+    manual_doi = ser.CharField(write_only=True, required=False, allow_null=True)
 
     def create(self, validated_data):
 
-        guid_str = validated_data.pop('manual_guid', None)
         creator = self.context['request'].user
         provider = validated_data.pop('provider', None)
         if not provider:
             raise exceptions.ValidationError(detail='You must specify a valid provider to create a preprint.')
         title = validated_data.pop('title')
         description = validated_data.pop('description', '')
-        preprint = Preprint.create(provider=provider, title=title, creator=creator, description=description, guid_str=guid_str)
+
+        # For manual GUID and DOI assignment during creation for privileged users
+        manual_guid = validated_data.pop('manual_guid', None)
+        manual_doi = validated_data.pop('manual_doi', None)
+        if manual_doi and not flag_is_active(self.context['request'], features.MANUAL_DOI_AND_GUID):
+            raise exceptions.ValidationError(detail='Manual DOI assignment is not allowed.')
+
+        preprint = Preprint.create(provider=provider, title=title, creator=creator, description=description, manual_guid=manual_guid, manual_doi=manual_doi)
 
         return self.update(preprint, validated_data)
 

api/registrations/serializers.py

@@ -1,5 +1,8 @@
 import pytz
 import json
+
+from api.waffle.utils import flag_is_active
+from osf import features
 from website.archiver.utils import normalize_unicode_filenames
 
 from packaging.version import Version
@@ -83,7 +86,6 @@ class RegistrationSerializer(NodeSerializer):
         'has_supplements',
     ])
 
-    manual_guid = ser.CharField(write_only=True, required=False, allow_null=True)
     ia_url = ser.URLField(read_only=True)
     reviews_state = ser.CharField(source='moderation_state', read_only=True)
     title = ser.CharField(required=False)
@@ -734,6 +736,10 @@ def __init__(self, *args, **kwargs):
         else:
             self.fields['draft_registration'] = ser.CharField(write_only=True)
 
+    # For manual GUID and DOI assignment during creation for privileged users
+    manual_guid = ser.CharField(write_only=True, required=False, allow_null=True)
+    manual_doi = ser.CharField(write_only=True, required=False, allow_null=True)
+
     # For newer versions
     embargo_end_date = VersionedDateTimeField(write_only=True, allow_null=True, default=None)
     included_node_ids = ser.ListField(write_only=True, required=False)
@@ -788,7 +794,7 @@ def get_children_by_version(self, validated_data):
 
     def create(self, validated_data):
 
-        guid_str = validated_data.pop('manual_guid', None)
+        manual_guid = validated_data.pop('manual_guid', None)
         auth = get_user_auth(self.context['request'])
         draft = validated_data.pop('draft', None)
         registration_choice = self.get_registration_choice_by_version(validated_data)
@@ -813,7 +819,7 @@ def create(self, validated_data):
             )
 
         try:
-            registration = draft.register(auth, save=True, child_ids=children, guid_str=guid_str)
+            registration = draft.register(auth, save=True, child_ids=children, manual_guid=manual_guid)
         except NodeStateError as err:
             raise exceptions.ValidationError(err)
 
@@ -826,6 +832,11 @@ def create(self, validated_data):
             except ValidationError as err:
                 raise exceptions.ValidationError(err.message)
         else:
+            manual_doi = validated_data.pop('manual_doi', None)
+            if manual_doi:
+                if not flag_is_active(self.context['request'], features.MANUAL_DOI_AND_GUID):
+                    raise exceptions.ValidationError(detail='Manual DOI assignment is not allowed.')
+                registration.set_identifier_value('doi', manual_doi)
             try:
                 registration.require_approval(auth.user)
             except NodeStateError as err:

osf/features.yaml

@@ -12,6 +12,12 @@
 # 5. When a flag name is no longer referenced anywhere in this repo or in the Ember app remove it from this list.
 flags:
 
+  - flag_name: MANUAL_DOI_AND_GUID
+    name: manual_doi_and_guid
+    note: This is used to allow certain product staff members to manually assign doi and guid during Registration or
+          Preprint creation. DO NOT CHANGE UNLESS ABSOLUTELY NECESSARY.
+    everyone: false
+
   - flag_name: ENABLE_GV
     name: gravy_waffle
     note: This is used to enable GravyValet, the system responible for addons, this will remove the files widget on the

osf/models/draft_node.py

@@ -58,7 +58,7 @@ def convert_draft_node_to_node(self, auth):
         )
         return
 
-    def register_node(self, schema, auth, draft_registration, parent=None, child_ids=None, provider=None, guid_str=None):
+    def register_node(self, schema, auth, draft_registration, parent=None, child_ids=None, provider=None, manual_guid=None):
         """Converts the DraftNode to a Node, copies editable fields from the DraftRegistration back to the Node,
          and then registers the Node
 
@@ -73,4 +73,4 @@ def register_node(self, schema, auth, draft_registration, parent=None, child_ids
         self.copy_editable_fields(draft_registration, save=True)
 
         # Calls super on Node, since self is no longer a DraftNode
-        return super(Node, self).register_node(schema, auth, draft_registration, parent, child_ids, provider, guid_str)
+        return super(Node, self).register_node(schema, auth, draft_registration, parent=parent, child_ids=child_ids, provider=provider, manual_guid=manual_guid)

osf/models/node.py

@@ -1395,7 +1395,7 @@ def subscribe_contributors_to_node(self):
                                                    contributor=user,
                                                    auth=None, email_template='default', permissions=perm)
 
-    def register_node(self, schema, auth, draft_registration, parent=None, child_ids=None, provider=None, guid_str=None):
+    def register_node(self, schema, auth, draft_registration, parent=None, child_ids=None, provider=None, manual_guid=None):
         """Make a frozen copy of a node.
 
         :param schema: Schema object
@@ -1439,12 +1439,12 @@ def register_node(self, schema, auth, draft_registration, parent=None, child_ids
         # Need to save here in order to set many-to-many fields, set is_public to false to avoid Spam filter/reindexing.
         registered.is_public = False
 
-        if guid_str:
-            if not check_manually_assigned_guid(guid_str):
-                raise ValidationError(f'GUID cannot be manually assigned: guid_str={guid_str}.')
+        if manual_guid:
+            if not check_manually_assigned_guid(manual_guid):
+                raise ValidationError(f'GUID cannot be manually assigned: guid_str={manual_guid}.')
             from osf.models import Guid
-            guid_obj = Guid.objects.create(_id=guid_str)
-            registered._manual_guid = guid_str
+            guid_obj = Guid.objects.create(_id=manual_guid)
+            registered._manual_guid = manual_guid
             # Initial save to just to create the PK
             registered.save(manually_assign_guid=True)
             guid_obj.referent = registered

osf/models/preprint.py

@@ -344,7 +344,7 @@ def __unicode__(self):
         return '{} ({} preprint) (guid={}){}'.format(self.title, 'published' if self.is_published else 'unpublished', self._id, ' with supplemental files on ' + self.node.__unicode__() if self.node else '')
 
     @classmethod
-    def create(cls, provider, title, creator, description, guid_str=None):
+    def create(cls, provider, title, creator, description, manual_guid=None, manual_doi=None):
         """Customized creation process to support preprint versions and versioned guid.
         """
         # Step 1: Create the preprint obj
@@ -356,10 +356,10 @@ def create(cls, provider, title, creator, description, guid_str=None):
         )
         preprint.save(guid_ready=False)
         # Step 2: Create the base guid obj
-        if guid_str:
-            if not check_manually_assigned_guid(guid_str):
-                raise ValidationError(f'GUID cannot be manually assigned: guid_str={guid_str}.')
-            base_guid_obj = Guid.objects.create(_id=guid_str)
+        if manual_guid:
+            if not check_manually_assigned_guid(manual_guid):
+                raise ValidationError(f'GUID cannot be manually assigned: guid_str={manual_guid}.')
+            base_guid_obj = Guid.objects.create(_id=manual_guid)
         else:
             base_guid_obj = Guid.objects.create()
         base_guid_obj.referent = preprint
@@ -375,7 +375,7 @@ def create(cls, provider, title, creator, description, guid_str=None):
             guid=base_guid_obj
         )
         versioned_guid.save()
-        preprint.save(guid_ready=True, first_save=True)
+        preprint.save(guid_ready=True, first_save=True, manual_doi=manual_doi)
 
         return preprint
 
@@ -985,6 +985,7 @@ def save(self, *args, **kwargs):
             raise IntegrityError(err_msg)
 
         first_save = kwargs.pop('first_save', False)
+        manual_doi = kwargs.pop('manual_doi', None)
         set_creator_as_contributor = kwargs.pop('set_creator_as_contributor', True)
         saved_fields = self.get_dirty_fields() or []
 
@@ -1009,6 +1010,8 @@ def save(self, *args, **kwargs):
             # thus no need to set creator as the first contributor immediately
             if set_creator_as_contributor:
                 self._add_creator_as_contributor()
+            if manual_doi:
+                self.set_identifier_value('doi', manual_doi)
 
         if (not first_save and 'is_published' in saved_fields) or self.is_published:
             update_or_enqueue_on_preprint_updated(preprint_id=self._id, saved_fields=saved_fields)

osf/models/registrations.py

@@ -1366,7 +1366,7 @@ def unescape_registration_file_names(self, registration_responses):
                 upload['file_name'] = html.unescape(upload['file_name'])
         return registration_responses
 
-    def register(self, auth, save=False, child_ids=None, guid_str=None):
+    def register(self, auth, save=False, child_ids=None, manual_guid=None):
         node = self.branched_from
 
         if not self.title:
@@ -1379,7 +1379,7 @@ def register(self, auth, save=False, child_ids=None, guid_str=None):
             draft_registration=self,
             child_ids=child_ids,
             provider=self.provider,
-            guid_str=guid_str,
+            manual_guid=manual_guid,
         )
         self.registered_node = registration
         self.add_status_log(auth.user, DraftRegistrationLog.REGISTERED)