├── test ├── mu4e-alert-test.el └── test-helper.el ├── .gitignore ├── screenshots └── mu4e-alert-in-action.png ├── Cask ├── CHANGELOG.org ├── README.org ├── mu4e-alert.el └── LICENSE /test/mu4e-alert-test.el: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .cask/ 2 | dist/ 3 | -------------------------------------------------------------------------------- /screenshots/mu4e-alert-in-action.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xzz53/mu4e-alert/HEAD/screenshots/mu4e-alert-in-action.png -------------------------------------------------------------------------------- /Cask: -------------------------------------------------------------------------------- 1 | (source gnu) 2 | (source melpa) 3 | 4 | (package-file "mu4e-alert.el") 5 | 6 | (development 7 | (depends-on "f") 8 | (depends-on "ecukes") 9 | (depends-on "ert-runner") 10 | (depends-on "el-mock")) 11 | -------------------------------------------------------------------------------- /test/test-helper.el: -------------------------------------------------------------------------------- 1 | ;;; test-helper.el --- Tests for mu4e-alert -*- lexical-binding: t; -*- 2 | 3 | ;;; Commentary: 4 | ;;; Helpers to write tests for mu4e-alert 5 | 6 | ;;; Code: 7 | 8 | ;; Setup load-path, some of this is redundant when tests are run from the 9 | ;; command line 10 | (let ((project-dir (locate-dominating-file (or (buffer-file-name) load-file-name) 11 | ".cask"))) 12 | (if (not project-dir) 13 | (user-error "Could not locate project root") 14 | (let ((default-directory (expand-file-name (format ".cask/%d.%d" 15 | emacs-major-version 16 | emacs-minor-version) 17 | project-dir))) 18 | (normal-top-level-add-subdirs-to-load-path)) 19 | 20 | (add-to-list 'load-path project-dir))) 21 | 22 | ;;; test-helper.el ends here 23 | -------------------------------------------------------------------------------- /CHANGELOG.org: -------------------------------------------------------------------------------- 1 | * Change Log 2 | All notable changes to this project will be documented in this file. 3 | The format is based on [[http://keepachangelog.com/][Keep a Changelog]]. 4 | 5 | ** Unreleased 6 | See [[https://github.com/iqbalansari/mu4e-alert/compare/v1.0...HEAD][Changes]] 7 | 8 | ** v1.0 - 2017-04-29 9 | See [[https://github.com/iqbalansari/mu4e-alert/compare/v0.4...v1.0][Changes]] 10 | 11 | *** Changed 12 | - Fetching of emails from ~mu~ are now throttled, as result multiple requests of unread emails are now batched into one 13 | - ~mu4e-alert~ now hooks into ~mu4e-msg-changed-hook~ instead of advicing ~mu4e-mark-execute-all~ to trigger fetching of mail counts 14 | 15 | ** v0.4 - 2016-09-28 16 | See [[https://github.com/iqbalansari/mu4e-alert/compare/v0.3...v0.4][Changes]] 17 | 18 | *** Changed 19 | - ~mu~ binary is now called directly, removing dependency on user shell and command line tools mu4e-alert can now work on any OS mu runs on (this has not been tested yet) 20 | 21 | *** Added 22 | - ~mu4e-headers-skip-duplicates~ option is now respected 23 | - ~mu4e-alert~ can now display for the count as well as subject of unread emails in notifications This can be customized 24 | - Window urgency is set on arrival of unread messages 25 | 26 | ** v0.3 - 2015-12-21 27 | See [[https://github.com/iqbalansari/mu4e-alert/compare/v0.2...v0.3][Changes]] 28 | 29 | *** Fixed 30 | - Display the message according to ~mu4e-alert-interesting-mail-query~ on clicking on modeline 31 | 32 | *** Changed 33 | - Use mu4e-mu-home if set 34 | 35 | ** v0.2 - 2015-09-15 36 | Initial public release 37 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | * mu4e alert 2 | 3 | [[./CHANGELOG.org][file:https://img.shields.io/badge/version-v0.4-blue.svg]] [[http://melpa.org/#/mu4e-alert][file:http://melpa.org/packages/mu4e-alert-badge.svg]] [[http://stable.melpa.org/#/mu4e-alert][file:http://stable.melpa.org/packages/mu4e-alert-badge.svg]] [[http://www.gnu.org/licenses/gpl-3.0.html][http://img.shields.io/:license-gpl3-blue.svg]] [[http://makeapullrequest.com][file:https://img.shields.io/badge/PRs-welcome-brightgreen.svg]] 4 | 5 | [[https://raw.githubusercontent.com/iqbalansari/mu4e-alert/master/screenshots/mu4e-alert-in-action.png][screenshots/mu4e-alert-in-action.png?raw=true]] 6 | 7 | ** Table of contents :TOC_4_gh: 8 | - [[#mu4e-alert][mu4e alert]] 9 | - [[#what-is-this][What is this?]] 10 | - [[#requirements][Requirements]] 11 | - [[#installation][Installation]] 12 | - [[#elpa][ELPA]] 13 | - [[#el-get][El-get]] 14 | - [[#usage][Usage]] 15 | - [[#desktop-notifications-for-unread-emails][Desktop notifications for unread emails]] 16 | - [[#mode-line-display-of-unread-emails][Mode Line display of unread emails]] 17 | - [[#customizations][Customizations]] 18 | - [[#general-options][General options]] 19 | - [[#customizing-the-desktop-notifications][Customizing the desktop notifications]] 20 | - [[#customizing-the-types-of-notifications-displayed][Customizing the types of notifications displayed]] 21 | - [[#customizing-the-notifications-for-unread-emails-counts][Customizing the notifications for unread emails counts]] 22 | - [[#customizing-the-notifications-for-unread-emails-subjects][Customizing the notifications for unread emails subjects]] 23 | - [[#customizing-urgency-hint][Customizing urgency hint]] 24 | - [[#customizing-the-mode-line-display][Customizing the mode-line display]] 25 | - [[#getting-desktop-notifications][Getting desktop notifications]] 26 | - [[#linux][Linux]] 27 | - [[#notifications][notifications]] 28 | - [[#libnotify][libnotify]] 29 | - [[#mac-osx][Mac OSX]] 30 | - [[#growl][growl]] 31 | - [[#notifier][notifier]] 32 | - [[#advanced-customizations][Advanced customizations]] 33 | - [[#acknowledgments][Acknowledgments]] 34 | 35 | ** What is this? 36 | mu4e-alert is an Emacs extension providing desktop notifications for [[https://github.com/djcb/mu][mu4e]], 37 | additionally it can display the number of unread emails in the mode-line. 38 | 39 | ** Requirements 40 | This package requires Emacs v24.3 or above and Mu version [[https://github.com/djcb/mu/releases/tag/v0.9.9.6][v0.9.9.6]] or 41 | above. It assumes that you have a working mu/mu4e setup. 42 | 43 | ** Installation 44 | *** ELPA 45 | ~mu4e-alert~ is available on [[http://melpa.org/#/mu4e-alert][MELPA]] and [[http://stable.melpa.org/#/mu4e-alert][MELPA Stable]]. Please follow the instructions on 46 | MELPA [[http://melpa.org/#/getting-started][website]] to enable it, if you haven't already. 47 | 48 | You can then install ~mu4e-alert~ from the [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Package-Menu.html][package menu]]. Alternatively 49 | install it by doing the following 50 | 51 | Refresh the package index 52 | #+BEGIN_QUOTE 53 | M-x package-refresh-contents RET 54 | #+END_QUOTE 55 | 56 | And then install it by doing 57 | #+BEGIN_QUOTE 58 | M-x package-install RET mu4e-alert 59 | #+END_QUOTE 60 | 61 | *** El-get 62 | ~mu4e-alert~ can also be installed using ~el-get~. Assuming you have latest 63 | version of el-get installing it by doing something similar to 64 | #+BEGIN_QUOTE 65 | M-x el-get-install RET mu4e-alert 66 | #+END_QUOTE 67 | 68 | ** Usage 69 | *** Desktop notifications for unread emails 70 | To enable desktop notifications manually, use the command 71 | ~mu4e-alert-enable-notifications~. To enable notification automatically on 72 | Emacs startup add something like the following to your ~init~ file 73 | 74 | #+BEGIN_SRC emacs-lisp 75 | ;; Choose the style you prefer for desktop notifications 76 | ;; If you are on Linux you can use 77 | ;; 1. notifications - Emacs lisp implementation of the Desktop Notifications API 78 | ;; 2. libnotify - Notifications using the `notify-send' program, requires `notify-send' to be in PATH 79 | ;; 80 | ;; On Mac OSX you can set style to 81 | ;; 1. notifier - Notifications using the `terminal-notifier' program, requires `terminal-notifier' to be in PATH 82 | ;; 1. growl - Notifications using the `growl' program, requires `growlnotify' to be in PATH 83 | (mu4e-alert-set-default-style 'libnotify) 84 | (add-hook 'after-init-hook #'mu4e-alert-enable-notifications) 85 | #+END_SRC 86 | 87 | ~mu4e-alert~ uses the value of ~alert-default-style~ as the default 88 | notification style, which defaults to ~message~, if you want to use different 89 | style please add a rule for category "mu4e-alert" using alert's API or use 90 | the function ~mu4e-alert-set-default-style~ to customize the value of 91 | ~mu4e-alert-style~. 92 | 93 | You can disable notifications using the command ~mu4e-alert-disable-notifications~ 94 | 95 | *** Mode Line display of unread emails 96 | Display of the unread email count in the mode-line can be enabled using the 97 | command ~mu4e-alert-enable-mode-line-display~ or adding something like the 98 | following to your ~init~ file 99 | 100 | #+BEGIN_SRC emacs-lisp 101 | (add-hook 'after-init-hook #'mu4e-alert-enable-mode-line-display) 102 | #+END_SRC 103 | 104 | After enabling mode-line display the unread emails can be viewed by clicking 105 | the mode-line indicator. 106 | 107 | Use the command ~mu4e-alert-disable-mode-line-display~ to disable mode-line 108 | indication of unread emails 109 | 110 | ** Customizations 111 | ~mu4e-alert~ should work with default options, nevertheless it offers the 112 | following customizations. Please see the ~mu4e-alert.el~ file or do =M-x= 113 | customize-group =RET= mu4e-alert =RET= to for documentation of customizable 114 | options. 115 | 116 | *** General options 117 | The query used to find unread (read 'interesting') emails can be customized 118 | using the variable ~mu4e-alert-interesting-mail-query~. So, for example, if 119 | you want ~mu4e-alert~ to ignore a certain maildir you can customize it to do 120 | so. In this example, we ignore a maildir that is located at ~/[Gmail].All 121 | Mail~ by adding this to the ~init.el~ file: 122 | 123 | #+BEGIN_SRC emacs-lisp 124 | (setq mu4e-alert-interesting-mail-query 125 | (concat 126 | "flag:unread" 127 | " AND NOT flag:trashed" 128 | " AND NOT maildir:" 129 | "\"/[Gmail].All Mail\"")) 130 | #+END_SRC 131 | 132 | *** Customizing the desktop notifications 133 | **** Customizing the types of notifications displayed 134 | ~mu4e-alert~ can display both the count as well subject of unread emails in 135 | the desktop notifications. Use the variable 136 | ~mu4e-alert-email-notification-types~ to customize the type of notifications 137 | displayed. It should be set to a list of types of notification you want to 138 | receive. Following are the notification types supported for now 139 | 140 | - count - Display the count of unread emails 141 | - subjects - Display the subject of unread emails 142 | 143 | For example, adding the following snippet to your init file, will instruct 144 | ~mu4e-alert~ to only display the number of unread emails. 145 | 146 | #+BEGIN_SRC emacs-lisp 147 | (setq mu4e-alert-email-notification-types '(count)) 148 | #+END_SRC 149 | 150 | **** Customizing the notifications for unread emails counts 151 | ~mu4e-alert~ allows you to customize the notifications for emails count by 152 | setting the following values 153 | 154 | |-----------------------------------------------+-------------------------------------------------------| 155 | | Variable | Aspect customized | 156 | |-----------------------------------------------+-------------------------------------------------------| 157 | | mu4e-alert-email-count-title | Title used for email count notifications | 158 | | mu4e-alert-email-count-notification-formatter | Formatting the message body of the email notification | 159 | |-----------------------------------------------+-------------------------------------------------------| 160 | 161 | **** Customizing the notifications for unread emails subjects 162 | For displaying subjects of unread emails, ~mu4e-alert~ groups unread emails 163 | according some criteria. Then subjects of the emails in each of the groups 164 | are displayed in separate desktop notifications. 165 | 166 | The following variables can be used to customize the notifications for subjects 167 | 168 | |------------------------------------------------+-------------------------------------------------------------------------------------------------------------| 169 | | Variable | Aspect customized | 170 | |------------------------------------------------+-------------------------------------------------------------------------------------------------------------| 171 | | mu4e-alert-mail-grouper | Function used to group unread emails | 172 | | mu4e-alert-group-by | Field used to group emails (this is applicable only if mu4e-alert-mail-grouper is set to the default value) | 173 | | mu4e-alert-grouped-mail-sorter | Function used to sort the groups of unread emails | 174 | | mu4e-alert-grouped-mail-notification-formatter | Function used to get notification for group of unread emails | 175 | | mu4e-alert-notify-repeated-mails | If set to non-nil, ~mu4e-alert~ displays notifications for all emails irrespective of whether user has been | 176 | | | notified about the email earlier. By default user is not notified about such repeated emails | 177 | |------------------------------------------------+-------------------------------------------------------------------------------------------------------------| 178 | 179 | **** Customizing urgency hint 180 | By default ~mu4e-alert~ sets the urgency hint for current Emacs frame (or 181 | the any mu4e frame if available), you can disable it by setting the 182 | variable ~mu4e-alert-set-window-urgency~ to ~nil~. 183 | 184 | *** Customizing the mode-line display 185 | The mode-line indicator for unread emails can be customized by setting the 186 | value of the variable ~mu4e-alert-modeline-formatter~ 187 | 188 | ** Getting desktop notifications 189 | By default the user is notified of unread messages using Emacs' ~message~ 190 | function. To get desktop notifications you can instruct ~mu4e-alert~ to use 191 | an appropriate style [[https://github.com/jwiegley/alert#builtin-alert-styles][provided]] by the ~alert~ library that works on your system. 192 | 193 | The easiest way to do this is use the function 194 | ~mu4e-alert-set-default-style~, calling it with the style to be used for 195 | notifications 196 | 197 | The styles available vary according to the OS 198 | 199 | *** Linux 200 | The following styles for desktop notifications, are available on Linux 201 | 202 | **** notifications 203 | This style uses ~notifications.el~ an implementation of the Desktop 204 | Notifications API, which ships with Emacs. It requires that Emacs is 205 | compiled with DBus support 206 | 207 | **** libnotify 208 | This style uses the command-line program ~notify-send~ to notify the user. 209 | The program should be in ~PATH~ 210 | 211 | *** Mac OSX 212 | The following styles for desktop notifications, are available on Mac OSX. 213 | Also see the discussion on the issue [[https://github.com/iqbalansari/mu4e-alert/issues/2][Does it works with MacOS X?]] 214 | 215 | **** growl 216 | This style uses the command-line program ~growlnotify~ to notify the user 217 | using ~Growl~. The program should be in ~PATH~ 218 | 219 | **** notifier 220 | This style uses the command-line program ~terminal-notifier~ to notify the 221 | user. The program should be in ~PATH~ 222 | 223 | ** Advanced customizations 224 | ~mu4e-alert~ uses the excellent [[https://github.com/jwiegley/alert][alert]] library for desktop notifications, more 225 | fine-grained customizations to the notifications can be done by using the 226 | ~alert~'s API. 227 | 228 | As an example the following customization will color the fringe (along with 229 | the usual desktop notification) if there are unread messages and the user is 230 | visiting one of ~mu4e-main-view~, ~mu4e-headers-view~ or viewing an email in 231 | mu4e. 232 | 233 | #+BEGIN_SRC emacs-lisp 234 | (mu4e-alert-set-default-style 'libnotify) 235 | (alert-add-rule :category "mu4e-alert" :style 'fringe :predicate (lambda (_) (string-match-p "^mu4e-" (symbol-name major-mode))) :continue t) 236 | (mu4e-alert-enable-notifications) 237 | #+END_SRC 238 | 239 | ** Acknowledgments 240 | Original mu4e-alert package was developed by @iqbalansari at 241 | https://github.com/iqbalansari/mu4e-alert. 242 | -------------------------------------------------------------------------------- /mu4e-alert.el: -------------------------------------------------------------------------------- 1 | ;;; mu4e-alert.el --- Desktop notification for mu4e -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2015-2017 Iqbal Ansari 4 | ;; Copyright (C) 2021-2024 Mikhail Rudenko 5 | 6 | ;; Author: Iqbal Ansari 7 | ;; Maintainer: Mikhail Rudenko 8 | ;; URL: https://github.com/xzz53/mu4e-alert 9 | ;; Keywords: mail, convenience 10 | ;; Version: 1.0 11 | ;; Package-Requires: ((alert "1.2") (s "1.10.0") (ht "2.0") (emacs "24.4")) 12 | 13 | ;; This program is free software; you can redistribute it and/or modify 14 | ;; it under the terms of the GNU General Public License as published by 15 | ;; the Free Software Foundation, either version 3 of the License, or 16 | ;; (at your option) any later version. 17 | 18 | ;; This program is distributed in the hope that it will be useful, 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | ;; GNU General Public License for more details. 22 | 23 | ;; You should have received a copy of the GNU General Public License 24 | ;; along with this program. If not, see . 25 | 26 | 27 | 28 | ;;; Commentary: 29 | 30 | ;; This package provides desktop notifications for mu4e, additionally it can 31 | ;; display the number of unread emails in the modeline 32 | 33 | 34 | 35 | ;;; Code: 36 | 37 | (require 'mu4e) 38 | (require 'alert) 39 | (require 's) 40 | (require 'ht) 41 | 42 | (require 'timer) 43 | (require 'time) 44 | (require 'advice) 45 | (require 'pcase) 46 | (require 'cl-lib) 47 | 48 | ;; Customizations 49 | 50 | (defgroup mu4e-alert nil 51 | "Customization options for mu4e-alert." 52 | :group 'mail 53 | :prefix "mu4e-alert-") 54 | 55 | (defcustom mu4e-alert-interesting-mail-query 56 | "flag:unread AND NOT flag:trashed" 57 | "The query to get count of unread (read interesting) emails. 58 | By default only unread emails are considered interesting, it should 59 | be string to be sent to the mu's find command." 60 | :type 'string 61 | :group 'mu4e-alert) 62 | 63 | (defcustom mu4e-alert-modeline-formatter 64 | #'mu4e-alert-default-mode-line-formatter 65 | "The function used to get the string to be displayed in the mode-line. 66 | It should be a function that accepts a single argument the current count of 67 | unread emails and should return the string to be displayed in the mode-line." 68 | :type 'function 69 | :group 'mu4e-alert) 70 | 71 | (defcustom mu4e-alert-email-count-notification-formatter 72 | #'mu4e-alert-default-email-count-notification-formatter 73 | "The function used to get the message for the desktop notification. 74 | It should be a function that accepts a single argument the current count of 75 | unread emails and should return the string to be used for the notification." 76 | :type 'function 77 | :group 'mu4e-alert) 78 | 79 | (defcustom mu4e-alert-max-messages-to-process 500 80 | "Limit searching and processing given number of messages." 81 | :type 'integer 82 | :group 'mu4e-alert) 83 | 84 | (defcustom mu4e-alert-email-count-title "mu4e" 85 | "The title to use for desktop notifications." 86 | :type 'string 87 | :group 'mu4e-alert) 88 | 89 | (defcustom mu4e-alert-group-by :from 90 | "Field to group messages to be displayed in notifications by. 91 | 92 | This should be one of :from, :to, :maildir, :priority and :flags or a function. 93 | If set to a function, the function should accept a single argument the list of 94 | messages and return a list of list of messages, where each individual list of 95 | messages should grouped together in one notification." 96 | :type '(radio :tag "Field to group messages to be displayed in notifications" 97 | (const :tag "Sender" :from) 98 | (const :tag "Recipient" :to) 99 | (const :tag "Maildir" :maildir) 100 | (const :tag "Priority" :priority) 101 | (const :tag "Flags" :flags)) 102 | :group 'mu4e-alert) 103 | 104 | (defcustom mu4e-alert-mail-grouper 105 | #'mu4e-alert-default-mails-grouper 106 | "The function used to get arrange similar mails in to a group. 107 | 108 | It should accept a list of mails and return a list of lists, where each list is 109 | a group of messages that user should be notified about in one notification." 110 | :type 'function) 111 | 112 | (defcustom mu4e-alert-grouped-mail-sorter 113 | #'mu4e-alert-default-grouped-mail-sorter 114 | "The function used to sort the emails after grouping them." 115 | :type 'function) 116 | 117 | (defcustom mu4e-alert-grouped-mail-notification-formatter 118 | #'mu4e-alert-default-grouped-mail-notification-formatter 119 | "The function used to get the notification for a group of mails. 120 | 121 | The function is used get the notification to be displayed for a group of emails. 122 | It should return a plist with keys :title and :body with the value of title and 123 | body for the notification respectively." 124 | :type 'function) 125 | 126 | (defcustom mu4e-alert-email-notification-types '(count subjects) 127 | "The types of notifications to be displayed for emails. 128 | 129 | It is a list of types of notifications to be issues for emails. The list can 130 | have following elements 131 | count - Notify the total email count to the user 132 | subjects - Notify with some content of the email, by default the emails are 133 | grouped by the sender. And one notification is issued per sender 134 | with the subject of the emails is displayed in the notification." 135 | :type 'symbol) 136 | 137 | (defcustom mu4e-alert-set-window-urgency t 138 | "Set window urgency on recieving unread emails. 139 | 140 | If non-nil `mu4e-alert' will set the WM_URGENT on detecting unread messages." 141 | :type 'boolean) 142 | 143 | (defcustom mu4e-alert-notify-repeated-mails nil 144 | "Notify about interesting mails that were notified about earlier. 145 | 146 | By default `mu4e-alert' does not notify about mails it has notified about 147 | earlier. For example, suppose you get two unread emails you read one and leave 148 | the other unread, next time the when mu4e-alert checks for unread emails, it 149 | will filter out the second message and show notifications only for mails that 150 | have arrived after the first check. Set this option to a non-nil value if you 151 | wish to be notified of all emails at each check irrespective of whether you have 152 | been notified of the an email earlier or no." 153 | :type 'boolean) 154 | 155 | (defcustom mu4e-alert-icon nil 156 | "Full path to icon to show in notification. 157 | 158 | Note that not all 'alert' notification backends support this." 159 | :type 'string 160 | :group 'mu4e-alert) 161 | 162 | ;;;###autoload 163 | (defun mu4e-alert-set-default-style (value) 164 | "Set the default style for unread email notifications. 165 | 166 | VALUE is the value to be used as the default style." 167 | (let ((notification-style (if (consp value) 168 | (eval value) 169 | value))) 170 | (unless (assoc value alert-styles) 171 | (user-error "[mu4e-alert] Do not know how to use `%s' style, please one of %s" 172 | value 173 | (mapcar #'car alert-styles))) 174 | (alert-add-rule :category "mu4e-alert" :style notification-style) 175 | (setq-default mu4e-alert-style notification-style))) 176 | 177 | (defcustom mu4e-alert-style alert-default-style 178 | "The default style to use for notifying the user about unread emails. 179 | 180 | This should be one of `alert-styles'. Setting this directly from Lisp will not 181 | work, to customize this value from Lisp use the function 182 | `mu4e-alert-set-default-style', if you want more fine grained customizations you 183 | can use alert's API and add rules for the category \"mu4e-alert\" 184 | 185 | See also https://github.com/jwiegley/alert." 186 | :type (alert-styles-radio-type 'radio) 187 | :set (lambda (_ value) (mu4e-alert-set-default-style value)) 188 | :group 'mu4e-alert) 189 | 190 | ;; deal with mu4e versions above 1.7 191 | ;; need to know whether on mu4e 1.7.x because its API changed. 192 | (defconst mu4e-alert--mu-is-17 193 | (version-list-<= '(1 7) (version-to-list mu4e-mu-version)) 194 | "Non-nil if we are using mu 1.7.4 or newer.") 195 | 196 | ;; declare functions to keep byte-compiler quiet 197 | (declare-function mu4e-running-p "mu4e-server" nil t) 198 | (declare-function mu4e~proc-running-p "mu4e" nil t) 199 | (declare-function mu4e--server-find "mu4e-server" nil t) 200 | (declare-function mu4e~proc-find "mu4e" nil t) 201 | (declare-function mu4e--init-handlers "mu4e" nil t) 202 | (declare-function mu4e-search "mu4e-search" nil t) 203 | 204 | ;; supress byte-compiler warning in mu4e v1.7 205 | (eval-when-compile 206 | (cl-remprop 'mu4e-headers-search 'byte-obsolete-info)) 207 | 208 | ;; make sure mu4e handlers are initialized in v1.7 209 | (when mu4e-alert--mu-is-17 210 | (mu4e--init-handlers)) 211 | 212 | ;; create aliases for mu4e functions and variables 213 | (defvaralias 'mu4e-alert-mu4e-header-func-var 214 | (if mu4e-alert--mu-is-17 'mu4e-headers-append-func 'mu4e-header-func) 215 | "mu4e variable storing function to process emails in header view.") 216 | 217 | (defvaralias 'mu4e-alert--mu4e-context-current 218 | (if mu4e-alert--mu-is-17 'mu4e--context-current 'mu4e~context-current) 219 | "mu4e variables to store the current context.") 220 | 221 | (defalias 'mu4e-alert--mu4e-search 222 | (if mu4e-alert--mu-is-17 #'mu4e-search #'mu4e-headers-search) 223 | "mu4e function to search for mail.") 224 | 225 | (defalias 'mu4e-alert--mu4e-proc-running-p-func 226 | (if mu4e-alert--mu-is-17 #'mu4e-running-p #'mu4e~proc-running-p) 227 | "Function that checks whether mu4e process is running.") 228 | 229 | (defalias 'mu4e-alert--mu4e-proc-find-func 230 | (if mu4e-alert--mu-is-17 #'mu4e--server-find #'mu4e~proc-find) 231 | "Function that searches for mail using mu4e.") 232 | 233 | ;; Core functions 234 | 235 | (defvar mu4e-alert-log-buffer " *mu4e-alert-logs*" 236 | "Buffer where mu4e-alert's internal logs are stored.") 237 | 238 | (defun mu4e-alert--sanity-check () 239 | "Sanity check run before attempting to fetch unread emails." 240 | (unless (and (bound-and-true-p mu4e-mu-binary) 241 | (stringp mu4e-mu-binary) 242 | (file-executable-p mu4e-mu-binary)) 243 | (user-error "Please set `mu4e-mu-binary' to the full path to the mu binary, before attempting to enable `mu4e-alert'"))) 244 | 245 | (defvar mu4e-alert--header-func-save mu4e-alert-mu4e-header-func-var 246 | "Saved :header handler from mu4e.") 247 | 248 | (defvar mu4e-alert--found-func-save mu4e-found-func 249 | "Saved :found handler from mu4e.") 250 | 251 | (defvar mu4e-alert--erase-func-save mu4e-erase-func 252 | "Saved :erase handler from mu4e.") 253 | 254 | (defvar mu4e-alert--messages 255 | "List of messages received by :header callback.") 256 | 257 | (defvar mu4e-alert--finding-p nil 258 | "Whether `find' request is in progress.") 259 | 260 | (defun mu4e-alert--erase-func () 261 | "Erase handler for mu process.") 262 | 263 | (defun mu4e-alert--found-func (_found) 264 | "Found handler for mu process." 265 | (mu4e-alert--find-end) 266 | (mu4e-alert--email-processor mu4e-alert--messages) 267 | (setq mu4e-alert-mu4e-header-func-var mu4e-alert--header-func-save 268 | mu4e-found-func mu4e-alert--found-func-save 269 | mu4e-erase-func mu4e-alert--erase-func-save)) 270 | 271 | (defun mu4e-alert--header-func (msg) 272 | "Message header handler for mu process. 273 | MSG argument is message plist." 274 | (if mu4e-alert--mu-is-17 275 | (setq mu4e-alert--messages msg) 276 | (push msg mu4e-alert--messages))) 277 | 278 | (defvar mu4e-alert--fetch-timer nil 279 | "The scheduled fetching of mails from mu.") 280 | 281 | (defun mu4e-alert--get-mu-unread-emails-1 () 282 | "Get messages from mu and invoke scheduled callbacks." 283 | (when (mu4e-alert--mu4e-proc-running-p-func) 284 | (if mu4e-alert--finding-p 285 | (setq mu4e-alert--fetch-timer 286 | (run-at-time 1.0 287 | nil 288 | #'mu4e-alert--get-mu-unread-emails-1)) 289 | (setq mu4e-alert-mu4e-header-func-var #'mu4e-alert--header-func 290 | mu4e-found-func #'mu4e-alert--found-func 291 | mu4e-erase-func #'mu4e-alert--erase-func) 292 | (setq mu4e-alert--messages nil) 293 | (mu4e-alert--mu4e-proc-find-func mu4e-alert-interesting-mail-query 294 | nil 295 | :date 296 | 'descending 297 | mu4e-alert-max-messages-to-process 298 | t 299 | nil)))) 300 | 301 | (defvar mu4e-alert--callback-queue nil 302 | "Callbacks queued for running after fetching mails from mu.") 303 | 304 | (defun mu4e-alert--email-processor (mails) 305 | "Process the MAILS fetched from mu. 306 | 307 | This simply runs queued callbacks one by one, any errors occurring while running 308 | are logged in the `mu4e-alert-log-buffer'" 309 | (let ((callback-queue mu4e-alert--callback-queue)) 310 | (setq mu4e-alert--callback-queue nil) 311 | (dolist (callback callback-queue) 312 | (condition-case err 313 | (funcall callback mails) 314 | (error (with-current-buffer (get-buffer-create mu4e-alert-log-buffer) 315 | (insert "Failed to execute a queued callback because: %s" 316 | (error-message-string err)))))))) 317 | 318 | (defun mu4e-alert--get-mu-unread-mails (callback) 319 | "Get the count of interesting emails asynchronously. 320 | CALLBACK is called with one argument the interesting emails." 321 | (mu4e-alert--sanity-check) 322 | (when (and (timerp mu4e-alert--fetch-timer) 323 | (not (timer--triggered mu4e-alert--fetch-timer))) 324 | (cancel-timer mu4e-alert--fetch-timer)) 325 | (push callback mu4e-alert--callback-queue) 326 | (setq mu4e-alert--fetch-timer 327 | (run-at-time 0.5 nil 328 | #'mu4e-alert--get-mu-unread-emails-1))) 329 | 330 | 331 | 332 | ;; Mode-line indicator for unread emails 333 | 334 | (defvar mu4e-alert-mode-line "" "The mode-line indicator to display the count of unread emails.") 335 | 336 | (defun mu4e-alert-default-mode-line-formatter (mail-count) 337 | "Default formatter used to get the string to be displayed in the mode-line. 338 | MAIL-COUNT is the count of mails for which the string is to displayed." 339 | (when (not (zerop mail-count)) 340 | (concat " " 341 | (propertize 342 | "Mail" 343 | 'display (when (display-graphic-p) 344 | display-time-mail-icon) 345 | 'face display-time-mail-face 346 | 'help-echo (concat (if (= mail-count 1) 347 | "You have an unread email" 348 | (format "You have %s unread emails" mail-count)) 349 | "\nClick here to view " 350 | (if (= mail-count 1) "it" "them")) 351 | 'mouse-face 'mode-line-highlight 352 | 'keymap '(mode-line keymap 353 | (mouse-1 . mu4e-alert-view-unread-mails) 354 | (mouse-2 . mu4e-alert-view-unread-mails) 355 | (mouse-3 . mu4e-alert-view-unread-mails))) 356 | (if (zerop mail-count) 357 | " " 358 | (format " [%d] " mail-count))))) 359 | 360 | (defun mu4e-alert-view-unread-mails () 361 | "View unread mails. 362 | This is primarily used to enable viewing unread emails by default mode-line 363 | formatter when user clicks on mode-line indicator." 364 | (interactive) 365 | (mu4e-alert--mu4e-search mu4e-alert-interesting-mail-query)) 366 | 367 | (defun mu4e-alert-update-mail-count-modeline () 368 | "Send a desktop notification about currently unread email." 369 | (mu4e-alert--get-mu-unread-mails (lambda (mails) 370 | (setq mu4e-alert-mode-line (funcall mu4e-alert-modeline-formatter 371 | (length mails))) 372 | (force-mode-line-update)))) 373 | 374 | 375 | ;; Desktop notifications for unread emails 376 | 377 | ;;;; Silence byte-compiler warnings for X11-only functions on non-X builds 378 | (eval-when-compile 379 | (declare-function x-window-property "x-win") 380 | (declare-function x-change-window-property "x-win") 381 | (declare-function x-delete-window-property "x-win")) 382 | 383 | ;;;; Setting urgency hint for Emacs frames 384 | (defun mu4e-alert--set-x-urgency-hint (frame arg) 385 | "Set window urgency hint for given FRAME. 386 | 387 | ARG should be non-nil to set the flag or nil to clear the flag. 388 | 389 | Taken from: http://www.emacswiki.org/emacs/JabberEl#toc17" 390 | (let* ((wm-hints (append (x-window-property "WM_HINTS" frame "WM_HINTS" nil nil t) nil)) 391 | (flags (car wm-hints))) 392 | (setcar wm-hints 393 | (if arg 394 | (logior flags #x00000100) 395 | (logand flags #x1ffffeff))) 396 | (x-change-window-property "WM_HINTS" wm-hints frame "WM_HINTS" 32 t))) 397 | 398 | (defvar mu4e-alert-urgent-window-flag "mu4e-alert-urgent") 399 | 400 | (defun mu4e-alert-set-x-urgency-hint (frame) 401 | "Set urgency hint for given FRAME. 402 | 403 | It also marks the frame, so that we can clear it later." 404 | (mu4e-alert--set-x-urgency-hint frame t) 405 | ;; Remember that we have set an urgency hint on this frame 406 | (x-change-window-property mu4e-alert-urgent-window-flag "true" frame)) 407 | 408 | (defun mu4e-alert-clear-urgency-hints () 409 | "Clear urgency hint for all frames. 410 | 411 | This only removes the hints added by `mu4e-alert'" 412 | (dolist (frame (frame-list)) 413 | (when (and (frame-live-p frame) 414 | ;; Wrapped in ignore-errors to prevent errors for 415 | ;; frames that do not support x-window-property 416 | (ignore-errors (x-window-property mu4e-alert-urgent-window-flag 417 | frame))) 418 | (mu4e-alert--set-x-urgency-hint frame nil) 419 | (x-delete-window-property mu4e-alert-urgent-window-flag frame)))) 420 | 421 | (defun mu4e-alert--get-mu4e-frame () 422 | "Try getting a frame containing a mu4e buffer." 423 | (car (delq nil (mapcar (lambda (buffer) 424 | (when (and buffer 425 | (get-buffer-window buffer t)) 426 | (window-frame (get-buffer-window buffer t)))) 427 | (list mu4e-main-buffer-name))))) 428 | 429 | (defun mu4e-alert--setup-clear-urgency () 430 | "Setup hooks to clear the urgency hooks." 431 | ;; if focus-in-hook (pre Emacs 24.4) is not defined hook into 432 | ;; post-command-hook instead 433 | (add-hook (if (boundp 'focus-in-hook) 'focus-in-hook 'post-command-hook) 434 | #'mu4e-alert-clear-urgency-hints)) 435 | 436 | (defun mu4e-alert-set-window-urgency-maybe () 437 | "Set urgency hint to current frame." 438 | (when (and mu4e-alert-set-window-urgency 439 | (display-graphic-p) 440 | (memql system-type '(gnu gnu/linux))) 441 | (let ((frame (or (mu4e-alert--get-mu4e-frame) 442 | (selected-frame)))) 443 | ;; Do not set urgency hint if the frame is visible 444 | (mu4e-alert-set-x-urgency-hint frame) 445 | (mu4e-alert--setup-clear-urgency)))) 446 | 447 | (defvar mu4e-alert-repeated-mails (ht-create #'equal)) 448 | 449 | (defun mu4e-alert-filter-repeated-mails (mails) 450 | "Filters the MAILS that have been seen already." 451 | (cl-remove-if (lambda (mail) 452 | (prog1 (and (not mu4e-alert-notify-repeated-mails) 453 | (ht-get mu4e-alert-repeated-mails 454 | (plist-get mail :message-id))) 455 | (ht-set! mu4e-alert-repeated-mails 456 | (plist-get mail :message-id) 457 | t))) 458 | mails)) 459 | 460 | (defun mu4e-alert--message-address (mail key) 461 | "Get a string representing address specified by KEY in MAIL." 462 | (let ((addr (car (plist-get mail key)))) 463 | (or 464 | (plist-get addr :name) 465 | (plist-get addr :email) 466 | (car addr) 467 | (cdr addr)))) 468 | 469 | (defun mu4e-alert--get-group (mail) 470 | "Get the group the given MAIL should be put in. 471 | 472 | This is an internal function used by `mu4e-alert-default-mails-grouper'." 473 | (pcase mu4e-alert-group-by 474 | (`:from (mu4e-alert--message-address mail :from)) 475 | (`:to (mu4e-alert--message-address mail :to)) 476 | (`:maildir (plist-get mail :maildir)) 477 | (`:priority (symbol-value (plist-get mail :maildir))) 478 | (`:flags (s-join ", " (mapcar #'symbol-value 479 | (plist-get mail :flags)))))) 480 | 481 | (defun mu4e-alert-default-email-count-notification-formatter (mail-count) 482 | "Default formatter for unread email count. 483 | MAIL-COUNT is the count of mails for which the string is to displayed." 484 | (when (not (zerop mail-count)) 485 | (if (= mail-count 1) 486 | "You have an unread email" 487 | (format "You have %s unread emails" mail-count)))) 488 | 489 | (defun mu4e-alert-default-grouped-mail-sorter (group1 group2) 490 | "The default function to sort the groups for notification. 491 | 492 | GROUP1 and GROUP2 are the group of mails to be sorted. This function groups 493 | by the date of first mail of group." 494 | (not (time-less-p (plist-get (car group1) :date) 495 | (plist-get (car group2) :date)))) 496 | 497 | (defun mu4e-alert-default-mails-grouper (mails) 498 | "Default function to group MAILS for notification." 499 | (let ((mail-hash (ht-create #'equal))) 500 | (dolist (mail mails) 501 | (let ((mail-group (mu4e-alert--get-group mail))) 502 | (puthash mail-group 503 | (cons mail (gethash mail-group mail-hash)) 504 | mail-hash))) 505 | (ht-values mail-hash))) 506 | 507 | (defun mu4e-alert-default-grouped-mail-notification-formatter (mail-group all-mails) 508 | "Default function to format MAIL-GROUP for notification. 509 | 510 | ALL-MAILS are the all the unread emails" 511 | (let* ((mail-count (length mail-group)) 512 | (total-mails (length all-mails)) 513 | (first-mail (car mail-group)) 514 | (title-prefix (format "You have [%d/%d] unread email%s" 515 | mail-count 516 | total-mails 517 | (if (> mail-count 1) "s" ""))) 518 | (field-value (mu4e-alert--get-group first-mail)) 519 | (title-suffix (format (pcase mu4e-alert-group-by 520 | (`:from "from %s:") 521 | (`:to "to %s:") 522 | (`:maildir "in %s:") 523 | (`:priority "with %s priority:") 524 | (`:flags "with %s flags:")) 525 | field-value)) 526 | (title (format "%s %s\n" title-prefix title-suffix))) 527 | (list :title title 528 | :body (concat "• " 529 | (s-join "\n• " 530 | (mapcar (lambda (mail) 531 | (plist-get mail :subject)) 532 | mail-group)))))) 533 | 534 | (defun mu4e-alert-notify-unread-messages (mails) 535 | "Display desktop notification for given MAILS." 536 | (let* ((mail-groups (funcall mu4e-alert-mail-grouper 537 | mails)) 538 | (sorted-mail-groups (sort mail-groups 539 | mu4e-alert-grouped-mail-sorter)) 540 | (notifications (mapcar (lambda (group) 541 | (funcall mu4e-alert-grouped-mail-notification-formatter 542 | group 543 | mails)) 544 | sorted-mail-groups))) 545 | (dolist (notification (cl-subseq notifications 0 (min 5 (length notifications)))) 546 | (alert (plist-get notification :body) 547 | :title (plist-get notification :title) 548 | :category "mu4e-alert" 549 | :icon mu4e-alert-icon)) 550 | (when notifications 551 | (mu4e-alert-set-window-urgency-maybe)))) 552 | 553 | (defun mu4e-alert-notify-unread-messages-count (mail-count) 554 | "Display desktop notification for given MAIL-COUNT." 555 | (when (not (zerop mail-count)) 556 | (alert (funcall mu4e-alert-email-count-notification-formatter 557 | mail-count) 558 | :title mu4e-alert-email-count-title 559 | :category "mu4e-alert" 560 | :icon mu4e-alert-icon))) 561 | 562 | (defun mu4e-alert-notify-unread-mail-async () 563 | "Send a desktop notification about currently unread email." 564 | (mu4e-alert--get-mu-unread-mails (lambda (mails) 565 | (let ((new-mails (mu4e-alert-filter-repeated-mails mails))) 566 | (when (memql 'count mu4e-alert-email-notification-types) 567 | (mu4e-alert-notify-unread-messages-count (length new-mails))) 568 | (when (memql 'subjects mu4e-alert-email-notification-types) 569 | (mu4e-alert-notify-unread-messages new-mails)))))) 570 | 571 | 572 | 573 | ;; Tying all the above together 574 | 575 | (defun mu4e-alert--context-switch (orig &rest args) 576 | "Advice to update mode-line after changing the context. 577 | ORIG is the original function to be called with ARGS." 578 | (let ((context mu4e-alert--mu4e-context-current)) 579 | (apply orig args) 580 | (unless (equal context mu4e-alert--mu4e-context-current) 581 | (mu4e-alert-update-mail-count-modeline)))) 582 | 583 | (defun mu4e-alert--find-start (&rest _) 584 | "Advice to track `find' request start." 585 | (setq mu4e-alert--finding-p t)) 586 | 587 | (defun mu4e-alert--find-end (&rest _) 588 | "Advice to track `find' request start." 589 | (setq mu4e-alert--finding-p nil)) 590 | 591 | (advice-add (symbol-function #'mu4e-alert--mu4e-proc-find-func) :before #'mu4e-alert--find-start) 592 | (advice-add mu4e-alert--found-func-save :before #'mu4e-alert--find-end) 593 | 594 | ;;;###autoload 595 | (defun mu4e-alert-enable-mode-line-display () 596 | "Enable display of unread emails in mode-line." 597 | (interactive) 598 | (add-to-list 'global-mode-string '(:eval mu4e-alert-mode-line) t) 599 | (add-hook 'mu4e-index-updated-hook #'mu4e-alert-update-mail-count-modeline) 600 | (add-hook 'mu4e-message-changed-hook #'mu4e-alert-update-mail-count-modeline) 601 | (advice-add #'mu4e-context-switch :around #'mu4e-alert--context-switch) 602 | (mu4e-alert-update-mail-count-modeline)) 603 | 604 | (defun mu4e-alert-disable-mode-line-display () 605 | "Disable display of unread emails in mode-line." 606 | (interactive) 607 | (setq global-mode-string (delete '(:eval mu4e-alert-mode-line) global-mode-string)) 608 | (remove-hook 'mu4e-index-updated-hook #'mu4e-alert-update-mail-count-modeline) 609 | (remove-hook 'mu4e-message-changed-hook #'mu4e-alert-update-mail-count-modeline) 610 | (advice-remove #'mu4e-context-switch #'mu4e-alert--context-switch)) 611 | 612 | ;;;###autoload 613 | (defun mu4e-alert-enable-notifications () 614 | "Enable desktop notifications for unread emails." 615 | (interactive) 616 | (add-hook 'mu4e-index-updated-hook #'mu4e-alert-notify-unread-mail-async) 617 | (mu4e-alert-notify-unread-mail-async)) 618 | 619 | (defun mu4e-alert-disable-notifications () 620 | "Disable desktop notifications for unread emails." 621 | (interactive) 622 | (remove-hook 'mu4e-index-updated-hook #'mu4e-alert-notify-unread-mail-async)) 623 | 624 | (provide 'mu4e-alert) 625 | ;;; mu4e-alert.el ends here 626 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | --------------------------------------------------------------------------------