// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_NET_HTTP_SERVER_PROPERTIES_MANAGER_H_
#define CHROME_BROWSER_NET_HTTP_SERVER_PROPERTIES_MANAGER_H_
#include <string>
#include <vector>
#include "base/basictypes.h"
#include "base/compiler_specific.h"
#include "base/memory/scoped_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/prefs/pref_change_registrar.h"
#include "base/timer/timer.h"
#include "base/values.h"
#include "net/base/host_port_pair.h"
#include "net/http/http_pipelined_host_capability.h"
#include "net/http/http_server_properties.h"
#include "net/http/http_server_properties_impl.h"
class PrefService;
namespace user_prefs {
class PrefRegistrySyncable;
}
namespace chrome_browser_net {
////////////////////////////////////////////////////////////////////////////////
// HttpServerPropertiesManager
// The manager for creating and updating an HttpServerProperties (for example it
// tracks if a server supports SPDY or not).
//
// This class interacts with both the UI thread, where notifications of pref
// changes are received from, and the IO thread, which owns it (in the
// ProfileIOData) and it persists the changes from network stack that if a
// server supports SPDY or not.
//
// It must be constructed on the UI thread, to set up |ui_method_factory_| and
// the prefs listeners.
//
// ShutdownOnUIThread must be called from UI before destruction, to release
// the prefs listeners on the UI thread. This is done from ProfileIOData.
//
// Update tasks from the UI thread can post safely to the IO thread, since the
// destruction order of Profile and ProfileIOData guarantees that if this
// exists in UI, then a potential destruction on IO will come after any task
// posted to IO from that method on UI. This is used to go through IO before
// the actual update starts, and grab a WeakPtr.
class HttpServerPropertiesManager
: public net::HttpServerProperties {
public:
// Create an instance of the HttpServerPropertiesManager. The lifetime of the
// PrefService objects must be longer than that of the
// HttpServerPropertiesManager object. Must be constructed on the UI thread.
explicit HttpServerPropertiesManager(PrefService* pref_service);
virtual ~HttpServerPropertiesManager();
// Initialize |http_server_properties_impl_| and |io_method_factory_| on IO
// thread. It also posts a task to UI thread to get SPDY Server preferences
// from |pref_service_|.
void InitializeOnIOThread();
// Prepare for shutdown. Must be called on the UI thread, before destruction.
void ShutdownOnUIThread();
// Register |prefs| for properties managed here.
static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
// Helper function for unit tests to set the version in the dictionary.
static void SetVersion(base::DictionaryValue* http_server_properties_dict,
int version_number);
// Deletes all data. Works asynchronously, but if a |completion| callback is
// provided, it will be fired on the UI thread when everything is done.
void Clear(const base::Closure& completion);
// ----------------------------------
// net::HttpServerProperties methods:
// ----------------------------------
// Gets a weak pointer for this object.
virtual base::WeakPtr<net::HttpServerProperties> GetWeakPtr() OVERRIDE;
// Deletes all data. Works asynchronously.
virtual void Clear() OVERRIDE;
// Returns true if |server| supports SPDY. Should only be called from IO
// thread.
virtual bool SupportsSpdy(const net::HostPortPair& server) const OVERRIDE;
// Add |server| as the SPDY server which supports SPDY protocol into the
// persisitent store. Should only be called from IO thread.
virtual void SetSupportsSpdy(const net::HostPortPair& server,
bool support_spdy) OVERRIDE;
// Returns true if |server| has an Alternate-Protocol header.
virtual bool HasAlternateProtocol(const net::HostPortPair& server) OVERRIDE;
// Returns the Alternate-Protocol and port for |server|.
// HasAlternateProtocol(server) must be true.
virtual net::PortAlternateProtocolPair GetAlternateProtocol(
const net::HostPortPair& server) OVERRIDE;
// Sets the Alternate-Protocol for |server|.
virtual void SetAlternateProtocol(
const net::HostPortPair& server,
uint16 alternate_port,
net::AlternateProtocol alternate_protocol) OVERRIDE;
// Sets the Alternate-Protocol for |server| to be BROKEN.
virtual void SetBrokenAlternateProtocol(
const net::HostPortPair& server) OVERRIDE;
// Clears the Alternate-Protocol for |server|.
virtual void ClearAlternateProtocol(const net::HostPortPair& server) OVERRIDE;
// Returns all Alternate-Protocol mappings.
virtual const net::AlternateProtocolMap&
alternate_protocol_map() const OVERRIDE;
// Gets a reference to the SettingsMap stored for a host.
// If no settings are stored, returns an empty SettingsMap.
virtual const net::SettingsMap& GetSpdySettings(
const net::HostPortPair& host_port_pair) OVERRIDE;
// Saves an individual SPDY setting for a host. Returns true if SPDY setting
// is to be persisted.
virtual bool SetSpdySetting(const net::HostPortPair& host_port_pair,
net::SpdySettingsIds id,
net::SpdySettingsFlags flags,
uint32 value) OVERRIDE;
// Clears all SPDY settings for a host.
virtual void ClearSpdySettings(
const net::HostPortPair& host_port_pair) OVERRIDE;
// Clears all SPDY settings for all hosts.
virtual void ClearAllSpdySettings() OVERRIDE;
// Returns all SPDY persistent settings.
virtual const net::SpdySettingsMap& spdy_settings_map() const OVERRIDE;
virtual void SetServerNetworkStats(const net::HostPortPair& host_port_pair,
NetworkStats stats) OVERRIDE;
virtual const NetworkStats* GetServerNetworkStats(
const net::HostPortPair& host_port_pair) const OVERRIDE;
virtual net::HttpPipelinedHostCapability GetPipelineCapability(
const net::HostPortPair& origin) OVERRIDE;
virtual void SetPipelineCapability(
const net::HostPortPair& origin,
net::HttpPipelinedHostCapability capability) OVERRIDE;
virtual void ClearPipelineCapabilities() OVERRIDE;
virtual net::PipelineCapabilityMap GetPipelineCapabilityMap() const OVERRIDE;
protected:
// --------------------
// SPDY related methods
// These are used to delay updating of the cached data in
// |http_server_properties_impl_| while the preferences are changing, and
// execute only one update per simultaneous prefs changes.
void ScheduleUpdateCacheOnUI();
// Starts the timers to update the cached prefs. This are overridden in tests
// to prevent the delay.
virtual void StartCacheUpdateTimerOnUI(base::TimeDelta delay);
// Update cached prefs in |http_server_properties_impl_| with data from
// preferences. It gets the data on UI thread and calls
// UpdateSpdyServersFromPrefsOnIO() to perform the update on IO thread.
virtual void UpdateCacheFromPrefsOnUI();
// Starts the update of cached prefs in |http_server_properties_impl_| on the
// IO thread. Protected for testing.
void UpdateCacheFromPrefsOnIO(
std::vector<std::string>* spdy_servers,
net::SpdySettingsMap* spdy_settings_map,
net::AlternateProtocolMap* alternate_protocol_map,
net::PipelineCapabilityMap* pipeline_capability_map,
bool detected_corrupted_prefs);
// These are used to delay updating the preferences when cached data in
// |http_server_properties_impl_| is changing, and execute only one update per
// simultaneous spdy_servers or spdy_settings or alternate_protocol changes.
void ScheduleUpdatePrefsOnIO();
// Starts the timers to update the prefs from cache. This are overridden in
// tests to prevent the delay.
virtual void StartPrefsUpdateTimerOnIO(base::TimeDelta delay);
// Update prefs::kHttpServerProperties in preferences with the cached data
// from |http_server_properties_impl_|. This gets the data on IO thread and
// posts a task (UpdatePrefsOnUI) to update the preferences UI thread.
void UpdatePrefsFromCacheOnIO();
// Same as above, but fires an optional |completion| callback on the UI thread
// when finished. Virtual for testing.
virtual void UpdatePrefsFromCacheOnIO(const base::Closure& completion);
// Update prefs::kHttpServerProperties preferences on UI thread. Executes an
// optional |completion| callback when finished. Protected for testing.
void UpdatePrefsOnUI(
base::ListValue* spdy_server_list,
net::SpdySettingsMap* spdy_settings_map,
net::AlternateProtocolMap* alternate_protocol_map,
net::PipelineCapabilityMap* pipeline_capability_map,
const base::Closure& completion);
private:
void OnHttpServerPropertiesChanged();
// ---------
// UI thread
// ---------
// Used to get |weak_ptr_| to self on the UI thread.
scoped_ptr<base::WeakPtrFactory<HttpServerPropertiesManager> >
ui_weak_ptr_factory_;
base::WeakPtr<HttpServerPropertiesManager> ui_weak_ptr_;
// Used to post cache update tasks.
scoped_ptr<base::OneShotTimer<HttpServerPropertiesManager> >
ui_cache_update_timer_;
// Used to track the spdy servers changes.
PrefChangeRegistrar pref_change_registrar_;
PrefService* pref_service_; // Weak.
bool setting_prefs_;
// ---------
// IO thread
// ---------
// Used to get |weak_ptr_| to self on the IO thread.
scoped_ptr<base::WeakPtrFactory<HttpServerPropertiesManager> >
io_weak_ptr_factory_;
// Used to post |prefs::kHttpServerProperties| pref update tasks.
scoped_ptr<base::OneShotTimer<HttpServerPropertiesManager> >
io_prefs_update_timer_;
scoped_ptr<net::HttpServerPropertiesImpl> http_server_properties_impl_;
DISALLOW_COPY_AND_ASSIGN(HttpServerPropertiesManager);
};
} // namespace chrome_browser_net
#endif // CHROME_BROWSER_NET_HTTP_SERVER_PROPERTIES_MANAGER_H_