Support immutable titles.
This commit is contained in:
Arun Prakash Jana
parent
e198fd3dc9
commit
870bdd6957
@ -152,6 +152,9 @@ Shell completion scripts for Bash, Fish and Zsh can be found in respective subdi
|
||||
-a: do not set title, -u: clear title
|
||||
-c, --comment [...] description of the bookmark, works with
|
||||
-a, -u; clears comment, if no arguments
|
||||
--immutable N disable title fetch from web during update
|
||||
works with -a, -u
|
||||
N=0: mutable (default), N=1: immutable
|
||||
|
||||
search options:
|
||||
-s, --sany keyword [...]
|
||||
@ -218,7 +221,7 @@ Shell completion scripts for Bash, Fish and Zsh can be found in respective subdi
|
||||
- **Update** operation:
|
||||
- If --title, --tag or --comment is passed without argument, clear the corresponding field from DB.
|
||||
- If --url is passed (and --title is omitted), update the title from web using the URL.
|
||||
- If indices are passed without any other options (--url, --title, --tag and --comment), read the URLs from DB and update titles from web.
|
||||
- If indices are passed without any other options (--url, --title, --tag, --comment and --immutable), read the URLs from DB and update titles from web. Bookmarks marked immutable are skipped.
|
||||
- **Delete** operation:
|
||||
- When a record is deleted, the last record is moved to the index.
|
||||
- Delete doesn't work with range and indices provided together as arguments. It's an intentional decision to avoid extra sorting, in-range checks and to keep the auto-DB compaction functionality intact. On the same lines, indices are deleted in descending order.
|
||||
@ -308,9 +311,9 @@ Once exported, import the html file in your browser.
|
||||
+ Informative website on Linux and open source
|
||||
# linux news,open source
|
||||
where, >: title, +: comment, #: tags
|
||||
2. **Add** a bookmark with tags `linux news` and `open source` & **custom title** `Linux magazine`:
|
||||
2. **Add** a bookmark with tags `linux news` and `open source` & **immutable custom title** `Linux magazine`:
|
||||
|
||||
$ buku -a http://tuxdiary.com linux news, open source -t 'Linux magazine'
|
||||
$ buku -a http://tuxdiary.com linux news, open source -t 'Linux magazine' --immutable 1
|
||||
Added at index 15012014
|
||||
Note that URL must precede tags.
|
||||
3. **Add** a bookmark **without a title** (works for update too):
|
||||
|
||||
61
buku
61
buku
@ -287,18 +287,17 @@ class BukuCrypt:
|
||||
|
||||
class BukuDb:
|
||||
|
||||
def __init__(self, json=False, field_filter=0):
|
||||
def __init__(self, json=False, field_filter=0, immutable=-1):
|
||||
'''Database initialization API
|
||||
|
||||
:param json: print results in json format
|
||||
:param field_filter: bookmark print format specifier
|
||||
'''
|
||||
|
||||
conn, cur = BukuDb.initdb()
|
||||
self.conn = conn
|
||||
self.cur = cur
|
||||
self.conn, self.cur = BukuDb.initdb()
|
||||
self.json = json
|
||||
self.field_filter = field_filter
|
||||
self.immutable = immutable
|
||||
|
||||
@staticmethod
|
||||
def get_dbdir_path():
|
||||
@ -400,6 +399,18 @@ class BukuDb:
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
'''Add flags column in existing DB
|
||||
Introduced in v2.7 to handle immutable title
|
||||
Designed to be extended in future using bitwise masks
|
||||
Masks:
|
||||
0b00000001: set title immutable'''
|
||||
try:
|
||||
query = 'ALTER TABLE bookmarks ADD COLUMN flags integer default 0'
|
||||
cur.execute(query)
|
||||
conn.commit()
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
return (conn, cur)
|
||||
|
||||
def get_bm_by_id(self, index):
|
||||
@ -476,9 +487,13 @@ class BukuDb:
|
||||
desc = ''
|
||||
|
||||
try:
|
||||
query = 'INSERT INTO bookmarks(URL, metadata, tags, desc) \
|
||||
VALUES (?, ?, ?, ?)'
|
||||
self.cur.execute(query, (url, meta, tags_in, desc))
|
||||
flagset = 0
|
||||
if self.immutable == 1:
|
||||
flagset |= self.immutable
|
||||
|
||||
query = 'INSERT INTO bookmarks(URL, metadata, tags, desc, flags) \
|
||||
VALUES (?, ?, ?, ?, ?)'
|
||||
self.cur.execute(query, (url, meta, tags_in, desc, flagset))
|
||||
if not delay_commit:
|
||||
self.conn.commit()
|
||||
if verbose:
|
||||
@ -618,14 +633,26 @@ class BukuDb:
|
||||
arguments += (desc,)
|
||||
to_update = True
|
||||
|
||||
# Update immutable flag if passed as argument
|
||||
if self.immutable != -1:
|
||||
flagset = 1
|
||||
if self.immutable:
|
||||
query = '%s flags = flags | ?,' % query
|
||||
else:
|
||||
query = '%s flags = flags & ?,' % query
|
||||
flagset = ~flagset
|
||||
|
||||
arguments += (flagset,)
|
||||
to_update = True
|
||||
|
||||
# Update title
|
||||
#
|
||||
# 1. if -t has no arguments, delete existing title
|
||||
# 2. if -t has arguments, update existing title
|
||||
# 3. if -t option is omitted at cmdline:
|
||||
# if URL is passed, update the title from web using the URL
|
||||
# 4. if no other argument (url, tag, comment) passed,
|
||||
# update title from web using DB URL
|
||||
# 4. if no other argument (url, tag, comment, immutable) passed,
|
||||
# update title from web using DB URL (if title is mutable)
|
||||
meta = None
|
||||
if title_in is not None:
|
||||
meta = title_in
|
||||
@ -686,10 +713,11 @@ class BukuDb:
|
||||
'''
|
||||
|
||||
if index == 0:
|
||||
self.cur.execute('SELECT id, url FROM bookmarks ORDER BY id ASC')
|
||||
self.cur.execute('SELECT id, url FROM bookmarks WHERE \
|
||||
flags & 1 != 1 ORDER BY id ASC')
|
||||
else:
|
||||
self.cur.execute('SELECT id, url FROM bookmarks WHERE id = ?',
|
||||
(index,))
|
||||
self.cur.execute('SELECT id, url FROM bookmarks WHERE id = ? AND \
|
||||
flags & 1 != 1', (index,))
|
||||
|
||||
resultset = self.cur.fetchall()
|
||||
query = 'UPDATE bookmarks SET metadata = ? WHERE id = ?'
|
||||
@ -1878,7 +1906,10 @@ if __name__ == '__main__':
|
||||
if no arguments:
|
||||
-a: do not set title, -u: clear title
|
||||
-c, --comment [...] description of the bookmark, works with
|
||||
-a, -u; clears comment, if no arguments''')
|
||||
-a, -u; clears comment, if no arguments
|
||||
--immutable N disable title fetch from web during update
|
||||
works with -a, -u
|
||||
N=0: mutable (default), N=1: immutable''')
|
||||
addarg = edit_grp.add_argument
|
||||
addarg('--url', nargs=1, dest='url', metavar='url', help=argparse.SUPPRESS)
|
||||
addarg('--tag', nargs='*', dest='tag', action=CustomTagAction,
|
||||
@ -1887,6 +1918,8 @@ if __name__ == '__main__':
|
||||
metavar='title', help=argparse.SUPPRESS)
|
||||
addarg('-c', '--comment', nargs='*', dest='desc', type=str,
|
||||
action=CustomDescAction, metavar='desc', help=argparse.SUPPRESS)
|
||||
addarg('--immutable', type=int, default=-1,
|
||||
choices=[0, 1], metavar='N', help=argparse.SUPPRESS)
|
||||
|
||||
# Search options group
|
||||
search_grp = argparser.add_argument_group(
|
||||
@ -2009,7 +2042,7 @@ if __name__ == '__main__':
|
||||
BukuCrypt.decrypt_file(args.decrypt)
|
||||
|
||||
# Initialize the database and get handles
|
||||
bdb = BukuDb(args.json_output, args.field_filter)
|
||||
bdb = BukuDb(args.json_output, args.field_filter, args.immutable)
|
||||
|
||||
# Add a record
|
||||
if args.addurl is not None:
|
||||
|
||||
19
buku.1
19
buku.1
@ -35,16 +35,16 @@ URLs are unique in DB. The same URL cannot be added twice.
|
||||
\fITags\fR:
|
||||
- Comma (',') is the tag delimiter in DB. A tag cannot have comma(s) in it. Tags are filtered (for unique tags) and sorted. Tags can be replaced.
|
||||
.PP
|
||||
\fIUpdate\fR operation:
|
||||
- If --title, --tag or --comment is passed without argument, clear the corresponding field from DB.
|
||||
- If --url is passed (and --title is omitted), update the title from web using the URL.
|
||||
- If indices are passed without any other options (--url, --title, --tag, --comment and --immutable), read the URLs from DB and update titles from web. Bookmarks marked immutable are skipped.
|
||||
.PP
|
||||
\fIDelete\fR operation:
|
||||
- When a record is deleted, the last record is moved to the index.
|
||||
- Delete doesn't work with range and indices provided together as arguments. It's an intentional decision to avoid extra sorting, in-range checks and to keep the auto-DB compaction functionality intact. On the same lines, indices are deleted in descending order.
|
||||
- Can delete bookmarks matching a search, when combined with any of the search options.
|
||||
.PP
|
||||
\fIUpdate\fR operation:
|
||||
- If --title, --tag or --comment is passed without argument, clear the corresponding field from DB.
|
||||
- If --url is passed (and --title is omitted), update the title from web using the URL.
|
||||
- If indices are passed without any other options (--url, --title, --tag and --comment), read the URLs from DB and update titles from web.
|
||||
.PP
|
||||
\fISearch\fR works in mysterious ways:
|
||||
- Case-insensitive.
|
||||
- Matches exact words in URL, title and tags.
|
||||
@ -84,6 +84,9 @@ Manually specify the title, works with --add, --update. Omits or clears the titl
|
||||
.TP
|
||||
.BI \-c " " \--comment " [...]"
|
||||
Add comment or description on the bookmark, works with --add, --update. Clears the comment, if no arguments passed.
|
||||
.TP
|
||||
.BI \--immutable " N"
|
||||
Set the title of a bookmark immutable during updates. Works with --add, --update. N=1 sets the immutable flag, N=0 removes it. If omitted, bookmarks are added with N=0.
|
||||
.SH SEARCH OPTIONS
|
||||
.TP
|
||||
.BI \-s " " \--sany " keyword [...]"
|
||||
@ -149,7 +152,7 @@ Replace
|
||||
.I oldtag
|
||||
with
|
||||
.I newtag
|
||||
if both are passed, delete
|
||||
if both are passed; delete
|
||||
.I oldtag
|
||||
if
|
||||
.I newtag
|
||||
@ -196,11 +199,11 @@ Overrides the default browser. Ref:
|
||||
In the output, >: title, +: comment, #: tags.
|
||||
.PP
|
||||
.IP 2. 4
|
||||
\fBAdd\fR a bookmark with tags 'linux news' and 'open source' & \fBcustom title\fR 'Linux magazine':
|
||||
\fBAdd\fR a bookmark with tags 'linux news' and 'open source' & \fBimmutable custom title\fR 'Linux magazine':
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -a http://tuxdiary.com linux news, open source -t 'Linux magazine'
|
||||
.B buku -a http://tuxdiary.com linux news, open source -t 'Linux magazine' --immutable 1
|
||||
.EE
|
||||
.PP
|
||||
.IP "" 4
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user