octopod-exe 0.9.4

data/lib/jekyll/octopod_filters.rb

@@ -0,0 +1,336 @@
+require 'uri'
+require 'digest/sha1'
+
+module Jekyll
+  module OctopodFilters
+    JSON_ENTITIES = { '&' => '\u0026', '>' => '\u003E', '<' => '\u003C', "'" => '\u0027' }
+
+    # Escapes  some text for CDATA
+    def cdata_escape(input)
+      input.gsub(/<!\[CDATA\[/, '&lt;![CDATA[').gsub(/\]\]>/, ']]&gt;')
+    end
+
+    # Escapes HTML entities in JSON strings.
+    # More or less a copy of the equivalent method in Active Support.
+    # https://github.com/rails/rails/tree/master/activesupport
+    def j(str)
+      str.to_s.gsub(/[&"><']/) { |e| JSON_ENTITIES[e] }
+    end
+
+    # Replaces relative urls with full urls
+    #
+    #   {{ "about.html" | expand_urls }}             => "/about.html"
+    #   {{ "about.html" | expand_urls:site.url }}  => "http://example.com/about.html"
+    def expand_urls(input, url='')
+      url ||= '/'
+      input.gsub /(\s+(href|src)\s*=\s*["|']{1})(\/[^\"'>]*)/ do
+        $1+url+$3
+      end
+    end
+
+    # Removes scripts tag and audio tags in multiline moderator
+    def remove_script_and_audio(input)
+      input.gsub(/<audio.*audio>/m, '').gsub(/<script.*script>/m, '')
+    end
+
+    # Formats a Time to be RSS compatible like "Wed, 15 Jun 2005 19:00:00 GMT"
+    #
+    #   {{ site.time | time_to_rssschema }}
+    def time_to_rssschema(time)
+      time.strftime("%a, %d %b %Y %H:%M:%S %z")
+    end
+
+    # Returns the first argument if it's not nil or empty otherwise it returns
+    # the second one.
+    #
+    #   {{ post.author | otherwise:site.author }}
+    def otherwise(first, second)
+      first = first.to_s
+      first.empty? ? second : first
+    end
+
+    # Returns the audio file name of a given hash. Is no key as second parameter given, it
+    # trys first "mp3", than "m4a" and than it will return a more or less random
+    # value.
+    #
+    #   {{ post.audio | audio:"m4a" }} => "my-episode.m4a"
+    def audio(hsh, key = nil)
+      if key.nil?
+        hsh['mp3'] ? hsh['mp3'] : hsh['m4a'] ? hsh['m4a'] : hsh['ogg'] ? hsh['ogg'] : hsh['opus'] ? hsh['opus'] : hsh.values.first
+      else
+        hsh[key]
+      end
+    end
+
+
+    # Returns the audio-type of a given hash. Is no key as second parameter given, it
+    # trys first "mp3", than "m4a" and than it will return a more or less random
+    # value.
+    #
+    #   {{ post.audio | audiotype }} => "my-episode.m4a"
+    def audio_type(hsh)
+      hsh['mp3'] ? mime_type('mp3') : hsh['m4a'] ? mime_type('m4a') : hsh['ogg'] ? mime_type('ogg') : mime_type('opus')
+    end
+
+
+    # Returns the MIME-Type of a given file format.
+    #
+    #   {{ "m4a" | mime_type }} => "audio/mp4a-latm"
+    def mime_type(format)
+      types = {
+        'mp3'  => 'mpeg',
+        'm4a'  => 'mp4a-latm',
+        'ogg'  => 'ogg; codecs=vorbis',
+        'opus' => 'ogg; codecs=opus'
+      }
+
+      "audio/#{types[format]}"
+    end
+
+    # Returns the size of a given file in bytes. If there is just a filename
+    # without a path, this method assumes that the file is an episode audio file
+    # which lives in /episodes.
+    #
+    #   {{ "example.m4a" | file_size }} => 4242
+    def file_size(path, rel = nil)
+      return 0 if path.nil?
+      path = path =~ /\// ? path : File.join('episodes', path)
+      path = rel + path if rel
+      File.size(path)
+    end
+
+    # Returns a slug based on the id of a given page.
+    #
+    #   {{ page | slug }} => '2012_10_02_octopod'
+    def slug(page)
+      page['id'][1..-1].gsub('/', '_')
+    end
+
+    # Returns the image of the post or the default logo.
+    #
+    #   {{ page | image_with_fallback }} => '/path/to/image.png'
+    def image_with_fallback(page)
+      if page["image"]
+        "/img/" + page["image"]
+      else
+        "/img/logo-itunes.jpg"
+      end
+    end
+
+    # Returns the dowrload url with fallback to the site's episode folder url
+    def download_url_with_fallback(site)
+      if site["download_url"] == "" or site["download_url"] == nil
+        site["url"] + "/episodes"
+      else
+        site["download_url"]
+      end
+    end
+
+
+    # Splits a chapter, like it is written to the post YAML front matter into
+    # the components 'start' which refers to a single point in time relative to
+    # the beginning of the media file nad 'title' which defines the text to be
+    # the title of the chapter.
+    #
+    #   {{ '00:00:00.000 Welcome to Octopod!' | split_chapter }}
+    #     => { 'start' => '00:00:00.000', 'title' => 'Welcome to Octopod!' }
+    #
+    #   {{ '00:00:00.000 Welcome to Octopod!' | split_chapter:'title' }}
+    #     => 'Welcome to Octopod!'
+    #
+    #   {{ '00:00:00.000 Welcome to Octopod!' | split_chapter:'start' }}
+    #     => '00:00:00.000'
+    def split_chapter(chapter_str, attribute = nil)
+      attributes = chapter_str.split(/ /, 2)
+      return nil unless attributes.first.match(/\A(\d|:|\.)+\z/)
+
+      if attribute.nil?
+        { 'start' => attributes.first, 'title' => attributes.last }
+      else
+        attribute == 'start' ? attributes.first : attributes.last
+      end
+    end
+
+
+    # Gets a number of seconds and returns an human readable duration string of
+    # it.
+    #
+    #   {{ 1252251 | string_of_duration }} => "00:03:13"
+    def string_of_duration(duration)
+      seconds = duration.to_i
+      minutes = seconds / 60
+      hours   = minutes / 60
+
+      "#{"%02d" % hours}:#{"%02d" % (minutes % 60)}:#{"%02d" % (seconds % 60)}"
+    end
+
+    # Gets a number of bytes and returns an human readable string of it.
+    #
+    #   {{ 1252251 | string_of_size }} => "1.19M"
+    def string_of_size(bytes)
+      bytes = bytes.to_i.to_f
+      out = '0'
+      return out if bytes == 0.0
+
+      jedec = %w[b K M G]
+      [3, 2, 1, 0].each { |i|
+        if bytes > 1024 ** i
+          out = "%.1f#{jedec[i]}" % (bytes / 1024 ** i)
+          break
+        end
+      }
+
+      return out
+    end
+
+    # Returns the host a given url
+    #
+    #   {{ 'https://github.com/pattex/octopod' | host_from_url }} => "github.com"
+    def host_from_url(url)
+      URI.parse(url).host
+    end
+
+    # Generates the config for disqus integration
+    # If a page object is given, it generates the config variables only for this
+    # page. Otherwise it generate only the global config variables.
+    #
+    #   {{ site | disqus_config }}
+    #   {{ site | disqus_config:page }}
+    def disqus_config(site, page = nil)
+      if page
+        disqus_vars = {
+          'disqus_identifier'  => page['url'],
+          'disqus_url'         => "#{site['url']}#{page['url']}",
+          'disqus_category_id' => page['disqus_category_id'] || site['disqus_category_id'],
+          'disqus_title'       => j(page['title'] || site['site'])
+        }
+      else
+        disqus_vars = {
+          'disqus_developer'   => site['disqus_developer'],
+          'disqus_shortname'   => site['disqus_shortname']
+        }
+      end
+
+      disqus_vars.delete_if { |_, v| v.nil? }
+      disqus_vars.map { |k, v| "var #{k} = '#{v}';" }.compact.join("\n")
+    end
+
+    # Returns the hex-encoded hash value of a given string. The optional
+    # second argument defines the length of the returned string.
+    #
+    #   {{ "Octopod" | sha1 }} => "8b20a59c"
+    #   {{ "Octopod" | sha1:23 }} => "8b20a59c8e2dcb5e1f845ba"
+    def sha1(str, lenght = 8)
+      sha1 = Digest::SHA1.hexdigest(str)
+      sha1[0, lenght.to_i]
+    end
+
+    # Returns a, ready to use, navigation list of all pages that have
+    # <tt>navigation</tt> set in their YAML front matter. The list is sorted by
+    # the value of <tt>navigation</tt>.
+    #
+    #   {{ site | navigation_list:page }}
+    def navigation_list(site, page)
+      pages = site['pages'].select { |p|
+        p.data['navigation'] && p.data['title']
+      }.sort_by { |p| p.data['navigation'] }
+
+      list = []
+      list << pages.map { |p|
+        active = (p.url == page['url']) || (page.key?('next') && File.join(p.dir, p.basename) == '/index')
+        navigation_list_item(File.join(site['url'], p.url), p.data['title'], active)
+      }
+      list.join("\n")
+    end
+
+    def talk_list(site, page)
+      pages = site['pages'].select { |p|
+        p.data['talk'] && p.data['title']
+      }.sort_by { |p| p.data['talk'] }
+
+      list =  ['<li class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false"> Talks <span class="caret"></span>
+                </a><ul class="dropdown-menu">']
+      list << pages.map { |p|
+        active = (p.url == page['url']) || (page.key?('next') && File.join(p.dir, p.basename) == '/index')
+        navigation_list_item(File.join(site['url'], p.url), p.data['title'], active)
+      }
+      list << ['</ul></li>']
+
+      list.join("\n")
+    end
+
+    def navigation_list_item(url, title, active = false)
+      a_class = active ? ' class="active"' : ''
+      %Q{<li#{a_class}><a #{a_class} href="#{url}">#{title}</a></li>}
+    end
+
+    # Returns an array of all episode feeds named by the convetion
+    # 'episodes.<episode_file_format>.rss' within the root directory. Also it
+    # contains all additional feeds specified by 'additional_feeds' in the
+    # '_config.yml'. If an 'episode_file_format' or key of 'additional_feeds'
+    # equals the optional parameter 'except', it will be skipped.
+    #
+    #   episode_feeds(site, except = nil) =>
+    #   [
+    #     ["m4a Episode RSS-Feed", "/episodes.m4a.rss"],
+    #     ["mp3 Episode RSS-Feed", "/episodes.mp3.rss"],
+    #     ["Torrent Feed m4a", "http://bitlove.org/octopod/octopod_m4a/feed"],
+    #     ["Torrent Feed mp3", "http://bitlove.org/octopod/octopod_mp3/feed"]
+    #   ]
+    def episode_feeds(site, except = nil)
+      feeds = []
+
+      if site['episode_feed_formats']
+        site['episode_feed_formats'].map { |f|
+         feeds << ["#{f} Episode RSS-Feed", "#{site['url']}/episodes.#{f}.rss"] unless f == except
+        }
+      end
+      if site['additional_feeds']
+        site['additional_feeds'].each { |k, v|
+          feeds << [k.gsub('_', ' '), v] unless k == except
+        }
+      end
+
+      feeds
+    end
+
+    # Returns HTML links to all episode feeds named by the convetion
+    # 'episodes.<episode_file_format>.rss' within the root directory. Also it
+    # returns all additional feeds specified by 'additional_feeds' in the
+    # '_config.yml'. If an 'episode_file_format' or key of 'additional_feeds'
+    # equals the optional parameter 'except', it will be skipped.
+    #
+    #   {{ site | episode_feeds_html:'m4a' }} =>
+    #   <link rel="alternate" type="application/rss+xml" title="mp3 Episode RSS-Feed" href="/episodes.mp3.rss" />
+    #   <link rel="alternate" type="application/rss+xml" title="Torrent Feed m4a" href="http://bitlove.org/octopod/octopod_m4a/feed" />
+    #   <link rel="alternate" type="application/rss+xml" title="Torrent Feed mp3" href="http://bitlove.org/octopod/octopod_mp3/feed" />
+    def episode_feeds_html(site, except = nil)
+      episode_feeds(site, except).map { |f|
+        %Q{<link rel="alternate" type="application/rss+xml" title="#{f.first || f.last}" href="#{f.last}" />}
+      }.join("\n")
+    end
+
+    # Returns RSS-XML links to all episode feeds named by the convetion
+    # 'episodes.<episode_file_format>.rss' within the root directory. Also it
+    # returns all additional feeds specified by 'additional_feeds' in the
+    # '_config.yml'. If an 'episode_file_format' or key of 'additional_feeds'
+    # equals the optional parameter 'except', it will be skipped.
+    #
+    #   {{ site | episode_feeds_rss:'m4a' }} =>
+    #   <atom:link rel="alternate" href="/episodes.mp3.rss" type="application/rss+xml" title="mp3 Episode RSS-Feed"/>
+    #   <atom:link rel="alternate" href="http://bitlove.org/octopod/octopod_m4a/feed" type="application/rss+xml" title="Torrent Feed m4a"/>
+    #   <atom:link rel="alternate" href="http://bitlove.org/octopod/octopod_mp3/feed" type="application/rss+xml" title="Torrent Feed mp3"/>
+    def episode_feeds_rss(site, except = nil)
+      episode_feeds(site, except).map { |f|
+        %Q{<atom:link rel="alternate" href="#{f.last}" type="application/rss+xml" title="#{f.first || f.last}"/>}
+      }.join("\n")
+    end
+
+    # Prints out current version
+    def version_string(site)
+      Jekyll::Octopod::VERSION::STRING
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::OctopodFilters)

data/lib/jekyll/paged_feed_page.rb

@@ -0,0 +1,22 @@
+module Jekyll
+  class PagedFeedPage < Page
+    def initialize(site, base, dir, name, page_number, pages_total, format)
+      @site = site
+      @dir = "/"
+      @name = name
+
+      self.process(@name)
+      self.read_yaml(File.join(base, '_layouts'), 'feed.xml')
+      self.data['next'] = pages_total > page_number ? (page_number + 1).to_s : nil
+      self.data['last'] = pages_total > 1 ? pages_total.to_s : nil
+      self.data['prev'] = case page_number
+        when 1 then nil
+        when 2 then ""
+        else        (page_number - 1).to_s
+      end
+      self.data['myself'] = page_number == 1 ? nil : page_number.to_s
+      self.data['format'] = format
+      self.data['page_number'] = page_number
+    end
+  end
+end

data/lib/jekyll/paged_feed_page_generator.rb

@@ -0,0 +1,20 @@
+module Jekyll
+  class PagedFeedPageGenerator < Generator
+    safe true
+
+    def generate(site)
+      pages_total = (site.posts.docs.count.to_f / site.config["episodes_per_feed_page"]).ceil
+
+      site.config["episode_feed_formats"].each do |page_format|
+        name = "episodes." + page_format + ".rss"
+        page = PagedFeedPage.new(site, site.source, ".", name, 1, pages_total, page_format)
+        site.pages << page
+        (1..pages_total).each do |page_number|
+          name = "episodes" + page_number.to_s + "." + page_format + ".rss"
+          page = PagedFeedPage.new(site, site.source, ".", name, page_number, pages_total, page_format)
+          site.pages << page
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/podcast_player_page.rb

@@ -0,0 +1,24 @@
+module Jekyll
+  class PodcastPlayerPage < Page
+    def initialize(site, base, dir, post)
+      @site = site
+      @base = base
+      @dir  = dir
+      @name = 'index.html'
+
+      self.process(@name)
+      self.read_yaml(File.join(base, '_layouts'), 'player_index.html')
+
+      self.data['title']    = post.data['title']
+      self.data['subtitle'] = post.data['subtitle']
+      self.data['datum']    = post.data['datum']
+      self.data['author']   = post.data['author']
+      self.data['duration'] = post.data['duration']
+      self.data['summary']  = post.data['summary']
+      self.data['explicit'] = post.data['explicit']
+      self.data['audio']    = post.data['audio']
+      self.data['chapters'] = post.data['chapters']
+      self.data['template'] = 'player_index'
+    end
+  end
+end

data/lib/jekyll/podcast_player_page_generator.rb

@@ -0,0 +1,14 @@
+module Jekyll
+  class PodcastPlayerPageGenerator < Generator
+    safe true
+
+    def generate(site)
+      if site.layouts.key? 'player_index'
+        dir =  site.config['players_dir'] || 'players'
+        site.posts.docs.each do |post|
+          site.pages << PodcastPlayerPage.new(site, site.source, File.join(dir, post.data['slug']), post)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/podigee_player_tag.rb

@@ -0,0 +1,44 @@
+module Jekyll
+  class PodigeePlayerTag < Liquid::Tag
+    def playerconfig(context)
+      config = context.registers[:site].config
+      page = context.registers[:page]
+
+      audio = {}
+      download_url = config["download_url"] || config["url"] + "/episodes"
+      page["audio"].each { |key, value| audio[key] = download_url + "/" + value}
+
+      { options: { theme: "default",
+                   startPanel: "ChapterMarks" },
+        extensions: { ChapterMarks: {},
+                      EpisodeInfo:  {},
+                      Playlist:     {} },
+        title: options['title'],
+        episode: { media: audio,
+                   coverUrl: config['url'] + (page["episode_cover"] || '/img/logo-360x360.png'),
+                   title: page["title"],
+                   subtitle: page["subtitle"],
+                   url: config['url'] + page["url"],
+                   description: page["description"],
+                   chaptermarks: page["chapters"].map {|chapter| { start: chapter[0..12], title: chapter[13..255] }}
+                 }
+      }.to_json
+    end
+
+    def render(context)
+      config = context.registers[:site].config
+      page = context.registers[:page]
+      return unless page["audio"]
+      return <<~HTML
+        <script>
+          window.playerConfiguration = #{playerconfig(context)}
+        </script>
+        <script class="podigee-podcast-player" data-configuration="playerConfiguration"
+                src="#{config["url"].split(":").first}://cdn.podigee.com/podcast-player/javascripts/podigee-podcast-player.js">
+        </script>
+HTML
+    end
+  end
+end
+
+Liquid::Template.register_tag('podigee_player', Jekyll::PodigeePlayerTag)