Introduce the `Input` class #51

Hywan · 2015-09-24T07:01:00Z

Old title

Imagine this case:

$ php foo.php

where foo.php is a program that reads from STDIN. It works perfectly with Hoa\Console.

Now, imagine this other case:

$ echo "foo\nbar" | php foo.php

STDIN will contain foo and bar but the Hoa\Console\Cursor —for instance— will no longer work since it reads from STDIN too.

The idea is then to close STDIN (aka php://input) and open /dev/tty, which is the real standard input in this case.

So, to address these needs, we introduce the Hoa\Console::getStdin method that is a helper to choose the appopriate standard input. We also change the Hoa\Console::advancedInteraction behavior: 👷 stty uses the -f option to specify /dev/tty instead of the default standard input. However, on Linux, this is -F. I don't know how to address this right now (I mean: Making something cross-platform).

Finally, all Hoa\Console's classes that were using STDIN directly are now using Hoa\Console::getStdin.

New title

Actually, since #55, this PR has taken a new path. We also introduced an Input class. And it considers whether to use Hoa\File\Read('php://stdin') as the default input, or Hoa\File\Read('/dev/tty') in case the former has been closed. This is a basic wrapper.

Hywan · 2015-10-21T06:49:41Z

@jubianchi, @Metalaka: Please, review it. I will add tests today.

Hywan · 2015-10-21T15:10:35Z

Ready for a review!

Hywan · 2015-10-21T15:11:13Z

Console.php

-        self::$_old = Processus::execute('stty -g');
-        Processus::execute('stty -echo -icanon min 1 time 0');
+        self::$_old = Processus::execute('stty -f /dev/tty -g');
+        Processus::execute('stty -f /dev/tty -echo -icanon min 1 time 0');


Still don't know what to do here. -F on Linux, -f on BSD. Any idea how to test the OS efficiently?

I am installing an Ubuntu OS to try finding a solution.

Metalaka · 2015-10-21T18:23:35Z

Input.php

+     *
+     * @param   int     $length    Length.
+     * @return  string
+     * @throws  \Hoa\Exception


Should not be present.

Actually, the underlying method we wrap can throw an exception, so…

So this method don't throw any things, @throws tag is present in Hoa\File\Read and don't need to be duplicated.

Hywan · 2015-10-22T07:32:53Z

I found a way to solve the issue -f vs. -F (respectively on BSD and Linux). See the commit message of Hywan@402b218:

On Linux, this is the stty -F $file or stty --file $file options.
On BSD, this is the stty -f $file option.

There is a conflict here and this is difficult to have something
cross-platform. Fortunately, both architectures use the standard input
as the -F, --file or -f value. So writing stty < $file seems to
fix the issue.

Hywan · 2015-10-22T07:33:23Z

We are ready for a merge. @Metalaka, @jubianchi: Is it OK for you?

Metalaka · 2015-10-22T18:33:49Z

getStream issue not solved, see example on hoaproject/Stream#16

Hywan · 2015-10-26T07:38:48Z

I guess we can merge this patch before, though? This is safe enough for now.

Metalaka · 2015-10-26T12:12:29Z

Ok, let's go.

By default, the advanced interaction is not enabled if `STDIN` is not direct. We can now bypass this guard in particular cases (for instance if `STDIN` is closed and we would like to read from `/dev/tty`).

In case `STDIN` has been closed, `stty` will not be able to act as expected. So we force it to use the `/dev/tty` file instead of the regular standard input.

Exactly like the `Output` class, the `Input` interface represents a stream of the program, here the input stream. We then create the `Console::setInput` and `Console::getInput` methods. By default, if no `Input` instance is provided, an `Hoa\File\Read` instance will be used representing `php://stdin`. If it has been closed then `/dev/tty` will be used instead. This way, we are ensured methods will behave as expected, whether or not the standard input has been closed or not.

The `getStream` method allows to access to the underlying stream that the `Input` class wraps.

Hywan · 2015-10-26T12:17:13Z

We still have an issue with stty -f, -F and <…

On Linux, this is the `stty -F $file` or `stty --file $file` options. On BSD, this is the `stty -f $file` option. There is a conflict here and this is difficult to have something cross-platform. Fortunately, both architectures use the standard input as the `-F`, `--file` or `-f` value. So writing `stty < $file` seems to fix the issue.

@Metalaka

As @Metalaka suggests, we can remove the `@throws` clause.

Hywan · 2015-10-26T12:20:06Z

Fixed with this commit.

Hywan added enhancement in progress difficulty: medium labels Sep 24, 2015

Hywan assigned Hywan and jubianchi and unassigned Hywan Sep 24, 2015

Hywan mentioned this pull request Sep 30, 2015

Proposal: Introduce an Output class #54

Closed

Hywan mentioned this pull request Oct 21, 2015

Improve Output behavior. #59

Merged

Hywan force-pushed the stdin_from_pipe branch from c7235fe to f1205cb Compare October 21, 2015 06:46

Hywan changed the title ~~Use /dev/stty instead of php://input if the latter is closed~~ Introduce the Input class Oct 21, 2015

Hywan force-pushed the stdin_from_pipe branch from f1205cb to a630f3a Compare October 21, 2015 06:54

Hywan reviewed Oct 21, 2015
View reviewed changes

Hywan force-pushed the stdin_from_pipe branch from 1bf66f9 to 836ad5c Compare October 21, 2015 15:23

Metalaka reviewed Oct 21, 2015
View reviewed changes

Metalaka mentioned this pull request Oct 22, 2015

Add getStream to interfaces. hoaproject/Stream#16

Closed

Advanced interaction can be forced.

cc35c09

By default, the advanced interaction is not enabled if `STDIN` is not direct. We can now bypass this guard in particular cases (for instance if `STDIN` is closed and we would like to read from `/dev/tty`).

Hywan added 4 commits October 26, 2015 13:13

stty uses /dev/tty instead of the std. input.

3d5fd41

In case `STDIN` has been closed, `stty` will not be able to act as expected. So we force it to use the `/dev/tty` file instead of the regular standard input.

Test the Input class.

8a66904

Input: Add the getStream method.

e08c9d7

The `getStream` method allows to access to the underlying stream that the `Input` class wraps.

Hywan force-pushed the stdin_from_pipe branch from 3ea97e2 to edd3d3a Compare October 26, 2015 12:13

Hywan added 2 commits October 26, 2015 13:19

Update API documentation.

9600ab3

As @Metalaka suggests, we can remove the `@throws` clause.

Hywan force-pushed the stdin_from_pipe branch from edd3d3a to 9600ab3 Compare October 26, 2015 12:20

Bhoat merged commit 9600ab3 into hoaproject:master Oct 26, 2015

Hywan removed the in progress label Oct 26, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce the `Input` class #51

Introduce the `Input` class #51

Hywan commented Sep 24, 2015

Hywan commented Oct 21, 2015

Hywan commented Oct 21, 2015

Hywan Oct 21, 2015

Hywan Oct 22, 2015

Metalaka Oct 21, 2015

Hywan Oct 22, 2015

Metalaka Oct 22, 2015

Hywan commented Oct 22, 2015

Hywan commented Oct 22, 2015

Metalaka commented Oct 22, 2015

Hywan commented Oct 26, 2015

Metalaka commented Oct 26, 2015

Hywan commented Oct 26, 2015

Hywan commented Oct 26, 2015

Introduce the Input class #51

Introduce the Input class #51

Conversation

Hywan commented Sep 24, 2015

Old title

New title

Hywan commented Oct 21, 2015

Hywan commented Oct 21, 2015

Hywan Oct 21, 2015

Choose a reason for hiding this comment

Hywan Oct 22, 2015

Choose a reason for hiding this comment

Metalaka Oct 21, 2015

Choose a reason for hiding this comment

Hywan Oct 22, 2015

Choose a reason for hiding this comment

Metalaka Oct 22, 2015

Choose a reason for hiding this comment

Hywan commented Oct 22, 2015

Hywan commented Oct 22, 2015

Metalaka commented Oct 22, 2015

Hywan commented Oct 26, 2015

Metalaka commented Oct 26, 2015

Hywan commented Oct 26, 2015

Hywan commented Oct 26, 2015

Introduce the `Input` class #51

Introduce the `Input` class #51