setupchecks.js 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768
  1. /*
  2. * Copyright (c) 2014
  3. *
  4. * This file is licensed under the Affero General Public License version 3
  5. * or later.
  6. *
  7. * See the COPYING-README file.
  8. *
  9. */
  10. (function() {
  11. OC.SetupChecks = {
  12. /* Message types */
  13. MESSAGE_TYPE_INFO:0,
  14. MESSAGE_TYPE_WARNING:1,
  15. MESSAGE_TYPE_ERROR:2,
  16. /**
  17. * Check whether the WebDAV connection works.
  18. *
  19. * @return $.Deferred object resolved with an array of error messages
  20. */
  21. checkWebDAV: function() {
  22. var deferred = $.Deferred();
  23. var afterCall = function(xhr) {
  24. var messages = [];
  25. if (xhr.status !== 207 && xhr.status !== 401) {
  26. messages.push({
  27. msg: t('core', 'Your web server is not yet properly set up to allow file synchronization, because the WebDAV interface seems to be broken.'),
  28. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  29. });
  30. }
  31. deferred.resolve(messages);
  32. };
  33. $.ajax({
  34. type: 'PROPFIND',
  35. url: OC.linkToRemoteBase('webdav'),
  36. data: '<?xml version="1.0"?>' +
  37. '<d:propfind xmlns:d="DAV:">' +
  38. '<d:prop><d:resourcetype/></d:prop>' +
  39. '</d:propfind>',
  40. contentType: 'application/xml; charset=utf-8',
  41. complete: afterCall,
  42. allowAuthErrors: true
  43. });
  44. return deferred.promise();
  45. },
  46. /**
  47. * Check whether the .well-known URLs works.
  48. *
  49. * @param url the URL to test
  50. * @param placeholderUrl the placeholder URL - can be found at OC.theme.docPlaceholderUrl
  51. * @param {boolean} runCheck if this is set to false the check is skipped and no error is returned
  52. * @param {int|int[]} expectedStatus the expected HTTP status to be returned by the URL, 207 by default
  53. * @return $.Deferred object resolved with an array of error messages
  54. */
  55. checkWellKnownUrl: function(verb, url, placeholderUrl, runCheck, expectedStatus, checkCustomHeader) {
  56. if (expectedStatus === undefined) {
  57. expectedStatus = [207];
  58. }
  59. if (!Array.isArray(expectedStatus)) {
  60. expectedStatus = [expectedStatus];
  61. }
  62. var deferred = $.Deferred();
  63. if(runCheck === false) {
  64. deferred.resolve([]);
  65. return deferred.promise();
  66. }
  67. var afterCall = function(xhr) {
  68. var messages = [];
  69. var customWellKnown = xhr.getResponseHeader('X-NEXTCLOUD-WELL-KNOWN')
  70. if (expectedStatus.indexOf(xhr.status) === -1 || (checkCustomHeader && !customWellKnown)) {
  71. var docUrl = placeholderUrl.replace('PLACEHOLDER', 'admin-setup-well-known-URL');
  72. messages.push({
  73. msg: t('core', 'Your web server is not properly set up to resolve "{url}". Further information can be found in the {linkstart}documentation ↗{linkend}.', { url: url })
  74. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + docUrl + '">')
  75. .replace('{linkend}', '</a>'),
  76. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  77. });
  78. }
  79. deferred.resolve(messages);
  80. };
  81. $.ajax({
  82. type: verb,
  83. url: url,
  84. complete: afterCall,
  85. allowAuthErrors: true
  86. });
  87. return deferred.promise();
  88. },
  89. /**
  90. * Check whether the .well-known URLs works.
  91. *
  92. * @param url the URL to test
  93. * @param placeholderUrl the placeholder URL - can be found at OC.theme.docPlaceholderUrl
  94. * @param {boolean} runCheck if this is set to false the check is skipped and no error is returned
  95. *
  96. * @return $.Deferred object resolved with an array of error messages
  97. */
  98. checkProviderUrl: function(url, placeholderUrl, runCheck) {
  99. var expectedStatus = [200];
  100. var deferred = $.Deferred();
  101. if(runCheck === false) {
  102. deferred.resolve([]);
  103. return deferred.promise();
  104. }
  105. var afterCall = function(xhr) {
  106. var messages = [];
  107. if (expectedStatus.indexOf(xhr.status) === -1) {
  108. var docUrl = placeholderUrl.replace('PLACEHOLDER', 'admin-nginx');
  109. messages.push({
  110. msg: t('core', 'Your web server is not properly set up to resolve "{url}". This is most likely related to a web server configuration that was not updated to deliver this folder directly. Please compare your configuration against the shipped rewrite rules in ".htaccess" for Apache or the provided one in the documentation for Nginx at it\'s {linkstart}documentation page ↗{linkend}. On Nginx those are typically the lines starting with "location ~" that need an update.', { docLink: docUrl, url: url })
  111. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + docUrl + '">')
  112. .replace('{linkend}', '</a>'),
  113. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  114. });
  115. }
  116. deferred.resolve(messages);
  117. };
  118. $.ajax({
  119. type: 'GET',
  120. url: url,
  121. complete: afterCall,
  122. allowAuthErrors: true
  123. });
  124. return deferred.promise();
  125. },
  126. /**
  127. * Check whether the WOFF2 URLs works.
  128. *
  129. * @param url the URL to test
  130. * @param placeholderUrl the placeholder URL - can be found at OC.theme.docPlaceholderUrl
  131. * @return $.Deferred object resolved with an array of error messages
  132. */
  133. checkWOFF2Loading: function(url, placeholderUrl) {
  134. var deferred = $.Deferred();
  135. var afterCall = function(xhr) {
  136. var messages = [];
  137. if (xhr.status !== 200) {
  138. var docUrl = placeholderUrl.replace('PLACEHOLDER', 'admin-nginx');
  139. messages.push({
  140. msg: t('core', 'Your web server is not properly set up to deliver .woff2 files. This is typically an issue with the Nginx configuration. For Nextcloud 15 it needs an adjustement to also deliver .woff2 files. Compare your Nginx configuration to the recommended configuration in our {linkstart}documentation ↗{linkend}.', { docLink: docUrl, url: url })
  141. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + docUrl + '">')
  142. .replace('{linkend}', '</a>'),
  143. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  144. });
  145. }
  146. deferred.resolve(messages);
  147. };
  148. $.ajax({
  149. type: 'GET',
  150. url: url,
  151. complete: afterCall,
  152. allowAuthErrors: true
  153. });
  154. return deferred.promise();
  155. },
  156. /**
  157. * Runs setup checks on the server side
  158. *
  159. * @return $.Deferred object resolved with an array of error messages
  160. */
  161. checkSetup: function() {
  162. var deferred = $.Deferred();
  163. var afterCall = function(data, statusText, xhr) {
  164. var messages = [];
  165. if (xhr.status === 200 && data) {
  166. if (!data.isGetenvServerWorking) {
  167. messages.push({
  168. msg: t('core', 'PHP does not seem to be setup properly to query system environment variables. The test with getenv("PATH") only returns an empty response.') + ' ' +
  169. t('core', 'Please check the {linkstart}installation documentation ↗{linkend} for PHP configuration notes and the PHP configuration of your server, especially when using php-fpm.')
  170. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + OC.theme.docPlaceholderUrl.replace('PLACEHOLDER', 'admin-php-fpm') + '">')
  171. .replace('{linkend}', '</a>'),
  172. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  173. });
  174. }
  175. if (data.isReadOnlyConfig) {
  176. messages.push({
  177. msg: t('core', 'The read-only config has been enabled. This prevents setting some configurations via the web-interface. Furthermore, the file needs to be made writable manually for every update.'),
  178. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  179. });
  180. }
  181. if (!data.wasEmailTestSuccessful) {
  182. messages.push({
  183. msg: t('core', 'You have not set or verified your email server configuration, yet. Please head over to the {mailSettingsStart}Basic settings{mailSettingsEnd} in order to set them. Afterwards, use the "Send email" button below the form to verify your settings.',)
  184. .replace('{mailSettingsStart}', '<a href="' + OC.generateUrl('/settings/admin') + '">')
  185. .replace('{mailSettingsEnd}', '</a>'),
  186. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  187. });
  188. }
  189. if (!data.hasValidTransactionIsolationLevel) {
  190. messages.push({
  191. msg: t('core', 'Your database does not run with "READ COMMITTED" transaction isolation level. This can cause problems when multiple actions are executed in parallel.'),
  192. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  193. });
  194. }
  195. if(!data.hasFileinfoInstalled) {
  196. messages.push({
  197. msg: t('core', 'The PHP module "fileinfo" is missing. It is strongly recommended to enable this module to get the best results with MIME type detection.'),
  198. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  199. });
  200. }
  201. if (data.isBruteforceThrottled) {
  202. messages.push({
  203. msg: t('core', 'Your remote address was identified as "{remoteAddress}" and is brute-force throttled at the moment slowing down the performance of various requests. If the remote address is not your address this can be an indication that a proxy is not configured correctly. Further information can be found in the {linkstart}documentation ↗{linkend}.', { remoteAddress: data.bruteforceRemoteAddress })
  204. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + data.reverseProxyDocs + '">')
  205. .replace('{linkend}', '</a>'),
  206. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  207. });
  208. }
  209. if(!data.hasWorkingFileLocking) {
  210. messages.push({
  211. msg: t('core', 'Transactional file locking is disabled, this might lead to issues with race conditions. Enable "filelocking.enabled" in config.php to avoid these problems. See the {linkstart}documentation ↗{linkend} for more information.')
  212. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + OC.theme.docPlaceholderUrl.replace('PLACEHOLDER', 'admin-transactional-locking') + '">')
  213. .replace('{linkend}', '</a>'),
  214. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  215. });
  216. }
  217. if(data.hasDBFileLocking) {
  218. messages.push({
  219. msg: t('core', 'The database is used for transactional file locking. To enhance performance, please configure memcache, if available. See the {linkstart}documentation ↗{linkend} for more information.')
  220. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + OC.theme.docPlaceholderUrl.replace('PLACEHOLDER', 'admin-transactional-locking') + '">')
  221. .replace('{linkend}', '</a>'),
  222. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  223. });
  224. }
  225. if (data.suggestedOverwriteCliURL !== '') {
  226. messages.push({
  227. msg: t('core', 'Please make sure to set the "overwrite.cli.url" option in your config.php file to the URL that your users mainly use to access this Nextcloud. Suggestion: "{suggestedOverwriteCliURL}". Otherwise there might be problems with the URL generation via cron. (It is possible though that the suggested URL is not the URL that your users mainly use to access this Nextcloud. Best is to double check this in any case.)', {suggestedOverwriteCliURL: data.suggestedOverwriteCliURL}),
  228. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  229. });
  230. }
  231. if (!data.isDefaultPhoneRegionSet) {
  232. messages.push({
  233. msg: t('core', 'Your installation has no default phone region set. This is required to validate phone numbers in the profile settings without a country code. To allow numbers without a country code, please add "default_phone_region" with the respective {linkstart}ISO 3166-1 code ↗{linkend} of the region to your config file.')
  234. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements">')
  235. .replace('{linkend}', '</a>'),
  236. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  237. });
  238. }
  239. if (data.cronErrors.length > 0) {
  240. var listOfCronErrors = "";
  241. data.cronErrors.forEach(function(element){
  242. listOfCronErrors += '<li>';
  243. listOfCronErrors += element.error;
  244. listOfCronErrors += ' ';
  245. listOfCronErrors += element.hint;
  246. listOfCronErrors += '</li>';
  247. });
  248. messages.push({
  249. msg: t('core', 'It was not possible to execute the cron job via CLI. The following technical errors have appeared:') + '<ul>' + listOfCronErrors + '</ul>',
  250. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  251. })
  252. }
  253. if (data.cronInfo.diffInSeconds > 3600) {
  254. messages.push({
  255. msg: t('core', 'Last background job execution ran {relativeTime}. Something seems wrong. {linkstart}Check the background job settings ↗{linkend}.', {relativeTime: data.cronInfo.relativeTime})
  256. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + data.cronInfo.backgroundJobsUrl + '">')
  257. .replace('{linkend}', '</a>'),
  258. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  259. });
  260. }
  261. if (!data.isFairUseOfFreePushService) {
  262. messages.push({
  263. msg: t('core', 'This is the unsupported community build of Nextcloud. Given the size of this instance, performance, reliability and scalability cannot be guaranteed. Push notifications are limited to avoid overloading our free service. Learn more about the benefits of Nextcloud Enterprise at {linkstart}https://nextcloud.com/enterprise{linkend}.')
  264. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="https://nextcloud.com/enterprise">')
  265. .replace('{linkend}', '</a>'),
  266. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  267. });
  268. }
  269. if (data.serverHasInternetConnectionProblems) {
  270. messages.push({
  271. msg: t('core', 'This server has no working internet connection: Multiple endpoints could not be reached. This means that some of the features like mounting external storage, notifications about updates or installation of third-party apps will not work. Accessing files remotely and sending of notification emails might not work, either. Establish a connection from this server to the internet to enjoy all features.'),
  272. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  273. });
  274. }
  275. if(!data.isMemcacheConfigured) {
  276. messages.push({
  277. msg: t('core', 'No memory cache has been configured. To enhance performance, please configure a memcache, if available. Further information can be found in the {linkstart}documentation ↗{linkend}.')
  278. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + data.memcacheDocs + '">')
  279. .replace('{linkend}', '</a>'),
  280. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  281. });
  282. }
  283. if(!data.isRandomnessSecure) {
  284. messages.push({
  285. msg: t('core', 'No suitable source for randomness found by PHP which is highly discouraged for security reasons. Further information can be found in the {linkstart}documentation ↗{linkend}.')
  286. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + data.securityDocs + '">')
  287. .replace('{linkend}', '</a>'),
  288. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  289. });
  290. }
  291. if(data.isUsedTlsLibOutdated) {
  292. messages.push({
  293. msg: data.isUsedTlsLibOutdated,
  294. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  295. });
  296. }
  297. if (data.phpSupported && data.phpSupported.eol) {
  298. messages.push({
  299. msg: t('core', 'You are currently running PHP {version}. Upgrade your PHP version to take advantage of {linkstart}performance and security updates provided by the PHP Group ↗{linkend} as soon as your distribution supports it.', { version: data.phpSupported.version })
  300. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="https://secure.php.net/supported-versions.php">')
  301. .replace('{linkend}', '</a>'),
  302. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  303. })
  304. }
  305. if (data.phpSupported && data.phpSupported.version.substr(0, 3) === '8.0') {
  306. messages.push({
  307. msg: t('core', 'PHP 8.0 is now deprecated in Nextcloud 27. Nextcloud 28 may require at least PHP 8.1. Please upgrade to {linkstart}one of the officially supported PHP versions provided by the PHP Group ↗{linkend} as soon as possible.')
  308. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="https://secure.php.net/supported-versions.php">')
  309. .replace('{linkend}', '</a>'),
  310. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  311. })
  312. }
  313. if(!data.forwardedForHeadersWorking) {
  314. messages.push({
  315. msg: t('core', 'The reverse proxy header configuration is incorrect, or you are accessing Nextcloud from a trusted proxy. If not, this is a security issue and can allow an attacker to spoof their IP address as visible to the Nextcloud. Further information can be found in the {linkstart}documentation ↗{linkend}.')
  316. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + data.reverseProxyDocs + '">')
  317. .replace('{linkend}', '</a>'),
  318. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  319. });
  320. }
  321. if(!data.isCorrectMemcachedPHPModuleInstalled) {
  322. messages.push({
  323. msg: t('core', 'Memcached is configured as distributed cache, but the wrong PHP module "memcache" is installed. \\OC\\Memcache\\Memcached only supports "memcached" and not "memcache". See the {linkstart}memcached wiki about both modules ↗{linkend}.')
  324. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="https://code.google.com/p/memcached/wiki/PHPClientComparison">')
  325. .replace('{linkend}', '</a>'),
  326. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  327. });
  328. }
  329. if(!data.hasPassedCodeIntegrityCheck) {
  330. messages.push({
  331. msg: t('core', 'Some files have not passed the integrity check. Further information on how to resolve this issue can be found in the {linkstart1}documentation ↗{linkend}. ({linkstart2}List of invalid files…{linkend} / {linkstart3}Rescan…{linkend})')
  332. .replace('{linkstart1}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + data.codeIntegrityCheckerDocumentation + '">')
  333. .replace('{linkstart2}', '<a href="' + OC.generateUrl('/settings/integrity/failed') + '">')
  334. .replace('{linkstart3}', '<a href="' + OC.generateUrl('/settings/integrity/rescan?requesttoken={requesttoken}', {'requesttoken': OC.requestToken}) + '">')
  335. .replace(/{linkend}/g, '</a>'),
  336. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  337. });
  338. }
  339. if(data.OpcacheSetupRecommendations.length > 0) {
  340. var listOfOPcacheRecommendations = "";
  341. data.OpcacheSetupRecommendations.forEach(function(element){
  342. listOfOPcacheRecommendations += '<li>' + element + '</li>';
  343. });
  344. messages.push({
  345. msg: t('core', 'The PHP OPcache module is not properly configured. See the {linkstart}documentation ↗{linkend} for more information.')
  346. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + OC.theme.docPlaceholderUrl.replace('PLACEHOLDER', 'admin-php-opcache') + '">')
  347. .replace('{linkend}', '</a>') + '<ul>' + listOfOPcacheRecommendations + '</ul>',
  348. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  349. });
  350. }
  351. if(!data.isSettimelimitAvailable) {
  352. messages.push({
  353. msg: t('core', 'The PHP function "set_time_limit" is not available. This could result in scripts being halted mid-execution, breaking your installation. Enabling this function is strongly recommended.'),
  354. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  355. });
  356. }
  357. if (!data.hasFreeTypeSupport) {
  358. messages.push({
  359. msg: t('core', 'Your PHP does not have FreeType support, resulting in breakage of profile pictures and the settings interface.'),
  360. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  361. })
  362. }
  363. if (data.missingIndexes.length > 0) {
  364. var listOfMissingIndexes = "";
  365. data.missingIndexes.forEach(function(element){
  366. listOfMissingIndexes += '<li>';
  367. listOfMissingIndexes += t('core', 'Missing index "{indexName}" in table "{tableName}".', element);
  368. listOfMissingIndexes += '</li>';
  369. });
  370. messages.push({
  371. msg: t('core', 'The database is missing some indexes. Due to the fact that adding indexes on big tables could take some time they were not added automatically. By running "occ db:add-missing-indices" those missing indexes could be added manually while the instance keeps running. Once the indexes are added queries to those tables are usually much faster.') + '<ul>' + listOfMissingIndexes + '</ul>',
  372. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  373. })
  374. }
  375. if (data.missingPrimaryKeys.length > 0) {
  376. var listOfMissingPrimaryKeys = "";
  377. data.missingPrimaryKeys.forEach(function(element){
  378. listOfMissingPrimaryKeys += '<li>';
  379. listOfMissingPrimaryKeys += t('core', 'Missing primary key on table "{tableName}".', element);
  380. listOfMissingPrimaryKeys += '</li>';
  381. });
  382. messages.push({
  383. msg: t('core', 'The database is missing some primary keys. Due to the fact that adding primary keys on big tables could take some time they were not added automatically. By running "occ db:add-missing-primary-keys" those missing primary keys could be added manually while the instance keeps running.') + '<ul>' + listOfMissingPrimaryKeys + '</ul>',
  384. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  385. })
  386. }
  387. if (data.missingColumns.length > 0) {
  388. var listOfMissingColumns = "";
  389. data.missingColumns.forEach(function(element){
  390. listOfMissingColumns += '<li>';
  391. listOfMissingColumns += t('core', 'Missing optional column "{columnName}" in table "{tableName}".', element);
  392. listOfMissingColumns += '</li>';
  393. });
  394. messages.push({
  395. msg: t('core', 'The database is missing some optional columns. Due to the fact that adding columns on big tables could take some time they were not added automatically when they can be optional. By running "occ db:add-missing-columns" those missing columns could be added manually while the instance keeps running. Once the columns are added some features might improve responsiveness or usability.') + '<ul>' + listOfMissingColumns + '</ul>',
  396. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  397. })
  398. }
  399. if (data.recommendedPHPModules.length > 0) {
  400. var listOfRecommendedPHPModules = "";
  401. data.recommendedPHPModules.forEach(function(element){
  402. listOfRecommendedPHPModules += '<li>' + element + '</li>';
  403. });
  404. messages.push({
  405. msg: t('core', 'This instance is missing some recommended PHP modules. For improved performance and better compatibility it is highly recommended to install them.') + '<ul><code>' + listOfRecommendedPHPModules + '</code></ul>',
  406. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  407. })
  408. }
  409. if (!data.isImagickEnabled) {
  410. messages.push({
  411. msg: t(
  412. 'core',
  413. 'The PHP module "imagick" is not enabled although the theming app is. For favicon generation to work correctly, you need to install and enable this module.'
  414. ),
  415. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  416. })
  417. }
  418. if (!data.areWebauthnExtensionsEnabled) {
  419. messages.push({
  420. msg: t(
  421. 'core',
  422. 'The PHP modules "gmp" and/or "bcmath" are not enabled. If you use WebAuthn passwordless authentication, these modules are required.'
  423. ),
  424. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  425. })
  426. }
  427. if (!data.is64bit) {
  428. messages.push({
  429. msg: t(
  430. 'core',
  431. 'It seems like you are running a 32-bit PHP version. Nextcloud needs 64-bit to run well. Please upgrade your OS and PHP to 64-bit! For further details read {linkstart}the documentation page ↗{linkend} about this.'
  432. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + OC.theme.docPlaceholderUrl.replace('PLACEHOLDER', 'admin-system-requirements') + '">')
  433. .replace('{linkend}', '</a>'),
  434. ),
  435. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  436. })
  437. }
  438. if (data.imageMagickLacksSVGSupport) {
  439. messages.push({
  440. msg: t('core', 'Module php-imagick in this instance has no SVG support. For better compatibility it is recommended to install it.'),
  441. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  442. })
  443. }
  444. if (data.pendingBigIntConversionColumns.length > 0) {
  445. var listOfPendingBigIntConversionColumns = "";
  446. data.pendingBigIntConversionColumns.forEach(function(element){
  447. listOfPendingBigIntConversionColumns += '<li>' + element + '</li>';
  448. });
  449. messages.push({
  450. msg: t('core', 'Some columns in the database are missing a conversion to big int. Due to the fact that changing column types on big tables could take some time they were not changed automatically. By running "occ db:convert-filecache-bigint" those pending changes could be applied manually. This operation needs to be made while the instance is offline. For further details read {linkstart}the documentation page about this ↗{linkend}.')
  451. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + OC.theme.docPlaceholderUrl.replace('PLACEHOLDER', 'admin-bigint-conversion') + '">')
  452. .replace('{linkend}', '</a>') + '<ul>' + listOfPendingBigIntConversionColumns + '</ul>',
  453. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  454. })
  455. }
  456. if (data.isSqliteUsed) {
  457. messages.push({
  458. msg: t('core', 'SQLite is currently being used as the backend database. For larger installations we recommend that you switch to a different database backend.') + ' ' + t('core', 'This is particularly recommended when using the desktop client for file synchronisation.') + ' ' +
  459. t('core', 'To migrate to another database use the command line tool: "occ db:convert-type", or see the {linkstart}documentation ↗{linkend}.')
  460. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + data.databaseConversionDocumentation + '">')
  461. .replace('{linkend}', '</a>'),
  462. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  463. })
  464. }
  465. if (!data.isMemoryLimitSufficient) {
  466. messages.push({
  467. msg: t('core', 'The PHP memory limit is below the recommended value of 512MB.'),
  468. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  469. })
  470. }
  471. if(data.appDirsWithDifferentOwner && data.appDirsWithDifferentOwner.length > 0) {
  472. var appDirsWithDifferentOwner = data.appDirsWithDifferentOwner.reduce(
  473. function(appDirsWithDifferentOwner, directory) {
  474. return appDirsWithDifferentOwner + '<li>' + directory + '</li>';
  475. },
  476. ''
  477. );
  478. messages.push({
  479. msg: t('core', 'Some app directories are owned by a different user than the web server one. ' +
  480. 'This may be the case if apps have been installed manually. ' +
  481. 'Check the permissions of the following app directories:')
  482. + '<ul>' + appDirsWithDifferentOwner + '</ul>',
  483. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  484. });
  485. }
  486. if (data.isMysqlUsedWithoutUTF8MB4) {
  487. messages.push({
  488. msg: t('core', 'MySQL is used as database but does not support 4-byte characters. To be able to handle 4-byte characters (like emojis) without issues in filenames or comments for example it is recommended to enable the 4-byte support in MySQL. For further details read {linkstart}the documentation page about this ↗{linkend}.')
  489. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + OC.theme.docPlaceholderUrl.replace('PLACEHOLDER', 'admin-mysql-utf8mb4') + '">')
  490. .replace('{linkend}', '</a>'),
  491. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  492. })
  493. }
  494. if (!data.isEnoughTempSpaceAvailableIfS3PrimaryStorageIsUsed) {
  495. messages.push({
  496. msg: t('core', 'This instance uses an S3 based object store as primary storage. The uploaded files are stored temporarily on the server and thus it is recommended to have 50 GB of free space available in the temp directory of PHP. Check the logs for full details about the path and the available space. To improve this please change the temporary directory in the php.ini or make more space available in that path.'),
  497. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  498. })
  499. }
  500. if (!data.temporaryDirectoryWritable) {
  501. messages.push({
  502. msg: t('core', 'The temporary directory of this instance points to an either non-existing or non-writable directory.'),
  503. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  504. })
  505. }
  506. if (window.location.protocol === 'https:' && data.reverseProxyGeneratedURL.split('/')[0] !== 'https:') {
  507. messages.push({
  508. msg: t('core', 'You are accessing your instance over a secure connection, however your instance is generating insecure URLs. This most likely means that you are behind a reverse proxy and the overwrite config variables are not set correctly. Please read {linkstart}the documentation page about this ↗{linkend}.')
  509. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + data.reverseProxyDocs + '">')
  510. .replace('{linkend}', '</a>'),
  511. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  512. })
  513. }
  514. if (window.oc_debug) {
  515. messages.push({
  516. msg: t('core', 'This instance is running in debug mode. Only enable this for local development and not in production environments.'),
  517. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  518. })
  519. }
  520. OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\PhpDefaultCharset', messages)
  521. OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\PhpOutputBuffering', messages)
  522. OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat', messages)
  523. OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\CheckUserCertificates', messages)
  524. OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\SupportedDatabase', messages)
  525. OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\LdapInvalidUuids', messages)
  526. OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\NeedsSystemAddressBookSync', messages)
  527. } else {
  528. messages.push({
  529. msg: t('core', 'Error occurred while checking server setup'),
  530. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  531. });
  532. }
  533. deferred.resolve(messages);
  534. };
  535. $.ajax({
  536. type: 'GET',
  537. url: OC.generateUrl('settings/ajax/checksetup'),
  538. allowAuthErrors: true
  539. }).then(afterCall, afterCall);
  540. return deferred.promise();
  541. },
  542. addGenericSetupCheck: function(data, check, messages) {
  543. var setupCheck = data[check] || { pass: true, description: '', severity: 'info', linkToDocumentation: null}
  544. var type = OC.SetupChecks.MESSAGE_TYPE_INFO
  545. if (setupCheck.severity === 'warning') {
  546. type = OC.SetupChecks.MESSAGE_TYPE_WARNING
  547. } else if (setupCheck.severity === 'error') {
  548. type = OC.SetupChecks.MESSAGE_TYPE_ERROR
  549. }
  550. var message = setupCheck.description;
  551. if (setupCheck.linkToDocumentation) {
  552. message += ' ' + t('core', 'For more details see the {linkstart}documentation ↗{linkend}.')
  553. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + setupCheck.linkToDocumentation + '">')
  554. .replace('{linkend}', '</a>');
  555. }
  556. if (setupCheck.elements) {
  557. message += '<br><ul>'
  558. setupCheck.elements.forEach(function(element){
  559. message += '<li>';
  560. message += element
  561. message += '</li>';
  562. });
  563. message += '</ul>'
  564. }
  565. if (!setupCheck.pass) {
  566. messages.push({
  567. msg: message,
  568. type: type,
  569. })
  570. }
  571. },
  572. /**
  573. * Runs generic checks on the server side, the difference to dedicated
  574. * methods is that we use the same XHR object for all checks to save
  575. * requests.
  576. *
  577. * @return $.Deferred object resolved with an array of error messages
  578. */
  579. checkGeneric: function() {
  580. var self = this;
  581. var deferred = $.Deferred();
  582. var afterCall = function(data, statusText, xhr) {
  583. var messages = [];
  584. messages = messages.concat(self._checkSecurityHeaders(xhr));
  585. messages = messages.concat(self._checkSSL(xhr));
  586. deferred.resolve(messages);
  587. };
  588. $.ajax({
  589. type: 'GET',
  590. url: OC.generateUrl('heartbeat'),
  591. allowAuthErrors: true
  592. }).then(afterCall, afterCall);
  593. return deferred.promise();
  594. },
  595. checkDataProtected: function() {
  596. var deferred = $.Deferred();
  597. if(oc_dataURL === false){
  598. return deferred.resolve([]);
  599. }
  600. var afterCall = function(xhr) {
  601. var messages = [];
  602. // .ocdata is an empty file in the data directory - if this is readable then the data dir is not protected
  603. if (xhr.status === 200 && xhr.responseText === '') {
  604. messages.push({
  605. msg: t('core', 'Your data directory and files are probably accessible from the internet. The .htaccess file is not working. It is strongly recommended that you configure your web server so that the data directory is no longer accessible, or move the data directory outside the web server document root.'),
  606. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  607. });
  608. }
  609. deferred.resolve(messages);
  610. };
  611. $.ajax({
  612. type: 'GET',
  613. url: OC.linkTo('', oc_dataURL+'/.ocdata?t=' + (new Date()).getTime()),
  614. complete: afterCall,
  615. allowAuthErrors: true
  616. });
  617. return deferred.promise();
  618. },
  619. /**
  620. * Runs check for some generic security headers on the server side
  621. *
  622. * @param {Object} xhr
  623. * @return {Array} Array with error messages
  624. */
  625. _checkSecurityHeaders: function(xhr) {
  626. var messages = [];
  627. if (xhr.status === 200) {
  628. var securityHeaders = {
  629. 'X-Content-Type-Options': ['nosniff'],
  630. 'X-Robots-Tag': ['noindex, nofollow'],
  631. 'X-Frame-Options': ['SAMEORIGIN', 'DENY'],
  632. 'X-Permitted-Cross-Domain-Policies': ['none'],
  633. };
  634. for (var header in securityHeaders) {
  635. var option = securityHeaders[header][0];
  636. if(!xhr.getResponseHeader(header) || xhr.getResponseHeader(header).replace(/, /, ',').toLowerCase() !== option.replace(/, /, ',').toLowerCase()) {
  637. var msg = t('core', 'The "{header}" HTTP header is not set to "{expected}". This is a potential security or privacy risk, as it is recommended to adjust this setting accordingly.', {header: header, expected: option});
  638. if(xhr.getResponseHeader(header) && securityHeaders[header].length > 1 && xhr.getResponseHeader(header).toLowerCase() === securityHeaders[header][1].toLowerCase()) {
  639. msg = t('core', 'The "{header}" HTTP header is not set to "{expected}". Some features might not work correctly, as it is recommended to adjust this setting accordingly.', {header: header, expected: option});
  640. }
  641. messages.push({
  642. msg: msg,
  643. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  644. });
  645. }
  646. }
  647. var xssfields = xhr.getResponseHeader('X-XSS-Protection') ? xhr.getResponseHeader('X-XSS-Protection').split(';').map(function(item) { return item.trim(); }) : [];
  648. if (xssfields.length === 0 || xssfields.indexOf('1') === -1 || xssfields.indexOf('mode=block') === -1) {
  649. messages.push({
  650. msg: t('core', 'The "{header}" HTTP header does not contain "{expected}". This is a potential security or privacy risk, as it is recommended to adjust this setting accordingly.',
  651. {
  652. header: 'X-XSS-Protection',
  653. expected: '1; mode=block'
  654. }),
  655. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  656. });
  657. }
  658. const referrerPolicy = xhr.getResponseHeader('Referrer-Policy')
  659. if (referrerPolicy === null || !/(no-referrer(-when-downgrade)?|strict-origin(-when-cross-origin)?|same-origin)(,|$)/.test(referrerPolicy)) {
  660. messages.push({
  661. msg: t('core', 'The "{header}" HTTP header is not set to "{val1}", "{val2}", "{val3}", "{val4}" or "{val5}". This can leak referer information. See the {linkstart}W3C Recommendation ↗{linkend}.',
  662. {
  663. header: 'Referrer-Policy',
  664. val1: 'no-referrer',
  665. val2: 'no-referrer-when-downgrade',
  666. val3: 'strict-origin',
  667. val4: 'strict-origin-when-cross-origin',
  668. val5: 'same-origin'
  669. })
  670. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="https://www.w3.org/TR/referrer-policy/">')
  671. .replace('{linkend}', '</a>'),
  672. type: OC.SetupChecks.MESSAGE_TYPE_INFO
  673. })
  674. }
  675. } else {
  676. messages.push({
  677. msg: t('core', 'Error occurred while checking server setup'),
  678. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  679. });
  680. }
  681. return messages;
  682. },
  683. /**
  684. * Runs check for some SSL configuration issues on the server side
  685. *
  686. * @param {Object} xhr
  687. * @return {Array} Array with error messages
  688. */
  689. _checkSSL: function(xhr) {
  690. var messages = [];
  691. if (xhr.status === 200) {
  692. var tipsUrl = OC.theme.docPlaceholderUrl.replace('PLACEHOLDER', 'admin-security');
  693. if(OC.getProtocol() === 'https') {
  694. // Extract the value of 'Strict-Transport-Security'
  695. var transportSecurityValidity = xhr.getResponseHeader('Strict-Transport-Security');
  696. if(transportSecurityValidity !== null && transportSecurityValidity.length > 8) {
  697. var firstComma = transportSecurityValidity.indexOf(";");
  698. if(firstComma !== -1) {
  699. transportSecurityValidity = transportSecurityValidity.substring(8, firstComma);
  700. } else {
  701. transportSecurityValidity = transportSecurityValidity.substring(8);
  702. }
  703. }
  704. var minimumSeconds = 15552000;
  705. if(isNaN(transportSecurityValidity) || transportSecurityValidity <= (minimumSeconds - 1)) {
  706. messages.push({
  707. msg: t('core', 'The "Strict-Transport-Security" HTTP header is not set to at least "{seconds}" seconds. For enhanced security, it is recommended to enable HSTS as described in the {linkstart}security tips ↗{linkend}.', {'seconds': minimumSeconds})
  708. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + tipsUrl + '">')
  709. .replace('{linkend}', '</a>'),
  710. type: OC.SetupChecks.MESSAGE_TYPE_WARNING
  711. });
  712. }
  713. } else if (!/(?:^(?:localhost|127\.0\.0\.1|::1)|\.onion)$/.exec(window.location.hostname)) {
  714. messages.push({
  715. msg: t('core', 'Accessing site insecurely via HTTP. You are strongly advised to set up your server to require HTTPS instead, as described in the {linkstart}security tips ↗{linkend}. Without it some important web functionality like "copy to clipboard" or "service workers" will not work!')
  716. .replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + tipsUrl + '">')
  717. .replace('{linkend}', '</a>'),
  718. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  719. });
  720. }
  721. } else {
  722. messages.push({
  723. msg: t('core', 'Error occurred while checking server setup'),
  724. type: OC.SetupChecks.MESSAGE_TYPE_ERROR
  725. });
  726. }
  727. return messages;
  728. }
  729. };
  730. })();