path: root/src/App.vue

<template>
<div class="absolute left-0 top-0 w-screen h-screen overflow-hidden flex flex-col">
	<!-- Title bar -->
	<div class="flex gap-2 p-2" :style="{backgroundColor: store.color.bgDark2}">
		<h1 class="my-auto ml-2 text-4xl" :style="{color: store.color.altDark}">Histplorer</h1>
		<div class="mx-auto"/> <!-- Spacer -->
		<!-- Icons -->
		<icon-button :size="45" :style="buttonStyles">
			<help-icon/>
		</icon-button>
		<icon-button :size="45" :style="buttonStyles" @click="settingsOpen = true" title="Show settings">
			<settings-icon/>
		</icon-button>
		<icon-button :size="45" :style="buttonStyles" @click="onTimelineAdd" title="Add a timeline">
			<plus-icon/>
		</icon-button>
		<icon-button :size="45" :style="buttonStyles" @click="searchOpen = true" title="Search">
			<search-icon/>
		</icon-button>
	</div>
	<!-- Content area -->
	<div class="grow min-h-0 flex" :class="{'flex-col': !vert}"
			:style="{backgroundColor: store.color.bg}" ref="contentAreaRef">
		<time-line v-for="(state, idx) in timelines" :key="state.id"
			:vert="vert" :initialState="state" :closeable="timelines.length > 1"
			:eventTree="eventTree" :unitCountMaps="unitCountMaps" :searchTarget="timelineTargets[idx]"
			class="grow basis-full min-h-0 outline outline-1"
			@close="onTimelineClose(idx)" @state-chg="onTimelineChg($event, idx)" @event-display="onEventDisplay"
			@info-click="onInfoClick"/>
		<base-line :vert="vert" :timelines="timelines" class='m-1 sm:m-2'/>
	</div>
	<!-- Modals -->
	<transition name="fade">
		<search-modal v-if="searchOpen" :eventTree="eventTree" :titleToEvent="titleToEvent"
			@close="searchOpen = false" @search="onSearch" @info-click="onInfoClick"/>
	</transition>
	<transition name="fade">
		<info-modal v-if="infoModalData != null" :eventInfo="infoModalData" @close="infoModalData = null"/>
	</transition>
	<transition name="fade">
		<settings-modal v-if="settingsOpen" @close="settingsOpen = false"/>
	</transition>
</div>
</template>

<script setup lang="ts">
import {ref, computed, onMounted, onUnmounted, Ref, shallowRef, ShallowRef} from 'vue';
// Components
import TimeLine from './components/TimeLine.vue';
import BaseLine from './components/BaseLine.vue';
import InfoModal from './components/InfoModal.vue';
import SearchModal from './components/SearchModal.vue';
import SettingsModal from './components/SettingsModal.vue';
import IconButton from './components/IconButton.vue';
// Icons
import HelpIcon from './components/icon/HelpIcon.vue';
import SettingsIcon from './components/icon/SettingsIcon.vue';
import PlusIcon from './components/icon/PlusIcon.vue';
import SearchIcon from './components/icon/SearchIcon.vue';
// Other
import {HistDate, HistEvent, queryServer,
	EventResponseJson, jsonToHistEvent, EventInfo, EventInfoJson, jsonToEventInfo,
	SCALES, stepDate, TimelineState, cmpHistEvent, dateToUnit, DateRangeTree} from './lib';
import {useStore} from './store';
import {RBTree, rbtree_shallow_copy} from './rbtree';

// Refs
const contentAreaRef = ref(null as HTMLElement | null);

// Global store
const store = useStore();

// For content sizing (used to decide between horizontal and vertical mode)
const contentWidth = ref(0);
const contentHeight = ref(0);
const vert = computed(() => contentHeight.value > contentWidth.value);
function updateAreaDims(){
	let contentAreaEl = contentAreaRef.value!;
	contentWidth.value = contentAreaEl.offsetWidth;
	contentHeight.value = contentAreaEl.offsetHeight;
}
onMounted(updateAreaDims);

