gs_phone 0.0.1

data/lib/gs_phone.rb

@@ -0,0 +1,274 @@
+#!/usr/bin/ruby -w
+# This is used to manage the Grandstream phones.
+# It is a wrapper over Charles Howes (gsutil@ch.pkts.ca)'s gsutil
+# utility (http://www.pkts.ca/gsutil.shtml)
+#
+# Copyright (C) 2007  Eric Davis <edavis10@gmail.com>
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+
+require 'yaml'
+require 'optparse'
+
+class GrandStream
+
+  # Default configurations
+  @user_file = "users.yml"
+  @admin_password = "admin"
+  @gsutil = "gsutil"
+  @config_files = "config"
+
+
+  # Setup the help messages with the optparse library
+  def initialize(args)
+    read_configuration
+    @ip = args[1]
+    @current_ip = args[2]
+    @admin = args[3]
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #$0 COMMANDS [options]\n\n" +
+        "       'IP' is the ip address you want the phone to use\n" +
+        "       'crtIP' is the ip address the phone currently has\n" +
+        "       'pass' is the current phone password\n\n"
+
+      opts.on("--new 'IP' ['crtIP'|'pass']", "Add new user and setup their phone ") do
+        self.add_user(@ip)
+        self.make(@ip)
+        self.update_config(@ip, @current_ip, @admin)
+        self.reboot_phone(@current_ip)
+      end
+      opts.on('-A', "--add-user", 'Adds a user to the phone database') { self.add_user(@ip) }
+      opts.on('-M', "--make 'IP", 'Generates a config file from the template') { self.make(@ip) }
+      opts.on('--make-all', 'Reboots all phones') { self.make_all }
+      opts.on('-U', "--update 'IP' ['crtIP'|'pass']", "Update the configuration file to the phone") { self.update_config(@ip, @current_ip, @admin) }
+      opts.on('--update-all', 'Updates the configs on all phones') { self.update_all }
+      opts.on('-R', "--reboot 'IP'", 'Reboots a phone') { self.reboot_phone(@ip) }
+      opts.on('--reboot-all', 'Reboots all phones') { self.reboot_all_phones }
+      opts.on('-F', '--find-ip', "Find the ip address in the configuration file") { self.find_ip }
+
+    end
+    opts.parse!(args)
+  end
+
+  # Read the gs_phone configuration file to get the settings
+  def read_configuration
+
+    if File.exists?("#{ENV["HOME"]}/.gs_phone")
+      settings = Hash.new
+      settings = YAML::load(File.open("#{ENV["HOME"]}/.gs_phone"))
+      
+      @user_file = settings["user_file"] if settings.include?("user_file")
+      @admin_password = settings["admin_password"]
+      @gsutil = settings["gsutil"]
+      @config_files = settings["config_files"]
+    else
+      puts "You have no default configuration file.  We will create one for you"
+      settings = {
+        "admin_password" => "admin",
+        "user_file" => "users.yml",
+        "gsutil" => "gsutil",
+        "config_files" => "config"
+      }
+
+      file = File.new("#{ENV["HOME"]}/.gs_phone","w")
+      file.puts settings.to_yaml
+      file.close
+
+      puts "File #{ENV["HOME"]}/.gs_phone has been created.  Please make sure the"
+      puts " settings are correct."
+      exit
+
+    end
+  end
+
+  # Add a user to the configuration file
+  def add_user(ip_addr=nil)
+    # Lets get some details for the new user
+    puts "GS> Username?"
+    username = STDIN.gets.chomp
+    puts "GS> Extension Number?"
+    password = STDIN.gets.chomp
+    # Skip the ip address if they already passed it in.
+    if ip_addr.nil?
+      puts "GS> Phone IP Address (i.e. 192.168.1.1)"
+      ip_addr = STDIN.gets.chomp
+    end
+    puts "GS> MAC Address?"
+    mac_addy = STDIN.gets.chomp
+    
+    # Open the user file and enter the data
+    users = File.open(@user_file, 'a')
+    users.puts "---"
+    users.puts "name: " + username
+    users.puts "ext: " + password
+    users.puts "ip: " + ip_addr
+    users.puts "mac: " + mac_addy
+    users.close
+
+    # Set this so we can use it in other parts of the script if "--new" was called
+    @ip = ip_addr    
+  end
+
+  # Generate a config file from the template
+  def make(ip_address=@ip)
+    # Skip the ip address if they already passed it in.
+    if ip_address.nil?
+      puts "GS> What ip address?  "
+      ip_address = STDIN.gets.chomp
+    end
+
+    @user_list = Hash.new
+    @phone = Array.new
+
+    # Open the user file and find the user who has the ip address that matches
+    # the one we are looking for
+    users = File.open(@user_file)
+    data = YAML::load_documents(users) do |element|
+      if element['ip'] == ip_address and not element['skip'] == 'y'
+        name = element['name']
+        password = element['ext'].to_s
+        exten = element['ext'].to_s
+        ip = element['ip']
+        
+        # Split the ip address into each octal, the Grandstream config files
+        # needs it this way
+        ip1, ip2, ip3, ip4 = ip.split('.')
+        
+        templated = IO.readlines(@config_files + "template.cfg")
+        phone_config = ""
+
+        # Substitue in the user fields into their config 
+        # a.k.a. Magic REGEX section
+        templated.each do |line|
+          phone_config << line.gsub(/<<ext>>/, exten).gsub(/<<name>>/, name).gsub(/<<password>>/, password).gsub(/<<ip1>>/, ip1).gsub(/<<ip2>>/, ip2).gsub(/<<ip3>>/, ip3).gsub(/<<ip4>>/, ip4)
+        end
+        # Write out the string to a file now
+        File.open("#{@config_files}#{ip}.cfg", "w+") do |file|
+          file.puts phone_config
+        end
+        puts "GS< Made config for extension #{exten.to_s}"
+      end # IF
+    end # DO
+  end
+  
+  def make_all
+    puts "GS< Making all configs"
+    @user_list = Hash.new
+
+    users = File.open(@user_file)
+    # Build a hash of the ext to ip
+    data = YAML::load_documents(users) do |element|
+      @user_list[element['ext']] = element['ip']
+    end
+    @user_list.each do |ext,ip|
+      puts "GS< Making config for #{ext} (#{ip})"
+      make(ip)
+    end
+  end
+
+
+  # Make a config file and push it to phone via web scraping
+  def update_config(ip_address=@ip, current_ip=nil, admin=nil)
+    # Skip the ip address if they already passed it in.
+    if ip_address.nil?
+      puts "GS> What ip address?  "
+      ip_address = STDIN.gets.chomp
+    end
+    if admin.nil?
+       admin = @admin_password
+    end
+    if current_ip.nil?
+      current_ip = ip_address
+    end
+    # Setup the string to shell out to the gsutil script to scrape the webforms
+    cmd = "#{@gsutil} -p '#{admin}' -r '#{current_ip}' < #{@config_files}#{ip_address}.cfg"
+    `#{cmd}`.to_s    # Evil eval().
+    puts "GS< Config sent to phone"
+  end
+
+  # Make a config file for each phone and push it to the phone
+  def update_all
+    puts "GS< Updating all phones"
+    @user_list = Hash.new
+
+    users = File.open(@user_file)
+    # Build a hash of the ext to ip
+    data = YAML::load_documents(users) do |element|
+      if  not element['skip'] == 'y'
+        @user_list[element['ext']] = element['ip']
+      end
+    end
+    @user_list.each do |ext,ip|
+      puts "GS< Making config for #{ext} (#{ip})"
+      update_config(ip)
+    end
+  end
+
+
+  # Reboot a phone
+  def reboot_phone(ip_address=@ip)
+    # Skip the ip address if they already passed it in.
+    if ip_address.nil?
+      puts "GS> What ip address?  "
+      ip_address = STDIN.gets.chomp
+    end
+    # Need a delay, if we just uploaded the new config then the phone will give a 500 
+    # error if we try to reboot it too soon
+    sleep(3) 
+    # Setup the string to shell out to the gsutil script to scrape the webforms
+    cmd = "#{@gsutil} -p '#{@admin_password}' -b '#{ip_address}'"
+    `#{cmd}` # Evil eval() two
+    puts "GS< Phone rebooted"
+  end
+
+  # Reboot all phones
+  def reboot_all_phones
+    puts "GS< Rebooting all phones"
+    @user_list = Hash.new
+
+    users = File.open(@user_file)
+    # Build a hash of the ext to ip
+    data = YAML::load_documents(users) do |element|
+      if  not element['skip'] == 'y'
+        @user_list[element['ext']] = element['ip']
+      end
+    end
+    # Need a delay, if we just uploaded the new config then the phone will give a 500 
+    # error if we try to reboot it too soon
+    sleep(3) 
+    # Go-go BOFH method, this will reboot every phone in the user list.
+    @user_list.each do |ext,ip|
+      puts "GS< Rebooting phone #{ext} (#{ip})"
+      cmd = "#{@gsutil} -p '#{@admin_password}' -b '#{ip}'"
+      `#{cmd}`
+    end
+  end
+
+  # Finds the ip address of the phone if you know the extension.
+  def find_ip
+    print "What extension?  "
+    exten_in = STDIN.gets.chomp.to_i
+
+    # Go thorugh config file loking for the extension
+    data = YAML::load_documents(File.open(@user_file)) do |element|
+      if element['ext'] == exten_in
+        @ip = element['ip']
+        puts "GS< #{element['ip']}"
+      end        
+    end
+  end
+end # Class
+