dump solution
This commit is contained in:
commit
619d47ae66
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>.
|
14
Makefile
Normal file
14
Makefile
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
JAVA = javac
|
||||||
|
|
||||||
|
RM = /bin/rm -f
|
||||||
|
|
||||||
|
all:
|
||||||
|
#${JAVA} src/Message.java
|
||||||
|
#${JAVA} src/Room.java
|
||||||
|
#${JAVA} src/User.java
|
||||||
|
${JAVA} src/ChatClient.java
|
||||||
|
${JAVA} src/ChatServer.java
|
||||||
|
|
||||||
|
clean:
|
||||||
|
${RM} *.class
|
||||||
|
${RM} src/*.class
|
45
README.md
Normal file
45
README.md
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
# A simple Chat program written in Java with NIO package
|
||||||
|
This program was written as a solution for an assignment given in
|
||||||
|
DCC-FCUP's [Networking and Communication](https://sigarra.up.pt/fcup/en/UCURR_GERAL.FICHA_UC_VIEW?pv_ocorrencia_id=445231) module.
|
||||||
|
The server implements a [multiplex model](http://tutorials.jenkov.com/java-nio/selectors.html) using [Java's NIO API](http://tutorials.jenkov.com/java-nio/index.html).
|
||||||
|
|
||||||
|
The protocol specified in the [assignment.pdf](assignment.pdf) (in Portuguese) is vaguely similar to IRC.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
1. Compile it with `make`
|
||||||
|
2. Run the server with a listening port as argument
|
||||||
|
```Shell
|
||||||
|
java ChatServer 31337
|
||||||
|
```
|
||||||
|
3. Run the client with the server IP address and the listening port
|
||||||
|
```Shell
|
||||||
|
java ChatClient 127.0.0.1 31337
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
To test the sending of a fragmented message divided in various packages, use `netcat` with `<CTRL-D>`, as in
|
||||||
|
```Shell
|
||||||
|
/ni<CTRL-D>ck Chu<CTRL-D>ck No<CTRL-D>rris<ENTER>
|
||||||
|
```
|
||||||
|
To test the sending of various messages in a single package, you can try it with
|
||||||
|
```Shell
|
||||||
|
netcat localhost 31337 < test_package_input.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
## Credits
|
||||||
|
Developed by [Diogo Cordeiro](https://www.diogo.site/) and [Hugo Sales](https://github.com/someonewithpc)
|
||||||
|
|
||||||
|
## License
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as
|
||||||
|
published by the Free Software Foundation, either version 3 of the
|
||||||
|
License, or (at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful, but
|
||||||
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public
|
||||||
|
License along with this program, in the file "LICENSE". If not, see
|
||||||
|
<http://www.gnu.org/licenses/>.
|
BIN
assignment.pdf
Normal file
BIN
assignment.pdf
Normal file
Binary file not shown.
181
src/ChatClient.java
Normal file
181
src/ChatClient.java
Normal file
@ -0,0 +1,181 @@
|
|||||||
|
import javax.swing.*;
|
||||||
|
import java.awt.*;
|
||||||
|
import java.awt.event.ActionEvent;
|
||||||
|
import java.awt.event.ActionListener;
|
||||||
|
import java.awt.event.WindowAdapter;
|
||||||
|
import java.awt.event.WindowEvent;
|
||||||
|
import java.io.BufferedReader;
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStreamReader;
|
||||||
|
import java.net.InetSocketAddress;
|
||||||
|
import java.nio.CharBuffer;
|
||||||
|
import java.nio.channels.SocketChannel;
|
||||||
|
import java.nio.charset.Charset;
|
||||||
|
import java.nio.charset.CharsetEncoder;
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is the main class for the Chat Client
|
||||||
|
*/
|
||||||
|
public class
|
||||||
|
ChatClient
|
||||||
|
{
|
||||||
|
// Variáveis relacionadas com a interface gráfica --- * NÃO MODIFICAR *
|
||||||
|
JFrame frame = new JFrame("Chat Client");
|
||||||
|
private JTextField chatBox = new JTextField();
|
||||||
|
private JTextArea chatArea = new JTextArea();
|
||||||
|
// --- Fim das variáveis relacionadas com a interface gráfica
|
||||||
|
|
||||||
|
// Se for necessário adicionar variáveis ao objecto ChatClient, devem
|
||||||
|
// ser colocadas aqui
|
||||||
|
|
||||||
|
// Socket info
|
||||||
|
private SocketChannel client_socket;
|
||||||
|
|
||||||
|
// Decoder and enconder for transmitting text
|
||||||
|
private final Charset charset = StandardCharsets.UTF_8;
|
||||||
|
private final CharsetEncoder encoder = charset.newEncoder();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Método a usar para acrescentar uma string à caixa de texto
|
||||||
|
* * NÃO MODIFICAR *
|
||||||
|
*
|
||||||
|
* @param message
|
||||||
|
*/
|
||||||
|
public void
|
||||||
|
printMessage (final String message)
|
||||||
|
{
|
||||||
|
chatArea.append(message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor
|
||||||
|
*
|
||||||
|
* @param server server_host
|
||||||
|
* @param port server_port
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
public ChatClient (String server, int port)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
// Inicialização da interface gráfica --- * NÃO MODIFICAR *
|
||||||
|
frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
|
||||||
|
JPanel panel = new JPanel();
|
||||||
|
panel.setLayout(new BorderLayout());
|
||||||
|
panel.add(chatBox);
|
||||||
|
frame.setLayout(new BorderLayout());
|
||||||
|
frame.add(panel, BorderLayout.SOUTH);
|
||||||
|
frame.add(new JScrollPane(chatArea), BorderLayout.CENTER);
|
||||||
|
frame.setSize(500, 300);
|
||||||
|
frame.setVisible(true);
|
||||||
|
chatArea.setEditable(false);
|
||||||
|
chatBox.setEditable(true);
|
||||||
|
chatBox.addActionListener(new ActionListener() {
|
||||||
|
@Override
|
||||||
|
public void actionPerformed(ActionEvent e) {
|
||||||
|
try {
|
||||||
|
newMessage(chatBox.getText());
|
||||||
|
} catch (IOException ex) {
|
||||||
|
} finally {
|
||||||
|
chatBox.setText("");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
frame.addWindowListener(new WindowAdapter() {
|
||||||
|
public void windowOpened(WindowEvent e) {
|
||||||
|
chatBox.requestFocus();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
// --- Fim da inicialização da interface gráfica
|
||||||
|
|
||||||
|
// Se for necessário adicionar código de inicialização ao
|
||||||
|
// construtor, deve ser colocado aqui
|
||||||
|
|
||||||
|
// Socket information
|
||||||
|
try {
|
||||||
|
client_socket = SocketChannel.open();
|
||||||
|
client_socket.configureBlocking(true);
|
||||||
|
client_socket.connect(new InetSocketAddress(server, port));
|
||||||
|
} catch (IOException ex) {
|
||||||
|
// Fail graciously if the server is offline.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Instancia o ChatClient e arranca-o invocando o seu método run()
|
||||||
|
* * NÃO MODIFICAR *
|
||||||
|
*
|
||||||
|
* @param args
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
public static void
|
||||||
|
main (String[] args)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
ChatClient client = new ChatClient(args[0], Integer.parseInt(args[1]));
|
||||||
|
client.run();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Método invocado sempre que o utilizador insere uma mensagem
|
||||||
|
* na caixa de entrada
|
||||||
|
*
|
||||||
|
* @param message
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
public void
|
||||||
|
newMessage (String message)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
// PREENCHER AQUI com código que envia a mensagem ao servidor
|
||||||
|
client_socket.write(encoder.encode(CharBuffer.wrap(message + "\n")));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Método principal do objecto
|
||||||
|
*
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private void
|
||||||
|
run ()
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
// PREENCHER AQUI
|
||||||
|
try
|
||||||
|
{
|
||||||
|
while (!client_socket.finishConnect())
|
||||||
|
{;} /* Deliberately blank. */
|
||||||
|
}
|
||||||
|
catch (IOException ce)
|
||||||
|
{
|
||||||
|
System.err.println("Unable to connect to the server...");
|
||||||
|
System.exit(0);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
BufferedReader input_reader =
|
||||||
|
new BufferedReader(new InputStreamReader(client_socket.socket().getInputStream()));
|
||||||
|
|
||||||
|
// Listen loop
|
||||||
|
while (true)
|
||||||
|
{
|
||||||
|
String message = input_reader.readLine();
|
||||||
|
|
||||||
|
if (message == null)
|
||||||
|
{
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
System.out.println("RECEIVED: " + message);
|
||||||
|
message = message.trim();
|
||||||
|
|
||||||
|
printMessage(Message.parse_string(message).toString(true));
|
||||||
|
int len = chatArea.getDocument().getLength(); // Length of chat text in lines
|
||||||
|
chatArea.setCaretPosition(len); // Scroll to bottom
|
||||||
|
}
|
||||||
|
|
||||||
|
System.out.println("Terminated.");
|
||||||
|
client_socket.close();
|
||||||
|
System.exit(0);
|
||||||
|
}
|
||||||
|
}
|
634
src/ChatServer.java
Normal file
634
src/ChatServer.java
Normal file
@ -0,0 +1,634 @@
|
|||||||
|
import java.io.IOException;
|
||||||
|
import java.net.InetSocketAddress;
|
||||||
|
import java.net.ServerSocket;
|
||||||
|
import java.net.Socket;
|
||||||
|
import java.nio.ByteBuffer;
|
||||||
|
import java.nio.CharBuffer;
|
||||||
|
import java.nio.channels.SelectionKey;
|
||||||
|
import java.nio.channels.Selector;
|
||||||
|
import java.nio.channels.ServerSocketChannel;
|
||||||
|
import java.nio.channels.SocketChannel;
|
||||||
|
import java.nio.charset.Charset;
|
||||||
|
import java.nio.charset.CharsetDecoder;
|
||||||
|
import java.nio.charset.CharsetEncoder;
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.Set;
|
||||||
|
import java.util.TreeSet;
|
||||||
|
import java.util.regex.Matcher;
|
||||||
|
import java.util.regex.Pattern;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is the main class for the Chat Server
|
||||||
|
*/
|
||||||
|
public class
|
||||||
|
ChatServer
|
||||||
|
{
|
||||||
|
// A pre-allocated buffer for the received data
|
||||||
|
private static final ByteBuffer buffer = ByteBuffer.allocate(16384);
|
||||||
|
|
||||||
|
// Decoder and encoder for transmitting text
|
||||||
|
private static final Charset charset = StandardCharsets.UTF_8;
|
||||||
|
private static final CharsetDecoder decoder = charset.newDecoder();
|
||||||
|
private static final CharsetEncoder encoder = charset.newEncoder();
|
||||||
|
|
||||||
|
// Regex for message process
|
||||||
|
private static final String REGEX_MSG_NEW_NICKNAME = "nick " + Message.REGEX_NICKNAME;
|
||||||
|
private static final String REGEX_MSG_JOIN = "join " + Message.REGEX_ROOM_NAME;
|
||||||
|
private static final String REGEX_MSG_LEAVE = "leave";
|
||||||
|
private static final String REGEX_MSG_BYE = "bye";
|
||||||
|
private static final String REGEX_MSG_PRIVATE = "priv " + Message.REGEX_NICKNAME + " " + Message.REGEX_TEXT;
|
||||||
|
|
||||||
|
// Users info
|
||||||
|
private static final HashMap<String, User> nickname_user = new HashMap<>();
|
||||||
|
private static final HashMap<String, Room> nickname_room = new HashMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run the server
|
||||||
|
*
|
||||||
|
* @param args
|
||||||
|
*/
|
||||||
|
public static void
|
||||||
|
main (String[] args)
|
||||||
|
{
|
||||||
|
// Port to listen
|
||||||
|
int server_port = Integer.parseInt(args[0]);
|
||||||
|
|
||||||
|
try
|
||||||
|
{
|
||||||
|
// Instead of creating a ServerSocket, create a ServerSocketChannel
|
||||||
|
ServerSocketChannel ssc = ServerSocketChannel.open();
|
||||||
|
|
||||||
|
// Set it to non-blocking, so we can use select
|
||||||
|
ssc.configureBlocking(false);
|
||||||
|
|
||||||
|
// Get the Socket connected to this channel, and bind
|
||||||
|
// it to the listening port
|
||||||
|
ServerSocket ss = ssc.socket();
|
||||||
|
InetSocketAddress isa = new InetSocketAddress(server_port);
|
||||||
|
ss.bind(isa);
|
||||||
|
|
||||||
|
// Create a new Selector for selecting
|
||||||
|
Selector selector = Selector.open();
|
||||||
|
|
||||||
|
// Register the ServerSocketChannel, so we can listen
|
||||||
|
// for incoming connections
|
||||||
|
ssc.register(selector, SelectionKey.OP_ACCEPT);
|
||||||
|
System.out.println("Listening on port " + server_port);
|
||||||
|
|
||||||
|
while (true)
|
||||||
|
{
|
||||||
|
// See if we've had any activity -- either an incoming connection,
|
||||||
|
// or incoming data on an existing connection
|
||||||
|
int num = selector.select();
|
||||||
|
|
||||||
|
// If we don't have any activity, loop around and wait again
|
||||||
|
if (num == 0)
|
||||||
|
{
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get the keys corresponding to the activity that has been
|
||||||
|
// detected, and process them one by one
|
||||||
|
Set<SelectionKey> keys = selector.selectedKeys();
|
||||||
|
for (SelectionKey key : keys)
|
||||||
|
{
|
||||||
|
// Get a key representing one of bits of I/O activity
|
||||||
|
// What kind of activity is it?
|
||||||
|
if (key.isAcceptable())
|
||||||
|
{
|
||||||
|
// It's an incoming connection. Register this socket with
|
||||||
|
// the Selector so we can listen for input on it
|
||||||
|
Socket s = ss.accept();
|
||||||
|
System.out.println("Got connection from " + s + ".");
|
||||||
|
|
||||||
|
// Make sure to make it non-blocking, so we can use a selector
|
||||||
|
// on it.
|
||||||
|
SocketChannel sc = s.getChannel();
|
||||||
|
sc.configureBlocking(false);
|
||||||
|
|
||||||
|
// Register it with the selector, for reading
|
||||||
|
sc.register(selector, SelectionKey.OP_READ, new User(sc));
|
||||||
|
}
|
||||||
|
else if (key.isReadable())
|
||||||
|
{
|
||||||
|
SocketChannel sc = null;
|
||||||
|
|
||||||
|
try
|
||||||
|
{
|
||||||
|
// It's incoming data on a connection -- process it
|
||||||
|
sc = (SocketChannel) key.channel();
|
||||||
|
boolean ok = processInput(key, sc);
|
||||||
|
|
||||||
|
// If the connection is dead, remove it from the selector
|
||||||
|
// and close it
|
||||||
|
if (!ok)
|
||||||
|
{
|
||||||
|
key.cancel();
|
||||||
|
close_client(key, sc);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch (IOException ie)
|
||||||
|
{
|
||||||
|
// On exception, remove this channel from the selector
|
||||||
|
key.cancel();
|
||||||
|
close_client(key, sc);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// We remove the selected keys, because we've dealt with them.
|
||||||
|
keys.clear();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
catch (IOException ie)
|
||||||
|
{
|
||||||
|
System.err.println(ie.getMessage());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Close a connection with a client
|
||||||
|
*
|
||||||
|
* @param key
|
||||||
|
* @param sc
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
close_client (SelectionKey key, SocketChannel sc)
|
||||||
|
{
|
||||||
|
User sender = (User)key.attachment();
|
||||||
|
if (sender.get_state() == State.INSIDE)
|
||||||
|
{
|
||||||
|
Room room = sender.get_room();
|
||||||
|
room.left_user(sender);
|
||||||
|
TreeSet<User> user_list = room.get_users();
|
||||||
|
|
||||||
|
for (User user : user_list)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
send_left_message(user, sender.get_nickname());
|
||||||
|
}
|
||||||
|
catch (IOException ie)
|
||||||
|
{
|
||||||
|
System.err.println("Error sending left message: " + ie);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (user_list.size() == 0)
|
||||||
|
{
|
||||||
|
nickname_room.remove(room.get_name());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
nickname_user.remove(sender.get_nickname());
|
||||||
|
key.cancel();
|
||||||
|
|
||||||
|
Socket s = sc.socket();
|
||||||
|
try
|
||||||
|
{
|
||||||
|
System.out.println("Closing connection to " + s);
|
||||||
|
sc.close();
|
||||||
|
}
|
||||||
|
catch (IOException ie)
|
||||||
|
{
|
||||||
|
System.err.println("Error closing socket " + s + ": " + ie);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read a message from the socket and process it
|
||||||
|
*
|
||||||
|
* @param key
|
||||||
|
* @param sc
|
||||||
|
* @return boolean false if connection closed, true otherwise
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static boolean
|
||||||
|
processInput (SelectionKey key, SocketChannel sc)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
// Read the message to the buffer
|
||||||
|
buffer.clear();
|
||||||
|
sc.read(buffer);
|
||||||
|
buffer.flip();
|
||||||
|
|
||||||
|
// If no data, close the connection
|
||||||
|
if (buffer.limit() == 0)
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decode and add to buffer
|
||||||
|
User sender = (User)key.attachment();
|
||||||
|
sender.add_to_buffer(decoder.decode(buffer).toString());
|
||||||
|
String instructions = sender.get_buffer().toString();
|
||||||
|
|
||||||
|
// // Print byte representation of incoming package
|
||||||
|
// for (final char c : instructions.toCharArray()) {
|
||||||
|
// System.out.print((int) c + " ");
|
||||||
|
// }
|
||||||
|
// System.out.println();
|
||||||
|
|
||||||
|
// We only want to process full instructions
|
||||||
|
if (!instructions.endsWith("\n"))
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
for (String instruction : instructions.split("\n"))
|
||||||
|
{
|
||||||
|
Matcher tokens;
|
||||||
|
if (instruction.startsWith("/"))
|
||||||
|
{
|
||||||
|
String cmd = instruction.substring(1).trim();
|
||||||
|
|
||||||
|
if ((tokens = Pattern.compile(REGEX_MSG_NEW_NICKNAME).matcher(cmd)).find())
|
||||||
|
{
|
||||||
|
send_nickname_command(sender, tokens.group(1));
|
||||||
|
}
|
||||||
|
else if ((tokens = Pattern.compile(REGEX_MSG_JOIN).matcher(cmd)).find())
|
||||||
|
{
|
||||||
|
send_join_command(sender, tokens.group(1));
|
||||||
|
}
|
||||||
|
else if (Pattern.matches(REGEX_MSG_LEAVE, cmd))
|
||||||
|
{
|
||||||
|
send_leave_command(sender);
|
||||||
|
}
|
||||||
|
else if (Pattern.matches(REGEX_MSG_BYE, cmd))
|
||||||
|
{
|
||||||
|
send_bye_command(key, sender);
|
||||||
|
}
|
||||||
|
else if ((tokens = Pattern.compile(REGEX_MSG_PRIVATE).matcher(cmd)).find())
|
||||||
|
{
|
||||||
|
send_private_command(
|
||||||
|
sender,
|
||||||
|
// Emitter
|
||||||
|
tokens.group(1),
|
||||||
|
// Message
|
||||||
|
tokens.group(2)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else if (cmd.startsWith("/"))
|
||||||
|
{
|
||||||
|
send_public_message(sender, cmd);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
send_error_message(sender, "Unknown command.");
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
else if (instruction.length() != 0)
|
||||||
|
{
|
||||||
|
send_public_message(sender, instruction.trim());
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
sender.advance_buffer(instruction.length() + 1);
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Helper function to send a message
|
||||||
|
*
|
||||||
|
* @param sc
|
||||||
|
* @param message
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_message (SocketChannel sc, Message message)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
sc.write(encoder.encode(CharBuffer.wrap(message.toString())));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Helper function to send a message
|
||||||
|
*
|
||||||
|
* @param receiver
|
||||||
|
* @param sender
|
||||||
|
* @param message_value
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_message (User receiver, String sender, String message_value)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
Message message = new Message(MessageType.MESSAGE, sender, message_value);
|
||||||
|
send_message(receiver.get_socket(), message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send error message
|
||||||
|
*
|
||||||
|
* @param receiver
|
||||||
|
* @param error_message
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_error_message (User receiver, String error_message)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
Message message = new Message(MessageType.ERROR, error_message);
|
||||||
|
send_message(receiver.get_socket(), message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send ok message
|
||||||
|
*
|
||||||
|
* @param receiver
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_ok_message (User receiver)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
Message message = new Message(MessageType.OK);
|
||||||
|
send_message(receiver.get_socket(), message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send newnick message
|
||||||
|
*
|
||||||
|
* @param receiver
|
||||||
|
* @param old_nickname
|
||||||
|
* @param new_nickname
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_nickname_message (User receiver, String old_nickname, String new_nickname)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
Message message = new Message(MessageType.NEW_NICKNAME, old_nickname, new_nickname);
|
||||||
|
send_message(receiver.get_socket(), message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send joined message
|
||||||
|
*
|
||||||
|
* @param receiver
|
||||||
|
* @param join_nickname
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_joined_message (User receiver, String join_nickname)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
Message message = new Message(MessageType.JOINED, join_nickname);
|
||||||
|
send_message(receiver.get_socket(), message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send left message
|
||||||
|
*
|
||||||
|
* @param receiver
|
||||||
|
* @param left_nickname
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_left_message (User receiver, String left_nickname)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
Message message = new Message(MessageType.LEFT, left_nickname);
|
||||||
|
send_message(receiver.get_socket(), message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send bye message
|
||||||
|
*
|
||||||
|
* @param receiver
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_bye_message (User receiver)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
Message message = new Message(MessageType.BYE);
|
||||||
|
send_message(receiver.get_socket(), message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send private message
|
||||||
|
*
|
||||||
|
* @param receiver
|
||||||
|
* @param sender
|
||||||
|
* @param message_value
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_private_message (User receiver, String sender, String message_value)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
Message message = new Message(MessageType.PRIVATE, sender, message_value);
|
||||||
|
send_message(receiver.get_socket(), message);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send simple message
|
||||||
|
*
|
||||||
|
* @param sender
|
||||||
|
* @param message_value
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_public_message (User sender, String message_value)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
if (sender.get_state() == State.INSIDE)
|
||||||
|
{
|
||||||
|
Room sender_room = sender.get_room();
|
||||||
|
TreeSet<User> user_list = sender_room.get_users();
|
||||||
|
|
||||||
|
for (User user : user_list)
|
||||||
|
{
|
||||||
|
send_message(user, sender.get_nickname(), message_value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
send_error_message(sender, "You are not in a room.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send nick command
|
||||||
|
*
|
||||||
|
* @param sender
|
||||||
|
* @param nick
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_nickname_command (User sender, String nick)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
if (
|
||||||
|
// Allow to change to the current nick
|
||||||
|
// Only compare if the user already has a nickname
|
||||||
|
((sender.get_state() != State.INIT)
|
||||||
|
&& sender.get_nickname().equals(nick))
|
||||||
|
|| // Don't allow to set a nickname already in use
|
||||||
|
!nickname_user.containsKey(nick)
|
||||||
|
)
|
||||||
|
{
|
||||||
|
if (sender.get_state() == State.INIT)
|
||||||
|
{
|
||||||
|
sender.set_state(State.OUTSIDE);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (sender.get_state() == State.INSIDE)
|
||||||
|
{
|
||||||
|
Room sender_room = sender.get_room();
|
||||||
|
TreeSet<User> user_list = sender_room.get_users();
|
||||||
|
|
||||||
|
for (User user : user_list)
|
||||||
|
{
|
||||||
|
if (user != sender)
|
||||||
|
{
|
||||||
|
send_nickname_message(user, sender.get_nickname(), nick);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
nickname_user.remove(sender.get_nickname());
|
||||||
|
nickname_user.put(nick, sender);
|
||||||
|
send_ok_message(sender);
|
||||||
|
sender.set_nickname(nick);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
send_error_message(sender, "There already is a user with nick " + nick);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send join command
|
||||||
|
*
|
||||||
|
* @param sender
|
||||||
|
* @param room_name
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_join_command (User sender, String room_name)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
if (sender.get_state() == State.INIT)
|
||||||
|
{
|
||||||
|
send_error_message(sender, "You don't have a nickname.");
|
||||||
|
}
|
||||||
|
/*else if (sender.get_room().get_name().equals(room_name))
|
||||||
|
{
|
||||||
|
send_error_message(sender, "You already are in that room.");
|
||||||
|
}*/
|
||||||
|
else
|
||||||
|
{
|
||||||
|
// If already in a room, leave it first
|
||||||
|
if (sender.get_state() == State.INSIDE)
|
||||||
|
{
|
||||||
|
send_leave_command(sender);
|
||||||
|
}
|
||||||
|
|
||||||
|
// If room doesn't exist
|
||||||
|
if (!nickname_room.containsKey(room_name))
|
||||||
|
{
|
||||||
|
nickname_room.put(room_name, new Room(room_name));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Notify
|
||||||
|
Room new_room = nickname_room.get(room_name);
|
||||||
|
TreeSet<User> current_room_user_list = new_room.get_users();
|
||||||
|
new_room.join_user(sender);
|
||||||
|
|
||||||
|
for (User user : current_room_user_list)
|
||||||
|
{
|
||||||
|
send_joined_message(user, sender.get_nickname());
|
||||||
|
}
|
||||||
|
|
||||||
|
send_ok_message(sender);
|
||||||
|
sender.set_room(new_room);
|
||||||
|
sender.set_state(State.INSIDE);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send leave command
|
||||||
|
*
|
||||||
|
* @param sender
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_leave_command (User sender)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
if (sender.get_state() != State.INSIDE)
|
||||||
|
{
|
||||||
|
send_error_message(sender, "You are not in a room.");
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
Room room = sender.get_room();
|
||||||
|
room.left_user(sender);
|
||||||
|
TreeSet<User> user_list = room.get_users();
|
||||||
|
|
||||||
|
for (User user : user_list)
|
||||||
|
{
|
||||||
|
send_left_message(user, sender.get_nickname());
|
||||||
|
}
|
||||||
|
|
||||||
|
if (user_list.size() == 0)
|
||||||
|
{
|
||||||
|
nickname_room.remove(room.get_name());
|
||||||
|
}
|
||||||
|
|
||||||
|
send_ok_message(sender);
|
||||||
|
sender.set_state(State.OUTSIDE);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send bye command
|
||||||
|
*
|
||||||
|
* @param key
|
||||||
|
* @param sender
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_bye_command (SelectionKey key, User sender)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
send_bye_message(sender);
|
||||||
|
close_client(key, sender.get_socket());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send private message
|
||||||
|
*
|
||||||
|
* @param sender
|
||||||
|
* @param receiver
|
||||||
|
* @param message_value
|
||||||
|
* @throws IOException
|
||||||
|
*/
|
||||||
|
private static void
|
||||||
|
send_private_command (User sender, String receiver, String message_value)
|
||||||
|
throws IOException
|
||||||
|
{
|
||||||
|
if (sender.get_state() == State.INIT)
|
||||||
|
{
|
||||||
|
send_error_message(sender, "You don't have a nickname.");
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
if (nickname_user.containsKey(receiver))
|
||||||
|
{
|
||||||
|
send_ok_message(sender);
|
||||||
|
send_private_message(nickname_user.get(receiver), sender.get_nickname(), message_value);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
send_error_message(sender, receiver + ": No such nickname online.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
253
src/Message.java
Normal file
253
src/Message.java
Normal file
@ -0,0 +1,253 @@
|
|||||||
|
import java.util.regex.Matcher;
|
||||||
|
import java.util.regex.Pattern;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Type of the Message
|
||||||
|
*/
|
||||||
|
enum MessageType
|
||||||
|
{
|
||||||
|
OK, ERROR, MESSAGE, NEW_NICKNAME, JOINED, LEFT, BYE, PRIVATE
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Message class
|
||||||
|
*/
|
||||||
|
public class
|
||||||
|
Message
|
||||||
|
{
|
||||||
|
public static final String REGEX_NICKNAME = "([^ .]+)";
|
||||||
|
public static final String REGEX_ROOM_NAME = "([^ .]+)";
|
||||||
|
public static final String REGEX_TEXT = "(.*)";
|
||||||
|
// Regex for command process
|
||||||
|
private static final String REGEX_CMD_OK = "OK";
|
||||||
|
private static final String REGEX_CMD_ERROR = "ERROR";
|
||||||
|
private static final String REGEX_CMD_MESSAGE = "MESSAGE " + REGEX_NICKNAME + " " + REGEX_TEXT;
|
||||||
|
private static final String REGEX_CMD_NEW_NICKNAME = "NEWNICK " + REGEX_NICKNAME + " " + REGEX_NICKNAME;
|
||||||
|
private static final String REGEX_CMD_JOINED = "JOINED " + REGEX_NICKNAME;
|
||||||
|
private static final String REGEX_CMD_LEFT = "LEFT " + REGEX_NICKNAME;
|
||||||
|
private static final String REGEX_CMD_BYE = "BYE";
|
||||||
|
private static final String REGEX_CMD_PRIVATE = "PRIVATE " + REGEX_NICKNAME + " " + REGEX_TEXT;
|
||||||
|
private final MessageType type;
|
||||||
|
// There are no getters for these two attributes, refer to toString
|
||||||
|
private final String token1;
|
||||||
|
private final String token2;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor
|
||||||
|
*
|
||||||
|
* @param type
|
||||||
|
*/
|
||||||
|
public Message (MessageType type)
|
||||||
|
{
|
||||||
|
this.type = type;
|
||||||
|
this.token1 = "";
|
||||||
|
this.token2 = "";
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor
|
||||||
|
*
|
||||||
|
* @param type
|
||||||
|
* @param token1
|
||||||
|
*/
|
||||||
|
public Message (MessageType type, String token1)
|
||||||
|
{
|
||||||
|
this.type = type;
|
||||||
|
this.token1 = token1;
|
||||||
|
this.token2 = "";
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor
|
||||||
|
*
|
||||||
|
* @param type
|
||||||
|
* @param token1
|
||||||
|
* @param token2
|
||||||
|
*/
|
||||||
|
public Message (MessageType type, String token1, String token2)
|
||||||
|
{
|
||||||
|
this.type = type;
|
||||||
|
this.token1 = token1;
|
||||||
|
this.token2 = token2;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Message from String
|
||||||
|
* ONLY TO BE USED BY CHAT CLIENT (that is, command process and not
|
||||||
|
* message process as happens in the server)
|
||||||
|
*
|
||||||
|
* @param text
|
||||||
|
* @return Message
|
||||||
|
*/
|
||||||
|
public static Message
|
||||||
|
parse_string (String text)
|
||||||
|
{
|
||||||
|
MessageType type;
|
||||||
|
Matcher tokens;
|
||||||
|
String token1 = "";
|
||||||
|
String token2 = "";
|
||||||
|
|
||||||
|
if (Pattern.matches(REGEX_CMD_OK, text))
|
||||||
|
{
|
||||||
|
type = MessageType.OK;
|
||||||
|
}
|
||||||
|
else if (Pattern.matches(REGEX_CMD_ERROR, text))
|
||||||
|
{
|
||||||
|
type = MessageType.ERROR;
|
||||||
|
}
|
||||||
|
else if ((tokens = Pattern.compile(REGEX_CMD_MESSAGE).matcher(text)).find())
|
||||||
|
{
|
||||||
|
type = MessageType.MESSAGE;
|
||||||
|
token1 = tokens.group(1); // Emitter
|
||||||
|
token2 = tokens.group(2); // Message
|
||||||
|
}
|
||||||
|
else if ((tokens = Pattern.compile(REGEX_CMD_NEW_NICKNAME).matcher(text)).find())
|
||||||
|
{
|
||||||
|
type = MessageType.NEW_NICKNAME;
|
||||||
|
token1 = tokens.group(1); // Old nickname
|
||||||
|
token2 = tokens.group(2); // New nickname
|
||||||
|
}
|
||||||
|
else if ((tokens = Pattern.compile(REGEX_CMD_JOINED).matcher(text)).find())
|
||||||
|
{
|
||||||
|
type = MessageType.JOINED;
|
||||||
|
token1 = tokens.group(1);
|
||||||
|
}
|
||||||
|
else if ((tokens = Pattern.compile(REGEX_CMD_LEFT).matcher(text)).find())
|
||||||
|
{
|
||||||
|
type = MessageType.LEFT;
|
||||||
|
token1 = tokens.group(1);
|
||||||
|
}
|
||||||
|
else if (Pattern.matches(REGEX_CMD_BYE, text))
|
||||||
|
{
|
||||||
|
type = MessageType.BYE;
|
||||||
|
}
|
||||||
|
else if ((tokens = Pattern.compile(REGEX_CMD_PRIVATE).matcher(text)).find())
|
||||||
|
{
|
||||||
|
type = MessageType.PRIVATE;
|
||||||
|
token1 = tokens.group(1); // Emitter
|
||||||
|
token2 = tokens.group(2); // Message
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
type = MessageType.ERROR;
|
||||||
|
}
|
||||||
|
|
||||||
|
return new Message(type, token1, token2);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return MessageType
|
||||||
|
*/
|
||||||
|
public MessageType
|
||||||
|
get_type ()
|
||||||
|
{
|
||||||
|
return this.type;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return String
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public String
|
||||||
|
toString ()
|
||||||
|
{
|
||||||
|
return this.toString(false);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param pretty
|
||||||
|
* @return String
|
||||||
|
*/
|
||||||
|
public String
|
||||||
|
toString (boolean pretty)
|
||||||
|
{
|
||||||
|
String output = "";
|
||||||
|
|
||||||
|
switch (this.type)
|
||||||
|
{
|
||||||
|
case OK:
|
||||||
|
if (pretty)
|
||||||
|
{
|
||||||
|
output = "Command successful.";
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
output = "OK";
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case ERROR:
|
||||||
|
if (pretty)
|
||||||
|
{
|
||||||
|
output = "Error. " + this.token1;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
output = "ERROR";
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case MESSAGE:
|
||||||
|
if (pretty)
|
||||||
|
{
|
||||||
|
output = this.token1 + ": " + this.token2;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
output = "MESSAGE " + this.token1 + " " + this.token2;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case NEW_NICKNAME:
|
||||||
|
if (pretty)
|
||||||
|
{
|
||||||
|
output = this.token1 + " is now known as " + this.token2;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
output = "NEWNICK " + this.token1 + " " + this.token2;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case JOINED:
|
||||||
|
if (pretty)
|
||||||
|
{
|
||||||
|
output = this.token1 + " has joined the room.";
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
output = "JOINED " + this.token1;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case LEFT:
|
||||||
|
if (pretty)
|
||||||
|
{
|
||||||
|
output = this.token1 + " left the room.";
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
output = "LEFT " + this.token1;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case BYE:
|
||||||
|
if (pretty)
|
||||||
|
{
|
||||||
|
output = "Disconnected...";
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
output = "BYE";
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case PRIVATE:
|
||||||
|
if (pretty)
|
||||||
|
{
|
||||||
|
output = "<" + this.token1 + ">: " + this.token2;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
output = "PRIVATE " + this.token1 + " " + this.token2;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
return output + "\n";
|
||||||
|
}
|
||||||
|
}
|
58
src/Room.java
Normal file
58
src/Room.java
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
import java.util.TreeSet;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Room class
|
||||||
|
*/
|
||||||
|
public class
|
||||||
|
Room
|
||||||
|
{
|
||||||
|
private final TreeSet<User> users;
|
||||||
|
private final String name;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor
|
||||||
|
*
|
||||||
|
* @param name
|
||||||
|
*/
|
||||||
|
public Room (String name)
|
||||||
|
{
|
||||||
|
this.users = new TreeSet<>();
|
||||||
|
this.name = name;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return TreeSet<User>
|
||||||
|
*/
|
||||||
|
public TreeSet<User>
|
||||||
|
get_users ()
|
||||||
|
{
|
||||||
|
return this.users;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param user
|
||||||
|
*/
|
||||||
|
public void
|
||||||
|
join_user (User user)
|
||||||
|
{
|
||||||
|
this.users.add(user);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param user
|
||||||
|
*/
|
||||||
|
public void
|
||||||
|
left_user (User user)
|
||||||
|
{
|
||||||
|
this.users.remove(user);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return String
|
||||||
|
*/
|
||||||
|
public String
|
||||||
|
get_name ()
|
||||||
|
{
|
||||||
|
return this.name;
|
||||||
|
}
|
||||||
|
}
|
137
src/User.java
Normal file
137
src/User.java
Normal file
@ -0,0 +1,137 @@
|
|||||||
|
import java.nio.channels.SocketChannel;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* User state
|
||||||
|
*/
|
||||||
|
enum State
|
||||||
|
{
|
||||||
|
INIT, OUTSIDE, INSIDE
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* User class
|
||||||
|
*/
|
||||||
|
public class
|
||||||
|
User
|
||||||
|
implements Comparable<User>
|
||||||
|
{
|
||||||
|
private String nickname;
|
||||||
|
private State state = State.INIT;
|
||||||
|
private Room room;
|
||||||
|
private final SocketChannel socket;
|
||||||
|
private StringBuilder buffer = new StringBuilder();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor
|
||||||
|
*
|
||||||
|
* @param socket
|
||||||
|
*/
|
||||||
|
public User (SocketChannel socket)
|
||||||
|
{
|
||||||
|
this.socket = socket;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Comparator
|
||||||
|
*
|
||||||
|
* @param other
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public int
|
||||||
|
compareTo (User other)
|
||||||
|
{
|
||||||
|
return this.nickname.compareTo(other.nickname);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return String
|
||||||
|
*/
|
||||||
|
public String
|
||||||
|
get_nickname ()
|
||||||
|
{
|
||||||
|
return this.nickname;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param nickname
|
||||||
|
*/
|
||||||
|
public void
|
||||||
|
set_nickname (String nickname)
|
||||||
|
{
|
||||||
|
this.nickname = nickname;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return State
|
||||||
|
*/
|
||||||
|
public State
|
||||||
|
get_state ()
|
||||||
|
{
|
||||||
|
return this.state;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param state
|
||||||
|
*/
|
||||||
|
public void
|
||||||
|
set_state (State state)
|
||||||
|
{
|
||||||
|
this.state = state;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return Room
|
||||||
|
*/
|
||||||
|
public Room
|
||||||
|
get_room ()
|
||||||
|
{
|
||||||
|
return this.room;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param room
|
||||||
|
*/
|
||||||
|
public void
|
||||||
|
set_room (Room room)
|
||||||
|
{
|
||||||
|
this.room = room;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return SocketChannel
|
||||||
|
*/
|
||||||
|
public SocketChannel
|
||||||
|
get_socket ()
|
||||||
|
{
|
||||||
|
return this.socket;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param cmd
|
||||||
|
*/
|
||||||
|
public void
|
||||||
|
add_to_buffer (String cmd)
|
||||||
|
{
|
||||||
|
this.buffer.append(cmd);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return String
|
||||||
|
*/
|
||||||
|
public StringBuilder
|
||||||
|
get_buffer ()
|
||||||
|
{
|
||||||
|
return this.buffer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param idx
|
||||||
|
*/
|
||||||
|
public void
|
||||||
|
advance_buffer (int idx)
|
||||||
|
{
|
||||||
|
this.buffer.delete(0, idx);
|
||||||
|
}
|
||||||
|
}
|
11
src/chat.iml
Normal file
11
src/chat.iml
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<module type="JAVA_MODULE" version="4">
|
||||||
|
<component name="NewModuleRootManager" inherit-compiler-output="true">
|
||||||
|
<exclude-output />
|
||||||
|
<content url="file://$MODULE_DIR$">
|
||||||
|
<sourceFolder url="file://$MODULE_DIR$" isTestSource="false" />
|
||||||
|
</content>
|
||||||
|
<orderEntry type="inheritedJdk" />
|
||||||
|
<orderEntry type="sourceFolder" forTests="false" />
|
||||||
|
</component>
|
||||||
|
</module>
|
4
test_package_input.txt
Normal file
4
test_package_input.txt
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
/nick bomrapaz
|
||||||
|
/join sala
|
||||||
|
Bom dia!
|
||||||
|
|
Reference in New Issue
Block a user