class HTTP::CookieJar::MozillaStore

stored persistently in the SQLite3 database.
Session cookies are stored separately on memory and will not be
backing store.
A store class that uses Mozilla compatible SQLite3 database as

def add(cookie)

def add(cookie)
  if cookie.session?
    @sjar.add(cookie)
    db_delete(cookie)
  else
    @sjar.delete(cookie)
    db_add(cookie)
  end
end

def cleanup(session = false)

def cleanup(session = false)
  synchronize {
    break if @gc_index == 0
    @stmt[:delete_expired].execute({ 'expiry' => Time.now.to_i })
    @stmt[:overusing_domains].execute({
        'count' => HTTP::Cookie::MAX_COOKIES_PER_DOMAIN
      }).each { |row|
      domain, count = row['domain'], row['count']
      @stmt[:delete_per_domain_overuse].execute({
          'domain' => domain,
          'limit' => count - HTTP::Cookie::MAX_COOKIES_PER_DOMAIN,
        })
    }
    overrun = count - HTTP::Cookie::MAX_COOKIES_TOTAL
    if overrun > 0
      @stmt[:delete_total_overuse].execute({ 'limit' => overrun })
    end
    @gc_index = 0
  }
  self
end

def clear

def clear
  @db.execute("DELETE FROM moz_cookies")
  @sjar.clear
  self
end

def close

raise an error.
Closes the SQLite3 database. After closing, any operation may
def close
  @db.closed? || @db.close
  self
end

def closed?

Tests if the SQLite3 database is closed.
def closed?
  @db.closed?
end

def create_table

def create_table
  self.schema_version = SCHEMA_VERSION
  @db.execute("DROP TABLE IF EXISTS moz_cookies")
  @db.execute(<<-'SQL')
               CREATE TABLE moz_cookies (
                 id INTEGER PRIMARY KEY,
                 baseDomain TEXT,
                 originAttributes TEXT NOT NULL DEFAULT '',
                 name TEXT,
                 value TEXT,
                 host TEXT,
                 path TEXT,
                 expiry INTEGER,
                 lastAccessed INTEGER,
                 creationTime INTEGER,
                 isSecure INTEGER,
                 isHttpOnly INTEGER,
                 appId INTEGER DEFAULT 0,
                 inBrowserElement INTEGER DEFAULT 0,
                 CONSTRAINT moz_uniqueid UNIQUE (name, host, path, originAttributes)
               )
  SQL
  @db.execute(<<-'SQL')
               CREATE INDEX moz_basedomain
                 ON moz_cookies (baseDomain,
                                 originAttributes);
  SQL
end

def create_table_v5

def create_table_v5
  self.schema_version = 5
  @db.execute("DROP TABLE IF EXISTS moz_cookies")
  @db.execute(<<-'SQL')
               CREATE TABLE moz_cookies (
                 id INTEGER PRIMARY KEY,
                 baseDomain TEXT,
                 appId INTEGER DEFAULT 0,
                 inBrowserElement INTEGER DEFAULT 0,
                 name TEXT,
                 value TEXT,
                 host TEXT,
                 path TEXT,
                 expiry INTEGER,
                 lastAccessed INTEGER,
                 creationTime INTEGER,
                 isSecure INTEGER,
                 isHttpOnly INTEGER,
                 CONSTRAINT moz_uniqueid UNIQUE (name, host, path, appId, inBrowserElement)
               )
  SQL
  @db.execute(<<-'SQL')
               CREATE INDEX moz_basedomain
                 ON moz_cookies (baseDomain,
                                 appId,
                                 inBrowserElement);
  SQL
end

def create_table_v6

