commit 82bba66fd6dd99d9866ff9594a473e1bda144332 Author: MassiveBox Date: Sat Oct 15 19:58:44 2022 +0200 First commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..76cffc0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +config.json +cache.json +go.sum \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..13566b8 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/ecodash.iml b/.idea/ecodash.iml new file mode 100644 index 0000000..5e764c4 --- /dev/null +++ b/.idea/ecodash.iml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml new file mode 100644 index 0000000..3018bff --- /dev/null +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -0,0 +1,36 @@ + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..283b9b4 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,8 @@ + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..4f83220 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..3a5f7dd --- /dev/null +++ b/Dockerfile @@ -0,0 +1,14 @@ +FROM golang:1.19 + +RUN mkdir -p /app + +WORKDIR /app +ADD . /app + +RUN rm -rf go.mod go.sum config.json cache.json; \ + touch config.json; \ + go mod init ecodash; \ + go mod tidy +RUN go build -o app . + +CMD ["./app"] \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e72bfdd --- /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 +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..cd88f47 --- /dev/null +++ b/README.md @@ -0,0 +1,103 @@ +# 🌿 EcoDash + +EcoDash is a simple way to show your users how much your server consumes. +It's intended as a medium of transparency, that gives your users an idea about the consumption of your machine. It's not meant to be 100% accurate. + +You can see it in action here: https://ecodash.massivebox.net + +## Requirements + +- A working HomeAssistant installation +- An energy consumption sensor, such as a [smart plug](https://www.aliexpress.com/item/1005003188500978.html), to which your server is plugged in and connected. + - All hardware that is +- CO2 Signal added as integration into HomeAssistant + +## Installation + +#### Using Docker run: +``` +touch config.json +docker run -v ./config.json:/app/config.json --name ecodash -p 8080:80 gitea.massivebox.net/massivebox/ecodash +``` +This will open the container on port 8080. Replace "8080" in the command with whatever number you want to open that specific port. + +#### Using Docker Compose: +Create a file `docker-compose.yml` with the following content: +``` +version: '3' +services: + ecodash: + container_name: ecodash + image: gitea.massivebox.net/massivebox/ecodash + ports: + - '8080:80' + volumes: + - ./config.json:/app/config.json + restart: always + +``` +Run the container with +``` +touch config.json +docker compose up -d +``` +This will open the container on port 8080. Replace "8080" in the file with whatever number you want to open that specific port. + +#### Using the binary +Grab a binary from the Releases page and run it. You can use the `PORT` environment variable to override the default port (80). + +## Set up + +As soon as you navigate to the container's exposed port, you will see the admin dashboard, there you will have to fill all fields to get EcoDash running. + +- **HomeAssistant's base URL**: the base URL which you use to access HomeAssistant on your server. It should be something like `http://INTERNAL_IP_ADDRESS:8123/` or `https://homeassistant.youdomain.com/`. +- **HomeAssistant's API Key:** Get it by going into your HomeAssistant profile settings (at `http://HOMEASSISTANT-BASE-URL/profile`) -> Create Long Lived Access Token (at the very bottom of the page) -> Insert a name -> Copy the string it gives you +- **Polled Smart Energy Summation entity ID:** After your plug is added in HomeAssistant, get it in Overview -> look for an entity called like "[Name of your plug] Polledsmartenergysummation" -> Settings -> Copy the Entity ID. Check that the unit of measurement in the "Info" tab is kWh. +- **CO2 signal Grid fossil fuel percentage entity ID**: Get it in Settings -> Devices and Integrations -> Add Integration -> CO2 Signal -> Get your token from the website -> CO2 signal Grid fossil fuel percentage -> Settings -> Copy the Entity ID. Check that the unit of measurement in the "Info" tab is %. +- **Admin username and password** don't need to be the credentials to HomeAssistant! They are the credentials to log into the admin panel. + +If you've just added your energy meter into HomeAssistant, note that it will take eight days for EcoDash to show meaningful data. + +## Support + +If something isn't working, you can find some help here: +- [Matrix support room](https://matrix.to/#/#support:massivebox.net) +- [Issues page](./issues) +- [Contact me](https://massivebox.net/contact.html) + +## The road ahead + +EcoDash is currently released as a minimum viable product, still far from completion. Here's a non-extensive, unordered list of the changes I want to make. + +- Adding support for energy returns (like solar panels) +- Supporting hot reload, removing the need to restart EcoDash each time the settings are changed +- Improving clarity for when data is missing +- Making FossilFuel Percentage optional and adding other sources +- Supporting energy consumption readings from internal sensors +- Adding some way to change header/footer links directly from the admin panel +- Eventually being completely HomeAssistant-independent +- Adding Woodpecker CI +- Organizing branches and releases better +- Moving documentation to a wiki and expanding it +- Extensively documenting the theming capabilities of EcoDash +- Publishing some alternative themes + +## License + +``` +EcoDash +Copyright (C) 2022 MassiveBox + +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 . +``` \ No newline at end of file diff --git a/api.go b/api.go new file mode 100644 index 0000000..d2ae11c --- /dev/null +++ b/api.go @@ -0,0 +1,239 @@ +package main + +import ( + "encoding/json" + "errors" + "io" + "log" + "math" + "net/http" + "net/url" + "strconv" + "time" +) + +type HistoryResult [][]struct { + State string `json:"state"` + LastUpdated time.Time `json:"last_updated"` +} + +func (config Config) queryHistory(entityID string, startTime, endTime time.Time) (HistoryResult, error) { + + req, err := http.NewRequest("GET", config.HomeAssistant.BaseURL+ + "/api/history/period/"+url.QueryEscape(startTime.Format(time.RFC3339))+ + "?filter_entity_id="+entityID+ + "&end_time="+url.QueryEscape(endTime.Format(time.RFC3339)), /*+ + "&minimal_response",*/nil) + if err != nil { + return HistoryResult{}, err + } + + req.Header.Add("Authorization", "Bearer "+config.HomeAssistant.ApiKey) + client := &http.Client{} + + resp, err := client.Do(req) + if err != nil { + return HistoryResult{}, err + } + defer resp.Body.Close() + + if resp.StatusCode != 200 { + return HistoryResult{}, errors.New("got a non-200 status code. Check the correctness of sensors IDs -" + resp.Status) + } + + body, err := io.ReadAll(resp.Body) + if err != nil { + return HistoryResult{}, err + } + + var result HistoryResult + err = json.Unmarshal(body, &result) + if err != nil { + return result, err + } + + return result, nil + +} + +type DayData struct { + DayNumber int + DayTime time.Time + Measurements int + Value float32 + High float32 + Low float32 +} + +func (config Config) historyAverageAndConvertToGreen(entityID string, startTime, endTime time.Time) ([]DayData, error) { + + history, err := config.queryHistory(entityID, startTime, endTime) + if err != nil { + return nil, err + } + + var days []DayData + + for _, historyChange := range history[0] { + val, err := strconv.ParseFloat(historyChange.State, 32) + if err != nil { + continue + } + value := float32(val) + var found bool + dayNo := historyChange.LastUpdated.Local().Day() + for key, day := range days { + if dayNo == day.DayNumber { + found = true + day.Value += value + day.Measurements++ + days[key] = day + } + } + if !found { + days = append(days, DayData{ + DayNumber: dayNo, + DayTime: historyChange.LastUpdated.Local(), + Measurements: 1, + Value: value, + }) + } + } + + for key, day := range days { + // by using 100 - value we get the percentage of green energy instead of the percentage of fossil-generated energy + day.Value = 100 - (day.Value / float32(day.Measurements)) + days[key] = day + } + + days = fillMissing(days) + + return days, nil + +} + +func (config Config) historyDelta(entityID string, startTime, endTime time.Time) ([]DayData, error) { + + history, err := config.queryHistory(entityID, startTime, endTime) + if err != nil { + return nil, err + } + + var days []DayData + + for _, historyChange := range history[0] { + if historyChange.State != "off" { + val, err := strconv.ParseFloat(historyChange.State, 32) + if err != nil { + continue + } + value := float32(val) + var found bool + dayNo := historyChange.LastUpdated.Local().Day() + for key, day := range days { + if dayNo == day.DayNumber { + found = true + if value > day.High { + day.High = value + } + if value < day.Low || day.Low == 0 { + day.Low = value + } + days[key] = day + } + } + if !found { + days = append(days, DayData{ + DayNumber: dayNo, + DayTime: historyChange.LastUpdated.Local(), + Value: value, + }) + } + } + } + + for key, day := range days { + day.Value = day.High - day.Low + days[key] = day + } + + days = fillMissing(days) + + return days, nil + +} + +func fillMissing(days []DayData) []DayData { + + var ( + previousDay time.Time + defaultDay time.Time + previousValue float32 + ret []DayData + currentTime = time.Now() + ) + + for key, day := range days { + + if key != 0 { + + if day.DayTime.Day() != previousDay.Add(24*time.Hour).Day() { + daysDiff := math.Trunc(day.DayTime.Sub(previousDay).Hours() / 24) + for i := 1; float64(i) < daysDiff; i++ { + fakeTime := previousDay.Add(time.Duration(24*i) * time.Hour) + ret = append(ret, DayData{ + DayNumber: fakeTime.Day(), + DayTime: fakeTime, + Value: previousValue, + }) + } + } + + } + + ret = append(ret, day) + previousValue = day.Value + previousDay = day.DayTime + + } + + // note that here previousDay is the last logged day + if previousDay == defaultDay { + return []DayData{} + } + + if previousDay.Day() != currentTime.Day() { + daysDiff := math.Trunc(currentTime.Sub(previousDay).Hours() / 24) + for i := 1; float64(i) < daysDiff; i++ { + fakeTime := previousDay.Add(time.Duration(24*i) * time.Hour) + ret = append(ret, DayData{ + DayNumber: fakeTime.Day(), + DayTime: fakeTime, + Value: previousValue, + }) + } + } + + if len(ret) < 8 { + shouldAdd := 8 - len(ret) + startDay := currentTime.Add(-time.Duration(24*len(ret)) * time.Hour) + for i := 0; i < shouldAdd; i++ { + fakeTime := startDay.Add(-time.Duration(24*i) * time.Hour) + ret = append([]DayData{ + { + DayNumber: fakeTime.Day(), + DayTime: fakeTime, + Value: 0, + }, + }, ret...) + } + } + + if len(ret) != 8 { + // oh shit + log.Panicln("You've found a logic bug! Open a bug report ASAP.") + } + + return ret + +} diff --git a/cache.go b/cache.go new file mode 100644 index 0000000..b6c899d --- /dev/null +++ b/cache.go @@ -0,0 +1,67 @@ +package main + +import ( + "encoding/json" + "fmt" + "os" + "time" +) + +type CacheEntry struct { + Date string `json:"date""` + GreenEnergyPercentage float32 `json:"green_energy_percentage"` + PolledSmartEnergySummation float32 `json:"polled_smart_energy_summation"` +} +type CacheFile []CacheEntry + +func (config Config) updateCache() { + + now := time.Now() + h, m, s := now.Clock() + start := now.AddDate(0, 0, -7).Add(-(time.Duration(h)*time.Hour + time.Duration(m)*time.Minute + time.Duration(s)*time.Second)) + + greenEnergyPercentage, err := config.historyAverageAndConvertToGreen(config.Sensors.FossilPercentage, start, now) + if err != nil { + fmt.Println("Error updating cached data for FossilPercentage -" + err.Error()) + return + } + historyPolledSmartEnergySummation, err := config.historyDelta(config.Sensors.PolledSmartEnergySummation, start, now) + if err != nil { + fmt.Println("Error updating cached data for PolledSmartEnergySummation -" + err.Error()) + return + } + + var cacheEntries []CacheEntry + for key, day := range greenEnergyPercentage { + cacheEntries = append(cacheEntries, CacheEntry{ + Date: day.DayTime.Format("02/01"), + GreenEnergyPercentage: greenEnergyPercentage[key].Value, + PolledSmartEnergySummation: historyPolledSmartEnergySummation[key].Value, + }) + } + + out, _ := json.Marshal(cacheEntries) + + err = os.WriteFile("cache.json", out, 0666) + if err != nil { + fmt.Println("Error saving cached data to file -" + err.Error()) + } + +} + +func readCache() (CacheFile, error) { + + data, err := os.ReadFile("cache.json") + if err != nil { + return CacheFile{}, err + } + + var cache CacheFile + err = json.Unmarshal(data, &cache) + if err != nil { + return CacheFile{}, err + } + + return cache, nil + +} diff --git a/config.go b/config.go new file mode 100644 index 0000000..186e7ff --- /dev/null +++ b/config.go @@ -0,0 +1,109 @@ +package main + +import ( + "crypto/sha256" + "encoding/json" + "errors" + "fmt" + "github.com/gofiber/fiber/v2" + "os" + "regexp" + "strings" +) + +type Config struct { + HomeAssistant HomeAssistant `json:"home_assistant"` + Sensors Sensors `json:"sensors"` + Administrator Administrator `json:"administrator"` + Dashboard Dashboard `json:"dashboard"` +} + +type HomeAssistant struct { + BaseURL string `json:"base_url"` + ApiKey string `json:"api_key"` +} +type Sensors struct { + PolledSmartEnergySummation string `json:"polled_smart_energy_summation"` + FossilPercentage string `json:"fossil_percentage"` +} +type Administrator struct { + Username string `json:"username"` + PasswordHash string `json:"password_hash"` +} +type Dashboard struct { + Name string `json:"name"` + Theme string `json:"theme"` + FooterLinks []Link `json:"footer_links"` + HeaderLinks []Link `json:"header_links"` +} + +func formatURL(url string) (string, error) { + + // the URL we want is: protocol://hostname[:port] without a final / + + if !strings.HasPrefix(url, "http://") && !strings.HasPrefix(url, "https://") { + url = "http://" + url + } + if strings.HasSuffix(url, "/") { + url = url[0 : len(url)-1] + } + + test := regexp.MustCompile(`(?m)https?:\/\/[^/]*`).ReplaceAllString(url, "") + if test != "" { + return "", errors.New("HomeAssistant base URL is badly formatted") + } + + return url, nil + +} + +func loadConfig() (config Config, err error, isFirstRun bool) { + + var defaultConfig = Config{} + defaultConfig.Dashboard.Theme = "default" + defaultConfig.Dashboard.Name = "EcoDash" + defaultConfig.Dashboard.HeaderLinks = append(defaultConfig.Dashboard.HeaderLinks, Link{ + Label: "Admin", + Destination: "/admin", + }, Link{ + Label: "Docs", + Destination: "https://gitea.massivebox.net/massivebox/ecodash", + NewTab: true, + Primary: true, + }) + + data, err := os.ReadFile("config.json") + if err != nil { + // if the data file doesn't exist, we consider it a first run + if os.IsNotExist(err) { + return defaultConfig, nil, true + } + return Config{}, err, false + } + + // if the data file is empty, we consider it as a first run + if string(data) == "" { + return defaultConfig, nil, true + } + + var conf Config + err = json.Unmarshal(data, &conf) + if err != nil { + return Config{}, err, false + } + + return conf, nil, false + +} + +// just a little utility function to SHA256 strings (for hashing passwords) +func hash(toHash string) string { + return fmt.Sprintf("%x", sha256.Sum256([]byte(toHash))) +} + +func (config Config) isAuthorized(c *fiber.Ctx) bool { + if config.Administrator.PasswordHash == "" { + return true + } + return c.Cookies("admin_username") == config.Administrator.Username && c.Cookies("admin_password_hash") == config.Administrator.PasswordHash +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..7ef3761 --- /dev/null +++ b/go.mod @@ -0,0 +1,18 @@ +module ecodash + +go 1.17 + +require ( + github.com/gofiber/fiber/v2 v2.37.1 + github.com/gofiber/template v1.7.1 + github.com/robfig/cron/v3 v3.0.1 +) + +require ( + github.com/andybalholm/brotli v1.0.4 // indirect + github.com/klauspost/compress v1.15.0 // indirect + github.com/valyala/bytebufferpool v1.0.0 // indirect + github.com/valyala/fasthttp v1.40.0 // indirect + github.com/valyala/tcplisten v1.0.0 // indirect + golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9 // indirect +) diff --git a/http.go b/http.go new file mode 100644 index 0000000..3aa3768 --- /dev/null +++ b/http.go @@ -0,0 +1,219 @@ +package main + +import ( + "encoding/json" + "errors" + "fmt" + "github.com/gofiber/fiber/v2" + "html/template" + "math" + "os" + "reflect" + "time" +) + +type Link struct { + Label string `json:"label"` + Destination string `json:"destination"` + NewTab bool `json:"new_tab"` + Primary bool `json:"primary"` +} + +type Warning struct { + Header string + Body string + BodyHTML template.HTML + IsSuccess bool +} + +func (config Config) getTemplateDefaults() map[string]interface{} { + return fiber.Map{ + "DashboardName": config.Dashboard.Name, + "HeaderLinks": config.Dashboard.HeaderLinks, + "FooterLinks": config.Dashboard.FooterLinks, + } +} + +func (config Config) adminEndpoint(c *fiber.Ctx) error { + + if c.Method() == "POST" { + + if config.isAuthorized(c) { // here the user is submitting the form to change configuration + err := config.saveAdminForm(c) + if err != nil { + return config.renderAdminPanel(c, Warning{ + Header: "An error occurred!", + Body: err.Error(), + }) + } + return config.renderAdminPanel(c, Warning{ + Header: "Restart needed", + Body: "In order to apply changes, please restart EcoDash.
" + + "If you're running via Docker, click here to restart automatically.", + IsSuccess: true, + }) + } + + // here the user is trying to authenticate + if c.FormValue("username") == config.Administrator.Username && hash(c.FormValue("password")) == config.Administrator.PasswordHash { + c.Cookie(&fiber.Cookie{Name: "admin_username", Value: c.FormValue("username")}) + c.Cookie(&fiber.Cookie{Name: "admin_password_hash", Value: hash(c.FormValue("password"))}) + return config.renderAdminPanel(c) + } + return c.Render("login", fiber.Map{"Defaults": config.getTemplateDefaults(), "Failed": true}, "base") + + } + + if config.isAuthorized(c) { + return config.renderAdminPanel(c) + } + return c.Render("login", fiber.Map{"Defaults": config.getTemplateDefaults()}, "base") + +} + +func (config Config) renderAdminPanel(c *fiber.Ctx, warning ...Warning) error { + + dirs, err := os.ReadDir("./templates") + if err != nil { + return err + } + + if len(warning) > 0 { + warning[0].BodyHTML = template.HTML(warning[0].Body) + return c.Render("admin", fiber.Map{ + "Defaults": config.getTemplateDefaults(), + "Themes": dirs, + "Config": config, + "Warning": warning[0], + }, "base") + } + + return c.Render("admin", fiber.Map{ + "Defaults": config.getTemplateDefaults(), + "Themes": dirs, + "Config": config, + }, "base") + +} + +func (config Config) saveAdminForm(c *fiber.Ctx) error { + + requiredFields := []string{"base_url", "api_key", "polled_smart_energy_summation", "fossil_percentage", "username", "theme", "name"} + for _, requiredField := range requiredFields { + if c.FormValue(requiredField) == "" { + return errors.New("Required field is missing: " + requiredField) + } + } + + form := Config{ + HomeAssistant: HomeAssistant{ /*BaseURL to be filled later*/ ApiKey: c.FormValue("api_key")}, + Sensors: Sensors{PolledSmartEnergySummation: c.FormValue("polled_smart_energy_summation"), FossilPercentage: c.FormValue("fossil_percentage")}, + Administrator: Administrator{Username: c.FormValue("username") /*PasswordHash to be filled later*/}, + Dashboard: Dashboard{Theme: c.FormValue("theme"), Name: c.FormValue("name"), HeaderLinks: config.Dashboard.HeaderLinks, FooterLinks: config.Dashboard.FooterLinks}, + } + + if c.FormValue("keep_old_password") == "" { + form.Administrator.PasswordHash = hash(c.FormValue("password")) + } else { + form.Administrator.PasswordHash = config.Administrator.PasswordHash + } + + fmtURL, err := formatURL(c.FormValue("base_url")) + if err != nil { + return err + } + form.HomeAssistant.BaseURL = fmtURL + + if reflect.DeepEqual(form, config) { + return errors.New("No changes from previous config.") + } + + // in order to test if ha base URL, API key and entity IDs are correct we try fetching the devices history + _, err = form.queryHistory(form.Sensors.FossilPercentage, time.Now().Add(-5*time.Minute), time.Now()) + if err != nil { + return err + } + _, err = form.queryHistory(form.Sensors.PolledSmartEnergySummation, time.Now().Add(-5*time.Minute), time.Now()) + if err != nil { + return err + } + + js, err := json.Marshal(form) + if err != nil { + return err + } + + return os.WriteFile("config.json", js, 0666) + +} + +func sevenDaysAverageExcludingCurrentDay(data []float32) float32 { + if len(data) == 0 { + return 0 + } + data = data[:len(data)-1] + var sum float32 + for _, num := range data { + sum += num + } + var avg = sum / float32(len(data)) + return float32(math.Floor(float64(avg)*100)) / 100 +} + +func (config Config) renderIndex(c *fiber.Ctx) error { + + data, err := readCache() + if err != nil { + return err + } + + var ( + labels []string + greenEnergyConsumptionAbsolute []float32 + greenEnergyPercents []float32 + energyConsumptions []float32 + ) + + for _, datum := range data { + labels = append(labels, datum.Date) + greenEnergyPercents = append(greenEnergyPercents, datum.GreenEnergyPercentage) + greenEnergyConsumptionAbsolute = append(greenEnergyConsumptionAbsolute, datum.GreenEnergyPercentage/100*datum.PolledSmartEnergySummation) + energyConsumptions = append(energyConsumptions, datum.PolledSmartEnergySummation) + } + + perDayUsage := sevenDaysAverageExcludingCurrentDay(energyConsumptions) + + return c.Render("index", fiber.Map{ + "Defaults": config.getTemplateDefaults(), + "Labels": labels, + "GreenEnergyPercents": greenEnergyConsumptionAbsolute, + "EnergyConsumptions": energyConsumptions, + "GreenEnergyPercent": sevenDaysAverageExcludingCurrentDay(greenEnergyPercents), + "PerDayUsage": perDayUsage, + }, "base") + +} + +func templateDivide(num1, num2 float32) template.HTML { + var ( + isInDecimals bool + hasHitMeaningful bool + meaningfulDigits int + rounded []byte + num = num1 / num2 + ) + for _, char := range []byte(fmt.Sprintf("%v", num)) { + if (isInDecimals && char != '0') || hasHitMeaningful { + hasHitMeaningful = true + meaningfulDigits++ + } + if char == '.' { + isInDecimals = true + } + rounded = append(rounded, char) + if meaningfulDigits == 3 { + break + } + } + return template.HTML(rounded) +} diff --git a/main.go b/main.go new file mode 100644 index 0000000..381ea3d --- /dev/null +++ b/main.go @@ -0,0 +1,74 @@ +package main + +import ( + "github.com/gofiber/fiber/v2" + "github.com/gofiber/template/html" + "github.com/robfig/cron/v3" + "log" + "os" + "time" +) + +func main() { + + config, err, isFirstRun := loadConfig() + if err != nil { + log.Fatal(err) + } + + if !isFirstRun { + cr := cron.New() + _, err = cr.AddFunc("@hourly", config.updateCache) + if err != nil { + return + } + cr.Start() + config.updateCache() + } + + engine := html.New("./templates/"+config.Dashboard.Theme, ".html") + engine.AddFunc("divide", templateDivide) + + app := fiber.New(fiber.Config{ + Views: engine, + }) + + app.Static("/assets", "./templates/"+config.Dashboard.Theme+"/assets") + + app.Get("/", func(c *fiber.Ctx) error { + if isFirstRun { + c.Cookie(&fiber.Cookie{Name: "admin_username", Value: ""}) + c.Cookie(&fiber.Cookie{Name: "admin_password_hash", Value: hash("")}) + return config.renderAdminPanel(c) + } + return config.renderIndex(c) + }) + + app.Get("/accuracy-notice", func(c *fiber.Ctx) error { + return c.Render("accuracy-notice", fiber.Map{ + "Defaults": config.getTemplateDefaults(), + }, "base") + }) + + app.All("/admin", config.adminEndpoint) + + app.Get("/restart", func(c *fiber.Ctx) error { + if config.isAuthorized(c) { + go func() { + time.Sleep(time.Second) + os.Exit(1) + }() + return c.Render("restart", fiber.Map{ + "Defaults": config.getTemplateDefaults(), + }, "base") + } + return c.Redirect("./", 307) + }) + + port := os.Getenv("PORT") + if port == "" { + port = "80" + } + log.Fatal(app.Listen(":" + port)) + +} diff --git a/templates/default/accuracy-notice.html b/templates/default/accuracy-notice.html new file mode 100644 index 0000000..fbfb4ed --- /dev/null +++ b/templates/default/accuracy-notice.html @@ -0,0 +1,26 @@ +

