vroman/PHPShell
SHA256
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Initial import. Code from 2008

Browse source
This commit is contained in:
Víctor Román Archidona 2012-08-26 13:14:58 +02:00
parent 6c772f2e0c
commit 5fb0d35421
3 changed files with 573 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

165
License Normal file
View file

@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.

68
example.php Normal file
View file

@ -0,0 +1,68 @@
<?php
/*
* Example output:
* user@machine ~/phpsh_test $ php phpshell.example.php
* phpsh (/home/user/phpsh_test)> ls
* another_dir
* my_file.txt
* phpshell.class.php
* phpshell.example.php
* phpsh (/home/user/phpsh_test)> show my_file.txt
* hello world
* phpsh (/home/user/phpsh_test)> mem_usage
* Memory used: 193.734375 mB
* phpsh (/home/user/phpsh_test)> cd another_dir
* phpsh (/home/user/phpsh_test/another_dir)> ls
* phpsh (/home/user/phpsh_test/another_dir)> cd ..
* phpsh (/home/user/phpsh_test)> exit
* user@machine ~/phpsh_test $
*/
# 1. Load the class
require_once "phpshell.class.php";
# 2. Create an instance to it
# 3. Some example commands:
$phpsh = new PHPShell("phpsh (%path%)> ");
$phpsh->registerCommand("show", "_Show");
$phpsh->registerCommand("mem_usage", "_DisplayUsedMemory");
# 4. Main loop (You can replace $phpsh->Process() with your own
# event dispatcher. See phpsh.class.php for details
for (;;) {
$input = trim($phpsh->waitInput());
$phpsh->Process($input);
}
# These functions are examples ones:
function _Show($parameters = array())
{
$file = $parameters;
if (!is_file($file)) {
WriteConsole("File $file does not exists".PHP_EOL);
return 1;
}
if (!is_readable($file)) {
WriteConsole("File $file is not readable".PHP_EOL);
return 1;
}
WriteConsole(file_get_contents($file));
return 0;
}
function _DisplayUsedMemory()
{
$memory_used = memory_get_usage()/1024;
WriteConsole("Memory used: $memory_used mB".PHP_EOL);
}
function WriteConsole($text)
{
$len = strlen($text);
fwrite(STDOUT, $text, $len);
}
?>

340
phpshell.class.php Normal file
View file

