local_storage_cache_filter.h

Go to the documentation of this file.

/*
 * Copyright 2012 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http:///www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


#ifndef NET_INSTAWEB_REWRITER_PUBLIC_LOCAL_STORAGE_CACHE_FILTER_H_
#define NET_INSTAWEB_REWRITER_PUBLIC_LOCAL_STORAGE_CACHE_FILTER_H_

#include <set>

#include "net/instaweb/rewriter/cached_result.pb.h"
#include "net/instaweb/rewriter/public/rewrite_driver.h"
#include "net/instaweb/rewriter/public/rewrite_filter.h"
#include "net/instaweb/rewriter/public/rewrite_options.h"
#include "pagespeed/kernel/base/basictypes.h"
#include "pagespeed/kernel/base/statistics.h"
#include "pagespeed/kernel/base/string.h"
#include "pagespeed/kernel/base/string_util.h"
#include "pagespeed/kernel/html/html_element.h"
#include "pagespeed/kernel/html/html_filter.h"

namespace net_instaweb {

/*
 * The Local Storage Cache rewriter reduces HTTP requests by inlining resources
 * and using browser-side javascript to store the inlined resources in local
 * storage. The javascript also creates a cookie that reflects the resources it
 * has in local storage. On a repeat view, the server uses the cookie to
 * determine if it should replace an inlined resource with a script snippet
 * that loads the resource from local storage. In effect, we get browser
 * caching of inlined resources, theoretically speeding up first view (by
 * inlining) and repeat view (by not resending the inlined resource).
 */
class LocalStorageCacheFilter : public RewriteFilter {
 public:
  static const char kLscCookieName[];
  static const char kLscInitializer[]; 

  static const char kCandidatesFound[];
  static const char kStoredTotal[];
  static const char kStoredImages[];
  static const char kStoredCss[];
  static const char kCandidatesAdded[];
  static const char kCandidatesRemoved[];

  class InlineState {
   public:
    InlineState() : initialized_(false), enabled_(false) {}

   private:
    friend class LocalStorageCacheFilter;

    bool initialized_;
    bool enabled_;
    GoogleString url_;
  };

  explicit LocalStorageCacheFilter(RewriteDriver* rewrite_driver);
  virtual ~LocalStorageCacheFilter();

  static void InitStats(Statistics* statistics);

  virtual void StartDocumentImpl();
  virtual void EndDocument();
  virtual void StartElementImpl(HtmlElement* element);
  virtual void EndElementImpl(HtmlElement* element);

  virtual const char* Name() const { return "LocalStorageCache"; }
  virtual const char* id() const {
    return RewriteOptions::kLocalStorageCacheId;
  }

  std::set<StringPiece>* mutable_cookie_hashes() { return &cookie_hashes_; }

  static bool AddStorableResource(const StringPiece& url,
                                  RewriteDriver* driver,
                                  bool skip_cookie_check,
                                  HtmlElement* element,
                                  InlineState* state);

  static bool AddLscAttributes(const StringPiece url,
                               const CachedResult& cached,
                               RewriteDriver* driver,
                               HtmlElement* element);

  static void RemoveLscAttributes(HtmlElement* element,
                                  RewriteDriver* driver);

  ScriptUsage GetScriptUsage() const override { return kWillInjectScripts; }

 private:
  void InsertOurScriptElement(HtmlElement* before);
  static bool IsHashInCookie(const RewriteDriver* driver,
                             const StringPiece cookie_name,
                             const StringPiece hash,
                             std::set<StringPiece>* hash_set);
  static GoogleString ExtractOtherImgAttributes(const HtmlElement* element);
  static GoogleString GenerateHashFromUrlAndElement(const RewriteDriver* driver,
                                                    const StringPiece& lsc_url,
                                                    const HtmlElement* element);

  bool script_inserted_;
  bool script_needs_inserting_;
  std::set<StringPiece> cookie_hashes_;

  Variable* num_local_storage_cache_candidates_found_;
  Variable* num_local_storage_cache_stored_total_;
  Variable* num_local_storage_cache_stored_images_;
  Variable* num_local_storage_cache_stored_css_;
  Variable* num_local_storage_cache_candidates_added_;
  Variable* num_local_storage_cache_candidates_removed_;

  
};

}  

#endif