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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
//! API to generate `.rs` files.

#![deny(intra_doc_link_resolution_failure)]
#![deny(missing_docs)]

use protoc::Protoc;
use protoc_rust::Customize;
use std::fs;
use std::io;
use std::io::Read;
use std::io::Write;
use std::path::{Path, PathBuf};

/// Error type alias.
pub type Error = io::Error;
/// Result type alias.
pub type Result<T> = io::Result<T>;

/// Utility to generate `.rs` files.
#[derive(Debug, Default)]
pub struct Codegen {
    protoc: Option<Protoc>,
    /// --lang_out= param
    out_dir: PathBuf,
    /// -I args
    includes: Vec<PathBuf>,
    /// List of .proto files to compile
    inputs: Vec<PathBuf>,
    /// Generate rust-protobuf files along with rust-gprc
    rust_protobuf: bool,
    /// Customize rust-protobuf codegen
    rust_protobuf_customize: protoc_rust::Customize,
}

impl Codegen {
    /// Create new codegen object.
    pub fn new() -> Codegen {
        Default::default()
    }

    /// Set `--LANG_out=...` param
    pub fn out_dir(&mut self, out_dir: impl AsRef<Path>) -> &mut Self {
        self.out_dir = out_dir.as_ref().to_owned();
        self
    }

    /// Append a path to `-I` args
    pub fn include(&mut self, include: impl AsRef<Path>) -> &mut Self {
        self.includes.push(include.as_ref().to_owned());
        self
    }

    /// Append multiple paths to `-I` args
    pub fn includes(&mut self, includes: impl IntoIterator<Item = impl AsRef<Path>>) -> &mut Self {
        for include in includes {
            self.include(include);
        }
        self
    }

    /// Append a `.proto` file path to compile
    pub fn input(&mut self, input: impl AsRef<Path>) -> &mut Self {
        self.inputs.push(input.as_ref().to_owned());
        self
    }

    /// Append multiple `.proto` file paths to compile
    pub fn inputs(&mut self, inputs: impl IntoIterator<Item = impl AsRef<Path>>) -> &mut Self {
        for input in inputs {
            self.input(input);
        }
        self
    }

    /// Generate rust-protobuf files along with rust-gprc
    pub fn rust_protobuf(&mut self, rust_protobuf: bool) -> &mut Self {
        self.rust_protobuf = rust_protobuf;
        self
    }

    /// Generate rust-protobuf files along with rust-gprc
    pub fn rust_protobuf_customize(&mut self, rust_protobuf_customize: Customize) -> &mut Self {
        self.rust_protobuf_customize = rust_protobuf_customize;
        self
    }

    /// Run the codegen.
    ///
    /// Generate `_grpc.rs` files, and if [`rust_protobuf_customize`](Codegen::rust_protobuf_customize)
    /// is specified, generate rust-protobuf `.rs` files too.
    ///
    pub fn run(&self) -> Result<()> {
        let protoc = self
            .protoc
            .clone()
            .unwrap_or_else(|| protoc::Protoc::from_env_path());
        let version = protoc.version().expect("protoc version");
        if !version.is_3() {
            panic!("protobuf must have version 3");
        }

        if self.rust_protobuf {
            protoc_rust::Codegen::new()
                .out_dir(&self.out_dir)
                .includes(&self.includes)
                .inputs(&self.inputs)
                .customize(self.rust_protobuf_customize.clone())
                .run()?;
        }

        let temp_dir = tempdir::TempDir::new("protoc-rust")?;
        let temp_file = temp_dir.path().join("descriptor.pbbin");
        let temp_file = temp_file.to_str().expect("utf-8 file name");

        let includes: Vec<&str> = self
            .includes
            .iter()
            .map(|p| p.as_os_str().to_str().unwrap())
            .collect();
        let inputs: Vec<&str> = self
            .inputs
            .iter()
            .map(|p| p.as_os_str().to_str().unwrap())
            .collect();
        protoc.write_descriptor_set(protoc::DescriptorSetOutArgs {
            out: temp_file,
            includes: &includes,
            input: &inputs,
            include_imports: true,
        })?;

        let mut fds = Vec::new();
        let mut file = fs::File::open(temp_file)?;
        file.read_to_end(&mut fds)?;

        drop(file);
        drop(temp_dir);

        let fds: protobuf::descriptor::FileDescriptorSet = protobuf::parse_from_bytes(&fds)
            .map_err(|e| io::Error::new(io::ErrorKind::Other, e))?;

        let mut includes = self.includes.clone();
        if includes.is_empty() {
            includes = vec![PathBuf::from(".")];
        }

        let mut files_to_generate = Vec::new();
        'outer: for file in &self.inputs {
            for include in &includes {
                if let Some(truncated) =
                    remove_path_prefix(file.to_str().unwrap(), include.to_str().unwrap())
                {
                    files_to_generate.push(truncated.to_owned());
                    continue 'outer;
                }
            }

            return Err(Error::new(
                io::ErrorKind::Other,
                format!(
                    "file {:?} is not found in includes {:?}",
                    file, self.includes
                ),
            ));
        }

        let gen_result = grpc_compiler::codegen::gen(fds.get_file(), &files_to_generate);

        for r in gen_result {
            let r: protobuf::compiler_plugin::GenResult = r;
            let file = format!("{}/{}", self.out_dir.display(), r.name);
            let mut file = fs::File::create(&file)?;
            file.write_all(&r.content)?;
            file.flush()?;
        }

        Ok(())
    }
}

fn remove_dot_slash(path: &str) -> &str {
    if path == "." {
        ""
    } else if path.starts_with("./") || path.starts_with(".\\") {
        &path[2..]
    } else {
        path
    }
}

fn remove_path_prefix<'a>(mut path: &'a str, mut prefix: &str) -> Option<&'a str> {
    path = remove_dot_slash(path);
    prefix = remove_dot_slash(prefix);

    if prefix == "" {
        return Some(path);
    }

    if prefix.ends_with("/") || prefix.ends_with("\\") {
        prefix = &prefix[..prefix.len() - 1];
    }

    if !path.starts_with(prefix) {
        return None;
    }

    if path.len() <= prefix.len() {
        return None;
    }

    if path.as_bytes()[prefix.len()] == b'/' || path.as_bytes()[prefix.len()] == b'\\' {
        return Some(&path[prefix.len() + 1..]);
    } else {
        return None;
    }
}

#[cfg(test)]
mod test {
    #[test]
    fn remove_path_prefix() {
        assert_eq!(
            Some("abc.proto"),
            super::remove_path_prefix("xxx/abc.proto", "xxx")
        );
        assert_eq!(
            Some("abc.proto"),
            super::remove_path_prefix("xxx/abc.proto", "xxx/")
        );
        assert_eq!(
            Some("abc.proto"),
            super::remove_path_prefix("../xxx/abc.proto", "../xxx/")
        );
        assert_eq!(
            Some("abc.proto"),
            super::remove_path_prefix("abc.proto", ".")
        );
        assert_eq!(
            Some("abc.proto"),
            super::remove_path_prefix("abc.proto", "./")
        );
        assert_eq!(None, super::remove_path_prefix("xxx/abc.proto", "yyy"));
        assert_eq!(None, super::remove_path_prefix("xxx/abc.proto", "yyy/"));
    }
}