switch from python2 to python3 + refactoring

This commit is contained in:
Romain H 2022-02-27 11:11:44 +01:00 committed by Romain Hv
parent 41fa28b2f6
commit d9894fbd87
4 changed files with 759 additions and 185 deletions

View File

@ -3,7 +3,7 @@ Welcome to the Redminebot install notes.
Steps: Steps:
0) Python 2 is required. 0) Python 3 is required.
1) git clone. 1) git clone.

2
README
View File

@ -5,5 +5,5 @@ Agirbot is based on Redminebot.
Agirbot is a free software by April. Agirbot is a free software by April.
Offical repository: https://agir.april.org/projects/admins/repository/agirbot Offical repository: https://forge.april.org/adminsys/agirbot

586
pylint.conf Normal file
View File

@ -0,0 +1,586 @@
[MASTER]
# A comma-separated list of package or module names from where C extensions may
# be loaded. Extensions are loading into the active Python interpreter and may
# run arbitrary code.
extension-pkg-whitelist=
# Add files or directories to the blacklist. They should be base names, not
# paths.
ignore=CVS
# Add files or directories matching the regex patterns to the blacklist. The
# regex matches against base names, not paths.
ignore-patterns=
# Python code to execute, usually for sys.path manipulation such as
# pygtk.require().
#init-hook=
# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
# number of processors available to use.
jobs=1
# Control the amount of potential inferred values when inferring a single
# object. This can help the performance when dealing with large functions or
# complex, nested conditions.
limit-inference-results=100
# List of plugins (as comma separated values of python module names) to load,
# usually to register additional checkers.
load-plugins=
# Pickle collected data for later comparisons.
persistent=yes
# Specify a configuration file.
#rcfile=
# When enabled, pylint would attempt to guess common misconfiguration and emit
# user-friendly hints instead of false-positive error messages.
suggestion-mode=yes
# Allow loading of arbitrary C extensions. Extensions are imported into the
# active Python interpreter and may run arbitrary code.
unsafe-load-any-extension=no
[MESSAGES CONTROL]
# Only show warnings with the listed confidence levels. Leave empty to show
# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
confidence=
# Disable the message, report, category or checker with the given id(s). You
# can either give multiple identifiers separated by comma (,) or put this
# option multiple times (only on the command line, not in the configuration
# file where it should appear only once). You can also use "--disable=all" to
# disable everything first and then reenable specific checks. For example, if
# you want to run only the similarities checker, you can use "--disable=all
# --enable=similarities". If you want to run only the classes checker, but have
# no Warning level messages displayed, use "--disable=all --enable=classes
# --disable=W".
disable=print-statement,
parameter-unpacking,
unpacking-in-except,
old-raise-syntax,
backtick,
long-suffix,
old-ne-operator,
old-octal-literal,
import-star-module-level,
non-ascii-bytes-literal,
raw-checker-failed,
bad-inline-option,
locally-disabled,
file-ignored,
suppressed-message,
useless-suppression,
deprecated-pragma,
use-symbolic-message-instead,
apply-builtin,
basestring-builtin,
buffer-builtin,
cmp-builtin,
coerce-builtin,
execfile-builtin,
file-builtin,
long-builtin,
raw_input-builtin,
reduce-builtin,
standarderror-builtin,
unicode-builtin,
xrange-builtin,
coerce-method,
delslice-method,
getslice-method,
setslice-method,
no-absolute-import,
old-division,
dict-iter-method,
dict-view-method,
next-method-called,
metaclass-assignment,
indexing-exception,
raising-string,
reload-builtin,
oct-method,
hex-method,
nonzero-method,
cmp-method,
input-builtin,
round-builtin,
intern-builtin,
unichr-builtin,
map-builtin-not-iterating,
zip-builtin-not-iterating,
range-builtin-not-iterating,
filter-builtin-not-iterating,
using-cmp-argument,
eq-without-hash,
div-method,
idiv-method,
rdiv-method,
exception-message-attribute,
invalid-str-codec,
sys-max-int,
bad-python3-import,
deprecated-string-function,
deprecated-str-translate-call,
deprecated-itertools-function,
deprecated-types-field,
next-method-defined,
dict-items-not-iterating,
dict-keys-not-iterating,
dict-values-not-iterating,
deprecated-operator-function,
deprecated-urllib-function,
xreadlines-attribute,
deprecated-sys-function,
exception-escape,
comprehension-escape,
missing-function-docstring,
missing-class-docstring,
missing-module-docstring,
too-few-public-methods,
broad-except
# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
# multiple time (only on the command line, not in the configuration file where
# it should appear only once). See also the "--disable" option for examples.
enable=c-extension-no-member
[REPORTS]
# Python expression which should return a score less than or equal to 10. You
# have access to the variables 'error', 'warning', 'refactor', and 'convention'
# which contain the number of messages in each category, as well as 'statement'
# which is the total number of statements analyzed. This score is used by the
# global evaluation report (RP0004).
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
# Template used to display messages. This is a python new-style format string
# used to format the message information. See doc for all details.
#msg-template=
# Set the output format. Available formats are text, parseable, colorized, json
# and msvs (visual studio). You can also give a reporter class, e.g.
# mypackage.mymodule.MyReporterClass.
output-format=text
# Tells whether to display a full report or only the messages.
reports=no
# Activate the evaluation score.
score=yes
[REFACTORING]
# Maximum number of nested blocks for function / method body
max-nested-blocks=5
# Complete name of functions that never returns. When checking for
# inconsistent-return-statements if a never returning function is called then
# it will be considered as an explicit return statement and no message will be
# printed.
never-returning-functions=sys.exit
[STRING]
# This flag controls whether the implicit-str-concat-in-sequence should
# generate a warning on implicit string concatenation in sequences defined over
# several lines.
check-str-concat-over-line-jumps=no
[LOGGING]
# Format style used to check logging format string. `old` means using %
# formatting, `new` is for `{}` formatting,and `fstr` is for f-strings.
logging-format-style=old
# Logging modules to check that the string format arguments are in logging
# function parameter format.
logging-modules=logging
[BASIC]
# Naming style matching correct argument names.
argument-naming-style=snake_case
# Regular expression matching correct argument names. Overrides argument-
# naming-style.
#argument-rgx=
# Naming style matching correct attribute names.
attr-naming-style=snake_case
# Regular expression matching correct attribute names. Overrides attr-naming-
# style.
#attr-rgx=
# Bad variable names which should always be refused, separated by a comma.
bad-names=foo,
bar,
baz,
toto,
tutu,
tata
# Naming style matching correct class attribute names.
class-attribute-naming-style=any
# Regular expression matching correct class attribute names. Overrides class-
# attribute-naming-style.
#class-attribute-rgx=
# Naming style matching correct class names.
class-naming-style=PascalCase
# Regular expression matching correct class names. Overrides class-naming-
# style.
#class-rgx=
# Naming style matching correct constant names.
const-naming-style=UPPER_CASE
# Regular expression matching correct constant names. Overrides const-naming-
# style.
#const-rgx=
# Minimum line length for functions/classes that require docstrings, shorter
# ones are exempt.
docstring-min-length=-1
# Naming style matching correct function names.
function-naming-style=snake_case
# Regular expression matching correct function names. Overrides function-
# naming-style.
#function-rgx=
# Good variable names which should always be accepted, separated by a comma.
good-names=i,
j,
k,
ex,
Run,
_
# Include a hint for the correct naming format with invalid-name.
include-naming-hint=no
# Naming style matching correct inline iteration names.
inlinevar-naming-style=any
# Regular expression matching correct inline iteration names. Overrides
# inlinevar-naming-style.
#inlinevar-rgx=
# Naming style matching correct method names.
method-naming-style=snake_case
# Regular expression matching correct method names. Overrides method-naming-
# style.
#method-rgx=
# Naming style matching correct module names.
module-naming-style=snake_case
# Regular expression matching correct module names. Overrides module-naming-
# style.
#module-rgx=
# Colon-delimited sets of names that determine each other's naming style when
# the name regexes allow several styles.
name-group=
# Regular expression which should only match function or class names that do
# not require a docstring.
no-docstring-rgx=^_
# List of decorators that produce properties, such as abc.abstractproperty. Add
# to this list to register other decorators that produce valid properties.
# These decorators are taken in consideration only for invalid-name.
property-classes=abc.abstractproperty
# Naming style matching correct variable names.
variable-naming-style=snake_case
# Regular expression matching correct variable names. Overrides variable-
# naming-style.
#variable-rgx=
[VARIABLES]
# List of additional names supposed to be defined in builtins. Remember that
# you should avoid defining new builtins when possible.
additional-builtins=
# Tells whether unused global variables should be treated as a violation.
allow-global-unused-variables=yes
# List of strings which can identify a callback function by name. A callback
# name must start or end with one of those strings.
callbacks=cb_,
_cb
# A regular expression matching the name of dummy variables (i.e. expected to
# not be used).
dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
# Argument names that match this expression will be ignored. Default to name
# with leading underscore.
ignored-argument-names=_.*|^ignored_|^unused_
# Tells whether we should check for unused import in __init__ files.
init-import=no
# List of qualified module names which can have objects that can redefine
# builtins.
redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
[TYPECHECK]
# List of decorators that produce context managers, such as
# contextlib.contextmanager. Add to this list to register other decorators that
# produce valid context managers.
contextmanager-decorators=contextlib.contextmanager
# List of members which are set dynamically and missed by pylint inference
# system, and so shouldn't trigger E1101 when accessed. Python regular
# expressions are accepted.
generated-members=
# Tells whether missing members accessed in mixin class should be ignored. A
# mixin class is detected if its name ends with "mixin" (case insensitive).
ignore-mixin-members=yes
# Tells whether to warn about missing members when the owner of the attribute
# is inferred to be None.
ignore-none=yes
# This flag controls whether pylint should warn about no-member and similar
# checks whenever an opaque object is returned when inferring. The inference
# can return multiple potential results while evaluating a Python object, but
# some branches might not be evaluated, which results in partial inference. In
# that case, it might be useful to still emit no-member and other checks for
# the rest of the inferred objects.
ignore-on-opaque-inference=yes
# List of class names for which member attributes should not be checked (useful
# for classes with dynamically set attributes). This supports the use of
# qualified names.
ignored-classes=optparse.Values,thread._local,_thread._local
# List of module names for which member attributes should not be checked
# (useful for modules/projects where namespaces are manipulated during runtime
# and thus existing member attributes cannot be deduced by static analysis). It
# supports qualified module names, as well as Unix pattern matching.
ignored-modules=
# Show a hint with possible names when a member name was not found. The aspect
# of finding the hint is based on edit distance.
missing-member-hint=yes
# The minimum edit distance a name should have in order to be considered a
# similar match for a missing member name.
missing-member-hint-distance=1
# The total number of similar names that should be taken in consideration when
# showing a hint for a missing member.
missing-member-max-choices=1
# List of decorators that change the signature of a decorated function.
signature-mutators=
[SPELLING]
# Limits count of emitted suggestions for spelling mistakes.
max-spelling-suggestions=4
# Spelling dictionary name. Available dictionaries: none. To make it work,
# install the python-enchant package.
spelling-dict=
# List of comma separated words that should not be checked.
spelling-ignore-words=
# A path to a file that contains the private dictionary; one word per line.
spelling-private-dict-file=
# Tells whether to store unknown words to the private dictionary (see the
# --spelling-private-dict-file option) instead of raising a message.
spelling-store-unknown-words=no
[MISCELLANEOUS]
# List of note tags to take in consideration, separated by a comma.
notes=FIXME,
XXX,
TODO
[SIMILARITIES]
# Ignore comments when computing similarities.
ignore-comments=yes
# Ignore docstrings when computing similarities.
ignore-docstrings=yes
# Ignore imports when computing similarities.
ignore-imports=no
# Minimum lines number of a similarity.
min-similarity-lines=4
[FORMAT]
# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
expected-line-ending-format=
# Regexp for a line that is allowed to be longer than the limit.
ignore-long-lines=^\s*(# )?<?https?://\S+>?$
# Number of spaces of indent required inside a hanging or continued line.
indent-after-paren=4
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
# tab).
indent-string=' '
# Maximum number of characters on a single line.
max-line-length=120
# Maximum number of lines in a module.
max-module-lines=1000
# List of optional constructs for which whitespace checking is disabled. `dict-
# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
# `trailing-comma` allows a space between comma and closing bracket: (a, ).
# `empty-line` allows space-only lines.
no-space-check=trailing-comma,
dict-separator
# Allow the body of a class to be on the same line as the declaration if body
# contains single statement.
single-line-class-stmt=no
# Allow the body of an if to be on the same line as the test if there is no
# else.
single-line-if-stmt=no
[IMPORTS]
# List of modules that can be imported at any level, not just the top level
# one.
allow-any-import-level=
# Allow wildcard imports from modules that define __all__.
allow-wildcard-with-all=no
# Analyse import fallback blocks. This can be used to support both Python 2 and
# 3 compatible code, which means that the block might have code that exists
# only in one or another interpreter, leading to false positives when analysed.
analyse-fallback-blocks=no
# Deprecated modules which should not be used, separated by a comma.
deprecated-modules=optparse,tkinter.tix
# Create a graph of external dependencies in the given file (report RP0402 must
# not be disabled).
ext-import-graph=
# Create a graph of every (i.e. internal and external) dependencies in the
# given file (report RP0402 must not be disabled).
import-graph=
# Create a graph of internal dependencies in the given file (report RP0402 must
# not be disabled).
int-import-graph=
# Force import order to recognize a module as part of the standard
# compatibility libraries.
known-standard-library=
# Force import order to recognize a module as part of a third party library.
known-third-party=enchant
# Couples of modules and preferred modules, separated by a comma.
preferred-modules=
[DESIGN]
# Maximum number of arguments for function / method.
max-args=5
# Maximum number of attributes for a class (see R0902).
max-attributes=7
# Maximum number of boolean expressions in an if statement (see R0916).
max-bool-expr=5
# Maximum number of branch for function / method body.
max-branches=12
# Maximum number of locals for function / method body.
max-locals=15
# Maximum number of parents for a class (see R0901).
max-parents=7
# Maximum number of public methods for a class (see R0904).
max-public-methods=20
# Maximum number of return / yield for function / method body.
max-returns=6
# Maximum number of statements in function / method body.
max-statements=50
# Minimum number of public methods for a class (see R0903).
min-public-methods=2
[CLASSES]
# List of method names used to declare (i.e. assign) instance attributes.
defining-attr-methods=__init__,
__new__,
setUp,
__post_init__
# List of member names, which should be excluded from the protected access
# warning.
exclude-protected=_asdict,
_fields,
_replace,
_source,
_make
# List of valid names for the first argument in a class method.
valid-classmethod-first-arg=cls
# List of valid names for the first argument in a metaclass class method.
valid-metaclass-classmethod-first-arg=cls
[EXCEPTIONS]
# Exceptions that will emit a warning when being caught. Defaults to
# "BaseException, Exception".
overgeneral-exceptions=BaseException,
Exception

View File

@ -1,254 +1,242 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# -*- coding: utf-8 -1 -*-
# Need: python3-iso8601 python3-feedparser import socket
import sys
# Import some necessary libraries. import re
import socket, sys, time, csv, queue, random, re, pdb, select, os.path, datetime import select
from threading import Thread import os.path
import feedparser
import xml.dom.minidom
from time import mktime, localtime
import iso8601
import configparser import configparser
from datetime import datetime, timedelta, timezone
from typing import Generator
import feedparser
# Help configuration. # Help configuration.
help_list = ["help", "faq", "aide"] HELP_LIST = ["help", "faq", "aide"]
hello_list = ["hello", "yo", "bonjour", "salut"] HELLO_LIST = ["hello", "yo", "bonjour", "salut"]
# Load configuration. # Load configuration.
configurationFilename = "/etc/redminebot/redminebot.conf" CONFIG_FILENAME = "/etc/redminebot/redminebot.conf"
if len(sys.argv) == 2: if len(sys.argv) == 2:
configurationFilename = sys.argv[1] CONFIG_FILENAME = sys.argv[1]
if os.path.isfile(configurationFilename): if os.path.isfile(CONFIG_FILENAME):
print("Using configuration file: " + configurationFilename) print(f"Using configuration file: {CONFIG_FILENAME}")
config = configparser.RawConfigParser() CONFIG = configparser.ConfigParser()
config.read(configurationFilename) CONFIG.read(CONFIG_FILENAME)
default_server = config.get("IRCSection", "irc.server") DEFAULT_SERVER = CONFIG.get("IRCSection", "irc.server")
default_nickname = config.get("IRCSection", "irc.nickname") DEFAULT_NICKNAME = CONFIG.get("IRCSection", "irc.nickname")
registered = config.get("IRCSection", "irc.registered") REGISTERED = CONFIG.get("IRCSection", "irc.registered")
password = config.get("IRCSection", "irc.password") PASSWORD = CONFIG.get("IRCSection", "irc.password")
projectId1 = config.get("IRCSection", "irc.projects.1.id") PROJECT_ID_1 = CONFIG.get("IRCSection", "irc.projects.1.id")
projectChannel1 = config.get("IRCSection", "irc.projects.1.channel") PROJECT_CHANNEL_1 = CONFIG.get("IRCSection", "irc.projects.1.channel")
projectId2 = config.get("IRCSection", "irc.projects.2.id") PROJECT_ID_2 = CONFIG.get("IRCSection", "irc.projects.2.id")
projectChannel2 = config.get("IRCSection", "irc.projects.2.channel") PROJECT_CHANNEL_2 = CONFIG.get("IRCSection", "irc.projects.2.channel")
projectId3 = config.get("IRCSection", "irc.projects.3.id") PROJECT_ID_3 = CONFIG.get("IRCSection", "irc.projects.3.id")
projectChannel3 = config.get("IRCSection", "irc.projects.3.channel") PROJECT_CHANNEL_3 = CONFIG.get("IRCSection", "irc.projects.3.channel")
else: else:
print("Missing configuration file.") print("Missing configuration file.")
sys.exit() sys.exit()
######################### class Project:
### Class Definitions ###
#########################
def __init__(self, project: str, channel: str):
class Project(object):
def __init__(self, project, channel):
self.name = project self.name = project
self.channel = channel self.channel = channel
self.redmine_next = datetime.datetime.utcnow() self.redmine_next = datetime.now(tz=timezone.utc)
self.redmine_latest = datetime.datetime.utcnow() self.redmine_latest = datetime.now(tz=timezone.utc)
def set_ircsock(self, ircsock): def redmine(self) -> Generator[str, None, None]:
self.ircsock = ircsock now = datetime.now(tz=timezone.utc)
if now < self.redmine_next:
return
def redmine(self):
t = datetime.datetime.utcnow()
# print ("Running: %s (%s) for %s" % ( t, self.redmine_next, self.channel ))
if t >= self.redmine_next:
latest_new = self.redmine_latest latest_new = self.redmine_latest
self.redmine_next = self.redmine_next + timedelta(seconds=10)
self.redmine_next = self.redmine_next + datetime.timedelta(seconds=10) redmine = feedparser.parse(f"http://agir.april.org/projects/{self.name}/activity.atom?show_issues=1")
redmine = feedparser.parse(
"http://agir.april.org/projects/%s/activity.atom?show_issues=1"
% self.name
)
for i in reversed(range(len(redmine.entries))): for i in reversed(range(len(redmine.entries))):
e = redmine.entries[i] redmine_entry = redmine.entries[i]
et = e.updated_parsed entry_updated = parse_redmine_datetime(redmine_entry.updated)
td = iso8601.parse_date(e.updated)
if td.replace(tzinfo=None) > self.redmine_latest: if entry_updated > self.redmine_latest:
msg = "Redmine: (%s): %s" % (e.link, e.title) yield f"Redmine: ({redmine_entry.link}): {redmine_entry.title}"
self.ircsock.send(
"PRIVMSG {0} :{1}\n".format(
self.channel, msg.encode("utf-8", "ignore")
).encode()
)
# find the new latest time # find the new latest time
if td.replace(tzinfo=None) > latest_new: if entry_updated > latest_new:
latest_new = td.replace(tzinfo=None) latest_new = entry_updated
self.redmine_latest = latest_new self.redmine_latest = latest_new
# Defines a bot def generate_command_regex(options):
class Bot(object):
def __init__(self, server, botnick):
self.botnick = botnick
self.hello_regex = re.compile(self.get_regex(hello_list), re.I)
self.help_regex = re.compile(self.get_regex(help_list), re.I)
self.server = server
self.projects = []
def connect(self):
self.ircsock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.ircsock.connect((self.server, 6667))
self.ircsock.send(
"USER {0} {0} {0} :Robot Agir April" ".\n".format(self.botnick).encode()
) # bot authentication
self.ircsock.send(
"NICK {}\n".format(self.botnick).encode()
) # Assign the nick to the bot.
if not password.strip() and registered == True:
print("PRIVMSG {} {} {}".format("NickServ", "IDENTIFY", password))
self.ircsock.send(
"PRIVMSG {} :{} {} {}".format(
"NickServ", "IDENTIFY", self.botnick, password
).encode()
)
def add_project(self, project):
project.set_ircsock(self.ircsock)
self.ircsock.send("JOIN {} \n".format(project.channel).encode()) # Joins channel
self.projects.append(project)
def get_project(self, name):
for project in self.projects:
if name[0] != "#" and project.name == name:
return project
elif name[0] == "#" and project.channel == name:
return project
# Main loop
def loop(self):
last_read = datetime.datetime.utcnow()
while 1: # Loop forever
ready_to_read, b, c = select.select([self.ircsock], [], [], 1)
if ready_to_read:
last_read = datetime.datetime.utcnow()
ircmsg = self.msg_handler()
ircmsg, actor, channel = self.parse_messages(ircmsg)
if ircmsg is not None:
self.message_response(ircmsg, actor, channel)
if datetime.datetime.utcnow() - last_read > datetime.timedelta(minutes=10):
raise Exception("timeout: nothing to read on socket since 10 minutes")
# Responds to server Pings.
def pong(self, ircmsg):
response = "PONG :" + ircmsg.split("PING :")[1] + "\n"
self.ircsock.send(response.encode())
self._redmine()
def _redmine(self):
for project in self.projects:
project.redmine()
# Parses messages and responds to them appropriately.
def message_response(self, ircmsg, actor, channel):
# If someone talks to (or refers to) the bot.
if (
(":!" in ircmsg or self.botnick.lower() in ircmsg.lower())
and actor != self.botnick
and "PRIVMSG".lower() in ircmsg.lower()
):
if self.hello_regex.search(ircmsg):
self.bot_hello(channel, "Yo!")
if self.help_regex.search(ircmsg):
self.bot_help(channel)
if "refresh" in ircmsg.lower():
self.ircsock.send(
"PRIVMSG {} :Raffraîchissement en cours\n".format(channel).encode()
)
project = self.get_project(channel)
if project:
project.redmine()
self.ircsock.send("PRIVMSG {} :Fait !\n".format(channel).encode())
# If the server pings us then we've got to respond!
if ircmsg.find("PING :") != -1:
self.pong(ircmsg)
# Responds to a user that inputs "Hello Mybot".
def bot_hello(self, channel, greeting):
self.ircsock.send("PRIVMSG {0} :{1}\n".format(channel, greeting).encode())
# Explains what the bot is when queried.
def bot_help(self, channel):
self.ircsock.send(
"PRIVMSG {} :Bonjour, je suis un bot qui reconnaît les options !help, !refresh et !bonjour\n".format(
channel
).encode()
)
self.ircsock.send(
"PRIVMSG {} :Périodiquement, je vais afficher les actualités de http://agir.april.org/projects/{}.\n".format(
channel, self.get_project(channel).name
).encode()
)
# Reads the messages from the server and adds them to the queue and prints
# them to the console. This function will be run in a thread, see below.
def msg_handler(
self,
): # pragma: no cover (this excludes this function from testing)
new_msg = self.ircsock.recv(2048) # receive data from the server
if not new_msg:
print("Empty recv. It seems Ive lost my mind. I stop to be reborn.", new_msg)
#sys.exit(7)
time.sleep(1)
else:
new_msg = new_msg.strip("\n\r".encode()) # removing any unnecessary linebreaks
if new_msg != "" and new_msg.find("PING :".encode()) == -1:
print(datetime.datetime.now().isoformat() + " " + new_msg.decode())
return new_msg
# Checks for messages.
def parse_messages(self, ircmsg):
try:
actor = ircmsg.split(":")[1].split("!")[0]
try:
target = ircmsg.split(":")[1].split(" ")[2]
except:
target = None
return " ".join(ircmsg.split()), actor, target
except:
# print ("Wrong message:", ircmsg)
return None, None, None
# Compile regex
def get_regex(self, options):
pattern = "(" pattern = "("
for s in options: for option in options:
pattern += s pattern += option
pattern += "|" pattern += '|'
pattern = pattern[:-1] pattern = pattern[:-1]
pattern += ")" pattern += ")"
return pattern return pattern
########################## def parse_irc_messages(irc_msg):
### The main function. ### try:
########################## actor = irc_msg.split(":")[1].split("!")[0]
try:
target = irc_msg.split(":")[1].split(" ")[2]
except Exception as exc:
print("Exception raised to irc message parsing:")
print(exc)
target = None
return " ".join(irc_msg.split()), actor, target
except Exception as exc:
print("Exception raised to irc message parsing:")
print(exc)
return None, None, None
def parse_redmine_datetime(redmine_date: str) -> datetime:
date_with_iso_tz = redmine_date[:-1] + '+00:00'
return datetime.fromisoformat(date_with_iso_tz)
class Bot:
def __init__(self, server, bot_nick):
self.bot_nick = bot_nick
self.hello_regex = re.compile(generate_command_regex(HELLO_LIST), re.I)
self.help_regex = re.compile(generate_command_regex(HELP_LIST), re.I)
self.server = server
self.projects = []
self.irc_socket = None
def send(self, msg: str):
self.irc_socket.send(msg.encode("utf-8", "ignore"))
def connect(self):
self.irc_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
self.irc_socket.connect((self.server, 6667))
self.send(f"USER {self.bot_nick} {self.bot_nick} {self.bot_nick} :Robot Agir April"
".\n") # bot authentication
self.send(f"NICK {self.bot_nick}\n") # Assign the nick to the bot.
if not PASSWORD.strip() and REGISTERED is True:
self.send("PRIVMSG NickServ :IDENTIFY {self.botnick} {password}")
def add_project(self, project):
self.send("JOIN {} \n".format(project.channel)) # Joins channel
self.projects.append(project)
def get_project(self, name):
for project in self.projects:
if name[0] != '#' and project.name == name:
return project
if name[0] == '#' and project.channel == name:
return project
return None
# Main loop
def loop(self):
last_read = datetime.utcnow()
while True: # Loop forever
ready_to_read, _fd2, _fd3 = select.select([self.irc_socket], [], [], 1)
if ready_to_read:
last_read = datetime.utcnow()
irc_msg = self.msg_handler()
irc_msg, actor, channel = parse_irc_messages(irc_msg)
if irc_msg is not None:
self.message_response(irc_msg, actor, channel)
if datetime.utcnow() - last_read > timedelta(minutes=10):
raise Exception('timeout: nothing to read on socket since 10 minutes')
# Responds to server Pings.
def pong(self, irc_msg):
response = f"PONG :{irc_msg.split('PING :')[1]}\n"
self.send(response)
self._check_global_updates()
def _check_global_updates(self):
print('Checking projects updates....')
for project in self.projects:
for message in project.redmine():
self.send(f"PRIVMSG {project.channel} :{message}\n")
def _check_project_updates(self, channel_name: str):
print('Checking projects updates....')
project = self.get_project(channel_name)
if not project:
print(f'Cannot find project for channel {channel_name}')
return
for message in project.redmine():
self.send(f"PRIVMSG {project.channel} :{message}\n")
# Parses messages and responds to them appropriately.
def message_response(self, irc_msg, actor, channel):
# If someone talks to (or refers to) the bot.
if (':!' in irc_msg or self.bot_nick.lower() in irc_msg.lower()) and \
actor != self.bot_nick and \
"PRIVMSG".lower() in irc_msg.lower():
if self.hello_regex.search(irc_msg):
self.bot_hello(channel, 'Yo!')
if self.help_regex.search(irc_msg):
self.bot_help(channel)
if 'refresh' in irc_msg.lower():
self.send(f"PRIVMSG {channel} :Raffraîchissement en cours\n")
self._check_project_updates(channel)
self.send(f"PRIVMSG {channel} :Fait !\n")
# If the server pings us then we've got to respond!
if irc_msg.find("PING :") != -1:
self.pong(irc_msg)
# Responds to a user that inputs "Hello Mybot".
def bot_hello(self, channel, greeting):
self.send(f"PRIVMSG {channel} :{greeting}\n")
# Explains what the bot is when queried.
def bot_help(self, channel):
self.send(f"PRIVMSG {channel} :Bonjour, je suis un bot qui reconnaît les options !help, !refresh et !bonjour\n")
project_name = self.get_project(channel).name
self.send(f"PRIVMSG {channel} :Périodiquement, je vais afficher les actualités de "
f"http://agir.april.org/projects/{project_name}.\n")
# Reads the messages from the server and adds them to the Queue and prints
# them to the console. This function will be run in a thread, see below.
def msg_handler(self): # pragma: no cover (this excludes this function from testing)
new_msg = self.irc_socket.recv(2048) # receive data from the server
if not new_msg:
print("Empty recv. It seems Ive lost my mind. I stop to be reborn.")
sys.exit(7)
else:
new_msg = new_msg.decode("utf-8").strip('\n\r') # removing any unnecessary linebreaks
if new_msg != '' and new_msg.find("PING :") == -1:
print(datetime.now().isoformat() + " " + new_msg)
return new_msg
def main(): def main():
print(datetime.datetime.now().isoformat() + " redmine bot starting…") print(datetime.now().isoformat() + " redmine bot starting…")
redmine_bot = Bot(default_server, default_nickname) redmine_bot = Bot(DEFAULT_SERVER, DEFAULT_NICKNAME)
redmine_bot.connect() redmine_bot.connect()
if projectId1 and projectChannel1: if PROJECT_ID_1 and PROJECT_CHANNEL_1:
redmine_bot.add_project(Project(projectId1, projectChannel1)) redmine_bot.add_project(Project(PROJECT_ID_1, PROJECT_CHANNEL_1))
if projectId2 and projectChannel2: if PROJECT_ID_2 and PROJECT_CHANNEL_2:
redmine_bot.add_project(Project(projectId2, projectChannel2)) redmine_bot.add_project(Project(PROJECT_ID_2, PROJECT_CHANNEL_2))
if projectId3 and projectChannel3: if PROJECT_ID_3 and PROJECT_CHANNEL_3:
redmine_bot.add_project(Project(projectId3, projectChannel3)) redmine_bot.add_project(Project(PROJECT_ID_3, PROJECT_CHANNEL_3))
return redmine_bot.loop() return redmine_bot.loop()