def create_table_v6
  self.schema_version = 6
  @db.execute("DROP TABLE IF EXISTS moz_cookies")
  @db.execute(<<-'SQL')
               CREATE TABLE moz_cookies (
                 id INTEGER PRIMARY KEY,
                 baseDomain TEXT,
                 originAttributes TEXT NOT NULL DEFAULT '',
                 name TEXT,
                 value TEXT,
                 host TEXT,
                 path TEXT,
                 expiry INTEGER,
                 lastAccessed INTEGER,
                 creationTime INTEGER,
                 isSecure INTEGER,
                 isHttpOnly INTEGER,
                 CONSTRAINT moz_uniqueid UNIQUE (name, host, path, originAttributes)
               )
  SQL
  @db.execute(<<-'SQL')
               CREATE INDEX moz_basedomain
                 ON moz_cookies (baseDomain,
                                 originAttributes);
  SQL
end

def db_add(cookie)

def db_add(cookie)
  @stmt[:add].execute({
      :baseDomain => cookie.domain_name.domain || cookie.domain,
      :originAttributes => @origin_attributes,
      :name => cookie.name, :value => cookie.value,
      :host => cookie.dot_domain,
      :path => cookie.path,
      :expiry => cookie.expires_at.to_i,
      :creationTime => serialize_usectime(cookie.created_at),
      :lastAccessed => serialize_usectime(cookie.accessed_at),
      :isSecure => cookie.secure? ? 1 : 0,
      :isHttpOnly => cookie.httponly? ? 1 : 0,
      :appId => @app_id,
      :inBrowserElement => @in_browser_element ? 1 : 0,
    })
  cleanup if (@gc_index += 1) >= @gc_threshold
  self
end

def db_delete(cookie)

def db_delete(cookie)
  @stmt[:delete].execute({
      :appId => @app_id,
      :inBrowserElement => @in_browser_element ? 1 : 0,
      :name => cookie.name,
      :host => cookie.dot_domain,
      :path => cookie.path,
    })
  self
end

def db_prepare(sql)

def db_prepare(sql)
  st = @db.prepare(sql)
  yield st
ensure
  st.close if st
end

def default_options

def default_options
  {
    :gc_threshold => HTTP::Cookie::MAX_COOKIES_TOTAL / 20,
    :app_id => 0,
    :in_browser_element => false,
  }
end

def delete(cookie)

def delete(cookie)
  @sjar.delete(cookie)
  db_delete(cookie)
end

def deserialize_usectime(value)

def deserialize_usectime(value)
  Time.at(value ? value / 1e6 : 0)
end

def each(uri = nil, &block) # :yield: cookie

:yield: cookie
def each(uri = nil, &block) # :yield: cookie
  now = Time.now
  if uri
    thost = DomainName.new(uri.host)
    @stmt[:cookies_for_domain].execute({
        :baseDomain => thost.domain || thost.hostname,
        :appId => @app_id,
        :inBrowserElement => @in_browser_element ? 1 : 0,
        :expiry => now.to_i,
      }).each { |row|
      if secure = row['isSecure'] != 0
        next unless URI::HTTPS === uri
      end
      cookie = HTTP::Cookie.new({}.tap { |attrs|
          attrs[:name]        = row['name']
          attrs[:value]       = row['value']
          attrs[:domain]      = row['host']
          attrs[:path]        = row['path']
          attrs[:expires_at]  = Time.at(row['expiry'])
          attrs[:accessed_at] = deserialize_usectime(row['lastAccessed'])
          attrs[:created_at]  = deserialize_usectime(row['creationTime'])
          attrs[:secure]      = secure
          attrs[:httponly]    = row['isHttpOnly'] != 0
        })
      if cookie.valid_for_uri?(uri)
        cookie.accessed_at = now
        @stmt[:update_lastaccessed].execute({
            'lastAccessed' => serialize_usectime(now),
            'id' => row['id'],
          })
        yield cookie
      end
    }
    @sjar.each(uri, &block)
  else
    @stmt[:all_cookies].execute({
        :appId => @app_id,
        :inBrowserElement => @in_browser_element ? 1 : 0,
        :expiry => now.to_i,
      }).each { |row|
      cookie = HTTP::Cookie.new({}.tap { |attrs|
          attrs[:name]        = row['name']
          attrs[:value]       = row['value']
          attrs[:domain]      = row['host']
          attrs[:path]        = row['path']
          attrs[:expires_at]  = Time.at(row['expiry'])
          attrs[:accessed_at] = deserialize_usectime(row['lastAccessed'])
          attrs[:created_at]  = deserialize_usectime(row['creationTime'])
          attrs[:secure]      = row['isSecure'] != 0
          attrs[:httponly]    = row['isHttpOnly'] != 0
        })
      yield cookie
    }
    @sjar.each(&block)
  end
  self
