firefox-json 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 134532c5c458ea1344c83744b89887468b180a160407d60d1a2f55ab9fa10bee
+  data.tar.gz: 4154350cbcc37b82a240be051c930e61479e7a6cfcc5a938d36d47a980983902
+SHA512:
+  metadata.gz: 5389d7be95eae2054691c170202ea8f847888e10986a9c64d3d39b73e0450ac517d7322fb2afb151cf63527ef5a9a09898cb3f2fd0966830f42244506ccc17b2
+  data.tar.gz: f8147fd5b4751f080ca6178e6495473337ce8019aa302032226fa105b7614bd7767ea1664da44a6220297e6d3f18ee012fd0607423b71704dcdcaf6430c34b06

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2018 Boris Peterbarg <reist.sa@gmail.com>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# FirefoxJson
+
+`firefox-json` is a library to view and/or manipulate the json files in Firefox profiles.
+
+It's capable of reading both the older .js and the new .jsonlz4 files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'firefox-json'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firefox-json
+
+## Usage
+
+For now, all the library can do is manipulate sessions - the window and tab collections.
+
+### Getting a session
+
+```ruby
+FirefoxJson.available_profiles
+=> ["default", "some-other-profile"]
+session = FirefoxJson.load_profile('default').session
+=> #<Firefox::Session# windows=1 closed=1>
+```
+
+### Digging in
+
+```ruby
+session.closed_windows
+=> [#<Firefox::Window closed! tabs=1 selected="Some Title">]
+_[0].tabs
+=> [#<Firefox::Tab entries=1 selected="Some Title">]
+e = _[0].entries[0]
+=> #<Firefox::Entry http://www.site.com/a-page>
+e.public_methods - Object.methods
+=> [:url, :title, :referrer, :domain, :dump, :path, :path=, :save, :required_key, :reload]
+e.referrer
+=> "https://www.google.com/long-search-string"
+e.domain
+=> "www.site.com"
+```
+
+### Recovering a closed window
+
+```ruby
+session.windows << session.closed_windows.shift # you can add `.tap { |w| w.is_closed = false }` to remove the `closed!` part
+=> [#<Firefox::Window tabs=15 closed=2 selected="Google">, #<Firefox::Window closed! tabs=3 selected="Ruby Programming Language">]
+session
+=> #<Firefox::Session# windows=2>
+session.save # or session.save('some_other_file.js')
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/reist/firefox-json.
+
+## License
+
+The gem is available as open source under the terms of the [ISC License](https://opensource.org/licenses/ISC).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "firefox-json"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/firefox-json.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'firefox-json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'firefox-json'
+  spec.version       = FirefoxJson::VERSION
+  spec.date          = '2018-03-20'
+  spec.summary       = %q{Read and manipulate Firefox's json files.}
+  spec.homepage      = 'https://github.com/reist/firefox-json'
+  spec.license       = 'ISC'
+  spec.author        = 'Boris Peterbarg'
+  spec.email         = 'boris.sa@gmail.com'
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_runtime_dependency 'oj', '~> 3.5'
+  spec.add_runtime_dependency 'inifile', '~> 3.0'
+  spec.add_runtime_dependency 'extlz4', '~> 0.2.5'
+end

data/lib/firefox-json.rb

@@ -0,0 +1,13 @@
+require "firefox-json/version"
+require "firefox-json/profiles"
+
+module FirefoxJson
+  def self.available_profiles
+    Profiles.new.list
+  end
+
+  def self.load_profile(name)
+    profiles = Profiles.new
+    profiles[name]
+  end
+end

data/lib/firefox-json/js_file.rb

@@ -0,0 +1,63 @@
+require 'extlz4'
+require 'oj'
+
+module FirefoxJson
+  # Saves and restores files
+  module JsFile
+    MOZ_ID = "mozLz40\0"
+    MOZ_PREFIX = MOZ_ID.size + 4
+    MAX_SIZE = 1 << 32 - 1
+    OFFSETS = [1 << 24, 1 << 16, 1 << 8, 1]
+
+    class FileTooLarge < RuntimeError; end
+
+    def self.load_file(path)
+      load(IO.read(path))
+    end
+
+    def self.load(string)
+      if string[0, MOZ_ID.size] == MOZ_ID
+        string = decompress(string)
+      end
+      Oj.load(string, mode: :strict)
+    end
+
+    def self.save(path, data)
+      string = Oj.dump(data, mode: :strict)
+      if path.end_with?('jsonlz4')
+        File.open(path, 'wb') do |file|
+          file.write(compress(string))
+        end
+      else
+        File.open(path, 'w') do |file|
+          file.write(string)
+        end
+      end
+    end
+
+    def self.decompress(string)
+      string.force_encoding(Encoding::BINARY)
+      size = string[8, 4].bytes.zip(OFFSETS.reverse).map do |byte, offset|
+        byte * offset
+      end.sum
+      string = LZ4.block_decode(string[MOZ_PREFIX..-1])
+      if string.bytesize != size
+        raise "Expected size #{size} != #{string.bytesize}"
+      end
+      string.force_encoding(Encoding::UTF_8)
+    end
+
+    def self.compress(string)
+      size = string.bytesize
+      if size > MAX_SIZE
+        raise FileTooLarge, 'Content over 4GB!'
+      end
+      sstr = OFFSETS.map do |offset|
+        part = size / offset
+        size %= offset
+        part
+      end.reverse.pack('c*')
+      MOZ_ID + sstr + LZ4.block_encode(string)
+    end
+  end
+end

data/lib/firefox-json/profiles.rb

@@ -0,0 +1,48 @@
+require 'inifile'
+require 'firefox-json/session'
+
+module FirefoxJson
+  # Access to the profiles.ini file that links to all defined profiles and their locations
+  class Profiles
+    # Collects methods to access a single profile's session file
+    class Profile
+      def initialize(data, ff_path)
+        @data = data
+        @ff_path = ff_path
+      end
+
+      def path
+        @path ||= @data['IsRelative'] == 1 ? File.join(@ff_path, @data['Path']) : @data['Path']
+      end
+
+      def session
+        Session.default(path)
+      end
+
+      def recovery_session
+        Session.recovery(path)
+      end
+    end
+
+    def initialize(path = File.join(Dir.home, '.mozilla/firefox'))
+      @ff_path = path
+      data = IniFile.load(File.join(@ff_path, 'profiles.ini'))
+      p_sections = data.sections.select {|section| section.start_with?('Profile')}
+      @profile_map = p_sections.reduce({}) do |hash, section|
+        profile = data[section]
+        hash[profile['Name'].freeze] = profile.freeze
+        hash
+      end
+    end
+
+    def list
+      @profile_map.keys.dup
+    end
+
+    def [](name)
+      if @profile_map.key?(name)
+        Profile.new(@profile_map[name], @ff_path)
+      end
+    end
+  end
+end

data/lib/firefox-json/session.rb

@@ -0,0 +1,302 @@
+require 'firefox-json/js_file'
+
+module FirefoxJson
+  module Session
+    class Base
+      attr_accessor :path
+      @@inherited = []
+
+      def initialize data, path: nil
+        setup data
+        @path = path
+      end
+
+      def inspect
+        to_s
+      end
+
+      def eql? object
+        object.is_a?(self.class) && hash == object.hash
+      end
+
+      def setup data
+        unless data && data[required_key]
+          raise ArgumentError, "Not a Firefox #{self.class.name.downcase} - missing #{required_key} key"
+        end
+        @data = data
+      end
+      protected :setup
+
+      def reload
+        raise ArgumentError, 'Path not given' unless @path
+        @data = JsFile.load_file(@path)
+      end
+
+      def dump
+        @data
+      end
+
+      def save path=nil
+        path ||= @path
+        raise ArgumentError, 'Path not given' unless path
+        JsFile.save(path, dump)
+      end
+
+      def self.inherited klass
+        @@inherited << klass
+      end
+
+      def self.children
+        @@inherited
+      end
+
+      def self.choose_for data
+        children.find { |klass| data.key? klass.required_key }
+      end
+
+      def self.mattr_accessor name
+        class_eval <<-CODE, __FILE__, __LINE__ + 1
+          def self.#{name}
+            @#{name}
+          end
+          def #{name}
+            self.class.#{name}
+          end
+        CODE
+      end
+
+      def self.required_key= key
+        @required_key = key.freeze
+      end
+      mattr_accessor :required_key
+
+      def self.set_collection item_class, index_key, with_closed = false
+        include Collection
+        @index_key = index_key
+        @item_class = item_class
+        base_key_name = item_class.name.split('::')[-1].sub(/y$/, 'ie') + 's'
+        self.required_key = base_key_name.downcase
+        define_method @required_key do
+          @collection
+        end
+        if with_closed
+          @closed_key = "_closed#{base_key_name}"
+          define_method "closed_#{required_key}" do
+            @closed_collection
+          end
+        end
+      end
+    end
+
+    # Management of collections, closed items and the item in focus
+    module Collection
+      def self.included target
+        target.send(:attr_reader, :selected_idx)
+        [:item_class, :closed_key, :index_key].each do |accessor|
+          target.mattr_accessor accessor
+        end
+      end
+
+      def setup data
+        super
+        @collection = convert required_key, false
+        if closed_key
+          @closed_collection = convert closed_key, true
+        end
+        @selected_idx = @data[index_key]
+        sanify_selected_idx
+      end
+
+      def convert key, is_closed
+        @data[key].map {|hash| item_class.new(hash, is_closed)}
+      end
+
+      def selected_idx= idx
+        if send(required_key).size >= idx
+          @selected_idx = idx
+        else
+          @selected_idx
+        end
+      end
+
+      def sanify_selected_idx
+        if !@selected_idx || @selected_idx > send(required_key).size
+          reset_selected_idx
+        else
+          @selected_idx
+        end
+      end
+
+      def reset_selected_idx
+        @selected_idx = send(required_key).size
+      end
+
+      def selected
+        send(required_key)[@selected_idx-1]
+      end
+
+      def dump
+        @data[index_key] = sanify_selected_idx
+        @data[required_key] = @collection.map(&:dump)
+        if closed_key
+          @data[closed_key] = @closed_collection.map(&:dump)
+        end
+        super
+      end
+    end
+
+    # The base of the session - a specific viewed site
+    class Entry < Base
+      attr_reader :url, :title, :referrer
+      self.required_key = 'url'
+
+      def initialize data, _closed
+        setup data
+        @url = data['url']
+        @title = data['title']
+        @referrer = data['referrer']
+        @id = data['id']
+        @docshell_id = data['docshellID']
+        @doc_identifier = data['docIdentifier']
+      end
+
+      def domain
+        url.split('/')[2]
+      end
+
+      def hash
+        url.hash
+      end
+
+      def to_s
+        "#<FirefoxJson::Entry #{url}>"
+      end
+    end
+
+    # A tab collects all its history and knows whether it's closed or not
+    class Tab < Base
+      attr_reader :is_closed
+      set_collection Entry, 'index'
+
+      # is_closed passed from Window and means the real data is inside the 'state' key
+      def initialize data, is_closed
+        @is_closed = is_closed
+        if is_closed
+          @closed_data = data.reject {|key,_v| 'state' == key}
+        end
+        tab_state = is_closed ? data['state'] : data
+        setup tab_state
+      end
+
+      def hash
+        selected_url.hash
+      end
+
+      def dump
+        is_closed ? @closed_data.merge('state' => super) : super
+      end
+
+      def selected_title
+        selected&.title
+      end
+
+      def selected_url
+        selected&.url
+      end
+
+      def selected_domain
+        selected&.domain
+      end
+
+      def to_s
+        "#<FirefoxJson::Tab#{' closed!' if is_closed} entries=#{entries.size} selected=\"#{selected_title}\">"
+      end
+    end
+
+    # A collection of tabs, both current and previous
+    class Window < Base
+      attr_reader :is_closed
+      set_collection Tab, 'selected', true
+
+      def initialize data, is_closed = false
+        @is_closed = is_closed
+        setup data
+      end
+
+      def hash
+        tabs.hash
+      end
+
+      def current_urls
+        tabs.map(&:selected_url)
+      end
+
+      def selected_title
+        selected.selected.title
+      end
+
+      def by_domain
+        tabs.map(&:selected_domain).reduce(Hash.new(0)) {|h,host| h[host]+=1; h}.sort_by {|_,v| -v}
+      end
+
+      def to_s
+        "#<FirefoxJson::Window#{' closed!' if is_closed} tabs=#{tabs.size}#{' closed='+closed_tabs.size.to_s if closed_tabs.size>0} selected=\"#{selected_title}\">"
+      end
+    end
+
+    # A collection of windows, both current and previous
+    class Session < Base
+      set_collection Window, 'selectedWindow', true
+
+      def current_urls
+        windows.map(&:current_urls)
+      end
+
+      def to_s
+        closed_text = ' closed='+closed_windows.size.to_s if closed_windows.size>0
+        fname = File.basename(path).split('.')[0..-2].join('.')
+        warning = fname if fname != 'sessionstore'
+        "#<FirefoxJson::Session##{warning} windows=#{windows.size}#{closed_text}>"
+      end
+
+      def self.default_file(path)
+        Dir["#{path}/sessionstore.jsonlz4",
+            "#{path}/sessionstore.js"][0]
+      end
+
+      def self.recovery_file(path)
+        Dir["#{path}/sessionstore-backups/recovery.jsonlz4",
+            "#{path}/sessionstore-backups/recovery.js"][0]
+      end
+
+      def self.file(path)
+        default_file(path) || recovery_file(path)
+      end
+    end
+
+    BAD_ARG = 'Not Firefox session data'.freeze
+
+    def self.load string, path=nil
+      data = JsFile.load(string)
+      raise ArgumentError, BAD_ARG unless data.is_a?(Hash)
+      klass = Base.choose_for(data)
+      raise RuntimeError, BAD_ARG unless klass
+      klass.new(data, path: path)
+    end
+
+    def self.load_file(path)
+      load IO.read(path), path
+    end
+
+    def self.default(path)
+      file = Session.file(path) || Session.recovery_file(path)
+      raise "No session file found under #{path}" if !file
+
+      load_file file
+    end
+
+    def self.recovery(path)
+      load_file Session.recovery_file(path)
+    end
+  end
+end

data/lib/firefox-json/version.rb

@@ -0,0 +1,3 @@
+module FirefoxJson
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: firefox-json
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Boris Peterbarg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: extlz4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+description: 
+email: boris.sa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- firefox-json.gemspec
+- lib/firefox-json.rb
+- lib/firefox-json/js_file.rb
+- lib/firefox-json/profiles.rb
+- lib/firefox-json/session.rb
+- lib/firefox-json/version.rb
+homepage: https://github.com/reist/firefox-json
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Read and manipulate Firefox's json files.
+test_files: []