WebOrbiton
v2.0.0.7

Publisium

228 lines · 13.4 KB
  1. <?php
  2. ​
  3. declare(strict_types=1);
  4. ​
  5. require_once __DIR__ . '/site-front.php';
  6. require_once __DIR__ . '/language.php';
  7. require_once __DIR__ . '/site-comments.php';
  8. ​
  9. // Comment systems for articles. Every setting is validated on save and escaped on output.
  10. final class Comments
  11. {
  12. public const PROVIDERS = [
  13. 'builtin' => 'Publisium (built in, no outside service)',
  14. 'disqus' => 'Disqus',
  15. 'commento' => 'Commento / Commento++',
  16. 'remark42' => 'Remark42 (self-hosted)',
  17. 'isso' => 'Isso (self-hosted)',
  18. 'cusdis' => 'Cusdis (cloud or self-hosted)',
  19. 'giscus' => 'Giscus (GitHub Discussions)',
  20. 'utterances' => 'Utterances (GitHub Issues)',
  21. 'hyvor' => 'Hyvor Talk',
  22. 'custom' => 'Your own code (any other service)',
  23. ];
  24. ​
  25. // Which settings each service uses; the settings page shows only these.
  26. public const FIELDS = [
  27. 'builtin' => ['comments_who', 'comments_moderation', 'comments_email'],
  28. 'disqus' => ['comments_shortname'],
  29. 'commento' => ['comments_server_url'],
  30. 'remark42' => ['comments_server_url', 'comments_site_id'],
  31. 'isso' => ['comments_server_url'],
  32. 'cusdis' => ['comments_server_url', 'comments_site_id'],
  33. 'giscus' => ['comments_repo', 'comments_repo_id', 'comments_category', 'comments_category_id', 'comments_mapping', 'comments_server_url'],
  34. 'utterances' => ['comments_repo', 'comments_mapping'],
  35. 'hyvor' => ['comments_site_id'],
  36. 'custom' => ['comments_custom_html'],
  37. ];
  38. ​
  39. public const DEFAULT_SERVERS = [
  40. 'commento' => 'https://cdn.commento.io',
  41. 'cusdis' => 'https://cusdis.com',
  42. 'giscus' => 'https://giscus.app',
  43. ];
  44. ​
  45. public const MAPPINGS = ['pathname', 'url', 'title', 'og:title'];
  46. ​
  47. // Cleans the posted comment settings. Anything that doesn't fit its format is dropped.
  48. public static function sanitizeSettings(array $post): array
  49. {
  50. $provider = array_key_exists((string) ($post['comments_provider'] ?? ''), self::PROVIDERS) ? (string) $post['comments_provider'] : 'disqus';
  51. $text = static fn(string $key, int $max): string => mb_substr(trim(str_replace(["\r", "\n"], ' ', (string) ($post[$key] ?? ''))), 0, $max);
  52. $match = static fn(string $value, string $pattern): string => preg_match($pattern, $value) === 1 ? $value : '';
  53. ​
  54. return [
  55. 'comments_enabled' => isset($post['comments_enabled']) ? '1' : '0',
  56. 'comments_jump_link' => isset($post['comments_jump_link']) ? '1' : '0',
  57. 'comments_provider' => $provider,
  58. 'comments_shortname' => $match(strtolower($text('comments_shortname', 64)), '/^[a-z0-9-]{1,64}$/'),
  59. 'comments_server_url' => self::cleanServerUrl($text('comments_server_url', 255)),
  60. 'comments_site_id' => $match($text('comments_site_id', 100), '/^[A-Za-z0-9_.:-]{1,100}$/'),
  61. 'comments_repo' => $match($text('comments_repo', 140), '/^[A-Za-z0-9_.-]{1,39}\/[A-Za-z0-9_.-]{1,100}$/'),
  62. 'comments_repo_id' => $match($text('comments_repo_id', 64), '/^[A-Za-z0-9_=-]{1,64}$/'),
  63. 'comments_category' => $text('comments_category', 100),
  64. 'comments_category_id' => $match($text('comments_category_id', 64), '/^[A-Za-z0-9_=-]{1,64}$/'),
  65. 'comments_mapping' => in_array($post['comments_mapping'] ?? '', self::MAPPINGS, true) ? (string) $post['comments_mapping'] : 'pathname',
  66. 'comments_custom_html' => (string) ($post['comments_custom_html'] ?? ''),
  67. 'comments_consent' => in_array($post['comments_consent'] ?? '', ['none', 'analytics', 'marketing'], true) ? (string) $post['comments_consent'] : 'marketing',
  68. 'comments_load' => ($post['comments_load'] ?? '') === 'click' ? 'click' : 'auto',
  69. 'comments_who' => array_key_exists((string) ($post['comments_who'] ?? ''), SiteComments::WHO) ? (string) $post['comments_who'] : 'users',
  70. 'comments_moderation' => array_key_exists((string) ($post['comments_moderation'] ?? ''), SiteComments::MODERATION) ? (string) $post['comments_moderation'] : 'all',
  71. 'comments_email' => array_key_exists((string) ($post['comments_email'] ?? ''), SiteComments::EMAIL) ? (string) $post['comments_email'] : 'off',
  72. ];
  73. }
  74. ​
  75. public static function cleanServerUrl(string $url): string
  76. {
  77. $url = rtrim(trim($url), '/');
  78. if ($url === '' || filter_var($url, FILTER_VALIDATE_URL) === false) {
  79. return '';
  80. }
  81. $scheme = strtolower((string) parse_url($url, PHP_URL_SCHEME));
  82. if (!in_array($scheme, ['https', 'http'], true) || preg_match('/["\'<>\s\\\\]/', $url) === 1) {
  83. return '';
  84. }
  85. ​
  86. return $url;
  87. }
  88. ​
  89. public static function isConfigured(array $settings): bool
  90. {
  91. if (($settings['comments_provider'] ?? '') === 'builtin') {
  92. return true;
  93. }
  94. ​
  95. return self::embedCode($settings, ['url' => '', 'id' => 'x', 'title' => '', 'slug' => 'x', 'lang' => 'en']) !== '';
  96. }
  97. ​
  98. // The comments box under an article: the service's code sits in a <template> and site.js
  99. // loads it once consent (if needed) and the visitor's click (if needed) allow it.
  100. public static function render(array $settings, array $article): string
  101. {
  102. if (($settings['comments_provider'] ?? '') === 'builtin') {
  103. return SiteComments::render($settings, $article);
  104. }
  105. ​
  106. $page = [
  107. 'url' => rtrim((string) Config::get('APP_URL', ''), '/') . SiteFront::articleUrl((string) $article['slug'], ''),
  108. 'id' => 'article-' . (int) $article['id'],
  109. 'title' => (string) $article['title'],
  110. 'slug' => (string) $article['slug'],
  111. 'lang' => Languages::htmlLang(),
  112. ];
  113. ​
  114. $code = self::embedCode($settings, $page);
  115. if ($code === '') {
  116. return '<p class="comments-placeholder">' . htmlspecialchars(Language::get('comments_coming_soon', 'Comments are coming soon.')) . '</p>';
  117. }
  118. ​
  119. $consent = ($settings['consent_manager_enabled'] ?? '0') === '1' ? (string) ($settings['comments_consent'] ?? 'marketing') : 'none';
  120. $consent = in_array($consent, ['analytics', 'marketing'], true) ? $consent : '';
  121. $load = ($settings['comments_load'] ?? 'auto') === 'click' ? 'click' : 'auto';
  122. ​
  123. return '<div class="comments-embed" data-consent="' . $consent . '" data-load="' . $load . '">'
  124. . '<template class="comments-embed-code">' . str_ireplace('</template', '<\/template', $code) . '</template>'
  125. . '<div class="comments-embed-target"></div>'
  126. . '<div class="comments-embed-notice" hidden><p>' . htmlspecialchars(Language::get('comments_consent_text', 'Comments come from an outside service that uses cookies. Allow them in the cookie settings to read and write comments.')) . '</p>'
  127. . '<button type="button" class="comments-embed-consent">' . htmlspecialchars(Language::get('comments_consent_button', 'Cookie settings')) . '</button></div>'
  128. . '<div class="comments-embed-click" hidden><p>' . htmlspecialchars(Language::get('comments_load_note', 'Comments are loaded from an outside service only when you ask for them.')) . '</p>'
  129. . '<button type="button" class="comments-embed-load">' . htmlspecialchars(Language::get('comments_load_button', 'Show comments')) . '</button></div>'
  130. . '</div>';
  131. }
  132. ​
  133. private static function embedCode(array $settings, array $page): string
  134. {
  135. $e =static fn(string $value): string => htmlspecialchars($value, ENT_QUOTES);
  136. $js = static fn(string $value): string => (string) json_encode($value, JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT);
  137. $provider = (string) ($settings['comments_provider'] ?? '');
  138. $server = self::cleanServerUrl((string) ($settings['comments_server_url'] ?? ''));
  139. $server = $server !== '' ? $server : (self::DEFAULT_SERVERS[$provider] ?? '');
  140. $siteId = (string) ($settings['comments_site_id'] ?? '');
  141. $repo = (string) ($settings['comments_repo'] ?? '');
  142. $mapping = in_array($settings['comments_mapping'] ?? '', self::MAPPINGS, true) ? (string) $settings['comments_mapping'] : 'pathname';
  143. ​
  144. switch ($provider) {
  145. case 'disqus':
  146. $shortname = (string) ($settings['comments_shortname'] ?? '');
  147. if (preg_match('/^[a-z0-9-]{1,64}$/', $shortname) !== 1) {
  148. return '';
  149. }
  150. return '<div id="disqus_thread"></div><script>'
  151. . 'var disqus_config = function () { this.page.url = ' . $js($page['url']) . '; this.page.identifier = ' . $js($page['id']) . '; this.page.title = ' . $js($page['title']) . '; };'
  152. . '(function () { var s = document.createElement("script"); s.src = "https://' . $shortname . '.disqus.com/embed.js"; s.setAttribute("data-timestamp", String(+new Date())); (document.head || document.body).appendChild(s); })();'
  153. . '</script>';
  154. ​
  155. case 'commento':
  156. if ($server === '') {
  157. return '';
  158. }
  159. return '<div id="commento"></div><script defer src="' . $e($server . '/js/commento.js') . '" data-page-id="' . $e($page['slug']) . '"></script>';
  160. ​
  161. case 'remark42':
  162. if ($server === '' || $siteId === '') {
  163. return '';
  164. }
  165. return '<div id="remark42"></div><script>'
  166. . 'var remark_config = { host: ' . $js($server) . ', site_id: ' . $js($siteId) . ', url: ' . $js($page['url']) . ', page_title: ' . $js($page['title']) . ', components: ["embed"], theme: document.body.getAttribute("data-theme") === "dark" ? "dark" : "light" };'
  167. . '(function (c) { for (var i = 0; i < c.length; i++) { var d = document, s = d.createElement("script"); s.src = remark_config.host + "/web/" + c[i] + ".js"; s.defer = true; (d.head || d.body).appendChild(s); } })(remark_config.components);'
  168. . '</script>';
  169. ​
  170. case 'isso':
  171. if ($server === '') {
  172. return '';
  173. }
  174. return '<script data-isso="' . $e($server . '/') . '" data-isso-lang="' . $e($page['lang']) . '" src="' . $e($server . '/js/embed.min.js') . '"></script>'
  175. . '<section id="isso-thread" data-isso-id="' . $e($page['id']) . '" data-title="' . $e($page['title']) . '"></section>';
  176. ​
  177. case 'cusdis':
  178. if ($server === '' || $siteId === '') {
  179. return '';
  180. }
  181. return '<div id="cusdis_thread" data-host="' . $e($server) . '" data-app-id="' . $e($siteId) . '" data-page-id="' . $e($page['id']) . '" data-page-url="' . $e($page['url']) . '" data-page-title="' . $e($page['title']) . '"></div>'
  182. . '<script async defer src="' . $e($server . '/js/cusdis.es.js') . '"></script>';
  183. ​
  184. case 'giscus':
  185. $repoId = (string) ($settings['comments_repo_id'] ?? '');
  186. $categoryId = (string) ($settings['comments_category_id'] ?? '');
  187. if ($server === '' || $repo === '' || $repoId === '' || $categoryId === '') {
  188. return '';
  189. }
  190. return '<script src="' . $e($server . '/client.js') . '" data-repo="' . $e($repo) . '" data-repo-id="' . $e($repoId) . '"'
  191. . ' data-category="' . $e((string) ($settings['comments_category'] ?? '')) . '" data-category-id="' . $e($categoryId) . '"'
  192. . ' data-mapping="' . $e($mapping) . '" data-strict="0" data-reactions-enabled="1" data-emit-metadata="0" data-input-position="top"'
  193. . ' data-theme="preferred_color_scheme" data-lang="' . $e(substr($page['lang'], 0, 2)) . '" data-loading="lazy" crossorigin="anonymous" async></script>';
  194. ​
  195. case 'utterances':
  196. if ($repo === '') {
  197. return '';
  198. }
  199. return '<script src="https://utteranc.es/client.js" repo="' . $e($repo) . '" issue-term="' . $e($mapping) . '" theme="preferred-color-scheme" crossorigin="anonymous" async></script>';
  200. ​
  201. case 'hyvor':
  202. if ($siteId === '') {
  203. return '';
  204. }
  205. return '<script async src="https://talk.hyvor.com/embed/embed.js" type="module"></script>'
  206. . '<hyvor-talk-comments website-id="' . $e($siteId) . '" page-id="' . $e($page['id']) . '"></hyvor-talk-comments>';
  207. ​
  208. case 'custom':
  209. $template = trim((string) ($settings['comments_custom_html'] ?? ''));
  210. if ($template === '') {
  211. return '';
  212. }
  213. // Values are HTML-escaped and made safe for JavaScript strings (quotes, backslashes,
  214. // backticks and ${), so they can't break out of the code they are placed in.
  215. $safe = static fn(string $value): string => str_replace(['\\', '`', '${', "\r", "\n"], ['&#92;', '&#96;', '&#36;{', ' ', ' '], htmlspecialchars($value, ENT_QUOTES));
  216. return strtr($template, [
  217. '{{url}}' => $safe($page['url']),
  218. '{{id}}' => $safe($page['id']),
  219. '{{title}}' => $safe($page['title']),
  220. '{{slug}}' => $safe($page['slug']),
  221. '{{lang}}' => $safe($page['lang']),
  222. ]);
  223. }
  224. ​
  225. return '';
  226. }
  227. }
  228. ​