├── bin
    └── php-server
├── src
    ├── pages
    │   ├── favicon.png
    │   ├── error-404.php
    │   ├── show-file.php
    │   ├── default.php
    │   └── _template.php
    ├── banner.txt
    ├── server_config.php
    ├── server_router.php
    ├── server.php
    └── functions.php
├── composer.json
├── LICENSE
└── README.md


/bin/php-server:
--------------------------------------------------------------------------------
1 | ../src/server.php


--------------------------------------------------------------------------------
/src/pages/favicon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/natanfelles/php-server/HEAD/src/pages/favicon.png


--------------------------------------------------------------------------------
/src/banner.txt:
--------------------------------------------------------------------------------
1 |  ____  _   _ ____    ____                           
2 | |  _ \| | | |  _ \  / ___|  ___ _ ____   _____ _ __ 
3 | | |_) | |_| | |_) | \___ \ / _ \ '__\ \ / / _ \ '__|
4 | |  __/|  _  |  __/   ___) |  __/ |   \ V /  __/ |   
5 | |_|   |_| |_|_|     |____/ \___|_|    \_/ \___|_|   
6 |                                                     
7 | 


--------------------------------------------------------------------------------
/src/pages/error-404.php:
--------------------------------------------------------------------------------
 1 | <p><a href="/">Document root</a></p>
 2 | <div class="error">
 3 |     <p>You are seeing this because the URL really could not be responded.</p>
 4 |     <p>That was the order of our attempts:</p>
 5 |     <ul>
 6 |         <li>Verified if the path <strong><?= $absolute_path ?></strong> exists.</li>
 7 |         <li>Verified if there is an index within <strong><?= $absolute_path ?></strong>.</li>
 8 |         <li>Verified if there is an index in the document root
 9 |             <strong><?= $config['root'] ?></strong> to do an URL Rewrite.
10 |         </li>
11 |     </ul>
12 |     <p>Therefore, this URL does not really exist.</p>
13 | </div>
14 | 


--------------------------------------------------------------------------------
/src/pages/show-file.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | $contents = file_get_contents($absolute_path);
 3 | if (substr($absolute_path, -3) === 'php') {
 4 |     $contents = highlight_string($contents, true);
 5 |     if (PHP_VERSION < '8.3') {
 6 |         $contents = strtr($contents, [PHP_EOL => '', '&nbsp;' => ' ']);
 7 |         $contents = str_replace(['<br>', '<br />'], "\n", $contents);
 8 |     }
 9 | } else {
10 |     $contents = '<pre>' . htmlentities($contents) . '</pre>';
11 | }
12 | 
13 | $function_parent_dir($relative_path);
14 | ?>
15 | <div class="file-code">
16 |     <div class="lines"><?php
17 |         foreach (explode("\n", $contents) as $line => $c) {
18 |             echo '<span>' . ($line + 1) . '</span>';
19 |         }
20 |         ?></div>
21 |     <div class="code"><?= $contents ?></div>
22 | </div>
23 | 


--------------------------------------------------------------------------------
/src/server_config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | if (is_file($custom_config_file = getcwd() . '/php-server.ini')) {
 4 |     $custom_config = parse_ini_file($custom_config_file, true, INI_SCANNER_TYPED);
 5 | }
 6 | 
 7 | $default_config = [
 8 |     'php' => PHP_BINARY,
 9 |     'host' => 'localhost',
10 |     'port' => '8080',
11 |     'root' => getcwd(),
12 |     'autoindex' => true,
13 |     'index' => 'index.html index.php',
14 |     'error_reporting' => E_ALL,
15 |     'ini' => [
16 |         'display_errors' => 1,
17 |         'display_startup_errors' => 1,
18 |         'max_execution_time' => 360,
19 |     ],
20 |     'server' => [
21 |         'PHPSERVER_VERSION' => '2.12.1',
22 |     ],
23 | ];
24 | 
25 | if (isset($custom_config['root'])) {
26 |     $custom_config['root'] = realpath($custom_config['root']);
27 | }
28 | 
29 | return isset($custom_config) ? array_replace_recursive($default_config, $custom_config)
30 |     : $default_config;
31 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "natanfelles/php-server",
 3 |     "description": "Fine-tuning on the PHP built-in web server.",
 4 |     "type": "library",
 5 |     "keywords": [
 6 |         "server",
 7 |         "php-server",
 8 |         "webserver",
 9 |         "dev",
10 |         "development",
11 |         "document-root",
12 |         "autoindex",
13 |         "rewrite",
14 |         "mod-rewrite",
15 |         "devtools"
16 |     ],
17 |     "homepage": "https://github.com/natanfelles/php-server",
18 |     "license": "MIT",
19 |     "authors": [
20 |         {
21 |             "name": "Natan Felles",
22 |             "email": "natanfelles@gmail.com",
23 |             "homepage": "https://natanfelles.github.io"
24 |         }
25 |     ],
26 |     "support": {
27 |         "issues": "https://github.com/natanfelles/php-server/issues",
28 |         "source": "https://github.com/natanfelles/php-server"
29 |     },
30 |     "require": {
31 |         "php": ">=5.6.0"
32 |     },
33 |     "bin": [
34 |         "bin/php-server"
35 |     ]
36 | }
37 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2017 Natan Felles
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/src/pages/default.php:
--------------------------------------------------------------------------------
 1 | <?php $function_parent_dir($relative_path) ?>
 2 | <?php if (!empty($paths)): ?>
 3 |     <p class="half" style="float: right"><input type="text" id="search" placeholder="Search..."></p>
 4 | <?php endif ?>
 5 | <table>
 6 |     <thead>
 7 |     <tr>
 8 |         <th>Type</th>
 9 |         <?= $function_order_link('filename', 'Name') ?>
