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
|
#!/usr/bin/env python3
#******************************************************************************
# exports.py, provides classes for a file export dialog and export functions
#
# TreeLine, an information storage program
# Copyright (C) 2019, Douglas W. Bell
#
# This is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License, either Version 2 or any later
# version. This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY. See the included LICENSE file for details.
#******************************************************************************
import os.path
import pathlib
import re
import json
import copy
import io
import zipfile
import csv
import shutil
from xml.etree import ElementTree
from PyQt5.QtCore import Qt
from PyQt5.QtGui import QFontInfo
from PyQt5.QtWidgets import (QApplication, QButtonGroup, QCheckBox, QDialog,
QFileDialog, QGroupBox, QHBoxLayout, QLabel,
QMessageBox, QRadioButton, QSpinBox, QVBoxLayout,
QWizard, QWizardPage)
import treestructure
import treenode
import treeformats
import nodeformat
import fieldformat
import treeoutput
import treemaincontrol
import imports
import urltools
import globalref
try:
from __main__ import __version__
except ImportError:
__version__ = ''
try:
from __main__ import templatePath
except ImportError:
templatePath = None
_bookmarkTitle = _('Bookmarks')
_odfNamespace = {'fo':
'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0',
'office': 'urn:oasis:names:tc:opendocument:xmlns:office:1.0',
'style': 'urn:oasis:names:tc:opendocument:xmlns:style:1.0',
'svg':
'urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0',
'text': 'urn:oasis:names:tc:opendocument:xmlns:text:1.0',
'manifest':
'urn:oasis:names:tc:opendocument:xmlns:manifest:1.0'}
_intLinkRe = re.compile(r'<a [^>]*href="#(.*?)"[^>]*>.*?</a>', re.I | re.S)
_genLinkRe = re.compile(r'<a [^>]*href="(.*?)"[^>]*>.*?</a>', re.I | re.S)
_imgLinkRe = re.compile(r'<img [^>]*src="(.*?)"[^>]*>.*?</img>', re.I | re.S)
_idReplaceCharsRe = re.compile(r'[^a-zA-Z0-9_-]+')
class ExportControl:
"""Control to do file exports for tree branches and nodes.
"""
def __init__(self, structure, selectionModel, defaultPathObj, printData):
"""Initialize export control object.
Arguments:
structure -- the tree structure ref for exporting the entire tree
selectionModel -- the selection model for partial exports
defaultPathObj -- path object to use as file dialog default
printData -- a ref to print data for old treeline exports
"""
self.structure = structure
self.selectedSpots = selectionModel.selectedSpots()
self.selectedNodes = selectionModel.selectedNodes()
self.defaultPathObj = defaultPathObj
self.printData = printData
def interactiveExport(self):
"""Prompt the user for types, options, filename & proceed with export.
Return True if export is successful.
"""
exportMethods = {'htmlSingle': self.exportHtmlSingle,
'htmlNavSingle': self.exportHtmlNavSingle,
'htmlPages': self.exportHtmlPages,
'htmlTables': self.exportHtmlTables,
'htmlLiveLink': self.exportHtmlLiveLink,
'htmlLiveSingle': self.exportHtmlLiveSingle,
'textTitles': self.exportTextTitles,
'textPlain': self.exportTextPlain,
'textTableMultiCsv': self.exportTextTableMultiCsv,
'textTableCsv': self.exportTextTableCsv,
'textTableTab': self.exportTextTableTab,
'oldTreeLine': self.exportOldTreeLine,
'treeLineSubtree': self.exportSubtree,
'xmlGeneric': self.exportXmlGeneric,
'odfText': self.exportOdfText,
'bookmarksHtml': self.exportBookmarksHtml,
'bookmarksXbel': self.exportBookmarksXbel}
exportDialog = ExportDialog(len(self.selectedNodes),
QApplication.activeWindow())
if exportDialog.exec_() == QDialog.Accepted:
result = exportMethods[ExportDialog.currentSubtype]()
QApplication.restoreOverrideCursor()
return result
return False
def getFileName(self, dialogTitle, defaultExt='txt'):
"""Prompt the user for a filename and return a path object.
Arguments:
dialogTitle -- the title for use on the dialog window
defaultExt -- the default file extension from globalref
"""
filters = ';;'.join((globalref.fileFilters[defaultExt],
globalref.fileFilters['all']))
defaultExt = defaultExt[:4]
if self.defaultPathObj.is_file():
self.defaultPathObj = self.defaultPathObj.with_suffix('.' +
defaultExt)
filePath, selectFilter = QFileDialog.getSaveFileName(QApplication.
activeWindow(),
dialogTitle,
str(self.defaultPathObj),
filters)
if filePath:
pathObj = pathlib.Path(filePath)
if not pathObj.suffix:
pathObj = pathObj.with_suffix('.' + defaultExt)
return pathObj
return None
def exportHtmlSingle(self, pathObj=None):
"""Export to a single web page, use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export HTML'), 'html')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
if ExportDialog.exportWhat == ExportDialog.entireTree:
self.selectedSpots = self.structure.rootSpots()
outputGroup = treeoutput.OutputGroup(self.selectedSpots,
ExportDialog.includeRoot,
ExportDialog.exportWhat !=
ExportDialog.selectNode,
ExportDialog.openOnly)
outputGroup.addAnchors()
if outputGroup.hasPrefixes():
outputGroup.combineAllSiblings()
outputGroup.addBlanksBetween()
outputGroup.addIndents()
outGroups = outputGroup.splitColumns(ExportDialog.numColumns)
htmlTitle = pathObj.stem
indent = globalref.genOptions['IndentOffset']
lines = ['<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 '
'Transitional//EN">', '<html>', '<head>',
'<meta http-equiv="Content-Type" content="text/html; '
'charset=utf-8">', '<title>{0}</title>'.format(htmlTitle),
'<style type="text/css"><!--',
'div {{margin-left: {0}em}}'.format(indent),
'td {padding: 10px}', 'tr {vertical-align: top}',
'--></style>', '</head>', '<body>']
if ExportDialog.addHeader:
headerText = (globalref.mainControl.activeControl.printData.
formatHeaderFooter(True))
if headerText:
lines.append(headerText)
lines.extend(['<table>', '<tr><td>'])
lines.extend(outGroups[0].getLines())
for group in outGroups[1:]:
lines.append('</td><td>')
lines.extend(group.getLines())
lines.extend(['</td></tr>', '</table>'])
if ExportDialog.addHeader:
footerText = (globalref.mainControl.activeControl.printData.
formatHeaderFooter(False))
if footerText:
lines.append(footerText)
lines.extend(['</body>', '</html>'])
with pathObj.open('w', encoding='utf-8') as f:
f.writelines([(line + '\n') for line in lines])
return True
def exportHtmlNavSingle(self, pathObj=None):
"""Export single web page with a navigation pane, ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export HTML'), 'html')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
if ExportDialog.exportWhat == ExportDialog.entireTree:
self.selectedSpots = self.structure.rootSpots()
outputGroup = treeoutput.OutputGroup(self.selectedSpots,
ExportDialog.includeRoot,
True, ExportDialog.openOnly)
outputGroup.addAnchors(ExportDialog.navPaneLevels)
if outputGroup.hasPrefixes():
outputGroup.combineAllSiblings()
outputGroup.addBlanksBetween()
outputGroup.addIndents()
htmlTitle = pathObj.stem
indent = globalref.genOptions['IndentOffset']
lines = ['<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 '
'Transitional//EN">', '<html>', '<head>',
'<meta http-equiv="Content-Type" content="text/html; '
'charset=utf-8">', '<title>{0}</title>'.format(htmlTitle),
'<style type="text/css"><!--',
' #sidebar {',
' width: 16em;',
' float: left;',
' border-right: 1px solid black;',
' }',
' #sidebar div {{margin-left: {0}em;}}'.format(indent),
' #content {',
' margin-left: 16em;',
' border-left: 1px solid black;',
' padding-left: 6px;',
' }',
' #content div {{margin-left: {0}em;}}'.format(indent),
'--></style>',
'</head>', '<body>', '<div id="sidebar">']
prevLevel = 0
treeView = globalref.mainControl.activeControl.activeWindow.treeView
for parentSpot in self.selectedSpots:
for spot, level in parentSpot.levelSpotDescendantGen(treeView,
ExportDialog.
includeRoot,
ExportDialog.
navPaneLevels,
ExportDialog.
openOnly):
if level > prevLevel:
lines.append('<div>')
while level < prevLevel:
lines.append('</div>')
prevLevel -= 1
node = spot.nodeRef
lines.append('• <a href="#{0}">{1}</a><br />'.
format(node.uId, node.title(spot)))
prevLevel = level
while level > 0:
lines.append('</div>')
level -= 1
lines.extend(['</div>', '<div id="content">'])
if ExportDialog.addHeader:
headerText = (globalref.mainControl.activeControl.printData.
formatHeaderFooter(True))
if headerText:
lines.append(headerText)
lines.extend(outputGroup.getLines())
if ExportDialog.addHeader:
footerText = (globalref.mainControl.activeControl.printData.
formatHeaderFooter(False))
if footerText:
lines.append(footerText)
lines.extend(['</div>', '</body>', '</html>'])
with pathObj.open('w', encoding='utf-8') as f:
f.writelines([(line + '\n') for line in lines])
return True
def exportHtmlPages(self, pathObj=None):
"""Export multiple web pages with navigation, use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
path = QFileDialog.getExistingDirectory(QApplication.
activeWindow(),
_('TreeLine - Export HTML'),
str(self.defaultPathObj))
if not path:
return False
pathObj = pathlib.Path(path)
QApplication.setOverrideCursor(Qt.WaitCursor)
oldDir = os.getcwd()
os.chdir(str(pathObj))
indent = globalref.genOptions['IndentOffset']
cssLines = ['#sidebar {',
' width: 16em;',
' float: left;',
' border-right: 1px solid black;',
'}',
'#sidebar div {{margin-left: {0}em;}}'.format(indent),
'#content {',
' margin-left: 16em;',
' border-left: 1px solid black;',
' padding-left: 6px;',
'}']
with open('default.css', 'w', encoding='utf-8') as f:
f.writelines([(line + '\n') for line in cssLines])
if ExportDialog.exportWhat != ExportDialog.entireTree:
self.structure = treestructure.TreeStructure(topNodes=self.
selectedNodes,
addSpots=False)
if len(self.structure.childList) > 1:
self.structure = treestructure.TreeStructure(topNodes=self.
structure.childList,
addSpots=False)
rootType = nodeformat.NodeFormat(treeformats.defaultTypeName,
self.structure.treeFormats,
addDefaultField=True)
self.structure.treeFormats.addTypeIfMissing(rootType)
root = treenode.TreeNode(self.structure.
treeFormats[treeformats.defaultTypeName])
root.setTitle(treestructure.defaultRootTitle)
self.structure.addNodeDictRef(root)
root.childList = self.structure.childList
self.structure.childList = [root]
pathDict = {}
_setHtmlDirectories(self.structure.childList[0], pathDict, pathObj,
set())
_writeHtmlPage(self.structure.childList[0], None, None, pathDict)
os.chdir(oldDir)
return True
def exportHtmlTables(self, pathObj=None):
"""Export to multiple web page tables, use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
path = QFileDialog.getExistingDirectory(QApplication.
activeWindow(),
_('TreeLine - Export HTML'),
str(self.defaultPathObj))
if not path:
return False
pathObj = pathlib.Path(path)
QApplication.setOverrideCursor(Qt.WaitCursor)
oldDir = os.getcwd()
os.chdir(str(pathObj))
if ExportDialog.exportWhat != ExportDialog.entireTree:
self.structure = treestructure.TreeStructure(topNodes=self.
selectedNodes,
addSpots=False)
if len(self.structure.childList) > 1:
self.structure = treestructure.TreeStructure(topNodes=self.
structure.childList,
addSpots=False)
rootType = nodeformat.NodeFormat(treeformats.defaultTypeName,
self.structure.treeFormats,
addDefaultField=True)
self.structure.treeFormats.addTypeIfMissing(rootType)
root = treenode.TreeNode(self.structure.
treeFormats[treeformats.defaultTypeName])
name = self.defaultPathObj.stem
if not name:
name = treestructure.defaultRootTitle
root.setTitle(name)
self.structure.addNodeDictRef(root)
root.childList = self.structure.childList
self.structure.childList = [root]
pathDict = {}
_setHtmlDirectories(self.structure.childList[0], pathDict, pathObj,
set(), False)
_writeHtmlTable(self.structure.childList[0], None, pathDict)
os.chdir(oldDir)
return True
def exportHtmlLiveLink(self, pathObj=None):
"""Export a live tree view, linked back to the source file.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
path = QFileDialog.getExistingDirectory(QApplication.
activeWindow(),
_('TreeLine - Export HTML'),
str(self.defaultPathObj))
if not path:
return False
pathObj = pathlib.Path(path)
QApplication.setOverrideCursor(Qt.WaitCursor)
control = globalref.mainControl
prefPath = templatePath + '/exports' if templatePath else ''
htmlPath = control.findResourceFile('live_tree_export.html',
'templates/exports', prefPath)
jsPath = control.findResourceFile('live_tree_export.js',
'templates/exports', prefPath)
cssPath = control.findResourceFile('live_tree_export.css',
'templates/exports', prefPath)
if not htmlPath or not jsPath or not cssPath:
QApplication.restoreOverrideCursor()
QMessageBox.warning(QApplication.activeWindow(), 'TreeLine',
_('Error - export template files not found.\n'
'Check your TreeLine installation.'))
return False
refPath = globalref.mainControl.activeControl.filePathObj
if not refPath:
QApplication.restoreOverrideCursor()
QMessageBox.warning(QApplication.activeWindow(), 'TreeLine',
_('Error - cannot link to unsaved TreeLine '
'file.\nSave the file and retry.'))
return False
try:
refPath = pathlib.Path(os.path.relpath(str(refPath), str(pathObj)))
except ValueError:
QApplication.restoreOverrideCursor()
msg = _('Warning - no relative path from "{0}" to "{1}".\n'
'Continue with absolute path?').format(pathObj.as_posix(),
refPath.as_posix())
ans = QMessageBox.warning(QApplication.activeWindow(), 'TreeLine',
msg, QMessageBox.Yes | QMessageBox.No,
QMessageBox.Yes)
if ans == QMessageBox.No:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
fileStem = refPath.stem
outPath = pathObj / (fileStem + '.html')
with htmlPath.open(encoding='utf-8') as fileIn:
with outPath.open('w', encoding='utf-8') as fileOut:
for line in fileIn:
if '<title>' in line:
line = re.sub(r'<title>.*</title>',
'<title>{0}</title>'.format(fileStem),
line)
elif 'dataFilePath' in line:
line = line.replace('""', '"{0}"'.
format(refPath.parent.as_posix()))
elif 'dataFileName' in line:
line = line.replace('""', '"{0}"'.format(refPath.name))
fileOut.write(line)
shutil.copy(str(jsPath), str(pathObj))
shutil.copy(str(cssPath), str(pathObj))
return True
def exportHtmlLiveSingle(self, pathObj=None):
"""Export a live tree view to a single file (embedded data).
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export HTML'), 'html')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
control = globalref.mainControl
prefPath = templatePath + '/exports' if templatePath else ''
htmlPath = control.findResourceFile('live_tree_export.html',
'templates/exports', prefPath)
jsPath = control.findResourceFile('live_tree_export.js',
'templates/exports', prefPath)
cssPath = control.findResourceFile('live_tree_export.css',
'templates/exports', prefPath)
if not htmlPath or not jsPath or not cssPath:
QApplication.restoreOverrideCursor()
QMessageBox.warning(QApplication.activeWindow(), 'TreeLine',
_('Error - export template files not found.\n'
'Check your TreeLine installation.'))
return False
if ExportDialog.exportWhat == ExportDialog.entireTree:
fileData = self.structure.fileData()
else:
self.structure = treestructure.TreeStructure(topNodes=self.
selectedNodes,
addSpots=False)
fileData = self.structure.fileData()
if ExportDialog.exportWhat == ExportDialog.selectNode:
topNodeIds = set([node.uId for node in
self.structure.childList])
nodeData = [data for data in fileData['nodes'] if data['uid']
in topNodeIds]
for data in nodeData:
data['children'] = []
fileData['nodes'] = nodeData
with htmlPath.open(encoding='utf-8') as htmlIn:
with pathObj.open('w', encoding='utf-8') as htmlOut:
for line in htmlIn:
if 'stylesheet' in line:
htmlOut.write('<style>\n')
with cssPath.open(encoding='utf-8') as cssIn:
for cssLine in cssIn:
if not cssLine.startswith('/*'):
htmlOut.write(cssLine)
htmlOut.write('</style>')
elif '<title>' in line:
line = re.sub(r'<title>.*</title>',
'<title>{0}</title>'.
format(pathObj.stem), line)
htmlOut.write(line)
elif 'application/json' in line:
htmlOut.write(line)
json.dump(fileData, htmlOut, indent=2, sort_keys=True)
elif 'dataFileName' in line:
htmlOut.write(line)
with jsPath.open(encoding='utf-8') as jsIn:
htmlOut.write(jsIn.read())
elif 'script src=' not in line:
htmlOut.write(line)
return True
def exportTextTitles(self, pathObj=None):
"""Export tabbed title text, use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export Text Titles'),
'txt')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
if ExportDialog.exportWhat == ExportDialog.entireTree:
self.selectedSpots = self.structure.rootSpots()
if ExportDialog.exportWhat == ExportDialog.selectNode:
lines = [spot.nodeRef.title(spot) for spot in self.selectedSpots]
else:
treeView = (globalref.mainControl.activeControl.activeWindow.
treeView)
lines = []
for rootSpot in self.selectedSpots:
for spot, level in rootSpot.levelSpotDescendantGen(treeView,
ExportDialog.includeRoot,
None, ExportDialog.openOnly):
lines.append('\t' * level + spot.nodeRef.title(spot))
try:
with pathObj.open('w', encoding=globalref.localTextEncoding) as f:
f.writelines([(line + '\n') for line in lines])
except UnicodeEncodeError:
with pathObj.open('w', encoding='utf-8') as f:
f.writelines([(line + '\n') for line in lines])
return True
def exportTextPlain(self, pathObj=None):
"""Export unformatted text for all output, use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export Plain Text'),
'txt')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
if ExportDialog.exportWhat == ExportDialog.entireTree:
self.selectedSpots = self.structure.rootSpots()
lines = []
if ExportDialog.exportWhat == ExportDialog.selectNode:
for rootSpot in self.selectedSpots:
lines.extend(rootSpot.nodeRef.output(True, False, rootSpot))
if rootSpot.nodeRef.formatRef.spaceBetween:
lines.append('')
else:
treeView = (globalref.mainControl.activeControl.activeWindow.
treeView)
for rootSpot in self.selectedSpots:
for spot, level in rootSpot.levelSpotDescendantGen(treeView,
ExportDialog.includeRoot,
None, ExportDialog.openOnly):
lines.extend(spot.nodeRef.output(True, False, spot))
if spot.nodeRef.formatRef.spaceBetween:
lines.append('')
try:
with pathObj.open('w', encoding=globalref.localTextEncoding) as f:
f.writelines([(line + '\n') for line in lines])
except UnicodeEncodeError:
with pathObj.open('w', encoding='utf-8') as f:
f.writelines([(line + '\n') for line in lines])
return True
def exportTextTableMultiCsv(self, pathObj=None):
"""Export descendant CSV delimited text table with level numbers.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export Text Tables'),
'csv')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
if ExportDialog.exportWhat == ExportDialog.entireTree:
self.selectedSpots = self.structure.rootSpots()
treeView = (globalref.mainControl.activeControl.activeWindow.treeView)
types = set()
headings = []
for rootSpot in self.selectedSpots:
for spot, level in rootSpot.levelSpotDescendantGen(treeView,
ExportDialog.includeRoot,
None, ExportDialog.openOnly):
nodeFormat = spot.nodeRef.formatRef
if nodeFormat not in types:
for fieldName in nodeFormat.fieldNames():
if fieldName not in headings:
headings.append(fieldName)
types.add(nodeFormat)
lines = [['Level'] + headings]
for rootSpot in self.selectedSpots:
for spot, level in rootSpot.levelSpotDescendantGen(treeView,
ExportDialog.includeRoot,
None, ExportDialog.openOnly):
newLine = [spot.nodeRef.data.get(head, '') for head in
headings]
lines.append([repr(level)] + newLine)
try:
with pathObj.open('w', newline='',
encoding=globalref.localTextEncoding) as f:
writer = csv.writer(f)
writer.writerows(lines)
except UnicodeEncodeError:
with pathObj.open('w', newline='', encoding='utf-8') as f:
writer = csv.writer(f)
writer.writerows(lines)
return True
def exportTextTableCsv(self, pathObj=None):
"""Export child CSV delimited text table, use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export Text Tables'),
'csv')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
if ExportDialog.exportWhat == ExportDialog.selectNode:
nodeList = self.selectedNodes
else:
nodeList = []
for node in self.selectedNodes:
nodeList.extend(node.childList)
types = set()
headings = []
for node in nodeList:
nodeFormat = node.formatRef
if nodeFormat not in types:
for fieldName in nodeFormat.fieldNames():
if fieldName not in headings:
headings.append(fieldName)
types.add(nodeFormat)
lines = [headings]
for node in nodeList:
lines.append([node.data.get(head, '') for head in headings])
try:
with pathObj.open('w', newline='',
encoding=globalref.localTextEncoding) as f:
writer = csv.writer(f)
writer.writerows(lines)
except UnicodeEncodeError:
with pathObj.open('w', newline='', encoding='utf-8') as f:
writer = csv.writer(f)
writer.writerows(lines)
return True
def exportTextTableTab(self, pathObj=None):
"""Export child tab delimited text table, use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export Text Tables'),
'txt')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
if ExportDialog.exportWhat == ExportDialog.selectNode:
nodeList = self.selectedNodes
else:
nodeList = []
for node in self.selectedNodes:
nodeList.extend(node.childList)
types = set()
headings = []
for node in nodeList:
nodeFormat = node.formatRef
if nodeFormat not in types:
for fieldName in nodeFormat.fieldNames():
if fieldName not in headings:
headings.append(fieldName)
types.add(nodeFormat)
lines = ['\t'.join(headings)]
for node in nodeList:
lines.append('\t'.join([node.data.get(head, '') for head in
headings]))
try:
with pathObj.open('w', encoding=globalref.localTextEncoding) as f:
f.writelines([(line + '\n') for line in lines])
except UnicodeEncodeError:
with pathObj.open('w', encoding='utf-8') as f:
f.writelines([(line + '\n') for line in lines])
return True
def exportOldTreeLine(self, pathObj=None):
"""Export old TreeLine version (2.0.x), use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export TreeLine Subtree'),
'trl')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
if ExportDialog.exportWhat != ExportDialog.entireTree:
self.structure = treestructure.TreeStructure(topNodes=self.
selectedNodes,
addSpots=False)
addDescend = ExportDialog.exportWhat != ExportDialog.selectNode
addChildren = addDescend
if len(self.structure.childList) > 1:
if not addDescend:
addChildren = True
self.structure = treestructure.TreeStructure(topNodes=self.
structure.childList,
addSpots=False)
rootType = nodeformat.NodeFormat(treeformats.defaultTypeName,
self.structure.treeFormats,
addDefaultField=True)
self.structure.treeFormats.addTypeIfMissing(rootType)
root = treenode.TreeNode(self.structure.
treeFormats[treeformats.defaultTypeName])
root.setTitle(treestructure.defaultRootTitle)
self.structure.addNodeDictRef(root)
root.childList = self.structure.childList
self.structure.childList = [root]
idDict = {}
for node in self.structure.childList[0].descendantGen():
_setOldUniqueId(idDict, node)
idDict = {i[1]: i[0] for i in idDict.items()} # reverse (new id keys)
rootElement = _oldElementXml(self.structure.childList[0],
self.structure, idDict,
addChildren=addChildren,
addDescend=addDescend)
if __version__:
rootElement.set('tlversion', __version__)
rootElement.attrib.update(_convertOldPrintData(self.printData.
fileData()))
elementTree = ElementTree.ElementTree(rootElement)
elementTree.write(str(pathObj), 'utf-8', True)
return True
def exportSubtree(self, pathObj=None):
"""Export TreeLine subtree, use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export TreeLine Subtree'),
'trlnsave')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
self.structure = treestructure.TreeStructure(topNodes=self.
selectedNodes,
addSpots=False)
fileData = self.structure.fileData()
fileData['properties'].update(self.printData.fileData())
if ExportDialog.exportWhat == ExportDialog.selectNode:
topNodeIds = set([node.uId for node in self.structure.childList])
nodeData = [data for data in fileData['nodes'] if data['uid'] in
topNodeIds]
for data in nodeData:
data['children'] = []
fileData['nodes'] = nodeData
indent = 3 if globalref.genOptions['PrettyPrint'] else 0
with pathObj.open('w', encoding='utf-8', newline='\n') as f:
json.dump(fileData, f, indent=indent, sort_keys=True)
return True
def exportXmlGeneric(self, pathObj=None):
"""Export generic XML, use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export Generic XML'),
'xml')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
if ExportDialog.exportWhat == ExportDialog.entireTree:
self.selectedNodes = self.structure.childList
addBranches = ExportDialog.exportWhat != ExportDialog.selectNode
if len(self.selectedNodes) > 1:
rootElement = ElementTree.Element(treeformats.defaultTypeName)
for node in self.selectedNodes:
rootElement.append(_createGenericXml(node, addBranches))
else:
rootElement = _createGenericXml(self.selectedNodes[0], addBranches)
elementTree = ElementTree.ElementTree(rootElement)
elementTree.write(str(pathObj), 'utf-8', True)
return True
def exportOdfText(self, pathObj=None):
"""Export an ODF text file, use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export ODF Text'), 'odt')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
if ExportDialog.exportWhat == ExportDialog.entireTree:
self.selectedSpots = self.structure.rootSpots()
addBranches = ExportDialog.exportWhat != ExportDialog.selectNode
for prefix, uri in _odfNamespace.items():
ElementTree.register_namespace(prefix, uri)
versionAttr = {'office:version': '1.0'}
fontInfo = QFontInfo(globalref.mainControl.activeControl.
activeWindow.editorSplitter.widget(0).
font())
fontAttr = {'style:font-pitch':
'fixed' if fontInfo.fixedPitch() else 'variable',
'style:name': fontInfo.family(),
'svg:font-family': fontInfo.family()}
fontElem = _addOdfElement('office:font-face-decls')
_addOdfElement('style:font-face', fontElem, fontAttr)
fontSizeDelta = 2
contentRoot = _addOdfElement('office:document-content',
attr=versionAttr)
contentRoot.append(fontElem)
contentBodyElem = _addOdfElement('office:body', contentRoot)
contentTextElem = _addOdfElement('office:text', contentBodyElem)
maxLevel = 0
for spot in self.selectedSpots:
level = _addOdfText(spot, contentTextElem, addBranches)
maxLevel = max(level, maxLevel)
manifestRoot = _addOdfElement('manifest:manifest')
_addOdfElement('manifest:file-entry', manifestRoot,
{'manifest:media-type':
'application/vnd.oasis.opendocument.text',
'manifest:full-path': '/'})
_addOdfElement('manifest:file-entry', manifestRoot,
{'manifest:media-type': 'text/xml',
'manifest:full-path': 'content.xml'})
_addOdfElement('manifest:file-entry', manifestRoot,
{'manifest:media-type': 'text/xml',
'manifest:full-path': 'styles.xml'})
styleRoot = _addOdfElement('office:document-styles', attr=versionAttr)
styleRoot.append(fontElem)
stylesElem = _addOdfElement('office:styles', styleRoot)
defaultStyleElem = _addOdfElement('style:default-style', stylesElem,
{'style:family': 'paragraph'})
_addOdfElement('style:paragraph-properties', defaultStyleElem,
{'style:writing-mode': 'page'})
_addOdfElement('style:text-properties', defaultStyleElem,
{'fo:font-size': '{0}pt'.format(fontInfo.pointSize()),
'fo:hyphenate': 'false',
'style:font-name': fontInfo.family()})
_addOdfElement('style:style', stylesElem,
{'style:name': 'Standard', 'style:class': 'text',
'style:family': 'paragraph'})
bodyStyleElem = _addOdfElement('style:style', stylesElem,
{'style:name': 'Text_20_body',
'style:display-name': 'Text body',
'style:class': 'text',
'style:family': 'paragraph',
'style:parent-style-name': 'Standard'})
_addOdfElement('style:paragraph-properties', bodyStyleElem,
{'fo:margin-bottom': '6.0pt'})
headStyleElem = _addOdfElement('style:style', stylesElem,
{'style:name': 'Heading',
'style:class': 'text',
'style:family': 'paragraph',
'style:next-style-name':
'Text_20_body',
'style:parent-style-name': 'Standard'})
_addOdfElement('style:paragraph-properties', headStyleElem,
{'fo:keep-with-next': 'always',
'fo:margin-bottom': '6.0pt',
'fo:margin-top': '12.0pt'})
_addOdfElement('style:text-properties', headStyleElem,
{'fo:font-size':
'{0}pt'.format(fontInfo.pointSize() + fontSizeDelta),
'style:font-name': fontInfo.family()})
outlineStyleElem = _addOdfElement('text:outline-style')
for level in range(1, maxLevel + 1):
size = fontInfo.pointSize()
if level <= 2:
size += 2 * fontSizeDelta
elif level <= 4:
size += fontSizeDelta
levelStyleElem = _addOdfElement('style:style', stylesElem,
{'style:name':
'Heading_20_{0}'.format(level),
'style:display-name':
'Heading {0}'.format(level),
'style:class': 'text',
'style:family': 'paragraph',
'style:parent-style-name':
'Heading',
'style:default-outline-level':
'{0}'.format(level)})
levelTextElem = _addOdfElement('style:text-properties',
levelStyleElem,
{'fo:font-size':
'{0}pt'.format(size),
'fo:font-weight': 'bold'})
if level % 2 == 0:
levelTextElem.set('fo:font-style', 'italic')
_addOdfElement('text:outline-level-style', outlineStyleElem,
{'text:level': '{0}'.format(level),
'style:num-format': ''})
stylesElem.append(outlineStyleElem)
autoStyleElem = _addOdfElement('office:automatic-styles', styleRoot)
pageLayElem = _addOdfElement('style:page-layout', autoStyleElem,
{'style:name': 'pm1'})
_addOdfElement('style:page-layout-properties', pageLayElem,
{'fo:margin-bottom': '0.75in',
'fo:margin-left': '0.75in',
'fo:margin-right': '0.75in', 'fo:margin-top': '0.75in',
'fo:page-height': '11in', 'fo:page-width': '8.5in',
'style:print-orientation': 'portrait'})
masterStyleElem = _addOdfElement('office:master-styles', styleRoot)
_addOdfElement('style:master-page', masterStyleElem,
{'style:name': 'Standard',
'style:page-layout-name': 'pm1'})
with zipfile.ZipFile(str(pathObj), 'w',
zipfile.ZIP_DEFLATED) as odfZip:
_addElemToZip(odfZip, contentRoot, 'content.xml')
_addElemToZip(odfZip, manifestRoot, 'META-INF/manifest.xml')
_addElemToZip(odfZip, styleRoot, 'styles.xml')
return True
def exportBookmarksHtml(self, pathObj=None):
"""Export HTML format bookmarks, use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export HTML Bookmarks'),
'html')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
if ExportDialog.exportWhat == ExportDialog.entireTree:
self.selectedNodes = self.structure.childList
addBranches = ExportDialog.exportWhat != ExportDialog.selectNode
title = _bookmarkTitle
if len(self.selectedNodes) == 1 and addBranches:
title = self.selectedNodes[0].title()
self.selectedNodes = self.selectedNodes[0].childList
lines = ['<!DOCTYPE NETSCAPE-Bookmark-file-1>',
'<meta http-equiv="Content-Type" content="text/html; '
'charset=utf-8">', '<title>{0}</title>'.format(title),
'<h1>{0}</h1>'.format(title)]
for node in self.selectedNodes:
lines.extend(_exportHtmlBookmarks(node, addBranches))
with pathObj.open('w', encoding='utf-8') as f:
f.writelines([(line + '\n') for line in lines])
return True
def exportBookmarksXbel(self, pathObj=None):
"""Export XBEL format bookmarks, use ExportDialog options.
Prompt user for path if not given in argument.
Return True on successful export.
Arguments:
pathObj -- use if given, otherwise prompt user
"""
if not pathObj:
pathObj = self.getFileName(_('TreeLine - Export XBEL Bookmarks'),
'xml')
if not pathObj:
return False
QApplication.setOverrideCursor(Qt.WaitCursor)
if ExportDialog.exportWhat == ExportDialog.entireTree:
self.selectedNodes = self.structure.childList
addBranches = ExportDialog.exportWhat != ExportDialog.selectNode
title = _bookmarkTitle
if len(self.selectedNodes) == 1 and addBranches:
title = self.selectedNodes[0].title()
self.selectedNodes = self.selectedNodes[0].childList
rootElem = ElementTree.Element('xbel')
titleElem = ElementTree.Element('title')
titleElem.text = title
rootElem.append(titleElem)
for node in self.selectedNodes:
rootElem.append(_exportXbel(node, addBranches))
elementTree = ElementTree.ElementTree(rootElem)
with pathObj.open('wb') as f:
f.write(b'<!DOCTYPE xbel>\n')
elementTree.write(f, 'utf-8', False)
return True
def _setHtmlDirectories(node, pathDict, parentPath, siblingNames,
addSuffix=True):
"""Recursively create path obj for node and add to the path dict by uId.
Arguments:
node -- the node to create a path object for
pathDict -- the dict of paths by uId for adding an entry
parentPath -- the path of the parent node
siblingNames -- set of already used sibling names
addSuffix -- add '.html' suffix to file names if True
"""
name = node.title()
maxLength = 32
if len(name) > maxLength:
pos = name.rfind(' ', maxLength // 2, maxLength + 1)
if pos < 0:
pos = maxLength
name = name[:pos]
name = name.replace(' ', '_')
name = _idReplaceCharsRe.sub('', name)
if not name:
name = 'id'
elif not 'a' <= name.lower() <= 'z':
name = 'id_' + name
origName = name
i = 1
while name in siblingNames:
name = origName + '_' + repr(i)
i += 1
siblingNames.add(name)
pathObj = parentPath / name
filePathObj = pathObj.with_suffix('.html') if addSuffix else pathObj
pathDict[node.uId] = filePathObj
siblings = set()
for child in node.childList:
_setHtmlDirectories(child, pathDict, pathObj, siblings, addSuffix)
def _writeHtmlPage(node, parent, grandparent, pathDict, level=0):
"""Write web pages with navigation for this node and descendents.
Arguments:
node -- the node to write the page for
parent -- the parent node (or None)
grandparent -- the grandparent node (or None)
pathDict -- the dict of paths by uId
level -- indicates the depth and how far up the css file is
"""
lines = ['<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">',
'<html>', '<head>',
'<meta http-equiv="Content-Type" content="text/html; '
'charset=utf-8">',
'<link rel="stylesheet" type="text/css" '
'href="{0}default.css" />'.format('../' * level),
'<title>{0}</title>'.format(node.title()),
'</head>', '<body>', '<div id="sidebar">']
nodeDir = str(pathDict[node.uId].parent)
uncleList = grandparent.childList if level > 1 else [parent]
for uncle in uncleList:
if uncle:
relPath = os.path.relpath(str(pathDict[uncle.uId]), nodeDir)
lines.append('• <a href="{0}">{1}</a><br />'.
format(relPath, uncle.title()))
if uncle is parent:
siblingList = parent.childList if level > 0 else [node]
if siblingList:
lines.append('<div>')
for sibling in siblingList:
if sibling is node:
lines.append('• <b>{0}</b><br />'.
format(node.title()))
if node.childList:
lines.append('<div>')
for child in node.childList:
relPath = os.path.relpath(str(pathDict[child.
uId]),
nodeDir)
lines.append('• <a href="{0}">{1}</a>'
'<br />'.
format(relPath, child.title()))
lines.append('</div>')
else:
relPath = os.path.relpath(str(pathDict[sibling.uId]),
nodeDir)
lines.append('• <a href="{0}">{1}</a><br />'.
format(relPath, sibling.title()))
lines.append('</div>')
lines.extend(['</div>', '<div id="content">'])
outputLines = [line + '<br />' for line in node.output()]
if node.formatRef.siblingPrefix:
outputLines[0] = node.formatRef.siblingPrefix + outputLines[0]
if node.formatRef.siblingSuffix:
outputLines[-1] += node.formatRef.siblingSuffix
for i in range(len(outputLines)):
startPos = 0
while True:
match = _genLinkRe.search(outputLines[i], startPos)
if not match:
break
addr = match.group(1)
if addr.startswith('#'):
pathObj = pathDict.get(addr[1:], None)
if pathObj:
relPath = os.path.relpath(str(pathObj), nodeDir)
outputLines[i] = (outputLines[i][:match.start(1)] +
relPath + outputLines[i][match.end(1):])
elif urltools.isRelative(addr):
outputLines[i] = (outputLines[i][:match.start(1)] +
'../' * level + addr +
outputLines[i][match.end(1):])
startPos = match.start(1)
startPos = 0
while True:
match = _imgLinkRe.search(outputLines[i], startPos)
if not match:
break
addr = match.group(1)
if not addr.startswith('#') and urltools.isRelative(addr):
outputLines[i] = (outputLines[i][:match.start(1)] +
'../' * level + addr +
outputLines[i][match.end(1):])
startPos = match.start(1)
lines.extend(outputLines)
lines.extend(['</div>', '</body>', '</html>'])
with pathDict[node.uId].open('w', encoding='utf-8') as f:
f.writelines([(line + '\n') for line in lines])
if node.childList:
dirObj = pathDict[node.uId].with_suffix('')
if not dirObj.is_dir():
dirObj.mkdir(0o755)
os.chdir(str(dirObj))
for child in node.childList:
_writeHtmlPage(child, node, parent, pathDict, level + 1)
os.chdir('..')
def _writeHtmlTable(node, parent, pathDict, level=1):
"""Write web pages with tables for child data to nested directories.
Arguments:
node -- the node to write the page for
parent -- the parent node (or None)
pathDict -- the dict of paths by uId
level -- the depth and how far up local links should point
"""
if not node.childList:
return
dirObj = pathDict[node.uId]
if not dirObj.is_dir():
dirObj.mkdir(0o755)
os.chdir(str(dirObj))
title = node.title()
lines = ['<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">',
'<html>', '<head>',
'<meta http-equiv="Content-Type" content="text/html; '
'charset=utf-8">', '<title>{0}</title>'.format(title),
'</head>', '<body>']
if ExportDialog.addHeader:
headerText = (globalref.mainControl.activeControl.printData.
formatHeaderFooter(True))
if headerText:
lines.append(headerText)
lines.append('<h1 align="center">{0}</h1>'.format(title))
if parent:
lines.append('<p align="center">{0}: <a href="../index.html">{1}'
'</a></p>'.format(_('Parent'), parent.title()))
lines.extend(['<table cellpadding="10">', '<tr>'])
lines.extend(['<th><u>{0}</u></th>'.format(name) for name in
node.childList[0].formatRef.fieldNames()])
lines.append('</tr><tr>')
for child in node.childList:
cellList = [field.outputText(child, False, False, True) for field in
child.formatRef.fields()]
for i in range(len(cellList)):
startPos = 0
while True:
match = _genLinkRe.search(cellList[i], startPos)
if not match:
break
addr = match.group(1)
if addr.startswith('#'):
pathObj = pathDict.get(addr[1:], None)
if pathObj:
name = pathObj.stem
pathObj = pathObj / '..' / 'index.html'
relPath = os.path.relpath(str(pathObj), str(dirObj))
relPath += '#' + name
cellList[i] = (cellList[i][:match.start(1)] +
relPath + cellList[i][match.end(1):])
elif urltools.isRelative(addr):
cellList[i] = (cellList[i][:match.start(1)] +
'../' * level + addr +
cellList[i][match.end(1):])
startPos = match.start(1)
startPos = 0
while True:
match = _imgLinkRe.search(cellList[i], startPos)
if not match:
break
addr = match.group(1)
if not addr.startswith('#') and urltools.isRelative(addr):
cellList[i] = (cellList[i][:match.start(1)] +
'../' * level + addr +
cellList[i][match.end(1):])
startPos = match.start(1)
if child.childList:
cellList[0] = ('<a href="{0}/index.html">{1}</a>'.
format(pathDict[child.uId].stem, cellList[0]))
cellList[0] = '<a id="{0}" />{1}'.format(pathDict[child.uId].stem,
cellList[0])
lines.extend(['<td>{0}</td>'.format(cell) for cell in cellList])
lines.append('</tr><tr>')
lines.extend(['</tr>', '</table>'])
if ExportDialog.addHeader:
footerText = (globalref.mainControl.activeControl.printData.
formatHeaderFooter(False))
if footerText:
lines.append(footerText)
lines.extend(['</body>', '</html>'])
with open('index.html', 'w', encoding='utf-8') as f:
f.writelines([(line + '\n') for line in lines])
for child in node.childList:
_writeHtmlTable(child, node, pathDict, level + 1)
os.chdir('..')
def _oldElementXml(node, structRef, idDict, skipTypeFormats=None,
extraFormats=True, addChildren=True, addDescend=True):
"""Return an Element object with the XML for this node's branch.
Arguments:
node -- the root node to save
structRef -- a ref to the tree structure
idDict -- a dict of new IDs to old IDs
skipTypeFormats -- a set of node format types not included in XML
extraFormats -- if True, includes unused format info
addChildren -- if True, include data for the first level of children
addDescend -- if True, add lower descendant nodes
"""
if skipTypeFormats == None:
skipTypeFormats = set()
nodeFormat = node.formatRef
addFormat = nodeFormat.name not in skipTypeFormats
element = ElementTree.Element(nodeFormat.name, {'item':'y'})
# add line feeds to make output somewhat readable
element.tail = '\n'
element.text = '\n'
element.set('uniqueid', idDict[node.uId])
if addFormat:
element.attrib.update(_convertOldNodeFormat(nodeFormat.storeFormat()))
skipTypeFormats.add(nodeFormat.name)
firstField = True
for field in nodeFormat.fields():
text = node.data.get(field.name, '')
if text or addFormat:
fieldElement = ElementTree.SubElement(element, field.name)
fieldElement.tail = '\n'
if field.typeName in ('Date', 'DateTime'):
text = text.replace('-', '/')
if (field.typeName in ('Time', 'DateTime') and
text.endswith('.000000')):
text = text[:-7]
linkCount = 0
startPos = 0
while True:
match = _intLinkRe.search(text, startPos)
if not match:
break
uId = idDict.get(match.group(1), '')
if uId:
text = text[:match.start(1)] + uId + text[match.end(1):]
linkCount += 1
startPos = match.start(1)
if linkCount:
fieldElement.attrib['linkcount'] = repr(linkCount)
fieldElement.text = text
if addFormat:
fieldElement.attrib.update(_convertOldFieldFormat(field.
formatData()))
if firstField:
fieldElement.attrib['idref'] = 'y'
firstField = False
if addChildren:
for child in node.childList:
element.append(_oldElementXml(child, structRef, idDict,
skipTypeFormats, False,
addChildren=addDescend))
nodeFormats = []
if extraFormats: # write format info for unused formats
nodeFormats = list(structRef.treeFormats.values())
if structRef.treeFormats.fileInfoFormat.fieldFormatModified:
nodeFormats.append(structRef.treeFormats.fileInfoFormat)
for nodeFormat in nodeFormats:
if nodeFormat.name not in skipTypeFormats:
formatElement = ElementTree.SubElement(element,
nodeFormat.name,
{'item':'n'})
formatElement.tail = '\n'
formatElement.attrib.update(_convertOldNodeFormat(nodeFormat.
storeFormat()))
firstField = True
for field in nodeFormat.fields():
fieldElement = ElementTree.SubElement(formatElement,
field.name)
fieldElement.tail = '\n'
fieldElement.attrib.update(_convertOldFieldFormat(field.
formatData()))
if firstField:
fieldElement.attrib['idref'] = 'y'
firstField = False
return element
def _setOldUniqueId(idDict, node):
"""Set an old TreeLine unique ID for this node amd add to dict.
Arguments:
idDict -- a dict of old IDs to new IDs.
node -- the node to give an old ID
"""
nodeFormat = node.formatRef
idField = next(iter(nodeFormat.fieldDict.values()))
uId = idField.outputText(node, True, True, nodeFormat.formatHtml)
uId = uId.strip().split('\n', 1)[0]
maxLength = 50
if len(uId) > maxLength:
pos = uId.rfind(' ', maxLength // 2, maxLength + 1)
if pos < 0:
pos = maxLength
uId = uId[:pos]
uId = uId.replace(' ', '_').lower()
uId = _idReplaceCharsRe.sub('', uId)
if not uId:
uId = 'id_1'
elif not 'a' <= uId <= 'z':
uId = 'id_' + uId
if uId in idDict:
if uId == 'id_1':
uId = 'id'
i = 1
while uId + '_' + repr(i) in idDict:
i += 1
uId = uId + '_' + repr(i)
idDict[uId] = node.uId
def _convertOldNodeFormat(attrib):
"""Return old XML node format attributes from current data.
Arguments:
attrib -- current node format data attributes
"""
if 'spacebetween' in attrib and not attrib['spacebetween']:
attrib['spacebetween'] = 'n'
for key in ('formathtml', 'bullets', 'tables'):
if key in attrib and attrib[key]:
attrib[key] = 'y'
attrib['line0'] = attrib.get('titleline', '')
del attrib['titleline']
for i, line in enumerate(attrib['outputlines'], 1):
attrib['line' + repr(i)] = line
del attrib['outputlines']
del attrib['formatname']
del attrib['fields']
return attrib
def _convertOldFieldFormat(attrib):
"""Return old XML field format attributes from current data.
Arguments:
attrib -- current field format data attributes
"""
if 'fieldtype' in attrib:
attrib['type'] = attrib['fieldtype']
del attrib['fieldtype']
for key in ('lines', 'sortkeynum'):
if key in attrib:
attrib[key] = repr(attrib[key])
if 'sortkeyfwd' in attrib and not attrib['sortkeyfwd']:
attrib['sortkeydir'] = 'r'
if 'evalhtml' in attrib:
attrib['evalhtml'] = 'y' if attrib['evalhtml'] else 'n'
if attrib['type'] in ('Date', 'Time', 'DateTime'):
fieldFormat = attrib.get('format', '')
if fieldFormat:
fieldFormat = fieldFormat.replace('%A', 'dddd')
fieldFormat = fieldFormat.replace('%a', 'ddd')
fieldFormat = fieldFormat.replace('%d', 'dd')
fieldFormat = fieldFormat.replace('%-d', 'd')
fieldFormat = fieldFormat.replace('%B', 'MMMM')
fieldFormat = fieldFormat.replace('%b', 'MMM')
fieldFormat = fieldFormat.replace('%m', 'MM')
fieldFormat = fieldFormat.replace('%-m', 'M')
fieldFormat = fieldFormat.replace('%Y', 'yyyy')
fieldFormat = fieldFormat.replace('%y', 'yy')
fieldFormat = fieldFormat.replace('%H', 'HH')
fieldFormat = fieldFormat.replace('%-H', 'H')
fieldFormat = fieldFormat.replace('%I', 'hh')
fieldFormat = fieldFormat.replace('%-I', 'h')
fieldFormat = fieldFormat.replace('%M', 'mm')
fieldFormat = fieldFormat.replace('%-M', 'm')
fieldFormat = fieldFormat.replace('%S', 'ss')
fieldFormat = fieldFormat.replace('%-S', 's')
fieldFormat = fieldFormat.replace('%f', 'zzz')
fieldFormat = fieldFormat.replace('%p', 'AP')
attrib['format'] = fieldFormat
del attrib['fieldname']
return attrib
def _convertOldPrintData(attrib):
"""Return old XML print data attributes from current print data.
Arguments:
attrib -- current print data attributes
"""
for key in ('printlines', 'printwidowcontrol', 'printportrait'):
if key in attrib and not attrib[key]:
attrib[key] = 'n'
for key in ('printindentfactor', 'printpaperwidth', 'printpaperheight',
'printheadermargin', 'printfootermargin', 'printcolumnspace',
'printnumcolumns'):
if key in attrib:
attrib[key] = repr(attrib[key])
if 'printmargins' in attrib:
attrib['printmargins'] = ' '.join([repr(margin) for margin in
attrib['printmargins']])
return attrib
def _createGenericXml(node, addChildren=True):
"""Return an ElementTree element with generic XML from this branch.
Called recursively for children if addChildren is True.
Arguments:
node -- the node to export
addChildren -- add branch if True
"""
nodeFormat = node.formatRef
element = ElementTree.Element(nodeFormat.name)
element.tail = '\n'
for fieldName in nodeFormat.fieldNames():
text = node.data.get(fieldName, '')
if text and fieldName != imports.genericXmlTextFieldName:
element.set(fieldName, text)
if imports.genericXmlTextFieldName in nodeFormat.fieldDict:
text = node.data.get(imports.genericXmlTextFieldName, '')
if text:
element.text = text
if addChildren and node.childList:
if not text:
element.text = '\n'
for child in node.childList:
element.append(_createGenericXml(child))
return element
def _addElemToZip(destZip, rootElem, fileName):
"""Adds ElementTree root elements to the given zip file.
Arguments:
destZip -- the destination zip file
rootElem -- the root element tree item to add
fileName -- the file name or path in the zip file
"""
elemTree = ElementTree.ElementTree(rootElem)
with io.BytesIO() as output:
elemTree.write(output, 'utf-8', True)
destZip.writestr(fileName, output.getvalue())
def _addOdfElement(name, parent=None, attr=None):
"""Shortcut function to add elements to the ElementTree.
Converts names and attr keys from short version (with ':') to the full URI.
Returns the new element.
Arguments:
name -- the element tag
parent -- new element is added here if given
attr -- a dict of the element's attrbutes
"""
if ':' in name:
prefix, name = name.split(':', 1)
name = '{{{0}}}{1}'.format(_odfNamespace[prefix], name)
newAttr = {}
if attr:
for key, value in attr.items():
if ':' in key:
prefix, key = key.split(':', 1)
key = '{{{0}}}{1}'.format(_odfNamespace[prefix], key)
newAttr[key] = value
elem = ElementTree.Element(name, newAttr)
elem.tail = '\n'
if parent is not None:
parent.append(elem)
return elem
def _addOdfText(spot, parentElem, addChildren=True, level=1, maxLevel=1):
"""Add heading and text elements to the parent element tree element.
Called recursively for children if addChildren is True.
Returns the maximum indent level used for this branch.
Arguments:
spot -- the spot to export
parentElem -- the parent element tree element to add to
addChildren -- add branch if True
level -- the current tree indent level
maxLevel -- the previous max indent level
"""
headElem = _addOdfElement('text:h', parentElem,
{'text:outline-level': '{0}'.format(level),
'text:style-name':
'Heading_20_{0}'.format(level)})
headElem.text = spot.nodeRef.title(spot)
output = spot.nodeRef.output(True, False, spot)
if output and output[0] == spot.nodeRef.title(spot):
del output[0] # remove first line if same as title
for line in output:
textElem = _addOdfElement('text:p', parentElem,
{'text:outline-level': '{0}'.format(level),
'text:style-name': 'Text_20_body'})
textElem.text = line
if addChildren and spot.nodeRef.childList:
for child in spot.childSpots():
childlevel = _addOdfText(child, parentElem, True, level + 1,
maxLevel)
maxLevel = max(childlevel, maxLevel)
else:
maxLevel = max(level, maxLevel)
return maxLevel
def _exportHtmlBookmarks(node, addChildren=True):
"""Return a text list ith descendant bookmarks in Mozilla format.
Called recursively for children if addChildren is True.
Arguments:
node -- the node to export
addChildren -- add branch if True
"""
title = node.title()
if not node.childList:
nodeFormat = node.formatRef
field = _findLinkField(nodeFormat)
if field:
linkMatch = fieldformat.linkRegExp.search(node.data.
get(field.name, ''))
if linkMatch:
link = linkMatch.group(1)
return ['<dt><a href="{0}">{1}</a>'.format(link, title)]
elif (len(nodeFormat.fieldDict) == 1 and not
node.data.get(nodeFormat.fieldNames()[0], '')):
return ['<hr>']
result = ['<dt><h3>{0}</h3>'.format(title)]
if addChildren:
result.append('<dl><p>')
for child in node.childList:
result.extend(_exportHtmlBookmarks(child))
result.append('</dl><p>')
return result
def _exportXbel(node, addChildren=True):
"""Return an ElementTree element with XBEL bookmarks from this branch.
Called recursively for children if addChildren is True.
Arguments:
node -- the node to export
addChildren -- add branch if True
"""
titleElem = ElementTree.Element('title')
titleElem.text = node.title()
if not node.childList:
nodeFormat = node.formatRef
field = _findLinkField(nodeFormat)
if field:
linkMatch = fieldformat.linkRegExp.search(node.data.
get(field.name, ''))
if linkMatch:
link = linkMatch.group(1)
element = ElementTree.Element('bookmark', {'href': link})
element.append(titleElem)
element.tail = '\n'
return element
elif (len(nodeFormat.fieldDict) == 1 and not
node.data.get(nodeFormat.fieldNames()[0], '')):
element = ElementTree.Element('separator')
element.tail = '\n'
return element
element = ElementTree.Element('folder')
element.append(titleElem)
element.tail = '\n'
if addChildren:
for child in node.childList:
element.append(_exportXbel(child))
return element
def _findLinkField(nodeFormat):
"""Return the field most likely to contain a bookmark URL.
Return None if there are no matches.
Arguments:
nodeFormat -- the format to find a field in
"""
availFields = [field for field in nodeFormat.fieldDict.values() if
field.typeName == 'ExternalLink']
if not availFields:
return None
bestFields = [field for field in availFields if
field.name.lower() ==
imports.bookmarkLinkFieldName.lower()]
if bestFields:
return bestFields[0]
return availFields[0]
class ExportDialog(QWizard):
"""Dialog/wizard for setting file export type and options.
"""
typePage, subtypePage, optionPage = range(3)
entireTree, selectBranch, selectNode = range(3)
exportWhat = entireTree
includeRoot = False
openOnly = False
addHeader = False
numColumns = 1
navPaneLevels = 2
exportTypes = ['html', 'text', 'treeline', 'xml', 'odf', 'bookmarks']
currentType = 'html'
exportTypeDescript = {'html': _('&HTML'), 'text': _('&Text'),
'treeline': _('Tree&Line'),
'xml': _('&XML (generic)'), 'odf': _('&ODF Outline'),
'bookmarks': _('Book&marks')}
exportSubtypes = {'html': ['htmlSingle', 'htmlNavSingle','htmlPages',
'htmlTables', 'htmlLiveLink', 'htmlLiveSingle'],
'text': ['textTitles', 'textPlain', 'textTableMultiCsv',
'textTableCsv', 'textTableTab'],
'treeline': ['oldTreeLine', 'treeLineSubtree'],
'xml': ['xmlGeneric'],
'odf': ['odfText'],
'bookmarks': ['bookmarksHtml', 'bookmarksXbel']}
currentSubtype = 'htmlSingle'
subtypeDescript = {'htmlSingle': _('&Single HTML page'),
'htmlNavSingle': _('Single &HTML page with '
'navigation pane'),
'htmlPages': _('Multiple HTML &pages with '
'navigation pane'),
'htmlTables': _('Multiple HTML &data tables'),
'htmlLiveLink': _('Live tree view, linked to '
'TreeLine file (for web server)'),
'htmlLiveSingle': _('Live tree view, single file '
'(embedded data)'),
'textTitles': _('&Tabbed title text'),
'textPlain': _('&Unformatted output of all text'),
'textTableMultiCsv': _('&Comma delimited (CSV) table '
'of descendants (level numbers)'),
'textTableCsv': _('Comma &delimited (CSV) table '
'of children (single level)'),
'textTableTab': _('Tab &delimited table of children '
'(&single level)'),
'oldTreeLine': _('&Old TreeLine (2.0.x)'),
'treeLineSubtree': _('&TreeLine Subtree'),
'bookmarksHtml': _('&HTML format bookmarks'),
'bookmarksXbel': _('&XBEL format bookmarks')}
disableEntireTree = {'textTableCsv', 'textTableTab', 'treeLineSubtree'}
disableSelBranches = {'htmlLiveLink'}
disableSelNodes = {'htmlNavSingle', 'htmlPages', 'htmlTables',
'htmlLiveLink', 'textTableMultiCsv'}
enableRootNode = {'htmlSingle', 'htmlNavSingle', 'textTitles',
'textPlain', 'textTableMultiCsv', 'ODF'}
forceRootNodeOff = {'textTableCsv', 'textTableTab'}
enableOpenOnly = {'htmlSingle', 'htmlNavSingle', 'textTitles',
'textPlain', 'textTableMultiCsv', 'ODF'}
enableHeader = {'htmlSingle', 'htmlNavSingle', 'htmlTables'}
enableColumns = {'htmlSingle'}
enableNavLevels = {'htmlNavSingle'}
def __init__(self, selectionAvail=True, parent=None):
"""Initialize the export wizard.
Arguments:
selectionAvail -- false if no nodes or branches are selected
parent -- the parent window
"""
super().__init__(parent, Qt.Dialog)
self.setWindowFlags(Qt.Dialog | Qt.WindowTitleHint |
Qt.WindowCloseButtonHint)
self.setWindowTitle(_('File Export'))
self.setWizardStyle(QWizard.ClassicStyle)
self.setPage(ExportDialog.typePage, ExportDialogTypePage())
self.setPage(ExportDialog.subtypePage, ExportDialogSubtypePage())
self.setPage(ExportDialog.optionPage,
ExportDialogOptionPage(selectionAvail))
class ExportDialogTypePage(QWizardPage):
"""A wizard page for selecting the main export type.
"""
def __init__(self, parent=None):
"""Initialize the export wizard page.
Arguments:
parent -- parent widget, set automatically by addPage or setPage
"""
super().__init__(parent)
topLayout = QVBoxLayout(self)
self.setLayout(topLayout)
self.setTitle(_('Choose export format type'))
typeButtons = QButtonGroup(self)
for id, exportType in enumerate(ExportDialog.exportTypes):
button = QRadioButton(ExportDialog.
exportTypeDescript[exportType])
typeButtons.addButton(button, id)
topLayout.addWidget(button)
if exportType == ExportDialog.currentType:
button.setChecked(True)
typeButtons.buttonClicked[int].connect(self.setCurrentType)
def setCurrentType(self, buttonID):
"""Set the saved current type value based on a button click.
Also sets the subtype to a default value.
Arguments:
buttonId -- the ID number of the button that was clicked
"""
ExportDialog.currentType = ExportDialog.exportTypes[buttonID]
ExportDialog.currentSubtype = (ExportDialog.
exportSubtypes[ExportDialog.currentType][0])
def nextId(self):
"""Return the ID for the next page in the wizard sequence.
"""
if len(ExportDialog.exportSubtypes[ExportDialog.currentType]) > 1:
return ExportDialog.subtypePage
return ExportDialog.optionPage
class ExportDialogSubtypePage(QWizardPage):
"""A wizard page for selecting the export subtype.
"""
def __init__(self, parent=None):
"""Initialize the export wizard page.
Arguments:
parent -- parent widget, set automatically by addPage or setPage
"""
super().__init__(parent)
topLayout = QVBoxLayout(self)
self.setLayout(topLayout)
self.setTitle(_('Choose export format subtype'))
self.subtypeButtons = QButtonGroup(self)
self.subtypeButtons.buttonClicked[int].connect(self.setCurrentSubtype)
def initializePage(self):
"""Add buttons to this page based on current settings.
"""
topLayout = self.layout()
# remove old buttons from a previously set subtype
for button in self.subtypeButtons.buttons():
self.subtypeButtons.removeButton(button)
topLayout.removeWidget(button)
button.deleteLater()
for id, subtype in enumerate(ExportDialog.
exportSubtypes[ExportDialog.currentType]):
button = QRadioButton(ExportDialog.subtypeDescript[subtype])
self.subtypeButtons.addButton(button, id)
topLayout.addWidget(button)
if subtype == ExportDialog.currentSubtype:
button.setChecked(True)
def setCurrentSubtype(self, buttonId):
"""Set the saved current subtype value based on a button click.
Arguments:
buttonId -- the ID number of the button that was clicked
"""
availSubtypes = ExportDialog.exportSubtypes[ExportDialog.currentType]
ExportDialog.currentSubtype = availSubtypes[buttonId]
class ExportDialogOptionPage(QWizardPage):
"""A wizard page for selecting other export options.
"""
def __init__(self, selectionAvail=True, parent=None):
"""Initialize the export wizard page.
Arguments:
selectionAvail -- false if no nodes or branches are selected
parent -- parent widget, set automatically by addPage or setPage
"""
super().__init__(parent)
self.selectionAvail = selectionAvail
topLayout = QVBoxLayout(self)
self.setLayout(topLayout)
self.setTitle(_('Choose export options'))
whatGroupBox = QGroupBox(_('What to Export'))
topLayout.addWidget(whatGroupBox)
whatLayout = QVBoxLayout(whatGroupBox)
self.whatButtons = QButtonGroup(self)
treeButton = QRadioButton(_('&Entire tree'))
self.whatButtons.addButton(treeButton, ExportDialog.entireTree)
whatLayout.addWidget(treeButton)
branchButton = QRadioButton(_('Selected &branches'))
self.whatButtons.addButton(branchButton, ExportDialog.selectBranch)
whatLayout.addWidget(branchButton)
nodeButton = QRadioButton(_('Selected &nodes'))
self.whatButtons.addButton(nodeButton, ExportDialog.selectNode)
whatLayout.addWidget(nodeButton)
self.whatButtons.button(ExportDialog.exportWhat).setChecked(True)
self.whatButtons.buttonClicked[int].connect(self.setExportWhat)
optionBox = QGroupBox(_('Other Options'))
topLayout.addWidget(optionBox)
optionLayout = QVBoxLayout(optionBox)
self.rootButton = QCheckBox(_('&Include root nodes'))
optionLayout.addWidget(self.rootButton)
self.rootButton.setChecked(ExportDialog.includeRoot)
self.rootButton.toggled.connect(self.setIncludeRoot)
self.openOnlyButton = QCheckBox(_('&Only open node children'))
optionLayout.addWidget(self.openOnlyButton)
self.openOnlyButton.setChecked(ExportDialog.openOnly)
self.openOnlyButton.toggled.connect(self.setOpenOnly)
self.headerButton = QCheckBox(_('Include &print header && '
'footer'))
optionLayout.addWidget(self.headerButton)
self.headerButton.setChecked(ExportDialog.addHeader)
self.headerButton.toggled.connect(self.setAddHeader)
columnLayout = QHBoxLayout()
optionLayout.addLayout(columnLayout)
self.numColSpin = QSpinBox()
columnLayout.addWidget(self.numColSpin)
self.numColSpin.setRange(1, 9)
self.numColSpin.setMaximumWidth(40)
self.numColSpin.setValue(ExportDialog.numColumns)
self.colLabel = QLabel(_('&Columns'))
columnLayout.addWidget(self.colLabel)
self.colLabel.setBuddy(self.numColSpin)
self.numColSpin.valueChanged.connect(self.setNumColumns)
navLevelsLayout = QHBoxLayout()
optionLayout.addLayout(navLevelsLayout)
self.navLevelsSpin = QSpinBox()
navLevelsLayout.addWidget(self.navLevelsSpin)
self.navLevelsSpin.setRange(1, 9)
self.navLevelsSpin.setMaximumWidth(40)
self.navLevelsSpin.setValue(ExportDialog.navPaneLevels)
self.navLevelsLabel = QLabel(_('Navigation pane &levels'))
navLevelsLayout.addWidget(self.navLevelsLabel)
self.navLevelsLabel.setBuddy(self.navLevelsSpin)
self.navLevelsSpin.valueChanged.connect(self.setNavLevels)
def initializePage(self):
"""Enable or disable controls based on current settings.
"""
subtype = ExportDialog.currentSubtype
treeButton, branchButton, nodeButton = self.whatButtons.buttons()
treeButton.setEnabled(subtype not in ExportDialog.disableEntireTree)
branchButton.setEnabled(subtype not in ExportDialog.disableSelBranches
and self.selectionAvail)
nodeButton.setEnabled(subtype not in ExportDialog.disableSelNodes and
self.selectionAvail)
num = 0
while not self.whatButtons.checkedButton().isEnabled():
try:
self.whatButtons.button(num).setChecked(True)
except AttributeError:
QMessageBox.warning(self, 'TreeLine',
_('Must select nodes prior to export'))
parent = self.parent()
while parent:
try:
parent.reject()
return
except AttributeError:
parent = parent.parent()
num += 1
if (subtype in ExportDialog.enableRootNode and
ExportDialog.exportWhat != ExportDialog.selectNode):
self.rootButton.setEnabled(True)
self.rootButton.setChecked(ExportDialog.includeRoot)
else:
self.rootButton.setEnabled(False)
self.rootButton.setChecked(subtype not in
ExportDialog.forceRootNodeOff)
if (subtype in ExportDialog.enableOpenOnly and
ExportDialog.exportWhat != ExportDialog.selectNode):
self.openOnlyButton.setEnabled(True)
else:
self.openOnlyButton.setEnabled(False)
self.openOnlyButton.setChecked(False)
self.headerButton.setEnabled(subtype in ExportDialog.enableHeader)
if subtype not in ExportDialog.enableHeader:
self.headerButton.setChecked(False)
columnsEnabled = subtype in ExportDialog.enableColumns
self.numColSpin.setVisible(columnsEnabled)
self.colLabel.setVisible(columnsEnabled)
if not columnsEnabled:
self.numColSpin.setValue(1)
navLevelsEnabled = subtype in ExportDialog.enableNavLevels
self.navLevelsSpin.setVisible(navLevelsEnabled)
self.navLevelsLabel.setVisible(navLevelsEnabled)
def setExportWhat(self, buttonNum):
"""Set what to export (all, branch, node) based on button group click.
Arguments:
buttonNum -- the ID number of the clicked button
"""
ExportDialog.exportWhat = buttonNum
self.initializePage()
def setIncludeRoot(self, checked):
"""Set whether root node is included based on a button click.
Arguments:
checked -- True if the check box is checked
"""
ExportDialog.includeRoot = checked
def setOpenOnly(self, checked):
"""Set whether only open nodes are included based on a button click.
Arguments:
checked -- True if the check box is checked
"""
ExportDialog.openOnly = checked
def setAddHeader(self, checked):
"""Set whether headers and footers are added based on a button click.
Arguments:
checked -- True if the check box is checked
"""
ExportDialog.addHeader = checked
def setNumColumns(self, num):
"""Set number of columns based on a spin box change.
Arguments:
num -- the new spin box setting
"""
ExportDialog.numColumns = num
def setNavLevels(self, num):
"""Set number of navigation pane levels based on a spin box change.
Arguments:
num -- the new spin box setting
"""
ExportDialog.navPaneLevels = num
|