forked from iarv/Remote-Terminal-for-MeshCore
996 lines
36 KiB
Python
996 lines
36 KiB
Python
"""
|
|
Database migrations using SQLite's user_version pragma.
|
|
|
|
Migrations run automatically on startup. The user_version pragma tracks
|
|
which migrations have been applied (defaults to 0 for existing databases).
|
|
|
|
This approach is safe for existing users - their databases have user_version=0,
|
|
so all migrations run in order on first startup after upgrade.
|
|
"""
|
|
|
|
import logging
|
|
from hashlib import sha256
|
|
|
|
import aiosqlite
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
async def get_version(conn: aiosqlite.Connection) -> int:
|
|
"""Get current schema version from SQLite user_version pragma."""
|
|
cursor = await conn.execute("PRAGMA user_version")
|
|
row = await cursor.fetchone()
|
|
return row[0] if row else 0
|
|
|
|
|
|
async def set_version(conn: aiosqlite.Connection, version: int) -> None:
|
|
"""Set schema version using SQLite user_version pragma."""
|
|
await conn.execute(f"PRAGMA user_version = {version}")
|
|
|
|
|
|
async def run_migrations(conn: aiosqlite.Connection) -> int:
|
|
"""
|
|
Run all pending migrations.
|
|
|
|
Returns the number of migrations applied.
|
|
"""
|
|
version = await get_version(conn)
|
|
applied = 0
|
|
|
|
# Migration 1: Add last_read_at columns for server-side read tracking
|
|
if version < 1:
|
|
logger.info("Applying migration 1: add last_read_at columns")
|
|
await _migrate_001_add_last_read_at(conn)
|
|
await set_version(conn, 1)
|
|
applied += 1
|
|
|
|
# Migration 2: Drop unused decrypt_attempts and last_attempt columns
|
|
if version < 2:
|
|
logger.info("Applying migration 2: drop decrypt_attempts and last_attempt columns")
|
|
await _migrate_002_drop_decrypt_attempt_columns(conn)
|
|
await set_version(conn, 2)
|
|
applied += 1
|
|
|
|
# Migration 3: Drop decrypted column (redundant with message_id), update index
|
|
if version < 3:
|
|
logger.info("Applying migration 3: drop decrypted column, add message_id index")
|
|
await _migrate_003_drop_decrypted_column(conn)
|
|
await set_version(conn, 3)
|
|
applied += 1
|
|
|
|
# Migration 4: Add payload_hash column for deduplication
|
|
if version < 4:
|
|
logger.info("Applying migration 4: add payload_hash column")
|
|
await _migrate_004_add_payload_hash_column(conn)
|
|
await set_version(conn, 4)
|
|
applied += 1
|
|
|
|
# Migration 5: Backfill payload hashes and deduplicate existing packets
|
|
if version < 5:
|
|
logger.info("Applying migration 5: backfill payload hashes and dedupe")
|
|
await _migrate_005_backfill_payload_hashes(conn)
|
|
await set_version(conn, 5)
|
|
applied += 1
|
|
|
|
# Migration 6: Replace path_len with path column in messages
|
|
if version < 6:
|
|
logger.info("Applying migration 6: replace path_len with path column")
|
|
await _migrate_006_replace_path_len_with_path(conn)
|
|
await set_version(conn, 6)
|
|
applied += 1
|
|
|
|
# Migration 7: Backfill path from raw_packets for decrypted messages
|
|
if version < 7:
|
|
logger.info("Applying migration 7: backfill path from raw_packets")
|
|
await _migrate_007_backfill_message_paths(conn)
|
|
await set_version(conn, 7)
|
|
applied += 1
|
|
|
|
# Migration 8: Convert path column to paths JSON array for multiple delivery paths
|
|
if version < 8:
|
|
logger.info("Applying migration 8: convert path to paths JSON array")
|
|
await _migrate_008_convert_path_to_paths_array(conn)
|
|
await set_version(conn, 8)
|
|
applied += 1
|
|
|
|
# Migration 9: Create app_settings table for persistent preferences
|
|
if version < 9:
|
|
logger.info("Applying migration 9: create app_settings table")
|
|
await _migrate_009_create_app_settings_table(conn)
|
|
await set_version(conn, 9)
|
|
applied += 1
|
|
|
|
# Migration 10: Add advert_interval column to app_settings
|
|
if version < 10:
|
|
logger.info("Applying migration 10: add advert_interval column")
|
|
await _migrate_010_add_advert_interval(conn)
|
|
await set_version(conn, 10)
|
|
applied += 1
|
|
|
|
# Migration 11: Add last_advert_time column to app_settings
|
|
if version < 11:
|
|
logger.info("Applying migration 11: add last_advert_time column")
|
|
await _migrate_011_add_last_advert_time(conn)
|
|
await set_version(conn, 11)
|
|
applied += 1
|
|
|
|
# Migration 12: Add bot_enabled and bot_code columns to app_settings
|
|
if version < 12:
|
|
logger.info("Applying migration 12: add bot settings columns")
|
|
await _migrate_012_add_bot_settings(conn)
|
|
await set_version(conn, 12)
|
|
applied += 1
|
|
|
|
# Migration 13: Convert bot_enabled/bot_code to bots JSON array
|
|
if version < 13:
|
|
logger.info("Applying migration 13: convert to multi-bot format")
|
|
await _migrate_013_convert_to_multi_bot(conn)
|
|
await set_version(conn, 13)
|
|
applied += 1
|
|
|
|
# Migration 14: Lowercase all contact public keys and related data
|
|
if version < 14:
|
|
logger.info("Applying migration 14: lowercase all contact public keys")
|
|
await _migrate_014_lowercase_public_keys(conn)
|
|
await set_version(conn, 14)
|
|
applied += 1
|
|
|
|
# Migration 15: Fix NULL sender_timestamp and add null-safe dedup index
|
|
if version < 15:
|
|
logger.info("Applying migration 15: fix NULL sender_timestamp values")
|
|
await _migrate_015_fix_null_sender_timestamp(conn)
|
|
await set_version(conn, 15)
|
|
applied += 1
|
|
|
|
if applied > 0:
|
|
logger.info(
|
|
"Applied %d migration(s), schema now at version %d", applied, await get_version(conn)
|
|
)
|
|
else:
|
|
logger.debug("Schema up to date at version %d", version)
|
|
|
|
return applied
|
|
|
|
|
|
async def _migrate_001_add_last_read_at(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Add last_read_at column to contacts and channels tables.
|
|
|
|
This enables server-side read state tracking, replacing the localStorage
|
|
approach for consistent read state across devices.
|
|
|
|
ALTER TABLE ADD COLUMN is safe - it preserves existing data and handles
|
|
the "column already exists" case gracefully.
|
|
"""
|
|
# Add to contacts table
|
|
try:
|
|
await conn.execute("ALTER TABLE contacts ADD COLUMN last_read_at INTEGER")
|
|
logger.debug("Added last_read_at to contacts table")
|
|
except aiosqlite.OperationalError as e:
|
|
if "duplicate column name" in str(e).lower():
|
|
logger.debug("contacts.last_read_at already exists, skipping")
|
|
else:
|
|
raise
|
|
|
|
# Add to channels table
|
|
try:
|
|
await conn.execute("ALTER TABLE channels ADD COLUMN last_read_at INTEGER")
|
|
logger.debug("Added last_read_at to channels table")
|
|
except aiosqlite.OperationalError as e:
|
|
if "duplicate column name" in str(e).lower():
|
|
logger.debug("channels.last_read_at already exists, skipping")
|
|
else:
|
|
raise
|
|
|
|
await conn.commit()
|
|
|
|
|
|
async def _migrate_002_drop_decrypt_attempt_columns(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Drop unused decrypt_attempts and last_attempt columns from raw_packets.
|
|
|
|
These columns were added for a retry-limiting feature that was never implemented.
|
|
They are written to but never read, so we can safely remove them.
|
|
|
|
SQLite 3.35.0+ supports ALTER TABLE DROP COLUMN. For older versions,
|
|
we silently skip (the columns will remain but are harmless).
|
|
"""
|
|
for column in ["decrypt_attempts", "last_attempt"]:
|
|
try:
|
|
await conn.execute(f"ALTER TABLE raw_packets DROP COLUMN {column}")
|
|
logger.debug("Dropped %s from raw_packets table", column)
|
|
except aiosqlite.OperationalError as e:
|
|
error_msg = str(e).lower()
|
|
if "no such column" in error_msg:
|
|
logger.debug("raw_packets.%s already dropped, skipping", column)
|
|
elif "syntax error" in error_msg or "drop column" in error_msg:
|
|
# SQLite version doesn't support DROP COLUMN - harmless, column stays
|
|
logger.debug("SQLite doesn't support DROP COLUMN, %s column will remain", column)
|
|
else:
|
|
raise
|
|
|
|
await conn.commit()
|
|
|
|
|
|
async def _migrate_003_drop_decrypted_column(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Drop the decrypted column and update indexes.
|
|
|
|
The decrypted column is redundant with message_id - a packet is decrypted
|
|
iff message_id IS NOT NULL. We replace the decrypted index with a message_id index.
|
|
|
|
SQLite 3.35.0+ supports ALTER TABLE DROP COLUMN. For older versions,
|
|
we silently skip the column drop but still update the index.
|
|
"""
|
|
# First, drop the old index on decrypted (safe even if it doesn't exist)
|
|
try:
|
|
await conn.execute("DROP INDEX IF EXISTS idx_raw_packets_decrypted")
|
|
logger.debug("Dropped idx_raw_packets_decrypted index")
|
|
except aiosqlite.OperationalError:
|
|
pass # Index didn't exist
|
|
|
|
# Create new index on message_id for efficient undecrypted packet queries
|
|
try:
|
|
await conn.execute(
|
|
"CREATE INDEX IF NOT EXISTS idx_raw_packets_message_id ON raw_packets(message_id)"
|
|
)
|
|
logger.debug("Created idx_raw_packets_message_id index")
|
|
except aiosqlite.OperationalError as e:
|
|
if "already exists" not in str(e).lower():
|
|
raise
|
|
|
|
# Try to drop the decrypted column
|
|
try:
|
|
await conn.execute("ALTER TABLE raw_packets DROP COLUMN decrypted")
|
|
logger.debug("Dropped decrypted from raw_packets table")
|
|
except aiosqlite.OperationalError as e:
|
|
error_msg = str(e).lower()
|
|
if "no such column" in error_msg:
|
|
logger.debug("raw_packets.decrypted already dropped, skipping")
|
|
elif "syntax error" in error_msg or "drop column" in error_msg:
|
|
# SQLite version doesn't support DROP COLUMN - harmless, column stays
|
|
logger.debug("SQLite doesn't support DROP COLUMN, decrypted column will remain")
|
|
else:
|
|
raise
|
|
|
|
await conn.commit()
|
|
|
|
|
|
async def _migrate_004_add_payload_hash_column(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Add payload_hash column to raw_packets for deduplication.
|
|
|
|
This column stores the SHA-256 hash of the packet payload (excluding routing/path info).
|
|
It will be used with a unique index to prevent duplicate packets from being stored.
|
|
"""
|
|
try:
|
|
await conn.execute("ALTER TABLE raw_packets ADD COLUMN payload_hash TEXT")
|
|
logger.debug("Added payload_hash column to raw_packets table")
|
|
except aiosqlite.OperationalError as e:
|
|
if "duplicate column name" in str(e).lower():
|
|
logger.debug("raw_packets.payload_hash already exists, skipping")
|
|
else:
|
|
raise
|
|
|
|
await conn.commit()
|
|
|
|
|
|
def _extract_payload_for_hash(raw_packet: bytes) -> bytes | None:
|
|
"""
|
|
Extract payload from a raw packet for hashing (migration-local copy of decoder logic).
|
|
|
|
Returns the payload bytes, or None if packet is malformed.
|
|
"""
|
|
if len(raw_packet) < 2:
|
|
return None
|
|
|
|
try:
|
|
header = raw_packet[0]
|
|
route_type = header & 0x03
|
|
offset = 1
|
|
|
|
# Skip transport codes if present (TRANSPORT_FLOOD=0, TRANSPORT_DIRECT=3)
|
|
if route_type in (0x00, 0x03):
|
|
if len(raw_packet) < offset + 4:
|
|
return None
|
|
offset += 4
|
|
|
|
# Get path length
|
|
if len(raw_packet) < offset + 1:
|
|
return None
|
|
path_length = raw_packet[offset]
|
|
offset += 1
|
|
|
|
# Skip path bytes
|
|
if len(raw_packet) < offset + path_length:
|
|
return None
|
|
offset += path_length
|
|
|
|
# Rest is payload (may be empty, matching decoder.py behavior)
|
|
return raw_packet[offset:]
|
|
except (IndexError, ValueError):
|
|
return None
|
|
|
|
|
|
async def _migrate_005_backfill_payload_hashes(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Backfill payload_hash for existing packets and remove duplicates.
|
|
|
|
This may take a while for large databases. Progress is logged.
|
|
After backfilling, a unique index is created to prevent future duplicates.
|
|
"""
|
|
# Get count first
|
|
cursor = await conn.execute("SELECT COUNT(*) FROM raw_packets WHERE payload_hash IS NULL")
|
|
row = await cursor.fetchone()
|
|
total = row[0] if row else 0
|
|
|
|
if total == 0:
|
|
logger.debug("No packets need hash backfill")
|
|
else:
|
|
logger.info("Backfilling payload hashes for %d packets. This may take a while...", total)
|
|
|
|
# Process in batches to avoid memory issues
|
|
batch_size = 1000
|
|
processed = 0
|
|
duplicates_deleted = 0
|
|
|
|
# Track seen hashes to identify duplicates (keep oldest = lowest ID)
|
|
seen_hashes: dict[str, int] = {} # hash -> oldest packet ID
|
|
|
|
# First pass: compute hashes and identify duplicates
|
|
cursor = await conn.execute("SELECT id, data FROM raw_packets ORDER BY id ASC")
|
|
|
|
packets_to_update: list[tuple[str, int]] = [] # (hash, id)
|
|
ids_to_delete: list[int] = []
|
|
|
|
while True:
|
|
rows = await cursor.fetchmany(batch_size)
|
|
if not rows:
|
|
break
|
|
|
|
for row in rows:
|
|
packet_id = row[0]
|
|
packet_data = bytes(row[1])
|
|
|
|
# Extract payload and compute hash
|
|
payload = _extract_payload_for_hash(packet_data)
|
|
if payload:
|
|
payload_hash = sha256(payload).hexdigest()
|
|
else:
|
|
# For malformed packets, hash the full data
|
|
payload_hash = sha256(packet_data).hexdigest()
|
|
|
|
if payload_hash in seen_hashes:
|
|
# Duplicate - mark for deletion (we keep the older one)
|
|
ids_to_delete.append(packet_id)
|
|
duplicates_deleted += 1
|
|
else:
|
|
# New hash - keep this packet
|
|
seen_hashes[payload_hash] = packet_id
|
|
packets_to_update.append((payload_hash, packet_id))
|
|
|
|
processed += 1
|
|
|
|
if processed % 10000 == 0:
|
|
logger.info("Processed %d/%d packets...", processed, total)
|
|
|
|
# Second pass: update hashes for packets we're keeping
|
|
total_updates = len(packets_to_update)
|
|
logger.info("Updating %d packets with hashes...", total_updates)
|
|
for idx, (payload_hash, packet_id) in enumerate(packets_to_update, 1):
|
|
await conn.execute(
|
|
"UPDATE raw_packets SET payload_hash = ? WHERE id = ?",
|
|
(payload_hash, packet_id),
|
|
)
|
|
if idx % 10000 == 0:
|
|
logger.info("Updated %d/%d packets...", idx, total_updates)
|
|
|
|
# Third pass: delete duplicates
|
|
if ids_to_delete:
|
|
total_deletes = len(ids_to_delete)
|
|
logger.info("Removing %d duplicate packets...", total_deletes)
|
|
deleted_count = 0
|
|
# Delete in batches to avoid "too many SQL variables" error
|
|
for i in range(0, len(ids_to_delete), 500):
|
|
batch = ids_to_delete[i : i + 500]
|
|
placeholders = ",".join("?" * len(batch))
|
|
await conn.execute(f"DELETE FROM raw_packets WHERE id IN ({placeholders})", batch)
|
|
deleted_count += len(batch)
|
|
if deleted_count % 10000 < 500: # Log roughly every 10k
|
|
logger.info("Removed %d/%d duplicates...", deleted_count, total_deletes)
|
|
|
|
await conn.commit()
|
|
logger.info(
|
|
"Hash backfill complete: %d packets updated, %d duplicates removed",
|
|
len(packets_to_update),
|
|
duplicates_deleted,
|
|
)
|
|
|
|
# Create unique index on payload_hash (this enforces uniqueness going forward)
|
|
try:
|
|
await conn.execute(
|
|
"CREATE UNIQUE INDEX IF NOT EXISTS idx_raw_packets_payload_hash "
|
|
"ON raw_packets(payload_hash)"
|
|
)
|
|
logger.debug("Created unique index on payload_hash")
|
|
except aiosqlite.OperationalError as e:
|
|
if "already exists" not in str(e).lower():
|
|
raise
|
|
|
|
await conn.commit()
|
|
|
|
|
|
async def _migrate_006_replace_path_len_with_path(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Replace path_len INTEGER column with path TEXT column in messages table.
|
|
|
|
The path column stores the hex-encoded routing path bytes. Path length can
|
|
be derived from the hex string (2 chars per byte = 1 hop).
|
|
|
|
SQLite 3.35.0+ supports ALTER TABLE DROP COLUMN. For older versions,
|
|
we silently skip the drop (the column will remain but is unused).
|
|
"""
|
|
# First, add the new path column
|
|
try:
|
|
await conn.execute("ALTER TABLE messages ADD COLUMN path TEXT")
|
|
logger.debug("Added path column to messages table")
|
|
except aiosqlite.OperationalError as e:
|
|
if "duplicate column name" in str(e).lower():
|
|
logger.debug("messages.path already exists, skipping")
|
|
else:
|
|
raise
|
|
|
|
# Try to drop the old path_len column
|
|
try:
|
|
await conn.execute("ALTER TABLE messages DROP COLUMN path_len")
|
|
logger.debug("Dropped path_len from messages table")
|
|
except aiosqlite.OperationalError as e:
|
|
error_msg = str(e).lower()
|
|
if "no such column" in error_msg:
|
|
logger.debug("messages.path_len already dropped, skipping")
|
|
elif "syntax error" in error_msg or "drop column" in error_msg:
|
|
# SQLite version doesn't support DROP COLUMN - harmless, column stays
|
|
logger.debug("SQLite doesn't support DROP COLUMN, path_len column will remain")
|
|
else:
|
|
raise
|
|
|
|
await conn.commit()
|
|
|
|
|
|
def _extract_path_from_packet(raw_packet: bytes) -> str | None:
|
|
"""
|
|
Extract path hex string from a raw packet (migration-local copy of decoder logic).
|
|
|
|
Returns the path as a hex string, or None if packet is malformed.
|
|
"""
|
|
if len(raw_packet) < 2:
|
|
return None
|
|
|
|
try:
|
|
header = raw_packet[0]
|
|
route_type = header & 0x03
|
|
offset = 1
|
|
|
|
# Skip transport codes if present (TRANSPORT_FLOOD=0, TRANSPORT_DIRECT=3)
|
|
if route_type in (0x00, 0x03):
|
|
if len(raw_packet) < offset + 4:
|
|
return None
|
|
offset += 4
|
|
|
|
# Get path length
|
|
if len(raw_packet) < offset + 1:
|
|
return None
|
|
path_length = raw_packet[offset]
|
|
offset += 1
|
|
|
|
# Extract path bytes
|
|
if len(raw_packet) < offset + path_length:
|
|
return None
|
|
path_bytes = raw_packet[offset : offset + path_length]
|
|
|
|
return path_bytes.hex()
|
|
except (IndexError, ValueError):
|
|
return None
|
|
|
|
|
|
async def _migrate_007_backfill_message_paths(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Backfill path column for messages that have linked raw_packets.
|
|
|
|
For each message with a linked raw_packet (via message_id), extract the
|
|
path from the raw packet and update the message.
|
|
|
|
Only updates incoming messages (outgoing=0) since outgoing messages
|
|
don't have meaningful path data.
|
|
"""
|
|
# Get count of messages that need backfill
|
|
cursor = await conn.execute(
|
|
"""
|
|
SELECT COUNT(*)
|
|
FROM messages m
|
|
JOIN raw_packets rp ON rp.message_id = m.id
|
|
WHERE m.path IS NULL AND m.outgoing = 0
|
|
"""
|
|
)
|
|
row = await cursor.fetchone()
|
|
total = row[0] if row else 0
|
|
|
|
if total == 0:
|
|
logger.debug("No messages need path backfill")
|
|
return
|
|
|
|
logger.info("Backfilling path for %d messages. This may take a while...", total)
|
|
|
|
# Process in batches
|
|
batch_size = 1000
|
|
processed = 0
|
|
updated = 0
|
|
|
|
cursor = await conn.execute(
|
|
"""
|
|
SELECT m.id, rp.data
|
|
FROM messages m
|
|
JOIN raw_packets rp ON rp.message_id = m.id
|
|
WHERE m.path IS NULL AND m.outgoing = 0
|
|
ORDER BY m.id ASC
|
|
"""
|
|
)
|
|
|
|
updates: list[tuple[str, int]] = [] # (path, message_id)
|
|
|
|
while True:
|
|
rows = await cursor.fetchmany(batch_size)
|
|
if not rows:
|
|
break
|
|
|
|
for row in rows:
|
|
message_id = row[0]
|
|
packet_data = bytes(row[1])
|
|
|
|
path_hex = _extract_path_from_packet(packet_data)
|
|
if path_hex is not None:
|
|
updates.append((path_hex, message_id))
|
|
|
|
processed += 1
|
|
|
|
if processed % 10000 == 0:
|
|
logger.info("Processed %d/%d messages...", processed, total)
|
|
|
|
# Apply updates in batches
|
|
if updates:
|
|
logger.info("Updating %d messages with path data...", len(updates))
|
|
for idx, (path_hex, message_id) in enumerate(updates, 1):
|
|
await conn.execute(
|
|
"UPDATE messages SET path = ? WHERE id = ?",
|
|
(path_hex, message_id),
|
|
)
|
|
updated += 1
|
|
if idx % 10000 == 0:
|
|
logger.info("Updated %d/%d messages...", idx, len(updates))
|
|
|
|
await conn.commit()
|
|
logger.info("Path backfill complete: %d messages updated", updated)
|
|
|
|
|
|
async def _migrate_008_convert_path_to_paths_array(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Convert path TEXT column to paths TEXT column storing JSON array.
|
|
|
|
The new format stores multiple paths as a JSON array of objects:
|
|
[{"path": "1A2B", "received_at": 1234567890}, ...]
|
|
|
|
This enables tracking multiple delivery paths for the same message
|
|
(e.g., when a message is received via different repeater routes).
|
|
"""
|
|
import json
|
|
|
|
# First, add the new paths column
|
|
try:
|
|
await conn.execute("ALTER TABLE messages ADD COLUMN paths TEXT")
|
|
logger.debug("Added paths column to messages table")
|
|
except aiosqlite.OperationalError as e:
|
|
if "duplicate column name" in str(e).lower():
|
|
logger.debug("messages.paths already exists, skipping column add")
|
|
else:
|
|
raise
|
|
|
|
# Migrate existing path data to paths array format
|
|
cursor = await conn.execute(
|
|
"SELECT id, path, received_at FROM messages WHERE path IS NOT NULL AND paths IS NULL"
|
|
)
|
|
rows = list(await cursor.fetchall())
|
|
|
|
if rows:
|
|
logger.info("Converting %d messages from path to paths array format...", len(rows))
|
|
for row in rows:
|
|
message_id = row[0]
|
|
old_path = row[1]
|
|
received_at = row[2]
|
|
|
|
# Convert single path to array format
|
|
paths_json = json.dumps([{"path": old_path, "received_at": received_at}])
|
|
await conn.execute(
|
|
"UPDATE messages SET paths = ? WHERE id = ?",
|
|
(paths_json, message_id),
|
|
)
|
|
|
|
logger.info("Converted %d messages to paths array format", len(rows))
|
|
|
|
# Try to drop the old path column (SQLite 3.35.0+ only)
|
|
try:
|
|
await conn.execute("ALTER TABLE messages DROP COLUMN path")
|
|
logger.debug("Dropped path column from messages table")
|
|
except aiosqlite.OperationalError as e:
|
|
error_msg = str(e).lower()
|
|
if "no such column" in error_msg:
|
|
logger.debug("messages.path already dropped, skipping")
|
|
elif "syntax error" in error_msg or "drop column" in error_msg:
|
|
# SQLite version doesn't support DROP COLUMN - harmless, column stays
|
|
logger.debug("SQLite doesn't support DROP COLUMN, path column will remain")
|
|
else:
|
|
raise
|
|
|
|
await conn.commit()
|
|
|
|
|
|
async def _migrate_009_create_app_settings_table(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Create app_settings table for persistent application preferences.
|
|
|
|
This table stores:
|
|
- max_radio_contacts: Max non-repeater contacts to keep on radio for DM ACKs
|
|
- favorites: JSON array of favorite conversations [{type, id}, ...]
|
|
- auto_decrypt_dm_on_advert: Whether to attempt historical DM decryption on new contact
|
|
- sidebar_sort_order: 'recent' or 'alpha' for sidebar sorting
|
|
- last_message_times: JSON object mapping conversation keys to timestamps
|
|
- preferences_migrated: Flag to track if localStorage has been migrated
|
|
|
|
The table uses a single-row pattern (id=1) for simplicity.
|
|
"""
|
|
await conn.execute(
|
|
"""
|
|
CREATE TABLE IF NOT EXISTS app_settings (
|
|
id INTEGER PRIMARY KEY CHECK (id = 1),
|
|
max_radio_contacts INTEGER DEFAULT 200,
|
|
favorites TEXT DEFAULT '[]',
|
|
auto_decrypt_dm_on_advert INTEGER DEFAULT 0,
|
|
sidebar_sort_order TEXT DEFAULT 'recent',
|
|
last_message_times TEXT DEFAULT '{}',
|
|
preferences_migrated INTEGER DEFAULT 0
|
|
)
|
|
"""
|
|
)
|
|
|
|
# Initialize with default row
|
|
await conn.execute(
|
|
"""
|
|
INSERT OR IGNORE INTO app_settings (id, max_radio_contacts, favorites, auto_decrypt_dm_on_advert, sidebar_sort_order, last_message_times, preferences_migrated)
|
|
VALUES (1, 200, '[]', 0, 'recent', '{}', 0)
|
|
"""
|
|
)
|
|
|
|
await conn.commit()
|
|
logger.debug("Created app_settings table with default values")
|
|
|
|
|
|
async def _migrate_010_add_advert_interval(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Add advert_interval column to app_settings table.
|
|
|
|
This enables configurable periodic advertisement interval (default 0 = disabled).
|
|
"""
|
|
try:
|
|
await conn.execute("ALTER TABLE app_settings ADD COLUMN advert_interval INTEGER DEFAULT 0")
|
|
logger.debug("Added advert_interval column to app_settings")
|
|
except aiosqlite.OperationalError as e:
|
|
if "duplicate column" in str(e).lower():
|
|
logger.debug("advert_interval column already exists, skipping")
|
|
else:
|
|
raise
|
|
|
|
await conn.commit()
|
|
|
|
|
|
async def _migrate_011_add_last_advert_time(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Add last_advert_time column to app_settings table.
|
|
|
|
This tracks when the last advertisement was sent, ensuring we never
|
|
advertise faster than the configured advert_interval.
|
|
"""
|
|
try:
|
|
await conn.execute("ALTER TABLE app_settings ADD COLUMN last_advert_time INTEGER DEFAULT 0")
|
|
logger.debug("Added last_advert_time column to app_settings")
|
|
except aiosqlite.OperationalError as e:
|
|
if "duplicate column" in str(e).lower():
|
|
logger.debug("last_advert_time column already exists, skipping")
|
|
else:
|
|
raise
|
|
|
|
await conn.commit()
|
|
|
|
|
|
async def _migrate_012_add_bot_settings(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Add bot_enabled and bot_code columns to app_settings table.
|
|
|
|
This enables user-defined Python code to be executed when messages are received,
|
|
allowing for custom bot responses.
|
|
"""
|
|
try:
|
|
await conn.execute("ALTER TABLE app_settings ADD COLUMN bot_enabled INTEGER DEFAULT 0")
|
|
logger.debug("Added bot_enabled column to app_settings")
|
|
except aiosqlite.OperationalError as e:
|
|
if "duplicate column" in str(e).lower():
|
|
logger.debug("bot_enabled column already exists, skipping")
|
|
else:
|
|
raise
|
|
|
|
try:
|
|
await conn.execute("ALTER TABLE app_settings ADD COLUMN bot_code TEXT DEFAULT ''")
|
|
logger.debug("Added bot_code column to app_settings")
|
|
except aiosqlite.OperationalError as e:
|
|
if "duplicate column" in str(e).lower():
|
|
logger.debug("bot_code column already exists, skipping")
|
|
else:
|
|
raise
|
|
|
|
await conn.commit()
|
|
|
|
|
|
async def _migrate_013_convert_to_multi_bot(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Convert single bot_enabled/bot_code to multi-bot format.
|
|
|
|
Adds a 'bots' TEXT column storing a JSON array of bot configs:
|
|
[{"id": "uuid", "name": "Bot 1", "enabled": true, "code": "..."}]
|
|
|
|
If existing bot_code is non-empty OR bot_enabled is true, migrates
|
|
to a single bot named "Bot 1". Otherwise, creates empty array.
|
|
|
|
Attempts to drop the old bot_enabled and bot_code columns.
|
|
"""
|
|
import json
|
|
import uuid
|
|
|
|
# Add new bots column
|
|
try:
|
|
await conn.execute("ALTER TABLE app_settings ADD COLUMN bots TEXT DEFAULT '[]'")
|
|
logger.debug("Added bots column to app_settings")
|
|
except aiosqlite.OperationalError as e:
|
|
if "duplicate column" in str(e).lower():
|
|
logger.debug("bots column already exists, skipping")
|
|
else:
|
|
raise
|
|
|
|
# Migrate existing bot data
|
|
cursor = await conn.execute("SELECT bot_enabled, bot_code FROM app_settings WHERE id = 1")
|
|
row = await cursor.fetchone()
|
|
|
|
if row:
|
|
bot_enabled = bool(row[0]) if row[0] is not None else False
|
|
bot_code = row[1] or ""
|
|
|
|
# If there's existing bot data, migrate it
|
|
if bot_code.strip() or bot_enabled:
|
|
bots = [
|
|
{
|
|
"id": str(uuid.uuid4()),
|
|
"name": "Bot 1",
|
|
"enabled": bot_enabled,
|
|
"code": bot_code,
|
|
}
|
|
]
|
|
bots_json = json.dumps(bots)
|
|
logger.info("Migrating existing bot to multi-bot format: enabled=%s", bot_enabled)
|
|
else:
|
|
bots_json = "[]"
|
|
|
|
await conn.execute(
|
|
"UPDATE app_settings SET bots = ? WHERE id = 1",
|
|
(bots_json,),
|
|
)
|
|
|
|
# Try to drop old columns (SQLite 3.35.0+ only)
|
|
for column in ["bot_enabled", "bot_code"]:
|
|
try:
|
|
await conn.execute(f"ALTER TABLE app_settings DROP COLUMN {column}")
|
|
logger.debug("Dropped %s column from app_settings", column)
|
|
except aiosqlite.OperationalError as e:
|
|
error_msg = str(e).lower()
|
|
if "no such column" in error_msg:
|
|
logger.debug("app_settings.%s already dropped, skipping", column)
|
|
elif "syntax error" in error_msg or "drop column" in error_msg:
|
|
# SQLite version doesn't support DROP COLUMN - harmless, column stays
|
|
logger.debug("SQLite doesn't support DROP COLUMN, %s column will remain", column)
|
|
else:
|
|
raise
|
|
|
|
await conn.commit()
|
|
|
|
|
|
async def _migrate_014_lowercase_public_keys(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Lowercase all contact public keys and related data for case-insensitive matching.
|
|
|
|
Updates:
|
|
- contacts.public_key (PRIMARY KEY) via temp table swap
|
|
- messages.conversation_key for PRIV messages
|
|
- app_settings.favorites (contact IDs)
|
|
- app_settings.last_message_times (contact- prefixed keys)
|
|
|
|
Handles case collisions by keeping the most-recently-seen contact.
|
|
"""
|
|
import json
|
|
|
|
# 1. Lowercase message conversation keys for private messages
|
|
try:
|
|
await conn.execute(
|
|
"UPDATE messages SET conversation_key = lower(conversation_key) WHERE type = 'PRIV'"
|
|
)
|
|
logger.debug("Lowercased PRIV message conversation_keys")
|
|
except aiosqlite.OperationalError as e:
|
|
if "no such table" in str(e).lower():
|
|
logger.debug("messages table does not exist yet, skipping conversation_key lowercase")
|
|
else:
|
|
raise
|
|
|
|
# 2. Check if contacts table exists before proceeding
|
|
cursor = await conn.execute(
|
|
"SELECT name FROM sqlite_master WHERE type='table' AND name='contacts'"
|
|
)
|
|
if not await cursor.fetchone():
|
|
logger.debug("contacts table does not exist yet, skipping key lowercase")
|
|
await conn.commit()
|
|
return
|
|
|
|
# 3. Handle contacts table - check for case collisions first
|
|
cursor = await conn.execute(
|
|
"SELECT lower(public_key) as lk, COUNT(*) as cnt "
|
|
"FROM contacts GROUP BY lower(public_key) HAVING COUNT(*) > 1"
|
|
)
|
|
collisions = list(await cursor.fetchall())
|
|
|
|
if collisions:
|
|
logger.warning(
|
|
"Found %d case-colliding contact groups, keeping most-recently-seen",
|
|
len(collisions),
|
|
)
|
|
for row in collisions:
|
|
lower_key = row[0]
|
|
# Delete all but the most recently seen
|
|
await conn.execute(
|
|
"""DELETE FROM contacts WHERE public_key IN (
|
|
SELECT public_key FROM contacts
|
|
WHERE lower(public_key) = ?
|
|
ORDER BY COALESCE(last_seen, 0) DESC
|
|
LIMIT -1 OFFSET 1
|
|
)""",
|
|
(lower_key,),
|
|
)
|
|
|
|
# 3. Rebuild contacts with lowercased keys
|
|
# Get the actual column names from the table (handles different schema versions)
|
|
cursor = await conn.execute("PRAGMA table_info(contacts)")
|
|
columns_info = await cursor.fetchall()
|
|
all_columns = [col[1] for col in columns_info] # col[1] is column name
|
|
|
|
# Build column lists, lowering public_key
|
|
select_cols = ", ".join(f"lower({c})" if c == "public_key" else c for c in all_columns)
|
|
col_defs = []
|
|
for col in columns_info:
|
|
name, col_type, _notnull, default, pk = col[1], col[2], col[3], col[4], col[5]
|
|
parts = [name, col_type or "TEXT"]
|
|
if pk:
|
|
parts.append("PRIMARY KEY")
|
|
if default is not None:
|
|
parts.append(f"DEFAULT {default}")
|
|
col_defs.append(" ".join(parts))
|
|
|
|
create_sql = f"CREATE TABLE contacts_new ({', '.join(col_defs)})"
|
|
await conn.execute(create_sql)
|
|
await conn.execute(f"INSERT INTO contacts_new SELECT {select_cols} FROM contacts")
|
|
await conn.execute("DROP TABLE contacts")
|
|
await conn.execute("ALTER TABLE contacts_new RENAME TO contacts")
|
|
|
|
# Recreate the on_radio index (if column exists)
|
|
if "on_radio" in all_columns:
|
|
await conn.execute("CREATE INDEX IF NOT EXISTS idx_contacts_on_radio ON contacts(on_radio)")
|
|
|
|
# 4. Lowercase contact IDs in favorites JSON (if app_settings exists)
|
|
cursor = await conn.execute(
|
|
"SELECT name FROM sqlite_master WHERE type='table' AND name='app_settings'"
|
|
)
|
|
if not await cursor.fetchone():
|
|
await conn.commit()
|
|
logger.info("Lowercased all contact public keys (no app_settings table)")
|
|
return
|
|
|
|
cursor = await conn.execute("SELECT favorites FROM app_settings WHERE id = 1")
|
|
row = await cursor.fetchone()
|
|
if row and row[0]:
|
|
try:
|
|
favorites = json.loads(row[0])
|
|
updated = False
|
|
for fav in favorites:
|
|
if fav.get("type") == "contact" and fav.get("id"):
|
|
new_id = fav["id"].lower()
|
|
if new_id != fav["id"]:
|
|
fav["id"] = new_id
|
|
updated = True
|
|
if updated:
|
|
await conn.execute(
|
|
"UPDATE app_settings SET favorites = ? WHERE id = 1",
|
|
(json.dumps(favorites),),
|
|
)
|
|
logger.debug("Lowercased contact IDs in favorites")
|
|
except (json.JSONDecodeError, TypeError):
|
|
pass
|
|
|
|
# 5. Lowercase contact keys in last_message_times JSON
|
|
cursor = await conn.execute("SELECT last_message_times FROM app_settings WHERE id = 1")
|
|
row = await cursor.fetchone()
|
|
if row and row[0]:
|
|
try:
|
|
times = json.loads(row[0])
|
|
new_times = {}
|
|
updated = False
|
|
for key, val in times.items():
|
|
if key.startswith("contact-"):
|
|
new_key = "contact-" + key[8:].lower()
|
|
if new_key != key:
|
|
updated = True
|
|
new_times[new_key] = val
|
|
else:
|
|
new_times[key] = val
|
|
if updated:
|
|
await conn.execute(
|
|
"UPDATE app_settings SET last_message_times = ? WHERE id = 1",
|
|
(json.dumps(new_times),),
|
|
)
|
|
logger.debug("Lowercased contact keys in last_message_times")
|
|
except (json.JSONDecodeError, TypeError):
|
|
pass
|
|
|
|
await conn.commit()
|
|
logger.info("Lowercased all contact public keys")
|
|
|
|
|
|
async def _migrate_015_fix_null_sender_timestamp(conn: aiosqlite.Connection) -> None:
|
|
"""
|
|
Fix NULL sender_timestamp values and add null-safe dedup index.
|
|
|
|
1. Set sender_timestamp = received_at for any messages with NULL sender_timestamp
|
|
2. Create a null-safe unique index as belt-and-suspenders protection
|
|
"""
|
|
# Check if messages table exists
|
|
cursor = await conn.execute(
|
|
"SELECT name FROM sqlite_master WHERE type='table' AND name='messages'"
|
|
)
|
|
if not await cursor.fetchone():
|
|
logger.debug("messages table does not exist yet, skipping NULL sender_timestamp fix")
|
|
await conn.commit()
|
|
return
|
|
|
|
# Backfill NULL sender_timestamps with received_at
|
|
cursor = await conn.execute(
|
|
"UPDATE messages SET sender_timestamp = received_at WHERE sender_timestamp IS NULL"
|
|
)
|
|
if cursor.rowcount > 0:
|
|
logger.info("Backfilled %d messages with NULL sender_timestamp", cursor.rowcount)
|
|
|
|
# Try to create null-safe dedup index (may fail if existing duplicates exist)
|
|
try:
|
|
await conn.execute(
|
|
"""CREATE UNIQUE INDEX IF NOT EXISTS idx_messages_dedup_null_safe
|
|
ON messages(type, conversation_key, text, COALESCE(sender_timestamp, 0))"""
|
|
)
|
|
logger.debug("Created null-safe dedup index")
|
|
except aiosqlite.IntegrityError:
|
|
logger.warning(
|
|
"Could not create null-safe dedup index due to existing duplicates - "
|
|
"the application-level dedup will handle these"
|
|
)
|
|
|
|
await conn.commit()
|