10 |         <?= $function_order_link('size', 'Size') ?>
11 |         <?= $function_order_link('owner', 'Owner') ?>
12 |         <?= $function_order_link('group', 'Group') ?>
13 |         <?= $function_order_link('perms', 'Permissions') ?>
14 |         <?= $function_order_link('mTime', 'Modified') ?>
15 |         <th>Options</th>
16 |     </tr>
17 |     </thead>
18 |     <tbody>
19 |     <?php if (empty($paths)): ?>
20 |         <tr>
21 |             <td colspan="8">This directory is empty.</td>
22 |         </tr>
23 |     <?php endif ?>
24 |     <?php
25 |     $posix = function_exists('posix_getpwuid') && function_exists('posix_getgrgid');
26 |     ?>
27 |     <?php foreach ($paths as $path): ?>
28 |         <?php
29 |         $user = $group = '';
30 |         if ($posix) {
31 |             $user = posix_getpwuid($path['owner']);
32 |             $user = $user['name'] . ($user['gecos'] ? ' - ' . rtrim($user['gecos'], ',') : '');
33 | 
34 |             $group = posix_getgrgid($path['group'])['name'];
35 |         }
36 |         ?>
37 |         <tr>
38 |             <td>
39 |                 <span><?= $path['type'] ?></span>
40 |             </td>
41 |             <td>
42 |                 <a href="<?= $path['href'] ?>"><?= $path['filename'] ?></a>
43 |             </td>
44 |             <td><?= $path['size'] ?></td>
45 |             <td title="<?= $user ?>"><?= $path['owner'] ?></td>
46 |             <td title="<?= $group ?>"><?= $path['group'] ?></td>
47 |             <td><?= $path['perms'] ?></td>
48 |             <td><?= $path['mTime'] ?></td>
49 |             <td>
50 |                 <a href="<?= $path['href'] ?>?php-server=show">Show</a>
51 |             </td>
52 |         </tr>
53 |     <?php endforeach ?>
54 |     </tbody>
55 | </table>
56 | 


