brew/Library/Homebrew/services/cli.rb

# typed: true # rubocop:todo Sorbet/StrictSigil
# frozen_string_literal: true

require "services/formula_wrapper"
require "fileutils"

module Homebrew
  module Services
    module Cli
      extend FileUtils

      sig { returns(T.nilable(String)) }
      def self.sudo_service_user
        @sudo_service_user
      end

      sig { params(sudo_service_user: String).void }
      def self.sudo_service_user=(sudo_service_user)
        @sudo_service_user = sudo_service_user
      end

      # Binary name.
      sig { returns(String) }
      def self.bin
        "brew services"
      end

      # Find all currently running services via launchctl list or systemctl list-units.
      sig { returns(T::Array[String]) }
      def self.running
        if System.launchctl?
          Utils.popen_read(System.launchctl, "list")
        else
          System::Systemctl.popen_read("list-units",
                                       "--type=service",
                                       "--state=running",
                                       "--no-pager",
                                       "--no-legend")
        end.chomp.split("\n").filter_map do |svc|
          Regexp.last_match(0) if svc =~ /homebrew(?>\.mxcl)?\.([\w+-.@]+)/
        end
      end

      # Check if formula has been found.
      def self.check(targets)
        raise UsageError, "Formula(e) missing, please provide a formula name or use --all" if targets.empty?

        true
      end

      # Kill services that don't have a service file
      def self.kill_orphaned_services
        cleaned_labels = []
        cleaned_services = []
        running.each do |label|
          if (service = FormulaWrapper.from(label))
            unless service.dest.file?
              cleaned_labels << label
              cleaned_services << service
            end
          else
            opoo "Service #{label} not managed by `#{bin}` => skipping"
          end
        end
        kill(cleaned_services)
        cleaned_labels
      end

      def self.remove_unused_service_files
        cleaned = []
        Dir["#{System.path}homebrew.*.{plist,service}"].each do |file|
          next if running.include?(File.basename(file).sub(/\.(plist|service)$/i, ""))

          puts "Removing unused service file #{file}"
          rm file
          cleaned << file
        end

        cleaned
      end

      # Run a service as defined in the formula. This does not clean the service file like `start` does.
      sig {
        params(
          targets:      T::Array[Services::FormulaWrapper],
          service_file: T.nilable(String),
          verbose:      T::Boolean,
        ).void
      }
      def self.run(targets, service_file = nil, verbose: false)
        if service_file.present?
          file = Pathname.new service_file
          raise UsageError, "Provided service file does not exist" unless file.exist?
        end

        targets.each do |service|
          if service.pid?
            puts "Service `#{service.name}` already running, use `#{bin} restart #{service.name}` to restart."
            next
          elsif System.root?
            puts "Service `#{service.name}` cannot be run (but can be started) as root."
            next
          end

          service_load(service, file, enable: false)
        end
      end

      # Start a service.
      sig {
        params(
          targets:      T::Array[Services::FormulaWrapper],
          service_file: T.nilable(String),
          verbose:      T::Boolean,
        ).void
      }
      def self.start(targets, service_file = nil, verbose: false)
        file = T.let(nil, T.nilable(Pathname))

        if service_file.present?
          file = Pathname.new service_file
          raise UsageError, "Provided service file does not exist" unless file.exist?
        end

        targets.each do |service|
          if service.pid?
            puts "Service `#{service.name}` already started, use `#{bin} restart #{service.name}` to restart."
            next
          end

          odie "Formula `#{service.name}` is not installed." unless service.installed?

          file ||= if service.service_file.exist? || System.systemctl?
            nil
          elsif service.formula.opt_prefix.exist? &&
                (keg = Keg.for service.formula.opt_prefix) &&
                keg.plist_installed?
            service_file = Dir["#{keg}/*#{service.service_file.extname}"].first
            Pathname.new service_file if service_file.present?
          end

          install_service_file(service, file)

          if file.blank? && verbose
            ohai "Generated service file for #{service.formula.name}:"
            puts "   #{service.dest.read.gsub("\n", "\n   ")}"
            puts
          end

          next if take_root_ownership(service).nil? && System.root?

          service_load(service, nil, enable: true)
        end
      end

      # Stop a service and unload it.
      sig {
        params(
          targets:  T::Array[Services::FormulaWrapper],
          verbose:  T::Boolean,
          no_wait:  T::Boolean,
          max_wait: T.nilable(T.any(Integer, Float)),
          keep:     T::Boolean,
        ).void
      }
      def self.stop(targets, verbose: false, no_wait: false, max_wait: 0, keep: false)
        targets.each do |service|
          unless service.loaded?
            rm service.dest if !keep && service.dest.exist? # get rid of installed service file anyway, dude
            if service.service_file_present?
              odie <<~EOS
                Service `#{service.name}` is started as `#{service.owner}`. Try:
                  #{"sudo " unless System.root?}#{bin} stop #{service.name}
              EOS
            elsif System.launchctl? &&
                  quiet_system(System.launchctl, "bootout", "#{System.domain_target}/#{service.service_name}")
              ohai "Successfully stopped `#{service.name}` (label: #{service.service_name})"
            else
              opoo "Service `#{service.name}` is not started."
            end
            next
          end

          systemctl_args = []
          if no_wait
            systemctl_args << "--no-block"
            puts "Stopping `#{service.name}`..."
          else
            puts "Stopping `#{service.name}`... (might take a while)"
          end

          if System.systemctl?
            if keep
              System::Systemctl.quiet_run(*systemctl_args, "stop", service.service_name)
            else
              System::Systemctl.quiet_run(*systemctl_args, "disable", "--now", service.service_name)
            end
          elsif System.launchctl?
            quiet_system System.launchctl, "bootout", "#{System.domain_target}/#{service.service_name}"
            unless no_wait
              time_slept = 0
              sleep_time = 1
              max_wait = T.must(max_wait)
              while ($CHILD_STATUS.to_i == 9216 || service.loaded?) && (max_wait.zero? || time_slept < max_wait)
                sleep(sleep_time)
                time_slept += sleep_time
                quiet_system System.launchctl, "bootout", "#{System.domain_target}/#{service.service_name}"
              end
            end
            quiet_system System.launchctl, "stop", "#{System.domain_target}/#{service.service_name}" if service.pid?
          end

          unless keep
            rm service.dest if service.dest.exist?
            # Run daemon-reload on systemctl to finish unloading stopped and deleted service.
            System::Systemctl.run(*systemctl_args, "daemon-reload") if System.systemctl?
          end

          if service.pid? || service.loaded?
            opoo "Unable to stop `#{service.name}` (label: #{service.service_name})"
          else
            ohai "Successfully stopped `#{service.name}` (label: #{service.service_name})"
          end
        end
      end

      # Stop a service but keep it registered.
      sig { params(targets: T::Array[Services::FormulaWrapper], verbose: T::Boolean).void }
      def self.kill(targets, verbose: false)
        targets.each do |service|
          if !service.pid?
            puts "Service `#{service.name}` is not started."
          elsif service.keep_alive?
            puts "Service `#{service.name}` is set to automatically restart and can't be killed."
          else
            puts "Killing `#{service.name}`... (might take a while)"
            if System.systemctl?
              System::Systemctl.quiet_run("stop", service.service_name)
            elsif System.launchctl?
              quiet_system System.launchctl, "stop", "#{System.domain_target}/#{service.service_name}"
            end

            if service.pid?
              opoo "Unable to kill `#{service.name}` (label: #{service.service_name})"
            else
              ohai "Successfully killed `#{service.name}` (label: #{service.service_name})"
            end
          end
        end
      end

      # protections to avoid users editing root services
      def self.take_root_ownership(service)
        return unless System.root?
        return if sudo_service_user

        root_paths = T.let([], T::Array[Pathname])

        if System.systemctl?
          group = "root"
        elsif System.launchctl?
          group = "admin"
          chown "root", group, service.dest
          plist_data = service.dest.read
          plist = begin
            Plist.parse_xml(plist_data, marshal: false)
          rescue
            nil
          end
          return unless plist

          program_location = plist["ProgramArguments"]&.first
          key = "first ProgramArguments value"
          if program_location.blank?
            program_location = plist["Program"]
            key = "Program"
          end

          if program_location.present?
            Dir.chdir("/") do
              if File.exist?(program_location)
                program_location_path = Pathname(program_location).realpath
                root_paths += [
                  program_location_path,
                  program_location_path.parent.realpath,
                ]
              else
                opoo <<~EOS
                  #{service.name}: the #{key} does not exist:
                    #{program_location}
                EOS
              end
            end
          end
        end

        if (formula = service.formula)
          root_paths += [
            formula.opt_prefix,
            formula.linked_keg,
            formula.bin,
            formula.sbin,
          ]
        end
        root_paths = root_paths.sort.uniq.select(&:exist?)

        opoo <<~EOS
          Taking root:#{group} ownership of some #{service.formula} paths:
            #{root_paths.join("\n  ")}
          This will require manual removal of these paths using `sudo rm` on
          brew upgrade/reinstall/uninstall.
        EOS
        chown "root", group, root_paths
        chmod "+t", root_paths
      end

      sig {
        params(
          service: Services::FormulaWrapper,
          file:    T.nilable(T.any(String, Pathname)),
          enable:  T::Boolean,
        ).void
      }
      def self.launchctl_load(service, file:, enable:)
        safe_system System.launchctl, "enable", "#{System.domain_target}/#{service.service_name}" if enable
        safe_system System.launchctl, "bootstrap", System.domain_target, file
      end

      sig { params(service: Services::FormulaWrapper, enable: T::Boolean).void }
      def self.systemd_load(service, enable:)
        System::Systemctl.run("start", service.service_name)
        System::Systemctl.run("enable", service.service_name) if enable
      end

      sig { params(service: Services::FormulaWrapper, file: T.nilable(Pathname), enable: T::Boolean).void }
      def self.service_load(service, file, enable:)
        if System.root? && !service.service_startup?
          opoo "#{service.name} must be run as non-root to start at user login!"
        elsif !System.root? && service.service_startup?
          opoo "#{service.name} must be run as root to start at system startup!"
        end

        if System.launchctl?
          file ||= enable ? service.dest : service.service_file
          launchctl_load(service, file:, enable:)
        elsif System.systemctl?
          # Systemctl loads based upon location so only install service
          # file when it is not installed. Used with the `run` command.
          install_service_file(service, file) unless service.dest.exist?
          systemd_load(service, enable:)
        end

        function = enable ? "started" : "ran"
        ohai("Successfully #{function} `#{service.name}` (label: #{service.service_name})")
      end

      def self.install_service_file(service, file)
        raise UsageError, "Formula `#{service.name}` is not installed" unless service.installed?

        unless service.service_file.exist?
          raise UsageError,
                "Formula `#{service.name}` has not implemented #plist, #service or installed a locatable service file"
        end

        temp = Tempfile.new(service.service_name)
        temp << if file.blank?
          contents = service.service_file.read

          if sudo_service_user && System.launchctl?
            # set the username in the new plist file
            ohai "Setting username in #{service.service_name} to #{System.user}"
            plist_data = Plist.parse_xml(contents, marshal: false)
            plist_data["UserName"] = sudo_service_user
            plist_data.to_plist
          else
            contents
          end
        else
          file.read
        end
        temp.flush

        rm service.dest if service.dest.exist?
        service.dest_dir.mkpath unless service.dest_dir.directory?
        cp T.must(temp.path), service.dest

        # Clear tempfile.
        temp.close

        chmod 0644, service.dest

        System::Systemctl.run("daemon-reload") if System.systemctl?
      end
    end
  end
end