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
use crate::{thread, Buffer, Priority, Record, TagMode};
use env_logger::filter::{Builder, Filter};
use log::{LevelFilter, Log, Metadata};
use parking_lot::RwLock;
use std::{io, process, sync::Arc, time::SystemTime};
/// Logger configuration.
pub(crate) struct Configuration {
pub(crate) filter: Filter,
pub(crate) tag: TagMode,
pub(crate) prepend_module: bool,
#[allow(unused)]
pub(crate) pstore: bool,
pub(crate) buffer_id: Buffer,
}
/// Logger configuration handler stores access to logger configuration parameters.
#[derive(Clone)]
pub struct Logger {
pub(crate) configuration: Arc<RwLock<Configuration>>,
}
impl Logger {
/// Sets buffer parameter of logger configuration
///
/// # Examples
///
/// ```
/// # use log::LevelFilter;
/// # use android_logd_logger::{Builder, Buffer};
///
/// let logger = android_logd_logger::builder().init();
///
/// logger.buffer(Buffer::Crash);
/// ```
pub fn buffer(&self, buffer: Buffer) -> &Self {
self.configuration.write().buffer_id = buffer;
self
}
// Sets tag parameter of logger configuration to custom value
///
/// # Examples
///
/// ```
/// # use log::LevelFilter;
/// # use android_logd_logger::Builder;
///
/// let logger = android_logd_logger::builder().init();
///
/// logger.tag("foo");
/// ```
pub fn tag(&self, tag: &str) -> &Self {
self.configuration.write().tag = TagMode::Custom(tag.into());
self
}
/// Sets tag parameter of logger configuration to target value
///
/// # Examples
///
/// ```
/// # use log::LevelFilter;
/// # use android_logd_logger::Builder;
///
/// let logger = android_logd_logger::builder().init();
///
/// logger.tag_target();
/// ```
pub fn tag_target(&self) -> &Self {
self.configuration.write().tag = TagMode::Target;
self
}
/// Sets tag parameter of logger configuration to strip value
///
/// # Examples
///
/// ```
/// # use log::LevelFilter;
/// # use android_logd_logger::Builder;
///
/// let logger = android_logd_logger::builder().init();
///
/// logger.tag_target_strip();
/// ```
pub fn tag_target_strip(&self) -> &Self {
self.configuration.write().tag = TagMode::TargetStrip;
self
}
/// Sets prepend module parameter of logger configuration
///
/// # Examples
///
/// ```
/// # use log::LevelFilter;
/// # use android_logd_logger::Builder;
///
/// let logger = android_logd_logger::builder().init();
///
/// logger.prepend_module(true);
/// ```
pub fn prepend_module(&self, prepend_module: bool) -> &Self {
self.configuration.write().prepend_module = prepend_module;
self
}
/// Adds a directive to the filter for a specific module.
///
/// # Examples
///
/// Only include messages for warning and above for logs in `path::to::module`:
///
/// ```
/// # use log::LevelFilter;
/// # use android_logd_logger::Builder;
///
/// let logger = android_logd_logger::builder().init();
///
/// logger.filter_module("path::to::module", LevelFilter::Info);
/// ```
pub fn filter_module(&self, module: &str, level: LevelFilter) -> &Self {
self.configuration.write().filter = Builder::default().filter_module(module, level).build();
self
}
/// Adjust filter.
///
/// # Examples
///
/// Only include messages for warning and above.
///
/// ```
/// # use log::LevelFilter;
/// # use android_logd_logger::Builder;
///
/// let logger = Builder::new().init();
/// logger.filter_level(LevelFilter::Info);
/// ```
pub fn filter_level(&self, level: LevelFilter) -> &Self {
self.configuration.write().filter = Builder::default().filter_level(level).build();
self
}
/// Adjust filter.
///
/// The given module (if any) will log at most the specified level provided.
/// If no module is provided then the filter will apply to all log messages.
///
/// # Examples
///
/// Only include messages for warning and above for logs in `path::to::module`:
///
/// ```
/// # use log::LevelFilter;
/// # use android_logd_logger::Builder;
///
/// let logger = Builder::new().init();
/// logger.filter(Some("path::to::module"), LevelFilter::Info);
/// ```
pub fn filter(&self, module: Option<&str>, level: LevelFilter) -> &Self {
self.configuration.write().filter = Builder::default().filter(module, level).build();
self
}
/// Parses the directives string in the same form as the `RUST_LOG`
/// environment variable.
///
/// See the module documentation for more details.
pub fn parse_filters(&mut self, filters: &str) -> &mut Self {
self.configuration.write().filter = Builder::default().parse(filters).build();
self
}
/// Sets filter parameter of logger configuration
///
/// # Examples
///
/// ```
/// # use log::LevelFilter;
/// # use android_logd_logger::Builder;
///
/// let logger = android_logd_logger::builder().init();
///
/// logger.pstore(true);
/// ```
#[cfg(target_os = "android")]
pub fn pstore(&self, pstore: bool) -> &Self {
self.configuration.write().pstore = pstore;
self
}
}
/// Logger implementation.
pub(crate) struct LoggerImpl {
configuration: Arc<RwLock<Configuration>>,
}
impl LoggerImpl {
pub fn new(configuration: Arc<RwLock<Configuration>>) -> Result<LoggerImpl, io::Error> {
Ok(LoggerImpl { configuration })
}
}
impl Log for LoggerImpl {
fn enabled(&self, metadata: &Metadata) -> bool {
self.configuration.read().filter.enabled(metadata)
}
fn log(&self, record: &log::Record) {
let configuration = self.configuration.read();
if !configuration.filter.matches(record) {
return;
}
let args = record.args().to_string();
let message = if let Some(module_path) = record.module_path() {
if configuration.prepend_module {
[module_path, &args].join(": ")
} else {
args
}
} else {
args
};
let priority: Priority = record.metadata().level().into();
let tag = match &configuration.tag {
TagMode::Target => record.target(),
TagMode::TargetStrip => record
.target()
.split_once("::")
.map(|(tag, _)| tag)
.unwrap_or_else(|| record.target()),
TagMode::Custom(tag) => tag.as_str(),
};
let timestamp = SystemTime::now();
let record = Record {
timestamp,
pid: process::id() as u16,
thread_id: thread::id() as u16,
buffer_id: configuration.buffer_id,
tag,
priority,
message: &message,
};
crate::log_record(&record).ok();
#[cfg(target_os = "android")]
{
if configuration.pstore {
crate::pmsg::log(&record);
}
}
}
#[cfg(not(target_os = "android"))]
fn flush(&self) {
use std::io::Write;
io::stderr().flush().ok();
}
#[cfg(target_os = "android")]
fn flush(&self) {
if self.configuration.read().pstore {
crate::pmsg::flush().ok();
}
}
}