Page Speed Optimization Libraries  1.5.27.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 net_instaweb {
00033 
00034 class AbstractClientState;
00035 class AbstractMutex;
00036 class BlinkCriticalLineDataFinder;
00037 class CacheHtmlInfoFinder;
00038 class CriticalCssFinder;
00039 class CriticalImagesFinder;
00040 class CriticalSelectorFinder;
00041 class FileSystem;
00042 class FilenameEncoder;
00043 class FlushEarlyInfoFinder;
00044 class FuriousMatcher;
00045 class Hasher;
00046 class MessageHandler;
00047 class NamedLockManager;
00048 class PropertyCache;
00049 class QueuedWorkerPool;
00050 class ServerContext;
00051 class RewriteDriver;
00052 class RewriteOptions;
00053 class RewriteStats;
00054 class Scheduler;
00055 class StaticAssetManager;
00056 class Statistics;
00057 class ThreadSystem;
00058 class Timer;
00059 class UrlAsyncFetcher;
00060 class UrlFetcher;
00061 class UrlNamer;
00062 class UsageDataReporter;
00063 class UserAgentMatcher;
00064 
00069 class RewriteDriverFactory {
00070  public:
00072   template<class T> class Deleter;
00073 
00074   enum WorkerPoolCategory {
00075     kHtmlWorkers,
00076     kRewriteWorkers,
00077     kLowPriorityRewriteWorkers,
00079     kNumWorkerPools
00080   };
00081 
00083   explicit RewriteDriverFactory(ThreadSystem* thread_system);
00084 
00089   void InitializeDefaultOptions();
00090 
00091   virtual ~RewriteDriverFactory();
00092 
00097   void set_html_parse_message_handler(MessageHandler* message_handler);
00098   void set_message_handler(MessageHandler* message_handler);
00099   void set_file_system(FileSystem* file_system);
00100   void set_hasher(Hasher* hasher);
00101   void set_filename_encoder(FilenameEncoder* filename_encoder);
00102   void set_url_namer(UrlNamer* url_namer);
00103   void set_timer(Timer* timer);
00104   void set_usage_data_reporter(UsageDataReporter* reporter);
00105 
00116   void set_slurp_directory(const StringPiece& directory);
00117   void set_slurp_read_only(bool read_only);
00118   void set_slurp_print_urls(bool read_only);
00119 
00122   void set_force_caching(bool u) { force_caching_ = u; }
00123 
00135   void set_base_url_fetcher(UrlFetcher* url_fetcher);
00136   void set_base_url_async_fetcher(UrlAsyncFetcher* url_fetcher);
00138   void set_base_distributed_async_fetcher(UrlAsyncFetcher* distributed_fetcher);
00139   bool set_filename_prefix(StringPiece p);
00140 
00142   bool slurping_enabled() const { return !slurp_directory_.empty(); }
00143 
00144   MessageHandler* html_parse_message_handler();
00145   MessageHandler* message_handler();
00146   FileSystem* file_system();
00149   Hasher* hasher();
00150   FilenameEncoder* filename_encoder() { return filename_encoder_.get(); }
00151   UrlNamer* url_namer();
00152   UserAgentMatcher* user_agent_matcher();
00153   StaticAssetManager* static_asset_manager();
00154   RewriteOptions* default_options() { return default_options_.get(); }
00155 
00158   Timer* timer();
00159   NamedLockManager* lock_manager();
00160   QueuedWorkerPool* WorkerPool(WorkerPoolCategory pool);
00161   Scheduler* scheduler();
00162   UsageDataReporter* usage_data_reporter();
00163 
00168   virtual UrlFetcher* ComputeUrlFetcher();
00169   virtual UrlAsyncFetcher* ComputeUrlAsyncFetcher();
00170   virtual UrlAsyncFetcher* ComputeDistributedFetcher();
00171 
00178   ServerContext* CreateServerContext();
00179 
00183   void InitServerContext(ServerContext* server_context);
00184 
00189   virtual void SetupCaches(ServerContext* server_context) = 0;
00190 
00194   virtual bool UseBeaconResultsInFilters() const = 0;
00195 
00199   virtual void AddPlatformSpecificRewritePasses(RewriteDriver* driver);
00200 
00207   virtual void AddPlatformSpecificDecodingPasses(RewriteDriver* driver);
00208 
00212   virtual void ApplyPlatformSpecificConfiguration(RewriteDriver* driver);
00213 
00214   ThreadSystem* thread_system() { return thread_system_.get(); }
00215 
00218   const StringSet& created_directories() const {
00219     return created_directories_;
00220   }
00221 
00222   bool async_rewrites() { return true; }
00223 
00228   RewriteStats* rewrite_stats();
00229 
00232   Statistics* statistics() { return statistics_; }
00233 
00236   static void InitStats(Statistics* statistics);
00237 
00239   static void Initialize();
00240   static void Terminate();
00241 
00243   void SetStatistics(Statistics* stats);
00244 
00248   virtual void ShutDown();
00249 
00251   void AddCreatedDirectory(const GoogleString& dir);
00252 
00257   virtual RewriteOptions* NewRewriteOptions();
00258 
00262   virtual RewriteOptions* NewRewriteOptionsForQuery();
00263 
00265   const GoogleString& version_string() const { return version_string_; }
00266   void set_version_string(const StringPiece& version_string) {
00267     version_string.CopyToString(&version_string_);
00268   }
00269 
00273   void defer_cleanup(Function* f) { deferred_cleanups_.push_back(f); }
00274 
00277   template<class T> void TakeOwnership(T* obj) {
00278     defer_cleanup(new RewriteDriverFactory::Deleter<T>(obj));
00279   }
00280 
00282   virtual bool IsDebugClient(const GoogleString& ip) const {
00283     return false;
00284   }
00285 
00289   virtual AbstractClientState* NewClientState();
00290 
00293   virtual FuriousMatcher* NewFuriousMatcher();
00294 
00296   const std::vector<int>* preferred_webp_qualities() {
00297     return &preferred_webp_qualities_;
00298   }
00299 
00301   const std::vector<int>* preferred_jpeg_qualities() {
00302     return &preferred_jpeg_qualities_;
00303   }
00304 
00306   bool SetPreferredWebpQualities(const StringPiece& qualities);
00307 
00309   bool SetPreferredJpegQualities(const StringPiece& qualities);
00310 
00311  protected:
00312   bool FetchersComputed() const;
00313   virtual void StopCacheActivity();
00314   StringPiece filename_prefix();
00315 
00319   bool TerminateServerContext(ServerContext* server_context);
00320 
00325   virtual UrlFetcher* DefaultUrlFetcher() = 0;
00326   virtual UrlAsyncFetcher* DefaultAsyncUrlFetcher() = 0;
00327   virtual MessageHandler* DefaultHtmlParseMessageHandler() = 0;
00328   virtual MessageHandler* DefaultMessageHandler() = 0;
00329   virtual FileSystem* DefaultFileSystem() = 0;
00330   virtual Timer* DefaultTimer();
00331 
00332   virtual Hasher* NewHasher() = 0;
00333 
00336   virtual ServerContext* NewServerContext() = 0;
00337 
00338   virtual UrlAsyncFetcher* DefaultDistributedUrlFetcher() { return NULL; }
00339 
00340   virtual CriticalCssFinder* DefaultCriticalCssFinder();
00341   virtual CriticalImagesFinder* DefaultCriticalImagesFinder();
00342   virtual CriticalSelectorFinder* DefaultCriticalSelectorFinder();
00343 
00345   virtual BlinkCriticalLineDataFinder* DefaultBlinkCriticalLineDataFinder(
00346       PropertyCache* cache);
00347 
00349   virtual CacheHtmlInfoFinder* DefaultCacheHtmlInfoFinder(
00350       PropertyCache* cache);
00351 
00353   virtual FlushEarlyInfoFinder* DefaultFlushEarlyInfoFinder();
00354 
00357   virtual NamedLockManager* DefaultLockManager();
00358 
00361   virtual UrlNamer* DefaultUrlNamer();
00362 
00363   virtual UserAgentMatcher* DefaultUserAgentMatcher();
00364   virtual UsageDataReporter* DefaultUsageDataReporter();
00365 
00369   virtual QueuedWorkerPool* CreateWorkerPool(WorkerPoolCategory pool,
00370                                              StringPiece name);
00371 
00378   virtual int LowPriorityLoadSheddingThreshold() const;
00379 
00382   virtual Scheduler* CreateScheduler();
00383 
00385   virtual void FetcherSetupHooks();
00386 
00390   virtual StringPiece LockFilePrefix();
00391 
00393   virtual void InitStaticAssetManager(
00394       StaticAssetManager* static_asset_manager) {}
00395 
00396  private:
00400   StaticAssetManager* DefaultStaticAssetManager();
00401 
00402   void SetupSlurpDirectories();
00403   void Init(); 
00404 
00405   scoped_ptr<MessageHandler> html_parse_message_handler_;
00406   scoped_ptr<MessageHandler> message_handler_;
00407   scoped_ptr<FileSystem> file_system_;
00408   UrlFetcher* url_fetcher_;
00409   UrlAsyncFetcher* url_async_fetcher_;
00410   UrlAsyncFetcher* distributed_async_fetcher_;
00411   scoped_ptr<UrlFetcher> base_url_fetcher_;
00412   scoped_ptr<UrlAsyncFetcher> base_url_async_fetcher_;
00413   scoped_ptr<UrlAsyncFetcher> base_distributed_async_fetcher_;
00414   scoped_ptr<Hasher> hasher_;
00415   scoped_ptr<FilenameEncoder> filename_encoder_;
00416   scoped_ptr<UrlNamer> url_namer_;
00417   scoped_ptr<UserAgentMatcher> user_agent_matcher_;
00418   scoped_ptr<StaticAssetManager> static_asset_manager_;
00419   scoped_ptr<Timer> timer_;
00420   scoped_ptr<Scheduler> scheduler_;
00421   scoped_ptr<UsageDataReporter> usage_data_reporter_;
00422 
00423   GoogleString filename_prefix_;
00424   GoogleString slurp_directory_;
00425   bool force_caching_;
00426   bool slurp_read_only_;
00427   bool slurp_print_urls_;
00428 
00430   typedef std::set<ServerContext*> ServerContextSet;
00431   ServerContextSet server_contexts_;
00432   scoped_ptr<AbstractMutex> server_context_mutex_;
00433 
00436   scoped_ptr<RewriteOptions> default_options_;
00437 
00439   scoped_ptr<NamedLockManager> lock_manager_;
00440 
00441   scoped_ptr<ThreadSystem> thread_system_;
00442 
00445   NullStatistics null_statistics_;
00446   Statistics* statistics_;
00447 
00448   StringSet created_directories_;
00449 
00450   std::vector<QueuedWorkerPool*> worker_pools_;
00451 
00454   scoped_ptr<RewriteStats> rewrite_stats_;
00455 
00458   std::vector<Function*> deferred_cleanups_;
00459 
00462   GoogleString version_string_;
00463 
00465   GoogleString hostname_;
00466 
00471   std::vector<int> preferred_webp_qualities_;
00472   std::vector<int> preferred_jpeg_qualities_;
00473 
00474   DISALLOW_COPY_AND_ASSIGN(RewriteDriverFactory);
00475 };
00476 
00479 template<class T> class RewriteDriverFactory::Deleter : public Function {
00480  public:
00481   explicit Deleter(T* obj) : obj_(obj) {}
00482   virtual void Run() { delete obj_; }
00483  private:
00484   T* obj_;
00485   DISALLOW_COPY_AND_ASSIGN(Deleter);
00486 };
00487 
00488 }  
00489 
00490 #endif  ///< NET_INSTAWEB_REWRITER_PUBLIC_REWRITE_DRIVER_FACTORY_H_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines