├── .github
└── workflows
│ └── deploy.yml
├── LICENSE
├── README.md
├── server
├── .env.example
├── .eslintrc.js
├── .gitignore
├── .vscode
│ └── launch.json
├── package-lock.json
├── package.json
├── prisma
│ ├── migrations
│ │ ├── 20230321001753_init
│ │ │ └── migration.sql
│ │ ├── 20230321004112_init
│ │ │ └── migration.sql
│ │ └── migration_lock.toml
│ └── schema.prisma
├── src
│ ├── api
│ │ ├── index.js
│ │ └── songs
│ │ │ ├── middlewares.js
│ │ │ ├── songs.routes.js
│ │ │ └── songs.services.js
│ ├── app.js
│ ├── config.js
│ ├── index.js
│ ├── middlewares.js
│ └── utils
│ │ └── db.js
└── test
│ └── api.test.js
└── static
├── CNAME
├── assets
├── interaction.wav
├── key0.mp3
├── key1.mp3
├── key2.mp3
├── key3.mp3
└── placeholder.png
├── favicon.ico
├── index.html
├── manifest.webmanifest
├── scripts
├── index.js
├── lastfm.api.cache.js
├── lastfm.api.js
└── lastfm.api.md5.js
└── styles
└── index.css
/.github/workflows/deploy.yml:
--------------------------------------------------------------------------------
1 | name: Deploy
2 |
3 | on:
4 | push:
5 | paths:
6 | - static/*
7 | workflow_dispatch:
8 |
9 | jobs:
10 | deploy:
11 | runs-on: ubuntu-latest
12 | steps:
13 | - uses: actions/checkout@v3
14 |
15 | - name: Deploy
16 | uses: s0/git-publish-subdir-action@develop
17 | env:
18 | REPO: self
19 | BRANCH: gh-pages
20 | FOLDER: static
21 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
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 |
635 | Copyright (C)
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 .
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 | Copyright (C)
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 | .
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 | .
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # osum!player - A music player for the web
2 |
3 | A music player built in vanilla web technologies out of the need of a good music player.
4 |
5 | ## 🔬 Demo
6 |
7 | Visit [music.osumatrix.me](https://music.osumatrix.me/) for a demo!
8 |
9 | ## 🖼️ Previews
10 |
11 | Get a glimpse of osum!player and it's features.
12 |
13 | ### ▶️ Player
14 |
15 | Intuitive and minimalistic player with your keyboard in mind.
16 |
17 |
18 |
19 | ### 🔍 Search
20 |
21 | Effortless instant global search.
22 |
23 |
24 |
25 | ### 🚩 Marker
26 |
27 | Add marker to your favourite spots or highlights.
28 |
29 |
30 |
31 | ### 📱 Mobile view
32 |
33 | Access the player from any device.
34 |
35 |
36 |
37 | ## ⭐ Features
38 |
39 | - Fast & responsive
40 | - Mark hot spots
41 | - Intuitive UX
42 | - Minimal design
43 | - Keyboard oriented
44 | - Autoplay, shuffle, repeat or play once
45 | - Global search
46 | - Play history
47 |
48 | ## 🪛 Server setup
49 |
50 | 1. Clone the repository:
51 |
52 | ```bash
53 | git clone git@github.com/oSumAtrIX/osum-player
54 | cd osum-player/server
55 | ```
56 |
57 | 2. Install dependencies
58 |
59 | 1. Install libjpeg development package if you are on Linux
60 | 2. Run `npm i`
61 |
62 | 3. Migrate the database:
63 |
64 | ```bash
65 | npx prisma migrate deploy
66 | ```
67 |
68 | 4. Configure environment variables following the example from `env.example`:
69 |
70 | 5. Start the server
71 |
72 | ```bash
73 | npm start
74 | ```
75 |
76 | ## ⌨️ Keybinds
77 |
78 | | Shortcut | Description |
79 | | ------------ | ----------------------------------------------------------------------------------------------- |
80 | | `CTRL+P` | Rotate between play modes (Autoplay, shuffle, repeat or play once) |
81 | | `CTRL+M` | Add marker to highlight hotspots in your songs |
82 | | `CTRL+C` | Clear all markers |
83 | | `CTRL+A` | Toggle animations |
84 | | `CTRL+E` | Rotate between endpoints |
85 | | `CTRL+S` | Sort by modified date or added |
86 | | `CTRL+Plus` | Increase volume |
87 | | `CTRL+Minus` | Decrease volume |
88 | | `CTRL+R` | Quick reload songs to update the database |
89 | | `CTRL+H` | Rotate between random themes |
90 | | `A-Za-z` | Start a search |
91 | | `Escape` | Exit search |
92 | | `Space` | Play, pause, or start a song |
93 | | `Enter` | Start the currently selected song or search result |
94 | | `ArrowLeft` | Scrub backward (Hold `SHIFT` for fine and `CTRL` for rough scrubbing) or play the previous song |
95 | | `ArrowRight` | Scrub forward (Hold `SHIFT` for fine and `CTRL` for rough scrubbing) |
96 | | `ArrowUp` | Select the previous song or the previous search result |
97 | | `ArrowDown` | Play the next song or select the next search result |
98 | | `Home` | Skip to the beginning of the current song |
99 | | `End` | Skip to the end of the current song |
100 | | `PageUp` | Play the previous song |
101 | | `PageDown` | Play the next song |
102 | | `0-9` | Seek to the corresponding time of the song |
103 |
104 | > **Note**: You can use your mouse wheel on the seekbar or album cover to adjust the volume.
105 |
106 | ## 🚀 Action launcher
107 |
108 | You can use the action launcher to quickly perform actions such as playing a song, or changing and toggling settings.
109 | The acton launcher can be opened anytime by typing `>` everywhere or in the quick search bar.
110 |
111 | ## 🚩 Marker
112 |
113 | To add a marker, press `CTRL+M`. The marker will appear on the seekbar which can be useful to highlight or mark favourite parts.
114 | To clear all markers, press `CTRL+C`. The markers will automatically show up when playing songs.
115 |
116 | ## 🐔 Easter egg
117 |
118 | Play with the album cover.
119 |
120 | ## 📝 Todo
121 |
122 | - [x] Backend server
123 | - [x] Adjusting volume with keybinds
124 | - [x] Sort by newest modification date
125 | - [x] Marker
126 | - [x] Various play modes
127 | - [x] Rainbow seekbar (Rotate between themes)
128 | - [x] Last.FM integration
129 | - [ ] Keybinds menu
130 | - [ ] Playlists
131 | - [ ] Queues
132 | - [ ] Sync live changes
133 | - [ ] Global hotkeys
134 | - [ ] Add new audio files with drag & drop
135 | - [ ] Share links
136 |
--------------------------------------------------------------------------------
/server/.env.example:
--------------------------------------------------------------------------------
1 | SERVER_PORT=3000 # the port the server will listen on
2 | SONGS_PATH=songs/ # the path to the songs folder
3 | SONGS_PER_OFFSET=32 # the number of songs to return per offset
4 | DATABASE_URL="file:./database.db?connection_limit=1" # database url
5 | IMAGE_CACHE_PATH=cache/ # the path to the image cache folder
6 | DEMO_MODE=false # whether to enable demo mode
7 | AUTH_TOKEN= # optional authorization token
--------------------------------------------------------------------------------
/server/.eslintrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | env: {
3 | es2021: true,
4 | node: true
5 | },
6 | extends: 'standard',
7 | overrides: [
8 | ],
9 | parserOptions: {
10 | ecmaVersion: 'latest',
11 | sourceType: 'module'
12 | },
13 | rules: {
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/server/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | .env
3 | /songs
4 | database.db
5 | cache
--------------------------------------------------------------------------------
/server/.vscode/launch.json:
--------------------------------------------------------------------------------
1 | {
2 | "version": "0.2.0",
3 | "configurations": [
4 | {
5 | "type": "node",
6 | "request": "launch",
7 | "name": "nodemon",
8 | "runtimeExecutable": "nodemon",
9 | "program": "${workspaceFolder}/src/index.js",
10 | "restart": true,
11 | "console": "integratedTerminal",
12 | "internalConsoleOptions": "neverOpen"
13 | }
14 | ]
15 | }
16 |
--------------------------------------------------------------------------------
/server/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "osum-player",
3 | "version": "0.1.0",
4 | "description": "A music player built in vanilla web technologies out of the need of a good music player",
5 | "main": "index.js",
6 | "scripts": {
7 | "lint": "eslint --fix src",
8 | "test": "mocha --exit",
9 | "start": "node src/index.js",
10 | "debug": "nodemon src/index.js"
11 | },
12 | "repository": {
13 | "type": "git",
14 | "url": "git+https://github.com/oSumAtrIX/osum-player.git"
15 | },
16 | "author": "oSumAtrIX",
17 | "license": "GPL-3.0-or-later",
18 | "bugs": {
19 | "url": "https://github.com/oSumAtrIX/osum-player/issues"
20 | },
21 | "type": "module",
22 | "homepage": "https://osumatrix.me",
23 | "dependencies": {
24 | "@prisma/client": "^4.11.0",
25 | "chokidar": "^3.5.3",
26 | "cookie-parser": "^1.4.6",
27 | "cors": "^2.8.5",
28 | "dotenv": "^16.0.3",
29 | "express": "^4.18.2",
30 | "hound": "^1.0.5",
31 | "imagemin": "^8.0.1",
32 | "imagemin-webp": "^8.0.0",
33 | "music-metadata": "^8.1.3",
34 | "parse-filepath": "^1.0.2",
35 | "sha1": "^1.1.1"
36 | },
37 | "devDependencies": {
38 | "eslint": "^8.35.0",
39 | "eslint-config-standard": "^17.0.0",
40 | "eslint-plugin-import": "^2.27.5",
41 | "eslint-plugin-n": "^15.6.1",
42 | "eslint-plugin-promise": "^6.1.1",
43 | "morgan": "^1.10.0",
44 | "prisma": "^4.11.0",
45 | "supertest": "^6.3.1"
46 | }
47 | }
--------------------------------------------------------------------------------
/server/prisma/migrations/20230321001753_init/migration.sql:
--------------------------------------------------------------------------------
1 | -- CreateTable
2 | CREATE TABLE "Song" (
3 | "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
4 | "title" TEXT,
5 | "artist" TEXT,
6 | "filename" TEXT NOT NULL,
7 | "image" BOOLEAN NOT NULL,
8 | "modified" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP
9 | );
10 |
11 | -- CreateTable
12 | CREATE TABLE "Marker" (
13 | "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
14 | "songId" INTEGER NOT NULL,
15 | "marker" REAL NOT NULL,
16 | CONSTRAINT "Marker_songId_fkey" FOREIGN KEY ("songId") REFERENCES "Song" ("id") ON DELETE RESTRICT ON UPDATE CASCADE
17 | );
18 |
19 | -- CreateIndex
20 | CREATE UNIQUE INDEX "Song_filename_key" ON "Song"("filename");
21 |
--------------------------------------------------------------------------------
/server/prisma/migrations/20230321004112_init/migration.sql:
--------------------------------------------------------------------------------
1 | -- RedefineTables
2 | PRAGMA foreign_keys=OFF;
3 | CREATE TABLE "new_Marker" (
4 | "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
5 | "songId" INTEGER NOT NULL,
6 | "marker" REAL NOT NULL,
7 | CONSTRAINT "Marker_songId_fkey" FOREIGN KEY ("songId") REFERENCES "Song" ("id") ON DELETE CASCADE ON UPDATE CASCADE
8 | );
9 | INSERT INTO "new_Marker" ("id", "marker", "songId") SELECT "id", "marker", "songId" FROM "Marker";
10 | DROP TABLE "Marker";
11 | ALTER TABLE "new_Marker" RENAME TO "Marker";
12 | PRAGMA foreign_key_check;
13 | PRAGMA foreign_keys=ON;
14 |
--------------------------------------------------------------------------------
/server/prisma/migrations/migration_lock.toml:
--------------------------------------------------------------------------------
1 | # Please do not edit this file manually
2 | # It should be added in your version-control system (i.e. Git)
3 | provider = "sqlite"
--------------------------------------------------------------------------------
/server/prisma/schema.prisma:
--------------------------------------------------------------------------------
1 | generator client {
2 | provider = "prisma-client-js"
3 | }
4 |
5 | datasource db {
6 | provider = "sqlite"
7 | url = env("DATABASE_URL")
8 | }
9 |
10 | model Song {
11 | id Int @id @default(autoincrement())
12 | title String?
13 | artist String?
14 | filename String @unique
15 | image Boolean
16 | modified DateTime @default(now())
17 | marker Marker[]
18 | }
19 |
20 | model Marker {
21 | id Int @id @default(autoincrement())
22 | songId Int
23 | marker Float
24 | song Song @relation(fields: [songId], references: [id], onDelete: Cascade)
25 | }
26 |
--------------------------------------------------------------------------------
/server/src/api/index.js:
--------------------------------------------------------------------------------
1 | import { Router } from "express";
2 |
3 | import songs from "./songs/songs.routes.js";
4 |
5 | const router = Router();
6 |
7 | router.get("/", (_, res) => {
8 | res.json({
9 | message: "osum!player server API v1",
10 | });
11 | });
12 |
13 | router.use("/songs", songs);
14 |
15 | export default router;
16 |
--------------------------------------------------------------------------------
/server/src/api/songs/middlewares.js:
--------------------------------------------------------------------------------
1 | import { findSong } from "./songs.services.js";
2 | import config from "../../config.js";
3 |
4 | export function checkDemoMode(_req, res, next) {
5 | if (config.DEMO_MODE) return res.json({ message: "This API is not available in demo mode" });
6 |
7 | next();
8 | }
9 |
10 | export function getId(req, _res, next) {
11 | const id = parseInt(req.params.id);
12 |
13 | if (isNaN(id)) return next(new Error("Invalid song id"));
14 |
15 | req.id = id;
16 |
17 | next();
18 | }
19 |
20 | export async function getSong(req, _res, next) {
21 | if (!req.id) return next(new Error("No id"));
22 |
23 | try {
24 | req.song = await findSong(req.id);
25 |
26 | if (req.song === null) return next(new Error("Song not found"));
27 | } catch (err) {
28 | return next(err);
29 | }
30 |
31 | next();
32 | }
--------------------------------------------------------------------------------
/server/src/api/songs/songs.routes.js:
--------------------------------------------------------------------------------
1 | import { Router } from "express";
2 | import {
3 | findSongs,
4 | getSongFile,
5 | getSongImage,
6 | getMarker,
7 | findSongIdsByQuery,
8 | findIdsByOffset,
9 | findIdsByModifiedDate,
10 | reload,
11 | watch,
12 | stopWatch,
13 | clearMarker,
14 | addMarker,
15 | findSongRandom,
16 | } from "./songs.services.js";
17 | import { getSong, getId, checkDemoMode } from "./middlewares.js";
18 |
19 | const router = Router();
20 |
21 | const defaultSongColumnsSelection = {
22 | artist: true,
23 | title: true,
24 | id: true,
25 | image: true,
26 | modified: true,
27 | };
28 |
29 | router.get("/", async (req, res, next) => {
30 | if (req.query.hasOwnProperty("q")) {
31 | return res.json(
32 | await findSongIdsByQuery(
33 | req.query.q,
34 | parseInt(req.query.limit || 8),
35 | parseInt(req.query.offset || 0)
36 | )
37 | );
38 | }
39 | next();
40 | });
41 |
42 | router.patch("/", checkDemoMode, async (req, res, _next) => {
43 | if (req.query.hasOwnProperty("watch")) {
44 | watch();
45 | res.json({ message: "Watching for changes" });
46 | } else {
47 | stopWatch();
48 | res.json({ message: "Stopped watching for changes" });
49 | }
50 | });
51 |
52 | router.post("/reload", checkDemoMode, async (req, res, next) => {
53 | const start = Date.now();
54 |
55 | const full = req.query.hasOwnProperty("full");
56 | try {
57 | await reload(full);
58 | } catch (err) {
59 | return next(err);
60 | }
61 |
62 | const end = Date.now();
63 | res.json(`Reloaded songs in ${end - start}ms`);
64 | });
65 |
66 | router.patch("/:id/marker", checkDemoMode, getId, async (req, res, next) => {
67 | if (!req.body.marker) return next(new Error("Invalid body"));
68 | if (req.body.marker === "clear") {
69 | try {
70 | await clearMarker(req.id);
71 | } catch (err) {
72 | return next(err);
73 | }
74 |
75 | return res.json({ message: "Cleared marker" });
76 | }
77 |
78 | const marker = parseFloat(req.body.marker);
79 |
80 | if (isNaN(marker)) return next(new Error("Marker must be a number"));
81 |
82 | try {
83 | await addMarker(req.id, marker);
84 | } catch (err) {
85 | return next(err);
86 | }
87 |
88 | res.json({ message: "Added marker" });
89 | });
90 |
91 | router.get("/offset/:offset", async (req, res, next) => {
92 | const offset = parseInt(req.params.offset);
93 |
94 | if (isNaN(offset)) return next(new Error("Invalid offset"));
95 |
96 | const sortByModifiedDate = req.query.hasOwnProperty("sortByModifiedDate");
97 |
98 | let songs = null;
99 | try {
100 | songs = sortByModifiedDate
101 | ? await findIdsByModifiedDate(offset)
102 | : await findIdsByOffset(offset);
103 | } catch (err) {
104 | return next(err);
105 | }
106 |
107 | if (songs == null) return next(new Error("Failed to get songs"));
108 |
109 | res.json(songs);
110 | });
111 |
112 | router.get("/random", async (_req, res, _next) => {
113 | const song = await findSongRandom(defaultSongColumnsSelection);
114 | res.json(song);
115 | });
116 |
117 | router.get("/:id/file", getId, async (req, res, next) => {
118 | let filename = null;
119 | try {
120 | filename = await getSongFile(req.id);
121 | } catch (err) {
122 | return next(err);
123 | }
124 |
125 | if (filename === null) {
126 | res.status(404);
127 | res.end();
128 | return;
129 | }
130 |
131 | res.setHeader("Content-Type", "audio/mpeg");
132 | res.sendFile(filename);
133 | });
134 |
135 | router.get("/:id/image", getId, async (req, res, next) => {
136 | const full = req.query.hasOwnProperty("full");
137 |
138 | let image;
139 | try {
140 | image = await getSongImage(req.id, full);
141 | } catch (err) {
142 | return next(err);
143 | }
144 |
145 | if (image === null) {
146 | res.status(404);
147 | res.end();
148 | return;
149 | }
150 |
151 | res.setHeader("Cache-control", "public, max-age=3600");
152 | res.setHeader("Content-Type", "image");
153 | res.end(image);
154 | });
155 |
156 | router.post("/multiple", async (req, res, next) => {
157 | if (!req.body.ids) return next(new Error("Invalid body"));
158 | if (req.query.ids == "") return res.json([]);
159 |
160 | const songs = await findSongs(req.body.ids, defaultSongColumnsSelection);
161 | res.json(songs);
162 | });
163 |
164 | router.get("/:id/marker", getId, async (req, res, next) => {
165 | const marker = await getMarker(req.id);
166 |
167 | res.json(marker);
168 | });
169 |
170 | router.get("/:id", getId, getSong, async (req, res, next) => {
171 | const song = req.song;
172 |
173 | if (song == null) {
174 | res.status(404);
175 | res.end();
176 | return;
177 | }
178 |
179 | res.json(song);
180 | });
181 |
182 | router.get("/changes", async (req, res, _next) => {
183 | // TODO: Get changes such as when songs are deleted or added to reflect to the client. Use request query to determine if the changes should be flushed.
184 | // WebSocket is probably the best way to do this.
185 |
186 | res.end();
187 | });
188 |
189 | export default router;
190 |
--------------------------------------------------------------------------------
/server/src/api/songs/songs.services.js:
--------------------------------------------------------------------------------
1 | import db from "../../utils/db.js";
2 | import { parseFile } from "music-metadata";
3 | import path from "path";
4 | import imagemin from "imagemin";
5 | import imageminWebp from "imagemin-webp";
6 | import chokidar from "chokidar";
7 | import parsePath from "parse-filepath";
8 | import fs from "fs";
9 | import sha1 from "sha1";
10 | import config from "../../config.js";
11 |
12 | let watcher = null;
13 |
14 | // TODO: Watch on startup of server if enabled previously by saving when enabling and by env variable.
15 | /**
16 | * Start watching for changes.
17 | */
18 | export function watch() {
19 | stopWatch();
20 |
21 | const getBaseName = (file) => parsePath(file).basename;
22 |
23 | watcher = chokidar.watch(config.SONGS_PATH, {
24 | ignoreInitial: true,
25 | awaitWriteFinish: {
26 | stabilityThreshold: 2000,
27 | pollInterval: 500,
28 | },
29 | binaryInterval: 2000,
30 | });
31 |
32 | watcher
33 | .on("add", async (path) => {
34 | const filename = getBaseName(path);
35 | if (!(await isMissing(getBaseName(filename)))) return;
36 |
37 | await addSongByName(filename);
38 | })
39 | .on("unlink", async (path) => {
40 | const song = await findByFilename(getBaseName(path));
41 | await removeSong(song);
42 | });
43 | }
44 |
45 | /**
46 | * Stop watching for changes.
47 | */
48 | export async function stopWatch() {
49 | await watcher?.close();
50 | }
51 |
52 | /**
53 | * Find a song by its id and a list of fields to select.
54 | * @param {number} id The id of the song.
55 | * @param {any} select The fields to select.
56 | * @returns A song.
57 | */
58 | export function findSong(id, select) {
59 | return db.song.findUnique({
60 | where: {
61 | id,
62 | },
63 | select,
64 | });
65 | }
66 |
67 | /**
68 | * Find songs by their ids.
69 | * @param {number[]} ids The ids of the song.
70 | * @param {any} select The fields to select.
71 | * @returns A list of song ids.
72 | */
73 | export function findSongs(ids, select) {
74 | return db.song.findMany({
75 | where: {
76 | id: { in: ids },
77 | },
78 | select,
79 | });
80 | }
81 |
82 | export async function findSongRandom(select) {
83 | const skip = Math.floor(Math.random() * (await db.song.count()));
84 |
85 | const results = await db.song.findMany({
86 | take: 1,
87 | skip,
88 | select,
89 | });
90 |
91 | return results[0];
92 | }
93 |
94 | export async function getSongFile(id) {
95 | const song = await findSong(id, {
96 | filename: true,
97 | });
98 |
99 | if (song === null) return null;
100 |
101 | return path.join(config.SONGS_PATH, song.filename);
102 | }
103 |
104 | /**
105 | * Get the path to an image given a filename.
106 | *
107 | * @param {string} filename The filename of the song.
108 | * @param {boolean} full If the full image should be returned.
109 | * @returns
110 | */
111 | function getImagePath(filename, full = false) {
112 | const imageName = sha1(filename + (full ? "_full" : ""));
113 | return path.join(config.IMAGE_CACHE_PATH, imageName);
114 | }
115 |
116 | export async function getSongImage(id, full = false) {
117 | const song = await findSong(id, {
118 | filename: true,
119 | });
120 |
121 | if (song === null) return null;
122 |
123 | // create path to image
124 | const imagePath = getImagePath(song.filename, full);
125 |
126 | // check if image exists and return it or create it
127 | const imageExists = await fileExists(imagePath);
128 | if (imageExists) return readFile(imagePath);
129 |
130 | let parsedSong;
131 | try {
132 | parsedSong = await parseSongFromFile(song.filename, true);
133 | } catch (e) {
134 | console.log(e);
135 | }
136 |
137 | if (!(parsedSong && parsedSong.image)) return null;
138 |
139 | const image = await compressImage(parsedSong.image, full ? 600 : 64);
140 |
141 | fs.createWriteStream(imagePath).end(image);
142 |
143 | return image;
144 | }
145 |
146 | /**
147 | * Find song ids given a query.
148 | * @param {string} query The query to search for.
149 | * @param {number} limit The limit of songs to return.
150 | * @param {number} offset The offset to start at.
151 | * @param {boolean} orderByModifiedDate Whether to order by modified date.
152 | * @returns A list of song ids.
153 | */
154 | export function findSongIdsByQuery(query, limit, offset, orderByModifiedDate) {
155 | const args = {
156 | where: {
157 | OR: [
158 | { title: { contains: query } },
159 | { artist: { contains: query } },
160 | { filename: { contains: query } },
161 | ],
162 | },
163 | take: limit,
164 | skip: offset,
165 | select: {
166 | id: true,
167 | },
168 | };
169 |
170 | if (orderByModifiedDate)
171 | args.orderBy = {
172 | modified: "desc",
173 | };
174 |
175 | return db.song.findMany(args);
176 | }
177 |
178 | /**
179 | * Find all songs in the database given an offset id.
180 | * @param {number} offset The offset id to start at.
181 | * @returns A list of songs.
182 | */
183 | export function findIdsByOffset(offset) {
184 | const args = {
185 | where: { id: { gte: offset } },
186 | take: config.SONGS_PER_OFFSET,
187 | select: {
188 | id: true,
189 | },
190 | };
191 |
192 | return db.song.findMany(args);
193 | }
194 |
195 | /**
196 | * Find all songs in the database given an offset id ordered by the song file modified date.
197 | * @param {number} page The page to start at.
198 | * @returns A list of songs.
199 | */
200 | export function findIdsByModifiedDate(page) {
201 | const args = {
202 | orderBy: {
203 | modified: "desc",
204 | },
205 | skip: config.SONGS_PER_OFFSET * page,
206 | take: config.SONGS_PER_OFFSET,
207 | select: {
208 | id: true,
209 | },
210 | };
211 |
212 | return db.song.findMany(args);
213 | }
214 |
215 | /**
216 | * Add a song to the database.
217 | * @param {Song} song The song to add.
218 | */
219 | function add(song) {
220 | return db.song.create({
221 | data: song,
222 | });
223 | }
224 |
225 | /**
226 | * Add a marker to a song.
227 | * @param {integer} songId The id of the song to add the marker to.
228 | * @param {*} marker The time of the marker.
229 | */
230 | export function addMarker(songId, marker) {
231 | return db.marker.create({
232 | data: {
233 | marker,
234 | song: {
235 | connect: {
236 | id: songId,
237 | },
238 | },
239 | },
240 | });
241 | }
242 |
243 | /**
244 | * Get all markers from a song.
245 | * @param {integer} songId The id of the song to get the markers from.
246 | * @returns A list of markers.
247 | */
248 | export async function getMarker(songId) {
249 | const marker = await db.marker.findMany({
250 | where: {
251 | songId,
252 | },
253 | select: {
254 | marker: true,
255 | },
256 | });
257 | return marker.map((marker) => marker.marker);
258 | }
259 | /**
260 | * Clear all marker from a song.
261 | * @param {integer} songId The id of the song to remove the markers from.
262 | */
263 | export function clearMarker(songId) {
264 | return db.marker.deleteMany({
265 | where: {
266 | songId,
267 | },
268 | });
269 | }
270 |
271 | /**
272 | * Remove a song from the database.
273 | * @param {Song} song The song to remove.
274 | */
275 | async function removeSong(song) {
276 | const songId = song.id;
277 |
278 | song = await findSong(songId, {
279 | filename: true,
280 | });
281 |
282 | if (song === null) return;
283 |
284 | deleteCache(song);
285 |
286 | return db.song.delete({
287 | where: {
288 | id: songId,
289 | },
290 | });
291 | }
292 |
293 | function deleteCache(song) {
294 | deleteFile(getImagePath(song.filename));
295 | deleteFile(getImagePath(song.filename, true));
296 | }
297 |
298 | function resetCache() {
299 | return new Promise((resolve, _) =>
300 | fs.readdir(config.IMAGE_CACHE_PATH, (err, files) => {
301 | if (err) throw err;
302 |
303 | for (const file of files) {
304 | fs.unlink(path.join(config.IMAGE_CACHE_PATH, file), (err) => {
305 | if (err) throw err;
306 | });
307 | }
308 |
309 | resolve();
310 | })
311 | );
312 | }
313 |
314 | function deleteFile(file) {
315 | if (fileExists(file)) {
316 | fs.unlink(file, () => { });
317 | }
318 | }
319 |
320 | async function fileExists(filePath) {
321 | return new Promise((resolve) =>
322 | fs.access(filePath, fs.constants.F_OK, (err) => resolve(err === null))
323 | );
324 | }
325 |
326 | async function readFile(file) {
327 | return new Promise((resolve, reject) =>
328 | fs.readFile(file, (err, data) => (err ? reject(err) : resolve(data)))
329 | );
330 | }
331 | /**
332 | * Removes songs from the database.
333 | * @param {Song[]} songs The songs to remove.
334 | * @returns The number of songs removed.
335 | */
336 | function removeSongs(songs) {
337 | songs.forEach(deleteCache);
338 |
339 | return db.song.deleteMany({
340 | where: {
341 | id: { in: songs.map((song) => song.id) },
342 | },
343 | });
344 | }
345 |
346 | /**
347 | * Finds songs by their filename.
348 | * @param {string[]} names A list of filenames
349 | * @returns A list of songs.
350 | */
351 | function findByFilenames(names) {
352 | return db.song.findMany({
353 | where: {
354 | filename: { in: names },
355 | },
356 | });
357 | }
358 |
359 | /**
360 | * Finds song by their filename.
361 | * @param {string} name A filename.
362 | * @returns A song.
363 | */
364 | function findByFilename(name) {
365 | return db.song.findUnique({
366 | where: {
367 | filename: name,
368 | },
369 | });
370 | }
371 |
372 | /**
373 | * Parses a song from a file.
374 | * @param {string} name The filename of the song.
375 | * @param {boolean} getImage Whether to return the image. If false, only the information if the song has an image is returned.
376 | */
377 | async function parseSongFromFile(name, getImage = false) {
378 | const songPath = path.join(config.SONGS_PATH, name);
379 |
380 | let metadata = await parseFile(songPath);
381 |
382 | return new Promise((resolve, reject) => {
383 | fs.stat(songPath, (err, stats) => {
384 | if (err) return reject(err);
385 |
386 | const modified = stats.mtime;
387 | const song = {
388 | title: metadata.common.title || name,
389 | artist: metadata.common.artist,
390 | filename: name,
391 | modified,
392 | };
393 |
394 | const picture = metadata.common.picture;
395 |
396 | if (getImage && picture) song.image = picture[0].data;
397 | else song.image = picture != null;
398 |
399 | resolve(song);
400 | });
401 | });
402 | }
403 |
404 | async function compressImage(image, size = 64) {
405 | return imagemin.buffer(image, {
406 | plugins: [
407 | imageminWebp({ resize: { width: size, height: size }, method: 0 }),
408 | ],
409 | });
410 | }
411 | /**
412 | * Gets all file names from the songs folder.
413 | * @returns A list of filenames.
414 | */
415 | function getFileNamesFromPath() {
416 | return new Promise((resolve, reject) =>
417 | fs.readdir(
418 | config.SONGS_PATH,
419 | { withFileTypes: true },
420 | (err, files) => {
421 | if (err) return reject(err);
422 | resolve(files.filter((file) => file.isFile()).map((file) => file.name));
423 | }
424 | )
425 | );
426 | }
427 |
428 | /**
429 | * Adds songs to the database given a list of filenames.
430 | * @param {string[]} filenames A list of song filenames.
431 | */
432 | async function addSongsByName(filenames) {
433 | // Add 10 songs at a time
434 | const chunkSize = 10;
435 | for (let i = 0; i < filenames.length; i += chunkSize) {
436 | const chunk = filenames.slice(i, i + chunkSize);
437 |
438 | const results = await Promise.allSettled(
439 | chunk.map((filename) => parseSongFromFile(filename))
440 | );
441 | const songs = results
442 | .filter((result) => result.status === "fulfilled")
443 | .map((result) => result.value);
444 |
445 | await Promise.all(songs.map(add));
446 | }
447 | }
448 |
449 | /**
450 | * Adds a song to the database given a filename.
451 | * @param {string} filename The filename of the song.
452 | */
453 | async function addSongByName(filename) {
454 | let parsedSong;
455 |
456 | try {
457 | parsedSong = await parseSongFromFile(filename);
458 | } catch (e) {
459 | console.error(e);
460 | }
461 |
462 | if (!parsedSong) return add({ filename });
463 |
464 | const song = {
465 | title: parsedSong.title,
466 | artist: parsedSong.artist,
467 | };
468 |
469 | return add(song);
470 | }
471 |
472 | /**
473 | * Finds the names of songs that are not in the database.
474 | * @param {string[]} filenames A list of song filenames. If not provided, it will get all the songs in the songs folder.
475 | * @returns {string[]} A list of song filenames that are not in the database.
476 | */
477 | async function findMissingSongs(filenames) {
478 | const names = filenames || (await getFileNamesFromPath());
479 |
480 | const existing = await findByFilenames(names);
481 | const missingSongs = names.filter(
482 | (song) => !existing.find((name) => song === name.filename)
483 | );
484 |
485 | return missingSongs;
486 | }
487 |
488 | /**
489 | * Checks if a song is missing from the database.
490 | * @param {string} filename The filename of the song.
491 | * @returns {boolean} True if the song is missing, false otherwise.
492 | */
493 | async function isMissing(filename) {
494 | const existing = await findByFilename(filename);
495 | return !existing;
496 | }
497 |
498 | /**
499 | * Finds the songs that are orphaned in the database.
500 | * @param {string[]} filenames A list of song filenames. If not provided, it will get all the songs in the songs folder.
501 | * @returns {string[]} A list of songs that do not exist anymore.
502 | */
503 | async function findOrphanedSongs(filenames) {
504 | const names = filenames || (await getFileNamesFromPath());
505 |
506 | const existing = await db.song.findMany({
507 | select: {
508 | id: true,
509 | filename: true,
510 | },
511 | });
512 |
513 | const orphaned = existing.filter(
514 | (song) => !names.find((name) => song.filename === name)
515 | );
516 |
517 | return orphaned;
518 | }
519 |
520 | /**
521 | * Reloads the database with the songs in the songs folder.
522 | * It will add songs that are missing and remove songs that are orphaned.
523 | * @param {boolean} full Whether to delete all songs before reloading.
524 | */
525 | export async function reload(full = false) {
526 | if (full) {
527 | await db.song.deleteMany({});
528 | resetCache();
529 | }
530 |
531 | const songNames = await getFileNamesFromPath();
532 |
533 | const missingSongs = await findMissingSongs(songNames);
534 | await addSongsByName(missingSongs);
535 |
536 | const orphanedSongs = await findOrphanedSongs(songNames);
537 | await removeSongs(orphanedSongs);
538 | }
539 |
--------------------------------------------------------------------------------
/server/src/app.js:
--------------------------------------------------------------------------------
1 | import express, { json } from "express";
2 | import morgan from "morgan";
3 | import cors from "cors";
4 |
5 | import { notFound, handleError, checkAuthorization } from "./middlewares.js";
6 | import api from "./api/index.js";
7 | import cookieParser from "cookie-parser";
8 |
9 | const app = express();
10 |
11 | app.use(morgan("dev"));
12 | app.use(cors({ origin: true, credentials: true }));
13 | app.use(cookieParser());
14 | app.use(checkAuthorization);
15 | app.use(json());
16 |
17 | app.get("/", (_req, res) => {
18 | res.json({
19 | message: "osum!player server API",
20 | });
21 | });
22 |
23 | app.use("/api/v1", api);
24 |
25 | app.use(notFound);
26 | app.use(handleError);
27 |
28 | export default app;
29 |
--------------------------------------------------------------------------------
/server/src/config.js:
--------------------------------------------------------------------------------
1 | import dotenv from "dotenv";
2 |
3 | dotenv.config();
4 |
5 | const config = {
6 | SERVER_PORT: parseInt(process.env.SERVER_PORT),
7 | SONGS_PATH: process.env.SONGS_PATH,
8 | IMAGE_CACHE_PATH: process.env.IMAGE_CACHE_PATH,
9 | SONGS_PER_OFFSET: parseInt(process.env.SONGS_PER_OFFSET),
10 | DEMO_MODE: process.env.DEMO_MODE === "true",
11 | AUTH_TOKEN: process.env.AUTH_TOKEN
12 | };
13 |
14 | export default config;
--------------------------------------------------------------------------------
/server/src/index.js:
--------------------------------------------------------------------------------
1 | import app from "./app.js";
2 | import config from "./config.js";
3 |
4 | const port = config.SERVER_PORT;
5 | app.listen(port, () => {
6 | console.log(`Listening: http://localhost:${port}`);
7 | });
8 |
--------------------------------------------------------------------------------
/server/src/middlewares.js:
--------------------------------------------------------------------------------
1 | import config from "./config.js";
2 |
3 | export function notFound(_req, res, next) {
4 | res.status(404);
5 | next(new Error(`Not found`));
6 | }
7 |
8 | export function handleError(err, _req, res, _next) {
9 | const statusCode = res.statusCode !== 200 ? res.statusCode : 400;
10 | res.status(statusCode);
11 | res.json({
12 | message: err.message,
13 | stack: err.stack,
14 | });
15 | }
16 |
17 | export function checkAuthorization(req, res, next) {
18 | if (req.method === "OPTIONS")
19 | return next();
20 |
21 | if (!config.AUTH_TOKEN || req.cookies.authorization === config.AUTH_TOKEN)
22 | return next();
23 |
24 | res.status(401);
25 | res.end();
26 | }
--------------------------------------------------------------------------------
/server/src/utils/db.js:
--------------------------------------------------------------------------------
1 | import { PrismaClient } from "@prisma/client";
2 |
3 | /**
4 | * @type {import('@prisma/client').PrismaClient}
5 | */
6 | const db = new PrismaClient();
7 |
8 | export default db;
9 |
--------------------------------------------------------------------------------
/server/test/api.test.js:
--------------------------------------------------------------------------------
1 | import request from "supertest";
2 |
3 | import app from "../src/app";
4 |
5 | describe("GET /api/v1", () => {
6 | it("responds with a json message", (done) => {
7 | request(app)
8 | .get("/api/v1")
9 | .set("Accept", "application/json")
10 | .expect("Content-Type", /json/)
11 | .expect(
12 | 200,
13 | {
14 | message: "osum!player server API v1",
15 | },
16 | done
17 | );
18 | });
19 | });
20 |
--------------------------------------------------------------------------------
/static/CNAME:
--------------------------------------------------------------------------------
1 | music.osumatrix.me
--------------------------------------------------------------------------------
/static/assets/interaction.wav:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oSumAtrIX/osum-player/98f8b76c7227e697513e62f151b18585b115d67b/static/assets/interaction.wav
--------------------------------------------------------------------------------
/static/assets/key0.mp3:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oSumAtrIX/osum-player/98f8b76c7227e697513e62f151b18585b115d67b/static/assets/key0.mp3
--------------------------------------------------------------------------------
/static/assets/key1.mp3:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oSumAtrIX/osum-player/98f8b76c7227e697513e62f151b18585b115d67b/static/assets/key1.mp3
--------------------------------------------------------------------------------
/static/assets/key2.mp3:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oSumAtrIX/osum-player/98f8b76c7227e697513e62f151b18585b115d67b/static/assets/key2.mp3
--------------------------------------------------------------------------------
/static/assets/key3.mp3:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oSumAtrIX/osum-player/98f8b76c7227e697513e62f151b18585b115d67b/static/assets/key3.mp3
--------------------------------------------------------------------------------
/static/assets/placeholder.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oSumAtrIX/osum-player/98f8b76c7227e697513e62f151b18585b115d67b/static/assets/placeholder.png
--------------------------------------------------------------------------------
/static/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/oSumAtrIX/osum-player/98f8b76c7227e697513e62f151b18585b115d67b/static/favicon.ico
--------------------------------------------------------------------------------
/static/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 | osum!player
10 |
11 |
12 |
13 |
14 |
15 |
16 |