database_sleuth 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Joel Watson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,38 @@
+= database_sleuth
+
+This library is designed to parse popular web application configuration files
+to extract database connection information for use in other applications or
+scripts.
+
+To get started, simply require the library:
+
+  require 'database_sleuth'
+
+Then, simply create a new instance of the class specifying which application
+you're collecting information from (note that the library expects the config
+file to be located in the directory the executing file is running from):
+
+  sleuth = DatabaseSleuth.new(:joomla)
+  sleuth.find_db_info
+  sleuth.dbhost #=> mysql.example.com
+  sleuth.dbname #=> somedbname
+  sleuth.dbuser #=> someusername
+  sleuth.dbpass #=> somepassword
+  
+  sleuth.manual_connection_string #=> mysql -u someusername -psomepassword -h mysql.example.com somedbname
+
+= Supported Applications
+
+Currently, the following applications are supported:
+
+* Drupal
+* Gallery
+* Joomla
+* MediaWiki
+* phpBB
+* WordPress
+* ZenCart
+
+== Copyright
+
+Copyright (c) 2010 Joel Watson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "database_sleuth"
+    gem.summary = %Q{Easily find database connection info from common web applications.}
+    gem.description = %Q{Easily find database connection info from common web applications.}
+    gem.email = "watsonian@gmail.com"
+    gem.homepage = "http://github.com/watsonian/database_sleuth"
+    gem.authors = ["watsonian"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "database_sleuth #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/database_sleuth.rb

@@ -0,0 +1,118 @@
+class DatabaseSleuth
+  attr_accessor :application, :locations, :exists_at, :located_at, :regex, :dbname, :dbuser, :dbpass, :dbhost, :dbtableprefix
+  
+  @@supported_applications = [:joomla, :wordpress, :drupal, :phpbb, :gallery, :zencart, :mediawiki]
+  
+  @@app_metadata = {}
+  @@app_metadata[:drupal] = {
+    :locations => ["sites/default/settings.php"],
+    :regex => {
+      :dbname => Regexp.new("^\\$db_url.*?\\/\\/.*?\\/(.*?)'"),
+      :dbuser => Regexp.new("^\\$db_url.*?\\/\\/(.*)?:.*?'"),
+      :dbpass => Regexp.new("^\\$db_url.*?\\/\\/.*?:(.*)?@.*?'"),
+      :dbhost => Regexp.new("^\\$db_url.*?\\/\\/.*?@(.*)?\\/.*?'"),
+    },
+  }
+  @@app_metadata[:gallery] = {
+    :locations => ["config.php"],
+    :regex => {
+      :dbname => Regexp.new("\\$storeConfig\\['database'.*?'(.*?)'"),
+      :dbuser => Regexp.new("\\$storeConfig\\['username'.*?'(.*?)'"),
+      :dbpass => Regexp.new("\\$storeConfig\\['password'.*?'(.*?)'"),
+      :dbhost => Regexp.new("\\$storeConfig\\['hostname'.*?'(.*?)'"),
+    },
+  }
+  @@app_metadata[:joomla] = {
+    :locations => ["configuration.php"],
+    :regex => {
+      :dbname => Regexp.new("\\$db\\s*=\\s*'(.*?)'"),
+      :dbuser => Regexp.new("\\$user\\s*=\\s*'(.*?)'"),
+      :dbpass => Regexp.new("\\$password\\s*=\\s*'(.*?)'"),
+      :dbhost => Regexp.new("\\$host\\s*=\\s*'(.*?)'"),
+    },
+  }
+  @@app_metadata[:mediawiki] = {
+    :locations => ["LocalSettings.php"],
+    :regex => {
+      :dbname => Regexp.new("\\$wgDBname\\s*=\\s*['\"](.*?)['\"]"),
+      :dbuser => Regexp.new("\\$wgDBuser\\s*=\\s*['\"](.*?)['\"]"),
+      :dbpass => Regexp.new("\\$wgDBpassword\\s*=\\s*['\"](.*?)['\"]"),
+      :dbhost => Regexp.new("\\$wgDBserver\\s*=\\s*['\"](.*?)['\"]"),
+    },
+  }
+  @@app_metadata[:phpbb] = {
+    :locations => ["config.php"],
+    :regex => {
+      :dbname => Regexp.new("dbname\\s*=\\s*'(.*?)'"),
+      :dbuser => Regexp.new("dbuser\\s*=\\s*'(.*?)'"),
+      :dbpass => Regexp.new("dbpasswd\\s*=\\s*'(.*?)'"),
+      :dbhost => Regexp.new("dbhost\\s*=\\s*'(.*?)'"),
+    },
+  }
+  @@app_metadata[:wordpress] = {
+    :locations => ["wp-config.php"],
+    :regex => {
+      :dbname => Regexp.new("DB_NAME'.*?'(.*?)'"),
+      :dbuser => Regexp.new("DB_USER'.*?'(.*?)'"),
+      :dbpass => Regexp.new("DB_PASSWORD'.*?'(.*?)'"),
+      :dbhost => Regexp.new("DB_HOST'.*?'(.*?)'"),
+      :dbtableprefix => Regexp.new("\\$table_prefix\\s*=\\s*'(.*?)'"),
+    },
+  }
+  @@app_metadata[:zencart] = {
+    :locations => ["includes/configure.php"],
+    :regex => {
+      :dbname => Regexp.new("DB_DATABASE'.*?'(.*?)'"),
+      :dbuser => Regexp.new("DB_SERVER_USERNAME'.*?'(.*?)'"),
+      :dbpass => Regexp.new("DB_SERVER_PASSWORD'.*?'(.*?)'"),
+      :dbhost => Regexp.new("DB_SERVER'.*?'(.*?)'"),
+    },
+  }
+  
+  def initialize(app)
+    @exists_at = []
+    @dbname = nil
+    @dbuser = nil
+    @dbpass = nil
+    @dbhost = nil
+    self.application = app
+    self.locations = @@app_metadata[@application][:locations]
+    @regex = @@app_metadata[@application][:regex]
+  end
+  
+  def application=(app)
+    a = String(app).downcase.to_sym
+    if @@supported_applications.include?(a)
+      instance_variable_set(:@application, a)
+    else
+      raise "That application is not supported yet."
+    end
+  end
+  
+  def find_db_info
+    locate_files
+    @exists_at.each do |file|
+      File.foreach(file) do |line|
+        @dbname ||= @regex[:dbname].match(line)[1] if @regex[:dbname] === line
+        @dbuser ||= @regex[:dbuser].match(line)[1] if @regex[:dbuser] === line
+        @dbpass ||= @regex[:dbpass].match(line)[1] if @regex[:dbpass] === line
+        @dbhost ||= @regex[:dbhost].match(line)[1] if @regex[:dbhost] === line
+        @dbtableprefix ||= @regex[:dbtableprefix].match(line)[1] if @regex[:dbtableprefix] === line && @regex.has_key?(:dbtableprefix)
+        @located_at = file if @dbname
+      end
+    end
+  end
+  
+  def manual_connection_string
+    "mysql -u #{@dbuser} -p#{@dbpass} -h #{@dbhost} #{@dbname}"
+  end
+  
+  private
+    def locate_files
+      @locations.each do |loc|
+        if File.exists?(loc)
+          @exists_at << loc
+        end
+      end
+    end
+end

data/spec/database_sleuth_spec.rb

@@ -0,0 +1,210 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "DatabaseSleuth" do  
+  context "when searching Drupal" do
+    before(:all) do
+      Dir.chdir(File.join(File.dirname(__FILE__), "drupal")) do
+        @sleuth = DatabaseSleuth.new(:drupal)
+        @sleuth.find_db_info
+      end
+    end
+    
+    it "should find the database name" do
+      @sleuth.dbname.should == "putyourdbnamehere"
+    end
+    
+    it "should find the username" do
+      @sleuth.dbuser.should == "usernamehere"
+    end
+    
+    it "should find the user password" do
+      @sleuth.dbpass.should == "yourpasswordhere"
+    end
+    
+    it "should find the hostname" do
+      @sleuth.dbhost.should == "localhost"
+    end
+    
+    it "should produce a manual connection string" do
+      @sleuth.manual_connection_string.should == "mysql -u usernamehere -pyourpasswordhere -h localhost putyourdbnamehere"
+    end
+  end
+  
+  context "when searching Gallery" do
+    before(:all) do
+      Dir.chdir(File.join(File.dirname(__FILE__), "gallery")) do
+        @sleuth = DatabaseSleuth.new(:gallery)
+        @sleuth.find_db_info
+      end
+    end
+    
+    it "should find the database name" do
+      @sleuth.dbname.should == "putyourdbnamehere"
+    end
+    
+    it "should find the username" do
+      @sleuth.dbuser.should == "usernamehere"
+    end
+    
+    it "should find the user password" do
+      @sleuth.dbpass.should == "yourpasswordhere"
+    end
+    
+    it "should find the hostname" do
+      @sleuth.dbhost.should == "localhost"
+    end
+    
+    it "should produce a manual connection string" do
+      @sleuth.manual_connection_string.should == "mysql -u usernamehere -pyourpasswordhere -h localhost putyourdbnamehere"
+    end
+  end
+  
+  context "when searching Joomla" do
+    before(:all) do
+      Dir.chdir(File.join(File.dirname(__FILE__), "joomla")) do
+        @sleuth = DatabaseSleuth.new(:joomla)
+        @sleuth.find_db_info
+      end
+    end
+    
+    it "should find the database name" do
+      @sleuth.dbname.should == "putyourdbnamehere"
+    end
+    
+    it "should find the username" do
+      @sleuth.dbuser.should == "usernamehere"
+    end
+    
+    it "should find the user password" do
+      @sleuth.dbpass.should == "yourpasswordhere"
+    end
+    
+    it "should find the hostname" do
+      @sleuth.dbhost.should == "localhost"
+    end
+    
+    it "should produce a manual connection string" do
+      @sleuth.manual_connection_string.should == "mysql -u usernamehere -pyourpasswordhere -h localhost putyourdbnamehere"
+    end
+  end
+  
+  context "when searching MediaWiki" do
+    before(:all) do
+      Dir.chdir(File.join(File.dirname(__FILE__), "mediawiki")) do
+        @sleuth = DatabaseSleuth.new(:mediawiki)
+        @sleuth.find_db_info
+      end
+    end
+    
+    it "should find the database name" do
+      @sleuth.dbname.should == "putyourdbnamehere"
+    end
+    
+    it "should find the username" do
+      @sleuth.dbuser.should == "usernamehere"
+    end
+    
+    it "should find the user password" do
+      @sleuth.dbpass.should == "yourpasswordhere"
+    end
+    
+    it "should find the hostname" do
+      @sleuth.dbhost.should == "localhost"
+    end
+    
+    it "should produce a manual connection string" do
+      @sleuth.manual_connection_string.should == "mysql -u usernamehere -pyourpasswordhere -h localhost putyourdbnamehere"
+    end
+  end
+  
+  context "when searching phpBB" do
+    before(:all) do
+      Dir.chdir(File.join(File.dirname(__FILE__), "phpbb")) do
+        @sleuth = DatabaseSleuth.new(:phpbb)
+        @sleuth.find_db_info
+      end
+    end
+    
+    it "should find the database name" do
+      @sleuth.dbname.should == "putyourdbnamehere"
+    end
+    
+    it "should find the username" do
+      @sleuth.dbuser.should == "usernamehere"
+    end
+    
+    it "should find the user password" do
+      @sleuth.dbpass.should == "yourpasswordhere"
+    end
+    
+    it "should find the hostname" do
+      @sleuth.dbhost.should == "localhost"
+    end
+    
+    it "should produce a manual connection string" do
+      @sleuth.manual_connection_string.should == "mysql -u usernamehere -pyourpasswordhere -h localhost putyourdbnamehere"
+    end
+  end
+  
+  context "when searching WordPress" do
+    before(:all) do
+      Dir.chdir(File.join(File.dirname(__FILE__), "wordpress")) do
+        @sleuth = DatabaseSleuth.new(:wordpress)
+        @sleuth.find_db_info
+      end
+    end
+    
+    it "should find the database name" do
+      @sleuth.dbname.should == "putyourdbnamehere"
+    end
+    
+    it "should find the username" do
+      @sleuth.dbuser.should == "usernamehere"
+    end
+    
+    it "should find the user password" do
+      @sleuth.dbpass.should == "yourpasswordhere"
+    end
+    
+    it "should find the hostname" do
+      @sleuth.dbhost.should == "localhost"
+    end
+    
+    it "should find the database table prefix" do
+      @sleuth.dbtableprefix.should == "wp_"
+    end
+    
+    it "should produce a manual connection string" do
+      @sleuth.manual_connection_string.should == "mysql -u usernamehere -pyourpasswordhere -h localhost putyourdbnamehere"
+    end
+  end
+  
+  context "when searching ZenCart" do
+    before(:all) do
+      Dir.chdir(File.join(File.dirname(__FILE__), "zencart")) do
+        @sleuth = DatabaseSleuth.new(:zencart)
+        @sleuth.find_db_info
+      end
+    end
+    
+    it "should find the database name" do
+      @sleuth.dbname.should == "putyourdbnamehere"
+    end
+    
+    it "should find the username" do
+      @sleuth.dbuser.should == "usernamehere"
+    end
+    
+    it "should find the user password" do
+      @sleuth.dbpass.should == "yourpasswordhere"
+    end
+    
+    it "should find the hostname" do
+      @sleuth.dbhost.should == "localhost"
+    end
+    
+    it "should produce a manual connection string" do
+      @sleuth.manual_connection_string.should == "mysql -u usernamehere -pyourpasswordhere -h localhost putyourdbnamehere"
+    end
+  end
+end