tg-firefly 0.9.0

data/lib/firefly/base62.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+module Firefly
+  class Base62
+
+    CHARS = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".split('')
+    BASE = 62
+
+    def self.encode(value)
+      s = ""
+      while value > 0
+        value, rem = value.divmod(BASE)
+        s << CHARS[rem]
+      end
+      s.reverse
+    end
+
+    def self.decode(str)
+      total = 0
+      str.split('').reverse.each_with_index do |v,k|
+        total += (CHARS.index(v) * (BASE ** k))
+      end
+      total
+    end
+  end
+end

data/lib/firefly/click.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+module Firefly
+  class Click
+    include DataMapper::Resource
+    
+#    limit click abuse!
+    MAX_CLICKS_PER_IP = 10
+    
+    property :id,           Serial
+    property :ip,           String,     :index => true, :length => 20
+    property :code,         String,     :index => true, :length => 64
+    property :created_at,   DateTime,   :default => Proc.new{Time.now}
+  end
+end

data/lib/firefly/code_factory.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+module Firefly
+  class CodeFactory
+    class << self
+      attr_accessor :order
+    end
+
+    include DataMapper::Resource
+
+    property :id,    Serial
+    property :count, Integer, :default => 0
+
+    # Redirect to the selected order method
+    def self.next_code!
+      self.send("next_#{self.order || :sequential}_code!".to_sym)
+    end
+
+    # Returns the next value randomly
+    def self.next_random_code!
+      Firefly::Base62.encode(rand(200000000))
+    end
+
+    # Returns the next auto increment value and updates
+    # the counter
+    def self.next_sequential_code!
+      code = nil
+
+      Firefly::CodeFactory.transaction do
+        c = Firefly::CodeFactory.first
+        code = Firefly::Base62.encode(c.count + 1)
+        c.update(:count => c.count + 1)
+      end
+
+      code
+    end
+
+  end
+end

data/lib/firefly/config.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+module Firefly
+  class Config < Hash
+
+    DEFAULTS = {
+      :hostname         => "localhost:3000",
+      :api_key          => "test",
+      :database         => "sqlite3://#{Dir.pwd}/firefly_#{ENV['RACK_ENV']}.sqlite3",
+      :recent_urls      => 25,
+      :twitter          => "Check this out: %short_url%",
+      :hyves_path       => "toevoegen/tips",
+      :hyves_args       => "type=12&rating=5",
+      :hyves_title      => "Check this out",
+      :hyves_body       => "Check this out: %short_url%",
+      :qr_size          => "150x150"
+    }
+
+    def initialize obj
+      self.update DEFAULTS
+      self.update obj
+    end
+
+    def set key, val = nil, &blk
+      if val.is_a? Hash
+        self[key].update val
+      else
+        self[key] = block_given?? blk : val
+      end
+    end
+  end
+end

data/lib/firefly/server.rb

