phares3757/barcode-server
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Init

Browse Source
This commit is contained in:
Mike Phares 2022-06-24 12:14:10 -07:00
commit 27fc1f5e16
31 changed files with 3769 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
.idea
venv

19
Dockerfile Normal file
View File

@ -0,0 +1,19 @@
# Docker image for barcode-server
FROM python:3.9
WORKDIR /app
COPY . .
RUN apt-get update \
&& apt-get -y install sudo
RUN pip install --upgrade pip;\
pip install pipenv;\
pipenv install --system --deploy;\
pip install .
ENV PUID=1000 PGID=1000
ENTRYPOINT [ "docker/entrypoint.sh", "barcode-server" ]
CMD [ "run" ]

661
LICENSE Normal file
View File

@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<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 Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.

1
MANIFEST.in Normal file
View File

@ -0,0 +1 @@
include Pipfile.lock

35
Makefile Normal file
View File

@ -0,0 +1,35 @@
PROJECT=barcode_server
current-version:
set -ex
@echo "Current version is `cat ${PROJECT}/__init__.py | grep '__version__' | cut -d ' ' -f3 | sed s/\\\"//g`"
build:
git stash
python setup.py sdist
- git stash pop
test:
pipenv run pytest
git-release:
set -ex
git add ${PROJECT}/__init__.py
git commit -m "Bumped version to `cat ${PROJECT}/__init__.py | grep '__version__' | cut -d ' ' -f3 | sed s/\\\"//g`"
git tag v`cat ${PROJECT}/__init__.py | grep '__version__' | cut -d ' ' -f3 | sed s/\"//g`
git push
git push --tags
_release-patch:
@echo "__version__ = \"`cat ${PROJECT}/__init__.py | awk -F '("|")' '{ print($$2)}' | awk -F. '{$$NF = $$NF + 1;} 1' | sed 's/ /./g'`\"" > ${PROJECT}/__init__.py
release-patch: test _release-patch git-release current-version
_release-minor:
@echo "__version__ = \"`cat ${PROJECT}/__init__.py | awk -F '("|")' '{ print($$2)}' | awk -F. '{$$(NF-1) = $$(NF-1) + 1;} 1' | sed 's/ /./g' | awk -F. '{$$(NF) = 0;} 1' | sed 's/ /./g' `\"" > ${PROJECT}/__init__.py
release-minor: test _release-minor git-release current-version
_release-major:
@echo "__version__ = \"`cat ${PROJECT}/__init__.py | awk -F '("|")' '{ print($$2)}' | awk -F. '{$$(NF-2) = $$(NF-2) + 1;} 1' | sed 's/ /./g' | awk -F. '{$$(NF-1) = 0;} 1' | sed 's/ /./g' | awk -F. '{$$(NF) = 0;} 1' | sed 's/ /./g' `\"" > ${PROJECT}/__init__.py
release-major: test _release-major git-release current-version
release: release-patch

22
Pipfile Normal file
View File

@ -0,0 +1,22 @@
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"
[packages]
container-app-conf = ">=5.0.0"
evdev = "*"
orjson = ">=3,<4"
aiohttp = "*"
asyncio-mqtt = "*"
prometheus-client = "*"
prometheus_async = "*"
click = "*"
[dev-packages]
pytest = "*"
pytest-aiohttp = "*"
pytest-mock = "*"
[requires]
python_version = "3"

1004
Pipfile.lock generated Normal file
View File

File diff suppressed because it is too large Load Diff

236
README.md Normal file
View File

