o TbhM6@sdZddlZddlmZddlmZddlmZGdddej Z Gdd d ej Z Gd d d ej Z Gd d d ej Z Gdddej ZGdddej ZGdddej ZGdddej ZGddde e e eZGdddee eeeZdS)z Common Models Module This module contains base models and common functionality that will be used across all applications in the project. N)models)timezone) gettext_lazycs^eZdZdZejeddeddZejeddeddZGd d d Z fd d Z Z S) TimeStampedModelaaAbstract base model that provides timestamp fields only. This model provides created_at and updated_at fields that are automatically managed. All models should inherit from this. This is a lighter version of BaseModel for cases where you only need timestamp tracking without user tracking or soft delete functionality. z Created AtTz)Date and time when the record was created) auto_now_add help_textz Updated Atz.Date and time when the record was last updated)auto_nowrc@seZdZdZdgZdS)zTimeStampedModel.MetaTz -created_atN__name__ __module__ __qualname__abstractorderingrrFC:\Users\vibe-look\OneDrive\Desktop\Adtlas_V\src\apps\common\models.pyMeta(s rcs(|jjs t|_tj|i|dS)z"Override save to add custom logic.N)_stateaddingrnow updated_atsupersave)selfargskwargs __class__rrr,s zTimeStampedModel.save) r r r __doc__r DateTimeField_Z created_atrrr __classcell__rrrrrs rc@s6eZdZdZejdejdeddZ GdddZ dS) UUIDModelzAbstract base model that provides UUID primary key. This model uses UUID as the primary key instead of auto-incrementing integers for better security and distributed systems compatibility. TFz!Unique identifier for this record) primary_keydefaulteditablerc@eZdZdZdS)zUUIDModel.MetaTNr r r r rrrrrDrN) r r r rr UUIDFielduuiduuid4ridrrrrrr!5sr!cseZdZdZejeddeddZejedddedd Z ej d ej ddd ed d Z GdddZ dfdd ZdddZdddZeddZeddZZS)SoftDeleteModelzAbstract base model that provides soft delete functionality. Instead of actually deleting records, this model marks them as deleted and provides methods to filter out deleted records. z Is DeletedFz)Whether this record has been soft deletedr#rz Deleted AtTz)Date and time when the record was deleted)nullblankr accounts.Userz%(class)s_deleted_recordszUser who deleted this record on_deleter.r/ related_namerc@r%)zSoftDeleteModel.MetaTNr&rrrrrfr'rNcstj||ddS)z)Override delete to implement soft delete.)using keep_parentsN)rdelete)rr4r5rrr hard_deleteiszSoftDeleteModel.hard_deletecCs.d|_t|_|r ||_|jgdddS)z Perform a soft delete on this record. Args: user: The user performing the delete operation T) is_deleted deleted_at deleted_by update_fieldsN)r8rrr9r:rruserrrr soft_deletens  zSoftDeleteModel.soft_deletecCs0d|_d|_d|_|r||_|jgdddS)z Restore a soft deleted record. Args: user: The user performing the restore operation FN)r8r9r: updated_byr;)r8r9r:r@rr=rrrrestore{s zSoftDeleteModel.restorecC|jjddS)z Get a queryset of non-deleted objects. Returns: QuerySet: All objects where is_deleted=False Fr8Nobjectsfilterclsrrrget_active_objectsz"SoftDeleteModel.get_active_objectscCrB)z Get a queryset of soft deleted objects. Returns: QuerySet: All objects where is_deleted=True TrCNrDrGrrrget_deleted_objectsrJz#SoftDeleteModel.get_deleted_objects)NFN)r r r rr BooleanFieldrr8rr9 ForeignKeySET_NULLr:rr7r?rA classmethodrIrKr rrrrr,Hs:     r,csPeZdZdZejddededdZGdddZfd d Z d d Z Z S) SlugModelz Abstract model that provides slug functionality. This model adds a slug field that can be used for SEO-friendly URLs. The slug is automatically generated from a specified field. TZSlugzSEO-friendly URL identifier) max_lengthunique verbose_namerc@r%)zSlugModel.MetaTNr&rrrrrr'rcs@|jst|drddlm}|||_tj|i|dS)z Override save method to auto-generate slug if not provided. Child models should define a get_slug_source() method that returns the field value to generate the slug from. get_slug_sourcer)slugifyN)slughasattrdjango.utils.textrWrVrr)rrrrWrrrrs zSlugModel.savecCs t|jS)a  Get the source value for slug generation. This method should be overridden in child models to specify which field should be used for slug generation. Returns: str: The value to generate slug from N)strpkrrrrrVs zSlugModel.get_slug_source) r r r rr SlugFieldrrXrrrVr rrrrrQs  rQc@sFeZdZdZejdededdZGdddZdd Z d d Z d S) SortableModelz Abstract model that provides sorting functionality. This model adds an order field that can be used to sort records in a specific order defined by the user. rOrderz.Order for sorting (lower numbers appear first))r#rUrc@seZdZdZddgZdS)zSortableModel.MetaTorderr+Nr rrrrrs rcCsrz.|jjj|jdd}|r,|j}|j|_||_|jdgd|jdgdWdSWdSty8YdSw)z Move this item up in the sort order. Swaps the order with the item that has the next lower order value. )Z order__ltz-orderrar;NrrErFraorder_byfirstr Exception)rZ previous_itemZprevious_orderrrrmove_up   zSortableModel.move_upcCsrz.|jjj|jdd}|r,|j}|j|_||_|jdgd|jdgdWdSWdSty8YdSw)z Move this item down in the sort order. Swaps the order with the item that has the next higher order value. )Z order__gtrar;Nrb)r next_itemZ next_orderrrr move_downrgzSortableModel.move_downN) r r r rrPositiveIntegerFieldrrarrfrirrrrr_s r_csfeZdZdZejdejdddeddZejdejdddeddZ Gd d d Z fd d Z Z S) AuditModelzAbstract model that provides audit trail functionality. This model tracks who created and last modified a record. r0Tz%(class)s_created_recordszUser who created this recordr1z%(class)s_updated_recordsz!User who last updated this recordc@r%)zAuditModel.MetaTNr&rrrrr&r'rcs<t|dd}|js|r||_|r||_tj|i|dS)z Override save method to handle user tracking. This method automatically sets created_by and updated_by based on the current user in the request context. Z _current_userN)getattrr\ created_byr@rr)rrrr>rrrr)s  zAuditModel.save) r r r rrrNrOrrmr@rrr rrrrrk s(  rkc@seZdZdZdedfdedfdedfded fd ed fgZejed d ededdZej eddeddZ GdddZ ddZ ddZ ddZddZdS) StatusModelzAbstract model that provides status functionality. This model provides common status fields used across the application. activeZActiveinactiveZInactivependingZPending suspendedZ SuspendedarchivedZArchivedStatuszCurrent status of this record)rSchoicesr#rz Is ActiveTzWhether this record is activer-c@r%)zStatusModel.MetaTNr&rrrrrZr'rcC d|_d|_|jddgddS)zActivate this record.roTstatus is_activer;Nrxryrr]rrractivate]zStatusModel.activatecCrw)zDeactivate this record.rpFrxryr;Nrzr]rrr deactivatecr|zStatusModel.deactivatecCrw)zSuspend this record.rrFrxryr;Nrzr]rrrsuspendir|zStatusModel.suspendcCrw)zArchive this record.rsFrxryr;Nrzr]rrrarchiveor|zStatusModel.archiveN)r r r rrZSTATUS_CHOICESr CharFieldrxrMryrr{r}r~rrrrrrn>s2      rnc@steZdZdZejedededdZejede deddZ Gdd d Z d d Z d d Z ddZdddZdS) MetaDataModelzAbstract model that provides metadata functionality. This model provides fields for storing additional metadata as JSON data. ZMetadataTz"Additional metadata stored as JSON)r#r/rTagsz Tags associated with this recordc@r%)zMetaDataModel.MetaTNr&rrrrrr'rcCs,||jvr|j||jdgddSdS)zAdd a tag to this record.tagsr;N)rappendrrtagrrradd_tag  zMetaDataModel.add_tagcCs,||jvr|j||jdgddSdS)zRemove a tag from this record.rr;N)rremoverrrrr remove_tagrzMetaDataModel.remove_tagcCs||j|<|jdgddS)zSet a metadata value.metadatar;N)rr)rkeyvaluerrr set_metadatas zMetaDataModel.set_metadataNcCs|j||S)zGet a metadata value.N)rget)rrr#rrr get_metadataszMetaDataModel.get_metadatarL)r r r rr JSONFieldrdictrlistrrrrrrrrrrrvs&rc@s.eZdZdZGdddZddZddZdS) BaseModela` Abstract base model that provides common fields for all models. This model includes: - UUID :: UUID primary key for better security - Timestamps :: Created and updated timestamps - Soft delete :: Soft delete functionality - Audit trail :: Created and updated by user tracking - Common methods for all models c@r%)zBaseModel.MetaTNr&rrrrrr'rcCs|jjd|jdS)z:Default string representation using the model name and ID.z ()N)rr r+r]rrr__str__szBaseModel.__str__cCs@ddlm}|jj}z ||dd|jidWSYdS)z Get the absolute URL for this model instance. This method should be overridden in child models to provide the correct URL for the model's detail view. r)reversez-detailr\)r#N) django.urlsrrr lowerr\)rr model_namerrrget_absolute_urls  zBaseModel.get_absolute_urlN)r r r rrrrrrrrrs   rc@seZdZdZGdddZdS) FullBaseModela.Complete base model with all functionality. This model combines all available base functionality: - UUID primary key - Timestamps - Soft delete - Audit trail - Status management - Metadata storage Use this for models that need comprehensive functionality. c@r%)zFullBaseModel.MetaTNr&rrrrrr'rN)r r r rrrrrrrs r)rr) django.dbr django.utilsrdjango.utils.translationrrModelrr!r,rQr_rkrnrrrrrrrs   %V-B18.#