├── Gemfile ├── lib ├── empyrean.rb └── empyrean │ ├── templatelister.rb │ ├── defaults.rb │ ├── tweetloader.rb │ ├── cli.rb │ ├── optparser.rb │ ├── configloader.rb │ ├── templaterenderer.rb │ ├── templates │ ├── default.html.erb │ └── pisg.html.erb │ └── tweetparser.rb ├── .gitignore ├── Gemfile.lock ├── bin └── empyrean ├── empyrean.gemspec ├── README.md ├── config.yml.example └── LICENSE /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gemspec 4 | -------------------------------------------------------------------------------- /lib/empyrean.rb: -------------------------------------------------------------------------------- 1 | require 'empyrean/defaults' 2 | 3 | module Empyrean 4 | end 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # ignore tweets directory 2 | tweets/ 3 | # ignore output HTML 4 | output.html 5 | # ignore configuration 6 | config.yml 7 | # ignore gemfiles 8 | *.gem 9 | -------------------------------------------------------------------------------- /Gemfile.lock: -------------------------------------------------------------------------------- 1 | PATH 2 | remote: . 3 | specs: 4 | empyrean (0.1.2) 5 | 6 | GEM 7 | remote: https://rubygems.org/ 8 | specs: 9 | 10 | PLATFORMS 11 | ruby 12 | 13 | DEPENDENCIES 14 | empyrean! 15 | -------------------------------------------------------------------------------- /bin/empyrean: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # empyrean - generate a statistics page from your Twitter archive 3 | # 4 | # This file is part of Empyrean 5 | # Copyright (C) 2015 nilsding, pixeldesu 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | 20 | require 'empyrean/cli' 21 | 22 | Empyrean::CLI.new(*ARGV) 23 | -------------------------------------------------------------------------------- /empyrean.gemspec: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | lib = File.expand_path('../lib', __FILE__) 3 | $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) 4 | require 'empyrean/defaults' 5 | 6 | Gem::Specification.new do |spec| 7 | spec.name = 'empyrean' 8 | spec.version = Empyrean::VERSION 9 | spec.authors = ['nilsding', 'pixeldesu'] 10 | spec.email = ['nilsding@nilsding.org', 'git@pixelde.su'] 11 | spec.summary = %q{Generates stats using your Twitter archive.} 12 | spec.description = %q{With Empyrean, you can generate full stats of your Twitter account using your Twitter archive.} 13 | spec.homepage = 'https://github.com/nilsding/Empyrean' 14 | spec.license = 'GPLv3' 15 | 16 | spec.files = `git ls-files -z`.split("\x0") 17 | spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) } 18 | spec.test_files = spec.files.grep(%r{^(test|spec|features)/}) 19 | spec.require_paths = ['lib'] 20 | end 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Empyrean 2 | 3 | Generate full stats of your account using your Twitter Archive. 4 | 5 | ## Usage 6 | 7 | 1. Install Empyrean using `gem install empyrean` 8 | 1. Download your Twitter archive and unpack it somewhere. 9 | 2. Generate a new configuration file: `empyrean -g config.yml` 10 | 2. `empyrean -d path/to/data/js/tweets` 11 | 3. ??? 12 | 4. Profit! 13 | 14 | ## Configuration 15 | 16 | Configuration is done using the `config.yml` file in the current directory. 17 | You can generate one using `empyrean -g config.yml`. You may also specify a 18 | different configuration file to use with the `-c` switch. 19 | 20 | You can also use the `-C` switch to override config values on the fly, such as 21 | `-C timezone_difference=2` or `-C mentions_enabled=no`. If the configuration 22 | variable is a list, separate the elements with `,`. For example, to ignore 23 | the Twitter users `BarackObama` and `baddragon_en`, use 24 | `-C ignored_users=BarackObama,baddragon_en`. 25 | 26 | -------------------------------------------------------------------------------- /lib/empyrean/templatelister.rb: -------------------------------------------------------------------------------- 1 | # templatelister.rb - lists available templates 2 | # 3 | # This file is part of Empyrean 4 | # Copyright (C) 2015 nilsding, pixeldesu 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | require 'empyrean/defaults' 20 | 21 | module Empyrean 22 | class TemplateLister 23 | class << self 24 | # Returns an array of available templates. 25 | def list 26 | Dir[File.join TEMPLATE_DIR, "*.html.erb"].map{ |t| File.basename t } 27 | end 28 | 29 | # Prints the available templates to stdout. 30 | def print_list 31 | puts list 32 | end 33 | end 34 | end 35 | end -------------------------------------------------------------------------------- /lib/empyrean/defaults.rb: -------------------------------------------------------------------------------- 1 | # defaults.rb - some constants 2 | # 3 | # This file is part of Empyrean 4 | # Copyright (C) 2015 nilsding, pixeldesu 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | module Empyrean 20 | # Application name 21 | APP_NAME = "Empyrean" 22 | 23 | # Version 24 | VERSION = "0.1.2" 25 | 26 | # Combined version string 27 | VERSION_STR = "#{APP_NAME} #{VERSION}" 28 | 29 | # Regexp for matching user names 30 | USERNAME_REGEX = /[@]([a-zA-Z0-9_]{1,16})/ 31 | 32 | # Regexp for matching the client source 33 | SOURCE_REGEX = /^(.+)<\/a>$/ 34 | 35 | # Regexp for matching hashtags 36 | HASHTAG_REGEX = /[#]([^{}\[\]().,\-:!*_?#\s]+)/ 37 | 38 | # Path to the templates 39 | TEMPLATE_DIR = File.expand_path "../templates", __FILE__ 40 | 41 | # The default template to use 42 | DEFAULT_TEMPLATE = "default.html.erb" 43 | end 44 | -------------------------------------------------------------------------------- /config.yml.example: -------------------------------------------------------------------------------- 1 | # Empyrean config file 2 | 3 | timezone_difference: 0 # Time zone difference (e.g. 2 for UTC+2, -6 for UTC-6) 4 | 5 | mentions: 6 | enabled: true # Enable "Most mentioned users" list 7 | top: 10 # How many users to show on the "Most mentioned users" list 8 | notop: 20 # How many users to show on the "These didn't make it to the top" list 9 | clients: 10 | enabled: true # Enable "Most used clients" list 11 | top: 10 # How many clients to show on the "Most used clients" list 12 | notop: 20 # How many clients to show on the "These didn't make it to the top" list 13 | hashtags: 14 | enabled: true # Enable "Most used hashtags" list 15 | top: 10 # How many hashtags to show on the "Most used hashtags" list 16 | notop: 20 # How many hashtags to show on the "These didn't make it to the top" list 17 | smileys: 18 | enabled: true # Enable "Most used smileys" list 19 | top: 10 # How many smileys to show on the "Most used smileys" list 20 | notop: 0 # How many smileys to show on the "These didn't make it to the top" list 21 | 22 | ignored_users: # Users to exclude from the statistics. 23 | - BarackObama 24 | - tbhjuststop 25 | 26 | renamed_users: # Users that have renamed themselves 27 | pixeldesu: "mochizune" # mochizune was previously known as pixeldesu 28 | technikaflash: "mochizune" # mochizune was also previously known as TechnikaFlash (the downcase on the username is important) 29 | traxxed22: "mochizune" # and before that, mochizune was known as TraXXed22. 30 | 31 | # kate: indent-width 2 -------------------------------------------------------------------------------- /lib/empyrean/tweetloader.rb: -------------------------------------------------------------------------------- 1 | # tweetloader.rb - loads tweet files 2 | # 3 | # This file is part of Empyrean 4 | # Copyright (C) 2015 nilsding, pixeldesu 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | require 'json' 20 | require 'empyrean/defaults' 21 | 22 | module Empyrean 23 | class TweetLoader 24 | 25 | ## 26 | # Returns a list of file names in a directory. 27 | def self.read_directory(directory) 28 | files = [] 29 | entries = Dir.entries(directory) 30 | entries.each do |e| 31 | if e =~ /^\d{4}_\d{2}\.js$/ 32 | files << File.expand_path(e, directory) 33 | end 34 | end 35 | files.sort 36 | end 37 | 38 | ## 39 | # Reads a tweet file 40 | def self.read_file(file) 41 | puts "reading file #{file}" 42 | fh = File.open(file) 43 | contents = fh.read 44 | contents.sub! /Grailbird\.data\.tweets_\d{4}_\d{2} =/, '' # get rid of the JS assignment 45 | json_tweets = JSON.parse(contents) 46 | end 47 | end 48 | end 49 | 50 | # kate: indent-width 2 -------------------------------------------------------------------------------- /lib/empyrean/cli.rb: -------------------------------------------------------------------------------- 1 | # cli.rb 2 | # 3 | # This file is part of Empyrean 4 | # Copyright (C) 2015 nilsding, pixeldesu 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | require 'empyrean/defaults' 20 | require 'empyrean/optparser' 21 | require 'empyrean/configloader' 22 | require 'empyrean/tweetloader' 23 | require 'empyrean/tweetparser' 24 | require 'empyrean/templatelister' 25 | require 'empyrean/templaterenderer' 26 | 27 | module Empyrean 28 | class CLI 29 | def initialize(*argv) 30 | @options = OptParser.parse(argv) 31 | @config = ConfigLoader.new(@options).load_config 32 | 33 | parsed = analyze_tweets 34 | print_stats(parsed) 35 | generate_html(parsed) 36 | end 37 | 38 | def analyze_tweets 39 | tweet_files = TweetLoader.read_directory(@options.jsondir) 40 | parsed = [] 41 | parser = TweetParser.new(@options, @config) 42 | tweet_files.each do |file| 43 | tweet = TweetLoader.read_file file 44 | parsed << parser.parse(tweet) 45 | end 46 | TweetParser.merge_parsed parsed 47 | end 48 | 49 | def print_stats(parsed) 50 | puts "Analyzed #{parsed[:tweet_count]} tweets" 51 | puts " - #{(parsed[:retweet_count] * 100 / parsed[:tweet_count].to_f).round(2)}% retweets\n" 52 | return unless @options.print_stats 53 | 54 | headers = { 55 | mentions: ["You send most mentions to:", "times", :name], 56 | clients: ["Most used clients:", "tweets", :name], 57 | hashtags: ["Your most used hashtags:", "times", :hashtag], 58 | smileys: ["Your most used smileys:", "times", :smiley] 59 | } 60 | 61 | headers.each do |k, v| 62 | if @config[k][:enabled] 63 | puts v[0] 64 | begin 65 | @config[k][:top].times do |i| 66 | puts "#{sprintf "%2d", i + 1}. #{'#' if k == :hashtags}#{parsed[k][i][1][v[2]]} (#{parsed[k][i][1][:count]} #{v[1]})" 67 | end 68 | rescue => _ 69 | end 70 | end 71 | end 72 | end 73 | 74 | def generate_html(parsed) 75 | puts "Generating HTML" 76 | template = File.read template_file 77 | renderer = TemplateRenderer.new @config, template, parsed 78 | File.open(@options.outfile, 'w') do |outfile| 79 | outfile.write renderer.render 80 | outfile.flush 81 | end 82 | puts " => #{@options.outfile}" 83 | end 84 | 85 | def template_file 86 | if File.exist? File.join(Dir.pwd, @options.template) 87 | File.join(Dir.pwd, @options.template) 88 | elsif TemplateLister.list.include? @options.template 89 | File.join TEMPLATE_DIR, @options.template 90 | else 91 | @options.template 92 | end 93 | end 94 | end 95 | end 96 | 97 | # kate: indent-width 2 -------------------------------------------------------------------------------- /lib/empyrean/optparser.rb: -------------------------------------------------------------------------------- 1 | # optparser.rb - parses CLI options using Ruby's OptionParser 2 | # 3 | # This file is part of Empyrean 4 | # Copyright (C) 2015 nilsding, pixeldesu 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | require 'optparse' 20 | require 'ostruct' 21 | require 'empyrean/defaults' 22 | require 'empyrean/templatelister' 23 | 24 | module Empyrean 25 | class OptParser 26 | 27 | def self.parse(args) 28 | options = OpenStruct.new 29 | options.jsondir = "" 30 | options.outfile = "output.html" 31 | options.config = File.expand_path('.', "config.yml") 32 | options.config_values = {} 33 | options.print_stats = false 34 | options.template = DEFAULT_TEMPLATE 35 | options.verbose = false 36 | 37 | opts = OptionParser.new do |opts| 38 | opts.banner = "Usage: stats.rb [options]" 39 | 40 | opts.separator "" 41 | opts.separator "Specific options:" 42 | 43 | opts.on("-c", "--config CONFIG", "The configuration file to use (default: #{options.config})") do |config| 44 | options.config = config 45 | end 46 | 47 | opts.on("-C", "--config-value KEY=VALUE", "Sets a configuration value (e.g. hashtags_enabled=false)") do |val| 48 | key, value = val.split("=") 49 | key = key.downcase 50 | unless value.nil? # ignore empty values 51 | case key.to_s 52 | when /_enabled$/ 53 | value = to_bool value 54 | when /_(no)?top$/, /timezone_difference$/ 55 | value = value.to_i 56 | when /ignored_users/ 57 | value = value.split ',' 58 | end 59 | options.config_values[key.to_sym] = value 60 | end 61 | end 62 | 63 | opts.on("-g", "--generate-config CONFIG", "Generate a new configuration file") do |config_file| 64 | fn = File.expand_path '.', config_file 65 | if File.exist? fn 66 | STDERR.puts "Cowardly refusing to overwrite already existing file #{config_file}." 67 | exit 2 68 | end 69 | File.open fn, 'w' do |f| 70 | f.write File.read File.expand_path("../../../config.yml.example", __FILE__) 71 | STDERR.puts "Wrote new configuration to #{config_file}." 72 | exit 73 | end 74 | end 75 | 76 | opts.on("-d", "--jsondir DIRECTORY", "Directory with tweet files (containing 2014_07.js etc.)") do |dir| 77 | dir = File.expand_path('.', dir) 78 | unless File.exist?(dir) && File.directory?(dir) 79 | STDERR.puts "not a directory: #{dir}" 80 | exit 1 81 | end 82 | 83 | entries = Dir.entries(dir) 84 | entries.each do |e| 85 | # the file names of the tweet archive are in the format /^\d{4}_\d{2}\.js$/ 86 | unless e =~ /^\d{4}_\d{2}\.js$|\.+?/ 87 | STDERR.puts "not a tweets directory: #{dir}" 88 | exit 1 89 | end 90 | end 91 | 92 | options.jsondir = dir 93 | end 94 | 95 | opts.on("-o", "--outfile OUTFILE", "Output HTML file (default: #{options.outfile})") do |outfile| 96 | options.outfile = outfile 97 | end 98 | 99 | opts.on("-l", "--list-templates", "List available templates") do 100 | TemplateLister.print_list 101 | exit 102 | end 103 | 104 | opts.on("-t", "--template TEMPLATE", "Template to use (default: #{options.template})") do |template| 105 | options.template = template 106 | end 107 | 108 | opts.on("-p", "--[no-]print-stats", "Print stats to stdout") do |p| 109 | options.print_stats = p 110 | end 111 | 112 | opts.on("-v", "--[no-]verbose", "Run verbosely") do |v| 113 | options.verbose = v 114 | end 115 | 116 | # No argument, shows at tail. This will print an options summary. 117 | opts.on_tail("-h", "--help", "Show this message") do 118 | puts opts 119 | exit 120 | end 121 | 122 | # Another typical switch to print the version. 123 | opts.on_tail("--version", "Show version") do 124 | puts Empyrean::VERSION_STR 125 | exit 126 | end 127 | end.parse!(args) 128 | 129 | if options.jsondir.empty? 130 | STDERR.puts "missing argument: --jsondir, see --help for more" 131 | exit 1 132 | end 133 | 134 | options 135 | end # parse() 136 | 137 | private 138 | 139 | ## 140 | # "converts" a string to a boolean value 141 | def self.to_bool str 142 | if str == true || str =~ (/(true|t|yes|y|1)$/i) 143 | true 144 | else 145 | false 146 | end 147 | end 148 | end 149 | end 150 | 151 | # kate: indent-width 2 152 | -------------------------------------------------------------------------------- /lib/empyrean/configloader.rb: -------------------------------------------------------------------------------- 1 | # configloader.rb - loads a config file 2 | # 3 | # This file is part of Empyrean 4 | # Copyright (C) 2015 nilsding, pixeldesu 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | require 'yaml' 20 | require 'empyrean/defaults' 21 | 22 | module Empyrean 23 | class ConfigLoader 24 | def initialize(options) 25 | @options = options 26 | end 27 | 28 | ## 29 | # Loads a YAML file, parses it and returns a hash with symbolized keys. 30 | def load(file) 31 | if File.exist? file 32 | symbolize_keys(YAML.load_file(File.expand_path('.', file))) 33 | else 34 | {} 35 | end 36 | end 37 | 38 | # Loads a YAML file, parses it and checks if all values are given. If a 39 | # value is missing, it will be set with the default value. 40 | def load_config(file = @options.config) 41 | config = load(file) 42 | config[:timezone_difference] = 0 if config[:timezone_difference].nil? 43 | config[:mentions] = {} if config[:mentions].nil? 44 | config[:mentions][:enabled] = true if config[:mentions][:enabled].nil? 45 | config[:mentions][:top] = 10 if config[:mentions][:top].nil? 46 | config[:mentions][:notop] = 20 if config[:mentions][:notop].nil? 47 | config[:clients] = {} if config[:clients].nil? 48 | config[:clients][:enabled] = true if config[:clients][:enabled].nil? 49 | config[:clients][:top] = 10 if config[:clients][:top].nil? 50 | config[:clients][:notop] = 20 if config[:clients][:notop].nil? 51 | config[:hashtags] = {} if config[:hashtags].nil? 52 | config[:hashtags][:enabled] = true if config[:hashtags][:enabled].nil? 53 | config[:hashtags][:top] = 10 if config[:hashtags][:top].nil? 54 | config[:hashtags][:notop] = 20 if config[:hashtags][:notop].nil? 55 | config[:smileys] = {} if config[:smileys].nil? 56 | config[:smileys][:enabled] = true if config[:smileys][:enabled].nil? 57 | config[:smileys][:top] = 10 if config[:smileys][:top].nil? 58 | config[:smileys][:notop] = 0 if config[:smileys][:notop].nil? 59 | config[:ignored_users] = [] if config[:ignored_users].nil? 60 | config[:renamed_users] = [] if config[:renamed_users].nil? 61 | args_override config 62 | end 63 | 64 | def args_override(config) 65 | config_args = @options.config_values 66 | config[:timezone_difference] = config_args[:timezone_difference] unless config_args[:timezone_difference].nil? 67 | config[:mentions][:enabled] = config_args[:mentions_enabled] unless config_args[:mentions_enabled].nil? 68 | config[:mentions][:top] = config_args[:mentions_top] unless config_args[:mentions_top].nil? 69 | config[:mentions][:notop] = config_args[:mentions_notop] unless config_args[:mentions_notop].nil? 70 | config[:clients][:enabled] = config_args[:clients_enabled] unless config_args[:clients_enabled].nil? 71 | config[:clients][:top] = config_args[:clients_top] unless config_args[:clients_top].nil? 72 | config[:clients][:notop] = config_args[:clients_notop] unless config_args[:clients_notop].nil? 73 | config[:hashtags][:enabled] = config_args[:hashtags_enabled] unless config_args[:hashtags_enabled].nil? 74 | config[:hashtags][:top] = config_args[:hashtags_top] unless config_args[:hashtags_top].nil? 75 | config[:hashtags][:notop] = config_args[:hashtags_notop] unless config_args[:hashtags_notop].nil? 76 | config[:smileys][:enabled] = config_args[:smileys_enabled] unless config_args[:smileys_enabled].nil? 77 | config[:smileys][:top] = config_args[:smileys_top] unless config_args[:smileys_top].nil? 78 | config[:smileys][:notop] = config_args[:smileys_notop] unless config_args[:smileys_notop].nil? 79 | config[:ignored_users] = config_args[:ignored_users] unless config_args[:ignored_users].nil? 80 | config[:ignored_users].each do |user| user.downcase! end 81 | config[:renamed_users].each do |old, new| new.downcase! end 82 | config 83 | end 84 | 85 | private 86 | 87 | # Symbolizes the keys of a hash, duh. 88 | def symbolize_keys(hash) 89 | hash.inject({}) do |result, (key, value)| 90 | new_key = case key 91 | when String then key.to_sym 92 | else key 93 | end 94 | new_value = case value 95 | when Hash then symbolize_keys(value) 96 | else value 97 | end 98 | result[new_key] = new_value 99 | result 100 | end 101 | end 102 | end 103 | end 104 | 105 | # kate: indent-width 2 -------------------------------------------------------------------------------- /lib/empyrean/templaterenderer.rb: -------------------------------------------------------------------------------- 1 | # templaterenderer.rb - renders a ERB template 2 | # 3 | # This file is part of Empyrean 4 | # Copyright (C) 2015 nilsding, pixeldesu 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | require 'erb' 20 | require 'empyrean/defaults' 21 | 22 | module Empyrean 23 | class TemplateRenderer 24 | 25 | ## 26 | # Initializes a new TemplateRenderer. 27 | # 28 | # template: The template to use (i.e. not the file name) 29 | # parsed_tweets: The dict that gets returned by TweetParser::merge_parsed 30 | def initialize(config, template, parsed_tweets) 31 | @config = config 32 | @template = template 33 | @parsed = parsed_tweets 34 | end 35 | 36 | ## 37 | # Renders @template. 38 | def render 39 | mentions = mentions_erb 40 | hashtags = hashtags_erb 41 | smileys = smileys_erb 42 | clients = clients_erb 43 | counters = { 44 | tweets: @parsed[:tweet_count], 45 | retweets: @parsed[:retweet_count], 46 | retweets_percentage: (@parsed[:retweet_count] * 100 / @parsed[:tweet_count].to_f).round(2), 47 | selftweets: @parsed[:selftweet_count], 48 | selftweets_percentage: (@parsed[:selftweet_count] * 100 / @parsed[:tweet_count].to_f).round(2) 49 | } 50 | times_of_day = times_erb 51 | erb = ERB.new @template 52 | erb.result binding 53 | end 54 | 55 | private 56 | ## 57 | # Returns an array with the mentions which can be easily used within ERB. 58 | def mentions_erb 59 | retdict = { 60 | enabled: @config[:mentions][:enabled], 61 | top: [], 62 | nottop: [] 63 | } 64 | 65 | if @config[:mentions][:enabled] 66 | top = @parsed[:mentions].slice(0, @config[:mentions][:top]) # top X mentions 67 | top.each do |mention| 68 | retdict[:top] << mention[1] 69 | end 70 | 71 | nottop = @parsed[:mentions].slice(@config[:mentions][:top], @config[:mentions][:notop]) # not in the top X 72 | unless nottop.nil? 73 | nottop.each do |mention| 74 | mention[1].delete(:example) 75 | retdict[:nottop] << mention[1] 76 | end 77 | end 78 | end 79 | 80 | retdict 81 | end 82 | 83 | ## 84 | # Returns an array with the hashtags which can be easily used within ERB. 85 | def hashtags_erb 86 | retdict = { 87 | enabled: @config[:hashtags][:enabled], 88 | top: [], 89 | nottop: [] 90 | } 91 | 92 | if @config[:hashtags][:enabled] 93 | top = @parsed[:hashtags].slice(0, @config[:hashtags][:top]) # top X hashtags 94 | top.each do |hashtag| 95 | retdict[:top] << hashtag[1] 96 | end 97 | 98 | nottop = @parsed[:hashtags].slice(@config[:hashtags][:top], @config[:hashtags][:notop]) # not in the top X 99 | unless nottop.nil? 100 | nottop.each do |hashtag| 101 | hashtag[1].delete(:example) 102 | retdict[:nottop] << hashtag[1] 103 | end 104 | end 105 | end 106 | 107 | retdict 108 | end 109 | 110 | ## 111 | # Returns an array with the smileys which can be easily used within ERB. 112 | def smileys_erb 113 | retdict = { 114 | enabled: @config[:smileys][:enabled], 115 | top: [], 116 | nottop: [] 117 | } 118 | 119 | if @config[:smileys][:enabled] 120 | top = @parsed[:smileys].slice(0, @config[:smileys][:top]) # top X smileys 121 | top.each do |smiley| 122 | retdict[:top] << smiley[1] 123 | end 124 | 125 | nottop = @parsed[:smileys].slice(@config[:smileys][:top], @config[:smileys][:notop]) # not in the top X 126 | unless nottop.nil? 127 | nottop.each do |smiley| 128 | smiley[1].delete(:example) 129 | retdict[:nottop] << smiley[1] 130 | end 131 | end 132 | end 133 | 134 | retdict 135 | end 136 | 137 | ## 138 | # Returns an array with the clients which can be easily used within ERB. 139 | def clients_erb 140 | retdict = { 141 | enabled: @config[:clients][:enabled], 142 | top: [], 143 | nottop: [] 144 | } 145 | 146 | if @config[:clients][:enabled] 147 | top = @parsed[:clients].slice(0, @config[:clients][:top]) # top X clients 148 | top.each do |client| 149 | retdict[:top] << { 150 | name: client[1][:name], 151 | url: client[1][:url], 152 | count: client[1][:count], 153 | percentage: (client[1][:count] * 100 / @parsed[:tweet_count].to_f).round(2) 154 | } 155 | end 156 | 157 | nottop = @parsed[:clients].slice(@config[:clients][:top], @config[:clients][:notop]) # not in the top X 158 | unless nottop.nil? 159 | nottop.each do |client| 160 | client[1].delete(:example) 161 | retdict[:nottop] << { 162 | name: client[1][:name], 163 | url: client[1][:url], 164 | count: client[1][:count], 165 | percentage: (client[1][:count] * 100 / @parsed[:tweet_count].to_f).round(2) 166 | } 167 | end 168 | end 169 | end 170 | 171 | retdict 172 | end 173 | 174 | def times_erb 175 | retarr = [] 176 | max_count = @parsed[:times_of_day].max 177 | 178 | @parsed[:times_of_day].each do |count| 179 | retarr << { 180 | count: count, 181 | percentage: (count * 100 / @parsed[:tweet_count].to_f).round(1), 182 | size: ((count / max_count.to_f) * 100).to_i, 183 | max: count == max_count 184 | } 185 | end 186 | 187 | retarr 188 | end 189 | end 190 | end 191 | 192 | # kate: indent-width 2 -------------------------------------------------------------------------------- /lib/empyrean/templates/default.html.erb: -------------------------------------------------------------------------------- 1 | <%#-*- coding: utf-8 -*-%> 2 | 3 | 4 | 5 | 6 | 7 | 8 | Twitter Stats 9 | 10 | 11 | 12 | 13 | 17 | 18 | 49 | 50 |
51 |
52 |