--------------------------------------------------------------------------------
/src/server_router.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * PHP Server
  4 |  *
  5 |  * You probably will not have to change much here
  6 |  *
  7 |  * @author Natan Felles <natanfelles@gmail.com>
  8 |  * @link   https://github.com/natanfelles/php-server
  9 |  */
 10 | 
 11 | // Load our functions...
 12 | require __DIR__ . '/functions.php';
 13 | 
 14 | /**
 15 |  * @var array $config Server config
 16 |  */
 17 | $config = require __DIR__ . '/server_config.php';
 18 | 
 19 | error_reporting($config['error_reporting']);
 20 | 
 21 | foreach ($config['server'] as $key => $value) {
 22 |     $_SERVER[$key] = $value;
 23 | }
 24 | 
 25 | if (isset($_GET['php-server']) && $_GET['php-server'] === 'phpinfo') {
 26 |     $function_clean_vars();
 27 |     phpinfo();
 28 | 
 29 |     return true;
 30 | }
 31 | 
 32 | /**
 33 |  * Relative and Absolute directory path
 34 |  */
 35 | $relative_path = preg_replace('/\/$/', '', urldecode(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH)));
 36 | $absolute_path = $config['root'] . $relative_path;
 37 | 
 38 | // Show file contents or goto listAll
 39 | if (isset($_GET['php-server']) && $_GET['php-server'] === 'show') {
 40 |     if (is_dir($absolute_path)) {
 41 |         goto listAll;
 42 |     }
 43 | 
 44 |     $title = 'File ' . $relative_path;
 45 |     $page = 'show-file';
 46 | 
 47 |     require __DIR__ . '/pages/_template.php';
 48 | 
 49 |     $function_clean_vars();
 50 |     return true;
 51 | }
 52 | 
 53 | // If is not a dir get the file content
 54 | if (!is_dir($absolute_path) && is_file($absolute_path)) {
 55 |     $function_clean_vars();
 56 | 
 57 |     return false;
 58 | }
 59 | 
 60 | // Run the index file
 61 | $indexes = explode(' ', trim($config['index']));
 62 | 
 63 | foreach ($indexes as $index) {
 64 |     // Check if has an index inside the current dir
 65 |     if (is_file($absolute_path . '/' . $index)) {
 66 |         $_SERVER['PHPSERVER_INDEX'] = $absolute_path . '/' . $index;
 67 |         $function_clean_vars();
 68 | 
 69 |         require $_SERVER['PHPSERVER_INDEX'];
 70 | 
 71 |         return true;
 72 |     }
 73 | }
 74 | 
 75 | // Rewrite - Check if has an index in the document root
 76 | foreach ($indexes as $index) {
 77 |     if (is_file($config['root'] . '/' . $index)) {
 78 |         $_SERVER['PHPSERVER_INDEX'] = $config['root'] . '/' . $index;
 79 |         $function_clean_vars();
 80 | 
 81 |         require $_SERVER['PHPSERVER_INDEX'];
 82 | 
 83 |         return true;
 84 |     }
 85 | }
 86 | 
 87 | listAll:
 88 | 
 89 | // If has not any index and the called file or dir does not exist
 90 | // means that we need a Error 404
 91 | if (!file_exists($absolute_path)) {
 92 |     http_response_code(404);
 93 |     $title = 'Error 404';
 94 |     $page = 'error-404';
 95 | 
 96 |     require __DIR__ . '/pages/_template.php';
 97 | 
 98 |     $function_clean_vars();
 99 | 
100 |     return true;
101 | }
102 | 
103 | // If autoindex is disabled the paths list will not be showed
104 | if ((bool) $config['autoindex'] === false) {
105 |     $function_clean_vars();
106 | 
107 |     return true;
108 | }
109 | 
110 | // File System iterator
111 | $filesystem = iterator_to_array(new FilesystemIterator($absolute_path));
112 | 
113 | // All child paths
114 | $paths = [];
115 | 
116 | foreach ($filesystem as $pathname => $SplFileInfo) {
117 |     if (!file_exists($SplFileInfo->getRealPath())) {
118 |         continue;
119 |     }
120 | 
121 |     if ($SplFileInfo->isDir()) {
122 |         $fi = new FilesystemIterator($SplFileInfo->getRealPath());
123 |     }
124 | 
125 |     $paths[$pathname] = [
126 |         'type' => $SplFileInfo->getType(),
127 |         'realPath' => $SplFileInfo->getRealPath(),
128 |         'filename' => $SplFileInfo->getFilename(),
129 |         'isDir' => $SplFileInfo->isDir(),
130 |         'size' => $SplFileInfo->isDir() ? iterator_count($fi) : $SplFileInfo->getSize(),
131 |         'owner' => $SplFileInfo->getOwner(),
132 |         'group' => $SplFileInfo->getGroup(),
133 |         'perms' => substr(sprintf('%o', $SplFileInfo->getPerms()), -4),
134 |         'mTime' => $SplFileInfo->getMTime(),
135 |         'href' => $function_path_href($SplFileInfo),
136 |     ];
137 | }
138 | 
139 | $paths = $function_order_paths($paths);
140 | 
141 | $title = 'Index of ' . (empty($relative_path) ? '/' : $relative_path);
142 | 
143 | $page = 'default';
144 | 
145 | require __DIR__ . '/pages/_template.php';
146 | 
147 | $function_clean_vars();
148 | 


