├── .gitignore
├── screenshot.png
├── sqlite.db.exp
├── mysql.db.sql
├── License
├── README.md
└── index.php


/.gitignore:
--------------------------------------------------------------------------------
1 | data.db
2 | 


--------------------------------------------------------------------------------
/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/isecret/short/HEAD/screenshot.png


--------------------------------------------------------------------------------
/sqlite.db.exp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/isecret/short/HEAD/sqlite.db.exp


--------------------------------------------------------------------------------
/mysql.db.sql:
--------------------------------------------------------------------------------
 1 | CREATE TABLE `url` (
 2 |   `id` int(11) NOT NULL AUTO_INCREMENT,
 3 |   `code` varchar(32) NOT NULL,
 4 |   `hash` varchar(32) NOT NULL,
 5 |   `url` text NOT NULL,
 6 |   `ip` varchar(64) NOT NULL,
 7 |   `user_agent` text,
 8 |   `visit_count` int(11) NOT NULL DEFAULT 0,
 9 |   `create_date` datetime DEFAULT CURRENT_TIMESTAMP,
10 |   PRIMARY KEY (`id`),
11 |   KEY `idx_code` (`code`),
12 |   KEY `idx_hash` (`hash`)
13 | ) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=utf8mb4;
14 | 
15 | CREATE TABLE `visit_history` (
16 |   `id` int(11) NOT NULL AUTO_INCREMENT,
17 |   `url_id` int(11) NOT NULL,
18 |   `ip` varchar(64) NOT NULL,
19 |   `user_agent` text,
20 |   `create_date` datetime DEFAULT CURRENT_TIMESTAMP,
21 |   PRIMARY KEY (`id`),
22 |   KEY `idx_url_id` (`url_id`)
23 | ) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=utf8mb4;
24 | 
25 | CREATE TABLE `blacklist` (
26 |   `id` int(11) NOT NULL AUTO_INCREMENT,
27 |   `domain` varchar(255) NOT NULL,
28 |   `create_date` datetime DEFAULT CURRENT_TIMESTAMP,
29 |   PRIMARY KEY (`id`)
30 | ) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=utf8mb4;


