summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2012-01-28 14:09:30 -0200
committerSilvio Rhatto <rhatto@riseup.net>2012-01-28 14:09:30 -0200
commitafade3b215bc5c10fdbf30a5d8b6d97e87302aaa (patch)
treea25deb96cf1616cda6278929a5408e31edf428e7
downloadpuppet-qwebirc-afade3b215bc5c10fdbf30a5d8b6d97e87302aaa.tar.gz
puppet-qwebirc-afade3b215bc5c10fdbf30a5d8b6d97e87302aaa.tar.bz2
Initial import
-rw-r--r--LICENSE661
-rw-r--r--files/ircclient-ssl.py173
-rw-r--r--files/qwebirc-init.d.sh154
-rw-r--r--files/qwebirc-ssl.patch38
-rw-r--r--files/qwebirc-ssl.patch.orig38
-rw-r--r--manifests/init.pp72
-rw-r--r--templates/config.py.erb303
7 files changed, 1439 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..dba13ed
--- /dev/null
+++ b/LICENSE
@@ -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/files/ircclient-ssl.py b/files/ircclient-ssl.py
new file mode 100644
index 0000000..2fd09c0
--- /dev/null
+++ b/files/ircclient-ssl.py
@@ -0,0 +1,173 @@
+import twisted, sys, codecs, traceback
+from twisted.words.protocols import irc
+from twisted.internet import reactor, protocol, abstract, ssl
+from twisted.web import resource, server
+from twisted.protocols import basic
+from twisted.names.client import Resolver
+import hmac, time, config, random, qwebirc.config_options as config_options
+from config import HMACTEMPORAL
+
+if config.get("CONNECTION_RESOLVER"):
+ CONNECTION_RESOLVER = Resolver(servers=config.get("CONNECTION_RESOLVER"))
+else:
+ CONNECTION_RESOLVER = None
+
+if hasattr(config, "WEBIRC_MODE") and config.WEBIRC_MODE == "hmac":
+ HMACKEY = hmac.HMAC(key=config.HMACKEY)
+
+def hmacfn(*args):
+ h = HMACKEY.copy()
+ h.update("%d %s" % (int(time.time() / HMACTEMPORAL), " ".join(args)))
+ return h.hexdigest()
+
+def utf8_iso8859_1(data, table=dict((x, x.decode("iso-8859-1")) for x in map(chr, range(0, 256)))):
+ return (table.get(data.object[data.start]), data.start+1)
+
+codecs.register_error("mixed-iso-8859-1", utf8_iso8859_1)
+
+def irc_decode(x):
+ try:
+ return x.decode("utf-8", "mixed-iso-8859-1")
+ except UnicodeDecodeError:
+ return x.decode("iso-8859-1", "ignore")
+
+class QWebIRCClient(basic.LineReceiver):
+ delimiter = "\n"
+ def __init__(self, *args, **kwargs):
+ self.__nickname = "(unregistered)"
+
+ def dataReceived(self, data):
+ basic.LineReceiver.dataReceived(self, data.replace("\r", ""))
+
+ def lineReceived(self, line):
+ line = irc_decode(irc.lowDequote(line))
+
+ try:
+ prefix, command, params = irc.parsemsg(line)
+ self.handleCommand(command, prefix, params)
+ except irc.IRCBadMessage:
+ # emit and ignore
+ traceback.print_exc()
+ return
+
+ if command == "001":
+ self.__nickname = params[0]
+
+ if self.__perform is not None:
+ for x in self.__perform:
+ self.write(x)
+ self.__perform = None
+ elif command == "NICK":
+ nick = prefix.split("!", 1)[0]
+ if nick == self.__nickname:
+ self.__nickname = params[0]
+
+ def handleCommand(self, command, prefix, params):
+ self("c", command, prefix, params)
+
+ def __call__(self, *args):
+ self.factory.publisher.event(args)
+
+ def write(self, data):
+ self.transport.write("%s\r\n" % irc.lowQuote(data.encode("utf-8")))
+
+ def connectionMade(self):
+ basic.LineReceiver.connectionMade(self)
+
+ self.lastError = None
+ f = self.factory.ircinit
+ nick, ident, ip, realname, hostname, pass_ = f["nick"], f["ident"], f["ip"], f["realname"], f["hostname"], f.get("password")
+ self.__nickname = nick
+ self.__perform = f.get("perform")
+
+ if not hasattr(config, "WEBIRC_MODE"):
+ self.write("USER %s bleh bleh %s :%s" % (ident, ip, realname))
+ elif config.WEBIRC_MODE == "hmac":
+ hmac = hmacfn(ident, ip)
+ self.write("USER %s bleh bleh %s %s :%s" % (ident, ip, hmac, realname))
+ elif config.WEBIRC_MODE == "webirc":
+ self.write("WEBIRC %s qwebirc %s %s" % (config.WEBIRC_PASSWORD, hostname, ip))
+ self.write("USER %s bleh %s :%s" % (ident, ip, realname))
+ elif config.WEBIRC_MODE == "cgiirc":
+ self.write("PASS %s_%s_%s" % (config.CGIIRC_STRING, ip, hostname))
+ self.write("USER %s bleh %s :%s" % (ident, ip, realname))
+ elif config.WEBIRC_MODE == config_options.WEBIRC_REALNAME or config.WEBIRC_MODE is None: # last bit is legacy
+ if ip == hostname:
+ dispip = ip
+ else:
+ dispip = "%s/%s" % (hostname, ip)
+
+ self.write("USER %s bleh bleh :%s - %s" % (ident, dispip, realname))
+
+ if pass_ is not None:
+ self.write("PASS :%s" % pass_)
+ self.write("NICK %s" % nick)
+
+ self.factory.client = self
+ self("connect")
+
+ def __str__(self):
+ return "<QWebIRCClient: %s!%s@%s>" % (self.__nickname, self.factory.ircinit["ident"], self.factory.ircinit["ip"])
+
+ def connectionLost(self, reason):
+ if self.lastError:
+ self.disconnect("Connection to IRC server lost: %s" % self.lastError)
+ else:
+ self.disconnect("Connection to IRC server lost.")
+ self.factory.client = None
+ basic.LineReceiver.connectionLost(self, reason)
+
+ def error(self, message):
+ self.lastError = message
+ self.write("QUIT :qwebirc exception: %s" % message)
+ self.transport.loseConnection()
+
+ def disconnect(self, reason):
+ self("disconnect", reason)
+ self.factory.publisher.disconnect()
+
+class QWebIRCFactory(protocol.ClientFactory):
+ protocol = QWebIRCClient
+ def __init__(self, publisher, **kwargs):
+ self.client = None
+ self.publisher = publisher
+ self.ircinit = kwargs
+
+ def write(self, data):
+ self.client.write(data)
+
+ def error(self, reason):
+ self.client.error(reason)
+
+ def clientConnectionFailed(self, connector, reason):
+ protocol.ClientFactory.clientConnectionFailed(self, connector, reason)
+ self.publisher.event(["disconnect", "Connection to IRC server failed."])
+ self.publisher.disconnect()
+
+def createIRC(*args, **kwargs):
+ f = QWebIRCFactory(*args, **kwargs)
+
+ tcpkwargs = {}
+ if hasattr(config, "OUTGOING_IP"):
+ tcpkwargs["bindAddress"] = (config.OUTGOING_IP, 0)
+
+ if CONNECTION_RESOLVER is None:
+ if hasattr(config, "SSLPORT"):
+ reactor.connectSSL(config.IRCSERVER, config.SSLPORT, f, ssl.ClientContextFactory(), **tcpkwargs)
+ else:
+ reactor.connectTCP(config.IRCSERVER, config.IRCPORT, f, **tcpkwargs)
+ return f
+
+ def callback(result):
+ name, port = random.choice(sorted((str(x.payload.target), x.payload.port) for x in result[0]))
+ reactor.connectTCP(name, port, f, **tcpkwargs)
+ def errback(err):
+ f.clientConnectionFailed(None, err) # None?!
+
+ d = CONNECTION_RESOLVER.lookupService(config.IRCSERVER, (1, 3, 11))
+ d.addCallbacks(callback, errback)
+ return f
+
+if __name__ == "__main__":
+ e = createIRC(lambda x: 2, nick="slug__moo", ident="mooslug", ip="1.2.3.6", realname="mooooo", hostname="1.2.3.4")
+ reactor.run()
diff --git a/files/qwebirc-init.d.sh b/files/qwebirc-init.d.sh
new file mode 100644
index 0000000..c0cea70
--- /dev/null
+++ b/files/qwebirc-init.d.sh
@@ -0,0 +1,154 @@
+#! /bin/sh
+### BEGIN INIT INFO
+# Provides: qwebirc
+# Required-Start: $remote_fs $syslog
+# Required-Stop: $remote_fs $syslog
+# Default-Start: 2 3 4 5
+# Default-Stop: 0 1 6
+# Short-Description: QwebIRC web interface
+# Description: This script launches the QWebIRC daemon.
+### END INIT INFO
+
+# Author: Antoine Beaupre <anarcat@koumbit.org>
+
+# PATH should only include /usr/* if it runs after the mountnfs.sh script
+PATH=/sbin:/usr/sbin:/bin:/usr/bin
+DESC="Description of the service"
+NAME=qwebirc
+HOME=/var/lib/qwebirc
+DAEMON=$HOME/run.py
+DAEMON_ARGS=""
+PIDFILE=$HOME/twistd.pid
+SCRIPTNAME=/etc/init.d/$NAME
+
+# Exit if the package is not installed
+[ -x "$DAEMON" ] || exit 0
+
+# Read configuration variable file if it is present
+[ -r /etc/default/$NAME ] && . /etc/default/$NAME
+
+# Load the VERBOSE setting and other rcS variables
+. /lib/init/vars.sh
+
+# Define LSB log_* functions.
+# Depend on lsb-base (>= 3.2-14) to ensure that this file is present
+# and status_of_proc is working.
+. /lib/lsb/init-functions
+
+#
+# Function that starts the daemon/service
+#
+do_start()
+{
+ # Return
+ # 0 if daemon has been started
+ # 1 if daemon was already running
+ # 2 if daemon could not be started
+ start-stop-daemon --start --quiet --pidfile $PIDFILE --startas $DAEMON --test > /dev/null \
+ || return 1
+ start-stop-daemon --chdir $HOME --chuid $NAME --start --quiet --pidfile $PIDFILE --startas $DAEMON -- \
+ $DAEMON_ARGS \
+ || return 2
+ # Add code here, if necessary, that waits for the process to be ready
+ # to handle requests from services started subsequently which depend
+ # on this one. As a last resort, sleep for some time.
+}
+
+#
+# Function that stops the daemon/service
+#
+do_stop()
+{
+ # Return
+ # 0 if daemon has been stopped
+ # 1 if daemon was already stopped
+ # 2 if daemon could not be stopped
+ # other if a failure occurred
+ start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE
+ RETVAL="$?"
+ [ "$RETVAL" = 2 ] && return 2
+ # Wait for children to finish too if this is a daemon that forks
+ # and if the daemon is only ever run from this initscript.
+ # If the above conditions are not satisfied then add some other code
+ # that waits for the process to drop all resources that could be
+ # needed by services started subsequently. A last resort is to
+ # sleep for some time.
+ start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --user $NAME --name python
+ [ "$?" = 2 ] && return 2
+ # Many daemons don't delete their pidfiles when they exit.
+ rm -f $PIDFILE
+ return "$RETVAL"
+}
+
+#
+# Function that sends a SIGHUP to the daemon/service
+#
+do_reload() {
+ #
+ # If the daemon can reload its configuration without
+ # restarting (for example, when it is sent a SIGHUP),
+ # then implement that here.
+ #
+ start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
+ return 0
+}
+
+case "$1" in
+ start)
+ [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
+ do_start
+ case "$?" in
+ 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+ 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+ esac
+ ;;
+ stop)
+ [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
+ do_stop
+ case "$?" in
+ 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+ 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+ esac
+ ;;
+ status)
+ status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $?
+ ;;
+ #reload|force-reload)
+ #
+ # If do_reload() is not implemented then leave this commented out
+ # and leave 'force-reload' as an alias for 'restart'.
+ #
+ #log_daemon_msg "Reloading $DESC" "$NAME"
+ #do_reload
+ #log_end_msg $?
+ #;;
+ restart|force-reload)
+ #
+ # If the "reload" option is implemented then remove the
+ # 'force-reload' alias
+ #
+ log_daemon_msg "Restarting $DESC" "$NAME"
+ do_stop
+ case "$?" in
+ 0|1)
+ do_start
+ case "$?" in
+ 0) log_end_msg 0 ;;
+ 1) log_end_msg 1 ;; # Old process is still running
+ *) log_end_msg 1 ;; # Failed to start
+ esac
+ ;;
+ *)
+ # Failed to stop
+ log_end_msg 1
+ ;;
+ esac
+ ;;
+ *)
+ #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
+ echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
+ exit 3
+ ;;
+esac
+
+:
diff --git a/files/qwebirc-ssl.patch b/files/qwebirc-ssl.patch
new file mode 100644
index 0000000..9c9e921
--- /dev/null
+++ b/files/qwebirc-ssl.patch
@@ -0,0 +1,38 @@
+diff -r 19d6068a1aa6 config.py.example
+--- a/config.py.example Sun Apr 03 23:58:29 2011 +0100
++++ b/config.py.example Sat Jan 28 13:31:49 2012 -0200
+@@ -20,6 +20,11 @@
+ # Port of IRC server to connect to.
+ IRCSERVER, IRCPORT = "irc.myserver.com", 6667
+
++# OPTION: SSLPORT
++# SSL port of IRC server to connect to.
++# If this option is uncommented it will override IRCPORT.
++#SSLPORT = 6697
++
+ # OPTION: REALNAME
+ # The realname field of IRC clients will be set to this value.
+ REALNAME = "http://moo.com/"
+diff -r 19d6068a1aa6 qwebirc/ircclient.py
+--- a/qwebirc/ircclient.py Sun Apr 03 23:58:29 2011 +0100
++++ b/qwebirc/ircclient.py Sat Jan 28 13:31:49 2012 -0200
+@@ -1,6 +1,6 @@
+ import twisted, sys, codecs, traceback
+ from twisted.words.protocols import irc
+-from twisted.internet import reactor, protocol, abstract
++from twisted.internet import reactor, protocol, abstract, ssl
+ from twisted.web import resource, server
+ from twisted.protocols import basic
+ from twisted.names.client import Resolver
+@@ -152,7 +152,10 @@
+ tcpkwargs["bindAddress"] = (config.OUTGOING_IP, 0)
+
+ if CONNECTION_RESOLVER is None:
+- reactor.connectTCP(config.IRCSERVER, config.IRCPORT, f, **tcpkwargs)
++ if hasattr(config, "SSLPORT"):
++ reactor.connectSSL(config.IRCSERVER, config.SSLPORT, f, ssl.ClientContextFactory(), **tcpkwargs)
++ else:
++ reactor.connectTCP(config.IRCSERVER, config.IRCPORT, f, **tcpkwargs)
+ return f
+
+ def callback(result):
diff --git a/files/qwebirc-ssl.patch.orig b/files/qwebirc-ssl.patch.orig
new file mode 100644
index 0000000..f0626f9
--- /dev/null
+++ b/files/qwebirc-ssl.patch.orig
@@ -0,0 +1,38 @@
+diff -r 19d6068a1aa6 config.py.example
+--- a/config.py.example Sun Apr 03 23:58:29 2011 +0100
++++ b/config.py.example Wed Oct 12 17:43:46 2011 -0400
+@@ -19,6 +19,11 @@
+ # OPTION: IRCPORT
+ # Port of IRC server to connect to.
+ IRCSERVER, IRCPORT = "irc.myserver.com", 6667
++
++# OPTION: SSLPORT
++# SSL port of IRC server to connect to.
++# If this option is uncommented it will override IRCPORT.
++#SSLPORT = 6697
+
+ # OPTION: REALNAME
+ # The realname field of IRC clients will be set to this value.
+diff -r 19d6068a1aa6 qwebirc/ircclient.py
+--- a/qwebirc/ircclient.py Sun Apr 03 23:58:29 2011 +0100
++++ b/qwebirc/ircclient.py Wed Oct 12 17:43:46 2011 -0400
+@@ -1,6 +1,6 @@
+ import twisted, sys, codecs, traceback
+ from twisted.words.protocols import irc
+-from twisted.internet import reactor, protocol, abstract
++from twisted.internet import reactor, protocol, abstract, ssl
+ from twisted.web import resource, server
+ from twisted.protocols import basic
+ from twisted.names.client import Resolver
+@@ -152,7 +152,10 @@
+ tcpkwargs["bindAddress"] = (config.OUTGOING_IP, 0)
+
+ if CONNECTION_RESOLVER is None:
+- reactor.connectTCP(config.IRCSERVER, config.IRCPORT, f, **tcpkwargs)
++ if hasattr(config, "SSLPORT"):
++ reactor.connectSSL(config.IRCSERVER, config.SSLPORT, f, ssl.ClientContextFactory(), **tcpkwargs)
++ else:
++ reactor.connectTCP(config.IRCSERVER, config.IRCPORT, f, **tcpkwargs)
+ return f
+
+ def callback(result):
diff --git a/manifests/init.pp b/manifests/init.pp
new file mode 100644
index 0000000..3e50670
--- /dev/null
+++ b/manifests/init.pp
@@ -0,0 +1,72 @@
+# Based on https://wiki.koumbit.net/QwebIrc
+class qwebirc($ircserver = 'irc.myserver.com', $ircport = '6667', $realname = 'http://moo.com/',
+ $webirc_mode = 'None', $base_url = 'http://foo.foo.org/', $network_name = 'FooNet',
+ $sslport = false) {
+
+ package { [ 'python-twisted', 'python-openssl', 'python-simplejson', 'mercurial' ]:
+ ensure => present,
+ }
+
+ group { "qwebirc":
+ ensure => present,
+ allowdupe => false,
+ }
+
+ user { "qwebirc":
+ ensure => present,
+ allowdupe => false,
+ gid => 'qwebirc',
+ require => Group['qwebirc'],
+ }
+
+ file { '/etc/init.d/qwebirc':
+ ensure => present,
+ owner => root,
+ group => root,
+ mode => 0755,
+ source => 'puppet:///modules/qwebirc/qwebirc-init.d.sh',
+ require => Vcsrepo['/var/lib/qwebirc'],
+ }
+
+ vcsrepo { "/var/lib/qwebirc":
+ ensure => present,
+ provider => hg,
+ source => 'https://bitbucket.org/qwebirc/qwebirc',
+ revision => '19d6068a1aa6',
+ owner => 'qwebirc',
+ group => 'qwebirc',
+ require => [ User['qwebirc'], Group['qwebirc'], Package['mercurial'] ],
+ notify => Service['qwebirc'],
+ }
+
+ file { '/var/lib/qwebirc/config.py':
+ ensure => present,
+ owner => 'qwebirc',
+ group => 'qwebirc',
+ mode => 0640,
+ content => template('qwebirc/config.py.erb'),
+ require => Vcsrepo['/var/lib/qwebirc'],
+ notify => Service['qwebirc'],
+ }
+
+ # See http://hg.qwebirc.org/qwebirc/issue/152/ssl
+ file { '/var/lib/qwebirc/qwebirc/ircclient.py':
+ ensure => present,
+ owner => 'qwebirc',
+ group => 'qwebirc',
+ mode => 0640,
+ source => 'puppet:///modules/qwebirc/ircclient-ssl.py',
+ require => Vcsrepo['/var/lib/qwebirc'],
+ notify => Service['qwebirc'],
+ }
+
+ service { 'qwebirc':
+ enable => true,
+ ensure => running,
+ hasrestart => true,
+ hasstatus => true,
+ require => [ File['/etc/init.d/qwebirc', '/var/lib/qwebirc/config.py',
+ '/var/lib/qwebirc/qwebirc/ircclient.py'],
+ Package['python-twisted'] ],
+ }
+}
diff --git a/templates/config.py.erb b/templates/config.py.erb
new file mode 100644
index 0000000..efafd7c
--- /dev/null
+++ b/templates/config.py.erb
@@ -0,0 +1,303 @@
+# qwebirc configuration file
+#
+# This a Python program that is imported, so feel free to use any
+# Python here!
+#
+# Note that some changes to this configuration file require re-running
+# compile.py and others require restarting qwebirc (and some require
+# both!)
+# If in doubt always re-compile and restart.
+
+# The following line is required, don't remove it!
+from qwebirc.config_options import *
+
+# IRC OPTIONS
+# ---------------------------------------------------------------------
+#
+# OPTION: IRCSERVER
+# Hostname (or IP address) of IRC server to connect to.
+# OPTION: IRCPORT
+# Port of IRC server to connect to.
+IRCSERVER, IRCPORT = "<%= ircserver %>", <%= ircport %>
+
+<% if ssl_port != false %>
+# OPTION: SSLPORT
+# SSL port of IRC server to connect to.
+# If this option is uncommented it will override IRCPORT.
+SSLPORT = 6697
+<% end %>
+# OPTION: REALNAME
+# The realname field of IRC clients will be set to this value.
+REALNAME = "<%= realname %>"
+
+# OPTION: IDENT
+# ident to use on irc, possible values include:
+# - a string, e.g. IDENT = "webchat"
+# - the literal value IDENT_HEX, this will set the ident to the
+# a hexadecimal version of the users IP address, e.g
+# IDENT = IDENT_HEX
+# - the literal value IDENT_NICKNAME, this will use the users
+# supplied nickname as their ident.
+IDENT = "webchat"
+
+# OPTION: OUTGOING_IP
+# The IP address to bind to when connecting to the IRC server.
+#
+# This will not change the IP address that qwebirc listens on.
+# You will need to call run.py with the --ip/-i option if you
+# want that.
+#OUTGOING_IP = "127.0.0.1"
+
+# OPTION: WEBIRC_MODE
+# This option controls how the IP/hostname of the connecting
+# browser will be sent to IRC.
+#
+# Possible values include:
+# - the string "webirc", i.e. WEBIRC_MODE = "webirc"
+# Use WEBIRC type blocks, with a server configuration of
+# the following style:
+#
+# cgiirc {
+# type webirc;
+# hostname <qwebirc's ip address>;
+# password <password>;
+# };
+#
+# Remember to set the WEBIRC_PASSWORD value to be the
+# same as <password>.
+# - the string "cgiirc", i.e. WEBIRC_MODE = "cgiirc"
+# old style CGIIRC command, set CGIIRC_STRING to be the
+# command used to set the ip/hostname, and set
+# WEBIRC_PASSWORD to be the password used in the server's
+# configuration file.
+# - the literal value None, i.e. WEBIRC_MODE = None
+# Send the IP and hostname in the realname field, overrides
+# the REALNAME option.
+WEBIRC_MODE = <%= webirc_mode %>
+
+# OPTION: WEBIRC_PASSWORD
+# Used for WEBIRC_MODE webirc and cgiirc, see WEBIRC_MODE
+# option documentation.
+#WEBIRC_PASSWORD = "fish"
+
+# OPTION: CGIIRC_STRING
+# Command sent to IRC server in for cgiirc WEBIRC_MODE.
+# See WEBIRC_MODE option documentation.
+#CGIIRC_STRING = "CGIIRC"
+
+# UI OPTIONS
+# ---------------------------------------------------------------------
+#
+# OPTION: BASE_URL
+# URL that this qwebirc instance will be available at, add the
+# port number if your instance runs on a port other than 80.
+BASE_URL = "<%= base_url %>"
+
+# OPTION: NETWORK_NAME
+# The name of your IRC network, displayed throughout the
+# application.
+NETWORK_NAME = "<%= network_name %>"
+
+# OPTION: APP_TITLE
+# The title of the application in the web browser.
+APP_TITLE = NETWORK_NAME + " Web IRC"
+
+# NICKNAME VALIDATION OPTIONS
+# ---------------------------------------------------------------------
+#
+# OPTION: NICKNAME_VALIDATE
+# If True then user nicknames will be validated according to
+# the configuration below, otherwise they will be passed
+# directly to the ircd.
+NICKNAME_VALIDATE = True
+
+# OPTION: NICKNAME_VALID_FIRST_CHAR
+# A string containing valid characters for the first letter of
+# a nickname.
+# Default is as in RFC1459.
+import string
+NICKNAME_VALID_FIRST_CHAR = string.letters + "_[]{}`^\\|"
+
+# OPTION: NICKNAME_VALID_SUBSEQUENT_CHAR
+# A string containing valid characters for the rest of the
+# nickname.
+NICKNAME_VALID_SUBSEQUENT_CHARS = NICKNAME_VALID_FIRST_CHAR + string.digits + "-"
+
+# OPTION: NICKNAME_MINIMUM_LENGTH
+# Minimum characters permitted in a nickname on your network.
+NICKNAME_MINIMUM_LENGTH = 2
+
+# OPTION: NICKNAME_MAXIMUM_LENGTH
+# Maximum characters permitted in a nickname on your network.
+# Ideally we'd extract this from the ircd, but we need to know
+# before we connect.
+NICKNAME_MAXIMUM_LENGTH = 15
+
+# FEEDBACK OPTIONS
+# ---------------------------------------------------------------------
+#
+# These options control the feedback module, which allows users to
+# send feedback directly from qwebirc (via email).
+#
+# OPTION: FEEDBACK_FROM
+# E-mail address that feedback will originate from.
+FEEDBACK_FROM = "moo@moo.com"
+
+# OPTION: FEEDBACK_TO:
+# E-mail address that feedback will be sent to.
+FEEDBACK_TO = "moo@moo.com"
+
+# OPTION: FEEDBACK_SMTP_HOST
+# Hostname/IP address of SMTP server feedback will be sent
+# through.
+# OPTION: FEEDBACK_SMTP_PORT
+# Port of SMTP server feedback will be sent through.
+FEEDBACK_SMTP_HOST, FEEDBACK_SMTP_PORT = "127.0.0.1", 25
+
+# ADMIN ENGINE OPTIONS
+# ---------------------------------------------------------------------
+#
+# OPTION: ADMIN_ENGINE_HOSTS:
+# List of IP addresses to allow onto the admin engine at
+# http://instance/adminengine
+ADMIN_ENGINE_HOSTS = ["127.0.0.1"]
+
+# PROXY OPTIONS
+# ---------------------------------------------------------------------
+#
+# OPTION: FORWARDED_FOR_HEADER
+# If you're using a proxy that passes through a forwarded-for
+# header set this option to the header name, also set
+# FORWARDED_FOR_IPS.
+#FORWARDED_FOR_HEADER="x-forwarded-for"
+
+# OPTION: FORWARDED_FOR_IPS
+# This option specifies the IP addresses that forwarded-for
+# headers will be accepted from.
+#FORWARDED_FOR_IPS=["127.0.0.1"]
+
+# EXECUTION OPTIONS
+# ---------------------------------------------------------------------
+#
+# OPTION: ARGS (optional)
+# These arguments will be used as if qwebirc was run directly
+# with them, see run.py --help for a list of options.
+#ARGS = "-n -p 3989"
+
+# OPTION: SYSLOG_ADDR (optional)
+# Used in conjunction with util/syslog.py and -s option.
+# This option specifies the address and port that syslog
+# datagrams will be sent to.
+#SYSLOG_ADDR = "127.0.0.1", 514
+
+# TUNEABLE VALUES
+# ---------------------------------------------------------------------
+#
+# You probably don't want to fiddle with these unless you really know
+# what you're doing...
+
+# OPTION: UPDATE_FREQ
+# Maximum rate (in seconds) at which updates will be propagated
+# to clients
+UPDATE_FREQ = 0.5
+
+# OPTION: MAXBUFLEN
+# Maximum client AJAX recieve buffer size (in bytes), if this
+# buffer size is exceeded then the client will be disconnected.
+# This value should match the client sendq size in your ircd's
+# configuration.
+MAXBUFLEN = 100000
+
+# OPTION: MAXSUBSCRIPTIONS
+# Maximum amount of 'subscriptions' to a specific AJAX channel,
+# i.e. an IRC connection.
+# In theory with a value greater than one you can connect more
+# than one web IRC client to the same IRC connection, ala
+# irssi-proxy.
+MAXSUBSCRIPTIONS = 1
+
+# OPTION: MAXLINELEN
+# If the client sends a line greater than MAXLINELEN (in bytes)
+# then they will be disconnected.
+# Note that IRC normally silently drops messages >=512 bytes.
+MAXLINELEN = 600
+
+# OPTION: DNS_TIMEOUT
+# DNS requests that do not respond within DNS_TIMEOUT seconds
+# will be cancelled.
+DNS_TIMEOUT = 5
+
+# OPTION: HTTP_AJAX_REQUEST_TIMEOUT
+# Connections made to the AJAX engine are closed after this
+# this many seconds.
+# Note that this value is intimately linked with the client
+# AJAX code at this time, changing it will result in bad
+# things happening.
+HTTP_AJAX_REQUEST_TIMEOUT = 30
+
+# OPTION: HTTP_REQUEST_TIMEOUT
+# Connections made to everything but the AJAX engine will
+# be closed after this many seconds, including connections
+# that haven't started/completed an HTTP request.
+HTTP_REQUEST_TIMEOUT = 5
+
+# OPTION: STATIC_BASE_URL
+# This value is used to build the URL for all static HTTP
+# requests.
+# You'd find this useful if you're running multiple qwebirc
+# instances on the same host.
+STATIC_BASE_URL = ""
+
+# OPTION: DYNAMIC_BASE_URL
+# This value is used to build the URL for all dynamic HTTP
+# requests.
+# You'd find this useful if you're running multiple qwebirc
+# instances on the same host.
+DYNAMIC_BASE_URL = ""
+
+# OPTION: CONNECTION_RESOLVER
+# A list of (ip, port) tuples of resolvers to use for looking
+# the SRV record(s) used for connecting to the name set in
+# IRC_SERVER.
+# The default value is None, and in this case qwebirc will use
+# the system's default resolver(s).
+CONNECTION_RESOLVER = None
+
+# QUAKENET SPECIFIC VALUES
+# ---------------------------------------------------------------------
+#
+# These values are of no interest if you're not QuakeNet.
+# At present they still need to be set, this will change soon.
+#
+# OPTION: HMACKEY
+# Shared key to use with hmac WEBIRC_MODE.
+HMACKEY = "mrmoo"
+
+# OPTION: HMACTEMPORAL
+# Divisor used for modulo HMAC timestamp generation.
+HMACTEMPORAL = 30
+
+# OPTION: AUTHGATEDOMAIN
+# Domain accepted inside authgate tickets.
+AUTHGATEDOMAIN = "webchat_test"
+
+# OPTION: QTICKETKEY
+# Key shared with the authgate that is used to decrypt
+# qtickets.
+QTICKETKEY = "boo"
+
+# OPTION: AUTH_SERVICE
+# Service that auth commands are sent to. Also used to check
+# responses from said service.
+AUTH_SERVICE = "Q!TheQBot@CServe.quakenet.org"
+
+# OPTION: AUTH_OK_REGEX
+# JavaScript regular expression that should match when
+# AUTH_SERVICE has returned an acceptable response to
+# authentication.
+AUTH_OK_REGEX = "^You are now logged in as [^ ]+\\.$"
+
+# OPTION: AUTHGATEPROVIDER
+# Authgate module to use, normally imported directly.
+# dummyauthgate does nothing.
+import dummyauthgate as AUTHGATEPROVIDER