abstract-php.rb

# encoding: utf-8

require "formula"
require File.join(File.dirname(__FILE__), "abstract-php-version")

class AbstractPhp < Formula
  def self.init
    homepage "https://php.net"

    # So PHP extensions don't report missing symbols
    skip_clean "bin", "sbin"

    head do
      depends_on "autoconf" => :build
      depends_on "re2c" => :build
      depends_on "flex" => :build
      depends_on "bison@2.7" => :build
    end

    # obtain list of php formulas
    php_formulas = Formula.names.grep(Regexp.new('^php\d\d$')).sort

    # remove our self from the list
    php_formulas.delete(name.split("::")[2].downcase)

    # conflict with out php versions
    php_formulas.each do |php_formula_name|
      conflicts_with php_formula_name, :because => "different php versions install the same binaries."
    end

    depends_on "curl" if build.include?("with-homebrew-curl") || MacOS.version < :lion
    depends_on "enchant" => :optional
    depends_on "freetds" if build.include?("with-mssql")
    depends_on "freetype"
    depends_on "gettext"
    depends_on "gmp" => :optional
    depends_on "icu4c"
    depends_on "imap-uw" if build.include?("with-imap")
    depends_on "jpeg"
    depends_on "webp" => :optional if name.split("::")[2].downcase.start_with?("php7")
    depends_on "libvpx" => :optional if name.split("::")[2].downcase.start_with?("php55", "php56")
    depends_on "libpng"
    depends_on "libxml2" if build.include?("with-homebrew-libxml2") || MacOS.version < :lion || MacOS.version >= :el_capitan
    depends_on "unixodbc" unless build.include?("without-unixodbc")
    depends_on "readline"
    depends_on "mysql" if build.include?("with-libmysql")

    # ssl
    if build.include?("with-homebrew-libressl")
      depends_on "libressl"
    else
      depends_on "openssl"
    end

    deprecated_option "with-pgsql" => "with-postgresql"
    depends_on :postgresql => :optional

    # Sanity Checks

    if build.include?("with-cgi") && build.include?("with-fpm")
      raise "Cannot specify more than one CGI executable to build."
    end

    option "with-httpd24", "Enable building of shared Apache 2.4 Handler module"
    option "with-httpd22", "Enable building of shared Apache 2.2 Handler module"
    deprecated_option "homebrew-apxs" => "with-homebrew-apxs"
    deprecated_option "with-homebrew-apxs" => "with-httpd24"
    deprecated_option "with-apache" => "with-httpd24"
    deprecated_option "with-apache22" => "with-httpd22"

    depends_on "homebrew/apache/httpd24" => :optional
    depends_on "homebrew/apache/httpd22" => :optional

    option "with-cgi", "Enable building of the CGI executable (implies --without-fpm)"
    option "with-debug", "Compile with debugging symbols"
    option "with-homebrew-curl", "Include Curl support via Homebrew"
    option "with-homebrew-libressl", "Include LibreSSL instead of OpenSSL via Homebrew"
    option "with-homebrew-libxslt", "Include LibXSLT support via Homebrew"
    option "with-homebrew-libxml2", "Include Libxml2 support via Homebrew"
    option "with-imap", "Include IMAP extension"
    option "with-libmysql", "Include (old-style) libmysql support instead of mysqlnd"
    option "with-mssql", "Include MSSQL-DB support"
    option "with-pear", "Build with PEAR"
    option "with-pdo-oci", "Include Oracle databases (requries ORACLE_HOME be set)"
    unless name.split("::")[2].casecmp("php53").zero?
      option "with-phpdbg", "Enable building of the phpdbg SAPI executable"
    end
    option "with-thread-safety", "Build with thread safety"
    option "without-bz2", "Build without bz2 support"
    option "without-fpm", "Disable building of the fpm SAPI executable"
    option "without-ldap", "Build without LDAP support"
    option "without-mysql", "Remove MySQL/MariaDB support"
    option "without-legacy-mysql", "Do not include the deprecated mysql_ functions"
    option "without-pcntl", "Build without Process Control support"
    option "without-unixodbc", "Build without unixODBC support"
  end

  # Fixes the pear .lock permissions issue that keeps it from operating correctly.
  # Thanks mistym & #machomebrew
  skip_clean "lib/php/.lock"

  def config_path
    etc+"php"+php_version
  end

  def home_path
    File.expand_path("~")
  end

  def build_fpm?
    true unless build.without?("fpm") || build.with?("cgi")
  end

  def php_version
    raise "Unspecified php version"
  end

  def php_version_path
    raise "Unspecified php version path"
  end

  def install
    # Ensure this php has a version specified
    php_version
    php_version_path

    # Not removing all pear.conf and .pearrc files from PHP path results in
    # the PHP configure not properly setting the pear binary to be installed
    config_pear = "#{config_path}/pear.conf"
    user_pear = "#{home_path}/pear.conf"
    config_pearrc = "#{config_path}/.pearrc"
    user_pearrc = "#{home_path}/.pearrc"
    if File.exist?(config_pear) || File.exist?(user_pear) || File.exist?(config_pearrc) || File.exist?(user_pearrc)
      opoo "Backing up all known pear.conf and .pearrc files"
      opoo <<-INFO
If you have a pre-existing pear install outside
         of homebrew-php, or you are using a non-standard
         pear.conf location, installation may fail.
INFO
      mv(config_pear, "#{config_pear}-backup") if File.exist? config_pear
      mv(user_pear, "#{user_pear}-backup") if File.exist? user_pear
      mv(config_pearrc, "#{config_pearrc}-backup") if File.exist? config_pearrc
      mv(user_pearrc, "#{user_pearrc}-backup") if File.exist? user_pearrc
    end

    begin
      _install
      rm_f("#{config_pear}-backup") if File.exist? "#{config_pear}-backup"
      rm_f("#{user_pear}-backup") if File.exist? "#{user_pear}-backup"
      rm_f("#{config_pearrc}-backup") if File.exist? "#{config_pearrc}-backup"
      rm_f("#{user_pearrc}-backup") if File.exist? "#{user_pearrc}-backup"
    rescue StandardError
      mv("#{config_pear}-backup", config_pear) if File.exist? "#{config_pear}-backup"
      mv("#{user_pear}-backup", user_pear) if File.exist? "#{user_pear}-backup"
      mv("#{config_pearrc}-backup", config_pearrc) if File.exist? "#{config_pearrc}-backup"
      mv("#{user_pearrc}-backup", user_pearrc) if File.exist? "#{user_pearrc}-backup"
      raise
    end
  end

  def apache_apxs
    if build.with?("httpd24") || build.with?("httpd22")
      ["sbin", "bin"].each do |dir|
        if File.exist?(location = "#{HOMEBREW_PREFIX}/#{dir}/apxs")
          return location
        end
      end
    else
      "/usr/sbin/apxs"
    end
  end

  def default_config
    "./php.ini-development"
  end

  def skip_pear_config_set?
    build.without? "pear"
  end

  def patches
    # Bug in PHP 5.x causes build to fail on OSX 10.5 Leopard due to
    # outdated system libraries being first on library search path:
    # https://bugs.php.net/bug.php?id=44294
    "https://gist.github.com/ablyler/6579338/raw/5713096862e271ca78e733b95e0235d80fed671a/Makefile.global.diff" if MacOS.version == :leopard
  end

  def install_args
    # Prevent PHP from harcoding sed shim path
    ENV["lt_cv_path_SED"] = "sed"

    args = [
      "--prefix=#{prefix}",
      "--localstatedir=#{var}",
      "--sysconfdir=#{config_path}",
      "--with-config-file-path=#{config_path}",
      "--with-config-file-scan-dir=#{config_path}/conf.d",
      "--mandir=#{man}",
      "--enable-bcmath",
      "--enable-calendar",
      "--enable-dba",
      "--enable-exif",
      "--enable-ftp",
      "--enable-gd-native-ttf",
      "--enable-mbregex",
      "--enable-mbstring",
      "--enable-shmop",
      "--enable-soap",
      "--enable-sockets",
      "--enable-sysvmsg",
      "--enable-sysvsem",
      "--enable-sysvshm",
      "--enable-wddx",
      "--enable-zip",
      "--with-freetype-dir=#{Formula["freetype"].opt_prefix}",
      "--with-gd",
      "--with-gettext=#{Formula["gettext"].opt_prefix}",
      ("--with-iconv-dir=/usr" if OS.mac?),
      "--with-icu-dir=#{Formula["icu4c"].opt_prefix}",
      "--with-jpeg-dir=#{Formula["jpeg"].opt_prefix}",
      ("--with-kerberos=/usr" if OS.mac?),
      "--with-mhash",
      ("--with-ndbm=/usr" if OS.mac?),
      "--with-png-dir=#{Formula["libpng"].opt_prefix}",
      "--with-xmlrpc",
      "--with-zlib=/usr",
      "--with-readline=#{Formula["readline"].opt_prefix}",
      "--without-gmp",
      "--without-snmp",
    ]

    if build.include?("with-homebrew-libxml2") || MacOS.version < :lion || MacOS.version >= :el_capitan
      args << "--with-libxml-dir=#{Formula["libxml2"].opt_prefix}"
    end

    # Build PDO ODBC with unixODBC by default
    unless build.without? "unixodbc"
      args << "--with-pdo-odbc=unixODBC,#{Formula["unixodbc"].opt_prefix}"
      args << "--with-unixODBC=#{Formula["unixodbc"].opt_prefix}"
    end

    # Build Apache module by default
    if build.with?("httpd24") || build.with?("httpd22")
      args << "--with-apxs2=#{apache_apxs}"
      args << "--libexecdir=#{libexec}"
    end

    if build.with? "bz2"
      args << "--with-bz2=/usr" if OS.mac?
    end

    if build.with? "debug"
      args << "--enable-debug"
    end

    if build.with? "enchant"
      args << "--with-enchant=#{Formula["enchant"].opt_prefix}"
    end

    if build.include?("with-homebrew-libressl")
      args << "--with-openssl=" + Formula["libressl"].opt_prefix.to_s
    else
      args << "--with-openssl=" + Formula["openssl"].opt_prefix.to_s
    end

    # Build PHP-FPM by default
    if build_fpm?
      args << "--enable-fpm"
      args << "--with-fpm-user=_www"
      args << "--with-fpm-group=_www"
      (prefix+"var/log").mkpath
      touch prefix+"var/log/php-fpm.log"
      plist_path.write plist
      plist_path.chmod 0644
    elsif build.with? "cgi"
      args << "--enable-cgi"
    end

    if build.include?("with-homebrew-curl") || MacOS.version < :lion
      args << "--with-curl=#{Formula["curl"].opt_prefix}"
    else
      args << "--with-curl"
    end

    if build.with? "homebrew-libxslt"
      args << "--with-xsl=" + Formula["libxslt"].opt_prefix.to_s
    elsif OS.mac?
      args << "--with-xsl=/usr"
    end

    if build.with? "imap"
      args << "--with-imap=#{Formula["imap-uw"].opt_prefix}"
      args << "--with-imap-ssl=" + Formula["openssl"].opt_prefix.to_s
    end

    unless build.without? "ldap"
      args << "--with-ldap"
      args << "--with-ldap-sasl=/usr"
    end

    if build.with? "libmysql"
      args << "--with-mysql-sock=/tmp/mysql.sock"
      args << "--with-mysqli=#{HOMEBREW_PREFIX}/bin/mysql_config"
      args << "--with-mysql=#{HOMEBREW_PREFIX}" unless (build.without? "legacy-mysql") || php_version.start_with?("7.")
      args << "--with-pdo-mysql=#{HOMEBREW_PREFIX}"
    elsif build.with? "mysql"
      args << "--with-mysql-sock=/tmp/mysql.sock"
      args << "--with-mysqli=mysqlnd"
      args << "--with-mysql=mysqlnd" unless (build.without? "legacy-mysql") || php_version.start_with?("5.5", "5.6", "7.")
      args << "--with-pdo-mysql=mysqlnd"
    end

    if build.with? "mssql"
      args << "--with-mssql=#{Formula["freetds"].opt_prefix}"
      args << "--with-pdo-dblib=#{Formula["freetds"].opt_prefix}"
    end

    # Do not build opcache by default; use a "phpxx-opcache" formula
    args << "--disable-opcache" if php_version.start_with?("5.5", "5.6", "7.")

    if build.with? "pcntl"
      args << "--enable-pcntl"
    end

    if build.with? "pdo-oci"
      if ENV.key?("ORACLE_HOME")
        args << "--with-pdo-oci=#{ENV["ORACLE_HOME"]}"
      else
        raise "Environmental variable ORACLE_HOME must be set to use --with-pdo-oci option."
      end
    end

    if build.without? "pear"
      args << "--without-pear"
    end

    if build.with? "postgresql"
      if Formula["postgresql"].opt_prefix.directory?
        args << "--with-pgsql=#{Formula["postgresql"].opt_prefix}"
        args << "--with-pdo-pgsql=#{Formula["postgresql"].opt_prefix}"
      else
        args << "--with-pgsql=#{`pg_config --includedir`}"
        args << "--with-pdo-pgsql=#{`which pg_config`}"
      end
    end

    unless php_version.start_with?("5.3")
      # dtrace is not compatible with phpdbg: https://github.com/krakjoe/phpdbg/issues/38
      if build.without? "phpdbg"
        args << "--enable-dtrace"
        args << "--disable-phpdbg"
      else
        args << "--enable-phpdbg"

        if build.with? "debug"
          args << "--enable-phpdbg-debug"
        end
      end

      args << "--enable-zend-signals"
    end

    if build.with? "webp"
      args << "--with-webp-dir=#{Formula['webp'].opt_prefix}"
    end

    if build.with? "libvpx"
      args << "--with-vpx-dir=#{Formula['libvpx'].opt_prefix}"
    end

    if build.with? "thread-safety"
      args << "--enable-maintainer-zts"
    end

    args
  end

  def _install
    system "./buildconf", "--force" if build.head?
    system "./configure", *install_args

    if build.with?("httpd24") || build.with?("httpd22")
      # Use Homebrew prefix for the Apache libexec folder
      inreplace "Makefile",
        /^INSTALL_IT = \$\(mkinstalldirs\) '([^']+)' (.+) LIBEXECDIR=([^\s]+) (.+)$/,
        "INSTALL_IT = $(mkinstalldirs) '#{libexec}/apache2' \\2 LIBEXECDIR='#{libexec}/apache2' \\4"
    end

    inreplace "Makefile" do |s|
      s.change_make_var! "EXTRA_LIBS", "\\1 -lstdc++"
    end

    system "make"
    ENV.deparallelize # parallel install fails on some systems
    system "make install"

    # Prefer relative symlink instead of absolute for relocatable bottles
    ln_s "phar.phar", bin+"phar", :force => true if File.exist? bin+"phar.phar"

    # Install new php.ini unless one exists
    config_path.install default_config => "php.ini" unless File.exist? config_path+"php.ini"

    chmod_R 0775, lib+"php"

    system bin+"pear", "config-set", "php_ini", config_path+"php.ini", "system" unless skip_pear_config_set?

    if build_fpm?
      if File.exist?("sapi/fpm/init.d.php-fpm")
        chmod 0755, "sapi/fpm/init.d.php-fpm"
        sbin.install "sapi/fpm/init.d.php-fpm" => "php#{php_version_path}-fpm"
      end

      if File.exist?("sapi/cgi/fpm/php-fpm")
        chmod 0755, "sapi/cgi/fpm/php-fpm"
        sbin.install "sapi/cgi/fpm/php-fpm" => "php#{php_version_path}-fpm"
      end

      if !File.exist?(config_path+"php-fpm.d/www.conf") && File.exist?(config_path+"php-fpm.d/www.conf.default")
        mv(config_path+"php-fpm.d/www.conf.default", config_path+"php-fpm.d/www.conf")
      end

      unless File.exist?(config_path+"php-fpm.conf")
        if File.exist?("sapi/fpm/php-fpm.conf")
          config_path.install "sapi/fpm/php-fpm.conf"
        end

        if File.exist?("sapi/cgi/fpm/php-fpm.conf")
          config_path.install "sapi/cgi/fpm/php-fpm.conf"
        end

        inreplace config_path+"php-fpm.conf" do |s|
          s.sub!(/^;?daemonize\s*=.+$/, "daemonize = no")
          s.sub!(/^;include\s*=.+$/, ";include=#{config_path}/fpm.d/*.conf") if php_version.start_with?("5")
          s.sub!(/^;?listen\.mode\s*=.+$/, "listen.mode = 0666") if php_version.start_with?("5")
          s.sub!(/^;?pm\.max_children\s*=.+$/, "pm.max_children = 10") if php_version.start_with?("5")
          s.sub!(/^;?pm\.start_servers\s*=.+$/, "pm.start_servers = 3") if php_version.start_with?("5")
          s.sub!(/^;?pm\.min_spare_servers\s*=.+$/, "pm.min_spare_servers = 2") if php_version.start_with?("5")
          s.sub!(/^;?pm\.max_spare_servers\s*=.+$/, "pm.max_spare_servers = 5") if php_version.start_with?("5")
        end
      end
    end
  end

  def caveats
    s = []

    if build.with?("httpd24") || build.with?("httpd22")
      if MacOS.version <= :leopard
        s << <<-EOS.undent
          For 10.5 and Apache:
              Apache needs to run in 32-bit mode. You can either force Apache to start in 32-bit mode or you can thin the Apache executable.
        EOS
      end

      if php_version.start_with?("7.")
        s << <<-EOS.undent
          To enable PHP in Apache add the following to httpd.conf and restart Apache:
              LoadModule php7_module #{HOMEBREW_PREFIX}/opt/php#{php_version_path}/libexec/apache2/libphp7.so

              <FilesMatch \.php$>
                  SetHandler application/x-httpd-php
              </FilesMatch>

          Finally, check DirectoryIndex includes index.php
              DirectoryIndex index.php index.html
        EOS
      else
        s << <<-EOS.undent
          To enable PHP in Apache add the following to httpd.conf and restart Apache:
              LoadModule php5_module #{HOMEBREW_PREFIX}/opt/php#{php_version_path}/libexec/apache2/libphp5.so
        EOS
      end
    end

    s << <<-EOS.undent
      The php.ini file can be found in:
          #{config_path}/php.ini
    EOS

    if build.with? "pear"
      s << <<-EOS.undent
        ✩✩✩✩ PEAR ✩✩✩✩

        If PEAR complains about permissions, 'fix' the default PEAR permissions and config:

            chmod -R ug+w #{lib}/php
            pear config-set php_ini #{etc}/php/#{php_version}/php.ini system
      EOS
    end

    s << <<-EOS.undent
      ✩✩✩✩ Extensions ✩✩✩✩

      If you are having issues with custom extension compiling, ensure that you are using the brew version, by placing #{HOMEBREW_PREFIX}/bin before /usr/sbin in your PATH:

            PATH="#{HOMEBREW_PREFIX}/bin:$PATH"

      PHP#{php_version_path} Extensions will always be compiled against this PHP. Please install them using --without-homebrew-php to enable compiling against system PHP.
    EOS

    s << <<-EOS.undent
      ✩✩✩✩ PHP CLI ✩✩✩✩

      If you wish to swap the PHP you use on the command line, you should add the following to ~/.bashrc, ~/.zshrc, ~/.profile or your shell's equivalent configuration file:
        export PATH="$(brew --prefix homebrew/php/php#{php_version.delete(".")})/bin:$PATH"
    EOS

    if build.include?("with-mcrypt")
      s << <<-EOS.undent
      ✩✩✩✩  Mcrypt ✩✩✩✩

      mcrypt is no longer included by default, install it as a separate extension:

          brew install php#{php_version_path}-mcrypt
    EOS
    end

    if build.include?("enable-opcache")
      s << <<-EOS.undent
      ✩✩✩✩ Opcache ✩✩✩✩

      opcache (PHP 5.5 and 5.6) is no longer included by default, install it as a separate extension:

          brew install php#{php_version_path}-opcache
    EOS
    end

    if build.include?("with-gmp")
      s << <<-EOS.undent
        GMP has moved to its own formula, please install it by running: brew install php#{php_version_path}-gmp
      EOS
    end

    if build.include?("with-snmp")
      s << <<-EOS.undent
        SNMP has moved to its own formula, please install it by running: brew install php#{php_version_path}-snmp
      EOS
    end

    if build.include?("with-tidy")
      s << <<-EOS.undent
        Tidy has moved to its own formula, please install it by running: brew install php#{php_version_path}-tidy
      EOS
    end

    if build_fpm?
      s << <<-EOS.undent
        ✩✩✩✩ FPM ✩✩✩✩

        To launch php-fpm on startup:
            mkdir -p ~/Library/LaunchAgents
            cp #{opt_prefix}/#{plist_name}.plist ~/Library/LaunchAgents/
            launchctl load -w ~/Library/LaunchAgents/#{plist_name}.plist

        The control script is located at #{opt_sbin}/php#{php_version_path}-fpm
      EOS

      if MacOS.version >= :mountain_lion
        s << <<-EOS.undent
          OS X 10.8 and newer come with php-fpm pre-installed, to ensure you are using the brew version you need to make sure #{HOMEBREW_PREFIX}/sbin is before /usr/sbin in your PATH:

            PATH="#{HOMEBREW_PREFIX}/sbin:$PATH"
        EOS
      end

      s << <<-EOS.undent
        You may also need to edit the plist to use the correct "UserName".

        Please note that the plist was called 'homebrew-php.josegonzalez.php#{php_version.delete(".")}.plist' in old versions of this formula.

        With the release of macOS Sierra the Apache module is now not built by default. If you want to build it on your system you have to install php with the --with-httpd24 option. See  brew options php#{php_version_path} for more details.
      EOS
    end

    s.join "\n"
  end

  test do
    system "#{bin}/php -i"

    if build_fpm?
      system "#{sbin}/php-fpm -y #{config_path}/php-fpm.conf -t"
    end
  end

  def plist; <<-EOPLIST.undent
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    <plist version="1.0">
    <dict>
      <key>KeepAlive</key>
      <true/>
      <key>Label</key>
      <string>#{plist_name}</string>
      <key>ProgramArguments</key>
      <array>
        <string>#{opt_sbin}/php-fpm</string>
        <string>--nodaemonize</string>
        <string>--fpm-config</string>
        <string>#{config_path}/php-fpm.conf</string>
      </array>
      <key>RunAtLoad</key>
      <true/>
      <key>LaunchOnlyOnce</key>
      <true/>
      <key>UserName</key>
      <string>#{`whoami`.chomp}</string>
      <key>WorkingDirectory</key>
      <string>#{var}</string>
      <key>StandardErrorPath</key>
      <string>#{opt_prefix}/var/log/php-fpm.log</string>
    </dict>
    </plist>
    EOPLIST
  end
end