--------------------------------------------------------------------------------
/src/server.php:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env php
  2 | <?php
  3 | /**
  4 |  * PHP Server
  5 |  *
  6 |  * Run the PHP Built-in web server
  7 |  *
  8 |  * @author Natan Felles <natanfelles@gmail.com>
  9 |  * @link   https://github.com/natanfelles/php-server
 10 |  */
 11 | 
 12 | require __DIR__ . '/functions.php';
 13 | 
 14 | echo file_get_contents(__DIR__ . '/banner.txt');
 15 | 
 16 | // Create a new php-server config file
 17 | if (in_array('new', $argv)) {
 18 |     if (is_file($file = getcwd() . '/php-server.ini')) {
 19 |         echo "The php-server.ini file already exists.\n";
 20 |     } else {
 21 |         $handle = fopen($file, 'w+');
 22 |         $ini = [
 23 |             'post_max_size' => ini_get('post_max_size'),
 24 |             'upload_max_filesize' => ini_get('upload_max_filesize'),
 25 |         ];
 26 |         $content = <<<EOD
 27 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 28 | ; php-server configuration file - https://github.com/natanfelles/php-server ;
 29 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 30 | php = PHP_BINARY
 31 | host = localhost
 32 | port = 8080
 33 | root = ./
 34 | autoindex = true
 35 | index = index.html index.php
 36 | error_reporting = E_ALL
 37 | 
 38 | [ini]
 39 | display_errors = 1
 40 | display_startup_errors = 1
 41 | max_execution_time = 30
 42 | post_max_size = {$ini['post_max_size']}
 43 | upload_max_filesize = {$ini['upload_max_filesize']}
 44 | ;opcache.preload = preload.php
 45 | 
 46 | xdebug.mode=develop
 47 | xdebug.var_display_max_depth = 10
 48 | xdebug.var_display_max_children = 256
 49 | xdebug.var_display_max_data = 1024
 50 | 
 51 | [server]
 52 | ENVIRONMENT = development
 53 | 
 54 | EOD;
 55 |         fwrite($handle, $content);
 56 |         fclose($handle);
 57 |         echo "The php-server.ini file was created.\n";
 58 |     }
 59 |     exit;
 60 | }
 61 | 
 62 | /**
 63 |  * @var array Server config
 64 |  */
 65 | $config = require __DIR__ . '/server_config.php';
 66 | 
 67 | if (in_array('-h', $argv) || in_array('--help', $argv)) {
 68 |     echo "Fine-tuning on the PHP built-in web server.\n";
 69 |     echo "Created by Natan Felles <natanfelles@gmail.com>\n";
 70 |     echo "Checking for the latest release...";
 71 | 
 72 |     $info = @file_get_contents(
 73 |         'https://api.github.com/repos/natanfelles/php-server/releases/latest',
 74 |         false,
 75 |         stream_context_create([
 76 |             'http' => [
 77 |                 'user_agent' => 'php-server ' . $config['server']['PHPSERVER_VERSION'],
 78 |                 'timeout' => 15,
 79 |             ],
 80 |         ])
 81 |     );
 82 | 
 83 |     echo "\r";
 84 | 
 85 |     if ($info && $info = json_decode($info)) {
 86 |         $version = ltrim($info->tag_name, 'v');
 87 | 
 88 |         if ($version == $config['server']['PHPSERVER_VERSION']) {
 89 |             echo "The latest php-server version ({$version}) is running.\n";
 90 |         } elseif ($version > $config['server']['PHPSERVER_VERSION']) {
 91 |             echo "A new release is available: Version {$version}.\n";
 92 |         }
 93 |     } else {
 94 |         echo "The current php-server version is {$config['server']['PHPSERVER_VERSION']}.\n";
 95 |     }
 96 | 
 97 |     echo "Check the repository at https://github.com/natanfelles/php-server\n";
 98 |     exit;
 99 | }
100 | 
101 | $ini = '';
102 | foreach ($config['ini'] as $key => $value) {
103 |     if (is_array($value)) {
104 |         foreach ($value as $val) {
105 |             $ini .= " -d {$key}={$val}";
106 |         }
107 |     } else {
108 |         $ini .= " -d {$key}={$value}";
109 |     }
110 | }
111 | 
112 | $options = getopt(null, ['php:', 'host:', 'port:', 'root:']);
113 | 
114 | $php = isset($options['php']) ? $options['php'] : $config['php'];
115 | $host = isset($options['host']) ? $options['host'] : $config['host'];
116 | $port = isset($options['port']) ? $options['port'] : $config['port'];
117 | $root = isset($options['root']) ? $options['root'] : $config['root'];
118 | $router = __DIR__ . '/server_router.php';
119 | 
120 | echo $function_color('Version:') . " {$config['server']['PHPSERVER_VERSION']}\n";
121 | echo $function_color('PHP Binary:') . " {$php}\n";
122 | echo $function_color('Document Root:') . " {$root}\n";
123 | echo $function_color('Web Address:') . " http://{$host}:{$port}\n";
124 | echo $function_color('Date:') . ' ' . date('r') . "\n\n";
125 | $root = strtr($root, [' ' => '\ ']);
126 | $router = strtr($router, [' ' => '\ ']);
127 | passthru("{$php}{$ini} -S {$host}:{$port} -t {$root} {$router}");
128 | 