Twitter Stats

53 |
54 | 55 |

Statistics generated on <%= Time.now.strftime("%A %d %B %Y - %T") %>

56 |

Total number of tweets: <%= counters[:tweets] %> (<%= counters[:retweets_percentage] %>% retweets)

57 | 58 |

Most active times

59 |

What time do you tweet the most?

60 | 61 | 62 | <% times_of_day.each_with_index do |time, index| %> 63 | 70 | <% end %> 71 | 72 | 73 | <% times_of_day.each_with_index do |time, index| %> 74 | 75 | <% end %> 76 | 77 |
64 | <%= time[:percentage] %>% 65 | <% if time[:size] > 0 %> 66 |
67 |
68 | <% end %> 69 |
<%= index %>
78 | 79 | <% if mentions[:enabled] %> 80 |

Most mentioned users

81 |

With this, you can see the people you mentioned most in your Twitter time!

82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | <% mentions[:top].each_with_index do |user, index| %> 93 | 94 | 95 | 96 | 97 | 98 | 99 | <% end %> 100 | 101 |
 UsernameTimes MentionedExample
<%= index + 1 %>.@<%= user[:name] %><%= user[:count] %><%= user[:example][:text] %>
102 | <% if mentions[:nottop].length > 0 %> 103 |
These didn't make it to the top…
104 | 105 | 106 | <% mentions[:nottop].each_with_index do |user, index| %> 107 | 108 | <% if index % 5 == 4 %> 109 | 110 | 111 | <% end %> 112 | <% end %> 113 | 114 |
@<%= user[:name] %> <%= user[:count] %>
115 | <% end %> 116 | <% end %> 117 | 118 | <% if clients[:enabled] %> 119 |