// Timeline data
const timelines: Ref<TimelineState[]> = ref([]);
let nextTimelineId = 1;
function addTimeline(){
	if (timelines.value.length == 0){
		timelines.value.push(new TimelineState(nextTimelineId, store.initialStartDate, store.initialEndDate));
	} else {
		let last = timelines.value[timelines.value.length - 1];
		timelines.value.push(new TimelineState(
			nextTimelineId, last.startDate,
			last.endDate, last.startOffset, last.endOffset, last.scaleIdx
		));
	}
	timelineTargets.value.push([null, false]);
	nextTimelineId++;
}
onMounted(addTimeline);
function onTimelineChg(state: TimelineState, idx: number){
	timelines.value[idx] = state;
}

// For timeline addition/removal
const MIN_TIMELINE_BREADTH = store.mainlineBreadth + store.spacing * 2 + store.eventImgSz + store.eventLabelHeight;
function onTimelineAdd(){
	if (vert.value && contentWidth.value / (timelines.value.length + 1) < MIN_TIMELINE_BREADTH ||
		!vert.value && contentHeight.value / (timelines.value.length + 1) < MIN_TIMELINE_BREADTH){
		console.log('Reached timeline minimum breadth');
		return;
	}
	addTimeline();
}
function onTimelineClose(idx: number){
	if (timelines.value.length == 1){
		console.log('Ignored removal of last timeline')
		return;
	}
	timelines.value.splice(idx, 1);
	timelineTargets.value.splice(idx, 1);
}

// For storing and looking up events
const eventTree: ShallowRef<RBTree<HistEvent>> = shallowRef(new RBTree(cmpHistEvent));
let idToEvent: Map<number, HistEvent> = new Map();
let titleToEvent: Map<string, HistEvent> = new Map();
const unitCountMaps: Ref<Map<number, number>[]> = ref(SCALES.map(() => new Map()));
	// For each scale, maps units to event counts
// For keeping event data under a memory limit
const EXCESS_EVENTS_THRESHOLD = 10000;
let displayedEvents: Map<number, number[]> = new Map(); // Maps TimeLine IDs to IDs of displayed events
function reduceEvents(){
	// Get events to keep
	let eventsToKeep: Map<number, HistEvent> = new Map();
	for (let [, ids] of displayedEvents){
		for (let id of ids){
			eventsToKeep.set(id, idToEvent.get(id)!);
		}
	}
	// Create new event tree
	let newTree = new RBTree(cmpHistEvent);
	for (let [, event] of eventsToKeep){
		newTree.insert(event);
	}
	// Create new unit-count maps
	let newMaps: Map<number, number>[] = SCALES.map(() => new Map());
	for (let timeline of timelines.value){
		if (timeline.scaleIdx == null){
			continue;
		}
		// Look for units to keep
		const scaleIdx = timeline.scaleIdx;
		const scale = SCALES[scaleIdx];
		let startUnit = dateToUnit(stepDate(timeline.startDate, scale, {forward: false}), scale);
		let endUnit = dateToUnit(stepDate(timeline.endDate, scale), scale);
		for (let [unit, count] of unitCountMaps.value[scaleIdx]){
			if (unit >= startUnit && unit <= endUnit){
				newMaps[scaleIdx].set(unit, count);
			}
		}
	}
	// Replace old data
	eventTree.value = newTree;
	unitCountMaps.value = newMaps;
	idToEvent = eventsToKeep;
	titleToEvent = new Map();
	for (let event of eventsToKeep.values()){
		titleToEvent.set(event.title, event);
	}
}
// For getting events from server
const EVENT_REQ_LIMIT = 300;
const MAX_EVENTS_PER_UNIT = 4; // Should equal MAX_DISPLAYED_PER_UNIT in backend gen_disp_data.py
let queriedRanges: DateRangeTree[] = SCALES.map(() => new DateRangeTree());
	// For each scale, holds date ranges for which data has already been queried fromm the server
