critterchat 0.1.2__tar.gz

critterchat-0.1.2/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

critterchat-0.1.2/MANIFEST.in

@@ -0,0 +1,17 @@
+include critterchat/data/migrations/alembic.ini
+include critterchat/http/templates/*.html
+include critterchat/http/templates/account/*.html
+include critterchat/http/templates/home/*.html
+include critterchat/http/templates/login/*.html
+include critterchat/http/templates/modals/*.html
+include critterchat/http/static/*.otf
+include critterchat/http/static/*.ttf
+include critterchat/http/static/*.woff
+include critterchat/http/static/*.css
+include critterchat/http/static/*.js
+include critterchat/http/static/*.LICENSE.txt
+include critterchat/http/static/*.json
+include critterchat/http/static/*.png
+include critterchat/http/static/*.svg
+include critterchat/http/static/*.mp3
+graft critterchat/http/static/twemoji

critterchat-0.1.2/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: critterchat
+Version: 0.1.2
+Summary: CritterChat self-hosted web chat software.
+Author-email: DragonMinded <dragonminded@dragonminded.com>
+Maintainer-email: DragonMinded <dragonminded@dragonminded.com>
+License-Expression: Unlicense
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: wheel
+Requires-Dist: Flask
+Requires-Dist: Flask-SocketIO
+Requires-Dist: Flask-CORS
+Requires-Dist: gevent
+Requires-Dist: gevent-websocket
+Requires-Dist: PyYAML
+Requires-Dist: SQLAlchemy
+Requires-Dist: alembic
+Requires-Dist: mysqlclient
+Requires-Dist: emoji
+Requires-Dist: webcolors
+Requires-Dist: pillow
+Requires-Dist: requests
+Requires-Dist: pycryptodome
+Requires-Dist: libpass
+Requires-Dist: sqlalchemy-stubs
+Requires-Dist: sql-fragments
+Requires-Dist: python-dateutil
+Requires-Dist: pydub
+Requires-Dist: python-magic-standalone
+Dynamic: license-file
+
+# CritterChat
+
+A web-based chat program that you can host yourself, providing direct messaging,
+private group conversations and public rooms. Started as a middle finger to Discord
+and now evolving slowly into its own thing. CritterChat focuses on ease of
+experience over highly technical things like end-to-end encryption. As of right
+now instances are standalone but I would like to implement some sort of
+federation between instances that can be enabled or disabled per-instance.
+
+## Feature List
+
+ - Web frontend with both mobile and desktop support.
+ - Public rooms with optional auto-join for new members.
+ - Private group conversations with an invite system for adding members.
+ - Direct messages between members on the instance.
+ - Direct messages, private conversations and public rooms have an editable name and topic.
+ - Member profile support with ability to view other chatters' profiles.
+ - Custom emoji support controlled by the instance administrator.
+ - Message reactions, with custom emoji support and multiple reactions per message.
+ - Preferences for most appearance settings and optional notification sounds.
+ - Image, text and binary attachment support so attachments can be sent with messages.
+ - Ability to spoiler a message or an attachment, alt text for attachments.
+ - Various sign-up modes such as open registration, admin-approval and invite codes.
+ - Integration with Mastodon's OAuth for account creation and member authentication.
+ - Collects absolutely no personal information, contains no tracking code.
+ - Not built with, enabled by or integrated with any generative AI.
+
+## Wishlist
+
+ - Message editing.
+ - Message deleting.
+ - Reply to message.
+ - Now typing indicators.
+ - Read receipts.
+ - Pinned messages.
+ - Sticker support.
+ - Moderation tools for network admin (global mute, global ban, etc).
+ - Moderation tools for individuals (block user, allow direct messages, etc.).
+ - Emoji auto-categorization by prefix.
+ - Sitewide CSS themeing with CSS moved to themes directory.
+ - Per-chat CSS themeing for direct messages, private conversations and rooms.
+ - Ability to set a personal nickname for a user that only you can see in a direct message or private conversation.
+ - Port Myno's Pictochat over from PyStreaming, allow drawing and remixing.
+ - Link auto-sanitization to remove tracking info.
+ - Multi-account support in the web frontend.
+ - Inter-instance direct messages and private conversations, inter-instance OIDC-based authentication.
+ - REST API for bot integration, discord-compatible webhook support.
+ - Multi-language support with default language per-instance.
+
+## Needed Help
+
+If you're looking for something to contribute and something on this or the above
+list sparks your interest we would be very grateful for a contribution! Please
+get in touch so we can work out the direction you plan to take.
+
+ - Containerization and simplifying deployment/updates.
+ - UX design work and help with themes.
+ - Accessibility help, audits and fixes.
+ - Testing and support for non-standard browsers and operating systems.
+ - SVGs for graphics for default avatar/room pictures, iconography on the frontend.
+ - Documentation clarification or correction, both in code and related markdown files.
+ - User's guide and administrator's guide.
+ - Support for more attachment backends.
+ - Support for more authentication provider flows.
+ - Native clients for mobile or desktop operating systems.
+ - Changes that make custom integrations easier.
+ - Frontend translation support and translations to other languages.
+
+# Getting Started
+
+At minimum, you will need a modern version of Python. Recommended version is 3.12 or
+higher due to being tested only on this version, but some things in the repo also
+depend on at least Python 3.11. Optionally, you will need a MySQL database or compatible
+(MariaDB that is recent) that supports at least MySQL 5.7 features due to using the
+JSON column type. If you do not have or want a MySQL database you can instead use
+SQLite which comes built-in with Python. Finally, you will need ffmpeg installed for
+media conversion. For a production instance it is heavily recommended to use a
+production-ready webserver for SSL termination and static resources such as nginx.
+
+## Quick Start Guide
+
+If you are on a modern debian-based operating system, you can run the following
+commands in a terminal in order to get a basic version of CritterChat running in
+as little time as possible:
+
+```
+# Install necessary system dependencies for CritterChat
+sudo apt install python3 python3-dev python3-pip pkg-config \
+         libmysqlclient-dev build-essential npm git ffmpeg just
+
+# Check out CritterChat repo locally
+git clone https://github.com/DragonMinded/critterchat.git
+cd critterchat
+
+# Setup python dependencies for your local configuration
+just setup
+
+# Initialize local configuration
+just init
+just manage database create
+
+# Add a test user that you can use to log in with
+just manage user create -u test -p test
+
+# Add a test room that you will join when you log in
+just manage room create -n "Test Room" -a on
+
+# Run the frontend, which can be viewed at http://localhost:5678
+just run
+```
+
+Once you've run those steps, you can go to [http://localhost:5678/](http://localhost:5678)
+and login with username "test" and password "test" to start poking around.
+

critterchat-0.1.2/README.md

@@ -0,0 +1,114 @@
+# CritterChat
+
+A web-based chat program that you can host yourself, providing direct messaging,
+private group conversations and public rooms. Started as a middle finger to Discord
+and now evolving slowly into its own thing. CritterChat focuses on ease of
+experience over highly technical things like end-to-end encryption. As of right
+now instances are standalone but I would like to implement some sort of
+federation between instances that can be enabled or disabled per-instance.
+
+## Feature List
+
+ - Web frontend with both mobile and desktop support.
+ - Public rooms with optional auto-join for new members.
+ - Private group conversations with an invite system for adding members.
+ - Direct messages between members on the instance.
+ - Direct messages, private conversations and public rooms have an editable name and topic.
+ - Member profile support with ability to view other chatters' profiles.
+ - Custom emoji support controlled by the instance administrator.
+ - Message reactions, with custom emoji support and multiple reactions per message.
+ - Preferences for most appearance settings and optional notification sounds.
+ - Image, text and binary attachment support so attachments can be sent with messages.
+ - Ability to spoiler a message or an attachment, alt text for attachments.
+ - Various sign-up modes such as open registration, admin-approval and invite codes.
+ - Integration with Mastodon's OAuth for account creation and member authentication.
+ - Collects absolutely no personal information, contains no tracking code.
+ - Not built with, enabled by or integrated with any generative AI.
+
+## Wishlist
+
+ - Message editing.
+ - Message deleting.
+ - Reply to message.
+ - Now typing indicators.
+ - Read receipts.
+ - Pinned messages.
+ - Sticker support.
+ - Moderation tools for network admin (global mute, global ban, etc).
+ - Moderation tools for individuals (block user, allow direct messages, etc.).
+ - Emoji auto-categorization by prefix.
+ - Sitewide CSS themeing with CSS moved to themes directory.
+ - Per-chat CSS themeing for direct messages, private conversations and rooms.
+ - Ability to set a personal nickname for a user that only you can see in a direct message or private conversation.
+ - Port Myno's Pictochat over from PyStreaming, allow drawing and remixing.
+ - Link auto-sanitization to remove tracking info.
+ - Multi-account support in the web frontend.
+ - Inter-instance direct messages and private conversations, inter-instance OIDC-based authentication.
+ - REST API for bot integration, discord-compatible webhook support.
+ - Multi-language support with default language per-instance.
+
+## Needed Help
+
+If you're looking for something to contribute and something on this or the above
+list sparks your interest we would be very grateful for a contribution! Please
+get in touch so we can work out the direction you plan to take.
+
+ - Containerization and simplifying deployment/updates.
+ - UX design work and help with themes.
+ - Accessibility help, audits and fixes.
+ - Testing and support for non-standard browsers and operating systems.
+ - SVGs for graphics for default avatar/room pictures, iconography on the frontend.
+ - Documentation clarification or correction, both in code and related markdown files.
+ - User's guide and administrator's guide.
+ - Support for more attachment backends.
+ - Support for more authentication provider flows.
+ - Native clients for mobile or desktop operating systems.
+ - Changes that make custom integrations easier.
+ - Frontend translation support and translations to other languages.
+
+# Getting Started
+
+At minimum, you will need a modern version of Python. Recommended version is 3.12 or
+higher due to being tested only on this version, but some things in the repo also
+depend on at least Python 3.11. Optionally, you will need a MySQL database or compatible
+(MariaDB that is recent) that supports at least MySQL 5.7 features due to using the
+JSON column type. If you do not have or want a MySQL database you can instead use
+SQLite which comes built-in with Python. Finally, you will need ffmpeg installed for
+media conversion. For a production instance it is heavily recommended to use a
+production-ready webserver for SSL termination and static resources such as nginx.
+
+## Quick Start Guide
+
+If you are on a modern debian-based operating system, you can run the following
+commands in a terminal in order to get a basic version of CritterChat running in
+as little time as possible:
+
+```
+# Install necessary system dependencies for CritterChat
+sudo apt install python3 python3-dev python3-pip pkg-config \
+         libmysqlclient-dev build-essential npm git ffmpeg just
+
+# Check out CritterChat repo locally
+git clone https://github.com/DragonMinded/critterchat.git
+cd critterchat
+
+# Setup python dependencies for your local configuration
+just setup
+
+# Initialize local configuration
+just init
+just manage database create
+
+# Add a test user that you can use to log in with
+just manage user create -u test -p test
+
+# Add a test room that you will join when you log in
+just manage room create -n "Test Room" -a on
+
+# Run the frontend, which can be viewed at http://localhost:5678
+just run
+```
+
+Once you've run those steps, you can go to [http://localhost:5678/](http://localhost:5678)
+and login with username "test" and password "test" to start poking around.
+

critterchat-0.1.2/critterchat/__main__.py

@@ -0,0 +1,104 @@
+from gevent import monkey
+monkey.patch_all()
+
+import argparse  # noqa
+import logging  # noqa
+from flask.logging import default_handler  # noqa
+from gevent.ssl import Purpose, create_default_context  # noqa
+from werkzeug.middleware.proxy_fix import ProxyFix  # noqa
+
+from critterchat.http import app, config, socketio  # noqa
+
+from critterchat.config import Config, load_config  # noqa
+from critterchat.data import Data  # noqa
+from critterchat.service import AttachmentService, MessageService, UserService  # noqa
+
+# Since the sockets and REST files use decorators for hooking, simply importing these hooks the desired functions
+import critterchat.http.welcome  # noqa
+import critterchat.http.chat  # noqa
+import critterchat.http.account  # noqa
+import critterchat.http.upload  # noqa
+import critterchat.http.socket  # noqa
+
+# This is only hooked when local storage is enabled.
+from critterchat.http.attachments import attachments  # noqa
+
+
+logger = logging.getLogger(__name__)
+
+
+def perform_initialization_work(config: Config) -> None:
+    with Data.spawn(config) as data:
+        # Ensure that the default avatars are copied to the attachment storage system.
+        attachmentservice = AttachmentService(config, data)
+        logger.info("Creating any default attachments required.")
+        attachmentservice.create_default_attachments()
+        logger.info("Migrating any legacy attachments to current system.")
+        attachmentservice.migrate_legacy_attachments()
+
+        # Ensure that any nickname loopholes are fixed.
+        userservice = UserService(config, data)
+        logger.info("Migrating any legacy names to current rules.")
+        userservice.migrate_legacy_names()
+
+        # Ensure any per-room nicknames loopholes are fixed.
+        messageservice = MessageService(config, data)
+        logger.info("Migrating any per-room legacy names to current rules.")
+        messageservice.migrate_legacy_names()
+
+        logger.info("Done with initialization.")
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(description="Run the chat application backend.")
+    parser.add_argument("-p", "--port", help="Port to listen on. Defaults to 5678", type=int, default=5678)
+    parser.add_argument("-d", "--debug", help="Enable debug mode. Defaults to off", action="store_true")
+    parser.add_argument("-s", "--sql-query-log", help="Enable logging of SQL queries. Defaults to off", action="store_true")
+    parser.add_argument("-n", "--nginx-proxy", help="Number of nginx proxies in front of this server. Defaults to 0", type=int, default=0)
+    parser.add_argument("-c", "--config", help="Config file to parse for instance settings. Defaults to config.yaml", type=str, default="config.yaml")
+    parser.add_argument("-e", "--cert", help="Certificate fullchain to use when directly hosting SSL traffic", type=str, default=None)
+    parser.add_argument("-k", "--cert-key", help="Certificate key to use with the fullchain when directly hosting SSL traffic", type=str, default=None)
+    args = parser.parse_args()
+
+    load_config(args.config, config)
+    app.secret_key = config.cookie_key
+
+    root_logger = logging.getLogger()
+    while root_logger.hasHandlers():
+        root_logger.removeHandler(logger.handlers[0])
+    default_handler.setFormatter(
+        logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+    )
+    root_logger.addHandler(default_handler)
+    root_logger.setLevel(logging.DEBUG if args.debug else logging.INFO)
+
+    # Gevent's logger has the wrong IP and is messy, shut it up.
+    gevent_logger = logging.getLogger("geventwebsocket.handler")
+    gevent_logger.setLevel(logging.WARNING)
+
+    if args.sql_query_log:
+        logging.getLogger("sqlalchemy.engine").setLevel(logging.INFO)
+
+    # Attach local storage handler if we're local attachment type.
+    if config.attachments.system == "local":
+        app.register_blueprint(attachments)
+
+    # If we're directly serving SSL, set that up here.
+    extra_args: dict[str, object] = {}
+    if args.cert and args.cert_key:
+        ssl_context = create_default_context(Purpose.CLIENT_AUTH)
+        ssl_context.load_cert_chain(args.cert, args.cert_key)
+        extra_args['ssl_context'] = ssl_context
+
+    # Perform any one-time initialization that needs to happen.
+    perform_initialization_work(config)
+
+    if args.nginx_proxy > 0:
+        logger.info(f"Fixing proxy headers with a depth of {args.nginx_proxy}")
+        app.wsgi_app = ProxyFix(app.wsgi_app, x_host=args.nginx_proxy, x_proto=args.nginx_proxy, x_for=args.nginx_proxy, x_prefix=args.nginx_proxy)  # type: ignore
+    logger.info(f"Running server listening on port {args.port}")
+    socketio.run(app, host='0.0.0.0', port=args.port, debug=args.debug, **extra_args)
+
+
+if __name__ == '__main__':
+    main()

critterchat-0.1.2/critterchat/common/__init__.py

@@ -0,0 +1,18 @@
+from .aes import AESCipher
+from .text import convert_spaces, represents_real_text
+from .time import Time
+from .emoji import get_aliases_unicode_dict, emojize
+from .emojicategories import EMOJI_CATEGORIES
+from .enums import coerce_enum
+
+
+__all__ = [
+    "AESCipher",
+    "Time",
+    "get_aliases_unicode_dict",
+    "emojize",
+    "convert_spaces",
+    "represents_real_text",
+    "EMOJI_CATEGORIES",
+    "coerce_enum",
+]

critterchat-0.1.2/critterchat/common/aes.py

@@ -0,0 +1,38 @@
+import base64
+import hashlib
+from Crypto import Random
+from Crypto.Cipher import AES
+
+
+class AESCipher:
+    """
+    Simple AES cipher used to provide cookie support to the frontend.
+    """
+
+    def __init__(self, key: str) -> None:
+        self.__padamt = 16
+        self.__key = hashlib.sha256(key.encode("utf-8")).digest()
+
+    def _pad(self, s: str) -> str:
+        intermediate = f"{len(s)}.{s}"
+        while len(intermediate) % self.__padamt != 0:
+            intermediate = intermediate + "-"
+        return intermediate
+
+    def _unpad(self, s: str) -> str:
+        length, string = s.split(".", 1)
+        intlength = int(length)
+        return string[:intlength]
+
+    def encrypt(self, raw: str) -> str:
+        raw = self._pad(raw)
+        random = Random.new()
+        iv = random.read(AES.block_size)
+        cipher = AES.new(self.__key, AES.MODE_CBC, iv)
+        return base64.b64encode(iv + cipher.encrypt(raw.encode("utf-8")), altchars=b"._").decode("utf-8")
+
+    def decrypt(self, encoded: str) -> str:
+        enc = base64.b64decode(encoded.encode("utf-8"), altchars=b"._")
+        iv = enc[: AES.block_size]
+        cipher = AES.new(self.__key, AES.MODE_CBC, iv)
+        return self._unpad(cipher.decrypt(enc[AES.block_size:]).decode("utf-8"))

critterchat-0.1.2/critterchat/common/emoji.py

@@ -0,0 +1,94 @@
+import re
+from emoji import LANGUAGES, EMOJI_DATA, STATUS
+from typing import Match
+
+
+_EMOJI_UNICODE: dict[str, dict[str, str] | None] = {lang: None for lang in LANGUAGES}  # Cache for the language dicts
+_ALIASES_UNICODE: dict[str, str] = {}  # Cache for the aliases dict
+_BANNED_ALIASES: set[str] = {
+    ":egg2:",
+    ":cow2:",
+    ":point_up_2:",
+    ":cat2:",
+    ":dog2:",
+    ":mouse2:",
+    ":pencil2:",
+    ":pig2:",
+    ":rabbit2:",
+    ":tiger2:",
+    ":train2:",
+    ":whale2:",
+}  # Aliases that are pure duplicates that we don't want around.
+_RENAMED_ALIASES: dict[str, str] = {
+    ":emoji_modifier_fitzpatrick_type_1_2:": ":emoji_modifier_1_light_skin_tone:",
+    ":emoji_modifier_fitzpatrick_type_3:": ":emoji_modifier_2_medium-light_skin_tone:",
+    ":emoji_modifier_fitzpatrick_type_4:": ":emoji_modifier_3_medium_skin_tone:",
+    ":emoji_modifier_fitzpatrick_type_5:": ":emoji_modifier_4_medium-dark_skin_tone:",
+    ":emoji_modifier_fitzpatrick_type_6:": ":emoji_modifier_5_dark_skin_tone:",
+}  # Aliases that we want to rename for convenience.
+
+
+# Delimeters for regex.
+_DELIMITER = ':'
+_EMOJI_NAME_PATTERN = '\\w\\-&.’”“()!#*+,/«»\u0300\u0301\u0302\u0303\u0306\u0308\u030a\u0327\u064b\u064e\u064f\u0650\u0653\u0654\u3099\u30fb\u309a\u0655'
+_EMOJI_REGEX = re.compile(
+    f'({_DELIMITER}[{_EMOJI_NAME_PATTERN}]+{_DELIMITER})'
+)
+
+
+def _get_emoji_unicode_dict(lang: str) -> dict[str, str]:
+    """
+    Generate dict containing all fully-qualified and component emoji name for a language
+    The dict is only generated once per language and then cached in _EMOJI_UNICODE[lang]
+    """
+
+    if _EMOJI_UNICODE[lang] is None:
+        _EMOJI_UNICODE[lang] = {
+            data[lang]: emj for emj, data in EMOJI_DATA.items()
+            if lang in data and data['status'] <= STATUS['fully_qualified']
+        }
+
+    return _EMOJI_UNICODE[lang]  # type: ignore
+
+
+def get_aliases_unicode_dict() -> dict[str, str]:
+    """
+    Generate dict containing all fully-qualified and component aliases
+    The dict is only generated once and then cached in _ALIASES_UNICODE
+    """
+
+    if not _ALIASES_UNICODE:
+        _ALIASES_UNICODE.update(_get_emoji_unicode_dict('en'))
+        for emj, data in EMOJI_DATA.items():
+            if 'alias' in data and data['status'] <= STATUS['fully_qualified']:
+                for alias in data['alias']:
+                    if alias in _ALIASES_UNICODE:
+                        continue
+                    if alias in _BANNED_ALIASES:
+                        continue
+                    if alias in _RENAMED_ALIASES:
+                        alias = _RENAMED_ALIASES[alias]
+                    _ALIASES_UNICODE[alias] = emj
+
+        for off, val in enumerate(range(0x1F1E6, 0x1F200)):
+            ascval = chr(off + ord('a'))
+            _ALIASES_UNICODE[f":regional_indicator_{ascval}:"] = chr(val) + chr(0x200B)
+
+    return _ALIASES_UNICODE
+
+
+def emojize(msg: str) -> str:
+    """
+    Performs the same thing as emoji.emojize() but does not include banned aliases since it
+    instead uses the unicode dictionary from above. Allows us to sidestep the problem that
+    our frontend has one set of aliases (computed in get_aliases_unicode_dict) but using
+    emoji.emojize ends up using its own internal alias list.
+    """
+
+    aliases = get_aliases_unicode_dict()
+
+    def replace(match: Match[str]) -> str:
+        name_or_alias = match.group(1)
+        return aliases.get(name_or_alias, match.group(1))
+
+    return _EMOJI_REGEX.sub(replace, msg)