mirror of
https://github.com/ShaYmez/hblink3.git
synced 2024-11-25 01:08:40 -05:00
push changes
This commit is contained in:
Cort Buffington
parent
f3f0d2e95d
commit
c3eee1b9b1
94
.gitignore
vendored
Executable file
94
.gitignore
vendored
Executable file
@ -0,0 +1,94 @@
|
|||||||
|
# Byte-compiled / optimized / DLL files
|
||||||
|
__pycache__/
|
||||||
|
*.py[cod]
|
||||||
|
*$py.class
|
||||||
|
|
||||||
|
# C extensions
|
||||||
|
*.so
|
||||||
|
|
||||||
|
# Distribution / packaging
|
||||||
|
.Python
|
||||||
|
env/
|
||||||
|
build/
|
||||||
|
develop-eggs/
|
||||||
|
dist/
|
||||||
|
downloads/
|
||||||
|
eggs/
|
||||||
|
.eggs/
|
||||||
|
lib/
|
||||||
|
lib64/
|
||||||
|
parts/
|
||||||
|
sdist/
|
||||||
|
var/
|
||||||
|
*.egg-info/
|
||||||
|
.installed.cfg
|
||||||
|
*.egg
|
||||||
|
|
||||||
|
# PyInstaller
|
||||||
|
# Usually these files are written by a python script from a template
|
||||||
|
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||||
|
*.manifest
|
||||||
|
*.spec
|
||||||
|
|
||||||
|
# Installer logs
|
||||||
|
pip-log.txt
|
||||||
|
pip-delete-this-directory.txt
|
||||||
|
|
||||||
|
# Unit test / coverage reports
|
||||||
|
htmlcov/
|
||||||
|
.tox/
|
||||||
|
.coverage
|
||||||
|
.coverage.*
|
||||||
|
.cache
|
||||||
|
nosetests.xml
|
||||||
|
coverage.xml
|
||||||
|
*,cover
|
||||||
|
.hypothesis/
|
||||||
|
|
||||||
|
# Translations
|
||||||
|
*.mo
|
||||||
|
*.pot
|
||||||
|
|
||||||
|
# Django stuff:
|
||||||
|
*.log
|
||||||
|
local_settings.py
|
||||||
|
|
||||||
|
# Flask stuff:
|
||||||
|
instance/
|
||||||
|
.webassets-cache
|
||||||
|
|
||||||
|
# Scrapy stuff:
|
||||||
|
.scrapy
|
||||||
|
|
||||||
|
# Sphinx documentation
|
||||||
|
docs/_build/
|
||||||
|
|
||||||
|
# PyBuilder
|
||||||
|
target/
|
||||||
|
|
||||||
|
# IPython Notebook
|
||||||
|
.ipynb_checkpoints
|
||||||
|
|
||||||
|
# pyenv
|
||||||
|
.python-version
|
||||||
|
|
||||||
|
# celery beat schedule file
|
||||||
|
celerybeat-schedule
|
||||||
|
|
||||||
|
# dotenv
|
||||||
|
.env
|
||||||
|
|
||||||
|
# virtualenv
|
||||||
|
venv/
|
||||||
|
ENV/
|
||||||
|
|
||||||
|
# Spyder project settings
|
||||||
|
.spyderproject
|
||||||
|
|
||||||
|
# Rope project settings
|
||||||
|
.ropeproject
|
||||||
|
|
||||||
|
.DS_Store
|
||||||
|
hblink.cfg
|
||||||
|
*.config
|
||||||
|
*.bak
|
||||||
241
LICENSE.txt
Executable file
241
LICENSE.txt
Executable file
@ -0,0 +1,241 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright © 2007 Free Software Foundation, Inc. <http://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 <http://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 <http://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 <http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||||
37
README.md
Executable file
37
README.md
Executable file
@ -0,0 +1,37 @@
|
|||||||
|
---
|
||||||
|
### FOR SUPPORT, DISCUSSION, GETTING INVOLVED ###
|
||||||
|
|
||||||
|
Please join the DVSwitch group at groups.io for online forum support, discussion, and to become part of the development team.
|
||||||
|
|
||||||
|
DVSwitch@groups.io
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## PROJECT: Open Source HomeBrew Repeater Proctol Client/Master. ##
|
||||||
|
|
||||||
|
**UPDATES:**
|
||||||
|
|
||||||
|
**PURPOSE:** Thanks to the work of Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT we have an open protocol for internetworking DMR repeaters. Unfortunately, there's no generic client and/or master stacks. This project is to build an open-source, python-based implementation. This is a non-commercial license. Atribution is *required* if you use it.
|
||||||
|
|
||||||
|
For those who will ask: This is a piece of software that implements an open-source, amateur radio networking protocol. It is not a network. It is not indended to be a network. It is not intended to replace or circumvent a network. People do those things, code doesn't.
|
||||||
|
|
||||||
|
**PROPERTY:**
|
||||||
|
This work represents the author's interpretation of the HomeBrew Repeater Protocol, based on the 2015-07-26 documents from DMRplus, "IPSC Protocol Specs for homebrew DMR repeater" as written by Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT, also licenced under Creative Commons BY-NC-SA license.
|
||||||
|
|
||||||
|
**WARRANTY**
|
||||||
|
None. The owners of this work make absolutely no warranty, express or implied. Use this software at your own risk.
|
||||||
|
|
||||||
|
**PRE-REQUISITE KNOWLEDGE:**
|
||||||
|
This document assumes the reader is familiar with Linux/UNIX, the Python programming language and DMR.
|
||||||
|
|
||||||
|
**MORE DOCUMENTATION TO COME**
|
||||||
|
|
||||||
|
***0x49 DE N0MJS***
|
||||||
|
|
||||||
|
Copyright (C) 2016-2017 Cortney T. Buffington, N0MJS n0mjs@me.com
|
||||||
|
|
||||||
|
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, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
263
all_bridge.py
Executable file
263
all_bridge.py
Executable file
@ -0,0 +1,263 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
#
|
||||||
|
###############################################################################
|
||||||
|
# Copyright (C) 2016-2018 Cortney T. Buffington, N0MJS <n0mjs@me.com>
|
||||||
|
#
|
||||||
|
# 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, write to the Free Software Foundation,
|
||||||
|
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
###############################################################################
|
||||||
|
|
||||||
|
'''
|
||||||
|
This is a very simple call/packet router for Homebrew Repeater Protocol. It
|
||||||
|
will forward traffic from any system to all other systems configured in the
|
||||||
|
hblink.py configuration file. It does not check for call contentions or
|
||||||
|
filter TS/TGID combinations. It should really only be used as a proxy to
|
||||||
|
hide multiple Homebrew repater protocol systems behind what appears as a single
|
||||||
|
repeater, hotspot, etc.
|
||||||
|
|
||||||
|
As is, this program only works with group voice packets. It could work for all
|
||||||
|
of them by removing a few things.
|
||||||
|
'''
|
||||||
|
|
||||||
|
from __future__ import print_function
|
||||||
|
|
||||||
|
# Python modules we need
|
||||||
|
import sys
|
||||||
|
from bitarray import bitarray
|
||||||
|
from time import time
|
||||||
|
from importlib import import_module
|
||||||
|
from types import ModuleType
|
||||||
|
|
||||||
|
# Twisted is pretty important, so I keep it separate
|
||||||
|
from twisted.internet.protocol import Factory, Protocol
|
||||||
|
from twisted.protocols.basic import NetstringReceiver
|
||||||
|
from twisted.internet import reactor, task
|
||||||
|
|
||||||
|
# Things we import from the main hblink module
|
||||||
|
from hblink import HBSYSTEM, OPENBRIDGE, systems, hblink_handler, reportFactory, REPORT_OPCODES, config_reports, mk_aliases
|
||||||
|
from dmr_utils.utils import hex_str_3, int_id, get_alias
|
||||||
|
from dmr_utils import decode, bptc, const
|
||||||
|
import hb_config
|
||||||
|
import hb_log
|
||||||
|
import hb_const
|
||||||
|
|
||||||
|
# The module needs logging logging, but handlers, etc. are controlled by the parent
|
||||||
|
import logging
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
# Does anybody read this stuff? There's a PEP somewhere that says I should do this.
|
||||||
|
__author__ = 'Cortney T. Buffington, N0MJS'
|
||||||
|
__copyright__ = 'Copyright (c) 2016-2018 Cortney T. Buffington, N0MJS and the K0USY Group'
|
||||||
|
__credits__ = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT'
|
||||||
|
__license__ = 'GNU GPLv3'
|
||||||
|
__maintainer__ = 'Cort Buffington, N0MJS'
|
||||||
|
__email__ = 'n0mjs@me.com'
|
||||||
|
__status__ = 'pre-alpha'
|
||||||
|
|
||||||
|
# Module gobal varaibles
|
||||||
|
|
||||||
|
|
||||||
|
class bridgeallSYSTEM(HBSYSTEM):
|
||||||
|
|
||||||
|
def __init__(self, _name, _config, _report):
|
||||||
|
HBSYSTEM.__init__(self, _name, _config, _report)
|
||||||
|
|
||||||
|
# Status information for the system, TS1 & TS2
|
||||||
|
# 1 & 2 are "timeslot"
|
||||||
|
# In TX_EMB_LC, 2-5 are burst B-E
|
||||||
|
self.STATUS = {
|
||||||
|
1: {
|
||||||
|
'RX_START': time(),
|
||||||
|
'RX_SEQ': '\x00',
|
||||||
|
'RX_RFS': '\x00',
|
||||||
|
'TX_RFS': '\x00',
|
||||||
|
'RX_STREAM_ID': '\x00',
|
||||||
|
'TX_STREAM_ID': '\x00',
|
||||||
|
'RX_TGID': '\x00\x00\x00',
|
||||||
|
'TX_TGID': '\x00\x00\x00',
|
||||||
|
'RX_TIME': time(),
|
||||||
|
'TX_TIME': time(),
|
||||||
|
'RX_TYPE': hb_const.HBPF_SLT_VTERM,
|
||||||
|
'RX_LC': '\x00',
|
||||||
|
'TX_H_LC': '\x00',
|
||||||
|
'TX_T_LC': '\x00',
|
||||||
|
'TX_EMB_LC': {
|
||||||
|
1: '\x00',
|
||||||
|
2: '\x00',
|
||||||
|
3: '\x00',
|
||||||
|
4: '\x00',
|
||||||
|
}
|
||||||
|
},
|
||||||
|
2: {
|
||||||
|
'RX_START': time(),
|
||||||
|
'RX_SEQ': '\x00',
|
||||||
|
'RX_RFS': '\x00',
|
||||||
|
'TX_RFS': '\x00',
|
||||||
|
'RX_STREAM_ID': '\x00',
|
||||||
|
'TX_STREAM_ID': '\x00',
|
||||||
|
'RX_TGID': '\x00\x00\x00',
|
||||||
|
'TX_TGID': '\x00\x00\x00',
|
||||||
|
'RX_TIME': time(),
|
||||||
|
'TX_TIME': time(),
|
||||||
|
'RX_TYPE': hb_const.HBPF_SLT_VTERM,
|
||||||
|
'RX_LC': '\x00',
|
||||||
|
'TX_H_LC': '\x00',
|
||||||
|
'TX_T_LC': '\x00',
|
||||||
|
'TX_EMB_LC': {
|
||||||
|
1: '\x00',
|
||||||
|
2: '\x00',
|
||||||
|
3: '\x00',
|
||||||
|
4: '\x00',
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
def dmrd_received(self, _peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data):
|
||||||
|
pkt_time = time()
|
||||||
|
dmrpkt = _data[20:53]
|
||||||
|
_bits = int_id(_data[15])
|
||||||
|
|
||||||
|
if _call_type == 'group':
|
||||||
|
|
||||||
|
# Is this is a new call stream?
|
||||||
|
if (_stream_id != self.STATUS[_slot]['RX_STREAM_ID']):
|
||||||
|
self.STATUS['RX_START'] = pkt_time
|
||||||
|
logger.info('(%s) *CALL START* STREAM ID: %s SUB: %s (%s) PEER: %s (%s) TGID %s (%s), TS %s', \
|
||||||
|
self._system, int_id(_stream_id), get_alias(_rf_src, subscriber_ids), int_id(_rf_src), get_alias(_peer_id, peer_ids), int_id(_peer_id), get_alias(_dst_id, talkgroup_ids), int_id(_dst_id), _slot)
|
||||||
|
|
||||||
|
# Final actions - Is this a voice terminator?
|
||||||
|
if (_frame_type == hb_const.HBPF_DATA_SYNC) and (_dtype_vseq == hb_const.HBPF_SLT_VTERM) and (self.STATUS[_slot]['RX_TYPE'] != hb_const.HBPF_SLT_VTERM):
|
||||||
|
call_duration = pkt_time - self.STATUS['RX_START']
|
||||||
|
logger.info('(%s) *CALL END* STREAM ID: %s SUB: %s (%s) PEER: %s (%s) TGID %s (%s), TS %s, Duration: %s', \
|
||||||
|
self._system, int_id(_stream_id), get_alias(_rf_src, subscriber_ids), int_id(_rf_src), get_alias(_peer_id, peer_ids), int_id(_peer_id), get_alias(_dst_id, talkgroup_ids), int_id(_dst_id), _slot, call_duration)
|
||||||
|
|
||||||
|
# Mark status variables for use later
|
||||||
|
self.STATUS[_slot]['RX_RFS'] = _rf_src
|
||||||
|
self.STATUS[_slot]['RX_TYPE'] = _dtype_vseq
|
||||||
|
self.STATUS[_slot]['RX_TGID'] = _dst_id
|
||||||
|
self.STATUS[_slot]['RX_TIME'] = pkt_time
|
||||||
|
self.STATUS[_slot]['RX_STREAM_ID'] = _stream_id
|
||||||
|
|
||||||
|
|
||||||
|
for _target in self._CONFIG['SYSTEMS']:
|
||||||
|
if _target != self._system:
|
||||||
|
|
||||||
|
_target_status = systems[_target].STATUS
|
||||||
|
_target_system = self._CONFIG['SYSTEMS'][_target]
|
||||||
|
_target_status[_slot]['TX_STREAM_ID'] = _stream_id
|
||||||
|
|
||||||
|
# ACL Processing
|
||||||
|
if self._CONFIG['GLOBAL']['USE_ACL']:
|
||||||
|
if not acl_check(_rf_src, self._CONFIG['GLOBAL']['SUB_ACL']):
|
||||||
|
if self._laststrid != _stream_id:
|
||||||
|
logger.debug('(%s) CALL DROPPED ON EGRESS WITH STREAM ID %s FROM SUBSCRIBER %s BY GLOBAL ACL', _target_system, int_id(_stream_id), int_id(_rf_src))
|
||||||
|
self._laststrid = _stream_id
|
||||||
|
return
|
||||||
|
if _slot == 1 and not acl_check(_dst_id, self._CONFIG['GLOBAL']['TG1_ACL']):
|
||||||
|
if self._laststrid != _stream_id:
|
||||||
|
logger.debug('(%s) CALL DROPPED ON EGRESS WITH STREAM ID %s ON TGID %s BY GLOBAL TS1 ACL', _target_system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid = _stream_id
|
||||||
|
return
|
||||||
|
if _slot == 2 and not acl_check(_dst_id, self._CONFIG['GLOBAL']['TG2_ACL']):
|
||||||
|
if self._laststrid != _stream_id:
|
||||||
|
logger.debug('(%s) CALL DROPPED ON EGRESS WITH STREAM ID %s ON TGID %s BY GLOBAL TS2 ACL', _target_system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid = _stream_id
|
||||||
|
return
|
||||||
|
if self._target_system['USE_ACL']:
|
||||||
|
if not acl_check(_rf_src, _target_system['SUB_ACL']):
|
||||||
|
if self._laststrid != _stream_id:
|
||||||
|
logger.debug('(%s) CALL DROPPED ON EGRESS WITH STREAM ID %s FROM SUBSCRIBER %s BY SYSTEM ACL', _target_system, int_id(_stream_id), int_id(_rf_src))
|
||||||
|
self._laststrid = _stream_id
|
||||||
|
return
|
||||||
|
if _slot == 1 and not acl_check(_dst_id, _target_system['TG1_ACL']):
|
||||||
|
if self._laststrid != _stream_id:
|
||||||
|
logger.debug('(%s) CALL DROPPED ON EGRESS WITH STREAM ID %s ON TGID %s BY SYSTEM TS1 ACL', _target_system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid = _stream_id
|
||||||
|
return
|
||||||
|
if _slot == 2 and not acl_check(_dst_id, _target_system['TG2_ACL']):
|
||||||
|
if self._laststrid != _stream_id:
|
||||||
|
logger.debug('(%s) CALL DROPPED ON EGRESS WITH STREAM ID %s ON TGID %s BY SYSTEM TS2 ACL', _target_system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid = _stream_id
|
||||||
|
return
|
||||||
|
self._laststrid = _stream_id
|
||||||
|
|
||||||
|
systems[_target].send_system(_data)
|
||||||
|
#logger.debug('(%s) Packet routed to system: %s', self._system, _target)
|
||||||
|
|
||||||
|
|
||||||
|
#************************************************
|
||||||
|
# MAIN PROGRAM LOOP STARTS HERE
|
||||||
|
#************************************************
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
import argparse
|
||||||
|
import sys
|
||||||
|
import os
|
||||||
|
import signal
|
||||||
|
from dmr_utils.utils import try_download, mk_id_dict
|
||||||
|
|
||||||
|
# Change the current directory to the location of the application
|
||||||
|
os.chdir(os.path.dirname(os.path.realpath(sys.argv[0])))
|
||||||
|
|
||||||
|
# CLI argument parser - handles picking up the config file from the command line, and sending a "help" message
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument('-c', '--config', action='store', dest='CONFIG_FILE', help='/full/path/to/config.file (usually hblink.cfg)')
|
||||||
|
parser.add_argument('-l', '--logging', action='store', dest='LOG_LEVEL', help='Override config file logging level.')
|
||||||
|
cli_args = parser.parse_args()
|
||||||
|
|
||||||
|
# Ensure we have a path for the config file, if one wasn't specified, then use the default (top of file)
|
||||||
|
if not cli_args.CONFIG_FILE:
|
||||||
|
cli_args.CONFIG_FILE = os.path.dirname(os.path.abspath(__file__))+'/hblink.cfg'
|
||||||
|
|
||||||
|
# Call the external routine to build the configuration dictionary
|
||||||
|
CONFIG = hb_config.build_config(cli_args.CONFIG_FILE)
|
||||||
|
|
||||||
|
# Start the system logger
|
||||||
|
if cli_args.LOG_LEVEL:
|
||||||
|
CONFIG['LOGGER']['LOG_LEVEL'] = cli_args.LOG_LEVEL
|
||||||
|
logger = hb_log.config_logging(CONFIG['LOGGER'])
|
||||||
|
logger.info('\n\nCopyright (c) 2013, 2014, 2015, 2016, 2018\n\tThe Founding Members of the K0USY Group. All rights reserved.\n')
|
||||||
|
logger.debug('Logging system started, anything from here on gets logged')
|
||||||
|
|
||||||
|
# Set up the signal handler
|
||||||
|
def sig_handler(_signal, _frame):
|
||||||
|
logger.info('SHUTDOWN: HBROUTER IS TERMINATING WITH SIGNAL %s', str(_signal))
|
||||||
|
hblink_handler(_signal, _frame)
|
||||||
|
logger.info('SHUTDOWN: ALL SYSTEM HANDLERS EXECUTED - STOPPING REACTOR')
|
||||||
|
reactor.stop()
|
||||||
|
|
||||||
|
# Set signal handers so that we can gracefully exit if need be
|
||||||
|
for sig in [signal.SIGTERM, signal.SIGINT]:
|
||||||
|
signal.signal(sig, sig_handler)
|
||||||
|
|
||||||
|
# Create the name-number mapping dictionaries
|
||||||
|
peer_ids, subscriber_ids, talkgroup_ids = mk_aliases(CONFIG)
|
||||||
|
|
||||||
|
# INITIALIZE THE REPORTING LOOP
|
||||||
|
report_server = config_reports(CONFIG, reportFactory)
|
||||||
|
|
||||||
|
# HBlink instance creation
|
||||||
|
logger.info('HBlink \'hb_bridge_all.py\' -- SYSTEM STARTING...')
|
||||||
|
for system in CONFIG['SYSTEMS']:
|
||||||
|
if CONFIG['SYSTEMS'][system]['ENABLED']:
|
||||||
|
if CONFIG['SYSTEMS'][system]['MODE'] == 'OPENBRIDGE':
|
||||||
|
logger.critical('%s FATAL: Instance is mode \'OPENBRIDGE\', \n\t\t...Which would be tragic for Bridge All, since it carries multiple call\n\t\tstreams simultaneously. hb_bridge_all.py onlyl works with MMDVM-based systems', system)
|
||||||
|
sys.exit('hb_bridge_all.py cannot function with systems that are not MMDVM devices. System {} is configured as an OPENBRIDGE'.format(system))
|
||||||
|
else:
|
||||||
|
systems[system] = bridgeallSYSTEM(system, CONFIG, report_server)
|
||||||
|
reactor.listenUDP(CONFIG['SYSTEMS'][system]['PORT'], systems[system], interface=CONFIG['SYSTEMS'][system]['IP'])
|
||||||
|
logger.debug('%s instance created: %s, %s', CONFIG['SYSTEMS'][system]['MODE'], system, systems[system])
|
||||||
|
|
||||||
|
reactor.run()
|
||||||
811
bridge.py
Executable file
811
bridge.py
Executable file
@ -0,0 +1,811 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
#
|
||||||
|
###############################################################################
|
||||||
|
# Copyright (C) 2016-2018 Cortney T. Buffington, N0MJS <n0mjs@me.com>
|
||||||
|
#
|
||||||
|
# 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, write to the Free Software Foundation,
|
||||||
|
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
###############################################################################
|
||||||
|
|
||||||
|
'''
|
||||||
|
This application, in conjuction with it's rule file (hb_confbridge_rules.py) will
|
||||||
|
work like a "conference bridge". This is similar to what most hams think of as a
|
||||||
|
reflector. You define conference bridges and any system joined to that conference
|
||||||
|
bridge will both receive traffic from, and send traffic to any other system
|
||||||
|
joined to the same conference bridge. It does not provide end-to-end connectivity
|
||||||
|
as each end system must individually be joined to a conference bridge (a name
|
||||||
|
you create in the configuraiton file) to pass traffic.
|
||||||
|
|
||||||
|
This program currently only works with group voice calls.
|
||||||
|
'''
|
||||||
|
|
||||||
|
# Python modules we need
|
||||||
|
import sys
|
||||||
|
from bitarray import bitarray
|
||||||
|
from time import time
|
||||||
|
from importlib import import_module
|
||||||
|
|
||||||
|
# Twisted is pretty important, so I keep it separate
|
||||||
|
from twisted.internet.protocol import Factory, Protocol
|
||||||
|
from twisted.protocols.basic import NetstringReceiver
|
||||||
|
from twisted.internet import reactor, task
|
||||||
|
|
||||||
|
# Things we import from the main hblink module
|
||||||
|
from hblink import HBSYSTEM, OPENBRIDGE, systems, hblink_handler, reportFactory, REPORT_OPCODES, mk_aliases
|
||||||
|
from dmr_utils3.utils import hex_str_3, int_id, get_alias
|
||||||
|
from dmr_utils3 import decode, bptc, const
|
||||||
|
import config
|
||||||
|
import log
|
||||||
|
import const
|
||||||
|
|
||||||
|
# Stuff for socket reporting
|
||||||
|
import pickle as pickle
|
||||||
|
from datetime import datetime
|
||||||
|
# The module needs logging, but handlers, etc. are controlled by the parent
|
||||||
|
import logging
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
# Does anybody read this stuff? There's a PEP somewhere that says I should do this.
|
||||||
|
__author__ = 'Cortney T. Buffington, N0MJS'
|
||||||
|
__copyright__ = 'Copyright (c) 2016-2018 Cortney T. Buffington, N0MJS and the K0USY Group'
|
||||||
|
__credits__ = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT'
|
||||||
|
__license__ = 'GNU GPLv3'
|
||||||
|
__maintainer__ = 'Cort Buffington, N0MJS'
|
||||||
|
__email__ = 'n0mjs@me.com'
|
||||||
|
|
||||||
|
# Module gobal varaibles
|
||||||
|
|
||||||
|
# Timed loop used for reporting HBP status
|
||||||
|
#
|
||||||
|
# REPORT BASED ON THE TYPE SELECTED IN THE MAIN CONFIG FILE
|
||||||
|
def config_reports(_config, _factory):
|
||||||
|
if True: #_config['REPORTS']['REPORT']:
|
||||||
|
def reporting_loop(logger, _server):
|
||||||
|
logger.debug('Periodic reporting loop started')
|
||||||
|
_server.send_config()
|
||||||
|
_server.send_bridge()
|
||||||
|
|
||||||
|
logger.info('HBlink TCP reporting server configured')
|
||||||
|
|
||||||
|
report_server = _factory(_config)
|
||||||
|
report_server.clients = []
|
||||||
|
reactor.listenTCP(_config['REPORTS']['REPORT_PORT'], report_server)
|
||||||
|
|
||||||
|
reporting = task.LoopingCall(reporting_loop, logger, report_server)
|
||||||
|
reporting.start(_config['REPORTS']['REPORT_INTERVAL'])
|
||||||
|
|
||||||
|
return report_server
|
||||||
|
|
||||||
|
|
||||||
|
# Import Bridging rules
|
||||||
|
# Note: A stanza *must* exist for any MASTER or CLIENT configured in the main
|
||||||
|
# configuration file and listed as "active". It can be empty,
|
||||||
|
# but it has to exist.
|
||||||
|
def make_bridges(_hb_confbridge_bridges):
|
||||||
|
try:
|
||||||
|
bridge_file = import_module(_hb_confbridge_bridges)
|
||||||
|
logger.info('Routing bridges file found and bridges imported')
|
||||||
|
except ImportError:
|
||||||
|
sys.exit('Routing bridges file not found or invalid')
|
||||||
|
|
||||||
|
# Convert integer GROUP ID numbers from the config into hex strings
|
||||||
|
# we need to send in the actual data packets.
|
||||||
|
for _bridge in bridge_file.BRIDGES:
|
||||||
|
for _system in bridge_file.BRIDGES[_bridge]:
|
||||||
|
if _system['SYSTEM'] not in CONFIG['SYSTEMS']:
|
||||||
|
sys.exit('ERROR: Conference bridges found for system not configured main configuration')
|
||||||
|
|
||||||
|
_system['TGID'] = hex_str_3(_system['TGID'])
|
||||||
|
for i, e in enumerate(_system['ON']):
|
||||||
|
_system['ON'][i] = hex_str_3(_system['ON'][i])
|
||||||
|
for i, e in enumerate(_system['OFF']):
|
||||||
|
_system['OFF'][i] = hex_str_3(_system['OFF'][i])
|
||||||
|
_system['TIMEOUT'] = _system['TIMEOUT']*60
|
||||||
|
if _system['ACTIVE'] == True:
|
||||||
|
_system['TIMER'] = time() + _system['TIMEOUT']
|
||||||
|
else:
|
||||||
|
_system['TIMER'] = time()
|
||||||
|
return bridge_file.BRIDGES
|
||||||
|
|
||||||
|
|
||||||
|
# Run this every minute for rule timer updates
|
||||||
|
def rule_timer_loop():
|
||||||
|
logger.debug('(ALL HBSYSTEMS) Rule timer loop started')
|
||||||
|
_now = time()
|
||||||
|
|
||||||
|
for _bridge in BRIDGES:
|
||||||
|
for _system in BRIDGES[_bridge]:
|
||||||
|
if _system['TO_TYPE'] == 'ON':
|
||||||
|
if _system['ACTIVE'] == True:
|
||||||
|
if _system['TIMER'] < _now:
|
||||||
|
_system['ACTIVE'] = False
|
||||||
|
logger.info('Conference Bridge TIMEOUT: DEACTIVATE System: %s, Bridge: %s, TS: %s, TGID: %s', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']))
|
||||||
|
else:
|
||||||
|
timeout_in = _system['TIMER'] - _now
|
||||||
|
logger.info('Conference Bridge ACTIVE (ON timer running): System: %s Bridge: %s, TS: %s, TGID: %s, Timeout in: %ss,', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']), timeout_in)
|
||||||
|
elif _system['ACTIVE'] == False:
|
||||||
|
logger.debug('Conference Bridge INACTIVE (no change): System: %s Bridge: %s, TS: %s, TGID: %s', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']))
|
||||||
|
elif _system['TO_TYPE'] == 'OFF':
|
||||||
|
if _system['ACTIVE'] == False:
|
||||||
|
if _system['TIMER'] < _now:
|
||||||
|
_system['ACTIVE'] = True
|
||||||
|
logger.info('Conference Bridge TIMEOUT: ACTIVATE System: %s, Bridge: %s, TS: %s, TGID: %s', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']))
|
||||||
|
else:
|
||||||
|
timeout_in = _system['TIMER'] - _now
|
||||||
|
logger.info('Conference Bridge INACTIVE (OFF timer running): System: %s Bridge: %s, TS: %s, TGID: %s, Timeout in: %ss,', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']), timeout_in)
|
||||||
|
elif _system['ACTIVE'] == True:
|
||||||
|
logger.debug('Conference Bridge ACTIVE (no change): System: %s Bridge: %s, TS: %s, TGID: %s', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']))
|
||||||
|
else:
|
||||||
|
logger.debug('Conference Bridge NO ACTION: System: %s, Bridge: %s, TS: %s, TGID: %s', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']))
|
||||||
|
|
||||||
|
if CONFIG['REPORTS']['REPORT']:
|
||||||
|
report_server.send_clients('bridge updated')
|
||||||
|
|
||||||
|
|
||||||
|
# run this every 10 seconds to trim orphaned stream ids
|
||||||
|
def stream_trimmer_loop():
|
||||||
|
logger.debug('(ALL OPENBRIDGE SYSTEMS) Trimming inactive stream IDs from system lists')
|
||||||
|
_now = time()
|
||||||
|
|
||||||
|
for system in systems:
|
||||||
|
# HBP systems, master and peer
|
||||||
|
if CONFIG['SYSTEMS'][system]['MODE'] != 'OPENBRIDGE':
|
||||||
|
for slot in range(1,3):
|
||||||
|
_slot = systems[system].STATUS[slot]
|
||||||
|
if _slot['RX_TYPE'] != const.HBPF_SLT_VTERM and _slot['RX_TIME'] < _now - 5:
|
||||||
|
_slot['RX_TYPE'] = const.HBPF_SLT_VTERM
|
||||||
|
logger.info('(%s) *TIME OUT* RX STREAM ID: %s SUB: %s TGID %s, TS %s, Duration: %s', \
|
||||||
|
system, int_id(_slot['RX_STREAM_ID']), int_id(_slot['RX_RFS']), int_id(_slot['RX_TGID']), slot, _slot['RX_TIME'] - _slot['RX_START'])
|
||||||
|
if CONFIG['REPORTS']['REPORT']:
|
||||||
|
systems[system]._report.send_bridgeEvent('GROUP VOICE,END,RX,{},{},{},{},{},{},{:.2f}'.format(system, int_id(_slot['RX_STREAM_ID']), int_id(_slot['RX_PEER']), int_id(_slot['RX_RFS']), slot, int_id(_slot['RX_TGID']), _slot['RX_TIME'] - _slot['RX_START']))
|
||||||
|
|
||||||
|
for slot in range(1,3):
|
||||||
|
_slot = systems[system].STATUS[slot]
|
||||||
|
if _slot['TX_TYPE'] != const.HBPF_SLT_VTERM and _slot['TX_TIME'] < _now - 5:
|
||||||
|
_slot['TX_TYPE'] = const.HBPF_SLT_VTERM
|
||||||
|
logger.info('(%s) *TIME OUT* TX STREAM ID: %s SUB: %s TGID %s, TS %s, Duration: %s', \
|
||||||
|
system, int_id(_slot['TX_STREAM_ID']), int_id(_slot['TX_RFS']), int_id(_slot['TX_TGID']), slot, _slot['TX_TIME'] - _slot['TX_START'])
|
||||||
|
if CONFIG['REPORTS']['REPORT']:
|
||||||
|
systems[system]._report.send_bridgeEvent('GROUP VOICE,END,TX,{},{},{},{},{},{},{:.2f}'.format(system, int_id(_slot['TX_STREAM_ID']), int_id(_slot['TX_PEER']), int_id(_slot['TX_RFS']), slot, int_id(_slot['TX_TGID']), _slot['TX_TIME'] - _slot['TX_START']))
|
||||||
|
|
||||||
|
# OBP systems
|
||||||
|
# We can't delete items from a dicationry that's being iterated, so we have to make a temporarly list of entrys to remove later
|
||||||
|
if CONFIG['SYSTEMS'][system]['MODE'] == 'OPENBRIDGE':
|
||||||
|
remove_list = []
|
||||||
|
for stream_id in systems[system].STATUS:
|
||||||
|
if systems[system].STATUS[stream_id]['LAST'] < _now - 5:
|
||||||
|
remove_list.append(stream_id)
|
||||||
|
for stream_id in remove_list:
|
||||||
|
if stream_id in systems[system].STATUS:
|
||||||
|
_system = systems[system].STATUS[stream_id]
|
||||||
|
_config = CONFIG['SYSTEMS'][system]
|
||||||
|
logger.info('(%s) *TIME OUT* STREAM ID: %s SUB: %s PEER: %s TGID: %s TS 1 Duration: %s', \
|
||||||
|
system, int_id(stream_id), get_alias(int_id(_system['RFS']), subscriber_ids), get_alias(int_id(_config['NETWORK_ID']), peer_ids), get_alias(int_id(_system['TGID']), talkgroup_ids), _system['LAST'] - _system['START'])
|
||||||
|
if CONFIG['REPORTS']['REPORT']:
|
||||||
|
systems[system]._report.send_bridgeEvent('GROUP VOICE,END,RX,{},{},{},{},{},{},{:.2f}'.format(system, int_id(stream_id), int_id(_config['NETWORK_ID']), int_id(_system['RFS']), 1, int_id(_system['TGID']), _system['LAST'] - _system['START']))
|
||||||
|
removed = systems[system].STATUS.pop(stream_id)
|
||||||
|
else:
|
||||||
|
logger.error('(%s) Attemped to remove OpenBridge Stream ID %s not in the Stream ID list: %s', system, int_id(stream_id), [id for id in systems[system].STATUS])
|
||||||
|
|
||||||
|
class routerOBP(OPENBRIDGE):
|
||||||
|
|
||||||
|
def __init__(self, _name, _config, _report):
|
||||||
|
OPENBRIDGE.__init__(self, _name, _config, _report)
|
||||||
|
self.STATUS = {}
|
||||||
|
|
||||||
|
|
||||||
|
def dmrd_received(self, _peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data):
|
||||||
|
pkt_time = time()
|
||||||
|
dmrpkt = _data[20:53]
|
||||||
|
_bits = int_id(_data[15])
|
||||||
|
|
||||||
|
if _call_type == 'group':
|
||||||
|
# Is this a new call stream?
|
||||||
|
if (_stream_id not in self.STATUS):
|
||||||
|
# This is a new call stream
|
||||||
|
self.STATUS[_stream_id] = {
|
||||||
|
'START': pkt_time,
|
||||||
|
'CONTENTION':False,
|
||||||
|
'RFS': _rf_src,
|
||||||
|
'TGID': _dst_id,
|
||||||
|
}
|
||||||
|
|
||||||
|
# If we can, use the LC from the voice header as to keep all options intact
|
||||||
|
if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
|
||||||
|
decoded = decode.voice_head_term(dmrpkt)
|
||||||
|
self.STATUS[_stream_id]['LC'] = decoded['LC']
|
||||||
|
|
||||||
|
# If we don't have a voice header then don't wait to decode the Embedded LC
|
||||||
|
# just make a new one from the HBP header. This is good enough, and it saves lots of time
|
||||||
|
else:
|
||||||
|
self.STATUS[_stream_id]['LC'] = const.LC_OPT + _dst_id + _rf_src
|
||||||
|
|
||||||
|
|
||||||
|
logger.info('(%s) *CALL START* STREAM ID: %s SUB: %s (%s) PEER: %s (%s) TGID %s (%s), TS %s', \
|
||||||
|
self._system, int_id(_stream_id), get_alias(_rf_src, subscriber_ids), int_id(_rf_src), get_alias(_peer_id, peer_ids), int_id(_peer_id), get_alias(_dst_id, talkgroup_ids), int_id(_dst_id), _slot)
|
||||||
|
if CONFIG['REPORTS']['REPORT']:
|
||||||
|
self._report.send_bridgeEvent('GROUP VOICE,START,RX,{},{},{},{},{},{}'.format(self._system, int_id(_stream_id), int_id(_peer_id), int_id(_rf_src), _slot, int_id(_dst_id)))
|
||||||
|
|
||||||
|
self.STATUS[_stream_id]['LAST'] = pkt_time
|
||||||
|
|
||||||
|
|
||||||
|
for _bridge in BRIDGES:
|
||||||
|
for _system in BRIDGES[_bridge]:
|
||||||
|
|
||||||
|
if (_system['SYSTEM'] == self._system and _system['TGID'] == _dst_id and _system['TS'] == _slot and _system['ACTIVE'] == True):
|
||||||
|
|
||||||
|
for _target in BRIDGES[_bridge]:
|
||||||
|
if (_target['SYSTEM'] != self._system) and (_target['ACTIVE']):
|
||||||
|
_target_status = systems[_target['SYSTEM']].STATUS
|
||||||
|
_target_system = self._CONFIG['SYSTEMS'][_target['SYSTEM']]
|
||||||
|
if _target_system['MODE'] == 'OPENBRIDGE':
|
||||||
|
# Is this a new call stream on the target?
|
||||||
|
if (_stream_id not in _target_status):
|
||||||
|
# This is a new call stream on the target
|
||||||
|
_target_status[_stream_id] = {
|
||||||
|
'START': pkt_time,
|
||||||
|
'CONTENTION':False,
|
||||||
|
'RFS': _rf_src,
|
||||||
|
'TGID': _dst_id,
|
||||||
|
}
|
||||||
|
# If we can, use the LC from the voice header as to keep all options intact
|
||||||
|
if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
|
||||||
|
decoded = decode.voice_head_term(dmrpkt)
|
||||||
|
_target_status[_stream_id]['LC'] = decoded['LC']
|
||||||
|
logger.debug('(%s) Created LC for OpenBridge destination: System: %s, TGID: %s', self._system, _target['SYSTEM'], int_id(_target['TGID']))
|
||||||
|
|
||||||
|
# If we don't have a voice header then don't wait to decode the Embedded LC
|
||||||
|
# just make a new one from the HBP header. This is good enough, and it saves lots of time
|
||||||
|
else:
|
||||||
|
_target_status[_stream_id]['LC'] = const.LC_OPT + _dst_id + _rf_src
|
||||||
|
logger.info('(%s) Created LC with *LATE ENTRY* for OpenBridge destination: System: %s, TGID: %s', self._system, _target['SYSTEM'], int_id(_target['TGID']))
|
||||||
|
|
||||||
|
_target_status[_stream_id]['H_LC'] = bptc.encode_header_lc(_target_status[_stream_id]['LC'])
|
||||||
|
_target_status[_stream_id]['T_LC'] = bptc.encode_terminator_lc(_target_status[_stream_id]['LC'])
|
||||||
|
_target_status[_stream_id]['EMB_LC'] = bptc.encode_emblc(_target_status[_stream_id]['LC'])
|
||||||
|
logger.info('(%s) Conference Bridge: %s, Call Bridged to OBP System: %s TS: %s, TGID: %s', self._system, _bridge, _target['SYSTEM'], _target['TS'], int_id(_target['TGID']))
|
||||||
|
|
||||||
|
# Record the time of this packet so we can later identify a stale stream
|
||||||
|
_target_status[_stream_id]['LAST'] = pkt_time
|
||||||
|
# Clear the TS bit -- all OpenBridge streams are effectively on TS1
|
||||||
|
_tmp_bits = _bits & ~(1 << 7)
|
||||||
|
|
||||||
|
# Assemble transmit HBP packet header
|
||||||
|
_tmp_data = _data[:8] + _target['TGID'] + _data[11:15] + chr(_tmp_bits) + _data[16:20]
|
||||||
|
|
||||||
|
# MUST TEST FOR NEW STREAM AND IF SO, RE-WRITE THE LC FOR THE TARGET
|
||||||
|
# MUST RE-WRITE DESTINATION TGID IF DIFFERENT
|
||||||
|
# if _dst_id != rule['DST_GROUP']:
|
||||||
|
dmrbits = bitarray(endian='big')
|
||||||
|
dmrbits.frombytes(dmrpkt)
|
||||||
|
# Create a voice header packet (FULL LC)
|
||||||
|
if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
|
||||||
|
dmrbits = _target_status[_stream_id]['H_LC'][0:98] + dmrbits[98:166] + _target_status[_stream_id]['H_LC'][98:197]
|
||||||
|
# Create a voice terminator packet (FULL LC)
|
||||||
|
elif _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VTERM:
|
||||||
|
dmrbits = _target_status[_stream_id]['T_LC'][0:98] + dmrbits[98:166] + _target_status[_stream_id]['T_LC'][98:197]
|
||||||
|
# Create a Burst B-E packet (Embedded LC)
|
||||||
|
elif _dtype_vseq in [1,2,3,4]:
|
||||||
|
dmrbits = dmrbits[0:116] + _target_status[_stream_id]['EMB_LC'][_dtype_vseq] + dmrbits[148:264]
|
||||||
|
dmrpkt = dmrbits.tobytes()
|
||||||
|
_tmp_data = _tmp_data + dmrpkt #+ _data[53:55]
|
||||||
|
|
||||||
|
else:
|
||||||
|
# BEGIN CONTENTION HANDLING
|
||||||
|
#
|
||||||
|
# The rules for each of the 4 "ifs" below are listed here for readability. The Frame To Send is:
|
||||||
|
# From a different group than last RX from this HBSystem, but it has been less than Group Hangtime
|
||||||
|
# From a different group than last TX to this HBSystem, but it has been less than Group Hangtime
|
||||||
|
# From the same group as the last RX from this HBSystem, but from a different subscriber, and it has been less than stream timeout
|
||||||
|
# From the same group as the last TX to this HBSystem, but from a different subscriber, and it has been less than stream timeout
|
||||||
|
# The "continue" at the end of each means the next iteration of the for loop that tests for matching rules
|
||||||
|
#
|
||||||
|
if ((_target['TGID'] != _target_status[_target['TS']]['RX_TGID']) and ((pkt_time - _target_status[_target['TS']]['RX_TIME']) < _target_system['GROUP_HANGTIME'])):
|
||||||
|
if self.STATUS[_stream_id]['CONTENTION'] == False:
|
||||||
|
self.STATUS[_stream_id]['CONTENTION'] = True
|
||||||
|
logger.info('(%s) Call not routed to TGID %s, target active or in group hangtime: HBSystem: %s, TS: %s, TGID: %s', self._system, int_id(_target['TGID']), _target['SYSTEM'], _target['TS'], int_id(_target_status[_target['TS']]['RX_TGID']))
|
||||||
|
continue
|
||||||
|
if ((_target['TGID'] != _target_status[_target['TS']]['TX_TGID']) and ((pkt_time - _target_status[_target['TS']]['TX_TIME']) < _target_system['GROUP_HANGTIME'])):
|
||||||
|
if self.STATUS[_stream_id]['CONTENTION'] == False:
|
||||||
|
self.STATUS[_stream_id]['CONTENTION'] = True
|
||||||
|
logger.info('(%s) Call not routed to TGID%s, target in group hangtime: HBSystem: %s, TS: %s, TGID: %s', self._system, int_id(_target['TGID']), _target['SYSTEM'], _target['TS'], int_id(_target_status[_target['TS']]['TX_TGID']))
|
||||||
|
continue
|
||||||
|
if (_target['TGID'] == _target_status[_target['TS']]['RX_TGID']) and ((pkt_time - _target_status[_target['TS']]['RX_TIME']) < const.STREAM_TO):
|
||||||
|
if self.STATUS[_stream_id]['CONTENTION'] == False:
|
||||||
|
self.STATUS[_stream_id]['CONTENTION'] = True
|
||||||
|
logger.info('(%s) Call not routed to TGID%s, matching call already active on target: HBSystem: %s, TS: %s, TGID: %s', self._system, int_id(_target['TGID']), _target['SYSTEM'], _target['TS'], int_id(_target_status[_target['TS']]['RX_TGID']))
|
||||||
|
continue
|
||||||
|
if (_target['TGID'] == _target_status[_target['TS']]['TX_TGID']) and (_rf_src != _target_status[_target['TS']]['TX_RFS']) and ((pkt_time - _target_status[_target['TS']]['TX_TIME']) < const.STREAM_TO):
|
||||||
|
if self.STATUS[_stream_id]['CONTENTION'] == False:
|
||||||
|
self.STATUS[_stream_id]['CONTENTION'] = True
|
||||||
|
logger.info('(%s) Call not routed for subscriber %s, call route in progress on target: HBSystem: %s, TS: %s, TGID: %s, SUB: %s', self._system, int_id(_rf_src), _target['SYSTEM'], _target['TS'], int_id(_target_status[_target['TS']]['TX_TGID']), int_id(_target_status[_target['TS']]['TX_RFS']))
|
||||||
|
continue
|
||||||
|
|
||||||
|
# Is this a new call stream?
|
||||||
|
if (_target_status[_target['TS']]['TX_STREAM_ID'] != _stream_id): #(_target_status[_target['TS']]['TX_RFS'] != _rf_src) or (_target_status[_target['TS']]['TX_TGID'] != _target['TGID']):
|
||||||
|
#if (_stream_id != self.STATUS[_slot]['RX_STREAM_ID']) or (_target_status[_target['TS']]['TX_RFS'] != _rf_src) or (_target_status[_target['TS']]['TX_TGID'] != _target['TGID']):
|
||||||
|
# Record the DST TGID and Stream ID
|
||||||
|
_target_status[_target['TS']]['TX_START'] = pkt_time
|
||||||
|
_target_status[_target['TS']]['TX_TGID'] = _target['TGID']
|
||||||
|
_target_status[_target['TS']]['TX_STREAM_ID'] = _stream_id
|
||||||
|
_target_status[_target['TS']]['TX_RFS'] = _rf_src
|
||||||
|
_target_status[_target['TS']]['TX_PEER'] = _peer_id
|
||||||
|
# Generate LCs (full and EMB) for the TX stream
|
||||||
|
dst_lc = self.STATUS[_stream_id]['LC'][0:3] + _target['TGID'] + _rf_src
|
||||||
|
_target_status[_target['TS']]['TX_H_LC'] = bptc.encode_header_lc(dst_lc)
|
||||||
|
_target_status[_target['TS']]['TX_T_LC'] = bptc.encode_terminator_lc(dst_lc)
|
||||||
|
_target_status[_target['TS']]['TX_EMB_LC'] = bptc.encode_emblc(dst_lc)
|
||||||
|
logger.debug('(%s) Generating TX FULL and EMB LCs for HomeBrew destination: System: %s, TS: %s, TGID: %s', self._system, _target['SYSTEM'], _target['TS'], int_id(_target['TGID']))
|
||||||
|
logger.info('(%s) Conference Bridge: %s, Call Bridged to HBP System: %s TS: %s, TGID: %s', self._system, _bridge, _target['SYSTEM'], _target['TS'], int_id(_target['TGID']))
|
||||||
|
if CONFIG['REPORTS']['REPORT']:
|
||||||
|
systems[_target['SYSTEM']]._report.send_bridgeEvent('GROUP VOICE,START,TX,{},{},{},{},{},{}'.format(_target['SYSTEM'], int_id(_stream_id), int_id(_peer_id), int_id(_rf_src), _target['TS'], int_id(_target['TGID'])))
|
||||||
|
|
||||||
|
# Set other values for the contention handler to test next time there is a frame to forward
|
||||||
|
_target_status[_target['TS']]['TX_TIME'] = pkt_time
|
||||||
|
_target_status[_target['TS']]['TX_TYPE'] = _dtype_vseq
|
||||||
|
|
||||||
|
# Handle any necessary re-writes for the destination
|
||||||
|
if _system['TS'] != _target['TS']:
|
||||||
|
_tmp_bits = _bits ^ 1 << 7
|
||||||
|
else:
|
||||||
|
_tmp_bits = _bits
|
||||||
|
|
||||||
|
# Assemble transmit HBP packet header
|
||||||
|
_tmp_data = _data[:8] + _target['TGID'] + _data[11:15] + chr(_tmp_bits) + _data[16:20]
|
||||||
|
|
||||||
|
# MUST TEST FOR NEW STREAM AND IF SO, RE-WRITE THE LC FOR THE TARGET
|
||||||
|
# MUST RE-WRITE DESTINATION TGID IF DIFFERENT
|
||||||
|
# if _dst_id != rule['DST_GROUP']:
|
||||||
|
dmrbits = bitarray(endian='big')
|
||||||
|
dmrbits.frombytes(dmrpkt)
|
||||||
|
# Create a voice header packet (FULL LC)
|
||||||
|
if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
|
||||||
|
dmrbits = _target_status[_target['TS']]['TX_H_LC'][0:98] + dmrbits[98:166] + _target_status[_target['TS']]['TX_H_LC'][98:197]
|
||||||
|
# Create a voice terminator packet (FULL LC)
|
||||||
|
elif _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VTERM:
|
||||||
|
dmrbits = _target_status[_target['TS']]['TX_T_LC'][0:98] + dmrbits[98:166] + _target_status[_target['TS']]['TX_T_LC'][98:197]
|
||||||
|
if CONFIG['REPORTS']['REPORT']:
|
||||||
|
systems[_target['SYSTEM']]._report.send_bridgeEvent('GROUP VOICE,END,TX,{},{},{},{},{},{},{:.2f}'.format(_target['SYSTEM'], int_id(_stream_id), int_id(_peer_id), int_id(_rf_src), _target['TS'], int_id(_target['TGID']), 1))
|
||||||
|
# Create a Burst B-E packet (Embedded LC)
|
||||||
|
elif _dtype_vseq in [1,2,3,4]:
|
||||||
|
dmrbits = dmrbits[0:116] + _target_status[_target['TS']]['TX_EMB_LC'][_dtype_vseq] + dmrbits[148:264]
|
||||||
|
dmrpkt = dmrbits.tobytes()
|
||||||
|
_tmp_data = _tmp_data + dmrpkt + '\x00\x00' # Add two bytes of nothing since OBP doesn't include BER & RSSI bytes #_data[53:55]
|
||||||
|
|
||||||
|
# Transmit the packet to the destination system
|
||||||
|
systems[_target['SYSTEM']].send_system(_tmp_data)
|
||||||
|
#logger.debug('(%s) Packet routed by bridge: %s to system: %s TS: %s, TGID: %s', self._system, _bridge, _target['SYSTEM'], _target['TS'], int_id(_target['TGID']))
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Final actions - Is this a voice terminator?
|
||||||
|
if (_frame_type == const.HBPF_DATA_SYNC) and (_dtype_vseq == const.HBPF_SLT_VTERM):
|
||||||
|
call_duration = pkt_time - self.STATUS[_stream_id]['START']
|
||||||
|
logger.info('(%s) *CALL END* STREAM ID: %s SUB: %s (%s) PEER: %s (%s) TGID %s (%s), TS %s, Duration: %s', \
|
||||||
|
self._system, int_id(_stream_id), get_alias(_rf_src, subscriber_ids), int_id(_rf_src), get_alias(_peer_id, peer_ids), int_id(_peer_id), get_alias(_dst_id, talkgroup_ids), int_id(_dst_id), _slot, call_duration)
|
||||||
|
if CONFIG['REPORTS']['REPORT']:
|
||||||
|
self._report.send_bridgeEvent('GROUP VOICE,END,RX,{},{},{},{},{},{},{:.2f}'.format(self._system, int_id(_stream_id), int_id(_peer_id), int_id(_rf_src), _slot, int_id(_dst_id), call_duration))
|
||||||
|
removed = self.STATUS.pop(_stream_id)
|
||||||
|
logger.debug('(%s) OpenBridge sourced call stream end, remove terminated Stream ID: %s', self._system, int_id(_stream_id))
|
||||||
|
if not removed:
|
||||||
|
selflogger.error('(%s) *CALL END* STREAM ID: %s NOT IN LIST -- THIS IS A REAL PROBLEM', self._system, int_id(_stream_id))
|
||||||
|
|
||||||
|
class routerHBP(HBSYSTEM):
|
||||||
|
|
||||||
|
def __init__(self, _name, _config, _report):
|
||||||
|
HBSYSTEM.__init__(self, _name, _config, _report)
|
||||||
|
|
||||||
|
# Status information for the system, TS1 & TS2
|
||||||
|
# 1 & 2 are "timeslot"
|
||||||
|
# In TX_EMB_LC, 2-5 are burst B-E
|
||||||
|
self.STATUS = {
|
||||||
|
1: {
|
||||||
|
'RX_START': time(),
|
||||||
|
'TX_START': time(),
|
||||||
|
'RX_SEQ': '\x00',
|
||||||
|
'RX_RFS': '\x00',
|
||||||
|
'TX_RFS': '\x00',
|
||||||
|
'RX_PEER': '\x00',
|
||||||
|
'TX_PEER': '\x00',
|
||||||
|
'RX_STREAM_ID': '\x00',
|
||||||
|
'TX_STREAM_ID': '\x00',
|
||||||
|
'RX_TGID': '\x00\x00\x00',
|
||||||
|
'TX_TGID': '\x00\x00\x00',
|
||||||
|
'RX_TIME': time(),
|
||||||
|
'TX_TIME': time(),
|
||||||
|
'RX_TYPE': const.HBPF_SLT_VTERM,
|
||||||
|
'TX_TYPE': const.HBPF_SLT_VTERM,
|
||||||
|
'RX_LC': '\x00',
|
||||||
|
'TX_H_LC': '\x00',
|
||||||
|
'TX_T_LC': '\x00',
|
||||||
|
'TX_EMB_LC': {
|
||||||
|
1: '\x00',
|
||||||
|
2: '\x00',
|
||||||
|
3: '\x00',
|
||||||
|
4: '\x00',
|
||||||
|
}
|
||||||
|
},
|
||||||
|
2: {
|
||||||
|
'RX_START': time(),
|
||||||
|
'TX_START': time(),
|
||||||
|
'RX_SEQ': '\x00',
|
||||||
|
'RX_RFS': '\x00',
|
||||||
|
'TX_RFS': '\x00',
|
||||||
|
'RX_PEER': '\x00',
|
||||||
|
'TX_PEER': '\x00',
|
||||||
|
'RX_STREAM_ID': '\x00',
|
||||||
|
'TX_STREAM_ID': '\x00',
|
||||||
|
'RX_TGID': '\x00\x00\x00',
|
||||||
|
'TX_TGID': '\x00\x00\x00',
|
||||||
|
'RX_TIME': time(),
|
||||||
|
'TX_TIME': time(),
|
||||||
|
'RX_TYPE': const.HBPF_SLT_VTERM,
|
||||||
|
'TX_TYPE': const.HBPF_SLT_VTERM,
|
||||||
|
'RX_LC': '\x00',
|
||||||
|
'TX_H_LC': '\x00',
|
||||||
|
'TX_T_LC': '\x00',
|
||||||
|
'TX_EMB_LC': {
|
||||||
|
1: '\x00',
|
||||||
|
2: '\x00',
|
||||||
|
3: '\x00',
|
||||||
|
4: '\x00',
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
def dmrd_received(self, _peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data):
|
||||||
|
pkt_time = time()
|
||||||
|
dmrpkt = _data[20:53]
|
||||||
|
_bits = int_id(_data[15])
|
||||||
|
|
||||||
|
if _call_type == 'group':
|
||||||
|
|
||||||
|
# Is this a new call stream?
|
||||||
|
if (_stream_id != self.STATUS[_slot]['RX_STREAM_ID']):
|
||||||
|
if (self.STATUS[_slot]['RX_TYPE'] != const.HBPF_SLT_VTERM) and (pkt_time < (self.STATUS[_slot]['RX_TIME'] + const.STREAM_TO)) and (_rf_src != self.STATUS[_slot]['RX_RFS']):
|
||||||
|
logger.warning('(%s) Packet received with STREAM ID: %s <FROM> SUB: %s PEER: %s <TO> TGID %s, SLOT %s collided with existing call', self._system, int_id(_stream_id), int_id(_rf_src), int_id(_peer_id), int_id(_dst_id), _slot)
|
||||||
|
return
|
||||||
|
|
||||||
|
# This is a new call stream
|
||||||
|
self.STATUS[_slot]['RX_START'] = pkt_time
|
||||||
|
logger.info('(%s) *CALL START* STREAM ID: %s SUB: %s (%s) PEER: %s (%s) TGID %s (%s), TS %s', \
|
||||||
|
self._system, int_id(_stream_id), get_alias(_rf_src, subscriber_ids), int_id(_rf_src), get_alias(_peer_id, peer_ids), int_id(_peer_id), get_alias(_dst_id, talkgroup_ids), int_id(_dst_id), _slot)
|
||||||
|
if CONFIG['REPORTS']['REPORT']:
|
||||||
|
self._report.send_bridgeEvent('GROUP VOICE,START,RX,{},{},{},{},{},{}'.format(self._system, int_id(_stream_id), int_id(_peer_id), int_id(_rf_src), _slot, int_id(_dst_id)))
|
||||||
|
|
||||||
|
# If we can, use the LC from the voice header as to keep all options intact
|
||||||
|
if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
|
||||||
|
decoded = decode.voice_head_term(dmrpkt)
|
||||||
|
self.STATUS[_slot]['RX_LC'] = decoded['LC']
|
||||||
|
|
||||||
|
# If we don't have a voice header then don't wait to decode it from the Embedded LC
|
||||||
|
# just make a new one from the HBP header. This is good enough, and it saves lots of time
|
||||||
|
else:
|
||||||
|
self.STATUS[_slot]['RX_LC'] = const.LC_OPT + _dst_id + _rf_src
|
||||||
|
|
||||||
|
for _bridge in BRIDGES:
|
||||||
|
for _system in BRIDGES[_bridge]:
|
||||||
|
|
||||||
|
if (_system['SYSTEM'] == self._system and _system['TGID'] == _dst_id and _system['TS'] == _slot and _system['ACTIVE'] == True):
|
||||||
|
|
||||||
|
for _target in BRIDGES[_bridge]:
|
||||||
|
if _target['SYSTEM'] != self._system:
|
||||||
|
if _target['ACTIVE']:
|
||||||
|
_target_status = systems[_target['SYSTEM']].STATUS
|
||||||
|
_target_system = self._CONFIG['SYSTEMS'][_target['SYSTEM']]
|
||||||
|
|
||||||
|
if _target_system['MODE'] == 'OPENBRIDGE':
|
||||||
|
# Is this a new call stream on the target?
|
||||||
|
if (_stream_id not in _target_status):
|
||||||
|
# This is a new call stream on the target
|
||||||
|
_target_status[_stream_id] = {
|
||||||
|
'START': pkt_time,
|
||||||
|
'CONTENTION':False,
|
||||||
|
'RFS': _rf_src,
|
||||||
|
'TGID': _dst_id,
|
||||||
|
}
|
||||||
|
# If we can, use the LC from the voice header as to keep all options intact
|
||||||
|
if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
|
||||||
|
decoded = decode.voice_head_term(dmrpkt)
|
||||||
|
_target_status[_stream_id]['LC'] = decoded['LC']
|
||||||
|
logger.debug('(%s) Created LC for OpenBridge destination: System: %s, TGID: %s', self._system, _target['SYSTEM'], int_id(_target['TGID']))
|
||||||
|
|
||||||
|
# If we don't have a voice header then don't wait to decode the Embedded LC
|
||||||
|
# just make a new one from the HBP header. This is good enough, and it saves lots of time
|
||||||
|
else:
|
||||||
|
_target_status[_stream_id]['LC'] = const.LC_OPT + _dst_id + _rf_src
|
||||||
|
logger.info('(%s) Created LC with *LATE ENTRY* for OpenBridge destination: System: %s, TGID: %s', self._system, _target['SYSTEM'], int_id(_target['TGID']))
|
||||||
|
|
||||||
|
_target_status[_stream_id]['H_LC'] = bptc.encode_header_lc(_target_status[_stream_id]['LC'])
|
||||||
|
_target_status[_stream_id]['T_LC'] = bptc.encode_terminator_lc(_target_status[_stream_id]['LC'])
|
||||||
|
_target_status[_stream_id]['EMB_LC'] = bptc.encode_emblc(_target_status[_stream_id]['LC'])
|
||||||
|
logger.info('(%s) Conference Bridge: %s, Call Bridged to OBP System: %s TS: %s, TGID: %s', self._system, _bridge, _target['SYSTEM'], _target['TS'], int_id(_target['TGID']))
|
||||||
|
|
||||||
|
# Record the time of this packet so we can later identify a stale stream
|
||||||
|
_target_status[_stream_id]['LAST'] = pkt_time
|
||||||
|
# Clear the TS bit -- all OpenBridge streams are effectively on TS1
|
||||||
|
_tmp_bits = _bits & ~(1 << 7)
|
||||||
|
|
||||||
|
# Assemble transmit HBP packet header
|
||||||
|
_tmp_data = _data[:8] + _target['TGID'] + _data[11:15] + chr(_tmp_bits) + _data[16:20]
|
||||||
|
|
||||||
|
# MUST TEST FOR NEW STREAM AND IF SO, RE-WRITE THE LC FOR THE TARGET
|
||||||
|
# MUST RE-WRITE DESTINATION TGID IF DIFFERENT
|
||||||
|
# if _dst_id != rule['DST_GROUP']:
|
||||||
|
dmrbits = bitarray(endian='big')
|
||||||
|
dmrbits.frombytes(dmrpkt)
|
||||||
|
# Create a voice header packet (FULL LC)
|
||||||
|
if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
|
||||||
|
dmrbits = _target_status[_stream_id]['H_LC'][0:98] + dmrbits[98:166] + _target_status[_stream_id]['H_LC'][98:197]
|
||||||
|
# Create a voice terminator packet (FULL LC)
|
||||||
|
elif _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VTERM:
|
||||||
|
dmrbits = _target_status[_stream_id]['T_LC'][0:98] + dmrbits[98:166] + _target_status[_stream_id]['T_LC'][98:197]
|
||||||
|
# Create a Burst B-E packet (Embedded LC)
|
||||||
|
elif _dtype_vseq in [1,2,3,4]:
|
||||||
|
dmrbits = dmrbits[0:116] + _target_status[_stream_id]['EMB_LC'][_dtype_vseq] + dmrbits[148:264]
|
||||||
|
dmrpkt = dmrbits.tobytes()
|
||||||
|
_tmp_data = _tmp_data + dmrpkt #+ _data[53:55]
|
||||||
|
|
||||||
|
else:
|
||||||
|
# BEGIN STANDARD CONTENTION HANDLING
|
||||||
|
#
|
||||||
|
# The rules for each of the 4 "ifs" below are listed here for readability. The Frame To Send is:
|
||||||
|
# From a different group than last RX from this HBSystem, but it has been less than Group Hangtime
|
||||||
|
# From a different group than last TX to this HBSystem, but it has been less than Group Hangtime
|
||||||
|
# From the same group as the last RX from this HBSystem, but from a different subscriber, and it has been less than stream timeout
|
||||||
|
# From the same group as the last TX to this HBSystem, but from a different subscriber, and it has been less than stream timeout
|
||||||
|
# The "continue" at the end of each means the next iteration of the for loop that tests for matching rules
|
||||||
|
#
|
||||||
|
if ((_target['TGID'] != _target_status[_target['TS']]['RX_TGID']) and ((pkt_time - _target_status[_target['TS']]['RX_TIME']) < _target_system['GROUP_HANGTIME'])):
|
||||||
|
if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD and self.STATUS[_slot]['RX_STREAM_ID'] != _seq:
|
||||||
|
logger.info('(%s) Call not routed to TGID %s, target active or in group hangtime: HBSystem: %s, TS: %s, TGID: %s', self._system, int_id(_target['TGID']), _target['SYSTEM'], _target['TS'], int_id(_target_status[_target['TS']]['RX_TGID']))
|
||||||
|
continue
|
||||||
|
if ((_target['TGID'] != _target_status[_target['TS']]['TX_TGID']) and ((pkt_time - _target_status[_target['TS']]['TX_TIME']) < _target_system['GROUP_HANGTIME'])):
|
||||||
|
if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD and self.STATUS[_slot]['RX_STREAM_ID'] != _seq:
|
||||||
|
logger.info('(%s) Call not routed to TGID%s, target in group hangtime: HBSystem: %s, TS: %s, TGID: %s', self._system, int_id(_target['TGID']), _target['SYSTEM'], _target['TS'], int_id(_target_status[_target['TS']]['TX_TGID']))
|
||||||
|
continue
|
||||||
|
if (_target['TGID'] == _target_status[_target['TS']]['RX_TGID']) and ((pkt_time - _target_status[_target['TS']]['RX_TIME']) < const.STREAM_TO):
|
||||||
|
if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD and self.STATUS[_slot]['RX_STREAM_ID'] != _seq:
|
||||||
|
logger.info('(%s) Call not routed to TGID%s, matching call already active on target: HBSystem: %s, TS: %s, TGID: %s', self._system, int_id(_target['TGID']), _target['SYSTEM'], _target['TS'], int_id(_target_status[_target['TS']]['RX_TGID']))
|
||||||
|
continue
|
||||||
|
if (_target['TGID'] == _target_status[_target['TS']]['TX_TGID']) and (_rf_src != _target_status[_target['TS']]['TX_RFS']) and ((pkt_time - _target_status[_target['TS']]['TX_TIME']) < const.STREAM_TO):
|
||||||
|
if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD and self.STATUS[_slot]['RX_STREAM_ID'] != _seq:
|
||||||
|
logger.info('(%s) Call not routed for subscriber %s, call route in progress on target: HBSystem: %s, TS: %s, TGID: %s, SUB: %s', self._system, int_id(_rf_src), _target['SYSTEM'], _target['TS'], int_id(_target_status[_target['TS']]['TX_TGID']), int_id(_target_status[_target['TS']]['TX_RFS']))
|
||||||
|
continue
|
||||||
|
|
||||||
|
# Is this a new call stream?
|
||||||
|
if (_stream_id != self.STATUS[_slot]['RX_STREAM_ID']) or (_target_status[_target['TS']]['TX_RFS'] != _rf_src) or (_target_status[_target['TS']]['TX_TGID'] != _target['TGID']):
|
||||||
|
# Record the DST TGID and Stream ID
|
||||||
|
_target_status[_target['TS']]['TX_START'] = pkt_time
|
||||||
|
_target_status[_target['TS']]['TX_TGID'] = _target['TGID']
|
||||||
|
_target_status[_target['TS']]['TX_STREAM_ID'] = _stream_id
|
||||||
|
_target_status[_target['TS']]['TX_RFS'] = _rf_src
|
||||||
|
_target_status[_target['TS']]['TX_PEER'] = _peer_id
|
||||||
|
# Generate LCs (full and EMB) for the TX stream
|
||||||
|
dst_lc = self.STATUS[_slot]['RX_LC'][0:3] + _target['TGID'] + _rf_src
|
||||||
|
_target_status[_target['TS']]['TX_H_LC'] = bptc.encode_header_lc(dst_lc)
|
||||||
|
_target_status[_target['TS']]['TX_T_LC'] = bptc.encode_terminator_lc(dst_lc)
|
||||||
|
_target_status[_target['TS']]['TX_EMB_LC'] = bptc.encode_emblc(dst_lc)
|
||||||
|
logger.debug('(%s) Generating TX FULL and EMB LCs for HomeBrew destination: System: %s, TS: %s, TGID: %s', self._system, _target['SYSTEM'], _target['TS'], int_id(_target['TGID']))
|
||||||
|
logger.info('(%s) Conference Bridge: %s, Call Bridged to HBP System: %s TS: %s, TGID: %s', self._system, _bridge, _target['SYSTEM'], _target['TS'], int_id(_target['TGID']))
|
||||||
|
if CONFIG['REPORTS']['REPORT']:
|
||||||
|
systems[_target['SYSTEM']]._report.send_bridgeEvent('GROUP VOICE,START,TX,{},{},{},{},{},{}'.format(_target['SYSTEM'], int_id(_stream_id), int_id(_peer_id), int_id(_rf_src), _target['TS'], int_id(_target['TGID'])))
|
||||||
|
|
||||||
|
# Set other values for the contention handler to test next time there is a frame to forward
|
||||||
|
_target_status[_target['TS']]['TX_TIME'] = pkt_time
|
||||||
|
_target_status[_target['TS']]['TX_TYPE'] = _dtype_vseq
|
||||||
|
|
||||||
|
# Handle any necessary re-writes for the destination
|
||||||
|
if _system['TS'] != _target['TS']:
|
||||||
|
_tmp_bits = _bits ^ 1 << 7
|
||||||
|
else:
|
||||||
|
_tmp_bits = _bits
|
||||||
|
|
||||||
|
# Assemble transmit HBP packet header
|
||||||
|
_tmp_data = _data[:8] + _target['TGID'] + _data[11:15] + chr(_tmp_bits) + _data[16:20]
|
||||||
|
|
||||||
|
# MUST TEST FOR NEW STREAM AND IF SO, RE-WRITE THE LC FOR THE TARGET
|
||||||
|
# MUST RE-WRITE DESTINATION TGID IF DIFFERENT
|
||||||
|
# if _dst_id != rule['DST_GROUP']:
|
||||||
|
dmrbits = bitarray(endian='big')
|
||||||
|
dmrbits.frombytes(dmrpkt)
|
||||||
|
# Create a voice header packet (FULL LC)
|
||||||
|
if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
|
||||||
|
dmrbits = _target_status[_target['TS']]['TX_H_LC'][0:98] + dmrbits[98:166] + _target_status[_target['TS']]['TX_H_LC'][98:197]
|
||||||
|
# Create a voice terminator packet (FULL LC)
|
||||||
|
elif _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VTERM:
|
||||||
|
dmrbits = _target_status[_target['TS']]['TX_T_LC'][0:98] + dmrbits[98:166] + _target_status[_target['TS']]['TX_T_LC'][98:197]
|
||||||
|
if CONFIG['REPORTS']['REPORT']:
|
||||||
|
systems[_target['SYSTEM']]._report.send_bridgeEvent('GROUP VOICE,END,TX,{},{},{},{},{},{},{:.2f}'.format(_target['SYSTEM'], int_id(_stream_id), int_id(_peer_id), int_id(_rf_src), _target['TS'], int_id(_target['TGID']), 1))
|
||||||
|
# Create a Burst B-E packet (Embedded LC)
|
||||||
|
elif _dtype_vseq in [1,2,3,4]:
|
||||||
|
dmrbits = dmrbits[0:116] + _target_status[_target['TS']]['TX_EMB_LC'][_dtype_vseq] + dmrbits[148:264]
|
||||||
|
dmrpkt = dmrbits.tobytes()
|
||||||
|
_tmp_data = _tmp_data + dmrpkt + _data[53:55]
|
||||||
|
|
||||||
|
# Transmit the packet to the destination system
|
||||||
|
systems[_target['SYSTEM']].send_system(_tmp_data)
|
||||||
|
#logger.debug('(%s) Packet routed by bridge: %s to system: %s TS: %s, TGID: %s', self._system, _bridge, _target['SYSTEM'], _target['TS'], int_id(_target['TGID']))
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Final actions - Is this a voice terminator?
|
||||||
|
if (_frame_type == const.HBPF_DATA_SYNC) and (_dtype_vseq == const.HBPF_SLT_VTERM) and (self.STATUS[_slot]['RX_TYPE'] != const.HBPF_SLT_VTERM):
|
||||||
|
call_duration = pkt_time - self.STATUS[_slot]['RX_START']
|
||||||
|
logger.info('(%s) *CALL END* STREAM ID: %s SUB: %s (%s) PEER: %s (%s) TGID %s (%s), TS %s, Duration: %s', \
|
||||||
|
self._system, int_id(_stream_id), get_alias(_rf_src, subscriber_ids), int_id(_rf_src), get_alias(_peer_id, peer_ids), int_id(_peer_id), get_alias(_dst_id, talkgroup_ids), int_id(_dst_id), _slot, call_duration)
|
||||||
|
if CONFIG['REPORTS']['REPORT']:
|
||||||
|
self._report.send_bridgeEvent('GROUP VOICE,END,RX,{},{},{},{},{},{},{:.2f}'.format(self._system, int_id(_stream_id), int_id(_peer_id), int_id(_rf_src), _slot, int_id(_dst_id), call_duration))
|
||||||
|
|
||||||
|
#
|
||||||
|
# Begin in-band signalling for call end. This has nothign to do with routing traffic directly.
|
||||||
|
#
|
||||||
|
|
||||||
|
# Iterate the rules dictionary
|
||||||
|
|
||||||
|
for _bridge in BRIDGES:
|
||||||
|
for _system in BRIDGES[_bridge]:
|
||||||
|
if _system['SYSTEM'] == self._system:
|
||||||
|
|
||||||
|
# TGID matches a rule source, reset its timer
|
||||||
|
if _slot == _system['TS'] and _dst_id == _system['TGID'] and ((_system['TO_TYPE'] == 'ON' and (_system['ACTIVE'] == True)) or (_system['TO_TYPE'] == 'OFF' and _system['ACTIVE'] == False)):
|
||||||
|
_system['TIMER'] = pkt_time + _system['TIMEOUT']
|
||||||
|
logger.info('(%s) Transmission match for Bridge: %s. Reset timeout to %s', self._system, _bridge, _system['TIMER'])
|
||||||
|
|
||||||
|
# TGID matches an ACTIVATION trigger
|
||||||
|
if (_dst_id in _system['ON'] or _dst_id in _system['RESET']) and _slot == _system['TS']:
|
||||||
|
# Set the matching rule as ACTIVE
|
||||||
|
if _dst_id in _system['ON']:
|
||||||
|
if _system['ACTIVE'] == False:
|
||||||
|
_system['ACTIVE'] = True
|
||||||
|
_system['TIMER'] = pkt_time + _system['TIMEOUT']
|
||||||
|
logger.info('(%s) Bridge: %s, connection changed to state: %s', self._system, _bridge, _system['ACTIVE'])
|
||||||
|
# Cancel the timer if we've enabled an "OFF" type timeout
|
||||||
|
if _system['TO_TYPE'] == 'OFF':
|
||||||
|
_system['TIMER'] = pkt_time
|
||||||
|
logger.info('(%s) Bridge: %s set to "OFF" with an on timer rule: timeout timer cancelled', self._system, _bridge)
|
||||||
|
# Reset the timer for the rule
|
||||||
|
if _system['ACTIVE'] == True and _system['TO_TYPE'] == 'ON':
|
||||||
|
_system['TIMER'] = pkt_time + _system['TIMEOUT']
|
||||||
|
logger.info('(%s) Bridge: %s, timeout timer reset to: %s', self._system, _bridge, _system['TIMER'] - pkt_time)
|
||||||
|
|
||||||
|
# TGID matches an DE-ACTIVATION trigger
|
||||||
|
if (_dst_id in _system['OFF'] or _dst_id in _system['RESET']) and _slot == _system['TS']:
|
||||||
|
# Set the matching rule as ACTIVE
|
||||||
|
if _dst_id in _system['OFF']:
|
||||||
|
if _system['ACTIVE'] == True:
|
||||||
|
_system['ACTIVE'] = False
|
||||||
|
logger.info('(%s) Bridge: %s, connection changed to state: %s', self._system, _bridge, _system['ACTIVE'])
|
||||||
|
# Cancel the timer if we've enabled an "ON" type timeout
|
||||||
|
if _system['TO_TYPE'] == 'ON':
|
||||||
|
_system['TIMER'] = pkt_time
|
||||||
|
logger.info('(%s) Bridge: %s set to ON with and "OFF" timer rule: timeout timer cancelled', self._system, _bridge)
|
||||||
|
# Reset the timer for the rule
|
||||||
|
if _system['ACTIVE'] == False and _system['TO_TYPE'] == 'OFF':
|
||||||
|
_system['TIMER'] = pkt_time + _system['TIMEOUT']
|
||||||
|
logger.info('(%s) Bridge: %s, timeout timer reset to: %s', self._system, _bridge, _system['TIMER'] - pkt_time)
|
||||||
|
# Cancel the timer if we've enabled an "ON" type timeout
|
||||||
|
if _system['ACTIVE'] == True and _system['TO_TYPE'] == 'ON' and _dst_group in _system['OFF']:
|
||||||
|
_system['TIMER'] = pkt_time
|
||||||
|
logger.info('(%s) Bridge: %s set to ON with and "OFF" timer rule: timeout timer cancelled', self._system, _bridge)
|
||||||
|
|
||||||
|
#
|
||||||
|
# END IN-BAND SIGNALLING
|
||||||
|
#
|
||||||
|
|
||||||
|
|
||||||
|
# Mark status variables for use later
|
||||||
|
self.STATUS[_slot]['RX_PEER'] = _peer_id
|
||||||
|
self.STATUS[_slot]['RX_SEQ'] = _seq
|
||||||
|
self.STATUS[_slot]['RX_RFS'] = _rf_src
|
||||||
|
self.STATUS[_slot]['RX_TYPE'] = _dtype_vseq
|
||||||
|
self.STATUS[_slot]['RX_TGID'] = _dst_id
|
||||||
|
self.STATUS[_slot]['RX_TIME'] = pkt_time
|
||||||
|
self.STATUS[_slot]['RX_STREAM_ID'] = _stream_id
|
||||||
|
|
||||||
|
#
|
||||||
|
# Socket-based reporting section
|
||||||
|
#
|
||||||
|
class confbridgeReportFactory(reportFactory):
|
||||||
|
|
||||||
|
def send_bridge(self):
|
||||||
|
serialized = pickle.dumps(BRIDGES, protocol=pickle.HIGHEST_PROTOCOL)
|
||||||
|
self.send_clients(REPORT_OPCODES['BRIDGE_SND']+serialized)
|
||||||
|
|
||||||
|
def send_bridgeEvent(self, _data):
|
||||||
|
self.send_clients(REPORT_OPCODES['BRDG_EVENT']+_data)
|
||||||
|
|
||||||
|
|
||||||
|
#************************************************
|
||||||
|
# MAIN PROGRAM LOOP STARTS HERE
|
||||||
|
#************************************************
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import sys
|
||||||
|
import os
|
||||||
|
import signal
|
||||||
|
|
||||||
|
# Change the current directory to the location of the application
|
||||||
|
os.chdir(os.path.dirname(os.path.realpath(sys.argv[0])))
|
||||||
|
|
||||||
|
# CLI argument parser - handles picking up the config file from the command line, and sending a "help" message
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument('-c', '--config', action='store', dest='CONFIG_FILE', help='/full/path/to/config.file (usually hblink.cfg)')
|
||||||
|
parser.add_argument('-l', '--logging', action='store', dest='LOG_LEVEL', help='Override config file logging level.')
|
||||||
|
cli_args = parser.parse_args()
|
||||||
|
|
||||||
|
# Ensure we have a path for the config file, if one wasn't specified, then use the default (top of file)
|
||||||
|
if not cli_args.CONFIG_FILE:
|
||||||
|
cli_args.CONFIG_FILE = os.path.dirname(os.path.abspath(__file__))+'/hblink.cfg'
|
||||||
|
|
||||||
|
# Call the external routine to build the configuration dictionary
|
||||||
|
CONFIG = config.build_config(cli_args.CONFIG_FILE)
|
||||||
|
|
||||||
|
# Start the system logger
|
||||||
|
if cli_args.LOG_LEVEL:
|
||||||
|
CONFIG['LOGGER']['LOG_LEVEL'] = cli_args.LOG_LEVEL
|
||||||
|
logger = log.config_logging(CONFIG['LOGGER'])
|
||||||
|
logger.info('\n\nCopyright (c) 2013, 2014, 2015, 2016, 2018\n\tThe Founding Members of the K0USY Group. All rights reserved.\n')
|
||||||
|
logger.debug('Logging system started, anything from here on gets logged')
|
||||||
|
|
||||||
|
# Set up the signal handler
|
||||||
|
def sig_handler(_signal, _frame):
|
||||||
|
logger.info('SHUTDOWN: CONFBRIDGE IS TERMINATING WITH SIGNAL %s', str(_signal))
|
||||||
|
hblink_handler(_signal, _frame)
|
||||||
|
logger.info('SHUTDOWN: ALL SYSTEM HANDLERS EXECUTED - STOPPING REACTOR')
|
||||||
|
reactor.stop()
|
||||||
|
|
||||||
|
# Set signal handers so that we can gracefully exit if need be
|
||||||
|
for sig in [signal.SIGINT, signal.SIGTERM]:
|
||||||
|
signal.signal(sig, sig_handler)
|
||||||
|
|
||||||
|
# Create the name-number mapping dictionaries
|
||||||
|
peer_ids, subscriber_ids, talkgroup_ids = mk_aliases(CONFIG)
|
||||||
|
|
||||||
|
# Build the routing rules file
|
||||||
|
BRIDGES = make_bridges('rules')
|
||||||
|
|
||||||
|
# INITIALIZE THE REPORTING LOOP
|
||||||
|
report_server = config_reports(CONFIG, confbridgeReportFactory)
|
||||||
|
|
||||||
|
# HBlink instance creation
|
||||||
|
logger.info('HBlink \'hb_confbridge.py\' -- SYSTEM STARTING...')
|
||||||
|
for system in CONFIG['SYSTEMS']:
|
||||||
|
if CONFIG['SYSTEMS'][system]['ENABLED']:
|
||||||
|
if CONFIG['SYSTEMS'][system]['MODE'] == 'OPENBRIDGE':
|
||||||
|
systems[system] = routerOBP(system, CONFIG, report_server)
|
||||||
|
else:
|
||||||
|
systems[system] = routerHBP(system, CONFIG, report_server)
|
||||||
|
reactor.listenUDP(CONFIG['SYSTEMS'][system]['PORT'], systems[system], interface=CONFIG['SYSTEMS'][system]['IP'])
|
||||||
|
logger.debug('%s instance created: %s, %s', CONFIG['SYSTEMS'][system]['MODE'], system, systems[system])
|
||||||
|
|
||||||
|
def loopingErrHandle(failure):
|
||||||
|
logger.error('STOPPING REACTOR TO AVOID MEMORY LEAK: Unhandled error in timed loop.\n %s', failure)
|
||||||
|
reactor.stop()
|
||||||
|
|
||||||
|
# Initialize the rule timer -- this if for user activated stuff
|
||||||
|
rule_timer_task = task.LoopingCall(rule_timer_loop)
|
||||||
|
rule_timer = rule_timer_task.start(60)
|
||||||
|
rule_timer.addErrback(loopingErrHandle)
|
||||||
|
|
||||||
|
# Initialize the stream trimmer
|
||||||
|
stream_trimmer_task = task.LoopingCall(stream_trimmer_loop)
|
||||||
|
stream_trimmer = stream_trimmer_task.start(5)
|
||||||
|
stream_trimmer.addErrback(loopingErrHandle)
|
||||||
|
|
||||||
|
|
||||||
|
reactor.run()
|
||||||
275
config.py
Executable file
275
config.py
Executable file
@ -0,0 +1,275 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
#
|
||||||
|
###############################################################################
|
||||||
|
# Copyright (C) 2016-2018 Cortney T. Buffington, N0MJS <n0mjs@me.com>
|
||||||
|
#
|
||||||
|
# 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, write to the Free Software Foundation,
|
||||||
|
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
###############################################################################
|
||||||
|
|
||||||
|
'''
|
||||||
|
This module generates the configuration data structure for hblink.py and
|
||||||
|
assoicated programs that use it. It has been seaparated into a different
|
||||||
|
module so as to keep hblink.py easeier to navigate. This file only needs
|
||||||
|
updated if the items in the main configuraiton file (usually hblink.cfg)
|
||||||
|
change.
|
||||||
|
'''
|
||||||
|
|
||||||
|
import configparser
|
||||||
|
import sys
|
||||||
|
import const
|
||||||
|
|
||||||
|
from socket import gethostbyname
|
||||||
|
|
||||||
|
# Does anybody read this stuff? There's a PEP somewhere that says I should do this.
|
||||||
|
__author__ = 'Cortney T. Buffington, N0MJS'
|
||||||
|
__copyright__ = 'Copyright (c) 2016-2018 Cortney T. Buffington, N0MJS and the K0USY Group'
|
||||||
|
__credits__ = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT'
|
||||||
|
__license__ = 'GNU GPLv3'
|
||||||
|
__maintainer__ = 'Cort Buffington, N0MJS'
|
||||||
|
__email__ = 'n0mjs@me.com'
|
||||||
|
|
||||||
|
# Processing of ALS goes here. It's separated from the acl_build function because this
|
||||||
|
# code is hblink config-file format specific, and acl_build is abstracted
|
||||||
|
def process_acls(_config):
|
||||||
|
# Global registration ACL
|
||||||
|
_config['GLOBAL']['REG_ACL'] = acl_build(_config['GLOBAL']['REG_ACL'], const.PEER_MAX)
|
||||||
|
|
||||||
|
# Global subscriber and TGID ACLs
|
||||||
|
for acl in ['SUB_ACL', 'TG1_ACL', 'TG2_ACL']:
|
||||||
|
_config['GLOBAL'][acl] = acl_build(_config['GLOBAL'][acl], const.ID_MAX)
|
||||||
|
|
||||||
|
# System level ACLs
|
||||||
|
for system in _config['SYSTEMS']:
|
||||||
|
# Registration ACLs (which make no sense for peer systems)
|
||||||
|
if _config['SYSTEMS'][system]['MODE'] == 'MASTER':
|
||||||
|
_config['SYSTEMS'][system]['REG_ACL'] = acl_build(_config['SYSTEMS'][system]['REG_ACL'], const.PEER_MAX)
|
||||||
|
|
||||||
|
# Subscriber and TGID ACLs (valid for all system types)
|
||||||
|
for acl in ['SUB_ACL', 'TG1_ACL', 'TG2_ACL']:
|
||||||
|
_config['SYSTEMS'][system][acl] = acl_build(_config['SYSTEMS'][system][acl], const.ID_MAX)
|
||||||
|
|
||||||
|
# Create an access control list that is programatically useable from human readable:
|
||||||
|
# ORIGINAL: 'DENY:1-5,3120101,3120124'
|
||||||
|
# PROCESSED: (False, set([(1, 5), (3120124, 3120124), (3120101, 3120101)]))
|
||||||
|
def acl_build(_acl, _max):
|
||||||
|
if not _acl:
|
||||||
|
return(True, set((const.ID_MIN, _max)))
|
||||||
|
|
||||||
|
acl = set()
|
||||||
|
sections = _acl.split(':')
|
||||||
|
|
||||||
|
if sections[0] == 'PERMIT':
|
||||||
|
action = True
|
||||||
|
else:
|
||||||
|
action = False
|
||||||
|
|
||||||
|
for entry in sections[1].split(','):
|
||||||
|
if entry == 'ALL':
|
||||||
|
acl.add((const.ID_MIN, _max))
|
||||||
|
break
|
||||||
|
|
||||||
|
elif '-' in entry:
|
||||||
|
start,end = entry.split('-')
|
||||||
|
start,end = int(start), int(end)
|
||||||
|
if (const.ID_MIN <= start <= _max) or (const.ID_MIN <= end <= _max):
|
||||||
|
acl.add((start, end))
|
||||||
|
else:
|
||||||
|
sys.exit('ACL CREATION ERROR, VALUE OUT OF RANGE (} - {})IN RANGE-BASED ENTRY: {}'.format(const.ID_MIN, _max, entry))
|
||||||
|
else:
|
||||||
|
id = int(entry)
|
||||||
|
if (const.ID_MIN <= id <= _max):
|
||||||
|
acl.add((id, id))
|
||||||
|
else:
|
||||||
|
sys.exit('ACL CREATION ERROR, VALUE OUT OF RANGE ({} - {}) IN SINGLE ID ENTRY: {}'.format(const.ID_MIN, _max, entry))
|
||||||
|
|
||||||
|
return (action, acl)
|
||||||
|
|
||||||
|
def build_config(_config_file):
|
||||||
|
config = configparser.ConfigParser()
|
||||||
|
|
||||||
|
if not config.read(_config_file):
|
||||||
|
sys.exit('Configuration file \''+_config_file+'\' is not a valid configuration file! Exiting...')
|
||||||
|
|
||||||
|
CONFIG = {}
|
||||||
|
CONFIG['GLOBAL'] = {}
|
||||||
|
CONFIG['REPORTS'] = {}
|
||||||
|
CONFIG['LOGGER'] = {}
|
||||||
|
CONFIG['ALIASES'] = {}
|
||||||
|
CONFIG['SYSTEMS'] = {}
|
||||||
|
|
||||||
|
try:
|
||||||
|
for section in config.sections():
|
||||||
|
if section == 'GLOBAL':
|
||||||
|
CONFIG['GLOBAL'].update({
|
||||||
|
'PATH': config.get(section, 'PATH'),
|
||||||
|
'PING_TIME': config.getint(section, 'PING_TIME'),
|
||||||
|
'MAX_MISSED': config.getint(section, 'MAX_MISSED'),
|
||||||
|
'USE_ACL': config.get(section, 'USE_ACL'),
|
||||||
|
'REG_ACL': config.get(section, 'REG_ACL'),
|
||||||
|
'SUB_ACL': config.get(section, 'SUB_ACL'),
|
||||||
|
'TG1_ACL': config.get(section, 'TGID_TS1_ACL'),
|
||||||
|
'TG2_ACL': config.get(section, 'TGID_TS2_ACL')
|
||||||
|
})
|
||||||
|
|
||||||
|
elif section == 'REPORTS':
|
||||||
|
CONFIG['REPORTS'].update({
|
||||||
|
'REPORT': config.getboolean(section, 'REPORT'),
|
||||||
|
'REPORT_INTERVAL': config.getint(section, 'REPORT_INTERVAL'),
|
||||||
|
'REPORT_PORT': config.getint(section, 'REPORT_PORT'),
|
||||||
|
'REPORT_CLIENTS': config.get(section, 'REPORT_CLIENTS').split(',')
|
||||||
|
})
|
||||||
|
|
||||||
|
elif section == 'LOGGER':
|
||||||
|
CONFIG['LOGGER'].update({
|
||||||
|
'LOG_FILE': config.get(section, 'LOG_FILE'),
|
||||||
|
'LOG_HANDLERS': config.get(section, 'LOG_HANDLERS'),
|
||||||
|
'LOG_LEVEL': config.get(section, 'LOG_LEVEL'),
|
||||||
|
'LOG_NAME': config.get(section, 'LOG_NAME')
|
||||||
|
})
|
||||||
|
|
||||||
|
elif section == 'ALIASES':
|
||||||
|
CONFIG['ALIASES'].update({
|
||||||
|
'TRY_DOWNLOAD': config.getboolean(section, 'TRY_DOWNLOAD'),
|
||||||
|
'PATH': config.get(section, 'PATH'),
|
||||||
|
'PEER_FILE': config.get(section, 'PEER_FILE'),
|
||||||
|
'SUBSCRIBER_FILE': config.get(section, 'SUBSCRIBER_FILE'),
|
||||||
|
'TGID_FILE': config.get(section, 'TGID_FILE'),
|
||||||
|
'PEER_URL': config.get(section, 'PEER_URL'),
|
||||||
|
'SUBSCRIBER_URL': config.get(section, 'SUBSCRIBER_URL'),
|
||||||
|
'STALE_TIME': config.getint(section, 'STALE_DAYS') * 86400,
|
||||||
|
})
|
||||||
|
|
||||||
|
elif config.getboolean(section, 'ENABLED'):
|
||||||
|
if config.get(section, 'MODE') == 'PEER':
|
||||||
|
CONFIG['SYSTEMS'].update({section: {
|
||||||
|
'MODE': config.get(section, 'MODE'),
|
||||||
|
'ENABLED': config.getboolean(section, 'ENABLED'),
|
||||||
|
'LOOSE': config.getboolean(section, 'LOOSE'),
|
||||||
|
'SOCK_ADDR': (gethostbyname(config.get(section, 'IP')), config.getint(section, 'PORT')),
|
||||||
|
'IP': gethostbyname(config.get(section, 'IP')),
|
||||||
|
'PORT': config.getint(section, 'PORT'),
|
||||||
|
'MASTER_SOCKADDR': (gethostbyname(config.get(section, 'MASTER_IP')), config.getint(section, 'MASTER_PORT')),
|
||||||
|
'MASTER_IP': gethostbyname(config.get(section, 'MASTER_IP')),
|
||||||
|
'MASTER_PORT': config.getint(section, 'MASTER_PORT'),
|
||||||
|
'PASSPHRASE': bytes(config.get(section, 'PASSPHRASE'), 'utf-8'),
|
||||||
|
'CALLSIGN': bytes(config.get(section, 'CALLSIGN').ljust(8)[:8], 'utf-8'),
|
||||||
|
'RADIO_ID': config.getint(section, 'RADIO_ID').to_bytes(4, 'big'),
|
||||||
|
'RX_FREQ': bytes(config.get(section, 'RX_FREQ').ljust(9)[:9], 'utf-8'),
|
||||||
|
'TX_FREQ': bytes(config.get(section, 'TX_FREQ').ljust(9)[:9], 'utf-8'),
|
||||||
|
'TX_POWER': bytes(config.get(section, 'TX_POWER').rjust(2,'0'), 'utf-8'),
|
||||||
|
'COLORCODE': bytes(config.get(section, 'COLORCODE').rjust(2,'0'), 'utf-8'),
|
||||||
|
'LATITUDE': bytes(config.get(section, 'LATITUDE').ljust(8)[:8], 'utf-8'),
|
||||||
|
'LONGITUDE': bytes(config.get(section, 'LONGITUDE').ljust(9)[:9], 'utf-8'),
|
||||||
|
'HEIGHT': bytes(config.get(section, 'HEIGHT').rjust(3,'0'), 'utf-8'),
|
||||||
|
'LOCATION': bytes(config.get(section, 'LOCATION').ljust(20)[:20], 'utf-8'),
|
||||||
|
'DESCRIPTION': bytes(config.get(section, 'DESCRIPTION').ljust(19)[:19], 'utf-8'),
|
||||||
|
'SLOTS': bytes(config.get(section, 'SLOTS'), 'utf-8'),
|
||||||
|
'URL': bytes(config.get(section, 'URL').ljust(124)[:124], 'utf-8'),
|
||||||
|
'SOFTWARE_ID': bytes(config.get(section, 'SOFTWARE_ID').ljust(40)[:40], 'utf-8'),
|
||||||
|
'PACKAGE_ID': bytes(config.get(section, 'PACKAGE_ID').ljust(40)[:40], 'utf-8'),
|
||||||
|
'GROUP_HANGTIME': config.getint(section, 'GROUP_HANGTIME'),
|
||||||
|
'OPTIONS': config.get(section, 'OPTIONS'),
|
||||||
|
'USE_ACL': config.getboolean(section, 'USE_ACL'),
|
||||||
|
'SUB_ACL': config.get(section, 'SUB_ACL'),
|
||||||
|
'TG1_ACL': config.get(section, 'TGID_TS1_ACL'),
|
||||||
|
'TG2_ACL': config.get(section, 'TGID_TS2_ACL')
|
||||||
|
}})
|
||||||
|
CONFIG['SYSTEMS'][section].update({'STATS': {
|
||||||
|
'CONNECTION': 'NO', # NO, RTPL_SENT, AUTHENTICATED, CONFIG-SENT, YES
|
||||||
|
'CONNECTED': None,
|
||||||
|
'PINGS_SENT': 0,
|
||||||
|
'PINGS_ACKD': 0,
|
||||||
|
'NUM_OUTSTANDING': 0,
|
||||||
|
'PING_OUTSTANDING': False,
|
||||||
|
'LAST_PING_TX_TIME': 0,
|
||||||
|
'LAST_PING_ACK_TIME': 0,
|
||||||
|
}})
|
||||||
|
|
||||||
|
elif config.get(section, 'MODE') == 'MASTER':
|
||||||
|
CONFIG['SYSTEMS'].update({section: {
|
||||||
|
'MODE': config.get(section, 'MODE'),
|
||||||
|
'ENABLED': config.getboolean(section, 'ENABLED'),
|
||||||
|
'REPEAT': config.getboolean(section, 'REPEAT'),
|
||||||
|
'MAX_PEERS': config.getint(section, 'MAX_PEERS'),
|
||||||
|
'IP': gethostbyname(config.get(section, 'IP')),
|
||||||
|
'PORT': config.getint(section, 'PORT'),
|
||||||
|
'PASSPHRASE': bytes(config.get(section, 'PASSPHRASE'), 'utf-8'),
|
||||||
|
'GROUP_HANGTIME': config.getint(section, 'GROUP_HANGTIME'),
|
||||||
|
'USE_ACL': config.getboolean(section, 'USE_ACL'),
|
||||||
|
'REG_ACL': config.get(section, 'REG_ACL'),
|
||||||
|
'SUB_ACL': config.get(section, 'SUB_ACL'),
|
||||||
|
'TG1_ACL': config.get(section, 'TGID_TS1_ACL'),
|
||||||
|
'TG2_ACL': config.get(section, 'TGID_TS2_ACL')
|
||||||
|
}})
|
||||||
|
CONFIG['SYSTEMS'][section].update({'PEERS': {}})
|
||||||
|
|
||||||
|
elif config.get(section, 'MODE') == 'OPENBRIDGE':
|
||||||
|
CONFIG['SYSTEMS'].update({section: {
|
||||||
|
'MODE': config.get(section, 'MODE'),
|
||||||
|
'ENABLED': config.getboolean(section, 'ENABLED'),
|
||||||
|
'NETWORK_ID': config.getint(section, 'NETWORK_ID').to_bytes(4, 'big'),
|
||||||
|
'IP': gethostbyname(config.get(section, 'IP')),
|
||||||
|
'PORT': config.getint(section, 'PORT'),
|
||||||
|
'PASSPHRASE': config.get(section, 'PASSPHRASE').ljust(20,'\x00')[:20],
|
||||||
|
'TARGET_SOCK': (gethostbyname(config.get(section, 'TARGET_IP')), config.getint(section, 'TARGET_PORT')),
|
||||||
|
'TARGET_IP': gethostbyname(config.get(section, 'TARGET_IP')),
|
||||||
|
'TARGET_PORT': config.getint(section, 'TARGET_PORT'),
|
||||||
|
'USE_ACL': config.getboolean(section, 'USE_ACL'),
|
||||||
|
'SUB_ACL': config.get(section, 'SUB_ACL'),
|
||||||
|
'TG1_ACL': config.get(section, 'TGID_ACL'),
|
||||||
|
'TG2_ACL': 'PERMIT:ALL'
|
||||||
|
}})
|
||||||
|
|
||||||
|
|
||||||
|
except configparser.Error as err:
|
||||||
|
sys.exit('Error processing configuration file -- {}'.format(err))
|
||||||
|
|
||||||
|
process_acls(CONFIG)
|
||||||
|
|
||||||
|
return CONFIG
|
||||||
|
|
||||||
|
# Used to run this file direclty and print the config,
|
||||||
|
# which might be useful for debugging
|
||||||
|
if __name__ == '__main__':
|
||||||
|
import sys
|
||||||
|
import os
|
||||||
|
import argparse
|
||||||
|
from pprint import pprint
|
||||||
|
from dmr_utils3.utils import int_id
|
||||||
|
|
||||||
|
# Change the current directory to the location of the application
|
||||||
|
os.chdir(os.path.dirname(os.path.realpath(sys.argv[0])))
|
||||||
|
|
||||||
|
# CLI argument parser - handles picking up the config file from the command line, and sending a "help" message
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument('-c', '--config', action='store', dest='CONFIG_FILE', help='/full/path/to/config.file (usually hblink.cfg)')
|
||||||
|
cli_args = parser.parse_args()
|
||||||
|
|
||||||
|
|
||||||
|
# Ensure we have a path for the config file, if one wasn't specified, then use the execution directory
|
||||||
|
if not cli_args.CONFIG_FILE:
|
||||||
|
cli_args.CONFIG_FILE = os.path.dirname(os.path.abspath(__file__))+'/hblink.cfg'
|
||||||
|
|
||||||
|
CONFIG = build_config(cli_args.CONFIG_FILE)
|
||||||
|
pprint(CONFIG)
|
||||||
|
|
||||||
|
def acl_check(_id, _acl):
|
||||||
|
id = int_id(_id)
|
||||||
|
for entry in _acl[1]:
|
||||||
|
if entry[0] <= id <= entry[1]:
|
||||||
|
return _acl[0]
|
||||||
|
return not _acl[0]
|
||||||
|
|
||||||
|
print(acl_check(b'\x00\x01\x37', CONFIG['GLOBAL']['TG1_ACL']))
|
||||||
70
const.py
Executable file
70
const.py
Executable file
@ -0,0 +1,70 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
#
|
||||||
|
###############################################################################
|
||||||
|
# Copyright (C) 2016-2018 Cortney T. Buffington, N0MJS <n0mjs@me.com>
|
||||||
|
#
|
||||||
|
# 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, write to the Free Software Foundation,
|
||||||
|
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
###############################################################################
|
||||||
|
|
||||||
|
'''
|
||||||
|
These are contants used by HBlink. Rather than stuff them into the main program
|
||||||
|
file, any new constants should be placed here. It makes them easier to keep track
|
||||||
|
of and keeps hblink.py shorter.
|
||||||
|
'''
|
||||||
|
|
||||||
|
__author__ = 'Cortney T. Buffington, N0MJS'
|
||||||
|
__copyright__ = 'Copyright (c) 2016 Cortney T. Buffington, N0MJS and the K0USY Group'
|
||||||
|
__credits__ = ''
|
||||||
|
__license__ = 'GNU GPLv3'
|
||||||
|
__maintainer__ = 'Cort Buffington, N0MJS'
|
||||||
|
__email__ = 'n0mjs@me.com'
|
||||||
|
|
||||||
|
|
||||||
|
# DMR Related constants
|
||||||
|
ID_MIN = 1
|
||||||
|
ID_MAX = 16776415
|
||||||
|
|
||||||
|
# Timers
|
||||||
|
STREAM_TO = .360
|
||||||
|
|
||||||
|
# HomeBrew Protocol Frame Types
|
||||||
|
HBPF_VOICE = 0x0
|
||||||
|
HBPF_VOICE_SYNC = 0x1
|
||||||
|
HBPF_DATA_SYNC = 0x2
|
||||||
|
HBPF_SLT_VHEAD = 0x1
|
||||||
|
HBPF_SLT_VTERM = 0x2
|
||||||
|
|
||||||
|
# HomeBrew Protocol Commands
|
||||||
|
DMRD = b'DMRD'
|
||||||
|
MSTCL = b'MSTCL'
|
||||||
|
MSTNAK = b'MSTNAC'
|
||||||
|
MSPONG = b'MSPONG'
|
||||||
|
MSTN = b'MSTN'
|
||||||
|
MSTP = b'MSTP'
|
||||||
|
MSTC = b'MSTC'
|
||||||
|
RPTL = b'RPTL'
|
||||||
|
RPTPING = b'RPTPING'
|
||||||
|
RPTCL = b'RPTCL'
|
||||||
|
RPTL = b'RPTL'
|
||||||
|
RPTACK = b'RPTACK'
|
||||||
|
RPTK = b'RPTK'
|
||||||
|
RPTC = b'RPTC'
|
||||||
|
RPTP = b'RPTP'
|
||||||
|
RPTA = b'RPTA'
|
||||||
|
RPTO = b'RPTO'
|
||||||
|
|
||||||
|
|
||||||
|
# Higheset peer ID permitted by HBP
|
||||||
|
PEER_MAX = 4294967295
|
||||||
209
hblink-SAMPLE.cfg
Executable file
209
hblink-SAMPLE.cfg
Executable file
@ -0,0 +1,209 @@
|
|||||||
|
# PROGRAM-WIDE PARAMETERS GO HERE
|
||||||
|
# PATH - working path for files, leave it alone unless you NEED to change it
|
||||||
|
# PING_TIME - the interval that peers will ping the master, and re-try registraion
|
||||||
|
# - how often the Master maintenance loop runs
|
||||||
|
# MAX_MISSED - how many pings are missed before we give up and re-register
|
||||||
|
# - number of times the master maintenance loop runs before de-registering a peer
|
||||||
|
#
|
||||||
|
# ACLs:
|
||||||
|
#
|
||||||
|
# Access Control Lists are a very powerful tool for administering your system.
|
||||||
|
# But they consume packet processing time. Disable them if you are not using them.
|
||||||
|
# But be aware that, as of now, the configuration stanzas still need the ACL
|
||||||
|
# sections configured even if you're not using them.
|
||||||
|
#
|
||||||
|
# REGISTRATION ACLS ARE ALWAYS USED, ONLY SUBSCRIBER AND TGID MAY BE DISABLED!!!
|
||||||
|
#
|
||||||
|
# The 'action' May be PERMIT|DENY
|
||||||
|
# Each entry may be a single radio id, or a hypenated range (e.g. 1-2999)
|
||||||
|
# Format:
|
||||||
|
# ACL = 'action:id|start-end|,id|start-end,....'
|
||||||
|
# --for example--
|
||||||
|
# SUB_ACL: DENY:1,1000-2000,4500-60000,17
|
||||||
|
#
|
||||||
|
# ACL Types:
|
||||||
|
# REG_ACL: peer radio IDs for registration (only used on HBP master systems)
|
||||||
|
# SUB_ACL: subscriber IDs for end-users
|
||||||
|
# TGID_TS1_ACL: destination talkgroup IDs on Timeslot 1
|
||||||
|
# TGID_TS2_ACL: destination talkgroup IDs on Timeslot 2
|
||||||
|
#
|
||||||
|
# ACLs may be repeated for individual systems if needed for granularity
|
||||||
|
# Global ACLs will be processed BEFORE the system level ACLs
|
||||||
|
# Packets will be matched against all ACLs, GLOBAL first. If a packet 'passes'
|
||||||
|
# All elements, processing continues. Packets are discarded at the first
|
||||||
|
# negative match, or 'reject' from an ACL element.
|
||||||
|
#
|
||||||
|
# If you do not wish to use ACLs, set them to 'PERMIT:ALL'
|
||||||
|
# TGID_TS1_ACL in the global stanza is used for OPENBRIDGE systems, since all
|
||||||
|
# traffic is passed as TS 1 between OpenBridges
|
||||||
|
[GLOBAL]
|
||||||
|
PATH: ./
|
||||||
|
PING_TIME: 5
|
||||||
|
MAX_MISSED: 3
|
||||||
|
USE_ACL: True
|
||||||
|
REG_ACL: PERMIT:ALL
|
||||||
|
SUB_ACL: DENY:1
|
||||||
|
TGID_TS1_ACL: PERMIT:ALL
|
||||||
|
TGID_TS2_ACL: PERMIT:ALL
|
||||||
|
|
||||||
|
|
||||||
|
# NOT YET WORKING: NETWORK REPORTING CONFIGURATION
|
||||||
|
# Enabling "REPORT" will configure a socket-based reporting
|
||||||
|
# system that will send the configuration and other items
|
||||||
|
# to a another process (local or remote) that may process
|
||||||
|
# the information for some useful purpose, like a web dashboard.
|
||||||
|
#
|
||||||
|
# REPORT - True to enable, False to disable
|
||||||
|
# REPORT_INTERVAL - Seconds between reports
|
||||||
|
# REPORT_PORT - TCP port to listen on if "REPORT_NETWORKS" = NETWORK
|
||||||
|
# REPORT_CLIENTS - comma separated list of IPs you will allow clients
|
||||||
|
# to connect on. Entering a * will allow all.
|
||||||
|
#
|
||||||
|
# ****FOR NOW MUST BE TRUE - USE THE LOOPBACK IF YOU DON'T USE THIS!!!****
|
||||||
|
[REPORTS]
|
||||||
|
REPORT: True
|
||||||
|
REPORT_INTERVAL: 60
|
||||||
|
REPORT_PORT: 4321
|
||||||
|
REPORT_CLIENTS: 127.0.0.1
|
||||||
|
|
||||||
|
|
||||||
|
# SYSTEM LOGGER CONFIGURAITON
|
||||||
|
# This allows the logger to be configured without chaning the individual
|
||||||
|
# python logger stuff. LOG_FILE should be a complete path/filename for *your*
|
||||||
|
# system -- use /dev/null for non-file handlers.
|
||||||
|
# LOG_HANDLERS may be any of the following, please, no spaces in the
|
||||||
|
# list if you use several:
|
||||||
|
# null
|
||||||
|
# console
|
||||||
|
# console-timed
|
||||||
|
# file
|
||||||
|
# file-timed
|
||||||
|
# syslog
|
||||||
|
# LOG_LEVEL may be any of the standard syslog logging levels, though
|
||||||
|
# as of now, DEBUG, INFO, WARNING and CRITICAL are the only ones
|
||||||
|
# used.
|
||||||
|
#
|
||||||
|
[LOGGER]
|
||||||
|
LOG_FILE: /tmp/hblink.log
|
||||||
|
LOG_HANDLERS: console-timed
|
||||||
|
LOG_LEVEL: DEBUG
|
||||||
|
LOG_NAME: HBlink
|
||||||
|
|
||||||
|
# DOWNLOAD AND IMPORT SUBSCRIBER, PEER and TGID ALIASES
|
||||||
|
# Ok, not the TGID, there's no master list I know of to download
|
||||||
|
# This is intended as a facility for other applcations built on top of
|
||||||
|
# HBlink to use, and will NOT be used in HBlink directly.
|
||||||
|
# STALE_DAYS is the number of days since the last download before we
|
||||||
|
# download again. Don't be an ass and change this to less than a few days.
|
||||||
|
[ALIASES]
|
||||||
|
TRY_DOWNLOAD: True
|
||||||
|
PATH: ./
|
||||||
|
PEER_FILE: peer_ids.csv
|
||||||
|
SUBSCRIBER_FILE: subscriber_ids.csv
|
||||||
|
TGID_FILE: talkgroup_ids.csv
|
||||||
|
PEER_URL: https://www.radioid.net/static/rptrs.csv
|
||||||
|
SUBSCRIBER_URL: https://www.radioid.net/static/users.csv
|
||||||
|
STALE_DAYS: 7
|
||||||
|
|
||||||
|
# OPENBRIDGE INSTANCES - DUPLICATE SECTION FOR MULTIPLE CONNECTIONS
|
||||||
|
# OpenBridge is a protocol originall created by DMR+ for connection between an
|
||||||
|
# IPSC2 server and Brandmeister. It has been implemented here at the suggestion
|
||||||
|
# of the Brandmeister team as a way to legitimately connect HBlink to the
|
||||||
|
# Brandemiester network.
|
||||||
|
# It is recommended to name the system the ID of the Brandmeister server that
|
||||||
|
# it connects to, but is not necessary. TARGET_IP and TARGET_PORT are of the
|
||||||
|
# Brandmeister or IPSC2 server you are connecting to. PASSPHRASE is the password
|
||||||
|
# that must be agreed upon between you and the operator of the server you are
|
||||||
|
# connecting to. NETWORK_ID is a number in the format of a DMR Radio ID that
|
||||||
|
# will be sent to the other server to identify this connection.
|
||||||
|
# other parameters follow the other system types.
|
||||||
|
#
|
||||||
|
# ACLs:
|
||||||
|
# OpenBridge does not 'register', so registration ACL is meaningless.
|
||||||
|
# OpenBridge passes all traffic on TS1, so there is only 1 TGID ACL.
|
||||||
|
# Otherwise ACLs work as described in the global stanza
|
||||||
|
[OBP-1]
|
||||||
|
MODE: OPENBRIDGE
|
||||||
|
ENABLED: True
|
||||||
|
IP:
|
||||||
|
PORT: 62035
|
||||||
|
NETWORK_ID: 3129100
|
||||||
|
PASSPHRASE: password
|
||||||
|
TARGET_IP: 1.2.3.4
|
||||||
|
TARGET_PORT: 62035
|
||||||
|
USE_ACL: True
|
||||||
|
SUB_ACL: DENY:1
|
||||||
|
TGID_ACL: PERMIT:ALL
|
||||||
|
|
||||||
|
# MASTER INSTANCES - DUPLICATE SECTION FOR MULTIPLE MASTERS
|
||||||
|
# HomeBrew Protocol Master instances go here.
|
||||||
|
# IP may be left blank if there's one interface on your system.
|
||||||
|
# Port should be the port you want this master to listen on. It must be unique
|
||||||
|
# and unused by anything else.
|
||||||
|
# Repeat - if True, the master repeats traffic to peers, False, it does nothing.
|
||||||
|
#
|
||||||
|
# MAX_PEERS -- maximun number of peers that may be connect to this master
|
||||||
|
# at any given time. This is very handy if you're allowing hotspots to
|
||||||
|
# connect, or using a limited computer like a Raspberry Pi.
|
||||||
|
#
|
||||||
|
# ACLs:
|
||||||
|
# See comments in the GLOBAL stanza
|
||||||
|
[MASTER-1]
|
||||||
|
MODE: MASTER
|
||||||
|
ENABLED: True
|
||||||
|
REPEAT: True
|
||||||
|
MAX_PEERS: 10
|
||||||
|
EXPORT_AMBE: False
|
||||||
|
IP:
|
||||||
|
PORT: 54000
|
||||||
|
PASSPHRASE: s3cr37w0rd
|
||||||
|
GROUP_HANGTIME: 5
|
||||||
|
USE_ACL: True
|
||||||
|
REG_ACL: DENY:1
|
||||||
|
SUB_ACL: DENY:1
|
||||||
|
TGID_TS1_ACL: PERMIT:ALL
|
||||||
|
TGID_TS2_ACL: PERMIT:ALL
|
||||||
|
|
||||||
|
# PEER INSTANCES - DUPLICATE SECTION FOR MULTIPLE PEERS
|
||||||
|
# There are a LOT of errors in the HB Protocol specifications on this one!
|
||||||
|
# MOST of these items are just strings and will be properly dealt with by the program
|
||||||
|
# The TX & RX Frequencies are 9-digit numbers, and are the frequency in Hz.
|
||||||
|
# Latitude is an 8-digit unsigned floating point number.
|
||||||
|
# Longitude is a 9-digit signed floating point number.
|
||||||
|
# Height is in meters
|
||||||
|
# Setting Loose to True relaxes the validation on packets received from the master.
|
||||||
|
# This will allow HBlink to connect to a non-compliant system such as XLXD, DMR+ etc.
|
||||||
|
#
|
||||||
|
# ACLs:
|
||||||
|
# See comments in the GLOBAL stanza
|
||||||
|
[REPEATER-1]
|
||||||
|
MODE: PEER
|
||||||
|
ENABLED: True
|
||||||
|
LOOSE: False
|
||||||
|
EXPORT_AMBE: False
|
||||||
|
IP:
|
||||||
|
PORT: 54001
|
||||||
|
MASTER_IP: 172.16.1.1
|
||||||
|
MASTER_PORT: 54000
|
||||||
|
PASSPHRASE: homebrew
|
||||||
|
CALLSIGN: W1ABC
|
||||||
|
RADIO_ID: 312000
|
||||||
|
RX_FREQ: 449000000
|
||||||
|
TX_FREQ: 444000000
|
||||||
|
TX_POWER: 25
|
||||||
|
COLORCODE: 1
|
||||||
|
SLOTS: 1
|
||||||
|
LATITUDE: 38.0000
|
||||||
|
LONGITUDE: -095.0000
|
||||||
|
HEIGHT: 75
|
||||||
|
LOCATION: Anywhere, USA
|
||||||
|
DESCRIPTION: This is a cool repeater
|
||||||
|
URL: www.w1abc.org
|
||||||
|
SOFTWARE_ID: 20170620
|
||||||
|
PACKAGE_ID: MMDVM_HBlink
|
||||||
|
GROUP_HANGTIME: 5
|
||||||
|
OPTIONS:
|
||||||
|
USE_ACL: True
|
||||||
|
SUB_ACL: DENY:1
|
||||||
|
TGID_TS1_ACL: PERMIT:ALL
|
||||||
|
TGID_TS2_ACL: PERMIT:ALL
|
||||||
803
hblink.py
Executable file
803
hblink.py
Executable file
@ -0,0 +1,803 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
#
|
||||||
|
###############################################################################
|
||||||
|
# Copyright (C) 2016-2018 Cortney T. Buffington, N0MJS <n0mjs@me.com>
|
||||||
|
#
|
||||||
|
# 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, write to the Free Software Foundation,
|
||||||
|
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
###############################################################################
|
||||||
|
|
||||||
|
'''
|
||||||
|
This program does very little on it's own. It is intended to be used as a module
|
||||||
|
to build applications on top of the HomeBrew Repeater Protocol. By itself, it
|
||||||
|
will only act as a peer or master for the systems specified in its configuration
|
||||||
|
file (usually hblink.cfg). It is ALWAYS best practice to ensure that this program
|
||||||
|
works stand-alone before troubleshooting any applications that use it. It has
|
||||||
|
sufficient logging to be used standalone as a troubleshooting application.
|
||||||
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Specifig functions from modules we need
|
||||||
|
from binascii import b2a_hex as ahex
|
||||||
|
from binascii import a2b_hex as bhex
|
||||||
|
from random import randint
|
||||||
|
from hashlib import sha256, sha1
|
||||||
|
from hmac import new as hmac_new, compare_digest
|
||||||
|
from time import time
|
||||||
|
from bitstring import BitArray
|
||||||
|
from importlib import import_module
|
||||||
|
from collections import deque
|
||||||
|
|
||||||
|
# Twisted is pretty important, so I keep it separate
|
||||||
|
from twisted.internet.protocol import DatagramProtocol, Factory, Protocol
|
||||||
|
from twisted.protocols.basic import NetstringReceiver
|
||||||
|
from twisted.internet import reactor, task
|
||||||
|
|
||||||
|
# Other files we pull from -- this is mostly for readability and segmentation
|
||||||
|
import log
|
||||||
|
import config
|
||||||
|
import const
|
||||||
|
from dmr_utils3.utils import int_id, hex_str_4, try_download, mk_id_dict
|
||||||
|
|
||||||
|
# Imports for the reporting server
|
||||||
|
import pickle as pickle
|
||||||
|
from reporting_const import *
|
||||||
|
|
||||||
|
# The module needs logging logging, but handlers, etc. are controlled by the parent
|
||||||
|
import logging
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
# Does anybody read this stuff? There's a PEP somewhere that says I should do this.
|
||||||
|
__author__ = 'Cortney T. Buffington, N0MJS'
|
||||||
|
__copyright__ = 'Copyright (c) 2016-2018 Cortney T. Buffington, N0MJS and the K0USY Group'
|
||||||
|
__credits__ = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT'
|
||||||
|
__license__ = 'GNU GPLv3'
|
||||||
|
__maintainer__ = 'Cort Buffington, N0MJS'
|
||||||
|
__email__ = 'n0mjs@me.com'
|
||||||
|
|
||||||
|
# Global variables used whether we are a module or __main__
|
||||||
|
systems = {}
|
||||||
|
|
||||||
|
# Timed loop used for reporting HBP status
|
||||||
|
#
|
||||||
|
# REPORT BASED ON THE TYPE SELECTED IN THE MAIN CONFIG FILE
|
||||||
|
def config_reports(_config, _factory):
|
||||||
|
if True: #_config['REPORTS']['REPORT']:
|
||||||
|
def reporting_loop(_logger, _server):
|
||||||
|
_logger.debug('Periodic reporting loop started')
|
||||||
|
_server.send_config()
|
||||||
|
|
||||||
|
logger.info('HBlink TCP reporting server configured')
|
||||||
|
|
||||||
|
report_server = _factory(_config)
|
||||||
|
report_server.clients = []
|
||||||
|
reactor.listenTCP(_config['REPORTS']['REPORT_PORT'], report_server)
|
||||||
|
|
||||||
|
reporting = task.LoopingCall(reporting_loop, logger, report_server)
|
||||||
|
reporting.start(_config['REPORTS']['REPORT_INTERVAL'])
|
||||||
|
|
||||||
|
return report_server
|
||||||
|
|
||||||
|
|
||||||
|
# Shut ourselves down gracefully by disconnecting from the masters and peers.
|
||||||
|
def hblink_handler(_signal, _frame):
|
||||||
|
for system in systems:
|
||||||
|
logger.info('SHUTDOWN: DE-REGISTER SYSTEM: %s', system)
|
||||||
|
systems[system].dereg()
|
||||||
|
|
||||||
|
# Check a supplied ID against the ACL provided. Returns action (True|False) based
|
||||||
|
# on matching and the action specified.
|
||||||
|
def acl_check(_id, _acl):
|
||||||
|
id = int_id(_id)
|
||||||
|
for entry in _acl[1]:
|
||||||
|
if entry[0] <= id <= entry[1]:
|
||||||
|
return _acl[0]
|
||||||
|
return not _acl[0]
|
||||||
|
|
||||||
|
|
||||||
|
#************************************************
|
||||||
|
# OPENBRIDGE CLASS
|
||||||
|
#************************************************
|
||||||
|
|
||||||
|
class OPENBRIDGE(DatagramProtocol):
|
||||||
|
def __init__(self, _name, _config, _report):
|
||||||
|
# Define a few shortcuts to make the rest of the class more readable
|
||||||
|
self._CONFIG = _config
|
||||||
|
self._system = _name
|
||||||
|
self._report = _report
|
||||||
|
self._config = self._CONFIG['SYSTEMS'][self._system]
|
||||||
|
self._laststrid = deque([], 20)
|
||||||
|
|
||||||
|
def dereg(self):
|
||||||
|
logger.info('(%s) is mode OPENBRIDGE. No De-Registration required, continuing shutdown', self._system)
|
||||||
|
|
||||||
|
def send_system(self, _packet):
|
||||||
|
if _packet[:4] == 'DMRD':
|
||||||
|
_packet = _packet[:11] + self._config['NETWORK_ID'] + _packet[15:]
|
||||||
|
_packet += hmac_new(self._config['PASSPHRASE'],_packet,sha1).digest()
|
||||||
|
self.transport.write(_packet, (self._config['TARGET_IP'], self._config['TARGET_PORT']))
|
||||||
|
# KEEP THE FOLLOWING COMMENTED OUT UNLESS YOU'RE DEBUGGING DEEPLY!!!!
|
||||||
|
# logger.debug('(%s) TX Packet to OpenBridge %s:%s -- %s', self._system, self._config['TARGET_IP'], self._config['TARGET_PORT'], ahex(_packet))
|
||||||
|
else:
|
||||||
|
logger.error('(%s) OpenBridge system was asked to send non DMRD packet', self._system)
|
||||||
|
|
||||||
|
def dmrd_received(self, _peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data):
|
||||||
|
pass
|
||||||
|
#print(int_id(_peer_id), int_id(_rf_src), int_id(_dst_id), int_id(_seq), _slot, _call_type, _frame_type, repr(_dtype_vseq), int_id(_stream_id))
|
||||||
|
|
||||||
|
def datagramReceived(self, _packet, _sockaddr):
|
||||||
|
# Keep This Line Commented Unless HEAVILY Debugging!
|
||||||
|
#logger.debug('(%s) RX packet from %s -- %s', self._system, _sockaddr, ahex(_packet))
|
||||||
|
|
||||||
|
if _packet[:4] == 'DMRD': # DMRData -- encapsulated DMR data frame
|
||||||
|
_data = _packet[:53]
|
||||||
|
_hash = _packet[53:]
|
||||||
|
_ckhs = hmac_new(self._config['PASSPHRASE'],_data,sha1).digest()
|
||||||
|
|
||||||
|
if compare_digest(_hash, _ckhs) and _sockaddr == self._config['TARGET_SOCK']:
|
||||||
|
_peer_id = _data[11:15]
|
||||||
|
_seq = _data[4]
|
||||||
|
_rf_src = _data[5:8]
|
||||||
|
_dst_id = _data[8:11]
|
||||||
|
_bits = int_id(_data[15])
|
||||||
|
_slot = 2 if (_bits & 0x80) else 1
|
||||||
|
#_call_type = 'unit' if (_bits & 0x40) else 'group'
|
||||||
|
if _bits & 0x40:
|
||||||
|
_call_type = 'unit'
|
||||||
|
elif (_bits & 0x23) == 0x23:
|
||||||
|
_call_type = 'vcsbk'
|
||||||
|
else:
|
||||||
|
_call_type = 'group'
|
||||||
|
_frame_type = (_bits & 0x30) >> 4
|
||||||
|
_dtype_vseq = (_bits & 0xF) # data, 1=voice header, 2=voice terminator; voice, 0=burst A ... 5=burst F
|
||||||
|
_stream_id = _data[16:20]
|
||||||
|
#logger.debug('(%s) DMRD - Seqence: %s, RF Source: %s, Destination ID: %s', self._system, int_id(_seq), int_id(_rf_src), int_id(_dst_id))
|
||||||
|
|
||||||
|
# Sanity check for OpenBridge -- all calls must be on Slot 1
|
||||||
|
if _slot != 1:
|
||||||
|
logger.error('(%s) OpenBridge packet discarded because it was not received on slot 1. SID: %s, TGID %s', self._system, int_id(_rf_src), int_id(_dst_id))
|
||||||
|
return
|
||||||
|
|
||||||
|
# ACL Processing
|
||||||
|
if self._CONFIG['GLOBAL']['USE_ACL']:
|
||||||
|
if not acl_check(_rf_src, self._CONFIG['GLOBAL']['SUB_ACL']):
|
||||||
|
if _stream_id not in self._laststrid:
|
||||||
|
logger.info('(%s) CALL DROPPED WITH STREAM ID %s FROM SUBSCRIBER %s BY GLOBAL ACL', self._system, int_id(_stream_id), int_id(_rf_src))
|
||||||
|
self._laststrid.append(_stream_id)
|
||||||
|
return
|
||||||
|
if _slot == 1 and not acl_check(_dst_id, self._CONFIG['GLOBAL']['TG1_ACL']):
|
||||||
|
if _stream_id not in self._laststrid:
|
||||||
|
logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY GLOBAL TS1 ACL', self._system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid.append(_stream_id)
|
||||||
|
return
|
||||||
|
if self._config['USE_ACL']:
|
||||||
|
if not acl_check(_rf_src, self._config['SUB_ACL']):
|
||||||
|
if _stream_id not in self._laststrid:
|
||||||
|
logger.info('(%s) CALL DROPPED WITH STREAM ID %s FROM SUBSCRIBER %s BY SYSTEM ACL', self._system, int_id(_stream_id), int_id(_rf_src))
|
||||||
|
self._laststrid.append(_stream_id)
|
||||||
|
return
|
||||||
|
if not acl_check(_dst_id, self._config['TG1_ACL']):
|
||||||
|
if _stream_id not in self._laststrid:
|
||||||
|
logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY SYSTEM ACL', self._system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid.append(_stream_id)
|
||||||
|
return
|
||||||
|
|
||||||
|
# Userland actions -- typically this is the function you subclass for an application
|
||||||
|
self.dmrd_received(_peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data)
|
||||||
|
else:
|
||||||
|
logger.info('(%s) OpenBridge HMAC failed, packet discarded - OPCODE: %s DATA: %s HMAC LENGTH: %s HMAC: %s', self._system, _packet[:4], repr(_packet[:53]), len(_packet[53:]), repr(_packet[53:]))
|
||||||
|
|
||||||
|
|
||||||
|
#************************************************
|
||||||
|
# HB MASTER CLASS
|
||||||
|
#************************************************
|
||||||
|
|
||||||
|
class HBSYSTEM(DatagramProtocol):
|
||||||
|
def __init__(self, _name, _config, _report):
|
||||||
|
# Define a few shortcuts to make the rest of the class more readable
|
||||||
|
self._CONFIG = _config
|
||||||
|
self._system = _name
|
||||||
|
self._report = _report
|
||||||
|
self._config = self._CONFIG['SYSTEMS'][self._system]
|
||||||
|
self._laststrid1 = ''
|
||||||
|
self._laststrid2 = ''
|
||||||
|
|
||||||
|
# Define shortcuts and generic function names based on the type of system we are
|
||||||
|
if self._config['MODE'] == 'MASTER':
|
||||||
|
self._peers = self._CONFIG['SYSTEMS'][self._system]['PEERS']
|
||||||
|
self.send_system = self.send_peers
|
||||||
|
self.maintenance_loop = self.master_maintenance_loop
|
||||||
|
self.datagramReceived = self.master_datagramReceived
|
||||||
|
self.dereg = self.master_dereg
|
||||||
|
|
||||||
|
elif self._config['MODE'] == 'PEER':
|
||||||
|
self._stats = self._config['STATS']
|
||||||
|
self.send_system = self.send_master
|
||||||
|
self.maintenance_loop = self.peer_maintenance_loop
|
||||||
|
self.datagramReceived = self.peer_datagramReceived
|
||||||
|
self.dereg = self.peer_dereg
|
||||||
|
|
||||||
|
def startProtocol(self):
|
||||||
|
# Set up periodic loop for tracking pings from peers. Run every 'PING_TIME' seconds
|
||||||
|
self._system_maintenance = task.LoopingCall(self.maintenance_loop)
|
||||||
|
self._system_maintenance_loop = self._system_maintenance.start(self._CONFIG['GLOBAL']['PING_TIME'])
|
||||||
|
|
||||||
|
# Aliased in __init__ to maintenance_loop if system is a master
|
||||||
|
def master_maintenance_loop(self):
|
||||||
|
logger.debug('(%s) Master maintenance loop started', self._system)
|
||||||
|
remove_list = []
|
||||||
|
for peer in self._peers:
|
||||||
|
_this_peer = self._peers[peer]
|
||||||
|
# Check to see if any of the peers have been quiet (no ping) longer than allowed
|
||||||
|
if _this_peer['LAST_PING']+(self._CONFIG['GLOBAL']['PING_TIME']*self._CONFIG['GLOBAL']['MAX_MISSED']) < time():
|
||||||
|
remove_list.append(peer)
|
||||||
|
for peer in remove_list:
|
||||||
|
logger.info('(%s) Peer %s (%s) has timed out and is being removed', self._system, self._peers[peer]['CALLSIGN'], self._peers[peer]['RADIO_ID'])
|
||||||
|
# Remove any timed out peers from the configuration
|
||||||
|
del self._CONFIG['SYSTEMS'][self._system]['PEERS'][peer]
|
||||||
|
|
||||||
|
# Aliased in __init__ to maintenance_loop if system is a peer
|
||||||
|
def peer_maintenance_loop(self):
|
||||||
|
logger.debug('(%s) Peer maintenance loop started', self._system)
|
||||||
|
if self._stats['PING_OUTSTANDING']:
|
||||||
|
self._stats['NUM_OUTSTANDING'] += 1
|
||||||
|
# If we're not connected, zero out the stats and send a login request RPTL
|
||||||
|
if self._stats['CONNECTION'] != 'YES' or self._stats['NUM_OUTSTANDING'] >= self._CONFIG['GLOBAL']['MAX_MISSED']:
|
||||||
|
self._stats['PINGS_SENT'] = 0
|
||||||
|
self._stats['PINGS_ACKD'] = 0
|
||||||
|
self._stats['NUM_OUTSTANDING'] = 0
|
||||||
|
self._stats['PING_OUTSTANDING'] = False
|
||||||
|
self._stats['CONNECTION'] = 'RPTL_SENT'
|
||||||
|
self.send_master(RPTL + self._config['RADIO_ID'])
|
||||||
|
logger.info('(%s) Sending login request to master %s:%s', self._system, self._config['MASTER_IP'], self._config['MASTER_PORT'])
|
||||||
|
# If we are connected, sent a ping to the master and increment the counter
|
||||||
|
if self._stats['CONNECTION'] == 'YES':
|
||||||
|
self.send_master(RPTPING + self._config['RADIO_ID'])
|
||||||
|
logger.debug('(%s) RPTPING Sent to Master. Total Sent: %s, Total Missed: %s, Currently Outstanding: %s', self._system, self._stats['PINGS_SENT'], self._stats['PINGS_SENT'] - self._stats['PINGS_ACKD'], self._stats['NUM_OUTSTANDING'])
|
||||||
|
self._stats['PINGS_SENT'] += 1
|
||||||
|
self._stats['PING_OUTSTANDING'] = True
|
||||||
|
|
||||||
|
def send_peers(self, _packet):
|
||||||
|
for _peer in self._peers:
|
||||||
|
self.send_peer(_peer, _packet)
|
||||||
|
#logger.debug('(%s) Packet sent to peer %s', self._system, self._peers[_peer]['RADIO_ID'])
|
||||||
|
|
||||||
|
def send_peer(self, _peer, _packet):
|
||||||
|
#if _packet[:4] == 'DMRD':
|
||||||
|
self.transport.write(b''.join([_packet[:11], _peer, _packet[15:]]), self._peers[_peer]['SOCKADDR'])
|
||||||
|
# KEEP THE FOLLOWING COMMENTED OUT UNLESS YOU'RE DEBUGGING DEEPLY!!!!
|
||||||
|
#logger.debug('(%s) TX Packet to %s on port %s: %s', self._peers[_peer]['RADIO_ID'], self._peers[_peer]['IP'], self._peers[_peer]['PORT'], ahex(_packet))
|
||||||
|
|
||||||
|
def send_master(self, _packet):
|
||||||
|
if _packet[:4] == b'DMRD':
|
||||||
|
_packet = _packet[:11] + self._config['RADIO_ID'] + _packet[15:]
|
||||||
|
self.transport.write(_packet, self._config['MASTER_SOCKADDR'])
|
||||||
|
# KEEP THE FOLLOWING COMMENTED OUT UNLESS YOU'RE DEBUGGING DEEPLY!!!!
|
||||||
|
# logger.debug('(%s) TX Packet to %s:%s -- %s', self._system, self._config['MASTER_IP'], self._config['MASTER_PORT'], ahex(_packet))
|
||||||
|
|
||||||
|
def dmrd_received(self, _peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def master_dereg(self):
|
||||||
|
for _peer in self._peers:
|
||||||
|
self.send_peer(_peer, MSTCL + _peer)
|
||||||
|
logger.info('(%s) De-Registration sent to Peer: %s (%s)', self._system, self._peers[_peer]['CALLSIGN'], self._peers[_peer]['RADIO_ID'])
|
||||||
|
|
||||||
|
def peer_dereg(self):
|
||||||
|
self.send_master(RPTCL + self._config['RADIO_ID'])
|
||||||
|
logger.info('(%s) De-Registration sent to Master: %s:%s', self._system, self._config['MASTER_SOCKADDR'][0], self._config['MASTER_SOCKADDR'][1])
|
||||||
|
|
||||||
|
# Aliased in __init__ to datagramReceived if system is a master
|
||||||
|
def master_datagramReceived(self, _data, _sockaddr):
|
||||||
|
# Keep This Line Commented Unless HEAVILY Debugging!
|
||||||
|
# logger.debug('(%s) RX packet from %s -- %s', self._system, _sockaddr, ahex(_data))
|
||||||
|
|
||||||
|
# Extract the command, which is various length, all but one 4 significant characters -- RPTCL
|
||||||
|
_command = _data[:4]
|
||||||
|
|
||||||
|
if _command == b'DMRD': # DMRData -- encapsulated DMR data frame
|
||||||
|
_peer_id = _data[11:15]
|
||||||
|
if _peer_id in self._peers \
|
||||||
|
and self._peers[_peer_id]['CONNECTION'] == 'YES' \
|
||||||
|
and self._peers[_peer_id]['SOCKADDR'] == _sockaddr:
|
||||||
|
_seq = _data[4]
|
||||||
|
_rf_src = _data[5:8]
|
||||||
|
_dst_id = _data[8:11]
|
||||||
|
_bits = int_id(_data[15])
|
||||||
|
_slot = 2 if (_bits & 0x80) else 1
|
||||||
|
#_call_type = 'unit' if (_bits & 0x40) else 'group'
|
||||||
|
if _bits & 0x40:
|
||||||
|
_call_type = 'unit'
|
||||||
|
elif (_bits & 0x23) == 0x23:
|
||||||
|
_call_type = 'vcsbk'
|
||||||
|
else:
|
||||||
|
_call_type = 'group'
|
||||||
|
_frame_type = (_bits & 0x30) >> 4
|
||||||
|
_dtype_vseq = (_bits & 0xF) # data, 1=voice header, 2=voice terminator; voice, 0=burst A ... 5=burst F
|
||||||
|
_stream_id = _data[16:20]
|
||||||
|
#logger.debug('(%s) DMRD - Seqence: %s, RF Source: %s, Destination ID: %s', self._system, int_id(_seq), int_id(_rf_src), int_id(_dst_id))
|
||||||
|
# ACL Processing
|
||||||
|
if self._CONFIG['GLOBAL']['USE_ACL']:
|
||||||
|
if not acl_check(_rf_src, self._CONFIG['GLOBAL']['SUB_ACL']):
|
||||||
|
if self._laststrid != _stream_id:
|
||||||
|
logger.info('(%s) CALL DROPPED WITH STREAM ID %s FROM SUBSCRIBER %s BY GLOBAL ACL', self._system, int_id(_stream_id), int_id(_rf_src))
|
||||||
|
if _slot == 1:
|
||||||
|
self._laststrid1 = _stream_id
|
||||||
|
else:
|
||||||
|
self._laststrid2 = _stream_id
|
||||||
|
return
|
||||||
|
if _slot == 1 and not acl_check(_dst_id, self._CONFIG['GLOBAL']['TG1_ACL']):
|
||||||
|
if self._laststrid1 != _stream_id:
|
||||||
|
logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY GLOBAL TS1 ACL', self._system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid1 = _stream_id
|
||||||
|
return
|
||||||
|
if _slot == 2 and not acl_check(_dst_id, self._CONFIG['GLOBAL']['TG2_ACL']):
|
||||||
|
if self._laststrid2 != _stream_id:
|
||||||
|
logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY GLOBAL TS2 ACL', self._system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid2 = _stream_id
|
||||||
|
return
|
||||||
|
if self._config['USE_ACL']:
|
||||||
|
if not acl_check(_rf_src, self._config['SUB_ACL']):
|
||||||
|
if self._laststrid != _stream_id:
|
||||||
|
logger.info('(%s) CALL DROPPED WITH STREAM ID %s FROM SUBSCRIBER %s BY SYSTEM ACL', self._system, int_id(_stream_id), int_id(_rf_src))
|
||||||
|
if _slot == 1:
|
||||||
|
self._laststrid1 = _stream_id
|
||||||
|
else:
|
||||||
|
self._laststrid2 = _stream_id
|
||||||
|
return
|
||||||
|
if _slot == 1 and not acl_check(_dst_id, self._config['TG1_ACL']):
|
||||||
|
if self._laststrid1 != _stream_id:
|
||||||
|
logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY SYSTEM TS1 ACL', self._system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid1 = _stream_id
|
||||||
|
return
|
||||||
|
if _slot == 2 and not acl_check(_dst_id, self._config['TG2_ACL']):
|
||||||
|
if self._laststrid2 != _stream_id:
|
||||||
|
logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY SYSTEM TS2 ACL', self._system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid2 = _stream_id
|
||||||
|
return
|
||||||
|
|
||||||
|
# The basic purpose of a master is to repeat to the peers
|
||||||
|
if self._config['REPEAT'] == True:
|
||||||
|
pkt = [_data[:11], '', _data[15:]]
|
||||||
|
for _peer in self._peers:
|
||||||
|
if _peer != _peer_id:
|
||||||
|
pkt[1] = _peer
|
||||||
|
self.transport.write(''.join(pkt), self._peers[_peer]['SOCKADDR'])
|
||||||
|
#logger.debug('(%s) Packet on TS%s from %s (%s) for destination ID %s repeated to peer: %s (%s) [Stream ID: %s]', self._system, _slot, self._peers[_peer_id]['CALLSIGN'], int_id(_peer_id), int_id(_dst_id), self._peers[_peer]['CALLSIGN'], int_id(_peer), int_id(_stream_id))
|
||||||
|
|
||||||
|
|
||||||
|
# Userland actions -- typically this is the function you subclass for an application
|
||||||
|
self.dmrd_received(_peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data)
|
||||||
|
|
||||||
|
elif _command == RPTL: # RPTLogin -- a repeater wants to login
|
||||||
|
_peer_id = _data[4:8]
|
||||||
|
# Check to see if we've reached the maximum number of allowed peers
|
||||||
|
if len(self._peers) < self._config['MAX_PEERS']:
|
||||||
|
# Check for valid Radio ID
|
||||||
|
if acl_check(_peer_id, self._CONFIG['GLOBAL']['REG_ACL']) and acl_check(_peer_id, self._config['REG_ACL']):
|
||||||
|
# Build the configuration data strcuture for the peer
|
||||||
|
self._peers.update({_peer_id: {
|
||||||
|
'CONNECTION': 'RPTL-RECEIVED',
|
||||||
|
'CONNECTED': time(),
|
||||||
|
'PINGS_RECEIVED': 0,
|
||||||
|
'LAST_PING': time(),
|
||||||
|
'SOCKADDR': _sockaddr,
|
||||||
|
'IP': _sockaddr[0],
|
||||||
|
'PORT': _sockaddr[1],
|
||||||
|
'SALT': randint(0,0xFFFFFFFF),
|
||||||
|
'RADIO_ID': str(int(ahex(_peer_id), 16)),
|
||||||
|
'CALLSIGN': '',
|
||||||
|
'RX_FREQ': '',
|
||||||
|
'TX_FREQ': '',
|
||||||
|
'TX_POWER': '',
|
||||||
|
'COLORCODE': '',
|
||||||
|
'LATITUDE': '',
|
||||||
|
'LONGITUDE': '',
|
||||||
|
'HEIGHT': '',
|
||||||
|
'LOCATION': '',
|
||||||
|
'DESCRIPTION': '',
|
||||||
|
'SLOTS': '',
|
||||||
|
'URL': '',
|
||||||
|
'SOFTWARE_ID': '',
|
||||||
|
'PACKAGE_ID': '',
|
||||||
|
}})
|
||||||
|
logger.info('(%s) Repeater Logging in with Radio ID: %s, %s:%s', self._system, int_id(_peer_id), _sockaddr[0], _sockaddr[1])
|
||||||
|
_salt_str = hex_str_4(self._peers[_peer_id]['SALT'])
|
||||||
|
self.send_peer(_peer_id, RPTACK + _salt_str)
|
||||||
|
self._peers[_peer_id]['CONNECTION'] = 'CHALLENGE_SENT'
|
||||||
|
logger.info('(%s) Sent Challenge Response to %s for login: %s', self._system, int_id(_peer_id), self._peers[_peer_id]['SALT'])
|
||||||
|
else:
|
||||||
|
self.transport.write(MSTNAK + _peer_id, _sockaddr)
|
||||||
|
logger.warning('(%s) Invalid Login from Radio ID: %s Denied by Registation ACL', self._system, int_id(_peer_id))
|
||||||
|
else:
|
||||||
|
self.transport.write(MSTNAK + _peer_id, _sockaddr)
|
||||||
|
logger.warning('(%s) Registration denied from Radio ID: %s Maximum number of peers exceeded', self._system, int_id(_peer_id))
|
||||||
|
|
||||||
|
elif _command == RPTK: # Repeater has answered our login challenge
|
||||||
|
_peer_id = _data[4:8]
|
||||||
|
if _peer_id in self._peers \
|
||||||
|
and self._peers[_peer_id]['CONNECTION'] == 'CHALLENGE_SENT' \
|
||||||
|
and self._peers[_peer_id]['SOCKADDR'] == _sockaddr:
|
||||||
|
_this_peer = self._peers[_peer_id]
|
||||||
|
_this_peer['LAST_PING'] = time()
|
||||||
|
_sent_hash = _data[8:]
|
||||||
|
_salt_str = hex_str_4(_this_peer['SALT'])
|
||||||
|
_calc_hash = bhex(sha256(_salt_str+self._config['PASSPHRASE']).hexdigest())
|
||||||
|
if _sent_hash == _calc_hash:
|
||||||
|
_this_peer['CONNECTION'] = 'WAITING_CONFIG'
|
||||||
|
self.send_peer(_peer_id, RPTACK + _peer_id)
|
||||||
|
logger.info('(%s) Peer %s has completed the login exchange successfully', self._system, _this_peer['RADIO_ID'])
|
||||||
|
else:
|
||||||
|
logger.info('(%s) Peer %s has FAILED the login exchange successfully', self._system, _this_peer['RADIO_ID'])
|
||||||
|
self.transport.write(MSTNAK + _peer_id, _sockaddr)
|
||||||
|
del self._peers[_peer_id]
|
||||||
|
else:
|
||||||
|
self.transport.write(MSTNAK + _peer_id, _sockaddr)
|
||||||
|
logger.warning('(%s) Login challenge from Radio ID that has not logged in: %s', self._system, int_id(_peer_id))
|
||||||
|
|
||||||
|
elif _command == RPTC: # Repeater is sending it's configuraiton OR disconnecting
|
||||||
|
if _data[:5] == RPTCL: # Disconnect command
|
||||||
|
_peer_id = _data[5:9]
|
||||||
|
if _peer_id in self._peers \
|
||||||
|
and self._peers[_peer_id]['CONNECTION'] == 'YES' \
|
||||||
|
and self._peers[_peer_id]['SOCKADDR'] == _sockaddr:
|
||||||
|
logger.info('(%s) Peer is closing down: %s (%s)', self._system, self._peers[_peer_id]['CALLSIGN'], int_id(_peer_id))
|
||||||
|
self.transport.write(MSTNAK + _peer_id, _sockaddr)
|
||||||
|
del self._peers[_peer_id]
|
||||||
|
|
||||||
|
else:
|
||||||
|
_peer_id = _data[4:8] # Configure Command
|
||||||
|
if _peer_id in self._peers \
|
||||||
|
and self._peers[_peer_id]['CONNECTION'] == 'WAITING_CONFIG' \
|
||||||
|
and self._peers[_peer_id]['SOCKADDR'] == _sockaddr:
|
||||||
|
_this_peer = self._peers[_peer_id]
|
||||||
|
_this_peer['CONNECTION'] = 'YES'
|
||||||
|
_this_peer['CONNECTED'] = time()
|
||||||
|
_this_peer['LAST_PING'] = time()
|
||||||
|
_this_peer['CALLSIGN'] = _data[8:16]
|
||||||
|
_this_peer['RX_FREQ'] = _data[16:25]
|
||||||
|
_this_peer['TX_FREQ'] = _data[25:34]
|
||||||
|
_this_peer['TX_POWER'] = _data[34:36]
|
||||||
|
_this_peer['COLORCODE'] = _data[36:38]
|
||||||
|
_this_peer['LATITUDE'] = _data[38:46]
|
||||||
|
_this_peer['LONGITUDE'] = _data[46:55]
|
||||||
|
_this_peer['HEIGHT'] = _data[55:58]
|
||||||
|
_this_peer['LOCATION'] = _data[58:78]
|
||||||
|
_this_peer['DESCRIPTION'] = _data[78:97]
|
||||||
|
_this_peer['SLOTS'] = _data[97:98]
|
||||||
|
_this_peer['URL'] = _data[98:222]
|
||||||
|
_this_peer['SOFTWARE_ID'] = _data[222:262]
|
||||||
|
_this_peer['PACKAGE_ID'] = _data[262:302]
|
||||||
|
|
||||||
|
self.send_peer(_peer_id, RPTACK + _peer_id)
|
||||||
|
logger.info('(%s) Peer %s (%s) has sent repeater configuration', self._system, _this_peer['CALLSIGN'], _this_peer['RADIO_ID'])
|
||||||
|
else:
|
||||||
|
self.transport.write(MSTNAK + _peer_id, _sockaddr)
|
||||||
|
logger.warning('(%s) Peer info from Radio ID that has not logged in: %s', self._system, int_id(_peer_id))
|
||||||
|
|
||||||
|
elif _command == RPTP: # RPTPing -- peer is pinging us
|
||||||
|
_peer_id = _data[7:11]
|
||||||
|
if _peer_id in self._peers \
|
||||||
|
and self._peers[_peer_id]['CONNECTION'] == "YES" \
|
||||||
|
and self._peers[_peer_id]['SOCKADDR'] == _sockaddr:
|
||||||
|
self._peers[_peer_id]['PINGS_RECEIVED'] += 1
|
||||||
|
self._peers[_peer_id]['LAST_PING'] = time()
|
||||||
|
self.send_peer(_peer_id, MSTPONG + _peer_id)
|
||||||
|
logger.debug('(%s) Received and answered RPTPING from peer %s (%s)', self._system, self._peers[_peer_id]['CALLSIGN'], int_id(_peer_id))
|
||||||
|
else:
|
||||||
|
self.transport.write(MSTNAK + _peer_id, _sockaddr)
|
||||||
|
logger.warning('(%s) Ping from Radio ID that is not logged in: %s', self._system, int_id(_peer_id))
|
||||||
|
|
||||||
|
else:
|
||||||
|
logger.error('(%s) Unrecognized command. Raw HBP PDU: %s', self._system, ahex(_data))
|
||||||
|
|
||||||
|
# Aliased in __init__ to datagramReceived if system is a peer
|
||||||
|
def peer_datagramReceived(self, _data, _sockaddr):
|
||||||
|
# Keep This Line Commented Unless HEAVILY Debugging!
|
||||||
|
# logger.debug('(%s) RX packet from %s -- %s', self._system, _sockaddr, ahex(_data))
|
||||||
|
|
||||||
|
# Validate that we receveived this packet from the master - security check!
|
||||||
|
if self._config['MASTER_SOCKADDR'] == _sockaddr:
|
||||||
|
# Extract the command, which is various length, but only 4 significant characters
|
||||||
|
_command = _data[:4]
|
||||||
|
if _command == b'DMRD': # DMRData -- encapsulated DMR data frame
|
||||||
|
|
||||||
|
_peer_id = _data[11:15]
|
||||||
|
if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation
|
||||||
|
_seq = _data[4:5]
|
||||||
|
_rf_src = _data[5:8]
|
||||||
|
_dst_id = _data[8:11]
|
||||||
|
_bits = _data[15]
|
||||||
|
_slot = 2 if (_bits & 0x80) else 1
|
||||||
|
#_call_type = 'unit' if (_bits & 0x40) else 'group'
|
||||||
|
if _bits & 0x40:
|
||||||
|
_call_type = 'unit'
|
||||||
|
elif (_bits & 0x23) == 0x23:
|
||||||
|
_call_type = 'vcsbk'
|
||||||
|
else:
|
||||||
|
_call_type = 'group'
|
||||||
|
_frame_type = (_bits & 0x30) >> 4
|
||||||
|
_dtype_vseq = (_bits & 0xF) # data, 1=voice header, 2=voice terminator; voice, 0=burst A ... 5=burst F
|
||||||
|
_stream_id = _data[16:20]
|
||||||
|
#logger.debug('(%s) DMRD - Sequence: %s, RF Source: %s, Destination ID: %s', self._system, int_id(_seq), int_id(_rf_src), int_id(_dst_id))
|
||||||
|
|
||||||
|
# ACL Processing
|
||||||
|
if self._CONFIG['GLOBAL']['USE_ACL']:
|
||||||
|
if not acl_check(_rf_src, self._CONFIG['GLOBAL']['SUB_ACL']):
|
||||||
|
if self._laststrid != _stream_id:
|
||||||
|
logger.debug('(%s) CALL DROPPED WITH STREAM ID %s FROM SUBSCRIBER %s BY GLOBAL ACL', self._system, int_id(_stream_id), int_id(_rf_src))
|
||||||
|
if _slot == 1:
|
||||||
|
self._laststrid1 = _stream_id
|
||||||
|
else:
|
||||||
|
self._laststrid2 = _stream_id
|
||||||
|
return
|
||||||
|
if _slot == 1 and not acl_check(_dst_id, self._CONFIG['GLOBAL']['TG1_ACL']):
|
||||||
|
if self._laststrid1 != _stream_id:
|
||||||
|
logger.debug('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY GLOBAL TS1 ACL', self._system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid1 = _stream_id
|
||||||
|
return
|
||||||
|
if _slot == 2 and not acl_check(_dst_id, self._CONFIG['GLOBAL']['TG2_ACL']):
|
||||||
|
if self._laststrid2 != _stream_id:
|
||||||
|
logger.debug('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY GLOBAL TS2 ACL', self._system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid2 = _stream_id
|
||||||
|
return
|
||||||
|
if self._config['USE_ACL']:
|
||||||
|
if not acl_check(_rf_src, self._config['SUB_ACL']):
|
||||||
|
if self._laststrid != _stream_id:
|
||||||
|
logger.debug('(%s) CALL DROPPED WITH STREAM ID %s FROM SUBSCRIBER %s BY SYSTEM ACL', self._system, int_id(_stream_id), int_id(_rf_src))
|
||||||
|
if _slot == 1:
|
||||||
|
self._laststrid1 = _stream_id
|
||||||
|
else:
|
||||||
|
self._laststrid2 = _stream_id
|
||||||
|
return
|
||||||
|
if _slot == 1 and not acl_check(_dst_id, self._config['TG1_ACL']):
|
||||||
|
if self._laststrid1 != _stream_id:
|
||||||
|
logger.debug('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY SYSTEM TS1 ACL', self._system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid1 = _stream_id
|
||||||
|
return
|
||||||
|
if _slot == 2 and not acl_check(_dst_id, self._config['TG2_ACL']):
|
||||||
|
if self._laststrid2 != _stream_id:
|
||||||
|
logger.debug('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY SYSTEM TS2 ACL', self._system, int_id(_stream_id), int_id(_dst_id))
|
||||||
|
self._laststrid2 = _stream_id
|
||||||
|
return
|
||||||
|
|
||||||
|
|
||||||
|
# Userland actions -- typically this is the function you subclass for an application
|
||||||
|
self.dmrd_received(_peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data)
|
||||||
|
|
||||||
|
elif _command == MSTN: # Actually MSTNAK -- a NACK from the master
|
||||||
|
_peer_id = _data[6:10]
|
||||||
|
if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation
|
||||||
|
logger.warning('(%s) MSTNAK Received. Resetting connection to the Master.', self._system)
|
||||||
|
self._stats['CONNECTION'] = 'NO' # Disconnect ourselves and re-register
|
||||||
|
self._stats['CONNECTED'] = time()
|
||||||
|
|
||||||
|
elif _command == RPTA: # Actually RPTACK -- an ACK from the master
|
||||||
|
# Depending on the state, an RPTACK means different things, in each clause, we check and/or set the state
|
||||||
|
if self._stats['CONNECTION'] == 'RPTL_SENT': # If we've sent a login request...
|
||||||
|
_login_int32 = _data[6:10]
|
||||||
|
logger.info('(%s) Repeater Login ACK Received with 32bit ID: %s', self._system, int_id(_login_int32))
|
||||||
|
_pass_hash = sha256(_login_int32+self._config['PASSPHRASE']).hexdigest()
|
||||||
|
_pass_hash = bhex(_pass_hash)
|
||||||
|
self.send_master(RPTK + self._config['RADIO_ID']+_pass_hash)
|
||||||
|
self._stats['CONNECTION'] = 'AUTHENTICATED'
|
||||||
|
|
||||||
|
elif self._stats['CONNECTION'] == 'AUTHENTICATED': # If we've sent the login challenge...
|
||||||
|
_peer_id = _data[6:10]
|
||||||
|
if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation
|
||||||
|
logger.info('(%s) Repeater Authentication Accepted', self._system)
|
||||||
|
_config_packet = self._config['RADIO_ID']+\
|
||||||
|
self._config['CALLSIGN']+\
|
||||||
|
self._config['RX_FREQ']+\
|
||||||
|
self._config['TX_FREQ']+\
|
||||||
|
self._config['TX_POWER']+\
|
||||||
|
self._config['COLORCODE']+\
|
||||||
|
self._config['LATITUDE']+\
|
||||||
|
self._config['LONGITUDE']+\
|
||||||
|
self._config['HEIGHT']+\
|
||||||
|
self._config['LOCATION']+\
|
||||||
|
self._config['DESCRIPTION']+\
|
||||||
|
self._config['SLOTS']+\
|
||||||
|
self._config['URL']+\
|
||||||
|
self._config['SOFTWARE_ID']+\
|
||||||
|
self._config['PACKAGE_ID']
|
||||||
|
|
||||||
|
self.send_master(RPTC + _config_packet)
|
||||||
|
self._stats['CONNECTION'] = 'CONFIG-SENT'
|
||||||
|
logger.info('(%s) Repeater Configuration Sent', self._system)
|
||||||
|
else:
|
||||||
|
self._stats['CONNECTION'] = 'NO'
|
||||||
|
logger.error('(%s) Master ACK Contained wrong ID - Connection Reset', self._system)
|
||||||
|
|
||||||
|
elif self._stats['CONNECTION'] == 'CONFIG-SENT': # If we've sent out configuration to the master
|
||||||
|
_peer_id = _data[6:10]
|
||||||
|
if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation
|
||||||
|
logger.info('(%s) Repeater Configuration Accepted', self._system)
|
||||||
|
if self._config['OPTIONS']:
|
||||||
|
self.send_master(RPTO + self._config['RADIO_ID']+self._config['OPTIONS'])
|
||||||
|
self._stats['CONNECTION'] = 'OPTIONS-SENT'
|
||||||
|
logger.info('(%s) Sent options: (%s)', self._system, self._config['OPTIONS'])
|
||||||
|
else:
|
||||||
|
self._stats['CONNECTION'] = 'YES'
|
||||||
|
self._stats['CONNECTED'] = time()
|
||||||
|
logger.info('(%s) Connection to Master Completed', self._system)
|
||||||
|
else:
|
||||||
|
self._stats['CONNECTION'] = 'NO'
|
||||||
|
logger.error('(%s) Master ACK Contained wrong ID - Connection Reset', self._system)
|
||||||
|
|
||||||
|
elif self._stats['CONNECTION'] == 'OPTIONS-SENT': # If we've sent out options to the master
|
||||||
|
_peer_id = _data[6:10]
|
||||||
|
if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation
|
||||||
|
logger.info('(%s) Repeater Options Accepted', self._system)
|
||||||
|
self._stats['CONNECTION'] = 'YES'
|
||||||
|
self._stats['CONNECTED'] = time()
|
||||||
|
logger.info('(%s) Connection to Master Completed with options', self._system)
|
||||||
|
else:
|
||||||
|
self._stats['CONNECTION'] = 'NO'
|
||||||
|
logger.error('(%s) Master ACK Contained wrong ID - Connection Reset', self._system)
|
||||||
|
|
||||||
|
elif _command == MSTP: # Actually MSTPONG -- a reply to RPTPING (send by peer)
|
||||||
|
_peer_id = _data[7:11]
|
||||||
|
if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation
|
||||||
|
self._stats['PING_OUTSTANDING'] = False
|
||||||
|
self._stats['NUM_OUTSTANDING'] = 0
|
||||||
|
self._stats['PINGS_ACKD'] += 1
|
||||||
|
logger.debug('(%s) MSTPONG Received. Pongs Since Connected: %s', self._system, self._stats['PINGS_ACKD'])
|
||||||
|
|
||||||
|
elif _command == MSTC: # Actually MSTCL -- notify us the master is closing down
|
||||||
|
_peer_id = _data[5:9]
|
||||||
|
if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation
|
||||||
|
self._stats['CONNECTION'] = 'NO'
|
||||||
|
logger.info('(%s) MSTCL Recieved', self._system)
|
||||||
|
|
||||||
|
else:
|
||||||
|
logger.error('(%s) Received an invalid command in packet: %s', self._system, ahex(_data))
|
||||||
|
|
||||||
|
#
|
||||||
|
# Socket-based reporting section
|
||||||
|
#
|
||||||
|
class report(NetstringReceiver):
|
||||||
|
def __init__(self, factory):
|
||||||
|
self._factory = factory
|
||||||
|
|
||||||
|
def connectionMade(self):
|
||||||
|
self._factory.clients.append(self)
|
||||||
|
logger.info('HBlink reporting client connected: %s', self.transport.getPeer())
|
||||||
|
|
||||||
|
def connectionLost(self, reason):
|
||||||
|
logger.info('HBlink reporting client disconnected: %s', self.transport.getPeer())
|
||||||
|
self._factory.clients.remove(self)
|
||||||
|
|
||||||
|
def stringReceived(self, data):
|
||||||
|
self.process_message(data)
|
||||||
|
|
||||||
|
def process_message(self, _message):
|
||||||
|
opcode = _message[:1]
|
||||||
|
if opcode == REPORT_OPCODES['CONFIG_REQ']:
|
||||||
|
logger.info('HBlink reporting client sent \'CONFIG_REQ\': %s', self.transport.getPeer())
|
||||||
|
self.send_config()
|
||||||
|
else:
|
||||||
|
logger.error('got unknown opcode')
|
||||||
|
|
||||||
|
class reportFactory(Factory):
|
||||||
|
def __init__(self, config):
|
||||||
|
self._config = config
|
||||||
|
|
||||||
|
def buildProtocol(self, addr):
|
||||||
|
if (addr.host) in self._config['REPORTS']['REPORT_CLIENTS'] or '*' in self._config['REPORTS']['REPORT_CLIENTS']:
|
||||||
|
logger.debug('Permitting report server connection attempt from: %s:%s', addr.host, addr.port)
|
||||||
|
return report(self)
|
||||||
|
else:
|
||||||
|
logger.error('Invalid report server connection attempt from: %s:%s', addr.host, addr.port)
|
||||||
|
return None
|
||||||
|
|
||||||
|
def send_clients(self, _message):
|
||||||
|
for client in self.clients:
|
||||||
|
client.sendString(_message)
|
||||||
|
|
||||||
|
def send_config(self):
|
||||||
|
serialized = pickle.dumps(self._config['SYSTEMS'], protocol=pickle.HIGHEST_PROTOCOL)
|
||||||
|
self.send_clients(REPORT_OPCODES['CONFIG_SND']+serialized)
|
||||||
|
|
||||||
|
|
||||||
|
# ID ALIAS CREATION
|
||||||
|
# Download
|
||||||
|
def mk_aliases(_config):
|
||||||
|
if _config['ALIASES']['TRY_DOWNLOAD'] == True:
|
||||||
|
# Try updating peer aliases file
|
||||||
|
result = try_download(_config['ALIASES']['PATH'], _config['ALIASES']['PEER_FILE'], _config['ALIASES']['PEER_URL'], _config['ALIASES']['STALE_TIME'])
|
||||||
|
logger.info(result)
|
||||||
|
# Try updating subscriber aliases file
|
||||||
|
result = try_download(_config['ALIASES']['PATH'], _config['ALIASES']['SUBSCRIBER_FILE'], _config['ALIASES']['SUBSCRIBER_URL'], _config['ALIASES']['STALE_TIME'])
|
||||||
|
logger.info(result)
|
||||||
|
|
||||||
|
# Make Dictionaries
|
||||||
|
peer_ids = mk_id_dict(_config['ALIASES']['PATH'], _config['ALIASES']['PEER_FILE'])
|
||||||
|
if peer_ids:
|
||||||
|
logger.info('ID ALIAS MAPPER: peer_ids dictionary is available')
|
||||||
|
|
||||||
|
subscriber_ids = mk_id_dict(_config['ALIASES']['PATH'], _config['ALIASES']['SUBSCRIBER_FILE'])
|
||||||
|
if subscriber_ids:
|
||||||
|
logger.info('ID ALIAS MAPPER: subscriber_ids dictionary is available')
|
||||||
|
|
||||||
|
talkgroup_ids = mk_id_dict(_config['ALIASES']['PATH'], _config['ALIASES']['TGID_FILE'])
|
||||||
|
if talkgroup_ids:
|
||||||
|
logger.info('ID ALIAS MAPPER: talkgroup_ids dictionary is available')
|
||||||
|
|
||||||
|
return peer_ids, subscriber_ids, talkgroup_ids
|
||||||
|
|
||||||
|
#************************************************
|
||||||
|
# MAIN PROGRAM LOOP STARTS HERE
|
||||||
|
#************************************************
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
# Python modules we need
|
||||||
|
import argparse
|
||||||
|
import sys
|
||||||
|
import os
|
||||||
|
import signal
|
||||||
|
|
||||||
|
|
||||||
|
# Change the current directory to the location of the application
|
||||||
|
os.chdir(os.path.dirname(os.path.realpath(sys.argv[0])))
|
||||||
|
|
||||||
|
# CLI argument parser - handles picking up the config file from the command line, and sending a "help" message
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument('-c', '--config', action='store', dest='CONFIG_FILE', help='/full/path/to/config.file (usually hblink.cfg)')
|
||||||
|
parser.add_argument('-l', '--logging', action='store', dest='LOG_LEVEL', help='Override config file logging level.')
|
||||||
|
cli_args = parser.parse_args()
|
||||||
|
|
||||||
|
# Ensure we have a path for the config file, if one wasn't specified, then use the execution directory
|
||||||
|
if not cli_args.CONFIG_FILE:
|
||||||
|
cli_args.CONFIG_FILE = os.path.dirname(os.path.abspath(__file__))+'/hblink.cfg'
|
||||||
|
|
||||||
|
# Call the external routine to build the configuration dictionary
|
||||||
|
CONFIG = config.build_config(cli_args.CONFIG_FILE)
|
||||||
|
|
||||||
|
# Call the external routing to start the system logger
|
||||||
|
if cli_args.LOG_LEVEL:
|
||||||
|
CONFIG['LOGGER']['LOG_LEVEL'] = cli_args.LOG_LEVEL
|
||||||
|
logger = log.config_logging(CONFIG['LOGGER'])
|
||||||
|
logger.info('\n\nCopyright (c) 2013, 2014, 2015, 2016, 2018\n\tThe Founding Members of the K0USY Group. All rights reserved.\n')
|
||||||
|
logger.debug('Logging system started, anything from here on gets logged')
|
||||||
|
|
||||||
|
# Set up the signal handler
|
||||||
|
def sig_handler(_signal, _frame):
|
||||||
|
logger.info('SHUTDOWN: HBLINK IS TERMINATING WITH SIGNAL %s', str(_signal))
|
||||||
|
hblink_handler(_signal, _frame)
|
||||||
|
logger.info('SHUTDOWN: ALL SYSTEM HANDLERS EXECUTED - STOPPING REACTOR')
|
||||||
|
reactor.stop()
|
||||||
|
|
||||||
|
# Set signal handers so that we can gracefully exit if need be
|
||||||
|
for sig in [signal.SIGTERM, signal.SIGINT]:
|
||||||
|
signal.signal(sig, sig_handler)
|
||||||
|
|
||||||
|
peer_ids, subscriber_ids, talkgroup_ids = mk_aliases(CONFIG)
|
||||||
|
|
||||||
|
# INITIALIZE THE REPORTING LOOP
|
||||||
|
report_server = config_reports(CONFIG, reportFactory)
|
||||||
|
|
||||||
|
# HBlink instance creation
|
||||||
|
logger.info('HBlink \'HBlink.py\' -- SYSTEM STARTING...')
|
||||||
|
for system in CONFIG['SYSTEMS']:
|
||||||
|
if CONFIG['SYSTEMS'][system]['ENABLED']:
|
||||||
|
if CONFIG['SYSTEMS'][system]['MODE'] == 'OPENBRIDGE':
|
||||||
|
systems[system] = OPENBRIDGE(system, CONFIG, report_server)
|
||||||
|
else:
|
||||||
|
systems[system] = HBSYSTEM(system, CONFIG, report_server)
|
||||||
|
reactor.listenUDP(CONFIG['SYSTEMS'][system]['PORT'], systems[system], interface=CONFIG['SYSTEMS'][system]['IP'])
|
||||||
|
logger.debug('%s instance created: %s, %s', CONFIG['SYSTEMS'][system]['MODE'], system, systems[system])
|
||||||
|
|
||||||
|
reactor.run()
|
||||||
93
log.py
Executable file
93
log.py
Executable file
@ -0,0 +1,93 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
#
|
||||||
|
###############################################################################
|
||||||
|
# Copyright (C) 2016-2018 Cortney T. Buffington, N0MJS <n0mjs@me.com>
|
||||||
|
#
|
||||||
|
# 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, write to the Free Software Foundation,
|
||||||
|
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
###############################################################################
|
||||||
|
|
||||||
|
'''
|
||||||
|
This is the logging configuration for hblink.py. It changes very infrequently,
|
||||||
|
so keeping in a separate module keeps hblink.py more concise. this file is
|
||||||
|
likely to never change.
|
||||||
|
'''
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from logging.config import dictConfig
|
||||||
|
|
||||||
|
# Does anybody read this stuff? There's a PEP somewhere that says I should do this.
|
||||||
|
__author__ = 'Cortney T. Buffington, N0MJS'
|
||||||
|
__copyright__ = 'Copyright (c) 2016-2018 Cortney T. Buffington, N0MJS and the K0USY Group'
|
||||||
|
__credits__ = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT'
|
||||||
|
__license__ = 'GNU GPLv3'
|
||||||
|
__maintainer__ = 'Cort Buffington, N0MJS'
|
||||||
|
__email__ = 'n0mjs@me.com'
|
||||||
|
|
||||||
|
|
||||||
|
def config_logging(_logger):
|
||||||
|
dictConfig({
|
||||||
|
'version': 1,
|
||||||
|
'disable_existing_loggers': False,
|
||||||
|
'filters': {
|
||||||
|
},
|
||||||
|
'formatters': {
|
||||||
|
'verbose': {
|
||||||
|
'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'
|
||||||
|
},
|
||||||
|
'timed': {
|
||||||
|
'format': '%(levelname)s %(asctime)s %(message)s'
|
||||||
|
},
|
||||||
|
'simple': {
|
||||||
|
'format': '%(levelname)s %(message)s'
|
||||||
|
},
|
||||||
|
'syslog': {
|
||||||
|
'format': '%(name)s (%(process)d): %(levelname)s %(message)s'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
'handlers': {
|
||||||
|
'null': {
|
||||||
|
'class': 'logging.NullHandler'
|
||||||
|
},
|
||||||
|
'console': {
|
||||||
|
'class': 'logging.StreamHandler',
|
||||||
|
'formatter': 'simple'
|
||||||
|
},
|
||||||
|
'console-timed': {
|
||||||
|
'class': 'logging.StreamHandler',
|
||||||
|
'formatter': 'timed'
|
||||||
|
},
|
||||||
|
'file': {
|
||||||
|
'class': 'logging.FileHandler',
|
||||||
|
'formatter': 'simple',
|
||||||
|
'filename': _logger['LOG_FILE'],
|
||||||
|
},
|
||||||
|
'file-timed': {
|
||||||
|
'class': 'logging.FileHandler',
|
||||||
|
'formatter': 'timed',
|
||||||
|
'filename': _logger['LOG_FILE'],
|
||||||
|
},
|
||||||
|
'syslog': {
|
||||||
|
'class': 'logging.handlers.SysLogHandler',
|
||||||
|
'formatter': 'syslog',
|
||||||
|
}
|
||||||
|
},
|
||||||
|
'root': {
|
||||||
|
'handlers': _logger['LOG_HANDLERS'].split(','),
|
||||||
|
'level': _logger['LOG_LEVEL'],
|
||||||
|
'propagate': True,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
return logging.getLogger(_logger['LOG_NAME'])
|
||||||
231
parrot.py
Executable file
231
parrot.py
Executable file
@ -0,0 +1,231 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
#
|
||||||
|
###############################################################################
|
||||||
|
# Copyright (C) 2016-2018 Cortney T. Buffington, N0MJS <n0mjs@me.com> (and Mike Zingman N4IRR)
|
||||||
|
#
|
||||||
|
# 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, write to the Free Software Foundation,
|
||||||
|
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
###############################################################################
|
||||||
|
|
||||||
|
'''
|
||||||
|
'''
|
||||||
|
|
||||||
|
from __future__ import print_function
|
||||||
|
|
||||||
|
# Python modules we need
|
||||||
|
import sys
|
||||||
|
from bitarray import bitarray
|
||||||
|
from time import time, sleep
|
||||||
|
from importlib import import_module
|
||||||
|
|
||||||
|
# Twisted is pretty important, so I keep it separate
|
||||||
|
from twisted.internet.protocol import Factory, Protocol
|
||||||
|
from twisted.protocols.basic import NetstringReceiver
|
||||||
|
from twisted.internet import reactor, task
|
||||||
|
|
||||||
|
# Things we import from the main hblink module
|
||||||
|
from hblink import HBSYSTEM, systems, hblink_handler, reportFactory, REPORT_OPCODES, config_reports, mk_aliases
|
||||||
|
from dmr_utils.utils import hex_str_3, int_id, get_alias
|
||||||
|
from dmr_utils import decode, bptc, const
|
||||||
|
import hb_config
|
||||||
|
import hb_log
|
||||||
|
import hb_const
|
||||||
|
|
||||||
|
# The module needs logging logging, but handlers, etc. are controlled by the parent
|
||||||
|
import logging
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
# Does anybody read this stuff? There's a PEP somewhere that says I should do this.
|
||||||
|
__author__ = 'Cortney T. Buffington, N0MJS and Mike Zingman, N4IRR'
|
||||||
|
__copyright__ = 'Copyright (c) 2016 Cortney T. Buffington, N0MJS and the K0USY Group'
|
||||||
|
__credits__ = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT'
|
||||||
|
__license__ = 'GNU GPLv3'
|
||||||
|
__maintainer__ = 'Cort Buffington, N0MJS'
|
||||||
|
__email__ = 'n0mjs@me.com'
|
||||||
|
__status__ = 'pre-alpha'
|
||||||
|
|
||||||
|
# Module gobal varaibles
|
||||||
|
|
||||||
|
class parrot(HBSYSTEM):
|
||||||
|
|
||||||
|
def __init__(self, _name, _config, _report):
|
||||||
|
HBSYSTEM.__init__(self, _name, _config, _report)
|
||||||
|
|
||||||
|
# Status information for the system, TS1 & TS2
|
||||||
|
# 1 & 2 are "timeslot"
|
||||||
|
# In TX_EMB_LC, 2-5 are burst B-E
|
||||||
|
self.STATUS = {
|
||||||
|
1: {
|
||||||
|
'RX_START': time(),
|
||||||
|
'RX_SEQ': '\x00',
|
||||||
|
'RX_RFS': '\x00',
|
||||||
|
'TX_RFS': '\x00',
|
||||||
|
'RX_STREAM_ID': '\x00',
|
||||||
|
'TX_STREAM_ID': '\x00',
|
||||||
|
'RX_TGID': '\x00\x00\x00',
|
||||||
|
'TX_TGID': '\x00\x00\x00',
|
||||||
|
'RX_TIME': time(),
|
||||||
|
'TX_TIME': time(),
|
||||||
|
'RX_TYPE': hb_const.HBPF_SLT_VTERM,
|
||||||
|
'RX_LC': '\x00',
|
||||||
|
'TX_H_LC': '\x00',
|
||||||
|
'TX_T_LC': '\x00',
|
||||||
|
'TX_EMB_LC': {
|
||||||
|
1: '\x00',
|
||||||
|
2: '\x00',
|
||||||
|
3: '\x00',
|
||||||
|
4: '\x00',
|
||||||
|
}
|
||||||
|
},
|
||||||
|
2: {
|
||||||
|
'RX_START': time(),
|
||||||
|
'RX_SEQ': '\x00',
|
||||||
|
'RX_RFS': '\x00',
|
||||||
|
'TX_RFS': '\x00',
|
||||||
|
'RX_STREAM_ID': '\x00',
|
||||||
|
'TX_STREAM_ID': '\x00',
|
||||||
|
'RX_TGID': '\x00\x00\x00',
|
||||||
|
'TX_TGID': '\x00\x00\x00',
|
||||||
|
'RX_TIME': time(),
|
||||||
|
'TX_TIME': time(),
|
||||||
|
'RX_TYPE': hb_const.HBPF_SLT_VTERM,
|
||||||
|
'RX_LC': '\x00',
|
||||||
|
'TX_H_LC': '\x00',
|
||||||
|
'TX_T_LC': '\x00',
|
||||||
|
'TX_EMB_LC': {
|
||||||
|
1: '\x00',
|
||||||
|
2: '\x00',
|
||||||
|
3: '\x00',
|
||||||
|
4: '\x00',
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
self.CALL_DATA = []
|
||||||
|
|
||||||
|
def dmrd_received(self, _peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data):
|
||||||
|
pkt_time = time()
|
||||||
|
dmrpkt = _data[20:53]
|
||||||
|
_bits = int_id(_data[15])
|
||||||
|
if _call_type == 'group':
|
||||||
|
|
||||||
|
# Is this is a new call stream?
|
||||||
|
if (_stream_id != self.STATUS[_slot]['RX_STREAM_ID']):
|
||||||
|
self.STATUS['RX_START'] = pkt_time
|
||||||
|
logger.info('(%s) *CALL START* STREAM ID: %s SUB: %s (%s) REPEATER: %s (%s) TGID %s (%s), TS %s', \
|
||||||
|
self._system, int_id(_stream_id), get_alias(_rf_src, subscriber_ids), int_id(_rf_src), get_alias(_peer_id, peer_ids), int_id(_peer_id), get_alias(_dst_id, talkgroup_ids), int_id(_dst_id), _slot)
|
||||||
|
|
||||||
|
|
||||||
|
# Final actions - Is this a voice terminator?
|
||||||
|
if (_frame_type == hb_const.HBPF_DATA_SYNC) and (_dtype_vseq == hb_const.HBPF_SLT_VTERM) and (self.STATUS[_slot]['RX_TYPE'] != hb_const.HBPF_SLT_VTERM):
|
||||||
|
call_duration = pkt_time - self.STATUS['RX_START']
|
||||||
|
logger.info('(%s) *CALL END* STREAM ID: %s SUB: %s (%s) REPEATER: %s (%s) TGID %s (%s), TS %s, Duration: %s', \
|
||||||
|
self._system, int_id(_stream_id), get_alias(_rf_src, subscriber_ids), int_id(_rf_src), get_alias(_peer_id, peer_ids), int_id(_peer_id), get_alias(_dst_id, talkgroup_ids), int_id(_dst_id), _slot, call_duration)
|
||||||
|
self.CALL_DATA.append(_data)
|
||||||
|
sleep(2)
|
||||||
|
logger.info('(%s) Playing back transmission from subscriber: %s', self._system, int_id(_rf_src))
|
||||||
|
for i in self.CALL_DATA:
|
||||||
|
self.send_system(i)
|
||||||
|
sleep(0.06)
|
||||||
|
self.CALL_DATA = []
|
||||||
|
|
||||||
|
else:
|
||||||
|
if not self.CALL_DATA:
|
||||||
|
logger.info('(%s) Receiving transmission to be played back from subscriber: %s', self._system, int_id(_rf_src))
|
||||||
|
self.CALL_DATA.append(_data)
|
||||||
|
|
||||||
|
|
||||||
|
# Mark status variables for use later
|
||||||
|
self.STATUS[_slot]['RX_RFS'] = _rf_src
|
||||||
|
self.STATUS[_slot]['RX_TYPE'] = _dtype_vseq
|
||||||
|
self.STATUS[_slot]['RX_TGID'] = _dst_id
|
||||||
|
self.STATUS[_slot]['RX_TIME'] = pkt_time
|
||||||
|
self.STATUS[_slot]['RX_STREAM_ID'] = _stream_id
|
||||||
|
|
||||||
|
|
||||||
|
#************************************************
|
||||||
|
# MAIN PROGRAM LOOP STARTS HERE
|
||||||
|
#************************************************
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import sys
|
||||||
|
import os
|
||||||
|
import signal
|
||||||
|
from dmr_utils.utils import try_download, mk_id_dict
|
||||||
|
|
||||||
|
# Change the current directory to the location of the application
|
||||||
|
os.chdir(os.path.dirname(os.path.realpath(sys.argv[0])))
|
||||||
|
|
||||||
|
# CLI argument parser - handles picking up the config file from the command line, and sending a "help" message
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument('-c', '--config', action='store', dest='CONFIG_FILE', help='/full/path/to/config.file (usually hblink.cfg)')
|
||||||
|
parser.add_argument('-l', '--logging', action='store', dest='LOG_LEVEL', help='Override config file logging level.')
|
||||||
|
cli_args = parser.parse_args()
|
||||||
|
|
||||||
|
# Ensure we have a path for the config file, if one wasn't specified, then use the default (top of file)
|
||||||
|
if not cli_args.CONFIG_FILE:
|
||||||
|
cli_args.CONFIG_FILE = os.path.dirname(os.path.abspath(__file__))+'/hblink.cfg'
|
||||||
|
|
||||||
|
# Call the external routine to build the configuration dictionary
|
||||||
|
CONFIG = hb_config.build_config(cli_args.CONFIG_FILE)
|
||||||
|
|
||||||
|
# Start the system logger
|
||||||
|
if cli_args.LOG_LEVEL:
|
||||||
|
CONFIG['LOGGER']['LOG_LEVEL'] = cli_args.LOG_LEVEL
|
||||||
|
logger = hb_log.config_logging(CONFIG['LOGGER'])
|
||||||
|
logger.info('\n\nCopyright (c) 2013, 2014, 2015, 2016, 2018\n\tThe Founding Members of the K0USY Group. All rights reserved.\n')
|
||||||
|
logger.debug('Logging system started, anything from here on gets logged')
|
||||||
|
|
||||||
|
# Set up the signal handler
|
||||||
|
def sig_handler(_signal, _frame):
|
||||||
|
logger.info('SHUTDOWN: HBROUTER IS TERMINATING WITH SIGNAL %s', str(_signal))
|
||||||
|
hblink_handler(_signal, _frame)
|
||||||
|
logger.info('SHUTDOWN: ALL SYSTEM HANDLERS EXECUTED - STOPPING REACTOR')
|
||||||
|
reactor.stop()
|
||||||
|
|
||||||
|
# Set signal handers so that we can gracefully exit if need be
|
||||||
|
for sig in [signal.SIGTERM, signal.SIGINT]:
|
||||||
|
signal.signal(sig, sig_handler)
|
||||||
|
|
||||||
|
# ID ALIAS CREATION
|
||||||
|
# Download
|
||||||
|
if CONFIG['ALIASES']['TRY_DOWNLOAD'] == True:
|
||||||
|
# Try updating peer aliases file
|
||||||
|
result = try_download(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['PEER_FILE'], CONFIG['ALIASES']['PEER_URL'], CONFIG['ALIASES']['STALE_TIME'])
|
||||||
|
logger.info(result)
|
||||||
|
# Try updating subscriber aliases file
|
||||||
|
result = try_download(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['SUBSCRIBER_FILE'], CONFIG['ALIASES']['SUBSCRIBER_URL'], CONFIG['ALIASES']['STALE_TIME'])
|
||||||
|
logger.info(result)
|
||||||
|
|
||||||
|
# Create the name-number mapping dictionaries
|
||||||
|
peer_ids, subscriber_ids, talkgroup_ids = mk_aliases(CONFIG)
|
||||||
|
|
||||||
|
# INITIALIZE THE REPORTING LOOP
|
||||||
|
report_server = config_reports(CONFIG, reportFactory)
|
||||||
|
|
||||||
|
# HBlink instance creation
|
||||||
|
logger.info('HBlink \'hb_parrot.py\' (c) 2017 Mike Zingman, N4IRR -- SYSTEM STARTING...')
|
||||||
|
for system in CONFIG['SYSTEMS']:
|
||||||
|
if CONFIG['SYSTEMS'][system]['ENABLED']:
|
||||||
|
if CONFIG['SYSTEMS'][system]['MODE'] == 'OPENBRIDGE':
|
||||||
|
logger.critical('%s FATAL: Instance is mode \'OPENBRIDGE\', \n\t\t...Which would be tragic for parrot, since it carries multiple call\n\t\tstreams simultaneously. hb_parrot.py onlyl works with MMDVM-based systems', system)
|
||||||
|
sys.exit('hb_parrot.py cannot function with systems that are not MMDVM devices. System {} is configured as an OPENBRIDGE'.format(system))
|
||||||
|
else:
|
||||||
|
systems[system] = parrot(system, CONFIG, report_server)
|
||||||
|
reactor.listenUDP(CONFIG['SYSTEMS'][system]['PORT'], systems[system], interface=CONFIG['SYSTEMS'][system]['IP'])
|
||||||
|
logger.debug('%s instance created: %s, %s', CONFIG['SYSTEMS'][system]['MODE'], system, systems[system])
|
||||||
|
|
||||||
|
reactor.run()
|
||||||
5591
peer_ids.csv
Normal file
5591
peer_ids.csv
Normal file
File diff suppressed because it is too large
Load Diff
30
reporting_const.py
Executable file
30
reporting_const.py
Executable file
@ -0,0 +1,30 @@
|
|||||||
|
###############################################################################
|
||||||
|
# Copyright (C) 2018 Cortney T. Buffington, N0MJS <n0mjs@me.com>
|
||||||
|
#
|
||||||
|
# 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, write to the Free Software Foundation,
|
||||||
|
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
###############################################################################
|
||||||
|
|
||||||
|
# Opcodes for the network-based reporting protocol
|
||||||
|
|
||||||
|
REPORT_OPCODES = {
|
||||||
|
'CONFIG_REQ': b'\x00',
|
||||||
|
'CONFIG_SND': b'\x01',
|
||||||
|
'BRIDGE_REQ': b'\x02',
|
||||||
|
'BRIDGE_SND': b'\x03',
|
||||||
|
'CONFIG_UPD': b'\x04',
|
||||||
|
'BRIDGE_UPD': b'\x05',
|
||||||
|
'LINK_EVENT': b'\x06',
|
||||||
|
'BRDG_EVENT': b'\x07',
|
||||||
|
}
|
||||||
4
requirements.txt
Executable file
4
requirements.txt
Executable file
@ -0,0 +1,4 @@
|
|||||||
|
bitstring>=3.1.5
|
||||||
|
bitarray>=0.8.1
|
||||||
|
Twisted>=16.3.0
|
||||||
|
dmr_utils3>=0.1.19
|
||||||
21
rules.py
Normal file
21
rules.py
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
'''
|
||||||
|
THIS EXAMPLE WILL NOT WORK AS IT IS - YOU MUST SPECIFY YOUR OWN VALUES!!!
|
||||||
|
|
||||||
|
|
||||||
|
'''
|
||||||
|
|
||||||
|
BRIDGES = {
|
||||||
|
'KANSAS': [
|
||||||
|
{'SYSTEM': 'PLYMOUTH', 'TS': 2, 'TGID': 3120, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [2,], 'OFF': [9,]},
|
||||||
|
],
|
||||||
|
'BYRG': [
|
||||||
|
{'SYSTEM': 'PLYMOUTH', 'TS': 1, 'TGID': 3100, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [3,], 'OFF': [8,]},
|
||||||
|
],
|
||||||
|
'ENGLISH': [
|
||||||
|
{'SYSTEM': 'PLYMOUTH', 'TS': 1, 'TGID': 13, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [4,], 'OFF': [7,]},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
from pprint import pprint
|
||||||
|
pprint(BRIDGES)
|
||||||
50
rules_SAMPLE.py
Executable file
50
rules_SAMPLE.py
Executable file
@ -0,0 +1,50 @@
|
|||||||
|
'''
|
||||||
|
THIS EXAMPLE WILL NOT WORK AS IT IS - YOU MUST SPECIFY YOUR OWN VALUES!!!
|
||||||
|
|
||||||
|
This file is organized around the "Conference Bridges" that you wish to use. If you're a c-Bridge
|
||||||
|
person, think of these as "bridge groups". You might also liken them to a "reflector". If a particular
|
||||||
|
system is "ACTIVE" on a particular conference bridge, any traffid from that system will be sent
|
||||||
|
to any other system that is active on the bridge as well. This is not an "end to end" method, because
|
||||||
|
each system must independently be activated on the bridge.
|
||||||
|
|
||||||
|
The first level (e.g. "WORLDWIDE" or "STATEWIDE" in the examples) is the name of the conference
|
||||||
|
bridge. This is any arbitrary ASCII text string you want to use. Under each conference bridge
|
||||||
|
definition are the following items -- one line for each HBSystem as defined in the main HBlink
|
||||||
|
configuration file.
|
||||||
|
|
||||||
|
* SYSTEM - The name of the sytem as listed in the main hblink configuration file (e.g. hblink.cfg)
|
||||||
|
This MUST be the exact same name as in the main config file!!!
|
||||||
|
* TS - Timeslot used for matching traffic to this confernce bridge
|
||||||
|
* TGID - Talkgroup ID used for matching traffic to this conference bridge
|
||||||
|
* ON and OFF are LISTS of Talkgroup IDs used to trigger this system off and on. Even if you
|
||||||
|
only want one (as shown in the ON example), it has to be in list format. None can be
|
||||||
|
handled with an empty list, such as " 'ON': [] ".
|
||||||
|
* TO_TYPE is timeout type. If you want to use timers, ON means when it's turned on, it will
|
||||||
|
turn off afer the timout period and OFF means it will turn back on after the timout
|
||||||
|
period. If you don't want to use timers, set it to anything else, but 'NONE' might be
|
||||||
|
a good value for documentation!
|
||||||
|
* TIMOUT is a value in minutes for the timout timer. No, I won't make it 'seconds', so don't
|
||||||
|
ask. Timers are performance "expense".
|
||||||
|
* RESET is a list of Talkgroup IDs that, in addition to the ON and OFF lists will cause a running
|
||||||
|
timer to be reset. This is useful if you are using different TGIDs for voice traffic than
|
||||||
|
triggering. If you are not, there is NO NEED to use this feature.
|
||||||
|
'''
|
||||||
|
|
||||||
|
BRIDGES = {
|
||||||
|
'WORLDWIDE': [
|
||||||
|
{'SYSTEM': 'MASTER-1', 'TS': 1, 'TGID': 1, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'ON', 'ON': [2,], 'OFF': [9,10], 'RESET': []},
|
||||||
|
{'SYSTEM': 'CLIENT-1', 'TS': 1, 'TGID': 3100, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'ON', 'ON': [2,], 'OFF': [9,10], 'RESET': []},
|
||||||
|
],
|
||||||
|
'ENGLISH': [
|
||||||
|
{'SYSTEM': 'MASTER-1', 'TS': 1, 'TGID': 13, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [3,], 'OFF': [8,10], 'RESET': []},
|
||||||
|
{'SYSTEM': 'CLIENT-2', 'TS': 1, 'TGID': 13, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [3,], 'OFF': [8,10], 'RESET': []},
|
||||||
|
],
|
||||||
|
'STATEWIDE': [
|
||||||
|
{'SYSTEM': 'MASTER-1', 'TS': 2, 'TGID': 3129, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [4,], 'OFF': [7,10], 'RESET': []},
|
||||||
|
{'SYSTEM': 'CLIENT-2', 'TS': 2, 'TGID': 3129, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [4,], 'OFF': [7,10], 'RESET': []},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
from pprint import pprint
|
||||||
|
pprint(BRIDGES)
|
||||||
116858
subscriber_ids.csv
Normal file
116858
subscriber_ids.csv
Normal file
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user