ipreader 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+pkg/*
+*.gem
+.bundle
+.redcar
+test/try_*
+test/tmp/*
+bin/try_*
+coverage/*

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+group :test do
+  gem "fakefs", :git => "git://github.com/vertiginous/fakefs.git"
+  gem "mocha"
+end
+
+gem "haml", ">=3.0.24"
+gem "sqlite3-ruby", :require => "sqlite3"
+
+#group :development do
+#end
+
+# Specify your gem's dependencies in ipreader.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GIT
+  remote: git://github.com/vertiginous/fakefs.git
+  revision: 7a35534e02128c95650d59fd95d34ef7cb04313b
+  specs:
+    fakefs (0.3.1)
+
+PATH
+  remote: .
+  specs:
+    ipreader (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    haml (3.0.25)
+    mocha (0.9.9)
+      rake
+    rake (0.8.7)
+    sqlite3 (1.3.3-x86-mingw32)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  fakefs!
+  haml (>= 3.0.24)
+  ipreader!
+  mocha
+  sqlite3-ruby

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/ext_sms

@@ -0,0 +1,12 @@
+##!/usr/bin/env ruby
+
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+dir_name = "/users/{user}/AppData/Roaming/Apple\ Computer/MobileSync/Backup/{directory name}"
+output_format = "html"
+
+dir_name = ARGV[0] if ARGV.length == 1
+output_format = ARGV[1] if ARGV.length == 2
+
+require "ipreader"
+Ipreader.Controller.read_backups(dir_name, output_format)

data/bin/ext_sms.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+#$:.unshift File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+require 'optparse'
+require_relative "../ipreader"
+
+OptionParser.accept(Date, /(\d+)-(\d+)-(\d+)/) do |d, mon, day, year|
+  Date.new( year.to_i, mon.to_i, day.to_i )
+end
+
+opts = OptionParser.new
+
+opts.banner = "Usage: ext_sms [ options ]"
+
+opts.on("-h", "--help", "-?", "show this message") do
+  puts opts
+  exit
+end
+
+format = "html"
+opts.on("-fo", "--format FORMAT", String, "Output format, one of [html, csv, xml]") do |fmt|
+  format = fmt
+end
+
+backup_path = ""
+opts.on("-p", "--path PATHNAME", "Path to backup directory") do |pth|
+  backup_path = pth
+end
+
+# TODO add date filters
+filters = {}
+opts.on("-fi", "--filters 'COLUMN_NAME:value'", String, "Filter to apply, columns [address:value[, text:value]]") do |fltrs|
+  fltrs.scan(/(\w+):\s*(\w+)/) do |name, value|
+    filters[name] = "%" + value + "%"
+  end
+end
+
+begin
+  ARGV << "-h" if ARGV.empty?
+  opts.parse!(ARGV)
+  backup_reader = Ipreader::Controller.new(backup_path, format, filters)
+  puts backup_reader.start
+rescue OptionParser::ParseError => e
+  STDERR.puts e.message, "\n", opts
+  exit(-1)
+end
+
+

data/ipreader/database_utils.rb

@@ -0,0 +1,82 @@
+require 'sqlite3'
+require 'date'
+
+module Ipreader
+  
+  module Database
+    
+    module Utils
+      
+      def is_sqlite3?(full_name)
+        return false if full_name.nil? 
+        file_data = File.open(full_name, "r") 
+        file_header = file_data.gets
+        file_header =~ /^SQLite format 3/
+      end      
+      
+      def sms_db?(full_name)
+        return false if full_name.nil? 
+        SQLite3::Database.new(full_name) do |db|
+          begin
+            if db.execute("SELECT count(*) FROM SQLITE_MASTER WHERE type='table' AND name='message'").flatten.first > 0
+              return true
+            else 
+              return false
+            end
+            rescue SQLite3::SQLException, SQLite3::IOException, NilClass => e
+              return false
+          end
+        end
+      end
+  
+      def read_sms_table(full_name, filters = {} )
+        
+        sms_list = Array.new
+        SQLite3::Database.new(full_name) do |db|
+          
+          message_table_columns = db.execute2("SELECT * FROM message LIMIT 0").flatten
+          column_keys = filters.keys.collect { |k| k.to_s }
+          non_matched_columns = column_keys - message_table_columns
+          if non_matched_columns.length > 0
+            raise ArgumentError, "can't find column [#{non_matched_columns}] in messages" 
+            exit
+          else
+            optional_filters = ""
+            filters.keys.each do |filter|
+            optional_filters += " AND #{filter} LIKE :#{filter}"
+          end
+            sql =  "SELECT rowid, date(date,'unixepoch'), address, text, flags, time(date,'unixepoch')"
+            sql += " FROM message"
+            sql += " WHERE text is not null #{optional_filters}"
+            sql += " ORDER BY address AND date ASC"
+            
+#            puts "sql=#{sql}"
+#            sql += " LIMIT 5"
+
+            begin
+              db.execute(sql, filters) do |row|
+                direction = case row[4]
+                when 2 then "to"
+                when 3 then "from"
+                else "??"
+                end
+                # TODO connascence of position
+                row_hash = { :rowid => row[0],
+                  :on_date => row[1], 
+                  :at_time => row[5], 
+                  :address => row[2],
+                  :direction => direction, 
+                  :text => row[3]
+                }
+                sms_list << row_hash
+              end
+            rescue SQLite3::Exception => e
+            end
+          end
+        end
+        return sms_list
+      end
+  
+    end
+  end
+end

data/ipreader/display.rb

@@ -0,0 +1,42 @@
+module Ipreader
+
+  module Display
+    
+#    KNOWN_FORMATS = [ "xml", "csv", "html" ]
+#    NO_TEMPLATE = "no template chosen"
+#    TEMPLATE_LOCATION = "templates"
+    
+    @missing = ''
+
+    def which_template(format)
+     known_fmt = lambda { |item| KNOWN_FORMATS.include?(item) }
+      case format
+        when known_fmt
+          "#{Ipreader::TEMPLATE_LOCATION}/sms.#{format.strip}.haml"
+        else
+          @missing = format
+          "#{Ipreader::TEMPLATE_LOCATION}/sms.missing.haml"
+      end
+    end
+
+    def template_location(templ)
+      File.join(File.dirname(__FILE__), which_template(templ))
+    end
+    
+    def display_sms( template_type = "html" , conversations = nil)
+      temp_loc = template_location(template_type)
+      render_template(File.read(temp_loc), conversations)
+    end
+
+    def render_template( template = nil, conversations = nil )
+      unless template.nil?
+        Haml::Engine.new(template).render( Object.new, :conversations => conversations, :missing => @missing )
+      else
+        Ipreader::NO_TEMPLATE
+      end
+    end
+    
+  end
+
+  
+end

data/ipreader/templates/sms.csv.haml

@@ -0,0 +1,3 @@
+"rowid","on_date","at_time","direction","text"
+- conversations.each do |sms|
+  #{sms[:rowid]},#{sms[:on_date]},#{sms[:at_time]},#{sms[:direction]},#{sms[:text]}

data/ipreader/templates/sms.html.haml

@@ -0,0 +1,10 @@
+!!! Strict
+%html
+  %head
+  %body
+    - conversations.each do |sms|
+      %p== #{ sms[:rowid] }
+      %p== #{ sms[:on_date] }
+      %p== #{ sms[:at_time] }
+      %p{ :class => sms[:direction] } 
+        = sms[:text]

data/ipreader/templates/sms.missing.haml

@@ -0,0 +1 @@
+I'am missing a template for "#{missing}"

data/ipreader/templates/sms.xml.haml

@@ -0,0 +1,6 @@
+- conversations.each do |sms|
+  %rowid== #{ sms[:rowid] }
+  %on-date== #{ sms[:on_date] }
+  %on-time== #{ sms[:at_time] }
+  %direction== #{ sms[:direction] }
+  %text== #{ sms[:text] }

data/ipreader/version.rb

@@ -0,0 +1,7 @@
+module Ipreader
+  module Backup
+    module Reader
+      VERSION = "0.0.1"
+    end
+  end
+end

data/ipreader.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.dirname(__FILE__)
+#$:.push File.join( File.dirname(__FILE__),'ipreader' )
+require "ipreader/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ipreader"
+  s.version     = Ipreader::Backup::Reader::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["David Rabbich"]
+  s.email       = ["davidrabbich@yahoo.co.uk"]
+  s.homepage    = "http://rubygems.org/gems/ipreader"
+  s.summary     = %q{ Reads an unencrypted IPhone backup store and queries the sms data within it. }
+  s.description = %q{ Takes as input a directory location of the Apple backup store and interrogates the back up data for SMS data }
+
+  s.rubyforge_project = "ipreader"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/ipreader.rb

@@ -0,0 +1,49 @@
+require 'date'
+require 'haml'
+require 'sqlite3'
+
+require_relative "ipreader/database_utils"
+require_relative "ipreader/display"
+
+module Ipreader
+
+  KNOWN_FORMATS = [ "xml", "csv", "html" ]
+  NO_TEMPLATE = "no template chosen"
+  LIBRARY_LOCATION = "ipreader"
+  TEMPLATE_LOCATION = "templates"
+  
+  class Controller
+
+    include Ipreader::Database::Utils
+    include Ipreader::Display
+
+    def initialize(backup_path = nil, format = "html" , filters = {} )
+      @conversations = []
+      @backup_path = backup_path
+      @template_type = format
+      @filters = filters
+    end
+
+    def start
+      read_backups
+      display_sms(@template_type, @conversations.flatten)
+    end
+    
+    # control which backup directories to read through
+    # TODO more than one backup directory
+    # TODO more than one database type
+    def read_backups
+      Dir.foreach(@backup_path) do |file_name|
+        full_name = File.join(@backup_path, file_name)
+        unless File.directory?(full_name) 
+          if is_sqlite3?(full_name)
+            @conversations << read_sms_table(full_name, @filters) if sms_db?(full_name)
+          end
+        end
+      end
+     # @conversations
+    end
+    
+  end
+    
+end

data/test/test_database_utils.rb

@@ -0,0 +1,46 @@
+require_relative "test_helper"  
+require_relative "../ipreader/database_utils"
+
+require 'fakefs/safe'
+
+class TestDatabaseUtils < Test::Unit::TestCase
+
+  include FakeFS
+  
+  class IpDbUtils
+    include Ipreader::Database::Utils
+  end
+  
+  def setup
+    @ipdbutils = IpDbUtils.new
+    FakeFS.activate!    
+    FileSystem.clear
+  end
+  
+  def teardown
+    FakeFS.deactivate!
+  end
+  
+  must "is_sqlite3? returns true the given file IS in a Sqlite3 format" do
+    test_db_path = File.join(test_root, "tmp", "sqlite3_valid_fake.sqlite3" )
+    File.open(test_db_path, 'w') { |f| f.write "SQLite format 3" }
+    assert @ipdbutils.is_sqlite3?(test_db_path), "first characters of a valid SQLite3 database should be 'SQLite format 3'"
+  end
+
+  must "is_sqlite3? returns false if the given file is NOT a valid Sqlite3 format" do
+    test_bad_path = File.join(test_root, "tmp", "sqlite3_invalid_fake.MSSQL" )
+    File.open(test_bad_path, 'w') { |f| f.write "SQL Server 2000" }
+    refute @ipdbutils.is_sqlite3?(test_bad_path), "should return false to a non SQLite3 file"
+  end
+  
+  must "return false if the SQLite3 file is malformed" do
+    test_malformed_path = File.join(test_root, "tmp", "sqlite3_malformed_fake.sqlite3" )
+    File.open(test_malformed_path, 'w') { |f| f.write "xxxxxxxxxxxxxxSQLite format 3" }
+    refute @ipdbutils.is_sqlite3?(test_malformed_path), "first characters are not a valid SQLite3 database"
+  end  
+  
+  must "fail gracefully if the given file does not exist" do
+    refute @ipdbutils.is_sqlite3?(nil), "should return false when no file is given"
+  end
+  
+end

data/test/test_database_utils2.rb

@@ -0,0 +1,98 @@
+require_relative "test_helper"  
+require_relative "../ipreader/database_utils"
+require "sqlite3"
+
+class TestDatabaseUtils < Test::Unit::TestCase
+
+  SMS_TABLE_CREATE = "CREATE TABLE message (rowid INTEGER, date TEXT, address TEXT, text TEXT, flags INTEGER)"
+  
+  class IpDbUtils
+    include Ipreader::Database::Utils
+  end
+  
+  def setup
+    @db_name = File.join(File.dirname(__FILE__), "tmp/dummy.sqlite3")
+    file_teardown(@db_name) if File.exists?(@db_name)
+    @ipdbutils = IpDbUtils.new
+    @db = SQLite3::Database.new @db_name
+  end
+  
+  def teardown
+    @db.close unless @db.closed?
+    GC.start
+    file_teardown(@db_name) 
+  end
+  
+  def file_teardown(file_name)
+    File.delete(file_name) if File.exists?(file_name)
+  end
+  
+  must "recognise an sms backup" do
+    @db.execute SMS_TABLE_CREATE
+    assert @ipdbutils.sms_db?(@db_name)
+  end
+
+  must "recognise when database is not an sms backup" do
+    @db.execute "CREATE TABLE smerf (name VARCHAR(30))"
+    refute @ipdbutils.sms_db?(@db_name)
+  end
+
+  must "fail gracefully if passed a file name that is not a SQLite3 database" do
+    dummy_file = File.join(test_root, "tmp/empty.sqlite3")
+    File.open(dummy_file, "w") { |df| df.puts " " } # "w" truncates existing db contents
+    refute @ipdbutils.sms_db?(dummy_file)
+  end  
+  
+  must "fail gracefully if passed a nil reference" do
+    refute @ipdbutils.sms_db?(nil)
+  end
+  
+  def setup_testdb
+    @db.execute SMS_TABLE_CREATE
+    @test_sms = []
+    (1..4).each do |test_item|
+      insert_sms = "INSERT INTO message (rowid, date, address, text, flags) VALUES( '#{test_item}', '2011-01-31 12:00:00', '+4479867#{test_item}#{test_item}#{test_item}#{test_item}', 'sms text #{test_item}', '2' );"
+      @db.execute(insert_sms)
+      @test_sms << { 
+        :rowid    => test_item, 
+        :on_date  => "2011/01/31", 
+        :at_time  => "12:00:00", 
+        :address  => "+4479867#{test_item}#{test_item}#{test_item}#{test_item}",
+        :direction => 'to',
+        :text     => "sms text #{test_item}"
+      }
+    end    
+  end
+  
+  must "return all rows when no filter is applied" do 
+    setup_testdb
+    test_result = @ipdbutils.read_sms_table(@db_name)
+    assert_equal test_result, @test_sms
+    assert_equal @test_sms.length, test_result.length
+  end
+  
+  must "correctly use the options hash to filter sms data" do
+    setup_testdb
+    result = []
+    result << @test_sms.first
+    options = { :address => "+44798671111" }
+    test_result = @ipdbutils.read_sms_table(@db_name, options)
+    assert_equal test_result, result
+    assert_equal test_result.length, 1
+  end
+  
+  must "ignore case when filtering sms data" do
+    setup_testdb
+    options = { :text => "sms text 1" }
+    assert_equal @ipdbutils.read_sms_table(@db_name, options).length, 1
+    options = { :text => "SMS TEXT 1" }
+    assert_equal @ipdbutils.read_sms_table(@db_name, options).length, 1
+  end
+  
+  must "ignore surplus options without erroring" do
+    setup_testdb
+    options = { :telephone => "011232131232" }
+    assert_raises(ArgumentError) { @ipdbutils.read_sms_table(@db_name, options) }
+  end
+
+end

data/test/test_display.rb

@@ -0,0 +1,66 @@
+require_relative "test_helper"  
+require_relative "../ipreader/display"
+
+class TestDisplay < Test::Unit::TestCase
+
+  class IpDisplay
+    include Ipreader::Display
+  end
+  
+  def setup
+    @display = IpDisplay.new
+    @unknown_fmt = "any-unknown-format"
+  end
+  
+  known_template_formats.each do |fmt|
+    must "respond with 'templates/sms.#{fmt}.haml' when display_format gets a known format '#{fmt}'" do
+      assert_equal @display.which_template(fmt), "templates/sms.#{fmt}.haml"
+    end
+  end
+  must "respond with missing template when display_format gets an unknown format of #{@unknown_fmt}" do
+    assert_equal @display.which_template(@unknown_fmt), "templates/sms.missing.haml"
+  end
+  
+  must "have an real life template for each of the list of known formats" do
+    known_template_formats.each do |fmt|
+      assert File.exists?(@display.template_location(fmt)), "template #{fmt} does not actually exist"
+    end
+  end
+  
+  must "have a library directory where the library constant defines it" do
+    library_path = File.join(app_root, library_loc)
+    assert File.directory?(library_path), "library #{library_path} does not actually exist"
+  end
+
+  must "have a template directory where the template_path constant defines it" do
+    template_path = File.join(app_root, library_loc, template_loc)
+    assert File.directory?(template_path), "template directory #{template_path} does not actually exist"
+  end
+  
+  must "create the correct fully qualified template name" do
+    assert_equal @display.template_location("html"), File.join(templates_path,"sms.html.haml")
+  end
+
+  # def display_sms(template)
+  #  temp_loc = template_location(template)
+  #  display_template(File.read(temp_loc))
+  # end  
+  #  must "read from the correct template location" do
+  #    mock_template = flexmock(File).should_receive(:read).with("html").and_return(:ok)
+  #    assert_equal :ok, @display.display_sms("html")
+  #  end
+  
+  # def render_template( template = nil )
+  #   unless template.nil?
+  #     Haml::Engine.new(template).render( Object.new, :conversations => @conversations, :missing => @missing )
+  #   else
+  #     NO_TEMPLATE
+  #   end
+  # end  
+  must "return a no template message if no template is passed" do
+    assert_equal @display.render_template(nil), no_template
+  end
+  #  must "render the and html template correctly" do
+  #  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+require "minitest/unit"
+require_relative "test_unit_extensions"
+require "flexmock/test_unit"
+require_relative "../ipreader"
+
+
+def template_loc
+  Ipreader::TEMPLATE_LOCATION
+end
+
+def library_loc
+  Ipreader::LIBRARY_LOCATION
+end
+
+def no_template
+  Ipreader::NO_TEMPLATE
+end
+
+def known_template_formats
+  Ipreader::KNOWN_FORMATS
+end
+
+def app_root 
+  File.expand_path(File.join(File.dirname(__FILE__),".."))
+end
+
+def test_root
+  File.join(app_root,"test")
+end
+
+def templates_path
+  File.join(app_root, library_loc, template_loc)
+end

data/test/test_unit_extensions.rb

@@ -0,0 +1,20 @@
+module MiniTest
+  class Unit
+    # Used to fix a minor minitest/unit incompatibility in flexmock 
+    AssertionFailedError = Class.new(StandardError)
+    class TestCase
+      def self.must(name, &block)
+        test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+        defined = instance_method(test_name) rescue false
+        raise "#{test_name} is already defined in #{self}" if defined
+        if block_given?
+          define_method(test_name, &block)
+        else
+          define_method(test_name) do
+            flunk "No implementation provided for #{name}"
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: ipreader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: !!null 
+platform: ruby
+authors:
+- David Rabbich
+autorequire: !!null 
+bindir: bin
+cert_chain: []
+date: 2011-03-15 00:00:00.000000000 +00:00
+default_executable: !!null 
+dependencies: []
+description: ! ' Takes as input a directory location of the Apple backup store and
+  interrogates the back up data for SMS data '
+email:
+- davidrabbich@yahoo.co.uk
+executables:
+- ext_sms
+- ext_sms.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- bin/ext_sms
+- bin/ext_sms.rb
+- ipreader.gemspec
+- ipreader.rb
+- ipreader/database_utils.rb
+- ipreader/display.rb
+- ipreader/init.rb
+- ipreader/templates/sms.csv.haml
+- ipreader/templates/sms.html.haml
+- ipreader/templates/sms.missing.haml
+- ipreader/templates/sms.xml.haml
+- ipreader/version.rb
+- test/test_database_utils.rb
+- test/test_database_utils2.rb
+- test/test_display.rb
+- test/test_helper.rb
+- test/test_unit_extensions.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/ipreader
+licenses: []
+post_install_message: !!null 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ipreader
+rubygems_version: 1.5.0
+signing_key: !!null 
+specification_version: 3
+summary: Reads an unencrypted IPhone backup store and queries the sms data within
+  it.
+test_files: []