a D gx@sddlZddlZddlmZddlmZddlmZddlm Z ddl m Z ddl m Z mZmZddlmZmZdd lmZmZmZdd lmZdd lmZdd lmZdd lmZddlm Z GdddeZ!GdddZ"Gddde e"e!Z#GdddeZ$GdddeZ%dS)N) defaultdict)Iterable)Any)apps) ContentType) CharFieldPrefetchQ)ExistsOuterRef)CastLengthSubstr) ModelIterable)MP_NodeQuerySet)Locale)Site)SearchableQuerySetMixincseZdZdZfddZde_d$ddZd%dd Zd&d d Zd d Z ddZ ddZ d'ddZ d(ddZ d)ddZddZddZddZd*ddZd+d d!Zd,d"d#ZZS)- TreeQuerySetz] Extends Treebeard's MP_NodeQuerySet with additional useful tree-related operations. cstdS)zNRedefine the delete method unbound, so we can set the queryset_only parameter.N)superdeleteself __class__L/var/www/lab.imftr.de/x/nb_venv/lib/python3.9/site-packages/wagtail/query.pyrszTreeQuerySet.deleteTFcCs2t|jdt|jd@}|s.|t|jdM}|S)NZpath__startswith)Z depth__gtepk)r pathdepthrrother inclusiveqrrrdescendant_of_qszTreeQuerySet.descendant_of_qcCs||||S)z This filters the QuerySet to only contain pages that descend from the specified page. If inclusive is set to True, it will also contain the page itself (instead of just its descendants). )filterr&rr#r$rrr descendant_of'szTreeQuerySet.descendant_ofcCs||||S)z This filters the QuerySet to not contain any pages that descend from the specified page. If inclusive is set to True, it will also exclude the specified page. )excluder&r(rrrnot_descendant_of/szTreeQuerySet.not_descendant_ofcCs||t|jdd@S)Nr!)r&r r!rr#rrr child_of_q7szTreeQuerySet.child_of_qcCs|||S)zq This filters the QuerySet to only contain pages that are direct children of the specified page. )r'r/r.rrrchild_of:szTreeQuerySet.child_ofcCs|||S)zt This filters the QuerySet to not contain any pages that are direct children of the specified page. )r*r/r.rrr not_child_of@szTreeQuerySet.not_child_ofcsRfddtdtjdjddD}t|d}|sN|tjdM}|S)Ncsg|]}jd|qS)rr ).0posr#rr Gsz.TreeQuerySet.ancestor_of_q..rr,)Zpath__inr)rangelenr steplenr r)rr#r$pathsr%rr5r ancestor_of_qFs  zTreeQuerySet.ancestor_of_qcCs||||S)z This filters the QuerySet to only contain pages that are ancestors of the specified page. If inclusive is set to True, it will also include the specified page. )r'r;r(rrr ancestor_ofRszTreeQuerySet.ancestor_ofcCs||||S)z This filters the QuerySet to not contain any pages that are ancestors of the specified page. If inclusive is set to True, it will also exclude the specified page. )r*r;r(rrrnot_ancestor_ofZszTreeQuerySet.not_ancestor_ofcCst|j|jdS)Nr2)r model_get_parent_path_from_pathr r.rrr parent_of_qbszTreeQuerySet.parent_of_qcCs|||S)z] This filters the QuerySet to only contain the parent of the specified page. )r'r@r.rrr parent_ofeszTreeQuerySet.parent_ofcCs|||S)zX This filters the QuerySet to exclude the parent of the specified page. )r*r@r.rrr not_parent_ofkszTreeQuerySet.not_parent_ofcCs:t|j|jdt|jd@}|s6|t|jdM}|S)Nrr-r)r r>r?r r!rr"rrr sibling_of_qqs zTreeQuerySet.sibling_of_qcCs||||S)a! This filters the QuerySet to only contain pages that are siblings of the specified page. By default, inclusive is set to True so it will include the specified page in the results. If inclusive is set to False, the page will be excluded from the results. )r'rCr(rrr sibling_of{szTreeQuerySet.sibling_ofcCs||||S)a$ This filters the QuerySet to not contain any pages that are siblings of the specified page. By default, inclusive is set to True so it will exclude the specified page from the results. If inclusive is set to False, the page will be included in the results. )r*rCr(rrrnot_sibling_ofszTreeQuerySet.not_sibling_of)F)F)F)F)F)F)T)T)T)__name__ __module__ __qualname____doc__rZ queryset_onlyr&r)r+r/r0r1r;r<r=r@rArBrCrDrE __classcell__rrrrrs$       rcsneZdZfddZfddZdddZedd Zdd ed fd d Z dd ed fd dZ Z S)SpecificQuerySetMixincs(tj|i|d|_d|_d|_dS)zSet custom instance attributesFrN)r__init___defer_streamfields_specific_select_related_fields"_specific_prefetch_related_lookups)rargskwargsrrrrLszSpecificQuerySetMixin.__init__cs&t}|j|_|j|_|j|_|S)z.Ensure clones inherit custom attribute values.)r_clonerMrNrO)rclonerrrrRs  zSpecificQuerySetMixin._cloneFcCs|}|rt|_nt|_|S)a This efficiently gets all the specific items for the queryset, using the minimum number of queries. When the "defer" keyword argument is set to True, only generic field values will be loaded and all specific fields will be deferred. )rRDeferredSpecificIterable_iterable_classSpecificIterable)rdeferrSrrrspecifics zSpecificQuerySetMixin.specificcCst|jttfS)zU Returns True if this queryset is already specific, False otherwise. ) issubclassrUrVrTrrrr is_specificsz!SpecificQuerySetMixin.is_specific)for_specific_subqueriescsD|stj|S|std|}|dkr4d|_n |j||_|S)an Overrides Django's native :meth:`~django.db.models.query.QuerySet.select_related` to allow related objects to be fetched by the subqueries made when a specific queryset is evaluated. When ``for_specific_subqueries`` is ``False`` (the default), the method functions exactly like the original method. However, when ``True``, ``fields`` are **required**, and must match names of ForeignKey fields on all specific models that might be included in the result (which can include fields inherited from concrete parents). Unlike when ``for_specific_subqueries`` is ``False``, no validation is applied to ``fields`` when the method is called. Rather, that when the method is called. Instead, that validation is applied for each individual subquery when the queryset is evaluated. This difference in behaviour should be taken into account when experimenting with ``for_specific_subqueries=True`` . As with Django's native implementation, you chain multiple applications of ``select_related()`` with ``for_specific_subqueries=True`` to progressively add to the list of fields to be fetched. For example: .. code-block:: python # Fetch 'author' when retrieving specific page data queryset = Page.objects.specific().select_related("author", for_specific_subqueries=True) # We're rendering cards with images, so fetch the listing image too queryset = queryset.select_related("listing_image", for_specific_subqueries=True) # Fetch some key taxonomy data too queryset = queryset.select_related("topic", "target_audience", for_specific_subqueries=True) As with Django's native implementation, ``None`` can be supplied in place of ``fields`` to negate a previous application of ``select_related()``. By default, this will only work for cases where ``select_related()`` was called without ``for_specific_subqueries``, or with ``for_specific_subqueries=False``. However, you can use ``for_specific_subqueries=True`` to negate subquery-specific applications too. For example: .. code-block:: python # Fetch 'author' and 'listing_image' when retrieving specific page data queryset = Page.objects.specific().select_related( "author", "listing_image", for_specific_subqueries=True ) # I've changed my mind. Do not fetch any additional data queryset = queryset.select_related(None, for_specific_subqueries=True) zZ'fields' must be specified when calling select_related() with for_specific_subqueries=TrueNr)rselect_related ValueError_chainrN)rr[fieldsrSrrrr]s3 z$SpecificQuerySetMixin.select_relatedcsD|stj|S|std|}|dkr4d|_n |j||_|S)a Overrides Django's native :meth:`~django.db.models.query.QuerySet.prefetch_related` implementation to allow related objects to be fetched alongside the subqueries made when a specific queryset is evaluated. When ``for_specific_subqueries`` is ``False`` (the default), the method functions exactly like the original method. However, when ``True``, ``lookups`` are **required**, and must match names of related fields on all specific models that might be included in the result (which can include relationships inherited from concrete parents). Unlike when ``for_specific_subqueries`` is ``False``, no validation is applied to ``lookups`` when the method is called. Instead, that validation is applied for each individual subquery when the queryset is evaluated. This difference in behaviour should be taken into account when experimenting with ``for_specific_subqueries=True``. As with Django's native implementation, you chain multiple applications of ``prefetch_related()`` with ``for_specific_subqueries=True`` to progressively add to the list of lookups to be made. For example: .. code-block:: python # Fetch 'contributors' when retrieving specific page data queryset = Page.objects.specific().prefetch_related("contributors", for_specific_subqueries=True) # We're rendering cards with images, so prefetch listing image renditions too queryset = queryset.prefetch_related("listing_image__renditions", for_specific_subqueries=True) # Fetch some key taxonomy data also queryset = queryset.prefetch_related("tags", for_specific_subqueries=True) As with Django's native implementation, ``None`` can be supplied in place of ``lookups`` to negate a previous application of ``prefetch_related()``. By default, this will only work for cases where ``prefetch_related()`` was called without ``for_specific_subqueries``, or with ``for_specific_subqueries=False``. However, you can use ``for_specific_subqueries=True`` to negate subquery-specific applications too. For example: .. code-block:: python # Fetch 'contributors' and 'listing_image' renditions when retrieving specific page data queryset = Page.objects.specific().prefetch_related( "contributors", "listing_image__renditions", for_specific_subqueries=True ) # I've changed my mind. Do not make any additional queries queryset = queryset.prefetch_related(None, for_specific_subqueries=True) z\'lookups' must be provided when calling prefetch_related() with for_specific_subqueries=Truer\r)rprefetch_relatedr^r_rO)rr[lookupsrSrrrras2 z&SpecificQuerySetMixin.prefetch_related)F) rFrGrHrLrRrXpropertyrZboolr]rarJrrrrrKs   BrKc@seZdZddZddZddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZddZddZdd Zd!d"Zd#d$Zd%d&Zd?d(d)Zd*d+Zd,d-Zd.d/Zd0d1Zd@d2d3ZdAd4d5Zd6d7Zd8d9Zd:d;ZdS)B PageQuerySetcCs tddS)NT)liver rrrrlive_qAszPageQuerySet.live_qcCs||S)zL This filters the QuerySet to only contain published pages. )r'rhrrrrrfDszPageQuerySet.livecCs||S)zN This filters the QuerySet to only contain unpublished pages. )r*rhrrrrnot_liveJszPageQuerySet.not_livecCs tddS)NT)Z show_in_menusrgrrrr in_menu_qPszPageQuerySet.in_menu_qcCs||S)zX This filters the QuerySet to only contain pages that are in the menus. )r'rjrrrrin_menuSszPageQuerySet.in_menucCs||S)z\ This filters the QuerySet to only contain pages that are not in the menus. )r*rjrrrr not_in_menuYszPageQuerySet.not_in_menucCs t|jdS)N)id)r rmr.rrrpage_q_szPageQuerySet.page_qcCs|||S)zS This filters the QuerySet so it only contains the specified page. )r'rnr.rrrpagebszPageQuerySet.pagecCs|||S)zU This filters the QuerySet so it doesn't contain the specified page. )r*rnr.rrrnot_pagehszPageQuerySet.not_pagecs4fddtD}tjj|}tt|dS)Ncsh|]}t|r|qSr)rY)r3r>typesrr osz&PageQuerySet.type_q..Zcontent_type__in)rZ get_modelsrobjectsget_for_modelsr listvalues)rrrZall_subclasses content_typesrrqrtype_qns   zPageQuerySet.type_qcGs||j|S)z This filters the QuerySet to only contain pages that are an instance of the specified model(s) (including subclasses). )r'rzrrrrrrtypeuszPageQuerySet.typecGs||j|S)zq This filters the QuerySet to exclude any pages which are an instance of the specified model(s). )r*rzr{rrrnot_type|szPageQuerySet.not_typecGstjj|}tt|dS)Nrt)rrurvr rwrx)rrrryrrr exact_type_qs zPageQuerySet.exact_type_qcGs||j|S)z This filters the QuerySet to only contain pages that are an instance of the specified model(s) (matching the model exactly, not subclasses). )r'r~r{rrr exact_typeszPageQuerySet.exact_typecGs||j|S)z This filters the QuerySet to exclude any pages which are an instance of the specified model(s) (matching the model exactly, not subclasses). )r*r~r{rrrnot_exact_typeszPageQuerySet.not_exact_typecCsNddlm}t}|jdD]}||j|jddO}q"|rD|StgdS)Nr)PageViewRestrictionroTr$Zpk__in)Zwagtail.modelsrr rur]allr&ro)rrr%Z restrictionrrr private_qs  zPageQuerySet.private_qcCs||S)z} Filters the QuerySet to only contain pages that are not in a private section and their descendants. )r*rrrrrpublicszPageQuerySet.publiccCs||Szy Filters the QuerySet to only contain pages that are in a private section and their descendants. r'rrrrr not_publicszPageQuerySet.not_publiccCs||SrrrrrrprivateszPageQuerySet.privateFcCs|s"|r|jd|jS|r:|jddd}n<|jtddtd|jj t dddd jd dd }t |}t||jj }|d kr|d | }|d kr|r|jd|jS|jjj|dS)a7 Find the first ancestor that all pages in this queryset have in common. For example, consider a page hierarchy like:: - Home/ - Foo Event Index/ - Foo Event Page 1/ - Foo Event Page 2/ - Bar Event Index/ - Bar Event Page 1/ - Bar Event Page 2/ The common ancestors for some queries would be: .. code-block:: python >>> Page.objects\ ... .type(EventPage)\ ... .first_common_ancestor() >>> Page.objects\ ... .type(EventPage)\ ... .filter(title__contains='Foo')\ ... .first_common_ancestor() This method tries to be efficient, but if you have millions of pages scattered across your page tree, it will be slow. If `include_self` is True, the ancestor can be one of the pages in the queryset: .. code-block:: python >>> Page.objects\ ... .filter(title__contains='Foo')\ ... .first_common_ancestor() >>> Page.objects\ ... .filter(title__exact='Bar Event Index')\ ... .first_common_ancestor() A few invalid cases exist: when the queryset is empty, when the root Page is in the queryset and ``include_self`` is False, and when there are multiple page trees with no common root (a case Wagtail does not support). If ``strict`` is False (the default), then the first root node is returned in these cases. If ``strict`` is True, then a ``ObjectDoesNotExist`` is raised. z'Can not find ancestor of empty querysetr T)Zflatr,) max_lengthZ output_field) parent_pathrrNzNo common ancestor found!r2)existsr>Z DoesNotExistZget_first_root_nodeZorder_byZ values_listannotaterr r9rZdistinct posixpath commonprefixr8ruget)rZ include_selfstrictr:Zcommon_parent_pathZ extra_charsrrrfirst_common_ancestors44      z"PageQuerySet.first_common_ancestorcCs|D] }|qdS)zB This unpublishes all live pages in the QuerySet. N)rf unpublish)rrorrrrs zPageQuerySet.unpublishcCs*|}d|_|j}|s |S|j|S)a7 Apply to a queryset to prevent fetching/decoding of StreamField values on evaluation. Useful when working with potentially large numbers of results, where StreamField values are unlikely to be needed. For example, when generating a sitemap or a long list of page links. T)rRrMr>Zget_streamfield_namesrW)rrSZstreamfield_namesrrrdefer_streamfields$s  zPageQuerySet.defer_streamfieldscCs|j|jddS)z\ This filters the QuerySet to only contain pages within the specified site. Tr)r)Z root_page)rsiterrrin_site2szPageQuerySet.in_sitecCs&t|jd}|s"|t|jdM}|S)Ntranslation_keyr)r rr)rror$r%rrrtranslation_of_q8s zPageQuerySet.translation_of_qcCs||||S)z This filters the QuerySet to only contain pages that are translations of the specified page. If inclusive is True, the page itself is returned. )r'rrror$rrrtranslation_of@szPageQuerySet.translation_ofcCs||||S)a` This filters the QuerySet to only contain pages that are not translations of the specified page. Note, this will include the page itself as the page is technically not a translation of itself. If inclusive is True, we consider the page to be a translation of itself so this excludes the page from the results. )r*rrrrrnot_translation_ofHszPageQuerySet.not_translation_ofcCs>ddlm}|jd}d}|jr*d}|t||ddS)a Performance optimisation for listing pages. Prefetches the active workflow states on each page in this queryset. Used by `workflow_in_progress` and `current_workflow_progress` properties on `wagtailcore.models.Page`. r,) WorkflowStateZcurrent_task_state__taskZ_workflow_statesZ_specific_workflow_statesZ_current_workflow_states)querysetZto_attr)modelsrruactiver]rZrar)rrZworkflow_statesZrelationrrrprefetch_workflow_statesRs  z%PageQuerySet.prefetch_workflow_statescCs<ddlm}|jt|jjddjttdt dddS) z Performance optimisation for listing pages. Annotates each page with the existence of an approved go live time. Used by `approved_schedule` property on `wagtailcore.models.Page`. r,)RevisionT)Zapproved_go_live_at__isnullrr)Z object_id)Z_approved_schedule) rrrr Zpage_revisionsr*r'r r r)rrrrrannotate_approved_scheduleks z'PageQuerySet.annotate_approved_schedulecCs|jttjjtdddS)z Performance optimisation for listing pages. Annotates each object with whether it is a root page of any site. Used by `is_site_root` method on `wagtailcore.models.Page`. r)Zroot_page__translation_key)Z _is_site_root)rr rrur'r rrrrannotate_site_root_state{sz%PageQuerySet.annotate_site_root_statecCs4|jttjj|jjjttdddddS)NrrZ locale_id)Zid__in)Z_has_untranslated_locale) rr rrur*r>r'r rxrrrr annotate_has_untranslated_locales z-PageQuerySet.annotate_has_untranslated_localeN)FF)F)F)!rFrGrHrhrfrirjrkrlrnrorprzr|r}r~rrrrrrrrrrrrrrrrrrrrrre@s<  j  rec@s2eZdZddZeeeeefdddZ dS)rVc #s|j}|jj|jddgR}||D]}tt}rf|D]"}fdd|D||d<qBdd|D}tt}|D]\}} || |qdd|D} i} g} |D]\} } | |  p|j }|j j | d}|j r|j|j }|jr|j|j}|jr t|d r |}d d|D| | <| fd d | Dq| r|j j j | dd}tjd dd|Dtdni}|D]n\}} z| | |}Wnty||}Yn0r||jiD]\}}t|||q|Vqq,dS)z Identify and return all specific items in a queryset, and return them in the same order, with any annotations intact. r content_typecsi|]\}}|vr||qSrr)r3kv)annotation_aliasesrr sz-SpecificIterable.__iter__..cSsg|]}|d|dgqS)rrr)r3rrrrr6z-SpecificIterable.__iter__..cSsi|]\}}|tj|qSr)rruZ get_for_id)r3_rrrrrsrrcSsi|] }|j|qSrr)r3itemrrrrrc3s|]}|vr|VqdSr\r)r3r)items_for_typerr rz,SpecificIterable.__iter__..zSpecific versions of the following items could not be found. This is most likely because a database migration has removed the relevant table or record since the item was created: {}cSsg|]}|j|j|jdqS))rmtitler|)rmrr)r3prrrr6scategoryN)rqueryZannotation_selectrx _get_chunksrrwitemsappendZ model_classr>rur'rNr]rOrarMhasattrrextendZin_bulkwarningswarnformatRuntimeWarningKeyErrorrrsetattr)rqsZ values_qsrxZannotations_by_pkdataZ pks_and_typesZ pks_by_typerrryZ items_by_typeZ missing_pksZpksr>rZ generic_itemsr annotationvaluer)rrr__iter__sp     zSpecificIterable.__iter__)returnccsd|jst|VnNg}||jD].}||t||jkr"t|V|q"|r`t|VdSr\)Z chunked_fetchtupleiterator chunk_sizerr8clear)rrZ current_chunkrrrrrs    zSpecificIterable._get_chunksN) rFrGrHrrrdictstrrrrrrrrVsWrVcseZdZfddZZS)rTc #s\tD]L}|jr|jVq tjd|jjd|jd|j d|j d t d|Vq dS)NzA specific version of the following object could not be returned because the specific model is not present on the active branch: r) rrZspecific_classZspecific_deferredrrrrFrmrrr)robjrrrrs  z!DeferredSpecificIterable.__iter__)rFrGrHrrJrrrrrTsrT)&rr collectionsrcollections.abcrtypingrZ django.appsrZ"django.contrib.contenttypes.modelsrZdjango.db.modelsrrr Zdjango.db.models.expressionsr r Zdjango.db.models.functionsr r rZdjango.db.models.queryrZtreebeard.mp_treerZwagtail.models.i18nrZwagtail.models.sitesrZwagtail.search.querysetrrrKrerVrTrrrrs,          |1Wk