밑바닥부터 만드는 리눅스 커맨드 라인 - 1. 분석 및 기본 구현

# 기본 검색입니다. grep 'pattern' [filename...]
> grep 'pattern' filename
# -R 옵션을 사용하면 해당 디렉토리 및 하위 디렉토리의 모든 파일에 대해 grep을 실행합니다.
> grep -R 'pattern' .
# -c 옵션을 사용하면 pattern 이 몇번 반복되었는지 수를 나타냅니다.
> grep -c 'pattern' filename
# 앞선 커맨드의 결과를 파이프연산으로 입력받아 grep을 수행합니다.
> echo "문자열" | grep 'pattern'

package main

type configuration struct {
	dereferenceRecursive bool // -R 여부
	count                bool // -c 여부
	pattern              string // 받은 pattern 값
	fileName             []string // 파일 이름. 복수의 파일 가능
	fromPipe             bool // pipe를 통해 값을 전달받는지 여부
}

const invalidArgument = "invalid argument count"
const cannotCreatTemp = "cannot create temp file"
const cannotReadFromPipe = "cannot read from pipe"
const cannotWriteTemp = "cannot write to temp file"

// 외부 입력 값들을 받아오는 함수입니다.
func setup() (configuration, error) {
	var config configuration
	var dereferenceRecursive, count bool

  // 옵션 들을 go언어의 기본 패키지은 flag를 통해 받습니다.
  // 실행 시 ./gorep -R 'pattern' filename 으로 받는다면,
  // 옵션으로 -R 이 true로 설정되고 -c는 받지 않았기 때문에 false가 됩니다.
	flag.BoolVar(&dereferenceRecursive, "R", false, "dereference recursive")
	flag.BoolVar(&count, "c", false, "count")
	flag.Parse()
  // 옵션을 제외한 인자들은 Args에 해당합니다.
	tail := flag.Args()

  // 파이프를 통해 값을 받아오는지 확인하는 조건문입니다.
  // grep에서는 -R 옵션을 사용할 경우 파이프 입력을 허용하지 않습니다.
	if fi, _ := os.Stdin.Stat(); !dereferenceRecursive && (fi.Mode()&os.ModeCharDevice) == 0 {
    // -R 옵션 사용하지 않았고 파이프로 입력받은 경우
    // 임시 파일을 생성하여 해당 파일에 pipe로 입력받은 값을 저장합니다.
    // 그리고 저장된 파일의 이름을 검색 파일 대상에 추가합니다.
		tmpFile, err := os.CreateTemp("", "gorep")
		if err != nil {
			return config, errors.New(cannotCreatTemp)
		}

		line, err := io.ReadAll(os.Stdin)
		if err != nil {
			return config, errors.New(cannotReadFromPipe)
		}

		err = os.WriteFile(tmpFile.Name(), line, 0644)
		if err != nil {
			return config, errors.New(cannotWriteTemp)
		}
    // defer 함수의 경우 return 직전에 실행됩니다.
		defer tmpFile.Close()
		return configuration{
			dereferenceRecursive: dereferenceRecursive,
			count:                count,
			pattern:              tail[0],
			fileName:             []string{tmpFile.Name()},
			fromPipe:             true,
		}, nil
	} else if len(tail) < 2 {
    // 파이프를 통해 값을 받지 않았으며 인자로 두개 이상 (패턴이름, 파일/폴더 이름)을 
    // 받지 않은경우 에러를 리턴합니다.
		return config, errors.New(invalidArgument)
	} else {
		return configuration{
			dereferenceRecursive: dereferenceRecursive,
			count:                count,
			pattern:              tail[0],
			fileName:             tail[1:],
			fromPipe:             false,
		}, nil
	}
}

package main

func main() {
  // config.go에서 작성한 setup() 함수를 불러옵니다.
  // 같은 패키지 내에 정의된 함수이기 때문에 exported name이 아니어도 됩니다.
	config, err := setup()
	if err != nil {
		fmt.Errorf(err.Error())
		os.Exit(2)
	}
  // -R 옵션을 사용하였을 경우 하위 폴더들을 순회하여 파일들을
  // 검색 대상으로 추가하는 코드입니다.
	if config.dereferenceRecursive {
		paths := make([]string, 0)
		err := filepath.Walk(config.fileName[0],
			func(path string, info os.FileInfo, err error) error {
				if err != nil {
					return err
				}
				if !info.IsDir() {
					paths = append(paths, path)
				}
				return nil
			})
		if err != nil {
			fmt.Errorf(err.Error())
			os.Exit(2)
		}
		config.fileName = paths
	}

  // -c 옵션을 사용하였을 경우 count를 반환하는 함수를 실행합니다.
  // 그렇지 않을 경우 pattern이 발견된 문자열을 출력하는 함수를 실행합니다.
	if printPrefix := len(config.fileName) > 1; config.count {
		for _, fileName := range config.fileName {
			searchCount(fileName, config.pattern, printPrefix)
		}
	} else {
		for _, fileName := range config.fileName {
			search(fileName, config.pattern, printPrefix)
		}
	}
}

package main

const cannotReadFile = "unable to read file: %v"
const errorWhileReadFile = "Error while reading file: %s"
const searchResultTemplate = "%s:%d|%s\n"
const countResultTemplate = "%s:%d\n"

func search(filename, pattern string, printPrefix bool) {
  // 검색 대상이 되는 파일을 open 합니다.
	file, err := os.Open(filename)
	if err != nil {
		log.Fatalf(cannotReadFile, err)
	}

	defer file.Close()
	fileScanner := bufio.NewScanner(file)

	lineNumber := 0
	for fileScanner.Scan() {
		line := fileScanner.Text()
    // go 언어의 문자열 검색은 grep과 동일하게 
    // boyer-moore string search 알고리즘을 사용합니다.
    // strings.Index 함수의 경우 위 알고리즘을 내부적으로 실행합니다.
    // 패턴이 발견되면 해당 문자열 속 해당 패턴의 첫 인덱스를 반환하고 
    // 반환되지 않을 경우 -1을 리턴합니다.
		if index := strings.Index(line, pattern); index > -1 {
			if printPrefix {
				fmt.Printf(searchResultTemplate, file.Name(), lineNumber, line)
			} else {
				fmt.Println(line)
			}
		}
		lineNumber++
	}
	if err := fileScanner.Err(); err != nil {
		log.Fatalf(errorWhileReadFile, err)
	}
}

func searchCount(filename, pattern string, printPrefix bool) {
	file, err := os.Open(filename)
	if err != nil {
		log.Fatalf(cannotReadFile, err)
	}

	defer file.Close()
	fileScanner := bufio.NewScanner(file)

	count := 0
	for fileScanner.Scan() {
		line := fileScanner.Text()
    // strings.Count 함수 역시 내부적으로 
    // boyer-moore string search 알고리즘을 사용합니다.
		count += strings.Count(line, pattern)
	}

	if err := fileScanner.Err(); err != nil {
		log.Fatalf(errorWhileReadFile, err)
	}

	if count != 0 {
		if printPrefix {
			fmt.Printf(countResultTemplate, file.Name(), count)
		} else {
			fmt.Println(count)
		}
	}
}