flapjack 1.3.0 → 1.4.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 198e6405b9d8cf5cf8eecb207b3a966ab1ec3b51
-  data.tar.gz: 74a6ecc7d159cef46a6e46ae8bf378404967c1ff
+  metadata.gz: 430d4ccfe0c3f611279b7235de7ad5a3e621bd91
+  data.tar.gz: 4178c1f165b158fd89c719429020dfded2f801f3
 SHA512:
-  metadata.gz: 300bb8e1d0f90e8d69fe65ccbae38bf49a96835e7c80884df51661ff11185dfe87715dedbd9fb091ae35eb7888a069a0b814fe37ea1579f387fa07c0efe840bc
-  data.tar.gz: ff264c0cc717dc2a4b4b188af93bf4ef6e2f5cbdf238250d5b7e99042bc11627f1602fc88b586df7aab2f6f20715b834b87dffd48b409e1a1fa1a1790434041c
+  metadata.gz: 48f0e2bc2272f66b74db10bb355c0619dc103f93abc499e5fdbb3aab86c72e7ca825f1d8cacce230c9e56191eeab5f81ae49d038d03026d186225cdbe90c53b7
+  data.tar.gz: 4f7c9dd297ae3c2d7cc8fafd66bba4479e281f0321eb7f2994c9acf1cf3f3594710b199e8e9a2bdc2f7220eeb7659a2a4dfa110102b6f89a166741111ceb8ae9

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Flapjack Changelog
 
+# 1.4.0rc1 - 2015-03-12
+- Bug: API : Wrong Timezone doesn't cause 422 status and makes GET /contacts crash #791 (@ali-graham)
+- Bug: uncaught exception in Event#initialize: invalid byte sequence in UTF-8 #801 (@ali-graham)
+- Bug: uncaught exception in Web UI: invalid byte sequence in US-ASCII #802 (@ali-graham)
+- Feature: Add bind_address config option for http server pikelets #807 (@mrichar1)
+
 # 1.3.0 - 2015-02-17
 - No changes
 
@@ -11,7 +17,7 @@
 - Bug: Error uninstalling - Error generating or dispatching SMS Nexmo message #789 (@Hobbsee)
 
 # 1.3.0rc1 - 2015-02-13
-- Feature: Add Nexmo SMS gateway
+- Feature: Add Nexmo SMS gateway #786 (@jsoriano)
 - Bug: Revert addition of sms_gammu gateway #759 (@ali-graham)
 
 # 1.2.2 - 2015-02-10

data/bin/flapjack

@@ -14,14 +14,19 @@ program_desc 'Flexible monitoring notification routing system'
 version Flapjack::VERSION
 
 desc 'Configuration file to use'
-default_value '/etc/flapjack/flapjack_config.yaml'
-arg_name '/path/to/flapjack.yaml'
-flag [:c,:config]
+flag [:c,:config],
+  :arg_name => '/path/to/flapjack.yaml',
+  :default_value => '/etc/flapjack/flapjack_config.yaml'
 
 desc 'Environment to boot'
-default_value 'production'
-arg_name '<environment>'
-flag [:n, :env, :environment]
+flag [:n, :env, :environment],
+  :arg_name => '<environment>',
+  :default_value => 'production'
+
+desc 'Force UTF-8 encoding'
+switch [:'force-utf8'],
+  :negatable => true,
+  :default_value => true
 
 accept Array do |value|
   value.split(/,/).map(&:strip)

data/etc/flapjack_config.yaml.example

@@ -179,6 +179,7 @@ production:
     # Browsable web interface
     web:
       enabled: yes
+      #bind_address: 0.0.0.0
       port: 3080
       timeout: 300
       # Seconds between auto_refresh of entities/checks pages.  Set to 0 to disable
@@ -197,6 +198,7 @@ production:
     # HTTP API server
     jsonapi:
       enabled: yes
+      #bind_address: 0.0.0.0
       port: 3081
       timeout: 300
       access_log: "/var/log/flapjack/jsonapi_access.log"
@@ -401,6 +403,7 @@ development:
     # Browsable web interface
     web:
       enabled: yes
+      #bind_address: 0.0.0.0
       port: 3080
       timeout: 300
       # Seconds between auto_refresh of entities/checks pages.  Set to 0 to disable
@@ -416,6 +419,7 @@ development:
     # HTTP API server
     jsonapi:
       enabled: yes
+      #bind_address: 0.0.0.0
       port: 3081
       timeout: 300
       access_log: "log/jsonapi_access.log"

data/features/steps/events_steps.rb

@@ -362,7 +362,7 @@ end
 
 Given /^user (\S+) has the following notification rules:$/ do |contact_id, rules|
   contact = Flapjack::Data::Contact.find_by_id(contact_id, :redis => @redis)
-  timezone = contact.timezone
+  time_zone = contact.time_zone
 
   # delete any autogenerated rules, and do it using redis directly so no new
   # ones will be created
@@ -384,9 +384,9 @@ Given /^user (\S+) has the following notification rules:$/ do |contact_id, rules
     }.inject([]) { |memo, time_restriction|
       case time_restriction
       when '8-18 weekdays'
-        weekdays_8_18 = IceCube::Schedule.new(timezone.local(2013,2,1,8,0,0), :duration => 60 * 60 * 10)
+        weekdays_8_18 = IceCube::Schedule.new(time_zone.local(2013,2,1,8,0,0), :duration => 60 * 60 * 10)
         weekdays_8_18.add_recurrence_rule(IceCube::Rule.weekly.day(:monday, :tuesday, :wednesday, :thursday, :friday))
-        memo << icecube_schedule_to_time_restriction(weekdays_8_18, timezone)
+        memo << icecube_schedule_to_time_restriction(weekdays_8_18, time_zone)
       end
     } : []
     rule_data = {:contact_id         => contact_id,

data/features/support/env.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
-#
+
+Encoding.default_internal = 'UTF-8'
 
 require 'delorean'
 require 'chronic'

data/lib/flapjack.rb

@@ -15,5 +15,11 @@ module Flapjack
     Oj.dump(data, :mode => :compat, :time_format => :ruby, :indent => 0)
   end
 
+  def self.sanitize(str)
+    return str if str.nil? || !str.is_a?(String) || str.valid_encoding?
+    return str.scrub('?') if str.respond_to(:scrub)
+    str.chars.collect {|c| c.valid_encoding? ? c : '_' }.join
+  end
+
 end
 

data/lib/flapjack/cli/flapper.rb

@@ -28,6 +28,11 @@ module Flapjack
         @global_options = global_options
         @options = options
 
+        if @global_options[:'force-utf8']
+          Encoding.default_external = 'UTF-8'
+          Encoding.default_internal = 'UTF-8'
+        end
+
         @config = Flapjack::Configuration.new
         @config.load(global_options[:config])
         @config_env = @config.all

data/lib/flapjack/cli/import.rb

@@ -15,6 +15,11 @@ module Flapjack
         @global_options = global_options
         @options = options
 
+        if @global_options[:'force-utf8']
+          Encoding.default_external = 'UTF-8'
+          Encoding.default_internal = 'UTF-8'
+        end
+
         config = Flapjack::Configuration.new
         config.load(global_options[:config])
         @config_env = config.all

data/lib/flapjack/cli/maintenance.rb

@@ -17,6 +17,11 @@ module Flapjack
         @global_options = global_options
         @options = options
 
+        if @global_options[:'force-utf8']
+          Encoding.default_external = 'UTF-8'
+          Encoding.default_internal = 'UTF-8'
+        end
+
         config = Flapjack::Configuration.new
         config.load(global_options[:config])
         @config_env = config.all

data/lib/flapjack/cli/purge.rb

@@ -13,6 +13,11 @@ module Flapjack
         @global_options = global_options
         @options = options
 
+        if @global_options[:'force-utf8']
+          Encoding.default_external = 'UTF-8'
+          Encoding.default_internal = 'UTF-8'
+        end
+
         config = Flapjack::Configuration.new
         config.load(global_options[:config])
         @config_env = config.all

data/lib/flapjack/cli/receiver.rb

@@ -19,6 +19,11 @@ module Flapjack
         @global_options = global_options
         @options = options
 
+        if @global_options[:'force-utf8']
+          Encoding.default_external = 'UTF-8'
+          Encoding.default_internal = 'UTF-8'
+        end
+
         @config = Flapjack::Configuration.new
         @config.load(global_options[:config])
         @config_env = @config.all

data/lib/flapjack/cli/server.rb

@@ -12,6 +12,11 @@ module Flapjack
         @global_options = global_options
         @options = options
 
+        if @global_options[:'force-utf8']
+          Encoding.default_external = 'UTF-8'
+          Encoding.default_internal = 'UTF-8'
+        end
+
         @config = Flapjack::Configuration.new
         @config.load(global_options[:config])
         @config_env = @config.all

data/lib/flapjack/cli/simulate.rb

@@ -17,6 +17,11 @@ module Flapjack
         @global_options = global_options
         @options = options
 
+        if @global_options[:'force-utf8']
+          Encoding.default_external = 'UTF-8'
+          Encoding.default_internal = 'UTF-8'
+        end
+
         config = Flapjack::Configuration.new
         config.load(global_options[:config])
         @config_env = config.all

data/lib/flapjack/data/contact.rb

@@ -3,13 +3,15 @@
 # NB: use of redis.keys probably indicates we should maintain a data
 # structure to avoid the need for this type of query
 
+require 'securerandom'
 require 'set'
+
 require 'ice_cube'
+
 require 'flapjack/data/entity'
+require 'flapjack/data/entity_check'
 require 'flapjack/data/notification_rule'
 
-require 'securerandom'
-
 module Flapjack
 
   module Data
@@ -101,8 +103,10 @@ module Flapjack
       # TODO may want to make this protected/private, it's only
       # used in this class
       def refresh
-        self.first_name, self.last_name, self.email =
-          @redis.hmget("contact:#{@id}", 'first_name', 'last_name', 'email')
+        fn, ln, em = @redis.hmget("contact:#{@id}", 'first_name', 'last_name', 'email')
+        self.first_name = Flapjack.sanitize(fn)
+        self.last_name  = Flapjack.sanitize(ln)
+        self.email      = Flapjack.sanitize(em)
         self.media = @redis.hgetall("contact_media:#{@id}")
         self.media_intervals = @redis.hgetall("contact_media_intervals:#{self.id}")
         self.media_rollup_thresholds = @redis.hgetall("contact_media_rollup_thresholds:#{self.id}")
@@ -430,45 +434,30 @@ module Flapjack
         self.media_list.collect {|medium| "#{self.id}_#{medium}" }
       end
 
-      # return the timezone of the contact, or the system default if none is set
-      # TODO cache?
-      def timezone(opts = {})
-        logger = opts[:logger]
-
-        tz_string = @redis.get("contact_tz:#{self.id}")
-        tz = opts[:default] if (tz_string.nil? || tz_string.empty?)
-
-        if tz.nil?
-          begin
-            tz = ActiveSupport::TimeZone.new(tz_string)
-          rescue ArgumentError
-            if logger
-              logger.warn("Invalid timezone string set for contact #{self.id} or TZ (#{tz_string}), using 'UTC'!")
-            end
-            tz = ActiveSupport::TimeZone.new('UTC')
-          end
-        end
-        tz
+      def timezone
+        @redis.get("contact_tz:#{self.id}")
       end
 
-      # sets or removes the timezone for the contact
-      def timezone=(tz)
-        if tz.nil?
+      def timezone=(tz_string)
+        if tz_string.nil?
           @redis.del("contact_tz:#{self.id}")
-        else
-          # ActiveSupport::TimeZone or String
-          @redis.set("contact_tz:#{self.id}",
-            tz.respond_to?(:name) ? tz.name : tz )
+        elsif tz_string.is_a?(String) && !ActiveSupport::TimeZone[tz_string].nil?
+          @redis.set("contact_tz:#{self.id}", tz_string)
         end
       end
 
+      def time_zone
+        return nil if self.timezone.nil?
+        ActiveSupport::TimeZone[self.timezone]
+      end
+
       def to_jsonapi(opts = {})
         json_data = {
           "id"                    => self.id,
           "first_name"            => self.first_name,
           "last_name"             => self.last_name,
           "email"                 => self.email,
-          "timezone"              => self.timezone.name,
+          "timezone"              => self.timezone,
           "links"                 => {
             :entities               => opts[:entity_ids]          || [],
             :media                  => self.media_ids             || [],
@@ -521,10 +510,8 @@ module Flapjack
           tz = contact_data['timezone']
           if tz.nil?
             redis.del("contact_tz:#{contact_id}")
-          else
-            # ActiveSupport::TimeZone or String
-            redis.set("contact_tz:#{contact_id}",
-              tz.respond_to?(:name) ? tz.name : tz )
+          elsif tz.is_a?(String) && !ActiveSupport::TimeZone[tz].nil?
+            redis.set("contact_tz:#{contact_id}", tz )
           end
         end
       end

data/lib/flapjack/data/entity_check.rb

@@ -1000,8 +1000,8 @@ module Flapjack
 
       def initialize(entity, check, options = {})
         raise "Redis connection not set" unless @redis = options[:redis]
-        raise "Invalid entity (#{entity.inspect})" unless @entity = entity
-        raise "Invalid check (#{check.inspect} on #{entity.inspect})" unless @check = check
+        raise "Invalid entity (#{entity.inspect})" unless @entity = Flapjack.sanitize(entity)
+        raise "Invalid check (#{check.inspect} on #{entity.inspect})" unless @check = Flapjack.sanitize(check)
         @key = "#{entity.name}:#{check}"
         if @redis.zscore("all_checks", @key).nil?
           timestamp = options[:timestamp] || Time.now.to_i

data/lib/flapjack/data/event.rb

@@ -234,7 +234,8 @@ module Flapjack
         ['type', 'state', 'entity', 'check', 'time', 'summary', 'details',
          'perfdata', 'acknowledgement_id', 'duration', 'initial_failure_delay',
          'repeat_failure_delay'].each do |key|
-          instance_variable_set("@#{key}", attrs[key])
+
+          instance_variable_set("@#{key}", Flapjack.sanitize(attrs[key]))
         end
         # summary is optional. set it to nil if it only contains whitespace
         @summary = (@summary.is_a?(String) && ! @summary.strip.empty?) ? @summary.strip : nil

data/lib/flapjack/data/notification.rb

@@ -276,13 +276,13 @@ module Flapjack
 
         return true if rule.time_restrictions.nil? or rule.time_restrictions.empty?
 
-        timezone = contact.timezone(:default => def_tz)
-        usertime = timezone.now
+        time_zone = contact.time_zone || def_tz
+        usertime = time_zone.now
 
         rule.time_restrictions.any? do |tr|
-          # add contact's timezone to the time restriction schedule
+          # add contact's time_zone to the time restriction schedule
           schedule = Flapjack::Data::NotificationRule.
-                       time_restriction_to_icecube_schedule(tr, timezone, :logger => options[:logger])
+                       time_restriction_to_icecube_schedule(tr, time_zone, :logger => options[:logger])
           schedule && schedule.occurring_at?(usertime)
         end
       end

data/lib/flapjack/gateways/aws_sns.rb

@@ -66,23 +66,18 @@ module Flapjack
         notification_id = alert.notification_id
         message_type    = alert.rollup ? 'rollup' : 'alert'
 
-        my_dir = File.dirname(__FILE__)
-        sms_template_path = case
-        when @config.has_key?('templates') && @config['templates']["#{message_type}.text"]
-          @config['templates']["#{message_type}.text"]
-        else
-          my_dir + "/aws_sns/#{message_type}.text.erb"
-        end
-        sms_template = ERB.new(File.read(sms_template_path), nil, '-')
+        sms_template_erb, sms_template =
+          load_template(@config['templates'], message_type, 'text',
+                        File.join(File.dirname(__FILE__), 'aws_sns'))
 
         @alert  = alert
         bnd     = binding
 
         begin
-          message = sms_template.result(bnd).chomp
+          message = sms_template_erb.result(bnd).chomp
         rescue => e
-          @logger.error "Error while excuting the ERB for an sms: " +
-            "ERB being executed: #{sms_template_path}"
+          @logger.error "Error while executing the ERB for an sms: " +
+            "ERB being executed: #{sms_template}"
           raise
         end
 

data/lib/flapjack/gateways/email.rb

@@ -131,44 +131,33 @@ module Flapjack
 
         message_type = alert.rollup ? 'rollup' : 'alert'
 
-        mydir = File.dirname(__FILE__)
-        subject_template_path = case
-        when @config.has_key?('templates') && @config['templates']["#{message_type}_subject.text"]
-          @config['templates']["#{message_type}_subject.text"]
-        else
-          mydir + "/email/#{message_type}_subject.text.erb"
-        end
-        text_template_path = case
-        when @config.has_key?('templates') && @config['templates']["#{message_type}.text"]
-          @config['templates']["#{message_type}.text"]
-        else
-          mydir + "/email/#{message_type}.text.erb"
-        end
-        html_template_path = case
-        when @config.has_key?('templates') && @config['templates']["#{message_type}.html"]
-          @config['templates']["#{message_type}.html"]
-        else
-          mydir + "/email/#{message_type}.html.erb"
-        end
-        subject_template = ERB.new(File.read(subject_template_path), nil, '-')
-        text_template    = ERB.new(File.read(text_template_path), nil, '-')
-        html_template    = ERB.new(File.read(html_template_path), nil, '-')
+        subject_template_erb, subject_template =
+          load_template(@config['templates'], "#{message_type}_subject",
+                        'text', File.join(File.dirname(__FILE__), 'email'))
+
+        text_template_erb, text_template =
+          load_template(@config['templates'], message_type,
+                        'text', File.join(File.dirname(__FILE__), 'email'))
+
+        html_template_erb, html_template =
+          load_template(@config['templates'], message_type,
+                        'html', File.join(File.dirname(__FILE__), 'email'))
 
         @alert  = alert
         bnd     = binding
 
         # do some intelligence gathering in case an ERB execution blows up
         begin
-          erb_to_be_executed = subject_template_path
-          subject = subject_template.result(bnd).chomp
+          erb_to_be_executed = subject_template
+          subject = subject_template_erb.result(bnd).chomp
 
-          erb_to_be_executed = text_template_path
-          body_text = text_template.result(bnd)
+          erb_to_be_executed = text_template
+          body_text = text_template_erb.result(bnd)
 
-          erb_to_be_executed = html_template_path
-          body_html = html_template.result(bnd)
+          erb_to_be_executed = html_template
+          body_html = html_template_erb.result(bnd)
         rescue => e
-          @logger.error "Error while excuting ERBs for an email: " +
+          @logger.error "Error while executing ERBs for an email: " +
             "ERB being executed: #{erb_to_be_executed}"
           raise
         end