BhyddlZddlZddlmZmZddlmZddlmZm Z m Z m Z ddl m Z ddlmZmZddlmZmZmZddlmZmZdd lmZdd lmZdd lmZmZdd lm Z dd l!m"Z"ddl#m$Z$m%Z&ddl'm(Z(ddl)m*Z*ddl+m,Z,m-Z-ddl.m/Z/ddl0m1Z1ddl2m3Z3Gdde jhZ5dedefdZ6Gddejne5Z8GddZ9y)N) lru_cachewraps) attrgetter)CallableOptionalTypeVarcast)forms)adminmessages)ImproperlyConfiguredObjectDoesNotExistValidationError) HttpRequest HttpResponse)Context)TemplateResponse) force_str smart_str)lazy)escapejs)gettext gettext_lazy) operations)SubClassNeededError) CMSPluginPage)get_plugin_tree) DJANGO_5_1)get_cms_settingc"eZdZdZfdZxZS)CMSPluginBaseMetaclasszj Ensure the CMSPlugin subclasses have sane values and set some defaults if they're not given. ct |}|Dcgc]}t|ts|}}|s |||||S|||||}t |j t std|j d|dt|dst|ds td|jsG|j dd}d td tf|i} td |ztjf| |_ |jsg} g} |j j j"D]_} | j$r| j&st| d r| j)| j*E| j)| j*a| rdd | ift-d | ddfg|_|j*st/j0dd||_d|vrd|_d|vrd|_|Scc}w)NzgThe 'model' attribute on CMSPluginBase subclasses must be either CMSPlugin or a subclass of CMSPlugin. z on z is not.render_templateget_render_templatez\CMSPluginBase subclasses must have a render_template attribute or get_render_template method)position placeholderlanguage plugin_typepathdepth)modelexcludeMetaz%sFormadvancedfieldszAdvanced options)collapse)r0classesz([a-z])([A-Z])z \g<1> \g<2> get_extra_placeholder_menu_itemsTget_extra_plugin_menu_items)super__new__ isinstancer" issubclassr,rrhasattrr formtypeobjectr ModelForm fieldsets_metar0 auto_creatededitableappendname_resub!_has_extra_placeholder_menu_items_has_extra_plugin_menu_items)clsrCbasesattrs super_newbaseparents new_pluginform_meta_attrs form_attrs basic_fieldsadvanced_fieldsf __class__s ?/home/dcms/DCMS/lib/python3.12/site-packages/cms/plugin_base.pyr6zCMSPluginBaseMetaclass.__new__ sGO $)VDZ>T-U4VVS$u5 5sD%7 ***I6%S]ScSceoq  z#45gjRg>h&n #))bO!$vy/"JKJ"8d?U__4F SJO##L O%%++22 4~~!**q*-'..qvv6$++AFF3  4 Hl34)*S`,ab( $  ff%5MJO . 6;?J 8 (E 16:J 3gWs GG)__name__ __module__ __qualname____doc__r6 __classcell__rUs@rVr"r"s 55r"methodreturncd|_|S)a Decorator that enables global caching for methods based on placeholder slots and templates. This decorator marks methods that should participate in the CMS's template and slot-based caching system. Decorated methods will have their results cached according to the configuration specified in CMS_PLACEHOLDER_CONF. Args: method: The method to be decorated. Returns: The decorated method with template slot caching enabled. Example: @template_slot_caching def get_child_class_overrides(cls, slot: str, page: Optional[Page] = None, instance: Optional[CMSPlugin] = None): # Method implementation... pass T)_template_slot_caching)r^s rVtemplate_slot_cachingrbXs*%)F! Mr]c $eZdZdZdZedZdZdZ dZ dZ dZ e Z dZ dZdZ dZdZdZdZdZdZed ZdZdZdZdZed Z dZiZd5fd Z d Z!e"rd Z#e$d Z%dZ&e$dZ'e$e(d6de)e*de)e fdZ+e$e,d5de-de)e*de)e de.fdZ/dZ0dZ1d7fd Z2 d8de3de)e de)e-de)e4de)e4de5f dZ6dZ7fd Z8d!Z9d"Z:d6d#Z;d6d$Zd'Z?d6fd( Z@e$d6d)ZAe$e,d5de-de)e*de)e fd*ZBe$d6de-de)e*deCfd+ZDe$e, d9de)e*de)e d,e.deCfd-ZEe$e,d5de-de)e*de)e fd.ZFd/ZGd0ZHeIeHZHe$d1ZJe$d2ZKd3ZLd4ZMxZNS): CMSPluginBasez Inherits :class:`django:django.contrib.admin.ModelAdmin` and in most respects behaves like a normal subclass. Note however that some attributes of ``ModelAdmin`` simply won't make sense in the context of a Plugin. GenericNz&admin/cms/page/plugin/change_form.htmlFTALWAYS_REFRESH_CONTENT PLUGIN_CACHEc|rt||j|d|_d|_d|_d|_i|_d|_y)NF) r5__init__r,object_successfully_changedr'pagecms_plugin_instance_cms_initial_attributes_operation_token)selfr, admin_siterUs rVrjzCMSPluginBase.__init__ sJ  G TZZ 4+0( #' (*$ $r]ct|dr|j|||}nt|ddrt|dd}nd}|std|jz|S)Nr%r$Fz!plugin has no render_template: %s)r9r%getattrrrU)rpcontextinstancer'templates rV_get_render_templatez"CMSPluginBase._get_render_templates_ 4. ///;OH T,e 4t%6>HH!"E"VW Wr]ctN) TypeError)rIitems rV__class_getitem__zCMSPluginBase.__class_getitem__+sOr]cJ|jjjSry)r,_default_managerall)rIs rVget_render_querysetz!CMSPluginBase.get_render_queryset.syy))--//r]c||d<||d<|S)aThis method returns the context to be used to render the template specified in :attr:`render_template`. :param dict context: The context with which the page is rendered. :param instance: The instance of your plugin that is rendered. :type instance: :class:`cms.models.pluginmodel.CMSPlugin` instance :param str placeholder: The name of the placeholder that is rendered. :rtype: `dict` or :class:`django.template.Context` This method must return a dictionary or an instance of :class:`django.template.Context`, which will be used as context to render the plugin template. By default, this method will add ``instance`` and ``placeholder`` to the context, which means for simple plugins, there is no need to overwrite this method. If you overwrite this method it's recommended to always populate the context with default values by calling the render method of the super class:: def render(self, context, instance, placeholder): context = super().render(context, instance, placeholder) ... return context rur')rprtrur's rVrenderzCMSPluginBase.render2s6' !, r]cb|j||ry|j||}t|S)NT)get_require_parentget_parent_classesbool)rIslotrlallowed_parentss rVrequires_parent_pluginz$CMSPluginBase.requires_parent_pluginQs2  ! !$ -00t<O$$r]rlruc|rt|jtS|i|jjrSt |jjdr3t|jjjtSy)zCache page template because page.get_template() might have to fetch the page content object from the db since django CMS 4N get_template)rrstrr'sourcer9)rIrlrus rV_get_template_for_confz$CMSPluginBase._get_template_for_confYst /4))3/1 1  $$++,,33^DG4,,33@@#FH Hr]rr_cbddlm}|j||}|d|||j}|S)Nrget_placeholder_confrequire_parentdefault)cms.utils.placeholderrrr)rIrrlrurrvrs rVrz CMSPluginBase.get_require_parentjs9 ?--dH=..>hX[XjXjkr]cy)a Provides hints to the placeholder, and in turn to the page for determining the appropriate Cache-Control headers to add to the HTTPResponse object. :param request: Relevant ``HTTPRequest`` instance. :param instance: The ``CMSPlugin`` instance that is being rendered. :rtype: ``None`` or ``datetime`` or ``time_delta`` or ``int`` Must return one of: :``None``: This means the placeholder and the page will not even consider this plugin when calculating the page expiration; :``datetime``: A specific date and time (timezone-aware) in the future when this plugin's content expires; .. important:: The returned ``datetime`` must be timezone-aware or the plugin will be ignored (with a warning) during expiration calculations. :``datetime.timedelta``: A timedelta instance indicating how long, relative to the response timestamp that the content can be cached; :``int``: An integer number of seconds that this plugin's content can be cached. There are constants are defined in ``cms.constants`` that may be useful: :const:`~cms.constants.EXPIRE_NOW` and :const:`~cms.constants.MAX_EXPIRATION_TTL`. An integer value of 0 (zero) or :const:`~cms.constants.EXPIRE_NOW` effectively means "do not cache". Negative values will be treated as :const:`~cms.constants.EXPIRE_NOW`. Values exceeding the value :const:`~cms.constants.MAX_EXPIRATION_TTL` will be set to that value. Negative `timedelta` values or those greater than ``MAX_EXPIRATION_TTL`` will also be ranged in the same manner. Similarly, ``datetime`` values earlier than now will be treated as ``EXPIRE_NOW``. Values greater than ``MAX_EXPIRATION_TTL`` seconds in the future will be treated as ``MAX_EXPIRATION_TTL`` seconds in the future. Nrrprequestrur's rVget_cache_expirationz"CMSPluginBase.get_cache_expirationus\r]cy)a Returns an HTTP VARY header string or a list of them to be considered by the placeholder and in turn by the page to caching behaviour. Overriding this method is optional. Must return one of: :``None``: This means that this plugin declares no headers for the cache to be varied upon. (default) :string: The name of a header to vary caching upon. :list of strings: A list of strings, each corresponding to a header to vary the cache upon. .. note:: This only makes sense to use with caching. If this plugin has ``cache = False`` or plugin.get_cache_expiration(...) returns 0, get_vary_cache_on() will have no effect. Nrrs rVget_vary_cache_onzCMSPluginBase.get_vary_cache_ons2r]c|jd|jvd|tddt|||||||S)z7 We just need the popup interface here no_previewT MEDIA_URL)previewis_popupplugin CMS_MEDIA_URL)updateGETr r5render_change_form)rprrtaddchangeform_urlobjrUs rVrz CMSPluginBase.render_change_formsM 'w{{: !0!=   w)'7CSVWWr]rraction extra_data extra_contextc tj|Dcgc]&}|j|j|jd(}}s!d||d|xsid|xsi}t |d|S j rj jn} | gt| jz} |dvr| dntfd| Dd } t|| | } tfd | d Di} di| |ttj| |d |xsid|xsi}t |d|Scc}w#t$r} YwxYw)a~ Renders the close frame for a CMS plugin in the Django admin interface. This method is used to send information to the javascript frontend after an edit action has taken place. It allows the javascript frontend to update the structure and content on the edit endpoints. Args: request (HttpRequest): The HTTP request object. obj (CMSPlugin): The CMS plugin instance being rendered. action (Optional[str]): The action being performed on the plugin. Defaults to "edit". Possible values are "add", "edit", "move", and "delete". extra_data (Optional[Context]): Additional data to include in the data bridge to the frontend. Defaults to None. extra_context (Optional[Context]): Additional context to include in the rendering. Defaults to None. Returns: HttpResponse: The rendered confirmation form as an HTTP response. Raises: ObjectDoesNotExist: If the parent plugin is a ghost plugin and the plugin tree cannot be fetched. Notes: - Handles edge cases where the parent plugin is a ghost plugin. - Constructs the plugin tree structure and gathers plugin-specific data for rendering. - Includes messages from the request in the context. )levelmessagetagsT)rr )r data_bridgez'admin/cms/page/plugin/confirm_form.html)rdeleterc3VK|] }|jjk(s|"ywrypk).0rrs rV z3CMSPluginBase.render_close_frame..s K&vyyCFF7JvKs))N) target_pluginc3HK|]}|djk(s|yw) plugin_idNr)r plugin_datars rVrz3CMSPluginBase.render_close_frame..s% g[KP[D\`c`f`fDf[ gs""plugins)r plugin_desc structurer )rrr)r get_messagesrrrrparentget_bound_pluginrlistget_descendantsnextrrrget_short_description)rprrrrrr dj_messagesrtrootrrrrs ` rVrender_close_framez CMSPluginBase.render_close_framesZ$009   !"??    !$ + "'R !&BG$G-VX_` ` 47JJ3::..0CD&4 4 4 677** AJKGKTR  $GWMR  gIi,@ gik  ' #2K2K2M(NO&'  #   "   )RT[\\u 0"  D  s+D;*(E E Ec\ddlm}|j}|j|jj}||d}|rL|j j j|j|d<||d<tj|d<n\|jr|jjnd} |jj| } ||d <tj|d<| |d <|jd i||_|j!||_|j%|j&y) z Override original method, and add some attributes to obj This has to be made, because if the object is newly created, it must know where it lives. r)site)rr'r old_pluginrO operationNr tree_orderr)django.contrib.adminrr' _registryrUr,objectsgetrr CHANGE_PLUGINrget_plugin_tree_order ADD_PLUGIN_send_pre_placeholder_operationro add_plugin saved_object clear_cacher() rprrr:rrplpl_adminoperation_kwargs parent_idrs rV save_modelzCMSPluginBase.save_model2s  . __>>#//";";<  -1ZZ-?-?-C-Csvv-C-N \ *-0 \ *,6,D,D [ )), I>>yIJ), X &,6,A,A [ )-7 \ * H H H \K[ \MM#. s||$r]ct||||}|jjD]\}}t ||||Sry)r5 save_formrnitemssetattr)rprr:rrfieldvaluerUs rVrzCMSPluginBase.save_formQsKgv6 88>>@ 'LE5 C & ' r]c 8d|_|j||dS)NTrr)rkr)rprrkwargss rV response_addzCMSPluginBase.response_addYs$+/( &&wE&BBr]cd|_|jj}t|jt|d}t d|z}|j ||tj|j||dS)NT)rCrz0The %(name)s "%(obj)s" was changed successfully.rr) rkr,r?r verbose_namerD message_userr SUCCESSr)rprroptsmsg_dictmsgs rVresponse_changezCMSPluginBase.response_changeasr+/(zz%d&7&783PBChN '3(8(89&&wH&EEr]cyryr)rprrbypasss rV log_additionzCMSPluginBase.log_additioni r]cyryr)rprrrrs rV log_changezCMSPluginBase.log_changelrr]cyryr)rprr object_reprrs rV log_deletionzCMSPluginBase.log_deletionorr]cy)alDeprecated: Since djangocms-text-ckeditor introduced inline previews of plugins, the icon will not be rendered in TextPlugins anymore. By default, this returns an empty string, which, if left un-overridden would result in no icon rendered at all, which, in turn, would render the plugin un-editable by the operator inside a parent text plugin. Therefore, this should be overridden when the plugin has text_enabled set to True to return the path to an icon to display in the text of the text plugin. :param instance: The instance of the plugin model. :type instance: :class:`cms.models.pluginmodel.CMSPlugin` instance Example:: def icon_src(self, instance): return static("cms/img/icons/plugins/link.png") See also: :attr:`text_enabled`, :meth:`icon_alt` rerrprus rVicon_srczCMSPluginBase.icon_srcrs*r]cHt|jdt|S)a Overwrite this if necessary if ``text_enabled = True`` Return the 'alt' text to be used for an icon representing the plugin object in a text editor. :param instance: The instance of the plugin model to provide specific information for the 'alt' text. :type instance: :class:`cms.models.pluginmodel.CMSPlugin` instance By default, :meth:`icon_alt` will return a string of the form: "[plugin type] - [instance]", but can be modified to return anything you like. This function accepts the ``instance`` as a parameter and returns a string to be used as the ``alt`` text for the plugin's preview or icon. Authors of text-enabled plugins should consider overriding this function as it will be rendered as a tooltip in most browser. This is useful, because if the same plugin is used multiple times, this tooltip can provide information about its configuration. See also: :attr:`text_enabled`, :meth:`icon_src`. z - )rrCrs rVicon_altzCMSPluginBase.icon_alts%2DII&'s9X+>*?@@r]ct|||}|D]\}}|jds|cS|jrgS |j ||ddd<|S#t $rY|SwxYw)z^ Same as from base class except if there are no fields, show an info message. r0)rr description)r5 get_fieldsetsrinlinesget_empty_change_form_textKeyError)rprrr>rCdatarUs rVrzCMSPluginBase.get_fieldsetssG)'37 # !JD$xx!   ! <<I -1-L-LQT-L-UIaLOM *   sA A*)A*ctdS)zv Returns the text displayed to the user when editing a plugin that requires no configuration. zAThere are no further settings for this plugin. Please press save.)r)rIrs rVrz(CMSPluginBase.get_empty_change_form_texts Z[[r]cddlm}|j||}|d||i}|j|j|j S)ze Returns a list of plugin types that are allowed as children of this plugin. rr child_classesr)rrrrrWr )rIrrlrurrvph_confs rVget_child_class_overridesz'CMSPluginBase.get_child_class_overridessG ?--dH='hPRS{{3<<):):;;r]c6ddlm}|j||dS)z Returns a list of all plugin classes that will be considered when fetching all available child classes for this plugin. r) plugin_poolF) root_plugin)cms.plugin_poolr get_all_plugins)rIrrlr s rVget_child_plugin_candidatesz)CMSPluginBase.get_child_plugin_candidatess 0**45*IIr] only_uncachedc|j|||}|j||}|r)|Dcgc]}|j|vs|jc}S|r|Dcgc]}|jr|}}g}|j}|D]7} | j |||} | r|| vs|j | j9|Scc}wcc}w)zf Returns a list of plugin types that can be added as children to this plugin. )rlru)r rrWcache_parent_classesrrB) rIrrlrurr installed_pluginsrr) plugin_classrs rVget_child_classeszCMSPluginBase.get_child_classess55dPX5Y ;;D$G 2ChvZgGgFOOh h 6G kFvOjOj k  k ll . /`` in the default case). ``get_plugin_urls()`` is useful if your plugin needs to talk asynchronously to the admin. rrps rVget_plugin_urlszCMSPluginBase.get_plugin_urlss  r]c"|jSry)rrs rV plugin_urlszCMSPluginBase.plugin_urlss##%%r]cy)aMExtends the placeholder context menu for all placeholders. To add one or more custom context menu items that are displayed in the context menu for all placeholders when in structure mode, override this method in a related plugin to return a list of :class:`cms.plugin_base.PluginMenuItem` instances. Nr)rprr's rVr3z.CMSPluginBase.get_extra_placeholder_menu_items# r]cy)a>Extends the plugin context menu for all plugins. To add one or more custom context menu items that are displayed in the context menu for all plugins when in structure mode, override this method in a related plugin to return a list of :class:`cms.plugin_base.PluginMenuItem` instances. Nr)rIrrs rVr4z)CMSPluginBase.get_extra_plugin_menu_items-r r]c,t|jSry)rrCrs rV__repr__zCMSPluginBase.__repr__7s##r]c|jSry)rCrs rV__str__zCMSPluginBase.__str__:s yyr])NNry)FFreN)editNN)NNF)OrWrXrYrZrCrDmoduler:change_form_template admin_previewr$ render_pluginrr, text_enabled page_onlyallow_childrenr rrdisable_child_plugins disable_edit show_add_formr is_localcache_child_classesrrGrHcachesystemrrjrwrr| classmethodrrrrrrrrbrrrrrrrrrrrrrrrrrrrrrr rrrrrrpropertyr3r4r#r%r[r\s@rVrdrdqs Dy\F DC MOM EL 5"IN.MNN"L M##;<%% (4. HYDW  c$RZ[dRequ.`6 X&!'(,+/ a]a]i a] a] W% a]  ( a] a]F%>CF   .A6&\\ rr?s rVrjzPluginMenuItem.__init__KsEJ ::d#D     $r])NNajaxN)rWrXrYrZrjrr]rVr9r9>s   %r]r9):r;rE functoolsrroperatorrtypingrrrr djangor django.contribr r django.core.exceptionsr rr django.httprrdjango.templaterdjango.template.responserdjango.utils.encodingrrdjango.utils.functionalrdjango.utils.htmlrdjango.utils.translationrrrDcmsrcms.exceptionsr cms.modelsrrcms.toolbar.utilsrcms.utils.compatrcms.utils.confr MediaDefiningClassr"rb ModelAdminrdr9rr]rVrVs &44*\\1#56(&?.&-'*;U55;|(x2J E$$0FJ Z%%r]