diff --git a/.gitignore b/.gitignore index aaadf73..91f9c96 100644 --- a/.gitignore +++ b/.gitignore @@ -30,3 +30,5 @@ go.work.sum # Editor/IDE # .idea/ # .vscode/ + +cmd/server/config.json \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..f6f2c43 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,48 @@ +# ------------------------- +# 1) Builder stage +# ------------------------- +FROM golang:1.20-alpine AS builder + +# Install CA certificates required for building +RUN apk add --no-cache ca-certificates + +WORKDIR /app + +# Copy local repository into the build image (portable across OSes) +COPY . /app + +# Ensure config.example exists; keep a fallback copy +RUN cp cmd/server/config.example.json cmd/server/config.json || true + +# Normalize go.mod 'go' directive to a valid major.minor form to avoid build errors +RUN if [ -f go.mod ]; then \ + sed -E -i 's/^go[[:space:]]+[0-9]+(\.[0-9]+){1,2}$/go 1.20/' go.mod || true; \ + fi + +# Build a static Linux binary for the server +RUN cd cmd/server && CGO_ENABLED=0 GOOS=linux go build -o ts6viewer . + +# ------------------------- +# 2) Runtime stage +# ------------------------- +FROM alpine:latest + +# Install CA certificates and gettext for envsubst +RUN apk add --no-cache ca-certificates gettext + +# Set working directory to where the server expects config.json when using relative path +WORKDIR /app/cmd/server + +# Copy the built app and assets from builder +COPY --from=builder /app /app + +# Copy entrypoint script and ensure it's executable +COPY entrypoint.sh /app/entrypoint.sh +RUN chmod +x /app/entrypoint.sh || true +RUN chmod +x /app/cmd/server/ts6viewer || true + +# Expose the internal port the app listens on +EXPOSE 8080 + +# Use the entrypoint to generate config and start the app +ENTRYPOINT ["/app/entrypoint.sh"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index acf5ff5..977098a 100644 --- a/README.md +++ b/README.md @@ -1 +1,127 @@ -# ts6-viewer \ No newline at end of file +# TS6 Viewer +

+ Dark Theme + Light Theme +

