Compare commits

..

No commits in common. "3.0" and "3.21.3" have entirely different histories.
3.0 ... 3.21.3

303 changed files with 44192 additions and 149393 deletions

View file

@ -1,45 +0,0 @@
/* ESLint Config */
module.exports = {
env: {
'es2017': true,
// others envs defined by cascading .eslintrc files
},
extends: 'eslint:recommended',
parser: '@babel/eslint-parser',
parserOptions: {
'sourceType': 'module',
},
rules: {
'brace-style': ['error','1tbs',{ 'allowSingleLine': true }],
'indent': [
'off', // temporary... a lot of stuff needs to be reformatted | 2020-08-21: I guess it's not so temporary...
4,
{ 'SwitchCase': 1 }
],
'linebreak-style': ['error','unix'],
'no-control-regex': ['off'],
'no-prototype-builtins': ['off'], // should consider cleaning up the code and turning this back on at some point
'no-trailing-spaces': ['error'],
'no-unused-vars': [
'error', {
'argsIgnorePattern': '^_',
'varsIgnorePattern': '^_|^Promise$'
}
],
'semi': ['error','always'],
'quotes': ['off'] // Old code uses double quotes, new code uses single / template
},
ignorePatterns: [
// These are not ours
'www/js/dash.all.min.js',
'www/js/jquery-1.12.4.min.js',
'www/js/jquery-ui.js',
'www/js/peertube.js',
'www/js/playerjs-0.0.12.js',
'www/js/sc.js',
'www/js/video.js',
'www/js/videojs-contrib-hls.min.js',
'www/js/videojs-dash.js',
'www/js/videojs-resolution-switcher.js',
],
}

10
.gitignore vendored
View file