@@ -0,0 +1,303 @@
+# encoding: UTF-8
+require 'sinatra/base'
+require 'sinatra/reloader'
+require 'haml'
+require 'digest/md5'
+
+module Firefly
+  class InvalidUrlError < StandardError
+  end
+
+  class InvalidCodeError < StandardError
+  end
+
+  class Server < Sinatra::Base
+    configure :development do
+      register Sinatra::Reloader
+      enable :logging, :dump_errors, :raise_errors
+    end
+    
+    enable :sessions
+
+    dir = File.join(File.dirname(__FILE__), '..', '..')
+
+    set :root, dir
+    set :haml, {:format => :html5 }
+    set :session_secret, nil
+
+    attr_accessor :config
+
+    helpers do
+      include Rack::Utils
+      include Firefly::Share
+      alias_method :h, :escape_html
+
+      def url(*path_parts)
+        [ path_prefix, path_parts ].join("/").squeeze('/')
+      end
+      alias_method :u, :url
+
+      def path_prefix
+        request.env['SCRIPT_NAME']
+      end
+
+      def set_api_cookie(key)
+        session["firefly_session"] = Digest::MD5.hexdigest(key)
+      end
+
+      # Taken from Rails
+      def truncate(text, length, options = {})
+        options[:omission] ||= "..."
+
+        length_with_room_for_omission = length - options[:omission].length
+        chars = text
+        stop = options[:separator] ?
+          (chars.rindex(options[:separator], length_with_room_for_omission) || length_with_room_for_omission) : length_with_room_for_omission
+
+        (chars.length > length ? chars[0...stop] + options[:omission] : text).to_s
+      end
+
+      def has_valid_api_cookie?
+        key = session["firefly_session"]
+        key == Digest::MD5.hexdigest(config[:api_key])
+      end
+
+      def has_valid_share_key?
+        return false unless @config.has_key?(:sharing_key)
+        @config[:sharing_key] == params[:key]
+      end
+
+      def has_valid_share_domain?
+        return false unless @config.has_key?(:sharing_domains)
+        return true if @config[:sharing_domains].empty?
+        @config[:sharing_domains].any? { |domain| params[:url].include?(domain) }
+      end
+
+      def has_valid_share_target?
+        return false unless @config.has_key?(:sharing_domains)
+        @config[:sharing_targets].include?(params[:target].downcase.to_sym)
+      end
+
+      def validate_share_permission
+        if has_valid_share_key? && has_valid_share_domain? && has_valid_share_target?
+          return true
+        else
+          status 401
+          return false
+        end
+      end
+
+      def validate_api_permission
+        true
+#        TODO: need api validation?
+#        if !has_valid_api_cookie? && params[:api_key] != config[:api_key]
+#          status 401
+#          return false
+#        else
+#          return true
+#        end
+      end
+
+      def short_url(url)
+        "http://#{config[:hostname]}/#{url.code}"
+      end
+
+      def generate_short_url(url = nil, user_id = nil, requested_code = nil)
+        code, result = nil, nil
+
+        begin
+          ff_url  = Firefly::Url.shorten(url, user_id, requested_code)
+          code, result = ff_url.code, "http://#{config[:hostname]}/#{ff_url.code}"
+        rescue Firefly::InvalidUrlError
+          code, result = nil, "ERROR: The URL you posted is invalid."
+        rescue Firefly::InvalidCodeError
+          code, result = nil, "ERROR: The code is invalid or already exists."
+        rescue
+          code, result = nil, "ERROR: An unknown error occured"
+        end
+
+        return code, result
+      end
+
+      def is_highlighted?(url)
+        return false unless @highlight
+        @highlight.code == url.code
+      end
+
+      def store_api_key(key)
+        if key == config[:api_key]
+          set_api_cookie(config[:api_key])
+        end
+      end
+    end
+
+    before do
+      @authenticated = has_valid_api_cookie?
+      @config        = config
+      @highlight     = nil
+      @title         = "Firefly at http://#{@config[:hostname]}"
+
+      set :session_secret, @config[:session_secret]
+    end
+
+    get '/' do
+      @highlight = Firefly::Url.first(:code => params[:highlight]) if not params[:highlight].nil?
+      @error     = params[:highlight] == "error"
+
+      sort_column = params[:s] || 'created_at'
+      sort_order  = params[:d] || 'desc'
+
+      @urls = Firefly::Url.all(:limit => config[:recent_urls], :order => [ sort_column.to_sym.send(sort_order.to_sym) ] )
+
+      haml :index
+    end
+
+    post '/api/set' do
+      store_api_key(params[:api_key])
+      redirect '/'
+    end
+
+    # GET /add?url=http://ariejan.net&api_key=test&user_id=42
+    # POST /add?url=http://ariejan.net&api_key=test&user_id=42
+    #
+    # Returns the shortened URL
+    api_add = lambda {
+      validate_api_permission or return "Permission denied: Invalid API key"
+
+      @url            = params[:url]
+      @requested_code = params[:short]
+      @user_id        = params[:user_id]
+      @code, @result  = generate_short_url(@url, @user_id, @requested_code)
+      invalid = @code.nil?
+
+      if params[:visual]
+        store_api_key(params[:api_key])
+        @code.nil? ? haml(:error) : redirect("/?highlight=#{@code}")
+      else
+        head 422 if invalid
+        @result
+      end
+    }
+
+    get '/api/add', &api_add
+    post '/api/add', &api_add
+
+    api_share = lambda {
+      validate_share_permission or return "Cannot share that URL."
+
+      @url = params[:url]
+      @code, @result = generate_short_url(@url, nil)
+      invalid = @code.nil?
+
+      params[:title] ||= ""
+      title = URI.unescape(params[:title])
+
+      case (params[:target].downcase.to_sym)
+        when :twitter
+          redirect(twitter("http://#{config[:hostname]}/#{@code}", title))
+        when :hyves
+          redirect(hyves("http://#{config[:hostname]}/#{@code}", title))
+        when :facebook
+          redirect(facebook("http://#{config[:hostname]}/#{@code}"))
+        end
+    }
+
+    get '/api/share', &api_share
+    post '/api/share', &api_share
+
+    # GET /api/info/b3d
+    #
+    # Show info on the URL
+    get '/api/info/:code' do
+      validate_api_permission or return "Permission denied: Invalid API key"
+
+      @url = Firefly::Url.first(:code => params[:code])
+
+      if @url.nil?
+        status 404
+        "Sorry, that code is unknown."
+      else
+        @short_url = "http://#{config[:hostname]}/#{@url.code}"
+        haml :info
+      end
+    end
+
+    # GET /b3d.png
+    #
+    # Return a QR code image
+    get '/:code.png' do
+      @url = Firefly::Url.first(:code => params[:code])
+
+      if @url.nil?
+        status 404
+        "Sorry, that code is unknown."
+      else
+        redirect("http://chart.googleapis.com/chart?cht=qr&chl=#{URI.escape(short_url(@url), Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}&chs=#{config[:qr_size]}")
+      end
+    end
+
+    # GET /b3d
+    #
+    # Redirect to the shortened URL
+    get '/:code' do
+      @url = Firefly::Url.first(:code => params[:code])
+
+      if @url.nil?
+        status 404
+        "Sorry, that code is unknown."
+      else
+        @url.register_click!(request.ip)
+        redirect @url.url, 301
+      end
+    end
+
+    def initialize config = {}, &blk
+      super
+      @config = config.is_a?(Config) ? config : Firefly::Config.new(config)
+      @config.instance_eval(&blk) if block_given?
+      Firefly::CodeFactory.order = @config[:order]
+      begin
+        DataMapper.setup(:default, @config[:database])
+        DataMapper.auto_upgrade!
+        check_mysql_collation
+        check_code_factory
+      rescue
+        puts "Error setting up database connection. Please check the `database` setting in config.ru"
+        puts $!
+        puts "-------"
+        puts $!.backtrace
+        exit(1)
+      end
+    end
+
+    def check_code_factory
+      Firefly::CodeFactory.first || Firefly::CodeFactory.create(:count => 0)
+    end
+
+    def check_mysql_collation(first_try = true)
+      # Make sure the 'code' column is case-sensitive. This hack is for
+      # MySQL only, other database systems don't have this problem.
+      if DataMapper.repository(:default).adapter =~ "DataMapper::Adapters::MysqlAdapter"
+        query     = "SHOW FULL COLUMNS FROM firefly_urls WHERE Field='code';"
+        collation = DataMapper.repository(:default).adapter.select(query)[0][:collation]
+
+        if collation != "utf8_bin"
+          if first_try
+            puts " ~ Your MySQL database is not using the 'utf8-bin' collation. Trying to fix..."
+            DataMapper.repository(:default).adapter.execute("ALTER TABLE firefly_urls MODIFY `code` varchar(255) CHARACTER SET utf8 COLLATE utf8_bin;")
+            return check_mysql_collation(false)
+          else
+            puts " ~ Failed to set the collation for `code` in `firefly_urls`. Please see http://wiki.github.com/ariejan/firefly/faq for details."
+            return false
+          end
+        else
+          if !first_try
+            puts " ~ Successfully fixed your database."
+          end
+          return true
+        end
+      end
+    end
+  end
+end
+

