release: 2.0

Author: szczyglis-dev

.gitignore

@@ -1,3 +1,6 @@
-temp/
-cookies/
-.idea/
+/cookies/*
+/cache/*
+/.idea/*
+
+!/cookies/index.html
+!/cache/index.html

README.md

@@ -1,36 +1,48 @@
-# [PHP] Ultra Small Proxy
-### PHP 5.6+ / PHP 7
+# [PHP] Ultra Small Proxy 2
+### PHP: 7.0+
 
-Current version: 1.1
+Current version: **2.0** | 2022-02-23
 
 Ultra Small Proxy is a light-weight proxy written in PHP. 
 
-## Features:
+## Key Features:
 
 - Proxy server written in PHP
 - Easy usage and integration
-- Standalone and external usage (it is only one PHP class)
+- Standalone and external usage (it is only one PHP file)
 - Simple and light-weight
 - Sessions support
 - Sending and receiving cookies
+- Sending and receiving HTTP headers **(NEW in 2.0+)**
+- Cache and assets storage **(NEW in 2.0+)**
+- Domain and IP/host connection support **(NEW in 2.0+)**
+- HTTP Basic Auth support **(NEW in 2.0+)**
 - GET and POST connections
 - Forms submiting support
 - POST variables redirecting
-- Toolbar with address bar and connection debugger
-- URLs rewriting at runtime (links, images, css, javascript, etc.)
+- Toolbar with address bar, configuration and debugger
+- URLs rewriting/proxying at runtime (links, images, css, javascript, etc.)
 - 2 different methods for URLs rewriting: Regex (with preg_replace) and DOM XML (with libxml / DOMDocument)
-- PHP 5 and PHP 7 supported
+- PHP 7.0+ supported
 
+## Requirements:
+
+- PHP 7.0+
+- CURL extension
+- DOM XML extension
 
 ## Usage example:
 ```
 <?php
 
-/* include class */
+/* include classes */
 include __DIR__.'/UltraSmallProxy.php';  
 
-/* instantiate proxy */
-$proxy = new UltraSmallProxy();
+/* instantiate config */
+$config = new UltraSmallProxyConfig();
+
+/* instantiate proxy with config */
+$proxy = new UltraSmallProxy($config);
 
 /* specify start page and load it! */
 $output = $proxy->load('https://github.com'); 
@@ -40,10 +52,13 @@ echo $output;
 
 ```
 Make sure to have write permissions to `./cookies` directory.
+Make sure to have write permissions to `./cache` directory.
+
+### BE CAREFUL: directory with cookies should not be available to the public!
 
 ## Screenshot:
 
-![proxy_github](https://user-images.githubusercontent.com/61396542/75244037-4c66bb00-57cb-11ea-82ee-c51c7736653b.png)
+![proxy](https://user-images.githubusercontent.com/61396542/155353063-fde84995-6e43-46c4-8a1c-b8b4772e6dfc.png)
 
 
 Open `loopback.php`if you want to test proxy features like sessions support, POST vars redirecting, form submiting and more, e.g.:
@@ -59,62 +74,96 @@ $output = $proxy->load('http://localhost/loopback.php');
 - `loopback.php` - loopback for test features like session support, form vars sending, and cookies redirecting
 
 
-## Options:
+## Basic usage:
 
 ```
-$proxy = new UltraSmallProxy($init = true, $rewriteMode = 'regex', $attachToolbar = true);
-```
-`$init` - autostarts listening for URLs in QUERY STRING, set to `false` if you want to disable this feature, default: `true`
-
-`$rewriteMode` - method used to URLs rewriting, possible values: `regex` (rewriting by regular expressions), `dom` (rewriting by DOM XML), `null` (disable rewriting), default: `regex`
+$config = new UltraSmallProxyConfig();
+$proxy = new UltraSmallProxy($config);
 
-`$attachToolbar` - appends toolbar DIV, CSS and JS to output when `true`, set to `false` if you want to disable this feature, default: `true`
+echo $proxy->load('https://github.com');
+```
 
+## Configuration:
 
 ```
 $output = $proxy->load('https://github.com', $force = false); 
 ```
 `$force` - if set to `false` then URLs given from QUERY STRING are always overwriting URLs passed here, set to `true` if you want to reverse this behaviour, default: `false`
 
 
-## Public methods:
+## Config values:
 
 Before page load:
 
-`$proxy->setUserAgent($agent)` - sets custom User Agent, defaul: `Mozilla/4.0 (compatible;)`
+`$config->set('init', bool);`- auto-init `true|false`, default: `true`
 
