Refactor I/O exceptions

Author: thekid

ChangeLog.md

@@ -3,6 +3,13 @@ Web change log
 
 ## ?.?.? / ????-??-??
 
+## 4.10.0 / 2026-06-21
+
+* Merged PR #22: Refactor I/O exceptions, dropping XP 10 support in the
+  doing. See xp-framework/core#363 for a write-up on the reason behind
+  this and the plan to move forward.
+  (@thekid)
+
 ## 4.9.0 / 2026-06-07
 
 * Merged PR #131: Implement `web.filters.CORS` (feature requested in #128),

composer.json

@@ -6,7 +6,7 @@
   "description" : "Web applications for the XP Framework",
   "keywords": ["module", "xp"],
   "require" : {
-    "xp-framework/core": "^12.0 | ^11.0 | ^10.0",
+    "xp-framework/core": "^12.11 | ^11.11",
     "xp-framework/networking": "^11.0 | ^10.1 | ^9.3",
     "xp-forge/uri": "^3.0 | ^2.0 | ^1.4",
     "php": ">=7.0.0"

src/main/php/web/io/Incomplete.class.php

@@ -1,6 +1,6 @@
 <?php namespace web\io;
 
-use io\OperationNotSupportedException;
+use io\NotSupported;
 use io\streams\InputStream;
 use web\io\Part;
 
@@ -42,9 +42,9 @@ public function kind() { return Part::INCOMPLETE; }
   /** @return string */
   public function error() { return $this->error; }
 
-  /** @return io.IOException */
+  /** @return io.OperationFailed */
   private function notSupported() {
-    return new OperationNotSupportedException('Cannot read from incomplete part (error= '.$this->error.')');
+    return new NotSupported('Cannot read from incomplete part (error= '.$this->error.')');
   }
 
   /** @return string */
@@ -56,7 +56,7 @@ public function bytes() { throw $this->notSupported(); }
    * @param  io.Path|io.Folder|io.streams.OutputStream|string $target
    * @return iterable
    * @throws lang.IllegalArgumentException if filename is invalid
-   * @throws io.IOException
+   * @throws io.OperationFailed
    */
   public function transmit($target) { throw $this->notSupported(); yield; }
 

src/main/php/web/io/ReadChunks.class.php

@@ -1,6 +1,6 @@
 <?php namespace web\io;
 
-use io\IOException;
+use io\OperationFailed;
 use io\streams\InputStream;
 
 /**
@@ -18,13 +18,13 @@ class ReadChunks implements InputStream {
    * Scans a chunk, populating length and buffer
    *
    * @return int
-   * @throws io.IOException for chunked format errors
+   * @throws io.OperationFailed for chunked format errors
    */
   private function scan() {
     $size= $this->input->readLine() ?? '';
 
     if (1 !== sscanf($size, '%x', $l)) {
-      throw new IOException('No chunk segment present (`'.addcslashes($size, "\0..\37").'`)');
+      throw new OperationFailed('No chunk segment present (`'.addcslashes($size, "\0..\37").'`)');
     }
 
     // Chunk with 0 length indicates EOF
@@ -80,7 +80,7 @@ public function read($limit= 8192) {
     $chunk= substr($this->buffer, 0, min($limit, $remaining));
     if ('' === $chunk) {
       $this->remaining= 0;
-      throw new IOException('EOF');
+      throw new OperationFailed('EOF');
     }
 
     $length= strlen($chunk);

src/main/php/web/io/ReadLength.class.php

@@ -1,6 +1,6 @@
 <?php namespace web\io;
 
-use io\IOException;
+use io\OperationFailed;
 use io\streams\InputStream;
 
 /**
@@ -32,7 +32,7 @@ public function read($limit= 8192) {
     $chunk= $this->input->read(min($limit, $this->remaininig));
     if ('' === $chunk) {
       $this->remaininig= 0;
-      throw new IOException('EOF');
+      throw new OperationFailed('EOF');
     }
 
     $this->remaininig-= strlen($chunk);

src/main/php/web/io/Stream.class.php

@@ -75,7 +75,7 @@ public function bytes() {
    * @param  io.Path|io.Folder|io.streams.OutputStream|string $target
    * @return iterable
    * @throws lang.IllegalArgumentException if filename is invalid
-   * @throws io.IOException
+   * @throws io.OperationFailed
    */
   public function transmit($target) {
     if ($target instanceof OutputStream) {

src/main/php/xp/web/Upload.class.php

@@ -65,7 +65,7 @@ public function bytes() {
    * @param  io.Path|io.Folder|io.streams.OutputStream|string $target
    * @return iterable
    * @throws lang.IllegalArgumentException if filename is invalid
-   * @throws io.IOException
+   * @throws io.OperationFailed
    */
   public function transmit($target) {
 

src/main/php/xp/web/srv/CannotWrite.class.php

@@ -1,8 +1,8 @@
 <?php namespace xp\web\srv;
 
-use io\IOException;
+use io\OperationFailed;
 
-class CannotWrite extends IOException {
+class CannotWrite extends OperationFailed {
 
   /** @return string */
   public function toString(): string { return $this->message; }

src/main/php/xp/web/srv/Develop.class.php

@@ -1,6 +1,6 @@
 <?php namespace xp\web\srv;
 
-use io\IOException;
+use io\OperationFailed;
 use lang\archive\ArchiveClassLoader;
 use lang\{ClassLoader, CommandLine, FileSystemClassLoader, Runtime, RuntimeOptions};
 use peer\Socket;
@@ -74,7 +74,7 @@ public function serve($source, $profile, $webroot, $docroot, $config, $args, $lo
       $cmd= 'exec '.$cmd;      // Replace launching shell with PHP
     }
     if (!($proc= proc_open($cmd, [STDIN, STDOUT, ['file', $nul, 'w']], $pipes, null, null, ['bypass_shell' => true]))) {
-      throw new IOException('Cannot execute `'.$runtime->getExecutable()->getFileName().'`');
+      throw new OperationFailed('Cannot execute `'.$runtime->getExecutable()->getFileName().'`');
     }
 
     Console::writeLinef(

src/test/php/web/unittest/io/IncompleteTest.class.php

@@ -1,6 +1,6 @@
 <?php namespace web\unittest\io;
 
-use io\OperationNotSupportedException;
+use io\NotSupported;
 use test\{Assert, Expect, Test};
 use web\io\{Incomplete, Part};
 
@@ -29,20 +29,20 @@ public function string_representation() {
     );
   }
 
-  #[Test, Expect(OperationNotSupportedException::class)]
+  #[Test, Expect(NotSupported::class)]
   public function cannot_access_bytes() {
     (new Incomplete('upload', UPLOAD_ERR_INI_SIZE))->bytes();
   }
 
-  #[Test, Expect(OperationNotSupportedException::class)]
+  #[Test, Expect(NotSupported::class)]
   public function cannot_transmit() {
     $it= (new Incomplete('upload', UPLOAD_ERR_INI_SIZE))->transmit('./uploads');
     while ($it->valid()) {
       $it->next();
     }
   }
 
-  #[Test, Expect(OperationNotSupportedException::class)]
+  #[Test, Expect(NotSupported::class)]
   public function cannot_read_bytes() {
     (new Incomplete('upload', UPLOAD_ERR_INI_SIZE))->read();
   }