Most used clients

120 |

What is/was your favorite and most used client? Find it out right here!

121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | <% clients[:top].each_with_index do |client, index| %> 132 | 133 | 134 | 135 | 136 | 137 | 138 | <% end %> 139 | 140 |
 ClientTimes UsedPercentage (% of total)
<%= index + 1 %>.<%= client[:name] %><%= client[:count] %><%= client[:percentage] %>%
141 | <% if clients[:nottop].length > 0 %> 142 |
These didn't make it to the top…
143 | 144 | 145 | <% clients[:nottop].each_with_index do |client, index| %> 146 | 147 | <% if index % 5 == 4 %> 148 | 149 | 150 | <% end %> 151 | <% end %> 152 | 153 |
<%= client[:name] %> <%= client[:count] %>
154 | <% end %> 155 | <% end %> 156 | 157 | <% if smileys[:enabled] %> 158 |

Most used smileys :^)

159 |

;-)

160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | <% smileys[:top].each_with_index do |smiley, index| %> 171 | 172 | 173 | 174 | 175 | 176 | 177 | <% end %> 178 | 179 |
 SmileyTimes UsedExample
<%= index + 1 %>.<%= smiley[:smiley] %><%= smiley[:count] %><%= smiley[:example][:text] %>
180 | <% if smileys[:nottop].length > 0 %> 181 |
These didn't make it to the top… ;_;
182 | 183 | 184 | <% smileys[:nottop].each_with_index do |smiley, index| %> 185 | 186 | <% if index % 5 == 4 %> 187 | 188 | 189 | <% end %> 190 | <% end %> 191 | 192 |
<%= smiley[:smiley] %> <%= smiley[:count] %>
193 | <% end %> 194 | <% end %> 195 | 196 | <% if hashtags[:enabled] %> 197 |

