Automatically generate descriptions for org-mode links

org-link-desc.el

;;; org-link-desc.el --- Automatically generate descriptions for org-mode links  -*- lexical-binding: t; -*-

;; Copyright (C) 2023 Your Name

;; Author: Your Name <your-email@example.com>
;; Version: 1.0
;; Package-Requires: ((emacs "26.1") (org "9.0"))
;; Keywords: org, convenience
;; URL: https://github.com/yourusername/org-link-desc

;; 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 <https://www.gnu.org/licenses/>.

;;; Commentary:

;; This package provides a function to automatically generate descriptions
;; for org-mode links when using `org-insert-link`. By default, it uses the
;; link itself as the description, but you can customize it to extract parts
;; of the link or fetch metadata (e.g., webpage titles).

;;; Code:

(require 'org)

(defun org-link-desc--default-description (link)
  "Generate a default description for LINK."
  link)

(defun org-link-desc--file-description (link)
  "Generate a description for file links using the file name."
  (file-name-nondirectory link))

(defun org-link-desc--url-title (url)
  "Fetch the title of a webpage at URL."
  (with-temp-buffer
    (url-insert-file-contents url)
    (goto-char (point-min))
    (if (search-forward "<title>" nil t)
        (let ((start (point)))
          (search-forward "</title>" nil t)
          (buffer-substring start (match-beginning 0)))
      url)))

(defun org-link-desc-insert-link (&optional custom-description-fn)
  "Insert an org-mode link with an automatically generated description.
If CUSTOM-DESCRIPTION-FN is provided, it is used to generate the description.
Otherwise, the default behavior is to use the link itself as the description."
  (interactive)
  (let* ((link (read-string "Link: "))
         (description (if custom-description-fn
                          (funcall custom-description-fn link)
                        (org-link-desc--default-description link))))
    (org-insert-link nil link description)))

;;;###autoload
(defun org-link-desc-insert-link-with-file-name ()
  "Insert an org-mode link with the file name as the description."
  (interactive)
  (org-link-desc-insert-link #'org-link-desc--file-description))

;;;###autoload
(defun org-link-desc-insert-link-with-url-title ()
  "Insert an org-mode link with the webpage title as the description."
  (interactive)
  (org-link-desc-insert-link #'org-link-desc--url-title))

(provide 'org-link-desc)

;;(define-key org-mode-map (kbd "C-c l f") 'org-link-desc-insert-link-with-file-name)
;;(define-key org-mode-map (kbd "C-c l l") 'org-link-desc-insert-link-with-url-title)

;;; org-link-desc.el ends here