chronicle-imessage 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcaf59959a65537025a3ec616fc7edfed08aebcd6a9aca59569e8102553ada41
-  data.tar.gz: c78cc1e83b6fef4d41b710944484c935409e7833a30c5269792d59872579f4f4
+  metadata.gz: 76cac6e564a07e8e411e2378c43b15b812c4b4631dedcdee3863eedb0e3932e6
+  data.tar.gz: 7f7551136fae37aa832a98f9bd5ba386fceb7d4d1c0e3396eee4d64c0cbc03d0
 SHA512:
-  metadata.gz: a71a3c50cad2861c304b687c291fdcab1ef418c20a384f20c0a71ea2563a75ffec6937630288723d91620c5148224cf13ff143250b07e44bbd62dd893358421f
-  data.tar.gz: 6b4948f26b2e9d4aced7326c9f6f7bb5e031b6447c1885be8b85912209fc440a03047af01833e536fd8f31c9cf9205885fa0ea3edd5f69cf1da2f930065b2f0d
+  metadata.gz: fec05237d35c28b1ff9be65c5a60a622abdabec4c3726d7a91583c579891903e5ecd0860422c88bd35ef5b63d9f1c1fea807233dc6997ae6cd8ee3a0557dc4de
+  data.tar.gz: f1d909c69c41258d43d0175ad707dd1069f540527abc122460a587815ff0617fb7b452e2c53ac93de5bc366a6f0fae6ff89905d11edc7eca9b008096ab2f6c80

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+Gemfile.lock

data/README.md

