Compare commits

...
Sign in to create a new pull request.

75 commits
docker ... main

Author SHA1 Message Date
a2433e0e5e rearranged, started using different wgsi server 2026-03-04 19:51:28 -05:00
8d78960f0b Added text hint to QR code in settings 2026-03-04 14:28:27 -05:00
f35b074543 Added lossless tag to search 2026-03-04 14:28:12 -05:00
d96014c24d Change back to CRLF, since basically everything else is
For some reason github thinks this is binary, promise it isn't
2026-03-02 17:24:54 -05:00
3690a66ef2 Small modifications, CRLF to LF 2026-02-11 09:50:31 -05:00
a72e91ce32
Merge pull request #7 from kristy-fournier/timerChanges
Sockets allowing for live updates rather than complete rebuilds of the client
2026-02-11 09:39:36 -05:00
192a84deed Update Wishlist, sockets are done 2026-02-11 09:38:45 -05:00
725cc3eb89 Re-freeze pip with minimum requirements 2026-02-11 09:36:32 -05:00
f556f17cce Few fixes that i'm going to un-re-fix later 2026-02-11 09:36:19 -05:00
f2204ee7ed Add versions and socketio 2026-02-11 09:12:00 -05:00
4cd5b33f84 Merge branch 'timerChanges' of https://github.com/kristy-fournier/PartyJukebox into timerChanges 2026-02-11 09:07:04 -05:00
566ce9cd73 Sockets are finished to an acceptable level 2026-02-11 09:06:02 -05:00
664cbda8f2 Merge branch 'timerChanges' of https://github.com/kristy-fournier/PartyJukebox into timerChanges 2026-02-10 20:06:14 -05:00
37bdd33aff Removed a false comment 2026-02-10 20:04:45 -05:00
554ba1b206 Merge branch 'main' into timerChanges 2026-02-09 14:18:37 -05:00
d8b261dcb7 Adjusted details relating to new features 2026-02-09 10:12:38 -05:00
4b3e64bd1a Updated readme 2026-02-08 20:34:50 -05:00
6effff1dc5 Adding a placeholder for future socket stuff 2026-02-02 10:58:31 -05:00
86a37a89c6 secure getFromServer is possible 2026-02-01 23:35:47 -05:00
95efd937f6 Update wishlist.md 2026-02-01 22:22:07 -05:00
8cb8b61397 Update wishlist.md 2026-02-01 22:21:02 -05:00
17632d4dea New settings socket, Different controls css 2026-02-01 22:20:05 -05:00
4c24f13c09 Update readme, slight gramatical change 2026-02-01 22:19:13 -05:00
87687506b1 Playlist update instead of refresh, time/skip sync
- Playlist destroys and creates members on the fly
- Updates time live, and ensures skips aren't detected twice

Im sure there are still bugs, but ill find them as i go
I am also still going to refactor this, so it''s not going to be merged into main for a while
2026-01-31 11:24:02 -05:00
f064183b9a Sockets are implemented
need a lot of fixes but are in a mostly working state as of now
2026-01-31 00:08:53 -05:00
384b369eee Update scripts.js 2026-01-30 22:06:43 -05:00
f17ab0c426 broken timer lololol 2026-01-29 17:53:25 -05:00
f37b2b7691 Added client side access to dupe prevention
Still some bugs but ill work through them
2026-01-29 17:09:00 -05:00
62caee7fd8 adaptive qr code, dark mode and more
- Dark mode is set based on user browser info
- QR Code changes colours based on dark or light mode
- "DUP" controlPerm for preventing duplicates in the future
  - Fully implemented in the server but not yet the client