@ -0,0 +1,236 @@
# barcode-server [![Code Climate](https://codeclimate.com/github/markusressel/barcode-server.svg)](https://codeclimate.com/github/markusressel/barcode-server)
A simple daemon to read barcodes from USB Barcode Scanners
and expose them to other service using HTTP calls, a websocket API or MQTT.
[![asciicast](https://asciinema.org/a/366004.svg)](https://asciinema.org/a/366004)
# Features
* [x] Autodetect Barcode Scanner devices on the fly
* [x] Request Server information via [REST API](#rest-api)
* [x] Subscribe to barcode events using
* [x] [Websocket API](#websocket-api)
* [x] Push barcode events using
* [x] [HTTP requests](#http-request)
* [x] [MQTT messages](#mqtt-publish)
* [x] Get [statistics](#statistics) via Prometheus exporter
# How to use
## Device Access Permissions
Ensure the user running this application is in the correct group for accessing
input devices (usually `input`), like this:
```
sudo usermod -a -G input myusername
```
## Configuration
**barcode-server** uses [container-app-conf](https://github.com/markusressel/container-app-conf)
to provide configuration via a YAML or TOML file as well as ENV variables. Have a look at the
[documentation about it](https://github.com/markusressel/container-app-conf).
The config file is searched for in the following locations (in this order):
* `./`
* `~/.config/`
* `~/`
See [barcode_server.yaml](/barcode_server.yaml) for an example in this repo.
## Native
```
# create venv
python -m venv ./venv
# enter venv
source ./venv/bin/activate
# install barcode-server
pip install barcode-server
# exit venv
deactivate
# print config
./venv/bin/barcode-server config
# launch application
./venv/bin/barcode-server run
```
## Docker
When starting the docker container, make sure to pass through input devices:
```
docker run -it \
--name barcode \
--device=/dev/input \
-v "/home/markus/.config/barcode_server.yaml:/app/barcode_server.yaml" \
-e PUID=0 \
-e PGID=0 \
markusressel/barcode-server
```
**Note:** Although **barcode-server** will continuously try to detect new devices,
even when passing through `/dev/input` like shown above, new devices can not be detected
due to the way docker works. If you need to detect devices in real-time, you have to use
the native approach.
You can specify the user id and group id using the `PUID` and `PGID` environment variables.
# Webserver
By default the webserver will listen to `127.0.0.1` on port `9654`.
## Authorization
When specified in the config, an API token is required to authorize clients, which must
be passed using a `X-Auth-Token` header when connecting. Since barcode-scanner doesn't rely on any
persistence, the token is specified in the configuration file and can not be changed on runtime.
## Rest API
**barcode-server** provides a simple REST API to get some basic information.
This API can **not** be used to retrieve barcode events. To do that you have to use one of
the approaches described below.
| Endpoint | Description |
|------------|-------------------------------------------|
| `/devices` | A list of all currently detected devices. |
## Websocket API
In addition to the REST API **barcode-server** also exposes a websocket at `/`, which can be used
to get realtime barcode scan events.
To connect to it, you have to provide
* a `Client-ID` header with a UUID (v4)
* (optional) an empty `Drop-Event-Queue` header, to ignore events that happened between connections
* (optional) an `X-Auth-Token` header, to authorize the client
Messages received on this websocket are JSON formatted strings with the following format:
```json
{
"id": "33cb5677-3d0b-4faf-9dc4-d19a8ee7d8a1",
"serverId": "cash-register-1",
"date": "2020-08-03T10:00:00+00:00",
"device": {
"name": "BARCODE SCANNER BARCODE SCANNER",
"path": "/dev/input/event3",
"vendorId": "ffff",
"productId": "0035",
},
"barcode": "4250168519463"
}
```
To test the connection you can use f.ex. `websocat`:
```
> websocat - autoreconnect:ws://127.0.0.1:9654 --text --header "Client-ID:dc1f14fc-a7a6-4102-af60-2b6e0dcf744c" --header "Drop-Event-Queue:" --header "X-Auth-Token:EmUSqjXGfnQwn5wn6CpzJRZgoazMTRbMNgH7CXwkQG7Ph7stex"
{"date":"2020-12-20T19:35:04.769739","device":{"name":"BARCODE SCANNER BARCODE SCANNER","path":"/dev/input/event3","vendorId":65535,"productId":53},"barcode":"D-t38409355843o52230Lm54784"}
{"date":"2020-12-20T19:35:06.237408","device":{"name":"BARCODE SCANNER BARCODE SCANNER","path":"/dev/input/event3","vendorId":65535,"productId":53},"barcode":"4250168519463"}
```
## HTTP Request
When configured, you can let **barcode-scanner** issue a HTTP request (defaults to `POST`) when a
barcode is scanned, which provides the ability to push barcode events to a server that is unaware
of any client. The body of the request will contain the same JSON as in the websocket API example.
To do this simply add the following section to your config:
```yaml
barcode_server:
[...]
http:
url: "https://my.domain.com/barcode"
```
Have a look at the [example config](barcode_server.yaml) for more options.
## MQTT Publish
When configured, you can let **barcode-scanner** publish barcode events to a MQTT broker.
The payload of the message will contain the same JSON as in the websocket API example.
To do this simply add the following section to your config:
```yaml
barcode_server:
[...]
mqtt:
host: "my.mqtt.broker"
```
Have a look at the [example config](barcode_server.yaml) for more options.
## Statistics
**barcode-server** exposes a prometheus exporter (defaults to port `8000`) to give some statistical insight.
A brief overview of (most) available metrics:
| Name | Type | Description |
|------|------|-------------|
| websocket_client_count | Gauge | Number of currently connected websocket clients |
| devices_count | Gauge | Number of currently detected devices |
| scan_count | Gauge | Number of times a scan has been detected |
| device_detection_processing_seconds | Summary | Time spent detecting devices |
| rest_endpoint_processing_seconds | Summary | Time spent in a rest command handler |
| notifier_processing_seconds | Summary | Time spent in a notifier |
# FAQ
## Can I lock the Barcode Scanner to this application?
Yes. Most barcode readers normally work like a keyboard, resulting in their input being evaluated by
the system, which can clutter up your TTY or other open programs.
**barcode-server** will try to _grab_ input devices, making it the sole recipient of all
incoming input events from those devices, which should prevent the device from cluttering
your TTY.
If, for some reason, this does not work for you, try this:
Create a file `/etc/udev/rules.d/10-barcode.rules`:
```
SUBSYSTEM=="input", ACTION=="add", ATTRS{idVendor}=="xxxx", ATTRS{idProduct}=="yyyy", RUN+="/bin/sh -c 'echo remove > /sys$env{DEVPATH}/uevent'"
SUBSYSTEM=="input", ACTION=="add", ATTRS{idVendor}=="xxxx", ATTRS{idProduct}=="yyyy", DEVPATH=="*:1.0/*", KERNEL=="event*", RUN+="/bin/sh -c 'ln -sf /dev/input/$kernel /dev/input/barcode_scanner'"
```
Replace the `idVendor` and `idProduct` values with the values of your barcode reader (a 4 digit hex value with leading zeros).
You can find them in the log output of **barcode-reader** or using `lsusb` with the wireless receiver attached to your computer.
Reload udev rules using:
```
udevadm control --reload
```
then remove and reinsert the wireless receiver.
You should now have a symlink in `/dev/input/barcode_scanner`:
```
ls -lha /dev/input/barcode_scanner
```
which can be used in the `device_paths` section of the **barcode-server** config.
Source: [This](https://serverfault.com/questions/385260/bind-usb-keyboard-exclusively-to-specific-application/976557#976557)
and [That](https://stackoverflow.com/questions/63478999/how-to-make-linux-ignore-a-keyboard-while-keeping-it-available-for-my-program-to/63531743#63531743)
# Contributing
GitHub is for social coding: if you want to write code, I encourage contributions
through pull requests from forks of this repository. Create GitHub tickets for
bugs and new features and comment on the ones that you are interested in.
# License
```text
barcode-server 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/>.
```

63
barcode_server.yaml Normal file
View File

@ -0,0 +1,63 @@
barcode_server:
# (optional) the verbosity level of log output
log_level: DEBUG
# (optional) an identifier for this barcode-server instance
# if omitted, this will be a UUIDv4
id: cash-register-1
# (optional) server configuration
server:
# (optional) the IP address to listen on for incoming connections
host: "127.0.0.1"
# (optional) the Port to listen on
port: 9654
# (optional) API-Token which has to be provided by connecting clients
api_token: "EmUSqjXGfnQwn5wn6CpzJRZgoazMTRbMNgH7CXwkQG7Ph7stex"
# (optional) Time period to retry delivering failed queued events before giving up and dropping the event
drop_event_queue_after: 2h
# (optional) Time to wait between retries
retry_interval: 2s
# (optional) HTTP push configuration
http:
# URL to send events to using a request
url: "http://dummy.restapiexample.com/api/v1/create"
# The request method to use
method: POST
# Headers to set on each request
headers:
- "X-Auth-Token: MY_HEADERS"
# (optional) MQTT push configuration
mqtt:
# MQTT server host address
host: "mqtt.mydomain.com"
# (optional) MQTT server port
port: 1883
# (optional) Client ID of this barcode-server instance to provide to the MQTT server
client_id: "barcode-server"
# MQTT topic to push events to
topic: "barcode-server/barcode"
# Username to use when connecting to the MQTT server
user: "myuser"
# Password to use when connecting to the MQTT server
password: "mypassword"
# (optional) QoS value of event messages
qos: 2
# (optional) Whether to instruct the MQTT server to remember event messages between restarts (of the MQTT server)
retain: True
# A list of regex patterns to match USB device names against
devices:
- ".*Barcode.*"
# A list of absolute file paths to devices
device_paths:
#- "/dev/input/barcode_scanner"
# (optional) Statistics configuration
stats:
# (optional) port to provide statistics on
port: 8000

1
barcode_server/__init__.py Normal file
View File

@ -0,0 +1 @@
__version__ = "2.3.0"

170
barcode_server/barcode.py Normal file
View File

@ -0,0 +1,170 @@
import asyncio
import logging
import uuid
from datetime import datetime
from pathlib import Path
from typing import List, Dict
import evdev
from evdev import *
from barcode_server.config import AppConfig
from barcode_server.keyevent_reader import KeyEventReader
from barcode_server.stats import SCAN_COUNT, DEVICES_COUNT, DEVICE_DETECTION_TIME
LOGGER = logging.getLogger(__name__)
class BarcodeEvent:
def __init__(self, input_device: InputDevice, barcode: str, date: datetime = None):
self.id = str(uuid.uuid4())
self.date = date if date is not None else datetime.now()
self.device = input_device
self.input_device = self.device
self.barcode = barcode
class BarcodeReader:
"""
Reads barcodes from all USB barcode scanners in the system
"""
def __init__(self, config: AppConfig):
self.config = config
self.devices = {}
self.listeners = set()
self._keyevent_reader = KeyEventReader()
self._main_task = None
self._device_tasks = {}
async def start(self):
"""
Start detecting and reading barcode scanner devices
"""
self._main_task = asyncio.create_task(self._detect_and_read())
async def stop(self):
"""
Stop detecting and reading barcode scanner devices
"""
if self._main_task is None:
return
for device_path, t in self._device_tasks.items():
t.cancel()
self._device_tasks.clear()
self._main_task.cancel()
self._main_task = None
async def _detect_and_read(self):
"""
Detect barcode scanner devices and start readers for them
"""
while True:
try:
self.devices = self._find_devices(self.config.DEVICE_PATTERNS.value, self.config.DEVICE_PATHS.value)
DEVICES_COUNT.set(len(self.devices))
for path, d in self.devices.items():
if path in self._device_tasks:
continue
LOGGER.info(
f"Reading: {d.path}: Name: {d.name}, "
f"Vendor: {d.info.vendor:04x}, Product: {d.info.product:04x}")
task = asyncio.create_task(self._start_reader(d))
self._device_tasks[path] = task
await asyncio.sleep(1)
except Exception as e:
logging.exception(e)
await asyncio.sleep(10)
async def _start_reader(self, input_device):
"""
Start a reader for a specific device
:param input_device: the input device
"""
try:
# become the sole recipient of all incoming input events
input_device.grab()
while True:
barcode = await self._read_line(input_device)
if barcode is not None and len(barcode) > 0:
event = BarcodeEvent(input_device, barcode)
asyncio.create_task(self._notify_listeners(event))
except Exception as e:
LOGGER.exception(e)
self._device_tasks.pop(input_device.path)
finally:
try:
# release device
input_device.ungrab()
except Exception as e:
pass
@staticmethod
@DEVICE_DETECTION_TIME.time()
def _find_devices(patterns: List, paths: List[str]) -> Dict[str, InputDevice]:
"""
# Finds the input device with the name ".*Barcode Reader.*".
# Could and should be parameterized, of course. Device name as cmd line parameter, perhaps?
:param patterns: list of patterns to match the device name against
:return: Map of ("Device Path" -> InputDevice) items
"""
result = {}
# find devices
devices = evdev.list_devices()
# create InputDevice instances
devices = [evdev.InputDevice(fn) for fn in devices]
# filter by device name
devices = list(filter(lambda d: any(map(lambda y: y.match(d.name), patterns)), devices))
# add manually defined paths
for path in paths:
try:
if Path(path).exists():
devices.append(evdev.InputDevice(path))
else:
logging.warning(f"Path doesn't exist: {path}")
except Exception as e:
logging.exception(e)
for d in devices:
result[d.path] = d
return result
async def _read_line(self, input_device: InputDevice) -> str or None:
"""
Read a single line (ENTER stops input) from the given device
:param input_device: the device to listen on
:return: a barcode
"""
# Using a thread executor here is a workaround for
# input_device.async_read_loop() skipping input events sometimes,
# so we use a synchronous method instead.
# While not perfect, it has a much higher success rate.
loop = asyncio.get_event_loop()
result = await loop.run_in_executor(None, self._keyevent_reader.read_line, input_device)
return result
def add_listener(self, listener: callable):
"""
Add a barcode event listener
:param listener: async callable taking two arguments
"""
self.listeners.add(listener)
async def _notify_listeners(self, event: BarcodeEvent):
"""
Notifies all listeners about the scanned barcode
:param event: barcode event
"""
SCAN_COUNT.inc()
LOGGER.info(f"{event.input_device.name} ({event.input_device.path}): {event.barcode}")
for listener in self.listeners:
asyncio.create_task(listener(event))

94
barcode_server/cli.py Normal file
View File

@ -0,0 +1,94 @@
import asyncio
import logging
import os
import signal
import sys
import click
from container_app_conf.formatter.toml import TomlFormatter
from prometheus_client import start_http_server
parent_dir = os.path.abspath(os.path.join(os.path.abspath(__file__), "..", ".."))
sys.path.append(parent_dir)
logging.basicConfig(level=logging.WARNING, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
LOGGER = logging.getLogger(__name__)
loop = asyncio.get_event_loop()
def signal_handler(signal=None, frame=None):
LOGGER.info("Exiting...")
os._exit(0)
CMD_OPTION_NAMES = {
}
CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
@click.group(context_settings=CONTEXT_SETTINGS)
@click.version_option()
def cli():
pass
def get_option_names(parameter: str) -> list:
"""
Returns a list of all valid console parameter names for a given parameter
:param parameter: the parameter to check
:return: a list of all valid names to use this parameter
"""
return CMD_OPTION_NAMES[parameter]
@cli.command(name="run")
def c_run():
"""
Run the barcode-server
"""
from barcode_server.barcode import BarcodeReader
from barcode_server.config import AppConfig
from barcode_server.webserver import Webserver
signal.signal(signal.SIGINT, signal_handler)
config = AppConfig()
log_level = logging._nameToLevel.get(str(config.LOG_LEVEL.value).upper(), config.LOG_LEVEL.default)
LOGGER = logging.getLogger("barcode_server")
LOGGER.setLevel(log_level)
LOGGER.info("=== barcode-server ===")
LOGGER.info(f"Instance ID: {config.INSTANCE_ID.value}")
barcode_reader = BarcodeReader(config)
webserver = Webserver(config, barcode_reader)
# start prometheus server
if config.STATS_PORT.value is not None:
LOGGER.info("Starting statistics webserver...")
start_http_server(config.STATS_PORT.value)
tasks = asyncio.gather(
webserver.start(),
)
loop.run_until_complete(tasks)
loop.run_forever()
@cli.command(name="config")
def c_config():
"""
Print the current configuration of barcode-server
"""
from barcode_server.config import AppConfig
config = AppConfig()
click.echo(config.print(TomlFormatter()))
if __name__ == '__main__':
cli()

250
barcode_server/config.py Normal file
View File

@ -0,0 +1,250 @@
# Copyright (c) 2019 Markus Ressel
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import logging
import re
import uuid
from container_app_conf import ConfigBase
from container_app_conf.entry.bool import BoolConfigEntry
from container_app_conf.entry.file import FileConfigEntry
from container_app_conf.entry.int import IntConfigEntry
from container_app_conf.entry.list import ListConfigEntry
from container_app_conf.entry.regex import RegexConfigEntry
from container_app_conf.entry.string import StringConfigEntry
from container_app_conf.entry.timedelta import TimeDeltaConfigEntry
from container_app_conf.source.env_source import EnvSource
from container_app_conf.source.toml_source import TomlSource
from container_app_conf.source.yaml_source import YamlSource
from py_range_parse import Range
from barcode_server.const import *
class AppConfig(ConfigBase):
def __new__(cls, *args, **kwargs):
yaml_source = YamlSource(CONFIG_NODE_ROOT)
toml_source = TomlSource(CONFIG_NODE_ROOT)
data_sources = [
EnvSource(),
yaml_source,
toml_source,
]
return super(AppConfig, cls).__new__(cls, data_sources=data_sources)
LOG_LEVEL = StringConfigEntry(
description="Log level",
key_path=[
CONFIG_NODE_ROOT,
"log_level"
],
regex=re.compile(f" {'|'.join(logging._nameToLevel.keys())}", flags=re.IGNORECASE),
default="INFO",
)
INSTANCE_ID = StringConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
"id"
],
regex=re.compile("[0-9a-zA-Z\.\_\-\+\/\#]+"),
default=str(uuid.uuid4()),
required=True
)
SERVER_HOST = StringConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_SERVER,
"host"
],
default=DEFAULT_SERVER_HOST,
secret=True)
SERVER_PORT = IntConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_SERVER,
CONFIG_NODE_PORT
],
range=Range(1, 65534),
default=DEFAULT_SERVER_PORT)
SERVER_API_TOKEN = StringConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_SERVER,
"api_token"
],
default=None,
secret=True
)
DROP_EVENT_QUEUE_AFTER = TimeDeltaConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
"drop_event_queue_after"
],
default="2h",
)
RETRY_INTERVAL = TimeDeltaConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
"retry_interval"
],
default="2s",
)
HTTP_METHOD = StringConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_HTTP,
"method"
],
required=True,
default="POST",
regex="GET|POST|PUT|PATCH"
)
HTTP_URL = StringConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_HTTP,
"url"
],
required=False
)
HTTP_HEADERS = ListConfigEntry(
item_type=StringConfigEntry,
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_HTTP,
"headers"
],
default=[]
)
MQTT_HOST = StringConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_MQTT,
"host"
],
required=False
)
MQTT_PORT = IntConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_MQTT,
"port"
],
required=True,
default=1883,
range=Range(1, 65534),
)
MQTT_CLIENT_ID = StringConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_MQTT,
"client_id"
],
default="barcode-server"
)
MQTT_USER = StringConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_MQTT,
"user"
]
)
MQTT_PASSWORD = StringConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_MQTT,
"password"
],
secret=True
)
MQTT_TOPIC = StringConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_MQTT,
"topic"
],
default="barcode-server/barcode",
required=True
)
MQTT_QOS = IntConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_MQTT,
"qos"
],
default=2,
required=True
)
MQTT_RETAIN = BoolConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_MQTT,
"retain"
],
default=False,
required=True
)
DEVICE_PATTERNS = ListConfigEntry(
item_type=RegexConfigEntry,
item_args={
"flags": re.IGNORECASE
},
key_path=[
CONFIG_NODE_ROOT,
"devices"
],
default=[]
)
DEVICE_PATHS = ListConfigEntry(
item_type=FileConfigEntry,
key_path=[
CONFIG_NODE_ROOT,
"device_paths"
],
default=[]
)
STATS_PORT = IntConfigEntry(
key_path=[
CONFIG_NODE_ROOT,
CONFIG_NODE_STATS,
CONFIG_NODE_PORT
],
default=8000,
required=False
)
def validate(self):
super(AppConfig, self).validate()
if len(self.DEVICE_PATHS.value) == len(self.DEVICE_PATTERNS.value) == 0:
raise AssertionError("You must provide at least one device pattern or device_path!")