@@ -13,7 +13,6 @@ IMessage importer for [chronicle-etl](https://github.com/chronicle-app/chronicle
 
 ```bash
 gem install chronicle-etl
-chronicle-etl connectors:install imessage
-
-chronicle-etl --extractor imessage --extractor-opts load_since:"2022-02-07" --transformer imessage --loader table
+chronicle-etl plugins:install imessage
+chronicle-etl --extractor imessage --since "2022-02-07" --transformer imessage
 ```

data/chronicle-imessage.gemspec

@@ -35,9 +35,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "chronicle-etl", "~> 0.3"
-  spec.add_dependency "sqlite3", "~> 1.4.2"
-  spec.add_dependency "phonelib", "~> 0.6.54"
+  spec.add_dependency "chronicle-etl", "~> 0.4.2"
+  spec.add_dependency "sqlite3", "~> 1.4"
+  spec.add_dependency "phonelib", "~> 0.6"
 
   spec.add_development_dependency "bundler", "~> 2.3"
   spec.add_development_dependency "rake", "~> 13.0.6"

data/lib/chronicle/imessage/imessage_extractor.rb

@@ -10,14 +10,16 @@ module Chronicle
         r.description = 'a local imessage database'
       end
 
-      DEFAULT_OPTIONS = {
-        db: File.join(Dir.home, 'Library', 'Messages', 'chat.db'),
-        load_attachments: false,
-        load_since: Time.now - 5000000
-      }.freeze
-
-      def initialize(options = {})
-        super(DEFAULT_OPTIONS.merge(options))
+      setting :db, default: File.join(Dir.home, 'Library', 'Messages', 'chat.db'), required: true
+      setting :load_attachments, default: false
+      setting :only_attachments, default: false
+      setting :my_phone_number
+      setting :my_name
+      setting :icloud_account_id
+      setting :icloud_account_dsid
+      setting :icloud_account_display_name
+
+      def prepare
         prepare_data
       end
 
@@ -26,6 +28,8 @@ module Chronicle
           meta = {}
           meta[:participants] = @chats[message['chat_id']]
           meta[:attachments] = @attachments[message['message_id']] if @attachments
+          meta[:my_phone_contact] = @my_phone_contact
+          meta[:my_icloud_account] = @my_icloud_account
 
           yield Chronicle::ETL::Extraction.new(data: message, meta: meta)
         end
@@ -38,34 +42,60 @@ module Chronicle
       private
 
       def prepare_data
-        @db = SQLite3::Database.new(@options[:db], results_as_hash: true)
-        @messages = load_messages(
-          load_since: @options[:load_since],
-          load_until: @options[:load_until],
-          limit: @options[:limit]
-        )
-        @contacts = LocalContacts.new.contacts
+        @db = SQLite3::Database.new(@config.db, results_as_hash: true)
+        @local_contacts = LocalContacts.new
+        @contacts = @local_contacts.contacts
+
+        @messages = load_messages
         @chats = load_chats
 
-        if @options[:load_attachments]
+        @my_phone_contact = load_my_phone_contact(@local_contacts)
+        @my_icloud_account = load_my_icloud_account(@local_contacts)
+
+        if @config.load_attachments
           @attachments = load_attachments(@messages.map{|m| m['message_id']})
         end
       end
 
-      def load_messages(load_since: nil, load_until: nil, limit: nil)
-        load_since_ios = unix_to_ios_timestamp(load_since.to_i) * 1000000000 if load_since
-        load_until_ios = unix_to_ios_timestamp(load_until.to_i) * 1000000000 if load_until
+      def load_my_phone_contact(local_contacts)
+        {
+          phone_number: @config.my_phone_number || local_contacts.my_phone_contact.fetch(:phone_number),
+          name: @config.my_name || local_contacts.my_phone_contact.fetch(:full_name)
+        }
+      end
+
+      def load_my_icloud_account(local_contacts)
+        {
+          id: @config.icloud_account_id || local_contacts.my_icloud_account.fetch(:AccountID),
+          dsid: @config.icloud_account_dsid || local_contacts.my_icloud_account.fetch(:AccountDSID),
+          display_name: @config.icloud_account_display_name || @config.my_name || local_contacts.my_icloud_account.fetch(:DisplayName)
+        }
+      end
+
+      def load_messages
+        conditions = []
+
+        if @config.until
+          load_until_ios = unix_to_ios_timestamp(@config.until.to_i) * 1000000000
+          conditions << "date < #{load_until_ios}"
+        end
+
+        if @config.since
+          load_since_ios = unix_to_ios_timestamp(@config.since.to_i) * 1000000000
+          conditions << "date > #{load_since_ios}"
+        end
+
+        if @config.only_attachments
+          conditions << "cache_has_attachments = true"
+        end
 
         sql = "SELECT * from message as m
           LEFT OUTER JOIN handle as h ON m.handle_id=h.ROWID
           INNER JOIN chat_message_join as cm ON m.ROWID = cm.message_id"
 
-        conditions = []
-        conditions << "date < #{load_until_ios}" if load_until
-        conditions << "date > #{load_since_ios}" if load_since
         sql += " WHERE #{conditions.join(" AND ")}" if conditions.any?
         sql += " ORDER BY date DESC"
-        sql += " LIMIT #{limit}" if limit
+        sql += " LIMIT #{@config.limit}" if @config.limit
 
         messages = @db.execute(sql)
       end

data/lib/chronicle/imessage/imessage_transformer.rb

@@ -8,14 +8,6 @@ module Chronicle
         r.description = 'a row from a local imessage database'
       end
 
-      DEFAULT_OPTIONS = {
-      }.freeze
-
-      def initialize(*args)
-        super(*args)
-        @options = @options.reverse_merge(DEFAULT_OPTIONS)
-      end
-
       def transform
         @message = @extraction.data
         @participants = @extraction.meta[:participants]
@@ -123,14 +115,40 @@ module Chronicle
       end
 
       def build_identity_mine
+        case identity_provider(@message['service'])
+        when 'icloud'
+          build_identity_mine_icloud
+        when 'phone'
+          build_identity_mine_phone
+        end
+      end
+
+      def build_identity_mine_icloud
+        icloud_account = @extraction.meta[:my_icloud_account]
+        raise(UntransformableRecordError, "Missing iCloud account information") unless icloud_account
+
         record = ::Chronicle::ETL::Models::Entity.new({
-          represents: 'identity',
-          slug: @options[:my_phone_slug],
-          title: @options[:my_name],
-          provider: identity_provider(@message['service']),
-          provider_id: @message['account_guid']
+          represent: 'identity',
+          provider: 'icloud',
+          provider_id: icloud_account[:dsid],
+          title: icloud_account[:display_name],
+          slug: icloud_account[:id]
+        })
+        record.dedupe_on << [:provider, :represents, :slug]
+        record
+      end
+
+      def build_identity_mine_phone
+        phone_account = @extraction.meta[:my_phone_contact]
+        raise(UntransformableRecordError, "Missing own phone contact information") unless phone_account
+
+        record = ::Chronicle::ETL::Models::Entity.new({
+          represent: 'identity',
+          provider: 'phone',
+          title: phone_account[:name],
+          slug: phone_account[:phone_number]
         })
-        record.dedupe_on = [[:represents, :slug, :provider], [:represents, :provider, :provider_id]]
+        record.dedupe_on << [:provider, :represents, :slug]
         record
       end
 

data/lib/chronicle/imessage/local_contacts.rb

@@ -23,6 +23,14 @@ module Chronicle
         end
       end
 
+      def my_phone_contact
+        @my_phone_contact ||= load_my_phone_contact
+      end
+
+      def my_icloud_account
+        @my_icloud_account ||= load_my_icloud_account
+      end
+
       # The synced address book doesn't have a stable folder location so we 
       # have to search for it
       def find_local_icloud_address_book
@@ -30,6 +38,38 @@ module Chronicle
         Dir.glob(pattern).first
       end
 
+      def load_my_icloud_account
+        @my_icloud_account || begin
+          output = `defaults read MobileMeAccounts Accounts | plutil -convert json -r -o - -- -`
+          JSON.parse(output, symbolize_names: true).first
+        end
+      end
+
+      def load_my_phone_contact
+        sql = <<-SQL
+          SELECT
+            ZABCDPHONENUMBER.ZFULLNUMBER AS identifier,
+            ZABCDRECORD.ZFIRSTNAME as first_name,
+            ZABCDRECORD.ZLASTNAME as last_name
+          FROM
+            ZABCDRECORD,
+            ZABCDPHONENUMBER 
+          WHERE
+            ZABCDRECORD.Z_PK = ZABCDPHONENUMBER.ZOWNER  
+            AND ZABCDRECORD.zcontainerwherecontactisme IS NOT NULL 
+        SQL
+
+        results = @db.execute(sql)
+
+        guessed_number = results.first
+        return unless guessed_number
+
+        {
+          phone_number: Phonelib.parse(guessed_number['identifier'], "US").e164,
+          full_name: "#{guessed_number['first_name']} #{guessed_number['last_name']}"
+        }
+      end
+
       def load_phone_numbers
         sql = <<-SQL
           SELECT

data/lib/chronicle/imessage/version.rb

@@ -1,5 +1,5 @@
 module Chronicle
   module Imessage
-    VERSION = "0.1.0"
+    VERSION = "0.2.2"
   end
 end

data/lib/chronicle/imessage.rb

@@ -5,7 +5,5 @@ require "chronicle/imessage/local_contacts"
 
 module Chronicle
   module Imessage
-    class Error < StandardError; end
-    # Your code goes here...
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chronicle-imessage
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrew Louis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-07 00:00:00.000000000 Z
+date: 2022-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronicle-etl
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: phonelib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.54
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.54
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -90,7 +90,6 @@ files:
 - ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
@@ -123,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.9
 signing_key: 
 specification_version: 4
 summary: iMessage importer for Chronicle

data/Gemfile.lock

@@ -1,88 +0,0 @@
-PATH
-  remote: .
-  specs:
-    chronicle-imessage (0.1.0)
-      chronicle-etl (~> 0.3)
-      phonelib (~> 0.6.54)
-      sqlite3 (~> 1.4.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.0.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    chronic_duration (0.10.6)
-      numerizer (~> 0.1.1)
-    chronicle-etl (0.3.0)
-      activesupport
-      chronic_duration (~> 0.10.6)
-      colorize (~> 0.8.1)
-      marcel (~> 1.0.2)
-      mini_exiftool (~> 2.10)
-      nokogiri (~> 1.13)
-      runcom (~> 6.2)
-      sequel (~> 5.35)
-      sqlite3 (~> 1.4)
-      thor (~> 0.20)
-      tty-progressbar (~> 0.17)
-      tty-table (~> 0.11)
-    colorize (0.8.1)
-    concurrent-ruby (1.1.9)
-    i18n (1.9.1)
-      concurrent-ruby (~> 1.0)
-    marcel (1.0.2)
-    mini_exiftool (2.10.2)
-    mini_portile2 (2.7.1)
-    minitest (5.15.0)
-    nokogiri (1.13.1)
-      mini_portile2 (~> 2.7.0)
-      racc (~> 1.4)
-    numerizer (0.1.1)
-    pastel (0.8.0)
-      tty-color (~> 0.5)
-    phonelib (0.6.55)
-    racc (1.6.0)
-    rake (13.0.6)
-    refinements (7.18.0)
-    runcom (6.6.0)
-      refinements (~> 7.16)
-      xdg (~> 4.4)
-    sequel (5.53.0)
-    sqlite3 (1.4.2)
-    strings (0.2.1)
-      strings-ansi (~> 0.2)
-      unicode-display_width (>= 1.5, < 3.0)
-      unicode_utils (~> 1.4)
-    strings-ansi (0.2.0)
-    thor (0.20.3)
-    tty-color (0.6.0)
-    tty-cursor (0.7.1)
-    tty-progressbar (0.18.2)
-      strings-ansi (~> 0.2)
-      tty-cursor (~> 0.7)
-      tty-screen (~> 0.8)
-      unicode-display_width (>= 1.6, < 3.0)
-    tty-screen (0.8.1)
-    tty-table (0.12.0)
-      pastel (~> 0.8)
-      strings (~> 0.2.0)
-      tty-screen (~> 0.8)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    unicode_utils (1.4.0)
-    xdg (4.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.3)
-  chronicle-imessage!
-  rake (~> 13.0.6)
-
-BUNDLED WITH
-   2.3.6