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 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
//! Interfaces for customizing resolution of protobuf source files.
mod chain;
mod descriptor_set;
mod google;
mod include;
#[cfg(test)]
mod tests;
pub use chain::ChainFileResolver;
pub use descriptor_set::DescriptorSetFileResolver;
pub use google::GoogleFileResolver;
pub use include::IncludeFileResolver;
use prost_types::FileDescriptorProto;
use std::{
fs,
io::{self, Read},
path::{Path, PathBuf},
};
use bytes::{Buf, Bytes};
pub(crate) use include::{check_shadow, path_to_file_name};
use prost::{DecodeError, Message};
use crate::error::{Error, ErrorKind};
const MAX_FILE_LEN: u64 = i32::MAX as u64;
/// A strategy for locating protobuf source files.
///
/// The main implementation is [`IncludeFileResolver`] which uses the file system, but
/// this trait allows sourcing files from other places as well.
pub trait FileResolver {
/// Converts a file system path to a unique file name.
fn resolve_path(&self, _path: &Path) -> Option<String> {
None
}
/// Opens a file by its unique name.
///
/// # Errors
///
/// If the file is not found, the implementation should return [`Error::file_not_found`].
fn open_file(&self, name: &str) -> Result<File, Error>;
}
impl<T> FileResolver for Box<T>
where
T: FileResolver + ?Sized,
{
fn resolve_path(&self, path: &Path) -> Option<String> {
(**self).resolve_path(path)
}
fn open_file(&self, name: &str) -> Result<File, Error> {
(**self).open_file(name)
}
}
/// An opened protobuf source file, returned by [`FileResolver::open_file`].
#[derive(Debug, Clone)]
pub struct File {
pub(crate) path: Option<PathBuf>,
pub(crate) source: Option<String>,
pub(crate) descriptor: FileDescriptorProto,
pub(crate) encoded: Option<Bytes>,
}
/// Information about a [`File`] after it has been added to a [`Compiler`](crate::Compiler) instance.
#[derive(Debug, Clone)]
pub struct FileMetadata {
pub(crate) name: String,
pub(crate) path: Option<PathBuf>,
pub(crate) is_import: bool,
}
impl File {
/// Read a protobuf source file from the filesystem into a new instance of [`File`]
///
/// # Errors
///
/// Returns an error if there is an IO error opening the file, or it is not
/// a valid protobuf source file.
///
/// If the file does not exist, [`Error::file_not_found()`] is returned
///
/// # Examples
///
/// ```
/// # use std::{fs, path::PathBuf};
/// # use protox::file::File;
/// # use prost_types::{DescriptorProto, FileDescriptorProto, SourceCodeInfo, source_code_info::Location};
/// # let tempdir = tempfile::TempDir::new().unwrap();
/// # std::env::set_current_dir(&tempdir).unwrap();
/// fs::write("foo.proto", "message Foo { }").unwrap();
///
/// let file = File::open("foo.proto", "foo.proto".as_ref()).unwrap();
/// assert_eq!(file.path(), Some("foo.proto".as_ref()));
/// assert_eq!(file.source(), Some("message Foo { }"));
/// assert_eq!(file.file_descriptor_proto(), &FileDescriptorProto {
/// name: Some("foo.proto".to_owned()),
/// message_type: vec![DescriptorProto {
/// name: Some("Foo".to_owned()),
/// ..Default::default()
/// }],
/// source_code_info: Some(SourceCodeInfo {
/// location: vec![
/// Location { path: vec![], span: vec![0, 0, 15], ..Default::default() },
/// Location { path: vec![4, 0], span: vec![0, 0, 15], ..Default::default() },
/// Location { path: vec![4, 0, 1], span: vec![0, 8, 11], ..Default::default() }
/// ]
/// }),
/// ..Default::default()
/// });
///
/// assert!(File::open("notfound.proto", "notfound.proto".as_ref()).unwrap_err().is_file_not_found());
/// ```
pub fn open(name: &str, path: &Path) -> Result<Self, Error> {
let map_io_err = |err: io::Error| -> Error {
match err.kind() {
io::ErrorKind::NotFound => Error::file_not_found(name),
io::ErrorKind::InvalidData => Error::from_kind(ErrorKind::FileInvalidUtf8 {
name: name.to_owned(),
}),
_ => Error::from_kind(ErrorKind::OpenFile {
name: name.to_owned(),
path: path.to_owned(),
err,
}),
}
};
let file = fs::File::open(path).map_err(map_io_err)?;
let metadata = file.metadata().map_err(map_io_err)?;
if metadata.len() > MAX_FILE_LEN {
return Err(Error::from_kind(ErrorKind::FileTooLarge {
name: name.to_owned(),
}));
}
let mut buf = String::with_capacity(metadata.len() as usize);
file.take(MAX_FILE_LEN)
.read_to_string(&mut buf)
.map_err(map_io_err)?;
let descriptor = protox_parse::parse(name, &buf)?;
Ok(File {
path: Some(path.to_owned()),
source: Some(buf),
descriptor,
encoded: None,
})
}
/// Read a protobuf source file from a string into a new instance of [`File`]
///
/// # Errors
///
/// Returns an error the string is not a valid protobuf source file.
///
/// # Examples
///
/// ```
/// # use std::{fs, path::PathBuf};
/// # use protox::file::File;
/// # use prost_types::{DescriptorProto, FileDescriptorProto, SourceCodeInfo, source_code_info::Location};
/// let file = File::from_source("foo.proto", "message Foo { }").unwrap();
/// assert_eq!(file.path(), None);
/// assert_eq!(file.source(), Some("message Foo { }"));
/// assert_eq!(file.file_descriptor_proto(), &FileDescriptorProto {
/// name: Some("foo.proto".to_owned()),
/// message_type: vec![DescriptorProto {
/// name: Some("Foo".to_owned()),
/// ..Default::default()
/// }],
/// source_code_info: Some(SourceCodeInfo {
/// location: vec![
/// Location { path: vec![], span: vec![0, 0, 15], ..Default::default() },
/// Location { path: vec![4, 0], span: vec![0, 0, 15], ..Default::default() },
/// Location { path: vec![4, 0, 1], span: vec![0, 8, 11], ..Default::default() }
/// ]
/// }),
/// ..Default::default()
/// });
/// ```
pub fn from_source(name: &str, source: &str) -> Result<Self, Error> {
let descriptor = protox_parse::parse(name, source)?;
Ok(File {
path: None,
source: Some(source.to_owned()),
descriptor,
encoded: None,
})
}
/// Create a new instance of [`File`] from a parsed [`FileDescriptorProto`].
///
/// The file does not need to have type names or imports resolved. Typically, it would be returned by the [`parse()`](protox_parse::parse()) method.
pub fn from_file_descriptor_proto(file: prost_types::FileDescriptorProto) -> Self {
File {
path: None,
source: None,
descriptor: file,
encoded: None,
}
}
/// Create an instance of [`File`] by deserializing a [`FileDescriptorProto`]
/// from the given bytes.
///
/// Unlike when going through [`from_file_descriptor_proto()`](File::from_file_descriptor_proto), extension options are preserved.
///
/// The file does not need to have type names or imports resolved.
pub fn decode_file_descriptor_proto<B>(mut buf: B) -> Result<Self, DecodeError>
where
B: Buf,
{
let encoded = buf.copy_to_bytes(buf.remaining());
Ok(File {
path: None,
source: None,
descriptor: FileDescriptorProto::decode(encoded.as_ref())?,
encoded: Some(encoded),
})
}
/// Returns the name of this file.
pub fn name(&self) -> &str {
self.descriptor.name()
}
/// Returns the filesystem path, if this source is backed by a physical file.
pub fn path(&self) -> Option<&Path> {
self.path.as_deref()
}
/// Returns the full content of the source file if available.
pub fn source(&self) -> Option<&str> {
self.source.as_deref()
}
/// Returns the parsed value of the source file.
///
/// This is typically equivalent to calling [`parse()`](protox_parse::parse()) on the string returned by [`source()`](File::source).
pub fn file_descriptor_proto(&self) -> &FileDescriptorProto {
&self.descriptor
}
}
impl FileMetadata {
/// Returns the name of this file.
pub fn name(&self) -> &str {
self.name.as_str()
}
/// Returns the filesystem path, if this source is backed by a physical file.
pub fn path(&self) -> Option<&Path> {
self.path.as_deref()
}
/// Returns `true` if this file was added explicitly by [`open_file()`](crate::Compiler::open_file), or `false` if it
/// is was added as an import of some other file.
pub fn is_import(&self) -> bool {
self.is_import
}
}
impl From<FileDescriptorProto> for File {
fn from(file: FileDescriptorProto) -> Self {
File::from_file_descriptor_proto(file)
}
}
impl From<File> for FileDescriptorProto {
fn from(file: File) -> Self {
file.descriptor
}
}