Compare commits

...

10 commits

Author SHA1 Message Date
Maciej Lebiest
1fa56298da Add api request rate limiting, fix for #5 2024-01-02 15:02:34 +01:00
Maciej Lebiest
cf1bb98dbd Add attachments exporting, fix for #4 2023-12-31 16:20:27 +01:00
Maciej Lebiest
acf8b71e5b Add HTTP headers customization parameters. Fix for #3 2023-04-16 10:33:29 +02:00
Maciej Lebiest
50fe9b7476 Add possibility to replace any characters in filename with "_" char. 2023-02-08 11:13:47 +01:00
Szwendacz99
5139a48760 update readme 2022-07-27 12:02:06 +02:00
Szwendacz99
60053ed3fc update readme 2022-07-27 11:56:39 +02:00
Maciej Lebiest
947c25d34d fix level and format parameters when more than one given 2022-07-27 11:49:07 +02:00
Maciej Lebiest
ff31611d46 add timestamps checking to prevent update of files that contain newest version 2022-07-26 17:30:08 +02:00
Maciej Lebiest
e2bc12eb60 properly retrieve full lists of objects through api, fix #2 2022-06-23 17:14:45 +02:00
Maciej Lebiest
fb65dfad99 add debug for printing elements names and id numbers 2022-06-23 14:34:28 +02:00
2 changed files with 499 additions and 125 deletions

103
README.md
View file

