Page Speed Optimization Libraries  1.8.31.2
net/instaweb/rewriter/public/rewrite_driver_factory.h
Go to the documentation of this file.
00001 /*
00002  * Copyright 2010 Google Inc.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *      http:///www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00018 
00019 #ifndef NET_INSTAWEB_REWRITER_PUBLIC_REWRITE_DRIVER_FACTORY_H_
00020 #define NET_INSTAWEB_REWRITER_PUBLIC_REWRITE_DRIVER_FACTORY_H_
00021 
00022 #include <set>
00023 #include <vector>
00024 
00025 #include "net/instaweb/util/public/basictypes.h"
00026 #include "net/instaweb/util/public/function.h"
00027 #include "net/instaweb/util/public/null_statistics.h"
00028 #include "net/instaweb/util/public/scoped_ptr.h"
00029 #include "net/instaweb/util/public/string.h"
00030 #include "net/instaweb/util/public/string_util.h"
00031 
00032 namespace pagespeed { namespace js { struct JsTokenizerPatterns; } }
00033 
00034 namespace net_instaweb {
00035 
00036 class AbstractMutex;
00037 class CacheHtmlInfoFinder;
00038 class CriticalCssFinder;
00039 class CriticalImagesFinder;
00040 class CriticalLineInfoFinder;
00041 class CriticalSelectorFinder;
00042 class FileSystem;
00043 class FlushEarlyInfoFinder;
00044 class ExperimentMatcher;
00045 class Hasher;
00046 class MessageHandler;
00047 class NamedLockManager;
00048 class NonceGenerator;
00049 class ProcessContext;
00050 class PropertyCache;
00051 class QueuedWorkerPool;
00052 class ServerContext;
00053 class RewriteDriver;
00054 class RewriteOptions;
00055 class RewriteOptionsManager;
00056 class RewriteStats;
00057 class Scheduler;
00058 class StaticAssetManager;
00059 class Statistics;
00060 class ThreadSystem;
00061 class Timer;
00062 class UrlAsyncFetcher;
00063 class UrlNamer;
00064 class UsageDataReporter;
00065 class UserAgentMatcher;
00066 class UserAgentNormalizer;
00067 
00072 class RewriteDriverFactory {
00073  public:
00075   template<class T> class Deleter;
00076 
00077   enum WorkerPoolCategory {
00078     kHtmlWorkers,
00079     kRewriteWorkers,
00080     kLowPriorityRewriteWorkers,
00082     kNumWorkerPools
00083   };
00084 
00086   RewriteDriverFactory(const ProcessContext& process_context,
00087                        ThreadSystem* thread_system);
00088 
00093   void InitializeDefaultOptions();
00094 
00095   virtual ~RewriteDriverFactory();
00096 
00101   void set_html_parse_message_handler(MessageHandler* message_handler);
00102   void set_message_handler(MessageHandler* message_handler);
00103   void set_file_system(FileSystem* file_system);
00104   void set_hasher(Hasher* hasher);
00105   void set_nonce_generator(NonceGenerator* nonce_generator);
00106   void set_url_namer(UrlNamer* url_namer);
00107   void set_timer(Timer* timer);
00108   void set_usage_data_reporter(UsageDataReporter* reporter);
00109 
00119   void set_slurp_directory(const StringPiece& directory);
00120   void set_slurp_read_only(bool read_only);
00121   void set_slurp_print_urls(bool read_only);
00122 
00125   void set_force_caching(bool u) { force_caching_ = u; }
00126 
00135   void set_base_url_async_fetcher(UrlAsyncFetcher* url_fetcher);
00137   void set_base_distributed_async_fetcher(UrlAsyncFetcher* distributed_fetcher);
00138   bool set_filename_prefix(StringPiece p);
00139 
00141   bool slurping_enabled() const { return !slurp_directory_.empty(); }
00142 
00143   MessageHandler* html_parse_message_handler();
00144   MessageHandler* message_handler();
00145   FileSystem* file_system();
00146   NonceGenerator* nonce_generator();
00149   Hasher* hasher();
00150   UrlNamer* url_namer();
00151   UserAgentMatcher* user_agent_matcher();
00152   StaticAssetManager* static_asset_manager();
00153   RewriteOptions* default_options() { return default_options_.get(); }
00154   virtual RewriteOptionsManager* NewRewriteOptionsManager();
00155 
00160   Timer* timer();
00161   NamedLockManager* lock_manager();
00162   QueuedWorkerPool* WorkerPool(WorkerPoolCategory pool);
00163   Scheduler* scheduler();
00164   UsageDataReporter* usage_data_reporter();
00165   const pagespeed::js::JsTokenizerPatterns* js_tokenizer_patterns() const {
00166     return js_tokenizer_patterns_;
00167   }
00168   const std::vector<const UserAgentNormalizer*>& user_agent_normalizers();
00169 
00174   virtual UrlAsyncFetcher* ComputeUrlAsyncFetcher();
00175   virtual UrlAsyncFetcher* ComputeDistributedFetcher();
00176 
00183   ServerContext* CreateServerContext();
00184 
00188   void InitServerContext(ServerContext* server_context);
00189 
00194   virtual void SetupCaches(ServerContext* server_context) = 0;
00195 
00199   virtual bool UseBeaconResultsInFilters() const = 0;
00200 
00204   virtual void AddPlatformSpecificRewritePasses(RewriteDriver* driver);
00205 
00214   virtual void AddPlatformSpecificDecodingPasses(RewriteDriver* driver);
00215 
00219   virtual void ApplyPlatformSpecificConfiguration(RewriteDriver* driver);
00220 
00221   ThreadSystem* thread_system() { return thread_system_.get(); }
00222 
00225   const StringSet& created_directories() const {
00226     return created_directories_;
00227   }
00228 
00229   bool async_rewrites() { return true; }
00230 
00235   RewriteStats* rewrite_stats();
00236 
00239   Statistics* statistics() { return statistics_; }
00240 
00243   static void InitStats(Statistics* statistics);
00244 
00246   static void Initialize();
00247   static void Terminate();
00248 
00250   void SetStatistics(Statistics* stats);
00251 
00255   virtual void ShutDown();
00256 
00258   void AddCreatedDirectory(const GoogleString& dir);
00259 
00264   virtual RewriteOptions* NewRewriteOptions();
00265 
00269   virtual RewriteOptions* NewRewriteOptionsForQuery();
00270 
00272   const GoogleString& version_string() const { return version_string_; }
00273   void set_version_string(const StringPiece& version_string) {
00274     version_string.CopyToString(&version_string_);
00275   }
00276 
00280   void defer_cleanup(Function* f) { deferred_cleanups_.push_back(f); }
00281 
00284   template<class T> void TakeOwnership(T* obj) {
00285     defer_cleanup(new RewriteDriverFactory::Deleter<T>(obj));
00286   }
00287 
00289   virtual bool IsDebugClient(const GoogleString& ip) const {
00290     return false;
00291   }
00292 
00295   virtual ExperimentMatcher* NewExperimentMatcher();
00296 
00298   const std::vector<int>* preferred_webp_qualities() {
00299     return &preferred_webp_qualities_;
00300   }
00301 
00303   const std::vector<int>* preferred_jpeg_qualities() {
00304     return &preferred_jpeg_qualities_;
00305   }
00306 
00308   bool SetPreferredWebpQualities(const StringPiece& qualities);
00309 
00311   bool SetPreferredJpegQualities(const StringPiece& qualities);
00312 
00313  protected:
00314   bool FetchersComputed() const;
00315   virtual void StopCacheActivity();
00316   StringPiece filename_prefix();
00317 
00321   bool TerminateServerContext(ServerContext* server_context);
00322 
00327   virtual UrlAsyncFetcher* DefaultAsyncUrlFetcher() = 0;
00328   virtual MessageHandler* DefaultHtmlParseMessageHandler() = 0;
00329   virtual MessageHandler* DefaultMessageHandler() = 0;
00330   virtual FileSystem* DefaultFileSystem() = 0;
00331   virtual NonceGenerator* DefaultNonceGenerator();
00332   virtual Timer* DefaultTimer();
00333 
00334   virtual Hasher* NewHasher() = 0;
00335 
00338   virtual ServerContext* NewServerContext() = 0;
00339 
00349   virtual ServerContext* NewDecodingServerContext() = 0;
00350 
00351   virtual UrlAsyncFetcher* DefaultDistributedUrlFetcher() { return NULL; }
00352 
00353   virtual CriticalCssFinder* DefaultCriticalCssFinder();
00354   virtual CriticalImagesFinder* DefaultCriticalImagesFinder(
00355       ServerContext* server_context);
00356   virtual CriticalSelectorFinder* DefaultCriticalSelectorFinder(
00357       ServerContext* server_context);
00358 
00360   virtual CacheHtmlInfoFinder* DefaultCacheHtmlInfoFinder(
00361       PropertyCache* cache, ServerContext* server_context);
00362 
00364   virtual FlushEarlyInfoFinder* DefaultFlushEarlyInfoFinder();
00365 
00367   virtual CriticalLineInfoFinder* DefaultCriticalLineInfoFinder(
00368       ServerContext* server_context);
00369 
00372   virtual NamedLockManager* DefaultLockManager();
00373 
00376   virtual UrlNamer* DefaultUrlNamer();
00377 
00378   virtual UserAgentMatcher* DefaultUserAgentMatcher();
00379   virtual UsageDataReporter* DefaultUsageDataReporter();
00380 
00387   virtual void AddPlatformSpecificUserAgentNormalizers(
00388       std::vector<const UserAgentNormalizer*>* out);
00389 
00393   virtual QueuedWorkerPool* CreateWorkerPool(WorkerPoolCategory pool,
00394                                              StringPiece name);
00395 
00402   virtual int LowPriorityLoadSheddingThreshold() const;
00403 
00406   virtual Scheduler* CreateScheduler();
00407 
00409   virtual void FetcherSetupHooks();
00410 
00414   virtual StringPiece LockFilePrefix();
00415 
00417   virtual void InitStaticAssetManager(
00418       StaticAssetManager* static_asset_manager) {}
00419 
00422   void InitStubDecodingServerContext(ServerContext* context);
00423 
00425   void RebuildDecodingDriverForTests(ServerContext* server_context);
00426 
00427  private:
00431   StaticAssetManager* DefaultStaticAssetManager();
00432 
00433   void SetupSlurpDirectories();
00434   void Init(); 
00435 
00436   void InitDecodingDriver(ServerContext* server_context);
00437 
00438   scoped_ptr<MessageHandler> html_parse_message_handler_;
00439   scoped_ptr<MessageHandler> message_handler_;
00440   scoped_ptr<FileSystem> file_system_;
00441   UrlAsyncFetcher* url_async_fetcher_;
00442   UrlAsyncFetcher* distributed_async_fetcher_;
00443   scoped_ptr<UrlAsyncFetcher> base_url_async_fetcher_;
00444   scoped_ptr<UrlAsyncFetcher> base_distributed_async_fetcher_;
00445   scoped_ptr<Hasher> hasher_;
00446   scoped_ptr<NonceGenerator> nonce_generator_;
00447   scoped_ptr<UrlNamer> url_namer_;
00448   scoped_ptr<UserAgentMatcher> user_agent_matcher_;
00449 
00453   std::vector<const UserAgentNormalizer*> user_agent_normalizers_;
00454   scoped_ptr<StaticAssetManager> static_asset_manager_;
00455   scoped_ptr<Timer> timer_;
00456   scoped_ptr<Scheduler> scheduler_;
00457   scoped_ptr<UsageDataReporter> usage_data_reporter_;
00459   const pagespeed::js::JsTokenizerPatterns* js_tokenizer_patterns_;
00460 
00461   GoogleString filename_prefix_;
00462   GoogleString slurp_directory_;
00463   bool force_caching_;
00464   bool slurp_read_only_;
00465   bool slurp_print_urls_;
00466 
00468   typedef std::set<ServerContext*> ServerContextSet;
00469   ServerContextSet server_contexts_;
00470   scoped_ptr<AbstractMutex> server_context_mutex_;
00471 
00474   scoped_ptr<RewriteOptions> default_options_;
00475 
00483   scoped_ptr<ServerContext> decoding_server_context_;
00484   scoped_ptr<RewriteDriver> decoding_driver_;
00485 
00487   scoped_ptr<NamedLockManager> lock_manager_;
00488 
00489   scoped_ptr<ThreadSystem> thread_system_;
00490 
00493   NullStatistics null_statistics_;
00494   Statistics* statistics_;
00495 
00496   StringSet created_directories_;
00497 
00498   std::vector<QueuedWorkerPool*> worker_pools_;
00499 
00502   scoped_ptr<RewriteStats> rewrite_stats_;
00503 
00506   std::vector<Function*> deferred_cleanups_;
00507 
00510   GoogleString version_string_;
00511 
00513   GoogleString hostname_;
00514 
00519   std::vector<int> preferred_webp_qualities_;
00520   std::vector<int> preferred_jpeg_qualities_;
00521 
00522   DISALLOW_COPY_AND_ASSIGN(RewriteDriverFactory);
00523 };
00524 
00527 template<class T> class RewriteDriverFactory::Deleter : public Function {
00528  public:
00529   explicit Deleter(T* obj) : obj_(obj) {}
00530   virtual void Run() { delete obj_; }
00531  private:
00532   T* obj_;
00533   DISALLOW_COPY_AND_ASSIGN(Deleter);
00534 };
00535 
00536 }  
00537 
00538 #endif  ///< NET_INSTAWEB_REWRITER_PUBLIC_REWRITE_DRIVER_FACTORY_H_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines