class Brakeman::ControllerAliasProcessor

Processes aliasing in controllers, but includes following renders in routes and putting variables into templates

Public Class Methods

new(tracker, only_method = nil) click to toggle source

If only_method is specified, only that method will be processed, other methods will be skipped. This is for rescanning just a single action.

Calls superclass method Brakeman::AliasProcessor::new
# File lib/brakeman/processors/controller_alias_processor.rb, line 14
def initialize tracker, only_method = nil
  super tracker
  @app_tree = tracker.app_tree
  @only_method = only_method
  @rendered = false
  @current_class = @current_module = @current_method = nil
  @method_cache = {} #Cache method lookups
end

Public Instance Methods

before_filter_list(method, klass) click to toggle source

Get list of filters, including those that are inherited

# File lib/brakeman/processors/controller_alias_processor.rb, line 235
def before_filter_list method, klass
  controller = @tracker.controllers[klass]

  if controller
    controller.before_filter_list self, method
  else
    []
  end
end
layout_name() click to toggle source

Determines default layout name

# File lib/brakeman/processors/controller_alias_processor.rb, line 211
def layout_name
  controller = @tracker.controllers[@current_class]

  return controller.layout if controller.layout
  return false if controller.layout == false

  app_controller = @tracker.controllers[:ApplicationController]

  return app_controller.layout if app_controller and app_controller.layout

  nil
end
process_before_filter(name) click to toggle source

Processes a call to a before filter. Basically, adds any instance variable assignments to the environment. TODO: method arguments?

# File lib/brakeman/processors/controller_alias_processor.rb, line 145
def process_before_filter name
  filter = tracker.find_method name, @current_class

  if filter.nil?
    Brakeman.debug "[Notice] Could not find filter #{name}"
    return
  end

  method = filter.src

  if ivars = @tracker.filter_cache[[filter.owner, name]]
    ivars.each do |variable, value|
      env[variable] = value
    end
  else
    processor = Brakeman::AliasProcessor.new @tracker
    processor.process_safely(method.body_list, only_ivars(:include_request_vars))

    ivars = processor.only_ivars(:include_request_vars).all

    @tracker.filter_cache[[filter.owner, name]] = ivars

    ivars.each do |variable, value|
      env[variable] = value
    end
  end
end
process_call(exp) click to toggle source

Look for calls to head()

Calls superclass method Brakeman::AliasProcessor#process_call
# File lib/brakeman/processors/controller_alias_processor.rb, line 112
def process_call exp
  exp = super
  return exp unless call? exp

  method = exp.method

  if method == :head
    @rendered = true
  elsif exp.target.nil? and method == :template_exists?
    env[exp.first_arg] = Sexp.new(:lit, :"brakeman:existing_template")
  elsif @tracker.options[:interprocedural] and
    @current_method and (exp.target.nil? or exp.target.node_type == :self)

    exp = get_call_value(exp)
  end

  exp
end
process_class(exp) click to toggle source

Skip it, must be an inner class

# File lib/brakeman/processors/controller_alias_processor.rb, line 73
def process_class exp
  exp
end
process_controller(name, src, current_file) click to toggle source
# File lib/brakeman/processors/controller_alias_processor.rb, line 23
def process_controller name, src, current_file
  if not node_type? src, :class
    Brakeman.debug "#{name} is not a class, it's a #{src.node_type}"
    return
  else
    @current_class = name
    @current_file = @app_tree.file_path(current_file)

    process_default src

    process_mixins
  end
end
process_default_render(exp) click to toggle source

Processes the default template for the current action

# File lib/brakeman/processors/controller_alias_processor.rb, line 174
def process_default_render exp
  process_layout
  process_template template_name, nil, nil, nil
end
process_defn(exp) click to toggle source

Processes a method definition, which may include processing any rendered templates.

# File lib/brakeman/processors/controller_alias_processor.rb, line 79
def process_defn exp
  meth_name = exp.method_name

  Brakeman.debug "Processing #{@current_class}##{meth_name}"

  #Skip if instructed to only process a specific method
  #(but don't skip if this method was called from elsewhere)
  return exp if @current_method.nil? and @only_method and @only_method != meth_name

  is_route = route? meth_name
  other_method = @current_method
  @current_method = meth_name
  @rendered = false if is_route

  meth_env do
    if is_route
      before_filter_list(@current_method, @current_class).each do |f|
        process_before_filter f
      end
    end

    process_all exp.body

    if is_route and not @rendered
      process_default_render exp
    end
  end

  @current_method = other_method
  exp
end
process_iter(exp) click to toggle source

Check for respond_to

Calls superclass method Brakeman::AliasProcessor#process_iter
# File lib/brakeman/processors/controller_alias_processor.rb, line 132
def process_iter exp
  super

  if call? exp.block_call and exp.block_call.method == :respond_to
    @rendered = true
  end

  exp
end
process_mixins() click to toggle source

Process modules mixed into the controller, in case they contain actions.

# File lib/brakeman/processors/controller_alias_processor.rb, line 38
def process_mixins
  controller = @tracker.controllers[@current_class]
  original_file = @current_file

  controller.includes.each do |i|
    mixin = @tracker.libs[i]

    next unless mixin

    #Process methods in alphabetical order for consistency
    methods = mixin.methods_public.keys.map { |n| n.to_s }.sort.map { |n| n.to_sym }

    methods.each do |name|
      #Need to process the method like it was in a controller in order
      #to get the renders set
      processor = Brakeman::ControllerProcessor.new(@tracker, mixin.file)
      method = mixin.get_method(name).src.deep_clone

      if node_type? method, :defn
        method = processor.process_defn method
      else
        #Should be a defn, but this will catch other cases
        method = processor.process method
      end

      @current_file = mixin.file
      #Then process it like any other method in the controller
      process method
    end
  end
ensure
  @current_file = original_file
end
process_template(name, args, _, line) click to toggle source

Process template and add the current class and method name as called_from info

Calls superclass method Brakeman::RenderHelper#process_template
# File lib/brakeman/processors/controller_alias_processor.rb, line 180
def process_template name, args, _, line
  # If line is null, assume implicit render and set the end of the action
  # method as the line number
  if line.nil? and controller = @tracker.controllers[@current_class]
    if meth = controller.get_method(@current_method)
      if line = meth.src && meth.src.last && meth.src.last.line
        line += 1
      else
        line = 1
      end
    end
  end

  render_path = Brakeman::RenderPath.new.add_controller_render(@current_class, @current_method, line, @current_file)
  super name, args, render_path, line
end
route?(method) click to toggle source

Returns true if the given method name is also a route

# File lib/brakeman/processors/controller_alias_processor.rb, line 225
def route? method
  if @tracker.routes[:allow_all_actions] or @tracker.options[:assume_all_routes]
    true
  else
    routes = @tracker.routes[@current_class]
    routes and (routes.include? :allow_all_actions or routes.include? method)
  end
end
template_name(name = nil) click to toggle source

Turns a method name into a template name

# File lib/brakeman/processors/controller_alias_processor.rb, line 198
def template_name name = nil
  name ||= @current_method
  name = name.to_s
  if name.include? "/"
    name
  else
    controller = @current_class.to_s.gsub("Controller", "")
    controller.gsub!("::", "/")
    underscore(controller + "/" + name.to_s)
  end
end