├── .gitignore ├── TODO ├── .travis.yml ├── test ├── unit │ └── host_observer_test.rb └── test_helper.rb ├── extra └── foreman-debug.sh ├── Gemfile ├── .github └── workflows │ └── ruby_ci.yml ├── lib ├── foreman_hooks │ ├── as_dependencies_hook.rb │ ├── engine.rb │ ├── callback_hooks.rb │ ├── orchestration_hook.rb │ └── util.rb ├── tasks │ └── hooks.rake └── foreman_hooks.rb ├── examples ├── bash │ ├── log.sh │ └── hook_functions.sh └── python │ ├── functions.py │ └── host │ └── managed │ └── create │ └── 10-logger.py ├── foreman_hooks.gemspec ├── Rakefile ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .rvmrc 2 | .ruby-* 3 | Gemfile.lock 4 | test/foreman_app 5 | .bundle 6 | pkg/ 7 | *gem 8 | -------------------------------------------------------------------------------- /TODO: -------------------------------------------------------------------------------- 1 | * pass more data into hooks 2 | * JSON dump of the model via stdin + utility shell script 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: ruby 2 | rvm: 3 | - "1.8.7" 4 | - "1.9.3" 5 | before_install: rake test:foreman_prepare 6 | script: rake test 7 | -------------------------------------------------------------------------------- /test/unit/host_observer_test.rb: -------------------------------------------------------------------------------- 1 | require 'test_helper' 2 | 3 | class HostObserverTest < ActiveSupport::TestCase 4 | test "should save" do 5 | host = Host::Base.new 6 | host.name = "foo" 7 | assert host.save 8 | end 9 | end 10 | -------------------------------------------------------------------------------- /extra/foreman-debug.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # This file provides additional debug information for foreman-debug tool and is 4 | # symlinked as /usr/share/foreman/script/foreman-debug.d/50-foreman_hooks 5 | 6 | add_cmd "find /usr/share/foreman/config/hooks/ -type f -executable" "foreman_hooks_list" 7 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "http://rubygems.org" 2 | 3 | FOREMAN_GEMFILE=File.expand_path('../test/foreman_app/Gemfile', __FILE__) 4 | unless File.exist?(FOREMAN_GEMFILE) 5 | puts <> /tmp/hook.log 17 | 18 | # exit code is important on orchestration tasks 19 | exit 0 20 | -------------------------------------------------------------------------------- /foreman_hooks.gemspec: -------------------------------------------------------------------------------- 1 | require "date" 2 | 3 | Gem::Specification.new do |s| 4 | s.name = "foreman_hooks" 5 | 6 | s.version = "0.3.17" 7 | s.date = Date.today.to_s 8 | 9 | s.summary = "Run custom hook scripts on Foreman events" 10 | s.description = "Plugin engine for Foreman that enables running custom hook scripts on Foreman events" 11 | s.homepage = "https://github.com/theforeman/foreman_hooks" 12 | s.licenses = ["GPL-3.0"] 13 | s.require_paths = ["lib"] 14 | 15 | s.authors = ["Dominic Cleal"] 16 | s.email = "dominic@cleal.org" 17 | 18 | s.extra_rdoc_files = [ 19 | "LICENSE", 20 | "README.md", 21 | "TODO" 22 | ] 23 | s.files = `git ls-files`.split("\n") - Dir[".*", "Gem*", "*.gemspec"] 24 | end 25 | -------------------------------------------------------------------------------- /lib/foreman_hooks/engine.rb: -------------------------------------------------------------------------------- 1 | require 'foreman_hooks' 2 | 3 | module ForemanHooks 4 | class Engine < ::Rails::Engine 5 | engine_name 'foreman_hooks' 6 | 7 | config.to_prepare do 8 | ForemanHooks.hooks.each do |klass,events| 9 | begin 10 | klass_const = klass.constantize 11 | rescue NameError => e 12 | ForemanHooks.logger.error "foreman_hooks: unknown hook object #{klass}, check against `foreman-rake hooks:objects`" 13 | next 14 | end 15 | ForemanHooks.attach_hook(klass_const, events) 16 | end 17 | end 18 | 19 | initializer 'foreman_hooks.register_plugin', :before => :finisher_hook do |app| 20 | Foreman::Plugin.register :foreman_hooks do 21 | end 22 | end 23 | end 24 | end 25 | -------------------------------------------------------------------------------- /examples/bash/hook_functions.sh: -------------------------------------------------------------------------------- 1 | # Utilities for hook scripts, used with foreman_hooks 2 | # 3 | # Source this at the start of any bash hook script: 4 | # 5 | # . hook_functions.sh 6 | # 7 | # It reads in a JSON representation of the object and then provides a 8 | # hook_data wrapper around jgrep to read fields from it, e.g. 9 | # 10 | # hostname=$(hook_data host.name) 11 | # comment=$(hook_data host.comment) 12 | 13 | # update, create, before_destroy etc. 14 | HOOK_EVENT=$1 15 | # to_s representation of the object, e.g. host's fqdn 16 | HOOK_OBJECT=$2 17 | 18 | HOOK_OBJECT_FILE=$(mktemp -t foreman_hooks.XXXXXXXXXX) 19 | trap "rm -f $HOOK_OBJECT_FILE" EXIT 20 | cat > $HOOK_OBJECT_FILE 21 | 22 | hook_data() { 23 | if [ $# -eq 1 ]; then 24 | jgrep -s "$1" < $HOOK_OBJECT_FILE 25 | else 26 | jgrep "$*" < $HOOK_OBJECT_FILE 27 | fi 28 | } 29 | -------------------------------------------------------------------------------- /test/test_helper.rb: -------------------------------------------------------------------------------- 1 | require 'rubygems' 2 | require 'bundler/setup' 3 | 4 | ENV["RAILS_ENV"] ||= 'test' 5 | require File.join("foreman_app/config/environment.rb") 6 | 7 | require 'test/unit' 8 | require 'foreman_hooks' 9 | require 'rails/test_help' 10 | 11 | Rails.backtrace_cleaner.remove_silencers! 12 | 13 | class ActiveSupport::TestCase 14 | # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order. 15 | # 16 | # Note: You'll currently still have to declare fixtures explicitly in integration tests 17 | # -- they do not yet inherit this setting 18 | 19 | foreman_dir = File.expand_path("../foreman_app", File.join(Dir.pwd, __FILE__)) 20 | fixture_path=File.join(foreman_dir, "test/fixtures") 21 | fixtures :all 22 | 23 | set_fixture_class({ :hosts => Host::Base }) 24 | end 25 | 26 | def set_session_user 27 | SETTINGS[:login] ? {:user => User.admin.id, :expires_at => 5.minutes.from_now} : {} 28 | end 29 | -------------------------------------------------------------------------------- /lib/foreman_hooks/callback_hooks.rb: -------------------------------------------------------------------------------- 1 | require 'foreman_hooks/util' 2 | 3 | module ForemanHooks::CallbackHooks 4 | extend ActiveSupport::Concern 5 | include ForemanHooks::Util 6 | 7 | included do 8 | ForemanHooks.events(self).each do |event| 9 | filter, name = event.to_s.split('_', 2) 10 | next unless name 11 | 12 | Rails.logger.debug("Created hook method #{event} on #{self}") 13 | if "#{event}" == "before_destroy" 14 | set_callback name.to_sym, filter.to_sym, "#{event}_hooks".to_sym, prepend: true 15 | else 16 | set_callback name.to_sym, filter.to_sym, "#{event}_hooks".to_sym 17 | end 18 | define_method("#{event}_hooks") do 19 | Rails.logger.debug "Observed #{event} hook on #{self}" 20 | return unless hooks = ForemanHooks.find_hooks(self.class, event) 21 | 22 | Rails.logger.debug "Running #{hooks.size} hooks for #{self.class.to_s}##{event}" 23 | hooks.each { |filename| exec_hook(filename, event.to_s, to_s) } 24 | end 25 | end 26 | end 27 | end 28 | -------------------------------------------------------------------------------- /examples/python/functions.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | ####### 3 | # To allow this module to be imported by other triggers 4 | # execute the commands below: 5 | # $ mkdir -p /usr/share/foreman-community/hooks 6 | # $ touch /usr/share/foreman-community/hooks/__init__.py 7 | # $ cp functions.py /usr/share/foreman-community/hooks/ 8 | ######## 9 | import json 10 | import sys 11 | import tempfile 12 | 13 | HOOK_TEMP_DIR = "/usr/share/foreman/tmp" 14 | 15 | # HOOK_EVENT = update, create, before_destroy etc. 16 | # HOOK_OBJECT = to_s representation of the object, e.g. host's fqdn 17 | HOOK_EVENT, HOOK_OBJECT = (sys.argv[1], sys.argv[2]) 18 | 19 | 20 | def get_json_hook(): 21 | ''' 22 | Create JSON object to be imported by hook/trigger 23 | Saves the data received via stdin to file. 24 | It does not require to save to a file, but it may be useful 25 | to troubleshooting. 26 | ''' 27 | 28 | with tempfile.NamedTemporaryFile( 29 | dir=HOOK_TEMP_DIR, 30 | # set to False for troubleshooting 31 | delete=True, 32 | prefix="foreman_hooks.") as hook: 33 | 34 | json_hook = sys.stdin.read() 35 | hook.file.write(json_hook) 36 | hook.file.flush() 37 | return json.loads(json_hook) 38 | -------------------------------------------------------------------------------- /lib/tasks/hooks.rake: -------------------------------------------------------------------------------- 1 | namespace :hooks do 2 | desc 'Print a list of object names that can be hooked' 3 | task :objects => :environment do 4 | Rails.application.config.eager_load_namespaces.each(&:eager_load!) 5 | 6 | # Gather the models 7 | models = ActiveRecord::Base.descendants.collect(&:name).collect(&:underscore) 8 | 9 | # filter out known models not hookable 10 | models.reject! {|e| e.start_with?('habtm')} 11 | 12 | puts models.sort 13 | end 14 | 15 | desc 'Print a list of event names for a given object, e.g. hooks:events[host/managed]' 16 | task :events, [:object] => :environment do |t,args| 17 | model = begin 18 | args[:object].camelize.constantize 19 | rescue NameError => e 20 | fail("Unknown model #{args[:object]}, run hooks:objects to get a list (#{e.message})") 21 | end 22 | 23 | # 1. List default ActiveRecord callbacks 24 | events = ActiveRecord::Callbacks::CALLBACKS.map(&:to_s).reject { |e| e.start_with?('around_') } 25 | 26 | # 2. List Foreman orchestration callbacks 27 | events.concat(['create', 'destroy', 'update', 'postcreate', 'postupdate']) if model.included_modules.include?(Orchestration) 28 | 29 | # 3. List custom define_callbacks/define_model_callbacks 30 | callbacks = model.methods.map { |m| $1 if m =~ /\A_([a-z]\w+)_callbacks\z/ }.compact 31 | # ignore callbacks that are in the AR default list 32 | callbacks.delete_if { |c| events.any? { |e| e.end_with?("_#{c}") } } 33 | callbacks.each { |c| events.push("before_#{c}", "after_#{c}") } 34 | 35 | puts events.sort 36 | end 37 | end 38 | -------------------------------------------------------------------------------- /examples/python/host/managed/create/10-logger.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import sys 3 | import tempfile 4 | import subprocess 5 | 6 | sys.path.append('/usr/share/foreman-community/hooks') 7 | 8 | from functions import \ 9 | (HOOK_EVENT, HOOK_OBJECT, HOOK_TEMP_DIR, get_json_hook) 10 | 11 | PREFIX = "created_by_hook-{}".format(sys.argv[0].split('/')[-1]) 12 | 13 | HOOK_JSON = get_json_hook() 14 | 15 | cmd = ['logger'] 16 | 17 | # read the information received 18 | if HOOK_JSON.get('host'): 19 | hostname = HOOK_JSON.get('host').get('name', None) 20 | if hostname: 21 | cmd.append('System:{0}'.format(hostname)) 22 | 23 | mac_address = HOOK_JSON.get('host').get('mac', None) 24 | if mac_address: 25 | cmd.append('MAC:{0}'.format(mac_address)) 26 | 27 | operating_system = HOOK_JSON.get('host').get('operatingsystem_name', None) 28 | if operating_system: 29 | cmd.append('OS:{0}'.format(operating_system)) 30 | 31 | # execute logger command 32 | subprocess.call(cmd) 33 | 34 | # for troubleshooting purposes, you can save the received data to a file 35 | # to parse the information to be used on the trigger. 36 | # To accomplish it, set the variable dumpdata to True 37 | dumpdata = False 38 | if dumpdata: 39 | with tempfile.NamedTemporaryFile(dir=HOOK_TEMP_DIR, 40 | delete=False, 41 | prefix=PREFIX) as fd: 42 | fd.file.write("HOOK_OBJECT: %s\n" % HOOK_OBJECT) 43 | fd.file.write("HOOK_EVENT: %s\n" % HOOK_EVENT) 44 | fd.file.write("HOOK_JSON: %s\n" % HOOK_JSON) 45 | 46 | # local variables 47 | fd.file.write("hostname: %s\n" % hostname) 48 | fd.file.write("mac_address: %s\n" % mac_address) 49 | fd.file.write("os: %s\n" % operating_system) 50 | fd.file.flush() 51 | 52 | sys.exit(0) 53 | -------------------------------------------------------------------------------- /lib/foreman_hooks/orchestration_hook.rb: -------------------------------------------------------------------------------- 1 | require 'foreman_hooks/util' 2 | 3 | module ForemanHooks::OrchestrationHook 4 | extend ActiveSupport::Concern 5 | include ForemanHooks::Util 6 | 7 | included do 8 | after_validation :queue_hooks_validate 9 | before_destroy :queue_hooks_destroy 10 | end 11 | 12 | def queue_hooks_validate 13 | return unless errors.empty? 14 | queue_hooks(new_record? ? 'create' : 'update') 15 | queue_hooks(new_record? ? 'postcreate' : 'postupdate') 16 | end 17 | 18 | def queue_hooks_destroy 19 | return unless errors.empty? 20 | queue_hooks('destroy') 21 | end 22 | 23 | def queue_hooks(event) 24 | logger.debug "Observed #{event} hook on #{self}" 25 | unless is_a? Orchestration 26 | logger.error "#{self.class.to_s} doesn't support orchestration, can't run orchestration hooks: use Rails events instead" 27 | return 28 | end 29 | 30 | return unless hooks = ForemanHooks.find_hooks(self.class, event) 31 | logger.debug "Queuing #{hooks.size} hooks for #{self.class.to_s}##{event}" 32 | 33 | counter = 0 34 | hooks.each do |filename| 35 | basename = File.basename(filename) 36 | priority = basename =~ /^(\d+)/ ? $1 : 10000 + (counter += 1) 37 | logger.debug "Queuing hook #{filename} for #{self.class.to_s}##{event} at priority #{priority}" 38 | queue_to_use = (event =~ /^post/) ? post_queue : queue 39 | queue_to_use.create(:name => "Hook: #{filename}", :priority => priority.to_i, 40 | :action => [HookRunner.new(filename, self, event.to_s), event.to_s == 'destroy' ? :hook_execute_del : :hook_execute_set]) 41 | end 42 | end 43 | 44 | # Orchestration runs methods against an object, so generate a runner for each 45 | # hook that will need executing 46 | class HookRunner 47 | def initialize(filename, obj, event) 48 | @filename = filename 49 | @obj = obj 50 | @event = event 51 | end 52 | 53 | def args 54 | [@obj.to_s] 55 | end 56 | 57 | def hook_execute_set 58 | @obj.exec_hook(@filename, @event, *args) 59 | end 60 | 61 | def hook_execute_del 62 | @obj.exec_hook(@filename, 'destroy', *args) 63 | end 64 | end 65 | end 66 | -------------------------------------------------------------------------------- /lib/foreman_hooks.rb: -------------------------------------------------------------------------------- 1 | module ForemanHooks 2 | require 'foreman_hooks/engine' 3 | require 'foreman_hooks/util' 4 | require 'foreman_hooks/as_dependencies_hook' 5 | require 'foreman_hooks/callback_hooks' 6 | require 'foreman_hooks/orchestration_hook' 7 | 8 | class Error < RuntimeError; end 9 | 10 | class << self 11 | def hooks_root 12 | File.join(Rails.application.root, 'config', 'hooks') 13 | end 14 | 15 | # Find all executable hook files under $hook_root/model_name/event_name/ 16 | def discover_hooks 17 | hooks = {} 18 | Dir.glob(File.join(hooks_root, '**', '*')) do |filename| 19 | next if filename.end_with? '~' 20 | next if filename.end_with? '.bak' 21 | next if File.directory? filename 22 | next unless File.executable? filename 23 | 24 | relative = filename[hooks_root.size..-1] 25 | next unless relative =~ %r{^/(.+)/([^/]+)/([^/]+)$} 26 | klass = $1.camelize 27 | event = $2 28 | script_name = $3 29 | hooks[klass] ||= {} 30 | hooks[klass][event] ||= [] 31 | hooks[klass][event] << filename 32 | logger.debug "Found hook to #{klass.to_s}##{event}, filename #{script_name}" 33 | end 34 | hooks 35 | end 36 | 37 | # {'ModelClass' => {'event_name' => ['/path/to/01.sh', '/path/to/02.sh']}} 38 | def hooks 39 | unless @hooks 40 | @hooks = discover_hooks 41 | @hooks.each do |klass,events| 42 | events.each do |event,hooks| 43 | logger.info "Finished discovering #{hooks.size} hooks for #{klass}##{event}" 44 | hooks.sort! 45 | end 46 | end 47 | end 48 | @hooks 49 | end 50 | 51 | # ['event1', 'event2'] 52 | def events(klass = nil) 53 | filtered = if klass 54 | klass = klass.name if klass.kind_of? Class 55 | Hash[hooks.select { |k,e| k == klass }] 56 | else 57 | hooks 58 | end 59 | filtered.values.map(&:keys).flatten.uniq.map(&:to_sym) 60 | end 61 | 62 | def find_hooks(klass, event) 63 | klass = klass.name if klass.kind_of? Class 64 | return unless filtered = hooks[klass] 65 | return unless filtered = filtered[event.to_s] 66 | return if filtered.empty? 67 | filtered 68 | end 69 | 70 | def attach_hook(klass, events) 71 | if events.keys.detect { |event| ['create', 'update', 'destroy', 'postcreate', 'postupdate'].include? event } 72 | unless klass.ancestors.include?(ForemanHooks::OrchestrationHook) 73 | logger.debug "Extending #{klass} with foreman_hooks orchestration hooking support" 74 | klass.send(:include, ForemanHooks::OrchestrationHook) 75 | end 76 | end 77 | 78 | unless klass.ancestors.include?(ForemanHooks::CallbackHooks) 79 | logger.debug "Extending #{klass} with foreman_hooks Rails hooking support" 80 | klass.send(:include, ForemanHooks::CallbackHooks) 81 | end 82 | end 83 | 84 | def logger; Rails.logger; end 85 | end 86 | end 87 | -------------------------------------------------------------------------------- /lib/foreman_hooks/util.rb: -------------------------------------------------------------------------------- 1 | require 'open3' 2 | 3 | module ForemanHooks::Util 4 | extend ActiveSupport::Concern 5 | 6 | def render_hook_type 7 | case self.class.name 8 | when "Host::Managed" 9 | 'host' 10 | when "Host::Discovered" 11 | 'discovered_host' 12 | when "Audited::Adapters::ActiveRecord::Audit", "Audited::Audit" 13 | 'audit' 14 | else 15 | self.class.name.downcase 16 | end 17 | end 18 | 19 | def rabl_path 20 | "api/v2/#{render_hook_type.tableize}/show" 21 | end 22 | 23 | def render_hook_json 24 | # APIv2 has some pretty good templates. We could extend them later in special cases. 25 | # Wrap them in a root node for pre-1.4 compatibility 26 | view_path = ActionController::Base.view_paths.collect(&:to_path) 27 | json = Rabl.render(self, rabl_path, 28 | view_path: view_path, format: :json, scope: RablScope.new) 29 | %Q|{"#{render_hook_type}":#{json}}| 30 | rescue => e 31 | logger.warn "Unable to render #{self} (#{self.class}) using RABL: #{e.message}" 32 | logger.debug e.backtrace.join("\n") 33 | self.to_json 34 | end 35 | 36 | def exec_hook(*args) 37 | unless File.executable?(args.first) 38 | logger.warn("Hook #{args.first} no longer exists or isn't executable, so skipping execution of the hook. The server should be restarted after adding or removing hooks.") 39 | return true 40 | end 41 | 42 | logger.debug "Running hook: #{args.join(' ')}" 43 | success, output = if defined? Bundler && Bundler.responds_to(:with_clean_env) 44 | Bundler.with_clean_env { exec_hook_int(render_hook_json, *args) } 45 | else 46 | exec_hook_int(render_hook_json, *args) 47 | end 48 | # Raising here causes Foreman Orchestration to correctly show error bubble in GUI 49 | raise ForemanHooks::Error.new "Hook failure running `#{args.join(' ')}`: #{$?} #{output}" unless success 50 | success 51 | end 52 | 53 | def exec_hook_int(stdin_data, *args) 54 | # Set environment vars available in hook scripts 55 | # Name of active Foreman user: 56 | ENV['FOREMAN_HOOKS_USER'] = User.current.login 57 | 58 | args.map!(&:to_s) 59 | output, status = if Open3.respond_to? :capture2e 60 | Open3.capture2e(*args.push(:stdin_data => stdin_data)) 61 | else # 1.8 62 | Open3.popen3(*args) do |stdin,stdout,stderr| 63 | begin 64 | stdin.write(stdin_data) 65 | stdin.close 66 | rescue Errno::EPIPE 67 | logger.debug "Foreman hook input data skipped, closed pipe" 68 | end 69 | # we could still deadlock here, it'd ideally select() on stdout+err 70 | output = stderr.read 71 | end 72 | [output, $?] 73 | end 74 | logger.debug "Hook output: #{output}" if output && !output.empty? 75 | [status.success?, output] 76 | end 77 | 78 | class RablScope 79 | def initialize 80 | # Used by api/v2/hosts/main.json.yaml to include parameter lists 81 | @all_parameters = true 82 | @parameters = true 83 | end 84 | 85 | def params 86 | # Used by app/views/api/v2/common/show_hidden.json.rabl to show hidden parameter values (#17653) 87 | { 'show_hidden' => true, 'show_hidden_parameters' => true } 88 | end 89 | end 90 | end 91 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | # encoding: utf-8 2 | 3 | require 'rubygems' 4 | require 'rake' 5 | require 'fileutils' 6 | 7 | task :default => :test 8 | 9 | ENGINE_DIR = File.expand_path('..', __FILE__) 10 | FOREMAN_DIR = 'test/foreman_app' 11 | 12 | namespace :test do 13 | desc "Download latest foreman devel source and install dependencies" 14 | task :foreman_prepare do 15 | foreman_repo = 'https://github.com/theforeman/foreman.git' 16 | foreman_gemfile = File.join(FOREMAN_DIR, "Gemfile") 17 | unless File.exists?(foreman_gemfile) 18 | puts "Foreman source code is not present at #{FOREMAN_DIR}" 19 | puts "Downloading latest Foreman development branch into #{FOREMAN_DIR}..." 20 | FileUtils.mkdir_p(FOREMAN_DIR) 21 | 22 | unless system("git clone #{foreman_repo} #{FOREMAN_DIR}") 23 | puts "Error while getting latest Foreman code from #{foreman_repo} into #{FOREMAN_DIR}" 24 | fail 25 | end 26 | end 27 | 28 | gemfile_content = File.read(foreman_gemfile) 29 | unless gemfile_content.include?('FOREMAN_GEMFILE') 30 | puts 'Preparing Gemfile' 31 | gemfile_content.gsub!('__FILE__', 'FOREMAN_GEMFILE') 32 | gemfile_content.insert(0, "FOREMAN_GEMFILE = __FILE__ unless defined? FOREMAN_GEMFILE\n") 33 | File.open(foreman_gemfile, 'w') { |f| f << gemfile_content } 34 | end 35 | 36 | settings_file = "#{FOREMAN_DIR}/config/settings.yaml" 37 | unless File.exists?(settings_file) 38 | puts 'Preparing settings file' 39 | FileUtils.copy("#{settings_file}.example", settings_file) 40 | settings_content = File.read(settings_file) 41 | settings_content.sub!('organizations_enabled: false', 'organizations_enabled: true') 42 | settings_content << ":puppetgem: true\n" 43 | File.open(settings_file, 'w') { |f| f << settings_content } 44 | end 45 | 46 | db_file = "#{FOREMAN_DIR}/config/database.yml" 47 | unless File.exists?(db_file) 48 | puts 'Preparing database file' 49 | FileUtils.copy("#{db_file}.example", db_file) 50 | end 51 | 52 | ["#{ENGINE_DIR}/.bundle/config", "#{FOREMAN_DIR}/.bundle/config"].each do |bundle_file| 53 | unless File.exists?(bundle_file) 54 | FileUtils.mkdir_p(File.dirname(bundle_file)) 55 | puts 'Preparing bundler configuration' 56 | File.open(bundle_file, 'w') { |f| f << < [:db_prepare, :set_loadpath] do 106 | Dir.glob('test/**/*_test.rb') { |f| require f.sub('test/','') unless f.include? '/foreman_app/' } 107 | end 108 | 109 | end 110 | 111 | task :test => 'test:all' 112 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # foreman_hooks 2 | 3 | Allows you to trigger scripts and commands on the Foreman server at any point 4 | in an object's lifecycle in Foreman. This lets you run scripts when a host 5 | is created, or finishes provisioning etc. 6 | 7 | It enables extension of Foreman's host orchestration so additional tasks can 8 | be executed, and can register hooks into standard Rails callbacks for any 9 | Foreman object, all with shell scripts. 10 | 11 | # Installation: 12 | 13 | Please see the Foreman wiki for appropriate instructions: 14 | 15 | * [Foreman: How to Install a Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin) 16 | 17 | The gem name is "foreman_hooks". 18 | 19 | RPM users can install the "tfm-rubygem-foreman_hooks" or 20 | "rubygem-foreman_hooks" packages. Debian/Ubuntu users can install the 21 | "ruby-foreman-hooks" package. 22 | 23 | # Usage 24 | 25 | Hooks are stored in `/usr/share/foreman/config/hooks` (`~foreman/config/hooks`) 26 | with a subdirectory for the object, then a subdirectory for the event name. 27 | 28 | ~foreman/config/hooks/[OBJECT]/[EVENT]/[HOOK_SCRIPT] 29 | 30 | Examples: 31 | 32 | ~foreman/config/hooks/host/managed/create/50_register_system.sh 33 | ~foreman/config/hooks/host/managed/destroy/15_cleanup_database.sh 34 | ~foreman/config/hooks/smart_proxy/after_create/01_email_operations.sh 35 | ~foreman/config/hooks/audited/audit/after_create/01_syslog.sh 36 | 37 | After adding or removing hooks, restart the Foreman server to update the list 38 | of known hooks (usually `apache2` or `httpd` when using Passenger, or 39 | `touch ~foreman/tmp/restart.txt`). 40 | 41 | ## Objects / Models 42 | 43 | Every object (or model in Rails terms) in Foreman can have hooks. Check 44 | `~foreman/app/models` for the full list, but these are the interesting ones: 45 | 46 | * `host/managed` 47 | * `config_report` (or `report` in Foreman 1.10 or older) 48 | * `nic/managed` 49 | * `hostgroup` 50 | * `user` 51 | 52 | To generate a list of *all* possible models, issue the following command: 53 | 54 | # foreman-rake hooks:objects 55 | 56 | and to get events for a listed object (e.g. `host/managed`): 57 | 58 | # foreman-rake hooks:events[host/managed] 59 | 60 | ## Orchestration events 61 | 62 | _Only supported on these objects:_ 63 | 64 | * _host/managed_ 65 | * _nic/\*_ 66 | 67 | Foreman supports orchestration tasks for hosts and NICs (each network 68 | interface) which happen when the object is created, updated and destroyed. 69 | These tasks are shown to the user in the UI and if they fail, will 70 | automatically trigger a rollback of the action. A rollback is performed as 71 | an opposite action (e.g. for DHCP record creation a rollback action is 72 | destroy). 73 | 74 | The following hooks are executed during `around_save` Rails callback: 75 | 76 | * `create` 77 | * `update` 78 | 79 | The following hooks are executed during `on_destroy` Rails callback: 80 | 81 | * `destroy` 82 | 83 | The following hooks are executed during `after_commit` Rails callback: 84 | 85 | * `postcreate` 86 | * `postupdate` 87 | 88 | The major difference between `create` and `postcreate` (or update respectively) is how late the hook is called during save operation. In the former case when a hook fails it starts rollback and operation can be still cancelled. In the latter case object was already saved and there is no way of cancelling the operation, but all referenced data should be properly loaded. The advice is to use the latter hooks as they will likely contain all the required data (e.g. nested parameters). 89 | 90 | Orchestration hooks can be given a priority by prefixing the filename with the 91 | priority number, therefore it is possible to order them before or after 92 | built-in orchestration steps (before DNS records are created for example). 93 | Existing common priority levels are: 94 | 95 | * _2_: Set up compute instance (create VM) 96 | * _10_: Create DNS record 97 | * _10_: Create DHCP reservation 98 | * _20_: Deploy TFTP configs 99 | * _50_: Create realm entry 100 | * _1000_: Power up compute instance 101 | 102 | ## Rails events 103 | 104 | _Supported on all object types._ 105 | 106 | For hooks on anything apart from hosts or NICs (which support orchestration, 107 | as above) then the standard Rails events will be needed. These are the most 108 | interesting events provided: 109 | 110 | * `after_create`, `before_create` 111 | * `after_destroy`, `before_destroy` 112 | 113 | Every event has a "before" and "after" hook. For the full list, see the 114 | Constants section at the bottom of the 115 | [ActiveRecord::Callbacks](http://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html) 116 | documentation. 117 | 118 | The host object has two additional callbacks that you can use: 119 | 120 | * `host/managed/after_build` triggers when a host is put into build mode (does 121 | not trigger upon new host creation, even when build flag is set) 122 | * `host/managed/before_provision` triggers when a host completes the OS install 123 | 124 | ## Execution of hooks 125 | 126 | Hooks are executed in the context of the Foreman server, so usually under the 127 | `foreman` user. 128 | 129 | The first argument is always the event name, enabling scripts to be symlinked 130 | into multiple event directories. The second argument is the string 131 | representation of the object that was hooked, e.g. the hostname for a host. 132 | 133 | ~foreman/config/hooks/host/managed/create/50_register_system.sh create foo.example.com 134 | 135 | A JSON representation of the hook object will be passed in on stdin. A utility 136 | to read this with jgrep is provided in `examples/hook_functions.sh` and 137 | sourcing this utility script will be enough for most users. Otherwise, you 138 | may want to ensure stdin is closed to prevent pipe buffer from filling. 139 | 140 | echo '{"host":{"name":"foo.example.com"}}' \ 141 | | ~foreman/config/hooks/host/managed/create/50_register_system.sh \ 142 | create foo.example.com 143 | 144 | Some arguments are available as environment variables: 145 | 146 | Variable | Description 147 | -------- | ----------- 148 | FOREMAN_HOOKS_USER | Username of Foreman user 149 | 150 | Every hook within the event directory is executed in alphabetical order. For 151 | orchestration hooks, an integer prefix in the hook filename will be used as 152 | the priority value, so influences where it's done in relation to DNS, DHCP, VM 153 | creation and other tasks. 154 | 155 | When testing hooks, don't rely on writing logs to /tmp or /var/tmp as you may 156 | not be able to see the contents. On modern systemd-based OSes, Apache (and 157 | Foreman) is run with a private temp directory to improve security - consider 158 | using `~foreman/tmp/` instead, or read `/tmp/systemd-private-*` as root. 159 | 160 | ## Hook failures and rollback 161 | 162 | If a hook fails (non-zero return code), the event is logged. For Rails events, 163 | execution of other hooks will continue. 164 | 165 | For orchestration events, a failure will halt the action and rollback will 166 | occur. If another orchestration action fails, the hook might be called again 167 | to rollback its action - in this case the first argument will change as 168 | appropriate, so must be obeyed by the script (e.g. a "create" hook will be 169 | called with "destroy" if it has to be rolled back later). 170 | 171 | ## Logging 172 | 173 | Entries are logged at application startup and during execution of hooks, but 174 | most will be at 'debug' level and may use the 'sql' logger. Enable this in 175 | Foreman's `/etc/foreman/settings.yaml`: 176 | 177 | ```yaml 178 | :logging: 179 | :level: debug 180 | :loggers: 181 | :sql: 182 | :enabled: true 183 | ``` 184 | 185 | See [Foreman manual: Debugging](https://theforeman.org/manuals/latest/index.html#7.2Debugging) 186 | for full details. 187 | 188 | Enabling debugging and searching the Foreman log file (`/var/log/foreman/production.log`) 189 | for the word "hook" will find all relevant log entries. 190 | 191 | ### Hook discovery and setup 192 | 193 | Expect to see these entries when the server starts: 194 | 195 | * `Found hook to Host::Managed#create, filename 01_example` - for each 196 | executable hook script in the correct location 197 | * `Finished discovering 3 hooks for Host::Managed#create` - for each unique 198 | event with hook scripts 199 | * `Extending Host::Managed with foreman_hooks orchestration hooking support` - 200 | if any orchestration (create/update/destroy) hooks exist for that object 201 | * `Extending Host::Managed with foreman_hooks Rails hooking support` - if any 202 | Rails events hooks exist for that object 203 | * `Created hook method after_create on Host::Managed` - for each type of Rails 204 | event that has hooks 205 | 206 | ### Running hooks 207 | 208 | Expect to see these entries logged when a hooked action occurs: 209 | 210 | * `Observed after_create hook on test.example.com` when a registered Rails 211 | event occurs, hook will then execute immediately 212 | * `Queuing 3 hooks for Host::Managed#create` when an orchestration action is 213 | being set up (hook will be executed later during orchestration) 214 | * `Queuing hook 01_example for Host::Managed#create at priority 01` for each 215 | hook registered when setting up an orchestration action 216 | * `Running hook: /example/config/hooks/host/managed/create/01_example create test.example.com` 217 | as the hook (orchestration or Rails event) is executed 218 | 219 | ## Transactions 220 | 221 | Most hooks are triggered during database transaction. This can cause 222 | conflicting updates when hook scripts emits database updates via Foreman CLI 223 | or API. It is recommended to avoid this behavior and write a Foreman plugin 224 | instead. 225 | 226 | ## SELinux notes 227 | 228 | When using official installation on Red Hat and Fedora system, note that 229 | SELinux is turned on by default and Foreman is running in confined mode. Make 230 | sure that hook scripts has the correct context (`foreman_hook_t` on 231 | RHEL7+/Fedora 19+ or `bin_t` on RHEL6): 232 | 233 | restorecon -RvF /usr/share/foreman/config/hooks 234 | 235 | Also keep in mind that the script is running confined, therefore some actions 236 | might be denied by SELinux. Check audit.log and use audit2allow and other 237 | tools when writing scripts. 238 | 239 | # More resources 240 | 241 | * [foreman\_hooks issue tracker](https://github.com/theforeman/foreman_hooks/issues) 242 | * [Extending Foreman quickly with hook scripts](http://m0dlx.com/blog/Extending_Foreman_quickly_with_hook_scripts.html) 243 | * [AWS VPC Buildout With Foreman Hooks for RDNS Creation](http://www.brian2.net/posts/foreman_hooks_aws_vpc/) 244 | * [Foreman <-> FreeIPA Integration Guide](https://bitbin.de/blog/2013/11/foreman-freeipa-integration-guide/) 245 | * [Autostart Libvirt/KVM VMs in Foreman](http://www.uberobert.com/autostart-libvirt-vms-in-foreman/) 246 | 247 | # Copyright 248 | 249 | Copyright (c) 2012-2017 Dominic Cleal 250 | 251 | This program is free software: you can redistribute it and/or modify 252 | it under the terms of the GNU General Public License as published by 253 | the Free Software Foundation, either version 3 of the License, or 254 | (at your option) any later version. 255 | 256 | This program is distributed in the hope that it will be useful, 257 | but WITHOUT ANY WARRANTY; without even the implied warranty of 258 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 259 | GNU General Public License for more details. 260 | 261 | You should have received a copy of the GNU General Public License 262 | along with this program. If not, see . 263 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------