├── vgapplet ├── __init__.py ├── test │ ├── __init__.py │ ├── test_resource.py │ ├── test_autoupdate.py │ ├── test_appindicator.py │ ├── test_ui.py │ ├── samples.py │ └── test_machineindex.py ├── resource.py ├── config.py ├── autoupdate.py ├── ui.py ├── vagrantcontrol.py ├── machineindex.py └── indicator.py ├── .gitignore ├── bin └── vgapplet ├── vgapplet.desktop ├── img ├── light │ ├── icon-0.svg │ ├── icon-1.svg │ ├── icon-2.svg │ ├── icon-3.svg │ ├── poweroff.svg │ ├── running.svg │ └── unknown.svg └── dark │ ├── icon-0.svg │ ├── icon-1.svg │ ├── icon-2.svg │ ├── icon-3.svg │ ├── poweroff.svg │ ├── running.svg │ └── unknown.svg ├── Makefile ├── README ├── setup.py ├── README.md └── COPYING /vgapplet/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /vgapplet/test/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | __pycache__/ 3 | 4 | coverage/ 5 | .coverage 6 | 7 | .venv/ 8 | .venv3/ 9 | 10 | dist/ 11 | MANIFEST 12 | vagrantappindicator.egg-info/ 13 | 14 | .idea/ 15 | -------------------------------------------------------------------------------- /bin/vgapplet: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | import sys 4 | from os.path import abspath, dirname, join 5 | 6 | try: 7 | import vgapplet 8 | except ImportError: 9 | sys.path.append(abspath(join(dirname(__file__), '..'))) 10 | 11 | from vgapplet import indicator 12 | indicator.main() 13 | -------------------------------------------------------------------------------- /vgapplet.desktop: -------------------------------------------------------------------------------- 1 | [Desktop Entry] 2 | Version=1.0 3 | Name=Vagrant Application Indicator 4 | Comment=View state of all VMs managed by Vagrant and operate them 5 | Exec=vgapplet 6 | Icon=/usr/share/vgapplet/img/light/icon-0.svg 7 | Type=Application 8 | Terminal=false 9 | Categories=GNOME;GTK;Utility; 10 | -------------------------------------------------------------------------------- /img/light/icon-0.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | 8 | 9 | -------------------------------------------------------------------------------- /vgapplet/test/test_resource.py: -------------------------------------------------------------------------------- 1 | # Copyright 2014, candidtim (https://github.com/candidtim) 2 | # 3 | # This file is part of Vagrant AppIndicator for Ubuntu. 4 | # 5 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by the Free Software 7 | # Foundation, either version 3 of the License, or (at your option) any later version. 8 | # 9 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 10 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 11 | # See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with Foobar. 14 | # If not, see . 15 | 16 | 17 | import unittest 18 | 19 | from vgapplet import resource 20 | 21 | 22 | class TestResource(unittest.TestCase): 23 | def test_image_path(self): 24 | image_path = resource.image_path("sample", "theme") 25 | self.assertTrue(image_path.endswith("img/theme/sample.svg")) 26 | 27 | 28 | if __name__ == "__main__": 29 | unittest.main() 30 | -------------------------------------------------------------------------------- /vgapplet/test/test_autoupdate.py: -------------------------------------------------------------------------------- 1 | # Copyright 2014, candidtim (https://github.com/candidtim) 2 | # 3 | # This file is part of Vagrant AppIndicator for Ubuntu. 4 | # 5 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by the Free Software 7 | # Foundation, either version 3 of the License, or (at your option) any later version. 8 | # 9 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 10 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 11 | # See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with Foobar. 14 | # If not, see . 15 | 16 | import unittest 17 | 18 | from vgapplet import autoupdate 19 | 20 | 21 | class TestAppIndicator(unittest.TestCase): 22 | def test_get_latest_version(self): 23 | # this test assumes that all versions are tagged with tags starting with V 24 | version = autoupdate._latest_version() 25 | self.assertTrue(type(u'') == type(version)) 26 | self.assertTrue(version.startswith('v')) 27 | 28 | 29 | if __name__ == "__main__": 30 | unittest.main() 31 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | all: clean venv test sdist 2 | 3 | clean: 4 | find vgapplet -type f -name *.pyc | xargs rm -rf 5 | find vgapplet -type d -name __pycache__ | xargs rm -rf 6 | rm -rf coverage 7 | rm -f .coverage 8 | rm -rf dist 9 | rm -f MANIFEST 10 | rm -rf vagrantappindicator.egg-info/ 11 | rm -rf /tmp/.vagrant.d/data/machine-index 12 | rm -f ~/.vgapplet 13 | 14 | venv2: 15 | rm -rf ./.venv/ 16 | virtualenv --python=python2.7 --system-site-packages .venv 17 | .venv/bin/pip install nose==1.3.3 coverage==3.7.1 mock==1.0.1 18 | 19 | venv3: 20 | rm -rf ./.venv3/ 21 | virtualenv --python=python3 --system-site-packages .venv3 22 | .venv3/bin/pip install nose==1.3.3 coverage==3.7.1 mock==1.0.1 23 | 24 | venv: venv2 venv3 25 | 26 | test2: 27 | export VAGRANT_HOME=/tmp/.vagrant.d; .venv/bin/nosetests 28 | 29 | test3: 30 | export VAGRANT_HOME=/tmp/.vagrant.d; .venv3/bin/nosetests 31 | 32 | test: test2 test3 33 | 34 | cover: 35 | export VAGRANT_HOME=/tmp/.vagrant.d; .venv3/bin/nosetests --with-coverage --cover-branches --cover-package=vgapplet --cover-html --cover-html-dir=coverage 36 | 37 | run: 38 | bin/vgapplet 39 | 40 | sdist2: clean 41 | python2.7 setup.py sdist 42 | 43 | sdist3: clean 44 | python3 setup.py sdist 45 | 46 | sdist: sdist2 sdist3 47 | 48 | install: sdist2 49 | pip install dist/vagrantappindicator-*.tar.gz 50 | rm -rf dist 51 | 52 | uninstall: 53 | pip uninstall vagrantappindicator 54 | -------------------------------------------------------------------------------- /vgapplet/resource.py: -------------------------------------------------------------------------------- 1 | # Copyright 2014, candidtim (https://github.com/candidtim) 2 | # 3 | # This file is part of Vagrant AppIndicator for Ubuntu. 4 | # 5 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by the Free Software 7 | # Foundation, either version 3 of the License, or (at your option) any later version. 8 | # 9 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 10 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 11 | # See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with Foobar. 14 | # If not, see . 15 | 16 | 17 | from os.path import join, dirname, isfile 18 | 19 | 20 | RESOURCES_DIRECTORY_PATH = "/usr/share/vgapplet" 21 | 22 | # when running vgapplet directly from sources - use resources from source code 23 | __RELATIVE_RESOURCE_PATH = join(dirname(dirname(__file__))) 24 | __CURRENT_RESOURCES_PATH = \ 25 | __RELATIVE_RESOURCE_PATH \ 26 | if isfile(join(__RELATIVE_RESOURCE_PATH, "bin", "vgapplet")) else \ 27 | RESOURCES_DIRECTORY_PATH 28 | 29 | 30 | def image_path(name, theme): 31 | """Returns path to the image file by its name, in given theme library""" 32 | return join(__CURRENT_RESOURCES_PATH, "img", theme, "%s.svg" % name) 33 | -------------------------------------------------------------------------------- /vgapplet/config.py: -------------------------------------------------------------------------------- 1 | # Copyright 2014, candidtim (https://github.com/candidtim) 2 | # 3 | # This file is part of Vagrant AppIndicator for Ubuntu. 4 | # 5 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by the Free Software 7 | # Foundation, either version 3 of the License, or (at your option) any later version. 8 | # 9 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 10 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 11 | # See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with Foobar. 14 | # If not, see . 15 | 16 | import os 17 | import json 18 | 19 | 20 | __CONFIG_FILE_PATH = os.path.expanduser("~/.vgapplet") 21 | 22 | 23 | show_notifications = True 24 | check_for_updates = True 25 | 26 | 27 | def __load(): 28 | if not os.path.isfile(__CONFIG_FILE_PATH): return 29 | 30 | global show_notifications 31 | global check_for_updates 32 | 33 | with open(__CONFIG_FILE_PATH, 'r') as config_file: 34 | config_dict = json.load(config_file) 35 | show_notifications = config_dict.get("show_notifications", True) 36 | check_for_updates = config_dict.get("check_for_updates", True) 37 | 38 | 39 | def persist(): 40 | config_dict = { 41 | "show_notifications": show_notifications, 42 | "check_for_updates": check_for_updates 43 | } 44 | with open(__CONFIG_FILE_PATH, 'w') as config_file: 45 | json.dump(config_dict, config_file) 46 | 47 | 48 | __load() 49 | -------------------------------------------------------------------------------- /vgapplet/test/test_appindicator.py: -------------------------------------------------------------------------------- 1 | # Copyright 2014, candidtim (https://github.com/candidtim) 2 | # 3 | # This file is part of Vagrant AppIndicator for Ubuntu. 4 | # 5 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by the Free Software 7 | # Foundation, either version 3 of the License, or (at your option) any later version. 8 | # 9 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 10 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 11 | # See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with Foobar. 14 | # If not, see . 15 | 16 | import unittest 17 | import mock 18 | 19 | from vgapplet import ui 20 | from vgapplet import indicator 21 | from vgapplet import machineindex 22 | 23 | from . import samples 24 | 25 | 26 | class TestAppIndicator(unittest.TestCase): 27 | def test_icon_choice(self): 28 | stopped = machineindex.Machine(None, "stopped", None, None) 29 | running = machineindex.Machine(None, "running", None, None) 30 | self.assertEquals("icon-0", indicator.VagrantAppIndicator._icon_name([stopped]*3)) 31 | self.assertEquals("icon-1", indicator.VagrantAppIndicator._icon_name([running]*1)) 32 | self.assertEquals("icon-2", indicator.VagrantAppIndicator._icon_name([running]*2)) 33 | self.assertEquals("icon-3", indicator.VagrantAppIndicator._icon_name([running]*3)) 34 | self.assertEquals("icon-3", indicator.VagrantAppIndicator._icon_name([running]*4)) 35 | 36 | 37 | if __name__ == "__main__": 38 | unittest.main() 39 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | Vagrant Application Indicator for Ubuntu 2 | ======================================== 3 | 4 | Application Indicator to display *last known* state of Vagrant-managed 5 | VMs in the notification area (system tray) on Ubuntu Unity and in Gnome. 6 | 7 | Main features: 8 | 9 | - displays last known state of VMs 10 | - allows opening Terminal in the VM home directory from the indicator 11 | menu 12 | - allows bringing VMs up, halting them and destroying them via an 13 | indicator menu 14 | 15 | Changelog 16 | ========= 17 | 18 | 1.2.0 19 | ----- 20 | 21 | - Added "Help & About" menu item 22 | - Added update check on startup 23 | 24 | 1.1.1 25 | ----- 26 | 27 | - Fixed desktop icon (was: no icon in v1.1.0) 28 | 29 | 1.1.0 30 | ----- 31 | 32 | - Added specific icons when machines are running 33 | 34 | 1.0.0 35 | ----- 36 | 37 | - Initial release 38 | 39 | 40 | Contributing 41 | ============ 42 | 43 | See 44 | `Vagrant AppIndicator on GitHub `__ 45 | 46 | 47 | Copying 48 | ======= 49 | 50 | Copyright 2014, `candidtim `__ 51 | 52 | This Application Indicator is distributed under `GNU GENERAL PUBLIC 53 | LICENSE `__, either version 3 of 54 | the License, or (at your option) any later version. 55 | 56 | .. figure:: http://www.gnu.org/graphics/gplv3-88x31.png 57 | :alt: GPLv3 58 | GPLv3 59 | 60 | This copyright or licensing doesn't apply to the icons used in the 61 | AppIndicator. See Attributions below. 62 | 63 | 64 | Attributions 65 | ============ 66 | 67 | Main AppIndicator icon was originally distributed under `CC BY 68 | 3.0 license `__. 69 | Icon made by Picol from `www.flaticon.com `__ 70 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | # Copyright 2014, candidtim (https://github.com/candidtim) 4 | # 5 | # This file is part of Vagrant AppIndicator for Ubuntu. 6 | # 7 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by the Free Software 9 | # Foundation, either version 3 of the License, or (at your option) any later version. 10 | # 11 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 12 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 13 | # See the GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License along with Foobar. 16 | # If not, see . 17 | 18 | 19 | import os 20 | from distutils.core import setup 21 | 22 | from vgapplet.resource import RESOURCES_DIRECTORY_PATH 23 | 24 | 25 | def find_resources(resource_dir): 26 | target_path = os.path.join(RESOURCES_DIRECTORY_PATH, resource_dir) 27 | resource_names = os.listdir(resource_dir) 28 | resource_list = [os.path.join(resource_dir, file_name) for file_name in resource_names] 29 | return (target_path, resource_list) 30 | 31 | 32 | setup(name="vagrantappindicator", 33 | version="1.4.0", 34 | description="Vagrant Application Indicator for Ubuntu", 35 | url='https://github.com/candidtim/vagrant-appindicator', 36 | author='candidtim', 37 | author_email='timcandid@gmail.com', 38 | license='GPL', 39 | packages=["vgapplet"], 40 | data_files=[ 41 | ('/usr/share/applications', ['vgapplet.desktop']), 42 | find_resources("img/light"), 43 | find_resources("img/dark")], 44 | scripts=["bin/vgapplet"] 45 | ) 46 | -------------------------------------------------------------------------------- /vgapplet/autoupdate.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | # Copyright 2014, candidtim (https://github.com/candidtim) 4 | # 5 | # This file is part of Vagrant AppIndicator for Ubuntu. 6 | # 7 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by the Free Software 9 | # Foundation, either version 3 of the License, or (at your option) any later version. 10 | # 11 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 12 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 13 | # See the GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License along with Foobar. 16 | # If not, see . 17 | 18 | import json 19 | import pkg_resources 20 | 21 | try: 22 | from urllib2 import urlopen 23 | except ImportError: 24 | from urllib.request import urlopen 25 | 26 | 27 | def is_update_available(): 28 | current_version = _current_version() 29 | latest_version = _latest_version() 30 | return current_version is not None \ 31 | and latest_version is not None \ 32 | and current_version != latest_version 33 | 34 | 35 | def _current_version(): 36 | try: 37 | version = u'v%s' % pkg_resources.get_distribution("vagrantappindicator").version 38 | except pkg_resources.DistributionNotFound: 39 | version = None 40 | return version 41 | 42 | 43 | def _latest_version(): 44 | try: 45 | response = urlopen('https://api.github.com/repos/candidtim/vagrant-appindicator/tags') 46 | raw_json = response.read().decode('ascii') 47 | tags = json.loads(raw_json) 48 | latest_version = [tag['name'] for tag in tags][0] 49 | except: 50 | latest_version = None 51 | return latest_version 52 | -------------------------------------------------------------------------------- /vgapplet/test/test_ui.py: -------------------------------------------------------------------------------- 1 | # Copyright 2014, candidtim (https://github.com/candidtim) 2 | # 3 | # This file is part of Vagrant AppIndicator for Ubuntu. 4 | # 5 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by the Free Software 7 | # Foundation, either version 3 of the License, or (at your option) any later version. 8 | # 9 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 10 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 11 | # See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with Foobar. 14 | # If not, see . 15 | 16 | import unittest 17 | import mock 18 | 19 | from vgapplet import ui 20 | from vgapplet import indicator 21 | from vgapplet import machineindex 22 | 23 | from . import samples 24 | 25 | 26 | class TestUi(unittest.TestCase): 27 | def test_luminance(self): 28 | self.assertEqual(ui._luminance(0,0,0), 0.0) 29 | self.assertEqual(ui._luminance(65000,65000,65000,65000), 1.0) 30 | self.assertEqual(ui._luminance(128,128,128), 0.5) 31 | 32 | def test_notifications(self): 33 | with samples.SampleIndex() as sample_index, samples.SampleGtkEnvironment() as gtk_env: 34 | app_indicator = indicator.VagrantAppIndicator() 35 | app_indicator._show_notification = mock.Mock() 36 | machineindex.get_machineindex = mock.Mock(return_value=[]) 37 | sample_index.touch() 38 | gtk_env.wait_for(lambda: app_indicator._show_notification.called) 39 | self.assertEqual(app_indicator._show_notification.call_count, 1) 40 | app_indicator._shutdown() 41 | 42 | 43 | if __name__ == "__main__": 44 | unittest.main() 45 | -------------------------------------------------------------------------------- /img/dark/icon-0.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | image/svg+xml -------------------------------------------------------------------------------- /img/light/icon-1.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | image/svg+xml -------------------------------------------------------------------------------- /img/dark/icon-1.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | image/svg+xml -------------------------------------------------------------------------------- /vgapplet/ui.py: -------------------------------------------------------------------------------- 1 | # Copyright 2014, candidtim (https://github.com/candidtim) 2 | # 3 | # This file is part of Vagrant AppIndicator for Ubuntu. 4 | # 5 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by the Free Software 7 | # Foundation, either version 3 of the License, or (at your option) any later version. 8 | # 9 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 10 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 11 | # See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with Foobar. 14 | # If not, see . 15 | 16 | 17 | import gi 18 | gi.require_version('Gdk', '3.0') 19 | from gi.repository import Gdk as gdk 20 | 21 | 22 | THEME_DARK = "dark" 23 | THEME_LIGHT = "light" 24 | 25 | 26 | def _luminance(r, g, b, base=256): 27 | """Calculates luminance of a color, on a scale from 0 to 1, meaning that 1 is the highest luminance. 28 | r, g, b arguments values should be in 0..256 limits, or base argument should define the upper limit otherwise""" 29 | return (0.2126*r + 0.7152*g + 0.0722*b)/base 30 | 31 | 32 | def __pixel_at(x, y): 33 | """Returns (r, g, b) color code for a pixel with given coordinates (each value is in 0..256 limits)""" 34 | root_window = gdk.get_default_root_window() 35 | buf = gdk.pixbuf_get_from_window(root_window, x, y, 1, 1) 36 | pixels = buf.get_pixels() 37 | if type(pixels) == type(""): 38 | rgb = tuple([int(byte.encode('hex'), 16) for byte in pixels]) 39 | else: 40 | rgb = tuple(pixels) 41 | return rgb 42 | 43 | 44 | def _get_theme(): 45 | """Returns one of THEME_LIGHT or THEME_DARK, corresponding to current user's UI theme""" 46 | # getting color of a pixel on a top bar, and identifying best-fitting color theme based on its luminance 47 | pixel_rgb = __pixel_at(2, 2) 48 | luminance = _luminance(*pixel_rgb) 49 | return THEME_LIGHT if luminance >= 0.5 else THEME_DARK 50 | 51 | 52 | THEME = _get_theme() 53 | -------------------------------------------------------------------------------- /img/light/icon-2.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | image/svg+xml -------------------------------------------------------------------------------- /img/dark/icon-2.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | image/svg+xml -------------------------------------------------------------------------------- /vgapplet/vagrantcontrol.py: -------------------------------------------------------------------------------- 1 | # Copyright 2014, candidtim (https://github.com/candidtim) 2 | # 3 | # This file is part of Vagrant AppIndicator for Ubuntu. 4 | # 5 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by the Free Software 7 | # Foundation, either version 3 of the License, or (at your option) any later version. 8 | # 9 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 10 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 11 | # See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with Foobar. 14 | # If not, see . 15 | 16 | 17 | import os 18 | import pwd 19 | import getpass 20 | import subprocess 21 | 22 | 23 | def open_terminal(machine): 24 | """Simply opens new terminal window in the working directory of a given machine""" 25 | subprocess.Popen(["x-terminal-emulator"], cwd=machine.directory) 26 | 27 | 28 | def start(machine): 29 | __term("vagrant up %s" % machine.name, machine.directory) 30 | 31 | 32 | def start_and_provision(machine): 33 | __term("vagrant up --provision %s" % machine.name, machine.directory) 34 | 35 | 36 | def resume(machine): 37 | __term("vagrant resume %s" % machine.name, machine.directory) 38 | 39 | 40 | def suspend(machine): 41 | __term("vagrant suspend %s" % machine.name, machine.directory) 42 | 43 | 44 | def ssh(machine): 45 | __term("vagrant ssh %s" % machine.name, machine.directory) 46 | 47 | 48 | def halt(machine): 49 | __term("vagrant halt %s" % machine.name, machine.directory) 50 | 51 | 52 | def provision(machine): 53 | __term("vagrant provision %s" % machine.name, machine.directory) 54 | 55 | 56 | def destroy(machine): 57 | __term("vagrant destroy --force %s" % machine.name, machine.directory) 58 | 59 | 60 | def __term(command, cwd): 61 | """Starts new terminal, executes given command in it and falls back to user's default shell after its completion""" 62 | subprocess.Popen(['x-terminal-emulator', '-e', 'bash -c "%s; exec %s"' % (command, __user_shell())], 63 | cwd=os.path.abspath(cwd)) 64 | 65 | def __user_shell(): 66 | return pwd.getpwnam(getpass.getuser()).pw_shell 67 | -------------------------------------------------------------------------------- /img/light/icon-3.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | image/svg+xml -------------------------------------------------------------------------------- /img/dark/icon-3.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | image/svg+xml -------------------------------------------------------------------------------- /img/dark/poweroff.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 18 | 20 | 39 | 41 | 42 | 44 | image/svg+xml 45 | 47 | 48 | 49 | 50 | 51 | 55 | 66 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /img/dark/running.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 18 | 20 | 39 | 41 | 42 | 44 | image/svg+xml 45 | 47 | 48 | 49 | 50 | 51 | 55 | 66 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /img/dark/unknown.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 18 | 20 | 39 | 41 | 42 | 44 | image/svg+xml 45 | 47 | 48 | 49 | 50 | 51 | 55 | 66 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /img/light/poweroff.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 18 | 20 | 39 | 41 | 42 | 44 | image/svg+xml 45 | 47 | 48 | 49 | 50 | 51 | 55 | 66 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /img/light/running.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 18 | 20 | 39 | 41 | 42 | 44 | image/svg+xml 45 | 47 | 48 | 49 | 50 | 51 | 55 | 66 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /img/light/unknown.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 18 | 20 | 39 | 41 | 42 | 44 | image/svg+xml 45 | 47 | 48 | 49 | 50 | 51 | 55 | 66 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /vgapplet/test/samples.py: -------------------------------------------------------------------------------- 1 | # Copyright 2014, candidtim (https://github.com/candidtim) 2 | # 3 | # This file is part of Vagrant AppIndicator for Ubuntu. 4 | # 5 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by the Free Software 7 | # Foundation, either version 3 of the License, or (at your option) any later version. 8 | # 9 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 10 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 11 | # See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with Foobar. 14 | # If not, see . 15 | 16 | 17 | import os 18 | import time 19 | import threading 20 | 21 | from gi.repository import Gtk as gtk 22 | 23 | 24 | MACHINEINDEX_SAMPLE = u""" 25 | { 26 | "version":1, 27 | "machines":{ 28 | "abcdef1234567890":{ 29 | "local_data_path":"/home/user/vagrant/vm1/.vagrant", 30 | "name":"default", 31 | "provider":"virtualbox", 32 | "state":"running", 33 | "vagrantfile_name":null, 34 | "vagrantfile_path":"/home/user/vagrant/vm1", 35 | "updated_at":null, 36 | "extra_data":{ 37 | "box":{ 38 | "name":"hashicorp/precise64", 39 | "provider":"virtualbox", 40 | "version":"1.1.0" 41 | } 42 | } 43 | } 44 | } 45 | } 46 | """ 47 | 48 | SAMPLE_MACHINE_ID = "abcdef1234567890" 49 | SAMPLE_MACHINE_STATE = "running" 50 | SAMPLE_MACHINE_DIRECTORY = "/home/user/vagrant/vm1" 51 | SAMPLE_MACHINE_NAME = "default" 52 | 53 | SAMPLE_INDEX_DIR = "/tmp/.vagrant.d/data/machine-index" 54 | SAMPLE_INDEX_FILE = SAMPLE_INDEX_DIR + "/index" 55 | 56 | _TEST_WAIT_TIMEOUT = 10 # seconds 57 | 58 | 59 | class SampleIndex(object): 60 | def __enter__(self): 61 | os.makedirs(SAMPLE_INDEX_DIR) 62 | with open(SAMPLE_INDEX_FILE, 'w') as sample_index: 63 | sample_index.write(MACHINEINDEX_SAMPLE) 64 | return self 65 | 66 | def touch(self): 67 | with open(SAMPLE_INDEX_FILE, 'a') as sample_index: 68 | sample_index.write("\n") 69 | 70 | def __exit__(self, type, value, traceback): 71 | os.remove(SAMPLE_INDEX_FILE) 72 | os.removedirs(SAMPLE_INDEX_DIR) 73 | 74 | 75 | class SampleGtkEnvironment(object): 76 | '''Provides active Gtk environment to run tests in''' 77 | def __enter__(self): 78 | return self 79 | 80 | def wait_for(self, predicate): 81 | '''Runs Gtk main loop until the predicate function returns true''' 82 | start = time.time() 83 | while not predicate() and time.time() - start < _TEST_WAIT_TIMEOUT: 84 | gtk.main_iteration_do(blocking=False) 85 | if time.time() - start >= _TEST_WAIT_TIMEOUT: 86 | raise AssertionError("Timeout reached while waiting for predicate to become True") 87 | 88 | def __exit__(self, type, value, traceback): 89 | pass 90 | -------------------------------------------------------------------------------- /vgapplet/test/test_machineindex.py: -------------------------------------------------------------------------------- 1 | # Copyright 2014, candidtim (https://github.com/candidtim) 2 | # 3 | # This file is part of Vagrant AppIndicator for Ubuntu. 4 | # 5 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by the Free Software 7 | # Foundation, either version 3 of the License, or (at your option) any later version. 8 | # 9 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 10 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 11 | # See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with Foobar. 14 | # If not, see . 15 | 16 | 17 | import io 18 | import unittest 19 | 20 | from vgapplet import machineindex 21 | 22 | from . import samples 23 | 24 | 25 | class TestMachineIndex(unittest.TestCase): 26 | def test_parser(self): 27 | sample_string_io = io.StringIO(samples.MACHINEINDEX_SAMPLE) 28 | machines = machineindex._parse_machineindex(sample_string_io) 29 | self.assertEqual(len(machines), 1) 30 | machine = machines[0] 31 | self.assertEqual(machine.id, samples.SAMPLE_MACHINE_ID) 32 | self.assertEqual(machine.state, samples.SAMPLE_MACHINE_STATE) 33 | self.assertEqual(machine.directory, samples.SAMPLE_MACHINE_DIRECTORY) 34 | self.assertEqual(machine.name, samples.SAMPLE_MACHINE_NAME) 35 | 36 | 37 | def test_diff(self): 38 | m1 = machineindex.Machine("1", "running", "/home/vm1", "default") 39 | m2 = machineindex.Machine("2", "running", "/home/vm2", "default") 40 | m2_changed = machineindex.Machine("2", "poweroff", "/home/vm2", "default") 41 | m3 = machineindex.Machine("3", "poweroff", "/home/vm3", "default") 42 | m4 = machineindex.Machine("4", "poweroff", "/home/vm4", "default") 43 | 44 | old_machineindex = [m2, m3, m4] 45 | new_machineindex = [m1, m2_changed, m3] 46 | 47 | diff = machineindex.diff_machineindexes(new_machineindex, old_machineindex) 48 | 49 | self.assertEqual(len(diff), 3) 50 | 51 | new_machines = diff[0] 52 | removed_machines = diff[1] 53 | changed_machines = diff[2] 54 | 55 | self.assertEqual(len(new_machines), 1) 56 | self.assertEqual(new_machines[0], m1) 57 | 58 | self.assertEqual(len(removed_machines), 1) 59 | self.assertEqual(removed_machines[0], m4) 60 | 61 | self.assertEqual(len(changed_machines), 1) 62 | self.assertEqual(changed_machines[0], m2_changed) 63 | self.assertEqual(changed_machines[0].state, m2_changed.state) 64 | 65 | 66 | def test_resolve_machineindex(self): 67 | with samples.SampleIndex(): 68 | machineindex_path = machineindex._resolve_machineindex_path() 69 | self.assertEqual(machineindex_path, samples.SAMPLE_INDEX_FILE) 70 | 71 | 72 | def test_resolve_machineindex_failure(self): 73 | self.assertRaises(Exception, machineindex._resolve_machineindex_path) 74 | 75 | 76 | def test_get_machineindex(self): 77 | with samples.SampleIndex(): 78 | machines = machineindex.get_machineindex() 79 | self.assertEqual(len(machines), 1) 80 | 81 | 82 | def test_subscribe(self): 83 | new_machines = [] 84 | def change_listener(machines): 85 | new_machines.append(machines) 86 | 87 | with samples.SampleIndex() as sample_index, samples.SampleGtkEnvironment() as gtk_env: 88 | machineindex.subscribe(change_listener) 89 | sample_index.touch() 90 | gtk_env.wait_for(lambda: len(new_machines) > 0) 91 | self.assertEqual(new_machines[0][0].id, samples.SAMPLE_MACHINE_ID) 92 | machineindex.unsubscribe_all() 93 | 94 | 95 | if __name__ == "__main__": 96 | unittest.main() 97 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Vagrant Application Indicator for Ubuntu Unity / Gnome 2 | 3 | Application Indicator to display *last known* state of Vagrant-managed VMs in the 4 | notification area (system tray) on Ubuntu Unity and in Gnome. 5 | 6 | Main features: 7 | 8 | - displays last known ("current") state of VMs 9 | - optionally, shows notifications when machines state changes 10 | - allows opening Terminal in the VM home directory from the indicator menu 11 | - allows bringing VMs up, halting them and destroying them via an indicator menu 12 | 13 | ![alt tag](https://raw.githubusercontent.com/candidtim/vagrant-appindicator/gh-pages/img/vgapplet-screenshot.png) 14 | 15 | # Usage 16 | 17 | **Install**: 18 | 19 | $ sudo pip install git+https://github.com/candidtim/vagrant-appindicator.git 20 | 21 | **Update** 22 | 23 | Vagrant AppIndicator will notify you automatically if a newer version is available (provided that there is an access to 24 | the internet). To update, run again same command as for install. 25 | 26 | Update checker can be deactivated in the AppIndicator menu, if necessary. 27 | 28 | **Run** 29 | 30 | To run Vagrant AppIndicator, start it from Unity Dash or Gnome Desktop Menu (whichever 31 | desktop you use). 32 | 33 | **Few more details, if you want** 34 | 35 | Install process will install the indicator directly from the source code on GitHub. 36 | `pip` basically clones the repo and builds and installs everything locally. One can as 37 | well do all that manually (why though?) - see below if you're interested. 38 | 39 | Just in case, you can as well run Vagrant AppIndicator from command line: use `vgapplet` 40 | or, `nohup vgapplet &`. 41 | 42 | To uninstall Vagrant AppIndicator and all files accompanying it, run 43 | `sudo pip uninstall vagrantappindicator`. 44 | 45 | 46 | # Development 47 | 48 | ## Project directory layout 49 | 50 | - `bin/` - entry point scripts 51 | - `img/` - image files used in runtime (icons) 52 | - `vgapplet/` - root application package (all source code) 53 | - `**/test/` - test packages 54 | - `Makefile` - provides basic tasks to run tests, run appindicator, etc. 55 | - `setup.py` - python packaging script 56 | - `README` - readme file for distributed pacakge 57 | - `README.md` - this file 58 | 59 | ## Python 2 and Python 3 60 | 61 | Current indicator implementation runs on both Python 2.7 and Python 3. All 62 | tests are as well executed on "both pythons". 63 | 64 | ## Running and testing 65 | 66 | **Running tests** 67 | 68 | $ make venv # run only once, or run again to re-create the virtualenv 69 | $ make tests 70 | 71 | **Getting test coverage (reports to ./coverage/)** 72 | 73 | $ make cover 74 | 75 | **Creating python source package** 76 | 77 | $ make sdist 78 | 79 | **Running appindicator without installing it** 80 | 81 | $ make run 82 | 83 | **Building and installing/uninstalling locally** 84 | 85 | $ sudo make install 86 | $ sudo make uninstall 87 | 88 | **Cleaning up the project directory (remove dist/, \*.pyc, etc.)** 89 | 90 | $ make clean 91 | 92 | **Reminder - release process** 93 | 94 | 1. Make changes, update and run tests, ensure good coverage 95 | 2. Update setup.py and change the version according to [semantic versioning](http://semver.org/) 96 | 3. Tag new version; tag format is 'vX.Y.Z'; e.g.: v1.2.1 97 | 4. Push changes and a new tag 98 | 99 | # Copying 100 | 101 | Copyright 2014, [candidtim](https://github.com/candidtim) 102 | 103 | This Application Indicator is distributed under 104 | [GNU GENERAL PUBLIC LICENSE](http://www.gnu.org/licenses/gpl.html), 105 | either version 3 of the License, or (at your option) any later version. 106 | 107 | ![GPLv3](http://www.gnu.org/graphics/gplv3-88x31.png) 108 | 109 | This copyright or licensing doesn't apply to the icons used in the AppIndicator. 110 | See Attributions below. 111 | 112 | # Attributions 113 | 114 | Main AppIndicator is a modified version of the icon originally distributed under 115 | [CC BY 3.0 license](http://creativecommons.org/licenses/by/3.0/). 116 | Icon made by Picol from [www.flaticon.com](http://www.flaticon.com) 117 | -------------------------------------------------------------------------------- /vgapplet/machineindex.py: -------------------------------------------------------------------------------- 1 | # Copyright 2014, candidtim (https://github.com/candidtim) 2 | # 3 | # This file is part of Vagrant AppIndicator for Ubuntu. 4 | # 5 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by the Free Software 7 | # Foundation, either version 3 of the License, or (at your option) any later version. 8 | # 9 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 10 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 11 | # See the GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along with Foobar. 14 | # If not, see . 15 | 16 | ''' 17 | Parsers for Vagrant machine-index file 18 | ''' 19 | 20 | import os 21 | import json 22 | 23 | from gi.repository import Gio as gio 24 | 25 | 26 | __VAGRNAT_HOME_VAR = "VAGRANT_HOME" 27 | __MACHINE_INDEX_PATH = "data/machine-index/index" 28 | 29 | 30 | # module's public interface 31 | 32 | class Machine(object): 33 | def __init__(self, id, state, directory, name): 34 | self.id = id 35 | self.state = state 36 | self.directory = directory 37 | self.name = name 38 | 39 | def isPoweroff(self): 40 | return self.state == "poweroff" 41 | 42 | def isRunning(self): 43 | return self.state == "running" 44 | 45 | def isSaved(self): 46 | return self.state == "saved" 47 | 48 | def __str__(self): 49 | return "id=%s state=%s directory=%s name=%s" % \ 50 | (self.id, self.state, self.directory, self.name) 51 | 52 | def __eq__(self, other): 53 | return self.id == other.id 54 | 55 | def _changed_state_since(self, other): 56 | assert self == other 57 | return self.state != other.state 58 | 59 | 60 | class MachineIndexNotFoundError(Exception): 61 | pass 62 | 63 | 64 | def get_machineindex(): 65 | machineindex_path = _resolve_machineindex_path() 66 | with open(machineindex_path, 'r') as machineindex_file: 67 | return _parse_machineindex(machineindex_file) 68 | 69 | 70 | def diff_machineindexes(new_index, old_index): 71 | '''Returns tuple of 3 items: 72 | (list of new machines, list of removed machines, list of machines that changed state) 73 | ''' 74 | new_machines = [machine for machine in new_index if machine not in old_index] 75 | removed_machines = [machine for machine in old_index if machine not in new_index] 76 | changed_machines = [machine for machine in new_index 77 | if machine in old_index and machine._changed_state_since(old_index[old_index.index(machine)])] 78 | went_running = [machine for machine in changed_machines if machine.isRunning()] 79 | return (new_machines, removed_machines, changed_machines) 80 | 81 | 82 | active_monitors = {} 83 | 84 | def subscribe(listener): 85 | def on_machineindex_change(mon, f, o, event): 86 | if event == gio.FileMonitorEvent.CHANGES_DONE_HINT: 87 | listener(get_machineindex()) 88 | 89 | machineindex_path = _resolve_machineindex_path() 90 | file_to_monitor = gio.File.new_for_path(machineindex_path) 91 | monitor = file_to_monitor.monitor_file(gio.FileMonitorFlags.NONE, None) 92 | handler_id = monitor.connect("changed", on_machineindex_change) 93 | active_monitors[handler_id] = monitor 94 | 95 | def unsubscribe_all(): 96 | global active_monitors 97 | for handler_id in active_monitors: 98 | monitor = active_monitors[handler_id] 99 | monitor.disconnect(handler_id) 100 | active_monitors = {} 101 | 102 | 103 | # private implementation 104 | 105 | def _resolve_machineindex_path(): 106 | vagrant_home = os.getenv(__VAGRNAT_HOME_VAR, "~/.vagrant.d") 107 | machineindex_path = os.path.expanduser(os.path.join(vagrant_home, __MACHINE_INDEX_PATH)) 108 | if not os.path.isfile(machineindex_path): 109 | raise MachineIndexNotFoundError( 110 | "Vagrant machine index not found. Is Vagrant installed and at least one VM created?") 111 | return machineindex_path 112 | 113 | 114 | def _parse_machineindex(machineindex_file): 115 | machineindex_json = json.load(machineindex_file) 116 | version = machineindex_json["version"] 117 | # currently, only one parser version is available: 118 | parser = __MachineIndexParserV1() 119 | return parser.parse(machineindex_json) 120 | 121 | 122 | class __MachineIndexParser(object): 123 | def parse(self, machineindex_json): 124 | raise NotImplementedError() 125 | 126 | 127 | class __MachineIndexParserV1(__MachineIndexParser): 128 | def parse(self, machineindex_json): 129 | machineindex = [] 130 | machines_json = machineindex_json["machines"] 131 | for machine_id in machines_json: 132 | machine_json = machines_json[machine_id] 133 | machine = Machine(machine_id, machine_json["state"], 134 | machine_json["vagrantfile_path"], machine_json["name"]) 135 | machineindex.append(machine) 136 | return tuple(machineindex) 137 | -------------------------------------------------------------------------------- /vgapplet/indicator.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | 3 | # Copyright 2014, candidtim (https://github.com/candidtim) 4 | # 5 | # This file is part of Vagrant AppIndicator for Ubuntu. 6 | # 7 | # Vagrant AppIndicator for Ubuntu is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by the Free Software 9 | # Foundation, either version 3 of the License, or (at your option) any later version. 10 | # 11 | # Foobar is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 12 | # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 13 | # See the GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License along with Foobar. 16 | # If not, see . 17 | 18 | import sys 19 | import os 20 | import signal 21 | 22 | import gi 23 | gi.require_version('Gtk', '3.0') 24 | gi.require_version('AppIndicator3', '0.1') 25 | gi.require_version('Notify', '0.7') 26 | from gi.repository import Gtk as gtk 27 | from gi.repository import AppIndicator3 as appindicator 28 | from gi.repository import Notify as notify 29 | 30 | from . import config 31 | from . import ui 32 | from . import resource 33 | from . import machineindex 34 | from . import vagrantcontrol 35 | from . import autoupdate 36 | 37 | 38 | APPINDICATOR_ID = 'vagrant_appindicator' 39 | 40 | 41 | class VagrantAppIndicator(object): 42 | def __init__(self): 43 | notify.init(APPINDICATOR_ID) 44 | self.indicator = appindicator.Indicator.new( 45 | APPINDICATOR_ID, resource.image_path("icon", ui.THEME), appindicator.IndicatorCategory.SYSTEM_SERVICES) 46 | self.indicator.set_status(appindicator.IndicatorStatus.ACTIVE) 47 | self.last_known_machines = None 48 | 49 | # check for updates 50 | self.check_for_updates() 51 | 52 | # trigger first update manually, and then subscribe to real updates 53 | try: 54 | self.update(machineindex.get_machineindex()) 55 | machineindex.subscribe(self.update) 56 | except machineindex.MachineIndexNotFoundError: 57 | notify.Notification.new( 58 | "Is Vagrant installed?", 59 | "Either Vagrant is not installed, or never ran, or its version is too old (has no public machine index)", 60 | None).show() 61 | sys.exit(1) 62 | 63 | 64 | def _shutdown(self): 65 | machineindex.unsubscribe_all() 66 | 67 | 68 | def run(self): 69 | gtk.main() 70 | 71 | 72 | def open_about_page(self): 73 | import webbrowser 74 | webbrowser.open('https://github.com/candidtim/vagrant-appindicator/#vagrant-application-indicator-for-ubuntu-unity--gnome') 75 | 76 | 77 | def check_for_updates(self): 78 | if config.check_for_updates and autoupdate.is_update_available(): 79 | self._show_notification("AppIndicator Update", 80 | "A newer version of Vagrant AppIndicator is available on GitHub. "+\ 81 | "Open 'Help & About' to navigate to the project page.") 82 | 83 | 84 | def quit(self): 85 | self._shutdown() 86 | notify.uninit() 87 | gtk.main_quit() 88 | 89 | 90 | def update(self, machines): 91 | """Entry point for appindicator update. 92 | Triggers all UI modifications necessary on updates of machines states 93 | Subscribed as a listener to updates of machineindex""" 94 | self.__update_icon(machines) 95 | self.__notify_about_changes(machines) 96 | self.__update_menu(machines) 97 | self.last_known_machines = machines 98 | 99 | 100 | def __update_icon(self, machines): 101 | """Updates main appindicator icon to reflect the number of running machines 102 | Icons indicate if no, 1, 2 or 3 machines are running; more running machines 103 | are shown same way as 3 running machines""" 104 | icon_name = VagrantAppIndicator._icon_name(machines) 105 | icon = resource.image_path(icon_name, ui.THEME) 106 | self.indicator.set_icon(icon) 107 | 108 | 109 | @staticmethod 110 | def _icon_name(machines): 111 | """Returns correct icon name, based on the number of running machines. See __update_icon()""" 112 | running_count = len([m for m in machines if m.isRunning()]) 113 | icon_index = min(running_count, 3) 114 | return "icon-%d" % icon_index 115 | 116 | 117 | def _show_notification(self, title, message): 118 | """Shows balloon notification with given title and message""" 119 | if config.show_notifications: 120 | notify.Notification.new("Vagrant - %s" % title, message, None).show() 121 | 122 | 123 | def __notify_machine_state_change(self, title, machine): 124 | self._show_notification(title, "%s (%s)" % (machine.directory, machine.name)) 125 | 126 | 127 | def __notify_about_changes(self, new_machines): 128 | """Shows balloon notifications for every change in machines states""" 129 | if not self.last_known_machines: return # only possible on first update 130 | 131 | diff = machineindex.diff_machineindexes(new_machines, self.last_known_machines) 132 | for new_machine in diff[0]: 133 | self.__notify_machine_state_change("New machine went %s" % new_machine.state, new_machine) 134 | for removed_machine in diff[1]: 135 | self.__notify_machine_state_change("Machine destroyed", removed_machine) 136 | for changed_machine in diff[2]: 137 | self.__notify_machine_state_change("Machine went %s" % changed_machine.state, changed_machine) 138 | 139 | 140 | def __update_menu(self, machines): 141 | """Updates appindicator menu with current machines state""" 142 | menu = gtk.Menu() 143 | 144 | for machine in machines: 145 | item = self.__create_machine_submenu(machine) 146 | menu.append(item) 147 | if not machines: 148 | menu.append(gtk.MenuItem("No active machines found (all machines destroyed?)")) 149 | 150 | menu.append(gtk.SeparatorMenuItem("Options")) 151 | 152 | item_show_notifications = \ 153 | gtk.CheckMenuItem("Show notifications", active = config.show_notifications) 154 | item_show_notifications.connect("activate", self.on_show_notifications) 155 | menu.append(item_show_notifications) 156 | 157 | item_check_updates = \ 158 | gtk.CheckMenuItem("Check for updates", active = config.check_for_updates) 159 | item_check_updates.connect("activate", self.on_check_updates) 160 | menu.append(item_check_updates) 161 | 162 | item_about = gtk.MenuItem('Help & About') 163 | item_about.connect('activate', self.on_about) 164 | menu.append(item_about) 165 | 166 | item_quit = gtk.MenuItem('Quit') 167 | item_quit.connect('activate', self.on_quit) 168 | menu.append(item_quit) 169 | 170 | menu.show_all() 171 | self.indicator.set_menu(menu) 172 | 173 | 174 | def __create_machine_submenu(self, machine): 175 | """Creates menu item for a given VM, with its submenu and relevant actions in it""" 176 | menu_item = gtk.ImageMenuItem("%s (%s) - %s" % (machine.directory, machine.name, machine.state)) 177 | menu_item_image = gtk.Image() 178 | image_file_path = resource.image_path(machine.state, ui.THEME) 179 | if not os.path.isfile(image_file_path): 180 | image_file_path = resource.image_path("unknown", ui.THEME) 181 | menu_item_image.set_from_file(image_file_path) 182 | menu_item.set_image(menu_item_image) 183 | menu_item.set_always_show_image(True) 184 | 185 | submenu = gtk.Menu() 186 | menu_item.set_submenu(submenu) 187 | 188 | submenu_item_terminal = gtk.MenuItem('Open terminal...') 189 | submenu_item_terminal.connect('activate', self.on_open_terminal, machine) 190 | submenu.append(submenu_item_terminal) 191 | 192 | if machine.isSaved(): 193 | submenu_item_resume = gtk.MenuItem('Resume') 194 | submenu_item_resume.connect('activate', self.on_resume_vm, machine) 195 | submenu.append(submenu_item_resume) 196 | 197 | if machine.isPoweroff(): 198 | submenu_item_up = gtk.MenuItem('Up') 199 | submenu_item_up.connect('activate', self.on_start_vm, machine) 200 | submenu.append(submenu_item_up) 201 | 202 | submenu_item_up_and_provision = gtk.MenuItem('Up & Provision') 203 | submenu_item_up_and_provision.connect('activate', self.on_start_and_provision, machine) 204 | submenu.append(submenu_item_up_and_provision) 205 | 206 | if machine.isRunning(): 207 | submenu_item_ssh = gtk.MenuItem('SSH') 208 | submenu_item_ssh.connect('activate', self.on_ssh_vm, machine) 209 | submenu.append(submenu_item_ssh) 210 | 211 | submenu_item_suspend = gtk.MenuItem('Suspend') 212 | submenu_item_suspend.connect('activate', self.on_suspend_vm, machine) 213 | submenu.append(submenu_item_suspend) 214 | 215 | submenu_item_halt = gtk.MenuItem('Halt') 216 | submenu_item_halt.connect('activate', self.on_halt_vm, machine) 217 | submenu.append(submenu_item_halt) 218 | 219 | submenu_item_provision = gtk.MenuItem('Provision') 220 | submenu_item_provision.connect('activate', self.on_provision_vm, machine) 221 | submenu.append(submenu_item_provision) 222 | 223 | submenu_item_destroy = gtk.MenuItem('Destroy') 224 | submenu_item_destroy.connect('activate', self.on_destroy_vm, machine) 225 | submenu.append(submenu_item_destroy) 226 | 227 | return menu_item 228 | 229 | # UI listeners 230 | def on_about(self, _): self.open_about_page() 231 | def on_quit(self, _): self.quit() 232 | def on_open_terminal(self, _, machine): vagrantcontrol.open_terminal(machine) 233 | def on_start_vm(self, _, machine): vagrantcontrol.start(machine) 234 | def on_start_and_provision(self, _, machine): vagrantcontrol.start_and_provision(machine) 235 | def on_resume_vm(self, _, machine): vagrantcontrol.resume(machine) 236 | def on_ssh_vm(self, _, machine): vagrantcontrol.ssh(machine) 237 | def on_suspend_vm(self, _, machine): vagrantcontrol.suspend(machine) 238 | def on_halt_vm(self, _, machine): vagrantcontrol.halt(machine) 239 | def on_provision_vm(self, _, machine): vagrantcontrol.provision(machine) 240 | def on_destroy_vm(self, _, machine): vagrantcontrol.destroy(machine) 241 | def on_show_notifications(self, _): 242 | config.show_notifications = not config.show_notifications 243 | config.persist() 244 | def on_check_updates(self, _): 245 | config.check_for_updates = not config.check_for_updates 246 | config.persist() 247 | 248 | 249 | def main(): 250 | signal.signal(signal.SIGINT, signal.SIG_DFL) 251 | VagrantAppIndicator().run() 252 | 253 | 254 | if __name__ == "__main__": 255 | main() 256 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------