chronicle-imessage 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e5b5b2c2b15c1a26c52871284d921960d825d24303b1d872d4d25c8d8782229
-  data.tar.gz: 5597cc2177ae72c86c2cc9a96b75f29dc5c07b0fe2053304e0e880b4d93919c5
+  metadata.gz: 708f7221b523605befa9a52e8fd375d79fc2a82109cf55c04fe145d53a1465b7
+  data.tar.gz: 570cbd92f6c52f8149fbebc18f5f961f314a5e3908983a2ce702ce324d2b88ac
 SHA512:
-  metadata.gz: bbae018587ad66e2a3ed05a5d7e878058cfac6c747fc283fbc54995f07bbbfc6aacaeddfaa16ae6ceb9d9547f0b4c20d692ce6a4fc059d542ca4621dec0b819c
-  data.tar.gz: ffc6247be044ebe0cfc58f545b10e7d622ebff3c82dc230c8f412abb61f971bce981bb6edcb58fbbe507a7cb8d639e8b19063ec6b66c2e332584e2c416357ab6
+  metadata.gz: e3d7c77e1fe7ee50ab51a4d11566c5c0ab5279b347f1b946c42cb376b6382ed2687af7d0431c5d30ef87bf8bc2c8f58ccf185d2ee5ebd91a99b47af7756ef31d
+  data.tar.gz: 51ed17c712516215615f964859ba08cb59deeb6a9d91811865e3b8e226bff1e357fafe04a52fd19a0e545dfe05fc4e309bdcc47853be6c177b80a1e319001643

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 --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

@@ -36,8 +36,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "chronicle-etl", "~> 0.4"
-  spec.add_dependency "sqlite3", "~> 1.4.2"
-  spec.add_dependency "phonelib", "~> 0.6.54"
+  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

@@ -13,6 +13,11 @@ module Chronicle
       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
@@ -23,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
@@ -37,14 +44,32 @@ module Chronicle
       def prepare_data
         @db = SQLite3::Database.new(@config.db, results_as_hash: true)
         @messages = load_messages
-        @contacts = LocalContacts.new.contacts
         @chats = load_chats
 
+        @local_contacts = LocalContacts.new
+        @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_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 = []
 

data/lib/chronicle/imessage/imessage_transformer.rb

@@ -8,9 +8,6 @@ module Chronicle
         r.description = 'a row from a local imessage database'
       end
 
-      setting :my_phone_slug, required: true
-      setting :my_name, required: true
-
       def transform
         @message = @extraction.data
         @participants = @extraction.meta[:participants]
@@ -118,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: @config.my_phone_slug,
-          title: @config.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.2.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chronicle-imessage
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew Louis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2022-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronicle-etl
@@ -30,28 +30,28 @@ dependencies:
     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
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.9
 signing_key: 
 specification_version: 4
 summary: iMessage importer for Chronicle