wassname/xbsjsonedit
1
0
Fork 0
mirror of https://github.com/wassname/xbsjsonedit.git synced 2026-06-27 17:18:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'v0.4'

Browse Source
This commit is contained in:
cjnaz
2020-03-30 23:10:57 -07:00
parent a11996e0f6 9425caece7
commit ff02dc02e5
4 changed files with 150 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.vscode/settings.json
Vendored
+7
View File
@@ -0,0 +1,7 @@
{
"cSpell.words": [
"digin",
"xbrowsersync",
"xbsjsonedit"
]
}
LICENSE.txt
Executable → Regular
View File
README.md
Executable → Regular
+14 -23
View File
@@ -9,21 +9,18 @@ If you want it to do other functions, grab the code and go for it.
## Usage
```
$ ./xbsjsonedit -h
usage: xbsjsonedit [-h] [--Print] [--Tags-Print] [--Tags-Count TAGS_COUNT]
[-V]
Infile
usage: xbsjsonedit [-h] [--print] [--tags TAGS] [--names] [-V] Infile
xBrowserSync json backup editor
positional arguments:
Infile json backup file
Infile json backup file.
optional arguments:
-h, --help show this help message and exit
--Print, -p Print bookmark hierarchy (redirect to less or a file)
--Tags-Print, -t Print tags list
--Tags-Count TAGS_COUNT, -c TAGS_COUNT
Filter Tags-List for min number of times a tag is used (defult 2). =0 prints only single use tags.
--print, -p Print bookmark hierarchy (redirect to less or a file).
--tags TAGS, -t TAGS Print tags list filtered by tags with a minimum <n> number of uses. n=0 prints only single use tags.
--names, -n Used with --tags to enable printing the titles/names for each tag.
-V, --version Return version number and exit.
```
@@ -69,35 +66,29 @@ Five modes are supported Listing/Deleting based on:
The Print function prints the full list of bookmarks in folder hierarchical form, listing the ID number and Title of each folder and bookmark. The `--Print` switch may be used for getting a good visual dump of the bookmarks in less or an editor for reference while using the interactive mode. The tags on each bookmark are listed as well.
The `--Tags-Print` switch prints bookmarks by tag name, where a minimum of 2 bookmarks share the same tag, as set by the `--Tags-Count` switch. Setting `--Tags-Count 1` prints all bookmarks with tags. Setting `--Tags-Count 0` prints all bookmarks with only one tag - useful for finding remnant tags.
The `--tags <n>` switch prints each tag where the number of bookmarks with that tag >= `<n>`. Optionally include the `--names` switch to list the bookmark titles/names for each tag. `--tags 0` is a special case that prints only tags that have exactly one occurrence, which may be useful for finding extraneous/remnant tags usage.
A lower case letter `t/g/d/f/x/y` will list the offenders, while an upper case letter
`T/G/D/F/X/Y` will allow for selective deletes of the offenders. The lower case List operation
need not be run before running the upper case Delete operation.
`T/G/D/F/X/Y` will allow for selective deletes of the offenders. The lower case List operation need not be run before running the upper case Delete operation.
Delete functions support individual bookmark selection, or all that match the selection mode.
You cannot do any damage to the original bookmark file during a session, so experiment and poke
around.
You cannot do any damage to the original bookmark file during a session, so experiment and poke around.
When deleting empty folders you may find that you need to repeat the operation a few times.
This happens when there are folders within folders that contain no bookmarks. The lower folder
must be deleted before the next higher folder is seen as empty. Just repeat the folder deletes
until the Matches count is 0.
This happens when there are folders within folders that contain no bookmarks. The lower folder must be deleted before the next higher folder is seen as empty. Just repeat the folder deletes until the Matches count is 0.
The output file defaults to the Infile + "_OUT", and can be specified during the write operation.
You may want to write out intermediate editing results to save work done up to that point.
The output format is "pretty printed" json for readability, and is accepted by the
xBrowserSync app Restore function via copy/paste. Note: xBrowserSync will allow you to restore
to (blast) your current
syncID, so you may want to Disable Sync, then create a new sync before restoring the modified bookmarks. **NOTE** that tags are not restored if sync is disabled. To recover, simply enable sync and do another restore.
The output file defaults to the Infile + "_OUT", and can be specified during the write operation. You may want to write out intermediate editing results to save work done up to that point. The output format is "pretty printed" json for readability, and is accepted by the xBrowserSync app Restore function via copy/paste.
- **Note** [_may no longer be the case_]: xBrowserSync will allow you to restore to (blast) your current syncID, so you may want to Disable Sync, then create a new sync before restoring the modified bookmarks.
- **NOTE** that tags are not restored by xBrowserSync if sync is disabled. To recover, simply enable sync and do another restore.
## Known issues:
- This code only works with Python 3. Development and testing was done on Linux with Python 3.7.3.
- This code only works with Python 3. Development and testing was done on Linux with Python 3.7.3. Limited testing was done on Windows with Python 3.8.0.
## Version history
- 200329 v1.0 Merged pull request #3 from mblais (add unbuffered getch input; add 'all' option), Reworked --tags and --names switches.
- 191206 v0.3 Added tags dump
- 191205 v0.2 Updated to xbrowsersync v1.5 and Python 3.x ONLY
- 181128 v0.1 New
xbsjsonedit
+129 -67
View File
@@ -1,20 +1,20 @@
#!/usr/bin/env python
# -*- coding: UTF-8 -*-
#!/usr/bin/env python3
"""xBrowserSync json backup editor"""
__version__ = "v0.3 191206"
__version__ = "v1.0 200330"
#==========================================================
#
# Chris Nelson 2018 - 2019
#
# 200330 v1.0 Merged pull request #3 from mblais (add unbuffered getch input; add 'all' option), Reworked --tags and --names switches.
# 191206 v0.3 Added tags dump
# 191205 v0.2 Updated to xbrowsersync v1.5 and Python 3.x ONLY
# 181128 v0.1 New
#
# Issues, and changes pending
# None
#
#
#==========================================================
import argparse
@@ -30,7 +30,6 @@ INDENT = 2
OFILESUFFIX = "_OUT"
NONE_SEARCH = "__NONE__"
# Global items
url_dict = {}
folder_dict = {}
@@ -45,27 +44,31 @@ def main():
global url_dict
global folder_dict
global tags_dict
with io.open(args.Infile, encoding='utf8', errors="replace") as json_data:
json_dict = json.load(json_data)
term = NONE_SEARCH
if args.Print:
if args.print:
digin(parent=json_dict["xbrowsersync"]["data"]["bookmarks"], parent_id="", path="/", search_term="", operation="printtree")
exit()
if args.Tags_Print:
if args.tags > -1:
digin(parent=json_dict["xbrowsersync"]["data"]["bookmarks"], parent_id="", path="/", search_term="", operation="GatherTags")
for tag in sorted(tags_dict.keys()):
if args.Tags_Count == 0:
if args.tags == 0:
if len(tags_dict[tag]) == 1:
print ("\n[{}]:".format(tag))
print (" {:<4} - {}".format(tags_dict[tag][0]["id"], tags_dict[tag][0]["title"]))
print ("[{}] (1):".format(tag))
if args.names:
print (" {:<4} - {}".format(tags_dict[tag][0]["id"], tags_dict[tag][0]["title"]))
print()
else:
if len(tags_dict[tag]) >= args.Tags_Count:
print ("\n[{}]:".format(tag))
for bookmark in tags_dict[tag]:
print (" {:<4} - {}".format(bookmark["id"], bookmark["title"]))
if len(tags_dict[tag]) >= args.tags:
print ("[{}] ({}):".format(tag, len(tags_dict[tag])))
if args.names:
for bookmark in tags_dict[tag]:
print (" {:<4} - {}".format(bookmark["id"], bookmark["title"]))
print()
exit()
while (1):
@@ -95,18 +98,17 @@ Options:
y: List empty folders (may arise if all children were deleted)
Y: Delete empty folders
w: Write out the bookmarks data to a file
q: Quit/exit (Do a Write first!)
""".format(term))
select = prompt("Enter option: ")
select = prompt("Enter option: ", valid="stTgGdDfFxXyYwq")
if select == 'p':
digin(parent=json_dict["xbrowsersync"]["data"]["bookmarks"], parent_id="", path="/", search_term="", operation="printtree")
elif select == 's':
term = prompt("Search for (empty to clear search term): ").lower()
term = prompt_long("Search for (empty to clear search term): ").lower()
if term == "":
term = NONE_SEARCH
elif select == 't':
@@ -164,17 +166,17 @@ Options:
print ("\nMatches: {} Deletes: {}\n".format(match_cnt, change_cnt))
elif select == 'w':
ans = prompt("Output file name (default <{}>: ".format(args.Infile + OFILESUFFIX))
ans = prompt_long("Output file name (default <{}>: ".format(args.Infile + OFILESUFFIX))
if ans == "":
ans = args.Infile + OFILESUFFIX
with io.open(ans, "w", encoding='utf8') as ofile:
json.dump(json_dict, ofile, ensure_ascii=False, indent=2)
elif select == 'q':
exit()
if prompt("Quit now? (Remember to write any changes first!) ", valid="yn") == 'y':
exit()
else:
print ("Invalid option {}".format(select))
print ("Shouldn't have gotten here!")
exit()
def digin(parent, parent_id, path, search_term, operation, commit=False, indent=""):
@@ -186,7 +188,7 @@ def digin(parent, parent_id, path, search_term, operation, commit=False, indent=
item_index = -1
ans = 'n'
for item in parent:
item_index += 1
@@ -194,8 +196,9 @@ def digin(parent, parent_id, path, search_term, operation, commit=False, indent=
if operation == "printtree":
print ("{:<4} > {}{}".format(item["id"], indent, item["title"]))
if operation == "SearchFolders":
# local_changes = False
if search_term in item["title"].lower():
print ("{:<4} > {}{}".format(item["id"], indent, item["title"]))
match_cnt += 1
@@ -203,7 +206,7 @@ def digin(parent, parent_id, path, search_term, operation, commit=False, indent=
if do_all:
ans = 'y'
else:
ans = prompt("Confirm delete for this item ('y'es, 'a'll, or 'q'uit, default no) ").lower()
ans = prompt("Confirm delete for this item ('y'es, 'a'll, or 'q'uit, default 'n'o) ", valid="yaqn\r")
if ans == 'a':
do_all = True
ans = 'y'
@@ -211,12 +214,10 @@ def digin(parent, parent_id, path, search_term, operation, commit=False, indent=
collect_items (path + parent_id, parent, item_index)
change_cnt += 1
if ans == 'q':
if prompt("Discard pending deletes ('y'es, default no)? ").lower() == 'y':
if prompt("Discard pending deletes ('y'es, default 'n'o)? ", valid="yn\n") == 'y':
path_dict = {}
return -1
if operation == "FolderTags":
if "tags" in item:
print ("\n{:4} - {} >>> {}\n {}".format(
@@ -234,7 +235,7 @@ def digin(parent, parent_id, path, search_term, operation, commit=False, indent=
if do_all:
ans = 'y'
else:
ans = prompt("Confirm immediate delete of tags on this folder ('y'es, 'a'll, or 'q'uit, default no) ").lower()
ans = prompt("Confirm immediate delete of tags on this folder ('y'es, 'a'll, or 'q'uit, default 'n'o) ", valid="yaqn\r")
if ans == 'a':
do_all = True
ans = 'y'
@@ -243,7 +244,7 @@ def digin(parent, parent_id, path, search_term, operation, commit=False, indent=
change_cnt += 1
if ans == 'q':
return -1
if operation == "EmptyFolders":
if len(item["children"]) == 0:
print ("\n{:4} - {} >>> {}".format(
@@ -255,7 +256,7 @@ def digin(parent, parent_id, path, search_term, operation, commit=False, indent=
if do_all:
ans = 'y'
else:
ans = prompt("Confirm delete of this empty folder ('y'es, 'a'll, or 'q'uit, default no) ").lower()
ans = prompt("Confirm delete of this empty folder ('y'es, 'a'll, or 'q'uit, default 'n'o) ", valid="yaqn\r")
if ans == 'a':
do_all = True
ans = 'y'
@@ -263,7 +264,7 @@ def digin(parent, parent_id, path, search_term, operation, commit=False, indent=
collect_items (path + parent_id, parent, item_index)
change_cnt += 1
if ans == 'q':
if prompt("Discard pending deletes ('y'es, default no)? ").lower() == 'y':
if prompt("Discard pending deletes ('y'es, default 'n'o) ", valid="yn\r") == 'y':
path_dict = {} # TODO
return -1
@@ -321,7 +322,7 @@ def digin(parent, parent_id, path, search_term, operation, commit=False, indent=
if do_all:
ans = 'y'
else:
ans = prompt("Confirm delete for this item ('y'es, 'a'll, or 'q'uit, default no) ").lower()
ans = prompt("Confirm delete for this item ('y'es, 'a'll, or 'q'uit, default 'n'o) ", valid="yaqn\r")
if ans == 'a':
do_all = True
ans = 'y'
@@ -329,7 +330,7 @@ def digin(parent, parent_id, path, search_term, operation, commit=False, indent=
collect_items (path + parent_id, parent, item_index)
change_cnt += 1
if ans == 'q':
if prompt("Discard pending deletes ('y'es, default no)? ").lower() == 'y':
if prompt("Discard pending deletes ('y'es, default 'n'o) ", valid="yn\r") == 'y':
path_dict = {}
return -1
@@ -359,19 +360,16 @@ def collect_items (path, parent, index):
def delete_items ():
"""Delete queued-up items by collect_items.
Note: Items in lists that are to be deleted must be deleted from the highest
Note: Items in lists that are to be deleted must be deleted from the highest
index / item number to the lowest, else the index numbers will be wrong, resulting
in garbage. This is the purpose of the collect_items and delete_items functions.
"""
global path_dict
for path in path_dict:
xxx = path_dict[path]["index"]
## print path
## print xxx
xxx.sort(reverse=True)
for _index in xxx:
## print path_dict[path]["parent"]
del path_dict[path]["parent"][_index]
path_dict = {}
@@ -391,24 +389,33 @@ def dup_folders (commit=False):
global change_cnt
global folder_dict
global path_dict
yes_all = False
for folder in folder_dict:
if len(folder_dict[folder]["instance"]) > 1:
print ("-------------------------------------------------\n{}".format(folder))
for instance in folder_dict[folder]["instance"]:
for instance in sorted(folder_dict[folder]["instance"], key=lambda k: k['id']): # Sort id numbers so that lowest is kept for 'a'll mode
print (" {:>4} - {}".format(instance["id"], instance["path"]))
match_cnt += 1
if commit:
print ("")
for instance in folder_dict[folder]["instance"]:
print (" {:>4} - {}".format(instance["id"], instance["path"]))
ans = prompt ("Confirm delete for this item ('y'es, 'q'uit, 's'kip to next URL - default no) ").lower()
if ans == 'y':
first_instance = True
for instance in sorted(folder_dict[folder]["instance"], key=lambda k: k['id']):
if first_instance and yes_all:
first_instance = False
continue # When yes_all is active, always keep first instance of duplicate folders
first_instance = False
if not yes_all:
print (" {:>4} - {}".format(instance["id"], instance["path"]))
ans = prompt ("Confirm delete for this item ('y'es, 'q'uit, 's'kip to next URL, 'a'll - default 'n'o) ", valid="yqsan\r")
if ans == 'a':
yes_all = True
if ans == 'y' or yes_all:
collect_items (instance["path"], instance["parent"], instance["item_index"])
change_cnt += 1
if ans == 's':
break
if ans == 'q':
if prompt("Discard pending deletes ('y'es, default no)? ").lower() == 'y':
if prompt("Discard pending deletes ('y'es, default 'n'o) ", valid="yn\r") == 'y':
path_dict = {}
return -1
@@ -427,34 +434,89 @@ def dup_urls (commit=False):
global match_cnt
global change_cnt
global path_dict
yes_all = False
for url in url_dict:
if len(url_dict[url]["instance"]) > 1:
print ("-------------------------------------------------\n{}".format(url))
for instance in url_dict[url]["instance"]:
for instance in sorted(url_dict[url]["instance"], key=lambda k: k['id']): # Sort id numbers so that lowest is kept for 'a'll mode
print (" {:>4} - {}".format(instance["id"], instance["path"]))
match_cnt += 1
if commit:
print ("")
for instance in url_dict[url]["instance"]:
print (" {:>4} - {}".format(instance["id"], instance["path"]))
ans = prompt ("Confirm delete for this item ('y'es, 'q'uit, 's'kip to next URL - default no) ").lower()
if ans == 'y':
first_instance = True
for instance in sorted(url_dict[url]["instance"], key=lambda k: k['id']):
if first_instance and yes_all:
first_instance = False
continue # When yes_all is active, always keep first instance of duplicate bookmarks
first_instance = False
if not yes_all:
print (" {:>4} - {}".format(instance["id"], instance["path"]))
ans = prompt ("Confirm delete for this item ('y'es, 'q'uit, 's'kip to next URL, 'a'll - default 'n'o) ", valid="yqsan\r")
if ans == 'a':
yes_all = True
if ans == 'y' or yes_all:
collect_items (instance["path"], instance["parent"], instance["item_index"])
change_cnt += 1
if ans == 's':
break
if ans == 'q':
if prompt("Discard pending deletes ('y'es, default no)? ").lower() == 'y':
if prompt("Discard pending deletes ('y'es, default 'n'o) ", valid="yn\r") == 'y':
path_dict = {}
return -1
def prompt (prompt_text):
# if sys.version_info[0] < 3:
# return (raw_input(prompt_text))
# else:
return (input(prompt_text))
def prompt_long (prompt_text):
return (input(prompt_text))
def prompt (prompt_text, valid=None):
print(prompt_text, end='', flush=True)
select = getch()
if valid is not None:
while select not in valid:
xx = list(valid)
yy = ", ".join(xx).replace("\r", "enter")
print("\nInvalid input - expecting one of <{}>: ".format(yy), end='', flush=True)
select = getch()
print(select)
return select
class _Getch:
"""Gets a single character from standard input. Does not echo to the screen.
"""
def __init__(self):
try:
self.impl = _GetchWindows()
except ImportError:
self.impl = _GetchUnix()
def __call__(self): return self.impl()
class _GetchUnix:
def __init__(self):
import tty, sys
def __call__(self):
import sys, tty, termios
fd = sys.stdin.fileno()
old_settings = termios.tcgetattr(fd)
try:
tty.setraw(sys.stdin.fileno())
ch = sys.stdin.read(1)
finally:
termios.tcsetattr(fd, termios.TCSADRAIN, old_settings)
return ch
class _GetchWindows:
def __init__(self):
import msvcrt
def __call__(self):
import msvcrt
# return msvcrt.getch()
return msvcrt.getch().decode("utf-8")
getch = _Getch()
# def get_item (path):
@@ -490,7 +552,7 @@ def prompt (prompt_text):
# tags = ""
# if "tags" in xxx:
# tags = xxx["tags"]
# tags = xxx["tags"]
# return {
# "title" : xxx["title"],
@@ -499,18 +561,18 @@ def prompt (prompt_text):
# "tags" : tags,
# "text_full_path": text_full_path
# }
if __name__ == '__main__':
parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawTextHelpFormatter)
parser.add_argument('Infile',
help="json backup file")
parser.add_argument('--Print', '-p', action='store_true',
help="Print bookmark hierarchy (redirect to less or a file)")
parser.add_argument('--Tags-Print', '-t', action='store_true',
help="Print tags list")
parser.add_argument('--Tags-Count', '-c', default=2, type=int,
help="Filter Tags-List for min number of times a tag is used (defult 2). =0 prints only single use tags.")
help="json backup file.")
parser.add_argument('--print', '-p', action='store_true',
help="Print bookmark hierarchy (redirect to less or a file).")
parser.add_argument('--tags', '-t', type=int, default=-1,
help="Print tags list filtered by tags with a minimum <n> number of uses. n=0 prints only single use tags.")
parser.add_argument('--names', '-n', action='store_true',
help="Used with --tags to enable printing the titles/names for each tag.")
parser.add_argument('-V', '--version',
help="Return version number and exit.",
action='version',