end

def encode_www_form(enum)

def encode_www_form(enum)
  URI.encode_www_form(enum)
end

def encode_www_form(enum)

def encode_www_form(enum)
  enum.map { |k, v| "#{CGI.escape(k)}=#{CGI.escape(v)}" }.join('&')
end

def get_query_param(str, key)

def get_query_param(str, key)
  URI.decode_www_form(str).find { |k, v|
    break v if k == key
  }
end

def get_query_param(str, key)

def get_query_param(str, key)
  CGI.parse(str)[key].first
end

def initialize(options = nil)

element. (default: `false`)
: a flag to tell if cookies are stored in an in browser
:in_browser_element

: application ID (default: `0`) to have per application jar.
:app_id

been stored (default: `HTTP::Cookie::MAX_COOKIES_TOTAL / 20`)
: GC threshold; A GC happens when this many times cookies have
:gc_threshold

mandatory.
: A file name of the SQLite3 database to open. This option is
:filename

Available option keywords are as below:

data.
automatically upgraded with a new schema keeping the existing
it is created. If it does and its schema is old, it is
Generates a Mozilla cookie store. If the file does not exist,

new(**options)
:call-seq:
def initialize(options = nil)
  super
  @origin_attributes = encode_www_form({}.tap { |params|
    params['appId'] = @app_id if @app_id.nonzero?
    params['inBrowserElement'] = 1 if @in_browser_element
  })
  @filename = options[:filename] or raise ArgumentError, ':filename option is missing'
  @sjar = HTTP::CookieJar::HashStore.new
  @db = Database.new(@filename)
  @stmt = Hash.new { |st, key|
    st[key] = @db.prepare(SQL[key])
  }
  ObjectSpace.define_finalizer(self, Callable[@db, :close])
  upgrade_database
  @gc_index = 0
end

def initialize_copy(other)

Raises TypeError. Cloning is inhibited in this store class.
def initialize_copy(other)
  raise TypeError, 'can\'t clone %s' % self.class
end

def schema_version

Returns the schema version of the database.
def schema_version
  @schema_version ||= @db.execute("PRAGMA user_version").first["user_version"]
rescue SQLite3::SQLException
  @logger.warn "couldn't get schema version!" if @logger
  return nil
end

def schema_version= version

def schema_version= version
  @db.execute("PRAGMA user_version = %d" % version)
  @schema_version = version
end

def serialize_usectime(time)

def serialize_usectime(time)
  time ? (time.to_f * 1e6).floor : 0
end

def upgrade_database

