Initial commit 0.000_3
authorMarius Gavrilescu <marius@ieval.ro>
Sat, 30 Aug 2014 21:06:09 +0000 (00:06 +0300)
committerMarius Gavrilescu <marius@ieval.ro>
Sat, 30 Aug 2014 21:06:09 +0000 (00:06 +0300)
16 files changed:
COPYING [new file with mode: 0644]
Changes [new file with mode: 0644]
MANIFEST [new file with mode: 0644]
Makefile.PL [new file with mode: 0644]
README [new file with mode: 0644]
config.pl [new file with mode: 0644]
fonbotd [new file with mode: 0644]
lib/App/FonBot/Daemon.pm [new file with mode: 0644]
lib/App/FonBot/Plugin/BitlBee.pm [new file with mode: 0644]
lib/App/FonBot/Plugin/Common.pm [new file with mode: 0644]
lib/App/FonBot/Plugin/Config.pm [new file with mode: 0644]
lib/App/FonBot/Plugin/HTTPD.pm [new file with mode: 0644]
lib/App/FonBot/Plugin/IRC.pm [new file with mode: 0644]
lib/App/FonBot/Plugin/OFTC.pm [new file with mode: 0644]
log4perl.conf [new file with mode: 0644]
t/App-FonBot-Daemon.t [new file with mode: 0644]

