Compare commits
No commits in common. "pages" and "master" have entirely different histories.
8
.gitignore
vendored
Normal file
8
.gitignore
vendored
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# NixOS
|
||||||
|
result
|
||||||
|
.envrc
|
||||||
|
.direnv/
|
||||||
|
|
||||||
|
# Build artifacts
|
||||||
|
static/css/index.css
|
||||||
|
public/
|
||||||
16
.woodpecker.yml
Normal file
16
.woodpecker.yml
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
steps:
|
||||||
|
build:
|
||||||
|
image: alpine:3.19
|
||||||
|
commands:
|
||||||
|
- apk add --no-cache zola npm
|
||||||
|
- npm install -D tailwindcss @tailwindcss/typography
|
||||||
|
- npx tailwindcss -i input.css -o static/css/index.css --minify
|
||||||
|
- zola build
|
||||||
|
deploy:
|
||||||
|
image: git.polynom.me/papatutuwawa/woodpecker-ssg-deploy@sha256:9cfec13eb8ab1b8920c2f1f00f0258a7bfd159fe4e14e0985328086392c0da34
|
||||||
|
secrets: [ ssh_key ]
|
||||||
|
settings:
|
||||||
|
email: "ci@polynom.me"
|
||||||
|
name: "polynom.me CI system"
|
||||||
|
token_env: "SSH_KEY"
|
||||||
|
output: "public"
|
||||||
3
404.html
3
404.html
@ -1,3 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<title>404 Not Found</title>
|
|
||||||
<h1>404 Not Found</h1>
|
|
||||||
674
LICENSE
Normal file
674
LICENSE
Normal file
@ -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>.
|
||||||
42
README.md
Normal file
42
README.md
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
# Moxxy's Website
|
||||||
|
|
||||||
|
See the live website at [moxxy.org](https://moxxy.org).
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
Developing the site requires [zola](https://www.getzola.org/) and [tailwindcss](https://tailwindcss.com/).
|
||||||
|
|
||||||
|
### Tailwind
|
||||||
|
|
||||||
|
The website uses tailwindcss for layouting. To use tailwind, install the
|
||||||
|
[tailwindcss CLI application](https://tailwindcss.com/docs/installation).
|
||||||
|
The [typography plugin](https://tailwindcss.com/docs/typography-plugin) is
|
||||||
|
required for building the website.
|
||||||
|
|
||||||
|
### Previewing
|
||||||
|
|
||||||
|
In order to test changes, assuming jekyll and tailwindcss are set up, ...
|
||||||
|
|
||||||
|
1. Run `tailwindcss -c tailwind.config.js -i input.css --watch --output ./static/css/index.css` from the root of the repository.
|
||||||
|
2. Run `zola serve` from the root of the repository.
|
||||||
|
|
||||||
|
This gives you an environment where tailwindcss and zola regenerate their
|
||||||
|
previews when modifying their files.
|
||||||
|
|
||||||
|
### Building
|
||||||
|
|
||||||
|
1. `tailwindcss --input ./input.css --output ./static/css/index.css`
|
||||||
|
2. `zola build`
|
||||||
|
|
||||||
|
### Adding a Blog Post
|
||||||
|
|
||||||
|
If you want to add a blog post, considert the following:
|
||||||
|
|
||||||
|
- If the post should contain media, create a directory in `./content/blog/` with the following naming scheme `YYYY-MM-DD-<Title>`. Inside that directory, create an `index.md` file where you can write the post in Markdown. The media files can then be placed inside that directory and included using ``.
|
||||||
|
- If the post does not contain media, create a file in `./content/blog/` with the following naming scheme `YYYY-MM-DD-<Title>`. Inside that file you can write the post in Markdown.
|
||||||
|
|
||||||
|
Note that the existing posts specify an alias as this site has been migrated from jekyll to zola. It is not required for new posts.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
See [`./LICENSE`](./LICENSE)
|
||||||
83
_config.yml
Normal file
83
_config.yml
Normal file
@ -0,0 +1,83 @@
|
|||||||
|
plugins:
|
||||||
|
- jekyll-feed
|
||||||
|
- jekyll-seo-tag
|
||||||
|
|
||||||
|
exclude:
|
||||||
|
- flake.nix
|
||||||
|
- flake.lock
|
||||||
|
- input.css
|
||||||
|
- LICENSE
|
||||||
|
- pkgs
|
||||||
|
- README.md
|
||||||
|
- tailwind.config.js
|
||||||
|
|
||||||
|
# SEO information
|
||||||
|
logo: /assets/img/logo.png
|
||||||
|
title: Moxxy
|
||||||
|
url: "https://moxxy.org"
|
||||||
|
tagline: A modern XMPP client
|
||||||
|
locale: en_GB
|
||||||
|
|
||||||
|
permalink: /posts/:year-:month-:day-:title:output_ext
|
||||||
|
|
||||||
|
# Links that can be used everywhere
|
||||||
|
sourceUrl: https://codeberg.org/moxxy/moxxy
|
||||||
|
githubMirrorUrl: https://github.com/PapaTutuWawa/moxxy
|
||||||
|
generalMuc: xmpp:moxxy@muc.moxxy.org?join
|
||||||
|
developmentMuc: xmpp:dev@muc.moxxy.org?join
|
||||||
|
|
||||||
|
index:
|
||||||
|
heroText: An experimental and modern XMPP client
|
||||||
|
mainScreenshotUrl: /assets/img/screenshots/1.png
|
||||||
|
|
||||||
|
screenshots:
|
||||||
|
- /assets/img/screenshots/1.png
|
||||||
|
- /assets/img/screenshots/2.png
|
||||||
|
|
||||||
|
badges:
|
||||||
|
codeberg:
|
||||||
|
url: https://codeberg.org/moxxy/moxxy/releases/latest
|
||||||
|
izzy:
|
||||||
|
url: https://apt.izzysoft.de/fdroid/index/apk/org.moxxy.moxxyv2
|
||||||
|
|
||||||
|
features:
|
||||||
|
- End-to-End encryption using OMEMO
|
||||||
|
- Stickers
|
||||||
|
- Reactions
|
||||||
|
- Retract messages
|
||||||
|
- Voice messages
|
||||||
|
- Swipe-to-quote
|
||||||
|
- Chat background images
|
||||||
|
- Optional privacy-preserving integration with phone contacts
|
||||||
|
- Open-Source
|
||||||
|
|
||||||
|
developers:
|
||||||
|
libraries:
|
||||||
|
- name: moxxmpp
|
||||||
|
desc: XMPP library written in Dart
|
||||||
|
specific: false
|
||||||
|
url: https://codeberg.org/moxxy/moxxmpp
|
||||||
|
- name: moxdns
|
||||||
|
desc: DNS SRV resolver for Flutter
|
||||||
|
specific: true
|
||||||
|
url: https://codeberg.org/moxxy/moxdns
|
||||||
|
- name: moxlib
|
||||||
|
desc: Shared functions for Moxxy-specific projects
|
||||||
|
specific: true
|
||||||
|
url: https://codeberg.org/moxxy/moxlib
|
||||||
|
- name: moxplatform
|
||||||
|
desc: Platform-specific code
|
||||||
|
specific: true
|
||||||
|
url: https://codeberg.org/moxxy/moxplatform
|
||||||
|
- name: omemo_dart
|
||||||
|
desc: Implementation of the cryptography for OMEMO 0.8.3 with a high-level interface
|
||||||
|
specific: false
|
||||||
|
url: https://codeberg.org/PapaTutuWawa/omemo_dart
|
||||||
|
|
||||||
|
customXeps:
|
||||||
|
- name: Extensible File Thumbnails
|
||||||
|
desc: Provide an extensible way of specifying thumbnails that are neccessarily binary data
|
||||||
|
url: https://codeberg.org/moxxy/custom-xeps/src/branch/master/xep-xxxx-extensible-file-thumbnails.md
|
||||||
|
- name: File Upload Notification
|
||||||
|
desc: Allow communicating that an OOB file upload is currently running to improve the consistency of the conversation
|
||||||
|
url: https://codeberg.org/moxxy/custom-xeps/src/branch/master/xep-xxxx-file-upload-notification.md
|
||||||
@ -1,82 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<link href="https://moxxy.org/css/index.css" rel="stylesheet" />
|
|
||||||
<link rel="shortcut icon" href="https://moxxy.org/img/favicon.ico" sizes="32x32" />
|
|
||||||
<link href="https://moxxy.org/feed.xml" type="application/atom+xml" rel="alternate" title="Moxxy Blog" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta property="og:description" content="" />
|
|
||||||
<meta property="og:title" content="Moxxy's First GSoC Project!" />
|
|
||||||
<title>Moxxy's First GSoC Project!</title>
|
|
||||||
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="flex flex-col">
|
|
||||||
<div class="relative h-16 inset-x-0 inset-y-0 px-4 shadow-md grid place-items-center">
|
|
||||||
<div class="flex flex-row items-center w-full">
|
|
||||||
<!-- The Moxxy logo -->
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<img src="https://moxxy.org/img/logo.png" class="w-12 h-12 p-2" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<span class="font-bold">Moxxy</span>
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<!-- Spacer -->
|
|
||||||
<div class="grow"></div>
|
|
||||||
|
|
||||||
<a href="/blog/" class="px-2 text-sky-400">Blog</a>
|
|
||||||
<a href="https://moxxy.org/developers/" class="px-2 text-sky-400">Developers</a>
|
|
||||||
<a href="https://codeberg.org/moxxy/moxxy" class="px-2 text-sky-400">Source</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="w-full md:max-w-prose mt-2 mx-auto">
|
|
||||||
<div class="px-8">
|
|
||||||
<h1 class="text-3xl">Moxxy's First GSoC Project!</h1>
|
|
||||||
<span>Posted by <span class="italic">Ikjot Singh Dhody</span> on 2023-05-06</span>
|
|
||||||
<article class="mt-5 prose lg:prose-lg">
|
|
||||||
<p>Hello readers!</p>
|
|
||||||
<p>As we know, Moxxy is an experimental IM for XMPP built using Flutter. While it does have a great set of features as described <a href="https://moxxy.org/">here</a>, it currently lacks support for group chats (or Multi-User-Chats). A great piece of news is that Google has accepted my proposal to add support for multi user chats in Moxxy.</p>
|
|
||||||
<span id="continue-reading"></span>
|
|
||||||
<p>To implement multi user chats in Moxxy, the <a href="https://xmpp.org/extensions/xep-0045.html">XEP-0045</a> standard will be followed and implemented. The project will run in two phases, since the major changes required will be in the <a href="https://codeberg.org/moxxy/moxxmpp">moxxmpp</a> and <a href="https://codeberg.org/moxxy/moxxy">Moxxy</a> codebases. First, XEP-0045 support will be added to moxxmpp with all the handlers, events and routines required to cleanly integrate the same with Moxxy. The second phase will be the UI changes in the Moxxy Flutter application, that builds upon the existing, reusable infrastructure.</p>
|
|
||||||
<p>The usecases planned to be implemented are listed below (subject to changes before the coding period begins):</p>
|
|
||||||
<ul>
|
|
||||||
<li>Join a room</li>
|
|
||||||
<li>Leave a room</li>
|
|
||||||
<li>Change availability status</li>
|
|
||||||
<li>View member list</li>
|
|
||||||
<li>Send/receive a message to/from all occupants</li>
|
|
||||||
<li>Send/receive a private message to/from a specific occupant</li>
|
|
||||||
</ul>
|
|
||||||
<p>Some extra usecases are planned in case time permits:</p>
|
|
||||||
<ul>
|
|
||||||
<li>Change nickname</li>
|
|
||||||
<li>Kick an occupant (if user has such a permission)</li>
|
|
||||||
<li>Ban an occupant (if user has such a permission)</li>
|
|
||||||
<li>Grant/revoke membership (if user has such a permission)</li>
|
|
||||||
</ul>
|
|
||||||
<p>The coding period for this project will begin on May 29. In case of any queries/interest, please join the following - <a href="xmpp:dev@muc.moxxy.org?join">xmpp:dev@muc.moxxy.org?join</a>.</p>
|
|
||||||
|
|
||||||
</article>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<footer class="h-8 w-full flex flex-row justify-center">
|
|
||||||
<span class="text-sm text-center">
|
|
||||||
Made with <3 by
|
|
||||||
<a class="text-sky-400" href="https://polynom.me" target="_blank" rel="noopener noreferrer">PapaTutuWawa</a>
|
|
||||||
using <a class="text-sky-400" href="https://tailwindcss.com/" target="_blank" rel="noopener noreferrer">TailwindCSS</a>,
|
|
||||||
<a class="text-sky-400" href="https://jekyllrb.com/" target="_blank" rel="noopener noreferrer">Jekyll</a> and
|
|
||||||
<a class="text-sky-400" href="https://heroicons.com/">heroicons</a>.
|
|
||||||
</span>
|
|
||||||
</footer>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
142
blog/index.html
142
blog/index.html
@ -1,142 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<link href="https://moxxy.org/css/index.css" rel="stylesheet" />
|
|
||||||
<link rel="shortcut icon" href="https://moxxy.org/img/favicon.ico" sizes="32x32" />
|
|
||||||
<link href="https://moxxy.org/feed.xml" type="application/atom+xml" rel="alternate" title="Moxxy Blog" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta property="og:description" content="A modern XMPP client" />
|
|
||||||
<meta property="og:title" content="Moxxy | A modern XMPP client" />
|
|
||||||
<title>Moxxy | A modern XMPP client</title>
|
|
||||||
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="flex flex-col">
|
|
||||||
<div class="relative h-16 inset-x-0 inset-y-0 px-4 shadow-md grid place-items-center">
|
|
||||||
<div class="flex flex-row items-center w-full">
|
|
||||||
<!-- The Moxxy logo -->
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<img src="https://moxxy.org/img/logo.png" class="w-12 h-12 p-2" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<span class="font-bold">Moxxy</span>
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<!-- Spacer -->
|
|
||||||
<div class="grow"></div>
|
|
||||||
|
|
||||||
<a href="/blog/" class="px-2 text-sky-400">Blog</a>
|
|
||||||
<a href="https://moxxy.org/developers/" class="px-2 text-sky-400">Developers</a>
|
|
||||||
<a href="https://codeberg.org/moxxy/moxxy" class="px-2 text-sky-400">Source</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="w-full flex flex-row justify-center mt-2">
|
|
||||||
<div class="w-full lg:w-1/2 px-8 flex flex-col items-start">
|
|
||||||
<div class="flex flex-row items-center gap-x-3">
|
|
||||||
<h1 class="text-3xl">Blog posts</h1>
|
|
||||||
|
|
||||||
<a href="https://moxxy.org/feed.xml">
|
|
||||||
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="w-6 h-6">
|
|
||||||
<path stroke-linecap="round" stroke-linejoin="round" d="M12.75 19.5v-.75a7.5 7.5 0 00-7.5-7.5H4.5m0-6.75h.75c7.87 0 14.25 6.38 14.25 14.25v.75M6 18.75a.75.75 0 11-1.5 0 .75.75 0 011.5 0z" />
|
|
||||||
</svg>
|
|
||||||
</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="divide-y divide-blue-200">
|
|
||||||
|
|
||||||
<!-- Post item -->
|
|
||||||
<div class="flex flex-col pt-4">
|
|
||||||
<a href="https://moxxy.org/blog/moxxy-muc-gsoc-final-report/">
|
|
||||||
<h1 class="text-indigo-400 prose prose-lg text-xl">GSoC report - Moxxy MUC implementation</h1>
|
|
||||||
</a>
|
|
||||||
<span class="text-md mt-2">Posted by <i>Ikjot Singh Dhody</i> on 2023-08-20</span>
|
|
||||||
|
|
||||||
<!-- Blurp -->
|
|
||||||
<span class="prose mt-4">
|
|
||||||
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Post item -->
|
|
||||||
<div class="flex flex-col pt-4">
|
|
||||||
<a href="https://moxxy.org/blog/join-muc-with-moxxy/">
|
|
||||||
<h1 class="text-indigo-400 prose prose-lg text-xl">Joining an MUC with Moxxy!</h1>
|
|
||||||
</a>
|
|
||||||
<span class="text-md mt-2">Posted by <i>Ikjot Singh Dhody</i> on 2023-07-24</span>
|
|
||||||
|
|
||||||
<!-- Blurp -->
|
|
||||||
<span class="prose mt-4">
|
|
||||||
<p>Greetings, readers!</p>
|
|
||||||
<p>Welcome back to our series of blogs on the Google Summer of Code (GSoC) project. In this blog post, I'll be sharing the progress made in implementing Multi-User Chat (MUC) support in Moxxy, the frontend counterpart to my GSoC project.</p>
|
|
||||||
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Post item -->
|
|
||||||
<div class="flex flex-col pt-4">
|
|
||||||
<a href="https://moxxy.org/blog/xep-0045-in-moxxmpp/">
|
|
||||||
<h1 class="text-indigo-400 prose prose-lg text-xl">XEP-0045 implementation in Moxxmpp</h1>
|
|
||||||
</a>
|
|
||||||
<span class="text-md mt-2">Posted by <i>Ikjot Singh Dhody</i> on 2023-06-17</span>
|
|
||||||
|
|
||||||
<!-- Blurp -->
|
|
||||||
<span class="prose mt-4">
|
|
||||||
<p>Hello readers!</p>
|
|
||||||
<p>Welcome back to the GSoC series of blogs. This one is about my implementation of the MUC XEP (XEP-0045) in Moxxmpp.</p>
|
|
||||||
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Post item -->
|
|
||||||
<div class="flex flex-col pt-4">
|
|
||||||
<a href="https://moxxy.org/blog/groupchat-gsoc-project/">
|
|
||||||
<h1 class="text-indigo-400 prose prose-lg text-xl">Moxxy's First GSoC Project!</h1>
|
|
||||||
</a>
|
|
||||||
<span class="text-md mt-2">Posted by <i>Ikjot Singh Dhody</i> on 2023-05-06</span>
|
|
||||||
|
|
||||||
<!-- Blurp -->
|
|
||||||
<span class="prose mt-4">
|
|
||||||
<p>Hello readers!</p>
|
|
||||||
<p>As we know, Moxxy is an experimental IM for XMPP built using Flutter. While it does have a great set of features as described <a href="https://moxxy.org/">here</a>, it currently lacks support for group chats (or Multi-User-Chats). A great piece of news is that Google has accepted my proposal to add support for multi user chats in Moxxy.</p>
|
|
||||||
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Post item -->
|
|
||||||
<div class="flex flex-col pt-4">
|
|
||||||
<a href="https://moxxy.org/blog/moxxys-new-website/">
|
|
||||||
<h1 class="text-indigo-400 prose prose-lg text-xl">Moxxy's New Website</h1>
|
|
||||||
</a>
|
|
||||||
<span class="text-md mt-2">Posted by <i>PapaTutuWawa</i> on 2023-01-24</span>
|
|
||||||
|
|
||||||
<!-- Blurp -->
|
|
||||||
<span class="prose mt-4">
|
|
||||||
<p>Hello everyone! Welcome on Moxxy's new website. It currently does not contain
|
|
||||||
much but that may change in the future.</p>
|
|
||||||
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<footer class="h-8 w-full flex flex-row justify-center">
|
|
||||||
<span class="text-sm text-center">
|
|
||||||
Made with <3 by
|
|
||||||
<a class="text-sky-400" href="https://polynom.me" target="_blank" rel="noopener noreferrer">PapaTutuWawa</a>
|
|
||||||
using <a class="text-sky-400" href="https://tailwindcss.com/" target="_blank" rel="noopener noreferrer">TailwindCSS</a>,
|
|
||||||
<a class="text-sky-400" href="https://jekyllrb.com/" target="_blank" rel="noopener noreferrer">Jekyll</a> and
|
|
||||||
<a class="text-sky-400" href="https://heroicons.com/">heroicons</a>.
|
|
||||||
</span>
|
|
||||||
</footer>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,119 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<link href="https://moxxy.org/css/index.css" rel="stylesheet" />
|
|
||||||
<link rel="shortcut icon" href="https://moxxy.org/img/favicon.ico" sizes="32x32" />
|
|
||||||
<link href="https://moxxy.org/feed.xml" type="application/atom+xml" rel="alternate" title="Moxxy Blog" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta property="og:description" content="" />
|
|
||||||
<meta property="og:title" content="Joining an MUC with Moxxy!" />
|
|
||||||
<title>Joining an MUC with Moxxy!</title>
|
|
||||||
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="flex flex-col">
|
|
||||||
<div class="relative h-16 inset-x-0 inset-y-0 px-4 shadow-md grid place-items-center">
|
|
||||||
<div class="flex flex-row items-center w-full">
|
|
||||||
<!-- The Moxxy logo -->
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<img src="https://moxxy.org/img/logo.png" class="w-12 h-12 p-2" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<span class="font-bold">Moxxy</span>
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<!-- Spacer -->
|
|
||||||
<div class="grow"></div>
|
|
||||||
|
|
||||||
<a href="/blog/" class="px-2 text-sky-400">Blog</a>
|
|
||||||
<a href="https://moxxy.org/developers/" class="px-2 text-sky-400">Developers</a>
|
|
||||||
<a href="https://codeberg.org/moxxy/moxxy" class="px-2 text-sky-400">Source</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="w-full md:max-w-prose mt-2 mx-auto">
|
|
||||||
<div class="px-8">
|
|
||||||
<h1 class="text-3xl">Joining an MUC with Moxxy!</h1>
|
|
||||||
<span>Posted by <span class="italic">Ikjot Singh Dhody</span> on 2023-07-24</span>
|
|
||||||
<article class="mt-5 prose lg:prose-lg">
|
|
||||||
<p>Greetings, readers!</p>
|
|
||||||
<p>Welcome back to our series of blogs on the Google Summer of Code (GSoC) project. In this blog post, I'll be sharing the progress made in implementing Multi-User Chat (MUC) support in Moxxy, the frontend counterpart to my GSoC project.</p>
|
|
||||||
<span id="continue-reading"></span><h2 id="introduction">Introduction</h2>
|
|
||||||
<p>As you may recall, Moxxy is a frontend application developed as an innovative XMPP client. To enhance its functionality, my GSoC project focuses on adding MUC support. Before diving into the Moxxy implementation, it was crucial to establish the necessary MUC support in Moxxmpp, which is highlighted in <a href="https://moxxy.org/posts/2023-06-17-XEP-0045-In-Moxxmpp.html">this</a> blog.</p>
|
|
||||||
<p>Currently, the implementation progress is to allow users to join an MUC through Moxxy, and view incoming live messages in the chat. </p>
|
|
||||||
<h2 id="design-plan-for-muc-support-in-moxxy">Design Plan for MUC Support in Moxxy</h2>
|
|
||||||
<p>To implement MUC support in Moxxy, we need to extend its functionality and introduce new components. Let's outline the design plan for the MUC feature:</p>
|
|
||||||
<h3 id="new-page">New Page</h3>
|
|
||||||
<h4 id="joingroupchatpage">JoinGroupchatPage</h4>
|
|
||||||
<p>This page will contain just 1 text field - for the nickname that the user wants to join with. It also has a button that allows us to join the MUC with said nickname. It is an additional route to the current StartChat page, if the user selects that they want to join a groupchat.</p>
|
|
||||||
<h3 id="new-command">New Command</h3>
|
|
||||||
<h4 id="joingroupchatcommand">JoinGroupchatCommand</h4>
|
|
||||||
<p>This command is sent to the data layer worker (separate thread) from the UI, when the user clicks on the join groupchat button on the new join groupchat page. It contains information about the JID and the nick that the user tried to join with. This will only be sent to the worker thread if the input validations are cleared.</p>
|
|
||||||
<h3 id="new-event">New Event</h3>
|
|
||||||
<h4 id="joingroupchatresult">JoinGroupchatResult</h4>
|
|
||||||
<p>This event is sent back as a result of the JoinGroupchatCommand. Based on whether the request succeeded or failed, it will return the new Conversation object that has just been created.</p>
|
|
||||||
<h3 id="database-changes">Database changes</h3>
|
|
||||||
<h4 id="groupchatdetails-table">GroupchatDetails table</h4>
|
|
||||||
<p>Add a new GrouchatDetails table to the database containing two data items - the jid and the nick. The main reason to have a separate table for the groupchat details, instead of to just have a new nick item in the Conversation table - was to maintain the single responsibility principle.</p>
|
|
||||||
<p>When the user fetches a conversation of type groupchat from the database, a separate call will be made that fetches the relevant groupchat details from this new table, and attaches it to the Conversation object.</p>
|
|
||||||
<h3 id="miscellaneous-changes">Miscellaneous changes</h3>
|
|
||||||
<ul>
|
|
||||||
<li>
|
|
||||||
<p>Changed the external helpers for the ConversationType to an enhanced enum. This allows us to include the functions within the enum.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>The MUCManager was added to the list of registered managers for Moxxy. Not only this, the OccupantIdManager was also registered which will allow for the unique occupant identification moving forward. This will be required for message reactions/retractions in an MUC. </p>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<h3 id="new-service">New Service</h3>
|
|
||||||
<h4 id="groupchatservice">GroupchatService</h4>
|
|
||||||
<p>Added a new GroupchatService that allows for the following functions:</p>
|
|
||||||
<ul>
|
|
||||||
<li><strong>getRoomInformation</strong>: Sends a request to moxxmpp to receive disco info about the MUC.</li>
|
|
||||||
<li><strong>joinRoom</strong>: Sends a request to moxxmpp to join the MUC if it's not password protected.</li>
|
|
||||||
<li><strong>addGroupchatDetailsFromData</strong>: Adds a new GroupchatDetails object to the database table.</li>
|
|
||||||
<li><strong>getGroupchatDetailsByJid</strong>: Fetches the GroupchatDetails from the database based on the JID provided. This is required as a separate step while fetching an MUC conversation since the Conversations and GroupchatDetails table are decoupled. </li>
|
|
||||||
</ul>
|
|
||||||
<h3 id="handling-errors">Handling Errors</h3>
|
|
||||||
<p>To prevent avoidable errors, Moxxy performs frontend checks when joining a room. These checks include ensuring to validate the JID input field, and checking for empty nicknames.</p>
|
|
||||||
<p>Possible errors that users may encounter during the MUC workflow include invalid or already in use nicknames, disallowed registration, invalid stanza format, and invalid disco info response. Moxxy will handle these errors gracefully.</p>
|
|
||||||
<h2 id="challenges-and-considerations">Challenges and Considerations</h2>
|
|
||||||
<p>Here is an enumeration of the possible challenges that we could face in the future implementation, and the ones I faced in the current implementation as well:</p>
|
|
||||||
<ol>
|
|
||||||
<li>
|
|
||||||
<p>Differentiating Messages from Oneself: Moxxy/Moxxmpp need to distinguish between messages from other users and self-echoed messages. To address this, Moxxy uses the origin ID of the message. If the origin ID of the response matches the sent origin ID, the message is ignored and not displayed in the UI.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Handling Impersonation in Anonymous MUCs: In anonymous MUCs, users can impersonate others by reusing their nicknames after leaving. To tackle this, Moxxmpp leverages the occupant ID, as described in XEP-0421. Each user joining the group receives a unique occupant ID, which helps track message origins accurately.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Managing Discussion History on Rejoining: When a user rejoins an MUC, the room history is resent, including errors, self-presence with status code, room history, room subject, and live message/presence updates. To prevent appending duplicate history to the UI, Moxxy/Moxxmpp will have to wait until it receives the room subject before listening for message stanzas.</p>
|
|
||||||
</li>
|
|
||||||
</ol>
|
|
||||||
<h2 id="conclusion-and-future-work">Conclusion and Future Work</h2>
|
|
||||||
<p>In this blog post, we explored the implementation plan for adding MUC support, specifically XEP-0045, to Moxxy. Moxxmpp serves as the backbone for Moxxy's XMPP functionality, handling communication between the client and XMPP server. We discussed the directory structure, and key routines required for MUC support in Moxxmpp. Additionally, we addressed various challenges and considerations related to MUC features.</p>
|
|
||||||
<p>The implementation process has already commenced, with a pull request (PR) underway. Once the PR is complete, Moxxy will support joining a groupchat and listening to live messages. In further PRs, sending messages and leaving the MUC will be supported as well. The addition of MUC support will empower Moxxy users to enjoy enhanced collaboration and communication within XMPP group chats.</p>
|
|
||||||
<p>Stay tuned for future updates on the progress of MUC support in Moxxy. Until then, happy chatting!</p>
|
|
||||||
|
|
||||||
</article>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<footer class="h-8 w-full flex flex-row justify-center">
|
|
||||||
<span class="text-sm text-center">
|
|
||||||
Made with <3 by
|
|
||||||
<a class="text-sky-400" href="https://polynom.me" target="_blank" rel="noopener noreferrer">PapaTutuWawa</a>
|
|
||||||
using <a class="text-sky-400" href="https://tailwindcss.com/" target="_blank" rel="noopener noreferrer">TailwindCSS</a>,
|
|
||||||
<a class="text-sky-400" href="https://jekyllrb.com/" target="_blank" rel="noopener noreferrer">Jekyll</a> and
|
|
||||||
<a class="text-sky-400" href="https://heroicons.com/">heroicons</a>.
|
|
||||||
</span>
|
|
||||||
</footer>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,258 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<link href="https://moxxy.org/css/index.css" rel="stylesheet" />
|
|
||||||
<link rel="shortcut icon" href="https://moxxy.org/img/favicon.ico" sizes="32x32" />
|
|
||||||
<link href="https://moxxy.org/feed.xml" type="application/atom+xml" rel="alternate" title="Moxxy Blog" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta property="og:description" content="" />
|
|
||||||
<meta property="og:title" content="GSoC report - Moxxy MUC implementation" />
|
|
||||||
<title>GSoC report - Moxxy MUC implementation</title>
|
|
||||||
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="flex flex-col">
|
|
||||||
<div class="relative h-16 inset-x-0 inset-y-0 px-4 shadow-md grid place-items-center">
|
|
||||||
<div class="flex flex-row items-center w-full">
|
|
||||||
<!-- The Moxxy logo -->
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<img src="https://moxxy.org/img/logo.png" class="w-12 h-12 p-2" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<span class="font-bold">Moxxy</span>
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<!-- Spacer -->
|
|
||||||
<div class="grow"></div>
|
|
||||||
|
|
||||||
<a href="/blog/" class="px-2 text-sky-400">Blog</a>
|
|
||||||
<a href="https://moxxy.org/developers/" class="px-2 text-sky-400">Developers</a>
|
|
||||||
<a href="https://codeberg.org/moxxy/moxxy" class="px-2 text-sky-400">Source</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="w-full md:max-w-prose mt-2 mx-auto">
|
|
||||||
<div class="px-8">
|
|
||||||
<h1 class="text-3xl">GSoC report - Moxxy MUC implementation</h1>
|
|
||||||
<span>Posted by <span class="italic">Ikjot Singh Dhody</span> on 2023-08-20</span>
|
|
||||||
<article class="mt-5 prose lg:prose-lg">
|
|
||||||
<h1 id="gsoc-final-report-xmpp-standards-foundation-moxxy-implement-group-chats">GSoC Final Report: XMPP Standards Foundation - Moxxy: Implement Group Chats</h1>
|
|
||||||
<p><strong>Project:</strong> Moxxy - Implement Group Chats<br />
|
|
||||||
<strong>Organization:</strong> XMPP Standards Foundation<br />
|
|
||||||
<strong>Duration:</strong> March 2023 - August 2023<br />
|
|
||||||
<strong>Student:</strong> Ikjot Singh Dhody<br />
|
|
||||||
<strong>Mentor:</strong> Alexander</p>
|
|
||||||
<h2 id="introduction">Introduction</h2>
|
|
||||||
<p>This report presents the culmination of my work on the GSoC project "Moxxy: Implement Group Chats" under the mentorship of Alexander at the XMPP Standards Foundation. Over the course of this project, I have been engaged in implementing a group chat feature for the Moxxy application, aiming to enhance its functionality and user experience.</p>
|
|
||||||
<h2 id="about-me">About Me</h2>
|
|
||||||
<h3 id="personal-and-social-contact-details">Personal and Social/Contact Details</h3>
|
|
||||||
<ul>
|
|
||||||
<li><strong>Name:</strong> Ikjot Singh Dhody</li>
|
|
||||||
<li><strong>Jabber ID:</strong> ikjot-2605[at]jabber.fr</li>
|
|
||||||
<li><strong>Email:</strong> ikjotsd[at]gmail.com</li>
|
|
||||||
<li><strong>GitHub:</strong> <a href="https://github.com/ikjot-2605">ikjot-2605</a></li>
|
|
||||||
<li><strong>LinkedIn:</strong> <a href="https://www.linkedin.com/in/ikjotsd/">LinkedIn Profile</a></li>
|
|
||||||
</ul>
|
|
||||||
<h3 id="educational-background">Educational Background</h3>
|
|
||||||
<ul>
|
|
||||||
<li><strong>University:</strong> National Institute of Technology Karnataka, Surathkal</li>
|
|
||||||
<li><strong>Major:</strong> Computer Science and Engineering</li>
|
|
||||||
<li><strong>Year:</strong> Senior Year</li>
|
|
||||||
<li><strong>Degree:</strong> Bachelor of Technology (B. Tech)</li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="the-project">The Project</h2>
|
|
||||||
<p>Before getting into the details of the actual project - here is a demo screencast for the implementation:</p>
|
|
||||||
<p><img src="https://moxxy.org/blog/moxxy-muc-gsoc-final-report/moxxy-muc-demo.gif" alt="" /></p>
|
|
||||||
<p>I have outlined the features I implemented through the GSoC period below.</p>
|
|
||||||
<h3 id="prs-merged">PRs merged</h3>
|
|
||||||
<ul>
|
|
||||||
<li>moxxmpp
|
|
||||||
<ol>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/moxxmpp/pulls/45">Add support for XEP-0421</a></li>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/moxxmpp/pulls/46">Implement XEP-0045 support in moxxmpp</a></li>
|
|
||||||
</ol>
|
|
||||||
</li>
|
|
||||||
<li>Moxxy
|
|
||||||
<ol>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/moxxy/pulls/300">Add groupchat support for Moxxy</a></li>
|
|
||||||
</ol>
|
|
||||||
</li>
|
|
||||||
<li>website (blog)
|
|
||||||
<ol>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/website/pulls/2">Add blog for GSoC MUC project introduction.</a></li>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/website/pulls/3">Blog for XEP 0045 support in Moxxmpp</a></li>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/website/pulls/4"> New blog - Join an MUC with Moxxy!</a></li>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/website/pulls/5">Final GSoC Report Blog</a></li>
|
|
||||||
</ol>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<h3 id="feature-use-cases">Feature Use-Cases</h3>
|
|
||||||
<p>The group chat feature required changes to the Moxxy codebase, as well as the moxxmpp codebase. Moxxmpp is the data worker that sends and maintains all the request requirements of the Moxxy frontend. These are the list of contributions across both projects:</p>
|
|
||||||
<ul>
|
|
||||||
<li>Joining rooms and getting disco info for the room.</li>
|
|
||||||
<li>Sending messages to a group chat and receiving messages from the group chat.</li>
|
|
||||||
<li>Leaving the group chat.</li>
|
|
||||||
<li>Displaying a UI for joining a group chat and providing a nickname.</li>
|
|
||||||
<li>Handling group chat details and database support.</li>
|
|
||||||
<li>Handling group chat errors and basic error handling.</li>
|
|
||||||
<li>Adding a GroupchatDetails model.</li>
|
|
||||||
<li>Adding UI elements for group chat, such as title and nickname fields.</li>
|
|
||||||
<li>Adding documentation to group chat service methods.</li>
|
|
||||||
<li>Minor code refactoring and naming enhancements.</li>
|
|
||||||
<li>Enhancing enums for conversation types.</li>
|
|
||||||
<li>Removing unnecessary translation strings.</li>
|
|
||||||
<li>Improving UI and formatting.</li>
|
|
||||||
</ul>
|
|
||||||
<p>Outlined below are commits made across both codebases throughout the GSoC period.</p>
|
|
||||||
<h4 id="moxxmpp">Moxxmpp</h4>
|
|
||||||
<p>There were 2 PRs merged for this codebase. </p>
|
|
||||||
<ul>
|
|
||||||
<li>XEP-0421 support for occupant ID support.</li>
|
|
||||||
</ul>
|
|
||||||
<table><thead><tr><th>Serial Number</th><th>Commit Hash</th><th>Description</th></tr></thead><tbody>
|
|
||||||
<tr><td>1</td><td>255d0f88e0</td><td>feat(xep): Use cascading operation to return state</td></tr>
|
|
||||||
<tr><td>2</td><td>fa11a3a384</td><td>feat(xep): Checked for the occupant-id directly.</td></tr>
|
|
||||||
<tr><td>3</td><td>ac5bb9e461</td><td>feat(xep): Implement XEP 0421 in Moxxmpp.</td></tr>
|
|
||||||
</tbody></table>
|
|
||||||
<ul>
|
|
||||||
<li>XEP-0045 support for MUC support. </li>
|
|
||||||
</ul>
|
|
||||||
<table><thead><tr><th>Serial Number</th><th>Commit Hash</th><th>Description</th></tr></thead><tbody>
|
|
||||||
<tr><td>1</td><td>b2724aba0c</td><td>Merge branch 'master' into xep_0045</td></tr>
|
|
||||||
<tr><td>2</td><td>d3742ea156</td><td>feat(xep): Small fixes - MUC Example.</td></tr>
|
|
||||||
<tr><td>3</td><td>8b00e85167</td><td>feat(xep): Add example for XEP 0045 Moxxmpp.</td></tr>
|
|
||||||
<tr><td>4</td><td>04dfc6d2ac</td><td>feat(xep): Replace DiscoError with StanzaError.</td></tr>
|
|
||||||
<tr><td>5</td><td>9e70e802ef</td><td>Merge branch 'master' into xep_0045</td></tr>
|
|
||||||
<tr><td>6</td><td>3ebd9b86ec</td><td>feat(xep): Fix lint issues and use moxlib for result.</td></tr>
|
|
||||||
<tr><td>7</td><td>a873edb9ec</td><td>feat(xep): Check for null nick before leaveRoom.</td></tr>
|
|
||||||
<tr><td>8</td><td>e6bd6d05cd</td><td>feat(xep): Remove NOOP cache access.</td></tr>
|
|
||||||
<tr><td>9</td><td>b7d53b8f47</td><td>feat(xep): Add docstings for the XEP-0045 routines</td></tr>
|
|
||||||
<tr><td>10</td><td>217c3ac236</td><td>feat(xep): Fix cache issue with join/leaveRoom.</td></tr>
|
|
||||||
<tr><td>11</td><td>51bca6c25d</td><td>feat(xep): XEP-0045 cache fixes.</td></tr>
|
|
||||||
<tr><td>12</td><td>8728166a4d</td><td>feat(xep): Add cache and roomstate to MUC implementation.</td></tr>
|
|
||||||
<tr><td>13</td><td>1f1321b269</td><td>feat(xep): Small fixes - review cycle 1.</td></tr>
|
|
||||||
<tr><td>14</td><td>66195f66fa</td><td>Merge branch 'master' into xep_0045</td></tr>
|
|
||||||
<tr><td>15</td><td>70fdfaf16d</td><td>feat(xep): Fix imports for xep_0045 files.</td></tr>
|
|
||||||
<tr><td>16</td><td>cd73f89e63</td><td>feat(xep): Remove duplicate manager string</td></tr>
|
|
||||||
<tr><td>17</td><td>05c41d3185</td><td>feat(xep): Refactor sendMessage to allow groupchat</td></tr>
|
|
||||||
<tr><td>18</td><td>64a8de6caa</td><td>feat(xep): Set base for XEP 0045 implementation</td></tr>
|
|
||||||
<tr><td>19</td><td>68809469f6</td><td>feat(xep): Add joinRoom, leaveRoom routines.</td></tr>
|
|
||||||
<tr><td>20</td><td>762cf1c77a</td><td>feat(xep): Set base for XEP 0045 implementation</td></tr>
|
|
||||||
</tbody></table>
|
|
||||||
<h4 id="moxxy">Moxxy</h4>
|
|
||||||
<ul>
|
|
||||||
<li>Implement MUCs in Moxxy</li>
|
|
||||||
</ul>
|
|
||||||
<table><thead><tr><th>Serial Number</th><th>Commit Hash</th><th>Description</th></tr></thead><tbody>
|
|
||||||
<tr><td>1</td><td>549e61a168</td><td>feat(all): Fix linter issues.</td></tr>
|
|
||||||
<tr><td>2</td><td>26bcaccd81</td><td>Merge branch 'master' into feat/groupchat</td></tr>
|
|
||||||
<tr><td>3</td><td>df5810a347</td><td>feat(all): Formatting change, lock file update</td></tr>
|
|
||||||
<tr><td>4</td><td>ef931c566f</td><td>feat(all): Send messages/chat state from Moxxy to MUC.</td></tr>
|
|
||||||
<tr><td>5</td><td>a3d4883406</td><td>feat(all): Remove unnecessary buttons/options for MUC.</td></tr>
|
|
||||||
<tr><td>6</td><td>532f0b1bb2</td><td>feat(all): Formatting fix, and navigation fix.</td></tr>
|
|
||||||
<tr><td>7</td><td>a98fe0d9f3</td><td>feat(all): Minor fixes - strings, formatting.</td></tr>
|
|
||||||
<tr><td>8</td><td>a7c3bd507f</td><td>Merge branch 'master' of https://codeberg.org/moxxy/moxxy into feat/groupchat</td></tr>
|
|
||||||
<tr><td>9</td><td>fba2cf86ae</td><td>feat(all): Minor formatting changes.</td></tr>
|
|
||||||
<tr><td>10</td><td>af481bf465</td><td>feat(all): remove unnecessary comparator override.</td></tr>
|
|
||||||
<tr><td>11</td><td>e6ae8182c2</td><td>feat(all): Organize import in main.dart.</td></tr>
|
|
||||||
<tr><td>12</td><td>de7b9adfa6</td><td>feat(all): Fix user flow for joining MUC.</td></tr>
|
|
||||||
<tr><td>13</td><td>e4f98bb82f</td><td>feat(all): Add label to nick text field.</td></tr>
|
|
||||||
<tr><td>14</td><td>56d6f97168</td><td>feat(all): Minor changes, fixes.</td></tr>
|
|
||||||
<tr><td>15</td><td>b0067f055f</td><td>feat(all): Move away from exception type design.</td></tr>
|
|
||||||
<tr><td>16</td><td>bd094dfc9a</td><td>feat(all): Remove unnecessary function.</td></tr>
|
|
||||||
<tr><td>17</td><td>7e9d7d6281</td><td>feat(all): Check if Groupchat exists before method.</td></tr>
|
|
||||||
<tr><td>18</td><td>2cf781459d</td><td>feat(all): Debug mode and translatable string</td></tr>
|
|
||||||
<tr><td>19</td><td>4ff9e3c81e</td><td>feat(all): Remove title from GroupchatDetails.</td></tr>
|
|
||||||
<tr><td>20</td><td>e337f1c579</td><td>feat(all): Minor refactors - naming.</td></tr>
|
|
||||||
<tr><td>21</td><td>7c840334e1</td><td>feat(all): Add docs to groupchat service methods.</td></tr>
|
|
||||||
<tr><td>22</td><td>06eab1d6f5</td><td>feat(all): Make ConversationType an enhanced enum.</td></tr>
|
|
||||||
<tr><td>23</td><td>008e816d70</td><td>feat(all): Rename JoinGroupchatResultEvent.</td></tr>
|
|
||||||
<tr><td>24</td><td>2bbbc164b5</td><td>feat(all): Remove incorrect translations.</td></tr>
|
|
||||||
<tr><td>25</td><td>11f4fd9932</td><td>feat(all): Add title to GroupchatDetails.</td></tr>
|
|
||||||
<tr><td>26</td><td>a1451c6fbf</td><td>feat(all): Refactor groupchat to new object in db.</td></tr>
|
|
||||||
<tr><td>27</td><td>993da40297</td><td>feat(all): Complete join groupchat flow.</td></tr>
|
|
||||||
<tr><td>28</td><td>09684b1268</td><td>feat(all): Fix fromDatabaseJson for MUC details.</td></tr>
|
|
||||||
<tr><td>29</td><td>0abb89cf38</td><td>feat(all): Fix database issues with nick.</td></tr>
|
|
||||||
<tr><td>30</td><td>7880f51b76</td><td>feat(all): Add db support for GroupchatDetails.</td></tr>
|
|
||||||
<tr><td>31</td><td>f0a79ca0e0</td><td>feat(all): Add GroupchatDetails model.</td></tr>
|
|
||||||
<tr><td>32</td><td>06dcd5491b</td><td>feat(all): Basic groupchat error handling set up.</td></tr>
|
|
||||||
<tr><td>33</td><td>3641be4f56</td><td>feat(all): Join room functionality complete.</td></tr>
|
|
||||||
<tr><td>34</td><td>18e28c3bbf</td><td>feat(all): Groupchat service/bloc updated.</td></tr>
|
|
||||||
<tr><td>35</td><td>62e39bf066</td><td>feat(all): Set base for groupchat implementation.</td></tr>
|
|
||||||
</tbody></table>
|
|
||||||
<h2 id="accomplishments">Accomplishments</h2>
|
|
||||||
<ul>
|
|
||||||
<li>
|
|
||||||
<p>Was able to produce a working model of groupchats in Moxxy.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Started the design approach from scratch and pretty much stuck to it till the end gave me confidence in my design capability.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Fruitful discussions and review cycles were conducted that allowed for a smooth GSoC experience.</p>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="challenges-faced">Challenges Faced</h2>
|
|
||||||
<ul>
|
|
||||||
<li>
|
|
||||||
<p>Needed to understand 2 different codebases, and the architecture of the project. This was a pretty interesting, albeit challenging task that took me a while to master.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Managing the busy schedule with GSoC work, family, college among other things was difficult. Also, managing a job in the latter parts was also challenging but a rewarding experience.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>The complete virtual approach was slightly difficult, and although not practical - it might have been slightly better with inter-GSoC meetings.</p>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="learnings-takeaways">Learnings/Takeaways</h2>
|
|
||||||
<ul>
|
|
||||||
<li>Implemented group chat (Multi-User Chat or MUC) support in the Moxxy project.</li>
|
|
||||||
<li>Successfully added features for joining a group chat room, sending messages to the room, and receiving messages from the room.</li>
|
|
||||||
<li>Learned to handle various aspects of XMPP communication, including sending and receiving messages, and interacting with group chat services.</li>
|
|
||||||
<li>Gained insights into implementing complex functionality in a Flutter application, involving UI components, service classes, and database interactions.</li>
|
|
||||||
<li>Collaborated with experienced developers through code reviews to improve code quality and ensure adherence to best practices.</li>
|
|
||||||
<li>Acquired knowledge of working with the XMPP protocol, understanding its intricacies and how it relates to group chat interactions.</li>
|
|
||||||
<li>Learned to manage and address feedback from code reviewers, making necessary adjustments to improve code readability and functionality.</li>
|
|
||||||
<li>Discovered the importance of proper error handling in real-time communication scenarios, such as handling different types of group chat errors.</li>
|
|
||||||
<li>Gained experience in integrating new features while maintaining the overall architecture and user experience of the application.</li>
|
|
||||||
<li>Understood the complexities of XMPP server behavior, including handling discussion history and preventing message loops.</li>
|
|
||||||
<li>Explored techniques for optimizing communication performance, such as preventing redundant message processing.</li>
|
|
||||||
<li>Improved skills in project management, including version control practices, managing branches, and resolving merge conflicts.</li>
|
|
||||||
<li>Gained familiarity with the process of creating, testing, and merging pull requests in a collaborative development environment.</li>
|
|
||||||
<li>Developed a better understanding of Flutter's state management, navigation, and widget composition for creating feature-rich user interfaces.</li>
|
|
||||||
<li>Learned to balance feature development with code quality, addressing both functional and non-functional aspects of the implementation.</li>
|
|
||||||
<li>Explored advanced Flutter topics, such as handling asynchronous operations, managing state, and integrating with external libraries.</li>
|
|
||||||
<li>Gained a deeper understanding of how group chat and real-time communication play a significant role in modern applications.</li>
|
|
||||||
<li>Developed the ability to diagnose and troubleshoot issues related to communication and user interface interactions.</li>
|
|
||||||
<li>Strengthened communication skills by participating in technical discussions and effectively conveying ideas and solutions.</li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="future-work">Future Work</h2>
|
|
||||||
<p>The future remaining work has been enlisted in this issue by my mentor <a href="https://codeberg.org/moxxy/moxxy/issues/315">here</a>.</p>
|
|
||||||
<p>This includes a list of improvements, bug fixes and general future requirements that will be needed to make the groupchat experience pleasurable for the users of Moxxy.</p>
|
|
||||||
<h2 id="conclusion">Conclusion</h2>
|
|
||||||
<p>Participating in GSoC has been an enriching experience. I've learned valuable skills, collaborated with mentors and the open-source community, and contributed to the Moxxy project. I'm grateful to XMPP Standards Foundation for this opportunity and look forward to continuing my journey in the world of open-source software development.</p>
|
|
||||||
<h2 id="acknowledgments">Acknowledgments</h2>
|
|
||||||
<p>I would like to express my gratitude to my mentor Alexander for their guidance and support throughout this project. His guidance and understanding is what allowed me to pull through and complete the GSoC with a happy mind. I also want to thank the XMPP Standards Foundation community for their encouragement and feedback.</p>
|
|
||||||
|
|
||||||
</article>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<footer class="h-8 w-full flex flex-row justify-center">
|
|
||||||
<span class="text-sm text-center">
|
|
||||||
Made with <3 by
|
|
||||||
<a class="text-sky-400" href="https://polynom.me" target="_blank" rel="noopener noreferrer">PapaTutuWawa</a>
|
|
||||||
using <a class="text-sky-400" href="https://tailwindcss.com/" target="_blank" rel="noopener noreferrer">TailwindCSS</a>,
|
|
||||||
<a class="text-sky-400" href="https://jekyllrb.com/" target="_blank" rel="noopener noreferrer">Jekyll</a> and
|
|
||||||
<a class="text-sky-400" href="https://heroicons.com/">heroicons</a>.
|
|
||||||
</span>
|
|
||||||
</footer>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,66 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<link href="https://moxxy.org/css/index.css" rel="stylesheet" />
|
|
||||||
<link rel="shortcut icon" href="https://moxxy.org/img/favicon.ico" sizes="32x32" />
|
|
||||||
<link href="https://moxxy.org/feed.xml" type="application/atom+xml" rel="alternate" title="Moxxy Blog" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta property="og:description" content="" />
|
|
||||||
<meta property="og:title" content="Moxxy's New Website" />
|
|
||||||
<title>Moxxy's New Website</title>
|
|
||||||
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="flex flex-col">
|
|
||||||
<div class="relative h-16 inset-x-0 inset-y-0 px-4 shadow-md grid place-items-center">
|
|
||||||
<div class="flex flex-row items-center w-full">
|
|
||||||
<!-- The Moxxy logo -->
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<img src="https://moxxy.org/img/logo.png" class="w-12 h-12 p-2" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<span class="font-bold">Moxxy</span>
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<!-- Spacer -->
|
|
||||||
<div class="grow"></div>
|
|
||||||
|
|
||||||
<a href="/blog/" class="px-2 text-sky-400">Blog</a>
|
|
||||||
<a href="https://moxxy.org/developers/" class="px-2 text-sky-400">Developers</a>
|
|
||||||
<a href="https://codeberg.org/moxxy/moxxy" class="px-2 text-sky-400">Source</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="w-full md:max-w-prose mt-2 mx-auto">
|
|
||||||
<div class="px-8">
|
|
||||||
<h1 class="text-3xl">Moxxy's New Website</h1>
|
|
||||||
<span>Posted by <span class="italic">PapaTutuWawa</span> on 2023-01-24</span>
|
|
||||||
<article class="mt-5 prose lg:prose-lg">
|
|
||||||
<p>Hello everyone! Welcome on Moxxy's new website. It currently does not contain
|
|
||||||
much but that may change in the future.</p>
|
|
||||||
<span id="continue-reading"></span>
|
|
||||||
<p>The page is built using <a href="https://jekyllrb.com/">Jekyll</a> and <a href="https://tailwindcss.com/">TailwindCSS</a>. You can find the page's
|
|
||||||
source <a href="https://codeberg.org/moxxy/website">here</a>.</p>
|
|
||||||
|
|
||||||
</article>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<footer class="h-8 w-full flex flex-row justify-center">
|
|
||||||
<span class="text-sm text-center">
|
|
||||||
Made with <3 by
|
|
||||||
<a class="text-sky-400" href="https://polynom.me" target="_blank" rel="noopener noreferrer">PapaTutuWawa</a>
|
|
||||||
using <a class="text-sky-400" href="https://tailwindcss.com/" target="_blank" rel="noopener noreferrer">TailwindCSS</a>,
|
|
||||||
<a class="text-sky-400" href="https://jekyllrb.com/" target="_blank" rel="noopener noreferrer">Jekyll</a> and
|
|
||||||
<a class="text-sky-400" href="https://heroicons.com/">heroicons</a>.
|
|
||||||
</span>
|
|
||||||
</footer>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,249 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<link href="https://moxxy.org/css/index.css" rel="stylesheet" />
|
|
||||||
<link rel="shortcut icon" href="https://moxxy.org/img/favicon.ico" sizes="32x32" />
|
|
||||||
<link href="https://moxxy.org/feed.xml" type="application/atom+xml" rel="alternate" title="Moxxy Blog" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta property="og:description" content="" />
|
|
||||||
<meta property="og:title" content="XEP-0045 implementation in Moxxmpp" />
|
|
||||||
<title>XEP-0045 implementation in Moxxmpp</title>
|
|
||||||
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="flex flex-col">
|
|
||||||
<div class="relative h-16 inset-x-0 inset-y-0 px-4 shadow-md grid place-items-center">
|
|
||||||
<div class="flex flex-row items-center w-full">
|
|
||||||
<!-- The Moxxy logo -->
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<img src="https://moxxy.org/img/logo.png" class="w-12 h-12 p-2" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<span class="font-bold">Moxxy</span>
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<!-- Spacer -->
|
|
||||||
<div class="grow"></div>
|
|
||||||
|
|
||||||
<a href="/blog/" class="px-2 text-sky-400">Blog</a>
|
|
||||||
<a href="https://moxxy.org/developers/" class="px-2 text-sky-400">Developers</a>
|
|
||||||
<a href="https://codeberg.org/moxxy/moxxy" class="px-2 text-sky-400">Source</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="w-full md:max-w-prose mt-2 mx-auto">
|
|
||||||
<div class="px-8">
|
|
||||||
<h1 class="text-3xl">XEP-0045 implementation in Moxxmpp</h1>
|
|
||||||
<span>Posted by <span class="italic">Ikjot Singh Dhody</span> on 2023-06-17</span>
|
|
||||||
<article class="mt-5 prose lg:prose-lg">
|
|
||||||
<p>Hello readers!</p>
|
|
||||||
<p>Welcome back to the GSoC series of blogs. This one is about my implementation of the MUC XEP (XEP-0045) in Moxxmpp.</p>
|
|
||||||
<span id="continue-reading"></span><h2 id="introduction">Introduction</h2>
|
|
||||||
<p>Well, as you probably know, Moxxy is the frontend app that is being developed as a modern new XMPP client.</p>
|
|
||||||
<p>Moxxmpp is a Dart package that is used by Moxxy for multiple XMPP services. Essentially, the conversation between Moxxy and the XMPP server is handled by Moxxmpp. It is like the middleman that helps ease the communication between the two, keeping Moxxy code clean and free from the intricacies it handles.</p>
|
|
||||||
<p>Since my GSoC project is all about adding MUC support to Moxxy, it was essential to first add the required support in Moxxmpp before proceeding to Moxxy. This blog will give you an idea of what the responsibilities of Moxxmpp are, and why it was important to separate it from Moxxy.</p>
|
|
||||||
<h2 id="what-is-moxxmpp">What is Moxxmpp?</h2>
|
|
||||||
<p>In the words of it's developer, Moxxmpp is "a pure-Dart XMPP library". Moxxmpp could be thought of as the backbone of Moxxy. The entire communication/networking part of Moxxy, i.e. how it (as a client) communicates with the user's XMPP server is outsourced to this Dart library.</p>
|
|
||||||
<p>Not only this, used as per it's rules - Moxxmpp could be used by any client to perform XMPP tasks that are currently supported by it. It is a re-usable and versatile XMPP library.</p>
|
|
||||||
<p>Listed below are some of it's core responsibilities:</p>
|
|
||||||
<ol>
|
|
||||||
<li>
|
|
||||||
<p>Establishing the connection between the client and the XMPP server via the user's JID and password.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Allowing Moxxy/any front-end client to register managers that provide support for a particular XEP/part of the XMPP flow. For example: the messaging service is handled by a MessageManager.
|
|
||||||
Similarly here are some other managers with their use:</p>
|
|
||||||
<ol>
|
|
||||||
<li>PresenceManager: Handling the presence related stanzas/use.</li>
|
|
||||||
<li>PubSubManager: Provides support for XEP-0060.</li>
|
|
||||||
<li>DiscoManager: Provides support for the service discovery: XEP-0030.</li>
|
|
||||||
<li>RosterManager: Handling roster related tasks.</li>
|
|
||||||
<li>BlockingManager: For blocking related tasks.</li>
|
|
||||||
</ol>
|
|
||||||
<p>As of June 17 2023, there are 35 such managers and 35 XEPs supported in Moxxmpp.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Managing cache: Moxxmpp manages cache of common requests, such as service discovery requests. If a request is duplicated, the result is provided from the cache - saving bandwidth and time.</p>
|
|
||||||
</li>
|
|
||||||
</ol>
|
|
||||||
<p>As explained below, new XEP support is related to adding new managers to Moxxmpp and I will be doing the same for XEP-0045 support in Moxxy. My design plan is elaborated in the next section. </p>
|
|
||||||
<p>Here is my implementation plan for adding XEP-0045 support to Moxxmpp.</p>
|
|
||||||
<h2 id="gsoc-moxxmpp-implementation-design-plan">GSoC Moxxmpp Implementation Design Plan</h2>
|
|
||||||
<h3 id="directory-structure">Directory Structure</h3>
|
|
||||||
<ul>
|
|
||||||
<li>xep_0045
|
|
||||||
<ul>
|
|
||||||
<li>errors.dart</li>
|
|
||||||
<li>helpers.dart</li>
|
|
||||||
<li>types.dart</li>
|
|
||||||
<li>xep_0045.dart</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>Here, the errors.dart file will contain the abstract classes for different errors that one could get whilst going through all the lifecycle use-cases of the MUC feature.</li>
|
|
||||||
<li>The helpers.dart file will have some helper functions to maintain (DRY code avoiding repetition) and (modularized code).</li>
|
|
||||||
<li>types.dart will contain model classes for the events and other entities.</li>
|
|
||||||
<li>The xep_0045.dart is the main file which will contain the exposed routines as shown below, as well as the incoming stanza handlers.</li>
|
|
||||||
</ul>
|
|
||||||
<h3 id="phase-1-query-room-information">Phase 1 - Query Room Information</h3>
|
|
||||||
<h4 id="future-result-roominformation-mucerror-queryroominformation-jid-roomjid"><code>Future<Result<RoomInformation,MUCError>> queryRoomInformation(JID roomJID)</code></h4>
|
|
||||||
<p>This routine will allow the users to view the features of the room. These will include whether the room is open, moderated, password protected, etc. All this will be stored in a RoomInformation object and sent back as a Result object. It is important to note that the MUC server's address (for the 'to' attribute) will be parsed from the latter half of the room JID (the part post the '@').</p>
|
|
||||||
<p>The parameters of the RoomInformation class will be represented in the following way:</p>
|
|
||||||
<ol>
|
|
||||||
<li><code>JID roomJID</code></li>
|
|
||||||
<li><code>List<String> feature_list</code></li>
|
|
||||||
</ol>
|
|
||||||
<h3 id="phase-2-join-leave-room-handle-errors">Phase 2 - Join/Leave Room(Handle errors)</h3>
|
|
||||||
<p>To join/leave a room we can send an appropriate presence stanza that will handle the same for us. So we will have two simple routines for the same as well.</p>
|
|
||||||
<h3 id="routines">Routines</h3>
|
|
||||||
<h4 id="future-result-bool-mucerror-joinroom-jid-roomjid"><code>Future<Result>bool, MUCError>> joinRoom(JID roomJID)</code></h4>
|
|
||||||
<p>This routine will send a presence stanza to the MUC server asking it to join the server. It takes the <code>roomJID</code> as a parameter that will essentially contain the bare JID as well as the nickname (prompted from the user) as the resource. This will be preceded by the queryRoomInformation() routine call to obtain necessary information about the room, for example: if the room is password protected (in which case the user will see a not-implemented error dialog till a time it is supported).</p>
|
|
||||||
<p>Important to note is that the user's nickname will be used as the 'resource' in the roomJID sent by the frontend. This is because the 'to' attribute of a presence stanza to join a room looks as such - <code>{local/MUC}@{domain/chat server}/{nickname}.</code></p>
|
|
||||||
<h4 id="future-result-bool-mucerror-leaveroom-jid-roomjid"><code>Future<Result<bool, MUCError>> leaveRoom(JID roomJID)</code></h4>
|
|
||||||
<p>Similarly this is a routine to allow for leaving the room with a presence stanza.</p>
|
|
||||||
<p>The boolean return type is just to allow for a simple return object with the Result type. We could move forward with a simple Future<bool> as well, but for the sake of consistency - maybe sticking to the former is better. </p>
|
|
||||||
<h3 id="phase-3-refactor-sendmessage-to-handle-mucs">Phase 3 - Refactor sendMessage to handle MUCs</h3>
|
|
||||||
<p>To be able to send messages to groupchats/MUCs, the main requirement is to be able to change the <code>type</code> attribute in the message stanzas from <code>chat</code> to <code>groupchat</code>. This can be done in one of two ways. The first way will be to change the <code>sendMessage</code> routine's description to include a <code>type</code> parameter that will simply transfer over to the stanza that will be sent from moxxmpp as a string. Another was is described below, where a new extension called ConversationTypeData will be added to the <code>StanzaHandlerExtension</code> object whilst calling the sendMessage routine. The former solution is simpler and will most probably be implemented. The design for both these possibilities is listed below.</p>
|
|
||||||
<h4 id="solution-1">Solution 1</h4>
|
|
||||||
<p>The <code>sendMessage</code> routine will transform from </p>
|
|
||||||
<pre data-lang="Dart" class="language-Dart "><code class="language-Dart" data-lang="Dart">Future<void> sendMessage(
|
|
||||||
JID to,
|
|
||||||
TypedMap<StanzaHandlerExtension> extensions,
|
|
||||||
) async {
|
|
||||||
await getAttributes().sendStanza(
|
|
||||||
StanzaDetails(
|
|
||||||
Stanza.message(
|
|
||||||
to: to.toString(),
|
|
||||||
id: extensions.get<MessageIdData>()?.id,
|
|
||||||
type: 'chat',
|
|
||||||
children: _messageSendingCallbacks
|
|
||||||
.map((c) => c(extensions))
|
|
||||||
.flattened
|
|
||||||
.toList(),
|
|
||||||
),
|
|
||||||
awaitable: false,
|
|
||||||
),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
</code></pre>
|
|
||||||
<p>to</p>
|
|
||||||
<pre data-lang="Dart" class="language-Dart "><code class="language-Dart" data-lang="Dart">Future<void> sendMessage(
|
|
||||||
JID to,
|
|
||||||
TypedMap<StanzaHandlerExtension> extensions,
|
|
||||||
String type,
|
|
||||||
) async {
|
|
||||||
await getAttributes().sendStanza(
|
|
||||||
StanzaDetails(
|
|
||||||
Stanza.message(
|
|
||||||
to: to.toString(),
|
|
||||||
id: extensions.get<MessageIdData>()?.id,
|
|
||||||
type: type,
|
|
||||||
children: _messageSendingCallbacks
|
|
||||||
.map((c) => c(extensions))
|
|
||||||
.flattened
|
|
||||||
.toList(),
|
|
||||||
),
|
|
||||||
awaitable: false,
|
|
||||||
),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
</code></pre>
|
|
||||||
<h4 id="solution-2">Solution 2</h4>
|
|
||||||
<pre data-lang="Dart" class="language-Dart "><code class="language-Dart" data-lang="Dart">enum ConversationType {
|
|
||||||
chat, groupchat, groupchatprivate
|
|
||||||
}
|
|
||||||
</code></pre>
|
|
||||||
<p>The <code>ConversationTypeData</code> class essentially will act as a wrapper over the above enum. </p>
|
|
||||||
<p>Hence the new type attribute value will be:</p>
|
|
||||||
<pre data-lang="Dart" class="language-Dart "><code class="language-Dart" data-lang="Dart">extensions.get<ConversationTypeData>()?.conversationType ==
|
|
||||||
ConversationType.groupchat
|
|
||||||
? 'groupchat'
|
|
||||||
: 'chat',
|
|
||||||
</code></pre>
|
|
||||||
<p>Here, <code>ConversationTypeData</code> is a simple wrapper over <code>ConversationType</code> so that it can be recognized as a subclass of the <code>StanzaHandlerExtensions</code> class.</p>
|
|
||||||
<p>For private MUC messages to a single participant, the <code>type</code> attribute of the message stanza should be set to <code>chat</code>. This can be handled very easily in case of either solution implementation. </p>
|
|
||||||
<hr />
|
|
||||||
<p>For MUC messages with a stanza reflecting a chat server (type: 'groupchat'), the type in the MessageEvent will be set to 'groupchat' automatically. The rest will be handled similarly to 1:1 chats.</p>
|
|
||||||
<h3 id="phase-4-miscellaneous-requirements">Phase 4 - Miscellaneous requirements</h3>
|
|
||||||
<p>Some of the miscellaneous requirements from Moxxmpp could include viewing member list, group subject, change availability status, and more.
|
|
||||||
For now, I have identified the below as the most crucial requirements for the Moxxmpp feature additions for MUC. </p>
|
|
||||||
<p>Below are the use-cases and how they are planned to be handled:</p>
|
|
||||||
<ol>
|
|
||||||
<li>Get member list</li>
|
|
||||||
</ol>
|
|
||||||
<p>After one joins a room, the user receives a presence from all the connected users to the chat. The best way to get the member list is to capture/handle the incoming presence stanzas and send an appropriate <code>MUCPresenceReceived</code> event to the UI.</p>
|
|
||||||
<p>This way, whenever a user joins a room, they can see the current member list, and on subsequent presence updates, also change that list.</p>
|
|
||||||
<ol start="2">
|
|
||||||
<li>Handling the room subject</li>
|
|
||||||
</ol>
|
|
||||||
<p>This is a very simple usecase. When a disco info query about the MUC goes out to the XMPP server, the response contains an identity node containing the chat name. This would be the best way to extract the rom subject. As of now, the <code>queryRoomInformation</code> routine will be triggered from the UI and the response will be sent to the same. This will be encapsulated in a simple <code>RoomInformation</code> class which is now updated as follows:</p>
|
|
||||||
<ol>
|
|
||||||
<li><code>JID roomJID</code></li>
|
|
||||||
<li><code>List<String> feature_list</code></li>
|
|
||||||
<li><code>String name</code></li>
|
|
||||||
</ol>
|
|
||||||
<p><strong>Note</strong>: Changing your status seemed like a task that would be slighlty out of scope for the project duration, so that is kept as a stretch goal for now.</p>
|
|
||||||
<h3 id="errors">Errors</h3>
|
|
||||||
<p>Frontend checks while joining a room to prevent avoidable errors:</p>
|
|
||||||
<ul>
|
|
||||||
<li>Nickname must be specified in accordance with the rules of the XEP - to prevent the no nickname specified error.</li>
|
|
||||||
<li>Validations for JID input field.</li>
|
|
||||||
<li>Validation for checking empty nickname.</li>
|
|
||||||
</ul>
|
|
||||||
<p>Some of the possible errors that can be faced by the user in an MUC workflow are:</p>
|
|
||||||
<ul>
|
|
||||||
<li>Invalid/Already in use nickname</li>
|
|
||||||
<li>Not allowed to register</li>
|
|
||||||
<li>Invalid stanza format</li>
|
|
||||||
<li>Invalid Disco Info Response: In case of some rare edge cases (not handled currently) where the response does not contain some information like the room name, or the features of the room. </li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="challenges-noted">Challenges noted</h2>
|
|
||||||
<p>Some challenges/room for error were noted along the way. They are enumerated below:</p>
|
|
||||||
<ol>
|
|
||||||
<li>
|
|
||||||
<p>How will Moxxy/Moxxmpp handle messages from oneself?</p>
|
|
||||||
<p>When a user sends a message on the MUC, they receive the message themselves as well. How will moxxmpp/moxxy differentiate between other live messages and this echoed message? </p>
|
|
||||||
<p>The solution to this problem is to use the origin-id of the message. If the origin-id of the response matches with the sent origin-id, then the message is to be ignored and not shown in the UI. </p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>In anonymous MUCs, one can easily act as someone else by using their nickname once they leave. How will this be handled?</p>
|
|
||||||
<p>This is fixed by using the occupant-id property as described in XEP-0421. A user (with their unique JID) when joins the group, is assigned a unique occupant-id, which can be used to actually track which message is from which user. </p>
|
|
||||||
<p>This makes the implementation of reactions/retractions simpler. </p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>How will discussion history (sent on joining an MUC) be handled when someone rejoins an MUC?</p>
|
|
||||||
<p>When a user joins a MUC, they are sent a set of stanzas in the following order:</p>
|
|
||||||
<pre><code> 1. Errors (if any)
|
|
||||||
2. Self presence with status code
|
|
||||||
3. Room history
|
|
||||||
4. Room subject
|
|
||||||
5. Live message/presence updates
|
|
||||||
</code></pre>
|
|
||||||
<p>Now, when a user gets disconnected from an MUC and joins again, then the room history will be sent again as well. To prevent this history from getting appended to the conversation in the UI, we will need to wait till we receive the room subject and only then start listening for message stanzas (since room subject is sent after room history).</p>
|
|
||||||
</li>
|
|
||||||
</ol>
|
|
||||||
<h2 id="conclusion-and-future-work">Conclusion and future work</h2>
|
|
||||||
<p>In conclusion, this blog post discussed the implementation plan for adding Multi-User Chat (MUC) support, specifically XEP-0045, to Moxxmpp. Moxxmpp serves as the backbone for the Moxxy XMPP client, handling the communication between the client and XMPP server. The blog outlined the directory structure, design plan, and key routines for implementing the MUC support in Moxxmpp. It also addressed some challenges and considerations related to handling MUC features.</p>
|
|
||||||
<p>Implementation for this has begun, and a <a href="https://codeberg.org/moxxy/moxxmpp/pulls/46">PR</a> is already underway. Once this PR is completed, then work will begin on the front-end and the changes will be integrated into Moxxy.</p>
|
|
||||||
|
|
||||||
</article>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<footer class="h-8 w-full flex flex-row justify-center">
|
|
||||||
<span class="text-sm text-center">
|
|
||||||
Made with <3 by
|
|
||||||
<a class="text-sky-400" href="https://polynom.me" target="_blank" rel="noopener noreferrer">PapaTutuWawa</a>
|
|
||||||
using <a class="text-sky-400" href="https://tailwindcss.com/" target="_blank" rel="noopener noreferrer">TailwindCSS</a>,
|
|
||||||
<a class="text-sky-400" href="https://jekyllrb.com/" target="_blank" rel="noopener noreferrer">Jekyll</a> and
|
|
||||||
<a class="text-sky-400" href="https://heroicons.com/">heroicons</a>.
|
|
||||||
</span>
|
|
||||||
</footer>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
82
config.toml
Normal file
82
config.toml
Normal file
@ -0,0 +1,82 @@
|
|||||||
|
base_url = "https://moxxy.org"
|
||||||
|
title = "Moxxy | A modern XMPP client"
|
||||||
|
description = "A modern XMPP client"
|
||||||
|
|
||||||
|
compile_sass = false
|
||||||
|
build_search_index = false
|
||||||
|
generate_feed = true
|
||||||
|
feed_filename = "feed.xml"
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
heroText = "An experimental and modern XMPP client"
|
||||||
|
mainScreenshot = "img/screenshots/1.png"
|
||||||
|
|
||||||
|
features = [
|
||||||
|
"End-to-End encryption using OMEMO (0.8.3)",
|
||||||
|
"Stickers",
|
||||||
|
"Reactions",
|
||||||
|
"Retract messages",
|
||||||
|
"Voice messages",
|
||||||
|
"Swipe-to-quote",
|
||||||
|
"Chat background images",
|
||||||
|
"Optional privacy-preserving integration with phone contacts",
|
||||||
|
"Open-Source"
|
||||||
|
]
|
||||||
|
|
||||||
|
screenshots = [
|
||||||
|
"img/screenshots/1.png",
|
||||||
|
"img/screenshots/2.png",
|
||||||
|
]
|
||||||
|
|
||||||
|
sourceUrl = "https://codeberg.org/moxxy/moxxy"
|
||||||
|
githubMirrorUrl = "https://github.com/PapaTutuWawa/moxxy"
|
||||||
|
generalMuc = "xmpp:moxxy@muc.moxxy.org?join"
|
||||||
|
developmentMuc = "xmpp:dev@muc.moxxy.org?join"
|
||||||
|
|
||||||
|
[[extra.libraries]]
|
||||||
|
url = "https://codeberg.org/moxxy/moxxmpp"
|
||||||
|
name = "moxxmpp"
|
||||||
|
desc = "XMPP library written in Dart"
|
||||||
|
specific = false
|
||||||
|
|
||||||
|
[[extra.libraries]]
|
||||||
|
url = "https://codeberg.org/moxxy/moxdns"
|
||||||
|
name = "moxdns"
|
||||||
|
desc = "DNS SRV resolver for Flutter"
|
||||||
|
specific = true
|
||||||
|
|
||||||
|
[[extra.libraries]]
|
||||||
|
url = "https://codeberg.org/moxxy/moxlib"
|
||||||
|
name = "moxlib"
|
||||||
|
desc = "Shared functions for Moxxy-specific projects"
|
||||||
|
specific = true
|
||||||
|
|
||||||
|
[[extra.libraries]]
|
||||||
|
url = "https://codeberg.org/moxxy/moxxy_native"
|
||||||
|
name = "moxxy_native"
|
||||||
|
desc = "Platform-specific code"
|
||||||
|
specific = true
|
||||||
|
|
||||||
|
[[extra.libraries]]
|
||||||
|
url = "https://codeberg.org/PapaTutuWawa/omemo_dart"
|
||||||
|
name = "omemo_dart"
|
||||||
|
desc = "Implementation of the cryptography for OMEMO 0.8.3 with a high-level interface"
|
||||||
|
specific = false
|
||||||
|
|
||||||
|
[[extra.customXeps]]
|
||||||
|
name = "Extensible File Thumbnails"
|
||||||
|
desc = "Provide an extensible way of specifying thumbnails that are neccessarily binary data"
|
||||||
|
url = "https://codeberg.org/moxxy/custom-xeps/src/branch/master/xep-xxxx-extensible-file-thumbnails.md"
|
||||||
|
|
||||||
|
[[extra.customXeps]]
|
||||||
|
name = "File Upload Notification"
|
||||||
|
desc = "Allow communicating that an OOB file upload is currently running to improve the consistency of the conversation"
|
||||||
|
url = "https://codeberg.org/moxxy/custom-xeps/src/branch/master/xep-xxxx-file-upload-notification.md"
|
||||||
|
|
||||||
|
[[extra.badges]]
|
||||||
|
url = "https://apt.izzysoft.de/fdroid/index/apk/org.moxxy.moxxyv2"
|
||||||
|
image = "img/badges/IzzyOnDroid.png"
|
||||||
|
|
||||||
|
[[extra.badges]]
|
||||||
|
url = "https://codeberg.org/moxxy/moxxy/releases/latest"
|
||||||
|
image = "img/badges/codeberg.png"
|
||||||
3
content/_index.md
Normal file
3
content/_index.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
+++
|
||||||
|
template = "index.html"
|
||||||
|
+++
|
||||||
18
content/blog/2023-01-24-Moxxys-New-Website.md
Normal file
18
content/blog/2023-01-24-Moxxys-New-Website.md
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
+++
|
||||||
|
title = "Moxxy's New Website"
|
||||||
|
date = "2023-01-24"
|
||||||
|
template = "post.html"
|
||||||
|
|
||||||
|
aliases = [ "posts/2023-01-24-Moxxys-New-Website.html" ]
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
author = "PapaTutuWawa"
|
||||||
|
+++
|
||||||
|
|
||||||
|
Hello everyone! Welcome on Moxxy's new website. It currently does not contain
|
||||||
|
much but that may change in the future.
|
||||||
|
|
||||||
|
<!-- more -->
|
||||||
|
|
||||||
|
The page is built using [Jekyll](https://jekyllrb.com/) and [TailwindCSS](https://tailwindcss.com/). You can find the page's
|
||||||
|
source [here](https://codeberg.org/moxxy/website).
|
||||||
34
content/blog/2023-05-06-Groupchat-GSoC-Project.md
Normal file
34
content/blog/2023-05-06-Groupchat-GSoC-Project.md
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
+++
|
||||||
|
title = "Moxxy's First GSoC Project!"
|
||||||
|
date = "2023-05-06"
|
||||||
|
template = "post.html"
|
||||||
|
|
||||||
|
aliases = [ "posts/2023-05-06-Groupchat-GSoC-Project.html" ]
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
author = "Ikjot Singh Dhody"
|
||||||
|
+++
|
||||||
|
|
||||||
|
Hello readers!
|
||||||
|
|
||||||
|
As we know, Moxxy is an experimental IM for XMPP built using Flutter. While it does have a great set of features as described [here](https://moxxy.org/), it currently lacks support for group chats (or Multi-User-Chats). A great piece of news is that Google has accepted my proposal to add support for multi user chats in Moxxy.
|
||||||
|
|
||||||
|
<!-- more -->
|
||||||
|
|
||||||
|
To implement multi user chats in Moxxy, the [XEP-0045](https://xmpp.org/extensions/xep-0045.html) standard will be followed and implemented. The project will run in two phases, since the major changes required will be in the [moxxmpp](https://codeberg.org/moxxy/moxxmpp) and [Moxxy](https://codeberg.org/moxxy/moxxy) codebases. First, XEP-0045 support will be added to moxxmpp with all the handlers, events and routines required to cleanly integrate the same with Moxxy. The second phase will be the UI changes in the Moxxy Flutter application, that builds upon the existing, reusable infrastructure.
|
||||||
|
|
||||||
|
The usecases planned to be implemented are listed below (subject to changes before the coding period begins):
|
||||||
|
- Join a room
|
||||||
|
- Leave a room
|
||||||
|
- Change availability status
|
||||||
|
- View member list
|
||||||
|
- Send/receive a message to/from all occupants
|
||||||
|
- Send/receive a private message to/from a specific occupant
|
||||||
|
|
||||||
|
Some extra usecases are planned in case time permits:
|
||||||
|
- Change nickname
|
||||||
|
- Kick an occupant (if user has such a permission)
|
||||||
|
- Ban an occupant (if user has such a permission)
|
||||||
|
- Grant/revoke membership (if user has such a permission)
|
||||||
|
|
||||||
|
The coding period for this project will begin on May 29. In case of any queries/interest, please join the following - [xmpp:dev@muc.moxxy.org?join](xmpp:dev@muc.moxxy.org?join).
|
||||||
241
content/blog/2023-06-17-XEP-0045-In-Moxxmpp.md
Normal file
241
content/blog/2023-06-17-XEP-0045-In-Moxxmpp.md
Normal file
@ -0,0 +1,241 @@
|
|||||||
|
+++
|
||||||
|
title = "XEP-0045 implementation in Moxxmpp"
|
||||||
|
date = "2023-06-17"
|
||||||
|
template = "post.html"
|
||||||
|
|
||||||
|
aliases = [ "posts/2023-06-17-XEP-0045-In-Moxxmpp.html" ]
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
author = "Ikjot Singh Dhody"
|
||||||
|
+++
|
||||||
|
|
||||||
|
Hello readers!
|
||||||
|
|
||||||
|
Welcome back to the GSoC series of blogs. This one is about my implementation of the MUC XEP (XEP-0045) in Moxxmpp.
|
||||||
|
|
||||||
|
<!-- more -->
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
Well, as you probably know, Moxxy is the frontend app that is being developed as a modern new XMPP client.
|
||||||
|
|
||||||
|
Moxxmpp is a Dart package that is used by Moxxy for multiple XMPP services. Essentially, the conversation between Moxxy and the XMPP server is handled by Moxxmpp. It is like the middleman that helps ease the communication between the two, keeping Moxxy code clean and free from the intricacies it handles.
|
||||||
|
|
||||||
|
Since my GSoC project is all about adding MUC support to Moxxy, it was essential to first add the required support in Moxxmpp before proceeding to Moxxy. This blog will give you an idea of what the responsibilities of Moxxmpp are, and why it was important to separate it from Moxxy.
|
||||||
|
|
||||||
|
## What is Moxxmpp?
|
||||||
|
|
||||||
|
In the words of it's developer, Moxxmpp is "a pure-Dart XMPP library". Moxxmpp could be thought of as the backbone of Moxxy. The entire communication/networking part of Moxxy, i.e. how it (as a client) communicates with the user's XMPP server is outsourced to this Dart library.
|
||||||
|
|
||||||
|
Not only this, used as per it's rules - Moxxmpp could be used by any client to perform XMPP tasks that are currently supported by it. It is a re-usable and versatile XMPP library.
|
||||||
|
|
||||||
|
Listed below are some of it's core responsibilities:
|
||||||
|
1. Establishing the connection between the client and the XMPP server via the user's JID and password.
|
||||||
|
2. Allowing Moxxy/any front-end client to register managers that provide support for a particular XEP/part of the XMPP flow. For example: the messaging service is handled by a MessageManager.
|
||||||
|
Similarly here are some other managers with their use:
|
||||||
|
1. PresenceManager: Handling the presence related stanzas/use.
|
||||||
|
2. PubSubManager: Provides support for XEP-0060.
|
||||||
|
3. DiscoManager: Provides support for the service discovery: XEP-0030.
|
||||||
|
4. RosterManager: Handling roster related tasks.
|
||||||
|
5. BlockingManager: For blocking related tasks.
|
||||||
|
|
||||||
|
As of June 17 2023, there are 35 such managers and 35 XEPs supported in Moxxmpp.
|
||||||
|
|
||||||
|
3. Managing cache: Moxxmpp manages cache of common requests, such as service discovery requests. If a request is duplicated, the result is provided from the cache - saving bandwidth and time.
|
||||||
|
|
||||||
|
As explained below, new XEP support is related to adding new managers to Moxxmpp and I will be doing the same for XEP-0045 support in Moxxy. My design plan is elaborated in the next section.
|
||||||
|
|
||||||
|
Here is my implementation plan for adding XEP-0045 support to Moxxmpp.
|
||||||
|
|
||||||
|
## GSoC Moxxmpp Implementation Design Plan
|
||||||
|
|
||||||
|
### Directory Structure
|
||||||
|
|
||||||
|
* xep_0045
|
||||||
|
* errors.dart
|
||||||
|
* helpers.dart
|
||||||
|
* types.dart
|
||||||
|
* xep_0045.dart
|
||||||
|
* Here, the errors.dart file will contain the abstract classes for different errors that one could get whilst going through all the lifecycle use-cases of the MUC feature.
|
||||||
|
* The helpers.dart file will have some helper functions to maintain (DRY code avoiding repetition) and (modularized code).
|
||||||
|
* types.dart will contain model classes for the events and other entities.
|
||||||
|
* The xep_0045.dart is the main file which will contain the exposed routines as shown below, as well as the incoming stanza handlers.
|
||||||
|
|
||||||
|
### Phase 1 - Query Room Information
|
||||||
|
|
||||||
|
#### `Future<Result<RoomInformation,MUCError>> queryRoomInformation(JID roomJID)`
|
||||||
|
This routine will allow the users to view the features of the room. These will include whether the room is open, moderated, password protected, etc. All this will be stored in a RoomInformation object and sent back as a Result object. It is important to note that the MUC server's address (for the 'to' attribute) will be parsed from the latter half of the room JID (the part post the '@').
|
||||||
|
|
||||||
|
The parameters of the RoomInformation class will be represented in the following way:
|
||||||
|
|
||||||
|
1. `JID roomJID`
|
||||||
|
2. `List<String> feature_list`
|
||||||
|
|
||||||
|
### Phase 2 - Join/Leave Room(Handle errors)
|
||||||
|
To join/leave a room we can send an appropriate presence stanza that will handle the same for us. So we will have two simple routines for the same as well.
|
||||||
|
|
||||||
|
### Routines
|
||||||
|
|
||||||
|
#### `Future<Result>bool, MUCError>> joinRoom(JID roomJID)`
|
||||||
|
|
||||||
|
This routine will send a presence stanza to the MUC server asking it to join the server. It takes the `roomJID` as a parameter that will essentially contain the bare JID as well as the nickname (prompted from the user) as the resource. This will be preceded by the queryRoomInformation() routine call to obtain necessary information about the room, for example: if the room is password protected (in which case the user will see a not-implemented error dialog till a time it is supported).
|
||||||
|
|
||||||
|
Important to note is that the user's nickname will be used as the 'resource' in the roomJID sent by the frontend. This is because the 'to' attribute of a presence stanza to join a room looks as such - `{local/MUC}@{domain/chat server}/{nickname}.`
|
||||||
|
|
||||||
|
#### `Future<Result<bool, MUCError>> leaveRoom(JID roomJID)`
|
||||||
|
|
||||||
|
Similarly this is a routine to allow for leaving the room with a presence stanza.
|
||||||
|
|
||||||
|
The boolean return type is just to allow for a simple return object with the Result type. We could move forward with a simple Future<bool> as well, but for the sake of consistency - maybe sticking to the former is better.
|
||||||
|
|
||||||
|
### Phase 3 - Refactor sendMessage to handle MUCs
|
||||||
|
To be able to send messages to groupchats/MUCs, the main requirement is to be able to change the `type` attribute in the message stanzas from `chat` to `groupchat`. This can be done in one of two ways. The first way will be to change the `sendMessage` routine's description to include a `type` parameter that will simply transfer over to the stanza that will be sent from moxxmpp as a string. Another was is described below, where a new extension called ConversationTypeData will be added to the `StanzaHandlerExtension` object whilst calling the sendMessage routine. The former solution is simpler and will most probably be implemented. The design for both these possibilities is listed below.
|
||||||
|
|
||||||
|
#### Solution 1
|
||||||
|
|
||||||
|
The `sendMessage` routine will transform from
|
||||||
|
|
||||||
|
|
||||||
|
```Dart
|
||||||
|
Future<void> sendMessage(
|
||||||
|
JID to,
|
||||||
|
TypedMap<StanzaHandlerExtension> extensions,
|
||||||
|
) async {
|
||||||
|
await getAttributes().sendStanza(
|
||||||
|
StanzaDetails(
|
||||||
|
Stanza.message(
|
||||||
|
to: to.toString(),
|
||||||
|
id: extensions.get<MessageIdData>()?.id,
|
||||||
|
type: 'chat',
|
||||||
|
children: _messageSendingCallbacks
|
||||||
|
.map((c) => c(extensions))
|
||||||
|
.flattened
|
||||||
|
.toList(),
|
||||||
|
),
|
||||||
|
awaitable: false,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
to
|
||||||
|
|
||||||
|
```Dart
|
||||||
|
Future<void> sendMessage(
|
||||||
|
JID to,
|
||||||
|
TypedMap<StanzaHandlerExtension> extensions,
|
||||||
|
String type,
|
||||||
|
) async {
|
||||||
|
await getAttributes().sendStanza(
|
||||||
|
StanzaDetails(
|
||||||
|
Stanza.message(
|
||||||
|
to: to.toString(),
|
||||||
|
id: extensions.get<MessageIdData>()?.id,
|
||||||
|
type: type,
|
||||||
|
children: _messageSendingCallbacks
|
||||||
|
.map((c) => c(extensions))
|
||||||
|
.flattened
|
||||||
|
.toList(),
|
||||||
|
),
|
||||||
|
awaitable: false,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Solution 2
|
||||||
|
|
||||||
|
```Dart
|
||||||
|
enum ConversationType {
|
||||||
|
chat, groupchat, groupchatprivate
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `ConversationTypeData` class essentially will act as a wrapper over the above enum.
|
||||||
|
|
||||||
|
Hence the new type attribute value will be:
|
||||||
|
```Dart
|
||||||
|
extensions.get<ConversationTypeData>()?.conversationType ==
|
||||||
|
ConversationType.groupchat
|
||||||
|
? 'groupchat'
|
||||||
|
: 'chat',
|
||||||
|
```
|
||||||
|
|
||||||
|
Here, `ConversationTypeData` is a simple wrapper over `ConversationType` so that it can be recognized as a subclass of the `StanzaHandlerExtensions` class.
|
||||||
|
|
||||||
|
For private MUC messages to a single participant, the `type` attribute of the message stanza should be set to `chat`. This can be handled very easily in case of either solution implementation.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
For MUC messages with a stanza reflecting a chat server (type: 'groupchat'), the type in the MessageEvent will be set to 'groupchat' automatically. The rest will be handled similarly to 1:1 chats.
|
||||||
|
|
||||||
|
### Phase 4 - Miscellaneous requirements
|
||||||
|
Some of the miscellaneous requirements from Moxxmpp could include viewing member list, group subject, change availability status, and more.
|
||||||
|
For now, I have identified the below as the most crucial requirements for the Moxxmpp feature additions for MUC.
|
||||||
|
|
||||||
|
Below are the use-cases and how they are planned to be handled:
|
||||||
|
|
||||||
|
1. Get member list
|
||||||
|
|
||||||
|
After one joins a room, the user receives a presence from all the connected users to the chat. The best way to get the member list is to capture/handle the incoming presence stanzas and send an appropriate `MUCPresenceReceived` event to the UI.
|
||||||
|
|
||||||
|
This way, whenever a user joins a room, they can see the current member list, and on subsequent presence updates, also change that list.
|
||||||
|
|
||||||
|
2. Handling the room subject
|
||||||
|
|
||||||
|
This is a very simple usecase. When a disco info query about the MUC goes out to the XMPP server, the response contains an identity node containing the chat name. This would be the best way to extract the rom subject. As of now, the `queryRoomInformation` routine will be triggered from the UI and the response will be sent to the same. This will be encapsulated in a simple `RoomInformation` class which is now updated as follows:
|
||||||
|
|
||||||
|
1. `JID roomJID`
|
||||||
|
2. `List<String> feature_list`
|
||||||
|
3. `String name`
|
||||||
|
|
||||||
|
**Note**: Changing your status seemed like a task that would be slighlty out of scope for the project duration, so that is kept as a stretch goal for now.
|
||||||
|
|
||||||
|
### Errors
|
||||||
|
Frontend checks while joining a room to prevent avoidable errors:
|
||||||
|
|
||||||
|
* Nickname must be specified in accordance with the rules of the XEP - to prevent the no nickname specified error.
|
||||||
|
* Validations for JID input field.
|
||||||
|
* Validation for checking empty nickname.
|
||||||
|
|
||||||
|
Some of the possible errors that can be faced by the user in an MUC workflow are:
|
||||||
|
|
||||||
|
* Invalid/Already in use nickname
|
||||||
|
* Not allowed to register
|
||||||
|
* Invalid stanza format
|
||||||
|
* Invalid Disco Info Response: In case of some rare edge cases (not handled currently) where the response does not contain some information like the room name, or the features of the room.
|
||||||
|
|
||||||
|
## Challenges noted
|
||||||
|
|
||||||
|
Some challenges/room for error were noted along the way. They are enumerated below:
|
||||||
|
|
||||||
|
1. How will Moxxy/Moxxmpp handle messages from oneself?
|
||||||
|
|
||||||
|
When a user sends a message on the MUC, they receive the message themselves as well. How will moxxmpp/moxxy differentiate between other live messages and this echoed message?
|
||||||
|
|
||||||
|
The solution to this problem is to use the origin-id of the message. If the origin-id of the response matches with the sent origin-id, then the message is to be ignored and not shown in the UI.
|
||||||
|
|
||||||
|
2. In anonymous MUCs, one can easily act as someone else by using their nickname once they leave. How will this be handled?
|
||||||
|
|
||||||
|
This is fixed by using the occupant-id property as described in XEP-0421. A user (with their unique JID) when joins the group, is assigned a unique occupant-id, which can be used to actually track which message is from which user.
|
||||||
|
|
||||||
|
This makes the implementation of reactions/retractions simpler.
|
||||||
|
|
||||||
|
3. How will discussion history (sent on joining an MUC) be handled when someone rejoins an MUC?
|
||||||
|
|
||||||
|
When a user joins a MUC, they are sent a set of stanzas in the following order:
|
||||||
|
|
||||||
|
1. Errors (if any)
|
||||||
|
2. Self presence with status code
|
||||||
|
3. Room history
|
||||||
|
4. Room subject
|
||||||
|
5. Live message/presence updates
|
||||||
|
|
||||||
|
Now, when a user gets disconnected from an MUC and joins again, then the room history will be sent again as well. To prevent this history from getting appended to the conversation in the UI, we will need to wait till we receive the room subject and only then start listening for message stanzas (since room subject is sent after room history).
|
||||||
|
|
||||||
|
## Conclusion and future work
|
||||||
|
|
||||||
|
In conclusion, this blog post discussed the implementation plan for adding Multi-User Chat (MUC) support, specifically XEP-0045, to Moxxmpp. Moxxmpp serves as the backbone for the Moxxy XMPP client, handling the communication between the client and XMPP server. The blog outlined the directory structure, design plan, and key routines for implementing the MUC support in Moxxmpp. It also addressed some challenges and considerations related to handling MUC features.
|
||||||
|
|
||||||
|
Implementation for this has begun, and a [PR](https://codeberg.org/moxxy/moxxmpp/pulls/46) is already underway. Once this PR is completed, then work will begin on the front-end and the changes will be integrated into Moxxy.
|
||||||
|
|
||||||
94
content/blog/2023-07-24-Join-MUC-With Moxxy.md
Normal file
94
content/blog/2023-07-24-Join-MUC-With Moxxy.md
Normal file
@ -0,0 +1,94 @@
|
|||||||
|
+++
|
||||||
|
title = "Joining an MUC with Moxxy!"
|
||||||
|
date = "2023-07-24"
|
||||||
|
template = "post.html"
|
||||||
|
|
||||||
|
aliases = [ "posts/2023-07-24-Join-MUC-With-Moxxy.html" ]
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
author = "Ikjot Singh Dhody"
|
||||||
|
+++
|
||||||
|
|
||||||
|
Greetings, readers!
|
||||||
|
|
||||||
|
Welcome back to our series of blogs on the Google Summer of Code (GSoC) project. In this blog post, I'll be sharing the progress made in implementing Multi-User Chat (MUC) support in Moxxy, the frontend counterpart to my GSoC project.
|
||||||
|
|
||||||
|
<!-- more -->
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
As you may recall, Moxxy is a frontend application developed as an innovative XMPP client. To enhance its functionality, my GSoC project focuses on adding MUC support. Before diving into the Moxxy implementation, it was crucial to establish the necessary MUC support in Moxxmpp, which is highlighted in [this](https://moxxy.org/posts/2023-06-17-XEP-0045-In-Moxxmpp.html) blog.
|
||||||
|
|
||||||
|
Currently, the implementation progress is to allow users to join an MUC through Moxxy, and view incoming live messages in the chat.
|
||||||
|
|
||||||
|
## Design Plan for MUC Support in Moxxy
|
||||||
|
|
||||||
|
To implement MUC support in Moxxy, we need to extend its functionality and introduce new components. Let's outline the design plan for the MUC feature:
|
||||||
|
|
||||||
|
### New Page
|
||||||
|
|
||||||
|
#### JoinGroupchatPage
|
||||||
|
|
||||||
|
This page will contain just 1 text field - for the nickname that the user wants to join with. It also has a button that allows us to join the MUC with said nickname. It is an additional route to the current StartChat page, if the user selects that they want to join a groupchat.
|
||||||
|
|
||||||
|
### New Command
|
||||||
|
|
||||||
|
#### JoinGroupchatCommand
|
||||||
|
|
||||||
|
This command is sent to the data layer worker (separate thread) from the UI, when the user clicks on the join groupchat button on the new join groupchat page. It contains information about the JID and the nick that the user tried to join with. This will only be sent to the worker thread if the input validations are cleared.
|
||||||
|
|
||||||
|
|
||||||
|
### New Event
|
||||||
|
|
||||||
|
#### JoinGroupchatResult
|
||||||
|
|
||||||
|
This event is sent back as a result of the JoinGroupchatCommand. Based on whether the request succeeded or failed, it will return the new Conversation object that has just been created.
|
||||||
|
|
||||||
|
|
||||||
|
### Database changes
|
||||||
|
|
||||||
|
#### GroupchatDetails table
|
||||||
|
|
||||||
|
Add a new GrouchatDetails table to the database containing two data items - the jid and the nick. The main reason to have a separate table for the groupchat details, instead of to just have a new nick item in the Conversation table - was to maintain the single responsibility principle.
|
||||||
|
|
||||||
|
When the user fetches a conversation of type groupchat from the database, a separate call will be made that fetches the relevant groupchat details from this new table, and attaches it to the Conversation object.
|
||||||
|
|
||||||
|
### Miscellaneous changes
|
||||||
|
|
||||||
|
- Changed the external helpers for the ConversationType to an enhanced enum. This allows us to include the functions within the enum.
|
||||||
|
|
||||||
|
- The MUCManager was added to the list of registered managers for Moxxy. Not only this, the OccupantIdManager was also registered which will allow for the unique occupant identification moving forward. This will be required for message reactions/retractions in an MUC.
|
||||||
|
|
||||||
|
### New Service
|
||||||
|
|
||||||
|
#### GroupchatService
|
||||||
|
Added a new GroupchatService that allows for the following functions:
|
||||||
|
|
||||||
|
- **getRoomInformation**: Sends a request to moxxmpp to receive disco info about the MUC.
|
||||||
|
- **joinRoom**: Sends a request to moxxmpp to join the MUC if it's not password protected.
|
||||||
|
- **addGroupchatDetailsFromData**: Adds a new GroupchatDetails object to the database table.
|
||||||
|
- **getGroupchatDetailsByJid**: Fetches the GroupchatDetails from the database based on the JID provided. This is required as a separate step while fetching an MUC conversation since the Conversations and GroupchatDetails table are decoupled.
|
||||||
|
|
||||||
|
### Handling Errors
|
||||||
|
|
||||||
|
To prevent avoidable errors, Moxxy performs frontend checks when joining a room. These checks include ensuring to validate the JID input field, and checking for empty nicknames.
|
||||||
|
|
||||||
|
Possible errors that users may encounter during the MUC workflow include invalid or already in use nicknames, disallowed registration, invalid stanza format, and invalid disco info response. Moxxy will handle these errors gracefully.
|
||||||
|
|
||||||
|
## Challenges and Considerations
|
||||||
|
|
||||||
|
Here is an enumeration of the possible challenges that we could face in the future implementation, and the ones I faced in the current implementation as well:
|
||||||
|
|
||||||
|
1. Differentiating Messages from Oneself: Moxxy/Moxxmpp need to distinguish between messages from other users and self-echoed messages. To address this, Moxxy uses the origin ID of the message. If the origin ID of the response matches the sent origin ID, the message is ignored and not displayed in the UI.
|
||||||
|
|
||||||
|
2. Handling Impersonation in Anonymous MUCs: In anonymous MUCs, users can impersonate others by reusing their nicknames after leaving. To tackle this, Moxxmpp leverages the occupant ID, as described in XEP-0421. Each user joining the group receives a unique occupant ID, which helps track message origins accurately.
|
||||||
|
|
||||||
|
3. Managing Discussion History on Rejoining: When a user rejoins an MUC, the room history is resent, including errors, self-presence with status code, room history, room subject, and live message/presence updates. To prevent appending duplicate history to the UI, Moxxy/Moxxmpp will have to wait until it receives the room subject before listening for message stanzas.
|
||||||
|
|
||||||
|
## Conclusion and Future Work
|
||||||
|
|
||||||
|
In this blog post, we explored the implementation plan for adding MUC support, specifically XEP-0045, to Moxxy. Moxxmpp serves as the backbone for Moxxy's XMPP functionality, handling communication between the client and XMPP server. We discussed the directory structure, and key routines required for MUC support in Moxxmpp. Additionally, we addressed various challenges and considerations related to MUC features.
|
||||||
|
|
||||||
|
The implementation process has already commenced, with a pull request (PR) underway. Once the PR is complete, Moxxy will support joining a groupchat and listening to live messages. In further PRs, sending messages and leaving the MUC will be supported as well. The addition of MUC support will empower Moxxy users to enjoy enhanced collaboration and communication within XMPP group chats.
|
||||||
|
|
||||||
|
Stay tuned for future updates on the progress of MUC support in Moxxy. Until then, happy chatting!
|
||||||
213
content/blog/2023-08-20-Moxxy-MUC-GSoC-Final-Report/index.md
Normal file
213
content/blog/2023-08-20-Moxxy-MUC-GSoC-Final-Report/index.md
Normal file
@ -0,0 +1,213 @@
|
|||||||
|
+++
|
||||||
|
title = "GSoC report - Moxxy MUC implementation"
|
||||||
|
date = "2023-08-20"
|
||||||
|
template = "post.html"
|
||||||
|
|
||||||
|
aliases = [ "posts/2023-08-20-Moxxy-MUC-GSoC-Final-Report.html" ]
|
||||||
|
|
||||||
|
[extra]
|
||||||
|
author = "Ikjot Singh Dhody"
|
||||||
|
+++
|
||||||
|
|
||||||
|
# GSoC Final Report: XMPP Standards Foundation - Moxxy: Implement Group Chats
|
||||||
|
|
||||||
|
**Project:** Moxxy - Implement Group Chats
|
||||||
|
**Organization:** XMPP Standards Foundation
|
||||||
|
**Duration:** March 2023 - August 2023
|
||||||
|
**Student:** Ikjot Singh Dhody
|
||||||
|
**Mentor:** Alexander
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
This report presents the culmination of my work on the GSoC project "Moxxy: Implement Group Chats" under the mentorship of Alexander at the XMPP Standards Foundation. Over the course of this project, I have been engaged in implementing a group chat feature for the Moxxy application, aiming to enhance its functionality and user experience.
|
||||||
|
|
||||||
|
## About Me
|
||||||
|
|
||||||
|
### Personal and Social/Contact Details
|
||||||
|
|
||||||
|
- **Name:** Ikjot Singh Dhody
|
||||||
|
- **Jabber ID:** ikjot-2605[at]jabber.fr
|
||||||
|
- **Email:** ikjotsd[at]gmail.com
|
||||||
|
- **GitHub:** [ikjot-2605](https://github.com/ikjot-2605)
|
||||||
|
- **LinkedIn:** [LinkedIn Profile](https://www.linkedin.com/in/ikjotsd/)
|
||||||
|
|
||||||
|
### Educational Background
|
||||||
|
|
||||||
|
- **University:** National Institute of Technology Karnataka, Surathkal
|
||||||
|
- **Major:** Computer Science and Engineering
|
||||||
|
- **Year:** Senior Year
|
||||||
|
- **Degree:** Bachelor of Technology (B. Tech)
|
||||||
|
|
||||||
|
## The Project
|
||||||
|
Before getting into the details of the actual project - here is a demo screencast for the implementation:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
I have outlined the features I implemented through the GSoC period below.
|
||||||
|
### PRs merged
|
||||||
|
- moxxmpp
|
||||||
|
1. [Add support for XEP-0421](https://codeberg.org/moxxy/moxxmpp/pulls/45)
|
||||||
|
2. [Implement XEP-0045 support in moxxmpp](https://codeberg.org/moxxy/moxxmpp/pulls/46)
|
||||||
|
- Moxxy
|
||||||
|
1. [Add groupchat support for Moxxy](https://codeberg.org/moxxy/moxxy/pulls/300)
|
||||||
|
- website (blog)
|
||||||
|
1. [Add blog for GSoC MUC project introduction.](https://codeberg.org/moxxy/website/pulls/2)
|
||||||
|
2. [Blog for XEP 0045 support in Moxxmpp](https://codeberg.org/moxxy/website/pulls/3)
|
||||||
|
3. [ New blog - Join an MUC with Moxxy!](https://codeberg.org/moxxy/website/pulls/4)
|
||||||
|
4. [Final GSoC Report Blog](https://codeberg.org/moxxy/website/pulls/5)
|
||||||
|
### Feature Use-Cases
|
||||||
|
|
||||||
|
The group chat feature required changes to the Moxxy codebase, as well as the moxxmpp codebase. Moxxmpp is the data worker that sends and maintains all the request requirements of the Moxxy frontend. These are the list of contributions across both projects:
|
||||||
|
|
||||||
|
- Joining rooms and getting disco info for the room.
|
||||||
|
- Sending messages to a group chat and receiving messages from the group chat.
|
||||||
|
- Leaving the group chat.
|
||||||
|
- Displaying a UI for joining a group chat and providing a nickname.
|
||||||
|
- Handling group chat details and database support.
|
||||||
|
- Handling group chat errors and basic error handling.
|
||||||
|
- Adding a GroupchatDetails model.
|
||||||
|
- Adding UI elements for group chat, such as title and nickname fields.
|
||||||
|
- Adding documentation to group chat service methods.
|
||||||
|
- Minor code refactoring and naming enhancements.
|
||||||
|
- Enhancing enums for conversation types.
|
||||||
|
- Removing unnecessary translation strings.
|
||||||
|
- Improving UI and formatting.
|
||||||
|
|
||||||
|
Outlined below are commits made across both codebases throughout the GSoC period.
|
||||||
|
|
||||||
|
#### Moxxmpp
|
||||||
|
|
||||||
|
There were 2 PRs merged for this codebase.
|
||||||
|
|
||||||
|
- XEP-0421 support for occupant ID support.
|
||||||
|
|
||||||
|
| Serial Number | Commit Hash | Description |
|
||||||
|
|---------------|----------------|--------------------------------------------------|
|
||||||
|
| 1 | 255d0f88e0 | feat(xep): Use cascading operation to return state |
|
||||||
|
| 2 | fa11a3a384 | feat(xep): Checked for the occupant-id directly. |
|
||||||
|
| 3 | ac5bb9e461 | feat(xep): Implement XEP 0421 in Moxxmpp. |
|
||||||
|
|
||||||
|
|
||||||
|
- XEP-0045 support for MUC support.
|
||||||
|
|
||||||
|
| Serial Number | Commit Hash | Description |
|
||||||
|
|---------------|----------------|--------------------------------------------------|
|
||||||
|
| 1 | b2724aba0c | Merge branch 'master' into xep_0045 |
|
||||||
|
| 2 | d3742ea156 | feat(xep): Small fixes - MUC Example. |
|
||||||
|
| 3 | 8b00e85167 | feat(xep): Add example for XEP 0045 Moxxmpp. |
|
||||||
|
| 4 | 04dfc6d2ac | feat(xep): Replace DiscoError with StanzaError. |
|
||||||
|
| 5 | 9e70e802ef | Merge branch 'master' into xep_0045 |
|
||||||
|
| 6 | 3ebd9b86ec | feat(xep): Fix lint issues and use moxlib for result. |
|
||||||
|
| 7 | a873edb9ec | feat(xep): Check for null nick before leaveRoom. |
|
||||||
|
| 8 | e6bd6d05cd | feat(xep): Remove NOOP cache access. |
|
||||||
|
| 9 | b7d53b8f47 | feat(xep): Add docstings for the XEP-0045 routines |
|
||||||
|
| 10 | 217c3ac236 | feat(xep): Fix cache issue with join/leaveRoom. |
|
||||||
|
| 11 | 51bca6c25d | feat(xep): XEP-0045 cache fixes. |
|
||||||
|
| 12 | 8728166a4d | feat(xep): Add cache and roomstate to MUC implementation. |
|
||||||
|
| 13 | 1f1321b269 | feat(xep): Small fixes - review cycle 1. |
|
||||||
|
| 14 | 66195f66fa | Merge branch 'master' into xep_0045 |
|
||||||
|
| 15 | 70fdfaf16d | feat(xep): Fix imports for xep_0045 files. |
|
||||||
|
| 16 | cd73f89e63 | feat(xep): Remove duplicate manager string |
|
||||||
|
| 17 | 05c41d3185 | feat(xep): Refactor sendMessage to allow groupchat |
|
||||||
|
| 18 | 64a8de6caa | feat(xep): Set base for XEP 0045 implementation |
|
||||||
|
| 19 | 68809469f6 | feat(xep): Add joinRoom, leaveRoom routines. |
|
||||||
|
| 20 | 762cf1c77a | feat(xep): Set base for XEP 0045 implementation |
|
||||||
|
|
||||||
|
|
||||||
|
#### Moxxy
|
||||||
|
|
||||||
|
- Implement MUCs in Moxxy
|
||||||
|
|
||||||
|
| Serial Number | Commit Hash | Description |
|
||||||
|
|---------------|----------------|--------------------------------------------------|
|
||||||
|
| 1 | 549e61a168 | feat(all): Fix linter issues. |
|
||||||
|
| 2 | 26bcaccd81 | Merge branch 'master' into feat/groupchat |
|
||||||
|
| 3 | df5810a347 | feat(all): Formatting change, lock file update |
|
||||||
|
| 4 | ef931c566f | feat(all): Send messages/chat state from Moxxy to MUC. |
|
||||||
|
| 5 | a3d4883406 | feat(all): Remove unnecessary buttons/options for MUC. |
|
||||||
|
| 6 | 532f0b1bb2 | feat(all): Formatting fix, and navigation fix. |
|
||||||
|
| 7 | a98fe0d9f3 | feat(all): Minor fixes - strings, formatting. |
|
||||||
|
| 8 | a7c3bd507f | Merge branch 'master' of https://codeberg.org/moxxy/moxxy into feat/groupchat |
|
||||||
|
| 9 | fba2cf86ae | feat(all): Minor formatting changes. |
|
||||||
|
| 10 | af481bf465 | feat(all): remove unnecessary comparator override. |
|
||||||
|
| 11 | e6ae8182c2 | feat(all): Organize import in main.dart. |
|
||||||
|
| 12 | de7b9adfa6 | feat(all): Fix user flow for joining MUC. |
|
||||||
|
| 13 | e4f98bb82f | feat(all): Add label to nick text field. |
|
||||||
|
| 14 | 56d6f97168 | feat(all): Minor changes, fixes. |
|
||||||
|
| 15 | b0067f055f | feat(all): Move away from exception type design. |
|
||||||
|
| 16 | bd094dfc9a | feat(all): Remove unnecessary function. |
|
||||||
|
| 17 | 7e9d7d6281 | feat(all): Check if Groupchat exists before method. |
|
||||||
|
| 18 | 2cf781459d | feat(all): Debug mode and translatable string |
|
||||||
|
| 19 | 4ff9e3c81e | feat(all): Remove title from GroupchatDetails. |
|
||||||
|
| 20 | e337f1c579 | feat(all): Minor refactors - naming. |
|
||||||
|
| 21 | 7c840334e1 | feat(all): Add docs to groupchat service methods. |
|
||||||
|
| 22 | 06eab1d6f5 | feat(all): Make ConversationType an enhanced enum. |
|
||||||
|
| 23 | 008e816d70 | feat(all): Rename JoinGroupchatResultEvent. |
|
||||||
|
| 24 | 2bbbc164b5 | feat(all): Remove incorrect translations. |
|
||||||
|
| 25 | 11f4fd9932 | feat(all): Add title to GroupchatDetails. |
|
||||||
|
| 26 | a1451c6fbf | feat(all): Refactor groupchat to new object in db. |
|
||||||
|
| 27 | 993da40297 | feat(all): Complete join groupchat flow. |
|
||||||
|
| 28 | 09684b1268 | feat(all): Fix fromDatabaseJson for MUC details. |
|
||||||
|
| 29 | 0abb89cf38 | feat(all): Fix database issues with nick. |
|
||||||
|
| 30 | 7880f51b76 | feat(all): Add db support for GroupchatDetails. |
|
||||||
|
| 31 | f0a79ca0e0 | feat(all): Add GroupchatDetails model. |
|
||||||
|
| 32 | 06dcd5491b | feat(all): Basic groupchat error handling set up. |
|
||||||
|
| 33 | 3641be4f56 | feat(all): Join room functionality complete. |
|
||||||
|
| 34 | 18e28c3bbf | feat(all): Groupchat service/bloc updated. |
|
||||||
|
| 35 | 62e39bf066 | feat(all): Set base for groupchat implementation. |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Accomplishments
|
||||||
|
|
||||||
|
- Was able to produce a working model of groupchats in Moxxy.
|
||||||
|
|
||||||
|
- Started the design approach from scratch and pretty much stuck to it till the end gave me confidence in my design capability.
|
||||||
|
|
||||||
|
- Fruitful discussions and review cycles were conducted that allowed for a smooth GSoC experience.
|
||||||
|
|
||||||
|
## Challenges Faced
|
||||||
|
|
||||||
|
- Needed to understand 2 different codebases, and the architecture of the project. This was a pretty interesting, albeit challenging task that took me a while to master.
|
||||||
|
|
||||||
|
- Managing the busy schedule with GSoC work, family, college among other things was difficult. Also, managing a job in the latter parts was also challenging but a rewarding experience.
|
||||||
|
|
||||||
|
- The complete virtual approach was slightly difficult, and although not practical - it might have been slightly better with inter-GSoC meetings.
|
||||||
|
|
||||||
|
|
||||||
|
## Learnings/Takeaways
|
||||||
|
|
||||||
|
- Implemented group chat (Multi-User Chat or MUC) support in the Moxxy project.
|
||||||
|
- Successfully added features for joining a group chat room, sending messages to the room, and receiving messages from the room.
|
||||||
|
- Learned to handle various aspects of XMPP communication, including sending and receiving messages, and interacting with group chat services.
|
||||||
|
- Gained insights into implementing complex functionality in a Flutter application, involving UI components, service classes, and database interactions.
|
||||||
|
- Collaborated with experienced developers through code reviews to improve code quality and ensure adherence to best practices.
|
||||||
|
- Acquired knowledge of working with the XMPP protocol, understanding its intricacies and how it relates to group chat interactions.
|
||||||
|
- Learned to manage and address feedback from code reviewers, making necessary adjustments to improve code readability and functionality.
|
||||||
|
- Discovered the importance of proper error handling in real-time communication scenarios, such as handling different types of group chat errors.
|
||||||
|
- Gained experience in integrating new features while maintaining the overall architecture and user experience of the application.
|
||||||
|
- Understood the complexities of XMPP server behavior, including handling discussion history and preventing message loops.
|
||||||
|
- Explored techniques for optimizing communication performance, such as preventing redundant message processing.
|
||||||
|
- Improved skills in project management, including version control practices, managing branches, and resolving merge conflicts.
|
||||||
|
- Gained familiarity with the process of creating, testing, and merging pull requests in a collaborative development environment.
|
||||||
|
- Developed a better understanding of Flutter's state management, navigation, and widget composition for creating feature-rich user interfaces.
|
||||||
|
- Learned to balance feature development with code quality, addressing both functional and non-functional aspects of the implementation.
|
||||||
|
- Explored advanced Flutter topics, such as handling asynchronous operations, managing state, and integrating with external libraries.
|
||||||
|
- Gained a deeper understanding of how group chat and real-time communication play a significant role in modern applications.
|
||||||
|
- Developed the ability to diagnose and troubleshoot issues related to communication and user interface interactions.
|
||||||
|
- Strengthened communication skills by participating in technical discussions and effectively conveying ideas and solutions.
|
||||||
|
|
||||||
|
|
||||||
|
## Future Work
|
||||||
|
|
||||||
|
The future remaining work has been enlisted in this issue by my mentor [here](https://codeberg.org/moxxy/moxxy/issues/315).
|
||||||
|
|
||||||
|
This includes a list of improvements, bug fixes and general future requirements that will be needed to make the groupchat experience pleasurable for the users of Moxxy.
|
||||||
|
|
||||||
|
## Conclusion
|
||||||
|
|
||||||
|
Participating in GSoC has been an enriching experience. I've learned valuable skills, collaborated with mentors and the open-source community, and contributed to the Moxxy project. I'm grateful to XMPP Standards Foundation for this opportunity and look forward to continuing my journey in the world of open-source software development.
|
||||||
|
|
||||||
|
## Acknowledgments
|
||||||
|
|
||||||
|
I would like to express my gratitude to my mentor Alexander for their guidance and support throughout this project. His guidance and understanding is what allowed me to pull through and complete the GSoC with a happy mind. I also want to thank the XMPP Standards Foundation community for their encouragement and feedback.
|
||||||
|
Before Width: | Height: | Size: 1.2 MiB After Width: | Height: | Size: 1.2 MiB |
8
content/blog/_index.md
Normal file
8
content/blog/_index.md
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
+++
|
||||||
|
title = "Blog Posts"
|
||||||
|
template = "blog.html"
|
||||||
|
|
||||||
|
sort_by = "date"
|
||||||
|
|
||||||
|
aliases = [ "posts.html" ]
|
||||||
|
+++
|
||||||
6
content/developers.md
Normal file
6
content/developers.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
+++
|
||||||
|
title = "Developer Information"
|
||||||
|
template = "developers.html"
|
||||||
|
|
||||||
|
aliases = [ "developers.html" ]
|
||||||
|
+++
|
||||||
File diff suppressed because one or more lines are too long
@ -1,6 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<link rel="canonical" href="https://moxxy.org/developers/">
|
|
||||||
<meta http-equiv="refresh" content="0; url=https://moxxy.org/developers/">
|
|
||||||
<title>Redirect</title>
|
|
||||||
<p><a href="https://moxxy.org/developers/">Click here</a> to be redirected.</p>
|
|
||||||
@ -1,161 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<link href="https://moxxy.org/css/index.css" rel="stylesheet" />
|
|
||||||
<link rel="shortcut icon" href="https://moxxy.org/img/favicon.ico" sizes="32x32" />
|
|
||||||
<link href="https://moxxy.org/feed.xml" type="application/atom+xml" rel="alternate" title="Moxxy Blog" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta property="og:description" content="" />
|
|
||||||
<meta property="og:title" content="Developer Information" />
|
|
||||||
<title>Developer Information</title>
|
|
||||||
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="flex flex-col">
|
|
||||||
<div class="relative h-16 inset-x-0 inset-y-0 px-4 shadow-md grid place-items-center">
|
|
||||||
<div class="flex flex-row items-center w-full">
|
|
||||||
<!-- The Moxxy logo -->
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<img src="https://moxxy.org/img/logo.png" class="w-12 h-12 p-2" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<span class="font-bold">Moxxy</span>
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<!-- Spacer -->
|
|
||||||
<div class="grow"></div>
|
|
||||||
|
|
||||||
<a href="/blog/" class="px-2 text-sky-400">Blog</a>
|
|
||||||
<a href="https://moxxy.org/developers/" class="px-2 text-sky-400">Developers</a>
|
|
||||||
<a href="https://codeberg.org/moxxy/moxxy" class="px-2 text-sky-400">Source</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="w-full flex flex-row justify-center">
|
|
||||||
<div class="w-full lg:w-1/2">
|
|
||||||
|
|
||||||
<div class="w-full p-8 flex flex-col">
|
|
||||||
<div class="w-full pt-4">
|
|
||||||
<p>
|
|
||||||
Moxxy is fully open source. You can find the source code <a class="text-sky-400" href="https://codeberg.org/moxxy/moxxy">on Codeberg</a>. Additionally, the code is
|
|
||||||
mirrored <a class="text-sky-400" href="https://github.com/PapaTutuWawa/moxxy">on GitHub</a>.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p class="pt-1 pb-4">
|
|
||||||
Feel free to join the <a class="text-sky-400" href="xmpp:moxxy@muc.moxxy.org?join">general chat</a> or the <a class="text-sky-400" href="xmpp:dev@muc.moxxy.org?join">developer chat</a> with your favourite XMPP client.
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
<h1 class="text-3xl font-bold">Libraries</h1>
|
|
||||||
|
|
||||||
<p class="pb-4">
|
|
||||||
Moxxy is built from various smaller libraries that are custom-made for this purpose. Some of them are for general usage, some are specific to the use case of building Moxxy.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<table class="table-fixed">
|
|
||||||
<thead class="bg-gray-100">
|
|
||||||
<tr>
|
|
||||||
<th class="text-left px-1">Library</th>
|
|
||||||
<th class="text-left px-1">Description</th>
|
|
||||||
<th class="text-left px-1">Moxxy specific</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody class="divide-y divide-blue-200">
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td class="pr-4">
|
|
||||||
<a class="text-sky-400" href="https://codeberg.org/moxxy/moxxmpp">moxxmpp</a>
|
|
||||||
</td>
|
|
||||||
<td class="pr-4">XMPP library written in Dart</td>
|
|
||||||
<td class="pr-4">No</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td class="pr-4">
|
|
||||||
<a class="text-sky-400" href="https://codeberg.org/moxxy/moxdns">moxdns</a>
|
|
||||||
</td>
|
|
||||||
<td class="pr-4">DNS SRV resolver for Flutter</td>
|
|
||||||
<td class="pr-4">Yes</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td class="pr-4">
|
|
||||||
<a class="text-sky-400" href="https://codeberg.org/moxxy/moxlib">moxlib</a>
|
|
||||||
</td>
|
|
||||||
<td class="pr-4">Shared functions for Moxxy-specific projects</td>
|
|
||||||
<td class="pr-4">Yes</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td class="pr-4">
|
|
||||||
<a class="text-sky-400" href="https://codeberg.org/moxxy/moxxy_native">moxxy_native</a>
|
|
||||||
</td>
|
|
||||||
<td class="pr-4">Platform-specific code</td>
|
|
||||||
<td class="pr-4">Yes</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td class="pr-4">
|
|
||||||
<a class="text-sky-400" href="https://codeberg.org/PapaTutuWawa/omemo_dart">omemo_dart</a>
|
|
||||||
</td>
|
|
||||||
<td class="pr-4">Implementation of the cryptography for OMEMO 0.8.3 with a high-level interface</td>
|
|
||||||
<td class="pr-4">No</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="w-full p-8 flex flex-col">
|
|
||||||
<h1 class="text-3xl font-bold">Custom XEPs</h1>
|
|
||||||
|
|
||||||
<p class="pb-4">
|
|
||||||
Moxxy currently implements some custom XMPP protocols to provide additional functionality. These are experimental and are intended to be upstreamed at some point.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<table class="table-fixed">
|
|
||||||
<thead class="bg-gray-100">
|
|
||||||
<tr>
|
|
||||||
<th class="text-left px-1">Name</th>
|
|
||||||
<th class="text-left px-1">Description</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody class="divide-y divide-blue-200">
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td class="pr-4">
|
|
||||||
<a class="text-sky-400" href="https://codeberg.org/moxxy/custom-xeps/src/branch/master/xep-xxxx-extensible-file-thumbnails.md">Extensible File Thumbnails</a>
|
|
||||||
</td>
|
|
||||||
<td class="pr-4">Provide an extensible way of specifying thumbnails that are neccessarily binary data</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<td class="pr-4">
|
|
||||||
<a class="text-sky-400" href="https://codeberg.org/moxxy/custom-xeps/src/branch/master/xep-xxxx-file-upload-notification.md">File Upload Notification</a>
|
|
||||||
</td>
|
|
||||||
<td class="pr-4">Allow communicating that an OOB file upload is currently running to improve the consistency of the conversation</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<footer class="h-8 w-full flex flex-row justify-center">
|
|
||||||
<span class="text-sm text-center">
|
|
||||||
Made with <3 by
|
|
||||||
<a class="text-sky-400" href="https://polynom.me" target="_blank" rel="noopener noreferrer">PapaTutuWawa</a>
|
|
||||||
using <a class="text-sky-400" href="https://tailwindcss.com/" target="_blank" rel="noopener noreferrer">TailwindCSS</a>,
|
|
||||||
<a class="text-sky-400" href="https://jekyllrb.com/" target="_blank" rel="noopener noreferrer">Jekyll</a> and
|
|
||||||
<a class="text-sky-400" href="https://heroicons.com/">heroicons</a>.
|
|
||||||
</span>
|
|
||||||
</footer>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
521
feed.xml
521
feed.xml
@ -1,521 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<rss xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">
|
|
||||||
<channel>
|
|
||||||
<title>Moxxy | A modern XMPP client</title>
|
|
||||||
<link>https://moxxy.org</link>
|
|
||||||
<description>A modern XMPP client</description>
|
|
||||||
<generator>Zola</generator>
|
|
||||||
<language>en</language>
|
|
||||||
<atom:link href="https://moxxy.org/feed.xml" rel="self" type="application/rss+xml"/>
|
|
||||||
<lastBuildDate>Sun, 20 Aug 2023 00:00:00 +0000</lastBuildDate>
|
|
||||||
<item>
|
|
||||||
<title>GSoC report - Moxxy MUC implementation</title>
|
|
||||||
<pubDate>Sun, 20 Aug 2023 00:00:00 +0000</pubDate>
|
|
||||||
<author>Unknown</author>
|
|
||||||
<link>https://moxxy.org/blog/moxxy-muc-gsoc-final-report/</link>
|
|
||||||
<guid>https://moxxy.org/blog/moxxy-muc-gsoc-final-report/</guid>
|
|
||||||
<description xml:base="https://moxxy.org/blog/moxxy-muc-gsoc-final-report/"><h1 id="gsoc-final-report-xmpp-standards-foundation-moxxy-implement-group-chats">GSoC Final Report: XMPP Standards Foundation - Moxxy: Implement Group Chats</h1>
|
|
||||||
<p><strong>Project:</strong> Moxxy - Implement Group Chats<br />
|
|
||||||
<strong>Organization:</strong> XMPP Standards Foundation<br />
|
|
||||||
<strong>Duration:</strong> March 2023 - August 2023<br />
|
|
||||||
<strong>Student:</strong> Ikjot Singh Dhody<br />
|
|
||||||
<strong>Mentor:</strong> Alexander</p>
|
|
||||||
<h2 id="introduction">Introduction</h2>
|
|
||||||
<p>This report presents the culmination of my work on the GSoC project &quot;Moxxy: Implement Group Chats&quot; under the mentorship of Alexander at the XMPP Standards Foundation. Over the course of this project, I have been engaged in implementing a group chat feature for the Moxxy application, aiming to enhance its functionality and user experience.</p>
|
|
||||||
<h2 id="about-me">About Me</h2>
|
|
||||||
<h3 id="personal-and-social-contact-details">Personal and Social/Contact Details</h3>
|
|
||||||
<ul>
|
|
||||||
<li><strong>Name:</strong> Ikjot Singh Dhody</li>
|
|
||||||
<li><strong>Jabber ID:</strong> ikjot-2605[at]jabber.fr</li>
|
|
||||||
<li><strong>Email:</strong> ikjotsd[at]gmail.com</li>
|
|
||||||
<li><strong>GitHub:</strong> <a href="https://github.com/ikjot-2605">ikjot-2605</a></li>
|
|
||||||
<li><strong>LinkedIn:</strong> <a href="https://www.linkedin.com/in/ikjotsd/">LinkedIn Profile</a></li>
|
|
||||||
</ul>
|
|
||||||
<h3 id="educational-background">Educational Background</h3>
|
|
||||||
<ul>
|
|
||||||
<li><strong>University:</strong> National Institute of Technology Karnataka, Surathkal</li>
|
|
||||||
<li><strong>Major:</strong> Computer Science and Engineering</li>
|
|
||||||
<li><strong>Year:</strong> Senior Year</li>
|
|
||||||
<li><strong>Degree:</strong> Bachelor of Technology (B. Tech)</li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="the-project">The Project</h2>
|
|
||||||
<p>Before getting into the details of the actual project - here is a demo screencast for the implementation:</p>
|
|
||||||
<p><img src="https://moxxy.org/blog/moxxy-muc-gsoc-final-report/moxxy-muc-demo.gif" alt="" /></p>
|
|
||||||
<p>I have outlined the features I implemented through the GSoC period below.</p>
|
|
||||||
<h3 id="prs-merged">PRs merged</h3>
|
|
||||||
<ul>
|
|
||||||
<li>moxxmpp
|
|
||||||
<ol>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/moxxmpp/pulls/45">Add support for XEP-0421</a></li>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/moxxmpp/pulls/46">Implement XEP-0045 support in moxxmpp</a></li>
|
|
||||||
</ol>
|
|
||||||
</li>
|
|
||||||
<li>Moxxy
|
|
||||||
<ol>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/moxxy/pulls/300">Add groupchat support for Moxxy</a></li>
|
|
||||||
</ol>
|
|
||||||
</li>
|
|
||||||
<li>website (blog)
|
|
||||||
<ol>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/website/pulls/2">Add blog for GSoC MUC project introduction.</a></li>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/website/pulls/3">Blog for XEP 0045 support in Moxxmpp</a></li>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/website/pulls/4"> New blog - Join an MUC with Moxxy!</a></li>
|
|
||||||
<li><a href="https://codeberg.org/moxxy/website/pulls/5">Final GSoC Report Blog</a></li>
|
|
||||||
</ol>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<h3 id="feature-use-cases">Feature Use-Cases</h3>
|
|
||||||
<p>The group chat feature required changes to the Moxxy codebase, as well as the moxxmpp codebase. Moxxmpp is the data worker that sends and maintains all the request requirements of the Moxxy frontend. These are the list of contributions across both projects:</p>
|
|
||||||
<ul>
|
|
||||||
<li>Joining rooms and getting disco info for the room.</li>
|
|
||||||
<li>Sending messages to a group chat and receiving messages from the group chat.</li>
|
|
||||||
<li>Leaving the group chat.</li>
|
|
||||||
<li>Displaying a UI for joining a group chat and providing a nickname.</li>
|
|
||||||
<li>Handling group chat details and database support.</li>
|
|
||||||
<li>Handling group chat errors and basic error handling.</li>
|
|
||||||
<li>Adding a GroupchatDetails model.</li>
|
|
||||||
<li>Adding UI elements for group chat, such as title and nickname fields.</li>
|
|
||||||
<li>Adding documentation to group chat service methods.</li>
|
|
||||||
<li>Minor code refactoring and naming enhancements.</li>
|
|
||||||
<li>Enhancing enums for conversation types.</li>
|
|
||||||
<li>Removing unnecessary translation strings.</li>
|
|
||||||
<li>Improving UI and formatting.</li>
|
|
||||||
</ul>
|
|
||||||
<p>Outlined below are commits made across both codebases throughout the GSoC period.</p>
|
|
||||||
<h4 id="moxxmpp">Moxxmpp</h4>
|
|
||||||
<p>There were 2 PRs merged for this codebase. </p>
|
|
||||||
<ul>
|
|
||||||
<li>XEP-0421 support for occupant ID support.</li>
|
|
||||||
</ul>
|
|
||||||
<table><thead><tr><th>Serial Number</th><th>Commit Hash</th><th>Description</th></tr></thead><tbody>
|
|
||||||
<tr><td>1</td><td>255d0f88e0</td><td>feat(xep): Use cascading operation to return state</td></tr>
|
|
||||||
<tr><td>2</td><td>fa11a3a384</td><td>feat(xep): Checked for the occupant-id directly.</td></tr>
|
|
||||||
<tr><td>3</td><td>ac5bb9e461</td><td>feat(xep): Implement XEP 0421 in Moxxmpp.</td></tr>
|
|
||||||
</tbody></table>
|
|
||||||
<ul>
|
|
||||||
<li>XEP-0045 support for MUC support. </li>
|
|
||||||
</ul>
|
|
||||||
<table><thead><tr><th>Serial Number</th><th>Commit Hash</th><th>Description</th></tr></thead><tbody>
|
|
||||||
<tr><td>1</td><td>b2724aba0c</td><td>Merge branch 'master' into xep_0045</td></tr>
|
|
||||||
<tr><td>2</td><td>d3742ea156</td><td>feat(xep): Small fixes - MUC Example.</td></tr>
|
|
||||||
<tr><td>3</td><td>8b00e85167</td><td>feat(xep): Add example for XEP 0045 Moxxmpp.</td></tr>
|
|
||||||
<tr><td>4</td><td>04dfc6d2ac</td><td>feat(xep): Replace DiscoError with StanzaError.</td></tr>
|
|
||||||
<tr><td>5</td><td>9e70e802ef</td><td>Merge branch 'master' into xep_0045</td></tr>
|
|
||||||
<tr><td>6</td><td>3ebd9b86ec</td><td>feat(xep): Fix lint issues and use moxlib for result.</td></tr>
|
|
||||||
<tr><td>7</td><td>a873edb9ec</td><td>feat(xep): Check for null nick before leaveRoom.</td></tr>
|
|
||||||
<tr><td>8</td><td>e6bd6d05cd</td><td>feat(xep): Remove NOOP cache access.</td></tr>
|
|
||||||
<tr><td>9</td><td>b7d53b8f47</td><td>feat(xep): Add docstings for the XEP-0045 routines</td></tr>
|
|
||||||
<tr><td>10</td><td>217c3ac236</td><td>feat(xep): Fix cache issue with join/leaveRoom.</td></tr>
|
|
||||||
<tr><td>11</td><td>51bca6c25d</td><td>feat(xep): XEP-0045 cache fixes.</td></tr>
|
|
||||||
<tr><td>12</td><td>8728166a4d</td><td>feat(xep): Add cache and roomstate to MUC implementation.</td></tr>
|
|
||||||
<tr><td>13</td><td>1f1321b269</td><td>feat(xep): Small fixes - review cycle 1.</td></tr>
|
|
||||||
<tr><td>14</td><td>66195f66fa</td><td>Merge branch 'master' into xep_0045</td></tr>
|
|
||||||
<tr><td>15</td><td>70fdfaf16d</td><td>feat(xep): Fix imports for xep_0045 files.</td></tr>
|
|
||||||
<tr><td>16</td><td>cd73f89e63</td><td>feat(xep): Remove duplicate manager string</td></tr>
|
|
||||||
<tr><td>17</td><td>05c41d3185</td><td>feat(xep): Refactor sendMessage to allow groupchat</td></tr>
|
|
||||||
<tr><td>18</td><td>64a8de6caa</td><td>feat(xep): Set base for XEP 0045 implementation</td></tr>
|
|
||||||
<tr><td>19</td><td>68809469f6</td><td>feat(xep): Add joinRoom, leaveRoom routines.</td></tr>
|
|
||||||
<tr><td>20</td><td>762cf1c77a</td><td>feat(xep): Set base for XEP 0045 implementation</td></tr>
|
|
||||||
</tbody></table>
|
|
||||||
<h4 id="moxxy">Moxxy</h4>
|
|
||||||
<ul>
|
|
||||||
<li>Implement MUCs in Moxxy</li>
|
|
||||||
</ul>
|
|
||||||
<table><thead><tr><th>Serial Number</th><th>Commit Hash</th><th>Description</th></tr></thead><tbody>
|
|
||||||
<tr><td>1</td><td>549e61a168</td><td>feat(all): Fix linter issues.</td></tr>
|
|
||||||
<tr><td>2</td><td>26bcaccd81</td><td>Merge branch 'master' into feat/groupchat</td></tr>
|
|
||||||
<tr><td>3</td><td>df5810a347</td><td>feat(all): Formatting change, lock file update</td></tr>
|
|
||||||
<tr><td>4</td><td>ef931c566f</td><td>feat(all): Send messages/chat state from Moxxy to MUC.</td></tr>
|
|
||||||
<tr><td>5</td><td>a3d4883406</td><td>feat(all): Remove unnecessary buttons/options for MUC.</td></tr>
|
|
||||||
<tr><td>6</td><td>532f0b1bb2</td><td>feat(all): Formatting fix, and navigation fix.</td></tr>
|
|
||||||
<tr><td>7</td><td>a98fe0d9f3</td><td>feat(all): Minor fixes - strings, formatting.</td></tr>
|
|
||||||
<tr><td>8</td><td>a7c3bd507f</td><td>Merge branch 'master' of https://codeberg.org/moxxy/moxxy into feat/groupchat</td></tr>
|
|
||||||
<tr><td>9</td><td>fba2cf86ae</td><td>feat(all): Minor formatting changes.</td></tr>
|
|
||||||
<tr><td>10</td><td>af481bf465</td><td>feat(all): remove unnecessary comparator override.</td></tr>
|
|
||||||
<tr><td>11</td><td>e6ae8182c2</td><td>feat(all): Organize import in main.dart.</td></tr>
|
|
||||||
<tr><td>12</td><td>de7b9adfa6</td><td>feat(all): Fix user flow for joining MUC.</td></tr>
|
|
||||||
<tr><td>13</td><td>e4f98bb82f</td><td>feat(all): Add label to nick text field.</td></tr>
|
|
||||||
<tr><td>14</td><td>56d6f97168</td><td>feat(all): Minor changes, fixes.</td></tr>
|
|
||||||
<tr><td>15</td><td>b0067f055f</td><td>feat(all): Move away from exception type design.</td></tr>
|
|
||||||
<tr><td>16</td><td>bd094dfc9a</td><td>feat(all): Remove unnecessary function.</td></tr>
|
|
||||||
<tr><td>17</td><td>7e9d7d6281</td><td>feat(all): Check if Groupchat exists before method.</td></tr>
|
|
||||||
<tr><td>18</td><td>2cf781459d</td><td>feat(all): Debug mode and translatable string</td></tr>
|
|
||||||
<tr><td>19</td><td>4ff9e3c81e</td><td>feat(all): Remove title from GroupchatDetails.</td></tr>
|
|
||||||
<tr><td>20</td><td>e337f1c579</td><td>feat(all): Minor refactors - naming.</td></tr>
|
|
||||||
<tr><td>21</td><td>7c840334e1</td><td>feat(all): Add docs to groupchat service methods.</td></tr>
|
|
||||||
<tr><td>22</td><td>06eab1d6f5</td><td>feat(all): Make ConversationType an enhanced enum.</td></tr>
|
|
||||||
<tr><td>23</td><td>008e816d70</td><td>feat(all): Rename JoinGroupchatResultEvent.</td></tr>
|
|
||||||
<tr><td>24</td><td>2bbbc164b5</td><td>feat(all): Remove incorrect translations.</td></tr>
|
|
||||||
<tr><td>25</td><td>11f4fd9932</td><td>feat(all): Add title to GroupchatDetails.</td></tr>
|
|
||||||
<tr><td>26</td><td>a1451c6fbf</td><td>feat(all): Refactor groupchat to new object in db.</td></tr>
|
|
||||||
<tr><td>27</td><td>993da40297</td><td>feat(all): Complete join groupchat flow.</td></tr>
|
|
||||||
<tr><td>28</td><td>09684b1268</td><td>feat(all): Fix fromDatabaseJson for MUC details.</td></tr>
|
|
||||||
<tr><td>29</td><td>0abb89cf38</td><td>feat(all): Fix database issues with nick.</td></tr>
|
|
||||||
<tr><td>30</td><td>7880f51b76</td><td>feat(all): Add db support for GroupchatDetails.</td></tr>
|
|
||||||
<tr><td>31</td><td>f0a79ca0e0</td><td>feat(all): Add GroupchatDetails model.</td></tr>
|
|
||||||
<tr><td>32</td><td>06dcd5491b</td><td>feat(all): Basic groupchat error handling set up.</td></tr>
|
|
||||||
<tr><td>33</td><td>3641be4f56</td><td>feat(all): Join room functionality complete.</td></tr>
|
|
||||||
<tr><td>34</td><td>18e28c3bbf</td><td>feat(all): Groupchat service/bloc updated.</td></tr>
|
|
||||||
<tr><td>35</td><td>62e39bf066</td><td>feat(all): Set base for groupchat implementation.</td></tr>
|
|
||||||
</tbody></table>
|
|
||||||
<h2 id="accomplishments">Accomplishments</h2>
|
|
||||||
<ul>
|
|
||||||
<li>
|
|
||||||
<p>Was able to produce a working model of groupchats in Moxxy.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Started the design approach from scratch and pretty much stuck to it till the end gave me confidence in my design capability.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Fruitful discussions and review cycles were conducted that allowed for a smooth GSoC experience.</p>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="challenges-faced">Challenges Faced</h2>
|
|
||||||
<ul>
|
|
||||||
<li>
|
|
||||||
<p>Needed to understand 2 different codebases, and the architecture of the project. This was a pretty interesting, albeit challenging task that took me a while to master.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Managing the busy schedule with GSoC work, family, college among other things was difficult. Also, managing a job in the latter parts was also challenging but a rewarding experience.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>The complete virtual approach was slightly difficult, and although not practical - it might have been slightly better with inter-GSoC meetings.</p>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="learnings-takeaways">Learnings/Takeaways</h2>
|
|
||||||
<ul>
|
|
||||||
<li>Implemented group chat (Multi-User Chat or MUC) support in the Moxxy project.</li>
|
|
||||||
<li>Successfully added features for joining a group chat room, sending messages to the room, and receiving messages from the room.</li>
|
|
||||||
<li>Learned to handle various aspects of XMPP communication, including sending and receiving messages, and interacting with group chat services.</li>
|
|
||||||
<li>Gained insights into implementing complex functionality in a Flutter application, involving UI components, service classes, and database interactions.</li>
|
|
||||||
<li>Collaborated with experienced developers through code reviews to improve code quality and ensure adherence to best practices.</li>
|
|
||||||
<li>Acquired knowledge of working with the XMPP protocol, understanding its intricacies and how it relates to group chat interactions.</li>
|
|
||||||
<li>Learned to manage and address feedback from code reviewers, making necessary adjustments to improve code readability and functionality.</li>
|
|
||||||
<li>Discovered the importance of proper error handling in real-time communication scenarios, such as handling different types of group chat errors.</li>
|
|
||||||
<li>Gained experience in integrating new features while maintaining the overall architecture and user experience of the application.</li>
|
|
||||||
<li>Understood the complexities of XMPP server behavior, including handling discussion history and preventing message loops.</li>
|
|
||||||
<li>Explored techniques for optimizing communication performance, such as preventing redundant message processing.</li>
|
|
||||||
<li>Improved skills in project management, including version control practices, managing branches, and resolving merge conflicts.</li>
|
|
||||||
<li>Gained familiarity with the process of creating, testing, and merging pull requests in a collaborative development environment.</li>
|
|
||||||
<li>Developed a better understanding of Flutter's state management, navigation, and widget composition for creating feature-rich user interfaces.</li>
|
|
||||||
<li>Learned to balance feature development with code quality, addressing both functional and non-functional aspects of the implementation.</li>
|
|
||||||
<li>Explored advanced Flutter topics, such as handling asynchronous operations, managing state, and integrating with external libraries.</li>
|
|
||||||
<li>Gained a deeper understanding of how group chat and real-time communication play a significant role in modern applications.</li>
|
|
||||||
<li>Developed the ability to diagnose and troubleshoot issues related to communication and user interface interactions.</li>
|
|
||||||
<li>Strengthened communication skills by participating in technical discussions and effectively conveying ideas and solutions.</li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="future-work">Future Work</h2>
|
|
||||||
<p>The future remaining work has been enlisted in this issue by my mentor <a href="https://codeberg.org/moxxy/moxxy/issues/315">here</a>.</p>
|
|
||||||
<p>This includes a list of improvements, bug fixes and general future requirements that will be needed to make the groupchat experience pleasurable for the users of Moxxy.</p>
|
|
||||||
<h2 id="conclusion">Conclusion</h2>
|
|
||||||
<p>Participating in GSoC has been an enriching experience. I've learned valuable skills, collaborated with mentors and the open-source community, and contributed to the Moxxy project. I'm grateful to XMPP Standards Foundation for this opportunity and look forward to continuing my journey in the world of open-source software development.</p>
|
|
||||||
<h2 id="acknowledgments">Acknowledgments</h2>
|
|
||||||
<p>I would like to express my gratitude to my mentor Alexander for their guidance and support throughout this project. His guidance and understanding is what allowed me to pull through and complete the GSoC with a happy mind. I also want to thank the XMPP Standards Foundation community for their encouragement and feedback.</p>
|
|
||||||
</description>
|
|
||||||
</item>
|
|
||||||
<item>
|
|
||||||
<title>Joining an MUC with Moxxy!</title>
|
|
||||||
<pubDate>Mon, 24 Jul 2023 00:00:00 +0000</pubDate>
|
|
||||||
<author>Unknown</author>
|
|
||||||
<link>https://moxxy.org/blog/join-muc-with-moxxy/</link>
|
|
||||||
<guid>https://moxxy.org/blog/join-muc-with-moxxy/</guid>
|
|
||||||
<description xml:base="https://moxxy.org/blog/join-muc-with-moxxy/"><p>Greetings, readers!</p>
|
|
||||||
<p>Welcome back to our series of blogs on the Google Summer of Code (GSoC) project. In this blog post, I'll be sharing the progress made in implementing Multi-User Chat (MUC) support in Moxxy, the frontend counterpart to my GSoC project.</p>
|
|
||||||
<span id="continue-reading"></span><h2 id="introduction">Introduction</h2>
|
|
||||||
<p>As you may recall, Moxxy is a frontend application developed as an innovative XMPP client. To enhance its functionality, my GSoC project focuses on adding MUC support. Before diving into the Moxxy implementation, it was crucial to establish the necessary MUC support in Moxxmpp, which is highlighted in <a href="https://moxxy.org/posts/2023-06-17-XEP-0045-In-Moxxmpp.html">this</a> blog.</p>
|
|
||||||
<p>Currently, the implementation progress is to allow users to join an MUC through Moxxy, and view incoming live messages in the chat. </p>
|
|
||||||
<h2 id="design-plan-for-muc-support-in-moxxy">Design Plan for MUC Support in Moxxy</h2>
|
|
||||||
<p>To implement MUC support in Moxxy, we need to extend its functionality and introduce new components. Let's outline the design plan for the MUC feature:</p>
|
|
||||||
<h3 id="new-page">New Page</h3>
|
|
||||||
<h4 id="joingroupchatpage">JoinGroupchatPage</h4>
|
|
||||||
<p>This page will contain just 1 text field - for the nickname that the user wants to join with. It also has a button that allows us to join the MUC with said nickname. It is an additional route to the current StartChat page, if the user selects that they want to join a groupchat.</p>
|
|
||||||
<h3 id="new-command">New Command</h3>
|
|
||||||
<h4 id="joingroupchatcommand">JoinGroupchatCommand</h4>
|
|
||||||
<p>This command is sent to the data layer worker (separate thread) from the UI, when the user clicks on the join groupchat button on the new join groupchat page. It contains information about the JID and the nick that the user tried to join with. This will only be sent to the worker thread if the input validations are cleared.</p>
|
|
||||||
<h3 id="new-event">New Event</h3>
|
|
||||||
<h4 id="joingroupchatresult">JoinGroupchatResult</h4>
|
|
||||||
<p>This event is sent back as a result of the JoinGroupchatCommand. Based on whether the request succeeded or failed, it will return the new Conversation object that has just been created.</p>
|
|
||||||
<h3 id="database-changes">Database changes</h3>
|
|
||||||
<h4 id="groupchatdetails-table">GroupchatDetails table</h4>
|
|
||||||
<p>Add a new GrouchatDetails table to the database containing two data items - the jid and the nick. The main reason to have a separate table for the groupchat details, instead of to just have a new nick item in the Conversation table - was to maintain the single responsibility principle.</p>
|
|
||||||
<p>When the user fetches a conversation of type groupchat from the database, a separate call will be made that fetches the relevant groupchat details from this new table, and attaches it to the Conversation object.</p>
|
|
||||||
<h3 id="miscellaneous-changes">Miscellaneous changes</h3>
|
|
||||||
<ul>
|
|
||||||
<li>
|
|
||||||
<p>Changed the external helpers for the ConversationType to an enhanced enum. This allows us to include the functions within the enum.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>The MUCManager was added to the list of registered managers for Moxxy. Not only this, the OccupantIdManager was also registered which will allow for the unique occupant identification moving forward. This will be required for message reactions/retractions in an MUC. </p>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<h3 id="new-service">New Service</h3>
|
|
||||||
<h4 id="groupchatservice">GroupchatService</h4>
|
|
||||||
<p>Added a new GroupchatService that allows for the following functions:</p>
|
|
||||||
<ul>
|
|
||||||
<li><strong>getRoomInformation</strong>: Sends a request to moxxmpp to receive disco info about the MUC.</li>
|
|
||||||
<li><strong>joinRoom</strong>: Sends a request to moxxmpp to join the MUC if it's not password protected.</li>
|
|
||||||
<li><strong>addGroupchatDetailsFromData</strong>: Adds a new GroupchatDetails object to the database table.</li>
|
|
||||||
<li><strong>getGroupchatDetailsByJid</strong>: Fetches the GroupchatDetails from the database based on the JID provided. This is required as a separate step while fetching an MUC conversation since the Conversations and GroupchatDetails table are decoupled. </li>
|
|
||||||
</ul>
|
|
||||||
<h3 id="handling-errors">Handling Errors</h3>
|
|
||||||
<p>To prevent avoidable errors, Moxxy performs frontend checks when joining a room. These checks include ensuring to validate the JID input field, and checking for empty nicknames.</p>
|
|
||||||
<p>Possible errors that users may encounter during the MUC workflow include invalid or already in use nicknames, disallowed registration, invalid stanza format, and invalid disco info response. Moxxy will handle these errors gracefully.</p>
|
|
||||||
<h2 id="challenges-and-considerations">Challenges and Considerations</h2>
|
|
||||||
<p>Here is an enumeration of the possible challenges that we could face in the future implementation, and the ones I faced in the current implementation as well:</p>
|
|
||||||
<ol>
|
|
||||||
<li>
|
|
||||||
<p>Differentiating Messages from Oneself: Moxxy/Moxxmpp need to distinguish between messages from other users and self-echoed messages. To address this, Moxxy uses the origin ID of the message. If the origin ID of the response matches the sent origin ID, the message is ignored and not displayed in the UI.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Handling Impersonation in Anonymous MUCs: In anonymous MUCs, users can impersonate others by reusing their nicknames after leaving. To tackle this, Moxxmpp leverages the occupant ID, as described in XEP-0421. Each user joining the group receives a unique occupant ID, which helps track message origins accurately.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Managing Discussion History on Rejoining: When a user rejoins an MUC, the room history is resent, including errors, self-presence with status code, room history, room subject, and live message/presence updates. To prevent appending duplicate history to the UI, Moxxy/Moxxmpp will have to wait until it receives the room subject before listening for message stanzas.</p>
|
|
||||||
</li>
|
|
||||||
</ol>
|
|
||||||
<h2 id="conclusion-and-future-work">Conclusion and Future Work</h2>
|
|
||||||
<p>In this blog post, we explored the implementation plan for adding MUC support, specifically XEP-0045, to Moxxy. Moxxmpp serves as the backbone for Moxxy's XMPP functionality, handling communication between the client and XMPP server. We discussed the directory structure, and key routines required for MUC support in Moxxmpp. Additionally, we addressed various challenges and considerations related to MUC features.</p>
|
|
||||||
<p>The implementation process has already commenced, with a pull request (PR) underway. Once the PR is complete, Moxxy will support joining a groupchat and listening to live messages. In further PRs, sending messages and leaving the MUC will be supported as well. The addition of MUC support will empower Moxxy users to enjoy enhanced collaboration and communication within XMPP group chats.</p>
|
|
||||||
<p>Stay tuned for future updates on the progress of MUC support in Moxxy. Until then, happy chatting!</p>
|
|
||||||
</description>
|
|
||||||
</item>
|
|
||||||
<item>
|
|
||||||
<title>XEP-0045 implementation in Moxxmpp</title>
|
|
||||||
<pubDate>Sat, 17 Jun 2023 00:00:00 +0000</pubDate>
|
|
||||||
<author>Unknown</author>
|
|
||||||
<link>https://moxxy.org/blog/xep-0045-in-moxxmpp/</link>
|
|
||||||
<guid>https://moxxy.org/blog/xep-0045-in-moxxmpp/</guid>
|
|
||||||
<description xml:base="https://moxxy.org/blog/xep-0045-in-moxxmpp/"><p>Hello readers!</p>
|
|
||||||
<p>Welcome back to the GSoC series of blogs. This one is about my implementation of the MUC XEP (XEP-0045) in Moxxmpp.</p>
|
|
||||||
<span id="continue-reading"></span><h2 id="introduction">Introduction</h2>
|
|
||||||
<p>Well, as you probably know, Moxxy is the frontend app that is being developed as a modern new XMPP client.</p>
|
|
||||||
<p>Moxxmpp is a Dart package that is used by Moxxy for multiple XMPP services. Essentially, the conversation between Moxxy and the XMPP server is handled by Moxxmpp. It is like the middleman that helps ease the communication between the two, keeping Moxxy code clean and free from the intricacies it handles.</p>
|
|
||||||
<p>Since my GSoC project is all about adding MUC support to Moxxy, it was essential to first add the required support in Moxxmpp before proceeding to Moxxy. This blog will give you an idea of what the responsibilities of Moxxmpp are, and why it was important to separate it from Moxxy.</p>
|
|
||||||
<h2 id="what-is-moxxmpp">What is Moxxmpp?</h2>
|
|
||||||
<p>In the words of it's developer, Moxxmpp is &quot;a pure-Dart XMPP library&quot;. Moxxmpp could be thought of as the backbone of Moxxy. The entire communication/networking part of Moxxy, i.e. how it (as a client) communicates with the user's XMPP server is outsourced to this Dart library.</p>
|
|
||||||
<p>Not only this, used as per it's rules - Moxxmpp could be used by any client to perform XMPP tasks that are currently supported by it. It is a re-usable and versatile XMPP library.</p>
|
|
||||||
<p>Listed below are some of it's core responsibilities:</p>
|
|
||||||
<ol>
|
|
||||||
<li>
|
|
||||||
<p>Establishing the connection between the client and the XMPP server via the user's JID and password.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Allowing Moxxy/any front-end client to register managers that provide support for a particular XEP/part of the XMPP flow. For example: the messaging service is handled by a MessageManager.
|
|
||||||
Similarly here are some other managers with their use:</p>
|
|
||||||
<ol>
|
|
||||||
<li>PresenceManager: Handling the presence related stanzas/use.</li>
|
|
||||||
<li>PubSubManager: Provides support for XEP-0060.</li>
|
|
||||||
<li>DiscoManager: Provides support for the service discovery: XEP-0030.</li>
|
|
||||||
<li>RosterManager: Handling roster related tasks.</li>
|
|
||||||
<li>BlockingManager: For blocking related tasks.</li>
|
|
||||||
</ol>
|
|
||||||
<p>As of June 17 2023, there are 35 such managers and 35 XEPs supported in Moxxmpp.</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>Managing cache: Moxxmpp manages cache of common requests, such as service discovery requests. If a request is duplicated, the result is provided from the cache - saving bandwidth and time.</p>
|
|
||||||
</li>
|
|
||||||
</ol>
|
|
||||||
<p>As explained below, new XEP support is related to adding new managers to Moxxmpp and I will be doing the same for XEP-0045 support in Moxxy. My design plan is elaborated in the next section. </p>
|
|
||||||
<p>Here is my implementation plan for adding XEP-0045 support to Moxxmpp.</p>
|
|
||||||
<h2 id="gsoc-moxxmpp-implementation-design-plan">GSoC Moxxmpp Implementation Design Plan</h2>
|
|
||||||
<h3 id="directory-structure">Directory Structure</h3>
|
|
||||||
<ul>
|
|
||||||
<li>xep_0045
|
|
||||||
<ul>
|
|
||||||
<li>errors.dart</li>
|
|
||||||
<li>helpers.dart</li>
|
|
||||||
<li>types.dart</li>
|
|
||||||
<li>xep_0045.dart</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li>Here, the errors.dart file will contain the abstract classes for different errors that one could get whilst going through all the lifecycle use-cases of the MUC feature.</li>
|
|
||||||
<li>The helpers.dart file will have some helper functions to maintain (DRY code avoiding repetition) and (modularized code).</li>
|
|
||||||
<li>types.dart will contain model classes for the events and other entities.</li>
|
|
||||||
<li>The xep_0045.dart is the main file which will contain the exposed routines as shown below, as well as the incoming stanza handlers.</li>
|
|
||||||
</ul>
|
|
||||||
<h3 id="phase-1-query-room-information">Phase 1 - Query Room Information</h3>
|
|
||||||
<h4 id="future-result-roominformation-mucerror-queryroominformation-jid-roomjid"><code>Future&lt;Result&lt;RoomInformation,MUCError&gt;&gt; queryRoomInformation(JID roomJID)</code></h4>
|
|
||||||
<p>This routine will allow the users to view the features of the room. These will include whether the room is open, moderated, password protected, etc. All this will be stored in a RoomInformation object and sent back as a Result object. It is important to note that the MUC server's address (for the 'to' attribute) will be parsed from the latter half of the room JID (the part post the '@').</p>
|
|
||||||
<p>The parameters of the RoomInformation class will be represented in the following way:</p>
|
|
||||||
<ol>
|
|
||||||
<li><code>JID roomJID</code></li>
|
|
||||||
<li><code>List&lt;String&gt; feature_list</code></li>
|
|
||||||
</ol>
|
|
||||||
<h3 id="phase-2-join-leave-room-handle-errors">Phase 2 - Join/Leave Room(Handle errors)</h3>
|
|
||||||
<p>To join/leave a room we can send an appropriate presence stanza that will handle the same for us. So we will have two simple routines for the same as well.</p>
|
|
||||||
<h3 id="routines">Routines</h3>
|
|
||||||
<h4 id="future-result-bool-mucerror-joinroom-jid-roomjid"><code>Future&lt;Result&gt;bool, MUCError&gt;&gt; joinRoom(JID roomJID)</code></h4>
|
|
||||||
<p>This routine will send a presence stanza to the MUC server asking it to join the server. It takes the <code>roomJID</code> as a parameter that will essentially contain the bare JID as well as the nickname (prompted from the user) as the resource. This will be preceded by the queryRoomInformation() routine call to obtain necessary information about the room, for example: if the room is password protected (in which case the user will see a not-implemented error dialog till a time it is supported).</p>
|
|
||||||
<p>Important to note is that the user's nickname will be used as the 'resource' in the roomJID sent by the frontend. This is because the 'to' attribute of a presence stanza to join a room looks as such - <code>{local/MUC}@{domain/chat server}/{nickname}.</code></p>
|
|
||||||
<h4 id="future-result-bool-mucerror-leaveroom-jid-roomjid"><code>Future&lt;Result&lt;bool, MUCError&gt;&gt; leaveRoom(JID roomJID)</code></h4>
|
|
||||||
<p>Similarly this is a routine to allow for leaving the room with a presence stanza.</p>
|
|
||||||
<p>The boolean return type is just to allow for a simple return object with the Result type. We could move forward with a simple Future<bool> as well, but for the sake of consistency - maybe sticking to the former is better. </p>
|
|
||||||
<h3 id="phase-3-refactor-sendmessage-to-handle-mucs">Phase 3 - Refactor sendMessage to handle MUCs</h3>
|
|
||||||
<p>To be able to send messages to groupchats/MUCs, the main requirement is to be able to change the <code>type</code> attribute in the message stanzas from <code>chat</code> to <code>groupchat</code>. This can be done in one of two ways. The first way will be to change the <code>sendMessage</code> routine's description to include a <code>type</code> parameter that will simply transfer over to the stanza that will be sent from moxxmpp as a string. Another was is described below, where a new extension called ConversationTypeData will be added to the <code>StanzaHandlerExtension</code> object whilst calling the sendMessage routine. The former solution is simpler and will most probably be implemented. The design for both these possibilities is listed below.</p>
|
|
||||||
<h4 id="solution-1">Solution 1</h4>
|
|
||||||
<p>The <code>sendMessage</code> routine will transform from </p>
|
|
||||||
<pre data-lang="Dart" class="language-Dart "><code class="language-Dart" data-lang="Dart">Future&lt;void&gt; sendMessage(
|
|
||||||
JID to,
|
|
||||||
TypedMap&lt;StanzaHandlerExtension&gt; extensions,
|
|
||||||
) async {
|
|
||||||
await getAttributes().sendStanza(
|
|
||||||
StanzaDetails(
|
|
||||||
Stanza.message(
|
|
||||||
to: to.toString(),
|
|
||||||
id: extensions.get&lt;MessageIdData&gt;()?.id,
|
|
||||||
type: &#x27;chat&#x27;,
|
|
||||||
children: _messageSendingCallbacks
|
|
||||||
.map((c) =&gt; c(extensions))
|
|
||||||
.flattened
|
|
||||||
.toList(),
|
|
||||||
),
|
|
||||||
awaitable: false,
|
|
||||||
),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
</code></pre>
|
|
||||||
<p>to</p>
|
|
||||||
<pre data-lang="Dart" class="language-Dart "><code class="language-Dart" data-lang="Dart">Future&lt;void&gt; sendMessage(
|
|
||||||
JID to,
|
|
||||||
TypedMap&lt;StanzaHandlerExtension&gt; extensions,
|
|
||||||
String type,
|
|
||||||
) async {
|
|
||||||
await getAttributes().sendStanza(
|
|
||||||
StanzaDetails(
|
|
||||||
Stanza.message(
|
|
||||||
to: to.toString(),
|
|
||||||
id: extensions.get&lt;MessageIdData&gt;()?.id,
|
|
||||||
type: type,
|
|
||||||
children: _messageSendingCallbacks
|
|
||||||
.map((c) =&gt; c(extensions))
|
|
||||||
.flattened
|
|
||||||
.toList(),
|
|
||||||
),
|
|
||||||
awaitable: false,
|
|
||||||
),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
</code></pre>
|
|
||||||
<h4 id="solution-2">Solution 2</h4>
|
|
||||||
<pre data-lang="Dart" class="language-Dart "><code class="language-Dart" data-lang="Dart">enum ConversationType {
|
|
||||||
chat, groupchat, groupchatprivate
|
|
||||||
}
|
|
||||||
</code></pre>
|
|
||||||
<p>The <code>ConversationTypeData</code> class essentially will act as a wrapper over the above enum. </p>
|
|
||||||
<p>Hence the new type attribute value will be:</p>
|
|
||||||
<pre data-lang="Dart" class="language-Dart "><code class="language-Dart" data-lang="Dart">extensions.get&lt;ConversationTypeData&gt;()?.conversationType ==
|
|
||||||
ConversationType.groupchat
|
|
||||||
? &#x27;groupchat&#x27;
|
|
||||||
: &#x27;chat&#x27;,
|
|
||||||
</code></pre>
|
|
||||||
<p>Here, <code>ConversationTypeData</code> is a simple wrapper over <code>ConversationType</code> so that it can be recognized as a subclass of the <code>StanzaHandlerExtensions</code> class.</p>
|
|
||||||
<p>For private MUC messages to a single participant, the <code>type</code> attribute of the message stanza should be set to <code>chat</code>. This can be handled very easily in case of either solution implementation. </p>
|
|
||||||
<hr />
|
|
||||||
<p>For MUC messages with a stanza reflecting a chat server (type: 'groupchat'), the type in the MessageEvent will be set to 'groupchat' automatically. The rest will be handled similarly to 1:1 chats.</p>
|
|
||||||
<h3 id="phase-4-miscellaneous-requirements">Phase 4 - Miscellaneous requirements</h3>
|
|
||||||
<p>Some of the miscellaneous requirements from Moxxmpp could include viewing member list, group subject, change availability status, and more.
|
|
||||||
For now, I have identified the below as the most crucial requirements for the Moxxmpp feature additions for MUC. </p>
|
|
||||||
<p>Below are the use-cases and how they are planned to be handled:</p>
|
|
||||||
<ol>
|
|
||||||
<li>Get member list</li>
|
|
||||||
</ol>
|
|
||||||
<p>After one joins a room, the user receives a presence from all the connected users to the chat. The best way to get the member list is to capture/handle the incoming presence stanzas and send an appropriate <code>MUCPresenceReceived</code> event to the UI.</p>
|
|
||||||
<p>This way, whenever a user joins a room, they can see the current member list, and on subsequent presence updates, also change that list.</p>
|
|
||||||
<ol start="2">
|
|
||||||
<li>Handling the room subject</li>
|
|
||||||
</ol>
|
|
||||||
<p>This is a very simple usecase. When a disco info query about the MUC goes out to the XMPP server, the response contains an identity node containing the chat name. This would be the best way to extract the rom subject. As of now, the <code>queryRoomInformation</code> routine will be triggered from the UI and the response will be sent to the same. This will be encapsulated in a simple <code>RoomInformation</code> class which is now updated as follows:</p>
|
|
||||||
<ol>
|
|
||||||
<li><code>JID roomJID</code></li>
|
|
||||||
<li><code>List&lt;String&gt; feature_list</code></li>
|
|
||||||
<li><code>String name</code></li>
|
|
||||||
</ol>
|
|
||||||
<p><strong>Note</strong>: Changing your status seemed like a task that would be slighlty out of scope for the project duration, so that is kept as a stretch goal for now.</p>
|
|
||||||
<h3 id="errors">Errors</h3>
|
|
||||||
<p>Frontend checks while joining a room to prevent avoidable errors:</p>
|
|
||||||
<ul>
|
|
||||||
<li>Nickname must be specified in accordance with the rules of the XEP - to prevent the no nickname specified error.</li>
|
|
||||||
<li>Validations for JID input field.</li>
|
|
||||||
<li>Validation for checking empty nickname.</li>
|
|
||||||
</ul>
|
|
||||||
<p>Some of the possible errors that can be faced by the user in an MUC workflow are:</p>
|
|
||||||
<ul>
|
|
||||||
<li>Invalid/Already in use nickname</li>
|
|
||||||
<li>Not allowed to register</li>
|
|
||||||
<li>Invalid stanza format</li>
|
|
||||||
<li>Invalid Disco Info Response: In case of some rare edge cases (not handled currently) where the response does not contain some information like the room name, or the features of the room. </li>
|
|
||||||
</ul>
|
|
||||||
<h2 id="challenges-noted">Challenges noted</h2>
|
|
||||||
<p>Some challenges/room for error were noted along the way. They are enumerated below:</p>
|
|
||||||
<ol>
|
|
||||||
<li>
|
|
||||||
<p>How will Moxxy/Moxxmpp handle messages from oneself?</p>
|
|
||||||
<p>When a user sends a message on the MUC, they receive the message themselves as well. How will moxxmpp/moxxy differentiate between other live messages and this echoed message? </p>
|
|
||||||
<p>The solution to this problem is to use the origin-id of the message. If the origin-id of the response matches with the sent origin-id, then the message is to be ignored and not shown in the UI. </p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>In anonymous MUCs, one can easily act as someone else by using their nickname once they leave. How will this be handled?</p>
|
|
||||||
<p>This is fixed by using the occupant-id property as described in XEP-0421. A user (with their unique JID) when joins the group, is assigned a unique occupant-id, which can be used to actually track which message is from which user. </p>
|
|
||||||
<p>This makes the implementation of reactions/retractions simpler. </p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>How will discussion history (sent on joining an MUC) be handled when someone rejoins an MUC?</p>
|
|
||||||
<p>When a user joins a MUC, they are sent a set of stanzas in the following order:</p>
|
|
||||||
<pre><code> 1. Errors (if any)
|
|
||||||
2. Self presence with status code
|
|
||||||
3. Room history
|
|
||||||
4. Room subject
|
|
||||||
5. Live message&#x2F;presence updates
|
|
||||||
</code></pre>
|
|
||||||
<p>Now, when a user gets disconnected from an MUC and joins again, then the room history will be sent again as well. To prevent this history from getting appended to the conversation in the UI, we will need to wait till we receive the room subject and only then start listening for message stanzas (since room subject is sent after room history).</p>
|
|
||||||
</li>
|
|
||||||
</ol>
|
|
||||||
<h2 id="conclusion-and-future-work">Conclusion and future work</h2>
|
|
||||||
<p>In conclusion, this blog post discussed the implementation plan for adding Multi-User Chat (MUC) support, specifically XEP-0045, to Moxxmpp. Moxxmpp serves as the backbone for the Moxxy XMPP client, handling the communication between the client and XMPP server. The blog outlined the directory structure, design plan, and key routines for implementing the MUC support in Moxxmpp. It also addressed some challenges and considerations related to handling MUC features.</p>
|
|
||||||
<p>Implementation for this has begun, and a <a href="https://codeberg.org/moxxy/moxxmpp/pulls/46">PR</a> is already underway. Once this PR is completed, then work will begin on the front-end and the changes will be integrated into Moxxy.</p>
|
|
||||||
</description>
|
|
||||||
</item>
|
|
||||||
<item>
|
|
||||||
<title>Moxxy's First GSoC Project!</title>
|
|
||||||
<pubDate>Sat, 06 May 2023 00:00:00 +0000</pubDate>
|
|
||||||
<author>Unknown</author>
|
|
||||||
<link>https://moxxy.org/blog/groupchat-gsoc-project/</link>
|
|
||||||
<guid>https://moxxy.org/blog/groupchat-gsoc-project/</guid>
|
|
||||||
<description xml:base="https://moxxy.org/blog/groupchat-gsoc-project/"><p>Hello readers!</p>
|
|
||||||
<p>As we know, Moxxy is an experimental IM for XMPP built using Flutter. While it does have a great set of features as described <a href="https://moxxy.org/">here</a>, it currently lacks support for group chats (or Multi-User-Chats). A great piece of news is that Google has accepted my proposal to add support for multi user chats in Moxxy.</p>
|
|
||||||
<span id="continue-reading"></span>
|
|
||||||
<p>To implement multi user chats in Moxxy, the <a href="https://xmpp.org/extensions/xep-0045.html">XEP-0045</a> standard will be followed and implemented. The project will run in two phases, since the major changes required will be in the <a href="https://codeberg.org/moxxy/moxxmpp">moxxmpp</a> and <a href="https://codeberg.org/moxxy/moxxy">Moxxy</a> codebases. First, XEP-0045 support will be added to moxxmpp with all the handlers, events and routines required to cleanly integrate the same with Moxxy. The second phase will be the UI changes in the Moxxy Flutter application, that builds upon the existing, reusable infrastructure.</p>
|
|
||||||
<p>The usecases planned to be implemented are listed below (subject to changes before the coding period begins):</p>
|
|
||||||
<ul>
|
|
||||||
<li>Join a room</li>
|
|
||||||
<li>Leave a room</li>
|
|
||||||
<li>Change availability status</li>
|
|
||||||
<li>View member list</li>
|
|
||||||
<li>Send/receive a message to/from all occupants</li>
|
|
||||||
<li>Send/receive a private message to/from a specific occupant</li>
|
|
||||||
</ul>
|
|
||||||
<p>Some extra usecases are planned in case time permits:</p>
|
|
||||||
<ul>
|
|
||||||
<li>Change nickname</li>
|
|
||||||
<li>Kick an occupant (if user has such a permission)</li>
|
|
||||||
<li>Ban an occupant (if user has such a permission)</li>
|
|
||||||
<li>Grant/revoke membership (if user has such a permission)</li>
|
|
||||||
</ul>
|
|
||||||
<p>The coding period for this project will begin on May 29. In case of any queries/interest, please join the following - <a href="xmpp:dev@muc.moxxy.org?join">xmpp:dev@muc.moxxy.org?join</a>.</p>
|
|
||||||
</description>
|
|
||||||
</item>
|
|
||||||
<item>
|
|
||||||
<title>Moxxy's New Website</title>
|
|
||||||
<pubDate>Tue, 24 Jan 2023 00:00:00 +0000</pubDate>
|
|
||||||
<author>Unknown</author>
|
|
||||||
<link>https://moxxy.org/blog/moxxys-new-website/</link>
|
|
||||||
<guid>https://moxxy.org/blog/moxxys-new-website/</guid>
|
|
||||||
<description xml:base="https://moxxy.org/blog/moxxys-new-website/"><p>Hello everyone! Welcome on Moxxy's new website. It currently does not contain
|
|
||||||
much but that may change in the future.</p>
|
|
||||||
<span id="continue-reading"></span>
|
|
||||||
<p>The page is built using <a href="https://jekyllrb.com/">Jekyll</a> and <a href="https://tailwindcss.com/">TailwindCSS</a>. You can find the page's
|
|
||||||
source <a href="https://codeberg.org/moxxy/website">here</a>.</p>
|
|
||||||
</description>
|
|
||||||
</item>
|
|
||||||
</channel>
|
|
||||||
</rss>
|
|
||||||
43
flake.lock
Normal file
43
flake.lock
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
{
|
||||||
|
"nodes": {
|
||||||
|
"flake-utils": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1667395993,
|
||||||
|
"narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=",
|
||||||
|
"owner": "numtide",
|
||||||
|
"repo": "flake-utils",
|
||||||
|
"rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "numtide",
|
||||||
|
"repo": "flake-utils",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"nixpkgs": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1704842529,
|
||||||
|
"narHash": "sha256-OTeQA+F8d/Evad33JMfuXC89VMetQbsU4qcaePchGr4=",
|
||||||
|
"owner": "NixOS",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"rev": "eabe8d3eface69f5bb16c18f8662a702f50c20d5",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "NixOS",
|
||||||
|
"ref": "nixpkgs-unstable",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"root": {
|
||||||
|
"inputs": {
|
||||||
|
"flake-utils": "flake-utils",
|
||||||
|
"nixpkgs": "nixpkgs"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"root": "root",
|
||||||
|
"version": 7
|
||||||
|
}
|
||||||
28
flake.nix
Normal file
28
flake.nix
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
{
|
||||||
|
description = "The website for Moxxy";
|
||||||
|
inputs = {
|
||||||
|
nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
|
||||||
|
flake-utils.url = "github:numtide/flake-utils";
|
||||||
|
};
|
||||||
|
|
||||||
|
outputs = { self, nixpkgs, flake-utils }: flake-utils.lib.eachDefaultSystem (system: let
|
||||||
|
pkgs = import nixpkgs {
|
||||||
|
inherit system;
|
||||||
|
};
|
||||||
|
|
||||||
|
tailwindWithTypography = (pkgs.nodePackages.tailwindcss.overrideAttrs (old: {
|
||||||
|
plugins = [
|
||||||
|
pkgs.nodePackages."@tailwindcss/typography"
|
||||||
|
];
|
||||||
|
}));
|
||||||
|
|
||||||
|
in {
|
||||||
|
devShell = pkgs.mkShell {
|
||||||
|
buildInputs = with pkgs; [
|
||||||
|
tailwindWithTypography
|
||||||
|
zola
|
||||||
|
imagemagick
|
||||||
|
];
|
||||||
|
};
|
||||||
|
});
|
||||||
|
}
|
||||||
124
index.html
124
index.html
@ -1,124 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<link href="https://moxxy.org/css/index.css" rel="stylesheet" />
|
|
||||||
<link rel="shortcut icon" href="https://moxxy.org/img/favicon.ico" sizes="32x32" />
|
|
||||||
<link href="https://moxxy.org/feed.xml" type="application/atom+xml" rel="alternate" title="Moxxy Blog" />
|
|
||||||
|
|
||||||
|
|
||||||
<meta property="og:description" content="A modern XMPP client" />
|
|
||||||
<meta property="og:title" content="Moxxy | A modern XMPP client" />
|
|
||||||
<title>Moxxy | A modern XMPP client</title>
|
|
||||||
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="flex flex-col">
|
|
||||||
<div class="relative h-16 inset-x-0 inset-y-0 px-4 shadow-md grid place-items-center">
|
|
||||||
<div class="flex flex-row items-center w-full">
|
|
||||||
<!-- The Moxxy logo -->
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<img src="https://moxxy.org/img/logo.png" class="w-12 h-12 p-2" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<a href="https://moxxy.org/">
|
|
||||||
<span class="font-bold">Moxxy</span>
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<!-- Spacer -->
|
|
||||||
<div class="grow"></div>
|
|
||||||
|
|
||||||
<a href="/blog/" class="px-2 text-sky-400">Blog</a>
|
|
||||||
<a href="https://moxxy.org/developers/" class="px-2 text-sky-400">Developers</a>
|
|
||||||
<a href="https://codeberg.org/moxxy/moxxy" class="px-2 text-sky-400">Source</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
<div class="w-full bg-moxxy-purple p-8 flex flex-row justify-center h-fit">
|
|
||||||
<div class="lg:w-1/2 grid grid-cols-2 gap-4">
|
|
||||||
<div class="grid grid-cols-1 place-items-center">
|
|
||||||
<span class="text-neutral-100 text-2xl text-center">An experimental and modern XMPP client</span>
|
|
||||||
</div>
|
|
||||||
<div class="grid grid-rows-1 place-items-center">
|
|
||||||
<img class="rounded-md h-64 lg:h-96" src="https://moxxy.org/img/screenshots/1.png" />
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="w-full p-8">
|
|
||||||
<div class="flex flex-col items-center">
|
|
||||||
<div class="flex flex-wrap gap-4">
|
|
||||||
|
|
||||||
<a href="https://apt.izzysoft.de/fdroid/index/apk/org.moxxy.moxxyv2">
|
|
||||||
<img class="h-24 md:h-16" src="https://moxxy.org/img/badges/IzzyOnDroid.png" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<a href="https://codeberg.org/moxxy/moxxy/releases/latest">
|
|
||||||
<img class="h-24 md:h-16" src="https://moxxy.org/img/badges/codeberg.png" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="w-full p-8">
|
|
||||||
<div class="flex flex-col items-center">
|
|
||||||
<div>
|
|
||||||
<h1 class="text-3xl font-bold pb-4 place-self-start">Features</h1>
|
|
||||||
|
|
||||||
<ul class="list-disc px-4">
|
|
||||||
|
|
||||||
<li>End-to-End encryption using OMEMO (0.8.3)</li>
|
|
||||||
|
|
||||||
<li>Stickers</li>
|
|
||||||
|
|
||||||
<li>Reactions</li>
|
|
||||||
|
|
||||||
<li>Retract messages</li>
|
|
||||||
|
|
||||||
<li>Voice messages</li>
|
|
||||||
|
|
||||||
<li>Swipe-to-quote</li>
|
|
||||||
|
|
||||||
<li>Chat background images</li>
|
|
||||||
|
|
||||||
<li>Optional privacy-preserving integration with phone contacts</li>
|
|
||||||
|
|
||||||
<li>Open-Source</li>
|
|
||||||
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="w-full p-8">
|
|
||||||
<div class="flex flex-col items-center">
|
|
||||||
<div>
|
|
||||||
<h1 class="text-3xl font-bold pb-4 place-self-start">Screenshots</h1>
|
|
||||||
|
|
||||||
<div class="flex flex-nowrap gap-8 overflow-scroll">
|
|
||||||
|
|
||||||
<img class="h-96 rounded-md" src="https://moxxy.org/img/screenshots/1.png" />
|
|
||||||
|
|
||||||
<img class="h-96 rounded-md" src="https://moxxy.org/img/screenshots/2.png" />
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<footer class="h-8 w-full flex flex-row justify-center">
|
|
||||||
<span class="text-sm text-center">
|
|
||||||
Made with <3 by
|
|
||||||
<a class="text-sky-400" href="https://polynom.me" target="_blank" rel="noopener noreferrer">PapaTutuWawa</a>
|
|
||||||
using <a class="text-sky-400" href="https://tailwindcss.com/" target="_blank" rel="noopener noreferrer">TailwindCSS</a>,
|
|
||||||
<a class="text-sky-400" href="https://jekyllrb.com/" target="_blank" rel="noopener noreferrer">Jekyll</a> and
|
|
||||||
<a class="text-sky-400" href="https://heroicons.com/">heroicons</a>.
|
|
||||||
</span>
|
|
||||||
</footer>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
10
input.css
Normal file
10
input.css
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
@tailwind base;
|
||||||
|
|
||||||
|
@layer base {
|
||||||
|
article > p > a {
|
||||||
|
@apply text-sky-400 !important;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@tailwind components;
|
||||||
|
@tailwind utilities;
|
||||||
@ -1,6 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<link rel="canonical" href="https://moxxy.org/blog/">
|
|
||||||
<meta http-equiv="refresh" content="0; url=https://moxxy.org/blog/">
|
|
||||||
<title>Redirect</title>
|
|
||||||
<p><a href="https://moxxy.org/blog/">Click here</a> to be redirected.</p>
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<link rel="canonical" href="https://moxxy.org/blog/moxxys-new-website/">
|
|
||||||
<meta http-equiv="refresh" content="0; url=https://moxxy.org/blog/moxxys-new-website/">
|
|
||||||
<title>Redirect</title>
|
|
||||||
<p><a href="https://moxxy.org/blog/moxxys-new-website/">Click here</a> to be redirected.</p>
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<link rel="canonical" href="https://moxxy.org/blog/groupchat-gsoc-project/">
|
|
||||||
<meta http-equiv="refresh" content="0; url=https://moxxy.org/blog/groupchat-gsoc-project/">
|
|
||||||
<title>Redirect</title>
|
|
||||||
<p><a href="https://moxxy.org/blog/groupchat-gsoc-project/">Click here</a> to be redirected.</p>
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<link rel="canonical" href="https://moxxy.org/blog/xep-0045-in-moxxmpp/">
|
|
||||||
<meta http-equiv="refresh" content="0; url=https://moxxy.org/blog/xep-0045-in-moxxmpp/">
|
|
||||||
<title>Redirect</title>
|
|
||||||
<p><a href="https://moxxy.org/blog/xep-0045-in-moxxmpp/">Click here</a> to be redirected.</p>
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<link rel="canonical" href="https://moxxy.org/blog/join-muc-with-moxxy/">
|
|
||||||
<meta http-equiv="refresh" content="0; url=https://moxxy.org/blog/join-muc-with-moxxy/">
|
|
||||||
<title>Redirect</title>
|
|
||||||
<p><a href="https://moxxy.org/blog/join-muc-with-moxxy/">Click here</a> to be redirected.</p>
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
<!doctype html>
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<link rel="canonical" href="https://moxxy.org/blog/moxxy-muc-gsoc-final-report/">
|
|
||||||
<meta http-equiv="refresh" content="0; url=https://moxxy.org/blog/moxxy-muc-gsoc-final-report/">
|
|
||||||
<title>Redirect</title>
|
|
||||||
<p><a href="https://moxxy.org/blog/moxxy-muc-gsoc-final-report/">Click here</a> to be redirected.</p>
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
User-agent: *
|
|
||||||
Disallow:
|
|
||||||
Allow: /
|
|
||||||
Sitemap: https://moxxy.org/sitemap.xml
|
|
||||||
32
sitemap.xml
32
sitemap.xml
@ -1,32 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
|
||||||
<url>
|
|
||||||
<loc>https://moxxy.org/</loc>
|
|
||||||
</url>
|
|
||||||
<url>
|
|
||||||
<loc>https://moxxy.org/blog/</loc>
|
|
||||||
</url>
|
|
||||||
<url>
|
|
||||||
<loc>https://moxxy.org/blog/groupchat-gsoc-project/</loc>
|
|
||||||
<lastmod>2023-05-06</lastmod>
|
|
||||||
</url>
|
|
||||||
<url>
|
|
||||||
<loc>https://moxxy.org/blog/join-muc-with-moxxy/</loc>
|
|
||||||
<lastmod>2023-07-24</lastmod>
|
|
||||||
</url>
|
|
||||||
<url>
|
|
||||||
<loc>https://moxxy.org/blog/moxxy-muc-gsoc-final-report/</loc>
|
|
||||||
<lastmod>2023-08-20</lastmod>
|
|
||||||
</url>
|
|
||||||
<url>
|
|
||||||
<loc>https://moxxy.org/blog/moxxys-new-website/</loc>
|
|
||||||
<lastmod>2023-01-24</lastmod>
|
|
||||||
</url>
|
|
||||||
<url>
|
|
||||||
<loc>https://moxxy.org/blog/xep-0045-in-moxxmpp/</loc>
|
|
||||||
<lastmod>2023-06-17</lastmod>
|
|
||||||
</url>
|
|
||||||
<url>
|
|
||||||
<loc>https://moxxy.org/developers/</loc>
|
|
||||||
</url>
|
|
||||||
</urlset>
|
|
||||||
1725
static/css/index.css
Normal file
1725
static/css/index.css
Normal file
File diff suppressed because it is too large
Load Diff
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 4.2 KiB After Width: | Height: | Size: 4.2 KiB |
|
Before Width: | Height: | Size: 77 KiB After Width: | Height: | Size: 77 KiB |
|
Before Width: | Height: | Size: 73 KiB After Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 528 KiB After Width: | Height: | Size: 528 KiB |
15
tailwind.config.js
Normal file
15
tailwind.config.js
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
module.exports = {
|
||||||
|
content: [
|
||||||
|
"./templates/*.html"
|
||||||
|
],
|
||||||
|
theme: {
|
||||||
|
extend: {
|
||||||
|
colors: {
|
||||||
|
'moxxy-purple': '#cf4aff',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
plugins: [
|
||||||
|
require('@tailwindcss/typography'),
|
||||||
|
],
|
||||||
|
}
|
||||||
37
templates/base.html
Normal file
37
templates/base.html
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<link href="{{ get_url(path="css/index.css") }}" rel="stylesheet" />
|
||||||
|
<link rel="shortcut icon" href="{{ get_url(path="img/favicon.ico") }}" sizes="32x32" />
|
||||||
|
<link href="{{ get_url(path="feed.xml", trailing_slash=false) }}" type="application/atom+xml" rel="alternate" title="Moxxy Blog" />
|
||||||
|
|
||||||
|
{% if page %}
|
||||||
|
<meta property="og:description" content="{{ page.description }}" />
|
||||||
|
<meta property="og:title" content="{{ page.title }}" />
|
||||||
|
<title>{{ page.title }}</title>
|
||||||
|
{% else %}
|
||||||
|
<meta property="og:description" content="{{ config.description }}" />
|
||||||
|
<meta property="og:title" content="{{ config.title }}" />
|
||||||
|
<title>{{ config.title }}</title>
|
||||||
|
{% endif %}
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div class="flex flex-col">
|
||||||
|
{% include "header.html" %}
|
||||||
|
|
||||||
|
{% block content %}{% endblock %}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<footer class="h-8 w-full flex flex-row justify-center">
|
||||||
|
<span class="text-sm text-center">
|
||||||
|
Made with <3 by
|
||||||
|
<a class="text-sky-400" href="https://polynom.me" target="_blank" rel="noopener noreferrer">PapaTutuWawa</a>
|
||||||
|
using <a class="text-sky-400" href="https://tailwindcss.com/" target="_blank" rel="noopener noreferrer">TailwindCSS</a>,
|
||||||
|
<a class="text-sky-400" href="https://jekyllrb.com/" target="_blank" rel="noopener noreferrer">Jekyll</a> and
|
||||||
|
<a class="text-sky-400" href="https://heroicons.com/">heroicons</a>.
|
||||||
|
</span>
|
||||||
|
</footer>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
34
templates/blog.html
Normal file
34
templates/blog.html
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
{% block content %}
|
||||||
|
<div class="w-full flex flex-row justify-center mt-2">
|
||||||
|
<div class="w-full lg:w-1/2 px-8 flex flex-col items-start">
|
||||||
|
<div class="flex flex-row items-center gap-x-3">
|
||||||
|
<h1 class="text-3xl">Blog posts</h1>
|
||||||
|
|
||||||
|
<a href="{{ get_url(path="feed.xml", trailing_slash=false) }}">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="w-6 h-6">
|
||||||
|
<path stroke-linecap="round" stroke-linejoin="round" d="M12.75 19.5v-.75a7.5 7.5 0 00-7.5-7.5H4.5m0-6.75h.75c7.87 0 14.25 6.38 14.25 14.25v.75M6 18.75a.75.75 0 11-1.5 0 .75.75 0 011.5 0z" />
|
||||||
|
</svg>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="divide-y divide-blue-200">
|
||||||
|
{% for post in section.pages %}
|
||||||
|
<!-- Post item -->
|
||||||
|
<div class="flex flex-col pt-4">
|
||||||
|
<a href="{{ post.permalink | safe }}">
|
||||||
|
<h1 class="text-indigo-400 prose prose-lg text-xl">{{ post.title }}</h1>
|
||||||
|
</a>
|
||||||
|
<span class="text-md mt-2">Posted by <i>{{ post.extra.author }}</i> on {{ post.date }}</span>
|
||||||
|
|
||||||
|
<!-- Blurp -->
|
||||||
|
<span class="prose mt-4">
|
||||||
|
{{ post.summary | safe }}
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
74
templates/developers.html
Normal file
74
templates/developers.html
Normal file
@ -0,0 +1,74 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
{% block content %}
|
||||||
|
<div class="w-full flex flex-row justify-center">
|
||||||
|
<div class="w-full lg:w-1/2">
|
||||||
|
|
||||||
|
<div class="w-full p-8 flex flex-col">
|
||||||
|
<div class="w-full pt-4">
|
||||||
|
<p>
|
||||||
|
Moxxy is fully open source. You can find the source code <a class="text-sky-400" href="{{ config.extra.sourceUrl }}">on Codeberg</a>. Additionally, the code is
|
||||||
|
mirrored <a class="text-sky-400" href="{{ config.extra.githubMirrorUrl }}">on GitHub</a>.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p class="pt-1 pb-4">
|
||||||
|
Feel free to join the <a class="text-sky-400" href="{{ config.extra.generalMuc }}">general chat</a> or the <a class="text-sky-400" href="{{ config.extra.developmentMuc }}">developer chat</a> with your favourite XMPP client.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<h1 class="text-3xl font-bold">Libraries</h1>
|
||||||
|
|
||||||
|
<p class="pb-4">
|
||||||
|
Moxxy is built from various smaller libraries that are custom-made for this purpose. Some of them are for general usage, some are specific to the use case of building Moxxy.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<table class="table-fixed">
|
||||||
|
<thead class="bg-gray-100">
|
||||||
|
<tr>
|
||||||
|
<th class="text-left px-1">Library</th>
|
||||||
|
<th class="text-left px-1">Description</th>
|
||||||
|
<th class="text-left px-1">Moxxy specific</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody class="divide-y divide-blue-200">
|
||||||
|
{% for library in config.extra.libraries %}
|
||||||
|
<tr>
|
||||||
|
<td class="pr-4">
|
||||||
|
<a class="text-sky-400" href="{{ library.url}}">{{ library.name }}</a>
|
||||||
|
</td>
|
||||||
|
<td class="pr-4">{{ library.desc }}</td>
|
||||||
|
<td class="pr-4">{% if library.specific %}Yes{% else %}No{% endif %}</td>
|
||||||
|
</tr>
|
||||||
|
{% endfor %}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="w-full p-8 flex flex-col">
|
||||||
|
<h1 class="text-3xl font-bold">Custom XEPs</h1>
|
||||||
|
|
||||||
|
<p class="pb-4">
|
||||||
|
Moxxy currently implements some custom XMPP protocols to provide additional functionality. These are experimental and are intended to be upstreamed at some point.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<table class="table-fixed">
|
||||||
|
<thead class="bg-gray-100">
|
||||||
|
<tr>
|
||||||
|
<th class="text-left px-1">Name</th>
|
||||||
|
<th class="text-left px-1">Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody class="divide-y divide-blue-200">
|
||||||
|
{% for xep in config.extra.customXeps %}
|
||||||
|
<tr>
|
||||||
|
<td class="pr-4">
|
||||||
|
<a class="text-sky-400" href="{{ xep.url }}">{{ xep.name }}</a>
|
||||||
|
</td>
|
||||||
|
<td class="pr-4">{{ xep.desc }}</td>
|
||||||
|
</tr>
|
||||||
|
{% endfor %}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
40
templates/feed.xml
Normal file
40
templates/feed.xml
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<rss xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">
|
||||||
|
<channel>
|
||||||
|
<title>{{ config.title }}
|
||||||
|
{%- if term %} - {{ term.name }}
|
||||||
|
{%- elif section.title %} - {{ section.title }}
|
||||||
|
{%- endif -%}
|
||||||
|
</title>
|
||||||
|
<link>
|
||||||
|
{%- if section -%}
|
||||||
|
{{ section.permalink | escape_xml | safe }}
|
||||||
|
{%- else -%}
|
||||||
|
{{ config.base_url | escape_xml | safe }}
|
||||||
|
{%- endif -%}
|
||||||
|
</link>
|
||||||
|
<description>{{ config.description }}</description>
|
||||||
|
<generator>Zola</generator>
|
||||||
|
<language>{{ lang }}</language>
|
||||||
|
<atom:link href="{{ feed_url | safe }}" rel="self" type="application/rss+xml"/>
|
||||||
|
<lastBuildDate>{{ last_updated | date(format="%a, %d %b %Y %H:%M:%S %z") }}</lastBuildDate>
|
||||||
|
{%- for page in pages %}
|
||||||
|
<item>
|
||||||
|
<title>{{ page.title }}</title>
|
||||||
|
<pubDate>{{ page.date | date(format="%a, %d %b %Y %H:%M:%S %z") }}</pubDate>
|
||||||
|
<author>
|
||||||
|
{%- if page.authors -%}
|
||||||
|
{{ page.authors[0] }}
|
||||||
|
{%- elif config.author -%}
|
||||||
|
{{ config.author }}
|
||||||
|
{%- else -%}
|
||||||
|
Unknown
|
||||||
|
{%- endif -%}
|
||||||
|
</author>
|
||||||
|
<link>{{ page.permalink | escape_xml | safe }}</link>
|
||||||
|
<guid>{{ page.permalink | escape_xml | safe }}</guid>
|
||||||
|
<description xml:base="{{ page.permalink | escape_xml | safe }}">{{ page.content }}</description>
|
||||||
|
</item>
|
||||||
|
{%- endfor %}
|
||||||
|
</channel>
|
||||||
|
</rss>
|
||||||
19
templates/header.html
Normal file
19
templates/header.html
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<div class="relative h-16 inset-x-0 inset-y-0 px-4 shadow-md grid place-items-center">
|
||||||
|
<div class="flex flex-row items-center w-full">
|
||||||
|
<!-- The Moxxy logo -->
|
||||||
|
<a href="{{ get_url(path="@/_index.md") }}">
|
||||||
|
<img src="{{ get_url(path="img/logo.png") }}" class="w-12 h-12 p-2" />
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<a href="{{ get_url(path="@/_index.md") }}">
|
||||||
|
<span class="font-bold">Moxxy</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<!-- Spacer -->
|
||||||
|
<div class="grow"></div>
|
||||||
|
|
||||||
|
<a href="/blog/" class="px-2 text-sky-400">Blog</a>
|
||||||
|
<a href="{{ get_url(path="@/developers.md") }}" class="px-2 text-sky-400">Developers</a>
|
||||||
|
<a href="{{ config.extra.sourceUrl }}" class="px-2 text-sky-400">Source</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
54
templates/index.html
Normal file
54
templates/index.html
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
{% block content %}
|
||||||
|
<div class="w-full bg-moxxy-purple p-8 flex flex-row justify-center h-fit">
|
||||||
|
<div class="lg:w-1/2 grid grid-cols-2 gap-4">
|
||||||
|
<div class="grid grid-cols-1 place-items-center">
|
||||||
|
<span class="text-neutral-100 text-2xl text-center">{{ config.extra.heroText }}</span>
|
||||||
|
</div>
|
||||||
|
<div class="grid grid-rows-1 place-items-center">
|
||||||
|
<img class="rounded-md h-64 lg:h-96" src="{{ get_url(path=config.extra.mainScreenshot) }}" />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="w-full p-8">
|
||||||
|
<div class="flex flex-col items-center">
|
||||||
|
<div class="flex flex-wrap gap-4">
|
||||||
|
{% for badge in config.extra.badges %}
|
||||||
|
<a href="{{ badge.url }}">
|
||||||
|
<img class="h-24 md:h-16" src="{{ get_url(path=badge.image)}}" />
|
||||||
|
</a>
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="w-full p-8">
|
||||||
|
<div class="flex flex-col items-center">
|
||||||
|
<div>
|
||||||
|
<h1 class="text-3xl font-bold pb-4 place-self-start">Features</h1>
|
||||||
|
|
||||||
|
<ul class="list-disc px-4">
|
||||||
|
{% for feature in config.extra.features %}
|
||||||
|
<li>{{ feature }}</li>
|
||||||
|
{% endfor %}
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="w-full p-8">
|
||||||
|
<div class="flex flex-col items-center">
|
||||||
|
<div>
|
||||||
|
<h1 class="text-3xl font-bold pb-4 place-self-start">Screenshots</h1>
|
||||||
|
|
||||||
|
<div class="flex flex-nowrap gap-8 overflow-scroll">
|
||||||
|
{% for screenshot in config.extra.screenshots %}
|
||||||
|
<img class="h-96 rounded-md" src="{{ get_url(path=screenshot) }}" />
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
13
templates/post.html
Normal file
13
templates/post.html
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
{% block content %}
|
||||||
|
<div class="w-full md:max-w-prose mt-2 mx-auto">
|
||||||
|
<div class="px-8">
|
||||||
|
<h1 class="text-3xl">{{ page.title }}</h1>
|
||||||
|
<span>Posted by <span class="italic">{{ page.extra.author }}</span> on {{ page.date }}</span>
|
||||||
|
<article class="mt-5 prose lg:prose-lg">
|
||||||
|
{{ page.content | safe }}
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
Loading…
Reference in New Issue
Block a user