Merge remote-tracking branch 'upstream/python3.4' into python3.4

sary,
Updating RoboCop

Author: Foxlet

.gitattributes

@@ -1,2 +1,7 @@
-# Force LF on all files
+# default all files as text with lf
 * text eol=lf
+
+# mmdb files are binary
+*.mmdb binary
+
+

.travis.yml

@@ -0,0 +1,24 @@
+language: python
+python:
+  - "3.4"
+
+install:
+  - "sudo apt-get update -q"
+  - "sudo apt-get install -y python3-lxml"
+  - "pip install -r ./travis/requirements.txt"
+
+script:
+  - "python ./travis/test_json.py"
+  - "py.test . -v --cov . --cov-report term-missing"
+
+after_success:
+  - "coveralls"
+
+notifications:
+  irc:
+    channels:
+      - "irc.esper.net#cloudbot"
+    template:
+      - "%{repository}#%{build_number} (%{branch} - %{commit}) %{author}: %{message}"
+  on_failure: always
+  on_success: change

CONTRIBUTORS

@@ -1,23 +1,23 @@
-# CloudBot Refresh
+# CloudBot [![Build Status](https://travis-ci.org/CloudBotIRC/CloudBot.svg?branch=python3.4)](https://travis-ci.org/CloudBotIRC/CloudBot) [![Coverage Status](https://coveralls.io/repos/CloudBotIRC/CloudBot/badge.png?branch=python3.4)](https://coveralls.io/r/CloudBotIRC/CloudBot?branch=python3.4)
 
-CloudBotRefresh is the newest generation of CloudBot, the fun, fast, extendable Python IRC bot!
+CloudBot Refresh is the newest generation of CloudBot, the fun, fast, extendable Python IRC bot!
 
 ## Installing CloudBot
 
