itunes-controller 0.1.0

data/lib/itunesController/platform.rb

@@ -0,0 +1,53 @@
+#
+# Copyright (C) 2011-2012  John-Paul.Stanford <dev@stanwood.org.uk>
+#
+# 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/>.
+#
+# Author:: John-Paul Stanford <dev@stanwood.org.uk>
+# Copyright:: Copyright (C) 2011  John-Paul.Stanford <dev@stanwood.org.uk>
+# License:: GNU General Public License v3 <http://www.gnu.org/licenses/>
+#
+
+module ItunesController
+
+    class Platform
+
+        def self.getUserHomeDir()
+            homes = ["HOME", "HOMEPATH"]
+            realHome = homes.detect {|h| ENV[h] != nil}
+            if not realHome
+                raise "Could not find home directory"
+            end
+            
+            return ENV[realHome]
+        end
+
+        def self.isWindows()
+            return RUBY_PLATFORM =~ /mswin|mingw/
+        end
+
+        def self.isMacOSX()
+            return RUBY_PLATFORM =~ /darwin/
+        end
+
+        def self.isLinux()
+            return RUBY_PLATFORM =~ /linux/
+        end
+
+        def self.isJRuby()
+            return RUBY_PLATFORM =~ /java/
+        end
+    end
+end
+

data/lib/itunesController/sqlite_creator.rb

@@ -0,0 +1,35 @@
+#
+# Copyright (C) 2011-2012  John-Paul.Stanford <dev@stanwood.org.uk>
+#
+# 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/>.
+#
+# Author:: John-Paul Stanford <dev@stanwood.org.uk>
+# Copyright:: Copyright (C) 2011  John-Paul.Stanford <dev@stanwood.org.uk>
+# License:: GNU General Public License v3 <http://www.gnu.org/licenses/>
+#
+
+require 'itunesController/database/sqlite3_backend'
+require 'itunesController/itunescontroller_factory'
+require 'itunesController/controller_creator'
+
+module ItunesController  
+
+    class SQLLiteControllerCreator < ControllerCreator    
+        def createController()            
+            dbBackend = ItunesController::SQLite3DatabaseBackend.new(nil)
+            return ItunesController::CachedController.new(ItunesController::ITunesControllerFactory::createController(),dbBackend)
+        end
+    end    
+    
+end

data/lib/itunesController/track.rb

@@ -0,0 +1,39 @@
+#
+# Copyright (C) 2011-2012  John-Paul.Stanford <dev@stanwood.org.uk>
+#
+# 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/>.
+#
+# Author:: John-Paul Stanford <dev@stanwood.org.uk>
+# Copyright:: Copyright (C) 2011  John-Paul.Stanford <dev@stanwood.org.uk>
+# License:: GNU General Public License v3 <http://www.gnu.org/licenses/>
+#
+
+module ItunesController
+    
+    # Used to store track information
+    class Track
+        attr_accessor :location,:databaseId,:title
+        
+        def initialize(location,databaseId,title)
+            @location = location
+            @databaseId = databaseId
+            @title = title
+        end
+        
+        def to_s
+            return "Location: '#{@location}' - Database ID: #{@databaseId} - Title: '#{@title}' "
+        end
+    end
+
+end

data/lib/itunesController/version.rb

@@ -0,0 +1,25 @@
+#
+# Copyright (C) 2011-2012  John-Paul.Stanford <dev@stanwood.org.uk>
+#
+# 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/>.
+#
+# Author:: John-Paul Stanford <dev@stanwood.org.uk>
+# Copyright:: Copyright (C) 2011  John-Paul.Stanford <dev@stanwood.org.uk>
+# License:: GNU General Public License v3 <http://www.gnu.org/licenses/>
+#
+
+module ItunesController
+    # The itunes-remote-control-server version
+    VERSION = "0.1.0"
+end

data/lib/itunesController/windows_itunescontroller.rb

