wp/wp-admin/includes/class-wp-filesystem-ftpsockets.php
changeset 7 cf61fcea0001
parent 5 5e2f62d02dcd
child 9 177826044cd9
--- a/wp/wp-admin/includes/class-wp-filesystem-ftpsockets.php	Tue Jun 09 11:14:17 2015 +0000
+++ b/wp/wp-admin/includes/class-wp-filesystem-ftpsockets.php	Mon Oct 14 17:39:30 2019 +0200
@@ -10,9 +10,8 @@
  * WordPress Filesystem Class for implementing FTP Sockets.
  *
  * @since 2.5.0
- * @package WordPress
- * @subpackage Filesystem
- * @uses WP_Filesystem_Base Extends class
+ *
+ * @see WP_Filesystem_Base
  */
 class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
 	/**
@@ -20,7 +19,11 @@
 	 */
 	public $ftp;
 
-	public function __construct($opt = '') {
+	/**
+	 *
+	 * @param array $opt
+	 */
+	public function __construct( $opt  = '' ) {
 		$this->method = 'ftpsockets';
 		$this->errors = new WP_Error();
 
@@ -33,7 +36,7 @@
 		if ( empty($opt['port']) )
 			$this->options['port'] = 21;
 		else
-			$this->options['port'] = $opt['port'];
+			$this->options['port'] = (int) $opt['port'];
 
 		if ( empty($opt['hostname']) )
 			$this->errors->add('empty_hostname', __('FTP hostname is required'));
@@ -52,24 +55,43 @@
 			$this->options['password'] = $opt['password'];
 	}
 
+	/**
+	 *
+	 * @return bool
+	 */
 	public function connect() {
 		if ( ! $this->ftp )
 			return false;
 
 		$this->ftp->setTimeout(FS_CONNECT_TIMEOUT);
 
-		if ( ! $this->ftp->SetServer($this->options['hostname'], $this->options['port']) ) {
-			$this->errors->add('connect', sprintf(__('Failed to connect to FTP Server %1$s:%2$s'), $this->options['hostname'], $this->options['port']));
+		if ( ! $this->ftp->SetServer( $this->options['hostname'], $this->options['port'] ) ) {
+			$this->errors->add( 'connect',
+				/* translators: %s: hostname:port */
+				sprintf( __( 'Failed to connect to FTP Server %s' ),
+					$this->options['hostname'] . ':' . $this->options['port']
+				)
+			);
 			return false;
 		}
 
 		if ( ! $this->ftp->connect() ) {
-			$this->errors->add('connect', sprintf(__('Failed to connect to FTP Server %1$s:%2$s'), $this->options['hostname'], $this->options['port']));
+			$this->errors->add( 'connect',
+				/* translators: %s: hostname:port */
+				sprintf( __( 'Failed to connect to FTP Server %s' ),
+					$this->options['hostname'] . ':' . $this->options['port']
+				)
+			);
 			return false;
 		}
 
-		if ( ! $this->ftp->login($this->options['username'], $this->options['password']) ) {
-			$this->errors->add('auth', sprintf(__('Username/Password incorrect for %s'), $this->options['username']));
+		if ( ! $this->ftp->login( $this->options['username'], $this->options['password'] ) ) {
+			$this->errors->add( 'auth',
+				/* translators: %s: username */
+				sprintf( __( 'Username/Password incorrect for %s' ),
+					$this->options['username']
+				)
+			);
 			return false;
 		}
 
@@ -80,8 +102,13 @@
 	}
 
 	/**
-	 * @param string $file
-	 * @return false|string
+	 * Retrieves the file contents.
+	 *
+	 * @since 2.5.0
+	 *
+	 * @param string $file Filename.
+	 * @return string|false File contents on success, false if no temp file could be opened,
+	 *                      or if the file doesn't exist.
 	 */
 	public function get_contents( $file ) {
 		if ( ! $this->exists($file) )
@@ -89,8 +116,10 @@
 
 		$temp = wp_tempnam( $file );
 
-		if ( ! $temphandle = fopen($temp, 'w+') )
+		if ( ! $temphandle = fopen( $temp, 'w+' ) ) {
+			unlink( $temp );
 			return false;
+		}
 
 		mbstring_binary_safe_encoding();
 
@@ -115,7 +144,9 @@
 		unlink($temp);
 		return $contents;
 	}
+
 	/**
+	 *
 	 * @param string $file
 	 * @return array
 	 */
@@ -124,6 +155,7 @@
 	}
 
 	/**
+	 *
 	 * @param string $file
 	 * @param string $contents
 	 * @param int|bool $mode
@@ -163,6 +195,10 @@
 		return $ret;
 	}
 
+	/**
+	 *
+	 * @return string
+	 */
 	public function cwd() {
 		$cwd = $this->ftp->pwd();
 		if ( $cwd )
@@ -170,11 +206,17 @@
 		return $cwd;
 	}
 
+	/**
+	 *
+	 * @param string $file
+	 * @return bool
+	 */
 	public function chdir($file) {
 		return $this->ftp->chdir($file);
 	}
 
 	/**
+	 *
 	 * @param string $file
 	 * @param int|bool $mode
 	 * @param bool $recursive
@@ -202,6 +244,7 @@
 	}
 
 	/**
+	 *
 	 * @param string $file
 	 * @return string
 	 */
@@ -209,7 +252,9 @@
 		$dir = $this->dirlist($file);
 		return $dir[$file]['owner'];
 	}
+
 	/**
+	 *
 	 * @param string $file
 	 * @return string
 	 */
@@ -217,7 +262,9 @@
 		$dir = $this->dirlist($file);
 		return $dir[$file]['permsn'];
 	}
