Skip to content

I/O exceptions refactoring #364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thekid merged 5 commits into from
Jun 21, 2026
Merged

I/O exceptions refactoring #364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4580846
I/O exceptions refactoring
thekid Jun 21, 2026
40dbba9
Clean up io.Folder::getEntry() left-overs
thekid Jun 21, 2026
a8420c3
Add class aliases
thekid Jun 21, 2026
7993c32
Merge branch 'main' into refactor/ioexception
thekid Jun 21, 2026
66f6d96
Re-enable 8.6
thekid Jun 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
strategy:
fail-fast: false
matrix:
php-versions: ['7.4', '8.0', '8.1', '8.2', '8.3', '8.4', '8.5']
php-versions: ['7.4', '8.0', '8.1', '8.2', '8.3', '8.4', '8.5', '8.6']
os: [ubuntu-latest, windows-latest]

steps:
Expand Down
94 changes: 47 additions & 47 deletions src/main/php/io/File.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,21 +132,21 @@ public function setURI($uri) {
*
* @param string mode one of the File::* constants
* @return self
* @throws io.FileNotFoundException in case the file is not found
* @throws io.IOException in case the file cannot be opened (e.g., lacking permissions)
* @throws io.NotFound in case the file is not found
* @throws io.OperationFailed in case the file cannot be opened (e.g., lacking permissions)
*/
public function open($mode= self::READ): self {
$this->mode= $mode;
if (
self::READ === $mode &&
0 !== strncmp('php://', $this->uri, 6) &&
!$this->exists()
) throw new FileNotFoundException('File "'.$this->uri.'" not found');
) throw new NotFound('File "'.$this->uri.'" not found');

$this->_fd= fopen($this->uri, $this->mode);
if (!$this->_fd) {
$this->_fd= null;
$e= new IOException('Cannot open '.$this->uri.' mode '.$this->mode);
$e= new OperationFailed('Cannot open '.$this->uri.' mode '.$this->mode);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -164,11 +164,11 @@ public function exists(): bool { return file_exists($this->uri); }
* Retrieve the file's size in bytes
*
* @return int size filesize in bytes
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function size(): int {
if (false === ($stat= $this->_fd ? fstat($this->_fd) : stat($this->uri))) {
$e= new IOException('Cannot get filesize for '.$this->uri);
$e= new OperationFailed('Cannot get filesize for '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -180,11 +180,11 @@ public function size(): int {
*
* @param int $size Default 0
* @return bool
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function truncate(int $size= 0): bool {
if (null === $this->_fd) {
throw new IOException('Cannot truncate file '.$this->uri);
throw new OperationFailed('Cannot truncate file '.$this->uri);
}

// OS vagaries: Windows does not retain file position!
Expand All @@ -197,7 +197,7 @@ public function truncate(int $size= 0): bool {
}

if (false === $return) {
$e= new IOException('Cannot truncate file '.$this->uri);
$e= new OperationFailed('Cannot truncate file '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -216,11 +216,11 @@ public function truncate(int $size= 0): bool {
* On such filesystems this function will be useless.
*
* @return int The date the file was last accessed as a unix-timestamp
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function lastAccessed() {
if (false === ($atime= fileatime($this->uri))) {
$e= new IOException('Cannot get atime for '.$this->uri);
$e= new OperationFailed('Cannot get atime for '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -231,11 +231,11 @@ public function lastAccessed() {
* Retrieve last modification time
*
* @return int The date the file was last modified as a unix-timestamp
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function lastModified() {
if (false === ($mtime= filemtime($this->uri))) {
$e= new IOException('Cannot get mtime for '.$this->uri);
$e= new OperationFailed('Cannot get mtime for '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -247,12 +247,12 @@ public function lastModified() {
*
* @param int time default -1 Unix-timestamp
* @return bool success
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function touch($time= -1) {
if (-1 == $time) $time= time();
if (false === touch($this->uri, $time)) {
$e= new IOException('Cannot set mtime for '.$this->uri);
$e= new OperationFailed('Cannot set mtime for '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -263,11 +263,11 @@ public function touch($time= -1) {
* Retrieve when the file was created
*
* @return int The date the file was created as a unix-timestamp
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function createdAt() {
if (false === ($mtime= filectime($this->uri))) {
$e= new IOException('Cannot get mtime for '.$this->uri);
$e= new OperationFailed('Cannot get mtime for '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -283,7 +283,7 @@ public function createdAt() {
*
* @param int bytes default 4096 Max. amount of bytes to be read
* @return string Data read
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function readLine($bytes= 4096) {
$bytes= $this->gets($bytes);
Expand All @@ -294,11 +294,11 @@ public function readLine($bytes= 4096) {
* Read one char
*
* @return string the character read
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function readChar() {
if (null === $this->_fd || false === ($result= fgetc($this->_fd)) && !feof($this->_fd)) {
$e= new IOException('Cannot read 1 byte from '.$this->uri);
$e= new OperationFailed('Cannot read 1 byte from '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -313,12 +313,12 @@ public function readChar() {
*
* @param int bytes default 4096 Max. amount of bytes to read
* @return string Data read
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function gets($bytes= 4096) {
if (0 === $bytes) return '';
if (null === $this->_fd || false === ($result= fgets($this->_fd, $bytes)) && !feof($this->_fd)) {
$e= new IOException('Cannot read '.$bytes.' bytes from '.$this->uri);
$e= new OperationFailed('Cannot read '.$bytes.' bytes from '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -330,12 +330,12 @@ public function gets($bytes= 4096) {
*
* @param int bytes default 4096 Max. amount of bytes to read
* @return string Data read
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function read($bytes= 4096) {
if (0 === $bytes) return '';
if (null === $this->_fd || false === ($result= fread($this->_fd, $bytes)) && !feof($this->_fd)) {
$e= new IOException('Cannot read '.$bytes.' bytes from '.$this->uri);
$e= new OperationFailed('Cannot read '.$bytes.' bytes from '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -347,11 +347,11 @@ public function read($bytes= 4096) {
*
* @param string string data to write
* @return int number of bytes written
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function write($string) {
if (null === $this->_fd || false === ($result= fwrite($this->_fd, $string))) {
$e= new IOException('Cannot write '.strlen($string).' bytes to '.$this->uri);
$e= new OperationFailed('Cannot write '.strlen($string).' bytes to '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -363,11 +363,11 @@ public function write($string) {
*
* @param string string data default '' to write
* @return int number of bytes written
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function writeLine($string= '') {
if (null === $this->_fd || false === ($result= fwrite($this->_fd, $string."\n"))) {
$e= new IOException('Cannot write '.(strlen($string)+ 1).' bytes to '.$this->uri);
$e= new OperationFailed('Cannot write '.(strlen($string)+ 1).' bytes to '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -382,12 +382,12 @@ public function writeLine($string= '') {
*
* @see php://feof
* @return bool TRUE when the end of the file is reached
* @throws io.IOException in case of an error (e.g., the file's not been opened)
* @throws io.OperationFailed in case of an error (e.g., the file's not been opened)
*/
public function eof() {
$result= feof($this->_fd);
if (isset(\xp::$errors[__FILE__][__LINE__ - 1])) {
$e= new IOException('Cannot determine eof of '.$this->uri);
$e= new OperationFailed('Cannot determine eof of '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -401,11 +401,11 @@ public function eof() {
* This function is identical to a call of $f->seek(0, SEEK_SET)
*
* @return bool TRUE if rewind suceeded
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function rewind() {
if (null === $this->_fd || false === ($result= rewind($this->_fd))) {
$e= new IOException('Cannot rewind file pointer');
$e= new OperationFailed('Cannot rewind file pointer');
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -418,12 +418,12 @@ public function rewind() {
* @param int position default 0 The new position
* @param int mode default SEEK_SET
* @see php://fseek
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
* @return bool success
*/
public function seek($position= 0, $mode= SEEK_SET) {
if (null === $this->_fd || 0 != ($result= fseek($this->_fd, $position, $mode))) {
$e= new IOException('Seek error, position '.$position.' in mode '.$mode);
$e= new OperationFailed('Seek error, position '.$position.' in mode '.$mode);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -434,11 +434,11 @@ public function seek($position= 0, $mode= SEEK_SET) {
* Retrieve file pointer position
*
* @return int position
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
*/
public function tell() {
if (null === $this->_fd || false === ($result= ftell($this->_fd))) {
$e= new IOException('Cannot retrieve file pointer\'s position');
$e= new OperationFailed('Cannot retrieve file pointer\'s position');
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -462,7 +462,7 @@ public function tell() {
* errno condition).
*
* @param int op operation (one of the predefined LOCK_* constants)
* @throws io.IOException in case of an error
* @throws io.OperationFailed in case of an error
* @return bool success
* @see php://flock
*/
Expand All @@ -480,7 +480,7 @@ protected function _lock($mode) {
$mode-= $o;
}
}
$e= new IOException('Cannot lock file '.$this->uri.' w/ '.substr($os, 3));
$e= new OperationFailed('Cannot lock file '.$this->uri.' w/ '.substr($os, 3));
\xp::gc(__FILE__);
throw $e;
}
Expand Down Expand Up @@ -524,14 +524,14 @@ public function unLock() {
* Close this file
*
* @return bool success
* @throws io.IOException if close fails
* @throws io.OperationFailed if close fails
*/
public function close() {
if (!is_resource($this->_fd)) {
throw new IOException('Cannot close non-opened file '.$this->uri);
throw new OperationFailed('Cannot close non-opened file '.$this->uri);
}
if (false === fclose($this->_fd)) {
$e= new IOException('Cannot close file '.$this->uri);
$e= new OperationFailed('Cannot close file '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -547,15 +547,15 @@ public function close() {
* close the file first
*
* @return bool success
* @throws io.IOException in case of an error (e.g., lack of permissions)
* @throws io.OperationFailed in case of an error (e.g., lack of permissions)
* @throws lang.IllegalStateException in case the file is still open
*/
public function unlink() {
if (is_resource($this->_fd)) {
throw new IllegalStateException('File still open');
}
if (false === unlink($this->uri)) {
$e= new IOException('Cannot delete file '.$this->uri);
$e= new OperationFailed('Cannot delete file '.$this->uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -570,7 +570,7 @@ public function unlink() {
*
* @param var target where to move the file to, either a string, a File or a Folder
* @return bool success
* @throws io.IOException in case of an error (e.g., lack of permissions)
* @throws io.OperationFailed in case of an error (e.g., lack of permissions)
* @throws lang.IllegalStateException in case the file is still open
*/
public function move($target) {
Expand All @@ -587,7 +587,7 @@ public function move($target) {
}

if (false === rename($this->uri, $uri)) {
$e= new IOException('Cannot move file '.$this->uri.' to '.$uri);
$e= new OperationFailed('Cannot move file '.$this->uri.' to '.$uri);
\xp::gc(__FILE__);
throw $e;
}
Expand All @@ -604,7 +604,7 @@ public function move($target) {
*
* @param var target where to copy the file to, either a string, a File or a Folder
* @return bool success
* @throws io.IOException in case of an error (e.g., lack of permissions)
* @throws io.OperationFailed in case of an error (e.g., lack of permissions)
* @throws lang.IllegalStateException in case the file is still open
*/
public function copy($target) {
Expand All @@ -621,7 +621,7 @@ public function copy($target) {
}

if (false === copy($this->uri, $uri)) {
$e= new IOException('Cannot copy file '.$this->uri.' to '.$uri);
$e= new OperationFailed('Cannot copy file '.$this->uri.' to '.$uri);
\xp::gc(__FILE__);
throw $e;
}
Expand Down
5 changes: 4 additions & 1 deletion src/main/php/io/FileNotFoundException.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

/**
* Indicates the file could not be found
*
* @deprecated https://github.com/xp-framework/core/issues/363
*/
class FileNotFoundException extends IOException {
}

}
8 changes: 4 additions & 4 deletions src/main/php/io/Files.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ class Files {
*
* @param string|io.File $file
* @return string file contents
* @throws io.IOException
* @throws io.FileNotFoundException
* @throws io.OperationFailed
* @throws io.NotFound
*/
public static function read($file) {
$f= $file instanceof File ? $file : new File($file);
Expand Down Expand Up @@ -57,7 +57,7 @@ public static function read($file) {
* @param string|io.File $file
* @param string $bytes
* @return int
* @throws io.IOException
* @throws io.OperationFailed
*/
public static function write($file, $bytes) {
$f= $file instanceof File ? $file : new File($file);
Expand All @@ -80,7 +80,7 @@ public static function write($file, $bytes) {
* @param string|io.File $file
* @param string $bytes
* @return int
* @throws io.IOException
* @throws io.OperationFailed
*/
public static function append($file, $bytes) {
$f= $file instanceof File ? $file : new File($file);
Expand Down
Loading
Loading