2021-04-29 10:08:52 +00:00
|
|
|
|
;;; eshell-info-banner.el --- System information as your Eshell banner -*- lexical-binding: t -*-
|
|
|
|
|
|
|
|
|
|
;; Author: Lucien Cartier-Tilet <lucien@phundrak.com>
|
2021-05-02 15:57:03 +00:00
|
|
|
|
;; Maintainer: Lucien Cartier-Tilet <lucien@phundrak.com>
|
2022-05-31 09:35:35 +00:00
|
|
|
|
;; Version: 0.8.8
|
2022-01-07 11:06:39 +00:00
|
|
|
|
;; Package-Requires: ((emacs "25.1") (s "1"))
|
2021-12-18 15:31:27 +00:00
|
|
|
|
;; Homepage: https://github.com/Phundrak/eshell-info-banner.el
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
|
|
|
|
;; 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 <https://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
2021-11-10 07:43:11 +00:00
|
|
|
|
;; `eshell-info-banner' is a utility for creating an informative
|
2021-05-17 15:14:43 +00:00
|
|
|
|
;; banner akin to fish_greeting if fish shell but for Eshell. It can
|
|
|
|
|
;; provide information on:
|
|
|
|
|
;; - the OS’ name
|
|
|
|
|
;; - the OS’ kernel
|
|
|
|
|
;; - the hostname
|
|
|
|
|
;; - the uptime
|
|
|
|
|
;; - the system’s memory usage (RAM, swap, disk)
|
|
|
|
|
;; - the battery status
|
|
|
|
|
;; It can be TRAMP-aware or not, depending on the user’s preferences.
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
|
|
|
|
;;; Code:
|
|
|
|
|
|
|
|
|
|
(require 'cl-lib)
|
2022-05-31 08:46:27 +00:00
|
|
|
|
(require 's)
|
2021-04-29 18:07:16 +00:00
|
|
|
|
(require 'em-banner)
|
2021-11-07 09:51:50 +00:00
|
|
|
|
(require 'json)
|
2021-11-10 18:48:59 +00:00
|
|
|
|
(require 'seq)
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
2021-05-17 15:17:21 +00:00
|
|
|
|
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
|
; Group ;
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
2021-04-30 14:59:42 +00:00
|
|
|
|
(defgroup eshell-info-banner ()
|
2021-04-29 10:08:52 +00:00
|
|
|
|
"System information as your Eshell banner."
|
2021-11-08 12:30:32 +00:00
|
|
|
|
:group 'eshell
|
2021-04-29 10:08:52 +00:00
|
|
|
|
:prefix "eshell-info-banner-"
|
2021-05-02 15:57:03 +00:00
|
|
|
|
:link '(url-link :tag "Gitea" "https://labs.phundrak.com/phundrak/eshell-info-banner.el")
|
|
|
|
|
:link '(url-link :tag "Github" "https://github.com/Phundrak/eshell-info-banner.el"))
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
2021-05-17 15:17:21 +00:00
|
|
|
|
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
|
; Constants ;
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
2022-01-14 10:21:29 +00:00
|
|
|
|
(defconst eshell-info-banner-path-separator
|
|
|
|
|
(substring-no-properties (file-relative-name (expand-file-name "x" "y")) 1 2)
|
|
|
|
|
"File separator used by the current operating system.")
|
2022-01-07 11:06:39 +00:00
|
|
|
|
|
2021-04-29 12:17:51 +00:00
|
|
|
|
(defconst eshell-info-banner--min-length-left 8
|
|
|
|
|
"Minimum length of text on the left hand side of the banner.")
|
2021-11-07 09:51:50 +00:00
|
|
|
|
|
|
|
|
|
(eval-when-compile
|
|
|
|
|
(defconst eshell-info-banner--macos-versions
|
2022-03-26 09:32:17 +00:00
|
|
|
|
'(("^10\\.0\\." . "Mac OS X Cheetah")
|
|
|
|
|
("^10\\.1\\." . "Mac OS X Puma")
|
|
|
|
|
("^10\\.2\\." . "Mac OS X Jaguar")
|
|
|
|
|
("^10\\.3\\." . "Mac OS X Panther")
|
|
|
|
|
("^10\\.4\\." . "Mac OS X Tiger")
|
|
|
|
|
("^10\\.5\\." . "Mac OS X Leopard")
|
|
|
|
|
("^10\\.6\\." . "Mac OS X Snow Leopard")
|
|
|
|
|
("^10\\.7\\." . "Mac OS X Lion")
|
|
|
|
|
("^10\\.8\\." . "OS X Mountain Lion")
|
|
|
|
|
("^10\\.9\\." . "OS X Mavericks")
|
|
|
|
|
("^10\\.10\\." . "OS X Yosemite")
|
|
|
|
|
("^10\\.11\\." . "OS X El Capitan")
|
|
|
|
|
("^10\\.12\\." . "macOS Sierra")
|
|
|
|
|
("^10\\.13\\." . "macOS High Sierra")
|
|
|
|
|
("^10\\.14\\." . "macOS Mojave")
|
|
|
|
|
("^10\\.15\\." . "macOS Catalina")
|
|
|
|
|
("^10\\.16\\." . "macOS Big Sur")
|
|
|
|
|
("^11\\." . "macOS Big Sur")
|
|
|
|
|
("^12\\." . "macOS Monterey"))
|
2021-11-07 09:51:50 +00:00
|
|
|
|
"Versions of OSX and macOS and their name."))
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
2021-12-20 23:12:41 +00:00
|
|
|
|
(defconst eshell-info-banner--posix-shells '("bash" "zsh" "sh")
|
|
|
|
|
"List of POSIX-compliant shells to run external commands through.")
|
|
|
|
|
|
2021-05-17 15:17:21 +00:00
|
|
|
|
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
|
; Custom variables ;
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
2021-05-08 11:41:41 +00:00
|
|
|
|
(defcustom eshell-info-banner-tramp-aware t
|
|
|
|
|
"Make `eshell-info-banner' TRAMP aware."
|
|
|
|
|
:group 'eshell-info-banner
|
2021-05-17 15:14:43 +00:00
|
|
|
|
:type 'boolean
|
2022-03-28 22:06:14 +00:00
|
|
|
|
:safe #'booleanp)
|
2021-05-08 11:41:41 +00:00
|
|
|
|
|
2021-04-29 19:56:53 +00:00
|
|
|
|
(defcustom eshell-info-banner-shorten-path-from 7
|
|
|
|
|
"From which length should a path be shortened?"
|
2021-04-29 10:08:52 +00:00
|
|
|
|
:group 'eshell-info-banner
|
2021-05-17 15:14:43 +00:00
|
|
|
|
:type 'integer
|
2022-03-28 22:06:14 +00:00
|
|
|
|
:safe #'integer-or-marker-p)
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
2021-04-29 19:56:53 +00:00
|
|
|
|
(defcustom eshell-info-banner-width 80
|
|
|
|
|
"Width of the info banner to be shown in Eshell."
|
2021-04-29 10:08:52 +00:00
|
|
|
|
:group 'eshell-info-banner
|
2021-05-17 15:14:43 +00:00
|
|
|
|
:type 'integer
|
2022-03-28 22:06:14 +00:00
|
|
|
|
:safe #'integer-or-marker-p)
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
2021-04-29 17:41:35 +00:00
|
|
|
|
(defcustom eshell-info-banner-progress-bar-char "="
|
2021-04-29 10:08:52 +00:00
|
|
|
|
"Character to fill the progress bars with."
|
|
|
|
|
:group 'eshell-info-banner
|
2021-05-17 15:14:43 +00:00
|
|
|
|
:type 'string
|
2022-03-28 22:06:14 +00:00
|
|
|
|
:safe #'stringp)
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
2021-04-29 19:56:53 +00:00
|
|
|
|
(defcustom eshell-info-banner-warning-percentage 75
|
|
|
|
|
"When to warn about a percentage."
|
2021-04-29 17:41:35 +00:00
|
|
|
|
:group 'eshell-info-banner
|
2021-05-17 15:14:43 +00:00
|
|
|
|
:type 'float
|
2022-03-28 22:06:14 +00:00
|
|
|
|
:safe #'floatp)
|
2021-04-29 17:41:35 +00:00
|
|
|
|
|
2021-04-29 19:56:53 +00:00
|
|
|
|
(defcustom eshell-info-banner-critical-percentage 90
|
|
|
|
|
"When a percentage becomes critical."
|
2021-04-29 17:41:35 +00:00
|
|
|
|
:group 'eshell-info-banner
|
2021-05-17 15:14:43 +00:00
|
|
|
|
:type 'float
|
2022-03-28 22:06:14 +00:00
|
|
|
|
:safe #'floatp)
|
2021-04-29 17:41:35 +00:00
|
|
|
|
|
2021-05-15 18:32:49 +00:00
|
|
|
|
(defcustom eshell-info-banner-partition-prefixes '("/dev")
|
|
|
|
|
"List of prefixes for detecting which partitions to display."
|
|
|
|
|
:group 'eshell-info-banner
|
2022-03-28 22:06:14 +00:00
|
|
|
|
:type 'list)
|
2021-05-15 18:32:49 +00:00
|
|
|
|
|
2022-05-31 09:31:22 +00:00
|
|
|
|
|
|
|
|
|
(defmacro eshell-info-banner--executable-find (program)
|
2021-12-20 22:08:31 +00:00
|
|
|
|
"Find PROGRAM executable, possibly on a remote machine.
|
2021-12-19 16:19:42 +00:00
|
|
|
|
This is a wrapper around `executable-find' in order to avoid
|
|
|
|
|
issues with older versions of the functions only accepting one
|
2021-12-20 22:08:31 +00:00
|
|
|
|
argument. `executable-find'’s remote argument has the value of
|
|
|
|
|
`eshell-info-banner-tramp-aware'."
|
2021-12-19 16:19:42 +00:00
|
|
|
|
(if (version< emacs-version "27.1")
|
2022-05-31 09:31:22 +00:00
|
|
|
|
`(let ((default-directory (if eshell-info-banner-tramp-aware
|
|
|
|
|
default-directory
|
|
|
|
|
"~")))
|
|
|
|
|
(executable-find ,program))
|
|
|
|
|
`(executable-find ,program eshell-info-banner-tramp-aware)))
|
2021-12-19 16:19:42 +00:00
|
|
|
|
|
2021-06-18 16:26:24 +00:00
|
|
|
|
(defcustom eshell-info-banner-duf-executable "duf"
|
|
|
|
|
"Path to the `duf' executable."
|
|
|
|
|
:group 'eshell-info-banner
|
|
|
|
|
:type 'string
|
2022-03-28 22:06:14 +00:00
|
|
|
|
:safe #'stringp)
|
2021-06-18 16:26:24 +00:00
|
|
|
|
|
2021-12-18 23:00:46 +00:00
|
|
|
|
(defcustom eshell-info-banner-use-duf
|
|
|
|
|
(if (eshell-info-banner--executable-find eshell-info-banner-duf-executable)
|
|
|
|
|
t
|
|
|
|
|
nil)
|
2021-06-18 16:26:24 +00:00
|
|
|
|
"If non-nil, use `duf' instead of `df'."
|
|
|
|
|
:group 'eshell-info-banner
|
|
|
|
|
:type 'boolean
|
2022-03-28 22:06:14 +00:00
|
|
|
|
:safe #'booleanp)
|
2021-06-18 16:26:24 +00:00
|
|
|
|
|
2021-12-19 16:19:42 +00:00
|
|
|
|
(defcustom eshell-info-banner-file-size-flavor nil
|
|
|
|
|
"Display sizes with IEC prefixes."
|
|
|
|
|
:group 'eshell-info-banner
|
|
|
|
|
:type '(radio (const :tag "Default" nil)
|
|
|
|
|
(const :tag "SI" si)
|
2022-03-28 22:06:14 +00:00
|
|
|
|
(const :tag "IEC" iec)))
|
2021-12-19 16:19:42 +00:00
|
|
|
|
|
2021-05-17 15:17:21 +00:00
|
|
|
|
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
|
; Faces ;
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
|
|
|
|
(defface eshell-info-banner-background-face
|
|
|
|
|
'((t :inherit font-lock-comment-face))
|
|
|
|
|
"Face for \"empty\" part of progress bars."
|
|
|
|
|
:group 'eshell-info-banner)
|
|
|
|
|
|
|
|
|
|
(defface eshell-info-banner-normal-face
|
|
|
|
|
'((t :inherit font-lock-string-face))
|
2021-11-08 12:30:32 +00:00
|
|
|
|
"Face for `eshell-info-banner' progress bars displaying acceptable levels."
|
2021-04-29 10:08:52 +00:00
|
|
|
|
:group 'eshell-info-banner)
|
|
|
|
|
|
|
|
|
|
(defface eshell-info-banner-warning-face
|
|
|
|
|
'((t :inherit warning))
|
2021-11-08 12:30:32 +00:00
|
|
|
|
"Face for `eshell-info-banner' progress bars displaying high levels."
|
2021-04-29 10:08:52 +00:00
|
|
|
|
:group 'eshell-info-banner)
|
|
|
|
|
|
|
|
|
|
(defface eshell-info-banner-critical-face
|
|
|
|
|
'((t :inherit error))
|
2021-11-08 12:30:32 +00:00
|
|
|
|
"Face for `eshell-info-banner' progress bars displaying critical levels."
|
2021-04-29 10:08:52 +00:00
|
|
|
|
:group 'eshell-info-banner)
|
|
|
|
|
|
2021-12-19 16:19:42 +00:00
|
|
|
|
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
|
; Macros and Utilities ;
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
|
|
|
|
|
|
(defmacro eshell-info-banner--with-face (str &rest properties)
|
2022-01-07 01:56:38 +00:00
|
|
|
|
"Helper macro for applying face PROPERTIES to STR."
|
2021-12-19 16:19:42 +00:00
|
|
|
|
`(propertize ,str 'face (list ,@properties)))
|
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--shell-command-to-string (command)
|
|
|
|
|
"Execute shell command COMMAND and return its output as a string.
|
|
|
|
|
Ensures the command is ran with LANG=C."
|
2021-12-20 23:12:41 +00:00
|
|
|
|
(let ((shell (or (seq-find (lambda (shell)
|
|
|
|
|
(eshell-info-banner--executable-find shell))
|
|
|
|
|
eshell-info-banner--posix-shells)
|
|
|
|
|
"sh")))
|
|
|
|
|
(with-temp-buffer
|
2022-05-15 07:00:35 +00:00
|
|
|
|
(let ((default-directory (if eshell-info-banner-tramp-aware default-directory "~")))
|
|
|
|
|
(process-file shell nil t nil "-c" (concat "LANG=C " command))
|
|
|
|
|
(buffer-string)))))
|
2021-12-19 16:19:42 +00:00
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--progress-bar-without-prefix (bar-length used total &optional newline)
|
|
|
|
|
"Display a progress bar without its prefix.
|
|
|
|
|
Display a progress bar of BAR-LENGTH length, followed by an
|
|
|
|
|
indication of how full the memory is with a human readable USED
|
2022-01-07 01:03:44 +00:00
|
|
|
|
and TOTAL size.
|
|
|
|
|
Optional argument NEWLINE: Whether to output a newline at the end
|
|
|
|
|
of the progress bar."
|
2021-12-19 16:19:42 +00:00
|
|
|
|
(let ((percentage (if (= used 0)
|
|
|
|
|
0
|
|
|
|
|
(/ (* 100 used) total))))
|
|
|
|
|
(concat (eshell-info-banner--progress-bar bar-length percentage)
|
|
|
|
|
(format (if (equal eshell-info-banner-file-size-flavor 'iec)
|
|
|
|
|
" %8s / %-8s (%3s%%)%s"
|
|
|
|
|
" %6s / %-6s (%3s%%)%s")
|
|
|
|
|
(file-size-human-readable used eshell-info-banner-file-size-flavor)
|
|
|
|
|
(file-size-human-readable total eshell-info-banner-file-size-flavor)
|
|
|
|
|
(eshell-info-banner--with-face
|
|
|
|
|
(number-to-string percentage)
|
|
|
|
|
:inherit (eshell-info-banner--get-color-percentage percentage))
|
|
|
|
|
(if newline "\n" "")))))
|
|
|
|
|
|
2022-04-02 16:58:41 +00:00
|
|
|
|
(defun eshell-info-banner--string-repeat (str times)
|
|
|
|
|
"Repeat STR for TIMES times."
|
|
|
|
|
(declare (pure t) (side-effect-free t))
|
|
|
|
|
(let (result)
|
|
|
|
|
(cl-dotimes (_ times)
|
|
|
|
|
(setq result (cons str result)))
|
|
|
|
|
(apply #'concat result)))
|
|
|
|
|
|
2021-05-17 15:17:21 +00:00
|
|
|
|
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
|
; Internal functions ;
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
|
|
2021-05-21 22:20:10 +00:00
|
|
|
|
; Misc ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--get-uptime ()
|
|
|
|
|
"Get uptime of machine if `uptime' is available.
|
|
|
|
|
|
|
|
|
|
If the executable `uptime' is not found, return nil."
|
2021-12-18 23:00:46 +00:00
|
|
|
|
(when (eshell-info-banner--executable-find "uptime")
|
2021-11-06 22:47:40 +00:00
|
|
|
|
(let ((uptime-str (eshell-info-banner--shell-command-to-string "uptime -p")))
|
2021-05-22 02:06:01 +00:00
|
|
|
|
(if (not (seq-some (lambda (keyword)
|
|
|
|
|
(string-match-p keyword uptime-str))
|
2021-12-19 12:30:07 +00:00
|
|
|
|
'("invalid" "illegal" "unknown")))
|
2022-05-31 09:31:22 +00:00
|
|
|
|
(s-chop-prefix "up " (s-trim uptime-str))
|
2021-11-06 22:47:40 +00:00
|
|
|
|
(let ((uptime-str (eshell-info-banner--shell-command-to-string "uptime")))
|
2021-05-21 22:20:10 +00:00
|
|
|
|
(save-match-data
|
2021-05-22 02:06:01 +00:00
|
|
|
|
(string-match "[^,]+up *\\([^,]+\\)," uptime-str)
|
2022-05-31 09:31:22 +00:00
|
|
|
|
(s-trim (substring-no-properties uptime-str
|
|
|
|
|
(match-beginning 1)
|
|
|
|
|
(match-end 1)))))))))
|
2021-05-21 22:20:10 +00:00
|
|
|
|
|
2021-05-17 15:17:21 +00:00
|
|
|
|
; Partitions ;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
|
|
|
|
|
|
(cl-defstruct eshell-info-banner--mounted-partitions
|
|
|
|
|
"Object representing a mounted partition found in the system."
|
|
|
|
|
path size used percent)
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
2021-05-17 15:34:24 +00:00
|
|
|
|
(defun eshell-info-banner--get-longest-path (partitions)
|
2022-01-07 01:56:38 +00:00
|
|
|
|
"Return the length of the longest partition path in PARTITIONS.
|
2021-05-17 15:34:24 +00:00
|
|
|
|
|
2021-11-08 12:30:32 +00:00
|
|
|
|
The returned value is in any case greater than
|
|
|
|
|
`eshell-info-banner--min-length-left'."
|
2021-11-10 18:48:59 +00:00
|
|
|
|
(let ((length eshell-info-banner--min-length-left))
|
|
|
|
|
(dolist (partition partitions length)
|
|
|
|
|
(setf length (max length
|
|
|
|
|
(length (eshell-info-banner--mounted-partitions-path partition)))))))
|
2021-05-17 15:34:24 +00:00
|
|
|
|
|
2021-04-29 10:08:52 +00:00
|
|
|
|
(defun eshell-info-banner--abbr-path (path &optional abbr)
|
2022-01-07 01:56:38 +00:00
|
|
|
|
"Remove `$HOME' from PATH, abbreviate parent dirs if ABBR non nil.
|
|
|
|
|
|
|
|
|
|
Abbreviate PATH by removing the value of HOME if it is present in
|
|
|
|
|
the former, and if ABBR is t then all parent directories of the
|
|
|
|
|
current PATH are abbreviated to only one character. If an
|
|
|
|
|
abbreviated directory starts with a dot, then include it before
|
|
|
|
|
the abbreviated name of the directory, e.g. \".config\" ->
|
|
|
|
|
\".c\".
|
|
|
|
|
|
|
|
|
|
For public use, PATH should be a string representing a UNIX path.
|
|
|
|
|
For internal use, PATH can also be a list. If PATH is neither of
|
|
|
|
|
these, an error will be thrown by the function."
|
2021-04-29 10:08:52 +00:00
|
|
|
|
(cond
|
2022-01-07 11:06:39 +00:00
|
|
|
|
((stringp path)
|
|
|
|
|
(let ((abbr-path (abbreviate-file-name path)))
|
|
|
|
|
(if abbr
|
|
|
|
|
(abbreviate-file-name
|
|
|
|
|
(eshell-info-banner--abbr-path
|
|
|
|
|
(split-string abbr-path eshell-info-banner-path-separator t)))
|
|
|
|
|
abbr-path)))
|
2021-04-29 10:08:52 +00:00
|
|
|
|
((null path) "")
|
|
|
|
|
((listp path)
|
2022-01-07 11:06:39 +00:00
|
|
|
|
(let ((file (eshell-info-banner--abbr-path (cdr path)))
|
|
|
|
|
(directory (if (= (length path) 1)
|
|
|
|
|
(car path)
|
|
|
|
|
(let* ((dir (car path))
|
|
|
|
|
(first-char (substring dir 0 1)))
|
|
|
|
|
(if (string= "." first-char)
|
|
|
|
|
(substring dir 0 2)
|
|
|
|
|
first-char)))))
|
|
|
|
|
(if (string= "" file)
|
|
|
|
|
directory
|
|
|
|
|
(let ((relative-p (not (file-name-absolute-p directory)))
|
|
|
|
|
(new-dir (expand-file-name file directory)))
|
|
|
|
|
(if relative-p
|
|
|
|
|
(file-relative-name new-dir)
|
|
|
|
|
new-dir)))))
|
2021-04-29 10:08:52 +00:00
|
|
|
|
(t (error "Invalid argument %s, neither stringp or listp" path))))
|
|
|
|
|
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(defun eshell-info-banner--get-mounted-partitions-duf ()
|
2021-06-18 16:26:24 +00:00
|
|
|
|
"Detect mounted partitions on systems supporting `duf'.
|
|
|
|
|
|
|
|
|
|
Return detected partitions as a list of structs. See
|
|
|
|
|
`eshell-info-banner-partition-prefixes' to see how partitions are
|
2021-06-18 17:26:16 +00:00
|
|
|
|
chosen. Relies on the `duf' command."
|
|
|
|
|
(let* ((partitions (json-read-from-string (with-temp-buffer
|
|
|
|
|
(call-process "duf" nil t nil "-json")
|
|
|
|
|
(buffer-string))))
|
2021-06-18 16:26:24 +00:00
|
|
|
|
(partitions (cl-remove-if-not (lambda (partition)
|
|
|
|
|
(let ((device (format "%s" (cdr (assoc 'device partition)))))
|
|
|
|
|
(seq-some (lambda (prefix)
|
|
|
|
|
(string-prefix-p prefix device t))
|
|
|
|
|
eshell-info-banner-partition-prefixes)))
|
|
|
|
|
(seq-into-sequence partitions))))
|
|
|
|
|
(mapcar (lambda (partition)
|
|
|
|
|
(let* ((mount-point (format "%s" (cdr (assoc 'mount_point partition))))
|
|
|
|
|
(total (cdr (assoc 'total partition)))
|
|
|
|
|
(used (cdr (assoc 'used partition)))
|
|
|
|
|
(percent (/ (* 100 used) total)))
|
|
|
|
|
(make-eshell-info-banner--mounted-partitions
|
|
|
|
|
:path (if (> (length mount-point) eshell-info-banner-shorten-path-from)
|
|
|
|
|
(eshell-info-banner--abbr-path mount-point t)
|
|
|
|
|
mount-point)
|
2021-12-19 16:19:42 +00:00
|
|
|
|
:size total
|
|
|
|
|
:used used
|
2021-06-18 16:26:24 +00:00
|
|
|
|
:percent percent)))
|
|
|
|
|
partitions)))
|
|
|
|
|
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(defun eshell-info-banner--get-mounted-partitions-df (mount-position)
|
2021-11-06 23:02:28 +00:00
|
|
|
|
"Get mounted partitions through df.
|
|
|
|
|
Common function between
|
2021-11-08 12:30:32 +00:00
|
|
|
|
`eshell-info-banner--get-mounted-partitions-gnu' and
|
2021-11-10 07:43:11 +00:00
|
|
|
|
`eshell-info-banner--get-mounted-partitions-darwin' which would
|
2021-11-06 23:02:28 +00:00
|
|
|
|
otherwise differ solely on the position of the mount point in the
|
|
|
|
|
partition list. Its position is given by the argument
|
|
|
|
|
MOUNT-POSITION."
|
2022-05-14 13:17:40 +00:00
|
|
|
|
(let ((partitions (cdr (split-string (eshell-info-banner--shell-command-to-string "df -l -k")
|
2021-11-19 17:38:24 +00:00
|
|
|
|
(regexp-quote "\n")
|
|
|
|
|
t))))
|
|
|
|
|
(cl-remove-if #'null
|
|
|
|
|
(mapcar (lambda (partition)
|
|
|
|
|
(let* ((partition (split-string partition " " t))
|
|
|
|
|
(filesystem (nth 0 partition))
|
2022-05-14 13:17:40 +00:00
|
|
|
|
(size (* (string-to-number (nth 1 partition)) 1024))
|
|
|
|
|
(used (* (string-to-number (nth 2 partition)) 1024))
|
2021-11-19 17:38:24 +00:00
|
|
|
|
(percent (nth 4 partition))
|
|
|
|
|
(mount (nth mount-position partition)))
|
|
|
|
|
(when (seq-some (lambda (prefix)
|
|
|
|
|
(string-prefix-p prefix filesystem t))
|
|
|
|
|
eshell-info-banner-partition-prefixes)
|
|
|
|
|
(make-eshell-info-banner--mounted-partitions
|
|
|
|
|
:path (if (> (length mount) eshell-info-banner-shorten-path-from)
|
|
|
|
|
(eshell-info-banner--abbr-path mount t)
|
|
|
|
|
mount)
|
|
|
|
|
:size size
|
|
|
|
|
:used used
|
|
|
|
|
:percent (string-to-number
|
2022-05-31 09:31:22 +00:00
|
|
|
|
(s-chop-suffix "%" percent))))))
|
2021-11-19 17:38:24 +00:00
|
|
|
|
partitions))))
|
2021-04-29 17:41:35 +00:00
|
|
|
|
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(defun eshell-info-banner--get-mounted-partitions-gnu ()
|
2021-11-06 23:02:28 +00:00
|
|
|
|
"Detect mounted partitions on a Linux system.
|
|
|
|
|
|
|
|
|
|
Return detected partitions as a list of structs. See
|
|
|
|
|
`eshell-info-banner-partition-prefixes' to see how partitions are
|
|
|
|
|
chosen. Relies on the `df' command."
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(eshell-info-banner--get-mounted-partitions-df 5))
|
2021-11-06 23:02:28 +00:00
|
|
|
|
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(defun eshell-info-banner--get-mounted-partitions-windows ()
|
2021-05-17 15:34:24 +00:00
|
|
|
|
"Detect mounted partitions on a Windows system.
|
2021-05-15 12:29:43 +00:00
|
|
|
|
|
2021-05-17 15:34:24 +00:00
|
|
|
|
Return detected partitions as a list of structs. See
|
|
|
|
|
`eshell-info-banner-partition-prefixes' to see how partitions are
|
|
|
|
|
chosen."
|
|
|
|
|
(progn
|
2021-11-06 21:51:11 +00:00
|
|
|
|
(warn "Partition detection for Windows and DOS not yet supported.")
|
2021-05-17 15:34:24 +00:00
|
|
|
|
nil))
|
|
|
|
|
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(defun eshell-info-banner--get-mounted-partitions-darwin ()
|
2021-05-17 15:34:24 +00:00
|
|
|
|
"Detect mounted partitions on a Darwin/macOS system.
|
|
|
|
|
|
|
|
|
|
Return detected partitions as a list of structs. See
|
|
|
|
|
`eshell-info-banner-partition-prefixes' to see how partitions are
|
2021-05-22 02:26:33 +00:00
|
|
|
|
chosen. Relies on the `df' command."
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(eshell-info-banner--get-mounted-partitions-df 8))
|
2021-05-17 15:34:24 +00:00
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--get-mounted-partitions ()
|
|
|
|
|
"Detect mounted partitions on the system.
|
|
|
|
|
|
|
|
|
|
Return detected partitions as a list of structs."
|
2021-06-18 16:26:24 +00:00
|
|
|
|
(if eshell-info-banner-use-duf
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(eshell-info-banner--get-mounted-partitions-duf)
|
2021-06-18 16:26:24 +00:00
|
|
|
|
(pcase system-type
|
2021-11-06 22:47:40 +00:00
|
|
|
|
((or 'gnu 'gnu/linux 'gnu/kfreebsd 'berkeley-unix)
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(eshell-info-banner--get-mounted-partitions-gnu))
|
2021-06-18 16:26:24 +00:00
|
|
|
|
((or 'ms-dos 'windows-nt 'cygwin)
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(eshell-info-banner--get-mounted-partitions-windows))
|
2021-06-18 16:26:24 +00:00
|
|
|
|
('darwin
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(eshell-info-banner--get-mounted-partitions-darwin))
|
2021-06-18 16:26:24 +00:00
|
|
|
|
(other
|
|
|
|
|
(progn
|
2021-11-06 21:51:11 +00:00
|
|
|
|
(warn "Partition detection for %s not yet supported." other)
|
2021-06-18 16:26:24 +00:00
|
|
|
|
nil)))))
|
2021-05-17 15:34:24 +00:00
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--partition-to-string (partition text-padding bar-length)
|
2022-01-07 01:56:38 +00:00
|
|
|
|
"Display a progress bar showing how full a PARTITION is.
|
2021-05-17 15:34:24 +00:00
|
|
|
|
|
|
|
|
|
For TEXT-PADDING and BAR-LENGTH, see the documentation of
|
|
|
|
|
`eshell-info-banner--display-memory'."
|
2021-12-19 16:19:42 +00:00
|
|
|
|
(concat (s-pad-right text-padding
|
|
|
|
|
"."
|
|
|
|
|
(eshell-info-banner--with-face
|
|
|
|
|
(eshell-info-banner--mounted-partitions-path partition)
|
|
|
|
|
:weight 'bold))
|
|
|
|
|
": "
|
|
|
|
|
(eshell-info-banner--progress-bar-without-prefix
|
|
|
|
|
bar-length
|
|
|
|
|
(eshell-info-banner--mounted-partitions-used partition)
|
|
|
|
|
(eshell-info-banner--mounted-partitions-size partition))))
|
2021-05-17 15:34:24 +00:00
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--display-partitions (text-padding bar-length)
|
|
|
|
|
"Display the detected mounted partitions of the system.
|
|
|
|
|
|
|
|
|
|
For TEXT-PADDING and BAR-LENGTH, see the documentation of
|
|
|
|
|
`eshell-info-banner--display-memory'."
|
|
|
|
|
(mapconcat (lambda (partition)
|
|
|
|
|
(eshell-info-banner--partition-to-string partition text-padding bar-length))
|
|
|
|
|
(eshell-info-banner--get-mounted-partitions)
|
|
|
|
|
"\n"))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
; Memory ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(defun eshell-info-banner--get-memory-gnu ()
|
2021-05-17 15:34:24 +00:00
|
|
|
|
"Get memory usage for GNU/Linux and Hurd."
|
2021-11-15 09:04:24 +00:00
|
|
|
|
(mapcar (lambda (line)
|
2021-11-10 18:48:59 +00:00
|
|
|
|
(let* ((line (split-string line " " t)))
|
|
|
|
|
(list (s-chop-suffix ":" (nth 0 line)) ; name
|
|
|
|
|
(string-to-number (nth 1 line)) ; total
|
|
|
|
|
(string-to-number (nth 2 line))))) ; used
|
|
|
|
|
(split-string (eshell-info-banner--shell-command-to-string "free -b | tail -2")
|
|
|
|
|
"\n"
|
|
|
|
|
t)))
|
2021-05-17 15:34:24 +00:00
|
|
|
|
|
2022-01-04 18:33:04 +00:00
|
|
|
|
(defun eshell-info-banner--get-memory-unix-command-to-mem (command)
|
2022-01-07 01:03:44 +00:00
|
|
|
|
"Get the output of COMMAND corresponding to memory information.
|
|
|
|
|
This function is to be only used on platforms which support sysctl."
|
2022-01-04 18:33:04 +00:00
|
|
|
|
(string-to-number
|
2022-05-31 09:31:22 +00:00
|
|
|
|
(s-trim
|
2022-01-04 18:33:04 +00:00
|
|
|
|
(car (last
|
|
|
|
|
(split-string (eshell-info-banner--shell-command-to-string command)
|
|
|
|
|
" "
|
|
|
|
|
t))))))
|
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--get-memory-netbsd ()
|
|
|
|
|
"Get memory usage for NetBSD systems.
|
|
|
|
|
See `eshell-info-banner--get-memory'."
|
2022-01-07 01:03:57 +00:00
|
|
|
|
(let* ((total (eshell-info-banner--get-memory-unix-command-to-mem "sysctl hw.physmem64"))
|
2022-01-04 18:33:04 +00:00
|
|
|
|
(used (- total
|
|
|
|
|
(* 1024 (string-to-number
|
2022-05-31 09:31:22 +00:00
|
|
|
|
(s-trim
|
2022-01-04 18:33:04 +00:00
|
|
|
|
(with-temp-buffer
|
|
|
|
|
(insert-file-contents-literally "/proc/meminfo")
|
|
|
|
|
(save-match-data
|
|
|
|
|
(string-match (rx bol
|
|
|
|
|
"MemFree:"
|
|
|
|
|
(* blank)
|
|
|
|
|
(group (+ digit))
|
|
|
|
|
(* blank)
|
|
|
|
|
"kB")
|
|
|
|
|
(buffer-string))
|
|
|
|
|
(substring-no-properties (buffer-string)
|
|
|
|
|
(match-beginning 1)
|
|
|
|
|
(match-end 1))))))))))
|
2021-12-19 17:35:59 +00:00
|
|
|
|
`(("RAM" ,total ,used))))
|
2021-11-03 17:26:14 +00:00
|
|
|
|
|
2022-01-04 18:33:04 +00:00
|
|
|
|
(defun eshell-info-banner--get-memory-darwin ()
|
|
|
|
|
"Get memory usage for Darwin systems.
|
|
|
|
|
See `eshell-info-banner--get-memory'."
|
|
|
|
|
(let* ((total (eshell-info-banner--get-memory-unix-command-to-mem "sysctl -n hw.memsize"))
|
|
|
|
|
(vmstat (with-temp-buffer
|
|
|
|
|
(call-process "vm_stat" nil t nil)
|
|
|
|
|
(buffer-string)))
|
|
|
|
|
(wired (save-match-data
|
|
|
|
|
(string-match (rx " wired" (* (not digit)) (+ blank) (group (+ digit)) ".")
|
|
|
|
|
vmstat)
|
|
|
|
|
(* 1024 4
|
|
|
|
|
(string-to-number (substring-no-properties vmstat
|
|
|
|
|
(match-beginning 1)
|
|
|
|
|
(match-end 1))))))
|
|
|
|
|
(active (save-match-data
|
|
|
|
|
(string-match (rx " active" (* (not digit)) (+ blank) (group (+ digit)) ".")
|
|
|
|
|
vmstat)
|
|
|
|
|
(* 1024 4
|
|
|
|
|
(string-to-number (substring-no-properties vmstat
|
|
|
|
|
(match-beginning 1)
|
|
|
|
|
(match-end 1))))))
|
|
|
|
|
(compressed (save-match-data
|
|
|
|
|
(if (string-match (rx " occupied" (* (not digit)) (+ blank) (group (+ digit)) ".")
|
|
|
|
|
vmstat)
|
|
|
|
|
(* 1024 4
|
|
|
|
|
(string-to-number (substring-no-properties vmstat
|
|
|
|
|
(match-beginning 1)
|
|
|
|
|
(match-end 1))))
|
|
|
|
|
0))))
|
|
|
|
|
`(("RAM" ,total ,(+ wired active compressed)))))
|
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--get-memory-unix ()
|
|
|
|
|
"Get memory usage for UNIX systems."
|
|
|
|
|
(cond ((and (equal system-type 'berkeley-unix)
|
|
|
|
|
(string-match-p "NetBSD" (eshell-info-banner--shell-command-to-string "uname")))
|
|
|
|
|
(eshell-info-banner--get-memory-netbsd))
|
|
|
|
|
((equal system-type 'darwin)
|
|
|
|
|
(eshell-info-banner--get-memory-darwin))
|
|
|
|
|
(t
|
|
|
|
|
(let* ((total (eshell-info-banner--get-memory-unix-command-to-mem "sysctl hw.physmem"))
|
|
|
|
|
(used (eshell-info-banner--get-memory-unix-command-to-mem "sysctl hw.usermem")))
|
|
|
|
|
`(("RAM" ,total ,used))))))
|
|
|
|
|
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(defun eshell-info-banner--get-memory-windows ()
|
2021-05-17 15:34:24 +00:00
|
|
|
|
"Get memory usage for Window."
|
2021-11-06 21:51:11 +00:00
|
|
|
|
(warn "Memory usage not yet implemented for Windows and DOS")
|
2021-05-17 15:34:24 +00:00
|
|
|
|
nil)
|
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--get-memory ()
|
|
|
|
|
"Get memory usage of current operating system.
|
|
|
|
|
|
|
|
|
|
Return a list of either one or two elements. The first element
|
|
|
|
|
represents the RAM, the second represents the swap. Both are
|
|
|
|
|
lists and contain three elements: the name of the memory, the
|
|
|
|
|
total amount of memory available, and the amount of used memory,
|
|
|
|
|
in bytes."
|
|
|
|
|
(pcase system-type
|
|
|
|
|
((or 'gnu 'gnu/linux)
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(eshell-info-banner--get-memory-gnu))
|
|
|
|
|
((or 'darwin 'berkeley-unix 'gnu/kfreebsd)
|
|
|
|
|
(eshell-info-banner--get-memory-unix))
|
2021-05-17 15:34:24 +00:00
|
|
|
|
((or 'ms-dos 'windows-nt 'cygwin)
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(eshell-info-banner--get-memory-windows))
|
2021-11-06 21:51:11 +00:00
|
|
|
|
(os (warn "Memory usage not yet implemented for %s" os)
|
2021-05-17 15:34:24 +00:00
|
|
|
|
nil)))
|
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--memory-to-string (type total used text-padding bar-length)
|
|
|
|
|
"Display a memory’s usage with a progress bar.
|
|
|
|
|
|
2022-01-07 01:56:38 +00:00
|
|
|
|
The TYPE of memory will be the text on the far left, while USED
|
|
|
|
|
and TOTAL will be displayed on the right of the progress bar.
|
|
|
|
|
From them, a percentage will be computed which will be used to
|
|
|
|
|
display a colored percentage of the progress bar and it will be
|
|
|
|
|
displayed on the far right.
|
2021-05-17 15:34:24 +00:00
|
|
|
|
|
2022-01-07 01:56:38 +00:00
|
|
|
|
TEXT-PADDING will determine how many dots are necessary between
|
|
|
|
|
TYPE and the colon.
|
2021-05-17 15:34:24 +00:00
|
|
|
|
|
2022-01-07 01:56:38 +00:00
|
|
|
|
BAR-LENGTH determines the length of the progress bar to be
|
2021-05-17 15:34:24 +00:00
|
|
|
|
displayed."
|
2021-12-19 16:19:42 +00:00
|
|
|
|
(concat (s-pad-right text-padding "." type)
|
|
|
|
|
": "
|
|
|
|
|
(eshell-info-banner--progress-bar-without-prefix bar-length used total t)))
|
2021-05-17 15:34:24 +00:00
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--display-memory (text-padding bar-length)
|
|
|
|
|
"Display memories detected on your system.
|
|
|
|
|
|
|
|
|
|
This function will create a string used by `eshell-info-banner'
|
|
|
|
|
in order to display memories detected by the package, generally
|
|
|
|
|
the Ram at least, sometimes the swap too. Displayed progress
|
|
|
|
|
bars will have this appearance:
|
|
|
|
|
|
|
|
|
|
TYPE......: [=========] XXG / XXG (XX%)
|
|
|
|
|
|
2022-01-07 01:56:38 +00:00
|
|
|
|
TEXT-PADDING: the space allocated to the text at the left of the
|
2021-05-17 15:34:24 +00:00
|
|
|
|
progress bar.
|
|
|
|
|
|
2022-01-07 01:56:38 +00:00
|
|
|
|
BAR-LENGTH: the length of the progress bar."
|
2021-06-18 17:29:06 +00:00
|
|
|
|
(mapconcat (lambda (mem)
|
|
|
|
|
(eshell-info-banner--memory-to-string (nth 0 mem) (nth 1 mem)
|
|
|
|
|
(nth 2 mem) text-padding
|
|
|
|
|
bar-length))
|
|
|
|
|
(eshell-info-banner--get-memory)
|
|
|
|
|
""))
|
2021-05-17 15:34:24 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
; Display information ;;;;;;;;;;;;;;;;;
|
2021-04-29 10:08:52 +00:00
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--get-color-percentage (percentage)
|
2022-01-07 01:56:38 +00:00
|
|
|
|
"Display a PERCENTAGE with its according face."
|
2021-04-29 10:08:52 +00:00
|
|
|
|
(let ((percentage (if (stringp percentage)
|
|
|
|
|
(string-to-number percentage)
|
|
|
|
|
percentage)))
|
|
|
|
|
(cond
|
2021-04-29 19:56:53 +00:00
|
|
|
|
((>= percentage eshell-info-banner-critical-percentage)
|
2021-04-29 10:08:52 +00:00
|
|
|
|
'eshell-info-banner-critical-face)
|
2021-04-29 19:56:53 +00:00
|
|
|
|
((>= percentage eshell-info-banner-warning-percentage)
|
2021-04-29 10:08:52 +00:00
|
|
|
|
'eshell-info-banner-warning-face)
|
|
|
|
|
(t 'eshell-info-banner-normal-face))))
|
|
|
|
|
|
2021-04-29 21:59:56 +00:00
|
|
|
|
(defun eshell-info-banner--progress-bar (length percentage &optional invert)
|
2022-01-07 01:56:38 +00:00
|
|
|
|
"Display a progress bar LENGTH long and PERCENTAGE full.
|
2021-04-29 10:08:52 +00:00
|
|
|
|
The full path will be displayed filled with the character
|
2021-04-29 17:41:35 +00:00
|
|
|
|
specified by `eshell-info-banner-progress-bar-char' up to
|
2022-01-07 01:56:38 +00:00
|
|
|
|
PERCENTAGE percents. The rest will be empty.
|
2021-04-29 21:59:56 +00:00
|
|
|
|
|
2022-01-07 01:56:38 +00:00
|
|
|
|
If INVERT is t, then consider the percentage to approach
|
2021-04-29 21:59:56 +00:00
|
|
|
|
critical levels close to 0 rather than 100."
|
|
|
|
|
(let* ((length-filled (if (= 0 percentage)
|
|
|
|
|
0
|
|
|
|
|
(/ (* length percentage) 100)))
|
|
|
|
|
(length-empty (- length length-filled))
|
|
|
|
|
(percentage-level (if invert
|
|
|
|
|
(- 100 percentage)
|
|
|
|
|
percentage)))
|
2021-04-29 10:08:52 +00:00
|
|
|
|
(concat
|
|
|
|
|
(eshell-info-banner--with-face "[" :weight 'bold)
|
2022-04-02 16:58:41 +00:00
|
|
|
|
(eshell-info-banner--with-face (eshell-info-banner--string-repeat eshell-info-banner-progress-bar-char
|
|
|
|
|
length-filled)
|
2021-04-29 10:08:52 +00:00
|
|
|
|
:weight 'bold
|
2021-04-29 21:59:56 +00:00
|
|
|
|
:inherit (eshell-info-banner--get-color-percentage percentage-level))
|
2022-04-02 16:58:41 +00:00
|
|
|
|
(eshell-info-banner--with-face (eshell-info-banner--string-repeat eshell-info-banner-progress-bar-char
|
|
|
|
|
length-empty)
|
2021-04-29 21:59:56 +00:00
|
|
|
|
:weight 'bold
|
|
|
|
|
:inherit 'eshell-info-banner-background-face)
|
2021-04-29 10:08:52 +00:00
|
|
|
|
(eshell-info-banner--with-face "]" :weight 'bold))))
|
|
|
|
|
|
2021-04-29 21:59:56 +00:00
|
|
|
|
(defun eshell-info-banner--display-battery (text-padding bar-length)
|
|
|
|
|
"If the computer has a battery, display its level.
|
|
|
|
|
|
2022-01-07 01:56:38 +00:00
|
|
|
|
Pad the left text with dots by TEXT-PADDING characters.
|
2021-04-29 21:59:56 +00:00
|
|
|
|
|
2022-01-07 01:56:38 +00:00
|
|
|
|
BAR-LENGTH indicates the length in characters of the progress
|
2021-04-29 21:59:56 +00:00
|
|
|
|
bar.
|
|
|
|
|
|
|
|
|
|
The usage of `eshell-info-banner-warning-percentage' and
|
|
|
|
|
`eshell-info-banner-critical-percentage' is reversed, and can be
|
|
|
|
|
thought of as the “percentage of discharge” of the computer.
|
|
|
|
|
Thus, setting the warning at 75% will be translated as showing
|
|
|
|
|
the warning face with a battery level of 25% or less."
|
2022-01-04 20:06:13 +00:00
|
|
|
|
(let ((battery-level (unless (and (equal system-type 'gnu/linux)
|
|
|
|
|
(not (file-readable-p "/sys/")))
|
|
|
|
|
(battery))))
|
2021-12-18 16:26:48 +00:00
|
|
|
|
(if (or (null battery-level)
|
|
|
|
|
(string= battery-level "Battery status not available")
|
2021-05-21 23:25:42 +00:00
|
|
|
|
(string-match-p (regexp-quote "N/A") battery-level))
|
2021-04-29 21:59:56 +00:00
|
|
|
|
""
|
|
|
|
|
(let ((percentage (save-match-data
|
2021-05-21 19:12:27 +00:00
|
|
|
|
(string-match "\\([0-9]+\\)\\(\\.[0-9]\\)?%" battery-level)
|
2021-05-21 22:19:54 +00:00
|
|
|
|
(string-to-number (substring battery-level
|
|
|
|
|
(match-beginning 1)
|
|
|
|
|
(match-end 1))))))
|
2021-04-29 21:59:56 +00:00
|
|
|
|
(concat (s-pad-right text-padding "." "Battery")
|
|
|
|
|
": "
|
|
|
|
|
(eshell-info-banner--progress-bar bar-length
|
|
|
|
|
percentage
|
|
|
|
|
t)
|
2022-04-02 16:58:41 +00:00
|
|
|
|
(eshell-info-banner--string-repeat
|
|
|
|
|
" "
|
|
|
|
|
(if (equal eshell-info-banner-file-size-flavor 'iec) 21 17))
|
2021-05-21 22:19:54 +00:00
|
|
|
|
(format "(%3s%%)\n"
|
|
|
|
|
(eshell-info-banner--with-face
|
|
|
|
|
(number-to-string percentage)
|
|
|
|
|
:inherit (eshell-info-banner--get-color-percentage (- 100.0 percentage)))))))))
|
2021-04-29 21:59:56 +00:00
|
|
|
|
|
2021-05-17 15:17:21 +00:00
|
|
|
|
|
2021-05-01 10:39:36 +00:00
|
|
|
|
; Operating system identification ;;;;;;;;;;;;;;;;;;
|
|
|
|
|
(defun eshell-info-banner--get-os-information-from-release-file (&optional release-file)
|
|
|
|
|
"Read the operating system from the given RELEASE-FILE.
|
|
|
|
|
|
|
|
|
|
If RELEASE-FILE is nil, use '/etc/os-release'."
|
2021-05-08 11:41:41 +00:00
|
|
|
|
(let ((prefix (if eshell-info-banner-tramp-aware (file-remote-p default-directory) "")))
|
|
|
|
|
(with-temp-buffer
|
|
|
|
|
(insert-file-contents (concat prefix (or release-file "/etc/os-release")))
|
|
|
|
|
(goto-char (point-min))
|
|
|
|
|
(re-search-forward "PRETTY_NAME=\"\\(.*\\)\"")
|
|
|
|
|
(match-string 1))))
|
2021-05-01 10:39:36 +00:00
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--get-os-information-from-hostnamectl ()
|
|
|
|
|
"Read the operating system via hostnamectl."
|
2021-05-08 11:41:41 +00:00
|
|
|
|
(let ((default-directory (if eshell-info-banner-tramp-aware default-directory "~")))
|
|
|
|
|
(with-temp-buffer
|
|
|
|
|
(process-file "hostnamectl" nil t nil)
|
|
|
|
|
(re-search-backward "Operating System: \\(.*\\)")
|
|
|
|
|
(match-string 1))))
|
2021-05-01 10:39:36 +00:00
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--get-os-information-from-lsb-release ()
|
2021-05-15 18:34:01 +00:00
|
|
|
|
"Read the operating system information from lsb_release."
|
2021-11-06 22:47:40 +00:00
|
|
|
|
(eshell-info-banner--shell-command-to-string "lsb_release -d -s"))
|
2021-05-01 10:39:36 +00:00
|
|
|
|
|
2021-05-02 19:32:23 +00:00
|
|
|
|
(defun eshell-info-banner--get-os-information-from-registry ()
|
|
|
|
|
"Read the operating system information from the Windows registry."
|
|
|
|
|
(let ((win32-name "Windows")
|
|
|
|
|
(win32-build "Unknown"))
|
|
|
|
|
(with-temp-buffer
|
|
|
|
|
(call-process "reg" nil t nil "query" "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion")
|
|
|
|
|
(goto-char (point-min))
|
|
|
|
|
(while (re-search-forward "\\([^[:blank:]]+\\) *\\(REG_[^[:blank:]]+\\) *\\(.+\\)" nil t)
|
|
|
|
|
(cond
|
|
|
|
|
((string= "ProductName" (match-string 1)) (setq win32-name (match-string 3)))
|
|
|
|
|
((string= "BuildLab" (match-string 1)) (setq win32-build (match-string 3)))))
|
|
|
|
|
(format "%s (%s)" win32-name win32-build))))
|
|
|
|
|
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(defun eshell-info-banner--get-os-information-windows ()
|
2021-05-22 01:59:08 +00:00
|
|
|
|
"See `eshell-info-banner--get-os-information'."
|
|
|
|
|
(let ((os (eshell-info-banner--get-os-information-from-registry)))
|
|
|
|
|
(save-match-data
|
|
|
|
|
(string-match "\\([^()]+\\) *(\\([^()]+\\))" os)
|
2022-05-31 09:31:22 +00:00
|
|
|
|
`(,(s-trim (substring-no-properties os
|
|
|
|
|
(match-beginning 1)
|
|
|
|
|
(match-end 1)))
|
2021-05-22 01:59:08 +00:00
|
|
|
|
.
|
|
|
|
|
,(substring-no-properties os
|
|
|
|
|
(match-beginning 2)
|
|
|
|
|
(match-end 2))))))
|
|
|
|
|
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(defun eshell-info-banner--get-os-information-gnu ()
|
2021-05-22 01:59:08 +00:00
|
|
|
|
"See `eshell-info-banner--get-os-information'."
|
2021-05-08 11:41:41 +00:00
|
|
|
|
(let ((prefix (if eshell-info-banner-tramp-aware (file-remote-p default-directory) "")))
|
2021-05-22 01:59:08 +00:00
|
|
|
|
`(,(cond
|
2021-12-18 15:24:32 +00:00
|
|
|
|
;; Bedrock Linux
|
|
|
|
|
((file-exists-p (concat prefix "/bedrock/etc/bedrock-release"))
|
2022-05-31 09:31:22 +00:00
|
|
|
|
(s-trim (with-temp-buffer
|
|
|
|
|
(insert-file-contents (concat prefix "/bedrock/etc/bedrock-release"))
|
|
|
|
|
(buffer-string))))
|
2021-12-18 15:24:32 +00:00
|
|
|
|
;; Proxmox
|
2021-12-20 22:08:31 +00:00
|
|
|
|
((eshell-info-banner--executable-find "pveversion")
|
2021-12-18 15:24:32 +00:00
|
|
|
|
(let ((distro (eshell-info-banner--shell-command-to-string "pveversion")))
|
|
|
|
|
(save-match-data
|
|
|
|
|
(string-match "/\\([^/]+\\)/" distro)
|
|
|
|
|
(concat "Proxmox "
|
|
|
|
|
(substring-no-properties distro
|
|
|
|
|
(match-beginning 1)
|
|
|
|
|
(match-end 1))))))
|
2021-12-20 22:08:31 +00:00
|
|
|
|
((eshell-info-banner--executable-find "hostnamectl")
|
2021-06-18 16:26:24 +00:00
|
|
|
|
(eshell-info-banner--get-os-information-from-hostnamectl))
|
2021-12-20 22:08:31 +00:00
|
|
|
|
((eshell-info-banner--executable-find "lsb_release")
|
2021-06-18 16:26:24 +00:00
|
|
|
|
(eshell-info-banner--get-os-information-from-lsb-release))
|
|
|
|
|
((file-exists-p (concat prefix "/etc/os-release"))
|
|
|
|
|
(eshell-info-banner--get-os-information-from-release-file))
|
2021-12-18 23:00:46 +00:00
|
|
|
|
((eshell-info-banner--executable-find "shepherd")
|
2021-11-06 22:47:40 +00:00
|
|
|
|
(let ((distro (car (s-lines (eshell-info-banner--shell-command-to-string "guix -V")))))
|
2021-06-18 16:26:24 +00:00
|
|
|
|
(save-match-data
|
|
|
|
|
(string-match "\\([0-9\\.]+\\)" distro)
|
|
|
|
|
(concat "Guix System "
|
|
|
|
|
(substring-no-properties distro
|
|
|
|
|
(match-beginning 1)
|
|
|
|
|
(match-end 1))))))
|
2021-11-03 17:26:14 +00:00
|
|
|
|
((equal system-type 'gnu/kfreebsd)
|
|
|
|
|
(let* ((default-directory (if eshell-info-banner-tramp-aware default-directory "~")))
|
2022-05-31 09:31:22 +00:00
|
|
|
|
(s-trim (with-temp-buffer
|
|
|
|
|
(process-file "uname" nil t nil "-s")
|
|
|
|
|
(buffer-string)))))
|
2021-12-18 17:40:26 +00:00
|
|
|
|
((and (file-exists-p (concat prefix "/system/app"))
|
|
|
|
|
(file-exists-p (concat prefix "/system/priv-app")))
|
|
|
|
|
(concat "Android "
|
2022-05-31 09:31:22 +00:00
|
|
|
|
(s-trim (eshell-info-banner--shell-command-to-string "getprop ro.build.version.release"))))
|
2021-06-18 16:26:24 +00:00
|
|
|
|
(t "Unknown"))
|
|
|
|
|
.
|
2022-05-31 09:31:22 +00:00
|
|
|
|
,(s-trim (eshell-info-banner--shell-command-to-string "uname -rs")))))
|
2021-05-22 01:59:08 +00:00
|
|
|
|
|
|
|
|
|
(defmacro eshell-info-banner--get-macos-name (version)
|
|
|
|
|
"Get the name of the current macOS or OSX system based on its VERSION."
|
|
|
|
|
`(cond
|
|
|
|
|
,@(mapcar (lambda (major)
|
2022-03-26 09:32:17 +00:00
|
|
|
|
`((string-match-p ,(car major)
|
|
|
|
|
,version)
|
|
|
|
|
,(cdr major)))
|
2021-07-09 12:13:15 +00:00
|
|
|
|
eshell-info-banner--macos-versions)
|
2021-11-10 07:43:11 +00:00
|
|
|
|
(t "unknown version")))
|
2021-05-22 01:59:08 +00:00
|
|
|
|
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(defun eshell-info-banner--get-os-information-darwin ()
|
2021-05-22 01:59:08 +00:00
|
|
|
|
"See `eshell-info-banner--get-os-information'."
|
2022-04-02 16:09:24 +00:00
|
|
|
|
`(,(eshell-info-banner--get-macos-name
|
2022-05-31 09:31:22 +00:00
|
|
|
|
(s-trim
|
2022-04-02 16:09:24 +00:00
|
|
|
|
(eshell-info-banner--shell-command-to-string "sw_vers -productVersion")))
|
2021-05-22 01:59:08 +00:00
|
|
|
|
.
|
2022-05-31 09:31:22 +00:00
|
|
|
|
,(s-trim (eshell-info-banner--shell-command-to-string "uname -rs"))))
|
2021-05-22 01:59:08 +00:00
|
|
|
|
|
|
|
|
|
(defun eshell-info-banner--get-os-information ()
|
|
|
|
|
"Get operating system identifying information.
|
|
|
|
|
Return a pair containing first the name of the operating system
|
|
|
|
|
and second its kernel name and version (or in Windows’ case its
|
|
|
|
|
build number)."
|
|
|
|
|
(pcase system-type
|
|
|
|
|
((or 'ms-dos 'windows-nt 'cygwin)
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(eshell-info-banner--get-os-information-windows))
|
2021-11-03 17:26:14 +00:00
|
|
|
|
((or 'gnu 'gnu/linux 'gnu/kfreebsd 'berkeley-unix)
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(eshell-info-banner--get-os-information-gnu))
|
2021-05-22 01:59:08 +00:00
|
|
|
|
('darwin
|
2021-11-08 12:30:32 +00:00
|
|
|
|
(eshell-info-banner--get-os-information-darwin))
|
|
|
|
|
(os (warn "Operating system information retrieving not yet supported for %s" os)
|
2021-11-06 21:51:11 +00:00
|
|
|
|
'((format "%s") . "Unknown"))))
|
2021-05-01 10:39:36 +00:00
|
|
|
|
|
2021-05-17 15:17:21 +00:00
|
|
|
|
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
|
; Public functions ;
|
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
2021-04-29 19:56:53 +00:00
|
|
|
|
|
2021-04-29 18:07:16 +00:00
|
|
|
|
;;;###autoload
|
2021-04-29 17:41:35 +00:00
|
|
|
|
(defun eshell-info-banner ()
|
|
|
|
|
"Banner for Eshell displaying system information."
|
2021-05-08 11:41:41 +00:00
|
|
|
|
(let* ((default-directory (if eshell-info-banner-tramp-aware default-directory "~"))
|
2021-12-19 16:19:42 +00:00
|
|
|
|
(system-info (eshell-info-banner--get-os-information))
|
|
|
|
|
(os (car system-info))
|
|
|
|
|
(kernel (cdr system-info))
|
|
|
|
|
(hostname (if eshell-info-banner-tramp-aware
|
|
|
|
|
(or (file-remote-p default-directory 'host) (system-name))
|
|
|
|
|
(system-name)))
|
|
|
|
|
(uptime (eshell-info-banner--get-uptime))
|
|
|
|
|
(partitions (eshell-info-banner--get-mounted-partitions))
|
|
|
|
|
(left-padding (eshell-info-banner--get-longest-path partitions))
|
|
|
|
|
(left-text (max (length os)
|
|
|
|
|
(length hostname)))
|
|
|
|
|
(left-length (+ left-padding 2 left-text)) ; + ": "
|
|
|
|
|
(right-text (+ (length "Kernel: ")
|
|
|
|
|
(max (length uptime)
|
|
|
|
|
(length kernel))))
|
|
|
|
|
(tot-width (max (+ left-length right-text 3)
|
|
|
|
|
eshell-info-banner-width))
|
|
|
|
|
(middle-padding (- tot-width right-text left-padding 4))
|
|
|
|
|
|
|
|
|
|
(bar-length (- tot-width left-padding 4 23))
|
|
|
|
|
(bar-length (if (equal eshell-info-banner-file-size-flavor 'iec)
|
|
|
|
|
(- bar-length 4)
|
|
|
|
|
bar-length)))
|
2022-04-02 16:58:41 +00:00
|
|
|
|
(concat (format "%s\n" (eshell-info-banner--string-repeat eshell-info-banner-progress-bar-char
|
|
|
|
|
tot-width))
|
2021-04-29 17:41:35 +00:00
|
|
|
|
(format "%s: %s Kernel.: %s\n"
|
|
|
|
|
(s-pad-right left-padding
|
|
|
|
|
"."
|
|
|
|
|
"OS")
|
|
|
|
|
(s-pad-right middle-padding " " (eshell-info-banner--with-face os :weight 'bold))
|
|
|
|
|
kernel)
|
|
|
|
|
(format "%s: %s Uptime.: %s\n"
|
|
|
|
|
(s-pad-right left-padding "." "Hostname")
|
|
|
|
|
(s-pad-right middle-padding " " (eshell-info-banner--with-face hostname :weight 'bold))
|
2021-04-29 21:59:56 +00:00
|
|
|
|
uptime)
|
|
|
|
|
(eshell-info-banner--display-battery left-padding bar-length)
|
2021-05-17 15:34:24 +00:00
|
|
|
|
(eshell-info-banner--display-memory left-padding bar-length)
|
|
|
|
|
(eshell-info-banner--display-partitions left-padding bar-length)
|
2022-04-02 16:58:41 +00:00
|
|
|
|
(format "\n%s\n" (eshell-info-banner--string-repeat eshell-info-banner-progress-bar-char
|
|
|
|
|
tot-width)))))
|
2021-04-29 17:41:35 +00:00
|
|
|
|
|
2021-04-29 19:56:53 +00:00
|
|
|
|
;;;###autoload
|
2021-04-29 18:07:16 +00:00
|
|
|
|
(defun eshell-info-banner-update-banner ()
|
|
|
|
|
"Update the Eshell banner."
|
|
|
|
|
(setq eshell-banner-message (eshell-info-banner)))
|
2021-04-29 10:28:07 +00:00
|
|
|
|
|
2021-04-29 10:08:52 +00:00
|
|
|
|
(provide 'eshell-info-banner)
|
|
|
|
|
|
|
|
|
|
;;; eshell-info-banner.el ends here
|