Page Speed Optimization Libraries  1.8.31.3
net/instaweb/rewriter/public/split_html_filter.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_SPLIT_HTML_FILTER_H_
00020 #define NET_INSTAWEB_REWRITER_PUBLIC_SPLIT_HTML_FILTER_H_
00021 
00022 #include <vector>
00023 
00024 #include "net/instaweb/rewriter/public/rewrite_driver.h"
00025 #include "net/instaweb/rewriter/public/script_tag_scanner.h"
00026 #include "net/instaweb/rewriter/public/server_context.h"
00027 #include "net/instaweb/rewriter/public/suppress_prehead_filter.h"
00028 #include "net/instaweb/util/public/basictypes.h"
00029 #include "net/instaweb/util/public/json.h"
00030 #include "net/instaweb/util/public/json_writer.h"
00031 #include "net/instaweb/util/public/null_writer.h"
00032 #include "net/instaweb/util/public/scoped_ptr.h"
00033 #include "net/instaweb/util/public/string.h"
00034 #include "net/instaweb/util/public/string_util.h"
00035 
00036 namespace net_instaweb {
00037 
00038 class HtmlElement;
00039 class RewriteOptions;
00040 class SplitHtmlConfig;
00041 class SplitHtmlState;
00042 class StaticAssetManager;
00043 class Writer;
00044 
00047 
00050 class SplitHtmlFilter : public SuppressPreheadFilter {
00051  public:
00052   static const char kSplitSuffixJsFormatString[];
00053   static const char kSplitTwoChunkSuffixJsFormatString[];
00054   static const char kLoadHiResImages[];
00055   static const char kMetaReferer[];
00056 
00057   explicit SplitHtmlFilter(RewriteDriver* rewrite_driver);
00058   virtual ~SplitHtmlFilter();
00059 
00060   virtual void DetermineEnabled();
00061 
00062   virtual void StartDocument();
00063   virtual void EndDocument();
00064 
00065   virtual void StartElement(HtmlElement* element);
00066   virtual void EndElement(HtmlElement* element);
00067 
00068   static const GoogleString& GetBlinkJsUrl(
00069       const RewriteOptions* options,
00070       const StaticAssetManager* static_asset_manager);
00071 
00072   virtual const char* Name() const { return "SplitHtmlFilter"; }
00073 
00074  private:
00075   const SplitHtmlConfig* config() const {
00076     return driver()->split_html_config();
00077   }
00078   const StaticAssetManager* static_asset_manager() const {
00079     return driver()->server_context()->static_asset_manager();
00080   }
00081 
00082   void ServeNonCriticalPanelContents(const Json::Value& json);
00083 
00086   void MarkElementWithPanelId(HtmlElement* element,
00087                               const GoogleString& panel_id);
00088 
00090   GoogleString GetPanelIdForInstance(HtmlElement* element);
00091 
00093   GoogleString GenerateCriticalLineConfigString();
00094 
00097   void EndPanelInstance();
00098 
00100   void StartPanelInstance(HtmlElement* element);
00101 
00103   void InsertPanelStub(HtmlElement* element, const GoogleString& panel_id);
00104 
00106   void AppendJsonData(Json::Value* dictionary, const Json::Value& dict);
00107 
00108   void WriteString(const StringPiece& str);
00109 
00113   void InsertSplitInitScripts(HtmlElement* element);
00114 
00115   void InvokeBaseHtmlFilterStartDocument();
00116 
00117   void InvokeBaseHtmlFilterStartElement(HtmlElement* element);
00118 
00119   void InvokeBaseHtmlFilterEndElement(HtmlElement* element);
00120 
00121   void InvokeBaseHtmlFilterEndDocument();
00122 
00127   bool IsAllowedCrossDomainRequest(StringPiece cross_origin);
00128 
00129   scoped_ptr<SplitHtmlState> state_;
00130   const RewriteOptions* options_;
00131   std::vector<ElementJsonPair> element_json_stack_;
00132   Json::FastWriter fast_writer_;
00133   scoped_ptr<JsonWriter> json_writer_;
00134   Writer* original_writer_;
00135   NullWriter null_writer_;
00136   StringPiece url_;
00137   bool script_written_;
00138   bool flush_head_enabled_;
00139   bool disable_filter_;
00140   bool inside_pagespeed_no_defer_script_;
00141   bool serve_response_in_two_chunks_;
00142   int last_script_index_before_panel_stub_;
00143   bool panel_seen_;
00144   ScriptTagScanner script_tag_scanner_;
00145 
00146   DISALLOW_COPY_AND_ASSIGN(SplitHtmlFilter);
00147 };
00148 
00149 }  
00150 
00151 #endif  ///< NET_INSTAWEB_REWRITER_PUBLIC_SPLIT_HTML_FILTER_H_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines