diff --git a/.env.model b/.env.model index 6fce799..a021120 100644 --- a/.env.model +++ b/.env.model @@ -1,5 +1,6 @@ ENV=development LOCALENV=true +BACKUP_DIR=/mnt/SR/DATA/BKP/ POSTGRES_USER=socialroots POSTGRES_DB=socialroots_default diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..55e5c35 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,15 @@ +# These are supported funding model platforms + +#github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +#patreon: # Replace with a single Patreon username +open_collective: socialroots-projects +#ko_fi: # Replace with a single Ko-fi username +#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +#liberapay: # Replace with a single Liberapay username +#issuehunt: # Replace with a single IssueHunt username +#lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry +#polar: # Replace with a single Polar username +#buy_me_a_coffee: # Replace with a single Buy Me a Coffee username +#thanks_dev: # Replace with a single thanks.dev username +#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/.gitmodules b/.gitmodules index 03050a3..ee18d83 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,31 +1,31 @@ [submodule "modules/ORCHESTRATOR"] path = modules/ORCHESTRATOR url = git@github.com:SocialRoots/rootshoots-orchestrate.git - branch = integration + branch = alpha [submodule "modules/RS-USERS"] path = modules/RS-USERS url = git@github.com:SocialRoots/rootshoot-users.git - branch = integration + branch = alpha [submodule "modules/RS-GROUPS"] path = modules/RS-GROUPS url = git@github.com:SocialRoots/rootshoot-groups.git - branch = integration + branch = alpha [submodule "modules/RS-CONNECTIONS"] path = modules/RS-CONNECTIONS url = git@github.com:SocialRoots/rootshoots-connections.git - branch = integration + branch = alpha [submodule "modules/RS-NOTIFICATIONS"] path = modules/RS-NOTIFICATIONS url = git@github.com:SocialRoots/rootshoot-notification.git - branch = integration + branch = alpha [submodule "modules/RS-NOTES"] path = modules/RS-NOTES url = git@github.com:SocialRoots/rootshoot-sendmail.git - branch = integration + branch = alpha [submodule "modules/RS-RESPONSES"] path = modules/RS-RESPONSES url = git@github.com:SocialRoots/rootshoot-responsecapture.git - branch = integration + branch = alpha [submodule "modules/RS-UTILS"] path = modules/RS-UTILS url = git@github.com:SocialRoots/sr-microservices-utils.git diff --git a/CLAUDE.md b/AGENTS.md similarity index 84% rename from CLAUDE.md rename to AGENTS.md index 582c74b..852172f 100644 --- a/CLAUDE.md +++ b/AGENTS.md @@ -1,6 +1,6 @@ -# CLAUDE.md +# AGENTS.md -This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. +This file provides guidance to AI coding assistants when working with code in this repository. ## Architecture Overview @@ -28,8 +28,8 @@ Each microservice is a separate Go module with its own database, migrations, and git submodule update --init --recursive # Set up databases (requires PostgreSQL running) -chmod +x init-db.sh -./init-db.sh +chmod +x bin/init-db.sh +./bin/init-db.sh ``` ### Docker Operations @@ -116,6 +116,17 @@ go run cmd/script/main.go # Run utility scripts - Test databases configured via `.env.test` files - Integration tests communicate with other services via HTTP clients +### Testing Best Practices +- **IMPORTANT**: Tests use a dedicated test DATABASE (`rootshoot-tests`), NOT `_test` suffixed tables +- Do NOT use `TestCk()` or similar table suffix functions in tests - use the main table names +- The `.env.test` file points to the test database, so migrations create tables with normal names there +- **IMPORTANT**: The test database is shared across modules. Before running migrations for a module, you must reset the database: + ```bash + PGPASSWORD='th15.R00TZ' psql -U socialroots -h localhost -d rootshoot-tests -c "DROP SCHEMA public CASCADE; CREATE SCHEMA public; GRANT ALL ON SCHEMA public TO socialroots;" + ``` +- Then run migrations: `set -a && source .env.test && set +a && ./scripts/migrate.sh migrate` +- To run tests: `set -a && source .env.test && set +a && go test -v ./pkg/db` + ### Security & Authentication - ORCHESTRATOR handles authentication and authorization - Services validate requests through user tokens and service keys diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md index 2d82a94..6f3777d 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ server. It uses Docker and Compose to start all the needed components: (*) Obs: All SR services are added as Git Submodules. +**Note:** Some modules referenced as submodules are not yet publicly available. We are open-sourcing the project incrementally. + ## Directory structure - `.`: The most relevant files in the home directory are the @@ -38,11 +40,11 @@ server. It uses Docker and Compose to start all the needed components: ### Steps 1. Cloning this repository and get inside its directory using a terminal; - 2. Then, load all the submodules by executing `git pull --recurse-submodules`; + 2. Then, load all the submodules by executing `git submodule update --init`; 3. Bootstrap a brand-new database: 1. start the Postgres server: `docker-compose --env-file .env up postgres -d` - 2. create the Socialroots databases: `./init-db.sh` *(you may need to - add execution permissions to the bash script first: `chmod +x init-sb.sh`)* + 2. create the Socialroots databases: `./bin/init-db.sh` *(you may need to + add execution permissions to the bash script first: `chmod +x bin/init-db.sh`)* 4. Start the services: `docker-compose --env-file .env up NAME_OF_SERVICE [--build] [-d]` 1. ... where `--build` is only needed if you want to rebuild the image in case you diff --git a/bin/backup/README.md b/bin/backup/README.md new file mode 100644 index 0000000..8fa0d61 --- /dev/null +++ b/bin/backup/README.md @@ -0,0 +1,60 @@ +# SocialRoots Backup + +## Requirements + +```bash +pip install python-dotenv +sudo apt install rclone +``` + +## Configuration + +Add to `.env`: +```bash +BACKUP_DIR=/path/to/backups +``` + +Set up rclone remote (for Google Drive): +```bash +rclone config +# Follow prompts to create a remote named 'gdrive' +``` + +## Usage + +```bash +# Backup single database +python bin/backup/db_backup.py --env .env --db sr_notes_int + +# Backup all databases +python bin/backup/db_backup.py --env .env --all + +# Sync backups to Google Drive +python bin/backup/db_backup.py --env .env --rclone gdrive + +# Cleanup old backups +python bin/backup/db_backup.py --env .env --cleanup + +# Full daily routine +python bin/backup/db_backup.py --env .env --all --rclone gdrive --cleanup +``` + +## Folder Structure + +``` +BACKUP_DIR/ +└── postgres/ + └── YYYY-MM-DD/ + └── YYYYMMDD_HHMMSS_dbname.sql.tgz +``` + +## Retention Policy + +- **Daily**: Last 7 days +- **Weekly**: Last 4 Sundays + +## Cron (Daily at 2am) + +```bash +0 2 * * * /usr/bin/python3 /path/to/bin/backup/db_backup.py --env /path/to/.env --all --rclone gdrive --cleanup +``` diff --git a/bin/backup/db_backup.py b/bin/backup/db_backup.py new file mode 100755 index 0000000..52bc558 --- /dev/null +++ b/bin/backup/db_backup.py @@ -0,0 +1,246 @@ +#!/usr/bin/env python3 +# Copyright (C) 2020-2026 Wicked Co-op LCA +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +""" +SocialRoots Database Backup Script + +Usage: + python db_backup.py --env /path/to/.env --db sr_notes_int +""" + +import argparse +import os +import subprocess +import sys +import tarfile +from datetime import datetime +from pathlib import Path + + +def load_config(env_file: str) -> dict: + """Load and validate configuration from .env file.""" + + env_path = Path(env_file) + if not env_path.exists(): + sys.exit(f"Error: .env file not found: {env_file}") + + try: + from dotenv import load_dotenv + load_dotenv(env_path) + except ImportError: + sys.exit("Error: python-dotenv required. Install with: pip install python-dotenv") + + required = ['POSTGRES_USER', 'POSTGRES_PASSWORD', 'POSTGRES_HOST', 'POSTGRES_PORT', 'BACKUP_DIR'] + missing = [key for key in required if not os.getenv(key)] + + if missing: + sys.exit(f"Error: Missing required config: {', '.join(missing)}") + + return { + 'pg_user': os.getenv('POSTGRES_USER'), + 'pg_password': os.getenv('POSTGRES_PASSWORD'), + 'pg_host': os.getenv('POSTGRES_HOST'), + 'pg_port': os.getenv('POSTGRES_PORT'), + 'backup_dir': os.getenv('BACKUP_DIR'), + } + + +def dump_database(db_name: str, config: dict) -> Path: + """Dump a single database to SQL file.""" + + date_str = datetime.now().strftime('%Y-%m-%d') + backup_dir = Path(config['backup_dir']) / 'postgres' / date_str + backup_dir.mkdir(parents=True, exist_ok=True) + + timestamp = datetime.now().strftime('%Y%m%d_%H%M%S') + output_file = backup_dir / f"{timestamp}_{db_name}.sql" + + cmd = [ + 'pg_dump', + '-U', config['pg_user'], + '-h', config['pg_host'], + '-p', config['pg_port'], + '-w', + '-d', db_name, + '--exclude-table', 'logs', + '-f', str(output_file), + ] + + env = os.environ.copy() + env['PGPASSWORD'] = config['pg_password'] + + print(f"Dumping {db_name}...", end=' ', flush=True) + + result = subprocess.run(cmd, env=env, capture_output=True, text=True) + + if result.returncode != 0: + sys.exit(f"FAILED\n Error: {result.stderr}") + + print(f"OK ({output_file.stat().st_size / 1024:.1f} KB)") + return output_file + + +def compress_backup(sql_file: Path) -> Path: + """Compress SQL file to .tgz and remove original.""" + + tgz_file = sql_file.with_suffix('.sql.tgz') + + print(f"Compressing to {tgz_file.name}...", end=' ', flush=True) + + with tarfile.open(tgz_file, 'w:gz') as tar: + tar.add(sql_file, arcname=sql_file.name) + + sql_file.unlink() + + print(f"OK ({tgz_file.stat().st_size / 1024:.1f} KB)") + return tgz_file + + +def cleanup_old_backups(backup_dir: str): + """Keep last 7 daily + last 4 weekly (Sundays).""" + + postgres_dir = Path(backup_dir) / 'postgres' + if not postgres_dir.exists(): + print("No backups to clean up") + return + + today = datetime.now().date() + + # Get all date folders + date_folders = [] + for folder in postgres_dir.iterdir(): + if folder.is_dir(): + try: + folder_date = datetime.strptime(folder.name, '%Y-%m-%d').date() + date_folders.append((folder_date, folder)) + except ValueError: + continue + + date_folders.sort(reverse=True) # Newest first + + keep = set() + sunday_count = 0 + + for folder_date, folder in date_folders: + days_old = (today - folder_date).days + + # Keep last 7 days + if days_old < 7: + keep.add(folder) + # Keep Sundays for 4 weeks + elif folder_date.weekday() == 6 and sunday_count < 4: + keep.add(folder) + sunday_count += 1 + + # Remove old folders + removed = 0 + for folder_date, folder in date_folders: + if folder not in keep: + print(f" Removing {folder.name}...", end=' ') + import shutil + shutil.rmtree(folder) + print("OK") + removed += 1 + + print(f"Cleanup: kept {len(keep)}, removed {removed}") + + +def get_all_databases() -> list: + """Find all database names from DB_NAME_* environment variables.""" + databases = [] + for key, value in os.environ.items(): + if key.startswith('DB_NAME_') and value: + databases.append(value) + return databases + + +def sync_to_remote(remote_name: str, backup_dir: str): + """Sync backup directory to rclone remote.""" + + # Check if rclone is installed + result = subprocess.run(['which', 'rclone'], capture_output=True) + if result.returncode != 0: + sys.exit("Error: rclone not installed. Install with: sudo apt install rclone") + + # Check if remote exists + result = subprocess.run(['rclone', 'listremotes'], capture_output=True, text=True) + if result.returncode != 0: + sys.exit(f"Error: Failed to list rclone remotes: {result.stderr}") + + remotes = [r.rstrip(':') for r in result.stdout.strip().split('\n') if r] + if remote_name not in remotes: + sys.exit(f"Error: Remote '{remote_name}' not found. Available: {', '.join(remotes)}") + + # Sync backup directory + remote_path = f"{remote_name}:" + print(f"Syncing {backup_dir} to {remote_path}...", end=' ', flush=True) + + result = subprocess.run( + ['rclone', 'sync', backup_dir, remote_path], + capture_output=True, + text=True + ) + + if result.returncode != 0: + sys.exit(f"FAILED\n Error: {result.stderr}") + + print("OK") + + +def main(): + parser = argparse.ArgumentParser(description='SocialRoots Database Backup') + parser.add_argument('--env', required=True, help='Path to .env file') + parser.add_argument('--db', help='Database name to backup') + parser.add_argument('--all', action='store_true', help='Backup all DB_NAME_* databases') + parser.add_argument('--rclone', help='rclone remote name to sync backups to') + parser.add_argument('--cleanup', action='store_true', help='Remove old backups (keep 7 daily + 4 weekly)') + args = parser.parse_args() + + if not args.db and not args.all and not args.rclone and not args.cleanup: + sys.exit("Error: Must specify --db, --all, --rclone, or --cleanup") + + print(f"[{datetime.now().strftime('%Y-%m-%d %H:%M:%S')}] Starting") + + config = load_config(args.env) + + # Backup databases if requested + if args.db or args.all: + databases = get_all_databases() if args.all else [args.db] + + if not databases: + sys.exit("Error: No databases found") + + print(f"Backing up {len(databases)} database(s)\n") + + for db_name in databases: + sql_file = dump_database(db_name, config) + compress_backup(sql_file) + print() + + # Sync to remote if requested + if args.rclone: + sync_to_remote(args.rclone, config['backup_dir']) + + # Cleanup old backups if requested + if args.cleanup: + cleanup_old_backups(config['backup_dir']) + + print("Done!") + return 0 + + +if __name__ == '__main__': + sys.exit(main()) diff --git a/init-db.sh b/bin/init-db.sh similarity index 65% rename from init-db.sh rename to bin/init-db.sh index e5ffe91..190eaf0 100755 --- a/init-db.sh +++ b/bin/init-db.sh @@ -1,4 +1,19 @@ #!/bin/bash +# Copyright (C) 2020-2026 Wicked Co-op LCA +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + source ./.env #printenv | grep POSTGRES diff --git a/docker-compose.yml b/docker-compose.yml index 32e6cad..371f693 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -255,6 +255,18 @@ services: networks: - sr-network + sr-next: + container_name: sr-next + restart: unless-stopped + image: sr-next:${VERSION} + ports: + - "3000:3000" + depends_on: + - orchestrator + networks: + - sr-network + + volumes: postgres_data: driver: local diff --git a/modules/ORCHESTRATOR b/modules/ORCHESTRATOR index 9596a80..587f35f 160000 --- a/modules/ORCHESTRATOR +++ b/modules/ORCHESTRATOR @@ -1 +1 @@ -Subproject commit 9596a808c51e800316700dccd1114832048a4ab6 +Subproject commit 587f35f395259bf7f0fbf2515dc083c35a070d0e diff --git a/modules/RS-CONNECTIONS b/modules/RS-CONNECTIONS index 94bd8bb..439576f 160000 --- a/modules/RS-CONNECTIONS +++ b/modules/RS-CONNECTIONS @@ -1 +1 @@ -Subproject commit 94bd8bbe5afa620281babfb8c8e2a516014f4795 +Subproject commit 439576fde1ba89a9e3354926af532730e4e4d956 diff --git a/modules/RS-GROUPS b/modules/RS-GROUPS index 0d696fd..28b26a3 160000 --- a/modules/RS-GROUPS +++ b/modules/RS-GROUPS @@ -1 +1 @@ -Subproject commit 0d696fd243f76a75afbb03cf8334cf839f3cefd6 +Subproject commit 28b26a3df086f164afdefee51f4cf481272b3463 diff --git a/modules/RS-NOTES b/modules/RS-NOTES index 3acc779..17ef5a7 160000 --- a/modules/RS-NOTES +++ b/modules/RS-NOTES @@ -1 +1 @@ -Subproject commit 3acc779a3c044a7396c65ae3f2ffb8181c1422db +Subproject commit 17ef5a7aee97556115beeaa14ba3648c55ba0611 diff --git a/modules/RS-NOTIFICATIONS b/modules/RS-NOTIFICATIONS index 4a61173..ff906cc 160000 --- a/modules/RS-NOTIFICATIONS +++ b/modules/RS-NOTIFICATIONS @@ -1 +1 @@ -Subproject commit 4a61173c4fd85e0e7b03e59a4a2978d5938686e1 +Subproject commit ff906cc12fa51e6ee04de47d991bd1a826e8d75a diff --git a/modules/RS-RESPONSES b/modules/RS-RESPONSES index 0898073..3f55ea3 160000 --- a/modules/RS-RESPONSES +++ b/modules/RS-RESPONSES @@ -1 +1 @@ -Subproject commit 089807368905c3adc58945693ea575e6ffa9008f +Subproject commit 3f55ea304712f27df063fcf1b311e899627a7edf diff --git a/modules/RS-USERS b/modules/RS-USERS index 3757158..99b6fe4 160000 --- a/modules/RS-USERS +++ b/modules/RS-USERS @@ -1 +1 @@ -Subproject commit 3757158a79801b5524d1e7aa15d8e9be2f953b7e +Subproject commit 99b6fe4089d62233db17d595c6d86180bac32159 diff --git a/modules/RS-UTILS b/modules/RS-UTILS index 4d8711c..cc55a91 160000 --- a/modules/RS-UTILS +++ b/modules/RS-UTILS @@ -1 +1 @@ -Subproject commit 4d8711c5fa1eacab853521a0d9097cba1ce672df +Subproject commit cc55a9108bcf9b48473968edb585a5c4f7d2b92d diff --git a/utils/README.md b/utils/README.md new file mode 100644 index 0000000..8c2b852 --- /dev/null +++ b/utils/README.md @@ -0,0 +1,33 @@ +# SocialRoots Utilities + +## Auto-start on Boot + +The `socialroots.service` file enables Docker Compose services to start automatically on system boot. + +### Install + +```bash +# Copy to systemd +sudo cp utils/socialroots.service /etc/systemd/system/ + +# Enable and start +sudo systemctl daemon-reload +sudo systemctl enable socialroots +sudo systemctl start socialroots +``` + +### Commands + +```bash +# Check status +sudo systemctl status socialroots + +# Stop services +sudo systemctl stop socialroots + +# Start services +sudo systemctl start socialroots + +# Disable auto-start +sudo systemctl disable socialroots +``` diff --git a/utils/bulk_create_summaries.sh b/utils/bulk_create_summaries.sh deleted file mode 100755 index 3f05fca..0000000 --- a/utils/bulk_create_summaries.sh +++ /dev/null @@ -1,408 +0,0 @@ -#!/bin/bash - -# Bulk Summary Notifications Creator -# Reads user_keys from a file and creates daily + weekly summary notifications for each user -# Usage: ./bulk_create_summaries.sh --file [options] - -# Don't use set -e - we handle errors explicitly -set -u # Exit on undefined variable - -# Colors for output -RED='\033[0;31m' -GREEN='\033[0;32m' -YELLOW='\033[1;33m' -BLUE='\033[0;34m' -NC='\033[0m' # No Color - -# Default values -DEFAULT_DAILY_FREQUENCY=1440 # 24 hours in minutes -DEFAULT_WEEKLY_FREQUENCY=10080 # 7 days in minutes -DEFAULT_TIME="01:00:00 PST" # 1 AM PST - -# Print colored message -print_info() { - echo -e "${BLUE}[INFO]${NC} $1" -} - -print_success() { - echo -e "${GREEN}[SUCCESS]${NC} $1" -} - -print_error() { - echo -e "${RED}[ERROR]${NC} $1" -} - -print_warning() { - echo -e "${YELLOW}[WARNING]${NC} $1" -} - -# Show usage -show_usage() { - cat << EOF -Usage: $0 --file --endpoint --start-date --daily-status --weekly-status [options] - -Required Arguments: - --file Path to file containing user_keys (one per line) - --endpoint API endpoint URL (e.g., http://localhost:2100) - --start-date Start date (format: YYYY-MM-DD) - --daily-status Initial status for daily summaries (active/inactive) - --weekly-status Initial status for weekly summaries (active/inactive) - -Optional Arguments: - --test-mode Enable test mode (uses test database tables) - --help Show this help message - -Defaults: - Daily frequency: $DEFAULT_DAILY_FREQUENCY minutes (24 hours) - Weekly frequency: $DEFAULT_WEEKLY_FREQUENCY minutes (7 days) - Start time: $DEFAULT_TIME (PST) - -Examples: - # Basic usage - creates both daily and weekly summaries for all users - $0 \\ - --file user_keys.txt \\ - --endpoint http://localhost:2100 \\ - --start-date 2025-01-20 \\ - --daily-status inactive \\ - --weekly-status active - - # With test mode enabled - $0 \\ - --file user_keys.txt \\ - --endpoint http://localhost:2100 \\ - --start-date 2025-01-20 \\ - --daily-status active \\ - --weekly-status active \\ - --test-mode - -File Format: - One user_key per line. Lines starting with # are treated as comments. - - Example user_keys.txt: - # Production users - user-abc-123 - user-def-456 - user-ghi-789 - -Notes: - - Creates BOTH daily and weekly summaries for each user - - Daily summaries: Every 24 hours ($DEFAULT_DAILY_FREQUENCY minutes) - - Weekly summaries: Every 7 days ($DEFAULT_WEEKLY_FREQUENCY minutes) - - Start time defaults to 1:00 AM PST ($DEFAULT_TIME) - -EOF - exit 0 -} - -# Initialize variables -USER_KEYS_FILE="" -API_ENDPOINT="" -START_DATE="" -DAILY_STATUS="" -WEEKLY_STATUS="" -TEST_MODE=false - -# Parse command line arguments -while [[ $# -gt 0 ]]; do - case $1 in - --file) - USER_KEYS_FILE="$2" - shift 2 - ;; - --endpoint) - API_ENDPOINT="$2" - shift 2 - ;; - --start-date) - START_DATE="$2" - shift 2 - ;; - --daily-status) - DAILY_STATUS="$2" - shift 2 - ;; - --weekly-status) - WEEKLY_STATUS="$2" - shift 2 - ;; - --test-mode) - TEST_MODE=true - shift - ;; - --help) - show_usage - ;; - *) - print_error "Unknown option: $1" - echo "Use --help for usage information" - exit 1 - ;; - esac -done - -# Validate required arguments -MISSING_ARGS=() - -if [ -z "$USER_KEYS_FILE" ]; then - MISSING_ARGS+=("--file") -fi -if [ -z "$API_ENDPOINT" ]; then - MISSING_ARGS+=("--endpoint") -fi -if [ -z "$START_DATE" ]; then - MISSING_ARGS+=("--start-date") -fi -if [ -z "$DAILY_STATUS" ]; then - MISSING_ARGS+=("--daily-status") -fi -if [ -z "$WEEKLY_STATUS" ]; then - MISSING_ARGS+=("--weekly-status") -fi - -if [ ${#MISSING_ARGS[@]} -gt 0 ]; then - print_error "Missing required arguments: ${MISSING_ARGS[*]}" - echo "" - echo "Use --help for usage information" - exit 1 -fi - -# Validate file exists -if [ ! -f "$USER_KEYS_FILE" ]; then - print_error "File not found: $USER_KEYS_FILE" - exit 1 -fi - -# Validate status values -if [[ ! "$DAILY_STATUS" =~ ^(active|inactive)$ ]]; then - print_error "Invalid --daily-status: $DAILY_STATUS (must be 'active' or 'inactive')" - exit 1 -fi - -if [[ ! "$WEEKLY_STATUS" =~ ^(active|inactive)$ ]]; then - print_error "Invalid --weekly-status: $WEEKLY_STATUS (must be 'active' or 'inactive')" - exit 1 -fi - -# Validate date format (YYYY-MM-DD) -if [[ ! "$START_DATE" =~ ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ ]]; then - print_error "Invalid date format: $START_DATE (must be YYYY-MM-DD)" - exit 1 -fi - -# Build full datetime string in required format: "2006-01-02 15:04:05 MST" -START_UPDATE="$START_DATE $DEFAULT_TIME" - -# Count lines in file (excluding empty and comment lines) -TOTAL_USERS=$(grep -v '^[[:space:]]*$' "$USER_KEYS_FILE" | grep -v '^[[:space:]]*#' | wc -l | tr -d ' ') -if [ "$TOTAL_USERS" -eq 0 ]; then - print_error "No valid user keys found in: $USER_KEYS_FILE" - exit 1 -fi - -# Display configuration -echo "==========================================" -echo " Bulk Summary Notification Configuration" -echo "==========================================" -echo "File: $USER_KEYS_FILE" -echo "Total Users: $TOTAL_USERS" -echo "Endpoint: $API_ENDPOINT" -echo "" -echo "Daily Summaries:" -echo " Frequency: $DEFAULT_DAILY_FREQUENCY minutes (24 hours)" -echo " Status: $DAILY_STATUS" -echo "" -echo "Weekly Summaries:" -echo " Frequency: $DEFAULT_WEEKLY_FREQUENCY minutes (7 days)" -echo " Status: $WEEKLY_STATUS" -echo "" -echo "Start Date/Time: $START_UPDATE" -echo "Test Mode: $TEST_MODE" -echo "==========================================" -echo "" -echo "This will create 2 summaries per user (daily + weekly)" -echo "Total summaries to create: $((TOTAL_USERS * 2))" -echo "" - -read -p "Proceed with bulk creation? [y/N]: " CONFIRM -if [[ ! "$CONFIRM" =~ ^[Yy]$ ]]; then - print_warning "Operation cancelled by user" - exit 0 -fi - -echo "" -print_info "Starting bulk creation..." -echo "" - -# Counters -DAILY_SUCCESS=0 -DAILY_ERROR=0 -DAILY_SKIPPED=0 -WEEKLY_SUCCESS=0 -WEEKLY_ERROR=0 -WEEKLY_SKIPPED=0 - -# Create log file immediately -LOG_FILE="bulk_summary_$(date +%Y%m%d_%H%M%S).log" -touch "$LOG_FILE" || { - print_error "Failed to create log file: $LOG_FILE" - exit 1 -} -print_info "Logging to: $LOG_FILE" -echo "=== Bulk Summary Creation Log ===" > "$LOG_FILE" -echo "Started: $(date)" >> "$LOG_FILE" -echo "File: $USER_KEYS_FILE" >> "$LOG_FILE" -echo "Endpoint: $API_ENDPOINT" >> "$LOG_FILE" -echo "" >> "$LOG_FILE" -echo "" - -# Function to create summary -create_summary() { - local USER_KEY=$1 - local FREQUENCY=$2 - local TEMPLATE=$3 - local STATUS=$4 - local SUMMARY_TYPE=$5 # "Daily" or "Weekly" for display - - # Build JSON payload - local JSON_PAYLOAD=$(cat <&1) - else - RESPONSE=$(curl -s -w "\nHTTP_CODE:%{http_code}" -X POST "$API_ENDPOINT/notifications/summary/new" \ - -H "Content-Type: application/json" \ - -d "$JSON_PAYLOAD" 2>&1) - fi - - # Extract HTTP code - local HTTP_CODE=$(echo "$RESPONSE" | grep "HTTP_CODE:" | cut -d: -f2) - local RESPONSE_BODY=$(echo "$RESPONSE" | sed '/HTTP_CODE:/d') - - # Log full response - echo "[$SUMMARY_TYPE] User: $USER_KEY | HTTP: $HTTP_CODE | Response: $RESPONSE_BODY" >> "$LOG_FILE" - - # Return status: 0=success, 1=error, 2=skipped - if [ "$HTTP_CODE" == "200" ]; then - return 0 - elif echo "$RESPONSE_BODY" | grep -q "id"; then - # Already exists (InsertSummary returns existing ID if user+template combo exists) - return 2 - else - return 1 - fi -} - -# Process each user key -LINE_NUM=0 -PROCESSED=0 - -print_info "DEBUG: Starting to read file: $USER_KEYS_FILE" -echo "DEBUG: Starting to read file" >> "$LOG_FILE" - -while IFS= read -r USER_KEY || [ -n "$USER_KEY" ]; do - LINE_NUM=$((LINE_NUM + 1)) - - echo "DEBUG: Read line $LINE_NUM: '$USER_KEY'" >> "$LOG_FILE" - - # Skip empty lines and lines starting with # - if [ -z "$USER_KEY" ] || [[ "$USER_KEY" =~ ^[[:space:]]*# ]]; then - echo "DEBUG: Skipping line $LINE_NUM (empty or comment)" >> "$LOG_FILE" - continue - fi - - # Trim whitespace - USER_KEY=$(echo "$USER_KEY" | xargs) - echo "DEBUG: Trimmed user_key: '$USER_KEY'" >> "$LOG_FILE" - - PROCESSED=$((PROCESSED + 1)) - - print_info "[$PROCESSED/$TOTAL_USERS] Processing user: $USER_KEY" - echo "=== Processing user $PROCESSED/$TOTAL_USERS: $USER_KEY ===" >> "$LOG_FILE" - - # Create DAILY summary - print_info " Creating daily summary..." - create_summary "$USER_KEY" "$DEFAULT_DAILY_FREQUENCY" "daily" "$DAILY_STATUS" "Daily" || true - DAILY_RESULT=$? - - case $DAILY_RESULT in - 0) - print_success " ✓ Daily summary created (status: $DAILY_STATUS)" - DAILY_SUCCESS=$((DAILY_SUCCESS + 1)) - ;; - 2) - print_warning " ⚠ Daily summary already exists" - DAILY_SKIPPED=$((DAILY_SKIPPED + 1)) - ;; - *) - print_error " ✗ Daily summary failed (exit code: $DAILY_RESULT)" - DAILY_ERROR=$((DAILY_ERROR + 1)) - ;; - esac - - # Create WEEKLY summary - print_info " Creating weekly summary..." - create_summary "$USER_KEY" "$DEFAULT_WEEKLY_FREQUENCY" "weekly" "$WEEKLY_STATUS" "Weekly" || true - WEEKLY_RESULT=$? - - case $WEEKLY_RESULT in - 0) - print_success " ✓ Weekly summary created (status: $WEEKLY_STATUS)" - WEEKLY_SUCCESS=$((WEEKLY_SUCCESS + 1)) - ;; - 2) - print_warning " ⚠ Weekly summary already exists" - WEEKLY_SKIPPED=$((WEEKLY_SKIPPED + 1)) - ;; - *) - print_error " ✗ Weekly summary failed (exit code: $WEEKLY_RESULT)" - WEEKLY_ERROR=$((WEEKLY_ERROR + 1)) - ;; - esac - - # Small delay to avoid overwhelming the service - sleep 0.1 - -done < "$USER_KEYS_FILE" - -# Summary -echo "" -echo "==========================================" -echo " Bulk Creation Summary" -echo "==========================================" -echo "Total Users Processed: $PROCESSED" -echo "" -echo "Daily Summaries ($DEFAULT_DAILY_FREQUENCY min):" -echo " Successful: $DAILY_SUCCESS" -echo " Skipped: $DAILY_SKIPPED" -echo " Errors: $DAILY_ERROR" -echo "" -echo "Weekly Summaries ($DEFAULT_WEEKLY_FREQUENCY min):" -echo " Successful: $WEEKLY_SUCCESS" -echo " Skipped: $WEEKLY_SKIPPED" -echo " Errors: $WEEKLY_ERROR" -echo "==========================================" -echo "" -print_info "Full log saved to: $LOG_FILE" - -TOTAL_ERRORS=$((DAILY_ERROR + WEEKLY_ERROR)) -if [ $TOTAL_ERRORS -gt 0 ]; then - print_warning "Some operations failed. Check log file for details." - exit 1 -else - print_success "All operations completed successfully!" - exit 0 -fi diff --git a/utils/checkout_modules.sh b/utils/checkout_modules.sh deleted file mode 100644 index 039b802..0000000 --- a/utils/checkout_modules.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/bash -MODULES_PATH=$(ls -d ../modules/*) -for module in $MODULES_PATH -do - git -C "$module" checkout sr-server-init -done \ No newline at end of file diff --git a/utils/socialroots.service b/utils/socialroots.service new file mode 100644 index 0000000..35f64ec --- /dev/null +++ b/utils/socialroots.service @@ -0,0 +1,14 @@ +[Unit] +Description=SocialRoots Services +Requires=docker.service +After=docker.service + +[Service] +Type=oneshot +RemainAfterExit=yes +WorkingDirectory=/media/DATA/WORKSPACE/SOCIAL_ROOTS/sr-server +ExecStart=/usr/bin/docker compose --env-file .env up -d +ExecStop=/usr/bin/docker compose --env-file .env down + +[Install] +WantedBy=multi-user.target