olly-iplayer-dl 0.15.2

data/lib/iplayer/downloader.rb

@@ -0,0 +1,132 @@
+require 'tempfile'
+
+module IPlayer
+class Downloader
+
+  IPHONE_URL     = 'http://www.bbc.co.uk/mobile/iplayer/index.html'
+  SELECTOR_URL   = 'http://www.bbc.co.uk/mediaselector/3/auth/iplayer_streaming_http_mp4/%s?%s'
+  BUG_URL        = 'http://www.bbc.co.uk/iplayer/framework/img/o.gif?%d'
+  MAX_SEGMENT    = 4 * 1024 * 1024
+  COPY_BUFFER    = 4 * 1024 * 1024
+
+  include IPlayer::Errors
+
+  Version = Struct.new(:name, :pid)
+
+  attr_reader   :browser, :pid
+  attr_accessor :cookies
+
+  def self.extract_pid(pid_or_url)
+    case pid_or_url
+    when %r!/(?:item|episode|programmes)/([a-z0-9]{8})!
+      $1
+    when %r!^[a-z0-9]{8}$!
+      pid_or_url
+    when %r!(b0[a-z0-9]{6})!
+      $1
+    else
+      raise NotAPid, pid_or_url
+    end
+  end
+
+  def initialize(browser, pid)
+    @browser = browser
+    @pid = pid
+  end
+
+  def metadata
+    @metadata = Metadata.new(@pid, @browser)
+  end
+
+  def get(url, user_agent, options={}, &blk)
+    options['User-Agent'] = user_agent
+    options['Cookie'] = cookies if cookies
+    browser.get(url, options, &blk)
+  end
+  
+  def available_versions
+    metadata.versions.map{ |name, vpid| Version.new(name, vpid) }
+  end
+
+  def download(version_pid, path, options={}, &blk)
+    if options[:subtitles]
+      download_subtitles(version_pid, path)
+    end
+
+    if File.exist?(path)
+      offset = File.size(path)
+    else
+      offset = 0
+    end
+    
+    File.open(path, 'a+b') do |io|    
+      location = real_stream_location(version_pid)
+      content_length = content_length_from_initial_request(location)
+      yield(offset, content_length) if block_given?
+      
+      offset.step(content_length - 1, MAX_SEGMENT) do |first_byte|
+        last_byte = [first_byte + MAX_SEGMENT - 1, content_length - 1].min
+        get(location, Browser::QT_UA, 'Range'=>"bytes=#{first_byte}-#{last_byte}") do |response|
+          response.read_body do |data|
+            offset += data.length
+            io << data
+            yield(offset, content_length) if block_given?
+          end
+        end
+      end
+    end
+  end
+
+private
+
+  def request_iphone_page
+    response = get(IPHONE_URL, Browser::IPHONE_UA)
+    raise ProgrammeDoesNotExist unless response.is_a?(Net::HTTPSuccess)
+    self.cookies = response.cookies.join('; ')
+  end
+
+  def request_image_bugs
+    get(BUG_URL % [(rand * 100000).floor], Browser::IPHONE_UA)
+  end
+
+  def real_stream_location(version_pid)
+    request_iphone_page
+    request_image_bugs
+
+    # Get the auth URL
+    r = (rand * 10000000).floor
+    selector = SELECTOR_URL % [version_pid, r]
+    response = get(selector, Browser::QT_UA, 'Range'=>'bytes=0-1')
+    
+    # It redirects us to the real stream location
+    location = response.to_hash['location']
+    if location =~ /error\.shtml/
+      raise FileUnavailable
+    end
+    return location
+  end
+
+  def content_length_from_initial_request(location)
+    # The first request of CoreMedia is always for the first byte
+    response = get(location, Browser::QT_UA, 'Range'=>'bytes=0-1')
+
+    # We now know the full length of the content
+    content_range = response.to_hash['content-range']
+    unless content_range
+      raise FileUnavailable
+    end
+    return content_range[/\d+$/].to_i
+  end
+
+  def download_subtitles(version_pid, media_path)
+    subtitles = Subtitles.new(version_pid, browser)
+    xml = subtitles.w3c_timed_text
+    return if xml.nil?
+    subtitles_path = media_path.sub(/\.[^\.]+$/, '.xml')
+    return if File.exist?(subtitles_path)
+    File.open(subtitles_path, 'w') do |f|
+      f << xml
+    end
+  end
+end
+end

data/lib/iplayer/errors.rb

