U ~4ic@sddlmZmZddlTddlZddlZddlmZddlm Z ddl m Z ddl m Z ddlmZed ZGd d d e ZdS) )urlparse parse_qsl)*N)contextmanager) HTTPAdapter)Retry) Confluence)ApiNotFoundErrorzatlassian.rest_clientc seZdZdZddejdeddffdd ZddZ e dUd d Z d d Z d dZ ddZfddZdVddZdWfdd ZdXddZddZd d!Zd"d#Zfd$d%Zfd&d'ZdYeeeeed)d*d+ZdZeeed,d-d.Zd[ed/d0d1Zd\d2d3Zd]d4d5Z d^d6d7Z!d_d8d9Z"ddd:fd;d< Z#d`ee$d=d>d?Z%fd@dAZ&dBdCZ'daeeeedDdEdFZ(dbeeeeeeedIdJdKZ)dLdMZ*edNdOdPZ+dQdRZ,dSdTZ-Z.S)c ConfluenceApiuK Подключение по API к учетной записи Confluence NTFc s|dr|nd|}|ds*|d7}|r4|}nd}tj|f|||||||d| |tjj|_dt|j |_ d|_ | dS)Nhttphttps:///)usernamepasswordtimeout verify_sslsessioncloudtokenzCONFLUENCE:COOKIE:) startswithendswithsuper__init___set_session_retriesZAPPZREDIS_DBredisrnetloc redis_key cookies_dict _init_cookies) selfurlrrrrrrrkwargs __class__./modules/confluence/api.pyrs0     zConfluenceApi.__init__cCs@ttjtjtjdd}t|d}|jd||jd|dS)u Конфигурирует стратегию повторных попыток и ассоциирует ее с сессией )totalstatusZstatus_forcelistZbackoff_factorZ max_retrieshttp://r N)rconfigZIMPORT_REQUEST_RETRY_TOTALZ!IMPORT_REQUEST_RETRY_STATUS_CODESr_sessionmount)rZretriesZ http_adapterr$r$r%r:s z"ConfluenceApi._set_session_retriesc csi}tdd}dD]$}|jj|||<|j||q|j}|rH||_z |VW5|D],\}}|rx|j||q\|jj|dq\|r||_XdS)u< Временно отключает Retry. rr))r*r N)rr,Zadaptersgetr-ritemspop)rrZ old_adaptersZno_retry_adapterprefixZ old_timeoutZadapterr$r$r% without_retryIs   zConfluenceApi.without_retrycCsX|j|j}|rTz*t|}|jj||jj|_ Wntj k rRYnXdS)u Добавляет cookie в сессию при инициализации, что бы не выполнять повторную авторизацию, если cookie еще действуют. При недействительных cookie, выполнится авторизация, а cookie обновятся в сессии и кеше N) rr.rpickleloadsr,cookiesupdateget_dictrZ PickleError)rcookies_pickler5r$r$r%ris zConfluenceApi._init_cookiescCs&t|jj}|jj|j|dddS)u Сохраняет cookie в кеш (Redis) для последующего использования без выполнения повторной авторизации i`T)exN)r3dumpsr,r5rsetr)rr8r$r$r% _save_cookiesyszConfluenceApi._save_cookiescCs(|jj}|j|kr$||_|dS)u Проверяет изменение cookie и обновляет их в кеше при необходимости N)r,r5r7rr<)rZcurrent_cookies_dictr$r$r%_check_cookiess  zConfluenceApi._check_cookiescstj||}||S)N)rrequestr=)rargsr!Zresponser"r$r%r>szConfluenceApi.requestc Cs|j}|p|j}|jd||d|jj|d|||j|jd`}td|d|j d|j | t |d"}|j |d D]}||q~W5QRXW5QRXd S) us Скачивает файл Args: download_url (_type_): url файла для скачивания save_path (_type_): путь для сохранения файла timeout (_type_, optional): Таймаут. Defaults to None. chunk_size (_type_, optional): _description_. Defaults to 64*1024. ZGET)methodr headersT)streamrBrZverifyproxiesz HTTP: GET z ->  zwb+) chunk_sizeN)Zno_check_headersrZlog_curl_debugr,r.rrDloggerdebugZ status_codereasonZraise_for_statusopenZ iter_contentwrite) rZ download_urlZ save_pathrrFrBresfchunkr$r$r% download_files"    zConfluenceApi.download_filec#sp|r|d}|d|d}nd}d}tj|||d}|rl|dsHql|dD] }|VqP|rbql||7}q&dS)u Получим все пространства из Confluence :return: Список всех пространств rr&d) space_typestartlimitresultsN)rget_all_spacesr.)rrQslicerRrSrLrowr"r$r%rUs zConfluenceApi.get_all_spacesrrParchivedpageccs2|j|||||d}|sq.|EdH||7}qdS)ud Получает архивные документы из пространства ) content_typeN)Zget_all_pages_from_space)rspacerRrSr(rZrLr$r$r% get_all_pages_from_space_archives  z.ConfluenceApi.get_all_pages_from_space_archivec cstddd}|||<d}zD|j||d}|ds8WdS|dEdH|d|d7<Wqtjk r}z td |d |WYdSd}~XYqXqdS) NrrRrSzrest/api/user/memberofparamsrTrRrSuLНе удалось получить группы пользователя "". )dictr.requestsZ HTTPErrorrGwarning)rkeyvaluer`r rLZhttp_errr$r$r%user_member_ofs  zConfluenceApi.user_member_ofc CsRz||}Wn>tk rL}z td|d|t}W5d}~XYnX|S)NuLНе удалось получить данные пользователя "ra)Zget_mobile_parameters ExceptionrGrdrb)rrinfoerrorr$r$r%get_user_details zConfluenceApi.get_user_detailc#sv|jrtddddd}|jd|d}|ds0dS|dD]\}|d |jd d }fd d |Ddd|d d Dd<Vq8|d|d7<qntddddd}|jf|}|dsdS|dD]|}|d ddkrt dq|d |j|d dd }fdd |Ddd|ddDd<Vq|d|d7<qdS)Nrr]zuser=""zoperations,personalSpace)rRrScqlexpandzrest/api/search/userr_rTuser accountIdrc3s*|]"\}}|ks|dkr||fVqdSNr$.0kvrnr$r% sz.ConfluenceApi.get_all_users..cSsg|]}|qSr$r$rtgr$r$r% sz/ConfluenceApi.get_all_users..groupsrRrSz type=userz&user.operations,user.status,user.emailrZrecovery_adminuВ вашем Confluence включен режим восстановления! Не оставляйте Confluence в режиме восстановления и не используйте учетную запись recovery_admin!c3s*|]"\}}|ks|dkr||fVqdSrqr$rsrwr$r%rxscSsg|]}|qSr$r$ryr$r$r%r{s) rrbr.rkr6r/rgrlrGrd)rr`rLrWZ user_infor$rwr% get_all_userss4    zConfluenceApi.get_all_usersc#sFtddd}tjf|}|s"dS|EdH|d|d7<q dS)Nrr]r^rRrS)rbrget_all_groups)rr`rLr"r$r%r~ s   zConfluenceApi.get_all_groupsc#sPtdd|dd}tjf|}|s&dS|D] }|Vq*|d|d7<qdS)Nrr]zoperations,status)rRrS group_namermrRrS)rbrget_group_members)rrr`rLrWr"r$r%rszConfluenceApi.get_group_membersr]) content_idrRrSrmreturnccsd|d}i}|dk r$t||d<|dk r8t||d<|dk rH||d<|sTd|d<|j||d }|d D]<} |r| d d krd d|j| d||dD| d<| Vqj|d} | d} | sqt| } tt| j} | d|d<| dr| d|d<| drT| d|d<qTdS)u Получает все комментарии к документу Args: content_id (str): ID страницы(документа) в Confluence expand (str): Cвойства элемента, которые нужно расширить, например, expand='body,version,history' children (bool): Создать иерархическую структуру с дочерними элементами Yields: Iterator[list]: элемент rest/api/content/z/child/commentNrRrSrmalldepthr_rTr(currentcSsg|]}|qSr$r$)rtobjr$r$r%r{;sz3ConfluenceApi.get_page_comments..id)rmchildrenr_linksnextcursor)intr.get_page_commentsrrbrquery)rrrRrSrmrr r`rLresultlinksnext_ next_parserr$r$r%rs:        zConfluenceApi.get_page_comments) key_spacermrc csd}d}|j|d|||dd}|dD]}|d|d|d dgdd id }|d rd d|j|dddD}|jddd||d dd<t||d dd<|Vq&|dsq||7}qdS)ui Получим все документы из корня пространства. :param key_space: Идентификатор пространства. :param expand: Дополнительные данные по документам. :return: Соответствие id документа и его данных. r2rootrY)rrmrRrSrZrTrtitletyperTsize)rrrrrcSsg|]}|qSr$r$rtchildr$r$r%r{jsz;ConfluenceApi.get_root_pages_from_space..FdetailedcSs|dSNpositionr$pr$r$r%kz9ConfluenceApi.get_root_pages_from_space..rerN)Zget_space_contentr. get_childrensortlen) rrrmrRrSrLrWdatarr$r$r%get_root_pages_from_spaceOs0   z'ConfluenceApi.get_root_pages_from_spacermccsZt|||d}|j|f|}|rV|ds,qV|dD] }|Vq4|d|d7<qdS)N)rRrSrmrTrRrS)rbZget_attachments_from_contentr.)rpage_idrRrSrmr`rLrWr$r$r%get_all_attachmentss z ConfluenceApi.get_all_attachmentcCs,z|j||dWStk r&YdSXdS)N)userkeyrm)Zget_user_details_by_userkeyr )rrrmr$r$r%get_user_info_by_key~sz"ConfluenceApi.get_user_info_by_keycCs|jr|j||dSdS)Nr)rget_user_details_by_accountid)rrormr$r$r% get_user_infoszConfluenceApi.get_user_infocCsRz6|jr(|j|d}|j|d|dWS|j||dWStk rLYdSXdS)Nrpro)Z accountidrm)rrm)rget_account_idrZget_user_details_by_usernamer )rrrmrnr$r$r%get_user_info_by_usernames z'ConfluenceApi.get_user_info_by_usernamecCs4d}|rd|i}nd|i}|j||d}|ddS)Nzrest/api/user/bulk/migrationrrr_rTrr.)rrrr r`rLr$r$r%rs  zConfluenceApi.get_account_id)r with_childrencstj|f||}|s:|d|d|d|ddd}|r|dd|j||d D}|jd d d d |t|di|d<|S)u Возвращает данные контента Николай1: expand='children.page' имеет лимит 25 элементов, запрашиваем детей вручную https://jira.atlassian.com/browse/CONFSERVER-52558?src=confmacro get_page_child_by_type - без лимита падает, т.к. в коде думает что урлы не относительные поэтому лимиты считаем руками Bспользуется в двух местах, поэтому вынес в глобальный API Args: page_id (str, int): ID контента detailed (bool, optional): Вернуть подробные данные. Defaults to True. with_children (bool, optional): Запросить дочерние объекты. Defaults to False. Returns: page (dict): данные контента rrr extensionsrrrrrcSsg|]}|qSr$r$rr$r$r%r{sz0ConfluenceApi.get_page_by_id..rcSs|dSrr$rr$r$r%rrz.ConfluenceApi.get_page_by_id..rrYrr)rget_page_by_idrrr)rrrrr?r!rYrr"r$r%rs  zConfluenceApi.get_page_by_id)typesrc cs|dkr|jsdgnddg}|D]p}d}d}|j||||d}|sDq |rT|EdHn2|D],}|d|d|d |d d d } | VqX||7}q,q dS) u Возвращает дочерние объекты(контент) Args: parent_id (_type_): ID родительского контента types (list, optional): Список типов дочерних объектов. Defaults to None. detailed (bool, optional): Вернуть подробные данные. Defaults to True. Yields: dict: данные дочернего объекта(контента) NrYZfolderrr])rrRrSrrrrrr)rZget_page_child_by_type) rZ parent_idrrZtype_rRrSrTrrr$r$r%rs.   zConfluenceApi.get_childrenc#s&tt|ddEdHdS)N)listr get_all_restrictions_for_contentvalues)rrr"r$r%rsz.ConfluenceApi.get_all_restrictions_for_contentccsTtdd|d}|jf|}|dEdH|d|d7<|d|dkrqPqdS)NrrP)rRrSrrTrRrSr)rbZget_page_labels)rrr`rLr$r$r%get_all_page_labelss  z!ConfluenceApi.get_all_page_labels)rversion_numberrmrcCsJ|jrd|d|}nd|d|}i}|dk r<||d<|j||dS)u Получает определенную версию документа Args: content_id (str): ID страницы(документа) в Confluence version_number (int): номер версии страницы(документа) expand (str): Cвойства элемента, которые нужно расширить, например, expand='body,version,history' Return: dict: данные версии документа rz /version/rest/experimental/content/Nrmr_)rr.)rrrrmr r`r$r$r%get_page_versions zConfluenceApi.get_page_versionr)rcurrent_versionrRrS last_versionsrmrccs|sdS|jrd|d}n d|d}i}|dk r@t||d<|dk rTt||d<|dk rd||d<d} zl|j||d } | d } | d } | d D]>} | d 7} d|kr| krnnd} q| dd }| VqWnt|ddD]~}| d 7} d|kr | krnnqhz||||VWqtk rd}ztd|d|VW5d}~XYqXqd} YnX| s|qt| }tt|j }|d|d<|dr|d|d<|d rh|d |d <qhdS)u Получает версии страницы (историю документа) При большом количестве данных в версиях, limit > 5 может не работать, зависает, либо падает с ошибкой по таймауту. Получение версий списком может упасть с ошибкой 500 "Internal Server Error", если в ответе будет кривая версия. При получении ошибки при запросе списков, пытаемся получить версии по одной. Args: content_id (str): ID страницы(документа) в Confluence current_version (int): номер текущй версии страницы(документа) last_versions (int): колчество послених версий для получения, при "-1" - получение всех версий expand (str): Cвойства элемента, которые нужно расширить, например, expand='body,version,history' Yields: Iterator[list]: элемент Nrz/versionrrRrSrmrr_rrrTr&Fnumberru версия z. r) rrr.rangerrhrrbrr)rrrrRrSrrmr r`Z version_countrLrrversionrexcrrr$r$r%get_page_versionssV       *    zConfluenceApi.get_page_versionscCsl|jr |j|dd}|dgS|dkr>d|d}||Sd}ddd |gd }|j||d d gSdS) NZ permissions) space_keyrm zrest/api/space/z /permissionsz!rpc/json-rpc/confluenceservice-v2z2.0ZgetSpacePermissionSets)ZjsonrpcrArr`)rr)rZ get_spacer.Zpost)rrrZ space_datar rr$r$r%get_space_permissionsbs   z#ConfluenceApi.get_space_permissions)rcCsd}||S)u Получает связи с другими системами Return: applinks (dict): данные связей с другими системами zrest/applinks/3.0/applinksrrr r$r$r% get_applinkstszConfluenceApi.get_applinkscCsd}||S)u7Получить информацию о системеzrest/applinks/1.0/manifestrrr$r$r%get_system_infoszConfluenceApi.get_system_infocCsd}||S)u^ Возвращает данные о текущем пользователе zrest/api/user/currentrrr$r$r%get_current_userszConfluenceApi.get_current_user)N)Nr@)NN)rrPrXrY)rr]NT)N)rr]N)N)N)N)NN)NT)N)rrrN)/__name__ __module__ __qualname____doc__r+Z!IMPORT_CONFLUENCE_REQUEST_TIMEOUTZcmfutilZrequests_sessionrrrr2rr<r=r>rOrUr\rgrkr}r~rstrrrrrbrrrrrrrboolrrrrrrrrr __classcell__r$r$r"r%r s|)     #  1$   ')   S r ) urllib.parserrZ cmf.includer3rc contextlibrZrequests.adaptersrZurllib3.util.retryrZ atlassianrZatlassian.errorsr ZloggingZ getLoggerrGr r$r$r$r%s