Skip to content

Commit 50339db

Browse files
claywilkinsonclaywilkinson
committed
Initial commit of the Android Play Services jar resolver for Unity.
See the README.md for details. This initial commit includes the source code for the dll.
1 parent f41f1da commit 50339db

27 files changed

+2923
-0
lines changed

‎LICENSE

Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,215 @@
1+
Copyright (C) 2014 Google Inc.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.
14+
15+
Apache License
16+
Version 2.0, January 2004
17+
http://www.apache.org/licenses/
18+
19+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
20+
21+
1. Definitions.
22+
23+
"License" shall mean the terms and conditions for use, reproduction,
24+
and distribution as defined by Sections 1 through 9 of this document.
25+
26+
"Licensor" shall mean the copyright owner or entity authorized by
27+
the copyright owner that is granting the License.
28+
29+
"Legal Entity" shall mean the union of the acting entity and all
30+
other entities that control, are controlled by, or are under common
31+
control with that entity. For the purposes of this definition,
32+
"control" means (i) the power, direct or indirect, to cause the
33+
direction or management of such entity, whether by contract or
34+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
35+
outstanding shares, or (iii) beneficial ownership of such entity.
36+
37+
"You" (or "Your") shall mean an individual or Legal Entity
38+
exercising permissions granted by this License.
39+
40+
"Source" form shall mean the preferred form for making modifications,
41+
including but not limited to software source code, documentation
42+
source, and configuration files.
43+
44+
"Object" form shall mean any form resulting from mechanical
45+
transformation or translation of a Source form, including but
46+
not limited to compiled object code, generated documentation,
47+
and conversions to other media types.
48+
49+
"Work" shall mean the work of authorship, whether in Source or
50+
Object form, made available under the License, as indicated by a
51+
copyright notice that is included in or attached to the work
52+
(an example is provided in the Appendix below).
53+
54+
"Derivative Works" shall mean any work, whether in Source or Object
55+
form, that is based on (or derived from) the Work and for which the
56+
editorial revisions, annotations, elaborations, or other modifications
57+
represent, as a whole, an original work of authorship. For the purposes
58+
of this License, Derivative Works shall not include works that remain
59+
separable from, or merely link (or bind by name) to the interfaces of,
60+
the Work and Derivative Works thereof.
61+
62+
"Contribution" shall mean any work of authorship, including
63+
the original version of the Work and any modifications or additions
64+
to that Work or Derivative Works thereof, that is intentionally
65+
submitted to Licensor for inclusion in the Work by the copyright owner
66+
or by an individual or Legal Entity authorized to submit on behalf of
67+
the copyright owner. For the purposes of this definition, "submitted"
68+
means any form of electronic, verbal, or written communication sent
69+
to the Licensor or its representatives, including but not limited to
70+
communication on electronic mailing lists, source code control systems,
71+
and issue tracking systems that are managed by, or on behalf of, the
72+
Licensor for the purpose of discussing and improving the Work, but
73+
excluding communication that is conspicuously marked or otherwise
74+
designated in writing by the copyright owner as "Not a Contribution."
75+
76+
"Contributor" shall mean Licensor and any individual or Legal Entity
77+
on behalf of whom a Contribution has been received by Licensor and
78+
subsequently incorporated within the Work.
79+
80+
2. Grant of Copyright License. Subject to the terms and conditions of
81+
this License, each Contributor hereby grants to You a perpetual,
82+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
83+
copyright license to reproduce, prepare Derivative Works of,
84+
publicly display, publicly perform, sublicense, and distribute the
85+
Work and such Derivative Works in Source or Object form.
86+
87+
3. Grant of Patent License. Subject to the terms and conditions of
88+
this License, each Contributor hereby grants to You a perpetual,
89+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
90+
(except as stated in this section) patent license to make, have made,
91+
use, offer to sell, sell, import, and otherwise transfer the Work,
92+
where such license applies only to those patent claims licensable
93+
by such Contributor that are necessarily infringed by their
94+
Contribution(s) alone or by combination of their Contribution(s)
95+
with the Work to which such Contribution(s) was submitted. If You
96+
institute patent litigation against any entity (including a
97+
cross-claim or counterclaim in a lawsuit) alleging that the Work
98+
or a Contribution incorporated within the Work constitutes direct
99+
or contributory patent infringement, then any patent licenses
100+
granted to You under this License for that Work shall terminate
101+
as of the date such litigation is filed.
102+
103+
4. Redistribution. You may reproduce and distribute copies of the
104+
Work or Derivative Works thereof in any medium, with or without
105+
modifications, and in Source or Object form, provided that You
106+
meet the following conditions:
107+
108+
(a) You must give any other recipients of the Work or
109+
Derivative Works a copy of this License; and
110+
111+
(b) You must cause any modified files to carry prominent notices
112+
stating that You changed the files; and
113+
114+
(c) You must retain, in the Source form of any Derivative Works
115+
that You distribute, all copyright, patent, trademark, and
116+
attribution notices from the Source form of the Work,
117+
excluding those notices that do not pertain to any part of
118+
the Derivative Works; and
119+
120+
(d) If the Work includes a "NOTICE" text file as part of its
121+
distribution, then any Derivative Works that You distribute must
122+
include a readable copy of the attribution notices contained
123+
within such NOTICE file, excluding those notices that do not
124+
pertain to any part of the Derivative Works, in at least one
125+
of the following places: within a NOTICE text file distributed
126+
as part of the Derivative Works; within the Source form or
127+
documentation, if provided along with the Derivative Works; or,
128+
within a display generated by the Derivative Works, if and
129+
wherever such third-party notices normally appear. The contents
130+
of the NOTICE file are for informational purposes only and
131+
do not modify the License. You may add Your own attribution
132+
notices within Derivative Works that You distribute, alongside
133+
or as an addendum to the NOTICE text from the Work, provided
134+
that such additional attribution notices cannot be construed
135+
as modifying the License.
136+
137+
You may add Your own copyright statement to Your modifications and
138+
may provide additional or different license terms and conditions
139+
for use, reproduction, or distribution of Your modifications, or
140+
for any such Derivative Works as a whole, provided Your use,
141+
reproduction, and distribution of the Work otherwise complies with
142+
the conditions stated in this License.
143+
144+
5. Submission of Contributions. Unless You explicitly state otherwise,
145+
any Contribution intentionally submitted for inclusion in the Work
146+
by You to the Licensor shall be under the terms and conditions of
147+
this License, without any additional terms or conditions.
148+
Notwithstanding the above, nothing herein shall supersede or modify
149+
the terms of any separate license agreement you may have executed
150+
with Licensor regarding such Contributions.
151+
152+
6. Trademarks. This License does not grant permission to use the trade
153+
names, trademarks, service marks, or product names of the Licensor,
154+
except as required for reasonable and customary use in describing the
155+
origin of the Work and reproducing the content of the NOTICE file.
156+
157+
7. Disclaimer of Warranty. Unless required by applicable law or
158+
agreed to in writing, Licensor provides the Work (and each
159+
Contributor provides its Contributions) on an "AS IS" BASIS,
160+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
161+
implied, including, without limitation, any warranties or conditions
162+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
163+
PARTICULAR PURPOSE. You are solely responsible for determining the
164+
appropriateness of using or redistributing the Work and assume any
165+
risks associated with Your exercise of permissions under this License.
166+
167+
8. Limitation of Liability. In no event and under no legal theory,
168+
whether in tort (including negligence), contract, or otherwise,
169+
unless required by applicable law (such as deliberate and grossly
170+
negligent acts) or agreed to in writing, shall any Contributor be
171+
liable to You for damages, including any direct, indirect, special,
172+
incidental, or consequential damages of any character arising as a
173+
result of this License or out of the use or inability to use the
174+
Work (including but not limited to damages for loss of goodwill,
175+
work stoppage, computer failure or malfunction, or any and all
176+
other commercial damages or losses), even if such Contributor
177+
has been advised of the possibility of such damages.
178+
179+
9. Accepting Warranty or Additional Liability. While redistributing
180+
the Work or Derivative Works thereof, You may choose to offer,
181+
and charge a fee for, acceptance of support, warranty, indemnity,
182+
or other liability obligations and/or rights consistent with this
183+
License. However, in accepting such obligations, You may act only
184+
on Your own behalf and on Your sole responsibility, not on behalf
185+
of any other Contributor, and only if You agree to indemnify,
186+
defend, and hold each Contributor harmless for any liability
187+
incurred by, or claims asserted against, such Contributor by reason
188+
of your accepting any such warranty or additional liability.
189+
190+
END OF TERMS AND CONDITIONS
191+
192+
APPENDIX: How to apply the Apache License to your work.
193+
194+
To apply the Apache License to your work, attach the following
195+
boilerplate notice, with the fields enclosed by brackets "[]"
196+
replaced with your own identifying information. (Don't include
197+
the brackets!) The text should be enclosed in the appropriate
198+
comment syntax for the file format. We also recommend that a
199+
file or class name and description of purpose be included on the
200+
same "printed page" as the copyright notice for easier
201+
identification within third-party archives.
202+
203+
Copyright [yyyy] [name of copyright owner]
204+
205+
Licensed under the Apache License, Version 2.0 (the "License");
206+
you may not use this file except in compliance with the License.
207+
You may obtain a copy of the License at
208+
209+
http://www.apache.org/licenses/LICENSE-2.0
210+
211+
Unless required by applicable law or agreed to in writing, software
212+
distributed under the License is distributed on an "AS IS" BASIS,
213+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
214+
See the License for the specific language governing permissions and
215+
limitations under the License.

