commit
2de3521d32
11 changed files with 447 additions and 0 deletions
@ -0,0 +1,4 @@
|
||||
[gerrit] |
||||
host=review.openstack.org |
||||
port=29418 |
||||
project=openstack-infra/ptgbot.git |
@ -0,0 +1,202 @@
|
||||
|
||||
Apache License |
||||
Version 2.0, January 2004 |
||||
http://www.apache.org/licenses/ |
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION |
||||
|
||||
1. Definitions. |
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction, |
||||
and distribution as defined by Sections 1 through 9 of this document. |
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by |
||||
the copyright owner that is granting the License. |
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all |
||||
other entities that control, are controlled by, or are under common |
||||
control with that entity. For the purposes of this definition, |
||||
"control" means (i) the power, direct or indirect, to cause the |
||||
direction or management of such entity, whether by contract or |
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the |
||||
outstanding shares, or (iii) beneficial ownership of such entity. |
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity |
||||
exercising permissions granted by this License. |
||||
|
||||
"Source" form shall mean the preferred form for making modifications, |
||||
including but not limited to software source code, documentation |
||||
source, and configuration files. |
||||
|
||||
"Object" form shall mean any form resulting from mechanical |
||||
transformation or translation of a Source form, including but |
||||
not limited to compiled object code, generated documentation, |
||||
and conversions to other media types. |
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or |
||||
Object form, made available under the License, as indicated by a |
||||
copyright notice that is included in or attached to the work |
||||
(an example is provided in the Appendix below). |
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object |
||||
form, that is based on (or derived from) the Work and for which the |
||||
editorial revisions, annotations, elaborations, or other modifications |
||||
represent, as a whole, an original work of authorship. For the purposes |
||||
of this License, Derivative Works shall not include works that remain |
||||
separable from, or merely link (or bind by name) to the interfaces of, |
||||
the Work and Derivative Works thereof. |
||||
|
||||
"Contribution" shall mean any work of authorship, including |
||||
the original version of the Work and any modifications or additions |
||||
to that Work or Derivative Works thereof, that is intentionally |
||||
submitted to Licensor for inclusion in the Work by the copyright owner |
||||
or by an individual or Legal Entity authorized to submit on behalf of |
||||
the copyright owner. For the purposes of this definition, "submitted" |
||||
means any form of electronic, verbal, or written communication sent |
||||
to the Licensor or its representatives, including but not limited to |
||||
communication on electronic mailing lists, source code control systems, |
||||
and issue tracking systems that are managed by, or on behalf of, the |
||||
Licensor for the purpose of discussing and improving the Work, but |
||||
excluding communication that is conspicuously marked or otherwise |
||||
designated in writing by the copyright owner as "Not a Contribution." |
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity |
||||
on behalf of whom a Contribution has been received by Licensor and |
||||
subsequently incorporated within the Work. |
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of |
||||
this License, each Contributor hereby grants to You a perpetual, |
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||
copyright license to reproduce, prepare Derivative Works of, |
||||
publicly display, publicly perform, sublicense, and distribute the |
||||
Work and such Derivative Works in Source or Object form. |
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of |
||||
this License, each Contributor hereby grants to You a perpetual, |
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||
(except as stated in this section) patent license to make, have made, |
||||
use, offer to sell, sell, import, and otherwise transfer the Work, |
||||
where such license applies only to those patent claims licensable |
||||
by such Contributor that are necessarily infringed by their |
||||
Contribution(s) alone or by combination of their Contribution(s) |
||||
with the Work to which such Contribution(s) was submitted. If You |
||||
institute patent litigation against any entity (including a |
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work |
||||
or a Contribution incorporated within the Work constitutes direct |
||||
or contributory patent infringement, then any patent licenses |
||||
granted to You under this License for that Work shall terminate |
||||
as of the date such litigation is filed. |
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the |
||||
Work or Derivative Works thereof in any medium, with or without |
||||
modifications, and in Source or Object form, provided that You |
||||
meet the following conditions: |
||||
|
||||
(a) You must give any other recipients of the Work or |
||||
Derivative Works a copy of this License; and |
||||
|
||||
(b) You must cause any modified files to carry prominent notices |
||||
stating that You changed the files; and |
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works |
||||
that You distribute, all copyright, patent, trademark, and |
||||
attribution notices from the Source form of the Work, |
||||
excluding those notices that do not pertain to any part of |
||||
the Derivative Works; and |
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its |
||||
distribution, then any Derivative Works that You distribute must |
||||
include a readable copy of the attribution notices contained |
||||
within such NOTICE file, excluding those notices that do not |
||||
pertain to any part of the Derivative Works, in at least one |
||||
of the following places: within a NOTICE text file distributed |
||||
as part of the Derivative Works; within the Source form or |
||||
documentation, if provided along with the Derivative Works; or, |
||||
within a display generated by the Derivative Works, if and |
||||
wherever such third-party notices normally appear. The contents |
||||
of the NOTICE file are for informational purposes only and |
||||
do not modify the License. You may add Your own attribution |
||||
notices within Derivative Works that You distribute, alongside |
||||
or as an addendum to the NOTICE text from the Work, provided |
||||
that such additional attribution notices cannot be construed |
||||
as modifying the License. |
||||
|
||||
You may add Your own copyright statement to Your modifications and |
||||
may provide additional or different license terms and conditions |
||||
for use, reproduction, or distribution of Your modifications, or |
||||
for any such Derivative Works as a whole, provided Your use, |
||||
reproduction, and distribution of the Work otherwise complies with |
||||
the conditions stated in this License. |
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise, |
||||
any Contribution intentionally submitted for inclusion in the Work |
||||
by You to the Licensor shall be under the terms and conditions of |
||||
this License, without any additional terms or conditions. |
||||
Notwithstanding the above, nothing herein shall supersede or modify |
||||
the terms of any separate license agreement you may have executed |
||||
with Licensor regarding such Contributions. |
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade |
||||
names, trademarks, service marks, or product names of the Licensor, |
||||
except as required for reasonable and customary use in describing the |
||||
origin of the Work and reproducing the content of the NOTICE file. |
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or |
||||
agreed to in writing, Licensor provides the Work (and each |
||||
Contributor provides its Contributions) on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
||||
implied, including, without limitation, any warranties or conditions |
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A |
||||
PARTICULAR PURPOSE. You are solely responsible for determining the |
||||
appropriateness of using or redistributing the Work and assume any |
||||
risks associated with Your exercise of permissions under this License. |
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory, |
||||
whether in tort (including negligence), contract, or otherwise, |
||||
unless required by applicable law (such as deliberate and grossly |
||||
negligent acts) or agreed to in writing, shall any Contributor be |
||||
liable to You for damages, including any direct, indirect, special, |
||||
incidental, or consequential damages of any character arising as a |
||||
result of this License or out of the use or inability to use the |
||||
Work (including but not limited to damages for loss of goodwill, |
||||
work stoppage, computer failure or malfunction, or any and all |
||||
other commercial damages or losses), even if such Contributor |
||||
has been advised of the possibility of such damages. |
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing |
||||
the Work or Derivative Works thereof, You may choose to offer, |
||||
and charge a fee for, acceptance of support, warranty, indemnity, |
||||
or other liability obligations and/or rights consistent with this |
||||
License. However, in accepting such obligations, You may act only |
||||
on Your own behalf and on Your sole responsibility, not on behalf |
||||
of any other Contributor, and only if You agree to indemnify, |
||||
defend, and hold each Contributor harmless for any liability |
||||
incurred by, or claims asserted against, such Contributor by reason |
||||
of your accepting any such warranty or additional liability. |
||||
|
||||
END OF TERMS AND CONDITIONS |
||||
|
||||
APPENDIX: How to apply the Apache License to your work. |
||||
|
||||
To apply the Apache License to your work, attach the following |
||||
boilerplate notice, with the fields enclosed by brackets "[]" |
||||
replaced with your own identifying information. (Don't include |
||||
the brackets!) The text should be enclosed in the appropriate |
||||
comment syntax for the file format. We also recommend that a |
||||
file or class name and description of purpose be included on the |
||||
same "printed page" as the copyright notice for easier |
||||
identification within third-party archives. |
||||
|
||||
Copyright [yyyy] [name of copyright owner] |
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); |
||||
you may not use this file except in compliance with the License. |
||||
You may obtain a copy of the License at |
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0 |
||||
|
||||
Unless required by applicable law or agreed to in writing, software |
||||
distributed under the License is distributed on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
See the License for the specific language governing permissions and |
||||
limitations under the License. |
@ -0,0 +1,7 @@
|
||||
================= |
||||
OpenStack PTG Bot |
||||
================= |
||||
|
||||
ptgbot is the bot that PTG room moderators use to surface what's |
||||
currently happening at the event. It builds a static webpage that |
||||
attendees can query for up-to-date information. |
@ -0,0 +1,159 @@
|
||||
#! /usr/bin/env python |
||||
|
||||
# Copyright (c) 2017, Thierry Carrez |
||||
# |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); |
||||
# you may not use this file except in compliance with the License. |
||||
# You may obtain a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, |
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
# See the License for the specific language governing permissions and |
||||
# limitations under the License. |
||||
|
||||
# The configuration file should look like: |
||||
""" |
||||
[ircbot] |
||||
nick=NICKNAME |
||||
pass=PASSWORD |
||||
server=irc.freenode.net |
||||
port=6667 |
||||
channels=foo,bar |
||||
""" |
||||
|
||||
import argparse |
||||
import configparser |
||||
import daemon |
||||
import irc.bot |
||||
import logging.config |
||||
import os |
||||
import time |
||||
import ssl |
||||
|
||||
try: |
||||
import daemon.pidlockfile as pid_file_module |
||||
except ImportError: |
||||
# as of python-daemon 1.6 it doesn't bundle pidlockfile anymore |
||||
# instead it depends on lockfile-0.9.1 |
||||
import daemon.pidfile as pid_file_module |
||||
|
||||
# https://bitbucket.org/jaraco/irc/issue/34/ |
||||
# irc-client-should-not-crash-on-failed |
||||
# ^ This is why pep8 is a bad idea. |
||||
irc.client.ServerConnection.buffer_class.errors = 'replace' |
||||
ANTI_FLOOD_SLEEP = 2 |
||||
|
||||
|
||||
class PTGBot(irc.bot.SingleServerIRCBot): |
||||
log = logging.getLogger("ptgbot.bot") |
||||
|
||||
def __init__(self, nickname, password, server, port, channels): |
||||
if port == 6697: |
||||
factory = irc.connection.Factory(wrapper=ssl.wrap_socket) |
||||
irc.bot.SingleServerIRCBot.__init__(self, |
||||
[(server, port)], |
||||
nickname, nickname, |
||||
connect_factory=factory) |
||||
else: |
||||
irc.bot.SingleServerIRCBot.__init__(self, |
||||
[(server, port)], |
||||
nickname, nickname) |
||||
self.nickname = nickname |
||||
self.password = password |
||||
self.channel_list = channels |
||||
self.identify_msg_cap = False |
||||
|
||||
def on_nicknameinuse(self, c, e): |
||||
self.log.debug("Nickname in use, releasing") |
||||
c.nick(c.get_nickname() + "_") |
||||
c.privmsg("nickserv", "identify %s " % self.password) |
||||
c.privmsg("nickserv", "ghost %s %s" % (self.nickname, self.password)) |
||||
c.privmsg("nickserv", "release %s %s" % (self.nickname, self.password)) |
||||
time.sleep(ANTI_FLOOD_SLEEP) |
||||
c.nick(self.nickname) |
||||
|
||||
def on_welcome(self, c, e): |
||||
self.identify_msg_cap = False |
||||
self.log.debug("Requesting identify-msg capability") |
||||
c.cap('REQ', 'identify-msg') |
||||
c.cap('END') |
||||
if (self.password): |
||||
self.log.debug("Identifying to nickserv") |
||||
c.privmsg("nickserv", "identify %s " % self.password) |
||||
for channel in self.channel_list: |
||||
self.log.info("Joining %s" % channel) |
||||
c.join(channel) |
||||
time.sleep(ANTI_FLOOD_SLEEP) |
||||
|
||||
def on_cap(self, c, e): |
||||
self.log.debug("Received cap response %s" % repr(e.arguments)) |
||||
if e.arguments[0] == 'ACK' and 'identify-msg' in e.arguments[1]: |
||||
self.log.debug("identify-msg cap acked") |
||||
self.identify_msg_cap = True |
||||
|
||||
def on_pubmsg(self, c, e): |
||||
if not self.identify_msg_cap: |
||||
self.log.debug("Ignoring message because identify-msg " |
||||
"cap not enabled") |
||||
return |
||||
nick = e.source.split('!')[0] |
||||
auth = e.arguments[0][0] |
||||
msg = e.arguments[0][1:] |
||||
|
||||
if msg.startswith('#test'): |
||||
self.handle_test_command(e.target, nick, auth, msg) |
||||
return |
||||
|
||||
def handle_test_command(self, channel, nick, auth, msg): |
||||
self.send(channel, "%s: I'm here" % (nick,)) |
||||
|
||||
def send(self, channel, msg): |
||||
self.connection.privmsg(channel, msg) |
||||
time.sleep(ANTI_FLOOD_SLEEP) |
||||
|
||||
|
||||
def start(configpath): |
||||
config = configparser.RawConfigParser() |
||||
config.read(configpath) |
||||
|
||||
if config.has_option('ircbot', 'log_config'): |
||||
log_config = config.get('ircbot', 'log_config') |
||||
fp = os.path.expanduser(log_config) |
||||
if not os.path.exists(fp): |
||||
raise Exception("Unable to read logging config file at %s" % fp) |
||||
logging.config.fileConfig(fp) |
||||
else: |
||||
logging.basicConfig(level=logging.DEBUG) |
||||
|
||||
channels = ['#' + name.strip() for name in |
||||
config.get('ircbot', 'channels').split(',')] |
||||
|
||||
bot = PTGBot(config.get('ircbot', 'nick'), |
||||
config.get('ircbot', 'pass'), |
||||
config.get('ircbot', 'server'), |
||||
config.getint('ircbot', 'port'), |
||||
channels) |
||||
bot.start() |
||||
|
||||
|
||||
def main(): |
||||
parser = argparse.ArgumentParser(description='PTG bot.') |
||||
parser.add_argument('configfile', nargs=1, |
||||
help='specify the config file') |
||||
parser.add_argument('-d', dest='nodaemon', action='store_true', |
||||
help='do not run as a daemon') |
||||
args = parser.parse_args() |
||||
|
||||
if not args.nodaemon: |
||||
pid = pid_file_module.TimeoutPIDLockFile( |
||||
"/var/run/ptgbot/ptgbot.pid", 10) |
||||
with daemon.DaemonContext(pidfile=pid): |
||||
start(args.configfile) |
||||
start(args.configfile) |
||||
|
||||
|
||||
if __name__ == "__main__": |
||||
main() |
@ -0,0 +1,20 @@
|
||||
[metadata] |
||||
name = ptgbot |
||||
summary = OpenStack PTG Bot |
||||
description-file = |
||||
README.rst |
||||
author = OpenStack Infrastructure Team |
||||
author-email = openstack-infra@lists.openstack.org |
||||
home-page = https://git.openstack.org/cgit/openstack-infra/ptgbot |
||||
classifier = |
||||
Intended Audience :: Information Technology |
||||
Intended Audience :: System Administrators |
||||
License :: OSI Approved :: Apache Software License |
||||
Operating System :: POSIX :: Linux |
||||
Programming Language :: Python |
||||
Programming Language :: Python :: 3 |
||||
Programming Language :: Python :: 3.5 |
||||
|
||||
[entry_points] |
||||
console_scripts = |
||||
ptgbot = ptgbot.bot:main |
@ -0,0 +1,21 @@
|
||||
#!/usr/bin/env python |
||||
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. |
||||
# |
||||
# Licensed under the Apache License, Version 2.0 (the "License"); |
||||
# you may not use this file except in compliance with the License. |
||||
# You may obtain a copy of the License at |
||||
# |
||||
# http://www.apache.org/licenses/LICENSE-2.0 |
||||
# |
||||
# Unless required by applicable law or agreed to in writing, software |
||||
# distributed under the License is distributed on an "AS IS" BASIS, |
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
||||
# implied. |
||||
# See the License for the specific language governing permissions and |
||||
# limitations under the License. |
||||
|
||||
import setuptools |
||||
|
||||
setuptools.setup( |
||||
setup_requires=['pbr'], |
||||
pbr=True) |
@ -0,0 +1,25 @@
|
||||
[tox] |
||||
envlist = pep8,pyflakes |
||||
|
||||
[testenv] |
||||
setenv = VIRTUAL_ENV={envdir} |
||||
sitepackages=True |
||||
basepython = python3 |
||||
deps = -r{toxinidir}/requirements.txt |
||||
-r{toxinidir}/test-requirements.txt |
||||
commands = nosetests {posargs} |
||||
|
||||
[testenv:pep8] |
||||
commands = flake8 |
||||
|
||||
[testenv:pyflakes] |
||||
commands = flake8 |
||||
|
||||
[testenv:venv] |
||||
commands = {posargs} |
||||
|
||||
[flake8] |
||||
# E125 and H are intentionally ignored |
||||
ignore = E125,H |
||||
show-source = True |
||||
exclude = .venv,.tox,dist,doc,build,*.egg |
Loading…
Reference in new issue