summaryrefslogtreecommitdiff
path: root/google-login-plugin/src/com/google/gct/login2/LoginFeature.kt
blob: 60e22ed065adb411155b4cbc3354646afe30ebb0 (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) 2023 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.google.gct.login2

import com.google.api.client.auth.oauth2.Credential
import com.intellij.openapi.actionSystem.AnAction
import com.intellij.openapi.extensions.ExtensionPointName
import javax.swing.JComponent

/**
 * Extension representing a feature that requires google login with certain [oAuthScopes]. The
 * feature will show up on the login settings page, where it can be individually enabled.
 */
interface LoginFeature {
  companion object {
    val EP_NAME = ExtensionPointName<LoginFeature>("com.google.gct.login.googleLoginFeature")

    fun getExtensionByName(name: String): LoginFeature? {
      return EP_NAME.extensionList.firstOrNull { it.name == name }
    }

    inline fun <reified T : LoginFeature> feature(): T =
      EP_NAME.findExtension(T::class.java)
        ?: throw RuntimeException(
          "Couldn't find ${T::class}. Is your extension registered properly?"
        )
  }

  val name: String
  val description: String
  val infoUrl: String?
  val infoUrlDisplayText: String?
  val settingsAction: AnAction?
  val oAuthScopes: Collection<String>
  val isInternal: Boolean
    get() = false

  fun credential(): Credential? = GoogleLoginService.instance.getCredential(this)

  fun isLoggedIn() = GoogleLoginService.instance.isLoggedIn(this)

  fun logInAsync(
    preferredUser: PreferredUser = PreferredUser.ActiveUser,
    parentComponent: JComponent? = null,
  ) =
    GoogleLoginService.instance.logInAsync(
      features = setOf(this),
      preferredUser = preferredUser,
      parentComponent = parentComponent,
    )
}

class UserInfoEnforcedFeature : LoginFeature {
  override val name: String
    get() = NAME

  override val description: String
    get() = "This is for getting user info (email)."

  override val infoUrl: String?
    get() = null

  override val infoUrlDisplayText: String?
    get() = null

  override val settingsAction: AnAction?
    get() = null

  override val oAuthScopes: Collection<String>
    get() = setOf("https://www.googleapis.com/auth/userinfo.email")

  override val isInternal = true

  companion object {
    internal const val NAME = "User Info"
  }
}