Commit graph

218 commits

Author SHA1 Message Date
CismonX
552a5797dc
doc: refactor style 2025-03-16 11:32:32 +08:00
CismonX
7ae2b283c3
bookmarkctl: add sub-commands for xattr
Provides platform-agnostic command-line interface for managing
extended attributes on a BookmarkFS filesystem.
2025-03-15 17:25:26 +08:00
CismonX
402cc1a304
doc: misc update (mostly style improvements) 2025-03-14 08:20:33 +08:00
CismonX
f6e3b743d1
build: rename autoconf helper macros
These macros are supposed to be reusable for other projects.
Also, a shorter name improves the readability of the config script.
2025-03-14 07:44:51 +08:00
CismonX
2ce0be8a18
bookmarkctl: better handling of command-line args 2025-03-13 14:45:10 +08:00
CismonX
68aafe3d8d
frontend: add helper macros for getopt() 2025-03-13 07:55:35 +08:00
CismonX
bd343ddf4b
backend_firefox: fix integer parsing 2025-03-12 17:22:54 +08:00
CismonX
0a4ff8770e
backend_firefox: misc refactor
- Follow the "best practice" in the SQLite manual, where calls to
  sqlite3_column_bytes() should come after sqlite3_column_text().
  This change does not affect the values returned.
- Other misc updates.
2025-03-11 16:22:29 +08:00
CismonX
08b9ea81d6
doc: misc update 2025-03-11 10:33:31 +08:00
CismonX
48b1d8c98d
backend_firefox: tombstone for deleted bookmarks
If a bookmark is assigned SYNC_STATUS_NORMAL (value 2),
a "tombstone" has to be inserted upon deletion,
so that the browser could purge it from remote.
2025-03-10 14:40:26 +08:00
CismonX
217e185496
backend_firefox: temp ts buffer for usecs_now() 2025-03-09 16:27:09 +08:00
CismonX
85b02f6c2b
backend_firefox, fs_ops: store hashcode in entry
Trade a bit of memory for hashmap rehash/remove efficiency.
2025-03-09 15:44:29 +08:00
CismonX
3e6bcb8b4f
backend_firefox: set bookmark initial sync status
New bookmarks should be assigned SYNC_STATUS_NEW (value 1).
2025-03-09 14:21:13 +08:00
CismonX
0b317c2727
test: misc refactor 2025-03-09 11:35:17 +08:00
CismonX
ca43bc6939
test: add tests for hashmap 2025-03-08 13:52:57 +08:00
CismonX
aed846b286
test: extract common prng helpers for future use 2025-03-08 13:50:47 +08:00
CismonX
1ed607de69
hashmap: tidy up log messages 2025-03-08 13:44:38 +08:00
CismonX
9fab17734c
chore: misc cleanup 2025-03-07 14:35:45 +08:00
CismonX
cadde0b61e
doc: update docs for the utility library
Move documentation for the hash table from source code comments
to the user manual.
2025-03-06 10:33:15 +08:00
CismonX
c2a91d6420
hashmap: refactor interface
- `hashmap_insert()` no longer takes key as argument, and
  takes the pointer to be associated with the entry as argument.
- Rename `hashmap_entry_delete` -> `hashmap_delete`.
- Make `user_data` the first argument for `hashmap_walk_func`.
- Other misc renames.
2025-03-06 06:40:28 +08:00
CismonX
b585a05c91
chore: remove null pointer representation check
That part of code in configure.ac look stupid, remove it.

If we _do_ try to run BookmarkFS on such an exotic platform with
non-zero null pointers, the breakage should be detected by the tests
(if it can run or even build at all).
2025-03-05 16:43:00 +08:00
CismonX
1836692719
test: disable LSAN for sandbox tests
since they do not play well with seccomp and landlock
2025-03-05 13:36:38 +08:00
CismonX
29be925c92
test: ATX_FEAT_NAME -> ATX_FEAT_VAR
Since we're only using the feature variables in shell expansion,
using this form should make the testsuite code look cleaner.
2025-03-05 07:34:40 +08:00
CismonX
95121cb78f
test: add helper macro ATX_RUN
This is meant to be a workaround for a limitation of Autotest,
where `set -e` has no effect in AT_CHECK().

Also we don't want to use `trap ... ERR`, since it is not portable.
2025-03-05 07:01:34 +08:00
CismonX
9050d01fe4
test: add tests for sandbox 2025-03-04 12:05:17 +08:00
CismonX
182967497d
sandbox: various fix and improvements
- Workaround a glibc issue for filtering negative syscall arguments.
- Allow unlinkat() syscall.
- Add extra filter for openat() in read-only mode when Landlock
  is not available.
2025-03-04 11:29:04 +08:00
CismonX
31192fc715
test: refactor watcher tests 2025-03-03 13:55:08 +08:00
CismonX
f6ff129f23
test: check-bookmarkfs-util -> check-util-lib 2025-03-03 09:21:26 +08:00
CismonX
97ddb47cc8
test: refactor tests
- Output more error message.
- Improve conditional tests for watcher.
2025-03-02 12:45:11 +08:00
CismonX
b8d03f008c
doc: add chapter for the utility library
Move the documentation of the following library components
from source code comments to the user manual:

