katello 1.5.0

data/app/lib/katello/util/report_table.rb

@@ -0,0 +1,102 @@
+#
+# Copyright 2013 Red Hat, Inc.
+#
+# This software is licensed to you under the GNU General Public
+# License as published by the Free Software Foundation; either version
+# 2 of the License (GPLv2) or (at your option) any later version.
+# There is NO WARRANTY for this software, express or implied,
+# including the implied warranties of MERCHANTABILITY,
+# NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
+# have received a copy of GPLv2 along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+
+require 'csv'
+
+module Katello
+module Util
+  class ReportTable
+
+    attr_accessor :transform, :column_names, :data, :renamed_columns, :column_hash
+
+    def initialize(params)
+      self.transform = params[:transforms]
+      self.column_names = params.fetch(:column_names, [])#retained for ordering
+      self.data = params[:data]
+      self.renamed_columns = {}
+      self.column_hash = {}
+      column_names.each{ |name| column_hash[name] = {:name => name}}
+    end
+
+    def rename_column(original, new)
+      column_hash[original][:name] = new
+    end
+
+    def as(type)
+      if type == :csv
+        as_csv(transform_data)
+      elsif type == :text
+        as_text(transform_data)
+      end
+    end
+
+    private
+
+    def transform_data
+      record_data = data.collect do |d|
+        OpenStruct.new(d.slice(*self.column_names))
+      end
+      record_data.each { |d| self.transform.call(d) }
+      record_data
+    end
+
+    def calculate_column_size(transformed_data)
+      total = 0
+      column_names.each do |name|
+        max_size = column_hash[name][:name].size
+        transformed_data.each do |row|
+          text_size = row.send(name).to_s.size
+          max_size = text_size if max_size < text_size
+        end
+        column_hash[name][:size] = (max_size + 2)
+        total += (max_size + 2)
+      end
+      total
+    end
+
+    def as_text(transformed_data)
+      text = ""
+      total = calculate_column_size(transformed_data) + column_names.size - 1
+      text += text_separator(total)
+      text += "|#{column_names.collect{ |name| pad(column_hash[name][:name], column_hash[name][:size]) }.join("|")}|\n"
+      text += text_separator(total)
+
+      transformed_data.each do |row|
+        text += "|#{column_names.collect{ |name| pad(row.send(name), column_hash[name][:size]) }.join("|")}|\n"
+        text += text_separator(total)
+      end
+
+      text
+    end
+
+    def text_separator(size)
+     "+#{'-' * size}+\n"
+    end
+
+    def pad(string, max_size)
+      new_spaces = max_size - string.size
+      left = new_spaces / 2.to_i
+      right = new_spaces - left
+      (" " * left) + string + (" " * right)
+    end
+
+    def as_csv(transformed_data)
+      CSV.generate do |csv|
+        csv << column_names.collect { |name| column_hash[name][:name] }
+        transformed_data.each do |item|
+          csv << column_names.collect { |name| item.send(name) }
+        end
+      end
+    end
+  end
+end
+end

data/app/lib/katello/util/search.rb