‎README.md

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
# JarResolver-Readme
2+
Google Play Services Jar Resolver Library for Unity
3+
4+
# Overview
5+
6+
This library is intended to be used by any Unity plugin that requires access to
7+
Google play-services or Android support libraries on Android. The goal is to
8+
minimize the risk of having multiple or conflicting versions of client
9+
libraries included in the Unity project.
10+
11+
With this library, a plugin declares the dependencies needed and these are
12+
resolved by using the play-services and support repositories that are part of
13+
the Android SDK. These repositories are used to store .aar files in a Maven
14+
(Gradle) compatible repository.
15+
16+
This library implements a subset of the resolution logic used by these build
17+
tools so the same functionality is available in Unity.
18+
19+
# Requirements
20+
21+
This library only works with Unity version 5.0 or better.
22+
23+
The library relies on the installation of the Android Support Repository and
24+
the Google Repository SDK components. These are found in the "extras" section.
25+
26+
# Packaging
27+
28+
The library is packaged as a DLL which implements a Unity editor extension.
29+
The library contains no runtime components.
30+
31+
There is sample code demonstrating how to declare dependencies and trigger
32+
resolution both from the menu, and as a background process when assets change.
33+
34+
# Usage
35+
36+
1. Copy the file [JarResolverLib.dll](Assets/Editor/JarResolver.dll) to the Assets/Editor folder in your Unity
37+
project.
38+
39+
The dependency information is stored statically, so all plugins register their
40+
dependency in a common location. In the worse case, this results in multiple calls to
41+
resolve the dependencies, but they all get the same resolution outcome.
42+
43+
2. Create an instance of PlayServicesSupport. Pass in a name for the
44+
client (needs to use valid filename characters), the path to the Android SDK,
45+
and the path to the settings directory. For Unity, this is "ProjectSettings".
46+
47+
```
48+
PlayServicesSupport instance = PlayServicesSupport.CreateInstance("myPlugin",
49+
EditorPrefs.GetString("AndroidSdkRoot"),
50+
"ProjectSettings");
51+
```
52+
53+
3. Specify the dependencies for your plugin. In your editor script, add a line
54+
for each direct dependency:
55+
56+
```
57+
instance.DependOn(group, artifact, version);
58+
```
59+
60+
This declares that the this application now depends on the specified artifact.
61+
Where:
62+
63+
* group: indicates the artifact group, e.g. "com.android.support" or
64+
"com.google.android.gms"
65+
* artifact: indicates the artifact, e.g. "appcompat-v7" or
66+
"play-services-appinvite"
67+
* version: indicates the version. The version value supports both specific
68+
versions such as 8.1.0, and also the trailing '+' indicating "or greater" for
69+
the portion of the number preceding the period. For example 8.1.+ would match
70+
8.1.2, but not 8.2. The string "8+" would resolve to any version greater or
71+
equal to 8.0. The meta version 'LATEST' is also supported meaning the greatest
72+
version available, and "0+" indicates any version.
73+
74+
When the dependency is added, the maven-metadata.xml file is read for this
75+
dependency. If there are no versions available (or the dependency is not
76+
found), there is an exception thrown. When the metadata is read, the list of
77+
known versions is filtered based on the version constraint. The remaining list
78+
of version is known as <em>possible versions</em>.
79+
80+
The greatest value of the possible versions is known as the <em>best version</em>. The best version is what is used to perform resolution.
81+
82+
2. Call Resolve. In your editor script call:
83+
84+
```
85+
PlayServicesSupport.ResolveDependencies(useLatest);
86+
```
87+
88+
Performs resolution of the dependencies. The parameter useLatest, if true,
89+
causes the latest version of any dependency to be used in the case of a
90+
conflict. If this flag is false, the resolution will fail by throwing an
91+
exception indicating the dependencies cannot be resolved.
92+
93+
The return value is a dictionary of dependencies needed. The key is the
94+
"versionless" key of the dependency, and the value is the Dependency object.
95+
96+
3. Copy/Update the dependencies in your project. Once ResolveDependencies
97+
returns, you need to copy and update the dependencies in your project. To do
98+
this, call
99+
100+
```
101+
PlayServicesSupport.CopyDependencies(
102+
103+
deps, "Assets/Plugins/Android", confirm);
104+
```
105+
106+
Where:
107+
108+
* <strong>deps</strong> is the dictionary returned from ResolveDependencies
109+
* <strong>"Assets/Plugins/Android" </strong>is the project relative path of where to copy the client libraries.
110+
* <strong>confirm</strong> is a delegate of type PlayServicesSupport.OverwriteConfirmation which is
111+
called when an a dependency already exists in the project. The delegate should
112+
return true to have the old dependency be overwritten by the new.
113+
114+
The signature of PlayServicesSupport.OverwriteConfirmation is
115+
116+
```
117+
bool OverwriteConfirmation (Dependency oldDep, Dependency newDep)
118+
```
119+
120+
# Calling resolution from the menu
121+
122+
If you want to make the resolution process manually started from the menu, you
123+
can use this class as a starter. It declares the dependencies statically (so
124+
other library clients will resolve them as well), and adds a menu item to
125+
perform resolution and copy the results. See
126+
[ManualResolution](Assets/Editor/ManualResolution.cs)
127+
128+
# Calling resolution in the background
129+
130+
If you want to make the resolution process automatically started when there is
131+
a change to the assets, you can kick off the process by implementing an
132+
AssetPostprocessor. See
133+
134+
[BackgroundResolution](Assets/Editor/BackgroundResolution.cs)
135+
136+
# How Resolution works
137+
138+
Resolution is done by following the steps:
139+
140+
1. All dependencies are added to the "unresolved" list. Then for each dependency
141+
in unresolved:
142+
2. check if there is already a candidate artifact
143+
1. if there is not, use the greatest version available (within the constraint) as
144+
the candidate and remove from the unresolved list.
145+
2. If there is an existing candidate, check if the unresolved version is satisfied
146+
by the candidate version.
147+
1. If it is, remove it from the unresolved list.
148+
2. If it is not, remove possible versions from the dependencies that have
149+
non-concrete version constraints (i.e. have a + in the version).
150+
3. If there
151+
4. If there are still possible versions to check, add the dependency to the end
152+
of the unresolved list for re-processing with a new version candidate.
153+
5. If there are no possible versions to resolve both the candidate and the
154+
unresolved dependencies, then either fail resolution with an exception, or use
155+
the greatest version value (depending on the useLatest flag passed to resolve).
156+
3. When a candidate version is selected, the pom file is read for that version and
157+
the
158+
159+
4. If there is a candidate version, add it to the candidate list and remove from
160+
the unresolved.
161+
3. Process transitive dependencies
162+
5. for each candidate artifact, read the pom file for dependencies and add them to
163+
the unresolved list.
164+
165+
# Code location and building instructions
166+
167+
There are 3 assemblies that are part of the solution.
168+
169+
1. The Unity Editor UI components
170+
2. The Jar resolver library
171+
3. The unit tests.

0 commit comments

Comments
 (0)