-Firstly, CloudBot will only run on **Python 3.4 or higher**. Because we use the asyncio module, you will not be able to use any other versions of Python. If you **really** want to run CloudBot on Python 2.x, you can find the old **unsupported** version of CloudBot at [this location](https://github.com/ClouDev/CloudBot).
+Firstly, CloudBot will only run on **Python 3.4 or higher**. Because we use the asyncio module, you will not be able to use any other versions of Python.
 
-To install CloudBotRefresh on *nix (linux, etc), see [docs/installing-unix.md](https://github.com/CloudBotIRC/CloudBotRefresh/blob/python3.4/docs/installing-unix.md)
+To install CloudBot on *nix (linux, etc), see [here](https://github.com/CloudBotIRC/CloudBot/wiki/Installing-on-*nix)
 
-To install CloudBotRefresh on Windows, see [docs/installing-windows.md](https://github.com/CloudBotIRC/CloudBotRefresh/blob/python3.4/docs/installing-windows.md)
+To install CloudBot on Windows, see [here](https://github.com/CloudBotIRC/CloudBot/wiki/Installing-on-Windows)
 
-If you're going to be actively developing on CloudBotRefresh, and submitting PRs back, we recommend running CloudBotRefresh inside Vagrant. This allows everyone to have an identical development environment.
+If you're going to be actively developing on CloudBot, and submitting PRs back, you can run CloudBot inside Vagrant. This allows everyone to have an identical development environment.
 
-To install CloudBotRefresh in Vagrant (both *Unix and Windows), see [docs/installing-vagrant.md](https://github.com/CloudBotIRC/CloudBotRefresh/blob/python3.4/docs/installing-vagrant.md)
+To install CloudBot in Vagrant (both *Unix and Windows), see [here](https://github.com/CloudBotIRC/CloudBot/wiki/Installing-with-Vagrant)
 
 
 ### Running CloudBot
 
-Before you run the bot, rename `config.default` to `config.json` and edit it with your preferred settings. You can check if your JSON is valid using [jsonlint.com](http://jsonlint.com/)!
+Before you run the bot, rename `config.default.json` to `config.json` and edit it with your preferred settings. You can check if your JSON is valid using [jsonlint.com](http://jsonlint.com/)!
 
 Once you have installed the required dependencies and renamed the config file, you can run the bot! Make sure you are in the correct folder and run the following command:
 
@@ -35,15 +35,12 @@ Specify the path as /path/to/repository/cloudbot/__main__.py, where `cloudbot` i
 
 ### Documentation
 
-To configure your CloudBot, visit the [Config Wiki Page](https://github.com/CloudBotIRC/CloudBotRefresh/wiki/Config).
+The CloudBot documentation is currently somewhat outdated and may not be correct. If you need any help, please visit our [IRC channel](irc://irc.esper.net/cloudbot) and we will be happy to assist you.
 
-To write your own modules, visit the [Module Wiki Page](https://github.com/CloudBotIRC/CloudBotRefresh/wiki/Writing-Refresh-Modules).
+To write your own plugins, visit the [Plugins Wiki Page](https://github.com/CloudBotIRC/CloudBotRefresh/wiki/Writing-Refresh-Modules).
 
 More at the [Wiki Main Page](https://github.com/CloudBotIRC/CloudBotRefresh/wiki).
 
-Note that the configuration page, and the main wiki page, are still for CloudBot Develop. The Module Wiki Page has been
-rewritten for refresh, but the other pages are outdated.
-
 ### Support
 
 The developers reside in [#CloudBot](irc://irc.esper.net/cloudbot) on [EsperNet](http://esper.net) and would be glad to help you.

README.md

@@ -57,7 +57,7 @@ def load_config(self):
             # if there is no config, show an error and die
             logger.critical("No config file found, bot shutting down!")
             print("No config file found! Bot shutting down in five seconds.")
-            print("Copy 'config.default' to 'config.json' for defaults.")
+            print("Copy 'config.default.json' to 'config.json' for defaults.")
             print("For help, see http://git.io/cloudbotirc. Thank you for using CloudBot!")
             time.sleep(5)
             sys.exit()

cloudbot/config.py

@@ -24,6 +24,18 @@
 }
 
 
+def decode(bytestring):
+    """
+    Tries to decode a bytestring using multiple encoding formats
+    """
+    for codec in ('utf-8', 'iso-8859-1', 'shift_jis', 'cp1252'):
+        try:
+            return bytestring.decode(codec)
+        except UnicodeDecodeError:
+            continue
+    return bytestring.decode('utf-8', errors='ignore')
+
+
 class IrcClient(Client):
     """
     An implementation of Client for IRC.
@@ -275,7 +287,7 @@ def data_received(self, data):
 
         while b"\r\n" in self._input_buffer:
             line_data, self._input_buffer = self._input_buffer.split(b"\r\n", 1)
-            line = line_data.decode()
+            line = decode(line_data)
 
             # parse the line into a message
             if line.startswith(":"):

cloudbot/irc/client.py

@@ -0,0 +1,186 @@
+"""
+colours.py by Zarthus <[email protected]>:
+Pretty colours, colours everywhere
+Parses colours using a $(colour) or $(formatting) template.
+Supports both the American and British spellings of many colours and words.
+
+This file is licenced under the MIT License (MIT)
+
+Copyright (c) 2014 - 2015 Zarthus [email protected]
+
+Permission is hereby granted, free of charge, toany person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+"""
+
+import re
+from random import randint
+
+
+IRC_COLOUR_DICT = {
+    "white": "00",
+    "black": "01",
+    "dblue": "02",
+    "dark_blue": "02",
+    "dark_green": "03",
+    "dgreen": "03",
+    "red": "04",
+    "dark_red": "05",
+    "dred": "05",
+    "brown": "05",  # Note: This appears to show up as brown for some clients, dark red for others.
+    "purple": "06",
+    "orange": "07",
+    "yellow": "08",
+    "green": "09",
+    "lime": "09",
+    "cyan": "10",
+    "teal": "11",
+    "blue": "12",
+    "pink": "13",
+    "dgrey": "14",
+    "dark_grey": "14",
+    "dgray": "14",
+    "dark_gray": "14",
+    "grey": "15",
+    "gray": "15",
+    "random": ""  # Special keyword, generate a random number.
+}
+
+IRC_FORMATTING_DICT = {
+    "colour": "\x03",
+    "color": "\x03",
+
+    "bold": "\x02",
+    "b": "\x02",
+
+    "underlined": "\x1F",
+    "underline": "\x1F",
+    "ul": "\x1F",
+
+    "italics": "\x1D",
+    "italic": "\x1D",
+    "i": "\x1D",
+
+    "reverse": "\x16",
+
+    "reset": "\x0F",
+    "clear": "\x0F"
+}
+
+
+COLOR_RE = re.compile(r"\$\(.*?\)", re.I)
+
+
+def get_color(colour, return_formatted=True):
+    """
+    Return numeric in string format of human readable colour formatting.
+    Set return_formatted to False to get just the numeric.
+    Throws KeyError if colour is not found.
+    """
+    colour = colour.lower()
+
+    if colour not in IRC_COLOUR_DICT:
+        raise KeyError("The colour '{}' is not in the list of available colours.".format(colour))
+
+    if colour == "random":  # Special keyword for a random colour
+        rand = randint(0, 15)
+        if rand < 10:  # Prepend '0' before colour so it always is double digits.
+            rand = "0" + str(rand)
+        rand = str(rand)
+
+        if return_formatted:
+            return get_format("colour") + rand
+        return rand
+
+    if return_formatted:
+        return get_format("colour") + IRC_COLOUR_DICT[colour]
+    return IRC_COLOUR_DICT[colour]
+
+
+def get_format(formatting):
+    """
+    Return hex-character in string format of human readable formatting.
+    Throws KeyError if formatting is not found.
+    """
+
+    if formatting.lower() not in IRC_FORMATTING_DICT:
+        raise KeyError("The formatting '{}' is not found in the list of available formats.".format(formatting))
+
+    return IRC_FORMATTING_DICT[formatting.lower()]
+
+
+def get_available_formats():
+    """List the formats you can use in self.getFormat in a comma separated list (string)"""
+
+    ret = ""
+    for formats in IRC_FORMATTING_DICT:
+        ret += formats + ", "
+
+    return ret[:-2]
+
+
+def get_available_colours():
+    """List the colours you can use in self.getColour in a comma separated list (string)"""
+
+    ret = ""
+    for colours in IRC_COLOUR_DICT:
+        ret += colours + ", "
+
+    return ret[:-2]
+
+
+def parse(string):
+    """
+    parse: Formats a string, replacing words wrapped in $( ) with actual colours or formatting.
+    example:
+    parse("The quick $(brown)brown$(clear) fox jumps over the$(bold) lazy dog$(clear).")
+    This method will not throw any KeyErrors, but will instead ignore input between $() if it doesn't know what to
+    replace it with.
+    """
+
+    formatted = string
+    regex = COLOR_RE.findall(string)
+    for match in regex:
+        formatted = formatted.replace(match, _convert(match), 1)
+    return formatted
+
+
+def strip(string):
+    """strip: Similiar to parse, only this removes colour codes"""
+
+    stripped = ""
+
+    regex = COLOR_RE.split(string)
+    for match in regex:
+        stripped += match
+
+    return stripped.strip()
+
+
+def _convert(string):
+    if not string.startswith("$(") and not string.endswith(")"):
+        return string
+    string = string[2:-1]
+    ret = ""
+    count = 1
+    formattings = string.lower().replace(" ", "").split(",")
+    for formatting in formattings:
+        if formatting in IRC_COLOUR_DICT:
+            if count % 2 == 0:
+                ret += "," + get_color(formatting, False)
+            else:
+                ret += get_color(formatting)
+            count += 1
+        elif formatting in IRC_FORMATTING_DICT:
+            ret += get_format(formatting)
+
+    return ret.strip()

cloudbot/util/colors.py

@@ -52,6 +52,7 @@
 are listed in the accompanying credits file.
 """
 
+
 traditional = [
     (1024 ** 5, 'P'),
     (1024 ** 4, 'T'),