This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

initial commit

  • Loading branch information...
ericoc committed Jul 13, 2012
0 parents commit 3dc6cb8b986a49ff2bbf733c39d91e7299bfa871
Showing with 2,232 additions and 0 deletions.
  1. +11 −0 .htaccess
  2. +6 −0 AUTHOR
  3. +191 −0 README
  4. +5 −0 TODO
  5. +4 −0 admin/.htaccess
  6. +1 −0 admin/.htpasswd
  7. +650 −0 admin/dumb.txt
  8. +377 −0 admin/index.php
  9. +377 −0 admin/index.phps
  10. +18 −0 config.php
  11. +128 −0 functions.php
  12. +82 −0 gawsh.css
  13. +137 −0 gawsh.sql
  14. +79 −0 go.php
  15. +163 −0 index.php
  16. +3 −0 robots.txt
@@ -0,0 +1,11 @@
ErrorDocument 404 /go.php?x=404
ErrorDocument 403 /go.php?x=403
RewriteEngine On
RewriteCond %{HTTP_HOST} !^gaw\.sh$ [NC]
RewriteRule ^(.*)$ http://gaw.sh/$1 [L,R=301]
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} !-d
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} !-f
RewriteRule ^(.*)$ /go.php?x=$1 [L]
6 AUTHOR
@@ -0,0 +1,6 @@
GAW.SH URL SHORTENER! \o/
http://gaw.sh/
by Eric O'Callaghan
http://ericoc.com/
eric@ericoc.com
191 README
@@ -0,0 +1,191 @@
================================================================================
GAW.SH URL SHORTENER
Eric O'Callaghan
2011-11-11
http://gaw.sh/ is a simple URL shortener which I created mostly over a two week vacation using PHP with a MySQL database containing two tables ("urls" and "visits")
My design skills suck, but it works; CSS is at http://gaw.sh/gawsh.css (Thanks to Jico for the alternating table row background colors tip! see "(tr:nth-child...)")
================================================================================
The following section describes most of the main/index page of http://gaw.sh/
The source for this file can be found at: http://gaw.sh/index.phps
1. ADDING
* Check that URL actually exists and does not return 404
* http://php.net/manual/en/book.curl.php
* If they gave an optional, custom alias:
* Make sure it is alpha-numeric and not taken
* Checks URL domain name against:
* Dumb domain list
- Mostly other URL shorteners, localhost, gaw.sh itself, etc...
* Spamhaus Domain Block List (DBL)
- http://www.spamhaus.org/dbl/
* SURBL
- http://www.surbl.org/
* URIBL
- http://www.uribl.com/
* Checks domain name IP address and authoritative name servers against:
* Spamhaus ZEN (SBL, SBLCSS, XBL and PBL)
- http://www.spamhaus.org/zen/
* If everything goes well and checks out, we add a URL to the "urls" table of the MySQL database, then...
===
mysql> show columns from urls;
+--------+------------------+------+-----+---------+----------------+
| Field | Type | Null | Key | Default | Extra |
+--------+------------------+------+-----+---------+----------------+
| id | int(10) unsigned | NO | PRI | NULL | auto_increment |
| alias | varchar(50) | NO | UNI | NULL | |
| url | text | NO | | NULL | |
| ip | varchar(128) | NO | | NULL | |
| time | varchar(15) | NO | | NULL | |
| status | varchar(2) | NO | | NULL | |
+--------+------------------+------+-----+---------+----------------+
6 rows in set (0.00 sec)
===
* If they did not give an optional custom alias:
* Generate one using the base36 of auto-incremented numeric database ID (from MySQL "urls" table)
- $shorturl = base_convert($id, 10, 36);
* If the generated one is also taken:
- Keep generating new ones using base36 of random generated number (0-10), followed by numeric database ID, and UNIX time until we find something that is not taken
- $shorturl = base_convert(rand(0,10).$id.time(), 10, 36);
* Example data:
===
mysql> select * from urls order by id desc limit 1;
+------+---------+---------------------+---------------+------------+--------+
| id | alias | url | ip | time | status |
+------+---------+---------------------+---------------+------------+--------+
| 1244 | 8static | http://8static.com/ | 98.221.114.54 | 1323632995 | 1 |
+------+---------+---------------------+---------------+------------+--------+
1 row in set (0.00 sec)
===
================================================================================
The following section describes what happens when someone tries to go to a shortened URL by visiting http://gaw.sh/<whatever>
The source for the file that handles these requests can be found at: http://gaw.sh/go.phps
2. VISITING
* .htaccess rewrites any requests for gaw.sh/<whatever> that are not for a real file or directory to /go.php?x=<whatever> like so:
===
RewriteEngine On
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} !-d
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} !-f
RewriteRule ^(.*)$ /go.php?x=$1 [L]
===
* A row is inserted in to the MySQL "visits" table with the database ID of the URL from the "urls" table (relational, woo!) as well as the IP address, browser, and referring URL
of the visitor along with the UNIX time of the visit:
===
mysql> show columns from visits;
+----------+------------------+------+-----+---------+-------+
| Field | Type | Null | Key | Default | Extra |
+----------+------------------+------+-----+---------+-------+
| id | int(10) unsigned | NO | MUL | NULL | |
| ip | varchar(128) | NO | | NULL | |
| browser | text | NO | | NULL | |
| referrer | text | NO | | NULL | |
| time | varchar(15) | NO | | NULL | |
+----------+------------------+------+-----+---------+-------+
5 rows in set (0.00 sec)
===
* Example data:
===
mysql> select * from visits order by id desc limit 1;
+------+---------------+-----------------------------------------------------------------------------------------------------------------------+----------------+------------+
| id | ip | browser | referrer | time |
+------+---------------+-----------------------------------------------------------------------------------------------------------------------+----------------+------------+
| 1244 | 98.221.114.54 | Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_2) AppleWebKit/535.2 (KHTML, like Gecko) Chrome/15.0.874.121 Safari/535.2 | http://gaw.sh/ | 1323633008 |
+------+---------------+-----------------------------------------------------------------------------------------------------------------------+----------------+------------+
1 row in set (0.00 sec)
===
* HTTP 301 redirect ("Moved Permanently") to the long/actual URL if it is active (status "1"):
===
air:~ eric$ curl -I http://gaw.sh/8static
HTTP/1.1 301 Moved Permanently
Date: Mon, 12 Dec 2011 00:21:54 GMT
Server: Apache
Location: http://8static.com/
Content-Type: text/html
===
* HTTP 410 ("Gone") error message if the short URL is determined to be disabled (status "0"):
===
air:~ eric$ curl -I http://gaw.sh/nope
HTTP/1.1 410 Gone
Date: Mon, 12 Dec 2011 01:00:34 GMT
Server: Apache
Content-Type: text/html
===
* HTTP 404 ("Not Found") error message otherwise (if the short URL never existed or has a funky status like "-1" for "Hidden") :
===
air:~ eric$ curl -I http://gaw.sh/404
HTTP/1.1 404 Not Found
Date: Mon, 12 Dec 2011 01:00:54 GMT
Server: Apache
Content-Type: text/html
===
================================================================================
3. ADMINISTERING
I built a simple administration panel to view/manage URLs somewhat which can be found at /admin/ and uses .htaccess/.htpasswd for authentication
The dumb domain name list is stored in /admin/ as well at /admin/dumb.txt
* Allows an administrator to search and sort URLs by all of their different characteristics/fields pretty easily
- Stores search/sort methods in cookies so refreshes of the page do not wipe out the search/sort values
* Gives the ability to quickly/easily disable a spam/malicious/bad/whatever URL
- Clicking the IP address of the creator of a bad URL allows you to quickly disable all URLs created by that IP address
- Statuses are "0" (disabled) or "1" (active; default)
* Lets an administrator edit the details of any specific URL
- No method by which to delete an URL, only disable/edit/hide it
* Can view the number of visits to an URL; my first time using a JOIN in MySQL (thanks Stan!):
- $listurls = mysql_query("SELECT urls.*, count(visits.id) AS visitors FROM urls INNER JOIN visits ON visits.id = urls.id GROUP BY visits.id ORDER BY visitors $sorthow LIMIT $limit", $link);
===
mysql> SELECT urls.*, count(visits.id) AS visitors FROM urls INNER JOIN visits ON visits.id = urls.id GROUP BY visits.id ORDER BY visitors desc limit 1;
+----+----------------+-------------------------------------------------------------------+---------------+------------+--------+----------+
| id | alias | url | ip | time | status | visitors |
+----+----------------+-------------------------------------------------------------------+---------------+------------+--------+----------+
| 3 | linodereferral | http://www.linode.com/?r=f9976de410ab39ee8e022d5bcc9ad24c6df18536 | 71.197.190.30 | 1323044415 | 1 | 52 |
+----+----------------+-------------------------------------------------------------------+---------------+------------+--------+----------+
1 row in set (0.01 sec)
===
================================================================================
4. THANKS
* <3 to:
- AMP Energy
- Stan Theman
- BrianOK
- Luke
- Jico
- Jason
- neilforobot
- Apple, Inc.
5 TODO
@@ -0,0 +1,5 @@
TODO for gaw.sh:
- fix blacklist lookup functions to understand multiple A (and AAAA maybe?) records/CNAMEs and check all the things
- isZEN/isZENNS does not work if the URL has an IP address instead of a domain name; dns_get_record is weird?
@@ -0,0 +1,4 @@
AuthType Basic
AuthName "Restricted Area"
AuthUserFile .htpasswd
Require valid-user
@@ -0,0 +1 @@
user:password
Oops, something went wrong.

0 comments on commit 3dc6cb8

Please sign in to comment.