[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Upgrader API: Automatic_Upgrader_Skin class
   4   *
   5   * @package WordPress
   6   * @subpackage Upgrader
   7   * @since 4.6.0
   8   */
   9  
  10  /**
  11   * Upgrader Skin for Automatic WordPress Upgrades
  12   *
  13   * This skin is designed to be used when no output is intended, all output
  14   * is captured and stored for the caller to process and log/email/discard.
  15   *
  16   * @since 3.7.0
  17   * @since 4.6.0 Moved to its own file from wp-admin/includes/class-wp-upgrader-skins.php.
  18   *
  19   * @see Bulk_Upgrader_Skin
  20   */
  21  class Automatic_Upgrader_Skin extends WP_Upgrader_Skin {
  22      protected $messages = array();
  23  
  24      /**
  25       * Determines whether the upgrader needs FTP/SSH details in order to connect
  26       * to the filesystem.
  27       *
  28       * @since 3.7.0
  29       * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
  30       *
  31       * @see request_filesystem_credentials()
  32       *
  33       * @param bool|WP_Error $error                        Optional. Whether the current request has failed to connect,
  34       *                                                    or an error object. Default false.
  35       * @param string        $context                      Optional. Full path to the directory that is tested
  36       *                                                    for being writable. Default empty.
  37       * @param bool          $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
  38       * @return bool True on success, false on failure.
  39       */
  40  	public function request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false ) {
  41          if ( $context ) {
  42              $this->options['context'] = $context;
  43          }
  44          // TODO: fix up request_filesystem_credentials(), or split it, to allow us to request a no-output version
  45          // This will output a credentials form in event of failure, We don't want that, so just hide with a buffer
  46          ob_start();
  47          $result = parent::request_filesystem_credentials( $error, $context, $allow_relaxed_file_ownership );
  48          ob_end_clean();
  49          return $result;
  50      }
  51  
  52      /**
  53       * @return array
  54       */
  55  	public function get_upgrade_messages() {
  56          return $this->messages;
  57      }
  58  
  59      /**
  60       * @param string|array|WP_Error $data
  61       * @param mixed                 ...$args Optional text replacements.
  62       */
  63  	public function feedback( $data, ...$args ) {
  64          if ( is_wp_error( $data ) ) {
  65              $string = $data->get_error_message();
  66          } elseif ( is_array( $data ) ) {
  67              return;
  68          } else {
  69              $string = $data;
  70          }
  71          if ( ! empty( $this->upgrader->strings[ $string ] ) ) {
  72              $string = $this->upgrader->strings[ $string ];
  73          }
  74  
  75          if ( strpos( $string, '%' ) !== false ) {
  76              if ( ! empty( $args ) ) {
  77                  $string = vsprintf( $string, $args );
  78              }
  79          }
  80  
  81          $string = trim( $string );
  82  
  83          // Only allow basic HTML in the messages, as it'll be used in emails/logs rather than direct browser output.
  84          $string = wp_kses(
  85              $string,
  86              array(
  87                  'a'      => array(
  88                      'href' => true,
  89                  ),
  90                  'br'     => true,
  91                  'em'     => true,
  92                  'strong' => true,
  93              )
  94          );
  95  
  96          if ( empty( $string ) ) {
  97              return;
  98          }
  99  
 100          $this->messages[] = $string;
 101      }
 102  
 103      /**
 104       */
 105  	public function header() {
 106          ob_start();
 107      }
 108  
 109      /**
 110       */
 111  	public function footer() {
 112          $output = ob_get_clean();
 113          if ( ! empty( $output ) ) {
 114              $this->feedback( $output );
 115          }
 116      }
 117  }