1 /*
2  * Copyright (C) 2021 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.eventlib.events.deviceadminreceivers;
18 
19 import android.app.admin.DeviceAdminReceiver;
20 import android.content.Context;
21 import android.content.Intent;
22 
23 import androidx.annotation.CheckResult;
24 
25 import com.android.eventlib.Event;
26 import com.android.eventlib.EventLogger;
27 import com.android.eventlib.EventLogsQuery;
28 import com.android.queryable.info.DeviceAdminReceiverInfo;
29 import com.android.queryable.queries.DeviceAdminReceiverQuery;
30 import com.android.queryable.queries.DeviceAdminReceiverQueryHelper;
31 import com.android.queryable.queries.IntentQueryHelper;
32 import com.android.queryable.util.SerializableParcelWrapper;
33 
34 import com.google.errorprone.annotations.CanIgnoreReturnValue;
35 
36 /**
37  * Event logged when {@link DeviceAdminReceiver#onEnabled(Context, Intent)} is called.
38  */
39 public final class DeviceAdminEnabledEvent extends Event {
40 
41     private static final long serialVersionUID = 1;
42 
43     /** Begins a query for {@link DeviceAdminEnabledEvent} events. */
queryPackage(String packageName)44     public static DeviceAdminEnabledEventQuery queryPackage(String packageName) {
45         return new DeviceAdminEnabledEventQuery(packageName);
46     }
47 
48     /** {@link EventLogsQuery} for {@link DeviceAdminEnabledEvent}. */
49     public static final class DeviceAdminEnabledEventQuery
50             extends EventLogsQuery<DeviceAdminEnabledEvent, DeviceAdminEnabledEventQuery> {
51 
52         private static final long serialVersionUID = 1;
53 
54         DeviceAdminReceiverQueryHelper<DeviceAdminEnabledEventQuery> mDeviceAdminReceiver =
55                 new DeviceAdminReceiverQueryHelper<>(this);
56         IntentQueryHelper<DeviceAdminEnabledEventQuery> mIntent = new IntentQueryHelper<>(this);
57 
DeviceAdminEnabledEventQuery(String packageName)58         private DeviceAdminEnabledEventQuery(String packageName) {
59             super(DeviceAdminEnabledEvent.class, packageName);
60         }
61 
62         /**
63          * Queries {@link Intent} passed into {@link DeviceAdminReceiver#onEnabled(Context, Intent)}.
64          */
65         @CheckResult
whereIntent()66         public IntentQueryHelper<DeviceAdminEnabledEventQuery> whereIntent() {
67             return mIntent;
68         }
69 
70         /** Queries {@link DeviceAdminReceiver}. */
71         @CheckResult
whereDeviceAdminReceiver()72         public DeviceAdminReceiverQuery<DeviceAdminEnabledEventQuery> whereDeviceAdminReceiver() {
73             return mDeviceAdminReceiver;
74         }
75 
76         @Override
filter(DeviceAdminEnabledEvent event)77         protected boolean filter(DeviceAdminEnabledEvent event) {
78             if (!mIntent.matches(event.mIntent)) {
79                 return false;
80             }
81             if (!mDeviceAdminReceiver.matches(event.mDeviceAdminReceiver)) {
82                 return false;
83             }
84             return true;
85         }
86 
87         @Override
describeQuery(String fieldName)88         public String describeQuery(String fieldName) {
89             return toStringBuilder(DeviceAdminEnabledEvent.class, this)
90                     .field("intent", mIntent)
91                     .field("deviceAdminReceiver", mDeviceAdminReceiver)
92                     .toString();
93         }
94     }
95 
96     /** Begins logging a {@link DeviceAdminEnabledEvent}. */
logger( DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent)97     public static DeviceAdminEnabledEventLogger logger(
98             DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent) {
99         return new DeviceAdminEnabledEventLogger(deviceAdminReceiver, context, intent);
100     }
101 
102     /** {@link EventLogger} for {@link DeviceAdminEnabledEvent}. */
103     public static final class DeviceAdminEnabledEventLogger
104             extends EventLogger<DeviceAdminEnabledEvent> {
DeviceAdminEnabledEventLogger( DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent)105         private DeviceAdminEnabledEventLogger(
106                 DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent) {
107             super(context, new DeviceAdminEnabledEvent());
108             mEvent.mIntent = new SerializableParcelWrapper<>(intent);
109             setDeviceAdminReceiver(deviceAdminReceiver);
110         }
111 
112         /** Sets the {@link DeviceAdminReceiver} which received this event. */
113         @CanIgnoreReturnValue
setDeviceAdminReceiver( DeviceAdminReceiver deviceAdminReceiver)114         public DeviceAdminEnabledEventLogger setDeviceAdminReceiver(
115                 DeviceAdminReceiver deviceAdminReceiver) {
116             mEvent.mDeviceAdminReceiver = new DeviceAdminReceiverInfo(deviceAdminReceiver);
117             return this;
118         }
119 
120         /** Sets the {@link DeviceAdminReceiver} which received this event. */
setDeviceAdminReceiver( Class<? extends DeviceAdminReceiver> deviceAdminReceiverClass)121         public DeviceAdminEnabledEventLogger setDeviceAdminReceiver(
122                 Class<? extends DeviceAdminReceiver> deviceAdminReceiverClass) {
123             mEvent.mDeviceAdminReceiver = new DeviceAdminReceiverInfo(deviceAdminReceiverClass);
124             return this;
125         }
126 
127         /** Sets the {@link DeviceAdminReceiver} which received this event. */
128         @CanIgnoreReturnValue
setDeviceAdminReceiver( String deviceAdminReceiverClassName)129         public DeviceAdminEnabledEventLogger setDeviceAdminReceiver(
130                 String deviceAdminReceiverClassName) {
131             mEvent.mDeviceAdminReceiver = new DeviceAdminReceiverInfo(deviceAdminReceiverClassName);
132             return this;
133         }
134 
135         /** Sets the {@link Intent} which was received. */
136         @CanIgnoreReturnValue
setIntent(Intent intent)137         public DeviceAdminEnabledEventLogger setIntent(Intent intent) {
138             mEvent.mIntent = new SerializableParcelWrapper<>(intent);
139             return this;
140         }
141     }
142 
143     protected SerializableParcelWrapper<Intent> mIntent;
144     protected DeviceAdminReceiverInfo mDeviceAdminReceiver;
145 
146     /**
147      * The {@link Intent} passed into {@link DeviceAdminReceiver#onEnabled(Context, Intent)}.
148      */
intent()149     public Intent intent() {
150         if (mIntent == null) {
151             return null;
152         }
153         return mIntent.get();
154     }
155 
156     /** Information about the {@link DeviceAdminReceiver} which received the intent. */
deviceAdminReceiver()157     public DeviceAdminReceiverInfo deviceAdminReceiver() {
158         return mDeviceAdminReceiver;
159     }
160 
161     @Override
toString()162     public String toString() {
163         return "DeviceAdminEnabledEvent{"
164                 + " intent=" + intent()
165                 + ", deviceAdminReceiver=" + mDeviceAdminReceiver
166                 + ", packageName='" + mPackageName + "'"
167                 + ", timestamp=" + mTimestamp
168                 + "}";
169     }
170 }
171