32
barcode_server/const.py Normal file
View File

@ -0,0 +1,32 @@
# Copyright (c) 2019 Markus Ressel
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
Client_Id = "Client-ID"
Drop_Event_Queue = "Drop-Event-Queue"
X_Auth_Token = "X-Auth-Token"
CONFIG_NODE_ROOT = "barcode_server"
CONFIG_NODE_SERVER = "server"
CONFIG_NODE_HTTP = "http"
CONFIG_NODE_MQTT = "mqtt"
CONFIG_NODE_STATS = "stats"
CONFIG_NODE_PORT = "port"
DEFAULT_SERVER_HOST = "127.0.0.1"
DEFAULT_SERVER_PORT = 9654
ENDPOINT_DEVICES = "devices"

198
barcode_server/keyevent_reader.py Normal file
View File

@ -0,0 +1,198 @@
import logging
from evdev import KeyEvent, InputDevice, categorize
LOGGER = logging.getLogger(__name__)
US_EN_UPPER_DICT = {
"`": "~",
"1": "!",
"2": "@",
"3": "#",
"4": "$",
"5": "%",
"6": "^",
"7": "&",
"8": "*",
"9": "(",
"0": ")",
"-": "_",
"=": "+",
",": "<",
".": ">",
"/": "?",
";": ":",
"'": "\"",
"\\": "|",
"[": "{",
"]": "}"
}
class KeyEventReader:
"""
Class used to convert a sequence of KeyEvents to text
"""
def __init__(self):
self._shift = False
self._caps = False
self._alt = False
self._unicode_number_input_buffer = ""
self._line = ""
def read_line(self, input_device: InputDevice) -> str:
"""
Reads a line
:param input_device: the device to read from
:return: line
"""
self._line = ""
# While there is a function called async_read_loop, it tends
# to skip input events, so we use the non-async read-loop here.
# async for event in input_device.async_read_loop():
for event in input_device.read_loop():
try:
event = categorize(event)
if hasattr(event, "event"):
if not hasattr(event, "keystate") and hasattr(event.event, "keystate"):
event.keystate = event.event.keystate
if not hasattr(event, "keystate") or not hasattr(event, "keycode"):
continue
keycode = event.keycode
keystate = event.keystate
if isinstance(event, KeyEvent):
if self._on_key_event(keycode, keystate):
return self._line
elif hasattr(event, "event") and event.event.type == 1:
if self._on_key_event(keycode, keystate):
return self._line
except Exception as ex:
LOGGER.exception(ex)
def _on_key_event(self, code: str, state: int) -> bool:
if code in ["KEY_ENTER", "KEY_KPENTER"]:
if state == KeyEvent.key_up:
# line is finished
self._reset_modifiers()
return True
elif code in ["KEY_RIGHTSHIFT", "KEY_LEFTSHIFT"]:
if state in [KeyEvent.key_down, KeyEvent.key_hold]:
self._shift = True
else:
self._shift = False
elif code in ["KEY_LEFTALT", "KEY_RIGHTALT"]:
if state in [KeyEvent.key_down, KeyEvent.key_hold]:
self._alt = True
else:
self._alt = False
character = self._unicode_numbers_to_character(self._unicode_number_input_buffer)
self._unicode_number_input_buffer = ""
if character is not None:
self._line += character
elif code == "KEY_BACKSPACE":
self._line = self._line[:-1]
elif state == KeyEvent.key_down:
character = self._code_to_character(code)
if self._alt:
self._unicode_number_input_buffer += character
else:
if character is not None and not self._alt:
# append the current character
self._line += character
return False
def _code_to_character(self, code: str) -> chr or None:
character = None
if len(code) == 5:
character = code[-1]
elif code.startswith("KEY_KP") and len(code) == 7:
character = code[-1]
elif code in ["KEY_DOWN"]:
character = '\n'
elif code in ["KEY_SPACE"]:
character = ' '
elif code in ["KEY_ASTERISK", "KEY_KPASTERISK"]:
character = '*'
elif code in ["KEY_MINUS", "KEY_KPMINUS"]:
character = '-'
elif code in ["KEY_PLUS", "KEY_KPPLUS"]:
character = '+'
elif code in ["KEY_QUESTION"]:
character = '?'
elif code in ["KEY_COMMA", "KEY_KPCOMMA"]:
character = ','
elif code in ["KEY_DOT", "KEY_KPDOT"]:
character = '.'
elif code in ["KEY_EQUAL", "KEY_KPEQUAL"]:
character = '='
elif code in ["KEY_LEFTPAREN", "KEY_KPLEFTPAREN"]:
character = '('
elif code in ["KEY_PLUSMINUS", "KEY_KPPLUSMINUS"]:
character = '+-'
elif code in ["KEY_RIGHTPAREN", "KEY_KPRIGHTPAREN"]:
character = ')'
elif code in ["KEY_RIGHTBRACE"]:
character = ']'
elif code in ["KEY_LEFTBRACE"]:
character = '['
elif code in ["KEY_SLASH", "KEY_KPSLASH"]:
character = '/'
elif code in ["KEY_BACKSLASH"]:
character = '\\'
elif code in ["KEY_COLON"]:
character = ';'
elif code in ["KEY_SEMICOLON"]:
character = ';'
elif code in ["KEY_APOSTROPHE"]:
character = '\''
elif code in ["KEY_GRAVE"]:
character = '`'
if character is None:
character = code[4:]
if len(character) > 1:
LOGGER.warning(f"Unhandled Keycode: {code}")
if self._shift or self._caps:
character = character.upper()
if character in US_EN_UPPER_DICT.keys():
character = US_EN_UPPER_DICT[character]
else:
character = character.lower()
return character
@staticmethod
def _unicode_numbers_to_character(code: str) -> chr or None:
if code is None or len(code) <= 0:
return None
try:
# convert to hex
i = int(code)
h = hex(i)
s = f"{h}"
return bytearray.fromhex(s[2:]).decode('utf-8')
except Exception as ex:
LOGGER.exception(ex)
return None
def _reset_modifiers(self):
self._alt = False
self._unicode_number_input_buffer = ""
self._shift = False
self._caps = False

103
barcode_server/notifier/__init__.py Normal file
View File

@ -0,0 +1,103 @@
import asyncio
import logging
from asyncio import Task, QueueEmpty
from datetime import datetime
from typing import Optional
from barcode_server.barcode import BarcodeEvent
from barcode_server.config import AppConfig
LOGGER = logging.getLogger(__name__)
class BarcodeNotifier:
"""
Base class for a notifier.
"""
def __init__(self):
self.config = AppConfig()
self.drop_event_queue_after = self.config.DROP_EVENT_QUEUE_AFTER.value
self.retry_interval = self.config.RETRY_INTERVAL.value
self.event_queue = asyncio.Queue()
self.processor_task: Optional[Task] = None
def is_running(self) -> bool:
return self.processor_task is not None
async def start(self):
"""
Starts the event processor of this notifier
"""
self.processor_task = asyncio.create_task(self.event_processor())
async def stop(self):
"""
Stops the event processor of this notifier
"""
if self.processor_task is None:
return
self.processor_task.cancel()
self.processor_task = None
async def drop_queue(self):
"""
Drops all items in the event queue
"""
running = self.is_running()
# stop if currently running
if running:
await self.stop()
# mark all items as finished
for _ in range(self.event_queue.qsize()):
try:
self.event_queue.get_nowait()
self.event_queue.task_done()
except QueueEmpty as ex:
break
# restart if it was running
if running:
await self.start()
async def event_processor(self):
"""
Processes the event queue
"""
while True:
try:
event = await self.event_queue.get()
success = False
while not success:
if datetime.now() - event.date >= self.drop_event_queue_after:
# event is older than threshold, so we just skip it
self.event_queue.task_done()
break
try:
await self._send_event(event)
success = True
self.event_queue.task_done()
except Exception as ex:
LOGGER.exception(ex)
await asyncio.sleep(self.retry_interval.total_seconds())
except Exception as ex:
LOGGER.exception(ex)
async def add_event(self, event: BarcodeEvent):
"""
Adds an event to the event queue
"""
await self.event_queue.put(event)
async def _send_event(self, event: BarcodeEvent):
"""
Sends the given event to the notification target
:param event: barcode event
"""
raise NotImplementedError()