@ -2,11 +2,15 @@
Customizable script for exporting notes from BookStack through API
#### Features:
- export keeping the tree structure by making folders from Shelves, Books and Chapters
- export keeping the tree structure by making folders from Shelves, Books, Chapters and attachments (including attachments from external links)
- export multiple formats at once
- export at multiple levels at once (export Books or/and Chapters or/and Pages as files)
- choose if local files should be updated only if their edit timestamp is older than remote document last edit, or timestamps should be ignored and files will always be overwritten with the newest version
- customizable path for placing exported notes
- configure replacing any characters in filenames with "_" for any filesystem compatibility
- authorization token is loaded from txt file
- Set custom HTTP User-Agent header to bypass filtering based on that header (like in CloudFlare tunnels)
- Set arbitrary custom headers through parameter
Requirements:
- Python at least in version 3.6
@ -14,44 +18,85 @@ Requirements:
Full example on how to use the script:
1. Clone the repo
2. next to the script place token.txt file containing token id and token secret in format: TOKEN_ID:TOKEN_SECRET
3. in the same directory run the command, specifying your app domain with https prefix (every parameter is optional as it have default value, this is a full possible example):
3. in the same directory run the command, specifying your app domain with https prefix (every parameter is optional as it have default value, this is an example):
```bash
python exporter.py \
-H https://wiki.example.com \
-f pdf,md,plaintext,html \
-l pages,chapters,books
-f pdf markdown plaintext html \
-l pages chapters books \
--rate-limit 180 \
-c "/" "#" \
--force-update-files \
-t ./token.txt \
-V debug \
-p ./
-p ./ \
--user-agent "Mozilla/5.0 (X11; Linux x86_64; rv:109.0) Gecko/20100101 Firefox/112.0"
--additional-headers "Header1: value1" "Header2: value2"
```
Customization:
```text
options:
-p PATH, --path PATH Path where exported files will be placed.
Default: .
-t TOKEN_FILE, --token-file TOKEN_FILE
File containing authorization token in format TOKEN_ID:TOKEN_SECRET
Default: ./token.txt
-H HOST, --host HOST Your domain with protocol prefix, example: https://example.com
Default: https://localhost
-f FORMATS, --formats FORMATS
Coma separated list of formats to use for export.
Available ones: markdown,plaintext,pdf,html
default: markdown
-l LEVEL, --level LEVEL
Coma separated list of levels at which should be export performed.
Available levels: ['pages', 'chapters', 'books']
Default: pages
-V LOG_LEVEL, --log-level LOG_LEVEL
Set verbosity level.
Available levels: dict_keys(['debug', 'info', 'warning', 'error'])
Default: info
usage: exporter.py [-h] [-p PATH] [-t TOKEN_FILE] [-H HOST]
[-f {markdown,plaintext,pdf,html} [{markdown,plaintext,pdf,html} ...]]
[--rate-limit RATE_LIMIT]
[-c FORBIDDEN_CHARS [FORBIDDEN_CHARS ...]] [-u USER_AGENT]
[--additional-headers ADDITIONAL_HEADERS [ADDITIONAL_HEADERS ...]]
[-l {pages,chapters,books} [{pages,chapters,books} ...]]
[--force-update-files] [--dont-export-attachments]
[--dont-export-external-attachments]
[-V {debug,info,warning,error}]
BookStack exporter
optional arguments:
-h, --help show this help message and exit
-p PATH, --path PATH Path where exported files will be placed.
-t TOKEN_FILE, --token-file TOKEN_FILE
File containing authorization token in format
TOKEN_ID:TOKEN_SECRET
-H HOST, --host HOST Your domain with protocol prefix, example:
https://example.com
-f {markdown,plaintext,pdf,html} [{markdown,plaintext,pdf,html} ...], --formats {markdown,plaintext,pdf,html} [{markdown,plaintext,pdf,html} ...]
Space separated list of formats to use for export.
--rate-limit RATE_LIMIT
How many api requests can be made in a minute. Default
is 180 (BookStack defaults)
-c FORBIDDEN_CHARS [FORBIDDEN_CHARS ...], --forbidden-chars FORBIDDEN_CHARS [FORBIDDEN_CHARS ...]
Space separated list of symbols to be replaced with
"_" in filenames.
-u USER_AGENT, --user-agent USER_AGENT
User agent header content. In situations where
requests are blocked because of bad
client/unrecognized web browser/etc (like with
CloudFlare tunnels), change to some typical web
browser user agent header.
--additional-headers ADDITIONAL_HEADERS [ADDITIONAL_HEADERS ...]
List of arbitrary additional HTTP headers to be sent
with every HTTP request. They can override default
ones, including Authorization header. IMPORTANT: these
headers are also sent when downloading external
attachments! Don't put here any private data.Example:
-u "Header1: value1" "Header2: value2"
-l {pages,chapters,books} [{pages,chapters,books} ...], --level {pages,chapters,books} [{pages,chapters,books} ...]
Space separated list of levels at which should be
export performed.
--force-update-files Set this option to skip checking local files
timestamps against remote last edit timestamps. This
will cause overwriting local files, even if they seem
to be already in newest version.
--dont-export-attachments
Set this to prevent exporting any attachments.
--dont-export-external-attachments
Set this to prevent exporting external attachments
(from links).
-V {debug,info,warning,error}, --log-level {debug,info,warning,error}
Set verbosity level.
```
### TODO:
- ~~choosing verbosity level through command line parameter~~ Done
- ~~choosing on what level should the notes be exported (Books, Chapters, Pages)~~ Done
- WIP: choosing if update note file only if the last edit timestamp from API is later that the local file timestamp
- suggestions?
- [x] ~~choosing verbosity level through command line parameter~~ Done
- [x] ~~choosing on what level should the notes be exported (Books, Chapters, Pages)~~ Done
- [x] ~~choosing if update note file only if the last edit timestamp from API is later that the local file timestamp~~ Done
- [x] ~~exporting attachments~~
- [x] ~~api rate limiting~~
- [ ] suggestions?

View file

