removed symlink to py-sonic

was crashing on KODI OpenELEC, safer not to use it.

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## v2.0.3
+Released 4 October 2016
+* Random tracks submenu
+* Download tracks
+* Star tracks
+* Context menu for downloading or marking items as favorite
+
+## v2.0.2
+* main code (main.py) fully rewritten
+* Use SimplePlugin framework (http://romanvm.github.io/script.module.simpleplugin/index.html)
+* Cache datas
+
+## v2.0.1
+* New setting 'albums_per_page'
+* New menu structure
+* Albums : Newest / Most played / Rencently played / by Genre
+* Tracks : Starred / Random by genre / Random by year
+* Upgraded: libsonic to v.0.5.0 (https://github.com/crustymonkey/py-sonic)
+* Code cleanup
+
 ## v2.0.0
 Released 14 September 2015
 

README.md

@@ -1,19 +1,31 @@
-# Subsonic for Kodi
+# Subsonic
-Kodi plugin to stream music from Subsonic.
+Kodi plugin to stream, star and download music from Subsonic.
+For feature requests / issues:
+https://github.com/gordielachance/plugin.audio.subsonic/issues
+Contributions are welcome:
+https://github.com/gordielachance/plugin.audio.subsonic
 
 ## Features
-* Playlist support
+* Browse by artist, albums (newest/most played/recently played/random), tracks (starred/random), and playlists
-* Browse by artist, album and genre
+* Download songs
-* Random playlists
+* Star songs
 
 ## Installation
 * Navigate to your `.kodi/addons/` folder
-* Clone this repository: `git clone https://github.com/basilfx/plugin.audio.subsonic.git`
+* Clone this repository: `git clone https://github.com/gordielachance/plugin.audio.subsonic.git`
+* Install the SimplePlugin dependency by cloning its repository: `git clone https://github.com/romanvm/script.module.simpleplugin.git`
 * (Re)start Kodi.
 
+## TODO
+* Scrobble to Last.FM (http://forum.kodi.tv/showthread.php?tid=195597&pid=2429362#pid2429362)
+* Improve the caching system
+* Search filter GUI for tracks and albums
+
 ## License
 See the `LICENSE` file.
 
 Additional copyright notices:
-* The original [SubKodi](https://github.com/DarkAllMan/SubKodi) plugin.
+* [Previous version of this plugin](https://github.com/basilfx/plugin.audio.subsonic) by basilfx
-* [`py-sonic`](https://github.com/crustymonkey/py-sonic) Python module.
+* [SimplePlugin](https://github.com/romanvm/script.module.simpleplugin/stargazers) by romanvm
+* The original [SubKodi](https://github.com/DarkAllMan/SubKodi) plugin
+* [`py-sonic`](https://github.com/crustymonkey/py-sonic) Python module

addon.py

@@ -1,383 +0,0 @@
-import os
-import sys
-import urllib
-import urlparse
-
-import xbmc
-import xbmcgui
-import xbmcaddon
-import xbmcplugin
-
-# Make sure library folder is on the path
-addon = xbmcaddon.Addon("plugin.audio.subsonic")
-sys.path.append(xbmc.translatePath(os.path.join(
-    addon.getAddonInfo("path"), "lib")))
-
-import libsonic_extra
-
-
-class Plugin(object):
-    """
-    Plugin container.
-    """
-
-    def __init__(self, addon_url, addon_handle, addon_args):
-        self.addon_url = addon_url
-        self.addon_handle = addon_handle
-        self.addon_args = addon_args
-
-        # Retrieve plugin settings
-        self.url = addon.getSetting("subsonic_url")
-        self.username = addon.getSetting("username")
-        self.password = addon.getSetting("password")
-
-        self.random_count = addon.getSetting("random_count")
-        self.bitrate = addon.getSetting("bitrate")
-        self.transcode_format = addon.getSetting("transcode_format")
-
-        # Create connection
-        self.connection = libsonic_extra.SubsonicClient(
-            self.url, self.username, self.password)
-
-    def build_url(self, query):
-        """
-        Create URL for page.
-        """
-
-        parts = list(urlparse.urlparse(self.addon_url))
-        parts[4] = urllib.urlencode(query)
-
-        return urlparse.urlunparse(parts)
-
-    def route(self):
-        """
-        Map a Kodi request to certain action. This takes the `mode' query
-        parameter and executed the function in this instance with that name.
-        """
-
-        mode = self.addon_args.get("mode", ["main_page"])[0]
-
-        if not mode.startswith("_"):
-            getattr(self, mode)()
-
-    def add_track(self, track, show_artist=False):
-        """
-        Display one track in the list.
-        """
-
-        url = self.connection.streamUrl(
-            sid=track["id"], maxBitRate=self.bitrate,
-            tformat=self.transcode_format)
-
-        # Create list item
-        if show_artist:
-            title = "%s - %s" % (
-                track.get("artist", "<Unknown>"),
-                track.get("title", "<Unknown>"))
-        else:
-            title = track.get("title", "<Unknown>")
-
-        # Create item
-        li = xbmcgui.ListItem(title)
-
-        # Handle cover art
-        if "coverArt" in track:
-            cover_art_url = self.connection.getCoverArtUrl(track["coverArt"])
-
-            li.setIconImage(cover_art_url)
-            li.setThumbnailImage(cover_art_url)
-            li.setProperty("fanart_image", cover_art_url)
-
-        # Handle metadata
-        li.setProperty("IsPlayable", "true")
-        li.setMimeType(track.get("contentType"))
-        li.setInfo(type="Music", infoLabels={
-            "Artist": track.get("artist"),
-            "Title": track.get("title"),
-            "Year": track.get("year"),
-            "Duration": track.get("duration"),
-            "Genre": track.get("genre"),
-            "TrackNumber": track.get("track")})
-
-        xbmcplugin.addDirectoryItem(
-            handle=self.addon_handle, url=url, listitem=li)
-
-    def add_album(self, album, show_artist=False):
-        """
-        Display one album in the list.
-        """
-
-        url = self.build_url({
-            "mode": "track_list",
-            "album_id": album["id"]})
-
-        # Create list item
-        if show_artist:
-            title = "%s - %s" % (
-                album.get("artist", "<Unknown>"),
-                album.get("name", "<Unknown>"))
-        else:
-            title = album.get("name", "<Unknown>")
-
-        # Add year if applicable
-        if album.get("year"):
-            title = "%s [%d]" % (title, album.get("year"))
-
-        # Create item
-        li = xbmcgui.ListItem()
-        li.setLabel(title)
-
-        # Handle cover art
-        if "coverArt" in album:
-            cover_art_url = self.connection.getCoverArtUrl(album["coverArt"])
-
-            li.setIconImage(cover_art_url)
-            li.setThumbnailImage(cover_art_url)
-            li.setProperty("fanart_image", cover_art_url)
-
-        # Handle metadata
-        li.setInfo(type="music", infoLabels={
-            "Artist": album.get("artist"),
-            "Album": album.get("name"),
-            "Year": album.get("year")})
-
-        xbmcplugin.addDirectoryItem(
-            handle=self.addon_handle, url=url, listitem=li, isFolder=True)
-
-    def main_page(self):
-        """
-        Display main menu.
-        """
-
-        menu = [
-            {"mode": "starred_list", "foldername": "Starred"},
-            {"mode": "playlists_list", "foldername": "Playlists"},
-            {"mode": "artist_list", "foldername": "Artists"},
-            {"mode": "genre_list", "foldername": "Genres"},
-            {"mode": "random_list", "foldername": "Random songs"}]
-
-        for entry in menu:
-            url = self.build_url(entry)
-
-            li = xbmcgui.ListItem(entry["foldername"])
-            xbmcplugin.addDirectoryItem(
-                handle=self.addon_handle, url=url, listitem=li, isFolder=True)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-    def starred_list(self):
-        """
-        Display starred songs.
-        """
-
-        xbmcplugin.setContent(self.addon_handle, "songs")
-
-        for starred in self.connection.walk_starred():
-            self.add_track(starred, show_artist=True)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-    def playlists_list(self):
-        """
-        Display playlists.
-        """
-
-        for playlist in self.connection.walk_playlists():
-            cover_art_url = self.connection.getCoverArtUrl(
-                playlist["coverArt"])
-            url = self.build_url({
-                "mode": "playlist_list", "playlist_id": playlist["id"]})
-
-            li = xbmcgui.ListItem(playlist["name"], iconImage=cover_art_url)
-            xbmcplugin.addDirectoryItem(
-                handle=self.addon_handle, url=url, listitem=li, isFolder=True)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-    def playlist_list(self):
-        """
-        Display playlist tracks.
-        """
-
-        playlist_id = self.addon_args["playlist_id"][0]
-
-        xbmcplugin.setContent(self.addon_handle, "songs")
-
-        for track in self.connection.walk_playlist(playlist_id):
-            self.add_track(track, show_artist=True)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-    def genre_list(self):
-        """
-        Display list of genres menu.
-        """
-
-        for genre in self.connection.walk_genres():
-            url = self.build_url({
-                "mode": "albums_by_genre_list",
-                "foldername": genre["value"].encode("utf-8")})
-
-            li = xbmcgui.ListItem(genre["value"])
-            xbmcplugin.addDirectoryItem(
-                handle=self.addon_handle, url=url, listitem=li, isFolder=True)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-    def albums_by_genre_list(self):
-        """
-        Display album list by genre menu.
-        """
-
-        genre = self.addon_args["foldername"][0].decode("utf-8")
-
-        xbmcplugin.setContent(self.addon_handle, "albums")
-
-        for album in self.connection.walk_album_list_genre(genre):
-            self.add_album(album, show_artist=True)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-    def artist_list(self):
-        """
-        Display artist list
-        """
-
-        xbmcplugin.setContent(self.addon_handle, "artists")
-
-        for artist in self.connection.walk_artists():
-            cover_art_url = self.connection.getCoverArtUrl(artist["id"])
-            url = self.build_url({
-                "mode": "album_list",
-                "artist_id": artist["id"]})
-
-            li = xbmcgui.ListItem(artist["name"])
-            li.setIconImage(cover_art_url)
-            li.setThumbnailImage(cover_art_url)
-            li.setProperty("fanart_image", cover_art_url)
-            xbmcplugin.addDirectoryItem(
-                handle=self.addon_handle, url=url, listitem=li, isFolder=True)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-    def album_list(self):
-        """
-        Display list of albums for certain artist.
-        """
-
-        artist_id = self.addon_args["artist_id"][0]
-
-        xbmcplugin.setContent(self.addon_handle, "albums")
-
-        for album in self.connection.walk_artist(artist_id):
-            self.add_album(album)
-
-        xbmcplugin.addSortMethod(
-            self.addon_handle, xbmcplugin.SORT_METHOD_UNSORTED)
-        xbmcplugin.addSortMethod(
-            self.addon_handle, xbmcplugin.SORT_METHOD_ALBUM)
-        xbmcplugin.addSortMethod(
-            self.addon_handle, xbmcplugin.SORT_METHOD_ARTIST)
-        xbmcplugin.addSortMethod(
-            self.addon_handle, xbmcplugin.SORT_METHOD_VIDEO_YEAR)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-    def track_list(self):
-        """
-        Display track list.
-        """
-
-        album_id = self.addon_args["album_id"][0]
-
-        xbmcplugin.setContent(self.addon_handle, "songs")
-
-        for track in self.connection.walk_album(album_id):
-            self.add_track(track)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-    def random_list(self):
-        """
-        Display random options.
-        """
-
-        menu = [
-            {"mode": "random_by_genre_list", "foldername": "By genre"},
-            {"mode": "random_by_year_list", "foldername": "By year"}]
-
-        for entry in menu:
-            url = self.build_url(entry)
-
-            li = xbmcgui.ListItem(entry["foldername"])
-            xbmcplugin.addDirectoryItem(
-                handle=self.addon_handle, url=url, listitem=li, isFolder=True)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-    def random_by_genre_list(self):
-        """
-        Display random genre list.
-        """
-
-        for genre in self.connection.walk_genres():
-            url = self.build_url({
-                "mode": "random_by_genre_track_list",
-                "foldername": genre["value"].encode("utf-8")})
-
-            li = xbmcgui.ListItem(genre["value"])
-            xbmcplugin.addDirectoryItem(
-                handle=self.addon_handle, url=url, listitem=li, isFolder=True)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-    def random_by_genre_track_list(self):
-        """
-        Display random tracks by genre
-        """
-
-        genre = self.addon_args["foldername"][0].decode("utf-8")
-
-        xbmcplugin.setContent(self.addon_handle, "songs")
-
-        for track in self.connection.walk_random_songs(
-                size=self.random_count, genre=genre):
-            self.add_track(track, show_artist=True)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-    def random_by_year_list(self):
-        """
-        Display random tracks by year.
-        """
-
-        from_year = xbmcgui.Dialog().input(
-            "From year", type=xbmcgui.INPUT_NUMERIC)
-        to_year = xbmcgui.Dialog().input(
-            "To year", type=xbmcgui.INPUT_NUMERIC)
-
-        xbmcplugin.setContent(self.addon_handle, "songs")
-
-        for track in self.connection.walk_random_songs(
-                size=self.random_count, from_year=from_year, to_year=to_year):
-            self.add_track(track, show_artist=True)
-
-        xbmcplugin.endOfDirectory(self.addon_handle)
-
-
-def main():
-    """
-    Entry point for this plugin. Instantiates a new plugin object and runs the
-    action that is given.
-    """
-
-    addon_url = sys.argv[0]
-    addon_handle = int(sys.argv[1])
-    addon_args = urlparse.parse_qs(sys.argv[2][1:])
-
-    # Route request to action.
-    Plugin(addon_url, addon_handle, addon_args).route()
-
-# Start plugin from within Kodi.
-if __name__ == "__main__":
-    main()

addon.xml

@@ -1,21 +1,29 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<addon id="plugin.audio.subsonic" name="Subsonic" version="2.0.0" provider-name="BasilFX">
+<addon id="plugin.audio.subsonic" name="Subsonic" version="2.0.3" provider-name="BasilFX,grosbouff,lrusak">
-    <requires>
+<requires>
-        <import addon="xbmc.python" version="2.19.0"/>
+    <import addon="xbmc.python" version="2.14.0"/>
-    </requires>
+    <import addon="script.module.dateutil" version="2.4.2"/>
-    <extension point="xbmc.python.pluginsource" library="addon.py">
+    <import addon="script.module.simpleplugin" version="2.0.1"/>
-        <provides>audio</provides>
+</requires>
-    </extension>
+<extension point="xbmc.python.pluginsource" library="main.py">
+  <provides>audio</provides>
+</extension>
     <extension point="xbmc.addon.metadata">
         <summary lang="en">Subsonic music addon for Kodi.</summary>
-        <description lang="en">Subsonic music addon for Kodi. Stream your tunes directly to Kodi.</description>
+        <description lang="en">
+            Stream, star and download your tunes, directly to Kodi !
+            For feature requests / issues:
+            https://github.com/gordielachance/plugin.audio.subsonic/issues
+            Contributions are welcome:
+            https://github.com/gordielachance/plugin.audio.subsonic
+        </description>
         <disclaimer lang="en"></disclaimer>
         <language>en</language>
         <platform>all</platform>
         <license>MIT</license>
         <forum></forum>
         <website>http://www.subsonic.org</website>
-        <source>https://github.com/basilfx/plugin.audio.subsonic</source>
+        <source>https://github.com/gordielachance/plugin.audio.subsonic</source>
         <email></email>
     </extension>
 </addon>

lib/libsonic/__init__.py

@@ -29,4 +29,4 @@ print conn.ping()
 
 from connection import *
 
-__version__ = '0.3.4'
+__version__ = '0.6.2'

lib/libsonic_extra/__init__.py

@@ -2,7 +2,6 @@ import urllib
 import urlparse
 import libsonic
 
-
 def force_list(value):
     """
     Coerce the input value to a list.
@@ -34,7 +33,7 @@ class SubsonicClient(libsonic.Connection):
     - Add conventient `walk_*' methods to iterate over the API responses.
     """
 
-    def __init__(self, url, username, password):
+    def __init__(self, url, username, password, apiversion, insecure, legacyauth):
         """
         Construct a new SubsonicClient.
 
@@ -64,7 +63,7 @@ class SubsonicClient(libsonic.Connection):
 
         # Invoke original constructor
         super(SubsonicClient, self).__init__(
-            host, username, password, port=port)
+            host, username, password, port=port, appName='Kodi', apiVersion=apiversion, insecure=insecure, legacyAuth=legacyauth)
 
     def getIndexes(self, *args, **kwargs):
         """
@@ -336,16 +335,6 @@ class SubsonicClient(libsonic.Connection):
         for child in response["playlist"]["entry"]:
             yield child
 
-    def walk_starred(self):
-        """
-        Request Subsonic's starred songs and iterate over each item.
-        """
-
-        response = self.getStarred()
-
-        for song in response["starred"]["song"]:
-            yield song
-
     def walk_directory(self, directory_id):
         """
         Request a Subsonic music directory and iterate over each item.
@@ -391,24 +380,26 @@ class SubsonicClient(libsonic.Connection):
         for genre in response["genres"]["genre"]:
             yield genre
 
-    def walk_album_list_genre(self, genre):
+    def walk_albums(self, ltype, size=None, fromYear=None,toYear=None, genre=None, offset=None):
         """
         Request all albums for a given genre and iterate over each album.
         """
+        
+        if ltype == 'byGenre' and genre is None:
+            return
+        
+        if ltype == 'byYear' and (fromYear is None or toYear is None):
+            return
 
-        offset = 0
+        response = self.getAlbumList2(
+            ltype=ltype, size=size, fromYear=fromYear, toYear=toYear,genre=genre, offset=offset)
 
-        while True:
+        if not response["albumList2"]["album"]:
-            response = self.getAlbumList2(
+            return
-                ltype="byGenre", genre=genre, size=500, offset=offset)
 
-            if not response["albumList2"]["album"]:
+        for album in response["albumList2"]["album"]:
-                break
+            yield album
 
-            for album in response["albumList2"]["album"]:
-                yield album
-
-            offset += 500
 
     def walk_album(self, album_id):
         """
@@ -420,14 +411,24 @@ class SubsonicClient(libsonic.Connection):
         for song in response["album"]["song"]:
             yield song
 
-    def walk_random_songs(self, size, genre=None, from_year=None,
+    def walk_tracks_random(self, size=None, genre=None, fromYear=None,toYear=None):
-                          to_year=None):
         """
         Request random songs by genre and/or year and iterate over each song.
         """
 
         response = self.getRandomSongs(
-            size=size, genre=genre, fromYear=from_year, toYear=to_year)
+            size=size, genre=genre, fromYear=fromYear, toYear=toYear)
 
         for song in response["randomSongs"]["song"]:
             yield song
+            
+
+    def walk_tracks_starred(self):
+        """
+        Request Subsonic's starred songs and iterate over each item.
+        """
+
+        response = self.getStarred()
+
+        for song in response["starred"]["song"]:
+            yield song

lib/py-sonic/.gitignore

@@ -0,0 +1,5 @@
+*.pyc
+test.py
+MANIFEST
+dist
+build

lib/py-sonic/CHANGELOG.md

@@ -0,0 +1,57 @@
+## 0.6.2
+
+* Added an option to use GET requests, instead of the default POST requests
+
+## 0.6.1
+
+* Added `legacyAuth` option for pre-1.13.0 support
+
+## 0.6.0
+
+* Added API 1.14.0 support
+
+## 0.5.1
+
+* Added the ability to use a netrc file for credentials
+
+## 0.5.0
+
+* Added support for using credentials via a netrc file
+
+## 0.4.1
+
+* Fixed SSL handling issues
+
+## 0.4.0
+
+* Added missing 1.12.0 API items
+* Added 1.13.0 API items
+* All timestamps both passed in, and returned, should now be in **proper** unix time, which is seconds since the epoch, **not** milliseconds since the epoch
+
+## 0.3.5
+
+* allow for self-signed certs
+
+## 0.3.4
+
+* Add missing parameters to getAlbumList2 (thanks to basilfx)
+* Remove trailing whitespace (thanks to basilfx)
+
+## 0.3.3
+
+* Added support for API version 1.11.0
+* Added a couple of additions from API version 1.10.x that were previously 
+  missed
+
+## 0.3.1
+
+*  Incorporated unofficial API calls (beallio)
+
+## 0.2.1
+
+*  Added a patch to force SSLv3 as some users were apparently having issues
+   with the 4.7 release of Subsonic and SSL.  (thanks to orangepeelbeef)
+
+## 0.2.0
+
+*  Added support for API version 1.8.0 (Subsonic verion 4.7)

lib/py-sonic/LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

lib/py-sonic/MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include CHANGELOG.md
+include README.md

lib/py-sonic/README.md

@@ -0,0 +1,80 @@
+# py-sonic #
+
+## INSTALL ##
+
+Installation is fairly simple.  Just do the standard install as root:
+
+    tar -xvzf py-sonic-*.tar.gz
+    cd py-sonic-*
+    python setup.py install
+
+You can also install directly using *pip* or *easy_install*
+
+    pip install py-sonic
+
+## PYTHON 3 ##
+
+I've added experimental support for Python 3.  This is not fully tested, but I
+do encourage people to fork the repository and test off the "python3" branch
+and issue pull requests.  If you don't want to go through that trouble, bug
+reports are always welcome too!
+
+## USAGE ##
+
+This library follows the REST API almost exactly (for now).  If you follow the 
+documentation on http://www.subsonic.org/pages/api.jsp or you do a:
+
+    pydoc libsonic.connection
+
+I have also added documentation at http://stuffivelearned.org/doku.php?id=programming:python:py-sonic
+
+## BASIC TUTORIAL ##
+
+This is about as basic as it gets.  We are just going to set up the connection
+and then get a couple of random songs.
+
+```python
+#!/usr/bin/env python
+
+from pprint import pprint
+import libsonic
+
+# We pass in the base url, the username, password, and port number
+# Be sure to use https:// if this is an ssl connection!
+conn = libsonic.Connection('https://music.example.com' , 'myuser' , 
+    'secretpass' , port=443)
+# Let's get 2 completely random songs
+songs = conn.getRandomSongs(size=2)
+# We'll just pretty print the results we got to the terminal
+pprint(songs)
+```
+
+As you can see, it's really pretty simple.  If you use the documentation 
+provided in the library:
+
+    pydoc libsonic.connection
+
+or the api docs on subsonic.org (listed above), you should be able to make use
+of your server without too much trouble.
+
+Right now, only plain old dictionary structures are returned.  The plan 
+for a later release includes the following:
+
+* Proper object representations for Artist, Album, Song, etc.
+* Lazy access of members (the song objects aren't created until you want to
+  do something with them)
+
+## TODO ##
+
+In the future, I would like to make this a little more "pythonic" and add
+some classes to wrap up the data returned from the server.  Right now, the data
+is just returned in the form of a dict, but I would like to have actual
+Song, Album, Folder, etc. classes instead, or at least an alternative.  For
+now, it works.
+
+*NOTE:* I've noticed a wart with the upstream Subsonic API wherein any
+of the Connection methods that would normally return a list of dictionary
+elements (getPlaylists() for example), will only return a dictionary if there
+is a single return element.  I plan on changing this in py-sonic so that
+any methods of that nature will *always* return a list, even if there is
+only a single dict in the list.

lib/py-sonic/libsonic/__init__.py

@@ -0,0 +1,32 @@
+"""
+This file is part of py-sonic.
+
+py-sonic is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+py-sonic is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with py-sonic.  If not, see <http://www.gnu.org/licenses/>
+
+For information on method calls, see 'pydoc libsonic.connection'
+
+----------
+Basic example:
+----------
+
+import libsonic
+
+conn = libsonic.Connection('http://localhost' , 'admin' , 'password')
+print conn.ping()
+
+"""
+
+from connection import *
+
+__version__ = '0.6.2'

lib/py-sonic/libsonic/errors.py

@@ -0,0 +1,59 @@
+"""
+This file is part of py-sonic.
+
+py-sonic is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+py-sonic is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with py-sonic.  If not, see <http://www.gnu.org/licenses/>
+"""
+
+class SonicError(Exception):
+    pass
+
+class ParameterError(SonicError):
+    pass
+
+class VersionError(SonicError):
+    pass
+
+class CredentialError(SonicError):
+    pass
+
+class AuthError(SonicError):
+    pass
+
+class LicenseError(SonicError):
+    pass
+
+class DataNotFoundError(SonicError):
+    pass
+
+class ArgumentError(SonicError):
+    pass
+
+# This maps the error code numbers from the Subsonic server to their
+# appropriate Exceptions
+ERR_CODE_MAP = {
+    0: SonicError ,
+    10: ParameterError ,
+    20: VersionError ,
+    30: VersionError ,
+    40: CredentialError ,
+    50: AuthError ,
+    60: LicenseError ,
+    70: DataNotFoundError ,
+}
+
+def getExcByCode(code):
+    code = int(code)
+    if code in ERR_CODE_MAP:
+        return ERR_CODE_MAP[code]
+    return SonicError

lib/py-sonic/setup.py

@@ -0,0 +1,49 @@
+#!/usr/bin/env python
+
+"""
+This file is part of py-sonic.
+
+py-sonic is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+py-sonic is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with py-sonic.  If not, see <http://www.gnu.org/licenses/>
+"""
+
+from distutils.core import setup
+from libsonic import __version__ as version
+
+setup(name='py-sonic',
+    version=version,
+    author='Jay Deiman',
+    author_email='admin@splitstreams.com',
+    url='http://stuffivelearned.org',
+    description='A python wrapper library for the Subsonic REST API.  '
+        'http://subsonic.org',
+    long_description='This is a basic wrapper library for the Subsonic '
+        'REST API. This will allow you to connect to your server and retrieve '
+        'information and have it returned in basic Python types.',
+    packages=['libsonic'],
+    package_dir={'libsonic': 'libsonic'},
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: System Administrators',
+        'Intended Audience :: Information Technology',
+        'License :: OSI Approved :: GNU General Public License (GPL)',
+        'Natural Language :: English',
+        'Operating System :: POSIX',
+        'Programming Language :: Python',
+        'Topic :: System :: Systems Administration',
+        'Topic :: Internet :: WWW/HTTP',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+        'Topic :: Software Development :: Libraries',
+        'Topic :: System',
+    ]
+)

resources/settings.xml

@@ -1,9 +1,27 @@
 <?xml version="1.0" encoding="utf-8" standalone="yes"?>
 <settings>
-    <setting id="subsonic_url" type="text" label="URL" default="http://demo.subsonic.org"/>
+    <!-- GENERAL -->
-    <setting id="username" type="text" label="Username" default="guest3"/>
+    <category label="General">
-    <setting id="password" type="text" option="hidden" label="Password" default="guest"/>
+        <setting label="Server" type="lsep" />
-    <setting id="random_count" type="labelenum" label="Random songs" values="10|15|20|25"/>
+        <setting id="subsonic_url" type="text" label="Server URL" default="http://demo.subsonic.org"/>
-    <setting id="transcode_format" type="labelenum" label="Transcode format" values="mp3|raw|flv|ogg"/>
+        <setting id="username" type="text" label="Username" default="guest3"/>
-    <setting id="bitrate" type="labelenum" label="Bitrate" values="320|256|224|192|160|128|112|96|80|64|56|48|40|32"/>
+        <setting id="password" type="text" option="hidden" label="Password" default="guest"/>
+        <setting label="Display" type="lsep" />
+        <setting id="albums_per_page" type="labelenum" label="Albums per page" default="50" values="10|25|50|100|250|500"/>
+        <setting id="tracks_per_page" type="labelenum" label="Tracks per page (ignored in albums & playlists)" default="100" values="10|25|50|100|250|500"/>
+        <setting label="Download" type="lsep" />
+        <setting id="download_folder"  type="folder" label="Download folder" source="auto" option="writeable"/>
+        <setting label="Streaming" type="lsep" />
+        <setting id="transcode_format_streaming" type="labelenum" label="Transcode format" values="mp3|raw|flv|ogg"/>
+        <setting id="bitrate_streaming" type="labelenum" label="Bitrate" values="320|256|224|192|160|128|112|96|80|64|56|48|40|32"/>
+    </category>
+    
+    <!-- ADVANCED -->
+  	<category label="Advanced Settings">
+        <setting label="Server" type="lsep" />
+        <setting id="apiversion" type="labelenum" label="API version" values="1.11.0|1.12.0|1.13.0|1.14.0" default="1.13.0"/>
+        <setting id="insecure" type="bool" label="Allow self signed certificates" default="false" />
+        <setting label="Cache (in minutes) - not yet implemented" type="lsep" />
+        <setting id="cachetime" type="labelenum" label="Cache datas time" default="5" values="1|5|15|30|60|120|180|720|1440"/>
+	</category>
 </settings>