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.queries.StringQuery;
33 import com.android.queryable.queries.StringQueryHelper;
34 import com.android.queryable.util.SerializableParcelWrapper;
35 
36 import com.google.errorprone.annotations.CanIgnoreReturnValue;
37 
38 /**
39  * Event logged when {@link DeviceAdminReceiver#onBugreportShared(Context, Intent, String)}
40  * is called.
41  */
42 public final class DeviceAdminBugreportSharedEvent extends Event {
43 
44     private static final long serialVersionUID = 1;
45 
46     /** Begins a query for {@link DeviceAdminBugreportSharedEvent} events. */
queryPackage(String packageName)47     public static DeviceAdminBugreportSharedEventQuery queryPackage(String packageName) {
48         return new DeviceAdminBugreportSharedEventQuery(packageName);
49     }
50 
51     /** {@link EventLogsQuery} for {@link DeviceAdminBugreportSharedEvent}. */
52     public static final class DeviceAdminBugreportSharedEventQuery
53             extends EventLogsQuery<DeviceAdminBugreportSharedEvent,
54             DeviceAdminBugreportSharedEventQuery> {
55 
56         private static final long serialVersionUID = 1;
57 
58         DeviceAdminReceiverQueryHelper<DeviceAdminBugreportSharedEventQuery> mDeviceAdminReceiver =
59                 new DeviceAdminReceiverQueryHelper<>(this);
60         IntentQueryHelper<DeviceAdminBugreportSharedEventQuery> mIntent =
61                 new IntentQueryHelper<>(this);
62         StringQueryHelper<DeviceAdminBugreportSharedEventQuery> mBugreportHash =
63                 new StringQueryHelper<>(this);
64 
DeviceAdminBugreportSharedEventQuery(String packageName)65         private DeviceAdminBugreportSharedEventQuery(String packageName) {
66             super(DeviceAdminBugreportSharedEvent.class, packageName);
67         }
68 
69         /**
70          * Queries {@link Intent} passed into
71          * {@link DeviceAdminReceiver#onBugreportShared(Context, Intent, String)}.
72          */
73         @CheckResult
whereIntent()74         public IntentQueryHelper<DeviceAdminBugreportSharedEventQuery> whereIntent() {
75             return mIntent;
76         }
77 
78         /** Queries {@link DeviceAdminReceiver}. */
79         @CheckResult
whereDeviceAdminReceiver()80         public DeviceAdminReceiverQuery<DeviceAdminBugreportSharedEventQuery> whereDeviceAdminReceiver() {
81             return mDeviceAdminReceiver;
82         }
83 
84         /** Queries {@code bugReportHash}. */
85         @CheckResult
whereBugreportHash()86         public StringQuery<DeviceAdminBugreportSharedEventQuery> whereBugreportHash() {
87             return mBugreportHash;
88         }
89 
90         @Override
filter(DeviceAdminBugreportSharedEvent event)91         protected boolean filter(DeviceAdminBugreportSharedEvent event) {
92             if (!mIntent.matches(event.mIntent)) {
93                 return false;
94             }
95             if (!mDeviceAdminReceiver.matches(event.mDeviceAdminReceiver)) {
96                 return false;
97             }
98             if (!mBugreportHash.matches(event.mBugreportHash)) {
99                 return false;
100             }
101             return true;
102         }
103 
104         @Override
describeQuery(String fieldName)105         public String describeQuery(String fieldName) {
106             return toStringBuilder(DeviceAdminBugreportSharedEvent.class, this)
107                     .field("intent", mIntent)
108                     .field("deviceAdminReceiver", mDeviceAdminReceiver)
109                     .field("bugReportHash", mBugreportHash)
110                     .toString();
111         }
112     }
113 
114     /** Begins logging a {@link DeviceAdminBugreportSharedEvent}. */
logger( DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent, String bugreportHash)115     public static DeviceAdminBugreportSharedEventLogger logger(
116             DeviceAdminReceiver deviceAdminReceiver,
117             Context context, Intent intent, String bugreportHash) {
118         return new DeviceAdminBugreportSharedEventLogger(
119                 deviceAdminReceiver, context, intent, bugreportHash);
120     }
121 
122     /** {@link EventLogger} for {@link DeviceAdminBugreportSharedEvent}. */
123     public static final class DeviceAdminBugreportSharedEventLogger
124             extends EventLogger<DeviceAdminBugreportSharedEvent> {
DeviceAdminBugreportSharedEventLogger( DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent, String bugreportHash)125         private DeviceAdminBugreportSharedEventLogger(
126                 DeviceAdminReceiver deviceAdminReceiver,
127                 Context context, Intent intent, String bugreportHash) {
128             super(context, new DeviceAdminBugreportSharedEvent());
129             mEvent.mIntent = new SerializableParcelWrapper<>(intent);
130             mEvent.mBugreportHash = bugreportHash;
131             setDeviceAdminReceiver(deviceAdminReceiver);
132         }
133 
134         /** Sets the {@link DeviceAdminReceiver} which received this event. */
135         @CanIgnoreReturnValue
setDeviceAdminReceiver( DeviceAdminReceiver deviceAdminReceiver)136         public DeviceAdminBugreportSharedEventLogger setDeviceAdminReceiver(
137                 DeviceAdminReceiver deviceAdminReceiver) {
138             mEvent.mDeviceAdminReceiver = new DeviceAdminReceiverInfo(deviceAdminReceiver);
139             return this;
140         }
141 
142         /** Sets the {@link DeviceAdminReceiver} which received this event. */
setDeviceAdminReceiver( Class<? extends DeviceAdminReceiver> deviceAdminReceiverClass)143         public DeviceAdminBugreportSharedEventLogger setDeviceAdminReceiver(
144                 Class<? extends DeviceAdminReceiver> deviceAdminReceiverClass) {
145             mEvent.mDeviceAdminReceiver = new DeviceAdminReceiverInfo(deviceAdminReceiverClass);
146             return this;
147         }
148 
149         /** Sets the {@link DeviceAdminReceiver} which received this event. */
150         @CanIgnoreReturnValue
setDeviceAdminReceiver( String deviceAdminReceiverClassName)151         public DeviceAdminBugreportSharedEventLogger setDeviceAdminReceiver(
152                 String deviceAdminReceiverClassName) {
153             mEvent.mDeviceAdminReceiver = new DeviceAdminReceiverInfo(deviceAdminReceiverClassName);
154             return this;
155         }
156 
157         /** Sets the {@link Intent} which was received. */
setIntent(Intent intent)158         public DeviceAdminBugreportSharedEventLogger setIntent(Intent intent) {
159             mEvent.mIntent = new SerializableParcelWrapper<>(intent);
160             return this;
161         }
162 
163         /** Sets the {@code bugreportHash} which was received. */
setBugreportHash(String bugreportHash)164         public DeviceAdminBugreportSharedEventLogger setBugreportHash(String bugreportHash) {
165             mEvent.mBugreportHash = bugreportHash;
166             return this;
167         }
168     }
169 
170     protected SerializableParcelWrapper<Intent> mIntent;
171     protected DeviceAdminReceiverInfo mDeviceAdminReceiver;
172     protected String mBugreportHash;
173 
174     /**
175      * The {@link Intent} passed into
176      * {@link DeviceAdminReceiver#onBugreportShared(Context, Intent, String)}.
177      */
intent()178     public Intent intent() {
179         if (mIntent == null) {
180             return null;
181         }
182         return mIntent.get();
183     }
184 
185     /** Information about the {@link DeviceAdminReceiver} which received the intent. */
deviceAdminReceiver()186     public DeviceAdminReceiverInfo deviceAdminReceiver() {
187         return mDeviceAdminReceiver;
188     }
189 
190     /**
191      * The {@code bugreportHash} passed into
192      * {@link DeviceAdminReceiver#onBugreportShared(Context, Intent, String)}.
193      */
bugreportHash()194     public String bugreportHash() {
195         return mBugreportHash;
196     }
197 
198     @Override
toString()199     public String toString() {
200         return "DeviceAdminBugreportSharedEvent{"
201                 + " intent=" + intent()
202                 + ", bugreportHash=" + mBugreportHash
203                 + ", deviceAdminReceiver=" + mDeviceAdminReceiver
204                 + ", packageName='" + mPackageName + "'"
205                 + ", timestamp=" + mTimestamp
206                 + "}";
207     }
208 }
209