30
barcode_server/notifier/http.py Normal file
View File

@ -0,0 +1,30 @@
import logging
from typing import List
import aiohttp
from prometheus_async.aio import time
from barcode_server.barcode import BarcodeEvent
from barcode_server.notifier import BarcodeNotifier
from barcode_server.stats import HTTP_NOTIFIER_TIME
from barcode_server.util import barcode_event_to_json
LOGGER = logging.getLogger(__name__)
class HttpNotifier(BarcodeNotifier):
def __init__(self, method: str, url: str, headers: List[str]):
super().__init__()
self.method = method
self.url = url
headers = list(map(lambda x: tuple(x.split(':', 1)), headers))
self.headers = list(map(lambda x: (x[0].strip(), x[1].strip()), headers))
@time(HTTP_NOTIFIER_TIME)
async def _send_event(self, event: BarcodeEvent):
json = barcode_event_to_json(self.config.INSTANCE_ID.value, event)
async with aiohttp.ClientSession() as session:
async with session.request(self.method, self.url, headers=self.headers, data=json) as resp:
resp.raise_for_status()
LOGGER.debug(f"Notified {self.url}: {event.barcode}")

38
barcode_server/notifier/mqtt.py Normal file
View File

@ -0,0 +1,38 @@
import logging
from asyncio_mqtt import Client
from prometheus_async.aio import time
from barcode_server.barcode import BarcodeEvent
from barcode_server.notifier import BarcodeNotifier
from barcode_server.stats import MQTT_NOTIFIER_TIME
from barcode_server.util import barcode_event_to_json
LOGGER = logging.getLogger(__name__)
class MQTTNotifier(BarcodeNotifier):
def __init__(self, host: str, port: int = 1883,
topic: str = "/barcode-server/barcode",
client_id: str = "barcode-server",
user: str = None, password: str = None,
qos: int = 2, retain: bool = False):
super().__init__()
self.client_id = client_id
self.host = host
self.port = port
self.user = user
self.password = password
self.topic = topic
self.qos = qos
self.retain = retain
@time(MQTT_NOTIFIER_TIME)
async def _send_event(self, event: BarcodeEvent):
json = barcode_event_to_json(self.config.INSTANCE_ID.value, event)
async with Client(hostname=self.host, port=self.port,
username=self.user, password=self.password,
client_id=self.client_id) as client:
await client.publish(self.topic, json, self.qos, self.retain)
LOGGER.debug(f"Notified {self.host}:{self.port}: {event.barcode}")

23
barcode_server/notifier/ws.py Normal file
View File

@ -0,0 +1,23 @@
from prometheus_async.aio import time
from barcode_server.barcode import BarcodeEvent
from barcode_server.notifier import BarcodeNotifier
from barcode_server.stats import WEBSOCKET_NOTIFIER_TIME
from barcode_server.util import barcode_event_to_json
class WebsocketNotifier(BarcodeNotifier):
def __init__(self, websocket):
super().__init__()
self.websocket = websocket
@time(WEBSOCKET_NOTIFIER_TIME)
async def _send_event(self, event: BarcodeEvent):
json = barcode_event_to_json(self.config.INSTANCE_ID.value, event)
await self.websocket.send_bytes(json)
# TODO: cant log websocket address here because we don't have access
# to an unique identifier anymore, maybe we need to store one manually
# when the websocket is connected initially...
# LOGGER.debug(f"Notified {client.remote_address}")

28
barcode_server/stats.py Normal file
View File

@ -0,0 +1,28 @@
from prometheus_client import Gauge, Summary
from barcode_server.const import *
WEBSOCKET_CLIENT_COUNT = Gauge(
'websocket_client_count',
'Number of currently connected websocket clients'
)
DEVICES_COUNT = Gauge(
'devices_count',
'Number of currently detected devices'
)
SCAN_COUNT = Gauge(
'scan_count',
'Number of times a scan has been detected'
)
DEVICE_DETECTION_TIME = Summary('device_detection_processing_seconds', 'Time spent detecting devices')
REST_TIME = Summary('rest_endpoint_processing_seconds', 'Time spent in a rest command handler', ['endpoint'])
REST_TIME_DEVICES = REST_TIME.labels(endpoint=ENDPOINT_DEVICES)
NOTIFIER_TIME = Summary('notifier_processing_seconds', 'Time spent in a notifier', ['type'])
WEBSOCKET_NOTIFIER_TIME = NOTIFIER_TIME.labels(type='websocket')
HTTP_NOTIFIER_TIME = NOTIFIER_TIME.labels(type='http')
MQTT_NOTIFIER_TIME = NOTIFIER_TIME.labels(type='mqtt')