const SERVER_QUERY_TIMEOUT = 200 // Used to throttle server queries
let eventDisplayHdlr = 0;
let lastQueriedRange: [HistDate, HistDate] | null = null;
async function onEventDisplay(
		timelineId: number, eventIds: number[], firstDate: HistDate, lastDate: HistDate, scaleIdx: number){
	async function handleEvent(
			timelineId: number, eventIds: number[], firstDate: HistDate, lastDate: HistDate, scaleIdx: number){
		let timelineIdx = timelines.value.findIndex((s : TimelineState) => s.id == timelineId);
		let targetEvent = timelineTargets.value[timelineIdx][0];
		// Skip if range has been queried, and enough of its events have been obtained
		if (queriedRanges[scaleIdx].contains([firstDate, lastDate])
				&& (targetEvent == null || idToEvent.has(targetEvent.id))){
			// Get number of events in range, server-side
			let fullCount = 0;
			let date = firstDate.clone();
			let eventCounts: Map<number, number> = new Map(); // For calculating number of events, client-side
			while (date.isEarlier(lastDate)){
				let unit = dateToUnit(date, SCALES[scaleIdx]);
				if (unitCountMaps.value[scaleIdx].has(unit)){
					fullCount += Math.min(MAX_EVENTS_PER_UNIT, unitCountMaps.value[scaleIdx].get(unit)!);
				}
				eventCounts.set(unit, 0);
				stepDate(date, SCALES[scaleIdx], {inplace: true});
			}
			if (fullCount > 0){
				// Get number of events, client-side
				let eventCount = 0;
				let itr = eventTree.value.lowerBound(new HistEvent(0, '', firstDate))
				while (itr.data() != null){
					let event = itr.data()!;
					itr.next();
					if (!event.start.isEarlier(lastDate)){
						break;
					}
					let unit = dateToUnit(event.start, SCALES[scaleIdx]);
					if (eventCounts.has(unit)){
						eventCounts.set(unit, eventCounts.get(unit)! + 1);
					}
				}
				for (let [, count] of eventCounts.entries()){
					eventCount += Math.min(MAX_EVENTS_PER_UNIT, count);
				}
				// If we have enough events
				if (eventCount >= fullCount || eventCount >= EVENT_REQ_LIMIT){
					return;
				}
			}
		}
		// Get events from server
		if (lastQueriedRange != null && lastQueriedRange[0].equals(firstDate) && lastQueriedRange[1].equals(lastDate)
				&& (targetEvent == null || idToEvent.has(targetEvent.id))){
			console.log(`INFO: Skipping redundant server request from ${firstDate} to ${lastDate}`);
			return;
		}
		lastQueriedRange = [firstDate, lastDate];
		let urlParams = new URLSearchParams({
			type: 'events',
			range: `${firstDate}.${lastDate}`,
			scale: String(SCALES[scaleIdx]),
			limit: String(EVENT_REQ_LIMIT),
		});
		if (targetEvent != null){
			urlParams.append('incl', String(targetEvent.id));
		}
		let responseObj: EventResponseJson | null = await queryServer(urlParams);
		if (responseObj == null){
			console.log('WARNING: Server gave null response to event query');
			return;
		}
		queriedRanges[scaleIdx].add([firstDate, lastDate]);
		// Collect events
		let eventAdded = false;
		for (let eventObj of responseObj.events){
			let event = jsonToHistEvent(eventObj);
			let success = eventTree.value.insert(event);
			if (success){
				eventAdded = true;
				idToEvent.set(event.id, event);
				titleToEvent.set(event.title, event);
			}
		}
		if (targetEvent != null){
			if (!idToEvent.has(targetEvent.id)){
				console.log(`WARNING: Server response did not include event matching 'incl=${targetEvent.id}'`);
			}
			timelineTargets.value[timelineIdx][0] = null;
		}
		// Collect unit counts
		const unitCounts = responseObj.unitCounts;
		if (unitCounts == null){
			console.log('WARNING: Exceeded unit-count limit for server query');
		} else {
			for (let [unitStr, count] of Object.entries(unitCounts)){
				let unit = parseInt(unitStr)
				if (isNaN(unit)){
					console.log('WARNING: Invalid non-integer unit value in server response');
					break;
				}
				unitCountMaps.value[scaleIdx].set(unit, count)
			}
		}
		// Notify components if new events were added
		if (eventAdded){
			eventTree.value = rbtree_shallow_copy(eventTree.value); // Note: triggerRef(eventTree) does not work here
		}
		// Check memory limit
		displayedEvents.set(timelineId, eventIds);
		if (eventTree.value.size > EXCESS_EVENTS_THRESHOLD){
			console.log(`INFO: Calling reduceEvents() upon reaching ${eventTree.value.size} events`);
			reduceEvents();
			queriedRanges.forEach((t: DateRangeTree) => t.clear());
		}
	}
	clearTimeout(eventDisplayHdlr);
	eventDisplayHdlr = window.setTimeout(async () => {
		await handleEvent(timelineId, eventIds, firstDate, lastDate, scaleIdx);
	}, SERVER_QUERY_TIMEOUT);
}

// For info modal
const infoModalData = ref(null as EventInfo | null);
async function onInfoClick(eventTitle: string){
	// Query server for event info
	let urlParams = new URLSearchParams({type: 'info', event: eventTitle});
	let responseObj: EventInfoJson | null = await queryServer(urlParams);
	if (responseObj != null){
		infoModalData.value = jsonToEventInfo(responseObj);
	} else {
		console.log('WARNING: Server gave null response to info query');
	}
}

// For search modal
const searchOpen = ref(false);
const timelineTargets = ref([] as [HistEvent | null, boolean][]); // For communicating search results to timelines
	// A boolean flag is used to trigger jumping even when the same event occurs twice
function onSearch(event: HistEvent){
	searchOpen.value = false;
	// Trigger jump in endmost timeline
	let timelineIdx = timelineTargets.value.length - 1;
	let oldFlag = timelineTargets.value[timelineIdx];
	timelineTargets.value.splice(timelineIdx, 1, [event, !oldFlag[1]]);
}

// For settings modal
const settingsOpen = ref(false);

// For resize handling
let lastResizeHdlrTime = 0; // Used to throttle resize handling
let afterResizeHdlr = 0; // Used to trigger handler after ending a run of resize events
async function onResize(){
	// Handle event if not recently done
	async function handleResize(){
		updateAreaDims();
	}
	clearTimeout(afterResizeHdlr);
	let currentTime = new Date().getTime();
	if (currentTime - lastResizeHdlrTime > 200){
		lastResizeHdlrTime = currentTime;
		await handleResize();
		lastResizeHdlrTime = new Date().getTime();
	} else {
		// Set up handler to execute after ending a run of resize events
		afterResizeHdlr = window.setTimeout(async () => {
			afterResizeHdlr = 0;
			await handleResize();
			lastResizeHdlrTime = new Date().getTime();
		}, 200); // If too small, touch-device detection when swapping to/from mobile-mode gets unreliable
	}
}
onMounted(() => window.addEventListener('resize', onResize));
onUnmounted(() => window.removeEventListener('resize', onResize));

// For keyboard shortcuts
function onKeyDown(evt: KeyboardEvent){
	if (store.disableShortcuts){
		return;
	}
	if (evt.key == 'Escape'){
		if (infoModalData.value != null){
			infoModalData.value = null;
		} else if (searchOpen.value){
			searchOpen.value = false;
		}
	} else if (evt.key == 'f' && evt.ctrlKey){
		evt.preventDefault();
		// Open/focus search bar
		if (!searchOpen.value){
			searchOpen.value = true;
		}
	}
}
onMounted(() => {
	window.addEventListener('keydown', onKeyDown);
		// Note: Need 'keydown' instead of 'keyup' to override default CTRL-F
});
onUnmounted(() => {
	window.removeEventListener('keydown', onKeyDown);
});

// Styles
const buttonStyles = computed(() => ({
	color: store.color.text,
	backgroundColor: store.color.altDark2,
}));
</script>