+ +A lightweight, fast, and modern web viewer for **TeamSpeak 6** servers. +TS6 Viewer connects to the TeamSpeak 6 WebQuery API, retrieves live server and channel data, and displays it in a clean, responsive web interface with optional dark/light themes. + +The viewer is designed to be: + +- Simple to deploy +- Fast and lightweight +- Fully client‑side auto‑refreshing +- Compatible with any TS6 server exposing WebQuery +- Customizable via a single `config.json` file + +--- + +## Features + +- Live TeamSpeak 6 server viewer +- Auto‑refresh with configurable interval +- Dark and light themes +- Channel tree rendering with clients +- Spacer and full‑width channel support +- Caching + rate‑limit protection +- Works on Windows, Linux, and Docker‑friendly environments + +--- + +## Configuration + +The application uses a `config.json` file located in the same directory as the executable. + +### Example `config.json` + +```json +{ + "_comment": "TS6 Viewer Configuration File", + "_comment2": "Rename this file to config.json and adjust the values to your setup.", + + "server_port": "8080", + "_comment_server_port": "The port on which the TS6 Viewer web interface will be available.", + + "theme": "dark", + "_comment_theme": "Choose between 'light' or 'dark' for the viewer theme.", + + "refresh_interval": 60, + "_comment_refresh_interval": "How often the viewer should auto-refresh (in seconds).", + + "teamspeak6": { + "base_url": "http://192.168.178.195:57007", + "_comment_base_url": "The WebQuery HTTP endpoint of your TeamSpeak 6 server. Usually http://:10080 or your mapped port.", + + "api_key": "geheim", + "_comment_api_key": "Your TeamSpeak 6 ServerQuery API key. It is shown ONCE in the server logs on first startup. If lost, create a new one.", + + "server_id": 1, + "_comment_server_id": "The ID of the virtual server you want to display. Default is usually 1." + } +} +``` + +--- + +## Building the Program + +The project is written in **Go**, so building is extremely simple. + +### Prerequisites + +- Go 1.20 or newer +- Git (optional) + +--- + +## Build on Linux +```bash +git clone https://github.com/Maxallica/ts6-viewer.git +cd ts6viewer + +go build -o ts6viewer +``` + +## Build Windows binary on Linux +```bash +cd "*/ts6-viewer/cmd/server" + +GOOS=windows GOARCH=amd64 go build -o ts6viewer.exe +``` + +## Running on Linux +```bash +./ts6viewer +``` + +## Build on Windows +```bash +git clone https://github.com/Maxallica/ts6-viewer.git +cd ts6viewer + +go build -o ts6viewer.exe +``` + +## Build Linux binary on Windows +```bash +cd "*/ts6-viewer/cmd/server" + +$env:GOOS="linux" +$env:GOARCH="amd64" +go build -o ts6viewer +``` + +## Running on Windows +```bash +.\ts6viewer.exe +``` + +--- + +## Navigate to the ts6viewer page +http(s)\://\:\/ts6viewer + +--- + +## ❤️ Made with love in Germany \ No newline at end of file diff --git a/cmd/server/config.example.json b/cmd/server/config.example.json new file mode 100644 index 0000000..899a462 --- /dev/null +++ b/cmd/server/config.example.json @@ -0,0 +1,24 @@ +{ + "_comment": "TS6 Viewer Configuration File", + "_comment2": "Rename this file to config.json and adjust the values to your setup.", + + "server_port": "${SERVER_PORT}", + "_comment_server_port": "The port on which the TS6 Viewer web interface will be available. Usually '8080'", + + "theme": "${THEME}", + "_comment_theme": "Choose between 'light' or 'dark' for the viewer theme. Usually 'dark'", + + "refresh_interval": "${REFRESH_INTERVAL}", + "_comment_refresh_interval": "How often the viewer should auto-refresh (in seconds). Usually '60'", + + "teamspeak6": { + "base_url": "${BASE_URL}", + "_comment_base_url": "The WebQuery HTTP endpoint of your TeamSpeak 6 server. Usually http://192.168.178.2:10080.", + + "api_key": "${API_KEY}", + "_comment_api_key": "Your TeamSpeak 6 ServerQuery API key. It is shown ONCE in the server logs on first startup. If lost, you have to create a whole new server.", + + "server_id": "${SERVER_ID}", + "_comment_server_id": "The ID of the virtual server you want to display. Default is usually '1'." + } +} diff --git a/cmd/server/main.go b/cmd/server/main.go new file mode 100644 index 0000000..c39a669 --- /dev/null +++ b/cmd/server/main.go @@ -0,0 +1,44 @@ +package main + +import ( + "log" + "net" + "net/http" + + router "ts6-viewer/http" + "ts6-viewer/internal/config" +) + +func main() { + log.Println("Starting TS6 Viewer...") + + // Load config.json + log.Println("Loading config.json") + cfg, err := config.Load("config.json") + if err != nil { + log.Fatal(err) + } + serverPort := cfg.ServerPort + log.Println("Successfully loaded config.json") + + // Create HTTP router + r := router.NewRouter(*cfg) + + // Create listener first + ln, err := net.Listen("tcp", ":"+serverPort) + if err != nil { + log.Fatal("Failed to bind port:", err) + } + + // Now we are guaranteed the port is bound → safe callback + log.Printf("HTTP server is now listening on port %s", serverPort) + + // Start the server (blocking) + srv := &http.Server{ + Handler: r, + } + + if err := srv.Serve(ln); err != nil && err != http.ErrServerClosed { + log.Fatal("HTTP server failed:", err) + } +} diff --git a/dark.png b/dark.png new file mode 100644 index 0000000..4ec32ff Binary files /dev/null and b/dark.png differ diff --git a/entrypoint.sh b/entrypoint.sh new file mode 100644 index 0000000..52f8841 --- /dev/null +++ b/entrypoint.sh @@ -0,0 +1,60 @@ +#!/bin/sh +set -eu + +# Paths +EXAMPLE="/app/cmd/server/config.example.json" +TARGET_REL="config.json" # relative path in WORKDIR (/app/cmd/server) +TARGET_ABS="/app/cmd/server/config.json" # absolute path for clarity +BINARY="/app/cmd/server/ts6viewer" + +# Export variables used in the template (use environment variables only) +export API_KEY="${API_KEY:-}" +export SERVER_PORT="${SERVER_PORT:-8080}" +export BASE_URL="${BASE_URL:-http://127.0.0.1:10080}" +export SERVER_ID="${SERVER_ID:-1}" +export THEME="${THEME:-dark}" +export REFRESH_INTERVAL="${REFRESH_INTERVAL:-60}" + +# Minimal, useful debug output +echo "=== STARTUP ===" +# Mask API key for logs: show first 4 chars if present +if [ -n "$API_KEY" ]; then + echo "API_KEY=****${API_KEY#????}" +else + echo "API_KEY=(empty)" +fi +echo "PORT=${SERVER_PORT} BASE_URL=${BASE_URL} THEME=${THEME}" +echo "Working dir: $(pwd)" +echo + +# Quick binary check +if [ -x "$BINARY" ]; then + echo "Binary: OK -> $BINARY" +else + echo "Binary: MISSING or not executable -> $BINARY" >&2 +fi + +# Ensure example exists; if not, start the binary directly +if [ ! -f "$EXAMPLE" ]; then + echo "config.example.json not found at $EXAMPLE, starting binary directly" >&2 + exec "$BINARY" +fi + +# Generate config.json from config.example.json using envsubst +envsubst < "$EXAMPLE" > "$TARGET_ABS" || { + echo "Failed to generate config.json" >&2 + exit 1 +} + +# Ensure relative copy exists for relative loads +cp -f "$TARGET_ABS" "$TARGET_REL" || true + +# Show compact confirmation and a short preview of the generated config +size=$(wc -c < "$TARGET_ABS" 2>/dev/null || echo 0) +echo "Generated config.json (${size} bytes). Preview:" +echo "-----" +head -n 20 "$TARGET_ABS" || true +echo "-----" + +echo "Starting server..." +exec "$BINARY" diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..804be69 --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module ts6-viewer + +go 1.25.6 diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..e69de29 diff --git a/http/http-helper.go b/http/http-helper.go new file mode 100644 index 0000000..9eee6e4 --- /dev/null +++ b/http/http-helper.go @@ -0,0 +1,108 @@ +package http + +import ( + "net" + "net/http" + "time" + "ts6-viewer/internal/ts6" +) + +func getIP(r *http.Request) string { + host, _, err := net.SplitHostPort(r.RemoteAddr) + if err != nil { + return r.RemoteAddr + } + return host +} + +func allowRequest(ip string) bool { + mu.Lock() + defer mu.Unlock() + + last, exists := lastRequestTime[ip] + if exists && time.Since(last) < rateLimitWindow { + return false + } + + lastRequestTime[ip] = time.Now() + return true +} + +func getViewerData(baseURL, apiKey string, serverID string) (ViewerData, error) { + mu.Lock() + defer mu.Unlock() + + if time.Since(cacheTimestamp) < cacheTTL { + return cacheData, nil + } + + serverInfo, err := ts6.GetServerInfo(baseURL, apiKey, serverID) + if err != nil { + return ViewerData{}, err + } + + clients, err := ts6.GetClientList(baseURL, apiKey, serverID) + if err != nil { + return ViewerData{}, err + } + + channelTree, err := ts6.GetChannelTree(baseURL, apiKey, serverID, clients) + if err != nil { + return ViewerData{}, err + } + + view := ViewerData{ + Server: mapServer(serverInfo), + ChannelTree: mapChannelTree(channelTree), + } + + cacheData = view + cacheTimestamp = time.Now() + + return view, nil +} + +func mapServer(s *ts6.ServerInfo) *ServerView { + return &ServerView{ + Name: s.Name, + ClientsOnline: s.ClientsOnline, + MaxClients: s.MaxClients, + UptimePretty: s.UptimePretty, + ChannelsOnline: s.ChannelsOnline, + HostBannerURL: s.HostBannerURL, + ClientConnections: s.ClientConnections, + } +} + +func mapClient(c *ts6.Client) *ClientView { + return &ClientView{ + Nickname: c.Nickname, + } +} + +func mapChannel(ch *ts6.Channel) *ChannelView { + out := &ChannelView{ + Name: ch.Name, + Type: ch.Type, + Align: ch.Align, + FullWidth: ch.FullWidth, + } + + for _, c := range ch.Clients { + out.Clients = append(out.Clients, mapClient(c)) + } + + for _, child := range ch.Children { + out.Children = append(out.Children, mapChannel(child)) + } + + return out +} + +func mapChannelTree(tree []*ts6.Channel) []*ChannelView { + out := make([]*ChannelView, 0, len(tree)) + for _, ch := range tree { + out = append(out, mapChannel(ch)) + } + return out +} diff --git a/http/router.go b/http/router.go new file mode 100644 index 0000000..1b4a4da --- /dev/null +++ b/http/router.go @@ -0,0 +1,124 @@ +package http + +import ( + "encoding/json" + "html/template" + "log" + "net/http" + "os" + "path/filepath" + "strconv" + "sync" + "time" + + "ts6-viewer/internal/config" +) + +var ( + cacheData ViewerData + cacheTimestamp time.Time + cacheTTL = 3 * time.Second + + lastRequestTime = make(map[string]time.Time) + rateLimitWindow = 1 * time.Second + + mu sync.Mutex +) + +func NewRouter(cfg config.Config) http.Handler { + baseURL := cfg.Teamspeak6.BaseURL + apiKey := cfg.Teamspeak6.ApiKey + serverID := cfg.Teamspeak6.ServerID + theme := cfg.Theme + refreshIntervalStr := cfg.RefreshInterval + + refreshInterval, err := strconv.Atoi(refreshIntervalStr) + if err != nil || refreshInterval <= 0 { + refreshIntervalStr = "60" + } + + mux := http.NewServeMux() + + wd, err := os.Getwd() + if err != nil { + log.Fatal("cannot get working directory:", err) + } + + tmplPath := filepath.Join(wd, "..", "..", "internal", "web", "templates", "ts6viewer.html") + tmpl := template.Must(template.ParseFiles(tmplPath)) + + staticPath := filepath.Join(wd, "..", "..", "internal", "web", "static") + mux.Handle("/static/", http.StripPrefix("/static/", http.FileServer(http.Dir(staticPath)))) + + // ----------------------------- + // JSON endpoint (/ts6viewer/data + /ts6viewer/data/) + // ----------------------------- + dataHandler := func(w http.ResponseWriter, r *http.Request) { + ip := getIP(r) + + var raw ViewerData + var err error + + if allowRequest(ip) { + raw, err = getViewerData(baseURL, apiKey, serverID) + } else { + raw = cacheData + } + + if err != nil { + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + + raw.Theme = theme + raw.RefreshInterval = refreshIntervalStr + + w.Header().Set("Content-Type", "application/json") + json.NewEncoder(w).Encode(raw) + } + + mux.HandleFunc("/ts6viewer/data", dataHandler) + mux.HandleFunc("/ts6viewer/data/", dataHandler) + + // ----------------------------- + // HTML view (/ts6viewer + /ts6viewer/) + // ----------------------------- + viewHandler := func(w http.ResponseWriter, r *http.Request) { + ip := getIP(r) + + var data ViewerData + var err error + + if allowRequest(ip) { + data, err = getViewerData(baseURL, apiKey, serverID) + } else { + data = cacheData + } + + if err != nil { + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + + data.Theme = theme + data.RefreshInterval = refreshIntervalStr + + w.Header().Set("Content-Type", "text/html; charset=utf-8") + if err := tmpl.Execute(w, data); err != nil { + log.Println("template error:", err) + } + } + + mux.HandleFunc("/ts6viewer", viewHandler) + mux.HandleFunc("/ts6viewer/", viewHandler) + + // ----------------------------- + // Health endpoint + // ----------------------------- + mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusOK) + w.Write([]byte("TS6Viewer is running!")) + }) + + return mux +} diff --git a/http/view-models.go b/http/view-models.go new file mode 100644 index 0000000..941e05c --- /dev/null +++ b/http/view-models.go @@ -0,0 +1,33 @@ +package http + +import "ts6-viewer/internal/ts6" + +type ViewerData struct { + Server *ServerView + ChannelTree []*ChannelView + Theme string + RefreshInterval string +} + +type ServerView struct { + Name string + ClientsOnline string + MaxClients string + UptimePretty string + ChannelsOnline string + HostBannerURL string + ClientConnections string +} + +type ClientView struct { + Nickname string +} + +type ChannelView struct { + Name string + Type ts6.ChannelType + Align ts6.Aligned + FullWidth bool + Clients []*ClientView + Children []*ChannelView +} diff --git a/internal/config/config.go b/internal/config/config.go new file mode 100644 index 0000000..91d282d --- /dev/null +++ b/internal/config/config.go @@ -0,0 +1,34 @@ +package config + +import ( + "encoding/json" + "os" +) + +type Config struct { + ServerPort string `json:"server_port"` + Theme string `json:"theme"` + + Teamspeak6 struct { + BaseURL string `json:"base_url"` + ApiKey string `json:"api_key"` + ServerID string `json:"server_id"` + } `json:"teamspeak6"` + + RefreshInterval string `json:"refresh_interval"` +} + +func Load(path string) (*Config, error) { + f, err := os.Open(path) + if err != nil { + return nil, err + } + defer f.Close() + + var cfg Config + if err := json.NewDecoder(f).Decode(&cfg); err != nil { + return nil, err + } + + return &cfg, nil +} diff --git a/internal/ts6/channels.go b/internal/ts6/channels.go new file mode 100644 index 0000000..f2a880c --- /dev/null +++ b/internal/ts6/channels.go @@ -0,0 +1,207 @@ +package ts6 + +import ( + "fmt" + "regexp" + "strings" +) + +// Channel represents a TeamSpeak channel +type Channel struct { + CID string `json:"cid"` + PID string `json:"pid"` + ChannelOrder string `json:"channel_order"` + Name string `json:"channel_name"` + Topic string `json:"channel_topic"` + FlagPermanent string `json:"channel_flag_permanent"` + FlagSemiPermanent string `json:"channel_flag_semi_permanent"` + FlagDefault string `json:"channel_flag_default"` + FlagPassword string `json:"channel_flag_password"` + MaxClients string `json:"channel_maxclients"` + MaxFamilyClients string `json:"channel_maxfamilyclients"` + NeededTalkPower string `json:"channel_needed_talk_power"` + + // Additional informations, that wil added after response parsing + Type ChannelType `json:"-"` + Align Aligned `json:"-"` + FullWidth bool `json:"-"` + + Children []*Channel `json:"-"` + + Clients []*Client `json:"-"` +} + +// ChannelListResponse represents the TS6 API response +type ChannelListResponse struct { + Body []Channel `json:"body"` + Status Status `json:"status"` +} + +// ChannelType defines the type of a channel or spacer +type ChannelType int + +const ( + NormalChannel ChannelType = iota // Regular TS6 channel + SolidSpacer // ___ + DashSpacer // --- + DotSpacer // ... + DashDotSpacer // -.- + DashDotDotSpacer // -.. + AlignedSpacer // [cSpacer#], [lSpacer#], [rSpacer#] + RepeatingSpacer // [*spacer#]X + BlankSpacer // Empty spacer like [cSpacer0] +) + +// Aligned defines the alignment for aligned spacers +type Aligned int + +const ( + AlignLeft Aligned = iota + AlignCenter + AlignRight +) + +// GetChannelList returns all channels for a virtual server +func GetChannelList(baseURL, apiKey string, serverID string) ([]Channel, error) { + var resp ChannelListResponse + + err := doGET( + baseURL, + apiKey, + fmt.Sprintf("/%s/channellist", serverID), + &resp, + ) + if err != nil { + return nil, err + } + + if resp.Status.Code != 0 { + return nil, fmt.Errorf("ts6 error %d: %s", resp.Status.Code, resp.Status.Message) + } + + // Parse each channel name and set the additional fields + for i := range resp.Body { + ch := &resp.Body[i] + + chType, align, fullWidth, resolved := ParseChannelName(ch.Name) + + ch.Type = chType + ch.Align = align + ch.FullWidth = fullWidth + ch.Name = resolved + } + + return resp.Body, nil +} + +// GetChannelTree returns all channels including the online clients in a tree structure for a virtual server +func GetChannelTree(baseURL, apiKey string, serverID string, clients []Client) ([]*Channel, error) { + channels, err := GetChannelList(baseURL, apiKey, serverID) + if err != nil { + return nil, err + } + + channelHierachy := buildChannelTree(clients, channels) + return channelHierachy, nil +} + +func buildChannelTree(clients []Client, channels []Channel) []*Channel { + lookup := make(map[string]*Channel) + for i := range channels { + lookup[channels[i].CID] = &channels[i] + } + + for i := range clients { + cl := &clients[i] + if ch, ok := lookup[cl.CID]; ok { + ch.Clients = append(ch.Clients, cl) + } + } + + var roots []*Channel + + for i := range channels { + ch := &channels[i] + + if ch.PID == "0" { + roots = append(roots, ch) + } else { + parent, ok := lookup[ch.PID] + if ok { + parent.Children = append(parent.Children, ch) + } + } + } + + return roots +} + +// ParseChannelName parses TeamSpeak spacer syntax. +// It removes spacer commands and expands spacer patterns to a fixed width. +func ParseChannelName(name string) (ChannelType, Aligned, bool, string) { + name = strings.TrimSpace(name) + + reCmd := regexp.MustCompile(`(?i)\[(c|l|r)?spacer\d*\]`) + cmd := reCmd.FindStringSubmatch(name) + + if len(cmd) > 0 { + align := AlignLeft + if len(cmd) > 1 { + switch strings.ToLower(cmd[1]) { + case "c": + align = AlignCenter + case "r": + align = AlignRight + } + } + + // Remove TS spacer command only + clean := strings.TrimSpace(reCmd.ReplaceAllString(name, "")) + + // Blank spacer + if clean == "" { + return BlankSpacer, align, false, "" + } + + // Line spacer (___ --- ...) + if isSpacerPattern(clean) { + return SolidSpacer, align, true, clean + } + + // Aligned spacer with text + return AlignedSpacer, align, false, clean + } + + return NormalChannel, AlignLeft, false, name +} + +func isSpacerPattern(s string) bool { + switch s { + case "___", "---", "...", "-.-", "-..": + return true + default: + return false + } +} + +// repeatToWidth repeats a spacer pattern until a fixed width is filled. +// Width is approximated using a monospace character width. +func repeatToWidth(pattern string, targetPx int) string { + const charWidth = 8 // px per character (approximation) + + if pattern == "" { + return "" + } + + patternWidth := len([]rune(pattern)) * charWidth + if patternWidth == 0 { + return pattern + } + + repeats := targetPx / patternWidth + if repeats < 1 { + repeats = 1 + } + + return strings.Repeat(pattern, repeats) +} diff --git a/internal/ts6/clients.go b/internal/ts6/clients.go new file mode 100644 index 0000000..758e0f9 --- /dev/null +++ b/internal/ts6/clients.go @@ -0,0 +1,50 @@ +package ts6 + +import "fmt" + +// Client represents an online TeamSpeak client +type Client struct { + CID string `json:"cid"` + CLID string `json:"clid"` + DatabaseID string `json:"client_database_id"` + Nickname string `json:"client_nickname"` + ClientType string `json:"client_type"` +} + +// ClientListResponse represents the TS6 API response +type ClientListResponse struct { + Body []Client `json:"body"` + Status Status `json:"status"` +} + +// GetClientList returns all connected clients for a virtual server +func GetClientList(baseURL, apiKey string, serverID string) ([]Client, error) { + var resp ClientListResponse + + err := doGET( + baseURL, + apiKey, + fmt.Sprintf("/%s/clientlist", serverID), + &resp, + ) + if err != nil { + return nil, err + } + + if resp.Status.Code != 0 { + return nil, fmt.Errorf( + "ts6 error %d: %s", + resp.Status.Code, + resp.Status.Message, + ) + } + + filtered := make([]Client, 0, len(resp.Body)) + for _, c := range resp.Body { + if c.DatabaseID != "1" { + filtered = append(filtered, c) + } + } + + return filtered, nil +} diff --git a/internal/ts6/http.go b/internal/ts6/http.go new file mode 100644 index 0000000..581704b --- /dev/null +++ b/internal/ts6/http.go @@ -0,0 +1,39 @@ +package ts6 + +import ( + "encoding/json" + "fmt" + "net/http" + "time" +) + +// doGET performs an authenticated HTTP GET request against TS6 +func doGET(baseURL, apiKey, path string, out any) error { + req, err := http.NewRequest( + http.MethodGet, + baseURL+path, + nil, + ) + if err != nil { + return err + } + + req.Header.Set("x-api-key", apiKey) + req.Header.Set("Accept", "application/json") + + client := &http.Client{ + Timeout: 10 * time.Second, + } + + resp, err := client.Do(req) + if err != nil { + return err + } + defer resp.Body.Close() + + if resp.StatusCode != http.StatusOK { + return fmt.Errorf("http error: %s", resp.Status) + } + + return json.NewDecoder(resp.Body).Decode(out) +} diff --git a/internal/ts6/serverinfo.go b/internal/ts6/serverinfo.go new file mode 100644 index 0000000..8aeff82 --- /dev/null +++ b/internal/ts6/serverinfo.go @@ -0,0 +1,90 @@ +package ts6 + +import ( + "fmt" + "strconv" +) + +// ServerInfo represents basic virtual server information +type ServerInfo struct { + ServerID string `json:"virtualserver_id"` + Name string `json:"virtualserver_name"` + Uptime string `json:"virtualserver_uptime"` + ClientsOnline string `json:"virtualserver_clientsonline"` + MaxClients string `json:"virtualserver_maxclients"` + ChannelsOnline string `json:"virtualserver_channelsonline"` + HostBannerURL string `json:"virtualserver_hostbanner_url"` + HostBannerGfxURL string `json:"virtualserver_hostbanner_gfx_url"` + NeededIdentitySecurity string `json:"virtualserver_needed_identity_security_level"` + QueryClientConnections string `json:"virtualserver_query_client_connections"` + ClientConnections string `json:"virtualserver_client_connections"` + + UptimePretty string `json:"-"` +} + +// ServerInfoResponse represents the TS6 API response +type ServerInfoResponse struct { + Body []ServerInfo `json:"body"` + Status Status `json:"status"` +} + +// GetServerInfo retrieves information about a virtual server +func GetServerInfo(baseURL, apiKey string, serverID string) (*ServerInfo, error) { + var resp ServerInfoResponse + + err := doGET( + baseURL, + apiKey, + fmt.Sprintf("/%s/serverinfo", serverID), + &resp, + ) + if err != nil { + return nil, err + } + + if resp.Status.Code != 0 { + return nil, fmt.Errorf( + "ts6 error %d: %s", + resp.Status.Code, + resp.Status.Message, + ) + } + + if len(resp.Body) != 1 { + return nil, fmt.Errorf( + "unexpected serverinfo result count: %d", + len(resp.Body), + ) + } + + info := resp.Body[0] + + if n, err := strconv.Atoi(info.ClientsOnline); err == nil { + n-- + if n < 0 { + n = 0 + } + info.ClientsOnline = strconv.Itoa(n) + } + + modifiedInfo := &info + modifiedInfo.UptimePretty = formatUptime(modifiedInfo.Uptime) + + return modifiedInfo, nil +} + +func formatUptime(secondsStr string) string { + sec, err := strconv.Atoi(secondsStr) + if err != nil || sec < 0 { + return secondsStr + } + + days := sec / 86400 + sec %= 86400 + hours := sec / 3600 + sec %= 3600 + minutes := sec / 60 + seconds := sec % 60 + + return fmt.Sprintf("%dD %02d:%02d:%02d", days, hours, minutes, seconds) +} diff --git a/internal/ts6/status.go b/internal/ts6/status.go new file mode 100644 index 0000000..3f856d2 --- /dev/null +++ b/internal/ts6/status.go @@ -0,0 +1,7 @@ +package ts6 + +// Status represents the standard TS6 API status block +type Status struct { + Code int `json:"code"` + Message string `json:"message"` +} diff --git a/internal/web/static/dark.css b/internal/web/static/dark.css new file mode 100644 index 0000000..9c25174 --- /dev/null +++ b/internal/web/static/dark.css @@ -0,0 +1,114 @@ +body { + font-family: 'Roboto', sans-serif; + background: #121212; + color: #e5e5e5; + padding: 0; + margin: 0; + font-size: 13px; +} + +h1, h2 { + margin: 6px 0; + padding-left: 6px; + font-size: 15px; + font-weight: bold; + color: #ffffff; +} + +#refreshButton { + cursor: default!important; + position: fixed; + top: 8px; + right: 8px; + background: #1f1f1f; + border: 1px solid #333; + padding: 6px 10px; + border-radius: 4px; + font-size: 14px; + font-weight: bold; + color: #e5e5e5; + z-index: 999; +} + +#refreshButtonText { + font-weight: bold; +} + +.row { + white-space: pre; + line-height: 16px; + font-size: 13px; + padding-left: 6px; + color: #e5e5e5; +} + +.row.spacer { + padding-left: 0 !important; + padding-right: 0 !important; +} + +.row.spacer.full-width { + padding-left: 0 !important; + padding-right: 0 !important; +} + +.row.client { + white-space: normal; + color: #ffffff; +} + +.channel { + color: #ffffff; + padding-left: 10px; +} + +.spacer { + color: #888; + white-space: pre; + font-weight: bold; + font-family: 'Roboto', sans-serif; + line-height: 16px; +} + +.spacer-mono { + font-family: "Courier New", monospace; +} + +.spacer-left { text-align: left; } +.spacer-center { text-align: center; } +.spacer-right { text-align: right; } + +.children { + margin-left: 10px; +} + +.server-info { + margin: 6px; + padding: 6px; + border: 1px solid #333; + background: #1a1a1a; + font-size: 12px; + color: #ccc; +} + +.server-info span { + display: inline-block; + width: 150px; + color: #bbb; +} + +.client { + padding-left: 10px; + color: #ffffff; +} + +.status-dot { + display: inline-block; + width: 8px; + height: 8px; + background-color: #4CAF50; + border-radius: 50%; + margin-right: 6px; + position: relative; + top: -1px; +} diff --git a/internal/web/static/light.css b/internal/web/static/light.css new file mode 100644 index 0000000..b9c47b0 --- /dev/null +++ b/internal/web/static/light.css @@ -0,0 +1,110 @@ +body { + font-family: 'Roboto', sans-serif; + background: #ffffff; + color: #000000; + padding: 0; + margin: 0; + font-size: 13px; +} + +h1, h2 { + margin: 6px 0; + padding-left: 6px; + font-size: 15px; + font-weight: bold; + color: #222; +} + +#refreshButton { + cursor: default!important; + position: fixed; + top: 8px; + right: 8px; + background: #eee; + border: 1px solid #ccc; + padding: 6px 10px; + border-radius: 4px; + font-size: 14px; + font-weight: bold; + z-index: 999; +} + +#refreshButtonText { + font-weight: bold; +} + +.row { + white-space: pre; + line-height: 16px; + font-size: 13px; + padding-left: 6px; +} + +.row.spacer { + padding-left: 0 !important; + padding-right: 0 !important; +} + +.row.spacer.full-width { + padding-left: 0 !important; + padding-right: 0 !important; +} + +.row.client { + white-space: normal; +} + +.channel { + color: #000; + padding-left: 10px; +} + +.spacer { + color: #777; + white-space: pre; + font-weight: bold; + font-family: 'Roboto', sans-serif; + line-height: 16px; +} + +.spacer-mono { + font-family: "Courier New", monospace; +} + +.spacer-left { text-align: left; } +.spacer-center { text-align: center; } +.spacer-right { text-align: right; } + +.children { + margin-left: 10px; +} + +.server-info { + margin: 6px; + padding: 6px; + border: 1px solid #ccc; + background: #fafafa; + font-size: 12px; +} + +.server-info span { + display: inline-block; + width: 150px; + color: #444; +} + +.client { + padding-left: 10px; + color: #000; +} + +.status-dot { + display: inline-block; + width: 8px; + height: 8px; + background-color: #4CAF50; + border-radius: 50%; + margin-right: 6px; + position: relative; + top: -1px; +} \ No newline at end of file diff --git a/internal/web/static/ts6viewer.js b/internal/web/static/ts6viewer.js new file mode 100644 index 0000000..d399e59 --- /dev/null +++ b/internal/web/static/ts6viewer.js @@ -0,0 +1,153 @@ +// ========================================== +// Refresh countdown (also controls data polling) +// ========================================== +let counter = refreshTime; + +const refreshText = document.getElementById("refreshButtonText"); + +// Update countdown every second +setInterval(() => { + counter--; + refreshText.textContent = counter; + + // When countdown reaches zero → refresh data + if (counter <= 0) { + counter = refreshTime; + fetchViewerData(); + } +}, 1000); + + +// ========================================== +// Spacer rendering helpers +// ========================================== +function repeatToWidth(element) { + const pattern = element.dataset.pattern; + if (!pattern) return; + + const width = element.clientWidth; + const charWidth = getCharWidth(element); + const repeatCount = Math.ceil(width / (pattern.length * charWidth)); + + element.textContent = pattern.repeat(repeatCount); +} + +function getCharWidth(element) { + const test = document.createElement("span"); + test.style.visibility = "hidden"; + test.style.whiteSpace = "pre"; + test.style.fontFamily = getComputedStyle(element).fontFamily; + test.textContent = "_"; + document.body.appendChild(test); + const width = test.getBoundingClientRect().width; + test.remove(); + return width; +} + +function updateAllSpacers() { + document.querySelectorAll(".full-width").forEach(repeatToWidth); +} + + +// ========================================== +// Fetch viewer data from backend +// ========================================== +async function fetchViewerData() { + try { + const response = await fetch("/ts6viewer/data"); + const data = await response.json(); + + updateServerInfo(data.Server); + updateChannelTree(data.ChannelTree); + + updateAllSpacers(); + } catch (err) { + console.error("Polling error:", err); + } +} + + +// ========================================== +// Update server info box +// ========================================== +function updateServerInfo(server) { + document.getElementById("server-name").textContent = server.Name; + + document.querySelector(".server-info").innerHTML = ` +
User: ${server.ClientsOnline} / ${server.MaxClients}
+
Client Connections: ${server.ClientConnections}
+
Uptime: ${server.UptimePretty}
+
ChannelsOnline: ${server.ChannelsOnline}
+ + `; +} + + +// ========================================== +// Render channel tree +// ========================================== +function updateChannelTree(tree) { + const container = document.getElementById("channels"); + container.innerHTML = renderChannels(tree); +} + +function renderChannels(nodes) { + let html = ""; + for (const node of nodes) { + html += renderChannel(node); + } + return html; +} + +function renderChannel(ch) { + const typeClass = ch.Type === 0 ? "channel" : "spacer"; + + const alignClassName = + ch.Align === 0 ? "spacer-left" : + ch.Align === 1 ? "spacer-center" : + "spacer-right"; + + let html = '
'; + + if (ch.Clients && ch.Clients.length > 0) { + html += '
'; + for (const c of ch.Clients) { + html += '
' + + c.Nickname + + '
'; + } + html += '
'; + } + + if (ch.Children && ch.Children.length > 0) { + html += '
'; + for (const child of ch.Children) { + html += renderChannel(child); + } + html += '
'; + } + + return html; +} + +// ========================================== +// Initial load +// ========================================== +window.addEventListener("load", () => { + fetchViewerData(); + updateAllSpacers(); +}); + +window.addEventListener("resize", updateAllSpacers); diff --git a/internal/web/templates/ts6viewer.html b/internal/web/templates/ts6viewer.html new file mode 100644 index 0000000..879271b --- /dev/null +++ b/internal/web/templates/ts6viewer.html @@ -0,0 +1,70 @@ +{{define "channel"}} +
+{{- .Name -}} +
+ +{{if .Clients}} +
+ {{range .Clients}} +
+ {{.Nickname}} +
+ {{end}} +
+{{end}} + +{{if .Children}} +
+ {{range .Children}} + {{template "channel" .}} + {{end}} +
+{{end}} +{{end}} + + + + + +TS6 Viewer + + + + + + + + + + +

{{.Server.Name}}

+ +
+
User: {{.Server.ClientsOnline}} / {{.Server.MaxClients}}
+
Client Connections: {{.Server.ClientConnections}}
+
Uptime: {{.Server.UptimePretty}}
+
ChannelsOnline: {{.Server.ChannelsOnline}}
+ +
+ +
+ {{range .ChannelTree}} + {{template "channel" .}} + {{end}} +
+ + + + + + diff --git a/light.png b/light.png new file mode 100644 index 0000000..8c3660d Binary files /dev/null and b/light.png differ