Class: Brakeman::Tracker
- Inherits:
-
Object
- Object
- Brakeman::Tracker
- Defined in:
- lib/brakeman/tracker.rb
Overview
The Tracker keeps track of all the processed information.
Constant Summary collapse
- UNKNOWN_MODEL =
Place holder when there should be a model, but it is not clear what model it will be.
:BrakemanUnresolvedModel
Instance Attribute Summary collapse
-
#app_tree ⇒ Object
Returns the value of attribute app_tree.
-
#checks ⇒ Object
Returns the value of attribute checks.
-
#config ⇒ Object
Returns the value of attribute config.
-
#constants ⇒ Object
Returns the value of attribute constants.
-
#controllers ⇒ Object
Returns the value of attribute controllers.
-
#duration ⇒ Object
Returns the value of attribute duration.
-
#end_time ⇒ Object
Returns the value of attribute end_time.
-
#errors ⇒ Object
Returns the value of attribute errors.
-
#filter_cache ⇒ Object
Returns the value of attribute filter_cache.
-
#ignored_filter ⇒ Object
Returns the value of attribute ignored_filter.
-
#initializers ⇒ Object
Returns the value of attribute initializers.
-
#libs ⇒ Object
Returns the value of attribute libs.
-
#models ⇒ Object
Returns the value of attribute models.
-
#options ⇒ Object
Returns the value of attribute options.
-
#processor ⇒ Object
Returns the value of attribute processor.
-
#routes ⇒ Object
Returns the value of attribute routes.
-
#start_time ⇒ Object
Returns the value of attribute start_time.
-
#template_cache ⇒ Object
Returns the value of attribute template_cache.
-
#templates ⇒ Object
Returns the value of attribute templates.
Instance Method Summary collapse
- #add_constant(name, value, context = nil) ⇒ Object
- #add_errors(exceptions) ⇒ Object
- #app_path ⇒ Object
-
#check_initializers(target, method) ⇒ Object
Searches the initializers for a method call.
-
#constant_lookup(name) ⇒ Object
This method does not return all constants at this time, just ones with “simple” values.
- #each_class ⇒ Object
-
#each_method ⇒ Object
Iterate over all methods in controllers and models.
-
#each_template ⇒ Object
Iterates over each template, yielding the name and the template.
-
#error(exception, backtrace = nil) ⇒ Object
Add an error to the list.
- #filtered_warnings ⇒ Object
-
#find_call(options) ⇒ Object
Find a method call.
- #find_class(name) ⇒ Object
- #index_call_sites ⇒ Object
-
#initialize(app_tree, processor = nil, options = {}) ⇒ Tracker
constructor
Creates a new Tracker.
-
#reindex_call_sites(locations) ⇒ Object
Reindex call sites.
-
#report ⇒ Object
Returns a Report with this Tracker’s information.
- #reset_controller(path) ⇒ Object
- #reset_initializer(path) ⇒ Object
-
#reset_lib(path) ⇒ Object
Clear information related to model.
-
#reset_model(path) ⇒ Object
Clear information related to model.
-
#reset_routes ⇒ Object
Clear information about routes.
-
#reset_template(name) ⇒ Object
Clear information related to template.
-
#reset_templates(options = { :only_rendered => false }) ⇒ Object
Clear information related to templates.
-
#run_checks ⇒ Object
Run a set of checks on the current information.
- #unused_fingerprints ⇒ Object
- #warnings ⇒ Object
Constructor Details
#initialize(app_tree, processor = nil, options = {}) ⇒ Tracker
Creates a new Tracker.
The Processor argument is only used by other Processors that might need to access it.
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/brakeman/tracker.rb', line 25 def initialize(app_tree, processor = nil, = {}) @app_tree = app_tree @processor = processor @options = @config = Brakeman::Config.new(self) @templates = {} @controllers = {} #Initialize models with the unknown model so #we can match models later without knowing precisely what #class they are. @models = {} @models[UNKNOWN_MODEL] = Brakeman::Model.new(UNKNOWN_MODEL, nil, @app_tree.file_path("NOT_REAL.rb"), nil, self) @routes = {} @initializers = {} @errors = [] @libs = {} @constants = Brakeman::Constants.new @checks = nil @processed = nil @template_cache = Set.new @filter_cache = {} @call_index = nil @start_time = Time.now @end_time = nil @duration = nil end |
Instance Attribute Details
#app_tree ⇒ Object
Returns the value of attribute app_tree.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def app_tree @app_tree end |
#checks ⇒ Object
Returns the value of attribute checks.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def checks @checks end |
#config ⇒ Object
Returns the value of attribute config.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def config @config end |
#constants ⇒ Object
Returns the value of attribute constants.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def constants @constants end |
#controllers ⇒ Object
Returns the value of attribute controllers.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def controllers @controllers end |
#duration ⇒ Object
Returns the value of attribute duration.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def duration @duration end |
#end_time ⇒ Object
Returns the value of attribute end_time.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def end_time @end_time end |
#errors ⇒ Object
Returns the value of attribute errors.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def errors @errors end |
#filter_cache ⇒ Object
Returns the value of attribute filter_cache.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def filter_cache @filter_cache end |
#ignored_filter ⇒ Object
Returns the value of attribute ignored_filter.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def ignored_filter @ignored_filter end |
#initializers ⇒ Object
Returns the value of attribute initializers.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def initializers @initializers end |
#libs ⇒ Object
Returns the value of attribute libs.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def libs @libs end |
#models ⇒ Object
Returns the value of attribute models.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def models @models end |
#options ⇒ Object
Returns the value of attribute options.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def @options end |
#processor ⇒ Object
Returns the value of attribute processor.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def processor @processor end |
#routes ⇒ Object
Returns the value of attribute routes.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def routes @routes end |
#start_time ⇒ Object
Returns the value of attribute start_time.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def start_time @start_time end |
#template_cache ⇒ Object
Returns the value of attribute template_cache.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def template_cache @template_cache end |
#templates ⇒ Object
Returns the value of attribute templates.
12 13 14 |
# File 'lib/brakeman/tracker.rb', line 12 def templates @templates end |
Instance Method Details
#add_constant(name, value, context = nil) ⇒ Object
203 204 205 |
# File 'lib/brakeman/tracker.rb', line 203 def add_constant name, value, context = nil @constants.add name, value, context unless @options[:disable_constant_tracking] end |
#add_errors(exceptions) ⇒ Object
71 72 73 74 75 |
# File 'lib/brakeman/tracker.rb', line 71 def add_errors exceptions exceptions.each do |e| error(e) end end |
#app_path ⇒ Object
87 88 89 |
# File 'lib/brakeman/tracker.rb', line 87 def app_path @app_path ||= File. @options[:app_path] end |
#check_initializers(target, method) ⇒ Object
Searches the initializers for a method call
169 170 171 172 173 174 175 176 177 |
# File 'lib/brakeman/tracker.rb', line 169 def check_initializers target, method finder = Brakeman::FindCall.new target, method, self initializers.sort.each do |name, initializer| finder.process_source initializer end finder.matches end |
#constant_lookup(name) ⇒ Object
This method does not return all constants at this time, just ones with “simple” values.
209 210 211 |
# File 'lib/brakeman/tracker.rb', line 209 def constant_lookup name @constants.get_simple_value name unless @options[:disable_constant_tracking] end |
#each_class ⇒ Object
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/brakeman/tracker.rb', line 126 def each_class classes = [self.controllers, self.models] if @options[:index_libs] classes << self.libs end classes.each do |set| set.each do |set_name, collection| collection.src.each do |file, src| yield src, set_name, file end end end end |
#each_method ⇒ Object
Iterate over all methods in controllers and models.
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/brakeman/tracker.rb', line 92 def each_method classes = [self.controllers, self.models] if @options[:index_libs] classes << self.libs end classes.each do |set| set.each do |set_name, collection| collection.each_method do |method_name, definition| src = definition[:src] yield src, set_name, method_name, definition[:file] end end end end |
#each_template ⇒ Object
Iterates over each template, yielding the name and the template. Prioritizes templates which have been rendered.
111 112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/brakeman/tracker.rb', line 111 def each_template if @processed.nil? @processed, @rest = templates.keys.sort_by{|template| template.to_s}.partition { |k| k.to_s.include? "." } end @processed.each do |k| yield k, templates[k] end @rest.each do |k| yield k, templates[k] end end |
#error(exception, backtrace = nil) ⇒ Object
Add an error to the list. If no backtrace is given, the one from the exception will be used.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/brakeman/tracker.rb', line 55 def error exception, backtrace = nil backtrace ||= exception.backtrace unless backtrace.is_a? Array backtrace = [ backtrace ] end Brakeman.debug exception Brakeman.debug backtrace @errors << { :exception => exception, :error => exception.to_s.gsub("\n", " "), :backtrace => backtrace } end |
#filtered_warnings ⇒ Object
188 189 190 191 192 193 194 195 196 |
# File 'lib/brakeman/tracker.rb', line 188 def filtered_warnings if self.ignored_filter self.warnings.reject do |w| self.ignored_filter.ignored? w end else self.warnings end end |
#find_call(options) ⇒ Object
Find a method call.
Options:
* :target => target name(s)
* :method => method name(s)
* :chained => search in method chains
If :target => false or :target => nil, searches for methods without a target. Targets and methods can be specified as a symbol, an array of symbols, or a regular expression.
If :chained => true, matches target at head of method chain and method at end.
For example:
find_call :target => User, :method => :all, :chained => true
could match
User.human.active.all(...)
163 164 165 166 |
# File 'lib/brakeman/tracker.rb', line 163 def find_call index_call_sites unless @call_index @call_index.find_calls end |
#find_class(name) ⇒ Object
213 214 215 216 217 218 219 220 221 |
# File 'lib/brakeman/tracker.rb', line 213 def find_class name [@controllers, @models, @libs].each do |collection| if c = collection[name] return c end end nil end |
#index_call_sites ⇒ Object
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/brakeman/tracker.rb', line 223 def index_call_sites finder = Brakeman::FindAllCalls.new self self.each_method do |definition, set_name, method_name, file| finder.process_source definition, :class => set_name, :method => method_name, :file => file end self.each_class do |definition, set_name, file| finder.process_source definition, :class => set_name, :file => file end self.each_template do |_name, template| finder.process_source template.src, :template => template, :file => template.file end self.initializers.each do |file_name, src| finder.process_all_source src, :file => file_name end @call_index = Brakeman::CallIndex.new finder.calls end |
#reindex_call_sites(locations) ⇒ Object
Reindex call sites
Takes a set of symbols which can include :templates, :models, or :controllers
This will limit reindexing to the given sets
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/brakeman/tracker.rb', line 251 def reindex_call_sites locations #If reindexing templates, models, controllers, #just redo everything. if locations.length == 3 return index_call_sites end if locations.include? :templates @call_index.remove_template_indexes end classes_to_reindex = Set.new method_sets = [] if locations.include? :models classes_to_reindex.merge self.models.keys method_sets << self.models end if locations.include? :controllers classes_to_reindex.merge self.controllers.keys method_sets << self.controllers end if locations.include? :initializers self.initializers.each do |file_name, src| @call_index.remove_indexes_by_file file_name end end @call_index.remove_indexes_by_class classes_to_reindex finder = Brakeman::FindAllCalls.new self method_sets.each do |set| set.each do |set_name, info| info.each_method do |method_name, definition| src = definition[:src] finder.process_source src, :class => set_name, :method => method_name, :file => definition[:file] end end end if locations.include? :templates self.each_template do |_name, template| finder.process_source template.src, :template => template, :file => template.file end end if locations.include? :initializers self.initializers.each do |file_name, src| finder.process_all_source src, :file => file_name end end @call_index.index_calls finder.calls end |
#report ⇒ Object
Returns a Report with this Tracker’s information
180 181 182 |
# File 'lib/brakeman/tracker.rb', line 180 def report Brakeman::Report.new(self) end |
#reset_controller(path) ⇒ Object
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 |
# File 'lib/brakeman/tracker.rb', line 362 def reset_controller path controller_name = nil #Remove from controller @controllers.each do |name, controller| if controller.files.include?(path) controller_name = name #Remove templates rendered from this controller @templates.each do |template_name, template| if template.render_path and template.render_path.include_controller? name reset_template template_name @call_index.remove_template_indexes template_name end end #Remove calls indexed from this controller @call_index.remove_indexes_by_class [name] break end end @controllers.delete controller_name end |
#reset_initializer(path) ⇒ Object
391 392 393 394 395 396 397 |
# File 'lib/brakeman/tracker.rb', line 391 def reset_initializer path @initializers.delete_if do |file, src| path.relative.include? file end @call_index.remove_indexes_by_file path end |
#reset_lib(path) ⇒ Object
Clear information related to model
349 350 351 352 353 354 355 356 357 358 359 360 |
# File 'lib/brakeman/tracker.rb', line 349 def reset_lib path lib_name = nil @libs.each do |name, lib| if lib.files.include?(path) lib_name = name break end end @libs.delete lib_name end |
#reset_model(path) ⇒ Object
Clear information related to model
335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/brakeman/tracker.rb', line 335 def reset_model path model_name = nil @models.each do |name, model| if model.files.include?(path) model_name = name break end end @models.delete model_name end |
#reset_routes ⇒ Object
Clear information about routes
387 388 389 |
# File 'lib/brakeman/tracker.rb', line 387 def reset_routes @routes = {} end |
#reset_template(name) ⇒ Object
Clear information related to template
326 327 328 329 330 331 332 |
# File 'lib/brakeman/tracker.rb', line 326 def reset_template name name = name.to_sym @templates.delete name @processed = nil @rest = nil @template_cache.clear end |
#reset_templates(options = { :only_rendered => false }) ⇒ Object
Clear information related to templates. If :only_rendered => true, will delete templates rendered from controllers (but not those rendered from other templates)
312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/brakeman/tracker.rb', line 312 def reset_templates = { :only_rendered => false } if [:only_rendered] @templates.delete_if do |_name, template| template.rendered_from_controller? end else @templates = {} end @processed = nil @rest = nil @template_cache.clear end |
#run_checks ⇒ Object
Run a set of checks on the current information. Results will be stored in Tracker#checks.
79 80 81 82 83 84 85 |
# File 'lib/brakeman/tracker.rb', line 79 def run_checks @checks = Brakeman::Checks.run_checks(self) @end_time = Time.now @duration = @end_time - @start_time @checks end |
#unused_fingerprints ⇒ Object
198 199 200 201 |
# File 'lib/brakeman/tracker.rb', line 198 def unused_fingerprints return [] unless self.ignored_filter self.ignored_filter.obsolete_fingerprints end |
#warnings ⇒ Object
184 185 186 |
# File 'lib/brakeman/tracker.rb', line 184 def warnings self.checks.all_warnings end |