lib_rss.php 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766
  1. <?php
  2. if (version_compare(PHP_VERSION, FRESHRSS_MIN_PHP_VERSION, '<')) {
  3. die(sprintf('FreshRSS error: FreshRSS requires PHP %s+!', FRESHRSS_MIN_PHP_VERSION));
  4. }
  5. if (!function_exists('mb_strcut')) {
  6. function mb_strcut($str, $start, $length = null, $encoding = 'UTF-8') {
  7. return substr($str, $start, $length);
  8. }
  9. }
  10. // @phpstan-ignore-next-line
  11. if (COPY_SYSLOG_TO_STDERR) {
  12. openlog('FreshRSS', LOG_CONS | LOG_ODELAY | LOG_PID | LOG_PERROR, LOG_USER);
  13. } else {
  14. openlog('FreshRSS', LOG_CONS | LOG_ODELAY | LOG_PID, LOG_USER);
  15. }
  16. /**
  17. * Build a directory path by concatenating a list of directory names.
  18. *
  19. * @param string ...$path_parts a list of directory names
  20. * @return string corresponding to the final pathname
  21. */
  22. function join_path(...$path_parts): string {
  23. return join(DIRECTORY_SEPARATOR, $path_parts);
  24. }
  25. //<Auto-loading>
  26. function classAutoloader($class) {
  27. if (strpos($class, 'FreshRSS') === 0) {
  28. $components = explode('_', $class);
  29. switch (count($components)) {
  30. case 1:
  31. include(APP_PATH . '/' . $components[0] . '.php');
  32. return;
  33. case 2:
  34. include(APP_PATH . '/Models/' . $components[1] . '.php');
  35. return;
  36. case 3: //Controllers, Exceptions
  37. include(APP_PATH . '/' . $components[2] . 's/' . $components[1] . $components[2] . '.php');
  38. return;
  39. }
  40. } elseif (strpos($class, 'Minz') === 0) {
  41. include(LIB_PATH . '/' . str_replace('_', '/', $class) . '.php');
  42. } elseif (strpos($class, 'SimplePie') === 0) {
  43. include(LIB_PATH . '/SimplePie/' . str_replace('_', '/', $class) . '.php');
  44. } elseif (strpos($class, 'CssXPath') !== false) {
  45. include(LIB_PATH . '/CssXPath/' . basename(str_replace('\\', '/', $class)) . '.php');
  46. } elseif (strpos($class, 'PHPMailer') === 0) {
  47. include(LIB_PATH . '/' . str_replace('\\', '/', $class) . '.php');
  48. }
  49. }
  50. spl_autoload_register('classAutoloader');
  51. //</Auto-loading>
  52. /**
  53. * @param string $url
  54. * @return string
  55. */
  56. function idn_to_puny($url) {
  57. if (function_exists('idn_to_ascii')) {
  58. $idn = parse_url($url, PHP_URL_HOST);
  59. if ($idn != '') {
  60. // https://wiki.php.net/rfc/deprecate-and-remove-intl_idna_variant_2003
  61. if (defined('INTL_IDNA_VARIANT_UTS46')) {
  62. $puny = idn_to_ascii($idn, IDNA_DEFAULT, INTL_IDNA_VARIANT_UTS46);
  63. } elseif (defined('INTL_IDNA_VARIANT_2003')) {
  64. $puny = idn_to_ascii($idn, IDNA_DEFAULT, INTL_IDNA_VARIANT_2003);
  65. } else {
  66. $puny = idn_to_ascii($idn);
  67. }
  68. $pos = strpos($url, $idn);
  69. if ($puny != '' && $pos !== false) {
  70. $url = substr_replace($url, $puny, $pos, strlen($idn));
  71. }
  72. }
  73. }
  74. return $url;
  75. }
  76. /**
  77. * @param string $url
  78. * @param bool $fixScheme
  79. * @return string|false
  80. */
  81. function checkUrl($url, $fixScheme = true) {
  82. $url = trim($url);
  83. if ($url == '') {
  84. return '';
  85. }
  86. if ($fixScheme && !preg_match('#^https?://#i', $url)) {
  87. $url = 'https://' . ltrim($url, '/');
  88. }
  89. $url = idn_to_puny($url); //PHP bug #53474 IDN
  90. $urlRelaxed = str_replace('_', 'z', $url); //PHP discussion #64948 Underscore
  91. if (filter_var($urlRelaxed, FILTER_VALIDATE_URL)) {
  92. return $url;
  93. } else {
  94. return false;
  95. }
  96. }
  97. /**
  98. * @param string $text
  99. * @return string
  100. */
  101. function safe_ascii($text) {
  102. return filter_var($text, FILTER_DEFAULT, FILTER_FLAG_STRIP_LOW | FILTER_FLAG_STRIP_HIGH);
  103. }
  104. if (function_exists('mb_convert_encoding')) {
  105. /**
  106. * @param string $text
  107. * @return string
  108. */
  109. function safe_utf8($text) {
  110. return mb_convert_encoding($text, 'UTF-8', 'UTF-8');
  111. }
  112. } elseif (function_exists('iconv')) {
  113. /**
  114. * @param string $text
  115. * @return string
  116. */
  117. function safe_utf8($text) {
  118. return iconv('UTF-8', 'UTF-8//IGNORE', $text);
  119. }
  120. } else {
  121. /**
  122. * @param string $text
  123. * @return string
  124. */
  125. function safe_utf8($text) {
  126. return $text;
  127. }
  128. }
  129. /**
  130. * @param string $text
  131. * @param bool $extended
  132. * @return string
  133. */
  134. function escapeToUnicodeAlternative($text, $extended = true) {
  135. $text = htmlspecialchars_decode($text, ENT_QUOTES);
  136. //Problematic characters
  137. $problem = array('&', '<', '>');
  138. //Use their fullwidth Unicode form instead:
  139. $replace = array('&', '<', '>');
  140. // https://raw.githubusercontent.com/mihaip/google-reader-api/master/wiki/StreamId.wiki
  141. if ($extended) {
  142. $problem += array("'", '"', '^', '?', '\\', '/', ',', ';');
  143. $replace += array("’", '"', '^', '?', '\', '/', ',', ';');
  144. }
  145. return trim(str_replace($problem, $replace, $text));
  146. }
  147. function format_number($n, $precision = 0) {
  148. // number_format does not seem to be Unicode-compatible
  149. return str_replace(' ', ' ', // Thin non-breaking space
  150. number_format($n, $precision, '.', ' ')
  151. );
  152. }
  153. function format_bytes($bytes, $precision = 2, $system = 'IEC') {
  154. if ($system === 'IEC') {
  155. $base = 1024;
  156. $units = array('B', 'KiB', 'MiB', 'GiB', 'TiB');
  157. } elseif ($system === 'SI') {
  158. $base = 1000;
  159. $units = array('B', 'KB', 'MB', 'GB', 'TB');
  160. } else {
  161. return format_number($bytes, $precision);
  162. }
  163. $bytes = max(intval($bytes), 0);
  164. $pow = $bytes === 0 ? 0 : floor(log($bytes) / log($base));
  165. $pow = min($pow, count($units) - 1);
  166. $bytes /= pow($base, $pow);
  167. return format_number($bytes, $precision) . ' ' . $units[$pow];
  168. }
  169. function timestamptodate ($t, $hour = true) {
  170. $month = _t('gen.date.' . date('M', $t));
  171. if ($hour) {
  172. $date = _t('gen.date.format_date_hour', $month);
  173. } else {
  174. $date = _t('gen.date.format_date', $month);
  175. }
  176. return @date ($date, $t);
  177. }
  178. /**
  179. * Decode HTML entities but preserve XML entities.
  180. * @param string|null $text
  181. */
  182. function html_only_entity_decode($text): string {
  183. static $htmlEntitiesOnly = null;
  184. if ($htmlEntitiesOnly === null) {
  185. $htmlEntitiesOnly = array_flip(array_diff(
  186. get_html_translation_table(HTML_ENTITIES, ENT_NOQUOTES, 'UTF-8'), //Decode HTML entities
  187. get_html_translation_table(HTML_SPECIALCHARS, ENT_NOQUOTES, 'UTF-8') //Preserve XML entities
  188. ));
  189. }
  190. return $text == '' ? '' : strtr($text, $htmlEntitiesOnly);
  191. }
  192. /**
  193. * @param array<string,mixed> $attributes
  194. */
  195. function customSimplePie($attributes = array()): SimplePie {
  196. $limits = FreshRSS_Context::$system_conf->limits;
  197. $simplePie = new SimplePie();
  198. $simplePie->set_useragent(FRESHRSS_USERAGENT);
  199. $simplePie->set_syslog(FreshRSS_Context::$system_conf->simplepie_syslog_enabled);
  200. $simplePie->set_cache_name_function('sha1');
  201. $simplePie->set_cache_location(CACHE_PATH);
  202. $simplePie->set_cache_duration($limits['cache_duration']);
  203. $simplePie->enable_order_by_date(false);
  204. $feed_timeout = empty($attributes['timeout']) ? 0 : intval($attributes['timeout']);
  205. $simplePie->set_timeout($feed_timeout > 0 ? $feed_timeout : $limits['timeout']);
  206. $curl_options = FreshRSS_Context::$system_conf->curl_options;
  207. if (isset($attributes['ssl_verify'])) {
  208. $curl_options[CURLOPT_SSL_VERIFYHOST] = $attributes['ssl_verify'] ? 2 : 0;
  209. $curl_options[CURLOPT_SSL_VERIFYPEER] = $attributes['ssl_verify'] ? true : false;
  210. if (!$attributes['ssl_verify']) {
  211. $curl_options[CURLOPT_SSL_CIPHER_LIST] = 'DEFAULT@SECLEVEL=1';
  212. }
  213. }
  214. if (!empty($attributes['curl_params']) && is_array($attributes['curl_params'])) {
  215. foreach ($attributes['curl_params'] as $co => $v) {
  216. $curl_options[$co] = $v;
  217. }
  218. }
  219. $simplePie->set_curl_options($curl_options);
  220. $simplePie->strip_comments(true);
  221. $simplePie->strip_htmltags(array(
  222. 'base', 'blink', 'body', 'doctype', 'embed',
  223. 'font', 'form', 'frame', 'frameset', 'html',
  224. 'link', 'input', 'marquee', 'meta', 'noscript',
  225. 'object', 'param', 'plaintext', 'script', 'style',
  226. 'svg', //TODO: Support SVG after sanitizing and URL rewriting of xlink:href
  227. ));
  228. $simplePie->rename_attributes(array('id', 'class'));
  229. $simplePie->strip_attributes(array_merge($simplePie->strip_attributes, array(
  230. 'autoplay', 'class', 'onload', 'onunload', 'onclick', 'ondblclick', 'onmousedown', 'onmouseup',
  231. 'onmouseover', 'onmousemove', 'onmouseout', 'onfocus', 'onblur',
  232. 'onkeypress', 'onkeydown', 'onkeyup', 'onselect', 'onchange', 'seamless', 'sizes', 'srcset')));
  233. $simplePie->add_attributes(array(
  234. 'audio' => array('controls' => 'controls', 'preload' => 'none'),
  235. 'iframe' => array('sandbox' => 'allow-scripts allow-same-origin'),
  236. 'video' => array('controls' => 'controls', 'preload' => 'none'),
  237. ));
  238. $simplePie->set_url_replacements(array(
  239. 'a' => 'href',
  240. 'area' => 'href',
  241. 'audio' => 'src',
  242. 'blockquote' => 'cite',
  243. 'del' => 'cite',
  244. 'form' => 'action',
  245. 'iframe' => 'src',
  246. 'img' => array(
  247. 'longdesc',
  248. 'src'
  249. ),
  250. 'input' => 'src',
  251. 'ins' => 'cite',
  252. 'q' => 'cite',
  253. 'source' => 'src',
  254. 'track' => 'src',
  255. 'video' => array(
  256. 'poster',
  257. 'src',
  258. ),
  259. ));
  260. $https_domains = array();
  261. $force = @file(FRESHRSS_PATH . '/force-https.default.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
  262. if (is_array($force)) {
  263. $https_domains = array_merge($https_domains, $force);
  264. }
  265. $force = @file(DATA_PATH . '/force-https.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
  266. if (is_array($force)) {
  267. $https_domains = array_merge($https_domains, $force);
  268. }
  269. $simplePie->set_https_domains($https_domains);
  270. return $simplePie;
  271. }
  272. /**
  273. * @param int|false $maxLength
  274. */
  275. function sanitizeHTML($data, string $base = '', $maxLength = false) {
  276. if (!is_string($data) || ($maxLength !== false && $maxLength <= 0)) {
  277. return '';
  278. }
  279. if ($maxLength !== false) {
  280. $data = mb_strcut($data, 0, $maxLength, 'UTF-8');
  281. }
  282. static $simplePie = null;
  283. if ($simplePie == null) {
  284. $simplePie = customSimplePie();
  285. $simplePie->init();
  286. }
  287. $result = html_only_entity_decode($simplePie->sanitize->sanitize($data, SIMPLEPIE_CONSTRUCT_HTML, $base));
  288. if ($maxLength !== false && strlen($result) > $maxLength) {
  289. //Sanitizing has made the result too long so try again shorter
  290. $data = mb_strcut($result, 0, (2 * $maxLength) - strlen($result) - 2, 'UTF-8');
  291. return sanitizeHTML($data, $base, $maxLength);
  292. }
  293. return $result;
  294. }
  295. function cleanCache(int $hours = 720) {
  296. $files = glob(CACHE_PATH . '/*.{html,spc}', GLOB_BRACE | GLOB_NOSORT);
  297. foreach ($files as $file) {
  298. if (substr($file, -10) === 'index.html') {
  299. continue;
  300. }
  301. $cacheMtime = @filemtime($file);
  302. if ($cacheMtime !== false && $cacheMtime < time() - (3600 * $hours)) {
  303. unlink($file);
  304. }
  305. }
  306. }
  307. /**
  308. * Set an XML preamble to enforce the HTML content type charset received by HTTP.
  309. * @param string $html the row downloaded HTML content
  310. * @param string $contentType an HTTP Content-Type such as 'text/html; charset=utf-8'
  311. * @return string an HTML string with XML encoding information for DOMDocument::loadHTML()
  312. */
  313. function enforceHttpEncoding(string $html, string $contentType = ''): string {
  314. $httpCharset = preg_match('/\bcharset=([0-9a-z_-]{2,12})$/i', $contentType, $matches) === false ? '' : $matches[1] ?? '';
  315. if ($httpCharset == '') {
  316. // No charset defined by HTTP, do nothing
  317. return $html;
  318. }
  319. $httpCharsetNormalized = SimplePie_Misc::encoding($httpCharset);
  320. if ($httpCharsetNormalized === 'windows-1252') {
  321. // Default charset for HTTP, do nothing
  322. return $html;
  323. }
  324. if (substr($html, 0, 3) === "\xEF\xBB\xBF" || // UTF-8 BOM
  325. substr($html, 0, 2) === "\xFF\xFE" || // UTF-16 Little Endian BOM
  326. substr($html, 0, 2) === "\xFE\xFF" || // UTF-16 Big Endian BOM
  327. substr($html, 0, 4) === "\xFF\xFE\x00\x00" || // UTF-32 Little Endian BOM
  328. substr($html, 0, 4) === "\x00\x00\xFE\xFF") { // UTF-32 Big Endian BOM
  329. // Existing byte order mark, do nothing
  330. return $html;
  331. }
  332. if (preg_match('/^<[?]xml[^>]+encoding\b/', substr($html, 0, 64))) {
  333. // Existing XML declaration, do nothing
  334. return $html;
  335. }
  336. return '<' . '?xml version="1.0" encoding="' . $httpCharsetNormalized . '" ?' . ">\n" . $html;
  337. }
  338. /**
  339. * @param array<string,mixed> $attributes
  340. */
  341. function getHtml(string $url, array $attributes = []): string {
  342. $limits = FreshRSS_Context::$system_conf->limits;
  343. $feed_timeout = empty($attributes['timeout']) ? 0 : intval($attributes['timeout']);
  344. $cachePath = FreshRSS_Feed::cacheFilename($url, $attributes, FreshRSS_Feed::KIND_HTML_XPATH);
  345. $cacheMtime = @filemtime($cachePath);
  346. if ($cacheMtime !== false && $cacheMtime > time() - intval($limits['cache_duration'])) {
  347. $html = @file_get_contents($cachePath);
  348. if ($html != '') {
  349. syslog(LOG_DEBUG, 'FreshRSS uses cache for ' . SimplePie_Misc::url_remove_credentials($url));
  350. return $html;
  351. }
  352. }
  353. if (mt_rand(0, 30) === 1) { // Remove old entries once in a while
  354. cleanCache();
  355. }
  356. if (FreshRSS_Context::$system_conf->simplepie_syslog_enabled) {
  357. syslog(LOG_INFO, 'FreshRSS GET ' . SimplePie_Misc::url_remove_credentials($url));
  358. }
  359. // TODO: Implement HTTP 1.1 conditional GET If-Modified-Since
  360. $ch = curl_init();
  361. curl_setopt_array($ch, [
  362. CURLOPT_URL => $url,
  363. CURLOPT_REFERER => SimplePie_Misc::url_remove_credentials($url),
  364. CURLOPT_HTTPHEADER => array('Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8'),
  365. CURLOPT_USERAGENT => FRESHRSS_USERAGENT,
  366. CURLOPT_CONNECTTIMEOUT => $feed_timeout > 0 ? $feed_timeout : $limits['timeout'],
  367. CURLOPT_TIMEOUT => $feed_timeout > 0 ? $feed_timeout : $limits['timeout'],
  368. //CURLOPT_FAILONERROR => true;
  369. CURLOPT_MAXREDIRS => 4,
  370. CURLOPT_RETURNTRANSFER => true,
  371. CURLOPT_FOLLOWLOCATION => true,
  372. CURLOPT_ENCODING => '', //Enable all encodings
  373. ]);
  374. curl_setopt_array($ch, FreshRSS_Context::$system_conf->curl_options);
  375. if (isset($attributes['curl_params']) && is_array($attributes['curl_params'])) {
  376. curl_setopt_array($ch, $attributes['curl_params']);
  377. }
  378. if (isset($attributes['ssl_verify'])) {
  379. curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, $attributes['ssl_verify'] ? 2 : 0);
  380. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, $attributes['ssl_verify'] ? true : false);
  381. if (!$attributes['ssl_verify']) {
  382. curl_setopt($ch, CURLOPT_SSL_CIPHER_LIST, 'DEFAULT@SECLEVEL=1');
  383. }
  384. }
  385. $html = curl_exec($ch);
  386. $c_status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  387. $c_content_type = curl_getinfo($ch, CURLINFO_CONTENT_TYPE); //TODO: Check if that may be null
  388. $c_error = curl_error($ch);
  389. curl_close($ch);
  390. if ($c_status != 200 || $c_error != '' || $html === false) {
  391. Minz_Log::warning('Error fetching content: HTTP code ' . $c_status . ': ' . $c_error . ' ' . $url);
  392. // TODO: Implement HTTP 410 Gone
  393. }
  394. if ($html == false) {
  395. $html = '';
  396. } else {
  397. $html = enforceHttpEncoding($html, $c_content_type);
  398. }
  399. if (file_put_contents($cachePath, $html) === false) {
  400. Minz_Log::warning("Error saving cache $cachePath for $url");
  401. }
  402. return $html;
  403. }
  404. /**
  405. * Validate an email address, supports internationalized addresses.
  406. *
  407. * @param string $email The address to validate
  408. *
  409. * @return bool true if email is valid, else false
  410. */
  411. function validateEmailAddress($email) {
  412. $mailer = new PHPMailer\PHPMailer\PHPMailer();
  413. $mailer->CharSet = 'utf-8';
  414. $punyemail = $mailer->punyencodeAddress($email);
  415. return PHPMailer\PHPMailer\PHPMailer::validateAddress($punyemail, 'html5');
  416. }
  417. /**
  418. * Add support of image lazy loading
  419. * Move content from src attribute to data-original
  420. * @param string $content is the text we want to parse
  421. */
  422. function lazyimg($content) {
  423. return preg_replace(
  424. '/<((?:img|iframe)[^>]+?)src=[\'"]([^"\']+)[\'"]([^>]*)>/i',
  425. '<$1src="' . Minz_Url::display('/themes/icons/grey.gif') . '" data-original="$2"$3>',
  426. $content
  427. );
  428. }
  429. /**
  430. * @return string
  431. */
  432. function uTimeString() {
  433. $t = @gettimeofday();
  434. return $t['sec'] . str_pad('' . $t['usec'], 6, '0', STR_PAD_LEFT);
  435. }
  436. function invalidateHttpCache($username = '') {
  437. if (!FreshRSS_user_Controller::checkUsername($username)) {
  438. Minz_Session::_param('touch', uTimeString());
  439. $username = Minz_Session::param('currentUser', '_');
  440. }
  441. $ok = @touch(DATA_PATH . '/users/' . $username . '/log.txt');
  442. //if (!$ok) {
  443. //TODO: Display notification error on front-end
  444. //}
  445. return $ok;
  446. }
  447. /**
  448. * @return array<string>
  449. */
  450. function listUsers() {
  451. $final_list = array();
  452. $base_path = join_path(DATA_PATH, 'users');
  453. $dir_list = array_values(array_diff(
  454. scandir($base_path),
  455. array('..', '.', '_')
  456. ));
  457. foreach ($dir_list as $file) {
  458. if ($file[0] !== '.' && is_dir(join_path($base_path, $file)) && file_exists(join_path($base_path, $file, 'config.php'))) {
  459. $final_list[] = $file;
  460. }
  461. }
  462. return $final_list;
  463. }
  464. /**
  465. * Return if the maximum number of registrations has been reached.
  466. *
  467. * Note a max_regstrations of 0 means there is no limit.
  468. *
  469. * @return boolean true if number of users >= max registrations, false else.
  470. */
  471. function max_registrations_reached() {
  472. $limit_registrations = FreshRSS_Context::$system_conf->limits['max_registrations'];
  473. $number_accounts = count(listUsers());
  474. return $limit_registrations > 0 && $number_accounts >= $limit_registrations;
  475. }
  476. /**
  477. * Register and return the configuration for a given user.
  478. *
  479. * Note this function has been created to generate temporary configuration
  480. * objects. If you need a long-time configuration, please don't use this function.
  481. *
  482. * @param string $username the name of the user of which we want the configuration.
  483. * @return FreshRSS_UserConfiguration|null object, or null if the configuration cannot be loaded.
  484. */
  485. function get_user_configuration($username) {
  486. if (!FreshRSS_user_Controller::checkUsername($username)) {
  487. return null;
  488. }
  489. $namespace = 'user_' . $username;
  490. try {
  491. Minz_Configuration::register($namespace,
  492. USERS_PATH . '/' . $username . '/config.php',
  493. FRESHRSS_PATH . '/config-user.default.php');
  494. } catch (Minz_ConfigurationNamespaceException $e) {
  495. // namespace already exists, do nothing.
  496. Minz_Log::warning($e->getMessage(), USERS_PATH . '/_/log.txt');
  497. } catch (Minz_FileNotExistException $e) {
  498. Minz_Log::warning($e->getMessage(), USERS_PATH . '/_/log.txt');
  499. return null;
  500. }
  501. /**
  502. * @var FreshRSS_UserConfiguration $user_conf
  503. */
  504. $user_conf = Minz_Configuration::get($namespace);
  505. return $user_conf;
  506. }
  507. /**
  508. * @return string
  509. */
  510. function httpAuthUser() {
  511. if (!empty($_SERVER['REMOTE_USER'])) {
  512. return $_SERVER['REMOTE_USER'];
  513. } elseif (!empty($_SERVER['REDIRECT_REMOTE_USER'])) {
  514. return $_SERVER['REDIRECT_REMOTE_USER'];
  515. } elseif (!empty($_SERVER['HTTP_X_WEBAUTH_USER'])) {
  516. return $_SERVER['HTTP_X_WEBAUTH_USER'];
  517. }
  518. return '';
  519. }
  520. /**
  521. * @return bool
  522. */
  523. function cryptAvailable() {
  524. try {
  525. $hash = '$2y$04$usesomesillystringfore7hnbRJHxXVLeakoG8K30oukPsA.ztMG';
  526. return $hash === @crypt('password', $hash);
  527. } catch (Exception $e) {
  528. Minz_Log::warning($e->getMessage());
  529. }
  530. return false;
  531. }
  532. /**
  533. * Check PHP and its extensions are well-installed.
  534. *
  535. * @return array<string,bool> of tested values.
  536. */
  537. function check_install_php() {
  538. $pdo_mysql = extension_loaded('pdo_mysql');
  539. $pdo_pgsql = extension_loaded('pdo_pgsql');
  540. $pdo_sqlite = extension_loaded('pdo_sqlite');
  541. return array(
  542. 'php' => version_compare(PHP_VERSION, FRESHRSS_MIN_PHP_VERSION) >= 0,
  543. 'curl' => extension_loaded('curl'),
  544. 'pdo' => $pdo_mysql || $pdo_sqlite || $pdo_pgsql,
  545. 'pcre' => extension_loaded('pcre'),
  546. 'ctype' => extension_loaded('ctype'),
  547. 'fileinfo' => extension_loaded('fileinfo'),
  548. 'dom' => class_exists('DOMDocument'),
  549. 'json' => extension_loaded('json'),
  550. 'mbstring' => extension_loaded('mbstring'),
  551. 'zip' => extension_loaded('zip'),
  552. );
  553. }
  554. /**
  555. * Check different data files and directories exist.
  556. *
  557. * @return array<string,bool> of tested values.
  558. */
  559. function check_install_files() {
  560. return array(
  561. // @phpstan-ignore-next-line
  562. 'data' => DATA_PATH && is_writable(DATA_PATH),
  563. // @phpstan-ignore-next-line
  564. 'cache' => CACHE_PATH && is_writable(CACHE_PATH),
  565. // @phpstan-ignore-next-line
  566. 'users' => USERS_PATH && is_writable(USERS_PATH),
  567. 'favicons' => is_writable(DATA_PATH . '/favicons'),
  568. 'tokens' => is_writable(DATA_PATH . '/tokens'),
  569. );
  570. }
  571. /**
  572. * Check database is well-installed.
  573. *
  574. * @return array<string,bool> of tested values.
  575. */
  576. function check_install_database() {
  577. $status = array(
  578. 'connection' => true,
  579. 'tables' => false,
  580. 'categories' => false,
  581. 'feeds' => false,
  582. 'entries' => false,
  583. 'entrytmp' => false,
  584. 'tag' => false,
  585. 'entrytag' => false,
  586. );
  587. try {
  588. $dbDAO = FreshRSS_Factory::createDatabaseDAO();
  589. $status['tables'] = $dbDAO->tablesAreCorrect();
  590. $status['categories'] = $dbDAO->categoryIsCorrect();
  591. $status['feeds'] = $dbDAO->feedIsCorrect();
  592. $status['entries'] = $dbDAO->entryIsCorrect();
  593. $status['entrytmp'] = $dbDAO->entrytmpIsCorrect();
  594. $status['tag'] = $dbDAO->tagIsCorrect();
  595. $status['entrytag'] = $dbDAO->entrytagIsCorrect();
  596. } catch(Minz_PDOConnectionException $e) {
  597. $status['connection'] = false;
  598. }
  599. return $status;
  600. }
  601. /**
  602. * Remove a directory recursively.
  603. *
  604. * From http://php.net/rmdir#110489
  605. *
  606. * @param string $dir the directory to remove
  607. */
  608. function recursive_unlink($dir) {
  609. if (!is_dir($dir)) {
  610. return true;
  611. }
  612. $files = array_diff(scandir($dir), array('.', '..'));
  613. foreach ($files as $filename) {
  614. $filename = $dir . '/' . $filename;
  615. if (is_dir($filename)) {
  616. @chmod($filename, 0777);
  617. recursive_unlink($filename);
  618. } else {
  619. unlink($filename);
  620. }
  621. }
  622. return rmdir($dir);
  623. }
  624. /**
  625. * Remove queries where $get is appearing.
  626. * @param string $get the get attribute which should be removed.
  627. * @param array<int,array<string,string>> $queries an array of queries.
  628. * @return array<int,array<string,string>> without queries where $get is appearing.
  629. */
  630. function remove_query_by_get($get, $queries) {
  631. $final_queries = array();
  632. foreach ($queries as $key => $query) {
  633. if (empty($query['get']) || $query['get'] !== $get) {
  634. $final_queries[$key] = $query;
  635. }
  636. }
  637. return $final_queries;
  638. }
  639. function _i($icon, $url_only = false) {
  640. return FreshRSS_Themes::icon($icon, $url_only);
  641. }
  642. const SHORTCUT_KEYS = [
  643. '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
  644. 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm',
  645. 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z',
  646. 'F1', 'F2', 'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9', 'F10', 'F11', 'F12',
  647. 'ArrowDown', 'ArrowLeft', 'ArrowRight', 'ArrowUp', 'Backspace', 'Delete',
  648. 'End', 'Enter', 'Escape', 'Home', 'Insert', 'PageDown', 'PageUp', 'Space', 'Tab',
  649. ];
  650. function getNonStandardShortcuts($shortcuts) {
  651. $standard = strtolower(implode(' ', SHORTCUT_KEYS));
  652. $nonStandard = array_filter($shortcuts, function ($shortcut) use ($standard) {
  653. $shortcut = trim($shortcut);
  654. return $shortcut !== '' & stripos($standard, $shortcut) === false;
  655. });
  656. return $nonStandard;
  657. }
  658. function errorMessage($errorTitle, $error = '') {
  659. $errorTitle = htmlspecialchars($errorTitle, ENT_NOQUOTES, 'UTF-8');
  660. $message = '';
  661. $details = '';
  662. // Prevent empty tags by checking if error isn not empty first
  663. if ($error) {
  664. $error = htmlspecialchars($error, ENT_NOQUOTES, 'UTF-8');
  665. // First line is the main message, other lines are the details
  666. list($message, $details) = explode("\n", $error, 2);
  667. $message = "<h2>{$message}</h2>";
  668. $details = "<pre>{$details}</pre>";
  669. }
  670. return <<<MSG
  671. <h1>{$errorTitle}</h1>
  672. {$message}
  673. {$details}
  674. <h2>Check the logs</h2>
  675. <p>FreshRSS logs are located in <code>./FreshRSS/data/users/*/log*.txt</code></p>
  676. <p><em>N.B.:</em> A typical problem is wrong file permissions in the <code>./FreshRSS/data/</code> folder
  677. so make sure the Web server can write there and in sub-directories.</p>
  678. <h3>Common locations for additional logs</h3>
  679. <p><em>N.B.:</em> Adapt names and paths according to your local setup.</p>
  680. <ul>
  681. <li>If using Docker: <code>docker logs -f freshrss</code></li>
  682. <li>To check Web server logs on a Linux system using systemd: <code>journalctl -xeu apache2</code>
  683. and if you are using php-fpm: <code>journalctl -xeu php-fpm</code></li>
  684. <li>Otherwise, Web server logs are typically located in <code>/var/log/apache2/</code> or similar</li>
  685. <li>System logs may also contain relevant information in <code>/var/log/syslog</code>, or if using systemd: <code>sudo journalctl -xe</code></li>
  686. </ul>
  687. <p>More logs can be generated by enabling <code>'environment' => 'development',</code> in <code>./FreshRSS/data/config.php</code></p>
  688. <p>Running the feed update script (with the same user and PHP version as your Web server) might provide other hints, e.g.:
  689. <code>sudo -u www-data /usr/bin/php ./FreshRSS/app/actualize_script.php</code></p>
  690. MSG;
  691. }