--------------------------------------------------------------------------------
/src/functions.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Convert a number to computer size
  4 |  *
  5 |  * @param integer $size
  6 |  *
  7 |  * @return string
  8 |  */
  9 | $function_size_conversion = function ($size) {
 10 |     $units = [
 11 |         'B',
 12 |         'KB',
 13 |         'MB',
 14 |         'GB',
 15 |         'TB',
 16 |         'PB',
 17 |         'EB',
 18 |         'ZB',
 19 |         'YB',
 20 |     ];
 21 |     $power = $size > 0 ? floor(log($size, 1024)) : 0;
 22 |     return number_format($size / pow(1024, $power), $power ? 2
 23 |             : 0, '.', ',') . ' ' . $units[$power];
 24 | };
 25 | 
 26 | /**
 27 |  * Clean all server variables
 28 |  */
 29 | $function_clean_vars = function () {
 30 |     foreach (array_keys($GLOBALS) as $var) {
 31 |         if (in_array($var, [
 32 |             '_GET',
 33 |             '_POST',
 34 |             '_COOKIE',
 35 |             '_FILES',
 36 |             '_ENV',
 37 |             '_REQUEST',
 38 |             '_SERVER',
 39 |             'GLOBALS',
 40 |         ])) {
 41 |             continue;
 42 |         }
 43 |         unset($GLOBALS[$var]);
 44 |     }
 45 | };
 46 | 
 47 | /**
 48 |  * Get an order by link
 49 |  *
 50 |  * @param string $order_by
 51 |  * @param string $name
 52 |  *
 53 |  * @return string
 54 |  */
 55 | $function_order_link = function ($order_by, $name) {
 56 |     $href = $GLOBALS['relative_path'] . '?order_by=' . $order_by;
 57 |     $title = 'Order by ' . $name;
 58 |     $class = '';
 59 |     $icon = ' <span></span>';
 60 |     if (isset($_GET['order_by']) && $_GET['order_by'] === $order_by || !isset($_GET['order_by']) && $order_by === 'filename') {
 61 |         $class = ' class="active asc"';
 62 |         $icon = ' <span>&blacktriangle;</span>';
 63 |         if (!isset($_GET['order'])) {
 64 |             $href .= '&order=asc';
 65 |             $title .= ' asc';
 66 |             $icon = ' <span>&blacktriangledown;</span>';
 67 |             $class = ' class="active desc"';
 68 |         }
 69 |     }
 70 | 
 71 |     return "<th{$class} title=\"{$title}\"><a href=\"{$href}\">{$name}{$icon}</a></th>\n";
 72 | };
 73 | 
 74 | $function_path_href = function ($SplFileInfo) {
 75 |     $q = '';
 76 |     if ($SplFileInfo->isDir()) {
 77 |         if (isset($_GET['order_by']) && in_array($_GET['order_by'], [
 78 |                 'filename',
 79 |                 'size',
 80 |                 'owner',
 81 |                 'group',
 82 |                 'perms',
 83 |                 'mTime',
 84 |             ])) {
 85 |             $q .= '?order_by=' . $_GET['order_by'];
 86 |             if (isset($_GET['order']) && in_array($_GET['order'], ['asc', 'desc'])) {
 87 |                 $q .= '&order=' . $_GET['order'];
 88 |             }
 89 |         }
 90 |     }
 91 | 
 92 |     return $GLOBALS['relative_path'] . '/' . $SplFileInfo->getFilename() . $q;
 93 | };
 94 | 
 95 | $function_order_paths = function ($paths) {
 96 |     array_multisort(array_keys($paths), SORT_NATURAL | SORT_FLAG_CASE, $paths);
 97 | 
 98 |     if (isset($_GET['order_by']) && in_array($_GET['order_by'], [
 99 |             'filename',
100 |             'size',
101 |             'owner',
102 |             'group',
103 |             'perms',
104 |             'mTime',
105 |         ])) {
106 |         usort($paths, function ($path1, $path2) {
107 |             $order_by = $_GET['order_by'];
108 | 
109 |             if ($path1[$order_by] === $path2[$order_by]) {
110 |                 return 0;
111 |             }
112 | 
113 |             return $path1[$order_by] < $path2[$order_by] ? -1 : 1;
114 |         });
115 |     }
116 | 
117 |     if (isset($_GET['order']) && $_GET['order'] === 'asc') {
118 |         $paths = array_reverse($paths);
119 |     }
120 | 
121 |     $dirs = [];
122 |     $files = [];
123 | 
124 |     foreach ($paths as $path) {
125 |         $path['mTime'] = date('Y-m-d H:i:s', $path['mTime']);
126 |         $path['size'] = $path['isDir']
127 |             ? $path['size'] . ' item' . ($path['size'] < 2 ? '' : 's')
128 |             : $GLOBALS['function_size_conversion']($path['size']);
129 | 
130 |         if ($path['isDir']) {
131 |             $dirs[] = $path;
132 |         } else {
133 |             $files[] = $path;
134 |         }
135 |     }
136 | 
137 |     return array_merge($dirs, $files);
138 | };
139 | 
140 | $function_color = function ($text) {
141 |     return "\033[0;32m$text\033[0m";
142 | };
143 | 
144 | $function_parent_dir = function ($relative_path) {
145 |     if ($relative_path):
146 |         $query = isset($_GET['php-server']) ? '?php-server=' . $_GET['php-server'] : '';
147 |         $relative_path = explode('/', $relative_path);
148 |         array_pop($relative_path);
149 |         $relative_path = implode('/', $relative_path);
150 |         $relative_path .= $relative_path ? $query : '/' . $query;
151 |         ?>
152 |         <p class="half"><a href="<?= $relative_path ?>">Parent dir</a></p>
153 |     <?php endif;
154 | };
155 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # PHP Server
  2 | 
  3 | [![Latest release](https://img.shields.io/github/release/natanfelles/php-server.svg?colorB=green&label=Latest%20release&style=popout)](https://github.com/natanfelles/php-server/releases)
  4 | [![PHP version](https://img.shields.io/packagist/php-v/natanfelles/php-server.svg?colorB=blueviolet&label=PHP%20version&style=flat)](https://php.net/downloads.php)
  5 | [![Packagist downloads](https://img.shields.io/packagist/dt/natanfelles/php-server.svg?colorB=%23f28d1a&label=Packagist%20downloads&style=flat)](https://packagist.org/packages/natanfelles/php-server)
  6 | 
  7 | Fine-tuning on the PHP built-in web server
  8 | 
  9 | ![PHP Built-in web server autoindex](https://i.imgur.com/dE7B2LJ.png)
 10 | 
 11 | > See release notes at: https://github.com/natanfelles/php-server/releases
 12 | 
 13 | ## Installation
 14 | 
 15 | ### Composer
 16 | 
 17 | Open your terminal and run:
 18 | 
 19 | ```sh
 20 | composer global require natanfelles/php-server
 21 | ```
 22 | 
 23 | Add the composer bin path to your *.bashrc*:
 24 | 
 25 | ```sh
 26 | echo 'export PATH="$PATH:$HOME/.config/composer/vendor/bin"' >> ~/.bashrc
 27 | ```
 28 | 
 29 | Run:
 30 | 
 31 | ```sh
 32 | source ~/.bashrc
 33 | ```
 34 | 
 35 | ### Manual
 36 | 
 37 | Download and extract the *php-server* project folder.
 38 | 
 39 | Add the php-server alias to your *.bashrc*:
 40 | 
 41 | ```sh
 42 | echo 'alias php-server="~/php-server/bin/php-server"' >> ~/.bashrc
 43 | ```
 44 | 
 45 | Run:
 46 | 
 47 | ```sh
 48 | source ~/.bashrc
 49 | ```
 50 | 
 51 | ## Config
 52 | 
 53 | You can run the php-server in any folder of your operating system.
 54 | 
 55 | Each time you run the *php-server* command, it will look up if there is a file named *php-server.ini* in the current directory. If found, your settings will override the default settings.
 56 | 
 57 | A quick example file content is:
 58 | 
 59 | ```ini
 60 | php = PHP_BINARY
 61 | host = localhost
 62 | port = 8080
 63 | root = ./public
 64 | autoindex = true
 65 | index = index.php
 66 | error_reporting = E_ALL
 67 | 
 68 | [ini]
 69 | display_errors = 1
 70 | display_startup_errors = 1
 71 | max_execution_time = 360
 72 | post_max_size = 200M
 73 | upload_max_filesize = 200M
 74 | 
 75 | [server]
 76 | ENVIRONMENT = development
 77 | ```
 78 | 
 79 | > You can use the command `php-server new` to create a new configuration file in the current directory.
 80 | 
 81 | ### Explanation
 82 | 
 83 | #### General Vars
 84 | 
 85 | | Key | Default Value| Description |
 86 | | --------------- | --- | --- |
 87 | | php | [PHP_BINARY](http://php.net/manual/en/reserved.constants.php#constant.php-binary) | PHP binary path or command |
 88 | | host | localhost | Server host |
 89 | | port | 8080 | Server host port |
 90 | | root | [getcwd()](http://php.net/manual/en/function.getcwd.php) | Document root. The location that will be the public root of your website. |
 91 | | autoindex | true | Determines if the server will list directory contents if it does not find an index file. |
 92 | | index | index.html index.php | The names of the index files separated by spaces. |
 93 | | error_reporting | [E_ALL](http://php.net/manual/en/errorfunc.constants.php#errorfunc.constants.errorlevels.e-all) | Sets the [level of errors](http://php.net/manual/en/function.error-reporting.php) that will be reported. |
 94 | 
 95 | #### Sections
 96 | 
 97 | | Section | Description |
 98 | | --- | --- |
 99 | | ini |  Used to set custom [php.ini directives](http://php.net/manual/en/ini.list.php). |
100 | | server | Used to set custom [Server and execution environment information](http://php.net/manual/en/reserved.variables.server.php). |
101 | 
102 | Knowing this, just create (if necessary) a php-server.ini file, run the server and you're done.
103 | 
104 | ## Run
105 | 
106 | As you can see in the [config](#config). You can create a php-server.ini file to leave the settings of each project already pre-established.
107 | 
108 | But, you can also simply run `php-server` and the server will already be available at [http://localhost:8080](http://localhost:8080).
109 | 
110 | The php-server command can receive some parameters and they are:
111 | 
112 | | Parameter | Description |
113 | | --- | --- |
114 | | --php | PHP binary path or command  |
115 | | --host | Server host |
116 | | --port | Server host port |
117 | | --root | Document root |
118 | 
119 | For example, to run the server on a different port:
120 | 
121 | ```sh
122 | php-server --port 8081
123 | ```
124 | 
125 | Or, also with a different version of PHP than the default:
126 | 
127 | ```sh
128 | php-server --php php8.4 --port 8081
129 | ```
130 | 
131 | Right. You get the idea. If you want to run on a different host you can add the host to the [hosts file](https://en.wikipedia.org/wiki/Hosts_(file)) of your operating system.
132 | 
133 | ## Contribute
134 | 
135 | Hello, how nice that you are reading this.
136 | 
137 | If you have any idea to improve this project or something is not working as it should, do not hesitate to open an [issue](https://github.com/natanfelles/php-server/issues) and if you have solved the problem feel free to open a [Pull Request](https://github.com/natanfelles/php-server/pulls).
138 | 


--------------------------------------------------------------------------------
/src/pages/_template.php:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html>
  2 | <html lang="en">
  3 | <head>
  4 |     <meta charset="utf-8">
  5 |     <title><?= htmlentities($title) ?></title>
  6 |     <link rel="shortcut icon" href="data:image/png;base64,<?= base64_encode(file_get_contents(__DIR__ . '/favicon.png')) ?>">
  7 |     <style>
  8 |         body {
  9 |             margin: 20px;
 10 |             font-family: "Fira Sans", "Source Sans Pro", Helvetica, Arial, sans-serif;
 11 |             font-weight: 400;
 12 |             font-size: 1rem;
 13 |             line-height: 1.5rem;
 14 |             color: #333;
 15 |             background: #f2f2f2;
 16 |         }
 17 | 
 18 |         a {
 19 |             color: #369;
 20 |         }
 21 | 
 22 |         a:hover {
 23 |             color: #ae508d;
 24 |             border-color: #ae508d;
 25 |             outline: 0;
 26 |         }
 27 | 
 28 |         .version {
 29 |             text-align: right;
 30 |         }
 31 | 
 32 |         .version a {
 33 |             text-decoration: none;
 34 |             color: #333;
 35 |         }
 36 | 
 37 |         h1, h1 a {
 38 |             line-height: 3rem;
 39 |             margin: 0 0 1.5rem;
 40 |             overflow: hidden;
 41 |             text-rendering: optimizeLegibility;
 42 |             color: #793862;
 43 |             text-decoration: none;
 44 |         }
 45 | 
 46 |         h1 a.active {
 47 |             color: #369;
 48 |         }
 49 | 
 50 |         h1::after {
 51 |             display: table;
 52 |             width: 100%;
 53 |             content: " ";
 54 |             margin-top: -1px;
 55 |             border-bottom: 1px dotted;
 56 |         }
 57 | 
 58 |         p {
 59 |             margin: 10px 0;
 60 |         }
 61 | 
 62 |         table {
 63 |             border: 1px solid #ccc;
 64 |             border-collapse: collapse;
 65 |             text-align: left;
 66 |             width: 100%;
 67 |         }
 68 | 
 69 |         tr {
 70 |             border-bottom: 1px solid #ccc;
 71 |         }
 72 | 
 73 |         tr:nth-child(even) {
 74 |             background: #e6e6e6
 75 |         }
 76 | 
 77 |         tr:nth-child(odd) {
 78 |             background: #fff
 79 |         }
 80 | 
 81 |         tr:hover {
 82 |             background: #ddd;
 83 |         }
 84 | 
 85 |         td, th {
 86 |             border-bottom: 1px solid #ccc;
 87 |             text-indent: .5rem;
 88 |             padding: 2px;
 89 |         }
 90 | 
 91 |         th {
 92 |             border-color: #c4c9df;
 93 |             background: #c4c9df;
 94 |             border-right: 1px dotted #ccc;
 95 |         }
 96 | 
 97 |         th a {
 98 |             color: #333;
 99 |             text-decoration: none;
100 |             padding: .25rem 0;
101 |             width: 100%;
102 |             display: block;
103 |         }
104 | 
105 |         .version a:hover,
106 |         th a:hover {
107 |             color: #793862;
108 |         }
109 | 
110 |         th a span {
111 |             float: right;
112 |             min-width: 20px;
113 |             display: block;
114 |         }
115 | 
116 |         td span {
117 |             color: gray;
118 |             min-width: 30px;
119 |             display: inline-block;
120 |             text-indent: 0;
121 |         }
122 | 
123 |         pre, code,
124 |         .file-code .lines span {
125 |             margin: 0;
126 |             font-family: "Fira Mono", "Source Code Pro", monospace;
127 |             font-weight: 400;
128 |             font-size: 1rem;
129 |             line-height: 1.5rem;
130 |             -moz-tab-size: 4;
131 |             -o-tab-size: 4;
132 |             tab-size: 4;
133 |         }
134 | 
135 |         .file-code {
136 |             border: 1px gray solid;
137 |             padding: 0;
138 |             background: #fff;
139 |             overflow-x: auto;
140 |             width: 100%;
141 |             margin: 0 auto;
142 |         }
143 | 
144 |         .file-code > * {
145 |             float: left;
146 |         }
147 | 
148 |         .file-code .lines {
149 |             background: #e6e6e6;
150 |             border-right: 1px gray solid;
151 |             padding: 0 5px;
152 |             min-width: 20px;
153 |         }
154 | 
155 |         .file-code .lines span {
156 |             display: block;
157 |         }
158 | 
159 |         .file-code .code {
160 |             width: 200px;
161 |             padding-left: 5px;
162 |             font-family: "Fira Mono", "Source Code Pro", monospace;
163 |         }
164 | 
165 |         .file-code .code span {
166 |             white-space: pre;
167 |         }
168 | 
169 |         .date {
170 |             float: right;
171 |             font-size: .875rem;
172 |         }
173 | 
174 |         .error {
175 |             background: #f4dfdf;
176 |             border: 1px solid #eabfbf;
177 |             padding: .75rem;
178 |             margin: 1.5rem 0;
179 |             overflow: hidden;
180 |         }
181 | 
182 |         #search {
183 |             float: right;
184 |             background: #fff;
185 |             border: 1px solid #ccc;
186 |             padding: .125rem .5rem;
187 |             box-shadow: inset 0 1px 2px rgba(0, 0, 0, .2);
188 |             color: #333;
189 |         }
190 | 
191 |         #search:focus {
192 |             border-color: #369;
193 |         }
194 | 
195 |         .half {
196 |             width: 50%;
197 |             float: left;
198 |         }
199 |     </style>
200 | </head>
201 | <body>
202 | <?php
203 | if (strpos($title, 'Index of ') === 0 || strpos($title, 'File ') === 0) {
204 |     $dirs = explode('/', $title);
205 |     $pre = $dirs[0];
206 |     unset($dirs[0]);
207 | 
208 |     $query = isset($_GET['php-server']) ? '?php-server=' . $_GET['php-server'] : '';
209 | 
210 |     $dirs = array_values($dirs);
211 |     $breadcrumbs = '';
212 |     for ($i = 0; $i < count($dirs); $i++) {
213 |         $dir = '';
214 |         for ($s = 0; $s <= $i; $s++) {
215 |             $dir .= '/' . $dirs[$s];
216 |         }
217 |         $dir .= $query;
218 |         $breadcrumbs .= "<a href=\"{$dir}\" class=\"uri\" data-id=\"{$i}\">"
219 |             . ($i === 0 ? '' : '/')
220 |             . "{$dirs[$i]}</a>";
221 |     }
222 | 
223 |     $title = $pre . ' <a href="/" class="uri" data-id="-1">/</a>' . $breadcrumbs;
224 | }
225 | ?>
226 | <h1><?= $title ?></h1>
227 | <p>
228 |     PHP <?= phpversion() ?> built-in web server -
229 |     <a href="/?php-server=phpinfo">info</a> <span class="date"><?= date('r') ?></span>
230 | </p>
231 | 
232 | <?php require_once __DIR__ . "/{$page}.php"; ?>
233 | 
234 | <p class="version">
235 |     <a href="https://github.com/natanfelles/php-server/releases/tag/v<?= $_SERVER['PHPSERVER_VERSION'] ?>" target="_blank"><?= 'php-server v' . $_SERVER['PHPSERVER_VERSION'] ?></a>
236 | </p>
237 | 
238 | <script type="text/javascript">
239 |     var uris = document.getElementsByClassName('uri');
240 |     for (var i = 0; i < uris.length; i++) {
241 |         uris[i].addEventListener('mouseover', function () {
242 |             for (var i = 0; i < uris.length; i++) {
243 |                 if (uris[i].getAttribute('data-id') <= this.getAttribute('data-id')) {
244 |                     uris[i].classList.add('active');
245 |                 }
246 |             }
247 |         }, true);
248 |         uris[i].addEventListener('mouseout', function () {
249 |             for (var i = 0; i < uris.length; i++) {
250 |                 uris[i].classList.remove('active');
251 |             }
252 |         }, true);
253 |     }
254 |     var search = document.getElementById('search');
255 |     if (search) {
256 |         search.value = '';
257 |         search.focus();
258 |         search.onkeyup = function () {
259 |             var filter = this.value.toUpperCase();
260 |             var table = document.getElementsByTagName('table')[0];
261 |             var tr = table.getElementsByTagName('tr');
262 |             for (var i = 1; i < tr.length; i++) {
263 |                 if (tr[i].innerText.toUpperCase().indexOf(filter) > -1) {
264 |                     tr[i].style.display = '';
265 |                 } else {
266 |                     tr[i].style.display = 'none';
267 |                 }
268 |             }
269 |         };
270 |         window.addEventListener('keydown', function (e) {
271 |             if (e.keyCode === 114 || (e.ctrlKey && e.keyCode === 70)) {
272 |                 e.preventDefault();
273 |                 search.focus();
274 |             }
275 |             return false;
276 |         });
277 |     }
278 | </script>
279 | </body>
280 | </html>
281 | 


--------------------------------------------------------------------------------