a D gr@sddlZddlmZmZddlmZddlmZmZddl m Z ddl m Z ddl mZddlmZdd lmZmZdd lmZdd lmZdd lmZGd ddZGdddejZGdddejZde_ dS)N)GenericForeignKey GenericRel) ContentType) connectionmodels)cached_property)capfirst) gettext_lazy) ParentalKey)ClusterableModelget_all_child_relations)ItemBase) StreamBlock) StreamFieldc@sPeZdZdZddZddZddZedd Zed d Z d d Z ddZ dS)ReferenceGroupsa Groups records in a ReferenceIndex queryset by their source object. Args: qs: (QuerySet[ReferenceIndex]) A QuerySet on the ReferenceIndex model Yields: A tuple (source_object, references) for each source object that appears in the queryset. source_object is the model instance of the source object and references is a list of references that occur in the QuerySet from that source object. cCs|dd|_dSNbase_content_type object_id)Zorder_byqs)selfrr]/var/www/lab.imftr.de/x/nb_venv/lib/python3.9/site-packages/wagtail/models/reference_index.py__init__szReferenceGroups.__init__ccsd}g}|jD]`}||j|jfkrd|durXtj|d}|j|dd}||fVg}|j|jf}||q|rtj|d}|j|dd}||fVdS)Nr)pk)rbase_content_type_idrrobjects get_for_idZget_object_for_this_typeappend)rZ reference_fk references reference content_typeobjectrrr__iter__"s    zReferenceGroups.__iter__cCs|jSN)_countrrrr__len__6szReferenceGroups.__len__cCs|jddSr)rvaluesZdistinctcountr&rrrr%9szReferenceGroups._countcCstdd|jDS)Ncss|]}|jtjkVqdSr$) on_deleterPROTECT).0r rrr ?z/ReferenceGroups.is_protected..)anyrr&rrr is_protected=szReferenceGroups.is_protectedcCst|S)z Returns the number of rows that will be returned by iterating this ReferenceGroups. Just calls len(self) internally, this method only exists to allow instances of this class to be used in a Paginator. )lenr&rrrr)AszReferenceGroups.countcCs t||Sr$)list)rkeyrrr __getitem__KszReferenceGroups.__getitem__N) __name__ __module__ __qualname____doc__rr#r'rr%r0r)r4rrrrrs    rc@seZdZddZdS)ReferenceIndexQuerySetcCst|S)z Returns a ReferenceGroups object for this queryset that will yield references grouped by their source instance. )rr&rrrgroup_by_source_objectPsz-ReferenceIndexQuerySet.group_by_source_objectN)r5r6r7r:rrrrr9Osr9c@seZdZdZejeejddZejeejddZ ej de ddZ ejeejddZ ej de ddZeZeZeZeZdZeZeZGdd d Zed d Zed6d dZeddZeddZ eddZ!eddZ"eddZ#eddZ$eddZ%eddZ&edd Z'ed!d"Z(e)d#d$Z*e+d%d&Z,e+d'd(Z-e+d)d*Z.e+d+d,Z/e+d-d.Z0e+d/d0Z1d1d2Z2d3d4Z3d5S)7ReferenceIndexa6 Records references between objects for quick retrieval of object usage. References are extracted from Foreign Keys, Chooser Blocks in StreamFields, and links in Rich Text Fields. This index allows us to efficiently find all of the references to a particular object from all of these sources. +)r*Z related_namez object id) max_length verbose_nameTc@seZdZdgZdS)zReferenceIndex.Meta)rrto_content_type to_object_idcontent_path_hashN)r5r6r7Zunique_togetherrrrrMetasrCcCs6|j}|r"tjj|dddStjj|ddSdS)aJ Returns the ContentType record that represents the base model of the given model or object. For a model that uses multi-table-inheritance, this returns the model that contains the primary key. For example, for any page object, this will return the content type of the Page model. FZfor_concrete_modelN)_metaget_parent_listrr get_for_model)clsmodel_or_objectparentsrrr_get_base_content_types z%ReferenceIndex._get_base_content_typeFcCst|ddrdS|s0tdd|jDr0dS|jD]T}|jr~|jr~t|ddrXq:t|jddrhq:t|tt frxq:dSt |dr:dSq:t |t rt |D]}|j|jddrdSqdS)a  Returns True if the given model may have outbound references that we would be interested in recording in the index. Args: model (type): a Django model class allow_child_models (boolean): Child models are not indexable on their own. If you are looking at a child model from the perspective of indexing it through its parent, set this to True to disable checking for this. Default False. wagtail_reference_index_ignoreFcss|]}t|tVqdSr$) isinstancer )r,fieldrrrr-sz4ReferenceIndex.model_is_indexable..Textract_referencesallow_child_models)getattrr/rF get_fields is_relation many_to_one related_modelrNr rhasattr issubclassr r model_is_indexable)rImodelrRrOchild_relationrrrrZs6       z!ReferenceIndex.model_is_indexablecCs2||jvrdS||r.|j|||dS)z3 Registers the model for indexing. N)indexed_modelsrZadd_register_as_tracked_modelrIr[rrrregister_models    zReferenceIndex.register_modelcCs\||jvrdSddlm}|j|||t|D] }|j|jddr6||jq6dS)z Add the model and all of its ParentalKey-linked children to the set of models to be tracked by signal handlers. Nr)1connect_reference_index_signal_handlers_for_modelTrQ)tracked_modelsZwagtail.signal_handlersrbr^r rZrWr_)rIr[rbr\rrrr_s    z)ReferenceIndex._register_as_tracked_modelcCs ||jvSr$)r]r`rrr is_indexedszReferenceIndex.is_indexedc #s|jD]8jrjrtddr.q tjddr>q tttfrNq tt r|j j }|j j }| |}| |}|dur |dur tj|}|jt|jjfVq ttrq  |}|durjjt|jjfVtdr  |}|dur fdd|DEdHq t|trt|D]H}|t|} | D]&fddDEdHqxqZdS)a Generator that scans the given object and yields any references it finds. Args: object (Model): an instance of a Django model to scan for references Yields: A tuple (content_type_id, object_id, model_path, content_path) for each reference found. content_type_id (int): The ID of the ContentType record representing the model of the referenced object object_id (str): The primary key of the referenced object, converted to a string model_path (str): The path to the field on the model of the source object where the reference was found content_path (str): The path to the piece of content on the source object instance where the reference was found rMFNrPc3sB|]:\}}}}|j|jd|jd|fVqdS).N)rLidname)r,Zto_modelrA model_path content_path)rIrOrrr-ks  zAReferenceIndex._extract_references_from_object..c 3sB|]:\}}}}||d|dtjd|fVqdS)z.item.reN)strrfr,to_content_type_idrArhri) child_object relation_namerrr-~s   )rFrTrUrVrSrWrNr rr get_fieldct_fieldfk_fieldZvalue_from_objectrrr model_classrLrfrjrgrXrPr r Zget_accessor_nameall_extract_references_from_object) rIr"rprqZct_valueZfk_valuer[valuer\Z child_objectsr)rmrIrOrnrrtsd               z.ReferenceIndex._extract_references_from_objectcCsttd|S)a Returns a UUID for the given content path. Used to enforce uniqueness. Note: MySQL has a limit on the length of fields that are used in unique keys so we need a separate hash field to allow us to support long content paths. Args: content_path (str): The content path to get a hash for Returns: A UUID instance containing the hash of the given content path z$bdc70d8b-e7a2-4c2a-bf43-2a3e3fcbbe86)uuiduuid5UUID)rIrirrr_get_content_path_hashs z%ReferenceIndex._get_content_path_hashc s t}ddgjD}|d|ddd|D}ddjjjdd d d d d dD}|t|}i}t j j rd|d<jj fdd|Dfi|g}| D]*\} \} } | |vrq| |vrq|| qʈjj|ddS)a Creates or updates ReferenceIndex records for the given object. This method will extract any outbound references from the given object and insert/update them in the database. Note: This method must be called within a `django.db.transaction.atomic()` block. Args: object (Model): The model instance to create/update ReferenceIndex records for cSsg|]}tjj|ddqS)FrE)rrrH)r,rJrrr sz>ReferenceIndex.create_or_update_for_object..rrDcSsg|] }|jqSr)rf)r,ctrrrrzr.cSs*i|]"\}}}}}}||||f||fqSrr)r,rfcontent_type_idrlrArhrirrr s  z>ReferenceIndex.create_or_update_for_object..rrrfr|r@rArhriTZignore_conflictsc s4g|],\}}}}j|||||dqS))r!rrrlrArhrirB)rryrkrrIr!r"rrrzs )Zid__inN)setrtrFrGrfilterrZ values_listkeysrfeaturesZsupports_ignore_conflictsZ bulk_createitemsrdelete) rIr"rZ content_typesZknown_content_type_idsZexisting_referencesZnew_referencesZbulk_create_kwargsZdeleted_reference_idsZreference_datar|rfrrrcreate_or_update_for_objectsL  z*ReferenceIndex.create_or_update_for_objectcCs$||}|jj||jddS)z Deletes all outbound references for the given object. Use this before deleting the object itself. Args: object (Model): The model instance to delete ReferenceIndex records for r~N)rLrrrr)rIr"rrrrremove_for_objects z ReferenceIndex.remove_for_objectcCs|jj|||jdS)z Returns all outbound references for the given object. Args: object (Model): The model instance to fetch ReferenceIndex records for Returns: A QuerySet of ReferenceIndex records )rrrrrLrrIr"rrrget_references_for_objects z(ReferenceIndex.get_references_for_objectcCs|jj|||jdS)z Returns all inbound references for the given object. Args: object (Model): The model instance to fetch ReferenceIndex records for Returns: A QuerySet of ReferenceIndex records )rlrArrrrrget_references_tos z ReferenceIndex.get_references_tocCs||S)a Returns all inbound references for the given object, grouped by the object they are found on. Args: object (Model): The model instance to fetch ReferenceIndex records for Returns: A ReferenceGroups object )rr:rrrrget_grouped_references_to/s z(ReferenceIndex.get_grouped_references_tocCstj|jSr$)rrrr|r&rrr _content_type=szReferenceIndex._content_typecCs|jjS)a The model name of the object from which the reference was extracted. For most cases, this is also where the reference exists on the database (i.e. ``related_field_model_name``). However, for ClusterableModels, the reference is extracted from the parent model. Example: A relationship between a BlogPage, BlogPageGalleryImage, and Image is extracted from the BlogPage model, but the reference is stored on on the BlogPageGalleryImage model. )rrgr&rrr model_nameDs zReferenceIndex.model_namecCs |jjjjS)zL The model name where the reference exists on the database. ) related_fieldr[rFr?r&rrrrelated_field_model_nameSsz'ReferenceIndex.related_field_model_namecCs(z |jjWSty"tjYS0dSr$)reverse_related_fieldr*AttributeErrorrZSET_NULLr&rrrr*Zs  zReferenceIndex.on_deletecCs*|jd}|d}|jj|}|S)z The field from which the reference was extracted. This may be a related field (e.g. ForeignKey), a reverse related field (e.g. ManyToOneRel), a StreamField, or any other field that defines extract_references(). rer)rhsplitrrrrFro)rmodel_path_components field_namerOrrr source_fieldcs zReferenceIndex.source_fieldcCst|jtjr|jjS|jSr$)rNrrZForeignObjectRel remote_fieldr&rrrrpszReferenceIndex.related_fieldcCs|jjSr$)rrr&rrrrzsz$ReferenceIndex.reverse_related_fieldc Cs|j}|jd}t|tjr:|jj|d}t |j St|t rt |j }|j }d}t|t r|j||}t |j}|d|7}|d7}qZ|Sz |j }Wn ty|jdd}Yn0t |SdS)a Returns a string describing the field that this reference was extracted from. For StreamField, this returns the label of the block that contains the reference. For other fields, this returns the verbose name of the field. reru → _ N)rrhrrNrZ ManyToOneRelrWrFrorr?rZ stream_blockrZ child_blockslabelrrgreplace) rrOrZ child_fieldrblockZ block_idxZ block_labelrrrrdescribe_source_fields(          z$ReferenceIndex.describe_source_fieldcCs|jtjkrtdd|jiS|jtjkr2tdS|jtjkrPtdd|jiS|jtjkrdtdS|jtjkrxtdSt |jdr|j dd krtd d|jiStd S) zr Returns a string describing the action that will be taken when the referenced object is deleted. z'the %(model_name)s will also be deletedrzprevents deletionz)will be set to the default %(model_name)szwill do nothingzmay prevent deletion deconstructrzdjango.db.models.SETz7will be set to a %(model_name)s specified by the systemzwill unset the reference) r*rCASCADErrr+Z SET_DEFAULTZ DO_NOTHINGZRESTRICTrXrr&rrrdescribe_on_deletes,      z!ReferenceIndex.describe_on_deleteN)F)4r5r6r7r8rZ ForeignKeyrrr!rZ CharFieldrrr@rAZ TextFieldrhriZ UUIDFieldrBr9Z as_managerrrMrrcr]rC classmethodrLrZrar_rdrtryrrrrrpropertyrrrrr*rrrrrrrrrr;Xs    0    j  c           !r;T)!rvZ"django.contrib.contenttypes.fieldsrrZ"django.contrib.contenttypes.modelsrZ django.dbrrZdjango.utils.functionalrZdjango.utils.textrZdjango.utils.translationr rZmodelcluster.fieldsr Zmodelcluster.modelsr r Z taggit.modelsr Zwagtail.blocksrZwagtail.fieldsrrZQuerySetr9ZModelr;rMrrrrs&        > |