;;; jabber-activity.el --- show jabber activity in the mode line  -*- lexical-binding: t; -*-

;; Copyright (C) 2004 Carl Henrik Lunde - <chlunde+jabber+@ping.uio.no>
;; Copyright (C) 2026  Thanos Apollo

;; Maintainer: Thanos Apollo <public@thanosapollo.org>

;; This file is a part of jabber.el

;; 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 2, or (at your option)
;; any later version.

;; GNU Emacs 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 GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Commentary:

;; Allows tracking messages from buddies using the global mode line
;; See (info "(jabber)Tracking activity")

;;; Code:

(require 'cl-lib)
(require 'seq)
(require 'jabber-core)
(require 'jabber-util)

(defgroup jabber-activity nil
  "Activity tracking options."
  :group 'jabber)

;; All the (featurep 'jabber-activity) is so we don't call a function
;; with an autoloaded cookie while the file is loading, since that
;; would lead to endless load recursion.

(defcustom jabber-activity-make-string 'jabber-activity-make-string-default
  "Function to call to show a string in the modeline.
The default function returns the nick of the user."
  :set #'(lambda (var val)
	   (custom-set-default var val)
	   (when (and (featurep 'jabber-activity)
		      (fboundp 'jabber-activity-make-name-alist))
	     (jabber-activity-make-name-alist)
	     (jabber-activity-mode-line-update)))
  :type 'function)

(defcustom jabber-activity-shorten-minimum 1
  "Length of the strings returned by `jabber-activity-make-strings-shorten'.
All strings returned by `jabber-activity-make-strings-shorten' will be
at least this long, when possible."
  :type 'number)

(defcustom jabber-activity-shorten-cutoff 2
  "Maximum number of JIDs to display in the mode line.
When non-nil and more JIDs are active than this number, only the
first CUTOFF entries are shown followed by \", +N\"."
  :type '(choice (const :tag "No limit" nil)
		 (integer :tag "Maximum entries")))

(defcustom jabber-activity-shorten-aggressively nil
  "If non-nil, shorten names more aggressively.
When set, names may use prefixes shorter than
`jabber-activity-shorten-minimum' as long as they remain unique."
  :type 'boolean)

(defcustom jabber-activity-muc-prefix "#"
  "String prepended to MUC names in the mode line.
Set to an empty string to disable the prefix."
  :type 'string)

(defcustom jabber-activity-make-strings #'jabber-activity-make-strings-shorten
  "Function which should return an alist of JID -> string when given a list of
JIDs."
  :set #'(lambda (var val)
	   (custom-set-default var val)
	   (when (and (featurep 'jabber-activity)
		      (fboundp 'jabber-activity-make-name-alist))
	     (jabber-activity-make-name-alist)
	     (jabber-activity-mode-line-update)))
  :type '(choice (function-item :tag "Keep strings"
				:value jabber-activity-make-strings-default)
		 (function-item :tag "Shorten strings"
				:value jabber-activity-make-strings-shorten)
		 (function :tag "Other function")))

(defcustom jabber-activity-count-in-title nil
  "If non-nil, display number of active JIDs in frame title."
  :type 'boolean)

(defcustom jabber-activity-count-in-title-format
  '(jabber-activity-jids ("[" jabber-activity-count-string "] "))
  "Format string used for displaying activity in frame titles.
Same syntax as `mode-line-format'."
  :type 'sexp)

(defcustom jabber-activity-show-p 'jabber-activity-show-p-default
  "Function that checks if the given JID should be shown on the mode line.
Predicate function to call to check if the given JID should be
shown in the mode line or not."
  :type 'function)

(defcustom jabber-activity-query-unread t
  "Query the user as to whether killing Emacs should be cancelled when
there are unread messages which otherwise would be lost."
  :type 'boolean)

(defcustom jabber-activity-banned nil
  "List of regexps of banned JID"
  :type '(repeat string))

(defface jabber-activity-chat-face
  '((t :inherit font-lock-warning-face))
  "Face for 1:1 chat activity in the mode line.")

(defface jabber-activity-mention-face
  '((t :inherit font-lock-warning-face))
  "Face for personal mentions (MUC highlight) in the mode line.")

(defface jabber-activity-muc-face
  '((t :inherit font-lock-keyword-face))
  "Face for MUC (groupchat) activity in the mode line.")

(define-obsolete-face-alias 'jabber-activity-face
			    'jabber-activity-chat-face "30.1")
(define-obsolete-face-alias 'jabber-activity-personal-face
			    'jabber-activity-mention-face "30.1")

(defvar jabber-activity-jids nil
  "A list of JIDs which have caused activity.")

(defvar jabber-activity-personal-jids nil
  "Subset of `jabber-activity-jids' for JIDs with \"personal\" activity.")

(defvar jabber-activity-name-alist nil
  "Alist of mode line names for bare JIDs.")

(defvar jabber-activity-mode-string ""
  "The mode string for jabber activity.")

(defvar jabber-activity-count-string "0"
  "Number of active JIDs as a string.")

(defvar jabber-activity-update-hook nil
  "Hook called when `jabber-activity-jids' changes.
It is called after `jabber-activity-mode-string' and
`jabber-activity-count-string' are updated.")

(defvar jabber-activity--updating nil
  "Non-nil while activity code is running.
Prevents recursive calls from `buffer-list-update-hook' and
`window-configuration-change-hook' triggered during updates.")

(defvar jabber-activity--shortened-names (make-hash-table :test #'equal)
  "Cache mapping sorted JID lists to shortened name alists.
Invalidated when `jabber-activity-make-name-alist' rebuilds.")

;; Global reference declarations

(declare-function jabber-chat-find-buffer "jabber-chat.el" (chat-with))
(declare-function jabber-muc-find-buffer "jabber-muc.el" (group))
(declare-function jabber-muc-private-find-buffer "jabber-muc.el"
                  (group nickname))
(declare-function jabber-muc-sender-p "jabber-muc.el" (jid))
(declare-function jabber-muc-joined-p "jabber-muc.el" (group &optional jc))
(declare-function jabber-muc-looks-like-personal-p
                  "jabber-muc-nick-completion.el" (message &optional group))
(defvar jabber-silent-mode)             ; jabber.el

;;

(defun jabber-activity-make-string-default (jid)
  "Return the nick of the JID.
If no nick is available, return the user name part of the JID. In
private MUC conversations, return the user's nickname."
  (if (jabber-muc-sender-p jid)
      (jabber-jid-resource jid)
    (let ((nick (jabber-jid-displayname jid))
	  (user (jabber-jid-user jid))
	  (username (jabber-jid-username jid)))
      (if (and username (string= nick user))
	  username
	nick))))

(defun jabber-activity-make-strings-default (jids)
  "Apply `jabber-activity-make-string' on JIDS."
  (mapcar #'(lambda (jid) (cons jid (funcall jabber-activity-make-string jid)))
	  jids))

(defun jabber-activity-common-prefix (s1 s2)
  "Return length of common prefix string shared by S1 and S2."
  (let ((len (min (length s1) (length s2))))
    (or (cl-dotimes (i len)
	  (when (not (eq (aref s1 i) (aref s2 i)))
	    (cl-return i)))
	;; Substrings, equal, nil, or empty ("")
	len)))

(defun jabber-activity--compute-shortening (jids)
  "Compute shortened names for JIDS.
Return an alist of (JID . short-name).  This is the uncached
workhorse for `jabber-activity-make-strings-shorten'."
  (let ((alist
	 (sort (mapcar
		(lambda (x) (cons x (funcall jabber-activity-make-string x)))
		jids)
	       (lambda (x y) (string-lessp (cdr x) (cdr y)))))
	(min-len (if jabber-activity-shorten-aggressively
		     1
		   jabber-activity-shorten-minimum)))
    (cl-loop
     for ((_prev-jid . prev) (cur-jid . cur) (_next-jid . next))
     on (cons nil alist)
     until (null cur)
     collect
     (cons
      cur-jid
      (substring
       cur
       0 (min (length cur)
	      (max min-len
		   (1+ (jabber-activity-common-prefix cur prev))
		   (1+ (jabber-activity-common-prefix cur next)))))))))

(defun jabber-activity-make-strings-shorten (jids)
  "Return an alist of (JID . short-names).
This is acquired by running `jabber-activity-make-string' on
JIDS, and then shortening the names as much as possible such that
all strings still are unique and at least
`jabber-activity-shorten-minimum' long.
When `jabber-activity-shorten-aggressively' is non-nil, the
minimum length constraint is relaxed to 1.
Results are cached in `jabber-activity--shortened-names'."
  (let ((key (sort (copy-sequence jids) #'string-lessp)))
    (or (gethash key jabber-activity--shortened-names)
	(puthash key (jabber-activity--compute-shortening jids)
		 jabber-activity--shortened-names))))

(defun jabber-activity-find-buffer-name (jid)
  "Find the buffer that messages from JID would use, or nil."
  (or (and (jabber-jid-resource jid)
	   (jabber-muc-private-find-buffer
	    (jabber-jid-user jid)
	    (jabber-jid-resource jid)))
      (jabber-chat-find-buffer jid)
      (jabber-muc-find-buffer jid)))

(defun jabber-activity-show-p-default (jid)
  "Return non-nil if JID should be shown in the mode line.
A JID is shown when it is not banned and its buffer (if any) is
not currently visible."
  (let ((buffer (jabber-activity-find-buffer-name jid)))
    (and (not (cl-dolist (entry jabber-activity-banned)
		(when (string-match entry jid)
                  (cl-return t))))
	 (or (null buffer)
	     (not (get-buffer-window buffer 'visible))))))

(defun jabber-activity-make-name-alist (&optional _jc)
  "Rebuild `jabber-activity-name-alist' based on currently known JIDs."
  (let ((jids (or (mapcar #'car jabber-activity-name-alist)
		  (mapcar #'symbol-name *jabber-roster*))))
    (setq jabber-activity-name-alist
	  (funcall jabber-activity-make-strings jids)))
  (clrhash jabber-activity--shortened-names))

(defun jabber-activity-lookup-name (jid)
  "Lookup JID in `jabber-activity-name-alist'.
Return a (jid . string) pair suitable for the mode line, creating
an entry if needed."
  (let ((elm (assoc jid jabber-activity-name-alist)))
    (or elm
	(progn
	  ;; Remake alist with the new JID
	  (setq jabber-activity-name-alist
		(funcall jabber-activity-make-strings
		         (cons jid (mapcar #'car jabber-activity-name-alist))))
	  (clrhash jabber-activity--shortened-names)
	  (jabber-activity-lookup-name jid)))))

(defun jabber-activity--propertize-entry (entry)
  "Return a propertized mode-line string for ENTRY.
ENTRY is a (JID . name) cons cell from `jabber-activity-lookup-name'.
MUC JIDs get a # prefix (not included in the shortening calculation)."
  (let* ((jid (car entry))
	 (name (cdr entry))
	 (mucp (jabber-muc-joined-p jid))
	 (display (if mucp (concat jabber-activity-muc-prefix name) name))
	 (face (cond
		((member jid jabber-activity-personal-jids)
		 'jabber-activity-mention-face)
		(mucp 'jabber-activity-muc-face)
		(t 'jabber-activity-chat-face))))
    (propertize display 'face face 'jabber-modeline t
                'help-echo jid)))

(defun jabber-activity--sort-jids (jids)
  "Return JIDS sorted with personal mentions first."
  (let (personal other)
    (dolist (jid jids)
      (if (member jid jabber-activity-personal-jids)
          (push jid personal)
        (push jid other)))
    (nconc (nreverse personal) (nreverse other))))

(defun jabber-activity-mode-line-update ()
  "Update the string shown in the mode line.
Recomputes `jabber-activity-mode-string' and
`jabber-activity-count-string' from `jabber-activity-jids'."
  (unless jabber-activity--updating
    (let* ((jabber-activity--updating t)
	   (sorted (jabber-activity--sort-jids jabber-activity-jids))
	   (entries (mapcar #'jabber-activity-lookup-name sorted))
	   (total (length entries))
	   (overflow (when (and jabber-activity-shorten-cutoff
				(> total jabber-activity-shorten-cutoff))
		       (- total jabber-activity-shorten-cutoff)))
	   (visible (if overflow
			(seq-take entries jabber-activity-shorten-cutoff)
		      entries))
	   (new-mode-string
	    (if jabber-activity-jids
		(concat
		 (propertize "[" 'face 'shadow 'jabber-modeline t)
		 (mapconcat #'jabber-activity--propertize-entry visible
			    (propertize "," 'face 'shadow 'jabber-modeline t))
		 (when overflow
		   (propertize (format ", +%d" overflow)
			       'face 'shadow 'jabber-modeline t))
		 (propertize "]" 'face 'shadow 'jabber-modeline t))
	      ""))
	   (new-count-string (number-to-string total))
	   (changed nil))
      (unless (equal-including-properties jabber-activity-mode-string
					  new-mode-string)
	(setq jabber-activity-mode-string new-mode-string
	      changed t))
      (unless (string= jabber-activity-count-string new-count-string)
	(setq jabber-activity-count-string new-count-string
	      changed t))
      (when changed
	(force-mode-line-update 'all)
	(run-hooks 'jabber-activity-update-hook)))))

;;; Hooks

(defun jabber-activity-clean ()
  "Remove JIDs where `jabber-activity-show-p' no longer is true."
  (unless jabber-activity--updating
    (let* ((jabber-activity--updating t)
           (new-jids (cl-remove-if-not jabber-activity-show-p
                                       jabber-activity-jids))
           (new-personal (cl-remove-if-not jabber-activity-show-p
                                           jabber-activity-personal-jids))
           (changed (or (not (equal new-jids jabber-activity-jids))
                        (not (equal new-personal jabber-activity-personal-jids)))))
      (setq jabber-activity-jids new-jids
            jabber-activity-personal-jids new-personal)
      (when changed
        (let ((jabber-activity--updating nil))
          (jabber-activity-mode-line-update))))))

(defun jabber-activity-add (from _buffer _text _proposed-alert)
  "Add a JID to mode line when `jabber-activity-show-p'."
  (when (funcall jabber-activity-show-p from)
    (add-to-list 'jabber-activity-jids from)
    (add-to-list 'jabber-activity-personal-jids from)
    (jabber-activity-mode-line-update)))

(defun jabber-activity-add-muc (_nick group _buffer text _proposed-alert)
  "Add GROUP to mode line.  Track personal mentions separately."
  (when (funcall jabber-activity-show-p group)
    (add-to-list 'jabber-activity-jids group)
    (when (jabber-muc-looks-like-personal-p text group)
      (add-to-list 'jabber-activity-personal-jids group))
    (jabber-activity-mode-line-update)))

(defun jabber-activity-presence (who _oldstatus newstatus _statustext _proposed-alert)
  "Add a JID to mode line on subscription requests."
  (when (string= newstatus "subscribe")
    (add-to-list 'jabber-activity-jids (symbol-name who))
    (add-to-list 'jabber-activity-personal-jids (symbol-name who))
    (jabber-activity-mode-line-update)))

(defun jabber-activity-kill-hook ()
  "Query the user if is sure to kill Emacs when there are unread messages.
Query the user as to whether killing Emacs should be cancelled
when there are unread messages which otherwise would be lost, if
`jabber-activity-query-unread' is t"
  (if (and jabber-activity-jids
	   jabber-activity-query-unread)
      (or jabber-silent-mode (yes-or-no-p
			      "You have unread Jabber messages, are you sure you want to quit?"))
    t))

;;; Interactive functions

(defvar jabber-activity-last-buffer nil
  "Last non-Jabber buffer used.")

(defun jabber-activity-switch-to (&optional jid-param)
  "Switch to the buffer for JID-PARAM, or the next active JID.
If no activity, switch back to the last non-Jabber buffer."
  (interactive)
  (if (or jid-param jabber-activity-jids)
      (let* ((jid (or jid-param (car jabber-activity-jids)))
             (buf (jabber-activity-find-buffer-name jid)))
        (unless (eq major-mode 'jabber-chat-mode)
          (setq jabber-activity-last-buffer (current-buffer)))
        (if buf
            (switch-to-buffer buf)
          (setq jabber-activity-jids (delete jid jabber-activity-jids)
                jabber-activity-personal-jids
                (delete jid jabber-activity-personal-jids))
          (jabber-activity-mode-line-update)
          (message "Buffer for %s no longer exists" jid))
        (jabber-activity-clean))
    (if (eq major-mode 'jabber-chat-mode)
        (when (buffer-live-p jabber-activity-last-buffer)
          (switch-to-buffer jabber-activity-last-buffer))
      (message "No new activity"))))

;;; Disconnect cleanup

(defun jabber-activity--on-disconnect ()
  "Clear activity tracking state on disconnect."
  (setq jabber-activity-jids nil
        jabber-activity-personal-jids nil)
  (jabber-activity-mode-line-update))

;;; Init/teardown for jabber-modeline-mode

(defun jabber-activity--init ()
  "Register activity tracking hooks.
Called by `jabber-modeline-mode' when enabling."
  (add-hook 'window-configuration-change-hook
	    #'jabber-activity-clean)
  (add-hook 'jabber-message-hooks
	    #'jabber-activity-add)
  (add-hook 'jabber-muc-hooks
	    #'jabber-activity-add-muc)
  (add-hook 'jabber-presence-hooks
	    #'jabber-activity-presence)
  (add-hook 'jabber-post-connect-hooks
	    #'jabber-activity-make-name-alist)
  (add-hook 'kill-emacs-query-functions
	    #'jabber-activity-kill-hook))

(defun jabber-activity--teardown ()
  "Unregister activity tracking hooks.
Called by `jabber-modeline-mode' when disabling."
  (remove-hook 'window-configuration-change-hook
	       #'jabber-activity-clean)
  (remove-hook 'jabber-message-hooks
	       #'jabber-activity-add)
  (remove-hook 'jabber-muc-hooks
	       #'jabber-activity-add-muc)
  (remove-hook 'jabber-presence-hooks
	       #'jabber-activity-presence)
  (remove-hook 'jabber-post-connect-hooks
	       #'jabber-activity-make-name-alist)
  (remove-hook 'kill-emacs-query-functions
	       #'jabber-activity-kill-hook))

(provide 'jabber-activity)

;;; jabber-activity.el ends here
