summaryrefslogtreecommitdiff
path: root/lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/MediaBrowserServiceCompatVersionDetector.kt
blob: 836b08bd967a94b0244973c0f2dea1d301dc9858 (plain)
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
/*
 * Copyright (C) 2016 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.lint.checks

import com.android.SdkConstants.SUPPORT_LIB_ARTIFACT
import com.android.ide.common.repository.GradleCoordinate
import com.android.ide.common.repository.GradleCoordinate.COMPARE_PLUS_HIGHER
import com.android.tools.lint.detector.api.Category
import com.android.tools.lint.detector.api.Detector
import com.android.tools.lint.detector.api.Implementation
import com.android.tools.lint.detector.api.Issue
import com.android.tools.lint.detector.api.JavaContext
import com.android.tools.lint.detector.api.Scope
import com.android.tools.lint.detector.api.Severity
import com.android.tools.lint.detector.api.SourceCodeScanner
import com.android.tools.lint.model.LintModelExternalLibrary
import org.jetbrains.uast.UClass

/** Constructs a new [MediaBrowserServiceCompatVersionDetector] check. */
class MediaBrowserServiceCompatVersionDetector : Detector(), SourceCodeScanner {

  companion object Issues {

    @JvmField
    val ISSUE =
      Issue.create(
        id = "IncompatibleMediaBrowserServiceCompatVersion",
        briefDescription = "Obsolete version of MediaBrowserServiceCompat",
        explanation =
          """
            `MediaBrowserServiceCompat` from version 23.2.0 to 23.4.0 of the Support v4 Library \
            used private APIs and will not be compatible with future versions of Android beyond Android N. \
            Please upgrade to version 24.0.0 or higher of the Support Library.""",
        category = Category.CORRECTNESS,
        priority = 6,
        severity = Severity.WARNING,
        androidSpecific = true,
        implementation =
          Implementation(
            MediaBrowserServiceCompatVersionDetector::class.java,
            Scope.JAVA_FILE_SCOPE
          )
      )

    /**
     * Minimum recommended support library version that has the necessary fixes to ensure that
     * MediaBrowserServiceCompat is forward compatible with N.
     */
    val MIN_SUPPORT_V4_VERSION: GradleCoordinate = GradleCoordinate.parseVersionOnly("24.0.0")

    const val MEDIA_BROWSER_SERVICE_COMPAT = "android.support.v4.media.MediaBrowserServiceCompat"
  }

  override fun applicableSuperClasses(): List<String> {
    return listOf(MEDIA_BROWSER_SERVICE_COMPAT)
  }

  override fun visitClass(context: JavaContext, declaration: UClass) {
    if (!context.evaluator.extendsClass(declaration, MEDIA_BROWSER_SERVICE_COMPAT, true)) {
      return
    }

    val library =
      context.project.buildVariant?.mainArtifact?.findCompileDependency(SUPPORT_LIB_ARTIFACT)
        as? LintModelExternalLibrary
        ?: return
    val mc = library.resolvedCoordinates
    if (mc.version.isNotBlank()) {
      val libVersion = GradleCoordinate.parseVersionOnly(mc.version)
      if (COMPARE_PLUS_HIGHER.compare(libVersion, MIN_SUPPORT_V4_VERSION) < 0) {
        val location = GradleDetector.getDependencyLocation(context, mc)
        val message = "Using a version of the class that is not forward compatible"
        context.report(ISSUE, location, message)
      }
    }
  }
}