@ -5,105 +5,271 @@ import os
from datetime import datetime
from logging import info, error, debug
from pathlib import Path
import sys
from typing import Dict, List, Union
from urllib.request import urlopen, Request
import urllib.parse
import base64
from time import time
from time import sleep
# (formatName, fileExtension)
FORMATS: dict['str', 'str'] = {
FORMATS: Dict['str', 'str'] = {
'markdown': 'md',
'plaintext': 'txt',
'pdf': 'pdf',
'html': 'html'
}
LEVELS = [
'pages',
'chapters',
'books'
]
LEVELS = ['pages', 'chapters', 'books']
LOG_LEVEL: dict = {
LOG_LEVEL: Dict = {
'debug': logging.DEBUG,
'info': logging.INFO,
'warning': logging.WARNING,
'error': logging.ERROR
}
# Characters in filenames to be replaced with "_"
FORBIDDEN_CHARS: List[str] = ["/", "#"]
parser = argparse.ArgumentParser(description='BookStack exporter')
parser.add_argument('-p', '--path', type=str, default='.',
parser.add_argument('-p',
'--path',
type=str,
default='.',
help='Path where exported files will be placed.')
parser.add_argument('-t', '--token-file', type=str, default=f'.{os.path.sep}token.txt',
parser.add_argument(
'-t',
'--token-file',
type=str,
default=f'.{os.path.sep}token.txt',
help='File containing authorization token in format TOKEN_ID:TOKEN_SECRET')
parser.add_argument('-H', '--host', type=str, default='https://localhost',
parser.add_argument(
'-H',
'--host',
type=str,
default='https://localhost',
help='Your domain with protocol prefix, example: https://example.com')
parser.add_argument('-f', '--formats', type=str, default='markdown',
help=f'Coma separated list of formats to use for export.'
f' Available ones: {",".join([f for f in FORMATS.keys()])}')
parser.add_argument('-l', '--level', type=str, default='pages',
help=f'Coma separated list of levels at which should be export performed. '
f'Available levels: {LEVELS}')
parser.add_argument('-V', '--log-level', type=str, default='info',
help=f'Set verbosity level. '
f'Available levels: {LOG_LEVEL.keys()}')
parser.add_argument('-f',
'--formats',
type=str,
default=['markdown'],
nargs="+",
help='Space separated list of formats to use for export.',
choices=FORMATS.keys())
parser.add_argument('--rate-limit',
type=int,
default=180,
help='How many api requests can be made in a minute. '
'Default is 180 (BookStack defaults)')
parser.add_argument('-c',
'--forbidden-chars',
type=str,
default=FORBIDDEN_CHARS,
nargs="+",
help='Space separated list of symbols to be replaced '
'with "_" in filenames.')
parser.add_argument('-u',
'--user-agent',
type=str,
default="BookStack exporter",
help='User agent header content. In situations'
' where requests are blocked because of bad client/'
'unrecognized web browser/etc (like with CloudFlare'
' tunnels), change to some typical '
'web browser user agent header.')
parser.add_argument('--additional-headers',
type=str,
nargs="+",
default=[],
help='List of arbitrary additional HTTP headers to be '
'sent with every HTTP request. They can override default'
' ones, including Authorization header. IMPORTANT: '
'these headers are also sent when downloading external '
'attachments! Don\'t put here any private data.'
'Example: -u "Header1: value1" "Header2: value2"')
parser.add_argument(
'-l',
'--level',
type=str,
default=['pages'],
nargs="+",
help="Space separated list of levels at which should be export "
"performed. ",
choices=LEVELS)
parser.add_argument(
'--force-update-files',
action='store_true',
help="Set this option to skip checking local files timestamps against "
"remote last edit timestamps. This will cause overwriting local files,"
" even if they seem to be already in newest version.")
parser.add_argument('--dont-export-attachments',
action='store_true',
help="Set this to prevent exporting any attachments.")
parser.add_argument(
'--dont-export-external-attachments',
action='store_true',
help="Set this to prevent exporting external attachments (from links).")
parser.set_defaults(force_update_files=False)
parser.set_defaults(dont_export_attachments=False)
parser.set_defaults(dont_export_external_attachments=False)
parser.add_argument('-V',
'--log-level',
type=str,
default='info',
help='Set verbosity level.',
choices=LOG_LEVEL.keys())
args = parser.parse_args()
if args.log_level not in LOG_LEVEL.keys():
error(f"Bad log level {args.log_level}, available levels: {LOG_LEVEL.keys()}")
exit(1)
logging.basicConfig(format='%(levelname)s :: %(message)s', level=LOG_LEVEL.get(args.log_level))
def removesuffix(text, suffix):
"""Remove suffix from text if matched."""
if text.endswith(suffix):
return text[:len(text) - len(suffix)]
return text
logging.basicConfig(format='%(levelname)s :: %(message)s',
level=LOG_LEVEL.get(args.log_level))
formats: List[str] = args.formats
FORBIDDEN_CHARS = args.forbidden_chars
formats = args.formats.split(',')
for frmt in formats:
if frmt not in FORMATS.keys():
if frmt not in FORMATS:
error("Unknown format name (NOT file extension), "
"check api docs for current version of your BookStack")
exit(1)
sys.exit(1)
API_PREFIX: str = f"{args.host.removesuffix(os.path.sep)}/api"
FS_PATH: str = args.path.removesuffix(os.path.sep)
LEVEL_CHOICE: list[str] = args.level.split(',')
API_PREFIX: str = f"{removesuffix(args.host, os.path.sep)}/api"
FS_PATH: str = removesuffix(args.path, os.path.sep)
LEVEL_CHOICE: List[str] = args.level
for lvl in LEVEL_CHOICE:
if lvl not in LEVELS:
error(f"Level {lvl} is not supported, can be only one of {LEVELS}")
exit(1)
sys.exit(1)
with open(args.token_file, 'r') as f:
TOKEN: str = f.readline().removesuffix('\n')
with open(args.token_file, 'r', encoding='utf-8') as f:
TOKEN: str = removesuffix(f.readline(), '\n')
HEADERS = {'Content-Type': 'application/json; charset=utf-8',
'Authorization': f"Token {TOKEN}"}
HEADERS = {
'Content-Type': 'application/json; charset=utf-8',
'Authorization': f"Token {TOKEN}",
'User-Agent': args.user_agent
}
HEADERS_NO_TOKEN = {
'Content-Type': 'application/json; charset=utf-8',
'User-Agent': args.user_agent
}
for header in args.additional_headers:
values = header.split(':', 1)
if len(values) < 2:
raise ValueError(f"Improper HTTP header specification: {header}")
HEADERS[values[0]] = values[1]
HEADERS_NO_TOKEN[values[0]] = values[1]
SKIP_TIMESTAMPS: bool = args.force_update_files
class ApiRateLimiter:
def __init__(self, rate_limit: int) -> None:
self.__rate_limit = rate_limit
info(f"API rate limit: {self.__rate_limit}/min")
self.__requests_times: List[float] = []
def limit_rate_request(self):
"""Count another request and wait minimal required time if limit is reached."""
current_time = time()
self.__requests_times.append(current_time)
# filter out requests older than 60s ago
self.__requests_times = list(
filter(lambda x: current_time - x <= 60, self.__requests_times))
# sleep until oldest remembered request is more than 60s ago
if len(self.__requests_times) > self.__rate_limit:
wait_time = self.__requests_times[0] + 60 - current_time
info(f"API Rate limit reached, waiting {round(wait_time, 2)}s")
sleep(wait_time)
api_rate_limiter = ApiRateLimiter(args.rate_limit)
class Node:
def __init__(self, name: str, parent: ['Node', None], node_id: int):
"""Clas representing any node in whole bookstack documents "tree"."""
def __init__(self, name: str, parent: Union['Node', None], node_id: int,
last_edit_timestamp: datetime):
for char in FORBIDDEN_CHARS:
name = name.replace(char, "_")
self.__name: str = name
self.__parent: ['Node', None] = parent
self.__children: List['Node'] = []
self.__parent: Union['Node', None] = parent
if parent is not None:
parent.add_child(self)
self.__last_edit_timestamp: datetime = last_edit_timestamp
self.__node_id = node_id
def get_name(self) -> str:
@property
def name(self) -> str:
"""Return name of this Shelf/Book/Chapter/Page."""
return self.__name
def get_parent(self) -> ['Node', None]:
@property
def parent(self) -> Union['Node', None]:
"""Return parent Node or None if there isn't any."""
return self.__parent
def changed_since(self, timestamp: datetime) -> int:
"""
Check if remote version have changed after given timestamp,
including its children
:param timestamp:
:return: amount of changed documents at level of this document Node
"""
result: int = 0
if self.__last_edit_timestamp > timestamp:
result += 1
for child in self.__children:
result += child.changed_since(timestamp)
return result
def get_last_edit_timestamp(self) -> datetime:
return self.__last_edit_timestamp
def set_parent(self, parent: 'Node'):
self.__parent = parent
parent.add_child(self)
def add_child(self, child: 'Node'):
self.__children.append(child)
def get_path(self) -> str:
if self.__parent is None:
return "."
return self.__parent.get_path() + os.path.sep + self.__parent.get_name()
return self.__parent.get_path() + os.path.sep + self.__parent.name
def get_id(self) -> int:
return self.__node_id
shelves: dict[int, Node] = {}
books: dict[int, Node] = {}
chapters: dict[int, Node] = {}
pages: dict[int, Node] = {}
pages_not_in_chapter: dict[int, Node] = {}
shelves: Dict[int, Node] = {}
books: Dict[int, Node] = {}
chapters: Dict[int, Node] = {}
pages: Dict[int, Node] = {}
pages_not_in_chapter: Dict[int, Node] = {}
attachments: Dict[int, Node] = {}
def api_timestamp_string_to_datetime(timestamp: str) -> datetime:
return datetime.strptime(timestamp, '%Y-%m-%dT%H:%M:%S.%fZ')
def make_dir(path: str):
@ -114,109 +280,272 @@ def make_dir(path: str):
path_obj.mkdir(exist_ok=True, parents=True)
def api_get_bytes(path: str) -> bytes:
request: Request = Request(f'{API_PREFIX}/{path}', headers=HEADERS)
def api_get_bytes(path: str, **kwargs) -> bytes:
request_path: str = f'{API_PREFIX}/{path}'
if len(kwargs) > 0:
params: str = urllib.parse.urlencode(kwargs)
request_path += f"?{params}"
debug(f"Making http request: {request_path}")
request: Request = Request(request_path, headers=HEADERS)
api_rate_limiter.limit_rate_request()
with urlopen(request) as response:
response = response
if response.status == 403:
error("403 Forbidden, check your token!")
exit(response.status)
sys.exit(response.status)
return response.read()
def api_get_dict(path: str) -> dict:
return json.loads(api_get_bytes(path).decode())
"""Make api request at specified path and return result as dict."""
data = api_get_bytes(path).decode()
return json.loads(data)
def check_if_update_needed(file: str, remote_last_edit: datetime) -> bool:
if not os.path.exists(file):
def api_get_listing(path: str) -> list:
"""Retrieve whole lists through api.
Request for another 50 until have collected "total" amount.
:param path:
:return:
"""
count: int = 50
total: int = count
result: list = []
while total > len(result):
data: dict = json.loads(
api_get_bytes(path, count=count, offset=len(result)))
total = data['total']
result += data['data']
debug(f"API listing got {len(result)} items out of maximum {count}")
return result
def check_if_update_needed(file_path: str, document: Node) -> bool:
"""Check if a Node need updating on disk, according to timestamps."""
if SKIP_TIMESTAMPS:
return True
local_last_edit: datetime = datetime.fromtimestamp(os.path.getmtime(file))
debug(f"Local file creation timestamp: {local_last_edit.date()} {local_last_edit.time()}, "
f"remote edit timestamp: {remote_last_edit.date()} {remote_last_edit.time()}")
return local_last_edit.timestamp() < remote_last_edit.timestamp()
debug(f"Checking for update for file {file_path}")
if not os.path.exists(file_path):
debug(f"Document {file_path} is missing on disk, update needed.")
return True
local_last_edit: datetime = datetime.fromtimestamp(
os.path.getmtime(file_path))
remote_last_edit: datetime = document.get_last_edit_timestamp()
debug("Local file creation timestamp: "
f"{local_last_edit.date()} {local_last_edit.time()}, "
"remote edit timestamp: "
f"{remote_last_edit.date()} {remote_last_edit.time()}")
changes: int = document.changed_since(local_last_edit)
if changes > 0:
info(f"Document \"{file_path}\" consists of {changes} "
"outdated documents, update needed.")
return True
debug(f"Document \"{file_path}\" consists of {changes} "
"outdated documents, skipping updating.")
return False
def export(files: list[Node], level: str):
for file in files:
make_dir(f"{FS_PATH}{os.path.sep}{file.get_path()}")
def export_doc(documents: List[Node], level: str):
"""Save document-like Nodes to files."""
for document in documents:
make_dir(f"{FS_PATH}{os.path.sep}{document.get_path()}")
file_info: dict = api_get_dict(f'{level}/{file.get_id()}')
last_edit_time: datetime = datetime.strptime(file_info['updated_at'], '%Y-%m-%dT%H:%M:%S.%fZ')
for v_format in formats:
path: str = f"{FS_PATH}{os.path.sep}{document.get_path()}" + \
f"{os.path.sep}{document.name}.{FORMATS[v_format]}"
for frmt in formats:
path: str = f"{FS_PATH}{os.path.sep}{file.get_path()}{os.path.sep}{file.get_name()}.{FORMATS[frmt]}"
debug(f"Checking for update for file {path}")
if not check_if_update_needed(path, last_edit_time):
debug("Already updated")
if not check_if_update_needed(path, document):
continue
data: bytes = api_get_bytes(f'{level}/{file.get_id()}/export/{frmt}')
with open(path, 'wb') as f:
data: bytes = api_get_bytes(
f'{level}/{document.get_id()}/export/{v_format}')
with open(path, 'wb') as file:
info(f"Saving {path}")
f.write(data)
file.write(data)
def export_attachments(attachments: List[Node]):
"""Save attachment Nodes to files."""
for attachment in attachments:
base_path = attachment.get_path()
if attachment.parent is None:
base_path = f'__ATTACHMENTS_FROM_DELETED_PAGES__{os.path.sep}{base_path}'
make_dir(f"{FS_PATH}{os.path.sep}{base_path}")
path: str = f"{FS_PATH}{os.path.sep}{base_path}" + \
f"{os.path.sep}{attachment.name}"
if not check_if_update_needed(path, attachment):
continue
data = api_get_bytes(f'attachments/{attachment.get_id()}')
data = json.loads(data)
content = data['content']
content_url = urllib.parse.urlparse(content)
if content_url.scheme:
if args.dont_export_external_attachments:
continue
info(f"Downloading attachment from url: {content_url.geturl()}")
request: Request = Request(content_url.geturl(),
headers=HEADERS_NO_TOKEN)
with urlopen(request) as response:
if response.status >= 300:
error(
"Could not download link-type attachment from "
f"'{content_url.geturl()}, got code {response.status}'!"
)
sys.exit(response.status)
with open(path, 'wb') as file:
info(f"Saving {path}")
file.write(response.read())
else:
with open(path, 'wb') as file:
info(f"Saving {path}")
file.write(base64.b64decode(content))
#########################
# Gathering data from api
#########################
info("Getting info about Shelves and their Books")
for shelf_data in api_get_dict('shelves').get('data'):
shelf = Node(shelf_data.get('name'), None, shelf_data.get('id'))
for shelf_data in api_get_listing('shelves'):
last_edit_ts: datetime = api_timestamp_string_to_datetime(
shelf_data['updated_at'])
shelf = Node(shelf_data.get('name'), None, shelf_data.get('id'),
last_edit_ts)
debug(f"Shelf: \"{shelf.name}\", ID: {shelf.get_id()}")
shelves[shelf.get_id()] = shelf
shelf_details = api_get_dict(f'shelves/{shelf.get_id()}')
if shelf_details.get('books') is None:
continue
for book_data in shelf_details.get('books'):
book = Node(book_data.get('name'), shelf, book_data.get('id'))
for book_data in shelf_details['books']:
last_edit_ts: datetime = api_timestamp_string_to_datetime(
book_data['updated_at'])
book = Node(book_data.get('name'), shelf, book_data.get('id'),
last_edit_ts)
debug(f"Book: \"{book.name}\", ID: {book.get_id()}")
books[book.get_id()] = book
info("Getting info about Books not belonging to any shelf")
for book_data in api_get_dict('books').get('data'):
if book_data.get('id') in books.keys():
for book_data in api_get_listing('books'):
if book_data.get('id') in books:
continue
book = Node(book_data.get('name'), None, book_data.get('id'))
info(f"Book \"{book.get_name()} has no shelf assigned.\"")
last_edit_ts: datetime = api_timestamp_string_to_datetime(
book_data['updated_at'])
book = Node(book_data.get('name'), None, book_data.get('id'), last_edit_ts)
debug(f"Book: \"{book.name}\", ID: {book.get_id()}, "
f"last edit: {book.get_last_edit_timestamp()}")
info(f"Book \"{book.name} has no shelf assigned.\"")
books[book.get_id()] = book
info("Getting info about Chapters")
for chapter_data in api_get_dict('chapters').get('data'):
chapter = Node(chapter_data.get('name'), books.get(chapter_data.get('book_id')), chapter_data.get('id'))
for chapter_data in api_get_listing('chapters'):
last_edit_ts: datetime = api_timestamp_string_to_datetime(
chapter_data['updated_at'])
chapter = Node(chapter_data.get('name'),
books.get(chapter_data.get('book_id')),
chapter_data.get('id'), last_edit_ts)
debug(f"Chapter: \"{chapter.name}\", ID: {chapter.get_id()},"
f" last edit: {chapter.get_last_edit_timestamp()}")
chapters[chapter.get_id()] = chapter
info("Getting info about Pages")
for page_data in api_get_dict('pages').get('data'):
for page_data in api_get_listing('pages'):
parent_id = page_data.get('chapter_id')
if parent_id not in chapters.keys():
parent_id = page_data.get('book_id')
info(f"Page \"{page_data.get('name')}\" is not in any chapter, "
f"using Book \"{books.get(parent_id).get_name()}\" as a parent.")
page = Node(page_data.get('name'), books.get(parent_id), page_data.get('id'))
last_edit_ts: datetime = api_timestamp_string_to_datetime(
page_data['updated_at'])
if parent_id not in chapters:
parent = books[page_data['book_id']]
page = Node(page_data.get('name'), parent, page_data.get('id'),
last_edit_ts)
info(f"Page \"{page.name}\" is not in any chapter, "
f"using Book \"{parent.name}\" as a parent.")
debug(f"Page: \"{page.name}\", ID: {page.get_id()},"
f" last edit: {page.get_last_edit_timestamp()}")
pages[page.get_id()] = page
pages_not_in_chapter[page.get_id()] = page
continue
page = Node(page_data.get('name'), chapters.get(parent_id), page_data.get('id'))
page = Node(page_data.get('name'), chapters.get(parent_id),
page_data.get('id'), last_edit_ts)
debug(f"Page: \"{page.name}\", ID: {page.get_id()}, "
f"last edit: {page.get_last_edit_timestamp()}")
pages[page.get_id()] = page
files: list[Node] = []
export_pages_not_in_chapter: bool = False
if not args.dont_export_attachments:
info("Getting info about Attachments.")
for attachment_data in api_get_listing('attachments'):
last_edit_ts: datetime = api_timestamp_string_to_datetime(
attachment_data['updated_at'])
all_pages = {}
all_pages.update(pages)
all_pages.update(pages_not_in_chapter)
attachment = Node(attachment_data.get('name'),
all_pages.get(attachment_data.get('uploaded_to')),
attachment_data.get('id'), last_edit_ts)
debug(f"Attachment: \"{attachment.name}\", ID: {attachment.get_id()},"
f" last edit: {attachment.get_last_edit_timestamp()}")
attachments[attachment.get_id()] = attachment
#########################
# Exporting data from api
#########################
files: List[Node] = []
EXPORT_PAGES_NOT_IN_CHAPTER: bool = False
for lvl in LEVEL_CHOICE:
if lvl == 'pages':
files = pages.values()
files = list(pages.values())
elif lvl == 'chapters':
files = chapters.values()
export_pages_not_in_chapter = True
files = list(chapters.values())
EXPORT_PAGES_NOT_IN_CHAPTER = True
elif lvl == 'books':
files = books.values()
export(files, lvl)
files = list(books.values())
if export_pages_not_in_chapter:
export_doc(files, lvl)
if EXPORT_PAGES_NOT_IN_CHAPTER:
info("Exporting pages that are not in chapter...")
export(pages_not_in_chapter.values(), 'pages')
export_doc(list(pages_not_in_chapter.values()), 'pages')
if not args.dont_export_attachments:
export_attachments(list(attachments.values()))
info("Finished")
sys.exit(0)