data/lib/firefly/share.rb

@@ -0,0 +1,29 @@
+module Firefly
+  module Share
+    def twitter(url, message = nil)
+      status = if message.nil? || message == ""
+        config[:twitter].gsub('%short_url%', url)
+      else
+        max_length = 140-1-url.size
+        [message.strip.slice(0...max_length), url].join(' ')
+      end
+      "http://twitter.com/home?status=#{URI.escape(status)}" 
+    end
+
+    def hyves(url, title = nil, body = nil)
+      if title.nil? || title == ""
+        title = config[:hyves_title]
+      end
+
+      if body.nil? || body == ""
+       body = config[:hyves_body].gsub('%short_url%', url)
+      end
+
+      "http://www.hyves.nl/profielbeheer/#{config[:hyves_path]}/?name=#{URI.escape(title.strip)}&text=#{URI.escape(body.strip)}&#{config[:hyves_args]}"
+    end
+
+    def facebook(url)
+      "http://www.facebook.com/share.php?u=#{URI.escape(url)}"
+    end
+  end
+end

data/lib/firefly/url.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+module Firefly
+  class Url
+    include DataMapper::Resource
+
+    VALID_CODE_REGEX = /^[A-Za-z0-9\-_]{3,64}$/u # case-insensitive, UTF-8 encoded
+
+    property :id,           Serial
+    property :url,          String,     :index => true, :length => 255
+    property :code,         String,     :index => true, :length => 64
+    property :clicks,       Integer,    :default => 0
+    property :created_at,   DateTime,   :default => Proc.new{Time.now}
+    property :user_id,      String,     :index => true, :length => 50
+    # Increase the visits counter by 1
+    def register_click!(ip)
+      Firefly::Click.create(:code => code, :ip => ip)
+      if Firefly::Click.count(:code => code, :ip => ip) <= Firefly::Click::MAX_CLICKS_PER_IP
+        self.update(:clicks => self.clicks + 1)
+      end
+    end
+
+    # Shorten a long_url and return a new FireFly::Url
+    def self.shorten(long_url, user_id, code = nil)
+      code = nil if code !~ /\S/
+
+      raise Firefly::InvalidUrlError.new unless valid_url?(long_url)
+      raise Firefly::InvalidCodeError.new unless valid_code?(code)
+
+      long_url = normalize_url(long_url)
+
+      the_url = Firefly::Url.first(:url => long_url, :user_id => user_id) || Firefly::Url.create(:url => long_url, :user_id => user_id)
+      return the_url unless the_url.code.nil?
+
+      code ||= get_me_a_code
+      the_url.update(:code => code)
+      the_url
+    end
+
+    private
+
+      # Generate a unique code, not already in use.
+      def self.get_me_a_code
+        code = Firefly::CodeFactory.next_code!
+
+        if Firefly::Url.count(:code => code) > 0 
+          code = get_me_a_code
+        end
+
+        code
+      end
+
+      # Normalize the URL
+      def self.normalize_url(url)
+        url = URI.escape(URI.unescape(url))
+        URI.parse(url).normalize.to_s
+      end
+
+      # Validates the URL to be a valid http or https one. 
+      def self.valid_url?(url)
+        url.match URI.regexp(['http', 'https'])
+      end
+
+      def self.valid_code?(code)
+        return true if code.nil?
+        code.match(Firefly::Url::VALID_CODE_REGEX) && Firefly::Url.count(:code => code) == 0
+      end
+
+  end
+end