Merge branch 'mrrobot47-update-for-obfuscation' into develop-v4

Author: mbtamuli

php/class-ee.php

@@ -480,19 +480,20 @@ public static function remove_deferred_addition( $name ) {
 	}
 
 	/**
-	 * Display informational message without prefix, and ignore `--quiet`.
+	 * Display informational message without prefix.
 	 *
-	 * Message is written to STDOUT. `EE::log()` is typically recommended;
-	 * `EE::line()` is included for historical compat.
+	 * Should only be used for displaying sensitive info which should be skipped from log file.
+	 * `EE::log()` is typically recommended for everything else.
 	 *
-	 * @access public
+	 * @access   public
 	 * @category Output
 	 *
 	 * @param string $message Message to display to the end user.
+	 *
 	 * @return null
 	 */
 	public static function line( $message = '' ) {
-		echo $message . "\n";
+		self::$logger->info( $message );
 	}
 
 	/**
@@ -818,19 +819,21 @@ public static function error_to_string( $errors ) {
 	 * @access   public
 	 * @category Execution
 	 *
-	 * @param string  $command         External process to launch.
+	 * @param string $command          External process to launch.
 	 * @param boolean $exit_on_error   Whether to exit if the command returns an elevated return code.
 	 * @param boolean $return_detailed Whether to return an exit status (default) or detailed execution results.
-	 * @param array   $env             Environment variables to set when running the command.
-	 * @param string  $cwd             Directory to execute the command in.
+	 * @param array $obfuscate         Parts of the command that need to be obfuscated.
+	 * @param array $env               Environment variables to set when running the command.
+	 * @param string $cwd              Directory to execute the command in.
 	 *
 	 * @return int|ProcessRun The command exit status, or a ProcessRun object for full details.
 	 */
-	public static function launch( $command, $exit_on_error = false, $return_detailed = true, $env = null, $cwd = null ) {
+	public static function launch( $command, $exit_on_error = false, $return_detailed = true, $obfuscate = [], $env = null, $cwd = null ) {
 		Utils\check_proc_available( 'launch' );
 
+		$command_to_log = empty( $obfuscate ) ? $command : str_replace( $obfuscate, '******', $command );
 		self::debug( '-----------------------' );
-		self::debug( "COMMAND: $command" );
+		self::debug( "COMMAND: $command_to_log" );
 
 		$proc    = Process::create( $command, $cwd, $env );
 		$results = $proc->run();
@@ -858,18 +861,20 @@ public static function launch( $command, $exit_on_error = false, $return_detaile
 	 * @access   public
 	 * @category Execution
 	 *
-	 * @param string  $command       External process to launch.
-	 * @param bool    $echo_stdout   Print stdout to terminal. Default false.
-	 * @param bool    $echo_stderr   Print stderr to terminal. Default false.
+	 * @param string $command        External process to launch.
+	 * @param bool $echo_stdout      Print stdout to terminal. Default false.
+	 * @param bool $echo_stderr      Print stderr to terminal. Default false.
+	 * @param array $obfuscate       Parts of the command that need to be obfuscated.
 	 * @param boolean $exit_on_error Exit if the command returns an elevated return code with stderr.
 	 *
 	 * @return bool True if executed successfully. False if failed.
 	 */
-	public static function exec( $command, $echo_stdout = false, $echo_stderr = false, $exit_on_error = false ) {
+	public static function exec( $command, $echo_stdout = false, $echo_stderr = false, $obfuscate = [], $exit_on_error = false ) {
 		Utils\check_proc_available( 'exec' );
 
+		$command_to_log = empty( $obfuscate ) ? $command : str_replace( $obfuscate, '******', $command );
 		self::debug( '-----------------------' );
-		self::debug( "COMMAND: $command" );
+		self::debug( "COMMAND: $command_to_log" );
 
 		$proc    = Process::create( $command, null, null );
 		$results = $proc->run();

php/utils.php

@@ -1508,19 +1508,25 @@ function get_type( $assoc_args, $arg_types, $default = false ) {
  * # +------+--------+
  * ```
  *
- * @param array $items An array of items to output.
+ * @param array $items   An array of items to output.
+ * @param bool $log_data To log table in file or not.
  *
  */
-function format_table( $items ) {
+function format_table( $items, $log_in_file = false ) {
 	$item_table = new \cli\Table();
 	$item_table->setRows( $items );
 	$item_table->setRenderer( new \cli\table\Ascii() );
 	$lines = array_slice( $item_table->getDisplayLines(), 3 );
 	array_pop( $lines );
 	$delem = $item_table->getDisplayLines()[0];
 	foreach ( $lines as $line ) {
-		\EE::log( $delem );
-		\EE::log( $line );
+		if ( $log_in_file ) {
+			\EE::log( $delem );
+			\EE::log( $line );
+		} else {
+			\EE::line( $delem );
+			\EE::line( $line );
+		}
 	}
 	\EE::log( $delem );
 }