-
Notifications
You must be signed in to change notification settings - Fork 462
/
DoNotPassLiteralsAsLocalizedParameters.cs
380 lines (326 loc) · 20.2 KB
/
DoNotPassLiteralsAsLocalizedParameters.cs
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
// Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Linq;
using System.Text;
using Analyzer.Utilities;
using Analyzer.Utilities.Extensions;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Diagnostics;
using Microsoft.CodeAnalysis.Operations;
using Microsoft.CodeAnalysis.FlowAnalysis.DataFlow;
using Microsoft.CodeAnalysis.FlowAnalysis.DataFlow.ValueContentAnalysis;
using Analyzer.Utilities.PooledObjects;
namespace Microsoft.NetCore.Analyzers.Runtime
{
/// <summary>
/// CA1303: Do not pass literals as localized parameters
/// A method passes a string literal as a parameter to a constructor or method in the .NET Framework class library and that string should be localizable.
/// This warning is raised when a literal string is passed as a value to a parameter or property and one or more of the following cases is true:
/// 1. The LocalizableAttribute attribute of the parameter or property is set to true.
/// 2. The parameter or property name contains "Text", "Message", or "Caption".
/// 3. The name of the string parameter that is passed to a Console.Write or Console.WriteLine method is either "value" or "format".
/// </summary>
[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)]
public sealed class DoNotPassLiteralsAsLocalizedParameters : DiagnosticAnalyzer
{
internal const string RuleId = "CA1303";
private static readonly LocalizableString s_localizableTitle = new LocalizableResourceString(nameof(MicrosoftNetCoreAnalyzersResources.DoNotPassLiteralsAsLocalizedParametersTitle), MicrosoftNetCoreAnalyzersResources.ResourceManager, typeof(MicrosoftNetCoreAnalyzersResources));
private static readonly LocalizableString s_localizableMessage = new LocalizableResourceString(nameof(MicrosoftNetCoreAnalyzersResources.DoNotPassLiteralsAsLocalizedParametersMessage), MicrosoftNetCoreAnalyzersResources.ResourceManager, typeof(MicrosoftNetCoreAnalyzersResources));
private static readonly LocalizableString s_localizableDescription = new LocalizableResourceString(nameof(MicrosoftNetCoreAnalyzersResources.DoNotPassLiteralsAsLocalizedParametersDescription), MicrosoftNetCoreAnalyzersResources.ResourceManager, typeof(MicrosoftNetCoreAnalyzersResources));
internal static DiagnosticDescriptor Rule = DiagnosticDescriptorHelper.Create(RuleId,
s_localizableTitle,
s_localizableMessage,
DiagnosticCategory.Globalization,
RuleLevel.Disabled,
description: s_localizableDescription,
isPortedFxCopRule: true,
isDataflowRule: true);
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);
public override void Initialize(AnalysisContext context)
{
context.EnableConcurrentExecution();
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
context.RegisterCompilationStartAction(compilationContext =>
{
INamedTypeSymbol? localizableStateAttributeSymbol = compilationContext.Compilation.GetOrCreateTypeByMetadataName(WellKnownTypeNames.SystemComponentModelLocalizableAttribute);
INamedTypeSymbol? conditionalAttributeSymbol = compilationContext.Compilation.GetOrCreateTypeByMetadataName(WellKnownTypeNames.SystemDiagnosticsConditionalAttribute);
INamedTypeSymbol? systemConsoleSymbol = compilationContext.Compilation.GetOrCreateTypeByMetadataName(WellKnownTypeNames.SystemConsole);
ImmutableHashSet<INamedTypeSymbol> typesToIgnore = GetTypesToIgnore(compilationContext.Compilation);
compilationContext.RegisterOperationBlockStartAction(operationBlockStartContext =>
{
if (!(operationBlockStartContext.OwningSymbol is IMethodSymbol containingMethod) ||
containingMethod.IsConfiguredToSkipAnalysis(operationBlockStartContext.Options,
Rule, operationBlockStartContext.Compilation, operationBlockStartContext.CancellationToken))
{
return;
}
Lazy<DataFlowAnalysisResult<ValueContentBlockAnalysisResult, ValueContentAbstractValue>?> lazyValueContentResult = new Lazy<DataFlowAnalysisResult<ValueContentBlockAnalysisResult, ValueContentAbstractValue>?>(
valueFactory: ComputeValueContentAnalysisResult, isThreadSafe: false);
operationBlockStartContext.RegisterOperationAction(operationContext =>
{
var argument = (IArgumentOperation)operationContext.Operation;
IMethodSymbol? targetMethod = null;
switch (argument.Parent)
{
case IInvocationOperation invocation:
targetMethod = invocation.TargetMethod;
break;
case IObjectCreationOperation objectCreation:
targetMethod = objectCreation.Constructor;
break;
}
if (ShouldAnalyze(targetMethod))
{
AnalyzeArgument(argument.Parameter, containingPropertySymbolOpt: null, operation: argument, reportDiagnostic: operationContext.ReportDiagnostic);
}
}, OperationKind.Argument);
operationBlockStartContext.RegisterOperationAction(operationContext =>
{
var propertyReference = (IPropertyReferenceOperation)operationContext.Operation;
if (propertyReference.Parent is IAssignmentOperation assignment &&
assignment.Target == propertyReference &&
!propertyReference.Property.IsIndexer &&
propertyReference.Property.SetMethod?.Parameters.Length == 1 &&
ShouldAnalyze(propertyReference.Property))
{
IParameterSymbol valueSetterParam = propertyReference.Property.SetMethod.Parameters[0];
AnalyzeArgument(valueSetterParam, propertyReference.Property, assignment, operationContext.ReportDiagnostic);
}
}, OperationKind.PropertyReference);
return;
// Local functions
bool ShouldAnalyze(ISymbol? symbol)
=> symbol != null && !symbol.IsConfiguredToSkipAnalysis(operationBlockStartContext.Options, Rule, operationBlockStartContext.Compilation, operationBlockStartContext.CancellationToken);
void AnalyzeArgument(IParameterSymbol parameter, IPropertySymbol? containingPropertySymbolOpt, IOperation operation, Action<Diagnostic> reportDiagnostic)
{
if (ShouldBeLocalized(parameter.OriginalDefinition, containingPropertySymbolOpt?.OriginalDefinition, localizableStateAttributeSymbol, conditionalAttributeSymbol, systemConsoleSymbol, typesToIgnore) &&
lazyValueContentResult.Value != null)
{
ValueContentAbstractValue stringContentValue = lazyValueContentResult.Value[operation.Kind, operation.Syntax];
if (stringContentValue.IsLiteralState)
{
Debug.Assert(stringContentValue.LiteralValues.Count > 0);
if (stringContentValue.LiteralValues.Any(l => !(l is string)))
{
return;
}
var stringLiteralValues = stringContentValue.LiteralValues.Cast<string?>();
// FxCop compat: Do not fire if the literal value came from a default parameter value
if (stringContentValue.LiteralValues.Count == 1 &&
parameter.IsOptional &&
parameter.ExplicitDefaultValue is string defaultValue &&
defaultValue == stringLiteralValues.Single())
{
return;
}
// FxCop compat: Do not fire if none of the string literals have any non-control character.
if (!LiteralValuesHaveNonControlCharacters(stringLiteralValues))
{
return;
}
// FxCop compat: Filter out xml string literals.
IEnumerable<string> filteredStrings = stringLiteralValues.Where(literal => literal != null && !LooksLikeXmlTag(literal))!;
if (filteredStrings.Any())
{
// Method '{0}' passes a literal string as parameter '{1}' of a call to '{2}'. Retrieve the following string(s) from a resource table instead: "{3}".
var arg1 = containingMethod.ToDisplayString(SymbolDisplayFormat.MinimallyQualifiedFormat);
var arg2 = parameter.Name;
var arg3 = parameter.ContainingSymbol.ToDisplayString(SymbolDisplayFormat.MinimallyQualifiedFormat);
var arg4 = FormatLiteralValues(filteredStrings);
var diagnostic = operation.CreateDiagnostic(Rule, arg1, arg2, arg3, arg4);
reportDiagnostic(diagnostic);
}
}
}
}
DataFlowAnalysisResult<ValueContentBlockAnalysisResult, ValueContentAbstractValue>? ComputeValueContentAnalysisResult()
{
var cfg = operationBlockStartContext.OperationBlocks.GetControlFlowGraph();
if (cfg != null)
{
var wellKnownTypeProvider = WellKnownTypeProvider.GetOrCreate(operationBlockStartContext.Compilation);
return ValueContentAnalysis.TryGetOrComputeResult(cfg, containingMethod, wellKnownTypeProvider,
operationBlockStartContext.Options, Rule, operationBlockStartContext.CancellationToken);
}
return null;
}
});
});
}
private static ImmutableHashSet<INamedTypeSymbol> GetTypesToIgnore(Compilation compilation)
{
var builder = PooledHashSet<INamedTypeSymbol>.GetInstance();
var xmlWriter = compilation.GetOrCreateTypeByMetadataName(WellKnownTypeNames.SystemXmlXmlWriter);
if (xmlWriter != null)
{
builder.Add(xmlWriter);
}
var webUILiteralControl = compilation.GetOrCreateTypeByMetadataName(WellKnownTypeNames.SystemWebUILiteralControl);
if (webUILiteralControl != null)
{
builder.Add(webUILiteralControl);
}
var unitTestingAssert = compilation.GetOrCreateTypeByMetadataName(WellKnownTypeNames.MicrosoftVisualStudioTestToolsUnitTestingAssert);
if (unitTestingAssert != null)
{
builder.Add(unitTestingAssert);
}
var unitTestingCollectionAssert = compilation.GetOrCreateTypeByMetadataName(WellKnownTypeNames.MicrosoftVisualStudioTestToolsUnitTestingCollectionAssert);
if (unitTestingCollectionAssert != null)
{
builder.Add(unitTestingCollectionAssert);
}
var unitTestingCollectionStringAssert = compilation.GetOrCreateTypeByMetadataName(WellKnownTypeNames.MicrosoftVisualStudioTestToolsUnitTestingStringAssert);
if (unitTestingCollectionStringAssert != null)
{
builder.Add(unitTestingCollectionStringAssert);
}
return builder.ToImmutableAndFree();
}
private static bool ShouldBeLocalized(
IParameterSymbol parameterSymbol,
IPropertySymbol? containingPropertySymbolOpt,
INamedTypeSymbol? localizableStateAttributeSymbol,
INamedTypeSymbol? conditionalAttributeSymbol,
INamedTypeSymbol? systemConsoleSymbol,
ImmutableHashSet<INamedTypeSymbol> typesToIgnore)
{
Debug.Assert(parameterSymbol.ContainingSymbol.Kind == SymbolKind.Method);
if (parameterSymbol.Type.SpecialType != SpecialType.System_String)
{
return false;
}
// Verify LocalizableAttributeState
if (localizableStateAttributeSymbol != null)
{
LocalizableAttributeState localizableAttributeState = GetLocalizableAttributeState(parameterSymbol, localizableStateAttributeSymbol);
switch (localizableAttributeState)
{
case LocalizableAttributeState.False:
return false;
case LocalizableAttributeState.True:
return true;
default:
break;
}
}
// FxCop compat checks.
if (typesToIgnore.Contains(parameterSymbol.ContainingType) ||
parameterSymbol.ContainingSymbol.HasAttribute(conditionalAttributeSymbol))
{
return false;
}
// FxCop compat: For overrides, check for localizability of the corresponding parameter in the overridden method.
var method = (IMethodSymbol)parameterSymbol.ContainingSymbol;
if (method.IsOverride &&
method.OverriddenMethod?.Parameters.Length == method.Parameters.Length)
{
int parameterIndex = method.GetParameterIndex(parameterSymbol);
IParameterSymbol overridenParameter = method.OverriddenMethod.Parameters[parameterIndex];
if (Equals(overridenParameter.Type, parameterSymbol.Type))
{
return ShouldBeLocalized(overridenParameter, containingPropertySymbolOpt, localizableStateAttributeSymbol, conditionalAttributeSymbol, systemConsoleSymbol, typesToIgnore);
}
}
if (IsLocalizableByNameHeuristic(parameterSymbol) ||
containingPropertySymbolOpt != null && IsLocalizableByNameHeuristic(containingPropertySymbolOpt))
{
return true;
}
if (method.ContainingType.Equals(systemConsoleSymbol) &&
(method.Name.Equals("Write", StringComparison.Ordinal) ||
method.Name.Equals("WriteLine", StringComparison.Ordinal)) &&
(parameterSymbol.Name.Equals("format", StringComparison.OrdinalIgnoreCase) ||
parameterSymbol.Name.Equals("value", StringComparison.OrdinalIgnoreCase)))
{
return true;
}
return false;
// FxCop compat: If a localizable attribute isn't defined then fall back to name heuristics.
static bool IsLocalizableByNameHeuristic(ISymbol symbol) =>
symbol.Name.Equals("message", StringComparison.OrdinalIgnoreCase) ||
symbol.Name.Equals("text", StringComparison.OrdinalIgnoreCase) ||
symbol.Name.Equals("caption", StringComparison.OrdinalIgnoreCase);
}
private static LocalizableAttributeState GetLocalizableAttributeState(ISymbol symbol, INamedTypeSymbol localizableAttributeTypeSymbol)
{
if (symbol == null)
{
return LocalizableAttributeState.Undefined;
}
LocalizableAttributeState localizedState = GetLocalizableAttributeStateCore(symbol.GetAttributes(), localizableAttributeTypeSymbol);
if (localizedState != LocalizableAttributeState.Undefined)
{
return localizedState;
}
ISymbol containingSymbol = (symbol as IMethodSymbol)?.AssociatedSymbol is IPropertySymbol propertySymbol ? propertySymbol : symbol.ContainingSymbol;
return GetLocalizableAttributeState(containingSymbol, localizableAttributeTypeSymbol);
}
private static LocalizableAttributeState GetLocalizableAttributeStateCore(ImmutableArray<AttributeData> attributeList, INamedTypeSymbol localizableAttributeTypeSymbol)
{
var localizableAttribute = attributeList.FirstOrDefault(attr => localizableAttributeTypeSymbol.Equals(attr.AttributeClass));
if (localizableAttribute != null &&
localizableAttribute.AttributeConstructor.Parameters.Length == 1 &&
localizableAttribute.AttributeConstructor.Parameters[0].Type.SpecialType == SpecialType.System_Boolean &&
localizableAttribute.ConstructorArguments.Length == 1 &&
localizableAttribute.ConstructorArguments[0].Kind == TypedConstantKind.Primitive &&
localizableAttribute.ConstructorArguments[0].Value is bool isLocalizable)
{
return isLocalizable ? LocalizableAttributeState.True : LocalizableAttributeState.False;
}
return LocalizableAttributeState.Undefined;
}
private static string FormatLiteralValues(IEnumerable<string> literalValues)
{
var literals = new StringBuilder();
foreach (string literal in literalValues.Order())
{
// sanitize the literal to ensure it's not multiline
// replace any newline characters with a space
var sanitizedLiteral = literal.Replace(Environment.NewLine, " ");
sanitizedLiteral = sanitizedLiteral.Replace((char)13, ' ');
sanitizedLiteral = sanitizedLiteral.Replace((char)10, ' ');
if (literals.Length > 0)
{
literals.Append(", ");
}
literals.Append(sanitizedLiteral);
}
return literals.ToString();
}
/// <summary>
/// Returns true if the given string looks like an XML/HTML tag
/// </summary>
private static bool LooksLikeXmlTag(string literal)
{
// Call the trim function to remove any spaces around the beginning and end of the string so we can more accurately detect
// XML strings
string trimmedLiteral = literal.Trim();
return trimmedLiteral.Length > 2 && trimmedLiteral[0] == '<' && trimmedLiteral[trimmedLiteral.Length - 1] == '>';
}
/// <summary>
/// Returns true if any character in literalValues is not a control character
/// </summary>
private static bool LiteralValuesHaveNonControlCharacters(IEnumerable<string?> literalValues)
{
foreach (string? literal in literalValues)
{
if (literal == null)
{
continue;
}
foreach (char ch in literal)
{
if (!char.IsControl(ch))
{
return true;
}
}
}
return false;
}
}
}