@@ -0,0 +1,53 @@
+module IPlayer
+module Errors
+  class RecognizedError < RuntimeError
+  end
+
+  class ParsingError < RecognizedError
+    def to_str
+      "Unable to parse the programme page. Perhaps the iPlayer has changed." 
+    end
+  end
+
+  class OutsideUK < RecognizedError
+    def to_str
+      "The BBC's geolocation has determined that you are outside the UK.\n"+
+      "You can try using a UK proxy."
+    end
+  end
+
+  class FileUnavailable < RecognizedError
+    def to_str
+      "The programme file is not currently available.\n"+
+      "If it's new, try again later."
+    end
+  end
+  
+  class MP4Unavailable < RecognizedError
+    def to_str
+      "This programme is not currently available in an MP3 or MPEG4 version."
+    end
+  end
+
+  class MetadataError < RecognizedError
+    def to_str
+      "Unable to parse the metadata for this programme.\n"+
+      "As a workaround, you can use the -f option to specify a filename manually."
+    end
+  end
+
+  class ProgrammeDoesNotExist < RecognizedError
+    def to_str
+      "There is no page for this programme.\n"+
+      "This probably means that the programme does not exist."
+    end
+  end
+
+  class NotAPid < RecognizedError
+    def to_str
+      "This does not look like a programme ID or a recognised programme URL: "+ message
+    end
+  end
+
+end
+end

data/lib/iplayer/gui/app.rb

