blob: 6ea062416240f8da077bfd040b9cf77ce46526c6 [file] [log] [blame]
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// A class to help filter URLRequest jobs based on the URL of the request
// rather than just the scheme. Example usage:
// // Use as an "http" handler.
// URLRequest::RegisterProtocolFactory("http", &URLRequestFilter::Factory);
// // Add special handling for the URL
// URLRequestFilter::GetInstance()->AddUrlHandler(
// GURL(""),
// &URLRequestCustomJob::Factory);
// If URLRequestFilter::Factory can't find a handle for the request, it passes
// it through to URLRequestInetJob::Factory and lets the default network stack
// handle it.
#pragma once
#include <map>
#include <string>
#include "base/hash_tables.h"
#include "net/base/net_export.h"
#include "net/url_request/url_request.h"
class GURL;
namespace net {
class URLRequestJob;
class NET_EXPORT URLRequestFilter {
// scheme,hostname -> ProtocolFactory
typedef std::map<std::pair<std::string, std::string>,
URLRequest::ProtocolFactory*> HostnameHandlerMap;
typedef base::hash_map<std::string, URLRequest::ProtocolFactory*>
static URLRequest::ProtocolFactory Factory;
// Singleton instance for use.
static URLRequestFilter* GetInstance();
void AddHostnameHandler(const std::string& scheme,
const std::string& hostname,
URLRequest::ProtocolFactory* factory);
void RemoveHostnameHandler(const std::string& scheme,
const std::string& hostname);
// Returns true if we successfully added the URL handler. This will replace
// old handlers for the URL if one existed.
bool AddUrlHandler(const GURL& url,
URLRequest::ProtocolFactory* factory);
void RemoveUrlHandler(const GURL& url);
// Clear all the existing URL handlers and unregister with the
// ProtocolFactory. Resets the hit count.
void ClearHandlers();
// Returns the number of times a handler was used to service a request.
int hit_count() const { return hit_count_; }
// Helper method that looks up the request in the url_handler_map_.
URLRequestJob* FindRequestHandler(URLRequest* request,
const std::string& scheme);
// Maps hostnames to factories. Hostnames take priority over URLs.
HostnameHandlerMap hostname_handler_map_;
// Maps URLs to factories.
UrlHandlerMap url_handler_map_;
int hit_count_;
// Singleton instance.
static URLRequestFilter* shared_instance_;
} // namespace net