19 #ifndef NET_INSTAWEB_REWRITER_PUBLIC_REWRITE_DRIVER_FACTORY_H_
20 #define NET_INSTAWEB_REWRITER_PUBLIC_REWRITE_DRIVER_FACTORY_H_
25 #include "pagespeed/controller/central_controller.h"
26 #include "pagespeed/kernel/base/abstract_mutex.h"
27 #include "pagespeed/kernel/base/basictypes.h"
28 #include "pagespeed/kernel/base/function.h"
29 #include "pagespeed/kernel/base/null_statistics.h"
30 #include "pagespeed/kernel/base/scoped_ptr.h"
31 #include "pagespeed/kernel/base/statistics.h"
32 #include "pagespeed/kernel/base/string.h"
33 #include "pagespeed/kernel/base/string_util.h"
34 #include "pagespeed/kernel/base/thread_system.h"
35 #include "pagespeed/kernel/thread/queued_worker_pool.h"
37 namespace pagespeed {
namespace js {
struct JsTokenizerPatterns; } }
39 namespace net_instaweb {
41 class CriticalImagesFinder;
42 class CriticalSelectorFinder;
44 class FlushEarlyInfoFinder;
45 class ExperimentMatcher;
48 class NamedLockManager;
54 class RewriteOptionsManager;
58 class StaticAssetManager;
60 class UrlAsyncFetcher;
62 class UsageDataReporter;
63 class UserAgentMatcher;
64 class UserAgentNormalizer;
78 kLowPriorityRewriteWorkers,
85 ThreadSystem* thread_system);
104 void set_message_handler(MessageHandler* message_handler);
105 void set_file_system(FileSystem* file_system);
106 void set_hasher(Hasher*
hasher);
107 void set_nonce_generator(NonceGenerator* nonce_generator);
108 void set_url_namer(
UrlNamer* url_namer);
109 void set_signature(SHA1Signature* signature);
110 void set_timer(Timer*
timer);
123 void set_slurp_read_only(
bool read_only);
124 void set_slurp_print_urls(
bool read_only);
141 bool set_filename_prefix(StringPiece p);
146 MessageHandler* html_parse_message_handler();
147 MessageHandler* message_handler();
148 FileSystem* file_system();
149 NonceGenerator* nonce_generator();
154 UserAgentMatcher* user_agent_matcher();
156 SHA1Signature* signature();
157 RewriteOptions* default_options() {
return default_options_.get(); }
158 virtual RewriteOptionsManager* NewRewriteOptionsManager();
165 NamedLockManager* lock_manager();
167 Scheduler* scheduler();
168 UsageDataReporter* usage_data_reporter();
169 const pagespeed::js::JsTokenizerPatterns* js_tokenizer_patterns()
const {
170 return js_tokenizer_patterns_;
172 const std::vector<const UserAgentNormalizer*>& user_agent_normalizers();
179 virtual UrlAsyncFetcher* ComputeDistributedFetcher();
202 virtual void SetupCaches(ServerContext* server_context) = 0;
229 ThreadSystem* thread_system() {
return thread_system_.get(); }
234 return created_directories_;
237 bool async_rewrites() {
return true; }
258 static void Terminate();
285 version_string.CopyToString(&version_string_);
309 bool FetchersComputed()
const;
310 virtual void StopCacheActivity();
311 StringPiece filename_prefix();
323 virtual MessageHandler* DefaultHtmlParseMessageHandler() = 0;
324 virtual MessageHandler* DefaultMessageHandler() = 0;
325 virtual FileSystem* DefaultFileSystem() = 0;
326 virtual NonceGenerator* DefaultNonceGenerator();
327 virtual Timer* DefaultTimer();
328 virtual SHA1Signature* DefaultSignature();
330 virtual Hasher* NewHasher() = 0;
347 virtual UrlAsyncFetcher* DefaultDistributedUrlFetcher() {
return NULL; }
349 virtual CriticalImagesFinder* DefaultCriticalImagesFinder(
350 ServerContext* server_context);
351 virtual CriticalSelectorFinder* DefaultCriticalSelectorFinder(
352 ServerContext* server_context);
365 virtual UserAgentMatcher* DefaultUserAgentMatcher();
366 virtual UsageDataReporter* DefaultUsageDataReporter();
375 std::vector<const UserAgentNormalizer*>* out);
419 NamedLockManager* lock_manager);
432 void SetupSlurpDirectories();
436 scoped_ptr<MessageHandler> html_parse_message_handler_;
437 scoped_ptr<MessageHandler> message_handler_;
438 scoped_ptr<FileSystem> file_system_;
441 scoped_ptr<UrlAsyncFetcher> base_url_async_fetcher_;
442 scoped_ptr<UrlAsyncFetcher> base_distributed_async_fetcher_;
443 scoped_ptr<Hasher> hasher_;
444 scoped_ptr<NonceGenerator> nonce_generator_;
445 scoped_ptr<SHA1Signature> signature_;
446 scoped_ptr<UrlNamer> url_namer_;
447 scoped_ptr<UserAgentMatcher> user_agent_matcher_;
452 std::vector<const UserAgentNormalizer*> user_agent_normalizers_;
453 scoped_ptr<StaticAssetManager> static_asset_manager_;
454 scoped_ptr<Timer> timer_;
455 scoped_ptr<Scheduler> scheduler_;
456 scoped_ptr<UsageDataReporter> usage_data_reporter_;
458 const pagespeed::js::JsTokenizerPatterns* js_tokenizer_patterns_;
460 GoogleString filename_prefix_;
461 GoogleString slurp_directory_;
463 bool slurp_read_only_;
464 bool slurp_print_urls_;
466 scoped_ptr<ThreadSystem> thread_system_;
469 typedef std::set<ServerContext*> ServerContextSet;
470 ServerContextSet server_contexts_;
471 scoped_ptr<AbstractMutex> server_context_mutex_;
475 scoped_ptr<RewriteOptions> default_options_;
484 scoped_ptr<ServerContext> decoding_server_context_;
485 scoped_ptr<RewriteDriver> decoding_driver_;
488 scoped_ptr<NamedLockManager> lock_manager_;
492 NullStatistics null_statistics_;
493 Statistics* statistics_;
495 StringSet created_directories_;
497 std::vector<QueuedWorkerPool*> worker_pools_;
501 scoped_ptr<RewriteStats> rewrite_stats_;
505 std::vector<Function*> deferred_cleanups_;
509 GoogleString version_string_;
512 GoogleString hostname_;
519 template<
class T>
class RewriteDriverFactory::Deleter :
public Function {
521 explicit Deleter(T* obj) : obj_(obj) {}
522 virtual void Run() {
delete obj_; }
Definition: url_namer.h:38
virtual RewriteOptions * NewRewriteOptions()
virtual int LowPriorityLoadSheddingThreshold() const
bool slurping_enabled() const
Determines whether Slurping is enabled.
Definition: rewrite_driver_factory.h:144
virtual RewriteOptions * NewRewriteOptionsForQuery()
virtual void InitStaticAssetManager(StaticAssetManager *static_asset_manager)
Initializes the StaticAssetManager.
Definition: rewrite_driver_factory.h:404
virtual void SetupCaches(ServerContext *server_context)=0
virtual void AddPlatformSpecificDecodingPasses(RewriteDriver *driver)
Definition: experiment_matcher.h:38
virtual FlushEarlyInfoFinder * DefaultFlushEarlyInfoFinder()
Default implementation returns NULL.
void RebuildDecodingDriverForTests(ServerContext *server_context)
For use in tests.
void InitializeDefaultOptions()
Definition: static_asset_manager.h:47
const GoogleString & version_string() const
get/set the version placed into the X-[Mod-]Page(s|-S)peed header.
Definition: rewrite_driver_factory.h:283
const StringSet & created_directories() const
Definition: rewrite_driver_factory.h:233
bool TerminateServerContext(ServerContext *server_context)
virtual UrlNamer * DefaultUrlNamer()
void set_force_caching(bool u)
Definition: rewrite_driver_factory.h:128
WorkerPoolCategory
Definition: rewrite_driver_factory.h:75
void set_html_parse_message_handler(MessageHandler *message_handler)
virtual ServerContext * NewServerContext()=0
virtual NamedLockManager * DefaultLockManager()
virtual Scheduler * CreateScheduler()
virtual ServerContext * NewDecodingServerContext()=0
void TakeOwnership(T *obj)
Definition: rewrite_driver_factory.h:295
void AddCreatedDirectory(const GoogleString &dir)
Registers the directory as having been created by us.
Make sure to insert new values above this line.
Definition: rewrite_driver_factory.h:80
void InitStubDecodingServerContext(ServerContext *context)
virtual ExperimentMatcher * NewExperimentMatcher()
void set_base_distributed_async_fetcher(UrlAsyncFetcher *distributed_fetcher)
Takes ownership of distributed_fetcher.
virtual UrlAsyncFetcher * ComputeUrlAsyncFetcher()
virtual void AddPlatformSpecificRewritePasses(RewriteDriver *driver)
virtual void AddPlatformSpecificUserAgentNormalizers(std::vector< const UserAgentNormalizer * > *out)
virtual void FetcherSetupHooks()
Called before creating the url fetchers.
void defer_cleanup(Function *f)
Definition: rewrite_driver_factory.h:291
virtual CentralController * CreateCentralController(NamedLockManager *lock_manager)
RewriteDriverFactory(const ProcessContext &process_context, ThreadSystem *thread_system)
Takes ownership of thread_system.
virtual UrlAsyncFetcher * DefaultAsyncUrlFetcher()=0
ServerContext * CreateServerContext()
void set_base_url_async_fetcher(UrlAsyncFetcher *url_fetcher)
void InitServerContext(ServerContext *server_context)
Definition: server_context.h:100
static void Initialize()
Initializes static variables. Initialize/Terminate calls must be paired.
Definition: process_context.h:35
virtual QueuedWorkerPool * CreateWorkerPool(WorkerPoolCategory pool, StringPiece name)
Statistics * statistics()
Definition: rewrite_driver_factory.h:250
virtual StringPiece LockFilePrefix()
virtual void ApplyPlatformSpecificConfiguration(RewriteDriver *driver)
Definition: usage_data_reporter.h:35
void set_slurp_directory(const StringPiece &directory)
Helper for users of defer_cleanup; see below.
Definition: rewrite_driver_factory.h:73
void SetStatistics(Statistics *stats)
Does not take ownership of Statistics.
Definition: rewrite_options.h:84
virtual bool IsDebugClient(const GoogleString &ip) const
Base method that returns true if the given ip is a debug ip.
Definition: rewrite_driver_factory.h:300
RewriteStats * rewrite_stats()
Definition: url_async_fetcher.h:33
static void InitStats(Statistics *statistics)
virtual bool UseBeaconResultsInFilters() const =0
Definition: rewrite_driver_factory.h:70
virtual bool HasWaveforms() const
Returns true if the server supports waveforms in its status page.
Definition: rewrite_driver_factory.h:246