+
 	/**
+	 *
 	 * @param string $file
 	 * @return string
 	 */
@@ -225,10 +272,12 @@
 		$dir = $this->dirlist($file);
 		return $dir[$file]['group'];
 	}
+
 	/**
-	 * @param string $source
-	 * @param string $destination
-	 * @param bool $overwrite
+	 *
+	 * @param string   $source
+	 * @param string   $destination
+	 * @param bool     $overwrite
 	 * @param int|bool $mode
 	 * @return bool
 	 */
@@ -242,18 +291,22 @@
 
 		return $this->put_contents($destination, $content, $mode);
 	}
+
 	/**
+	 *
 	 * @param string $source
 	 * @param string $destination
-	 * @param bool $overwrite
+	 * @param bool   $overwrite
 	 * @return bool
 	 */
 	public function move($source, $destination, $overwrite = false ) {
 		return $this->ftp->rename($source, $destination);
 	}
+
 	/**
+	 *
 	 * @param string $file
-	 * @param bool $recursive
+	 * @param bool   $recursive
 	 * @param string $type
 	 * @return bool
 	 */
@@ -269,6 +322,7 @@
 	}
 
 	/**
+	 *
 	 * @param string $file
 	 * @return bool
 	 */
@@ -284,6 +338,7 @@
 	}
 
 	/**
+	 *
 	 * @param string $file
 	 * @return bool
 	 */
@@ -296,6 +351,7 @@
 	}
 
 	/**
+	 *
 	 * @param string $path
 	 * @return bool
 	 */
@@ -309,6 +365,7 @@
 	}
 
 	/**
+	 *
 	 * @param string $file
 	 * @return bool
 	 */
@@ -317,6 +374,7 @@
 	}
 
 	/**
+	 *
 	 * @param string $file
 	 * @return bool
 	 */
@@ -325,6 +383,7 @@
 	}
 
 	/**
+	 *
 	 * @param string $file
 	 * @return bool
 	 */
@@ -333,6 +392,7 @@
 	}
 
 	/**
+	 *
 	 * @param string $file
 	 * @return int
 	 */
@@ -347,7 +407,9 @@
 	public function size($file) {
 		return $this->ftp->filesize($file);
 	}
+
 	/**
+	 *
 	 * @param string $file
 	 * @param int $time
 	 * @param int $atime
@@ -358,10 +420,11 @@
 	}
 
 	/**
+	 *
 	 * @param string $path
-	 * @param mixed $chmod
-	 * @param mixed $chown
-	 * @param mixed $chgrp
+	 * @param mixed  $chmod
+	 * @param mixed  $chown
+	 * @param mixed  $chgrp
 	 * @return bool
 	 */
 	public function mkdir($path, $chmod = false, $chown = false, $chgrp = false ) {
@@ -378,17 +441,20 @@
 	}
 
 	/**
-	 * @param sting $path
+	 *
+	 * @param string $path
 	 * @param bool $recursive
+	 * @return bool
 	 */
 	public function rmdir($path, $recursive = false ) {
-		$this->delete($path, $recursive);
+		return $this->delete($path, $recursive);
 	}
 
 	/**
+	 *
 	 * @param string $path
-	 * @param bool $include_hidden
-	 * @param bool $recursive
+	 * @param bool   $include_hidden
+	 * @param bool   $recursive
 	 * @return bool|array
 	 */
 	public function dirlist($path = '.', $include_hidden = true, $recursive = false ) {
@@ -432,6 +498,9 @@
 			if ( $struc['islink'] )
 				$struc['name'] = preg_replace( '/(\s*->\s*.*)$/', '', $struc['name'] );
 
+			// Add the Octal representation of the file permissions
+			$struc['permsn'] = $this->getnumchmodfromh( $struc['perms'] );
+
 			$ret[ $struc['name'] ] = $struc;
 		}
 
@@ -440,6 +509,8 @@
 		return $ret;
 	}
 
+	/**
+	 */
 	public function __destruct() {
 		$this->ftp->quit();
 	}