203 lines
8.6 KiB
Python
203 lines
8.6 KiB
Python
"""
|
|
Management utility to create superusers.
|
|
"""
|
|
import getpass
|
|
import sys
|
|
|
|
from django.contrib.auth import get_user_model
|
|
from django.contrib.auth.management import get_default_username
|
|
from django.contrib.auth.password_validation import validate_password
|
|
from django.core import exceptions
|
|
from django.core.management.base import BaseCommand, CommandError
|
|
from django.db import DEFAULT_DB_ALIAS
|
|
from django.utils.text import capfirst
|
|
|
|
|
|
class NotRunningInTTYException(Exception):
|
|
pass
|
|
|
|
|
|
class Command(BaseCommand):
|
|
help = 'Used to create a superuser.'
|
|
requires_migrations_checks = True
|
|
stealth_options = ('stdin',)
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super().__init__(*args, **kwargs)
|
|
self.UserModel = get_user_model()
|
|
self.username_field = self.UserModel._meta.get_field(self.UserModel.USERNAME_FIELD)
|
|
|
|
def add_arguments(self, parser):
|
|
parser.add_argument(
|
|
'--%s' % self.UserModel.USERNAME_FIELD,
|
|
dest=self.UserModel.USERNAME_FIELD, default=None,
|
|
help='Specifies the login for the superuser.',
|
|
)
|
|
parser.add_argument(
|
|
'--noinput', '--no-input', action='store_false', dest='interactive',
|
|
help=(
|
|
'Tells Django to NOT prompt the user for input of any kind. '
|
|
'You must use --%s with --noinput, along with an option for '
|
|
'any other required field. Superusers created with --noinput will '
|
|
'not be able to log in until they\'re given a valid password.' %
|
|
self.UserModel.USERNAME_FIELD
|
|
),
|
|
)
|
|
parser.add_argument(
|
|
'--database', action='store', dest='database',
|
|
default=DEFAULT_DB_ALIAS,
|
|
help='Specifies the database to use. Default is "default".',
|
|
)
|
|
for field in self.UserModel.REQUIRED_FIELDS:
|
|
parser.add_argument(
|
|
'--%s' % field, dest=field, default=None,
|
|
help='Specifies the %s for the superuser.' % field,
|
|
)
|
|
|
|
def execute(self, *args, **options):
|
|
self.stdin = options.get('stdin', sys.stdin) # Used for testing
|
|
return super().execute(*args, **options)
|
|
|
|
def handle(self, *args, **options):
|
|
username = options[self.UserModel.USERNAME_FIELD]
|
|
database = options['database']
|
|
|
|
# If not provided, create the user with an unusable password
|
|
password = None
|
|
user_data = {}
|
|
# Same as user_data but with foreign keys as fake model instances
|
|
# instead of raw IDs.
|
|
fake_user_data = {}
|
|
verbose_field_name = self.username_field.verbose_name
|
|
|
|
# Do quick and dirty validation if --noinput
|
|
if not options['interactive']:
|
|
try:
|
|
if not username:
|
|
raise CommandError("You must use --%s with --noinput." % self.UserModel.USERNAME_FIELD)
|
|
username = self.username_field.clean(username, None)
|
|
|
|
for field_name in self.UserModel.REQUIRED_FIELDS:
|
|
if options[field_name]:
|
|
field = self.UserModel._meta.get_field(field_name)
|
|
user_data[field_name] = field.clean(options[field_name], None)
|
|
else:
|
|
raise CommandError("You must use --%s with --noinput." % field_name)
|
|
except exceptions.ValidationError as e:
|
|
raise CommandError('; '.join(e.messages))
|
|
|
|
else:
|
|
# Prompt for username/password, and any other required fields.
|
|
# Enclose this whole thing in a try/except to catch
|
|
# KeyboardInterrupt and exit gracefully.
|
|
default_username = get_default_username()
|
|
try:
|
|
|
|
if hasattr(self.stdin, 'isatty') and not self.stdin.isatty():
|
|
raise NotRunningInTTYException("Not running in a TTY")
|
|
|
|
# Get a username
|
|
while username is None:
|
|
input_msg = capfirst(verbose_field_name)
|
|
if default_username:
|
|
input_msg += " (leave blank to use '%s')" % default_username
|
|
username_rel = self.username_field.remote_field
|
|
input_msg = '%s%s: ' % (
|
|
input_msg,
|
|
' (%s.%s)' % (
|
|
username_rel.model._meta.object_name,
|
|
username_rel.field_name
|
|
) if username_rel else ''
|
|
)
|
|
username = self.get_input_data(self.username_field, input_msg, default_username)
|
|
if not username:
|
|
continue
|
|
if self.username_field.unique:
|
|
try:
|
|
self.UserModel._default_manager.db_manager(database).get_by_natural_key(username)
|
|
except self.UserModel.DoesNotExist:
|
|
pass
|
|
else:
|
|
self.stderr.write("Error: That %s is already taken." % verbose_field_name)
|
|
username = None
|
|
|
|
if not username:
|
|
raise CommandError('%s cannot be blank.' % capfirst(verbose_field_name))
|
|
|
|
for field_name in self.UserModel.REQUIRED_FIELDS:
|
|
field = self.UserModel._meta.get_field(field_name)
|
|
user_data[field_name] = options[field_name]
|
|
while user_data[field_name] is None:
|
|
message = '%s%s: ' % (
|
|
capfirst(field.verbose_name),
|
|
' (%s.%s)' % (
|
|
field.remote_field.model._meta.object_name,
|
|
field.remote_field.field_name,
|
|
) if field.remote_field else '',
|
|
)
|
|
input_value = self.get_input_data(field, message)
|
|
user_data[field_name] = input_value
|
|
fake_user_data[field_name] = input_value
|
|
|
|
# Wrap any foreign keys in fake model instances
|
|
if field.remote_field:
|
|
fake_user_data[field_name] = field.remote_field.model(input_value)
|
|
|
|
# Get a password
|
|
while password is None:
|
|
password = getpass.getpass()
|
|
password2 = getpass.getpass('Password (again): ')
|
|
if password != password2:
|
|
self.stderr.write("Error: Your passwords didn't match.")
|
|
password = None
|
|
# Don't validate passwords that don't match.
|
|
continue
|
|
|
|
if password.strip() == '':
|
|
self.stderr.write("Error: Blank passwords aren't allowed.")
|
|
password = None
|
|
# Don't validate blank passwords.
|
|
continue
|
|
|
|
try:
|
|
validate_password(password2, self.UserModel(**fake_user_data))
|
|
except exceptions.ValidationError as err:
|
|
self.stderr.write('\n'.join(err.messages))
|
|
response = input('Bypass password validation and create user anyway? [y/N]: ')
|
|
if response.lower() != 'y':
|
|
password = None
|
|
|
|
except KeyboardInterrupt:
|
|
self.stderr.write("\nOperation cancelled.")
|
|
sys.exit(1)
|
|
|
|
except NotRunningInTTYException:
|
|
self.stdout.write(
|
|
"Superuser creation skipped due to not running in a TTY. "
|
|
"You can run `manage.py createsuperuser` in your project "
|
|
"to create one manually."
|
|
)
|
|
|
|
if username:
|
|
user_data[self.UserModel.USERNAME_FIELD] = username
|
|
user_data['password'] = password
|
|
self.UserModel._default_manager.db_manager(database).create_superuser(**user_data)
|
|
if options['verbosity'] >= 1:
|
|
self.stdout.write("Superuser created successfully.")
|
|
|
|
def get_input_data(self, field, message, default=None):
|
|
"""
|
|
Override this method if you want to customize data inputs or
|
|
validation exceptions.
|
|
"""
|
|
raw_value = input(message)
|
|
if default and raw_value == '':
|
|
raw_value = default
|
|
try:
|
|
val = field.clean(raw_value, None)
|
|
except exceptions.ValidationError as e:
|
|
self.stderr.write("Error: %s" % '; '.join(e.messages))
|
|
val = None
|
|
|
|
return val
|