max/chookchat
max/chookchat
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

Compare commits

base: max:main
Branches Tags
max:main
max:0.1.0
max:0.0.2
max:0.0.1
..
compare: max:0.0.1
Branches Tags
max:main
max:0.1.0
max:0.0.2
max:0.0.1

No commits in common. "main" and "0.0.1" have entirely different histories.
main ... 0.0.1

32 changed files with 560 additions and 2150 deletions
Show Stats Expand all files Collapse all files

5
.gitignore vendored
View File

@ -2,7 +2,8 @@
.swp .swp
server/build server/build
server/.gradle server/.gradle
server/uploads
server/userDatabase server/userDatabase
server/chatHistory server/chatHistory
server/roomChats client-cli/build
client-cli/.gradle
client-cli/.chookpen.profile

98
README.md
View File

@ -1,31 +1,97 @@
# Chookchat - A simple messaging service # Chookpen - A simple messaging service
## What is Chookchat? ## What is Chookpen?
Chookchat is a lightweight, secure-ish chat server implementation focused on simplicity and real-time communication. It features user authentication, persistent message history and real-time updates via WebSockets. It uses very little resources on a system, often using a maximum of 20mb. Chookpen is BETA SOFTWARE, and MAY BE BUGGY! Don't expect too much. Chookpen is a simple messaging service which allows users to talk to each other through text chat. In it's current state it has very low security and has many bugs, so please don't use this in production yet.
## A guide to this repository ## How does Chookpen work?
Chookpen is split up into multiple parts, the server and different reference clients for different platforms. For extensive documentation of all parts of Chookpen, a repository wiki is being worked on which will be released soon. For now, if you want to learn more about Chookpen, visit each folder. Chookpen works by having a client and a server. The client sends a request to the server, which includes a username, hashed password and message contents. The server returns that request with previous messages.
## Acknowledgments ## How do I get started?
Chookpen relies on a lot of FOSS software, and wouldn't be possible without it! Here's some quick links to the original projects if you're interested: First, you'll need to install Gradle and Java version 17 or later. These instructions vary depending on your OS, so look those up.
### [Javalin](https://javalin.io) Next, clone the repository with `git clone https://git.maxwellj.xyz/max/chookpen`. Change to the `server` directory. Create the files `chatHistory` and `userDatabase`. Next, open a terminal and `gradle run`. Once the server starts, you can now send requests to the server! Using a web browser or `curl`, whichever is preferable, make a request to `http://localhost:8000/api/createAccount/username:{(pick a username)}token:{(pick a token)}`. If all works, you should have created an account!
An easy to use web server for Kotlin and Java. Chookpen wouldn't be possible without it! Once you've created an account through the API, you can send requests using your token and username. You can send a request to see the chat history like this: `http://localhost:8000/api/username:{(your username)}token:{(your password)}`. If you'd like to send a message, it's like this: `http://localhost:8000/api/username:{(your username)}token:{(your password)}message:{(a message)}`.
### [Gradle](https://gradle.org) If you don't want all the hassle of sending requests, you can use the experimental CLI client. Open a new terminal, and cd to `client-cli`. Run `gradle installDist`, and wait for it to build. Cd to build/install. Make a file called `.chookpen.profile` in your home directory and add the following information, styled like a Unix /etc/passwd (colons in between items):
The build tool for compiling Chookpen. It just works! `username:password:server:port:0`
### [Kotlin](https://kotlinlang.org) NOTE: When creating your account with this method, use the MD5 hash of your password. If you're unsure of what it is, just fill in all your details in .chookpen.profile and run the program. The server will tell you the hash the CLI created.
The language Chookpen is coded in. How else does it work? Once you're set up, run the CLI program in bin. Use the .bat if you're on Windows (yucky). You should be able to send and recieve messages! If that isn't working, make sure your .chookpen.profile is in your system home directory.
### [OpenJDK](https://openjdk.org) ## How can I make my own client?
The best way to run Chookpen. Free and open source! Chookpen is very simple in how it works at present. There's only one chat on each server, and messages are sent as plaintext (unless you put your server behind a reverse proxy like Caddy). You can send a request to create an account, get messages or send a message.
There's also all the other various libraries I use (and these other libraries use) so check the code for those! ### Brief API documentation for the server
#### Create account
**Usage**
`http://(address:port)/api/createAccount/username:{(username)}token:{(password-hash)}`
**Successful response**
`Success`
**Unsuccessful responses**
`Username already exists` - Choose a new username
`No username` - Add a username
`No token` - Add a token
#### Send a message
**Usage**
`http://(address:port)/api/send/username:{(username)}token:{(password-hash)}message:{(message to send)}`
**Successful response**
`Success`
**Unsuccessful responses**
`Unknown account` - Either you don't have an account or your username is wrong
`Invalid token` - Password is wrong
`No data provided` - Add a message
#### Get messages
**Usage**
`http://(address:port)/api/syncmessages/username:{(username)}token:{(password-hash)}`
**Successful response**
A successful response should contain everything in `chatHistory` in the directory you run the server in.
**Unsuccessful responses**
`Unknown account` - Either you don't have an account or your username is wrong
`Invalid token` - Password is wrong
### Websockets
Chookpen supports websockets for live updating of messages. You can establish a websocket connection with the URL `ws://(server):(port)/api/websocket/`. Send a login request to the websocket: `username:{(username)}password:{(password)}`. If your username and password are correct, you should start recieving messages. Send a message: `username:{(username)}password:{(password)}message:{(message)}`
## Some handy tips and tricks
Chookpen Server **does not support HTTPS!** You can put Chookpen Server behind a reverse proxy and that will sort that out for you.
Chookpen Server and CLI client are both in an alpha stage, keep this in mind before doing ANYTHING with it!
Chookpen Server is not ready for production :/
The port for the server is 7070.

26
client-cli/README.md Normal file
View File

@ -0,0 +1,26 @@
# Chookpen Client (CLI)
This is the reference client for Chookpen. It is quite a basic client. This is a good starting point if you need an example, or are building a GUI Kotlin client.
## Features
* Profile file
* Create account (buggy)
* Log into existing account
* Sync messages
* Send message
* Auto hash password
* Configure whether HTTPS is used
## Documentation
To run this client, do the following:
1. Install Java 17+ and Gradle.
2. `git clone https://git.maxwellj.xyz/max/chookpen`
3. In the client-cli directory of the git repo, run `gradle installDist`.
5. Inside build/install/bin, create a .chookpen.profile file that looks like this: ```name:password:server:port:0```
6. Run the script in build/install/bin, or the bat file if you're a crazy weird guy who uses Windows (Make sure to use the command line otherwise it'll close instantly)
7. If you'd like to send a message, add that as your argument after specifying the script.
Note: The password in .chookpen.profile is hashed by the client. If you're just testing the server, set your password to `dingus`. The hash recognised by the server for that password is `750c63441033127dccaa91c16b21614e`. Create an account with the method specified in the root README using that password.

35
client-cli/build.gradle.kts Normal file
View File

@ -0,0 +1,35 @@
plugins {
kotlin("jvm") version "2.0.0"
application
distribution
}
application {
mainClass.set("xyz.maxwellj.chookpen.client.MainKt")
layout.buildDirectory.dir("distributions/")
}
group = "xyz.maxwellj.chookpen.client"
version = "0.0.2"
repositories {
mavenCentral()
}
tasks.withType<Jar> {
manifest {
attributes["Main-Class"] = "xyz.maxwellj.chookpen.client.MainKt"
}
}
dependencies {
testImplementation(kotlin("test"))
implementation("com.squareup.okhttp3:okhttp:4.12.0")
}
tasks.test {
useJUnitPlatform()
}
kotlin {
jvmToolchain(17)
}

5
client-cli/settings.gradle.kts Normal file
View File

@ -0,0 +1,5 @@
plugins {
id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0"
}
rootProject.name = "chookpen.client"

112
client-cli/src/main/kotlin/Main.kt Normal file
View File

@ -0,0 +1,112 @@
package xyz.maxwellj.chookpen.client
import okhttp3.*
import java.util.Scanner
import kotlin.system.exitProcess
import java.io.File
import kotlin.system.exitProcess
import java.math.BigInteger
import java.security.MessageDigest
fun md5(input:String): String {
val md = MessageDigest.getInstance("MD5")
return BigInteger(1, md.digest(input.toByteArray())).toString(16).padStart(32, '0')
}
fun main() {
// Variables
var name = ""
var server = ""
var port = ""
var hasHTTPS = ""
var password = ""
var configFile = File("${System.getProperty("user.home")}/chookpen.profile")
var configStage = 0
for (char in configFile.readText()) {
if (char == ':') {configStage ++}
if (configStage == 0) {
name += char
} else if (configStage == 1) {
password += char
} else if (configStage == 2) {
server += char
} else if (configStage == 3) {
port += char
} else if (configStage == 4) {
hasHTTPS += char
}
}
server = server.replace(":", "")
port = port.replace(":", "")
hasHTTPS = hasHTTPS.replace(":", "")
password = password.replace(":", "")
if (password == "x") {
println("Enter your password:")
password = readln()
}
val client = OkHttpClient.Builder()
//.pingInterval(30, TimeUnit.SECONDS)
.build()
val request = Request.Builder()
.url("ws://localhost:7070/api/websocket")
.build()
var webSocket: WebSocket? = null
val listener = object : WebSocketListener() {
override fun onOpen(webSocket: WebSocket, response: Response) {
println(password)
println(md5(password))
println("Connection opened")
webSocket.send("username:{$name}token:{${md5(password)}}message:{Joined the room}")
}
override fun onMessage(webSocket: WebSocket, text: String) {
println("$text")
}
override fun onClosing(webSocket: WebSocket, code: Int, reason: String) {
println("Connection closing: $reason")
webSocket.close(1000, null)
}
override fun onFailure(webSocket: WebSocket, t: Throwable, response: Response?) {
println("Connection failed: ${t.message}")
}
}
// Set up shutdown hook for Ctrl+C handling
Runtime.getRuntime().addShutdownHook(Thread {
println("\nShutting down gracefully...")
webSocket?.close(1000, "Client shutting down")
client.dispatcher.executorService.shutdown()
})
// Initialize WebSocket connection
webSocket = client.newWebSocket(request, listener)
// Set up input handling
val scanner = Scanner(System.`in`)
println("Type your messages (press Enter to send, Ctrl+C to quit):")
while (true) {
try {
val input = scanner.nextLine()
if (input.isNotEmpty()) {
webSocket?.send("username:{$name}token:{${md5(password)}}message:{$input}")
}
} catch (e: Exception) {
// Handle any input-related exceptions
println("Error reading input: ${e.message}")
break
}
}
}

13
client-python/README.md
View File

@ -1,13 +0,0 @@
## Chookchat Python Client
This is an example client for Chookchat, written in Python. It is very simplistic. It connects to the Websocket, and prints recieved messages.
This would be a good baseline for a GUI client with tkinter, or a bot for Chookchat linking it to other services.
Not much else to say.
### Running
First, `pip3 install websocket-client rel`. If you need, create a virtual environment for Python.
Then, run with `python3 client.py`

68
client-python/client.py
View File

@ -1,68 +0,0 @@
import websocket
import json
import _thread
import time
import rel
from google import genai
username = "(insert username here)"
token = "(insert token here)"
def joinRoom(roomName):
ws.send(json.dumps({
"type": "joinRoom",
"username": username,
"token": token,
"room": roomName,
"content": ""
}))
def sendMessage(content):
ws.send(json.dumps({
"type": "message",
"username": username,
"token": token,
"content": content
}))
def sendTyping(content):
ws.send(json.dumps({
"type": "typing",
"username": username,
"token": token,
"content": content
}))
def on_message(ws, message):
print("Message received: " + message)
if message == "ping":
ws.send("pong")
def on_error(ws, error):
print("Error:", error)
def on_close(ws, close_status_code, close_msg):
print(f"Connection closed: {close_status_code} - {close_msg}")
def on_open(ws):
print("Opening connection to Chookchat...")
joinRoom("general")
ws.send(json.dumps({
"type": "connect",
"username": username,
"token": token,
"content": username + " joined the room!"
}))
if __name__ == "__main__":
websocket.enableTrace(True)
ws = websocket.WebSocketApp("wss://bobcompass.online/api/websocket",
on_open=on_open,
on_message=on_message,
on_error=on_error,
on_close=on_close
)
ws.run_forever(dispatcher=rel, reconnect=5, ping_interval=30, ping_timeout=10)
rel.signal(2, rel.abort)
rel.dispatch()

BIN
client-web/InterVariable.ttf
View File

Binary file not shown.

21
client-web/gradient.css
View File

@ -1,21 +0,0 @@
/* Credit to Manuel Pinto on Codepen for the code!
https://codepen.io/P1N2O/pen/pyBNzX */
body {
background: linear-gradient(-33deg, #721c7a, #612bd4, #3aa5c5, #30cf7f);
background-size: 400% 400%;
animation: gradient 120s ease infinite;
height: 100vh;
}
@keyframes gradient {
0% {
background-position: 0% 50%;
}
50% {
background-position: 100% 50%;
}
100% {
background-position: 0% 50%;
}
}

419
client-web/index.css
View File

@ -1,419 +0,0 @@
@font-face {
font-family: "inter";
src: url("InterVariable.ttf");
}
a {
color: white;
}
input {
color: white;
background: rgba(0, 0, 0, 0.5);
border: none;
border-radius: 10px;
padding: 5px;
font-family: "inter";
margin: 10px;
}
.tiny {
font-size: 5pt;
}
h1 {
font-size: 35pt;
}
h2 {
font-size: 20pt;
}
h3 {
font-size: 15pt;
}
p {
font-size: 12pt;
}
#messagebox {
overflow-y: auto;
border: 0px;
padding: 20px;
margin: 10px 10px;
flex-grow: 1;
}
.bluebutton {
background: rgba(0, 0, 255, 0.3);
}
.greenbutton {
background: rgba(0, 255, 0, 0.3);
}
.redbutton {
background: rgba(255, 0, 0, 0.3);
}
.hidden {
display: none;
}
html, body {
height: 100%;
margin: 0;
padding: 0;
overflow: hidden;
box-sizing: border-box;
}
body {
color: white;
background: rgb(231,255,68);
background: linear-gradient(336deg, rgba(231,255,68,0.67) 0%, rgba(73,255,145,0.67) 43%, rgba(104,79,255,1) 100%);
font-family: inter;
background-attachment: fixed;
padding: 20px;
display: flex;
flex-direction: column;
align-items: center;
}
.section {
background-color: rgba(0, 0, 0, 0.1);
border-radius: 10px;
padding: 5px;
width: calc(100vw - 40px);
height: calc(100vh - 40px);
box-sizing: border-box;
}
.section h2 {
margin: 20px;
}
.box {
color: white;
background: rgba(0, 0, 0, 0.5);
border-radius: 10px;
margin: 10px auto;
padding: 20px;
max-width: 400px;
width: 100%;
box-sizing: border-box;
display: flex;
flex-direction: column;
align-items: center;
}
.box p {
margin: 10px;
}
.box h3 {
margin: 10px;
}
.box img {
margin: 10px;
}
.box button {
margin: 10px;
}
#messaging .box {
max-width: none;
height: 100%;
position: relative;
}
#messagebox {
overflow-y: auto;
border: 0px;
padding: 20px;
margin: 10px 0;
flex-grow: 1;
width: 100%;
box-sizing: border-box;
}
.message {
text-align: left;
margin: 5px 0;
width: 100%;
display: flex;
flex-direction: column;
align-items: flex-start;
}
.file {
float: left;
border-radius: 10px;
margin: 5px 0;
}
.input-container {
display: flex;
width: 100%;
gap: 10px;
box-sizing: border-box;
}
input {
color: white;
background: rgba(0, 0, 0, 0.5);
border: none;
border-radius: 10px;
padding: 5px 5px;
font-family: "inter";
max-width: 300px;
width: 100%;
box-sizing: border-box;
}
#messageInput {
max-width: none;
flex-grow: 1;
margin: 0;
}
.bluebutton, .greenbutton, .redbutton {
max-width: 200px;
width: auto;
margin: 0;
white-space: nowrap;
color: white;
font-size: 12pt;
font-family: inter;
border-radius: 10px;
border: none;
padding: 8px 12px;
max-width: none;
width: auto;
margin: 5px 0;
white-space: normal;
word-wrap: break-word;
text-align: center;
cursor: pointer;
}
.bluebutton, .greenbutton, .redbutton:hover {
background: rgba(255, 255, 255, 0.1);
border-radius: 5px;
}
#users {
display: flex;
align-items: left;
justify-content: space-between;
width: 100%;
}
#meeting {
cursor: pointer;
padding: 5px 10px;
margin-right: 10px;
align-items: right;
}
.suttle {
text-align: left;
width: 100%;
padding-left: 10px;
margin-bottom: 5px;
font-size: 0.9em;
color: rgba(255, 255, 255, 0.7);
}
#users {
position: relative;
width: 100%;
}
#meeting {
position: absolute;
right: 10px;
top: 0;
cursor: pointer;
padding: 5px 10px;
}
.message.call-notification {
color: lightblue;
}
#meet {
display: none;
position: fixed;
top: 50%;
left: 50%;
transform: translate(-50%, -50%);
z-index: 1000;
background: rgba(0, 0, 0, 0.9);
padding: 20px;
border-radius: 10px;
width: 80%;
height: 80%;
}
.eggs-panel {
position: absolute;
right: -300px;
top: 0;
width: 300px;
height: 100%;
background: rgba(0, 0, 0, 0.5);
border-radius: 10px;
transition: right 0.3s ease;
}
.eggs-panel.visible {
right: -310px;
}
.eggs-list {
padding: 10px;
}
.egg-item {
width: 100%;
padding: 10px;
margin: 5px 0;
background: rgba(0, 0, 0, 0.3);
border: none;
border-radius: 5px;
color: white;
font-family: "inter";
cursor: pointer;
}
.egg-item:hover {
background: rgba(255, 255, 255, 0.1);
}
.egg-content {
padding: 10px;
height: calc(100% - 20px);
background: rgba(0, 0, 0, 0.3);
border-radius: 5px;
margin: 10px;
}
#messaging {
width: 100%;
height: 100%;
}
.messaging-container {
display: flex;
flex-direction: row;
height: 100%;
position: relative;
}
.box {
flex: 1;
margin-right: 10px;
}
.eggs-panel {
width: 300px;
background: rgba(0, 0, 0, 0.5);
border-radius: 10px;
transition: transform 0.3s ease;
transform: translateX(100%);
height: 100%;
}
.eggs-panel.visible {
transform: translateX(0);
}
.eggs-list {
padding: 10px;
}
.egg-item {
width: 100%;
padding: 10px;
margin: 5px 0;
background: rgba(0, 0, 0, 0.3);
border: none;
border-radius: 5px;
color: white;
font-family: "inter";
cursor: pointer;
}
.egg-item:hover {
background: rgba(255, 255, 255, 0.1);
}
.egg-content {
padding: 10px;
height: calc(100% - 20px);
background: rgba(0, 0, 0, 0.3);
border-radius: 5px;
margin: 10px;
}
.room-list {
width: 200px;
background: rgba(0, 0, 0, 0.5);
border-radius: 10px;
margin-right: 10px;
padding: 10px;
height: 100%;
overflow-y: auto;
}
.room-header {
font-weight: bold;
text-align: center;
padding: 5px;
margin-bottom: 10px;
border-bottom: 1px solid rgba(255, 255, 255, 0.3);
}
.room-item {
padding: 10px;
margin: 5px 0;
border-radius: 5px;
cursor: pointer;
transition: background 0.2s;
}
.room-item:hover {
background: rgba(255, 255, 255, 0.1);
}
.room-item.active {
background: rgba(104, 79, 255, 0.3);
font-weight: bold;
}
.create-room-button {
width: 100%;
padding: 8px;
margin-top: 10px;
background: rgba(73, 255, 145, 0.3);
border: none;
border-radius: 5px;
color: white;
cursor: pointer;
transition: background 0.2s;
}
.create-room-button:hover {
background: rgba(73, 255, 145, 0.5);
}
.room-title {
font-weight: bold;
font-size: 16px;
margin-bottom: 5px;
padding: 5px 10px;
background: rgba(0, 0, 0, 0.3);
border-radius: 5px;
}
.message.system-message {
color: rgba(73, 255, 145, 0.8);
font-style: italic;
}
.message.history-message {
color: rgba(255, 255, 255, 0.7);
}

68
client-web/index.html
View File

@ -1,68 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Chookchat</title>
<link rel="preconnect" href="https://rsms.me/">
<link rel="stylesheet" href="https://rsms.me/inter/inter.css">
<link type="text/css" rel="stylesheet" href="index.css">
<link type="text/css" rel="stylesheet" href="gradient.css">
<link rel="shortcut icon" type="image/jpg" href="favicon.ico"/>
<script src="https://cdnjs.cloudflare.com/ajax/libs/crypto-js/4.1.1/crypto-js.min.js"></script>
<script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
</head>
<body class="gradient">
<div id="login">
<div class="section">
<div class="box">
<h3>Chookchat</h3>
<input type="text" id="username" placeholder="Username"><br>
<input type="password" id="password" placeholder="Password"><br>
<button class="bluebutton" onclick="connect()">Log in</button>
<button class="greenbutton" onclick="register()">Register</button>
<button class="redbutton" onclick="showConfig()">Show Server Config</button>
<div id="serverStatus"></div>
</div>
<div class="box" style="display: none;" id="serverconfig">
<input type="text" id="serverUrl" value="bobcompass.online" placeholder="Server URL"><br>
<input type="text" id="serverPort" value="443" placeholder="Server Port"><br>
<input type="checkbox" id="securityStatus" checked>
<label for="securityStatus">Use HTTPS/WSS</label>
</div>
</div>
</div>
<div class="hidden" id="messaging">
<div class="messaging-container">
<div id="meet"></div>
<div class="box">
<div id="users" class="suttle"></div>
<button id="meeting" class="bluebutton" onclick="startMeeting()">📞</button>
<div id="messagebox" class="box" style="height: 600px;">
<div></div>
</div>
<div id="typing" class="suttle"></div>
<div id="upload" class="suttle" style="display: none;">
<input type="file" id="fileupload" accept="image/*,text/*">
<button class="bluebutton" onclick="uploadFile()">Upload</button>
</input>
</div>
<div class="input-container">
<button onclick="showFileUpload()" class="bluebutton">📁</button>
<button onclick="showEggs()" class="bluebutton">🥚</button>
<input type="text" id="messageInput" placeholder="Send a message..." autofocus>
<button onclick="sendMessage()" class="bluebutton">Send</button>
</div>
</div>
<div id="eggs" style="display: none;">
<div id="eggs-list" class="eggs-list">
<button class="egg-item" onclick="eggNotepad()">📝 Notepad</button>
</div>
<!-- Eggs Start Here -->
</div>
</div>
</div>
<script src="index.js"></script>
</body>
</html>

701
client-web/index.js
View File

@ -1,701 +0,0 @@
alert("Chookchat is currently in early development, expect bugs! Please don't try breaking the public server, do that with your own test server (read more in the Git repo). Thanks for trying Chookchat!")
let ws;
let username;
let password;
let typingTimeout;
let typingPeople = new Array();
let api;
let currentRoom = "general";
let availableRooms = ["general"];
function resizeMessaging() {
const messagingDiv = document.getElementById('messaging');
if (messagingDiv) {
messagingDiv.style.width = `${window.innerWidth - 40}px`;
messagingDiv.style.height = `${window.innerHeight - 40}px`;
}
}
resizeMessaging();
window.addEventListener('resize', resizeMessaging);
function showConfig() {
const serverconfig = document.getElementById('serverconfig')
if (serverconfig) {
serverconfig.style.display = 'block';
}
}
function md5(string) {
return CryptoJS.MD5(string).toString();
}
function getUrl() {
const serverUrl = document.getElementById('serverUrl').value.trim();
const serverPort = document.getElementById('serverPort').value;
const useWss = document.getElementById('securityStatus').checked;
const protocol = useWss ? 'wss' : 'ws';
const cleanUrl = serverUrl.replace(/^(https?:\/\/|wss?:\/\/)/, '');
return `${protocol}://${cleanUrl}:${serverPort}/api/websocket`;
}
function getSignupUrl() {
const serverUrl = document.getElementById('serverUrl').value.trim();
const serverPort = document.getElementById('serverPort').value;
const useWss = document.getElementById('securityStatus').checked;
const protocol = useWss ? 'https' : 'http';
const cleanUrl = serverUrl.replace(/^(https?:\/\/|wss?:\/\/)/, '');
return `${protocol}://${cleanUrl}:${serverPort}/api/createaccount/`;
}
function getUploadUrl() {
const serverUrl = document.getElementById('serverUrl').value.trim();
const serverPort = document.getElementById('serverPort').value;
const useWss = document.getElementById('securityStatus').checked;
const protocol = useWss ? 'https' : 'http';
const cleanUrl = serverUrl.replace(/^(https?:\/\/|wss?:\/\/)/, '');
return `${protocol}://${cleanUrl}:${serverPort}/api/upload`;
}
async function getRooms() {
try {
const serverUrl = document.getElementById('serverUrl').value.trim();
const serverPort = document.getElementById('serverPort').value;
const useWss = document.getElementById('securityStatus').checked;
const protocol = useWss ? 'https' : 'http';
const cleanUrl = serverUrl.replace(/^(https?:\/\/|wss?:\/\/)/, '');
const url = `${protocol}://${cleanUrl}:${serverPort}/api/rooms`;
const response = await fetch(url, {
mode: "no-cors"
});
const data = await response.json();
return JSON.parse(data.content);
} catch (error) {
console.error('Error fetching rooms:', error);
return ["general"];
}
}
async function getRoomHistory(roomName) {
try {
const serverUrl = document.getElementById('serverUrl').value.trim();
const serverPort = document.getElementById('serverPort').value;
const useWss = document.getElementById('securityStatus').checked;
const protocol = useWss ? 'https' : 'http';
const cleanUrl = serverUrl.replace(/^(https?:\/\/|wss?:\/\/)/, '');
const url = `${protocol}://${cleanUrl}:${serverPort}/api/room/${roomName}/history`;
const response = await fetch(url, {
mode: "no-cors"
});
const history = await response.text();
return history;
} catch (error) {
console.error('Error fetching room history:', error);
return '';
}
}
const imageMimeTypes = [
'image/webp',
'image/tiff',
'image/svg+xml',
'image/png',
'image/jpeg',
'image/vnd.microsoft.icon',
'image/gif',
'image/bmp',
];
const imageTypes = [
'png',
'jpg',
'jpeg',
'svg',
'tiff',
'gif',
'webp',
'bmp'
];
function isImage(file) {
const fileSplit = file.split(".");
return imageTypes.includes(fileSplit[fileSplit.length - 1]);
}
async function connect() {
username = document.getElementById('username').value;
password = document.getElementById('password').value;
if (!username || !password) {
alert('Please enter a username and password');
return;
}
const wsUrl = getUrl();
if (ws) {
ws.close();
}
ws = new WebSocket(wsUrl);
var incorrectDetail = 0;
ws.onopen = async () => {
if (typeof Notification !== "undefined") {
Notification.requestPermission();
}
console.log('Connected!');
document.getElementById('login').style.display = 'none';
document.getElementById('messaging').style.display = 'block';
try {
availableRooms = await getRooms();
updateRoomList();
} catch (error) {
console.error('Failed to get room list:', error);
availableRooms = ["general"];
}
const connectMessage = {
"type": "connect",
"username": username,
"token": md5(password),
"content": `${username} joined the room!`
}
ws.send(JSON.stringify(connectMessage));
joinRoom("general");
ws.onmessage = (event) => {
if (event.data === "ping") {
ws.send("pong");
return;
}
const message = JSON.parse(event.data);
if (message.type == "error") {
if (message.username == "system") {
if (message.content == "invalid-token") {
alert("Your password is incorrect! Please try putting in your password right.");
incorrectDetail = 1;
location.reload();
}
if (message.content == "unknown-account") {
alert("That username isn't on the server. Maybe try registering?");
incorrectDetail = 1;
location.reload();
}
if (message.content == "banned") {
alert("kiddo you're banned lol what did you do to get banned lmaooo");
incorrectDetail = 1;
location.reload();
}
}
}
else if (message.type == "typing" && message.content == "1") {
if (username !== message.username && !typingPeople.includes(message.username)) {
typingPeople.push(message.username);
updatePeopleTyping();
}
return;
}
else if (message.type == "typing" && message.content == "0") {
if (username !== message.username && typingPeople.includes(message.username)) {
const index = typingPeople.indexOf(message.username);
typingPeople.splice(index, 1);
updatePeopleTyping();
}
return;
}
else if (message.type == "users" && message.username == "system") {
usersDiv = document.getElementById("users");
if (usersDiv) {
usersDiv.textContent = `Online users: ${message.content}`
}
return;
}
else if (message.type == "roomUsers" && message.username == "system") {
const usersInRoom = message.content;
const roomName = message.room;
usersDiv = document.getElementById("users");
if (usersDiv) {
usersDiv.textContent = `Users in ${roomName}: ${usersInRoom}`;
if (roomName !== currentRoom) {
currentRoom = roomName;
updateCurrentRoomDisplay();
}
}
return;
}
else if (message.type == "roomsList" && message.username == "system") {
try {
availableRooms = JSON.parse(message.content);
updateRoomList();
} catch (error) {
console.error('Error parsing rooms list:', error);
}
return;
}
else if (message.type == "roomCreated" || message.type == "roomJoin") {
if (message.room) {
currentRoom = message.room;
updateCurrentRoomDisplay();
clearMessages();
loadRoomHistory(currentRoom);
updateRoomList();
}
// Display the system message
const messagesDiv = document.getElementById('messagebox');
const messageElement = document.createElement('div');
if (messageElement && messagesDiv) {
messagesDiv.appendChild(messageElement);
messageElement.className = 'message system-message';
messageElement.textContent = message.content;
messagesDiv.scrollTop = messagesDiv.scrollHeight;
}
return;
}
else if (message.type == "file") {
// Only show file if it's for current room
if (message.room && message.room !== currentRoom) {
return;
}
const messagesDiv = document.getElementById('messagebox');
let filename = message.content.replace("https://maxwellj.xyz/chookchat/uploads/", "");
if (isImage(filename)) {
const imagePreview = document.createElement('img');
if (imagePreview) {
if (messagesDiv) {
messagesDiv.appendChild(imagePreview);
imagePreview.src = message.content;
imagePreview.height = 300;
imagePreview.addEventListener("click", function() {
window.open(message.content, "_blank");
});
}
}
} else {
const fileButton = document.createElement('button');
if (fileButton) {
if (messagesDiv) {
messagesDiv.appendChild(fileButton);
fileButton.textContent = `Open ${filename} in new tab`;
fileButton.className = "bluebutton";
fileButton.addEventListener("click", function() {
window.open(message.content, "_blank");
});
messagesDiv.scrollTop = messagesDiv.scrollHeight;
}
}
}
return;
}
else if (message.type == "call") {
if (message.room && message.room !== currentRoom) {
return;
}
const messagesDiv = document.getElementById('messagebox');
const callButton = document.createElement('div');
if (callButton) {
if (messagesDiv) {
messagesDiv.appendChild(callButton)
callButton.className = "message call-notification";
callButton.textContent = `${message.username} started a Jitsi call! Click to join!`;
callButton.addEventListener('click', () => {
window.open(message.content, '_blank');
});
messagesDiv.scrollTop = messagesDiv.scrollHeight;
return;
}
}
}
else if (message.type == "connect") {
const messagesDiv = document.getElementById('messagebox');
const messageElement = document.createElement('div');
if (messageElement) {
if (messagesDiv) {
messagesDiv.appendChild(messageElement);
messageElement.className = 'message';
messageElement.textContent = message.content;
messagesDiv.scrollTop = messagesDiv.scrollHeight;
}
}
if (document.hidden) {
const notifiction = new Notification("Chookchat", {body: messageElement.textContent});
}
}
else if (message.type == "message") {
if (message.room && message.room !== currentRoom) {
return;
}
const messagesDiv = document.getElementById('messagebox');
const messageElement = document.createElement('div');
if (messageElement) {
if (messagesDiv) {
messagesDiv.appendChild(messageElement);
messageElement.className = 'message';
messageElement.textContent = `${message.username}: ${message.content}` ;
messagesDiv.scrollTop = messagesDiv.scrollHeight;
}
}
if (document.hidden) {
const notifiction = new Notification("Chookchat", {body: messageElement.textContent});
}
}
else {
return
}
};
}
ws.onclose = () => {
alert("Chookchat has disconnected :/ Refresh the page to try again");
}
}
async function createRoom(roomName) {
const message = {
type: 'createRoom',
username: username,
token: md5(password),
room: roomName,
content: ""
};
ws.send(JSON.stringify(message));
setTimeout(updateRoomList, 500);
}
async function joinRoom(roomName) {
if (roomName === currentRoom) {
const usersMessage = {
type: 'getUsersInRoom',
username: username,
token: md5(password),
room: roomName,
content: ""
};
ws.send(JSON.stringify(usersMessage));
return;
}
const message = {
type: 'joinRoom',
username: username,
token: md5(password),
room: roomName,
content: ""
};
ws.send(JSON.stringify(message));
}
function sendMessage() {
const messageInput = document.getElementById('messageInput');
const message = messageInput.value.trim();
const processedMessage = {
"type": "message",
"username": username,
"token": md5(password),
"room": currentRoom,
"content": message
}
if (processedMessage.content && ws && ws.readyState === WebSocket.OPEN) {
ws.send(JSON.stringify(processedMessage));
messageInput.value = '';
if (typingTimeout) {
clearTimeout(typingTimeout);
}
const stoppedTypingMessage = {
"type": "typing",
"username": username,
"token": md5(password),
"room": currentRoom,
"content": "0"
};
if (ws && ws.readyState === WebSocket.OPEN) {
ws.send(JSON.stringify(stoppedTypingMessage));
}
}
}
function showFileUpload() {
const fileUploadElement = document.getElementById("upload");
if (fileUploadElement) {
fileUploadElement.style.display = "block";
}
}
async function uploadFile() {
const fileInput = document.getElementById("fileupload");
if (!fileInput.files.length) {
alert("Please add a file!");
return;
}
const formData = new FormData();
formData.append("file", fileInput.files[0]);
formData.append("room", currentRoom);
try {
const response = await fetch(getUploadUrl(), {
method: 'POST',
mode: "no-cors",
body: formData
});
if (response.ok) {
const result = await response.text();
const processedMessage = {
"type": "message",
"username": username,
"token": md5(password),
"room": currentRoom,
"content": `Sent a file`
}
if (processedMessage && ws && ws.readyState === WebSocket.OPEN) {
ws.send(JSON.stringify(processedMessage));
}
} else {
alert("Something went wrong lmao");
}
} catch (error) {
alert(error);
}
const fileUploadElement = document.getElementById("upload");
if (fileUploadElement) {
fileUploadElement.style.display = "none";
}
}
document.getElementById('messageInput').addEventListener('keypress', (event) => {
if (event.key === 'Enter') {
sendMessage();
}
});
document.getElementById('password').addEventListener('keypress', (event) => {
if (event.key === 'Enter') {
connect();
}
});
async function doRegister(username, password) {
return fetch(`${getSignupUrl()}username:{${username}}token:{${md5(password)}}`).then((response)=>response.json()).then((responseJson)=>{return responseJson});
}
async function register() {
username = document.getElementById('username').value;
password = document.getElementById('password').value;
if (!username || !password) {
alert('Please enter a username and password');
return;
}
const response = await this.doRegister(username, password);
if (response.type == "success") {
alert("Account created! Click 'log in' to access Chookchat!")
} else {
alert(`We couldn't create your account :( Reason: ${response.content}`)
}
}
function sleep(ms) {
return new Promise(resolve => setTimeout(resolve, ms));
}
function startTypingIndicator() {
if (typingTimeout) {
clearTimeout(typingTimeout);
}
const typingMessage = {
"type": "typing",
"username": username,
"token": md5(password),
"room": currentRoom,
"content": "1"
};
if (ws && ws.readyState === WebSocket.OPEN) {
ws.send(JSON.stringify(typingMessage));
}
typingTimeout = setTimeout(() => {
const stoppedTypingMessage = {
"type": "typing",
"username": username,
"token": md5(password),
"room": currentRoom,
"content": "0"
};
if (ws && ws.readyState === WebSocket.OPEN) {
ws.send(JSON.stringify(stoppedTypingMessage));
}
}, 5000);
}
function updatePeopleTyping() {
const typingDiv = document.getElementById('typing');
if (typingDiv) {
if (typingPeople.length === 0) {
typingDiv.textContent = '';
} else if (typingPeople.length === 1) {
typingDiv.textContent = `${typingPeople[0]} is typing...`;
} else if (typingPeople.length === 2) {
typingDiv.textContent = `${typingPeople[0]} and ${typingPeople[1]} are typing...`;
} else {
typingDiv.textContent = `${typingPeople.length} people are typing...`;
}
}
}
const characters ='abcdefghijklmnopqrstuvwxyz';
function generateString(length) {
let result = '';
const charactersLength = characters.length;
for ( let i = 0; i < length; i++ ) {
result += characters.charAt(Math.floor(Math.random() * charactersLength));
}
return result;
}
function startMeeting() {
const link = `https://meet.jit.si/chookchat-${generateString(15)}`;
alert("Note: You may need to sign in to Jitsi to start the meeting. We'll take you there in a moment...")
window.open(link, '_blank');
const processedMessage = {
"type": "call",
"username": username,
"token": md5(password),
"room": currentRoom,
"content": link
};
if (ws && ws.readyState === WebSocket.OPEN) {
ws.send(JSON.stringify(processedMessage));
} else {
alert("Something went wrong. Refreshing might do the trick :)")
}
}
document.getElementById('messageInput').addEventListener('input', startTypingIndicator);
async function updateRoomList() {
let roomListDiv = document.getElementById('room-list');
if (!roomListDiv) {
const messagingDiv = document.querySelector('.messaging-container');
roomListDiv = document.createElement('div');
roomListDiv.id = 'room-list';
roomListDiv.className = 'room-list';
messagingDiv.insertBefore(roomListDiv, messagingDiv.firstChild);
}
try {
availableRooms = await getRooms();
} catch (error) {
console.error('Error updating room list:', error);
}
roomListDiv.innerHTML = '<div class="room-header">Rooms</div>';
availableRooms.forEach(room => {
const roomElement = document.createElement('div');
roomElement.className = `room-item ${room === currentRoom ? 'active' : ''}`;
roomElement.textContent = room;
roomElement.addEventListener('click', () => joinRoom(room));
roomListDiv.appendChild(roomElement);
});
const createRoomButton = document.createElement('button');
createRoomButton.className = 'create-room-button';
createRoomButton.textContent = '+ New Room';
createRoomButton.addEventListener('click', promptCreateRoom);
roomListDiv.appendChild(createRoomButton);
}
function updateCurrentRoomDisplay() {
const roomTitle = document.getElementById('room-title');
if (roomTitle) {
roomTitle.remove();
}
const roomItems = document.querySelectorAll('.room-item');
roomItems.forEach(item => {
if (item.textContent === currentRoom) {
item.classList.add('active');
} else {
item.classList.remove('active');
}
});
}
function clearMessages() {
const messagebox = document.getElementById('messagebox');
if (messagebox) {
messagebox.innerHTML = '';
}
}
async function loadRoomHistory(roomName) {
try {
const history = await getRoomHistory(roomName);
if (history) {
const messagebox = document.getElementById('messagebox');
const lines = history.split('\n');
lines.forEach(line => {
if (line.trim()) {
const messageElement = document.createElement('div');
messageElement.className = 'message history-message';
messageElement.textContent = line;
messagebox.appendChild(messageElement);
}
});
messagebox.scrollTop = messagebox.scrollHeight;
}
} catch (error) {
console.error('Error loading room history:', error);
}
}
function promptCreateRoom() {
const roomName = prompt('Enter a name for the new room:');
if (roomName && roomName.trim()) {
createRoom(roomName.trim());
}
}
function showEggs() {
const eggsPanel = document.getElementById('eggs');
eggsPanel.style.display = "block";
const mainBox = document.querySelector('#messaging .box');
if (eggsPanel.classList.contains('visible')) {
mainBox.style.width = 'calc(100% - 310px)';
} else {
mainBox.style.width = '100%';
}
}
function closeEggs() {
const eggsPanel = document.getElementById('eggs');
eggsPanel.style.display = "block";
}
const uploadField = document.getElementById("fileupload");
uploadField.onchange = function() {
if(this.files[0].size > 10485760) {
alert("That file is too big bro. Not as big as my (message terminated)");
this.value = "";
}
};
// Eggs begin here

61
server/README.md
View File

@ -1,62 +1,5 @@
# Chookchat Server # Chookpen Server
This is the code for Chookchat's server program. The server program: This is the official Chookpen server implementation. It provides a backend and exposes an API.
* Starts a server on port 7070
* Hosts the web client files (index.html at the root)
* Adjusts index.html based on your config file (a backup index.html is still avaliable at localhost:7070/index.html)
* Handles user signups
* Opens a websocket allowing for flexible user input
* Handles file uploads
**Note:** Chookchat does not support HTTPS natively. We recommend the usage of a reverse proxy like Caddy (caddyserver.com) to enable HTTPS on your website, as well as a firewall to block HTTP connections.
## Server Configuration
Chookchat looks for a chookchat.config file in the directory where you start Chookchat. An example is provided in this directory. Your file must look like the following:
```
address:localhost;port:7070;security:false;serviceName:Chookchat;
```
Address: Where your server is hosted (a domain or IP address usually)
Port: Your server's port (default 7070, 443 if you route it through Caddy with HTTPS)
Security: Whether or not to use WSS/HTTPS (either `true` or `false`)
ServiceName: What your server's name comes up as.
## API Documentation
Chookchat uses websockets to send and recieve messages. Each websocket request (except pinging and ponging) contains JSON to show what kind of data we are sending, what user is sending it (and token while being sent to the server), and the actual message content. A chookchat websocket message to the server looks like this:
```json
{
"type": "message",
"username": "max",
"token": "(hash of password)",
"content": "dongus"
}
```
And a message from the server would look like this (it's the same without the token):
```json
{
"type": "message",
"username": "max",
"content": "dongus"
}
```
The server will send a `ping` every five seconds (without JSON) to stop the connection from timing out. When you recieve this, send back a `pong`.
### Message Types
**message**: A message. Not much going on. It's recommended to display it like ${username}: ${content}
**call**: A link to a Jitsi call. Treat this how you'd like.
**file**: A file sent by a user. For now, it appears as if the `system` user has sent the file, so in a client send a message describing who's uploaded the file shortly after sending the file.
**connect**: A user joining the room. If this is not sent by the `system` user, ignore.
**users**: A list of users currently in the room, seperated by ", ". In order of who joined first. If this is not sent by the `system` user, ignore.

8
server/build.gradle.kts
View File

@ -5,11 +5,11 @@ plugins {
} }
application { application {
mainClass.set("xyz.maxwellj.chookchat.MainKt") mainClass.set("xyz.maxwellj.chookpen.MainKt")
layout.buildDirectory.dir("distributions/") layout.buildDirectory.dir("distributions/")
} }
group = "xyz.maxwellj.chookchat" group = "xyz.maxwellj.chookpen"
version = "0.0.1" version = "0.0.1"
repositories { repositories {
@ -18,16 +18,14 @@ repositories {
tasks.withType<Jar> { tasks.withType<Jar> {
manifest { manifest {
attributes["Main-Class"] = "xyz.maxwellj.chookchat.MainKt" attributes["Main-Class"] = "xyz.maxwellj.chookpen.MainKt"
} }
} }
dependencies { dependencies {
testImplementation(kotlin("test")) testImplementation(kotlin("test"))
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
implementation("io.javalin:javalin:6.3.0") implementation("io.javalin:javalin:6.3.0")
implementation("org.slf4j:slf4j-simple:2.0.16") implementation("org.slf4j:slf4j-simple:2.0.16")
implementation("org.json:json:20230618")
} }
tasks.test { tasks.test {

1
server/chookchat.config
View File

@ -1 +0,0 @@
address:localhost;port:7070;security:false;serviceName:chookchat;

1
server/chookchat.eggs.config
View File

@ -1 +0,0 @@
notepad

4
server/eggs/notepad/index.html
View File

@ -1,4 +0,0 @@
<div class="egg" id="egg-notepad" style="display: none;">
<button id="egg-notepad-close" class="redbutton" onclick="closeEggNotepad()">Close</button><br>
<textarea id="egg-notepad-textarea" placeholder="Start typing..." style="height: 500px"></textarea>
</div>

21
server/eggs/notepad/index.js
View File

@ -1,21 +0,0 @@
function eggNotepad() {
const eggsList = document.getElementById("eggs-list");
eggsList.style.display = "none";
const eggNotepad = document.getElementById("egg-notepad");
eggNotepad.style.display = "block";
const eggNotepadTextArea = document.getElementById("egg-notepad-textarea");
eggNotepadTextArea.addEventListener('input', function(event) {
const eggNotepadMessage = {
"type": "egg-notepad",
"username": username,
"token": md5(password),
"content": event.target.value
};
ws.send(JSON.stringify(eggNotepadMessage));
}, false);
}
function closeEggNotepad() {
const eggNotepad = document.getElementById("egg-notepad");
eggNotepad.style.display = "none";
}

4
server/eggs/notepad/message.js
View File

@ -1,4 +0,0 @@
else if (message.type == "egg-notepad") {
const eggNotepadTextArea = document.getElementById("egg-notepad-textarea");
eggNotepadTextArea.value = message.content
}

1
server/resources/InterVariable.ttf
View File

@ -1 +0,0 @@
../../client-web/InterVariable.ttf

1
server/resources/gradient.css
View File

@ -1 +0,0 @@
../../client-web/gradient.css

1
server/resources/index.css
View File

@ -1 +0,0 @@
../../client-web/index.css

1
server/resources/index.html
View File

@ -1 +0,0 @@
../../client-web/index.html

1
server/resources/index.js
View File

@ -1 +0,0 @@
../../client-web/index.js

2
server/settings.gradle.kts
View File

@ -1,5 +1,5 @@
plugins { plugins {
id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0" id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0"
} }
rootProject.name = "chookchat" rootProject.name = "chookpen"

1021
server/src/main/kotlin/Main.kt
View File

File diff suppressed because it is too large Load Diff

1
server/src/main/resources/public/InterVariable.ttf
View File

@ -1 +0,0 @@
../../../../../client-web/InterVariable.ttf

1
server/src/main/resources/public/gradient.css
View File

@ -1 +0,0 @@
../../../../../client-web/gradient.css

1
server/src/main/resources/public/index.css
View File

@ -1 +0,0 @@
../../../../../client-web/index.css

1
server/src/main/resources/public/index.html
View File

@ -1 +0,0 @@
../../../../../client-web/index.html

1
server/src/main/resources/public/index.js
View File

@ -1 +0,0 @@
../../../../../client-web/index.js