Accuracy Notice

+ All the data reported in this dashboard is exclusively for reference. It's presented here with no guarantees of being + up-to-date or reliable. +

+ +

Energy consumption data

+ The energy consumption data reported in this dashboard has been obtained using unprofessional equipment, which lacks of + any kind of documentation about its precision.
+ Don't take this data too seriously. +

+ +

Green energy percentage

+ The percentage of green energy is gathered using CO2Signal's API.
+ The data reported might be estimated on historical data, and is exclusively +

+ +

References for comparison table

Desk light: calculated on a 3W 270 lumen lamp running for 24 hours = 0.072kWh
Washing machine: estimated at an average of 0.66kWh (source)
Oven: calculated on a 2400W oven running for 30 minutes (the average time to bake a cake, according to my mom) = 1.2kWh
Bitcoin transaction: estimated as 1300kWh (source)

\ No newline at end of file diff --git a/templates/default/admin.html b/templates/default/admin.html new file mode 100644 index 0000000..e655834 --- /dev/null +++ b/templates/default/admin.html @@ -0,0 +1,53 @@ +

Admin Panel

Here you can edit all the configurations for EcoDash.

+ +{{if .Warning}} +

+ +

Accuracy Notice

Energy consumption data

Green energy percentage

References for comparison table

Admin Panel

{{.Warning.Header}}

HomeAssistant

Sensors

Admin account

Personalization

Green report

Energy usage per day

Green energy %

This server consumes in a day as much as...

Login

Error!

Restarting...