38
barcode_server/util.py Normal file
View File

@ -0,0 +1,38 @@
from evdev import InputDevice
from barcode_server.barcode import BarcodeEvent
def input_device_to_dict(input_device: InputDevice) -> dict:
"""
Converts an input device to a a dictionary with human readable values
:param input_device: the device to convert
:return: dictionary
"""
return {
"name": input_device.name,
"path": input_device.path,
"vendorId": f"{input_device.info.vendor: 04x}",
"productId": f"{input_device.info.product: 04x}",
}
def barcode_event_to_json(server_id: str, event: BarcodeEvent) -> bytes:
"""
Converts a barcode event to json
:param server_id: server instance id
:param event: the event to convert
:return: json representation
"""
import orjson
event = {
"id": event.id,
"serverId": server_id,
"date": event.date.isoformat(),
"device": input_device_to_dict(event.input_device),
"barcode": event.barcode
}
json = orjson.dumps(event)
return json

180
barcode_server/webserver.py Normal file
View File

@ -0,0 +1,180 @@
import asyncio
import logging
from typing import Dict
import aiohttp
from aiohttp import web
from aiohttp.web_middlewares import middleware
from prometheus_async.aio import time
from barcode_server.barcode import BarcodeReader, BarcodeEvent
from barcode_server.config import AppConfig
from barcode_server.const import *
from barcode_server.notifier import BarcodeNotifier
from barcode_server.notifier.http import HttpNotifier
from barcode_server.notifier.mqtt import MQTTNotifier
from barcode_server.notifier.ws import WebsocketNotifier
from barcode_server.stats import REST_TIME_DEVICES, WEBSOCKET_CLIENT_COUNT
from barcode_server.util import input_device_to_dict
LOGGER = logging.getLogger(__name__)
routes = web.RouteTableDef()
class Webserver:
def __init__(self, config: AppConfig, barcode_reader: BarcodeReader):
self.config = config
self.host = config.SERVER_HOST.value
self.port = config.SERVER_PORT.value
self.clients = {}
self.barcode_reader = barcode_reader
self.barcode_reader.add_listener(self.on_barcode)
self.notifiers: Dict[str, BarcodeNotifier] = {}
if config.HTTP_URL.value is not None:
http_notifier = HttpNotifier(
config.HTTP_METHOD.value,
config.HTTP_URL.value,
config.HTTP_HEADERS.value)
self.notifiers["http"] = http_notifier
if config.MQTT_HOST.value is not None:
mqtt_notifier = MQTTNotifier(
host=config.MQTT_HOST.value,
port=config.MQTT_PORT.value,
client_id=config.MQTT_CLIENT_ID.value,
user=config.MQTT_USER.value,
password=config.MQTT_PASSWORD.value,
topic=config.MQTT_TOPIC.value,
qos=config.MQTT_QOS.value,
retain=config.MQTT_RETAIN.value,
)
self.notifiers["mqtt"] = mqtt_notifier
async def start(self):
# start detecting and reading barcode scanners
await self.barcode_reader.start()
# start notifier queue processors
for key, notifier in self.notifiers.items():
LOGGER.debug(f"Starting notifier: {key}")
await notifier.start()
LOGGER.info(f"Starting webserver on {self.config.SERVER_HOST.value}:{self.config.SERVER_PORT.value} ...")
app = self.create_app()
runner = aiohttp.web.AppRunner(app)
await runner.setup()
site = aiohttp.web.TCPSite(
runner,
host=self.config.SERVER_HOST.value,
port=self.config.SERVER_PORT.value
)
await site.start()
# wait forever
return await asyncio.Event().wait()
def create_app(self) -> web.Application:
app = web.Application(middlewares=[self.authentication_middleware])
app.add_routes(routes)
return app
@middleware
async def authentication_middleware(self, request, handler):
if self.config.SERVER_API_TOKEN.value is not None and \
(X_Auth_Token not in request.headers.keys()
or request.headers[X_Auth_Token] != self.config.SERVER_API_TOKEN.value):
LOGGER.warning(f"Rejecting unauthorized connection: {request.host}")
return web.HTTPUnauthorized()
if Client_Id not in request.headers.keys():
LOGGER.warning(f"Rejecting client without {Client_Id} header: {request.host}")
return web.HTTPBadRequest()
client_id = request.headers[Client_Id].lower().strip()
if self.clients.get(client_id, None) is not None:
LOGGER.warning(
f"Rejecting new connection of already connected client {request.headers[Client_Id]}: {request.host}")
return web.HTTPBadRequest()
return await handler(self, request)
@routes.get(f"/{ENDPOINT_DEVICES}")
@time(REST_TIME_DEVICES)
async def devices_handle(self, request):
import orjson
device_list = list(map(input_device_to_dict, self.barcode_reader.devices.values()))
json = orjson.dumps(device_list)
return web.Response(body=json, content_type="application/json")
@routes.get("/")
async def websocket_handler(self, request):
client_id = request.headers[Client_Id].lower().strip()
websocket = web.WebSocketResponse()
await websocket.prepare(request)
self.clients[client_id] = websocket
active_client_count = self.count_active_clients()
known_client_ids_count = len(self.clients.keys())
# TODO: report both the mount of currently connected clients, as well as known client ids
WEBSOCKET_CLIENT_COUNT.set(active_client_count)
if client_id not in self.notifiers.keys():
LOGGER.debug(
f"New client connected: {client_id} (from {request.host})")
LOGGER.debug(f"Creating new notifier for client id: {client_id}")
notifier = WebsocketNotifier(websocket)
self.notifiers[client_id] = notifier
else:
LOGGER.debug(
f"Previously seen client reconnected: {client_id} (from {request.host})")
notifier = self.notifiers[client_id]
if isinstance(notifier, WebsocketNotifier):
notifier.websocket = websocket
if Drop_Event_Queue in request.headers.keys():
await notifier.drop_queue()
LOGGER.debug(f"Starting notifier: {client_id}")
await notifier.start()
try:
async for msg in websocket:
if msg.type == aiohttp.WSMsgType.TEXT:
if msg.data.strip() == 'close':
await websocket.close()
else:
await websocket.send_str(msg.data + '/answer')
elif msg.type == aiohttp.WSMsgType.ERROR:
LOGGER.debug('ws connection closed with exception %s' %
websocket.exception())
except Exception as e:
LOGGER.exception(e)
finally:
# TODO: should we remove this notifier after some time?
LOGGER.debug(f"Stopping notifier: {client_id}")
await notifier.stop()
self.clients[client_id] = None
self.clients.pop(client_id)
active_client_count = self.count_active_clients()
WEBSOCKET_CLIENT_COUNT.set(active_client_count)
LOGGER.debug(f"Client disconnected: {client_id} (from {request.host})")
return websocket
async def on_barcode(self, event: BarcodeEvent):
for key, notifier in self.notifiers.items():
await notifier.add_event(event)
def count_active_clients(self):
"""
Counts the number of clients with an active websocket connection
:return: number of active clients
"""
return len(list(filter(lambda x: x[1] is not None, self.clients.items())))

4
docker/entrypoint.sh Normal file
View File

