├── terminal_velocity ├── __init__.py ├── notebook.py └── urwid_ui.py ├── MANIFEST.in ├── .gitignore ├── setup.py ├── CHANGELOG.txt ├── README.rst ├── bin └── terminal_velocity ├── CONTRIBUTING.md └── LICENSE.txt /terminal_velocity/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include *.md 2 | include *.rst 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.swp 3 | *~ 4 | MANIFEST 5 | dist/* 6 | terminal_velocity.egg-info/ 7 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | setup( 4 | name="terminal_velocity", 5 | version="0.1.9", 6 | author="Sean Hammond", 7 | packages=["terminal_velocity"], 8 | scripts=["bin/terminal_velocity"], 9 | url="http://seanh.github.com/terminal_velocity/", 10 | license="GNU General Public License, Version 3", 11 | description="A fast note-taking app for the UNIX terminal", 12 | long_description=open("README.rst").read(), 13 | install_requires=[ 14 | "urwid==1.1.1", 15 | "chardet==2.1.1", 16 | ], 17 | classifiers=[ 18 | 'Programming Language :: Python :: 2', 19 | 'Programming Language :: Python :: 2 :: Only', 20 | 'Programming Language :: Python :: 2.6', 21 | 'Programming Language :: Python :: 2.7', 22 | ], 23 | ) 24 | -------------------------------------------------------------------------------- /CHANGELOG.txt: -------------------------------------------------------------------------------- 1 | 0.1.9, 19th December 2016 2 | - Fix bug opening filenames with spaces in them (contributed by Vincent Perricone) 3 | - Improved -e argument handling (contributed by Sam Walker) 4 | 0.1.8, 19th October 2014 5 | - Add --exclude option (contributed by Selene Scriven and Abhinav Gupta) 6 | 0.1a7, 6th January 2013 7 | - Add --print-config option 8 | - Change --log_file option to --log-file. 9 | - Hide traceback on ctrl-c (#24) 10 | - Add --extensions option (#18) 11 | - Fix Python 2.6 "zero length field name in format" crash (#22) 12 | - Don't create a note with no title (#26) 13 | - Don't create a note called Find or Create (#27) 14 | - Add a CONTRIBUTING file 15 | - Change the README file, dev install instructions have been moved into 16 | CONTRIBUTING, README now contains basic install and usage 17 | instructions. 18 | - Various other fixes and tweaks 19 | 0.1a6, 4th January 2013 -- Fix broken MANIFEST file. 20 | 0.1a5, 4th January 2013 -- Add README to pypi page (long_description). 21 | 0.1a4, 4th January 2013 -- Change README from markdown to rest. 22 | 0.1a3, 4th January 2013 -- Unicode handling fixes. 23 | 0.1a2, 2nd January 2013 -- Fix a pip install warning. 24 | 0.1a1, 1st January 2013 -- Initial release. 25 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | **This is my unmaintained archived copy of Terminal Velocity**. 2 | 3 | Development has moved to Vincent Perricone's fork, you should use this instead: https://github.com/vhp/terminal_velocity 4 | 5 | Terminal Velocity (seanh's archived copy) 6 | ========================================= 7 | 8 | 9 | `Terminal Velocity` is a fast note-taking app for the UNIX terminal, that 10 | focuses on letting you create or find a note as quickly and easily as possible, 11 | then uses your ``$EDITOR`` to open and edit the note. It is heavily inspired 12 | by the OS X app `Notational Velocity `_. 13 | For screenshots and features, see the 14 | `Terminal Velocity website `_. 15 | 16 | To install Terminal Velocity, run:: 17 | 18 | pip install terminal_velocity 19 | 20 | Then to launch it just run:: 21 | 22 | terminal_velocity 23 | 24 | To use a different notes directory, run:: 25 | 26 | terminal_velocity path/to/your/notes/dir 27 | 28 | To see all the command-line options, run:: 29 | 30 | terminal_velocity -h 31 | 32 | To quit the app, press ``ctrl-c`` or ``ctrl-x``. 33 | 34 | To upgrade Terminal Velocity to the latest version, run:: 35 | 36 | pip install --upgrade terminal_velocity 37 | 38 | To uninstall it, run:: 39 | 40 | pip uninstall terminal_velocity 41 | 42 | To make a bug report or feature request, use `GitHub Issues `_. 43 | 44 | To contribute documentation, use `the wiki `_. 45 | 46 | To contribute code to Terminal Velocity, see 47 | `CONTRIBUTING `_. 48 | 49 | 50 | Hacking 51 | ------- 52 | 53 | To release a new version of Terminal Velocity: 54 | 55 | 1. Increment the version number in the 56 | `setup.py file `_, 57 | add an entry te the `changelog `_, 58 | commit both changes to git and push them to github. 59 | For example, see `aae87b `_. 60 | 61 | 2. Upload the new release to `the terminal_velocity package on pypi `_: run ``python setup.py sdist upload -r pypi``. 62 | 63 | For more information see https://packaging.python.org/. 64 | -------------------------------------------------------------------------------- /bin/terminal_velocity: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | """A fast note-taking app for the UNIX terminal""" 3 | 4 | import argparse 5 | import ConfigParser 6 | import os 7 | import logging 8 | import logging.handlers 9 | import sys 10 | 11 | import terminal_velocity.urwid_ui as urwid_ui 12 | 13 | 14 | def main(): 15 | 16 | # Parse the command-line option for the config file. 17 | parser = argparse.ArgumentParser(add_help=False) 18 | parser.add_argument("-c", "--config", dest="config", action="store", 19 | default="~/.tvrc", 20 | help="the config file to use (default: %(default)s)") 21 | args, remaining_argv = parser.parse_known_args() 22 | 23 | # Parse the config file. 24 | config_file = os.path.abspath(os.path.expanduser(args.config)) 25 | config = ConfigParser.SafeConfigParser() 26 | config.read(config_file) 27 | defaults = dict(config.items('DEFAULT')) 28 | 29 | # Parse the rest of the command-line options. 30 | description = __doc__ 31 | epilog = """ 32 | the config file can be used to override the defaults for the optional 33 | arguments, example config file contents: 34 | 35 | [DEFAULT] 36 | editor = vim 37 | # The filename extension to use for new files. 38 | extension = .txt 39 | # The filename extensions to recognize in the notes dir. 40 | extensions = .txt, .text, .md, .markdown, .mdown, .mdwn, .mkdn, .mkd, .rst 41 | notes_dir = ~/Notes 42 | 43 | if there is no config file (or an argument is missing from the config file) 44 | the default default will be used""" 45 | 46 | parser = argparse.ArgumentParser(description=description, epilog=epilog, 47 | parents=[parser], 48 | formatter_class=argparse.RawDescriptionHelpFormatter) 49 | parser.add_argument("-e", "--editor", dest="editor", action="store", 50 | default=defaults.get("editor", os.getenv("EDITOR", "vim")), 51 | help="the text editor to use (default: %(default)s)") 52 | 53 | parser.add_argument("-x", "--extension", dest="extension", action="store", 54 | default=defaults.get("extension", "txt"), 55 | help="the filename extension for new notes (default: %(default)s)") 56 | 57 | parser.add_argument("--extensions", dest="extensions", action="store", 58 | default=defaults.get("extensions", 59 | ".txt, .text, .md, .markdown, .mdown, .mdwn, .mkdn, .mkd, .rst"), 60 | help="the filename extensions to recognize in the notes dir, a " 61 | "comma-separated list (default: %(default)s)") 62 | 63 | parser.add_argument("--exclude", dest="exclude", action="store", 64 | default=defaults.get("exclude", 65 | "src, backup, ignore, tmp, old"), 66 | help="the file/directory names to skip while recursively searching " 67 | "the notes dir for notes, a comma-separated list " 68 | "(default: %(default)s)") 69 | 70 | parser.add_argument("-d", "--debug", dest="debug", action="store_true", 71 | default=defaults.get("debug", False), 72 | help="debug logging on or off (default: off)") 73 | 74 | parser.add_argument("-l", "--log-file", dest="log_file", action="store", 75 | default=defaults.get("log_file", "~/.tvlog"), 76 | help="the file to log to (default: %(default)s)") 77 | 78 | parser.add_argument("-p", "--print-config", dest="print_config", 79 | action="store_true", default=False, 80 | help="print your configuration settings then exit") 81 | 82 | parser.add_argument("notes_dir", action="store", nargs="?", 83 | default=defaults.get("notes_dir", "~/Notes"), 84 | help="the notes directory to use (default: %(default)s)") 85 | 86 | args = parser.parse_args() 87 | 88 | extensions = [] 89 | for extension in args.extensions.split(","): 90 | extensions.append(extension.strip()) 91 | args.extensions = extensions 92 | 93 | exclude = [] 94 | for name in args.exclude.split(","): 95 | exclude.append(name.strip()) 96 | args.exclude = exclude 97 | 98 | if args.print_config: 99 | print args 100 | sys.exit() 101 | 102 | logger = logging.getLogger("terminal_velocity") 103 | # Send all messages to handlers, let them decide. 104 | logger.setLevel(logging.DEBUG) 105 | fh = logging.handlers.RotatingFileHandler( 106 | os.path.abspath(os.path.expanduser(args.log_file)), 107 | maxBytes=1000000, # 1 megabyte. 108 | backupCount=0) 109 | if args.debug: 110 | fh.setLevel(logging.DEBUG) 111 | else: 112 | fh.setLevel(logging.WARNING) 113 | logger.addHandler(fh) 114 | sh = logging.StreamHandler(sys.stdout) 115 | sh.setLevel(logging.CRITICAL) 116 | logger.addHandler(sh) 117 | 118 | logger.debug(args) 119 | 120 | try: 121 | urwid_ui.launch(notes_dir=args.notes_dir, editor=args.editor, 122 | extension=args.extension, extensions=args.extensions, 123 | exclude=args.exclude) 124 | except KeyboardInterrupt: 125 | # Silence KeyboardInterrupt tracebacks on ctrl-c. 126 | sys.exit() 127 | 128 | if __name__ == "__main__": 129 | main() 130 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | Contributing to Terminal Velocity 2 | --------------------------------- 3 | 4 | 5 | If you want to contribute bug reports or feature requests, documentation, or 6 | code to Terminal Velocity, you can send them to me by email or by whatever means 7 | you prefer. But if you're looking for instructions, here are my suggestions: 8 | 9 | If you want to contribute a bug report or feature request to Terminal Velocity, 10 | use 11 | [GitHub Issues](https://github.com/seanh/terminal_velocity/issues?state=open). 12 | 13 | If you want to contribute documentation, for example to explain how to combine 14 | Terminal Velocity with an external tool that handles something like note 15 | synchronisation or encryption, use 16 | [the wiki](https://github.com/seanh/terminal_velocity/wiki). 17 | 18 | If you want to contribute code to Terminal Velocity: create your own GitHub 19 | account, fork Terminal Velocity, create a new bugfix or feature branch and 20 | commit your code to it, push your branch to your Terminal Velocity fork on 21 | GitHub, then send me a pull request asking me to pull your feature branch into 22 | my master branch. In detail: 23 | 24 | 1. [Install the Terminal Velocity development version](https://github.com/seanh/terminal_velocity/blob/master/CONTRIBUTING.md#how-to-install-the-terminal-velocity-development-version). 25 | 26 | 2. Checkout a new branch, forked from the master branch, e.g. 27 | `git checkout -b my-new-feature`. _Don't commit on the master branch_, 28 | instead develop each bugfix or feature on its own branch forked from master. 29 | 30 | 3. [Create a GitHub account](https://github.com/signup) (it's free!) 31 | 32 | 4. Fork my Terminal Velocity repo: click the _Fork_ button on the Terminal 33 | Velocity GitHub page. 34 | 35 | 5. In the git clone on your dev machine, add your GitHub fork as a remote (you 36 | only need to this once): 37 | 38 | git remote add MY_FORK https://github.com/YOUR_USERNAME/terminal_velocity.git 39 | 40 | 6. Push your feature or bugfix branch to your fork: 41 | 42 | git push MY_FORK my-new-feature 43 | 44 | 7. Use the _Pull Request_ button on the main Terminal Velocity project page to 45 | send me a pull request, asking me to pull your bugfix or feature branch into 46 | my master branch. 47 | 48 | 8. Once I've pulled your pull request, then you can pull my master branch into 49 | the master branch on your dev machine and push it to the master branch on 50 | your GitHub fork, to get the new feature in those master branches as well: 51 | 52 | git checkout master 53 | git pull origin master 54 | git push MY_FORK master 55 | 56 | For code style, I try to follow [PEP 8](http://www.python.org/dev/peps/pep-0008/) and 57 | [PEP 257](http://www.python.org/dev/peps/pep-0257/). I try to make code compatible 58 | with Python 2, version 2.6 or newer (i.e. don't use 59 | [Python 2.7-only features](http://docs.python.org/2/whatsnew/2.7.html)). 60 | That being said, I also try to write Python 2 code that's 61 | [forward-compatible with Python 3](http://lucumr.pocoo.org/2011/1/22/forwards-compatible-python/). 62 | For git commit messages, I try to follow these [Commit Guidelines](http://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines). 63 | 64 | 65 | ### How To Install the Terminal Velocity Development Version 66 | 67 | To install Terminal Velocity for development, you need 68 | [Python](http://www.python.org/), 69 | [virtualenv](http://www.virtualenv.org/), 70 | [virtualenvwrapper](http://www.doughellmann.com/projects/virtualenvwrapper/) 71 | and [git](http://git-scm.com/) 72 | (technically you can make do without virtualenv and virtualenvwrapper, but they 73 | make development a lot more convenient). 74 | 75 | Use virtualenvwrapper to create a Python virtualenv and install Terminal 76 | Velocity and its dependences into the virtualenv, for example: 77 | 78 | $ mkvirtualenv terminal_velocity 79 | (terminal_velocity) $ mkdir -p ~/Projects/terminal_velocity 80 | (terminal_velocity) $ cd ~/Projects/terminal_velocity 81 | (terminal_velocity) $ setvirtualenvproject 82 | (terminal_velocity) $ git clone https://github.com/seanh/terminal_velocity.git 83 | (terminal_velocity) $ cd terminal_velocity 84 | (terminal_velocity) $ python setup.py develop 85 | (terminal_velocity) $ deactivate 86 | $ workon terminal_velocity 87 | 88 | At this point, the `terminal_velocity` command should run your development 89 | copy of Terminal Velocity from your virtualenv: 90 | 91 | (terminal_velocity) $ which terminal_velocity 92 | /home/seanh/.virtualenvs/terminal_velocity/bin/terminal_velocity 93 | 94 | Each time you open a new shell to start working on Terminal Velocity 95 | development, you need to activate your terminal_velocity virtualenv: 96 | 97 | $ workon terminal_velocity 98 | (terminal_velocity) $ 99 | 100 | When you're finished working, deactivate the virtualenv: 101 | 102 | (terminal_velocity) $ deactivate 103 | $ 104 | 105 | While the virtualenv is deactivated, the `terminal_velocity` command will run 106 | your installed release version of Terminal Velocity (if you have one) rather 107 | than the development version installed in your virtualenv: 108 | 109 | $ which terminal_velocity 110 | /usr/local/bin/terminal_velocity 111 | 112 | So you can easily switch between your stable and development copies of Terminal 113 | Velocity by activating and deactivating your virtualenv with the `workon` and 114 | `deactivate` commands. You can also have multiple shells open, some with the 115 | virtualenv activated and others not, so you can use your stable copy of 116 | Terminal Velocity to takes note while you hack on your development version. 117 | 118 | You can also setup different aliases (e.g. in your `~/.bashrc` or 119 | `~/.zshrc`) for running the release and development versions: 120 | 121 | alias tv="/usr/local/bin/terminal_velocity" 122 | alias tvdev="/home/seanh/.virtualenvs/terminal_velocity/bin/python /home/seanh/Projects/terminal_velocity/bin/terminal_velocity" 123 | 124 | -------------------------------------------------------------------------------- /terminal_velocity/notebook.py: -------------------------------------------------------------------------------- 1 | """Persistent note storage and search. 2 | 3 | This module defines the NoteBook and Note interfaces and provides 4 | PlainTextNoteBook and PlainTextNote implementations that store notes in a 5 | directory of plain text files. 6 | 7 | Other implementations could store notes differently (e.g. in a database) and 8 | provide drop-in replacements for PlainTextNoteBook and PlainTextNote by 9 | implementing the same NoteBook and Note interfaces. 10 | 11 | TODO: Extract the NoteBook and Note interfaces into separate interface classes 12 | for clarity. 13 | 14 | A NoteBook is a container of Notes. It behaves like a standard Python 15 | container, e.g. you can do: 16 | 17 | notebook = PlainTextNoteBook("/path/to/my/notes/dir") 18 | 19 | note = notebook[5] 20 | 21 | for note in notebook: 22 | ... 23 | 24 | if note in notebook: 25 | ... 26 | 27 | len(notebook) 28 | 29 | reversed(notebook) 30 | 31 | del notebook[3] 32 | 33 | notebook.remove(note) 34 | 35 | When deleting or removing a Note from a NoteBook, DelNoteError may be raised if 36 | removing the note fails. 37 | 38 | You should not initialise your own Note objects when working with a NoteBook, 39 | instead use the NoteBook's add_new() method: 40 | 41 | try: 42 | note = notebook.add_new("The Title of My New Note") 43 | except AddNoteError: 44 | ... 45 | 46 | NoteBooks also provide a search() method for doing fast, full-text search of 47 | notes: 48 | 49 | matching_notes = notebook.search(query) 50 | 51 | This module provides a simple brute force full text search implementation. 52 | Other modules could provide better search functions that could be plugged in. 53 | 54 | """ 55 | import logging 56 | logger = logging.getLogger(__name__) 57 | import os 58 | import sys 59 | 60 | import chardet 61 | 62 | 63 | def unicode_or_bust(raw_text): 64 | """Return the given raw text data decoded to unicode. 65 | 66 | If the text cannot be decoded, return None. 67 | 68 | """ 69 | encodings = ["utf-8"] 70 | for encoding in (sys.getfilesystemencoding(), sys.getdefaultencoding()): 71 | # I would use a set for this, but they don't maintain order. 72 | if encoding not in encodings: 73 | encodings.append(encoding) 74 | 75 | for encoding in encodings: 76 | if encoding: # getfilesystemencoding() may return None 77 | try: 78 | decoded = unicode(raw_text, encoding=encoding) 79 | return decoded 80 | except UnicodeDecodeError: 81 | pass 82 | 83 | # If none of those guesses worked, let chardet have a go. 84 | encoding = chardet.detect(raw_text)["encoding"] 85 | if encoding and encoding not in encodings: 86 | try: 87 | decoded = unicode(raw_text, encoding=encoding) 88 | logger.debug("File decoded with chardet, encoding was {0}".format( 89 | encoding)) 90 | return decoded 91 | except UnicodeDecodeError: 92 | pass 93 | except LookupError: 94 | pass 95 | 96 | # I've heard that decoding with cp1252 never fails, so try that last. 97 | try: 98 | decoded = unicode(raw_text, encoding="cp1252") 99 | logger.debug("File decoded with encoding cp1252") 100 | return decoded 101 | except UnicodeDecodeError: 102 | pass 103 | 104 | # If nothing worked then give up. 105 | return None 106 | 107 | 108 | class Error(Exception): 109 | """Base class for exceptions in this module.""" 110 | pass 111 | 112 | 113 | class NewNoteBookError(Error): 114 | """Exception raised if initialising a new NoteBook fails. 115 | 116 | """ 117 | def __init__(self, value): 118 | self.value = value 119 | 120 | def __str__(self): 121 | return repr(self.value) 122 | 123 | 124 | class NewNoteError(Error): 125 | """Exception raised if making a new Note or adding it to a NoteBook fails. 126 | 127 | """ 128 | def __init__(self, value): 129 | self.value = value 130 | 131 | def __str__(self): 132 | return repr(self.value) 133 | 134 | 135 | class NoteAlreadyExistsError(NewNoteError): 136 | """Exception raised when trying to add a new note that already exists. 137 | 138 | """ 139 | pass 140 | 141 | 142 | class InvalidNoteTitleError(NewNoteError): 143 | """Exception raised when trying to add a new note with an invalid title. 144 | 145 | """ 146 | pass 147 | 148 | 149 | class DelNoteError(Error): 150 | """Exception raised if removing a Note from a NoteBook fails. 151 | 152 | """ 153 | def __init__(self, value): 154 | self.value = value 155 | 156 | def __str__(self): 157 | return repr(self.value) 158 | 159 | 160 | class PlainTextNote(object): 161 | """A note, stored as a plain text file on disk.""" 162 | 163 | def __init__(self, title, notebook, extension): 164 | """Initialise a new PlainTextNote. 165 | 166 | A path for the note's file will be generated from the NoteBook's 167 | path and the given title and extension. 168 | 169 | If a file already exists at the given path, it will be used as the 170 | note's file. If not, an empty file will be created (parent directories 171 | will be created also, if necessary). 172 | 173 | The modified time of the note will be read from the mtime of the file. 174 | 175 | Raises NewNoteError if something goes wrong when creating or reading 176 | the note file. 177 | 178 | Keyword arguments: 179 | title -- the title for the note 180 | notebook -- the PlainTextNoteBook this PlainTextNote will belong to 181 | extension -- the filename extension to use (string, should start with 182 | a dot e.g. ".txt") 183 | 184 | """ 185 | self._title = title 186 | self._notebook = notebook 187 | self._extension = extension 188 | self._filename = self.title + self._extension 189 | self._abspath = os.path.join(self._notebook.path, self._filename) 190 | 191 | # Create the file's parent directories (including note directory 192 | # subdirs) if they don't exist. 193 | directory = os.path.split(self.abspath)[0] 194 | if not os.path.isdir(directory): 195 | logger.debug(u"'{0} doesn't exist, creating it".format(directory)) 196 | try: 197 | os.makedirs(directory) 198 | except os.error as e: 199 | raise NewNoteError( 200 | u"{0} could not be created: {1}".format(directory, e)) 201 | 202 | # Create an empty file if the file doesn't exist. 203 | open(self.abspath, 'a') 204 | 205 | @property 206 | def title(self): 207 | return self._title 208 | 209 | @title.setter 210 | def set_title(self, new_title): 211 | # TODO: Implement note renaming. Should rename file on disk. 212 | raise NotImplementedError 213 | 214 | @property 215 | def extension(self): 216 | return self._extension 217 | 218 | @property 219 | def contents(self): 220 | contents = unicode_or_bust(open(self.abspath, "r").read()) 221 | if contents is None: 222 | logger.error( 223 | u"Could not decode file contents: {0}".format(self.abspath)) 224 | return u"" 225 | else: 226 | return contents 227 | 228 | @property 229 | def mtime(self): 230 | return os.path.getmtime(self.abspath) 231 | 232 | @property 233 | def abspath(self): 234 | return self._abspath 235 | 236 | def __eq__(self, other): 237 | return getattr(other, 'abspath', None) == self.abspath 238 | 239 | 240 | def brute_force_search(notebook, query): 241 | """Return all notes in `notebook` that match `query`. 242 | 243 | Returns a sequence of Note objects that match the given search query. 244 | 245 | Arguments: 246 | 247 | notebook - the notebook to search (NoteBook) 248 | 249 | query - the query to search for (string) 250 | 251 | This is implemented as a standalone function so it can easily be replaced 252 | with some other function that does the search differently (e.g. you could 253 | have a config option to choose between different search implementations). 254 | 255 | This implementation does a brute force search that simply reads every file 256 | in the notebook looking for the search words. 257 | 258 | """ 259 | search_words = query.strip().split() 260 | matching_notes = [] 261 | for note in notebook: 262 | match = True 263 | for search_word in search_words: 264 | if search_word.islower(): 265 | # Search for word case-insensitively. 266 | in_title = search_word in note.title.lower() 267 | in_contents = search_word in note.contents.lower() 268 | else: 269 | # Search for word case-sensitively. 270 | in_title = search_word in note.title 271 | in_contents = search_word in note.contents 272 | if (not in_title) and (not in_contents): 273 | match = False 274 | if match: 275 | matching_notes.append(note) 276 | return matching_notes 277 | 278 | 279 | class PlainTextNoteBook(object): 280 | """A NoteBook that stores its notes as a directory of plain text files.""" 281 | 282 | def __init__(self, path, extension, extensions, 283 | search_function=brute_force_search, exclude=None): 284 | """Make a new PlainTextNoteBook for the given path. 285 | 286 | If `path` does not exist it will be created (parent directories too). 287 | 288 | If `path` does exist, any note files in path will be read and included 289 | in the NoteBook. Subdirectories in `path` will be read recursively. 290 | 291 | Raises NewNoteBookError if creating the notebook directory or reading 292 | the files in an existing directory fails. 293 | 294 | Arguments: 295 | 296 | path -- absolute path to the directory where this NoteBook's note files 297 | are kept (string) 298 | 299 | extension -- the filename extension to use for new notes (string) 300 | 301 | extensions -- the filename extensions to read in the notes dir 302 | (list of strings) 303 | 304 | search_function -- the function to call to search the notebook 305 | 306 | """ 307 | # Expand ~ in path, and transform it into an absolute path. 308 | self._path = os.path.abspath(os.path.expanduser(path)) 309 | 310 | if extension and not extension.startswith("."): 311 | extension = "." + extension 312 | self.extension = extension 313 | self.search_function = search_function 314 | self.exclude = exclude 315 | if not self.exclude: self.exclude = [] 316 | 317 | self.extensions = [] 318 | for extension in extensions: 319 | if not extension.startswith("."): 320 | extension = "." + extension 321 | self.extensions.append(extension) 322 | 323 | # Create notebook_dir if it doesn't exist. 324 | if not os.path.isdir(self.path): 325 | logger.debug(u"'{0} doesn't exist, creating it".format(self.path)) 326 | try: 327 | os.makedirs(self.path) 328 | except os.error as e: 329 | raise NewNoteBookError( 330 | u"{0} could not be created: {1}".format(self.path, e)) 331 | else: 332 | # TODO: Check that self.path is a directory, if not raise. 333 | pass 334 | 335 | # Read any existing note files in the notes directory. 336 | self._notes = [] 337 | for root, dirs, files in os.walk(self.path): 338 | 339 | # ignore any dirs we don't want to check 340 | for name in self.exclude: 341 | if name in dirs: 342 | dirs.remove(name) 343 | 344 | for filename in files: 345 | 346 | # ignore anything listed in our 'exclude' list 347 | if filename in self.exclude: 348 | continue 349 | 350 | # Ignore hidden and backup files. 351 | if filename.startswith('.') or filename.endswith('~'): 352 | continue 353 | 354 | if os.path.splitext(filename)[1] not in self.extensions: 355 | continue 356 | 357 | # Make a Note object for the file and add it to this NoteBook. 358 | abspath = os.path.join(root, filename) 359 | relpath = os.path.relpath(abspath, self.path) 360 | relpath, ext = os.path.splitext(relpath) 361 | unicode_relpath = unicode_or_bust(relpath) 362 | if relpath is None: 363 | # The filename could not be decoded. 364 | logger.error( 365 | "Could not decode filename: {0}".format(relpath)) 366 | else: 367 | self.add_new(title=unicode_relpath, extension=ext) 368 | 369 | @property 370 | def path(self): 371 | return self._path 372 | 373 | def search(self, query): 374 | """Return a sequence of Notes that match the given query. 375 | 376 | Arguments: 377 | query -- the search query match notes against (string) 378 | 379 | """ 380 | return self.search_function(self, query) 381 | 382 | def add_new(self, title, extension=None): 383 | """Create a new Note and add it to this NoteBook. 384 | 385 | Returns the newly-created Note object. 386 | 387 | Raises NewNoteError if creating or adding the Note fails. 388 | 389 | Raises NoteAlreadyExistsError if creating or adding the Note fails 390 | because this NoteBook already contains a Note with the given title. 391 | 392 | Notes can be added to subdirectories of the notebook directory by 393 | putting slashes in their titles, e.g. 394 | "programming/python/How to use Decorators in Python" 395 | 396 | Arguments: 397 | title -- the title for the new note (string) 398 | extension -- the filename extension for the new note (string, should 399 | start with a dot e.g. ".txt") 400 | 401 | """ 402 | if extension is None: 403 | extension = self.extension 404 | 405 | # Don't create notes outside of the notes dir. 406 | if title.startswith(os.sep): 407 | title = title[len(os.sep):] 408 | 409 | title = title.strip() 410 | 411 | if not os.path.split(title)[1]: 412 | # Don't create notes with empty filenames. 413 | raise InvalidNoteTitleError( 414 | "Invalid note title: {0}".format(title)) 415 | 416 | # Check that we don't already have a note with the same title and 417 | # extension. 418 | for note in self._notes: 419 | if note.title == title and note.extension == extension: 420 | raise NoteAlreadyExistsError( 421 | u"Note already in NoteBook: {0}".format(note.title)) 422 | 423 | # Ok, add the note. 424 | note = PlainTextNote(title, self, extension) 425 | self._notes.append(note) 426 | return note 427 | 428 | def __len__(self): 429 | return len(self._notes) 430 | 431 | def __getitem__(self, index): 432 | return self._notes[index] 433 | 434 | def __delitem__(self, index): 435 | raise NotImplementedError 436 | 437 | def __iter__(self): 438 | return self._notes.__iter__() 439 | 440 | def __reversed__(self): 441 | return self._notes.__reversed__() 442 | 443 | def __contains__(self, note): 444 | return (note in self._notes) 445 | -------------------------------------------------------------------------------- /terminal_velocity/urwid_ui.py: -------------------------------------------------------------------------------- 1 | """A console user interface for Terminal Velocity. 2 | 3 | Implemented using the console user interface library urwid. 4 | 5 | """ 6 | import subprocess 7 | import shlex 8 | import logging 9 | logger = logging.getLogger(__name__) 10 | 11 | import urwid 12 | import notebook 13 | 14 | 15 | palette = [ 16 | ("placeholder", "dark blue", "default"), 17 | ("notewidget unfocused", "default", "default"), 18 | ("notewidget focused", "black", "brown"), 19 | ("search", "default", "default"), 20 | ("autocomplete", "black", "brown"), 21 | ] 22 | 23 | 24 | def system(cmd, loop): 25 | """Execute a system command in a subshell and return the exit status.""" 26 | 27 | loop.screen.stop() 28 | 29 | cmd = u"{0}".format(cmd) 30 | cmd = cmd.encode("utf-8") # FIXME: Correct encoding? 31 | safe_cmd = shlex.split(cmd) 32 | 33 | logger.debug("System command: {0}".format(safe_cmd)) 34 | 35 | try: 36 | returncode = subprocess.check_call(safe_cmd) 37 | except Exception as e: 38 | logger.exception(e) 39 | raise e 40 | 41 | loop.screen.start() 42 | return returncode 43 | 44 | 45 | def placeholder_text(text): 46 | """Return a placeholder text widget with the given text.""" 47 | 48 | text_widget = urwid.Text(("placeholder", text), align="center") 49 | filler_widget = urwid.Filler(text_widget) 50 | return filler_widget 51 | 52 | 53 | # TODO: This widget will have to get smarter to implement note renaming. 54 | class NoteWidget(urwid.Text): 55 | 56 | def __init__(self, note): 57 | self.note = note 58 | return super(NoteWidget, self).__init__(note.title) 59 | 60 | def selectable(self): 61 | return True 62 | 63 | def keypress(self, size, key): 64 | return key 65 | 66 | # FIXME: Is this the best way to do this? 67 | # The point is that I want the "notewidget focused" and 68 | # "notewidget unfocused" display attributes to apply to notewidgets, but 69 | # I want to be able to just use NoteWidget objects directly and not have 70 | # to wrap them in AttrMap objects, because I want to be able to use 71 | # notewidget.note and not have to do notewidget.base_widget.note. 72 | def render(self, size, focus=False): 73 | """Render the widget applying focused and unfocused display attrs.""" 74 | 75 | if focus: 76 | attr_map = {None: "notewidget focused"} 77 | else: 78 | attr_map = {None: "notewidget unfocused"} 79 | canv = super(NoteWidget, self).render(size, focus=focus) 80 | canv = urwid.CompositeCanvas(canv) 81 | canv.fill_attr_apply(attr_map) 82 | return canv 83 | 84 | 85 | class AutocompleteWidget(urwid.Edit): 86 | """A text editing widget with autocomplete support. 87 | 88 | If you set the .autocomplete_text attribute, it will be shown to the user 89 | as an autocomplete suggestion. 90 | 91 | Also has a .fake_focus attribute that, if set to True, makes the widget 92 | look like it has the keyboard focus even when it doesn't. 93 | 94 | """ 95 | def __init__(self, *args, **kwargs): 96 | self.fake_focus = True 97 | self._autocomplete_text = None 98 | return super(AutocompleteWidget, self).__init__(*args, **kwargs) 99 | 100 | def get_autocomplete_text(self): 101 | return self._autocomplete_text 102 | 103 | def set_autocomplete_text(self, text): 104 | self._autocomplete_text = text 105 | self._invalidate() 106 | 107 | autocomplete_text = property(get_autocomplete_text, set_autocomplete_text) 108 | 109 | def render(self, size, focus=False): 110 | return super(AutocompleteWidget, self).render(size, self.fake_focus) 111 | 112 | def get_text(self): 113 | 114 | # When search bar is empty show placeholder text. 115 | if not self.edit_text and not self.autocomplete_text: 116 | placeholder_text = u"Find or Create" 117 | return (placeholder_text, 118 | [("placeholder", len(placeholder_text))]) 119 | 120 | # When no note is focused simply show typed text in search bar. 121 | if not self.autocomplete_text: 122 | return super(AutocompleteWidget, self).get_text() 123 | 124 | # When a note is focused show it's title in the search bar. 125 | is_substring = self.autocomplete_text.lower().startswith( 126 | self.edit_text.lower()) 127 | if self.edit_text and is_substring: 128 | # If the typed text is a substring of the focused note's title, 129 | # then show the typed text followed by the rest of the focused 130 | # note's title in a different colour. 131 | text_to_show = self.edit_text + self.autocomplete_text[ 132 | len(self.edit_text):] 133 | attrs = [("search", len(self.edit_text)), 134 | ("autocomplete", len(text_to_show) - len(self.edit_text))] 135 | return (text_to_show, attrs) 136 | else: 137 | # If the typed text is not a prefix of the focused note's title, 138 | # just show the focused note's title in the search bar. 139 | return (self.autocomplete_text, 140 | [('autocomplete', len(self.autocomplete_text))]) 141 | 142 | def consume(self): 143 | """Consume the autocomplete text, turning it into typed text.""" 144 | 145 | if self.autocomplete_text and ( 146 | len(self.edit_text) < len(self.autocomplete_text)): 147 | self.set_edit_text(self.autocomplete_text) 148 | self.move_cursor_to_coords((1,), len(self.autocomplete_text), 0) 149 | self.autocomplete_text = None 150 | return True 151 | else: 152 | return False 153 | 154 | 155 | class NoteFilterListBox(urwid.ListBox): 156 | """A filterable list of notes from a notebook.""" 157 | 158 | def __init__(self, on_changed=None): 159 | """Initialise a new NoteFilterListBox. 160 | 161 | Keyword arguments: 162 | on_changed -- callable that will be called when the focused note 163 | changes, the new focused note will be passed as argument 164 | 165 | """ 166 | self._fake_focus = False 167 | self.list_walker = urwid.SimpleFocusListWalker([]) 168 | self.widgets = {} # NoteWidget cache. 169 | super(NoteFilterListBox, self).__init__(self.list_walker) 170 | self.on_changed = on_changed 171 | 172 | def get_selected_note(self): 173 | return self.focus.note 174 | 175 | selected_note = property(get_selected_note) 176 | 177 | def get_fake_focus(self): 178 | return self._fake_focus 179 | 180 | def set_fake_focus(self, value): 181 | self._fake_focus = value 182 | self._invalidate() 183 | 184 | fake_focus = property(get_fake_focus, set_fake_focus) 185 | 186 | def render(self, size, focus=False): 187 | if len(self.list_walker) == 0: 188 | placeholder = placeholder_text(u"No matching notes, press Enter " 189 | "to create a new note") 190 | return placeholder.render(size) 191 | return super(NoteFilterListBox, self).render(size, self.fake_focus) 192 | 193 | def filter(self, matching_notes): 194 | """Filter this listbox to show only widgets for matching notes.""" 195 | 196 | # Get NoteWidgets for each of the matching Notes, retreive the 197 | # NoteWidgets from the NoteWidget cache if possible, if not create new 198 | # ones and add them to the cache. 199 | matching_widgets = [] 200 | for note in matching_notes: 201 | widget = self.widgets.get(note.abspath) 202 | if widget: 203 | matching_widgets.append(widget) 204 | else: 205 | widget = NoteWidget(note) 206 | self.widgets[note.abspath] = widget 207 | matching_widgets.append(widget) 208 | 209 | # Remove all widgets from the list walker. 210 | del self.list_walker[:] 211 | 212 | # Add all the matching widgets to the list walker, in order. 213 | for widget in matching_widgets: 214 | self.list_walker.append(widget) 215 | 216 | def focus_note(self, note): 217 | """Focus the widget for the given note.""" 218 | 219 | for widget in self.list_walker: 220 | if widget.note == note: 221 | self.list_walker.set_focus(self.list_walker.index(widget)) 222 | break 223 | 224 | def keypress(self, size, key): 225 | result = super(NoteFilterListBox, self).keypress(size, key) 226 | self.on_changed(self.selected_note) 227 | return result 228 | 229 | def mouse_event(self, size, event, button, col, row, focus): 230 | result = super(NoteFilterListBox, self).mouse_event( 231 | size, event, button, col, row, focus) 232 | self.on_changed(self.selected_note) 233 | return result 234 | 235 | 236 | class MainFrame(urwid.Frame): 237 | """The topmost urwid widget.""" 238 | 239 | def __init__(self, notes_dir, editor, extension, extensions, exclude=None): 240 | 241 | self.editor = editor 242 | self.notebook = notebook.PlainTextNoteBook(notes_dir, extension, 243 | extensions, exclude=exclude) 244 | 245 | # Don't filter the note list when the text in the search box changes. 246 | self.suppress_filter = False 247 | 248 | # Don't change the focused note when normally it would change 249 | # (e.g. when the text in the search box changes) 250 | self.suppress_focus = False 251 | 252 | self._selected_note = None 253 | 254 | self.search_box = AutocompleteWidget(wrap="clip") 255 | self.list_box = NoteFilterListBox(on_changed=self.on_list_box_changed) 256 | 257 | urwid.connect_signal(self.search_box, "change", 258 | self.on_search_box_changed) 259 | 260 | super(MainFrame, self).__init__( 261 | header=urwid.LineBox(self.search_box), 262 | body=None, 263 | focus_part="body") 264 | 265 | # Add all the notes to the listbox. 266 | self.filter(self.search_box.edit_text) 267 | 268 | def get_selected_note(self): 269 | return self._selected_note 270 | 271 | def set_selected_note(self, note): 272 | """Select the given note. 273 | 274 | Make the note appear focused in the list box, and the note's title 275 | autocompleted in the search box. 276 | 277 | """ 278 | if self.suppress_focus: 279 | return 280 | 281 | if note: 282 | 283 | self.search_box.autocomplete_text = note.title 284 | 285 | # Focus the list box so the focused note will look selected. 286 | self.list_box.fake_focus = True 287 | 288 | # Tell list box to focus the note. 289 | self.list_box.focus_note(note) 290 | 291 | else: 292 | 293 | self.search_box.autocomplete_text = None 294 | 295 | # Unfocus the listbox so no list item widget will look selected. 296 | self.list_box.fake_focus = False 297 | 298 | self._selected_note = note 299 | 300 | selected_note = property(get_selected_note, set_selected_note) 301 | 302 | def quit(self): 303 | """Quit the app.""" 304 | 305 | raise urwid.ExitMainLoop() 306 | 307 | def keypress(self, size, key): 308 | 309 | maxcol, maxrow = size 310 | 311 | self.suppress_filter = False 312 | self.suppress_focus = False 313 | 314 | if key in ["esc", "ctrl d"]: 315 | if self.selected_note: 316 | # Clear the selected note. 317 | self.selected_note = None 318 | return None 319 | elif self.search_box.edit_text: 320 | self.search_box.set_edit_text("") 321 | return None 322 | 323 | elif key in ["enter"]: 324 | if self.selected_note: 325 | system(self.editor + " '" + self.selected_note.abspath + "'", self.loop) 326 | else: 327 | if self.search_box.edit_text: 328 | try: 329 | note = self.notebook.add_new(self.search_box.edit_text) 330 | system(self.editor + " '" + note.abspath + "'", self.loop) 331 | except notebook.NoteAlreadyExistsError: 332 | # Try to open the existing note instead. 333 | system(self.editor + " '" + self.search_box.edit_text + 334 | self.notebook.extension + "'", 335 | self.loop) 336 | except notebook.InvalidNoteTitleError: 337 | # TODO: Display error message to user. 338 | pass 339 | else: 340 | # Hitting Enter with no note selected and no text typed in 341 | # search box does nothing. 342 | pass 343 | self.suppress_focus = True 344 | self.filter(self.search_box.edit_text) 345 | return None 346 | 347 | elif key in ["ctrl x"]: 348 | self.quit() 349 | 350 | elif self.selected_note and key in ["tab", "left", "right"]: 351 | if self.search_box.consume(): 352 | return None 353 | else: 354 | return self.search_box.keypress((maxcol,), key) 355 | 356 | elif key in ["down"]: 357 | if not self.list_box.fake_focus: 358 | # If no note is focused make pressing down focus the first 359 | # note (not the second, as it would do if we just passed this 360 | # keypress straight to the list box). 361 | self.list_box.fake_focus = True 362 | self.on_list_box_changed(self.list_box.selected_note) 363 | return None 364 | else: 365 | return self.list_box.keypress(size, key) 366 | 367 | elif key in ["up", "page up", "page down"]: 368 | return self.list_box.keypress(size, key) 369 | 370 | elif key in ["backspace"]: 371 | consume = False 372 | if self.selected_note: 373 | if self.search_box.edit_text == "": 374 | consume = True 375 | else: 376 | title = self.selected_note.title.lower() 377 | typed = self.search_box.edit_text.lower() 378 | if not title.startswith(typed): 379 | consume = True 380 | if consume: 381 | self.search_box.consume() 382 | else: 383 | self.selected_note = None 384 | self.suppress_focus = True 385 | return self.search_box.keypress((maxcol,), key) 386 | 387 | else: 388 | return self.search_box.keypress((maxcol,), key) 389 | 390 | def filter(self, query): 391 | """Do the synchronised list box filter and search box autocomplete. 392 | 393 | """ 394 | if self.suppress_filter: 395 | return 396 | 397 | # If the user has no notes yet show some placeholder text, otherwise 398 | # show the note list. 399 | if len(self.notebook) == 0: 400 | self.body = placeholder_text(u"You have no notes yet, to create " 401 | "a note type a note title then press Enter") 402 | else: 403 | self.body = urwid.Padding(self.list_box, left=1, right=1) 404 | 405 | # Find all notes that match the typed text. 406 | matching_notes = self.notebook.search(query) 407 | 408 | # Sort the notes. 409 | # TODO: Support different sort orderings. 410 | matching_notes.sort(key=lambda x: x.mtime, reverse=True) 411 | 412 | # Tell the list box to show only the matching notes. 413 | self.list_box.filter(matching_notes) 414 | 415 | # Find the notes whose title begins with the typed text. 416 | autocompletable_matches = [] 417 | if query: 418 | for note in matching_notes: 419 | if note.title.lower().startswith(query.lower()): 420 | autocompletable_matches.append(note) 421 | 422 | # Select the first autocompletable note. 423 | if autocompletable_matches: 424 | self.selected_note = autocompletable_matches[0] 425 | else: 426 | self.selected_note = None 427 | 428 | def on_search_box_changed(self, edit, new_edit_text): 429 | self.filter(new_edit_text) 430 | 431 | def on_list_box_changed(self, note): 432 | self.selected_note = note 433 | 434 | 435 | def launch(notes_dir, editor, extension, extensions, exclude=None): 436 | """Launch the user interface.""" 437 | 438 | frame = MainFrame(notes_dir, editor, extension, extensions, exclude=exclude) 439 | loop = urwid.MainLoop(frame, palette) 440 | frame.loop = loop 441 | loop.run() 442 | 443 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 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 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------