olly-iplayer-dl 0.15.2

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/COPYING

@@ -0,0 +1,26 @@
+Copyright (c) 2008 Paul Battley <pbattley@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+If you have received this program as a self-executing bundle, the following
+licences apply to individual components:
+
+ruby: GNU General Public License (GPL), version 2; Ruby License
+rubyscript2exe: GNU General Public License (GPL), version 2
+wxruby: wxWindows Licence

data/README

@@ -0,0 +1,14 @@
+I've refactored iplayer-dl in order to make it easier to extend and wrap. As a
+direct result, it's no longer just one script. As a result, you'll need to
+install the libraries and command-line script in order to use it.
+
+The good news is that this is as easy as typing:
+
+  ruby setup.rb config
+  sudo ruby setup.rb install
+
+Windows users should omit 'sudo' in the second line.
+
+You can then run the downloader just by typing:
+
+  iplayer-dl

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/rdoctask'
+require 'rake'
+require 'find'
+require 'lib/iplayer/version'
+
+# Globals
+
+PKG_NAME = 'iplayer-dl'
+
+PKG_FILES = %w[ COPYING README setup.rb Rakefile ]
+Find.find('lib/', 'test/', 'bin/', 'share/') do |f|
+  if FileTest.directory?(f) and f =~ /\.svn/
+    Find.prune
+  else
+    PKG_FILES << f
+  end
+end
+
+EXE_FILES = PKG_FILES + %w[ application.ico init.rb ]
+
+# Tasks
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test" 
+  t.test_files = FileList['test/test_*.rb']
+end
+
+Rake::PackageTask.new(PKG_NAME, IPlayer::VERSION) do |p|
+  p.need_tar_gz = true
+  p.package_files = PKG_FILES
+end
+
+desc "Build a Windows executable. Needs rubyscript2exe.rb in the current path and the wx gem installed."
+task :exe do |t|
+  mkdir_p 'tmp'
+  build_dir = File.join('tmp', "ipdl-#{IPlayer::GUI_VERSION}")
+  rm_rf build_dir
+  mkdir build_dir
+  EXE_FILES.each do |file|
+    next if File.directory?(file)
+    loc = File.join(build_dir, File.dirname(file))
+    mkdir_p loc
+    cp_r file, loc
+  end
+  sh "ruby rubyscript2exe.rb #{build_dir} --rubyscript2exe-verbose --rubyscript2exe-rubyw"
+  rm_rf build_dir
+  mkdir_p 'pkg'
+  mv "ipdl-#{IPlayer::GUI_VERSION}.exe", "pkg"
+end
+
+begin
+  require 'rubygems'
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "iplayer-dl"
+    gemspec.summary = "Downloads DRM-free video (h.264) and audio (MP3) files from the BBC iPlayer service by pretending to be an iPhone."
+    gemspec.homepage = "http://po-ru.com/projects/iplayer-downloader/"
+    gemspec.description = "Downloads DRM-free video (h.264) and audio (MP3) files from the BBC iPlayer service by pretending to be an iPhone."
+    gemspec.authors = ["Paul Battley"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 15
+:patch: 2
+:major: 0

data/bin/iplayer-dl

@@ -0,0 +1,152 @@
+#!/usr/bin/env ruby
+
+# Download iPlayer programmes by spoofing an iPhone
+# Paul Battley - http://po-ru.com/
+#
+# Get the latest version via subversion:
+# svn co http://paulbattley.googlecode.com/svn/iplayer-dl
+
+require 'iplayer'
+require 'optparse'
+require 'fileutils'
+require 'iplayer/version'
+require 'iplayer/preferences'
+
+include IPlayer
+include IPlayer::Errors
+
+preferences = IPlayer::Preferences.new
+filenames   = []
+pid_list    = nil
+dry_run     = false
+
+opts = ARGV.options{ |o|
+  o.banner << ' IDENTIFIER [IDENTIFIER [...]]'
+  o.define_head 'Download DRM-free videos from the BBC iPlayer, courtesy of their iPhone interface.'
+  o.separator 'IDENTIFIER is the iPlayer viewing page URL or the PID of the programme.'
+  o.separator ''
+  o.on(
+    '-t', '--type-preference=VERSION', String,
+    'Video types in order of preference.',
+    "Default is '#{preferences.type_preference.join(',')}'."
+  ) { |s| preferences.type_preference = s.split(/,\s*/) }
+  o.on(
+    '-d', '--download-path=PATH', String,
+    'Location into which downloaded files will be saved.',
+    'Default is current working directory.'
+  ) { |d| preferences.download_path = d }
+  o.on(
+    '-s', '--title-subdir',
+    'Place downloaded files in a sub-directory named after the title of the programme.'
+  ) { preferences.subdirs = true }
+  o.on(
+    '-u', '--subtitles',
+    'Also download subtitles.'
+  ) { preferences.subtitles = true }
+  o.on(
+    '-f', '--filename=FILENAME', String,
+    'Manually specify a name for the downloaded file.',
+    'The default is constructed from the programme metadata.',
+    'You can specify this multiple times for each download in order.'
+  ) { |f| filenames << f }
+  o.on(
+    '-p', '--http-proxy=HOST:PORT', String,
+    'Specify an HTTP proxy.',
+    'Default is taken from the http_proxy environment variable.'
+  ) { |p| preferences.http_proxy = p }
+  o.on(
+    '-l', '--pid-list=FILENAME', String,
+    'List PIDs to be downloaded in a file, one per line.'
+  ) { |l| pid_list = l }
+  o.on(
+    '-n', '--dry-run', String,
+    'Parse the iPlayer page and output the filename but don\'t actually download (useful for scripting).'
+  ) { |n| dry_run = true }
+  o.on(
+    '-v', '--version',
+    'Show the software version.'
+  ) { puts IPlayer::VERSION; exit }
+  o.on_tail(
+    '-h', '--help', 
+    'Show this help message.'
+  ) { puts o; exit }
+}
+
+begin
+  opts.parse!
+  pids = ARGV
+  if pid_list
+    pids += File.read(pid_list).strip.split(/\s*\r?\n\s*/)
+  end
+  raise 'no programme identifier specified' if pids.empty?
+rescue => exception
+  $stderr.puts 'Error: '+exception, ''
+  puts opts
+  exit 1
+end
+
+if http_proxy = preferences.http_proxy
+  http_proxy = 'http://' + http_proxy unless http_proxy =~ %r{^http://}
+  u = URI.parse(http_proxy)
+  $stderr.puts "Using proxy #{u.host}:#{u.port}"
+  http = Net::HTTP::Proxy(u.host, u.port)
+else
+  http = Net::HTTP
+end
+
+pids.each_with_index do |pid, i|
+  browser = Browser.new(http)
+
+  begin
+    pid = Downloader.extract_pid(pid)
+    downloader = Downloader.new(browser, pid)
+
+    available_versions = downloader.available_versions
+    raise MP4Unavailable if available_versions.empty?
+    version = available_versions.sort_by{ |v| 
+      preferences.type_preference.index(v.name) || 100 
+    }.first
+
+    filename = filenames[i]
+    if filename.nil? || preferences.subdirs
+      metadata = downloader.metadata
+      filename ||= "#{ metadata.full_title }.#{ metadata.filetype }".gsub(/[^a-z0-9 \-\.]+/i, '')
+    end
+    if preferences.subdirs
+      subdir = metadata.title.gsub(/[^a-z0-9 \-\.]+/i, '')
+      path = File.expand_path( File.join( preferences.download_path, subdir ))
+      FileUtils.makedirs(path)
+      path = File.join( path, filename )
+    else
+      path = File.expand_path( File.join( preferences.download_path, filename ))
+    end
+
+    if dry_run
+      $stdout.puts filename
+    else
+      old_percentage = nil
+      first_chunk = true
+
+      $stderr.puts "#{ filename } (version: #{ version.name })"
+      download_options = {:subtitles => preferences.subtitles}
+      downloader.download(version.pid, path, download_options) do |position, max|
+        if first_chunk
+          $stderr.puts "Resuming download at #{position} bytes." if position > 0
+          first_chunk = false
+        end
+        
+        percentage = "%.1f" % [((1000 * position) / max) / 10.0]
+        if percentage != old_percentage
+          old_percentage = percentage
+          $stderr.print "\r#{ percentage }%"
+          $stderr.flush
+        end
+      end
+      $stderr.puts
+    end
+
+  rescue RecognizedError => error
+    $stderr.puts(error.to_str)
+    next
+  end
+end

data/bin/iplayer-dl-gui

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+# Download iPlayer programmes by spoofing an iPhone
+# WxWidgets GUI interface
+# Paul Battley - http://po-ru.com/
+#
+# Get the latest version via subversion:
+# svn co http://paulbattley.googlecode.com/svn/iplayer-dl
+
+require 'iplayer'
+require 'iplayer/gui/app'
+require 'iplayer/gui/main_frame'
+require 'iplayer/version'
+
+options = {
+  :type_preference  => %w[original signed],
+  :http_proxy       => ENV['http_proxy']
+}
+about = {
+  :name        => 'iPlayer Downloader',
+  :version     => "#{IPlayer::GUI_VERSION} (library #{IPlayer::VERSION})",
+  :developers  => ['Paul Battley'],
+  :description => "Download programmes from the BBC iPlayer.\nVisit http://po-ru.com/projects/iplayer-downloader/\nfor more information."
+}
+app = IPlayer::GUI::App.new(IPlayer::GUI::MainFrame, about, options)
+app.main_loop

data/init.rb

@@ -0,0 +1,12 @@
+if defined?(RUBYSCRIPT2EXE)
+  app_root = File.expand_path(File.dirname(__FILE__))
+  $:.unshift(File.join(app_root, 'lib'))
+  if RUBYSCRIPT2EXE.respond_to?(:is_compiling?) && RUBYSCRIPT2EXE.is_compiling?
+    require 'iplayer'
+    require 'iplayer/gui/app'
+    require 'iplayer/gui/main_frame'
+    exit
+  end
+end
+
+load File.join(app_root, 'bin', 'iplayer-dl-gui')

data/iplayer-dl.gemspec

@@ -0,0 +1,67 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{iplayer-dl}
+  s.version = "0.15.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Battley"]
+  s.date = %q{2009-05-18}
+  s.description = %q{Downloads DRM-free video (h.264) and audio (MP3) files from the BBC iPlayer service by pretending to be an iPhone.}
+  s.executables = ["iplayer-dl", "iplayer-dl-gui"]
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "COPYING",
+     "README",
+     "Rakefile",
+     "VERSION.yml",
+     "application.ico",
+     "bin/iplayer-dl",
+     "bin/iplayer-dl-gui",
+     "init.rb",
+     "iplayer-dl.gemspec",
+     "lib/iplayer.rb",
+     "lib/iplayer/browser.rb",
+     "lib/iplayer/downloader.rb",
+     "lib/iplayer/errors.rb",
+     "lib/iplayer/gui/app.rb",
+     "lib/iplayer/gui/main_frame.rb",
+     "lib/iplayer/metadata.rb",
+     "lib/iplayer/preferences.rb",
+     "lib/iplayer/subtitles.rb",
+     "lib/iplayer/version.rb",
+     "setup.rb",
+     "share/pixmaps/iplayer-dl/icon128.png",
+     "share/pixmaps/iplayer-dl/icon16.png",
+     "share/pixmaps/iplayer-dl/icon32.png",
+     "share/pixmaps/iplayer-dl/icon48.png",
+     "share/pixmaps/iplayer-dl/icon64.png",
+     "test/test_metadata.rb",
+     "test/test_preferences.rb",
+     "test/test_subtitles.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://po-ru.com/projects/iplayer-downloader/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Downloads DRM-free video (h.264) and audio (MP3) files from the BBC iPlayer service by pretending to be an iPhone.}
+  s.test_files = [
+    "test/test_metadata.rb",
+     "test/test_preferences.rb",
+     "test/test_subtitles.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/iplayer.rb

@@ -0,0 +1,5 @@
+require 'iplayer/errors'
+require 'iplayer/browser'
+require 'iplayer/metadata'
+require 'iplayer/subtitles'
+require 'iplayer/downloader'

data/lib/iplayer/browser.rb

@@ -0,0 +1,69 @@
+require 'net/http'
+require 'uri'
+
+class Net::HTTPResponse # Monkey-patch in some 21st-century functionality
+  include Enumerable
+  
+  def cookies
+    inject([]){ |acc, (key, value)|
+      key == 'set-cookie' ? acc << value.split(/;/).first : acc
+    }
+  end
+  
+  def to_hash
+    @to_hash ||= inject({}){ |hash, (key, value)|
+      hash[key] = value
+      hash
+    }
+  end
+end
+
+module IPlayer
+class Browser
+
+  # Used by Safari Mobile
+  IPHONE_UA  = 'Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ '+
+               '(KHTML, like Gecko) Version/3.0 Mobile/1A543a Safari/419.3'
+
+  # Used by Quicktime
+  QT_UA      = 'Apple iPhone v1.1.4 CoreMedia v1.0.0.4A102'
+
+  # Safari, for no good reason
+  DESKTOP_UA = 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_4; en-gb) '+
+               'AppleWebKit/525.18 (KHTML, like Gecko) Version/3.1.2 Safari/525.20.1'
+
+  DEFAULT_HEADERS = {
+    'Accept'          => '*/*',
+    'Accept-Language' => 'en',
+    'Connection'      => 'keep-alive',
+    'Pragma'          => 'no-cache'
+  }
+
+  def initialize(http_class = Net::HTTP)
+    @http_class = http_class
+  end
+
+  def get(location, headers={}, &blk)
+    url = URI.parse(location)
+    http = @http_class.new(url.host, url.port)
+    path = url.path
+    if url.query
+      path << '?' << url.query
+    end
+    if defined? DEBUG
+      puts path
+      DEFAULT_HEADERS.merge(headers).each do |k,v|
+        puts " -> #{k}: #{v}"
+      end
+    end
+    response = http.request_get(path, DEFAULT_HEADERS.merge(headers), &blk)
+    if defined? DEBUG
+      response.each do |k,v|
+        puts "<-  #{k}: #{v}"
+      end
+    end
+    response
+  end
+
+end
+end