@ -0,0 +1,4 @@
#!/bin/sh
set -eu
sudo -E -u "#${PUID}" -g "#${PGID}" "$@"

72
setup.py Normal file
View File

@ -0,0 +1,72 @@
import os
from setuptools import setup, find_packages
DEVELOPMENT_STATUS = "Development Status :: 5 - Production/Stable"
def read_version(package):
with open(os.path.join(package, '__init__.py'), 'r') as fd:
for line in fd:
if line.startswith('__version__ = '):
return line.split()[-1].strip().strip("'").strip("\"")
def readme_type() -> str:
import os
if os.path.exists("README.rst"):
return "text/x-rst"
if os.path.exists("README.md"):
return "text/markdown"
def readme() -> [str]:
with open('README.md') as f:
return f.read()
def locked_requirements(section):
"""
Look through the 'Pipfile.lock' to fetch requirements by section.
"""
import json
with open('Pipfile.lock') as pip_file:
pipfile_json = json.load(pip_file)
if section not in pipfile_json:
print("{0} section missing from Pipfile.lock".format(section))
return []
return [package + detail.get('version', "")
for package, detail in pipfile_json[section].items()]
setup(
name='barcode-server',
version=read_version("barcode_server"),
description='A simple daemon to expose USB Barcode Scanner data on the network.',
long_description=readme(),
long_description_content_type=readme_type(),
license='GPLv3+',
author='Markus Ressel',
author_email='mail@markusressel.de',
url='https://github.com/markusressel/barcode-server',
packages=find_packages(),
# python_requires='>=3.4',
classifiers=[
DEVELOPMENT_STATUS,
'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9'
],
install_requires=locked_requirements('default'),
tests_require=locked_requirements('develop'),
entry_points={
'console_scripts': [
'barcode-server = barcode_server.cli:cli'
]
}
)

34
tests/__init__.py Normal file
View File

@ -0,0 +1,34 @@
# Copyright (c) 2019 Markus Ressel
# .
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# .
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
# .
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from unittest import IsolatedAsyncioTestCase
class TestBase(IsolatedAsyncioTestCase):
from barcode_server.config import AppConfig
from container_app_conf.source.yaml_source import YamlSource
# load config from test folder
config = AppConfig(
singleton=True,
data_sources=[
YamlSource("barcode_server", "./tests/")
]
)

32
tests/api_test.py Normal file
View File

@ -0,0 +1,32 @@
from datetime import datetime
from unittest.mock import Mock
from barcode_server.barcode import BarcodeEvent
from barcode_server.util import barcode_event_to_json
from tests import TestBase
class ApiTest(TestBase):
def test_json(self):
date_str = "2020-08-03T10:00:00+00:00"
input_device = Mock()
input_device.name = "Barcode Scanner"
input_device.path = "/dev/input/event2"
input_device.info.vendor = 1
input_device.info.product = 2
date = datetime.fromisoformat(str(date_str))
barcode = "4006824000970"
server_id = "server-id"
event = BarcodeEvent(input_device, barcode, date)
event_json = str(barcode_event_to_json(server_id, event))
self.assertIn(event.id, event_json)
self.assertIn(server_id, event_json)
self.assertIn(date_str, event_json)
self.assertIn(input_device.path, event_json)
self.assertIn(barcode, event_json)
self.assertIsNotNone(event_json)

11
tests/barcode_reader_test.py Normal file
View File

@ -0,0 +1,11 @@
from barcode_server.barcode import BarcodeReader
from barcode_server.config import AppConfig
from tests import TestBase
class BarcodeReaderTest(TestBase):
async def test_initialization(self):
config = AppConfig()
reader = BarcodeReader(config)
self.assertIsNotNone(reader)

9
tests/barcode_server.yaml Normal file
View File

@ -0,0 +1,9 @@
barcode_server:
server:
host: "127.0.0.1"
port: 9654
api_token: "EmUSqjXGfnQwn5wn6CpzJRZgoazMTRbMNgH7CXwkQG7Ph7stex"
devices:
- "Barcode/i"
stats:
port:

167
tests/key_event_reader_test.py Normal file
View File

@ -0,0 +1,167 @@
from typing import List
from unittest.mock import Mock
from evdev import InputEvent, ecodes, KeyEvent
from barcode_server.keyevent_reader import KeyEventReader
from tests import TestBase
class KeyEventReaderTest(TestBase):
@staticmethod
def fake_input_loop(input: List[InputEvent]):
input_events = input
def read_loop():
for event in input_events:
yield event
return read_loop
@staticmethod
def mock_input_event(keycode, keystate) -> InputEvent:
input_event = Mock(spec=InputEvent)
input_event.type = 1
input_event.keystate = keystate # 0: UP, 1: Down, 2: Hold
input_event.keycode = keycode
# inverse lookup of the event code in the target structure
code = next(key for key, value in ecodes.keys.items() if value == keycode)
input_event.code = code
return input_event
def generate_input_event_sequence(self, expected: str, finish_line: bool = True) -> List[InputEvent]:
events = []
keycodes = list(map(lambda x: self.character_to_keycode(x), expected))
for item in keycodes:
for keystate in [KeyEvent.key_down, KeyEvent.key_up]:
event = self.mock_input_event(keycode=item, keystate=keystate)
events.append(event)
if finish_line:
for keystate in [KeyEvent.key_down, KeyEvent.key_up]:
event = self.mock_input_event(keycode="KEY_ENTER", keystate=keystate)
events.append(event)
return events
@staticmethod
def character_to_keycode(character: str) -> str:
char_to_keycode_map = {
'0': "KEY_KP0",
'1': "KEY_KP1",
'2': "KEY_KP2",
'3': "KEY_KP3",
'4': "KEY_KP4",
'5': "KEY_KP5",
'6': "KEY_KP6",
'7': "KEY_KP7",
'8': "KEY_KP8",
'9': "KEY_KP9",
'*': "KEY_KPASTERISK",
'/': "KEY_SLASH",
'-': "KEY_KPMINUS",
'+': "KEY_KPPLUS",
'.': "KEY_DOT",
',': "KEY_COMMA",
'?': "KEY_QUESTION",
'\n': "KEY_ENTER",
}
return char_to_keycode_map[character]
def test_mock_gen(self):
# GIVEN
expected = [
self.mock_input_event(keycode="KEY_KPMINUS", keystate=KeyEvent.key_down),
self.mock_input_event(keycode="KEY_KPMINUS", keystate=KeyEvent.key_up),
self.mock_input_event(keycode="KEY_DOT", keystate=KeyEvent.key_down),
self.mock_input_event(keycode="KEY_DOT", keystate=KeyEvent.key_up),
self.mock_input_event(keycode="KEY_KPMINUS", keystate=KeyEvent.key_down),
self.mock_input_event(keycode="KEY_KPMINUS", keystate=KeyEvent.key_up),
self.mock_input_event(keycode="KEY_ENTER", keystate=KeyEvent.key_down),
self.mock_input_event(keycode="KEY_ENTER", keystate=KeyEvent.key_up),
]
text = "-.-"
# WHEN
input_events = self.generate_input_event_sequence(text)
# THEN
self.assertEqual(len(expected), len(input_events))
for i in range(0, len(expected)):
self.assertEqual(expected[i].keycode, input_events[i].keycode)
async def test_numbers(self):
# GIVEN
under_test = KeyEventReader()
expected = "0123456789"
input_events = self.generate_input_event_sequence(expected)
input_device = Mock()
input_device.read_loop = self.fake_input_loop(input_events)
# WHEN
line = under_test.read_line(input_device)
# THEN
self.assertEqual(expected, line)
async def test_special_characters(self):
# GIVEN
under_test = KeyEventReader()
expected = "+.,*/-?"
input_events = self.generate_input_event_sequence(expected)
input_device = Mock()
input_device.read_loop = self.fake_input_loop(input_events)
# WHEN
line = under_test.read_line(input_device)
# THEN
self.assertEqual(expected, line)
async def test_none_event(self):
# GIVEN
under_test = KeyEventReader()
unexpected = "0"
expected = "1"
input_events = self.generate_input_event_sequence(unexpected + expected)
input_events[0] = None
input_events[1] = None
input_device = Mock()
input_device.read_loop = self.fake_input_loop(input_events)
# WHEN
line = under_test.read_line(input_device)
# THEN
self.assertEqual(expected, line)
async def test_event_without_keystate_attribute(self):
# GIVEN
under_test = KeyEventReader()
unexpected = "0"
input_events_without_keystate = self.generate_input_event_sequence(unexpected)
for event in input_events_without_keystate:
delattr(event, "keystate")
expected = "1"
input_events = self.generate_input_event_sequence(expected)
input_events = input_events + input_events_without_keystate
input_device = Mock()
input_device.read_loop = self.fake_input_loop(input_events)
# WHEN
line = under_test.read_line(input_device)
# THEN
self.assertEqual(expected, line)