- hash
- prng
- sandbox
- watcher
2025-03-02 11:18:34 +08:00
CismonX
b1100445b7
watcher: misc fix
- The initial `impl_rearm()` should always be performed by the
  worker thread, so that we won't get spurious zero returns from
  `watcher_poll()`.
- Sandboxing should not be implicitly disabled if not implemented.
- Shift internal watcher flags, to save space for public ones
  if we wish to add any in the future.
2025-03-02 06:54:06 +08:00
CismonX
8cbd5846d9
chore: tidy up 2025-03-01 23:40:34 +08:00
CismonX
f3f522ae63
test: fix
- Address sanitizer may call sigaltstack().
  Add it to the syscall whitelist (debug only).
- Fix args count checking for `check-bookmarkfs-util watcher`.
2025-03-01 12:14:53 +08:00
CismonX
3a0f435572
test: add tests for the file watcher 2025-03-01 11:23:42 +08:00
CismonX
0b7b46be9c
watcher: refactor
- Use negated errno as return value.
- Do not consider deletion of the watched file as a fatal error,
  and use a separate error code to distinguish between them.
- Lazy-init worker: Starts watching upon the first call to
  watcher_poll().
2025-03-01 10:02:05 +08:00
CismonX
03da5fea5c
xstd: add convenience function xstrerror_save() 2025-03-01 07:40:13 +08:00
CismonX
6f11f51171
backend_firefox: rename msecs -> usecs
For microseconds, "usecs" is the correct abbreviation,
while "msecs" should be used for milliseconds.
2025-03-01 00:52:18 +08:00
CismonX
f952a35ddc
backend: misc refactor
- Following commit d01554400c, rename `attr_key_*` to `xattr_name_*`.
- Other misc changes.
2025-02-28 10:05:25 +08:00
CismonX
cd648f9ef0
backend_firefox: separator-aware
There's a special kind of bookmark in Firefox known as "separator",
which appears as vertical or horizontal bars in the browser.

BookmarkFS currently does not support managing separators, but
the backend should be aware of their existence, and must not break
when one appears.

A separator always has a NULL `title` and `fk` in `moz_bookmarks`,
so it doesn't break `bookmark_list()` and `bookmark_lookup()`,
but breaks `bookmark_check()` since it could be mistaken for a
bookmark or bookmark folder with NULL title.

Fix by checking the bookmark type in `bookmark_check_cb()`.
2025-02-28 00:07:24 +08:00
CismonX
348f13df02
backend_firefox: improve length(url) performace
The SQLite builtin function `length()` calculates the number of
Unicode code points of the given argument, while `octet_length()`
calculates the number of bytes.

The two functions should produce the same result for a URL since it's
always ASCII-only, however, with `octet_length()` the length can be
directly fetched from metadata without actually reading the URL text,
thereby improving performance.
2025-02-27 14:26:24 +08:00
CismonX
0307140980
ci: add history build urls 2025-02-27 11:06:00 +08:00
CismonX
1e1460af0d
ci: add build.sr.ht configuration
Automate the building and testing process of BookmarkFS using the
builds.sr.ht service, to see whether it still works on:

- Debian, Arch Linux
  * Typical GNU/Linux distros, either stable or cutting-edge.
- Alpine Linux
  * Minimal non-GNU setup, notably BusyBox, TinyCC, musl and pdpmake.
- FreeBSD
  * FreeBSD kernel and userland, including Clang and others.
2025-02-27 10:08:26 +08:00
CismonX
b7b8cc88d2
doc: misc update 2025-02-26 22:53:38 +08:00
CismonX
fc8bda14f3
doc: update doc for the Firefox backend
Following commit 349877f9a3, explain in the user manual about
readonly database files.
2025-02-26 15:14:07 +08:00
CismonX
f737aa9868
chore: remove bad copy-pasted comment lines 2025-02-26 14:58:42 +08:00
CismonX
b33f2ced0b
fsck: limit history list length
Add a hard limit to prevent the history command list from growing
unnecessarily large, especially when interactive fsck is automated
with scripting.
2025-02-26 14:46:29 +08:00
CismonX
0fd2cbbc9d
backend_firefox: no db_check() in sandbox mode
Following commit 35d4a93a41, now only perform `PRAGMA quick_check`
in non-sandbox mode before querying data on the database.

Although in practice SQLite does well in terms of memory safety,
most likely way better than BookmarkFS itself, we consider
sandboxing a stronger security guarantee than `PRAGMA quick_check`.
2025-02-26 14:06:18 +08:00
CismonX
d01554400c
backend: rename ATTR_KEY_* -> BM_XATTR_* 2025-02-26 13:56:18 +08:00
CismonX
55c0726c7f
all: minor refactor 2025-02-26 00:23:27 +08:00
CismonX
7816e955b7
fsck: remove unnecessary isatty() checks
There are legitimate use cases for interactive fsck.bookmarkfs
without a terminal, and Readline works fine without one.
2025-02-25 08:35:15 +08:00