nginxconfig.io/src/nginxconfig/templates/app.vue

435 lines
18 KiB
Vue

<!--
Copyright 2022 DigitalOcean
This code is licensed under the MIT License.
You may obtain a copy of the License at
https://github.com/digitalocean/nginxconfig.io/blob/master/LICENSE or https://mit-license.org/
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 :
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->
<template>
<div class="all do-bulma">
<Header :title="$t('templates.app.title')">
<template #description>
{{ $t('templates.app.description') }}
</template>
<template #header>
</template>
<template #buttons>
<VueSelect
v-model="lang"
:options="i18nPacks"
:clearable="false"
:reduce="s => s.value"
:disabled="languageLoading"
>
<template #selected-option="{ label }">
<span class="has-icon">
<i v-if="languageLoading" class="icon fas fa-spinner fa-pulse"></i>
<i v-else class="icon fas fa-language"></i>
<span>{{ label }}</span>
</span>
</template>
</VueSelect>
<a v-if="splitColumn" class="button is-primary is-outline is-hidden-touch" @click="splitColumnToggle">
{{ $t('templates.app.singleColumnMode') }}
</a>
<a v-else class="button is-primary is-hidden-touch" @click="splitColumnToggle">
{{ $t('templates.app.splitColumnMode') }}
</a>
</template>
</Header>
<div class="main container" :style="{ display: ready ? undefined : 'none' }">
<div class="columns is-multiline">
<div :class="`column ${splitColumn ? 'is-half' : 'is-full'} is-full-touch`">
<h2>{{ $t('templates.app.perWebsiteConfig') }}</h2>
<div class="tabs">
<ul>
<li v-for="data in activeDomains" :class="data[1] === active ? 'is-active' : undefined">
<a class="domain" @click="active = data[1]">
{{ data[0].server.domain.computed }}{{ changes(data[1]) }}
<i v-if="warnings(data[1])" class="fas fa-exclamation-triangle"></i>
</a>
<a class="remove" @click="remove(data[1])">
<i class="fas fa-times"></i>
</a>
</li>
<li>
<a @click="add"><i class="fas fa-plus"></i> {{ $t('templates.app.addSite') }}</a>
</li>
</ul>
</div>
<template v-for="data in activeDomains">
<Domain
:key="data[1]"
:ref="`domain-${data[1]}`"
:data="data[0]"
:style="{ display: data[1] === active ? undefined : 'none' }"
></Domain>
</template>
<h2>{{ $t('templates.app.globalConfig') }}</h2>
<Global :data="global"></Global>
<DropletCallout></DropletCallout>
<h2>{{ $t('templates.app.setup') }}</h2>
<Setup :data="{ domains: domains.filter(d => d !== null), global, confFiles }"></Setup>
</div>
<div :class="`column ${splitColumn ? 'is-half' : 'is-full'} is-full-touch`">
<h2>{{ $t('templates.app.configFiles') }}</h2>
<div ref="files" class="columns is-multiline files">
<template v-for="confContents in confFilesOutput">
<component
:is="getPrismComponent(confContents[0])"
:key="confContents[2]"
:name="confContents[0]"
:conf="confContents[1]"
:half="Object.keys(confFilesOutput).length > 1 && !splitColumn"
@copied="codeCopiedEvent(confContents[3])"
></component>
</template>
</div>
</div>
</div>
</div>
<Footer></Footer>
<ContributeCallout></ContributeCallout>
</div>
</template>
<script>
import clone from 'clone';
import sha2_256 from 'simple-js-sha2-256';
import escape from 'escape-html';
import VueSelect from 'vue-select';
import Header from 'do-vue/src/templates/header';
import diff from 'files-diff';
import isChanged from '../util/is_changed';
import importData from '../util/import_data';
import isObject from '../util/is_object';
import analytics from '../util/analytics';
import browserLanguage from '../util/browser_language';
import { defaultPack, availablePacks } from '../util/language_packs';
import { info, error } from '../util/log';
import { setLanguagePack } from '../i18n/setup';
import generators from '../generators';
import Domain from './domain';
import Global from './global';
import DropletCallout from './callouts/droplet';
import ContributeCallout from './callouts/contribute';
import Setup from './setup';
import Footer from './footer';
import NginxPrism from './prism/nginx';
export default {
name: 'App',
components: {
Header,
VueSelect,
Footer,
Domain,
Global,
DropletCallout,
ContributeCallout,
Setup,
NginxPrism,
YamlPrism: () => import('./prism/yaml'),
DockerPrism: () => import('./prism/docker'),
},
data() {
return {
domains: [],
global: {
...Global.delegated,
app: {
lang: {
default: defaultPack,
value: defaultPack,
computed: defaultPack,
enabled: true,
},
},
},
active: 0,
ready: false,
splitColumn: false,
confWatcherWaiting: false,
confFilesPrevious: {},
confFilesOutput: [],
languageLoading: false,
languagePrevious: defaultPack,
interactiveEvents: false,
};
},
computed: {
activeDomains() {
return this.$data.domains.map((domain, index) => [domain, index]).filter(d => d[0] !== null);
},
confFiles() {
return generators(this.$data.domains.filter(d => d !== null), this.$data.global);
},
confFilesWithDirectory() {
return Object.entries(this.confFiles).reduce((obj, [ file, content ]) => ({
...obj,
[`${this.$data.global.nginx.nginxConfigDirectory.computed}/${file}`]: content,
}), {});
},
lang: {
get() {
return this.$data.global.app.lang.value;
},
set (value) {
this.$data.global.app.lang.value = value;
this.$data.global.app.lang.computed = value;
},
},
i18nPacks() {
return availablePacks.map(pack => ({
label: this.$t(`languages.${pack}`) + (pack === this.$i18n.locale
? ''
: ` - ${this.$t(`languages.${pack}`, pack)}`),
value: pack,
}));
},
},
watch: {
confFilesWithDirectory(newConf, oldConf) {
if (this.$data.confWatcherWaiting) return;
// Set that we're waiting for changes to stop
this.$data.confWatcherWaiting = true;
this.$data.confFilesPrevious = oldConf;
// Check next tick to see if anything has changed again
this.$nextTick(() => this.checkChange(newConf));
},
'$data.global.app.lang': {
handler(data) {
// Lock out the dropdown
this.$data.languageLoading = true;
// Store if we should fire the event when this is done loading
const interactive = this.$data.interactiveEvents;
// Ensure valid pack
if (!availablePacks.includes(data.value)) data.computed = data.default;
// Update the locale
setLanguagePack(data.computed).then(() => {
// Done
info('Language set to', data.computed);
this.$data.languagePrevious = data.computed;
this.$data.languageLoading = false;
// Analytics
this.languageSetEvent(!interactive);
}).catch((err) => {
// Error
error(`Failed to set language to ${data.computed}`, err);
// Fallback to last known good
data.value = this.$data.languagePrevious;
data.computed = this.$data.languagePrevious;
this.$data.languageLoading = false;
});
},
deep: true,
},
},
async mounted() {
// Import any data from the URL query params, defaulting to one domain
// Fallback to the window hash if no search query params, from the Angular version of nginxconfig
// The config file watcher will handle setting the app as ready
const query = window.location.search || window.location.hash.slice(1);
const imported = await importData(query, this.$data.domains, this.$data.global, this.$nextTick);
// Apply browser language if not specified in query
if (!imported || !imported.global || !imported.global.app || !imported.global.app.lang) {
const language = browserLanguage(availablePacks);
if (language) this.lang = language;
}
// Initial analytics events
this.splitColumnEvent(true);
for (let i = 0; i < this.activeDomains.length; i++) this.addSiteEvent(i + 1, true);
this.$data.interactiveEvents = true;
},
methods: {
changes(index) {
const data = this.$data.domains[index];
const changes = Object.entries(data).reduce((prev, current) => {
if (current[0] === 'presets') return prev; // Ignore changes from presets
if (!isObject(current[1])) return prev; // Ignore non-objects (things that aren't tabs)
prev += Object.keys(current[1]).filter(key => isChanged(current[1][key], current[0], key)).length;
return prev;
}, 0);
if (changes) return ` (${changes.toLocaleString()})`;
return '';
},
warnings(index) {
if (!Object.prototype.hasOwnProperty.call(this.$refs, `domain-${index}`)) return false;
return this.$refs[`domain-${index}`][0].hasWarnings || false;
},
add() {
const data = clone(Domain.delegated);
// Avoid dupe domains
let count = 1;
while (this.$data.domains.some(d => d && d.server.domain.computed === data.server.domain.computed)) {
count++;
data.server.domain.computed = data.server.domain.default.replace('.com', `${count}.com`);
}
data.server.domain.value = data.server.domain.computed;
// Store
this.$data.domains.push(data);
this.$data.active = this.$data.domains.length - 1;
// Analytics
this.addSiteEvent(this.activeDomains.length);
},
remove(index) {
const name = this.$data.domains[index].server.domain.computed;
this.$set(this.$data.domains, index, null);
if (this.$data.active === index) this.$data.active = this.$data.domains.findIndex(d => d !== null);
// Analytics
this.removeSiteEvent(this.activeDomains.length, name);
},
checkChange(oldConf) {
// If nothing has changed for a tick, we can use the config files
if (oldConf === this.confFilesWithDirectory) {
// If this is the initial data load on app start, run the diff logic
// but with previous as this so that we don't highlight any changes
if (!this.$data.ready) {
this.$data.confFilesPrevious = this.confFilesWithDirectory;
this.$nextTick(() => { this.$data.ready = true; });
}
// Do the diff!
this.updateDiff(this.confFilesWithDirectory, this.$data.confFilesPrevious);
return;
}
// Check next tick to see if anything has changed again
this.$nextTick(() => this.checkChange(this.confFilesWithDirectory));
},
updateDiff(newConf, oldConf) {
try {
// Calculate the diff & highlight after render
const diffConf = diff(newConf, oldConf, {
highlightFunction: value => `<mark>${value}</mark>`,
});
this.$data.confFilesOutput = Object.entries(diffConf).map(([ file, { name, content } ]) => {
const diffName = name.filter(x => !x.removed).map(x => x.value).join('');
const diffContent = content.filter(x => !x.removed).map(x => x.value).join('');
return [
diffName,
diffContent,
`${sha2_256(diffName)}-${sha2_256(diffContent)}`,
file,
];
});
} catch (err) {
// If diff generation goes wrong, don't show any diff
error('Failed to compute and highlight diff', err);
this.$data.confFilesOutput = Object.entries(newConf).map(([ name, content ]) => {
const safeName = escape(name);
const safeContent = escape(content);
return [
safeName,
safeContent,
`${sha2_256(safeName)}-${sha2_256(safeContent)}`,
name,
];
});
}
// Once rendered, begin looking for changes again
this.$nextTick(() => this.$data.confWatcherWaiting = false);
},
splitColumnToggle() {
this.$data.splitColumn = !this.$data.splitColumn;
this.splitColumnEvent();
},
splitColumnEvent(nonInteraction = false) {
analytics({
category: 'Split column',
action: this.$data.splitColumn ? 'Enabled' : 'Disabled',
nonInteraction,
});
},
languageSetEvent(nonInteraction = false) {
analytics({
category: 'Language',
action: 'Set',
label: this.$data.global.app.lang.computed,
nonInteraction,
});
},
addSiteEvent(count, nonInteraction = false) {
analytics({
category: 'Site',
action: 'Added',
value: count,
nonInteraction,
});
},
removeSiteEvent(count, name) {
analytics({
category: 'Site',
action: 'Removed',
label: name,
value: count,
});
},
codeCopiedEvent(file) {
analytics({
category: 'Config files',
action: 'Code snippet copied',
label: file,
});
},
getPrismComponent(confName) {
switch (confName) {
case '/etc/nginx/Dockerfile':
return 'DockerPrism';
case '/etc/nginx/docker-compose.yaml':
return 'YamlPrism';
default:
return 'NginxPrism';
}
},
},
};
</script>