/**
* The Scheduled Events page.
*
* - The events, with what each switches on (its parts, and what each part last did), when it is on and next turns on
* and off, and a mode switch (off, by its schedule, always on). Then a month calendar with the events and the things
* scheduled on their own pages, the event_N settings, and the events that change the same vanity NPCs or files.
* - The editor: name, mode, priority; once (two times) or by rules (every year, once, days of the week, times of day,
* moon phases, groups; or JSON, see dCommon/ScheduleRules.h), which the server checks and lists as you type; and the
* parts, one editor per kind. Kinds the user may not add are shown but can't be picked.
* - #event:ID opens that event, #new a new one, #new:vanity a new one with a vanity part (the Vanity page links here).
*/
(function () {
'use strict';
var DAYS = ['sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat'];
var PHASES = [['new_moon', 'New moon'], ['first_quarter', 'First quarter'], ['full_moon', 'Full moon'], ['last_quarter', 'Last quarter']];
var RULE_LABELS = { yearly: 'Every year', dates: 'Once', weekdays: 'Days of the week', time_of_day: 'Times of day', moon: 'Moon phase', group: 'Group' };
var KIND_LABELS = { feature: 'Game feature', vanity: 'Vanity changes', live_event: 'Live event', announcement: 'Announcement', restart: 'Restart' };
var LIVE_TYPES = [['treasure_hunt', 'Treasure hunt'], ['bonus', 'Bonus'], ['invasion', 'Invasion'], ['celebration', 'Celebration']];
// Colours by state name, so the numbers stay the server's
var COLOURS = { 'Scheduled': 'info', 'Active': 'success', 'Ended': 'secondary', 'Cancelled': 'secondary', 'Missed': 'warning' };
var data = { events: [], features: [], slots: [], states: [], modes: [], kinds: [], zones: [], vanity: null };
var editing = null; // the event being edited, or null for a new one
var rules = []; // the schedule's rules as edited (the JSON format)
var parts = []; // the parts as edited: [{kind, config, applied, status}]
var pickers = null; // vanity files and NPC names, fetched when a vanity part is edited
var recentLive = null; // recent live events to copy from
var previewTimer = null;
var cal = { shown: new Date(), range: '', list: [] };
cal.shown.setDate(1);
var modal = new bootstrap.Modal(document.getElementById('evModal'));
var importModal = new bootstrap.Modal(document.getElementById('evImportModal'));
var canShutDown = DASH.can('worlds_manage');
function get(id) { return document.getElementById(id); }
function byId(id) { return data.events.filter(function (e) { return String(e.id) === String(id); })[0]; }
function pad(n) { return (n < 10 ? '0' : '') + n; }
function lines(text) { return String(text).split('\n').map(function (l) { return l.trim(); }).filter(Boolean); }
function allowed(kind) { var k = data.kinds.filter(function (x) { return x.name === kind; })[0]; return !!(k && k.allowed); }
function permissionOf(kind) { return (data.kinds.filter(function (x) { return x.name === kind; })[0] || {}).permission || ''; }
function colour(e) { return COLOURS[e.stateName] || 'secondary'; }
function isOver(e) { return e.once && (e.stateName === 'Ended' || e.stateName === 'Missed' || e.stateName === 'Cancelled'); }
function feature(name) { return data.features.filter(function (f) { return f.name === name; })[0]; }
// Whether the user may change the event: every kind of part it has needs its permission
function mayChange(e) { return e.parts.every(function (p) { return allowed(p.kind); }); }
function offsetLabel(minutes) {
if (!minutes) return 'UTC';
var sign = minutes < 0 ? '-' : '+', abs = Math.abs(minutes);
return 'UTC' + sign + pad(Math.floor(abs / 60)) + ':' + pad(abs % 60);
}
// The browser's offset now, to the quarter hour (a new schedule starts in it)
function browserOffset() { return Math.round(-new Date().getTimezoneOffset() / 15) * 15; }
function toInput(ts) {
if (!ts) return '';
var d = new Date(ts * 1000);
d.setMinutes(d.getMinutes() - d.getTimezoneOffset());
return d.toISOString().slice(0, 16);
}
function fromInput(value) { return value ? Math.floor(new Date(value).getTime() / 1000) : 0; }
// ---------------------------------------------------------------- describing schedules and parts
function monthDay(text) {
var p = String(text || '').split('-');
var d = new Date(2000, Number(p[0]) - 1, Number(p[1]));
return isNaN(d) ? text : d.toLocaleDateString([], { month: 'short', day: 'numeric' });
}
function describeRule(r) {
var text;
switch (r.type) {
case 'yearly': text = 'every year ' + monthDay(r.from) + ' to ' + monthDay(r.to); break;
case 'dates': text = String(r.from).replace('T', ' ') + ' to ' + String(r.to).replace('T', ' '); break;
case 'weekdays': text = (r.days || []).map(function (d) { return d.charAt(0).toUpperCase() + d.slice(1); }).join(', '); break;
case 'time_of_day': text = r.from + ' to ' + r.to; break;
case 'moon': {
var phase = (PHASES.filter(function (p) { return p[0] === r.phase; })[0] || [r.phase, r.phase])[1].toLowerCase();
text = r.hours ? phase + ' ±' + r.hours + 'h' : phase + (r.days ? ' day ±' + r.days + 'd' : ' day');
break;
}
case 'group': text = '(' + describeRules(r.rules || [], r.match) + ')'; break;
default: text = r.type;
}
return (r.not ? 'not ' : '') + text;
}
function describeRules(list, match) { return list.map(describeRule).join(match === 'all' ? ' and ' : ' or '); }
// Always with the rules' time zone: a UTC day is two days in most browsers
function describe(schedule) {
if (!schedule) return '';
return describeRules(schedule.rules || [], schedule.match) + ' (' + offsetLabel(schedule.utcOffset || 0) + ')';
}
function partSummary(p) {
var c = p.config || {};
switch (p.kind) {
case 'feature': return esc(c.feature || '?') + (p.state && p.state.slot ? ' ' + esc('event_' + p.state.slot) + '' : '');
case 'vanity': {
var bits = [];
Object.keys(c.fileSwitches || {}).forEach(function (f) { bits.push(esc(f) + (c.fileSwitches[f] ? ' on' : ' off')); });
if (c.file) bits.push('overlay ' + esc(c.file));
var removals = Array.isArray(c.removals) ? c.removals : lines(c.removals || '');
if (removals.length) bits.push('takes out ' + esc(removals.join(', ')));
return bits.join('; ');
}
case 'live_event': return esc((LIVE_TYPES.filter(function (t) { return t[0] === c.type; })[0] || ['', c.type])[1]) + (c.title ? ' “' + esc(c.title) + '”' : '');
case 'announcement': return (c.atStart !== false ? 'at the start' : '') + (c.repeat ? (c.atStart !== false ? ', ' : '') + 'repeats ' + esc(c.repeat) + '' : '') +
(c.endMessage ? ', at the end' : '');
case 'restart': return 'when it ' + (c.when === 'start' ? 'starts' : 'ends') + ', ' + esc(c.minutes) + ' min warning';
}
return '';
}
function partBadges(e) {
if (e.partsError) return '
';
}).join('');
}
// ---------------------------------------------------------------- the list
function whenCell(e) {
if (e.once) return esc(fmt.unix(e.startsAt)) + ' to ' + esc(fmt.unix(e.endsAt));
if (e.scheduleError) return '' + esc(e.scheduleError) + '';
return esc(describe(e.schedule));
}
function nextCell(e) {
var state = e.once ? fmt.badge(e.stateName, colour(e)) + ' ' : '';
if (e.mode === 0) return state + 'Off';
var now = e.on ? fmt.badge('On', 'success') : fmt.badge('Off now', 'secondary');
if (e.mode === 2) return now + ' always';
if (isOver(e)) return state;
var bits = [];
if (e.on && e.nextEnd) bits.push('until ' + esc(fmt.unix(e.nextEnd)));
if (!e.on && e.nextStart) bits.push('from ' + esc(fmt.unix(e.nextStart)) + (e.nextEnd ? ' to ' + esc(fmt.unix(e.nextEnd)) : ''));
if (e.on && e.nextStart) bits.push('then from ' + esc(fmt.unix(e.nextStart)));
if (!bits.length && !e.once) bits.push(e.on ? 'for the next four years' : 'not in the next four years');
return now + '
' + bits.join(' ') + '
';
}
function worlds(e) {
// Feature parts: running worlds of the zones that keep what they loaded until restarted
var list = [];
e.parts.forEach(function (p) { if (p.kind === 'feature' && p.applied) (p.affected || []).forEach(function (w) { list.push(w); }); });
if (!list.length) return '';
return '
Vanity file ' + esc(c.file) + ' is switched by ' + esc(c.switches.map(function (s) { return s.event + ' (' + (s.on ? 'on' : 'off') + ')'; }).join(', ')) +
'; ' + esc(c.winner) + ' wins, so it is ' + (c.on ? 'on' : 'off') + '.
');
});
}
get('evConflicts').innerHTML = items.length ? 'Events that are on now change the same vanity NPCs or files:
' + items.join('') + '
' : '';
get('evConflicts').classList.toggle('d-none', !items.length);
var overlaps = v ? v.overlaps : [];
get('evOverlaps').innerHTML = overlaps.map(function (o) {
var a = byId(o.a) || {}, b = byId(o.b) || {};
var what = [];
if (o.npcs.length) what.push('NPCs ' + o.npcs.join(', '));
if (o.files.length) what.push('files ' + o.files.join(', '));
return '
' + esc(a.name) + ' and ' + esc(b.name) + ' both change ' + esc(what.join(' and ')) +
'. When both are on, ' + esc((byId(o.winner) || {}).name) + ' wins.
';
}).join('');
}
function load() {
return api.get('/api/events').then(function (d) {
if (!d.success) { toast(d.error || 'Could not load the events', 'danger'); return; }
data = d;
get('scanning').classList.toggle('d-none', !d.scanning);
get('clientVersion').textContent = d.clientVersion;
renderList();
renderVanity();
renderSlots();
cal.range = '';
renderCalendar();
renderNewPartOptions();
});
}
// ---------------------------------------------------------------- the calendar
function renderCalendar() {
var year = cal.shown.getFullYear(), month = cal.shown.getMonth();
get('calTitle').textContent = cal.shown.toLocaleDateString([], { month: 'long', year: 'numeric' });
var first = new Date(year, month, 1);
var start = new Date(first); start.setDate(1 - ((first.getDay() + 6) % 7)); // weeks start on Monday
var html = '';
for (var i = 0; i < 7; i++) html += '
';
}
function builderSchedule() { return { utcOffset: Number(get('evOffset').value) || 0, match: get('evMatch').value, rules: rules }; }
function repeating() { return get('evRepeat').checked; }
// The schedule as edited (null for once), or undefined (after a toast) when the JSON can't be read
function currentSchedule(quiet) {
if (!repeating()) return null;
if (!get('evJsonMode').checked) return builderSchedule();
try { return JSON.parse(get('evJson').value); } catch (e) {
if (!quiet) toast('The schedule isn\'t valid JSON: ' + e.message, 'danger');
return undefined;
}
}
function offsetInfo() {
var offset = Number(get('evOffset').value) || 0, mine = browserOffset();
get('evOffsetInfo').textContent = 'Dates, days and times in the rules are ' + offsetLabel(offset) + ' (a fixed offset: no daylight saving)' +
(offset === mine ? ', the same as your browser now.' : '; your browser is ' + offsetLabel(mine) + ', so a day in the rules is ' + offsetLabel(offset) + ' midnight to midnight.');
}
function loadBuilder(schedule) {
schedule = schedule || { utcOffset: browserOffset(), match: 'any', rules: [] };
get('evOffset').value = String(schedule.utcOffset || 0);
get('evMatch').value = schedule.match === 'all' ? 'all' : 'any';
rules = (schedule.rules || []).slice();
renderRules();
offsetInfo();
}
function schedulePreview() {
clearTimeout(previewTimer);
var out = get('evSchedulePreview');
if (!repeating()) {
var s = fromInput(get('evStarts').value), e = fromInput(get('evEnds').value);
out.innerHTML = s && e ? (e <= s ? 'The end has to be after the start.' : 'On from ' + esc(fmt.unix(s)) + ' to ' + esc(fmt.unix(e)) + ' (your time zone).') : '';
return;
}
previewTimer = setTimeout(function () {
var schedule = currentSchedule(true);
if (!schedule) { out.innerHTML = 'Not valid JSON'; return; }
api.post('/api/events/check', { schedule: schedule, count: 6 }).then(function (d) {
if (!d.success) return;
if (!d.valid) { out.innerHTML = '' + esc(d.error) + ''; return; }
out.innerHTML = '
');
});
}, 300);
}
function setWhen(repeat) {
get(repeat ? 'evRepeat' : 'evOnce').checked = true;
get('evOnceBox').classList.toggle('d-none', repeat);
get('evRepeatBox').classList.toggle('d-none', !repeat);
schedulePreview();
}
// ---------------------------------------------------------------- the parts
function renderNewPartOptions() {
get('evNewPart').innerHTML = data.kinds.map(function (k) {
return '';
}).join('');
var first = data.kinds.filter(function (k) { return k.allowed; })[0];
if (first) get('evNewPart').value = first.name;
}
function defaultConfig(kind) {
switch (kind) {
case 'feature': return { feature: '' };
case 'vanity': return { file: '', removals: [], fileSwitches: {} };
case 'live_event': return { type: 'celebration', title: '', message: '', zones: [], instance: -1, config: liveDefaults('celebration') };
case 'announcement': return { title: '', message: '', zones: [], atStart: true, repeat: '', endMessage: '' };
case 'restart': return { when: 'end', minutes: 15, reason: '' };
}
return {};
}
function liveDefaults(type) {
switch (type) {
case 'treasure_hunt': return { lot: 0, count: 10, coins: 0, radius: 4, itemLot: 0, itemCount: 1 };
case 'bonus': return { coins: 2, uscore: 1, lootChance: 1 };
case 'invasion': return { lots: [], waves: 3, perWave: 5, interval: 90, radius: 25, center: 'spawn' };
default: return { effectId: 0, effectType: '', interval: 10 };
}
}
function field(i, path, label, value, attrs, help) {
var id = 'evp-' + i + '-' + path.replace(/\./g, '-');
return '
' +
'' +
(help ? '
' + help + '
' : '') + '
';
}
function zonesField(i, path, selected, help) {
var id = 'evp-' + i + '-zones';
return '
' +
'
' + help + ' Ctrl-click for several.
';
}
function featureBody(p, i) {
var inZones = data.features.filter(function (f) { return f.zones.length; }), others = data.features.filter(function (f) { return !f.zones.length; });
function option(f) { return ''; }
var known = !p.config.feature || feature(p.config.feature);
var f = feature(p.config.feature), info = [];
if (f) {
if (f.description) info.push(esc(f.description));
if (f.version) info.push('FeatureGating: from client version ' + esc(f.version) + (f.unlocked ? ' (already on at ' + esc(data.clientVersion) + ', so it changes nothing in the zones)' : ''));
info.push(f.zones.length ? 'Objects in: ' + f.zones.map(function (z) { return esc(z.name) + ' (' + esc(z.objects) + ')'; }).join(', ') +
'. Worlds of these zones that are running when it starts or ends need a restart.' : 'No zone has objects gated on it; it only reaches the client at login.');
}
return '' +
'
' + info.map(function (x) { return '
' + x + '
'; }).join('') + '
' +
'
It goes in a free event_1–event_8 setting while the event is on; players get it at their next login.
';
}
function vanityFiles() { return pickers ? pickers.files : []; }
function vanityBody(p, i) {
if (!pickers) { loadPickers(); return '
Its NPCs are laid over the others: one with the same name as a vanity NPC replaces it (all of its locations). A new name makes an empty file when you save; root.xml shouldn\'t load it.
' +
'
' +
'' +
'
';
}
function liveConfigBody(p, i) {
var c = p.config.config || {}, type = p.config.type;
switch (type) {
case 'treasure_hunt':
return '' +
'
' + ['count|Treasures|1', 'coins|Coins per find|0', 'radius|Pickup distance|2'].map(function (x) {
var bits = x.split('|');
return '
' +
field(i, 'message', 'Said when it starts (optional)', c.message, 'maxlength="300"') +
zonesField(i, 'zones', c.zones, c.type === 'bonus' ? 'None: every world.' : 'Where it runs.') +
field(i, 'instance', 'Instance', c.instance, 'type="number" min="-1"', '-1: every instance of those zones.') +
liveConfigBody(p, i) +
'
It starts when the event does and ends when it ends (a live event runs at most 7 days).
';
}
function announcementBody(p, i) {
var c = p.config;
return field(i, 'title', 'Title (optional)', c.title, 'maxlength="100"') +
'' +
'' +
field(i, 'repeat', 'Repeat while it is on (optional)', c.repeat, 'placeholder="@every 2h or 0 */3 * * *" spellcheck="false"', 'A schedule as on the Scheduled Announcements page (cron in UTC, or @every). At most once a minute.') +
field(i, 'endMessage', 'Say when it ends (optional)', c.endMessage, 'maxlength="1000"') +
zonesField(i, 'zones', c.zones, 'None: every world.');
}
function restartBody(p, i) {
var c = p.config;
return '
' +
'
' + field(i, 'minutes', 'Warn players this many minutes before', c.minutes, 'type="number" min="1" max="1440"') + '