@@ -0,0 +1,145 @@
+#
+# Copyright (C) 2011-2012  John-Paul.Stanford <dev@stanwood.org.uk>
+#
+# 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/>.
+#
+# Author:: John-Paul Stanford <dev@stanwood.org.uk>
+# Copyright:: Copyright (C) 2011  John-Paul.Stanford <dev@stanwood.org.uk>
+# License:: GNU General Public License v3 <http://www.gnu.org/licenses/>
+#
+
+require 'itunesController/itunescontroller'
+require 'itunesController/kinds'
+require 'itunesController/debug'
+require 'itunesController/logging'
+require 'win32ole'
+
+module ItunesController
+
+    class WindowsITunesController < ItunesController::BaseITunesController
+
+        # The constructor
+        def initialize
+            @iTunes = WIN32OLE.new('iTunes.Application')
+            @libraryPlaylists=@iTunes.LibraryPlaylist
+        end
+
+        # Used to get the iTunes version
+        # @return [String] The itunes version
+        def version
+            return @iTunes.version.to_s+" (Windows)"
+        end
+
+        # Used to tell iTunes to refresh a list of tracks data from the info stored in the files
+        # @param [Array] tracks A list of tracks to fresh
+        def refreshTracks(tracks)
+            tracks.reverse.each do | track |                
+                track.UpdateInfoFromFile
+            end
+        end
+
+        # Used to remove tracks from the libaray
+        # @param [Array] tracks A list of tracks to remove from the itunes libaray
+        def removeTracksFromLibrary(tracks)
+            tracks.reverse.each do | track |               
+                track.Delete
+            end
+        end
+
+        # Used to add a list of files to the itunes library
+        # @param [Array[String]] A list of files to add to the itunes library
+        # @return [Array[ItunesController::Track]] List of ids of the new tracks once they are in the database
+        def addFilesToLibrary(files)
+            tracks=[]
+            files.each do | file |
+                if (!File.exist?(file))
+                    ItunesController::ItunesControllerLogging::error("Unable to find file #{file}")
+                else
+                    itracks=@libraryPlaylists.AddFile(file)   
+                    if (itracks!=nil)
+                        itracks=itracks.Tracks                                                         
+                        for i in (1..itracks.Count())                      
+                            itrack=itracks.Item(i)
+                            track=ItunesController::Track.new(file,itrack.TrackDatabaseID,itrack.Name)
+                            tracks.push(track)
+                        end                                                             
+                    else
+                        ItunesController::ItunesControllerLogging::error("Unable to add file '#{file}'")                         
+                    end
+                end
+            end
+
+            return tracks;
+        end
+
+        def getTracks(&b)
+            ItunesController::ItunesControllerLogging::debug("Retriving track information...")
+            playlist=@libraryPlaylists
+            fileTracks = playlist.Tracks
+            size = fileTracks.Count()
+            count = 1
+            for count in (1..size)
+                track=fileTracks.Item(count)
+                location=track.location            
+                dead=false
+                if (location!=nil)                   
+                    if (!File.exist?(location))
+                        dead = true
+                    end
+                else
+                    dead = true
+                end                
+                if (count % 1000 == 0)
+                    ItunesController::ItunesControllerLogging::debug("Found tracks #{count} of #{size}")
+                end
+                if (track.name!=nil)
+                    b.call(ItunesController::Track.new(location,track.TrackDatabaseID,track.name),count,size,dead)
+                end
+                count=count+1
+            end
+            ItunesController::ItunesControllerLogging::debug("Found tracks #{count-1} of #{size}")
+            return size
+        end
+
+        # Used to find the number of tracks in the library
+        # @return [Number] The number of tracks
+        def getTrackCount()                          
+            return @libraryPlaylists.Tracks.Count()
+        end
+
+        # Used to search the itunes library
+        # @param term The search term
+        # @return [Array] a list of iTunes track that match the search term
+        def searchLibrary(term)
+            tracks=[]
+            playlist=@libraryPlaylists                             
+            foundTracks = playlist.Search(term,1)            
+            if (foundTracks!=nil)
+                foundTracks.each do | t |
+                    tracks.push(t)
+                end
+            end
+           
+            return tracks
+        end              
+        
+        # Used to get the database of a itunes track
+        # @abstract Must be overridden
+        # @param track the track
+        # @return The database id
+        def getTrackDatabaseId(track)
+            return track.TrackDatabaseID()
+        end
+    end
+end

data/test/base_server_test_case.rb

