server_maint 0.0.2 → 0.0.3

data/lib/cookbooks/php/README.md

@@ -0,0 +1,253 @@
+Description
+===========
+
+Installs and configures PHP 5.3 and the PEAR package management system.  Also includes LWRPs for managing PEAR (and PECL) packages along with PECL channels.
+
+---
+Requirements
+============
+
+Platform
+--------
+
+* Debian, Ubuntu
+* CentOS, Red Hat, Fedora
+
+Cookbooks
+---------
+
+* build-essential
+* xml
+* mysql
+
+These cookbooks are only used when building PHP from source.
+
+---
+Attributes
+==========
+
+* `node['php']['install_method']` = method to install php with, default `package`.
+* `node['php']['directives']` = Hash of directives and values to append
+  to `php.ini`, default `{}`.
+
+The file also contains the following attribute types:
+
+* platform specific locations and settings.
+* source installation settings
+
+---
+Resource/Provider
+=================
+
+This cookbook includes LWRPs for managing:
+
+* PEAR channels
+* PEAR/PECL packages
+
+`php_pear_channel`
+------------------
+
+[PEAR Channels](http://pear.php.net/manual/en/guide.users.commandline.channels.php) are alternative sources for PEAR packages.  This LWRP provides and easy way to manage these channels.
+
+# Actions
+
+- :discover: Initialize a channel from its server.
+- :add: Add a channel to the channel list, usually only used to add private channels.  Public channels are usually added using the `:discover` action
+- :update: Update an existing channel
+- :remove: Remove a channel from the List
+
+# Attribute Parameters
+
+- channel_name: name attribute. The name of the channel to discover
+- channel_xml: the channel.xml file of the channel you are adding
+
+# Example
+    
+    # discover the horde channel
+    php_pear_channel "pear.horde.org" do
+      action :discover
+    end
+    
+    # download xml then add the symfony channel
+    remote_file "#{Chef::Config[:file_cache_path]}/symfony-channel.xml" do
+      source "http://pear.symfony-project.com/channel.xml"
+      mode 0644
+    end
+    php_pear_channel "symfony" do
+      channel_xml "#{Chef::Config[:file_cache_path]}/symfony-channel.xml"
+      action :add
+    end
+    
+    # update the main pear channel
+    php_pear_channel 'pear.php.net' do
+      action :update
+    end
+    
+    # update the main pecl channel
+    php_pear_channel 'pecl.php.net' do
+      action :update
+    end
+    
+
+`php_pear`
+----------
+
+[PEAR](http://pear.php.net/) is a framework and distribution system for reusable PHP components. [PECL](http://pecl.php.net/) is a repository for PHP Extensions. PECL contains C extensions for compiling into PHP. As C programs, PECL extensions run more efficiently than PEAR packages. PEARs and PECLs use the same packaging and distribution system.  As such this LWRP is clever enough to abstract away the small differences and can be used for managing either.  This LWRP also creates the proper module .ini file for each PECL extension at the correct location for each supported platform.
+
+# Actions
+
+- :install: Install a pear package - if version is provided, install that specific version
+- :upgrade: Upgrade a pear package - if version is provided, upgrade to that specific version
+- :remove: Remove a pear package
+- :purge: Purge a pear package (this usually entails removing configuration files as well as the package itself).  With pear packages this behaves the same as `:remove`
+
+# Attribute Parameters
+
+- package_name: name attribute. The name of the pear package to install
+- version: the version of the pear package to install/upgrade.  If no version is given latest is assumed.
+- preferred_state: PEAR by default installs stable packages only, this allows you to install pear packages in a devel, alpha or beta state
+- directives: extra extension directives (settings) for a pecl. on most platforms these usually get rendered into the extension's .ini file
+- zend_extensions: extension filenames which should be loaded with zend_extension.
+- options: Add additional options to the underlying pear package command
+
+
+# Example
+
+    # upgrade a pear
+    php_pear "XML_RPC" do
+      action :upgrade
+    end
+    
+    
+    # install a specific version
+    php_pear "XML_RPC" do
+      version "1.5.4"
+      action :install
+    end
+    
+    
+    # install the mongodb pecl
+    php_pear "mongo" do
+      action :install
+    end
+
+    # install the xdebug pecl
+    php_pear "xdebug" do
+      # Specify that xdebug.so must be loaded as a zend extension
+      zend_extensions ['xdebug.so']
+      action :install
+    end
+    
+    
+    # install apc pecl with directives
+    php_pear "apc" do
+      action :install
+      directives(:shm_size => 128, :enable_cli => 1)
+    end
+    
+    
+    # install the beta version of Horde_Url 
+    # from the horde channel
+    hc = php_pear_channel "pear.horde.org" do
+      action :discover
+    end
+    php_pear "Horde_Url" do
+      preferred_state "beta"
+      channel hc.channel_name
+      action :install
+    end
+    
+    
+    # install the YAML pear from the symfony project
+    sc = php_pear_channel "pear.symfony-project.com" do
+      action :discover
+    end
+    php_pear "YAML" do
+      channel sc.channel_name
+      action :install
+    end
+    
+---
+Recipes
+=======
+
+default
+-------
+
+Include the default recipe in a run list, to get `php`.  By default `php` is installed from packages but this can be changed by using the `install_method` attribute.
+
+package
+-------
+
+This recipe installs PHP from packages.
+
+source
+------
+
+This recipe installs PHP from source.
+
+---
+Deprecated Recipes
+==================
+
+The following recipes are deprecated and will be removed from a future version of this cookbook.
+
+* `module_apc`
+* `module_curl`
+* `module_fileinfo`
+* `module_fpdf`
+* `module_gd`
+* `module_ldap`
+* `module_memcache`
+* `module_mysql`
+* `module_pgsql`
+* `module_sqlite3`
+
+The installation of the php modules in these recipes can now be accomplished by installing from a native package or via the new php_pear LWRP.  For example, the functionality of the `module_memcache` recipe can be enabled in the following ways:
+
+    # using apt
+    package "php5-memcache" do
+      action :install
+    end
+    
+    # using pear LWRP
+    php_pear "memcache" do
+      action :install
+    end
+
+---
+Usage
+=====
+
+Simply include the `php` recipe where ever you would like php installed.  To install from source override the `node['php']['install_method']` attribute with in a role:
+
+    name "php"
+    description "Install php from source"
+    override_attributes(
+      "php" => {
+        "install_method" => "source"
+      }
+    )
+    run_list(
+      "recipe[php]"
+    )
+
+License and Author
+==================
+
+Author:: Seth Chisamore (<schisamo@opscode.com>)
+Author:: Joshua Timberman (<joshua@opscode.com>)
+
+Copyright:: 2011, Opscode, Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/lib/cookbooks/php/attributes/default.rb

@@ -0,0 +1,86 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Cookbook Name:: php
+# Attribute:: default
+#
+# Copyright 2011, Opscode, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+lib_dir = kernel['machine'] =~ /x86_64/ ? 'lib64' : 'lib'
+
+default['php']['install_method'] = 'package'
+default['php']['directives'] = {}
+
+case node["platform_family"]
+when "rhel", "fedora"
+  default['php']['conf_dir']      = '/etc'
+  default['php']['ext_conf_dir']  = '/etc/php.d'
+  default['php']['fpm_user']      = 'nobody'
+  default['php']['fpm_group']     = 'nobody'
+  default['php']['ext_dir']       = "/usr/#{lib_dir}/php/modules"
+when "debian"
+  default['php']['conf_dir']      = '/etc/php5/cli'
+  default['php']['ext_conf_dir']  = '/etc/php5/conf.d'
+  default['php']['fpm_user']      = 'www-data'
+  default['php']['fpm_group']     = 'www-data'
+else
+  default['php']['conf_dir']      = '/etc/php5/cli'
+  default['php']['ext_conf_dir']  = '/etc/php5/conf.d'
+  default['php']['fpm_user']      = 'www-data'
+  default['php']['fpm_group']     = 'www-data'
+end
+
+default['php']['url'] = 'http://us.php.net/distributions'
+default['php']['version'] = '5.3.10'
+default['php']['checksum'] = 'ee26ff003eaeaefb649735980d9ef1ffad3ea8c2836e6ad520de598da225eaab'
+default['php']['prefix_dir'] = '/usr/local'
+
+default['php']['configure_options'] = %W{--prefix=#{php['prefix_dir']}
+                                          --with-libdir=#{lib_dir}
+                                          --with-config-file-path=#{php['conf_dir']}
+                                          --with-config-file-scan-dir=#{php['ext_conf_dir']}
+                                          --with-pear
+                                          --enable-fpm
+                                          --with-fpm-user=#{php['fpm_user']}
+                                          --with-fpm-group=#{php['fpm_group']}
+                                          --with-zlib
+                                          --with-openssl
+                                          --with-kerberos
+                                          --with-bz2
+                                          --with-curl
+                                          --enable-ftp
+                                          --enable-zip
+                                          --enable-exif
+                                          --with-gd
+                                          --enable-gd-native-ttf
+                                          --with-gettext
+                                          --with-gmp
+                                          --with-mhash
+                                          --with-iconv
+                                          --with-imap
+                                          --with-imap-ssl
+                                          --enable-sockets
+                                          --enable-soap
+                                          --with-xmlrpc
+                                          --with-libevent-dir
+                                          --with-mcrypt
+                                          --enable-mbstring
+                                          --with-t1lib
+                                          --with-mysql
+                                          --with-mysqli=/usr/bin/mysql_config
+                                          --with-mysql-sock
+                                          --with-sqlite3
+                                          --with-pdo-mysql
+                                          --with-pdo-sqlite}

data/lib/cookbooks/php/metadata.rb

@@ -0,0 +1,27 @@
+maintainer        "Opscode, Inc."
+maintainer_email  "cookbooks@opscode.com"
+license           "Apache 2.0"
+description       "Installs and maintains php and php modules"
+version           "1.1.0"
+
+depends "build-essential"
+depends "xml"
+depends "mysql"
+
+%w{ debian ubuntu centos redhat fedora scientific amazon }.each do |os|
+  supports os
+end
+
+recipe "php", "Installs php"
+recipe "php::package", "Installs php using packages."
+recipe "php::source", "Installs php from source."
+recipe "php::module_apc", "Install the php5-apc package"
+recipe "php::module_curl", "Install the php5-curl package"
+recipe "php::module_fileinfo", "Install the php5-fileinfo package"
+recipe "php::module_fpdf", "Install the php-fpdf package"
+recipe "php::module_gd", "Install the php5-gd package"
+recipe "php::module_ldap", "Install the php5-ldap package"
+recipe "php::module_memcache", "Install the php5-memcache package"
+recipe "php::module_mysql", "Install the php5-mysql package"
+recipe "php::module_pgsql", "Install the php5-pgsql packag"
+recipe "php::module_sqlite3", "Install the php5-sqlite3 package"

data/lib/cookbooks/php/providers/pear.rb

@@ -0,0 +1,261 @@
+#
+# Author:: Seth Chisamore <schisamo@opscode.com>
+# Cookbook Name:: php
+# Provider:: pear_package
+#
+# Copyright:: 2011, Opscode, Inc <legal@opscode.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/mixin/shell_out'
+require 'chef/mixin/language'
+include Chef::Mixin::ShellOut
+
+# the logic in all action methods mirror that of
+# the Chef::Provider::Package which will make
+# refactoring into core chef easy
+
+action :install do
+  # If we specified a version, and it's not the current version, move to the specified version
+  if @new_resource.version != nil && @new_resource.version != @current_resource.version
+    install_version = @new_resource.version
+  # If it's not installed at all, install it
+  elsif @current_resource.version == nil
+    install_version = candidate_version
+  end
+
+  if install_version
+    Chef::Log.info("Installing #{@new_resource} version #{install_version}")
+    status = install_package(@new_resource.package_name, install_version)
+    if status
+      new_resource.updated_by_last_action(true)
+    end
+  end
+end
+
+action :upgrade do
+  if @current_resource.version != candidate_version
+    orig_version = @current_resource.version || "uninstalled"
+    Chef::Log.info("Upgrading #{@new_resource} version from #{orig_version} to #{candidate_version}")
+    status = upgrade_package(@new_resource.package_name, candidate_version)
+    if status
+      new_resource.updated_by_last_action(true)
+    end
+  end
+end
+
+action :remove do
+  if removing_package?
+    Chef::Log.info("Removing #{@new_resource}")
+    remove_package(@current_resource.package_name, @new_resource.version)
+    new_resource.updated_by_last_action(true)
+  else
+  end
+end
+
+action :purge do
+  if removing_package?
+    Chef::Log.info("Purging #{@new_resource}")
+    purge_package(@current_resource.package_name, @new_resource.version)
+    new_resource.updated_by_last_action(true)
+  end
+end
+
+def removing_package?
+  if @current_resource.version.nil?
+    false # nothing to remove
+  elsif @new_resource.version.nil?
+    true # remove any version of a package
+  elsif @new_resource.version == @current_resource.version
+    true # remove the version we have
+  else
+    false # we don't have the version we want to remove
+  end
+end
+
+def expand_options(options)
+  options ? " #{options}" : ""
+end
+
+# these methods are the required overrides of
+# a provider that extends from Chef::Provider::Package
+# so refactoring into core Chef should be easy
+
+def load_current_resource
+  @current_resource = Chef::Resource::PhpPear.new(@new_resource.name)
+  @current_resource.package_name(@new_resource.package_name)
+  @bin = 'pear'
+  if pecl?
+    Chef::Log.debug("#{@new_resource} smells like a pecl...installing package in Pecl mode.")
+    @bin = 'pecl'
+  end
+  Chef::Log.debug("#{@current_resource}: Installed version: #{current_installed_version} Candidate version: #{candidate_version}")
+
+  unless current_installed_version.nil?
+    @current_resource.version(current_installed_version)
+    Chef::Log.debug("Current version is #{@current_resource.version}") if @current_resource.version
+  end
+  @current_resource
+end
+
+def current_installed_version
+  @current_installed_version ||= begin
+    v = nil
+    version_check_cmd = "#{@bin} -d preferred_state=#{can_haz(@new_resource, "preferred_state")} list#{expand_channel(can_haz(@new_resource, "channel"))}"
+    p = shell_out(version_check_cmd)
+    response = nil
+    if p.stdout =~ /\.?Installed packages/i
+      response = grep_for_version(p.stdout, @new_resource.package_name)
+    end
+    response
+  end
+end
+
+def candidate_version
+  @candidate_version ||= begin
+    candidate_version_cmd = "#{@bin} -d preferred_state=#{can_haz(@new_resource, "preferred_state")} search#{expand_channel(can_haz(@new_resource, "channel"))} #{@new_resource.package_name}"
+    p = shell_out(candidate_version_cmd)
+    response = nil
+    if p.stdout =~ /\.?Matched packages/i
+      response = grep_for_version(p.stdout, @new_resource.package_name)
+    end
+    response
+  end
+end
+
+def install_package(name, version)
+  pear_shell_out("echo -e \"\\r\" | #{@bin} -d preferred_state=#{can_haz(@new_resource, "preferred_state")} install -a#{expand_options(@new_resource.options)} #{prefix_channel(can_haz(@new_resource, "channel"))}#{name}-#{version}")
+  manage_pecl_ini(name, :create, can_haz(@new_resource, "directives"), can_haz(@new_resource, "zend_extensions")) if pecl?
+end
+
+def upgrade_package(name, version)
+  pear_shell_out("echo -e \"\\r\" | #{@bin} -d preferred_state=#{can_haz(@new_resource, "preferred_state")} upgrade -a#{expand_options(@new_resource.options)} #{prefix_channel(can_haz(@new_resource, "channel"))}#{name}-#{version}")
+  manage_pecl_ini(name, :create, can_haz(@new_resource, "directives"), can_haz(@new_resource, "zend_extensions")) if pecl?
+end
+
+def remove_package(name, version)
+  command = "#{@bin} uninstall #{expand_options(@new_resource.options)} #{prefix_channel(can_haz(@new_resource, "channel"))}#{name}"
+  command << "-#{version}" if version and !version.empty?
+  pear_shell_out(command)
+  manage_pecl_ini(name, :delete) if pecl?
+end
+
+def pear_shell_out(command)
+  p = shell_out!(command)
+  # pear/pecl commands return a 0 on failures...we'll grep for it
+  if p.stdout.split("\n").last =~ /^ERROR:.+/i
+    p.invalid!
+  end
+  p
+end
+
+def purge_package(name, version)
+  remove_package(name, version)
+end
+
+def expand_channel(channel)
+  channel ? " -c #{channel}" : ""
+end
+
+def prefix_channel(channel)
+  channel ? "#{channel}/" : ""
+end
+
+def get_extension_dir()
+  @extension_dir ||= begin
+    p = shell_out("php-config --extension-dir")
+    p.stdout.strip
+  end
+end
+
+def get_extension_files(name)
+  files = []
+
+  p = shell_out("#{@bin} list-files #{name}")
+  p.stdout.each_line.grep(/^src\s+.*\.so$/i).each do |line|
+    files << line.split[1]
+  end
+
+  files
+end
+
+def manage_pecl_ini(name, action, directives, zend_extensions)
+  ext_prefix = get_extension_dir()
+  ext_prefix << ::File::SEPARATOR if ext_prefix[-1].chr != ::File::SEPARATOR
+
+  files = get_extension_files(name)
+
+  extensions = Hash[ files.map { |filepath|
+    rel_file = filepath.clone
+    rel_file.slice! ext_prefix if rel_file.start_with? ext_prefix
+
+    zend = zend_extensions.include?(rel_file)
+
+    [ (zend ? filepath : rel_file) , zend ]
+  }]
+
+  template "#{node['php']['ext_conf_dir']}/#{name}.ini" do
+    source "extension.ini.erb"
+    cookbook "php"
+    owner "root"
+    group "root"
+    mode "0644"
+    variables(:name => name, :extensions => extensions, :directives => directives)
+    action action
+  end
+end
+
+def grep_for_version(stdout, package)
+  v = nil
+
+  stdout.split(/\n/).grep(/^#{package}\s/i).each do |m|
+    # XML_RPC          1.5.4    stable
+    # mongo   1.1.4/(1.1.4 stable) 1.1.4 MongoDB database driver
+    # Horde_Url -n/a-/(1.0.0beta1 beta)       Horde Url class
+    # Horde_Url 1.0.0beta1 (beta) 1.0.0beta1 Horde Url class
+    v = m.split(/\s+/)[1].strip
+    if v.split(/\//)[0] =~ /.\./
+      # 1.1.4/(1.1.4 stable)
+      v = v.split(/\//)[0]
+    else
+      # -n/a-/(1.0.0beta1 beta)
+      v = v.split(/(.*)\/\((.*)/).last.split(/\s/)[0]
+    end
+  end
+  v
+end
+
+def pecl?
+  @pecl ||= begin
+    # search as a pear first since most 3rd party channels will report pears as pecls!
+    search_cmd = "pear -d preferred_state=#{can_haz(@new_resource, "preferred_state")} search#{expand_channel(can_haz(@new_resource, "channel"))} #{@new_resource.package_name}"
+    if shell_out(search_cmd).stdout =~ /\.?Matched packages/i
+      false
+    else
+      # fall back and search as a pecl
+      search_cmd = "pecl -d preferred_state=#{can_haz(@new_resource, "preferred_state")} search#{expand_channel(can_haz(@new_resource, "channel"))} #{@new_resource.package_name}"
+      if shell_out(search_cmd).stdout =~ /\.?Matched packages/i
+        true
+      else
+        false
+      end
+    end
+  end
+end
+
+# TODO remove when provider is moved into Chef core
+# this allows PhpPear to work with Chef::Resource::Package
+def can_haz(resource, attribute_name)
+  resource.respond_to?(attribute_name) ? resource.send(attribute_name) : nil
+end