2026-01-29 16:51:01 -05:00
cda152852c Minor changes 2026-01-26 15:32:28 -05:00
7d45d9498e fixed search errors 2026-01-26 15:32:00 -05:00
bcf3f28cb0
Merge pull request #6 from kristy-fournier/responseCodes
http responses are entirely rewritten
2026-01-26 12:31:24 -05:00
fce09edfc5 Added proper handling of internal errors (should be no 500s anywhere) 2026-01-26 12:30:08 -05:00
2002dd1afa removed broken timer, finalised new responses 2026-01-26 12:15:56 -05:00
417ecc8ced messing around, will fix later 2026-01-26 10:50:59 -05:00
00550cca85 I got distracted and broke something but the responses should be good now 2026-01-26 10:39:17 -05:00
0b64a6f297 Okay the backend should be done so im committing now
im gonna fix the frontend next
2026-01-26 10:09:26 -05:00
9bdac82f10 In the thick of changing the responses to requests 2026-01-25 19:04:02 -05:00
347feae50a added to requirements.txt, updated readme 2026-01-22 18:57:03 -05:00
bcd6807a34 Duplicate song queue adds can be blocked 2026-01-22 00:31:53 -05:00
1e1eac4aa4 Added a "clear playlist" admin function on the client 2026-01-22 00:10:59 -05:00
6a04ac30f5 slight layout update, mostly relevant for mobile 2026-01-21 23:45:14 -05:00
0dba7fd8cf Added to wishlist
websockets for playlist to send updates without full refresh
2026-01-21 20:06:07 -05:00
85257808a3 Updates to readme, fixed darkmode cookie bug 2026-01-21 20:02:35 -05:00
4f39417852 added hashing, updated parts of readme to explain env file
also added some tabby stuff, but its not done yet
2026-01-21 19:27:49 -05:00
37945ccced updated example.env
also rearranged imports and wishlist
2026-01-21 18:36:41 -05:00
ae428239a7 Start of updating icons 2026-01-21 18:28:40 -05:00
5772edf88a Using dotenv, refactored some stuff, made making database slightly faster with art 2026-01-21 16:49:04 -05:00
0cd6b4ce2e Keep dark mode state in a cookie
im gonna make this suck less later
2026-01-21 16:46:01 -05:00
838789e687 I lied i added a bit to the wishlist 2026-01-21 16:03:29 -05:00
ded406abcd update wishlist 2026-01-21 16:00:47 -05:00
ab09058c3d Dark mode is working to a level where i am happy with it
Note: i did ask gemini for some help on this, but understand and still wrote everything out
2026-01-21 15:57:35 -05:00
d33ee77693 Moved the creation of the virtual table to the databasegenerator.py 2026-01-21 15:56:55 -05:00
758f399636 tab to songs and playlist items
this actually isnt accessible, but it is something to think about. I don't personally know anyone who needs tab navigation but i know it's good to have and use
2025-10-17 15:49:02 -04:00
7958b4e8bd made the search items not have text go out of the box 2025-10-17 15:44:10 -04:00
6ece2d3ea1 refactored, fixed mp3 length bug, added lossless tag to database 2025-10-17 15:32:19 -04:00
faac93b1f6 flac and wav support 2025-10-10 18:39:56 -04:00
86e3e9cce8 Rearranged and removed comments 2025-10-10 15:30:01 -04:00
b20f0ecad0 Client is now 100% hosted on the included files
no more web references (so you don't need internet access on a closed network)
2025-10-10 15:28:49 -04:00
dcfe7115fa Playlist items text is spaced not stupidly
Playlist Items look like not garbage now
I gave them a giant margin and forgot about it. should be good now
the item holders have padding instead for the edges
2025-10-07 16:36:06 -04:00
e08e9cbcca Fixed a bunch of bugs to make adminpass complete
also added a bunch of comments and a new item design (css) that i'm probably going to undo
2025-10-06 12:47:58 -04:00
d72320aae4 Renamed some dumb variables, started wishlist 2025-10-05 23:27:04 -04:00
0034708091
Merge pull request #5 from kristy-fournier/admin-mode
Admin mode
2025-10-05 09:06:34 -04:00
86fde79305 make VERY CLEAR the password feature is not secure 2025-10-05 09:04:24 -04:00
d24aca7f39 made very clear passwords are not secure 2025-10-05 09:02:48 -04:00
189cafd08a Readme update
Should be good to be pushed to main now
2025-10-03 19:03:49 -04:00
76971ea75e Done adding admin password
Just gotta do documentation
2025-10-03 18:51:12 -04:00
1733a485b4 99% done
also added some new comments and notes about future design changes
2025-10-03 17:26:12 -04:00
36c2286b41 Update readme.md 2025-10-03 15:32:14 -04:00
1910b30acc everything but the auto-updating settings should be working
and also skipping isnt working on the playlist page
2025-07-18 20:13:18 -04:00
f41255e456 added server side password verification to everything that needs it 2025-07-18 19:21:21 -04:00
d110657d8f Added base of password system and check for adding a song 2025-07-18 18:31:46 -04:00
ea0380e3eb changed a for loop to fix for testing 2025-07-18 18:31:22 -04:00
26e8e93785 Fixed adminperms labels 2025-07-18 18:31:02 -04:00
a291e4626a added options 2025-07-12 22:09:18 -04:00
14 changed files with 1055 additions and 231 deletions

2
.gitignore vendored
View file

@ -1,3 +1,5 @@
server/sound/
*.db
start.bat
.env
venv/

134
Client/ext/popper.js Normal file
View file

@ -0,0 +1,134 @@
function Pop() {
// var cssRuleFile = "/src/css/style.css"; // will be the link once this css file became available online
var cssRuleFile = "https://cookieconsent.popupsmart.com/src/css/style.css"; // will be the link once this css file became available online
let lnk = document.createElement("link");
lnk.setAttribute("rel", "stylesheet");
lnk.setAttribute("type", "text/css");
lnk.setAttribute("href", cssRuleFile);
document.getElementsByTagName("head")[0].appendChild(lnk);
let styl = "undefined";
var conDivObj;
var fadeInTime = 10; // If needed could be served as an customizable option to the user
var fadeOutTime = 10;
let cookie = {
name: "cookieconsent_status",
path: "/",
expiryDays: 365 * 24 * 60 * 60 * 5000,
};
let content = {
/// Add a field for link color
message:
"This website uses cookies to ensure you get the best experience on our website.",
btnText: "Got it!",
mode: " banner bottom",
theme: " theme-classic",
palette: " palette1",
link: "Learn more",
href: "https://www.cookiesandyou.com",
target: "_blank",
};
let createPopUp = function () {
console.log(content);
if (typeof conDivObj === "undefined") {
conDivObj = document.createElement("DIV");
conDivObj.style.opacity = 0;
conDivObj.setAttribute("id", "spopupCont");
}
conDivObj.innerHTML =
'<div id="poper" class="window ' +
content.mode +
content.theme +
content.palette +
'"><span id="msg" class="message">' +
content.message +
'<a id="plcy-lnk" class="policylink" href="' +
content.href +
'"' +
" target=" +
content.target +
">" +
content.link +
'</a></span><div id="btn" class="compliance"><a id="cookie-btn" class="spopupbtnok" >' +
content.btnText +
'</a></div><span class="credit"><a href="https://popupsmart.com" target="_blank"><svg xmlns="http://www.w3.org/2000/svg" width="1em" height="1em" viewBox="0 0 60 60" fill="currentColor"><path id="popupsmart" d="M56.627,12.279a22.441,22.441,0,0,0-9.549-9.074c-4.122-2.088-8.951-3.2-15.722-3.2H28.644c-6.769,0-11.6,1.112-15.72,3.2a22.425,22.425,0,0,0-9.551,9.072C1.174,16.191,0,20.783,0,27.214v5.578c0,6.434,1.173,11.024,3.373,14.934A22.412,22.412,0,0,0,12.924,56.8c4.12,2.094,8.949,3.206,15.72,3.206h2.711c6.771,0,11.6-1.112,15.72-3.206a22.427,22.427,0,0,0,9.551-9.072c2.2-3.91,3.373-8.5,3.373-14.934V27.216C60,20.78,58.827,16.19,56.627,12.279ZM30,45.006c-.237,0-.473-.005-.708-.015l-.211-.012c-.14-.008-.28-.019-.419-.031-.123-.011-.245-.022-.367-.036l-.191-.024a14.979,14.979,0,0,1-2.672-.59V44.3a14.861,14.861,0,0,1-6.294-3.955,1.406,1.406,0,1,0-2.036,1.94,17.648,17.648,0,0,0,8.33,4.944v.354a5.214,5.214,0,1,1-10.428,0V30.046c0-.013,0-.026,0-.039a15,15,0,1,1,15,15Z" transform="translate(0 -0.005)"></path></svg><span>Powered by Popupsmart</span></a></span></div>';
document.body.appendChild(conDivObj);
fadeIn(conDivObj);
document
.getElementById("cookie-btn")
.addEventListener("click", function () {
saveCookie();
fadeOut(conDivObj);
});
};
let fadeOut = function (element) {
var op = 1;
var timer = setInterval(function () {
if (op <= 0.1) {
clearInterval(timer);
conDivObj.parentElement.removeChild(conDivObj);
}
element.style.opacity = op;
element.style.filter = "alpha(opacity=" + op * 100 + ")";
op -= op * 0.1;
}, fadeOutTime);
};
let fadeIn = function (element) {
var op = 0.1;
var timer = setInterval(function () {
if (op >= 1) {
clearInterval(timer);
}
element.style.opacity = op;
element.style.filter = "alpha(opacity=" + op * 100 + ")";
op += op * 0.1;
}, fadeInTime);
};
let checkCookie = function (key) {
var keyValue = document.cookie.match("(^|;) ?" + key + "=([^;]*)(;|$)");
return keyValue ? true : false;
};
let saveCookie = function () {
var expires = new Date();
expires.setTime(expires.getTime() + cookie.expiryDays);
document.cookie =
cookie.name +
"=" +
"ok" +
";expires=" +
expires.toUTCString() +
"path=" +
cookie.path;
};
this.init = function (param) {
if (checkCookie(cookie.name)) return;
if (typeof param === "object") {
if ("ButtonText" in param) content.btnText = param.ButtonText;
if ("Mode" in param) content.mode = " " + param.Mode;
if ("Theme" in param) content.theme = " " + param.Theme;
if ("Palette" in param) content.palette = " " + param.Palette;
if ("Message" in param) content.message = param.Message;
if ("LinkText" in param) content.link = param.LinkText;
if ("Location" in param) content.href = param.Location;
if ("Target" in param) content.target = param.Target;
if ("Time" in param)
setTimeout(function () {
createPopUp();
}, param.Time * 1000);
else createPopUp();
}
};
}
window.start = new Pop();

1
Client/ext/qrcode.min.js vendored Normal file

File diff suppressed because one or more lines are too long

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Before After
Before After

View file

@ -5,10 +5,14 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0" />
<link rel="stylesheet" href="styles.css">
<link rel="manifest" href="manifest.json" />
<meta charset="utf-8">
<script src="https://cdnjs.cloudflare.com/ajax/libs/js-sha256/0.11.0/sha256.min.js"></script>
<!-- above allows use of sha256() on http -->
<script src="https://cdn.socket.io/4.7.5/socket.io.min.js"></script>
</head>
<body id="test-body">
<!--Cookie Popup(does it matter if im not tracking them? i have no idea)-->
<script type="text/javascript" src="https://cookieconsent.popupsmart.com/src/js/popper.js"></script><script> window.start.init({Palette:"palette2",Mode:"floating left",Theme:"classic",LinkText:" Learn More!",Message:"This website uses cookies to save necessary data to your device, and no tracking is performed.",Time:"0",})</script>
<script type="text/javascript" src="/ext/popper.js"></script><script> window.start.init({Palette:"palette2",Mode:"floating left",Theme:"classic",LinkText:" Learn More!",Message:"This website uses cookies to save necessary data to your device, and no tracking is performed.",Time:"0",})</script>
<div class="intro">
<h1 id="title">Jukebox Remote</h1>
@ -22,12 +26,12 @@ changes visibility with JS-->
<input type="text" autocomplete="off" placeholder="Search" id="songsearch" enterkeyhint="Search" class="searchbox"><button class="go-search" id="go-search">Go!</button>
</div>
<div class="songlist" id="songlist">
<h1>Search to find songs!</h1>
<h1 style="margin-top: 0px;">Search to find songs!</h1>
<!-- Placeholder for the song items
These are generated using javascript for search
<div class="item">
<img src="search.png"></img>
<img src="placeholder.png"></img>
<h3><span>Song title</span></h3>
<h4>Artist</h4>
</div>
@ -53,13 +57,12 @@ changes visibility with JS-->
<div class="settings-mode" id="settings-mode">
<div class="settings" id="settings">
<h1>Client Settings (Saved to device)</h1>
<!--
<div class="item">
<h2 for="darkmode-button">Dark Mode:</h2>
<p class="italic">Opposite of light mode</p>
<button title="darkmode-button" id="darkmode-button">Off</button>
</div>
-->
<div class="item">
<h2 for="iptextbox">Server IP:</h2>
<p class="italic">IP of the device running the song server</p>
@ -81,26 +84,50 @@ changes visibility with JS-->
<p class="italic">Volume of the music</p>
<input type="range" min="0" max="100" step="1" title="volumerange" id="volumerange">
</div>
<div class="item no-line">
<div class="item">
<h2>Share the remote:</h2>
<!-- <p class="italic">Hit settings icon to refresh the code</p>
You actually no longer need to do that, it does it anytime the ip changes -->
<p class="italic">This shares the IP and URL you are currently connected to</p>
<div id="qrcode" alt="QR code to the remote URL"></div>
</div>
<p class="versionNumber">Version 1.0.2</p>
<p class="versionNumber">PartyJukebox is under an <a href="https://github.com/kristy-fournier/PartyJukebox/blob/main/LICENSE.md">AGPLV3</a> liscense. You can access the source code <a href=https://github.com/kristy-fournier/PartyJukebox>here</a>.</p>
<h1>Admin Settings</h1>
<p class="italic">Note: Admin password must have been set from the server</p>
<div class="item">
<h2>Admin Password:</h2>
<p class="italic">Enter to use admin restricted functions</p>
<input placeholder="Wordpass12" type="password" title="Admin password box" id="adminpasswordbox" enterkeyhint="done">
</div>
<div class=item>
<h2>Fine action control:</h2>
<p class="italic">A check means that action is avalible to everyone</p>
<div id="admincheckholder">
<input type="checkbox" title="addsongcheck" id="addsongsettingcheckbox"><label for="addsongsettingcheckbox">Add songs to queue</label><br>
<input type="checkbox" title="skipsongcheck" id="skipsongsettingcheckbox"><label for="skipsongsettingcheckbox">Skip songs</label><br>
<input type="checkbox" title="playpausecheck" id="playpausesettingcheckbox"><label for="playpausesettingcheckbox">Play/pause</label><br>
<input type="checkbox" title="partymodecheck" id="partymodesettingcheckbox"><label for="partymodesettingcheckbox">Toggle Party Mode</label><br>
<input type="checkbox" title="volumechangecheck" id="volumechangesettingcheckbox"><label for="volumechangesettingcheckbox">Change volume</label><br>
<input type="checkbox" title="duplicateallowcheck" id="duplicateallowesettingcheckbox"><label for="duplicateallowsettingcheck">Add duplicate songs</label><br>
</div>
</div>
<div class="item">
<h2>Clear the playlist</h2>
<p class="italic" >Wipe the playlist, except the currently playing song. With PartyMode enabled, a second song will be added back randomly</p>
<button id="clear-button">Clear Playlist</button>
</div>
<p class="versionNumber">PartyJukebox is under an <a href="https://github.com/kristy-fournier/PartyJukebox/blob/main/LICENSE.md" target="_blank">AGPLV3</a> liscense. You can access the source code <a href=https://github.com/kristy-fournier/PartyJukebox target="_blank">here</a>.</p>
</div>
</div>
<!--All the buttons are down here but settings is just doing its own thing-->
<img class="settings-button" id="settings-button" src="./images/settings.png" alt="settings"></img>
<div id="controls" class="controls">
<img class="control-button" id="playlist-button" src="./images/playlist.png" alt="playlist"></img>
<img class="control-button" id="play-pause-button" src="./images/play-pause.png" alt="play pause"></img>
<img class="control-button" id="skip-button" src="./images/skip.png" alt="skip"></img>
<img class="control-button" id="search-button" src="./images/search.png" alt="search"></img>
<img tabindex=0 class="control-button" id="playlist-button" src="./images/playlist.png" alt="Playlist"></img>
<img tabindex=0 class="control-button" id="play-pause-button" src="./images/play-pause.png" alt="Play pause"></img>
<img tabindex=0 class="control-button" id="skip-button" src="./images/skip.png" alt="Skip"></img>
<img tabindex=0 class="control-button" id="search-button" src="./images/search.png" alt="Search"></img>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/qrcodejs/1.0.0/qrcode.min.js" integrity="sha512-CNgIRecGo7nphbeZ04Sc13ka07paqdeTu0WR1IM4kNcpmBAUSHSQX0FslNhTDadL4O5SAGapGt4FodqL8My0mA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
<div class="settings-button-holder">
<img tabindex=0 class="settings-button control-button" id="settings-button" src="./images/settings.png" alt="settings"></img>
</div>
<script src="/ext/qrcode.min.js" integrity="sha512-CNgIRecGo7nphbeZ04Sc13ka07paqdeTu0WR1IM4kNcpmBAUSHSQX0FslNhTDadL4O5SAGapGt4FodqL8My0mA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
<script src="scripts.js"></script>
</body>
</html>

View file

@ -1,5 +1,37 @@
let ip
let alertTime = 2
// set all the global stuff
let ip;
let alertTime = 2;
let adminPass = "";
let justSkipped = false;
let justChangedSetting = false;
const ERR_NO_ADMIN = 401;
const VALID_FILE_EXT = ["mp3","flac","wav"];
let playlistTimeTimer=null;
let playlistElapsedSeconds=0;
let playlistSongLength=-1;
let currentlyPlaying = false;
const params = new URLSearchParams(location.search);
let darkmodetemp = getCookie("darkmode");
if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
darkmodetemp = "true";
}
if(darkmodetemp === "") {
darkmodetemp = params.get("darkmode")
}
if (darkmodetemp === "true") {
// i know this is gonna cause weird blinking
// maybe the dark mode function should be loaded before any content, would that work?
// NEW JS FILE ????? exciting stuff
// im thinking a few new js files
// you know like good design separating stuff
// yeah but i need the getCookie function in both the darkmode.js and this one, so im gonna make a
// getcookie.js
toggleDark("None");
}
async function alertText(text="Song Added!") {
alertbox = document.getElementById("alert");
alertbox.innerHTML = text;
@ -10,29 +42,54 @@ async function alertText(text="Song Added!") {
}
// a lot of this is kinda waffly because i was trying to get
// it to return the right stuff and javascript is asyrcronouse (boo)
async function getFromServer(bodyInfo, source="") {
async function getFromServer(bodyInfo, source="", secure=false, password=adminPass) {
try{
const response = await fetch("http://"+ip+"/"+source, {
if (bodyInfo != null) {
// the currently set password is always included in every request
bodyInfo["password"] = password;
}
let href = "";
if(secure) {
href = "https://"+ip+"/" + source;
} else {
href = "http://"+ip+"/" + source;
}
const response = await fetch(href, {
method: "POST",
body: JSON.stringify(bodyInfo),
headers: {
"Content-type": "application/json; charset=UTF-8"
}
});
const data = await response.json();
let data = await response.json(); // original json
if (response.status == ERR_NO_ADMIN) {
// im suprised i didn't comment on this already but this is kinda lame desing
// its not wrong but you know
// it is easy which i like
alertText("Error: Admin restricted action")
} else if(!response.ok){
throw new Error(data.error);
alertText("Error: "+data.error);
}
// we add some information from the response just in case it is needed
data["ok"] = response.ok;
data["status"] = response.status;
// console.log(data);
return await data;
} catch(e) {
if (e == "TypeError: Failed to fetch"){
alertText("error: Can't Connect to Server (is the ip set?)")
// console.log("error print here:");
// console.log(e);
if (e.toString().includes("TypeError: Failed to fetch")){
alertText("Error: Can't Connect to Server (is the ip set?)")
} else {
alertText("error: " + e)
alertText(e);
}
const response=null;
return response;
}
}
//cookie reader is taken from internet because cookies ae too complicated for me
//i still understand how it works though promise just i see no reason to write this from scratch
function getCookie(cname) {
@ -51,37 +108,56 @@ function getCookie(cname) {
return "";
}
//someone more organised than me would have set all these html elements to variables so they dont have to get them 50 times
// also someone who likes things not being dumb more than me would have separated the client and server buttons
async function controlButton(buttonType) {
if (buttonType == "pp") {
getFromServer({control: "play-pause"}, "controls")
} else if (buttonType == "sk") {
getFromServer({control: "skip"}, "controls")
if (buttonType == "pp") { // Play-Pause button
let result = await getFromServer({control: "play-pause"}, "controls");
// console.log(result);
currentlyPlaying = result["data"]["playingState"];
} else if (buttonType == "sk") { // Skip button
// clearInterval(playlistTimeTimer);
let returnCode = await getFromServer({control: "skip"}, "controls");
// console.log(returnCode["ok"])
if(returnCode["ok"]) {
if (document.getElementById("playlist-mode").style.display == "block") {
generateVisualPlaylist("skip-button");
skipInPlaylist();
playlistElapsedSeconds = 0;
justSkipped = true;
}
} else if (buttonType == "pl") {
}
} else if (buttonType == "pl") { // Playlist button
clearInterval(playlistTimeTimer);
document.getElementById("songlist").innerHTML = "";
document.getElementById("playlist").innerHTML = "<h1 id=\"playlist-alert\"></h1>";
document.getElementById("playlist-mode").style.display = "block";
document.getElementById("songlist-mode").style.display = "none";
document.getElementById("settings-mode").style.display = "none";
generateVisualPlaylist();
} else if (buttonType == "se") {
} else if (buttonType == "se") { //SearchMode button
clearInterval(playlistTimeTimer);
document.getElementById("songlist").innerHTML = "<h1>Search to find songs!</h1>";
document.getElementById("playlist").innerHTML = "";
document.getElementById("playlist-mode").style.display = "none";
document.getElementById("songlist-mode").style.display = "block";
document.getElementById("settings-mode").style.display = "none";
} else if (buttonType == "st") {
} else if (buttonType == "st") { //Settings button
clearInterval(playlistTimeTimer);
document.getElementById("songlist").innerHTML = "";
document.getElementById("playlist").innerHTML = "";
document.getElementById("playlist-mode").style.display = "none";
document.getElementById("songlist-mode").style.display = "none";
document.getElementById("settings-mode").style.display = "block";
checkSettings()
} else if (buttonType = "pm") {
await getFromServer({setting: "partymode-toggle"}, "settings")
checkSettings(true)
} else if (buttonType == "pm") { //Partymode toggle (in settings)
let response = await getFromServer({setting: "partymode-toggle"}, "settings")
if(response.ok) {
justChangedSetting = true;
checkSettings();
} else {
// dont think anything is needed here
}
} else {
alertText("Error: You pushed a button that does not exist");
}
@ -94,15 +170,16 @@ function searchSongsEnter(e) {
}
async function searchSongs(searchTerm){
let optionslist = []
document.getElementById("songlist").innerHTML = ""
searchResults = await getFromServer({search:searchTerm},"search").then()
let fetchResults = await getFromServer({search:searchTerm},"search").then();
let searchResults = fetchResults.data;
//generate the visual song list
for(var fileName in searchResults) {
let currentSongInJSON = searchResults[fileName]
let newItem = document.createElement("div");
newItem.className = "item";
newItem.id = fileName;
newItem.tabIndex = 0;
let image = document.createElement("img");
try {
if (currentSongInJSON["art"] == null) {
@ -120,6 +197,13 @@ async function searchSongs(searchTerm){
newItem.appendChild(image);
newItem.appendChild(head3);
newItem.appendChild(head4);
// I like this concept but i'm leaving it out for now
if(currentSongInJSON.lossless === 1) {
let losslesstag = document.createElement("p");
losslesstag.textContent = "Ⓛ";
losslesstag.classList.add("lossless-tag");
newItem.appendChild(losslesstag);
}
document.getElementById("songlist").appendChild(newItem);
}
@ -128,6 +212,7 @@ async function searchSongs(searchTerm){
document.getElementById("songlist").innerHTML = "<h1>We might not have that one...</h1>";
}
}
function alertTimeEnter(e){
if (e.key == "Enter") {
e.preventDefault();
@ -144,6 +229,10 @@ function alertTimeSet(time) {
function ipSetEnter(e){
if (e.key == "Enter") {
e.preventDefault();
// why on gosh's green earth am i sending a value here?
// im gonna get rid of all these individual "enter" dectectors and do something
// like i did for the keyboard selection of elements
// basically just if(e==click || e.key == enter)
ipSetter(document.getElementById("iptextbox").value)
}
}
@ -164,23 +253,68 @@ function ipSetter(){
alertText("Your IP is now set to "+ipBox+" at port 19054 (Default)")
}
}
// anytime the server ip changes the qrcode should change to use it
qrCodeGenerate()
}
function qrCodeGenerate() {
let tempURL = "http://" + document.location.href.split("/")[2] + "/?ip=" + ip;
document.getElementById("qrcode").innerHTML = ""
document.getElementById("qrcode").innerHTML = "";
// get the current foreground and background
let dark = window.getComputedStyle(document.body).getPropertyValue("--text-color");
let light = window.getComputedStyle(document.body).getPropertyValue("--bg-main");
new QRCode(document.getElementById("qrcode"), {
text: tempURL,
width: 256,
height: 256,
colorDark : "#000000",
colorLight : "#eeeeee",
colorDark : dark,
colorLight : light,
correctLevel : QRCode.CorrectLevel.H
});
}
async function displayElapsedPlaylistTime(elapsed=0,length=-1) {
if(currentlyPlaying) {
if(Math.floor(elapsed) > Math.floor(length) && typeof length === "number" && typeof elapsed === "number"){
// console.log("somethingShouldBeHappening")
playlistElapsedSeconds = 0;
generateVisualPlaylist();
}
let mins = Math.floor(elapsed/60);
let secs = Math.floor(elapsed%60);
let durMins = Math.floor(length/60);
let durSecs = Math.floor(length%60);
let timeLeft = document.getElementById("elapsed-time-display");
if(mins > durMins) {
mins = durMins;
if(secs > durSecs) {
secs = durSecs;
}
}
timeLeft.innerHTML = mins.toString() +":"+ secs.toLocaleString('en-US', {minimumIntegerDigits: 2,useGrouping: false}) + "/"+ durMins.toString()+":"+durSecs.toLocaleString('en-US', {minimumIntegerDigits: 2,useGrouping: false});
playlistElapsedSeconds++;
}
}
async function updateSingleSetting(data) {
let toBeChanged = data["settingToChange"];
if (toBeChanged === "partymode") {
document.getElementById("partymode-button").textContent = data["newData"];
} else if (toBeChanged === "perms") {
let currentAdminPerms = data["newData"];
document.getElementById("addsongsettingcheckbox").checked = currentAdminPerms["AS"];
document.getElementById("skipsongsettingcheckbox").checked = currentAdminPerms["SK"];
document.getElementById("playpausesettingcheckbox").checked = currentAdminPerms["PP"];
document.getElementById("partymodesettingcheckbox").checked = currentAdminPerms["PM"];
document.getElementById("volumechangesettingcheckbox").checked = currentAdminPerms["VOL"];
document.getElementById("duplicateallowesettingcheckbox").checked = currentAdminPerms["DUP"];
} else if (toBeChanged === "volume") {
document.getElementById("volumerange").value = data["newData"];
}
}
async function checkSettings(skipServer=false) {
//check client stuff first so if the server doesn't exist it can still be changed and seen
if (ip.slice(-5)=="19054") {
@ -192,7 +326,16 @@ async function checkSettings(skipServer=false) {
qrCodeGenerate()
document.getElementById("alerttimetextbox").value = alertTime
partyButtonState = document.getElementById("partymode-button").innerHTML;
x = await getFromServer({setting: "getsettings"}, "settings");
let nodeList = document.getElementById("admincheckholder").children
// temporary
for (let i=0; i<nodeList.length;i++) {
if (nodeList[i].type == 'checkbox') {
nodeList[i].checked = true;
}
}
//ping the server here
data = await getFromServer({setting: "getsettings"}, "settings");
x = data["data"];
if (!(skipServer) || partyButtonState=="N/A") {
if (x["partymode"] == false) {
document.getElementById("partymode-button").innerHTML = "Off";
@ -205,20 +348,102 @@ async function checkSettings(skipServer=false) {
document.getElementById("partymode-button").innerHTML = "Off";
}
document.getElementById("volumerange").value = parseInt(x["volume"])
// do the admin checkboxes here
let currentAdminPerms = x["admin"];
document.getElementById("addsongsettingcheckbox").checked = currentAdminPerms["AS"];
document.getElementById("skipsongsettingcheckbox").checked = currentAdminPerms["SK"];
document.getElementById("playpausesettingcheckbox").checked = currentAdminPerms["PP"];
document.getElementById("partymodesettingcheckbox").checked = currentAdminPerms["PM"];
document.getElementById("volumechangesettingcheckbox").checked = currentAdminPerms["VOL"];
document.getElementById("duplicateallowesettingcheckbox").checked = currentAdminPerms["DUP"];
}
async function addToPlaylist(songObject) {
i = document.getElementById("playlist").children.length-1
let newItem = document.createElement("div");
newItem.className = "item";
newItem.id = Object.keys(songObject)[0];
newItem.tabIndex = 0;
let image = document.createElement("img");
try {
if (songObject[newItem.id]["art"] == null) {
throw "no image lolz"
}
image.src = songObject[newItem.id]["art"];
} catch(err){
image.src = "./images/placeholder.png";
}
image.id = String(songObject[newItem.id])+" image";
let head3 = document.createElement("h3");
head3.innerText = songObject[newItem.id]["title"];
let head4 = document.createElement("h4");
head4.innerText= songObject[newItem.id]["artist"];
let head5 = document.createElement("h5");
let timeLeft =document.createElement("h5");
timeLeft.style.fontWeight = 100;
if(i==0) {
// they can all have the text, doesn't really matter, but only the first one
// should get the ids since its the one we want to mess with
head5.id = "playing-indicator-text";
timeLeft.id = "elapsed-time-display";
}
let textdiv = document.createElement("div")
textdiv.className="text"
newItem.appendChild(image);
textdiv.appendChild(head3);
textdiv.appendChild(head4);
textdiv.appendChild(timeLeft);
textdiv.appendChild(head5);
newItem.appendChild(textdiv);
document.getElementById("playlist").appendChild(newItem);
try {
if (i == 0) { // Only the first song in the loop gets a time
head5.innerHTML="Playing";
playlistElapsedSeconds = playlist[0]["time"];
playlistSongLength = playlist[0]["length"];
displayElapsedPlaylistTime(playlistElapsedSeconds,playlistSongLength);
clearInterval(playlistTimeTimer);
}
} catch(e) {
console.log("I dunno something bad happened:"+e);
}
}
async function skipInPlaylist() {
playlistElapsedSeconds = 0;
let playlistChildren = document.getElementById("playlist").children;
if(playlistChildren[1].nodeName === "DIV") {
playlistChildren[1].remove();
}
playlistChildren = document.getElementById("playlist").children;
if(playlistChildren.length === 1) {
playlistChildren[0].innerText = "Nothing's Queued..."
} else {
let firstElementTextChildren = playlistChildren[1].children[1].children
// console.log(firstElementTextChildren);
firstElementTextChildren[2].id = "elapsed-time-display";
firstElementTextChildren[3].id = "playing-indicator-text";
firstElementTextChildren[3].textContent = "Playing";
}
displayElapsedPlaylistTime(playlistElapsedSeconds,playlistSongLength);
}
async function generateVisualPlaylist(conditions="") {
document.getElementById("playlist").innerHTML = "<h1 id=\"playlist-alert\"></h1>";
playlist = await getFromServer(null, "playlist");
data = await getFromServer(null, "playlist");
playlist = data["data"]["playlist"];
currentlyPlaying = data["data"]["playingState"]
playlist = Object.values(playlist).map(obj => {
const filename = Object.keys(obj)[0]; // Get the filename
const songData = obj[filename]; // Get the song metadata
return { filename, ...songData }; // Merge filename with song data
});
if (playlist.length==0){
clearInterval(playlistTimeTimer);
document.getElementById("playlist-alert").innerHTML = "Nothing's Queued..."
} else {
if (conditions=="skip-button") {
if (conditions==="skip-button") {
playlist.shift()
if (playlist.length==0){
document.getElementById("playlist-alert").innerHTML = "Nothing's Queued..."
@ -229,6 +454,7 @@ async function generateVisualPlaylist(conditions="") {
let newItem = document.createElement("div");
newItem.className = "item";
newItem.id = fileName;
newItem.tabIndex = 0;
let image = document.createElement("img");
try {
if (playlist[i]["art"] == null) {
@ -246,20 +472,11 @@ async function generateVisualPlaylist(conditions="") {
let head5 = document.createElement("h5");
let timeLeft =document.createElement("h5");
timeLeft.style.fontWeight = 100;
try {
if (i == 0) {
head5.innerHTML="Playing";
if ((conditions != "skip-button")) {
let mins = Math.floor(playlist[i]["time"]/60);
let secs = Math.floor(playlist[i]["time"]%60);
let durMins = Math.floor(playlist[i]["length"]/60);
let durSecs = Math.floor(playlist[i]["length"]%60);
timeLeft.innerHTML = mins.toString() +":"+ secs.toLocaleString('en-US', {minimumIntegerDigits: 2,useGrouping: false}) + "/"+ durMins.toString()+":"+durSecs.toLocaleString('en-US', {minimumIntegerDigits: 2,useGrouping: false});
}
}
}catch(err){
// i dont know why there's a try catch here but i'm leaving it i dont want to break something
console.log(err)
if(i== 0) {
// they can all have the text, doesn't really matter, but only the first one
// should get the ids since its the one we want to mess with
head5.id = "playing-indicator-text";
timeLeft.id = "elapsed-time-display";
}
let textdiv = document.createElement("div")
textdiv.className="text"
@ -270,36 +487,122 @@ async function generateVisualPlaylist(conditions="") {
textdiv.appendChild(head5);
newItem.appendChild(textdiv);
document.getElementById("playlist").appendChild(newItem);
try {
if (i == 0) { // Only the first song in the loop gets a time
head5.innerHTML="Playing";
if ((conditions != "skip-button")) {
playlistElapsedSeconds = playlist[0]["time"];
playlistSongLength = playlist[0]["length"];
displayElapsedPlaylistTime(playlistElapsedSeconds,playlistSongLength);
clearInterval(playlistTimeTimer);
}
}
}catch(err){
// i dont know why there's a try catch here but i'm leaving it i dont want to break something
console.error(err)
}
}
playlistTimeTimer = setInterval(() => {
displayElapsedPlaylistTime(playlistElapsedSeconds,playlistSongLength);
},1000)
}
}
async function submitSong(songid) {
getFromServer({song: songid}, "songadd")
alertText("Added to Queue")
let returncode = await getFromServer({song: songid}, "songadd");
if(returncode["status"] === ERR_NO_ADMIN) {
// right now the error is alerted in getFromServer, maybe will change that
} else if(returncode["status"]!==200) {
alertText("That song's already in the queue! Hang on!")
} else {
alertText("Added to Queue");
}
}
function checkWhatSongWasClicked(e) {
if(e.type == "click" || e.key == "Enter") {
itemId = e.srcElement.id;
if ((itemId.length-itemId.lastIndexOf("image") == 5) && itemId.lastIndexOf("image")!=-1) {
itemId = itemId.slice(0,-6)
}
let filenameSep = itemId.split('.')
//i feel like later kristy won't apreciate this
//one of my files was "file.MP3" so it didn't work
//windows be like
if (itemId.slice(-4).toLowerCase() == ".mp3") {
if (VALID_FILE_EXT.includes(filenameSep[filenameSep.length-1].toLowerCase())) {
submitSong(itemId);
}
}
}
function toggleDark(e) {
let x = document.getElementById("test-body").classList
if (!(x.contains("dark-mode"))) {
document.getElementById("darkmode-button").innerHTML = "On"
document.cookie = "darkmode=true; path=/;";
document.getElementById("darkmode-button").innerHTML = "On";
x.add("dark-mode");
} else {
document.getElementById("darkmode-button").innerHTML = "Off"
document.cookie = "darkmode=false; path=/;";
document.getElementById("darkmode-button").innerHTML = "Off";
x.remove("dark-mode");
}
qrCodeGenerate();
}
// async function sha256(message) {
// // Encode the message as UTF-8
// const msgBuffer = new TextEncoder().encode(message);
// // Hash the message
// const hashBuffer = await crypto.subtle.digest('SHA-256', msgBuffer);
// // Convert ArrayBuffer to hex string
// const hashArray = Array.from(new Uint8Array(hashBuffer));
// const hashHex = hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
// return hashHex;
// }
async function adminPassEnter(e) {
if (e.key == "Enter") {
e.preventDefault();
let enteredpass = document.getElementById("adminpasswordbox").value;
if(enteredpass === "") {
adminPass = ""; // an empty pass is technically meant to represent not having one
// this isn't stritly necesarry but i dont wanna break anything that might depend on this being true
} else {
adminPass= await sha256(document.getElementById("adminpasswordbox").value);
}
alertText("Admin Password Updated");
}
}
async function submitPerms(e) {
let tempData = {}
tempData["PP"] = document.getElementById("playpausesettingcheckbox").checked;
tempData["SK"] = document.getElementById("skipsongsettingcheckbox").checked;
tempData["AS"] = document.getElementById("addsongsettingcheckbox").checked;
tempData["PM"] = document.getElementById("partymodesettingcheckbox").checked;
tempData["VOL"] = document.getElementById("volumechangesettingcheckbox").checked;
tempData["DUP"] = document.getElementById("duplicateallowesettingcheckbox").checked;
let returncode = await getFromServer({"setting":"perms","admin":tempData},"settings");
if (!(returncode["ok"])) {
// if you aren't allowed to check the box then toggle it again
// its not perfect if you spam click, but it gets the point across to the user
let clickedBox = e.srcElement;
clickedBox.checked = !clickedBox.checked;
} else {
justChangedSetting = true;
}
}
async function clearPlaylist() {
let returncode = await getFromServer({control:"clear"},"controls");
if(returncode == ERR_NO_ADMIN || returncode == null) {
// alertText("Admin Restricted ")
// there's an admin restrict alert built into getFromServer
} else {
alertText("Playlist Cleared!");
}
}
let optionslist = []
@ -313,20 +616,31 @@ document.addEventListener('keydown', function(e){
}})
document.getElementById("playlist-mode").style.display = "none";
document.getElementById("settings-mode").style.display = "none";
//.ontouch for mobile??
document.getElementById("volumerange").onchange = async function() {
let returnValue = await getFromServer({setting:"volume",level:this.value}, "settings")
if (returnValue["volumePassed"] !=0) {
document.getElementById("volumerange").onchange = async function(e) {
// there is no reason for this not to be a defined function
// FIX THIS
let returnValue = await getFromServer({setting:"volume",level:e.target.value}, "settings")
if (returnValue["status"] == ERR_NO_ADMIN) {
// alertText("Error: Admin restricted action");
// there's an admin restrict alert built into getFromServer
// i wanna put the volume slider back to where it was but idk a good way to keep the previous volume
checkSettings(false);
} else if (returnValue["data"]["volumePassed"] !=0) {
// i forgot about this, i had to do this because it confused the crap out of me one time
// vlc doesn't let you change the volume of nothing, which makes sense if you think about it
alertText("Nothing is playing")
document.getElementById("volumerange").value = -1
}
else if (this.value == 0) {
} else if (this.value == 0) {
alertText("The volume is now set to 0 (Pause?)")
} else {
alertText("The volume is now set to " + this.value.toString())
}
}
//bit of a cheat code for clearing the alerts when they don't clear normally
document.getElementById("title").addEventListener('click',function(){document.getElementById("alert").innerHTML = ""})
document.getElementById("settings-button").addEventListener('click',function(){controlButton("st")});
document.getElementById("play-pause-button").addEventListener('click', function(){controlButton("pp")});
document.getElementById("playlist-button").addEventListener('click', function(){controlButton("pl")});
@ -336,18 +650,24 @@ document.getElementById("go-search").addEventListener('click', function(){search
document.getElementById("songsearch").addEventListener('keydown', function(e){searchSongsEnter(e)});
document.getElementById("iptextbox").addEventListener('keydown', function(e){ipSetEnter(e)});
document.getElementById("alerttimetextbox").addEventListener('keydown', function(e){alertTimeEnter(e)});
document.getElementById("adminpasswordbox").addEventListener('keydown',function(e){adminPassEnter(e)});
document.getElementById("admincheckholder").addEventListener('click',function(e){submitPerms(e)});
document.getElementById("partymode-button").addEventListener('click',function(){controlButton("pm")})
document.getElementById("darkmode-button").addEventListener('click',function(){toggleDark()})
document.getElementById("clear-button").addEventListener('click',function(){clearPlaylist()})
//sets the fact that clicking a song needs to return its id to the function to find it
document.getElementById("songlist").addEventListener('keydown', function(e){checkWhatSongWasClicked(e)});
document.getElementById("songlist").addEventListener('click', function(e){checkWhatSongWasClicked(e)});
//makes the controls look mostly normal on all screens, best solution i could find, idk man
let tempWidth = document.getElementById('controls').clientWidth;
document.getElementById("controls").style.marginLeft = "-"+String(parseInt(tempWidth/2))+"px";
// document.getElementById("darkmode-button").addEventListener('click',function(){toggleDark()})
// replaced this with "transform" css stuff
// let tempWidth = document.getElementById('controls').clientWidth;
// document.getElementById("controls").style.marginLeft = "-"+String(parseInt(tempWidth/2))+"px";
//for my use case (my immediate family), they dont know how to set an ip
//using this allows the creator of the link for, a qr code for example, to set the ip before distributing the code, and it would all work smoothly
//example (http://192.168.1.100:8000/?ip=192.168.1.100:19054 sets the ip to the same host at the default port)
//the port must be set manually using this method, but only has to be done once for the url that ends up being shared
let params = new URLSearchParams(location.search);
//tries the url first, then the cookie, then the default
ip = params.get("ip")
@ -357,6 +677,8 @@ if (ip == null || ip=="") {
if (ip==null || ip==""){
ip = ""
}
// saving the cookies (don't tell the EU)
document.cookie = "ip="+ip+"; path=/;"
alertTime = getCookie("alertTime")
@ -367,3 +689,42 @@ if (alertTime == "") {
}
// this is the code that makes the qr code at the very start
qrCodeGenerate()
// socket testing stuff
socket = io("http://"+ip,{
reconnectionAttemps: 5,
timeout: 10000,
});
socket.on("songAdd", function(data) {
// console.log("recieved data from songAdd");
// console.log(data);
addToPlaylist(data);
})
socket.on("timeUpdate", function(data) {
// console.log("recieved data from timeUpdate");
// console.log(data);
playlistElapsedSeconds = data["elapsedTime"];
currentlyPlaying = data["playingState"]
});
socket.on("skipSong",() => {
if(justSkipped === false) {
skipInPlaylist();
} else {
justSkipped = false;
}
})
socket.on("settingsChange",(data) => {
// console.log(data);
if(justChangedSetting) {
// console.log("working");
justChangedSetting = false;
} else {
// checkSettings();
updateSingleSetting(data);
}
});

View file

@ -1,20 +1,47 @@
/* testing */
/* dark mode stuff */
.dark-mode {
background-color: #333333;
color:#ffffff;
--bg-main: #333333;
--bg-item: #3f3f3f;
--bg-inputs: #2a2a2a;
--text-color: #ffffff;
/* -webkit-filter:invert(100%);
filter:progid:DXImageTransform.Microsoft.BasicImage(invert='1'); */
}
.dark-mode .control-button {
filter: invert(100%) brightness(0.9)
}
:root {
--bg-main: #eeeeee;
--bg-item: #dddddd;
--bg-inputs: #ffffff;
--text-color: #000000;
color: var(--text-color);
}
/* In hindsight i should have just used p's with classes to decide size, but whatever
Should probably fix that at some point, this is like the least accessible site ever */
h1,h2,h3,h4,h5,p,input,button,label {
color: var(--text-color);
}
input, button {
background-color: var(--bg-inputs);
}
/* Things that are always visible */
body {
background-color: #EEEEEE;
background-color: var(--bg-main);
}
* {
font-family: 'arial';
font-family: 'Arial',sans-serif;
}
.italic {
font-style: italic;
}
@ -35,7 +62,8 @@ h4 {
left: 50%;
bottom: 0;
margin: 0 auto;
background-color:inherit;
transform: translateX(-50%);
background-color:var(--bg-main);
}
.alert {
@ -44,23 +72,29 @@ h4 {
width: 100%;
text-align: center;
z-index: 1000;
background-color: #EEEEEEd6;
background-color: color-mix(in srgb, var(--bg-main), transparent 16%);
}
.settings-button {
width: 15%;
.settings-button-holder {
width:15%;
max-width: 90px;
position:fixed;
top:0;
right:0;
margin: 3px;
background:inherit;
background-color: var(--bg-main);
/* This is a circle background for the circle settings button
So it can display over other text and such */
border-radius: 50%;
}
.control-button{
.settings-button {
width: 100%;
}
.controls > .control-button{
width:20%;
max-width: 110px;
margin: auto 2%;
@ -72,22 +106,26 @@ h4 {
text-align: center;
}
.item {
/* Only actually applies to playlist and search because settings item has "inherit" bg-colour */
background-color: var(--bg-item);
}
/* Songlist stuff */
.songlist {
width: 80%;
min-width: 300px;
min-width: 400px;
margin:auto auto 150px;
display: flex;
flex-wrap: wrap;
}
.songlist > .item{
border: 1px solid #333333;
border: 1px solid var(--bg-item);
width:30%;
max-width: 150px;
margin: 5px auto;
min-width: 75px;
background-color: inherit;
}
.songlist > .item > img{
@ -98,6 +136,8 @@ h4 {
.songlist > .item > h3, .songlist > .item > h4{
margin-left: 2px;
margin-right: 2px;
margin: 5px;
word-wrap: break-word;
}
.searchbox-holder {
@ -109,11 +149,18 @@ h4 {
.searchbox {
width: 65%;
margin: 1px;
margin-bottom: 16px;
}
.go-search {
width: 20%;
min-width: 50px;
}
.lossless-tag {
width:16px;
padding: 1px;
margin-left: auto;
}
/* playlist mode stuff */
.playlist {
@ -123,7 +170,7 @@ h4 {
}
.playlist > .item{
border: 1px solid #333333;
border: 1px solid var(--bg-item);
display: flex;
max-width: 50em;
min-width: 200px;
@ -132,6 +179,7 @@ h4 {
}
.playlist > .item > .text {
padding: 3px;
display: inline-block;
margin: 0px 3px;
}
@ -146,7 +194,7 @@ h4 {
}
.playlist > .item > .text > * {
margin:5% 2px;
margin:2px;
}
/* settings stuff */
@ -160,12 +208,12 @@ h4 {
.settings > .item {
margin-left: 10%;
width:fit-content;
background-color: var(--bg-main);
}
.settings > .item:not(:last-child) {
padding-bottom: 10px;
border-bottom: 1px solid #333333;
border-bottom: 1px solid var(--bg-item);
}
.settings > .item.no-line {
@ -177,8 +225,16 @@ h4 {
border-bottom: 0;
}
.settings > .item > h2 {
margin-bottom: 4px;
}
.settings > .item > p {
margin-top: 0px
}
.versionNumber {
font-size: 8px;
font-size: 11px;
font-style: italic;
text-align: left;
width: 80%;

View file

@ -1,27 +1,29 @@
import os
from mutagen.easyid3 import EasyID3
from mutagen.mp3 import MP3
import mutagen.flac
import mutagen.wave
import sqlite3 as sql
import requests, ast, time, math, argparse
import requests, ast, time, math, argparse, dotenv, os
loading = ["-","\\","|","/"]
parser=argparse.ArgumentParser(description="Options for the generation of the song database")
parser.add_argument('-k','--apikey', help='String: LastFM api key', default="")
# parser.add_argument('-k','--apikey', help='String: LastFM api key', default="")
parser.add_argument('-m', '--mode', help='new/update: Remake database or update current', default= "update")
parser.add_argument('-a', '--art', help="True/False: Add art to the database using LastFm (takes minimum 0.25s per song)", default="True")
parser.add_argument('-d','--directory',help="Directory of the song files", default="./sound/")
args = parser.parse_args()
apikeylastfm = args.apikey
dotenv.load_dotenv()
apikeylastfm = os.getenv("API_KEY")
soundLocation = os.getenv("DIRECTORY")
# apikeylastfm = args.apikey
if args.directory[-1] == "/" or args.directory[-1] == "\\":
soundLocation = args.directory
elif "/" in args.directory:
soundLocation = args.directory + "/"
else:
soundLocation = args.directory + "\\"
# if you want to set the api key/sound directory permenantly for your setup just uncomment the next line
# apikeylastfm = "KeyHere"
# soundLocation = "directoryHere"
songFiles = os.listdir(soundLocation)
fileOfDB = sql.connect("songDatabase.db")
songDatabase = fileOfDB.cursor()
@ -33,7 +35,7 @@ except:
songDatabase.execute("UPDATE meta SET data = ? WHERE id = 'songDirectory'", (soundLocation,))
if args.mode.lower() == "update":
#Create if not exists
songDatabase.execute("CREATE TABLE IF NOT EXISTS songs (filename TEXT PRIMARY KEY, title TEXT, artist TEXT, art TEXT, length INTEGER);")
songDatabase.execute("CREATE TABLE IF NOT EXISTS songs (filename TEXT PRIMARY KEY, title TEXT, artist TEXT, art TEXT, length INTEGER, lossless INTEGER);")
songDatabase.execute("SELECT filename FROM songs;")
dBfilelist = songDatabase.fetchall()
dBfilelistSet = set()
@ -48,44 +50,61 @@ if args.mode.lower() == "update":
print("new songs: " + ", ".join(songFiles))
elif args.mode.lower()=="new":
songDatabase.execute("DROP TABLE IF EXISTS songs;")
songDatabase.execute("CREATE TABLE songs (filename TEXT PRIMARY KEY, title TEXT, artist TEXT, art TEXT, length INTEGER);")
songDatabase.execute("CREATE TABLE songs (filename TEXT PRIMARY KEY, title TEXT, artist TEXT, art TEXT, length INTEGER, lossless INTEGER);")
else:
raise ValueError("Must be \"new\" or \"update\"")
if args.art.lower() == "true" and not(args.apikey == ""):
x = len(songFiles)*0.25
if x > 60:
print("ETA "+ str(x/60) + " minutes")
if args.art.lower() == "true" and not(apikeylastfm == ""):
eta = len(songFiles)*0.25
if eta > 60:
print(f"ETA {eta/60:.2f} minutes")
else:
print("ETA "+ str(x) + " seconds")
print(f"ETA {eta} seconds")
# will be used soon
validFormats = ["mp3","flac","wav"]
for i in songFiles:
if i[-4:].lower() != ".mp3":
# skip any non-mp3's (like directories or cover art)
# songFiles is the list of filenames, so i is the filename of each song
global song
filenamesplit = i.split(".")
extension = filenamesplit[len(filenamesplit)-1]
lossless = 0 # sqlite doesn't have booleans. what is this, C?
if not(extension.lower() in validFormats):
# skip any non music files (like directories or cover art)
continue
try:
# get the metadata
if(extension.lower() == "mp3"):
song = EasyID3(soundLocation+i)
elif(extension.lower() == "flac"):
song = mutagen.flac.FLAC(soundLocation+i)
lossless = 1
elif(extension.lower() in ["wav","wave"]):
# Im actually pretty sure waves can't have metadata, but whatevz
song = mutagen.wave.WAVE(soundLocation+i)
lossless = 1
title = song['title'][0]
artist = song['artist'][0]
except:
if "_" in i:
# if metadata is missing, try to use file name following title_artist.mp3
# if metadata is missing, try to use file name following "title_artist.mp3"
song = i.split("_")
title = song[0]
artist = song[1].split(".")[0]
elif "-" in i:
# if there's no underscore, try artist - title.mp3
# if there's no underscore, try "artist - title.mp3"
song = i.split("-")
title = song[1].split(".")[0]
artist = song[0]
title = title.strip()
artist = artist.strip()
else:
#if the file is not formatted with an underscore, the title is the file name
#if the file is not formatted with an underscore or hyphen, the title is the file name
title = i
artist = None
if args.art.lower() == "true" and not(args.apikey == ""):
if args.art.lower() == "true" and not(apikeylastfm == "") and artist:
# and artist just means anything that only has the x.mp3 title won't bother to check since it'll never exist on last fm
try:
# get the images from last fm, try 2 different sizes
image = ast.literal_eval(requests.post(url="http://ws.audioscrobbler.com/2.0/?method=track.getInfo&api_key="+apikeylastfm+"&artist="+artist+"&track="+title+"&format=json").text)["track"]["album"]["image"][2]["#text"]
@ -93,21 +112,29 @@ for i in songFiles:
image = ast.literal_eval(requests.post(url="http://ws.audioscrobbler.com/2.0/?method=track.getInfo&api_key="+apikeylastfm+"&artist="+artist+"&track="+title+"&format=json").text)["track"]["album"]["image"][1]["#text"]
if image == "":
image = None
time.sleep(0.25)
time.sleep(0.01)
except:
image=None
else:
image=None
try:
length = math.ceil(MP3(soundLocation+i).info.length)
if extension.lower() in ['flac','wave','wav']:
length = math.ceil(song.info.length)
elif extension.lower() == "mp3":
# for some reason ID3 and mutagen.mp3 get different info
# artist and title are in id3() and length is in mp3()
# I dunno why
length = MP3(soundLocation+i).info.length
except:
length = 0
if len(songFiles) != 1:
index = (songFiles.index(i))%4
print("\r" + str(loading[index] + str(math.floor((songFiles.index(i)/(len(songFiles)-1))*100))+ "%"), end='', flush=True)
# each "song" is stored as a dictionary/JSON entry following the format seen in the readME
songDatabase.execute(f"INSERT INTO songs (filename, title, artist, art, length) VALUES (?,?,?,?,?)",(i,title,artist,image,length))
# each "song" is stored as a SQLite entry following the format seen below
songDatabase.execute(f"INSERT INTO songs (filename, title, artist, art, length, lossless) VALUES (?,?,?,?,?,?)",(i,title,artist,image,length,lossless))
songDatabase.execute("DROP TABLE IF EXISTS virtualSongs;")
songDatabase.execute("CREATE VIRTUAL TABLE virtualSongs USING fts5(filename, title, artist, art, length, lossless);")
songDatabase.execute("INSERT INTO virtualSongs SELECT * FROM songs;")
fileOfDB.commit()
fileOfDB.close()

7
Server/example.env Normal file
View file

@ -0,0 +1,7 @@
API_KEY=
DIRECTORY=./sound
SERVER_PORT=19054
#API_KEY = a lastfm api key
#Directory = either a relative or concrete directory, default is subdirectory "sound", should work on unix and windows
#server_port= the port for the webbybits.py flask server

View file

@ -1,14 +1,40 @@
import eventlet
eventlet.monkey_patch()
from flask import Flask
from flask import request
from flask_cors import CORS
from flask_socketio import SocketIO
import sqlite3 as sql
import vlc,threading,time,random, argparse
import vlc,threading,time,random,argparse,dotenv,os,hashlib,string
# Argparse Stuff
parser=argparse.ArgumentParser(description="Options for the Webby Bits")
# this is no longer needed assuming my file works correctly with the generator
# parser.add_argument('-d','--directory',help="Directory of the song files (make sure this matches the directory used for the databaseGenerator)", default="./sound/")
parser.add_argument('-p','--port',help="Port to host on, not the same as the web (client) port",default='19054')
portTheUserPicked=parser.parse_args().port
# parser.add_argument('-p','--port',help="Port to host on, not the same as the web (client) port",default='19054')
parser.add_argument('-a','--admin',help="Add an admin password to be used in the client. DO NOT use a password you use elsewhere",default="")
args = parser.parse_args()
dotenv.load_dotenv()
portTheUserPicked=os.getenv("SERVER_PORT")
ERR_NO_ADMIN = ({"error":"no-admin","data":None},401)
ERR_200 = ({"error":"OK","data":None},200)
ERR_MISSING_ARGS = ({"error":"Request missing required arguments","data":None}),400
if args.admin:
ADMIN_PASS = hashlib.sha256(bytes(args.admin,'utf-8')).hexdigest()
else:
tempPass = ''.join(random.choices(string.ascii_letters + string.digits +"?"+"!",k=20))
print("No adminPass was set, the auto generated one is: "+tempPass)
ADMIN_PASS = hashlib.sha256(bytes(tempPass,'utf-8')).hexdigest()
# True = everyone, False = admin only. Change in client while in use.
# play-pause,skip,addsong,partymode,volume in order
controlPerms = {
"PP":True,
"SK":True,
"AS":True,
"PM":True,
"VOL":True,
"DUP":True # Not implemented, allow duplicate songs in queue
}
fileofDB = sql.connect("songDatabase.db")
songDatabase = fileofDB.cursor()
@ -16,20 +42,15 @@ songDatabase = fileofDB.cursor()
#song directory
songDatabase.execute("SELECT * FROM meta WHERE id='songDirectory';")
soundLocation = songDatabase.fetchall()[0][1]
if soundLocation[-1] == "/" or soundLocation[-1] == "\\":
pass
elif "/" in soundLocation:
soundLocation += "/"
else:
soundLocation += "\\"
print(soundLocation)
#Create Virtual table for searching
songDatabase.execute("DROP TABLE virtualSongs;")
songDatabase.execute("CREATE VIRTUAL TABLE virtualSongs USING fts5(filename, title, artist, art, length);")
songDatabase.execute("INSERT INTO virtualSongs SELECT * FROM songs;")
fileofDB.commit()
fileofDB.close()
#I'm not sure why i don't do this in the databaseGenerator, but it also takes like 3 seconds so i'm not messing with it rn
#Initializing all the global stuff
random.seed()
global partyMode
@ -40,35 +61,69 @@ songNext = None
skipNow = False
playlist = []
playlistLock = threading.Lock()
fakeplayer = vlc.Instance()
player = fakeplayer.media_player_new()
vlcInstance = vlc.Instance()
player = vlcInstance.media_player_new()
# for client side volume to work as well as possible, set system volume to 100 and control in app
player.audio_set_volume(100)
app = Flask(__name__)
# because you are posting from another domain to this one, you need CORS
# because you are POSTing from another domain to this one, you need CORS
CORS(app)
# Replace the star with the frontend domain if you dislike being hacked
socketio = SocketIO(app, cors_allowed_origins="*")
def queueSong(song):
with playlistLock:
playlist.append(song)
socketio.emit("songAdd",getSongInfo(song))
def getSongInfo(song):
fileofDB = sql.connect("songDatabase.db")
songDatabase = fileofDB.cursor()
songDatabase.execute("SELECT * FROM songs WHERE filename = ?",[song])
result = songDatabase.fetchall()[0]
# again, this is still using the old JSON format to avoid client changes
k = {
"title": result[1],
"artist": result[2],
"art": result[3],
"length": result[4]
}
fileofDB.close()
return {song:k}
# this is a loop that plays the songs and checks for playlist changes, skips, ect.
counter = 0
isPlaying = False
def playQueuedSongs():
global skipNow
global songNext
global partyMode
global counter
global isPlaying
while True:
with playlistLock:
z = str(player.get_state())
if playlist and (z == "State.Ended" or z== "State.Stopped" or z == "State.NothingSpecial" or skipNow == True):
counter+=1
if(counter > 2):
playingState = str(player.get_state()) == "State.Playing"
socketio.emit('timeUpdate',{"elapsedTime":player.get_time()/1000,"playingState":playingState})
counter = 0
playerState = str(player.get_state())
endStates = ["State.Ended","State.Stopped","State.NothingSpecial"]
if playlist and (playerState in endStates or skipNow == True):
# New song is in the queue and (the previous song is over or skip has been pressed)
player.stop()
skipNow = False
songNext = playlist.pop(0)
media = fakeplayer.media_new(soundLocation+songNext)
media = vlcInstance.media_new(soundLocation+songNext)
player.set_media(media)
player.play()
elif (skipNow==True or (z == "State.Ended" or z == "State.NothingSpecial" or z=="State.Stopped")):
isPlaying = True
socketio.emit("skipSong",None)
elif (skipNow==True or (playerState in endStates)):
if(isPlaying):
socketio.emit("skipSong",None)
isPlaying = False
# print(playerState)
# skip was pressed and there are no new songs
skipNow=False
songNext = None
@ -79,83 +134,151 @@ def playQueuedSongs():
songDatabase.execute("SELECT * FROM songs ORDER BY RANDOM() LIMIT 1;")
result = songDatabase.fetchall()
# adds the random songs for party mode
# the above 2 means this only applies if (a song is playing (or paused)) and the queue is empty
# the above 2 means this only applies if (a song is playing or paused) and (the queue is empty)
playlist.append(result[0][0])
socketio.emit('songAdd',getSongInfo(result[0][0]))
# check for new songs every second
# I just didn't want to eat too much processing looping
# this also has another useful affect that skips get "queued" to only 1 per second, that way somebody usually can't skip twice accidentally
time.sleep(1)
# start the media player thread
queueThread = threading.Thread(target=playQueuedSongs)
queueThread.daemon = True
queueThread.start()
@socketio.on("connect")
def handleConnect():
pass
@app.route("/controls", methods=['POST'])
def playerControls():
# recieve control inputs (play/pause and skip) from the webUI
global skipNow
global media
global partyMode
recieveData=request.get_json(force=True)
if recieveData["control"] != None:
try:
if recieveData["control"] == "play-pause":
if ADMIN_PASS == recieveData['password'] or controlPerms["PP"]:
playingState = str(player.get_state())=="State.Playing"
player.pause()
return "200"
elif recieveData["control"] == "skip":
skipNow = True
# print(str(player.get_state()))
return "200"
return {"error":"ok","data":{"playingState":not(playingState)}},200
else:
return "400"
playingState = str(player.get_state())=="State.Playing"
return {"error":"Admin Restricted Action","data":{"playingState":playingState}},401
elif recieveData["control"] == "skip":
if ADMIN_PASS == recieveData['password'] or controlPerms["SK"]:
skipNow = True
return ERR_200
else:
return ERR_NO_ADMIN
# Maybe i should have put this next one in the "settings" section
elif recieveData["control"] == "clear":
if ADMIN_PASS == recieveData['password']: # this is only ever allowed with the adminpassword
with playlistLock:
playlist.clear()
return ERR_200
else:
return ERR_NO_ADMIN
else:
return {"error":"Not a valid control","data":None},400
except KeyError:
return ERR_MISSING_ARGS
@app.route("/settings", methods=['POST'])
def settingsControl():
global controlPerms
# set the volume and partymode
global partyMode
global player
recieveData = request.get_json(force=True)
try:
if recieveData["setting"] == "volume":
volumePassed = player.audio_set_volume(int(recieveData["level"]))
return {"volumePassed":volumePassed}
if ADMIN_PASS == recieveData['password'] or controlPerms["VOL"]:
volumeLevel = int(recieveData["level"])
if(volumeLevel <= 100 and volumeLevel >= 0):
volumePassed = player.audio_set_volume(volumeLevel)
if(volumePassed == 0):
# only emit a signal i the volume really changed
socketio.emit("settingsChange",{"settingToChange":"volume","newData":volumeLevel})
return {"error":"ok","data":{"volumePassed":volumePassed}},200
else:
return {"error":"Invalid volume level","data":None},422
else:
return ERR_NO_ADMIN
elif recieveData["setting"] == "partymode-toggle":
if ADMIN_PASS == recieveData['password'] or controlPerms["PM"]:
partyMode = not(partyMode)
return "200"
partyModeStr = "On" if partyMode else "Off"
socketio.emit("settingsChange",{"settingToChange":"partymode","newData":partyModeStr})
return ERR_200
else:
return ERR_NO_ADMIN
elif recieveData["setting"] == "perms":
if ADMIN_PASS == recieveData["password"]:
controlPerms = recieveData["admin"]
# print(recieveData["admin"])
socketio.emit("settingsChange",{"settingToChange":"perms","newData":controlPerms})
return ERR_200
else:
return ERR_NO_ADMIN
elif recieveData["setting"] == "getsettings":
# probably should have made this a different request type or something but it works
x = {"partymode":partyMode,"volume":player.audio_get_volume()}
return x
return {"error":"ok","data":{"partymode":partyMode,"volume":player.audio_get_volume(),"admin":controlPerms}},200
else:
return "400"
return {"error":"Not a valid setting","data":None},400
except:
return ERR_MISSING_ARGS
@app.route("/search", methods=['POST'])
def searchSongDB():
recieveData=request.get_json(force=True)
fileofDB = sql.connect("songDatabase.db")
songDatabase = fileofDB.cursor()
try:
results = []
# print(recieveData["search"])
if (recieveData['search'] == ""):
songDatabase.execute("SELECT * FROM virtualSongs")
results = songDatabase.fetchall()
else:
songDatabase.execute("SELECT * FROM virtualSongs WHERE virtualSongs MATCH ?",[recieveData['search']])
songDatabase.execute("SELECT * FROM virtualSongs WHERE virtualSongs MATCH ?",['"' + recieveData['search']+'"'])
results = songDatabase.fetchall()
tempdata = {}
# this is a temporary solution so i dont have to change the
# this is a temporary solution so i dont have to change the client
for i in results:
tempdata[i[0]] = {
"title": i[1],
"artist": i[2],
"art": i[3],
"length": i[4]
"length": i[4],
"lossless":i[5]
}
# print(tempData)
fileofDB.close()
return tempdata
return {"error":"ok","data":tempdata},200
except KeyError:
fileofDB.close()
return ERR_MISSING_ARGS
except sql.OperationalError as e:
print(e)
fileofDB.close()
return ({"error":"Database error (Try another search?)","data":None},500)
@app.route("/songadd", methods=["POST"])
def songadd():
recieveData=request.get_json(force=True)
try:
if (ADMIN_PASS == recieveData['password']) or controlPerms["AS"]:
# Password exists and is correct, or it's not restricted
if not(controlPerms["DUP"]) and (recieveData['song'] in playlist) and not(ADMIN_PASS == recieveData['password']):
return {"error":"This song is already in the queue, hang on!","data":None},409
else:
queueSong(recieveData['song'])
return "200"
return ERR_200
else:
# the password is incorrect (technically a password not existing falls into the above case because controlPerms is never changed)
return ERR_NO_ADMIN
except KeyError as e:
print(e)
return ERR_MISSING_ARGS
@app.route("/playlist", methods=["POST"])
def getPlaylist():
global songNext
@ -187,10 +310,19 @@ def getPlaylist():
"length": result[4]
}
tempPlaylist.append({i:k})
# print(tempPlaylist)
fileofDB.close()
return tempPlaylist
playingState = False
if(str(player.get_state())=="State.Playing"):
playingState = True
# print(playingState)
return {"error":"ok","data":{"playlist":tempPlaylist,"playingState":playingState}},200
if __name__ == "__main__":
app.run(host='0.0.0.0', port=portTheUserPicked)
# There's not really a whole lot of point to a main function for something like this, you'd never use any of these methods
# elsewhere, but its just good practice i guess
# start the media player thread
queueThread = threading.Thread(target=playQueuedSongs)
queueThread.daemon = True
queueThread.start()
socketio.run(app=app,host='0.0.0.0', port=portTheUserPicked)

View file

@ -10,24 +10,33 @@ The main advantage compared to doing something similar using Spotify is that you
### Client Setup:
The client is a web application that can be hosted on any server, it need not be the same device running the music player.
* If the app is being setup for a large group, you can distribute the url (via QR code, for example) with `?ip=YOURSERVERHOSTNAME:19054` set as an attribute after the url.
* You can also add `?darkmode=(true/false)` to set the default colour scheme, but this will be overwritten by the users saved choice in the cookie if they change it themselves
### Server Setup:
**Pre-setup:** If you want the songs to have art associated with them, it is all hosted on and retrieved from LastFM, and you will need to sign up for a developer app, and put your key in the database generator \
\
The server side consists of 3 files:
The server side consists of 3 files and a directory:
```
sound/
databaseGenerator.py
webbyBits.py
.env
```
1. Place mp3 files in the `sound/` folder
2. Open `databaseGenerator.py` and put your LastFM API key in at the top or at runtime using `-k APIKey` (*optional*)
3. Run `databaseGenerator.py`
2. Rename `example.env` to `.env` and...
- Set the location where your audio files are (Default: `./sound/`)
- Set the LastFM API key (Optional)
- Change the port of the webbybits server (Default: `19054` )
3. Run `databaseGenerator.py` (Will try to use LastFM API key)
* *The `databaseGenerator.py` will index all mp3 files, and save the information to `songDatabase.db`*
* *If getting images, this process may take a long time with a large amount of mp3 files*
4. Run `webbyBits.py`
* *The port can be customized at runtime using* `-p portNumber` *as an atribute*
* *The port can be customized by editing the `.env` file*
* *You can add an admin password at runtime with* `-a AdminPass` *as an atribute*
* ***NOTE: Do not reuse ANY password for this, it is hashed but 100% unsecure. The best option is just a random string you write down once***
* If this attribute isn't included a random string will be generated as the admin password
* This is intended for protecting certain features for small closed events, not for public security
You can now connect with the client and use the app as normal. \
*Make sure you have turned down/off any other apps that might make noise or notification sounds* \
@ -39,24 +48,31 @@ These are specific details on each section of the app, and how to use them
- `sound/` contains all mp3 files by default
- `databaseGenerator.py` scans through mp3 files and gets information about them
- `Filename, Title, Artist, Art, Length` are all saved
- *If the title and artist are not in the mp3 metadata, it looks for a format of* `TITLE_ARTIST.mp3` *then of* `ARTIST - TITLE.mp3` *and otherwise defaults to the file name as the title, and no artist*
- *If the title and artist are not in the file metadata, it looks for a format of* `TITLE_ARTIST.mp3` *then of* `ARTIST - TITLE.mp3` *and otherwise defaults to the file name as the title, and no artist*
- Art is retrieved from LastFM
- Running with `--mode (update/new)` either updates the current database and adds new songs/removes deleted songs, or recreates the entire database (update is default, and is faster in art mode)
- Running with `--art (True/False)` retrieves art from LastFM or doesn't (True is default)
- *Can only generate one song / 0.25 seconds, to avoid pinging the LastFM server too much*
- Running with `--apikey (KEYhere)` sets the LastFM key for that run
- If this is set to an empty string (Default) the app runs in non-art mode
- Running with `--directory (directoryOfmp3s)` allows for sound files to be in a different place
- Default `"./sound/"`
- _This setting might be kinda iffy on Linux. You're on Linux just go and edit it if you have issues_
- ~~__Make certain you only use forward slashes in your directory, even on Windows__~~ I think this should be fine now i'll check later
- Directory to index for music files can be set in the `.env` file
- `songDatabase.db` stores all the information about each song in a SQLite database with tables `songs` and `meta`
- `webbyBits.py` imports the database, runs all music playing, and accepts all commands from clients
- Searches return matching songs
- Accepts Play-Pause and Skip commands
- Uses port 19054 by default
- `--port (port)` changes the port for that run
- The default port can be changed in the file
- Can be changed in the `.env` file
- Running with `--admin (admin password)` sets an admin password for moderation on the client
- ***Note: Do not reuse a password, the password is hashed before being sent over the network, but I still wouldn't bet my house on it, no security is guaranteed***
- Anyone who knows the admin password can enter it on the client and change the abilities of any non-admin users (for example to limit skipping)
- The total set of features that can be restricted is
- Skip track
- Play-pause toggle
- Add track to queue
- Partymode toggle
- Change volume
- Add duplicate track to queue
- This is a seperate toggle, but is based on the setting "Add track to queue"
- Basically if you can't add at all, you can't add a duplicate either (obviously)
- When this argument is left out a random string is generated and printed in console to be the admin password (so keep the console window hidden if you don't want to use it)
### Client:
![image](./Screenshot_MAIN.png) \
@ -65,13 +81,30 @@ From left to right:
- The currently playing song is identified, and has the duration listed
- The play-pause button toggles playing
- The skip button goes to the next track
- *No "previous" button is a design decision (It's a feature not a bug)*
- The search button opens the search screen (pictured)
- The settings button (top right) opens the settings menu
- Dark mode sets a dark mode and stores a cookie to keep you in dark mode after refreshing
- Server IP allows you to change the ip that the site connects to
- Alert time changes how long error/confirmation messages are shown for (Default 2s)
- Party Mode adds new songs to the queue when the queue has only 1 song in it
- Volume controls the VLC volume of the connected server
- *Because the volume can be controlled in the client, for best usage set your device volume as high as possible and turn it down using this slider*
- QR code to allow others to connect to and use the Remote
- Admin password can be set to restrict actions for general users, or avoid the set restrictions
*See `LICENSE.md` for redistribution details.
### A quick note on the password feature
The exact process of the password's plaintext scope is as follows
- On the server, you type in the password on the server in the console, the python script takes that plaintext, hashes it, then stores that hash as a variable. The plaintext is also technically a variable, but it's not accessed after that initial hashing. (It's also going to be visible in your console history)
- On the client, you type in the password and press enter. A function reads the value of the password box, saves the hash of that password to a variable, and sends it with all your requests. The plaintext is still stored in the inputbox, but if you delete it and don't press enter on the box again, the hash will be stored without keeping the plaintext. (I may change this behaviour so this box auto-clears when enter is pressed, maybe)
None of this is "secure", but it's better than sending plaintext passwords, which is what I was doing before. Hypothetically somebody who intercepted your packet where you sent the password can't get back the original plaintext, just the hash.
## External Credits
- QR Code Generator: JS file found [here](https://cdnjs.cloudflare.com/ajax/libs/qrcodejs/1.0.0/qrcode.min.js)
- Cookie Popup: JS file found [here](https://cookieconsent.popupsmart.com/src/js/popper.js)
*See `LICENSE.md` for redistribution and editing details.*

View file

@ -1,16 +1,25 @@
blinker==1.8.2
certifi==2024.2.2
charset-normalizer==3.3.2
click==8.1.7
bidict==0.23.1
blinker==1.9.0
certifi==2026.1.4
charset-normalizer==3.4.4
click==8.3.1
colorama==0.4.6
Flask==3.0.3
Flask-Cors==4.0.1
idna==3.7
dotenv==0.9.9
Flask==3.1.2
flask-cors==6.0.2
Flask-SocketIO==5.6.0
h11==0.16.0
idna==3.11
itsdangerous==2.2.0
Jinja2==3.1.4
MarkupSafe==2.1.5
Jinja2==3.1.6
MarkupSafe==3.0.3
mutagen==1.47.0
python-vlc==3.0.20123
requests==2.32.2
urllib3==2.2.1
Werkzeug==3.0.3
python-dotenv==1.2.1
python-engineio==4.13.1
python-socketio==5.16.1
python-vlc==3.0.21203
requests==2.32.5
simple-websocket==1.1.0
urllib3==2.6.3
Werkzeug==3.1.5
wsproto==1.3.2

35
wishlist.md Normal file
View file

@ -0,0 +1,35 @@
# Wishlist
*Features I would like to add, will be completed in any order*
- [ ] Loading indicator while awaiting server stuff
- [ ] Refactoring existing code
- [x] Remove old comments
- [ ] Update the SQL -> Server -> Client pipeline when searching and building playlist
- [ ] Verify all if-else sequences are correct and not redundant
- [ ] Security Updates
- [x] `.env` file for the api keys and other runtime info to be set, rather than in the `.py` files
- [x] Hashing rather than plaintext sending passwords (that way at least the password text itself isn't transmitted over the network)
- [ ] Actually use SSL, for posting (CORS seems like an issue)
- [ ] Accessibility
- [ ] Better use of semantic HTML tags
- [ ] Full keyboard control (tab, enter to select, tab between control buttons)
- [ ] GUI update for client
- [x] Playlist items look cleaner
- [x] Dark mode
- [ ] New Icons
- [ ] Google material design (Not sure I want this anymore)
- [ ] "Credit" system so each client can only add a set number of songs
- Based on time period, number in queue, other possible ideas for credits
- Without a login system there's no easy way to give credits to specific clients (and a login is beyond scope of what I want to do)
- Potentially a "redemption code" system, which can be tracked client side
- All of this is very hackable without a server-side login.
## Completed Features
These will still be updated, but they're in a state that I am happy with them
- [x] Admin password
- [x] Websockets / some method of updating the time remaining to any client on the playlist screen
- [x] Set a timeout to change the time (to start)
- [x] Send updates to the playlist in real time when songs are added
- [x] Update the playlist's html without destroying it (create 1 new element)
- [x] Tell clients looking at the playlist when the song has been paused (so they can pause the local timers)
- [x] Settings updates
- [x] Without re-posting the server (contain update data in websocket ping)