THANASOFT-HFC/calendar/src/store/fetchedTimeRanges.js

/**
 * @copyright Copyright (c) 2019 Georg Ehrke
 *
 * @author Georg Ehrke <oc.list@georgehrke.com>
 *
 * @license AGPL-3.0-or-later
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */
import Vue from 'vue'

const state = {
	lastTimeRangeInsertId: -1,
	fetchedTimeRanges: [],
	fetchedTimeRangesById: {},
}

const mutations = {

	/**
	 * Adds a fetched time-range to the state
	 *
	 * @param {object} state The vuex state
	 * @param {object} data The destructuring object
	 * @param {string} data.calendarId Calendar-id which objects have been fetched
	 * @param {number} data.from timestamp of start
	 * @param {number} data.to timestamp of end
	 * @param {number} data.lastFetched timestamp of last-fetched
	 * @param {string[]} data.calendarObjectIds array of calendarObjectIds
	 */
	addTimeRange(state, { calendarId, from, to, lastFetched, calendarObjectIds }) {
		const fetchedTimeRange = {
			id: ++state.lastTimeRangeInsertId,
			calendarId,
			from,
			to,
			lastFetched,
			calendarObjectIds,
		}

		state.fetchedTimeRanges.push(fetchedTimeRange)
		Vue.set(state.fetchedTimeRangesById, fetchedTimeRange.id, fetchedTimeRange)
	},

	/**
	 * Removes a fetched time-range from the state
	 *
	 * @param {object} state The vuex state
	 * @param {object} data The destructuring object
	 * @param {number} data.timeRangeId Id of time-range to remove
	 */
	removeTimeRange(state, { timeRangeId }) {
		const obj = state.fetchedTimeRangesById[timeRangeId]
		const index = state.fetchedTimeRanges.indexOf(obj)

		if (index !== -1) {
			state.fetchedTimeRanges.splice(index, 1)
			Vue.delete(state.fetchedTimeRangesById, timeRangeId)
		}
	},

	/**
	 * Adds a calendar-object-id to an already fetched time-range
	 *
	 * @param {object} state The vuex state
	 * @param {object} data The destructuring object
	 * @param {number} data.timeRangeId The id of the time-range
	 * @param {string[]} data.calendarObjectIds The array of ids of the calendar-object to add
	 */
	appendCalendarObjectIdsToTimeFrame(state, { timeRangeId, calendarObjectIds }) {
		for (const calendarObjectId of calendarObjectIds) {
			if (state.fetchedTimeRangesById[timeRangeId].calendarObjectIds.indexOf(calendarObjectId) === -1) {
				state.fetchedTimeRangesById[timeRangeId].calendarObjectIds.push(calendarObjectId)
			}
		}
	},

	/**
	 * Adds a calendar-object-id to an already fetched time-range
	 *
	 * @param {object} state The vuex state
	 * @param {object} data The destructuring object
	 * @param {number} data.timeRangeId The id of the time-range
	 * @param {string} data.calendarObjectId The id of the calendar-object to add
	 */
	appendCalendarObjectIdToTimeRange(state, { timeRangeId, calendarObjectId }) {
		state.fetchedTimeRangesById[timeRangeId].calendarObjectIds.push(calendarObjectId)
	},

	/**
	 * Removes a calendar-object-id from an already fetched time-range
	 *
	 * @param {object} state The vuex state
	 * @param {object} data The destructuring object
	 * @param {number} data.timeRangeId The id of the timerange
	 * @param {string} data.calendarObjectId The id of the calendar-object to remove
	 */
	removeCalendarObjectIdFromTimeRange(state, { timeRangeId, calendarObjectId }) {
		const index = state.fetchedTimeRangesById[timeRangeId]
			.calendarObjectIds
			.indexOf(calendarObjectId)
		if (index !== -1) {
			state.fetchedTimeRangesById[timeRangeId]
				.calendarObjectIds
				.splice(index, 1)
		}
	},

	/**
	 * Removes a calendar-object-id from any time-range it may occur in
	 *
	 * @param {object} state The vuex state
	 * @param {object} data The destructuring object
	 * @param {string} data.calendarObjectId The id of the calendar-object to remove
	 */
	removeCalendarObjectIdFromAnyTimeRange(state, { calendarObjectId }) {
		for (const timeRange of state.fetchedTimeRanges) {
			const index = timeRange
				.calendarObjectIds
				.indexOf(calendarObjectId)
			if (index !== -1) {
				timeRange
					.calendarObjectIds
					.splice(index, 1)
			}
		}
	},

	/**
	 * Updates the last-fetched timestamp of a time-range
	 *
	 * @param {object} state The vuex state
	 * @param {object} data The destructuring object
	 * @param {number} data.timeRangeId The id of the timerange
	 * @param {number} data.lastFetched Timestamp of last-fetched
	 */
	updateTimestampOfLastFetched(state, { timeRangeId, lastFetched }) {
		state.fetchedTimeRangesById[timeRangeId].lastFetched = lastFetched
	},

	/**
	 * Adds a calendar-object-id to all time-ranges of a given caloendar
	 *
	 * @param {object} state The vuex state
	 * @param {object} data The destructuring object
	 * @param {string} data.calendarObjectId The id of the calendar-object
	 * @param {string} data.calendarId The id of the calendar
	 */
	addCalendarObjectIdToAllTimeRangesOfCalendar(state, { calendarObjectId, calendarId }) {
		for (const timerange of state.fetchedTimeRanges) {
			if (timerange.calendarId !== calendarId) {
				continue
			}

			if (timerange.calendarObjectIds.indexOf(calendarObjectId) === -1) {
				timerange.calendarObjectIds.push(calendarObjectId)
			}
		}
	},

	/**
	 * Removes a calendar-object-id to all time-ranges of a given caloendar
	 *
	 * @param {object} state The vuex state
	 * @param {object} data The destructuring object
	 * @param {string} data.calendarObjectId The id of the calendar-object
	 * @param {string} data.calendarId The id of the calendar
	 */
	removeCalendarObjectIdFromAllTimeRangesOfCalendar(state, { calendarObjectId, calendarId }) {
		for (const timerange of state.fetchedTimeRanges) {
			if (timerange.calendarId !== calendarId) {
				continue
			}

			const index = timerange.calendarObjectIds.indexOf(calendarObjectId)
			if (index !== -1) {
				timerange.calendarObjectIds.splice(index, 1)
			}
		}
	},

	/**
	 * clear FetchedTimeRanges Store
	 *
	 * @param {object} state The vuex state
	 */
	clearFetchedTimeRanges(state) {
		state.lastTimeRangeInsertId = -1
		state.fetchedTimeRanges = []
		state.fetchedTimeRangesById = {}
	},
}

const getters = {

	/**
	 * Get all time-ranges for a calendar
	 *
	 * @param {object} state The vuex state
	 * @return {function({String}): {Object}[]}
	 */
	getAllTimeRangesForCalendar: (state) => (calendarId) =>
		state.fetchedTimeRanges.filter(f => (f.calendarId === calendarId)),

	/**
	 * Get time-range covering
	 *
	 * @param {object} state The vuex state
	 * @return {function({Number}, {Number}, {Number}): {Object}|false}
	 */
	getTimeRangeForCalendarCoveringRange: (state) => (calendarId, requestedFrom, requestedTo) => {
		return state.fetchedTimeRanges.find(f => {
			return f.calendarId === calendarId && f.from <= requestedFrom && f.to >= requestedTo
		})
	},

	/**
	 * Get all time-ranges that have been last fetched before a given time
	 *
	 * @param {object} state The vuex state
	 * @return {function({Number}): {Object}[]}
	 */
	getAllTimeRangesOlderThan: (state) => (olderThan) =>
		state.fetchedTimeRanges.filter(f => (f.lastFetched <= olderThan)),

	/**
	 *
	 * @param {object} state The vuex state
	 * @return {number}
	 */
	getLastTimeRangeInsertId: (state) => state.lastTimeRangeInsertId,

	/**
	 *
	 * @param {object} state The vuex state
	 * @param {object} getters The vuex getters
	 * @return {function({Number}): {CalendarObject}[]}
	 */
	getCalendarObjectsByTimeRangeId: (state, getters) => (timeRangeId) => {
		if (!state.fetchedTimeRangesById[timeRangeId]) {
			return []
		}

		return state.fetchedTimeRangesById[timeRangeId].calendarObjectIds.map((calendarObjectId) => {
			return getters.getCalendarObjectById(calendarObjectId)
		})
	},
}

const actions = {}

export default { state, mutations, getters, actions }