Page Speed Optimization Libraries  1.6.29.3
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 net_instaweb {
00033 
00034 class AbstractMutex;
00035 class CacheHtmlInfoFinder;
00036 class CriticalCssFinder;
00037 class CriticalImagesFinder;
00038 class CriticalSelectorFinder;
00039 class FileSystem;
00040 class FilenameEncoder;
00041 class FlushEarlyInfoFinder;
00042 class ExperimentMatcher;
00043 class Hasher;
00044 class MessageHandler;
00045 class NamedLockManager;
00046 class NonceGenerator;
00047 class PropertyCache;
00048 class QueuedWorkerPool;
00049 class ServerContext;
00050 class RewriteDriver;
00051 class RewriteOptions;
00052 class RewriteOptionsManager;
00053 class RewriteStats;
00054 class Scheduler;
00055 class StaticAssetManager;
00056 class Statistics;
00057 class ThreadSystem;
00058 class Timer;
00059 class UrlAsyncFetcher;
00060 class UrlNamer;
00061 class UsageDataReporter;
00062 class UserAgentMatcher;
00063 
00068 class RewriteDriverFactory {
00069  public:
00071   template<class T> class Deleter;
00072 
00073   enum WorkerPoolCategory {
00074     kHtmlWorkers,
00075     kRewriteWorkers,
00076     kLowPriorityRewriteWorkers,
00078     kNumWorkerPools
00079   };
00080 
00082   explicit RewriteDriverFactory(ThreadSystem* thread_system);
00083 
00088   void InitializeDefaultOptions();
00089 
00090   virtual ~RewriteDriverFactory();
00091 
00096   void set_html_parse_message_handler(MessageHandler* message_handler);
00097   void set_message_handler(MessageHandler* message_handler);
00098   void set_file_system(FileSystem* file_system);
00099   void set_hasher(Hasher* hasher);
00100   void set_filename_encoder(FilenameEncoder* filename_encoder);
00101   void set_nonce_generator(NonceGenerator* nonce_generator);
00102   void set_url_namer(UrlNamer* url_namer);
00103   void set_timer(Timer* timer);
00104   void set_usage_data_reporter(UsageDataReporter* reporter);
00105 
00115   void set_slurp_directory(const StringPiece& directory);
00116   void set_slurp_read_only(bool read_only);
00117   void set_slurp_print_urls(bool read_only);
00118 
00121   void set_force_caching(bool u) { force_caching_ = u; }
00122 
00131   void set_base_url_async_fetcher(UrlAsyncFetcher* url_fetcher);
00133   void set_base_distributed_async_fetcher(UrlAsyncFetcher* distributed_fetcher);
00134   bool set_filename_prefix(StringPiece p);
00135 
00137   bool slurping_enabled() const { return !slurp_directory_.empty(); }
00138 
00139   MessageHandler* html_parse_message_handler();
00140   MessageHandler* message_handler();
00141   FileSystem* file_system();
00142   NonceGenerator* nonce_generator();
00145   Hasher* hasher();
00146   FilenameEncoder* filename_encoder() { return filename_encoder_.get(); }
00147   UrlNamer* url_namer();
00148   UserAgentMatcher* user_agent_matcher();
00149   StaticAssetManager* static_asset_manager();
00150   RewriteOptions* default_options() { return default_options_.get(); }
00151   virtual RewriteOptionsManager* NewRewriteOptionsManager();
00152 
00155   Timer* timer();
00156   NamedLockManager* lock_manager();
00157   QueuedWorkerPool* WorkerPool(WorkerPoolCategory pool);
00158   Scheduler* scheduler();
00159   UsageDataReporter* usage_data_reporter();
00160 
00165   virtual UrlAsyncFetcher* ComputeUrlAsyncFetcher();
00166   virtual UrlAsyncFetcher* ComputeDistributedFetcher();
00167 
00174   ServerContext* CreateServerContext();
00175 
00179   void InitServerContext(ServerContext* server_context);
00180 
00185   virtual void SetupCaches(ServerContext* server_context) = 0;
00186 
00190   virtual bool UseBeaconResultsInFilters() const = 0;
00191 
00195   virtual bool UseSelectorFilterForCriticalCss() const {
00196     return UseBeaconResultsInFilters();
00197   }
00198 
00202   virtual void AddPlatformSpecificRewritePasses(RewriteDriver* driver);
00203 
00210   virtual void AddPlatformSpecificDecodingPasses(RewriteDriver* driver);
00211 
00215   virtual void ApplyPlatformSpecificConfiguration(RewriteDriver* driver);
00216 
00217   ThreadSystem* thread_system() { return thread_system_.get(); }
00218 
00221   const StringSet& created_directories() const {
00222     return created_directories_;
00223   }
00224 
00225   bool async_rewrites() { return true; }
00226 
00231   RewriteStats* rewrite_stats();
00232 
00235   Statistics* statistics() { return statistics_; }
00236 
00239   static void InitStats(Statistics* statistics);
00240 
00242   static void Initialize();
00243   static void Terminate();
00244 
00246   void SetStatistics(Statistics* stats);
00247 
00251   virtual void ShutDown();
00252 
00254   void AddCreatedDirectory(const GoogleString& dir);
00255 
00260   virtual RewriteOptions* NewRewriteOptions();
00261 
00265   virtual RewriteOptions* NewRewriteOptionsForQuery();
00266 
00268   const GoogleString& version_string() const { return version_string_; }
00269   void set_version_string(const StringPiece& version_string) {
00270     version_string.CopyToString(&version_string_);
00271   }
00272 
00276   void defer_cleanup(Function* f) { deferred_cleanups_.push_back(f); }
00277 
00280   template<class T> void TakeOwnership(T* obj) {
00281     defer_cleanup(new RewriteDriverFactory::Deleter<T>(obj));
00282   }
00283 
00285   virtual bool IsDebugClient(const GoogleString& ip) const {
00286     return false;
00287   }
00288 
00291   virtual ExperimentMatcher* NewExperimentMatcher();
00292 
00294   const std::vector<int>* preferred_webp_qualities() {
00295     return &preferred_webp_qualities_;
00296   }
00297 
00299   const std::vector<int>* preferred_jpeg_qualities() {
00300     return &preferred_jpeg_qualities_;
00301   }
00302 
00304   bool SetPreferredWebpQualities(const StringPiece& qualities);
00305 
00307   bool SetPreferredJpegQualities(const StringPiece& qualities);
00308 
00309  protected:
00310   bool FetchersComputed() const;
00311   virtual void StopCacheActivity();
00312   StringPiece filename_prefix();
00313 
00317   bool TerminateServerContext(ServerContext* server_context);
00318 
00323   virtual UrlAsyncFetcher* DefaultAsyncUrlFetcher() = 0;
00324   virtual MessageHandler* DefaultHtmlParseMessageHandler() = 0;
00325   virtual MessageHandler* DefaultMessageHandler() = 0;
00326   virtual FileSystem* DefaultFileSystem() = 0;
00327   virtual NonceGenerator* DefaultNonceGenerator();
00328   virtual Timer* DefaultTimer();
00329 
00330   virtual Hasher* NewHasher() = 0;
00331 
00334   virtual ServerContext* NewServerContext() = 0;
00335 
00336   virtual UrlAsyncFetcher* DefaultDistributedUrlFetcher() { return NULL; }
00337 
00338   virtual CriticalCssFinder* DefaultCriticalCssFinder();
00339   virtual CriticalImagesFinder* DefaultCriticalImagesFinder(
00340       ServerContext* server_context);
00341   virtual CriticalSelectorFinder* DefaultCriticalSelectorFinder(
00342       ServerContext* server_context);
00343 
00345   virtual CacheHtmlInfoFinder* DefaultCacheHtmlInfoFinder(
00346       PropertyCache* cache, ServerContext* server_context);
00347 
00349   virtual FlushEarlyInfoFinder* DefaultFlushEarlyInfoFinder();
00350 
00353   virtual NamedLockManager* DefaultLockManager();
00354 
00357   virtual UrlNamer* DefaultUrlNamer();
00358 
00359   virtual UserAgentMatcher* DefaultUserAgentMatcher();
00360   virtual UsageDataReporter* DefaultUsageDataReporter();
00361 
00365   virtual QueuedWorkerPool* CreateWorkerPool(WorkerPoolCategory pool,
00366                                              StringPiece name);
00367 
00374   virtual int LowPriorityLoadSheddingThreshold() const;
00375 
00378   virtual Scheduler* CreateScheduler();
00379 
00381   virtual void FetcherSetupHooks();
00382 
00386   virtual StringPiece LockFilePrefix();
00387 
00389   virtual void InitStaticAssetManager(
00390       StaticAssetManager* static_asset_manager) {}
00391 
00392  private:
00396   StaticAssetManager* DefaultStaticAssetManager();
00397 
00398   void SetupSlurpDirectories();
00399   void Init(); 
00400 
00401   scoped_ptr<MessageHandler> html_parse_message_handler_;
00402   scoped_ptr<MessageHandler> message_handler_;
00403   scoped_ptr<FileSystem> file_system_;
00404   UrlAsyncFetcher* url_async_fetcher_;
00405   UrlAsyncFetcher* distributed_async_fetcher_;
00406   scoped_ptr<UrlAsyncFetcher> base_url_async_fetcher_;
00407   scoped_ptr<UrlAsyncFetcher> base_distributed_async_fetcher_;
00408   scoped_ptr<Hasher> hasher_;
00409   scoped_ptr<FilenameEncoder> filename_encoder_;
00410   scoped_ptr<NonceGenerator> nonce_generator_;
00411   scoped_ptr<UrlNamer> url_namer_;
00412   scoped_ptr<UserAgentMatcher> user_agent_matcher_;
00413   scoped_ptr<StaticAssetManager> static_asset_manager_;
00414   scoped_ptr<Timer> timer_;
00415   scoped_ptr<Scheduler> scheduler_;
00416   scoped_ptr<UsageDataReporter> usage_data_reporter_;
00417 
00418   GoogleString filename_prefix_;
00419   GoogleString slurp_directory_;
00420   bool force_caching_;
00421   bool slurp_read_only_;
00422   bool slurp_print_urls_;
00423 
00425   typedef std::set<ServerContext*> ServerContextSet;
00426   ServerContextSet server_contexts_;
00427   scoped_ptr<AbstractMutex> server_context_mutex_;
00428 
00431   scoped_ptr<RewriteOptions> default_options_;
00432 
00434   scoped_ptr<NamedLockManager> lock_manager_;
00435 
00436   scoped_ptr<ThreadSystem> thread_system_;
00437 
00440   NullStatistics null_statistics_;
00441   Statistics* statistics_;
00442 
00443   StringSet created_directories_;
00444 
00445   std::vector<QueuedWorkerPool*> worker_pools_;
00446 
00449   scoped_ptr<RewriteStats> rewrite_stats_;
00450 
00453   std::vector<Function*> deferred_cleanups_;
00454 
00457   GoogleString version_string_;
00458 
00460   GoogleString hostname_;
00461 
00466   std::vector<int> preferred_webp_qualities_;
00467   std::vector<int> preferred_jpeg_qualities_;
00468 
00469   DISALLOW_COPY_AND_ASSIGN(RewriteDriverFactory);
00470 };
00471 
00474 template<class T> class RewriteDriverFactory::Deleter : public Function {
00475  public:
00476   explicit Deleter(T* obj) : obj_(obj) {}
00477   virtual void Run() { delete obj_; }
00478  private:
00479   T* obj_;
00480   DISALLOW_COPY_AND_ASSIGN(Deleter);
00481 };
00482 
00483 }  
00484 
00485 #endif  ///< NET_INSTAWEB_REWRITER_PUBLIC_REWRITE_DRIVER_FACTORY_H_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines