serverless-ircd 0.6.0 → 0.7.0

package/apps/web/upstream/jsdoc.json

@@ -0,0 +1,22 @@
+{
+    "plugins": ["plugins/markdown"],
+    "recurseDepth": 10,
+    "source": {
+        "include": "src/",
+        "includePattern": ".+\\.js(doc|x)?$",
+        "excludePattern": "(^|\\/|\\\\)_"
+    },
+    "sourceType": "module",
+    "tags": {
+        "allowUnknownTags": true,
+        "dictionaries": ["jsdoc","closure"]
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false
+    },
+    "opts": {
+        "destination": "./srcdocs/",
+        "recurse": true
+    }
+}

package/apps/web/upstream/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "kiwiirc",
+  "version": "1.7.1",
+  "description": "Web based IRC client",
+  "author": "Darren <darren@darrenwhitlen.com>",
+  "scripts": {
+    "build": "vue-cli-service build --no-module",
+    "test:unit": "vue-cli-service test:unit",
+    "lint": "npm-run-all lint:*",
+    "lint:eslint": "vue-cli-service lint --no-fix",
+    "lint:stylelint": "stylelint \"src/**/*.{vue,htm,html,css,sss,less,scss}\"",
+    "dev": "vue-cli-service serve",
+    "test": "vue-cli-service test:unit",
+    "gendocs": "rm -rf srcdocs/ && jsdoc -c jsdoc.json"
+  },
+  "dependencies": {
+    "@babel/runtime-corejs3": "^7.22.6",
+    "@panter/vue-i18next": "^0.15.2",
+    "buffer": "^6.0.3",
+    "compare-versions": "^5.0.3",
+    "css-vars-ponyfill": "^2.4.8",
+    "event-emitter": "^0.3.5",
+    "font-awesome": "^4.7.0",
+    "htmlparser2": "^8.0.2",
+    "i18next": "^22.5.1",
+    "i18next-http-backend": "^v2.2.1",
+    "intersection-observer": "^0.12.2",
+    "ip-regex": "^4.3.0",
+    "irc-framework": "^4.13.1",
+    "json5": "^2.2.3",
+    "murmurhash3js": "^3.0.1",
+    "sockjs-client": "^1.6.1",
+    "stream-browserify": "^3.0.0",
+    "strftime": "^0.10.2",
+    "tinycon": "^0.6.8",
+    "vue": "^2.7.14",
+    "vue-virtual-scroller": "^1.1.2",
+    "whatwg-fetch": "^3.6.17",
+    "xhr": "^2.6.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.22.9",
+    "@babel/eslint-parser": "^7.22.9",
+    "@babel/plugin-transform-runtime": "^7.22.9",
+    "@vue/cli-plugin-babel": "~5.0.8",
+    "@vue/cli-plugin-eslint": "~5.0.8",
+    "@vue/cli-plugin-unit-jest": "~5.0.8",
+    "@vue/cli-service": "~5.0.8",
+    "@vue/eslint-config-airbnb": "^6.0.0",
+    "@vue/test-utils": "1.3.6",
+    "@vue/vue2-jest": "^27.0.0",
+    "babel-jest": "^27.5.1",
+    "copy-webpack-plugin": "^11.0.0",
+    "eslint": "^7.32.0",
+    "eslint-config-standard": "^14.1.1",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^4.3.1",
+    "eslint-plugin-rulesdir": "^0.2.2",
+    "eslint-plugin-standard": "^4.1.0",
+    "eslint-plugin-vue": "^8.7.1",
+    "eslint-plugin-vuejs-accessibility": "^1.2.0",
+    "html-loader": "^4.2.0",
+    "i18next-conv": "^12.1.1",
+    "jest": "^27.5.1",
+    "jsdoc": "^4.0.2",
+    "less": "^4.1.3",
+    "less-loader": "^11.1.3",
+    "npm-run-all": "^4.1.5",
+    "postcss-html": "^1.5.0",
+    "postcss-import": "^12.0.1",
+    "postcss-url": "^9.0.0",
+    "stylelint": "^14.16.1",
+    "stylelint-config-recommended-vue": "^1.5.0",
+    "stylelint-config-standard": "^29.0.0",
+    "stylelint-webpack-plugin": "3.3.0",
+    "vue-template-compiler": "^2.7.14",
+    "webpack": "^5.88.2"
+  }
+}

package/apps/web/upstream/scripts/pre-commit

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+## Source https://gist.github.com/rashtay/328da46a99a9d7c746636df1cf769675
+
+STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep ".\(vue\|jsx\?\)$")
+ESLINT="$(git rev-parse --show-toplevel)/node_modules/.bin/eslint"
+
+if [[ "$STAGED_FILES" = "" ]]; then
+  exit 0
+fi
+
+PASS=true
+
+printf "\nValidating Javascript:\n"
+
+# Check for eslint
+if [[ ! -x "$ESLINT" ]]; then
+  printf "\t\033[41mPlease install ESlint\033[0m (npm i --save-dev eslint)"
+  exit 1
+fi
+
+for FILE in $STAGED_FILES
+do
+  "$ESLINT" "$FILE"
+
+  if [[ "$?" == 0 ]]; then
+    printf "\t\033[32mESLint Passed: $FILE\033[0m\n"
+  else
+    printf "\t\033[41mESLint Failed: $FILE\033[0m\n"
+    PASS=false
+  fi
+done
+
+printf "\nJavascript validation completed!\n"
+
+if ! $PASS; then
+  printf "\033[41mCOMMIT FAILED:\033[0m Your commit contains files that should pass ESLint but do not. Please fix the ESLint errors and try again.\n"
+  exit 1
+else
+  printf "\033[42mCOMMIT SUCCEEDED\033[0m\n"
+fi
+
+exit $?

package/apps/web/upstream/src/components/App.vue

@@ -0,0 +1,516 @@
+<template>
+    <div
+        :class="{
+            'kiwi-wrap--statebrowser-drawopen': stateBrowserDrawOpen,
+            'kiwi-wrap--monospace': $state.setting('useMonospace'),
+            'kiwi-wrap--touch': $state.ui.is_touch,
+        }"
+        :data-activebuffer="buffer ? buffer.name.toLowerCase() : ''"
+        class="kiwi-wrap kiwi-theme-bg"
+        @click="emitDocumentClick"
+        @paste.capture="emitBufferPaste"
+    >
+        <link :href="themeUrl" rel="stylesheet" type="text/css">
+
+        <template v-if="!hasStarted || (!fallbackComponent && networks.length === 0)">
+            <component :is="startupComponent" @start="startUp" />
+        </template>
+        <template v-else>
+            <state-browser :networks="networks" :sidebar-state="sidebarState" />
+            <div
+                :class="{
+                    'kiwi-workspace--disconnected': network && network.state !== 'connected'
+                }"
+                class="kiwi-workspace"
+                @click="stateBrowserDrawOpen = false"
+            >
+                <div class="kiwi-workspace-background" />
+
+                <template v-if="!activeComponent && network">
+                    <container
+                        :network="network"
+                        :buffer="buffer"
+                        :sidebar-state="sidebarState"
+                    >
+                        <template v-if="mediaviewerOpen" #before>
+                            <media-viewer
+                                :url="mediaviewerUrl"
+                                :component="mediaviewerComponent"
+                                :component-props="mediaviewerComponentProps"
+                                :is-iframe="mediaviewerIframe"
+                                class="kiwi-main-mediaviewer"
+                                @close="$state.$emit('mediaviewer.hide', { source: 'user' });"
+                            />
+                        </template>
+                    </container>
+                    <control-input
+                        v-if="buffer.show_input"
+                        :network="network"
+                        :buffer="buffer"
+                        :sidebar-state="sidebarState"
+                    />
+                </template>
+                <component
+                    :is="fallbackComponent"
+                    v-else-if="!activeComponent"
+                    v-bind="fallbackComponentProps"
+                />
+                <component :is="activeComponent" v-else v-bind="activeComponentProps" />
+            </div>
+        </template>
+    </div>
+</template>
+
+<script>
+'kiwi public';
+
+import cssVarsPonyfill from 'css-vars-ponyfill';
+import '@/res/globalStyle.css';
+import Tinycon from 'tinycon';
+
+import startupWelcome from '@/components/startups/Welcome';
+import startupZncLogin from '@/components/startups/ZncLogin';
+import startupCustomServer from '@/components/startups/CustomServer';
+import startupKiwiBnc from '@/components/startups/KiwiBnc';
+import startupPersonal from '@/components/startups/Personal';
+import StateBrowser from '@/components/StateBrowser';
+import AppSettings from '@/components/AppSettings';
+import Container from '@/components/Container';
+import ControlInput from '@/components/ControlInput';
+import MediaViewer from '@/components/MediaViewer';
+import { State as SidebarState } from '@/components/Sidebar';
+import * as Notifications from '@/libs/Notifications';
+import * as bufferTools from '@/libs/bufferTools';
+import ThemeManager from '@/libs/ThemeManager';
+import Logger from '@/libs/Logger';
+
+let log = Logger.namespace('App.vue');
+
+export default {
+    components: {
+        StateBrowser,
+        Container,
+        ControlInput,
+        MediaViewer,
+    },
+    data() {
+        return {
+            startupComponent: null,
+            hasStarted: false,
+            // When on mobile screens, the statebrowser turns into a drawer
+            stateBrowserDrawOpen: false,
+            // If set, will become the main view instead of a buffer/nicklist container
+            activeComponent: null,
+            activeComponentProps: {},
+            // If set, will become the main view when no networks are available to be shown
+            // and there is no active component set
+            fallbackComponent: null,
+            fallbackComponentProps: {},
+            mediaviewerOpen: false,
+            mediaviewerUrl: '',
+            mediaviewerComponent: null,
+            mediaviewerComponentProps: {},
+            mediaviewerIframe: false,
+            themeUrl: '',
+            sidebarState: new SidebarState(),
+        };
+    },
+    computed: {
+        networks() {
+            return this.$state.networks;
+        },
+        network() {
+            return this.$state.getActiveNetwork();
+        },
+        buffer() {
+            return this.$state.getActiveBuffer();
+        },
+    },
+    created() {
+        this.listenForActiveComponents();
+        this.watchForThemes();
+        this.initStateBrowser();
+        this.initMediaviewer();
+        this.configureFavicon();
+
+        this.listen(document, 'keydown', (event) => this.onKeyDown(event));
+        this.listen(window, 'focus', (event) => this.onFocus(event));
+        this.listen(window, 'blur', (event) => this.onBlur(event));
+        this.listen(window, 'touchstart', (event) => this.onTouchStart(event));
+    },
+    mounted() {
+        // Decide which startup screen to use depending on the config
+        let startupScreens = {
+            welcome: startupWelcome,
+            customServer: startupCustomServer,
+            kiwiBnc: startupKiwiBnc,
+            znc: startupZncLogin,
+            personal: startupPersonal,
+        };
+        let extraStartupScreens = this.$state.getStartups();
+
+        let startupName = this.$state.settings.startupScreen || 'personal';
+        let startup = extraStartupScreens[startupName] || startupScreens[startupName];
+
+        if (!startup) {
+            Logger.error(`Startup screen "${startupName}" does not exist`);
+        } else {
+            this.startupComponent = startup;
+        }
+        this.trackWindowDimensions();
+    },
+    methods: {
+        // Triggered by a startup screen event
+        startUp(opts) {
+            log('startUp()');
+            if (opts && opts.fallbackComponent) {
+                this.fallbackComponent = opts.fallbackComponent;
+            }
+            if (opts && opts.fallbackComponentProps) {
+                this.fallbackComponentProps = opts.fallbackComponentProps;
+            }
+
+            // Make sure a startup screen can't trigger these more than once
+            if (!this.hasStarted) {
+                this.warnOnPageClose();
+
+                // Wait for a click or sending a message before asking for notification permission.
+                // Not doing this on an input event will get it blocked by some browsers.
+                let requestNotificationPermission = () => {
+                    this.$state.$off('document.clicked', requestNotificationPermission);
+                    this.$state.$off('input.raw', requestNotificationPermission);
+
+                    Notifications.requestPermission(this.$state);
+                    Notifications.listenForNewMessages(this.$state);
+                };
+
+                this.$state.$once('document.clicked', requestNotificationPermission);
+                this.$state.$once('input.raw', requestNotificationPermission);
+            }
+
+            this.hasStarted = true;
+        },
+        listenForActiveComponents() {
+            this.listen(this.$state, 'active.component', (component, props) => {
+                this.activeComponent = null;
+                if (component) {
+                    this.activeComponentProps = props;
+                    this.activeComponent = component;
+                }
+            });
+            this.listen(this.$state, 'active.component.toggle', (component, props) => {
+                if (component === this.activeComponent) {
+                    this.activeComponent = null;
+                } else if (component) {
+                    this.activeComponentProps = props;
+                    this.activeComponent = component;
+                }
+            });
+        },
+        watchForThemes() {
+            let themes = ThemeManager.instance();
+            this.themeUrl = ThemeManager.themeUrl(themes.currentTheme());
+            this.$nextTick(() => cssVarsPonyfill());
+            this.listen(this.$state, 'theme.change', () => {
+                this.themeUrl = ThemeManager.themeUrl(themes.currentTheme());
+                this.$nextTick(() => cssVarsPonyfill());
+            });
+        },
+        initStateBrowser() {
+            this.listen(this.$state, 'statebrowser.toggle', () => {
+                this.stateBrowserDrawOpen = !this.stateBrowserDrawOpen;
+            });
+            this.listen(this.$state, 'statebrowser.show', () => {
+                this.stateBrowserDrawOpen = true;
+            });
+            this.listen(this.$state, 'statebrowser.hide', () => {
+                this.stateBrowserDrawOpen = false;
+            });
+        },
+        initMediaviewer() {
+            this.listen(this.$state, 'mediaviewer.show', (url) => {
+                let opts = {};
+
+                // The passed url may be a string or an options object
+                if (typeof url === 'string') {
+                    opts = { url: url };
+                } else {
+                    opts = url;
+                }
+
+                this.mediaviewerUrl = opts.url;
+                this.mediaviewerComponent = opts.component;
+                this.mediaviewerComponentProps = opts.componentProps;
+                this.mediaviewerIframe = opts.iframe;
+                this.mediaviewerOpen = true;
+            });
+
+            this.listen(this.$state, 'mediaviewer.hide', () => {
+                this.mediaviewerOpen = false;
+            });
+        },
+        configureFavicon() {
+            // favicon bubble
+            Tinycon.setOptions({
+                width: 7,
+                height: 9,
+                color: '#ffffff',
+                background: '#b32d2d',
+                fallback: true,
+            });
+
+            this.$state.$watch('ui.favicon_counter', (newVal) => {
+                if (newVal) {
+                    Tinycon.setBubble(newVal);
+                } else {
+                    Tinycon.reset();
+                }
+            });
+
+            this.listen(this.$state, 'message.new', (event) => {
+                let message = event.message;
+                if (!message.isHighlight || message.ignore || this.$state.ui.app_has_focus) {
+                    return;
+                }
+
+                this.$state.ui.favicon_counter++;
+            });
+        },
+        trackWindowDimensions() {
+            // Track the window dimensions into the reactive ui state
+            let trackWindowDims = () => {
+                this.$state.ui.app_width = this.$el.clientWidth;
+                this.$state.ui.app_height = this.$el.clientHeight;
+                this.$state.ui.is_narrow = this.$el.clientWidth <= 769;
+            };
+            this.listen(window, 'resize', trackWindowDims);
+            trackWindowDims();
+        },
+        warnOnPageClose() {
+            window.onbeforeunload = () => {
+                if (this.$state.setting('warnOnExit')) {
+                    return this.$t('window_unload');
+                }
+                return undefined;
+            };
+            window.onunload = () => {
+                this.$state.networks.forEach((net) => {
+                    if (net.connection.direct && net.state === 'connected') {
+                        net.ircClient.raw('QUIT', this.$state.setting('quitMessage') || 'Client Closed Connection');
+                    }
+                });
+            };
+        },
+        emitBufferPaste(event) {
+            // bail if no buffer is active, or the buffer is hidden by another component
+            if (!this.$state.getActiveBuffer() || this.activeComponent !== null) {
+                return;
+            }
+
+            // bail if the target is an input-like element
+            if (
+                event.target instanceof HTMLInputElement ||
+                event.target instanceof HTMLSelectElement ||
+                event.target instanceof HTMLTextAreaElement
+            ) {
+                return;
+            }
+
+            this.$state.$emit('buffer.paste', event);
+        },
+        emitDocumentClick(event) {
+            this.$state.$emit('document.clicked', event);
+        },
+        onTouchStart(event) {
+            // Parts of the UI adjust themselves if we're known to be using a touchscreen
+            this.$state.ui.is_touch = true;
+        },
+        onBlur(event) {
+            this.$state.ui.app_has_focus = false;
+        },
+        onFocus(event) {
+            this.$state.ui.app_has_focus = true;
+            let buffer = this.$state.getActiveBuffer();
+            if (buffer) {
+                buffer.markAsRead(true);
+            }
+
+            this.$state.ui.favicon_counter = 0;
+        },
+        onKeyDown(event) {
+            this.$state.$emit('document.keydown', event);
+
+            let meta = false;
+
+            if (navigator.appVersion.indexOf('Mac') !== -1) {
+                meta = event.metaKey;
+            } else {
+                // none english languages use ctrl + alt to access extended chars
+                // make sure we do not interfere with that by only acting on ctrl
+                meta = event.ctrlKey && !event.altKey;
+            }
+
+            if (meta && event.keyCode === 221) {
+                // meta + ]
+                let buffer = bufferTools.getNextBuffer();
+                if (buffer) {
+                    this.$state.setActiveBuffer(buffer.networkid, buffer.name);
+                }
+                event.preventDefault();
+            } else if (meta && event.keyCode === 219) {
+                // meta + [
+                let buffer = bufferTools.getPreviousBuffer();
+                if (buffer) {
+                    this.$state.setActiveBuffer(buffer.networkid, buffer.name);
+                }
+                event.preventDefault();
+            } else if (meta && event.keyCode === 79) {
+                // meta + o
+                this.$state.$emit('active.component.toggle', AppSettings);
+                event.preventDefault();
+            } else if (meta && event.keyCode === 83) {
+                // meta + s
+                let network = this.$state.getActiveNetwork();
+                if (network) {
+                    network.showServerBuffer('settings');
+                }
+                event.preventDefault();
+            }
+        },
+    },
+};
+</script>
+
+<style lang="less">
+@import "~font-awesome/less/variables.less";
+/* stylelint-disable-next-line at-rule-no-unknown */
+@fa-font-path "~font-awesome/fonts/";
+
+/* stylelint-disable no-invalid-position-at-import-rule */
+@import "~font-awesome/less/mixins.less";
+@import "~font-awesome/less/core.less";
+@import "~font-awesome/less/fixed-width.less";
+@import "~font-awesome/less/icons.less";
+@import "~font-awesome/less/path.less";
+@import "~font-awesome/less/animated.less";
+
+html {
+    height: 100%;
+    margin: 0;
+    padding: 0;
+}
+
+body {
+    height: 100%;
+    margin: 0;
+    padding: 0;
+}
+
+.kiwi-wrap {
+    font-size: 90%;
+    line-height: 1.6em;
+    font-family: Source Sans Pro, Helvetica, sans-serif;
+    -webkit-font-smoothing: antialiased;
+    height: 100%;
+    overflow: hidden;
+}
+
+/* .kiwi-workspace has ::before and ::after 4px above itself for the connection status */
+.kiwi-workspace {
+    position: relative;
+    margin-left: 220px;
+    left: 0;
+    top: 4px;
+    display: flex;
+    flex-direction: column;
+    height: 100%;
+    transition: left 0.2s, margin-left 0.2s;
+}
+
+.kiwi-workspace::before,
+.kiwi-workspace::after {
+    position: absolute;
+    content: '';
+    left: 0;
+    right: auto;
+    margin-top: -4px;
+    width: 100%;
+    height: 4px;
+    z-index: 0;
+    transition: width 0.3s;
+}
+
+.kiwi-workspace::after {
+    right: 0;
+    left: auto;
+    width: 0;
+}
+
+.kiwi-workspace--disconnected::before {
+    width: 0;
+}
+
+.kiwi-workspace--disconnected::after {
+    width: 100%;
+}
+
+.kiwi-workspace-background {
+    position: absolute;
+    top: 0;
+    left: 0;
+    height: 100%;
+    width: 100%;
+    z-index: -1;
+}
+
+.kiwi-statebrowser {
+    position: absolute;
+    top: 0;
+    left: 0;
+    width: 220px;
+    bottom: 0;
+    z-index: 11; /* Must be at least 1 higher than the workspace :after z-index; */
+    transition: left 0.145s, margin-left 0.145s;
+}
+
+.kiwi-container {
+    flex-grow: 1;
+
+    /* The nicklist scroller needs some type of height set on it's parent, but since we use flexbox
+       it starts conflicting on firefox. Luckily flexbox ignores this 5% and resizes it as we intend
+       anyway. */
+    height: 5%;
+}
+
+.kiwi-main-mediaviewer {
+    max-height: 70%;
+    overflow: auto;
+    border-bottom: 1px solid rgba(0, 0, 0, 0.3);
+}
+
+.kiwi-controlinput {
+    z-index: 2;
+}
+
+/* Small screen will cause the statebrowser to act as a drawer */
+@media screen and (max-width: 769px) {
+    .kiwi-workspace {
+        left: 0;
+        margin-left: 0;
+    }
+
+    .kiwi-statebrowser {
+        left: -220px;
+    }
+
+    .kiwi-wrap--statebrowser-drawopen .kiwi-statebrowser {
+        left: 0;
+    }
+
+    .kiwi-wrap--statebrowser-drawopen .kiwi-workspace {
+        left: 75%;
+        transition: left 0.1s;
+        transition-delay: 0s;
+    }
+}
+</style>