@@ -0,0 +1,73 @@
+#
+# Copyright 2013 Red Hat, Inc.
+#
+# This software is licensed to you under the GNU General Public
+# License as published by the Free Software Foundation; either version
+# 2 of the License (GPLv2) or (at your option) any later version.
+# There is NO WARRANTY for this software, express or implied,
+# including the implied warranties of MERCHANTABILITY,
+# NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
+# have received a copy of GPLv2 along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+
+module Katello
+module Util
+  module Search
+
+    DISABLED_LUCENE_SPECIAL_CHARS = ['-', ':']
+
+    def self.custom_analyzers
+      {
+        "kt_name_analyzer" => {
+          "type"      => "custom",
+          "tokenizer" => "keyword",
+          "filter"    => %w(lowercase asciifolding)
+        },
+        "autcomplete_name_analyzer" => {
+            "type"      => "custom",
+            "tokenizer" => "keyword",
+            "filter"    => %w(standard lowercase asciifolding ngram_filter)
+        }
+      }
+    end
+
+    def self.custom_filters
+      {
+          "ngram_filter"  => {
+              "type"      => "edgeNGram",
+              "side"      => "front",
+              "min_gram"  => 1,
+              "max_gram"  => 30
+          }
+      }
+    end
+
+    # Filter the search input, escaping unsupported lucene syntax (e.g. usage of - operator)
+    def self.filter_input(search)
+      return nil if search.nil?
+      DISABLED_LUCENE_SPECIAL_CHARS.each do |chr|
+        search = search.gsub(chr, '\\' + chr)
+      end
+      return search
+    end
+
+    def self.active_record_search_classes
+      ignore_list =  %w(Katello::CpConsumerUser Katello::Pool)
+      classes = get_subclasses(ActiveRecord::Base)
+      classes = classes.select{ |c| !ignore_list.include?(c.name) && c.respond_to?(:index) }
+
+      #we need index base classes first (TaskStatus) before child classes (PulpTaskStatus)
+      initial_list = classes.select{|c| c.superclass == ActiveRecord::Base}
+      subclass_list = classes - initial_list
+      initial_list + subclass_list
+    end
+
+    def self.get_subclasses(obj_class)
+      classes = obj_class.subclasses
+      subs = classes.collect {|c| get_subclasses(c) }.flatten
+      classes + subs
+    end
+
+  end
+end
+end

data/app/lib/katello/util/support.rb

@@ -0,0 +1,101 @@
+#
+# Copyright 2013 Red Hat, Inc.
+#
+# This software is licensed to you under the GNU General Public
+# License as published by the Free Software Foundation; either version
+# 2 of the License (GPLv2) or (at your option) any later version.
+# There is NO WARRANTY for this software, express or implied,
+# including the implied warranties of MERCHANTABILITY,
+# NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
+# have received a copy of GPLv2 along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+
+module Katello
+module Util
+  module Support
+    def self.deep_copy(object)
+      Marshal.load(Marshal.dump(object))
+    end
+
+    def self.time
+      a = Time.now
+      yield
+      Time.now - a
+    end
+
+    def self.scrub(params, &block_to_match)
+      params.keys.each do |key|
+        if params[key].is_a?(Hash)
+          scrub(params[key], &block_to_match)
+        elsif block_to_match.call(key, params[key])
+          params[key] = "[FILTERED]"
+        end
+      end
+      params
+    end
+
+    # Helper method to just convert
+    # a collection of objects to their
+    # string representation (mostly to be used internally)
+    def self.stringify(col)
+      col.collect{|c| c.to_s}
+    end
+
+    # Given a rules hash in the format
+    # {<attrib_name>: {<attrib_name> => ...}}
+    # the method will match the params attributes to provided
+    # rule and return a diff.
+    # Here are some of the examples
+    # rule -> {:units => [[:name, :version, :min_version, :max_version]]}
+    # will match -> {:units => [{:name = > "boo", :version => "2.0"},
+    #                 {:name = > "Foo", :min_version => "2.0"}]}
+    # rule ->     {:units => [[:id]], :date_range => [:start, :end],
+    #                :errata_type => {}, :severity => {}}
+    # will match -> {:units => [{:id => 100}],
+    #        :date_range => {:start => "05/14/2011"}}
+    # Note of caution this merely shows differences in the structure
+    # of params vs rules. It doesnt validate anything.
+    # Look at SerializedParamsValidator method for its uses.
+    def self.diff_hash_params(rule, params)
+      params = params.with_indifferent_access
+      if rule.is_a?(Array)
+        return stringify(params.keys) - stringify(rule)
+      end
+
+      rule = rule.with_indifferent_access
+      diff_data = rule.keys.collect do |k|
+        if params[k]
+          if (params[k].is_a?(Array)) && (rule[k].first.is_a?(Array))
+            diffs = params[k].collect {|pk| diff_hash_params(rule[k].first, pk)}.flatten
+            diffs
+          elsif params[k].is_a?(Hash)
+            keys = stringify(params[k].keys) - stringify(rule[k])
+            if keys.empty?
+              nil
+            else
+              {k => keys}
+            end
+          end
+        end
+      end
+      diff_data = diff_data.compact.flatten
+
+      return diff_data unless diff_data.nil? || diff_data.empty?
+      stringify(params.keys) - stringify(rule.keys)
+    end
+
+    # We need this so that we can return
+    # empty search results on an invalid query
+    # Basically this is a empty array with a total
+    # method. We could ve user Tire::Result:Collection
+    # But that class is way more involved
+    def self.array_with_total(a = [])
+      def a.total
+        size
+      end
+      a
+    end
+
+  end
+end
+end

data/app/lib/katello/util/task_status.rb

@@ -0,0 +1,142 @@
+#
+# Copyright 2013 Red Hat, Inc.
+#
+# This software is licensed to you under the GNU General Public
+# License as published by the Free Software Foundation; either version
+# 2 of the License (GPLv2) or (at your option) any later version.
+# There is NO WARRANTY for this software, express or implied,
+# including the implied warranties of MERCHANTABILITY,
+# NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
+# have received a copy of GPLv2 along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+
+module Katello
+module Util
+  module TaskStatus
+
+    # The types hash below was introduced to simplify rendering of the status of various tasks/actions.  It was
+    # initially introduced to support System Event history and was later refactored, so that it may be used
+    # for system groups...etc.  Refer to the job.rb and system_task.rb for examples of it's usage.
+    TYPES = {
+        #package tasks
+       :package_install => {
+            :english_name => N_("Package Install"),
+            :type => :package,
+            # in the event_messages structure, the first element is used for status when the action/event is scheduled
+            # (e.g. System->Packages pane, the second and third are used on the Event History for singular/plural
+            :event_messages => {
+                :running => [N_('Installing Package...'), N_('installing package...'), N_('installing packages...')],
+                :waiting => [N_('Installing Package...'), N_('installing package...'), N_('installing packages...')],
+                :finished => [N_('Package Install Complete'), N_('Package installation: "%{package}" '), N_('%{package} (%{total} other packages) installed')],
+                :error => [N_('Package Install Failed'), N_('Package install failed: "%{package}"'), N_('%{package} (%{total} other packages) install failed')],
+                :cancelled => [N_('Package Install Canceled'), N_('%{package} package install canceled'), N_('%{package} (%{total} other packages) install canceled')],
+                :timed_out => [N_('Package Install Timed Out'), N_('%{package} package install timed out'), N_('%{package} (%{total} other packages) install timed out')],
+            },
+            :user_message => _('Package Install scheduled by %s')
+
+        },
+       :package_update => {
+            :english_name => N_("Package Update"),
+            :type => :package,
+            :event_messages => {
+                :running => [N_('Updating Package...'), N_('updating package...'), N_('updating packages...')],
+                :waiting => [N_('Updating Package...'), N_('updating package...'), N_('updating packages...')],
+                :finished => [N_('Package Update Complete'), N_('%{package} package updated'), N_('%{package} (%{total} other packages) updated')],
+                :error => [N_('Package Update Failed'), N_('%{package} package update failed'), N_('%{package} (%{total} other packages) update failed')],
+                :cancelled => [N_('Package Update Canceled'), N_('%{package} package update canceled'), N_('%{package} (%{total} other packages) update canceled')],
+                :timed_out => [N_('Package Update Timed Out'), N_('%{package} package update timed out'), N_('%{package} (%{total} other packages) update timed out')],
+            },
+            :user_message => _('Package Update scheduled by %s')
+        },
+       :package_remove => {
+            :english_name => N_("Package Remove"),
+            :type => :package,
+            :event_messages => {
+                :running => [N_('Removing Package...'), N_('removing package...'), N_('removing packages...')],
+                :waiting => [N_('Removing Package...'), N_('removing package...'), N_('removing packages...')],
+                :finished => [N_('Package Remove Complete'), N_('%{package} package removed'), N_('%{package} (%{total} other packages) removed')],
+                :error => [N_('Package Remove Failed'), N_('%{package} package remove failed'), N_('%{package} (%{total} other packages) remove failed')],
+                :cancelled => [N_('Package Remove Canceled'), N_('%{package} package remove canceled'), N_('%{package} (%{total} other packages) remove canceled')],
+                :timed_out => [N_('Package Remove Timed Out'), N_('%{package} package remove timed out'), N_('%{package} (%{total} other packages) remove timed out')],
+            },
+            :user_message => _('Package Remove scheduled by %s')
+        },
+        #package group tasks
+       :package_group_install => {
+            :english_name => N_("Package Group Install"),
+            :type => :package_group,
+            :event_messages => {
+                :running => [N_('Installing Package Group...'), N_('installing package group...'), N_('installing package groups...')],
+                :waiting => [N_('Installing Package Group...'), N_('installing package group...'), N_('installing package groups...')],
+                :finished => [N_('Package Group Install Complete'), N_('%{group} package group installed'), N_('%{group} (%{total} other package groups) installed')],
+                :error => [N_('Package Group Install Failed'), N_('%{group} package group install failed'), N_('%{group} (%{total} other package groups) install failed')],
+                :cancelled => [N_('Package Group Install Canceled'), N_('%{group} package group install canceled'), N_('%{group} (%{total} other package groups) install canceled')],
+                :timed_out => [N_('Package Group Install Timed Out'), N_('%{group} package group install timed out'), N_('%{group} (%{total} other package groups) install timed out')],
+            },
+            :user_message => _('Package Group Install scheduled by %s')
+        },
+       :package_group_update => {
+            :english_name => N_("Package Group Update"),
+            :type => :package_group,
+            :event_messages => {
+                :running => [N_('Updating package group...'), N_('updating package group...'), N_('updating package groups...')],
+                :waiting => [N_('Updating package group...'), N_('updating package group...'), N_('updating package groups...')],
+                :finished => [N_('Package group update complete'), N_('%{group} package group updated'), N_('%{group} (%{total} other package groups) updated')],
+                :error => [N_('Package group update failed'), N_('%{group} package group update failed'), N_('%{group} (%{total} other package groups) update failed')],
+                :cancelled => [N_('Package group update canceled'), N_('%{group} package group update canceled'), N_('%{group} (%{total} other package groups) update canceled')],
+                :timed_out => [N_('Package group update timed out'), N_('%{group} package group update timed out'), N_('%{group} (%{total} other package groups) update timed out')],
+
+            },
+            :user_message => _('Package Group Update scheduled by %s')
+        },
+       :package_group_remove => {
+            :english_name => N_("Package Group Remove"),
+            :type => :package_group,
+            :event_messages => {
+                :running => [N_('Removing Package Group...'), N_('removing package group...'), N_('removing package groups...')],
+                :waiting => [N_('Removing Package Group...'), N_('removing package group...'), N_('removing package groups...')],
+                :finished => [N_('Package Group Remove Complete'), N_('%{group} package group removed'), N_('%{group} (%{total} other package groups) removed')],
+                :error => [N_('Package Group Remove Failed'), N_('%{group} package group remove failed'), N_('%{group} (%{total} other package groups) remove failed')],
+                :cancelled => [N_('Package Group Remove Canceled'), N_('%{group} package group remove canceled'), N_('%{group} (%{total} other package groups) remove canceled')],
+                :timed_out => [N_('Package Group Remove Timed Out'), N_('%{group} package group remove timed out'), N_('%{group} (%{total} other package groups) remove timed out')],
+
+            },
+            :user_message => _('Package Group Remove scheduled by %s')
+        },
+       :errata_install => {
+            :english_name => N_("Errata Install"),
+            :type => :errata,
+            :event_messages => {
+                :running => [N_('Installing Erratum...'), N_('installing erratum...'), N_('installing errata...')],
+                :waiting => [N_('Installing Erratum...'), N_('installing erratum...'), N_('installing errata...')],
+                :finished => [N_('Erratum Install Complete'), N_('%{errata} erratum installed'), N_('%{errata} (%{total} other errata) installed')],
+                :error => [N_('Erratum Install Failed'), N_('%{errata} erratum install failed'), N_('%{errata} (%{total} other errata) install failed')],
+                :cancelled => [N_('Erratum Install Canceled'), N_('%{errata} erratum install canceled'), N_('%{errata} (%{total} other errata) install canceled')],
+                :timed_out => [N_('Erratum Install Timed Out'), N_('%{errata} erratum install timed out'), N_('%{errata} (%{total} other errata) install timed out')],
+            },
+            :user_message => _('Errata Install scheduled by %s')
+        },
+       :candlepin_event => {
+            :english_name => N_("Candlepin Event"),
+            :type => :candlepin_event,
+            :event_messages => {
+            },
+            :user_message => nil
+        },
+       :content_view_publish => {
+            :english_name => N_("content view publish"),
+            :type => :content_view_publish
+        },
+       :content_view_refresh => {
+            :english_name => N_("content view refresh"),
+            :type => :content_view_refresh
+        }
+    }.with_indifferent_access
+
+    TYPES.each_pair do |name, value|
+      value[:name] = _(value[:english_name])
+    end
+
+  end
+end
+end

data/app/lib/katello/util/thread_session.rb

@@ -0,0 +1,86 @@
+#
+# Copyright 2013 Red Hat, Inc.
+#
+# This software is licensed to you under the GNU General Public
+# License as published by the Free Software Foundation; either version
+# 2 of the License (GPLv2) or (at your option) any later version.
+# There is NO WARRANTY for this software, express or implied,
+# including the implied warranties of MERCHANTABILITY,
+# NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
+# have received a copy of GPLv2 along with this software; if not, see
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+
+#
+# In several cases we want to break chain of responsibility in MVC a bit and provide
+# a safe way to access current user (and maybe few more data items). Storing it as
+# a global variable (or class member) is not thread-safe. Including ThreadSession::
+# UserModel in models and ThreadSession::Controller in the application controller
+# allows this without any concurrent issues.
+#
+# Idea taken from sentinent_user rails plugin.
+#
+# http://github.com/bokmann/sentient_user
+# http://github.com/astrails/let_my_controller_go
+# http://rails-bestpractices.com/posts/47-fetch-current-user-in-models
+#
+
+module Katello
+  def self.pulp_server=(server)
+    Thread.current[:pulp_server] = server
+  end
+
+  def self.pulp_server
+    Thread.current[:pulp_server]
+  end
+end
+
+module Katello
+module Util
+  module ThreadSession
+
+    # include this in the User model
+    module UserModel
+      # TODO: break up method
+      # rubocop:disable MethodLength
+      def self.included(base)
+        base.class_eval do
+          def self.current
+            Thread.current[:user]
+          end
+
+          def self.current=(o)
+            unless (o.nil? || o.is_a?(self) || o.class.name == 'RSpec::Mocks::Mock')
+              fail(ArgumentError, "Unable to set current User, expected class '#{self}', got #{o.inspect}")
+            end
+            if o.is_a?(::User)
+              debug = ["Setting current user thread-local variable to", o.firstname, o.lastname]
+              Rails.logger.debug debug.join(" ")
+            end
+            Thread.current[:user] = o
+
+            if Katello.config.use_pulp && o && o.respond_to?(:remote_id)
+              uri = URI.parse(Katello.config.pulp.url)
+
+              Katello.pulp_server = Runcible::Instance.new(
+                :url      => "#{uri.scheme}://#{uri.host.downcase}",
+                :api_path => uri.path,
+                :user     => o.remote_id,
+                :timeout      => Katello.config.rest_client_timeout,
+                :open_timeout => Katello.config.rest_client_timeout,
+                :oauth    => {:oauth_secret => Katello.config.pulp.oauth_secret,
+                              :oauth_key    => Katello.config.pulp.oauth_key },
+                :logging  => {:logger     => ::Logging.logger['pulp_rest'],
+                              :exception  => true,
+                              :debug      => true }
+              )
+            end
+
+          end
+
+        end
+      end
+    end
+
+  end
+end
+end