123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784 |
- <?php
- /**
- * WordPress FTP Filesystem.
- *
- * @package WordPress
- * @subpackage Filesystem
- */
- /**
- * WordPress Filesystem Class for implementing FTP.
- *
- * @since 2.5.0
- *
- * @see WP_Filesystem_Base
- */
- class WP_Filesystem_FTPext extends WP_Filesystem_Base {
- /**
- * @since 2.5.0
- * @var resource
- */
- public $link;
- /**
- * Constructor.
- *
- * @since 2.5.0
- *
- * @param array $opt
- */
- public function __construct( $opt = '' ) {
- $this->method = 'ftpext';
- $this->errors = new WP_Error();
- // Check if possible to use ftp functions.
- if ( ! extension_loaded( 'ftp' ) ) {
- $this->errors->add( 'no_ftp_ext', __( 'The ftp PHP extension is not available' ) );
- return;
- }
- // This class uses the timeout on a per-connection basis, others use it on a per-action basis.
- if ( ! defined( 'FS_TIMEOUT' ) ) {
- define( 'FS_TIMEOUT', 4 * MINUTE_IN_SECONDS );
- }
- if ( empty( $opt['port'] ) ) {
- $this->options['port'] = 21;
- } else {
- $this->options['port'] = $opt['port'];
- }
- if ( empty( $opt['hostname'] ) ) {
- $this->errors->add( 'empty_hostname', __( 'FTP hostname is required' ) );
- } else {
- $this->options['hostname'] = $opt['hostname'];
- }
- // Check if the options provided are OK.
- if ( empty( $opt['username'] ) ) {
- $this->errors->add( 'empty_username', __( 'FTP username is required' ) );
- } else {
- $this->options['username'] = $opt['username'];
- }
- if ( empty( $opt['password'] ) ) {
- $this->errors->add( 'empty_password', __( 'FTP password is required' ) );
- } else {
- $this->options['password'] = $opt['password'];
- }
- $this->options['ssl'] = false;
- if ( isset( $opt['connection_type'] ) && 'ftps' === $opt['connection_type'] ) {
- $this->options['ssl'] = true;
- }
- }
- /**
- * Connects filesystem.
- *
- * @since 2.5.0
- *
- * @return bool True on success, false on failure.
- */
- public function connect() {
- if ( isset( $this->options['ssl'] ) && $this->options['ssl'] && function_exists( 'ftp_ssl_connect' ) ) {
- $this->link = @ftp_ssl_connect( $this->options['hostname'], $this->options['port'], FS_CONNECT_TIMEOUT );
- } else {
- $this->link = @ftp_connect( $this->options['hostname'], $this->options['port'], FS_CONNECT_TIMEOUT );
- }
- if ( ! $this->link ) {
- $this->errors->add(
- 'connect',
- sprintf(
- /* translators: %s: hostname:port */
- __( 'Failed to connect to FTP Server %s' ),
- $this->options['hostname'] . ':' . $this->options['port']
- )
- );
- return false;
- }
- if ( ! @ftp_login( $this->link, $this->options['username'], $this->options['password'] ) ) {
- $this->errors->add(
- 'auth',
- sprintf(
- /* translators: %s: Username. */
- __( 'Username/Password incorrect for %s' ),
- $this->options['username']
- )
- );
- return false;
- }
- // Set the connection to use Passive FTP.
- ftp_pasv( $this->link, true );
- if ( @ftp_get_option( $this->link, FTP_TIMEOUT_SEC ) < FS_TIMEOUT ) {
- @ftp_set_option( $this->link, FTP_TIMEOUT_SEC, FS_TIMEOUT );
- }
- return true;
- }
- /**
- * Reads entire file into a string.
- *
- * @since 2.5.0
- *
- * @param string $file Name of the file to read.
- * @return string|false Read data on success, false if no temporary file could be opened,
- * or if the file couldn't be retrieved.
- */
- public function get_contents( $file ) {
- $tempfile = wp_tempnam( $file );
- $temphandle = fopen( $tempfile, 'w+' );
- if ( ! $temphandle ) {
- unlink( $tempfile );
- return false;
- }
- if ( ! ftp_fget( $this->link, $temphandle, $file, FTP_BINARY ) ) {
- fclose( $temphandle );
- unlink( $tempfile );
- return false;
- }
- fseek( $temphandle, 0 ); // Skip back to the start of the file being written to.
- $contents = '';
- while ( ! feof( $temphandle ) ) {
- $contents .= fread( $temphandle, 8 * KB_IN_BYTES );
- }
- fclose( $temphandle );
- unlink( $tempfile );
- return $contents;
- }
- /**
- * Reads entire file into an array.
- *
- * @since 2.5.0
- *
- * @param string $file Path to the file.
- * @return array|false File contents in an array on success, false on failure.
- */
- public function get_contents_array( $file ) {
- return explode( "\n", $this->get_contents( $file ) );
- }
- /**
- * Writes a string to a file.
- *
- * @since 2.5.0
- *
- * @param string $file Remote path to the file where to write the data.
- * @param string $contents The data to write.
- * @param int|false $mode Optional. The file permissions as octal number, usually 0644.
- * Default false.
- * @return bool True on success, false on failure.
- */
- public function put_contents( $file, $contents, $mode = false ) {
- $tempfile = wp_tempnam( $file );
- $temphandle = fopen( $tempfile, 'wb+' );
- if ( ! $temphandle ) {
- unlink( $tempfile );
- return false;
- }
- mbstring_binary_safe_encoding();
- $data_length = strlen( $contents );
- $bytes_written = fwrite( $temphandle, $contents );
- reset_mbstring_encoding();
- if ( $data_length !== $bytes_written ) {
- fclose( $temphandle );
- unlink( $tempfile );
- return false;
- }
- fseek( $temphandle, 0 ); // Skip back to the start of the file being written to.
- $ret = ftp_fput( $this->link, $file, $temphandle, FTP_BINARY );
- fclose( $temphandle );
- unlink( $tempfile );
- $this->chmod( $file, $mode );
- return $ret;
- }
- /**
- * Gets the current working directory.
- *
- * @since 2.5.0
- *
- * @return string|false The current working directory on success, false on failure.
- */
- public function cwd() {
- $cwd = ftp_pwd( $this->link );
- if ( $cwd ) {
- $cwd = trailingslashit( $cwd );
- }
- return $cwd;
- }
- /**
- * Changes current directory.
- *
- * @since 2.5.0
- *
- * @param string $dir The new current directory.
- * @return bool True on success, false on failure.
- */
- public function chdir( $dir ) {
- return @ftp_chdir( $this->link, $dir );
- }
- /**
- * Changes filesystem permissions.
- *
- * @since 2.5.0
- *
- * @param string $file Path to the file.
- * @param int|false $mode Optional. The permissions as octal number, usually 0644 for files,
- * 0755 for directories. Default false.
- * @param bool $recursive Optional. If set to true, changes file permissions recursively.
- * Default false.
- * @return bool True on success, false on failure.
- */
- public function chmod( $file, $mode = false, $recursive = false ) {
- if ( ! $mode ) {
- if ( $this->is_file( $file ) ) {
- $mode = FS_CHMOD_FILE;
- } elseif ( $this->is_dir( $file ) ) {
- $mode = FS_CHMOD_DIR;
- } else {
- return false;
- }
- }
- // chmod any sub-objects if recursive.
- if ( $recursive && $this->is_dir( $file ) ) {
- $filelist = $this->dirlist( $file );
- foreach ( (array) $filelist as $filename => $filemeta ) {
- $this->chmod( $file . '/' . $filename, $mode, $recursive );
- }
- }
- // chmod the file or directory.
- if ( ! function_exists( 'ftp_chmod' ) ) {
- return (bool) ftp_site( $this->link, sprintf( 'CHMOD %o %s', $mode, $file ) );
- }
- return (bool) ftp_chmod( $this->link, $mode, $file );
- }
- /**
- * Gets the file owner.
- *
- * @since 2.5.0
- *
- * @param string $file Path to the file.
- * @return string|false Username of the owner on success, false on failure.
- */
- public function owner( $file ) {
- $dir = $this->dirlist( $file );
- return $dir[ $file ]['owner'];
- }
- /**
- * Gets the permissions of the specified file or filepath in their octal format.
- *
- * @since 2.5.0
- *
- * @param string $file Path to the file.
- * @return string Mode of the file (the last 3 digits).
- */
- public function getchmod( $file ) {
- $dir = $this->dirlist( $file );
- return $dir[ $file ]['permsn'];
- }
- /**
- * Gets the file's group.
- *
- * @since 2.5.0
- *
- * @param string $file Path to the file.
- * @return string|false The group on success, false on failure.
- */
- public function group( $file ) {
- $dir = $this->dirlist( $file );
- return $dir[ $file ]['group'];
- }
- /**
- * Copies a file.
- *
- * @since 2.5.0
- *
- * @param string $source Path to the source file.
- * @param string $destination Path to the destination file.
- * @param bool $overwrite Optional. Whether to overwrite the destination file if it exists.
- * Default false.
- * @param int|false $mode Optional. The permissions as octal number, usually 0644 for files,
- * 0755 for dirs. Default false.
- * @return bool True on success, false on failure.
- */
- public function copy( $source, $destination, $overwrite = false, $mode = false ) {
- if ( ! $overwrite && $this->exists( $destination ) ) {
- return false;
- }
- $content = $this->get_contents( $source );
- if ( false === $content ) {
- return false;
- }
- return $this->put_contents( $destination, $content, $mode );
- }
- /**
- * Moves a file.
- *
- * @since 2.5.0
- *
- * @param string $source Path to the source file.
- * @param string $destination Path to the destination file.
- * @param bool $overwrite Optional. Whether to overwrite the destination file if it exists.
- * Default false.
- * @return bool True on success, false on failure.
- */
- public function move( $source, $destination, $overwrite = false ) {
- return ftp_rename( $this->link, $source, $destination );
- }
- /**
- * Deletes a file or directory.
- *
- * @since 2.5.0
- *
- * @param string $file Path to the file or directory.
- * @param bool $recursive Optional. If set to true, deletes files and folders recursively.
- * Default false.
- * @param string|false $type Type of resource. 'f' for file, 'd' for directory.
- * Default false.
- * @return bool True on success, false on failure.
- */
- public function delete( $file, $recursive = false, $type = false ) {
- if ( empty( $file ) ) {
- return false;
- }
- if ( 'f' === $type || $this->is_file( $file ) ) {
- return ftp_delete( $this->link, $file );
- }
- if ( ! $recursive ) {
- return ftp_rmdir( $this->link, $file );
- }
- $filelist = $this->dirlist( trailingslashit( $file ) );
- if ( ! empty( $filelist ) ) {
- foreach ( $filelist as $delete_file ) {
- $this->delete( trailingslashit( $file ) . $delete_file['name'], $recursive, $delete_file['type'] );
- }
- }
- return ftp_rmdir( $this->link, $file );
- }
- /**
- * Checks if a file or directory exists.
- *
- * @since 2.5.0
- *
- * @param string $path Path to file or directory.
- * @return bool Whether $path exists or not.
- */
- public function exists( $path ) {
- $list = ftp_nlist( $this->link, $path );
- if ( empty( $list ) && $this->is_dir( $path ) ) {
- return true; // File is an empty directory.
- }
- return ! empty( $list ); // Empty list = no file, so invert.
- }
- /**
- * Checks if resource is a file.
- *
- * @since 2.5.0
- *
- * @param string $file File path.
- * @return bool Whether $file is a file.
- */
- public function is_file( $file ) {
- return $this->exists( $file ) && ! $this->is_dir( $file );
- }
- /**
- * Checks if resource is a directory.
- *
- * @since 2.5.0
- *
- * @param string $path Directory path.
- * @return bool Whether $path is a directory.
- */
- public function is_dir( $path ) {
- $cwd = $this->cwd();
- $result = @ftp_chdir( $this->link, trailingslashit( $path ) );
- if ( $result && $path === $this->cwd() || $this->cwd() !== $cwd ) {
- @ftp_chdir( $this->link, $cwd );
- return true;
- }
- return false;
- }
- /**
- * Checks if a file is readable.
- *
- * @since 2.5.0
- *
- * @param string $file Path to file.
- * @return bool Whether $file is readable.
- */
- public function is_readable( $file ) {
- return true;
- }
- /**
- * Checks if a file or directory is writable.
- *
- * @since 2.5.0
- *
- * @param string $path Path to file or directory.
- * @return bool Whether $path is writable.
- */
- public function is_writable( $path ) {
- return true;
- }
- /**
- * Gets the file's last access time.
- *
- * @since 2.5.0
- *
- * @param string $file Path to file.
- * @return int|false Unix timestamp representing last access time, false on failure.
- */
- public function atime( $file ) {
- return false;
- }
- /**
- * Gets the file modification time.
- *
- * @since 2.5.0
- *
- * @param string $file Path to file.
- * @return int|false Unix timestamp representing modification time, false on failure.
- */
- public function mtime( $file ) {
- return ftp_mdtm( $this->link, $file );
- }
- /**
- * Gets the file size (in bytes).
- *
- * @since 2.5.0
- *
- * @param string $file Path to file.
- * @return int|false Size of the file in bytes on success, false on failure.
- */
- public function size( $file ) {
- $size = ftp_size( $this->link, $file );
- return ( $size > -1 ) ? $size : false;
- }
- /**
- * Sets the access and modification times of a file.
- *
- * Note: If $file doesn't exist, it will be created.
- *
- * @since 2.5.0
- *
- * @param string $file Path to file.
- * @param int $time Optional. Modified time to set for file.
- * Default 0.
- * @param int $atime Optional. Access time to set for file.
- * Default 0.
- * @return bool True on success, false on failure.
- */
- public function touch( $file, $time = 0, $atime = 0 ) {
- return false;
- }
- /**
- * Creates a directory.
- *
- * @since 2.5.0
- *
- * @param string $path Path for new directory.
- * @param int|false $chmod Optional. The permissions as octal number (or false to skip chmod).
- * Default false.
- * @param string|int|false $chown Optional. A user name or number (or false to skip chown).
- * Default false.
- * @param string|int|false $chgrp Optional. A group name or number (or false to skip chgrp).
- * Default false.
- * @return bool True on success, false on failure.
- */
- public function mkdir( $path, $chmod = false, $chown = false, $chgrp = false ) {
- $path = untrailingslashit( $path );
- if ( empty( $path ) ) {
- return false;
- }
- if ( ! ftp_mkdir( $this->link, $path ) ) {
- return false;
- }
- $this->chmod( $path, $chmod );
- return true;
- }
- /**
- * Deletes a directory.
- *
- * @since 2.5.0
- *
- * @param string $path Path to directory.
- * @param bool $recursive Optional. Whether to recursively remove files/directories.
- * Default false.
- * @return bool True on success, false on failure.
- */
- public function rmdir( $path, $recursive = false ) {
- return $this->delete( $path, $recursive );
- }
- /**
- * @param string $line
- * @return array
- */
- public function parselisting( $line ) {
- static $is_windows = null;
- if ( is_null( $is_windows ) ) {
- $is_windows = stripos( ftp_systype( $this->link ), 'win' ) !== false;
- }
- if ( $is_windows && preg_match( '/([0-9]{2})-([0-9]{2})-([0-9]{2}) +([0-9]{2}):([0-9]{2})(AM|PM) +([0-9]+|<DIR>) +(.+)/', $line, $lucifer ) ) {
- $b = array();
- if ( $lucifer[3] < 70 ) {
- $lucifer[3] += 2000;
- } else {
- $lucifer[3] += 1900; // 4-digit year fix.
- }
- $b['isdir'] = ( '<DIR>' === $lucifer[7] );
- if ( $b['isdir'] ) {
- $b['type'] = 'd';
- } else {
- $b['type'] = 'f';
- }
- $b['size'] = $lucifer[7];
- $b['month'] = $lucifer[1];
- $b['day'] = $lucifer[2];
- $b['year'] = $lucifer[3];
- $b['hour'] = $lucifer[4];
- $b['minute'] = $lucifer[5];
- $b['time'] = mktime( $lucifer[4] + ( strcasecmp( $lucifer[6], 'PM' ) === 0 ? 12 : 0 ), $lucifer[5], 0, $lucifer[1], $lucifer[2], $lucifer[3] );
- $b['am/pm'] = $lucifer[6];
- $b['name'] = $lucifer[8];
- } elseif ( ! $is_windows ) {
- $lucifer = preg_split( '/[ ]/', $line, 9, PREG_SPLIT_NO_EMPTY );
- if ( $lucifer ) {
- // echo $line."\n";
- $lcount = count( $lucifer );
- if ( $lcount < 8 ) {
- return '';
- }
- $b = array();
- $b['isdir'] = 'd' === $lucifer[0][0];
- $b['islink'] = 'l' === $lucifer[0][0];
- if ( $b['isdir'] ) {
- $b['type'] = 'd';
- } elseif ( $b['islink'] ) {
- $b['type'] = 'l';
- } else {
- $b['type'] = 'f';
- }
- $b['perms'] = $lucifer[0];
- $b['permsn'] = $this->getnumchmodfromh( $b['perms'] );
- $b['number'] = $lucifer[1];
- $b['owner'] = $lucifer[2];
- $b['group'] = $lucifer[3];
- $b['size'] = $lucifer[4];
- if ( 8 === $lcount ) {
- sscanf( $lucifer[5], '%d-%d-%d', $b['year'], $b['month'], $b['day'] );
- sscanf( $lucifer[6], '%d:%d', $b['hour'], $b['minute'] );
- $b['time'] = mktime( $b['hour'], $b['minute'], 0, $b['month'], $b['day'], $b['year'] );
- $b['name'] = $lucifer[7];
- } else {
- $b['month'] = $lucifer[5];
- $b['day'] = $lucifer[6];
- if ( preg_match( '/([0-9]{2}):([0-9]{2})/', $lucifer[7], $l2 ) ) {
- $b['year'] = gmdate( 'Y' );
- $b['hour'] = $l2[1];
- $b['minute'] = $l2[2];
- } else {
- $b['year'] = $lucifer[7];
- $b['hour'] = 0;
- $b['minute'] = 0;
- }
- $b['time'] = strtotime( sprintf( '%d %s %d %02d:%02d', $b['day'], $b['month'], $b['year'], $b['hour'], $b['minute'] ) );
- $b['name'] = $lucifer[8];
- }
- }
- }
- // Replace symlinks formatted as "source -> target" with just the source name.
- if ( isset( $b['islink'] ) && $b['islink'] ) {
- $b['name'] = preg_replace( '/(\s*->\s*.*)$/', '', $b['name'] );
- }
- return $b;
- }
- /**
- * Gets details for files in a directory or a specific file.
- *
- * @since 2.5.0
- *
- * @param string $path Path to directory or file.
- * @param bool $include_hidden Optional. Whether to include details of hidden ("." prefixed) files.
- * Default true.
- * @param bool $recursive Optional. Whether to recursively include file details in nested directories.
- * Default false.
- * @return array|false {
- * Array of files. False if unable to list directory contents.
- *
- * @type string $name Name of the file or directory.
- * @type string $perms *nix representation of permissions.
- * @type string $permsn Octal representation of permissions.
- * @type string $owner Owner name or ID.
- * @type int $size Size of file in bytes.
- * @type int $lastmodunix Last modified unix timestamp.
- * @type mixed $lastmod Last modified month (3 letter) and day (without leading 0).
- * @type int $time Last modified time.
- * @type string $type Type of resource. 'f' for file, 'd' for directory.
- * @type mixed $files If a directory and `$recursive` is true, contains another array of files.
- * }
- */
- public function dirlist( $path = '.', $include_hidden = true, $recursive = false ) {
- if ( $this->is_file( $path ) ) {
- $limit_file = basename( $path );
- $path = dirname( $path ) . '/';
- } else {
- $limit_file = false;
- }
- $pwd = ftp_pwd( $this->link );
- if ( ! @ftp_chdir( $this->link, $path ) ) { // Can't change to folder = folder doesn't exist.
- return false;
- }
- $list = ftp_rawlist( $this->link, '-a', false );
- @ftp_chdir( $this->link, $pwd );
- if ( empty( $list ) ) { // Empty array = non-existent folder (real folder will show . at least).
- return false;
- }
- $dirlist = array();
- foreach ( $list as $k => $v ) {
- $entry = $this->parselisting( $v );
- if ( empty( $entry ) ) {
- continue;
- }
- if ( '.' === $entry['name'] || '..' === $entry['name'] ) {
- continue;
- }
- if ( ! $include_hidden && '.' === $entry['name'][0] ) {
- continue;
- }
- if ( $limit_file && $entry['name'] !== $limit_file ) {
- continue;
- }
- $dirlist[ $entry['name'] ] = $entry;
- }
- $ret = array();
- foreach ( (array) $dirlist as $struc ) {
- if ( 'd' === $struc['type'] ) {
- if ( $recursive ) {
- $struc['files'] = $this->dirlist( $path . '/' . $struc['name'], $include_hidden, $recursive );
- } else {
- $struc['files'] = array();
- }
- }
- $ret[ $struc['name'] ] = $struc;
- }
- return $ret;
- }
- /**
- * Destructor.
- *
- * @since 2.5.0
- */
- public function __destruct() {
- if ( $this->link ) {
- ftp_close( $this->link );
- }
- }
- }
|