@ -12,13 +12,3 @@ torlist
www/cache www/cache
google-drive-subtitles google-drive-subtitles
lib/ lib/
integration-test-config.json
conf/*.toml
www/js/cytube-google-drive.user.js
www/js/cytube-google-drive.meta.js
www/js/player.js
tor-exit-list.json
*.patch
examples/demo-bot/.env
mysql/
peertube-hosts.json

View file

@ -1,14 +0,0 @@
language: node_js
addons:
apt:
sources:
- ubuntu-toolchain-r-test
packages:
- gcc-9
- g++-9
env:
- CXX="g++-9"
node_js:
- "15"
- "14"
- "12"

View file

@ -1,18 +0,0 @@
FROM node:20
RUN apt update && apt install -y build-essential git wget
COPY ./ /app
WORKDIR /app
RUN rm -rf node_modules lib package-lock.json
RUN npm cache clean --force
RUN npm install
RUN /bin/sh /app/postinstall.sh
RUN npm run build-server
RUN npm rebuild
RUN wget https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -O /usr/local/bin/yt-dlp
RUN chmod a+rx /usr/local/bin/yt-dlp
CMD ["node", "index.js"]

View file

@ -1,6 +1,6 @@
/* /*
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2013-2022 Calvin Montgomery and contributors Copyright (c) 2013-2015 Calvin Montgomery and contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

391
NEWS.md
View file

@ -1,394 +1,3 @@
2022-09-21
==========
**Upgrade intervention required**
This release adds a feature to ban channels, replacing the earlier (hastily
added) configuration-based `channel-blacklist`. If you have any entries in
`channel-blacklist` in your `config.yaml`, you will need to migrate them to the
new bans table by using a command after upgrading (the ACP web interface hasn't
been updated for this feature):
./bin/admin.js ban-channel <channel-name> <external-reason> <internal-reason>
The external reason will be displayed when users attempt to join the banned
channel, while the internal reason is only displayed when using the
`show-channel-ban` command.
You can later use `unban-channel` to remove a ban. The owner of the banned
channel can still delete it, but the banned state will persist, so the channel
cannot be re-registered later.
2022-08-28
==========
This release integrates Xaekai's added support for Bandcamp, BitChute, Odysee,
and Nicovideo playback support into the main repository. The updated support
for custom fonts and audio tracks in custom media manifests is also included,
but does not work out of the box -- it requires a separate channel script; this
may be addressed in the future.
2021-08-14
==========
CyTube has been upgraded to socket.io v4 (from v2).
**Breaking change:** Newer versions of socket.io require CORS to validate the
origin initiating the socket connection. CyTube allows the origins specified in
the `io.domain` and `https.domain` configuration keys by default, which should
work for many use cases, however, if you host your website on a different domain
than the socket connection, you will need to configure the allowed origins (see
config.template.yaml under `io.cors`).
CyTube enables the `allowEIO3` configuration in socket.io by default, which
means that existing clients and bots using socket.io-client v2 should continue
to work.
2021-08-12
==========
The legacy metrics recorder (`counters.log` file) has been removed. For over 4
years now, CyTube has integrated with [Prometheus](https://prometheus.io/),
which provides a superior way to monitor the application. Copy
`conf/example/prometheus.toml` to `conf/prometheus.toml` and edit it to
configure CyTube's Prometheus support.
2021-08-12
==========
Due to changes in Soundcloud's authorization scheme, support has been dropped
from core due to requiring each server owner to register an API key (which is
currently impossible as they have not accepted new API key registrations for
*years*).
If you happen to already have an API key registered, or if Soundcloud reopens
registration at some point in the future, feel free to reach out to me for
patches to reintroduce support for it.
2020-08-21
==========
Some of CyTube's dependencies depends on features in newer versions of node.js.
Accordingly, node 10 is no longer supported. Administrators are recommended to
use node 12 (the active LTS), or node 14 (the current version).
2020-06-22
==========
Twitch has [updated their embed
player](https://discuss.dev.twitch.tv/t/twitch-embedded-player-migration-timeline-update/25588),
which adds new requirements for embedding Twitch:
1. The origin website must be served over HTTPS
2. The origin website must be served over the default port (i.e., the hostname
cannot include a port; https://example.com:8443 won't work)
Additionally, third-party cookies must be enabled for whatever internal
subdomains Twitch is using.
CyTube now sets the parameters expected by Twitch, and displays an error message
if it detects (1) or (2) above are not met.
2020-02-15
==========
Old versions of CyTube defaulted to storing channel state in flatfiles located
in the `chandump` directory. The default was changed a while ago, and the
flatfile storage mechanism has now been removed.
Admins who have not already migrated their installation to the "database"
channel storage type can do so by following these instructions:
1. Run `git checkout e3a9915b454b32e49d3871c94c839899f809520a` to temporarily
switch to temporarily revert to the previous version of the code that
supports the "file" channel storage type
2. Run `npm run build-server` to build the old version
3. Run `node lib/channel-storage/migrator.js |& tee migration.log` to migrate
channel state from files to the database
4. Inspect the output of the migration tool for errors
5. Set `channel-storage`/`type` to `"database"` in `config.yaml` and start the
server. Load a channel to verify the migration worked as expected
6. Upgrade back to the latest version with `git checkout 3.0` and `npm run
build-server`
7. Remove the `channel-storage` block from `config.yaml` and remove the
`chandump` directory since it is no longer needed (you may wish to archive
it somewhere in case you later discover the migration didn't work as
expected).
If you encounter any errors during the process, please file an issue on GitHub
and attach the output of the migration tool (which if you use the above commands
will be written to `migration.log`).
2019-12-01
==========
In accordance with node v8 LTS becoming end-of-life on 2019-12-31, CyTube no
longer supports v8.
Please upgrade to v10 or v12 (active LTS); refer to
https://nodejs.org/en/about/releases/ for the node.js support timelines.
2018-12-07
==========
Users can now self-service request their account to be deleted, and it will be
automatically purged after 7 days. In order to send a notification email to
the user about the request, copy the [email
configuration](https://github.com/calzoneman/sync/blob/3.0/conf/example/email.toml#L43)
to `conf/email.toml` (the same file used for password reset emails).
2018-10-21
==========
The `sanitize-html` dependency has made a change that results in `"` no longer
being replaced by `&quot;` when not inside an HTML attribute value. This
potentially breaks any chat filters matching quotes as `&quot;` (on my
particular instance, this seems to be quite rare). These filters will need to
be updated in order to continue matching quotes.
2018-08-27
==========
Support for node.js 6.x has been dropped, in order to bump the babel preset to
generate more efficient code (8.x supports async-await and other ES6+ features
natively and is the current node.js LTS).
If you are unable to upgrade to node.js 8.x, you can revert the changes to
package.json in this commit, however, be warned that I no longer test on 6.x.
2018-06-03
==========
## Dependency upgrades
In order to support node.js 10, the `bcrypt` dependency has been upgraded to
version 2. `bcrypt` version 2 defaults to the `$2b$` algorithm, whereas version
1 defaults to the `$2a$` algorithm. Existing password hashes will continue to
be readable, however hashes created with version 2 will not be readable by
version 1. See https://github.com/kelektiv/node.bcrypt.js for details.
In addition, the optional dependency on `v8-profiler` has been removed, since
this is not compatible with newer versions of v8.
## Supported node.js versions
In accordance with the node.js release schedule, node.js 4.x, 5.x, 7.x, and 9.x
are end-of-life and are no longer maintained upstream. Accordingly, these
versions are no longer supported by CyTube.
Please upgrade to 8.x (LTS) or 10.x (current). 6.x is still supported, but is
in the "maintenance" phase upstream, and should be phased out.
2018-01-07
==========
**Build changes:** When the `babel` dependency was first added to transpile ES6
code to ES5, an interactive prompt was added to the `postinstall` script before
transpilation, in case the user had made local modifications to the files in
`lib` which previously would have been detected as a git conflict when pulling.
It has now been sufficiently long that this is no longer needed, so I've removed
it. As always, users wishing to make local modifications (or forks) should edit
the code in `src/` and run `npm run build-server` to regenerate `lib/`.
This commit also removes the bundled `www/js/player.js` file in favor of having
`postinstall` generate it from the sources in `player/`.
2017-12-24
==========
As of December 2017, Vid.me is no longer in service. Accordingly, Vid.me
support in CyTube has been deprecated.
2017-11-27
==========
The Google Drive userscript has been updated once again. Violentmonkey is
now explicitly supported. Google login redirects are caught and handled.
See directly below on how to regenerate the user script again.
2017-11-15
==========
The Google Drive userscript has been updated due to breaking changes in
Greasemonkey 4.0. Remember to generate the script by running:
$ npm run generate-userscript "Your Site Name" http://your-site.example.com/r/*
2017-11-05
==========
The latest commit introduces a referrer check in the account page handlers.
This is added as a short-term mitigation for a recent report that account
management functions (such as deleting channels) can be executed without the
user's consent if placed in channel JS.
Longer term options are being considered, such as moving account management to a
separate subdomain to take advantage of cross-origin checks in browsers, and
requiring the user to re-enter their password to demonstrate intent. As always,
I recommend admins take extreme caution when accepting channel JS.
2017-09-26
==========
**Breaking change:** the `nodemailer` dependency has been upgraded to version
4.x. I also took this opportunity to make some modifications to the email
configuration and move it out of `config.yaml` to `conf/email.toml`.
To upgrade:
* Run `npm upgrade` (or `rm -rf node_modules; npm install`)
* Copy `conf/example/email.toml` to `conf/email.toml`
* Edit `conf/email.toml` to your liking
* Remove the `mail:` block from `config.yaml`
This feature only supports sending via SMTP for now. If there is demand for
other transports, feel free to open an issue or submit a pull request.
2017-09-19
==========
The `/useragreement` default page has been removed. Server administrators can
substitute their own terms of service page by editing `templates/footer.pug`
2017-09-19
==========
This commit removes an old kludge that redirected users to HTTPS (when enabled)
specifically for the account authorization pages (e.g., `/login`). The code for
doing this was to work around limitations that no longer exist, and does not
represent current security best practices.
The recommended solution to ensure that users are logged in securely (assuming
you've configured support for HTTPS) is to use
[Strict-Transport-Security](https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security)
to direct browsers to access the HTTPS version of the website at all times. You
can enable this by configuring a reverse proxy (e.g. nginx) in front of CyTube
to intercept HTTP traffic and redirect it to HTTPS, and add the
`Strict-Transport-Security` header when returning the response from CyTube.
2017-07-22
==========
Support for the old version of Vimeo's OAuth API (the `vimeo-oauth`
configuration block) has been dropped. It's unlikely anyone was using this,
since you haven't been able to register new API keys for it in years (it was
superseded by a newer OAuth API, which CyTube does not support), and in fact I
lost my credentials for this API and no longer have a way to test it.
Vimeo videos can still be added -- the metadata will be queried from the
anonymous API which has been the default since the beginning.
2017-07-17
==========
The `stats` database table and associated ACP subpage have been removed in favor
of integration with [Prometheus](https://prometheus.io/). You can enable
Prometheus reporting by copying `conf/example/prometheus.toml` to
`conf/prometheus.toml` and editing it to your liking. I recommend integrating
Prometheus with [Grafana](https://grafana.com/) for dashboarding needs.
The particular metrics that were saved in the `stats` table are reported by the
following Prometheus metrics:
* Channel count: `cytube_channels_num_active` gauge.
* User count: `cytube_sockets_num_connected` gauge (labeled by socket.io
transport).
* CPU/Memory: default metrics emitted by the
[`prom-client`](https://github.com/siimon/prom-client) module.
More Prometheus metrics will be added in the future to make CyTube easier to
monitor :)
2017-07-15
==========
The latest commit upgrades `socket.io` to version 2.0, a major version change
from 1.4. This release improves performance by switching to `uws` for the
websocket transport, and fixes several bugs; you can read about it
[here](https://github.com/socketio/socket.io/releases/tag/2.0.0).
For browser clients, the upgrade should basically just work with no
intervention. For node.js clients, all that is needed is to upgrade
`socket.io-client` to 2.0. For other clients, work required may vary depending
on whether the implementation has compatibility problems with 2.0.
2017-06-20
==========
The latest commit drops support for node.js versions below 6 (the [current
LTS](https://github.com/nodejs/LTS#lts-schedule1)). This is to allow the babel
preset to avoid generating inefficient code to polyfill ES2015+ features that
are now implemented in the node.js core.
New versions of node.js can be downloaded from the [node.js
website](https://nodejs.org/en/download/), if they are not already available in
your distribution's package manager.
2017-03-20
==========
Polls are now more strictly validated, including the number of options. The
default limit is 50 options, which you can configure via `poll.max-options`.
2017-03-11
==========
Commit f8183bea1b37154d79db741ac2845adf282e7514 modifes the schema of the
`users` table to include a new column (`name_dedupe`) which has a `UNIQUE`
constraint. This column is populated with a modified version of the user's name
to prevent the registration of usernames which are bitwise distinct but visually
similar. 'l', 'L', and '1' are all mapped to '1'; 'o', 'O', and '0' are all
mapped to '0'; '\_' and '-' are mapped to '\_'. On first startup after
upgrading, the new column will be added and populated.
This replaces the earlier solution which was put in place to mitigate PR#489 but
was overly-restrictive since it wildcarded these characters against *any*
character, not just characters in the same group.
2017-03-03
==========
The dependency on `sanitize-html`, which previously pointed to a fork, has now
been switched back to the upstream module. XSS filtering has been turned off
for the chat filter replacement itself (since this provides no additional
security), and is now only run on the final chat message after filtering.
Certain chat filters and MOTDs which relied on syntactically incorrect HTML,
such as unclosed tags, may have different behavior now, since `sanitize-html`
fixes these.
2016-11-02
==========
After upgrading the dependency on `yamljs`, you may see this error if you didn't
notice and correct a typo in the config.yaml template:
Error loading config file config.yaml:
{ [Error: Unexpected characters near ",".]
message: 'Unexpected characters near ",".',
parsedLine: 88,
snippet: 'title: \'CyTube\',' }
The fix is to edit config.yaml and remove the trailing comma for the `title:`
property under `html-template`. If there are other syntax errors that the old
version didn't detect, you will need to correct those as well.
Longer term, I am looking to move away from using `yamljs` to parse
configuration because it's a little buggy and the current configuration system
is confusing.
2016-10-20
==========
Google Drive changed the URL schema for retrieving video metadata, which broke
CyTube's Google Drive support, even with the userscript. I have updated the
userscript source with the new URL, so server administrators will have to
regenerate the userscript for their site and users will be prompted to install
the newer version.
Additionally, fixing Drive lookups required an update to the `mediaquery`
module, so you will have to do an `npm install` to pull that fix in.
2016-08-23 2016-08-23
========== ==========

109
README.md
View file

@ -1,46 +1,91 @@
CyTube Read before submitting an issue: https://github.com/calzoneman/sync/wiki/Reporting-an-Issue
====== ===========================================================================================
CyTube is a project I started in early 2013 as a hobby project to build my own calzoneman/sync
clone of synchtube.com (which shut down in March 2013). ===============
The basic concept is that users register channels where connected viewers can About
watch videos from different video hosts (e.g., YouTube, Twitch) and the playback -----
is synchronized for all the viewers in the channel.
Each channel has a playlist where users can queue up videos to play, as well as CyTube is a web application providing media synchronization, chat, and more for an arbitrary number of channels.
an integrated chatroom for discussion. I began developing this as a hobby project, and when synchtube.com announced their closure, I
began polishing it and readying it for the public.
The official server is located at https://cytu.be, but there are other public I am hosting a CyTube server at http://cytu.be
servers hosted for various communities.
## Installation The serverside is written in JavaScript and runs on Node.JS. It makes use
of a MySQL database to store user registrations, cached media metadata, and
data about each channel.
The installation guide for server administrators is located [on the The clientside is written in JavaScript and makes use of Socket.IO and
wiki](https://github.com/calzoneman/sync/wiki/CyTube-3.0-Installation-Guide). jQuery as well as the APIs for various media providers.
The web interface uses Bootstrap for layout and styling.
## Contact Features
--------
- Standalone web/socket.io server
- Optional SSL support for socket.io and the account API
- Synchronized playback from the following sources:
- YouTube (individual videos + playlists)
- Google Docs videos
- Vimeo
- Dailymotion
- Soundcloud
- Raw video/audio files (via video.js)
- Embedding of the following sources:
- livestream.com
- twitch.tv
- justin.tv
- ustream.tv
- RTMP streams
- Custom `<iframe>` and `<object>` embeds
- Channel customization
- HTML Message of the Day
- CSS
- JavaScript
- Permissions
- Tiered ranks (Site admin > Channel admin > Moderator > Leader > Member > Guest > Anonymous)
- Chat filters (based on regular expressions)
- Lock/unlock playlist to allow additions by non-moderators (configurable with permissions)
- Searchable library of videos
- Integrated YouTube search
- Save/load playlists per user account
- Polls
- Voteskip (can be disabled by a channel moderator)
- Auto-AFK status (can be configured per-channel)
- Leader
- Grants control of playback to a user (can pause/seek)
- Can also be used to grant temporary mod-like powers to a user
- Not necessary for synchronization as the server has an internal timer
- Channel state saves/loads on restart
- Account management
- Password change
- Password reset (via email)
- Profile avatar and text
- Moderation
- Mute users
- Kick users
- Ban users by name
- Ban users by IP address (and by /24 range)
- Administration
- Log viewer
- Global bans
- Search registered channels and users
- Currently loaded channels
- Stats (usercount, channelcount, RAM usage)
**Please check if the Installing
[FAQ](https://github.com/calzoneman/sync/wiki/Frequently-Asked-Questions) ----------
answers your question already.**
For bug reports and feature requests, please open a GitHub issue. To report a Installation instructions are available here: https://github.com/calzoneman/sync/wiki/CyTube-3.0-Installation-Guide
security vulnerability, or to discuss an issue with https://cytu.be itself
(unrelated to the code), please send me an email: cyzon@cytu.be
Please be courteous and search through [the open and closed
issues](https://github.com/calzoneman/sync/issues?utf8=%E2%9C%93&q=is%3Aissue)
for your request before submitting a new one.
General help with the software and the website is also available on the IRC Feedback
channel at [irc.esper.net#cytube](http://webchat.esper.net/?channels=cytube) --------
during US daytime hours.
## License Please open a GitHub Issue.
Original source code in this repository is provided under the MIT license License
(see the LICENSE file for the full text). -------
Bundled source code, such as third-party CSS and JavaScript libraries, are Licensed under MIT. See LICENSE for the full license text.
provided under their respective licenses.

View file

@ -1,176 +0,0 @@
#!/usr/bin/env node
const Config = require('../lib/config');
Config.load('config.yaml');
if (!Config.get('service-socket.enabled')){
console.error('The Service Socket is not enabled.');
process.exit(1);
}
const net = require('net');
const path = require('path');
const readline = require('node:readline/promises');
const socketPath = path.resolve(__dirname, '..', Config.get('service-socket.socket'));
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout
});
async function doCommand(params) {
return new Promise((resolve, reject) => {
const client = net.createConnection(socketPath);
client.on('connect', () => {
client.write(JSON.stringify(params) + '\n');
});
client.on('data', data => {
client.end();
resolve(JSON.parse(data));
});
client.on('error', error => {
reject(error);
});
});
}
let commands = [
{
command: 'ban-channel',
handler: async args => {
if (args.length !== 3) {
console.log('Usage: ban-channel <name> <externalReason> <internalReason>');
process.exit(1);
}
let [name, externalReason, internalReason] = args;
let answer = await rl.question(`Ban ${name} with external reason "${externalReason}" and internal reason "${internalReason}"? `);
if (!/^[yY]$/.test(answer)) {
console.log('Aborted.');
process.exit(1);
}
let res = await doCommand({
command: 'ban-channel',
name,
externalReason,
internalReason
});
switch (res.status) {
case 'error':
console.log('Error:', res.error);
process.exit(1);
break;
case 'success':
console.log('Ban succeeded.');
process.exit(0);
break;
default:
console.log(`Unknown result: ${res.status}`);
process.exit(1);
break;
}
}
},
{
command: 'unban-channel',
handler: async args => {
if (args.length !== 1) {
console.log('Usage: unban-channel <name>');
process.exit(1);
}
let [name] = args;
let answer = await rl.question(`Unban ${name}? `);
if (!/^[yY]$/.test(answer)) {
console.log('Aborted.');
process.exit(1);
}
let res = await doCommand({
command: 'unban-channel',
name
});
switch (res.status) {
case 'error':
console.log('Error:', res.error);
process.exit(1);
break;
case 'success':
console.log('Unban succeeded.');
process.exit(0);
break;
default:
console.log(`Unknown result: ${res.status}`);
process.exit(1);
break;
}
}
},
{
command: 'show-banned-channel',
handler: async args => {
if (args.length !== 1) {
console.log('Usage: show-banned-channel <name>');
process.exit(1);
}
let [name] = args;
let res = await doCommand({
command: 'show-banned-channel',
name
});
switch (res.status) {
case 'error':
console.log('Error:', res.error);
process.exit(1);
break;
case 'success':
if (res.ban != null) {
console.log(`Channel: ${name}`);
console.log(`Ban issued: ${res.ban.createdAt}`);
console.log(`Banned by: ${res.ban.bannedBy}`);
console.log(`External reason:\n${res.ban.externalReason}`);
console.log(`Internal reason:\n${res.ban.internalReason}`);
} else {
console.log(`Channel ${name} is not banned.`);
}
process.exit(0);
break;
default:
console.log(`Unknown result: ${res.status}`);
process.exit(1);
break;
}
}
}
];
let found = false;
commands.forEach(cmd => {
if (cmd.command === process.argv[2]) {
found = true;
cmd.handler(process.argv.slice(3)).then(() => {
process.exit(0);
}).catch(error => {
console.log('Error in command:', error.stack);
});
}
});
if (!found) {
console.log('Available commands:');
commands.forEach(cmd => {
console.log(` * ${cmd.command}`);
});
process.exit(1);
}

View file

@ -1,52 +0,0 @@
#!/usr/bin/env node
var coffee = require('coffeescript');
var fs = require('fs');
var path = require('path');
var order = [
'base.coffee',
'dailymotion.coffee',
'niconico.coffee',
'peertube.coffee',
'soundcloud.coffee',
'twitch.coffee',
'vimeo.coffee',
'youtube.coffee',
// playerjs-based players
'playerjs.coffee',
'iframechild.coffee',
'odysee.coffee',
'whepplayer.coffee',
'streamable.coffee',
// iframe embed-based players
'embed.coffee',
'custom-embed.coffee',
'livestream.com.coffee',
'twitchclip.coffee',
// video.js-based players
'videojs.coffee',
'gdrive-player.coffee',
'hls.coffee',
'raw-file.coffee',
'rtmp.coffee',
// mediaUpdate handler
'update.coffee'
];
var buffer = '';
order.forEach(function (file) {
buffer += fs.readFileSync(
path.join(__dirname, '..', 'player', file)
) + '\n';
});
fs.writeFileSync(
path.join(__dirname, '..', 'www', 'js', 'player.js'),
coffee.compile(buffer)
);

32
build-player.js Normal file
View file

@ -0,0 +1,32 @@
var coffee = require('coffee-script');
var fs = require('fs');
var path = require('path');
var order = [
'base.coffee',
'vimeo.coffee',
'youtube.coffee',
'dailymotion.coffee',
'videojs.coffee',
'gdrive-player.coffee',
'raw-file.coffee',
'soundcloud.coffee',
'embed.coffee',
'twitch.coffee',
'livestream.com.coffee',
'custom-embed.coffee',
'rtmp.coffee',
'hitbox.coffee',
'ustream.coffee',
'imgur.coffee',
'gdrive-youtube.coffee',
'hls.coffee',
'update.coffee'
];
var buffer = '';
order.forEach(function (file) {
buffer += fs.readFileSync(path.join('player', file)) + '\n';
});
fs.writeFileSync(path.join('www', 'js', 'player.js'), coffee.compile(buffer));

View file

@ -1,15 +0,0 @@
# Configuration for proxying images to a camo (or camo-compatible) proxy server.
# To use, copy to conf/camo.toml.
# More info on camo: https://github.com/atmos/camo
[camo]
enabled = true
server = 'https://my-camo-server'
# The key must match the `CAMO_KEY` environment variable passed to the camo server.
key = 'ABCDEFGH'
# Bypass the proxy for domains you trust that already support HTTPS and won't be harmful to users.
whitelisted-domains = [
'i.imgur.com',
'i.4cdn.org'
]
# Whether to use URL encoding ("url") or hex encoding ("hex") for the target URL.
encoding = 'url'

View file

@ -1,9 +0,0 @@
[hcaptcha]
# Site key from hCaptcha. The value here by default is the dummy test key for local testing
site-key = "10000000-ffff-ffff-ffff-000000000001"
# Secret key from hCaptcha. The value here by default is the dummy test key for local testing
secret = "0x0000000000000000000000000000000000000000"
[register]
# Whether to require a captcha for registration
enabled = true

View file

@ -1,66 +0,0 @@
# SMTP configuration for sending mail
[smtp]
host = 'smtp.gmail.com'
port = 465
secure = true
user = 'some-user@example.com'
password = 'secretpassword'
# Email configuration for password reset emails
# Be sure to update both html-template AND text-template
# nodemailer will send both and the email client will render whichever one is supported
[password-reset]
enabled = true
# Template to use for HTML-formatted emails
# $user$ will be replaced by the username for which the reset was requested
# $url$ will be replaced by the password reset confirmation link
html-template = """
Hi $user$,<br>
<br>
A password reset was requested for your account on CHANGE ME. You can complete the reset by opening the following link in your browser: <a href="$url$">$url$</a><br>
<br>
This link will expire in 24 hours.<br>
<br>
This email address is not monitored for replies. For assistance with password resets, please <a href="http://example.com/contact">contact an administrator</a>.
"""
# Template to use for plaintext emails
# Same substitutions as the HTML template
text-template = """
Hi $user$,
A password reset was requested for your account on CHANGE ME. You can complete the reset by opening the following link in your browser: $url$
This link will expire in 24 hours.
This email address is not monitored for replies. For assistance with password resets, please contact an administrator. See http://example.com/contact for contact information.
"""
from = "Example Website <website@example.com>"
subject = "Password reset request"
# Email configuration for account deletion request notifications
[delete-account]
enabled = true
html-template = """
Hi $user$,
<br>
<br>
Account deletion was requested for your account on CHANGE ME. Your account will be automatically deleted in 7 days without any further action from you.
<br>
<br>
This email address is not monitored for replies. For assistance, please <a href="http://example.com/contact">contact an administrator</a>.
"""
text-template = """
Hi $user$,
Account deletion was requested for your account on CHANGE ME. Your account will be automatically deleted in 7 days without any further action from you.
This email address is not monitored for replies. For assistance, please contact an administrator. See http://example.com/contact for contact information.
"""
from = "Example Website <website@example.com>"
subject = "Account deletion request"

View file

@ -1,14 +0,0 @@
# Configuration for binding an HTTP server to export prometheus metrics.
# See https://prometheus.io/ and https://github.com/siimon/prom-client
# for more details.
[prometheus]
enabled = true
# Host, port to bind. This is separate from the main CyTube HTTP server
# because it may be desirable to bind a different IP/port for monitoring
# purposes. Default: localhost port 19820 (arbitrary port chosen not to
# conflict with existing prometheus exporters).
host = '127.0.0.1'
port = 19820
# Request path to serve metrics. All other paths are rejected with
# 400 Bad Request.
path = '/metrics'

View file

@ -1,15 +1,14 @@
# MySQL server details # MySQL server details
# server: domain, IP or unix socket path of MySQL server. If a unix socket, it be like so `unix:/path/to/sock.sock` # server: domain or IP of MySQL server
# database: a MySQL database that the user specified has read/write access to # database: a MySQL database that the user specified has read/write access to
# user: username to authenticate as # user: username to authenticate as
# password: password for user # password: password for user
mysql: mysql:
server: 'mysql' server: 'localhost'
port: 3306 port: 3306
database: 'cytube3' database: 'cytube3'
user: 'cytube3' user: 'cytube3'
password: 'strong-password-here' password: ''
pool-size: 10
# Define IPs/ports to listen on # Define IPs/ports to listen on
# Each entry MUST define ip and port (ip can be '' to bind all available addresses) # Each entry MUST define ip and port (ip can be '' to bind all available addresses)
@ -48,6 +47,7 @@ http:
# one port must be specified as default for the purposes of generating # one port must be specified as default for the purposes of generating
# links with the appropriate port # links with the appropriate port
default-port: 8080 default-port: 8080
domain: 'http://localhost'
# Specifies the root domain for cookies. If you have multiple domains # Specifies the root domain for cookies. If you have multiple domains
# e.g. a.example.com and b.example.com, the root domain is example.com # e.g. a.example.com and b.example.com, the root domain is example.com
root-domain: 'localhost' root-domain: 'localhost'
@ -69,9 +69,6 @@ http:
index: index:
# Maximum number of channels to display on the index page public channel list # Maximum number of channels to display on the index page public channel list
max-entries: 50 max-entries: 50
# Configure trusted proxy addresses to map X-Forwarded-For to the client IP.
# See also: https://github.com/jshttp/proxy-addr
trust-proxies: ['loopback']
# HTTPS server details # HTTPS server details
https: https:
@ -86,11 +83,15 @@ https:
certfile: 'localhost.cert' certfile: 'localhost.cert'
cafile: '' cafile: ''
ciphers: 'HIGH:!DSS:!aNULL@STRENGTH' ciphers: 'HIGH:!DSS:!aNULL@STRENGTH'
# Allow certain account pages to redirect to HTTPS if HTTPS is enabled.
# You may want to set this to false if you are reverse proxying HTTPS to a
# non-HTTPS address.
redirect: true
# Page template values # Page template values
# title goes in the upper left corner, description goes in a <meta> tag # title goes in the upper left corner, description goes in a <meta> tag
html-template: html-template:
title: 'Sync' title: 'CyTube',
description: 'Free, open source synchtube' description: 'Free, open source synchtube'
# Socket.IO server details # Socket.IO server details
@ -107,38 +108,50 @@ io:
default-port: 1337 default-port: 1337
# limit the number of concurrent socket connections per IP address # limit the number of concurrent socket connections per IP address
ip-connection-limit: 10 ip-connection-limit: 10
cors: # Whether or not to use zlib to compress each socket message (this option is
# Additional origins to allow socket connections from (io.domain and # passed through to socket.io/engine.io).
# https.domain are included implicitly). # Note that while this may save a little bandwidth, it also consumes a lot
allowed-origins: [] # more CPU and will bottleneck pretty quickly under heavy load.
per-message-deflate: false
# Mailer details (used for sending password reset links)
# see https://github.com/andris9/Nodemailer
mail:
enabled: false
config:
service: 'Gmail'
auth:
user: 'some.user@gmail.com'
pass: 'supersecretpassword'
from-address: 'some.user@gmail.com'
from-name: 'CyTube Services'
# YouTube v3 API key # YouTube v3 API key
# 1. Go to https://console.developers.google.com/, create a new "project" (or choose an existing one) # See https://developers.google.com/youtube/registering_an_application
# 2. Make sure the YouTube Data v3 API is "enabled" for your project: https://console.developers.google.com/apis/library/youtube.googleapis.com # YouTube links will not work without this!
# 3. Go to "Credentials" on the sidebar of https://console.developers.google.com/, click "Create credentials" and choose type "API key" # Instructions:
# 4. Optionally restrict the key for security, or just copy the key. # 1. Go to https://console.developers.google.com/project
# 5. Test your key (may take a few minutes to become active): # 2. Create a new API project
# # 3. On the left sidebar, click "Credentials" under "APIs & auth"
# $ export YOUTUBE_API_KEY="your key here" # 4. Click "Create new Key" under "Public API access"
# $ curl "https://www.googleapis.com/youtube/v3/search?key=$YOUTUBE_API_KEY&part=id&maxResults=1&q=test+video&type=video" # 5. Click "Server key"
# 6. Under "APIs & auth" click "YouTube Data API" and then click "Enable API"
youtube-v3-key: '' youtube-v3-key: ''
# Minutes between saving channel state to disk
channel-save-interval: 5
# Limit for the number of channels a user can register # Limit for the number of channels a user can register
max-channels-per-user: 5 max-channels-per-user: 5
# Limit for the number of accounts an IP address can register # Limit for the number of accounts an IP address can register
max-accounts-per-ip: 5 max-accounts-per-ip: 5
# Minimum number of seconds between guest logins from the same IP # Minimum number of seconds between guest logins from the same IP
guest-login-delay: 60 guest-login-delay: 60
# Maximum character length of a chat message, capped at 1000 characters
max-chat-message-length: 320
# Allows you to customize the path divider. The /r/ in http://localhost/r/yourchannel # Configure statistics tracking
# Acceptable characters are a-z A-Z 0-9 _ and - stats:
channel-path: 'r' # Interval (in milliseconds) between data points - default 1h
# Allows you to blacklist certain channels. Users will be automatically kicked interval: 3600000
# upon trying to join one. # Maximum age of a datapoint (ms) before it is deleted - default 24h
channel-blacklist: [] max-age: 86400000
# Minutes between saving channel state to disk
channel-save-interval: 5
# Configure periodic clearing of old alias data # Configure periodic clearing of old alias data
aliases: aliases:
@ -150,6 +163,16 @@ aliases:
# Workaround for Vimeo blocking my domain # Workaround for Vimeo blocking my domain
vimeo-workaround: false vimeo-workaround: false
# OPTIONAL: Use Vimeo's OAuth API instead of the anonymous API.
# This allows you to add private videos that have embedding enabled.
# See https://developer.vimeo.com/apps/new to register for this API.
# Note that in order to use this feature you must agree to Vimeo's
# Terms of Service and License Agreement.
vimeo-oauth:
enabled: false
consumer-key: ''
secret: ''
# Regular expressions for defining reserved user and channel names and page titles # Regular expressions for defining reserved user and channel names and page titles
# The list of regular expressions will be joined with an OR, and compared without # The list of regular expressions will be joined with an OR, and compared without
# case sensitivity. # case sensitivity.
@ -167,12 +190,10 @@ reserved-names:
pagetitles: [] pagetitles: []
# Provide a contact list for the /contact page # Provide a contact list for the /contact page
# Example: contacts:
# contacts: - name: 'calzoneman'
# - name: 'my_name' title: 'Developer'
# title: 'administrator email: 'cyzon@cytu.be'
# email: 'me@my.site'
contacts: []
playlist: playlist:
max-items: 4000 max-items: 4000
@ -184,6 +205,10 @@ playlist:
# The server must be invoked with node --expose-gc index.js for this to have any effect. # The server must be invoked with node --expose-gc index.js for this to have any effect.
aggressive-gc: false aggressive-gc: false
# Allows you to blacklist certain channels. Users will be automatically kicked
# upon trying to join one.
channel-blacklist: []
# If you have ffmpeg installed, you can query metadata from raw files, allowing # If you have ffmpeg installed, you can query metadata from raw files, allowing
# server-synched raw file playback. This requires the following: # server-synched raw file playback. This requires the following:
# * ffmpeg must be installed on the server # * ffmpeg must be installed on the server
@ -203,26 +228,18 @@ setuid:
# how long to wait in ms before changing uid/gid # how long to wait in ms before changing uid/gid
timeout: 15 timeout: 15
# Determines channel data storage mechanism.
# Defaults to 'file', in which channel data is JSON stringified and saved to a file
# in the `chandump/` folder. This is the legacy behavior of CyTube.
# The other possible option is 'database', in which case each key-value pair of
# channel data is stored as a row in the `channel_data` database table.
# To migrate legacy chandump files to the database, shut down CyTube (to prevent
# concurrent updates), then run `node lib/channel-storage/migrate.js`.
channel-storage:
type: 'file'
# Allows for external services to access the system commandline # Allows for external services to access the system commandline
# Useful for setups where stdin isn't available such as when using PM2 # Useful for setups where stdin isn't available such as when using PM2
service-socket: service-socket:
enabled: false enabled: false
socket: 'service.sock' socket: 'service.sock'
# Twitch Client ID for the data API (used for VOD lookups)
# https://github.com/justintv/Twitch-API/blob/master/authentication.md#developer-setup
twitch-client-id: null
poll:
max-options: 50
calendar-sync:
enabled: false
# 32-byte key encoded as base64. Prefer setting via env CALENDAR_SYNC_ENCRYPTION_KEY.
encryption-key: ''
google:
client-id: ''
client-secret: ''
# Must exactly match Google OAuth redirect URI
# Example: https://your-domain/api/v1/integrations/google/callback
redirect-uri: ''

View file

@ -1,35 +0,0 @@
version: "3.7"
services:
sync:
build: .
depends_on:
mysql:
condition: service_healthy
ports:
- "8080:8080"
- "1337:1337"
- "8443:8443"
volumes:
- "./templates/head.pug:/app/templates/head.pug"
- "./favicon.ico:/app/www/favicon.ico"
- "./config.yaml:/app/config.yaml"
mysql:
image: docker.io/library/mariadb:latest
healthcheck:
test: ["CMD", "mariadb-admin","ping","-h","localhost", "-u", "root", "--password=sync"]
interval: 5s
timeout: 3s
retries: 100
environment:
- MARIADB_AUTO_UPGRADE=1
- MARIADB_ROOT_PASSWORD=sync
- MARIADB_DATABASE=cytube3
- MARIADB_USER=cytube3
- MARIADB_PASSWORD=strong-password-here
volumes:
# This will create and mount the mysql files in the same folder as the docker-compose.yml file.
# You can change this to be anywhere.
# This will provide data persistence to your MariaDB database.
- "./mysql:/var/lib/mysql"
# If you are using a reverse proxy please do not forget to add the network here as well.
# Refer to the Readme for more information regarding using a Reverse Proxy.

View file

@ -1,570 +0,0 @@
# Bot API
Bots connect to a channel in two ways:
- **WebSocket** (socket.io) — real-time events: chat, user list, playlist changes, media updates
- **REST** (`/api/v1/...`) — commands: queue/delete/shuffle/clear playlist, manage emotes, read/write settings, kick/ban users
Chat can only be sent and received over the WebSocket. The REST API has no chat endpoint.
---
## Ranks
| Name | Value |
|-----------|-------|
| Moderator | 2 |
| Admin | 3 |
| Owner | 4 |
| Creator | 5 |
A bot's rank is capped at the rank of the user who issued its token. Every REST endpoint that modifies state has a minimum rank requirement listed in its description.
---
## Issuing a token
Tokens are issued in the channel settings modal on the **Bots** tab. You need at least moderator rank (2) to see this tab.
Fill in a name (120 alphanumeric, `-`, `_` characters), choose a rank, and click **Issue Token**. The token is shown **once** — copy it immediately. It looks like:
```
cbt_a3f8e2...64 hex characters...
```
To revoke a token, click **Revoke** next to it in the table. Any live WebSocket connections using that token are disconnected immediately.
---
## WebSocket connection
The bot authenticates by passing the token in the socket.io `auth` object:
```js
const io = require('socket.io-client');
const socket = io('http://your-server:1337', {
auth: { token: process.env.BOT_TOKEN }
});
```
> **Port note:** socket.io runs on the port defined by `io.port` in your server config (default 1337), which is separate from the HTTP port used for the web UI and REST API.
### Join sequence
After connecting you must wait for the `login` event before emitting `joinChannel`, otherwise the server will ignore it:
```js
socket.once('login', () => {
socket.emit('joinChannel', { name: 'your-channel-name' });
});
```
### Sending chat
```js
socket.emit('chatMsg', { msg: 'Hello from a bot!' });
// Action message:
socket.emit('chatMsg', { msg: '/me waves' });
```
### Events the bot receives
| Event | Payload | Description |
|------------------|----------------------------------------------|-------------------------------------|
| `login` | `{ success, name, guest }` | Server accepted the connection |
| `chatMsg` | `{ username, msg, meta, time }` | A chat message was sent |
| `userlist` | `[{ name, rank, meta }, ...]` | Full user list on join |
| `addUser` | `{ name, rank, meta }` | A user joined the channel |
| `userLeave` | `{ name }` | A user left the channel |
| `setUserMeta` | `{ name, meta }` | A user's meta (AFK, muted) changed |
| `changeMedia` | `{ id, type, title, seconds, ... }` | A new video started playing |
| `playlist` | `[{ uid, media, queueby, temp }, ...]` | Full playlist on join |
| `queue` | `{ item, after }` | An item was added to the playlist |
| `delete` | `{ uid }` | A playlist item was removed |
| `errorMsg` | `{ msg }` | An error from the server |
| `kick` | `{ reason }` | The bot was kicked |
| `announcement` | `{ title, text }` | Server-wide announcement |
`meta.is_bot` is set to `true` in `chatMsg` and user list payloads for bots, which the web UI renders as a `[bot]` badge.
---
## REST API
### Base URL
```
http://your-server:8080/api/v1
```
All channel-scoped endpoints are under `/channels/:channel/`.
### Authentication
Every REST request must include the bot token as a Bearer token:
```
Authorization: Bearer cbt_...
```
The token is validated against the channel in the URL — a token issued for `#general` will be rejected for `/channels/gaming/...`.
### Error responses
All errors return JSON:
```json
{ "error": "Human readable message" }
```
Common status codes:
| Code | Meaning |
|------|-------------------------------------------------------|
| 400 | Bad request (missing/invalid fields) |
| 401 | Missing or invalid token |
| 403 | Token not authorized for this channel, or rank too low |
| 404 | Resource not found |
| 503 | Channel is not currently active (no users in it) |
---
### Playlist
Playlist endpoints require the channel to be active (at least one user present).
#### `GET /channels/:channel/playlist`
Returns the current playlist and which item is playing.
No minimum rank.
**Response:**
```json
{
"items": [
{
"uid": 1,
"id": "dQw4w9WgXcQ",
"type": "yt",
"title": "Rick Astley - Never Gonna Give You Up",
"seconds": 212,
"duration": "3:32",
"thumb": { "url": "..." },
"meta": {}
}
],
"currentIndex": 0,
"locked": false
}
```
`uid` is the server-assigned unique ID for the playlist slot. Use it for delete/jump operations.
#### `POST /channels/:channel/playlist`
Queue a new item. Minimum rank: **2 (Mod)**.
Returns `202 Accepted` immediately because media lookup is asynchronous. If the bot's permissions don't allow the add (e.g. playlist is locked and rank is too low), a `400` is returned synchronously.
**Body:**
```json
{ "id": "dQw4w9WgXcQ", "type": "yt", "pos": "end" }
```
| Field | Required | Values | Default |
|-------|----------|---------------------|---------|
| `id` | yes | media ID string | |
| `type`| yes | see media types below | |
| `pos` | no | `"end"` or `"next"` | `"end"` |
**Media types:**
| Type | Source |
|------|----------------------|
| `yt` | YouTube |
| `sc` | SoundCloud |
| `tw` | Twitch stream |
| `tc` | Twitch clip |
| `rt` | Dailymotion |
| `vm` | Vimeo |
| `dm` | Dailymotion |
| `gd` | Google Drive |
| `fi` | Direct file URL |
| `cu` | Custom embed (HTML) |
#### `DELETE /channels/:channel/playlist/:uid`
Remove a playlist item by uid. Minimum rank: **3 (Admin)**.
#### `PUT /channels/:channel/playlist/playing`
Skip to a specific item. Minimum rank: **2 (Mod)**.
**Body:**
```json
{ "uid": 3 }
```
#### `POST /channels/:channel/playlist/shuffle`
Shuffle the playlist. Minimum rank: **3 (Admin)**.
#### `POST /channels/:channel/playlist/clear`
Clear the entire playlist. Minimum rank: **3 (Admin)**.
---
### Emotes
Emote endpoints read and write directly to the database and work even when the channel is offline. If the channel happens to be active, changes are broadcast live to connected users.
#### `GET /channels/:channel/emotes`
Returns the full emote list. No minimum rank.
**Response:**
```json
[
{ "name": "KEKW", "image": "https://cdn.example.com/kekw.png", "source": "..." }
]
```
#### `POST /channels/:channel/emotes`
Add a new emote. Minimum rank: **4 (Owner)**.
**Body:**
```json
{ "name": "KEKW", "image": "https://cdn.example.com/kekw.png" }
```
Returns `409 Conflict` if the name is already taken.
#### `PUT /channels/:channel/emotes/:name`
Update an emote's image or rename it. Minimum rank: **4 (Owner)**.
**Body** (all fields optional, but at least one must differ):
```json
{ "image": "https://cdn.example.com/kekw-v2.png", "newName": "KEKWait" }
```
Omit `newName` to keep the existing name. Returns `409` if the new name is already taken.
#### `DELETE /channels/:channel/emotes/:name`
Delete an emote by name. Minimum rank: **4 (Owner)**.
---
### Users / Moderation
These endpoints require the channel to be active.
#### `GET /channels/:channel/users`
List currently connected users. No minimum rank.
**Response:**
```json
[
{ "name": "Alice", "rank": 3, "afk": false, "is_bot": false },
{ "name": "MyBot", "rank": 2, "afk": false, "is_bot": true }
]
```
#### `POST /channels/:channel/users/:name/kick`
Kick a user. Minimum rank: **2 (Mod)**. Cannot kick users with equal or higher rank.
**Body:**
```json
{ "reason": "Spamming" }
```
`reason` is optional, defaults to `"Kicked by bot"`.
#### `POST /channels/:channel/users/:name/ban`
Ban a user by name. Minimum rank: **3 (Admin)**. Cannot ban users with equal or higher rank.
**Body:**
```json
{ "reason": "Ban evasion" }
```
`reason` is optional, defaults to `"Banned by bot"`.
#### `DELETE /channels/:channel/users/:name/ban`
Remove a ban. Minimum rank: **3 (Admin)**.
#### `PUT /channels/:channel/users/:name/rank`
Change a user's channel rank. Minimum rank: **4 (Owner)**. Cannot assign a rank equal to or higher than your own, and cannot target users with equal or higher rank.
**Body:**
```json
{ "rank": 2 }
```
---
### Settings
Settings endpoints require the channel to be active. Minimum rank: **4 (Owner)** for both read and write.
#### `GET /channels/:channel/settings`
Returns current channel options.
**Response:**
```json
{
"pagetitle": "My Channel",
"allow_voteskip": true,
"voteskip_ratio": 0.5,
"maxlength": 0,
"afk_timeout": 600,
"password": "",
"show_public": false,
...
}
```
**Available keys:**
`allow_voteskip`, `allow_dupes`, `voteskip_ratio`, `maxlength`, `playlist_max_duration_per_user`, `afk_timeout`, `enable_link_regex`, `chat_antiflood`, `chat_antiflood_burst`, `chat_antiflood_sustained`, `new_user_chat_delay`, `new_user_chat_link_delay`, `pagetitle`, `password`, `externalcss`, `externaljs`, `show_public`, `torbanned`, `block_anonymous_users`, `allow_ascii_control`, `playlist_max_per_user`
#### `PUT /channels/:channel/settings`
Update one or more settings. Unknown keys are silently ignored.
**Body:**
```json
{ "pagetitle": "Now Playing: Chill Beats", "allow_voteskip": false }
```
---
### Shows
Show endpoints manage scheduled playlist runs. These endpoints support bot Bearer auth and session auth.
#### `GET /channels/:channel/shows`
List shows for the channel. Minimum rank: **2 (Mod)**.
#### `GET /channels/:channel/shows/:id`
Get a single show. Minimum rank: **2 (Mod)**.
#### `GET /channels/:channel/shows/public`
List only public-facing shows (`scheduled`, `running`, `paused`, `completed`). No auth required.
#### `POST /channels/:channel/shows/resolve-media`
Resolve up to 50 media entries to display-ready titles before saving a show. Minimum rank: **2 (Mod)**.
**Body:**
```json
{
"items": [
{ "type": "yt", "id": "dQw4w9WgXcQ" }
]
}
```
**Response:**
```json
{
"items": [
{ "type": "yt", "id": "dQw4w9WgXcQ", "title": "Rick Astley - Never Gonna Give You Up", "ok": true }
]
}
```
#### `POST /channels/:channel/shows`
Create a show. Minimum rank: **2 (Mod)**.
#### `PUT /channels/:channel/shows/:id`
Update a show. Minimum rank: **2 (Mod)**.
#### `DELETE /channels/:channel/shows/:id`
Delete a show. Minimum rank: **3 (Admin)**.
#### `POST /channels/:channel/shows/:id/action`
Run control action.
| Action | Minimum rank |
|------------|--------------|
| `pause` | 2 |
| `resume` | 2 |
| `schedule` | 2 |
| `run` | 3 |
| `cancel` | 3 |
**Create/Update body schema:**
```json
{
"name": "Friday Prime",
"notes": "Opening block",
"color": "#337AB7",
"scheduled_for": "2026-05-22T19:00:00.000Z",
"estimated_end_at": "2026-05-22T21:00:00.000Z",
"timezone": "America/New_York",
"recurrence": "weekly",
"fill_mode": "replace",
"conflict_mode": "force",
"start_playback": true,
"playlist": [
{ "type": "yt", "id": "dQw4w9WgXcQ", "pos": "end" }
],
"status": "scheduled"
}
```
**Field constraints:**
- `name`: required, 1-100 chars
- `notes`: optional string, trimmed and capped to 20,000 chars
- `color`: optional `#RRGGBB` hex color
- `timezone`: required IANA timezone string (example: `Europe/Berlin`, `America/New_York`)
- `scheduled_for`: required date string or unix timestamp (ms)
- `estimated_end_at`: optional date string/timestamp, must be later than `scheduled_for` when present
- `recurrence`: `none | daily | weekly`
- `fill_mode`: `append | replace`
- `conflict_mode`: `force | skip`
- `playlist`: non-empty array of media entries (`type`, `id`, optional `pos: next|end`)
- `status`: one of `draft | scheduled | paused | running | completed | failed | canceled` (`running` is accepted but normalized to `scheduled` on write)
**Action body schema:**
```json
{ "action": "run" }
```
**Show response shape** (`GET`, `POST`, `PUT`, and `POST /action`):
```json
{
"id": 42,
"channel_name": "my-channel",
"channel_id": 10,
"name": "Friday Prime",
"notes": "Opening block",
"notes_html": "<p>Opening block</p>",
"color": "#337AB7",
"playlist": [{ "type": "yt", "id": "dQw4w9WgXcQ", "pos": "end" }],
"timezone": "America/New_York",
"scheduled_for": 1779476400000,
"estimated_end_at": 1779483600000,
"next_run_at": 1779476400000,
"status": "scheduled",
"recurrence": "weekly",
"recurrence_meta": null,
"fill_mode": "replace",
"conflict_mode": "force",
"start_playback": true,
"run_count": 0,
"last_run_at": null,
"created_at": 1779400000000,
"updated_at": 1779400000000,
"created_by": "my-bot",
"updated_by": "my-bot",
"last_error": null
}
```
---
### Bot management
These endpoints use **session cookie auth** (the normal logged-in web session), not a bot token. They are intended for the channel settings UI.
#### `GET /channels/:channel/bots`
List all bots for the channel. Returns id, name, rank, creator, creation time, last connection time. Requires channel rank ≥ 2.
#### `POST /channels/:channel/bots`
Issue a new bot token. Requires channel rank ≥ 2. The returned `token` is shown **once** and not stored.
**Body:**
```json
{ "name": "MyBot", "rank": 2 }
```
**Response:**
```json
{ "id": 7, "name": "MyBot", "rank": 2, "token": "cbt_..." }
```
#### `DELETE /channels/:channel/bots/:id`
Revoke a bot token. Any live socket connections for that bot are disconnected immediately. Requires channel rank ≥ 2 and your rank must be ≥ the bot's rank.
---
## Demo bot
A working example with a TUI is in `examples/demo-bot/`.
```
cd examples/demo-bot
npm install
cp .env.example .env
# Edit .env: fill in BOT_TOKEN, CHANNEL, SERVER_URL, API_BASE
node bot.js
```
**.env fields:**
| Variable | Description | Default |
|--------------|---------------------------------------------------------|-----------------------------------|
| `BOT_TOKEN` | Bot token from the channel settings Bots tab | — |
| `CHANNEL` | Channel name (lowercase, no `#`) | — |
| `SERVER_URL` | socket.io URL (use the io.port, not the HTTP port) | `http://localhost:1337` |
| `API_BASE` | Base URL for REST requests | `http://localhost:8080/api/v1` |
**TUI keybindings:** Enter to send, PgUp/PgDn to scroll, Ctrl-C to quit.
**Bot commands** (prefix with `/` in the input box):
| Command | Description |
|--------------------------|----------------------------------------|
| `/help` | List commands |
| `/playlist` | Show playlist via REST |
| `/emotes` | List emotes via REST |
| `/settings` | Show channel settings via REST |
| `/users` | Show connected user list |
| `/add <type> <id>` | Queue media, e.g. `/add yt dQw4w9WgXcQ` |
| `/skip` | Skip to next item |
| `/clear` | Clear the playlist |
| `/kick <name> [reason]` | Kick a user |
| `/me <text>` | Send an action message |

View file

@ -1,210 +0,0 @@
CyTube Custom Content Metadata
==============================
*Last updated: 2022-02-12*
## Purpose ##
CyTube currently supports adding custom audio/video content by allowing the user
to supply a direct URL to an audio/video file. The server uses `ffprobe` to
probe the file for various metadata, including the codec/container format and
the duration. This approach has a few disadvantages over the officially
supported media providers, namely:
* Since it accepts a single file, it is not possible to provide multiple
source URLs with varying formats or bitrates to allow viewers to select the
best source for their computer.
- It also means it is not possible to provide text tracks for subtitles or
closed captioning, or to provide image URLs for thumbnails/previews.
* Probing the file with `ffprobe` is slow, especially if the content is hosted
in a far away network location, which at best is inconvenient and at worst
results in timeouts and inability to add the content.
* Parsing the `ffprobe` output is inexact, and may sometimes result in
detecting the wrong format, or failing to detect the title.
This document specifies a new supported media provider which allows users to
provide a JSON manifest specifying the metadata for custom content in a way that
avoids the above issues and is more flexible for extension.
## Custom Manifest URLs ##
Custom media manifests are added to CyTube by adding a link to a public URL
hosting the JSON metadata manifest. Pasting the JSON directly into CyTube is
not supported. Valid JSON manifests must:
* Have a URL path ending with the file extension `.json` (not counting
querystring parameters)
* Be served with the `Content-Type` header set to `application/json`
* Be retrievable at any time while the item is on the playlist (CyTube may
re-request the metadata for an item already on the playlist to revalidate)
* Respond to valid requests with a 200 OK HTTP response code (redirects are
not supported)
* Respond within 10 seconds
* Not exceed 100 KiB in size
## Manifest Format ##
To add custom content, the user provides a JSON object with the following keys:
* `title`: A nonempty string specifying the title of the content. For legacy
reasons, CyTube currently truncates this to 100 UTF-8 characters.
* `duration`: A non-negative, finite number specifying the duration, in
seconds, of the content. This is what the server will use for timing
purposes. Decimals are allowed, but CyTube's timer truncates the value as
an integer number of seconds, so including fractional seconds lends no
advantage.
* `live`: An optional boolean (default: `false`) indicating whether the
content is live or pre-recorded. For live content, the `duration` is
ignored, and the server won't advance the playlist automatically.
* `thumbnail`: An optional string specifying a URL for a thumbnail image of
the content. CyTube currently does not support displaying thumbnails in the
playlist, but this functionality may be offered in the future.
* `sources`: A nonempty list of playable sources for the content. The format
is described below.
* `audioTracks`: An optional list of audio tracks for using demuxed audio
and providing multiple audio selections. The format is described below.
* `textTracks`: An optional list of text tracks for subtitles or closed
captioning. The format is described below.
### Source Format ###
Each source entry is a JSON object with the following keys:
* `url`: A valid URL that browsers can use to retrieve the content. The URL
must resolve to a publicly-routed IP address, and must the `https:` scheme.
* `contentType`: A string representing the MIME type of the content at `url`.
A list of acceptable MIME types is provided below.
* `quality`: A number representing the quality level of the source. The
supported quality levels are `240`, `360`, `480`, `540`, `720`, `1080`,
`1440`, and `2160`. This may be extended in the future.
* `bitrate`: An optional number indicating the bitrate (in Kbps) of the
content. It must be a positive, finite number if provided. The bitrate is
not currently used by CyTube, but may be used by extensions or custom
scripts to determine whether this source is feasible to play on the viewer's
internet connection.
#### Acceptable MIME Types ####
The following MIME types are accepted for the `contentType` field:
* `video/mp4`
* `video/webm`
* `video/ogg`
* `application/x-mpegURL` (HLS streams)
- HLS is only tested with livestreams. VODs are accepted, but I do not test
this functionality.
* `application/dash+xml` (DASH streams)
- Support for DASH is experimental
* ~~`rtmp/flv`~~
- In light of Adobe phasing out support for Flash, and many browsers
already dropping support, RTMP is not supported by this feature.
RTMP streams are only supported through the existing `rt:` media
type.
* `audio/aac`
* `audio/mp4`
* `audio/mpeg`
* `audio/ogg`
Other audio or video formats, such as AVI, MKV, and FLAC, are not supported due
to lack of common support across browsers for playing these formats. For more
information, refer to
[MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats#Browser_compatibility).
### Audio Track Format ###
Each audio track entry is a JSON object with the following keys:
* `label`: A label for the audio track. This is displayed in the menu for the
viewer to select a text track.
* `language`: A two or three letter IETF BCP 47 subtype code indicating the
language of the audio track.
* `url`: A valid URL that browsers can use to retrieve the track. The URL
must resolve to a publicly-routed IP address, and must use the `https:` scheme.
* `contentType`: A string representing the MIME type of the track at `url`.
Any type starting with `audio` from the list above is acceptable. However
the usage of audio/aac is known to cause audio syncrhonization problems
for some users. It is recommended to use an m4a file to wrap aac streams.
**Important note regarding audio tracks:**
Because of browsers trying to be too smart for their own good, you should
include a silent audio stream in the video sources when using separate audio
tracks. If you do not, the browser will automatically pause the video whenever
the browser detects the page as not visible. There is no way to instruct it to
not do so. You can readily accomplish the inclusion of a silent audio track
with ffmpeg using the anullsrc filter like so:
`ffmpeg -f lavfi -i anullsrc=channel_layout=stereo:sample_rate=48000 -i input.mp4 -c:v copy -c:a aac -shortest output.mp4`
It is recommended to match the sample rate and codec you intend to use in your
audioTracks in your silent track.
### Text Track Format ###
Each text track entry is a JSON object with the following keys:
* `url`: A valid URL that browsers can use to retrieve the track. The URL
must resolve to a publicly-routed IP address, and must the `https:` scheme.
* `contentType`: A string representing the MIME type of the track at `url`.
The only currently supported MIME type is
[`text/vtt`](https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API).
* `name`: A name for the text track. This is displayed in the menu for the
viewer to select a text track.
* `default`: Enable track by default. Optional boolean attribute to enable
a subtitle track to the user by default.
**Important note regarding text tracks and CORS:**
By default, browsers block requests for WebVTT tracks hosted on different
domains than the current page. In order for text tracks to work cross-origin,
the `Access-Control-Allow-Origin` header needs to be set by the remote server
when serving the VTT file. See
[MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin)
for more information about setting this header.
## Example ##
{
"title": "Test Video",
"duration": 10,
"live": false,
"thumbnail": "https://example.com/thumb.jpg",
"sources": [
{
"url": "https://example.com/video.mp4",
"contentType": "video/mp4",
"quality": 1080,
"bitrate": 5000
}
],
"textTracks": [
{
"url": "https://example.com/subtitles.vtt",
"contentType": "text/vtt",
"name": "English Subtitles",
"default": true
}
]
}
## Permissions ##
The permission node to allow users to add custom content is the same as the
permission node for the existing raw file support. Custom content is considered
as an extension of the existing feature.
## Unsupported/Undefined Behavior ##
The behavior under any the following circumstances is not defined by this
specification, and any technical support in these cases is voided. This list is
non-exhaustive.
* Source URLs or text track URLs are hosted on a third-party website that does
not have knowledge of its content being played on CyTube.
* The webserver hosting the source or text track URLs serves a different MIME
type than the one specified in the manifest.
* The webserver hosting the source or text track URLs serves a file that does
not match the MIME type specified in the `Content-Type` HTTP header returned
to the browser.
* The manifest includes source URLs or text track URLs with expiration times,
session IDs, etc. in the URL querystring.
* The manifest provides source URLs with non-silent audio as well as a list
of audioTracks.

View file

@ -21,4 +21,4 @@ example, for cytu.be I use:
npm run generate-userscript CyTube http://cytu.be/r/* https://cytu.be/r/* npm run generate-userscript CyTube http://cytu.be/r/* https://cytu.be/r/*
``` ```
This will generate `www/js/cytube-google-drive.user.js`. If you've changed the channel path, be sure to take that into account. This will generate `www/js/cytube-google-drive.user.js`.

View file

@ -12,4 +12,4 @@ This user guide is a work in progress rewrite of the old user guide. If you not
## I need help! ## ## I need help! ##
1. Please read the [FAQ](https://github.com/calzoneman/sync/wiki/Frequently-Asked-Questions) and check whether that answers your question. 1. Please read the [FAQ](https://github.com/calzoneman/sync/wiki/Frequently-Asked-Questions) and check whether that answers your question.
2. If not, you can contact someone for help. IRC support is provided on `irc.esper.net #cytube` ([webchat](https://webchat.esper.net/?channels=cytube) available) for https://cytu.be and general questions about using the software. If nobody is available on IRC, or you want to speak privately, email one of the contacts on https://cytu.be/contact. 2. If not, you can contact someone for help. IRC support is provided on `irc.6irc.net #cytube` ([webchat](https://webchat.6irc.net/?channels=cytube) available) for http://cytu.be, http://synchtu.be, and general questions about using the software. If nobody is available on IRC, or you want to speak privately, email one of the contacts on https://cytu.be/contact.

View file

@ -29,9 +29,7 @@ natively. Accordingly, CyTube only supports a few codecs:
**Video** **Video**
* MP4 (AV1)
* MP4 (H.264) * MP4 (H.264)
* WebM (AV1)
* WebM (VP8) * WebM (VP8)
* WebM (VP9) * WebM (VP9)
* Ogg/Theora * Ogg/Theora

View file

@ -21,6 +21,7 @@ Setting | Description
--------|------------ --------|------------
Synchronize video playback | By default, CyTube attempts to synchronize the video so that everyone is watching at the same time. Some users with poor internet connections may wish to disable this in order to prevent excessive buffering due to constantly seeking forward. Synchronize video playback | By default, CyTube attempts to synchronize the video so that everyone is watching at the same time. Some users with poor internet connections may wish to disable this in order to prevent excessive buffering due to constantly seeking forward.
Synch threshold | The number of seconds your video is allowed to be ahead/behind before it is forcibly seeked to the correct position. Should be set to at least 2 seconds to avoid buffering problems and choppy playback. Synch threshold | The number of seconds your video is allowed to be ahead/behind before it is forcibly seeked to the correct position. Should be set to at least 2 seconds to avoid buffering problems and choppy playback.
Set wmode=transparent | There's probably no reason to touch this unless you know what you're doing. Having a non-transparent wmode can cause modals to display behind the video player, but also can cause performance issues in some situations.
Remove the video player | Automatically remove the video player on page load. Equivalent to manually clicking Layout->Remove Video every time you load a channel. Remove the video player | Automatically remove the video player on page load. Equivalent to manually clicking Layout->Remove Video every time you load a channel.
Hide playlist buttons by default | Hides the control buttons from each video in the playlist, so that only the title is displayed. The control buttons can be shown by right clicking the video item in the playlist. Hide playlist buttons by default | Hides the control buttons from each video in the playlist, so that only the title is displayed. The control buttons can be shown by right clicking the video item in the playlist.
Old style playlist buttons | Legacy feature introduced in CyTube 2.0 for those who preferred the old 1.0-style video control buttons. Old style playlist buttons | Legacy feature introduced in CyTube 2.0 for those who preferred the old 1.0-style video control buttons.

View file

@ -1,11 +0,0 @@
# Issue a bot token in the channel settings modal (Bots tab), then paste it here.
BOT_TOKEN=cbt_your_token_here
# The channel this token was issued for.
CHANNEL=yourchannel
# Base URL of the CyTube server (no trailing slash).
SERVER_URL=http://localhost:1337
# REST API base (usually SERVER_URL + /api/v1).
API_BASE=http://localhost:8080/api/v1

View file

@ -1,594 +0,0 @@
#!/usr/bin/env node
/**
* CyTube Sync Demo Bot
*
* Shows the two halves of the bot API:
* WebSocket (socket.io-client) real-time events: chat, user list, playlist
* REST API (fetch) queries and commands: playlist, emotes, settings, moderation
*
* Setup:
* cp .env.example .env # fill in BOT_TOKEN and CHANNEL
* npm install
* node bot.js
*
* TUI keybindings:
* Enter send message or run command
* PgUp/PgDn scroll chat
* Ctrl-C quit
*
* Commands (prefix with /):
* /help list commands
* /playlist show current playlist via REST
* /emotes list emotes via REST
* /settings show channel settings via REST
* /users dump user list from in-memory state
* /add <type> <id> add media e.g. /add yt dQw4w9WgXcQ
* /skip skip to next playlist item
* /clear clear the playlist
* /kick <name> [reason] kick a user
* /me <text> send an action (/me) message
*/
'use strict';
require('dotenv').config();
const io = require('socket.io-client');
const fetch = require('node-fetch');
const blessed = require('blessed');
// ── Config ────────────────────────────────────────────────────────────────────
const {
BOT_TOKEN,
CHANNEL,
SERVER_URL = 'http://localhost:8080',
API_BASE = 'http://localhost:8080/api/v1',
} = process.env;
if (!BOT_TOKEN || !CHANNEL) {
console.error('BOT_TOKEN and CHANNEL must be set. Copy .env.example to .env and fill it in.');
process.exit(1);
}
if (!BOT_TOKEN.startsWith('cbt_')) {
console.error('BOT_TOKEN does not look right — it should start with cbt_');
process.exit(1);
}
// ── REST helpers ──────────────────────────────────────────────────────────────
async function apiRequest(method, path, body) {
const url = `${API_BASE}/channels/${CHANNEL}${path}`;
const opts = {
method,
headers: {
'Authorization': `Bearer ${BOT_TOKEN}`,
'Content-Type': 'application/json',
},
};
if (body !== undefined) opts.body = JSON.stringify(body);
const res = await fetch(url, opts);
const json = await res.json().catch(() => null);
if (!res.ok) {
throw new Error((json && json.error) || `HTTP ${res.status}`);
}
return json;
}
const api = {
get: (path) => apiRequest('GET', path),
post: (path, body) => apiRequest('POST', path, body),
put: (path, body) => apiRequest('PUT', path, body),
delete: (path) => apiRequest('DELETE', path),
};
// ── Utilities ─────────────────────────────────────────────────────────────────
function stripHtml(html) {
return html
.replace(/<br\s*\/?>/gi, '\n')
.replace(/<[^>]+>/g, '')
.replace(/&amp;/g, '&')
.replace(/&lt;/g, '<')
.replace(/&gt;/g, '>')
.replace(/&quot;/g, '"')
.replace(/&#39;/g, "'");
}
// Escape blessed tag syntax so server content can't inject markup.
function escBless(str) {
return String(str).replace(/\{/g, '\\{');
}
function hhmm(secs) {
return `${Math.floor(secs / 60)}:${String(secs % 60).padStart(2, '0')}`;
}
function timestamp() {
return new Date().toLocaleTimeString([], { hour: '2-digit', minute: '2-digit' });
}
// ── In-memory state ───────────────────────────────────────────────────────────
const state = {
users: [], // userlist entries from server
nowPlaying: null, // current changeMedia payload
connected: false,
inChannel: false,
};
// ── TUI ───────────────────────────────────────────────────────────────────────
const screen = blessed.screen({
smartCSR: true,
title: `CyTube Bot :: #${CHANNEL}`,
fullUnicode: true,
forceUnicode: true,
});
// Top bar — connection status + now playing
const statusBar = blessed.box({
top: 0,
left: 0,
width: '100%',
height: 1,
tags: true,
style: { bg: 'blue', fg: 'white', bold: true },
content: ` CyTube Bot #${CHANNEL} Connecting...`,
});
// Main chat log (left, scrollable)
const chatLog = blessed.log({
top: 1,
left: 0,
width: '70%',
height: '100%-4',
border: { type: 'line' },
label: ' Chat ',
scrollable: true,
alwaysScroll: true,
scrollbar: { ch: ' ', style: { bg: 'cyan' } },
mouse: true,
tags: true,
wrap: true,
style: { border: { fg: 'cyan' }, label: { fg: 'cyan', bold: true } },
});
// User list sidebar (right)
const userList = blessed.list({
top: 1,
right: 0,
width: '30%',
height: '100%-4',
border: { type: 'line' },
label: ' Users ',
scrollable: true,
mouse: true,
tags: true,
style: {
border: { fg: 'cyan' },
label: { fg: 'cyan', bold: true },
item: { fg: 'white' },
selected: { fg: 'white' },
},
});
// Input box (bottom)
const inputBox = blessed.textbox({
bottom: 0,
left: 0,
width: '100%',
height: 3,
border: { type: 'line' },
label: ' Message — /help for commands — Ctrl-C to quit ',
inputOnFocus: true,
style: { border: { fg: 'green' }, label: { fg: 'green' } },
});
screen.append(statusBar);
screen.append(chatLog);
screen.append(userList);
screen.append(inputBox);
screen.key(['C-c'], () => process.exit(0));
// ── TUI helpers ───────────────────────────────────────────────────────────────
function setStatus(msg) {
statusBar.setContent(` CyTube Bot #${CHANNEL} ${msg}`);
screen.render();
}
function chat(line) {
chatLog.log(line);
screen.render();
}
function info(line) {
chat(`{cyan-fg}${line}{/cyan-fg}`);
}
function warn(line) {
chat(`{yellow-fg}${line}{/yellow-fg}`);
}
function fail(line) {
chat(`{red-fg}✗ ${line}{/red-fg}`);
}
function rebuildUserList() {
const items = state.users.map(u => {
const isBot = u.meta && u.meta.is_bot;
const afk = u.meta && u.meta.afk;
let rankStr;
if (u.rank >= 5) rankStr = '{red-fg}[creator]{/red-fg}';
else if (u.rank >= 4) rankStr = '{yellow-fg}[owner]{/yellow-fg}';
else if (u.rank >= 3) rankStr = '{magenta-fg}[admin]{/magenta-fg}';
else if (u.rank >= 2) rankStr = '{green-fg}[mod]{/green-fg}';
else rankStr = '';
const botTag = isBot ? ' {blue-fg}[bot]{/blue-fg}' : '';
const afkTag = afk ? ' {grey-fg}[afk]{/grey-fg}' : '';
return `${escBless(u.name)} ${rankStr}${botTag}${afkTag}`;
});
userList.setLabel(` Users (${items.length}) `);
userList.setItems(items);
screen.render();
}
// ── Socket.IO ─────────────────────────────────────────────────────────────────
const socket = io(SERVER_URL, {
// This is how the bot authenticates — token goes in socket.handshake.auth.token
auth: { token: BOT_TOKEN },
reconnection: true,
reconnectionDelay: 3000,
reconnectionAttempts: Infinity,
});
socket.on('connect', () => {
state.connected = true;
setStatus('Authenticating...');
});
socket.on('disconnect', (reason) => {
state.connected = false;
state.inChannel = false;
state.users = [];
rebuildUserList();
warn(`Disconnected: ${reason}`);
setStatus(`Disconnected — reconnecting...`);
});
socket.on('connect_error', (err) => {
fail(`Connection error: ${err.message}`);
});
// Server confirms authentication and sends the bot's display name + rank.
// We wait for this before joining the channel to avoid any ordering issues.
socket.on('login', (data) => {
if (data.success) {
info(`Authenticated as: ${escBless(data.name)}`);
socket.emit('joinChannel', { name: CHANNEL });
} else {
fail(`Authentication failed: ${escBless(data.error || 'unknown')}`);
}
});
socket.on('errorMsg', (data) => {
fail(escBless(data.msg || 'Server error'));
});
socket.on('kick', (data) => {
fail(`Kicked: ${escBless(data.reason || '')}`);
setStatus('Kicked from channel');
});
// ── Channel events ────────────────────────────────────────────────────────────
// Channel options (title, password, etc.)
socket.on('channelOpts', (opts) => {
const title = opts.pagetitle || CHANNEL;
const playing = state.nowPlaying ? `${escBless(state.nowPlaying.title)}` : '';
setStatus(`{bold}${escBless(title)}{/bold}${playing}`);
});
// ── User list events ──────────────────────────────────────────────────────────
// Full user list, sent on join and refresh
socket.on('userlist', (users) => {
state.users = users;
state.inChannel = true;
rebuildUserList();
info(`Joined #${CHANNEL}${users.length} user(s) present`);
});
// New user joined
socket.on('addUser', (user) => {
state.users = state.users.filter(u => u.name !== user.name);
state.users.push(user);
rebuildUserList();
chat(`{green-fg}→ ${escBless(user.name)} joined{/green-fg}`);
});
// User left
socket.on('userLeave', (data) => {
state.users = state.users.filter(u => u.name !== data.name);
rebuildUserList();
chat(`{red-fg}← ${escBless(data.name)} left{/red-fg}`);
});
// Rank changed for a user
socket.on('setUserRank', (data) => {
const user = state.users.find(u => u.name === data.name);
if (user) user.rank = data.rank;
rebuildUserList();
});
// AFK / mute state changed
socket.on('setUserMeta', (data) => {
const user = state.users.find(u => u.name === data.name);
if (user) Object.assign(user.meta, data.meta);
rebuildUserList();
});
// ── Chat events ───────────────────────────────────────────────────────────────
socket.on('chatMsg', (data) => {
const time = timestamp();
const name = escBless(data.username || '?');
const msg = escBless(stripHtml(data.msg || ''));
const isAction = data.meta && data.meta.addClass === 'action';
// is_bot is set by the server in the message meta; fall back to checking
// the local user list in case the message arrives before the userlist does.
const senderInList = state.users.find(u => u.name === data.username);
const isBot = (data.meta && data.meta.is_bot) ||
(senderInList && senderInList.meta && senderInList.meta.is_bot);
const botTag = isBot ? ' {blue-fg}[bot]{/blue-fg}' : '';
if (isAction) {
chat(`{grey-fg}[${time}]{/grey-fg}${botTag} {italic}* ${name} ${msg}{/italic}`);
} else {
chat(`{grey-fg}[${time}]{/grey-fg} {bold}${name}{/bold}${botTag}: ${msg}`);
}
});
// Private messages
socket.on('pm', (data) => {
const name = escBless(data.username || '?');
const msg = escBless(stripHtml(data.msg || ''));
chat(`{magenta-fg}[PM ← ${name}]{/magenta-fg} ${msg}`);
});
// Chat cleared by a moderator
socket.on('clearchat', () => {
chatLog.setContent('');
info('Chat was cleared by a moderator.');
screen.render();
});
// ── Playlist events ───────────────────────────────────────────────────────────
// Full playlist on join
socket.on('playlist', (items) => {
if (items.length > 0) {
info(`Playlist loaded: ${items.length} item(s)`);
}
});
// New item added to playlist by someone
socket.on('queue', (data) => {
const item = data.item;
if (item && item.media) {
info(`Queued: [${item.media.type}] ${escBless(item.media.title)}`);
}
});
// Currently playing changed
socket.on('changeMedia', (media) => {
state.nowPlaying = media;
const dur = media.seconds ? ` (${hhmm(media.seconds)})` : '';
const title = escBless(media.title || media.id);
setStatus(`${title}${dur}`);
info(`Now playing: {bold}${title}{/bold}${dur}`);
});
// ── Emote events ──────────────────────────────────────────────────────────────
socket.on('updateEmote', (emote) => {
info(`Emote updated: :${escBless(emote.name)}:`);
});
socket.on('removeEmote', (data) => {
info(`Emote removed: :${escBless(data.name)}:`);
});
// ── Commands ──────────────────────────────────────────────────────────────────
const COMMANDS = {
help() {
info('─── Commands ───────────────────────────────────────────────────');
info(' /playlist fetch and show the playlist');
info(' /emotes list emote names');
info(' /settings show channel settings');
info(' /users dump in-memory user list');
info(' /add <type> <id> add media e.g. /add yt dQw4w9WgXcQ');
info(' /skip skip to next playlist item');
info(' /clear clear the playlist');
info(' /kick <name> [reason] kick a user from the channel');
info(' /me <text> send an action message');
info(' <anything else> send as a chat message');
info('───────────────────────────────────────────────────────────────');
},
async playlist() {
try {
const data = await api.get('/playlist');
info(`─── Playlist (${data.items.length} item${data.items.length !== 1 ? 's' : ''}) ──`);
if (data.items.length === 0) {
info(' (empty)');
} else {
data.items.forEach((item, i) => {
const dur = item.seconds ? hhmm(item.seconds) : '?:??';
const marker = i === data.currentIndex ? '{yellow-fg}▶{/yellow-fg}' : ' ';
info(` ${marker} [${item.type}] ${escBless(item.title)} (${dur}) uid:${item.uid}`);
});
}
if (data.locked) warn(' Playlist is locked');
} catch (e) {
fail(`playlist: ${e.message}`);
}
},
async emotes() {
try {
const emotes = await api.get('/emotes');
info(`─── Emotes (${emotes.length}) ──`);
if (emotes.length === 0) {
info(' (none)');
} else {
// Print names in rows of 8
for (let i = 0; i < emotes.length; i += 8) {
info(' ' + emotes.slice(i, i + 8).map(e => `:${escBless(e.name)}:`).join(' '));
}
}
} catch (e) {
fail(`emotes: ${e.message}`);
}
},
async settings() {
try {
const s = await api.get('/settings');
info('─── Channel Settings ──');
for (const [k, v] of Object.entries(s)) {
if (v !== null && v !== '' && v !== false) {
info(` ${k}: ${escBless(String(v))}`);
}
}
} catch (e) {
fail(`settings: ${e.message}`);
}
},
users() {
info(`─── Users (${state.users.length}) ──`);
state.users.forEach(u => {
const rank = u.rank >= 5 ? 'creator' : u.rank >= 4 ? 'owner' : u.rank >= 3 ? 'admin' : u.rank >= 2 ? 'mod' : 'user';
const isBot = u.meta && u.meta.is_bot ? ' [bot]' : '';
info(` ${escBless(u.name)} (${rank} rank:${u.rank})${isBot}`);
});
},
async add(args) {
const parts = args.trim().split(/\s+/);
if (parts.length < 2) {
fail('Usage: /add <type> <id> e.g. /add yt dQw4w9WgXcQ');
return;
}
const [type, id] = parts;
try {
await api.post('/playlist', { type, id, pos: 'end' });
info(`Added [${type}] ${escBless(id)} to playlist`);
} catch (e) {
fail(`add: ${e.message}`);
}
},
async skip() {
try {
const data = await api.get('/playlist');
if (data.items.length === 0) { warn('Playlist is empty'); return; }
const idx = data.currentIndex;
if (idx < 0 || idx >= data.items.length - 1) {
warn('No next item in playlist');
return;
}
const next = data.items[idx + 1];
await api.put('/playlist/playing', { uid: next.uid });
info(`Skipped to: ${escBless(next.title)}`);
} catch (e) {
fail(`skip: ${e.message}`);
}
},
async clear() {
try {
await api.post('/playlist/clear');
info('Playlist cleared');
} catch (e) {
fail(`clear: ${e.message}`);
}
},
async kick(args) {
const parts = args.trim().split(/\s+/);
const name = parts[0];
const reason = parts.slice(1).join(' ') || 'Kicked by bot';
if (!name) { fail('Usage: /kick <name> [reason]'); return; }
try {
await api.post(`/users/${encodeURIComponent(name)}/kick`, { reason });
info(`Kicked ${escBless(name)}`);
} catch (e) {
fail(`kick: ${e.message}`);
}
},
me(args) {
const text = args.trim();
if (!text) { fail('Usage: /me <text>'); return; }
socket.emit('chatMsg', { msg: `/me ${text}` });
},
};
async function handleInput(line) {
line = line.trim();
if (!line) return;
if (line.startsWith('/')) {
const space = line.indexOf(' ');
const name = (space === -1 ? line.slice(1) : line.slice(1, space)).toLowerCase();
const args = space === -1 ? '' : line.slice(space + 1);
if (COMMANDS[name]) {
try {
await COMMANDS[name](args);
} catch (e) {
fail(`Command error: ${e.message}`);
}
} else {
fail(`Unknown command: /${name} (type /help for a list)`);
}
} else {
// Regular chat message — sent over the WebSocket, not REST.
// The server will echo it back as a chatMsg event.
socket.emit('chatMsg', { msg: line });
}
}
// ── Input box wiring ──────────────────────────────────────────────────────────
inputBox.on('submit', async (value) => {
inputBox.clearValue();
inputBox.focus();
screen.render();
if (value && value.trim()) {
await handleInput(value);
}
});
// Pressing Enter submits, but blessed's textbox needs this nudge
inputBox.key('enter', () => inputBox.submit());
// ── Boot ──────────────────────────────────────────────────────────────────────
info(`Connecting to ${SERVER_URL} as bot in #${CHANNEL}...`);
info('Type /help for available commands.');
inputBox.focus();
screen.render();

View file

@ -1,283 +0,0 @@
{
"name": "cytube-demo-bot",
"version": "1.0.0",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "cytube-demo-bot",
"version": "1.0.0",
"dependencies": {
"blessed": "^0.1.81",
"dotenv": "^16.0.0",
"node-fetch": "^2.7.0",
"socket.io-client": "^4.7.0"
}
},
"node_modules/@socket.io/component-emitter": {
"version": "3.1.2",
"resolved": "https://registry.npmjs.org/@socket.io/component-emitter/-/component-emitter-3.1.2.tgz",
"integrity": "sha512-9BCxFwvbGg/RsZK9tjXd8s4UcwR0MWeFQ1XEKIQVVvAGJyINdrqKMcTRyLoK8Rse1GjzLV9cwjWV1olXRWEXVA=="
},
"node_modules/blessed": {
"version": "0.1.81",
"resolved": "https://registry.npmjs.org/blessed/-/blessed-0.1.81.tgz",
"integrity": "sha512-LoF5gae+hlmfORcG1M5+5XZi4LBmvlXTzwJWzUlPryN/SJdSflZvROM2TwkT0GMpq7oqT48NRd4GS7BiVBc5OQ==",
"bin": {
"blessed": "bin/tput.js"
},
"engines": {
"node": ">= 0.8.0"
}
},
"node_modules/debug": {
"version": "4.4.3",
"resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz",
"integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==",
"dependencies": {
"ms": "^2.1.3"
},
"engines": {
"node": ">=6.0"
},
"peerDependenciesMeta": {
"supports-color": {
"optional": true
}
}
},
"node_modules/dotenv": {
"version": "16.6.1",
"resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.6.1.tgz",
"integrity": "sha512-uBq4egWHTcTt33a72vpSG0z3HnPuIl6NqYcTrKEg2azoEyl2hpW0zqlxysq2pK9HlDIHyHyakeYaYnSAwd8bow==",
"engines": {
"node": ">=12"
},
"funding": {
"url": "https://dotenvx.com"
}
},
"node_modules/engine.io-client": {
"version": "6.6.4",
"resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-6.6.4.tgz",
"integrity": "sha512-+kjUJnZGwzewFDw951CDWcwj35vMNf2fcj7xQWOctq1F2i1jkDdVvdFG9kM/BEChymCH36KgjnW0NsL58JYRxw==",
"dependencies": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.4.1",
"engine.io-parser": "~5.2.1",
"ws": "~8.18.3",
"xmlhttprequest-ssl": "~2.1.1"
}
},
"node_modules/engine.io-parser": {
"version": "5.2.3",
"resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-5.2.3.tgz",
"integrity": "sha512-HqD3yTBfnBxIrbnM1DoD6Pcq8NECnh8d4As1Qgh0z5Gg3jRRIqijury0CL3ghu/edArpUYiYqQiDUQBIs4np3Q==",
"engines": {
"node": ">=10.0.0"
}
},
"node_modules/ms": {
"version": "2.1.3",
"resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
"integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="
},
"node_modules/node-fetch": {
"version": "2.7.0",
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz",
"integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==",
"dependencies": {
"whatwg-url": "^5.0.0"
},
"engines": {
"node": "4.x || >=6.0.0"
},
"peerDependencies": {
"encoding": "^0.1.0"
},
"peerDependenciesMeta": {
"encoding": {
"optional": true
}
}
},
"node_modules/socket.io-client": {
"version": "4.8.3",
"resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-4.8.3.tgz",
"integrity": "sha512-uP0bpjWrjQmUt5DTHq9RuoCBdFJF10cdX9X+a368j/Ft0wmaVgxlrjvK3kjvgCODOMMOz9lcaRzxmso0bTWZ/g==",
"dependencies": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.4.1",
"engine.io-client": "~6.6.1",
"socket.io-parser": "~4.2.4"
},
"engines": {
"node": ">=10.0.0"
}
},
"node_modules/socket.io-parser": {
"version": "4.2.6",
"resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-4.2.6.tgz",
"integrity": "sha512-asJqbVBDsBCJx0pTqw3WfesSY0iRX+2xzWEWzrpcH7L6fLzrhyF8WPI8UaeM4YCuDfpwA/cgsdugMsmtz8EJeg==",
"dependencies": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.4.1"
},
"engines": {
"node": ">=10.0.0"
}
},
"node_modules/tr46": {
"version": "0.0.3",
"resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
"integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw=="
},
"node_modules/webidl-conversions": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
"integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ=="
},
"node_modules/whatwg-url": {
"version": "5.0.0",
"resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
"integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==",
"dependencies": {
"tr46": "~0.0.3",
"webidl-conversions": "^3.0.0"
}
},
"node_modules/ws": {
"version": "8.18.3",
"resolved": "https://registry.npmjs.org/ws/-/ws-8.18.3.tgz",
"integrity": "sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg==",
"engines": {
"node": ">=10.0.0"
},
"peerDependencies": {
"bufferutil": "^4.0.1",
"utf-8-validate": ">=5.0.2"
},
"peerDependenciesMeta": {
"bufferutil": {
"optional": true
},
"utf-8-validate": {
"optional": true
}
}
},
"node_modules/xmlhttprequest-ssl": {
"version": "2.1.2",
"resolved": "https://registry.npmjs.org/xmlhttprequest-ssl/-/xmlhttprequest-ssl-2.1.2.tgz",
"integrity": "sha512-TEU+nJVUUnA4CYJFLvK5X9AOeH4KvDvhIfm0vV1GaQRtchnG0hgK5p8hw/xjv8cunWYCsiPCSDzObPyhEwq3KQ==",
"engines": {
"node": ">=0.4.0"
}
}
},
"dependencies": {
"@socket.io/component-emitter": {
"version": "3.1.2",
"resolved": "https://registry.npmjs.org/@socket.io/component-emitter/-/component-emitter-3.1.2.tgz",
"integrity": "sha512-9BCxFwvbGg/RsZK9tjXd8s4UcwR0MWeFQ1XEKIQVVvAGJyINdrqKMcTRyLoK8Rse1GjzLV9cwjWV1olXRWEXVA=="
},
"blessed": {
"version": "0.1.81",
"resolved": "https://registry.npmjs.org/blessed/-/blessed-0.1.81.tgz",
"integrity": "sha512-LoF5gae+hlmfORcG1M5+5XZi4LBmvlXTzwJWzUlPryN/SJdSflZvROM2TwkT0GMpq7oqT48NRd4GS7BiVBc5OQ=="
},
"debug": {
"version": "4.4.3",
"resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz",
"integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==",
"requires": {
"ms": "^2.1.3"
}
},
"dotenv": {
"version": "16.6.1",
"resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.6.1.tgz",
"integrity": "sha512-uBq4egWHTcTt33a72vpSG0z3HnPuIl6NqYcTrKEg2azoEyl2hpW0zqlxysq2pK9HlDIHyHyakeYaYnSAwd8bow=="
},
"engine.io-client": {
"version": "6.6.4",
"resolved": "https://registry.npmjs.org/engine.io-client/-/engine.io-client-6.6.4.tgz",
"integrity": "sha512-+kjUJnZGwzewFDw951CDWcwj35vMNf2fcj7xQWOctq1F2i1jkDdVvdFG9kM/BEChymCH36KgjnW0NsL58JYRxw==",
"requires": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.4.1",
"engine.io-parser": "~5.2.1",
"ws": "~8.18.3",
"xmlhttprequest-ssl": "~2.1.1"
}
},
"engine.io-parser": {
"version": "5.2.3",
"resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-5.2.3.tgz",
"integrity": "sha512-HqD3yTBfnBxIrbnM1DoD6Pcq8NECnh8d4As1Qgh0z5Gg3jRRIqijury0CL3ghu/edArpUYiYqQiDUQBIs4np3Q=="
},
"ms": {
"version": "2.1.3",
"resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
"integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="
},
"node-fetch": {
"version": "2.7.0",
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz",
"integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==",
"requires": {
"whatwg-url": "^5.0.0"
}
},
"socket.io-client": {
"version": "4.8.3",
"resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-4.8.3.tgz",
"integrity": "sha512-uP0bpjWrjQmUt5DTHq9RuoCBdFJF10cdX9X+a368j/Ft0wmaVgxlrjvK3kjvgCODOMMOz9lcaRzxmso0bTWZ/g==",
"requires": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.4.1",
"engine.io-client": "~6.6.1",
"socket.io-parser": "~4.2.4"
}
},
"socket.io-parser": {
"version": "4.2.6",
"resolved": "https://registry.npmjs.org/socket.io-parser/-/socket.io-parser-4.2.6.tgz",
"integrity": "sha512-asJqbVBDsBCJx0pTqw3WfesSY0iRX+2xzWEWzrpcH7L6fLzrhyF8WPI8UaeM4YCuDfpwA/cgsdugMsmtz8EJeg==",
"requires": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.4.1"
}
},
"tr46": {
"version": "0.0.3",
"resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
"integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw=="
},
"webidl-conversions": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
"integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ=="
},
"whatwg-url": {
"version": "5.0.0",
"resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
"integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==",
"requires": {
"tr46": "~0.0.3",
"webidl-conversions": "^3.0.0"
}
},
"ws": {
"version": "8.18.3",
"resolved": "https://registry.npmjs.org/ws/-/ws-8.18.3.tgz",
"integrity": "sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg==",
"requires": {}
},
"xmlhttprequest-ssl": {
"version": "2.1.2",
"resolved": "https://registry.npmjs.org/xmlhttprequest-ssl/-/xmlhttprequest-ssl-2.1.2.tgz",
"integrity": "sha512-TEU+nJVUUnA4CYJFLvK5X9AOeH4KvDvhIfm0vV1GaQRtchnG0hgK5p8hw/xjv8cunWYCsiPCSDzObPyhEwq3KQ=="
}
}
}

