BhadZddlZddlmZddlmZddlmZmZddl m Z m Z ddl m Z ddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZmZmZm Z ddl!m"Z"ddl#m$Z$ddl%m&Z&ddl'm(Z(ddl)m*Z*ddl+m,Z,ddl-m.Z.ddl/m0Z0ddl1m2Z2m3Z3ddl4m5Z5ddl6m7Z7ddl8m9Z9dZ:dZ;e jxdddddddddddddddddejzd dej|fd!Z?e jxdddddddddddeejzej|fd"Z@dddddddddddeejzej|fd#ZAe jxd-d$ZB d.d&ZCedddddddd%dddf d'ZDd(ZEd/d)ZFd*ZGd0d+ZHd,ZIy)1aR Python APIs for creating CMS content. This is done in :mod:`cms.api` and not on the models and managers, because the direct API via models and managers is slightly counterintuitive for developers. The api for both Pages and Plugins has changed significantly since django CMS Version 4. Also, the functions defined in this module do sanity checks on arguments. .. warning:: None of the functions in this module does any security or permission checks. They verify their input values to be sane wherever possible, however permission checks should be implemented manually before calling any of these functions. .. info:: Due to potential circular dependency issues, it's recommended to import the api in the functions that uses its function. e.g. use: :: def my_function(): from cms.api import api_function api_function(...) instead of: :: from cms.api import api_function def my_function(): api_function(...) N)get_user_model)Site) FieldErrorValidationError)IntegrityError transaction)slugify) get_template) constants)CMSApp) apphook_pool)TEMPLATE_INHERITANCE_MAGIC) PageContent)Page)ACCESS_PAGE_AND_DESCENDANTSGlobalPagePermissionPagePermissionPageUser) Placeholder) CMSPlugin) CMSPluginBase) plugin_pool)get_current_site)RemovedInDjangoCMS51Warning)get_cms_setting)get_language_list)get_available_slugget_clean_username)_thread_locals)copy_plugins_to_placeholder) menu_poolcVtjt|tr] |jtj j Dcgc]}|jc}vsJ |jj}n\t|drt|tr |jSt|tr |tj vsJ |}n tdtj |jr |s td|Scc}w#t$rwxYw#t$rwxYw)zT Verifies the apphook given is valid and returns the normalized form (name) __module__z)apphook must be string or CMSApp instancez-apphook with app_name must define a namespace)r discover_apps isinstancer __class__appsvaluesAssertionError__name__hasattr issubclassstr TypeErrorapp_namer)apphook namespaceapp apphook_names 7/home/dcms/DCMS/lib/python3.12/site-packages/cms/api.py_verify_apphookr5Os  '6" $$,BSBSBZBZB\(]3(]] ]]((11 , 'Jw,G GS ! l/// // CDD&// MNN !)^      s)+DD $D;D D D D(cdt|drNt|tr>|j}|tj j vsJ|j}||fSt|tr$ t j|j}||fStd#t$r tdwxYw)zh Verifies the given plugin_type is valid and returns a tuple of (plugin_model, plugin_type) r#z4plugin_type must be CMSPluginBase subclass or string) r+r,rmodelrpluginsr(r*r%r- get_pluginKeyErrorr.) plugin_type plugin_models r4_verify_plugin_typer=is {L)jm.T"(( k1188::::!**   $$ K % T&11+>DDL  $$NOO TRS S Ts ,BB/z python-apiF last-childc(|| | tjdtd|tk(s+|t dDcgc]}|d c}vsJt ||s t }nt|tsJ|t|vs)Jt dj|j| rt| tsJ|r.tjdd }|Dcgc]}|d }}||vsJtj tj"tj$f}||vsJ|d vsJ|r t'||}nd}| r+t| t)r| t*_t/| } n dt*_|r=tj0j3|| j5rt7d |zt| | | |||||| }|j9||j;t=||||| |||||| |||t*`|Scc}wcc}w)a Creates a :class:`cms.models.Page` instance and returns it. Also creates a :class:`cms.models.PageContent` instance for the specified language. .. warning:: Since version 4 the parameters published, publication_date, and publication_end_date do not change the behaviour of this function. If they are supplied a warning is raised. :param str title: Title of the page :param str template: Template to use for this page. Must be in :setting:`CMS_TEMPLATES` :param str language: Language code for this page. Must be in :setting:`django:LANGUAGES` :param str menu_title: Menu title for this page :param str slug: Slug for the page, by default uses a slugified version of *title* :param apphook: Application to hook on this page, must be a valid apphook :type apphook: str or :class:`cms.app_base.CMSApp` sub-class :param str apphook_namespace: Name of the apphook namespace :param str redirect: URL redirect :param str meta_description: Description of this page for SEO :param created_by: User that is creating this page :type created_by: str of :class:`django.contrib.auth.models.User` instance :param parent: Parent page of this page :type parent: :class:`cms.models.Page` instance :param bool in_navigation: Whether this page should be in the navigation or not :param bool soft_root: Whether this page is a soft root or not :param str reverse_id: Reverse ID of this page (for template tags) :param str navigation_extenders: Menu to attach to this page. Must be a valid menu :param site: Site to put this page on :type site: :class:`django.contrib.sites.models.Site` instance :param bool login_required: Whether users must be logged in or not to view this page :param limit_visibility_in_menu: Limits visibility of this page in the menu :type limit_visibility_in_menu: :data:`VISIBILITY_ALL` or :data:`VISIBILITY_USERS` or :data:`VISIBILITY_ANONYMOUS` :param str position: Where to insert this node if *parent* is given, must be ``'first-child'`` or ``'last-child'`` :param str overwrite_url: Overwritten path for this page :param int xframe_options: X Frame Option value for Clickjacking protection :param str page_title: Overridden page title for HTML title tag NziThis API function no longer accepts a "published", "publication_date", or "publication_end_date" argument stacklevel TEMPLATESr LANGUAGES cms_enabledT)r> first-childleftright) reverse_idsitez.A page with the reverse_id="%s" already exist.) parent created_by changed_byrInavigation_extendersapplication_urlsapplication_namespacelogin_requiredrJ)position)languagetitle menu_titleslugrLredirectmeta_descriptionpage overwrite_url soft_root in_navigationtemplatelimit_visibility_in_menuxframe_options)warningswarn UserWarningrrr rr%rrgetpkrr!get_menus_by_attributer VISIBILITY_ALLVISIBILITY_USERSVISIBILITY_ANONYMOUSr5rruserrobjectsfilterexistsr add_to_treesavecreate_page_content)rTr]rSrUrVr0apphook_namespacerWrXrLrKpublication_datepublication_end_dater\r[rIrN publishedrJrQr^rRrZr_tpl raw_menusmenumenusaccepted_limitationsrOrYs r4 create_pagerysH@ 0 <@T@`  .    1 1ok.JKsCFKKKKX !$%%% (. .Y 0L0P0PQUQXQX0YY .&$'''44]DI %./Ta//#u,,,&44i6P6PR[RpRpq #'; ;; ; E EE E*74EFj^-=>(' 3 " <<  *4  @ G G IMPZZ[ [ 1)/%  D h'IIK ) ##!9%"  K[L$0s H  Hc|tk(s+|tdDcgc]}|d c}vsJt|t|tsJ|t |j vsJtjtjtjf}||vsJ|s2|jt||}t|j||}|r|jd} n| |j||} | r*t| t!r| t"_t'| } ddlm}||j| ||j,|j2j5||t7|| t9| t;t"d d }t<j>jA|jC|||| |||| | | | ||| }|jE|jG|Scc}w#t.$r}t1|d}~wwxYw) aG Creates a :class:`cms.models.PageContent` instance and returns it. ``parent`` is only used if slug=None. :param str language: Language code for this page. Must be in :setting:`django:LANGUAGES` :param str title: Title of the page :param page: The page for which to create this title :type page: :class:`cms.models.Page` instance :param str menu_title: Menu title for this page :param str slug: Slug for the page, by default uses a slugified version of *title* :param str redirect: URL redirect :param str meta_description: Description of this page for SEO :param parent: Used for automated slug generation :type parent: :class:`cms.models.Page` instance :param str overwrite_url: Overwritten path for this page :param str page_title: Overridden page title for HTML title tag rCr/N)validate_url_uniqueness) exclude_page)rVpathmanaged)rYrSdefaultsriz unknown user)rSrTrU page_titlerWrXrYrLrMr[r\r]r^r_)$rrr r%rrsite_idr rfrgrhget_path_for_slugr rrJstriprrrircms.forms.validatorsr|rKrrurlsupdate_or_createdictboolgetattrrrj with_usercreaterescan_placeholders_clear_internal_cache)rSrTrYrUrVrWrXrKrZrr~rLr[r\r]r^r_rtrxbaser|eri page_contents r4rorosP 1 1ok.JKsCFKKKKX dD !! ! (6 66 6&44i6P6PR[RpRpq #'; ;; ; %%genh?!$))T8<""3' %%dH5j^-=>(' 3  @ 4 T II ]++  >6> :D&&006==) #!9%>L $$& CL>  Q s G'&G,, H5 HHcptjdtdt|||f||||||| | | | | |||dS)zx .. warning :: ``create_title`` has been renamed to ``create_page_content`` as of django CMS version 4. zGcms.api.create_title has been renamed to cms.api.create_page_content().r@rA)rUrVrWrXrKrZrr~rLr[r\r]r^r_)r`rarro)rSrTrYrUrVrWrXrKrZrr~rLr[r\r]r^r_s r4 create_titlersb. MMQ#     )# #!9%# c xt|tsJt|\}}|r|dk(r!|j||d}|j}n|dk(r!|j||d}|j}n|dk(r|j }|j }nc|dk(r-|j dz|jz}|j }n1td |z|d vsJ|dk(r|j|d }nd}d }t||||| } |j| } |di|} | j| | j| S)a Adds a plugin to a placeholder and returns it. :param placeholder: Placeholder to add the plugin to :type placeholder: :class:`cms.models.placeholdermodel.Placeholder` instance :param plugin_type: What type of plugin to add :type plugin_type: str or :class:`cms.plugin_base.CMSPluginBase` sub-class, must be a valid plugin :param str language: Language code for this plugin, must be in :setting:`django:LANGUAGES` :param str position: Position to add this plugin to the placeholder. Allowed positions are ``"last-child"`` (default), ``"first-child"``, ``"left"``, ``"right"``. :param target: Parent plugin. Must be plugin instance :param data: Data for the plugin type instance r>last)rK insert_orderrFfirstrGrHzposition not supported: %s)rFr>)rN)r; placeholderrRrS parent_id) r%rr=get_next_plugin_positionrdrRr_get_descendants_count Exceptionr add_plugin set_base_attrrn) rr;rSrRtargetdatar<new_posr plugin_baseplugins r4rrsa k; // /!4K @L+ | #!::8Fag:hG I  &!::8Fah:iG I  ooG((I  oo)F,I,I,KKG((I88CD D8888 | #!::8RX:YGG  K((5K  !D !Ff% KKM MrTcddlm}| rt||ddddddddddd St|t sJ|||||||| | | | d }d|_d|_t|}t jjDcgc]}|jc}D]}t||t|||j|j||||Scc}w)a Creates a page user for the user provided and returns that page user. :param created_by: The user that creates the page user :type created_by: :class:`django.contrib.auth.models.User` instance :param user: The user to create the page user from :type user: :class:`django.contrib.auth.models.User` instance :param bool can_*: Permissions to give the user :param bool grant_all: Grant all permissions to the user r)save_permissionsT) can_add_page can_view_pagecan_change_pagecan_delete_pagecan_publish_pagecan_add_pageusercan_change_pageusercan_delete_pageusercan_add_pagepermissioncan_change_pagepermissioncan_delete_pagepermission)rL)cms.admin.formsrcreate_page_userr%ris_staff is_activer_meta local_fieldsnamesetattrrrn)rLrirrrrrrrrrrr grant_allrr page_userffields r4rrs41 D$dD$PTVZ\`bfhlnrss j."2 33 3%&**,,22"8%>%> DDMDNJ/I"0"2"8"8"E"EFQ!&&F8 5'$"678IIK NNT9% K Gs>Cc .| xr| } |xs| |xs| |xs| |xs| |xs| |xs| | xs| | xs| d}td|||d|}|j| rAtd|| d|}|j|jj t |S)a Assigns a user to a page and gives them some permissions. Returns the :class:`cms.models.PagePermission` object that gets created. :param page: The page to assign the user to :type page: :class:`cms.models.Page` instance :param user: The user to assign to the page :type user: :class:`django.contrib.auth.models.User` instance :param grant_on: Controls which pages are affected :type grant_on: :data:`cms.models.ACCESS_PAGE`, :data:`cms.models.ACCESS_CHILDREN`, :data:`cms.models.ACCESS_DESCENDANTS` or :data:`cms.models.ACCESS_PAGE_AND_DESCENDANTS` :param can_*: Permissions to grant :param bool grant_all: Grant all permissions to the user )can_add can_change can_delete can_publishcan_change_advanced_settingscan_change_permissions can_move_pagecan_view)rYrigrant_on)rican_recover_pager)rrnrsitesaddr)rYrirrrrrrrrrrrglobal_permissionrpage_permissions r4assign_user_to_pager.s@3"33I'i -I -I"/i(D(Q "8"EI&3))  D%U$THUPTUO.dDK[d_cd!!"2"45 rc<tjdtdyz .. warning:: Publishing pages has been removed from django CMS core in version 4 onward. For publishing functionality see `djangocms-versioning: `_ This API function has been removed. For publishing functionality use a package that adds publishing, such as: djangocms-versioning.r@rANr`rarb)rYrirSs r4 publish_pagerc MM 5 rc<tjdtdyrr)include_unpublishedrSrJs r4 publish_pagesrsrrc<tjdtdy)z .. warning:: The concept of draft pages has been removed from django CMS core in version 4 onward. For draft functionality see `djangocms-versioning: `_ rr@rANr)rYs r4get_page_draftrrrcd}|j|}|D]\}|r!|j|jr&t|j|}t |||}|t |z }^|S)a Copy the plugins to another language in the same page for all the page placeholders. By default, plugins are copied only if placeholder has no plugin for the target language; use ``only_empty=False`` to change this. .. warning: This function skips permissions checks :param page: the page to copy :type page: :class:`cms.models.pagemodel.Page` instance :param string source_language: The source language code, must be in :setting:`django:LANGUAGES` :param string target_language: The source language code, must be in :setting:`django:LANGUAGES` :param bool only_empty: if False, plugin are copied even if plugins exists in the target language (on a placeholder basis). :return int: number of copied plugins r)rS)get_placeholders get_pluginsrllistr len) rYsource_languagetarget_language only_emptycopied placeholdersrr8copied_pluginss r4copy_plugins_to_languagers(F((9L#* !8!8/!8!R!Y!Y![;22O2LMG8+XghN c.) )F * Mrcddlm}|j}|j}|r|j ||St j j|}|j||S)a2 Check whether a user has the permission to change the page. This will work across all permission-related setting, with a unified interface to permission checking. :param request: The request object from which the user will be taken. :type request: :class:`HttpRequest` instance r)page_permissions) cms.utilsrri current_pageuser_can_change_pagerrj get_currentuser_can_change_all_pages)requestrrirrJs r4rrsX+ <N) TTTTTTTTTTTF)FNN)T)J__doc__r`django.contrib.authrdjango.contrib.sites.modelsrdjango.core.exceptionsrr django.dbrrdjango.template.defaultfiltersr django.template.loaderr cmsr cms.app_baser cms.apphook_poolr cms.constantsr cms.modelsrcms.models.pagemodelrcms.models.permissionmodelsrrrrcms.models.placeholdermodelrcms.models.pluginmodelrcms.plugin_basercms.plugin_poolrrrcms.utils.compat.warningsrcms.utils.confrcms.utils.i18nrcms.utils.pagerrcms.utils.permissionsrcms.utils.pluginsr menus.menu_poolr!r5r=atomicrfX_FRAME_OPTIONS_INHERITryrorrrrrrrrrrrr4r s%N.,>12/)4"% 4,)'&A*,A09%4%0      &55 441VVr      '&5544#ii`    '&5544#.b 66x""8|) !&  2j    @Br