Merge pull request #49 from crpellegrino/adding_tom_registration_to_snex2_part_2

feat(users): enable tom_registration in snex2 with backwards db syncing.

Author: moira-andrews

custom_code/forms.py

@@ -10,6 +10,14 @@
 from django.db.models.functions import Lower
 from django.core.exceptions import ValidationError
 from django.contrib.auth.models import Group
+try:
+    from django.contrib.auth.forms import BaseUserCreationForm as UserCreationForm
+except ImportError:
+    from django.contrib.auth.forms import UserCreationForm
+from django.contrib.auth.forms import UsernameField
+from django.contrib.auth.models import User, Group
+from django.db import transaction
+from crispy_forms.helper import FormHelper
 
 class CustomTargetCreateForm(SiderealTargetCreateForm):
 
@@ -59,6 +67,64 @@ def save(self, commit=True):
                 )
 
         return instance
+    
+class SNEx2UserCreationForm(UserCreationForm):
+    """
+    Form used for creation of new users and update of existing users.
+    """
+    email = forms.EmailField(required=True)
+    groups = forms.ModelMultipleChoiceField(Group.objects.all(),
+                                            required=False, widget=forms.CheckboxSelectMultiple)
+
+    class Meta:
+        model = User
+        fields = ('username', 'first_name', 'last_name', 'email', 'groups')
+        field_classes = {'username': UsernameField}
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.helper = FormHelper()
+        self.form_tag = False
+
+    def save(self, commit=True):
+        # If any operations fail, we roll back
+        with transaction.atomic():
+            # Saving the MaterialRequisition first
+            user = super(forms.ModelForm, self).save(commit=False)
+
+            # Because this form is used for both create and update user, and the user can be updated without modifying
+            # the password, we check if the password field has been populated in order to set a new one.
+            if self.cleaned_data['password1']:
+                user.set_password(self.cleaned_data["password1"])
+            if commit:
+                # Saving the inline formsets
+                user.save()
+                self.save_m2m()
+
+            return user
+
+    # Also needs to be overridden in case any clean method are implemented
+    def clean(self):
+        super().clean()
+
+        return self.cleaned_data
+
+    # is_valid sets the cleaned_data attribute so we need to override that too
+    def is_valid(self):
+        is_valid = True
+        is_valid &= super().is_valid()
+
+        return is_valid
+
+    # In case you're using the form for updating, you need to do this too
+    # because nothing will be saved if you only update field in the inner formset
+    def has_changed(self):
+        has_changed = False
+
+        has_changed |= super().has_changed()
+
+        return has_changed
 
 
 class ReducerGroupWidget(forms.widgets.MultiWidget):

custom_code/hooks.py

