java/com/android/dialer/util/PermissionsUtil.java - LeafOS-Project/android_packages_apps_Dialer - Gitiles

 /*
  * Copyright (C) 2015 The Android Open Source Project
  * Copyright (C) 2023 The LineageOS 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.dialer.util;

 import static android.Manifest.permission.ACCESS_COARSE_LOCATION;
 import static android.Manifest.permission.ACCESS_FINE_LOCATION;
 import static android.Manifest.permission.ADD_VOICEMAIL;
 import static android.Manifest.permission.CALL_PHONE;
 import static android.Manifest.permission.MODIFY_PHONE_STATE;
 import static android.Manifest.permission.READ_CALL_LOG;
 import static android.Manifest.permission.READ_CONTACTS;
 import static android.Manifest.permission.READ_PHONE_STATE;
 import static android.Manifest.permission.READ_VOICEMAIL;
 import static android.Manifest.permission.RECEIVE_SMS;
 import static android.Manifest.permission.SEND_SMS;
 import static android.Manifest.permission.WRITE_CALL_LOG;
 import static android.Manifest.permission.WRITE_CONTACTS;
 import static android.Manifest.permission.WRITE_VOICEMAIL;

 import android.Manifest.permission;
 import android.content.BroadcastReceiver;
 import android.content.Context;
 import android.content.Intent;
 import android.content.IntentFilter;
 import android.content.pm.PackageManager;
 import android.widget.Toast;

 import androidx.annotation.NonNull;
 import androidx.core.content.ContextCompat;
 import androidx.localbroadcastmanager.content.LocalBroadcastManager;

 import com.android.dialer.R;
 import com.android.dialer.common.LogUtil;
 import com.android.dialer.storage.StorageComponent;

 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;

 /** Utility class to help with runtime permissions. */
 public class PermissionsUtil {

   private static final String PREFERENCE_CAMERA_ALLOWED_BY_USER = "camera_allowed_by_user";

   private static final String PERMISSION_PREFERENCE = "dialer_permissions";
   private static final String CEQUINT_PERMISSION = "com.cequint.ecid.CALLER_ID_LOOKUP";

   // Permissions list retrieved from application manifest.
   // Starting in Android O Permissions must be explicitly enumerated:
   // https://developer.android.com/preview/behavior-changes.html#rmp
   public static final List<String> allPhoneGroupPermissionsUsedInDialer =
       Collections.unmodifiableList(
           Arrays.asList(
               READ_CALL_LOG,
               WRITE_CALL_LOG,
               READ_PHONE_STATE,
               MODIFY_PHONE_STATE,
               RECEIVE_SMS,
               SEND_SMS,
               CALL_PHONE,
               ADD_VOICEMAIL,
               WRITE_VOICEMAIL,
               READ_VOICEMAIL));

   public static final List<String> allContactsGroupPermissionsUsedInDialer =
       Collections.unmodifiableList(Arrays.asList(READ_CONTACTS, WRITE_CONTACTS));

   public static final List<String> allLocationGroupPermissionsUsedInDialer =
       Collections.unmodifiableList(Arrays.asList(ACCESS_FINE_LOCATION, ACCESS_COARSE_LOCATION));

   public static boolean hasPhonePermissions(Context context) {
     return hasPermission(context, permission.CALL_PHONE);
   }

   public static boolean hasReadPhoneStatePermissions(Context context) {
     return hasPermission(context, permission.READ_PHONE_STATE);
   }

   public static boolean hasModifyPhoneStatePermissions(Context context) {
     return hasPermission(context, MODIFY_PHONE_STATE);
   }

   public static boolean hasContactsReadPermissions(Context context) {
     return hasPermission(context, permission.READ_CONTACTS);
   }

   public static boolean hasContactsWritePermissions(Context context) {
     return hasPermission(context, permission.WRITE_CONTACTS);
   }

   public static boolean hasLocationPermissions(Context context) {
     return hasPermission(context, permission.ACCESS_FINE_LOCATION);
   }

   public static boolean hasCameraPermissions(Context context) {
     return hasPermission(context, permission.CAMERA);
   }

   public static boolean hasMicrophonePermissions(Context context) {
     return hasPermission(context, permission.RECORD_AUDIO);
   }

   public static boolean hasCallLogReadPermissions(Context context) {
     return hasPermission(context, permission.READ_CALL_LOG);
   }

   public static boolean hasCallLogWritePermissions(Context context) {
     return hasPermission(context, permission.WRITE_CALL_LOG);
   }

   public static boolean hasCequintPermissions(Context context) {
     return hasPermission(context, CEQUINT_PERMISSION);
   }

   public static boolean hasReadVoicemailPermissions(Context context) {
     return hasPermission(context, permission.READ_VOICEMAIL);
   }

   public static boolean hasWriteVoicemailPermissions(Context context) {
     return hasPermission(context, permission.WRITE_VOICEMAIL);
   }

   public static boolean hasAddVoicemailPermissions(Context context) {
     return hasPermission(context, permission.ADD_VOICEMAIL);
   }

   public static boolean hasReceiveSmsPermissions(Context context) {
     return hasPermission(context, permission.RECEIVE_SMS);
   }

   public static boolean hasSendSmsPermissions(Context context) {
     return hasPermission(context, permission.SEND_SMS);
   }

   public static boolean hasPermission(Context context, String permission) {
     return ContextCompat.checkSelfPermission(context, permission)
         == PackageManager.PERMISSION_GRANTED;
   }

   /**
    * Checks {@link android.content.SharedPreferences} if a permission has been requested before.
    *
    * <p>It is important to note that this method only works if you call {@link
    * PermissionsUtil#permissionRequested(Context, String)} in {@link
    * android.app.Activity#onRequestPermissionsResult(int, String[], int[])}.
    */
   public static boolean isFirstRequest(Context context, String permission) {
     return context
         .getSharedPreferences(PERMISSION_PREFERENCE, Context.MODE_PRIVATE)
         .getBoolean(permission, true);
   }

   /**
    * Records in {@link android.content.SharedPreferences} that the specified permission has been
    * requested at least once.
    *
    * <p>This method should be called in {@link android.app.Activity#onRequestPermissionsResult(int,
    * String[], int[])}.
    */
   public static void permissionRequested(Context context, String permission) {
     context
         .getSharedPreferences(PERMISSION_PREFERENCE, Context.MODE_PRIVATE)
         .edit()
         .putBoolean(permission, false)
         .apply();
   }

   /**
    * Rudimentary methods wrapping the use of a LocalBroadcastManager to simplify the process of
    * notifying other classes when a particular fragment is notified that a permission is granted.
    *
    * <p>To be notified when a permission has been granted, create a new broadcast receiver and
    * register it using {@link #registerPermissionReceiver(Context, BroadcastReceiver, String)}
    *
    * <p>E.g.
    *
    * <p>final BroadcastReceiver receiver = new BroadcastReceiver() { @Override public void
    * onReceive(Context context, Intent intent) { refreshContactsView(); } }
    *
    * <p>PermissionsUtil.registerPermissionReceiver(getActivity(), receiver, READ_CONTACTS);
    *
    * <p>If you register to listen for multiple permissions, you can identify which permission was
    * granted by inspecting {@link Intent#getAction()}.
    *
    * <p>In the fragment that requests for the permission, be sure to call {@link
    * #notifyPermissionGranted(Context, String)} when the permission is granted so that any
    * interested listeners are notified of the change.
    */
   public static void registerPermissionReceiver(
       Context context, BroadcastReceiver receiver, String permission) {
     LogUtil.i("PermissionsUtil.registerPermissionReceiver", permission);
     final IntentFilter filter = new IntentFilter(permission);
     LocalBroadcastManager.getInstance(context).registerReceiver(receiver, filter);
   }

   public static void unregisterPermissionReceiver(Context context, BroadcastReceiver receiver) {
     LogUtil.i("PermissionsUtil.unregisterPermissionReceiver", null);
     LocalBroadcastManager.getInstance(context).unregisterReceiver(receiver);
   }

   public static void notifyPermissionGranted(Context context, String permission) {
     LogUtil.i("PermissionsUtil.notifyPermissionGranted", permission);
     final Intent intent = new Intent(permission);
     LocalBroadcastManager.getInstance(context).sendBroadcast(intent);
   }

   /**
    * Returns a list of permissions currently not granted to the application from the supplied list.
    *
    * @param context - The Application context.
    * @param permissionsList - A list of permissions to check if the current application has been
    *     granted.
    * @return An array of permissions that are currently DENIED to the application; a subset of
    *     permissionsList.
    */
   @NonNull
   public static String[] getPermissionsCurrentlyDenied(
       @NonNull Context context, @NonNull List<String> permissionsList) {
     List<String> permissionsCurrentlyDenied = new ArrayList<>();
     for (String permission : permissionsList) {
       if (!hasPermission(context, permission)) {
         permissionsCurrentlyDenied.add(permission);
       }
     }
     return permissionsCurrentlyDenied.toArray(new String[0]);
   }

   /**
    * Since we are granted the camera permission automatically as a first-party app, we need to show
    * a toast to let users know the permission was granted for privacy reasons.
    *
    * @return true if we've already shown the camera privacy toast.
    */
   public static boolean hasCameraPrivacyToastShown(@NonNull Context context) {
     return StorageComponent.get(context)
         .unencryptedSharedPrefs()
         .getBoolean(PREFERENCE_CAMERA_ALLOWED_BY_USER, false);
   }

   public static void showCameraPermissionToast(@NonNull Context context) {
     Toast.makeText(context, context.getString(R.string.camera_privacy_text), Toast.LENGTH_LONG)
         .show();
     setCameraPrivacyToastShown(context);
   }

   public static void setCameraPrivacyToastShown(@NonNull Context context) {
     StorageComponent.get(context)
         .unencryptedSharedPrefs()
         .edit()
         .putBoolean(PREFERENCE_CAMERA_ALLOWED_BY_USER, true)
         .apply();
   }
 }
	/*
	* Copyright (C) 2015 The Android Open Source Project
	* Copyright (C) 2023 The LineageOS 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.dialer.util;

	import static android.Manifest.permission.ACCESS_COARSE_LOCATION;
	import static android.Manifest.permission.ACCESS_FINE_LOCATION;
	import static android.Manifest.permission.ADD_VOICEMAIL;
	import static android.Manifest.permission.CALL_PHONE;
	import static android.Manifest.permission.MODIFY_PHONE_STATE;
	import static android.Manifest.permission.READ_CALL_LOG;
	import static android.Manifest.permission.READ_CONTACTS;
	import static android.Manifest.permission.READ_PHONE_STATE;
	import static android.Manifest.permission.READ_VOICEMAIL;
	import static android.Manifest.permission.RECEIVE_SMS;
	import static android.Manifest.permission.SEND_SMS;
	import static android.Manifest.permission.WRITE_CALL_LOG;
	import static android.Manifest.permission.WRITE_CONTACTS;
	import static android.Manifest.permission.WRITE_VOICEMAIL;

	import android.Manifest.permission;
	import android.content.BroadcastReceiver;
	import android.content.Context;
	import android.content.Intent;
	import android.content.IntentFilter;
	import android.content.pm.PackageManager;
	import android.widget.Toast;

	import androidx.annotation.NonNull;
	import androidx.core.content.ContextCompat;
	import androidx.localbroadcastmanager.content.LocalBroadcastManager;

	import com.android.dialer.R;
	import com.android.dialer.common.LogUtil;
	import com.android.dialer.storage.StorageComponent;

	import java.util.ArrayList;
	import java.util.Arrays;
	import java.util.Collections;
	import java.util.List;

	/** Utility class to help with runtime permissions. */
	public class PermissionsUtil {

	private static final String PREFERENCE_CAMERA_ALLOWED_BY_USER = "camera_allowed_by_user";

	private static final String PERMISSION_PREFERENCE = "dialer_permissions";
	private static final String CEQUINT_PERMISSION = "com.cequint.ecid.CALLER_ID_LOOKUP";

	// Permissions list retrieved from application manifest.
	// Starting in Android O Permissions must be explicitly enumerated:
	// https://developer.android.com/preview/behavior-changes.html#rmp
	public static final List<String> allPhoneGroupPermissionsUsedInDialer =
	Collections.unmodifiableList(
	Arrays.asList(
	READ_CALL_LOG,
	WRITE_CALL_LOG,
	READ_PHONE_STATE,
	MODIFY_PHONE_STATE,
	RECEIVE_SMS,
	SEND_SMS,
	CALL_PHONE,
	ADD_VOICEMAIL,
	WRITE_VOICEMAIL,
	READ_VOICEMAIL));

	public static final List<String> allContactsGroupPermissionsUsedInDialer =
	Collections.unmodifiableList(Arrays.asList(READ_CONTACTS, WRITE_CONTACTS));

	public static final List<String> allLocationGroupPermissionsUsedInDialer =
	Collections.unmodifiableList(Arrays.asList(ACCESS_FINE_LOCATION, ACCESS_COARSE_LOCATION));

	public static boolean hasPhonePermissions(Context context) {
	return hasPermission(context, permission.CALL_PHONE);
	}

	public static boolean hasReadPhoneStatePermissions(Context context) {
	return hasPermission(context, permission.READ_PHONE_STATE);
	}

	public static boolean hasModifyPhoneStatePermissions(Context context) {
	return hasPermission(context, MODIFY_PHONE_STATE);
	}

	public static boolean hasContactsReadPermissions(Context context) {
	return hasPermission(context, permission.READ_CONTACTS);
	}

	public static boolean hasContactsWritePermissions(Context context) {
	return hasPermission(context, permission.WRITE_CONTACTS);
	}

	public static boolean hasLocationPermissions(Context context) {
	return hasPermission(context, permission.ACCESS_FINE_LOCATION);
	}

	public static boolean hasCameraPermissions(Context context) {
	return hasPermission(context, permission.CAMERA);
	}

	public static boolean hasMicrophonePermissions(Context context) {
	return hasPermission(context, permission.RECORD_AUDIO);
	}

	public static boolean hasCallLogReadPermissions(Context context) {
	return hasPermission(context, permission.READ_CALL_LOG);
	}

	public static boolean hasCallLogWritePermissions(Context context) {
	return hasPermission(context, permission.WRITE_CALL_LOG);
	}

	public static boolean hasCequintPermissions(Context context) {
	return hasPermission(context, CEQUINT_PERMISSION);
	}

	public static boolean hasReadVoicemailPermissions(Context context) {
	return hasPermission(context, permission.READ_VOICEMAIL);
	}

	public static boolean hasWriteVoicemailPermissions(Context context) {
	return hasPermission(context, permission.WRITE_VOICEMAIL);
	}

	public static boolean hasAddVoicemailPermissions(Context context) {
	return hasPermission(context, permission.ADD_VOICEMAIL);
	}

	public static boolean hasReceiveSmsPermissions(Context context) {
	return hasPermission(context, permission.RECEIVE_SMS);
	}

	public static boolean hasSendSmsPermissions(Context context) {
	return hasPermission(context, permission.SEND_SMS);
	}

	public static boolean hasPermission(Context context, String permission) {
	return ContextCompat.checkSelfPermission(context, permission)
	== PackageManager.PERMISSION_GRANTED;
	}

	/**
	* Checks {@link android.content.SharedPreferences} if a permission has been requested before.
	*
	* <p>It is important to note that this method only works if you call {@link
	* PermissionsUtil#permissionRequested(Context, String)} in {@link
	* android.app.Activity#onRequestPermissionsResult(int, String[], int[])}.
	*/
	public static boolean isFirstRequest(Context context, String permission) {
	return context
	.getSharedPreferences(PERMISSION_PREFERENCE, Context.MODE_PRIVATE)
	.getBoolean(permission, true);
	}

	/**
	* Records in {@link android.content.SharedPreferences} that the specified permission has been
	* requested at least once.
	*
	* <p>This method should be called in {@link android.app.Activity#onRequestPermissionsResult(int,
	* String[], int[])}.
	*/
	public static void permissionRequested(Context context, String permission) {
	context
	.getSharedPreferences(PERMISSION_PREFERENCE, Context.MODE_PRIVATE)
	.edit()
	.putBoolean(permission, false)
	.apply();
	}

	/**
	* Rudimentary methods wrapping the use of a LocalBroadcastManager to simplify the process of
	* notifying other classes when a particular fragment is notified that a permission is granted.
	*
	* <p>To be notified when a permission has been granted, create a new broadcast receiver and
	* register it using {@link #registerPermissionReceiver(Context, BroadcastReceiver, String)}
	*
	* <p>E.g.
	*
	* <p>final BroadcastReceiver receiver = new BroadcastReceiver() { @Override public void
	* onReceive(Context context, Intent intent) { refreshContactsView(); } }
	*
	* <p>PermissionsUtil.registerPermissionReceiver(getActivity(), receiver, READ_CONTACTS);
	*
	* <p>If you register to listen for multiple permissions, you can identify which permission was
	* granted by inspecting {@link Intent#getAction()}.
	*
	* <p>In the fragment that requests for the permission, be sure to call {@link
	* #notifyPermissionGranted(Context, String)} when the permission is granted so that any
	* interested listeners are notified of the change.
	*/
	public static void registerPermissionReceiver(
	Context context, BroadcastReceiver receiver, String permission) {
	LogUtil.i("PermissionsUtil.registerPermissionReceiver", permission);
	final IntentFilter filter = new IntentFilter(permission);
	LocalBroadcastManager.getInstance(context).registerReceiver(receiver, filter);
	}

	public static void unregisterPermissionReceiver(Context context, BroadcastReceiver receiver) {
	LogUtil.i("PermissionsUtil.unregisterPermissionReceiver", null);
	LocalBroadcastManager.getInstance(context).unregisterReceiver(receiver);
	}

	public static void notifyPermissionGranted(Context context, String permission) {
	LogUtil.i("PermissionsUtil.notifyPermissionGranted", permission);
	final Intent intent = new Intent(permission);
	LocalBroadcastManager.getInstance(context).sendBroadcast(intent);
	}

	/**
	* Returns a list of permissions currently not granted to the application from the supplied list.
	*
	* @param context - The Application context.
	* @param permissionsList - A list of permissions to check if the current application has been
	* granted.
	* @return An array of permissions that are currently DENIED to the application; a subset of
	* permissionsList.
	*/
	@NonNull
	public static String[] getPermissionsCurrentlyDenied(
	@NonNull Context context, @NonNull List<String> permissionsList) {
	List<String> permissionsCurrentlyDenied = new ArrayList<>();
	for (String permission : permissionsList) {
	if (!hasPermission(context, permission)) {
	permissionsCurrentlyDenied.add(permission);
	}
	}
	return permissionsCurrentlyDenied.toArray(new String[0]);
	}

	/**
	* Since we are granted the camera permission automatically as a first-party app, we need to show
	* a toast to let users know the permission was granted for privacy reasons.
	*
	* @return true if we've already shown the camera privacy toast.
	*/
	public static boolean hasCameraPrivacyToastShown(@NonNull Context context) {
	return StorageComponent.get(context)
	.unencryptedSharedPrefs()
	.getBoolean(PREFERENCE_CAMERA_ALLOWED_BY_USER, false);
	}

	public static void showCameraPermissionToast(@NonNull Context context) {
	Toast.makeText(context, context.getString(R.string.camera_privacy_text), Toast.LENGTH_LONG)
	.show();
	setCameraPrivacyToastShown(context);
	}

	public static void setCameraPrivacyToastShown(@NonNull Context context) {
	StorageComponent.get(context)
	.unencryptedSharedPrefs()
	.edit()
	.putBoolean(PREFERENCE_CAMERA_ALLOWED_BY_USER, true)
	.apply();
	}
	}