org-social.el/org-social-variables.el

;;; org-social-variables.el --- Variables for the Org-social client -*- lexical-binding: t -*- -*- coding: utf-8 -*-

;; SPDX-License-Identifier: GPL-3.0

;; Author: Andros Fenollosa <hi@andros.dev>
;; Version: 2.10
;; URL: https://github.com/tanrax/org-social.el

;; This file is NOT part of GNU Emacs.

;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation, either version 3 of the
;; License, or (at your option) any later version.

;; This program is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
;; General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see
;; <http://www.gnu.org/licenses/>.

;;; Commentary:

;; Configuration variables and constants for the Org-social client.

;;; Code:

;; Forward declarations to avoid compiler warnings
(declare-function org-social-polls--vote-on-poll "org-social-polls" ())
(declare-function org-social-new-post "org-social" (&optional reply-url reply-id))
(declare-function org-social-new-poll "org-social" ())

;; Customization

(defcustom org-social-file "~/social.org"
  "Path to your Org-social feed file."
  :type 'file
  :group 'org-social)

(defcustom org-social-hide-post-buttons nil
  "When non-nil, hide Reply and Profile buttons from timeline posts.
This creates a cleaner timeline view by removing the interactive buttons
at the end of each post.  You can still use keyboard shortcuts to reply (r)
and view profiles (P)."
  :type 'boolean
  :group 'org-social)

(defcustom org-social-post-preview-length 400
  "Maximum number of characters to show in a post before truncating.
If a post exceeds this length, it will be truncated and a \\'Read more\\' button
will appear to view the full post.  Set to nil to disable truncation and
always show full posts."
  :type '(choice (integer :tag "Character limit")
                 (const :tag "No limit" nil))
  :group 'org-social)

(defcustom org-social-live-preview-url "https://preview.org-social.org/?post="
  "Base URL for live post previews.
When set to a non-nil value, a Share button will appear in the post buttons row
that opens the post preview in the system's native browser.  The post URL is
URL-encoded and appended to this base URL.
Example: \"https://preview.org-social.org/?post=\" generates URLs like
\"https://preview.org-social.org/?post=https%3A%2F%2Ffoo.org%2Fsocial.org%232025-02-03T23%3A05%3A00%2B0100\""
  :type '(choice (const :tag "No live preview URL" nil)
                 (string :tag "Live preview base URL"))
  :group 'org-social)

(defcustom org-social-relay "https://relay.org-social.org"
  "URL of the Org Social Relay server.
When set, the relay will be used to register your feed and discover mentions,
replies, and other social interactions.
Default is set to the public relay server."
  :type '(choice (const :tag "No relay server" nil)
                 (string :tag "Relay server URL"))
  :group 'org-social)

(defcustom org-social-realtime-notifications nil
  "When non-nil, receive real-time notifications via SSE from the relay.
Requires `org-social-relay' and `org-social-my-public-url' to be configured.
When enabled, you'll receive desktop notifications for mentions, reactions,
replies, and boosts as they happen."
  :type 'boolean
  :group 'org-social)

(defcustom org-social-my-public-url nil
  "Public URL of your social.org file.
This is the URL where others can access your social.org file.
Example: \"https://example.com/social.org\""
  :type '(choice (const :tag "No public URL" nil)
                 (string :tag "Public URL"))
  :group 'org-social)

(defcustom org-social-only-relay-followers-p nil
  "When non-nil, use only feeds from the relay server for timeline.
If t, the timeline will be built exclusively from feeds listed in the relay,
ignoring local followers list.  This requires both `org-social-relay' and
`org-social-my-public-url' to be configured."
  :type 'boolean
  :group 'org-social)

(defcustom org-social-hashtag-color "#ffaa00"
  "Color for hashtag highlighting in posts.
This color is used when displaying hashtags (#tag) in the user interface.
Should be a hex color code like \"#ffaa00\" for yellow."
  :type 'string
  :group 'org-social)

(defcustom org-social-image-cache-directory "~/.org-social-cache/"
  "Directory for caching downloaded profile images.
Images are downloaded and cached to avoid repeated network requests."
  :type 'directory
  :group 'org-social)

(defcustom org-social-default-lang nil
  "Default language code for new posts.
When set, this value will be automatically inserted in the :LANG: property
of new posts and polls.  Should be a two-letter ISO 639-1 language code
\(e.g., \"en\", \"es\", \"fr\").
When nil or empty string, the :LANG: field will be left empty."
  :type '(choice (const :tag "No default language" nil)
                 (string :tag "Language code (e.g., en, es, fr)"))
  :group 'org-social)

(defcustom org-social-max-post-age-days 14
  "Maximum age of posts to fetch from feeds, in days.
When fetching feeds, only posts newer than this many days will be downloaded
using optimized partial downloads with HTTP Range requests.  Each feed is
downloaded in a separate thread for parallel execution without blocking Emacs.
For servers supporting Range requests, this can save up bandwidth.
For servers without Range support, the full feed is downloaded
and filtered.  Set to nil to disable filtering and download all posts.
Default: 14 days (2 weeks)."
  :type '(choice (integer :tag "Days (e.g., 7, 14, 30)")
                 (const :tag "No limit (download all posts)" nil))
  :group 'org-social)

(defcustom org-social-max-concurrent-downloads 20
  "Maximum number of concurrent feed downloads.
When loading the timeline, feeds are downloaded in parallel to improve speed.
This setting limits how many downloads can run simultaneously to avoid
overwhelming system resources or triggering rate limits on remote servers.
Recommended range: 10-30.  Higher values = faster but more resource intensive.
Default: 20."
  :type 'integer
  :group 'org-social)

(defcustom org-social-language-filter nil
  "List of language codes to filter timeline posts.
When set to a list of ISO 639-1 two-letter language codes
\(e.g., \\='(\"en\" \"es\")), only posts with a :LANG: property matching one of
these codes will be shown in the timeline.  When nil, all posts are shown
regardless of language.  Posts without a :LANG: property or with empty
:LANG: are hidden when filter is active.
Examples:
  \\='(\"en\")           - Show only English posts
  \\='(\"en\" \"es\")      - Show English and Spanish posts
  nil               - Show all posts (default)"
  :type '(choice (const :tag "Show all languages" nil)
                 (repeat :tag "Language codes" string))
  :group 'org-social)

;; Variables for state management

(defvar org-social-variables--feeds nil
  "List of parsed feeds from followers.")

(defvar org-social-variables--my-profile nil
  "Current user's profile information.")

(defvar org-social-variables--queue nil
  "Queue for downloading feeds asynchronously.")

(defvar org-social-variables--posts-with-replies nil
  "Alist of posts that have replies.
Each entry is (post-url . t) for posts with replies.")

;; Hooks

(defvar org-social-after-fetch-posts-hook nil
  "Hook run after all feeds have been fetched.")

(defvar org-social-after-save-file-hook nil
  "Hook run after saving the social file.")

;; Keymap for org-social mode (empty - use global bindings instead)

(defvar org-social-variables--mode-map
  (make-sparse-keymap)
  "Keymap for `org-social-mode'.")


(provide 'org-social-variables)
;;; org-social-variables.el ends here