common_filter.h

Go to the documentation of this file.

/*
 * Copyright 2010 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_COMMON_FILTER_H_
#define NET_INSTAWEB_REWRITER_PUBLIC_COMMON_FILTER_H_

#include "net/instaweb/rewriter/public/resource.h"
#include "net/instaweb/rewriter/public/rewrite_driver.h"
#include "net/instaweb/rewriter/public/rewrite_options.h"
#include "net/instaweb/rewriter/public/server_context.h"
#include "pagespeed/kernel/base/basictypes.h"
#include "pagespeed/kernel/base/string.h"
#include "pagespeed/kernel/base/string_util.h"
#include "pagespeed/kernel/html/empty_html_filter.h"
#include "pagespeed/kernel/html/html_element.h"
#include "pagespeed/kernel/html/html_node.h"
#include "pagespeed/kernel/http/google_url.h"
#include "pagespeed/kernel/http/response_headers.h"

namespace net_instaweb {

class CommonFilter : public EmptyHtmlFilter {
 public:
  static const char kCreateResourceFailedDebugMsg[];

  explicit CommonFilter(RewriteDriver* driver);
  virtual ~CommonFilter();


  const GoogleUrl& base_url() const;

  const GoogleUrl& decoded_base_url() const;

  RewriteDriver* driver() const { return driver_; }
  HtmlElement* noscript_element() const { return noscript_element_; }

  void InsertNodeAtBodyEnd(HtmlNode* data);

  virtual void StartDocument();
  virtual void StartElement(HtmlElement* element);
  virtual void EndElement(HtmlElement* element);

  virtual void Characters(HtmlCharactersNode* characters);

  ResourcePtr CreateInputResource(StringPiece input_url,
                                  RewriteDriver::InputRole role,
                                  bool* is_authorized);

  ResourcePtr CreateInputResourceOrInsertDebugComment(
      StringPiece input_url, RewriteDriver::InputRole role,
      HtmlElement* element);

  void ResolveUrl(StringPiece input_url, GoogleUrl* out_url);

  bool IsRelativeUrlLoadPermittedByCsp(StringPiece url, CspDirective role);

  bool BaseUrlIsValid() const;

  bool DebugMode() const { return driver_->DebugMode(); }

  static bool ExtractMetaTagDetails(const HtmlElement& element,
                                    const ResponseHeaders* headers,
                                    GoogleString* content,
                                    GoogleString* mime_type,
                                    GoogleString* charset);

  bool CanAddPagespeedOnloadToImage(const HtmlElement&);

  virtual void LogFilterModifiedContent();

  virtual RewriteDriver::InlineAuthorizationPolicy AllowUnauthorizedDomain()
      const { return RewriteDriver::kInlineOnlyAuthorizedResources; }

  virtual bool IntendedForInlining() const { return false; }

  void AddJsToElement(StringPiece js, HtmlElement* script);

 protected:
  ServerContext* server_context() const { return server_context_; }
  const RewriteOptions* rewrite_options() { return rewrite_options_; }

  virtual void StartDocumentImpl() = 0;
  virtual void StartElementImpl(HtmlElement* element) = 0;
  virtual void EndElementImpl(HtmlElement* element) = 0;

  virtual const char* LoggingId() { return Name(); }

 private:
  RewriteDriver* driver_;
  ServerContext* server_context_;
  const RewriteOptions* rewrite_options_;
  HtmlElement* noscript_element_;
  HtmlElement* end_body_point_;
  bool seen_base_;

  
};

}  

#endif