paulgoughbooks_old
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
paulgoughbooks_old / trunk / system / HTTP / CLIRequest.php
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\HTTP; use Config\App; /** * Class CLIRequest * * Represents a request from the command-line. Provides additional * tools to interact with that request since CLI requests are not * static like HTTP requests might be. * * Portions of this code were initially from the FuelPHP Framework, * version 1.7.x, and used here under the MIT license they were * originally made available under. * * http://fuelphp.com * * @package CodeIgniter\HTTP */ class CLIRequest extends Request { /** * Stores the segments of our cli "URI" command. * * @var array */ protected $segments = []; /** * Command line options and their values. * * @var array */ protected $options = []; /** * Set the expected HTTP verb * * @var string */ protected $method = 'cli'; //-------------------------------------------------------------------- /** * Constructor * * @param App $config */ public function __construct(App $config) { parent::__construct($config); // Don't terminate the script when the cli's tty goes away ignore_user_abort(true); $this->parseCommand(); } //-------------------------------------------------------------------- /** * Returns the "path" of the request script so that it can be used * in routing to the appropriate controller/method. * * The path is determined by treating the command line arguments * as if it were a URL - up until we hit our first option. * * Example: * php index.php users 21 profile -foo bar * * // Routes to /users/21/profile (index is removed for routing sake) * // with the option foo = bar. * * @return string */ public function getPath(): string { $path = implode('/', $this->segments); return empty($path) ? '' : $path; } //-------------------------------------------------------------------- /** * Returns an associative array of all CLI options found, with * their values. * * @return array */ public function getOptions(): array { return $this->options; } //-------------------------------------------------------------------- /** * Returns the path segments. * * @return array */ public function getSegments(): array { return $this->segments; } //-------------------------------------------------------------------- /** * Returns the value for a single CLI option that was passed in. * * @param string $key * * @return string|null */ public function getOption(string $key) { return $this->options[$key] ?? null; } //-------------------------------------------------------------------- /** * Returns the options as a string, suitable for passing along on * the CLI to other commands. * * Example: * $options = [ * 'foo' => 'bar', * 'baz' => 'queue some stuff' * ]; * * getOptionString() = '-foo bar -baz "queue some stuff"' * * @return string */ public function getOptionString(): string { if (empty($this->options)) { return ''; } $out = ''; foreach ($this->options as $name => $value) { // If there's a space, we need to group // so it will pass correctly. if (strpos($value, ' ') !== false) { $value = '"' . $value . '"'; } $out .= "-{$name} $value "; } return trim($out); } //-------------------------------------------------------------------- /** * Parses the command line it was called from and collects all options * and valid segments. * * NOTE: I tried to use getopt but had it fail occasionally to find * any options, where argv has always had our back. */ protected function parseCommand() { // Since we're building the options ourselves, // we stop adding it to the segments array once // we have found the first dash. $options_found = false; $argc = $this->getServer('argc', FILTER_SANITIZE_NUMBER_INT); $argv = $this->getServer('argv'); // We start at 1 since we never want to include index.php for ($i = 1; $i < $argc; $i ++) { // If there's no '-' at the beginning of the argument // then add it to our segments. if (! $options_found && strpos($argv[$i], '-') !== 0) { $this->segments[] = filter_var($argv[$i], FILTER_SANITIZE_STRING); continue; } $options_found = true; if (strpos($argv[$i], '-') !== 0) { continue; } $arg = filter_var(str_replace('-', '', $argv[$i]), FILTER_SANITIZE_STRING); $value = null; // If the next item starts with a dash it's a value if (isset($argv[$i + 1]) && strpos($argv[$i + 1], '-') !== 0) { $value = filter_var($argv[$i + 1], FILTER_SANITIZE_STRING); $i ++; } $this->options[$arg] = $value; } } //-------------------------------------------------------------------- } |
Commits for paulgoughbooks_old/trunk/system/HTTP/CLIRequest.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |