/** * @copyright 2019 Christoph Wurst * * @author Christoph Wurst * @author John Molakvoæ * @author Julius Härtl * @author Roeland Jago Douma * * @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 . * */ import $ from 'jquery' import { emit } from '@nextcloud/event-bus' import { loadState } from '@nextcloud/initial-state' import { getCurrentUser } from '@nextcloud/auth' import { generateUrl } from '@nextcloud/router' import OC from './OC/index.js' import { setToken as setRequestToken, getToken as getRequestToken } from './OC/requesttoken.js' let config = null /** * The legacy jsunit tests overwrite OC.config before calling initCore * therefore we need to wait with assigning the config fallback until initCore calls initSessionHeartBeat */ const loadConfig = () => { try { config = loadState('core', 'config') } catch (e) { // This fallback is just for our legacy jsunit tests since we have no way to mock loadState calls config = OC.config } } /** * session heartbeat (defaults to enabled) * * @return {boolean} */ const keepSessionAlive = () => { return config.session_keepalive === undefined || !!config.session_keepalive } /** * get interval in seconds * * @return {number} */ const getInterval = () => { let interval = NaN if (config.session_lifetime) { interval = Math.floor(config.session_lifetime / 2) } // minimum one minute, max 24 hours, default 15 minutes return Math.min( 24 * 3600, Math.max( 60, isNaN(interval) ? 900 : interval ) ) } const getToken = async () => { const url = generateUrl('/csrftoken') // Not using Axios here as Axios is not stubbable with the sinon fake server // see https://stackoverflow.com/questions/41516044/sinon-mocha-test-with-async-ajax-calls-didnt-return-promises // see js/tests/specs/coreSpec.js for the tests const resp = await $.get(url) return resp.token } const poll = async () => { try { const token = await getToken() setRequestToken(token) } catch (e) { console.error('session heartbeat failed', e) } } const startPolling = () => { const interval = setInterval(poll, getInterval() * 1000) console.info('session heartbeat polling started') return interval } const registerAutoLogout = () => { if (!config.auto_logout || !getCurrentUser()) { return } let lastActive = Date.now() window.addEventListener('mousemove', e => { lastActive = Date.now() localStorage.setItem('lastActive', lastActive) }) window.addEventListener('touchstart', e => { lastActive = Date.now() localStorage.setItem('lastActive', lastActive) }) window.addEventListener('storage', e => { if (e.key !== 'lastActive') { return } lastActive = e.newValue }) setInterval(function() { const timeout = Date.now() - config.session_lifetime * 1000 if (lastActive < timeout) { console.info('Inactivity timout reached, logging out') const logoutUrl = generateUrl('/logout') + '?requesttoken=' + encodeURIComponent(getRequestToken()) window.location = logoutUrl } }, 1000) } /** * Calls the server periodically to ensure that session and CSRF * token doesn't expire */ export const initSessionHeartBeat = () => { loadConfig() registerAutoLogout() if (!keepSessionAlive()) { console.info('session heartbeat disabled') return } let interval = startPolling() window.addEventListener('online', async () => { console.info('browser is online again, resuming heartbeat') interval = startPolling() try { await poll() console.info('session token successfully updated after resuming network') // Let apps know we're online and requests will have the new token emit('networkOnline', { success: true, }) } catch (e) { console.error('could not update session token after resuming network', e) // Let apps know we're online but requests might have an outdated token emit('networkOnline', { success: false, }) } }) window.addEventListener('offline', () => { console.info('browser is offline, stopping heartbeat') // Let apps know we're offline emit('networkOffline', {}) clearInterval(interval) console.info('session heartbeat polling stopped') }) }