imsg-grep 0.1.2-darwin

data/bin/msg-info

@@ -0,0 +1,133 @@
+#!/usr/bin/env ruby
+# Display detailed information about a specific message by ID from the iMessage database
+
+require "bundler/setup"
+
+require_relative '../lib/imsg-grep/dev/print_query'
+require_relative '../lib/imsg-grep/messages'
+
+db = Messages.init
+
+def print_results(results2)
+  puts "\n#{'=' * 80}"
+
+  cols, *rows = results2
+  width = cols.map(&:length).max
+  rows.each do |row|
+    row.each_with_index do |val, i|
+      if cols[i] == "payload_json" && val
+        val = IO.popen("jq -C", "r+") { |jq| jq << val; jq.close_write; jq.read.chomp }
+      else
+        val = val.nil? ? "NULL" : val.to_s
+        val = val.gsub("\n", "\n   " + ' ' * width)
+      end
+      puts "#{cols[i].ljust(width, ' ')} : #{val}"
+    end
+    puts "-" * 80
+  end
+end
+
+def print_message_details(db, msg_id)
+  id_cond = msg_id =~ /-/ ? "orig.guid" : "orig.ROWID"
+  print_results db.execute2(<<~SQL, msg_id)
+    SELECT
+      -- Core identifiers
+      m.message_id,
+      m.guid,
+      m.utc_time,
+      -- -- Timing
+      -- m.utc_time,
+
+      -- -- Chat context
+      -- m.chat_style,
+      -- m.chat_name,
+
+      -- -- Message content
+
+      m.sender_name,
+      m.sender_searchable,
+      m.recipient_searchable,
+      m.recipient_name,
+      m.recipient_names,
+      m.recipients_searchable,
+      m.member_names,
+      m.members_searchable,
+
+      m.has_attachments,
+      m.is_from_me,
+      orig.text as text_original,
+      m.text,
+      unarchive_string(orig.attributedBody) as text_fresh,
+
+      -- Raw message fields
+      orig.subject,
+      orig.service,
+      orig.account,
+      orig.date,
+      orig.date_read,
+      orig.date_delivered,
+
+      -- Thread/Reply
+      orig.thread_originator_guid,
+      orig.thread_originator_part,
+      orig.reply_to_guid,
+
+      -- Metadata
+      orig.version,
+      orig.sort_id,
+      orig.share_status,
+      orig.share_direction,
+      orig.group_action_type,
+      orig.balloon_bundle_id,
+      orig.destination_caller_id,
+      orig.associated_message_type,
+      orig.associated_message_guid,
+
+      -- Status flags
+      orig.is_delivered,
+      orig.is_finished,
+      orig.is_emote,
+      orig.is_delayed,
+      orig.is_auto_reply,
+      orig.is_prepared,
+      orig.is_read,
+      orig.is_system_message,
+      orig.is_sent,
+      orig.is_forward,
+      orig.is_service_message,
+      orig.is_spam,
+      orig.error,
+
+      -- Big Data
+      HEX(orig.attributedBody) as attributedBody_hex,
+      HEX(orig.payload_data) as payload_data_hex,
+      unarchive_keyed(m.payload_data) as payload_json
+
+
+    FROM  _imsg.message orig
+    LEFT JOIN message_view m ON m.message_id = orig.ROWID
+    WHERE #{id_cond} = ?
+  SQL
+
+
+  id_cond = msg_id =~ /-/ ? "(SELECT ROWID FROM message WHERE guid = ?)" : "?"
+  Print.query(<<~SQL, msg_id)
+    SELECT a.ROWID, a.filename, a.mime_type, a.uti,
+    a.created_date,
+    a.hide_attachment,
+    a.total_bytes,
+    a.transfer_name
+    FROM _imsg.attachment a
+    JOIN _imsg.message_attachment_join maj ON a.ROWID = maj.attachment_id
+    JOIN _imsg.message m ON maj.message_id = m.ROWID
+    WHERE m.ROWID IN (#{id_cond})
+  SQL
+
+
+end
+
+if __FILE__ == $0 && ARGV[0]
+  ARGV.each do |id|
+    print_message_details(db, id)
+  end
+end

data/bin/sql-shell

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# Interactive SQL shell for querying the iMessage database with readline history
+
+require "bundler/setup"
+
+require_relative '../lib/imsg-grep/messages'
+require_relative '../lib/imsg-grep/dev/print_query'
+require 'readline'
+require 'fileutils'
+
+$db = Messages.init
+
+histfile = "#{ENV['HOME']}/.config/imsg-grep/history"
+FileUtils.mkdir_p File.dirname(histfile)
+Readline::HISTORY.push(*File.readlines(histfile).map(&:chomp)) if File.exist?(histfile)
+
+while buf = Readline.readline("sql> ", true)
+  break if buf.strip =~ /^(exit|quit)$/i
+  begin
+    Print.query(buf)
+    File.write(histfile, "#{buf}\n", mode: 'a')
+  rescue => e
+    puts "Error: #{e.message}"
+  end
+end

data/doc/HELP

@@ -0,0 +1,181 @@
+Usage: PROG [options ...] [PATTERN ...]
+
+Date filtering:
+    -d, --since DATE        Match after DATE
+    -u, --until DATE        Match before DATE
+    -Z, --utc               Parse and print dates as UTC
+
+Participant filtering:
+    -t, --to CONTACT        Match recipients
+    -f, --from CONTACT      Match sender
+    -w, --with CONTACT      Match sender or recipients
+    -c, --chat [PATTERN]    With no argument, match any group chat
+                            Otherwise PATTERN matches chat name
+
+Message filtering:
+    -M, --message PATTERN   Match message text
+                            Useful for boolean expressions: -f x --or -M y
+    -s, --sent              Only match sent
+    -r, --received          Only match received
+    -V, --service SRV       Filter by messaging service
+                            One of: any|imessage|rcs|sms (default: any)
+    -n, --max NUM           Only print top NUM messages
+    -a, --all               Allow calling with no conditions
+                            (will print every message unless -n)
+
+Link filtering:
+    -L, --links [PATTERN]   Find links with URL matching pattern
+                            With no argument, find all links
+    -Y, --youtube           Find youtube links
+    -S, --soundcloud        Find soundcloud links
+    -X, --twitter           Find twitter links
+
+Pattern modifiers:
+    -C, --smart-case        Case-sensitive only when pattern has uppercase
+                            letters (default; turn off with -i or -I)
+    -i, --ignore-case       Case-insensitive matches
+    -I, --no-ignore-case    Case-sensitive matches
+    -q, --literal           Literal string match, no regex
+    -x, --regexp            Regexp match (default; turn off with -q)
+    -v, --invert-match      Negate next pattern
+    -e, --exact             Next pattern must match full string
+    -A, --and [PATTERN]     Must also appear with previous condition
+    -O, --or [PATTERN]      Either previous or next condition may occur
+                            Without argument, affect the following condition
+
+Format:
+    --[no-]color            Enable/disable color output (default: yes if tty)
+    -W, --no-wrap           Don't wrap text
+    -l, --one-line          "[from -> to] message", newlines stripped
+                            With --json, disable pretty print
+    -U, --urls              Print only URLs in place of message text
+                            Prefer canonical URLs if available
+                            No change when no link present
+    -m, --no-meta           Print only text or capture
+                            No from/to headers, link or file details
+    -N, --short-names       Shorten participant names like "First L"
+                            Truncate chat names if --one-line
+    -T, --tiny              Same as --short-names --one-line --urls
+    -k, --count             Print total messages found at the end
+    -o, --capture [EXPR]    Print only matched string, or EXPR
+    -j, --json              JSON output
+    -P, --payload           Include payload in JSON
+    -R, -z, --reverse       Reverse sort order (oldest first)
+
+Media:
+    -F, --files [KIND|KEY:PATTERN]
+                            Find messages with files of KIND
+                            or matching pattern for KEY
+                            KIND: any (default) or images
+                            KEY: name, ext, mime
+    -b, --list-files        List attached files (default in normal list)
+    -B, --no-list-files     Do not list attached files
+    -p, --preview [KIND]    Inline image preview (requires terminal support)
+                            KIND is some of: images, links; both if not given
+    -g, --img, --images     Same as --files=images --preview=images
+    -Q, --silence-warnings  Suppress warning messages and hints
+
+Other:
+    --version               Print version
+    --reset                 Clear and rebuild cache
+    -h, --help              Show this help (see more with --help)
+    --help-dates            Show detailed DATE help
+
+~~LONG HELP BELOW~~
+
+DATES
+
+  ISO8601 format (time/TZ optional): '2024-12-30', '2024-12-30 12:34'
+
+  Relative format: 4y (years), 1m5w (months+weeks), 30min, 3a (3am today)
+
+  Times default to local unless TZ specified or -Z used. See --help-dates for
+  details.
+
+LOGICAL EXPRESSIONS
+
+  Conditions for --from, --chat, and --service are OR'd with others from same
+  option. --links, -Y, -X, -S too are all OR'd together.
+
+  Everything else is AND'ed by default. Chains of explicit --and/--or combine
+  as a single expression. Then get AND'ed with the rest. ANDs bind before ORs.
+
+  '-f x --or y' is shorthand for '-f x --or -f y'.
+
+  Mixing options is possible: '-fX -O -c -A -Mfoo'.
+
+PATTERNS
+
+  PATTERN or CONTACT is a regular expression.
+
+  CONTACT matches address book information: You can give part of a name, phone
+  number, email. It doesn't matter which one a message was sent/received from.
+
+  Smart-case is the default case, which means case-insensitive, unless
+  uppercase letters present. Use -q to match literal strings, -i and -I to
+  change case sensitivity.
+
+  The flags -q, -x, -i, -I, and -C affect all subsequent patterns.
+  -e and -v affect the immediate next pattern only.
+
+CAPTURE
+
+  EXPR is a format string for the message output where you can use capture
+  groups (alongside any text).
+
+  - When EXPR omitted, the entire match is presented. ('-o' = '-o"\0"')
+  - When it's a digit, that capture group is presented. ('-o1' = '-o"\1"')
+  - A comma-separated list of digits outputs those groups joined by space.
+  - When it's a format string: "foo \1 bar \2", interpolates the captures.
+
+  For a pattern to be available for capture, it must not be part of a logical
+  expression (--and/or) nor negated (-v).
+
+  If multiple message patterns are given, the last is used for capture.
+
+FILES AND IMAGES
+
+  Inline image previews are possible on terminals that support it. We implement
+  iTerm and Kitty (Ghostty, etc) protocols.
+
+  Previews are available for links and image files. You can preview both (-p)
+  or either (-pi, -pl).
+
+  Filter files by:
+    --files                  # messages having any files at all
+    --files=images           # with images
+    --files=ext:'jpe?g|png'  # with jpeg, jpg, png extensions
+    --files=mime:video       # video files
+    --files=name:'\bcats?\b' # files with word 'cat' or 'cats' in the name
+
+  JSON output does not include files by default. Use '-b' to include.
+
+OTHER NOTES
+
+  '--to foo' will find a message sent by someone else to a group where foo
+  is a member. Use '--sent' will constrain to only messages you sent, and '-vc'
+  will exclude group chats entirely.
+
+  When listing links, using '--urls' is advisable so you get a shorter,
+  resolved (often canonical) URL.
+
+  Most things can be abbreviated, some combined:
+    --rev     = --reverse
+    -Vi,r     = --service=imessage --or --service=rcs
+    -Fn:bar,i = --files=name:bar --or --files=images
+
+  You cannot combine patterns by comma, but you can use '|': --from 'foo|bar'
+  This is generally simpler than using '--or' for same option.
+
+  Most things are regular expressions, even where you don't expect it.
+  Cf. file filter above.
+
+EXAMPLES
+
+  PROG pattern                  # Message contents search
+  PROG -f Alice pattern         # From Alice
+  PROG -d 2024-01-01 pattern    # Since date
+  PROG -o '1,2' '(\w+):(\d+)'   # Capture groups
+  PROG -eqIf andy@example.com -xit 'pedro|bob' -c
+    matches case-sensitive, literal, exact (whole email) andy@example.com
+    sender, and case-insensitive regexp recipient, and must be a group chat.

data/doc/HELP_DATES

@@ -0,0 +1,72 @@
+Date and Time Format Reference
+
+This tool accepts flexible date and time inputs for filtering messages.
+
+ABSOLUTE DATES
+  2024-01-01              Today's date in YYYY-MM-DD format
+  2024-1-1                Relaxed format (single digits OK)
+  2024-12-31              Any valid date
+
+DATES WITH TIME
+  2024-01-01 10:30        Date with time (inherits your timezone, unless -Z)
+  2024-01-01T10:30        ISO format with T separator
+  2024-01-01 10:30:45     Include seconds
+  2024-01-01T10:30Z       UTC timezone (Z suffix)
+  2024-01-01T10:30+05     Explicit timezone (short)
+  2024-01-01T10:30+05:30  Explicit timezone offset
+  2024-01-01T10:30-08:00  Negative timezone offset
+
+TIME ONLY (uses today's date, respecting -Z)
+  1:34                    24-hour format
+  23:59                   24-hour format
+  10a, 10am               10 AM
+  10p, 10pm               10 PM
+  12:34a                  12:34 AM (midnight hour)
+  12:45p                  12:45 PM (noon hour)
+  0:34a                   12:34 AM
+  1a                      1 AM
+  1p                      1 PM
+
+RELATIVE DATES (how far back)
+  1d                      1 day ago
+  7d                      7 days ago
+  1w                      1 week ago
+  2w                      2 weeks ago
+  1m                      1 month ago
+  6m                      6 months ago
+  1y                      1 year ago
+  2y                      2 years ago
+
+COMBINE RELATIVE DATES
+  1y6m                    1 year 6 months ago
+  1y6m2w3d                1 year 6 months 2 weeks 3 days ago
+  6m1w                    6 months 1 week ago
+
+RELATIVE TIME
+  1h                      1 hour ago
+  30M                     30 minutes ago (capital M for minutes)
+  30min                   30 minutes ago (alternative)
+  45s                     45 seconds ago
+  2h30M                   2 hours 30 minutes ago
+  1h30M45s                1 hour 30 minutes 45 seconds ago
+
+COMBINE DATE AND TIME
+  3d2h                    3 days 2 hours ago
+  1d12h30M                1 day 12 hours 30 minutes ago
+  5d3h15M30s              5 days 3 hours 15 minutes 30 seconds ago
+  1min2d                  2 days 1 minute ago (order doesn't matter)
+  1d1d2m4m                6 months, 2 days ago (additive)
+
+NOTES
+- Optional minus sign: -1d same as 1d
+- Case insensitive: 10AM, 10am, 10A all work
+- M = minutes, m = months in relative times
+- 12am = midnight, 12pm = noon
+- Invalid dates will show an error
+
+EXAMPLES
+  --since 2024-01-01      Messages after January 1, 2024
+  --until 3d              Messages before 3 days ago
+  --since 1y6m            Messages after 1 year 6 months ago
+  --until 10:30p          Messages before 10:30 PM today
+  --since "2d 3h"         Messages after 2 days 3 hours ago

data/ext/extconf.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+
+require "mkmf"
+
+# Check if dylib already exists
+dylib_path = File.join *%W[ #{File.dirname __FILE__} .. lib imsg-grep images img2png.dylib ]
+if File.exist?(dylib_path)
+  # Create no-op Makefile since dylib already exists
+  File.open("Makefile", "w") do |f|
+    f.puts <<~MAKEFILE
+      SHELL = /bin/sh
+
+      all:
+      \t@echo "dylib already exists, skipping build"
+
+      install:
+      \t@echo "dylib already exists, skipping install"
+
+      clean:
+
+      distclean:
+      \trm -f Makefile
+
+      .PHONY: all install clean distclean
+    MAKEFILE
+  end
+  exit 0
+end
+
+# Check for explicit disable via environment variable
+images_disabled = %w[0 no false].include?(ENV['IMSGGREP_IMAGES']&.downcase)
+
+# Check build requirements
+
+is_darwin    = RUBY_PLATFORM.include?("darwin")
+found_swiftc = find_executable("swiftc")
+
+has_requirements = is_darwin && found_swiftc
+
+if has_requirements
+  # Create Swift compilation Makefile
+  File.open("Makefile", "w") do |f|
+    f.puts <<~MAKEFILE
+      SHELL = /bin/sh
+
+      DLLIB = img2png.dylib
+
+      all: $(DLLIB)
+
+      $(DLLIB): img2png.swift
+      \tswiftc -O -whole-module-optimization -lto=llvm-full -emit-library -D LIBRARY -o $(DLLIB) img2png.swift
+
+      install: $(DLLIB)
+      \tmkdir -p $(sitearchdir)/imsg-grep/images
+      \tcp $(DLLIB) $(sitearchdir)/imsg-grep/images/$(DLLIB)
+
+      clean:
+      \trm -f $(DLLIB)
+
+      distclean: clean
+      \trm -f Makefile
+
+      .PHONY: all install clean distclean
+    MAKEFILE
+  end
+elsif images_disabled
+  # User explicitly disabled image support
+  File.open("Makefile", "w") do |f|
+    f.puts <<~MAKEFILE
+      SHELL = /bin/sh
+
+      all:
+      \t@echo "Image processing disabled via IMSGGREP_IMAGES environment variable"
+
+      install:
+      \t@echo "Image processing disabled via IMSGGREP_IMAGES environment variable"
+
+      clean:
+
+      distclean:
+      \trm -f Makefile
+
+      .PHONY: all install clean distclean
+    MAKEFILE
+  end
+else
+  # Requirements not met - show helpful error and fail
+  $stderr.puts "ERROR: img2png extension build requirements not met:"
+  $stderr.puts "  - Requires macOS (current platform: #{RUBY_PLATFORM})" unless is_darwin
+  $stderr.puts "  - Requires swiftc (install Xcode or Swift toolchain)" unless found_swiftc
+  $stderr.puts ""
+  $stderr.puts "To build without image support, set:"
+  $stderr.puts "  export IMSGGREP_IMAGES=0"
+  $stderr.puts ""
+
+  abort "Build failed due to missing requirements"
+end