@@ -0,0 +1,125 @@
+
+require 'tempfile'
+require 'test/unit'
+require 'socket'
+require 'timeout'
+
+require 'itunesController/platform'
+require 'itunesController/config'
+require 'itunesController/dummy_itunescontroller'
+require 'itunesController/controllserver'
+require 'itunesController/cachedcontroller'
+require 'itunesController/controller_creator'
+
+require 'itunesController/database/sqlite3_backend'
+
+class DummyControllerCreator < ItunesController::ControllerCreator
+    
+    def initialize(controller)
+        @controller = controller
+    end
+    
+    def createController()
+        return @controller
+    end
+end
+
+class BaseServerTest < Test::Unit::TestCase 
+    
+    USER="test"
+    PASSWORD="testpass"
+    MIN_PORT_NUMBER = 5000
+    MAX_PORT_NUMBER = 9000
+    
+    attr_accessor :server,:port
+    
+    def portOpen?(ip, port, seconds=1)
+      Timeout::timeout(seconds) do
+        begin
+          TCPSocket.new(ip, port).close
+          true
+        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+          false
+        end
+      end
+    rescue Timeout::Error
+      false
+    end
+    
+    def findAvaliablePort
+        port=BaseServerTest::MIN_PORT_NUMBER   
+        while (port < BaseServerTest::MAX_PORT_NUMBER )
+            if !portOpen?("127.0.0.1",port)
+                return port
+            end        
+            port+=1        
+        end   
+        return -1
+    end
+    
+    def setupServer(tracks=nil)
+        ItunesController::DummyITunesController::resetCommandLog()
+        ItunesController::DummyITunesController::resetTracks()        
+        if (tracks!=nil)
+            tracks.each do | track |
+                ItunesController::DummyITunesController::forceAddTrack(track)
+            end 
+        end        
+        
+        ItunesController::DummyITunesController::getCommandLog().take_while {
+            | el |
+        }
+        @dbFile = Tempfile.new('dummyDatabase.db')
+        itunes = ItunesController::DummyITunesController.new        
+        dbBackend = ItunesController::SQLite3DatabaseBackend.new(@dbFile.path) 
+        controller = ItunesController::CachedController.new(itunes,dbBackend)        
+        config=ItunesController::ServerConfig.new
+        config.port = findAvaliablePort
+        @port = config.port
+        config.username = BaseServerTest::USER
+        config.password = BaseServerTest::PASSWORD
+        @server=ItunesController::ITunesControlServer.new(config,config.port,DummyControllerCreator.new(controller))        
+    end
+    
+    def teardownServer
+        @server.stop
+        while !@server.stopped?
+        end
+        @server.join
+        @dbFile.unlink
+    end
+
+    def test_dummy
+    end
+    
+    def assertCommandLog(expected)
+        sleep(2)
+        @server.waitForEmptyJobQueue()
+        actual=ItunesController::DummyITunesController::getCommandLog()
+        error=false
+        if (expected.size()!=actual.size()) 
+            puts("Worng number of command log entries")
+            error = true
+        end
+            
+        
+        for i in (0..expected.size())
+            if (expected[i]!=actual[i])
+                error=true
+            end
+        end
+        if (error)
+            puts("Command log did not match expected.")
+            puts("Expected:")
+            expected.each do | line |
+                puts("  "+line)
+            end
+            puts("Actual:")
+            actual.each do | line |
+                puts("  "+line)
+            end
+            raise("Command log did not match expected.")
+        end
+    end
+        
+end

data/test/dummy_client.rb

@@ -0,0 +1,44 @@
+
+require 'net/telnet'
+
+require 'itunesController/controllserver'
+
+class DummyClient
+    
+    DEFAULT_TIMEOUT=40    
+    
+    def connect(hostname,port)
+        @client=Net::Telnet::new('Host' => hostname,
+                                 'Port' => port,
+                                 'Telnetmode' => false)        
+        @client.waitfor('String'=>"001 hello")
+        sendCommand("HELO",220)
+    end
+    
+   
+    def disconnect
+        @client.close
+    end
+    
+    def login(username,password)
+        sendCommand(ItunesController::CommandName::LOGIN+":"+username,222); 
+        sendCommand(ItunesController::CommandName::PASSWORD+":"+password,223); 
+    end
+    
+    def sendCommand(cmd, expectedCode,timeout=DummyClient::DEFAULT_TIMEOUT)
+        @client.cmd(cmd) do | response |            
+            if (response!=nil)            
+                response.each_line do | line |                                
+                    if ( line =~ /(\d+).*/)                    
+                        code=$1
+                        if (code.to_i==expectedCode)                    
+                            return;
+                        end
+                    end
+                end
+            end         
+            raise "Did not recive expected response from server"   
+        end        
+    end
+        
+end