use rustc_data_structures::fx::FxHashMap; use clippy_utils::diagnostics::{span_lint, span_lint_and_then}; use clippy_utils::ty::{is_type_diagnostic_item, match_type}; use clippy_utils::{match_any_def_paths, paths}; use rustc_ast::ast::LitKind; use rustc_hir::{Expr, ExprKind}; use rustc_lint::LateContext; use rustc_middle::ty::Ty; use rustc_span::source_map::Spanned; use rustc_span::{Span, sym}; use super::{NONSENSICAL_OPEN_OPTIONS, SUSPICIOUS_OPEN_OPTIONS}; fn is_open_options(cx: &LateContext<'_>, ty: Ty<'_>) -> bool { is_type_diagnostic_item(cx, ty, sym::FsOpenOptions) || match_type(cx, ty, &paths::TOKIO_IO_OPEN_OPTIONS) } pub(super) fn check<'tcx>(cx: &LateContext<'tcx>, e: &'tcx Expr<'_>, recv: &'tcx Expr<'_>) { if let Some(method_id) = cx.typeck_results().type_dependent_def_id(e.hir_id) && let Some(impl_id) = cx.tcx.impl_of_method(method_id) && is_open_options(cx, cx.tcx.type_of(impl_id).instantiate_identity()) { let mut options = Vec::new(); if get_open_options(cx, recv, &mut options) { check_open_options(cx, &options, e.span); } } } #[derive(Eq, PartialEq, Clone, Debug)] enum Argument { Set(bool), Unknown, } #[derive(Debug, Eq, PartialEq, Hash, Clone)] enum OpenOption { Append, Create, CreateNew, Read, Truncate, Write, } impl std::fmt::Display for OpenOption { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { OpenOption::Append => write!(f, "append"), OpenOption::Create => write!(f, "create"), OpenOption::CreateNew => write!(f, "create_new"), OpenOption::Read => write!(f, "read"), OpenOption::Truncate => write!(f, "truncate"), OpenOption::Write => write!(f, "write"), } } } /// Collects information about a method call chain on `OpenOptions`. /// Returns false if an unexpected expression kind was found "on the way", /// and linting should then be avoided. fn get_open_options( cx: &LateContext<'_>, argument: &Expr<'_>, options: &mut Vec<(OpenOption, Argument, Span)>, ) -> bool { if let ExprKind::MethodCall(path, receiver, arguments, span) = argument.kind { let obj_ty = cx.typeck_results().expr_ty(receiver).peel_refs(); // Only proceed if this is a call on some object of type std::fs::OpenOptions if !arguments.is_empty() && is_open_options(cx, obj_ty) { let argument_option = match arguments[0].kind { ExprKind::Lit(span) => { if let Spanned { node: LitKind::Bool(lit), .. } = span { Argument::Set(*lit) } else { // The function is called with a literal which is not a boolean literal. // This is theoretically possible, but not very likely. // We'll ignore it for now return get_open_options(cx, receiver, options); } }, _ => Argument::Unknown, }; match path.ident.as_str() { "create" => { options.push((OpenOption::Create, argument_option, span)); }, "create_new" => { options.push((OpenOption::CreateNew, argument_option, span)); }, "append" => { options.push((OpenOption::Append, argument_option, span)); }, "truncate" => { options.push((OpenOption::Truncate, argument_option, span)); }, "read" => { options.push((OpenOption::Read, argument_option, span)); }, "write" => { options.push((OpenOption::Write, argument_option, span)); }, _ => { // Avoid linting altogether if this method is from a trait. // This might be a user defined extension trait with a method like `truncate_write` // which would be a false positive if let Some(method_def_id) = cx.typeck_results().type_dependent_def_id(argument.hir_id) && cx.tcx.trait_of_item(method_def_id).is_some() { return false; } }, } get_open_options(cx, receiver, options) } else { false } } else if let ExprKind::Call(callee, _) = argument.kind && let ExprKind::Path(path) = callee.kind && let Some(did) = cx.qpath_res(&path, callee.hir_id).opt_def_id() { let std_file_options = [sym::file_options, sym::open_options_new]; let tokio_file_options: &[&[&str]] = &[&paths::TOKIO_IO_OPEN_OPTIONS_NEW, &paths::TOKIO_FILE_OPTIONS]; let is_std_options = std_file_options .into_iter() .any(|sym| cx.tcx.is_diagnostic_item(sym, did)); is_std_options || match_any_def_paths(cx, did, tokio_file_options).is_some() } else { false } } fn check_open_options(cx: &LateContext<'_>, settings: &[(OpenOption, Argument, Span)], span: Span) { // The args passed to these methods, if they have been called let mut options = FxHashMap::default(); for (option, arg, sp) in settings { if let Some((_, prev_span)) = options.insert(option.clone(), (arg.clone(), *sp)) { span_lint( cx, NONSENSICAL_OPEN_OPTIONS, prev_span, format!("the method `{option}` is called more than once"), ); } } if let Some((Argument::Set(true), _)) = options.get(&OpenOption::Read) && let Some((Argument::Set(true), _)) = options.get(&OpenOption::Truncate) && let None | Some((Argument::Set(false), _)) = options.get(&OpenOption::Write) { span_lint( cx, NONSENSICAL_OPEN_OPTIONS, span, "file opened with `truncate` and `read`", ); } if let Some((Argument::Set(true), _)) = options.get(&OpenOption::Append) && let Some((Argument::Set(true), _)) = options.get(&OpenOption::Truncate) { span_lint( cx, NONSENSICAL_OPEN_OPTIONS, span, "file opened with `append` and `truncate`", ); } if let Some((Argument::Set(true), create_span)) = options.get(&OpenOption::Create) && let None = options.get(&OpenOption::Truncate) && let None | Some((Argument::Set(false), _)) = options.get(&OpenOption::Append) { span_lint_and_then( cx, SUSPICIOUS_OPEN_OPTIONS, *create_span, "file opened with `create`, but `truncate` behavior not defined", |diag| { diag.span_suggestion( create_span.shrink_to_hi(), "add", ".truncate(true)".to_string(), rustc_errors::Applicability::MaybeIncorrect, ) .help("if you intend to overwrite an existing file entirely, call `.truncate(true)`") .help( "if you instead know that you may want to keep some parts of the old file, call `.truncate(false)`", ) .help("alternatively, use `.append(true)` to append to the file instead of overwriting it"); }, ); } }