File size: 97,704 Bytes
56d74b6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 | # coding=utf-8
import logging
import os
import time
import json
from requests import HTTPError
from deprecated import deprecated
from atlassian import utils
from .errors import (
ApiError,
ApiNotFoundError,
ApiPermissionError,
ApiValueError,
ApiConflictError,
)
from .rest_client import AtlassianRestAPI
log = logging.getLogger(__name__)
class Confluence(AtlassianRestAPI):
content_types = {
".gif": "image/gif",
".png": "image/png",
".jpg": "image/jpeg",
".jpeg": "image/jpeg",
".pdf": "application/pdf",
".doc": "application/msword",
".xls": "application/vnd.ms-excel",
".svg": "image/svg+xml",
}
def __init__(self, url, *args, **kwargs):
if ("atlassian.net" in url or "jira.com" in url) and ("/wiki" not in url):
url = AtlassianRestAPI.url_joiner(url, "/wiki")
if "cloud" not in kwargs:
kwargs["cloud"] = True
super(Confluence, self).__init__(url, *args, **kwargs)
@staticmethod
def _create_body(body, representation):
if representation not in ["editor", "export_view", "view", "storage", "wiki"]:
raise ValueError("Wrong value for representation, it should be either wiki or storage")
return {representation: {"value": body, "representation": representation}}
def page_exists(self, space, title):
try:
if self.get_page_by_title(space, title):
log.info('Page "{title}" already exists in space "{space}"'.format(space=space, title=title))
return True
else:
log.info("Page does not exist because did not find by title search")
return False
except (HTTPError, KeyError, IndexError):
log.info('Page "{title}" does not exist in space "{space}"'.format(space=space, title=title))
return False
def get_page_child_by_type(self, page_id, type="page", start=None, limit=None):
"""
Provide content by type (page, blog, comment)
:param page_id: A string containing the id of the type content container.
:param type:
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: how many items should be returned after the start index. Default: Site limit 200.
:return:
"""
params = {}
if start is not None:
params["start"] = int(start)
if limit is not None:
params["limit"] = int(limit)
url = "rest/api/content/{page_id}/child/{type}".format(page_id=page_id, type=type)
log.info(url)
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, "
"or the calling user does not have permission to view the content",
reason=e,
)
raise
if self.advanced_mode:
return response
return response.get("results")
def get_child_title_list(self, page_id, type="page", start=None, limit=None):
"""
Find a list of Child title
:param page_id: A string containing the id of the type content container.
:param type:
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: how many items should be returned after the start index. Default: Site limit 200.
:return:
"""
child_page = self.get_page_child_by_type(page_id, type, start, limit)
child_title_list = [child["title"] for child in child_page]
return child_title_list
def get_child_id_list(self, page_id, type="page", start=None, limit=None):
"""
Find a list of Child id
:param page_id: A string containing the id of the type content container.
:param type:
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: how many items should be returned after the start index. Default: Site limit 200.
:return:
"""
child_page = self.get_page_child_by_type(page_id, type, start, limit)
child_id_list = [child["id"] for child in child_page]
return child_id_list
def get_child_pages(self, page_id):
"""
Get child pages for the provided page_id
:param page_id:
:return:
"""
return self.get_page_child_by_type(page_id=page_id, type="page")
def get_page_id(self, space, title):
"""
Provide content id from search result by title and space
:param space: SPACE key
:param title: title
:return:
"""
return (self.get_page_by_title(space, title) or {}).get("id")
def get_parent_content_id(self, page_id):
"""
Provide parent content id from page id
:type page_id: str
:return:
"""
parent_content_id = None
try:
parent_content_id = (self.get_page_by_id(page_id=page_id, expand="ancestors").get("ancestors") or {})[
-1
].get("id") or None
except Exception as e:
log.error(e)
return parent_content_id
def get_parent_content_title(self, page_id):
"""
Provide parent content title from page id
:type page_id: str
:return:
"""
parent_content_title = None
try:
parent_content_title = (self.get_page_by_id(page_id=page_id, expand="ancestors").get("ancestors") or {})[
-1
].get("title") or None
except Exception as e:
log.error(e)
return parent_content_title
def get_page_space(self, page_id):
"""
Provide space key from content id
:param page_id: content ID
:return:
"""
return ((self.get_page_by_id(page_id, expand="space") or {}).get("space") or {}).get("key")
def get_pages_by_title(self, space, title, start=0, limit=200, expand=None):
"""
Provide pages by title search
:param space: Space key
:param title: Title of the page
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of labels to return, this may be restricted by
fixed system limits. Default: 200.
:param expand: OPTIONAL: expand e.g. history
:return: The JSON data returned from searched results the content endpoint, or the results of the
callback. Will raise requests.HTTPError on bad input, potentially.
If it has IndexError then return the None.
"""
return self.get_page_by_title(space, title, start, limit, expand)
def get_page_by_title(self, space, title, start=0, limit=1, expand=None):
"""
Returns the first page on a piece of Content.
:param space: Space key
:param title: Title of the page
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of labels to return, this may be restricted by
fixed system limits. Default: 1.
:param expand: OPTIONAL: expand e.g. history
:return: The JSON data returned from searched results the content endpoint, or the results of the
callback. Will raise requests.HTTPError on bad input, potentially.
If it has IndexError then return the None.
"""
url = "rest/api/content"
params = {}
if start is not None:
params["start"] = int(start)
if limit is not None:
params["limit"] = int(limit)
if expand is not None:
params["expand"] = expand
if space is not None:
params["spaceKey"] = str(space)
if title is not None:
params["title"] = str(title)
if self.advanced_mode:
return self.get(url, params=params)
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 404:
raise ApiPermissionError(
"The calling user does not have permission to view the content",
reason=e,
)
raise
try:
return response.get("results")[0]
except (IndexError, TypeError) as e:
log.error("Can't find '{title}' page on the {url}!".format(title=title, url=self.url))
log.debug(e)
return None
def get_page_by_id(self, page_id, expand=None, status=None, version=None):
"""
Returns a piece of Content.
Example request URI(s):
http://example.com/confluence/rest/api/content/1234?expand=space,body.view,version,container
http://example.com/confluence/rest/api/content/1234?status=any
:param page_id: Content ID
:param status: (str) list of Content statuses to filter results on. Default value: [current]
:param version: (int)
:param expand: OPTIONAL: Default value: history,space,version
We can also specify some extensions such as extensions.inlineProperties
(for getting inline comment-specific properties) or extensions.resolution
for the resolution status of each comment in the results
:return:
"""
params = {}
if expand:
params["expand"] = expand
if status:
params["status"] = status
if version:
params["version"] = version
url = "rest/api/content/{page_id}".format(page_id=page_id)
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, "
"or the calling user does not have permission to view the content",
reason=e,
)
raise
return response
def get_page_labels(self, page_id, prefix=None, start=None, limit=None):
"""
Returns the list of labels on a piece of Content.
:param page_id: A string containing the id of the labels content container.
:param prefix: OPTIONAL: The prefixes to filter the labels with {@see Label.Prefix}.
Default: None.
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of labels to return, this may be restricted by
fixed system limits. Default: 200.
:return: The JSON data returned from the content/{id}/label endpoint, or the results of the
callback. Will raise requests.HTTPError on bad input, potentially.
"""
url = "rest/api/content/{id}/label".format(id=page_id)
params = {}
if prefix:
params["prefix"] = prefix
if start is not None:
params["start"] = int(start)
if limit is not None:
params["limit"] = int(limit)
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, "
"or the calling user does not have permission to view the content",
reason=e,
)
raise
return response
def get_page_comments(
self,
content_id,
expand=None,
parent_version=None,
start=0,
limit=25,
location=None,
depth=None,
):
"""
:param content_id:
:param expand: extensions.inlineProperties,extensions.resolution
:param parent_version:
:param start:
:param limit:
:param location: inline or not
:param depth:
:return:
"""
params = {"id": content_id, "start": start, "limit": limit}
if expand:
params["expand"] = expand
if parent_version:
params["parentVersion"] = parent_version
if location:
params["location"] = location
if depth:
params["depth"] = depth
url = "rest/api/content/{id}/child/comment".format(id=content_id)
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, "
"or the calling user does not have permission to view the content",
reason=e,
)
raise
return response
def get_draft_page_by_id(self, page_id, status="draft"):
"""
Provide content by id with status = draft
:param page_id:
:param status:
:return:
"""
url = "rest/api/content/{page_id}?status={status}".format(page_id=page_id, status=status)
try:
response = self.get(url)
except HTTPError as e:
if e.response.status_code == 404:
raise ApiPermissionError(
"The calling user does not have permission to view the content",
reason=e,
)
raise
return response
def get_all_pages_by_label(self, label, start=0, limit=50):
"""
Get all page by label
:param label:
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
fixed system limits. Default: 50
:return:
"""
url = "rest/api/content/search"
params = {}
if label:
params["cql"] = 'type={type} AND label="{label}"'.format(type="page", label=label)
if start:
params["start"] = start
if limit:
params["limit"] = limit
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 400:
raise ApiValueError("The CQL is invalid or missing", reason=e)
raise
return response.get("results")
def get_all_pages_from_space(self, space, start=0, limit=50, status=None, expand=None, content_type="page"):
"""
Get all pages from space
:param space:
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
fixed system limits. Default: 50
:param status: OPTIONAL: list of statuses the content to be found is in.
Defaults to current is not specified.
If set to 'any', content in 'current' and 'trashed' status will be fetched.
Does not support 'historical' status for now.
:param expand: OPTIONAL: a comma separated list of properties to expand on the content.
Default value: history,space,version.
:param content_type: the content type to return. Default value: page. Valid values: page, blogpost.
:return:
"""
url = "rest/api/content"
params = {}
if space:
params["spaceKey"] = space
if start:
params["start"] = start
if limit:
params["limit"] = limit
if status:
params["status"] = status
if expand:
params["expand"] = expand
if content_type:
params["type"] = content_type
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 404:
raise ApiPermissionError(
"The calling user does not have permission to view the content",
reason=e,
)
raise
return response.get("results")
def get_all_pages_from_space_trash(self, space, start=0, limit=500, status="trashed", content_type="page"):
"""
Get list of pages from trash
:param space:
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
fixed system limits. Default: 500
:param status:
:param content_type: the content type to return. Default value: page. Valid values: page, blogpost.
:return:
"""
return self.get_all_pages_from_space(space, start, limit, status, content_type=content_type)
def get_all_draft_pages_from_space(self, space, start=0, limit=500, status="draft"):
"""
Get list of draft pages from space
Use case is cleanup old drafts from Confluence
:param space:
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
fixed system limits. Default: 500
:param status:
:return:
"""
return self.get_all_pages_from_space(space, start, limit, status)
def get_all_draft_pages_from_space_through_cql(self, space, start=0, limit=500, status="draft"):
"""
Search list of draft pages by space key
Use case is cleanup old drafts from Confluence
:param space: Space Key
:param status: Can be changed
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
fixed system limits. Default: 500
:return:
"""
url = "rest/api/content?cql=space=spaceKey={space} and status={status}".format(space=space, status=status)
params = {}
if limit:
params["limit"] = limit
if start:
params["start"] = start
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 404:
raise ApiPermissionError(
"The calling user does not have permission to view the content",
reason=e,
)
raise
return response.get("results")
@deprecated(version="2.4.2", reason="Use get_all_restrictions_for_content()")
def get_all_restictions_for_content(self, content_id):
"""Let's use the get_all_restrictions_for_content()"""
log.warning("Please, be informed that is deprecated as typo naming")
return self.get_all_restrictions_for_content(content_id=content_id)
def get_all_restrictions_for_content(self, content_id):
"""
Returns info about all restrictions by operation.
:param content_id:
:return: Return the raw json response
"""
url = "rest/api/content/{}/restriction/byOperation".format(content_id)
return self.get(url)
def remove_page_from_trash(self, page_id):
"""
This method removes a page from trash
:param page_id:
:return:
"""
return self.remove_page(page_id=page_id, status="trashed")
def remove_page_as_draft(self, page_id):
"""
This method removes a page from trash if it is a draft
:param page_id:
:return:
"""
return self.remove_page(page_id=page_id, status="draft")
def remove_content(self, content_id):
"""
Remove any content
:param content_id:
:return:
"""
try:
response = self.delete("rest/api/content/{}".format(content_id))
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, or the calling "
"user does not have permission to trash or purge the content",
reason=e,
)
if e.response.status_code == 409:
raise ApiConflictError(
"There is a stale data object conflict when trying to delete a draft",
reason=e,
)
raise
return response
def remove_page(self, page_id, status=None, recursive=False):
"""
This method removes a page, if it has recursive flag, method removes including child pages
:param page_id:
:param status: OPTIONAL: type of page
:param recursive: OPTIONAL: if True - will recursively delete all children pages too
:return:
"""
url = "rest/api/content/{page_id}".format(page_id=page_id)
if recursive:
children_pages = self.get_page_child_by_type(page_id)
for children_page in children_pages:
self.remove_page(children_page.get("id"), status, recursive)
params = {}
if status:
params["status"] = status
try:
response = self.delete(url, params=params)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, or the calling "
"user does not have permission to trash or purge the content",
reason=e,
)
if e.response.status_code == 409:
raise ApiConflictError(
"There is a stale data object conflict when trying to delete a draft",
reason=e,
)
raise
return response
def create_page(
self,
space,
title,
body,
parent_id=None,
type="page",
representation="storage",
editor=None,
):
"""
Create page from scratch
:param space:
:param title:
:param body:
:param parent_id:
:param type:
:param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format
:param editor: OPTIONAL: v2 to be created in the new editor
:return:
"""
log.info('Creating {type} "{space}" -> "{title}"'.format(space=space, title=title, type=type))
url = "rest/api/content/"
data = {
"type": type,
"title": title,
"space": {"key": space},
"body": self._create_body(body, representation),
}
if parent_id:
data["ancestors"] = [{"type": type, "id": parent_id}]
if editor == "v2":
data["metadata"] = {"properties": {"editor": {"value": "v2"}}}
try:
response = self.post(url, data=data)
except HTTPError as e:
if e.response.status_code == 404:
raise ApiPermissionError(
"The calling user does not have permission to view the content",
reason=e,
)
raise
return response
def move_page(self, space_key, page_id, target_id=None, target_title=None, position="append"):
"""
Move page method
:param space_key:
:param page_id:
:param target_title:
:param target_id:
:param position: topLevel or append , above, below
:return:
"""
url = "/pages/movepage.action"
params = {"spaceKey": space_key, "pageId": page_id}
if target_title:
params["targetTitle"] = target_title
if target_id:
params["targetId"] = target_id
if position:
params["position"] = position
return self.post(url, params=params, headers=self.no_check_headers)
def create_or_update_template(
self, name, body, template_type="page", template_id=None, description=None, labels=None, space=None
):
"""
Creates a new or updates an existing content template.
Note, blueprint templates cannot be created or updated via the REST API.
If you provide a ``template_id`` then this method will update the template with the provided settings.
If no ``template_id`` is provided, then this method assumes you are creating a new template.
:param str name: If creating, the name of the new template. If updating, the name to change
the template name to. Set to the current name if this field is not being updated.
:param dict body: This object is used when creating or updating content.
{
"storage": {
"value": "<string>",
"representation": "view"
}
}
:param str template_type: OPTIONAL: The type of the new template. Default: "page".
:param str template_id: OPTIONAL: The ID of the template being updated. REQUIRED if updating a template.
:param str description: OPTIONAL: A description of the new template. Max length 255.
:param list labels: OPTIONAL: Labels for the new template. An array like:
[
{
"prefix": "<string>",
"name": "<string>",
"id": "<string>",
"label": "<string>",
}
]
:param dict space: OPTIONAL: The key for the space of the new template. Only applies to space templates.
If not specified, the template will be created as a global template.
:return:
"""
data = {"name": name, "templateType": template_type, "body": body}
if description:
data["description"] = description
if labels:
data["labels"] = labels
if space:
data["space"] = {"key": space}
if template_id:
data["templateId"] = template_id
return self.put("wiki/rest/api/template", data=json.dumps(data))
return self.post("wiki/rest/api/template", json=data)
@deprecated(version="3.7.0", reason="Use get_content_template()")
def get_template_by_id(self, template_id):
"""
Get user template by id. Experimental API
Use case is get template body and create page from that
"""
url = "rest/experimental/template/{template_id}".format(template_id=template_id)
try:
response = self.get(url)
except HTTPError as e:
if e.response.status_code == 403:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, "
"or the calling user does not have permission to view the content",
reason=e,
)
raise
return response
def get_content_template(self, template_id):
"""
Get a content template.
This includes information about the template, like the name, the space or blueprint
that the template is in, the body of the template, and more.
:param str template_id: The ID of the content template to be returned
:return:
"""
url = "wiki/rest/api/template/{template_id}".format(template_id=template_id)
try:
response = self.get(url)
except HTTPError as e:
if e.response.status_code == 403:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, "
"or the calling user does not have permission to view the content",
reason=e,
)
raise
return response
@deprecated(version="3.7.0", reason="Use get_blueprint_templates()")
def get_all_blueprints_from_space(self, space, start=0, limit=None, expand=None):
"""
Get all users blue prints from space. Experimental API
:param space: Space Key
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
fixed system limits. Default: 20
:param expand: OPTIONAL: expand e.g. body
"""
url = "rest/experimental/template/blueprint"
params = {}
if space:
params["spaceKey"] = space
if start:
params["start"] = start
if limit:
params["limit"] = limit
if expand:
params["expand"] = expand
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 403:
raise ApiPermissionError(
"The calling user does not have permission to view the content",
reason=e,
)
raise
return response.get("results") or []
def get_blueprint_templates(self, space=None, start=0, limit=None, expand=None):
"""
Gets all templates provided by blueprints.
Use this method to retrieve all global blueprint templates or all blueprint templates in a space.
:param space: OPTIONAL: The key of the space to be queried for templates. If ``space`` is not
specified, global blueprint templates will be returned.
:param start: OPTIONAL: The starting index of the returned templates. Default: None (0).
:param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
fixed system limits. Default: 25
:param expand: OPTIONAL: A multi-value parameter indicating which properties of the template to expand.
"""
url = "wiki/rest/api/template/blueprint"
params = {}
if space:
params["spaceKey"] = space
if start:
params["start"] = start
if limit:
params["limit"] = limit
if expand:
params["expand"] = expand
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 403:
raise ApiPermissionError(
"The calling user does not have permission to view the content",
reason=e,
)
raise
return response.get("results") or []
@deprecated(version="3.7.0", reason="Use get_content_templates()")
def get_all_templates_from_space(self, space, start=0, limit=None, expand=None):
"""
Get all users templates from space. Experimental API
ref: https://docs.atlassian.com/atlassian-confluence/1000.73.0/com/atlassian/confluence/plugins/restapi\
/resources/TemplateResource.html
:param space: Space Key
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
fixed system limits. Default: 20
:param expand: OPTIONAL: expand e.g. body
"""
url = "rest/experimental/template/page"
params = {}
if space:
params["spaceKey"] = space
if start:
params["start"] = start
if limit:
params["limit"] = limit
if expand:
params["expand"] = expand
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 403:
raise ApiPermissionError(
"The calling user does not have permission to view the content",
reason=e,
)
raise
return response.get("results") or []
def get_content_templates(self, space=None, start=0, limit=None, expand=None):
"""
Get all content templates.
Use this method to retrieve all global content templates or all content templates in a space.
:param space: OPTIONAL: The key of the space to be queried for templates. If ``space`` is not
specified, global templates will be returned.
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
fixed system limits. Default: 25
:param expand: OPTIONAL: A multi-value parameter indicating which properties of the template to expand.
e.g. ``body``
"""
url = "wiki/rest/api/template/page"
params = {}
if space:
params["spaceKey"] = space
if start:
params["start"] = start
if limit:
params["limit"] = limit
if expand:
params["expand"] = expand
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 403:
raise ApiPermissionError(
"The calling user does not have permission to view the content",
reason=e,
)
raise
return response.get("results") or []
def remove_template(self, template_id):
"""
Deletes a template.
This results in different actions depending on the type of template:
* If the template is a content template, it is deleted.
* If the template is a modified space-level blueprint template, it reverts to the template
inherited from the global-level blueprint template.
* If the template is a modified global-level blueprint template, it reverts to the default
global-level blueprint template.
Note: Unmodified blueprint templates cannot be deleted.
:param str template_id: The ID of the template to be deleted.
:return:
"""
return self.delete("wiki/rest/api/template/{}".format(template_id))
def get_all_spaces(self, start=0, limit=500, expand=None, space_type=None, space_status=None):
"""
Get all spaces with provided limit
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
fixed system limits. Default: 500
:param space_type: OPTIONAL: Filter the list of spaces returned by type (global, personal)
:param space_status: OPTIONAL: Filter the list of spaces returned by status (current, archived)
:param expand: OPTIONAL: additional info, e.g. metadata, icon, description, homepage
"""
url = "rest/api/space"
params = {}
if start:
params["start"] = start
if limit:
params["limit"] = limit
if expand:
params["expand"] = expand
if space_type:
params["type"] = space_type
if space_status:
params["status"] = space_status
return self.get(url, params=params)
def add_comment(self, page_id, text):
"""
Add comment into page
:param page_id
:param text
"""
data = {
"type": "comment",
"container": {"id": page_id, "type": "page", "status": "current"},
"body": self._create_body(text, "storage"),
}
try:
response = self.post("rest/api/content/", data=data)
except HTTPError as e:
if e.response.status_code == 404:
raise ApiPermissionError(
"The calling user does not have permission to view the content",
reason=e,
)
raise
return response
def attach_content(
self,
content,
name,
content_type="application/binary",
page_id=None,
title=None,
space=None,
comment=None,
):
"""
Attach (upload) a file to a page, if it exists it will update the
automatically version the new file and keep the old one.
:param title: The page name
:type title: ``str``
:param space: The space name
:type space: ``str``
:param page_id: The page id to which we would like to upload the file
:type page_id: ``str``
:param name: The name of the attachment
:type name: ``str``
:param content: Contains the content which should be uploaded
:type content: ``binary``
:param content_type: Specify the HTTP content type. The default is
:type content_type: ``str``
:param comment: A comment describing this upload/file
:type comment: ``str``
"""
page_id = self.get_page_id(space=space, title=title) if page_id is None else page_id
type = "attachment"
if page_id is not None:
comment = comment if comment else "Uploaded {filename}.".format(filename=name)
data = {
"type": type,
"fileName": name,
"contentType": content_type,
"comment": comment,
"minorEdit": "true",
}
headers = {"X-Atlassian-Token": "no-check", "Accept": "application/json"}
path = "rest/api/content/{page_id}/child/attachment".format(page_id=page_id)
# Check if there is already a file with the same name
attachments = self.get(path=path, headers=headers, params={"filename": name})
if attachments.get("size"):
path = path + "/" + attachments["results"][0]["id"] + "/data"
try:
response = self.post(
path=path,
data=data,
headers=headers,
files={"file": (name, content, content_type)},
)
except HTTPError as e:
if e.response.status_code == 403:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"Attachments are disabled or the calling user does "
"not have permission to add attachments to this content",
reason=e,
)
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"The requested content is not found, the user does not have "
"permission to view it, or the attachments exceeds the maximum "
"configured attachment size",
reason=e,
)
raise
return response
else:
log.warning("No 'page_id' found, not uploading attachments")
return None
def attach_file(
self,
filename,
name=None,
content_type=None,
page_id=None,
title=None,
space=None,
comment=None,
):
"""
Attach (upload) a file to a page, if it exists it will update the
automatically version the new file and keep the old one.
:param title: The page name
:type title: ``str``
:param space: The space name
:type space: ``str``
:param page_id: The page id to which we would like to upload the file
:type page_id: ``str``
:param filename: The file to upload (Specifies the content)
:type filename: ``str``
:param name: Specifies name of the attachment. This parameter is optional.
Is no name give the file name is used as name
:type name: ``str``
:param content_type: Specify the HTTP content type. The default is
:type content_type: ``str``
:param comment: A comment describing this upload/file
:type comment: ``str``
"""
# get base name of the file to get the attachment from confluence.
if name is None:
name = os.path.basename(filename)
if content_type is None:
extension = os.path.splitext(filename)[-1]
content_type = self.content_types.get(extension, "application/binary")
with open(filename, "rb") as infile:
content = infile.read()
return self.attach_content(
content,
name,
content_type,
page_id=page_id,
title=title,
space=space,
comment=comment,
)
def delete_attachment(self, page_id, filename, version=None):
"""
Remove completely a file if version is None or delete version
:param version:
:param page_id: file version
:param filename:
:return:
"""
params = {"pageId": page_id, "fileName": filename}
if version:
params["version"] = version
return self.post(
"json/removeattachment.action",
params=params,
headers=self.form_token_headers,
)
def delete_attachment_by_id(self, attachment_id, version):
"""
Remove completely a file if version is None or delete version
:param attachment_id:
:param version: file version
:return:
"""
return self.delete(
"rest/experimental/content/{id}/version/{versionId}".format(id=attachment_id, versionId=version)
)
def remove_page_attachment_keep_version(self, page_id, filename, keep_last_versions):
"""
Keep last versions
:param filename:
:param page_id:
:param keep_last_versions:
:return:
"""
attachment = self.get_attachments_from_content(page_id=page_id, expand="version", filename=filename).get(
"results"
)[0]
attachment_versions = self.get_attachment_history(attachment.get("id"))
while len(attachment_versions) > keep_last_versions:
remove_version_attachment_number = attachment_versions[keep_last_versions].get("number")
self.delete_attachment_by_id(
attachment_id=attachment.get("id"),
version=remove_version_attachment_number,
)
log.info(
"Removed oldest version for {}, now versions equal more than {}".format(
attachment.get("title"), len(attachment_versions)
)
)
attachment_versions = self.get_attachment_history(attachment.get("id"))
log.info("Kept versions {} for {}".format(keep_last_versions, attachment.get("title")))
def get_attachment_history(self, attachment_id, limit=200, start=0):
"""
Get attachment history
:param attachment_id
:param limit
:param start
:return
"""
params = {"limit": limit, "start": start}
url = "rest/experimental/content/{}/version".format(attachment_id)
return (self.get(url, params=params) or {}).get("results")
# @todo prepare more attachments info
def get_attachments_from_content(self, page_id, start=0, limit=50, expand=None, filename=None, media_type=None):
"""
Get attachments for page
:param page_id:
:param start:
:param limit:
:param expand:
:param filename:
:param media_type:
:return:
"""
params = {}
if start:
params["start"] = start
if limit:
params["limit"] = limit
if expand:
params["expand"] = expand
if filename:
params["filename"] = filename
if media_type:
params["mediaType"] = media_type
url = "rest/api/content/{id}/child/attachment".format(id=page_id)
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, "
"or the calling user does not have permission to view the content",
reason=e,
)
raise
return response
def set_page_label(self, page_id, label):
"""
Set a label on the page
:param page_id: content_id format
:param label: label to add
:return:
"""
url = "rest/api/content/{page_id}/label".format(page_id=page_id)
data = {"prefix": "global", "name": label}
try:
response = self.post(path=url, data=data)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, "
"or the calling user does not have permission to view the content",
reason=e,
)
raise
return response
def remove_page_label(self, page_id, label):
"""
Delete Confluence page label
:param page_id: content_id format
:param label: label name
:return:
"""
url = "rest/api/content/{page_id}/label".format(page_id=page_id)
params = {"id": page_id, "name": label}
try:
response = self.delete(path=url, params=params)
except HTTPError as e:
if e.response.status_code == 403:
raise ApiPermissionError(
"The user has view permission, " "but no edit permission to the content",
reason=e,
)
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"The content or label doesn't exist, "
"or the calling user doesn't have view permission to the content",
reason=e,
)
raise
return response
def history(self, page_id):
url = "rest/api/content/{0}/history".format(page_id)
try:
response = self.get(url)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, "
"or the calling user does not have permission to view the content",
reason=e,
)
raise
return response
def get_content_history(self, content_id):
return self.history(content_id)
def get_content_history_by_version_number(self, content_id, version_number):
"""
Get content history by version number
:param content_id:
:param version_number:
:return:
"""
url = "rest/experimental/content/{0}/version/{1}".format(content_id, version_number)
return self.get(url)
def remove_content_history(self, page_id, version_number):
"""
Remove content history. It works as experimental method
:param page_id:
:param version_number: version number
:return:
"""
url = "rest/experimental/content/{id}/version/{versionNumber}".format(id=page_id, versionNumber=version_number)
self.delete(url)
def remove_page_history(self, page_id, version_number):
"""
Remove content history. It works as experimental method
:param page_id:
:param version_number: version number
:return:
"""
self.remove_content_history(page_id, version_number)
def remove_content_history_in_cloud(self, page_id, version_id):
"""
Remove content history. It works in CLOUD
:param page_id:
:param version_id:
:return:
"""
url = "rest/api/content/{id}/version/{versionId}".format(id=page_id, versionId=version_id)
self.delete(url)
def remove_page_history_keep_version(self, page_id, keep_last_versions):
"""
Keep last versions
:param page_id:
:param keep_last_versions:
:return:
"""
page = self.get_page_by_id(page_id=page_id, expand="version")
page_number = page.get("version").get("number")
while page_number > keep_last_versions:
self.remove_page_history(page_id=page_id, version_number=1)
page = self.get_page_by_id(page_id=page_id, expand="version")
page_number = page.get("version").get("number")
log.info("Removed oldest version for {}, now it's {}".format(page.get("title"), page_number))
log.info("Kept versions {} for {}".format(keep_last_versions, page.get("title")))
def has_unknown_attachment_error(self, page_id):
"""
Check has unknown attachment error on page
:param page_id:
:return:
"""
unknown_attachment_identifier = "plugins/servlet/confluence/placeholder/unknown-attachment"
result = self.get_page_by_id(page_id, expand="body.view")
if len(result) == 0:
return ""
body = ((result.get("body") or {}).get("view") or {}).get("value") or {}
if unknown_attachment_identifier in body:
return result.get("_links").get("base") + result.get("_links").get("tinyui")
return ""
def is_page_content_is_already_updated(self, page_id, body, title=None):
"""
Compare content and check is already updated or not
:param page_id: Content ID for retrieve storage value
:param body: Body for compare it
:param title: Title to compare
:return: True if the same
"""
confluence_content = self.get_page_by_id(page_id)
if title:
current_title = confluence_content.get("title", None)
if title != current_title:
log.info("Title of {page_id} is different".format(page_id=page_id))
return False
if self.advanced_mode:
confluence_content = (
(self.get_page_by_id(page_id, expand="body.storage").json() or {}).get("body") or {}
).get("storage") or {}
else:
confluence_content = ((self.get_page_by_id(page_id, expand="body.storage") or {}).get("body") or {}).get(
"storage"
) or {}
confluence_body_content = confluence_content.get("value")
if confluence_body_content:
# @todo move into utils
confluence_body_content = utils.symbol_normalizer(confluence_body_content)
log.debug('Old Content: """{body}"""'.format(body=confluence_body_content))
log.debug('New Content: """{body}"""'.format(body=body))
if confluence_body_content.strip() == body.strip():
log.warning("Content of {page_id} is exactly the same".format(page_id=page_id))
return True
else:
log.info("Content of {page_id} differs".format(page_id=page_id))
return False
def update_existing_page(
self,
page_id,
title,
body,
type="page",
representation="storage",
minor_edit=False,
version_comment=None,
):
"""Duplicate update_page. Left for the people who used it before. Use update_page instead"""
return self.update_page(
page_id=page_id,
title=title,
body=body,
parent_id=None,
type=type,
representation=representation,
minor_edit=minor_edit,
version_comment=version_comment,
)
def update_page(
self,
page_id,
title,
body=None,
parent_id=None,
type="page",
representation="storage",
minor_edit=False,
version_comment=None,
always_update=False,
):
"""
Update page if already exist
:param page_id:
:param title:
:param body:
:param parent_id:
:param type:
:param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format
:param minor_edit: Indicates whether to notify watchers about changes.
If False then notifications will be sent.
:param version_comment: Version comment
:param always_update: Whether always to update (suppress content check)
:return:
"""
log.info('Updating {type} "{title}"'.format(title=title, type=type))
if not always_update and body is not None and self.is_page_content_is_already_updated(page_id, body, title):
return self.get_page_by_id(page_id)
try:
if self.advanced_mode:
version = self.history(page_id).json()["lastUpdated"]["number"] + 1
else:
version = self.history(page_id)["lastUpdated"]["number"] + 1
except (IndexError, TypeError) as e:
log.error("Can't find '{title}' {type}!".format(title=title, type=type))
log.debug(e)
return None
data = {
"id": page_id,
"type": type,
"title": title,
"version": {"number": version, "minorEdit": minor_edit},
}
if body is not None:
data["body"] = self._create_body(body, representation)
if parent_id:
data["ancestors"] = [{"type": "page", "id": parent_id}]
if version_comment:
data["version"]["message"] = version_comment
try:
response = self.put("rest/api/content/{0}".format(page_id), data=data)
except HTTPError as e:
if e.response.status_code == 400:
raise ApiValueError(
"No space or no content type, or setup a wrong version "
"type set to content, or status param is not draft and "
"status content is current",
reason=e,
)
if e.response.status_code == 404:
raise ApiNotFoundError("Can not find draft with current content", reason=e)
raise
return response
def _insert_to_existing_page(
self,
page_id,
title,
insert_body,
parent_id=None,
type="page",
representation="storage",
minor_edit=False,
version_comment=None,
top_of_page=False,
):
"""
Insert body to a page if already exist
:param parent_id:
:param page_id:
:param title:
:param insert_body:
:param type:
:param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format
:param minor_edit: Indicates whether to notify watchers about changes.
If False then notifications will be sent.
:param top_of_page: Option to add the content to the end of page body
:return:
"""
log.info('Updating {type} "{title}"'.format(title=title, type=type))
if self.is_page_content_is_already_updated(page_id, insert_body, title):
return self.get_page_by_id(page_id)
else:
version = self.history(page_id)["lastUpdated"]["number"] + 1
previous_body = (
(self.get_page_by_id(page_id, expand="body.storage").get("body") or {}).get("storage").get("value")
)
previous_body = previous_body.replace("ó", u"ó")
body = insert_body + previous_body if top_of_page else previous_body + insert_body
data = {
"id": page_id,
"type": type,
"title": title,
"body": self._create_body(body, representation),
"version": {"number": version, "minorEdit": minor_edit},
}
if parent_id:
data["ancestors"] = [{"type": "page", "id": parent_id}]
if version_comment:
data["version"]["message"] = version_comment
try:
response = self.put("rest/api/content/{0}".format(page_id), data=data)
except HTTPError as e:
if e.response.status_code == 400:
raise ApiValueError(
"No space or no content type, or setup a wrong version "
"type set to content, or status param is not draft and "
"status content is current",
reason=e,
)
if e.response.status_code == 404:
raise ApiNotFoundError("Can not find draft with current content", reason=e)
raise
return response
def append_page(
self,
page_id,
title,
append_body,
parent_id=None,
type="page",
representation="storage",
minor_edit=False,
):
"""
Append body to page if already exist
:param parent_id:
:param page_id:
:param title:
:param append_body:
:param type:
:param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format
:param minor_edit: Indicates whether to notify watchers about changes.
If False then notifications will be sent.
:return:
"""
log.info('Updating {type} "{title}"'.format(title=title, type=type))
return self._insert_to_existing_page(
page_id,
title,
append_body,
parent_id=parent_id,
type=type,
representation=representation,
minor_edit=minor_edit,
top_of_page=False,
)
def prepend_page(
self,
page_id,
title,
prepend_body,
parent_id=None,
type="page",
representation="storage",
minor_edit=False,
):
"""
Append body to page if already exist
:param parent_id:
:param page_id:
:param title:
:param prepend_body:
:param type:
:param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format
:param minor_edit: Indicates whether to notify watchers about changes.
If False then notifications will be sent.
:return:
"""
log.info('Updating {type} "{title}"'.format(title=title, type=type))
return self._insert_to_existing_page(
page_id,
title,
prepend_body,
parent_id=parent_id,
type=type,
representation=representation,
minor_edit=minor_edit,
top_of_page=True,
)
def update_or_create(
self,
parent_id,
title,
body,
representation="storage",
minor_edit=False,
version_comment=None,
editor=None,
):
"""
Update page or create a page if it is not exists
:param parent_id:
:param title:
:param body:
:param representation: OPTIONAL: either Confluence 'storage' or 'wiki' markup format
:param minor_edit: Update page without notification
:param version_comment: Version comment
:param editor: OPTIONAL: v2 to be created in the new editor
:return:
"""
space = self.get_page_space(parent_id)
if self.page_exists(space, title):
page_id = self.get_page_id(space, title)
parent_id = parent_id if parent_id is not None else self.get_parent_content_id(page_id)
result = self.update_page(
parent_id=parent_id,
page_id=page_id,
title=title,
body=body,
representation=representation,
minor_edit=minor_edit,
version_comment=version_comment,
)
else:
result = self.create_page(
space=space,
parent_id=parent_id,
title=title,
body=body,
representation=representation,
editor=editor,
)
log.info(
"You may access your page at: {host}{url}".format(
host=self.url, url=((result or {}).get("_links") or {}).get("tinyui")
)
)
return result
def convert_wiki_to_storage(self, wiki):
"""
Convert to Confluence XHTML format from wiki style
:param wiki:
:return:
"""
data = {"value": wiki, "representation": "wiki"}
return self.post("rest/api/contentbody/convert/storage", data=data)
def convert_storage_to_view(self, storage):
"""
Convert from Confluence XHTML format to view format
:param storage:
:return:
"""
data = {"value": storage, "representation": "storage"}
return self.post("rest/api/contentbody/convert/view", data=data)
def set_page_property(self, page_id, data):
"""
Set the page (content) property e.g. add hash parameters
:param page_id: content_id format
:param data: data should be as json data
:return:
"""
url = "rest/api/content/{page_id}/property".format(page_id=page_id)
json_data = data
try:
response = self.post(path=url, data=json_data)
except HTTPError as e:
if e.response.status_code == 400:
raise ApiValueError(
"The given property has a different content id to the one in the "
"path, or the content already has a value with the given key, or "
"the value is missing, or the value is too long",
reason=e,
)
if e.response.status_code == 403:
raise ApiPermissionError(
"The user does not have permission to " "edit the content with the given id",
reason=e,
)
if e.response.status_code == 413:
raise ApiValueError("The value is too long", reason=e)
raise
return response
def update_page_property(self, page_id, data):
"""
Update the page (content) property.
Use json data or independent keys
:param data:
:param page_id: content_id format
:data: property data in json format
:return:
"""
url = "rest/api/content/{page_id}/property/{key}".format(page_id=page_id, key=data.get("key"))
try:
response = self.put(path=url, data=data)
except HTTPError as e:
if e.response.status_code == 400:
raise ApiValueError(
"The given property has a different content id to the one in the "
"path, or the content already has a value with the given key, or "
"the value is missing, or the value is too long",
reason=e,
)
if e.response.status_code == 403:
raise ApiPermissionError(
"The user does not have permission to " "edit the content with the given id",
reason=e,
)
if e.response.status_code == 404:
raise ApiNotFoundError(
"There is no content with the given id, or no property with the given key, "
"or if the calling user does not have permission to view the content.",
reason=e,
)
if e.response.status_code == 409:
raise ApiConflictError(
"The given version is does not match the expected " "target version of the updated property",
reason=e,
)
if e.response.status_code == 413:
raise ApiValueError("The value is too long", reason=e)
raise
return response
def delete_page_property(self, page_id, page_property):
"""
Delete the page (content) property e.g. delete key of hash
:param page_id: content_id format
:param page_property: key of property
:return:
"""
url = "rest/api/content/{page_id}/property/{page_property}".format(
page_id=page_id, page_property=str(page_property)
)
try:
response = self.delete(path=url)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, "
"or the calling user does not have permission to view the content",
reason=e,
)
raise
return response
def get_page_property(self, page_id, page_property_key):
"""
Get the page (content) property e.g. get key of hash
:param page_id: content_id format
:param page_property_key: key of property
:return:
"""
url = "rest/api/content/{page_id}/property/{key}".format(page_id=page_id, key=str(page_property_key))
try:
response = self.get(path=url)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, or no property with the "
"given key, or the calling user does not have permission to view "
"the content",
reason=e,
)
raise
return response
def get_page_properties(self, page_id):
"""
Get the page (content) properties
:param page_id: content_id format
:return: get properties
"""
url = "rest/api/content/{page_id}/property".format(page_id=page_id)
try:
response = self.get(path=url)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, "
"or the calling user does not have permission to view the content",
reason=e,
)
raise
return response
def get_page_ancestors(self, page_id):
"""
Provide the ancestors from the page (content) id
:param page_id: content_id format
:return: get properties
"""
url = "rest/api/content/{page_id}?expand=ancestors".format(page_id=page_id)
try:
response = self.get(path=url)
except HTTPError as e:
if e.response.status_code == 404:
raise ApiPermissionError(
"The calling user does not have permission to view the content",
reason=e,
)
raise
return response.get("ancestors")
def clean_all_caches(self):
""" Clean all caches from cache management"""
headers = self.form_token_headers
return self.delete("rest/cacheManagement/1.0/cacheEntries", headers=headers)
def clean_package_cache(self, cache_name="com.gliffy.cache.gon"):
"""Clean caches from cache management
e.g.
com.gliffy.cache.gon
org.hibernate.cache.internal.StandardQueryCache_v5
"""
headers = self.form_token_headers
data = {"cacheName": cache_name}
return self.delete("rest/cacheManagement/1.0/cacheEntries", data=data, headers=headers)
def get_all_groups(self, start=0, limit=1000):
"""
Get all groups from Confluence User management
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of groups to return, this may be restricted by
fixed system limits. Default: 1000
:return:
"""
url = "rest/api/group?limit={limit}&start={start}".format(limit=limit, start=start)
try:
response = self.get(url)
except HTTPError as e:
if e.response.status_code == 403:
raise ApiPermissionError("The calling user does not have permission to view groups", reason=e)
raise
return response.get("results")
def get_group_members(self, group_name="confluence-users", start=0, limit=1000, expand=None):
"""
Get a paginated collection of users in the given group
:param group_name
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of users to return, this may be restricted by
fixed system limits. Default: 1000
:param expand: OPTIONAL: A comma separated list of properties to expand on the content. status
:return:
"""
url = "rest/api/group/{group_name}/member?limit={limit}&start={start}&expand={expand}".format(
group_name=group_name, limit=limit, start=start, expand=expand
)
try:
response = self.get(url)
except HTTPError as e:
if e.response.status_code == 403:
raise ApiPermissionError("The calling user does not have permission to view users", reason=e)
raise
return response.get("results")
def get_all_members(self, group_name="confluence-users", expand=None):
"""
Get collection of all users in the given group
:param group_name
:param expand: OPTIONAL: A comma separated list of properties to expand on the content. status
:return:
"""
limit = 50
flag = True
step = 0
members = []
while flag:
values = self.get_group_members(group_name=group_name, start=len(members), limit=limit, expand=expand)
step += 1
if len(values) == 0:
flag = False
else:
members.extend(values)
if not members:
print("Did not get members from {} group, please check permissions or connectivity".format(group_name))
return members
def get_space(self, space_key, expand="description.plain,homepage", params=None):
"""
Get information about a space through space key
:param space_key: The unique space key name
:param expand: OPTIONAL: additional info from description, homepage
:param params: OPTIONAL: dictionary of additional URL parameters
:return: Returns the space along with its ID
"""
url = "rest/api/space/{space_key}".format(space_key=space_key)
params = params or {}
if expand:
params["expand"] = expand
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no space with the given key, "
"or the calling user does not have permission to view the space",
reason=e,
)
raise
return response
def get_space_content(
self,
space_key,
depth="all",
start=0,
limit=500,
content_type=None,
expand="body.storage",
):
"""
Get space content.
You can specify which type of content want to receive, or get all content types.
Use expand to get specific content properties or page
:param content_type:
:param space_key: The unique space key name
:param depth: OPTIONAL: all|root
Gets all space pages or only root pages
:param start: OPTIONAL: The start point of the collection to return. Default: 0.
:param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
fixed system limits. Default: 500
:param expand: OPTIONAL: by default expands page body in confluence storage format.
See atlassian documentation for more information.
:return: Returns the space along with its ID
"""
content_type = "{}".format("/" + content_type if content_type else "")
url = "rest/api/space/{space_key}/content{content_type}".format(space_key=space_key, content_type=content_type)
params = {
"depth": depth,
"start": start,
"limit": limit,
}
if expand:
params["expand"] = expand
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no space with the given key, "
"or the calling user does not have permission to view the space",
reason=e,
)
raise
return response
def get_home_page_of_space(self, space_key):
"""
Get information about a space through space key
:param space_key: The unique space key name
:return: Returns homepage
"""
return self.get_space(space_key, expand="homepage").get("homepage")
def create_space(self, space_key, space_name):
"""
Create space
:param space_key:
:param space_name:
:return:
"""
data = {"key": space_key, "name": space_name}
self.post("rest/api/space", data=data)
def delete_space(self, space_key):
"""
Delete space
:param space_key:
:return:
"""
url = "rest/api/space/{}".format(space_key)
try:
response = self.delete(url)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no space with the given key, "
"or the calling user does not have permission to delete it",
reason=e,
)
raise
return response
def get_space_property(self, space_key, expand=None):
url = "rest/api/space/{space}/property".format(space=space_key)
params = {}
if expand:
params["expand"] = expand
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no space with the given key, "
"or the calling user does not have permission to view the space",
reason=e,
)
raise
return response
def get_user_details_by_username(self, username, expand=None):
"""
Get information about a user through username
:param username: The user name
:param expand: OPTIONAL expand for get status of user.
Possible param is "status". Results are "Active, Deactivated"
:return: Returns the user details
"""
url = "rest/api/user"
params = {"username": username}
if expand:
params["expand"] = expand
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 403:
raise ApiPermissionError("The calling user does not have permission to view users", reason=e)
if e.response.status_code == 404:
raise ApiNotFoundError(
"The user with the given username or userkey does not exist",
reason=e,
)
raise
return response
def get_user_details_by_userkey(self, userkey, expand=None):
"""
Get information about a user through user key
:param userkey: The user key
:param expand: OPTIONAL expand for get status of user.
Possible param is "status". Results are "Active, Deactivated"
:return: Returns the user details
"""
url = "rest/api/user"
params = {"key": userkey}
if expand:
params["expand"] = expand
try:
response = self.get(url, params=params)
except HTTPError as e:
if e.response.status_code == 403:
raise ApiPermissionError("The calling user does not have permission to view users", reason=e)
if e.response.status_code == 404:
raise ApiNotFoundError(
"The user with the given username or userkey does not exist",
reason=e,
)
raise
return response
def cql(
self,
cql,
start=0,
limit=None,
expand=None,
include_archived_spaces=None,
excerpt=None,
):
"""
Get results from cql search result with all related fields
Search for entities in Confluence using the Confluence Query Language (CQL)
:param cql:
:param start: OPTIONAL: The start point of the collection to return. Default: 0.
:param limit: OPTIONAL: The limit of the number of issues to return, this may be restricted by
fixed system limits. Default by built-in method: 25
:param excerpt: the excerpt strategy to apply to the result, one of : indexed, highlight, none.
This defaults to highlight
:param expand: OPTIONAL: the properties to expand on the search result,
this may cause database requests for some properties
:param include_archived_spaces: OPTIONAL: whether to include content in archived spaces in the result,
this defaults to false
:return:
"""
params = {}
if start is not None:
params["start"] = int(start)
if limit is not None:
params["limit"] = int(limit)
if cql is not None:
params["cql"] = cql
if expand is not None:
params["expand"] = expand
if include_archived_spaces is not None:
params["includeArchivedSpaces"] = include_archived_spaces
if excerpt is not None:
params["excerpt"] = excerpt
try:
response = self.get("rest/api/search", params=params)
except HTTPError as e:
if e.response.status_code == 400:
raise ApiValueError("The query cannot be parsed", reason=e)
raise
return response
def get_page_as_pdf(self, page_id):
"""
Export page as standard pdf exporter
:param page_id: Page ID
:return: PDF File
"""
headers = self.form_token_headers
url = "spaces/flyingpdf/pdfpageexport.action?pageId={pageId}".format(pageId=page_id)
if self.api_version == "cloud":
url = self.get_pdf_download_url_for_confluence_cloud(url)
return self.get(url, headers=headers, not_json_response=True)
def get_page_as_word(self, page_id):
"""
Export page as standard word exporter.
:param page_id: Page ID
:return: Word File
"""
headers = self.form_token_headers
url = "exportword?pageId={pageId}".format(pageId=page_id)
return self.get(url, headers=headers, not_json_response=True)
def export_page(self, page_id):
"""
Alias method for export page as pdf
:param page_id: Page ID
:return: PDF File
"""
return self.get_page_as_pdf(page_id)
def get_descendant_page_id(self, space, parent_id, title):
"""
Provide space, parent_id and title of the descendant page, it will return the descendant page_id
:param space: str
:param parent_id: int
:param title: str
:return: page_id of the page whose title is passed in argument
"""
page_id = ""
url = 'rest/api/content/search?cql=parent={}%20AND%20space="{}"'.format(parent_id, space)
try:
response = self.get(url, {})
except HTTPError as e:
if e.response.status_code == 400:
raise ApiValueError("The CQL is invalid or missing", reason=e)
raise
for each_page in response.get("results", []):
if each_page.get("title") == title:
page_id = each_page.get("id")
break
return page_id
def reindex(self):
"""
It is not public method for reindex Confluence
:return:
"""
url = "rest/prototype/1/index/reindex"
return self.post(url)
def reindex_get_status(self):
"""
Get reindex status of Confluence
:return:
"""
url = "rest/prototype/1/index/reindex"
return self.get(url)
def health_check(self):
"""
Get health status
https://confluence.atlassian.com/jirakb/how-to-retrieve-health-check-results-using-rest-api-867195158.html
:return:
"""
# check as Troubleshooting & Support Tools Plugin
response = self.get("rest/troubleshooting/1.0/check/")
if not response:
# check as support tools
response = self.get("rest/supportHealthCheck/1.0/check/")
return response
def synchrony_enable(self):
"""
Enable Synchrony
:return:
"""
headers = {"X-Atlassian-Token": "no-check"}
url = "rest/synchrony-interop/enable"
return self.post(url, headers=headers)
def synchrony_disable(self):
"""
Disable Synchrony
:return:
"""
headers = {"X-Atlassian-Token": "no-check"}
url = "rest/synchrony-interop/disable"
return self.post(url, headers=headers)
def check_access_mode(self):
return self.get("rest/api/accessmode")
def anonymous(self):
"""
Get information about the how anonymous is represented in confluence
:return:
"""
try:
response = self.get("rest/api/user/anonymous")
except HTTPError as e:
if e.response.status_code == 403:
raise ApiPermissionError(
"The calling user does not have permission to use Confluence",
reason=e,
)
raise
return response
def upload_plugin(self, plugin_path):
"""
Provide plugin path for upload into Jira e.g. useful for auto deploy
:param plugin_path:
:return:
"""
files = {"plugin": open(plugin_path, "rb")}
upm_token = self.request(
method="GET",
path="rest/plugins/1.0/",
headers=self.no_check_headers,
trailing=True,
).headers["upm-token"]
url = "rest/plugins/1.0/?token={upm_token}".format(upm_token=upm_token)
return self.post(url, files=files, headers=self.no_check_headers)
def delete_plugin(self, plugin_key):
"""
Delete plugin
:param plugin_key:
:return:
"""
url = "rest/plugins/1.0/{}-key".format(plugin_key)
return self.delete(url)
def check_long_tasks_result(self, start=None, limit=None, expand=None):
"""
Get result of long tasks
:param start: OPTIONAL: The start point of the collection to return. Default: None (0).
:param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
fixed system limits. Default: 50
:param expand:
:return:
"""
params = {}
if expand:
params["expand"] = expand
if start:
params["start"] = start
if limit:
params["limit"] = limit
return self.get("rest/api/longtask", params=params)
def check_long_task_result(self, task_id, expand=None):
"""
Get result of long tasks
:param task_id: task id
:param expand:
:return:
"""
params = None
if expand:
params = {"expand": expand}
try:
response = self.get("rest/api/longtask/{}".format(task_id), params=params)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no task with the given key, " "or the calling user does not have permission to view it",
reason=e,
)
raise
return response
def get_pdf_download_url_for_confluence_cloud(self, url):
"""
Confluence cloud does not return the PDF document when the PDF
export is initiated. Instead it starts a process in the background
and provides a link to download the PDF once the process completes.
This functions polls the long running task page and returns the
download url of the PDF.
:param url: URL to initiate PDF export
:return: Download url for PDF file
"""
download_url = None
try:
long_running_task = True
headers = self.form_token_headers
log.info("Initiate PDF export from Confluence Cloud")
response = self.get(url, headers=headers, not_json_response=True)
response_string = response.decode(encoding="utf-8", errors="strict")
task_id = response_string.split('name="ajs-taskId" content="')[1].split('">')[0]
poll_url = "runningtaskxml.action?taskId={0}".format(task_id)
while long_running_task:
long_running_task_response = self.get(poll_url, headers=headers, not_json_response=True)
long_running_task_response_parts = long_running_task_response.decode(
encoding="utf-8", errors="strict"
).split("\n")
percentage_complete = long_running_task_response_parts[6].strip()
is_successful = long_running_task_response_parts[7].strip()
is_complete = long_running_task_response_parts[8].strip()
log.info("Sleep for 5s.")
time.sleep(5)
log.info("Check if export task has completed.")
if is_complete == "<isComplete>true</isComplete>":
if is_successful == "<isSuccessful>true</isSuccessful>":
log.info(percentage_complete)
log.info("Downloading content...")
log.debug("Extract taskId and download PDF.")
current_status = long_running_task_response_parts[3]
download_url = current_status.split("href="/wiki/")[1].split(""")[0]
long_running_task = False
elif is_successful == "<isSuccessful>false</isSuccessful>":
log.error("PDF conversion not successful.")
return None
else:
log.info(percentage_complete)
except IndexError as e:
log.error(e)
return None
return download_url
def audit(self, start_date=None, end_date=None, start=None, limit=None, search_string=None):
"""
Fetch a paginated list of AuditRecord instances dating back to a certain time
:param start_date:
:param end_date:
:param start:
:param limit:
:param search_string:
:return:
"""
url = "rest/api/audit"
params = {}
if start_date:
params["startDate"] = start_date
if end_date:
params["endDate"] = end_date
if start:
params["start"] = start
if limit:
params["limit"] = limit
if search_string:
params["searchString"] = search_string
return self.get(url, params=params)
"""
##############################################################################################
# Team Calendars REST API implements (https://jira.atlassian.com/browse/CONFSERVER-51003) #
##############################################################################################
"""
def team_calendars_get_sub_calendars(self, include=None, viewing_space_key=None, calendar_context=None):
"""
Get subscribed calendars
:param include:
:param viewing_space_key:
:param calendar_context:
:return:
"""
url = "rest/calendar-services/1.0/calendar/subcalendars"
params = {}
if include:
params["include"] = include
if viewing_space_key:
params["viewingSpaceKey"] = viewing_space_key
if calendar_context:
params["calendarContext"] = calendar_context
return self.get(url, params=params)
def team_calendars_get_sub_calendars_watching_status(self, include=None):
url = "rest/calendar-services/1.0/calendar/subcalendars/watching/status"
params = {}
if include:
params["include"] = include
return self.get(url, params=params)
def team_calendar_events(self, sub_calendar_id, start, end, user_time_zone_id=None):
"""
Get calendar event status
:param sub_calendar_id:
:param start:
:param end:
:param user_time_zone_id:
:return:
"""
url = "rest/calendar-services/1.0/calendar/events"
params = {}
if sub_calendar_id:
params["subCalendarId"] = sub_calendar_id
if user_time_zone_id:
params["userTimeZoneId"] = user_time_zone_id
if start:
params["start"] = start
if end:
params["end"] = end
return self.get(url, params=params)
def get_mobile_parameters(self, username):
"""
Get mobile paramaters
:param username:
:return:
"""
url = "rest/mobile/1.0/profile/{username}".format(username=username)
return self.get(url)
def avatar_upload_for_user(self, user_key, data):
"""
:param user_key:
:param data: json like {"avatarDataURI":"image in base64"}
:return:
"""
url = "rest/user-profile/1.0/{}/avatar/upload".format(user_key)
return self.post(url, data=data)
def avatar_set_default_for_user(self, user_key):
"""
:param user_key:
:return:
"""
url = "rest/user-profile/1.0/{}/avatar/default".format(user_key)
return self.get(url)
def add_user(self, email, fullname, username, password):
"""
That method related to creating user via json rpc for Confluence Server
"""
params = {"email": email, "fullname": fullname, "name": username}
url = "rpc/json-rpc/confluenceservice-v2"
data = {"jsonrpc": "2.0", "method": "addUser", "params": [params, password]}
self.post(url, data=data)
def add_user_to_group(self, username, group_name):
"""
Add given user to a group
:param username: str
:param group_name: str
:return: Current state of the group
"""
url = "rest/api/2/group/user"
params = {"groupname": group_name}
data = {"name": username}
return self.post(url, params=params, data=data)
def add_space_permissions(self, space_key, subject_type, subject_id, operation_key, operation_target):
"""
Add permissions to a space
:param space_key: str
:param subject_type: str
:param subject_id: str
:param operation_key: str
:param operation_target: str
:return: Current permissions of space
"""
url = "rest/api/space/{}/permission".format(space_key)
data = {
"subject": {"type": subject_type, "identifier": subject_id},
"operation": {"key": operation_key, "target": operation_target},
"_links": {},
}
return self.post(url, data=data, headers=self.experimental_headers)
def get_space_permissions(self, space_key):
"""
The JSON-RPC APIs for Confluence are provided here to help you browse and discover APIs you have access to.
JSON-RPC APIs operate differently than REST APIs.
To learn more about how to use these APIs,
please refer to the Confluence JSON-RPC documentation on Atlassian Developers.
"""
if self.api_version == "cloud":
return self.get_space(space_key=space_key, expand="permissions")
url = "rpc/json-rpc/confluenceservice-v2"
data = {
"jsonrpc": "2.0",
"method": "getSpacePermissionSets",
"id": 7,
"params": [space_key],
}
return self.post(url, data=data).get("result") or {}
def get_subtree_of_content_ids(self, page_id):
"""
Get sub tree of page ids
:param page_id:
:return: Set of page ID
"""
output = list()
output.append(page_id)
children_pages = self.get_page_child_by_type(page_id)
for page in children_pages:
child_subtree = self.get_subtree_of_content_ids(page.get("id"))
if child_subtree:
output.extend([p for p in child_subtree])
return set(output)
def set_inline_tasks_checkbox(self, page_id, task_id, status):
"""
Set inline task element value
status is CHECKED or UNCHECKED
:return:
"""
url = "rest/inlinetasks/1/task/{page_id}/{task_id}/".format(page_id=page_id, task_id=task_id)
data = {"status": status, "trigger": "VIEW_PAGE"}
return self.post(url, json=data)
def get_jira_metadata(self, page_id):
"""
Get linked Jira ticket metadata
PRIVATE method
:param page_id: Page Id
:return:
"""
url = "rest/jira-metadata/1.0/metadata"
params = {"pageId": page_id}
return self.get(url, params=params)
def get_jira_metadata_aggregated(self, page_id):
"""
Get linked Jira ticket aggregated metadata
PRIVATE method
:param page_id: Page Id
:return:
"""
url = "rest/jira-metadata/1.0/metadata/aggregate"
params = {"pageId": page_id}
return self.get(url, params=params)
def clean_jira_metadata_cache(self, global_id):
"""
Clean cache for linked Jira app link
PRIVATE method
:param global_id: ID of Jira app link
:return:
"""
url = "rest/jira-metadata/1.0/metadata/cache"
params = {"globalId": global_id}
return self.delete(url, params=params)
|