Page Speed Optimization Libraries
1.7.30.4
|
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 <map> 00023 #include <utility> 00024 00025 #include "net/instaweb/rewriter/critical_images.pb.h" 00026 #include "net/instaweb/rewriter/public/critical_finder_support_util.h" 00027 #include "net/instaweb/util/public/basictypes.h" 00028 #include "net/instaweb/util/public/property_cache.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 GoogleUrl; 00035 class RenderedImages; 00036 class RewriteDriver; 00037 class RewriteOptions; 00038 class Statistics; 00039 class Variable; 00040 00041 typedef std::map<GoogleString, std::pair<int32, int32> > 00042 RenderedImageDimensionsMap; 00043 00052 struct CriticalImagesInfo { 00053 CriticalImagesInfo() 00054 : is_critical_image_info_present(false) {} 00055 StringSet html_critical_images; 00056 StringSet css_critical_images; 00057 CriticalImages proto; 00058 bool is_critical_image_info_present; 00059 RenderedImageDimensionsMap rendered_images_map; 00060 }; 00061 00062 00065 class CriticalImagesFinder { 00066 public: 00067 static const char kCriticalImagesValidCount[]; 00068 static const char kCriticalImagesExpiredCount[]; 00069 static const char kCriticalImagesNotFoundCount[]; 00070 static const char kCriticalImagesPropertyName[]; 00073 static const char kRenderedImageDimensionsProperty[]; 00074 00075 CriticalImagesFinder(const PropertyCache::Cohort* cohort, Statistics* stats); 00076 virtual ~CriticalImagesFinder(); 00077 00078 static void InitStats(Statistics* statistics); 00079 00083 virtual bool IsMeaningful(const RewriteDriver* driver) const = 0; 00084 00090 virtual int PercentSeenForCritical() const { 00091 return kDefaultPercentSeenForCritical; 00092 } 00093 00101 virtual int SupportInterval() const { 00102 return kDefaultImageSupportInterval; 00103 } 00104 00110 bool IsHtmlCriticalImage(const GoogleString& image_url, 00111 RewriteDriver* driver); 00112 00113 bool IsCssCriticalImage(const GoogleString& image_url, 00114 RewriteDriver* driver); 00115 00118 bool GetRenderedImageDimensions( 00119 RewriteDriver* driver, 00120 const GoogleUrl& image_src_gurl, 00121 std::pair<int32, int32>* dimensions); 00122 00125 const StringSet& GetHtmlCriticalImages(RewriteDriver* driver); 00126 const StringSet& GetCssCriticalImages(RewriteDriver* driver); 00127 00134 StringSet* mutable_html_critical_images(RewriteDriver* driver); 00135 StringSet* mutable_css_critical_images(RewriteDriver* driver); 00136 00138 virtual void ComputeCriticalImages(RewriteDriver* driver) = 0; 00139 00144 const PropertyCache::Cohort* cohort() const { return cohort_; } 00145 00151 bool UpdateCriticalImagesCacheEntryFromDriver( 00152 const StringSet* html_critical_images_set, 00153 const StringSet* css_critical_images_set, 00154 RewriteDriver* driver); 00155 00160 static bool PopulateCriticalImagesFromPropertyValue( 00161 const PropertyValue* property_value, CriticalImages* critical_images); 00162 00166 static bool UpdateCriticalImagesCacheEntry( 00167 const StringSet* html_critical_images_set, 00168 const StringSet* css_critical_images_set, 00169 const RenderedImages* rendered_images_set, 00170 int support_interval, 00171 const PropertyCache::Cohort* cohort, 00172 AbstractPropertyPage* page); 00173 00176 virtual bool IsCriticalImageInfoPresent(RewriteDriver* driver); 00177 00179 virtual RenderedImages* ExtractRenderedImageDimensionsFromCache( 00180 RewriteDriver* driver); 00181 00183 void AddHtmlCriticalImage(const GoogleString& url, 00184 RewriteDriver* driver); 00185 00188 RenderedImages* JsonMapToRenderedImagesMap(const GoogleString& str, 00189 const RewriteOptions* options); 00190 00193 virtual bool ShouldBeacon(RewriteDriver* driver) { return false; } 00194 00199 virtual BeaconMetadata PrepareForBeaconInsertion(RewriteDriver* driver) { 00200 BeaconMetadata result; 00201 result.status = kBeaconNoNonce; 00202 return result; 00203 } 00204 00210 virtual void UpdateCandidateImagesForBeaconing(const StringSet& images, 00211 RewriteDriver* driver, 00212 bool beaconing) {} 00213 00214 protected: 00217 static bool UpdateAndWriteBackCriticalImagesCacheEntry( 00218 const StringSet* html_critical_images_set, 00219 const StringSet* css_critical_images_set, 00220 const RenderedImages* rendered_images_set, 00221 int support_interval, 00222 const PropertyCache::Cohort* cohort, 00223 AbstractPropertyPage* page, 00224 CriticalImages* critical_images); 00225 00230 virtual void UpdateCriticalImagesSetInDriver(RewriteDriver* driver); 00231 00232 virtual GoogleString GetKeyForUrl(const GoogleString& url) { 00233 return url; 00234 } 00235 00239 CriticalImagesInfo* ExtractCriticalImagesFromCache( 00240 RewriteDriver* driver, 00241 const PropertyValue* property_value); 00242 00243 private: 00244 friend class CriticalImagesFinderTestBase; 00245 00250 static bool UpdateCriticalImages(const StringSet* html_critical_images, 00251 const StringSet* css_critical_images, 00252 int support_interval, 00253 CriticalImages* critical_images); 00254 00257 static const int kDefaultPercentSeenForCritical = 100; 00258 static const int kDefaultImageSupportInterval = 1; 00259 00260 const PropertyCache::Cohort* cohort_; 00261 00262 Variable* critical_images_valid_count_; 00263 Variable* critical_images_expired_count_; 00264 Variable* critical_images_not_found_count_; 00265 00266 DISALLOW_COPY_AND_ASSIGN(CriticalImagesFinder); 00267 }; 00268 00269 } 00270 00271 #endif ///< NET_INSTAWEB_REWRITER_PUBLIC_CRITICAL_IMAGES_FINDER_H_