U (3ihM6@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__abstractorderingrr./var/www/html/Adtlas/src/apps/common/models.pyMeta(srcs$|jjst|_tj||dS)z"Override save to add custom logic.N)_stateaddingrnow updated_atsupersave)selfargskwargs __class__rrr,s zTimeStampedModel.save) r r r __doc__r DateTimeField_ 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@seZdZdZdS)zUUIDModel.MetaTNr r r r rrrrrDsrN) 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@seZdZdZdS)zSoftDeleteModel.MetaTNr&rrrrrfsrNcstj||ddS)z)Override delete to implement soft delete.)using keep_parentsN)rdelete)rr3r4rrr hard_deleteiszSoftDeleteModel.hard_deletecCs0d|_t|_|r||_|jdddgddS)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)r7rrr8r9rruserrrr soft_deletens  zSoftDeleteModel.soft_deletecCs4d|_d|_d|_|r||_|jddddgddS)z Restore a soft deleted record. Args: user: The user performing the restore operation FNr7r8r9 updated_byr:)r7r8r9r?rr<rrrrestore{s zSoftDeleteModel.restorecCs|jjddS)z Get a queryset of non-deleted objects. Returns: QuerySet: All objects where is_deleted=False Fr7objectsfilterclsrrrget_active_objectssz"SoftDeleteModel.get_active_objectscCs|jjddS)z Get a queryset of soft deleted objects. Returns: QuerySet: All objects where is_deleted=True TrArBrErrrget_deleted_objectssz#SoftDeleteModel.get_deleted_objects)NF)N)N)r r r rr BooleanFieldrr7rr8 ForeignKeySET_NULLr9rr6r>r@ classmethodrGrHr!rrrrr+Hs8   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@seZdZdZdS)zSlugModel.MetaTNr&rrrrrsrcs<|js*t|dr*ddlm}|||_tj||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.textrSrRrr)rrrrSrrrrs 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 )strpkrrrrrRs zSlugModel.get_slug_source) r r r rr SlugFieldrrTrrrRr!rrrrrMs rMc@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$rQrc@seZdZdZddgZdS)zSortableModel.MetaTorderr*Nr rrrrrsrcCsnzT|jjj|jdd}|rR|j}|j|_||_|jdgd|jdgdWntk rhYnXdS)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-orderr]r:NrrCrDr]order_byfirstr Exception)rZ previous_itemZprevious_orderrrrmove_upszSortableModel.move_upcCsnzT|jjj|jdd}|rR|j}|j|_||_|jdgd|jdgdWntk rhYnXdS)z Move this item down in the sort order. Swaps the order with the item that has the next higher order value. )Z order__gtr]r:Nr^)r next_itemZ next_orderrrr move_downszSortableModel.move_downN) r r r rrPositiveIntegerFieldrr]rrbrdrrrrr[sr[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. r/Tz%(class)s_created_recordszUser who created this recordr0z%(class)s_updated_recordsz!User who last updated this recordc@seZdZdZdS)zAuditModel.MetaTNr&rrrrr&srcs8t|dd}|js|r||_|r&||_tj||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)getattrrX created_byr?rr)rrrr=rrrr)s   zAuditModel.save) r r r rrrJrKrrhr?rrr!rrrrrf s&  rfc@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)rOchoicesr$rz Is ActiveTzWhether this record is activer,c@seZdZdZdS)zStatusModel.MetaTNr&rrrrrZsrcCs d|_d|_|jddgddS)zActivate this record.rjTstatus is_activer:NrrrsrrYrrractivate]szStatusModel.activatecCs d|_d|_|jddgddS)zDeactivate this record.rkFrrrsr:NrtrYrrr deactivatecszStatusModel.deactivatecCs d|_d|_|jddgddS)zSuspend this record.rmFrrrsr:NrtrYrrrsuspendiszStatusModel.suspendcCs d|_d|_|jddgddS)zArchive this record.rnFrrrsr:NrtrYrrrarchiveoszStatusModel.archiveN)r r r rrZSTATUS_CHOICESr CharFieldrrrIrsrrurvrwrxrrrrri>s0     ric@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@seZdZdZdS)zMetaDataModel.MetaTNr&rrrrrsrcCs(||jkr$|j||jdgddS)zAdd a tag to this record.tagsr:N)r|appendrrtagrrradd_tags  zMetaDataModel.add_tagcCs(||jkr$|j||jdgddS)zRemove a tag from this record.r|r:N)r|removerr~rrr remove_tags  zMetaDataModel.remove_tagcCs||j|<|jdgddS)zSet a metadata value.metadatar:N)rr)rkeyvaluerrr set_metadatas zMetaDataModel.set_metadataNcCs|j||S)zGet a metadata value.)rget)rrr$rrr get_metadataszMetaDataModel.get_metadata)N)r r r rr JSONFieldrdictrlistr|rrrrrrrrrrzvs$rzc@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@seZdZdZdS)zBaseModel.MetaTNr&rrrrrsrcCs|jjd|jdS)z:Default string representation using the model name and ID.z ())rr r*rYrrr__str__szBaseModel.__str__cCsFddlm}|jj}z||dd|jidWSYdSXdS)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-detailrX)r#N) django.urlsrrr lowerrX)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@seZdZdZdS)zFullBaseModel.MetaTNr&rrrrrsrN)r r r rrrrrrrs r)rr( django.dbr django.utilsrdjango.utils.translationrrModelrr"r+rMr[rfrirzrrrrrrs   %V-B18.#