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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
use crate::VarOrBool;

use super::intent_filter::IntentFilter;
use super::meta_data::MetaData;
use super::resources::{
    MipmapOrDrawableResource, Resource, StringResource, StringResourceOrString,
};
use serde::{Deserialize, Serialize};

/// Declares a service (a [`Service`] subclass) as one of the application's components.
///
/// Unlike activities, services lack a visual user interface. They're used to implement
/// long-running background operations or a rich communications API that can be called by
/// other applications. All services must be represented by `<service>` elements in the
/// manifest file. Any that are not declared there will not be seen by the system and will
/// never be run.
///
/// ## Note
/// On Android 8.0 (API level 26) and higher, the system places limitations on what your
/// app can do while it's running in the background. For more information, see the guides
/// that discuss [`background execution limits`] and [`background location limits`].
///
/// ## XML Syntax
/// ```xml
/// <service android:description="string resource"
///          android:directBootAware=["true" | "false"]
///          android:enabled=["true" | "false"]
///          android:exported=["true" | "false"]
///          android:foregroundServiceType=["camera" | "connectedDevice" |
///                                        "dataSync" | "location" | "mediaPlayback" |
///                                        "mediaProjection" | "microphone" | "phoneCall"]
///          android:icon="drawable resource"
///          android:isolatedProcess=["true" | "false"]
///          android:label="string resource"
///          android:name="string"
///          android:permission="string"
///          android:process="string" >
///             ...
/// </service>
/// ```
///
/// ## Contained in
/// * [`<application>`]
///
/// ## Can contain
/// * [`<intent-filter>`]
/// * [`<meta-data>`]
///
/// ## introduced in
/// API Level 1
///
/// [`Service`]: https://developer.android.com/reference/android/app/Service
/// [`background execution limits`]: https://developer.android.com/about/versions/oreo/background
/// [`background location limits`]: https://developer.android.com/about/versions/oreo/background-location-limits
/// [`<application>`]: crate::Application
/// [`<intent-filter>`]: crate::IntentFilter
/// [`<meta-data>`]: crate::MetaData
#[derive(
    Debug, Deserialize, Serialize, YaSerialize, YaDeserialize, PartialEq, Eq, Default, Clone,
)]
pub struct Service {
    /// A string that describes the service to users. The label should be set as a
    /// reference to a string resource, so that it can be localized like other strings
    /// in the user interface.
    #[yaserde(attribute, prefix = "android")]
    pub description: Option<Resource<StringResource>>,
    /// Whether or not the service is direct-boot aware; that is, whether or not it can
    /// run before the user unlocks the device.
    ///
    /// ## Note
    /// During [`Direct Boot`], a service in your application can only access the data
    /// that is stored in device protected storage.
    ///
    /// The default value is `"false"`.
    ///
    /// [`Direct Boot`]: https://developer.android.com/training/articles/direct-boot
    #[yaserde(attribute, prefix = "android", rename = "directBootAware")]
    pub direct_boot_aware: Option<VarOrBool>,
    /// Whether or not the service can be instantiated by the system — `"true"` if it can
    /// be, and `"false"` if not. The default value is `"true"`.
    ///
    /// The [`<application>`] element has its own [`enabled`] attribute that applies to
    /// all application components, including services. The [`<application>`] and
    /// <service> attributes must both be `"true"` (as they both are by default) for
    /// the service to be enabled. If either is `"false"`, the service is disabled; it
    /// cannot be instantiated.
    ///
    /// [`<application>`]: crate::Application
    /// [`enabled`]: crate::Application#structfield.enabled
    #[yaserde(attribute, prefix = "android")]
    pub enabled: Option<VarOrBool>,
    /// Whether or not components of other applications can invoke the service or interact
    /// with it — `"true"` if they can, and `"false"` if not. When the value is
    /// `"false"`, only components of the same application or applications with the
    /// same user ID can start the service or bind to it.
    ///
    /// The default value depends on
    /// whether the service contains intent filters. The absence of any filters means
    /// that it can be invoked only by specifying its exact class name. This implies
    /// that the service is intended only for application-internal use (since others
    /// would not know the class name).So in this case, the default value is
    /// `"false"`. On the other hand, the presence of at least one filter implies that
    /// the service is intended for external use, so the default value is `"true"`.
    ///
    /// This attribute is not the only way to limit the exposure of a service to
    /// other applications. You can also use a permission to limit the
    /// external entities that can interact with the service (see the
    /// [`permission`] attribute).
    ///
    /// [`permission`]: crate::Service#structfield.enabled
    #[yaserde(attribute, prefix = "android")]
    pub exported: Option<VarOrBool>,
    /// Specify that the service is a [`foreground service`] that satisfies a particular
    /// use case. For example, a foreground service type of `"location"` indicates
    /// that an app is getting the device's current location, usually to [`continue a
    /// user-initiated action`] related to device location.
    ///
    /// You can assign multiple foreground service types to a particular service.
    ///
    /// [`foreground service`]: https://developer.android.com/guide/components/services
    /// [`continue a user-initiated action`]: https://developer.android.com/training/location/background#continue-user-initiated-action
    #[yaserde(attribute, prefix = "android", rename = "foregroundServiceType")]
    pub foreground_service_type: Option<ForegroundServiceType>,
    /// An icon representing the service. This attribute must be set as a reference to a
    /// drawable resource containing the image definition. If it is not set, the icon
    /// specified for the application as a whole is used instead (see the
    /// [`<application>`] element's [`icon`](crate::Application#structfield.icon)
    /// attribute).
    ///
    /// The service's icon — whether set here or by the [`<application>`] element — is
    /// also the default icon for all the service's intent filters (see the
    /// [`<intent-filter>`] element's [`icon`](crate::IntentFilter#structfield.icon)
    /// attribute).
    ///
    /// [`<application>`]: crate::Application
    /// [`<intent-filter>`]: crate::IntentFilter
    #[yaserde(attribute, prefix = "android")]
    pub icon: Option<MipmapOrDrawableResource>,
    /// If set to true, this service will run under a special process that is isolated
    /// from the rest of the system and has no permissions of its own.
    /// The only communication with it is through the Service API (binding and
    /// starting).
    #[yaserde(attribute, prefix = "android", rename = "isolatedProcess")]
    pub isolated_process: Option<VarOrBool>,
    /// A name for the service that can be displayed to users. If this attribute is not
    /// set, the label set for the application as a whole is used instead
    /// (see the [`<application>`] element's
    /// [`label`](crate::Application#structfield.label) attribute).
    ///
    /// The service's label — whether set here or by the [`<application>`] element — is
    /// also the default label for all the service's intent filters (see the
    /// [`<intent-filter>`] element's [`label`](crate::IntentFilter#structfield.label)
    /// attribute).
    ///
    /// The label should be set as a reference to a string resource, so that it can be
    /// localized like other strings in the user interface. However, as a convenience
    /// while you're developing the application, it can also be set as a raw string.
    ///
    /// [`<application>`]: crate::Application
    /// [`<intent-filter>`]: crate::IntentFilter
    #[yaserde(attribute, prefix = "android")]
    pub label: Option<StringResourceOrString>,
    /// The name of the [`Service`] subclass that implements the service. This should be a
    /// fully qualified class name (such as, `"com.example.project.RoomService"`).
    /// However, as a shorthand, if the first character of the name is a period (for
    /// example, `".RoomService"`), it is appended to the package name specified in
    /// the [`<manifest>`] element.
    ///
    /// Once you publish your application, you [`should not change this name`] (unless
    /// you've set [`android:exported="false"`]).
    ///
    /// There is no default. The name must be specified.
    ///
    /// [`Service`]: https://developer.android.com/reference/android/app/Service
    /// [`<manifest>`]: crate::AndroidManifest
    /// [`should not change this name`]: https://android-developers.googleblog.com/2011/06/things-that-cannot-change.html
    /// [`android:exported="false"`]: crate::Service#structfield.exported
    #[yaserde(attribute, prefix = "android")]
    pub name: String,
    /// The name of a permission that an entity must have in order to launch the service
    /// or bind to it. If a caller of [`startService()`], [`bindService()`],
    /// or [`stopService()`] has not been granted this permission, the method
    /// will not work and the Intent object will not be delivered to the
    /// service.
    ///
    /// If this attribute is not set, the permission set by the [`<application>`]
    /// element's [`permission`] attribute applies to the service. If neither
    /// attribute is set, the service is not protected by a permission.
    ///
    /// For more information on permissions, see the [`Permissions`] section in the
    /// introduction and a separate document, [`Security and Permissions`].
    ///
    /// [`startService()`]: https://developer.android.com/reference/android/content/Context#startService(android.content.Intent)
    /// [`bindService()`]: https://developer.android.com/reference/android/content/Context#bindService(android.content.Intent,%20android.content.ServiceConnection,%20int)
    /// [`stopService()`]: https://developer.android.com/reference/android/content/Context#stopService(android.content.Intent)
    /// [`<application>`]: crate::Application
    /// [`Security and Permissions`]: https://developer.android.com/training/articles/security-tips
    /// [`permission`]: crate::Application#structfield.permission
    /// [`Permissions`]: https://developer.android.com/guide/topics/manifest/manifest-intro#perms
    #[yaserde(attribute, prefix = "android")]
    pub permission: Option<String>,
    /// The name of the process where the service is to run. Normally, all components of
    /// an application run in the default process created for the application. It has
    /// the same name as the application package. The [`<application>`] element's
    /// [`process`] attribute can set a different default for all components. But
    /// component can override the default with its own process attribute, allowing
    /// you to spread your application across multiple processes.
    ///
    /// If the name assigned to this attribute begins with a colon `(':')`, a new process,
    /// private to the application, is created when it's needed and the service runs
    /// in that process. If the process name begins with a lowercase character, the
    /// service will run in a global process of that name, provided that it has
    /// permission to do so. This allows components in different applications to share
    /// a process, reducing resource usage.
    ///
    /// [`<application>`]: crate::Application
    /// [`process`]: crate::Application#structfield.process
    #[yaserde(attribute, prefix = "android")]
    pub process: Option<String>,
    #[yaserde(rename = "intent-filter")]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub intent_filter: Vec<IntentFilter>,
    #[yaserde(rename = "meta-data")]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub meta_data: Vec<MetaData>,
}

#[derive(Debug, Deserialize, Serialize, YaSerialize, YaDeserialize, PartialEq, Eq, Clone)]
#[serde(rename_all = "camelCase")]
#[derive(Default)]
pub enum ForegroundServiceType {
    #[yaserde(rename = "camera")]
    #[default]
    Camera,
    #[yaserde(rename = "connectedDevice")]
    ConnectedDevice,
    #[yaserde(rename = "dataSync")]
    DataSync,
    #[yaserde(rename = "location")]
    Location,
    #[yaserde(rename = "mediaPlayback")]
    MediaPlayback,
    #[yaserde(rename = "mediaProjection")]
    MediaProjection,
    #[yaserde(rename = "microphone")]
    Microphone,
    #[yaserde(rename = "phoneCall")]
    PhoneCall,
}