Blame vendor/github.com/julienschmidt/httprouter/path.go

Packit Service 4d2de5
// Copyright 2013 Julien Schmidt. All rights reserved.
Packit Service 4d2de5
// Based on the path package, Copyright 2009 The Go Authors.
Packit Service 4d2de5
// Use of this source code is governed by a BSD-style license that can be found
Packit Service 4d2de5
// in the LICENSE file.
Packit Service 4d2de5
Packit Service 4d2de5
package httprouter
Packit Service 4d2de5
Packit Service 4d2de5
// CleanPath is the URL version of path.Clean, it returns a canonical URL path
Packit Service 4d2de5
// for p, eliminating . and .. elements.
Packit Service 4d2de5
//
Packit Service 4d2de5
// The following rules are applied iteratively until no further processing can
Packit Service 4d2de5
// be done:
Packit Service 4d2de5
//	1. Replace multiple slashes with a single slash.
Packit Service 4d2de5
//	2. Eliminate each . path name element (the current directory).
Packit Service 4d2de5
//	3. Eliminate each inner .. path name element (the parent directory)
Packit Service 4d2de5
//	   along with the non-.. element that precedes it.
Packit Service 4d2de5
//	4. Eliminate .. elements that begin a rooted path:
Packit Service 4d2de5
//	   that is, replace "/.." by "/" at the beginning of a path.
Packit Service 4d2de5
//
Packit Service 4d2de5
// If the result of this process is an empty string, "/" is returned
Packit Service 4d2de5
func CleanPath(p string) string {
Packit Service 4d2de5
	// Turn empty string into "/"
Packit Service 4d2de5
	if p == "" {
Packit Service 4d2de5
		return "/"
Packit Service 4d2de5
	}
Packit Service 4d2de5
Packit Service 4d2de5
	n := len(p)
Packit Service 4d2de5
	var buf []byte
Packit Service 4d2de5
Packit Service 4d2de5
	// Invariants:
Packit Service 4d2de5
	//      reading from path; r is index of next byte to process.
Packit Service 4d2de5
	//      writing to buf; w is index of next byte to write.
Packit Service 4d2de5
Packit Service 4d2de5
	// path must start with '/'
Packit Service 4d2de5
	r := 1
Packit Service 4d2de5
	w := 1
Packit Service 4d2de5
Packit Service 4d2de5
	if p[0] != '/' {
Packit Service 4d2de5
		r = 0
Packit Service 4d2de5
		buf = make([]byte, n+1)
Packit Service 4d2de5
		buf[0] = '/'
Packit Service 4d2de5
	}
Packit Service 4d2de5
Packit Service 4d2de5
	trailing := n > 1 && p[n-1] == '/'
Packit Service 4d2de5
Packit Service 4d2de5
	// A bit more clunky without a 'lazybuf' like the path package, but the loop
Packit Service 4d2de5
	// gets completely inlined (bufApp). So in contrast to the path package this
Packit Service 4d2de5
	// loop has no expensive function calls (except 1x make)
Packit Service 4d2de5
Packit Service 4d2de5
	for r < n {
Packit Service 4d2de5
		switch {
Packit Service 4d2de5
		case p[r] == '/':
Packit Service 4d2de5
			// empty path element, trailing slash is added after the end
Packit Service 4d2de5
			r++
Packit Service 4d2de5
Packit Service 4d2de5
		case p[r] == '.' && r+1 == n:
Packit Service 4d2de5
			trailing = true
Packit Service 4d2de5
			r++
Packit Service 4d2de5
Packit Service 4d2de5
		case p[r] == '.' && p[r+1] == '/':
Packit Service 4d2de5
			// . element
Packit Service 4d2de5
			r += 2
Packit Service 4d2de5
Packit Service 4d2de5
		case p[r] == '.' && p[r+1] == '.' && (r+2 == n || p[r+2] == '/'):
Packit Service 4d2de5
			// .. element: remove to last /
Packit Service 4d2de5
			r += 3
Packit Service 4d2de5
Packit Service 4d2de5
			if w > 1 {
Packit Service 4d2de5
				// can backtrack
Packit Service 4d2de5
				w--
Packit Service 4d2de5
Packit Service 4d2de5
				if buf == nil {
Packit Service 4d2de5
					for w > 1 && p[w] != '/' {
Packit Service 4d2de5
						w--
Packit Service 4d2de5
					}
Packit Service 4d2de5
				} else {
Packit Service 4d2de5
					for w > 1 && buf[w] != '/' {
Packit Service 4d2de5
						w--
Packit Service 4d2de5
					}
Packit Service 4d2de5
				}
Packit Service 4d2de5
			}
Packit Service 4d2de5
Packit Service 4d2de5
		default:
Packit Service 4d2de5
			// real path element.
Packit Service 4d2de5
			// add slash if needed
Packit Service 4d2de5
			if w > 1 {
Packit Service 4d2de5
				bufApp(&buf, p, w, '/')
Packit Service 4d2de5
				w++
Packit Service 4d2de5
			}
Packit Service 4d2de5
Packit Service 4d2de5
			// copy element
Packit Service 4d2de5
			for r < n && p[r] != '/' {
Packit Service 4d2de5
				bufApp(&buf, p, w, p[r])
Packit Service 4d2de5
				w++
Packit Service 4d2de5
				r++
Packit Service 4d2de5
			}
Packit Service 4d2de5
		}
Packit Service 4d2de5
	}
Packit Service 4d2de5
Packit Service 4d2de5
	// re-append trailing slash
Packit Service 4d2de5
	if trailing && w > 1 {
Packit Service 4d2de5
		bufApp(&buf, p, w, '/')
Packit Service 4d2de5
		w++
Packit Service 4d2de5
	}
Packit Service 4d2de5
Packit Service 4d2de5
	if buf == nil {
Packit Service 4d2de5
		return p[:w]
Packit Service 4d2de5
	}
Packit Service 4d2de5
	return string(buf[:w])
Packit Service 4d2de5
}
Packit Service 4d2de5
Packit Service 4d2de5
// internal helper to lazily create a buffer if necessary
Packit Service 4d2de5
func bufApp(buf *[]byte, s string, w int, c byte) {
Packit Service 4d2de5
	if *buf == nil {
Packit Service 4d2de5
		if s[w] == c {
Packit Service 4d2de5
			return
Packit Service 4d2de5
		}
Packit Service 4d2de5
Packit Service 4d2de5
		*buf = make([]byte, len(s))
Packit Service 4d2de5
		copy(*buf, s[:w])
Packit Service 4d2de5
	}
Packit Service 4d2de5
	(*buf)[w] = c
Packit Service 4d2de5
}