Most used hashtags

198 |

What were you talking about on Twitter most? (Or you simply spammed/overused those hashtags)

199 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | <% hashtags[:top].each_with_index do |hashtag, index| %> 210 | 211 | 212 | 213 | 214 | 215 | 216 | <% end %> 217 | 218 |
 HashtagTimes UsedExample
<%= index + 1 %>.#<%= hashtag[:hashtag] %><%= hashtag[:count] %><%= hashtag[:example][:text] %>
219 | <% if hashtags[:nottop].length > 0 %> 220 |
These didn't make it to the top…
221 | 222 | 223 | <% hashtags[:nottop].each_with_index do |hashtag, index| %> 224 | 225 | <% if index % 5 == 4 %> 226 | 227 | 228 | <% end %> 229 | <% end %> 230 | 231 |
#<%= hashtag[:hashtag] %> <%= hashtag[:count] %>
232 | <% end %> 233 | <% end %> 234 | 235 | 236 | Stats generated using <%= Empyrean::VERSION_STR %>
237 | Empyrean © <%= (2014..Time.now.strftime("%Y").to_i).to_a * ", " %> nilsding, pixeldesu 238 | 239 |
240 | 241 | 242 | -------------------------------------------------------------------------------- /lib/empyrean/tweetparser.rb: -------------------------------------------------------------------------------- 1 | # tweetparser.rb - parses tweets 2 | # 3 | # This file is part of Empyrean 4 | # Copyright (C) 2015 nilsding, pixeldesu 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | require 'json' 20 | require 'empyrean/defaults' 21 | 22 | module Empyrean 23 | class TweetParser 24 | def initialize(options, config) 25 | @options = options 26 | @config = config 27 | end 28 | 29 | # Parses an array of tweets 30 | # 31 | # Returns a dict of things 32 | def parse(tweets) 33 | retdict = { 34 | mentions: {}, 35 | hashtags: {}, 36 | clients: {}, 37 | smileys: {}, 38 | times_of_day: [0] * 24, 39 | tweet_count: 0, 40 | retweet_count: 0, 41 | selftweet_count: 0, 42 | } 43 | tweets.each do |tweet| 44 | parsed_tweet = self.parse_one tweet 45 | 46 | if parsed_tweet[:retweet] # the tweet was a retweet 47 | # increase retweeted tweets count 48 | retdict[:retweet_count] += 1 49 | else 50 | parsed_tweet[:mentions].each do |user, data| # add mentions to the mentions dict 51 | retdict[:mentions][user] ||= { count: 0 } 52 | retdict[:mentions][user][:count] += data[:count] 53 | retdict[:mentions][user][:name] ||= data[:name] 54 | retdict[:mentions][user][:examples] ||= [] 55 | retdict[:mentions][user][:examples] << data[:example] 56 | end 57 | parsed_tweet[:hashtags].each do |hashtag, data| # add hashtags to the hashtags dict 58 | retdict[:hashtags][hashtag] ||= { count: 0 } 59 | retdict[:hashtags][hashtag][:count] += data[:count] 60 | retdict[:hashtags][hashtag][:hashtag] ||= data[:hashtag] 61 | retdict[:hashtags][hashtag][:examples] ||= [] 62 | retdict[:hashtags][hashtag][:examples] << data[:example] 63 | end 64 | 65 | parsed_tweet[:smileys].each do |smile, data| 66 | retdict[:smileys][smile] ||= { count: 0 } 67 | retdict[:smileys][smile][:frown] ||= data[:frown] 68 | retdict[:smileys][smile][:count] += data[:count] 69 | retdict[:smileys][smile][:smiley] ||= data[:smiley] 70 | retdict[:smileys][smile][:examples] ||= [] 71 | retdict[:smileys][smile][:examples] << data[:example] 72 | end 73 | 74 | # increase self tweeted tweets count 75 | retdict[:selftweet_count] += 1 76 | end 77 | 78 | # add client to the clients dict 79 | client_dict = parsed_tweet[:client][:name] 80 | retdict[:clients][client_dict] ||= { count: 0 } 81 | retdict[:clients][client_dict][:count] += 1 82 | retdict[:clients][client_dict][:name] = parsed_tweet[:client][:name] 83 | retdict[:clients][client_dict][:url] = parsed_tweet[:client][:url] 84 | 85 | retdict[:times_of_day][parsed_tweet[:time_of_day]] += 1 86 | 87 | # increase tweet count 88 | retdict[:tweet_count] += 1 89 | end 90 | 91 | retdict 92 | end 93 | 94 | # Parses a single tweet object 95 | # 96 | # Returns a dict of things. 97 | def parse_one(tweet) 98 | puts "==> #{tweet['id']}" if @options.verbose 99 | retdict = { 100 | mentions: {}, 101 | hashtags: {}, 102 | time_of_day: 0, 103 | retweet: false, 104 | client: { 105 | name: "", 106 | url: "", 107 | }, 108 | smileys: {} 109 | } 110 | 111 | # check if the tweet is actually a retweet and ignore the status text 112 | unless tweet['retweeted_status'].nil? 113 | retdict[:retweet] = true 114 | else 115 | # scan for mentions 116 | tweet['text'].scan USERNAME_REGEX do |user| 117 | hash_user = user[0].downcase 118 | puts "===> mentioned: #{user[0]}" if @options.verbose 119 | unless @config[:ignored_users].include? hash_user 120 | if @config[:renamed_users].include? hash_user.to_sym 121 | hash_user = @config[:renamed_users][hash_user.to_sym] 122 | end 123 | retdict[:mentions][hash_user] ||= {} 124 | retdict[:mentions][hash_user][:name] ||= user[0] 125 | retdict[:mentions][hash_user][:count] = retdict[:mentions][hash_user][:count].to_i.succ 126 | retdict[:mentions][hash_user][:example] ||= { text: tweet['text'], id: tweet['id'] } 127 | end 128 | end 129 | 130 | # scan for hashtags 131 | tweet['text'].scan HASHTAG_REGEX do |hashtag| 132 | hash_hashtag = hashtag[0].downcase 133 | puts "===> hashtag: ##{hashtag[0]}" if @options.verbose 134 | retdict[:hashtags][hash_hashtag] ||= {} 135 | retdict[:hashtags][hash_hashtag][:hashtag] ||= hashtag[0] 136 | retdict[:hashtags][hash_hashtag][:count] = retdict[:hashtags][hash_hashtag][:count].to_i.succ 137 | retdict[:hashtags][hash_hashtag][:example] ||= { text: tweet['text'], id: tweet['id'] } 138 | end 139 | 140 | # Smileys :^) 141 | eyes = "[xX8;:=%]" 142 | nose = "[-oc*^]" 143 | smile_regex = /(>?#{eyes}'?#{nose}[\)pPD\}\]>]|[\(\{\[<]#{nose}'?#{eyes}]|\([;:]|\^[_o-]*\^[';]|\\[o.]\/)/ 144 | frown_regex = /(#{eyes}'?#{nose}[\(\[\\\/\{|]|[\)\]\\\/\}|]#{nose}'?#{eyes}|[;:][\(\/]|[\)D]:|;_+;|T_+T|-[._]+-)/ 145 | 146 | unescaped_tweet = tweet['text'].gsub("&", "&").gsub("<", "<").gsub(">", ">") 147 | 148 | unescaped_tweet.scan smile_regex do |smile| 149 | smile = smile[0] 150 | puts "===> smile: #{smile}" if @options.verbose 151 | retdict[:smileys][smile] ||= {frown: false} 152 | retdict[:smileys][smile][:smiley] ||= smile 153 | retdict[:smileys][smile][:count] = retdict[:smileys][smile][:count].to_i.succ 154 | retdict[:smileys][smile][:example] ||= { text: tweet['text'], id: tweet['id'] } 155 | end 156 | 157 | unescaped_tweet.scan frown_regex do |frown| 158 | break unless unescaped_tweet !~ /\w+:\/\// # http:// :^) 159 | frown = frown[0] 160 | puts "===> frown: #{frown}" if @options.verbose 161 | retdict[:smileys][frown] ||= {frown: true} 162 | retdict[:smileys][frown][:smiley] ||= frown 163 | retdict[:smileys][frown][:count] = retdict[:smileys][frown][:count].to_i.succ 164 | retdict[:smileys][frown][:example] ||= { text: tweet['text'], id: tweet['id'] } 165 | end 166 | end 167 | 168 | # Tweet source (aka. the client the (re)tweet was made with) 169 | source_matches = tweet['source'].match SOURCE_REGEX 170 | retdict[:client][:url] = source_matches[1] 171 | retdict[:client][:name] = source_matches[2] 172 | 173 | # Time of day 174 | retdict[:time_of_day] = (tweet['created_at'].match(/^\d{4}-\d{2}-\d{2} (\d{2})/)[1].to_i + @config[:timezone_difference]) % 24 175 | 176 | retdict 177 | end 178 | 179 | class << self 180 | # Merges an array which contains dicts returned by self.parse() 181 | # Increases all counters. 182 | def merge_parsed(parsed) 183 | retdict = { 184 | mentions: {}, 185 | hashtags: {}, 186 | clients: {}, 187 | smileys: {}, 188 | times_of_day: [0] * 24, 189 | tweet_count: 0, 190 | retweet_count: 0, 191 | selftweet_count: 0, 192 | } 193 | parsed.each do |elem| 194 | retdict[:tweet_count] += elem[:tweet_count] 195 | retdict[:retweet_count] += elem[:retweet_count] 196 | retdict[:selftweet_count] += elem[:selftweet_count] 197 | 198 | elem[:mentions].each do |user, data| 199 | retdict[:mentions][user] ||= { count: 0 } 200 | retdict[:mentions][user][:count] += data[:count] 201 | retdict[:mentions][user][:name] = data[:name] 202 | retdict[:mentions][user][:examples] ||= [] 203 | retdict[:mentions][user][:examples] += data[:examples] 204 | end 205 | 206 | elem[:hashtags].each do |hashtag, data| 207 | retdict[:hashtags][hashtag] ||= { count: 0 } 208 | retdict[:hashtags][hashtag][:count] += data[:count] 209 | retdict[:hashtags][hashtag][:hashtag] = data[:hashtag] 210 | retdict[:hashtags][hashtag][:examples] ||= [] 211 | retdict[:hashtags][hashtag][:examples] += data[:examples] 212 | end 213 | 214 | elem[:smileys].each do |smile, data| 215 | retdict[:smileys][smile] ||= { count: 0 } 216 | retdict[:smileys][smile][:frown] ||= data[:frown] 217 | retdict[:smileys][smile][:count] += data[:count] 218 | retdict[:smileys][smile][:smiley] ||= data[:smiley] 219 | retdict[:smileys][smile][:examples] ||= [] 220 | retdict[:smileys][smile][:examples] += data[:examples] 221 | end 222 | 223 | elem[:clients].each do |client, data| 224 | retdict[:clients][client] ||= { count: 0 } 225 | retdict[:clients][client][:count] += data[:count] 226 | retdict[:clients][client][:name] = data[:name] 227 | retdict[:clients][client][:url] = data[:url] 228 | end 229 | 230 | elem[:times_of_day].each_with_index do |count, index| 231 | retdict[:times_of_day][index] += elem[:times_of_day][index] 232 | end 233 | end 234 | 235 | # take only one example 236 | retdict[:mentions].each do |user, data| 237 | retdict[:mentions][user][:example] = retdict[:mentions][user][:examples].sample 238 | retdict[:mentions][user].delete(:examples) 239 | end 240 | retdict[:hashtags].each do |hashtag, data| 241 | retdict[:hashtags][hashtag][:example] = retdict[:hashtags][hashtag][:examples].sample 242 | retdict[:hashtags][hashtag].delete(:examples) 243 | end 244 | retdict[:smileys].each do |smile, data| 245 | retdict[:smileys][smile][:example] = retdict[:smileys][smile][:examples].sample 246 | retdict[:smileys][smile].delete(:examples) 247 | end 248 | 249 | retdict[:mentions] = retdict[:mentions].sort_by { |k, v| v[:count] }.reverse 250 | retdict[:hashtags] = retdict[:hashtags].sort_by { |k, v| v[:count] }.reverse 251 | retdict[:clients] = retdict[:clients].sort_by { |k, v| v[:count] }.reverse 252 | retdict[:smileys] = retdict[:smileys].sort_by { |k, v| v[:count] }.reverse 253 | 254 | retdict 255 | end 256 | end 257 | end 258 | end 259 | 260 | # kate: indent-width 2 -------------------------------------------------------------------------------- /lib/empyrean/templates/pisg.html.erb: -------------------------------------------------------------------------------- 1 | <%#-*- coding: utf-8 -*-%> 2 | <% 3 | table_width = 710 4 | 5 | def _generate_colour(count, position) 6 | table_colour_start = 'babadc' 7 | table_colour_end = 'cccccc' 8 | 9 | start_red = table_colour_start.match(/([0-9A-Fa-f]{2}).{4}/)[1].to_i(16) 10 | start_green = table_colour_start.match(/.{2}([0-9A-Fa-f]{2}).{2}/)[1].to_i(16) 11 | start_blue = table_colour_start.match(/.{4}([0-9A-Fa-f]{2})/)[1].to_i(16) 12 | end_red = table_colour_end.match(/([0-9A-Fa-f]{2}).{4}/)[1].to_i(16) 13 | end_green = table_colour_end.match(/.{2}([0-9A-Fa-f]{2}).{2}/)[1].to_i(16) 14 | end_blue = table_colour_end.match(/.{4}([0-9A-Fa-f]{2})/)[1].to_i(16) 15 | 16 | blue = sprintf "%0.2x", ((((end_blue - start_blue) / count.to_f) * + position) + start_blue).abs 17 | green = sprintf "%0.2x", ((((end_green - start_green) / count.to_f) * + position) + start_green).abs 18 | red = sprintf "%0.2x", ((((end_red - start_red) / count.to_f) * + position) + start_red).abs 19 | 20 | "##{red}#{green}#{blue}" 21 | end 22 | 23 | def _colour(time) 24 | case time 25 | when (0..5) then "blue" 26 | when (6..11) then "green" 27 | when (12..17) then "yellow" 28 | when (18..23) then "red" 29 | end 30 | end 31 | 32 | table_colours_mentions = [] 33 | table_colours_clients = [] 34 | table_colours_hashtags = [] 35 | table_colours_smileys = [] 36 | 37 | (0...@config[:mentions][:top]).each do |i| 38 | table_colours_mentions << _generate_colour(@config[:mentions][:top], i) 39 | end 40 | (0...@config[:clients][:top]).each do |i| 41 | table_colours_clients << _generate_colour(@config[:clients][:top], i) 42 | end 43 | (0...@config[:hashtags][:top]).each do |i| 44 | table_colours_hashtags << _generate_colour(@config[:hashtags][:top], i) 45 | end 46 | (0...@config[:smileys][:top]).each do |i| 47 | table_colours_smileys << _generate_colour(@config[:smileys][:top], i) 48 | end 49 | %> 50 | 51 | 52 | 53 | 54 | Twitter Stats 55 | 225 | 226 | 227 |
228 | 229 | Twitter Stats
230 |
231 | Statistics generated on <%= Time.now.strftime("%A %d %B %Y - %T") %>
232 | Total number of tweets: <%= counters[:tweets] %> (<%= counters[:retweets_percentage] %>% retweets) 233 |

234 | 235 | 236 | 237 | 244 | 245 |
238 | 239 | 240 | 241 | 242 |
Most active times
243 |
246 | 247 | 248 | 249 | <% times_of_day.each_with_index do |time, index| %> 250 | 251 | <% end %> 252 | 253 | <% times_of_day.each_with_index do |time, index| %> 254 | 255 | <% end %> 256 |
<%= time[:percentage] %>%<% if time[:size] > 0 %>
<% end %>
<%= index %>

257 |
258 | 259 | <% if mentions[:enabled] %> 260 | 261 | 262 | 269 | 270 |
263 | 264 | 265 | 266 | 267 |
Most mentioned users
268 |
271 | 272 | 273 | 274 | 275 | 276 | 277 | 278 | 279 | <% mentions[:top].each_with_index do |user, index| %> 280 | 281 | 282 | 283 | 284 | 285 | 286 | <% end %> 287 |
 UserHow often?Random quote
<%= index + 1 %>@<%= user[:name] %><%= user[:count] %>"<%= user[:example][:text] %>" →

288 |
289 | <% if mentions[:nottop].length > 0 %>These didn't make it to the top: 290 | <% mentions[:nottop].each_with_index do |user, index| %> 291 | 292 | <% if index % 5 == 4 %> 293 | 294 | 295 | <% end %> 296 | <% end %> 297 | 298 |
@<%= user[:name] %> (<%= user[:count] %>)

