http: extract query parser to bittorrent package
This commit is contained in:
parent
9dc5372796
commit
6260570635
5 changed files with 222 additions and 146 deletions
|
@ -124,11 +124,6 @@ func (p Peer) Equal(x Peer) bool { return p.EqualEndpoint(x) && p.ID == x.ID }
|
||||||
// EqualEndpoint reports whether p and x have the same endpoint.
|
// EqualEndpoint reports whether p and x have the same endpoint.
|
||||||
func (p Peer) EqualEndpoint(x Peer) bool { return p.Port == x.Port && p.IP.Equal(x.IP) }
|
func (p Peer) EqualEndpoint(x Peer) bool { return p.Port == x.Port && p.IP.Equal(x.IP) }
|
||||||
|
|
||||||
// Params is used to fetch request optional parameters from an Announce.
|
|
||||||
type Params interface {
|
|
||||||
String(key string) (string, bool)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ClientError represents an error that should be exposed to the client over
|
// ClientError represents an error that should be exposed to the client over
|
||||||
// the BitTorrent protocol implementation.
|
// the BitTorrent protocol implementation.
|
||||||
type ClientError string
|
type ClientError string
|
||||||
|
|
192
bittorrent/params.go
Normal file
192
bittorrent/params.go
Normal file
|
@ -0,0 +1,192 @@
|
||||||
|
package bittorrent
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"net/url"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Params is used to fetch (optional) request parameters from an Announce.
|
||||||
|
// For HTTP Announces this includes the request path and parsed query, for UDP
|
||||||
|
// Announces this is the extracted path and parsed query from optional URLData
|
||||||
|
// as specified in BEP41.
|
||||||
|
//
|
||||||
|
// See ParseURLData for specifics on parsing and limitations.
|
||||||
|
type Params interface {
|
||||||
|
// String returns a string parsed from a query. Every key can be
|
||||||
|
// returned as a string because they are encoded in the URL as strings.
|
||||||
|
String(key string) (string, bool)
|
||||||
|
|
||||||
|
// RawPath returns the raw path from the request URL.
|
||||||
|
// The path returned can contain URL encoded data.
|
||||||
|
// For a request of the form "/announce?port=1234" this would return
|
||||||
|
// "/announce".
|
||||||
|
RawPath() string
|
||||||
|
|
||||||
|
// RawQuery returns the raw query from the request URL, excluding the
|
||||||
|
// delimiter '?'.
|
||||||
|
// For a request of the form "/announce?port=1234" this would return
|
||||||
|
// "port=1234"
|
||||||
|
RawQuery() string
|
||||||
|
}
|
||||||
|
|
||||||
|
// ErrKeyNotFound is returned when a provided key has no value associated with
|
||||||
|
// it.
|
||||||
|
var ErrKeyNotFound = errors.New("query: value for the provided key does not exist")
|
||||||
|
|
||||||
|
// ErrInvalidInfohash is returned when parsing a query encounters an infohash
|
||||||
|
// with invalid length.
|
||||||
|
var ErrInvalidInfohash = errors.New("query: invalid infohash")
|
||||||
|
|
||||||
|
// QueryParams parses a URL Query and implements the Params interface with some
|
||||||
|
// additional helpers.
|
||||||
|
type QueryParams struct {
|
||||||
|
path string
|
||||||
|
query string
|
||||||
|
params map[string]string
|
||||||
|
infoHashes []InfoHash
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseURLData parses a request URL or UDP URLData as defined in BEP41.
|
||||||
|
// It expects a concatenated string of the request's path and query parts as
|
||||||
|
// defined in RFC 3986. As both the udp: and http: scheme used by BitTorrent
|
||||||
|
// include an authority part the path part must always begin with a slash.
|
||||||
|
// An example of the expected URLData would be "/announce?port=1234&uploaded=0"
|
||||||
|
// or "/?auth=0x1337".
|
||||||
|
// HTTP servers should pass (*http.Request).RequestURI, UDP servers should
|
||||||
|
// pass the concatenated, unchanged URLData as defined in BEP41.
|
||||||
|
//
|
||||||
|
// Note that, in the case of a key occurring multiple times in the query, only
|
||||||
|
// the last value for that key is kept.
|
||||||
|
// The only exception to this rule is the key "info_hash" which will attempt to
|
||||||
|
// parse each value as an InfoHash and return an error if parsing fails. All
|
||||||
|
// InfoHashes are collected and can later be retrieved by calling the InfoHashes
|
||||||
|
// method.
|
||||||
|
func ParseURLData(urlData string) (*QueryParams, error) {
|
||||||
|
var path, query string
|
||||||
|
|
||||||
|
queryDelim := strings.IndexAny(urlData, "?")
|
||||||
|
if queryDelim == -1 {
|
||||||
|
path = urlData
|
||||||
|
} else {
|
||||||
|
path = urlData[:queryDelim]
|
||||||
|
query = urlData[queryDelim+1:]
|
||||||
|
}
|
||||||
|
|
||||||
|
q, err := parseQuery(query)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
q.path = path
|
||||||
|
return q, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseQuery parses a URL query into QueryParams.
|
||||||
|
// The query is expected to exclude the delimiting '?'.
|
||||||
|
func parseQuery(rawQuery string) (*QueryParams, error) {
|
||||||
|
var (
|
||||||
|
keyStart, keyEnd int
|
||||||
|
valStart, valEnd int
|
||||||
|
|
||||||
|
onKey = true
|
||||||
|
|
||||||
|
q = &QueryParams{
|
||||||
|
query: rawQuery,
|
||||||
|
infoHashes: nil,
|
||||||
|
params: make(map[string]string),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
for i, length := 0, len(rawQuery); i < length; i++ {
|
||||||
|
separator := rawQuery[i] == '&' || rawQuery[i] == ';'
|
||||||
|
last := i == length-1
|
||||||
|
|
||||||
|
if separator || last {
|
||||||
|
if onKey && !last {
|
||||||
|
keyStart = i + 1
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if last && !separator && !onKey {
|
||||||
|
valEnd = i
|
||||||
|
}
|
||||||
|
|
||||||
|
keyStr, err := url.QueryUnescape(rawQuery[keyStart : keyEnd+1])
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var valStr string
|
||||||
|
|
||||||
|
if valEnd > 0 {
|
||||||
|
valStr, err = url.QueryUnescape(rawQuery[valStart : valEnd+1])
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if keyStr == "info_hash" {
|
||||||
|
if len(valStr) != 20 {
|
||||||
|
return nil, ErrInvalidInfohash
|
||||||
|
}
|
||||||
|
q.infoHashes = append(q.infoHashes, InfoHashFromString(valStr))
|
||||||
|
} else {
|
||||||
|
q.params[strings.ToLower(keyStr)] = valStr
|
||||||
|
}
|
||||||
|
|
||||||
|
valEnd = 0
|
||||||
|
onKey = true
|
||||||
|
keyStart = i + 1
|
||||||
|
|
||||||
|
} else if rawQuery[i] == '=' {
|
||||||
|
onKey = false
|
||||||
|
valStart = i + 1
|
||||||
|
valEnd = 0
|
||||||
|
} else if onKey {
|
||||||
|
keyEnd = i
|
||||||
|
} else {
|
||||||
|
valEnd = i
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return q, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// String returns a string parsed from a query. Every key can be returned as a
|
||||||
|
// string because they are encoded in the URL as strings.
|
||||||
|
func (qp *QueryParams) String(key string) (string, bool) {
|
||||||
|
value, ok := qp.params[key]
|
||||||
|
return value, ok
|
||||||
|
}
|
||||||
|
|
||||||
|
// Uint64 returns a uint parsed from a query. After being called, it is safe to
|
||||||
|
// cast the uint64 to your desired length.
|
||||||
|
func (qp *QueryParams) Uint64(key string) (uint64, error) {
|
||||||
|
str, exists := qp.params[key]
|
||||||
|
if !exists {
|
||||||
|
return 0, ErrKeyNotFound
|
||||||
|
}
|
||||||
|
|
||||||
|
val, err := strconv.ParseUint(str, 10, 64)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return val, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// InfoHashes returns a list of requested infohashes.
|
||||||
|
func (qp *QueryParams) InfoHashes() []InfoHash {
|
||||||
|
return qp.infoHashes
|
||||||
|
}
|
||||||
|
|
||||||
|
// RawPath returns the raw path from the parsed URL.
|
||||||
|
func (qp *QueryParams) RawPath() string {
|
||||||
|
return qp.path
|
||||||
|
}
|
||||||
|
|
||||||
|
// RawQuery returns the raw query from the parsed URL.
|
||||||
|
func (qp *QueryParams) RawQuery() string {
|
||||||
|
return qp.query
|
||||||
|
}
|
|
@ -1,4 +1,4 @@
|
||||||
package http
|
package bittorrent
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"net/url"
|
"net/url"
|
||||||
|
@ -6,11 +6,10 @@ import (
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
baseAddr = "https://www.subdomain.tracker.com:80/"
|
testPeerID = "-TEST01-6wfG2wk6wWLc"
|
||||||
testInfoHash = "01234567890123456789"
|
|
||||||
testPeerID = "-TEST01-6wfG2wk6wWLc"
|
|
||||||
|
|
||||||
ValidAnnounceArguments = []url.Values{
|
ValidAnnounceArguments = []url.Values{
|
||||||
|
{},
|
||||||
{"peer_id": {testPeerID}, "port": {"6881"}, "downloaded": {"1234"}, "left": {"4321"}},
|
{"peer_id": {testPeerID}, "port": {"6881"}, "downloaded": {"1234"}, "left": {"4321"}},
|
||||||
{"peer_id": {testPeerID}, "ip": {"192.168.0.1"}, "port": {"6881"}, "downloaded": {"1234"}, "left": {"4321"}},
|
{"peer_id": {testPeerID}, "ip": {"192.168.0.1"}, "port": {"6881"}, "downloaded": {"1234"}, "left": {"4321"}},
|
||||||
{"peer_id": {testPeerID}, "ip": {"192.168.0.1"}, "port": {"6881"}, "downloaded": {"1234"}, "left": {"4321"}, "numwant": {"28"}},
|
{"peer_id": {testPeerID}, "ip": {"192.168.0.1"}, "port": {"6881"}, "downloaded": {"1234"}, "left": {"4321"}, "numwant": {"28"}},
|
||||||
|
@ -26,7 +25,7 @@ var (
|
||||||
}
|
}
|
||||||
|
|
||||||
InvalidQueries = []string{
|
InvalidQueries = []string{
|
||||||
baseAddr + "announce/?" + "info_hash=%0%a",
|
"/announce?" + "info_hash=%0%a",
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -45,28 +44,42 @@ func mapArrayEqual(boxed map[string][]string, unboxed map[string]string) bool {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestValidQueries(t *testing.T) {
|
func TestParseEmptyURLData(t *testing.T) {
|
||||||
|
parsedQuery, err := ParseURLData("")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if parsedQuery == nil {
|
||||||
|
t.Fatal("Parsed query must not be nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseValidURLData(t *testing.T) {
|
||||||
for parseIndex, parseVal := range ValidAnnounceArguments {
|
for parseIndex, parseVal := range ValidAnnounceArguments {
|
||||||
parsedQueryObj, err := NewQueryParams(baseAddr + "announce/?" + parseVal.Encode())
|
parsedQueryObj, err := ParseURLData("/announce?" + parseVal.Encode())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Error(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !mapArrayEqual(parseVal, parsedQueryObj.params) {
|
if !mapArrayEqual(parseVal, parsedQueryObj.params) {
|
||||||
t.Errorf("Incorrect parse at item %d.\n Expected=%v\n Recieved=%v\n", parseIndex, parseVal, parsedQueryObj.params)
|
t.Fatalf("Incorrect parse at item %d.\n Expected=%v\n Recieved=%v\n", parseIndex, parseVal, parsedQueryObj.params)
|
||||||
|
}
|
||||||
|
|
||||||
|
if parsedQueryObj.path != "/announce" {
|
||||||
|
t.Fatalf("Incorrect path, expected %q, got %q", "/announce", parsedQueryObj.path)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestInvalidQueries(t *testing.T) {
|
func TestParseInvalidURLData(t *testing.T) {
|
||||||
for parseIndex, parseStr := range InvalidQueries {
|
for parseIndex, parseStr := range InvalidQueries {
|
||||||
parsedQueryObj, err := NewQueryParams(parseStr)
|
parsedQueryObj, err := ParseURLData(parseStr)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Error("Should have produced error", parseIndex)
|
t.Fatal("Should have produced error", parseIndex)
|
||||||
}
|
}
|
||||||
|
|
||||||
if parsedQueryObj != nil {
|
if parsedQueryObj != nil {
|
||||||
t.Error("Should be nil after error", parsedQueryObj, parseIndex)
|
t.Fatal("Should be nil after error", parsedQueryObj, parseIndex)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -74,7 +87,7 @@ func TestInvalidQueries(t *testing.T) {
|
||||||
func BenchmarkParseQuery(b *testing.B) {
|
func BenchmarkParseQuery(b *testing.B) {
|
||||||
for bCount := 0; bCount < b.N; bCount++ {
|
for bCount := 0; bCount < b.N; bCount++ {
|
||||||
for parseIndex, parseStr := range ValidAnnounceArguments {
|
for parseIndex, parseStr := range ValidAnnounceArguments {
|
||||||
parsedQueryObj, err := NewQueryParams(baseAddr + "announce/?" + parseStr.Encode())
|
parsedQueryObj, err := parseQuery(parseStr.Encode())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
b.Error(err, parseIndex)
|
b.Error(err, parseIndex)
|
||||||
b.Log(parsedQueryObj)
|
b.Log(parsedQueryObj)
|
||||||
|
@ -86,7 +99,7 @@ func BenchmarkParseQuery(b *testing.B) {
|
||||||
func BenchmarkURLParseQuery(b *testing.B) {
|
func BenchmarkURLParseQuery(b *testing.B) {
|
||||||
for bCount := 0; bCount < b.N; bCount++ {
|
for bCount := 0; bCount < b.N; bCount++ {
|
||||||
for parseIndex, parseStr := range ValidAnnounceArguments {
|
for parseIndex, parseStr := range ValidAnnounceArguments {
|
||||||
parsedQueryObj, err := url.ParseQuery(baseAddr + "announce/?" + parseStr.Encode())
|
parsedQueryObj, err := url.ParseQuery(parseStr.Encode())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
b.Error(err, parseIndex)
|
b.Error(err, parseIndex)
|
||||||
b.Log(parsedQueryObj)
|
b.Log(parsedQueryObj)
|
|
@ -13,7 +13,7 @@ import (
|
||||||
// If realIPHeader is not empty string, the first value of the HTTP Header with
|
// If realIPHeader is not empty string, the first value of the HTTP Header with
|
||||||
// that name will be used.
|
// that name will be used.
|
||||||
func ParseAnnounce(r *http.Request, realIPHeader string, allowIPSpoofing bool) (*bittorrent.AnnounceRequest, error) {
|
func ParseAnnounce(r *http.Request, realIPHeader string, allowIPSpoofing bool) (*bittorrent.AnnounceRequest, error) {
|
||||||
qp, err := NewQueryParams(r.URL.RawQuery)
|
qp, err := bittorrent.ParseURLData(r.RequestURI)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
@ -84,7 +84,7 @@ func ParseAnnounce(r *http.Request, realIPHeader string, allowIPSpoofing bool) (
|
||||||
|
|
||||||
// ParseScrape parses an bittorrent.ScrapeRequest from an http.Request.
|
// ParseScrape parses an bittorrent.ScrapeRequest from an http.Request.
|
||||||
func ParseScrape(r *http.Request) (*bittorrent.ScrapeRequest, error) {
|
func ParseScrape(r *http.Request) (*bittorrent.ScrapeRequest, error) {
|
||||||
qp, err := NewQueryParams(r.URL.RawQuery)
|
qp, err := bittorrent.ParseURLData(r.RequestURI)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,124 +0,0 @@
|
||||||
package http
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"net/url"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/chihaya/chihaya/bittorrent"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrKeyNotFound is returned when a provided key has no value associated with
|
|
||||||
// it.
|
|
||||||
var ErrKeyNotFound = errors.New("http: value for the provided key does not exist")
|
|
||||||
|
|
||||||
// ErrInvalidInfohash is returned when parsing a query encounters an infohash
|
|
||||||
// with invalid length.
|
|
||||||
var ErrInvalidInfohash = errors.New("http: invalid infohash")
|
|
||||||
|
|
||||||
// QueryParams parses an HTTP Query and implements the bittorrent.Params
|
|
||||||
// interface with some additional helpers.
|
|
||||||
type QueryParams struct {
|
|
||||||
query string
|
|
||||||
params map[string]string
|
|
||||||
infoHashes []bittorrent.InfoHash
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewQueryParams parses a raw URL query.
|
|
||||||
func NewQueryParams(query string) (*QueryParams, error) {
|
|
||||||
var (
|
|
||||||
keyStart, keyEnd int
|
|
||||||
valStart, valEnd int
|
|
||||||
|
|
||||||
onKey = true
|
|
||||||
|
|
||||||
q = &QueryParams{
|
|
||||||
query: query,
|
|
||||||
infoHashes: nil,
|
|
||||||
params: make(map[string]string),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
for i, length := 0, len(query); i < length; i++ {
|
|
||||||
separator := query[i] == '&' || query[i] == ';' || query[i] == '?'
|
|
||||||
last := i == length-1
|
|
||||||
|
|
||||||
if separator || last {
|
|
||||||
if onKey && !last {
|
|
||||||
keyStart = i + 1
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if last && !separator && !onKey {
|
|
||||||
valEnd = i
|
|
||||||
}
|
|
||||||
|
|
||||||
keyStr, err := url.QueryUnescape(query[keyStart : keyEnd+1])
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var valStr string
|
|
||||||
|
|
||||||
if valEnd > 0 {
|
|
||||||
valStr, err = url.QueryUnescape(query[valStart : valEnd+1])
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if keyStr == "info_hash" {
|
|
||||||
if len(valStr) != 20 {
|
|
||||||
return nil, ErrInvalidInfohash
|
|
||||||
}
|
|
||||||
q.infoHashes = append(q.infoHashes, bittorrent.InfoHashFromString(valStr))
|
|
||||||
} else {
|
|
||||||
q.params[strings.ToLower(keyStr)] = valStr
|
|
||||||
}
|
|
||||||
|
|
||||||
valEnd = 0
|
|
||||||
onKey = true
|
|
||||||
keyStart = i + 1
|
|
||||||
|
|
||||||
} else if query[i] == '=' {
|
|
||||||
onKey = false
|
|
||||||
valStart = i + 1
|
|
||||||
valEnd = 0
|
|
||||||
} else if onKey {
|
|
||||||
keyEnd = i
|
|
||||||
} else {
|
|
||||||
valEnd = i
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return q, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// String returns a string parsed from a query. Every key can be returned as a
|
|
||||||
// string because they are encoded in the URL as strings.
|
|
||||||
func (qp *QueryParams) String(key string) (string, bool) {
|
|
||||||
value, ok := qp.params[key]
|
|
||||||
return value, ok
|
|
||||||
}
|
|
||||||
|
|
||||||
// Uint64 returns a uint parsed from a query. After being called, it is safe to
|
|
||||||
// cast the uint64 to your desired length.
|
|
||||||
func (qp *QueryParams) Uint64(key string) (uint64, error) {
|
|
||||||
str, exists := qp.params[key]
|
|
||||||
if !exists {
|
|
||||||
return 0, ErrKeyNotFound
|
|
||||||
}
|
|
||||||
|
|
||||||
val, err := strconv.ParseUint(str, 10, 64)
|
|
||||||
if err != nil {
|
|
||||||
return 0, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return val, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// InfoHashes returns a list of requested infohashes.
|
|
||||||
func (qp *QueryParams) InfoHashes() []bittorrent.InfoHash {
|
|
||||||
return qp.infoHashes
|
|
||||||
}
|
|
Loading…
Reference in a new issue