clippy_lints/src/regex.rs

   1 use crate::consts::{constant, Constant};
   2 use crate::utils::{is_expn_of, match_def_path, match_type, paths, span_lint, span_lint_and_help};
   3 use if_chain::if_chain;
   4 use rustc_ast::ast::{LitKind, StrStyle};
   5 use rustc_data_structures::fx::FxHashSet;
   6 use rustc_hir::{Block, BorrowKind, Crate, Expr, ExprKind, HirId};
   7 use rustc_lint::{LateContext, LateLintPass};
   8 use rustc_session::{declare_tool_lint, impl_lint_pass};
   9 use rustc_span::source_map::{BytePos, Span};
  10 use std::convert::TryFrom;
  11
  12 declare_clippy_lint! {
  13     /// **What it does:** Checks [regex](https://crates.io/crates/regex) creation
  14     /// (with `Regex::new`,`RegexBuilder::new` or `RegexSet::new`) for correct
  15     /// regex syntax.
  16     ///
  17     /// **Why is this bad?** This will lead to a runtime panic.
  18     ///
  19     /// **Known problems:** None.
  20     ///
  21     /// **Example:**
  22     /// ```ignore
  23     /// Regex::new("|")
  24     /// ```
  25     pub INVALID_REGEX,
  26     correctness,
  27     "invalid regular expressions"
  28 }
  29
  30 declare_clippy_lint! {
  31     /// **What it does:** Checks for trivial [regex](https://crates.io/crates/regex)
  32     /// creation (with `Regex::new`, `RegexBuilder::new` or `RegexSet::new`).
  33     ///
  34     /// **Why is this bad?** Matching the regex can likely be replaced by `==` or
  35     /// `str::starts_with`, `str::ends_with` or `std::contains` or other `str`
  36     /// methods.
  37     ///
  38     /// **Known problems:** None.
  39     ///
  40     /// **Example:**
  41     /// ```ignore
  42     /// Regex::new("^foobar")
  43     /// ```
  44     pub TRIVIAL_REGEX,
  45     style,
  46     "trivial regular expressions"
  47 }
  48
  49 declare_clippy_lint! {
  50     /// **What it does:** Checks for usage of `regex!(_)` which (as of now) is
  51     /// usually slower than `Regex::new(_)` unless called in a loop (which is a bad
  52     /// idea anyway).
  53     ///
  54     /// **Why is this bad?** Performance, at least for now. The macro version is
  55     /// likely to catch up long-term, but for now the dynamic version is faster.
  56     ///
  57     /// **Known problems:** None.
  58     ///
  59     /// **Example:**
  60     /// ```ignore
  61     /// regex!("foo|bar")
  62     /// ```
  63     pub REGEX_MACRO,
  64     style,
  65     "use of `regex!(_)` instead of `Regex::new(_)`"
  66 }
  67
  68 #[derive(Clone, Default)]
  69 pub struct Regex {
  70     spans: FxHashSet<Span>,
  71     last: Option<HirId>,
  72 }
  73
  74 impl_lint_pass!(Regex => [INVALID_REGEX, REGEX_MACRO, TRIVIAL_REGEX]);
  75
  76 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Regex {
  77     fn check_crate(&mut self, _: &LateContext<'a, 'tcx>, _: &'tcx Crate<'_>) {
  78         self.spans.clear();
  79     }
  80
  81     fn check_block(&mut self, cx: &LateContext<'a, 'tcx>, block: &'tcx Block<'_>) {
  82         if_chain! {
  83             if self.last.is_none();
  84             if let Some(ref expr) = block.expr;
  85             if match_type(cx, cx.tables.expr_ty(expr), &paths::REGEX);
  86             if let Some(span) = is_expn_of(expr.span, "regex");
  87             then {
  88                 if !self.spans.contains(&span) {
  89                     span_lint(cx,
  90                               REGEX_MACRO,
  91                               span,
  92                               "`regex!(_)` found. \
  93                               Please use `Regex::new(_)`, which is faster for now.");
  94                     self.spans.insert(span);
  95                 }
  96                 self.last = Some(block.hir_id);
  97             }
  98         }
  99     }
 100
 101     fn check_block_post(&mut self, _: &LateContext<'a, 'tcx>, block: &'tcx Block<'_>) {
 102         if self.last.map_or(false, |id| block.hir_id == id) {
 103             self.last = None;
 104         }
 105     }
 106
 107     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) {
 108         if_chain! {
 109             if let ExprKind::Call(ref fun, ref args) = expr.kind;
 110             if let ExprKind::Path(ref qpath) = fun.kind;
 111             if args.len() == 1;
 112             if let Some(def_id) = cx.tables.qpath_res(qpath, fun.hir_id).opt_def_id();
 113             then {
 114                 if match_def_path(cx, def_id, &paths::REGEX_NEW) ||
 115                    match_def_path(cx, def_id, &paths::REGEX_BUILDER_NEW) {
 116                     check_regex(cx, &args[0], true);
 117                 } else if match_def_path(cx, def_id, &paths::REGEX_BYTES_NEW) ||
 118                    match_def_path(cx, def_id, &paths::REGEX_BYTES_BUILDER_NEW) {
 119                     check_regex(cx, &args[0], false);
 120                 } else if match_def_path(cx, def_id, &paths::REGEX_SET_NEW) {
 121                     check_set(cx, &args[0], true);
 122                 } else if match_def_path(cx, def_id, &paths::REGEX_BYTES_SET_NEW) {
 123                     check_set(cx, &args[0], false);
 124                 }
 125             }
 126         }
 127     }
 128 }
 129
 130 #[allow(clippy::cast_possible_truncation)] // truncation very unlikely here
 131 #[must_use]
 132 fn str_span(base: Span, c: regex_syntax::ast::Span, offset: u16) -> Span {
 133     let offset = u32::from(offset);
 134     let end = base.lo() + BytePos(u32::try_from(c.end.offset).expect("offset too large") + offset);
 135     let start = base.lo() + BytePos(u32::try_from(c.start.offset).expect("offset too large") + offset);
 136     assert!(start <= end);
 137     Span::new(start, end, base.ctxt())
 138 }
 139
 140 fn const_str<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, e: &'tcx Expr<'_>) -> Option<String> {
 141     constant(cx, cx.tables, e).and_then(|(c, _)| match c {
 142         Constant::Str(s) => Some(s),
 143         _ => None,
 144     })
 145 }
 146
 147 fn is_trivial_regex(s: &regex_syntax::hir::Hir) -> Option<&'static str> {
 148     use regex_syntax::hir::Anchor::{EndText, StartText};
 149     use regex_syntax::hir::HirKind::{Alternation, Anchor, Concat, Empty, Literal};
 150
 151     let is_literal = |e: &[regex_syntax::hir::Hir]| {
 152         e.iter().all(|e| match *e.kind() {
 153             Literal(_) => true,
 154             _ => false,
 155         })
 156     };
 157
 158     match *s.kind() {
 159         Empty | Anchor(_) => Some("the regex is unlikely to be useful as it is"),
 160         Literal(_) => Some("consider using `str::contains`"),
 161         Alternation(ref exprs) => {
 162             if exprs.iter().all(|e| e.kind().is_empty()) {
 163                 Some("the regex is unlikely to be useful as it is")
 164             } else {
 165                 None
 166             }
 167         },
 168         Concat(ref exprs) => match (exprs[0].kind(), exprs[exprs.len() - 1].kind()) {
 169             (&Anchor(StartText), &Anchor(EndText)) if exprs[1..(exprs.len() - 1)].is_empty() => {
 170                 Some("consider using `str::is_empty`")
 171             },
 172             (&Anchor(StartText), &Anchor(EndText)) if is_literal(&exprs[1..(exprs.len() - 1)]) => {
 173                 Some("consider using `==` on `str`s")
 174             },
 175             (&Anchor(StartText), &Literal(_)) if is_literal(&exprs[1..]) => Some("consider using `str::starts_with`"),
 176             (&Literal(_), &Anchor(EndText)) if is_literal(&exprs[1..(exprs.len() - 1)]) => {
 177                 Some("consider using `str::ends_with`")
 178             },
 179             _ if is_literal(exprs) => Some("consider using `str::contains`"),
 180             _ => None,
 181         },
 182         _ => None,
 183     }
 184 }
 185
 186 fn check_set<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>, utf8: bool) {
 187     if_chain! {
 188         if let ExprKind::AddrOf(BorrowKind::Ref, _, ref expr) = expr.kind;
 189         if let ExprKind::Array(exprs) = expr.kind;
 190         then {
 191             for expr in exprs {
 192                 check_regex(cx, expr, utf8);
 193             }
 194         }
 195     }
 196 }
 197
 198 fn check_regex<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>, utf8: bool) {
 199     let mut parser = regex_syntax::ParserBuilder::new()
 200         .unicode(utf8)
 201         .allow_invalid_utf8(!utf8)
 202         .build();
 203
 204     if let ExprKind::Lit(ref lit) = expr.kind {
 205         if let LitKind::Str(ref r, style) = lit.node {
 206             let r = &r.as_str();
 207             let offset = if let StrStyle::Raw(n) = style { 2 + n } else { 1 };
 208             match parser.parse(r) {
 209                 Ok(r) => {
 210                     if let Some(repl) = is_trivial_regex(&r) {
 211                         span_lint_and_help(cx, TRIVIAL_REGEX, expr.span, "trivial regex", repl);
 212                     }
 213                 },
 214                 Err(regex_syntax::Error::Parse(e)) => {
 215                     span_lint(
 216                         cx,
 217                         INVALID_REGEX,
 218                         str_span(expr.span, *e.span(), offset),
 219                         &format!("regex syntax error: {}", e.kind()),
 220                     );
 221                 },
 222                 Err(regex_syntax::Error::Translate(e)) => {
 223                     span_lint(
 224                         cx,
 225                         INVALID_REGEX,
 226                         str_span(expr.span, *e.span(), offset),
 227                         &format!("regex syntax error: {}", e.kind()),
 228                     );
 229                 },
 230                 Err(e) => {
 231                     span_lint(cx, INVALID_REGEX, expr.span, &format!("regex syntax error: {}", e));
 232                 },
 233             }
 234         }
 235     } else if let Some(r) = const_str(cx, expr) {
 236         match parser.parse(&r) {
 237             Ok(r) => {
 238                 if let Some(repl) = is_trivial_regex(&r) {
 239                     span_lint_and_help(cx, TRIVIAL_REGEX, expr.span, "trivial regex", repl);
 240                 }
 241             },
 242             Err(regex_syntax::Error::Parse(e)) => {
 243                 span_lint(
 244                     cx,
 245                     INVALID_REGEX,
 246                     expr.span,
 247                     &format!("regex syntax error on position {}: {}", e.span().start.offset, e.kind()),
 248                 );
 249             },
 250             Err(regex_syntax::Error::Translate(e)) => {
 251                 span_lint(
 252                     cx,
 253                     INVALID_REGEX,
 254                     expr.span,
 255                     &format!("regex syntax error on position {}: {}", e.span().start.offset, e.kind()),
 256                 );
 257             },
 258             Err(e) => {
 259                 span_lint(cx, INVALID_REGEX, expr.span, &format!("regex syntax error: {}", e));
 260             },
 261         }
 262     }
 263 }