U hL@srdZddlZddlmZddlmZddlmZddlm Z ddl m Z ddl mZdd lmZdd lmZdd lmZmZdd lmZmZGd ddejZGdddejZGdddejZGdddejZGdddejZGdddejZGdddejZ GdddejZ!GdddejZ"Gdd d ejZ#Gd!d"d"eeeeZ$Gd#d$d$e$ee ee"Z%dS)%a Enterprise-Ready Common Models Module This module provides base model classes, abstract models, and common functionality that can be inherited by other models throughout the application. It follows Django best practices and enterprise patterns for scalability and maintainability. Features: - Base timestamp models with created/updated tracking - Soft delete functionality with audit trails - UUID primary keys for enhanced security - Versioning and change tracking - Common field types and validators - Audit logging capabilities - Status and workflow management - Metadata and tagging support Author: Adtals Development Team Version: 2.0.0 License: Proprietary N)modelsreverse)timezone)ValidationError) gettext_lazy)get_user_model) ContentType)GenericForeignKey)MinLengthValidatorRegexValidator) BaseManagerSoftDeleteManagercs^eZdZdZejeddeddZejeddeddZGd d d Z fd d Z Z S) TimestampedModelaa Abstract base model providing timestamp fields. This model provides automatic tracking of creation and modification timestamps for all models that inherit from it. Attributes: created_at (DateTimeField): Timestamp when object was created updated_at (DateTimeField): Timestamp when object was last modified z Created AtTz&Timestamp when this object was created) auto_now_add help_textz Updated Atz,Timestamp when this object was last modified)auto_nowrc@seZdZdZdgZdS)zTimestampedModel.MetaTz -created_atN__name__ __module__ __qualname__abstractorderingrr-/var/www/html/Focus/src/apps/common/models.pyMeta?srcs,|jst|_t|_tj||dS)z1Override save to ensure updated_at is always set.N)pkrnow created_at updated_atsupersaveselfargskwargs __class__rrr!Cs  zTimestampedModel.save) rrr__doc__r DateTimeField_rrrr! __classcell__rrr&rr&s rc@s6eZdZdZejdejdeddZ GdddZ dS) UUIDModelz Abstract base model using UUID as primary key. This model provides UUID primary keys for enhanced security and to prevent enumeration attacks. Attributes: id (UUIDField): UUID primary key TFz!Unique identifier for this object) primary_keydefaulteditablerc@seZdZdZdS)zUUIDModel.MetaTNrrrrrrrrr^srN) rrrr(r UUIDFielduuiduuid4r*idrrrrrr,Ks r,c seZdZdZejeddeddZejedddedd Z ej d ej ddd ed ed dZ e ZeZGdddZdddZdddZfddZeddZeddZZS)SoftDeleteModela Abstract base model providing soft delete functionality. This model allows objects to be marked as deleted without actually removing them from the database, enabling recovery and audit trail maintenance. Attributes: is_deleted (BooleanField): Whether object is soft-deleted deleted_at (DateTimeField): When object was soft-deleted deleted_by (ForeignKey): User who soft-deleted the object z Is DeletedFz)Whether this object has been soft-deletedr.rz Deleted AtTz+Timestamp when this object was soft-deleted)nullblankr accounts.Userz%(class)s_deletedz Deleted Byz!User who soft-deleted this object on_deleter7r8 related_name verbose_namerc@seZdZdZdS)zSoftDeleteModel.MetaTNr0rrrrrsrNcOs0d|_t|_|r||_|jdddgddS)z Perform soft delete instead of hard delete. Args: user: The user performing the delete operation T is_deleted deleted_at deleted_by update_fieldsN)r>rrr?r@r!)r#userr$r%rrrdeletes  zSoftDeleteModel.deletecCs(d|_d|_d|_|r||_|dS)z Restore a soft deleted object. Args: user: The user performing the restore operation FN)r>r?r@ updated_byr!)r#rCrrrrestores zSoftDeleteModel.restorecstdS)z,Permanently delete the object from database.N)r rDr#r&rr hard_deleteszSoftDeleteModel.hard_deletecCs|jjddS)z Get a queryset of non-deleted objects. Returns: QuerySet: All objects where is_deleted=False Fr>objectsfilterclsrrrget_active_objectssz"SoftDeleteModel.get_active_objectscCs|jjddS)z Get a queryset of soft deleted objects. Returns: QuerySet: All objects where is_deleted=True TrIrJrMrrrget_deleted_objectssz#SoftDeleteModel.get_deleted_objects)N)N)rrrr(r BooleanFieldr*r>r)r? ForeignKeySET_NULLr@rrKr Z all_objectsrrDrFrH classmethodrOrPr+rrr&rr5bs>    r5csPeZdZdZejddededdZGdddZfd 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_lengthuniquer=rc@seZdZdZdS)zSlugModel.MetaTNr0rrrrrsrcs<|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.textrZrYr r!)r#r$r%rZr&rrr!s 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 )strrrGrrrrYs zSlugModel.get_slug_source) rrrr(r SlugFieldr*r[rr!rYr+rrr&rrUs rUc@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.r=rc@seZdZdZddgZdS)zSortableModel.MetaTorderr4NrrrrrrsrcCsnzT|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-orderrbrANr'rKrLrborder_byfirstr! Exception)r#Z 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__gtrbrANrc)r# next_itemZ next_orderrrr move_downszSortableModel.move_downN) rrrr(rPositiveIntegerFieldr*rbrrgrirrrrr`sr`c sreZdZdZejdejdddededdZejdejddded ed dZ Gd d d Z fd dZ Z S) AuditModelaB Abstract base model for tracking user actions. This model tracks which user created and last modified an object, providing audit trail capabilities. Attributes: created_by (ForeignKey): User who created this object updated_by (ForeignKey): User who last modified this object r9Tz%(class)s_createdz Created ByzUser who created this objectr:z%(class)s_updatedz Updated Byz"User who last modified this objectc@seZdZdZdS)zAuditModel.MetaTNr0rrrrrRsrcs8t|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)getattrr created_byrEr r!)r#r$r%rCr&rrr!Us   zAuditModel.save) rrrr(rrRrSr*rmrErr!r+rrr&rrk3s*   rkc@seZdZdZdedfdedfdedfded fd ed fd ed fgZejeddeddZejeddeddZ ej eddededdZ GdddZ ddZ ddZdd Zd!d"Zd#S)$ StatusModelaz Abstract base model providing status tracking. This model provides common status fields that can be used across different models for workflow management. Attributes: is_active (BooleanField): Whether object is active is_published (BooleanField): Whether object is published status (CharField): Current status of the object ZdraftZDraftpendingZPendingZapprovedZApprovedZrejectedZRejectedZ publishedZ PublishedarchivedZArchivedz Is ActiveTzWhether this object is activer6z Is PublishedFz Whether this object is publishedStatuszCurrent status of this object)rWchoicesr.rc@seZdZdZdS)zStatusModel.MetaTNr0rrrrrsrcCsd|_|jdgddS)zActivate this record.T is_activerANrtr!rGrrractivateszStatusModel.activatecCsd|_|jdgddS)zDeactivate this record.FrtrANrurGrrr deactivateszStatusModel.deactivatecCs d|_d|_|jddgddS)zSuspend this record.Z suspendedFstatusrtrANrxrtr!rGrrrsuspendszStatusModel.suspendcCs d|_d|_|jddgddS)zArchive this record.rpFrxrtrANryrGrrrarchiveszStatusModel.archiveN)rrrr(r*ZSTATUS_CHOICESrrQrtZ is_published CharFieldrxrrvrwrzr{rrrrrnjs<       rncs^eZdZdZejeddeddZejeddedd Z Gd d d Z fd d Z Z S)VersionedModelaH Abstract base model providing versioning functionality. This model tracks version numbers and changes for objects, enabling version control and change history. Attributes: version (PositiveIntegerField): Current version number change_reason (TextField): Reason for the last change Versionz%Current version number of this objectr6z Change ReasonTz.Reason for the last change made to this object)r8rc@seZdZdZdS)zVersionedModel.MetaTNr0rrrrrsrcs&|jr|jd7_tj||dS)zIncrement version on save.rN)rversionr r!r"r&rrr!szVersionedModel.save) rrrr(rrjr*r TextFieldZ change_reasonrr!r+rrr&rr}s r}c@s|eZdZdZejedededdZej edddedd Z Gd d d Z d d Z ddZ ddZdddZddZdS) MetadataModelaQ Abstract base model providing metadata functionality. This model provides flexible metadata storage using JSON fields for storing additional information that doesn't warrant separate fields. Attributes: metadata (JSONField): Flexible metadata storage tags (CharField): Comma-separated tags ZMetadataTz#Additional metadata for this object)r.r8rTagsiz'Comma-separated tags for categorizationrWr8rc@seZdZdZdS)zMetadataModel.MetaTNr0rrrrrsrcCs |jrdd|jdDSgS)zReturn tags as a list.cSsg|]}|r|qSr)strip).0tagrrr sz/MetadataModel.get_tags_list..,)tagssplitrGrrr get_tags_listszMetadataModel.get_tags_listcCs*|}||kr&||d||_dS)zAdd a tag to the object., N)rappendjoinrr#rrrrradd_tags zMetadataModel.add_tagcCs*|}||kr&||d||_dS)zRemove a tag from the object.rN)rremoverrrrrr remove_tags zMetadataModel.remove_tagNcCs|j||S)zGet a metadata value.)metadataget)r#keyr.rrr get_metadataszMetadataModel.get_metadatacCs||j|<|jdgddS)zSet a metadata value.rrAN)rr!)r#rvaluerrr set_metadatas zMetadataModel.set_metadata)N)rrrr(r JSONFieldr*dictrr|rrrrrrrrrrrrs&  rc@seZdZdZejedddeddZejeddded dZejed dded dZ ejed d deddZ ejedddeddZ ej edddddeddZ ej edddddeddZGdddZddZddZdS) AddressModela Abstract model for address information. This model provides common address fields that can be used by various models that need location information. Attributes: street_address (CharField): Street address city (CharField): City name state_province (CharField): State or province postal_code (CharField): Postal/ZIP code country (CharField): Country name latitude (DecimalField): Latitude coordinate longitude (DecimalField): Longitude coordinate zstreet addressrVTz/Street address including number and street namercitydz City namezstate/provincezState or province namez postal coderrzPostal or ZIP codecountryz Country namelatitude zLatitude coordinate) max_digitsdecimal_placesr7r8r longitude zLongitude coordinatec@seZdZdZdZdS)zAddressModel.Metaz(Meta configuration for the AddressModel.TN)rrrr(rrrrrrOsrcCs(|j|j|j|j|jg}dtd|S)z Get the complete address as a formatted string. Returns: str: Formatted address string rN)street_addressrstate_province postal_coderrrL)r# address_partsrrrget_full_addressSszAddressModel.get_full_addresscCs|jdk o|jdk S)z Check if the address has geographic coordinates. Returns: bool: True if both latitude and longitude are set N)rrrGrrrhas_coordinatescszAddressModel.has_coordinatesN)rrrr(rr|r*rrrrr DecimalFieldrrrrrrrrrrsd  rc@s.eZdZdZGdddZddZddZdS) BaseModela% Comprehensive base model combining all common functionality. This model combines UUID primary keys, timestamps, user tracking, soft delete, and status management into a single base class that provides enterprise-level functionality 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.MetaTNr0rrrrr}srcCs|jjd|jdS)z:Default string representation using the model name and ID.z ())r'rr4rGrrr__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. rrz-detailr)r%#N) django.urlsrr'rlowerr)r#r model_namerrrget_absolute_urls   zBaseModel.get_absolute_urlN)rrrr(rrrrrrrrmsrc@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.MetaTNr0rrrrrsrN)rrrr(rrrrrrs r)&r(r2 django.dbrrr django.utilsrdjango.core.exceptionsrdjango.utils.translationrr*django.contrib.authr"django.contrib.contenttypes.modelsr Z"django.contrib.contenttypes.fieldsr django.core.validatorsr r Zapps.common.managersr rModelrr,r5rUr`rkrnr}rrrrrrrrs.        %b-B7B!:f&