Class: Brakeman::Rescanner
Overview
Class for rescanning changed files after an initial scan
Constant Summary collapse
- SCAN_ORDER =
[:config, :gemfile, :initializer, :lib, :routes, :template, :model, :controller]
Constants inherited from Scanner
Scanner::KNOWN_TEMPLATE_EXTENSIONS, Scanner::RUBY_1_9
Instance Attribute Summary
Attributes inherited from Scanner
Instance Method Summary collapse
-
#file_type(path) ⇒ Object
Guess at what kind of file the path contains.
-
#initialize(options, processor, changed_files) ⇒ Rescanner
constructor
Create new Rescanner to scan changed files.
-
#recheck ⇒ Object
Runs checks.
-
#remove_deleted_file(path) ⇒ Object
Check controllers, templates, models and libs for data from file and delete it.
-
#rescan ⇒ Object
Rescans changed files.
- #rescan_controller(path) ⇒ Object
- #rescan_deleted_controller(path) ⇒ Object
-
#rescan_deleted_file(path, type) ⇒ Object
Handle rescanning when a file is deleted.
- #rescan_deleted_initializer(path) ⇒ Object
- #rescan_deleted_lib(path) ⇒ Object
- #rescan_deleted_template(path) ⇒ Object
-
#rescan_file(path, type = nil) ⇒ Object
Rescans a single file.
- #rescan_lib(path) ⇒ Object
- #rescan_mixin(lib) ⇒ Object
- #rescan_model(path) ⇒ Object
- #rescan_template(path) ⇒ Object
Methods inherited from Scanner
#index_call_sites, #parse_ruby, #process, #process_config, #process_controller, #process_controllers, #process_gems, #process_initializer, #process_initializers, #process_lib, #process_libs, #process_model, #process_models, #process_routes, #process_template, #process_templates, #template_path_to_name, #tracker
Constructor Details
#initialize(options, processor, changed_files) ⇒ Rescanner
Create new Rescanner to scan changed files
12 13 14 15 16 17 18 19 |
# File 'lib/brakeman/rescanner.rb', line 12 def initialize , processor, changed_files super(, processor) @paths = changed_files.map {|f| File. f, tracker.[:app_path] } @old_results = tracker.checks #Old warnings from previous scan @changes = nil #True if files had to be rescanned @reindex = Set.new end |
Instance Method Details
#file_type(path) ⇒ Object
Guess at what kind of file the path contains
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/brakeman/rescanner.rb', line 293 def file_type path case path when /\/app\/controllers/ :controller when /\/app\/views/ :template when /\/app\/models/ :model when /\/lib/ :lib when /\/config\/initializers/ :initializer when /config\/routes\.rb/ :routes when /\/config\/.+\.rb/ :config when /Gemfile/ :gemfile else :unknown end end |
#recheck ⇒ Object
Runs checks. Will rescan files if they have not already been scanned
23 24 25 26 27 28 29 |
# File 'lib/brakeman/rescanner.rb', line 23 def recheck rescan if @changes.nil? tracker.run_checks if @changes Brakeman::RescanReport.new @old_results, tracker end |
#remove_deleted_file(path) ⇒ Object
Check controllers, templates, models and libs for data from file and delete it.
277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/brakeman/rescanner.rb', line 277 def remove_deleted_file path deleted = false [:controllers, :templates, :models, :libs].each do |collection| tracker.send(collection).delete_if do |name, data| if data[:file] == path deleted = true true end end end deleted end |
#rescan ⇒ Object
Rescans changed files
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/brakeman/rescanner.rb', line 32 def rescan tracker.template_cache.clear paths_by_type = {} SCAN_ORDER.each do |type| paths_by_type[type] = [] end @paths.each do |path| type = file_type(path) paths_by_type[type] << path unless type == :unknown end @changes = false SCAN_ORDER.each do |type| paths_by_type[type].each do |path| Brakeman.debug "Rescanning #{path} as #{type}" if rescan_file path, type @changes = true end end end if @changes and not @reindex.empty? tracker.reindex_call_sites @reindex end self end |
#rescan_controller(path) ⇒ Object
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/brakeman/rescanner.rb', line 110 def rescan_controller path #Process source process_controller path #Process data flow and template rendering #from the controller tracker.controllers.each do |name, controller| if controller[:file] == path tracker.templates.each do |template_name, template| next unless template[:caller] unless template[:caller].grep(/^#{name}#/).empty? tracker.reset_template template_name end end @processor.process_controller_alias controller[:name], controller[:src] end end end |
#rescan_deleted_controller(path) ⇒ Object
231 232 233 |
# File 'lib/brakeman/rescanner.rb', line 231 def rescan_deleted_controller path tracker.reset_controller path end |
#rescan_deleted_file(path, type) ⇒ Object
Handle rescanning when a file is deleted
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/brakeman/rescanner.rb', line 208 def rescan_deleted_file path, type case type when :controller rescan_deleted_controller path when :template rescan_deleted_template path when :model rescan_model path when :lib rescan_deleted_lib path when :initializer rescan_deleted_initializer path else if remove_deleted_file path return true else Brakeman.notify "Ignoring deleted file: #{path}" end end true end |
#rescan_deleted_initializer(path) ⇒ Object
271 272 273 |
# File 'lib/brakeman/rescanner.rb', line 271 def rescan_deleted_initializer path tracker.initializers.delete Pathname.new(path).basename.to_s end |
#rescan_deleted_lib(path) ⇒ Object
258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/brakeman/rescanner.rb', line 258 def rescan_deleted_lib path deleted_lib = nil tracker.libs.delete_if do |name, lib| if lib[:file] == path deleted_lib = lib true end end rescan_mixin deleted_lib if deleted_lib end |
#rescan_deleted_template(path) ⇒ Object
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/brakeman/rescanner.rb', line 235 def rescan_deleted_template path return unless path.match KNOWN_TEMPLATE_EXTENSIONS template_name = template_path_to_name(path) #Remove template tracker.reset_template template_name rendered_from_controller = /^#{template_name}\.(.+Controller)#(.+)/ rendered_from_view = /^#{template_name}\.Template:(.+)/ #Remove any rendered versions, or partials rendered from it tracker.templates.delete_if do |name, template| if template[:file] == path true elsif template[:file].nil? name = name.to_s name.match(rendered_from_controller) or name.match(rendered_from_view) end end end |
#rescan_file(path, type = nil) ⇒ Object
Rescans a single file
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/brakeman/rescanner.rb', line 66 def rescan_file path, type = nil type ||= file_type path unless File.exist? path return rescan_deleted_file path, type end case type when :controller rescan_controller path @reindex << :controllers << :templates when :template rescan_template path @reindex << :templates when :model rescan_model path when :lib rescan_lib path when :config process_config when :initializer process_initializer path when :routes # Routes affect which controller methods are treated as actions # which affects which templates are rendered, so routes, controllers, # and templates rendered from controllers must be rescanned tracker.reset_routes tracker.reset_templates :only_rendered => true process_routes process_controllers @reindex << :controllers << :templates when :gemfile if tracker.config[:gems][:rails_xss] and tracker.config[:escape_html] tracker.config[:escape_html] = false end process_gems else return false #Nothing to do, file hopefully does not need to be rescanned end true end |
#rescan_lib(path) ⇒ Object
192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/brakeman/rescanner.rb', line 192 def rescan_lib path process_lib path if File.exists? path lib = nil tracker.libs.each do |name, library| if library[:file] == path lib = library break end end rescan_mixin lib if lib end |
#rescan_mixin(lib) ⇒ Object
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/brakeman/rescanner.rb', line 316 def rescan_mixin lib method_names = [] [:public, :private, :protected].each do |access| lib[access].each do |name, meth| method_names << name end end method_matcher = /##{method_names.map {|n| Regexp.escape(n.to_s)}.join('|')}$/ #Rescan controllers that mixed in library tracker.controllers.each do |name, controller| if controller[:includes].include? lib[:name] unless @paths.include? controller[:file] rescan_file controller[:file] end end end to_rescan = [] #Check if a method from this mixin was used to render a template. #This is not precise, because a different controller might have the #same method... tracker.templates.each do |name, template| next unless template[:caller] unless template[:caller].grep(method_matcher).empty? name.to_s.match /^([^.]+)/ original = tracker.templates[$1.to_sym] if original to_rescan << [name, original[:file]] end end end to_rescan.each do |template| tracker.reset_template template[0] rescan_file template[1] end end |
#rescan_model(path) ⇒ Object
177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/brakeman/rescanner.rb', line 177 def rescan_model path num_models = tracker.models.length tracker.reset_model path process_model path if File.exists? path #Only need to rescan other things if a model is added or removed if num_models != tracker.models.length process_templates process_controllers @reindex << :templates << :controllers end @reindex << :models end |
#rescan_template(path) ⇒ Object
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/brakeman/rescanner.rb', line 130 def rescan_template path return unless path.match KNOWN_TEMPLATE_EXTENSIONS and File.exist? path template_name = template_path_to_name(path) tracker.reset_template template_name process_template path @processor.process_template_alias tracker.templates[template_name] rescan = Set.new template_matcher = /^Template:(.+)/ controller_matcher = /^(.+Controller)#(.+)/ template_name_matcher = /^#{template_name}\./ #Search for processed template and process it. #Search for rendered versions of template and re-render (if necessary) tracker.templates.each do |name, template| if template[:file] == path or template[:file].nil? next unless template[:caller] and name.to_s.match(template_name_matcher) template[:caller].each do |from| if from.match(template_matcher) rescan << [:template, $1.to_sym] elsif from.match(controller_matcher) rescan << [:controller, $1.to_sym, $2.to_sym] end end end end rescan.each do |r| if r[0] == :controller controller = tracker.controllers[r[1]] unless @paths.include? controller[:file] @processor.process_controller_alias controller[:name], controller[:src], r[2] end elsif r[0] == :template template = tracker.templates[r[1]] rescan_template template[:file] end end end |