@@ -945,7 +945,7 @@ def sync_users_with_snex1(user, created=False, old_username=''):
                 Users.username==old_username
             ).update(
                 {'name': user.username,
-                'pw': 'crypt$$'+user.password,
+                # 'pw': 'crypt$$'+user.password,
                 'firstname': user.first_name,
                 'lastname': user.last_name,
                 'email': user.email}

custom_code/views.py

@@ -19,6 +19,7 @@
 from tom_targets.models import TargetList, Target, TargetExtra, TargetName
 from custom_code.models import TNSTarget, ScienceTags, TargetTags, ReducedDatumExtra, Papers, InterestedPersons, BrokerTarget
 from custom_code.filters import TNSTargetFilter, CustomTargetFilter, BrokerTargetFilter, BrokerTargetForm
+from custom_code.forms import SNEx2UserCreationForm
 from tom_targets.templatetags.targets_extras import target_extra_field
 from guardian.mixins import PermissionListMixin
 from guardian.models import GroupObjectPermission
@@ -58,6 +59,7 @@
 from tom_observations.cadence import get_cadence_strategy
 from tom_observations.facilities.lco import LCOSettings
 from tom_observations.views import ObservationCreateView, ObservationListView
+from tom_registration.registration_flows.approval_required.views import UserApprovalView
 import base64
 
 import logging
@@ -326,6 +328,8 @@ def get_initial(self):
 
 class CustomUserUpdateView(UserUpdateView):
 
+    form_class = SNEx2UserCreationForm
+
     def get_success_url(self):
         """
         Returns the redirect URL for a successful update. If the current user is a superuser, returns the URL for the
@@ -351,12 +355,20 @@ def dispatch(self, *args, **kwargs):
 
     def form_valid(self, form):
         old_username = self.get_object().username
-        print('IN NEW VIEW WITH USERNAME', old_username)
         super().form_valid(form)
         run_hook('sync_users_with_snex1', self.get_object(), False, old_username)
         return redirect(self.get_success_url())
 
 
+class SNEx2UserApprovalView(UserApprovalView):
+
+    def form_valid(self, form):
+        response = super().form_valid(form)
+        run_hook("sync_users_with_snex1", self.get_object(), True)
+
+        return response
+
+
 class CustomDataProductUploadView(DataProductUploadView):
 
     form_class = CustomDataProductUploadForm

snex2/settings.py

@@ -387,24 +387,44 @@
 # for example: OPEN_URLS = ['/', '/about']
 OPEN_URLS = ['/snex2/tnstargets/', '/pipeline-upload/photometry-upload/']
 
-HOOKS = {
-    'target_post_save': 'custom_code.hooks.target_post_save',
-    'observation_change_state': 'tom_common.hooks.observation_change_state',
-    'targetextra_post_save': 'custom_code.hooks.targetextra_post_save',
-    'targetname_post_save': 'custom_code.hooks.targetname_post_save',
-    'sync_observation_with_snex1': 'custom_code.hooks.sync_observation_with_snex1',
-    'sync_sequence_with_snex1': 'custom_code.hooks.sync_sequence_with_snex1',
-    'cancel_sequence_in_snex1': 'custom_code.hooks.cancel_sequence_in_snex1',
-    'update_reminder_in_snex1': 'custom_code.hooks.update_reminder_in_snex1',
-    'approve_sequence_in_snex1': 'custom_code.hooks.approve_sequence_in_snex1',
-    'find_images_from_snex1': 'custom_code.hooks.find_images_from_snex1',
-    'change_interest_in_snex1': 'custom_code.hooks.change_interest_in_snex1',
-    'sync_paper_with_snex1': 'custom_code.hooks.sync_paper_with_snex1',
-    'sync_comment_with_snex1': 'custom_code.hooks.sync_comment_with_snex1',
-    'cancel_gw_obs': 'gw.hooks.cancel_gw_obs',
-    'ingest_gw_galaxy_into_snex1': 'gw.hooks.ingest_gw_galaxy_into_snex1',
-    'sync_users_with_snex1': 'custom_code.hooks.sync_users_with_snex1',
-}
+if DEBUG:
+    HOOKS = {
+        'target_post_save': '',
+        'observation_change_state': '',
+        'targetextra_post_save': '',
+        'targetname_post_save': '',
+        'sync_observation_with_snex1': '',
+        'sync_sequence_with_snex1': '',
+        'cancel_sequence_in_snex1': '',
+        'update_reminder_in_snex1': '',
+        'approve_sequence_in_snex1': '',
+        'find_images_from_snex1': '',
+        'change_interest_in_snex1': '',
+        'sync_paper_with_snex1': '',
+        'sync_comment_with_snex1': '',
+        'cancel_gw_obs': '',
+        'ingest_gw_galaxy_into_snex1': '',
+        'sync_users_with_snex1': '',
+    }
+else:
+    HOOKS = {
+        'target_post_save': 'custom_code.hooks.target_post_save',
+        'observation_change_state': 'tom_common.hooks.observation_change_state',
+        'targetextra_post_save': 'custom_code.hooks.targetextra_post_save',
+        'targetname_post_save': 'custom_code.hooks.targetname_post_save',
+        'sync_observation_with_snex1': 'custom_code.hooks.sync_observation_with_snex1',
+        'sync_sequence_with_snex1': 'custom_code.hooks.sync_sequence_with_snex1',
+        'cancel_sequence_in_snex1': 'custom_code.hooks.cancel_sequence_in_snex1',
+        'update_reminder_in_snex1': 'custom_code.hooks.update_reminder_in_snex1',
+        'approve_sequence_in_snex1': 'custom_code.hooks.approve_sequence_in_snex1',
+        'find_images_from_snex1': 'custom_code.hooks.find_images_from_snex1',
+        'change_interest_in_snex1': 'custom_code.hooks.change_interest_in_snex1',
+        'sync_paper_with_snex1': 'custom_code.hooks.sync_paper_with_snex1',
+        'sync_comment_with_snex1': 'custom_code.hooks.sync_comment_with_snex1',
+        'cancel_gw_obs': 'gw.hooks.cancel_gw_obs',
+        'ingest_gw_galaxy_into_snex1': 'gw.hooks.ingest_gw_galaxy_into_snex1',
+        'sync_users_with_snex1': 'custom_code.hooks.sync_users_with_snex1',
+    }
 
 
 BROKERS = {
@@ -497,7 +517,7 @@
     'REGISTRATION_AUTHENTICATION_BACKEND': 'django.contrib.auth.backends.AllowAllUsersModelBackend',
     'REGISTRATION_REDIRECT_PATTERN': 'home',
     'REGISTRATION_STRATEGY': 'approval_required', 
-    'SEND_APPROVAL_EMAILS': False,  
+    'SEND_APPROVAL_EMAILS': True,  
     'APPROVAL_SUBJECT': f'Your {TOM_NAME} registration has been approved!',  # Optional subject line of approval email, (Default Shown)
     'APPROVAL_MESSAGE': f'Your {TOM_NAME} registration has been approved. You can log in <a href="mytom.com/login">here</a>.'  # Optional html-enabled body for approval email, (Default Shown)
 }
@@ -506,15 +526,15 @@
     ('SNEx Secure', 'sne@lco.global')
 ]
 
+MANAGERS = [("SNe", "sne@lco.global")]
+EMAIL_SUBJECT_PREFIX = f'[{TOM_NAME}]'
 EMAIL_HOST = 'smtp.gmail.com'
-
 EMAIL_PORT = 587
-
 EMAIL_USE_TLS = True
-
+EMAIL_USE_SSL = False
 EMAIL_HOST_USER = 'snex@lco.global'
-
 EMAIL_HOST_PASSWORD = str(os.getenv('SNEX_EMAIL_PASSWORD', ''))
+EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"
 
 DATA_UPLOAD_MAX_MEMORY_SIZE = 7000000
 

snex2/urls.py

@@ -69,6 +69,7 @@
     path('nonlocalizedevents/sequence/<int:id>/obs/', EventSequenceGalaxiesTripletView.as_view(), name='nonlocalizedevents-sequence-triplets'),
     path('nonlocalizedevents/galaxies/<int:id>/obs/', GWFollowupGalaxyTripletView.as_view(), name='nonlocalizedevents-galaxies-triplets'),
     path('', include('tom_registration.registration_flows.approval_required.urls', namespace='registration')),
+    path('snex2/accounts/approve/<int:pk>/', SNEx2UserApprovalView.as_view(), name="snex2-approve-user"),
     path('snex2/', include('custom_code.urls')),
     path('nonlocalizedevents/', include('tom_nonlocalizedevents.urls', namespace='nonlocalizedevents')),
     path('django_plotly_dash/', include('django_plotly_dash.urls')),

templates/tom_registration/approve_user.html

@@ -0,0 +1,18 @@
+{% extends 'tom_common/base.html' %}
+{% load bootstrap4 static %}
+{% block title %}Approve user{% endblock %}
+{% block additional_css %}
+<link rel="stylesheet" href="{% static 'tom_targets/css/targets_snexclone.css' %}">
+{% endblock %}
+{% block content %}
+<form action="{% url 'snex2-approve-user' object.id %}" method="POST">
+{% csrf_token %}
+{% bootstrap_form form %}
+{% bootstrap_formset form.user_profile_formset %}
+{% buttons %}
+  <button type="submit" class="btn btn-primary">
+    Approve
+  </button>
+{% endbuttons %}
+</form>
+{% endblock %}

templates/tom_registration/partials/pending_users.html

@@ -0,0 +1,29 @@
+{% if request.user.is_superuser %}
+<h4>Pending Users</h4>
+<div class="row">
+    <div class="col-md-12">
+        <table class="table table-striped">
+          <thead>
+          <tr>
+            <th>Username</th>
+            <th>Name</th>
+            <th>Email</th>
+            <th>Approve</th>
+            <th>Delete</th>
+        </tr>
+        </thead>
+        <tbody>
+            {% for user in users %}
+            <tr>
+                <td>{{ user.username }}</td>
+                <td>{{ user.first_name }} {{ user.last_name }}</td>
+                <td>{{ user.email }}</td>
+                <td><a href="{% url 'snex2-approve-user' user.id %}" class="btn btn-primary">Approve</a></td>
+                <td><a href="{% url 'user-delete' user.id %}" class="btn btn-danger">Delete</a></td>
+            </tr>
+              {% endfor %}
+            </tbody>
+        </table>
+    </div>
+</div>
+{% endif %}