feat(storage): added a central storage management system

Reviewed-on: trinitrix/core#23

.cargo/config.toml

@@ -1,3 +1,22 @@
+# Copyright (C) 2024 - 2024:
+# The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Trinitrix.
+#
+# Trinitrix 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 <https://www.gnu.org/licenses/>.
+
 # [target.x86_64-unknown-linux-gnu]
 # rustflags = ["-C", "link-arg=-fuse-ld=mold"]
 

.envrc

@@ -1,6 +1,29 @@
+# Copyright (C) 2024 - 2024:
+# The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Trinitrix.
+#
+# Trinitrix 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 <https://www.gnu.org/licenses/>.
+
 use flake || use nix
 watch_file flake.nix
 
+PATH_add ./target/debug
+PATH_add ./target/release
+PATH_add ./scripts
+
 if on_git_branch; then
   echo && git status --short --branch &&
   echo && git fetch --verbose

.gitignore

@@ -1,13 +1,41 @@
+# Copyright (C) 2024 - 2024:
+# The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Trinitrix.
+#
+# Trinitrix 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 <https://www.gnu.org/licenses/>.
+
 userdata/
 trinitrix.log
+plugin.txt
 
 # build
 /target
 /result
+# generate by trixy for the c headers
+/dist
 
 # IDE stuff
 .idea
 .direnv
 
-# Lua LS stuff
+# Pre Commit hooks
+.pre-commit-config.yaml
+
+# LS
+## lua
 .luarc.json
+## c
+.ccls-cache

.licensure.yml

@@ -0,0 +1,201 @@
+# Copyright (C) 2024 - 2024:
+# The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Trinitrix.
+#
+# Trinitrix 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 <https://www.gnu.org/licenses/>.
+
+---
+# Regexes which if matched by a file path will always be excluded from
+# getting a license header
+excludes:
+  - .*lock
+  - \.git/.*
+  - LICENSE.spdx
+  - LICENSE
+  - COPYING
+  - COPYING.LESSER
+  - .*\.(rst|txt|pdf|png)
+# Definition of the licenses used on this project and to what files
+# they should apply.
+#
+# No default license configuration is provided. This section must be
+# configured by the user.
+licenses:
+  # Either a regex or the string "any" to determine to what files this
+  # license should apply. It is common for projects to have files
+  # under multiple licenses or with multiple copyright holders. This
+  # provides the ability to automatically license files correctly
+  # based on their file paths.
+  #
+  # If "any" is provided all files will match this license.
+  - files: any
+    #
+    #   The license identifier, a list of common identifiers can be
+    #   found at: https://spdx.org/licenses/ but existence of the ident
+    #   in this list it is not enforced unless auto_template is set to
+    #   true.
+    ident: GPL-3.0-or-later
+    #
+    #   A list of authors who hold copyright over these files
+    authors:
+      - name: "The Trinitrix Project"
+        email: "benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li"
+
+    #   The template that will be rendered to generate the header before
+    #   comment characters are applied. Available variables are:
+    #    - [year]: substituted with the current year.
+    #    - [name of author]: Substituted with name of the author and email
+    #      if provided. If email is provided the output appears as Full
+    #      Name <email@example.com>. If multiple authors are provided the
+    #      list is concatenated together with commas.
+    template: |
+        Copyright (C) 2024 - [year]:
+        [name of author]
+        SPDX-License-Identifier: GPL-3.0-or-later
+
+        This file is part of Trinitrix.
+
+        Trinitrix 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 <https://www.gnu.org/licenses/>.
+    #   If auto_template is true then template is ignored and the SPDX
+    #   API will be queried with the ident value to automatically
+    #   determine the license header template. auto_template works best
+    #   with licenses that have a standardLicenseHeader field defined in
+    #   their license info JSON, if it is not then we will use the full
+    #   licenseText to generate the header which works fine for short
+    #   licenses like MIT but can be quite lengthy for other licenses
+    #   like BSD-4-Clause. The above default template is valid for most
+    #   licenses and is recommended for MIT, and BSD licenses. Common
+    #   licenses that work well with the auto_template feature are GPL
+    #   variants, and the Apache 2.0 license.
+    #
+    #   Important Note: this means the ident must be a valid SPDX identifier
+    # auto_template: true
+
+    #   If true try to detect the text wrapping of the template, and unwrap it
+    unwrap_text: false
+
+# Define type of comment characters to apply based on file extensions.
+comments:
+  # The extensions (or singular extension) field defines which file
+  # extensions to apply the commenter to.
+  - extensions:
+      - js
+      - go
+      - pest
+    # The commenter field defines the kind of commenter to
+    # generate. There are two types of commenters: line and block.
+    #
+    # This demonstrates a line commenter configuration. A line
+    # commenter type will apply the comment_char to the beginning of
+    # each line in the license header. It will then apply a number of
+    # empty newlines to the end of the header equal to trailing_lines.
+    #
+    # If trailing_lines is omitted it is assumed to be 0.
+    commenter:
+      type: line
+      comment_char: "//"
+      trailing_lines: 1
+
+  - extensions:
+      - lua
+    # The commenter field defines the kind of commenter to
+    # generate. There are two types of commenters: line and block.
+    #
+    # This demonstrates a line commenter configuration. A line
+    # commenter type will apply the comment_char to the beginning of
+    # each line in the license header. It will then apply a number of
+    # empty newlines to the end of the header equal to trailing_lines.
+    #
+    # If trailing_lines is omitted it is assumed to be 0.
+    commenter:
+      type: line
+      comment_char: "--"
+      trailing_lines: 1
+
+  - extensions:
+      - rs
+      - tri
+      - css
+      - cpp
+      - c
+      - h
+    # This demonstrates a block commenter configuration. A block
+    # commenter type will add start_block_char as the first character
+    # in the license header and add end_block_char as the last character
+    # in the license header. If per_line_char is provided each line of
+    # the header between the block start and end characters will be
+    # line commented with the per_line_char
+    #
+    # trailing_lines works the same for both block and line commenter
+    # types
+    commenter:
+      type: block
+      start_block_char: "/*\n"
+      end_block_char: "*/\n"
+      per_line_char: "*"
+      trailing_lines: 1
+
+  - extension:
+      - html
+      - md
+      - svg
+      - drawio
+    commenter:
+      type: block
+      start_block_char: "<!--\n"
+      end_block_char: "-->\n"
+      trailing_lines: 1
+
+  - extensions:
+      - el
+      - lisp
+    commenter:
+      type: line
+      comment_char: ";;;"
+      trailing_lines: 1
+
+  - extensions:
+      - tex
+      - bib
+    commenter:
+      type: line
+      comment_char: "%"
+      trailing_lines: 1
+
+  # The extension string "any" is special and so will match any file
+  # extensions. Commenter configurations are always checked in the
+  # order they are defined, so if any is used it should be the last
+  # commenter configuration or else it will override all others.
+  #
+  # In this configuration if we can't match the file extension we fall
+  # back to the popular '#' line comment used in most scripting
+  # languages.
+  - extension: any
+    commenter:
+      type: line
+      comment_char: '#'
+      trailing_lines: 1

COPYING

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ 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.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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 <https://www.gnu.org/licenses/>.
+
+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:
+
+    <program>  Copyright (C) <year>  <name of author>
+    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
+<https://www.gnu.org/licenses/>.
+
+  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
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

Cargo.toml

@@ -1,43 +1,77 @@
+# Copyright (C) 2024 - 2024:
+# The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Trinitrix.
+#
+# Trinitrix 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 <https://www.gnu.org/licenses/>.
+
 [package]
 name = "trinitrix"
+description = "A multi protocol chat client"
 version = "0.1.0"
 edition = "2021"
-license = "MIT"
+license = "GPL-3.0-or-later"
 default-run = "trinitrix"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
-[features]
-default = ["tui"]
-tui = ["dep:tui", "dep:tui-textarea", "dep:crossterm", "dep:tokio-util", "dep:serde", "dep:indexmap"]
-
 [dependencies]
 clap = { version = "4.5.4", features = ["derive"] }
 cli-log = "2.0"
 anyhow = "1.0"
-matrix-sdk = "0.6"
+tokio = { version = "1.37", features = [
-tokio = { version = "1.37", features = ["macros", "rt-multi-thread"] }
+    "macros",
+    "rt-multi-thread",
+    "fs",
+    "time",
+    "io-util"
+] }
+tokio-util = { version = "0.7.10" }
+uuid = { version = "1.8.0", features = ["v4"] }
+rand = "0.8.5"
+serde = { version = "1.0.201", features = ["derive"] }
+rmp-serde = "1.3.0"
+strum = { version = "0.26.2", features = ["derive"] }
+sqlx = { version = "0.7.4", features = ["sqlite"] }
 
 # config
-trinitry = {version = "0.1.0"}
+trinitry = { version = "0.1.0" }
-keymaps = {version = "0.1.1", features = ["crossterm"] }
+keymaps = { version = "0.1.1", features = ["crossterm"] }
+directories = "5.0.1"
+
+# crypto
+x25519-dalek = "2.0.1"
+aes-gcm-siv = { version = "0.11.1", features = ["aes"] }
 
 # c api
 libloading = "0.8.3"
-trixy = {version = "0.1.1"}
+trixy = { version = "0.1.1" }
 
 # lua stuff
 mlua = { version = "0.9.7", features = ["lua54", "async", "send", "serialize"] }
 once_cell = "1.19.0"
 
 # tui feature specific parts
-tui = {version = "0.19", optional = true}
+ratatui = "0.26.2"
-tui-textarea = { version = "0.2", features = ["crossterm"], optional = true }
+tui-textarea = { version = "0.4", features = ["crossterm"] }
-crossterm = { version = "0.25", optional = true }
+crossterm = { version = "0.25" }
-tokio-util = { version = "0.7", optional = true }
+
-serde = { version = "1.0", optional = true }
+# Trinitrx Backend API specific
-indexmap = { version = "2.2.6", optional = true }
+interprocess = { version = "2.1.0", features = ["tokio"] }
-directories = "5.0.1"
+triba-packet = { path = "../triba-packet" }
+triba = { path = "../triba" }
 
 [dev-dependencies]
 pretty_assertions = "1.4.0"

LICENSE

@@ -1,20 +0,0 @@
-Copyright 2023 The Trinitrix Project <antifallobst@systemausfall.org>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the “Software”), to deal in
-the Software without restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
-Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.

LICENSE.spdx

@@ -0,0 +1,7 @@
+SPDXVersion: SPDX-2.3
+DataLicense: CC0-1.0
+Creator: flake template init
+PackageName: trinitrix
+PackageOriginator: The Trinitrix Project
+PackageHomePage: https://git.nerdcult.net/trinitrix/core
+PackageLicenseDeclared: GPL-3.0-or-later

README.md

@@ -1,27 +1,38 @@
+<!--
+Copyright (C) 2024 - 2024:
+The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+SPDX-License-Identifier: GPL-3.0-or-later
+
+This file is part of Trinitrix.
+
+Trinitrix 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 <https://www.gnu.org/licenses/>.
+-->
+
 # Trinitrix
