kubernetes/cmd/mungedocs/links.go

/*
Copyright 2015 The Kubernetes Authors All rights reserved.

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.
*/

package main

import (
	"errors"
	"fmt"
	"net/url"
	"os"
	"path"
	"regexp"
	"strings"
)

var (
	// Finds markdown links of the form [foo](bar "alt-text").
	linkRE = regexp.MustCompile(`\[([^]]*)\]\(([^)]*)\)`)
	// Finds markdown link typos of the form (foo)[bar]
	badLinkRE = regexp.MustCompile(`\([^]()]*\)\[[^]()]*\]`)
	// Splits the link target into link target and alt-text.
	altTextRE = regexp.MustCompile(`([^)]*)( ".*")`)
)

func processLink(in string, filePath string) (string, error) {
	var errs []string
	out := linkRE.ReplaceAllStringFunc(in, func(in string) string {
		var err error
		match := linkRE.FindStringSubmatch(in)
		if match == nil {
			errs = append(errs, fmt.Sprintf("Detected this line had a link, but unable to parse, %v", in))
			return ""
		}
		// match[0] is the entire expression;
		visibleText := match[1]
		linkText := match[2]
		altText := ""
		if parts := altTextRE.FindStringSubmatch(linkText); parts != nil {
			linkText = parts[1]
			altText = parts[2]
		}

		// clean up some random garbage I found in our docs.
		linkText = strings.Trim(linkText, " ")
		linkText = strings.Trim(linkText, "\n")
		linkText = strings.Trim(linkText, " ")

		u, terr := url.Parse(linkText)
		if terr != nil {
			errs = append(errs, fmt.Sprintf("link %q is unparsable: %v", linkText, terr))
			return in
		}

		if u.Host != "" && u.Host != "github.com" {
			// We only care about relative links and links within github.
			return in
		}

		suggestedVisibleText := visibleText
		if u.Path != "" && !strings.HasPrefix(linkText, "TODO:") {
			newPath, targetExists := checkPath(filePath, path.Clean(u.Path))
			if !targetExists {
				errs = append(errs, fmt.Sprintf("%q: target not found", linkText))
				return in
			}
			u.Path = newPath
			if strings.HasPrefix(u.Path, "/") {
				u.Host = "github.com"
				u.Scheme = "https"
			} else {
				// Remove host and scheme from relative paths
				u.Host = ""
				u.Scheme = ""
			}
			// Make the visible text show the absolute path if it's
			// not nested in or beneath the current directory.
			if strings.HasPrefix(u.Path, "..") {
				dir := path.Dir(filePath)
				suggestedVisibleText, err = makeRepoRelative(path.Join(dir, u.Path), filePath)
				if err != nil {
					errs = append(errs, fmt.Sprintf("%q: unable to make path relative", filePath))
					return in
				}
			} else {
				suggestedVisibleText = u.Path
			}
			var unescaped string
			if unescaped, err = url.QueryUnescape(u.String()); err != nil {
				// Remove %28 type stuff, be nice to humans.
				// And don't fight with the toc generator.
				linkText = unescaped
			} else {
				linkText = u.String()
			}
		}
		// If the current visible text is trying to be a file name, use
		// the correct file name.
		if strings.HasSuffix(visibleText, ".md") && !strings.ContainsAny(visibleText, ` '"`+"`") {
			visibleText = suggestedVisibleText
		}

		return fmt.Sprintf("[%s](%s)", visibleText, linkText+altText)
	})
	if len(errs) != 0 {
		return "", errors.New(strings.Join(errs, ","))
	}
	return out, nil
}

// updateLinks assumes lines has links in markdown syntax, and verifies that
// any relative links actually point to files that exist.
func updateLinks(filePath string, mlines mungeLines) (mungeLines, error) {
	var out mungeLines
	allErrs := []string{}

	for lineNum, mline := range mlines {
		if mline.preformatted {
			out = append(out, mline)
			continue
		}
		if badMatch := badLinkRE.FindString(mline.data); badMatch != "" {
			allErrs = append(allErrs,
				fmt.Sprintf("On line %d: found backwards markdown link %q", lineNum, badMatch))
		}
		if !mline.link {
			out = append(out, mline)
			continue
		}
		line, err := processLink(mline.data, filePath)
		if err != nil {
			var s = fmt.Sprintf("On line %d: %s", lineNum, err.Error())
			err := errors.New(s)
			allErrs = append(allErrs, err.Error())
		}
		ml := newMungeLine(line)
		out = append(out, ml)
	}
	err := error(nil)
	if len(allErrs) != 0 {
		err = fmt.Errorf("%s", strings.Join(allErrs, "\n"))
	}
	return out, err
}

// We have to append together before path.Clean will be able to tell that stuff
// like ../docs isn't needed.
func cleanPath(dirPath, linkPath string) string {
	clean := path.Clean(path.Join(dirPath, linkPath))
	if strings.HasPrefix(clean, dirPath+"/") {
		out := strings.TrimPrefix(clean, dirPath+"/")
		if out != linkPath {
			fmt.Printf("%s -> %s\n", linkPath, out)
		}
		return out
	}
	return linkPath
}

func checkPath(filePath, linkPath string) (newPath string, ok bool) {
	dir := path.Dir(filePath)
	absFilePrefixes := []string{
		"/kubernetes/kubernetes/blob/master/",
		"/kubernetes/kubernetes/tree/master/",
	}
	for _, prefix := range absFilePrefixes {
		if strings.HasPrefix(linkPath, prefix) {
			linkPath = strings.TrimPrefix(linkPath, prefix)
			// Now linkPath is relative to the root of the repo. The below
			// loop that adds ../ at the beginning of the path should find
			// the right path.
			break
		}
	}
	if strings.HasPrefix(linkPath, "/") {
		// These links might go to e.g. the github issues page, or a
		// file at a particular revision, or another github project
		// entirely.
		return linkPath, true
	}
	linkPath = cleanPath(dir, linkPath)

	// Fast exit if the link is already correct.
	if info, err := os.Stat(path.Join(dir, linkPath)); err == nil {
		if info.IsDir() {
			return linkPath + "/", true
		}
		return linkPath, true
	}

	for strings.HasPrefix(linkPath, "../") {
		linkPath = strings.TrimPrefix(linkPath, "../")
	}

	// Fix - vs _ automatically
	nameMungers := []func(string) string{
		func(s string) string { return s },
		func(s string) string { return strings.Replace(s, "-", "_", -1) },
		func(s string) string { return strings.Replace(s, "_", "-", -1) },
	}
	// Fix being moved into/out of admin (replace "admin" with directory
	// you're doing mass movements to/from).
	pathMungers := []func(string) string{
		func(s string) string { return s },
		func(s string) string { return path.Join("admin", s) },
		func(s string) string { return strings.TrimPrefix(s, "admin/") },
	}

	for _, namer := range nameMungers {
		for _, pather := range pathMungers {
			newPath = pather(namer(linkPath))
			for i := 0; i < 7; i++ {
				// The file must exist.
				target := path.Join(dir, newPath)
				if info, err := os.Stat(target); err == nil {
					if info.IsDir() {
						return newPath + "/", true
					}
					return cleanPath(dir, newPath), true
				}
				newPath = path.Join("..", newPath)
			}
		}
	}
	return linkPath, false
}