299 |
300 | <% end %> 301 | <% end %> 302 | <% if clients[:enabled] %> 303 | 304 | 305 | 312 | 313 |
306 | 307 | 308 | 309 | 310 |
Most used clients
311 |
314 | 315 | 316 | 317 | 318 | 319 | 320 | 321 | 322 | <% clients[:top].each_with_index do |client, index| %> 323 | 324 | 325 | 326 | 327 | 328 | 329 | <% end %> 330 |
 ClientTimes usedPercentage
<%= index + 1 %><%= client[:name] %><%= client[:count] %><%= client[:percentage] %>%

331 |
332 | <% if clients[:nottop].length > 0 %>These didn't make it to the top: 333 | <% clients[:nottop].each_with_index do |client, index| %> 334 | 335 | <% if index % 5 == 4 %> 336 | 337 | 338 | <% end %> 339 | <% end %> 340 | 341 |
<%= client[:name] %> (<%= client[:count] %>)

342 |
343 | <% end %> 344 | <% end %> 345 | 346 | <% if smileys[:enabled] %> 347 | 348 | 349 | 356 | 357 |
350 | 351 | 352 | 353 | 354 |
Most used smileys :^)
355 |
358 | 359 | 360 | 361 | 362 | 363 | 364 | 365 | 366 | <% smileys[:top].each_with_index do |smiley, index| %> 367 | 368 | 369 | 370 | 371 | 372 | 373 | <% end %> 374 |
 SmileyTimes usedRandom quote
