wppaste
WordPress

WP_Filesystem_FTPext::parselisting( string $line ): array|string

Source
wp-admin/includes/class-wp-filesystem-ftpext.php:689
Parses an individual entry from the FTP LIST command output.

Compatibility

WordPress
core
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$linestring
A line from the directory listing.

Return value

array|string
Array of file information. Empty string if the line could not be parsed.

  • $namestring

    Name of the file or directory.

  • $permsstring

    *nix representation of permissions.

  • $permsnstring

    Octal representation of permissions.

  • $numberstring|false

    File number as a string, or false if not available.

  • $ownerstring|false

    Owner name or ID, or false if not available.

  • $groupstring|false

    File permissions group, or false if not available.

  • $sizestring|false

    Size of file in bytes as a string, or false if not available.

  • $lastmodunixstring|false

    Last modified unix timestamp as a string, or false if not available.

  • $lastmodstring|false

    Last modified month (3 letters) and day (without leading 0), or false if not available.

  • $timestring|false

    Last modified time, or false if not available.

  • $typestring

    Type of resource. 'f' for file, 'd' for directory, 'l' for link.

  • $filesarray|false

    If a directory and $recursive is true, contains another array of files. False if unable to list directory contents.

Performance profile

How much work a call to WP_Filesystem_FTPext::parselisting() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
16–123

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 222.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

  • regexregular expression over the whole inputpreg_split()called directly

What one call costs · 20 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Filesystem_FTPext::parselisting() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
$is_windows !== null && !preg_match()16–25preg_match()
$is_windows !== null17–26preg_split()
$is_windows !== null && !preg_match()24–33preg_match(), preg_split()
$is_windows === null && !preg_match()27–36ftp_systype(), stripos(), preg_match()
$is_windows === null28–37ftp_systype(), stripos(), preg_split()
$is_windows === null && !preg_match()35–44ftp_systype(), stripos(), preg_match(), preg_split()
$is_windows !== null && preg_match()65–77preg_match(), strcasecmp(), mktime()
$is_windows === null && preg_match()76–88ftp_systype(), stripos(), preg_match(), strcasecmp(), mktime()
$is_windows !== null && !$lcount && $lcount !== 8 && !preg_match()88–99preg_split(), ->getnumchmodfromh(), preg_match(), sprintf(), strtotime()
$is_windows !== null && !$lcount && $lcount !== 8 && preg_match()92–103preg_split(), ->getnumchmodfromh(), preg_match(), gmdate(), sprintf(), strtotime()
$is_windows !== null && !$lcount && $lcount === 894–105preg_split(), ->getnumchmodfromh(), sscanf(), sscanf(), mktime()
$is_windows !== null && !preg_match() && !$lcount && $lcount !== 895–106preg_match(), preg_split(), ->getnumchmodfromh(), preg_match(), sprintf(), strtotime()
8 further outcomes, up to 123 instructions
$is_windows !== null && !$lcount && $lcount !== 899–110preg_match(), preg_split(), ->getnumchmodfromh(), preg_match(), gmdate(), sprintf(), strtotime()
$is_windows === null && !$lcount && $lcount !== 8 && !preg_match()99–110ftp_systype(), stripos(), preg_split(), ->getnumchmodfromh(), preg_match(), sprintf(), strtotime()
$is_windows !== null && !preg_match() && !$lcount && $lcount === 8101–112preg_match(), preg_split(), ->getnumchmodfromh(), sscanf(), sscanf(), mktime()
$is_windows === null && !$lcount && $lcount !== 8 && preg_match()103–114ftp_systype(), stripos(), preg_split(), ->getnumchmodfromh(), preg_match(), gmdate(), sprintf(), strtotime()
$is_windows === null && !$lcount && $lcount === 8105–116ftp_systype(), stripos(), preg_split(), ->getnumchmodfromh(), sscanf(), sscanf(), mktime()
$is_windows === null && !preg_match() && !$lcount && $lcount !== 8106–117ftp_systype(), stripos(), preg_match(), preg_split(), ->getnumchmodfromh(), preg_match(), sprintf(), strtotime()
$is_windows === null && !$lcount && $lcount !== 8110–121ftp_systype(), stripos(), preg_match(), preg_split(), ->getnumchmodfromh(), preg_match(), gmdate(), sprintf(), strtotime()
$is_windows === null && !preg_match() && !$lcount && $lcount === 8112–123ftp_systype(), stripos(), preg_match(), preg_split(), ->getnumchmodfromh(), sscanf(), sscanf(), mktime()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev22216–12316
8.522216–12316
8.422216–123163 fewer instructions than PHP 8.3
8.322516–12616
8.222516–126161 more instruction than PHP 8.1
8.122416–12516
7.422416–12516

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

  • stripos()
  • WP_Filesystem_FTPext::getnumchmodfromh()

Used by · 1

Source code

View on Trac View on GitHub 

	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['time'] = mktime( (int) $lucifer[4] + ( strcasecmp( $lucifer[6], 'PM' ) === 0 ? 12 : 0 ), (int) $lucifer[5], 0, (int) $lucifer[1], (int) $lucifer[2], (int) $lucifer[3] );			$b['name'] = $lucifer[8];		} elseif ( ! $is_windows ) {			$lucifer = preg_split( '/[ ]/', $line, 9, PREG_SPLIT_NO_EMPTY ); 			if ( $lucifer ) {				$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', $year, $month, $day );					sscanf( $lucifer[6], '%d:%d', $hour, $minute ); 					$b['time'] = mktime( (int) $hour, (int) $minute, 0, (int) $month, (int) $day, (int) $year );					$b['name'] = $lucifer[7];				} else {					$month = $lucifer[5];					$day   = $lucifer[6]; 					if ( preg_match( '/([0-9]{2}):([0-9]{2})/', $lucifer[7], $l2 ) ) {						$year   = gmdate( 'Y' );						$hour   = $l2[1];						$minute = $l2[2];					} else {						$year   = $lucifer[7];						$hour   = 0;						$minute = 0;					} 					$b['time'] = strtotime( sprintf( '%d %s %d %02d:%02d', $day, $month, $year, $hour, $minute ) );					$b['name'] = $lucifer[8];				}			}

Changelog

One change between 6.7.7 and 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

6.9.7
Return type changed from array to array|string.verified against source

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/class-wp-filesystem-ftpext.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.