Page Speed Optimization Libraries  1.5.27.2
net/instaweb/rewriter/public/critical_images_finder.h
Go to the documentation of this file.
00001 /*
00002  * Copyright 2012 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_CRITICAL_IMAGES_FINDER_H_
00020 #define NET_INSTAWEB_REWRITER_PUBLIC_CRITICAL_IMAGES_FINDER_H_
00021 
00022 #include "net/instaweb/util/public/basictypes.h"
00023 #include "net/instaweb/util/public/string.h"
00024 #include "net/instaweb/util/public/string_util.h"
00025 
00026 namespace net_instaweb {
00027 
00028 class CriticalImages;
00029 class AbstractPropertyPage;
00030 class PropertyCache;
00031 class PropertyValue;
00032 class RewriteDriver;
00033 class Statistics;
00034 class Variable;
00035 
00044 struct CriticalImagesInfo {
00045   StringSet html_critical_images;
00046   StringSet css_critical_images;
00047 };
00048 
00049 
00052 class CriticalImagesFinder {
00053  public:
00054   static const char kCriticalImagesValidCount[];
00055   static const char kCriticalImagesExpiredCount[];
00056   static const char kCriticalImagesNotFoundCount[];
00057   static const char kCriticalImagesPropertyName[];
00058 
00059   explicit CriticalImagesFinder(Statistics* stats);
00060   virtual ~CriticalImagesFinder();
00061 
00062   static void InitStats(Statistics* statistics);
00063 
00067   virtual bool IsMeaningful(const RewriteDriver* driver) const = 0;
00068 
00074   virtual int PercentSeenForCritical() const {
00075     return kDefaultPercentSeenForCritial;
00076   }
00077 
00081   virtual int NumSetsToKeep() const {
00082     return kDefaultNumSetsToKeep;
00083   }
00084 
00090   virtual bool IsHtmlCriticalImage(const GoogleString& image_url,
00091                                    RewriteDriver* driver);
00092 
00093   virtual bool IsCssCriticalImage(const GoogleString& image_url,
00094                                   RewriteDriver* driver);
00095 
00098   const StringSet& GetHtmlCriticalImages(RewriteDriver* driver);
00099   const StringSet& GetCssCriticalImages(RewriteDriver* driver);
00100 
00107   StringSet* mutable_html_critical_images(RewriteDriver* driver);
00108   StringSet* mutable_css_critical_images(RewriteDriver* driver);
00109 
00111   virtual void ComputeCriticalImages(StringPiece url,
00112                                      RewriteDriver* driver) = 0;
00113 
00116   virtual const char* GetCriticalImagesCohort() const = 0;
00117 
00123   bool UpdateCriticalImagesCacheEntryFromDriver(
00124       const StringSet* html_critical_images_set,
00125       const StringSet* css_critical_images_set,
00126       RewriteDriver* driver);
00127 
00131   bool UpdateCriticalImagesCacheEntry(
00132       const StringSet* html_critical_images_set,
00133       const StringSet* css_critical_images_set,
00134       AbstractPropertyPage* page,
00135       PropertyCache* page_property_cache);
00136 
00137  protected:
00142   virtual void UpdateCriticalImagesSetInDriver(RewriteDriver* driver);
00143 
00147   CriticalImagesInfo* ExtractCriticalImagesFromCache(
00148       RewriteDriver* driver,
00149       const PropertyValue* property_value);
00150 
00151  private:
00152   friend class CriticalImagesFinderTestBase;
00153 
00158   bool UpdateCriticalImages(const StringSet* html_critical_images,
00159                             const StringSet* css_critical_images,
00160                             CriticalImages* critical_images) const;
00161 
00164   static const int kDefaultPercentSeenForCritial = 100;
00165   static const int kDefaultNumSetsToKeep = 1;
00166 
00167   Variable* critical_images_valid_count_;
00168   Variable* critical_images_expired_count_;
00169   Variable* critical_images_not_found_count_;
00170 
00171   DISALLOW_COPY_AND_ASSIGN(CriticalImagesFinder);
00172 };
00173 
00174 }  
00175 
00176 #endif  ///< NET_INSTAWEB_REWRITER_PUBLIC_CRITICAL_IMAGES_FINDER_H_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines