Compare commits

..

11 Commits
0.0.2 ... main

Author SHA1 Message Date
Maxwell Jeffress
e463d3dd2b Add eggs 2024-12-06 13:27:22 +11:00
Maxwell Jeffress
7ff5447388 Add eggs, as well as example egg and config 2024-12-06 13:07:53 +11:00
Maxwell Jeffress
23fc71bd45 Update README.md 2024-12-04 13:11:36 +11:00
Maxwell Jeffress
90cf9f4325 Add Chookpen config file 2024-12-04 08:39:58 +11:00
Maxwell Jeffress
857a05b9ca Add Jitsi call button 2024-12-04 08:28:53 +11:00
Maxwell Jeffress
c07a2c7fce Fix the gradient 2024-11-26 08:32:22 +11:00
Maxwell Jeffress
500ac029df Add file upload support 2024-11-25 14:50:03 +11:00
Maxwell Jeffress
83fc6052ad Add file uploads 2024-11-25 14:25:42 +11:00
Maxwell Jeffress
dae4bb380f Typing indicators, online users 2024-11-24 16:07:45 +11:00
Maxwell Jeffress
78b885b22e Fix critical mobile WebKit bug 2024-11-24 14:13:05 +11:00
Maxwell Jeffress
f69a3fb599 Update readmes, make slight code change 2024-11-23 19:38:19 +11:00
23 changed files with 766 additions and 437 deletions

1
.gitignore vendored
View File

@ -2,6 +2,7 @@
.swp
server/build
server/.gradle
server/uploads
server/userDatabase
server/chatHistory
client-cli/build

View File

@ -1,8 +1,8 @@
# Chookpen - A simple messaging service
# Chookchat - A simple messaging service
## What is Chookpen?
## What is Chookchat?
Chookpen is a lightweight, secure-ish chat server implementation focused on simplicity and real-time communication. It features user authentication, persistent message history, real-time updates via WebSockets, and supports both traditional HTTP endpoints and WebSocket connections for flexible integration. 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.
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.
## A guide to this repository
@ -25,3 +25,7 @@ The build tool for compiling Chookpen. It just works!
The language Chookpen is coded in. How else does it work?
### [OpenJDK](https://openjdk.org)
The best way to run Chookpen. Free and open source!
There's also all the other various libraries I use (and these other libraries use) so check the code for those!

View File

@ -1,26 +0,0 @@
# 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.

View File

@ -1,35 +0,0 @@
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)
}

View File

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

View File

@ -1,114 +0,0 @@
package xyz.maxwellj.chookpen.client
import okhttp3.*
import java.util.Scanner
import java.util.concurrent.TimeUnit
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
}
}
}

View File

@ -1,43 +1,21 @@
/* Reset default margin and ensure full viewport coverage */
/* Credit to Manuel Pinto on Codepen for the code!
https://codepen.io/P1N2O/pen/pyBNzX */
body {
margin: 0;
min-height: 100vh;
background: linear-gradient(
30deg,
#50C878, /* green */
#7FFFD4, /* aqua */
#87CEEB, /* light blue */
#00008B, /* dark blue */
#800080, /* purple */
#50C878, /* green */
#7FFFD4, /* aqua */
#87CEEB, /* light blue */
#00008B, /* dark blue */
#800080, /* purple */
#50C878 /* green */
);
background-size: 1000% 1000%;
background: linear-gradient(-33deg, #721c7a, #612bd4, #3aa5c5, #30cf7f);
background-size: 400% 400%;
animation: gradient 120s ease infinite;
height: 100vh;
}
/* Gradient animation keyframes */
@keyframes gradient {
0% {
background-position: 0% 50%;
}
50% {
background-position: 100% 50%;
}
100% {
background-position: 200% 50%;
background-position: 0% 50%;
}
}
/* Optional: styling for centered content */
.content {
height: 100vh;
display: flex;
justify-content: center;
align-items: center;
color: white;
font-family: sans-serif;
font-size: 2rem;
text-shadow: 2px 2px 4px rgba(0,0,0,0.3);
}

View File

@ -42,61 +42,17 @@ p {
border: 0px;
padding: 20px;
margin: 10px 10px;
flex-grow: 1; /* This makes it take up remaining space */
}
.section h2 {
margin: 20px;
}
.box p {
margin: 10px;
}
.box h3 {
margin: 10px;
}
.box img {
margin: 10px;
}
.box button {
margin: 10px;
flex-grow: 1;
}
.bluebutton {
color: white;
font-size: 12pt;
background: rgba(0, 0, 255, 0.3);
font-family: inter;
border-radius: 10px;
border: none;
padding: 5px;
}
.greenbutton {
color: white;
font-size: 12pt;
background: rgba(0, 255, 0, 0.3);
font-family: inter;
border-radius: 10px;
border: none;
padding: 5px;
}
.redbutton {
color: white;
font-size: 12pt;
background: rgba(255, 0, 0, 0.3);
font-family: inter;
border-radius: 10px;
border: none;
padding: 5px;
}
.backbutton {
color: white;
font-size: 12pt;
background: rgba(255, 0, 0, 0.3);
font-family: inter;
border-radius: 10px;
border: none;
padding: 5px;
}
.hidden {
display: none;
@ -121,17 +77,19 @@ body {
align-items: center;
}
/* Update section styles */
.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; /* Add this to include padding in width calculation */
box-sizing: border-box;
}
.section h2 {
margin: 20px;
}
/* Update box styles */
.box {
color: white;
background: rgba(0, 0, 0, 0.5);
@ -146,11 +104,23 @@ body {
align-items: center;
}
/* Special handling for messaging box */
.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; /* For absolute positioning of input container */
position: relative;
}
#messagebox {
@ -163,19 +133,25 @@ body {
box-sizing: border-box;
}
/* Style for individual messages */
.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;
}
/* Create a container for message input and send button */
.input-container {
display: flex;
width: 100%;
gap: 10px; /* Space between input and button */
/* padding: 10px;*/
gap: 10px;
box-sizing: border-box;
}
@ -192,17 +168,185 @@ input {
box-sizing: border-box;
}
/* Special style for message input */
#messageInput {
max-width: none;
flex-grow: 1; /* Take up remaining space */
margin: 0; /* Remove default margins */
flex-grow: 1;
margin: 0;
}
/* Update button styles */
.bluebutton, .greenbutton, .redbutton, .backbutton {
.bluebutton, .greenbutton, .redbutton {
max-width: 200px;
width: auto; /* Allow button to size to content */
margin: 0; /* Remove default margins */
white-space: nowrap; /* Prevent button text from wrapping */
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;
}

View File

@ -4,6 +4,8 @@
<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"/>
@ -31,13 +33,28 @@
</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"><button class="bluebutton" onclick="uploadFile()">Upload</button></input></div>
<div class="input-container">
<input type="text" id="messageInput" placeholder="Send a message...">
<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>

View File

@ -1,29 +1,20 @@
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!")
const width = $(document).width();
if (width < 512) {
console.log("enlarging");
const loginDiv = document.getElementById('login');
if (loginDiv) {
console.log(loginDiv.style.width = `${width}px`);
console.log("enlarged?");
}
}
let ws;
let username;
let password;
let typingTimeout;
let typingPeople = new Array();
let api;
function resizeMessaging() {
const messagingDiv = document.getElementById('messaging');
if (messagingDiv) {
messagingDiv.style.width = `${window.innerWidth - 40}px`; // -40 for body margins
messagingDiv.style.height = `${window.innerHeight - 40}px`; // -40 for body margins
messagingDiv.style.width = `${window.innerWidth - 40}px`;
messagingDiv.style.height = `${window.innerHeight - 40}px`;
}
}
// Call it initially
resizeMessaging();
// Add resize listener to handle window resizing
@ -60,7 +51,16 @@ function getSignupUrl() {
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`;
}
function connect() {
username = document.getElementById('username').value;
password = document.getElementById('password').value;
@ -80,7 +80,9 @@ function connect() {
var incorrectDetail = 0;
ws.onopen = () => {
if (typeof Notification !== "undefined") {
Notification.requestPermission();
}
console.log('Connected!');
document.getElementById('login').style.display = 'none';
document.getElementById('messaging').style.display = 'block';
@ -109,21 +111,102 @@ function connect() {
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 == "file") {
const messagesDiv = document.getElementById('messagebox');
const fileElement = document.createElement('embed');
if (fileElement) {
if (messagesDiv) {
messagesDiv.appendChild(fileElement);
fileElement.className = "file";
fileElement.src = message.content;
fileElement.height = 200;
fileElement.addEventListener("click", function() {
window.open(message.content, "_blank");
});
messagesDiv.scrollTop = messagesDiv.scrollHeight;
}
}
return;
}
else if (message.type == "call") {
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);
messagesDiv.scrollTop = messagesDiv.scrollHeight;
messageElement.className = 'message';
messageElement.textContent = `${message.username}: ${message.content}` ;
messageElement.textContent = message.content;
messagesDiv.scrollTop = messagesDiv.scrollHeight;
}
}
if (document.hidden) {
const notifiction = new Notification("Chookchat", {body: messageElement.textContent});
}
}
else if (message.type == "message") {
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});
}
}
// Egg message logic
else {
return
}
};
}
ws.onclose = () => {
@ -145,6 +228,73 @@ function sendMessage() {
if (processedMessage && 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),
"content": "0"
};
if (ws && ws.readyState === WebSocket.OPEN) {
ws.send(JSON.stringify(stoppedTypingMessage));
}
}
const processedMessage2 = {
"type": "typing",
"username": username,
"token": md5(password),
"content": "0"
}
if (processedMessage && ws && ws.readyState === WebSocket.OPEN) {
ws.send(JSON.stringify(processedMessage2));
}
}
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]);
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),
"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";
}
}
@ -171,3 +321,103 @@ function register() {
window.open(`${getSignupUrl()}username:{${username}}token:{${md5(password)}}`);
}
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),
"content": "1"
};
if (ws && ws.readyState === WebSocket.OPEN) {
ws.send(JSON.stringify(typingMessage));
}
typingTimeout = setTimeout(() => {
const stoppedTypingMessage = {
"type": "typing",
"username": username,
"token": md5(password),
"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),
"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);
function showEggs() {
const eggsPanel = document.getElementById('eggs');
eggsPanel.style.display = "block";
// Adjust main box width when eggs panel is toggled
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";
}
// Eggs begin here

View File

@ -1,130 +1,62 @@
# Chookpen Server
# Chookchat Server
Key features:
- Real-time messaging with WebSocket support
- User authentication and account management
- Persistent message history
- Simple HTTP API for basic operations
- Built-in static file serving for web clients
- Support for encryption keys
- Active user tracking and presence notifications
This is the code for Chookchat's server program. The server program:
## Requirements
* Starts a server on port 7070
- Java 17 or later
- Caddy (for HTTPS reverse proxy) - [Download from caddyserver.com](https://caddyserver.com/download)
- Some kind of OS, any should do
- 50mb free space, 30mb avaliable ram (yes I know, very bloated and inefficient)
* Hosts the web client files (index.html at the root)
## Running the Server
* Adjusts index.html based on your config file (a backup index.html is still avaliable at localhost:7070/index.html)
Prebuilt binaries are available for immediate use. Simply download the latest server release and run:
* Handles user signups
```bash
./run
* 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;
```
The server will start on port 7070 by default.
## Building from Source
First, install Gradle. Unless you want to painfully compile everything manually, Gradle is your best friend.
Clone the repository and CD into the server directory. Then run:
```bash
gradle build
```
To create a distribution (you don't need to run gradle build, it will do that for you):
```bash
./gradlew installDist
```
To run the server, create the files `chatHistory` and `userDatabase` in the directory you're running it from, then run the script to start Chookpen.
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
### HTTP Endpoints
#### Send Message
- Endpoint: `/api/send/{content}`
- Content Format: `username:{name}token:{token}message:{message}`
- Response: "Success" or error message
#### Create Account
- Endpoint: `/api/createaccount/{content}`
- Content Format: `username:{name}token:{password}`
- Response: "Success" or error message
#### Sync Messages
- Endpoint: `/api/syncmessages/{content}`
- Content Format: `username:{name}token:{token}`
- Response: Chat history or error message
#### Auth Key (being worked on for E2EE)
- Endpoint: `/api/authkey/{content}`
- Content Format: `username:{name}token:{token}authkey:{key}`
- Response: "Success" or error message
## WebSocket Interface
Connect to `/api/websocket` for real-time updates.
### WebSocket Messages
1. Server to Client:
- Ping messages: "ping"
- User updates: "!users:{user1,user2,user3}"
- Chat messages: "username: message"
2. Client to Server:
- Pong response: "pong"
- Message format: Same as HTTP send endpoint
## Setting up HTTPS with Caddy
Caddy provides automatic HTTPS and serves as a reverse proxy for your Chookpen server. [Download from caddyserver.com](https://caddyserver.com/download) or from your Linux/BSD/Illumos/Haiku/TempleOS/whatever distribution's package manager.
1. Create a `Caddyfile` in your server directory:
```
chat.yourdomain.com {
reverse_proxy localhost:7070
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"
}
```
2. Start Caddy:
```bash
caddy run
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`.
Caddy will automatically obtain and manage SSL certificates for your domain.
### Message Types
## Client Deployment
**message**: A message. Not much going on. It's recommended to display it like ${username}: ${content}
Place your client files in the `src/main/resources/public` directory. The server will automatically serve these static files, making the client accessible at your server's root URL.
**call**: A link to a Jitsi call. Treat this how you'd like.
## Maintenance
**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.
### Database Files
- `userDatabase`: Contains user credentials in format `username:token:salt`
- `chatHistory`: Stores message history
- Regular backups recommended
**connect**: A user joining the room. If this is not sent by the `system` user, ignore.
### Health Checks
- Server automatically maintains WebSocket connections
- Dead sessions are cleaned up automatically
- Active user count is logged
### Security Recommendations
- Keep database files secure
- Regular system updates
- Monitor for unusual login patterns
- Back up regularly:
```bash
#!/bin/bash
backup_dir="/path/to/backups"
date_stamp=$(date +%Y%m%d)
cp userDatabase "${backup_dir}/userDatabase_${date_stamp}"
cp chatHistory "${backup_dir}/chatHistory_${date_stamp}"
```
**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.

1
server/chookchat.config Normal file
View File

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

View File

@ -0,0 +1 @@
notepad

View File

@ -0,0 +1,4 @@
<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>

View File

@ -0,0 +1,21 @@
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";
}

View File

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

View File

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

View File

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

1
server/resources/index.css Symbolic link
View File

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

1
server/resources/index.html Symbolic link
View File

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

1
server/resources/index.js Symbolic link
View File

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

View File

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

View File

@ -2,6 +2,8 @@ package xyz.maxwellj.chookchat
import io.javalin.Javalin
import io.javalin.websocket.WsContext
import io.javalin.http.UploadedFile
import java.util.concurrent.ConcurrentHashMap
import java.util.UUID
@ -24,20 +26,52 @@ fun md5(input:String): String {
val md = MessageDigest.getInstance("MD5")
return BigInteger(1, md.digest(input.toByteArray())).toString(16).padStart(32, '0')
}
/*
fun removeLines(fileName: String, lineNumber: String) {
require(!fileName.isEmpty() && startLine >= 1 && numLines >= 1)
val f = File(fileName)
var lines = f.readLines()
if (startLine > size) {
println("The starting line is beyond the length of the file")
return
object config {
var address = ""
var port = ""
var security = ""
var serviceName = ""
fun getConfig() {
address = ""
port = ""
security = ""
serviceName = ""
val configFile = File("chookchat.config")
try {
val config = configFile.readLines()
var type = ""
var isEditing = 0
for (line in config) {
for (char in line) {
if (char == ':') {
isEditing = 1
} else if (char == ';') {
isEditing = 0
type = ""
} else {
if (isEditing == 0) {
type += char
} else if (isEditing == 1)
if (type == "address") {
address += char
} else if (type == "port") {
port += char
} else if (type == "security") {
security += char
} else if (type == "serviceName") {
serviceName += char
}
}
}
}
} catch (e: Exception) {
println("Something went wrong :/ Here's the error: $e")
}
}
lines = lines.take(startLine - 1) + lines.drop(startLine + n - 1)
val text = lines.joinToString(System.lineSeparator())
f.writeText(text)
}
*/
object WsSessionManager {
val peopleOnline = mutableListOf("")
val sessionsList = mutableListOf("")
@ -350,15 +384,120 @@ fun handleServerCommand(command: String): String {
return("I'm not sure how to ${commandArgs.toString()}")
}
fun buildHTML(): String {
try {
config.getConfig()
val htmlFile = File("resources/index.html")
val html = htmlFile.readLines()
var editedhtml = ""
for (line in html) {
if (line == """ <input type="text" id="serverUrl" value="bobcompass.online" placeholder="Server URL"><br>""") {
editedhtml += """ <input type="text" id="serverUrl" value="${config.address}" placeholder="Server URL"><br>"""
} else if (line == """ <input type="text" id="serverPort" value="443" placeholder="Server Port"><br>""") {
editedhtml += """ <input type="text" id="serverPort" value="${config.port}" placeholder="Server Port"><br>"""
} else if (line == """ <input type="checkbox" id="securityStatus" checked>""" && config.security == "false") {
editedhtml += """ <input type="checkbox" id="securityStatus">"""
} else if (line == """ <h3>Chookchat</h3>""") {
editedhtml += """ <h3>${config.serviceName}</h3>"""
} else if (line == """ <!-- Eggs Start Here -->""") {
val eggsFile = File("chookchat.eggs.config")
val eggs = eggsFile.readLines()
for (line in eggs) {
val eggHTMLFile = File("eggs/$line/index.html")
if (eggHTMLFile.exists()) {
val eggHTML = eggHTMLFile.readText()
editedhtml += eggHTML
}
}
} else {
editedhtml += line
}
}
return(editedhtml)
} catch (e: Exception) {
println(e)
return("There was an error! If you're the server's admin, here are the details: $e")
}
return("dingus")
}
fun buildJS(): String {
try {
val eggsFile = File("chookchat.eggs.config")
val eggs = eggsFile.readLines()
val jsFile = File("resources/index.js")
val js = jsFile.readLines()
var editedJS = ""
for (line in js) {
if (line == " // Egg message logic") {
for (line in eggs) {
val eggJSMessageFile = File("eggs/$line/message.js")
if (eggJSMessageFile.exists()) {
val eggJSMessage = eggJSMessageFile.readText()
editedJS += eggJSMessage
}
}
} else {
editedJS += "$line\n"
}
}
//editedJS += js
for (line in eggs) {
val eggJSFile = File("eggs/$line/index.js")
if (eggJSFile.exists()) {
val eggJS = eggJSFile.readText()
editedJS += eggJS
}
}
return(editedJS)
} catch (e: Exception) {
println(e)
return("console.log(`There was an error! If you're the server's admin, here are the details: $e`)")
}
return("dingus")
}
fun main(args: Array<String>) {
WsSessionManager.peopleOnline.removeAt(0)
WsSessionManager.sessionsList.removeAt(0)
val app = Javalin.create { config ->
config.staticFiles.add("/public")
}.get("/") { ctx ->
ctx.redirect("/index.html")
ctx.html(buildHTML())
//ctx.redirect("/index.html")
}
.get("/index.js") { ctx ->
ctx.result(buildJS())
}
.get("/api/createaccount/{content}") { ctx -> ctx.result(createAccount(ctx.pathParam("content")))}
.post("/api/upload") { ctx ->
val uploadedFiles = ctx.uploadedFiles()
if (uploadedFiles.isEmpty()) {
ctx.status(400).result("No files uploaded")
return@post
}
val uploadedFile = uploadedFiles[0]
val originalFilename = uploadedFile.filename()
val uuid = UUID.randomUUID().toString()
val fileExtension = originalFilename.substringAfterLast(".", "")
val baseFilename = originalFilename.substringBeforeLast(".")
val newFilename = "${baseFilename}_${uuid}${if (fileExtension.isNotEmpty()) ".$fileExtension" else ""}"
val filePath = Paths.get("uploads", newFilename)
Files.copy(uploadedFile.content(), filePath)
val processedData = JSONObject().apply {
put("type", "fileStatus")
put("username", "system")
put("content", "success")
}
ctx.result(processedData.toString())
val processedData2 = JSONObject().apply {
put("type", "file")
put("username", "system")
put("content", "https://maxwellj.xyz/chookchat/uploads/$newFilename")
}
WsSessionManager.broadcast(processedData2.toString())
}
.ws("/api/websocket") { ws ->
ws.onConnect { ctx ->
WsSessionManager.addSession(ctx)
@ -387,9 +526,17 @@ fun main(args: Array<String>) {
}
}
.start(7070)
try {
if (args[0] == "-i") {
println("Type a command for the server")
while (1 == 1) {
println(handleServerCommand(readln()))
}
} else {
println("Interactive mode disabled, add -i to enable")
}
} catch (error: Exception) {
println("Interactive mode disabled, add -i to enable")
}
}