-`$proxy->setRewriteMode($rewriteMode)` - sets URLs rewrite mode: `regex`|`dom`|`null`
+`$config->set('source', 'string');` - input source `domain|ip`, default: `domain`
 
-`$proxy->setMethod($method)` - sets request method: `GET`|`POST`
+`$config->set('raw', bool);` - raw download `true|false`, default: `false`
 
-`$proxy->setCookiesDir($path)` - sets directory for proxied cookies storage, default: `cookies`
+`$config->set('toolbar', bool);` - attach toolbar  `true|false`, default: `true`
 
+`$config->set('user_agent', 'string');` - user agent, default: `Mozilla/4.0 (compatible;)`
 
+`$config->set('timeout', int);` - curl timeout, default: `120`
 
-After page load:
+`$config->set('max_redirects', int);` - curl max redirects, default: `10`
 
-`$siteCookies = $proxy->getSiteCookies()` - returns cookies[] received from proxied site
+`$config->set('cookies_dir', 'string');` - cookies directory, default: `./cookies`
 
-`$localCookies = $proxy->getLocalCookies()` - returns cookies[] stored localy and sended to proxied site
+`$config->set('cache_dir', 'string');` - cache directory, default: `./cache`
 
-`$status = $proxy->getStatus()` - returns connection status[]
+`$config->set('method', 'string');` - request method `GET|POST`
 
-`$sid = $proxy->getSid()` - returns proxied PHPSESSID if exists
+`$config->set('rewrite', 'string');` - rewrite method `REGEX,REGEX2,REGEX3,DOM`, default: `REGEX2`
 
-`$isError = $proxy->isError()` - returns `true` if any error occured, `false` if not
+`$config->set('rewrite_url', bool);` - enable URL rewriting `true|false`, default: `true`
 
-`$isCurlError = $proxy->isCurlError()` - returns `true` if curl error occured, `false` if not
+`$config->set('rewrite_img', bool);` - enable IMG rewriting `true|false`, default: `true`
 
-`$errorMessages = $proxy->getErrorMessages()` - returns error messages[] if occured
+`$config->set('rewrite_js', bool);` - enable JS rewriting `true|false`, default: `true`
 
+`$config->set('rewrite_form', bool);` - enable FORM ACTION rewriting `true|false`, default: `true`
 
- 
-Other:
+`$config->set('rewrite_css', bool);` - enable CSS rewriting `true|false`, default: `true`
+
+`$config->set('rewrite_video', bool);` - enable VIDEO rewriting `true|false`, default: `true`
+
+`$config->set('rewrite_ip', bool);` - enable domain to IP+Host resolve `true|false`, default: `true`
 
-`$parsed = $proxy->parse($html)` - parse/rewrite URLs in custom html content with selected `$rewriteMode`
+`$config->set('assets', 'string');` - assets proxying mode `REDIRECT|CURL`, default: `REDIRECT`
 
+`$config->set('is_cfg', bool);` - show options `true|false`, default: `false`
 
+`$config->set('is_dbg', bool);` - show debug `true|false`, default: `false`
 
+`$config->set('htaccess_user', 'string');` - HTTP AUTH user
+
+`$config->set('htaccess_pass', 'string');` - HTTP AUTH password
+
+
+## Public methods:
+
+After page load:
+
+`$siteCookies = $proxy->cookie->getSiteCookies()` - returns cookies[] received from proxied site
+
+`$localCookies = $proxy->cookie->getLocalCookies()` - returns cookies[] stored localy and sended to proxied site
+
+`$status = $proxy->http->getStatus()` - returns connection status[]
+
+`$headers = $proxy->http->getHeaders()` - returns received headers[]
+
+`$sid = $proxy->getSid()` - returns proxied PHPSESSID if exists
+
+`$errors = $proxy->getErrors()` - returns error messages[] if occured
+
+ 
+Other:
+
+`$parsed = $proxy->render($html)` - parse/rewrite URLs in custom html content with selected `$rewriteMode`
+
+---
 
 ### Ultra Small Proxy is free to use but if you liked then you can donate project via BTC: 
 
@@ -126,9 +175,7 @@ or by PayPal:
 
 Enjoy!
 
-
-
-MIT License | 2020 Marcin 'szczyglis' Szczygliński
+MIT License | 2022 Marcin 'szczyglis' Szczygliński
 
 https://github.com/szczyglis-dev/php-ultra-small-proxy