§ ;ٹ»jh;مَ—dZddlZddlmZddlmZmZddlmZm Z m Z ddlmZm Z mZmZmZmZmZmZmZddlmZmZdd lmZmZmZe ¦«\ZZd „Zd;d„Zd;d „Z d„Z!d„Z"d„Z#d„Z$d„Z%d„Z&dd!„Z2d"„Z3d#„Z4d$„Z5d%„Z6d&„Z7d'„Z8d(ed)e9fd*„Z:d+„Z;d,„Zd)e?fd/„Z@d0„ZAd1„ZBd2„ZCd)eDefd3„ZEe¦«d4„¦«ZFd5„ZGd)e>fd6„ZHd7„ZId8„ZJd9„ZKd)e9fd:„ZLee¦«ZMeM N¦«ZOe!¦«ZPeOjQZQeOjRZReOjSZSeOjTZTeOjUZUeOjVZVeOjWZWeOjXZXeOjYZYeOjZZZeOj[Z[eOj\Z\eOj]Z]dS)?z< CloudLinux control panel API API for Hosting control panel éN)ع lru_cacheé)عCACHE_CPNAMEعUNKNOWN_CP_NAME)عFeatureعget_cl_feature_status_mapعget_hosting_accounts_limit) عget_cp_plugin_moduleعdetect_panel_fastعCPANEL_NAMEعDIRECTADMIN_NAMEع PLESK_NAMEعISPMANAGER_NAMEعINTERWORX_NAMEعINTEGRATED_NAMEعOFFICIAL_PLUGINS)عNotSupportedعNoPanelUser)عis_cl_solo_editionعCLEditionDetectionErrorعis_containercَP—tttttt fvS)zH Is current panel has native CL support :return: True/False )ع_CP_NAMErr rrr©َْ—/builddir/build/BUILDROOT/alt-python27-cllib-3.4.44-1.el8.cloudlinux.x86_64/opt/cloudlinux/venv/lib/python3.11/site-packages/clcommon/cpapi/__init__.pyعis_cl_supported_panelr2s%€ُ فففففًًًrFcَ6—t |¦«S)zء Return list of available admin's packages :param raise_exc: hack for lvemanager :rtype: list :return: List of packages. For example ['BusinessPackage', 'Package2'] )ع_panel_classعadmin_packages©ع raise_excs rr r @s€ُ×&ز& yر1ش1ذ1rcَ4—t ¦«S)a Return dictionary, contains available resellers packages, grouped by resellers :rtype: dict :return: Dictionary. Example: {'res1': ['BusinessPackage', 'UltraPackage', 'Package'], 'res2': ['SimplePackage', 'Package'] } )rعresellers_packagesr!s rr$r$Ks€ُ×*ز*ر,ش,ذ,rcَè—tj¦«dkrt ¦«Stt tkrt ¦«StپtSt}tj t¦«rTttd¬¦«5}| ¦« ¦«}ddd¦«n#1swxYwY|S)zC Return panel name :rtype: str :return: Panel name rNzutf-8)عencoding)عosعgetegidrع getCPNamerrع_CP_PLUGIN_NAMErrعpathعisfilerعopenعreadlineعstrip)عcontrolpanelnameعcache_streams rr)r)Ws‎€ُ „zپ|„|گqزذف×%ز%ر'ش'ذ'ُ‌ش(Oز;ذ;ف×%ز%ر'ش'ذ'ُ ذ فˆه&ذف „w‡~‚~•lر#ش#ً?ف •,¨ذ 1ر 1ش 1ً ?°\ط+×4ز4ر6ش6×<ز<ر>ش>ذً ?ً ?ً ?ٌ ?ô ?ً ?ً ?ً ?ً ?ً ?ً ?ًّّّ ?ً ?ً ?ً ?àذsآ4'C'أ'C+أ.C+cَ4—t ¦«S)zا Retrieve panel name and it's version :rtype: dict :return: dict: { 'name': 'panel_name', 'version': 'panel_version', 'additional_info': 'add_info'} or None if can't get info )rعget_cp_descriptionrrrr3r3qs€ُ×*ز*ر,ش,ذ,rcَ¼—t¦«rt ¦«St d¬¦«}d„|D¦«}t |¦«S)z” Generates a list of cpusers registered in the control panel :return: list of cpusers registered in the control panel :rtype: tuple )عcplogin)عkeylscَ—g|] }|d‘ŒS)rr)ع.0عuser_s rْ zcpusers..…s€ذ4ذ4ذ4 گ5ک”8ذ4ذ4ذ4r)rrعcpusersعcpinfoعtuple)ع users_infoع_list_userss rr;r;{s[€ُرشً&ه×#ز#ر%ش%ذ%ف×$ز$¨=ذ$ر9ش9€Jط4ذ4¨ذ4ر4ش4€Kفگرشذrcَ4—t ¦«S)z‹ Generates a list of resellers in the control panel :return: list of cpusers registered in the control panel :rtype: tuple )rع resellersrrrrArA‰s€ُ×!ز!ر#ش#ذ#rcَ4—t ¦«S)z‌ Generates a set of admins in the control panel :return: set of cpusers registered in the control panel :rtype: set :raise: NotSupported )rعadminsrrrrCrC’s€ُ×زر ش ذ rcَ4—t ¦«S)zو Getting root access to mysql database. For example {'login': 'root', 'db': 'mysql', 'host': 'localhost', 'pass': '9pJUv38sAqqW'} :return: root access to mysql database :rtype: dict :raises: NoDBAccessData )rع db_accessrrrrErEœs€ُ×!ز!ر#ش#ذ#rcَ8—t ||¦«S)a· Returs a list of pairs, the database user login - user login control panel For example: (('nata2_someuse', 'nata2'), ('testsome_dfrtbus', 'testsome')) :param list|tuple|None cplogin_lst: list of control panel users :param bool with_system_users: add system users to dbmapping :return: list of pairs, the database user login - user login control panel :rtype: tuple :raises: NotSupported, NoPackage )rعdblogin_cplogin_pairs)عcplogin_lstعwith_system_userss rrGrG§s€ُ×-ز-¨kذ;LرMشMذMr©r5عpackageعmailعresellerعdnsTcَ<—t |||¬¦«S)a Retrieves info about panel user(s) :param str|unicode|list|tuple|None cpuser: user login :param keyls: list of data which is necessary to obtain the user, the valuescan be: cplogin - name/login user control panel mail - Email users reseller - name reseller/owner users locale - localization of the user account package - User name of the package dns - domain of the user :param bool search_sys_users: search for cpuser in sys_users or in control panel users (e.g. for Plesk) :return: returns a tuple of tuples of data in the same sequence as specified keys in keylst :rtype: tuple )عsearch_sys_users)rr<)عcpuserr6rPs rr<r<µs €ُ"×زکv uذ?OذرPشPذPrcَ²—t¦«rt ¦«S t ¦«dS#t$rYdSwxYw)zع Gets admin email Note: be careful when modifying this method. It is used in SSA, ask @dkavchuk or someone else from C-Projects team for details :rtype: string :return: string - admin email rع)rrعget_admin_emailعget_admin_emails_listع IndexErrorrrrrTrTةsb€ُرشًف×+ز+ر-ش-ذ-ً ف×5ز5ر7ش7¸ش:ذ:ّفً ً ً طگ2گ2ً ّّّs©Aء AءAcَ~—d}t¦«r, t ¦«S#t$r|cYSwxYw|S)Nعen)rrعget_admin_localer)عDEFAULT_LOCALEs rrYrYغsY€ط€Nفرشً"ً "ف×0ز0ر2ش2ذ2ّفً "ً "ً "ط!ذ!ذ!ذ!ً "ّّّàذs’+«:¹:cَ6—t |¦«S)zƒ Return document root for domain :param str|unicode domain: :rtype tuple :return Tuple: (document_root, owner) )rعdocroot©عdomains rr\r\هs€ُ×ز ر'ش'ذ'rcَ8—t ||¦«S©zط Return domain and document root pairs for control panel user first domain is main domain :param str|unicode cpuser: user login :rtype: list :return list of tuples (domain_name, documen_root) )rعuseraliases)rQr^s rraraïs€ُ×#ز# F¨Fر3ش3ذ3rcَ6—t |¦«Sr`)rعuserdomains©rQs rrcrcûs€ُ×#ز# Fر+ش+ذ+rcَ6—t |¦«S)zذ Return addon domain and mountpoint domain pairs for control panel user :param str|unicode cpuser: user login :return: mapping of addon domain names to their mountpoint names :rtype: dict )rعuseraddondomainsrds rrfrfs€ُ×(ز(¨ر0ش0ذ0rcَ4—t ¦«S)z؟ Detects and returns list of folders contained the home dirs of users of the cPanel :rtype: list :return: list of folders, which are parent of home dirs of users of the panel )rعhomedirsrrrrhrhs€ُ× ز ر"ش"ذ"rcَz—t¦«rt |¦«St|¦«\}}|S)z— Return domain's owner :param domain: Domain/sub-domain/add-domain name :rtype: str :return: user name or None if domain not found )rrعdomain_ownerr\)r^ع_ع _domain_owners rrjrjs<€ُرشً1ف×(ز(¨ر0ش0ذ0فکv‘”ر€A€}طذrcَ6—t |¦«S)zک Return reseller users :param resellername: reseller name; return empty list if None :rtype list :return list[str]: user names list )rعreseller_users©عresellernames rrnrn&s€ُ×&ز& |ر4ش4ذ4rcَ6—t |¦«S)z؛ Return reseller users and their main domains :param resellername: reseller name; autodetect name if None :rtype disct :return dict[str, str]: pairs user <==> domain )rعreseller_domainsros rrrrr0s€ُ×(ز(¨ر6ش6ذ6rcَ6—t |¦«S)zM Check if user is reseller; :type username: str :rtype: bool )rعis_reseller©عusernames rrtrt:s€ُ×#ز# Hر-ش-ذ-rcَ6—t |¦«S)zP Get login url for current panel; :type domain: str :rtype: str )rعget_user_login_urlr]s rrxrxCs€ُ×*ز*¨6ر2ش2ذ2rcَ6—t |¦«S)zچ Return True if username is in admin names :param str username: user to check :rtype bool :return: True if user is admin )rعis_adminrus rrzrzLs€ُ× ز ر*ش*ذ*rcَf—t¦«} |tjS#t$rYdSwxYw)z{ Return True if panel supports reseller limits (LVE10+) :return: bool - True - yes, False - no :rtype bool F)rrعRESELLER_LIMITSعKeyError)عpanel_featuress rعis_reseller_limits_supportedrVsD€ُ/ر0ش0€Nًط‌gش5ش6ذ6ّفًًًطˆuˆuًّّّsگ"¢ 0¯0cَ4—t ¦«S)z™ Get dict reseller => id Optional method for panels without hard link reseller <=> system user :rtype: dict[str,int] - {'res1': id1} )rعget_reseller_id_pairsrrrrپrپfs€ُ×-ز-ر/ش/ذ/rcَ4—t ¦«S)zY Retrive encoding name, used for package/reseller names, from panel :return: )rعget_encoding_namerrrrƒrƒrs€ُ ×)ز)ر+ش+ذ+rعfeatureعreturncَv— t¦«}|dup| |d¦«S#t$rYdSwxYw)zˆ Get if feature is supported by control panel. :param feature: constant from Feature class :return: boolean NF)عget_supported_cl_featuresعgetr)r„عfeaturess rعis_panel_feature_supportedrٹzsR€ًف,ر.ش.ˆطک4ذذ? 8§<¢<°¸ر#?ش#?ذ?ّف"ًًًطˆuˆuًّّّs‚'*ھ 8·8cَ4—t ¦«S)zL Retrieves Apache's connections number (from mod_status) For CM )rعget_apache_connections_numberrrrrŒrŒ‰s€ُ ×5ز5ر7ش7ذ7rcَ4—t ¦«S)z` Retrieves active httpd's ports from httpd's config :return: list of apache's ports )rعget_apache_ports_listrrrrژrژ‘s€ُ ×-ز-ر/ش/ذ/rcَ4—t ¦«S)z× Get current maximum request apache workers from httpd's config :return: tuple (max_req_num, message) max_req_num - Maximum request apache workers number or 0 if error message - OK/Trace )rعget_apache_max_request_workersrrrrگrگ™s€ُ×6ز6ر8ش8ذ8rعuidcَ6—t |¦«S)zT Get "main" panel username by uid. :param uid: uid :return Username )rعget_main_username_by_uid)r‘s rr“r“£s€ُ×0ز0°ر5ش5ذ5rcَ8—t ||¦«S©N)rعget_user_emails_list)rvr^s rr–r–¬s€ف×,ز,¨X°vر>ش>ذ>rcَ6—t |¦«Sr•)rعpanel_login_linkrus rrکrک¯s€ف×(ز(¨ر2ش2ذ2rcَ6—t |¦«Sr•)rعpanel_awp_linkrus rrڑrڑ²s€ف×&ز& xر0ش0ذ0rcَ8—t ¦«pgS)zK Returns features that are not supported on current control panel. )rعget_unsupported_cl_featuresrrrعget_unsupported_featuresr‌¶s€ُ×3ز3ر5ش5ذ;¸ذ;rcَ—t¦«S)zd Left here mostly for backwards compatibility. See get_cl_feature_status_map docstring. )rrrrr‡r‡؟s€ُ%ر&ش&ذ&rcَF—td¬¦«st¦«rdSdS)NT)عskip_jwt_checkF)rrrrrعis_throttling_supportedr،بs*€ف¨ذ.ر.ش.ًµ,±.´.ًطˆuطˆ4rcَ4—t ¦«S)zY Get panel users count, admin accounts are not counted :return: Users count. )rعget_hosting_accounts_countrrrr£r£خs€ُ ×2ز2ر4ش4ذ4rcَd—t¦«}|sdSt ¦«}||kS)zB Check if customer hitting max accounts count per edition F)r rr£)عmax_accounts_limitعcurrent_accounts_counts rعis_hitting_max_accounts_limitr§ضs;€ُ4ر5ش5ذطًطˆuه)×DزDرFشFذط!ذ$6ز6ذ6rcَ—t¦«Sr•)r rrrعget_max_accounts_limitr©âs€ه%ر'ش'ذ'rcَ؛‡— t¦«}n"#t$r}td¦«|‚d}~wwxYwt¦«ٹtˆfd„|D¦«¦«S)z| Retrieve users count and admins count, substract the last value from the first one and dump the result on disk zcpusers() method not supportedNc3َ$•K—|] }|‰v¯dV—ŒdS)rNr)r8عuserعadmins_collections €rْ z)count_hosting_accounts..ôs.ّèè€ذIذIگT¨4ذ7Hذ+Hذ+Hˆqذ+Hذ+Hذ+Hذ+HذIذIr)r;rrCعsum)ع users_listعers @rعcount_hosting_accountsr²çswّ€ً Dف‘Y”Yˆ ˆ ّفًDًDًDفذ;ر<ش<ہ!ذCًّّّّDُّّّ™œذهذIذIذIذIکZذIرIشIرIشIذIsƒ’ 1œ,¬1cَœ—d}tj |¦«sdS tjd¦«dkS#t$rYdSwxYw)z@ They have symlink /usr/local/cpanel/server.type -> wp2 z/usr/local/cpanel/server.typeFعwp2)r'r+عislinkعreadlinkع Exception)ع wp2_markers rعis_wp2_environmentr¹ِsa€ً1€Jف Œ7ڈ>ٹ>ک*ر%ش%ًطˆuًفŒ{ذ:ر;ش;¸uزDذDّفًًًطˆuˆuًّّّs¥=½ Aء A)F)NF)NrJTr•)^ع__doc__r'ع functoolsrعconstrrعclcommon.featuresrrr ع pluginlibr rrr rrrrrعcpapiexceptionsrrعclcommon.lib.cleditionrrrrr*rr r$r)r3r;rArCrErGr<rTrYr\rarcrfrhrjrnrrrtrxrzrrپrƒعboolrٹrŒrژrگعintعstrr“r–rکrڑعlistr‌r‡r،r£r§r©r²r¹ع _apipluginعPanelPluginrعCP_NAMEعget_domains_php_infoعget_system_php_infoعlist_allع list_usersعget_reseller_usersعreseller_package_by_uidعget_uids_list_by_packageعget_installed_php_versionsعget_customer_loginعget_domain_loginع get_server_ipعinvalidate_cpapi_cacheعsuspended_users_listrrrْrصsےًًًً € € € طذذذذذà0ذ0ذ0ذ0ذ0ذ0ذ0ذ0ًًًًًًًًًًً ً ً ً ً ً ً ً ً ً ً ً ً ً ً ً ً ً ً ً ً ً ً7ذ6ذ6ذ6ذ6ذ6ذ6ذ6ًًًًًًًًًًً.ذ-ر/ش/ر€ˆ/ًًًً2ً2ً2ً2ً -ً -ً -ً -ًًًً4-ً-ً-ًًًً$ً$ً$ً!ً!ً!ً$ً$ً$ًNًNًNًNًPط ًQًQًQًQً(ًًً$ًًً(ً(ً(ً 4ً 4ً 4ً,ً,ً,ً1ً1ً1ً#ً#ً#ً ً ً ً5ً5ً5ً7ً7ً7ً7ً.ً.ً.ً3ً3ً3ً+ً+ً+ً ً ً ً 0ً0ً0ً,ً,ً,ً¨ً°Dًًًًً8ً8ً8ً0ً0ً0ً9ً9ً9ً6 #ً6¨#ً6ً6ً6ً6ً?ً?ً?ً3ً3ً3ً1ً1ً1ً< $ w¤-ً<ً<ً<ً<ً€پ„ً'ً'ٌ „ً'ًًًً5 Cً5ً5ً5ً5ً 7ً 7ً 7ً(ً(ً(ً Jً Jً JًکDًًًًً"ذ ! /ر 2ش 2€ ط×%ز%ر'ش'€ط ˆ)‰+Œ+€ً$ش8ذط"ش6ذطش €ط ش $€ ط!ش4ذط&ش>ذط'ش@ذط)شDذط!ش4ذطش0ذطش*€ ط%ش<ذط#ش8ذذذr