View file

@ -1,15 +0,0 @@
{
"name": "cytube-demo-bot",
"version": "1.0.0",
"description": "Demo bot for the CyTube Sync bot API — TUI chat client + REST queries",
"main": "bot.js",
"scripts": {
"start": "node bot.js"
},
"dependencies": {
"blessed": "^0.1.81",
"dotenv": "^16.0.0",
"node-fetch": "^2.7.0",
"socket.io-client": "^4.7.0"
}
}

View file

@ -1,32 +0,0 @@
# Python Show Bot Example
Uses `veretube-bot==0.1.4` with `AsyncBot` and the built-in Shows API helpers.
## Setup
```bash
cd examples/python-show-bot
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
Set environment variables:
- `BOT_TOKEN` (required)
- `CHANNEL` (required)
- `SOCKET_URL` (default: `http://localhost:1337`)
- `API_BASE` (default: `http://localhost:8080/api/v1`)
- `SHOW_TIMEZONE` (default: `UTC`, must be valid IANA timezone)
Run:
```bash
python bot.py
```
## Chat Commands
- `!shows` - list shows
- `!mkshow` - create a demo show
- `!runshow <id>` - run a show immediately

View file

@ -1,116 +0,0 @@
"""
Veretube Python Show Bot example (veretube-bot 0.1.4)
Commands in chat:
!shows -> list existing shows
!mkshow -> create an example show scheduled ~2 minutes from now
!show <id> -> inspect a show from API
!runshow <id> -> trigger immediate run of a show
"""
from datetime import datetime, timedelta, timezone
import asyncio
import os
from veretube_bot import AsyncBot, BotAPIError
BOT_TOKEN = os.getenv("BOT_TOKEN", "TOKEN_HERE")
CHANNEL = os.getenv("CHANNEL", "CHANNEL_NAME_HERE")
SOCKET_URL = os.getenv("SOCKET_URL", "http://localhost:1337")
API_BASE = os.getenv("API_BASE", "http://localhost:8080/api/v1")
SHOW_TIMEZONE = os.getenv("SHOW_TIMEZONE", "UTC")
bot = AsyncBot(
token=BOT_TOKEN,
channel=CHANNEL,
socket_url=SOCKET_URL,
api_url=API_BASE,
)
def create_example_show_payload() -> dict:
# Schedule a couple minutes in the future to make testing easy.
scheduled_for = datetime.now(timezone.utc) + timedelta(minutes=2)
return {
"name": f"Python Demo Show {scheduled_for.strftime('%H:%M:%S')}",
"scheduled_for": scheduled_for.isoformat(),
"timezone": SHOW_TIMEZONE,
"recurrence": "none",
"fill_mode": "append",
"conflict_mode": "force",
"start_playback": False,
"status": "scheduled",
"playlist": [
{"type": "yt", "id": "dQw4w9WgXcQ", "pos": "end"},
{"type": "yt", "id": "9bZkp7q19f0", "pos": "end"},
],
}
@bot.on("chatMsg")
async def on_chat(data):
msg = (data.get("msg") or "").strip()
if msg == "!shows":
try:
shows = await bot.list_shows()
except BotAPIError as err:
await bot.send_message(f"shows error: {err}")
return
if not shows:
await bot.send_message("No shows configured")
return
summary = ", ".join([f"#{s['id']} {s['name']} ({s['status']})" for s in shows[:4]])
await bot.send_message(f"Shows: {summary}")
elif msg == "!mkshow":
try:
show = await bot.create_show(create_example_show_payload())
persisted = await bot.get_show(show["id"])
await bot.send_message(
f"Created show #{persisted['id']} status={persisted.get('status')} "
f"scheduled_for={persisted.get('scheduled_for')} timezone={persisted.get('timezone')}"
)
except BotAPIError as err:
await bot.send_message(f"create show error: {err}")
elif msg.startswith("!runshow "):
parts = msg.split()
if len(parts) != 2 or not parts[1].isdigit():
await bot.send_message("Usage: !runshow <show_id>")
return
show_id = int(parts[1])
try:
result = await bot.show_action(show_id, "run")
await bot.send_message(f"Show #{result['id']} run action complete, status={result['status']}")
except BotAPIError as err:
await bot.send_message(f"run show error: {err}")
elif msg.startswith("!show "):
parts = msg.split()
if len(parts) != 2 or not parts[1].isdigit():
await bot.send_message("Usage: !show <show_id>")
return
show_id = int(parts[1])
try:
show = await bot.get_show(show_id)
await bot.send_message(
f"Show #{show['id']}: status={show.get('status')} "
f"scheduled_for={show.get('scheduled_for')} timezone={show.get('timezone')}"
)
except BotAPIError as err:
await bot.send_message(f"show lookup error: {err}")
@bot.on("changeMedia")
async def on_media(data):
title = data.get("title", "(unknown)")
await bot.send_message(f"Now playing: {title}")
if __name__ == "__main__":
asyncio.run(bot.run())

View file

@ -1,23 +0,0 @@
aiohappyeyeballs==2.6.2
aiohttp==3.13.5
aiosignal==1.4.0
async-timeout==5.0.1
attrs==26.1.0
bidict==0.23.1
certifi==2026.5.20
charset-normalizer==3.4.7
frozenlist==1.8.0
h11==0.16.0
idna==3.15
multidict==6.7.1
propcache==0.5.2
python-engineio==4.13.1
python-socketio==5.16.1
requests==2.33.1
simple-websocket==1.1.0
typing_extensions==4.15.0
urllib3==2.7.0
veretube-bot==0.1.4
websocket-client==1.9.0
wsproto==1.3.2
yarl==1.24.2

View file

@ -1,26 +0,0 @@
from veretube_bot import Bot, Rank
bot = Bot(
token="TOKEN_HERE",
channel="CHANNEL_NAME_HERE",
socket_url="http://localhost:1337",
api_url="http://localhost:8080/api/v1"
)
@bot.on("chatMsg")
def on_chat(data):
if data["msg"] == "!playlist":
playlist = bot.api.get_playlist()
bot.send_message(f"{len(playlist['items'])} items in queue")
elif data["msg"].startswith("!kick "):
name = data["msg"].split(" ", 1)[1]
bot.kick(name, "Kicked by command")
elif data["msg"] == "!emotes":
emotes = bot.get_emotes()
print(emotes)
@bot.on("changeMedia")
def on_media(data):
bot.send_message(f"Now playing: {data['title']}")
bot.run()

View file

@ -1,13 +0,0 @@
bidict==0.23.1
certifi==2026.4.22
charset-normalizer==3.4.7
h11==0.16.0
idna==3.13
python-engineio==4.13.1
python-socketio==5.16.1
requests==2.33.1
simple-websocket==1.1.0
urllib3==2.6.3
veretube-bot==0.1.0
websocket-client==1.9.0
wsproto==1.3.2

View file

