a434645e76
many thanks to @Lompik
* don't match empty unit names. AIUI unit names are alphanumeric with
the exception of the group [-_.@], non ascii are backslash-escaped.
* more strictly match temp file names: .# prefix, [[:hexdigit:]]{16}
suffix. the filenames are a unit name with a unit suffix (systemctl
edit --full) or just override.conf (edit without --full option)
* add regex for dropin config files. This is just a file with ".conf"
extension, with the added constraint that it's a file having some
parent directory named "systemd"
393 lines
17 KiB
EmacsLisp
393 lines
17 KiB
EmacsLisp
;;; systemd.el --- Major mode for editing systemd units -*- lexical-binding: t -*-
|
|
|
|
;; Copyright (C) 2014-2016 Mark Oteiza <mvoteiza@udel.edu>
|
|
|
|
;; Author: Mark Oteiza <mvoteiza@udel.edu>
|
|
;; Version: 1.3.1
|
|
;; Package-Requires: ((emacs "24.4"))
|
|
;; Keywords: tools, unix
|
|
|
|
;; This file 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 file 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 file. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; Major mode for editing systemd units.
|
|
|
|
;; Similar to `conf-mode' but with added highlighting; e.g. for
|
|
;; specifiers and booleans. Employs strict regex for whitespace.
|
|
;; Features a facility for browsing documentation: use C-c C-o to open
|
|
;; links to documentation in a unit (cf. systemctl help).
|
|
|
|
;; Supports completion of directives and sections in either units or
|
|
;; network configuration. Both a completer for
|
|
;; `completion-at-point-functions' and a company backend are provided.
|
|
;; The latter can be enabled by adding `company-mode' to
|
|
;; `systemd-mode-hook'.
|
|
|
|
;;; Code:
|
|
|
|
(require 'conf-mode)
|
|
(require 'thingatpt)
|
|
(require 'url-parse)
|
|
|
|
(declare-function company-begin-backend "company")
|
|
(declare-function company-grab-symbol "company")
|
|
|
|
(defgroup systemd ()
|
|
"Major mode for editing systemd units."
|
|
:link '(url-link "http://www.freedesktop.org/wiki/Software/systemd/")
|
|
:group 'tools)
|
|
|
|
(defcustom systemd-browse-url-function 'browse-url
|
|
"Browser to use for HTTP(S) documentation."
|
|
:type `(radio (function-item browse-url)
|
|
,@(when (fboundp 'eww) '((function-item eww)))
|
|
,@(when (fboundp 'w3m-browse-url) '((function-item w3m-browse-url)))
|
|
(function :tag "Other function"))
|
|
:group 'systemd)
|
|
|
|
(defcustom systemd-comment-start "#"
|
|
"String to insert to start a new comment."
|
|
:type '(choice (string :tag "Comment sign" "#")
|
|
(string :tag "Semicolon" ";"))
|
|
:group 'systemd)
|
|
|
|
(defcustom systemd-man-function 'man
|
|
"Pager to use for system manual pages."
|
|
:type '(radio (function-item man)
|
|
(function-item woman)
|
|
(function :tag "Other function"))
|
|
:group 'systemd)
|
|
|
|
(defcustom systemd-use-company-p nil
|
|
"Whether to use `company-mode' for completion, if available."
|
|
:type 'boolean
|
|
:group 'systemd)
|
|
|
|
(defconst systemd-unit-sections
|
|
'("Unit" "Install" "Service")
|
|
"Configuration sections for systemd 225.")
|
|
|
|
(defconst systemd-unit-directives
|
|
;; TODO: keep a script of sorts for generating this list. systemd
|
|
;; source has a python script in tools/ for parsing the
|
|
;; documentation xml for the unit directives.
|
|
;;
|
|
;; forcer on freenode threw together a curl monstrosity for achieving
|
|
;; the same:
|
|
;; curl -s http://www.freedesktop.org/software/systemd/man/systemd.directives.html | tr -d '\n' | sed 's/>/>\n/g' | sed -ne '/Unit directives/,/Options on the kernel/p' | sed -ne 's/.*<dt id="\([^-][^"]*\)=">.*/\1/p'
|
|
;; Quote, wrap with fill-column at 72, insert into list and indent
|
|
'("Accept" "AccuracySec" "After" "Alias" "AllowIsolate" "Also"
|
|
"AppArmorProfile" "AssertACPower" "AssertArchitecture"
|
|
"AssertCapability" "AssertDirectoryNotEmpty" "AssertFileIsExecutable"
|
|
"AssertFileNotEmpty" "AssertFirstBoot" "AssertHost"
|
|
"AssertKernelCommandLine" "AssertNeedsUpdate" "AssertPathExists"
|
|
"AssertPathExistsGlob" "AssertPathIsDirectory" "AssertPathIsMountPoint"
|
|
"AssertPathIsReadWrite" "AssertPathIsSymbolicLink" "AssertSecurity"
|
|
"AssertVirtualization" "Backlog" "Before" "BindIPv6Only" "BindToDevice"
|
|
"BindsTo" "BlockIOAccounting" "BlockIODeviceWeight"
|
|
"BlockIOReadBandwidth" "BlockIOWeight" "BlockIOWriteBandwidth"
|
|
"Broadcast" "BusName" "BusPolicy" "CPUAccounting" "CPUAffinity"
|
|
"CPUQuota" "CPUSchedulingPolicy" "CPUSchedulingPriority"
|
|
"CPUSchedulingResetOnFork" "CPUShares" "Capabilities"
|
|
"CapabilityBoundingSet" "ConditionACPower" "ConditionArchitecture"
|
|
"ConditionCapability" "ConditionDirectoryNotEmpty"
|
|
"ConditionFileIsExecutable" "ConditionFileNotEmpty" "ConditionFirstBoot"
|
|
"ConditionHost" "ConditionKernelCommandLine" "ConditionNeedsUpdate"
|
|
"ConditionPathExists" "ConditionPathExistsGlob"
|
|
"ConditionPathIsDirectory" "ConditionPathIsMountPoint"
|
|
"ConditionPathIsReadWrite" "ConditionPathIsSymbolicLink"
|
|
"ConditionSecurity" "ConditionVirtualization" "Conflicts"
|
|
"DefaultDependencies" "DefaultInstance" "DeferAcceptSec" "Delegate"
|
|
"Description" "DeviceAllow" "DevicePolicy" "DirectoryMode"
|
|
"DirectoryNotEmpty" "Documentation" "Environment" "EnvironmentFile"
|
|
"ExecReload" "ExecStart" "ExecStartPost" "ExecStartPre" "ExecStop"
|
|
"ExecStopPost" "ExecStopPre" "FailureAction" "FileDescriptorName"
|
|
"FileDescriptorStoreMax" "FreeBind" "Group" "GuessMainPID"
|
|
"IOSchedulingClass" "IOSchedulingPriority" "IPTOS" "IPTTL"
|
|
"IgnoreOnIsolate" "IgnoreSIGPIPE" "InaccessibleDirectories"
|
|
"JobTimeoutAction" "JobTimeoutRebootArgument" "JobTimeoutSec"
|
|
"JoinsNamespaceOf" "KeepAlive" "KeepAliveIntervalSec" "KeepAliveProbes"
|
|
"KeepAliveTimeSec" "KillMode" "KillSignal" "LimitAS" "LimitCORE"
|
|
"LimitCPU" "LimitDATA" "LimitFSIZE" "LimitLOCKS" "LimitMEMLOCK"
|
|
"LimitMSGQUEUE" "LimitNICE" "LimitNOFILE" "LimitNPROC" "LimitRSS"
|
|
"LimitRTPRIO" "LimitRTTIME" "LimitSIGPENDING" "LimitSTACK"
|
|
"ListenDatagram" "ListenFIFO" "ListenMessageQueue" "ListenNetlink"
|
|
"ListenSequentialPacket" "ListenSpecial" "ListenStream"
|
|
"ListenUSBFunction" "MakeDirectory" "Mark" "MaxConnections"
|
|
"MemoryAccounting" "MemoryLimit" "MessageQueueMaxMessages"
|
|
"MessageQueueMessageSize" "MountFlags" "NetClass" "Nice" "NoDelay"
|
|
"NoNewPrivileges" "NonBlocking" "NotifyAccess" "OOMScoreAdjust"
|
|
"OnActiveSec" "OnBootSec" "OnCalendar" "OnFailure" "OnFailureJobMode"
|
|
"OnStartupSec" "OnUnitActiveSec" "OnUnitInactiveSec" "Options" "PAMName"
|
|
"PIDFile" "PartOf" "PassCredentials" "PassEnvironment" "PassSecurity"
|
|
"PathChanged" "PathExists" "PathExistsGlob" "PathModified"
|
|
"PermissionsStartOnly" "Persistent" "Personality" "PipeSize" "Priority"
|
|
"PrivateDevices" "PrivateNetwork" "PrivateTmp" "PropagatesReloadTo"
|
|
"ProtectHome" "ProtectSystem" "RandomSec" "ReadOnlyDirectories"
|
|
"ReadWriteDirectories" "RebootArgument" "ReceiveBuffer"
|
|
"RefuseManualStart" "RefuseManualStop" "ReloadPropagatedFrom"
|
|
"RemainAfterElapse" "RemainAfterExit" "RemoveOnStop" "RequiredBy"
|
|
"Requires" "RequiresMountsFor" "Requisite" "Restart"
|
|
"RestartForceExitStatus" "RestartPreventExitStatus" "RestartSec"
|
|
"RestrictAddressFamilies" "ReusePort" "RootDirectory"
|
|
"RootDirectoryStartOnly" "RuntimeDirectory" "RuntimeDirectoryMode"
|
|
"SELinuxContext" "SELinuxContextFromNet" "SecureBits" "SendBuffer"
|
|
"SendSIGHUP" "SendSIGKILL" "Service" "Slice" "SloppyOptions"
|
|
"SmackLabel" "SmackLabelIPIn" "SmackLabelIPOut" "SmackProcessLabel"
|
|
"SocketGroup" "SocketMode" "SocketProtocol" "SocketUser" "Sockets"
|
|
"SourcePath" "StandardError" "StandardInput" "StandardOutput"
|
|
"StartLimitAction" "StartLimitBurst" "StartLimitInterval"
|
|
"StartupBlockIOWeight" "StartupCPUShares" "StopWhenUnneeded"
|
|
"SuccessExitStatus" "SupplementaryGroups" "Symlinks" "SyslogFacility"
|
|
"SyslogIdentifier" "SyslogLevel" "SyslogLevelPrefix"
|
|
"SystemCallArchitectures" "SystemCallErrorNumber" "SystemCallFilter"
|
|
"TCPCongestion" "TTYPath" "TTYReset" "TTYVHangup" "TTYVTDisallocate"
|
|
"TasksAccounting" "TasksMax" "TimeoutIdleSec" "TimeoutSec"
|
|
"TimeoutStartSec" "TimeoutStopSec" "TimerSlackNSec" "Transparent" "Type"
|
|
"UMask" "USBFunctionDescriptors" "USBFunctionStrings" "Unit" "User"
|
|
"UtmpIdentifier" "UtmpMode" "WakeSystem" "WantedBy" "Wants"
|
|
"WatchdogSec" "What" "Where" "WorkingDirectory" "Writable")
|
|
"Configuration directives for systemd 228.")
|
|
|
|
(defconst systemd-network-sections
|
|
'("Match" "Link" "NetDev" "VLAN" "MACVLAN" "MACVTAP" "IPVLAN" "VXLAN"
|
|
"Tunnel" "Peer" "Tun" "Tap" "Bond" "Network" "Address" "Route" "DHCP"
|
|
"Bridge" "BridgeFDB")
|
|
"Network configuration sections for systemd 225.")
|
|
|
|
(defconst systemd-network-directives
|
|
;; /Network directives/,/Journal fields/p
|
|
'("ARPAllTargets" "ARPIPTargets" "ARPIntervalSec" "ARPProxy" "ARPValidate"
|
|
"AdSelect" "Address" "AllSlavesActive" "AllowPortToBeRoot"
|
|
"Architecture" "BindCarrier" "BitsPerSecond" "Bond" "Bridge"
|
|
"ClientIdentifier" "CopyDSCP" "Cost" "CriticalConnection" "DHCP"
|
|
"DHCPServer" "DNS" "DefaultLeaseTimeSec" "Description" "Destination" "DiscoverPathMTU"
|
|
"Domains" "DownDelaySec" "Driver" "Duplex" "EmitDNS" "EmitNTP"
|
|
"EmitTimezone" "EncapsulationLimit" "FDBAgeingSec" "FailOverMACPolicy"
|
|
"FallbackDNS" "FallbackNTP" "FastLeave" "ForwardDelaySec" "Gateway"
|
|
"GratuitousARP" "GroupPolicyExtension" "HairPin" "HelloTimeSec" "Host"
|
|
"Hostname" "IPForward" "IPMasquerade" "IPv4LLRoute"
|
|
"IPv6AcceptRouterAdvertisements" "IPv6DuplicateAddressDetection"
|
|
"IPv6FlowLabel" "IPv6HopLimit" "IPv6PrivacyExtensions" "IPv6Token" "Id"
|
|
"KernelCommandLine" "Kind" "L2MissNotification" "L3MissNotification"
|
|
"LACPTransmitRate" "LLDP" "LLMNR" "Label" "LearnPacketIntervalSec"
|
|
"LinkLocalAddressing" "Local" "MACAddress" "MACAddressPolicy" "MACVLAN"
|
|
"MIIMonitorSec" "MTUBytes" "MacLearning" "MaxAgeSec" "MaxLeaseTimeSec"
|
|
"MaximumFDBEntries" "Metric" "MinLinks" "Mode" "MultiQueue" "NTP" "Name"
|
|
"NamePolicy" "OneQueue" "OriginalName" "PacketInfo" "PacketsPerSlave"
|
|
"Path" "Peer" "PoolOffset" "PoolSize" "PreferredSource"
|
|
"PrimaryReselectPolicy" "Remote" "RequestBroadcast" "ResendIGMP"
|
|
"RouteMetric" "RouteShortCircuit" "Scope" "SendHostname" "Source" "TOS"
|
|
"TTL" "Timezone" "TransmitHashPolicy" "Tunnel" "UDP6ZeroCheckSumRx"
|
|
"UDP6ZeroChecksumTx" "UDPCheckSum" "UnicastFlood" "UpDelaySec" "UseBPDU"
|
|
"UseDNS" "UseDomains" "UseHostname" "UseMTU" "UseNTP" "UseRoutes"
|
|
"UseTimezone" "VLAN" "VLANId" "VNetHeader" "VXLAN"
|
|
"VendorClassIdentifier" "Virtualization" "WakeOnLan")
|
|
"Network configuration directives for systemd 228.")
|
|
|
|
(defconst systemd-autoload-regexp
|
|
(eval-when-compile
|
|
(rx (+? (or alphanumeric (any "-_.@\\"))) "."
|
|
(or "automount" "busname" "mount" "service" "slice"
|
|
"socket" "swap" "target" "timer" "link" "netdev" "network")
|
|
string-end))
|
|
"Regexp for file buffers in which to autoload `systemd-mode'.")
|
|
|
|
(defconst systemd-tempfn-autoload-regexp
|
|
(eval-when-compile
|
|
(rx ".#"
|
|
(or (and (+? (or alphanumeric (any "-_.@\\"))) "."
|
|
(or "automount" "busname" "mount" "service" "slice"
|
|
"socket" "swap" "target" "timer" "link" "netdev" "network"))
|
|
"override.conf")
|
|
(= 16 (char hex-digit)) string-end))
|
|
"Regexp for temp file buffers in which to autoload `systemd-mode'.")
|
|
|
|
(defconst systemd-dropin-autoload-regexp
|
|
(eval-when-compile
|
|
(rx "/systemd/" (+? anything) ".d/"
|
|
(+? (or alphanumeric (any "-_.@\\"))) ".conf" string-end))
|
|
"Regexp for dropin config file buffers in which to autoload `systemd-mode'.")
|
|
|
|
(defun systemd-get-value (start)
|
|
"Return the value of the key whose value begins at position START.
|
|
Lines ending in a backslash are concatenated with the next
|
|
according to systemd.unit(5)."
|
|
(let ((break "\\\\\n")
|
|
end)
|
|
(save-excursion
|
|
(while (progn (goto-char (1- (line-end-position)))
|
|
(looking-at break))
|
|
(forward-line))
|
|
(setq end (line-end-position))
|
|
(replace-regexp-in-string break " " (buffer-substring start end)))))
|
|
|
|
(defun systemd-doc-find ()
|
|
"Find the value of the unit's “Documentation” keys.
|
|
Return values in a list of strings, otherwise nil."
|
|
(let ((key "^Documentation=")
|
|
string)
|
|
(save-excursion
|
|
(goto-char (point-min))
|
|
(while (re-search-forward key nil t)
|
|
(setq string (concat string " " (systemd-get-value (point))))))
|
|
(when string
|
|
(remove "\\" (split-string string)))))
|
|
|
|
(defun systemd-doc-man (page)
|
|
"Open a manual page PAGE with `systemd-man-function'."
|
|
(pcase (symbol-name systemd-man-function)
|
|
("woman" (woman (replace-regexp-in-string "([[:alnum:]]+)" "" page)))
|
|
("man" (man page))
|
|
(_ (apply 'systemd-man-function page))))
|
|
|
|
(defun systemd-doc-open (url)
|
|
"Prompt to open URL.
|
|
Interactively completes the documentation in the current unit
|
|
file, defaulting to the link under point, if any."
|
|
(interactive
|
|
(let* ((completion-cycle-threshold t)
|
|
(collection (systemd-doc-find))
|
|
(uri (or (thing-at-point-url-at-point)
|
|
(car-safe collection)))
|
|
(prompt (concat "URL"
|
|
(when uri (format " (default %s)" uri))
|
|
": ")))
|
|
(list (completing-read prompt collection nil nil nil nil uri))))
|
|
(let ((link (url-generic-parse-url url)))
|
|
(pcase (url-type link)
|
|
("file" (find-file (url-filename link)))
|
|
("man" (systemd-doc-man (url-filename link)))
|
|
("info" (url-info link))
|
|
((or "http" "https") (funcall systemd-browse-url-function url))
|
|
(_ (user-error "Invalid link")))))
|
|
|
|
(defun systemd-doc-directives ()
|
|
"Open systemd.directives(7)."
|
|
(interactive)
|
|
(systemd-doc-man "systemd.directives(7)"))
|
|
|
|
(defun systemd-buffer-section-p ()
|
|
"Return t if current line begins with \"[\", otherwise nil."
|
|
(save-excursion
|
|
(beginning-of-line)
|
|
(looking-at "\\[")))
|
|
|
|
(defun systemd-buffer-network-p ()
|
|
"Return non-nil if `buffer-name' has a network-type extension, otherwise nil."
|
|
(string-match-p (eval-when-compile
|
|
(rx "." (or "link" "netdev" "network") string-end))
|
|
(buffer-name)))
|
|
|
|
(defun systemd-completion-table (&rest _ignore)
|
|
"Return a list of completion candidates."
|
|
(let ((sectionp (systemd-buffer-section-p)))
|
|
(if (systemd-buffer-network-p)
|
|
(if sectionp systemd-network-sections systemd-network-directives)
|
|
(if sectionp systemd-unit-sections systemd-unit-directives))))
|
|
|
|
(defun systemd-complete-at-point ()
|
|
"Complete the symbol at point."
|
|
(let ((bounds (bounds-of-thing-at-point 'symbol)))
|
|
(list (or (car bounds) (point))
|
|
(or (cdr bounds) (point))
|
|
(completion-table-dynamic #'systemd-completion-table))))
|
|
|
|
(defun systemd-company-backend (command &optional arg &rest ignored)
|
|
"Backend for `company-mode' in `systemd-mode' buffers."
|
|
(interactive (list 'interactive))
|
|
(pcase command
|
|
(`interactive (company-begin-backend 'systemd-company-backend))
|
|
(`prefix (and (eq major-mode 'systemd-mode) (company-grab-symbol)))
|
|
(`candidates (all-completions arg (systemd-completion-table nil)))
|
|
(`post-completion (if (not (systemd-buffer-section-p)) (insert "=")))))
|
|
|
|
(defvar systemd-font-lock-keywords
|
|
`(("^\\([#;]\\)\\(.*\\)$"
|
|
(1 'font-lock-comment-delimiter-face)
|
|
(2 'font-lock-comment-face))
|
|
("\\\\$" 0 'font-lock-warning-face) ; line break
|
|
;; sections
|
|
("^\\(\\[[[:upper:]][[:alnum:]]+\\]\\)"
|
|
1 'font-lock-type-face)
|
|
;; keys
|
|
("^\\([[:upper:]][[:alnum:]]+\\)="
|
|
1 'font-lock-keyword-face)
|
|
;; boolean arguments
|
|
("=\\(1\\|yes\\|true\\|on\\|0\\|no\\|false\\|off\\)$"
|
|
1 'font-lock-constant-face)
|
|
;; specifiers
|
|
("%[nNpPiIfcrRtuUhsmbHv%]" 0 'font-lock-constant-face)
|
|
;; exec prefixes
|
|
("=\\(-@\\|@-\\|[@-]\\)"
|
|
1 'font-lock-negation-char-face))
|
|
"Default expressions to highlight in `systemd-mode'.
|
|
See systemd.unit(5) for details on unit file syntax.")
|
|
|
|
(defvar systemd-mode-syntax-table
|
|
(let ((table (make-syntax-table)))
|
|
(modify-syntax-entry ?\' "." table)
|
|
(modify-syntax-entry ?\" "." table)
|
|
(modify-syntax-entry ?\; " " table)
|
|
(modify-syntax-entry ?\n ">" table)
|
|
(modify-syntax-entry ?\% "\\" table)
|
|
table)
|
|
"Syntax table used in `systemd-mode' buffers.")
|
|
|
|
(defvar systemd-mode-map
|
|
(let ((map (make-sparse-keymap)))
|
|
(define-key map (kbd "C-c C-d") 'systemd-doc-directives)
|
|
(define-key map (kbd "C-c C-o") 'systemd-doc-open)
|
|
map)
|
|
"Keymap used in `systemd-mode' buffers.")
|
|
|
|
(easy-menu-define systemd-mode-menu systemd-mode-map
|
|
"Menu used in `systemd-mode' buffers."
|
|
'("Systemd"
|
|
["Open Unit File help" systemd-doc-open
|
|
:help "Documentation referenced in current buffer"]
|
|
["Open systemd.directives(7)" systemd-doc-directives
|
|
:help "Index of configuration directives"]))
|
|
|
|
;;;###autoload
|
|
(add-to-list 'auto-mode-alist `(,systemd-autoload-regexp . systemd-mode))
|
|
;;;###autoload
|
|
(add-to-list 'auto-mode-alist `(,systemd-tempfn-autoload-regexp . systemd-mode))
|
|
;;;###autoload
|
|
(add-to-list 'auto-mode-alist `(,systemd-dropin-autoload-regexp . systemd-mode))
|
|
|
|
;;;###autoload
|
|
(define-derived-mode systemd-mode conf-mode "Systemd"
|
|
"Major mode for editing systemd unit files.
|
|
See http://www.freedesktop.org/wiki/Software/systemd/ for more
|
|
information about systemd.
|
|
|
|
In addition to any hooks its parent mode might have run, this
|
|
mode runs the hook `systemd-mode-hook' at mode initialization.
|
|
|
|
Key bindings:
|
|
\\{systemd-mode-map}"
|
|
(set-keymap-parent systemd-mode-map nil)
|
|
(conf-mode-initialize systemd-comment-start)
|
|
(if (and systemd-use-company-p (fboundp 'company-mode))
|
|
(company-mode 1))
|
|
(add-hook 'company-backends #'systemd-company-backend)
|
|
(add-hook 'completion-at-point-functions #'systemd-complete-at-point)
|
|
(setq-local font-lock-defaults '(systemd-font-lock-keywords)))
|
|
|
|
(provide 'systemd)
|
|
|
|
;;; systemd.el ends here
|