/*
* Copyright (C) 2011 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.tools.klint.checks;
import com.android.annotations.NonNull;
import com.android.annotations.Nullable;
import com.android.builder.model.ProductFlavor;
import com.android.builder.model.ProductFlavorContainer;
import com.android.ide.common.resources.ResourceUrl;
import com.android.resources.Density;
import com.android.resources.ResourceFolderType;
import com.android.resources.ResourceType;
import com.android.tools.klint.detector.api.*;
import com.google.common.collect.*;
import com.intellij.psi.PsiClass;
import com.intellij.psi.PsiElement;
import org.jetbrains.uast.*;
import org.jetbrains.uast.util.UastExpressionUtils;
import org.jetbrains.uast.visitor.AbstractUastVisitor;
import org.jetbrains.uast.visitor.UastVisitor;
import org.w3c.dom.Element;
import javax.imageio.ImageIO;
import javax.imageio.ImageReader;
import javax.imageio.stream.ImageInputStream;
import java.awt.*;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import java.util.*;
import java.util.List;
import java.util.Map.Entry;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static com.android.SdkConstants.*;
import static com.android.tools.klint.detector.api.LintUtils.endsWith;
/**
* Checks for common icon problems, such as wrong icon sizes, placing icons in the
* density independent drawable folder, etc.
*/
public class IconDetector extends ResourceXmlDetector implements Detector.UastScanner {
private static final boolean INCLUDE_LDPI;
static {
boolean includeLdpi = false;
String value = System.getenv("ANDROID_LINT_INCLUDE_LDPI"); //$NON-NLS-1$
if (value != null) {
includeLdpi = Boolean.valueOf(value);
}
INCLUDE_LDPI = includeLdpi;
}
/** Pattern for the expected density folders to be found in the project */
private static final Pattern DENSITY_PATTERN = Pattern.compile(
"^drawable-(nodpi|xxxhdpi|xxhdpi|xhdpi|hdpi|mdpi" //$NON-NLS-1$
+ (INCLUDE_LDPI ? "|ldpi" : "") + ")$"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
/** Pattern for icon names that include their dp size as part of the name */
private static final Pattern DP_NAME_PATTERN = Pattern.compile(".+_(\\d+)dp\\.png"); //$NON-NLS-1$
/** Cache for {@link #getRequiredDensityFolders(Context)} */
private List<String> mCachedRequiredDensities;
/** Cache key for {@link #getRequiredDensityFolders(Context)} */
private Project mCachedDensitiesForProject;
// TODO: Convert this over to using the Density enum and FolderConfiguration
// for qualifier lookup
private static final String[] DENSITY_QUALIFIERS =
new String[] {
"-ldpi", //$NON-NLS-1$
"-mdpi", //$NON-NLS-1$
"-hdpi", //$NON-NLS-1$
"-xhdpi", //$NON-NLS-1$
"-xxhdpi",//$NON-NLS-1$
"-xxxhdpi",//$NON-NLS-1$
};
/** Scope needed to detect the types of icons (which involves scanning .java files,
* the manifest, menu files etc to see how icons are used
*/
private static final EnumSet<Scope> ICON_TYPE_SCOPE = EnumSet.of(Scope.ALL_RESOURCE_FILES,
Scope.JAVA_FILE, Scope.MANIFEST);
private static final Implementation IMPLEMENTATION_JAVA = new Implementation(
IconDetector.class,
ICON_TYPE_SCOPE);
private static final Implementation IMPLEMENTATION_RES_ONLY = new Implementation(
IconDetector.class,
Scope.ALL_RESOURCES_SCOPE);
/** Wrong icon size according to published conventions */
public static final Issue ICON_EXPECTED_SIZE = Issue.create(
"IconExpectedSize", //$NON-NLS-1$
"Icon has incorrect size",
"There are predefined sizes (for each density) for launcher icons. You " +
"should follow these conventions to make sure your icons fit in with the " +
"overall look of the platform.",
Category.ICONS,
5,
Severity.WARNING,
IMPLEMENTATION_JAVA)
// Still some potential false positives:
.setEnabledByDefault(false)
.addMoreInfo(
"http://developer.android.com/design/style/iconography.html"); //$NON-NLS-1$
/** Inconsistent dip size across densities */
public static final Issue ICON_DIP_SIZE = Issue.create(
"IconDipSize", //$NON-NLS-1$
"Icon density-independent size validation",
"Checks the all icons which are provided in multiple densities, all compute to " +
"roughly the same density-independent pixel (`dip`) size. This catches errors where " +
"images are either placed in the wrong folder, or icons are changed to new sizes " +
"but some folders are forgotten.",
Category.ICONS,
5,
Severity.WARNING,
IMPLEMENTATION_RES_ONLY);
/** Images in res/drawable folder */
public static final Issue ICON_LOCATION = Issue.create(
"IconLocation", //$NON-NLS-1$
"Image defined in density-independent drawable folder",
"The res/drawable folder is intended for density-independent graphics such as " +
"shapes defined in XML. For bitmaps, move it to `drawable-mdpi` and consider " +
"providing higher and lower resolution versions in `drawable-ldpi`, `drawable-hdpi` " +
"and `drawable-xhdpi`. If the icon *really* is density independent (for example " +
"a solid color) you can place it in `drawable-nodpi`.",
Category.ICONS,
5,
Severity.WARNING,
IMPLEMENTATION_RES_ONLY).addMoreInfo(
"http://developer.android.com/guide/practices/screens_support.html"); //$NON-NLS-1$
/** Missing density versions of image */
public static final Issue ICON_DENSITIES = Issue.create(
"IconDensities", //$NON-NLS-1$
"Icon densities validation",
"Icons will look best if a custom version is provided for each of the " +
"major screen density classes (low, medium, high, extra high). " +
"This lint check identifies icons which do not have complete coverage " +
"across the densities.\n" +
"\n" +
"Low density is not really used much anymore, so this check ignores " +
"the ldpi density. To force lint to include it, set the environment " +
"variable `ANDROID_LINT_INCLUDE_LDPI=true`. For more information on " +
"current density usage, see " +
"http://developer.android.com/resources/dashboard/screens.html",
Category.ICONS,
4,
Severity.WARNING,
IMPLEMENTATION_RES_ONLY).addMoreInfo(
"http://developer.android.com/guide/practices/screens_support.html"); //$NON-NLS-1$
/** Missing density folders */
public static final Issue ICON_MISSING_FOLDER = Issue.create(
"IconMissingDensityFolder", //$NON-NLS-1$
"Missing density folder",
"Icons will look best if a custom version is provided for each of the " +
"major screen density classes (low, medium, high, extra-high, extra-extra-high). " +
"This lint check identifies folders which are missing, such as `drawable-hdpi`.\n" +
"\n" +
"Low density is not really used much anymore, so this check ignores " +
"the ldpi density. To force lint to include it, set the environment " +
"variable `ANDROID_LINT_INCLUDE_LDPI=true`. For more information on " +
"current density usage, see " +
"http://developer.android.com/resources/dashboard/screens.html",
Category.ICONS,
3,
Severity.WARNING,
IMPLEMENTATION_RES_ONLY).addMoreInfo(
"http://developer.android.com/guide/practices/screens_support.html"); //$NON-NLS-1$
/** Using .gif bitmaps */
public static final Issue GIF_USAGE = Issue.create(
"GifUsage", //$NON-NLS-1$
"Using `.gif` format for bitmaps is discouraged",
"The `.gif` file format is discouraged. Consider using `.png` (preferred) " +
"or `.jpg` (acceptable) instead.",
Category.ICONS,
5,
Severity.WARNING,
IMPLEMENTATION_RES_ONLY).addMoreInfo(
"http://developer.android.com/guide/topics/resources/drawable-resource.html#Bitmap"); //$NON-NLS-1$
/** Duplicated icons across different names */
public static final Issue DUPLICATES_NAMES = Issue.create(
"IconDuplicates", //$NON-NLS-1$
"Duplicated icons under different names",
"If an icon is repeated under different names, you can consolidate and just " +
"use one of the icons and delete the others to make your application smaller. " +
"However, duplicated icons usually are not intentional and can sometimes point " +
"to icons that were accidentally overwritten or accidentally not updated.",
Category.ICONS,
3,
Severity.WARNING,
IMPLEMENTATION_RES_ONLY);
/** Duplicated contents across configurations for a given name */
public static final Issue DUPLICATES_CONFIGURATIONS = Issue.create(
"IconDuplicatesConfig", //$NON-NLS-1$
"Identical bitmaps across various configurations",
"If an icon is provided under different configuration parameters such as " +
"`drawable-hdpi` or `-v11`, they should typically be different. This detector " +
"catches cases where the same icon is provided in different configuration folder " +
"which is usually not intentional.",
Category.ICONS,
5,
Severity.WARNING,
IMPLEMENTATION_RES_ONLY);
/** Icons appearing in both -nodpi and a -Ndpi folder */
public static final Issue ICON_NODPI = Issue.create(
"IconNoDpi", //$NON-NLS-1$
"Icon appears in both `-nodpi` and dpi folders",
"Bitmaps that appear in `drawable-nodpi` folders will not be scaled by the " +
"Android framework. If a drawable resource of the same name appears *both* in " +
"a `-nodpi` folder as well as a dpi folder such as `drawable-hdpi`, then " +
"the behavior is ambiguous and probably not intentional. Delete one or the " +
"other, or use different names for the icons.",
Category.ICONS,
7,
Severity.WARNING,
IMPLEMENTATION_RES_ONLY);
/** Drawables provided as both .9.png and .png files */
public static final Issue ICON_MIX_9PNG = Issue.create(
"IconMixedNinePatch", //$NON-NLS-1$
"Clashing PNG and 9-PNG files",
"If you accidentally name two separate resources `file.png` and `file.9.png`, " +
"the image file and the nine patch file will both map to the same drawable " +
"resource, `@drawable/file`, which is probably not what was intended.",
Category.ICONS,
5,
Severity.WARNING,
IMPLEMENTATION_RES_ONLY);
/** Icons appearing as both drawable xml files and bitmaps */
public static final Issue ICON_XML_AND_PNG = Issue.create(
"IconXmlAndPng", //$NON-NLS-1$
"Icon is specified both as `.xml` file and as a bitmap",
"If a drawable resource appears as an `.xml` file in the `drawable/` folder, " +
"it's usually not intentional for it to also appear as a bitmap using the " +
"same name; generally you expect the drawable XML file to define states " +
"and each state has a corresponding drawable bitmap.",
Category.ICONS,
7,
Severity.WARNING,
IMPLEMENTATION_RES_ONLY);
/** Wrong filename according to the format */
public static final Issue ICON_EXTENSION = Issue.create(
"IconExtension", //$NON-NLS-1$
"Icon format does not match the file extension",
"Ensures that icons have the correct file extension (e.g. a `.png` file is " +
"really in the PNG format and not for example a GIF file named `.png`.)",
Category.ICONS,
3,
Severity.WARNING,
IMPLEMENTATION_RES_ONLY);
/** Wrong filename according to the format */
public static final Issue ICON_COLORS = Issue.create(
"IconColors", //$NON-NLS-1$
"Icon colors do not follow the recommended visual style",
"Notification icons and Action Bar icons should only white and shades of gray. " +
"See the Android Design Guide for more details. " +
"Note that the way Lint decides whether an icon is an action bar icon or " +
"a notification icon is based on the filename prefix: `ic_menu_` for " +
"action bar icons, `ic_stat_` for notification icons etc. These correspond " +
"to the naming conventions documented in " +
"http://developer.android.com/guide/practices/ui_guidelines/icon_design.html",
Category.ICONS,
6,
Severity.WARNING,
IMPLEMENTATION_JAVA).addMoreInfo(
"http://developer.android.com/design/style/iconography.html"); //$NON-NLS-1$
/** Wrong launcher icon shape */
public static final Issue ICON_LAUNCHER_SHAPE = Issue.create(
"IconLauncherShape", //$NON-NLS-1$
"The launcher icon shape should use a distinct silhouette",
"According to the Android Design Guide " +
"(http://developer.android.com/design/style/iconography.html) " +
"your launcher icons should \"use a distinct silhouette\", " +
"a \"three-dimensional, front view, with a slight perspective as if viewed " +
"from above, so that users perceive some depth.\"\n" +
"\n" +
"The unique silhouette implies that your launcher icon should not be a filled " +
"square.",
Category.ICONS,
6,
Severity.WARNING,
IMPLEMENTATION_JAVA).addMoreInfo(
"http://developer.android.com/design/style/iconography.html"); //$NON-NLS-1$
/** Constructs a new {@link IconDetector} check */
public IconDetector() {
}
@Override
public void beforeCheckProject(@NonNull Context context) {
mLauncherIcons = null;
mActionBarIcons = null;
mNotificationIcons = null;
}
@Override
public void afterCheckLibraryProject(@NonNull Context context) {
if (!context.getProject().getReportIssues()) {
// If this is a library project not being analyzed, ignore it
return;
}
checkResourceFolder(context, context.getProject());
}
@Override
public void afterCheckProject(@NonNull Context context) {
checkResourceFolder(context, context.getProject());
}
private void checkResourceFolder(Context context, @NonNull Project project) {
List<File> resourceFolders = project.getResourceFolders();
for (File res : resourceFolders) {
File[] folders = res.listFiles();
if (folders != null) {
boolean checkFolders = context.isEnabled(ICON_DENSITIES)
|| context.isEnabled(ICON_MISSING_FOLDER)
|| context.isEnabled(ICON_NODPI)
|| context.isEnabled(ICON_MIX_9PNG)
|| context.isEnabled(ICON_XML_AND_PNG);
boolean checkDipSizes = context.isEnabled(ICON_DIP_SIZE);
boolean checkDuplicates = context.isEnabled(DUPLICATES_NAMES)
|| context.isEnabled(DUPLICATES_CONFIGURATIONS);
Map<File, Dimension> pixelSizes = null;
Map<File, Long> fileSizes = null;
if (checkDipSizes || checkDuplicates) {
pixelSizes = new HashMap<File, Dimension>();
fileSizes = new HashMap<File, Long>();
}
Map<File, Set<String>> folderToNames = new HashMap<File, Set<String>>();
Map<File, Set<String>> nonDpiFolderNames = new HashMap<File, Set<String>>();
for (File folder : folders) {
String folderName = folder.getName();
if (folderName.startsWith(DRAWABLE_FOLDER)) {
File[] files = folder.listFiles();
if (files != null) {
checkDrawableDir(context, folder, files, pixelSizes, fileSizes);
if (checkFolders && DENSITY_PATTERN.matcher(folderName).matches()) {
Set<String> names = new HashSet<String>(files.length);
for (File f : files) {
String name = f.getName();
if (isDrawableFile(name)) {
names.add(name);
}
}
folderToNames.put(folder, names);
} else if (checkFolders) {
Set<String> names = new HashSet<String>(files.length);
for (File f : files) {
String name = f.getName();
if (isDrawableFile(name)) {
names.add(name);
}
}
nonDpiFolderNames.put(folder, names);
}
}
}
}
if (checkDipSizes) {
checkDipSizes(context, pixelSizes);
}
if (checkDuplicates) {
checkDuplicates(context, pixelSizes, fileSizes);
}
if (checkFolders && !folderToNames.isEmpty()) {
checkDensities(context, res, folderToNames, nonDpiFolderNames);
}
}
}
}
/** Like {@link LintUtils#isBitmapFile(File)} but (a) operates on Strings instead
* of files and (b) also considers XML drawables as images */
private static boolean isDrawableFile(String name) {
// endsWith(name, DOT_PNG) is also true for endsWith(name, DOT_9PNG)
return endsWith(name, DOT_PNG)|| endsWith(name, DOT_JPG) || endsWith(name, DOT_GIF)
|| endsWith(name, DOT_XML) || endsWith(name, DOT_JPEG) || endsWith(name, DOT_WEBP);
}
// This method looks for duplicates in the assets. This uses two pieces of information
// (file sizes and image dimensions) to quickly reject candidates, such that it only
// needs to check actual file contents on a small subset of the available files.
private static void checkDuplicates(Context context, Map<File, Dimension> pixelSizes,
Map<File, Long> fileSizes) {
Map<Long, Set<File>> sameSizes = new HashMap<Long, Set<File>>();
Map<Long, File> seenSizes = new HashMap<Long, File>(fileSizes.size());
for (Map.Entry<File, Long> entry : fileSizes.entrySet()) {
File file = entry.getKey();
Long size = entry.getValue();
if (seenSizes.containsKey(size)) {
Set<File> set = sameSizes.get(size);
if (set == null) {
set = new HashSet<File>();
set.add(seenSizes.get(size));
sameSizes.put(size, set);
}
set.add(file);
} else {
seenSizes.put(size, file);
}
}
if (sameSizes.isEmpty()) {
return;
}
// Now go through the files that have the same size and check to see if we can
// split them apart based on image dimensions
// Note: we may not have file sizes on all the icons; in particular,
// we don't have file sizes for ninepatch files.
Collection<Set<File>> candidateLists = sameSizes.values();
for (Set<File> candidates : candidateLists) {
Map<Dimension, Set<File>> sameDimensions = new HashMap<Dimension, Set<File>>(
candidates.size());
List<File> noSize = new ArrayList<File>();
for (File file : candidates) {
Dimension dimension = pixelSizes.get(file);
if (dimension != null) {
Set<File> set = sameDimensions.get(dimension);
if (set == null) {
set = new HashSet<File>();
sameDimensions.put(dimension, set);
}
set.add(file);
} else {
noSize.add(file);
}
}
// Files that we have no dimensions for must be compared against everything
Collection<Set<File>> sets = sameDimensions.values();
if (!noSize.isEmpty()) {
if (!sets.isEmpty()) {
for (Set<File> set : sets) {
set.addAll(noSize);
}
} else {
// Must just test the noSize elements against themselves
HashSet<File> noSizeSet = new HashSet<File>(noSize);
sets = Collections.<Set<File>>singletonList(noSizeSet);
}
}
// Map from file to actual byte contents of the file.
// We store this in a map such that for repeated files, such as noSize files
// which can appear in multiple buckets, we only need to read them once
Map<File, byte[]> fileContents = new HashMap<File, byte[]>();
// Now we're ready for the final check where we actually check the
// bits. We have to partition the files into buckets of files that
// are identical.
for (Set<File> set : sets) {
if (set.size() < 2) {
continue;
}
// Read all files in this set and store in map
for (File file : set) {
byte[] bits = fileContents.get(file);
if (bits == null) {
try {
bits = context.getClient().readBytes(file);
fileContents.put(file, bits);
} catch (IOException e) {
context.log(e, null);
}
}
}
// Map where the key file is known to be equal to the value file.
// After we check individual files for equality this will be used
// to look for transitive equality.
Map<File, File> equal = new HashMap<File, File>();
// Now go and compare all the files. This isn't an efficient algorithm
// but the number of candidates should be very small
List<File> files = new ArrayList<File>(set);
Collections.sort(files);
for (int i = 0; i < files.size() - 1; i++) {
for (int j = i + 1; j < files.size(); j++) {
File file1 = files.get(i);
File file2 = files.get(j);
byte[] contents1 = fileContents.get(file1);
byte[] contents2 = fileContents.get(file2);
if (contents1 == null || contents2 == null) {
// File couldn't be read: ignore
continue;
}
if (contents1.length != contents2.length) {
// Sizes differ: not identical.
// This shouldn't happen since we've already partitioned based
// on File.length(), but just make sure here since the file
// system could have lied, or cached a value that has changed
// if the file was just overwritten
continue;
}
boolean same = true;
for (int k = 0; k < contents1.length; k++) {
if (contents1[k] != contents2[k]) {
same = false;
break;
}
}
if (same) {
equal.put(file1, file2);
}
}
}
if (!equal.isEmpty()) {
Map<File, Set<File>> partitions = new HashMap<File, Set<File>>();
List<Set<File>> sameSets = new ArrayList<Set<File>>();
for (Map.Entry<File, File> entry : equal.entrySet()) {
File file1 = entry.getKey();
File file2 = entry.getValue();
Set<File> set1 = partitions.get(file1);
Set<File> set2 = partitions.get(file2);
if (set1 != null) {
set1.add(file2);
} else if (set2 != null) {
set2.add(file1);
} else {
set = new HashSet<File>();
sameSets.add(set);
set.add(file1);
set.add(file2);
partitions.put(file1, set);
partitions.put(file2, set);
}
}
// We've computed the partitions of equal files. Now sort them
// for stable output.
List<List<File>> lists = new ArrayList<List<File>>();
for (Set<File> same : sameSets) {
assert !same.isEmpty();
ArrayList<File> sorted = new ArrayList<File>(same);
Collections.sort(sorted);
lists.add(sorted);
}
// Sort overall partitions by the first item in each list
Collections.sort(lists, new Comparator<List<File>>() {
@Override
public int compare(List<File> list1, List<File> list2) {
return list1.get(0).compareTo(list2.get(0));
}
});
// Allow one specific scenario of duplicated icon contents:
// Checking in different size icons (within a single density
// folder). For now the only pattern we recognize is the
// one advocated by the material design icons:
// https://github.com/google/material-design-icons
// where the pattern is foo_<N>dp.png. (See issue 74584 for more.)
ListIterator<List<File>> iterator = lists.listIterator();
while (iterator.hasNext()) {
List<File> list = iterator.next();
boolean remove = true;
for (File file : list) {
String name = file.getName();
if (!DP_NAME_PATTERN.matcher(name).matches()) {
// One or more pattern in this list does not
// conform to the dp naming pattern, so
remove = false;
break;
}
}
if (remove) {
iterator.remove();
}
}
for (List<File> sameFiles : lists) {
Location location = null;
boolean sameNames = true;
String lastName = null;
for (File file : sameFiles) {
if (lastName != null && !lastName.equals(file.getName())) {
sameNames = false;
}
lastName = file.getName();
// Chain locations together
Location linkedLocation = location;
location = Location.create(file);
location.setSecondary(linkedLocation);
}
if (sameNames) {
StringBuilder sb = new StringBuilder(sameFiles.size() * 16);
for (File file : sameFiles) {
if (sb.length() > 0) {
sb.append(", "); //$NON-NLS-1$
}
sb.append(file.getParentFile().getName());
}
String message = String.format(
"The `%1$s` icon has identical contents in the following configuration folders: %2$s",
lastName, sb.toString());
if (location != null) {
context.report(DUPLICATES_CONFIGURATIONS, location, message);
}
} else {
StringBuilder sb = new StringBuilder(sameFiles.size() * 16);
for (File file : sameFiles) {
if (sb.length() > 0) {
sb.append(", "); //$NON-NLS-1$
}
sb.append(file.getName());
}
String message = String.format(
"The following unrelated icon files have identical contents: %1$s",
sb.toString());
context.report(DUPLICATES_NAMES, location, message);
}
}
}
}
}
}
// This method checks the given map from resource file to pixel dimensions for each
// such image and makes sure that the normalized dip sizes across all the densities
// are mostly the same.
private static void checkDipSizes(Context context, Map<File, Dimension> pixelSizes) {
// Partition up the files such that I can look at a series by name. This
// creates a map from filename (such as foo.png) to a list of files
// providing that icon in various folders: drawable-mdpi/foo.png, drawable-hdpi/foo.png
// etc.
Map<String, List<File>> nameToFiles = new HashMap<String, List<File>>();
for (File file : pixelSizes.keySet()) {
String name = file.getName();
List<File> list = nameToFiles.get(name);
if (list == null) {
list = new ArrayList<File>();
nameToFiles.put(name, list);
}
list.add(file);
}
ArrayList<String> names = new ArrayList<String>(nameToFiles.keySet());
Collections.sort(names);
// We have to partition the files further because it's possible for the project
// to have different configurations for an icon, such as this:
// drawable-large-hdpi/foo.png, drawable-large-mdpi/foo.png,
// drawable-hdpi/foo.png, drawable-mdpi/foo.png,
// drawable-hdpi-v11/foo.png and drawable-mdpi-v11/foo.png.
// In this case we don't want to compare across categories; we want to
// ensure that the drawable-large-{density} icons are consistent,
// that the drawable-{density}-v11 icons are consistent, and that
// the drawable-{density} icons are consistent.
// Map from name to list of map from parent folder to list of files
Map<String, Map<String, List<File>>> configMap =
new HashMap<String, Map<String,List<File>>>();
for (Map.Entry<String, List<File>> entry : nameToFiles.entrySet()) {
String name = entry.getKey();
List<File> files = entry.getValue();
for (File file : files) {
//noinspection ConstantConditions
String parentName = file.getParentFile().getName();
// Strip out the density part
int index = -1;
for (String qualifier : DENSITY_QUALIFIERS) {
index = parentName.indexOf(qualifier);
if (index != -1) {
parentName = parentName.substring(0, index)
+ parentName.substring(index + qualifier.length());
break;
}
}
if (index == -1) {
// No relevant qualifier found in the parent directory name,
// e.g. it's just "drawable" or something like "drawable-nodpi".
continue;
}
Map<String, List<File>> folderMap = configMap.get(name);
if (folderMap == null) {
folderMap = new HashMap<String,List<File>>();
configMap.put(name, folderMap);
}
// Map from name to a map from parent folder to files
List<File> list = folderMap.get(parentName);
if (list == null) {
list = new ArrayList<File>();
folderMap.put(parentName, list);
}
list.add(file);
}
}
for (String name : names) {
//List<File> files = nameToFiles.get(name);
Map<String, List<File>> configurations = configMap.get(name);
if (configurations == null) {
// Nothing in this configuration: probably only found in drawable/ or
// drawable-nodpi etc directories.
continue;
}
for (Map.Entry<String, List<File>> entry : configurations.entrySet()) {
List<File> files = entry.getValue();
// Ensure that all the dip sizes are *roughly* the same
Map<File, Dimension> dipSizes = new HashMap<File, Dimension>();
int dipWidthSum = 0; // Incremental computation of average
int dipHeightSum = 0; // Incremental computation of average
int count = 0;
for (File file : files) {
//noinspection ConstantConditions
String folderName = file.getParentFile().getName();
float factor = getMdpiScalingFactor(folderName);
if (factor > 0) {
Dimension size = pixelSizes.get(file);
if (size == null) {
continue;
}
Dimension dip = new Dimension(
Math.round(size.width / factor),
Math.round(size.height / factor));
dipWidthSum += dip.width;
dipHeightSum += dip.height;
dipSizes.put(file, dip);
count++;
String fileName = file.getName();
Matcher matcher = DP_NAME_PATTERN.matcher(fileName);
if (matcher.matches()) {
String dpString = matcher.group(1);
int dp = Integer.parseInt(dpString);
// We're not sure whether the dp size refers to the width
// or the height, so check both. Allow a little bit of rounding
// slop.
if (Math.abs(dip.width - dp) > 2 || Math.abs(dip.height - dp) > 2) {
// Unicode 00D7 is the multiplication sign
String message = String.format(""
+ "Suspicious file name `%1$s`: The implied %2$s `dp` "
+ "size does not match the actual `dp` size "
+ "(pixel size %3$d\u00D7%4$d in a `%5$s` folder "
+ "computes to %6$d\u00D7%7$d `dp`)",
fileName, dpString,
size.width, size.height,
folderName,
dip.width, dip.height);
context.report(ICON_DIP_SIZE, Location.create(file), message);
}
}
}
}
if (count == 0) {
// Icons in drawable/ and drawable-nodpi/
continue;
}
int meanWidth = dipWidthSum / count;
int meanHeight = dipHeightSum / count;
// Compute standard deviation?
int squareWidthSum = 0;
int squareHeightSum = 0;
for (Dimension size : dipSizes.values()) {
squareWidthSum += (size.width - meanWidth) * (size.width - meanWidth);
squareHeightSum += (size.height - meanHeight) * (size.height - meanHeight);
}
double widthStdDev = Math.sqrt(squareWidthSum / count);
double heightStdDev = Math.sqrt(squareHeightSum / count);
if (widthStdDev > meanWidth / 10 || heightStdDev > meanHeight) {
Location location = null;
StringBuilder sb = new StringBuilder(100);
// Sort entries by decreasing dip size
List<Map.Entry<File, Dimension>> entries =
new ArrayList<Map.Entry<File,Dimension>>();
for (Map.Entry<File, Dimension> entry2 : dipSizes.entrySet()) {
entries.add(entry2);
}
Collections.sort(entries,
new Comparator<Map.Entry<File, Dimension>>() {
@Override
public int compare(Entry<File, Dimension> e1,
Entry<File, Dimension> e2) {
Dimension d1 = e1.getValue();
Dimension d2 = e2.getValue();
if (d1.width != d2.width) {
return d2.width - d1.width;
}
return d2.height - d1.height;
}
});
for (Map.Entry<File, Dimension> entry2 : entries) {
if (sb.length() > 0) {
sb.append(", ");
}
File file = entry2.getKey();
// Chain locations together
Location linkedLocation = location;
location = Location.create(file);
location.setSecondary(linkedLocation);
Dimension dip = entry2.getValue();
Dimension px = pixelSizes.get(file);
//noinspection ConstantConditions
String fileName = file.getParentFile().getName() + File.separator
+ file.getName();
sb.append(String.format("%1$s: %2$dx%3$d dp (%4$dx%5$d px)",
fileName, dip.width, dip.height, px.width, px.height));
}
String message = String.format(
"The image `%1$s` varies significantly in its density-independent (dip) " +
"size across the various density versions: %2$s",
name, sb.toString());
if (location != null) {
context.report(ICON_DIP_SIZE, location, message);
}
}
}
}
}
private void checkDensities(Context context, File res,
Map<File, Set<String>> folderToNames,
Map<File, Set<String>> nonDpiFolderNames) {
// TODO: Is there a way to look at the manifest and figure out whether
// all densities are expected to be needed?
// Note: ldpi is probably not needed; it has very little usage
// (about 2%; http://developer.android.com/resources/dashboard/screens.html)
// TODO: Use the matrix to check out if we can eliminate densities based
// on the target screens?
Set<String> definedDensities = new HashSet<String>();
for (File f : folderToNames.keySet()) {
definedDensities.add(f.getName());
}
// Look for missing folders -- if you define say drawable-mdpi then you
// should also define -hdpi and -xhdpi.
if (context.isEnabled(ICON_MISSING_FOLDER)) {
List<String> missing = new ArrayList<String>();
for (String density : getRequiredDensityFolders(context)) {
if (!definedDensities.contains(density)) {
missing.add(density);
}
}
if (!missing.isEmpty()) {
context.report(
ICON_MISSING_FOLDER,
Location.create(res),
String.format("Missing density variation folders in `%1$s`: %2$s",
context.getProject().getDisplayPath(res),
LintUtils.formatList(missing, -1)));
}
}
if (context.isEnabled(ICON_NODPI)) {
Set<String> noDpiNames = new HashSet<String>();
for (Map.Entry<File, Set<String>> entry : folderToNames.entrySet()) {
if (isNoDpiFolder(entry.getKey())) {
noDpiNames.addAll(entry.getValue());
}
}
if (!noDpiNames.isEmpty()) {
// Make sure that none of the nodpi names appear in a non-nodpi folder
Set<String> inBoth = new HashSet<String>();
List<File> files = new ArrayList<File>();
for (Map.Entry<File, Set<String>> entry : folderToNames.entrySet()) {
File folder = entry.getKey();
String folderName = folder.getName();
if (!isNoDpiFolder(folder)) {
assert DENSITY_PATTERN.matcher(folderName).matches();
Set<String> overlap = nameIntersection(noDpiNames, entry.getValue());
inBoth.addAll(overlap);
for (String name : overlap) {
files.add(new File(folder, name));
}
}
}
if (!inBoth.isEmpty()) {
List<String> list = new ArrayList<String>(inBoth);
Collections.sort(list);
// Chain locations together
Location location = chainLocations(files);
context.report(ICON_NODPI, location,
String.format(
"The following images appear in both `-nodpi` and in a density folder: %1$s",
LintUtils.formatList(list,
context.getDriver().isAbbreviating() ? 10 : -1)));
}
}
}
if (context.isEnabled(ICON_MIX_9PNG)) {
checkMixedNinePatches(context, folderToNames);
}
if (context.isEnabled(ICON_XML_AND_PNG)) {
Map<File, Set<String>> folderMap = Maps.newHashMap(folderToNames);
folderMap.putAll(nonDpiFolderNames);
Set<String> xmlNames = Sets.newHashSetWithExpectedSize(100);
Set<String> bitmapNames = Sets.newHashSetWithExpectedSize(100);
for (Map.Entry<File, Set<String>> entry : folderMap.entrySet()) {
Set<String> names = entry.getValue();
for (String name : names) {
if (endsWith(name, DOT_XML)) {
xmlNames.add(name);
} else if (isDrawableFile(name)) {
bitmapNames.add(name);
}
}
}
if (!xmlNames.isEmpty() && !bitmapNames.isEmpty()) {
// Make sure that none of the nodpi names appear in a non-nodpi folder
Set<String> overlap = nameIntersection(xmlNames, bitmapNames);
if (!overlap.isEmpty()) {
Multimap<String, File> map = ArrayListMultimap.create();
Set<String> bases = Sets.newHashSetWithExpectedSize(overlap.size());
for (String name : overlap) {
bases.add(LintUtils.getBaseName(name));
}
for (String base : bases) {
for (Map.Entry<File, Set<String>> entry : folderMap.entrySet()) {
File folder = entry.getKey();
for (String n : entry.getValue()) {
if (base.equals(LintUtils.getBaseName(n))) {
map.put(base, new File(folder, n));
}
}
}
}
List<String> sorted = new ArrayList<String>(map.keySet());
Collections.sort(sorted);
for (String name : sorted) {
List<File> lists = Lists.newArrayList(map.get(name));
Location location = chainLocations(lists);
List<String> fileNames = Lists.newArrayList();
boolean seenXml = false;
boolean seenNonXml = false;
for (File f : lists) {
boolean isXml = endsWith(f.getPath(), DOT_XML);
if (isXml && !seenXml) {
fileNames.add(context.getProject().getDisplayPath(f));
seenXml = true;
} else if (!isXml && !seenNonXml) {
fileNames.add(context.getProject().getDisplayPath(f));
seenNonXml = true;
}
}
context.report(ICON_XML_AND_PNG, location,
String.format(
"The following images appear both as density independent `.xml` files and as bitmap files: %1$s",
LintUtils.formatList(fileNames,
context.getDriver().isAbbreviating() ? 10 : -1)));
}
}
}
}
if (context.isEnabled(ICON_DENSITIES)) {
// Look for folders missing some of the specific assets
Set<String> allNames = new HashSet<String>();
for (Entry<File,Set<String>> entry : folderToNames.entrySet()) {
if (!isNoDpiFolder(entry.getKey())) {
Set<String> names = entry.getValue();
allNames.addAll(names);
}
}
for (Map.Entry<File, Set<String>> entry : folderToNames.entrySet()) {
File file = entry.getKey();
if (isNoDpiFolder(file)) {
continue;
}
Set<String> names = entry.getValue();
if (names.size() != allNames.size()) {
List<String> delta = new ArrayList<String>(nameDifferences(allNames, names));
if (delta.isEmpty()) {
continue;
}
Collections.sort(delta);
String foundIn = "";
if (delta.size() == 1) {
// Produce list of where the icon is actually defined
List<String> defined = new ArrayList<String>();
String name = delta.get(0);
for (Map.Entry<File, Set<String>> e : folderToNames.entrySet()) {
if (e.getValue().contains(name)) {
defined.add(e.getKey().getName());
}
}
if (!defined.isEmpty()) {
foundIn = String.format(" (found in %1$s)",
LintUtils.formatList(defined,
context.getDriver().isAbbreviating() ? 5 : -1));
}
}
// Irrelevant folder?
String folder = file.getName();
if (!getRequiredDensityFolders(context).contains(folder)) {
continue;
}
context.report(ICON_DENSITIES, Location.create(file),
String.format(
"Missing the following drawables in `%1$s`: %2$s%3$s",
folder,
LintUtils.formatList(delta,
context.getDriver().isAbbreviating() ? 5 : -1),
foundIn));
}
}
}
}
private List<String> getRequiredDensityFolders(@NonNull Context context) {
if (mCachedRequiredDensities == null
|| context.getProject() != mCachedDensitiesForProject) {
mCachedDensitiesForProject = context.getProject();
mCachedRequiredDensities = Lists.newArrayListWithExpectedSize(10);
List<String> applicableDensities = context.getProject().getApplicableDensities();
if (applicableDensities != null) {
mCachedRequiredDensities.addAll(applicableDensities);
} else {
if (INCLUDE_LDPI) {
mCachedRequiredDensities.add(DRAWABLE_LDPI);
}
mCachedRequiredDensities.add(DRAWABLE_MDPI);
mCachedRequiredDensities.add(DRAWABLE_HDPI);
mCachedRequiredDensities.add(DRAWABLE_XHDPI);
mCachedRequiredDensities.add(DRAWABLE_XXHDPI);
mCachedRequiredDensities.add(DRAWABLE_XXXHDPI);
}
}
return mCachedRequiredDensities;
}
/**
* Adds in the resConfig values specified by the given flavor container, assuming
* it's in one of the relevant variantFlavors, into the given set
*/
private static void addResConfigsFromFlavor(@NonNull Set<String> relevantDensities,
@Nullable List<String> variantFlavors,
@NonNull ProductFlavorContainer container) {
ProductFlavor flavor = container.getProductFlavor();
if (variantFlavors == null || variantFlavors.contains(flavor.getName())) {
if (!flavor.getResourceConfigurations().isEmpty()) {
for (String densityName : flavor.getResourceConfigurations()) {
Density density = Density.getEnum(densityName);
if (density != null && density.isRecommended()
&& density != Density.NODPI && density != Density.ANYDPI) {
relevantDensities.add(densityName);
}
}
}
}
}
/**
* Compute the difference in names between a and b. This is not just
* Sets.difference(a, b) because we want to make the comparisons <b>without
* file extensions</b> and return the result <b>with</b>..
*/
private static Set<String> nameDifferences(Set<String> a, Set<String> b) {
Set<String> names1 = new HashSet<String>(a.size());
for (String s : a) {
names1.add(LintUtils.getBaseName(s));
}
Set<String> names2 = new HashSet<String>(b.size());
for (String s : b) {
names2.add(LintUtils.getBaseName(s));
}
names1.removeAll(names2);
if (!names1.isEmpty()) {
// Map filenames back to original filenames with extensions
Set<String> result = new HashSet<String>(names1.size());
for (String s : a) {
if (names1.contains(LintUtils.getBaseName(s))) {
result.add(s);
}
}
for (String s : b) {
if (names1.contains(LintUtils.getBaseName(s))) {
result.add(s);
}
}
return result;
}
return Collections.emptySet();
}
/**
* Compute the intersection in names between a and b. This is not just
* Sets.intersection(a, b) because we want to make the comparisons <b>without
* file extensions</b> and return the result <b>with</b>.
*/
private static Set<String> nameIntersection(Set<String> a, Set<String> b) {
Set<String> names1 = new HashSet<String>(a.size());
for (String s : a) {
names1.add(LintUtils.getBaseName(s));
}
Set<String> names2 = new HashSet<String>(b.size());
for (String s : b) {
names2.add(LintUtils.getBaseName(s));
}
names1.retainAll(names2);
if (!names1.isEmpty()) {
// Map filenames back to original filenames with extensions
Set<String> result = new HashSet<String>(names1.size());
for (String s : a) {
if (names1.contains(LintUtils.getBaseName(s))) {
result.add(s);
}
}
for (String s : b) {
if (names1.contains(LintUtils.getBaseName(s))) {
result.add(s);
}
}
return result;
}
return Collections.emptySet();
}
private static boolean isNoDpiFolder(File file) {
return file.getName().contains("-nodpi");
}
private Map<File, BufferedImage> mImageCache;
@Nullable
private BufferedImage getImage(@Nullable File file) throws IOException {
if (file == null) {
return null;
}
if (mImageCache == null) {
mImageCache = Maps.newHashMap();
} else {
BufferedImage image = mImageCache.get(file);
if (image != null) {
return image;
}
}
BufferedImage image = ImageIO.read(file);
mImageCache.put(file, image);
return image;
}
private void checkDrawableDir(Context context, File folder, File[] files,
Map<File, Dimension> pixelSizes, Map<File, Long> fileSizes) {
if (folder.getName().equals(DRAWABLE_FOLDER)
&& context.isEnabled(ICON_LOCATION) &&
// If supporting older versions than Android 1.6, it's not an error
// to include bitmaps in drawable/
context.getProject().getMinSdk() >= 4) {
for (File file : files) {
String name = file.getName();
//noinspection StatementWithEmptyBody
if (name.endsWith(DOT_XML)) {
// pass - most common case, avoids checking other extensions
} else if (endsWith(name, DOT_PNG)
|| endsWith(name, DOT_JPG)
|| endsWith(name, DOT_JPEG)
|| endsWith(name, DOT_GIF)) {
context.report(ICON_LOCATION,
Location.create(file),
String.format("Found bitmap drawable `res/drawable/%1$s` in " +
"densityless folder",
file.getName()));
}
}
}
if (context.isEnabled(GIF_USAGE)) {
for (File file : files) {
String name = file.getName();
if (endsWith(name, DOT_GIF)) {
context.report(GIF_USAGE, Location.create(file),
"Using the `.gif` format for bitmaps is discouraged");
}
}
}
if (context.isEnabled(ICON_EXTENSION)) {
for (File file : files) {
String path = file.getPath();
if (isDrawableFile(path) && !endsWith(path, DOT_XML)) {
checkExtension(context, file);
}
}
}
if (context.isEnabled(ICON_COLORS)) {
for (File file : files) {
String name = file.getName();
if (isDrawableFile(name)
&& !endsWith(name, DOT_XML)
&& !endsWith(name, DOT_9PNG)) {
String baseName = getBaseName(name);
boolean isActionBarIcon = isActionBarIcon(context, baseName, file);
if (isActionBarIcon || isNotificationIcon(baseName)) {
Dimension size = checkColor(context, file, isActionBarIcon);
// Store dimension for size check if we went to the trouble of reading image
if (size != null && pixelSizes != null) {
pixelSizes.put(file, size);
}
}
}
}
}
if (context.isEnabled(ICON_LAUNCHER_SHAPE)) {
// Look up launcher icon name
for (File file : files) {
String name = file.getName();
if (isLauncherIcon(getBaseName(name))
&& !endsWith(name, DOT_XML)
&& !endsWith(name, DOT_9PNG)) {
checkLauncherShape(context, file);
}
}
}
// Check icon sizes
if (context.isEnabled(ICON_EXPECTED_SIZE)) {
checkExpectedSizes(context, folder, files);
}
if (pixelSizes != null || fileSizes != null) {
for (File file : files) {
// TODO: Combine this check with the check for expected sizes such that
// I don't check file sizes twice!
String fileName = file.getName();
if (endsWith(fileName, DOT_PNG) || endsWith(fileName, DOT_JPG)
|| endsWith(fileName, DOT_JPEG)) {
// Only scan .png files (except 9-patch png's) and jpg files for
// dip sizes. Duplicate checks can also be performed on ninepatch files.
if (pixelSizes != null && !endsWith(fileName, DOT_9PNG)
&& !pixelSizes.containsKey(file)) { // already read by checkColor?
Dimension size = getSize(file);
pixelSizes.put(file, size);
}
if (fileSizes != null) {
fileSizes.put(file, file.length());
}
}
}
}
mImageCache = null;
}
/**
* Check that launcher icons do not fill every pixel in the image
*/
private void checkLauncherShape(Context context, File file) {
try {
BufferedImage image = getImage(file);
if (image != null) {
// TODO: see if the shape is rectangular but inset from outer rectangle; if so
// that's probably not right either!
for (int y = 0, height = image.getHeight(); y < height; y++) {
for (int x = 0, width = image.getWidth(); x < width; x++) {
int rgb = image.getRGB(x, y);
if ((rgb & 0xFF000000) == 0) {
return;
}
}
}
String message = "Launcher icons should not fill every pixel of their square " +
"region; see the design guide for details";
context.report(ICON_LAUNCHER_SHAPE, Location.create(file),
message);
}
} catch (IOException e) {
// Pass: ignore files we can't read
}
}
/**
* Check whether the icons in the file are okay. Also return the image size
* if known (for use by other checks)
*/
private Dimension checkColor(Context context, File file, boolean isActionBarIcon) {
int folderVersion = context.getDriver().getResourceFolderVersion(file);
if (isActionBarIcon) {
if (folderVersion != -1 && folderVersion < 11
|| !isAndroid30(context, folderVersion)) {
return null;
}
} else {
if (folderVersion != -1 && folderVersion < 9
|| !isAndroid23(context, folderVersion)
&& !isAndroid30(context, folderVersion)) {
return null;
}
}
// TODO: This only checks icons that are known to be using the Holo style.
// However, if the user has minSdk < 11 as well as targetSdk > 11, we should
// also check that they actually include a -v11 or -v14 folder with proper
// icons, since the below won't flag the older icons.
try {
BufferedImage image = getImage(file);
if (image != null) {
if (isActionBarIcon) {
checkPixels:
for (int y = 0, height = image.getHeight(); y < height; y++) {
for (int x = 0, width = image.getWidth(); x < width; x++) {
int rgb = image.getRGB(x, y);
if ((rgb & 0xFF000000) != 0) { // else: transparent
int r = (rgb & 0xFF0000) >>> 16;
int g = (rgb & 0x00FF00) >>> 8;
int b = (rgb & 0x0000FF);
if (r != g || r != b) {
String message = "Action Bar icons should use a single gray "
+ "color (`#333333` for light themes (with 60%/30% "
+ "opacity for enabled/disabled), and `#FFFFFF` with "
+ "opacity 80%/30% for dark themes";
context.report(ICON_COLORS, Location.create(file),
message);
break checkPixels;
}
}
}
}
} else {
if (folderVersion >= 11 || isAndroid30(context, folderVersion)) {
// Notification icons. Should be white as of API 14
checkPixels:
for (int y = 0, height = image.getHeight(); y < height; y++) {
for (int x = 0, width = image.getWidth(); x < width; x++) {
int rgb = image.getRGB(x, y);
// If the pixel is not completely transparent, insist that
// its RGB channel must be white (with any alpha value)
if ((rgb & 0xFF000000) != 0 && (rgb & 0xFFFFFF) != 0xFFFFFF) {
int r = (rgb & 0xFF0000) >>> 16;
int g = (rgb & 0x00FF00) >>> 8;
int b = (rgb & 0x0000FF);
if (r == g && r == b) {
// If the pixel is not white, it might be because of
// anti-aliasing. In that case, at least one neighbor
// should be of a different color
if (x < width - 1 && rgb != image.getRGB(x + 1, y)) {
continue;
}
if (x > 0 && rgb != image.getRGB(x - 1, y)) {
continue;
}
if (y < height - 1 && rgb != image.getRGB(x, y + 1)) {
continue;
}
if (y > 0 && rgb != image.getRGB(x, y - 1)) {
continue;
}
}
String message = "Notification icons must be entirely white";
context.report(ICON_COLORS, Location.create(file),
message);
break checkPixels;
}
}
}
} else {
// As of API 9, should be gray.
checkPixels:
for (int y = 0, height = image.getHeight(); y < height; y++) {
for (int x = 0, width = image.getWidth(); x < width; x++) {
int rgb = image.getRGB(x, y);
if ((rgb & 0xFF000000) != 0) { // else: transparent
int r = (rgb & 0xFF0000) >>> 16;
int g = (rgb & 0x00FF00) >>> 8;
int b = (rgb & 0x0000FF);
if (r != g || r != b) {
String message = "Notification icons should not use "
+ "colors";
context.report(ICON_COLORS, Location.create(file),
message);
break checkPixels;
}
}
}
}
}
}
return new Dimension(image.getWidth(), image.getHeight());
}
} catch (IOException e) {
// Pass: ignore files we can't read
}
return null;
}
private static void checkExtension(Context context, File file) {
try {
ImageInputStream input = ImageIO.createImageInputStream(file);
if (input != null) {
try {
Iterator<ImageReader> readers = ImageIO.getImageReaders(input);
while (readers.hasNext()) {
ImageReader reader = readers.next();
try {
reader.setInput(input);
// Check file extension
String formatName = reader.getFormatName();
if (formatName != null && !formatName.isEmpty()) {
String path = file.getPath();
int index = path.lastIndexOf('.');
String extension = path.substring(index+1).toLowerCase(Locale.US);
if (!formatName.equalsIgnoreCase(extension)) {
if (endsWith(path, DOT_JPG)
&& formatName.equals("JPEG")) { //$NON-NLS-1$
return;
}
String message = String.format(
"Misleading file extension; named `.%1$s` but the " +
"file format is `%2$s`", extension, formatName);
Location location = Location.create(file);
context.report(ICON_EXTENSION, location, message);
}
break;
}
} finally {
reader.dispose();
}
}
} finally {
input.close();
}
}
} catch (IOException e) {
// Pass -- we can't handle all image types, warn about those we can
}
}
// Like LintUtils.getBaseName, but for files like .svn it returns "" rather than ".svn"
private static String getBaseName(String name) {
String baseName = name;
int index = baseName.indexOf('.');
if (index != -1) {
baseName = baseName.substring(0, index);
}
return baseName;
}
private static void checkMixedNinePatches(Context context,
Map<File, Set<String>> folderToNames) {
Set<String> conflictSet = null;
for (Entry<File, Set<String>> entry : folderToNames.entrySet()) {
Set<String> baseNames = new HashSet<String>();
Set<String> names = entry.getValue();
for (String name : names) {
assert isDrawableFile(name) : name;
String base = getBaseName(name);
if (baseNames.contains(base)) {
String ninepatch = base + DOT_9PNG;
String png = base + DOT_PNG;
if (names.contains(ninepatch) && names.contains(png)) {
if (conflictSet == null) {
conflictSet = Sets.newHashSet();
}
conflictSet.add(base);
}
} else {
baseNames.add(base);
}
}
}
if (conflictSet == null || conflictSet.isEmpty()) {
return;
}
Map<String, List<File>> conflicts = null;
for (Entry<File, Set<String>> entry : folderToNames.entrySet()) {
File dir = entry.getKey();
Set<String> names = entry.getValue();
for (String name : names) {
assert isDrawableFile(name) : name;
String base = getBaseName(name);
if (conflictSet.contains(base)) {
if (conflicts == null) {
conflicts = Maps.newHashMap();
}
List<File> files = conflicts.get(base);
if (files == null) {
files = Lists.newArrayList();
conflicts.put(base, files);
}
files.add(new File(dir, name));
}
}
}
assert conflicts != null && !conflicts.isEmpty() : conflictSet;
List<String> names = new ArrayList<String>(conflicts.keySet());
Collections.sort(names);
for (String name : names) {
List<File> files = conflicts.get(name);
assert files != null : name;
Location location = chainLocations(files);
String message = String.format(
"The files `%1$s.png` and `%1$s.9.png` clash; both "
+ "will map to `@drawable/%1$s`", name);
context.report(ICON_MIX_9PNG, location, message);
}
}
private static Location chainLocations(List<File> files) {
// Chain locations together
Collections.sort(files);
Location location = null;
for (File file : files) {
Location linkedLocation = location;
location = Location.create(file);
location.setSecondary(linkedLocation);
}
return location;
}
private void checkExpectedSizes(Context context, File folder, File[] files) {
if (files == null || files.length == 0) {
return;
}
String folderName = folder.getName();
int folderVersion = context.getDriver().getResourceFolderVersion(files[0]);
for (File file : files) {
String name = file.getName();
// TODO: Look up exact app icon from the manifest rather than simply relying on
// the naming conventions described here:
// http://developer.android.com/guide/practices/ui_guidelines/icon_design.html#design-tips
// See if we can figure out other types of icons from usage too.
String baseName = getBaseName(name);
if (isLauncherIcon(baseName)) {
// Launcher icons
checkSize(context, folderName, file, 48, 48, true /*exact*/);
} else if (isActionBarIcon(baseName)) {
checkSize(context, folderName, file, 32, 32, true /*exact*/);
} else if (name.startsWith("ic_dialog_")) { //$NON-NLS-1$
// Dialog
checkSize(context, folderName, file, 32, 32, true /*exact*/);
} else if (name.startsWith("ic_tab_")) { //$NON-NLS-1$
// Tab icons
checkSize(context, folderName, file, 32, 32, true /*exact*/);
} else if (isNotificationIcon(baseName)) {
// Notification icons
if (isAndroid30(context, folderVersion)) {
checkSize(context, folderName, file, 24, 24, true /*exact*/);
} else if (isAndroid23(context, folderVersion)) {
checkSize(context, folderName, file, 16, 25, false /*exact*/);
} else {
// Android 2.2 or earlier
// TODO: Should this be done for each folder size?
checkSize(context, folderName, file, 25, 25, true /*exact*/);
}
} else if (name.startsWith("ic_menu_")) { //$NON-NLS-1$
if (isAndroid30(context, folderVersion)) {
// Menu icons (<=2.3 only: Replaced by action bar icons (ic_action_ in 3.0).
// However the table halfway down the page on
// http://developer.android.com/guide/practices/ui_guidelines/icon_design.html
// and the README in the icon template download says that convention is ic_menu
checkSize(context, folderName, file, 32, 32, true);
} else if (isAndroid23(context, folderVersion)) {
// The icon should be 32x32 inside the transparent image; should
// we check that this is mostly the case (a few pixels are allowed to
// overlap for anti-aliasing etc)
checkSize(context, folderName, file, 48, 48, true /*exact*/);
} else {
// Android 2.2 or earlier
// TODO: Should this be done for each folder size?
checkSize(context, folderName, file, 48, 48, true /*exact*/);
}
}
// TODO: ListView icons?
}
}
/**
* Is this drawable folder for an Android 3.0 drawable? This will be the
* case if it specifies -v11+, or if the minimum SDK version declared in the
* manifest is at least 11.
*/
private static boolean isAndroid30(Context context, int folderVersion) {
return folderVersion >= 11 || context.getMainProject().getMinSdk() >= 11;
}
/**
* Is this drawable folder for an Android 2.3 drawable? This will be the
* case if it specifies -v9 or -v10, or if the minimum SDK version declared in the
* manifest is 9 or 10 (and it does not specify some higher version like -v11
*/
private static boolean isAndroid23(Context context, int folderVersion) {
if (isAndroid30(context, folderVersion)) {
return false;
}
if (folderVersion == 9 || folderVersion == 10) {
return true;
}
int minSdk = context.getMainProject().getMinSdk();
return minSdk == 9 || minSdk == 10;
}
private static float getMdpiScalingFactor(String folderName) {
// Can't do startsWith(DRAWABLE_MDPI) because the folder could
// be something like "drawable-sw600dp-mdpi".
if (folderName.contains("-mdpi")) { //$NON-NLS-1$
return 1.0f;
} else if (folderName.contains("-hdpi")) { //$NON-NLS-1$
return 1.5f;
} else if (folderName.contains("-xhdpi")) { //$NON-NLS-1$
return 2.0f;
} else if (folderName.contains("-xxhdpi")) { //$NON-NLS-1$
return 3.0f;
} else if (folderName.contains("-xxxhdpi")) { //$NON-NLS-1$
return 4.0f;
} else if (folderName.contains("-ldpi")) { //$NON-NLS-1$
return 0.75f;
} else {
return 0f;
}
}
private static void checkSize(Context context, String folderName, File file,
int mdpiWidth, int mdpiHeight, boolean exactMatch) {
String fileName = file.getName();
// Only scan .png files (except 9-patch png's) and jpg files
if (!((endsWith(fileName, DOT_PNG) && !endsWith(fileName, DOT_9PNG)) ||
endsWith(fileName, DOT_JPG) || endsWith(fileName, DOT_JPEG))) {
return;
}
int width;
int height;
// Use 3:4:6:8 scaling ratio to look up the other expected sizes
if (folderName.startsWith(DRAWABLE_MDPI)) {
width = mdpiWidth;
height = mdpiHeight;
} else if (folderName.startsWith(DRAWABLE_HDPI)) {
// Perform math using floating point; if we just do
// width = mdpiWidth * 3 / 2;
// then for mdpiWidth = 25 (as in notification icons on pre-GB) we end up
// with width = 37, instead of 38 (with floating point rounding we get 37.5 = 38)
width = Math.round(mdpiWidth * 3.f / 2);
height = Math.round(mdpiHeight * 3f / 2);
} else if (folderName.startsWith(DRAWABLE_XHDPI)) {
width = mdpiWidth * 2;
height = mdpiHeight * 2;
} else if (folderName.startsWith(DRAWABLE_XXHDPI)) {
width = mdpiWidth * 3;
height = mdpiWidth * 3;
} else if (folderName.startsWith(DRAWABLE_LDPI)) {
width = Math.round(mdpiWidth * 3f / 4);
height = Math.round(mdpiHeight * 3f / 4);
} else {
return;
}
Dimension size = getSize(file);
if (size != null) {
if (exactMatch && (size.width != width || size.height != height)) {
context.report(
ICON_EXPECTED_SIZE,
Location.create(file),
String.format(
"Incorrect icon size for `%1$s`: expected %2$dx%3$d, but was %4$dx%5$d",
folderName + File.separator + file.getName(),
width, height, size.width, size.height));
} else if (!exactMatch && (size.width > width || size.height > height)) {
context.report(
ICON_EXPECTED_SIZE,
Location.create(file),
String.format(
"Incorrect icon size for `%1$s`: icon size should be at most %2$dx%3$d, but was %4$dx%5$d",
folderName + File.separator + file.getName(),
width, height, size.width, size.height));
}
}
}
private static Dimension getSize(File file) {
try {
ImageInputStream input = ImageIO.createImageInputStream(file);
if (input != null) {
try {
Iterator<ImageReader> readers = ImageIO.getImageReaders(input);
if (readers.hasNext()) {
ImageReader reader = readers.next();
try {
reader.setInput(input);
return new Dimension(reader.getWidth(0), reader.getHeight(0));
} finally {
reader.dispose();
}
}
} finally {
input.close();
}
}
// Fallback: read the image using the normal means
BufferedImage image = ImageIO.read(file);
if (image != null) {
return new Dimension(image.getWidth(), image.getHeight());
} else {
return null;
}
} catch (IOException e) {
// Pass -- we can't handle all image types, warn about those we can
return null;
}
}
private Set<String> mActionBarIcons;
private Set<String> mNotificationIcons;
private Set<String> mLauncherIcons;
private Multimap<String, String> mMenuToIcons;
private boolean isLauncherIcon(String name) {
assert name.indexOf('.') == -1 : name; // Should supply base name
// Naming convention
//noinspection SimplifiableIfStatement
if (name.startsWith("ic_launcher")) { //$NON-NLS-1$
return true;
}
return mLauncherIcons != null && mLauncherIcons.contains(name);
}
private boolean isNotificationIcon(String name) {
assert name.indexOf('.') == -1; // Should supply base name
// Naming convention
//noinspection SimplifiableIfStatement
if (name.startsWith("ic_stat_")) { //$NON-NLS-1$
return true;
}
return mNotificationIcons != null && mNotificationIcons.contains(name);
}
private boolean isActionBarIcon(String name) {
assert name.indexOf('.') == -1; // Should supply base name
// Naming convention
//noinspection SimplifiableIfStatement
if (name.startsWith("ic_action_")) { //$NON-NLS-1$
return true;
}
// Naming convention
return mActionBarIcons != null && mActionBarIcons.contains(name);
}
private boolean isActionBarIcon(Context context, String name, File file) {
if (isActionBarIcon(name)) {
return true;
}
// As of Android 3.0 ic_menu_ are action icons
//noinspection SimplifiableIfStatement,RedundantIfStatement
if (file != null && name.startsWith("ic_menu_") //$NON-NLS-1$
&& isAndroid30(context, context.getDriver().getResourceFolderVersion(file))) {
// Naming convention
return true;
}
return false;
}
// XML detector: Skim manifest and menu files
@Override
public boolean appliesTo(@NonNull Context context, @NonNull File file) {
return file.getName().equals(ANDROID_MANIFEST_XML);
}
@Override
public boolean appliesTo(@NonNull ResourceFolderType folderType) {
return folderType == ResourceFolderType.MENU;
}
@Override
public Collection<String> getApplicableElements() {
return Arrays.asList(
// Manifest
TAG_APPLICATION,
TAG_ACTIVITY,
TAG_SERVICE,
TAG_PROVIDER,
TAG_RECEIVER,
// Menu
TAG_ITEM
);
}
@Override
public void visitElement(@NonNull XmlContext context, @NonNull Element element) {
String icon = element.getAttributeNS(ANDROID_URI, ATTR_ICON);
if (icon != null && icon.startsWith(DRAWABLE_PREFIX)) {
icon = icon.substring(DRAWABLE_PREFIX.length());
String tagName = element.getTagName();
if (tagName.equals(TAG_ITEM)) {
if (mMenuToIcons == null) {
mMenuToIcons = ArrayListMultimap.create();
}
String menu = getBaseName(context.file.getName());
mMenuToIcons.put(menu, icon);
} else {
// Manifest tags: launcher icons
if (mLauncherIcons == null) {
mLauncherIcons = Sets.newHashSet();
}
mLauncherIcons.add(icon);
}
}
}
// ---- Implements UastScanner ----
private static final String NOTIFICATION_CLASS = "android.app.Notification";
private static final String NOTIFICATION_BUILDER_CLASS = "android.app.Notification.Builder";
private static final String NOTIFICATION_COMPAT_BUILDER_CLASS =
"android.support.v4.app.NotificationCompat.Builder";
private static final String SET_SMALL_ICON = "setSmallIcon";
private static final String ON_CREATE_OPTIONS_MENU = "onCreateOptionsMenu";
@Nullable
@Override
public List<Class<? extends UElement>> getApplicableUastTypes() {
List<Class<? extends UElement>> types = new ArrayList<Class<? extends UElement>>(2);
types.add(UCallExpression.class);
types.add(UMethod.class);
return types;
}
@Nullable
@Override
public UastVisitor createUastVisitor(@NonNull JavaContext context) {
return new NotificationFinder(context);
}
private final class NotificationFinder extends AbstractUastVisitor {
private final JavaContext mContext;
private NotificationFinder(JavaContext context) {
mContext = context;
}
@Override
public boolean visitMethod(UMethod method) {
if (ON_CREATE_OPTIONS_MENU.equals(method.getName())) {
// Gather any R.menu references found in this method
method.accept(new MenuFinder());
}
return super.visitMethod(method);
}
@Override
public boolean visitCallExpression(UCallExpression node) {
if (UastExpressionUtils.isConstructorCall(node)) {
visitConstructorCall(node);
}
return super.visitCallExpression(node);
}
private void visitConstructorCall(UCallExpression node) {
UReferenceExpression classReference = node.getClassReference();
if (classReference == null) {
return;
}
PsiElement resolved = classReference.resolve();
if (!(resolved instanceof PsiClass)) {
return;
}
String typeName = ((PsiClass) resolved).getQualifiedName();
if (NOTIFICATION_CLASS.equals(typeName)) {
List<UExpression> args = node.getValueArguments();
if (args.size() == 3) {
if (args.get(0) instanceof UReferenceExpression && handleSelect(args.get(0))) {
return;
}
ResourceUrl url = ResourceEvaluator.getResource(mContext, args.get(0));
if (url != null
&& (url.type == ResourceType.DRAWABLE
|| url.type == ResourceType.COLOR
|| url.type == ResourceType.MIPMAP)) {
if (mNotificationIcons == null) {
mNotificationIcons = Sets.newHashSet();
}
mNotificationIcons.add(url.name);
}
}
} else if (NOTIFICATION_BUILDER_CLASS.equals(typeName)
|| NOTIFICATION_COMPAT_BUILDER_CLASS.equals(typeName)) {
UMethod method = UastUtils.getParentOfType(node, UMethod.class, true);
if (method != null) {
SetIconFinder finder = new SetIconFinder();
method.accept(finder);
}
}
}
}
private boolean handleSelect(UElement select) {
ResourceUrl url = ResourceEvaluator.getResourceConstant(select);
if (url != null && url.type == ResourceType.DRAWABLE && !url.framework) {
if (mNotificationIcons == null) {
mNotificationIcons = Sets.newHashSet();
}
mNotificationIcons.add(url.name);
return true;
}
return false;
}
private final class SetIconFinder extends AbstractUastVisitor {
@Override
public boolean visitCallExpression(UCallExpression expression) {
if (UastExpressionUtils.isMethodCall(expression)) {
if (SET_SMALL_ICON.equals(expression.getMethodName())) {
List<UExpression> arguments = expression.getValueArguments();
if (arguments.size() == 1 && arguments.get(0) instanceof UReferenceExpression) {
handleSelect(arguments.get(0));
}
}
}
return super.visitCallExpression(expression);
}
@Override
public boolean visitClass(UClass node) {
if (node instanceof UAnonymousClass) {
return true;
}
return super.visitClass(node);
}
}
private final class MenuFinder extends AbstractUastVisitor {
@Override
public boolean visitSimpleNameReferenceExpression(USimpleNameReferenceExpression node) {
ResourceUrl url = ResourceEvaluator.getResourceConstant(node);
if (url != null && url.type == ResourceType.MENU && !url.framework) {
// Reclassify icons in the given menu as action bar icons
if (mMenuToIcons != null) {
Collection<String> icons = mMenuToIcons.get(url.name);
if (icons != null) {
if (mActionBarIcons == null) {
mActionBarIcons = Sets.newHashSet();
}
mActionBarIcons.addAll(icons);
}
}
}
return super.visitSimpleNameReferenceExpression(node);
}
}
}