strepsirrhini/libreoffice-online
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
libreoffice-online/common/Common.hpp

54 lines
1.8 KiB
C++
Raw Normal View History

loolwsd: moved config values into common header Change-Id: Ib88379e453f207a6a5e6223045a393c769082be4 Reviewed-on: https://gerrit.libreoffice.org/20978 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2015-12-27 16:23:43 -06:00
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
Use #pragma once LibreOffice core uses that, too, and we support an even more restricted set of compilers. Change-Id: I0d0e2c8608e323eb5ef0f35ee8c46d02ab49a745 Reviewed-on: https://gerrit.libreoffice.org/c/online/+/92467 Tested-by: Jenkins CollaboraOffice <jenkinscollaboraoffice@gmail.com> Reviewed-by: Tor Lillqvist <tml@collabora.com>
2020-04-18 03:39:50 -05:00
#pragma once
Switch local prisoner sockets to abstract UDS Unix Domain Sockets are inaddressable remotely, and more efficient, as well as allowing future SCM_CREDENTIALS / SCM_RIGHTS. Change-Id: Ia2472260f75feb43e9022cdfa0fe005ccd489454
2019-03-30 09:06:16 -05:00
#include <string>
loolwsd: moved config values into common header Change-Id: Ib88379e453f207a6a5e6223045a393c769082be4 Reviewed-on: https://gerrit.libreoffice.org/20978 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2015-12-27 16:23:43 -06:00
// Default values and other shared data between processes.
loolwsd: removed dead code Variables and options lingering from previous iterations removed. Standardizing static member names. Header inclusion cleanups. Change-Id: I65182ad4d100e0077f1b450be50cf95d7b8f0fc7 Reviewed-on: https://gerrit.libreoffice.org/20997 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2015-12-28 15:34:21 -06:00
constexpr int DEFAULT_CLIENT_PORT_NUMBER = 9980;
loolwsd: all timeouts in milliseconds Change-Id: Ic5db4e13b2caba53fcbeea0bfdb10d112f2d5a18 Reviewed-on: https://gerrit.libreoffice.org/29942 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2016-10-14 22:00:33 -05:00
loolwsd: command timeout is now a const Change-Id: I9115f465fe760f4c388294bfb5e14cbb441c1174 Reviewed-on: https://gerrit.libreoffice.org/23979 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2016-04-10 21:16:04 -05:00
constexpr int COMMAND_TIMEOUT_MS = 5000;
wsd: dynamic child timeout The initial child spawning takes significantly longer than subsequent ones (for obvious reasons) and this lead to unit-tests being sensitive to the timeout we use for child spawning. Too short, and we spawn more than we want on startup, too long and crash-recovery tests fail (we don't recover fast enough, as we wait too long before spawning new children). Dynamically setting the timeout allows us to give longer timeout at startup, and reduce it afterwards. Reviewed-on: https://gerrit.libreoffice.org/81194 Reviewed-by: Andras Timar <andras.timar@collabora.com> Tested-by: Andras Timar <andras.timar@collabora.com> (cherry picked from commit 32fa1d95fc2ec65866d0cb47d619885182db7040) Change-Id: I8423f5c6619e57030ab43d519aaa41d8712c36d3 Reviewed-on: https://gerrit.libreoffice.org/81570 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2019-10-18 07:10:12 -05:00
constexpr int CHILD_TIMEOUT_MS = COMMAND_TIMEOUT_MS;
loolwsd: all timeouts in milliseconds Change-Id: Ic5db4e13b2caba53fcbeea0bfdb10d112f2d5a18 Reviewed-on: https://gerrit.libreoffice.org/29942 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2016-10-14 22:00:33 -05:00
constexpr int CHILD_REBALANCE_INTERVAL_MS = CHILD_TIMEOUT_MS / 10;
Poll - switch to ppoll for closer to microsecond accuracy. Change-Id: Ib8a2bb6f60302df8631edadbbb8db626894c457c Reviewed-on: https://gerrit.libreoffice.org/c/online/+/92000 Tested-by: Jenkins CollaboraOffice <jenkinscollaboraoffice@gmail.com> Reviewed-by: Michael Meeks <michael.meeks@collabora.com>
2020-04-09 08:43:51 -05:00
constexpr int POLL_TIMEOUT_MICRO_S = (COMMAND_TIMEOUT_MS / 5) * 1000;
loolwsd: all timeouts in milliseconds Change-Id: Ic5db4e13b2caba53fcbeea0bfdb10d112f2d5a18 Reviewed-on: https://gerrit.libreoffice.org/29942 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2016-10-14 22:00:33 -05:00
constexpr int WS_SEND_TIMEOUT_MS = 1000;
loolwsd: PIPE_BUFFER -> READ_BUFFER_SIZE = 2048 Change-Id: I12e9725549a15b2cb1c287db9de0fca732dafac2 Reviewed-on: https://gerrit.libreoffice.org/21678 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2016-01-21 07:49:43 -06:00
Upper limit of sent out versions of the same tile We try to decrease the network usage with avoiding sending out to much tiles to the client. When we already sent out two versions of the same tile without having the tileprocessed message from the client we delay sending out the next version to avoid spamming tiles on the network. Change-Id: Ia47cd7c0d3fb829f6777f0c3265970433591df19
2018-09-28 12:30:57 -05:00
constexpr int TILE_ROUNDTRIP_TIMEOUT_MS = 5000;
loolwsd: PIPE_BUFFER -> READ_BUFFER_SIZE = 2048 Change-Id: I12e9725549a15b2cb1c287db9de0fca732dafac2 Reviewed-on: https://gerrit.libreoffice.org/21678 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2016-01-21 07:49:43 -06:00
/// Pipe and Socket read buffer size.
/// Should be large enough for ethernet packets
/// which can be 1500 bytes long.
IoUtil: avoid multiplying at int precision, then comparing to long Here: if (payload.capacity() > READ_BUFFER_SIZE * 4) Change-Id: I12e090d03b471b7394a4898d5e1a74992182051e
2016-12-01 11:15:46 -06:00
constexpr long READ_BUFFER_SIZE = 64 * 1024;
loolwsd: use larger threshold to large messages Messages larger than a certain size are preambled with a 'nextmessage' message that hold the size of the subsequent message. This is a workaround to a limitation the Poco WebSocket API where if the buffer size is smaller than the received frame the socket ends up in a bad state and must be closed. Unfortunately the new API that avoids this workaround is not yet released by Poco. Here we minimize the need for 'nextmessage' to truely large messages. The limit is now raised from above 1KB to over 63KB. We may raise this limit further, but that will cost each socket that much dedicated buffer size. Change-Id: I01e4c68cdbe67e413c04a9725152224a87ab8267 Reviewed-on: https://gerrit.libreoffice.org/31286 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2016-11-26 21:28:48 -06:00
loolwsd: SocketProcessor cleanup Change-Id: I120574dce169e1e8149aeba9d982b8235fa034fb Reviewed-on: https://gerrit.libreoffice.org/30828 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2016-11-13 20:52:02 -06:00
/// Message larger than this will be dropped as invalid
/// or as intentionally flooding the server.
loolwsd: use larger threshold to large messages Messages larger than a certain size are preambled with a 'nextmessage' message that hold the size of the subsequent message. This is a workaround to a limitation the Poco WebSocket API where if the buffer size is smaller than the received frame the socket ends up in a bad state and must be closed. Unfortunately the new API that avoids this workaround is not yet released by Poco. Here we minimize the need for 'nextmessage' to truely large messages. The limit is now raised from above 1KB to over 63KB. We may raise this limit further, but that will cost each socket that much dedicated buffer size. Change-Id: I01e4c68cdbe67e413c04a9725152224a87ab8267 Reviewed-on: https://gerrit.libreoffice.org/31286 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2016-11-26 21:28:48 -06:00
constexpr int MAX_MESSAGE_SIZE = 2 * 1024 * READ_BUFFER_SIZE;
loolwsd: SocketProcessor cleanup Change-Id: I120574dce169e1e8149aeba9d982b8235fa034fb Reviewed-on: https://gerrit.libreoffice.org/30828 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2016-11-13 20:52:02 -06:00
Use correct path in the client websockets. Change-Id: Ie0bf6646ff3f6e6cf99b505143a416c86a3a33b8
2018-05-07 08:09:40 -05:00
constexpr const char JAILED_DOCUMENT_ROOT[] = "/user/docs/";
constexpr const char CHILD_URI[] = "/loolws/child?";
constexpr const char NEW_CHILD_URI[] = "/loolws/newchild";
constexpr const char LO_JAIL_SUBPATH[] = "lo";
Replaced pipe with websocket based on Unix socket in communication with ForKit Change-Id: I80f1a4e84ca6820503966a8ee5d9958a150eac14 Reviewed-on: https://gerrit.libreoffice.org/c/online/+/91585 Tested-by: Jenkins CollaboraOffice <jenkinscollaboraoffice@gmail.com> Reviewed-by: Michael Meeks <michael.meeks@collabora.com>
2020-04-02 10:11:36 -05:00
constexpr const char FORKIT_URI[] = "/loolws/forkit";
loolwsd: refactored JailedDocumentRoot path Change-Id: Ibee16e6ebde0ae1945be53903a0b0bad4f3300ed Reviewed-on: https://gerrit.libreoffice.org/21179 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2016-01-06 12:49:10 -06:00
Add /hosting/capabilities endpoint to advertise online features Add an entry to discovery.xml with the urlsrc where capabilities end point can be found. Use json format to send back the feature list. Change-Id: I390a53d956d53ca79e5a8090aead7f4131ec4ca0
2018-10-19 11:14:48 -05:00
constexpr const char CAPABILITIES_END_POINT[] = "/hosting/capabilities";
wsd: include version in http agent strings And move the WOPI agent string to Common.hpp. Change-Id: Ife679705bcd6914ddd45ad50446e690fb22dd317 Reviewed-on: https://gerrit.libreoffice.org/37607 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2017-05-14 14:17:19 -05:00
/// The HTTP response User-Agent.
Use compile-time rather than run-time string concatenation. Saves some time & space. Change-Id: If1e62056447fb7e8f26e8cf107451876adf3fecb
2019-05-20 06:11:38 -05:00
#define HTTP_AGENT_STRING "LOOLWSD HTTP Agent " LOOLWSD_VERSION
wsd: include version in http agent strings And move the WOPI agent string to Common.hpp. Change-Id: Ife679705bcd6914ddd45ad50446e690fb22dd317 Reviewed-on: https://gerrit.libreoffice.org/37607 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2017-05-14 14:17:19 -05:00
/// The WOPI User-Agent.
Use compile-time rather than run-time string concatenation. Saves some time & space. Change-Id: If1e62056447fb7e8f26e8cf107451876adf3fecb
2019-05-20 06:11:38 -05:00
#define WOPI_AGENT_STRING "LOOLWSD WOPI Agent " LOOLWSD_VERSION
nb: process POST requests These are really GET requests that aren't WebSocket upgrade. Should rename to something less misleading. Re-enabled testSlideShow which depended on this. Change-Id: I52b7f67b650fcdcbae7c2bff020b756099263141
2017-02-28 18:34:21 -06:00
Remove confusing ChildProcessSession include on LOOLWSD. Move the ClientPortNumber into both Kit and WSD.
2016-04-14 12:04:19 -05:00
// The client port number, both loolwsd and the kits have this.
extern int ClientPortNumber;
Switch local prisoner sockets to abstract UDS Unix Domain Sockets are inaddressable remotely, and more efficient, as well as allowing future SCM_CREDENTIALS / SCM_RIGHTS. Change-Id: Ia2472260f75feb43e9022cdfa0fe005ccd489454
2019-03-30 09:06:16 -05:00
extern std::string MasterLocation;
Remove confusing ChildProcessSession include on LOOLWSD. Move the ClientPortNumber into both Kit and WSD.
2016-04-14 12:04:19 -05:00
loolwsd: moved config values into common header Change-Id: Ib88379e453f207a6a5e6223045a393c769082be4 Reviewed-on: https://gerrit.libreoffice.org/20978 Reviewed-by: Ashod Nakashian <ashnakash@gmail.com> Tested-by: Ashod Nakashian <ashnakash@gmail.com>
2015-12-27 16:23:43 -06:00
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in a new issue Copy permalink