a D ge@sddlmZddlmZddlmZddlmZddlm Z ddl m Z ddl m Z ddlmZdd lmZdd lmZdd lmZdd lmZmZdd lmZddlmZddlmZmZddl m!Z!ddl"m#Z#ddl$m%Z%ddl&m'Z'm(Z(Gddde'Z)Gddde(Z*dS))warn)get_permission_codename) Permission) ContentType)ImproperlyConfigured)modelform_factory)redirect)path)cached_property)capfirst)hooks)ModelAdminURLFinderregister_admin_url_finder) ObjectList)generic)historyusage)ReferenceIndex)ModelPermissionPolicy)RemovedInWagtail70Warning)ViewSet ViewSetGroupcseZdZdZdZejZejZ ej Z ej Z ejZejZejZejZdZdZdZdZgZgZdZdxfdd Ze d d Z!e"d d Z#fd dZ$ddZ%ddZ&ddZ'ddZ(ddZ)ddZ*ddZ+ddZ,e dd Z-e d!d"Z.e d#d$Z/e d%d&Z0e d'd(Z1e d)d*Z2e d+d,Z3e d-d.Z4e d/d0Z5e d1d2Z6e d3d4Z7e d5d6Z8dyd8d9Z9e"d:d;Z:e"dd?Ze"dDdEZ?e"dFdGZ@e"dHdIZAe"dJdKZBe"dLdMZCe"dNdOZDe"dPdQZEe"dRdSZFe"dTdUZGe"dVdWZHe"dXdYZIe"dZd[ZJd\d]ZKdzd^d_ZLd`daZMdbdcZNdddeZOe"dfdgZPe dhdiZQdjdkZRdldmZSdndoZTdpdqZUdrdsZVe"dtduZWfdvdwZXZYS){ ModelViewSeta  A viewset to allow listing, creating, editing and deleting model instances. All attributes and methods from :class:`~wagtail.admin.viewsets.base.ViewSet` are available. For more information on how to use this class, see :ref:`generic_views`. TNFc sJtjfd|i||js(td||jj|_|jj|_|jj|_dS)NnamezJModelViewSet %r must define a `model` attribute or pass a `model` argument)super__init__modelr_meta model_opts app_label model_name)selfrkwargs __class__[/var/www/lab.imftr.de/x/nb_venv/lib/python3.9/site-packages/wagtail/admin/viewsets/model.pyrcs  zModelViewSet.__init__cCs t|jSN)rrr$r(r(r)permission_policyoszModelViewSet.permission_policycCs|jS)z Viewset name, to use as the URL prefix and namespace. Defaults to the :attr:`~django.db.models.Options.model_name`. )r#r+r(r(r)rsszModelViewSet.namec stjfi|j|j|d|d|d|d|d|d|d|jd |}|jrp|d |d <|jr|d |d <|S) Nindex index_resultsrraddeditdelete) rr,Zindex_url_nameZindex_results_url_nameZhistory_url_nameZusage_url_nameZ add_url_name edit_url_nameZdelete_url_name header_iconcopyZ copy_url_nameinspectZinspect_url_name)rget_common_view_kwargsrr, get_url_nameZiconcopy_view_enabledinspect_view_enabledr$r%Z view_kwargsr&r(r)r6{s(  z#ModelViewSet.get_common_view_kwargsc KsJ|j|j|j|j|j|j|j|j|j|j |j d |}|j rF|j |d<|S)N) template_nameresults_template_name list_display list_filter list_exportexport_headingsexport_filenamefilterset_class search_fieldssearch_backend_nameZ paginate_byZdefault_ordering) index_template_nameindex_results_template_namer=r>r?r@rArBrCrD list_per_pageorderingr:r(r(r)get_index_view_kwargss"  z"ModelViewSet.get_index_view_kwargscKs|j||jd|S)NZpanelZ form_classr;) _edit_handlerget_form_classcreate_template_namer$r%r(r(r)get_add_view_kwargss z ModelViewSet.get_add_view_kwargscKs|j|jdd|jd|S)NT) for_updaterJ)rKrLedit_template_namerNr(r(r)get_edit_view_kwargss  z!ModelViewSet.get_edit_view_kwargscKsd|ji|S)Nr;)delete_template_namerNr(r(r)get_delete_view_kwargssz#ModelViewSet.get_delete_view_kwargscKs|j|ddd|S)Nhistory_resultsr)r;Zhistory_results_url_namer3)history_template_namer7rNr(r(r)get_history_view_kwargss z$ModelViewSet.get_history_view_kwargscKsd|jd|jjdi|S)Nr;rfallback) get_templatesusage_view_classr;rNr(r(r)get_usage_view_kwargss z"ModelViewSet.get_usage_view_kwargscKs|j|j|jd|S)N)r;fieldsZfields_exclude)inspect_template_nameinspect_view_fieldsinspect_view_fields_excluderNr(r(r)get_inspect_view_kwargss z$ModelViewSet.get_inspect_view_kwargscKs|jfi|Sr*)rOrNr(r(r)get_copy_view_kwargssz!ModelViewSet.get_copy_view_kwargscCs|j|jfi|Sr*construct_viewindex_view_classrIr+r(r(r) index_views zModelViewSet.index_viewcCs |j|jfi|ddiSNZ results_onlyTrcr+r(r(r)index_results_viewszModelViewSet.index_results_viewcCs|j|jfi|Sr*)rdadd_view_classrOr+r(r(r)add_viewszModelViewSet.add_viewcCs|j|jfi|Sr*)rdedit_view_classrRr+r(r(r) edit_viewszModelViewSet.edit_viewcCs|j|jfi|Sr*)rddelete_view_classrTr+r(r(r) delete_views zModelViewSet.delete_viewcsfdd}|S)Ncs(tdjjtdtd|ddS)NzQ%s's `//` edit view URL pattern has been deprecated in favour of /edit//.categoryr0TZ permanentrr'__name__rrr7requestpkr+r(r)redirect_to_editsz.redirect_to_editr()r$rwr(r+r)redirect_to_edit_views z"ModelViewSet.redirect_to_edit_viewcsfdd}|S)Ncs(tdjjtdtd|ddS)Nz\%s's `//delete/` delete view URL pattern has been deprecated in favour of /delete//.ror1Trqrrrtr+r(r)redirect_to_deletesz@ModelViewSet.redirect_to_delete_view..redirect_to_deleter()r$ryr(r+r)redirect_to_delete_views z$ModelViewSet.redirect_to_delete_viewcCs|j|jfi|Sr*rdhistory_view_classrWr+r(r(r) history_view s zModelViewSet.history_viewcCs |j|jfi|ddiSrgr{r+r(r(r)history_results_viewsz!ModelViewSet.history_results_viewcCs|j|jfi|Sr*)rdr[r\r+r(r(r) usage_views zModelViewSet.usage_viewcCs|j|jfi|Sr*)rdinspect_view_classrar+r(r(r) inspect_views zModelViewSet.inspect_viewcCs|j|jfi|Sr*)rdcopy_view_classrbr+r(r(r) copy_view%szModelViewSet.copy_viewr-cCsd|js |gS|j|jd|jd|d|j|jd|d|j|dg}|r`|||S)z Utility function that provides a list of templates to try for a given view, when the template isn't overridden by one of the template attributes on the class. /z.html)template_prefixr"r#append)r$rrYZ templatesr(r(r)rZ)s zModelViewSet.get_templatescCs|jd|jjdS)ac A template to be used when rendering ``index_view``. Default: if :attr:`template_prefix` is specified, an ``index.html`` template in the prefix directory and its ``{app_label}/{model_name}/`` or ``{app_label}/`` subdirectories will be used. Otherwise, the ``index_view_class.template_name`` will be used. r-rX)rZrer;r+r(r(r)rE:s z ModelViewSet.index_template_namecCs|jd|jjdS)az A template to be used when rendering ``index_results_view``. Default: if :attr:`template_prefix` is specified, a ``index_results.html`` template in the prefix directory and its ``{app_label}/{model_name}/`` or ``{app_label}/`` subdirectories will be used. Otherwise, the ``index_view_class.results_template_name`` will be used. r.rX)rZrer<r+r(r(r)rFIs z(ModelViewSet.index_results_template_namecCs|jd|jjdS)a_ A template to be used when rendering ``add_view``. Default: if :attr:`template_prefix` is specified, a ``create.html`` template in the prefix directory and its ``{app_label}/{model_name}/`` or ``{app_label}/`` subdirectories will be used. Otherwise, the ``add_view_class.template_name`` will be used. createrX)rZrir;r+r(r(r)rMXs z!ModelViewSet.create_template_namecCs|jd|jjdS)a` A template to be used when rendering ``edit_view``. Default: if :attr:`template_prefix` is specified, an ``edit.html`` template in the prefix directory and its ``{app_label}/{model_name}/`` or ``{app_label}/`` subdirectories will be used. Otherwise, the ``edit_view_class.template_name`` will be used. r0rX)rZrkr;r+r(r(r)rQgs zModelViewSet.edit_template_namecCs|jd|jjdS)am A template to be used when rendering ``delete_view``. Default: if :attr:`template_prefix` is specified, a ``confirm_delete.html`` template in the prefix directory and its ``{app_label}/{model_name}/`` or ``{app_label}/`` subdirectories will be used. Otherwise, the ``delete_view_class.template_name`` will be used. Zconfirm_deleterX)rZrmr;r+r(r(r)rSvs z!ModelViewSet.delete_template_namecCs|jd|jjdS)ah A template to be used when rendering ``history_view``. Default: if :attr:`template_prefix` is specified, a ``history.html`` template in the prefix directory and its ``{app_label}/{model_name}/`` or ``{app_label}/`` subdirectories will be used. Otherwise, the ``history_view_class.template_name`` will be used. rrX)rZr|r;r+r(r(r)rVs z"ModelViewSet.history_template_namecCs|jd|jjdS)ai A template to be used when rendering ``inspect_view``. Default: if :attr:`template_prefix` is specified, an ``inspect.html`` template in the prefix directory and its ``{app_label}/{model_name}/`` or ``{app_label}/`` subdirectories will be used. Otherwise, the ``inspect_view_class.template_name`` will be used. r5rX)rZrr;r+r(r(r)r^s z"ModelViewSet.inspect_template_namecCs|jjS)a@ A list or tuple, where each item is either: - The name of a field on the model; - The name of a callable or property on the model that accepts a single parameter for the model instance; or - An instance of the ``wagtail.admin.ui.tables.Column`` class. If the name refers to a database field, the ability to sort the listing by the database column will be offerred and the field's verbose name will be used as the column header. If the name refers to a callable or property, an ``admin_order_field`` attribute can be defined on it to point to the database column for sorting. A ``short_description`` attribute can also be defined on the callable or property to be used as the column header. This list will be passed to the ``list_display`` attribute of the index view. If left unset, the ``list_display`` attribute of the index view will be used instead, which by default is defined as ``["__str__", wagtail.admin.ui.tables.UpdatedAtColumn()]``. )rer=r+r(r(r)r=szModelViewSet.list_displaycCs|jjS)a A list or tuple, where each item is the name of model fields of type ``BooleanField``, ``CharField``, ``DateField``, ``DateTimeField``, ``IntegerField`` or ``ForeignKey``. Alternatively, it can also be a dictionary that maps a field name to a list of lookup expressions. This will be passed as django-filter's ``FilterSet.Meta.fields`` attribute. See `its documentation `_ for more details. If ``filterset_class`` is set, this attribute will be ignored. )rer>r+r(r(r)r>szModelViewSet.list_filtercCs|jS)a A subclass of ``wagtail.admin.filters.WagtailFilterSet``, which is a subclass of `django_filters.FilterSet `_. This will be passed to the ``filterset_class`` attribute of the index view. ) UNDEFINEDr+r(r(r)rBszModelViewSet.filterset_classcCs|jjS)z The fields to use for the search in the index view. If set to ``None`` and :attr:`search_backend_name` is set to use a Wagtail search backend, the ``search_fields`` attribute of the model will be used instead. )rerCr+r(r(r)rCszModelViewSet.search_fieldscCs|jjS)z The name of the Wagtail search backend to use for the search in the index view. If set to a falsy value, the search will fall back to use Django's QuerySet API. )rerDr+r(r(r)rDsz ModelViewSet.search_backend_namecCs|jjS)z A list or tuple, where each item is the name of a field, an attribute, or a single-argument callable on the model to be exported. )rer?r+r(r(r)r?szModelViewSet.list_exportcCs|jjS)zr A dictionary of export column heading overrides in the format ``{field_name: heading}``. )rer@r+r(r(r)r@szModelViewSet.export_headingscCs |jjjS)z The base file name for the exported listing, without extensions. If unset, the model's :attr:`~django.db.models.Options.db_table` will be used instead. )rr Zdb_tabler+r(r(r)rAszModelViewSet.export_filenamecCs t|jjSr*)r r!Zverbose_name_pluralr+r(r(r) menu_labelszModelViewSet.menu_labelcs4ddlm}fdd}tjjd|fd|iS)Nr)MenuItemcsj|jjjSr*)r,Zuser_has_any_permissionuserreZany_permission_required)_selfrur+r(r)is_showns z.ModelViewSet.menu_item_class..is_shownrr)Zwagtail.admin.menurtyperrs)r$rrr(r+r)menu_item_classs   zModelViewSet.menu_item_classcKs|jfi|Sr*)Z formfield)r$Zdb_fieldr%r(r(r)formfield_for_dbfieldsz"ModelViewSet.formfield_for_dbfieldcCsL|jr|jS|}|}|dur8|dur8tdt|j|j||dS)zL Returns the form class to use for the create / edit forms. NzaSubclasses of ModelViewSet must specify 'get_form_class', 'form_fields' or 'exclude_form_fields'.)Zformfield_callbackr]exclude)rKrLget_form_fieldsget_exclude_form_fieldsrrrr)r$rPr]rr(r(r)rLs zModelViewSet.get_form_classcCs t|ddS)zc Returns a list or tuple of field names to be included in the create / edit forms. Z form_fieldsNgetattrr+r(r(r)r/szModelViewSet.get_form_fieldscCs t|ddS)ze Returns a list or tuple of field names to be excluded from the create / edit forms. Zexclude_form_fieldsNrr+r(r(r)r5sz$ModelViewSet.get_exclude_form_fieldscCspt|dr|j}nRt|dr,|j}t|}n8t|jdrB|jj}n"t|jdr`|jj}t|}ndS||jS)a Returns the appropriate edit handler for this ``ModelViewSet`` class. It can be defined either on the model itself or on the ``ModelViewSet``, as the ``edit_handler`` or ``panels`` properties. If none of these are defined, it will return ``None`` and the form will be constructed as a Django form using :meth:`get_form_class` (without using :ref:`forms_panels_overview`). edit_handlerpanelsN)hasattrrrrrZ bind_to_model)r$rrr(r(r)get_edit_handler;s       zModelViewSet.get_edit_handlercCs|S)zj An edit handler that has been bound to the model class, to be used across views. )rr+r(r(r)rKRszModelViewSet._edit_handlercCstdtf|j|ddS)NZ_ModelAdminURLFinderr0)r,r2)rr r,r7r+r(r(r)url_finder_classZszModelViewSet.url_finder_classcCst|j|jdSr*)rrrr+r(r(r)resz&ModelViewSet.register_admin_url_findercCs|jrt|jdSr*)add_to_reference_indexrZregister_modelrr+r(r(r)register_reference_indexhsz%ModelViewSet.register_reference_indexcCs:tj|j}tjj|d}|js6|jtd|j d}|S)aR Returns a queryset of :class:`~django.contrib.auth.models.Permission` objects to be registered with the :ref:`register_permissions` hook. By default, it returns all permissions for the model if :attr:`inspect_view_enabled` is set to ``True``. Otherwise, the "view" permission is excluded. ) content_typeview)codename) rZobjectsZ get_for_modelrrfilterr9rrr!)r$rZ permissionsr(r(r)get_permissions_to_registerls z(ModelViewSet.get_permissions_to_registercCstd|jdS)Nregister_permissions)r registerrr+r(r(r)r}sz!ModelViewSet.register_permissionsc Cstd|jddtd|jddtd|jddtd|jd dtd |jd dtd |jd dtd|jddtd|jddg}|j r| td|j dd|j r| td|j dd||j7}|S)Nrr-)rzresults/r.znew/r/zedit//r0zdelete//r1zhistory//rzhistory-results//rUzusage//rzinspect//r5zcopy//r4)r rfrhrjrlrnr}r~rr9rrr8r_legacy_urlpatterns)r$Z urlpatternsr(r(r)get_urlpatternss* zModelViewSet.get_urlpatternscCstd|jtd|jgS)Nz /z/delete/)r rxrzr+r(r(r)rs  z ModelViewSet._legacy_urlpatternscs&t|||dSr*)r on_registerrrrr+r&r(r)rs zModelViewSet.on_register)N)r-r)F)Zrs __module__ __qualname____doc__rrZ IndexViewreZ CreateViewriZEditViewrkZ DeleteViewrmrZ HistoryViewr|rZ UsageViewr[ZCopyViewrZ InspectViewrrrGrHr9r_r`r8rpropertyr,r rr6rIrOrRrTrWr\rarbrfrhrjrlrnrxrzr}r~rrrrZrErFrMrQrSrVr^r=r>rBrCrDr?r@rArrrrLrrrrKrrrrrrrr __classcell__r(r(r&r)rs                                        rc@s$eZdZdZddZeddZdS)ModelViewSetGroupz A container for grouping together multiple :class:`~wagtail.admin.viewsets.model.ModelViewSet` instances. All attributes and methods from :class:`~wagtail.admin.viewsets.base.ViewSetGroup` are available. cCs,|jD] }t|dd}rt|SqdS)Nr"r)Z registerablesrr )r$instancer"r(r(r)get_app_label_from_subitemss z-ModelViewSetGroup.get_app_label_from_subitemscCs|Sr*)rr+r(r(r)rszModelViewSetGroup.menu_labelN)rsrrrrr rr(r(r(r)rsrN)+warningsrZdjango.contrib.authrZdjango.contrib.auth.modelsrZ"django.contrib.contenttypes.modelsrZdjango.core.exceptionsrZdjango.forms.modelsrZdjango.shortcutsrZ django.urlsr Zdjango.utils.functionalr Zdjango.utils.textr Zwagtailr Zwagtail.admin.admin_url_finderr rZwagtail.admin.panels.grouprZwagtail.admin.viewsrZwagtail.admin.views.genericrrZwagtail.modelsrZwagtail.permissionsrZwagtail.utils.deprecationrbaserrrrr(r(r(r)s2