<%= index + 1 %><%= smiley[:smiley] %><%= smiley[:count] %>"<%= smiley[:example][:text] %>" →

375 |
376 | <% if smileys[:nottop].length > 0 %>These didn't make it to the top ;_; 377 | <% smileys[:nottop].each_with_index do |smiley, index| %> 378 | 379 | <% if index % 5 == 4 %> 380 | 381 | 382 | <% end %> 383 | <% end %> 384 | 385 |
<%= smiley[:smiley] %> (<%= smiley[:count] %>)

386 |
387 | <% end %> 388 | <% end %> 389 | 390 | <% if hashtags[:enabled] %> 391 | 392 | 393 | 400 | 401 |
394 | 395 | 396 | 397 | 398 |
Most used hashtags
399 |
402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | <% hashtags[:top].each_with_index do |hashtag, index| %> 411 | 412 | 413 | 414 | 415 | 416 | 417 | <% end %> 418 |
 HashtagTimes usedRandom quote
<%= index + 1 %>#<%= hashtag[:hashtag] %><%= hashtag[:count] %>"<%= hashtag[:example][:text] %>" →

419 |
420 | <% if hashtags[:nottop].length > 0 %>These didn't make it to the top: 421 | <% hashtags[:nottop].each_with_index do |hashtag, index| %> 422 | 423 | <% if index % 5 == 4 %> 424 | 425 | 426 | <% end %> 427 | <% end %> 428 | 429 |
#<%= hashtag[:hashtag] %> (<%= hashtag[:count] %>)

430 |
431 | <% end %> 432 | <% end %> 433 | 434 | 435 | Stats generated using <%= Empyrean::VERSION_STR %>
436 | Empyrean © <%= (2014..Time.now.strftime("%Y").to_i).to_a * ", " %> nilsding, pixeldesu 437 | 438 |
439 | 440 | 441 | 442 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------