Update with new features

README.md

@@ -1,6 +1,18 @@
 # Shorty
 
-Shorty is a simple URL shortener for PHP.
+This is a fork of Shorty, a simple URL shortener for PHP.
+
+Shortened URLs are 301 redirects which will still display open graph previews when shared on social media.
+
+## Changes
+
+Changes in this fork made by @ttscoff ([Brett Terpstra](https://brettterpstra.com)):
+
+- Allow limiting shortening to one domain
+- Allow forwarding of paths containing hyphens or which are not found in the database to be forwarded to a root url
+- Allow appending query strings to urls before shortening or forwarding
+- Accept `format=qr` and `size=XXX` to create QR codes for shortened urls
+- Add longURL keys to JSON and XML output
 
 ## Installation
 
@@ -10,7 +22,7 @@ Shorty is a simple URL shortener for PHP.
 
 3\. Configure your webserver.
 
-For **Apache**, edit your `.htaccess` file with the following:
+For **Apache**, edit your `.htaccess` file with the following (rename ht.access to .htaccess):
 
     RewriteEngine On
     RewriteCond %{REQUEST_FILENAME} !-f
@@ -27,6 +39,20 @@ For **Nginx**, add the following to your server declaration:
 
 4\. Edit the `config.php` file.
 
+## Config options
+
+Set `$hostname` to the base url of your shortener.
+
+By default urls from any domain can be shortened. To limit shortening to a specific domain, set `$site_specific = true` in `config.php` and add a domain for `$target`.
+
+If a path is passed that contains hyphens or is otherwise not found, Shorty will forward to the url specified in `$long_redirect`, with the path appended to the base url. For example, if `$long_redirect` is `https://blog.example.com/` and somebody tries to access `example.com/test-post`, the request will be forwarded to `https://blog.example.com/test-post`.
+
+If you would like a query string (such as Google UTM parameters) appended to urls before shortening, set `$query_string`. If you're using this as a general shortener and expect to pass it urls that already contain query strings, leave this empty ('') to avoid double query strings.
+
+Set mySQL database name, host, user, and password in the `$connection` setting.
+
+See the comments in `config.php` for more options on character sets and randomizing short urls to make them less guessable.
+
 ## Generating short URLs
 
 To generate a short URL, simply pass in a `url` query parameter to your Shorty installation:
@@ -39,12 +65,19 @@ This will return a shortened URL such as:
 
 When a user opens the short URL they will be redirected to the long URL location.
 
-By default, Shorty will generate an HTML response for all saved URLs.
-You can alter the response format by passing in a `format` query parameter.
+By default, Shorty will output a plain text version of the shortened URL. This is ideal for calling from scripts and command line applications. If you'd like to have a full HTML link tag output, add `&format=html` to your call.
+
+    http://example.com/?url=http://www.google.com&format=html
+
+To generate a QR code for a shortened URL, use `format=qr`. By default this will generate a 200x200px PNG file. You can use `size=XXX` to set a size between 100 and 500 pixels if desired.
+
+The possible formats are `html`, `xml`, `text`, `json`, and `qr`. XML and JSON responses will contain keys for `url` and `longURL`.
+
+## Analytics
 
-    http://example.com/?url=http://www.google.com&format=text
+The mySQL database of shortened urls will contain basic analytics such as hit counts and access dates. There is currently no interface for displaying this information.
 
-The possible formats are `html`, `xml`, `text`, and `json`.
+Note that when you share a shortened URL to social media, the preview generators for those sites will repeatedly make hits on the URL. Shorty makes no distinction between those and actual visits, so these numbers can't be used for sales analytics or anything like that, other than to see how widely your shortened url may have spread.
 
 ## Whitelist
 

config.php

@@ -1,6 +1,15 @@
 <?php
 // Hostname for your URL shortener
-$hostname = 'http://example.com';
+$hostname = 'https://example.com';
+
+// If you only want to allow urls from a specific domain to be shortened
+$site_specific = false;
+// The hostname to limit to (no protocol or trailing slash)
+$target = 'example.com';
+// If the short url contains dashes or isn't found, append it to this url
+$long_redirect = 'https://example.com/blog/';
+// query string to add to long url before shortening or forwarding
+$query_string = '?utm_source=blog&utm_medium=web&utm_campaign=share_button';
 
 // PDO connection to the database
 $connection = new PDO('mysql:dbname=shorty;host=localhost', 'user', 'password');

ht.access

@@ -0,0 +1,4 @@
+RewriteEngine On
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteRule ^(.*)$ index.php?q=$1 [QSA,L]

index.php

@@ -1,4 +1,8 @@
 <?php
+// ini_set('display_errors', 1);
+// ini_set('display_startup_errors', 1);
+// error_reporting(E_ALL);
+
 require './shorty.php';
 require './config.php';
 
@@ -8,5 +12,40 @@
 $shorty->set_salt($salt);
 $shorty->set_padding($padding);
 
+$shorty->set_site_specific($site_specific);
+
+/**
+ * Ensure $target does not have protocol or trailing slash
+ */
+if (preg_match('/^https?:\/\//', $target)) {
+	$target = str_replace('https://', '', $target);
+	$target = str_replace('http://', '', $target);
+}
+if (preg_match('/\/$/', $target)) {
+	$target = str_replace('/', '', $target);
+}
+$shorty->set_target($target);
+
+/**
+ * Ensure $long_redirect has protocol and trailing slash
+ */
+if (!preg_match('/^https?\/\//', $long_redirect)) {
+	$long_redirect = 'https://' . $long_redirect;
+}
+if (!preg_match('/\/$/', $long_redirect)) {
+	$long_redirect = $long_redirect . '/';
+}
+$shorty->set_long_redirect($long_redirect);
+
+/**
+ * Ensure $query_string starts with question mark
+ */
+if (isset($query_string) && !preg_match('/^$/', $query_string)) {
+	if (!preg_match('/^\?/', $query_string)) {
+		$query_string = '?' . $query_string;
+	}
+	$shorty->set_query_string($query_string);
+}
+
 $shorty->run();
 ?>