├── icon_spotify.png ├── CHANGELOG.md ├── .gitignore ├── README.md ├── spotify-notify.py └── LICENSE /icon_spotify.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sveint/spotify-notify/HEAD/icon_spotify.png -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | 2 | Old version log 3 | ------------- 4 | # v0.6d (28th aug 11) 5 | # by JonW (jon.neverwinter@gmail.com) 6 | # patched 20110907 by Jansen Price (sumpygump@gmail.com) 7 | # patched 20120729 by Jansen Price (sumpygump@gmail.com) and brandl.matthaeus 8 | # 9 | # Original by SveinT (sveint@gmail.com) 10 | # up to v0.5.2 (27th jan 11) -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[cod] 2 | 3 | # C extensions 4 | *.so 5 | 6 | # Packages 7 | *.egg 8 | *.egg-info 9 | dist 10 | build 11 | eggs 12 | parts 13 | bin 14 | var 15 | sdist 16 | develop-eggs 17 | .installed.cfg 18 | lib 19 | lib64 20 | __pycache__ 21 | 22 | # Installer logs 23 | pip-log.txt 24 | 25 | # Unit test / coverage reports 26 | .coverage 27 | .tox 28 | nosetests.xml 29 | 30 | # Translations 31 | *.mo 32 | 33 | # Mr Developer 34 | .mr.developer.cfg 35 | .project 36 | .pydevproject 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | spotify-notify 2 | ============== 3 | 4 | ### Note: Spotify for Linux now supports notifications and media keys natively, making this script redundant. 5 | 6 | 7 | Spotify-notify is a __notifier for currently playing song__ in Spotify on a linux system, using the notify-osd notifier (found in e.g. Ubuntu). It also includess __support for media keys__. It is intended for use on Ubuntu systems - current dependency is notify-osd. 8 | 9 | ![Example image](https://dl.dropbox.com/u/100344/spotifynotify2.png) 10 | 11 | 12 | Getting started 13 | --------------- 14 | ### Installation 15 | 16 | If you want to install spotify-notify permanently, it's recommended to follow these instructions. They apply to Ubuntu only but may work on other Debian-based distros as well. 17 | 18 | Just execute the following terminal commands to install spotify-notify: 19 | ```bash 20 | sudo mkdir /opt/spotify-notify/ # Create new directory to install spotify-notify 21 | cd /opt/spotify-notify/ # Change current directory to this folder 22 | # Download current version of spotify-notify 23 | sudo wget https://raw.githubusercontent.com/sveint/spotify-notify/master/spotify-notify.py 24 | sudo chmod a+x spotify-notify.py # Mark spotify-notify.py as an executable 25 | python spotify-notify.py -s & # Start spotify-notify in background 26 | ``` 27 | 28 | ### Adding spotify-notify to autostart 29 | In Ubuntu you can easily add spotify-notify to the autostart. You only need to open the startup-programmes dialog. More details can be found in the [Ubuntu Wiki](https://help.ubuntu.com/community/AddingProgramToSessionStartup#Startup_Programs). As the name you can choose something like "Spotify Notify" and as the command to be executed, choose 30 | 31 | `python spotify-notify.py -s` 32 | 33 | The comment field can be left empty. 34 | 35 | Advanced 36 | -------- 37 | ### Running spotify-notify (general information) 38 | To get it running, you first need to clone this repository or download the file `spotify-notify.py`. Afterwards you can run spotify-notify by 39 | 40 | `python spotify-notify.py` 41 | 42 | It will launch Spotify for you if not already running. Please see options below to change default behavior. 43 | 44 | If you want to launch the file directly you can first add execution rights to it: 45 | 46 | `chmod a+x spotify-notify.py` 47 | 48 | then launch by 49 | 50 | `./spotify-notify.py` 51 | 52 | ### Command line options 53 | 54 | Available options are: 55 | 56 | | Option | Description | 57 | | ------------------------------|:----------------------------------------------------------:| 58 | | `-h, --help` | Show help message and exit | 59 | | `-a ACTION, --action=ACTION` | Music player actions (playPause/play/pause/next/previous). | 60 | | `-n, --skip_notify` | Song change notifications will be turned off. | 61 | | `-m, --skip_media_keys` | Multimedia keys will not interact with spotify. | 62 | | `-s, --skip_spotify` | Spotify will not be opened if it is not running and spotify notify will not close when spotify is closed. | 63 | | `-d, --debug` | Debug messages will be displayed. | 64 | 65 | 66 | 67 | ### FAQ 68 | 69 | 70 | #### Q: How can I launch the script at startup? 71 | 72 | Just add a new entry to the startup applications, using the following as the "Command"-string; 73 | 74 | `///spotify-notify/spotify-notify.py -s` 75 | 76 | - Make sure that "spotify-notify.py" is executable 77 | - Make note of the "-s" parameter at the end, as this makes sure that spotify-notify doesn't start Spotify, and that it doesn't quit when you quit Spotify. 78 | 79 | 80 | #### Q: I want to use the script just for the media key support. How can I do this? 81 | 82 | Launch with -n as parameter. 83 | 84 | 85 | #### Q: Do I need Ubuntu to use this script? Will others distros work? 86 | 87 | A: Other distros supporting the same messaging system might work, please report any success stories! 88 | 89 | 90 | Spotify-notify is in no way affiliated with Spotify. Spotify is the registered trade mark of the Spotify Group. 91 | -------------------------------------------------------------------------------- /spotify-notify.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | # This program is free software; you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation; either version 2 of the License, or 6 | # (at your option) any later version. 7 | 8 | 9 | import dbus 10 | from dbus.mainloop.glib import DBusGMainLoop 11 | 12 | import gobject, gtk, os, tempfile, sys, time, re, urllib2 13 | from optparse import OptionParser 14 | from subprocess import * 15 | 16 | # The url to use when fetching spotify track information. 17 | SPOTIFY_OPEN_URL = "http://open.spotify.com/track/" 18 | 19 | # The path to this application's directory. 20 | APPLICATION_DIR = sys.path[0] + "/" 21 | 22 | # The file path to spotify. If empty, it will try to auto detect. 23 | SPOTIFY_PROCESS_NAME = '' 24 | 25 | # How often to check if spotify has been closed (in milliseconds). 26 | SPOTIFY_CLOSED_CHECK = 20000 27 | 28 | class SpotifyNotify(): 29 | 30 | spotifyPath = '' 31 | 32 | tryToReconnect = False 33 | 34 | tmpfile = False 35 | 36 | def __init__(self, debugger): 37 | self.debug = debugger 38 | self.spotifyservice = False 39 | 40 | self.prev = 0 41 | self.new = False 42 | self.prevMeta = {} 43 | self.notifyid = 0 44 | 45 | self.connect() 46 | 47 | def __del__(self): 48 | if SpotifyNotify and SpotifyNotify.tmpfile: 49 | SpotifyNotify.tmpfile.close() 50 | 51 | def connect(self): 52 | self.debug.out("Connecting to spotify.") 53 | self.bus = dbus.Bus(dbus.Bus.TYPE_SESSION) 54 | 55 | try: 56 | self.spotifyservice = self.bus.get_object( 57 | 'com.spotify.qt', 58 | '/org/mpris/MediaPlayer2' 59 | ) 60 | SpotifyNotify.tryToReconnect = False 61 | except Exception, e: 62 | self.spotifyservice = False 63 | self.debug.out("Failed to connect.") 64 | self.debug.out(e) 65 | 66 | def executeCommand(self, key): 67 | if not key: 68 | return 69 | 70 | self.connect() 71 | self.debug.out("Running command: {0}".format(key)) 72 | self.cmd = self.spotifyservice.get_dbus_method(key, 'org.mpris.MediaPlayer2.Player') 73 | self.cmd() 74 | 75 | def pollChange(self): 76 | try: 77 | self.spotifyservice = self.bus.get_object('com.spotify.qt', '/') 78 | self.cmd = self.spotifyservice.get_dbus_method( 79 | 'GetMetadata', 80 | 'org.freedesktop.MediaPlayer2' 81 | ) 82 | self.new = self.cmd() 83 | except Exception, e: 84 | self.debug.out('Spotify service not connected.') 85 | SpotifyNotify.tryToReconnect = True 86 | 87 | if (self.prev != self.new): 88 | self.trackChange(self.new) 89 | self.prev = self.new 90 | 91 | return 1 92 | 93 | def trackChange(self, *trackChange): 94 | if not trackChange[0]: 95 | return 96 | 97 | self.prev = trackChange[0] 98 | 99 | trackInfo = {} 100 | trackMap = { 101 | 'artist' : 'xesam:artist', 102 | 'album' : 'xesam:album', 103 | 'title' : 'xesam:title', 104 | 'year' : 'xesam:contentCreated', 105 | 'trackhash' : 'mpris:trackid', 106 | 'arturl' : 'mpris:artUrl' 107 | } 108 | 109 | # Fetch the track information for the notification window. 110 | for key in trackMap: 111 | if not trackMap[key] in trackChange[0]: 112 | continue 113 | piece = trackChange[0][trackMap[key]] 114 | if key == 'year': 115 | piece = str(piece[:4]) 116 | elif isinstance(piece, list): 117 | piece = ", ".join(piece) 118 | 119 | if not isinstance(piece, str): 120 | piece = str(piece) 121 | 122 | trackInfo[key] = piece.encode('utf-8') 123 | 124 | if not self.prevMeta\ 125 | or not SpotifyNotify.tmpfile\ 126 | or 'iconfilename' not in self.prevMeta\ 127 | or self.prevMeta['artist'] != trackInfo['artist']\ 128 | or self.prevMeta['album'] != trackInfo['album']: 129 | trackInfo['iconfilename'] = self.retrieveCoverImage(trackInfo) 130 | 131 | cover_image = '' 132 | 133 | if 'iconfilename' in trackInfo: 134 | cover_image = trackInfo['iconfilename'] 135 | elif 'iconfilename' in self.prevMeta: 136 | cover_image = self.prevMeta['iconfilename'] 137 | trackInfo['iconfilename'] = cover_image 138 | 139 | if cover_image == '': 140 | cover_image = APPLICATION_DIR + 'icon_spotify.png' 141 | 142 | self.prevMeta = trackInfo 143 | 144 | # Connect to notification interface on DBUS. 145 | self.notifyservice = self.bus.get_object( 146 | 'org.freedesktop.Notifications', 147 | '/org/freedesktop/Notifications' 148 | ) 149 | self.notifyservice = dbus.Interface( 150 | self.notifyservice, 151 | "org.freedesktop.Notifications" 152 | ) 153 | notifyText = "{0}\n{1}".format( 154 | trackInfo['artist'], 155 | trackInfo['album'] 156 | ) 157 | if len(trackInfo['year']) > 0: 158 | notifyText += " ({0})".format(trackInfo['year']) 159 | 160 | # Send track change information to stdout 161 | print "Changing track : {0} | {1} | {2} ({3})".format( 162 | trackInfo['artist'], 163 | trackInfo['title'], 164 | trackInfo['album'], 165 | trackInfo['year'] 166 | ) 167 | 168 | # The second param is the replace id, so get the notify id back, 169 | # store it, and send it as the replacement on the next call. 170 | self.notifyid = self.notifyservice.Notify( 171 | "Spotify-notify", 172 | self.notifyid, 173 | cover_image, 174 | trackInfo['title'], 175 | notifyText, 176 | [], 177 | {}, 178 | -1 179 | ) 180 | 181 | def retrieveCoverImage(self, trackInfo): 182 | if 'arturl' in trackInfo: 183 | self.debug.out("Simply retrieving image from {0}".format(trackInfo['arturl'])) 184 | iconfilename = self.fetchCoverImage(trackInfo['arturl']) 185 | else: 186 | #if (trackInfo['trackhash'][0:14] == 'spotify:local:'): 187 | # self.debug.out("Track is a local file. No art available.") 188 | # return '' 189 | 190 | self.debug.out("Attempting to fetch image from spotify") 191 | iconfilename = self.fetchCoverImageSpotify( 192 | trackInfo['artist'], 193 | trackInfo['album'], 194 | trackInfo['trackhash'] 195 | ) 196 | return iconfilename 197 | 198 | def fetchCoverImageSpotify(self, artist, album, trackhash): 199 | try: 200 | trackid = trackhash.split(":")[2] 201 | url = SPOTIFY_OPEN_URL + trackid 202 | tracksite = urllib2.urlopen(url).read() 203 | 204 | # Attempt to get the image url from the open graph image meta tag. 205 | imageurl = False 206 | metaMatch = re.search( 207 | ']*property\s*=\s*["\']og:image["\'][^\>]*/?>', 208 | tracksite 209 | ) 210 | if metaMatch: 211 | contentMatch = re.search( 212 | 'content\s*=\s*["\']([^\"\']*)["\']', 213 | metaMatch.group(0) 214 | ) 215 | if contentMatch: 216 | imageurl = contentMatch.group(1) 217 | 218 | if not imageurl: 219 | self.debug.out("No cover available.") 220 | raise() 221 | 222 | return self.fetchCoverImage(imageurl) 223 | except Exception, e: 224 | self.debug.out("Couldn't fetch cover image.") 225 | self.debug.out(e) 226 | 227 | return '' 228 | 229 | def fetchCoverImage(self, url): 230 | # Close the temporary image file, we are going to make a new one. 231 | if SpotifyNotify.tmpfile: 232 | SpotifyNotify.tmpfile.close() 233 | SpotifyNotify.tmpfile = False 234 | 235 | try: 236 | SpotifyNotify.tmpfile = tempfile.NamedTemporaryFile() 237 | tmpfilename = SpotifyNotify.tmpfile.name 238 | self.debug.out("Album art tmp filepath: {0}".format(tmpfilename)) 239 | 240 | coverfile = urllib2.urlopen(url) 241 | SpotifyNotify.tmpfile.write(coverfile.read()) 242 | SpotifyNotify.tmpfile.flush() 243 | return tmpfilename 244 | except Exception, e: 245 | self.debug.out("Couldn't fetch cover image.") 246 | self.debug.out(e) 247 | 248 | return '' 249 | 250 | @staticmethod 251 | def startSpotify(Debug): 252 | if not SpotifyNotify.spotifyPath: 253 | Debug.out("No spotify process identifier found.") 254 | return 255 | 256 | ident = SpotifyNotify.spotifyPath 257 | Debug.out("Looking for spotify as: {0}".format(ident)) 258 | 259 | procs = SpotifyNotify.checkForProcess( 260 | 'ps x | grep "{0}" | grep -v grep'.format(ident), 261 | Debug 262 | ) 263 | if len(procs): 264 | Debug.out("Spotify process found as: {0}".format(" ".join(procs[0]))) 265 | return 266 | 267 | Debug.out("Starting new Spotify now.") 268 | 269 | FNULL = open('/dev/null', 'w') 270 | spid = Popen([ident], stdout=FNULL, stderr=FNULL).pid 271 | if spid: 272 | Debug.out("Spotify started, pid: {0}.".format(spid)) 273 | else: 274 | Debug.out("Spotify could not be started.") 275 | 276 | @staticmethod 277 | def checkForClosedSpotify(SN, Debug): 278 | if not SpotifyNotify.spotifyPath: 279 | Debug.out("No spotify process identifier found.") 280 | return False 281 | 282 | ident = SpotifyNotify.spotifyPath 283 | Debug.out("Looking for spotify as: {0}".format(ident)) 284 | 285 | procs = SpotifyNotify.checkForProcess( 286 | 'ps x | grep "{0}" | grep -v grep'.format(ident), 287 | Debug 288 | ) 289 | if len(procs): 290 | Debug.out("Spotify process found as: {0}".format(" ".join(procs[0]))) 291 | 292 | if (SpotifyNotify.tryToReconnect): 293 | SN.connect() 294 | 295 | return True 296 | 297 | if SpotifyNotify.tmpfile: 298 | SpotifyNotify.tmpfile.close() 299 | 300 | Debug.out("Spotify has been closed, therefore I die.") 301 | exit(0) 302 | 303 | @staticmethod 304 | def preventDuplicate(Debug): 305 | mypid = os.getpid() 306 | Debug.out("My pid: {0}".format(mypid)) 307 | 308 | proc = SpotifyNotify.checkForProcess('ps -p {0}'.format(mypid), Debug) 309 | if not proc[0][3]: 310 | return 311 | 312 | process = proc[0][3] 313 | search = 'ps -C {0}'.format(process) 314 | 315 | Debug.out("Looking for other processes named: {0}".format(process).strip()) 316 | 317 | if process == 'python': 318 | if not sys.argv[0]: 319 | Debug.out("Process started using python, cannot determine script name.") 320 | return 321 | 322 | search = 'ps ax | grep "python {0}" | grep -v grep'.format(sys.argv[0]) 323 | 324 | for line in SpotifyNotify.checkForProcess(search, Debug): 325 | if int(line[0]) != mypid: 326 | print("This program was already running.") 327 | Debug.out("I am a duplicate. I shall end myself. ({0})".format(" ".join(line))) 328 | exit(0) 329 | 330 | @staticmethod 331 | def checkForProcess(proc, Debug): 332 | output = [] 333 | 334 | for line in Popen(proc, shell=True, stdout=PIPE).stdout: 335 | fields = line.split() 336 | if not fields[0].isdigit(): 337 | continue 338 | 339 | output.append(fields) 340 | 341 | return output 342 | 343 | class MediaKeyHandler(): 344 | def __init__(self, spotifyNotify, debugger): 345 | self.SN = spotifyNotify 346 | self.debug = debugger 347 | self.keys = { 348 | "Play" : "PlayPause", 349 | "Stop" : "Pause", 350 | "Pause" : "Pause", 351 | "Next" : "Next", 352 | "Previous" : "Previous", 353 | } 354 | 355 | try: 356 | self.bus = dbus.Bus(dbus.Bus.TYPE_SESSION) 357 | self.bus_object = self.bus.get_object( 358 | 'org.gnome.SettingsDaemon', 359 | '/org/gnome/SettingsDaemon/MediaKeys' 360 | ) 361 | except: 362 | print "Gnome SettingsDaemon not founnd, multimedia keys will not interact with spotify" 363 | return 364 | try: 365 | self.bus_object.GrabMediaPlayerKeys( 366 | "Spotify", 367 | 0, 368 | dbus_interface='org.gnome.SettingsDaemon.MediaKeys' 369 | ) 370 | except: 371 | pass 372 | 373 | self.bus_object.connect_to_signal( 374 | 'MediaPlayerKeyPressed', 375 | self.handle_mediakey 376 | ) 377 | 378 | def handle_mediakey(self, *mmkeys): 379 | for key in mmkeys: 380 | if not key in self.keys or not self.keys[key]: 381 | continue 382 | 383 | self.SN.executeCommand(self.keys[key]) 384 | 385 | class DebugMe(): 386 | def __init__(self, toggle): 387 | if toggle: 388 | self.output = True 389 | else: 390 | self.output = False 391 | 392 | def out(self, msg): 393 | if not self.output: 394 | return 395 | 396 | print(">> {0}".format(msg)) 397 | 398 | if __name__ == "__main__": 399 | parser = OptionParser() 400 | parser.add_option( 401 | '-a', 402 | '--action', 403 | dest = 'action', 404 | default = None, 405 | type = 'choice', 406 | choices = ['playPause', 'play', 'pause', 'next', 'previous'], 407 | help = 'Music player actions (playPause/play/pause/next/previous).' 408 | ) 409 | parser.add_option( 410 | '-n', 411 | '--skip_notify', 412 | dest = 'skipNotify', 413 | action = 'store_true', 414 | default = False, 415 | help = 'Song change notifications will be turned off.' 416 | ) 417 | parser.add_option( 418 | '-m', 419 | '--skip_media_keys', 420 | dest = 'skipMediaKeys', 421 | action = 'store_true', 422 | default = False, 423 | help = 'Multimedia keys will not interact with spotify.' 424 | ) 425 | parser.add_option( 426 | '-s', 427 | '--skip_spotify', 428 | dest = 'skipSpotify', 429 | action = 'store_true', 430 | default = False, 431 | help = 'Spotify will not be opened if it is not running and spotify notify will not close when spotify is closed.' 432 | ) 433 | parser.add_option( 434 | '-d', 435 | '--debug', 436 | dest = 'debug', 437 | action = 'store_true', 438 | default = False, 439 | help = 'Debug messages will be displayed.' 440 | ) 441 | 442 | (options, args) = parser.parse_args() 443 | 444 | Debug = DebugMe(options.debug) 445 | print("Spotify-notify v0.6") 446 | 447 | if SPOTIFY_PROCESS_NAME: 448 | SpotifyNotify.spotifyPath = SPOTIFY_PROCESS_NAME 449 | else: 450 | for line in Popen('which spotify', shell=True, stdout=PIPE).stdout: 451 | SpotifyNotify.spotifyPath = str(line).strip() 452 | break 453 | 454 | if options.skipSpotify: 455 | Debug.out('Skipping spotify process check.') 456 | else: 457 | SpotifyNotify.startSpotify(Debug) 458 | 459 | DBusGMainLoop(set_as_default=True) 460 | SN = SpotifyNotify(Debug) 461 | 462 | if options.action: 463 | action = options.action 464 | action = action[0:1].upper() + action[1:] 465 | SN.executeCommand(action) 466 | exit(0) 467 | 468 | SpotifyNotify.preventDuplicate(Debug) 469 | 470 | if not options.skipMediaKeys: 471 | MH = MediaKeyHandler(SN, Debug) 472 | 473 | loop = gobject.MainLoop() 474 | 475 | if not options.skipSpotify: 476 | gobject.timeout_add(SPOTIFY_CLOSED_CHECK, SN.checkForClosedSpotify, SN, Debug) 477 | if not options.skipNotify: 478 | gobject.timeout_add(500, SN.pollChange) 479 | 480 | loop.run() 481 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------