def upgrade_database
  loop {
    case schema_version
    when nil, 0
      self.schema_version = SCHEMA_VERSION
      break
    when 1
      @db.execute("ALTER TABLE moz_cookies ADD lastAccessed INTEGER")
      self.schema_version += 1
    when 2
      @db.execute("ALTER TABLE moz_cookies ADD baseDomain TEXT")
      db_prepare("UPDATE moz_cookies SET baseDomain = :baseDomain WHERE id = :id") { |st_update|
        @db.execute("SELECT id, host FROM moz_cookies") { |row|
          domain_name = DomainName.new(row['host'][/\A\.?(.*)/, 1])
          domain = domain_name.domain || domain_name.hostname
          st_update.execute(:baseDomain => domain, :id => row['id'])
        }
      }
      @db.execute("CREATE INDEX moz_basedomain ON moz_cookies (baseDomain)")
      self.schema_version += 1
    when 3
      db_prepare("DELETE FROM moz_cookies WHERE id = :id") { |st_delete|
        prev_row = nil
        @db.execute(<<-'SQL') { |row|
                     SELECT id, name, host, path FROM moz_cookies
                       ORDER BY name ASC, host ASC, path ASC, expiry ASC
        SQL
          if %w[name host path].all? { |col| prev_row and row[col] == prev_row[col] }
            st_delete.execute(prev_row['id'])
          end
          prev_row = row
        }
      }
      @db.execute("ALTER TABLE moz_cookies ADD creationTime INTEGER")
      @db.execute("UPDATE moz_cookies SET creationTime = (SELECT id WHERE id = moz_cookies.id)")
      @db.execute("CREATE UNIQUE INDEX moz_uniqueid ON moz_cookies (name, host, path)")
      self.schema_version += 1
    when 4
      @db.execute("ALTER TABLE moz_cookies RENAME TO moz_cookies_old")
      @db.execute("DROP INDEX moz_basedomain")
      create_table_v5
      @db.execute(<<-'SQL')
                   INSERT INTO moz_cookies
                     (baseDomain, appId, inBrowserElement, name, value, host, path, expiry,
                      lastAccessed, creationTime, isSecure, isHttpOnly)
                     SELECT baseDomain, 0, 0, name, value, host, path, expiry,
                            lastAccessed, creationTime, isSecure, isHttpOnly
                       FROM moz_cookies_old
      SQL
      @db.execute("DROP TABLE moz_cookies_old")
    when 5
      @db.execute("ALTER TABLE moz_cookies RENAME TO moz_cookies_old")
      @db.execute("DROP INDEX moz_basedomain")
      create_table_v6
      @db.create_function('CONVERT_TO_ORIGIN_ATTRIBUTES', 2) { |func, appId, inBrowserElement|
        params = {}
        params['appId'] = appId if appId.nonzero?
        params['inBrowserElement'] = inBrowserElement if inBrowserElement.nonzero?
        func.result = encode_www_form(params)
      }
      @db.execute(<<-'SQL')
                   INSERT INTO moz_cookies
                     (baseDomain, originAttributes, name, value, host, path, expiry,
                      lastAccessed, creationTime, isSecure, isHttpOnly)
                     SELECT baseDomain,
                            CONVERT_TO_ORIGIN_ATTRIBUTES(appId, inBrowserElement),
                            name, value, host, path, expiry, lastAccessed, creationTime,
                            isSecure, isHttpOnly
                       FROM moz_cookies_old
      SQL
      @db.execute("DROP TABLE moz_cookies_old")
    when 6
      @db.execute("ALTER TABLE moz_cookies ADD appId INTEGER DEFAULT 0")
      @db.execute("ALTER TABLE moz_cookies ADD inBrowserElement INTEGER DEFAULT 0")
      @db.create_function('SET_APP_ID', 1) { |func, originAttributes|
        func.result = get_query_param(originAttributes, 'appId').to_i  # nil.to_i == 0
      }
      @db.create_function('SET_IN_BROWSER', 1) { |func, originAttributes|
        func.result = get_query_param(originAttributes, 'inBrowserElement').to_i  # nil.to_i == 0
      }
      @db.execute(<<-'SQL')
                   UPDATE moz_cookies SET appId = SET_APP_ID(originAttributes),
                                          inBrowserElement = SET_IN_BROWSER(originAttributes)
      SQL
      @logger.info("Upgraded database to schema version %d" % schema_version) if @logger
      self.schema_version += 1
    else
      break
    end
  }
  begin
    @db.execute("SELECT %s from moz_cookies limit 1" % ALL_COLUMNS.join(', '))
  rescue SQLite3::SQLException
    create_table
  end
end