U !rh@sdZddlmZddlmZddlmZmZm Z m Z m Z ddl m Z ddlmZddlmZddlmZmZdd lmZGd d d eZGd d d eeZGdddeZdS)a AgencyType Model This module contains the AgencyType model which represents different categories of advertising agencies in the system. It provides a taxonomy for classifying agencies based on their specialization, size, and service offerings. Author: Senior Developer Created: 2025-08-12 Version: 1.0 Dependencies: - Django 4.2+ - django.utils.translation for internationalization - apps.common.models.BaseModel for shared functionality )models) gettext_lazy)FileExtensionValidatorMinValueValidatorMaxValueValidatorEmailValidator URLValidator)ValidationError)timezone)User) BaseModel AddressModel)agency_logo_upload_pathcseZdZdZejddededddZejdededd Z ejd d ed ed ddZ ej dededddZ ej dededddZGdddZddZddZfddZfddZd d!Zd"d#Zd$d%Zd/d'd(Zd)d*Zed+d,Zed-d.ZZS)0 AgencyTypeaj Model representing different types of advertising agencies. This model serves as a categorization system for agencies, allowing the platform to organize and filter agencies based on their specialization, size, and service offerings. It's designed to be flexible and extensible to accommodate various agency business models. Business Logic: - Agencies are categorized to help clients find the right type of agency - Premium types may have special features or higher visibility - Sort order allows for strategic positioning of agency types - Color coding enables consistent UI representation Relationships: - One AgencyType can have many Agencies (One-to-Many) - Uses PROTECT on delete to maintain referential integrity Attributes: name (CharField): The display name of the agency type description (TextField): Detailed description of the agency type color_code (CharField): Hex color code for UI representation sort_order (PositiveIntegerField): Display order priority is_premium (BooleanField): Premium type flag for special features Inherited from BaseModel: id (AutoField): Primary key created_at (DateTimeField): Record creation timestamp updated_at (DateTimeField): Last modification timestamp is_deleted (BooleanField): Soft delete flag Example Usage: # Create a new agency type agency_type = AgencyType.objects.create( name="Digital Marketing", description="Specialized in digital advertising and online marketing", color_code="#007bff", sort_order=1, is_premium=True ) # Query premium agency types premium_types = AgencyType.objects.filter(is_premium=True) # Get agencies of a specific type digital_agencies = agency_type.agencies.filter(is_active=True) dTzAgency Type NamezThe name of the agency type (e.g., Full Service, Digital, Creative). This name will be displayed throughout the platform and should be descriptive and professional.) max_lengthunique verbose_name help_textdb_index DescriptionzDetailed description of what this agency type represents, including typical services, client types, and characteristics. This helps agencies and clients understand the category better.blankrrz#007bffz Color CodezHex color code for UI representation (e.g., #007bff). This color will be used in charts, badges, and other UI elements to visually distinguish this agency type.)rdefaultrrrrz Sort OrderzOrder in which agency types should be displayed. Lower numbers appear first. Use this to strategically position important agency types at the top of lists.rrrrFz Premium TypezWhether this is a premium agency type with special features such as enhanced visibility, priority placement, or exclusive access to certain platform features.c@seZdZdZedZedZddgZdZe j ddgdd e j dge j d d d d gZ e j e j dddde j e j ddddgZdS)zAgencyType.Metaz Meta class defining model behavior and database configuration. This configuration optimizes the model for performance and usability while ensuring proper internationalization and database structure. Agency Typez Agency Types sort_ordernameZagencies_agency_type is_premiumZidx_premium_sort)fieldsrF) is_deletedZidx_active_premium)r conditionrr)Zsort_order__gteZcheck_sort_order_positive)checkrz^#[0-9A-Fa-f]{6}$)Zcolor_code__regexZcheck_color_code_formatN)__name__ __module__ __qualname____doc___rverbose_name_pluralorderingdb_tablerIndexQindexesCheckConstraint constraintsr1r18/var/www/html/Focus/src/apps/agencies/models/agencies.pyMetas*   r3cCs|jS)a String representation of the agency type. Returns the name of the agency type, which is the most meaningful identifier for users and administrators. Returns: str: The name of the agency type Example: >>> agency_type = AgencyType(name="Digital Marketing") >>> str(agency_type) "Digital Marketing" rselfr1r1r2__str__szAgencyType.__str__c Cs&d|jd|jd|jd|jd S)a  Developer-friendly string representation. Provides detailed information about the instance for debugging and development purposes. Returns: str: Detailed representation including key attributes z)pkrrrr5r1r1r2__repr__s $zAgencyType.__repr__cst|jrV|j|_|js2tdtditdd|jDsVtdtdi|jr|j|_ddl }| d|jstd td i|j rt |j d krtd td idS)a Custom model validation logic. Performs validation that goes beyond simple field constraints, ensuring business rules are followed and data integrity is maintained. Raises: ValidationError: If validation fails Validation Rules: 1. Name must not be empty or just whitespace 2. Color code must be a valid hex color 3. Description should not exceed reasonable length for display rz4Agency type name cannot be empty or just whitespace.css|]}|VqdS)N)isalnum).0cr1r1r2 sz#AgencyType.clean..zupperrematchr?len)r6rE __class__r1r2rAs<  zAgencyType.cleancs|tj||dS)aM Custom save method with additional processing. Ensures validation is run and performs any necessary pre-save processing. Args: *args: Variable length argument list passed to parent save() **kwargs: Arbitrary keyword arguments passed to parent save() N) full_cleanr@save)r6argskwargsrHr1r2rK#s zAgencyType.savecCs |jS)z Get the total number of agencies of this type. Returns: int: Count of agencies associated with this type Example: >>> agency_type.get_agencies_count() 15 )agenciescountr5r1r1r2get_agencies_count8s zAgencyType.get_agencies_countcCs|jjdddS)aH Get the number of active agencies of this type. Only counts agencies that are marked as active and not deleted. Returns: int: Count of active agencies of this type Example: >>> agency_type.get_active_agencies_count() 12 TF) is_activer!rNfilterrOr5r1r1r2get_active_agencies_countEs z$AgencyType.get_active_agencies_countcCs|jjddddS)z Get the number of premium agencies of this type. Counts agencies that are both active and marked as premium/featured. Returns: int: Count of premium agencies of this type TF)rQr! is_featuredrRr5r1r1r2get_premium_agencies_countTs z%AgencyType.get_premium_agencies_count cCs ||kS)a Check if this agency type is popular based on agency count. Args: threshold (int): Minimum number of agencies to be considered popular Returns: bool: True if the agency type has at least threshold agencies Example: >>> agency_type.is_popular(threshold=5) True )rT)r6 thresholdr1r1r2 is_popularcszAgencyType.is_popularcsZ|jrt|jdkrdSz&|jddtfdddDWStk rTYdSXdS)a, Convert hex color code to RGB tuple. Returns: tuple: RGB values as (red, green, blue) integers (0-255) Example: >>> agency_type.color_code = "#007BFF" >>> agency_type.get_color_rgb() (0, 123, 255) r)r{Nc3s$|]}t||ddVqdS)N)int)r;iZ hex_colorr1r2r=sz+AgencyType.get_color_rgb..)rr])r>rGtuple ValueErrorr5r1rar2 get_color_rgbss zAgencyType.get_color_rgbc Csrtdtdddddtdtdd d ddtd td d dddtdtdddddtdtdddddgS)a Get a list of default agency types for system initialization. This is useful for data migration scripts or initial system setup. Returns: list: List of dictionaries with agency type data Example: >>> AgencyType.get_default_types() [{'name': 'Full Service', 'description': '...', ...}, ...] Full ServicezSComprehensive advertising services including strategy, creative, media, and digitalz#007BFFr\T)rr?r>rrDigital MarketingzFSpecialized in digital advertising, social media, and online marketingz#28A745r]zCreative AgencyzzAgencyType.get_default_typescCsHg}|D]6}|jj|dd}|s |jjf|}||q |S)a Create default agency types if they don't exist. This method is safe to run multiple times as it checks for existing types before creating new ones. Returns: list: List of created AgencyType instances Example: >>> created_types = AgencyType.create_default_types() >>> len(created_types) 3 # Number of new types created rr4)rkobjectsrSfirstcreateappend)rjZ created_typesZ type_dataZ existing_type agency_typer1r1r2create_default_typess  zAgencyType.create_default_types)rW)r$r%r&r'r CharFieldr(r TextFieldr?r>PositiveIntegerFieldr BooleanFieldrr3r7r9rArKrPrTrVrYre classmethodrkrq __classcell__r1r1rHr2r'sp4    2 9    3rc @seZdZdZdedfdedfdedfded fd ed fgZd ed fdedfdedfdedfdedfdedfdedfdedfdedfdedfg Zejd ed!ed"d#d$Z ejd d#ed%ed&d'Z ej d(ej d)ed*ed+d#d,Z ejd#ed-ed.d/Zejed#d#ed0ed1ed2d3d4d5d6gd7gd8Zejd#ed9ed:egd;Zejdd'Zejed?ed@egd#dAZejd#d#edBedCgedDedEd#dFZejd