+
 Trinitrix is a terminal UI client for the matrix chat protocol.
 Docs can be found [here](https://git.nerdcult.net/antifallobst/trinitrix/src/branch/master/docs).
 
----
+______________________________________________________________________
 
-# License (MIT)
+# License (GPL-3.0 or later)
-Copyright 2023 The Trinitrix Project <antifallobst@systemausfall.org>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of
+Copyright 2024 The Trinitrix Project \<antifallobst@systemausfall.org,
-this software and associated documentation files (the “Software”), to deal in
+benedikt.peetz@b-peetz.de, sils@sils.li>
-the Software without restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
-Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
+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.
-copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+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.
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.

branding/README.md

@@ -1,2 +1,24 @@
+<!--
+Copyright (C) 2024 - 2024:
+The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+SPDX-License-Identifier: GPL-3.0-or-later
+
+This file is part of Trinitrix.
+
+Trinitrix 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 <https://www.gnu.org/licenses/>.
+-->
+
 # License
+
 The [square Trinitrix Logo](./square.svg) by Eric-Paul Ickhorn is marked with the CC0 1.0 Universal License.

branding/round.svg

@@ -1,3 +1,24 @@
+<!--
+Copyright (C) 2024 - 2024:
+The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+SPDX-License-Identifier: GPL-3.0-or-later
+
+This file is part of Trinitrix.
+
+Trinitrix 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 <https://www.gnu.org/licenses/>.
+-->
+
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!-- Created with Inkscape (http://www.inkscape.org/) -->
 

branding/square.svg

@@ -1,3 +1,24 @@
+<!--
+Copyright (C) 2024 - 2024:
+The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+SPDX-License-Identifier: GPL-3.0-or-later
+
+This file is part of Trinitrix.
+
+Trinitrix 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 <https://www.gnu.org/licenses/>.
+-->
+
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!-- Created with Inkscape (http://www.inkscape.org/) -->
 

build.rs

@@ -0,0 +1,33 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
+use trixy::macros::config::trixy::TrixyConfig;
+
+fn main() {
+    println!("cargo:rerun-if-changed=./dist/*");
+    println!("cargo:rerun-if-changed=./src/app/command_interface/command_list/api.tri");
+    let file_tree = TrixyConfig::new("handle_cmd")
+        .trixy_path("./src/app/command_interface/command_list/api.tri")
+        .dist_dir_path("./dist")
+        .generate();
+
+    file_tree.materialize().unwrap();
+}

cog.toml

@@ -0,0 +1,44 @@
+# Copyright (C) 2024 - 2024:
+# The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Trinitrix.
+#
+# Trinitrix 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 <https://www.gnu.org/licenses/>.
+
+tag_prefix = "v"
+branch_whitelist = ["main"]
+ignore_merge_commits = false
+
+pre_bump_hooks = [
+  "nix flake check",                     # verify the project builds
+  "./scripts/renew_copyright_header.sh", # update the license header in each file
+  "cargo set-version {{version}}",       # bump version in Cargo.toml
+  "nix fmt",                             # format
+]
+post_bump_hooks = [
+  "git push",
+  "cargo publish",
+  "git push origin v{{version}}", # push the new tag to origin
+]
+
+[bump_profiles]
+
+[changelog]
+path = "NEWS.md"
+template = "remote"
+remote = "git.nerdcult.net"
+repository = "core"
+owner = "trinitrix"
+authors = [{ signature = "The Trinitrix Project", username = "trinitrix" }]

config/c/plugin.c

@@ -0,0 +1,141 @@
+/*
+ * Copyright (C) 2024 - 2024:
+ * The Trinitrix Project <benedikt.peetz@b-peetz.de,
+ * antifallobst@systemausfall.org, sils@sils.li> SPDX-License-Identifier:
+ * GPL-3.0-or-later
+ *
+ * This file is part of Trinitrix.
+ *
+ * Trinitrix 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 <https://www.gnu.org/licenses/>.
+ */
+
+#include "../../dist/interface.h"
+#include <assert.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#define println(args...)                                                      \
+  fprintf (log_file, "\33[32;1m(plugin):\33[0m \33[34;1m");                   \
+  fprintf (log_file, args);                                                   \
+  fprintf (log_file, "\n\33[0m");                                             \
+  fflush (log_file);
+
+#define eprintln(args...)                                                     \
+  fprintf (log_file, "\33[32;1m(plugin):\33[0m\33[31;1m ");                   \
+  fprintf (log_file, args);                                                   \
+  fprintf (log_file, "\n\33[0m");                                             \
+  fflush (log_file);
+
+int is_first_log_file_open = 1;
+FILE *
+get_log_file ()
+{
+  FILE *log_file;
+
+  if (is_first_log_file_open)
+    {
+      is_first_log_file_open = 0;
+      log_file = fopen ("plugin.txt", "w");
+    }
+  else
+    {
+      log_file = fopen ("plugin.txt", "wa");
+    }
+
+  if (log_file == NULL)
+    {
+      printf ("Error opening file!\n");
+      exit (1);
+    }
+
+  return log_file;
+}
+
+void
+handle_error ()
+{
+  FILE *log_file = get_log_file ();
+  eprintln ("GOT an error");
+
+  int error_length = last_error_length ();
+  char *error = malloc (error_length);
+  last_error_message (error, error_length);
+  eprintln ("Encountered error: %s", error);
+  free (error);
+}
+
+void
+set_normal_mode ()
+{
+  if (!trinitrix.api.ui.set_mode (Normal))
+    handle_error ();
+}
+void
+set_command_mode ()
+{
+  if (!trinitrix.api.ui.set_mode (Command))
+    handle_error ();
+}
+void
+set_insert_mode ()
+{
+  if (!trinitrix.api.ui.set_mode (Insert))
+    handle_error ();
+}
+void
+print_hi ()
+{
+  if (!trinitrix.api.raw.raise_error ("hi!"))
+    handle_error ();
+}
+void
+print_warning ()
+{
+  if (!trinitrix.api.raw.raise_error (
+          "To exit trinitrix use 'trinitrix.api.exit()' instead!"))
+    handle_error ();
+}
+
+int
+plugin_main ()
+{
+  FILE *log_file = get_log_file ();
+
+  println ("Hi, setting first keymap!");
+  if (!trinitrix.api.keymaps.add ("ci", "<ESC>", set_normal_mode))
+    handle_error ();
+  println ("Done setting that keymap");
+
+  if (!trinitrix.api.keymaps.add ("n", ":", set_command_mode))
+    handle_error ();
+
+  trinitrix.api.keymaps.add ("n", "i", set_insert_mode);
+  trinitrix.api.keymaps.add ("n", "<TAB>", trinitrix.api.ui.cycle_planes);
+
+  // a simple test to prove that key chords work
+  trinitrix.api.keymaps.add ("ni", "jj", print_hi);
+
+  trinitrix.api.keymaps.add ("n", "q", trinitrix.api.exit);
+
+  // Help people
+  trinitrix.api.keymaps.add ("n", "<C-c>", print_warning);
+
+  // workaround to avoid c de-allocating our nice strings
+  while (1)
+    {
+    };
+
+  return EXIT_SUCCESS;
+}

config/lua/init.lua

@@ -1,5 +1,26 @@
+-- Copyright (C) 2024 - 2024:
+-- The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+-- SPDX-License-Identifier: GPL-3.0-or-later
+--
+-- This file is part of Trinitrix.
+--
+-- Trinitrix 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 <https://www.gnu.org/licenses/>.
+
+-- FIXME(@soispha): The code here has been deprecated, update it when trixy supports lua <2024-05-03>
+
 -- create the required tables under `std`
-trinitrix.std = { keymaps = {} };
+trinitrix.std = { keymaps = {} }
 
 --- Add a new keymap. This is just a convenience function which registers the function
 --- and at the same time deals with the fact that the whole trinitrix api is async.
@@ -7,17 +28,15 @@ trinitrix.std = { keymaps = {} };
 ---@param key string
 ---@param callback function
 trinitrix.std.keymaps.add = function(mode, key, callback)
-    local callback_key = trinitrix.api.register_function(function()
+	local callback_key = trinitrix.api.register_function(function()
-        local co = coroutine.create(callback)
+		local co = coroutine.create(callback)
-        while coroutine.status(co) ~= "dead" do
+		while coroutine.status(co) ~= "dead" do
-            coroutine.resume(co)
+			coroutine.resume(co)
-        end
+		end
-    end)
+	end)
-    trinitrix.api.keymaps.add(mode, key, callback_key)
+	trinitrix.api.keymaps.add(mode, key, callback_key)
 end
 
-
-
 trinitrix.std.keymaps.add("ci", "<ESC>", trinitrix.api.ui.set_mode_normal)
 
 trinitrix.std.keymaps.add("n", ":", trinitrix.api.ui.command_line_show)
@@ -25,10 +44,13 @@ trinitrix.std.keymaps.add("n", "i", trinitrix.api.ui.set_mode_insert)
 trinitrix.std.keymaps.add("n", "<TAB>", trinitrix.api.ui.cycle_planes)
 
 -- a simple test to prove that key chords work
-trinitrix.std.keymaps.add("ni", "jj", function() print("hi") end)
+trinitrix.std.keymaps.add("ni", "jj", function()
+	print("hi")
+end)
 
 trinitrix.std.keymaps.add("n", "q", trinitrix.api.exit)
 
-
 -- Help people
-trinitrix.std.keymaps.add("n", "<C-c>", function() print("To exit trinitrix use 'trinitrix.api.exit()' instead!") end)
+trinitrix.std.keymaps.add("n", "<C-c>", function()
+	print("To exit trinitrix use 'trinitrix.api.exit()' instead!")
+end)

docs/CommandLine.md

@@ -1,7 +1,30 @@
+<!--
+Copyright (C) 2024 - 2024:
+The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+SPDX-License-Identifier: GPL-3.0-or-later
+
+This file is part of Trinitrix.
+
+Trinitrix 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 <https://www.gnu.org/licenses/>.
+-->
+
 # Command Line
+
 Trinitrix has a command line, which you can use to control and navigate the app.
 You can activate it with the `CommandLineShow` command, which is mapped to `<Ctrl>+c` by default.
 
 ## Syntax (LUA)
+
 The command line uses [lua](https://www.lua.org/about.html) and provides a builtin function for every internal command.
-The function names are the snake case variants of the command names.
+The function names are the snake case variants of the command names.

docs/Commands.md

@@ -1,4 +1,26 @@
+<!--
+Copyright (C) 2024 - 2024:
+The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+SPDX-License-Identifier: GPL-3.0-or-later
+
+This file is part of Trinitrix.
+
+Trinitrix 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 <https://www.gnu.org/licenses/>.
+-->
+
 # Commands
+
 Trinitrix relies heavily on the concept of commands.
 There is a command for every interaction with the application.
 By this, everything can use the same internal API, what makes the whole application extreme extensible and customizable.

docs/CommitMessageStyle.md

@@ -1,4 +1,26 @@
+<!--
+Copyright (C) 2024 - 2024:
+The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+SPDX-License-Identifier: GPL-3.0-or-later
+
+This file is part of Trinitrix.
+
+Trinitrix 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 <https://www.gnu.org/licenses/>.
+-->
+
 # Commit message style
+
 *This specification is heavily inspired by the [AngularJS commit message format](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format).*
 
 We have very precise rules over how our Git commit messages must be formatted.
@@ -6,7 +28,6 @@ This format leads to **easier to read commit history**.
 
 Each commit message consists of a **header**, a **body** (optional), and a **footer** (optional).
 
-
 ```
 <header>
 <BLANK LINE>
@@ -22,7 +43,6 @@ When the body is present it must be at least 20 characters long and must conform
 
 The `footer` is optional. The _Commit Message Footer format_ (described below) describes what the footer is used for and the structure it must have.
 
-
 ## Commit Message Header
 
 ```
@@ -37,29 +57,29 @@ The `footer` is optional. The _Commit Message Footer format_ (described below) d
 
 The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is optional.
 
-
 ### type
 
 Must be one of the following:
 
-* **Build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
+- **Build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
-* **Docs**: Documentation only changes
+- **Docs**: Documentation only changes
-* **Feat**: A new feature
+- **Feat**: A new feature
-* **Fix**: A bug fix
+- **Fix**: A bug fix
-* **Perf**: A code change that improves performance
+- **Perf**: A code change that improves performance
-* **Refactor**: A code change that neither fixes a bug nor adds a feature
+- **Refactor**: A code change that neither fixes a bug nor adds a feature
-* **Test**: Adding missing tests or correcting existing tests
+- **Test**: Adding missing tests or correcting existing tests
-* **Merge**: A merging commit
+- **Merge**: A merging commit
 
 ### Scope
+
 The scope should be the name of the module affected (as perceived by the person reading the changelog generated from commit messages).
 
 Specify submodules if needed!
 
 Example scopes:
 
-* `app::events`
+- `app::events`
-* `ui`
+- `ui`
 
 When a commit affects the whole tree, use `treewide`.
 
@@ -67,10 +87,9 @@ When a commit affects the whole tree, use `treewide`.
 
 Use the summary field to provide a succinct description of the change:
 
-* use the imperative, present tense: "change" not "changed" nor "changes"
+- use the imperative, present tense: "change" not "changed" nor "changes"
-* don't capitalize the first letter
+- don't capitalize the first letter
-* no dot (.) at the end
+- no dot (.) at the end
-
 
 ## Commit Message Body
 

docs/Config.md

@@ -1,3 +1,25 @@
+<!--
+Copyright (C) 2024 - 2024:
+The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+SPDX-License-Identifier: GPL-3.0-or-later
+
+This file is part of Trinitrix.
+
+Trinitrix 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 <https://www.gnu.org/licenses/>.
+-->
+
 # Config
+
 To configure trinitrix, you can add a file named `config.lua` to the userdata path.
-This file will be interpreted on startup with the same syntax as the Command Line.
+This file will be interpreted on startup with the same syntax as the Command Line.

docs/Philosophy.md

@@ -1,16 +1,40 @@
+<!--
+Copyright (C) 2024 - 2024:
+The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+SPDX-License-Identifier: GPL-3.0-or-later
+
+This file is part of Trinitrix.
+
+Trinitrix 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 <https://www.gnu.org/licenses/>.
+-->
+
 # Design Philosophy
 
 ## Customizability
+
 Trinitrix aims to be highly customizable.
 The command API provides a customizazion method, which can be used by an initial config script or live from the intern cli by the user.
 The command API should cover at least 90% of the possible configuration settings.
 
 ## Cross Platform
+
 Trinitrix is cross platform.
 Even if the targeted users are nerdy linux users xD.
 This can be easily achieved by using only cross platform libraries such as `crossterm` or `tui`.
 
 ## Future Proof / Extensible
+
 Modules and Interfaces should be designed in a way, that they're not limited to only use case.
 They should be open for every usecase, that makes sense.
 A good example is the command API, which is a unified way to interact with the application.

docs/TrinitrixBackendAPI.md

@@ -0,0 +1,61 @@
+# Trinitrix Backend API (TriBA)
+
+**Disclaimer:** These docs are WIP and going to receive a lot of improvement.
+
+## Basic concept
+
+The core starts a CBS as its child process and gives it as first Arg a base64 encoded UUID.
+The CBS then connects to the local fs (or namespaced) socket.
+After performing a handshake, which includes exchange of encryption keys, all communication
+between core and CBS is encrypted (AES256-GCM-SIV) and serialized using [MessagePack](https://msgpack.org)
+
+## Packets
+
+Post-Handshake communication is structured in packets, which have the following structure in their raw form:
+
+| Size (bytes) | Type              | Content                                                            |
+|--------------|-------------------|--------------------------------------------------------------------|
+| 4            | uint32            | The size of the payload.                                           |
+| -            | encrypted payload | The AES-GCM-SIV encrypted MessagePack serialization of the packet. |
+
+A decrypted and deserialized payload contains either a response or a request.
+A request looks as follows:
+
+| Size | Name   | Type   | Content                                                                                                           |
+|------|--------|--------|-------------------------------------------------------------------------------------------------------------------|
+| 8    | `id`   | uint64 | The ID of _this_ packet.                                                                                          |
+| -    | `body` | enum   | The actual packet data. (this will be better documented, as soon, as I dive into the mPack serialization details) |
+
+A response looks like this:
+
+| Size | Name   | Type   | Content                                               |
+|------|--------|--------|-------------------------------------------------------|
+| 8    | `id`   | uint64 | The ID of _this_ packet.                              |
+| 8    | `req`  | uint64 | The ID of the request packet this response refers to. |
+| -    | `body` | enum   | The actual packet data.                               |
+
+**Every request packet, that is sent over the socket, has to get a linked response packet.**
+
+### IDs
+
+Packet IDs are expected to be an incremental counter.
+There is no difference between requests and responses originating from the same socket side when it comes to IDs.
+So both - requests and responses - should share the same counter.
+
+## Handshake
+
+The handshaking process after connecting to the socket looks as follows:
+
+1. The CBS sends its ID as 16 raw bytes.
+2. When the ID is not known to the core, it aborts the handshaking process by closing the connection.
+3. The core sends its Public Key for this connection. Again just 32 raw bytes.
+4. The CBS sends its Public Key for this connection.
+5. The core sends a 12 byte nonce value.
+6. __Connection Upgrade:__ From this point on, all communication is structured by packets.
+   The packet encryption key is calculated using x25519 Diffie-Hellman and the previously exchanged keys.
+   The nonce from step 5 will be used as nonce for all packets.
+7. The CBS sends the `Request::HandshakeUpgradeConnection` packet.
+8. The core responds with `Response::Success`.
+9. (In here there is going to happen API version information exchange etc.)
+10. The Core sends a `Request::HandshakeSuccess`
+11. The CBS responds with `Response::Succcess`

docs/architecture.drawio

@@ -1,3 +1,24 @@
+<!--
+Copyright (C) 2024 - 2024:
+The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+SPDX-License-Identifier: GPL-3.0-or-later
+
+This file is part of Trinitrix.
+
+Trinitrix 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 <https://www.gnu.org/licenses/>.
+-->
+
 <mxfile host="app.diagrams.net" modified="2023-08-04T10:25:32.584Z" agent="Mozilla/5.0 (X11; Linux x86_64; rv:109.0) Gecko/20100101 Firefox/115.0" etag="MddSPBE_GJy1ugcnxB6H" version="21.6.6" type="device">
   <diagram name="Page-1" id="hWGGHW_Bsmf1wcgqsJl5">
     <mxGraphModel dx="682" dy="366" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">

docs/trinitrix.1.md

@@ -0,0 +1,62 @@
+<!--
+Copyright (C) 2024 - 2024:
+The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+SPDX-License-Identifier: GPL-3.0-or-later
+
+This file is part of Trinitrix.
+
+Trinitrix 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 <https://www.gnu.org/licenses/>.
+-->
+
+% TRINITRIX(1) trinitrix 0.1.0
+% The Trinitrix Project
+% May 2024
+
+# NAME
+
+trinitrix - A multi protocol chat client
+
+# SYNOPSIS
+
+**trinitrix** \[*--help*|*--version*\]
+
+# DESCRIPTION
+
+Trinitrix is a multi protocol client. That is implemented via cbs and plugins.
+
+# OPTIONS
+
+**--help**, **-h**
+: Displays a help message and exit.
+
+**--version**, **-v**
+: Displays the software version and exit.
+
+**--plugin-path \<SHARED_OBJECT>**, **-p \<SHARED_OBJECT>**
+: The SHARED_OBJECT to load as a dynamic library. The `plugin_main` function will be
+executed.
+
+# EXAMPLES
+
+**trinitrix repl**
+: Start a repl with evaluation of trinitry commands.
+
+# FILES
+
+*plugin.so*
+: Shared object file of a plugin, to be loaded with **--plugin-path**
+
+# BUGS
+
+Report bugs to <https://git.nerdcult.net/trinitrix/core/issues>.

flake.lock

@@ -38,7 +38,9 @@
     },
     "flake-utils": {
       "inputs": {
-        "systems": "systems"
+        "systems": [
+          "systems"
+        ]
       },
       "locked": {
         "lastModified": 1710146030,
@@ -54,6 +56,58 @@
         "type": "github"
       }
     },
+    "git-hooks": {
+      "inputs": {
+        "flake-compat": [
+          "flake-compat"
+        ],
+        "flake-utils": [
+          "flake-utils"
+        ],
+        "gitignore": [
+          "gitignore"
+        ],
+        "nixpkgs": [
+          "nixpkgs"
+        ],
+        "nixpkgs-stable": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1714478972,
+        "narHash": "sha256-q//cgb52vv81uOuwz1LaXElp3XAe1TqrABXODAEF6Sk=",
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "rev": "2849da033884f54822af194400f8dff435ada242",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1709087332,
+        "narHash": "sha256-HG2cCnktfHsKV0s4XW83gU3F57gaTljL9KNSuG6bnQs=",
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
     "nixpkgs": {
       "locked": {
         "lastModified": 1714656196,
@@ -75,8 +129,12 @@
         "crane": "crane",
         "flake-compat": "flake-compat",
         "flake-utils": "flake-utils",
+        "git-hooks": "git-hooks",
+        "gitignore": "gitignore",
         "nixpkgs": "nixpkgs",
-        "rust-overlay": "rust-overlay"
+        "rust-overlay": "rust-overlay",
+        "systems": "systems",
+        "treefmt-nix": "treefmt-nix"
       }
     },
     "rust-overlay": {
@@ -104,16 +162,36 @@
     },
     "systems": {
       "locked": {
-        "lastModified": 1681028828,
+        "lastModified": 1680978846,
-        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "narHash": "sha256-Gtqg8b/v49BFDpDetjclCYXm8mAnTrUzR0JnE2nv5aw=",
         "owner": "nix-systems",
-        "repo": "default",
+        "repo": "x86_64-linux",
-        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "rev": "2ecfcac5e15790ba6ce360ceccddb15ad16d08a8",
         "type": "github"
       },
       "original": {
         "owner": "nix-systems",
-        "repo": "default",
+        "repo": "x86_64-linux",
+        "type": "github"
+      }
+    },
+    "treefmt-nix": {
+      "inputs": {
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1714058656,
+        "narHash": "sha256-Qv4RBm4LKuO4fNOfx9wl40W2rBbv5u5m+whxRYUMiaA=",
+        "owner": "numtide",
+        "repo": "treefmt-nix",
+        "rev": "c6aaf729f34a36c445618580a9f95a48f5e4e03f",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "treefmt-nix",
         "type": "github"
       }
     }

flake.nix

@@ -1,13 +1,32 @@
+# Copyright (C) 2024 - 2024:
+# The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Trinitrix.
+#
+# Trinitrix 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 <https://www.gnu.org/licenses/>.
 {
-  description = "A terminal UI client for the matrix chat protocol";
+  description = "A multi protocol chat client";
 
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
 
-    # inputs for following
+    treefmt-nix = {
-    flake-compat = {
+      url = "github:numtide/treefmt-nix";
-      url = "github:edolstra/flake-compat";
+      inputs = {
-      flake = false;
+        nixpkgs.follows = "nixpkgs";
+      };
     };
 
     crane = {
@@ -16,9 +35,15 @@
         nixpkgs.follows = "nixpkgs";
       };
     };
-    flake-utils = {
+    git-hooks = {
-      url = "github:numtide/flake-utils";
+      url = "github:cachix/git-hooks.nix";
-      inputs = {};
+      inputs = {
+        flake-compat.follows = "flake-compat";
+        flake-utils.follows = "flake-utils";
+        gitignore.follows = "gitignore";
+        nixpkgs.follows = "nixpkgs";
+        nixpkgs-stable.follows = "nixpkgs";
+      };
     };
     rust-overlay = {
       url = "github:oxalica/rust-overlay";
@@ -27,13 +52,36 @@
         flake-utils.follows = "flake-utils";
       };
     };
+
+    # inputs for following
+    gitignore = {
+      url = "github:hercules-ci/gitignore.nix";
+      inputs = {
+        nixpkgs.follows = "nixpkgs";
+      };
+    };
+    systems = {
+      url = "github:nix-systems/x86_64-linux"; # only evaluate for this system
+    };
+    flake-compat = {
+      url = "github:edolstra/flake-compat";
+      flake = false;
+    };
+    flake-utils = {
+      url = "github:numtide/flake-utils";
+      inputs = {
+        systems.follows = "systems";
+      };
+    };
   };
 
   outputs = {
     self,
     nixpkgs,
-    crane,
     flake-utils,
+    git-hooks,
+    treefmt-nix,
+    crane,
     rust-overlay,
     ...
   }:
@@ -44,26 +92,20 @@
       };
 
       nightly = false;
-      rust =
+      rust_minimal =
         if nightly
         then
-          (pkgs.rust-bin.selectLatestNightlyWith (toolchain:
+          (pkgs.rust-bin.selectLatestNightlyWith (toolchain: toolchain.minimal)).override {
-              toolchain.default))
-          .override {
-            extensions = ["rustc-codegen-cranelift-preview"];
-          }
-        else pkgs.rust-bin.stable.latest.default;
-      rust_min =
-        if nightly
-        then
-          (pkgs.rust-bin.selectLatestNightlyWith (toolchain:
-              toolchain.minimal))
-          .override {
             extensions = ["rustc-codegen-cranelift-preview"];
           }
         else pkgs.rust-bin.stable.latest.minimal;
-
+      rust_default =
-      craneLib = (crane.mkLib pkgs).overrideToolchain rust_min;
+        if nightly
+        then
+          (pkgs.rust-bin.selectLatestNightlyWith (toolchain: toolchain.default)).override {
+            extensions = ["rustc-codegen-cranelift-preview"];
+          }
+        else pkgs.rust-bin.stable.latest.default;
 
       nativeBuildInputs = with pkgs; [
         pkg-config
@@ -75,31 +117,78 @@
         openssl
         lua54Packages.lua
       ];
+      cargo_toml = craneLib.cleanCargoToml {cargoToml = ./Cargo.toml;};
+      pname = cargo_toml.package.name;
 
+      craneLib = (crane.mkLib pkgs).overrideToolchain rust_minimal;
       craneBuild = craneLib.buildPackage {
-        src = craneLib.cleanCargoSource ./.;
+        inherit nativeBuildInputs buildInputs;
+
+        src = let
+          trixyFilter = path: _type: builtins.match ".*tri$" path != null;
+          markdownOrCargo = path: type:
+            (trixyFilter path type) || (craneLib.filterCargoSources path type);
+        in
+          pkgs.lib.cleanSourceWith {
+            src = craneLib.path ./.;
+            filter = markdownOrCargo;
+          };
 
         doCheck = true;
-        inherit nativeBuildInputs buildInputs;
-      };
-    in {
-      checks.default = craneBuild;
-      packages = {
-        default = craneBuild;
       };
 
-      app.default = {
+      manual = pkgs.stdenv.mkDerivation {
-        type = "app";
+        name = "${pname}-manual";
-        program = "${self.packages.${system}.default}/bin/trinitix";
+        inherit (cargo_toml.package) version;
+
+        src = ./docs;
+        nativeBuildInputs = with pkgs; [pandoc];
+
+        buildPhase = ''
+          mkdir --parents $out/docs;
+
+          pandoc "./${pname}.1.md" -s -t man > $out/docs/${pname}.1
+        '';
+
+        installPhase = ''
+          install -D $out/docs/${pname}.1  $out/share/man/man1/${pname};
+        '';
       };
 
+      treefmtEval = import ./treefmt.nix {inherit treefmt-nix pkgs;};
+    in {
+      packages.default = pkgs.symlinkJoin {
+        inherit (cargo_toml.package) name;
+
+        paths = [manual craneBuild];
+      };
+
+      checks = {
+        inherit craneBuild;
+        formatting = treefmtEval.config.build.check self;
+        pre-commit = git-hooks.lib.${system}.run {
+          src = ./.;
+          hooks.treefmt = {
+            enable = true;
+            package = treefmtEval.config.build.wrapper;
+          };
+        };
+      };
+
+      formatter = treefmtEval.config.build.wrapper;
+
       devShells.default = pkgs.mkShell {
+        inherit (self.checks.${system}.pre-commit) shellHook;
         packages = with pkgs; [
-          alejandra
+          cocogitto
 
-          rust
+          yq
+
+          rust_default
           cargo-edit
-          cargo-expand
+
+          valgrind
+          licensure
         ];
         inherit nativeBuildInputs buildInputs;
       };

makefile

@@ -0,0 +1,55 @@
+# Copyright (C) 2024 - 2024:
+# The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Trinitrix.
+#
+# Trinitrix 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 <https://www.gnu.org/licenses/>.
+
+BIN_NAME := ./target/plugin.so
+
+BUILD_DIR := ./target/c_build/
+
+# SRC := $(wildcard c/*.c)
+SRC := ./config/c/plugin.c
+OBJ := $(SRC:.c=.o)
+DEP := $(OBJ:.o=.d)
+
+LIBS :=
+
+ALL_CFLAGS  := -fPIC -O3 -MMD -Wall -Wextra -Wno-unused-parameter $(CFLAGS) $(CPPFLAGS)
+ALL_LDFLAGS := $(addprefix -l,$(LIBS)) -L $(LD_LIBRARY_PATH) $(CFLAGS) $(LDFLAGS)
+
+
+$(BIN_NAME): $(OBJ)
+	gcc $(addprefix $(BUILD_DIR),$(notdir $(OBJ))) -shared -o $(addprefix $(BUILD_DIR),$(notdir $(BIN_NAME))) $(ALL_CFLAGS) $(ALL_LDFLAGS)
+
+$(OBJ): $(SRC)
+	mkdir --parents $(BUILD_DIR)
+	$(CC) -c $< -o $(addprefix $(BUILD_DIR),$(notdir $(OBJ))) $(ALL_CFLAGS)
+
+.PHONY : clean options
+options:
+	@echo "CC      = $(CC)"
+	@echo "CFLAGS  = $(ALL_CFLAGS)"
+	@echo "LDFLAGS = $(ALL_LDFLAGS)"
+	@echo "SRC = $(SRC)"
+	@echo "OBJ = $(OBJ)"
+	@echo "DEP = $(DEP)"
+	@echo ""
+
+clean :
+	rm $(BIN_NAME) $(OBJ) $(DEP)
+	rm -r $(BUILD_DIR)
+

scripts/renew_copyright_header.sh

@@ -0,0 +1,110 @@
+#! /usr/bin/env sh
+# Copyright (C) 2024 - 2024:
+# The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Trinitrix.
+#
+# Trinitrix 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 <https://www.gnu.org/licenses/>.
+
+# NOTE: This is the line length of the .licensure.yml header template **plus** the extra
+# line after the template comment.
+TEMPLATE_LINE_LENGTH=19
+LATEX_TEMPLATE_LINE_LENGTH=9
+
+PROJECT_ROOT="$(git rev-parse --show-toplevel)"
+
+remove() {
+    extension="$1"
+    file="$2"
+
+    # We need to differentiate, when removing the old copyright header, as some
+    # formatters do weird things to the file
+    case "$extension" in
+    # normal '#' comments (these are $TEMPLATE_LINE_LENGTH lines long)
+    "Makefile" | "makefile" | "toml" | "envrc" | "yml" | "gitignore" | "awk" | "lua")
+        sed --in-place "1,${TEMPLATE_LINE_LENGTH}d" "$file"
+        ;;
+    # LaTeX files (or TeX files in general) have a different license, use the
+    # $LATEX_TEMPLATE_LINE_LENGTH variable.
+    "tex")
+        sed --in-place "1,${LATEX_TEMPLATE_LINE_LENGTH}d" "$file"
+        ;;
+    # normal '/* ... */' like comments (these are $TEMPLATE_LINE_LENGTH + 2 lines long)
+    "c" | "h" | "md" | "rs" | "html" | "svg" | "drawio" | "tri")
+        length="$((TEMPLATE_LINE_LENGTH + 2))"
+        sed --in-place "1,${length}d;" "$file"
+        ;;
+    # alejandra (the nix formatter) removes the blank line after the comment,
+    # thus only $TEMPLATE_LINE_LENGTH - 1 lines
+    "nix")
+        length="$((TEMPLATE_LINE_LENGTH - 1))"
+        sed --in-place "1,${length}d;" "$file"
+        ;;
+    # Shell needs a shebang on the first line, only after the first line can we
+    # remove the $TEMPLATE_LINE_LENGTH lines
+    "sh")
+        sed --in-place "2,${TEMPLATE_LINE_LENGTH}d;" "$file"
+        licensure --in-place "$file"
+
+        TEMPLATE_LINE_LENGTH_NEW="$(($(yq --raw-output '.licenses | map(.template) | join("")' "$PROJECT_ROOT/.licensure.yml" | wc -l) + $(yq '.comments | last | .commenter.trailing_lines' "$PROJECT_ROOT/.licensure.yml")))"
+
+        # delete the current shebang
+        to="$((TEMPLATE_LINE_LENGTH_NEW + 1))"
+        sed --in-place "${TEMPLATE_LINE_LENGTH_NEW},${to}d;" "$file"
+
+        # add a new one
+        sed --in-place "1i#! /usr/bin/env sh" "$file"
+        ;;
+    *)
+        echo "File '$file' with extension '$extension' is not know yet, please add it!"
+        ;;
+    esac
+}
+
+list() {
+    echo "$extension -> $file"
+}
+
+if [ -f "$1" ]; then
+    file="$(realpath "$1")"
+    filename="$(basename -- "$file")"
+    extension="${filename##*.}"
+    filename="${filename%.*}"
+
+    if [ -n "$DRY_RUN" ]; then
+        list "$extension" "$file"
+    else
+        remove "$extension" "$file"
+    fi
+else
+    fd --type file --hidden . | while read -r file; do
+        if grep --quiet 'SPDX-License-Identifier' "$file"; then
+            filename="$(basename -- "$file")"
+            extension="${filename##*.}"
+            filename="${filename%.*}"
+
+            if [ -n "$DRY_RUN" ]; then
+                list "$extension" "$file"
+            else
+                remove "$extension" "$file"
+            fi
+        fi
+    done
+
+    if [ -z "$DRY_RUN" ]; then
+        licensure --in-place --project
+        nix fmt
+    fi
+fi

scripts/valgrind_test.sh

@@ -0,0 +1,39 @@
+#! /usr/bin/env sh
+# Copyright (C) 2024 - 2024:
+# The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Trinitrix.
+#
+# Trinitrix 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 <https://www.gnu.org/licenses/>.
+
+cd "$(dirname "$0")" || {
+    echo "BUG: There is no parent dirname!"
+    exit 1
+}
+cd ..
+
+make
+cargo build
+
+export TRINITRIX_LOG=info
+
+valgrind --leak-check=full \
+    --show-leak-kinds=all \
+    --show-error-list=yes \
+    --track-origins=yes \
+    --log-file=./target/valgrind_out.txt \
+    ./target/debug/trinitrix --plugin-path ./target/c_build/plugin.so
+
+cat ./target/valgrind_out.txt

src/accounts/mod.rs

@@ -1,223 +0,0 @@
-use std::fs;
-
-use anyhow::{Error, Result};
-use cli_log::{error, info};
-use matrix_sdk::{ruma::exports::serde_json, Client, Session};
-use serde::{Deserialize, Serialize};
-
-#[derive(Debug, Clone, Serialize, Deserialize)]
-pub struct Account {
-    homeserver: String,
-    id: u32,
-    name: String,
-
-    session: Session,
-    sync_token: Option<String>,
-}
-
-#[derive(Debug, Serialize, Deserialize)]
-struct AccountsData {
-    current_account: u32,
-    accounts: Vec<Account>,
-}
-
-pub struct AccountsManager {
-    current_account: u32,
-    num_accounts: u32,
-    accounts: Vec<Account>,
-    clients: Vec<Option<Client>>,
-}
-
-impl Account {
-    pub fn name(&self) -> &String {
-        &self.name
-    }
-
-    pub fn user_id(&self) -> String {
-        self.session.user_id.to_string()
-    }
-}
-
-impl AccountsManager {
-    pub fn new(config: Option<String>) -> Result<Self> {
-        return match config {
-            Some(s) => {
-                info!("Loading serialized AccountsManager");
-                let accounts_data: AccountsData = serde_json::from_str(&s)?;
-                let mut clients = Vec::new();
-                clients.resize(accounts_data.accounts.len(), None);
-                Ok(Self {
-                    current_account: accounts_data.current_account,
-                    num_accounts: accounts_data.accounts.len() as u32,
-                    accounts: accounts_data.accounts,
-                    clients,
-                })
-            }
-            None => {
-                info!("Creating empty AccountsManager");
-                Ok(Self {
-                    current_account: 0,
-                    num_accounts: 0,
-                    accounts: Vec::new(),
-                    clients: Vec::new(),
-                })
-            }
-        };
-    }
-
-    pub async fn restore(&mut self) -> Result<()> {
-        self.login(self.current_account).await?;
-        Ok(())
-    }
-
-    pub async fn add(
-        &mut self,
-        homeserver: &String,
-        username: &String,
-        password: &String,
-    ) -> Result<u32> {
-        let id = self.num_accounts;
-        self.num_accounts += 1;
-
-        let client = Client::builder()
-            .homeserver_url(homeserver)
-            .sled_store(format!("userdata/{id}"), Some("supersecure"))?
-            .build()
-            .await?;
-
-        client
-            .login_username(username, password)
-            .initial_device_display_name("Trinitrix")
-            .send()
-            .await?;
-
-        let session = match client.session() {
-            Some(s) => s,
-            None => return Err(Error::msg("Failed to get session")),
-        };
-
-        let name = match client.account().get_display_name().await? {
-            Some(n) => n,
-            None => return Err(Error::msg("Failed to get display name")),
-        };
-
-        let account = Account {
-            homeserver: homeserver.to_string(),
-            id,
-            name,
-            session: session.clone(),
-            sync_token: None,
-        };
-
-        self.logout().await?;
-        self.current_account = id;
-        self.accounts.push(account);
-        self.clients.push(Some(client));
-        self.save()?;
-
-        info!(
-            "Logged in as '{}' device ID: {}",
-            session.user_id.to_string(),
-            session.device_id.to_string()
-        );
-
-        Ok(id)
-    }
-
-    pub async fn login(&mut self, account_id: u32) -> Result<()> {
-        self.logout().await?; // log out the current account
-
-        let account = if account_id >= self.num_accounts {
-            error!("Tried to log in with an invalid account ID {}", account_id);
-            return Err(Error::msg("Invalid account ID"));
-        } else {
-            if let Some(a) = self.get(account_id) {
-                a
-            } else {
-                return Err(Error::msg("Failed to get account"));
-            }
-        };
-
-        if self
-            .clients
-            .get(account_id as usize)
-            .expect("client lookup failed")
-            .is_none()
-        {
-            info!(
-                "No client cached for account: '{}' -> requesting a new one",
-                &account.session.user_id
-            );
-            let client = Client::builder()
-                .homeserver_url(&account.homeserver)
-                .sled_store(format!("userdata/{account_id}"), Some("supersecure"))?
-                .build()
-                .await?;
-            client.restore_login(account.session.clone()).await?;
-            self.clients.insert(account_id as usize, Some(client));
-        } else {
-            info!(
-                "Using cached client for account: '{}'",
-                &account.session.user_id
-            );
-        };
-
-        info!("Restored account");
-
-        self.current_account = account_id;
-
-        Ok(())
-    }
-
-    pub async fn logout(&mut self) -> Result<()> {
-        // idk, do some matrix related stuff in here or something like that
-        if self.clients.get(self.current_account as usize).is_none() {
-            return Ok(());
-        }
-        let client = match self.clients.get(self.current_account as usize).unwrap() {
-            None => return Ok(()),
-            Some(c) => c,
-        };
-
-        info!("Logged out '{}' locally", client.session().unwrap().user_id);
-        client.logout().await?;
-
-        Ok(())
-    }
-
-    pub fn save(&self) -> Result<()> {
-        let accounts_data = AccountsData {
-            current_account: self.current_account,
-            accounts: self.accounts.clone(),
-        };
-
-        let serialized = serde_json::to_string(&accounts_data)?;
-        fs::write("userdata/accounts.json", serialized)?;
-
-        info!("Saved serialized accounts config (userdata/accounts.json)");
-
-        Ok(())
-    }
-
-    pub fn get(&self, id: u32) -> Option<&Account> {
-        self.accounts.get(id as usize)
-    }
-
-    pub fn current(&self) -> Option<&Account> {
-        self.get(self.current_account)
-    }
-
-    pub fn client(&self) -> Option<&Client> {
-        match self.clients.get(self.current_account as usize) {
-            None => None,
-            Some(oc) => match oc {
-                None => None,
-                Some(c) => Some(c),
-            },
-        }
-    }
-
-    pub fn num_accounts(&self) -> u32 {
-        self.num_accounts
-    }
-}

src/app/command_interface/command_list/api.tri

@@ -1,23 +1,22 @@
 /*
-* Copyright (C) 2023 - 2024:
+* Copyright (C) 2024 - 2024:
-* The Trinitrix Project <soispha@vhack.eu, antifallobst@systemausfall.org>
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
-* SPDX-License-Identifier: LGPL-3.0-or-later
+* SPDX-License-Identifier: GPL-3.0-or-later
 *
-* This file is part of the Trixy crate for Trinitrix.
+* This file is part of Trinitrix.
 *
-* Trixy is free software: you can redistribute it and/or modify
+* Trinitrix is free software: you can redistribute it and/or modify
-* it under the terms of the Lesser GNU General Public License as
+* it under the terms of the GNU General Public License as published
-* published by the Free Software Foundation, either version 3 of
+* by the Free Software Foundation, either version 3 of the License,
-* the License, or (at your option) any later version.
+* 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
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-* GNU General Public License for more details.
+* General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
-* and the Lesser GNU General Public License along with this program.
+* along with this program.  If not, see <https://www.gnu.org/licenses/>.
-* If not, see <https://www.gnu.org/licenses/>.
 */
 
 //// Prints to the output, with a newline.
@@ -40,20 +39,12 @@ mod trinitrix {
         /// Closes the application
         fn exit();
 
-        /// Send a message to the current room
-        /// The send message is interpreted literally.
-        fn room_message_send(message: String);
-
         //// Open the help pages at the first occurrence of
         //// the input string if it is Some, otherwise open
         //// the help pages at the start
         // TODO(@soispha): To be implemented <2024-03-09>
         // fn help(Option<String>);
 
-        //// Register a function to be used with the Trinitrix api
-        // (This function is not actually implemented here)
-        /* declare register_function: false, */
-
         /// Function that change the UI, or UI state
         mod ui {
             enum Mode {

src/app/command_interface/command_list/mod.rs

@@ -1,3 +1,24 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 // Run the `api` bin to see the generated api
 
 use std::{panic::catch_unwind, process, thread};

src/app/command_interface/command_transfer_value/lua.rs

@@ -1,3 +1,24 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 use std::collections::HashMap;
 
 use cli_log::info;

src/app/command_interface/command_transfer_value/mod.rs

@@ -1,3 +1,24 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 use std::{collections::HashMap, fmt::Display};
 
 use serde::{Deserialize, Serialize};

src/app/command_interface/command_transfer_value/support_types.rs

@@ -1,3 +1,24 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 use std::{
     fmt::Display,
     sync::atomic::{AtomicUsize, Ordering},

src/app/command_interface/command_transfer_value/type_conversions.rs

@@ -1,3 +1,24 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 use std::collections::HashMap;
 
 use super::CommandTransferValue;

src/app/command_interface/lua_command_manager/mod.rs

@@ -1,3 +1,24 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 use std::thread;
 
 use anyhow::{Context, Result};

src/app/command_interface/mod.rs

@@ -1,3 +1,24 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 pub mod command_list;
 // pub mod command_transfer_value;
 // pub mod lua_command_manager;

src/app/config/lua/mod.rs

@@ -1,14 +1,66 @@
-use std::path::PathBuf;
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
 
-use anyhow::Result;
+use std::path::{Path, PathBuf};
-use cli_log::info;
+
+use anyhow::{Context, Result};
+use cli_log::{info, warn};
 use tokio::{fs, sync::mpsc::Sender};
 
 use crate::app::events::Event;
 
+const LUA_CONFIG_FILE_NAME: &str = "init.lua";
+
 pub async fn load(tx: Sender<Event>, path: PathBuf) -> Result<()> {
+    info!("Loaded config file at '{}'", path.display());
+
     let lua_config_code = fs::read_to_string(&path).await?;
     tx.send(Event::LuaCommand(lua_config_code)).await?;
-    info!("Loaded config file at `{}`", path.display());
+
     Ok(())
 }
+
+pub async fn check_for_config_file(config_dir: &Path) -> Result<Option<PathBuf>> {
+    if config_dir
+        .try_exists()
+        .context("Failed to search for a config file")?
+    {
+        info!("Found config dir: `{}`", config_dir.display());
+        let config_file = config_dir.join(LUA_CONFIG_FILE_NAME);
+
+        info!("Searching for config file at '{}'", config_file.display());
+        if config_file.try_exists().with_context(|| {
+            format!(
+                "Failed to check, if the lua config file at '{}' exists.",
+                config_file.display()
+            )
+        })? {
+            info!("Found the config file at: '{}'", config_file.display());
+            Ok(Some(config_file))
+        } else {
+            warn!("No config file found!");
+            Ok(None)
+        }
+    } else {
+        warn!("No config directory found at {}!", config_dir.display());
+        Ok(None)
+    }
+}

src/app/config/mod.rs

@@ -1 +1,23 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 pub mod lua;
+pub mod shared_objects;

src/app/config/shared_objects/mod.rs

@@ -0,0 +1,50 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
+use std::{
+    ffi::c_int,
+    path::PathBuf,
+    thread::{self},
+};
+
+use anyhow::{Context, Result};
+use cli_log::info;
+use libloading::{Library, Symbol};
+
+pub fn load(plugin: PathBuf) -> Result<()> {
+    info!("Loading a plugin from '{}'", plugin.display());
+
+    let _handle = thread::spawn(move || -> Result<()> {
+        unsafe {
+            let lib = Library::new(plugin).context("Failed to load plugin")?;
+            let func: Symbol<unsafe fn() -> c_int> = lib
+                .get(b"plugin_main")
+                .context("Plugin does not have a 'plugin_main' symbol")?;
+
+            info!("Starting plugin");
+            let out = func();
+            info!("Plugin finished with: {}", out);
+        }
+        Ok(())
+    });
+
+    Ok(())
+}

src/app/events/handlers/command.rs

@@ -1,3 +1,24 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 use std::str::FromStr;
 
 use crate::{
@@ -14,7 +35,7 @@ use crate::{
         App,
     },
     trinitrix::api::ui::Mode,
-    ui::central::InputPosition,
+    ui::ui_trait::TrinitrixUi,
 };
 use anyhow::Result;
 use cli_log::{info, trace, warn};
@@ -25,8 +46,8 @@ use keymaps::{
 };
 use trixy::oneshot;
 
-pub async fn handle(
+pub async fn handle<U: TrinitrixUi>(
-    app: &mut App<'_>,
+    app: &mut App<U>,
     command: &Commands,
 
     // FIXME(@soispha): The `String` is temporary <2024-05-03>
@@ -87,21 +108,6 @@ pub async fn handle(
                     warn!("Terminating the application");
                     EventStatus::Terminate
                 }
-                Api::room_message_send { message } => {
-                    if let Some(room) = app.status.room_mut() {
-                        room.send(message.to_string()).await?;
-                        send_status_output!("Sent message: `{}`", message);
-                    } else {
-                        // FIXME(@soispha): This should raise an error within lua, as it would
-                        // otherwise be very confusing <2023-09-20>
-                        warn!(
-                            "Can't send message: `{}`, as there is no open room!",
-                            &message
-                        );
-                    }
-
-                    EventStatus::Ok
-                }
                 Api::Ui(ui) => match ui {
                     Ui::set_mode { mode } => match mode {
                         Mode::Normal => {
@@ -111,24 +117,24 @@ pub async fn handle(
                         }
                         Mode::Insert => {
                             app.status.set_state(State::Insert);
-                            app.ui.set_input_position(InputPosition::MessageCompose);
                             send_status_output!("Set input mode to Insert");
                             EventStatus::Ok
                         }
                         Mode::Command => {
-                            app.ui.cli_enable();
                             app.status.set_state(State::Command);
                             send_status_output!("Set input mode to CLI");
                             EventStatus::Ok
                         }
                     },
                     Ui::cycle_planes => {
-                        app.ui.cycle_main_input_position();
+                        // TODO(@soispha): add this <2024-05-04>
+                        // app.ui.cycle_main_input_position();
                         send_status_output!("Switched main input position");
                         EventStatus::Ok
                     }
                     Ui::cycle_planes_rev => {
-                        app.ui.cycle_main_input_position_rev();
+                        // TODO(@soispha): and this <2024-05-04>
+                        // app.ui.cycle_main_input_position_rev();
                         send_status_output!("Switched main input position; reversed");
                         EventStatus::Ok
                     }
@@ -193,33 +199,19 @@ pub async fn handle(
                         EventStatus::Ok
                     }
                     Raw::send_input_unprocessed { input } => {
-                        let output = match app.status.state() {
+                        let key = Key::from_str(input.as_str())?;
-                            State::Insert => {
+
-                                let key = Key::from_str(input.as_str())?;
+                        match app.status.state() {
-                                let cross_input: Event = key.try_into()?;
+                            State::Insert | State::Command => {
-                                app.ui
+                                app.ui.input(key);
-                                    .message_compose
-                                    .input(tui_textarea::Input::from(cross_input));
-                                EventStatus::Ok
-                            }
-                            State::Command => {
-                                let key = Key::from_str(input.as_str())?;
-                                let cross_input: Event = key.try_into()?;
-                                app.ui
-                                    .cli
-                                    .as_mut()
-                                    .expect("This should exist, when the state is 'Command'")
-                                    .input(tui_textarea::Input::from(cross_input));
-                                EventStatus::Ok
                             }
                             State::Normal
-                            | State::Setup
                             | State::KeyInputPending {
                                 old_state: _,
                                 pending_keys: _,
-                            } => EventStatus::Ok,
+                            } => {}
-                        };
+                        }
-                        output
+                        EventStatus::Ok
                     }
                     Raw::Private(private) => {
                         // no-op, this was used to store functions (not so sure, if we need it

src/app/events/handlers/function.rs

@@ -1,3 +1,24 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 // use anyhow::Result;
 //
 // use crate::app::{

src/app/events/handlers/input.rs

@@ -1,23 +1,54 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 use anyhow::Result;
 use cli_log::info;
 use crossterm::event::Event as CrosstermEvent;
 use keymaps::key_repr::{Key, Keys};
 
-use crate::app::{
+use crate::{
-    command_interface::{
+    app::{
-        trinitrix::{
+        command_interface::{
-            api::{raw::Raw, Api},
+            trinitrix::{
-            Trinitrix,
+                api::{raw::Raw, Api},
+                Trinitrix,
+            },
+            Commands,
         },
-        Commands,
+        events::{Event, EventStatus},
+        status::State,
+        App,
     },
-    events::{Event, EventStatus},
+    ui::ui_trait::TrinitrixUi,
-    status::State,
-    App,
 };
 
-pub async fn handle(app: &mut App<'_>, input_event: &CrosstermEvent) -> Result<EventStatus> {
+pub async fn handle<U: TrinitrixUi>(
-    async fn default(converted_key: Key, app: &mut App<'_>, old_state: &State) -> Result<()> {
+    app: &mut App<U>,
+    input_event: &CrosstermEvent,
+) -> Result<EventStatus> {
+    async fn default<U: TrinitrixUi>(
+        converted_key: Key,
+        app: &mut App<U>,
+        old_state: &State,
+    ) -> Result<()> {
         info!(
             "No keymaps exist for key ('{}'), passing it along..",
             converted_key

src/app/events/handlers/lua_command.rs

@@ -1,3 +1,24 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 // use anyhow::Result;
 // use cli_log::trace;
 //

src/app/events/handlers/main.rs

@@ -1,10 +1,31 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 use anyhow::{Context, Result};
 use crossterm::event::{Event as CrosstermEvent, KeyCode, KeyEvent, KeyModifiers};
 
 use crate::{
     app::{
         command_interface::{
-            Api::{Exit, Ui, RoomMessageSend},
+            Api::{Exit, RoomMessageSend, Ui},
             Command,
             Trinitrix::Api,
             Ui::{CommandLineShow, CyclePlanes, CyclePlanesRev, SetModeInsert, SetModeNormal},

src/app/events/handlers/matrix.rs

@@ -1,23 +0,0 @@
-use anyhow::Result;
-use matrix_sdk::deserialized_responses::SyncResponse;
-
-use crate::app::{events::EventStatus, App};
-
-pub async fn handle(app: &mut App<'_>, sync: &SyncResponse) -> Result<EventStatus> {
-    for (m_room_id, m_room) in sync.rooms.join.iter() {
-        let room = match app.status.get_room_mut(m_room_id) {
-            Some(r) => r,
-            None => continue,
-        };
-        for m_event in m_room.timeline.events.clone() {
-            let event = m_event
-                .event
-                .deserialize()
-                .unwrap()
-                .into_full_event(m_room_id.clone());
-            room.timeline_add(event);
-        }
-    }
-
-    Ok(EventStatus::Ok)
-}

src/app/events/handlers/mod.rs

@@ -1,9 +1,26 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 // input events
 pub mod input;
-pub mod setup;
-
-// matrix
-pub mod matrix;
 
 // ci
 pub mod command;

src/app/events/handlers/setup.rs

@@ -1,75 +0,0 @@
-use anyhow::{bail, Context, Result};
-use crossterm::event::{Event as CrosstermEvent, KeyCode, KeyEvent};
-
-use crate::{
-    app::{events::EventStatus, App},
-    ui::setup,
-};
-
-pub async fn handle(app: &mut App<'_>, input_event: &CrosstermEvent) -> Result<EventStatus> {
-    let ui = match &mut app.ui.setup_ui {
-        Some(ui) => ui,
-        None => bail!("SetupUI instance not found"),
-    };
-
-    match input_event {
-        CrosstermEvent::Key(KeyEvent {
-            code: KeyCode::Esc, ..
-        }) => return Ok(EventStatus::Terminate),
-        CrosstermEvent::Key(KeyEvent {
-            code: KeyCode::Tab, ..
-        }) => {
-            ui.cycle_input_position();
-        }
-        CrosstermEvent::Key(KeyEvent {
-            code: KeyCode::BackTab,
-            ..
-        }) => {
-            ui.cycle_input_position_rev();
-        }
-        CrosstermEvent::Key(KeyEvent {
-            code: KeyCode::Enter,
-            ..
-        }) => {
-            match ui.input_position() {
-                setup::InputPosition::Ok => {
-                    let homeserver = ui.homeserver.lines()[0].clone();
-                    let username = ui.username.lines()[0].clone();
-                    let password = ui.password_data.lines()[0].clone();
-                    app.login(&homeserver, &username, &password)
-                        .await
-                        .context("Failed to login")?;
-                    // We bailed in the line above, thus login must have succeeded
-                    return Ok(EventStatus::Finished);
-                }
-                _ => ui.cycle_input_position(),
-            };
-        }
-        input => match ui.input_position() {
-            setup::InputPosition::Homeserver => {
-                ui.homeserver.input(input.to_owned());
-            }
-            setup::InputPosition::Username => {
-                ui.username.input(input.to_owned());
-            }
-            setup::InputPosition::Password => {
-                let textarea_input = tui_textarea::Input::from(input.to_owned());
-                ui.password_data.input(textarea_input.clone());
-                match textarea_input.key {
-                    tui_textarea::Key::Char(_) => {
-                        ui.password.input(tui_textarea::Input {
-                            key: tui_textarea::Key::Char('*'),
-                            ctrl: false,
-                            alt: false,
-                        });
-                    }
-                    _ => {
-                        ui.password.input(textarea_input);
-                    }
-                }
-            }
-            _ => (),
-        },
-    };
-    Ok(EventStatus::Ok)
-}

src/app/events/listeners/input.rs

@@ -1,21 +0,0 @@
-use crate::app::events::Event;
-use anyhow::{bail, Result};
-use tokio::{sync::mpsc, time::Duration};
-use tokio_util::sync::CancellationToken;
-
-pub async fn poll(channel: mpsc::Sender<Event>, kill: CancellationToken) -> Result<()> {
-    async fn stage_2(channel: mpsc::Sender<Event>) -> Result<()> {
-        loop {
-            if crossterm::event::poll(Duration::from_millis(100))? {
-                let event = Event::InputEvent(crossterm::event::read()?);
-                channel.send(event).await?;
-            } else {
-                tokio::task::yield_now().await;
-            }
-        }
-    }
-    tokio::select! {
-        output = stage_2(channel) => output,
-        _ = kill.cancelled() => bail!("received kill signal")
-    }
-}

src/app/events/listeners/matrix.rs

@@ -1,41 +0,0 @@
-/* WARNING(@antifallobst):
- * This file is going to be removed while implementing Chat Backend Servers!
- * <19-10-2023>
- */
-
-use crate::app::events::Event;
-use anyhow::{bail, Result};
-use matrix_sdk::{config::SyncSettings, Client, LoopCtrl};
-use tokio::sync::mpsc;
-use tokio_util::sync::CancellationToken;
-
-pub async fn poll(
-    channel: mpsc::Sender<Event>,
-    kill: CancellationToken,
-    client: Client,
-) -> Result<()> {
-    async fn stage_2(channel: mpsc::Sender<Event>, client: Client) -> Result<()> {
-        let sync_settings = SyncSettings::default();
-        // .token(sync_token)
-        // .timeout(Duration::from_secs(30));
-
-        let tx = &channel;
-
-        client
-            .sync_with_callback(sync_settings, |response| async move {
-                let event = Event::MatrixEvent(response);
-
-                match tx.send(event).await {
-                    Ok(_) => LoopCtrl::Continue,
-                    Err(_) => LoopCtrl::Break,
-                }
-            })
-            .await?;
-
-        Ok(())
-    }
-    tokio::select! {
-        output = stage_2(channel, client) => output,
-        _ = kill.cancelled() => bail!("received kill signal"),
-    }
-}

src/app/events/listeners/mod.rs

@@ -1,2 +1,42 @@
-pub mod input;
+/*
-pub mod matrix;
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
+use crate::app::events::Event;
+use anyhow::{bail, Result};
+use tokio::{sync::mpsc, time::Duration};
+use tokio_util::sync::CancellationToken;
+
+pub async fn poll(channel: mpsc::Sender<Event>, kill: CancellationToken) -> Result<()> {
+    async fn stage_2(channel: mpsc::Sender<Event>) -> Result<()> {
+        loop {
+            if crossterm::event::poll(Duration::from_millis(100))? {
+                let event = Event::InputEvent(crossterm::event::read()?);
+                channel.send(event).await?;
+            } else {
+                tokio::task::yield_now().await;
+            }
+        }
+    }
+    tokio::select! {
+        output = stage_2(channel) => output,
+        _ = kill.cancelled() => bail!("received kill signal")
+    }
+}

src/app/events/mod.rs

@@ -1,34 +1,82 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 mod handlers;
 pub mod listeners;
 
-use anyhow::{Context, Result};
+use anyhow::{Context, Error, Result};
 
-use crate::app::{command_interface::Commands, status::State, App};
+use crate::{
+    app::{command_interface::Commands, App},
+    ui::ui_trait::TrinitrixUi,
+};
 use cli_log::{trace, warn};
 use crossterm::event::Event as CrosstermEvent;
-use handlers::{command, input, lua_command, matrix, setup};
+use handlers::{command, input};
+use uuid::Uuid;
+
+#[derive(Debug)]
+pub enum ErrorEvent {
+    CBSCrash(Uuid, Error),
+}
+
+impl ErrorEvent {
+    pub async fn handle<U: TrinitrixUi>(self, app: &mut App<U>) -> Result<EventStatus> {
+        match self {
+            Self::CBSCrash(cbs, err) => {
+                // TODO: Kill CBS process
+                // TODO: Kill CBS connection threads
+                cli_log::error!("The CBS handler for {cbs} crashed: {err}");
+                Ok(EventStatus::Ok)
+            }
+        }
+    }
+}
 
 #[derive(Debug)]
 pub enum Event {
     InputEvent(CrosstermEvent),
-    MatrixEvent(matrix_sdk::deserialized_responses::SyncResponse),
+    CBSPacket(Uuid, triba_packet::Packet),
-    // FIXME(@soispha): The `String` is also wrong <2024-05-03>
+    Error(ErrorEvent),
+
+    // FIXME(@soispha): The `String` here is just wrong <2024-05-03>
     CommandEvent(Commands, Option<trixy::oneshot::Sender<String>>),
     LuaCommand(String),
 }
 
 impl Event {
-    pub async fn handle(self, app: &mut App<'_>) -> Result<EventStatus> {
+    pub async fn handle<U: TrinitrixUi>(self, app: &mut App<U>) -> Result<EventStatus> {
         trace!("Received event to handle: `{:#?}`", &self);
         match self {
-            Event::MatrixEvent(event) => matrix::handle(app, &event)
-                .await
-                .with_context(|| format!("Failed to handle matrix event: `{:#?}`", event)),
-
             Event::CommandEvent(event, callback_tx) => command::handle(app, &event, callback_tx)
                 .await
                 .with_context(|| format!("Failed to handle command event: `{:#?}`", event)),
 
+            Event::CBSPacket(cbs, packet) => {
+                cli_log::info!("Received packet from cbs {cbs}: {packet:?}");
+                Ok(EventStatus::Ok)
+            }
+
+            Event::Error(err) => err.handle(app).await,
+
             Event::LuaCommand(lua_code) => {
                 warn!(
                     "Got lua code to execute, but no exectuter is available:\n{}",
@@ -43,9 +91,6 @@ impl Event {
             //     .await
             //     .with_context(|| format!("Failed to handle function: `{}`", function)),
             Event::InputEvent(event) => match app.status.state() {
-                State::Setup => setup::handle(app, &event).await.with_context(|| {
-                    format!("Failed to handle input (setup) event: `{:#?}`", event)
-                }),
                 _ => input::handle(app, &event).await.with_context(|| {
                     format!("Failed to handle input (non-setup) event: `{:#?}`", event)
                 }),

src/app/mod.rs

@@ -1,26 +1,35 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 pub mod command_interface;
 pub mod config;
 pub mod events;
 pub mod status;
+pub mod storage;
 
-use std::{
+use std::{collections::HashMap, path::PathBuf, sync::OnceLock};
-    collections::HashMap,
-    ffi::c_int,
-    path::{Path, PathBuf},
-    sync::OnceLock,
-};
 
-use anyhow::{Context, Error, Result};
+use anyhow::{Context, Result};
-use cli_log::{info, warn};
+use cli_log::{debug, warn};
-use crossterm::{
-    event::DisableMouseCapture,
-    execute,
-    terminal::{disable_raw_mode, LeaveAlternateScreen},
-};
-use directories::ProjectDirs;
 use keymaps::trie::Node;
-use libloading::{Library, Symbol};
-use matrix_sdk::Client;
 use tokio::sync::mpsc::{self, Sender};
 use tokio_util::sync::CancellationToken;
 
@@ -28,67 +37,60 @@ use tokio_util::sync::CancellationToken;
 // lua_command_manager::LuaCommandManager,
 // };
 
+use crate::app::storage::Storage;
 use crate::{
-    accounts::{Account, AccountsManager},
     app::{
         events::{Event, EventStatus},
         status::{State, Status},
     },
-    ui::{central, setup},
+    cbs,
+    ui::ui_trait::TrinitrixUi,
 };
 
-pub struct App<'runtime> {
+pub struct App<U: TrinitrixUi> {
-    ui: central::UI<'runtime>,
+    ui: U,
-    accounts_manager: AccountsManager,
     status: Status,
 
+    cbs_manager: cbs::Manager,
+
     tx: mpsc::Sender<Event>,
     rx: mpsc::Receiver<Event>,
 
     input_listener_killer: CancellationToken,
-    matrix_listener_killer: CancellationToken,
 
     // lua: LuaCommandManager,
-    project_dirs: ProjectDirs,
+    storage: Storage,
 
     key_mappings: HashMap<State, Node<extern "C" fn()>>,
 }
 
 pub static COMMAND_TRANSMITTER: OnceLock<Sender<Event>> = OnceLock::new();
 
-impl App<'_> {
+impl<U: TrinitrixUi> App<U> {
-    pub fn new() -> Result<Self> {
+    pub async fn new(ui: U) -> Result<Self> {
-        let path: &std::path::Path = Path::new("userdata/accounts.json");
-        let config = if path.exists() {
-            info!("Reading account config (userdata/accounts.json)");
-            Some(std::fs::read_to_string(path)?)
-        } else {
-            None
-        };
-
         let (tx, rx) = mpsc::channel(256);
 
         COMMAND_TRANSMITTER
             .set(tx.clone())
             .expect("The cell should always be empty at this point");
 
+        let cbs_manager = cbs::Manager::new(tx.clone()).await;
+        cbs_manager.spawn_cbs().await?; // TODO: remove, this is just a dummy  - antifallobst <2024-05-21>
+
         Ok(Self {
-            ui: central::UI::new()?,
+            ui,
-            accounts_manager: AccountsManager::new(config)?,
+            status: Status::new(),
-            status: Status::new(None),
+
+            cbs_manager,
 
             tx: tx.clone(),
             rx,
             input_listener_killer: CancellationToken::new(),
-            matrix_listener_killer: CancellationToken::new(),
 
             // lua: LuaCommandManager::new(tx),
 
             // TODO: We probably want to populate the strings below a bit more <2023-09-09>
-            project_dirs: ProjectDirs::from("", "", "trinitrix").context(
+            storage: Storage::new().await?,
-                "Failed to allocate project direcectory paths, \
-                          please ensure your $HOME is set correctly",
-            )?,
             key_mappings: HashMap::new(),
         })
     }
@@ -99,64 +101,30 @@ impl App<'_> {
         plugin_path: Option<PathBuf>,
     ) -> Result<()> {
         // Spawn input event listener
-        tokio::task::spawn(events::listeners::input::poll(
+        tokio::task::spawn(events::listeners::poll(
             self.tx.clone(),
             self.input_listener_killer.clone(),
         ));
 
-        let config_dir = self.project_dirs.config_dir();
-        let mut lua_config_file = None;
-        if config_dir
-            .try_exists()
-            .context("Failed to search for a config file")?
-        {
-            lua_config_file = Some(config_dir.join("init.lua"));
-            info!("Found config dir: `{}`", config_dir.display());
-        } else {
-            warn!("No config dir found!");
-        }
-
         if let Some(config_file) = cli_lua_config_file {
             config::lua::load(self.tx.clone(), config_file).await?;
-        } else if let Some(config_file) = lua_config_file {
+            warn!("Loading cli config file, will ignore the default locations");
-            info!("Searching for config file at `{}`", config_file.display());
+        } else {
-            if config_file.try_exists().with_context(|| {
+            let config_file =
-                format!(
+                config::lua::check_for_config_file(self.storage.project_dirs().config_dir())
-                    "Failed to check, if the lua config file at `{}` exists",
+                    .await
-                    config_file.display()
+                    .context("Failed to check for the config file")?;
-                )
+
-            })? {
+            if let Some(config) = config_file {
-                config::lua::load(self.tx.clone(), config_file).await?;
+                config::lua::load(self.tx.clone(), config).await?;
-            } else {
-                warn!("No config file found!");
             }
         }
 
         if let Some(plugin) = plugin_path {
-            info!("Loading plugin_main() from {}", plugin.display());
+            config::shared_objects::load(plugin.clone())
-
+                .with_context(|| format!("Failed to load a pluging at '{}'", plugin.display()))?;
-            unsafe {
-                let lib = Library::new(plugin).context("Failed to load plugin")?;
-                let func: Symbol<unsafe fn() -> c_int> = lib
-                    .get(b"plugin_main")
-                    .context("Plugin does not have a 'plugin_main' symbol")?;
-
-                info!("Starting plugin");
-                let out = func();
-                info!("Plugin finished with: {}", out);
-            }
         }
 
-        if self.account().is_err() {
-            info!("No saved sessions found -> jumping into setup");
-            self.setup().await?;
-        } else {
-            self.accounts_manager.restore().await?;
-            self.init_account().await?;
-        }
-
-        self.status.set_state(State::Normal);
-
         loop {
             self.ui.update(&self.status).await?;
 
@@ -171,89 +139,4 @@ impl App<'_> {
         self.input_listener_killer.cancel();
         Ok(())
     }
-
-    async fn setup(&mut self) -> Result<()> {
-        self.ui.setup_ui = Some(setup::UI::new());
-
-        self.status.set_state(State::Setup);
-
-        loop {
-            self.ui.update_setup().await?;
-
-            let event = self.rx.recv().await.context("Failed to get next event")?;
-
-            match event.handle(self).await? {
-                EventStatus::Ok => (),
-                EventStatus::Finished => return Ok(()),
-                EventStatus::Terminate => return Err(Error::msg("Terminated by user")),
-            }
-        }
-    }
-
-    pub async fn init_account(&mut self) -> Result<()> {
-        let client = match self.client() {
-            Some(c) => c,
-            None => return Err(Error::msg("failed to get current client")),
-        }
-        .clone();
-
-        self.matrix_listener_killer.cancel();
-        self.matrix_listener_killer = CancellationToken::new();
-
-        // Spawn Matrix Event Listener
-        tokio::task::spawn(events::listeners::matrix::poll(
-            self.tx.clone(),
-            self.matrix_listener_killer.clone(),
-            client.clone(),
-        ));
-
-        // Reset Status
-        self.status = Status::new(Some(client));
-
-        let account = self.account()?;
-        let name = account.name().clone();
-        let user_id = account.user_id().clone();
-        self.status.set_account_name(name);
-        self.status.set_account_user_id(user_id);
-
-        for (_, room) in self.status.rooms_mut() {
-            room.update_name().await?;
-            for _ in 0..3 {
-                room.poll_old_timeline().await?;
-            }
-        }
-
-        info!("Initializing client for the current account");
-
-        Ok(())
-    }
-
-    pub async fn switch_account(&mut self, account_id: u32) -> Result<()> {
-        Ok(())
-    }
-
-    pub async fn login(
-        &mut self,
-        homeserver: &String,
-        username: &String,
-        password: &String,
-    ) -> Result<()> {
-        self.accounts_manager
-            .add(homeserver, username, password)
-            .await?;
-        self.init_account().await?;
-        Ok(())
-    }
-
-    pub fn account(&self) -> Result<&Account> {
-        let account = self.accounts_manager.current();
-        match account {
-            None => Err(Error::msg("failed to resolve current account")),
-            Some(a) => Ok(a),
-        }
-    }
-
-    pub fn client(&self) -> Option<&Client> {
-        self.accounts_manager.client()
-    }
 }

src/app/status.rs

@@ -1,25 +1,35 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 use core::fmt;
 
-use anyhow::{bail, Error, Result};
+use anyhow::{bail, Result};
-use cli_log::warn;
-use indexmap::IndexMap;
 use keymaps::key_repr::Keys;
-use matrix_sdk::{
-    room::MessagesOptions,
-    ruma::{
-        events::{room::message::RoomMessageEventContent, AnyTimelineEvent, StateEventType},
-        RoomId, TransactionId,
-    },
-    Client,
-};
 
-#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Debug)]
+#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Debug, Default)]
 pub enum State {
+    #[default]
     Normal,
     Insert,
     Command,
-    /// Temporary workaround until command based login is working
-    Setup,
     /// Only used internally to signal, that we are waiting on further keyinputs, if multiple
     /// keymappings have the same prefix
     KeyInputPending {
@@ -34,7 +44,6 @@ impl State {
             'n' => State::Normal,
             'i' => State::Insert,
             'c' => State::Command,
-            's' => State::Setup,
             _ => bail!(
                 "The letter '{}' is either not connected to a state or not yet implemented",
                 c
@@ -43,15 +52,6 @@ impl State {
     }
 }
 
-pub struct Room {
-    matrix_room: matrix_sdk::room::Joined,
-    name: String,
-    encrypted: bool,
-    timeline: Vec<AnyTimelineEvent>,
-    timeline_end: Option<String>,
-    view_scroll: Option<usize>,
-}
-
 pub struct StatusMessage {
     content: String,
     is_error: bool,
@@ -67,12 +67,7 @@ impl StatusMessage {
 
 pub struct Status {
     state: State,
-    account_name: String,
-    account_user_id: String,
 
-    client: Option<Client>,
-    rooms: IndexMap<String, Room>,
-    current_room_id: String,
     status_messages: Vec<StatusMessage>,
 }
 
@@ -82,7 +77,6 @@ impl fmt::Display for State {
             Self::Normal => write!(f, "Normal"),
             Self::Insert => write!(f, "Insert"),
             Self::Command => write!(f, "Command"),
-            Self::Setup => write!(f, "Setup (!! workaround !!)"),
             Self::KeyInputPending {
                 old_state: _,
                 pending_keys: keys,
@@ -91,101 +85,10 @@ impl fmt::Display for State {
     }
 }
 
-impl Room {
-    pub fn new(matrix_room: matrix_sdk::room::Joined) -> Self {
-        Self {
-            matrix_room,
-            name: "".to_string(),
-            encrypted: false,
-            timeline: Vec::new(),
-            timeline_end: None,
-            view_scroll: None,
-        }
-    }
-
-    pub async fn poll_old_timeline(&mut self) -> Result<()> {
-        if let Some(AnyTimelineEvent::State(event)) = &self.timeline.get(0) {
-            if event.event_type() == StateEventType::RoomCreate {
-                return Ok(());
-            }
-        }
-
-        let mut messages_options = MessagesOptions::backward();
-        messages_options = match &self.timeline_end {
-            Some(end) => messages_options.from(end.as_str()),
-            None => messages_options,
-        };
-        let events = self.matrix_room.messages(messages_options).await?;
-        self.timeline_end = events.end;
-
-        for event in events.chunk.iter() {
-            self.timeline.insert(
-                0,
-                match event.event.deserialize() {
-                    Ok(ev) => ev,
-                    Err(err) => {
-                        warn!("Failed to deserialize timeline event - {err}");
-                        continue;
-                    }
-                },
-            );
-        }
-        Ok(())
-    }
-
-    pub fn name(&self) -> &String {
-        &self.name
-    }
-
-    pub async fn update_name(&mut self) -> Result<()> {
-        self.name = self.matrix_room.display_name().await?.to_string();
-        Ok(())
-    }
-
-    pub fn timeline_add(&mut self, event: AnyTimelineEvent) {
-        self.timeline.push(event);
-    }
-
-    pub fn timeline(&self) -> &Vec<AnyTimelineEvent> {
-        &self.timeline
-    }
-
-    pub async fn send(&mut self, message: String) -> Result<()> {
-        let content = RoomMessageEventContent::text_plain(message);
-        let id = TransactionId::new();
-        self.matrix_room.send(content, Some(&id)).await?;
-        Ok(())
-    }
-
-    pub fn view_scroll(&self) -> Option<usize> {
-        self.view_scroll
-    }
-
-    pub fn set_view_scroll(&mut self, scroll: Option<usize>) {
-        self.view_scroll = scroll;
-    }
-
-    pub fn encrypted(&self) -> bool {
-        self.matrix_room.is_encrypted()
-    }
-}
-
 impl Status {
-    pub fn new(client: Option<Client>) -> Self {
+    pub fn new() -> Self {
-        let mut rooms = IndexMap::new();
-        if let Some(c) = &client {
-            for r in c.joined_rooms() {
-                rooms.insert(r.room_id().to_string(), Room::new(r.clone()));
-            }
-        };
-
         Self {
-            state: State::Normal,
+            state: State::default(),
-            account_name: "".to_owned(),
-            account_user_id: "".to_owned(),
-            client,
-            rooms,
-            current_room_id: "".to_owned(),
             status_messages: vec![StatusMessage {
                 content: "Initialized!".to_owned(),
                 is_error: false,
@@ -215,70 +118,6 @@ impl Status {
         &self.status_messages
     }
 
-    pub fn account_name(&self) -> &String {
-        &self.account_name
-    }
-
-    pub fn set_account_name(&mut self, name: String) {
-        self.account_name = name;
-    }
-
-    pub fn account_user_id(&self) -> &String {
-        &self.account_user_id
-    }
-
-    pub fn set_account_user_id(&mut self, user_id: String) {
-        self.account_user_id = user_id;
-    }
-
-    pub fn room(&self) -> Option<&Room> {
-        self.rooms.get(self.current_room_id.as_str())
-    }
-
-    pub fn room_mut(&mut self) -> Option<&mut Room> {
-        self.rooms.get_mut(self.current_room_id.as_str())
-    }
-
-    pub fn rooms(&self) -> &IndexMap<String, Room> {
-        &self.rooms
-    }
-
-    pub fn rooms_mut(&mut self) -> &mut IndexMap<String, Room> {
-        &mut self.rooms
-    }
-
-    pub fn set_room(&mut self, room_id: &RoomId) -> Result<()> {
-        if self.rooms.contains_key(room_id.as_str()) {
-            self.current_room_id = room_id.to_string();
-            Ok(())
-        } else {
-            Err(Error::msg(format!(
-                "failed to set room -> invalid room id {}",
-                room_id.to_string()
-            )))
-        }
-    }
-
-    pub fn set_room_by_index(&mut self, room_index: usize) -> Result<()> {
-        if let Some((room_id, _)) = self.rooms.get_index(room_index) {
-            self.current_room_id = room_id.clone();
-            Ok(())
-        } else {
-            Err(Error::msg(format!(
-                "failed to set room -> invalid room index {}",
-                room_index
-            )))
-        }
-    }
-
-    pub fn get_room(&self, room_id: &RoomId) -> Option<&Room> {
-        self.rooms.get(room_id.as_str())
-    }
-
-    pub fn get_room_mut(&mut self, room_id: &RoomId) -> Option<&mut Room> {
-        self.rooms.get_mut(room_id.as_str())
-    }
-
     pub fn state(&self) -> &State {
         &self.state
     }

src/app/storage/accounts.rs

@@ -0,0 +1,82 @@
+use anyhow::Result;
+use sqlx::{FromRow, SqlitePool};
+use std::collections::HashMap;
+use std::convert::TryInto;
+use uuid::Uuid;
+
+#[derive(Debug, FromRow)]
+pub struct RawAccount {
+    id: Vec<u8>,
+    cbs: Vec<u8>,
+}
+
+#[derive(Debug, Clone)]
+pub struct Account {
+    id: Uuid,
+    cbs: Uuid,
+}
+
+impl From<Account> for RawAccount {
+    fn from(value: Account) -> Self {
+        Self {
+            id: value.id.into_bytes().to_vec(),
+            cbs: value.cbs.into_bytes().to_vec(),
+        }
+    }
+}
+
+impl TryFrom<RawAccount> for Account {
+    type Error = anyhow::Error;
+    fn try_from(value: RawAccount) -> std::result::Result<Self, Self::Error> {
+        Ok(Self {
+            id: Uuid::from_slice(value.id.as_slice())?,
+            cbs: Uuid::from_slice(value.cbs.as_slice())?,
+        })
+    }
+}
+
+#[derive(Debug)]
+pub struct Accounts {
+    pool: SqlitePool,
+    accounts: HashMap<Uuid, Account>,
+}
+
+impl Accounts {
+    pub async fn new(pool: SqlitePool) -> Result<Self> {
+        sqlx::query(
+            r#"CREATE TABLE IF NOT EXIST Accounts (
+                id      BINARY(16)      PRIMARY KEY,
+                cbs     BINARY(16)
+            );"#,
+        )
+        .execute(&pool)
+        .await?;
+
+        let raw_accounts: Vec<RawAccount> = sqlx::query_as(r#"SELECT * FROM Accounts;"#)
+            .fetch_all(&pool)
+            .await?;
+        let mut accounts = HashMap::new();
+        for account in raw_accounts {
+            let account: Account = account.try_into()?;
+            accounts.insert(account.id, account);
+        }
+
+        Ok(Self { pool, accounts })
+    }
+
+    pub async fn add(&mut self, id: Uuid, cbs: Uuid) -> Result<()> {
+        let account = Account { id, cbs };
+
+        self.accounts.insert(id, account.clone());
+
+        let raw: RawAccount = account.into();
+
+        sqlx::query(r#"INSERT INTO Accounts VALUES ?, ?;"#)
+            .bind(raw.id)
+            .bind(raw.cbs)
+            .execute(&self.pool)
+            .await?;
+
+        Ok(())
+    }
+}

src/app/storage/backends.rs

@@ -0,0 +1,76 @@
+use anyhow::Result;
+use sqlx::{FromRow, SqlitePool};
+use std::collections::HashMap;
+use std::convert::TryInto;
+use uuid::Uuid;
+
+#[derive(Debug, FromRow)]
+pub struct RawBackend {
+    id: Vec<u8>,
+}
+
+#[derive(Debug, Clone)]
+pub struct Backend {
+    id: Uuid,
+}
+
+impl From<Backend> for RawBackend {
+    fn from(value: Backend) -> Self {
+        Self {
+            id: value.id.into_bytes().to_vec(),
+        }
+    }
+}
+
+impl TryFrom<RawBackend> for Backend {
+    type Error = anyhow::Error;
+    fn try_from(value: RawBackend) -> std::result::Result<Self, Self::Error> {
+        Ok(Self {
+            id: Uuid::from_slice(value.id.as_slice())?,
+        })
+    }
+}
+
+#[derive(Debug)]
+pub struct Backends {
+    pool: SqlitePool,
+    backends: HashMap<Uuid, Backend>,
+}
+
+impl Backends {
+    pub async fn new(pool: SqlitePool) -> Result<Self> {
+        sqlx::query(
+            r#"CREATE TABLE IF NOT EXIST Backends (
+                id      BINARY(16)      PRIMARY KEY
+            );"#,
+        )
+        .execute(&pool)
+        .await?;
+
+        let raw_backends: Vec<RawBackend> = sqlx::query_as(r#"SELECT * FROM Backends;"#)
+            .fetch_all(&pool)
+            .await?;
+        let mut backends = HashMap::new();
+        for backend in raw_backends {
+            let backend: Backend = backend.try_into()?;
+            backends.insert(backend.id, backend);
+        }
+
+        Ok(Self { pool, backends })
+    }
+
+    pub async fn add(&mut self, id: Uuid) -> Result<()> {
+        let backend = Backend { id };
+
+        self.backends.insert(id, backend.clone());
+
+        let raw: RawBackend = backend.into();
+
+        sqlx::query(r#"INSERT INTO Backends VALUES ?;"#)
+            .bind(raw.id)
+            .execute(&self.pool)
+            .await?;
+
+        Ok(())
+    }
+}

src/app/storage/mod.rs

@@ -0,0 +1,54 @@
+mod accounts;
+mod backends;
+
+pub use accounts::{Account, Accounts};
+pub use backends::{Backend, Backends};
+
+use anyhow::{Context, Result};
+use directories::ProjectDirs;
+use sqlx::SqlitePool;
+
+const DATABASE_NAME: &str = "storage.sqlite";
+const PROJECT_DIRS: (&str, &str, &str) = ("", "", "trinitrix");
+
+pub struct Storage {
+    project_dirs: ProjectDirs,
+    accounts: Accounts,
+    backends: Backends,
+}
+
+impl Storage {
+    pub async fn new() -> Result<Self> {
+        let project_dirs = ProjectDirs::from("", "", "trinitrix").context(
+            "Failed to allocate project directory paths, please ensure your $HOME is set correctly",
+        )?;
+
+        let pool = SqlitePool::connect(&format!(
+            "sqlite:{}/{}",
+            project_dirs.data_dir().to_string_lossy(),
+            DATABASE_NAME
+        ))
+        .await?;
+
+        let accounts = Accounts::new(pool.clone()).await?;
+        let backends = Backends::new(pool).await?;
+
+        Ok(Self {
+            project_dirs,
+            accounts,
+            backends,
+        })
+    }
+
+    pub fn project_dirs(&self) -> &ProjectDirs {
+        &self.project_dirs
+    }
+
+    pub fn accounts(&self) -> &Accounts {
+        &self.accounts
+    }
+
+    pub fn backends(&self) -> &Backends {
+        &self.backends
+    }
+}

src/bin/api.rs

@@ -1,3 +1,24 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 fn main() {
     let output = include_str!(concat!(env!("OUT_DIR"), "/api.rs"));
     println!("{}", output);

src/cbs/connection.rs

@@ -0,0 +1,206 @@
+use crate::app::events::{ErrorEvent as AppErrorEvent, Event as AppEvent};
+
+use aes_gcm_siv::{Aes256GcmSiv, Nonce};
+use anyhow::{anyhow, Context, Result};
+use interprocess::local_socket::tokio::{RecvHalf, SendHalf};
+use tokio::sync::mpsc;
+use tokio_util::sync::CancellationToken;
+use triba_packet::{IdPool, Packet, Request, Response};
+use uuid::Uuid;
+
+enum Event {
+    ToCBSReq(Request),
+    ToCBSResp(Response, u64),
+    FromCBS(Packet),
+}
+
+pub struct Connection {
+    tx: mpsc::UnboundedSender<Event>,
+}
+
+impl Connection {
+    pub async fn send_request(&self, body: Request) -> Result<()> {
+        self.tx.send(Event::ToCBSReq(body))?;
+        Ok(())
+    }
+
+    pub async fn send_response(&self, body: Response, receiver: u64) -> Result<()> {
+        self.tx.send(Event::ToCBSResp(body, receiver))?;
+        Ok(())
+    }
+}
+
+pub struct UnstableConnection {
+    kill_token: CancellationToken,
+    id: Uuid,
+    main_tx: mpsc::Sender<AppEvent>,
+}
+
+impl UnstableConnection {
+    pub fn new(kill_token: CancellationToken, id: Uuid, main_tx: mpsc::Sender<AppEvent>) -> Self {
+        Self {
+            kill_token,
+            id,
+            main_tx,
+        }
+    }
+
+    pub async fn stabilize(
+        &self,
+        cipher: Aes256GcmSiv,
+        nonce: Nonce,
+        mut sock_rx: RecvHalf,
+        mut sock_tx: SendHalf,
+    ) -> Result<Connection> {
+        let (tx, mut rx) = mpsc::unbounded_channel();
+
+        let mut id_pool = IdPool::new();
+
+        let packet = Packet::recv(&mut sock_rx, &cipher, &nonce).await?;
+        match packet {
+            Packet::Request { id, body } => {
+                match body {
+                    Request::HandshakeUpgradeConnection => {
+                        Packet::response(id_pool.acquire(), id, Response::Success)
+                            .send(&mut sock_tx, &cipher, &nonce)
+                            .await?;
+
+                        cli_log::info!(
+                            "CBS {id}: upgraded connection to encrypted messagepack",
+                            id = self.id
+                        );
+                    }
+                    req => return Err(anyhow!(
+                        "expected cbs to send: Request::HandshakeUpgradeConnection, but got: Request::{req}"
+                    ))
+                }
+            }
+            body => {
+                return Err(anyhow!(
+                    "expected cbs to send: Request::HandshakeUpgradeConnection, but got: {body}"
+                ))
+            }
+        }
+
+        Packet::request(id_pool.acquire(), Request::HandshakeSuccess)
+            .send(&mut sock_tx, &cipher, &nonce)
+            .await?;
+
+        match Packet::recv(&mut sock_rx, &cipher, &nonce).await? {
+            Packet::Response { body, .. } => match body {
+                Response::Success => {}
+                req => {
+                    return Err(anyhow!(
+                        "expected cbs to send: Response::Success, but got: Request::{req}"
+                    ))
+                }
+            },
+            body => {
+                return Err(anyhow!(
+                    "expected cbs to send: Request::Success, but got: {body}"
+                ))
+            }
+        }
+
+        // Poll packets from socket
+        {
+            let cipher = cipher.clone();
+            let nonce = nonce.clone();
+            let tx = tx.clone();
+
+            let id = self.id.clone();
+            let main_tx = self.main_tx.clone();
+
+            tokio::spawn(async move {
+                match poll_from_socket(&mut sock_rx, &cipher, &nonce, tx).await {
+                    Err(e) => main_tx
+                        .send(AppEvent::Error(AppErrorEvent::CBSCrash(id, e)))
+                        .await
+                        .expect("Failed to propagate error back to main queue."),
+                    Ok(_) => (),
+                }
+            });
+        }
+
+        // Handle and route all packets
+        {
+            let cipher = cipher.clone();
+            let nonce = nonce.clone();
+            let kill_token = self.kill_token.clone();
+            let main_tx = self.main_tx.clone();
+            let id = self.id.clone();
+
+            tokio::spawn(async move {
+                match route_packets(
+                    rx,
+                    kill_token,
+                    id_pool,
+                    &mut sock_tx,
+                    &cipher,
+                    &nonce,
+                    main_tx.clone(),
+                    id,
+                )
+                .await
+                {
+                    Err(e) => main_tx
+                        .send(AppEvent::Error(AppErrorEvent::CBSCrash(id, e)))
+                        .await
+                        .expect("Failed to propagate error back to main queue."),
+                    Ok(_) => (),
+                }
+            });
+        }
+
+        Ok(Connection { tx })
+    }
+}
+
+async fn poll_from_socket(
+    rx: &mut RecvHalf,
+    cipher: &Aes256GcmSiv,
+    nonce: &Nonce,
+    tx: mpsc::UnboundedSender<Event>,
+) -> Result<()> {
+    loop {
+        let packet = Packet::recv(rx, cipher, nonce).await?;
+        tx.send(Event::FromCBS(packet))?;
+    }
+}
+
+async fn route_packets(
+    mut rx: mpsc::UnboundedReceiver<Event>,
+    kill_token: CancellationToken,
+    mut id_pool: IdPool,
+    sock_tx: &mut SendHalf,
+    cipher: &Aes256GcmSiv,
+    nonce: &Nonce,
+    main_tx: mpsc::Sender<AppEvent>,
+    id: Uuid,
+) -> Result<()> {
+    loop {
+        let event = tokio::select! {
+            event = rx.recv() => event.context("The cbs event queue was closed unexpectedly.")?,
+            _ = kill_token.cancelled() => break,
+        };
+
+        match event {
+            Event::ToCBSReq(req) => {
+                Packet::request(id_pool.acquire(), req)
+                    .send(sock_tx, cipher, nonce)
+                    .await?;
+            }
+            Event::ToCBSResp(resp, req) => {
+                Packet::response(id_pool.acquire(), req, resp)
+                    .send(sock_tx, cipher, nonce)
+                    .await?;
+            }
+            Event::FromCBS(packet) => {
+                main_tx
+                    .send(AppEvent::CBSPacket(id.clone(), packet))
+                    .await?
+            }
+        }
+    }
+    Ok(())
+}

src/cbs/dummy.rs

@@ -0,0 +1,10 @@
+use interprocess::local_socket::Name;
+use uuid::Uuid;
+
+pub async fn cbs(sock_name: Name<'_>, id: Uuid) {
+    let (session, rx) = triba::Session::new(id, sock_name).await.unwrap();
+
+    loop {
+        tokio::task::yield_now().await;
+    }
+}

src/cbs/manager.rs

@@ -0,0 +1,195 @@
+use super::{Connection, UnstableConnection};
+use crate::app::events::Event as AppEvent;
+
+use aes_gcm_siv::{Aes256GcmSiv, KeyInit, Nonce};
+use anyhow::{anyhow, Result};
+use interprocess::local_socket::{
+    self,
+    tokio::{prelude::*, Stream},
+    GenericFilePath, GenericNamespaced, ListenerOptions,
+};
+use rand::{
+    distributions::Alphanumeric,
+    {thread_rng, Rng},
+};
+use std::collections::HashMap;
+use tokio::{
+    io::{AsyncReadExt, AsyncWriteExt, BufReader},
+    sync::{mpsc, oneshot},
+};
+use tokio_util::sync::CancellationToken;
+use triba_packet::{Request, Response};
+use uuid::Uuid;
+use x25519_dalek::{EphemeralSecret, PublicKey};
+
+enum Event {
+    IncomingConnection(Stream),
+    SpawnCBS(oneshot::Sender<Result<Uuid>>),
+    SendRequest(Uuid, Request),
+    SendResponse(Uuid, Response, u64),
+}
+
+async fn poll_socket(
+    sock_name: local_socket::Name<'_>,
+    tx: mpsc::UnboundedSender<Event>,
+) -> Result<()> {
+    let listener = ListenerOptions::new()
+        .name(sock_name)
+        .create_tokio()
+        .unwrap();
+
+    loop {
+        let stream = listener.accept().await?;
+        tx.send(Event::IncomingConnection(stream)).unwrap();
+    }
+}
+
+async fn handle_incoming(
+    stream: Stream,
+    connections: &mut HashMap<Uuid, (UnstableConnection, oneshot::Sender<Result<Uuid>>)>,
+) -> Result<(Uuid, Connection)> {
+    let (raw_rx, mut tx) = stream.split();
+    let mut rx = BufReader::new(&raw_rx);
+
+    let id = {
+        let mut buffer = [0u8; 16];
+        rx.read(&mut buffer).await?;
+        Uuid::from_bytes(buffer)
+    };
+
+    cli_log::info!("Received CBS connection with id: {id}");
+
+    let conn = match connections.get(&id) {
+        Some((conn, _)) => conn,
+        None => {
+            return Err(anyhow!("The CBS id {id} is unknown."));
+        }
+    };
+
+    let dh_own_secret = EphemeralSecret::random_from_rng(thread_rng());
+    let dh_own_public = PublicKey::from(&dh_own_secret);
+
+    tx.write(dh_own_public.as_bytes()).await?;
+
+    let dh_cbs_public = {
+        let mut buffer = [0u8; 32];
+        rx.read(&mut buffer).await?;
+        PublicKey::from(buffer)
+    };
+
+    let shared_secret = dh_own_secret.diffie_hellman(&dh_cbs_public);
+
+    let nonce = Nonce::from(rand::random::<[u8; 12]>());
+    tx.write(nonce.as_slice()).await?;
+
+    let cipher = Aes256GcmSiv::new(shared_secret.as_bytes().into());
+
+    let conn = conn.stabilize(cipher, nonce, raw_rx, tx).await?;
+
+    Ok((id, conn))
+}
+
+pub struct Manager {
+    tx: mpsc::UnboundedSender<Event>,
+}
+
+impl Manager {
+    pub async fn new(main_tx: mpsc::Sender<AppEvent>) -> Self {
+        let (tx, mut rx) = mpsc::unbounded_channel();
+
+        let sock_name = {
+            let suffix = thread_rng()
+                .sample_iter(&Alphanumeric)
+                .take(30)
+                .map(char::from)
+                .collect::<String>();
+
+            if GenericNamespaced::is_supported() {
+                format!("example_{suffix}.sock")
+                    .to_ns_name::<GenericNamespaced>()
+                    .unwrap()
+            } else {
+                format!("/tmp/example_{suffix}.sock")
+                    .to_fs_name::<GenericFilePath>()
+                    .unwrap()
+            }
+        };
+
+        // Start socket connection listener
+        tokio::spawn(poll_socket(sock_name.clone(), tx.clone()));
+
+        tokio::spawn(async move {
+            let mut unstable_connections: HashMap<
+                Uuid,
+                (UnstableConnection, oneshot::Sender<Result<Uuid>>),
+            > = HashMap::new();
+            let mut connections: HashMap<Uuid, Connection> = HashMap::new();
+
+            loop {
+                match rx.recv().await.unwrap() {
+                    Event::IncomingConnection(stream) => {
+                        match handle_incoming(stream, &mut unstable_connections).await {
+                            Ok((id, conn)) => {
+                                let (_, tx) = unstable_connections.remove(&id).unwrap();
+                                connections.insert(id, conn);
+
+                                tx.send(Ok(id)).unwrap();
+                                cli_log::info!("CBS {id}: Connection stabilized.")
+                            }
+                            Err(e) => {
+                                cli_log::error!("Handshake failed: {e}");
+                            }
+                        }
+                    }
+                    Event::SpawnCBS(tx) => {
+                        let id = Uuid::new_v4();
+                        unstable_connections.insert(
+                            id,
+                            (
+                                UnstableConnection::new(
+                                    CancellationToken::new(),
+                                    id,
+                                    main_tx.clone(),
+                                ),
+                                tx,
+                            ),
+                        );
+
+                        cli_log::info!("Spawned CBS with ID: {id}");
+
+                        // Start dummy cbs
+                        let sock_name = sock_name.clone();
+                        tokio::spawn(super::dummy::cbs(sock_name.clone(), id));
+                    }
+                    Event::SendRequest(id, body) => {
+                        let conn = connections.get(&id).unwrap();
+                        conn.send_request(body).await.unwrap();
+                    }
+                    Event::SendResponse(id, body, req) => {
+                        let conn = connections.get(&id).unwrap();
+                        conn.send_response(body, req).await.unwrap();
+                    }
+                }
+            }
+        });
+
+        Self { tx }
+    }
+
+    pub async fn spawn_cbs(&self) -> Result<Uuid> {
+        let (tx, rx) = oneshot::channel();
+
+        self.tx.send(Event::SpawnCBS(tx))?;
+        rx.await?
+    }
+
+    pub fn send_request(&self, cbs: Uuid, body: Request) -> Result<()> {
+        self.tx.send(Event::SendRequest(cbs, body))?;
+        Ok(())
+    }
+
+    pub fn send_response(&self, cbs: Uuid, body: Response, receiver: u64) -> Result<()> {
+        self.tx.send(Event::SendResponse(cbs, body, receiver))?;
+        Ok(())
+    }
+}

src/cbs/mod.rs

@@ -0,0 +1,9 @@
+pub mod connection;
+mod dummy;
+pub mod manager;
+
+// TODO: This whole module uses hell a lot of unwraps,
+//       which need to be replaced by proper error handling.     - antifallobst  2024-05-14
+
+pub use connection::{Connection, UnstableConnection};
+pub use manager::Manager;

src/cli.rs

@@ -1,16 +1,35 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 use std::path::PathBuf;
 
 use clap::{Parser, Subcommand};
 
-// TODO: The description is wrong
+/// A multi protocol chat client
-
-/// A terminal client for the matrix chat protocol
 #[derive(Parser, Debug)]
-#[command(author, version, about, long_about = None)]
+#[command(author, version, about, long_about = None, arg_required_else_help(true))]
 pub struct Args {
     #[command(subcommand)]
-    /// The subcommand to execute, default is start
+    /// The subcommand to execute, default is help
-    pub subcommand: Option<Command>,
+    pub subcommand: Command,
 
     // #[arg(long, short)]
     // /// Path to the Lua config file, executed instead of the normal one
@@ -21,6 +40,9 @@ pub struct Args {
 }
 #[derive(Subcommand, Debug)]
 pub enum Command {
-    /// Starts the main TUI client
+    /// Starts a TUI client
-    Start {},
+    Tui {},
+
+    /// Starts a repl to the trinitry cli interpreter
+    Repl {},
 }

src/main.rs

@@ -1,23 +1,53 @@
-mod accounts;
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 mod app;
+mod cbs;
 mod cli;
 mod ui;
 
+use anyhow::Context;
 use clap::Parser;
 
-use crate::cli::{Args, Command};
+use crate::{
+    cli::{Args, Command},
+    ui::{repl::Repl, tui::Tui},
+};
 
 #[tokio::main]
 async fn main() -> anyhow::Result<()> {
     cli_log::init_cli_log!();
 
     let args = Args::parse();
-    let command = args.subcommand.unwrap_or(Command::Start {});
+    match args.subcommand {
-    match command {
+        Command::Tui {} => {
-        Command::Start {} => {
+            let mut app = app::App::new(Tui::new().context("Failed to setup tui")?).await?;
-            let mut app = app::App::new()?;
 
-            // NOTE(@soispha): The `None` is temporary <2024-05-03>
+            // NOTE(@soispha): The `None` here is temporary <2024-05-08>
+            app.run(None, args.plugin_path).await?;
+        }
+        Command::Repl {} => {
+            let mut app = app::App::new(Repl::new().context("Failed to setup repl")?).await?;
+
+            // NOTE(@soispha): The `None` here is temporary <2024-05-03>
             app.run(None, args.plugin_path).await?;
         }
     };

src/ui/central/update/widgets/messages.rs

@@ -1,109 +0,0 @@
-use anyhow::{Context, Result};
-use matrix_sdk::ruma::events::{AnyMessageLikeEvent, AnyTimelineEvent};
-use tui::{
-    layout::Corner,
-    style::{Color, Modifier, Style},
-    text::{Span, Spans, Text},
-    widgets::{Block, Borders, List, ListItem, ListState},
-};
-
-use crate::{app::status::Room, ui::central::InputPosition};
-
-pub fn init<'a>(room: Option<&'a Room>, colors: &Vec<Color>) -> Result<(List<'a>, ListState)> {
-    let content = match room {
-        Some(room) => get_content_from_room(room).context("Failed to get content from room")?,
-        None => vec![ListItem::new(Text::styled(
-            "No room selected!",
-            Style::default().fg(Color::Red),
-        ))],
-    };
-
-    let mut messages_state = ListState::default();
-
-    if let Some(room) = room {
-        messages_state.select(room.view_scroll());
-    }
-
-    Ok((
-        List::new(content)
-            .block(
-                Block::default()
-                    .title("Messages")
-                    .borders(Borders::ALL)
-                    .style(Style::default().fg(colors[InputPosition::Messages as usize])),
-            )
-            .start_corner(Corner::BottomLeft)
-            .highlight_symbol(">")
-            .highlight_style(
-                Style::default()
-                    .fg(Color::LightMagenta)
-                    .add_modifier(Modifier::BOLD),
-            ),
-        messages_state,
-    ))
-}
-
-fn get_content_from_room(room: &Room) -> Result<Vec<ListItem>> {
-    let results: Vec<Result<ListItem>> = room
-        .timeline()
-        .iter()
-        .rev()
-        .map(|event| filter_event(event).context("Failed to filter event"))
-        .collect();
-
-    let mut output = Vec::with_capacity(results.len());
-    for result in results {
-        output.push(result?);
-    }
-    Ok(output)
-}
-
-fn filter_event<'a>(event: &AnyTimelineEvent) -> Result<ListItem<'a>> {
-    match event {
-        // Message Like Events
-        AnyTimelineEvent::MessageLike(message_like_event) => {
-            let (content, color) = match &message_like_event {
-                AnyMessageLikeEvent::RoomMessage(room_message_event) => {
-                    let message_content = &room_message_event
-                        .as_original()
-                        .context("Failed to get inner original message_event")?
-                        .content
-                        .body();
-
-                    (message_content.to_string(), Color::White)
-                }
-                _ => (
-                    format!(
-                        "~~~ not supported message like event: {} ~~~",
-                        message_like_event.event_type().to_string()
-                    ),
-                    Color::Red,
-                ),
-            };
-            let mut text = Text::styled(
-                message_like_event.sender().to_string(),
-                Style::default()
-                    .fg(Color::Cyan)
-                    .add_modifier(Modifier::BOLD),
-            );
-            text.extend(Text::styled(
-                content.to_string(),
-                Style::default().fg(color),
-            ));
-            Ok(ListItem::new(text))
-        }
-
-        // State Events
-        AnyTimelineEvent::State(state) => Ok(ListItem::new(vec![Spans::from(vec![
-            Span::styled(
-                state.sender().to_string(),
-                Style::default().fg(Color::DarkGray),
-            ),
-            Span::styled(": ", Style::default().fg(Color::DarkGray)),
-            Span::styled(
-                state.event_type().to_string(),
-                Style::default().fg(Color::DarkGray),
-            ),
-        ])])),
-    }
-}

src/ui/central/update/widgets/mod.rs

@@ -1,5 +0,0 @@
-pub mod command_monitor;
-pub mod messages;
-pub mod room_info;
-pub mod rooms;
-pub mod status;

src/ui/central/update/widgets/room_info.rs

@@ -1,37 +0,0 @@
-use tui::{
-    layout::Alignment,
-    style::{Color, Style},
-    text::Text,
-    widgets::{Block, Borders, Paragraph},
-};
-
-use crate::{app::status::Room, ui::central::InputPosition};
-
-pub fn init<'a>(room: Option<&'a Room>, colors: &Vec<Color>) -> Paragraph<'a> {
-    let mut room_info_content = Text::default();
-    if let Some(room) = room {
-        room_info_content.extend(Text::styled(room.name(), Style::default().fg(Color::Cyan)));
-        if room.encrypted() {
-            room_info_content.extend(Text::styled("Encrypted", Style::default().fg(Color::Green)));
-        } else {
-            room_info_content.extend(Text::styled(
-                "Not Encrypted!",
-                Style::default().fg(Color::Red),
-            ));
-        }
-    } else {
-        room_info_content.extend(Text::styled(
-            "No room selected!",
-            Style::default().fg(Color::Red),
-        ));
-    }
-
-    Paragraph::new(room_info_content)
-        .block(
-            Block::default()
-                .title("Room Info")
-                .borders(Borders::ALL)
-                .style(Style::default().fg(colors[InputPosition::RoomInfo as usize])),
-        )
-        .alignment(Alignment::Center)
-}

src/ui/central/update/widgets/rooms.rs

@@ -1,29 +0,0 @@
-use tui::{
-    style::{Color, Modifier, Style},
-    text::Span,
-    widgets::{Block, Borders, List, ListItem},
-};
-
-use crate::{app::status::Status, ui::central::InputPosition};
-
-pub fn init<'a>(status: &'a Status, colors: &Vec<Color>) -> List<'a> {
-    let rooms_content: Vec<_> = status
-        .rooms()
-        .iter()
-        .map(|(_, room)| ListItem::new(Span::styled(room.name(), Style::default())))
-        .collect();
-    List::new(rooms_content)
-        .block(
-            Block::default()
-                .title("Rooms (navigate: arrow keys)")
-                .borders(Borders::ALL)
-                .style(Style::default().fg(colors[InputPosition::Rooms as usize])),
-        )
-        .style(Style::default().fg(Color::DarkGray))
-        .highlight_style(
-            Style::default()
-                .fg(Color::Cyan)
-                .add_modifier(Modifier::BOLD),
-        )
-        .highlight_symbol(">")
-}

src/ui/central/update/widgets/status.rs

@@ -1,30 +0,0 @@
-use tui::{
-    layout::Alignment,
-    style::{Color, Modifier, Style},
-    text::Text,
-    widgets::{Block, Borders, Paragraph},
-};
-
-use crate::{app::status::Status, ui::central::InputPosition};
-
-pub fn init<'a>(status: &'a Status, colors: &Vec<Color>) -> Paragraph<'a> {
-    let mut status_content = Text::styled(
-        status.account_name(),
-        Style::default().add_modifier(Modifier::BOLD),
-    );
-    status_content.extend(Text::styled(status.account_user_id(), Style::default()));
-    status_content.extend(Text::styled(
-        "settings",
-        Style::default()
-            .fg(Color::LightMagenta)
-            .add_modifier(Modifier::ITALIC | Modifier::UNDERLINED),
-    ));
-    Paragraph::new(status_content)
-        .block(
-            Block::default()
-                .title("Status")
-                .borders(Borders::ALL)
-                .style(Style::default().fg(colors[InputPosition::Status as usize])),
-        )
-        .alignment(Alignment::Left)
-}

src/ui/mod.rs

@@ -1,45 +1,24 @@
-pub mod central;
+/*
-pub mod setup;
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
 
-use std::{io, io::Stdout};
+pub mod repl;
-
+pub mod tui;
-use anyhow::{Context, Result};
+pub mod ui_trait;
-use cli_log::info;
-use crossterm::{
-    event::EnableMouseCapture,
-    execute,
-    terminal::{enable_raw_mode, EnterAlternateScreen},
-};
-use tui::{
-    style::{Color, Modifier, Style},
-    widgets::{Block, Borders},
-};
-use tui_textarea::TextArea;
-
-fn terminal_prepare() -> Result<Stdout> {
-    enable_raw_mode().context("Failed to enable raw mode")?;
-    let mut stdout = io::stdout();
-    execute!(stdout, EnterAlternateScreen, EnableMouseCapture)?;
-    info!("Prepared terminal");
-    Ok(stdout)
-}
-
-pub fn textarea_activate(textarea: &mut TextArea) {
-    textarea.set_cursor_line_style(Style::default().add_modifier(Modifier::UNDERLINED));
-    textarea.set_cursor_style(Style::default().add_modifier(Modifier::REVERSED));
-    let b = textarea
-        .block()
-        .cloned()
-        .unwrap_or_else(|| Block::default().borders(Borders::ALL));
-    textarea.set_block(b.style(Style::default()));
-}
-
-pub fn textarea_inactivate(textarea: &mut TextArea) {
-    textarea.set_cursor_line_style(Style::default());
-    textarea.set_cursor_style(Style::default());
-    let b = textarea
-        .block()
-        .cloned()
-        .unwrap_or_else(|| Block::default().borders(Borders::ALL));
-    textarea.set_block(b.style(Style::default().fg(Color::DarkGray)));
-}

src/ui/repl/mod.rs

@@ -0,0 +1,153 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
+use std::io::{self, Stdout, Write};
+
+use anyhow::{Context, Result};
+use cli_log::{debug, info};
+use crossterm::{
+    execute,
+    terminal::{disable_raw_mode, enable_raw_mode, EnableLineWrap},
+};
+use keymaps::key_repr::{Key, KeyValue};
+
+use crate::{
+    app::status::{State, Status},
+    ui::ui_trait::TrinitrixUi,
+};
+
+pub struct Repl {
+    current_written_buffer: String,
+    current_input: String,
+    enter_new_line: bool,
+    stdout: Stdout,
+}
+
+impl Repl {
+    pub fn new() -> Result<Self> {
+        enable_raw_mode().context("Failed to enable raw mode")?;
+        let mut stdout = io::stdout();
+
+        write!(
+            stdout,
+            "Welcome to the Trinitrix repl! You can now enter trinitry commands."
+        )?;
+        write!(stdout, "\n\r{}", Self::prompt(&Status::new()))?;
+        stdout.flush()?;
+
+        Ok(Repl {
+            current_written_buffer: String::new(),
+            current_input: String::new(),
+            enter_new_line: false,
+            stdout,
+        })
+    }
+    pub fn prompt(status: &Status) -> String {
+        format!("{}> ", status.state())
+    }
+}
+
+impl Drop for Repl {
+    fn drop(&mut self) {
+        disable_raw_mode().expect("Must work in drop");
+        execute!(io::stdout(), EnableLineWrap).expect("Must also work");
+
+        writeln!(self.stdout, "\n\rBye!").expect("Must also work");
+    }
+}
+
+impl TrinitrixUi for Repl {
+    async fn update(&mut self, status: &Status) -> Result<()> {
+        if self.enter_new_line {
+            info!("Got '{}' from user in repl.", self.current_written_buffer);
+
+            if status.state() == &State::Command {
+                write!(
+                    self.stdout,
+                    "\n\rEvaluating: '{}' ..",
+                    self.current_written_buffer
+                )?;
+            } else {
+                write!(
+                    self.stdout,
+                    "\n\rCan't insert anything in the repl besides in command mode!",
+                )?;
+            }
+
+            self.enter_new_line = false;
+            self.current_written_buffer.clear();
+
+            write!(self.stdout, "\n\r{}", Self::prompt(status))?;
+        } else {
+            write!(
+                self.stdout,
+                "\r{}{}{}",
+                Self::prompt(status),
+                self.current_written_buffer,
+                self.current_input
+            )?;
+
+            self.current_written_buffer += self.current_input.as_str();
+            self.current_input.clear();
+        }
+        self.stdout.flush()?;
+
+        Ok(())
+    }
+
+    fn input(&mut self, input: Key) {
+        debug!("Input received at repl: {}", input);
+
+        if let Some(value) = input.value() {
+            match value {
+                KeyValue::Backspace => {
+                    self.current_written_buffer.pop();
+                }
+                KeyValue::Enter => self.enter_new_line = true,
+                KeyValue::Left => todo!(),
+                KeyValue::Right => todo!(),
+                KeyValue::Up => todo!(),
+                KeyValue::Down => todo!(),
+                KeyValue::Home => todo!(),
+                KeyValue::End => todo!(),
+                KeyValue::PageUp => todo!(),
+                KeyValue::PageDown => todo!(),
+                KeyValue::Tab => todo!(),
+                KeyValue::BackTab => todo!(),
+                KeyValue::Delete => todo!(),
+                KeyValue::Insert => todo!(),
+                KeyValue::F(_) => todo!(),
+                KeyValue::Char(ch) => self.current_input.push(*ch),
+                KeyValue::Null => todo!(),
+                KeyValue::Esc => todo!(),
+                KeyValue::CapsLock => todo!(),
+                KeyValue::ScrollLock => todo!(),
+                KeyValue::NumLock => todo!(),
+                KeyValue::PrintScreen => todo!(),
+                KeyValue::Pause => todo!(),
+                KeyValue::Menu => todo!(),
+                KeyValue::KeypadBegin => todo!(),
+            }
+        } else {
+            info!("User wrote: '{}'", input.to_string_repr());
+        }
+    }
+}

src/ui/setup.rs

@@ -1,172 +0,0 @@
-use std::io::Stdout;
-
-use anyhow::Result;
-use tui::{
-    backend::CrosstermBackend,
-    layout::{Alignment, Constraint, Direction, Layout},
-    style::{Color, Modifier, Style},
-    text::Span,
-    widgets::{Block, Borders, Paragraph},
-    Terminal,
-};
-use tui_textarea::TextArea;
-
-use crate::ui::{textarea_activate, textarea_inactivate};
-
-pub struct UI<'a> {
-    input_position: InputPosition,
-
-    pub homeserver: TextArea<'a>,
-    pub username: TextArea<'a>,
-    pub password: TextArea<'a>,
-    pub password_data: TextArea<'a>,
-}
-
-#[derive(Clone, Copy)]
-pub enum InputPosition {
-    Homeserver,
-    Username,
-    Password,
-    Ok,
-}
-
-impl UI<'_> {
-    pub fn new() -> Self {
-        let mut homeserver = TextArea::new(vec!["https://matrix.org".to_string()]);
-        let mut username = TextArea::default();
-        let mut password = TextArea::default();
-        let password_data = TextArea::default();
-
-        homeserver.set_block(Block::default().title("Homeserver").borders(Borders::ALL));
-        username.set_block(Block::default().title("Username").borders(Borders::ALL));
-        password.set_block(Block::default().title("Password").borders(Borders::ALL));
-
-        textarea_activate(&mut homeserver);
-        textarea_inactivate(&mut username);
-        textarea_inactivate(&mut password);
-
-        Self {
-            input_position: InputPosition::Homeserver,
-            homeserver,
-            username,
-            password,
-            password_data,
-        }
-    }
-
-    pub fn cycle_input_position(&mut self) {
-        self.input_position = match self.input_position {
-            InputPosition::Homeserver => {
-                textarea_inactivate(&mut self.homeserver);
-                textarea_activate(&mut self.username);
-                textarea_inactivate(&mut self.password);
-                InputPosition::Username
-            }
-            InputPosition::Username => {
-                textarea_inactivate(&mut self.homeserver);
-                textarea_inactivate(&mut self.username);
-                textarea_activate(&mut self.password);
-                InputPosition::Password
-            }
-            InputPosition::Password => {
-                textarea_inactivate(&mut self.homeserver);
-                textarea_inactivate(&mut self.username);
-                textarea_inactivate(&mut self.password);
-                InputPosition::Ok
-            }
-            InputPosition::Ok => {
-                textarea_activate(&mut self.homeserver);
-                textarea_inactivate(&mut self.username);
-                textarea_inactivate(&mut self.password);
-                InputPosition::Homeserver
-            }
-        };
-    }
-
-    pub fn cycle_input_position_rev(&mut self) {
-        self.input_position = match self.input_position {
-            InputPosition::Homeserver => {
-                textarea_inactivate(&mut self.homeserver);
-                textarea_inactivate(&mut self.username);
-                textarea_inactivate(&mut self.password);
-                InputPosition::Ok
-            }
-            InputPosition::Username => {
-                textarea_activate(&mut self.homeserver);
-                textarea_inactivate(&mut self.username);
-                textarea_inactivate(&mut self.password);
-                InputPosition::Homeserver
-            }
-            InputPosition::Password => {
-                textarea_inactivate(&mut self.homeserver);
-                textarea_activate(&mut self.username);
-                textarea_inactivate(&mut self.password);
-                InputPosition::Username
-            }
-            InputPosition::Ok => {
-                textarea_inactivate(&mut self.homeserver);
-                textarea_inactivate(&mut self.username);
-                textarea_activate(&mut self.password);
-                InputPosition::Password
-            }
-        };
-    }
-
-    pub fn input_position(&self) -> &InputPosition {
-        &self.input_position
-    }
-
-    pub async fn update(
-        &mut self,
-        terminal: &mut Terminal<CrosstermBackend<Stdout>>,
-    ) -> Result<()> {
-        let strings: Vec<String> = vec!["".to_owned(); 3];
-
-        let content_ok = match self.input_position {
-            InputPosition::Ok => {
-                Span::styled("OK", Style::default().add_modifier(Modifier::UNDERLINED))
-            }
-            _ => Span::styled("OK", Style::default().fg(Color::DarkGray)),
-        };
-
-        let block = Block::default().title("Login").borders(Borders::ALL);
-
-        let ok = Paragraph::new(content_ok).alignment(Alignment::Center);
-
-        // define a 32 * 6 chunk in the middle of the screen
-        let mut chunk = terminal.size()?;
-        chunk.x = (chunk.width / 2) - 16;
-        chunk.y = (chunk.height / 2) - 5;
-        chunk.height = 12;
-        chunk.width = 32;
-
-        let mut split_chunk = chunk.clone();
-        split_chunk.x += 1;
-        split_chunk.y += 1;
-        split_chunk.height -= 1;
-        split_chunk.width -= 2;
-
-        let chunks = Layout::default()
-            .direction(Direction::Vertical)
-            .constraints(
-                [
-                    Constraint::Length(3), // 0. Homserver:
-                    Constraint::Length(3), // 1. Username:
-                    Constraint::Length(3), // 2. Password:
-                    Constraint::Length(1), // 3.    OK
-                ]
-                .as_ref(),
-            )
-            .split(split_chunk);
-
-        terminal.draw(|frame| {
-            frame.render_widget(block.clone(), chunk);
-            frame.render_widget(self.homeserver.widget(), chunks[0]);
-            frame.render_widget(self.username.widget(), chunks[1]);
-            frame.render_widget(self.password.widget(), chunks[2]);
-            frame.render_widget(ok.clone(), chunks[3]);
-        })?;
-
-        Ok(())
-    }
-}

src/ui/tui/mod.rs

@@ -1,25 +1,48 @@
-pub mod update;
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
+pub mod trinitrixui;
+pub mod utils;
 
 use std::io::Stdout;
 
-use anyhow::{bail, Context, Result};
+use anyhow::{Context, Result};
 use cli_log::{info, warn};
 use crossterm::{
     event::DisableMouseCapture,
     execute,
     terminal::{disable_raw_mode, LeaveAlternateScreen},
 };
-use tui::{
+use ratatui::{
     backend::CrosstermBackend,
     style::Color,
     widgets::{Block, Borders, ListState},
     Terminal,
 };
 use tui_textarea::TextArea;
-pub use update::*;
 
-use super::setup;
+use crate::ui::{
-use crate::ui::{terminal_prepare, textarea_activate, textarea_inactivate};
+    tui::utils::{terminal_prepare, textarea_activate, textarea_inactivate},
+    ui_trait::TrinitrixUi,
+};
 
 #[derive(Clone, Copy, PartialEq)]
 pub enum InputPosition {
@@ -142,17 +165,15 @@ impl InputPosition {
     }
 }
 
-pub struct UI<'a> {
+pub struct Tui<'a> {
     terminal: Terminal<CrosstermBackend<Stdout>>,
     input_position: InputPosition,
     pub rooms_state: ListState,
     pub message_compose: TextArea<'a>,
     pub cli: Option<TextArea<'a>>,
-
-    pub setup_ui: Option<setup::UI<'a>>,
 }
 
-impl Drop for UI<'_> {
+impl Drop for Tui<'_> {
     fn drop(&mut self) {
         info!("Destructing UI");
         disable_raw_mode().expect("While destructing UI -> Failed to disable raw mode");
@@ -167,7 +188,7 @@ impl Drop for UI<'_> {
     }
 }
 
-impl UI<'_> {
+impl Tui<'_> {
     pub fn new() -> Result<Self> {
         let stdout = terminal_prepare().context("Falied to prepare terminal")?;
         let backend = CrosstermBackend::new(stdout);
@@ -190,7 +211,6 @@ impl UI<'_> {
             rooms_state: ListState::default(),
             message_compose,
             cli: None,
-            setup_ui: None,
         })
     }
 
@@ -267,15 +287,4 @@ impl UI<'_> {
         }
         self.cli = None;
     }
-
-    pub async fn update_setup(&mut self) -> Result<()> {
-        let setup_ui = match &mut self.setup_ui {
-            Some(c) => c,
-            None => bail!("SetupUI instance not found"),
-        };
-
-        setup_ui.update(&mut self.terminal).await?;
-
-        Ok(())
-    }
 }

src/ui/tui/trinitrixui/mod.rs

@@ -1,20 +1,46 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
 use std::cmp;
 
-use anyhow::{Context, Result};
+use crate::{
-use tui::{
+    app::status::Status,
+    ui::{
+        tui::{trinitrixui::widgets::command_monitor, Tui},
+        ui_trait::TrinitrixUi,
+    },
+};
+use anyhow::Result;
+use cli_log::{debug, info};
+use keymaps::key_repr::{Key, KeyValue};
+use ratatui::{
     layout::{Constraint, Direction, Layout},
     style::{Color, Style},
     widgets::{Block, Borders, Paragraph},
 };
 
-use self::widgets::{command_monitor, messages, room_info, rooms, status};
-use super::UI;
-use crate::app::status::Status;
-
 pub mod widgets;
 
-impl UI<'_> {
+impl<'r> TrinitrixUi for Tui<'r> {
-    pub async fn update(&mut self, status: &Status) -> Result<()> {
+    async fn update(&mut self, status: &Status) -> Result<()> {
         let chunks = Layout::default()
             .direction(Direction::Vertical)
             .constraints([Constraint::Min(10), Constraint::Length(3)].as_ref())
@@ -43,7 +69,7 @@ impl UI<'_> {
             )
             .split(chunks[0]);
 
-        let left_chunks = Layout::default()
+        let _left_chunks = Layout::default()
             .direction(Direction::Vertical)
             .constraints([Constraint::Length(5), Constraint::Min(4)].as_ref())
             .split(main_chunks[0]);
@@ -76,28 +102,53 @@ impl UI<'_> {
                     .style(Style::default().fg(Color::DarkGray)),
             )
             .style(Style::default().fg(Color::LightYellow));
-        let status_panel = status::init(status, &colors);
-        let rooms_panel = rooms::init(status, &colors);
-        let (messages_panel, mut messages_state) = messages::init(status.room(), &colors)
-            .context("Failed to initiate the messages widget")?;
-        let room_info_panel = room_info::init(status.room(), &colors);
         let command_monitor = command_monitor::init(status.status_messages(), &colors);
 
         // render the widgets
         self.terminal.draw(|frame| {
-            frame.render_widget(status_panel, left_chunks[0]);
-            frame.render_stateful_widget(rooms_panel, left_chunks[1], &mut self.rooms_state);
-            frame.render_stateful_widget(messages_panel, middle_chunks[0], &mut messages_state);
             frame.render_widget(self.message_compose.widget(), middle_chunks[1]);
             frame.render_widget(mode_indicator, bottom_chunks[0]);
             match &self.cli {
                 Some(cli) => frame.render_widget(cli.widget(), bottom_chunks[1]),
                 None => (),
             };
-            frame.render_widget(room_info_panel, right_chunks[0]);
             frame.render_widget(command_monitor, right_chunks[1]);
         })?;
 
         Ok(())
     }
+    fn input(&mut self, input: Key) {
+        debug!("Input received in tui: {}", input);
+        if let Some(value) = input.value() {
+            match value {
+                KeyValue::Backspace => todo!(),
+                KeyValue::Enter => todo!(),
+                KeyValue::Left => todo!(),
+                KeyValue::Right => todo!(),
+                KeyValue::Up => todo!(),
+                KeyValue::Down => todo!(),
+                KeyValue::Home => todo!(),
+                KeyValue::End => todo!(),
+                KeyValue::PageUp => todo!(),
+                KeyValue::PageDown => todo!(),
+                KeyValue::Tab => todo!(),
+                KeyValue::BackTab => todo!(),
+                KeyValue::Delete => todo!(),
+                KeyValue::Insert => todo!(),
+                KeyValue::F(_) => todo!(),
+                KeyValue::Char(_) => todo!(),
+                KeyValue::Null => todo!(),
+                KeyValue::Esc => todo!(),
+                KeyValue::CapsLock => todo!(),
+                KeyValue::ScrollLock => todo!(),
+                KeyValue::NumLock => todo!(),
+                KeyValue::PrintScreen => todo!(),
+                KeyValue::Pause => todo!(),
+                KeyValue::Menu => todo!(),
+                KeyValue::KeypadBegin => todo!(),
+            }
+        } else {
+            info!("User wrote: '{}'", input.to_string_repr());
+        }
+    }
 }

src/ui/tui/trinitrixui/widgets/command_monitor.rs

@@ -1,11 +1,32 @@
-use tui::{
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
+use ratatui::{
     layout::Alignment,
     style::{Color, Style},
     text::Text,
     widgets::{Block, Borders, Paragraph},
 };
 
-use crate::{app::status::StatusMessage, ui::central::InputPosition};
+use crate::{app::status::StatusMessage, ui::tui::InputPosition};
 
 pub fn init<'a>(status_events: &Vec<StatusMessage>, colors: &Vec<Color>) -> Paragraph<'a> {
     let mut command_monitor = Text::default();

src/ui/tui/trinitrixui/widgets/mod.rs

@@ -0,0 +1,22 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
+pub mod command_monitor;

src/ui/tui/utils.rs

@@ -0,0 +1,63 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
+use std::{io, io::Stdout};
+
+use anyhow::{Context, Result};
+use cli_log::info;
+use crossterm::{
+    event::EnableMouseCapture,
+    execute,
+    terminal::{enable_raw_mode, EnterAlternateScreen},
+};
+use ratatui::{
+    style::{Color, Modifier, Style},
+    widgets::{Block, Borders},
+};
+use tui_textarea::TextArea;
+
+pub(super) fn terminal_prepare() -> Result<Stdout> {
+    enable_raw_mode().context("Failed to enable raw mode")?;
+    let mut stdout = io::stdout();
+    execute!(stdout, EnterAlternateScreen, EnableMouseCapture)?;
+    info!("Prepared terminal");
+    Ok(stdout)
+}
+
+pub fn textarea_activate(textarea: &mut TextArea) {
+    textarea.set_cursor_line_style(Style::default().add_modifier(Modifier::UNDERLINED));
+    textarea.set_cursor_style(Style::default().add_modifier(Modifier::REVERSED));
+    let b = textarea
+        .block()
+        .cloned()
+        .unwrap_or_else(|| Block::default().borders(Borders::ALL));
+    textarea.set_block(b.style(Style::default()));
+}
+
+pub fn textarea_inactivate(textarea: &mut TextArea) {
+    textarea.set_cursor_line_style(Style::default());
+    textarea.set_cursor_style(Style::default());
+    let b = textarea
+        .block()
+        .cloned()
+        .unwrap_or_else(|| Block::default().borders(Borders::ALL));
+    textarea.set_block(b.style(Style::default().fg(Color::DarkGray)));
+}

src/ui/ui_trait/mod.rs

@@ -0,0 +1,30 @@
+/*
+* Copyright (C) 2024 - 2024:
+* The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+* SPDX-License-Identifier: GPL-3.0-or-later
+*
+* This file is part of Trinitrix.
+*
+* Trinitrix 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 <https://www.gnu.org/licenses/>.
+*/
+
+use anyhow::Result;
+use keymaps::key_repr::Key;
+
+use crate::app::status::Status;
+
+pub trait TrinitrixUi {
+    async fn update(&mut self, status: &Status) -> Result<()>;
+    fn input(&mut self, input: Key);
+}

treefmt.nix

@@ -0,0 +1,91 @@
+# Copyright (C) 2024 - 2024:
+# The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Trinitrix.
+#
+# Trinitrix 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 <https://www.gnu.org/licenses/>.
+{
+  treefmt-nix,
+  pkgs,
+}:
+treefmt-nix.lib.evalModule pkgs (
+  {pkgs, ...}: {
+    # Used to find the project root
+    projectRootFile = "flake.nix";
+
+    programs = {
+      alejandra.enable = true;
+      rustfmt.enable = true;
+      clang-format.enable = true;
+      mdformat.enable = true;
+      shfmt = {
+        enable = true;
+        indent_size = 4;
+      };
+      shellcheck.enable = true;
+      prettier = {
+        settings = {
+          arrowParens = "always";
+          bracketSameLine = false;
+          bracketSpacing = true;
+          editorconfig = true;
+          embeddedLanguageFormatting = "auto";
+          endOfLine = "lf";
+          # experimentalTernaries = false;
+          htmlWhitespaceSensitivity = "css";
+          insertPragma = false;
+          jsxSingleQuote = true;
+          printWidth = 80;
+          proseWrap = "always";
+          quoteProps = "consistent";
+          requirePragma = false;
+          semi = true;
+          singleAttributePerLine = true;
+          singleQuote = true;
+          trailingComma = "all";
+          useTabs = false;
+          vueIndentScriptAndStyle = false;
+
+          tabWidth = 4;
+          overrides = {
+            files = ["*.js"];
+            options.tabwidth = 2;
+          };
+        };
+      };
+      stylua.enable = true;
+      ruff = {
+        enable = true;
+        format = true;
+      };
+      taplo.enable = true;
+    };
+
+    settings = {
+      global.excludes = [
+        "CHANGELOG.md"
+        "NEWS.md"
+      ];
+      formatter = {
+        clang-format = {
+          options = ["--style" "GNU"];
+        };
+        shfmt = {
+          includes = ["*.bash"];
+        };
+      };
+    };
+  }
+)

update.sh

@@ -1,7 +1,23 @@
-#!/usr/bin/env sh
+#! /usr/bin/env sh
+# Copyright (C) 2024 - 2024:
+# The Trinitrix Project <benedikt.peetz@b-peetz.de, antifallobst@systemausfall.org, sils@sils.li>
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+# This file is part of Trinitrix.
+#
+# Trinitrix 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 <https://www.gnu.org/licenses/>.
 
 cargo update && cargo upgrade
 
-git add Cargo.lock Cargo.toml flake.lock
-
 # vim: ft=sh