Page Speed Optimization Libraries  1.4.26.1
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 PropertyCache;
00030 class PropertyPage;
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 
00089   virtual bool IsHtmlCriticalImage(const GoogleString& image_url,
00090                                    RewriteDriver* driver);
00091 
00092   virtual bool IsCssCriticalImage(const GoogleString& image_url,
00093                                   RewriteDriver* driver);
00094 
00097   const StringSet& GetHtmlCriticalImages(RewriteDriver* driver);
00098   const StringSet& GetCssCriticalImages(RewriteDriver* driver);
00099 
00104   StringSet* mutable_html_critical_images(RewriteDriver* driver);
00105   StringSet* mutable_css_critical_images(RewriteDriver* driver);
00106 
00108   virtual void ComputeCriticalImages(StringPiece url,
00109                                      RewriteDriver* driver) = 0;
00110 
00113   virtual const char* GetCriticalImagesCohort() const = 0;
00114 
00119   bool UpdateCriticalImagesCacheEntryFromDriver(
00120       RewriteDriver* driver,
00121       StringSet* critical_images_set,
00122       StringSet* css_critical_images_set);
00123 
00130   bool UpdateCriticalImagesCacheEntry(
00131       PropertyPage* page,
00132       PropertyCache* page_property_cache,
00133       StringSet* critical_images_set,
00134       StringSet* css_critical_images_set);
00135 
00136  protected:
00141   virtual void UpdateCriticalImagesSetInDriver(RewriteDriver* driver);
00142 
00147   void ExtractCriticalImagesFromCache(
00148       RewriteDriver* driver,
00149       const PropertyValue* property_value,
00150       bool track_stats,
00151       CriticalImagesInfo* critical_images_info);
00152 
00153 
00154  private:
00157   static const int kDefaultPercentSeenForCritial = 100;
00158   static const int kDefaultNumSetsToKeep = 1;
00159 
00160   Variable* critical_images_valid_count_;
00161   Variable* critical_images_expired_count_;
00162   Variable* critical_images_not_found_count_;
00163 
00168   bool UpdateCriticalImages(const StringSet* html_critical_images,
00169                             const StringSet* css_critical_images,
00170                             CriticalImages* critical_images) const;
00171 
00172   friend class CriticalImagesFinderTestBase;
00173   DISALLOW_COPY_AND_ASSIGN(CriticalImagesFinder);
00174 };
00175 
00176 }  
00177 
00178 #endif  ///< NET_INSTAWEB_REWRITER_PUBLIC_CRITICAL_IMAGES_FINDER_H_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines