g1a / hubph

src/Util/ExecWithRedactionTrait.php

<?php
namespace Hubph\Util;

trait ExecWithRedactionTrait
{
    protected function execWithRedaction($cmd, $replacements = [], $redacted = [])
    {
        $redactedReplacements = $this->redactedReplacements($replacements, $redacted);
        $redactions = $this->redactions($redactedReplacements, $replacements);
        $redactedCommand = $this->interpolate($cmd, $redactedReplacements + $replacements);
        $command = $this->interpolate("$cmd{redactions}", ['redactions' => $redactions] + $replacements);

        if (isset($this->logger)) {
            $this->logger->notice('Executing {command}', ['command' => $redactedCommand]);

The property logger does not exist. Did you maybe forget to declare it?

        }
        exec($command, $output, $result);
        if ($result != 0) {

It seems like you are loosely comparing $result of type integer|null to 0; this is ambiguous as not only 0 == 0 is true, but null == 0 is true, too. Consider using a strict comparison ===.

            throw new \Exception("Command `$redactedCommand` failed with exit code $result");
        }
        return $output;
    }

    private function redactedReplacements($replacements, $redacted)

The parameter $replacements is not used and could be removed.

    {
        $result = [];
        foreach ($redacted as $key => $value) {
            if (is_numeric($key)) {
                $result[$value] = '[REDACTED]';
            } else {
                $result[$key] = $value;
            }
        }
        return $result;
    }

    private function redactions($redactedReplacements, $replacements)
    {
        if (empty($redactedReplacements)) {
            return '';
        }

        // Make a simple array (with numeric keys) whose values
        // are the values of the items in $replacements whose keys
        // appear in $redactedReplacements.
        $values = array_map(
            function ($item) use ($replacements) {
                return $replacements[$item];
            },
            array_keys($redactedReplacements)
        );

        // If any redacted value contains a # or a ', then simply turn off output
        if ($this->unsafe($values)) {
            return ' >/dev/null 2>&1';
        }

        // Create 'sed' expressions to replace the redactions.
        $redactions = array_map(
            function ($value) {
                return "-e 's#$value#[REDACTED]#'";
            },
            $values
        );

        return ' 2>&1 | sed ' . implode(' ', $redactions);
    }

    private function unsafe($values)
    {
        foreach ($values as $value) {
            if ((strpos($value, "'") !== false) || (strpos($value, "#") !== false)) {
                return true;
            }
        }
        return false;
    }

    private function interpolate($str, array $context)
    {
        // build a replacement array with braces around the context keys
        $replace = array();
        foreach ($context as $key => $val) {
            if (!is_array($val) && (!is_object($val) || method_exists($val, '__toString'))) {
                $replace[sprintf('{%s}', $key)] = $val;
            }
        }

        // interpolate replacement values into the message and return
        return strtr($str, $replace);
    }
}