.~hkddlZddlZddlZddlZddlZddlZddlmZddlm Z ddl m Z ddl m Z ddl m Z ddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddlm Z ddl!m"Z"ejFe$Z%ejLdZ'ddZ(dZ)GddejTZ+GddejXZ-Gdde+Z.Gdde-Z/y)N)apps)settings)ImproperlyConfigured)MultipleObjectsReturned)ObjectDoesNotExist)EmailMultiAlternatives)models) transaction)TemplateDoesNotExist)render_to_string)get_random_string) import_string)now) UserModel)UserModelString)_z^[a-f0-9]{40,64}$cFttddrpttdd}|s tdtjdd}|xs|j j }dj||j}|Sttd tj}|S) aC Return the email address by which mail is sent. If the `REGISTRATION_USE_SITE_EMAIL` setting is set, the `Site` object will provide the domain and the REGISTRATION_SITE_USER_EMAIL will provide the username. Otherwise the `REGISTRATION_DEFAULT_FROM_EMAIL` or `DEFAULT_FROM_EMAIL` settings are used. REGISTRATION_USE_SITE_EMAILFREGISTRATION_SITE_USER_EMAILNzPREGISTRATION_SITE_USER_EMAIL must be set when using REGISTRATION_USE_SITE_EMAIL.sitesSitez{}@{}REGISTRATION_DEFAULT_FROM_EMAIL) getattrrrr get_modelobjects get_currentformatdomainDEFAULT_FROM_EMAIL)site user_emailr from_emails \/var/www/peopleoo.sandbox-dev.co.uk/venv/lib/python3.12/site-packages/registration/models.pyget_from_emailr%!sx6>X'EtL &/1 1~~gv.1t||//1^^J <  X'H%88: cttdd}|t||z}dj|j }t |j d}t||}t||||} ttddr t||} | j| d| jy#t$rYwxYw)z& Function that sends an email !REGISTRATION_EMAIL_SUBJECT_PREFIXr!REGISTRATION_EMAIL_HTMLT text/htmlN) rrr join splitlinesr%getrattach_alternativer send) addresses_toctx_dictsubject_template body_templatebody_html_templateprefixsubjectr# message_txt email_message message_htmls r$ send_emailr;8s XBB GF'(8(CCGggg((*+G V 45J"=#+-K+7K+5|EMx2D9 H+"H.L  , ,\; G $   s B55 CCcBeZdZdZdZd dZdddifdZdZd dZd Z y) RegistrationManagera Custom manager for the ``RegistrationProfile`` model. The methods defined here provide shortcuts for account creation and activation (including generation and emailing of activation keys), and for cleaning out expired inactive accounts. c|j}d|_d|_tj5|j |j ddd|r|S|S#1swYxYw)z Activate the ``RegistrationProfile`` given as argument. User is able to login, as ``is_active`` is set to ``True`` TN)user is_active activatedr atomicsave)selfprofiler! get_profiler?s r$ _activatezRegistrationManager._activate_s^ ||     !  IIK LLN  NK   s !AA'ctj|rR |j|}|j r|j dfS|js|j|||dfSy#|jj$rYywxYw)aL Validate an activation key and activate the corresponding ``User`` if valid, returns a tuple of (``User``, ``activated``). The activated flag indicates if the user was newly activated or an error occurred. If the key is valid and has not expired, return the (``User``, ``True``) after activating. If the key is not valid or has expired, return (``User`` or ``False``, ``False``). If the key is valid but the ``User`` is already active, return (``User``, ``False``). If the key is valid but the ``User`` is inactive, return (``User``, ``False``). To prevent reactivation of an account which has been deactivated by site administrators, ``RegistrationProfile.activated`` is set to ``True`` after successful activation. )activation_key)FFFT) SHA256_REsearchr.model DoesNotExistrAr?activation_key_expiredrG)rDrIr!rFrEs r$ activate_userz!RegistrationManager.activate_userps6   N + &((.(A   e,,113wkBDII!::** &&  &sA))BBNTc r|2|jd}tdi|}|j|d|_t |_t j5|j|j|fi||rt jfdddd|S#1swY|SxYw)a Create a new, inactive ``User``, generate a ``RegistrationProfile`` and email its activation key to the ``User``, returning the new ``User``. By default, an activation email will be sent to the new user. To disable this, pass ``send_email=False``. Additionally, if email is sent and ``request`` is supplied, it will be passed to the email template. NpasswordFc(jSN)send_activation_email)registration_profilerequestr!sr$z:RegistrationManager.create_inactive_user..s0FFg'r&) popr set_passwordr@ datetime_now date_joinedr rBrCcreate_profile on_commit) rDr!new_userr;rV profile_info user_inforQrUs ` ` @r$create_inactive_userz(RegistrationManager.create_inactive_users   }}Z0H"y{/Y/H  ! !( +" ,~    !  MMO#64#6#6$*($* %%'  s "AB,,B6c z|jdd|i|}d|vr|jd|j|S)z Create a ``RegistrationProfile`` for a given ``User``, and return the ``RegistrationProfile``. The activation key for the ``RegistrationProfile`` will be a SHA256 hash, generated from a secure random string. r?rIF)rCrX)rLcreate_new_activation_keyrC)rDr?r`rEs r$r]z"RegistrationManager.create_profilesC$**7$7,7 < /  - -5 - 9 r&c |j|}|js|j ry|j |j ||y#t$rYyt$rYywxYw)zR Resets activation key for the user and resends activation email. )user__email__iexactFT)r.rrrArNrdrT)rDemailr!rVrEs r$resend_activation_mailz*RegistrationManager.resend_activation_mailsn hh5h9G    > > @))+%%dG4" &  sA A*A*)A*c|jtjdtjdzd}d}|D]j} |jrW|j}t j dj|| |j|j|d z }l|S#tjtjf$r/}t jdj||Yd}~Vd}~wwxYw#tj$r=t j d j||j|d z }YwxYw) a Remove expired instances of ``RegistrationProfile`` and their associated ``User``s. Accounts to be deleted are identified by searching for instances of ``RegistrationProfile`` with expired activation keys and an ``activated`` field that is set to ``False``. If these conditions are met both the ``RegistrationProfile`` and the ``User`` objects will be deleted. It is recommended that this method be executed regularly as part of your routine site maintenance; this application provides a custom management command which will call this method, accessible as ``manage.py cleanupregistration``. Regularly clearing out accounts which have never been activated serves two useful purposes: 1. It alleviates the occasional need to reset a ``RegistrationProfile`` and/or re-send an activation email when a user does not receive or does not act upon the initial activation email; since the account will be deleted, the user will be able to simply re-register and receive a new activation key. 2. It prevents the possibility of a malicious user registering one or more accounts and never activating them (thus denying the use of those usernames to anyone else); since those accounts will be deleted, the usernames will become available for use again. If you have a troublesome ``User`` and wish to disable their account while keeping it in the database, simply delete the associated ``RegistrationProfile``; an inactive ``User`` which does not have an associated ``RegistrationProfile`` will not be deleted. F)user__is_activeNr?)rArz5Deleting expired Registration profile {} and user {}.z$Deletion of user {} is prevented: {}rz(Deleting expired Registration profile {})filterr QrNr?loggerwarningrdeleteProtectedErrorRestrictedErrorerrorrrM)rDprofiles deleted_countrEr?es r$delete_expired_usersz(RegistrationManager.delete_expired_userss8N;; HHU +fhhD.A A   #G #113"<AD B2)D2#D%C?:D?DDAEE)FrS) __name__ __module__ __qualname____doc__rGrOrbr]rhrwrXr&r$r=r=Us3".`374%)#J$&;r&r=ceZdZdZej eejedZ ejeddZ ejdZ eZGd d Zd Zdd Zd ZddZy)RegistrationProfileaT A simple profile which stores an activation key for use during user account registration. Generally, you will not want to interact directly with instances of this model; the provided manager includes methods for creating and activating new accounts, as well as for cleaning out accounts which have never been activated. While it is possible to use this model as the value of the ``AUTH_PROFILE_MODULE`` setting, it's not recommended that you do so. This model's sole purpose is to store data temporarily during account registration and activation. r?) on_delete verbose_namezactivation key@) max_lengthF)defaultc,eZdZedZedZy)RegistrationProfile.Metazregistration profilezregistration profilesN)rxryrzrrverbose_name_pluralrXr&r$MetarCs/0  78r&rc d|jzS)NzRegistration information for %srk)rDs r$__str__zRegistrationProfile.__str__Gs0499< YZr&c|jjs(|js|j|j|d|_|j |r|S|jS)z Activate the ``SupervisedRegistrationProfile`` given as argument. Send an email to the site administrators to approve the user. User is not able to login yet, as ``is_active`` is not yet ``True`` T)r?r@rAsend_admin_approve_emailrC)rDrEr!rFs r$rGz'SupervisedRegistrationManager._activatesR||%%g.?.?  ) )',, =!  N<< r&Nc tjj|}|jr"|jj r |jS|jrd|j_ny|jj |j|||r|S|jS#|jj$rYywxYw)a Approve the ``SupervisedRegistrationProfile`` object with the given ``profile_id``. If the id is valid, return the ``User`` after approving. If the id is not valid, return ``False``. If the id is valid but the ``User`` is already active, return ``User``. If the id is valid but the ``SupervisedRegistrationProfile`` object is not activated, return ``False``. )idTF) SupervisedRegistrationProfilerr.rAr?r@rC!send_admin_approve_complete_emailrLrM)rD profile_idr!rFrVrEs r$admin_approve_userz0SupervisedRegistrationManager.admin_approve_users  3;;??:?NG  <<))"<<'   )- & LL     5 5dG D||#zz&&  s$A B+B+//B+ B++CCcttdd}ttdd}ttdd}||jj|d}ttdd }t |t rt |} | } n|xsttd d } |stjd t| s td | D cgc]} | d  } } t| ||||y cc} w)aM Send an approval email to the site administrators to approve this user. The approval email will use the following templates, which can be overridden by setting APPROVAL_EMAIL_SUBJECT, APPROVAL_EMAIL_BODY, and APPROVAL_EMAIL_HTML appropriately: ``registration/admin_approve_email_subject.txt`` This template will be used for the subject line of the email. Because it is used as the subject line of an email, this template's output **must** be only a single line of text; output longer than one line will be forcibly joined into only a single line. ``registration/admin_approve_email.txt`` This template will be used for the text body of the email. ``registration/admin_approve_email.html`` This template will be used for the html body of the email. These templates will each receive the following context variables: ``user`` The new user account ``profile_id`` The id of the associated``SupervisedRegistrationProfile`` object. ``site`` An object representing the site on which the user registered; depending on whether ``django.contrib.sites`` is installed, this may be an instance of either ``django.contrib.sites.models.Site`` (if the sites application is installed) or ``django.contrib.sites.requests.RequestSite`` (if not). Consult the documentation for the Django sites framework for details regarding these objects' interfaces. ``request`` Optional Django's ``HttpRequest`` object from view. If supplied will be passed to the template for better flexibility via ``RequestContext``. ADMIN_APPROVAL_EMAIL_SUBJECTz,registration/admin_approve_email_subject.txtADMIN_APPROVAL_EMAIL_BODYz$registration/admin_approve_email.txtADMIN_APPROVAL_EMAIL_HTMLz%registration/admin_approve_email.html)r?rr!REGISTRATION_ADMINSNADMINSzkNo registration admin defined in settings.REGISTRATION_ADMINS. Using settings.ADMINS for the admin approvalz|Using the admin_approval registration backend requires at least one admin in settings.ADMINS or settings.REGISTRATION_ADMINSr) rrregistrationprofiler isinstancestrrwarningswarn UserWarningrr;) rDr?r!rVadmin_approve_email_subjectadmin_approve_email_bodyadmin_approve_email_htmlr2registration_admins admins_getteradminsadmins r$rz6SupervisedRegistrationManager.send_admin_approve_email$s `'.  * :' # $+  ' 2$  $+  ' 3$  2255  &h0EtL )3 /)*=>M"_F(MGHh,MF" MMJ& '&34 4 )//u%(// H9 $&> 0s C")FNrS)rxryrzrNrGrrrXr&r$rrs[4 *&PZ r&rc"eZdZeZddZy)rNcttdd}ttdd}ttdd}|j|d}t|jjg||||y) a* Send an "approval is complete" email to the user associated with this ``SupervisedRegistrationProfile``. The email will use the following templates, which can be overridden by settings APPROVAL_COMPLETE_EMAIL_SUBJECT, APPROVAL_COMPLETE_EMAIL_BODY, and APPROVAL_COMPLETE_EMAIL_HTML appropriately: ``registration/admin_approve_complete_email_subject.txt`` This template will be used for the subject line of the email. Because it is used as the subject line of an email, this template's output **must** be only a single line of text; output longer than one line will be forcibly joined into only a single line. ``registration/admin_approve_complete_email.txt`` This template will be used for the text body of the email. ``registration/admin_approve_complete_email.html`` This template will be used for the text body of the email. These templates will each receive the following context variables: ``user`` The new user account ``site`` An object representing the site on which the user registered; depending on whether ``django.contrib.sites`` is installed, this may be an instance of either ``django.contrib.sites.models.Site`` (if the sites application is installed) or ``django.contrib.sites.requests.RequestSite`` (if not). Consult the documentation for the Django sites framework for details regarding these objects' interfaces. ``request`` Optional Django's ``HttpRequest`` object from view. If supplied will be passed to the template for better flexibility via ``RequestContext``. APPROVAL_COMPLETE_EMAIL_SUBJECTz5registration/admin_approve_complete_email_subject.txtAPPROVAL_COMPLETE_EMAIL_BODYz-registration/admin_approve_complete_email.txtAPPROVAL_COMPLETE_EMAIL_HTMLz.registration/admin_approve_complete_email.html)r?r!N)rrr?r;rg)rDr!rV$admin_approve_complete_email_subject!admin_approve_complete_email_body!admin_approve_complete_email_htmlr2s r$rz?SupervisedRegistrationProfile.send_admin_approve_complete_emails|V07 7 C0E,-4 4 ;-=)-4 4 <->) II   YY__ x 0 - -  r&rS)rxryrzrrrrXr&r$rrs ,-G> r&rrS)0rrloggingrerr django.appsr django.confrdjango.core.exceptionsrrrdjango.core.mailr django.dbr r django.templater django.template.loaderr django.utils.cryptor django.utils.module_loadingrdjango.utils.timezonerr[usersrrutilsr getLoggerrxrncompilerJr%r;Managerr=Modelr}rrrXr&r$rs  7:53!03155"   8 $ BJJ* + .:P&..Pf`&,,`Fs $7s lE $7E r&