@@ -0,0 +1,84 @@
+require 'wx'
+require 'iplayer'
+
+module IPlayer
+module GUI
+class App < Wx::App
+  include IPlayer
+  include IPlayer::Errors
+
+  def initialize(initial_frame_class, about, options)
+    @initial_frame_class = initial_frame_class
+    @about = about
+    @options = options
+    super()
+    if http_proxy = @options[:http_proxy]
+      http_proxy = 'http://' + http_proxy unless http_proxy =~ %r{^http://}
+      u = URI.parse(http_proxy)
+      http = Net::HTTP::Proxy(u.host, u.port)
+    else
+      http = Net::HTTP
+    end
+    @browser = Browser.new(http)
+    @flags = {}
+  end
+
+  def on_init
+    @initial_frame_class.new(self).show
+  end
+
+  def download(pid, path)
+    downloader = Downloader.new(@browser, pid)
+    available_versions = downloader.available_versions
+    raise MP4Unavailable if available_versions.empty?
+    version = available_versions.sort_by{ |v| 
+      @options[:type_preference].index(v.name) || 100 
+    }.first
+
+    self.yield
+
+    downloader.download(version.pid, path) do |position, max|
+      return if check_flag(:stop_download)
+      yield position, max
+      self.yield
+    end
+  end
+
+  def stop_download!
+    set_flag(:stop_download)
+  end
+
+  def get_default_filename(pid)
+    self.yield
+    begin
+      metadata = Metadata.new(pid, @browser)
+      title    = metadata.full_title
+      filetype = metadata.filetype
+    rescue MetadataError
+      title    = pid
+      filetype = 'mov'
+    end
+    "#{ title }.#{ filetype }".gsub(/[^a-z0-9 \-\.]+/i, '')
+  end
+
+  def name
+    @about[:name]
+  end
+
+  def show_about_box
+    Wx::about_box(@about)
+  end
+
+private
+  def set_flag(name)
+    @flags[name] = true
+  end
+
+  def check_flag(name)
+    retval = !!@flags[name]
+    @flags.delete(name)
+    retval
+  end
+end
+end
+end

data/lib/iplayer/gui/main_frame.rb

@@ -0,0 +1,123 @@
+require 'wx'
+require 'iplayer/errors'
+
+module IPlayer
+module GUI
+class MainFrame < Wx::Frame
+  include Wx
+  include IPlayer::Errors
+
+  def initialize(app)
+    @app = app
+
+    super(nil, -1, @app.name, DEFAULT_POSITION, DEFAULT_SIZE, CAPTION|MINIMIZE_BOX|CLOSE_BOX|SYSTEM_MENU)
+
+    @pid_label = StaticText.new(self, -1, "Programme ID")
+    @pid_field = TextCtrl.new(self, -1, "", DEFAULT_POSITION, Size.new(300,-1))
+    @pid_field.set_tool_tip("Use either the short alphanumeric programme identifier or the URL of the viewing page on the iPlayer website.")
+    @download_progress = Gauge.new(self, -1, 1, DEFAULT_POSITION, DEFAULT_SIZE, GA_HORIZONTAL|GA_SMOOTH)
+    @stop_button = Button.new(self, -1, "Stop")
+    evt_button(@stop_button.get_id){ |e| stop_button_clicked(e)   }
+    @stop_button.disable
+    @download_button = Button.new(self, -1, "Download...")
+    evt_button(@download_button.get_id){ |e| download_button_clicked(e) }
+    @about_button = Button.new(self, -1, "About...")
+    evt_button(@about_button.get_id){ |e| about_button_clicked(e) }
+    @status_bar = StatusBar.new(self, -1, 0)
+    @status_bar.set_fields_count(3)
+    @status_bar.set_status_widths([-1, 60, 60])
+    set_status_bar(@status_bar)
+    @status_bar.set_status_text("Waiting", 0)
+
+    set_properties
+    do_layout
+  end
+
+  def set_properties
+    set_background_colour(SystemSettings.get_colour(SYS_COLOUR_3DFACE))
+    relative_icon_path = File.join('share', 'pixmaps', 'iplayer-dl', 'icon32.png')
+    icon_path = [
+      File.join(File.dirname($0), '..', relative_icon_path),
+      File.join(File.dirname(__FILE__), '..', '..', '..', relative_icon_path)
+    ].find{ |p| File.exist?(p) }
+    self.icon = Icon.new(icon_path, BITMAP_TYPE_PNG) if icon_path
+  end
+
+  def do_layout
+    sizer_main = BoxSizer.new(VERTICAL)
+    sizer_buttons = BoxSizer.new(HORIZONTAL)
+    sizer_input = BoxSizer.new(HORIZONTAL)
+    sizer_input.add(@pid_label, 0, ALL|ALIGN_CENTER_VERTICAL, 4)
+    sizer_input.add(@pid_field, 0, ALL|EXPAND|ALIGN_CENTER_VERTICAL, 4)
+    sizer_main.add(sizer_input, 0, EXPAND, 0)
+    sizer_main.add(@download_progress, 0, ALL|EXPAND, 4)
+    sizer_buttons.add(@about_button, 0, ALL, 4)
+    sizer_buttons.add(@stop_button, 0, ALL, 4)
+    sizer_buttons.add(@download_button, 0, ALL, 4)
+    sizer_main.add(sizer_buttons, 0, ALIGN_RIGHT|ALIGN_CENTER_HORIZONTAL, 0)
+    self.set_sizer(sizer_main)
+    sizer_main.fit(self)
+    layout
+    centre
+  end
+
+  def stop_button_clicked(event)
+    @app.stop_download!
+    @status_bar.set_status_text("Stopped", 0)
+    @download_button.enable
+    @stop_button.disable
+  end
+
+  def download_button_clicked(event)
+    pid = @pid_field.get_value
+    if pid.empty?
+      message_box('You must specify a programme ID before I can download it.')
+      return
+    else
+      begin
+        pid = Downloader.extract_pid(pid)
+      rescue NotAPid => error
+        message_box(error.to_str, :title => 'Error')
+        return
+      end
+    end
+
+    @download_button.disable
+    filename = @app.get_default_filename(pid)
+
+    fd = FileDialog.new(nil, 'Save as', '', filename, 'iPlayer Programmes|*.mov;*.mp3|', FD_SAVE)
+
+    if fd.show_modal == ID_OK
+      path = fd.get_path
+      @status_bar.set_status_text(File.basename(path), 0)
+      @download_button.disable
+      @stop_button.enable
+      begin
+        @app.download(pid, path) do |position, max|
+          @download_progress.set_range(max)
+          @download_progress.set_value(position)
+          percentage = "%.1f" % [((1000.0 * position) / max).round / 10.0]
+          @status_bar.set_status_text("#{(max.to_f / 2**20).round} MiB", 1) 
+          @status_bar.set_status_text(percentage+"%", 2) 
+        end
+      rescue RecognizedError => error
+        message_box(error.to_str, :title => 'Error')
+      rescue Exception => error
+        message_box("#{error.message} (#{error.class})\n#{error.backtrace.first}", :title => 'Error')
+      end
+      @stop_button.disable
+    end
+    @download_button.enable
+  end
+
+  def about_button_clicked(event)
+    @app.show_about_box
+  end
+
+  def message_box(message, options={})
+    options = {:title => @app.name, :buttons => OK}.merge(options)
+    MessageDialog.new(self, message, options[:title], options[:buttons]).show_modal
+  end
+end
+end
+end

data/lib/iplayer/metadata.rb

@@ -0,0 +1,63 @@
+require 'rexml/document'
+require 'iplayer/errors'
+
+module IPlayer
+class Metadata
+  include IPlayer::Errors
+
+  METADATA_URL = 'http://www.bbc.co.uk/iplayer/playlist/%s'
+
+  def initialize(pid, browser)
+    @pid = pid
+    @browser = browser
+  end
+
+  def title
+    mixed_title.split(/:/).first
+  end
+
+  def full_title
+    mixed_title.gsub(/\s*:\s*/, ' - ')
+  end
+
+  def filetype
+    radio? ? 'mp3' : 'mov'
+  end
+
+  def versions
+    versions = {}
+    REXML::XPath.each(metadata, '//playlist/item') do |node|
+      version_pid = node.attributes['identifier'] or next
+      alternate_id = REXML::XPath.first(node, 'alternate').attributes['id'] rescue 'anonymous'
+      versions[alternate_id] = version_pid
+    end
+    versions
+  end
+
+private
+
+  def metadata
+    @metadata ||= REXML::Document.new( @browser.get(METADATA_URL % @pid).body )
+  rescue Exception => e
+    raise MetadataError, e.message
+  end
+
+  def mixed_title
+    REXML::XPath.first(metadata, '//playlist/title').text
+  end
+
+  def programme_type
+    # this could be done more easily if REXML actually worked properly
+    REXML::XPath.each(metadata, '//playlist/item') do |node|
+      kind = node.attributes['kind']
+      return kind if kind
+    end
+    return nil
+  end
+
+  def radio?
+    programme_type == 'radioProgramme'
+  end
+
+end
+end