diff options
author | Marko Zajc <marko@zajc.eu.org> | 2024-03-19 01:45:53 +0100 |
---|---|---|
committer | Marko Zajc <marko@zajc.eu.org> | 2024-03-19 02:21:27 +0100 |
commit | 54cb615a682e1a5a886ec8c93fca8cfe8c1a8bc3 (patch) | |
tree | aa3746a058991d4bfb438390bfb104b130fc940b |
-rw-r--r-- | .gitignore | 29 | ||||
-rw-r--r-- | LICENSE | 674 | ||||
-rw-r--r-- | README.md | 147 | ||||
-rw-r--r-- | pom.xml | 159 | ||||
-rw-r--r-- | src/main/java/zajc/gogarchiver/Arguments.java | 206 | ||||
-rw-r--r-- | src/main/java/zajc/gogarchiver/Main.java | 246 | ||||
-rw-r--r-- | src/main/java/zajc/gogarchiver/api/Game.java | 103 | ||||
-rw-r--r-- | src/main/java/zajc/gogarchiver/api/GameDlc.java | 69 | ||||
-rw-r--r-- | src/main/java/zajc/gogarchiver/api/GameDownload.java | 149 | ||||
-rw-r--r-- | src/main/java/zajc/gogarchiver/api/User.java | 168 | ||||
-rw-r--r-- | src/main/java/zajc/gogarchiver/exception/NotLoggedInException.java | 25 | ||||
-rw-r--r-- | src/main/java/zajc/gogarchiver/util/LazyValue.java | 42 | ||||
-rw-r--r-- | src/main/java/zajc/gogarchiver/util/Utilities.java | 80 | ||||
-rw-r--r-- | versions-ruleset.xml | 13 |
14 files changed, 2110 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f7ae149 --- /dev/null +++ b/.gitignore | |||
@@ -0,0 +1,29 @@ | |||
1 | # Compiled class file | ||
2 | *.class | ||
3 | |||
4 | # Log file | ||
5 | *.log | ||
6 | |||
7 | # BlueJ files | ||
8 | *.ctxt | ||
9 | |||
10 | # Mobile Tools for Java (J2ME) | ||
11 | .mtj.tmp/ | ||
12 | |||
13 | # Package Files # | ||
14 | *.jar | ||
15 | *.war | ||
16 | *.ear | ||
17 | *.zip | ||
18 | *.tar.gz | ||
19 | *.rar | ||
20 | |||
21 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml | ||
22 | hs_err_pid* | ||
23 | /target/ | ||
24 | /repository/ | ||
25 | |||
26 | # IDE files | ||
27 | /.project | ||
28 | /.classpath | ||
29 | /.settings/ | ||
@@ -0,0 +1,674 @@ | |||
1 | GNU GENERAL PUBLIC LICENSE | ||
2 | Version 3, 29 June 2007 | ||
3 | |||
4 | Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> | ||
5 | Everyone is permitted to copy and distribute verbatim copies | ||
6 | of this license document, but changing it is not allowed. | ||
7 | |||
8 | Preamble | ||
9 | |||
10 | The GNU General Public License is a free, copyleft license for | ||
11 | software and other kinds of works. | ||
12 | |||
13 | The licenses for most software and other practical works are designed | ||
14 | to take away your freedom to share and change the works. By contrast, | ||
15 | the GNU General Public License is intended to guarantee your freedom to | ||
16 | share and change all versions of a program--to make sure it remains free | ||
17 | software for all its users. We, the Free Software Foundation, use the | ||
18 | GNU General Public License for most of our software; it applies also to | ||
19 | any other work released this way by its authors. You can apply it to | ||
20 | your programs, too. | ||
21 | |||
22 | When we speak of free software, we are referring to freedom, not | ||
23 | price. Our General Public Licenses are designed to make sure that you | ||
24 | have the freedom to distribute copies of free software (and charge for | ||
25 | them if you wish), that you receive source code or can get it if you | ||
26 | want it, that you can change the software or use pieces of it in new | ||
27 | free programs, and that you know you can do these things. | ||
28 | |||
29 | To protect your rights, we need to prevent others from denying you | ||
30 | these rights or asking you to surrender the rights. Therefore, you have | ||
31 | certain responsibilities if you distribute copies of the software, or if | ||
32 | you modify it: responsibilities to respect the freedom of others. | ||
33 | |||
34 | For example, if you distribute copies of such a program, whether | ||
35 | gratis or for a fee, you must pass on to the recipients the same | ||
36 | freedoms that you received. You must make sure that they, too, receive | ||
37 | or can get the source code. And you must show them these terms so they | ||
38 | know their rights. | ||
39 | |||
40 | Developers that use the GNU GPL protect your rights with two steps: | ||
41 | (1) assert copyright on the software, and (2) offer you this License | ||
42 | giving you legal permission to copy, distribute and/or modify it. | ||
43 | |||
44 | For the developers' and authors' protection, the GPL clearly explains | ||
45 | that there is no warranty for this free software. For both users' and | ||
46 | authors' sake, the GPL requires that modified versions be marked as | ||
47 | changed, so that their problems will not be attributed erroneously to | ||
48 | authors of previous versions. | ||
49 | |||
50 | Some devices are designed to deny users access to install or run | ||
51 | modified versions of the software inside them, although the manufacturer | ||
52 | can do so. This is fundamentally incompatible with the aim of | ||
53 | protecting users' freedom to change the software. The systematic | ||
54 | pattern of such abuse occurs in the area of products for individuals to | ||
55 | use, which is precisely where it is most unacceptable. Therefore, we | ||
56 | have designed this version of the GPL to prohibit the practice for those | ||
57 | products. If such problems arise substantially in other domains, we | ||
58 | stand ready to extend this provision to those domains in future versions | ||
59 | of the GPL, as needed to protect the freedom of users. | ||
60 | |||
61 | Finally, every program is threatened constantly by software patents. | ||
62 | States should not allow patents to restrict development and use of | ||
63 | software on general-purpose computers, but in those that do, we wish to | ||
64 | avoid the special danger that patents applied to a free program could | ||
65 | make it effectively proprietary. To prevent this, the GPL assures that | ||
66 | patents cannot be used to render the program non-free. | ||
67 | |||
68 | The precise terms and conditions for copying, distribution and | ||
69 | modification follow. | ||
70 | |||
71 | TERMS AND CONDITIONS | ||
72 | |||
73 | 0. Definitions. | ||
74 | |||
75 | "This License" refers to version 3 of the GNU General Public License. | ||
76 | |||
77 | "Copyright" also means copyright-like laws that apply to other kinds of | ||
78 | works, such as semiconductor masks. | ||
79 | |||
80 | "The Program" refers to any copyrightable work licensed under this | ||
81 | License. Each licensee is addressed as "you". "Licensees" and | ||
82 | "recipients" may be individuals or organizations. | ||
83 | |||
84 | To "modify" a work means to copy from or adapt all or part of the work | ||
85 | in a fashion requiring copyright permission, other than the making of an | ||
86 | exact copy. The resulting work is called a "modified version" of the | ||
87 | earlier work or a work "based on" the earlier work. | ||
88 | |||
89 | A "covered work" means either the unmodified Program or a work based | ||
90 | on the Program. | ||
91 | |||
92 | To "propagate" a work means to do anything with it that, without | ||
93 | permission, would make you directly or secondarily liable for | ||
94 | infringement under applicable copyright law, except executing it on a | ||
95 | computer or modifying a private copy. Propagation includes copying, | ||
96 | distribution (with or without modification), making available to the | ||
97 | public, and in some countries other activities as well. | ||
98 | |||
99 | To "convey" a work means any kind of propagation that enables other | ||
100 | parties to make or receive copies. Mere interaction with a user through | ||
101 | a computer network, with no transfer of a copy, is not conveying. | ||
102 | |||
103 | An interactive user interface displays "Appropriate Legal Notices" | ||
104 | to the extent that it includes a convenient and prominently visible | ||
105 | feature that (1) displays an appropriate copyright notice, and (2) | ||
106 | tells the user that there is no warranty for the work (except to the | ||
107 | extent that warranties are provided), that licensees may convey the | ||
108 | work under this License, and how to view a copy of this License. If | ||
109 | the interface presents a list of user commands or options, such as a | ||
110 | menu, a prominent item in the list meets this criterion. | ||
111 | |||
112 | 1. Source Code. | ||
113 | |||
114 | The "source code" for a work means the preferred form of the work | ||
115 | for making modifications to it. "Object code" means any non-source | ||
116 | form of a work. | ||
117 | |||
118 | A "Standard Interface" means an interface that either is an official | ||
119 | standard defined by a recognized standards body, or, in the case of | ||
120 | interfaces specified for a particular programming language, one that | ||
121 | is widely used among developers working in that language. | ||
122 | |||
123 | The "System Libraries" of an executable work include anything, other | ||
124 | than the work as a whole, that (a) is included in the normal form of | ||
125 | packaging a Major Component, but which is not part of that Major | ||
126 | Component, and (b) serves only to enable use of the work with that | ||
127 | Major Component, or to implement a Standard Interface for which an | ||
128 | implementation is available to the public in source code form. A | ||
129 | "Major Component", in this context, means a major essential component | ||
130 | (kernel, window system, and so on) of the specific operating system | ||
131 | (if any) on which the executable work runs, or a compiler used to | ||
132 | produce the work, or an object code interpreter used to run it. | ||
133 | |||
134 | The "Corresponding Source" for a work in object code form means all | ||
135 | the source code needed to generate, install, and (for an executable | ||
136 | work) run the object code and to modify the work, including scripts to | ||
137 | control those activities. However, it does not include the work's | ||
138 | System Libraries, or general-purpose tools or generally available free | ||
139 | programs which are used unmodified in performing those activities but | ||
140 | which are not part of the work. For example, Corresponding Source | ||
141 | includes interface definition files associated with source files for | ||
142 | the work, and the source code for shared libraries and dynamically | ||
143 | linked subprograms that the work is specifically designed to require, | ||
144 | such as by intimate data communication or control flow between those | ||
145 | subprograms and other parts of the work. | ||
146 | |||
147 | The Corresponding Source need not include anything that users | ||
148 | can regenerate automatically from other parts of the Corresponding | ||
149 | Source. | ||
150 | |||
151 | The Corresponding Source for a work in source code form is that | ||
152 | same work. | ||
153 | |||
154 | 2. Basic Permissions. | ||
155 | |||
156 | All rights granted under this License are granted for the term of | ||
157 | copyright on the Program, and are irrevocable provided the stated | ||
158 | conditions are met. This License explicitly affirms your unlimited | ||
159 | permission to run the unmodified Program. The output from running a | ||
160 | covered work is covered by this License only if the output, given its | ||
161 | content, constitutes a covered work. This License acknowledges your | ||
162 | rights of fair use or other equivalent, as provided by copyright law. | ||
163 | |||
164 | You may make, run and propagate covered works that you do not | ||
165 | convey, without conditions so long as your license otherwise remains | ||
166 | in force. You may convey covered works to others for the sole purpose | ||
167 | of having them make modifications exclusively for you, or provide you | ||
168 | with facilities for running those works, provided that you comply with | ||
169 | the terms of this License in conveying all material for which you do | ||
170 | not control copyright. Those thus making or running the covered works | ||
171 | for you must do so exclusively on your behalf, under your direction | ||
172 | and control, on terms that prohibit them from making any copies of | ||
173 | your copyrighted material outside their relationship with you. | ||
174 | |||
175 | Conveying under any other circumstances is permitted solely under | ||
176 | the conditions stated below. Sublicensing is not allowed; section 10 | ||
177 | makes it unnecessary. | ||
178 | |||
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. | ||
180 | |||
181 | No covered work shall be deemed part of an effective technological | ||
182 | measure under any applicable law fulfilling obligations under article | ||
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or | ||
184 | similar laws prohibiting or restricting circumvention of such | ||
185 | measures. | ||
186 | |||
187 | When you convey a covered work, you waive any legal power to forbid | ||
188 | circumvention of technological measures to the extent such circumvention | ||
189 | is effected by exercising rights under this License with respect to | ||
190 | the covered work, and you disclaim any intention to limit operation or | ||
191 | modification of the work as a means of enforcing, against the work's | ||
192 | users, your or third parties' legal rights to forbid circumvention of | ||
193 | technological measures. | ||
194 | |||
195 | 4. Conveying Verbatim Copies. | ||
196 | |||
197 | You may convey verbatim copies of the Program's source code as you | ||
198 | receive it, in any medium, provided that you conspicuously and | ||
199 | appropriately publish on each copy an appropriate copyright notice; | ||
200 | keep intact all notices stating that this License and any | ||
201 | non-permissive terms added in accord with section 7 apply to the code; | ||
202 | keep intact all notices of the absence of any warranty; and give all | ||
203 | recipients a copy of this License along with the Program. | ||
204 | |||
205 | You may charge any price or no price for each copy that you convey, | ||
206 | and you may offer support or warranty protection for a fee. | ||
207 | |||
208 | 5. Conveying Modified Source Versions. | ||
209 | |||
210 | You may convey a work based on the Program, or the modifications to | ||
211 | produce it from the Program, in the form of source code under the | ||
212 | terms of section 4, provided that you also meet all of these conditions: | ||
213 | |||
214 | a) The work must carry prominent notices stating that you modified | ||
215 | it, and giving a relevant date. | ||
216 | |||
217 | b) The work must carry prominent notices stating that it is | ||
218 | released under this License and any conditions added under section | ||
219 | 7. This requirement modifies the requirement in section 4 to | ||
220 | "keep intact all notices". | ||
221 | |||
222 | c) You must license the entire work, as a whole, under this | ||
223 | License to anyone who comes into possession of a copy. This | ||
224 | License will therefore apply, along with any applicable section 7 | ||
225 | additional terms, to the whole of the work, and all its parts, | ||
226 | regardless of how they are packaged. This License gives no | ||
227 | permission to license the work in any other way, but it does not | ||
228 | invalidate such permission if you have separately received it. | ||
229 | |||
230 | d) If the work has interactive user interfaces, each must display | ||
231 | Appropriate Legal Notices; however, if the Program has interactive | ||
232 | interfaces that do not display Appropriate Legal Notices, your | ||
233 | work need not make them do so. | ||
234 | |||
235 | A compilation of a covered work with other separate and independent | ||
236 | works, which are not by their nature extensions of the covered work, | ||
237 | and which are not combined with it such as to form a larger program, | ||
238 | in or on a volume of a storage or distribution medium, is called an | ||
239 | "aggregate" if the compilation and its resulting copyright are not | ||
240 | used to limit the access or legal rights of the compilation's users | ||
241 | beyond what the individual works permit. Inclusion of a covered work | ||
242 | in an aggregate does not cause this License to apply to the other | ||
243 | parts of the aggregate. | ||
244 | |||
245 | 6. Conveying Non-Source Forms. | ||
246 | |||
247 | You may convey a covered work in object code form under the terms | ||
248 | of sections 4 and 5, provided that you also convey the | ||
249 | machine-readable Corresponding Source under the terms of this License, | ||
250 | in one of these ways: | ||
251 | |||
252 | a) Convey the object code in, or embodied in, a physical product | ||
253 | (including a physical distribution medium), accompanied by the | ||
254 | Corresponding Source fixed on a durable physical medium | ||
255 | customarily used for software interchange. | ||
256 | |||
257 | b) Convey the object code in, or embodied in, a physical product | ||
258 | (including a physical distribution medium), accompanied by a | ||
259 | written offer, valid for at least three years and valid for as | ||
260 | long as you offer spare parts or customer support for that product | ||
261 | model, to give anyone who possesses the object code either (1) a | ||
262 | copy of the Corresponding Source for all the software in the | ||
263 | product that is covered by this License, on a durable physical | ||
264 | medium customarily used for software interchange, for a price no | ||
265 | more than your reasonable cost of physically performing this | ||
266 | conveying of source, or (2) access to copy the | ||
267 | Corresponding Source from a network server at no charge. | ||
268 | |||
269 | c) Convey individual copies of the object code with a copy of the | ||
270 | written offer to provide the Corresponding Source. This | ||
271 | alternative is allowed only occasionally and noncommercially, and | ||
272 | only if you received the object code with such an offer, in accord | ||
273 | with subsection 6b. | ||
274 | |||
275 | d) Convey the object code by offering access from a designated | ||
276 | place (gratis or for a charge), and offer equivalent access to the | ||
277 | Corresponding Source in the same way through the same place at no | ||
278 | further charge. You need not require recipients to copy the | ||
279 | Corresponding Source along with the object code. If the place to | ||
280 | copy the object code is a network server, the Corresponding Source | ||
281 | may be on a different server (operated by you or a third party) | ||
282 | that supports equivalent copying facilities, provided you maintain | ||
283 | clear directions next to the object code saying where to find the | ||
284 | Corresponding Source. Regardless of what server hosts the | ||
285 | Corresponding Source, you remain obligated to ensure that it is | ||
286 | available for as long as needed to satisfy these requirements. | ||
287 | |||
288 | e) Convey the object code using peer-to-peer transmission, provided | ||
289 | you inform other peers where the object code and Corresponding | ||
290 | Source of the work are being offered to the general public at no | ||
291 | charge under subsection 6d. | ||
292 | |||
293 | A separable portion of the object code, whose source code is excluded | ||
294 | from the Corresponding Source as a System Library, need not be | ||
295 | included in conveying the object code work. | ||
296 | |||
297 | A "User Product" is either (1) a "consumer product", which means any | ||
298 | tangible personal property which is normally used for personal, family, | ||
299 | or household purposes, or (2) anything designed or sold for incorporation | ||
300 | into a dwelling. In determining whether a product is a consumer product, | ||
301 | doubtful cases shall be resolved in favor of coverage. For a particular | ||
302 | product received by a particular user, "normally used" refers to a | ||
303 | typical or common use of that class of product, regardless of the status | ||
304 | of the particular user or of the way in which the particular user | ||
305 | actually uses, or expects or is expected to use, the product. A product | ||
306 | is a consumer product regardless of whether the product has substantial | ||
307 | commercial, industrial or non-consumer uses, unless such uses represent | ||
308 | the only significant mode of use of the product. | ||
309 | |||
310 | "Installation Information" for a User Product means any methods, | ||
311 | procedures, authorization keys, or other information required to install | ||
312 | and execute modified versions of a covered work in that User Product from | ||
313 | a modified version of its Corresponding Source. The information must | ||
314 | suffice to ensure that the continued functioning of the modified object | ||
315 | code is in no case prevented or interfered with solely because | ||
316 | modification has been made. | ||
317 | |||
318 | If you convey an object code work under this section in, or with, or | ||
319 | specifically for use in, a User Product, and the conveying occurs as | ||
320 | part of a transaction in which the right of possession and use of the | ||
321 | User Product is transferred to the recipient in perpetuity or for a | ||
322 | fixed term (regardless of how the transaction is characterized), the | ||
323 | Corresponding Source conveyed under this section must be accompanied | ||
324 | by the Installation Information. But this requirement does not apply | ||
325 | if neither you nor any third party retains the ability to install | ||
326 | modified object code on the User Product (for example, the work has | ||
327 | been installed in ROM). | ||
328 | |||
329 | The requirement to provide Installation Information does not include a | ||
330 | requirement to continue to provide support service, warranty, or updates | ||
331 | for a work that has been modified or installed by the recipient, or for | ||
332 | the User Product in which it has been modified or installed. Access to a | ||
333 | network may be denied when the modification itself materially and | ||
334 | adversely affects the operation of the network or violates the rules and | ||
335 | protocols for communication across the network. | ||
336 | |||
337 | Corresponding Source conveyed, and Installation Information provided, | ||
338 | in accord with this section must be in a format that is publicly | ||
339 | documented (and with an implementation available to the public in | ||
340 | source code form), and must require no special password or key for | ||
341 | unpacking, reading or copying. | ||
342 | |||
343 | 7. Additional Terms. | ||
344 | |||
345 | "Additional permissions" are terms that supplement the terms of this | ||
346 | License by making exceptions from one or more of its conditions. | ||
347 | Additional permissions that are applicable to the entire Program shall | ||
348 | be treated as though they were included in this License, to the extent | ||
349 | that they are valid under applicable law. If additional permissions | ||
350 | apply only to part of the Program, that part may be used separately | ||
351 | under those permissions, but the entire Program remains governed by | ||
352 | this License without regard to the additional permissions. | ||
353 | |||
354 | When you convey a copy of a covered work, you may at your option | ||
355 | remove any additional permissions from that copy, or from any part of | ||
356 | it. (Additional permissions may be written to require their own | ||
357 | removal in certain cases when you modify the work.) You may place | ||
358 | additional permissions on material, added by you to a covered work, | ||
359 | for which you have or can give appropriate copyright permission. | ||
360 | |||
361 | Notwithstanding any other provision of this License, for material you | ||
362 | add to a covered work, you may (if authorized by the copyright holders of | ||
363 | that material) supplement the terms of this License with terms: | ||
364 | |||
365 | a) Disclaiming warranty or limiting liability differently from the | ||
366 | terms of sections 15 and 16 of this License; or | ||
367 | |||
368 | b) Requiring preservation of specified reasonable legal notices or | ||
369 | author attributions in that material or in the Appropriate Legal | ||
370 | Notices displayed by works containing it; or | ||
371 | |||
372 | c) Prohibiting misrepresentation of the origin of that material, or | ||
373 | requiring that modified versions of such material be marked in | ||
374 | reasonable ways as different from the original version; or | ||
375 | |||
376 | d) Limiting the use for publicity purposes of names of licensors or | ||
377 | authors of the material; or | ||
378 | |||
379 | e) Declining to grant rights under trademark law for use of some | ||
380 | trade names, trademarks, or service marks; or | ||
381 | |||
382 | f) Requiring indemnification of licensors and authors of that | ||
383 | material by anyone who conveys the material (or modified versions of | ||
384 | it) with contractual assumptions of liability to the recipient, for | ||
385 | any liability that these contractual assumptions directly impose on | ||
386 | those licensors and authors. | ||
387 | |||
388 | All other non-permissive additional terms are considered "further | ||
389 | restrictions" within the meaning of section 10. If the Program as you | ||
390 | received it, or any part of it, contains a notice stating that it is | ||
391 | governed by this License along with a term that is a further | ||
392 | restriction, you may remove that term. If a license document contains | ||
393 | a further restriction but permits relicensing or conveying under this | ||
394 | License, you may add to a covered work material governed by the terms | ||
395 | of that license document, provided that the further restriction does | ||
396 | not survive such relicensing or conveying. | ||
397 | |||
398 | If you add terms to a covered work in accord with this section, you | ||
399 | must place, in the relevant source files, a statement of the | ||
400 | additional terms that apply to those files, or a notice indicating | ||
401 | where to find the applicable terms. | ||
402 | |||
403 | Additional terms, permissive or non-permissive, may be stated in the | ||
404 | form of a separately written license, or stated as exceptions; | ||
405 | the above requirements apply either way. | ||
406 | |||
407 | 8. Termination. | ||
408 | |||
409 | You may not propagate or modify a covered work except as expressly | ||
410 | provided under this License. Any attempt otherwise to propagate or | ||
411 | modify it is void, and will automatically terminate your rights under | ||
412 | this License (including any patent licenses granted under the third | ||
413 | paragraph of section 11). | ||
414 | |||
415 | However, if you cease all violation of this License, then your | ||
416 | license from a particular copyright holder is reinstated (a) | ||
417 | provisionally, unless and until the copyright holder explicitly and | ||
418 | finally terminates your license, and (b) permanently, if the copyright | ||
419 | holder fails to notify you of the violation by some reasonable means | ||
420 | prior to 60 days after the cessation. | ||
421 | |||
422 | Moreover, your license from a particular copyright holder is | ||
423 | reinstated permanently if the copyright holder notifies you of the | ||
424 | violation by some reasonable means, this is the first time you have | ||
425 | received notice of violation of this License (for any work) from that | ||
426 | copyright holder, and you cure the violation prior to 30 days after | ||
427 | your receipt of the notice. | ||
428 | |||
429 | Termination of your rights under this section does not terminate the | ||
430 | licenses of parties who have received copies or rights from you under | ||
431 | this License. If your rights have been terminated and not permanently | ||
432 | reinstated, you do not qualify to receive new licenses for the same | ||
433 | material under section 10. | ||
434 | |||
435 | 9. Acceptance Not Required for Having Copies. | ||
436 | |||
437 | You are not required to accept this License in order to receive or | ||
438 | run a copy of the Program. Ancillary propagation of a covered work | ||
439 | occurring solely as a consequence of using peer-to-peer transmission | ||
440 | to receive a copy likewise does not require acceptance. However, | ||
441 | nothing other than this License grants you permission to propagate or | ||
442 | modify any covered work. These actions infringe copyright if you do | ||
443 | not accept this License. Therefore, by modifying or propagating a | ||
444 | covered work, you indicate your acceptance of this License to do so. | ||
445 | |||
446 | 10. Automatic Licensing of Downstream Recipients. | ||
447 | |||
448 | Each time you convey a covered work, the recipient automatically | ||
449 | receives a license from the original licensors, to run, modify and | ||
450 | propagate that work, subject to this License. You are not responsible | ||
451 | for enforcing compliance by third parties with this License. | ||
452 | |||
453 | An "entity transaction" is a transaction transferring control of an | ||
454 | organization, or substantially all assets of one, or subdividing an | ||
455 | organization, or merging organizations. If propagation of a covered | ||
456 | work results from an entity transaction, each party to that | ||
457 | transaction who receives a copy of the work also receives whatever | ||
458 | licenses to the work the party's predecessor in interest had or could | ||
459 | give under the previous paragraph, plus a right to possession of the | ||
460 | Corresponding Source of the work from the predecessor in interest, if | ||
461 | the predecessor has it or can get it with reasonable efforts. | ||
462 | |||
463 | You may not impose any further restrictions on the exercise of the | ||
464 | rights granted or affirmed under this License. For example, you may | ||
465 | not impose a license fee, royalty, or other charge for exercise of | ||
466 | rights granted under this License, and you may not initiate litigation | ||
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that | ||
468 | any patent claim is infringed by making, using, selling, offering for | ||
469 | sale, or importing the Program or any portion of it. | ||
470 | |||
471 | 11. Patents. | ||
472 | |||
473 | A "contributor" is a copyright holder who authorizes use under this | ||
474 | License of the Program or a work on which the Program is based. The | ||
475 | work thus licensed is called the contributor's "contributor version". | ||
476 | |||
477 | A contributor's "essential patent claims" are all patent claims | ||
478 | owned or controlled by the contributor, whether already acquired or | ||
479 | hereafter acquired, that would be infringed by some manner, permitted | ||
480 | by this License, of making, using, or selling its contributor version, | ||
481 | but do not include claims that would be infringed only as a | ||
482 | consequence of further modification of the contributor version. For | ||
483 | purposes of this definition, "control" includes the right to grant | ||
484 | patent sublicenses in a manner consistent with the requirements of | ||
485 | this License. | ||
486 | |||
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free | ||
488 | patent license under the contributor's essential patent claims, to | ||
489 | make, use, sell, offer for sale, import and otherwise run, modify and | ||
490 | propagate the contents of its contributor version. | ||
491 | |||
492 | In the following three paragraphs, a "patent license" is any express | ||
493 | agreement or commitment, however denominated, not to enforce a patent | ||
494 | (such as an express permission to practice a patent or covenant not to | ||
495 | sue for patent infringement). To "grant" such a patent license to a | ||
496 | party means to make such an agreement or commitment not to enforce a | ||
497 | patent against the party. | ||
498 | |||
499 | If you convey a covered work, knowingly relying on a patent license, | ||
500 | and the Corresponding Source of the work is not available for anyone | ||
501 | to copy, free of charge and under the terms of this License, through a | ||
502 | publicly available network server or other readily accessible means, | ||
503 | then you must either (1) cause the Corresponding Source to be so | ||
504 | available, or (2) arrange to deprive yourself of the benefit of the | ||
505 | patent license for this particular work, or (3) arrange, in a manner | ||
506 | consistent with the requirements of this License, to extend the patent | ||
507 | license to downstream recipients. "Knowingly relying" means you have | ||
508 | actual knowledge that, but for the patent license, your conveying the | ||
509 | covered work in a country, or your recipient's use of the covered work | ||
510 | in a country, would infringe one or more identifiable patents in that | ||
511 | country that you have reason to believe are valid. | ||
512 | |||
513 | If, pursuant to or in connection with a single transaction or | ||
514 | arrangement, you convey, or propagate by procuring conveyance of, a | ||
515 | covered work, and grant a patent license to some of the parties | ||
516 | receiving the covered work authorizing them to use, propagate, modify | ||
517 | or convey a specific copy of the covered work, then the patent license | ||
518 | you grant is automatically extended to all recipients of the covered | ||
519 | work and works based on it. | ||
520 | |||
521 | A patent license is "discriminatory" if it does not include within | ||
522 | the scope of its coverage, prohibits the exercise of, or is | ||
523 | conditioned on the non-exercise of one or more of the rights that are | ||
524 | specifically granted under this License. You may not convey a covered | ||
525 | work if you are a party to an arrangement with a third party that is | ||
526 | in the business of distributing software, under which you make payment | ||
527 | to the third party based on the extent of your activity of conveying | ||
528 | the work, and under which the third party grants, to any of the | ||
529 | parties who would receive the covered work from you, a discriminatory | ||
530 | patent license (a) in connection with copies of the covered work | ||
531 | conveyed by you (or copies made from those copies), or (b) primarily | ||
532 | for and in connection with specific products or compilations that | ||
533 | contain the covered work, unless you entered into that arrangement, | ||
534 | or that patent license was granted, prior to 28 March 2007. | ||
535 | |||
536 | Nothing in this License shall be construed as excluding or limiting | ||
537 | any implied license or other defenses to infringement that may | ||
538 | otherwise be available to you under applicable patent law. | ||
539 | |||
540 | 12. No Surrender of Others' Freedom. | ||
541 | |||
542 | If conditions are imposed on you (whether by court order, agreement or | ||
543 | otherwise) that contradict the conditions of this License, they do not | ||
544 | excuse you from the conditions of this License. If you cannot convey a | ||
545 | covered work so as to satisfy simultaneously your obligations under this | ||
546 | License and any other pertinent obligations, then as a consequence you may | ||
547 | not convey it at all. For example, if you agree to terms that obligate you | ||
548 | to collect a royalty for further conveying from those to whom you convey | ||
549 | the Program, the only way you could satisfy both those terms and this | ||
550 | License would be to refrain entirely from conveying the Program. | ||
551 | |||
552 | 13. Use with the GNU Affero General Public License. | ||
553 | |||
554 | Notwithstanding any other provision of this License, you have | ||
555 | permission to link or combine any covered work with a work licensed | ||
556 | under version 3 of the GNU Affero General Public License into a single | ||
557 | combined work, and to convey the resulting work. The terms of this | ||
558 | License will continue to apply to the part which is the covered work, | ||
559 | but the special requirements of the GNU Affero General Public License, | ||
560 | section 13, concerning interaction through a network will apply to the | ||
561 | combination as such. | ||
562 | |||
563 | 14. Revised Versions of this License. | ||
564 | |||
565 | The Free Software Foundation may publish revised and/or new versions of | ||
566 | the GNU General Public License from time to time. Such new versions will | ||
567 | be similar in spirit to the present version, but may differ in detail to | ||
568 | address new problems or concerns. | ||
569 | |||
570 | Each version is given a distinguishing version number. If the | ||
571 | Program specifies that a certain numbered version of the GNU General | ||
572 | Public License "or any later version" applies to it, you have the | ||
573 | option of following the terms and conditions either of that numbered | ||
574 | version or of any later version published by the Free Software | ||
575 | Foundation. If the Program does not specify a version number of the | ||
576 | GNU General Public License, you may choose any version ever published | ||
577 | by the Free Software Foundation. | ||
578 | |||
579 | If the Program specifies that a proxy can decide which future | ||
580 | versions of the GNU General Public License can be used, that proxy's | ||
581 | public statement of acceptance of a version permanently authorizes you | ||
582 | to choose that version for the Program. | ||
583 | |||
584 | Later license versions may give you additional or different | ||
585 | permissions. However, no additional obligations are imposed on any | ||
586 | author or copyright holder as a result of your choosing to follow a | ||
587 | later version. | ||
588 | |||
589 | 15. Disclaimer of Warranty. | ||
590 | |||
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY | ||
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT | ||
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY | ||
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, | ||
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM | ||
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF | ||
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. | ||
599 | |||
600 | 16. Limitation of Liability. | ||
601 | |||
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING | ||
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS | ||
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY | ||
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE | ||
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF | ||
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD | ||
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), | ||
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF | ||
610 | SUCH DAMAGES. | ||
611 | |||
612 | 17. Interpretation of Sections 15 and 16. | ||
613 | |||
614 | If the disclaimer of warranty and limitation of liability provided | ||
615 | above cannot be given local legal effect according to their terms, | ||
616 | reviewing courts shall apply local law that most closely approximates | ||
617 | an absolute waiver of all civil liability in connection with the | ||
618 | Program, unless a warranty or assumption of liability accompanies a | ||
619 | copy of the Program in return for a fee. | ||
620 | |||
621 | END OF TERMS AND CONDITIONS | ||
622 | |||
623 | How to Apply These Terms to Your New Programs | ||
624 | |||
625 | If you develop a new program, and you want it to be of the greatest | ||
626 | possible use to the public, the best way to achieve this is to make it | ||
627 | free software which everyone can redistribute and change under these terms. | ||
628 | |||
629 | To do so, attach the following notices to the program. It is safest | ||
630 | to attach them to the start of each source file to most effectively | ||
631 | state the exclusion of warranty; and each file should have at least | ||
632 | the "copyright" line and a pointer to where the full notice is found. | ||
633 | |||
634 | <one line to give the program's name and a brief idea of what it does.> | ||
635 | Copyright (C) <year> <name of author> | ||
636 | |||
637 | This program is free software: you can redistribute it and/or modify | ||
638 | it under the terms of the GNU General Public License as published by | ||
639 | the Free Software Foundation, either version 3 of the License, or | ||
640 | (at your option) any later version. | ||
641 | |||
642 | This program is distributed in the hope that it will be useful, | ||
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
645 | GNU General Public License for more details. | ||
646 | |||
647 | You should have received a copy of the GNU General Public License | ||
648 | along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
649 | |||
650 | Also add information on how to contact you by electronic and paper mail. | ||
651 | |||
652 | If the program does terminal interaction, make it output a short | ||
653 | notice like this when it starts in an interactive mode: | ||
654 | |||
655 | <program> Copyright (C) <year> <name of author> | ||
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. | ||
657 | This is free software, and you are welcome to redistribute it | ||
658 | under certain conditions; type `show c' for details. | ||
659 | |||
660 | The hypothetical commands `show w' and `show c' should show the appropriate | ||
661 | parts of the General Public License. Of course, your program's commands | ||
662 | might be different; for a GUI interface, you would use an "about box". | ||
663 | |||
664 | You should also get your employer (if you work as a programmer) or school, | ||
665 | if any, to sign a "copyright disclaimer" for the program, if necessary. | ||
666 | For more information on this, and how to apply and follow the GNU GPL, see | ||
667 | <https://www.gnu.org/licenses/>. | ||
668 | |||
669 | The GNU General Public License does not permit incorporating your program | ||
670 | into proprietary programs. If your program is a subroutine library, you | ||
671 | may consider it more useful to permit linking proprietary applications with | ||
672 | the library. If this is what you want to do, use the GNU Lesser General | ||
673 | Public License instead of this License. But first, please read | ||
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>. | ||
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c30755f --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,147 @@ | |||
1 | # gogarchiver-ng | ||
2 | A Java rewrite of [gogarchiver](https://github.com/markozajc/gogarchiver), the GOG.com archival tool written in bash, with many improvements: | ||
3 | |||
4 | * a better, more flexible CLI | ||
5 | * parallel download support | ||
6 | * DLC support | ||
7 | * account library retrieval | ||
8 | * a much improved interface | ||
9 | |||
10 | ## Building | ||
11 | Prerequisites: | ||
12 | |||
13 | * JDK (>= 17) | ||
14 | * Maven (>= 3.2.5) | ||
15 | |||
16 | Run the following: | ||
17 | ``` | ||
18 | $ mvn clean package | ||
19 | ``` | ||
20 | The output runnable JAR will be written to `target/gogarchiver-ng.jar`. There will be another JAR with the version number in that directory - ignore it. | ||
21 | |||
22 | ## Finding the authorization token | ||
23 | 1. Open firefox | ||
24 | 2. Log into GOG.COM | ||
25 | 3. Open developer tools (Ctrl + Shift + Alt) | ||
26 | 4. Navigate to the *Storage* tab | ||
27 | 5. Select *Cookies*, and then *https://www.gog.com/* on the left sidebar | ||
28 | 6. Locate the `gog-al` cookie, and copy its value | ||
29 | |||
30 | The cookie can be passed to gogarchiver-ng directly (via `-k`) or through a file for better security (via `-K`). | ||
31 | |||
32 | ## Available on: | ||
33 | * [https://git.zajc.eu.org/gogarchiver-ng.git/](https://git.zajc.eu.org/gogarchiver-ng.git/) | ||
34 | * [https://github.com/markozajc/gogarchiver-ng/](https://github.com/markozajc/gogarchiver-ng/) | ||
35 | |||
36 | Prebuilt binaries are available at [https://files.zajc.eu.org/builds/gogarchiver-ng/](https://files.zajc.eu.org/builds/gogarchiver-ng/). | ||
37 | |||
38 | <div class="sect1"> | ||
39 | <h2 id="_options">Usage</h2> | ||
40 | <div class="sectionbody"> | ||
41 | <div class="dlist"> | ||
42 | <dl> | ||
43 | <dt class="hdlist1"><strong>-k</strong>, <strong>--token</strong>=<em>TOKEN</em></dt> | ||
44 | <dd> | ||
45 | <p>GOG token, which can be extracted from the gog-al cookie</p> | ||
46 | </dd> | ||
47 | <dt class="hdlist1"><strong>-K</strong>, <strong>--token-file</strong>=<em>PATH</em></dt> | ||
48 | <dd> | ||
49 | <p>read GOG token from a file</p> | ||
50 | </dd> | ||
51 | <dt class="hdlist1"><strong>-o</strong>, <strong>--output</strong>=<em>PATH</em></dt> | ||
52 | <dd> | ||
53 | <p>directory to write downloaded games to</p> | ||
54 | </dd> | ||
55 | <dt class="hdlist1"><strong>-t</strong>, <strong>--threads</strong>=<em>THREADS</em></dt> | ||
56 | <dd> | ||
57 | <p>number of download threads</p> | ||
58 | <div class="literalblock"> | ||
59 | Default: (same as machine's thread count) | ||
60 | </div> | ||
61 | </dd> | ||
62 | <dt class="hdlist1"><strong>-q</strong>, <strong>--quiet</strong></dt> | ||
63 | <dd> | ||
64 | <p>disable progress bars</p> | ||
65 | </dd> | ||
66 | <dt class="hdlist1"><strong>-c</strong>, <strong>--color</strong>=<em>MODE</em></dt> | ||
67 | <dd> | ||
68 | <p>control output color. Supported are auto, on, off</p> | ||
69 | </dd> | ||
70 | <dt class="hdlist1"><strong>-h</strong>, <strong>--help</strong></dt> | ||
71 | <dd> | ||
72 | <p>Show this help message and exit.</p> | ||
73 | </dd> | ||
74 | <dt class="hdlist1"><strong>-V</strong>, <strong>--version</strong></dt> | ||
75 | <dd> | ||
76 | <p>Print version information and exit.</p> | ||
77 | </dd> | ||
78 | </dl> | ||
79 | </div> | ||
80 | </div> | ||
81 | </div> | ||
82 | <div class="sect1"> | ||
83 | <h2 id="_filter_options">Filter options</h2> | ||
84 | <div class="sectionbody"> | ||
85 | <div class="dlist"> | ||
86 | <dl> | ||
87 | <dt class="hdlist1"><strong>--[no-]installers</strong></dt> | ||
88 | <dd> | ||
89 | <p>download installers</p> | ||
90 | <div class="literalblock"> | ||
91 | Default: true | ||
92 | </div> | ||
93 | </dd> | ||
94 | <dt class="hdlist1"><strong>--[no-]patches</strong></dt> | ||
95 | <dd> | ||
96 | <p>download version patches</p> | ||
97 | <div class="literalblock"> | ||
98 | Default: true | ||
99 | </div> | ||
100 | </dd> | ||
101 | <dt class="hdlist1"><strong>--[no-]dlcs</strong></dt> | ||
102 | <dd> | ||
103 | <p>download available DLCs</p> | ||
104 | <div class="literalblock"> | ||
105 | Default: true | ||
106 | </div> | ||
107 | </dd> | ||
108 | <dt class="hdlist1"><strong>-i</strong>, <strong>--include-game</strong>=<em>ID</em>[,<em>ID</em>…​]</dt> | ||
109 | <dd> | ||
110 | <p>only the listed game IDs will be downloaded. Game IDs can be obtained from <a href="https://www.gogdb.org/" class="bare">https://www.gogdb.org/</a></p> | ||
111 | </dd> | ||
112 | <dt class="hdlist1"><strong>-e</strong>, <strong>--exclude-game</strong>=<em>ID</em>[,<em>ID</em>…​]</dt> | ||
113 | <dd> | ||
114 | <p>all games owned by the account except those listed will be downloaded</p> | ||
115 | </dd> | ||
116 | <dt class="hdlist1"><strong>--include-platform</strong>=<em>PLATFORM</em>[,<em>PLATFORM</em>…​]</dt> | ||
117 | <dd> | ||
118 | <p>platforms to download for. Supported are linux, windows, mac</p> | ||
119 | </dd> | ||
120 | <dt class="hdlist1"><strong>--exclude-platform</strong>=<em>PLATFORM</em>[,<em>PLATFORM</em>…​]</dt> | ||
121 | <dd> | ||
122 | <p>platforms to not download for</p> | ||
123 | </dd> | ||
124 | </dl> | ||
125 | </div> | ||
126 | </div> | ||
127 | </div> | ||
128 | <div class="sect1"> | ||
129 | <h2 id="_advanced_options">Advanced options</h2> | ||
130 | <div class="sectionbody"> | ||
131 | <div class="dlist"> | ||
132 | <dl> | ||
133 | <dt class="hdlist1"><strong>-v</strong>, <strong>--verbose</strong></dt> | ||
134 | <dd> | ||
135 | <p>display verbose log messages</p> | ||
136 | </dd> | ||
137 | <dt class="hdlist1"><strong>--[no-]unknown-types</strong></dt> | ||
138 | <dd> | ||
139 | <p>download unknown download types</p> | ||
140 | <div class="literalblock"> | ||
141 | Default: false | ||
142 | </div> | ||
143 | </dd> | ||
144 | </dl> | ||
145 | </div> | ||
146 | </div> | ||
147 | </div> | ||
@@ -0,0 +1,159 @@ | |||
1 | <project xmlns="http://maven.apache.org/POM/4.0.0" | ||
2 | xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
3 | xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
4 | <modelVersion>4.0.0</modelVersion> | ||
5 | |||
6 | <groupId>zajc</groupId> | ||
7 | <artifactId>gogarchiver-ng</artifactId> | ||
8 | <version>2.0</version> | ||
9 | |||
10 | <name>gogarchiver-ng</name> | ||
11 | <description>An archival tool for GOG.com</description> | ||
12 | <inceptionYear>2024</inceptionYear> | ||
13 | |||
14 | <licenses> | ||
15 | <license> | ||
16 | <name>The GNU General Public License, Version 3.0</name> | ||
17 | <url>https://www.gnu.org/licenses/gpl-3.0.txt</url> | ||
18 | </license> | ||
19 | </licenses> | ||
20 | |||
21 | <properties> | ||
22 | <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | ||
23 | <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> | ||
24 | <maven.compiler.source>17</maven.compiler.source> | ||
25 | <maven.compiler.target>17</maven.compiler.target> | ||
26 | </properties> | ||
27 | |||
28 | <dependencies> | ||
29 | |||
30 | <!-- HTTP Client --> | ||
31 | <dependency> | ||
32 | <groupId>com.konghq</groupId> | ||
33 | <artifactId>unirest-java</artifactId> | ||
34 | <version>3.14.5</version> | ||
35 | </dependency> | ||
36 | |||
37 | <!-- CLI support --> | ||
38 | <dependency> | ||
39 | <groupId>info.picocli</groupId> | ||
40 | <artifactId>picocli</artifactId> | ||
41 | <version>4.7.5</version> | ||
42 | </dependency> | ||
43 | <dependency> | ||
44 | <groupId>me.tongfei</groupId> | ||
45 | <artifactId>progressbar</artifactId> | ||
46 | <version>0.10.0</version> | ||
47 | </dependency> | ||
48 | |||
49 | <!-- Lambda Improvement --> | ||
50 | <dependency> | ||
51 | <groupId>org.eu.zajc</groupId> | ||
52 | <artifactId>extended-functions</artifactId> | ||
53 | <version>1.4.2</version> | ||
54 | </dependency> | ||
55 | |||
56 | <!-- Annotations --> | ||
57 | <dependency> | ||
58 | <groupId>com.google.code.findbugs</groupId> | ||
59 | <artifactId>jsr305</artifactId> | ||
60 | <version>3.0.2</version> | ||
61 | <scope>provided</scope> | ||
62 | </dependency> | ||
63 | |||
64 | </dependencies> | ||
65 | |||
66 | <build> | ||
67 | <plugins> | ||
68 | |||
69 | <!-- Version checker --> | ||
70 | <plugin> | ||
71 | <groupId>org.codehaus.mojo</groupId> | ||
72 | <artifactId>versions-maven-plugin</artifactId> | ||
73 | <version>2.16.2</version> | ||
74 | <configuration> | ||
75 | <rulesUri>file://${project.basedir}/versions-ruleset.xml</rulesUri> | ||
76 | </configuration> | ||
77 | </plugin> | ||
78 | |||
79 | <!-- Version enforcer --> | ||
80 | <plugin> | ||
81 | <groupId>org.apache.maven.plugins</groupId> | ||
82 | <artifactId>maven-enforcer-plugin</artifactId> | ||
83 | <version>3.4.1</version> | ||
84 | <executions> | ||
85 | <execution> | ||
86 | <id>enforce-maven</id> | ||
87 | <goals> | ||
88 | <goal>enforce</goal> | ||
89 | </goals> | ||
90 | <configuration> | ||
91 | <rules> | ||
92 | <requireMavenVersion> | ||
93 | <version>3.2.5</version> | ||
94 | </requireMavenVersion> | ||
95 | </rules> | ||
96 | </configuration> | ||
97 | </execution> | ||
98 | </executions> | ||
99 | </plugin> | ||
100 | |||
101 | <!-- Analyzer --> | ||
102 | <plugin> | ||
103 | <groupId>org.apache.maven.plugins</groupId> | ||
104 | <artifactId>maven-dependency-plugin</artifactId> | ||
105 | <version>3.6.1</version> | ||
106 | <configuration> | ||
107 | <ignoreNonCompile>true</ignoreNonCompile> | ||
108 | </configuration> | ||
109 | </plugin> | ||
110 | |||
111 | <!-- Shader --> | ||
112 | <plugin> | ||
113 | <groupId>org.apache.maven.plugins</groupId> | ||
114 | <artifactId>maven-shade-plugin</artifactId> | ||
115 | <version>3.5.1</version> | ||
116 | <configuration> | ||
117 | <filters> | ||
118 | <filter> | ||
119 | <artifact>*:*</artifact> | ||
120 | <excludes> | ||
121 | <exclude>META-INF/*.SF</exclude> | ||
122 | <exclude>META-INF/*.DSA</exclude> | ||
123 | <exclude>META-INF/*.RSA</exclude> | ||
124 | <exclude>META-INF/LICENSE*</exclude> | ||
125 | <exclude>META-INF/MANIFEST.MF</exclude> | ||
126 | <exclude>META-INF/NOTICE*</exclude> | ||
127 | <exclude>META-INF/DEPENDENCIES</exclude> | ||
128 | <exclude>LICENSE*</exclude> | ||
129 | <exclude>CHANGELOG*</exclude> | ||
130 | <exclude>README*</exclude> | ||
131 | <exclude>about.html</exclude> | ||
132 | <exclude>.keep</exclude> | ||
133 | <exclude>**/module-info.class</exclude> | ||
134 | </excludes> | ||
135 | </filter> | ||
136 | </filters> | ||
137 | <transformers> | ||
138 | <transformer | ||
139 | implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"> | ||
140 | <mainClass>zajc.gogarchiver.Main</mainClass> | ||
141 | </transformer> | ||
142 | </transformers> | ||
143 | <createDependencyReducedPom>false</createDependencyReducedPom> | ||
144 | <outputFile>${project.build.directory}/${project.artifactId}.jar</outputFile> | ||
145 | </configuration> | ||
146 | <executions> | ||
147 | <execution> | ||
148 | <phase>package</phase> | ||
149 | <goals> | ||
150 | <goal>shade</goal> | ||
151 | </goals> | ||
152 | </execution> | ||
153 | </executions> | ||
154 | </plugin> | ||
155 | |||
156 | </plugins> | ||
157 | </build> | ||
158 | |||
159 | </project> | ||
diff --git a/src/main/java/zajc/gogarchiver/Arguments.java b/src/main/java/zajc/gogarchiver/Arguments.java new file mode 100644 index 0000000..cd24ffa --- /dev/null +++ b/src/main/java/zajc/gogarchiver/Arguments.java | |||
@@ -0,0 +1,206 @@ | |||
1 | //SPDX-License-Identifier: GPL-3.0 | ||
2 | /* | ||
3 | * gogarchiver-ng, an archival tool for GOG.com | ||
4 | * Copyright (C) 2024 Marko Zajc | ||
5 | * | ||
6 | * This program is free software: you can redistribute it and/or modify it under the | ||
7 | * terms of the GNU General Public License as published by the Free Software | ||
8 | * Foundation, version 3. | ||
9 | * | ||
10 | * This program is distributed in the hope that it will be useful, but WITHOUT ANY | ||
11 | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | ||
12 | * PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
13 | * | ||
14 | * You should have received a copy of the GNU General Public License along with this | ||
15 | * program. If not, see <https://www.gnu.org/licenses/>. | ||
16 | */ | ||
17 | package zajc.gogarchiver; | ||
18 | |||
19 | import static java.lang.Runtime.getRuntime; | ||
20 | import static java.util.Collections.unmodifiableSet; | ||
21 | import static java.util.stream.Collectors.toUnmodifiableSet; | ||
22 | import static picocli.CommandLine.Help.Ansi.AUTO; | ||
23 | import static picocli.CommandLine.Help.Visibility.ALWAYS; | ||
24 | import static zajc.gogarchiver.api.GameDownload.Type.*; | ||
25 | |||
26 | import java.io.IOException; | ||
27 | import java.nio.file.*; | ||
28 | import java.util.*; | ||
29 | import java.util.function.Predicate; | ||
30 | |||
31 | import javax.annotation.Nonnull; | ||
32 | |||
33 | import org.eu.zajc.ef.supplier.except.all.AESupplier; | ||
34 | |||
35 | import picocli.CommandLine.*; | ||
36 | import picocli.CommandLine.Help.Ansi; | ||
37 | import zajc.gogarchiver.api.*; | ||
38 | import zajc.gogarchiver.api.GameDownload.Platform; | ||
39 | import zajc.gogarchiver.exception.NotLoggedInException; | ||
40 | import zajc.gogarchiver.util.LazyValue; | ||
41 | |||
42 | public class Arguments { | ||
43 | |||
44 | private final LazyValue<User> user = new LazyValue<>(); | ||
45 | |||
46 | @ArgGroup(exclusive = true, multiplicity = "1") private Token token; | ||
47 | |||
48 | private static class Token { | ||
49 | |||
50 | @Option(names = { "-k", "--token" }, description = "GOG token, which can be extracted from the gog-al cookie", | ||
51 | paramLabel = "TOKEN") private String tokenString; | ||
52 | @Option(names = { "-K", "--token-file" }, description = "read GOG token from a file", | ||
53 | paramLabel = "PATH") private Path tokenFile; | ||
54 | |||
55 | @Nonnull | ||
56 | @SuppressWarnings("null") | ||
57 | public String getTokenString() throws IOException { | ||
58 | var token = this.tokenString; | ||
59 | if (token == null) | ||
60 | token = Files.readString(this.tokenFile); | ||
61 | return token.strip(); | ||
62 | } | ||
63 | |||
64 | } | ||
65 | |||
66 | @Option(names = { "-o", "--output" }, required = true, description = "directory to write downloaded games to", | ||
67 | paramLabel = "PATH") private Path output; | ||
68 | @Option(names = { "-t", "--threads" }, description = "number of download threads", paramLabel = "THREADS", | ||
69 | showDefaultValue = ALWAYS) private int threads = getRuntime().availableProcessors(); | ||
70 | @Option(names = { "-q", "--quiet" }, description = "disable progress bars") private boolean quiet = false; | ||
71 | @Option(names = { "-c", "--color" }, description = "control output color. Supported are auto, on, off", | ||
72 | paramLabel = "MODE") private Ansi color = AUTO; | ||
73 | |||
74 | @ArgGroup(validate = false, heading = "%nFilter options%n") private Filters filters = new Filters(); | ||
75 | |||
76 | private static class Filters { | ||
77 | |||
78 | @Option(names = { "--no-installers" }, description = "download installers", negatable = true, | ||
79 | showDefaultValue = ALWAYS) private boolean installers = true; | ||
80 | @Option(names = { "--no-patches" }, description = "download version patches", negatable = true, | ||
81 | showDefaultValue = ALWAYS) private boolean patches = true; | ||
82 | @Option(names = { "--no-dlcs" }, description = "download available DLCs", negatable = true, | ||
83 | showDefaultValue = ALWAYS) private boolean dlcs = true; | ||
84 | |||
85 | @ArgGroup(exclusive = true) private GameIds gameIds = new GameIds(); | ||
86 | |||
87 | private static class GameIds { | ||
88 | |||
89 | @Option(names = { "-i", "--include-game" }, description = """ | ||
90 | only the listed game IDs will be downloaded. Game IDs can be obtained from https://www.gogdb.org/""", | ||
91 | paramLabel = "ID", split = ",") private Set<String> included; | ||
92 | @Option(names = { "-e", "--exclude-game" }, description = """ | ||
93 | all games owned by the account except those listed will be downloaded""", paramLabel = "ID", | ||
94 | split = ",") private Set<String> excluded; | ||
95 | |||
96 | @Nonnull | ||
97 | @SuppressWarnings("null") | ||
98 | public Set<String> getGameIds(@Nonnull User user) { | ||
99 | if (this.included != null) | ||
100 | return unmodifiableSet(this.included); | ||
101 | |||
102 | var library = user.getLibraryIds(); | ||
103 | |||
104 | if (this.excluded == null) | ||
105 | return library; | ||
106 | else | ||
107 | return library.stream().filter(Predicate.not(this.excluded::contains)).collect(toUnmodifiableSet()); | ||
108 | } | ||
109 | |||
110 | } | ||
111 | |||
112 | @ArgGroup(exclusive = true) private Platforms platforms = new Platforms(); | ||
113 | |||
114 | private static class Platforms { | ||
115 | |||
116 | @Option(names = { "--include-platform" }, description = """ | ||
117 | platforms to download for. Supported are linux, windows, mac""", paramLabel = "PLATFORM", | ||
118 | split = ",") private EnumSet<Platform> included; | ||
119 | @Option(names = { "--exclude-platform" }, description = """ | ||
120 | platforms to not download for""", paramLabel = "PLATFORM", | ||
121 | split = ",") private EnumSet<Platform> excluded; | ||
122 | |||
123 | @Nonnull | ||
124 | @SuppressWarnings("null") | ||
125 | public Set<Platform> getPlatforms() { | ||
126 | if (this.included != null) | ||
127 | return unmodifiableSet(this.included); | ||
128 | else if (this.excluded != null) | ||
129 | return unmodifiableSet(this.excluded); | ||
130 | else | ||
131 | return EnumSet.allOf(Platform.class); | ||
132 | } | ||
133 | |||
134 | } | ||
135 | |||
136 | } | ||
137 | |||
138 | @ArgGroup(validate = false, heading = "%nAdvanced options%n") private AdvancedOptions advanced = | ||
139 | new AdvancedOptions(); | ||
140 | |||
141 | private static class AdvancedOptions { | ||
142 | |||
143 | @Option(names = { "-v", "--verbose" }, description = "display verbose log messages") private boolean verbose = | ||
144 | false; | ||
145 | |||
146 | @Option(names = { "--unknown-types" }, description = "download unknown download types", negatable = true, | ||
147 | showDefaultValue = ALWAYS) private boolean unknown = false; | ||
148 | |||
149 | } | ||
150 | |||
151 | @Nonnull | ||
152 | @SuppressWarnings({ "unused", "null" }) | ||
153 | public User getUser() throws IOException, NotLoggedInException { | ||
154 | return this.user.get((AESupplier<User>) () -> new User(this.token.getTokenString())); | ||
155 | } | ||
156 | |||
157 | @Nonnull | ||
158 | public Set<String> getGameIds() throws IOException, NotLoggedInException { | ||
159 | return this.filters.gameIds.getGameIds(getUser()); | ||
160 | } | ||
161 | |||
162 | @Nonnull | ||
163 | @SuppressWarnings("null") | ||
164 | public Ansi getColorMode() { | ||
165 | return this.color; | ||
166 | } | ||
167 | |||
168 | public int getThreads() { | ||
169 | return this.threads; | ||
170 | } | ||
171 | |||
172 | public Path getOutputPath() { | ||
173 | return this.output; | ||
174 | } | ||
175 | |||
176 | public Set<Platform> getPlatforms() { | ||
177 | return this.filters.platforms.getPlatforms(); | ||
178 | } | ||
179 | |||
180 | public boolean downloadDlcs() { | ||
181 | return this.filters.dlcs; | ||
182 | } | ||
183 | |||
184 | public Set<GameDownload.Type> getTypes() { | ||
185 | var types = EnumSet.noneOf(GameDownload.Type.class); | ||
186 | if (this.filters.installers) | ||
187 | types.add(INSTALLER); | ||
188 | |||
189 | if (this.filters.patches) | ||
190 | types.add(PATCH); | ||
191 | |||
192 | if (this.advanced.unknown) | ||
193 | types.add(UNKNOWN); | ||
194 | |||
195 | return types; | ||
196 | } | ||
197 | |||
198 | public boolean isVerbose() { | ||
199 | return this.advanced.verbose; | ||
200 | } | ||
201 | |||
202 | public boolean isQuiet() { | ||
203 | return this.quiet; | ||
204 | } | ||
205 | |||
206 | } | ||
diff --git a/src/main/java/zajc/gogarchiver/Main.java b/src/main/java/zajc/gogarchiver/Main.java new file mode 100644 index 0000000..3cba37f --- /dev/null +++ b/src/main/java/zajc/gogarchiver/Main.java | |||
@@ -0,0 +1,246 @@ | |||
1 | //SPDX-License-Identifier: GPL-3.0 | ||
2 | /* | ||
3 | * gogarchiver-ng, an archival tool for GOG.com | ||
4 | * Copyright (C) 2024 Marko Zajc | ||
5 | * | ||
6 | * This program is free software: you can redistribute it and/or modify it under the | ||
7 | * terms of the GNU General Public License as published by the Free Software | ||
8 | * Foundation, version 3. | ||
9 | * | ||
10 | * This program is distributed in the hope that it will be useful, but WITHOUT ANY | ||
11 | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | ||
12 | * PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
13 | * | ||
14 | * You should have received a copy of the GNU General Public License along with this | ||
15 | * program. If not, see <https://www.gnu.org/licenses/>. | ||
16 | */ | ||
17 | package zajc.gogarchiver; | ||
18 | |||
19 | import static java.lang.Long.MAX_VALUE; | ||
20 | import static java.lang.Math.max; | ||
21 | import static java.lang.System.*; | ||
22 | import static java.nio.file.Files.createDirectories; | ||
23 | import static java.util.Objects.requireNonNullElse; | ||
24 | import static java.util.concurrent.Executors.newFixedThreadPool; | ||
25 | import static java.util.concurrent.TimeUnit.NANOSECONDS; | ||
26 | import static java.util.stream.Collectors.toUnmodifiableSet; | ||
27 | import static java.util.stream.Stream.concat; | ||
28 | import static me.tongfei.progressbar.ProgressBarStyle.*; | ||
29 | import static picocli.CommandLine.Help.Ansi.OFF; | ||
30 | import static zajc.gogarchiver.util.Utilities.*; | ||
31 | |||
32 | import java.io.IOException; | ||
33 | import java.util.*; | ||
34 | import java.util.concurrent.*; | ||
35 | import java.util.stream.Stream; | ||
36 | |||
37 | import javax.annotation.*; | ||
38 | |||
39 | import org.eu.zajc.ef.runnable.except.all.AERunnable; | ||
40 | |||
41 | import me.tongfei.progressbar.*; | ||
42 | import picocli.CommandLine; | ||
43 | import picocli.CommandLine.*; | ||
44 | import sun.misc.Signal; // NOSONAR it's just quality of life | ||
45 | import zajc.gogarchiver.api.*; | ||
46 | import zajc.gogarchiver.exception.NotLoggedInException; | ||
47 | |||
48 | @Command(name = "gogarchiver", description = "an archival tool for GOG.com", version = "gogarchiver 1.0", | ||
49 | mixinStandardHelpOptions = true, sortSynopsis = false, sortOptions = false) | ||
50 | public class Main implements Callable<Integer> { | ||
51 | |||
52 | @Mixin private Arguments arguments; | ||
53 | |||
54 | private void run() throws Exception { | ||
55 | createDirectories(this.arguments.getOutputPath()); | ||
56 | var downloads = getDownloadList(); | ||
57 | if (downloads.isEmpty()) { | ||
58 | if (!this.arguments.isQuiet()) | ||
59 | out.println("\u001b[2KNothing to do"); | ||
60 | |||
61 | } else { | ||
62 | executeDownloads(downloads); | ||
63 | |||
64 | if (!this.arguments.isQuiet()) | ||
65 | out.println("Done"); | ||
66 | } | ||
67 | } | ||
68 | |||
69 | @SuppressWarnings({ "resource", "null" }) | ||
70 | private void executeDownloads(@Nonnull List<GameDownload> downloads) throws InterruptedException { | ||
71 | var progressTitleWidth = | ||
72 | downloads.stream().map(GameDownload::getProgressTitle).mapToInt(String::length).max().orElse(-1); | ||
73 | |||
74 | Map<GameDownload, ProgressBar> progressBars; | ||
75 | if (this.arguments.isQuiet()) { | ||
76 | progressBars = null; | ||
77 | |||
78 | } else { | ||
79 | progressBars = new HashMap<>(); | ||
80 | downloads.stream().forEachOrdered(d -> { | ||
81 | progressBars.put(d, downloadProgress(d.getProgressTitle(), progressTitleWidth)); | ||
82 | }); | ||
83 | } | ||
84 | |||
85 | var pool = newFixedThreadPool(this.arguments.getThreads()); | ||
86 | downloads.stream().forEachOrdered(d -> { | ||
87 | startDownload(d, pool, progressBars); | ||
88 | }); | ||
89 | |||
90 | pool.shutdown(); | ||
91 | pool.awaitTermination(MAX_VALUE, NANOSECONDS); | ||
92 | } | ||
93 | |||
94 | @SuppressWarnings({ "null", "resource" }) | ||
95 | private void startDownload(@Nonnull GameDownload download, @Nonnull ExecutorService service, | ||
96 | @Nullable Map<GameDownload, ProgressBar> progressBars) { | ||
97 | service.submit((AERunnable) () -> { | ||
98 | var progress = progressBars == null ? null : progressBars.get(download); | ||
99 | |||
100 | download.downloadTo(this.arguments.getOutputPath(), progress); | ||
101 | |||
102 | if (progress != null) { | ||
103 | progress.stepTo(progress.getMax()); | ||
104 | progress.refresh(); | ||
105 | progress.pause(); | ||
106 | } | ||
107 | }); | ||
108 | } | ||
109 | |||
110 | @Nonnull | ||
111 | @SuppressWarnings({ "null", "resource" }) | ||
112 | public List<GameDownload> getDownloadList() throws IOException, NotLoggedInException { | ||
113 | ForkJoinPool pool = null; | ||
114 | try (var p = this.arguments.isQuiet() ? null : createGameLoadingProgress()) { | ||
115 | if (p != null) | ||
116 | p.setExtraMessage("Loading user library"); | ||
117 | |||
118 | var ids = this.arguments.getGameIds(); | ||
119 | if (p != null) | ||
120 | p.maxHint(ids.size()); | ||
121 | |||
122 | var user = this.arguments.getUser(); | ||
123 | pool = new ForkJoinPool(ids.size() + 1); // metadata requests take a while so it doesn't hurt to parallelize | ||
124 | var games = pool.submit(() -> { // this is a hack to increase parallelStream()'s parallelism | ||
125 | return ids.parallelStream().map(user::resolveGame).filter(Objects::nonNull).peek(g -> { // NOSONAR | ||
126 | if (p != null) { | ||
127 | p.setExtraMessage(g.getTitle()); | ||
128 | p.step(); | ||
129 | } | ||
130 | }).collect(toUnmodifiableSet()); | ||
131 | }).join(); | ||
132 | |||
133 | if (p != null) { | ||
134 | p.stepTo(ids.size()); | ||
135 | p.setExtraMessage("Processing games"); | ||
136 | } | ||
137 | return createDownloadList(games, pool); | ||
138 | |||
139 | } finally { | ||
140 | if (pool != null) | ||
141 | pool.shutdown(); | ||
142 | if (!this.arguments.isQuiet()) | ||
143 | cursorUp(); | ||
144 | } | ||
145 | } | ||
146 | |||
147 | @Nonnull | ||
148 | @SuppressWarnings("null") | ||
149 | private List<GameDownload> createDownloadList(@Nonnull Set<Game> games, @Nonnull ForkJoinPool pool) { | ||
150 | var types = this.arguments.getTypes(); | ||
151 | var platforms = this.arguments.getPlatforms(); | ||
152 | var output = this.arguments.getOutputPath(); | ||
153 | |||
154 | return pool.submit(() -> { | ||
155 | return games.parallelStream().flatMap(g -> concat(Stream.of(g), g.getDlcs().stream())).filter(g -> { | ||
156 | if (g instanceof GameDlc dlc && !this.arguments.downloadDlcs()) { | ||
157 | verbose("Downloading DLCs is disabled - skipping DLC @|bold %s|@ of game @|bold %s|@", | ||
158 | dlc.getTitle(), dlc.getParent().getTitle()); | ||
159 | |||
160 | return false; | ||
161 | } else { | ||
162 | return true; | ||
163 | } | ||
164 | }).flatMap(g -> g.getDownloads().stream()).filter(d -> { | ||
165 | if (!platforms.contains(d.platform())) { | ||
166 | verbose("Downloading for @|bold %s|@ is disabled - not downloading @|bold %s|@", | ||
167 | d.platform().toString().toLowerCase(), d.getProgressTitle()); | ||
168 | return false; | ||
169 | |||
170 | } else if (!types.contains(d.type())) { | ||
171 | verbose("Downloading types of @|bold %s|@ is disabled - not downloading @|bold %s|@", | ||
172 | d.type().toString().toLowerCase(), d.getProgressTitle()); | ||
173 | return false; | ||
174 | |||
175 | } else if (output.resolve(d.path()).toFile().exists()) { | ||
176 | verbose("Not downloading @|bold %s|@ because it is already downloaded", | ||
177 | d.type().toString().toLowerCase(), d.getProgressTitle()); | ||
178 | return false; | ||
179 | |||
180 | } else { | ||
181 | return true; | ||
182 | } | ||
183 | }) | ||
184 | .sorted(Comparator.<GameDownload, String>comparing(d -> d.game().getTitle()) | ||
185 | .thenComparing(GameDownload::platform) | ||
186 | .thenComparing(d -> requireNonNullElse(d.version(), "")) | ||
187 | .thenComparing(GameDownload::type) | ||
188 | .thenComparingInt(GameDownload::part)) | ||
189 | .toList(); | ||
190 | }).join(); | ||
191 | } | ||
192 | |||
193 | @Nonnull | ||
194 | @SuppressWarnings("null") | ||
195 | public ProgressBar downloadProgress(@Nonnull String title, int titleMinWidth) { | ||
196 | return new ProgressBarBuilder().setUpdateIntervalMillis(250) | ||
197 | .setTaskName(title + ".".repeat(max(0, titleMinWidth - title.length()))) | ||
198 | .setStyle(this.arguments.getColorMode() == OFF ? UNICODE_BLOCK : COLORFUL_UNICODE_BLOCK) | ||
199 | .setInitialMax(1) | ||
200 | .setUnit(" MiB", 1024L * 1024L) | ||
201 | .build(); | ||
202 | } | ||
203 | |||
204 | @Nonnull | ||
205 | @SuppressWarnings("null") | ||
206 | private ProgressBar createGameLoadingProgress() { | ||
207 | return new ProgressBarBuilder().setUpdateIntervalMillis(250) | ||
208 | .setTaskName("Loading games") | ||
209 | .setStyle(this.arguments.getColorMode() == OFF ? UNICODE_BLOCK : COLORFUL_UNICODE_BLOCK) | ||
210 | .setInitialMax(-1) | ||
211 | .continuousUpdate() | ||
212 | .clearDisplayOnFinish() | ||
213 | .hideEta() | ||
214 | .build(); | ||
215 | } | ||
216 | |||
217 | @Override | ||
218 | public Integer call() throws Exception { | ||
219 | setVerbose(this.arguments.isVerbose()); | ||
220 | setColorMode(this.arguments.getColorMode()); | ||
221 | |||
222 | try { | ||
223 | run(); | ||
224 | } catch (NotLoggedInException e) { | ||
225 | println(""" | ||
226 | @|bold,red Invalid token.|@ Find your token by logging into GOG in your browser, \ | ||
227 | and copying the "gog-al" cookie from its developer tools."""); | ||
228 | return 1; | ||
229 | } | ||
230 | return 0; | ||
231 | } | ||
232 | |||
233 | public static void main(String[] args) { | ||
234 | Signal.handle(new Signal("INT"), s -> { | ||
235 | out.println(); | ||
236 | exit(0); | ||
237 | }); | ||
238 | |||
239 | exit(new CommandLine(new Main()).setUsageHelpAutoWidth(true) | ||
240 | .setUsageHelpLongOptionsMaxWidth(50) | ||
241 | .setCaseInsensitiveEnumValuesAllowed(true) | ||
242 | .setOverwrittenOptionsAllowed(true) | ||
243 | .execute(args)); | ||
244 | } | ||
245 | |||
246 | } | ||
diff --git a/src/main/java/zajc/gogarchiver/api/Game.java b/src/main/java/zajc/gogarchiver/api/Game.java new file mode 100644 index 0000000..5180a20 --- /dev/null +++ b/src/main/java/zajc/gogarchiver/api/Game.java | |||
@@ -0,0 +1,103 @@ | |||
1 | //SPDX-License-Identifier: GPL-3.0 | ||
2 | /* | ||
3 | * gogarchiver-ng, an archival tool for GOG.com | ||
4 | * Copyright (C) 2024 Marko Zajc | ||
5 | * | ||
6 | * This program is free software: you can redistribute it and/or modify it under the | ||
7 | * terms of the GNU General Public License as published by the Free Software | ||
8 | * Foundation, version 3. | ||
9 | * | ||
10 | * This program is distributed in the hope that it will be useful, but WITHOUT ANY | ||
11 | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | ||
12 | * PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
13 | * | ||
14 | * You should have received a copy of the GNU General Public License along with this | ||
15 | * program. If not, see <https://www.gnu.org/licenses/>. | ||
16 | */ | ||
17 | package zajc.gogarchiver.api; | ||
18 | |||
19 | import static java.util.Objects.hash; | ||
20 | import static zajc.gogarchiver.util.Utilities.stream; | ||
21 | |||
22 | import java.util.*; | ||
23 | |||
24 | import javax.annotation.Nonnull; | ||
25 | |||
26 | import kong.unirest.json.*; | ||
27 | import zajc.gogarchiver.api.GameDownload.Platform; | ||
28 | |||
29 | public class Game { | ||
30 | |||
31 | @Nonnull private final User user; | ||
32 | @Nonnull private final String id; | ||
33 | @Nonnull private final String title; | ||
34 | @Nonnull private final List<GameDownload> downloads; | ||
35 | @Nonnull private final List<GameDlc> dlcs; | ||
36 | |||
37 | @SuppressWarnings("null") | ||
38 | protected Game(@Nonnull User user, @Nonnull String id, @Nonnull String title, @Nonnull JSONObject downloads, | ||
39 | @Nonnull JSONArray dlcs) { | ||
40 | this.user = user; | ||
41 | this.id = id; | ||
42 | this.title = title; | ||
43 | |||
44 | this.downloads = downloads.keySet().stream().flatMap(p -> { | ||
45 | var platform = Platform.valueOf(p.toUpperCase()); | ||
46 | return stream(downloads.getJSONArray(p)).map(JSONObject.class::cast) | ||
47 | .map(d -> GameDownload.fromJson(this, d, platform)); // NOSONAR | ||
48 | }).toList(); | ||
49 | |||
50 | this.dlcs = stream(dlcs).map(JSONObject.class::cast).map(j -> GameDlc.fromJson(this, j)).toList(); | ||
51 | } | ||
52 | |||
53 | @Nonnull | ||
54 | @SuppressWarnings("null") | ||
55 | public static Game fromJson(@Nonnull User user, @Nonnull JSONObject json, @Nonnull String id) { | ||
56 | var title = json.getString("title"); | ||
57 | var downloads = json.getJSONArray("downloads").getJSONArray(0).getJSONObject(1); | ||
58 | var dlcs = json.getJSONArray("dlcs"); | ||
59 | |||
60 | return new Game(user, id, title, downloads, dlcs); | ||
61 | } | ||
62 | |||
63 | @Nonnull | ||
64 | public User getUser() { | ||
65 | return this.user; | ||
66 | } | ||
67 | |||
68 | @Nonnull | ||
69 | public String getId() { | ||
70 | return this.id; | ||
71 | } | ||
72 | |||
73 | @Nonnull | ||
74 | public String getTitle() { | ||
75 | return this.title; | ||
76 | } | ||
77 | |||
78 | @Nonnull | ||
79 | public List<GameDownload> getDownloads() { | ||
80 | return this.downloads; | ||
81 | } | ||
82 | |||
83 | @Nonnull | ||
84 | public List<GameDlc> getDlcs() { | ||
85 | return this.dlcs; | ||
86 | } | ||
87 | |||
88 | @Override | ||
89 | public int hashCode() { | ||
90 | return hash(this.id, this.title); | ||
91 | } | ||
92 | |||
93 | @Override | ||
94 | public boolean equals(Object obj) { | ||
95 | if (this == obj) | ||
96 | return true; | ||
97 | if (obj instanceof Game other) | ||
98 | return Objects.equals(this.id, other.id) && Objects.equals(this.title, other.title); | ||
99 | else | ||
100 | return false; | ||
101 | } | ||
102 | |||
103 | } | ||
diff --git a/src/main/java/zajc/gogarchiver/api/GameDlc.java b/src/main/java/zajc/gogarchiver/api/GameDlc.java new file mode 100644 index 0000000..91a08ac --- /dev/null +++ b/src/main/java/zajc/gogarchiver/api/GameDlc.java | |||
@@ -0,0 +1,69 @@ | |||
1 | //SPDX-License-Identifier: GPL-3.0 | ||
2 | /* | ||
3 | * gogarchiver-ng, an archival tool for GOG.com | ||
4 | * Copyright (C) 2024 Marko Zajc | ||
5 | * | ||
6 | * This program is free software: you can redistribute it and/or modify it under the | ||
7 | * terms of the GNU General Public License as published by the Free Software | ||
8 | * Foundation, version 3. | ||
9 | * | ||
10 | * This program is distributed in the hope that it will be useful, but WITHOUT ANY | ||
11 | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | ||
12 | * PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
13 | * | ||
14 | * You should have received a copy of the GNU General Public License along with this | ||
15 | * program. If not, see <https://www.gnu.org/licenses/>. | ||
16 | */ | ||
17 | package zajc.gogarchiver.api; | ||
18 | |||
19 | import java.util.Objects; | ||
20 | |||
21 | import javax.annotation.Nonnull; | ||
22 | |||
23 | import kong.unirest.json.*; | ||
24 | |||
25 | public class GameDlc extends Game { | ||
26 | |||
27 | @Nonnull private final Game parent; | ||
28 | |||
29 | private GameDlc(@Nonnull Game parent, @Nonnull String title, @Nonnull JSONObject downloads) { | ||
30 | super(parent.getUser(), parent.getId(), title, downloads, new JSONArray()); | ||
31 | |||
32 | this.parent = parent; | ||
33 | } | ||
34 | |||
35 | @Nonnull | ||
36 | @SuppressWarnings("null") | ||
37 | public static GameDlc fromJson(@Nonnull Game parent, @Nonnull JSONObject json) { | ||
38 | var title = json.getString("title"); | ||
39 | var downloads = json.getJSONArray("downloads").getJSONArray(0).getJSONObject(1); | ||
40 | |||
41 | return new GameDlc(parent, title, downloads); | ||
42 | } | ||
43 | |||
44 | @Nonnull | ||
45 | public Game getParent() { | ||
46 | return this.parent; | ||
47 | } | ||
48 | |||
49 | @Override | ||
50 | public int hashCode() { | ||
51 | final int prime = 31; | ||
52 | int result = super.hashCode(); | ||
53 | result = prime * result + Objects.hash(this.parent); | ||
54 | return result; | ||
55 | } | ||
56 | |||
57 | @Override | ||
58 | public boolean equals(Object obj) { | ||
59 | if (this == obj) | ||
60 | return true; | ||
61 | else if (!super.equals(obj)) | ||
62 | return false; | ||
63 | else if (obj instanceof GameDlc other) | ||
64 | return Objects.equals(this.parent, other.parent); | ||
65 | else | ||
66 | return false; | ||
67 | } | ||
68 | |||
69 | } | ||
diff --git a/src/main/java/zajc/gogarchiver/api/GameDownload.java b/src/main/java/zajc/gogarchiver/api/GameDownload.java new file mode 100644 index 0000000..61a1d41 --- /dev/null +++ b/src/main/java/zajc/gogarchiver/api/GameDownload.java | |||
@@ -0,0 +1,149 @@ | |||
1 | //SPDX-License-Identifier: GPL-3.0 | ||
2 | /* | ||
3 | * gogarchiver-ng, an archival tool for GOG.com | ||
4 | * Copyright (C) 2024 Marko Zajc | ||
5 | * | ||
6 | * This program is free software: you can redistribute it and/or modify it under the | ||
7 | * terms of the GNU General Public License as published by the Free Software | ||
8 | * Foundation, version 3. | ||
9 | * | ||
10 | * This program is distributed in the hope that it will be useful, but WITHOUT ANY | ||
11 | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | ||
12 | * PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
13 | * | ||
14 | * You should have received a copy of the GNU General Public License along with this | ||
15 | * program. If not, see <https://www.gnu.org/licenses/>. | ||
16 | */ | ||
17 | package zajc.gogarchiver.api; | ||
18 | |||
19 | import static java.lang.Integer.parseInt; | ||
20 | import static java.lang.String.format; | ||
21 | import static java.nio.charset.StandardCharsets.UTF_8; | ||
22 | import static java.util.Objects.hash; | ||
23 | import static java.util.regex.Pattern.compile; | ||
24 | import static zajc.gogarchiver.api.GameDownload.Type.*; | ||
25 | import static zajc.gogarchiver.util.Utilities.warn; | ||
26 | |||
27 | import java.io.IOException; | ||
28 | import java.net.URLDecoder; | ||
29 | import java.nio.file.Path; | ||
30 | import java.util.Objects; | ||
31 | import java.util.regex.Pattern; | ||
32 | |||
33 | import javax.annotation.*; | ||
34 | |||
35 | import kong.unirest.json.JSONObject; | ||
36 | import me.tongfei.progressbar.ProgressBar; | ||
37 | import zajc.gogarchiver.util.LazyValue; | ||
38 | |||
39 | public record GameDownload(@Nonnull Game game, @Nonnull String originalUrl, @Nonnull LazyValue<String> resolvedUrl, | ||
40 | @Nonnull Platform platform, @Nullable String name, @Nullable String version, | ||
41 | @Nonnull Type type, int part) { | ||
42 | |||
43 | private static final Pattern TYPE_PATTERN = compile("\\d+(\\p{IsLatin}+)"); | ||
44 | private static final Pattern PART_PATTERN = compile("\\d+$"); | ||
45 | |||
46 | @Nonnull | ||
47 | public static GameDownload fromJson(@Nonnull Game game, @Nonnull JSONObject download, @Nonnull Platform platform) { | ||
48 | var url = "https://www.gog.com/" + download.getString("manualUrl").substring(1); | ||
49 | var name = download.optString("name"); | ||
50 | var version = download.optString("version"); | ||
51 | var type = parseType(url); | ||
52 | var part = parsePart(url); | ||
53 | |||
54 | return new GameDownload(game, url, new LazyValue<>(), platform, name, version, type, part); | ||
55 | } | ||
56 | |||
57 | @Nonnull | ||
58 | private static Type parseType(@Nonnull String url) { | ||
59 | var m = TYPE_PATTERN.matcher(url.substring(url.lastIndexOf('/') + 1)); | ||
60 | if (!m.find()) { | ||
61 | warn("Could not extract download type from the url: %s. Please report this to marko@zajc.eu.org.", url); | ||
62 | return UNKNOWN; | ||
63 | } | ||
64 | |||
65 | return switch (m.group(1)) { | ||
66 | case "installer" -> INSTALLER; | ||
67 | case "patch" -> PATCH; | ||
68 | default -> { | ||
69 | warn("Unknown download type: %s. Please report this to marko@zajc.eu.org.", m.group(1)); | ||
70 | yield UNKNOWN; | ||
71 | } | ||
72 | }; | ||
73 | } | ||
74 | |||
75 | private static int parsePart(@Nonnull String url) { | ||
76 | var m = PART_PATTERN.matcher(url); | ||
77 | if (!m.find()) { | ||
78 | warn("Could not extract part number from the url: %s. Please report this to marko@zajc.eu.org.", url); | ||
79 | return 0; | ||
80 | |||
81 | } else { | ||
82 | return parseInt(m.group()); | ||
83 | } | ||
84 | } | ||
85 | |||
86 | @SuppressWarnings("null") | ||
87 | public void downloadTo(@Nonnull Path outputDirectory, @Nullable ProgressBar monitor) throws IOException { | ||
88 | game().getUser().downloadTo(this, outputDirectory.resolve(path()), monitor); | ||
89 | } | ||
90 | |||
91 | @Nonnull | ||
92 | @SuppressWarnings("null") | ||
93 | public Path path() { | ||
94 | return Path.of(this.game.getTitle(), this.platform.toString().toLowerCase(), this.type.toString().toLowerCase(), | ||
95 | URLDecoder.decode(url().substring(url().lastIndexOf('/') + 1), UTF_8)); | ||
96 | } | ||
97 | |||
98 | @Nonnull | ||
99 | @SuppressWarnings("null") | ||
100 | public String url() { | ||
101 | return this.resolvedUrl.get(() -> game().getUser().resolveUrl(this)); | ||
102 | } | ||
103 | |||
104 | @Nonnull | ||
105 | @SuppressWarnings("null") | ||
106 | public String getProgressTitle() { | ||
107 | return format("%s (%s%s%s, %s)", game().getTitle(), this.part != 0 ? "part " + (part() + 1) + ", " : "", | ||
108 | version() != null ? "ver. " + version() + ", " : "", platform().toString().toLowerCase(), | ||
109 | type().toString().toLowerCase()); | ||
110 | } | ||
111 | |||
112 | @Override | ||
113 | public int hashCode() { | ||
114 | return hash(this.game, this.name, this.originalUrl, this.platform, this.type, this.version); | ||
115 | } | ||
116 | |||
117 | @Override | ||
118 | public boolean equals(Object obj) { | ||
119 | if (this == obj) | ||
120 | return true; | ||
121 | if (obj instanceof GameDownload other) | ||
122 | return Objects.equals(this.game, other.game) && Objects.equals(this.name, other.name) | ||
123 | && Objects.equals(this.originalUrl, other.originalUrl) && this.platform == other.platform | ||
124 | && this.type == other.type && Objects.equals(this.version, other.version); | ||
125 | else | ||
126 | return false; | ||
127 | } | ||
128 | |||
129 | public enum Platform { | ||
130 | |||
131 | LINUX, | ||
132 | WINDOWS, | ||
133 | MAC; | ||
134 | |||
135 | @Override | ||
136 | public String toString() { | ||
137 | return name().toLowerCase(); | ||
138 | } | ||
139 | } | ||
140 | |||
141 | public enum Type { | ||
142 | |||
143 | INSTALLER, | ||
144 | PATCH, | ||
145 | UNKNOWN; | ||
146 | |||
147 | } | ||
148 | |||
149 | } | ||
diff --git a/src/main/java/zajc/gogarchiver/api/User.java b/src/main/java/zajc/gogarchiver/api/User.java new file mode 100644 index 0000000..114cb26 --- /dev/null +++ b/src/main/java/zajc/gogarchiver/api/User.java | |||
@@ -0,0 +1,168 @@ | |||
1 | //SPDX-License-Identifier: GPL-3.0 | ||
2 | /* | ||
3 | * gogarchiver-ng, an archival tool for GOG.com | ||
4 | * Copyright (C) 2024 Marko Zajc | ||
5 | * | ||
6 | * This program is free software: you can redistribute it and/or modify it under the | ||
7 | * terms of the GNU General Public License as published by the Free Software | ||
8 | * Foundation, version 3. | ||
9 | * | ||
10 | * This program is distributed in the hope that it will be useful, but WITHOUT ANY | ||
11 | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | ||
12 | * PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
13 | * | ||
14 | * You should have received a copy of the GNU General Public License along with this | ||
15 | * program. If not, see <https://www.gnu.org/licenses/>. | ||
16 | */ | ||
17 | package zajc.gogarchiver.api; | ||
18 | |||
19 | import static java.io.File.separatorChar; | ||
20 | import static java.nio.file.Files.createDirectories; | ||
21 | import static java.util.stream.Collectors.toUnmodifiableSet; | ||
22 | import static zajc.gogarchiver.api.GameDownload.Platform.LINUX; | ||
23 | import static zajc.gogarchiver.util.Utilities.*; | ||
24 | |||
25 | import java.io.*; | ||
26 | import java.nio.file.Path; | ||
27 | import java.util.*; | ||
28 | import java.util.concurrent.ConcurrentHashMap; | ||
29 | |||
30 | import javax.annotation.*; | ||
31 | |||
32 | import kong.unirest.*; | ||
33 | import kong.unirest.json.JSONObject; | ||
34 | import me.tongfei.progressbar.ProgressBar; | ||
35 | import zajc.gogarchiver.exception.NotLoggedInException; | ||
36 | import zajc.gogarchiver.util.LazyValue; | ||
37 | |||
38 | public class User { | ||
39 | |||
40 | private static final UnirestInstance UNIREST_NO_REDIRECT = new UnirestInstance(new Config().followRedirects(false)); | ||
41 | |||
42 | private static final String URL_USER = "https://www.gog.com/userData.json"; | ||
43 | private static final String URL_LIBRARY = "https://menu.gog.com/v1/account/licences"; | ||
44 | private static final String URL_GAME_DETAILS = "https://www.gog.com/account/gameDetails/%s.json"; | ||
45 | |||
46 | @Nonnull private final String token; | ||
47 | @Nonnull private final LazyValue<Set<String>> libraryIds = new LazyValue<>(); | ||
48 | @Nonnull private final LazyValue<JSONObject> userData = new LazyValue<>(); | ||
49 | @Nonnull private final Map<String, Game> games = new ConcurrentHashMap<>(); | ||
50 | |||
51 | public User(@Nonnull String token) throws NotLoggedInException { | ||
52 | this.token = token; | ||
53 | |||
54 | if (!isLoggedIn()) | ||
55 | throw new NotLoggedInException(); | ||
56 | } | ||
57 | |||
58 | private boolean isLoggedIn() { | ||
59 | return getUserData().getBoolean("isLoggedIn"); | ||
60 | } | ||
61 | |||
62 | @Nonnull | ||
63 | @SuppressWarnings("null") | ||
64 | public String getUsername() { | ||
65 | return getUserData().getString("username"); | ||
66 | } | ||
67 | |||
68 | @Nonnull | ||
69 | @SuppressWarnings("null") | ||
70 | private JSONObject getUserData() { | ||
71 | return this.userData.get(() -> getJson(URL_USER).getObject()); | ||
72 | } | ||
73 | |||
74 | @Nonnull | ||
75 | @SuppressWarnings("null") | ||
76 | public Set<String> getLibraryIds() { | ||
77 | return this.libraryIds | ||
78 | .get(() -> stream(getJson(URL_LIBRARY).getArray()).map(Object::toString).collect(toUnmodifiableSet())); | ||
79 | } | ||
80 | |||
81 | @Nullable | ||
82 | public Game resolveGame(@Nonnull String id) { | ||
83 | return this.games.computeIfAbsent(id, this::resolveGameDirectly); | ||
84 | } | ||
85 | |||
86 | @Nullable | ||
87 | @SuppressWarnings("null") | ||
88 | public Game resolveGameDirectly(@Nonnull String id) { | ||
89 | if (!getLibraryIds().contains(id)) { | ||
90 | warn("User @|bold %s|@ does not own game @|bold %s|@.", getUsername(), id); | ||
91 | return null; | ||
92 | } | ||
93 | |||
94 | var json = getJson(URL_GAME_DETAILS.formatted(id)); | ||
95 | if (json.isArray() && json.getArray().isEmpty()) // is a dlc | ||
96 | return null; | ||
97 | else | ||
98 | return Game.fromJson(this, json.getObject(), id); | ||
99 | } | ||
100 | |||
101 | @Nonnull | ||
102 | @SuppressWarnings("null") | ||
103 | public JsonNode getJson(@Nonnull String url) { | ||
104 | return checkResponse(url, get(url).asJson()).getBody(); | ||
105 | } | ||
106 | |||
107 | @SuppressWarnings("resource") | ||
108 | public void downloadTo(@Nonnull GameDownload download, @Nonnull Path output, | ||
109 | @Nullable ProgressBar monitor) throws IOException { | ||
110 | var parent = output.getParent(); | ||
111 | if (parent != null) | ||
112 | createDirectories(parent); | ||
113 | |||
114 | var temp = new File((parent == null ? "" : parent.toString() + separatorChar) + '.' + | ||
115 | output.getFileName().toString() + | ||
116 | ".part"); | ||
117 | temp.deleteOnExit(); // NOSONAR it's good enough | ||
118 | |||
119 | var req = get(download.url()); | ||
120 | if (monitor != null) { | ||
121 | req.downloadMonitor((_1, _2, downloaded, total) -> { | ||
122 | if (monitor.getMax() == 1) | ||
123 | monitor.maxHint(total); | ||
124 | monitor.stepTo(downloaded); | ||
125 | }); | ||
126 | } | ||
127 | |||
128 | var outputFile = checkResponse(download.originalUrl(), req.asFile(temp.getPath())).getBody(); | ||
129 | if (download.platform() == LINUX) | ||
130 | outputFile.setExecutable(true, false); // NOSONAR doesn't matter much | ||
131 | |||
132 | if (!outputFile.renameTo(output.toFile())) | ||
133 | throw new IOException("Couldn't rename the part file"); | ||
134 | } | ||
135 | |||
136 | @Nonnull | ||
137 | @SuppressWarnings("null") | ||
138 | public String resolveUrl(@Nonnull GameDownload download) { | ||
139 | var location = download.originalUrl(); | ||
140 | try (var unirest = Unirest.spawnInstance()) { | ||
141 | unirest.config().followRedirects(false); | ||
142 | |||
143 | for (int i = 0; i < 10; i++) { | ||
144 | var newLocation = UNIREST_NO_REDIRECT.get(location) | ||
145 | .cookie("gog-al", this.token) | ||
146 | .asEmpty() | ||
147 | .getHeaders() | ||
148 | .all() | ||
149 | .stream() | ||
150 | .filter(h -> h.getName().equalsIgnoreCase("location")) | ||
151 | .findFirst() | ||
152 | .map(Header::getValue); | ||
153 | |||
154 | if (newLocation.isPresent()) | ||
155 | location = newLocation.get(); | ||
156 | else | ||
157 | return location; | ||
158 | } | ||
159 | } | ||
160 | |||
161 | throw new RuntimeException("Encountered a redirect loop on " + download.originalUrl()); | ||
162 | } | ||
163 | |||
164 | public GetRequest get(@Nonnull String url) { | ||
165 | return Unirest.get(url).cookie("gog-al", this.token); | ||
166 | } | ||
167 | |||
168 | } | ||
diff --git a/src/main/java/zajc/gogarchiver/exception/NotLoggedInException.java b/src/main/java/zajc/gogarchiver/exception/NotLoggedInException.java new file mode 100644 index 0000000..15d1a86 --- /dev/null +++ b/src/main/java/zajc/gogarchiver/exception/NotLoggedInException.java | |||
@@ -0,0 +1,25 @@ | |||
1 | //SPDX-License-Identifier: GPL-3.0 | ||
2 | /* | ||
3 | * gogarchiver-ng, an archival tool for GOG.com | ||
4 | * Copyright (C) 2024 Marko Zajc | ||
5 | * | ||
6 | * This program is free software: you can redistribute it and/or modify it under the | ||
7 | * terms of the GNU General Public License as published by the Free Software | ||
8 | * Foundation, version 3. | ||
9 | * | ||
10 | * This program is distributed in the hope that it will be useful, but WITHOUT ANY | ||
11 | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | ||
12 | * PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
13 | * | ||
14 | * You should have received a copy of the GNU General Public License along with this | ||
15 | * program. If not, see <https://www.gnu.org/licenses/>. | ||
16 | */ | ||
17 | package zajc.gogarchiver.exception; | ||
18 | |||
19 | public class NotLoggedInException extends Exception { | ||
20 | |||
21 | public NotLoggedInException() { | ||
22 | super(); | ||
23 | } | ||
24 | |||
25 | } | ||
diff --git a/src/main/java/zajc/gogarchiver/util/LazyValue.java b/src/main/java/zajc/gogarchiver/util/LazyValue.java new file mode 100644 index 0000000..118193f --- /dev/null +++ b/src/main/java/zajc/gogarchiver/util/LazyValue.java | |||
@@ -0,0 +1,42 @@ | |||
1 | //SPDX-License-Identifier: GPL-3.0 | ||
2 | /* | ||
3 | * gogarchiver-ng, an archival tool for GOG.com | ||
4 | * Copyright (C) 2024 Marko Zajc | ||
5 | * | ||
6 | * This program is free software: you can redistribute it and/or modify it under the | ||
7 | * terms of the GNU General Public License as published by the Free Software | ||
8 | * Foundation, version 3. | ||
9 | * | ||
10 | * This program is distributed in the hope that it will be useful, but WITHOUT ANY | ||
11 | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | ||
12 | * PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
13 | * | ||
14 | * You should have received a copy of the GNU General Public License along with this | ||
15 | * program. If not, see <https://www.gnu.org/licenses/>. | ||
16 | */ | ||
17 | package zajc.gogarchiver.util; | ||
18 | |||
19 | import java.util.function.Supplier; | ||
20 | |||
21 | import javax.annotation.*; | ||
22 | |||
23 | public class LazyValue<T> { | ||
24 | |||
25 | @Nullable private volatile T value; | ||
26 | |||
27 | public T get(@Nonnull Supplier<T> generator) { | ||
28 | if (this.value != null) | ||
29 | return this.value; | ||
30 | synchronized (this) { | ||
31 | if (this.value != null) // double checked locking | ||
32 | return this.value; | ||
33 | else | ||
34 | return this.value = generator.get(); | ||
35 | } | ||
36 | } | ||
37 | |||
38 | public synchronized void unset() { | ||
39 | this.value = null; | ||
40 | } | ||
41 | |||
42 | } | ||
diff --git a/src/main/java/zajc/gogarchiver/util/Utilities.java b/src/main/java/zajc/gogarchiver/util/Utilities.java new file mode 100644 index 0000000..d039ab1 --- /dev/null +++ b/src/main/java/zajc/gogarchiver/util/Utilities.java | |||
@@ -0,0 +1,80 @@ | |||
1 | //SPDX-License-Identifier: GPL-3.0 | ||
2 | /* | ||
3 | * gogarchiver-ng, an archival tool for GOG.com | ||
4 | * Copyright (C) 2024 Marko Zajc | ||
5 | * | ||
6 | * This program is free software: you can redistribute it and/or modify it under the | ||
7 | * terms of the GNU General Public License as published by the Free Software | ||
8 | * Foundation, version 3. | ||
9 | * | ||
10 | * This program is distributed in the hope that it will be useful, but WITHOUT ANY | ||
11 | * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | ||
12 | * PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
13 | * | ||
14 | * You should have received a copy of the GNU General Public License along with this | ||
15 | * program. If not, see <https://www.gnu.org/licenses/>. | ||
16 | */ | ||
17 | package zajc.gogarchiver.util; | ||
18 | |||
19 | import static java.lang.System.err; | ||
20 | import static picocli.CommandLine.Help.defaultColorScheme; | ||
21 | |||
22 | import java.util.stream.*; | ||
23 | |||
24 | import javax.annotation.*; | ||
25 | |||
26 | import kong.unirest.HttpResponse; | ||
27 | import kong.unirest.json.JSONArray; | ||
28 | import picocli.CommandLine.Help.*; | ||
29 | |||
30 | public class Utilities { | ||
31 | |||
32 | private static boolean enableVerbose = false; | ||
33 | private static ColorScheme colorScheme; | ||
34 | |||
35 | public static void setVerbose(boolean verbose) { | ||
36 | enableVerbose = verbose; | ||
37 | } | ||
38 | |||
39 | public static void setColorMode(@Nonnull Ansi ansi) { | ||
40 | colorScheme = defaultColorScheme(ansi); | ||
41 | } | ||
42 | |||
43 | public static void println(@Nullable Object text) { | ||
44 | err.println(colorScheme.text(String.valueOf(text))); | ||
45 | } | ||
46 | |||
47 | public static void printf(@Nonnull String format, @Nonnull Object... args) { | ||
48 | err.print(colorScheme.text(format.formatted(args))); | ||
49 | } | ||
50 | |||
51 | public static void warn(@Nonnull String text, @Nonnull Object... args) { | ||
52 | println("@|yellow [W]|@ " + text.formatted(args)); | ||
53 | } | ||
54 | |||
55 | public static void verbose(@Nonnull String text, @Nonnull Object... args) { | ||
56 | if (enableVerbose) | ||
57 | println("@|faint [V]|@ " + text.formatted(args)); | ||
58 | } | ||
59 | |||
60 | public static <T> HttpResponse<T> checkResponse(String url, HttpResponse<T> resp) { | ||
61 | if (!resp.isSuccess()) | ||
62 | throw new RuntimeException("Got a bad HTTP response on %s: %d %s".formatted(url, resp.getStatus(), | ||
63 | resp.getStatusText())); | ||
64 | |||
65 | return resp; | ||
66 | } | ||
67 | |||
68 | @Nonnull | ||
69 | @SuppressWarnings("null") | ||
70 | public static Stream<Object> stream(JSONArray array) { | ||
71 | return StreamSupport.stream(array.spliterator(), false); | ||
72 | } | ||
73 | |||
74 | public static void cursorUp() { | ||
75 | err.print("\u001b[1A"); | ||
76 | } | ||
77 | |||
78 | private Utilities() {} | ||
79 | |||
80 | } | ||
diff --git a/versions-ruleset.xml b/versions-ruleset.xml new file mode 100644 index 0000000..93be4ae --- /dev/null +++ b/versions-ruleset.xml | |||
@@ -0,0 +1,13 @@ | |||
1 | <ruleset | ||
2 | xmlns="http://mojo.codehaus.org/versions-maven-plugin/rule/2.0.0" | ||
3 | xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
4 | comparisonMethod="maven" | ||
5 | xsi:schemaLocation="http://mojo.codehaus.org/versions-maven-plugin/rule/2.0.0 https://mojo.codehaus.org/versions-maven-plugin/xsd/rule-2.0.0.xsd"> | ||
6 | <rules> | ||
7 | <rule groupId="*"> | ||
8 | <ignoreVersions> | ||
9 | <ignoreVersion type="regex">.*(-|\.)(beta|alpha|RC|M)(\.)?\d+$</ignoreVersion> | ||
10 | </ignoreVersions> | ||
11 | </rule> | ||
12 | </rules> | ||
13 | </ruleset> | ||