commit 4664798ec35a10aa8f1a75a8a0f31b413fc56264 Author: LX3JL Date: Tue Dec 29 23:45:47 2015 +0100 Initial import diff --git a/license.txt b/license.txt new file mode 100644 index 0000000..3d90694 --- /dev/null +++ b/license.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. \ No newline at end of file diff --git a/src/cbuffer.cpp b/src/cbuffer.cpp new file mode 100644 index 0000000..879ba8d --- /dev/null +++ b/src/cbuffer.cpp @@ -0,0 +1,125 @@ +// +// cbuffer.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 02/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include +#include "cprotocol.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CBuffer::CBuffer(uint8 *buffer, int len) +{ + resize(len); + ::memcpy(data(), buffer, len); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// set + +void CBuffer::Set(uint8 *buffer, int len) +{ + resize(len); + ::memcpy(data(), buffer, len); +} + +void CBuffer::Set(const char *sz) +{ + resize(::strlen(sz)+1); + ::strcpy((char *)data(), sz); +} + +void CBuffer::Append(uint8 *buffer, int len) +{ + int n = (int)size(); + resize(n+len); + ::memcpy(&(data()[n]), buffer, len); +} + +void CBuffer::Append(uint8 ui, int len) +{ + int n = (int)size(); + resize(n+len); + ::memset(&(data()[n]), ui, len); +} + +void CBuffer::Append(uint8 ui) +{ + int n = (int)size(); + resize(n+sizeof(uint8)); + ::memcpy(&(data()[n]), &ui, sizeof(uint8)); +} + +void CBuffer::Append(uint16 ui) +{ + int n = (int)size(); + resize(n+sizeof(uint16)); + ::memcpy(&(data()[n]), &ui, sizeof(uint16)); +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// operation + +int CBuffer::Compare(uint8 *buffer, int len) const +{ + int result = -1; + if ( size() >= len ) + { + result = ::memcmp(data(), buffer, len); + } + return result; +} + +int CBuffer::Compare(uint8 *buffer, int off, int len) const +{ + int result = -1; + if ( size() >= (off+len) ) + { + result = ::memcmp(&(data()[off]), buffer, len); + } + return result; +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// operator + +bool CBuffer::operator ==(const CBuffer &Buffer) const +{ + if ( size() == Buffer.size() ) + { + return (::memcmp((const char *)data(), (const char *)Buffer.data(), size()) == 0); + } + return false; +} + +bool CBuffer::operator ==(const char *sz) const +{ + if ( size() == ::strlen(sz) ) + { + return (::memcmp((const char *)data(), sz, size()) == 0); + } + return false; +} diff --git a/src/cbuffer.h b/src/cbuffer.h new file mode 100644 index 0000000..5f1b08d --- /dev/null +++ b/src/cbuffer.h @@ -0,0 +1,59 @@ +// +// cbuffer.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 02/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cbuffer_h +#define cbuffer_h + +//////////////////////////////////////////////////////////////////////////////////////// + +class CBuffer : public std::vector +{ +public: + // constructor + CBuffer() {}; + CBuffer(uint8 *, int); + + // destructor + virtual ~CBuffer() {}; + + // set + void Set(uint8 *, int); + void Set(const char *); + void Append(uint8 *, int); + void Append(uint8, int); + void Append(uint8); + void Append(uint16); + + // operation + int Compare(uint8 *, int) const; + int Compare(uint8 *, int, int) const; + + + // operator + bool operator ==(const CBuffer &) const; + bool operator ==(const char *) const; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cbuffer_h */ diff --git a/src/ccallsign.cpp b/src/ccallsign.cpp new file mode 100644 index 0000000..29fc27c --- /dev/null +++ b/src/ccallsign.cpp @@ -0,0 +1,267 @@ +// +// ccallsign.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include +#include +#include "ccallsign.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// constructors + +CCallsign::CCallsign() +{ + // blank all + ::memset(m_Callsign, ' ', sizeof(m_Callsign)); + ::memset(m_Suffix, ' ', sizeof(m_Suffix)); + m_Module = ' '; +} + +CCallsign::CCallsign(const char *sz) +{ + // blank all + ::memset(m_Callsign, ' ', sizeof(m_Callsign)); + ::memset(m_Suffix, ' ', sizeof(m_Suffix)); + m_Module = ' '; + // and copy + ::memcpy(m_Callsign, sz, MIN(strlen(sz), sizeof(m_Callsign)-1)); + if ( strlen(sz) >= sizeof(m_Callsign) ) + { + m_Module = sz[sizeof(m_Callsign)-1]; + } +} + +CCallsign::CCallsign(const CCallsign &callsign) +{ + ::memcpy(m_Callsign, callsign.m_Callsign, sizeof(m_Callsign)); + ::memcpy(m_Suffix, callsign.m_Suffix, sizeof(m_Suffix)); + m_Module = callsign.m_Module; +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// status + +bool CCallsign::IsValid(void) const +{ + bool valid = true; + int i; + + // callsign + // first 3 chars are letter or number but cannot be all number + int iNum = 0; + for ( i = 0; i < 3; i++ ) + { + valid &= IsLetter(m_Callsign[i]) || IsNumber(m_Callsign[i]); + if ( IsNumber(m_Callsign[i]) ) + { + iNum++; + } + } + valid &= (iNum < 3); + // all remaining char are letter, number or space + for ( ; i < CALLSIGN_LEN; i++) + { + valid &= IsLetter(m_Callsign[i]) || IsNumber(m_Callsign[i]) || IsSpace(m_Callsign[i]); + } + + // prefix + // all chars are number, uppercase or space + for ( i = 0; i < CALLSUFFIX_LEN; i++ ) + { + valid &= IsLetter(m_Suffix[i]) || IsNumber(m_Suffix[i]) || IsSpace(m_Suffix[i]); + } + + // module + // is an letter or space + valid &= IsLetter(m_Module) || IsSpace(m_Module); + + // done + return valid; +} + +bool CCallsign::HasSuffix(void) const +{ + bool has = false; + for ( int i = 0; i < CALLSUFFIX_LEN; i++ ) + { + has |= (m_Suffix[i] != ' '); + } + return has; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// set + +void CCallsign::SetCallsign(const char *sz) +{ + ::memset(m_Callsign, ' ', sizeof(m_Callsign)); + m_Module = ' '; + ::memcpy(m_Callsign, sz, MIN(strlen(sz), sizeof(m_Callsign)-1)); + if ( strlen(sz) >= sizeof(m_Callsign) ) + { + m_Module = sz[sizeof(m_Callsign)-1]; + } +} + +void CCallsign::SetCallsign(const uint8 *buffer, int len) +{ + ::memset(m_Callsign, ' ', sizeof(m_Callsign)); + m_Module = ' '; + ::memcpy(m_Callsign, buffer, MIN(len, sizeof(m_Callsign)-1)); + for ( int i = 0; i < sizeof(m_Callsign); i++ ) + { + if ( m_Callsign[i] == 0 ) + { + m_Callsign[i] = ' '; + } + } + if ( (len >= sizeof(m_Callsign)) && ((char)buffer[sizeof(m_Callsign)-1] != 0) ) + { + m_Module = (char)buffer[sizeof(m_Callsign)-1]; + } +} + +void CCallsign::SetModule(char c) +{ + m_Module = c; +} + + +void CCallsign::SetSuffix(const char *sz) +{ + ::memset(m_Suffix, ' ', sizeof(m_Suffix)); + ::memcpy(m_Suffix, sz, MIN(strlen(sz), sizeof(m_Suffix))); +} + +void CCallsign::SetSuffix(const uint8 *buffer, int len) +{ + len = MIN(len, sizeof(m_Suffix)); + ::memset(m_Suffix, ' ', sizeof(m_Suffix)); + ::memcpy(m_Suffix, buffer, len); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// modify + +void CCallsign::PatchCallsign(int off, const uint8 *patch, int len) +{ + if ( off < sizeof(m_Callsign) ) + { + ::memcpy(m_Callsign, patch, MIN(len, sizeof(m_Callsign) - off)); + } +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// get + +void CCallsign::GetCallsign(uint8 *buffer) const +{ + ::memcpy(buffer, m_Callsign, sizeof(m_Callsign)); + if ( HasModule() ) + { + buffer[sizeof(m_Callsign)-1] = m_Module; + } +} + +void CCallsign::GetCallsignString(char *sz) const +{ + int i; + for ( i = 0; (i < sizeof(m_Callsign)) && (m_Callsign[i] != ' '); i++ ) + { + sz[i] = m_Callsign[i]; + } + sz[i] = 0; +} + +void CCallsign::GetSuffix(uint8 *buffer) const +{ + ::memcpy(buffer, m_Suffix, sizeof(m_Suffix)); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// compare +bool CCallsign::HasSameCallsign(const CCallsign &Callsign) const +{ + return (::memcmp(m_Callsign, Callsign.m_Callsign, sizeof(m_Callsign)) == 0); +} + +bool CCallsign::HasSameModule(const CCallsign &Callsign) const +{ + return (m_Module == Callsign.m_Module); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// operators + +bool CCallsign::operator ==(const CCallsign &callsign) const +{ + return ((::memcmp(callsign.m_Callsign, m_Callsign, sizeof(m_Callsign)) == 0) && + (m_Module == callsign.m_Module) && + (::memcmp(callsign.m_Suffix, m_Suffix, sizeof(m_Suffix)) == 0)); +} + +CCallsign::operator const char *() const +{ + char *sz = (char *)(const char *)m_sz; + + // empty + ::memset(sz, 0, sizeof(m_sz)); + // callsign + sz[CALLSIGN_LEN] = 0; + ::memcpy(sz, m_Callsign, sizeof(m_Callsign)); + // module + if ( HasModule() ) + { + sz[sizeof(m_Callsign)] = m_Module; + } + // suffix + if ( HasSuffix() ) + { + ::strcat(sz, " / "); + ::strncat(sz, m_Suffix, sizeof(m_Suffix)); + } + + // done + return m_sz; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// helper + +bool CCallsign::IsNumber(char c) const +{ + return ((c >= '0') && (c <= '9')); +} + +bool CCallsign::IsLetter(char c) const +{ + return ((c >= 'A') && (c <= 'Z')); +} + +bool CCallsign::IsSpace(char c) const +{ + return (c == ' '); +} diff --git a/src/ccallsign.h b/src/ccallsign.h new file mode 100644 index 0000000..51de462 --- /dev/null +++ b/src/ccallsign.h @@ -0,0 +1,93 @@ +// +// ccallsign.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef ccallsign_h +#define ccallsign_h + +//////////////////////////////////////////////////////////////////////////////////////// +// define + +#define CALLSIGN_LEN 8 +#define CALLSUFFIX_LEN 4 + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CCallsign +{ +public: + // contructors + CCallsign(); + CCallsign(const char *); + CCallsign(const CCallsign &); + + // destructor + virtual ~CCallsign() {}; + + // status + bool IsValid(void) const; + bool HasSuffix(void) const; + bool HasModule(void) const { return m_Module != ' '; } + + // set + void SetCallsign(const char *); + void SetCallsign(const uint8 *, int); + void SetModule(char); + void SetSuffix(const char *); + void SetSuffix(const uint8 *, int); + + // modify + void PatchCallsign(int, const uint8 *, int); + + // get + void GetCallsign(uint8 *) const; + void GetCallsignString(char *) const; + void GetSuffix(uint8 *) const; + char GetModule(void) const { return m_Module; } + + // compare + bool HasSameCallsign(const CCallsign &) const; + bool HasSameModule(const CCallsign &) const; + + // operators + bool operator ==(const CCallsign &) const; + operator const char *() const; + +protected: + // helper + bool IsNumber(char) const; + bool IsLetter(char) const; + bool IsSpace(char) const; + +protected: + // data + char m_Callsign[CALLSIGN_LEN]; + char m_Suffix[CALLSUFFIX_LEN]; + char m_Module; + char m_sz[CALLSIGN_LEN+CALLSUFFIX_LEN+5]; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* ccallsign_h */ diff --git a/src/cclient.cpp b/src/cclient.cpp new file mode 100644 index 0000000..f559cb3 --- /dev/null +++ b/src/cclient.cpp @@ -0,0 +1,121 @@ +// +// cclient.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include +#include "cclient.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructors + +CClient::CClient() +{ + m_ReflectorModule = ' '; + m_ModuleMastered = ' '; + m_LastKeepaliveTime.Now(); + m_ConnectTime = std::time(NULL); + m_LastHeardTime = std::time(NULL); +} + +CClient::CClient(const CCallsign &callsign, const CIp &ip, char reflectorModule) +{ + m_ReflectorModule = reflectorModule; + m_Callsign = callsign; + m_Ip = ip; + m_ModuleMastered = ' '; + m_LastKeepaliveTime.Now(); + m_ConnectTime = std::time(NULL); + m_LastHeardTime = std::time(NULL); +} + +CClient::CClient(const CClient &client) +{ + m_Callsign = client.m_Callsign; + m_Ip = client.m_Ip; + m_ReflectorModule = client.m_ReflectorModule; + m_ModuleMastered = client.m_ModuleMastered; + m_LastKeepaliveTime = client.m_LastKeepaliveTime; + m_ConnectTime = client.m_ConnectTime; + m_LastHeardTime = client.m_LastHeardTime; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// status + +void CClient::Alive(void) +{ + m_LastKeepaliveTime.Now();; +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// operators + +bool CClient::operator ==(const CClient &client) const +{ + return ((client.m_Callsign == m_Callsign) && + (client.m_Ip == m_Ip)); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// reporting + +void CClient::WriteXml(std::ofstream &xmlFile) +{ + xmlFile << "" << std::endl; + xmlFile << "\t" << m_Callsign << "" << std::endl; + xmlFile << "\t" << m_Ip << "" << std::endl; + xmlFile << "\t" << m_ReflectorModule << "" << std::endl; + xmlFile << "\t" << GetProtocolName() << "" << std::endl; + char mbstr[100]; + if (std::strftime(mbstr, sizeof(mbstr), "%A %c", std::localtime(&m_ConnectTime))) + { + xmlFile << "\t" << mbstr << "" << std::endl; + } + if (std::strftime(mbstr, sizeof(mbstr), "%A %c", std::localtime(&m_LastHeardTime))) + { + xmlFile << "\t" << mbstr << "" << std::endl; + } + xmlFile << "" << std::endl; +} + +void CClient::GetJsonObject(char *Buffer) +{ + char sz[512]; + char mbstr[100]; + char cs[16]; + + if (std::strftime(mbstr, sizeof(mbstr), "%A %c", std::localtime(&m_LastHeardTime))) + { + m_Callsign.GetCallsignString(cs); + + ::sprintf(sz, "{\"callsign\":\"%s\",\"module\":\"%c\",\"linkedto\":\"%c\",\"time\":\"%s\"}", + cs, + m_Callsign.GetModule(), + m_ReflectorModule, + mbstr); + ::strcat(Buffer, sz); + } +} diff --git a/src/cclient.h b/src/cclient.h new file mode 100644 index 0000000..1106c76 --- /dev/null +++ b/src/cclient.h @@ -0,0 +1,96 @@ +// +// cclient.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cclient_h +#define cclient_h + +#include "ctimepoint.h" +#include "cip.h" +#include "ccallsign.h" +#include "cbuffer.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CClient +{ +public: + // constructors + CClient(); + CClient(const CCallsign &, const CIp &, char = ' '); + CClient(const CClient &); + + // destructor + virtual ~CClient() {}; + + // operators + bool operator ==(const CClient &) const; + + // get + const CCallsign &GetCallsign(void) const { return m_Callsign; } + const CIp &GetIp(void) const { return m_Ip; } + bool HasModule(void) const { return m_Callsign.HasModule(); } + char GetModule(void) const { return m_Callsign.GetModule(); } + char GetReflectorModule(void) const { return m_ReflectorModule; } + + // set + void SetModule(char c) { m_Callsign.SetModule(c); } + void SetReflectorModule(char c) { m_ReflectorModule = c; } + + // identity + virtual int GetProtocol(void) const { return PROTOCOL_NONE; } + virtual const char *GetProtocolName(void) const { return "none"; } + + // status + virtual void Alive(void); + virtual bool IsAlive(void) const { return false; } + virtual bool IsAMaster(void) const { return (m_ModuleMastered != ' '); } + virtual void SetMasterOfModule(char c) { m_ModuleMastered = c; } + virtual void NotAMaster(void) { m_ModuleMastered = ' '; } + virtual void Heard(void) { m_LastHeardTime = std::time(NULL); } + + // reporting + virtual void WriteXml(std::ofstream &); + virtual void GetJsonObject(char *); + +protected: + // data + CCallsign m_Callsign; + CIp m_Ip; + + // linked to + char m_ReflectorModule; + + // status + char m_ModuleMastered; + CTimePoint m_LastKeepaliveTime; + std::time_t m_ConnectTime; + std::time_t m_LastHeardTime; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cclient_h */ diff --git a/src/cclients.cpp b/src/cclients.cpp new file mode 100644 index 0000000..e416531 --- /dev/null +++ b/src/cclients.cpp @@ -0,0 +1,251 @@ +// +// cclients.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "creflector.h" +#include "cclients.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + + +CClients::CClients() +{ + m_Clients.reserve(100); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// destructors + +CClients::~CClients() +{ + m_Mutex.lock(); + { + for ( int i = 0; i < m_Clients.size(); i++ ) + { + delete m_Clients[i]; + } + m_Clients.clear(); + + } + m_Mutex.unlock(); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// manage Clients + +void CClients::AddClient(CClient *client) +{ + // first check if client already exists + bool found = false; + for ( int i = 0; (i < m_Clients.size()) && !found; i++ ) + { + found = (*client == *m_Clients[i]); + // if found, just do nothing + // so *client keep pointing on a valid object + // on function return + if ( found ) + { + // delete new one + delete client; + //std::cout << "Adding existing client " << client->GetCallsign() << " at " << client->GetIp() << std::endl; + } + } + + // if not, append to the vector + if ( !found ) + { + // grow vector capacity if needed + if ( m_Clients.capacity() == m_Clients.size() ) + { + m_Clients.reserve(m_Clients.capacity()+10); + } + // and append + m_Clients.push_back(client); + std::cout << "New client " << client->GetCallsign() << " at " << client->GetIp() + << " added with protocol " << client->GetProtocol() << std::endl; + // notify + g_Reflector.OnClientsChanged(); + } + } + +void CClients::RemoveClient(CClient *client) +{ + // look for the client + bool found = false; + for ( int i = 0; (i < m_Clients.size()) && !found; i++ ) + { + // compare objetc pointers + if ( (m_Clients[i]) == client ) + { + // found it ! + if ( !m_Clients[i]->IsAMaster() ) + { + // remove it + std::cout << "Client " << m_Clients[i]->GetCallsign() << " at " << m_Clients[i]->GetIp() + << " removed" << std::endl; + delete m_Clients[i]; + m_Clients.erase(m_Clients.begin()+i); + found = true; + // notify + g_Reflector.OnClientsChanged(); + } + } + } +} + +CClient *CClients::GetClient(int i) +{ + if ( (i >= 0) && (i < m_Clients.size()) ) + { + return m_Clients[i]; + } + else + { + return NULL; + } +} + +bool CClients::IsClient(CClient *client) const +{ + bool found = false; + for ( int i = 0; (i < m_Clients.size()) && !found; i++ ) + { + found = (m_Clients[i] == client); + } + return found; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// find Clients + +CClient *CClients::FindClient(const CIp &Ip) +{ + CClient *client = NULL; + + // find client + for ( int i = 0; (i < m_Clients.size()) && (client == NULL); i++ ) + { + if ( m_Clients[i]->GetIp() == Ip ) + { + client = m_Clients[i]; + } + } + + // done + return client; +} + +CClient *CClients::FindClient(const CIp &Ip, int Protocol) +{ + CClient *client = NULL; + + // find client + for ( int i = 0; (i < m_Clients.size()) && (client == NULL); i++ ) + { + if ( (m_Clients[i]->GetIp() == Ip) && (m_Clients[i]->GetProtocol() == Protocol)) + { + client = m_Clients[i]; + } + } + + // done + return client; +} + +CClient *CClients::FindClient(const CCallsign &Callsign, const CIp &Ip, int Protocol) +{ + CClient *client = NULL; + + // find client + for ( int i = 0; (i < m_Clients.size()) && (client == NULL); i++ ) + { + if ( m_Clients[i]->GetCallsign().HasSameCallsign(Callsign) && + (m_Clients[i]->GetIp() == Ip) && + (m_Clients[i]->GetProtocol() == Protocol) ) + { + client = m_Clients[i]; + } + } + + // done + return client; +} + +CClient *CClients::FindClient(const CCallsign &Callsign, char module, const CIp &Ip, int Protocol) +{ + CClient *client = NULL; + + // find client + for ( int i = 0; (i < m_Clients.size()) && (client == NULL); i++ ) + { + if ( m_Clients[i]->GetCallsign().HasSameCallsign(Callsign) && + (m_Clients[i]->GetModule() == module) && + (m_Clients[i]->GetIp() == Ip) && + (m_Clients[i]->GetProtocol() == Protocol) ) + { + client = m_Clients[i]; + } + } + + // done + return client; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// iterate on clients + +CClient *CClients::FindNextClient(int Protocol, int *index) +{ + CClient *client = NULL; + + // find next client + bool found = false; + for ( int i = *index+1; (i < m_Clients.size()) && !found; i++ ) + { + if ( m_Clients[i]->GetProtocol() == Protocol ) + { + found = true; + client = m_Clients[i]; + *index = i; + } + } + return client; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// reporting + +void CClients::WriteXml(std::ofstream &xmlFile) +{ + xmlFile << "" << std::endl; + for ( int i = 0; i < m_Clients.size(); i++ ) + { + m_Clients[i]->WriteXml(xmlFile); + } + xmlFile << "" << std::endl; +} + + diff --git a/src/cclients.h b/src/cclients.h new file mode 100644 index 0000000..328f323 --- /dev/null +++ b/src/cclients.h @@ -0,0 +1,78 @@ +// +// cclients.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cclients_h +#define cclients_h + +#include "cclient.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// define + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CClients +{ +public: + // constructors + CClients(); + + // destructors + virtual ~CClients(); + + // locks + void Lock(void) { m_Mutex.lock(); } + void Unlock(void) { m_Mutex.unlock(); } + + // manage Clients + int GetSize(void) const { return (int)m_Clients.size(); } + void AddClient(CClient *); + void RemoveClient(CClient *); + CClient *GetClient(int); + bool IsClient(CClient *) const; + + // find clients + CClient *FindClient(const CIp &); + CClient *FindClient(const CIp &, int); + CClient *FindClient(const CCallsign &, const CIp &, int); + CClient *FindClient(const CCallsign &, char, const CIp &, int); + + // iterate on clients + CClient *FindNextClient(int, int*); + + // reporting + void WriteXml(std::ofstream &); + +protected: + // data + std::mutex m_Mutex; + std::vector m_Clients; +}; + + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cclients_h */ diff --git a/src/cdcsclient.cpp b/src/cdcsclient.cpp new file mode 100644 index 0000000..eec1d19 --- /dev/null +++ b/src/cdcsclient.cpp @@ -0,0 +1,52 @@ +// +// cdcsclient.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 07/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "cdcsclient.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructors + +CDcsClient::CDcsClient() +{ +} + +CDcsClient::CDcsClient(const CCallsign &callsign, const CIp &ip, char reflectorModule) +: CClient(callsign, ip, reflectorModule) +{ +} + +CDcsClient::CDcsClient(const CDcsClient &client) +: CClient(client) +{ +} + +//////////////////////////////////////////////////////////////////////////////////////// +// status + +bool CDcsClient::IsAlive(void) const +{ + return (m_LastKeepaliveTime.DurationSinceNow() < DCS_KEEPALIVE_TIMEOUT); +} diff --git a/src/cdcsclient.h b/src/cdcsclient.h new file mode 100644 index 0000000..d8ca7f9 --- /dev/null +++ b/src/cdcsclient.h @@ -0,0 +1,58 @@ +// +// cdcsclient.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 07/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cdcsclient_h +#define cdcsclient_h + +#include "cclient.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// define + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CDcsClient : public CClient +{ +public: + // constructors + CDcsClient(); + CDcsClient(const CCallsign &, const CIp &, char = ' '); + CDcsClient(const CDcsClient &); + + // destructor + virtual ~CDcsClient() {}; + + // identity + int GetProtocol(void) const { return PROTOCOL_DCS; } + const char *GetProtocolName(void) const { return "DCS"; } + + // status + bool IsAlive(void) const; +}; + +//////////////////////////////////////////////////////////////////////////////////////// + +#endif /* cdcsclient_h */ diff --git a/src/cdcsprotocol.cpp b/src/cdcsprotocol.cpp new file mode 100644 index 0000000..d513d6a --- /dev/null +++ b/src/cdcsprotocol.cpp @@ -0,0 +1,511 @@ +// +// cdcsprotocol.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 07/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include +#include "cdcsclient.h" +#include "cdcsprotocol.h" +#include "creflector.h" +#include "cgatekeeper.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CDcsProtocol::CDcsProtocol() +{ + for ( int i = 0; i < m_iSeqCounters.size(); i++ ) + { + m_iSeqCounters[i] = 0; + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// operation + +bool CDcsProtocol::Init(void) +{ + bool ok; + + // base class + ok = CProtocol::Init(); + + // update the reflector callsign + m_ReflectorCallsign.PatchCallsign(0, (const uint8 *)"DCS", 3); + + // create our socket + ok &= m_Socket.Open(DCS_PORT); + + // update time + m_LastKeepaliveTime.Now(); + + // done + return ok; +} + + + +//////////////////////////////////////////////////////////////////////////////////////// +// task + +void CDcsProtocol::Task(void) +{ + CBuffer Buffer; + CIp Ip; + CCallsign Callsign; + char ToLinkModule; + CDvHeaderPacket *Header; + CDvFramePacket *Frame; + + // handle incoming packets + if ( m_Socket.Receive(&Buffer, &Ip, 20) != -1 ) + { + // crack the packet + if ( IsValidDvPacket(Buffer, &Header, &Frame) ) + { + //std::cout << "DCS DV packet" << std::endl; + + // callsign muted? + if ( g_GateKeeper.MayTransmit(Header->GetMyCallsign(), Ip, PROTOCOL_DCS) ) + { + // handle it + if ( !OnDvHeaderPacketIn(Header, Ip) ) + { + if ( !Frame->IsLastPacket() ) + { + //std::cout << "DCS DV frame" << std::endl; + OnDvFramePacketIn(Frame); + } + else + { + //std::cout << "DCS DV last frame" << std::endl; + OnDvLastFramePacketIn((CDvLastFramePacket *)Frame); + } + } + else + { + //std::cout << "DCS DV header:" << std::endl << *Header << std::endl; + delete Frame; + } + } + else + { + delete Header; + delete Frame; + } + } + else if ( IsValidConnectPacket(Buffer, &Callsign, &ToLinkModule) ) + { + std::cout << "DCS connect packet for module " << ToLinkModule << " from " << Callsign << " at " << Ip << std::endl; + + // callsign authorized? + if ( g_GateKeeper.MayLink(Callsign, Ip, PROTOCOL_DCS) ) + { + // acknowledge the request + EncodeConnectAckPacket(Callsign, &Buffer); + m_Socket.Send(Buffer, Ip); + + // create the client + CDcsClient *client = new CDcsClient(Callsign, Ip, ToLinkModule); + + // and append + g_Reflector.GetClients()->AddClient(client); + g_Reflector.ReleaseClients(); + } + else + { + // deny the request + EncodeConnectNackPacket(Callsign, &Buffer); + m_Socket.Send(Buffer, Ip); + } + + } + else if ( IsValidDisconnectPacket(Buffer, &Callsign) ) + { + std::cout << "DCS disconnect packet from " << Ip << std::endl; + + // find client & remove it + CClients *clients = g_Reflector.GetClients(); + CClient *client = clients->FindClient(Ip, PROTOCOL_DCS); + if ( client != NULL ) + { + clients->RemoveClient(client); + } + g_Reflector.ReleaseClients(); + } + else if ( IsValidKeepAlivePacket(Buffer, &Callsign) ) + { + //std::cout << "DCS keepalive packet from " << Callsign << " at " << Ip << std::endl; + + // find client & keep it alive + CClient *GetClient(const CCallsign &, const CIp &, char, int); + + CClient *client = g_Reflector.GetClients()->FindClient(Ip, PROTOCOL_DCS); + if ( client != NULL ) + { + client->Alive(); + } + g_Reflector.ReleaseClients(); + } + else + { + std::cout << "DCS packet (" << Buffer.size() << ")" << std::endl; + } + } + + // handle end of streaming timeout + CheckStreamsTimeout(); + + // handle queue from reflector + HandleQueue(); + + // keep client alive + if ( m_LastKeepaliveTime.DurationSinceNow() > DCS_KEEPALIVE_PERIOD ) + { + // DCS protocol sends and monitors keepalives packets + // event if the client is currently streaming + // so, send keepalives to all + CBuffer keepalive1; + EncodeKeepAlivePacket(&keepalive1); + + // iterate on clients + CClients *clients = g_Reflector.GetClients(); + int index = -1; + CClient *client = NULL; + while ( (client = clients->FindNextClient(PROTOCOL_DCS, &index)) != NULL ) + { + // encode client's specific keepalive packet + CBuffer keepalive2; + EncodeKeepAlivePacket(&keepalive2, client); + + // send keepalive + m_Socket.Send(keepalive1, client->GetIp()); + m_Socket.Send(keepalive2, client->GetIp()); + + // is this client busy ? + if ( client->IsAMaster() ) + { + // yes, just tickle it + client->Alive(); + } + // check it's still with us + else if ( !client->IsAlive() ) + { + // no, disconnect + CBuffer disconnect; + EncodeDisconnectPacket(&disconnect, client); + m_Socket.Send(disconnect, client->GetIp()); + + // remove it + std::cout << "DCS client " << client->GetCallsign() << " keepalive timeout" << std::endl; + clients->RemoveClient(client); + } + + } + g_Reflector.ReleaseClients(); + + // update time + m_LastKeepaliveTime.Now(); + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// streams helpers + +bool CDcsProtocol::OnDvHeaderPacketIn(CDvHeaderPacket *Header, const CIp &Ip) +{ + bool newstream = false; + + // find the stream + CPacketStream *stream = GetStream(Header->GetStreamId()); + if ( stream == NULL ) + { + // no stream open yet, open a new one + // find this client + CClient *client = g_Reflector.GetClients()->FindClient(Ip, PROTOCOL_DCS); + if ( client != NULL ) + { + // and try to open the stream + if ( (stream = g_Reflector.OpenStream(Header, client)) != NULL ) + { + // keep the handle + m_Streams.push_back(stream); + newstream = true; + } + } + // release + g_Reflector.ReleaseClients(); + } + else + { + // stream already open + // skip packet, but tickle the stream + stream->Tickle(); + // and delete packet + delete Header; + } + + // update last heard + g_Reflector.GetUsers()->Hearing(Header->GetMyCallsign(), Header->GetRpt1Callsign()); + g_Reflector.ReleaseUsers(); + + // done + return newstream; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// queue helper + +void CDcsProtocol::HandleQueue(void) +{ + m_Queue.Lock(); + while ( !m_Queue.empty() ) + { + // get the packet + CPacket *packet = m_Queue.front(); + m_Queue.pop(); + + // get our sender's id + int iModId = g_Reflector.GetModuleIndex(packet->GetModuleId()); + + // check if it's header and update cache + if ( packet->IsDvHeader() ) + { + // this relies on queue feeder setting valid module id + m_DvHeadersCache[iModId] = CDvHeaderPacket((const CDvHeaderPacket &)*packet); + m_iSeqCounters[iModId] = 0; + } + else + { + // encode it + CBuffer buffer; + if ( packet->IsDvFrame() ) + { + EncodeDvPacket(m_DvHeadersCache[iModId], (const CDvFramePacket &)*packet, m_iSeqCounters[iModId]++, &buffer); + } + else if ( packet->IsLastPacket() ) + { + EncodeDvLastPacket(m_DvHeadersCache[iModId], (const CDvFramePacket &)*packet, m_iSeqCounters[iModId]++, &buffer); + } + + // send it + if ( buffer.size() > 0 ) + { + // and push it to all our clients linked to the module and who are not streaming in + CClients *clients = g_Reflector.GetClients(); + int index = -1; + CClient *client = NULL; + while ( (client = clients->FindNextClient(PROTOCOL_DCS, &index)) != NULL ) + { + // is this client busy ? + if ( !client->IsAMaster() && (client->GetReflectorModule() == packet->GetModuleId()) ) + { + // no, send the packet + m_Socket.Send(buffer, client->GetIp()); + + } + } + g_Reflector.ReleaseClients(); + } + } + + // done + delete packet; + } + m_Queue.Unlock(); +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// packet decoding helpers + +bool CDcsProtocol::IsValidConnectPacket(const CBuffer &Buffer, CCallsign *callsign, char *reflectormodule) +{ + bool valid = false; + if ( Buffer.size() == 519 ) + { + callsign->SetCallsign(Buffer.data(), 8); + callsign->SetModule(Buffer.data()[8]); + *reflectormodule = Buffer.data()[9]; + valid = (callsign->IsValid() && std::isupper(*reflectormodule)); + } + return valid; +} + +bool CDcsProtocol::IsValidDisconnectPacket(const CBuffer &Buffer, CCallsign *callsign) +{ + bool valid = false; + if ((Buffer.size() == 11) && (Buffer.data()[9] == ' ')) + { + callsign->SetCallsign(Buffer.data(), 8); + callsign->SetModule(Buffer.data()[8]); + valid = callsign->IsValid(); + } + else if ((Buffer.size() == 19) && (Buffer.data()[9] == ' ') && (Buffer.data()[10] == 0x00)) + { + callsign->SetCallsign(Buffer.data(), 8); + callsign->SetModule(Buffer.data()[8]); + valid = callsign->IsValid(); + } + return valid; +} + +bool CDcsProtocol::IsValidKeepAlivePacket(const CBuffer &Buffer, CCallsign *callsign) +{ + bool valid = false; + if (Buffer.size() == 17) + { + callsign->SetCallsign(Buffer.data(), 8); + valid = callsign->IsValid(); + } + return valid; +} + +bool CDcsProtocol::IsValidDvPacket(const CBuffer &Buffer, CDvHeaderPacket **header, CDvFramePacket **frame) +{ + uint8 tag[] = { '0','0','0','1' }; + + bool valid = false; + *header = NULL; + *frame = NULL; + + if ( (Buffer.size() >= 100) && (Buffer.Compare(tag, sizeof(tag)) == 0) ) + { + // get the header + *header = new CDvHeaderPacket((struct dstar_header *)&(Buffer.data()[4]), + *((uint16 *)&(Buffer.data()[43])), 0x80); + + // get the frame + if ( ((Buffer.data()[45]) & 0x40) != 0 ) + { + // it's the last frame + *frame = new CDvLastFramePacket((struct dstar_dvframe *)&(Buffer.data()[46]), + *((uint16 *)&(Buffer.data()[43])), Buffer.data()[45]); + } + else + { + // it's a regular DV frame + *frame = new CDvFramePacket((struct dstar_dvframe *)&(Buffer.data()[46]), + *((uint16 *)&(Buffer.data()[43])), Buffer.data()[45]); + } + + // check validity of packets + if ( !((*header)->IsValid() && (*frame)->IsValid()) ) + { + delete *header; + delete *frame; + *header = NULL; + *frame = NULL; + } + else + { + valid = true; + } + } + // done + return valid; +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// packet encoding helpers + +void CDcsProtocol::EncodeKeepAlivePacket(CBuffer *Buffer) +{ + Buffer->Set(GetReflectorCallsign()); +} + +void CDcsProtocol::EncodeKeepAlivePacket(CBuffer *Buffer, CClient *Client) +{ + Buffer->Set((uint8 *)(const char *)GetReflectorCallsign(), CALLSIGN_LEN-1); + Buffer->Append((uint8)Client->GetReflectorModule()); + Buffer->Append((uint8)0); + Buffer->Append((uint8 *)(const char *)Client->GetCallsign(), CALLSIGN_LEN); + Buffer->Append((uint8)Client->GetModule()); + Buffer->Append((uint8)0, 4); +} + +void CDcsProtocol::EncodeConnectAckPacket(const CCallsign &Callsign, CBuffer *Buffer) +{ + uint8 tag[] = { 'E','A','C','K',0x00 }; + uint8 cs[CALLSIGN_LEN]; + + Callsign.GetCallsign(cs); + Buffer->Set(cs, CALLSIGN_LEN-1); + Buffer->Append((uint8)' '); + Buffer->Append((uint8)Callsign.GetModule()); + Buffer->Append(tag, sizeof(tag)); +} + +void CDcsProtocol::EncodeConnectNackPacket(const CCallsign &Callsign, CBuffer *Buffer) +{ + uint8 tag[] = { 'E','N','A','K',0x00 }; + uint8 cs[CALLSIGN_LEN]; + + Callsign.GetCallsign(cs); + Buffer->Set(cs, CALLSIGN_LEN-1); + Buffer->Append((uint8)' '); + Buffer->Append((uint8)Callsign.GetModule()); + Buffer->Append(tag, sizeof(tag)); +} + +void CDcsProtocol::EncodeDisconnectPacket(CBuffer *Buffer, CClient *Client) +{ + Buffer->Set((uint8 *)(const char *)Client->GetCallsign(), CALLSIGN_LEN-1); + Buffer->Append((uint8)' '); + Buffer->Append((uint8)Client->GetModule()); + Buffer->Append((uint8)0x00); + Buffer->Append((uint8 *)(const char *)GetReflectorCallsign(), CALLSIGN_LEN-1); + Buffer->Append((uint8)' '); + Buffer->Append((uint8)0x00); +} + +void CDcsProtocol::EncodeDvPacket(const CDvHeaderPacket &Header, const CDvFramePacket &DvFrame, uint32 iSeq, CBuffer *Buffer) const +{ + uint8 tag[] = { '0','0','0','1' }; + struct dstar_header DstarHeader; + + Header.ConvertToDstarStruct(&DstarHeader); + + Buffer->Set(tag, sizeof(tag)); + Buffer->Append((uint8 *)&DstarHeader, sizeof(struct dstar_header) - sizeof(uint16)); + Buffer->Append(DvFrame.GetStreamId()); + Buffer->Append((uint8)(DvFrame.GetPacketId() % 21)); + Buffer->Append((uint8 *)DvFrame.GetAmbe(), AMBE_SIZE); + Buffer->Append((uint8 *)DvFrame.GetDvData(), DVDATA_SIZE); + Buffer->Append((uint8)((iSeq >> 0) & 0xFF)); + Buffer->Append((uint8)((iSeq >> 8) & 0xFF)); + Buffer->Append((uint8)((iSeq >> 16) & 0xFF)); + Buffer->Append((uint8)0x01); + Buffer->Append((uint8)0x00, 38); +} + +void CDcsProtocol::EncodeDvLastPacket(const CDvHeaderPacket &Header, const CDvFramePacket &DvFrame, uint32 iSeq, CBuffer *Buffer) const +{ + //uint8 tag[] = { 0x4e,0x8d,0x32,0x88,0x26,0x1a,0x3f,0x61,0xe8,0x55,0x55,0x55 }; + + EncodeDvPacket(Header, DvFrame, iSeq, Buffer); + (Buffer->data())[45] |= 0x40; + //Buffer->Ser +} diff --git a/src/cdcsprotocol.h b/src/cdcsprotocol.h new file mode 100644 index 0000000..bc00c95 --- /dev/null +++ b/src/cdcsprotocol.h @@ -0,0 +1,87 @@ +// +// cdcsprotocol.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 07/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cdcsprotocol_h +#define cdcsprotocol_h + +#include "ctimepoint.h" +#include "cprotocol.h" +#include "cdvheaderpacket.h" +#include "cdvframepacket.h" +#include "cdvlastframepacket.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// define + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CDcsProtocol : public CProtocol +{ +public: + // constructor + CDcsProtocol(); + + // destructor + virtual ~CDcsProtocol() {}; + + // initialization + bool Init(void); + + // task + void Task(void); + +protected: + // stream helpers + bool OnDvHeaderPacketIn(CDvHeaderPacket *, const CIp &); + + // packet decoding helpers + bool IsValidConnectPacket(const CBuffer &, CCallsign *, char *); + bool IsValidDisconnectPacket(const CBuffer &, CCallsign *); + bool IsValidKeepAlivePacket(const CBuffer &, CCallsign *); + bool IsValidDvPacket(const CBuffer &, CDvHeaderPacket **, CDvFramePacket **); + + // packet encoding helpers + void EncodeKeepAlivePacket(CBuffer *); + void EncodeKeepAlivePacket(CBuffer *, CClient *); + void EncodeConnectAckPacket(const CCallsign &, CBuffer *); + void EncodeConnectNackPacket(const CCallsign &, CBuffer *); + void EncodeDisconnectPacket(CBuffer *, CClient *); + void EncodeDvPacket(const CDvHeaderPacket &, const CDvFramePacket &, uint32, CBuffer *) const; + void EncodeDvLastPacket(const CDvHeaderPacket &, const CDvFramePacket &, uint32, CBuffer *) const; + + // queue helper + void HandleQueue(void); + +protected: + // for keep alive + CTimePoint m_LastKeepaliveTime; + + // for queue header caches + std::array m_DvHeadersCache; + std::array m_iSeqCounters; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cdcsprotocol_h */ diff --git a/src/cdextraclient.cpp b/src/cdextraclient.cpp new file mode 100644 index 0000000..f5a5b66 --- /dev/null +++ b/src/cdextraclient.cpp @@ -0,0 +1,53 @@ +// +// cdextraclient.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "cdextraclient.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructors + +CDextraClient::CDextraClient() +{ +} + +CDextraClient::CDextraClient(const CCallsign &callsign, const CIp &ip, char reflectorModule) + : CClient(callsign, ip, reflectorModule) +{ +} + +CDextraClient::CDextraClient(const CDextraClient &client) + : CClient(client) +{ +} + +//////////////////////////////////////////////////////////////////////////////////////// +// status + +bool CDextraClient::IsAlive(void) const +{ + return (m_LastKeepaliveTime.DurationSinceNow() < DEXTRA_KEEPALIVE_TIMEOUT); +} + diff --git a/src/cdextraclient.h b/src/cdextraclient.h new file mode 100644 index 0000000..bb0576e --- /dev/null +++ b/src/cdextraclient.h @@ -0,0 +1,57 @@ +// +// cdextraclient.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cdextraclient_h +#define cdextraclient_h + +#include "cclient.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// define + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CDextraClient : public CClient +{ +public: + // constructors + CDextraClient(); + CDextraClient(const CCallsign &, const CIp &, char = ' '); + CDextraClient(const CDextraClient &); + + // destructor + virtual ~CDextraClient() {}; + + // identity + int GetProtocol(void) const { return PROTOCOL_DEXTRA; } + const char *GetProtocolName(void) const { return "Dextra"; } + + // status + bool IsAlive(void) const; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cdextraclient_h */ diff --git a/src/cdextraprotocol.cpp b/src/cdextraprotocol.cpp new file mode 100644 index 0000000..2b63cec --- /dev/null +++ b/src/cdextraprotocol.cpp @@ -0,0 +1,464 @@ +// +// cdextraprotocol.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include +#include "cdextraclient.h" +#include "cdextraprotocol.h" +#include "creflector.h" +#include "cgatekeeper.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// operation + +bool CDextraProtocol::Init(void) +{ + bool ok; + + // base class + ok = CProtocol::Init(); + + // update the reflector callsign + m_ReflectorCallsign.PatchCallsign(0, (const uint8 *)"XRF", 3); + + // create our socket + ok &= m_Socket.Open(DEXTRA_PORT); + + // update time + m_LastKeepaliveTime.Now(); + + // done + return ok; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// task + +void CDextraProtocol::Task(void) +{ + CBuffer Buffer; + CIp Ip; + CCallsign Callsign; + char ToLinkModule; + CDvHeaderPacket *Header; + CDvFramePacket *Frame; + CDvLastFramePacket *LastFrame; + + // any incoming packet ? + if ( m_Socket.Receive(&Buffer, &Ip, 20) != -1 ) + { + // crack the packet + if ( (Frame = IsValidDvFramePacket(Buffer)) != NULL ) + { + //std::cout << "DExtra DV frame" << std::endl; + + // handle it + OnDvFramePacketIn(Frame); + } + else if ( (Header = IsValidDvHeaderPacket(Buffer)) != NULL ) + { + //std::cout << "DExtra DV header:" << std::endl << *Header << std::endl; + + // callsign muted? + if ( g_GateKeeper.MayTransmit(Header->GetMyCallsign(), Ip, PROTOCOL_DEXTRA) ) + { + // handle it + OnDvHeaderPacketIn(Header, Ip); + } + else + { + delete Header; + } + } + else if ( (LastFrame = IsValidDvLastFramePacket(Buffer)) != NULL ) + { + //std::cout << "DExtra DV last frame" << std::endl; + + // handle it + OnDvLastFramePacketIn(LastFrame); + } + else if ( IsValidConnectPacket(Buffer, &Callsign, &ToLinkModule) ) + { + std::cout << "DExtra connect packet for module " << ToLinkModule << " from " << Callsign << " at " << Ip << std::endl; + + // callsign authorized? + if ( g_GateKeeper.MayLink(Callsign, Ip, PROTOCOL_DEXTRA) ) + { + // acknowledge the request + EncodeConnectAckPacket(&Buffer); + m_Socket.Send(Buffer, Ip); + + // create the client + CDextraClient *client = new CDextraClient(Callsign, Ip, ToLinkModule); + + // and append + g_Reflector.GetClients()->AddClient(client); + g_Reflector.ReleaseClients(); + } + else + { + // deny the request + EncodeConnectNackPacket(&Buffer); + m_Socket.Send(Buffer, Ip); + } + } + else if ( IsValidDisconnectPacket(Buffer, &Callsign) ) + { + std::cout << "DExtra disconnect packet from " << Callsign << " at " << Ip << std::endl; + + // find client & remove it + CClients *clients = g_Reflector.GetClients(); + CClient *client = clients->FindClient(Callsign, Ip, PROTOCOL_DEXTRA); + if ( client != NULL ) + { + clients->RemoveClient(client); + } + g_Reflector.ReleaseClients(); + } + else if ( IsValidKeepAlivePacket(Buffer, &Callsign) ) + { + //std::cout << "DExtra keepalive packet from " << Callsign << " at " << Ip << std::endl; + + // find client & keep it alive + CClient *GetClient(const CCallsign &, const CIp &, char, int); + + CClient *client = g_Reflector.GetClients()->FindClient(Callsign, Ip, PROTOCOL_DEXTRA); + if ( client != NULL ) + { + client->Alive(); + } + g_Reflector.ReleaseClients(); + } + else + { + std::cout << "DExtra packet (" << Buffer.size() << ")" << std::endl; + } + } + + // handle end of streaming timeout + CheckStreamsTimeout(); + + // handle queue from reflector + HandleQueue(); + + // keep client alive + if ( m_LastKeepaliveTime.DurationSinceNow() > DEXTRA_KEEPALIVE_PERIOD ) + { + // DExtra protocol sends and monitors keepalives packets + // event if the client is currently streaming + // so, send keepalives to all + CBuffer keepalive; + EncodeKeepAlivePacket(&keepalive); + + // iterate on clients + CClients *clients = g_Reflector.GetClients(); + int index = -1; + CClient *client = NULL; + while ( (client = clients->FindNextClient(PROTOCOL_DEXTRA, &index)) != NULL ) + { + // send keepalive + m_Socket.Send(keepalive, client->GetIp()); + + // client busy ? + if ( client->IsAMaster() ) + { + // yes, just tickle it + client->Alive(); + } + // otherwise check if still with us + else if ( !client->IsAlive() ) + { + // no, disconnect + CBuffer disconnect; + EncodeDisconnectPacket(&disconnect); + m_Socket.Send(disconnect, client->GetIp()); + + // remove it + std::cout << "DExtra client " << client->GetCallsign() << " keepalive timeout" << std::endl; + clients->RemoveClient(client); + } + + } + g_Reflector.ReleaseClients(); + + // update time + m_LastKeepaliveTime.Now(); + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// queue helper + +void CDextraProtocol::HandleQueue(void) +{ + m_Queue.Lock(); + while ( !m_Queue.empty() ) + { + // get the packet + CPacket *packet = m_Queue.front(); + m_Queue.pop(); + + // encode it + CBuffer buffer; + if ( EncodeDvPacket(*packet, &buffer) ) + { + // and push it to all our clients linked to the module and who are not streaming in + CClients *clients = g_Reflector.GetClients(); + int index = -1; + CClient *client = NULL; + while ( (client = clients->FindNextClient(PROTOCOL_DEXTRA, &index)) != NULL ) + { + // is this client busy ? + if ( !client->IsAMaster() && (client->GetReflectorModule() == packet->GetModuleId()) ) + { + // no, send the packet + m_Socket.Send(buffer, client->GetIp()); + + } + } + g_Reflector.ReleaseClients(); + } + + + // done + delete packet; + } + m_Queue.Unlock(); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// streams helpers + +bool CDextraProtocol::OnDvHeaderPacketIn(CDvHeaderPacket *Header, const CIp &Ip) +{ + bool newstream = false; + + // find the stream + CPacketStream *stream = GetStream(Header->GetStreamId()); + if ( stream == NULL ) + { + // no stream open yet, open a new one + // find this client + CClient *client = g_Reflector.GetClients()->FindClient(Ip, PROTOCOL_DEXTRA); + if ( client != NULL ) + { + // and try to open the stream + if ( (stream = g_Reflector.OpenStream(Header, client)) != NULL ) + { + // keep the handle + m_Streams.push_back(stream); + newstream = true; + } + } + // release + g_Reflector.ReleaseClients(); + } + else + { + // stream already open + // skip packet, but tickle the stream + stream->Tickle(); + } + + // update last heard + g_Reflector.GetUsers()->Hearing(Header->GetMyCallsign(), Header->GetRpt1Callsign()); + g_Reflector.ReleaseUsers(); + + // done + return newstream; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// packet decoding helpers + +bool CDextraProtocol::IsValidConnectPacket(const CBuffer &Buffer, CCallsign *callsign, char *reflectormodule) +{ + bool valid = false; + if ((Buffer.size() == 11) && (Buffer.data()[9] != ' ')) + { + callsign->SetCallsign(Buffer.data(), 8); + callsign->SetModule(Buffer.data()[8]); + *reflectormodule = Buffer.data()[9]; + valid = (callsign->IsValid() && std::isupper(*reflectormodule)); + } + return valid; +} + +bool CDextraProtocol::IsValidDisconnectPacket(const CBuffer &Buffer, CCallsign *callsign) +{ + bool valid = false; + if ((Buffer.size() == 11) && (Buffer.data()[9] == ' ')) + { + callsign->SetCallsign(Buffer.data(), 8); + callsign->SetModule(Buffer.data()[8]); + valid = callsign->IsValid(); + } + return valid; +} + +bool CDextraProtocol::IsValidKeepAlivePacket(const CBuffer &Buffer, CCallsign *callsign) +{ + bool valid = false; + if (Buffer.size() == 9) + { + callsign->SetCallsign(Buffer.data(), 8); + valid = callsign->IsValid(); + } + return valid; +} + +CDvHeaderPacket *CDextraProtocol::IsValidDvHeaderPacket(const CBuffer &Buffer) +{ + CDvHeaderPacket *header = NULL; + + if ( (Buffer.size() == 56) && (Buffer.Compare((uint8 *)"DSVT", 4) == 0) && + (Buffer.data()[4] == 0x10) && (Buffer.data()[8] == 0x20) ) + { + // create packet + header = new CDvHeaderPacket((struct dstar_header *)&(Buffer.data()[15]), + *((uint16 *)&(Buffer.data()[12])), 0x80); + // check validity of packet + if ( !header->IsValid() ) + { + delete header; + header = NULL; + } + } + return header; +} + +CDvFramePacket *CDextraProtocol::IsValidDvFramePacket(const CBuffer &Buffer) +{ + CDvFramePacket *dvframe = NULL; + + if ( (Buffer.size() == 27) && (Buffer.Compare((uint8 *)"DSVT", 4) == 0) && + (Buffer.data()[4] == 0x20) && (Buffer.data()[8] == 0x20) && + ((Buffer.data()[14] & 0x40) == 0) ) + { + // create packet + dvframe = new CDvFramePacket((struct dstar_dvframe *)&(Buffer.data()[15]), + *((uint16 *)&(Buffer.data()[12])), Buffer.data()[14]); + // check validity of packet + if ( !dvframe->IsValid() ) + { + delete dvframe; + dvframe = NULL; + } + } + return dvframe; +} + +CDvLastFramePacket *CDextraProtocol::IsValidDvLastFramePacket(const CBuffer &Buffer) +{ + CDvLastFramePacket *dvframe = NULL; + + if ( (Buffer.size() == 27) && (Buffer.Compare((uint8 *)"DSVT", 4) == 0) && + (Buffer.data()[4] == 0x20) && (Buffer.data()[8] == 0x20) && + ((Buffer.data()[14] & 0x40) != 0) ) + { + // create packet + dvframe = new CDvLastFramePacket((struct dstar_dvframe *)&(Buffer.data()[15]), + *((uint16 *)&(Buffer.data()[12])), Buffer.data()[14]); + // check validity of packet + if ( !dvframe->IsValid() ) + { + delete dvframe; + dvframe = NULL; + } + } + return dvframe; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// packet encoding helpers + +void CDextraProtocol::EncodeKeepAlivePacket(CBuffer *Buffer) +{ + Buffer->Set(GetReflectorCallsign()); +} + +void CDextraProtocol::EncodeConnectAckPacket(CBuffer *Buffer) +{ + uint8 tag[] = { 'A','C','K',0 }; + Buffer->resize(Buffer->size()-1); + Buffer->Append(tag, sizeof(tag)); +} + +void CDextraProtocol::EncodeConnectNackPacket(CBuffer *Buffer) +{ + uint8 tag[] = { 'N','A','K',0 }; + Buffer->resize(Buffer->size()-1); + Buffer->Append(tag, sizeof(tag)); +} + +void CDextraProtocol::EncodeDisconnectPacket(CBuffer *Buffer) +{ + uint8 tag[] = { ' ',' ',' ',' ',' ',' ',' ',' ',' ',' ',0 }; + Buffer->Set(tag, sizeof(tag)); +} + + +bool CDextraProtocol::EncodeDvHeaderPacket(const CDvHeaderPacket &Packet, CBuffer *Buffer) const +{ + uint8 tag[] = { 'D','S','V','T',0x10,0x00,0x00,0x00,0x20,0x00,0x01,0x02 }; + struct dstar_header DstarHeader; + + Packet.ConvertToDstarStruct(&DstarHeader); + + Buffer->Set(tag, sizeof(tag)); + Buffer->Append(Packet.GetStreamId()); + Buffer->Append((uint8)0x80); + Buffer->Append((uint8 *)&DstarHeader, sizeof(struct dstar_header)); + + return true; +} + +bool CDextraProtocol::EncodeDvFramePacket(const CDvFramePacket &Packet, CBuffer *Buffer) const +{ + uint8 tag[] = { 'D','S','V','T',0x20,0x00,0x00,0x00,0x20,0x00,0x01,0x02 }; + + Buffer->Set(tag, sizeof(tag)); + Buffer->Append(Packet.GetStreamId()); + Buffer->Append((uint8)(Packet.GetPacketId() % 21)); + Buffer->Append((uint8 *)Packet.GetAmbe(), AMBE_SIZE); + Buffer->Append((uint8 *)Packet.GetDvData(), DVDATA_SIZE); + + return true; + +} + +bool CDextraProtocol::EncodeDvLastFramePacket(const CDvLastFramePacket &Packet, CBuffer *Buffer) const +{ + uint8 tag1[] = { 'D','S','V','T',0x20,0x00,0x00,0x00,0x20,0x00,0x01,0x02 }; + uint8 tag2[] = { 0x55,0xC8,0x7A,0x00,0x00,0x00,0x00,0x00,0x00,0x25,0x1A,0xC6 }; + + Buffer->Set(tag1, sizeof(tag1)); + Buffer->Append(Packet.GetStreamId()); + Buffer->Append((uint8)((Packet.GetPacketId() % 21) | 0x40)); + Buffer->Append(tag2, sizeof(tag2)); + + return true; +} + diff --git a/src/cdextraprotocol.h b/src/cdextraprotocol.h new file mode 100644 index 0000000..a681676 --- /dev/null +++ b/src/cdextraprotocol.h @@ -0,0 +1,85 @@ +// +// cdextraprotocol.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cdextraprotocol_h +#define cdextraprotocol_h + +#include "ctimepoint.h" +#include "cprotocol.h" +#include "cdvheaderpacket.h" +#include "cdvframepacket.h" +#include "cdvlastframepacket.h" + +//////////////////////////////////////////////////////////////////////////////////////// + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CDextraProtocol : public CProtocol +{ +public: + // constructor + CDextraProtocol() {}; + + // destructor + virtual ~CDextraProtocol() {}; + + // initialization + bool Init(void); + + // task + void Task(void); + +protected: + // queue helper + void HandleQueue(void); + + // stream helpers + bool OnDvHeaderPacketIn(CDvHeaderPacket *, const CIp &); + + // packet decoding helpers + bool IsValidConnectPacket(const CBuffer &, CCallsign *, char *); + bool IsValidDisconnectPacket(const CBuffer &, CCallsign *); + bool IsValidKeepAlivePacket(const CBuffer &, CCallsign *); + CDvHeaderPacket *IsValidDvHeaderPacket(const CBuffer &); + CDvFramePacket *IsValidDvFramePacket(const CBuffer &); + CDvLastFramePacket *IsValidDvLastFramePacket(const CBuffer &); + + // packet encoding helpers + void EncodeKeepAlivePacket(CBuffer *); + void EncodeConnectAckPacket(CBuffer *); + void EncodeConnectNackPacket(CBuffer *); + void EncodeDisconnectPacket(CBuffer *); + bool EncodeDvHeaderPacket(const CDvHeaderPacket &, CBuffer *) const; + bool EncodeDvFramePacket(const CDvFramePacket &, CBuffer *) const; + bool EncodeDvLastFramePacket(const CDvLastFramePacket &, CBuffer *) const; + +protected: + // time + CTimePoint m_LastKeepaliveTime; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cdextraprotocol_h */ diff --git a/src/cdplusclient.cpp b/src/cdplusclient.cpp new file mode 100644 index 0000000..e5a09ae --- /dev/null +++ b/src/cdplusclient.cpp @@ -0,0 +1,58 @@ +// +// cdplusclient.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "cdplusclient.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructors + +CDplusClient::CDplusClient() +{ +} + +CDplusClient::CDplusClient(const CCallsign &callsign, const CIp &ip, char reflectorModule) + : CClient(callsign, ip, reflectorModule) +{ +} + +CDplusClient::CDplusClient(const CDplusClient &client) + : CClient(client) +{ +} + +//////////////////////////////////////////////////////////////////////////////////////// +// status + +bool CDplusClient::IsAlive(void) const +{ + return (m_LastKeepaliveTime.DurationSinceNow() < DPLUS_KEEPALIVE_TIMEOUT); +} + +void CDplusClient::SetMasterOfModule(char c) +{ + CClient::SetMasterOfModule(c); + SetReflectorModule(c); +} diff --git a/src/cdplusclient.h b/src/cdplusclient.h new file mode 100644 index 0000000..186205d --- /dev/null +++ b/src/cdplusclient.h @@ -0,0 +1,58 @@ +// +// cdplusclient.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cdplusclient_h +#define cdplusclient_h + +#include "cclient.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// define + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CDplusClient : public CClient +{ +public: + // constructors + CDplusClient(); + CDplusClient(const CCallsign &, const CIp &, char = ' '); + CDplusClient(const CDplusClient &); + + // destructor + virtual ~CDplusClient() {}; + + // identity + int GetProtocol(void) const { return PROTOCOL_DPLUS; } + const char *GetProtocolName(void) const { return "Dplus"; } + + // status + bool IsAlive(void) const; + void SetMasterOfModule(char); +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cdplusclient_h */ diff --git a/src/cdplusprotocol.cpp b/src/cdplusprotocol.cpp new file mode 100644 index 0000000..04fac6a --- /dev/null +++ b/src/cdplusprotocol.cpp @@ -0,0 +1,478 @@ +// +// cdplusprotocol.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include +#include "cdplusclient.h" +#include "cdplusprotocol.h" +#include "creflector.h" +#include "cgatekeeper.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// operation + +bool CDplusProtocol::Init(void) +{ + bool ok; + + // base class + ok = CProtocol::Init(); + + // update the reflector callsign + //m_ReflectorCallsign.PatchCallsign(0, (const uint8 *)"REF", 3); + m_ReflectorCallsign.PatchCallsign(0, (const uint8 *)"XRF", 3); + + // create our socket + ok &= m_Socket.Open(DPLUS_PORT); + + // update time + m_LastKeepaliveTime.Now(); + + // done + return ok; +} + + + +//////////////////////////////////////////////////////////////////////////////////////// +// task + +void CDplusProtocol::Task(void) +{ + CBuffer Buffer; + CIp Ip; + CCallsign Callsign; + CDvHeaderPacket *Header; + CDvFramePacket *Frame; + CDvLastFramePacket *LastFrame; + + // handle incoming packets + if ( m_Socket.Receive(&Buffer, &Ip, 20) != -1 ) + { + // crack the packet + if ( (Frame = IsValidDvFramePacket(Buffer)) != NULL ) + { + //std::cout << "DPlus DV frame" << std::endl; + + // handle it + OnDvFramePacketIn(Frame); + } + else if ( (Header = IsValidDvHeaderPacket(Buffer)) != NULL ) + { + //std::cout << "DPlus DV header:" << std::endl << *Header << std::endl; + + // callsign muted? + if ( g_GateKeeper.MayTransmit(Header->GetMyCallsign(), Ip, PROTOCOL_DPLUS) ) + { + // handle it + OnDvHeaderPacketIn(Header, Ip); + } + else + { + delete Header; + } + } + else if ( (LastFrame = IsValidDvLastFramePacket(Buffer)) != NULL ) + { + //std::cout << "DPlus DV last frame" << std::endl; + + // handle it + OnDvLastFramePacketIn(LastFrame); + } + else if ( IsValidConnectPacket(Buffer) ) + { + std::cout << "DPlus connect request packet from " << Ip << std::endl; + + // acknowledge the request + m_Socket.Send(Buffer, Ip); + } + else if ( IsValidLoginPacket(Buffer, &Callsign) ) + { + std::cout << "DPlus login packet from " << Callsign << " at " << Ip << std::endl; + + // callsign authorized? + if ( g_GateKeeper.MayLink(Callsign, Ip, PROTOCOL_DPLUS) ) + { + // acknowledge the request + EncodeLoginAckPacket(&Buffer); + m_Socket.Send(Buffer, Ip); + + // create the client + CDplusClient *client = new CDplusClient(Callsign, Ip); + + // and append + g_Reflector.GetClients()->AddClient(client); + g_Reflector.ReleaseClients(); + } + else + { + // deny the request + EncodeLoginNackPacket(&Buffer); + m_Socket.Send(Buffer, Ip); + } + + } + else if ( IsValidDisconnectPacket(Buffer) ) + { + std::cout << "DPlus disconnect packet from " << Ip << std::endl; + + // find client & remove it + CClients *clients = g_Reflector.GetClients(); + CClient *client = clients->FindClient(Ip, PROTOCOL_DPLUS); + if ( client != NULL ) + { + clients->RemoveClient(client); + } + g_Reflector.ReleaseClients(); + } + else if ( IsValidKeepAlivePacket(Buffer) ) + { + //std::cout << "DPlus keepalive packet from " << Ip << std::endl; + + // find client & keep it alive + CClient *client = g_Reflector.GetClients()->FindClient(Ip, PROTOCOL_DPLUS); + if ( client != NULL ) + { + client->Alive(); + } + g_Reflector.ReleaseClients(); + } + else + { + std::cout << "DPlus packet (" << Buffer.size() << ")" << std::endl; + } + } + + // handle end of streaming timeout + CheckStreamsTimeout(); + + // handle queue from reflector + HandleQueue(); + + // keep client alive + if ( m_LastKeepaliveTime.DurationSinceNow() > DPLUS_KEEPALIVE_PERIOD ) + { + // send keepalives + CBuffer keepalive; + EncodeKeepAlivePacket(&keepalive); + + // iterate on clients + CClients *clients = g_Reflector.GetClients(); + int index = -1; + CClient *client = NULL; + while ( (client = clients->FindNextClient(PROTOCOL_DPLUS, &index)) != NULL ) + { + // send keepalive + //std::cout << "Sending DPlus packet @ " << client->GetIp() << std::endl; + m_Socket.Send(keepalive, client->GetIp()); + + // is this client busy ? + if ( client->IsAMaster() ) + { + // yes, just tickle it + client->Alive(); + } + // check it's still with us + else if ( !client->IsAlive() ) + { + // no, disconnect + CBuffer disconnect; + EncodeDisconnectPacket(&disconnect); + m_Socket.Send(disconnect, client->GetIp()); + + // and remove it + std::cout << "DPlus client " << client->GetCallsign() << " keepalive timeout" << std::endl; + clients->RemoveClient(client); + } + } + g_Reflector.ReleaseClients(); + + // update time + m_LastKeepaliveTime.Now(); + } + } + +//////////////////////////////////////////////////////////////////////////////////////// +// streams helpers + +bool CDplusProtocol::OnDvHeaderPacketIn(CDvHeaderPacket *Header, const CIp &Ip) +{ + bool newstream = false; + + // find the stream + CPacketStream *stream = GetStream(Header->GetStreamId()); + if ( stream == NULL ) + { + // no stream open yet, open a new one + // find this client + CClient *client = g_Reflector.GetClients()->FindClient(Ip, PROTOCOL_DPLUS); + if ( client != NULL ) + { + // now we know its module, let's update it + if ( !client->HasModule() ) + { + client->SetModule(Header->GetRpt1Module()); + } + // and try to open the stream + if ( (stream = g_Reflector.OpenStream(Header, client)) != NULL ) + { + // keep the handle + m_Streams.push_back(stream); + newstream = true; + } + } + // release + g_Reflector.ReleaseClients(); + } + else + { + // stream already open + // skip packet, but tickle the stream + stream->Tickle(); + // and delete packet + delete Header; + } + + // update last heard + g_Reflector.GetUsers()->Hearing(Header->GetMyCallsign(), Header->GetRpt1Callsign()); + g_Reflector.ReleaseUsers(); + + // done + return newstream; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// queue helper + +void CDplusProtocol::HandleQueue(void) +{ + m_Queue.Lock(); + while ( !m_Queue.empty() ) + { + // get the packet + CPacket *packet = m_Queue.front(); + m_Queue.pop(); + + // encode it + CBuffer buffer; + if ( EncodeDvPacket(*packet, &buffer) ) + { + // and push it to all our clients who are not streaming in + // note that for dplus protocol, all stream of all modules are push to all clients + // it's client who decide which stream he's interrrested in + CClients *clients = g_Reflector.GetClients(); + int index = -1; + CClient *client = NULL; + while ( (client = clients->FindNextClient(PROTOCOL_DPLUS, &index)) != NULL ) + { + // is this client busy ? + if ( !client->IsAMaster() ) + { + // no, send the packet + m_Socket.Send(buffer, client->GetIp()); + + } + } + g_Reflector.ReleaseClients(); + } + + + // done + delete packet; + } + m_Queue.Unlock(); +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// packet decoding helpers + +bool CDplusProtocol::IsValidConnectPacket(const CBuffer &Buffer) +{ + uint8 tag[] = { 0x05,0x00,0x18,0x00,0x01 }; + return (Buffer == CBuffer(tag, sizeof(tag))); +} + +bool CDplusProtocol::IsValidLoginPacket(const CBuffer &Buffer, CCallsign *Callsign) +{ + uint8 Tag[] = { 0x1C,0xC0,0x04,0x00 }; + bool valid = false; + + if ( (Buffer.size() == 28) &&(::memcmp(Buffer.data(), Tag, sizeof(Tag)) == 0) ) + { + Callsign->SetCallsign(&(Buffer.data()[4]), 8); + valid = Callsign->IsValid(); + } + return valid; +} + +bool CDplusProtocol::IsValidDisconnectPacket(const CBuffer &Buffer) +{ + uint8 tag[] = { 0x05,0x00,0x18,0x00,0x00 }; + return (Buffer == CBuffer(tag, sizeof(tag))); +} + +bool CDplusProtocol::IsValidKeepAlivePacket(const CBuffer &Buffer) +{ + uint8 tag[] = { 0x03,0x60,0x00 }; + return (Buffer == CBuffer(tag, sizeof(tag))); +} + +CDvHeaderPacket *CDplusProtocol::IsValidDvHeaderPacket(const CBuffer &Buffer) +{ + CDvHeaderPacket *header = NULL; + + if ( (Buffer.size() == 58) && + (Buffer.data()[0] == 0x3A) && (Buffer.data()[1] == 0x80) && + (Buffer.Compare((uint8 *)"DSVT", 2, 4) == 0) && + (Buffer.data()[6] == 0x10) && (Buffer.data()[10] == 0x20) ) + { + // create packet + header = new CDvHeaderPacket((struct dstar_header *)&(Buffer.data()[17]), + *((uint16 *)&(Buffer.data()[14])), 0x80); + // check validity of packet + if ( !header->IsValid() ) + { + delete header; + header = NULL; + } + } + return header; +} + +CDvFramePacket *CDplusProtocol::IsValidDvFramePacket(const CBuffer &Buffer) +{ + CDvFramePacket *dvframe = NULL; + + if ( (Buffer.size() == 29) && + (Buffer.data()[0] == 0x1D) && (Buffer.data()[1] == 0x80) && + (Buffer.Compare((uint8 *)"DSVT", 2, 4) == 0) && + (Buffer.data()[6] == 0x20) && (Buffer.data()[10] == 0x20) ) + { + // create packet + dvframe = new CDvFramePacket((struct dstar_dvframe *)&(Buffer.data()[17]), + *((uint16 *)&(Buffer.data()[14])), Buffer.data()[16]); + // check validity of packet + if ( !dvframe->IsValid() ) + { + delete dvframe; + dvframe = NULL; + } + } + return dvframe; +} + +CDvLastFramePacket *CDplusProtocol::IsValidDvLastFramePacket(const CBuffer &Buffer) +{ + CDvLastFramePacket *dvframe = NULL; + + if ( (Buffer.size() == 32) && + (Buffer.Compare((uint8 *)"DSVT", 2, 4) == 0) && + (Buffer.data()[0] == 0x20) && (Buffer.data()[1] == 0x80) && + (Buffer.data()[6] == 0x20) && (Buffer.data()[10] == 0x20) ) + { + // create packet + dvframe = new CDvLastFramePacket((struct dstar_dvframe *)&(Buffer.data()[17]), + *((uint16 *)&(Buffer.data()[14])), Buffer.data()[16]); + // check validity of packet + if ( !dvframe->IsValid() ) + { + delete dvframe; + dvframe = NULL; + } + } + return dvframe; +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// packet encoding helpers + +void CDplusProtocol::EncodeKeepAlivePacket(CBuffer *Buffer) +{ + uint8 tag[] = { 0x03,0x60,0x00 }; + Buffer->Set(tag, sizeof(tag)); +} + +void CDplusProtocol::EncodeLoginAckPacket(CBuffer *Buffer) +{ + uint8 tag[] = { 0x08,0xC0,0x04,0x00,'O','K','R','W' }; + Buffer->Set(tag, sizeof(tag)); +} + +void CDplusProtocol::EncodeLoginNackPacket(CBuffer *Buffer) +{ + uint8 tag[] = { 0x08,0xC0,0x04,0x00,'B','U','S','Y' }; + Buffer->Set(tag, sizeof(tag)); +} + +void CDplusProtocol::EncodeDisconnectPacket(CBuffer *Buffer) +{ + uint8 tag[] = { 0x05,0x00,0x18,0x00,0x00 }; + Buffer->Set(tag, sizeof(tag)); +} + + +bool CDplusProtocol::EncodeDvHeaderPacket(const CDvHeaderPacket &Packet, CBuffer *Buffer) const +{ + uint8 tag[] = { 0x3A,0x80,0x44,0x53,0x56,0x54,0x10,0x00,0x00,0x00,0x20,0x00,0x01,0x02 }; + struct dstar_header DstarHeader; + + Packet.ConvertToDstarStruct(&DstarHeader); + + Buffer->Set(tag, sizeof(tag)); + Buffer->Append(Packet.GetStreamId()); + Buffer->Append((uint8)0x80); + Buffer->Append((uint8 *)&DstarHeader, sizeof(struct dstar_header)); + + return true; +} + +bool CDplusProtocol::EncodeDvFramePacket(const CDvFramePacket &Packet, CBuffer *Buffer) const +{ + uint8 tag[] = { 0x1D,0x80,0x44,0x53,0x56,0x54,0x20,0x00,0x00,0x00,0x20,0x00,0x01,0x02 }; + + Buffer->Set(tag, sizeof(tag)); + Buffer->Append(Packet.GetStreamId()); + Buffer->Append((uint8)(Packet.GetPacketId() % 21)); + Buffer->Append((uint8 *)Packet.GetAmbe(), AMBE_SIZE); + Buffer->Append((uint8 *)Packet.GetDvData(), DVDATA_SIZE); + + return true; + +} + +bool CDplusProtocol::EncodeDvLastFramePacket(const CDvLastFramePacket &Packet, CBuffer *Buffer) const +{ + uint8 tag1[] = { 0x20,0x80,0x44,0x53,0x56,0x54,0x20,0x00,0x81,0x00,0x20,0x00,0x01,0x02 }; + uint8 tag2[] = { 0x55,0xC8,0x7A,0x55,0x55,0x55,0x55,0x55,0x55,0x55,0x55,0x55,0x25,0x1A,0xC6 }; + + Buffer->Set(tag1, sizeof(tag1)); + Buffer->Append(Packet.GetStreamId()); + Buffer->Append((uint8)((Packet.GetPacketId() % 21) | 0x40)); + Buffer->Append(tag2, sizeof(tag2)); + + return true; +} diff --git a/src/cdplusprotocol.h b/src/cdplusprotocol.h new file mode 100644 index 0000000..9cd1bec --- /dev/null +++ b/src/cdplusprotocol.h @@ -0,0 +1,86 @@ +// +// cdplusprotocol.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cdplusprotocol_h +#define cdplusprotocol_h + +#include "ctimepoint.h" +#include "cprotocol.h" +#include "cdvheaderpacket.h" +#include "cdvframepacket.h" +#include "cdvlastframepacket.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// define + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CDplusProtocol : public CProtocol +{ +public: + // constructor + CDplusProtocol() {}; + + // destructor + virtual ~CDplusProtocol() {}; + + // initialization + bool Init(void); + + // task + void Task(void); + +protected: + // stream helpers + bool OnDvHeaderPacketIn(CDvHeaderPacket *, const CIp &); + + // packet decoding helpers + bool IsValidConnectPacket(const CBuffer &); + bool IsValidLoginPacket(const CBuffer &, CCallsign *); + bool IsValidDisconnectPacket(const CBuffer &); + bool IsValidKeepAlivePacket(const CBuffer &); + CDvHeaderPacket *IsValidDvHeaderPacket(const CBuffer &); + CDvFramePacket *IsValidDvFramePacket(const CBuffer &); + CDvLastFramePacket *IsValidDvLastFramePacket(const CBuffer &); + + // packet encoding helpers + void EncodeKeepAlivePacket(CBuffer *); + void EncodeLoginAckPacket(CBuffer *); + void EncodeLoginNackPacket(CBuffer *); + void EncodeDisconnectPacket(CBuffer *); + bool EncodeDvHeaderPacket(const CDvHeaderPacket &, CBuffer *) const; + bool EncodeDvFramePacket(const CDvFramePacket &, CBuffer *) const; + bool EncodeDvLastFramePacket(const CDvLastFramePacket &, CBuffer *) const; + + // queue helper + void HandleQueue(void); + +protected: + // for keep alive + CTimePoint m_LastKeepaliveTime; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cdplusprotocol_h */ diff --git a/src/cdvframepacket.cpp b/src/cdvframepacket.cpp new file mode 100644 index 0000000..b037ab7 --- /dev/null +++ b/src/cdvframepacket.cpp @@ -0,0 +1,71 @@ +// +// cdvframepacket.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + + +#include "main.h" +#include +#include "cdvframepacket.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CDvFramePacket::CDvFramePacket() +{ + ::memset(m_uiAmbe, 0, sizeof(m_uiAmbe)); + ::memset(m_uiDvData, 0, sizeof(m_uiDvData)); +} + +CDvFramePacket::CDvFramePacket(const struct dstar_dvframe *dvframe, uint16 sid, uint8 pid) + : CPacket(sid, pid) +{ + ::memcpy(m_uiAmbe, dvframe->AMBE, sizeof(m_uiAmbe)); + ::memcpy(m_uiDvData, dvframe->DVDATA, sizeof(m_uiDvData)); +} + + +CDvFramePacket::CDvFramePacket(const CDvFramePacket &DvFrame) + : CPacket(DvFrame) +{ + ::memcpy(m_uiAmbe, DvFrame.m_uiAmbe, sizeof(m_uiAmbe)); + ::memcpy(m_uiDvData, DvFrame.m_uiDvData, sizeof(m_uiDvData)); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// virtual duplication + +CPacket *CDvFramePacket::Duplicate(void) const +{ + return new CDvFramePacket(*this); +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// operators + +bool CDvFramePacket::operator ==(const CDvFramePacket &DvFrame) const +{ + return ( (::memcmp(m_uiAmbe, DvFrame.m_uiAmbe, sizeof(m_uiAmbe)) == 0) && + (::memcmp(m_uiDvData, DvFrame.m_uiDvData, sizeof(m_uiDvData)) == 0) ); +} diff --git a/src/cdvframepacket.h b/src/cdvframepacket.h new file mode 100644 index 0000000..c02ce3a --- /dev/null +++ b/src/cdvframepacket.h @@ -0,0 +1,79 @@ +// +// cdvframepacket.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cdvframepacket_h +#define cdvframepacket_h + +#include "cpacket.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// defines + +#define AMBE_SIZE 9 +#define DVDATA_SIZE 3 + +// typedef & structures + +struct __attribute__ ((__packed__))dstar_dvframe +{ + uint8 AMBE[AMBE_SIZE]; + uint8 DVDATA[DVDATA_SIZE]; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CDvFramePacket : public CPacket +{ +public: + // constructor + CDvFramePacket(); + CDvFramePacket(const struct dstar_dvframe *, uint16 = 0, uint8 = 0); + CDvFramePacket(const CDvFramePacket &); + + // destructor + virtual ~CDvFramePacket() {}; + + // virtual duplication + CPacket *Duplicate(void) const; + + // identity + bool IsDvFrame(void) const { return true; } + + // get + const uint8 *GetAmbe(void) const { return m_uiAmbe; } + const uint8 *GetDvData(void) const { return m_uiDvData; } + + // operators + bool operator ==(const CDvFramePacket &) const; + +protected: + // data + uint8 m_uiAmbe[AMBE_SIZE]; + uint8 m_uiDvData[DVDATA_SIZE]; +}; + + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cdvframepacket_h */ diff --git a/src/cdvheaderpacket.cpp b/src/cdvheaderpacket.cpp new file mode 100644 index 0000000..f7cf04b --- /dev/null +++ b/src/cdvheaderpacket.cpp @@ -0,0 +1,137 @@ +// +// cdvheaderpacket.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include +#include +#include "cdvheaderpacket.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CDvHeaderPacket::CDvHeaderPacket() +{ + m_uiFlag1 = 0; + m_uiFlag2 = 0; + m_uiFlag3 = 0; + m_uiCrc = 0; +} + +CDvHeaderPacket::CDvHeaderPacket(const struct dstar_header *buffer, uint16 sid, uint8 pid) + : CPacket(sid, pid) +{ + m_uiFlag1 = buffer->Flag1; + m_uiFlag2 = buffer->Flag2; + m_uiFlag3 = buffer->Flag3; + m_csUR.SetCallsign(buffer->UR, CALLSIGN_LEN); + m_csRPT1.SetCallsign(buffer->RPT1, CALLSIGN_LEN); + m_csRPT2.SetCallsign(buffer->RPT2, CALLSIGN_LEN); + m_csMY.SetCallsign(buffer->MY, CALLSIGN_LEN); + m_csMY.SetSuffix(buffer->SUFFIX, CALLSUFFIX_LEN); + m_uiCrc = buffer->Crc; +} + +CDvHeaderPacket::CDvHeaderPacket(const CDvHeaderPacket &Header) + : CPacket(Header) +{ + m_uiFlag1 = Header.m_uiFlag1; + m_uiFlag2 = Header.m_uiFlag2; + m_uiFlag3 = Header.m_uiFlag3; + m_csUR = Header.m_csUR; + m_csRPT1 = Header.m_csRPT1; + m_csRPT2 = Header.m_csRPT2; + m_csMY = Header.m_csMY; + m_uiCrc = Header.m_uiCrc; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// virtual duplication + +CPacket *CDvHeaderPacket::Duplicate(void) const +{ + return new CDvHeaderPacket(*this); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// conversion + +void CDvHeaderPacket::ConvertToDstarStruct(struct dstar_header *buffer) const +{ + ::memset(buffer, 0, sizeof(struct dstar_header)); + buffer->Flag1 = m_uiFlag1; + buffer->Flag2 = m_uiFlag2; + buffer->Flag3 = m_uiFlag3; + m_csUR.GetCallsign(buffer->UR); + m_csRPT1.GetCallsign(buffer->RPT1); + m_csRPT2.GetCallsign(buffer->RPT2); + m_csMY.GetCallsign(buffer->MY); + m_csMY.GetSuffix(buffer->SUFFIX); + buffer->Crc = m_uiCrc; +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// get valid + +bool CDvHeaderPacket::IsValid(void) const +{ + bool valid = CPacket::IsValid(); + + valid &= m_csRPT1.IsValid(); + valid &= m_csRPT2.IsValid(); + valid &= m_csMY.IsValid(); + + return valid; +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// operators + +bool CDvHeaderPacket::operator ==(const CDvHeaderPacket &Header) const +{ + return ( (m_uiFlag1 == Header.m_uiFlag1) && + (m_uiFlag2 == Header.m_uiFlag2) && + (m_uiFlag3 == Header.m_uiFlag3) && + (m_csUR == Header.m_csUR) && + (m_csRPT1 == Header.m_csRPT1) && + (m_csRPT2 == Header.m_csRPT2) && + (m_csMY == Header.m_csMY) ); +} + +#ifdef IMPLEMENT_CDVHEADERPACKET_CONST_CHAR_OPERATOR +CDvHeaderPacket::operator const char *() const +{ + char *sz = (char *)(const char *)m_sz; + + std::sprintf(sz, "%02X %02X %02X\n%s\n%s\n%s\n%s", + m_uiFlag1, m_uiFlag2, m_uiFlag3, + (const char *)m_csUR, + (const char *)m_csRPT1, + (const char *)m_csRPT2, + (const char *)m_csMY); + + return m_sz; +} +#endif \ No newline at end of file diff --git a/src/cdvheaderpacket.h b/src/cdvheaderpacket.h new file mode 100644 index 0000000..b4acf33 --- /dev/null +++ b/src/cdvheaderpacket.h @@ -0,0 +1,120 @@ +// +// cdvheaderpacket.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cdvheaderpacket_h +#define cdvheaderpacket_h + +#include "ccallsign.h" +#include "cpacket.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// implementation details + +//#define IMPLEMENT_CDVHEADERPACKET_CONST_CHAR_OPERATOR + +//////////////////////////////////////////////////////////////////////////////////////// +// typedef & structures + +struct __attribute__ ((__packed__))dstar_header +{ + // flags + uint8 Flag1; + uint8 Flag2; + uint8 Flag3; + // callsigns + uint8 RPT2[CALLSIGN_LEN]; + uint8 RPT1[CALLSIGN_LEN]; + uint8 UR[CALLSIGN_LEN]; + uint8 MY[CALLSIGN_LEN]; + uint8 SUFFIX[CALLSUFFIX_LEN]; + // crc + uint16 Crc; +}; + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CDvHeaderPacket : public CPacket +{ +public: + // constructor + CDvHeaderPacket(); + CDvHeaderPacket(const struct dstar_header *, uint16 = 0, uint8 = 0); + CDvHeaderPacket(const CDvHeaderPacket &); + + // destructor + virtual ~CDvHeaderPacket(){}; + + // virtual duplication + CPacket *Duplicate(void) const; + + // identity + bool IsDvHeader(void) const { return true; } + + // conversion + void ConvertToDstarStruct(struct dstar_header *) const; + + // get valid + bool IsValid(void) const; + + // get callsigns + const CCallsign &GetUrCallsign(void) const { return m_csUR; } + const CCallsign &GetRpt1Callsign(void) const { return m_csRPT1; } + const CCallsign &GetRpt2Callsign(void) const { return m_csRPT2; } + const CCallsign &GetMyCallsign(void) const { return m_csMY; } + + // get modules + char GetUrModule(void) const { return m_csUR.GetModule(); } + char GetRpt1Module(void) const { return m_csRPT1.GetModule(); } + char GetRpt2Module(void) const { return m_csRPT2.GetModule(); } + char GetMyModule(void) const { return m_csMY.GetModule(); } + + // set callsigns + void SetRpt2Callsign(const CCallsign &cs) { m_csRPT2 = cs; } + + // operators + bool operator ==(const CDvHeaderPacket &) const; +#ifdef IMPLEMENT_CDVHEADERPACKET_CONST_CHAR_OPERATOR + operator const char *() const; +#endif + +protected: + // data + uint8 m_uiFlag1; + uint8 m_uiFlag2; + uint8 m_uiFlag3; + CCallsign m_csUR; + CCallsign m_csRPT1; + CCallsign m_csRPT2; + CCallsign m_csMY; + uint16 m_uiCrc; +#ifdef IMPLEMENT_CDVHEADERPACKET_CONST_CHAR_OPERATOR + // buffer + char m_sz[32]; +#endif +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cdvheaderpacket_h */ diff --git a/src/cdvlastframepacket.cpp b/src/cdvlastframepacket.cpp new file mode 100644 index 0000000..e37c033 --- /dev/null +++ b/src/cdvlastframepacket.cpp @@ -0,0 +1,53 @@ +// +// cdvlastframepacket.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 03/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "cdvlastframepacket.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CDvLastFramePacket::CDvLastFramePacket() +{ +} + +CDvLastFramePacket::CDvLastFramePacket(const struct dstar_dvframe *DvFrame, uint16 sid, uint8 pid) + : CDvFramePacket(DvFrame, sid, pid) +{ +} + +CDvLastFramePacket::CDvLastFramePacket(const CDvLastFramePacket &DvFrame) + : CDvFramePacket(DvFrame) +{ +} + +//////////////////////////////////////////////////////////////////////////////////////// +// virtual duplication + +CPacket *CDvLastFramePacket::Duplicate(void) const +{ + return new CDvLastFramePacket(*this); +} + diff --git a/src/cdvlastframepacket.h b/src/cdvlastframepacket.h new file mode 100644 index 0000000..44622cc --- /dev/null +++ b/src/cdvlastframepacket.h @@ -0,0 +1,58 @@ +// +// cdvlastframepacket.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 03/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cdvlastframepacket_h +#define cdvlastframepacket_h + + +#include "cdvframepacket.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// defines + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CDvLastFramePacket : public CDvFramePacket +{ +public: + // constructor + CDvLastFramePacket(); + CDvLastFramePacket(const struct dstar_dvframe *, uint16 = 0, uint8 = 0); + CDvLastFramePacket(const CDvLastFramePacket &); + + // destructor + virtual ~CDvLastFramePacket() {}; + + // virtual duplication + CPacket *Duplicate(void) const; + + // identity + bool IsLastPacket(void) const { return true; } +}; + + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cdvlastframepacket_h */ diff --git a/src/cgatekeeper.cpp b/src/cgatekeeper.cpp new file mode 100644 index 0000000..614d489 --- /dev/null +++ b/src/cgatekeeper.cpp @@ -0,0 +1,27 @@ +// +// cgatekeeper.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 07/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "cgatekeeper.h" + +CGateKeeper g_GateKeeper; diff --git a/src/cgatekeeper.h b/src/cgatekeeper.h new file mode 100644 index 0000000..dee78b3 --- /dev/null +++ b/src/cgatekeeper.h @@ -0,0 +1,51 @@ +// +// cgatekeeper.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 07/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cgatekeeper_h +#define cgatekeeper_h + +#include "main.h" +#include "ccallsign.h" +#include "cip.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CGateKeeper +{ +public: + // constructor + CGateKeeper() {} + + // destructor + ~CGateKeeper() {} + + // operation + bool MayLink(const CCallsign &, const CIp &, int) { return true; } + bool MayTransmit(const CCallsign &, const CIp &, int) { return true; } +}; + + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cgatekeeper_h */ diff --git a/src/cip.cpp b/src/cip.cpp new file mode 100644 index 0000000..6d496d4 --- /dev/null +++ b/src/cip.cpp @@ -0,0 +1,77 @@ +// +// cip.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include +#include +#include "cip.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// constructors + +CIp::CIp() +{ + ::memset(&m_Addr, 0, sizeof(m_Addr)); +} + +CIp::CIp(const char *sz) +{ + ::memset(&m_Addr, 0, sizeof(m_Addr)); + m_Addr.sin_addr.s_addr = inet_addr(sz); +} + +CIp::CIp(const struct sockaddr_in *sa) +{ + ::memcpy(&m_Addr, sa, sizeof(m_Addr)); +} + + +CIp::CIp(const CIp &ip) +{ + ::memcpy(&m_Addr, &ip.m_Addr, sizeof(m_Addr)); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// set + +void CIp::SetSockAddr(struct sockaddr_in *sa) +{ + ::memcpy(&m_Addr, sa, sizeof(m_Addr)); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// operator + +bool CIp::operator ==(const CIp &ip) const +{ + return ( (ip.m_Addr.sin_family == m_Addr.sin_family) && + (ip.m_Addr.sin_addr.s_addr == m_Addr.sin_addr.s_addr)) ; +} + +CIp::operator const char *() const +{ + return ::inet_ntoa(m_Addr.sin_addr); +} + + diff --git a/src/cip.h b/src/cip.h new file mode 100644 index 0000000..3a65fd6 --- /dev/null +++ b/src/cip.h @@ -0,0 +1,59 @@ +// +// cip.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cip_h +#define cip_h + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CIp +{ +public: + // constructors + CIp(); + //CIp(uint8, uint8, uint8, uint8); + CIp(const struct sockaddr_in *); + CIp(const char *); + CIp(const CIp &); + + // destructor + virtual ~CIp() {}; + + // sockaddr + void SetSockAddr(struct sockaddr_in *); + struct sockaddr_in *GetSockAddr(void) { return &m_Addr; } + + // operator + bool operator ==(const CIp &) const; + operator const char *() const; + +protected: + // data + struct sockaddr_in m_Addr; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cip_h */ diff --git a/src/cnotification.cpp b/src/cnotification.cpp new file mode 100644 index 0000000..782013d --- /dev/null +++ b/src/cnotification.cpp @@ -0,0 +1,52 @@ +// +// cnotification.cpp +// xlxd +// +// Created by Jean-Luc on 05/12/2015. +// Copyright © 2015 Jean-Luc. All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "cnotification.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CNotification::CNotification() +{ + // init variables + m_iId = NOTIFICATION_NONE; +} + +CNotification::CNotification(const CNotification &Notification) +{ + m_iId = Notification.m_iId; + m_Callsign = Notification.m_Callsign; +} + +CNotification::CNotification(int iId) +{ + m_iId = iId; +} + +CNotification::CNotification(int iId, const CCallsign &Callsign) +{ + m_iId = iId; + m_Callsign = Callsign; +} diff --git a/src/cnotification.h b/src/cnotification.h new file mode 100644 index 0000000..da7d570 --- /dev/null +++ b/src/cnotification.h @@ -0,0 +1,67 @@ +// +// cnotification.h +// xlxd +// +// Created by Jean-Luc on 05/12/2015. +// Copyright © 2015 Jean-Luc. All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + + +#ifndef cnotification_h +#define cnotification_h + +#include "ccallsign.h" + +//////////////////////////////////////////////////////////////////////////////////////// + +// Id +#define NOTIFICATION_NONE 0 +#define NOTIFICATION_CLIENTS 1 +#define NOTIFICATION_USERS 2 +#define NOTIFICATION_STREAM_OPEN 3 +#define NOTIFICATION_STREAM_CLOSE 4 + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CNotification +{ +public: + // constructor + CNotification(); + CNotification(const CNotification &); + CNotification(int); + CNotification(int, const CCallsign &); + + // destructor + ~CNotification() {}; + + // get + int GetId(void) const { return m_iId; } + const CCallsign &GetCallsign(void) const { return m_Callsign; } + +protected: + // data + int m_iId; + CCallsign m_Callsign; + +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cnotification_h */ diff --git a/src/cnotificationqueue.h b/src/cnotificationqueue.h new file mode 100644 index 0000000..6e13980 --- /dev/null +++ b/src/cnotificationqueue.h @@ -0,0 +1,57 @@ +// +// cnotificationqueue.h +// xlxd +// +// Created by Jean-Luc on 05/12/2015. +// Copyright © 2015 Jean-Luc. All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + + + +#ifndef cnotificationqueue_h +#define cnotificationqueue_h + +#include "cnotification.h" + + +//////////////////////////////////////////////////////////////////////////////////////// + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CNotificationQueue : public std::queue +{ +public: + // constructor + CNotificationQueue() {}; + + // destructor + ~CNotificationQueue() {}; + + // lock + void Lock() { m_Mutex.lock(); } + void Unlock() { m_Mutex.unlock(); } + +protected: + // data + std::mutex m_Mutex; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cnotificationqueue_h */ diff --git a/src/cpacket.cpp b/src/cpacket.cpp new file mode 100644 index 0000000..2c24bc1 --- /dev/null +++ b/src/cpacket.cpp @@ -0,0 +1,51 @@ +// +// cpacket.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 04/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "cpacket.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CPacket::CPacket() +{ + m_uiStreamId = 0; + m_uiPacketId = 0; + m_uiModuleId = ' '; +}; + +CPacket::CPacket(uint16 sid, uint8 pid) +{ + m_uiStreamId = sid; + m_uiPacketId = pid; + m_uiModuleId = ' '; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +// virtual duplication + +CPacket *CPacket::Duplicate(void) const +{ + return new CPacket(*this); +} diff --git a/src/cpacket.h b/src/cpacket.h new file mode 100644 index 0000000..34439e1 --- /dev/null +++ b/src/cpacket.h @@ -0,0 +1,72 @@ +// +// cpacket.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cpacket_h +#define cpacket_h + +//////////////////////////////////////////////////////////////////////////////////////// + + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CPacket +{ +public: + // constructor + CPacket(); + CPacket(uint16 sid, uint8 pid); + + // destructor + virtual ~CPacket() {}; + + // virtual duplication + virtual CPacket *Duplicate(void) const; + + // identity + virtual bool IsDvHeader(void) const { return false; } + virtual bool IsDvFrame(void) const { return false; } + virtual bool IsLastPacket(void) const { return false; } + + // get + virtual bool IsValid(void) const { return true; } + uint16 GetStreamId(void) const { return m_uiStreamId; } + uint8 GetPacketId(void) const { return m_uiPacketId; } + uint8 GetModuleId(void) const { return m_uiModuleId; } + + // set + void SetModuleId(uint8 uiId) { m_uiModuleId = uiId; } + +protected: + // data + uint16 m_uiStreamId; + uint8 m_uiPacketId; + uint8 m_uiModuleId; +}; + + + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cpacket_h */ diff --git a/src/cpacketqueue.h b/src/cpacketqueue.h new file mode 100644 index 0000000..818dbd3 --- /dev/null +++ b/src/cpacketqueue.h @@ -0,0 +1,60 @@ +// +// cpacketqueue.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 02/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cpacketqueue_h +#define cpacketqueue_h + +#include "cpacket.h" +#include "cclient.h" + +//////////////////////////////////////////////////////////////////////////////////////// + +//////////////////////////////////////////////////////////////////////////////////////// +// CPacketQueue + +class CPacketQueue : public std::queue +{ +public: + // constructor + CPacketQueue() {}; + + // destructor + ~CPacketQueue() {}; + + // lock + void Lock() { m_Mutex.lock(); } + void Unlock() { m_Mutex.unlock(); } + +protected: + // status + bool m_bOpen; + uint16 m_uiStreamId; + std::mutex m_Mutex; + + // owner + CClient *m_Client; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cpacketqueue_h */ diff --git a/src/cpacketstream.cpp b/src/cpacketstream.cpp new file mode 100644 index 0000000..5e78bee --- /dev/null +++ b/src/cpacketstream.cpp @@ -0,0 +1,75 @@ +// +// cpacketstream.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 06/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "cpacketstream.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CPacketStream::CPacketStream() +{ + m_bOpen = false; + m_uiStreamId = 0; + m_OwnerClient = NULL; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// open / close + +bool CPacketStream::Open(const CDvHeaderPacket &DvHeader, CClient *client) +{ + bool ok = false; + + // not already open? + if ( !m_bOpen ) + { + // update status + m_bOpen = true; + m_uiStreamId = DvHeader.GetStreamId(); + m_DvHeader = DvHeader; + m_OwnerClient = client; + m_LastPacketTime.Now(); + ok = true; + } + return ok; +} + +void CPacketStream::Close(void) +{ + // update status + m_bOpen = false; + m_uiStreamId = 0; + m_OwnerClient = NULL; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// push & pop + +void CPacketStream::Push(CPacket *Packet) +{ + m_LastPacketTime.Now(); + push(Packet); +} + diff --git a/src/cpacketstream.h b/src/cpacketstream.h new file mode 100644 index 0000000..2c5575c --- /dev/null +++ b/src/cpacketstream.h @@ -0,0 +1,72 @@ +// +// cpacketstream.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 06/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cpacketstream_h +#define cpacketstream_h + +#include "cpacketqueue.h" +#include "ctimepoint.h" +#include "cdvheaderpacket.h" + +//////////////////////////////////////////////////////////////////////////////////////// + +#define STREAM_TIMEOUT (0.200) + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CPacketStream : public CPacketQueue +{ +public: + // constructor + CPacketStream(); + + // destructor + virtual ~CPacketStream() {}; + + // open / close + bool Open(const CDvHeaderPacket &, CClient *); + void Close(void); + + // push & pop + void Push(CPacket *); + void Tickle(void) { m_LastPacketTime.Now(); } + + // get + CClient *GetOwnerClient(void) { return m_OwnerClient; } + bool IsExpired(void) const { return (m_LastPacketTime.DurationSinceNow() > STREAM_TIMEOUT); } + uint16 GetStreamId(void) const { return m_uiStreamId; } + const CCallsign &GetUserCallsign(void) const { return m_DvHeader.GetMyCallsign(); } + +protected: + // data + bool m_bOpen; + uint16 m_uiStreamId; + CClient *m_OwnerClient; + CTimePoint m_LastPacketTime; + CDvHeaderPacket m_DvHeader; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cpacketstream_h */ diff --git a/src/cprotocol.cpp b/src/cprotocol.cpp new file mode 100644 index 0000000..403b09b --- /dev/null +++ b/src/cprotocol.cpp @@ -0,0 +1,221 @@ +// +// cprotocol.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "cprotocol.h" +#include "cclients.h" +#include "creflector.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + + +CProtocol::CProtocol() +{ + m_bStopThread = false; + m_pThread = NULL; + m_Streams.reserve(NB_OF_MODULES); +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// destructor + +CProtocol::~CProtocol() +{ + // kill threads + m_bStopThread = true; + if ( m_pThread != NULL ) + { + m_pThread->join(); + delete m_pThread; + } + + // empty queue + m_Queue.Lock(); + while ( !m_Queue.empty() ) + { + m_Queue.pop(); + } + m_Queue.Unlock(); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// initialization + +bool CProtocol::Init(void) +{ + // init reflector apparent callsign + m_ReflectorCallsign = g_Reflector.GetCallsign(); + + // reset stop flag + m_bStopThread = false; + + // start thread; + m_pThread = new std::thread(CProtocol::Thread, this); + + // done + return true; +} + +void CProtocol::Close(void) +{ + m_bStopThread = true; + if ( m_pThread != NULL ) + { + m_pThread->join(); + delete m_pThread; + m_pThread = NULL; + } +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// thread + +void CProtocol::Thread(CProtocol *This) +{ + + while ( !This->m_bStopThread ) + { + This->Task(); + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// packet encoding helpers + +bool CProtocol::EncodeDvPacket(const CPacket &packet, CBuffer *buffer) const +{ + bool ok = false; + if ( packet.IsDvFrame() ) + { + if ( packet.IsLastPacket() ) + { + ok = EncodeDvLastFramePacket((const CDvLastFramePacket &)packet, buffer); + } + else + { + ok = EncodeDvFramePacket((const CDvFramePacket &)packet, buffer); + } + } + else if ( packet.IsDvHeader() ) + { + ok = EncodeDvHeaderPacket((const CDvHeaderPacket &)packet, buffer); + } + else + { + buffer->clear(); + } + return ok; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// streams helpers + +void CProtocol::OnDvFramePacketIn(CDvFramePacket *Frame) +{ + // find the stream + CPacketStream *stream = GetStream(Frame->GetStreamId()); + if ( stream != NULL ) + { + //std::cout << "DV frame" << std::endl; + // and push + stream->Lock(); + stream->Push(Frame); + stream->Unlock(); + } +} + +void CProtocol::OnDvLastFramePacketIn(CDvLastFramePacket *Frame) +{ + // find the stream + CPacketStream *stream = GetStream(Frame->GetStreamId()); + if ( stream != NULL ) + { + // push + stream->Lock(); + stream->Push(Frame); + stream->Unlock(); + + // and close the stream + g_Reflector.CloseStream(stream); + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// stream handle helpers + +CPacketStream *CProtocol::GetStream(uint16 uiStreamId) +{ + CPacketStream *stream = NULL; + for ( int i = 0; (i < m_Streams.size()) && (stream == NULL); i++ ) + { + if ( m_Streams[i]->GetStreamId() == uiStreamId ) + { + stream = m_Streams[i]; + } + } + return stream; +} + +void CProtocol::CheckStreamsTimeout(void) +{ + for ( int i = 0; i < m_Streams.size(); i++ ) + { + // time out ? + m_Streams[i]->Lock(); + if ( m_Streams[i]->IsExpired() ) + { + // yes, close it + m_Streams[i]->Unlock(); + g_Reflector.CloseStream(m_Streams[i]); + // and remove it + m_Streams.erase(m_Streams.begin()+i); + } + else + { + m_Streams[i]->Unlock(); + } + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// queue helper + +void CProtocol::HandleQueue(void) +{ + // the default protocol just keep queue empty + m_Queue.Lock(); + while ( !m_Queue.empty() ) + { + delete m_Queue.front(); + m_Queue.pop(); + } + m_Queue.Unlock(); +} + + + diff --git a/src/cprotocol.h b/src/cprotocol.h new file mode 100644 index 0000000..64129d5 --- /dev/null +++ b/src/cprotocol.h @@ -0,0 +1,102 @@ +// +// cprotocol.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cprotocol_h +#define cprotocol_h + +#include "cudpsocket.h" +#include "cpacketstream.h" +#include "cdvheaderpacket.h" +#include "cdvframepacket.h" +#include "cdvlastframepacket.h" + +//////////////////////////////////////////////////////////////////////////////////////// + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CProtocol +{ +public: + // constructor + CProtocol(); + + // destructor + virtual ~CProtocol(); + + // initialization + virtual bool Init(void); + virtual void Close(void); + + // queue + CPacketQueue *GetQueue(void) { m_Queue.Lock(); return &m_Queue; } + void ReleaseQueue(void) { m_Queue.Unlock(); } + + // get + const CCallsign &GetReflectorCallsign(void)const { return m_ReflectorCallsign; } + + // task + static void Thread(CProtocol *); + virtual void Task(void) {}; + +protected: + // packet encoding helpers + virtual bool EncodeDvPacket(const CPacket &, CBuffer *) const; + virtual bool EncodeDvHeaderPacket(const CDvHeaderPacket &, CBuffer *) const { return false; } + virtual bool EncodeDvFramePacket(const CDvFramePacket &, CBuffer *) const { return false; } + virtual bool EncodeDvLastFramePacket(const CDvLastFramePacket &, CBuffer *) const { return false; } + + // stream helpers + virtual bool OnDvHeaderPacketIn(CDvHeaderPacket *, const CIp &) { return false; } + virtual void OnDvFramePacketIn(CDvFramePacket *); + virtual void OnDvLastFramePacketIn(CDvLastFramePacket *); + + // stream handle helpers + CPacketStream *GetStream(uint16); + void CheckStreamsTimeout(void); + + // queue helper + virtual void HandleQueue(void); + +protected: + // socket + CUdpSocket m_Socket; + + // streams + std::vector m_Streams; + + // queue + CPacketQueue m_Queue; + + // thread + bool m_bStopThread; + std::thread *m_pThread; + + // identity + CCallsign m_ReflectorCallsign; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cprotocol_h */ diff --git a/src/cprotocols.cpp b/src/cprotocols.cpp new file mode 100644 index 0000000..1254592 --- /dev/null +++ b/src/cprotocols.cpp @@ -0,0 +1,99 @@ +// +// cprotocols.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "cdextraprotocol.h" +#include "cdplusprotocol.h" +#include "cdcsprotocol.h" +#include "cprotocols.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CProtocols::CProtocols() +{ + for ( int i = 0; i < m_Protocols.size(); i++ ) + { + m_Protocols[i] = NULL; + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// destructor + +CProtocols::~CProtocols() +{ + m_Mutex.lock(); + { + for ( int i = 0; i < m_Protocols.size(); i++ ) + { + delete m_Protocols[i]; + } + } + m_Mutex.unlock(); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// initialization + +bool CProtocols::Init(void) +{ + bool ok = true; + + m_Mutex.lock(); + { + // create and initialize DEXTRA + delete m_Protocols[0]; + m_Protocols[0] = new CDextraProtocol; + ok &= m_Protocols[0]->Init(); + + // create and initialize DPLUS + delete m_Protocols[1]; + m_Protocols[1] = new CDplusProtocol; + ok &= m_Protocols[1]->Init(); + + // create and initialize DCS + delete m_Protocols[2]; + m_Protocols[2] = new CDcsProtocol; + ok &= m_Protocols[2]->Init(); + + } + m_Mutex.unlock(); + + // done + return ok; +} + +void CProtocols::Close(void) +{ + m_Mutex.lock(); + { + for ( int i = 0; i < m_Protocols.size(); i++ ) + { + m_Protocols[i]->Close(); + } + } + m_Mutex.unlock(); +} diff --git a/src/cprotocols.h b/src/cprotocols.h new file mode 100644 index 0000000..c0194a7 --- /dev/null +++ b/src/cprotocols.h @@ -0,0 +1,64 @@ +// +// cprotocols.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 01/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cprotocols_h +#define cprotocols_h + +#include "cprotocol.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// define + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CProtocols +{ +public: + // constructors + CProtocols(); + + // destructors + virtual ~CProtocols(); + + // initialization + bool Init(void); + void Close(void); + + // get + int Size(void) const { return (int)m_Protocols.size(); } + CProtocol *GetProtocol(int i) { return m_Protocols[i]; } + +protected: + // data + std::mutex m_Mutex; + std::array m_Protocols; +}; + + +//////////////////////////////////////////////////////////////////////////////////////// + +#endif /* cprotocols_h */ diff --git a/src/creflector.cpp b/src/creflector.cpp new file mode 100644 index 0000000..ab52e4a --- /dev/null +++ b/src/creflector.cpp @@ -0,0 +1,659 @@ +// +// creflector.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include +#include "creflector.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CReflector::CReflector() +{ + m_bStopThreads = false; + m_XmlReportThread = NULL; + m_JsonReportThread = NULL; + for ( int i = 0; i < NB_OF_MODULES; i++ ) + { + m_RouterThreads[i] = NULL; + } +} + +CReflector::CReflector(const CCallsign &callsign) +{ + m_bStopThreads = false; + m_XmlReportThread = NULL; + m_JsonReportThread = NULL; + for ( int i = 0; i < NB_OF_MODULES; i++ ) + { + m_RouterThreads[i] = NULL; + } + m_Callsign = callsign; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// destructor + +CReflector::~CReflector() +{ + m_bStopThreads = true; + if ( m_XmlReportThread != NULL ) + { + m_XmlReportThread->join(); + delete m_XmlReportThread; + } + if ( m_JsonReportThread != NULL ) + { + m_JsonReportThread->join(); + delete m_JsonReportThread; + } + for ( int i = 0; i < NB_OF_MODULES; i++ ) + { + if ( m_RouterThreads[i] != NULL ) + { + m_RouterThreads[i]->join(); + delete m_RouterThreads[i]; + } + } +} + + +//////////////////////////////////////////////////////////////////////////////////////// +// operation + +bool CReflector::Start(void) +{ + bool ok = true; + + // reset stop flag + m_bStopThreads = false; + + // create protocols + ok &= m_Protocols.Init(); + + // start one thread per reflector module + for ( int i = 0; i < NB_OF_MODULES; i++ ) + { + m_RouterThreads[i] = new std::thread(CReflector::RouterThread, this, &(m_Streams[i])); + } + + // start the reporting threads + m_XmlReportThread = new std::thread(CReflector::XmlReportThread, this); +#ifdef JSON_MONITOR + m_JsonReportThread = new std::thread(CReflector::JsonReportThread, this); +#endif + + // done + return ok; +} + +void CReflector::Stop(void) +{ + // stop & delete all threads + m_bStopThreads = true; + + // stop & delete report threads + if ( m_XmlReportThread != NULL ) + { + m_XmlReportThread->join(); + delete m_XmlReportThread; + m_XmlReportThread = NULL; + } + if ( m_JsonReportThread != NULL ) + { + m_JsonReportThread->join(); + delete m_JsonReportThread; + m_JsonReportThread = NULL; + } + + // stop & delete all router thread + for ( int i = 0; i < NB_OF_MODULES; i++ ) + { + if ( m_RouterThreads[i] != NULL ) + { + m_RouterThreads[i]->join(); + delete m_RouterThreads[i]; + m_RouterThreads[i] = NULL; + } + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// stream opening & closing + +bool CReflector::IsStreaming(char module) +{ + return false; +} + +CPacketStream *CReflector::OpenStream(CDvHeaderPacket *DvHeader, CClient *client) +{ + CPacketStream *retStream = NULL; + + // clients MUST have bee locked by the caller + // so we can freely access it within the fuction + + // check if client is valid candidate + if ( m_Clients.IsClient(client) && !client->IsAMaster() ) + { + // get the module's queue + char module = DvHeader->GetRpt2Module(); + CPacketStream *stream = GetStream(module); + if ( stream != NULL ) + { + // lock it + stream->Lock(); + // is it available ? + if ( stream->Open(*DvHeader, client) ) + { + // stream open, mark client as master + // so that it can't be deleted + client->SetMasterOfModule(module); + + // update last heard time + client->Heard(); + retStream = stream; + + // and push header packet + stream->Push(DvHeader); + + // report + std::cout << "Opening stream on module " << module << " for client " << client->GetCallsign() + << " with sid " << DvHeader->GetStreamId() << std::endl; + + // notify + g_Reflector.OnStreamOpen(stream->GetUserCallsign()); + + } + // unlock now + stream->Unlock(); + } + } + + // done + return retStream; +} + +void CReflector::CloseStream(CPacketStream *stream) +{ + // + if ( stream != NULL ) + { + // wait queue is empty + // the following waut's forever + bool bEmpty = false; + do + { + stream->Lock(); + bEmpty = stream->empty(); + stream->Unlock(); + if ( !bEmpty ) + { + // wait a bit + CTimePoint::TaskSleepFor(10); + } + } while (!bEmpty); + + // lock it + stream->Lock(); + + // lock clients + GetClients(); + + // get and check the master + CClient *client = stream->GetOwnerClient(); + if ( client != NULL ) + { + // client no longer a master + client->NotAMaster(); + + // notify + g_Reflector.OnStreamClose(stream->GetUserCallsign()); + + std::cout << "Closing stream of module " << GetStreamModule(stream) << std::endl; + } + + // stop the queue + stream->Close(); + + + // release clients + ReleaseClients(); + + // and unlock + stream->Unlock(); + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// router threads + +void CReflector::RouterThread(CReflector *This, CPacketStream *streamIn) +{ + // get our module + uint8 uiModuleId = This->GetStreamModule(streamIn); + + // get on input queue + CPacket *packet; + + while ( !This->m_bStopThreads ) + { + // any packet in our input queue ? + streamIn->Lock(); + if ( !streamIn->empty() ) + { + // get the packet + packet = streamIn->front(); + streamIn->pop(); + } + else + { + packet = NULL; + } + streamIn->Unlock(); + + // route it + if ( packet != NULL ) + { + // set origin + packet->SetModuleId(uiModuleId); + + // iterate on all protocols + for ( int i = 0; i < This->m_Protocols.Size(); i++ ) + { + // duplicate packet + CPacket *packetClone = packet->Duplicate(); + + // get protocol + CProtocol *protocol = This->m_Protocols.GetProtocol(i); + + // if packet is header, update RPT2 according to protocol + if ( packetClone->IsDvHeader() ) + { + // get our callsign + CCallsign csRPT = protocol->GetReflectorCallsign(); + csRPT.SetModule(This->GetStreamModule(streamIn)); + ((CDvHeaderPacket *)packetClone)->SetRpt2Callsign(csRPT); + } + + // and push it + CPacketQueue *queue = protocol->GetQueue(); + queue->push(packetClone); + protocol->ReleaseQueue(); + } + // done + delete packet; + packet = NULL; + } + + // wait a bit + CTimePoint::TaskSleepFor(10); + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// report threads + +void CReflector::XmlReportThread(CReflector *This) +{ + while ( !This->m_bStopThreads ) + { + // report to xml file + std::ofstream xmlFile; + xmlFile.open("/var/log/xlxd.xml", std::ios::out | std::ios::trunc); + if ( xmlFile.is_open() ) + { + // write xml file + This->WriteXmlFile(xmlFile); + + // and close file + xmlFile.close(); + } + + // and wait a bit + CTimePoint::TaskSleepFor(XML_UPDATE_PERIOD * 1000); + } +} + +void CReflector::JsonReportThread(CReflector *This) +{ + CUdpSocket Socket; + CBuffer Buffer; + CIp Ip; + bool bOn; + + // init variable + bOn = false; + + // create listening socket + if ( Socket.Open(JSON_PORT) ) + { + // and loop + while ( !This->m_bStopThreads ) + { + // any command ? + if ( Socket.Receive(&Buffer, &Ip, 50) != -1 ) + { + // check verb + if ( Buffer.Compare((uint8 *)"hello", 5) == 0 ) + { + std::cout << "Monitor socket connected with " << Ip << std::endl; + + // connected + bOn = true; + + // announce ourselves + This->SendJsonReflectorObject(Socket, Ip); + + // dump tables + This->SendJsonNodesObject(Socket, Ip); + This->SendJsonStationsObject(Socket, Ip); + } + else if ( Buffer.Compare((uint8 *)"bye", 3) == 0 ) + { + std::cout << "Monitor socket disconnected" << std::endl; + + // diconnected + bOn = false; + } + } + + // any notifications ? + CNotification notification; + This->m_Notifications.Lock(); + if ( !This->m_Notifications.empty() ) + { + // get the packet + notification = This->m_Notifications.front(); + This->m_Notifications.pop(); + } + This->m_Notifications.Unlock(); + + // handle it + if ( bOn ) + { + switch ( notification.GetId() ) + { + case NOTIFICATION_CLIENTS: + //std::cout << "Monitor updating nodes table" << std::endl; + This->SendJsonNodesObject(Socket, Ip); + break; + case NOTIFICATION_USERS: + //std::cout << "Monitor updating stations table" << std::endl; + This->SendJsonStationsObject(Socket, Ip); + break; + case NOTIFICATION_STREAM_OPEN: + //std::cout << "Monitor notify station " << notification.GetCallsign() << "going ON air" << std::endl; + This->SendJsonStationsObject(Socket, Ip); + This->SendJsonOnairObject(Socket, Ip, notification.GetCallsign()); + break; + case NOTIFICATION_STREAM_CLOSE: + //std::cout << "Monitor notify station " << notification.GetCallsign() << "going OFF air" << std::endl; + This->SendJsonOffairObject(Socket, Ip, notification.GetCallsign()); + break; + case NOTIFICATION_NONE: + default: + // nothing to do, just sleep a bit + CTimePoint::TaskSleepFor(250); + break; + } + } + } + } + else + { + std::cout << "Error creating monitor socket" << std::endl; + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// notifications + +void CReflector::OnClientsChanged(void) +{ + CNotification notification(NOTIFICATION_CLIENTS); + + m_Notifications.Lock(); + m_Notifications.push(notification); + m_Notifications.Unlock(); +} + +void CReflector::OnUsersChanged(void) +{ + CNotification notification(NOTIFICATION_USERS); + + m_Notifications.Lock(); + m_Notifications.push(notification); + m_Notifications.Unlock(); +} + +void CReflector::OnStreamOpen(const CCallsign &callsign) +{ + CNotification notification(NOTIFICATION_STREAM_OPEN, callsign); + + m_Notifications.Lock(); + m_Notifications.push(notification); + m_Notifications.Unlock(); +} + +void CReflector::OnStreamClose(const CCallsign &callsign) +{ + CNotification notification(NOTIFICATION_STREAM_CLOSE, callsign); + + m_Notifications.Lock(); + m_Notifications.push(notification); + m_Notifications.Unlock(); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// modules & queues + +int CReflector::GetModuleIndex(char module) const +{ + int i = (int)module - (int)'A'; + if ( (i < 0) || (i >= NB_OF_MODULES) ) + { + i = -1; + } + return i; +} + +CPacketStream *CReflector::GetStream(char module) +{ + CPacketStream *stream = NULL; + int i = GetModuleIndex(module); + if ( i >= 0 ) + { + stream = &(m_Streams[i]); + } + return stream; +} + +char CReflector::GetStreamModule(CPacketStream *stream) +{ + char module = ' '; + for ( int i = 0; (i < m_Streams.size()) && (module == ' '); i++ ) + { + if ( &(m_Streams[i]) == stream ) + { + module = GetModuleLetter(i); + } + } + return module; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// xml helpers + +void CReflector::WriteXmlFile(std::ofstream &xmlFile) +{ + // write header + xmlFile << "" << std::endl; + + // software version + char sz[64]; + ::sprintf(sz, "%d.%d.%d", VERSION_MAJOR, VERSION_MINOR, VERSION_REVISION); + xmlFile << "" << sz << "" << std::endl; + + // linked nodes + xmlFile << "<" << m_Callsign << "linked nodes>" << std::endl; + // lock + CClients *clients = GetClients(); + // iterate on clients + for ( int i = 0; i < clients->GetSize(); i++ ) + { + clients->GetClient(i)->WriteXml(xmlFile); + } + // unlock + ReleaseClients(); + xmlFile << "" << std::endl; + + // last heard users + xmlFile << "<" << m_Callsign << "heard users>" << std::endl; + // lock + CUsers *users = GetUsers(); + // iterate on users + for ( int i = 0; i < users->GetSize(); i++ ) + { + users->GetUser(i)->WriteXml(xmlFile); + } + // unlock + ReleaseUsers(); + xmlFile << "" << std::endl; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// json helpers + +void CReflector::SendJsonReflectorObject(CUdpSocket &Socket, CIp &Ip) +{ + char Buffer[1024]; + char cs[CALLSIGN_LEN+1]; + char mod[8] = "\"A\""; + + // get reflector callsign + m_Callsign.GetCallsign((uint8 *)cs); + cs[CALLSIGN_LEN] = 0; + + // build string + ::sprintf(Buffer, "{\"reflector\":\"%s\",\"modules\":[", cs); + for ( int i = 0; i < NB_OF_MODULES; i++ ) + { + ::strcat(Buffer, mod); + mod[1]++; + if ( i < NB_OF_MODULES-1 ) + { + ::strcat(Buffer, ","); + } + } + ::strcat(Buffer, "]}"); + + // and send + Socket.Send(Buffer, Ip); +} + +#define JSON_NBMAX_NODES 250 + +void CReflector::SendJsonNodesObject(CUdpSocket &Socket, CIp &Ip) +{ + char Buffer[12+(JSON_NBMAX_NODES*94)]; + + // nodes object table + ::sprintf(Buffer, "{\"nodes\":["); + // lock + CClients *clients = GetClients(); + // iterate on clients + for ( int i = 0; (i < clients->GetSize()) && (i < JSON_NBMAX_NODES); i++ ) + { + clients->GetClient(i)->GetJsonObject(Buffer); + if ( i < clients->GetSize()-1 ) + { + ::strcat(Buffer, ","); + } + } + // unlock + ReleaseClients(); + ::strcat(Buffer, "]}"); + + // and send + //std::cout << Buffer << std::endl; + Socket.Send(Buffer, Ip); +} + +void CReflector::SendJsonStationsObject(CUdpSocket &Socket, CIp &Ip) +{ + char Buffer[15+(LASTHEARD_USERS_MAX_SIZE*94)]; + + // stations object table + ::sprintf(Buffer, "{\"stations\":["); + + // lock + CUsers *users = GetUsers(); + // iterate on users + for ( int i = 0; i < users->GetSize(); i++ ) + { + users->GetUser(i)->GetJsonObject(Buffer); + if ( i < users->GetSize()-1 ) + { + ::strcat(Buffer, ","); + } + } + // unlock + ReleaseUsers(); + + ::strcat(Buffer, "]}"); + + // and send + //std::cout << Buffer << std::endl; + Socket.Send(Buffer, Ip); +} + +void CReflector::SendJsonOnairObject(CUdpSocket &Socket, CIp &Ip, const CCallsign &Callsign) +{ + char Buffer[128]; + char sz[CALLSIGN_LEN+1]; + + // onair object + Callsign.GetCallsignString(sz); + ::sprintf(Buffer, "{\"onair\":\"%s\"}", sz); + + // and send + //std::cout << Buffer << std::endl; + Socket.Send(Buffer, Ip); +} + +void CReflector::SendJsonOffairObject(CUdpSocket &Socket, CIp &Ip, const CCallsign &Callsign) +{ + char Buffer[128]; + char sz[CALLSIGN_LEN+1]; + + // offair object + Callsign.GetCallsignString(sz); + ::sprintf(Buffer, "{\"offair\":\"%s\"}", sz); + + // and send + //std::cout << Buffer << std::endl; + Socket.Send(Buffer, Ip); +} diff --git a/src/creflector.h b/src/creflector.h new file mode 100644 index 0000000..2370280 --- /dev/null +++ b/src/creflector.h @@ -0,0 +1,134 @@ +// +// creflector.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef creflector_h +#define creflector_h + +#include "cusers.h" +#include "cclients.h" +#include "cprotocols.h" +#include "cpacketstream.h" +#include "cnotificationqueue.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// define + +// event defines +#define EVENT_NONE 0 +#define EVENT_CLIENTS 1 +#define EVENT_USERS 2 + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CReflector +{ +public: + // constructor + CReflector(); + CReflector(const CCallsign &); + + // destructor + virtual ~CReflector(); + + // settings + void SetCallsign(const CCallsign &callsign) { m_Callsign = callsign; } + const CCallsign &GetCallsign(void) const { return m_Callsign; } + void SetListenIp(const CIp &ip) { m_Ip = ip; } + const CIp &GetListenIp(void) const { return m_Ip; } + + // operation + bool Start(void); + void Stop(void); + + // clients + CClients *GetClients(void) { m_Clients.Lock(); return &m_Clients; } + void ReleaseClients(void) { m_Clients.Unlock(); } + + // stream opening & closing + CPacketStream *OpenStream(CDvHeaderPacket *, CClient *); + bool IsStreaming(char); + void CloseStream(CPacketStream *); + + // users + CUsers *GetUsers(void) { m_Users.Lock(); return &m_Users; } + void ReleaseUsers(void) { m_Users.Unlock(); } + + // get + bool IsValidModule(char c) const { return true; } + int GetModuleIndex(char) const; + char GetModuleLetter(int i) const { return 'A' + (char)i; } + + // notifications + void OnClientsChanged(void); + void OnUsersChanged(void); + void OnStreamOpen(const CCallsign &); + void OnStreamClose(const CCallsign &); + +protected: + // threads + static void RouterThread(CReflector *, CPacketStream *); + static void XmlReportThread(CReflector *); + static void JsonReportThread(CReflector *); + + // streams + CPacketStream *GetStream(char); + char GetStreamModule(CPacketStream *); + + // xml helpers + void WriteXmlFile(std::ofstream &); + + // json helpers + void SendJsonReflectorObject(CUdpSocket &, CIp &); + void SendJsonNodesObject(CUdpSocket &, CIp &); + void SendJsonStationsObject(CUdpSocket &, CIp &); + void SendJsonOnairObject(CUdpSocket &, CIp &, const CCallsign &); + void SendJsonOffairObject(CUdpSocket &, CIp &, const CCallsign &); + +protected: + // identity + CCallsign m_Callsign; + CIp m_Ip; + + // objects + CUsers m_Users; // sorted list of lastheard stations + CClients m_Clients; // list of linked repeaters/nodes + CProtocols m_Protocols; // list of supported protocol handlers + + // queues + std::array m_Streams; + + // threads + bool m_bStopThreads; + std::array m_RouterThreads; + std::thread *m_XmlReportThread; + std::thread *m_JsonReportThread; + + // notifications + CNotificationQueue m_Notifications; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* creflector_h */ diff --git a/src/ctimepoint.cpp b/src/ctimepoint.cpp new file mode 100644 index 0000000..41b59f0 --- /dev/null +++ b/src/ctimepoint.cpp @@ -0,0 +1,53 @@ +// +// ctimepoint.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 05/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "ctimepoint.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CTimePoint::CTimePoint() +{ + m_TimePoint = std::chrono::steady_clock::now(); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// operation + +double CTimePoint::DurationSinceNow(void) const +{ + std::chrono::steady_clock::time_point Now = std::chrono::steady_clock::now(); + std::chrono::steady_clock::duration time_span = (Now - m_TimePoint); + return double(time_span.count()) * std::chrono::steady_clock::period::num / std::chrono::steady_clock::period::den; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// task + +void CTimePoint::TaskSleepFor(uint ms) +{ + std::chrono::milliseconds timespan(ms); + std::this_thread::sleep_for(timespan); +} diff --git a/src/ctimepoint.h b/src/ctimepoint.h new file mode 100644 index 0000000..9a9e5a2 --- /dev/null +++ b/src/ctimepoint.h @@ -0,0 +1,55 @@ +// +// ctimepoint.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 05/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef ctimepoint_h +#define ctimepoint_h + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CTimePoint : public std::chrono::steady_clock::time_point +{ +public: + // constructor + CTimePoint(); + + // destructor + virtual ~CTimePoint() {} + + // operation + void Now(void) { m_TimePoint = std::chrono::steady_clock::now(); } + double DurationSinceNow(void) const; + + // task + static void TaskSleepFor(uint); + +protected: + // data + std::chrono::steady_clock::time_point m_TimePoint; +}; + + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* ctimepoint_h */ diff --git a/src/cudpsocket.cpp b/src/cudpsocket.cpp new file mode 100644 index 0000000..c6404c9 --- /dev/null +++ b/src/cudpsocket.cpp @@ -0,0 +1,153 @@ +// +// cudpsocket.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include +#include "creflector.h" +#include "cudpsocket.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CUdpSocket::CUdpSocket() +{ + m_Socket = -1; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// destructor + +CUdpSocket::~CUdpSocket() +{ + if ( m_Socket != -1 ) + { + Close(); + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// open & close + +bool CUdpSocket::Open(uint16 uiPort) +{ + bool open = false; + + // create socket + m_Socket = socket(PF_INET,SOCK_DGRAM,0); + if ( m_Socket != -1 ) + { + // initialize sockaddr struct + ::memset(&m_SocketAddr, 0, sizeof(struct sockaddr_in)); + m_SocketAddr.sin_family = AF_INET; + m_SocketAddr.sin_port = htons(uiPort); + m_SocketAddr.sin_addr.s_addr = inet_addr(g_Reflector.GetListenIp()); + + if ( bind(m_Socket, (struct sockaddr *)&m_SocketAddr, sizeof(struct sockaddr_in)) == 0 ) + { + fcntl(m_Socket, F_SETFL, O_NONBLOCK); + open = true; + } + else + { + close(m_Socket); + m_Socket = -1; + } + } + + // done + return open; +} + +void CUdpSocket::Close(void) +{ + if ( m_Socket != -1 ) + { + close(m_Socket); + m_Socket = -1; + } +} + +//////////////////////////////////////////////////////////////////////////////////////// +// read + +int CUdpSocket::Receive(CBuffer *Buffer, CIp *Ip, int timeout) +{ + struct sockaddr_in Sin; + fd_set FdSet; + unsigned int uiFromLen = sizeof(struct sockaddr_in); + int iRecvLen = -1; + struct timeval tv; + + // socket valid ? + if ( m_Socket != -1 ) + { + // control socket + FD_ZERO(&FdSet); + FD_SET(m_Socket, &FdSet); + tv.tv_sec = timeout / 1000; + tv.tv_usec = (timeout % 1000) * 1000; + select(m_Socket + 1, &FdSet, 0, 0, &tv); + + // allocate buffer + Buffer->resize(UDP_BUFFER_LENMAX); + + // read + iRecvLen = (int)recvfrom(m_Socket, + (void *)Buffer->data(), UDP_BUFFER_LENMAX, + 0, (struct sockaddr *)&Sin, &uiFromLen); + + // handle + if ( iRecvLen != -1 ) + { + // adjust buffer size + Buffer->resize(iRecvLen); + + // get IP + Ip->SetSockAddr(&Sin); + } + } + + // done + return iRecvLen; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// write + +int CUdpSocket::Send(const CBuffer &Buffer, const CIp &Ip) +{ + CIp temp(Ip); + return (int)::sendto(m_Socket, + (void *)Buffer.data(), Buffer.size(), + 0, (struct sockaddr *)temp.GetSockAddr(), sizeof(struct sockaddr_in)); +} + +int CUdpSocket::Send(const char *Buffer, const CIp &Ip) +{ + CIp temp(Ip); + return (int)::sendto(m_Socket, + (void *)Buffer, ::strlen(Buffer), + 0, (struct sockaddr *)temp.GetSockAddr(), sizeof(struct sockaddr_in)); +} diff --git a/src/cudpsocket.h b/src/cudpsocket.h new file mode 100644 index 0000000..01d6ace --- /dev/null +++ b/src/cudpsocket.h @@ -0,0 +1,76 @@ +// +// cudpsocket.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cudpsocket_h +#define cudpsocket_h + +#include +//#include +#include +#include +#include +#include +#include + +#include "cip.h" +#include "cbuffer.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// define + +#define UDP_BUFFER_LENMAX 1024 + + +//////////////////////////////////////////////////////////////////////////////////////// +// class + +class CUdpSocket +{ +public: + // constructor + CUdpSocket(); + + // destructor + ~CUdpSocket(); + + // open & close + bool Open(uint16); + void Close(void); + int GetSocket(void) { return m_Socket; } + + // read + int Receive(CBuffer *, CIp *, int); + + // write + int Send(const CBuffer &, const CIp &); + int Send(const char *, const CIp &); + +protected: + // data + int m_Socket; + struct sockaddr_in m_SocketAddr; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cudpsocket_h */ diff --git a/src/cuser.cpp b/src/cuser.cpp new file mode 100644 index 0000000..3a0ff88 --- /dev/null +++ b/src/cuser.cpp @@ -0,0 +1,103 @@ +// +// cuser.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 13/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include +#include "cuser.h" + + +//////////////////////////////////////////////////////////////////////////////////////// +// constructors + +CUser::CUser() +{ + m_LastHeardTime = std::time(NULL); +} + +CUser::CUser(const CCallsign &my, const CCallsign &rpt1) +{ + m_My = my; + m_Rpt1 = rpt1; + m_LastHeardTime = std::time(NULL); +} + +CUser::CUser(const CUser &user) +{ + m_My = user.m_My; + m_Rpt1 = user.m_Rpt1; + m_LastHeardTime = user.m_LastHeardTime; +} + +//////////////////////////////////////////////////////////////////////////////////////// +// operators + +bool CUser::operator ==(const CUser &user) const +{ + return ((user.m_My == m_My) && (user.m_Rpt1 == m_Rpt1)); +} + + +bool CUser::operator <(const CUser &user) const +{ + // smallest is youngest + return (std::difftime(m_LastHeardTime, user.m_LastHeardTime) > 0); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// reporting + +void CUser::WriteXml(std::ofstream &xmlFile) +{ + xmlFile << "" << std::endl; + xmlFile << "\t" << m_My << "" << std::endl; + xmlFile << "\t" << m_Rpt1 << "" << std::endl; + + char mbstr[100]; + if (std::strftime(mbstr, sizeof(mbstr), "%A %c", std::localtime(&m_LastHeardTime))) + { + xmlFile << "\t" << mbstr << "" << std::endl; + } + xmlFile << "" << std::endl; +} + +void CUser::GetJsonObject(char *Buffer) +{ + char sz[512]; + char mbstr[100]; + char my[16]; + char rpt1[16]; + + if (std::strftime(mbstr, sizeof(mbstr), "%A %c", std::localtime(&m_LastHeardTime))) + { + m_My.GetCallsignString(my); + m_Rpt1.GetCallsignString(rpt1); + + ::sprintf(sz, "{\"callsign\":\"%s\",\"node\":\"%s\",\"module\":\"%c\",\"time\":\"%s\"}", + my, + rpt1, + m_Rpt1.GetModule(), + mbstr); + ::strcat(Buffer, sz); + } +} diff --git a/src/cuser.h b/src/cuser.h new file mode 100644 index 0000000..04b6556 --- /dev/null +++ b/src/cuser.h @@ -0,0 +1,63 @@ +// +// cuser.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 13/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cuser_h +#define cuser_h + +#include "ccallsign.h" +#include "cbuffer.h" + +//////////////////////////////////////////////////////////////////////////////////////// + +class CUser +{ +public: + // constructor + CUser(); + CUser(const CCallsign &, const CCallsign &); + CUser(const CUser &); + + // destructor + ~CUser() {} + + // operation + void HeardNow(void) { m_LastHeardTime = std::time(NULL); } + + // operators + bool operator ==(const CUser &) const; + bool operator <(const CUser &) const; + + // reporting + void WriteXml(std::ofstream &); + void GetJsonObject(char *); + +protected: + // data + CCallsign m_My; + CCallsign m_Rpt1; + std::time_t m_LastHeardTime; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cuser_h */ diff --git a/src/cusers.cpp b/src/cusers.cpp new file mode 100644 index 0000000..164279b --- /dev/null +++ b/src/cusers.cpp @@ -0,0 +1,87 @@ +// +// cusers.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 13/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "cusers.h" +#include "creflector.h" + +//////////////////////////////////////////////////////////////////////////////////////// +// constructor + +CUsers::CUsers() +{ + m_Users.reserve(LASTHEARD_USERS_MAX_SIZE); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// users management + +void CUsers::AddUser(const CUser &user) +{ + // add + m_Users.push_back(user); + + // sort list by descending time (fisrt is youngest) + std::sort(m_Users.begin(), m_Users.end()); + + // if list size too big, remove oldest + if ( m_Users.size() >= (LASTHEARD_USERS_MAX_SIZE-1) ) + { + m_Users.resize(m_Users.size()-1); + } + + // notify + g_Reflector.OnUsersChanged(); +} + +//////////////////////////////////////////////////////////////////////////////////////// +// operation + +void CUsers::Hearing(const CCallsign &my, const CCallsign &rpt1) +{ + CUser heard(my, rpt1); + + // first check if we have this user listed yet + bool found = false; + for ( int i = 0; (i < m_Users.size()) && !found; i++ ) + { + found = (m_Users[i] == heard); + if ( found ) + { + m_Users[i].HeardNow(); + } + } + + // if not found, add user to list + // otherwise just re-sort the list + if ( !found ) + { + AddUser(heard); + } + else + { + std::sort(m_Users.begin(), m_Users.end()); + } +} + diff --git a/src/cusers.h b/src/cusers.h new file mode 100644 index 0000000..90427df --- /dev/null +++ b/src/cusers.h @@ -0,0 +1,60 @@ +// +// cusers.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 13/11/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef cusers_h +#define cusers_h + +#include "cuser.h" + +//////////////////////////////////////////////////////////////////////////////////////// + +class CUsers +{ +public: + // constructor + CUsers(); + + // destructor + virtual ~CUsers() {} + + // locks + void Lock(void) { m_Mutex.lock(); } + void Unlock(void) { m_Mutex.unlock(); } + + // management + int GetSize(void) const { return (int)m_Users.size(); } + void AddUser(const CUser &); + CUser *GetUser(int i) { return &m_Users[i]; } + + // operation + void Hearing(const CCallsign &, const CCallsign &); + +protected: + // data + std::mutex m_Mutex; + std::vector m_Users; +}; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* cusers_h */ diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..308a171 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,129 @@ +// +// main.cpp +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#include "main.h" +#include "creflector.h" + +#include "syslog.h" +#include + + +//////////////////////////////////////////////////////////////////////////////////////// +// global objects + +CReflector g_Reflector; + +//////////////////////////////////////////////////////////////////////////////////////// +// function declaration + +#include "cusers.h" + +int main(int argc, const char * argv[]) +{ +#ifdef RUN_AS_DAEMON + + // redirect cout, cerr and clog to syslog + syslog::redirect cout_redir(std::cout); + syslog::redirect cerr_redir(std::cerr); + syslog::redirect clog_redir(std::clog); + + //Fork the Parent Process + pid_t pid, sid; + pid = ::fork(); + if ( pid < 0 ) + { + exit(EXIT_FAILURE); + } + + // We got a good pid, Close the Parent Process + if (pid > 0) + { + exit(EXIT_SUCCESS); + } + + // Change File Mask + ::umask(0); + + //Create a new Signature Id for our child + sid = ::setsid(); + if (sid < 0) + { + exit(EXIT_FAILURE); + } + + // Change Directory + // If we cant find the directory we exit with failure. + if ( (::chdir("/")) < 0) + { + exit(EXIT_FAILURE); + } + + // Close Standard File Descriptors + close(STDIN_FILENO); + close(STDOUT_FILENO); + close(STDERR_FILENO); + +#endif + + // check arguments + if ( argc != 3 ) + { + std::cout << "Usage: xlxd callsign ip" << std::endl; + std::cout << "example: xlxd XLX999 192.168.178.212" << std::endl; + return 1; + } + + // initialize reflector + g_Reflector.SetCallsign(argv[1]); + g_Reflector.SetListenIp(CIp(argv[2])); + + // and let it run + if ( !g_Reflector.Start() ) + { + std::cout << "Error starting reflector" << std::endl; + exit(EXIT_FAILURE); + } + std::cout << "Reflector " << g_Reflector.GetCallsign() + << "started and listening on " << g_Reflector.GetListenIp() << std::endl; + +#ifdef RUN_AS_DAEMON + // run forever + while ( true ) + { + // sleep 60 seconds + CTimePoint::TaskSleepFor(60000); + } +#else + // wait any key + //for (;;); + std::cin.get(); +#endif + + // and wait for end + g_Reflector.Stop(); + std::cout << "Reflector stopped" << std::endl; + + // done + exit(EXIT_SUCCESS); +} diff --git a/src/main.h b/src/main.h new file mode 100644 index 0000000..cca6c75 --- /dev/null +++ b/src/main.h @@ -0,0 +1,122 @@ +// +// main.h +// xlxd +// +// Created by Jean-Luc Deltombe (LX3JL) on 31/10/2015. +// Copyright © 2015 Jean-Luc Deltombe (LX3JL). All rights reserved. +// +// ---------------------------------------------------------------------------- +// This file is part of xlxd. +// +// xlxd 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. +// +// xlxd 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 Foobar. If not, see . +// ---------------------------------------------------------------------------- + +#ifndef main_h +#define main_h + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +//////////////////////////////////////////////////////////////////////////////////////// +// defines + +// version ----------------------------------------------------- + +#define VERSION_MAJOR 1 +#define VERSION_MINOR 0 +#define VERSION_REVISION 0 + +// global ------------------------------------------------------ + +#define RUN_AS_DAEMON +#define JSON_MONITOR + +// reflector --------------------------------------------------- + +#define NB_OF_MODULES 4 + +// protocols --------------------------------------------------- + +#define NB_OF_PROTOCOLS 3 + +#define PROTOCOL_NONE 0 +#define PROTOCOL_DEXTRA 1 +#define PROTOCOL_DPLUS 2 +#define PROTOCOL_DCS 3 + +// DExtra +#define DEXTRA_PORT 30001 // UDP port +#define DEXTRA_KEEPALIVE_PERIOD 3 // in seconds +#define DEXTRA_KEEPALIVE_TIMEOUT (DEXTRA_KEEPALIVE_PERIOD*10) // in seconds + +// DPlus +#define DPLUS_PORT 20001 // UDP port +#define DPLUS_KEEPALIVE_PERIOD 1 // in seconds +#define DPLUS_KEEPALIVE_TIMEOUT (DPLUS_KEEPALIVE_PERIOD*10) // in seconds + +// DCS +#define DCS_PORT 30051 // UDP port +#define DCS_KEEPALIVE_PERIOD 1 // in seconds +#define DCS_KEEPALIVE_TIMEOUT (DCS_KEEPALIVE_PERIOD*10) // in seconds + +// xml & json reporting ----------------------------------------- + +#define LASTHEARD_USERS_MAX_SIZE 100 +#define XML_UPDATE_PERIOD 10 // in seconds +#define JSON_UPDATE_PERIOD 10 // in seconds +#define JSON_PORT 10001 + + +//////////////////////////////////////////////////////////////////////////////////////// +// typedefs + +typedef unsigned char uint8; +typedef unsigned short uint16; +typedef unsigned long uint32; +typedef unsigned int uint; + + +//////////////////////////////////////////////////////////////////////////////////////// +// macros + +#define MIN(a,b) ((a) < (b))?(a):(b) +#define MAX(a,b) ((a) > (b))?(a):(b) +#define MAKEWORD(low, high) ((uint16)(((uint8)(low)) | (((uint16)((uint8)(high))) << 8))) +#define LOBYTE(w) ((uint8)(uint16)(w & 0x00FF)) +#define HIBYTE(w) ((uint8)((((uint16)(w)) >> 8) & 0xFF)) + +//////////////////////////////////////////////////////////////////////////////////////// +// global objects + +class CReflector; +extern CReflector g_Reflector; + +class CGateKeeper; +extern CGateKeeper g_GateKeeper; + +//////////////////////////////////////////////////////////////////////////////////////// +#endif /* main_h */ diff --git a/src/makefile b/src/makefile new file mode 100644 index 0000000..53b73f5 --- /dev/null +++ b/src/makefile @@ -0,0 +1,17 @@ +CC=g++ +CFLAGS=-c -std=c++11 -pthread +LDFLAGS=-std=c++11 -pthread +SOURCES=$(wildcard *.cpp) +OBJECTS=$(SOURCES:.cpp=.o) +EXECUTABLE=xlxd + +all: $(SOURCES) $(EXECUTABLE) + +$(EXECUTABLE): $(OBJECTS) + $(CC) $(LDFLAGS) $(OBJECTS) -o $@ + +.cpp.o: + $(CC) $(CFLAGS) $< -o $@ + +clean: + rm *.o \ No newline at end of file diff --git a/src/syslog.h b/src/syslog.h new file mode 100644 index 0000000..aba8f83 --- /dev/null +++ b/src/syslog.h @@ -0,0 +1,96 @@ +/************************************************************************* + ** Copyright (C) 2014 Jan Pedersen + ** + ** 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 . + *************************************************************************/ + +#ifndef __syslog +#define __syslog + +#include +#include +#include +namespace csyslog { +#include +} + +namespace syslog +{ + struct level { + enum pri { + emerg = LOG_EMERG, // A panic condition + alert = LOG_ALERT, // A condition that should be corrected + critical= LOG_CRIT, // Critical condition, e.g, hard device error + error = LOG_ERR, // Errors + warning = LOG_WARNING, // Warning messages + notice = LOG_NOTICE, // Possibly be handled specially + info = LOG_INFO, // Informational + debug = LOG_DEBUG // For debugging program + }; + }; + + class streambuf : public std::streambuf + { + std::string _buf; + int _level; + + public: + + streambuf() : _level(level::debug) { } + void level(int level) { _level = level; } + + protected: + + int sync() + { + if (_buf.size()) { + csyslog::syslog(_level, "%s", _buf.c_str()); + _buf.erase(); + } + return 0; + } + + int_type overflow(int_type c) + { + if(c == traits_type::eof()) sync(); + else _buf += static_cast(c); + return c; + } + + }; + + class ostream : public std::ostream + { + streambuf _logbuf; + public: + ostream() : std::ostream(&_logbuf) {} + ostream& operator<<(const level::pri lev) { _logbuf.level(lev); return *this; } + }; + + class redirect + { + ostream dst; + std::ostream &src; + std::streambuf * const sbuf; + + public: + redirect(std::ostream & src) : src(src), sbuf(src.rdbuf(dst.rdbuf())) { dst << (&src == &std::cout ? level::info : level::error); } + ~redirect() { src.rdbuf(sbuf); } + }; +} + +#endif + + +