@ -5,32 +5,24 @@
// {INCLUDE_BLOCK} // {INCLUDE_BLOCK}
// @grant unsafeWindow // @grant unsafeWindow
// @grant GM_xmlhttpRequest // @grant GM_xmlhttpRequest
// @grant GM.xmlHttpRequest
// @connect docs.google.com // @connect docs.google.com
// @run-at document-end // @run-at document-end
// @version 1.7.0 // @version 1.1.0
// ==/UserScript== // ==/UserScript==
try { try {
function debug(message) { function debug(message) {
if (!unsafeWindow.enableCyTubeGoogleDriveUserscriptDebug) {
return;
}
try { try {
unsafeWindow.console.log('[Drive]', message); unsafeWindow.console.log(message);
} catch (error) { } catch (error) {
unsafeWindow.console.error(error); unsafeWindow.console.error(error);
} }
} }
function httpRequest(opts) {
if (typeof GM_xmlhttpRequest === 'undefined') {
// Assume GM4.0
debug('Using GM4.0 GM.xmlHttpRequest');
GM.xmlHttpRequest(opts);
} else {
debug('Using old-style GM_xmlhttpRequest');
GM_xmlhttpRequest(opts);
}
}
var ITAG_QMAP = { var ITAG_QMAP = {
37: 1080, 37: 1080,
46: 1080, 46: 1080,
@ -58,53 +50,35 @@ try {
}; };
function getVideoInfo(id, cb) { function getVideoInfo(id, cb) {
var url = 'https://docs.google.com/get_video_info?authuser=' var url = 'https://docs.google.com/file/d/' + id + '/get_video_info';
+ '&docid=' + id
+ '&sle=true'
+ '&hl=en';
debug('Fetching ' + url); debug('Fetching ' + url);
httpRequest({ GM_xmlhttpRequest({
method: 'GET', method: 'GET',
url: url, url: url,
onload: function (res) { onload: function (res) {
try { try {
debug('Got response ' + res.responseText); debug('Got response ' + res.responseText);
if (res.status !== 200) {
debug('Response status not 200: ' + res.status);
return cb(
'Google Drive request failed: HTTP ' + res.status
);
}
var data = {}; var data = {};
var error; var error;
// Google Santa sometimes eats login cookies and gets mad if there aren't any.
if(/accounts\.google\.com\/ServiceLogin/.test(res.responseText)){
error = 'Google Docs request failed: ' +
'This video requires you be logged into a Google account. ' +
'Open your Gmail in another tab and then refresh video.';
return cb(error);
}
res.responseText.split('&').forEach(function (kv) { res.responseText.split('&').forEach(function (kv) {
var pair = kv.split('='); var pair = kv.split('=');
data[decodeURIComponent(pair[0])] = decodeURIComponent(pair[1]); data[decodeURIComponent(pair[0])] = decodeURIComponent(pair[1]);
}); });
if (data.status === 'fail') { if (data.status === 'fail') {
error = 'Google Drive request failed: ' + error = new Error('Google Docs request failed: ' +
unescape(data.reason).replace(/\+/g, ' '); 'metadata indicated status=fail');
error.response = res.responseText;
error.reason = 'RESPONSE_STATUS_FAIL';
return cb(error); return cb(error);
} }
if (!data.fmt_stream_map) { if (!data.fmt_stream_map) {
error = ( error = new Error('Google Docs request failed: ' +
'Google has removed the video streams associated' + 'metadata lookup returned no valid links');
' with this item. It can no longer be played.' error.response = res.responseText;
); error.reason = 'MISSING_LINKS';
return cb(error); return cb(error);
} }
@ -122,8 +96,8 @@ try {
}, },
onerror: function () { onerror: function () {
var error = 'Google Drive request failed: ' + var error = new Error('Google Docs request failed: ' +
'metadata lookup HTTP request failed'; 'metadata lookup HTTP request failed');
error.reason = 'HTTP_ONERROR'; error.reason = 'HTTP_ONERROR';
return cb(error); return cb(error);
} }
@ -212,20 +186,15 @@ try {
}, 1000); }, 1000);
} }
var TM_COMPATIBLES = [ function isRunningTampermonkey() {
'Tampermonkey',
'Violentmonkey' // https://github.com/calzoneman/sync/issues/713
];
function isTampermonkeyCompatible() {
try { try {
return TM_COMPATIBLES.indexOf(GM_info.scriptHandler) >= 0; return GM_info.scriptHandler === 'Tampermonkey';
} catch (error) { } catch (error) {
return false; return false;
} }
} }
if (isTampermonkeyCompatible()) { if (isRunningTampermonkey()) {
unsafeWindow.getGoogleDriveMetadata = getVideoInfo; unsafeWindow.getGoogleDriveMetadata = getVideoInfo;
} else { } else {
debug('Using non-TM polling workaround'); debug('Using non-TM polling workaround');
@ -236,8 +205,6 @@ try {
unsafeWindow.console.log('Initialized userscript Google Drive player'); unsafeWindow.console.log('Initialized userscript Google Drive player');
unsafeWindow.hasDriveUserscript = true; unsafeWindow.hasDriveUserscript = true;
// Checked against GS_VERSION from data.js
unsafeWindow.driveUserscriptVersion = '1.7';
} catch (error) { } catch (error) {
unsafeWindow.console.error(error); unsafeWindow.console.error(error);
} }

View file

@ -8,30 +8,12 @@ var includes = process.argv.slice(3).map(function (include) {
var lines = String(fs.readFileSync( var lines = String(fs.readFileSync(
path.resolve(__dirname, 'cytube-google-drive.user.js'))).split('\n'); path.resolve(__dirname, 'cytube-google-drive.user.js'))).split('\n');
var userscriptOutput = '';
var metaOutput = '';
lines.forEach(function (line) { lines.forEach(function (line) {
if (line.match(/\{INCLUDE_BLOCK\}/)) { if (line.match(/\{INCLUDE_BLOCK\}/)) {
userscriptOutput += includes + '\n'; console.log(includes);
} else if (line.match(/\{SITENAME\}/)) { } else if (line.match(/\{SITENAME\}/)) {
line = line.replace(/\{SITENAME\}/, sitename) + '\n'; console.log(line.replace(/\{SITENAME\}/, sitename));
userscriptOutput += line;
metaOutput += line;
} else { } else {
if (line.match(/==\/?UserScript|@name|@version/)) { console.log(line);
metaOutput += line + '\n';
}
userscriptOutput += line + '\n';
} }
}); });
fs.writeFileSync(
path.join(__dirname, '..', 'www', 'js', 'cytube-google-drive.user.js'),
userscriptOutput
);
fs.writeFileSync(
path.join(__dirname, '..', 'www', 'js', 'cytube-google-drive.meta.js'),
metaOutput
);

180
index.js Executable file → Normal file
View file

@ -1,56 +1,17 @@
#!/usr/bin/env node if (/^v0/.test(process.version)) {
console.error('node.js ' + process.version + ' is not supported. ' +
const ver = process.version.match(/v(\d+)\.\d+\.\d+/); 'For more information, visit ' +
'https://github.com/calzoneman/sync/wiki/CyTube-3.0-Installation-Guide#nodejs');
if (parseInt(ver[1], 10) < 12) {
console.error(
`node.js ${process.version} is not supported. ` +
'CyTube requires node v12 or later.'
)
process.exit(1); process.exit(1);
} }
checkPlayerExists(); try {
var Server = require("./lib/server");
const args = parseArgs(); } catch (err) {
console.error('FATAL: Failed to require() lib/server.js');
if (args.has('--daemonize')) {
fork();
} else {
try {
require('./lib/main');
} catch (err) {
console.error('FATAL: Failed to require() lib/main.js');
handleStartupError(err);
}
}
function fork() {
try {
console.log('Warning: --daemonize support is experimental. Use with caution.');
const spawn = require('child_process').spawn;
const path = require('path');
const main = path.resolve(__dirname, 'lib', 'main.js');
const child = spawn(process.argv[0], [main], {
detached: true,
stdio: 'ignore' // TODO: support setting stdout/stderr logfile
});
child.unref();
console.log('Forked with PID ' + child.pid);
} catch (error) {
console.error('FATAL: Failed to fork lib/main.js');
handleStartupError(error);
}
}
function handleStartupError(err) {
if (/module version mismatch/i.test(err.message)) { if (/module version mismatch/i.test(err.message)) {
console.error('Module version mismatch, try running `npm rebuild` or ' + console.error('Module version mismatch, try running `npm rebuild` or removing ' +
'removing the node_modules folder and re-running ' + 'the node_modules folder and re-running `npm install`');
'`npm install`');
} else { } else {
console.error('Possible causes:\n' + console.error('Possible causes:\n' +
' * You haven\'t run `npm run build-server` to regenerate ' + ' * You haven\'t run `npm run build-server` to regenerate ' +
@ -60,39 +21,108 @@ function handleStartupError(err) {
' * A dependency failed to install correctly (check the output ' + ' * A dependency failed to install correctly (check the output ' +
'of `npm install` next time)'); 'of `npm install` next time)');
} }
console.error(err.stack); console.error(err.stack);
process.exit(1); process.exit(1);
} }
var Config = require("./lib/config");
var Logger = require("./lib/logger");
const Switches = require("./lib/switches");
require("source-map-support").install();
function parseArgs() { Config.load("config.yaml");
const args = new Map(); var sv = Server.init();
for (var i = 2; i < process.argv.length; i++) { if (!Config.get("debug")) {
if (/^--/.test(process.argv[i])) { process.on("uncaughtException", function (err) {
var val; Logger.errlog.log("[SEVERE] Uncaught Exception: " + err);
if (i+1 < process.argv.length) val = process.argv[i+1]; Logger.errlog.log(err.stack);
else val = null; });
args.set(process.argv[i], val); process.on("SIGINT", function () {
sv.shutdown();
});
}
var stdinbuf = "";
process.stdin.on("data", function (data) {
stdinbuf += data;
if (stdinbuf.indexOf("\n") !== -1) {
var line = stdinbuf.substring(0, stdinbuf.indexOf("\n"));
stdinbuf = stdinbuf.substring(stdinbuf.indexOf("\n") + 1);
handleLine(line);
}
});
var validIP = require('net').isIP;
function handleLine(line) {
if (line === "/reload") {
Logger.syslog.log("Reloading config");
Config.load("config.yaml");
} else if (line === "/gc") {
if (global && global.gc) {
Logger.syslog.log("Running GC");
global.gc();
} else {
Logger.syslog.log("Failed to invoke GC: node started without --expose-gc");
}
} else if (line === "/delete_old_tables") {
require("./lib/database/update").deleteOldChannelTables(function (err) {
if (!err) {
Logger.syslog.log("Deleted old channel tables");
}
});
} else if (line.indexOf("/switch") === 0) {
var args = line.split(" ");
args.shift();
if (args.length === 1) {
Logger.syslog.log("Switch " + args[0] + " is " +
(Switches.isActive(args[0]) ? "ON" : "OFF"));
} else if (args.length === 2) {
Switches.setActive(args[0], args[1].toLowerCase() === "on" ? true : false);
Logger.syslog.log("Switch " + args[0] + " is now " +
(Switches.isActive(args[0]) ? "ON" : "OFF"));
}
} else if (line.indexOf("/reload-partitions") === 0) {
sv.reloadPartitionMap();
} else if (line.indexOf("/globalban") === 0) {
var args = line.split(/\s+/); args.shift();
if (args.length >= 2 && validIP(args[0]) !== 0) {
var ip = args.shift();
var comment = args.join(' ');
require("./lib/database").globalBanIP(ip, comment, function (err, res) {
if (!err) {
Logger.eventlog.log("[acp] " + "SYSTEM" + " global banned " + ip);
}
})
}
} else if (line.indexOf("/unglobalban") === 0) {
var args = line.split(/\s+/); args.shift();
if (args.length >= 1 && validIP(args[0]) !== 0) {
var ip = args.shift();
require("./lib/database").globalUnbanIP(ip, function (err, res) {
if (!err) {
Logger.eventlog.log("[acp] " + "SYSTEM" + " un-global banned " + ip);
}
})
}
} else if (line.indexOf("/unloadchan") === 0) {
var args = line.split(/\s+/); args.shift();
if(args.length){
var name = args.shift();
var chan = sv.getChannel(name);
var users = Array.prototype.slice.call(chan.users);
chan.emit("empty");
users.forEach(function (u) {
u.kick("Channel shutting down");
});
Logger.eventlog.log("[acp] " + "SYSTEM" + " forced unload of " + name);
} }
} }
return args;
} }
function checkPlayerExists() { // Go Go Gadget Service Socket
const fs = require('fs'); if (Config.get("service-socket.enabled")) {
const path = require('path'); Logger.syslog.log("Opening service socket");
var ServiceSocket = require('./lib/servsock');
const playerDotJs = path.join(__dirname, 'www', 'js', 'player.js'); var server = new ServiceSocket;
server.init(handleLine, Config.get("service-socket.socket"));
if (!fs.existsSync(playerDotJs)) {
console.error(
'Missing video player: www/js/player.js. This should have been ' +
'automatically generated by the postinstall step of ' +
'`npm install`, but you can manually regenerate it by running ' +
'`npm run build-player`'
);
process.exit(1);
}
} }

View file

@ -1,603 +0,0 @@
const assert = require('assert');
const KickbanModule = require('../../lib/channel/kickban');
const database = require('../../lib/database');
const Promise = require('bluebird');
const testDB = require('../testutil/db').testDB;
database.init(testDB);
describe('KickbanModule', () => {
const channelName = `test_${Math.random().toString(31).substring(2)}`;
let mockChannel;
let mockUser;
let kickban;
beforeEach(() => {
mockChannel = {
name: channelName,
refCounter: {
ref() { },
unref() { }
},
logger: {
log() { }
},
modules: {
permissions: {
canBan() {
return true;
}
}
},
users: []
};
mockUser = {
getName() {
return 'The_Admin';
},
getLowerName() {
return 'the_admin';
},
socket: {
emit(frame) {
if (frame === 'errorMsg') {
throw new Error(arguments[1].msg);
}
}
},
account: {
effectiveRank: 3
}
};
kickban = new KickbanModule(mockChannel);
});
afterEach(async () => {
await database.getDB().runTransaction(async tx => {
await tx.table('channel_bans')
.where({ channel: channelName })
.del();
await tx.table('channel_ranks')
.where({ channel: channelName })
.del();
});
});
describe('#handleCmdBan', () => {
it('inserts a valid ban', done => {
let kicked = false;
mockChannel.refCounter.unref = () => {
assert(kicked, 'Expected user to be kicked');
database.getDB().runTransaction(async tx => {
const ban = await tx.table('channel_bans')
.where({
channel: channelName,
name: 'test_user'
})
.first();
assert.strictEqual(ban.ip, '*');
assert.strictEqual(ban.reason, 'because reasons');
assert.strictEqual(ban.bannedby, mockUser.getName());
done();
});
};
mockChannel.users = [{
getLowerName() {
return 'test_user';
},
kick(reason) {
assert.strictEqual(reason, "You're banned!");
kicked = true;
}
}];
kickban.handleCmdBan(
mockUser,
'/ban test_user because reasons',
{}
);
});
it('rejects if the username is invalid', done => {
mockUser.socket.emit = (frame, obj) => {
if (frame === 'errorMsg') {
assert.strictEqual(
obj.msg,
'Invalid username'
);
done();
}
};
kickban.handleCmdBan(
mockUser,
'/ban test_user<>%$# because reasons',
{}
);
});
it('rejects if the user does not have ban permission', done => {
mockUser.socket.emit = (frame, obj) => {
if (frame === 'errorMsg') {
assert.strictEqual(
obj.msg,
'You do not have ban permissions on this channel'
);
done();
}
};
mockChannel.modules.permissions.canBan = () => false;
kickban.handleCmdBan(
mockUser,
'/ban test_user because reasons',
{}
);
});
it('rejects if the user tries to ban themselves', done => {
let costanza = false;
mockUser.socket.emit = (frame, obj) => {
if (frame === 'errorMsg') {
assert.strictEqual(
obj.msg,
'You cannot ban yourself'
);
if (!costanza) {
throw new Error('Expected costanza for banning self');
}
done();
} else if (frame === 'costanza') {
assert.strictEqual(
obj.msg,
"You can't ban yourself"
);
costanza = true;
}
};
kickban.handleCmdBan(
mockUser,
'/ban the_Admin because reasons',
{}
);
});
it('rejects if the user is ranked below the ban recipient', done => {
database.getDB().runTransaction(tx => {
return tx.table('channel_ranks')
.insert({
channel: channelName,
name: 'test_user',
rank: 5
});
}).then(() => {
mockUser.socket.emit = (frame, obj) => {
if (frame === 'errorMsg') {
assert.strictEqual(
obj.msg,
"You don't have permission to ban test_user"
);
done();
}
};
kickban.handleCmdBan(
mockUser,
'/ban test_user because reasons',
{}
);
});
});
it('rejects if the the ban recipient is already banned', done => {
database.getDB().runTransaction(tx => {
return tx.table('channel_bans')
.insert({
channel: channelName,
name: 'test_user',
ip: '*',
bannedby: 'somebody',
reason: 'I dunno'
});
}).then(() => {
mockUser.socket.emit = (frame, obj) => {
if (frame === 'errorMsg') {
assert.strictEqual(
obj.msg,
'test_user is already banned'
);
done();
}
};
kickban.handleCmdBan(
mockUser,
'/ban test_user because reasons',
{}
);
});
});
});
describe('#handleCmdIPBan', () => {
beforeEach(async () => {
await database.getDB().runTransaction(async tx => {
await tx.table('aliases')
.insert([{
name: 'test_user',
ip: '1.2.3.4',
time: Date.now()
}]);
});
});
afterEach(async () => {
await database.getDB().runTransaction(async tx => {
await tx.table('aliases')
.where({ name: 'test_user' })
.orWhere({ ip: '1.2.3.4' })
.del();
});
});
it('inserts a valid ban', done => {
let firstUserKicked = false;
let secondUserKicked = false;
mockChannel.refCounter.unref = () => {
assert(firstUserKicked, 'Expected banned user to be kicked');
assert(
secondUserKicked,
'Expected user with banned IP to be kicked'
);
database.getDB().runTransaction(async tx => {
const nameBan = await tx.table('channel_bans')
.where({
channel: channelName,
name: 'test_user',
ip: '*'
})
.first();
assert.strictEqual(nameBan.reason, 'because reasons');
assert.strictEqual(nameBan.bannedby, mockUser.getName());
const ipBan = await tx.table('channel_bans')
.where({
channel: channelName,
ip: '1.2.3.4'
})
.first();
assert.strictEqual(ipBan.name, 'test_user');
assert.strictEqual(ipBan.reason, 'because reasons');
assert.strictEqual(ipBan.bannedby, mockUser.getName());
done();
});
};
mockChannel.users = [{
getLowerName() {
return 'test_user';
},
realip: '1.2.3.4',
kick(reason) {
assert.strictEqual(reason, "You're banned!");
firstUserKicked = true;
}
}, {
getLowerName() {
return 'second_user_same_ip';
},
realip: '1.2.3.4',
kick(reason) {
assert.strictEqual(reason, "You're banned!");
secondUserKicked = true;
}
}];
kickban.handleCmdIPBan(
mockUser,
'/ipban test_user because reasons',
{}
);
});
it('inserts a valid range ban', done => {
mockChannel.refCounter.unref = () => {
database.getDB().runTransaction(async tx => {
const ipBan = await tx.table('channel_bans')
.where({
channel: channelName,
ip: '1.2.3'
})
.first();
assert.strictEqual(ipBan.name, 'test_user');
assert.strictEqual(ipBan.reason, 'because reasons');
assert.strictEqual(ipBan.bannedby, mockUser.getName());
done();
});
};
kickban.handleCmdIPBan(
mockUser,
'/ipban test_user range because reasons',
{}
);
});
it('inserts a valid wide-range ban', done => {
mockChannel.refCounter.unref = () => {
database.getDB().runTransaction(async tx => {
const ipBan = await tx.table('channel_bans')
.where({
channel: channelName,
ip: '1.2'
})
.first();
assert.strictEqual(ipBan.name, 'test_user');
assert.strictEqual(ipBan.reason, 'because reasons');
assert.strictEqual(ipBan.bannedby, mockUser.getName());
done();
});
};
kickban.handleCmdIPBan(
mockUser,
'/ipban test_user wrange because reasons',
{}
);
});
it('inserts a valid IPv6 ban', done => {
const longIP = require('../../lib/utilities').expandIPv6('::abcd');
mockChannel.refCounter.unref = () => {
database.getDB().runTransaction(async tx => {
const ipBan = await tx.table('channel_bans')
.where({
channel: channelName,
ip: longIP
})
.first();
assert.strictEqual(ipBan.name, 'test_user');
assert.strictEqual(ipBan.reason, 'because reasons');
assert.strictEqual(ipBan.bannedby, mockUser.getName());
done();
});
};
database.getDB().runTransaction(async tx => {
await tx.table('aliases')
.insert({
name: 'test_user',
ip: longIP,
time: Date.now()
});
}).then(() => {
kickban.handleCmdIPBan(
mockUser,
'/ipban test_user because reasons',
{}
);
});
});
it('rejects if the user does not have ban permission', done => {
mockUser.socket.emit = (frame, obj) => {
if (frame === 'errorMsg') {
assert.strictEqual(
obj.msg,
'You do not have ban permissions on this channel'
);
done();
}
};
mockChannel.modules.permissions.canBan = () => false;
kickban.handleCmdIPBan(
mockUser,
'/ipban test_user because reasons',
{}
);
});
it('rejects if the user tries to ban themselves', done => {
let costanza = false;
mockUser.socket.emit = (frame, obj) => {
if (frame === 'errorMsg') {
assert.strictEqual(
obj.msg,
'You cannot ban yourself'
);
if (!costanza) {
throw new Error('Expected costanza for banning self');
}
done();
} else if (frame === 'costanza') {
assert.strictEqual(
obj.msg,
"You can't ban yourself"
);
costanza = true;
}
};
kickban.handleCmdIPBan(
mockUser,
'/ipban the_Admin because reasons',
{}
);
});
it('rejects if the user is ranked below the ban recipient', done => {
database.getDB().runTransaction(tx => {
return tx.table('channel_ranks')
.insert({
channel: channelName,
name: 'test_user',
rank: 5
});
}).then(() => {
mockUser.socket.emit = (frame, obj) => {
if (frame === 'errorMsg') {
assert.strictEqual(
obj.msg,
"You don't have permission to ban IP " +
"09l.TFb.5To.HBB"
);
done();
}
};
kickban.handleCmdIPBan(
mockUser,
'/ipban test_user because reasons',
{}
);
});
});
it('rejects if the user is ranked below an alias of the ban recipient', done => {
database.getDB().runTransaction(async tx => {
await tx.table('channel_ranks')
.insert({
channel: channelName,
name: 'another_user',
rank: 5
});
await tx.table('aliases')
.insert({
name: 'another_user',
ip: '1.2.3.3', // different IP, same /24 range
time: Date.now()
});
}).then(() => {
mockUser.socket.emit = (frame, obj) => {
if (frame === 'errorMsg') {
assert.strictEqual(
obj.msg,
"You don't have permission to ban IP " +
"09l.TFb.5To.*"
);
done();
}
};
kickban.handleCmdIPBan(
mockUser,
'/ipban test_user range because reasons',
{}
);
});
});
it('rejects if the the ban recipient IP is already banned', done => {
database.getDB().runTransaction(tx => {
return tx.table('channel_bans')
.insert({
channel: channelName,
name: 'another_user',
ip: '1.2.3.4',
bannedby: 'somebody',
reason: 'I dunno'
});
}).then(() => {
mockUser.socket.emit = (frame, obj) => {
if (frame === 'errorMsg') {
assert.strictEqual(
obj.msg,
'09l.TFb.5To.HBB is already banned'
);
done();
}
};
kickban.handleCmdIPBan(
mockUser,
'/ipban test_user because reasons',
{}
);
});
});
it('still adds the IP ban even if the name is already banned', done => {
mockChannel.refCounter.unref = () => {
database.getDB().runTransaction(async tx => {
const ipBan = await tx.table('channel_bans')
.where({
channel: channelName,
ip: '1.2.3.4'
})
.first();
assert.strictEqual(ipBan.name, 'test_user');
assert.strictEqual(ipBan.reason, 'because reasons');
assert.strictEqual(ipBan.bannedby, mockUser.getName());
done();
});
};
database.getDB().runTransaction(tx => {
return tx.table('channel_bans')
.insert({
channel: channelName,
name: 'test_user',
ip: '*',
bannedby: 'somebody',
reason: 'I dunno'
});
}).then(() => {
kickban.handleCmdIPBan(
mockUser,
'/ipban test_user because reasons',
{}
);
});
});
});
});

View file

@ -1,109 +0,0 @@
const assert = require('assert');
const { BannedChannelsController } = require('../../lib/controller/banned-channels');
const dbChannels = require('../../lib/database/channels');
const testDB = require('../testutil/db').testDB;
const { EventEmitter } = require('events');
require('../../lib/database').init(testDB);
const testBan = {
name: 'ban_test_1',
externalReason: 'because I said so',
internalReason: 'illegal content',
bannedBy: 'admin'
};
async function cleanupTestBan() {
return dbChannels.removeBannedChannel(testBan.name);
}
describe('BannedChannelsController', () => {
let controller;
let messages;
beforeEach(async () => {
await cleanupTestBan();
messages = new EventEmitter();
controller = new BannedChannelsController(
dbChannels,
messages
);
});
afterEach(async () => {
await cleanupTestBan();
});
it('bans a channel', async () => {
assert.strictEqual(await controller.getBannedChannel(testBan.name), null);
let received = null;
messages.once('ChannelBanned', cb => {
received = cb;
});
await controller.banChannel(testBan);
let info = await controller.getBannedChannel(testBan.name);
for (let field of Object.keys(testBan)) {
// Consider renaming parameter to avoid this branch
if (field === 'name') {
assert.strictEqual(info.channelName, testBan.name);
} else {
assert.strictEqual(info[field], testBan[field]);
}
}
assert.notEqual(received, null);
assert.strictEqual(received.channel, testBan.name);
assert.strictEqual(received.externalReason, testBan.externalReason);
});
it('updates an existing ban', async () => {
let received = [];
messages.on('ChannelBanned', cb => {
received.push(cb);
});
await controller.banChannel(testBan);
let testBan2 = { ...testBan, externalReason: 'because of reasons' };
await controller.banChannel(testBan2);
let info = await controller.getBannedChannel(testBan2.name);
for (let field of Object.keys(testBan2)) {
// Consider renaming parameter to avoid this branch
if (field === 'name') {
assert.strictEqual(info.channelName, testBan2.name);
} else {
assert.strictEqual(info[field], testBan2[field]);
}
}
assert.deepStrictEqual(received, [
{
channel: testBan.name,
externalReason: testBan.externalReason
},
{
channel: testBan2.name,
externalReason: testBan2.externalReason
},
]);
});
it('unbans a channel', async () => {
let received = null;
messages.once('ChannelUnbanned', cb => {
received = cb;
});
await controller.banChannel(testBan);
await controller.unbanChannel(testBan.name, testBan.bannedBy);
let info = await controller.getBannedChannel(testBan.name);
assert.strictEqual(info, null);
assert.notEqual(received, null);
assert.strictEqual(received.channel, testBan.name);
});
});

View file

@ -1,88 +0,0 @@
const assert = require('assert');
const { testDB } = require('../testutil/db');
const accounts = require('../../lib/database/accounts');
require('../../lib/database').init(testDB);
describe('AccountsDatabase', () => {
describe('#verifyLogin', () => {
let ip = '169.254.111.111';
let user;
let password;
beforeEach(async () => {
return testDB.knex.table('users')
.where({ ip })
.delete();
});
beforeEach(done => {
user = `u${Math.random().toString(31).substring(2)}`;
password = 'int!gration_Test';
accounts.register(
user,
password,
'',
ip,
(error, res) => {
if (error) {
throw error;
}
console.log(`Created test user ${user}`);
done();
}
)
});
it('verifies a correct login', done => {
accounts.verifyLogin(
user,
password,
(error, res) => {
if (error) {
throw error;
}
assert.strictEqual(res.name, user);
done();
}
);
});
it('verifies a correct login with an older hash', done => {
testDB.knex.table('users')
.where({ name: user })
.update({
// 'test' hashed with old version of bcrypt module
password: '$2b$10$2oCG7O9FFqie7T8O33yQDugFPS0NqkgbQjtThTs7Jr8E1QOzdRruK'
})
.then(() => {
accounts.verifyLogin(
user,
'test',
(error, res) => {
if (error) {
throw error;
}
assert.strictEqual(res.name, user);
done();
}
);
});
});
it('rejects an incorrect login', done => {
accounts.verifyLogin(
user,
'not the right password',
(error, res) => {
assert.strictEqual(error, 'Invalid username/password combination');
done();
}
);
});
});
});

View file

@ -1,76 +0,0 @@
const assert = require('assert');
const AliasesDB = require('../../lib/db/aliases').AliasesDB;
const testDB = require('../testutil/db').testDB;
const aliasesDB = new AliasesDB(testDB);
const testIPs = ['111.111.111.111', '111.111.111.222'];
const testNames = ['itest1', 'itest2'];
function cleanup() {
return testDB.knex.table('aliases')
.where('ip', 'in', testIPs)
.del()
.then(() => {
return testDB.knex.table('aliases')
.where('name', 'in', testNames)
.del();
});
}
function addSomeAliases() {
return cleanup().then(() => {
return testDB.knex.table('aliases')
.insert([
{ ip: testIPs[0], name: testNames[0], time: Date.now() },
{ ip: testIPs[0], name: testNames[1], time: Date.now() },
{ ip: testIPs[1], name: testNames[1], time: Date.now() }
]);
});
}
describe('AliasesDB', () => {
describe('#addAlias', () => {
beforeEach(cleanup);
afterEach(cleanup);
it('adds a new alias', () => {
return aliasesDB.addAlias(testIPs[0], testNames[0])
.then(() => {
return testDB.knex.table('aliases')
.where({ ip: testIPs[0], name: testNames[0] })
.select()
.then(rows => {
assert.strictEqual(rows.length, 1, 'expected 1 row');
});
});
});
});
describe('#getAliasesByIP', () => {
beforeEach(addSomeAliases);
afterEach(cleanup);
it('retrieves aliases by IP', () => {
return aliasesDB.getAliasesByIP(testIPs[0])
.then(names => assert.deepStrictEqual(
names.sort(), testNames.sort()));
});
it('retrieves aliases by partial IP', () => {
return aliasesDB.getAliasesByIP(testIPs[0].substring(4))
.then(names => assert.deepStrictEqual(
names.sort(), testNames.sort()));
});
});
describe('#getIPsByName', () => {
beforeEach(addSomeAliases);
afterEach(cleanup);
it('retrieves IPs by name', () => {
return aliasesDB.getIPsByName(testNames[1])
.then(ips => assert.deepStrictEqual(
ips.sort(), testIPs.sort()));
});
});
});

View file

@ -1,92 +0,0 @@
const assert = require('assert');
const GlobalBanDB = require('../../lib/db/globalban').GlobalBanDB;
const testDB = require('../testutil/db').testDB;
const { o } = require('../testutil/o');
const globalBanDB = new GlobalBanDB(testDB);
const testBan = { ip: '8.8.8.8', reason: 'test' };
function cleanupTestBan() {
return testDB.knex.table('global_bans')
.where({ ip: testBan.ip })
.del();
}
function setupTestBan() {
return testDB.knex.table('global_bans')
.insert(testBan)
.catch(error => {
if (error.code === 'ER_DUP_ENTRY') {
return testDB.knex.table('global_bans')
.where({ ip: testBan.ip })
.update({ reason: testBan.reason });
}
throw error;
});
}
describe('GlobalBanDB', () => {
describe('#listGlobalBans', () => {
beforeEach(setupTestBan);
afterEach(cleanupTestBan);
it('lists existing IP bans', () => {
return globalBanDB.listGlobalBans().then(bans => {
assert.deepStrictEqual([{
ip: '8.8.8.8',
reason: 'test'
}], bans.map(o));
});
});
});
describe('#addGlobalIPBan', () => {
beforeEach(cleanupTestBan);
afterEach(cleanupTestBan);
it('adds a new ban', () => {
return globalBanDB.addGlobalIPBan('8.8.8.8', 'test').then(() => {
return testDB.knex.table('global_bans')
.where({ ip: '8.8.8.8' })
.select()
.then(rows => {
assert.strictEqual(rows.length, 1, 'Expected 1 row');
assert.strictEqual(rows[0].ip, '8.8.8.8');
assert.strictEqual(rows[0].reason, 'test');
});
});
});
it('updates the reason on an existing ban', () => {
return globalBanDB.addGlobalIPBan('8.8.8.8', 'test').then(() => {
return globalBanDB.addGlobalIPBan('8.8.8.8', 'different').then(() => {
return testDB.knex.table('global_bans')
.where({ ip: '8.8.8.8' })
.select()
.then(rows => {
assert.strictEqual(rows.length, 1, 'Expected 1 row');
assert.strictEqual(rows[0].ip, '8.8.8.8');
assert.strictEqual(rows[0].reason, 'different');
});
});
});
});
});
describe('#removeGlobalIPBan', () => {
beforeEach(setupTestBan);
afterEach(cleanupTestBan);
it('removes a ban', () => {
return globalBanDB.removeGlobalIPBan('8.8.8.8').then(() => {
return testDB.knex.table('global_bans')
.where({ ip: '8.8.8.8' })
.select()
.then(rows => {
assert.strictEqual(rows.length, 0, 'Expected 0 rows');
});
});
});
});
});

View file

@ -1,144 +0,0 @@
const assert = require('assert');
const PasswordResetDB = require('../../lib/db/password-reset').PasswordResetDB;
const testDB = require('../testutil/db').testDB;
const { o } = require('../testutil/o');
const passwordResetDB = new PasswordResetDB(testDB);
function cleanup() {
return testDB.knex.table('password_reset').del();
}
describe('PasswordResetDB', () => {
describe('#insert', () => {
beforeEach(cleanup);
const params = {
ip: '1.2.3.4',
name: 'testing',
email: 'test@example.com',
hash: 'abcdef',
expire: 5678
};
it('adds a new password reset', () => {
return passwordResetDB.insert(params).then(() => {
return testDB.knex.table('password_reset')
.where({ name: 'testing' })
.select();
}).then(rows => {
assert.strictEqual(rows.length, 1);
assert.deepStrictEqual(o(rows[0]), params);
});
});
it('overwrites an existing reset for the same name', () => {
return passwordResetDB.insert(params).then(() => {
params.ip = '5.6.7.8';
params.email = 'somethingelse@example.com';
params.hash = 'qwertyuiop';
params.expire = 9999;
return passwordResetDB.insert(params);
}).then(() => {
return testDB.knex.table('password_reset')
.where({ name: 'testing' })
.select();
}).then(rows => {
assert.strictEqual(rows.length, 1);
assert.deepStrictEqual(o(rows[0]), params);
});
});
});
describe('#get', () => {
const reset = {
ip: '1.2.3.4',
name: 'testing',
email: 'test@example.com',
hash: 'abcdef',
expire: 5678
};
beforeEach(() => cleanup().then(() => {
return testDB.knex.table('password_reset').insert(reset);
}));
it('gets a password reset by hash', () => {
return passwordResetDB.get(reset.hash).then(result => {
assert.deepStrictEqual(o(result), reset);
});
});
it('throws when no reset exists for the input', () => {
return passwordResetDB.get('lalala').then(() => {
assert.fail('Expected not found error');
}).catch(error => {
assert.strictEqual(
error.message,
'No password reset found for hash lalala'
);
});
});
});
describe('#delete', () => {
const reset = {
ip: '1.2.3.4',
name: 'testing',
email: 'test@example.com',
hash: 'abcdef',
expire: 5678
};
beforeEach(() => cleanup().then(() => {
return testDB.knex.table('password_reset').insert(reset);
}));
it('deletes a password reset by hash', () => {
return passwordResetDB.delete(reset.hash).then(() => {
return testDB.knex.table('password_reset')
.where({ name: 'testing' })
.select();
}).then(rows => {
assert.strictEqual(rows.length, 0);
});
});
});
describe('#cleanup', () => {
const now = Date.now();
const reset1 = {
ip: '1.2.3.4',
name: 'testing',
email: 'test@example.com',
hash: 'abcdef',
expire: now - 25 * 60 * 60 * 1000
};
const reset2 = {
ip: '5.6.7.8',
name: 'testing2',
email: 'test@example.com',
hash: 'abcdef',
expire: now
};
beforeEach(() => cleanup().then(() => {
return testDB.knex.table('password_reset')
.insert([reset1, reset2]);
}));
it('cleans up old password resets', () => {
return passwordResetDB.cleanup().then(() => {
return testDB.knex.table('password_reset')
.whereIn('name', ['testing1', 'testing2'])
.select();
}).then(rows => {
assert.strictEqual(rows.length, 1);
assert.deepStrictEqual(o(rows[0]), reset2);
});
});
});
});

View file

@ -1,136 +0,0 @@
const assert = require('assert');
const KickbanModule = require('../../lib/channel/kickban');
const database = require('../../lib/database');
const dbChannels = require('../../lib/database/channels');
const Promise = require('bluebird');
const ChannelModule = require('../../lib/channel/module');
const Flags = require('../../lib/flags');
const testDB = require('../testutil/db').testDB;
function randomString(length) {
const chars = 'abcdefgihkmnpqrstuvwxyz0123456789';
let str = '';
for (let i = 0; i < length; i++) {
str += chars[Math.floor(Math.random() * chars.length)];
}
return str;
}
database.init(testDB);
describe('onPreUserJoin Ban Check', () => {
const channelName = `test_${randomString(20)}`;
const bannedIP = '1.1.1.1';
const bannedName = 'troll';
const mockChannel = {
name: channelName,
modules: {},
is(flag) {
return flag === Flags.C_REGISTERED;
}
};
const module = new KickbanModule(mockChannel);
before(done => {
dbChannels.ban(channelName, bannedIP, bannedName, '', '', () => {
dbChannels.ban(channelName, bannedIP, '', '', '', () => {
dbChannels.ban(channelName, '*', bannedName, '', '', () => {
done();
});
});
});
});
after(done => {
dbChannels.deleteBans(channelName, null, () => {
done();
});
});
it('handles a banned IP with a different name', done => {
const user = {
getName() {
return 'anotherTroll';
},
realip: bannedIP,
kick() {
}
};
module.onUserPreJoin(user, null, (error, res) => {
assert.equal(error, null, `Unexpected error: ${error}`);
assert.equal(res, ChannelModule.DENY, 'Expected user to be banned');
done();
});
});
it('handles a banned name with a different IP', done => {
const user = {
getName() {
return 'troll';
},
realip: '5.5.5.5',
kick() {
}
};
module.onUserPreJoin(user, null, (error, res) => {
assert.equal(error, null, `Unexpected error: ${error}`);
assert.equal(res, ChannelModule.DENY, 'Expected user to be banned');
done();
});
});
it('handles a banned IP with a blank name', done => {
const user = {
getName() {
return '';
},
realip: bannedIP,
kick() {
}
};
module.onUserPreJoin(user, null, (error, res) => {
assert.equal(error, null, `Unexpected error: ${error}`);
assert.equal(res, ChannelModule.DENY, 'Expected user to be banned');
done();
});
});
it('handles a non-banned IP with a blank name', done => {
const user = {
getName() {
return '';
},
realip: '5.5.5.5'
};
module.onUserPreJoin(user, null, (error, res) => {
assert.equal(error, null, `Unexpected error: ${error}`);
assert.equal(res, ChannelModule.PASSTHROUGH, 'Expected user not to be banned');
done();
});
});
it('handles a non-banned IP with a non-banned name', done => {
const user = {
getName() {
return 'some_user';
},
realip: '5.5.5.5'
};
module.onUserPreJoin(user, null, (error, res) => {
assert.equal(error, null, `Unexpected error: ${error}`);
assert.equal(res, ChannelModule.PASSTHROUGH, 'Expected user not to be banned');
done();
});
});
});

View file

@ -1,14 +0,0 @@
const loadFromToml = require('../../lib/configuration/configloader').loadFromToml;
const path = require('path');
class IntegrationTestConfig {
constructor(config) {
this.config = config;
}
get knexConfig() {
return this.config.database;
}
}
exports.testConfig = loadFromToml(IntegrationTestConfig, path.resolve(__dirname, '..', '..', 'conf', 'integration-test.toml'));

View file

@ -1,4 +0,0 @@
const testConfig = require('./config').testConfig;
const Database = require('../../lib/database').Database;
exports.testDB = new Database(testConfig.knexConfig);

View file

@ -1,4 +0,0 @@
exports.o = function o(obj) {
// Workaround for knex returning RowDataPacket and failing assertions
return Object.assign({}, obj);
}

7481
package-lock.json generated

File diff suppressed because it is too large Load diff

View file

@ -2,81 +2,55 @@
"author": "Calvin Montgomery", "author": "Calvin Montgomery",
"name": "CyTube", "name": "CyTube",
"description": "Online media synchronizer and chat", "description": "Online media synchronizer and chat",
"version": "3.86.1", "version": "3.21.3",
"repository": { "repository": {
"url": "http://github.com/calzoneman/sync" "url": "http://github.com/calzoneman/sync"
}, },
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@calzoneman/jsli": "^2.0.1", "babel": "^5.8.23",
"@cytube/mediaquery": "github:CyTube/mediaquery#52a635d45f38785bdb26e842c9f2bb505bc37a1c", "bcrypt": "^0.8.5",
"bcrypt": "^5.0.1", "bluebird": "^2.10.1",
"bluebird": "^3.7.2", "body-parser": "^1.14.0",
"body-parser": "^1.20.1", "cheerio": "^0.19.0",
"cheerio": "^1.0.0-rc.10", "clone": "^1.0.2",
"clone": "^2.1.2", "compression": "^1.5.2",
"compression": "^1.7.4", "cookie-parser": "^1.4.0",
"cookie-parser": "^1.4.5",
"create-error": "^0.3.1", "create-error": "^0.3.1",
"csrf": "^3.1.0", "csrf": "^3.0.0",
"cytubefilters": "github:calzoneman/cytubefilters#c67b2dab2dc5cc5ed11018819f71273d0f8a1bf5", "cytube-common": "git://github.com/CyTube/cytube-common",
"express": "^4.18.2", "cytube-mediaquery": "git://github.com/CyTube/mediaquery",
"express-minify": "^1.0.0", "cytubefilters": "git://github.com/calzoneman/cytubefilters#67c7c69a",
"express": "^4.13.3",
"express-minify": "^0.1.6",
"graceful-fs": "^4.1.2",
"http-errors": "^1.3.1",
"json-typecheck": "^0.1.3", "json-typecheck": "^0.1.3",
"knex": "^2.4.0", "lodash": "^4.13.1",
"lodash": "^4.17.21", "morgan": "^1.6.1",
"morgan": "^1.10.0", "mysql": "^2.9.0",
"mysql": "^2.18.1", "nodemailer": "^1.4.0",
"nodemailer": "^6.6.1", "oauth": "^0.9.12",
"prom-client": "^13.1.0", "pug": "^2.0.0-beta3",
"proxy-addr": "^2.0.6", "q": "^1.4.1",
"pug": "^3.0.2", "redis": "^2.4.2",
"redis": "^3.1.1", "sanitize-html": "git://github.com/calzoneman/sanitize-html",
"sanitize-html": "^2.7.0", "serve-static": "^1.10.0",
"serve-static": "^1.15.0", "socket.io": "^1.4.0",
"socket.io": "^4.5.4", "socket.io-redis": "^1.0.0",
"source-map-support": "^0.5.19", "source-map-support": "^0.4.0",
"toml": "^3.0.0", "status-message-polyfill": "git://github.com/calzoneman/status-message-polyfill",
"uuid": "^8.3.2", "uuid": "^2.0.1",
"yamljs": "^0.2.8" "yamljs": "^0.1.6"
}, },
"scripts": { "scripts": {
"build-player": "./bin/build-player.js", "build-player": "$npm_node_execpath build-player.js",
"build-server": "babel -D --source-maps --out-dir lib/ src/", "build-server": "babel -D --source-maps --loose es6.destructuring,es6.forOf --out-dir lib/ src/",
"flow": "flow",
"lint": "eslint src",
"pretest": "npm run lint",
"postinstall": "./postinstall.sh", "postinstall": "./postinstall.sh",
"server-dev": "babel -D --watch --source-maps --verbose --out-dir lib/ src/", "server-dev": "babel -D --watch --source-maps --loose es6.destructuring,es6.forOf --out-dir lib/ src/",
"generate-userscript": "$npm_node_execpath gdrive-userscript/generate-userscript $@ > www/js/cytube-google-drive.user.js", "generate-userscript": "$npm_node_execpath gdrive-userscript/generate-userscript $@ > www/js/cytube-google-drive.user.js"
"test": "mocha --recursive --exit test",
"integration-test": "mocha --recursive --exit integration_test"
}, },
"devDependencies": { "devDependencies": {
"@babel/cli": "^7.15.7", "coffee-script": "^1.9.2"
"@babel/core": "^7.15.8",
"@babel/eslint-parser": "^7.15.8",
"@babel/preset-env": "^7.15.8",
"babel-plugin-add-module-exports": "^1.0.4",
"coffeescript": "^1.9.2",
"eslint": "^7.32.0",
"eslint-plugin-no-jquery": "^2.7.0",
"mocha": "^9.2.2",
"sinon": "^10.0.0"
},
"babel": {
"presets": [
[
"@babel/env",
{
"targets": {
"node": "12"
}
}
]
],
"plugins": [
"add-module-exports"
]
} }
} }

View file

@ -15,24 +15,13 @@ window.CustomEmbedPlayer = class CustomEmbedPlayer extends EmbedPlayer
return return
embedSrc = data.meta.embed.src embedSrc = data.meta.embed.src
link = "<a href=\"#{embedSrc}\" target=\"_blank\"><strong>#{embedSrc}</strong></a>"
link = document.createElement('a') alert = makeAlert('Untrusted Content', CUSTOM_EMBED_WARNING.replace('%link%', link),
link.href = embedSrc
link.target = '_blank'
link.rel = 'noopener noreferer'
strong = document.createElement('strong')
strong.textContent = embedSrc
link.appendChild(strong)
# TODO: Ideally makeAlert() would allow optionally providing a DOM
# element instead of requiring HTML text
alert = makeAlert('Untrusted Content', CUSTOM_EMBED_WARNING.replace('%link%', link.outerHTML),
'alert-warning') 'alert-warning')
.removeClass('col-md-12') .removeClass('col-md-12')
$('<button/>').addClass('btn btn-default') $('<button/>').addClass('btn btn-default')
.text('Embed') .text('Embed')
.on('click', => .click(=>
super(data) super(data)
) )
.appendTo(alert.find('.alert')) .appendTo(alert.find('.alert'))

View file

@ -5,25 +5,20 @@ window.DailymotionPlayer = class DailymotionPlayer extends Player
@setMediaProperties(data) @setMediaProperties(data)
@initialVolumeSet = false @initialVolumeSet = false
@playbackReadyCb = null
waitUntilDefined(window, 'DM', => waitUntilDefined(window, 'DM', =>
removeOld() removeOld()
params = params =
autoplay: 1 autoplay: 1
wmode: if USEROPTS.wmode_transparent then 'transparent' else 'opaque'
logo: 0 logo: 0
quality = @mapQuality(USEROPTS.default_quality) quality = @mapQuality(USEROPTS.default_quality)
if quality != 'auto' if quality != 'auto'
params.quality = quality params.quality = quality
@element = DM.$('ytapiplayer') @dm = DM.player('ytapiplayer',
if not @element or @element.nodeType != Node.ELEMENT_NODE
throw new Error("Invalid player element in DailymotionPlayer(), requires an existing HTML element: " + @element)
if DM.Player._INSTANCES[@element.id] != undefined
@element = DM.Player.destroy(@element.id)
@dm = DM.Player.create(@element,
video: data.id video: data.id
width: parseInt(VWIDTH, 10) width: parseInt(VWIDTH, 10)
height: parseInt(VHEIGHT, 10) height: parseInt(VHEIGHT, 10)
@ -31,7 +26,7 @@ window.DailymotionPlayer = class DailymotionPlayer extends Player
) )
@dm.addEventListener('apiready', => @dm.addEventListener('apiready', =>
@dmReady = true @dm.ready = true
@dm.addEventListener('ended', -> @dm.addEventListener('ended', ->
if CLIENT.leader if CLIENT.leader
socket.emit('playNext') socket.emit('playNext')
@ -52,64 +47,43 @@ window.DailymotionPlayer = class DailymotionPlayer extends Player
@setVolume(VOLUME) @setVolume(VOLUME)
@initialVolumeSet = true @initialVolumeSet = true
) )
# Once the video stops, the internal state of the player
# becomes unusable and attempting to load() will corrupt it and
# crash the player with an error. As a shortmedium term
# workaround, mark the player as "not ready" until the next
# playback_ready event
@dm.addEventListener('video_end', =>
@dmReady = false
)
@dm.addEventListener('playback_ready', =>
@dmReady = true
if @playbackReadyCb
@playbackReadyCb()
@playbackReadyCb = null
)
) )
) )
load: (data) -> load: (data) ->
@setMediaProperties(data) @setMediaProperties(data)
if @dm and @dmReady if @dm and @dm.ready
@dm.load(data.id) @dm.load(data.id)
@dm.seek(data.currentTime) @dm.seek(data.currentTime)
else if @dm
# TODO: Player::load() needs to be made asynchronous in the future
console.log('Warning: load() called before DM is ready, queueing callback')
@playbackReadyCb = () =>
@dm.load(data.id)
@dm.seek(data.currentTime)
else else
console.error('WTF? DailymotionPlayer::load() called but @dm is undefined') console.error('WTF? DailymotionPlayer::load() called but dm is not ready')
pause: -> pause: ->
if @dm and @dmReady if @dm and @dm.ready
@paused = true @paused = true
@dm.pause() @dm.pause()
play: -> play: ->
if @dm and @dmReady if @dm and @dm.ready
@paused = false @paused = false
@dm.play() @dm.play()
seekTo: (time) -> seekTo: (time) ->
if @dm and @dmReady if @dm and @dm.ready
@dm.seek(time) @dm.seek(time)
setVolume: (volume) -> setVolume: (volume) ->
if @dm and @dmReady if @dm and @dm.ready
@dm.setVolume(volume) @dm.setVolume(volume)
getTime: (cb) -> getTime: (cb) ->
if @dm and @dmReady if @dm and @dm.ready
cb(@dm.currentTime) cb(@dm.currentTime)
else else
cb(0) cb(0)
getVolume: (cb) -> getVolume: (cb) ->
if @dm and @dmReady if @dm and @dm.ready
if @dm.muted if @dm.muted
cb(0) cb(0)
else else
@ -129,7 +103,3 @@ window.DailymotionPlayer = class DailymotionPlayer extends Player
when '360' then '380' when '360' then '380'
when 'best' then '1080' when 'best' then '1080'
else 'auto' else 'auto'
destroy: ->
if @dm
@dm.destroy('ytapiplayer')

View file

@ -1,7 +1,9 @@
DEFAULT_ERROR = 'You are currently connected via HTTPS but the embedded content DEFAULT_ERROR = 'You are currently connected via HTTPS but the embedded content
uses non-secure plain HTTP. Your browser therefore blocks it from uses non-secure plain HTTP. Your browser therefore blocks it from
loading due to mixed content policy. To fix this, embed the video using a loading due to mixed content policy. To fix this, embed the video using a
secure link if available (https://...), or find another source for the content.' secure link if available (https://...), or load this page over plain HTTP by
replacing "https://" with "http://" in the address bar (your websocket will
still be secured using HTTPS, but this will permit non-secure content to load).'
genParam = (name, value) -> genParam = (name, value) ->
$('<param/>').attr( $('<param/>').attr(
@ -24,10 +26,27 @@ window.EmbedPlayer = class EmbedPlayer extends Player
console.error('EmbedPlayer::load(): missing meta.embed') console.error('EmbedPlayer::load(): missing meta.embed')
return return
@player = @loadIframe(embed) if embed.tag == 'object'
@player = @loadObject(embed)
else
@player = @loadIframe(embed)
removeOld(@player) removeOld(@player)
loadObject: (embed) ->
object = $('<object/>').attr(
type: 'application/x-shockwave-flash'
data: embed.src
wmode: 'opaque'
)
genParam('allowfullscreen', 'true').appendTo(object)
genParam('allowscriptaccess', 'always').appendTo(object)
for key, value of embed.params
genParam(key, value).appendTo(object)
return object
loadIframe: (embed) -> loadIframe: (embed) ->
if embed.src.indexOf('http:') == 0 and location.protocol == 'https:' if embed.src.indexOf('http:') == 0 and location.protocol == 'https:'
if @__proto__.mixedContentError? if @__proto__.mixedContentError?
@ -42,7 +61,6 @@ window.EmbedPlayer = class EmbedPlayer extends Player
iframe = $('<iframe/>').attr( iframe = $('<iframe/>').attr(
src: embed.src src: embed.src
frameborder: '0' frameborder: '0'
allow: 'autoplay'
allowfullscreen: '1' allowfullscreen: '1'
) )

View file

@ -6,81 +6,17 @@ window.GoogleDrivePlayer = class GoogleDrivePlayer extends VideoJSPlayer
super(data) super(data)
load: (data) -> load: (data) ->
if not window.hasDriveUserscript
window.promptToInstallDriveUserscript()
else if window.hasDriveUserscript
window.maybePromptToUpgradeUserscript()
if typeof window.getGoogleDriveMetadata is 'function' if typeof window.getGoogleDriveMetadata is 'function'
setTimeout(=> window.getGoogleDriveMetadata(data.id, (error, metadata) =>
backoffRetry((cb) -> if error
window.getGoogleDriveMetadata(data.id, cb) console.error(error)
, (error, metadata) => alertBox = window.document.createElement('div')
if error alertBox.className = 'alert alert-danger'
console.error(error) alertBox.textContent = error.message
alertBox = window.document.createElement('div') document.getElementById('ytapiplayer').appendChild(alertBox)
alertBox.className = 'alert alert-danger' else
alertBox.textContent = error data.meta.direct = metadata.videoMap
document.getElementById('ytapiplayer').appendChild(alertBox) super(data)
else )
data.meta.direct = metadata.videoMap else
super(data) super(data)
, {
maxTries: 3
delay: 1000
factor: 1.2
jitter: 500
})
, Math.random() * 1000)
window.promptToInstallDriveUserscript = ->
if document.getElementById('prompt-install-drive-userscript')
return
alertBox = document.createElement('div')
alertBox.id = 'prompt-install-drive-userscript'
alertBox.className = 'alert alert-info'
alertBox.innerHTML = """
Due to continual breaking changes making it increasingly difficult to
maintain Google Drive support, Google Drive now requires installing
a userscript in order to play the video."""
alertBox.appendChild(document.createElement('br'))
infoLink = document.createElement('a')
infoLink.className = 'btn btn-info'
infoLink.href = '/google_drive_userscript'
infoLink.textContent = 'Click here for details'
infoLink.target = '_blank'
alertBox.appendChild(infoLink)
closeButton = document.createElement('button')
closeButton.className = 'close pull-right'
closeButton.innerHTML = '&times;'
closeButton.onclick = ->
alertBox.parentNode.removeChild(alertBox)
alertBox.insertBefore(closeButton, alertBox.firstChild)
removeOld($('<div/>').append(alertBox))
window.tellUserNotToContactMeAboutThingsThatAreNotSupported = ->
if document.getElementById('prompt-no-gdrive-support')
return
alertBox = document.createElement('div')
alertBox.id = 'prompt-no-gdrive-support'
alertBox.className = 'alert alert-danger'
alertBox.innerHTML = """
CyTube has detected an error in Google Drive playback. Please note that the
staff in CyTube support channels DO NOT PROVIDE SUPPORT FOR GOOGLE DRIVE. It
is left in the code as-is for existing users, but we will not assist in
troubleshooting any errors that occur.<br>"""
alertBox.appendChild(document.createElement('br'))
infoLink = document.createElement('a')
infoLink.className = 'btn btn-danger'
infoLink.href = 'https://github.com/calzoneman/sync/wiki/Frequently-Asked-Questions#why-dont-you-support-google-drive-anymore'
infoLink.textContent = 'Click here for details'
infoLink.target = '_blank'
alertBox.appendChild(infoLink)
closeButton = document.createElement('button')
closeButton.className = 'close pull-right'
closeButton.innerHTML = '&times;'
closeButton.onclick = ->
alertBox.parentNode.removeChild(alertBox)
alertBox.insertBefore(closeButton, alertBox.firstChild)
removeOld($('<div/>').append(alertBox))

View file

@ -0,0 +1,132 @@
window.GoogleDriveYouTubePlayer = class GoogleDriveYouTubePlayer extends Player
constructor: (data) ->
if not (this instanceof GoogleDriveYouTubePlayer)
return new GoogleDriveYouTubePlayer(data)
@setMediaProperties(data)
@init(data)
init: (data) ->
window.promptToInstallDriveUserscript()
embed = $('<embed />').attr(
type: 'application/x-shockwave-flash'
src: "https://www.youtube.com/get_player?docid=#{data.id}&ps=docs\
&partnerid=30&enablejsapi=1&cc_load_policy=1\
&auth_timeout=86400000000"
flashvars: 'autoplay=1&playerapiid=uniquePlayerId'
wmode: 'opaque'
allowscriptaccess: 'always'
)
removeOld(embed)
window.onYouTubePlayerReady = =>
if PLAYER != this
return
@yt = embed[0]
window.gdriveStateChange = @onStateChange.bind(this)
@yt.addEventListener('onStateChange', 'gdriveStateChange')
@onReady()
load: (data) ->
@yt = null
@setMediaProperties(data)
@init(data)
onReady: ->
@yt.ready = true
@setVolume(VOLUME)
@setQuality(USEROPTS.default_quality)
onStateChange: (ev) ->
if PLAYER != this
return
if (ev == YT.PlayerState.PAUSED and not @paused) or
(ev == YT.PlayerState.PLAYING and @paused)
@paused = (ev == YT.PlayerState.PAUSED)
if CLIENT.leader
sendVideoUpdate()
if ev == YT.PlayerState.ENDED and CLIENT.leader
socket.emit('playNext')
play: ->
@paused = false
if @yt and @yt.ready
@yt.playVideo()
pause: ->
@paused = true
if @yt and @yt.ready
@yt.pauseVideo()
seekTo: (time) ->
if @yt and @yt.ready
@yt.seekTo(time, true)
setVolume: (volume) ->
if @yt and @yt.ready
if volume > 0
# If the player is muted, even if the volume is set,
# the player remains muted
@yt.unMute()
@yt.setVolume(volume * 100)
setQuality: (quality) ->
if not @yt or not @yt.ready
return
ytQuality = switch String(quality)
when '240' then 'small'
when '360' then 'medium'
when '480' then 'large'
when '720' then 'hd720'
when '1080' then 'hd1080'
when 'best' then 'highres'
else 'auto'
if ytQuality != 'auto'
@yt.setPlaybackQuality(ytQuality)
getTime: (cb) ->
if @yt and @yt.ready
cb(@yt.getCurrentTime())
else
cb(0)
getVolume: (cb) ->
if @yt and @yt.ready
if @yt.isMuted()
cb(0)
else
cb(@yt.getVolume() / 100)
else
cb(VOLUME)
window.promptToInstallDriveUserscript = ->
if document.getElementById('prompt-install-drive-userscript')
return
alertBox = document.createElement('div')
alertBox.id = 'prompt-install-drive-userscript'
alertBox.className = 'alert alert-info'
alertBox.innerHTML = """
Due to continual breaking changes making it increasingly difficult to
maintain Google Drive support, you can now install a userscript that
simplifies the code and has better compatibility. In the future, the
old player will be removed."""
alertBox.appendChild(document.createElement('br'))
infoLink = document.createElement('a')
infoLink.className = 'btn btn-info'
infoLink.href = '/google_drive_userscript'
infoLink.textContent = 'Click here for details'
infoLink.target = '_blank'
alertBox.appendChild(infoLink)
closeButton = document.createElement('button')
closeButton.className = 'close pull-right'
closeButton.innerHTML = '&times;'
closeButton.onclick = ->
alertBox.parentNode.removeChild(alertBox)
alertBox.insertBefore(closeButton, alertBox.firstChild)
document.getElementById('videowrap').appendChild(alertBox)

21
player/hitbox.coffee Normal file
View file

@ -0,0 +1,21 @@
HITBOX_ERROR = 'Hitbox.tv only serves its content over plain HTTP, but you are
viewing this page over secure HTTPS. Your browser therefore blocks the
hitbox embed due to mixed content policy. In order to view hitbox, you must
view this page over plain HTTP (change "https://" to "http://" in the address
bar)-- your websocket will still be connected using secure HTTPS. This is
something I have asked Hitbox to fix but they have not done so yet.'
window.HitboxPlayer = class HitboxPlayer extends EmbedPlayer
constructor: (data) ->
if not (this instanceof HitboxPlayer)
return new HitboxPlayer(data)
@load(data)
load: (data) ->
data.meta.embed =
src: "http://hitbox.tv/embed/#{data.id}"
tag: 'iframe'
super(data)
mixedContentError: HITBOX_ERROR

View file

@ -1,33 +0,0 @@
window.IframeChild = class IframeChild extends PlayerJSPlayer
constructor: (data) ->
if not (this instanceof IframeChild)
return new IframeChild(data)
super(data)
load: (data) ->
@setMediaProperties(data)
@ready = false
waitUntilDefined(window, 'playerjs', =>
iframe = $('<iframe/>')
.attr(
src: '/iframe'
allow: 'autoplay; fullscreen'
)
removeOld(iframe)
@setupFrame(iframe[0], data)
@setupPlayer(iframe[0])
)
setupFrame: (iframe, data) ->
iframe.addEventListener('load', =>
# TODO: ideally, communication with the child frame should use postMessage()
iframe.contentWindow.VOLUME = VOLUME
iframe.contentWindow.loadMediaPlayer(Object.assign({}, data, { type: 'cm' } ))
iframe.contentWindow.document.querySelector('#ytapiplayer').classList.add('vjs-16-9')
adapter = iframe.contentWindow.playerjs.VideoJSAdapter(iframe.contentWindow.PLAYER.player)
adapter.ready()
typeof data?.meta?.thumbnail == 'string' and iframe.contentWindow.PLAYER.player.poster(data.meta.thumbnail)
)

12
player/imgur.coffee Normal file
View file

@ -0,0 +1,12 @@
window.ImgurPlayer = class ImgurPlayer extends EmbedPlayer
constructor: (data) ->
if not (this instanceof ImgurPlayer)
return new ImgurPlayer(data)
@load(data)
load: (data) ->
data.meta.embed =
tag: 'iframe'
src: "https://imgur.com/a/#{data.id}/embed"
super(data)

View file

@ -6,12 +6,18 @@ window.LivestreamPlayer = class LivestreamPlayer extends EmbedPlayer
@load(data) @load(data)
load: (data) -> load: (data) ->
[ account, event ] = data.id.split(';') if LIVESTREAM_CHROMELESS
data.meta.embed = data.meta.embed =
src: "https://livestream.com/accounts/#{account}/events/#{event}/player?\ src: 'https://cdn.livestream.com/chromelessPlayer/v20/playerapi.swf'
enableInfoAndActivity=false&\ tag: 'object'
defaultDrawer=&\ params:
autoPlay=true&\ flashvars: "channel=#{data.id}"
mute=false" else
tag: 'iframe' data.meta.embed =
src: "https://cdn.livestream.com/embed/#{data.id}?\
layout=4&\
color=0x000000&\
iconColorOver=0xe7e7e7&\
iconColor=0xcccccc"
tag: 'iframe'
super(data) super(data)

View file

@ -1,66 +0,0 @@
window.NicoPlayer = class NicoPlayer extends Player
constructor: (data) ->
if not (this instanceof NicoPlayer)
return new NicoPlayer(data)
@load(data)
load: (data) ->
@setMediaProperties(data)
waitUntilDefined(window, 'NicovideoEmbed', =>
@nico = new NicovideoEmbed({ playerId: 'ytapiplayer', videoId: data.id })
removeOld($(@nico.iframe))
@nico.on('ended', =>
if CLIENT.leader
socket.emit('playNext')
)
@nico.on('pause', =>
@paused = true
if CLIENT.leader
sendVideoUpdate()
)
@nico.on('play', =>
@paused = false
if CLIENT.leader
sendVideoUpdate()
)
@nico.on('ready', =>
@play()
@setVolume(VOLUME)
)
)
play: ->
@paused = false
if @nico
@nico.play()
pause: ->
@paused = true
if @nico
@nico.pause()
seekTo: (time) ->
if @nico
@nico.seek(time * 1000)
setVolume: (volume) ->
if @nico
@nico.volumeChange(volume)
getTime: (cb) ->
if @nico
cb(parseFloat(@nico.state.currentTime / 1000))
else
cb(0)
getVolume: (cb) ->
if @nico
cb(parseFloat(@nico.state.volume))
else
cb(VOLUME)

View file

@ -1,21 +0,0 @@
window.OdyseePlayer = class OdyseePlayer extends PlayerJSPlayer
constructor: (data) ->
if not (this instanceof OdyseePlayer)
return new OdyseePlayer(data)
super(data)
load: (data) ->
@ready = false
@setMediaProperties(data)
waitUntilDefined(window, 'playerjs', =>
iframe = $('<iframe/>')
.attr(
src: data.meta.embed.src
allow: 'autoplay; fullscreen'
)
removeOld(iframe)
@setupPlayer(iframe[0], data)
)

View file

@ -1,122 +0,0 @@
PEERTUBE_EMBED_WARNING = 'This channel is embedding PeerTube content from %link%.
PeerTube instances may use P2P technology that will expose your IP address to third parties, including but not
limited to other users in this channel. It is also conceivable that if the content in question is in violation of
copyright laws your IP address could be potentially be observed by legal authorities monitoring the tracker of
this PeerTube instance. The operators of %site% are not responsible for the data sent by the embedded player to
third parties on your behalf.<br><br> If you understand the risks, wish to assume all liability, and continue to
the content, click "Embed" below to allow the content to be embedded.<hr>'
PEERTUBE_RISK = false
window.PeerPlayer = class PeerPlayer extends Player
constructor: (data) ->
if not (this instanceof PeerPlayer)
return new PeerPlayer(data)
@warn(data)
warn: (data) ->
if USEROPTS.peertube_risk or PEERTUBE_RISK
return @load(data)
site = new URL(document.URL).hostname
embedSrc = data.meta.embed.domain
link = "<a href=\"http://#{embedSrc}\" target=\"_blank\" rel=\"noopener noreferer\"><strong>#{embedSrc}</strong></a>"
alert = makeAlert('Privacy Advisory', PEERTUBE_EMBED_WARNING.replace('%link%', link).replace('%site%', site),
'alert-warning')
.removeClass('col-md-12')
$('<button/>').addClass('btn btn-default')
.text('Embed')
.on('click', =>
@load(data)
)
.appendTo(alert.find('.alert'))
$('<button/>').addClass('btn btn-default pull-right')
.text('Embed and dont ask again for this session')
.on('click', =>
PEERTUBE_RISK = true
@load(data)
)
.appendTo(alert.find('.alert'))
removeOld(alert)
load: (data) ->
@setMediaProperties(data)
waitUntilDefined(window, 'PeerTubePlayer', =>
video = $('<iframe/>')
removeOld(video)
video.attr(
src: "https://#{data.meta.embed.domain}/videos/embed/#{data.meta.embed.uuid}?api=1"
allow: 'autoplay; fullscreen'
)
@peertube = new PeerTubePlayer(video[0])
@peertube.addEventListener('playbackStatusChange', (status) =>
@paused = status == 'paused'
if CLIENT.leader
sendVideoUpdate()
)
@peertube.addEventListener('playbackStatusUpdate', (status) =>
@peertube.currentTime = status.position
if status.playbackState == "ended" and CLIENT.leader
socket.emit('playNext')
)
@peertube.addEventListener('volumeChange', (volume) =>
VOLUME = volume
setOpt("volume", VOLUME)
)
@play()
@setVolume(VOLUME)
)
play: ->
@paused = false
if @peertube and @peertube.ready
@peertube.play().catch((error) ->
console.error('PeerTube::play():', error)
)
pause: ->
@paused = true
if @peertube and @peertube.ready
@peertube.pause().catch((error) ->
console.error('PeerTube::pause():', error)
)
seekTo: (time) ->
if @peertube and @peertube.ready
@peertube.seek(time)
getVolume: (cb) ->
if @peertube and @peertube.ready
@peertube.getVolume().then((volume) ->
cb(parseFloat(volume))
).catch((error) ->
console.error('PeerTube::getVolume():', error)
)
else
cb(VOLUME)
setVolume: (volume) ->
if @peertube and @peertube.ready
@peertube.setVolume(volume).catch((error) ->
console.error('PeerTube::setVolume():', error)
)
getTime: (cb) ->
if @peertube and @peertube.ready
cb(@peertube.currentTime)
else
cb(0)
setQuality: (quality) ->
# USEROPTS.default_quality
# @peertube.getResolutions()
# @peertube.setResolution(resolutionId : number)

View file

@ -1,85 +0,0 @@
window.PlayerJSPlayer = class PlayerJSPlayer extends Player
constructor: (data) ->
if not (this instanceof PlayerJSPlayer)
return new PlayerJSPlayer(data)
@load(data)
load: (data) ->
@setMediaProperties(data)
@ready = false
if not data.meta.playerjs
throw new Error('Invalid input: missing meta.playerjs')
waitUntilDefined(window, 'playerjs', =>
iframe = $('<iframe/>')
.attr(
src: data.meta.playerjs.src
allow: 'autoplay; fullscreen'
)
removeOld(iframe)
@setupPlayer(iframe[0])
)
setupPlayer: (iframe) ->
@player = new playerjs.Player(iframe)
@player.on('ready', =>
@player.on('error', (error) =>
console.error('PlayerJS error', error.stack)
)
@player.on('ended', ->
if CLIENT.leader
socket.emit('playNext')
)
@player.on('play', ->
@paused = false
if CLIENT.leader
sendVideoUpdate()
)
@player.on('pause', ->
@paused = true
if CLIENT.leader
sendVideoUpdate()
)
@player.setVolume(VOLUME * 100)
if not @paused
@player.play()
@ready = true
)
play: ->
@paused = false
if @player and @ready
@player.play()
pause: ->
@paused = true
if @player and @ready
@player.pause()
seekTo: (time) ->
if @player and @ready
@player.setCurrentTime(time)
setVolume: (volume) ->
if @player and @ready
@player.setVolume(volume * 100)
getTime: (cb) ->
if @player and @ready
@player.getCurrentTime(cb)
else
cb(0)
getVolume: (cb) ->
if @player and @ready
@player.getVolume((volume) ->
cb(volume / 100)
)
else
cb(VOLUME)

View file

@ -1,13 +1,11 @@
codecToMimeType = (codec) -> codecToMimeType = (codec) ->
switch codec switch codec
when 'mov/h264', 'mov/av1' then 'video/mp4' when 'mov/h264' then 'video/mp4'
when 'flv/h264' then 'video/flv' when 'flv/h264' then 'video/flv'
when 'matroska/vp8', 'matroska/vp9', 'matroska/av1' then 'video/webm' when 'matroska/vp8', 'matroska/vp9' then 'video/webm'
when 'ogg/theora' then 'video/ogg' when 'ogg/theora' then 'video/ogg'
when 'mp3' then 'audio/mp3' when 'mp3' then 'audio/mp3'
when 'vorbis' then 'audio/ogg' when 'vorbis' then 'audio/ogg'
when 'aac' then 'audio/aac'
when 'opus' then 'audio/opus'
else 'video/flv' else 'video/flv'
window.FilePlayer = class FilePlayer extends VideoJSPlayer window.FilePlayer = class FilePlayer extends VideoJSPlayer

View file

@ -18,6 +18,5 @@ window.RTMPPlayer = class RTMPPlayer extends VideoJSPlayer
480: [ 480: [
{ {
link: data.id link: data.id
contentType: 'rtmp/flv'
} }
] ]

View file

@ -91,8 +91,13 @@ window.SoundCloudPlayer = class SoundCloudPlayer extends Player
@soundcloud.seekTo(time * 1000) @soundcloud.seekTo(time * 1000)
setVolume: (volume) -> setVolume: (volume) ->
# NOTE: SoundCloud's documentation claims that setVolume() accepts
# volumes in the range [0, 100], however it *actually* accepts volumes
# in the range [0, 1] (anything larger than 1 is treated as 1). I
# emailed them about this 2 years ago and they still haven't fixed
# their documentation.
if @soundcloud and @soundcloud.ready if @soundcloud and @soundcloud.ready
@soundcloud.setVolume(volume * 100) @soundcloud.setVolume(volume)
getTime: (cb) -> getTime: (cb) ->
if @soundcloud and @soundcloud.ready if @soundcloud and @soundcloud.ready
@ -103,6 +108,6 @@ window.SoundCloudPlayer = class SoundCloudPlayer extends Player
getVolume: (cb) -> getVolume: (cb) ->
if @soundcloud and @soundcloud.ready if @soundcloud and @soundcloud.ready
@soundcloud.getVolume((vol) -> cb(vol / 100)) @soundcloud.getVolume(cb)
else else
cb(VOLUME) cb(VOLUME)

View file

@ -1,35 +0,0 @@
window.StreamablePlayer = class StreamablePlayer extends PlayerJSPlayer
constructor: (data) ->
if not (this instanceof StreamablePlayer)
return new StreamablePlayer(data)
super(data)
load: (data) ->
@ready = false
@finishing = false
@setMediaProperties(data)
waitUntilDefined(window, 'playerjs', =>
iframe = $('<iframe/>')
.attr(
src: "https://streamable.com/e/#{data.id}"
allow: 'autoplay; fullscreen'
)
removeOld(iframe)
@setupPlayer(iframe[0])
@player.on('ready', =>
# Streamable does not implement ended event since it loops
# gotta use a timeupdate hack
@player.on('timeupdate', (time) =>
if time.duration - time.seconds < 1 and not @finishing
setTimeout(=>
if CLIENT.leader
socket.emit('playNext')
@pause()
, (time.duration - time.seconds) * 1000)
@finishing = true
)
)
)

View file

@ -1,10 +1,3 @@
window.TWITCH_PARAMS_ERROR = 'The Twitch embed player now uses parameters which only
work if the following requirements are met: (1) The embedding website uses
HTTPS; (2) The embedding website uses the default port (443) and is accessed
via https://example.com instead of https://example.com:port. I have no
control over this -- see <a href="https://discuss.dev.twitch.tv/t/twitch-embedded-player-migration-timeline-update/25588" rel="noopener noreferrer" target="_blank">this Twitch post</a>
for details'
window.TwitchPlayer = class TwitchPlayer extends Player window.TwitchPlayer = class TwitchPlayer extends Player
constructor: (data) -> constructor: (data) ->
if not (this instanceof TwitchPlayer) if not (this instanceof TwitchPlayer)
@ -19,40 +12,17 @@ window.TwitchPlayer = class TwitchPlayer extends Player
init: (data) -> init: (data) ->
removeOld() removeOld()
if location.hostname != location.host or location.protocol != 'https:'
alert = makeAlert(
'Twitch API Parameters',
window.TWITCH_PARAMS_ERROR,
'alert-danger'
).removeClass('col-md-12')
removeOld(alert)
@twitch = null
return
options = options =
parent: [location.hostname] channel: data.id
width: $('#ytapiplayer').width()
height: $('#ytapiplayer').height()
if data.type is 'tv'
# VOD
options.video = data.id
else
# Livestream
options.channel = data.id
@twitch = new Twitch.Player('ytapiplayer', options) @twitch = new Twitch.Player('ytapiplayer', options)
@twitch.addEventListener(Twitch.Player.READY, => @twitch.addEventListener(Twitch.Player.READY, =>
@setVolume(VOLUME) @setVolume(VOLUME)
@twitch.setQuality(@mapQuality(USEROPTS.default_quality)) @twitch.setQuality(@mapQuality(USEROPTS.default_quality))
@twitch.addEventListener(Twitch.Player.PLAY, => @twitch.addEventListener(Twitch.Player.PLAY, =>
@paused = false
if CLIENT.leader if CLIENT.leader
sendVideoUpdate() sendVideoUpdate()
) )
@twitch.addEventListener(Twitch.Player.PAUSE, => @twitch.addEventListener(Twitch.Player.PAUSE, =>
@paused = true
if CLIENT.leader if CLIENT.leader
sendVideoUpdate() sendVideoUpdate()
) )
@ -65,26 +35,19 @@ window.TwitchPlayer = class TwitchPlayer extends Player
load: (data) -> load: (data) ->
@setMediaProperties(data) @setMediaProperties(data)
try try
if data.type is 'tv' @twitch.setChannel(data.id)
# VOD
@twitch.setVideo(data.id)
else
# Livestream
@twitch.setChannel(data.id)
catch error catch error
console.error(error) console.error(error)
pause: -> pause: ->
try try
@twitch.pause() @twitch.pause()
@paused = true
catch error catch error
console.error(error) console.error(error)
play: -> play: ->
try try
@twitch.play() @twitch.play()
@paused = false
catch error catch error
console.error(error) console.error(error)
@ -96,7 +59,7 @@ window.TwitchPlayer = class TwitchPlayer extends Player
getTime: (cb) -> getTime: (cb) ->
try try
cb(@twitch.getCurrentTime()) cb(@twitch.getVolume())
catch error catch error
console.error(error) console.error(error)

View file

@ -1,21 +0,0 @@
window.TwitchClipPlayer = class TwitchClipPlayer extends EmbedPlayer
constructor: (data) ->
if not (this instanceof TwitchClipPlayer)
return new TwitchClipPlayer(data)
@load(data)
load: (data) ->
if location.hostname != location.host or location.protocol != 'https:'
alert = makeAlert(
'Twitch API Parameters',
window.TWITCH_PARAMS_ERROR,
'alert-danger'
).removeClass('col-md-12')
removeOld(alert)
return
data.meta.embed =
tag: 'iframe'
src: "https://clips.twitch.tv/embed?clip=#{data.id}&parent=#{location.host}"
super(data)

View file

@ -3,23 +3,20 @@ TYPE_MAP =
vi: VimeoPlayer vi: VimeoPlayer
dm: DailymotionPlayer dm: DailymotionPlayer
gd: GoogleDrivePlayer gd: GoogleDrivePlayer
gp: VideoJSPlayer
fi: FilePlayer fi: FilePlayer
jw: FilePlayer
sc: SoundCloudPlayer sc: SoundCloudPlayer
li: LivestreamPlayer li: LivestreamPlayer
tw: TwitchPlayer tw: TwitchPlayer
tv: TwitchPlayer
cu: CustomEmbedPlayer cu: CustomEmbedPlayer
rt: RTMPPlayer rt: RTMPPlayer
hb: HitboxPlayer
us: UstreamPlayer
im: ImgurPlayer
vm: VideoJSPlayer
hl: HLSPlayer hl: HLSPlayer
sb: StreamablePlayer sb: VideoJSPlayer
tc: TwitchClipPlayer
cm: VideoJSPlayer
pt: PeerPlayer
bc: IframeChild
bn: IframeChild
od: OdyseePlayer
wp: WhepPlayer
nv: NicoPlayer
window.loadMediaPlayer = (data) -> window.loadMediaPlayer = (data) ->
try try
@ -28,11 +25,19 @@ window.loadMediaPlayer = (data) ->
catch error catch error
console.error error console.error error
if data.meta.direct and data.type is 'vi' if data.meta.direct and data.type != 'gd'
try try
window.PLAYER = new VideoJSPlayer(data) window.PLAYER = new VideoJSPlayer(data)
catch e catch e
console.error e console.error e
else if data.type is 'gd'
try
if data.meta.html5hack or window.hasDriveUserscript
window.PLAYER = new GoogleDrivePlayer(data)
else
window.PLAYER = new GoogleDriveYouTubePlayer(data)
catch e
console.error e
else if data.type of TYPE_MAP else if data.type of TYPE_MAP
try try
window.PLAYER = TYPE_MAP[data.type](data) window.PLAYER = TYPE_MAP[data.type](data)
@ -111,8 +116,7 @@ window.removeOld = (replace) ->
$('#soundcloud-volume-holder').remove() $('#soundcloud-volume-holder').remove()
replace ?= $('<div/>').addClass('embed-responsive-item') replace ?= $('<div/>').addClass('embed-responsive-item')
old = $('#ytapiplayer') old = $('#ytapiplayer')
old.attr('id', 'ytapiplayer-old')
replace.attr('id', 'ytapiplayer')
replace.insertBefore(old) replace.insertBefore(old)
old.remove() old.remove()
replace.attr('id', 'ytapiplayer')
return replace return replace

21
player/ustream.coffee Normal file
View file

@ -0,0 +1,21 @@
USTREAM_ERROR = 'Ustream.tv\'s embed player only works over plain HTTP, but you are
viewing this page over secure HTTPS. Your browser therefore blocks the
ustream embed due to mixed content policy. In order to view ustream, you must
view this page over plain HTTP (change "https://" to "http://" in the address
bar)-- your websocket will still be connecting using secure HTTPS. This is
something that ustream needs to fix.'
window.UstreamPlayer = class UstreamPlayer extends EmbedPlayer
constructor: (data) ->
if not (this instanceof UstreamPlayer)
return new UstreamPlayer(data)
@load(data)
load: (data) ->
data.meta.embed =
tag: 'iframe'
src: "http://www.ustream.tv/embed/#{data.id}?v=3&wmode=direct&autoplay=1"
super(data)
mixedContentError: USTREAM_ERROR

View file

@ -3,16 +3,15 @@ sortSources = (sources) ->
console.error('sortSources() called with null source list') console.error('sortSources() called with null source list')
return [] return []
qualities = ['2160', '1440', '1080', '720', '540', '480', '360', '240'] qualities = ['1080', '720', '480', '360', '240']
pref = String(USEROPTS.default_quality) pref = String(USEROPTS.default_quality)
if USEROPTS.default_quality == 'best' if USEROPTS.default_quality == 'best'
pref = '2160' pref = '1080'
idx = qualities.indexOf(pref) idx = qualities.indexOf(pref)
if idx < 0 if idx < 0
idx = 5 # 480p idx = 2
qualityOrder = qualities.slice(idx).concat(qualities.slice(0, idx).reverse()) qualityOrder = qualities.slice(idx).concat(qualities.slice(0, idx).reverse())
qualityOrder.unshift('auto')
sourceOrder = [] sourceOrder = []
flvOrder = [] flvOrder = []
for quality in qualityOrder for quality in qualityOrder
@ -32,23 +31,12 @@ sortSources = (sources) ->
return sourceOrder.concat(flvOrder).map((source) -> return sourceOrder.concat(flvOrder).map((source) ->
type: source.contentType type: source.contentType
src: source.link src: source.link
res: source.quality quality: source.quality
label: getSourceLabel(source)
) )
getSourceLabel = (source) -> waitUntilDefined(window, 'videojs', =>
if source.res is 'auto' videojs.options.flash.swf = '/video-js.swf'
return 'auto' )
else
return "#{source.quality}p #{source.contentType.split('/')[1]}"
hasAnyTextTracks = (data) ->
ntracks = data?.meta?.textTracks?.length ? 0
return ntracks > 0
hasAnyAudioTracks = (data) ->
ntracks = data?.meta?.audioTracks?.length ? 0
return ntracks > 0
window.VideoJSPlayer = class VideoJSPlayer extends Player window.VideoJSPlayer = class VideoJSPlayer extends Player
constructor: (data) -> constructor: (data) ->
@ -59,16 +47,9 @@ window.VideoJSPlayer = class VideoJSPlayer extends Player
loadPlayer: (data) -> loadPlayer: (data) ->
waitUntilDefined(window, 'videojs', => waitUntilDefined(window, 'videojs', =>
attrs =
width: '100%'
height: '100%'
if @mediaType == 'cm' and hasAnyTextTracks(data)
attrs.crossorigin = 'anonymous'
video = $('<video/>') video = $('<video/>')
.addClass('video-js vjs-default-skin embed-responsive-item') .addClass('video-js vjs-default-skin embed-responsive-item')
.attr(attrs) .attr(width: '100%', height: '100%')
removeOld(video) removeOld(video)
@sources = sortSources(data.meta.direct) @sources = sortSources(data.meta.direct)
@ -79,10 +60,14 @@ window.VideoJSPlayer = class VideoJSPlayer extends Player
return return
@sourceIdx = 0 @sourceIdx = 0
@sources.forEach((source) ->
$('<source/>').attr(
src: source.src
type: source.type
'data-quality': source.quality
).appendTo(video)
)
# TODO: Refactor VideoJSPlayer to use a preLoad()/load()/postLoad() pattern
# VideoJSPlayer should provide the core functionality and logic for specific
# dependent player types (gdrive) should be an extension
if data.meta.gdrive_subtitles if data.meta.gdrive_subtitles
data.meta.gdrive_subtitles.available.forEach((subt) -> data.meta.gdrive_subtitles.available.forEach((subt) ->
label = subt.lang_original label = subt.lang_original
@ -97,57 +82,19 @@ window.VideoJSPlayer = class VideoJSPlayer extends Player
).appendTo(video) ).appendTo(video)
) )
if data.meta.textTracks @player = videojs(video[0], autoplay: true, controls: true)
data.meta.textTracks.forEach((track) ->
label = track.name
attrs =
src: track.url
kind: 'subtitles'
type: track.type
label: label
if track.default? and track.default
attrs.default = ''
$('<track/>').attr(attrs).appendTo(video)
)
pluginData =
videoJsResolutionSwitcher:
default: @sources[0].res
if hasAnyAudioTracks(data)
pluginData.audioSwitch =
audioTracks: data.meta.audioTracks,
volume: VOLUME
@player = videojs(video[0],
# https://github.com/Dash-Industry-Forum/dash.js/issues/2184
autoplay: @sources[0].type != 'application/dash+xml',
controls: true,
plugins: pluginData
)
@player.ready(=> @player.ready(=>
# Have to use updateSrc instead of <source> tags
# see: https://github.com/videojs/video.js/issues/3428
@player.poster(data.meta.thumbnail)
@player.updateSrc(@sources)
@player.on('error', => @player.on('error', =>
err = @player.error() err = @player.error()
if err and err.code == 4 if err and err.code == 4
console.error('Caught error, trying next source') console.error('Caught error, trying next source')
# Does this really need to be done manually?
@sourceIdx++ @sourceIdx++
if @sourceIdx < @sources.length if @sourceIdx < @sources.length
@player.src(@sources[@sourceIdx]) @player.src(@sources[@sourceIdx])
else else
console.error('Out of sources, video will not play') console.error('Out of sources, video will not play')
if @mediaType is 'gd' if @mediaType is 'gd' and not window.hasDriveUserscript
if not window.hasDriveUserscript window.promptToInstallDriveUserscript()
window.promptToInstallDriveUserscript()
else
window.tellUserNotToContactMeAboutThingsThatAreNotSupported()
) )
@setVolume(VOLUME) @setVolume(VOLUME)
@player.on('ended', -> @player.on('ended', ->

View file

@ -8,79 +8,73 @@ window.VimeoPlayer = class VimeoPlayer extends Player
load: (data) -> load: (data) ->
@setMediaProperties(data) @setMediaProperties(data)
waitUntilDefined(window, 'Vimeo', => waitUntilDefined(window, '$f', =>
video = $('<iframe/>') video = $('<iframe/>')
removeOld(video) removeOld(video)
video.attr( video.attr(
src: "https://player.vimeo.com/video/#{data.id}" src: "https://player.vimeo.com/video/#{data.id}?api=1&player_id=ytapiplayer"
allow: 'autoplay; fullscreen' webkitallowfullscreen: true
mozallowfullscreen: true
allowfullscreen: true
) )
@vimeo = new Vimeo.Player(video[0]) if USEROPTS.wmode_transparent
video.attr('wmode', 'transparent')
@vimeo.on('ended', => $f(video[0]).addEvent('ready', =>
if CLIENT.leader @vimeo = $f(video[0])
socket.emit('playNext') @play()
@vimeo.addEvent('finish', =>
if CLIENT.leader
socket.emit('playNext')
)
@vimeo.addEvent('pause', =>
@paused = true
if CLIENT.leader
sendVideoUpdate()
)
@vimeo.addEvent('play', =>
@paused = false
if CLIENT.leader
sendVideoUpdate()
)
@setVolume(VOLUME)
) )
@vimeo.on('pause', =>
@paused = true
if CLIENT.leader
sendVideoUpdate()
)
@vimeo.on('play', =>
@paused = false
if CLIENT.leader
sendVideoUpdate()
)
@play()
@setVolume(VOLUME)
) )
play: -> play: ->
@paused = false @paused = false
if @vimeo if @vimeo
@vimeo.play().catch((error) -> @vimeo.api('play')
console.error('vimeo::play():', error)
)
pause: -> pause: ->
@paused = true @paused = true
if @vimeo if @vimeo
@vimeo.pause().catch((error) -> @vimeo.api('pause')
console.error('vimeo::pause():', error)
)
seekTo: (time) -> seekTo: (time) ->
if @vimeo if @vimeo
@vimeo.setCurrentTime(time).catch((error) -> @vimeo.api('seekTo', time)
console.error('vimeo::setCurrentTime():', error)
)
setVolume: (volume) -> setVolume: (volume) ->
if @vimeo if @vimeo
@vimeo.setVolume(volume).catch((error) -> @vimeo.api('setVolume', volume)
console.error('vimeo::setVolume():', error)
)
getTime: (cb) -> getTime: (cb) ->
if @vimeo if @vimeo
@vimeo.getCurrentTime().then((time) -> @vimeo.api('getCurrentTime', (time) ->
# I will never understand why Vimeo returns current time as a string
cb(parseFloat(time)) cb(parseFloat(time))
).catch((error) ->
console.error('vimeo::getCurrentTime():', error)
) )
else else
cb(0) cb(0)
getVolume: (cb) -> getVolume: (cb) ->
if @vimeo if @vimeo
@vimeo.getVolume().then((volume) -> @vimeo.api('getVolume', cb)
cb(parseFloat(volume))
).catch((error) ->
console.error('vimeo::getVolume():', error)
)
else else
cb(VOLUME) cb(VOLUME)

View file

@ -1,87 +0,0 @@
window.WhepPlayer = class WhepPlayer extends Player
constructor: (data) ->
return new WhepPlayer(data) unless this instanceof WhepPlayer
super(data)
@load(data)
load: (data) ->
@ready = false
@paused = true
@setMediaProperties(data)
unless data.meta?.whepURL
u = new URL(data.id)
streemId = u.pathname.split('/').filter(Boolean)[0]
data.meta ?= {}
# Adjust these to whatever your backend expects
data.meta.whepURL = "#{u.origin}/api/whep"
data.meta.streamKey = streemId
{ whepURL, streamKey } = data.meta
# Create video element
videoEl = document.createElement 'video'
videoEl.autoplay = true
videoEl.muted = true
videoEl.controls = true
# Use the standard container swapper
holder = removeOld() # jQuery object
holder.empty().append(videoEl)
@videoEl = videoEl
# ---- WebRTC setup ----
pc = new RTCPeerConnection()
pc.addTransceiver 'audio', direction: 'recvonly'
pc.addTransceiver 'video', direction: 'recvonly'
pc.ontrack = (e) => @videoEl.srcObject = e.streams[0]
pc.onconnectionstatechange = =>
if pc.connectionState is 'connected'
@ready = true
@fire? 'ready'
pc.createOffer()
.then (offer) =>
pc.setLocalDescription offer
fetch whepURL,
method: 'POST'
headers:
Authorization: "Bearer #{streamKey}"
'Content-Type': 'application/sdp'
body: offer.sdp
.then (r) -> r.text()
.then (answer) ->
pc.setRemoteDescription type: 'answer', sdp: answer
.catch (err) ->
console.error 'WHEP negotiation failed:', err
@pc = pc
play: ->
@paused = false
@videoEl?.play?()
pause: ->
@paused = true
@videoEl?.pause?()
seekTo: (t) ->
@videoEl?.currentTime = t if @ready
setVolume: (v) ->
@videoEl?.volume = v if @ready
getTime: (cb) ->
if @ready and @videoEl?
cb @videoEl.currentTime
else
cb 0
getVolume: (cb) ->
if @ready and @videoEl?
cb @videoEl.volume
else
cb VOLUME

View file

@ -4,6 +4,7 @@ window.YouTubePlayer = class YouTubePlayer extends Player
return new YouTubePlayer(data) return new YouTubePlayer(data)
@setMediaProperties(data) @setMediaProperties(data)
@qualityRaceCondition = true
@pauseSeekRaceCondition = false @pauseSeekRaceCondition = false
waitUntilDefined(window, 'YT', => waitUntilDefined(window, 'YT', =>
@ -12,6 +13,7 @@ window.YouTubePlayer = class YouTubePlayer extends Player
waitUntilDefined(YT, 'Player', => waitUntilDefined(YT, 'Player', =>
removeOld() removeOld()
wmode = if USEROPTS.wmode_transparent then 'transparent' else 'opaque'
@yt = new YT.Player('ytapiplayer', @yt = new YT.Player('ytapiplayer',
videoId: data.id videoId: data.id
playerVars: playerVars:
@ -20,6 +22,7 @@ window.YouTubePlayer = class YouTubePlayer extends Player
controls: 1 controls: 1
iv_load_policy: 3 # iv_load_policy 3 indicates no annotations iv_load_policy: 3 # iv_load_policy 3 indicates no annotations
rel: 0 rel: 0
wmode: wmode
events: events:
onReady: @onReady.bind(this) onReady: @onReady.bind(this)
onStateChange: @onStateChange.bind(this) onStateChange: @onStateChange.bind(this)
@ -31,6 +34,9 @@ window.YouTubePlayer = class YouTubePlayer extends Player
@setMediaProperties(data) @setMediaProperties(data)
if @yt and @yt.ready if @yt and @yt.ready
@yt.loadVideoById(data.id, data.currentTime) @yt.loadVideoById(data.id, data.currentTime)
@qualityRaceCondition = true
if USEROPTS.default_quality
@setQuality(USEROPTS.default_quality)
else else
console.error('WTF? YouTubePlayer::load() called but yt is not ready') console.error('WTF? YouTubePlayer::load() called but yt is not ready')
@ -39,9 +45,15 @@ window.YouTubePlayer = class YouTubePlayer extends Player
@setVolume(VOLUME) @setVolume(VOLUME)
onStateChange: (ev) -> onStateChange: (ev) ->
# If you pause the video before the first PLAYING # For some reason setting the quality doesn't work
# event is emitted, weird things happen (or at least that was true # until the first event has fired.
# whenever this comment was authored in 2015). if @qualityRaceCondition
@qualityRaceCondition = false
if USEROPTS.default_quality
@setQuality(USEROPTS.default_quality)
# Similar to above, if you pause the video before the first PLAYING
# event is emitted, weird things happen.
if ev.data == YT.PlayerState.PLAYING and @pauseSeekRaceCondition if ev.data == YT.PlayerState.PLAYING and @pauseSeekRaceCondition
@pause() @pause()
@pauseSeekRaceCondition = false @pauseSeekRaceCondition = false
@ -78,7 +90,20 @@ window.YouTubePlayer = class YouTubePlayer extends Player
@yt.setVolume(volume * 100) @yt.setVolume(volume * 100)
setQuality: (quality) -> setQuality: (quality) ->
# https://github.com/calzoneman/sync/issues/726 if not @yt or not @yt.ready
return
ytQuality = switch String(quality)
when '240' then 'small'
when '360' then 'medium'
when '480' then 'large'
when '720' then 'hd720'
when '1080' then 'hd1080'
when 'best' then 'highres'
else 'auto'
if ytQuality != 'auto'
@yt.setPlaybackQuality(ytQuality)
getTime: (cb) -> getTime: (cb) ->
if @yt and @yt.ready if @yt and @yt.ready

View file

@ -1,14 +1,13 @@
#!/bin/sh #!/bin/sh
set -e echo "In order to run the server, the source files in src/ must be transpiled to lib/. This will overwrite any changes you have made to the files in lib/."
echo -n "Do you want to build now? [y/N]? "
read answer
echo
if ! command -v npm >/dev/null; then if test "$answer" = "y" || test "$answer" = "Y"; then
echo "Could not find npm in \$PATH" echo "Running $npm_package_scripts_build_server"
exit 1 $npm_package_scripts_build_server
else
echo "Skipping build step. You can build at a later time by running \`npm run build-server\`."
fi fi
echo "Building from src/ to lib/"
npm run build-server
echo "Building from player/ to www/js/player.js"
npm run build-player
echo "Done"

View file

@ -14,7 +14,6 @@ const COMPLETIONS = [
"/gc", "/gc",
"/globalban", "/globalban",
"/reload", "/reload",
"/reloadcert",
"/reload-partitions", "/reload-partitions",
"/switch", "/switch",
"/unglobalban", "/unglobalban",
@ -34,7 +33,7 @@ const SOCKETFILE = Config.get("service-socket.socket");
// Wipe the TTY // Wipe the TTY
process.stdout.write('\x1Bc'); process.stdout.write('\x1Bc');
var commandline, eventlog, syslog, errorlog; var commandline, eventlog, syslog;
var client = net.createConnection(SOCKETFILE).on('connect', () => { var client = net.createConnection(SOCKETFILE).on('connect', () => {
commandline = readline.createInterface({ commandline = readline.createInterface({
input: process.stdin, input: process.stdin,
@ -79,11 +78,6 @@ var client = net.createConnection(SOCKETFILE).on('connect', () => {
console.log(data.toString().replace(/^(.+)$/mg, 'sys: $1')); console.log(data.toString().replace(/^(.+)$/mg, 'sys: $1'));
}); });
errorlog = spawn('tail', ['-f', 'error.log']);
errorlog.stdout.on('data', function (data) {
console.log(data.toString().replace(/^(.+)$/mg, 'error: $1'));
});
}).on('data', (msg) => { }).on('data', (msg) => {
msg = msg.toString(); msg = msg.toString();

View file

@ -1 +0,0 @@
{ "env": { "node": true } }

View file

@ -1,59 +1,155 @@
import db from './database'; var db = require("./database");
import Promise from 'bluebird'; var Q = require("q");
const dbGetGlobalRank = Promise.promisify(db.users.getGlobalRank); function Account(opts) {
const dbMultiGetGlobalRank = Promise.promisify(db.users.getGlobalRanks); var defaults = {
const dbGetChannelRank = Promise.promisify(db.channels.getRank); name: "",
const dbMultiGetChannelRank = Promise.promisify(db.channels.getRanks); ip: "",
const dbGetAliases = Promise.promisify(db.getAliases); aliases: [],
globalRank: -1,
const DEFAULT_PROFILE = Object.freeze({ image: '', text: '' }); channelRank: -1,
guest: true,
class Account { profile: {
constructor(ip, user, aliases) { image: "",
this.ip = ip; text: ""
this.user = user;
this.aliases = aliases;
this.channelRank = -1;
this.guestName = null;
this.update();
}
update() {
if (this.user !== null) {
this.name = this.user.name;
this.globalRank = this.user.global_rank;
} else if (this.guestName !== null) {
this.name = this.guestName;
this.globalRank = 0;
} else {
this.name = '';
this.globalRank = -1;
} }
this.lowername = this.name.toLowerCase(); };
this.effectiveRank = Math.max(this.channelRank, this.globalRank);
this.profile = (this.user === null) ? DEFAULT_PROFILE : this.user.profile; this.name = opts.name || defaults.name;
} this.lowername = this.name.toLowerCase();
this.ip = opts.ip || defaults.ip;
this.aliases = opts.aliases || defaults.aliases;
this.globalRank = "globalRank" in opts ? opts.globalRank : defaults.globalRank;
this.channelRank = "channelRank" in opts ? opts.channelRank : defaults.channelRank;
this.effectiveRank = Math.max(this.globalRank, this.channelRank);
this.guest = this.globalRank === 0;
this.profile = opts.profile || defaults.profile;
} }
module.exports.Account = Account; module.exports.default = function (ip) {
return new Account({ ip: ip });
module.exports.rankForName = async function rankForNameAsync(name, channel) {
const [globalRank, channelRank] = await Promise.all([
dbGetGlobalRank(name),
dbGetChannelRank(channel, name)
]);
return Math.max(globalRank, channelRank);
}; };
module.exports.rankForIP = async function rankForIP(ip, channel) { module.exports.getAccount = function (name, ip, opts, cb) {
const aliases = await dbGetAliases(ip); if (!cb) {
const [globalRanks, channelRanks] = await Promise.all([ cb = opts;
dbMultiGetGlobalRank(aliases), opts = {};
dbMultiGetChannelRank(channel, aliases) }
]); opts.channel = opts.channel || false;
return Math.max.apply(Math, globalRanks.concat(channelRanks)); var data = {};
Q.nfcall(db.getAliases, ip)
.then(function (aliases) {
data.aliases = aliases;
if (name && opts.registered) {
return Q.nfcall(db.users.getGlobalRank, name);
} else if (name) {
return 0;
} else {
return -1;
}
}).then(function (globalRank) {
data.globalRank = globalRank;
if (opts.channel && opts.registered) {
return Q.nfcall(db.channels.getRank, opts.channel, name);
} else {
if (opts.registered) {
return 1;
} else if (name) {
return 0;
} else {
return -1;
}
}
}).then(function (chanRank) {
data.channelRank = chanRank;
/* Look up profile for registered user */
if (data.globalRank >= 1) {
return Q.nfcall(db.users.getProfile, name);
} else {
return { text: "", image: "" };
}
}).then(function (profile) {
setImmediate(function () {
cb(null, new Account({
name: name,
ip: ip,
aliases: data.aliases,
globalRank: data.globalRank,
channelRank: data.channelRank,
profile: profile
}));
});
}).catch(function (err) {
cb(err, null);
}).done();
};
module.exports.rankForName = function (name, opts, cb) {
if (!cb) {
cb = opts;
opts = {};
}
var rank = 0;
Q.fcall(function () {
return Q.nfcall(db.users.getGlobalRank, name);
}).then(function (globalRank) {
rank = globalRank;
if (opts.channel) {
return Q.nfcall(db.channels.getRank, opts.channel, name);
} else {
return globalRank > 0 ? 1 : 0;
}
}).then(function (chanRank) {
setImmediate(function () {
cb(null, Math.max(rank, chanRank));
});
}).catch(function (err) {
cb(err, 0);
}).done();
};
module.exports.rankForIP = function (ip, opts, cb) {
if (!cb) {
cb = opts;
opts = {};
}
var globalRank, rank, names;
var promise = Q.nfcall(db.getAliases, ip)
.then(function (_names) {
names = _names;
return Q.nfcall(db.users.getGlobalRanks, names);
}).then(function (ranks) {
ranks.push(0);
globalRank = Math.max.apply(Math, ranks);
rank = globalRank;
});
if (!opts.channel) {
promise.then(function () {
setImmediate(function () {
cb(null, globalRank);
});
}).catch(function (err) {
cb(err, null);
}).done();
} else {
promise.then(function () {
return Q.nfcall(db.channels.getRanks, opts.channel, names);
}).then(function (ranks) {
ranks.push(globalRank);
rank = Math.max.apply(Math, ranks);
}).then(function () {
setImmediate(function () {
cb(null, rank);
});
}).catch(function (err) {
setImmediate(function () {
cb(err, null);
});
}).done();
}
}; };

View file

@ -2,7 +2,8 @@ var Logger = require("./logger");
var Server = require("./server"); var Server = require("./server");
var db = require("./database"); var db = require("./database");
var util = require("./utilities"); var util = require("./utilities");
import { v4 as uuidv4 } from 'uuid'; var Config = require("./config");
var Server = require("./server");
function eventUsername(user) { function eventUsername(user) {
return user.getName() + "@" + user.realip; return user.getName() + "@" + user.realip;
@ -12,7 +13,6 @@ function handleAnnounce(user, data) {
var sv = Server.getServer(); var sv = Server.getServer();
sv.announce({ sv.announce({
id: uuidv4(),
title: data.title, title: data.title,
text: data.content, text: data.content,
from: user.getName() from: user.getName()
@ -28,60 +28,77 @@ function handleAnnounceClear(user) {
} }
function handleGlobalBan(user, data) { function handleGlobalBan(user, data) {
const globalBanDB = db.getGlobalBanDB(); db.globalBanIP(data.ip, data.note, function (err, res) {
globalBanDB.addGlobalIPBan(data.ip, data.note).then(() => { if (err) {
Logger.eventlog.log("[acp] " + eventUsername(user) + " global banned " + data.ip); user.socket.emit("errMessage", {
return globalBanDB.listGlobalBans().then(bans => { msg: err
// Why is it called reason in the DB and note in the socket frame?
// Who knows...
const mappedBans = bans.map(ban => {
return { ip: ban.ip, note: ban.reason };
}); });
user.socket.emit("acp-gbanlist", mappedBans); return;
}); }
}).catch(error => {
user.socket.emit("errMessage", { Logger.eventlog.log("[acp] " + eventUsername(user) + " global banned " + data.ip);
msg: error.message
db.listGlobalBans(function (err, bans) {
if (err) {
user.socket.emit("errMessage", {
msg: err
});
return;
}
var flat = [];
for (var ip in bans) {
flat.push({
ip: ip,
note: bans[ip].reason
});
}
user.socket.emit("acp-gbanlist", flat);
}); });
}); });
} }
function handleGlobalBanDelete(user, data) { function handleGlobalBanDelete(user, data) {
const globalBanDB = db.getGlobalBanDB(); db.globalUnbanIP(data.ip, function (err, res) {
globalBanDB.removeGlobalIPBan(data.ip).then(() => { if (err) {
user.socket.emit("errMessage", {
msg: err
});
return;
}
Logger.eventlog.log("[acp] " + eventUsername(user) + " un-global banned " + Logger.eventlog.log("[acp] " + eventUsername(user) + " un-global banned " +
data.ip); data.ip);
return globalBanDB.listGlobalBans().then(bans => {
// Why is it called reason in the DB and note in the socket frame? db.listGlobalBans(function (err, bans) {
// Who knows... if (err) {
const mappedBans = bans.map(ban => { user.socket.emit("errMessage", {
return { ip: ban.ip, note: ban.reason }; msg: err
}); });
user.socket.emit("acp-gbanlist", mappedBans); return;
}); }
}).catch(error => {
user.socket.emit("errMessage", { var flat = [];
msg: error.message for (var ip in bans) {
flat.push({
ip: ip,
note: bans[ip].reason
});
}
user.socket.emit("acp-gbanlist", flat);
}); });
}); });
} }
function handleListUsers(user, data) { function handleListUsers(user, data) {
var value = data.value; var name = data.name;
var field = data.field; if (typeof name !== "string") {
value = (typeof value !== 'string') ? '' : value; name = "";
field = (typeof field !== 'string') ? 'name' : field; }
var fields = ["id", "name", "global_rank", "email", "ip", "time"]; var fields = ["id", "name", "global_rank", "email", "ip", "time"];
if(!fields.includes(field)){ db.users.search(name, fields, function (err, users) {
user.socket.emit("errMessage", {
msg: `The field "${field}" doesn't exist or isn't searchable.`
});
return;
}
db.users.search(field, value, fields, function (err, users) {
if (err) { if (err) {
user.socket.emit("errMessage", { user.socket.emit("errMessage", {
msg: err msg: err
@ -137,7 +154,7 @@ function handleSetRank(user, data) {
}); });
} }
function handleResetPassword(user, data, ack) { function handleResetPassword(user, data) {
var name = data.name; var name = data.name;
var email = data.email; var email = data.email;
if (typeof name !== "string" || typeof email !== "string") { if (typeof name !== "string" || typeof email !== "string") {
@ -162,14 +179,19 @@ function handleResetPassword(user, data, ack) {
expire: expire expire: expire
}, function (err) { }, function (err) {
if (err) { if (err) {
ack && ack({ error: err }); user.socket.emit("errMessage", {
msg: err
});
return; return;
} }
Logger.eventlog.log("[acp] " + eventUsername(user) + " initialized a " + Logger.eventlog.log("[acp] " + eventUsername(user) + " initialized a " +
"password recovery for " + name); "password recovery for " + name);
ack && ack({ hash }); user.socket.emit("errMessage", {
msg: "Reset link: " + Config.get("http.domain") +
"/account/passwordrecover/" + hash
});
}); });
}); });
} }
@ -252,6 +274,12 @@ function handleForceUnload(user, data) {
Logger.eventlog.log("[acp] " + eventUsername(user) + " forced unload of " + name); Logger.eventlog.log("[acp] " + eventUsername(user) + " forced unload of " + name);
} }
function handleListStats(user) {
db.listStats(function (err, rows) {
user.socket.emit("acp-list-stats", rows);
});
}
function init(user) { function init(user) {
var s = user.socket; var s = user.socket;
s.on("acp-announce", handleAnnounce.bind(this, user)); s.on("acp-announce", handleAnnounce.bind(this, user));
@ -265,19 +293,24 @@ function init(user) {
s.on("acp-delete-channel", handleDeleteChannel.bind(this, user)); s.on("acp-delete-channel", handleDeleteChannel.bind(this, user));
s.on("acp-list-activechannels", handleListActiveChannels.bind(this, user)); s.on("acp-list-activechannels", handleListActiveChannels.bind(this, user));
s.on("acp-force-unload", handleForceUnload.bind(this, user)); s.on("acp-force-unload", handleForceUnload.bind(this, user));
s.on("acp-list-stats", handleListStats.bind(this, user));
const globalBanDB = db.getGlobalBanDB(); db.listGlobalBans(function (err, bans) {
globalBanDB.listGlobalBans().then(bans => { if (err) {
// Why is it called reason in the DB and note in the socket frame? user.socket.emit("errMessage", {
// Who knows... msg: err
const mappedBans = bans.map(ban => { });
return { ip: ban.ip, note: ban.reason }; return;
}); }
user.socket.emit("acp-gbanlist", mappedBans);
}).catch(error => { var flat = [];
user.socket.emit("errMessage", { for (var ip in bans) {
msg: error.message flat.push({
}); ip: ip,
note: bans[ip].reason
});
}
user.socket.emit("acp-gbanlist", flat);
}); });
Logger.eventlog.log("[acp] Initialized ACP for " + eventUsername(user)); Logger.eventlog.log("[acp] Initialized ACP for " + eventUsername(user));
} }

View file

@ -9,7 +9,7 @@ AsyncQueue.prototype.next = function () {
if (!this.lock()) if (!this.lock())
return; return;
var item = this._q.shift(); var item = this._q.shift();
var fn = item[0]; var fn = item[0], tm = item[1];
this._tm = Date.now() + item[1]; this._tm = Date.now() + item[1];
fn(this); fn(this);
} }

View file

@ -0,0 +1,23 @@
class BackendConfiguration {
constructor(config) {
this.config = config;
}
getRedisConfig() {
return this.config.redis;
}
getListenerConfig() {
return this.config.proxy.listeners.map(listener => ({
getHost() {
return listener.host;
},
getPort() {
return listener.port;
}
}));
}
}
export { BackendConfiguration };

View file

@ -0,0 +1,93 @@
import { RedisClusterClient } from '../io/cluster/redisclusterclient';
import { DualClusterClient } from '../io/cluster/dualclusterclient';
import NullClusterClient from '../io/cluster/nullclusterclient';
import { FrontendPool } from 'cytube-common/lib/redis/frontendpool';
import RedisClientProvider from 'cytube-common/lib/redis/redisclientprovider';
import { loadFromToml } from 'cytube-common/lib/configuration/configloader';
import path from 'path';
import { BackendConfiguration } from './backendconfiguration';
import logger from 'cytube-common/lib/logger';
import redisAdapter from 'socket.io-redis';
import LegacyConfig from '../config';
import IOConfiguration from '../configuration/ioconfig';
import * as Switches from '../switches';
const BACKEND_CONFIG_PATH = path.resolve(__dirname, '..', '..', 'backend.toml');
class BackendModule {
constructor() {
this.initConfig();
}
initConfig() {
logger.initialize(null, null, LegacyConfig.get('debug'));
try {
this.backendConfig = loadFromToml(BackendConfiguration, BACKEND_CONFIG_PATH);
} catch (error) {
if (typeof error.line !== 'undefined') {
logger.error(`Error in configuration file: ${error} (line ${error.line})`);
} else {
logger.error(`Error loading configuration: ${error.stack}`);
}
process.exit(1);
}
}
onReady() {
const redisClientProvider = this.getRedisClientProvider();
this.redisAdapter = redisAdapter({
pubClient: redisClientProvider.get(),
// return_buffers is needed for msgpack-js to function correctly
subClient: redisClientProvider.get({ return_buffers: true })
});
this.sioEmitter = require('socket.io').instance;
this.sioEmitter.adapter(this.redisAdapter);
const IOBackend = require('./iobackend');
this.ioBackend = new IOBackend(
this.backendConfig.getListenerConfig()[0],
this.sioEmitter,
redisClientProvider.get()
)
}
getFrontendPool() {
if (!this.frontendPool) {
this.frontendPool = new FrontendPool(this.getRedisClientProvider().get());
}
return this.frontendPool;
}
getRedisClientProvider() {
if (!this.redisClientProvider) {
this.redisClientProvider = new RedisClientProvider(
this.backendConfig.getRedisConfig()
);
}
return this.redisClientProvider;
}
getClusterClient() {
if (!this.redisClusterClient) {
this.redisClusterClient = new RedisClusterClient(this.getFrontendPool());
}
if (Switches.isActive(Switches.DUAL_BACKEND) && !this.nullClusterClient) {
this.nullClusterClient = new NullClusterClient(
IOConfiguration.fromOldConfig(LegacyConfig));
}
if (Switches.isActive(Switches.DUAL_BACKEND)) {
this.clusterClient = new DualClusterClient(this.nullClusterClient,
this.redisClusterClient);
} else {
this.clusterClient = this.redisClusterClient;
}
return this.clusterClient;
}
}
export { BackendModule }

45
src/backend/iobackend.js Normal file
View file

@ -0,0 +1,45 @@
import Server from 'cytube-common/lib/proxy/server';
import ProxyInterceptor from './proxyinterceptor';
import uuid from 'uuid';
import PoolEntryUpdater from 'cytube-common/lib/redis/poolentryupdater';
import JSONProtocol from 'cytube-common/lib/proxy/protocol';
import { formatProxyAddress } from 'cytube-common/lib/util/addressutil';
const BACKEND_POOL = 'backend-hosts';
export default class IOBackend {
constructor(proxyListenerConfig, socketEmitter, poolRedisClient) {
this.proxyListenerConfig = proxyListenerConfig;
this.socketEmitter = socketEmitter;
this.poolRedisClient = poolRedisClient;
this.protocol = new JSONProtocol();
this.initProxyInterceptor();
this.initProxyListener();
this.initBackendPoolUpdater();
}
initProxyInterceptor() {
this.proxyInterceptor = new ProxyInterceptor(this.socketEmitter);
}
initProxyListener() {
this.proxyListener = new Server(this.proxyListenerConfig, this.protocol);
this.proxyListener.on('connection',
this.proxyInterceptor.onConnection.bind(this.proxyInterceptor));
}
initBackendPoolUpdater() {
const hostname = this.proxyListenerConfig.getHost();
const port = this.proxyListenerConfig.getPort();
const entry = {
address: formatProxyAddress(hostname, port)
}
this.poolEntryUpdater = new PoolEntryUpdater(
this.poolRedisClient,
BACKEND_POOL,
uuid.v4(),
entry
);
this.poolEntryUpdater.start();
}
}

View file

@ -0,0 +1,54 @@
import logger from 'cytube-common/lib/logger';
import { EventEmitter } from 'events';
export default class ProxiedSocket extends EventEmitter {
constructor(socketID, socketIP, socketUser, socketEmitter, frontendConnection) {
super();
this.id = socketID;
this.ip = socketIP;
this._realip = socketIP;
if (socketUser) {
this.user = {
name: socketUser.name,
global_rank: socketUser.globalRank
};
}
this.socketEmitter = socketEmitter;
this.frontendConnection = frontendConnection;
}
emit() {
const target = this.socketEmitter.to(this.id);
target.emit.apply(target, arguments);
}
onProxiedEventReceived() {
try {
EventEmitter.prototype.emit.apply(this, arguments);
} catch (error) {
logger.error(`Emit failed: ${error.stack}`);
}
}
join(channel) {
this.frontendConnection.write(
this.frontendConnection.protocol.newSocketJoinRoomsEvent(
this.id, [channel]
)
);
}
leave(room) {
this.frontendConnection.write(
this.frontendConnection.protocol.newSocketLeaveRoomsEvent(
this.id, [room]
)
);
}
disconnect() {
this.frontendConnection.write(
this.frontendConnection.protocol.newSocketKickEvent(this.id)
);
}
}

View file

@ -0,0 +1,91 @@
import logger from 'cytube-common/lib/logger';
import ioServer from '../io/ioserver';
import ProxiedSocket from './proxiedsocket';
export default class ProxyInterceptor {
constructor(socketEmitter) {
this.socketEmitter = socketEmitter;
this.frontendConnections = {};
this.frontendProxiedSockets = {};
}
/**
* Handle a new frontend proxy connection.
*
* @param {Connection} socket frontend proxy connection
*/
onConnection(socket) {
if (this.frontendConnections.hasOwnProperty(socket.endpoint)) {
logger.error(`Duplicate frontend connection: ${socket.endpoint}`);
return;
}
logger.info(`Got proxy connection from ${socket.endpoint}`);
this.frontendConnections[socket.endpoint] = socket;
socket.on('close', this.onFrontendDisconnect.bind(this, socket));
socket.on('SocketConnectEvent', this.onSocketConnect.bind(this, socket));
socket.on('SocketFrameEvent', this.onSocketFrame.bind(this, socket));
socket.on('SocketDisconnectEvent', this.onSocketDisconnect.bind(this, socket));
}
onFrontendDisconnect(socket) {
const endpoint = socket.endpoint;
if (this.frontendConnections.hasOwnProperty(endpoint)) {
if (this.frontendProxiedSockets.hasOwnProperty(endpoint)) {
logger.warn(`Frontend ${endpoint} disconnected`);
for (const key in this.frontendProxiedSockets[endpoint]) {
const proxySocket = this.frontendProxiedSockets[endpoint][key];
proxySocket.onProxiedEventReceived('disconnect');
}
delete this.frontendProxiedSockets[endpoint];
}
delete this.frontendConnections[endpoint];
}
}
onSocketConnect(frontendConnection, socketID, socketIP, socketUser) {
const mapKey = frontendConnection.endpoint;
const proxiedSocket = new ProxiedSocket(
socketID,
socketIP,
socketUser,
this.socketEmitter,
frontendConnection);
if (!this.frontendProxiedSockets.hasOwnProperty(mapKey)) {
this.frontendProxiedSockets[mapKey] = {};
} else if (this.frontendProxiedSockets[mapKey].hasOwnProperty(socketID)) {
logger.error(`Duplicate SocketConnectEvent for ${socketID}`);
return;
}
this.frontendProxiedSockets[mapKey][socketID] = proxiedSocket;
ioServer.handleConnection(proxiedSocket);
}
onSocketFrame(frontendConnection, socketID, event, args) {
const mapKey = frontendConnection.endpoint;
const socketMap = this.frontendProxiedSockets[mapKey];
if (!socketMap || !socketMap.hasOwnProperty(socketID)) {
logger.error(`Received SocketFrameEvent for nonexistent socket`,
{ socketID, event });
return;
}
const socket = socketMap[socketID];
socket.onProxiedEventReceived.apply(socket, [event].concat(args));
}
onSocketDisconnect(frontendConnection, socketID) {
const mapKey = frontendConnection.endpoint;
const socketMap = this.frontendProxiedSockets[mapKey];
if (!socketMap || !socketMap.hasOwnProperty(socketID)) {
logger.error(`Received SocketDisconnectEvent for nonexistent socket`,
{ socketID });
return;
}
const socket = socketMap[socketID];
socket.onProxiedEventReceived.apply(socket, ['disconnect']);
}
}

View file

@ -5,179 +5,85 @@
running. running.
*/ */
var Logger = require("./logger");
var Config = require("./config"); var Config = require("./config");
var db = require("./database"); var db = require("./database");
var Promise = require("bluebird"); var Promise = require("bluebird");
const shows = require('./shows');
const calendarDB = require('./database/calendar-integrations');
const integrationsApi = require('./web/routes/api/integrations');
const LOGGER = require('@calzoneman/jsli')('bgtask');
var init = null; var init = null;
/* Stats */
function initStats(Server) {
var STAT_INTERVAL = parseInt(Config.get("stats.interval"));
var STAT_EXPIRE = parseInt(Config.get("stats.max-age"));
setInterval(function () {
var chancount = Server.channels.length;
var usercount = 0;
Server.channels.forEach(function (chan) {
usercount += chan.users.length;
});
var mem = process.memoryUsage().rss;
db.addStatPoint(Date.now(), usercount, chancount, mem, function () {
db.pruneStats(Date.now() - STAT_EXPIRE);
});
}, STAT_INTERVAL);
}
/* Alias cleanup */ /* Alias cleanup */
function initAliasCleanup() { function initAliasCleanup(Server) {
var CLEAN_INTERVAL = parseInt(Config.get("aliases.purge-interval")); var CLEAN_INTERVAL = parseInt(Config.get("aliases.purge-interval"));
var CLEAN_EXPIRE = parseInt(Config.get("aliases.max-age")); var CLEAN_EXPIRE = parseInt(Config.get("aliases.max-age"));
setInterval(function () { setInterval(function () {
db.cleanOldAliases(CLEAN_EXPIRE, function (err) { db.cleanOldAliases(CLEAN_EXPIRE, function (err) {
LOGGER.info("Cleaned old aliases"); Logger.syslog.log("Cleaned old aliases");
if (err) if (err)
LOGGER.error(err); Logger.errlog.log(err);
}); });
}, CLEAN_INTERVAL); }, CLEAN_INTERVAL);
} }
/* Password reset cleanup */ /* Password reset cleanup */
function initPasswordResetCleanup() { function initPasswordResetCleanup(Server) {
var CLEAN_INTERVAL = 8*60*60*1000; var CLEAN_INTERVAL = 8*60*60*1000;
setInterval(function () { setInterval(function () {
db.cleanOldPasswordResets(function (err) { db.cleanOldPasswordResets(function (err) {
if (err) if (err)
LOGGER.error(err); Logger.errlog.log(err);
}); });
}, CLEAN_INTERVAL); }, CLEAN_INTERVAL);
} }
function initChannelDumper(Server) { function initChannelDumper(Server) {
const chanPath = Config.get('channel-path');
var CHANNEL_SAVE_INTERVAL = parseInt(Config.get("channel-save-interval")) var CHANNEL_SAVE_INTERVAL = parseInt(Config.get("channel-save-interval"))
* 60000; * 60000;
setInterval(function () { setInterval(function () {
if (Server.channels.length === 0) {
return;
}
var wait = CHANNEL_SAVE_INTERVAL / Server.channels.length; var wait = CHANNEL_SAVE_INTERVAL / Server.channels.length;
LOGGER.info(`Saving channels with delay ${wait}`);
Promise.reduce(Server.channels, (_, chan) => { Promise.reduce(Server.channels, (_, chan) => {
return Promise.delay(wait).then(async () => { return Promise.delay(wait).then(() => {
if (!chan.dead && chan.users && chan.users.length > 0) { if (!chan.dead && chan.users && chan.users.length > 0) {
try { return chan.saveState().catch(err => {
await chan.saveState(); Logger.errlog.log(`Failed to save /r/${chan.name}: ${err.stack}`);
LOGGER.info(`Saved /${chanPath}/${chan.name}`);
} catch (error) {
LOGGER.error(
'Failed to save /%s/%s: %s',
chanPath,
chan ? chan.name : '<undefined>',
error.stack
);
}
}
}).catch(error => {
LOGGER.error(`Failed to save channel: ${error.stack}`);
});
}, 0).catch(error => {
LOGGER.error(`Failed to save channels: ${error.stack}`);
});
}, CHANNEL_SAVE_INTERVAL);
}
function initAccountCleanup() {
setInterval(() => {
(async () => {
let rows = await db.users.findAccountsPendingDeletion();
for (let row of rows) {
try {
await db.users.purgeAccount(row.id);
LOGGER.info('Purged account from request %j', row);
} catch (error) {
LOGGER.error('Error purging account %j: %s', row, error.stack);
}
}
})().catch(error => {
LOGGER.error('Error purging deleted accounts: %s', error.stack);
});
}, 3600 * 1000);
}
function initShowScheduler() {
var SCHEDULE_INTERVAL = 15 * 1000;
var running = false;
setInterval(async () => {
if (running) {
return;
}
running = true;
try {
await shows.pollAndRunDueShows();
} catch (error) {
LOGGER.error('Show scheduler failure: %s', error.stack || error);
} finally {
running = false;
}
}, SCHEDULE_INTERVAL);
}
function initCalendarAutoSyncScheduler() {
const AUTO_SYNC_INTERVAL_MS = 60 * 1000;
const AUTO_SYNC_PERIOD_MINUTES = 30;
let running = false;
function inStaggerSlot(integrationId, now) {
const slot = Number(integrationId || 0) % AUTO_SYNC_PERIOD_MINUTES;
const minute = new Date(now).getUTCMinutes() % AUTO_SYNC_PERIOD_MINUTES;
return slot === minute;
}
setInterval(async () => {
if (running) {
return;
}
running = true;
try {
const now = Date.now();
const rows = await calendarDB.listConnectedByProvider('google');
for (const integration of rows) {
if (!inStaggerSlot(integration.id, now)) {
continue;
}
if (integration.last_sync_at && now - integration.last_sync_at < AUTO_SYNC_PERIOD_MINUTES * 60 * 1000) {
continue;
}
try {
await integrationsApi.syncIntegrationNow({
provider: 'google',
integration,
channelRow: { id: integration.channel_id },
enforceCooldown: false
}); });
} catch (err) {
LOGGER.warn(
'Auto calendar sync failed integration=%s channel=%s: %s',
integration.id,
integration.channel_id,
err && (err.stack || err.message) || err
);
} }
} });
} catch (err) { }, 0);
LOGGER.error('Calendar auto-sync scheduler failure: %s', err.stack || err); }, CHANNEL_SAVE_INTERVAL);
} finally {
running = false;
}
}, AUTO_SYNC_INTERVAL_MS);
} }
module.exports = function (Server) { module.exports = function (Server) {
if (init === Server) { if (init === Server) {
LOGGER.warn("Attempted to re-init background tasks"); Logger.errlog.log("WARNING: Attempted to re-init background tasks");
return; return;
} }
init = Server; init = Server;
initAliasCleanup(); initStats(Server);
initAliasCleanup(Server);
initChannelDumper(Server); initChannelDumper(Server);
initPasswordResetCleanup(); initPasswordResetCleanup(Server);
initAccountCleanup();
initShowScheduler();
initCalendarAutoSyncScheduler();
}; };

View file

@ -1,29 +0,0 @@
const registry = new Map(); // botId -> Set<socket>
function register(botId, socket) {
if (!registry.has(botId)) {
registry.set(botId, new Set());
}
registry.get(botId).add(socket);
socket.once('disconnect', () => {
const sockets = registry.get(botId);
if (sockets) {
sockets.delete(socket);
if (sockets.size === 0) {
registry.delete(botId);
}
}
});
}
function disconnect(botId) {
const sockets = registry.get(botId);
if (sockets) {
for (const socket of sockets) {
socket.disconnect(true);
}
registry.delete(botId);
}
}
module.exports = { register, disconnect };

View file

@ -1,46 +0,0 @@
import crypto from 'crypto';
import * as urlparse from 'url';
const LOGGER = require('@calzoneman/jsli')('camo');
function isWhitelisted(camoConfig, url) {
const whitelistedDomains = camoConfig.getWhitelistedDomainsRegexp();
const parsed = urlparse.parse(url);
return whitelistedDomains.test('.' + parsed.hostname);
}
export function camoify(camoConfig, url) {
if (typeof url !== 'string') {
throw new TypeError(`camoify expected a string, not [${url}]`);
}
if (isWhitelisted(camoConfig, url)) {
return url.replace(/^http:/, 'https:');
}
const hmac = crypto.createHmac('sha1', camoConfig.getKey());
hmac.update(url);
const digest = hmac.digest('hex');
// https://github.com/atmos/camo#url-formats
if (camoConfig.getEncoding() === 'hex') {
const hexUrl = Buffer.from(url, 'utf8').toString('hex');
return `${camoConfig.getServer()}/${digest}/${hexUrl}`;
} else {
const encoded = encodeURIComponent(url);
return `${camoConfig.getServer()}/${digest}?url=${encoded}`;
}
}
export function transformImgTags(camoConfig, tagName, attribs) {
if (typeof attribs.src === 'string') {
try {
const oldSrc = attribs.src;
attribs.src = camoify(camoConfig, attribs.src);
LOGGER.debug('Camoified "%s" to "%s"', oldSrc, attribs.src);
} catch (error) {
LOGGER.error(`Failed to generate camo URL for "${attribs.src}": ${error}`);
}
}
return { tagName, attribs };
}

View file

@ -1,3 +1,4 @@
import { FileStore } from './filestore';
import { DatabaseStore } from './dbstore'; import { DatabaseStore } from './dbstore';
import Config from '../config'; import Config from '../config';
import Promise from 'bluebird'; import Promise from 'bluebird';
@ -8,29 +9,28 @@ export function init() {
CHANNEL_STORE = loadChannelStore(); CHANNEL_STORE = loadChannelStore();
} }
export function load(id, channelName) { export function load(channelName) {
if (CHANNEL_STORE === null) { if (CHANNEL_STORE === null) {
return Promise.reject(new Error('ChannelStore not initialized yet')); return Promise.reject(new Error('ChannelStore not initialized yet'));
} }
return CHANNEL_STORE.load(id, channelName); return CHANNEL_STORE.load(channelName);
} }
export function save(id, channelName, data) { export function save(channelName, data) {
if (CHANNEL_STORE === null) { if (CHANNEL_STORE === null) {
return Promise.reject(new Error('ChannelStore not initialized yet')); return Promise.reject(new Error('ChannelStore not initialized yet'));
} }
return CHANNEL_STORE.save(id, channelName, data); return CHANNEL_STORE.save(channelName, data);
} }
function loadChannelStore() { function loadChannelStore() {
if (Config.get('channel-storage.type') === 'file') { switch (Config.get('channel-storage.type')) {
throw new Error( case 'database':
'channel-storage type "file" is no longer supported. Please see ' + return new DatabaseStore();
'NEWS.md for instructions on upgrading.' case 'file':
); default:
return new FileStore();
} }
return new DatabaseStore();
} }

View file

@ -3,8 +3,9 @@ import Promise from 'bluebird';
import Config from '../config'; import Config from '../config';
import db from '../database'; import db from '../database';
import { DatabaseStore } from './dbstore'; import { DatabaseStore } from './dbstore';
import { syslog } from '../logger';
syslog.log = () => undefined;
/* eslint no-console: off */
function main() { function main() {
Config.load('config.yaml'); Config.load('config.yaml');
db.init(); db.init();

View file

@ -1,27 +1,12 @@
import Promise from 'bluebird'; import Promise from 'bluebird';
import { ChannelStateSizeError } from '../errors'; import { ChannelStateSizeError,
ChannelNotFoundError } from '../errors';
import db from '../database'; import db from '../database';
import { Counter } from 'prom-client'; import Logger from '../logger';
const LOGGER = require('@calzoneman/jsli')('dbstore');
const SIZE_LIMIT = 1048576; const SIZE_LIMIT = 1048576;
const QUERY_CHANNEL_ID_FOR_NAME = 'SELECT id FROM channels WHERE name = ?';
const QUERY_CHANNEL_DATA = 'SELECT `key`, `value` FROM channel_data WHERE channel_id = ?'; const QUERY_CHANNEL_DATA = 'SELECT `key`, `value` FROM channel_data WHERE channel_id = ?';
const loadRowcount = new Counter({
name: 'cytube_channel_db_load_rows_total',
help: 'Total rows loaded from the channel_data table'
});
const loadCharcount = new Counter({
name: 'cytube_channel_db_load_chars_total',
help: 'Total characters (JSON length) loaded from the channel_data table'
});
const saveRowcount = new Counter({
name: 'cytube_channel_db_save_rows_total',
help: 'Total rows saved in the channel_data table'
});
const saveCharcount = new Counter({
name: 'cytube_channel_db_save_chars_total',
help: 'Total characters (JSON length) saved in the channel_data table'
});
function queryAsync(query, substitutions) { function queryAsync(query, substitutions) {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
@ -49,22 +34,20 @@ function buildUpdateQuery(numEntries) {
} }
export class DatabaseStore { export class DatabaseStore {
load(id, channelName) { load(channelName) {
if (!id || id === 0) { return queryAsync(QUERY_CHANNEL_ID_FOR_NAME, [channelName]).then((rows) => {
return Promise.reject(new Error(`Cannot load state for [${channelName}]: ` + if (rows.length === 0) {
`id was passed as [${id}]`)); throw new ChannelNotFoundError(`Channel does not exist: "${channelName}"`);
} }
return queryAsync(QUERY_CHANNEL_DATA, [id]).then(rows => {
loadRowcount.inc(rows.length);
return queryAsync(QUERY_CHANNEL_DATA, [rows[0].id]);
}).then(rows => {
const data = {}; const data = {};
rows.forEach(row => { rows.forEach(row => {
try { try {
data[row.key] = JSON.parse(row.value); data[row.key] = JSON.parse(row.value);
loadCharcount.inc(row.value.length);
} catch (e) { } catch (e) {
LOGGER.error(`Channel data for channel "${channelName}", ` + Logger.errlog.log(`Channel data for channel "${channelName}", ` +
`key "${row.key}" is invalid: ${e}`); `key "${row.key}" is invalid: ${e}`);
} }
}); });
@ -73,50 +56,36 @@ export class DatabaseStore {
}); });
} }
async save(id, channelName, data) { save(channelName, data) {
if (!id || id === 0) { return queryAsync(QUERY_CHANNEL_ID_FOR_NAME, [channelName]).then((rows) => {
throw new Error( if (rows.length === 0) {
`Cannot save state for [${channelName}]: ` + throw new ChannelNotFoundError(`Channel does not exist: "${channelName}"`);
`id was passed as [${id}]`
);
}
let totalSize = 0;
let rowCount = 0;
const substitutions = [];
for (const key in data) {
if (typeof data[key] === 'undefined') {
continue;
} }
rowCount++; let totalSize = 0;
let rowCount = 0;
const id = rows[0].id;
const substitutions = [];
for (const key in data) {
if (typeof data[key] === 'undefined') {
continue;
}
rowCount++;
const value = JSON.stringify(data[key]);
totalSize += value.length;
substitutions.push(id);
substitutions.push(key);
substitutions.push(value);
}
const value = JSON.stringify(data[key]); if (totalSize > SIZE_LIMIT) {
totalSize += value.length; throw new ChannelStateSizeError('Channel state size is too large', {
substitutions.push(id);
substitutions.push(key);
substitutions.push(value);
}
if (rowCount === 0) {
return;
}
if (totalSize > SIZE_LIMIT) {
throw new ChannelStateSizeError(
'Channel state size is too large',
{
limit: SIZE_LIMIT, limit: SIZE_LIMIT,
actual: totalSize actual: totalSize
} });
); }
}
saveRowcount.inc(rowCount); return queryAsync(buildUpdateQuery(rowCount), substitutions);
saveCharcount.inc(totalSize); });
return await queryAsync(buildUpdateQuery(rowCount), substitutions);
} }
} }

View file

@ -0,0 +1,56 @@
import * as Promise from 'bluebird';
import { stat } from 'fs';
import * as fs from 'graceful-fs';
import path from 'path';
import { ChannelStateSizeError } from '../errors';
const readFileAsync = Promise.promisify(fs.readFile);
const writeFileAsync = Promise.promisify(fs.writeFile);
const readdirAsync = Promise.promisify(fs.readdir);
const statAsync = Promise.promisify(stat);
const SIZE_LIMIT = 1048576;
const CHANDUMP_DIR = path.resolve(__dirname, '..', '..', 'chandump');
export class FileStore {
filenameForChannel(channelName) {
return path.join(CHANDUMP_DIR, channelName);
}
load(channelName) {
const filename = this.filenameForChannel(channelName);
return statAsync(filename).then(stats => {
if (stats.size > SIZE_LIMIT) {
throw new ChannelStateSizeError('Channel state file is too large', {
limit: SIZE_LIMIT,
actual: stats.size
});
} else {
return readFileAsync(filename);
}
}).then(fileContents => {
try {
return JSON.parse(fileContents);
} catch (e) {
throw new Error('Channel state file is not valid JSON: ' + e);
}
});
}
save(channelName, data) {
const filename = this.filenameForChannel(channelName);
const fileContents = new Buffer(JSON.stringify(data), 'utf8');
if (fileContents.length > SIZE_LIMIT) {
return Promise.reject(new ChannelStateSizeError(
'Channel state size is too large', {
limit: SIZE_LIMIT,
actual: fileContents.length
}));
}
return writeFileAsync(filename, fileContents);
}
listChannels() {
return readdirAsync(CHANDUMP_DIR);
}
}

View file

@ -0,0 +1,193 @@
import Config from '../config';
import Promise from 'bluebird';
import db from '../database';
import { FileStore } from './filestore';
import { DatabaseStore } from './dbstore';
import { sanitizeHTML } from '../xss';
import { ChannelNotFoundError } from '../errors';
const QUERY_CHANNEL_NAMES = 'SELECT name FROM channels WHERE 1';
const EXPECTED_KEYS = [
'chatbuffer',
'chatmuted',
'css',
'emotes',
'filters',
'js',
'motd',
'openPlaylist',
'opts',
'permissions',
'playlist',
'poll'
];
function queryAsync(query, substitutions) {
return new Promise((resolve, reject) => {
db.query(query, substitutions, (err, res) => {
if (err) {
if (!(err instanceof Error)) {
err = new Error(err);
}
reject(err);
} else {
resolve(res);
}
});
});
}
function fixOldChandump(data) {
const converted = {};
EXPECTED_KEYS.forEach(key => {
converted[key] = data[key];
});
if (data.queue) {
converted.playlist = {
pl: data.queue.map(item => {
return {
media: {
id: item.id,
title: item.title,
seconds: item.seconds,
duration: item.duration,
type: item.type,
meta: {}
},
queueby: item.queueby,
temp: item.temp
};
}),
pos: data.position,
time: data.currentTime
};
}
if (data.hasOwnProperty('openqueue')) {
converted.openPlaylist = data.openqueue;
}
if (data.hasOwnProperty('playlistLock')) {
converted.openPlaylist = !data.playlistLock;
}
if (data.chatbuffer) {
converted.chatbuffer = data.chatbuffer.map(entry => {
return {
username: entry.username,
msg: entry.msg,
meta: entry.meta || {
addClass: entry.msgclass ? entry.msgclass : undefined
},
time: entry.time
};
});
}
if (data.motd && data.motd.motd) {
converted.motd = sanitizeHTML(data.motd.motd).replace(/\n/g, '<br>\n');
}
if (data.opts && data.opts.customcss) {
converted.opts.externalcss = data.opts.customcss;
}
if (data.opts && data.opts.customjs) {
converted.opts.externaljs = data.opts.customjs;
}
if (data.filters && data.filters.length > 0 && Array.isArray(data.filters[0])) {
converted.filters = data.filters.map(filter => {
let [source, replace, active] = filter;
return {
source: source,
replace: replace,
flags: 'g',
active: active,
filterlinks: false
};
});
}
return converted;
}
function migrate(src, dest, opts) {
return src.listChannels().then(names => {
return Promise.reduce(names, (_, name) => {
// A long time ago there was a bug where CyTube would save a different
// chandump depending on the capitalization of the channel name in the URL.
// This was fixed, but there are still some really old chandumps with
// uppercase letters in the name.
//
// If another chandump exists which is all lowercase, then that one is
// canonical. Otherwise, it's safe to load the existing capitalization,
// convert it, and save.
if (name !== name.toLowerCase()) {
if (names.indexOf(name.toLowerCase()) >= 0) {
return Promise.resolve();
}
}
return src.load(name).then(data => {
data = fixOldChandump(data);
Object.keys(data).forEach(key => {
if (opts.keyWhitelist.length > 0 &&
opts.keyWhitelist.indexOf(key) < 0) {
delete data[key];
} else if (opts.keyBlacklist.length > 0 &&
opts.keyBlacklist.indexOf(key) >= 0) {
delete data[key];
}
});
return dest.save(name, data);
}).then(() => {
console.log(`Migrated /r/${name}`);
}).catch(ChannelNotFoundError, err => {
console.log(`Skipping /r/${name} (not present in the database)`);
}).catch(err => {
console.error(`Failed to migrate /r/${name}: ${err.stack}`);
});
}, 0);
});
}
function loadOpts(argv) {
const opts = {
keyWhitelist: [],
keyBlacklist: []
};
for (let i = 0; i < argv.length; i++) {
if (argv[i] === '-w') {
opts.keyWhitelist = (argv[i+1] || '').split(',');
i++;
} else if (argv[i] === '-b') {
opts.keyBlacklist = (argv[i+1] || '').split(',');
i++;
}
}
return opts;
}
function main() {
Config.load('config.yaml');
db.init();
const src = new FileStore();
const dest = new DatabaseStore();
const opts = loadOpts(process.argv.slice(2));
Promise.delay(1000).then(() => {
return migrate(src, dest, opts);
}).then(() => {
console.log('Migration complete');
process.exit(0);
}).catch(err => {
console.error(`Migration failed: ${err.stack}`);
process.exit(1);
});
}
main();

View file

@ -1,15 +1,18 @@
var Account = require("../account");
var ChannelModule = require("./module"); var ChannelModule = require("./module");
var Flags = require("../flags"); var Flags = require("../flags");
function AccessControlModule(_channel) { function AccessControlModule(channel) {
ChannelModule.apply(this, arguments); ChannelModule.apply(this, arguments);
} }
AccessControlModule.prototype = Object.create(ChannelModule.prototype); AccessControlModule.prototype = Object.create(ChannelModule.prototype);
var pending = 0;
AccessControlModule.prototype.onUserPreJoin = function (user, data, cb) { AccessControlModule.prototype.onUserPreJoin = function (user, data, cb) {
var chan = this.channel, var chan = this.channel,
opts = this.channel.modules.options; opts = this.channel.modules.options;
var self = this;
if (user.socket.disconnected) { if (user.socket.disconnected) {
return cb("User disconnected", ChannelModule.DENY); return cb("User disconnected", ChannelModule.DENY);
} }
@ -27,15 +30,21 @@ AccessControlModule.prototype.onUserPreJoin = function (user, data, cb) {
} else { } else {
user.socket.emit("needPassword", typeof data.pw !== "undefined"); user.socket.emit("needPassword", typeof data.pw !== "undefined");
/* Option 1: log in as a moderator */ /* Option 1: log in as a moderator */
user.waitFlag(Flags.U_HAS_CHANNEL_RANK, function () { user.waitFlag(Flags.U_LOGGED_IN, function () {
if (user.is(Flags.U_IN_CHANNEL)) { user.channel = chan;
return; user.refreshAccount(function (err, account) {
} /* Already joined the channel by some other condition */
if (user.is(Flags.U_IN_CHANNEL)) {
return;
} else if (user.channel === chan) {
user.channel = null;
}
if (user.account.effectiveRank >= 2) { if (account.effectiveRank >= 2) {
cb(null, ChannelModule.PASSTHROUGH); cb(null, ChannelModule.PASSTHROUGH);
user.socket.emit("cancelNeedPassword"); user.socket.emit("cancelNeedPassword");
} }
});
}); });
/* Option 2: Enter correct password */ /* Option 2: Enter correct password */

View file

@ -1,35 +0,0 @@
var ChannelModule = require("./module");
var Flags = require("../flags");
function AnonymousCheck(_channel) {
ChannelModule.apply(this, arguments);
}
AnonymousCheck.prototype = Object.create(ChannelModule.prototype);
AnonymousCheck.prototype.onUserPreJoin = function (user, data, cb) {
const opts = this.channel.modules.options;
var anonymousBanned = opts.get("block_anonymous_users");
if (user.socket.disconnected) {
return cb("User disconnected", ChannelModule.DENY);
}
if(anonymousBanned && user.isAnonymous()) {
user.socket.on("disconnect", function () {
if (!user.is(Flags.U_IN_CHANNEL)) {
cb("User disconnected", ChannelModule.DENY);
}
});
user.socket.emit("errorMsg", { msg : "This channel has blocked anonymous users. Please provide a user name to join."});
user.waitFlag(Flags.U_LOGGED_IN, function () {
cb(null, ChannelModule.PASSTHROUGH);
});
return;
} else{
cb(null, ChannelModule.PASSTHROUGH);
}
};
module.exports = AnonymousCheck;

View file

@ -1,16 +1,17 @@
var Logger = require("../logger");
var ChannelModule = require("./module"); var ChannelModule = require("./module");
var Flags = require("../flags"); var Flags = require("../flags");
var fs = require("fs"); var Account = require("../account");
var util = require("../utilities");
var fs = require("graceful-fs");
var path = require("path"); var path = require("path");
var sio = require("socket.io"); var sio = require("socket.io");
var db = require("../database"); var db = require("../database");
import * as ChannelStore from '../channel-storage/channelstore'; import * as ChannelStore from '../channel-storage/channelstore';
import { ChannelStateSizeError } from '../errors'; import { ChannelStateSizeError } from '../errors';
import Promise from 'bluebird';
import { EventEmitter } from 'events'; import { EventEmitter } from 'events';
import { throttle } from '../util/throttle'; import { throttle } from '../util/throttle';
import Logger from '../logger';
const LOGGER = require('@calzoneman/jsli')('channel');
const USERCOUNT_THROTTLE = 10000; const USERCOUNT_THROTTLE = 10000;
@ -42,10 +43,9 @@ class ReferenceCounter {
delete this.references[caller]; delete this.references[caller];
} }
} else { } else {
LOGGER.error("ReferenceCounter::unref() called by caller [" + Logger.errlog.log("ReferenceCounter::unref() called by caller [" +
caller + "] but this caller had no active references! " + caller + "] but this caller had no active references! " +
`(channel: ${this.channelName})`); `(channel: ${this.channelName})`);
return;
} }
} }
@ -56,15 +56,15 @@ class ReferenceCounter {
checkRefCount() { checkRefCount() {
if (this.refCount === 0) { if (this.refCount === 0) {
if (Object.keys(this.references).length > 0) { if (Object.keys(this.references).length > 0) {
LOGGER.error("ReferenceCounter::refCount reached 0 but still had " + Logger.errlog.log("ReferenceCounter::refCount reached 0 but still had " +
"active references: " + "active references: " +
JSON.stringify(Object.keys(this.references)) + JSON.stringify(Object.keys(this.references)) +
` (channel: ${this.channelName})`); ` (channel: ${this.channelName})`);
for (var caller in this.references) { for (var caller in this.references) {
this.refCount += this.references[caller]; this.refCount += this.references[caller];
} }
} else if (this.channel.users && this.channel.users.length > 0) { } else if (this.channel.users.length > 0) {
LOGGER.error("ReferenceCounter::refCount reached 0 but still had " + Logger.errlog.log("ReferenceCounter::refCount reached 0 but still had " +
this.channel.users.length + " active users" + this.channel.users.length + " active users" +
` (channel: ${this.channelName})`); ` (channel: ${this.channelName})`);
this.refCount = this.channel.users.length; this.refCount = this.channel.users.length;
@ -79,31 +79,25 @@ function Channel(name) {
this.name = name; this.name = name;
this.uniqueName = name.toLowerCase(); this.uniqueName = name.toLowerCase();
this.modules = {}; this.modules = {};
this.logger = new Logger.Logger( this.logger = new Logger.Logger(path.join(__dirname, "..", "..", "chanlogs",
path.join( this.uniqueName + ".log"));
__dirname, "..", "..", "chanlogs", this.uniqueName + ".log"
)
);
this.users = []; this.users = [];
this.refCounter = new ReferenceCounter(this); this.refCounter = new ReferenceCounter(this);
this.flags = 0; this.flags = 0;
this.id = 0;
this.ownerName = null;
this.broadcastUsercount = throttle(() => { this.broadcastUsercount = throttle(() => {
this.broadcastAll("usercount", this.users.length); this.broadcastAll("usercount", this.users.length);
}, USERCOUNT_THROTTLE); }, USERCOUNT_THROTTLE);
const self = this; var self = this;
db.channels.load(this, function (err) { db.channels.load(this, function (err) {
if (err && err.code === 'EBANNED') { if (err && err !== "Channel is not registered") {
self.emit("loadFail", err.message); self.emit("loadFail", "Failed to load channel data from the database");
self.setFlag(Flags.C_ERROR); // Force channel to be unloaded, so that it will load properly when
} else if (err && err !== "Channel is not registered") { // the database connection comes back
self.emit("loadFail", "Failed to load channel data from the database. Please try again later."); self.emit("empty");
self.setFlag(Flags.C_ERROR); return;
} else { } else {
self.initModules(); self.initModules();
self.loadState(); self.loadState();
db.channels.updateLastLoaded(self.id);
} }
}); });
} }
@ -161,8 +155,7 @@ Channel.prototype.initModules = function () {
"./poll" : "poll", "./poll" : "poll",
"./kickban" : "kickban", "./kickban" : "kickban",
"./ranks" : "rank", "./ranks" : "rank",
"./accesscontrol" : "password", "./accesscontrol" : "password"
"./anonymouscheck": "anoncheck"
}; };
var self = this; var self = this;
@ -177,6 +170,23 @@ Channel.prototype.initModules = function () {
self.logger.log("[init] Loaded modules: " + inited.join(", ")); self.logger.log("[init] Loaded modules: " + inited.join(", "));
}; };
Channel.prototype.getDiskSize = function (cb) {
if (this._getDiskSizeTimeout > Date.now()) {
return cb(null, this._cachedDiskSize);
}
var self = this;
var file = path.join(__dirname, "..", "..", "chandump", self.uniqueName);
fs.stat(file, function (err, stats) {
if (err) {
return cb(err);
}
self._cachedDiskSize = stats.size;
cb(null, self._cachedDiskSize);
});
};
Channel.prototype.loadState = function () { Channel.prototype.loadState = function () {
/* Don't load from disk if not registered */ /* Don't load from disk if not registered */
if (!this.is(Flags.C_REGISTERED)) { if (!this.is(Flags.C_REGISTERED)) {
@ -186,19 +196,22 @@ Channel.prototype.loadState = function () {
} }
const self = this; const self = this;
function errorLoad(msg, suggestTryAgain = true) { function errorLoad(msg) {
const extra = suggestTryAgain ? " Please try again later." : ""; if (self.modules.customization) {
self.emit("loadFail", "Failed to load channel data from the database: " + self.modules.customization.load({
msg + extra); motd: msg
self.setFlag(Flags.C_ERROR); });
}
self.setFlag(Flags.C_READY | Flags.C_ERROR);
} }
ChannelStore.load(this.id, this.uniqueName).then(data => { ChannelStore.load(this.uniqueName).then(data => {
Object.keys(this.modules).forEach(m => { Object.keys(this.modules).forEach(m => {
try { try {
this.modules[m].load(data); this.modules[m].load(data);
} catch (e) { } catch (e) {
LOGGER.error("Failed to load module " + m + " for channel " + Logger.errlog.log("Failed to load module " + m + " for channel " +
this.uniqueName); this.uniqueName);
} }
}); });
@ -209,8 +222,8 @@ Channel.prototype.loadState = function () {
"enforced by this server. Please contact an administrator " + "enforced by this server. Please contact an administrator " +
"for assistance."; "for assistance.";
LOGGER.error(err.stack); Logger.errlog.log(err.stack);
errorLoad(message, false); errorLoad(message);
}).catch(err => { }).catch(err => {
if (err.code === 'ENOENT') { if (err.code === 'ENOENT') {
Object.keys(this.modules).forEach(m => { Object.keys(this.modules).forEach(m => {
@ -221,74 +234,50 @@ Channel.prototype.loadState = function () {
} else { } else {
const message = "An error occurred when loading this channel's data from " + const message = "An error occurred when loading this channel's data from " +
"disk. Please contact an administrator for assistance. " + "disk. Please contact an administrator for assistance. " +
`The error was: ${err}.`; `The error was: ${err}`;
LOGGER.error(err.stack); Logger.errlog.log(err.stack);
errorLoad(message); errorLoad(message);
} }
}); });
}; };
Channel.prototype.saveState = async function () { Channel.prototype.saveState = function () {
if (!this.is(Flags.C_REGISTERED)) { if (!this.is(Flags.C_REGISTERED)) {
return; return Promise.resolve();
} else if (!this.is(Flags.C_READY)) { } else if (!this.is(Flags.C_READY)) {
throw new Error( return Promise.reject(new Error(`Attempted to save channel ${this.name} ` +
`Attempted to save channel ${this.name} ` + `but it wasn't finished loading yet!`));
`but it wasn't finished loading yet!`
);
} }
if (this.is(Flags.C_ERROR)) { if (this.is(Flags.C_ERROR)) {
throw new Error(`Channel is in error state`); return Promise.reject(new Error(`Channel is in error state`));
} }
this.logger.log("[init] Saving channel state to disk"); this.logger.log("[init] Saving channel state to disk");
const data = {}; const data = {};
Object.keys(this.modules).forEach(m => { Object.keys(this.modules).forEach(m => {
if ( this.modules[m].save(data);
this.modules[m].dirty ||
!this.modules[m].supportsDirtyCheck
) {
this.modules[m].save(data);
} else {
LOGGER.debug(
"Skipping save for %s[%s]: not dirty",
this.uniqueName,
m
);
}
}); });
try { return ChannelStore.save(this.uniqueName, data).catch(ChannelStateSizeError, err => {
await ChannelStore.save(this.id, this.uniqueName, data); this.users.forEach(u => {
if (u.account.effectiveRank >= 2) {
Object.keys(this.modules).forEach(m => { u.socket.emit("warnLargeChandump", {
this.modules[m].dirty = false; limit: err.limit,
actual: err.actual
});
}
}); });
} catch (error) {
if (error instanceof ChannelStateSizeError) {
this.users.forEach(u => {
if (u.account.effectiveRank >= 2) {
u.socket.emit("warnLargeChandump", {
limit: error.limit,
actual: error.actual
});
}
});
}
throw error; throw err;
} });
}; };
Channel.prototype.checkModules = function (fn, args, cb) { Channel.prototype.checkModules = function (fn, args, cb) {
const self = this; const self = this;
const refCaller = `Channel::checkModules/${fn}`; const refCaller = `Channel::checkModules/${fn}`;
this.waitFlag(Flags.C_READY, function () { this.waitFlag(Flags.C_READY, function () {
if (self.dead) return;
self.refCounter.ref(refCaller); self.refCounter.ref(refCaller);
var keys = Object.keys(self.modules); var keys = Object.keys(self.modules);
var next = function (err, result) { var next = function (err, result) {
@ -307,31 +296,18 @@ Channel.prototype.checkModules = function (fn, args, cb) {
return; return;
} }
if (!self.modules) {
LOGGER.warn(
'checkModules(%s): self.modules is undefined; dead=%s,' +
' current=%s, remaining=%s',
fn,
self.dead,
m,
keys
);
return;
}
var module = self.modules[m]; var module = self.modules[m];
module[fn].apply(module, args); module[fn].apply(module, args);
}; };
args.push(next); args.push(next);
process.nextTick(next, null, ChannelModule.PASSTHROUGH); next(null, ChannelModule.PASSTHROUGH);
}); });
}; };
Channel.prototype.notifyModules = function (fn, args) { Channel.prototype.notifyModules = function (fn, args) {
var self = this; var self = this;
this.waitFlag(Flags.C_READY, function () { this.waitFlag(Flags.C_READY, function () {
if (self.dead) return;
var keys = Object.keys(self.modules); var keys = Object.keys(self.modules);
keys.forEach(function (k) { keys.forEach(function (k) {
self.modules[k][fn].apply(self.modules[k], args); self.modules[k][fn].apply(self.modules[k], args);
@ -344,7 +320,6 @@ Channel.prototype.joinUser = function (user, data) {
self.refCounter.ref("Channel::user"); self.refCounter.ref("Channel::user");
self.waitFlag(Flags.C_READY, function () { self.waitFlag(Flags.C_READY, function () {
/* User closed the connection before the channel finished loading */ /* User closed the connection before the channel finished loading */
if (user.socket.disconnected) { if (user.socket.disconnected) {
self.refCounter.unref("Channel::user"); self.refCounter.unref("Channel::user");
@ -352,49 +327,40 @@ Channel.prototype.joinUser = function (user, data) {
} }
user.channel = self; user.channel = self;
user.waitFlag(Flags.U_LOGGED_IN, () => { if (self.is(Flags.C_REGISTERED)) {
if (self.dead) { user.refreshAccount(function (err, account) {
LOGGER.warn( if (err) {
'Got U_LOGGED_IN for %s after channel already unloaded', Logger.errlog.log("user.refreshAccount failed at Channel.joinUser");
user.getName() Logger.errlog.log(err.stack);
); self.refCounter.unref("Channel::user");
return;
}
afterAccount();
});
} else {
afterAccount();
}
function afterAccount() {
if (user.socket.disconnected) {
self.refCounter.unref("Channel::user");
return;
} else if (self.dead) {
return; return;
} }
if (user.is(Flags.U_REGISTERED)) { self.checkModules("onUserPreJoin", [user, data], function (err, result) {
db.channels.getRank(self.name, user.getName(), (error, rank) => { if (result === ChannelModule.PASSTHROUGH) {
if (!error) { self.acceptUser(user);
user.setChannelRank(rank); } else {
user.setFlag(Flags.U_HAS_CHANNEL_RANK); user.channel = null;
if (user.inChannel()) { user.account.channelRank = 0;
self.broadcastAll("setUserRank", { user.account.effectiveRank = user.account.globalRank;
name: user.getName(), self.refCounter.unref("Channel::user");
rank: user.account.effectiveRank }
}); });
}
}
});
}
});
if (user.socket.disconnected) {
self.refCounter.unref("Channel::user");
return;
} else if (self.dead) {
return;
} }
self.checkModules("onUserPreJoin", [user, data], function (err, result) {
if (result === ChannelModule.PASSTHROUGH) {
user.channel = self;
self.acceptUser(user);
} else {
user.channel = null;
user.account.channelRank = 0;
user.account.effectiveRank = user.account.globalRank;
self.refCounter.unref("Channel::user");
}
});
}); });
}; };
@ -404,8 +370,8 @@ Channel.prototype.acceptUser = function (user) {
user.autoAFK(); user.autoAFK();
user.socket.on("readChanLog", this.handleReadLog.bind(this, user)); user.socket.on("readChanLog", this.handleReadLog.bind(this, user));
LOGGER.info(user.realip + " joined " + this.name); Logger.syslog.log(user.realip + " joined " + this.name);
if (user.socket.context.torConnection) { if (user.socket._isUsingTor) {
if (this.modules.options && this.modules.options.get("torbanned")) { if (this.modules.options && this.modules.options.get("torbanned")) {
user.kick("This channel has banned connections from Tor."); user.kick("This channel has banned connections from Tor.");
this.logger.log("[login] Blocked connection from Tor exit at " + this.logger.log("[login] Blocked connection from Tor exit at " +
@ -432,10 +398,8 @@ Channel.prototype.acceptUser = function (user) {
if (user.account.globalRank === 0) loginStr += " (guest)"; if (user.account.globalRank === 0) loginStr += " (guest)";
loginStr += " (aliases: " + user.account.aliases.join(",") + ")"; loginStr += " (aliases: " + user.account.aliases.join(",") + ")";
self.logger.log(loginStr); self.logger.log(loginStr);
self.sendUserJoin(self.users, user); self.sendUserJoin(self.users, user);
if (user.getName().toLowerCase() === self.ownerName) {
db.channels.updateOwnerLastSeen(self.id);
}
}); });
this.users.push(user); this.users.push(user);
@ -447,31 +411,15 @@ Channel.prototype.acceptUser = function (user) {
}); });
this.sendUserlist([user]); this.sendUserlist([user]);
// Managing this from here is not great, but due to the sequencing involved
// and the limitations of the existing design, it'll have to do.
if (this.modules.playlist.leader !== null) {
user.socket.emit("setLeader", this.modules.playlist.leader.getName());
}
this.broadcastUsercount(); this.broadcastUsercount();
if (!this.is(Flags.C_REGISTERED)) { if (!this.is(Flags.C_REGISTERED)) {
user.socket.emit("channelNotRegistered"); user.socket.emit("channelNotRegistered");
} }
user.on('afk', function(afk){
self.sendUserMeta(self.users, user);
// TODO: Drop legacy setAFK frame after a few months
self.broadcastAll("setAFK", { name: user.getName(), afk: afk });
});
user.on("effectiveRankChange", (newRank, oldRank) => {
this.maybeResendUserlist(user, newRank, oldRank);
});
}; };
Channel.prototype.partUser = function (user) { Channel.prototype.partUser = function (user) {
if (!this.logger) { if (!this.logger) {
LOGGER.error("partUser called on dead channel"); Logger.errlog.log("partUser called on dead channel");
return; return;
} }
@ -500,26 +448,14 @@ Channel.prototype.partUser = function (user) {
user.die(); user.die();
}; };
Channel.prototype.maybeResendUserlist = function maybeResendUserlist(user, newRank, oldRank) {
if ((newRank >= 2 && oldRank < 2)
|| (newRank < 2 && oldRank >= 2)
|| (newRank >= 255 && oldRank < 255)
|| (newRank < 255 && oldRank >= 255)) {
this.sendUserlist([user]);
}
};
Channel.prototype.packUserData = function (user) { Channel.prototype.packUserData = function (user) {
var isBot = Boolean(user.socket.context.user && user.socket.context.user.isBot);
var base = { var base = {
name: user.getName(), name: user.getName(),
rank: user.account.effectiveRank, rank: user.account.effectiveRank,
profile: user.account.profile, profile: user.account.profile,
meta: { meta: {
afk: user.is(Flags.U_AFK), afk: user.is(Flags.U_AFK),
muted: user.is(Flags.U_MUTED) && !user.is(Flags.U_SMUTED), muted: user.is(Flags.U_MUTED) && !user.is(Flags.U_SMUTED)
is_bot: isBot
} }
}; };
@ -532,8 +468,7 @@ Channel.prototype.packUserData = function (user) {
muted: user.is(Flags.U_MUTED), muted: user.is(Flags.U_MUTED),
smuted: user.is(Flags.U_SMUTED), smuted: user.is(Flags.U_SMUTED),
aliases: user.account.aliases, aliases: user.account.aliases,
ip: user.displayip, ip: user.displayip
is_bot: isBot
} }
}; };
@ -546,8 +481,7 @@ Channel.prototype.packUserData = function (user) {
muted: user.is(Flags.U_MUTED), muted: user.is(Flags.U_MUTED),
smuted: user.is(Flags.U_SMUTED), smuted: user.is(Flags.U_SMUTED),
aliases: user.account.aliases, aliases: user.account.aliases,
ip: user.realip, ip: user.realip
is_bot: isBot
} }
}; };
@ -562,7 +496,7 @@ Channel.prototype.sendUserMeta = function (users, user, minrank) {
var self = this; var self = this;
var userdata = self.packUserData(user); var userdata = self.packUserData(user);
users.filter(function (u) { users.filter(function (u) {
return typeof minrank !== "number" || u.account.effectiveRank >= minrank; return typeof minrank !== "number" || u.account.effectiveRank > minrank
}).forEach(function (u) { }).forEach(function (u) {
if (u.account.globalRank >= 255) { if (u.account.globalRank >= 255) {
u.socket.emit("setUserMeta", { u.socket.emit("setUserMeta", {
@ -704,6 +638,7 @@ Channel.prototype.handleReadLog = function (user) {
return; return;
} }
var shouldMaskIP = user.account.globalRank < 255;
this.readLog(function (err, data) { this.readLog(function (err, data) {
if (err) { if (err) {
user.socket.emit("readChanLog", { user.socket.emit("readChanLog", {

View file

@ -1,13 +1,14 @@
var Config = require("../config"); var Config = require("../config");
var User = require("../user");
var XSS = require("../xss"); var XSS = require("../xss");
var ChannelModule = require("./module"); var ChannelModule = require("./module");
var util = require("../utilities"); var util = require("../utilities");
var Flags = require("../flags"); var Flags = require("../flags");
import { transformImgTags } from '../camo'; var url = require("url");
import { Counter } from 'prom-client'; var counters = require("../counters");
const SHADOW_TAG = "[shadow]"; const SHADOW_TAG = "[shadow]";
const LINK = /(\w+:\/\/(?:[^:/[\]\s]+|\[[0-9a-f:]+\])(?::\d+)?(?:\/[^/\s]*)*)/ig; const LINK = /(\w+:\/\/(?:[^:\/\[\]\s]+|\[[0-9a-f:]+\])(?::\d+)?(?:\/[^\/\s]*)*)/ig;
const LINK_PLACEHOLDER = '\ueeee'; const LINK_PLACEHOLDER = '\ueeee';
const LINK_PLACEHOLDER_RE = /\ueeee/g; const LINK_PLACEHOLDER_RE = /\ueeee/g;
@ -28,12 +29,11 @@ const MIN_ANTIFLOOD = {
sustained: 10 sustained: 10
}; };
function ChatModule(_channel) { function ChatModule(channel) {
ChannelModule.apply(this, arguments); ChannelModule.apply(this, arguments);
this.buffer = []; this.buffer = [];
this.muted = new Set(); this.muted = new util.Set();
this.commandHandlers = {}; this.commandHandlers = {};
this.supportsDirtyCheck = true;
/* Default commands */ /* Default commands */
this.registerCommand("/me", this.handleCmdMe.bind(this)); this.registerCommand("/me", this.handleCmdMe.bind(this));
@ -54,7 +54,7 @@ ChatModule.prototype = Object.create(ChannelModule.prototype);
ChatModule.prototype.load = function (data) { ChatModule.prototype.load = function (data) {
this.buffer = []; this.buffer = [];
this.muted = new Set(); this.muted = new util.Set();
if ("chatbuffer" in data) { if ("chatbuffer" in data) {
for (var i = 0; i < data.chatbuffer.length; i++) { for (var i = 0; i < data.chatbuffer.length; i++) {
@ -63,20 +63,18 @@ ChatModule.prototype.load = function (data) {
} }
if ("chatmuted" in data) { if ("chatmuted" in data) {
for (i = 0; i < data.chatmuted.length; i++) { for (var i = 0; i < data.chatmuted.length; i++) {
this.muted.add(data.chatmuted[i]); this.muted.add(data.chatmuted[i]);
} }
} }
this.dirty = false;
}; };
ChatModule.prototype.save = function (data) { ChatModule.prototype.save = function (data) {
data.chatbuffer = this.buffer; data.chatbuffer = this.buffer;
data.chatmuted = Array.from(this.muted); data.chatmuted = Array.prototype.slice.call(this.muted);
}; };
ChatModule.prototype.packInfo = function (data, _isAdmin) { ChatModule.prototype.packInfo = function (data, isAdmin) {
data.chat = Array.prototype.slice.call(this.buffer); data.chat = Array.prototype.slice.call(this.buffer);
}; };
@ -101,8 +99,8 @@ ChatModule.prototype.onUserPostJoin = function (user) {
}; };
ChatModule.prototype.isMuted = function (name) { ChatModule.prototype.isMuted = function (name) {
return this.muted.has(name.toLowerCase()) || return this.muted.contains(name.toLowerCase()) ||
this.muted.has(SHADOW_TAG + name.toLowerCase()); this.muted.contains(SHADOW_TAG + name.toLowerCase());
}; };
ChatModule.prototype.mutedUsers = function () { ChatModule.prototype.mutedUsers = function () {
@ -113,7 +111,7 @@ ChatModule.prototype.mutedUsers = function () {
}; };
ChatModule.prototype.isShadowMuted = function (name) { ChatModule.prototype.isShadowMuted = function (name) {
return this.muted.has(SHADOW_TAG + name.toLowerCase()); return this.muted.contains(SHADOW_TAG + name.toLowerCase());
}; };
ChatModule.prototype.shadowMutedUsers = function () { ChatModule.prototype.shadowMutedUsers = function () {
@ -123,13 +121,17 @@ ChatModule.prototype.shadowMutedUsers = function () {
}); });
}; };
ChatModule.prototype.anonymousUsers = function () { const SERVER_START_DATE = Date.now();
return this.channel.users.filter(function (u) {
return u.getName() === "";
});
};
ChatModule.prototype.restrictNewAccount = function restrictNewAccount(user, data) { ChatModule.prototype.restrictNewAccount = function restrictNewAccount(user, data) {
// TODO: this is temporary to prevent hundreds of guests from getting
// blocked immediately after this feature is rolled out.
//
// Will be removed later.
if (SERVER_START_DATE + this.channel.modules.options.get("new_user_chat_delay")*1000
>= Date.now()) {
return false;
}
if (user.account.effectiveRank < 2 && this.channel.modules.options) { if (user.account.effectiveRank < 2 && this.channel.modules.options) {
const firstSeen = user.getFirstSeenTime(); const firstSeen = user.getFirstSeenTime();
const opts = this.channel.modules.options; const opts = this.channel.modules.options;
@ -150,19 +152,16 @@ ChatModule.prototype.restrictNewAccount = function restrictNewAccount(user, data
return false; return false;
}; };
const chatIncomingCount = new Counter({
name: 'cytube_chat_incoming_total',
help: 'Number of incoming chatMsg frames'
});
ChatModule.prototype.handleChatMsg = function (user, data) { ChatModule.prototype.handleChatMsg = function (user, data) {
var self = this; var self = this;
chatIncomingCount.inc(1, new Date()); counters.add("chat:incoming");
if (!this.channel || !this.channel.modules.permissions.canChat(user)) { if (!this.channel || !this.channel.modules.permissions.canChat(user)) {
return; return;
} }
data.msg = data.msg.substring(0, Config.get("max-chat-message-length")); // Limit to 240 characters
data.msg = data.msg.substring(0, 240);
// Restrict new accounts/IPs from chatting and posting links // Restrict new accounts/IPs from chatting and posting links
if (this.restrictNewAccount(user, data)) { if (this.restrictNewAccount(user, data)) {
@ -226,6 +225,7 @@ ChatModule.prototype.handlePm = function (user, data) {
return; return;
} }
var reallyTo = data.to;
data.to = data.to.toLowerCase(); data.to = data.to.toLowerCase();
if (data.to === user.getLowerName()) { if (data.to === user.getLowerName()) {
@ -248,7 +248,7 @@ ChatModule.prototype.handlePm = function (user, data) {
} }
data.msg = data.msg.substring(0, Config.get("max-chat-message-length")); data.msg = data.msg.substring(0, 240);
var to = null; var to = null;
for (var i = 0; i < this.channel.users.length; i++) { for (var i = 0; i < this.channel.users.length; i++) {
if (this.channel.users[i].getLowerName() === data.to) { if (this.channel.users[i].getLowerName() === data.to) {
@ -284,10 +284,6 @@ ChatModule.prototype.handlePm = function (user, data) {
user.socket.emit("pm", msgobj); user.socket.emit("pm", msgobj);
}; };
const chatSentCount = new Counter({
name: 'cytube_chat_sent_total',
help: 'Number of broadcast chat messages'
});
ChatModule.prototype.processChatMsg = function (user, data) { ChatModule.prototype.processChatMsg = function (user, data) {
if (data.msg.match(Config.get("link-domain-blacklist-regex"))) { if (data.msg.match(Config.get("link-domain-blacklist-regex"))) {
this.channel.logger.log(user.displayip + " (" + user.getName() + ") was kicked for " + this.channel.logger.log(user.displayip + " (" + user.getName() + ") was kicked for " +
@ -303,9 +299,6 @@ ChatModule.prototype.processChatMsg = function (user, data) {
} }
var msgobj = this.formatMessage(user.getName(), data); var msgobj = this.formatMessage(user.getName(), data);
if (user.socket.context.user && user.socket.context.user.isBot) {
msgobj.meta.is_bot = true;
}
var antiflood = MIN_ANTIFLOOD; var antiflood = MIN_ANTIFLOOD;
if (this.channel.modules.options && if (this.channel.modules.options &&
this.channel.modules.options.get("chat_antiflood") && this.channel.modules.options.get("chat_antiflood") &&
@ -342,10 +335,6 @@ ChatModule.prototype.processChatMsg = function (user, data) {
this.shadowMutedUsers().forEach(function (u) { this.shadowMutedUsers().forEach(function (u) {
u.socket.emit("chatMsg", msgobj); u.socket.emit("chatMsg", msgobj);
}); });
// This prevents shadowmuted users from easily detecting their state
this.anonymousUsers().forEach(function (u) {
u.socket.emit("chatMsg", msgobj);
});
msgobj.meta.shadow = true; msgobj.meta.shadow = true;
this.channel.moderators().forEach(function (u) { this.channel.moderators().forEach(function (u) {
u.socket.emit("chatMsg", msgobj); u.socket.emit("chatMsg", msgobj);
@ -359,7 +348,7 @@ ChatModule.prototype.processChatMsg = function (user, data) {
return; return;
} }
this.sendMessage(msgobj); this.sendMessage(msgobj);
chatSentCount.inc(1, new Date()); counters.add("chat:sent");
}; };
ChatModule.prototype.formatMessage = function (username, data) { ChatModule.prototype.formatMessage = function (username, data) {
@ -379,6 +368,7 @@ ChatModule.prototype.formatMessage = function (username, data) {
ChatModule.prototype.filterMessage = function (msg) { ChatModule.prototype.filterMessage = function (msg) {
var filters = this.channel.modules.filters.filters; var filters = this.channel.modules.filters.filters;
var chan = this.channel;
var convertLinks = this.channel.modules.options.get("enable_link_regex"); var convertLinks = this.channel.modules.options.get("enable_link_regex");
var links = msg.match(LINK); var links = msg.match(LINK);
var intermediate = msg.replace(LINK, LINK_PLACEHOLDER); var intermediate = msg.replace(LINK, LINK_PLACEHOLDER);
@ -401,17 +391,7 @@ ChatModule.prototype.filterMessage = function (msg) {
} }
}); });
let settings = {}; return XSS.sanitizeHTML(result);
const camoConfig = Config.getCamoConfig();
if (camoConfig.isEnabled()) {
settings = {
transformTags: {
img: transformImgTags.bind(null, camoConfig)
}
};
}
return XSS.sanitizeHTML(result, settings);
}; };
ChatModule.prototype.sendModMessage = function (msg, minrank) { ChatModule.prototype.sendModMessage = function (msg, minrank) {
@ -439,17 +419,14 @@ ChatModule.prototype.sendModMessage = function (msg, minrank) {
ChatModule.prototype.sendMessage = function (msgobj) { ChatModule.prototype.sendMessage = function (msgobj) {
this.channel.broadcastAll("chatMsg", msgobj); this.channel.broadcastAll("chatMsg", msgobj);
this.dirty = true;
this.buffer.push(msgobj); this.buffer.push(msgobj);
if (this.buffer.length > 15) { if (this.buffer.length > 15) {
this.buffer.shift(); this.buffer.shift();
} }
this.channel.logger.log( this.channel.logger.log("<" + msgobj.username + (msgobj.meta.addClass ?
"<" + msgobj.username + "." + msgobj.meta.addClass : "") +
(msgobj.meta.addClass ? "." + msgobj.meta.addClass : "") + "> " + XSS.decodeText(msgobj.msg));
"> " + XSS.decodeText(msgobj.msg)
);
}; };
ChatModule.prototype.registerCommand = function (cmd, cb) { ChatModule.prototype.registerCommand = function (cmd, cb) {
@ -488,15 +465,13 @@ ChatModule.prototype.handleCmdSay = function (user, msg, meta) {
this.processChatMsg(user, { msg: args.join(" "), meta: meta }); this.processChatMsg(user, { msg: args.join(" "), meta: meta });
}; };
ChatModule.prototype.handleCmdClear = function (user, _msg, _meta) { ChatModule.prototype.handleCmdClear = function (user, msg, meta) {
if (!this.channel.modules.permissions.canClearChat(user)) { if (!this.channel.modules.permissions.canClearChat(user)) {
return; return;
} }
this.dirty = true;
this.buffer = []; this.buffer = [];
this.channel.broadcastAll("clearchat", { clearedBy: user.getName() }); this.channel.broadcastAll("clearchat");
this.sendModMessage(user.getName() + " cleared chat.", -1);
this.channel.logger.log("[mod] " + user.getName() + " used /clear"); this.channel.logger.log("[mod] " + user.getName() + " used /clear");
}; };
@ -529,11 +504,11 @@ ChatModule.prototype.handleCmdAdminflair = function (user, msg, meta) {
this.processChatMsg(user, { msg: cargs.join(" "), meta: meta }); this.processChatMsg(user, { msg: cargs.join(" "), meta: meta });
}; };
ChatModule.prototype.handleCmdAfk = function (user, _msg, _meta) { ChatModule.prototype.handleCmdAfk = function (user, msg, meta) {
user.setAFK(!user.is(Flags.U_AFK)); user.setAFK(!user.is(Flags.U_AFK));
}; };
ChatModule.prototype.handleCmdMute = function (user, msg, _meta) { ChatModule.prototype.handleCmdMute = function (user, msg, meta) {
if (!this.channel.modules.permissions.canMute(user)) { if (!this.channel.modules.permissions.canMute(user)) {
return; return;
} }
@ -583,7 +558,7 @@ ChatModule.prototype.handleCmdMute = function (user, msg, _meta) {
this.sendModMessage(user.getName() + " muted " + target.getName(), muteperm); this.sendModMessage(user.getName() + " muted " + target.getName(), muteperm);
}; };
ChatModule.prototype.handleCmdSMute = function (user, msg, _meta) { ChatModule.prototype.handleCmdSMute = function (user, msg, meta) {
if (!this.channel.modules.permissions.canMute(user)) { if (!this.channel.modules.permissions.canMute(user)) {
return; return;
} }
@ -634,7 +609,7 @@ ChatModule.prototype.handleCmdSMute = function (user, msg, _meta) {
this.sendModMessage(user.getName() + " shadowmuted " + target.getName(), muteperm); this.sendModMessage(user.getName() + " shadowmuted " + target.getName(), muteperm);
}; };
ChatModule.prototype.handleCmdUnmute = function (user, msg, _meta) { ChatModule.prototype.handleCmdUnmute = function (user, msg, meta) {
if (!this.channel.modules.permissions.canMute(user)) { if (!this.channel.modules.permissions.canMute(user)) {
return; return;
} }
@ -666,11 +641,8 @@ ChatModule.prototype.handleCmdUnmute = function (user, msg, _meta) {
return; return;
} }
this.muted.delete(name); this.muted.remove(name);
this.muted.delete(SHADOW_TAG + name); this.muted.remove(SHADOW_TAG + name);
this.channel.logger.log("[mod] " + user.getName() + " unmuted " + name);
this.sendModMessage(user.getName() + " unmuted " + name, muteperm);
var target; var target;
for (var i = 0; i < this.channel.users.length; i++) { for (var i = 0; i < this.channel.users.length; i++) {
@ -686,6 +658,8 @@ ChatModule.prototype.handleCmdUnmute = function (user, msg, _meta) {
target.clearFlag(Flags.U_MUTED | Flags.U_SMUTED); target.clearFlag(Flags.U_MUTED | Flags.U_SMUTED);
this.channel.sendUserMeta(this.channel.users, target, -1); this.channel.sendUserMeta(this.channel.users, target, -1);
this.channel.logger.log("[mod] " + user.getName() + " unmuted " + target.getName());
this.sendModMessage(user.getName() + " unmuted " + target.getName(), muteperm);
}; };
module.exports = ChatModule; module.exports = ChatModule;

View file

@ -1,6 +1,5 @@
const ChannelModule = require("./module"); var ChannelModule = require("./module");
const XSS = require("../xss"); var XSS = require("../xss");
const { hash } = require('../util/hash');
const TYPE_SETCSS = { const TYPE_SETCSS = {
css: "string" css: "string"
@ -14,38 +13,15 @@ const TYPE_SETMOTD = {
motd: "string" motd: "string"
}; };
function CustomizationModule(_channel) { function CustomizationModule(channel) {
ChannelModule.apply(this, arguments); ChannelModule.apply(this, arguments);
this.css = ""; this.css = "";
this.js = ""; this.js = "";
this.motd = ""; this.motd = "";
this.supportsDirtyCheck = true;
} }
CustomizationModule.prototype = Object.create(ChannelModule.prototype); CustomizationModule.prototype = Object.create(ChannelModule.prototype);
Object.defineProperty(CustomizationModule.prototype, 'css', {
get() {
return this._css;
},
set(val) {
this._css = val;
this.cssHash = hash('md5', val, 'base64');
}
});
Object.defineProperty(CustomizationModule.prototype, 'js', {
get() {
return this._js;
},
set(val) {
this._js = val;
this.jsHash = hash('md5', val, 'base64');
}
});
CustomizationModule.prototype.load = function (data) { CustomizationModule.prototype.load = function (data) {
if ("css" in data) { if ("css" in data) {
this.css = data.css; this.css = data.css;
@ -66,8 +42,6 @@ CustomizationModule.prototype.load = function (data) {
this.motd = XSS.sanitizeHTML(data.motd); this.motd = XSS.sanitizeHTML(data.motd);
} }
} }
this.dirty = false;
}; };
CustomizationModule.prototype.save = function (data) { CustomizationModule.prototype.save = function (data) {
@ -92,9 +66,7 @@ CustomizationModule.prototype.onUserPostJoin = function (user) {
CustomizationModule.prototype.sendCSSJS = function (users) { CustomizationModule.prototype.sendCSSJS = function (users) {
var data = { var data = {
css: this.css, css: this.css,
cssHash: this.cssHash, js: this.js
js: this.js,
jsHash: this.jsHash
}; };
users.forEach(function (u) { users.forEach(function (u) {
u.socket.emit("channelCSSJS", data); u.socket.emit("channelCSSJS", data);
@ -114,15 +86,10 @@ CustomizationModule.prototype.handleSetCSS = function (user, data) {
return; return;
} }
let oldHash = this.cssHash;
// TODO: consider sending back an error instead of silently truncating
this.css = data.css.substring(0, 20000); this.css = data.css.substring(0, 20000);
this.sendCSSJS(this.channel.users);
if (oldHash !== this.cssHash) { this.channel.logger.log("[mod] " + user.getName() + " updated the channel CSS");
this.dirty = true;
this.sendCSSJS(this.channel.users);
this.channel.logger.log("[mod] " + user.getName() + " updated the channel CSS");
}
}; };
CustomizationModule.prototype.handleSetJS = function (user, data) { CustomizationModule.prototype.handleSetJS = function (user, data) {
@ -131,14 +98,10 @@ CustomizationModule.prototype.handleSetJS = function (user, data) {
return; return;
} }
let oldHash = this.jsHash;
this.js = data.js.substring(0, 20000); this.js = data.js.substring(0, 20000);
this.sendCSSJS(this.channel.users);
if (oldHash !== this.jsHash) { this.channel.logger.log("[mod] " + user.getName() + " updated the channel JS");
this.dirty = true;
this.sendCSSJS(this.channel.users);
this.channel.logger.log("[mod] " + user.getName() + " updated the channel JS");
}
}; };
CustomizationModule.prototype.handleSetMotd = function (user, data) { CustomizationModule.prototype.handleSetMotd = function (user, data) {
@ -149,7 +112,6 @@ CustomizationModule.prototype.handleSetMotd = function (user, data) {
var motd = data.motd.substring(0, 20000); var motd = data.motd.substring(0, 20000);
this.dirty = true;
this.setMotd(motd); this.setMotd(motd);
this.channel.logger.log("[mod] " + user.getName() + " updated the MOTD"); this.channel.logger.log("[mod] " + user.getName() + " updated the MOTD");
}; };

View file

@ -1,10 +1,6 @@
// TODO: figure out what to do with this module
// it serves a very niche use case and is only a core module because of
// legacy reasons (early channels requested it before I had criteria
// around what to include in core)
var ChannelModule = require("./module"); var ChannelModule = require("./module");
function DrinkModule(_channel) { function DrinkModule(channel) {
ChannelModule.apply(this, arguments); ChannelModule.apply(this, arguments);
this.drinks = 0; this.drinks = 0;
} }

View file

@ -20,33 +20,6 @@ EmoteList.prototype = {
this.emotes = Array.prototype.slice.call(emotes); this.emotes = Array.prototype.slice.call(emotes);
}, },
emoteExists: function (emote){
for (let i = 0; i < this.emotes.length; i++) {
if (this.emotes[i].name === emote.name) {
return true;
}
}
return false;
},
renameEmote: function (emote) {
var found = false;
for (var i = 0; i < this.emotes.length; i++) {
if (this.emotes[i].name === emote.old) {
found = true;
this.emotes[i] = emote;
delete this.emotes[i].old;
break;
}
}
if(found){
return true;
}
return false;
},
updateEmote: function (emote) { updateEmote: function (emote) {
var found = false; var found = false;
for (var i = 0; i < this.emotes.length; i++) { for (var i = 0; i < this.emotes.length; i++) {
@ -64,6 +37,7 @@ EmoteList.prototype = {
}, },
removeEmote: function (emote) { removeEmote: function (emote) {
var found = false;
for (var i = 0; i < this.emotes.length; i++) { for (var i = 0; i < this.emotes.length; i++) {
if (this.emotes[i].name === emote.name) { if (this.emotes[i].name === emote.name) {
this.emotes.splice(i, 1); this.emotes.splice(i, 1);
@ -101,7 +75,7 @@ function validateEmote(f) {
f.image = f.image.substring(0, 1000); f.image = f.image.substring(0, 1000);
f.image = XSS.sanitizeText(f.image); f.image = XSS.sanitizeText(f.image);
var s = XSS.looseSanitizeText(f.name).replace(/([\\.?+*$^|()[\]{}])/g, "\\$1"); var s = XSS.sanitizeText(f.name).replace(/([\\\.\?\+\*\$\^\|\(\)\[\]\{\}])/g, "\\$1");
s = "(^|\\s)" + s + "(?!\\S)"; s = "(^|\\s)" + s + "(?!\\S)";
f.source = s; f.source = s;
@ -116,22 +90,21 @@ function validateEmote(f) {
} }
return f; return f;
} };
function EmoteModule(_channel) { function EmoteModule(channel) {
ChannelModule.apply(this, arguments); ChannelModule.apply(this, arguments);
this.emotes = new EmoteList(); this.emotes = new EmoteList();
this.supportsDirtyCheck = true;
} }
EmoteModule.prototype = Object.create(ChannelModule.prototype); EmoteModule.prototype = Object.create(ChannelModule.prototype);
EmoteModule.prototype.load = function (data) { EmoteModule.prototype.load = function (data) {
if ("emotes" in data) { if ("emotes" in data) {
this.emotes = new EmoteList(data.emotes); for (var i = 0; i < data.emotes.length; i++) {
this.emotes.updateEmote(data.emotes[i]);
}
} }
this.dirty = false;
}; };
EmoteModule.prototype.save = function (data) { EmoteModule.prototype.save = function (data) {
@ -145,7 +118,6 @@ EmoteModule.prototype.packInfo = function (data, isAdmin) {
}; };
EmoteModule.prototype.onUserPostJoin = function (user) { EmoteModule.prototype.onUserPostJoin = function (user) {
user.socket.on("renameEmote", this.handleRenameEmote.bind(this, user));
user.socket.on("updateEmote", this.handleUpdateEmote.bind(this, user)); user.socket.on("updateEmote", this.handleUpdateEmote.bind(this, user));
user.socket.on("importEmotes", this.handleImportEmotes.bind(this, user)); user.socket.on("importEmotes", this.handleImportEmotes.bind(this, user));
user.socket.on("moveEmote", this.handleMoveEmote.bind(this, user)); user.socket.on("moveEmote", this.handleMoveEmote.bind(this, user));
@ -155,58 +127,12 @@ EmoteModule.prototype.onUserPostJoin = function (user) {
EmoteModule.prototype.sendEmotes = function (users) { EmoteModule.prototype.sendEmotes = function (users) {
var f = this.emotes.pack(); var f = this.emotes.pack();
var chan = this.channel;
users.forEach(function (u) { users.forEach(function (u) {
u.socket.emit("emoteList", f); u.socket.emit("emoteList", f);
}); });
}; };
EmoteModule.prototype.handleRenameEmote = function (user, data) {
if (typeof data !== "object") {
return;
}
/*
** This shouldn't be able to happen,
** but we have idiots that like to send handcrafted frames to fuck with shit
*/
if (typeof data.old !== "string"){
return;
}
if (!this.channel.modules.permissions.canEditEmotes(user)) {
return;
}
var e = this.emotes.emoteExists(data);
var f = validateEmote(data);
if (!f || e) {
var message = "Unable to rename emote '" + JSON.stringify(data) + "'. " +
"Please contact an administrator for assistance.";
if (!data.image || !data.name) {
message = "Emote names and images must not be blank.";
}
if (e) {
message = "Emote already exists.";
}
user.socket.emit("errorMsg", {
msg: message,
alert: true
});
return;
}
// See comment above
var success = this.emotes.renameEmote(Object.assign({}, f));
if(!success){ return; }
this.dirty = true;
var chan = this.channel;
chan.broadcastAll("renameEmote", f);
chan.logger.log(`[mod] ${user.getName()} renamed emote: ${f.old} -> ${f.name}`);
};
EmoteModule.prototype.handleUpdateEmote = function (user, data) { EmoteModule.prototype.handleUpdateEmote = function (user, data) {
if (typeof data !== "object") { if (typeof data !== "object") {
return; return;
@ -232,9 +158,6 @@ EmoteModule.prototype.handleUpdateEmote = function (user, data) {
} }
this.emotes.updateEmote(f); this.emotes.updateEmote(f);
this.dirty = true;
var chan = this.channel; var chan = this.channel;
chan.broadcastAll("updateEmote", f); chan.broadcastAll("updateEmote", f);
@ -256,9 +179,6 @@ EmoteModule.prototype.handleImportEmotes = function (user, data) {
this.emotes.importList(data.map(validateEmote).filter(function (f) { this.emotes.importList(data.map(validateEmote).filter(function (f) {
return f !== false; return f !== false;
})); }));
this.dirty = true;
this.sendEmotes(this.channel.users); this.sendEmotes(this.channel.users);
}; };
@ -276,9 +196,6 @@ EmoteModule.prototype.handleRemoveEmote = function (user, data) {
} }
this.emotes.removeEmote(data); this.emotes.removeEmote(data);
this.dirty = true;
this.channel.logger.log("[mod] " + user.getName() + " removed emote: " + data.name); this.channel.logger.log("[mod] " + user.getName() + " removed emote: " + data.name);
this.channel.broadcastAll("removeEmote", data); this.channel.broadcastAll("removeEmote", data);
}; };
@ -297,8 +214,6 @@ EmoteModule.prototype.handleMoveEmote = function (user, data) {
} }
this.emotes.moveEmote(data.from, data.to); this.emotes.moveEmote(data.from, data.to);
this.dirty = true;
}; };
module.exports = EmoteModule; module.exports = EmoteModule;

View file

@ -1,7 +1,7 @@
var FilterList = require("cytubefilters"); var FilterList = require("cytubefilters");
var ChannelModule = require("./module"); var ChannelModule = require("./module");
var XSS = require("../xss");
const LOGGER = require('@calzoneman/jsli')('filters'); var Logger = require("../logger");
/* /*
* Converts JavaScript-style replacements ($1, $2, etc.) with * Converts JavaScript-style replacements ($1, $2, etc.) with
@ -22,6 +22,7 @@ function validateFilter(f) {
} }
f.replace = fixReplace(f.replace.substring(0, 1000)); f.replace = fixReplace(f.replace.substring(0, 1000));
f.replace = XSS.sanitizeHTML(f.replace);
f.flags = f.flags.substring(0, 4); f.flags = f.flags.substring(0, 4);
try { try {
@ -62,10 +63,9 @@ const DEFAULT_FILTERS = [
"<span class=\"spoiler\">\\1</span>") "<span class=\"spoiler\">\\1</span>")
]; ];
function ChatFilterModule(_channel) { function ChatFilterModule(channel) {
ChannelModule.apply(this, arguments); ChannelModule.apply(this, arguments);
this.filters = new FilterList(); this.filters = new FilterList();
this.supportsDirtyCheck = true;
} }
ChatFilterModule.prototype = Object.create(ChannelModule.prototype); ChatFilterModule.prototype = Object.create(ChannelModule.prototype);
@ -78,15 +78,13 @@ ChatFilterModule.prototype.load = function (data) {
try { try {
this.filters = new FilterList(filters); this.filters = new FilterList(filters);
} catch (e) { } catch (e) {
LOGGER.error("Filter load failed: " + e + " (channel:" + Logger.errlog.log("Filter load failed: " + e + " (channel:" +
this.channel.name); this.channel.name);
this.channel.logger.log("Failed to load filters: " + e); this.channel.logger.log("Failed to load filters: " + e);
} }
} else { } else {
this.filters = new FilterList(DEFAULT_FILTERS); this.filters = new FilterList(DEFAULT_FILTERS);
} }
this.dirty = false;
}; };
ChatFilterModule.prototype.save = function (data) { ChatFilterModule.prototype.save = function (data) {
@ -152,8 +150,6 @@ ChatFilterModule.prototype.handleAddFilter = function (user, data) {
return; return;
} }
this.dirty = true;
user.socket.emit("addFilterSuccess"); user.socket.emit("addFilterSuccess");
var chan = this.channel; var chan = this.channel;
@ -202,8 +198,6 @@ ChatFilterModule.prototype.handleUpdateFilter = function (user, data) {
return; return;
} }
this.dirty = true;
var chan = this.channel; var chan = this.channel;
chan.users.forEach(function (u) { chan.users.forEach(function (u) {
if (chan.modules.permissions.canEditFilters(u)) { if (chan.modules.permissions.canEditFilters(u)) {
@ -239,8 +233,6 @@ ChatFilterModule.prototype.handleImportFilters = function (user, data) {
return; return;
} }
this.dirty = true;
this.channel.logger.log("[mod] " + user.getName() + " imported the filter list"); this.channel.logger.log("[mod] " + user.getName() + " imported the filter list");
this.sendChatFilters(this.channel.users); this.sendChatFilters(this.channel.users);
}; };
@ -267,9 +259,6 @@ ChatFilterModule.prototype.handleRemoveFilter = function (user, data) {
}); });
return; return;
} }
this.dirty = true;
var chan = this.channel; var chan = this.channel;
chan.users.forEach(function (u) { chan.users.forEach(function (u) {
if (chan.modules.permissions.canEditFilters(u)) { if (chan.modules.permissions.canEditFilters(u)) {
@ -302,8 +291,6 @@ ChatFilterModule.prototype.handleMoveFilter = function (user, data) {
}); });
return; return;
} }
this.dirty = true;
}; };
ChatFilterModule.prototype.handleRequestChatFilters = function (user) { ChatFilterModule.prototype.handleRequestChatFilters = function (user) {

View file

@ -3,20 +3,14 @@ var db = require("../database");
var Flags = require("../flags"); var Flags = require("../flags");
var util = require("../utilities"); var util = require("../utilities");
var Account = require("../account"); var Account = require("../account");
import Promise from 'bluebird'; var Q = require("q");
const XSS = require("../xss");
const dbIsNameBanned = Promise.promisify(db.channels.isNameBanned);
const dbIsIPBanned = Promise.promisify(db.channels.isIPBanned);
const dbAddBan = Promise.promisify(db.channels.ban);
const dbGetIPs = Promise.promisify(db.getIPs);
const TYPE_UNBAN = { const TYPE_UNBAN = {
id: "number", id: "number",
name: "string" name: "string"
}; };
function KickBanModule(_channel) { function KickBanModule(channel) {
ChannelModule.apply(this, arguments); ChannelModule.apply(this, arguments);
if (this.channel.modules.chat) { if (this.channel.modules.chat) {
@ -40,8 +34,8 @@ function checkIPBan(cname, ip, cb) {
}); });
} }
function checkBan(cname, ip, name, cb) { function checkNameBan(cname, name, cb) {
db.channels.isBanned(cname, ip, name, function (err, banned) { db.channels.isNameBanned(cname, name, function (err, banned) {
if (err) { if (err) {
cb(false); cb(false);
} else { } else {
@ -55,21 +49,23 @@ KickBanModule.prototype.onUserPreJoin = function (user, data, cb) {
return cb(null, ChannelModule.PASSTHROUGH); return cb(null, ChannelModule.PASSTHROUGH);
} }
const cname = this.channel.name; var cname = this.channel.name;
function callback(banned) { checkIPBan(cname, user.realip, function (banned) {
if (banned) { if (banned) {
cb(null, ChannelModule.DENY); cb(null, ChannelModule.DENY);
user.kick("You are banned from this channel."); user.kick("Your IP address is banned from this channel.");
} else { } else {
cb(null, ChannelModule.PASSTHROUGH); checkNameBan(cname, user.getName(), function (banned) {
if (banned) {
cb(null, ChannelModule.DENY);
user.kick("Your username is banned from this channel.");
} else {
cb(null, ChannelModule.PASSTHROUGH);
}
});
} }
} });
if (user.getName() !== '') {
checkBan(cname, user.realip, user.getName(), callback);
} else {
checkIPBan(cname, user.realip, callback);
}
}; };
KickBanModule.prototype.onUserPostJoin = function (user) { KickBanModule.prototype.onUserPostJoin = function (user) {
@ -152,7 +148,7 @@ KickBanModule.prototype.sendUnban = function (users, data) {
}); });
}; };
KickBanModule.prototype.handleCmdKick = function (user, msg, _meta) { KickBanModule.prototype.handleCmdKick = function (user, msg, meta) {
if (!this.channel.modules.permissions.canKick(user)) { if (!this.channel.modules.permissions.canKick(user)) {
return; return;
} }
@ -196,7 +192,7 @@ KickBanModule.prototype.handleCmdKick = function (user, msg, _meta) {
} }
}; };
KickBanModule.prototype.handleCmdKickAnons = function (user, _msg, _meta) { KickBanModule.prototype.handleCmdKickAnons = function (user, msg, meta) {
if (!this.channel.modules.permissions.canKick(user)) { if (!this.channel.modules.permissions.canKick(user)) {
return; return;
} }
@ -216,7 +212,7 @@ KickBanModule.prototype.handleCmdKickAnons = function (user, _msg, _meta) {
}; };
/* /ban - name bans */ /* /ban - name bans */
KickBanModule.prototype.handleCmdBan = function (user, msg, _meta) { KickBanModule.prototype.handleCmdBan = function (user, msg, meta) {
var args = msg.split(" "); var args = msg.split(" ");
args.shift(); /* shift off /ban */ args.shift(); /* shift off /ban */
if (args.length === 0 || args[0].trim() === "") { if (args.length === 0 || args[0].trim() === "") {
@ -229,17 +225,13 @@ KickBanModule.prototype.handleCmdBan = function (user, msg, _meta) {
const chan = this.channel; const chan = this.channel;
chan.refCounter.ref("KickBanModule::handleCmdBan"); chan.refCounter.ref("KickBanModule::handleCmdBan");
this.banName(user, name, reason, function (err) {
this.banName(user, name, reason).catch(error => {
const message = error.message || error;
user.socket.emit("errorMsg", { msg: message });
}).then(() => {
chan.refCounter.unref("KickBanModule::handleCmdBan"); chan.refCounter.unref("KickBanModule::handleCmdBan");
}); });
}; };
/* /ipban - bans name and IP addresses associated with it */ /* /ipban - bans name and IP addresses associated with it */
KickBanModule.prototype.handleCmdIPBan = function (user, msg, _meta) { KickBanModule.prototype.handleCmdIPBan = function (user, msg, meta) {
var args = msg.split(" "); var args = msg.split(" ");
args.shift(); /* shift off /ipban */ args.shift(); /* shift off /ipban */
if (args.length === 0 || args[0].trim() === "") { if (args.length === 0 || args[0].trim() === "") {
@ -260,32 +252,23 @@ KickBanModule.prototype.handleCmdIPBan = function (user, msg, _meta) {
const chan = this.channel; const chan = this.channel;
chan.refCounter.ref("KickBanModule::handleCmdIPBan"); chan.refCounter.ref("KickBanModule::handleCmdIPBan");
this.banAll(user, name, range, reason, function (err) {
this.banAll(user, name, range, reason).catch(error => {
const message = error.message || error;
user.socket.emit("errorMsg", { msg: message });
}).then(() => {
chan.refCounter.unref("KickBanModule::handleCmdIPBan"); chan.refCounter.unref("KickBanModule::handleCmdIPBan");
}); });
}; };
KickBanModule.prototype.checkChannelAlive = function checkChannelAlive() { KickBanModule.prototype.banName = function (actor, name, reason, cb) {
if (!this.channel || this.channel.dead) { var self = this;
throw new Error("Channel not live");
}
};
KickBanModule.prototype.banName = async function banName(actor, name, reason) {
if (!util.isValidUserName(name)) {
throw new Error("Invalid username");
}
reason = reason.substring(0, 255); reason = reason.substring(0, 255);
var chan = this.channel; var chan = this.channel;
var error = function (what) {
actor.socket.emit("errorMsg", { msg: what });
cb(what);
};
if (!chan.modules.permissions.canBan(actor)) { if (!chan.modules.permissions.canBan(actor)) {
throw new Error("You do not have ban permissions on this channel"); return error("You do not have ban permissions on this channel");
} }
name = name.toLowerCase(); name = name.toLowerCase();
@ -293,134 +276,129 @@ KickBanModule.prototype.banName = async function banName(actor, name, reason) {
actor.socket.emit("costanza", { actor.socket.emit("costanza", {
msg: "You can't ban yourself" msg: "You can't ban yourself"
}); });
return cb("Attempted to ban self");
throw new Error("You cannot ban yourself");
} }
const rank = await Account.rankForName(name, chan.name); Q.nfcall(Account.rankForName, name, { channel: chan.name })
this.checkChannelAlive(); .then(function (rank) {
if (rank >= actor.account.effectiveRank) {
throw "You don't have permission to ban " + name;
}
if (rank >= actor.account.effectiveRank) { return Q.nfcall(db.channels.isNameBanned, chan.name, name);
throw new Error("You don't have permission to ban " + name); }).then(function (banned) {
} if (banned) {
throw name + " is already banned";
}
const isBanned = await dbIsNameBanned(chan.name, name); if (chan.dead) { throw null; }
this.checkChannelAlive();
if (isBanned) { return Q.nfcall(db.channels.ban, chan.name, "*", name, reason, actor.getName());
throw new Error(name + " is already banned"); }).then(function () {
} chan.logger.log("[mod] " + actor.getName() + " namebanned " + name);
if (chan.modules.chat) {
await dbAddBan(chan.name, "*", name, reason, actor.getName()); chan.modules.chat.sendModMessage(actor.getName() + " namebanned " + name,
this.checkChannelAlive(); chan.modules.permissions.permissions.ban);
}
chan.logger.log("[mod] " + actor.getName() + " namebanned " + name); return true;
}).then(function () {
if (chan.modules.chat) { self.kickBanTarget(name, null);
chan.modules.chat.sendModMessage( setImmediate(function () {
actor.getName() + " namebanned " + name, cb(null);
chan.modules.permissions.permissions.ban });
); }).catch(error).done();
}
this.kickBanTarget(name, null);
}; };
KickBanModule.prototype.banIP = async function banIP(actor, ip, name, reason) { KickBanModule.prototype.banIP = function (actor, ip, name, reason, cb) {
if (!util.isValidUserName(name)) { var self = this;
throw new Error("Invalid username");
}
reason = reason.substring(0, 255); reason = reason.substring(0, 255);
var masked = util.cloakIP(ip); var masked = util.cloakIP(ip);
var chan = this.channel; var chan = this.channel;
var error = function (what) {
actor.socket.emit("errorMsg", { msg: what });
cb(what);
};
if (!chan.modules.permissions.canBan(actor)) { if (!chan.modules.permissions.canBan(actor)) {
throw new Error("You do not have ban permissions on this channel"); return error("You do not have ban permissions on this channel");
} }
const rank = await Account.rankForIP(ip, chan.name); Q.nfcall(Account.rankForIP, ip, { channel: chan.name }).then(function (rank) {
this.checkChannelAlive(); if (rank >= actor.account.effectiveRank) {
throw "You don't have permission to ban IP " + masked;
}
if (rank >= actor.account.effectiveRank) { return Q.nfcall(db.channels.isIPBanned, chan.name, ip);
// TODO: this message should be made friendlier }).then(function (banned) {
throw new Error("You don't have permission to ban IP " + masked); if (banned) {
} throw masked + " is already banned";
}
const isBanned = await dbIsIPBanned(chan.name, ip); if (chan.dead) { throw null; }
this.checkChannelAlive();
if (isBanned) { return Q.nfcall(db.channels.ban, chan.name, ip, name, reason, actor.getName());
// TODO: this message should be made friendlier }).then(function () {
throw new Error(masked + " is already banned"); var cloaked = util.cloakIP(ip);
} chan.logger.log("[mod] " + actor.getName() + " banned " + cloaked + " (" + name + ")");
if (chan.modules.chat) {
await dbAddBan(chan.name, ip, name, reason, actor.getName()); chan.modules.chat.sendModMessage(actor.getName() + " banned " +
this.checkChannelAlive(); cloaked + " (" + name + ")",
chan.modules.permissions.permissions.ban);
var cloaked = util.cloakIP(ip); }
chan.logger.log( }).then(function () {
"[mod] " + actor.getName() + " banned " + cloaked + self.kickBanTarget(name, ip);
" (" + name + ")" setImmediate(function () {
); cb(null);
});
if (chan.modules.chat) { }).catch(error).done();
chan.modules.chat.sendModMessage(
actor.getName() + " banned " + cloaked + " (" + name + ")",
chan.modules.permissions.permissions.ban
);
}
this.kickBanTarget(name, ip);
}; };
KickBanModule.prototype.banAll = async function banAll( KickBanModule.prototype.banAll = function (actor, name, range, reason, cb) {
actor, var self = this;
name,
range,
reason
) {
reason = reason.substring(0, 255); reason = reason.substring(0, 255);
var chan = this.channel; var chan = self.channel;
var error = function (what) {
cb(what);
};
if (!chan.modules.permissions.canBan(actor)) { if (!chan.modules.permissions.canBan(actor)) {
throw new Error("You do not have ban permissions on this channel"); return error("You do not have ban permissions on this channel");
} }
const ips = await dbGetIPs(name); self.banName(actor, name, reason, function (err) {
this.checkChannelAlive(); if (err && err.indexOf("is already banned") === -1) {
cb(err);
} else {
db.getIPs(name, function (err, ips) {
if (err) {
return error(err);
}
const toBan = new Set(); var seenIPs = {};
for (let ip of ips) { var all = ips.map(function (ip) {
switch (range) { if (range === "range") {
case "range": ip = util.getIPRange(ip);
toBan.add(util.getIPRange(ip)); } else if (range === "wrange") {
break; ip = util.getWideIPRange(ip);
case "wrange": }
toBan.add(util.getWideIPRange(ip));
break; if (seenIPs.hasOwnProperty(ip)) {
default: return;
toBan.add(ip); } else {
break; seenIPs[ip] = true;
}
return Q.nfcall(self.banIP.bind(self), actor, ip, name, reason);
});
Q.all(all).then(function () {
setImmediate(cb);
}).catch(error).done();
});
} }
} });
const promises = Array.from(toBan).map(ip =>
this.banIP(actor, ip, name, reason)
);
if (!await dbIsNameBanned(chan.name, name)) {
promises.push(this.banName(actor, name, reason).catch(error => {
// TODO: banning should be made idempotent, not throw an error
if (!/already banned/.test(error.message)) {
throw error;
}
}));
}
await Promise.all(promises);
this.checkChannelAlive();
}; };
KickBanModule.prototype.kickBanTarget = function (name, ip) { KickBanModule.prototype.kickBanTarget = function (name, ip) {
@ -452,11 +430,8 @@ KickBanModule.prototype.handleUnban = function (user, data) {
self.channel.logger.log("[mod] " + user.getName() + " unbanned " + data.name); self.channel.logger.log("[mod] " + user.getName() + " unbanned " + data.name);
if (self.channel.modules.chat) { if (self.channel.modules.chat) {
var banperm = self.channel.modules.permissions.permissions.ban; var banperm = self.channel.modules.permissions.permissions.ban;
// TODO: quick fix, shouldn't trust name from unban frame. self.channel.modules.chat.sendModMessage(user.getName() + " unbanned " +
self.channel.modules.chat.sendModMessage( data.name, banperm);
user.getName() + " unbanned " + XSS.sanitizeText(data.name),
banperm
);
} }
self.channel.refCounter.unref("KickBanModule::handleUnban"); self.channel.refCounter.unref("KickBanModule::handleUnban");
}); });

View file

@ -3,8 +3,7 @@ var Flags = require("../flags");
var util = require("../utilities"); var util = require("../utilities");
var InfoGetter = require("../get-info"); var InfoGetter = require("../get-info");
var db = require("../database"); var db = require("../database");
import { Counter, Summary } from 'prom-client'; var Media = require("../media");
const LOGGER = require('@calzoneman/jsli')('channel/library');
const TYPE_UNCACHE = { const TYPE_UNCACHE = {
id: "string" id: "string"
@ -15,7 +14,7 @@ const TYPE_SEARCH_MEDIA = {
query: "string" query: "string"
}; };
function LibraryModule(_channel) { function LibraryModule(channel) {
ChannelModule.apply(this, arguments); ChannelModule.apply(this, arguments);
} }
@ -32,17 +31,15 @@ LibraryModule.prototype.cacheMedia = function (media) {
} }
}; };
LibraryModule.prototype.cacheMediaList = function (list) { LibraryModule.prototype.getItem = function (id, cb) {
if (this.channel.is(Flags.C_REGISTERED)) { db.channels.getLibraryItem(this.channel.name, id, function (err, row) {
LOGGER.info( if (err) {
'Saving %d items to library for %s', cb(err, null);
list.length, } else {
this.channel.name var meta = JSON.parse(row.meta || "{}");
); cb(null, new Media(row.id, row.title, row.seconds, row.type, meta));
db.channels.addListToLibrary(this.channel.name, list).catch(error => { }
LOGGER.error('Failed to add list to library: %s', error.stack); });
});
}
}; };
LibraryModule.prototype.handleUncache = function (user, data) { LibraryModule.prototype.handleUncache = function (user, data) {
@ -56,7 +53,7 @@ LibraryModule.prototype.handleUncache = function (user, data) {
const chan = this.channel; const chan = this.channel;
chan.refCounter.ref("LibraryModule::handleUncache"); chan.refCounter.ref("LibraryModule::handleUncache");
db.channels.deleteFromLibrary(chan.name, data.id, function (err, _res) { db.channels.deleteFromLibrary(chan.name, data.id, function (err, res) {
if (chan.dead) { if (chan.dead) {
return; return;
} else if (err) { } else if (err) {
@ -70,24 +67,11 @@ LibraryModule.prototype.handleUncache = function (user, data) {
}); });
}; };
const librarySearchQueryCount = new Counter({
name: 'cytube_library_search_query_count',
help: 'Counter for number of channel library searches',
labelNames: ['source']
});
const librarySearchResultSize = new Summary({
name: 'cytube_library_search_results_size',
help: 'Summary for number of channel library results returned',
labelNames: ['source']
});
LibraryModule.prototype.handleSearchMedia = function (user, data) { LibraryModule.prototype.handleSearchMedia = function (user, data) {
var query = data.query.substring(0, 100); var query = data.query.substring(0, 100);
var searchYT = function () { var searchYT = function () {
librarySearchQueryCount.labels('yt').inc(1, new Date());
InfoGetter.Getters.ytSearch(query, function (e, vids) { InfoGetter.Getters.ytSearch(query, function (e, vids) {
if (!e) { if (!e) {
librarySearchResultSize.labels('yt')
.observe(vids.length, new Date());
user.socket.emit("searchResults", { user.socket.emit("searchResults", {
source: "yt", source: "yt",
results: vids results: vids
@ -100,15 +84,14 @@ LibraryModule.prototype.handleSearchMedia = function (user, data) {
!this.channel.modules.permissions.canSeePlaylist(user)) { !this.channel.modules.permissions.canSeePlaylist(user)) {
searchYT(); searchYT();
} else { } else {
librarySearchQueryCount.labels('library').inc(1, new Date());
db.channels.searchLibrary(this.channel.name, query, function (err, res) { db.channels.searchLibrary(this.channel.name, query, function (err, res) {
if (err) { if (err) {
res = []; res = [];
} }
librarySearchResultSize.labels('library') if (res.length === 0) {
.observe(res.length, new Date()); return searchYT();
}
res.sort(function (a, b) { res.sort(function (a, b) {
var x = a.title.toLowerCase(); var x = a.title.toLowerCase();

Some files were not shown because too many files have changed in this diff Show more