@ -0,0 +1,340 @@
<?php
/*
* PHPSH - An example about shellin', PHP and callbacks
* Copyright (C) 2008 Víctor Román Archidona <contacto@victor-roman.es>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
class PHPShell
{
protected $bufferOutput = null;
protected $consolePrompt = "phpsh (%path%)> ";
private $currentPath = null;
private $registered_commands = array();
/*
* @fn __construct($prompt = null)
* @param[in] string $prompt Prompt to be used
*
* This function is the entrypoint for the shell emulator
*/
public function __construct($prompt = null)
{
$this->currentPath = getcwd();
$this->setPrompt($prompt ? $prompt : $this->consolePrompt);
$this->registerCommand("cd", array($this, "_builtInCommandChdir"));
$this->registerCommand("exit", array($this, "_builtInCommandExit"));
}
/*
* @fn getCommand($input)
* @brief From a given input, strips the first thing (the command)
* @param[in] string $input Input to analyze
* @return The first thing
*/
function getCommand($input)
{
$input = trim($input);
$space_exists = strpos($input, " ");
if ($space_exists)
$input = substr($input, 0, $space_exists);
return $input;
}
/*
* @fn getParameters($input)
* @brief From a given input, strips the parameters (all except first word)
* @param[in] string $input Input to analyze
* @return Every word, as an array, except the first one
*/
function getParameters($input)
{
$input = trim($input);
$space_exists = strpos($input, " ");
if ($space_exists) {
$parameters = substr($input, strpos($input, " ") + 1);
$parameters = explode(" ", $parameters);
return $parameters;
}
return array();
}
/*
* @fn Process($input)
* @brief Event dispatcher. The core of the class
* @param[in] string $input Input to process
*
* NOTES
* -----
* 1. First gets the command and parameters
* 2. If command is not null:
* 1. If is a system command, it gets the full path and execute
* 2. Else, if is an internal command, runs it
* 3. Otherwise runs the input as php code using eval()
*/
public function Process($input)
{
$command = $this->getCommand($input);
$params = $this->getParameters($input);
if (strlen($command)) {
if ($this->isSystemCommand($command)) {
$full_cmd_path = $this->getSystemCommandFullPath($command);
$this->runSystemCommand($full_cmd_path, $params);
} else if ($this->isCommand($command)) {
$output = $this->runCommand($command, $params);
if ($output)
$this->Write($output);
} else {
eval($input);
}
}
}
public function _builtInCommandChdir($parameters)
{
if ($parameters[0] != DIRECTORY_SEPARATOR)
$newdir = realpath($this->currentPath.DIRECTORY_SEPARATOR.$parameters);
else
$newdir = $this->currentPath.DIRECTORY_SEPARATOR.$parameters;
if (is_dir($newdir)) {
chdir($newdir);
$this->currentPath = getcwd();
} else {
$this->Write("Directory $parameters does not exists".PHP_EOL);
}
}
public function _builtInCommandExit($parameters = null)
{
$exit_code = 0;
if ($parameters[0] && is_numeric($parameters[0]))
$exit_code = $parameters[0];
exit($exit_code);
}
/**
* @fn promptReplace()
* @brief Replaces the macro appearances inside current prompt
*/
private function promptReplace()
{
$prompt = str_replace("%path%", $this->currentPath, $this->consolePrompt);
return $prompt;
}
/**
* @fn setPrompt($prompt)
* @brief sets the prompt to be displayed
* @param[in] string $prompt prompt to be setted
*
* NOTES
* 1. You can use the macro %path% to display the *current* path.
*/
public function setPrompt($prompt)
{
$this->consolePrompt = $prompt;
}
/**
* @fn getPrompt()
* @brief Gets the current prompt
*/
public function getPrompt()
{
return $this->consolePrompt;
}
/**
* @fn waitInput()
* @brief Waits until the user press the enter key, showing the prompt
*/
public function waitInput()
{
$this->Write($this->promptReplace($this->consolePrompt));
return $this->Read();
}
/**
* @fn registerCommand($command, $callback)
* @brief Register a command with an internal callback
* @input[in] string $command Command name exported
* @input[in] string $callback Function that the command will execute
*
* @return true if the command is correctly registered
*
* NOTES:
* 1. Callback must be a function or an array(class,method) pair
* 2. The command must be unique (not previously registered)
*/
public function registerCommand($command, $callback)
{
$command = strtolower($command);
if (!in_array($command, $this->registered_commands)) {
$new_command = array("command" => $command,
"callback" => $callback);
if (is_array($callback)) {
list($_class, $_method) = $callback;
if (!method_exists($_class, $_method)) {
$this->Write("Function callback: \"$_class->$_method\" for command: \"$command\" does not exists\n");
return false;
}
} else {
if (!function_exists($callback)) {
$this->Write("Function callback: \"$callback\" for command: \"$command\" does not exists\n");
return false;
}
}
$this->registered_commands[] = $new_command;
return true;
}
}
/**
* @fn isCommand($command)
* @brief Determines if $command was registered via registerCommand
* @input[in] string $command Command to be checked
*
* @return true if $command was registered via registerCommand, false otherwise
*/
public function isCommand($command)
{
foreach ($this->registered_commands as $current)
if ($current['command'] == $command)
return true;
return false;
}
/**
* @fn isSystemCommand($command)
* @brief Determines if $command is from system or not
* @input[in] string $command Command to be checked
*
* @return true if $command came from system, false otherwise
*/
public function isSystemCommand($command)
{
$syspath = $_ENV["PATH"];
foreach (explode(":", $syspath) as $path)
if (is_executable($path.DIRECTORY_SEPARATOR.$command))
return true;
return false;
}
/**
* @fn getSystemCommandFullPath($command)
* @brief Gets the full (real) path from a system command
* @input[in] string $command Command to obtain
*
* @return The full path of the given system command
*/
public function getSystemCommandFullPath($command)
{
$syspath = $_ENV["PATH"];
foreach ((array)explode(":", $syspath) as $path)
if (is_executable($path.DIRECTORY_SEPARATOR.$command))
return $path.DIRECTORY_SEPARATOR.$command;
return null;
}
/**
* @fn runSystemCommand($command, $parameters)
* @brief Runs a system command with specified $parameters
* @param[in] string $command Command to execute
* @param[in] string $parameters Parameters passed to the command
*/
public function runSystemCommand($command, $parameters = null)
{
$parameters = is_array($parameters) ? implode(" ", $parameters) : null;
passthru("$command $parameters");
}
/**
* @fn runCommand($command, $parameters)
* @brief Runs a registered command with specified $parameters
* @param[in] string $command Command to execute
* @param[in] string $parameters Parameters passed to the command
*/
public function runCommand($command, $parameters = null)
{
$callback = $this->getCommandCallback($command);
if (is_array($callback)) {
list($_class, $_method) = $callback;
call_user_func_array(array($_class, $_method), $parameters);
} else {
call_user_func_array($callback, $parameters);
}
}
/**
* @fn getCommandCallback($command)
* @brief Gets the internal callback from an internal command
* @param[in] string $command Command to check
*/
public function getCommandCallback($command)
{
foreach ($this->registered_commands as $current)
if ($current['command'] == $command)
return $current['callback'];
return null;
}
/**
* @fn Read
* @brief Reads input from STDIN
* @return string readed from STDIN, without \r nor \n
*/
public static function Read()
{
$drop_chars = array("\n", "\r");
$buffer = fread(STDIN, 1024);
$buffer = str_replace($drop_chars, null, $buffer);
return $buffer;
}
/**
* @fn Write($text)
* @brief Writes $text to STDOUT
* @param[in] string $text Text to be written
*/
public static function Write($text)
{
$len = strlen($text);
fwrite(STDOUT, $text, $len);
}
}