--------------------------------------------------------------------------------
/License:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2014-2017 iissnan
 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 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | ## 短链接生成
  2 | 
  3 | 在线演示: [0x64.cn](https://0x64.cn)
  4 | 
  5 | 又一个基于 PHP 简单实现的短链接在线生成工具，简单配置，快速搭建。
  6 | 
  7 | ![截图](./screenshot.png)
  8 | 
  9 | ## 配置
 10 | 
 11 | ### 安装
 12 | #### 1. 下载源码，部署至服务器，环境 `PHP >= 5.6`，需安装 `PDO` 扩展。
 13 | #### 2. 配置 Nginx，参考如下：
 14 | ```conf
 15 | server {
 16 |     listen  80;
 17 |     server_name  0x64.cn;
 18 |     root   /www/0x64.cn;
 19 |     index  index.php index.html index.htm;
 20 |     
 21 |     access_log /dev/null;
 22 |     error_log  /var/log/nginx/nginx.0x64.error.log  warn;
 23 | 
 24 |     # 伪静态 必须
 25 |     location / {
 26 |         try_files $uri $uri/ /index.php?$query_string;
 27 |     }
 28 | 
 29 |     # sqlite 数据库文件禁止访问 必须
 30 |     location ~ /(data\.db) {
 31 |         deny all;
 32 |     }
 33 | 
 34 |     location ~ \.php$ {
 35 |         fastcgi_pass   unix:/dev/shm/php-cgi.sock;
 36 |         include        fastcgi-php.conf;
 37 |         include        fastcgi_params;
 38 |     }
 39 | }
 40 | ```
 41 | #### 3. 配置数据库，支持 MySQL 和 SQLite。
 42 | 
 43 | ##### 3.1 MySQL 配置
 44 | 
 45 | ###### 3.1.1 编辑 index.php
 46 | 
 47 | ```
 48 | <?php
 49 | // 数据库连接字符串 host 主机名; dbname 数据库名; charset 字符集编码
 50 | define('DB_DSN', 'mysql:host=localhost;dbname=short;charset=utf8mb4');
 51 | 
 52 | // 数据库用户名
 53 | define('DB_USER', 'root');
 54 | 
 55 | // 数据库密码
 56 | define('DB_PASSWD', '123456');
 57 | ```
 58 | 
 59 | ###### 3.1.2 导入数据库表结构
 60 | 使用工具（Navicat、PHPMyAdmin等）连接 MySQL 服务，创建数据库 `short`，并导入 `mysql.db.sql`
 61 | 
 62 | ##### 3.2 SQLite 配置：
 63 | 
 64 | ###### 3.2.1 编辑 index.php
 65 | 
 66 | ```
 67 | <?php
 68 | // 数据库连接字符串 host 主机名; dbname 数据库名; charset 字符集编码
 69 | define('DB_DSN', 'sqlite:data.db');
 70 | 
 71 | // 数据库用户名
 72 | define('DB_USER', null);
 73 | 
 74 | // 数据库密码
 75 | define('DB_PASSWD', null);
 76 | ```
 77 | 
 78 | ###### 3.2.2 创建数据库文件
 79 | 复制 `sqlite.db.exp` 为 `data.db`
 80 | 
 81 | ### 4. 配置短链接字符长度
 82 | 
 83 | ```php
 84 | // 生成短链接随机字符长度 默认 6 位 不超过 32 位
 85 | define('CODE_LENGTH', 6);
 86 | ```
 87 | 
 88 | ## API
 89 | 
 90 | ### 生成短链接
 91 | 你可以通过域名访问页面或使用接口生成 URL，地址为 `/`，请求方式为 `POST`，参数为 `url` 即你的长链接；`code` 为自定义短链接（可选）。
 92 | 
 93 | ```bash
 94 | # 自动生成短链接
 95 | $ curl -X POST -d 'url=http://github.com' http://0x64.cn
 96 | {
 97 |   "code": 0,
 98 |   "msg": "OK",
 99 |   "data": {
100 |     "short": "0x64.cn/8FuHf5",
101 |     "generic": "http://0x64.cn/8FuHf5",
102 |     "long": "https://0x64.cn/8FuHf5"
103 |   }
104 | }
105 | 
106 | # 自定义短链接
107 | $curl -X POST -d 'url=http://github.com&code=github' http://0x64.cn
108 | {
109 |   "code": 0,
110 |   "msg": "OK",
111 |   "data": {
112 |     "short": "0x64.cn/github",
113 |     "generic": "http://0x64.cn/github",
114 |     "long": "https://0x64.cn/github"
115 |   }
116 | }
117 | ```
118 | 
119 | | 字段 | 协议 | 兼容性 | 字符长度 |
120 | | ---- | ---- | ---- | ---- | 
121 | | short | 自动识别 | 较差 | 最短 |
122 | | generic  | http | 较好 | 较短 |
123 | | long  | https | 好 | 较长 |
124 | 
125 | ## TODO List
126 | - 后台管理
127 | - 域名黑名单
128 | - 密码访问


--------------------------------------------------------------------------------
/index.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | // 数据库连接字符串
  4 | // MySQL示例 mysql:host=localhost;dbname=testdb;charset=utf8mb4
  5 | define('DB_DSN', 'sqlite:data.db');
  6 | 
  7 | // 数据库用户名
  8 | define('DB_USER', null);
  9 | 
 10 | // 数据库密码
 11 | define('DB_PASSWD', null);
 12 | 
 13 | // 生成短链接随机字符长度 默认 6 位 不超过 32 位
 14 | define('CODE_LENGTH', 6);
 15 | 
 16 | if ($_SERVER['REQUEST_METHOD'] == 'POST') {
 17 | 
 18 |     if (empty($_POST['url'])) {
 19 |         json(-2, '网址不能为空!');
 20 |     }
 21 | 
 22 |     $url = $_POST['url'];
 23 | 
 24 |     if (!filter_var($url, FILTER_VALIDATE_URL)) {
 25 |         json(-3, '网址格式不正确!');
 26 |     }
 27 | 
 28 |     $db = db();
 29 |     $hash = md5($url);
 30 |     $domain = parse_url($url)['host'];
 31 |     $code = null;
 32 |     $data = null;
 33 | 
 34 |     if (is_domain_blocked($domain)) {
 35 |         json(-6, '该域名不在服务范围!');
 36 |     }
 37 | 
 38 |     if (empty($_POST['code'])) {
 39 |         $stmt = $db->prepare("select * from url where hash = ?");
 40 |         $stmt->execute([$hash]);
 41 |         $data = $stmt->fetchAll();
 42 |     } else {
 43 |         $code = $_POST['code'];
 44 |         $stmt = $db->prepare("select * from url where code = ?");
 45 |         $stmt->execute([$code]);
 46 |         $codeExist = $stmt->fetchAll();
 47 |         if ($codeExist) {
 48 |             if (current($codeExist)['hash'] == $hash) {
 49 |                 $data[] = ['code' => current($codeExist)['code']];
 50 |             } else {
 51 |                 json(-7, '该 Code 已占用，更换一个呗!');
 52 |             }
 53 |         }
 54 |     }
 55 | 
 56 |     if ($data) {
 57 |         $code = current($data)['code'];
 58 |     } else {
 59 |         if (empty($code)) {
 60 |             $code = generate_code();
 61 |         }
 62 |         $ip = get_client_ip();
 63 |         $user_agent = $_SERVER['HTTP_USER_AGENT'];
 64 | 
 65 |         $stmt = $db->prepare("select * from url where code = ?");
 66 |         $stmt->execute([$code]);
 67 |         $exist = $stmt->fetchColumn();
 68 |         if ($exist) {
 69 |             json(-4, '天选之子，再来一次!');
 70 |         }
 71 | 
 72 |         $stmt = $db->prepare("insert into url(code, hash, url, ip, user_agent) values (?, ?, ?, ?, ?)");
 73 |         $result = $stmt->execute([$code, $hash, $url, $ip, $user_agent]);
 74 |         if (!$result) {
 75 |             json(-5, '系统繁忙，请稍后再试!');
 76 |         }
 77 |     }
 78 | 
 79 |     $base_url = $_SERVER['HTTP_HOST'] .'/'. $code;
 80 |     json(0, 'OK',[
 81 |         'short' => $base_url,
 82 |         'generic' => 'http://' . $base_url,
 83 |         'long' => 'https://' . $base_url,
 84 |     ]);
 85 | } else if ($_SERVER['REQUEST_METHOD'] == 'GET') {
 86 |     header("Content-Type: text/html");
 87 |     if ($_SERVER['REQUEST_URI'] != '/') {
 88 |         $code = substr($_SERVER['REQUEST_URI'], 1);
 89 |         $db = db();
 90 |         $stmt = $db->prepare("select * from url where code = ?");
 91 |         $stmt->execute([$code]);
 92 |         $data = $stmt->fetchAll();
 93 |         if ($data) {
 94 |             $url = current($data)['url'];
 95 |             $domain = parse_url($url)['host'];
 96 |             $url_id = current($data)['id'];
 97 |             $ip = get_client_ip();
 98 |             $user_agent = $_SERVER['HTTP_USER_AGENT'];
 99 |             $visit_count = current($data)['visit_count'] + 1;
100 | 
101 |             $stmt = $db->prepare("update url set visit_count=? where id = ?");
102 |             $stmt->execute([$visit_count, $url_id]);
103 | 
104 |             $stmt = $db->prepare("insert into visit_history(url_id, ip, user_agent) values (?, ?, ?)");
105 |             $stmt->execute([$url_id, $ip, $user_agent]);
106 | 
107 |             if (is_domain_blocked($domain)) {
108 |                 http_response_code(403);
109 |             } else {
110 |                 header("Location: {$url}");
111 |             }
112 |         } else {
113 |             header("Location: /");
114 |         }
115 |         exit(0);
116 |     }
117 | }
118 | 
119 | function json($code, $msg, $data=[]) {
120 |     header("Content-Type: application/json; charset=utf-8");
121 |     echo json_encode(['code' => $code, 'msg' => $msg, 'data' => $data]);
122 |     exit(0);
123 | }
124 | 
125 | function db() {
126 |     try {
127 |         $pdo = new PDO(DB_DSN, DB_USER, DB_PASSWD);
128 |     } catch (PDOException $e) {
129 |         json(-1, '数据库连接失败!'.$e->getMessage());
130 |     }
131 | 
132 |     return $pdo;
133 | }
134 | 
135 | function generate_code() {
136 |     $seeds = array_merge(range('a', 'z'), range('A', 'Z'), range(0, 9));
137 |     $depository = [];
138 |     for ($i = 0; $i < CODE_LENGTH-1; $i++) {
139 |         $depository = array_merge($depository, $seeds);
140 |     }
141 |     shuffle($depository);
142 |     return join('', array_slice($depository, 0, CODE_LENGTH));
143 | }
144 | 
145 | function get_client_ip() {
146 |     if (!empty($_SERVER['HTTP_CLIENT_IP'])) {
147 |         return $_SERVER['HTTP_CLIENT_IP'];
148 |     } elseif (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
149 |         return $_SERVER['HTTP_X_FORWARDED_FOR'];
150 |     } else {
151 |         return $_SERVER['REMOTE_ADDR'];
152 |     }
153 | }
154 | 
155 | function is_domain_blocked($domain) {
156 |     $db = db();
157 |     $stmt = $db->prepare("select * from blacklist");
158 |     $stmt->execute();
159 |     $blacklist = $stmt->fetchAll();
160 | 
161 |     foreach ($blacklist as $blocked_domain) {
162 |         if (fnmatch($blocked_domain['domain'], $domain, FNM_CASEFOLD | FNM_NOESCAPE)) {
163 |             return true;
164 |         }
165 |     }
166 |     return false;
167 | }
168 | 
169 | header("Content-Type: text/html");
170 | 
171 | ?>
172 | 
173 | <!DOCTYPE html>
174 | <html lang="en">
175 | <head>
176 |     <meta charset="UTF-8">
177 |     <meta http-equiv="X-UA-Compatible" content="IE=edge">
178 |     <meta name="viewport" content="width=device-width,initial-scale=1.0,maximum-scale=1.0,user-scalable=0">
179 |     <title>短链接生成</title>
180 |     <script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.6.3/jquery.min.js"></script>
181 |     <style>
182 |         * {
183 |             padding: 0;
184 |             margin: 0;
185 |             box-sizing: border-box;
186 |         }
187 |         body {
188 |             display:flex;
189 |             justify-content:center;
190 |             align-items: center;
191 |             height: 100vh;
192 |             color: #333
193 |         }
194 |         a {
195 |             font-size: .8em;
196 |             width: auto;
197 |             color: #999;
198 |         }
199 |         .site-header {
200 |             margin-bottom: 14px;
201 |             margin-top: -140px;
202 |             text-align: center;
203 |         }
204 |         .main-title {
205 |             font-size: 1.8em;
206 |         }
207 |         .subtitle {
208 |             font-size: 1em;
209 |             color: #bbb;
210 |             font-weight: 400;
211 |             margin: 4px 0 10px 0;
212 |         }
213 |         .site-body {
214 |             margin: 24px 0 24px;
215 |         }
216 |         .site-body-item {
217 |             margin: 22px 0 22px 0;
218 |             display: flex;
219 |             justify-content: center;
220 |             align-items: center;
221 |         }
222 |         .site-input {
223 |             border-radius: 3px;
224 |             padding: 5px;
225 |             font-size: 14px;
226 |             line-height: 1.2;
227 |             border: 1px solid #ccc;
228 |             width: 280px;
229 |             box-sizing: border-box;
230 |         }
231 |         .site-button {
232 |             background-color: #fff;
233 |             color: #333;
234 |             text-shadow: 0 1px 0 #fff;
235 |             text-decoration: none;
236 |             font-weight: 700;
237 |             padding: 4px 15px 3px;
238 |             border: 1px solid #ccc;
239 |             border-radius: 3px;
240 |             font-size: 14px;
241 |             font-family: Arial,sans-serif;
242 |             display: inline-block;
243 |             line-height: 1.25;
244 |             outline: 0;
245 |             margin-left: 4px;
246 |         }
247 |         .site-button:hover {
248 |             background-color: #f9f9f9;
249 |             border: 1px solid #ccc;
250 |             color: #333;
251 |             text-shadow: 0 1px 0 #fff;
252 |             text-decoration: none;
253 |             font-weight: 700;
254 |             cursor: pointer;
255 |         }
256 |         .site-footer {
257 |             text-align: center;
258 |             font-size: 12px;
259 |             color: #bbb;
260 |         }
261 |     </style>
262 |     <link rel="stylesheet" href="https://at.alicdn.com/t/c/font_3948736_5826ppfenst.css">
263 | </head>
264 | <body>
265 |     <div class="container">
266 |         <div class="site-header">
267 |             <h1 class="main-title">短链接生成</h1>
268 |             <h2 class="subtitle">人生很短，链接也别太长。</h2>
269 |         </div>
270 |         <div class="site-body">
271 |             <div class="site-body-item">
272 |                 <input type="text" name="url" class="site-input"/>
273 |                 <div id="submit" class="site-button"><i class="iconfont icon-exchange"></i></div>
274 |             </div>
275 |             <div class="site-body-item">
276 |                 <input type="text" name="short_url" class="site-input" />
277 |                 <div id="copy" class="site-button"><i class="iconfont icon-copy"></i></div>
278 |             </div>
279 |         </div>
280 |         <div class="site-footer">
281 |             <p><a href="https://blog.wangmao.me">WangMao's Blog</a> | <a href="https://github.com/isecret/short">Github</a></p>
282 |         </div>
283 |     </div>
284 |     <script>
285 |         $('#submit').click(function () {
286 |             var url = $('input[name=url]').val();
287 | 
288 |             if (url == '') {
289 |                 alert("链接不能为空！");
290 |                 return;
291 |             }
292 | 
293 |             if (!/^http(s)?:\/\//.test(url)) {
294 |                 alert("链接格式不正确！");
295 |                 return;
296 |             }
297 | 
298 |             $.post("/", {url: url}, function (data) {
299 |                 if (data.code == 0) {
300 |                     $('input[name=short_url]').val(data.data.generic);
301 |                 } else {
302 |                     alert(data.msg);
303 |                 }
304 |             }, 'json')
305 |         });
306 | 
307 |         $('#copy').click(function () {
308 |             $("input[name=short_url]").focus();
309 |             $("input[name=short_url]").select();
310 |             document.execCommand("Copy");
311 |         });
312 |     </script>
313 | </body>
314 | </html>
315 | 


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