13
tests/notifier_test.py Normal file
View File

@ -0,0 +1,13 @@
from barcode_server.notifier.http import HttpNotifier
from tests import TestBase
class NotifierTest(TestBase):
def test_http(self):
method = "POST"
url = "test.de"
headers = []
reader = HttpNotifier(method, url, headers)
self.assertIsNotNone(reader)

199
tests/websocket_notifier_test.py Normal file
View File

@ -0,0 +1,199 @@
import asyncio
import random
from unittest.mock import MagicMock
import aiohttp
from aiohttp.test_utils import AioHTTPTestCase, unittest_run_loop
from barcode_server import const
from barcode_server.barcode import BarcodeEvent
from barcode_server.util import barcode_event_to_json
from barcode_server.webserver import Webserver
def create_barcode_event_mock(barcode: str = None):
device = lambda: None
device.info = lambda: None
device.name = "BARCODE SCANNER BARCODE SCANNER"
device.path = "/dev/input/event3"
device.info.vendor = 1
device.info.product = 1
event = BarcodeEvent(
device,
barcode if barcode is not None else f"{random.getrandbits(24)}"
)
return event
class WebsocketNotifierTest(AioHTTPTestCase):
from barcode_server.config import AppConfig
from container_app_conf.source.yaml_source import YamlSource
# load config from test folder
config = AppConfig(
singleton=True,
data_sources=[
YamlSource("barcode_server", "./tests/")
]
)
webserver = None
async def get_application(self):
"""
Override the get_app method to return your application.
"""
barcode_reader = MagicMock()
self.webserver = Webserver(self.config, barcode_reader)
app = self.webserver.create_app()
runner = aiohttp.web.AppRunner(app)
await runner.setup()
site = aiohttp.web.TCPSite(
runner,
host=self.config.SERVER_HOST.value,
port=self.config.SERVER_PORT.value
)
await site.start()
return app
# the unittest_run_loop decorator can be used in tandem with
# the AioHTTPTestCase to simplify running
# tests that are asynchronous
@unittest_run_loop
async def test_ws_connect_and_event(self):
sample_event = create_barcode_event_mock("abcdefg")
server_id = self.config.INSTANCE_ID.value
expected_json = barcode_event_to_json(server_id, sample_event)
import uuid
client_id = str(uuid.uuid4())
async with aiohttp.ClientSession() as session:
async with session.ws_connect(
'http://127.0.0.1:9654/',
headers={
const.Client_Id: client_id,
const.X_Auth_Token: self.config.SERVER_API_TOKEN.value or ""
}) as ws:
asyncio.create_task(self.webserver.on_barcode(sample_event))
async for msg in ws:
if msg.type == aiohttp.WSMsgType.BINARY:
self.assertEqual(expected_json, msg.data)
await ws.close()
return
else:
self.fail("No event received")
assert False
@unittest_run_loop
async def test_ws_reconnect_event_catchup(self):
server_id = self.config.INSTANCE_ID.value
missed_event = create_barcode_event_mock("abcdefg")
second_event = create_barcode_event_mock("123456")
missed_event_json = barcode_event_to_json(server_id, missed_event)
second_event_json = barcode_event_to_json(server_id, second_event)
import uuid
client_id = str(uuid.uuid4())
# connect to the server once
async with aiohttp.ClientSession() as session:
async with session.ws_connect(
'http://127.0.0.1:9654/',
headers={
const.Client_Id: client_id,
const.X_Auth_Token: self.config.SERVER_API_TOKEN.value or ""
}) as ws:
await ws.close()
# then emulate a barcode scan event
asyncio.create_task(self.webserver.on_barcode(missed_event))
await asyncio.sleep(0.1)
# and then reconnect again, expecting the event in between
async with aiohttp.ClientSession() as session:
async with session.ws_connect(
'http://127.0.0.1:9654/',
headers={
const.Client_Id: client_id,
const.X_Auth_Token: self.config.SERVER_API_TOKEN.value or ""
}) as ws:
# emulate another event, while connected
asyncio.create_task(self.webserver.on_barcode(second_event))
missed_event_received = False
async for msg in ws:
if msg.type == aiohttp.WSMsgType.BINARY:
if missed_event_json == msg.data:
if missed_event_received:
assert False
missed_event_received = True
elif second_event_json == msg.data:
if not missed_event_received:
assert False
await ws.close()
return
else:
assert False
else:
self.fail("No event received")
assert False
@unittest_run_loop
async def test_ws_reconnect_drop_queue(self):
server_id = self.config.INSTANCE_ID.value
missed_event = create_barcode_event_mock("abcdefg")
second_event = create_barcode_event_mock("123456")
missed_event_json = barcode_event_to_json(server_id, missed_event)
second_event_json = barcode_event_to_json(server_id, second_event)
import uuid
client_id = str(uuid.uuid4())
# connect to the server once
async with aiohttp.ClientSession() as session:
async with session.ws_connect(
'http://127.0.0.1:9654/',
headers={
const.Client_Id: client_id,
const.X_Auth_Token: self.config.SERVER_API_TOKEN.value or ""
}) as ws:
await ws.close()
# then emulate a barcode scan event while not connected
asyncio.create_task(self.webserver.on_barcode(missed_event))
await asyncio.sleep(0.1)
# and then reconnect again, passing the "drop cache" header, expecting only
# the new live event
async with aiohttp.ClientSession() as session:
async with session.ws_connect(
'http://127.0.0.1:9654/',
headers={
const.Client_Id: client_id,
const.Drop_Event_Queue: "",
const.X_Auth_Token: self.config.SERVER_API_TOKEN.value or ""
}) as ws:
# emulate another event, while connected
asyncio.create_task(self.webserver.on_barcode(second_event))
async for msg in ws:
if msg.type == aiohttp.WSMsgType.BINARY:
if missed_event_json == msg.data:
self.fail("Received missed event despite queue drop")
elif second_event_json == msg.data:
await ws.close()
assert True
return
else:
self.fail("Received unexpected event")
else:
self.fail("No event received")
assert False