-
Notifications
You must be signed in to change notification settings - Fork 256
/
named_helper.go
176 lines (157 loc) · 5.19 KB
/
named_helper.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
// Copyright 2020-2022 Buf Technologies, Inc.
//
// 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 protogenutil
import (
"fmt"
"path"
"strings"
"google.golang.org/protobuf/compiler/protogen"
)
const namedHelperGoPackageOptionKey = "named_go_package"
type namedHelper struct {
pluginNameToGoPackage map[string]string
}
func newNamedHelper() *namedHelper {
return &namedHelper{
pluginNameToGoPackage: make(map[string]string),
}
}
func (h *namedHelper) NewGoPackageName(
baseGoPackageName protogen.GoPackageName,
pluginName string,
) protogen.GoPackageName {
return protogen.GoPackageName(string(baseGoPackageName) + pluginName)
}
func (h *namedHelper) NewGoImportPath(
file *protogen.File,
pluginName string,
) (protogen.GoImportPath, error) {
return h.newGoImportPath(
path.Dir(file.GeneratedFilenamePrefix),
file.GoPackageName,
pluginName,
)
}
func (h *namedHelper) NewPackageGoImportPath(
goPackageFileSet *GoPackageFileSet,
pluginName string,
) (protogen.GoImportPath, error) {
return h.newGoImportPath(
goPackageFileSet.GeneratedDir,
goPackageFileSet.GoPackageName,
pluginName,
)
}
func (h *namedHelper) NewGlobalGoImportPath(
pluginName string,
) (protogen.GoImportPath, error) {
goPackage, ok := h.pluginNameToGoPackage[pluginName]
if !ok {
return "", fmt.Errorf("no %s specified for plugin %s", namedHelperGoPackageOptionKey, pluginName)
}
return protogen.GoImportPath(goPackage), nil
}
func (h *namedHelper) NewGeneratedFile(
plugin *protogen.Plugin,
file *protogen.File,
pluginName string,
) (*protogen.GeneratedFile, error) {
goImportPath, err := h.NewGoImportPath(file, pluginName)
if err != nil {
return nil, err
}
goPackageName := h.NewGoPackageName(file.GoPackageName, pluginName)
generatedFilePath := path.Dir(file.GeneratedFilenamePrefix) +
"/" + string(goPackageName) +
"/" + path.Base(file.GeneratedFilenamePrefix) +
".pb.go"
generatedFile := plugin.NewGeneratedFile(generatedFilePath, goImportPath)
printGeneratedFileNamedHelperHeader(generatedFile, goPackageName, pluginName)
return generatedFile, nil
}
func (h *namedHelper) NewPackageGeneratedFile(
plugin *protogen.Plugin,
goPackageFileSet *GoPackageFileSet,
pluginName string,
) (*protogen.GeneratedFile, error) {
goImportPath, err := h.NewPackageGoImportPath(goPackageFileSet, pluginName)
if err != nil {
return nil, err
}
goPackageName := h.NewGoPackageName(goPackageFileSet.GoPackageName, pluginName)
fileBaseName := string(goPackageName)
// make sure this file name would not overlap with any actual file name
for _, file := range goPackageFileSet.Files {
if path.Base(file.GeneratedFilenamePrefix) == fileBaseName {
fileBaseName = fileBaseName + "_pkg"
// do not break, just for the malicious case, where there is a file
// packagename_pkg.proto, packagename_pkg_pkg.proto, etc
}
}
generatedFilePath := goPackageFileSet.GeneratedDir +
"/" + string(goPackageName) +
"/" + fileBaseName +
".pb.go"
generatedFile := plugin.NewGeneratedFile(generatedFilePath, goImportPath)
printGeneratedFileNamedHelperHeader(generatedFile, goPackageName, pluginName)
return generatedFile, nil
}
func (h *namedHelper) NewGlobalGeneratedFile(
plugin *protogen.Plugin,
pluginName string,
) (*protogen.GeneratedFile, error) {
goImportPath, err := h.NewGlobalGoImportPath(pluginName)
if err != nil {
return nil, err
}
goPackageName := h.NewGoPackageName("", pluginName)
generatedFilePath := string(goPackageName) + ".pb.go"
generatedFile := plugin.NewGeneratedFile(generatedFilePath, goImportPath)
printGeneratedFileNamedHelperHeader(generatedFile, goPackageName, pluginName)
return generatedFile, nil
}
func (h *namedHelper) newGoImportPath(
generatedDir string,
baseGoPackageName protogen.GoPackageName,
pluginName string,
) (protogen.GoImportPath, error) {
goPackage, ok := h.pluginNameToGoPackage[pluginName]
if !ok {
return "", fmt.Errorf("no %s specified for plugin %s", namedHelperGoPackageOptionKey, pluginName)
}
return protogen.GoImportPath(goPackage +
"/" + generatedDir +
"/" + string(h.NewGoPackageName(baseGoPackageName, pluginName))), nil
}
func (h *namedHelper) handleOption(key string, value string) error {
if key != namedHelperGoPackageOptionKey {
return nil
}
split := strings.Split(value, "=")
if len(split) != 2 {
return fmt.Errorf("unknown value for %s: %s", namedHelperGoPackageOptionKey, value)
}
h.pluginNameToGoPackage[split[0]] = split[1]
return nil
}
func printGeneratedFileNamedHelperHeader(
generatedFile *protogen.GeneratedFile,
goPackageName protogen.GoPackageName,
pluginName string,
) {
generatedFile.P("// Code generated by protoc-gen-go-", pluginName, ". DO NOT EDIT.")
generatedFile.P()
generatedFile.P("package ", goPackageName)
generatedFile.P()
}