diff --git a/COPYING b/COPYING
new file mode 100644 (file)
index 0000000..dba13ed
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<http://www.gnu.org/licenses/>.
diff --git a/Changes b/Changes
new file mode 100644 (file)
index 0000000..e938576
--- /dev/null
+++ b/Changes
@@ -0,0 +1,4 @@
+Revision history for Perl extension App::FonBot::Daemon.
+
+[ This will be filled in when the first non-dev build is released ]
+
diff --git a/MANIFEST b/MANIFEST
new file mode 100644 (file)
index 0000000..de2e9c6
--- /dev/null
+++ b/MANIFEST
@@ -0,0 +1,16 @@
+Changes
+COPYING
+Makefile.PL
+MANIFEST
+README
+config.pl Example fonbotd configuration file
+fonbotd
+log4perl.conf Example log4perl configuration file
+t/App-FonBot-Daemon.t
+lib/App/FonBot/Daemon.pm
+lib/App/FonBot/Plugin/IRC.pm
+lib/App/FonBot/Plugin/Config.pm
+lib/App/FonBot/Plugin/HTTPD.pm
+lib/App/FonBot/Plugin/Common.pm
+lib/App/FonBot/Plugin/BitlBee.pm
+lib/App/FonBot/Plugin/OFTC.pm
diff --git a/Makefile.PL b/Makefile.PL
new file mode 100644 (file)
index 0000000..5871080
--- /dev/null
@@ -0,0 +1,31 @@
+use ExtUtils::MakeMaker;
+
+WriteMakefile(
+    NAME              => 'App::FonBot::Daemon',
+    VERSION_FROM      => 'lib/App/FonBot/Daemon.pm',
+       MIN_PERL_VERSION  => "5.14.0",
+       ABSTRACT_FROM     => 'lib/App/FonBot/Daemon.pm',
+       AUTHOR            => 'Marius Gavrilescu <marius@ieval.ro>',
+       EXE_FILES         => ['fonbotd'],
+       LICENSE           => 'AGPL_3',
+    PREREQ_PM         => {
+         Apache2::Authen::Passphrase => 0,
+         HTTP::Status    => 0,
+         IRC::Utils      => 0,
+         JSON            => 0,
+         Log::Log4perl   => 0,
+         POE             => 0,
+         POE::Component::IRC => 0,
+         POE::Component::IRC::Plugin::AutoJoin => 0,
+         POE::Component::IRC::Plugin::Connector => 0,
+         POE::Component::IRC::Plugin::NickServID => 0,
+         POE::Component::Server::HTTP => 0,
+         POE::Component::SSLify => 0,
+
+         # Built-in
+         DB_File          => 0,
+         MIME::Base64     => 0,
+         Storable         => 0,
+         Text::ParseWords => 0,
+       },
+);
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..a40aba4
--- /dev/null
+++ b/README
@@ -0,0 +1,57 @@
+App-FonBot-Daemon version 0.001
+===============================
+
+FonBot is an Android application that lets users control their phones through the internet or through text messages.
+
+Users can communicate with the applications through Yahoo! Messenger, Jabber and IRC (on the OFTC network). Email support is planned.
+
+This is the FonBot server, a daemon which relays messages between users and their phones.
+
+INSTALLATION
+
+To install this module type the following:
+
+   perl Makefile.PL
+   make
+   make test
+   make install
+
+SETUP
+
+Steps to setting up your own fonbotd installation:
+
+1. Install fonbotd
+2. (if you want YMSG or Jabber) Install BitlBee
+3. (if you want YMSG or Jabber) Create a BitlBee account and add some IM accounts.
+4. Create the /etc/fonbotd directory and copy the example config.pl and log4perl.conf files to that directory
+5. Edit the example configuration files to your liking
+6. Run fonbotd
+
+DEPENDENCIES
+
+This module requires these other modules and libraries:
+
+- Apache2::Authen::Passphrase
+- IRC::Utils
+- JSON
+- Log::Log4perl
+- POE
+- POE::Component::IRC
+- POE::Component::Server::HTTP
+
+COPYRIGHT AND LICENCE
+
+Copyright (C) 2013 by Marius Gavrilescu
+
+fonbotd is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+fonbotd is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with fonbotd.  If not, see <http://www.gnu.org/licenses/>
diff --git a/config.pl b/config.pl
new file mode 100644 (file)
index 0000000..c384d44
--- /dev/null
+++ b/config.pl
@@ -0,0 +1,59 @@
+# OFTC
+# ====
+
+# Comment this out to disable the OFTC plugin
+$oftc_enabled = 1;
+
+# Nickname to use on OFTC
+$oftc_nick = 'fonbot';
+
+# Channels to join on OFTC
+@oftc_channels = ();
+
+# Password to identify to NickServ with
+$oftc_nickserv_password = 'asd';
+
+# BitlBee
+# =======
+
+# Comment this out to disable the BitlBee plugin
+$bitlbee_enabled = 1;
+
+# Nickname to use on BitlBee
+$bitlbee_nick = 'marius';
+
+# BitlBee server hostname
+$bitlbee_server = 'localhost';
+
+# BitlBee server port
+$bitlbee_port = 6667;
+
+# BitlBee server password
+$bitlbee_password = 'parola';
+
+# Common
+# ======
+
+# Directory to store state in
+$dir = '/home/marius/fonbotsrv';
+
+# Run fonbotd as this user
+$user = 'marius';
+
+# Run fonbotd as this primary group
+$group = 'marius';
+
+# Run fonbotd as these supplementary groups
+@supplementary_groups = ();
+
+# HTTPD
+# =====
+
+# Run the HTTPD on this port
+$httpd_port = 8888;
+
+# Read the authentication data from this directory
+$Apache2::Authen::Passphrase::rootdir = "$rootdir/us";
+
+# End the configuration file
+return 1;
diff --git a/fonbotd b/fonbotd
new file mode 100644 (file)
index 0000000..ece6b53
--- /dev/null
+++ b/fonbotd
@@ -0,0 +1,52 @@
+#!/usr/bin/perl -wT
+use v5.14;
+use strict;
+
+use App::FonBot::Daemon;
+
+App::FonBot::Daemon::run;
+END { App::FonBot::Daemon::finish };
+
+__END__
+
+=head1 NAME
+
+fonbotd - FonBot daemon
+
+=head1 SYNOPSIS
+
+    fonbotd
+
+=head1 DESCRIPTION
+
+FonBot is an Android application that lets users control their phones through the internet or through text messages.
+
+Users can communicate with the applications through Yahoo! Messenger, Jabber and IRC (on the OFTC network). Email support is planned.
+
+This is the FonBot server, a daemon which relays messages between users and their phones.
+
+=head1 AUTHOR
+
+Marius Gavrilescu C<< marius@ieval.ro >>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2013 Marius Gavrilescu
+
+This file is part of fonbotd.
+
+fonbotd is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+fonbotd is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with fonbotd.  If not, see <http://www.gnu.org/licenses/>
+
+
+=cut
diff --git a/lib/App/FonBot/Daemon.pm b/lib/App/FonBot/Daemon.pm
new file mode 100644 (file)
index 0000000..9ef7b15
--- /dev/null
@@ -0,0 +1,91 @@
+package App::FonBot::Daemon;
+
+our $VERSION = '0.000_3';
+
+use 5.014000;
+use strict;
+use warnings;
+
+use Log::Log4perl qw//;
+use POE;
+
+use App::FonBot::Plugin::Config;
+use App::FonBot::Plugin::Common;
+use App::FonBot::Plugin::OFTC;
+use App::FonBot::Plugin::BitlBee;
+use App::FonBot::Plugin::HTTPD;
+
+use sigtrap qw/die normal-signals/;
+
+use constant PLUGINS => map { "App::FonBot::Plugin::$_" } qw/Config Common OFTC BitlBee HTTPD/;
+
+##################################################
+
+sub run{
+  Log::Log4perl->init('/etc/fonbotd/log4perl.conf');
+  chdir '/var/lib/fonbot';
+  $_->init for PLUGINS;
+  POE::Kernel->run
+}
+
+sub finish{
+  $_->fini for reverse PLUGINS
+}
+
+1;
+
+__END__
+
+=head1 NAME
+
+App::FonBot::Daemon - FonBot daemon
+
+=head1 SYNOPSIS
+
+    use App::FonBot::Daemon;
+    App::FonBot::Daemon::run;
+    END { App::FonBot::Daemon::finish }
+
+=head1 DESCRIPTION
+
+This module is the entry point of the FonBot Daemon
+
+=head1 FUNCTIONS
+
+=over
+
+=item B<run>
+
+Runs the FonBot daemon
+
+=item B<finish>
+
+Runs the plugin finalizers
+
+=back
+
+=head1 AUTHOR
+
+Marius Gavrilescu C<< <marius@ieval.ro> >>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2013 Marius Gavrilescu
+
+This file is part of fonbotd.
+
+fonbotd is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+fonbotd is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with fonbotd.  If not, see <http://www.gnu.org/licenses/>
+
+
+=cut
diff --git a/lib/App/FonBot/Plugin/BitlBee.pm b/lib/App/FonBot/Plugin/BitlBee.pm
new file mode 100644 (file)
index 0000000..3192662
--- /dev/null
@@ -0,0 +1,115 @@
+package App::FonBot::Plugin::BitlBee;
+
+our $VERSION = '0.000_3';
+
+use v5.14;
+use strict;
+use warnings;
+
+use parent qw/App::FonBot::Plugin::IRC/;
+
+use POE;
+use POE::Component::IRC::Plugin::Connector;
+
+use App::FonBot::Plugin::Config qw/$bitlbee_enabled $bitlbee_nick $bitlbee_server $bitlbee_port $bitlbee_password/;
+
+##################################################
+
+sub _start{
+  return unless $bitlbee_enabled;
+  my $self=$_[OBJECT];
+
+  $self->{irc} = POE::Component::IRC->spawn(
+       Flood => 1,
+       Nick => $bitlbee_nick,
+       Username => $bitlbee_nick,
+       Ircname => 'FonBot',
+       Server => $bitlbee_server,
+       Port => $bitlbee_port,
+  );
+  $self->{irc}->yield(register => qw/msg public/);
+  $self->{irc}->yield(connect => {});
+  $self->{irc}->plugin_add(Connector => POE::Component::IRC::Plugin::Connector->new);
+
+  $_[KERNEL]->alias_set('BITLBEE')
+}
+
+sub irc_public{
+  my ($self, $msg)=@_[OBJECT, ARG2];
+  $self->{irc}->yield(privmsg => '&bitlbee', "identify $bitlbee_password") if $msg =~ /^Welcome to the BitlBee gateway!$/;
+  $self->{irc}->yield(privmsg => '&bitlbee', 'yes') if $msg =~ /New request:/;
+}
+
+1;
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+App::FonBot::Plugin::BitlBee - FonBot plugin that provides the BitlBee user interface
+
+=head1 SYNOPSIS
+
+    use App::FonBot::Plugin::BitlBee;
+    App::FonBot::Plugin::BitlBee->init;
+
+    END { App::FonBot::Plugin::BitlBee->fini }
+
+=head1 DESCRIPTION
+
+This is one of the two implementations of C<App::FonBot::Plugin::IRC>. It identifies with a bitlbee server, accepts all buddy requests and processes received commands.
+
+=head1 CONFIGURATION VARIABLES
+
+These are the L<App::FonBot::Plugin::Config> configuration variables used in this module
+
+=over
+
+=item C<$bitlbee_enabled>
+
+If false, the BitlBee plugin is disabled.
+
+=item C<$bitlbee_nick>
+
+BitlBee nickname
+
+=item C<$bilbee_server>
+
+BitlBee server hostname
+
+=item C<$bitlbee_port>
+
+BitlBee server port
+
+=item C<$bitlbee_password>
+
+BitlBee identify password
+
+=back
+
+=head1 AUTHOR
+
+Marius Gavrilescu C<< <marius@ieval.ro> >>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2013 Marius Gavrilescu
+
+This file is part of fonbotd.
+
+fonbotd is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+fonbotd is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with fonbotd.  If not, see <http://www.gnu.org/licenses/>
+
+
+=cut
diff --git a/lib/App/FonBot/Plugin/Common.pm b/lib/App/FonBot/Plugin/Common.pm
new file mode 100644 (file)
index 0000000..b4fce7c
--- /dev/null
@@ -0,0 +1,175 @@
+package App::FonBot::Plugin::Common;
+
+our $VERSION = '0.000_3';
+
+use v5.14;
+use strict;
+use warnings;
+
+use parent qw/Exporter/;
+
+use JSON qw/encode_json/;
+use Log::Log4perl qw//;
+
+use DB_File qw//;
+use Storable qw/freeze thaw/;
+
+use App::FonBot::Plugin::Config qw/$dir $user $group @supplementary_groups/;
+
+##################################################
+
+our (%ok_user_addresses, %commands, %waiting_requests);
+our @EXPORT = qw/%ok_user_addresses %commands %waiting_requests sendmsg/;
+
+my $log=Log::Log4perl->get_logger(__PACKAGE__);
+
+sub init{
+  $log->info('setting user and group');
+  $)=join ' ', scalar getgrnam $group, map {scalar getgrnam $_} @supplementary_groups;
+  $(=scalar getgrnam $group;
+  $<=$>=scalar getpwnam $user;
+  chdir $dir;
+
+  $log->info('initializing '.__PACKAGE__);
+  tie %ok_user_addresses, DB_File => 'ok_user_addresses.db';
+  tie %commands, DB_File => 'commands.db';
+}
+
+sub fini{
+  $log->info('finishing '.__PACKAGE__);
+  untie %ok_user_addresses;
+  untie %commands;
+}
+
+##################################################
+
+sub sendmsg{
+  my ($touser,$requestid,$replyto,$command,@args)=@_;
+
+  my $data={command=>$command, replyto=>$replyto, args => \@args };
+  $data->{requestid} = $requestid if defined $requestid;
+
+  if (exists $commands{$touser}) {
+       my $temp = thaw $commands{$touser};
+       push $temp, $data;
+       $commands{$touser} = freeze $temp
+  } else {
+       $commands{$touser} = freeze [$data]
+  }
+
+  if (exists $waiting_requests{$touser}) {
+       $waiting_requests{$touser}->continue;
+       delete $waiting_requests{$touser}
+  }
+}
+
+1;
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+App::FonBot::Plugin::Common - FonBot plugin that provides global variables and functions
+
+=head1 SYNOPSIS
+
+       use App::FonBot::Plugin::Common;
+       App::FonBot::Plugin::Common->init;
+
+       $ok_user_addresses{'marius OFTC mgvx'}=1; # Let user marius send messages to mgvx via the OFTC plugin
+       sendmsg 'marius', 'OFTC mgvx', 'echo', 'Hello', 'world!';
+
+       App::FonBot::Plugin::Common->fini;
+
+=head1 DESCRIPTION
+
+This FonBot plugin provides global variables and functions to the other plugins. It also sets the user and group according to the configuration file. It is a required plugin, since most other plugins depend on it.
+
+=head1 CONFIGURATION VARIABLES
+
+These are the L<App::FonBot::Plugin::Config> configuration variables used in this module
+
+=over
+
+=item C<$dir>
+
+Directory to chdir to.
+
+=item C<$user>
+
+User to change to.
+
+=item C<$group>
+
+Group to change to.
+
+=item C<@supplementary_groups>
+
+Supplementary groups list to set.
+
+=back
+
+=head1 EXPORTED SYMBOLS
+
+=over
+
+=item B<%ok_user_addresses>
+
+Hash that records combinations of username, driver and address that have sent commands to us. The key format is C<"$username $drivername $address">. B<fonbotd> will never send a message to an address which is not found in this hash.
+
+Example entry: C<$ok_user_address{"nobody EMAIL nobody@mailinator.com"}>.
+
+=item B<%commands>
+
+Hash from usernames to a C<Storable::freeze>d array of pending commands for the user.
+
+=item B<%waiting_requests>
+
+Hash from usernames to a waiting HTTP::Response, as defined by the POE::Component::Server::HTTP documentation.
+
+=item B<sendmsg>(I<$touser>, I<$requestid>, I<$replyto>, I<$command>, I<@args>)
+
+Sends a command to C<$touser>'s phone. The command includes a command name (C<$command>), a list of arguments (C<@args>) and a reply address (C<$replyto>). If I<$requestid> is defined, the command will also include that request ID.
+
+=back
+
+=head1 METHODS
+
+=over
+
+=item C<App::FonBot::Plugin::Common-E<gt>init>
+
+Sets the user and group according to the configuration variables and reads the exported variables from the disk.
+
+=item C<App::FonBot::Plugin::Common-E<gt>fini>
+
+Writes the exported variables to the disk.
+
+=back
+
+=head1 AUTHOR
+
+Marius Gavrilescu C<< <marius@ieval.ro> >>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2013 Marius Gavrilescu
+
+This file is part of fonbotd.
+
+fonbotd is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+fonbotd is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with fonbotd.  If not, see <http://www.gnu.org/licenses/>
+
+
+=cut
diff --git a/lib/App/FonBot/Plugin/Config.pm b/lib/App/FonBot/Plugin/Config.pm
new file mode 100644 (file)
index 0000000..b710cf8
--- /dev/null
@@ -0,0 +1,118 @@
+package App::FonBot::Plugin::Config;
+
+our $VERSION = '0.000_3';
+
+use v5.14;
+use strict;
+use warnings;
+
+use parent qw/Exporter/;
+
+use Apache2::Authen::Passphrase;
+use Log::Log4perl qw//;
+
+our @EXPORT_OK=qw/$oftc_enabled $oftc_nick @oftc_channels $oftc_nickserv_password $bitlbee_enabled $bitlbee_nick $bitlbee_server $bitlbee_port $bitlbee_password $dir $user $group @supplementary_groups $httpd_port/;
+
+##################################################
+
+our ($oftc_enabled, $oftc_nick, @oftc_channels, $oftc_nickserv_password);
+our ($bitlbee_enabled, $bitlbee_nick, $bitlbee_server, $bitlbee_port, $bitlbee_password);
+our ($dir, $user, $group, @supplementary_groups);
+
+##################################################
+
+my $log=Log::Log4perl->get_logger(__PACKAGE__);
+
+sub init{
+  $log->info('reading config file');
+  unless (my $ret = do '/etc/fonbotd/config.pl') {
+       die "Cannot parse config file: $@" if $@;
+       die "Cannot run config file: $!" unless $ret;
+  }
+}
+
+sub fini{
+  #no-op
+}
+
+1;
+
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+App::FonBot::Plugin::Config - FonBot plugin for reading configuration files
+
+=head1 SYNOPSIS
+
+       use App::FonBot::Plugin::Config qw/$oftc_enabled $oftc_nick @oftc_channels $oftc_nickserv_password $bitlbee_enabled $bitlbee_nick $bitlbee_server $bitlbee_port $bitlbee_password $user $group @supplementary_groups $httpd_port/;
+       App::FonBot::Plugin::Config->init;
+
+       # Variables used in App::FonBot:Plugin::OFTC
+    say "The OFTC plugin is ".($oftc_enabled ? 'enabled' : 'disabled');
+       say "The OFTC NickServ password is $oftc_nickserv_password";
+       say "The OFTC nickname is $oftc_nick";
+       say "The OFTC channels are @oftc_channels";
+
+       # Variables used in App::FonBot::Plugin::BitlBee
+    say "The BitlBee plugin is ".($bitlbee_enabled ? 'enabled' : 'disabled');
+    say "The BitlBee server runs on port $bitlbee_port of host $bitlbee_server"
+       say "The BitlBee nickname is $bitlbee_nick";
+       say "The BitlBee password is $bitlbee_password";
+
+       # Variables used in App::FonBot::Plugin::Common
+    say "The storage directory is $dir";
+       say "The user is $user";
+       say "The primary group is $group";
+       say "The supplementary groups are @supplementary_groups";
+
+    # Variables used in App::FonBot::Plugin::HTTPD
+    say "The HTTPD listens on port $httpd_port"
+
+=head1 DESCRIPTION
+
+This FonBot plugin reads a configuration file (hardcoded to F</etc/fonbot/config.pl>) and provides configuration variables to the other plugins. It is a required plugin, since all other plugins depend on it.
+
+The configuration variables are described in detail in the plugins that use it.
+
+=head1 METHODS
+
+=over
+
+=item C<App::FonBot::Plugin::Config-E<gt>init>
+
+(Re-)reads the configuration file, populating the configuration variables. The configuration file is a regular perl script, hardcoded to F</etc/fonbot/config.pl>.
+
+=item C<App::FonBot::Plugin::Config-E<gt>fini>
+
+Currently a no-op. It is recommended to call this after finishing using this module, since it might do something in a future release.
+
+=back
+
+=head1 AUTHOR
+
+Marius Gavrilescu C<< <marius@ieval.ro> >>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2013 Marius Gavrilescu
+
+This file is part of fonbotd.
+
+fonbotd is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+fonbotd is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with fonbotd.  If not, see <http://www.gnu.org/licenses/>
+
+
+=cut
diff --git a/lib/App/FonBot/Plugin/HTTPD.pm b/lib/App/FonBot/Plugin/HTTPD.pm
new file mode 100644 (file)
index 0000000..e45977d
--- /dev/null
@@ -0,0 +1,326 @@
+package App::FonBot::Plugin::HTTPD;
+
+our $VERSION = '0.000_3';
+
+use v5.14;
+use strict;
+use warnings;
+
+use Apache2::Authen::Passphrase qw/pwcheck/;
+use HTTP::Status qw/HTTP_BAD_REQUEST HTTP_OK HTTP_NO_CONTENT HTTP_FORBIDDEN HTTP_UNAUTHORIZED/;
+use JSON qw/encode_json/;
+use Log::Log4perl;
+use POE::Component::Server::HTTP qw/RC_OK RC_DENY RC_WAIT/;
+
+use DB_File;
+use MIME::Base64 qw/decode_base64/;
+use Storable qw/freeze thaw/;
+use Text::ParseWords qw/shellwords/;
+
+use App::FonBot::Plugin::Config qw/$httpd_port/;
+use App::FonBot::Plugin::Common;
+
+##################################################
+
+my $log=Log::Log4perl->get_logger(__PACKAGE__);
+
+my $httpd;
+my %waiting_userrequests;
+my %responses;
+
+sub init{
+  $log->info('initializing '.__PACKAGE__);
+  %waiting_requests = ();
+  %waiting_userrequests = ();
+  $httpd = POE::Component::Server::HTTP->new(
+         Port => 8888,
+         PreHandler => { '/' => [\&pre_auth, \&pre_get, \&pre_userget], },
+         ContentHandler =>{ '/send' => \&on_send, '/get' => \&on_get, '/ok' => \&on_ok, '/userget' => \&on_userget, '/usersend' => \&on_usersend },
+         ErrorHandler => { '/' => sub { RC_OK }},
+         Headers => { 'Cache-Control' => 'no-cache' },
+       );
+}
+
+sub fini{
+  $log->info('finishing '.__PACKAGE__);
+  POE::Kernel->call($httpd, 'shutdown');
+}
+
+##################################################
+
+sub httpdie (\$$;$){
+  my ($response,$errstr,$errcode)=@_;
+
+  $$response->code($errcode // HTTP_BAD_REQUEST);
+  $$response->header(Content_Type => 'text/plain');
+  $$response->message($errstr);
+
+  die 'Bad Request';
+}
+
+sub pre_auth{
+  my ($request, $response)=@_;
+
+  eval {
+       my $authorization=$request->header('Authorization') // die 'No Authorization header';
+       $authorization =~ /^Basic (.+)$/ or die 'Invalid Authorization header';
+       my ($user, $password) = decode_base64($1) =~ /^(.+):(.*)$/ or die 'Invalid Authorization header';
+       eval { pwcheck $user, $password; 1 } or die 'Invalid user/password combination';
+       $request->header(Username => $user);
+       $log->debug("HTTP request from $user to url ".$request->url);
+  };
+  if (my $error = $@) {
+       $response->code(HTTP_UNAUTHORIZED);
+       $response->message('Bad username or password');
+       $response->header(Content_Type => 'text/plain');
+       $response->header(WWW_Authenticate => 'Basic realm="fonbotd"');
+       $response->content('Unauthorized');
+       $log->debug("Request denied: $error");
+       return RC_DENY
+  }
+
+  $response->content('');
+  RC_OK
+}
+
+sub pre_get{
+  my ($request, $response)=@_;
+  my $user=$request->header('Username');
+  return RC_OK if $response->code;
+  return RC_OK unless $user;
+  return RC_OK unless $request->uri =~ m,/get,;
+
+  unless (exists $commands{$user}) {
+       $log->debug("No pending commands for $user, entering RC_WAIT");
+       $waiting_requests{$user}->continue if exists $waiting_requests{$user};
+       $waiting_requests{$user}=$response;
+       return RC_WAIT
+  }
+
+  RC_OK
+}
+
+sub pre_userget{
+  my ($request, $response)=@_;
+  my $user=$request->header('Username');
+  return RC_OK if $response->code;
+  return RC_OK unless $user;
+  return RC_OK unless $request->uri =~ m,/userget,;
+
+  unless (exists $responses{$user}) {
+       $log->debug("No pending responses for $user, entering RC_WAIT");
+       $waiting_userrequests{$user}->continue if exists $waiting_userrequests{$user};
+       $waiting_userrequests{$user}=$response;
+       return RC_WAIT
+  }
+
+  RC_OK
+}
+
+sub on_ok{
+  my ($request, $response)=@_;
+  return RC_OK if $response->code;
+
+  $response->code(HTTP_OK);
+  RC_OK
+}
+
+sub on_get{
+  my ($request, $response)=@_;
+  return RC_OK if $response->code;
+
+  eval {
+       my $user=$request->header('Username');
+       $log->debug("on_get from user $user");
+
+       if (exists $commands{$user}) {
+         my $json=encode_json thaw $commands{$user};
+         $log->debug("Sending JSON: $json to $user");
+         $response->content($json);
+         $response->code(HTTP_OK);
+         $response->message('Commands sent');
+       } else {
+         $log->debug("Sending back 204 No Content");
+         $response->code(HTTP_NO_CONTENT);
+         $response->message('No pending commands');
+       }
+
+       delete $commands{$user}
+  };
+
+  $log->error("ERROR: $@") if $@ && $@ !~ /^Bad Request /;
+
+  RC_OK
+}
+
+sub on_userget{
+  my ($request, $response)=@_;
+  return RC_OK if $response->code;
+
+  eval {
+       my $user=$request->header('Username');
+       $log->debug("on_userget from user $user");
+
+       if (exists $responses{$user}) {
+         my $json=encode_json $responses{$user};
+         $log->debug("Sending JSON: $json to $user");
+         $response->content($json);
+         $response->code(HTTP_OK);
+         $response->message('Responses sent');
+       } else {
+         $log->debug("Sending back 204 No Content");
+         $response->code(HTTP_NO_CONTENT);
+         $response->message('No pending responses');
+       }
+
+       delete $responses{$user}
+  };
+
+  $log->error("ERROR: $@") if $@ && $@ !~ /^Bad Request /;
+
+  RC_OK
+}
+
+sub on_send{
+  my ($request, $response)=@_;
+  return RC_OK if $response->code;
+
+  eval {
+       httpdie $response, 'All requests must use the POST http method' unless $request->method eq 'POST';
+       my $user=$request->header('Username');
+
+       my $destination=$request->header('X-Destination') // httpdie $response, 'Missing destination address';
+       my ($driver, $address)=shellwords $destination;
+
+       my $content=$request->content // httpdie $response, 'Content is undef';
+
+       if ($driver eq 'HTTP') {
+         $responses{$user}//=[];
+         push $responses{$user}, $content;
+         if (exists $waiting_userrequests{$user}) {
+               $waiting_userrequests{$user}->continue;
+               delete $waiting_userrequests{$user}
+         }
+       } else {
+         unless ($ok_user_addresses{"$user $driver $address"}) {
+               $response->code(HTTP_FORBIDDEN);
+               $response->message("$user is not allowed to send messages to $address");
+               return
+         }
+
+         POE::Kernel->post($driver, 'send_message', $address, $content) or $log->error("Driver not found: $driver");
+       }
+
+       $response->code(HTTP_NO_CONTENT);
+       $response->message('Message sent');
+  };
+
+  $log->error("ERROR: $@") if $@ && $@ !~ /^Bad Request /;
+  $log->debug('Responding to send from $user with '.$response->code.' '.$response->message);
+  RC_OK
+}
+
+sub on_usersend{
+  my ($request, $response)=@_;
+  $log->debug("asdasd asd");
+  return RC_OK if $response->code;
+
+  eval{
+       httpdie $response, 'All requests must use the POST http method' unless $request->method eq 'POST';
+       my $user=$request->header('Username');
+
+       my $content=$request->content // httpdie $response, 'Content is undef';
+
+       sendmsg $user, $request->header('X-Requestid'), HTTP => shellwords $_ for split '\n', $content;
+
+       $response->code(HTTP_NO_CONTENT);
+       $response->message('Command sent');
+  };
+
+  $log->error("ERROR: $@") if $@ && $@ !~ /^Bad Request /;
+  $log->debug('Responding to usersend from $user with '.$response->code.' '.$response->message);
+  RC_OK
+}
+
+1
+
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+App::FonBot::Plugin::HTTPD - FonBot webserver plugin, used for communication with phones
+
+=head1 SYNOPSIS
+
+       use App::FonBot::Plugin::HTTPD;
+       App::FonBot::Plugin::HTTPD->init;
+       ...
+       App::FonBot::Plugin::HTTPD->fini;
+
+=head1 DESCRIPTION
+
+This FonBot plugin provides a webserver for interacting with fonbotd. All requests use Basic access authentication.
+
+The available calls are:
+
+=over
+
+=item GET C</get>
+
+Returns a JSON array of pending commands for the current user. Uses long polling — the server does not respond immediately if there are no pending commands.
+
+=item GET C</ok>
+
+Returns a 200 OK.
+
+=item POST C</send>
+
+Sends a message to an address. The address is given in the C<X-Destination> header. The message is in the POST data.
+
+=item GET C</userget>
+
+Returns a JSON array of pending messages for the current user. Uses long polling — the server does not respond immediately if there are no pending commands.
+
+=item POST C</usersend>
+
+Sends a command to the sender's phone. The optional C<X-Requestid> header sets the request ID. The command is in the POST data
+
+=back
+
+=head1 CONFIGURATION VARIABLES
+
+=over
+
+=item C<$httpd_port>
+
+The HTTPD listens on this port.
+
+=back
+
+=head1 AUTHOR
+
+Marius Gavrilescu C<< marius@ieval.ro >>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2013 Marius Gavrilescu
+
+This file is part of fonbotd.
+
+fonbotd is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+fonbotd is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with fonbotd.  If not, see <http://www.gnu.org/licenses/>
+
+
+=cut
diff --git a/lib/App/FonBot/Plugin/IRC.pm b/lib/App/FonBot/Plugin/IRC.pm
new file mode 100644 (file)
index 0000000..e4eaf01
--- /dev/null
@@ -0,0 +1,151 @@
+package App::FonBot::Plugin::IRC;
+
+our $VERSION = '0.000_3';
+
+use v5.14;
+use strict;
+use warnings;
+
+use Apache2::Authen::Passphrase qw/pwcheck/;
+use IRC::Utils qw/parse_user/;
+use Log::Log4perl qw//;
+use POE;
+use POE::Component::IRC qw//;
+
+use Text::ParseWords qw/shellwords/;
+use subs qw/shutdown/;
+
+use App::FonBot::Plugin::Common;
+
+##################################################
+
+my %selves;
+
+sub init{
+  my ($ns)=@_;
+
+  my $self=$ns->new;
+  $self->{log}->info("initializing $ns");
+  tie my %nick_to_username, DB_File => "nick_to_username-$ns.db";
+  $self->{nick_to_username}=\%nick_to_username;
+  $selves{$ns}=$self
+}
+
+sub fini{
+  my ($ns)=@_;
+
+  $selves{$ns}->{log}->info("finishing $ns");
+  $selves{$ns}->{irc}->yield(shutdown => "finishing $ns") if defined $selves{$ns}->{irc};
+  untie $selves{$ns}->{nick_to_username};
+  POE::Kernel->post($selves{$ns}->{session} => 'shutdown');
+  delete $selves{$ns}
+}
+
+##################################################
+
+sub new{
+  my ($ns)=@_;
+
+  my $self = {
+       prefix => {},
+       log => Log::Log4perl->get_logger($ns),
+  };
+
+  bless $self, $ns;
+
+  $self->{session} = POE::Session->create(
+       object_states => [ $self => [ '_start', 'send_message', 'irc_001', 'irc_msg', 'irc_public', 'shutdown' ] ],
+  );
+
+  $self
+}
+
+sub irc_msg{
+  my ($from, $msg, $self)=@_[ARG0,ARG2,OBJECT];
+  my $nick=parse_user $from;
+
+  my $username=$self->{nick_to_username}{$from};
+  my $address=$_[KERNEL]->alias_list;
+  $address.=" $nick";
+
+  chomp $msg;
+  my @args=shellwords $msg;
+  my $cmd=shift @args;
+
+  given($cmd){
+       when(/^myid$/i){
+         $self->{irc}->yield(privmsg => $nick, $from);
+       }
+
+    when(/^login$/i) {
+         my ($user, $pass) = @args;
+
+         eval { pwcheck $user, $pass };
+
+         if ($@) {
+               $self->{log}->debug("Login for $user failed");
+               $self->{irc}->yield(privmsg => $nick, 'Bad username/password combination');
+         } else {
+               $self->{log}->debug("Login for $user succeded");
+               $self->{nick_to_username}{$from} = $user;
+               $self->{irc}->yield(privmsg => $nick, "Logged in as $user");
+         }
+    }
+
+       when(/^logout$/i){
+         delete $self->{nick_to_username}{$from};
+       }
+
+    when(/^prefix$/i){
+         if (defined $username) {
+               $self->{prefix}{$username} = [@args];
+         } else {
+               $self->{irc}->yield(privmsg => $nick, 'You are not logged in. Say "login your_username your_password" (where your_username and your_password are your login credentials) to login.');
+         }
+    }
+
+    when(/^noprefix$/i){
+         if (defined $username) {
+               delete $self->{prefix}{$username}
+         } else {
+               $self->{irc}->yield(privmsg => $nick, 'You are not logged in. Say "login your_username your_password" (where your_username and your_password are your login credentials) to login.');
+         }
+    }
+
+       default {
+         if (defined $username) {
+               $ok_user_addresses{"$username $address"}=1;
+               $self->{log}->debug("Command $cmd @args from $username");
+               if (exists $self->{prefix}{$username}) {
+                 sendmsg $username, undef, $address, @{$self->{prefix}{$username}}, $cmd, @args;
+               } else {
+                 sendmsg $username, undef, $address, $cmd, @args;
+               }
+         } else {
+               $self->{irc}->yield(privmsg => $nick, 'You are not logged in. Say "login your_username your_password" (where your_username and your_password are your login credentials) to login.');
+         }
+       }
+
+  }
+}
+
+sub irc_public{
+  # Do nothing
+}
+
+sub irc_001{
+  # Do nothing
+}
+
+sub send_message{
+  my ($self, $address, $content)=@_[OBJECT, ARG0, ARG1];
+  $self->{irc}->yield(privmsg => $address, $_) for map {unpack '(A400)*'} split "\n", $content
+}
+
+sub shutdown{
+  $_[KERNEL]->alias_remove($_) for $_[KERNEL]->alias_list;
+}
+
+sub _start { ... }
+
+1
diff --git a/lib/App/FonBot/Plugin/OFTC.pm b/lib/App/FonBot/Plugin/OFTC.pm
new file mode 100644 (file)
index 0000000..12b88cf
--- /dev/null
@@ -0,0 +1,115 @@
+package App::FonBot::Plugin::OFTC;
+
+our $VERSION = '0.000_3';
+
+use v5.14;
+use strict;
+use warnings;
+
+use parent qw/App::FonBot::Plugin::IRC/;
+
+use POE;
+use POE::Component::IRC::Plugin::AutoJoin;
+use POE::Component::IRC::Plugin::Connector;
+use POE::Component::IRC::Plugin::NickServID;
+
+use App::FonBot::Plugin::Config qw/$oftc_enabled $oftc_nick @oftc_channels $oftc_nickserv_password/;
+
+##################################################
+
+sub _start{
+  return unless $oftc_enabled;
+  my $self=$_[OBJECT];
+
+  $self->{irc} = POE::Component::IRC->spawn(
+       Nick => $oftc_nick,
+       Username => $oftc_nick,
+       Ircname => 'FonBot OFTC Transport',
+       Server => 'irc.oftc.net',
+       Port => 6697,
+       UseSSL => 1,
+  );
+  $self->{irc}->yield(register => qw/msg/);
+  $self->{irc}->yield(connect => {});
+
+  $self->{irc}->plugin_add(Connector => POE::Component::IRC::Plugin::Connector->new);
+  $self->{irc}->plugin_add(AutoJoin => POE::Component::IRC::Plugin::AutoJoin->new(
+       Channels => \@oftc_channels
+  ));
+
+  $self->{irc}->plugin_add(NickServID => POE::Component::IRC::Plugin::NickServID->new(
+       Password => $oftc_nickserv_password
+  ));
+
+  $_[KERNEL]->alias_set('OFTC');
+}
+
+1;
+
+__END__
+
+=head1 NAME
+
+App::FonBot::Plugin::OFTC - FonBot pluginthat provides the OFTC user interface
+
+=head1 SYNOPSIS
+
+    use App::FonBot::Plugin::OFTC;
+    App::FonBot::Plugin::OFTC->init;
+
+    END {App::FonBot::Plugin::OFTC->fini};
+
+=head1 DESCRIPTION
+
+This is one of the two implementations of C<App::FonBot::Plugin::IRC>. It connects to OFTC, joins C<$oftc_channel>, identifies with NickServ using the C<$oftc_nickserv_password> password, and processes received commands.
+
+=head1 CONFIGURATION VARIABLES
+
+These are the L<App::FonBot::Plugin::Config> configuration variables used in this module
+
+=over
+
+=item C<$oftc_enabled>
+
+If false, the OFTC plugin is disabled.
+
+=item C<$oftc_nick>
+
+IRC nickname.
+
+=item C<@oftc_channels>
+
+List of channels to join.
+
+=item C<$oftc_nickserv_password>
+
+Password to identify to NickServ with.
+
+=back
+
+=head1 AUTHOR
+
+Marius Gavrilescu C<< <marius@ieval.ro> >>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2013 Marius Gavrilescu
+
+This file is part of fonbotd.
+
+fonbotd is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+fonbotd is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with fonbotd.  If not, see <http://www.gnu.org/licenses/>
+
+
+=cut
+
diff --git a/log4perl.conf b/log4perl.conf
new file mode 100644 (file)
index 0000000..a24a8a1
--- /dev/null
@@ -0,0 +1,10 @@
+log4perl.category.App.FonBot = DEBUG, logfile, stderr
+
+log4perl.appender.logfile                          = Log::Log4perl::Appender::File
+log4perl.appender.logfile.filename                 = /var/log/fonbotd
+log4perl.appender.logfile.layout                   = Log::Log4perl::Layout::PatternLayout
+log4perl.appender.logfile.layout.ConversionPattern = [%d] [%M{2} %F{1}:%L] [%p] %m%n
+
+log4perl.appender.stderr                          = Log::Log4perl::Appender::Screen
+log4perl.appender.stderr.layout                   = Log::Log4perl::Layout::PatternLayout
+log4perl.appender.stderr.layout.ConversionPattern = [%d] [%F{1}:%M{1}:%L] [%p] %m%n
diff --git a/t/App-FonBot-Daemon.t b/t/App-FonBot-Daemon.t
new file mode 100644 (file)
index 0000000..add887f
--- /dev/null
@@ -0,0 +1,18 @@
+# Before `make install' is performed this script should be runnable with
+# `make test'. After `make install' it should work as `perl App-FonBot-Daemon.t'
+
+#########################
+
+# change 'tests => 1' to 'tests => last_test_to_print';
+
+use strict;
+use warnings;
+
+use Test::More tests => 1;
+BEGIN { use_ok('App::FonBot::Daemon') };
+
+#########################
+
+# Insert your test code below, the Test::More module is use()ed here so read
+# its man page ( perldoc Test::More ) for help writing this test script.
+
This page took 0.03824 seconds and 4 git commands to generate.