Unify user creation and edit forms

To allow changing the user password on edit we'll also extend the user creation form instead of having two different forms/pages to edit the user and the user password.

Author: jraddaoui

scope/forms.py

@@ -1,5 +1,5 @@
 from django.contrib.auth.models import Group
-from django.contrib.auth.forms import UserChangeForm, UserCreationForm
+from django.contrib.auth.forms import UserCreationForm
 from django.utils.translation import gettext_lazy as _
 from django import forms
 from modeltranslation.forms import TranslationModelForm
@@ -19,17 +19,15 @@ def clean_identifier(self):
  return self.cleaned_data["identifier"]
 
 
-class UserCreationForm(UserCreationForm):
- is_superuser = forms.BooleanField(required=False, label=_("Administrator"))
+class UserForm(UserCreationForm):
+ """Form used for user creation and edit.
 
- def __init__(self, *args, **kwargs):
- super(UserCreationForm, self).__init__(*args, **kwargs)
- self.fields["groups"] = forms.MultipleChoiceField(
- choices=Group.objects.all().values_list("id", "name"),
- required=False,
- label=_("Groups"),
- help_text=_("Ctrl + Click to select multiple or unselect."),
- )
+ It uses UserCreationForm as base for both cases to allow editing the user
+ password on edit. The password fields are required on creation but not on
+ edit, when the password will only be updated if the fields are populated.
+ """
+
+ is_superuser = forms.BooleanField(required=False, label=_("Administrator"))
 
  class Meta:
  model = User
@@ -41,56 +39,29 @@ class Meta:
  "is_active",
  "is_superuser",
  "groups",
+ "password1",
+ "password2",
  )
 
-
-class UserChangeForm(UserChangeForm):
- password = forms.CharField(widget=forms.PasswordInput, required=False)
- password_confirmation = forms.CharField(widget=forms.PasswordInput, required=False)
- is_superuser = forms.BooleanField(required=False, label=_("Administrator"))
-
  def __init__(self, *args, **kwargs):
- super(UserChangeForm, self).__init__(*args, **kwargs)
+ super().__init__(*args, **kwargs)
  self.fields["groups"] = forms.MultipleChoiceField(
  choices=Group.objects.all().values_list("id", "name"),
  required=False,
  label=_("Groups"),
  help_text=_("Ctrl + Click to select multiple or unselect."),
  )
-
- class Meta:
- model = User
- fields = (
- "username",
- "first_name",
- "last_name",
- "email",
- "is_active",
- "is_superuser",
- "groups",
- )
-
- def clean_password(self):
- password = self.cleaned_data.get("password", "")
- if password != "" and len(password) < 8:
- raise forms.ValidationError(
- _("Password should be at least 8 characters long")
- )
- return password
-
- def clean(self):
- super(UserChangeForm, self).clean()
- password = self.cleaned_data.get("password", "")
- password_conf = self.cleaned_data.get("password_confirmation", "")
- if password != password_conf:
- raise forms.ValidationError(
- _("Password and password confirmation do not match")
- )
- return self.cleaned_data
+ # Password fields are not required when editing
+ if "instance" in kwargs:
+ self.fields["password1"].required = False
+ self.fields["password2"].required = False
 
  def save(self):
- user = super(UserChangeForm, self).save(commit=False)
- password = self.cleaned_data.get("password", "")
+ # Call ModelForm save directly to avoid setting the
+ # user password allways in UserCreationForm save.
+ user = super(UserCreationForm, self).save(commit=False)
+ # Only set the password when it's populated. It's required on creation.
+ password = self.cleaned_data.get("password1", "")
  if password != "":
  user.set_password(password)
  user.save()

scope/views.py

@@ -15,13 +15,7 @@
 
 from .helpers import get_sort_params, get_page_from_search
 from .models import User, Collection, DIP, DigitalFile, DublinCore, Content
-from .forms import (
- DeleteByDublinCoreForm,
- UserCreationForm,
- UserChangeForm,
- DublinCoreSettingsForm,
- ContentForm,
-)
+from .forms import DeleteByDublinCoreForm, UserForm, DublinCoreSettingsForm, ContentForm
 from .tasks import extract_mets, parse_mets, save_import_error
 from search.helpers import (
  add_query_to_search,
@@ -180,7 +174,7 @@ def new_user(request):
  if not request.user.is_manager():
  return redirect("home")
 
- form = UserCreationForm(request.POST or None)
+ form = UserForm(request.POST or None)
 
  # Remove superuser field for non-admin users
  if not request.user.is_superuser:
@@ -211,7 +205,7 @@ def edit_user(request, pk):
  return redirect("users")
 
  current_groups = list(instance.groups.values_list("id", flat=True))
- form = UserChangeForm(
+ form = UserForm(
  request.POST or None, instance=instance, initial={"groups": current_groups}
  )