Делаем свой укорачиватель длинных адресов URL

Наверняка вам встречались адреса URL ссылок на различные ресурсы в записях Twitter или Facebook? составленные с использованием сервисов bit.ly или t.co. Такие сервисы предоставляют короткие псевдонимы для ссылок на страницы с длинными адресами URL. Например,  вот псевдоним http://bit.ly/SaaYw5, который соответствует очень длинному URL на результат поиска в Google (тема: как погладить рубашку). Передать 20 символьную ссылку с bit.ly гораздо проще.

В данном уроке мы разберемся, как сделать полноценный функционал создания коротких псевдонимов адресов URL для вашего веб сайта. Если у вас есть система управления сайтом, то мы разберемся, как легко интегрировать новые функции без глубинного копания в коде.

Ответы на общие вопросы

Итак, кроме bit.ly существует множество подобных бесплатных сервисов, так зачем же делать свой собственный? Большинство таких сервисов даже имеют простые в использовании API, что позволяет программно генерировать короткие URL и использовать их в собственных скриптах PHP.

Наиболее побудительные мотивы - удобство, эстетичность и распознавание бренда. Например, если ваш сайт содержит приложение, которое создает большое количество отчетов, блог с высокой активностью или огромную коллекцию изображений, то на него может существовать большое количество ссылок. Укорачиватель адресов URL позволит программно создавать простые и четкие ссылки, которые будет легко переправлять по почте читателям или публиковать на сайте. Очевидным преимуществом такого решения будет быстрое и четкое выделение вашего бренда у посетителей сайта.

Может быть, вас удивляет смесь из букв и цифр, которая присутствует в коротких адресах URL. Использование большего числа  опций, чем десять цифр (0-9) для символа ссылки существенно увеличивает число возможных комбинаций и сохраняет код более коротким.

У нас для формирования адресов будут использоваться  цифры и символы в обычном и заглавном написании. Из набора удаляем гласные (чтобы исключить формирование неприличных слов) и символы, которые похожи друг на друга. В итоге получается набор из 50 символов для каждой позиции, что дает для 2 символов адреса 2500 различных комбинаций, для 3-ч - 125000 и  колоссальное число 6.5 миллионов всего лишь для 4-х символов адреса.

Планируем базу данных

Будем использовать таблицу short_urls. Это простая таблица, которую можно создать с помощью ниже приведенного выражения:

CREATE TABLE IF NOT EXISTS short_urls (
  id INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
  long_url VARCHAR(255) NOT NULL,
  short_code VARBINARY(6) NOT NULL,
  date_created INTEGER UNSIGNED NOT NULL,
  counter INTEGER UNSIGNED NOT NULL DEFAULT '0',

  PRIMARY KEY (id),
  KEY short_code (short_code)
)
ENGINE=InnoDB;

У нас будет стандартный ключ с автоматическим инкрементом и поля для полного адреса URL, короткого кода для адреса URL (индексируем его для  быстрого доступа), времени создания псевдонима и количества обращений к короткому псевдониму.

Обратите внимание, что поле long_url имеет максимальную длину в 255 символов, что должно хватить для большинства приложений. Если вам потребуется хранить более длинные адреса URL, то тип поля следует изменить на TEXT.

Приступим к кодированию на PHP!

Создаем короткий код для адреса URL

Код для создания и декодирования коротких кодов URL будет в классе ShortUrl. Сначала рассмотрим часть, ответственную за создание коротких кодов:

<?php
class ShortUrl
{
    protected static $chars = "123456789bcdfghjkmnpqrstvwxyzBCDFGHJKLMNPQRSTVWXYZ";
    protected static $table = "short_urls";
    protected static $checkUrlExists = true;

    protected $pdo;
    protected $timestamp;

    public function __construct(PDO $pdo) {
        $this->pdo = $pdo;
        $this->timestamp = $_SERVER["REQUEST_TIME"];
    }

    public function urlToShortCode($url) {
        if (empty($url)) {
            throw new \Exception("Не получен адрес URL.");
        }

        if ($this->validateUrlFormat($url) == false) {
            throw new \Exception(
                "Адрес URL имеет неправильный формат.");
        }

        if (self::$checkUrlExists) {
            if (!$this->verifyUrlExists($url)) {
                throw new \Exception(
                    "Адрес URL не существует.");
            }
        }

        $shortCode = $this->urlExistsInDb($url);
        if ($shortCode == false) {
            $shortCode = $this->createShortCode($url);
        }

        return $shortCode;
    }

    protected function validateUrlFormat($url) {
        return filter_var($url, FILTER_VALIDATE_URL,
            FILTER_FLAG_HOST_REQUIRED);
    }

    protected function verifyUrlExists($url) {
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_NOBODY, true);
        curl_setopt($ch,  CURLOPT_RETURNTRANSFER, true);
        curl_exec($ch);
        $response = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        curl_close($ch);

        return (!empty($response) && $response != 404);
    }

    protected function urlExistsInDb($url) {
        $query = "SELECT short_code FROM " . self::$table .
            " WHERE long_url = :long_url LIMIT 1";
        $stmt = $this->pdo->prepare($query);
        $params = array(
            "long_url" => $url
        );
        $stmt->execute($params);

        $result = $stmt->fetch();
        return (empty($result)) ? false : $result["short_code"];
    }

    protected function createShortCode($url) {
        $id = $this->insertUrlInDb($url);
        $shortCode = $this->convertIntToShortCode($id);
        $this->insertShortCodeInDb($id, $shortCode);
        return $shortCode;
    }

    protected function insertUrlInDb($url) {
        $query = "INSERT INTO " . self::$table .
            " (long_url, date_created) " .
            " VALUES (:long_url, :timestamp)";
        $stmnt = $this->pdo->prepare($query);
        $params = array(
            "long_url" => $url,
            "timestamp" => $this->timestamp
        );
        $stmnt->execute($params);

        return $this->pdo->lastInsertId();
    }

    protected function convertIntToShortCode($id) {
        $id = intval($id);
        if ($id < 1) {
            throw new \Exception(
                "ID не является некорректным целым числом.");
        }

        $length = strlen(self::$chars);
        // Проверяем, что длина строки
        // больше минимума - она должна быть
        // больше 10 символов
        if ($length < 10) {
            throw new \Exception("Длина строки мала");
        }

        $code = "";
        while ($id > $length - 1) {
            // Определяем значение следующего символа
            // в коде и подготавливаем его
            $code = self::$chars[fmod($id, $length)] .
                $code;
            // Сбрасываем $id до оставшегося значения для конвертации
            $id = floor($id / $length);
        }

        // Оставшееся значение $id меньше, чем
        // длина self::$chars
        $code = self::$chars[$id] . $code;

        return $code;
    }

    protected function insertShortCodeInDb($id, $code) {
        if ($id == null || $code == null) {
            throw new \Exception("Параметры ввода неправильные.");
        }
        $query = "UPDATE " . self::$table .
            " SET short_code = :short_code WHERE id = :id";
        $stmnt = $this->pdo->prepare($query);
        $params = array(
            "short_code" => $code,
            "id" => $id
        );
        $stmnt->execute($params);

        if ($stmnt->rowCount() < 1) {
            throw new \Exception(
                "Строка не обновляется коротким кодом.");
        }

        return true;
    }
...

При реализации нашего класса ShortUrl мы передаем ему экземпляр объекта PDO. Конструктор сохраняет данную ссылку и устанавливает $timestamp.

Мы вызываем метод urlToShortCode() и передаем в него длинный адрес URL, который надо заменить коротким псевдонимом.Метод выполняет все действия,необходимые для создания короткого кода.

urlToShortCode() вызывает validateUrlFormat(), где используется фильтр PHP для проверки правильности адреса URL. Если статическая переменная $checkUrlExists имеет значение true, вызывается verifyUrlExists(), где используется cURL для соединения с адресом URL и проверки, что не возвращается ошибка 404. Также можно проверить наличие статуса 200 (OK), но он устанавливается, если адрес возвращает код 301 (перемещено) или 401 (нет доступа).

Нет смысла хранить повторяющиеся значения, поэтому производим проверку функцией  urlExistsInDb(), которая опрашивает базу данных на предмет наличия в ней длинного адреса URL. Если он уже есть в базе данных, то функция возвращает соответствующий короткий код. Иначе возвращается значение false, чтобы мы могли создать короткий код. Обратите внимание, что  http://www.example.com и http://example.com являются разными адресами URL, поэтому, если вам нужно предотвратить подобного рода повторения, следует использовать регулярные выражения.

createShortCode() предает следующие задачи соответствующим методам:

1. insertUrlInDb() для вставки длинного адреса URL в базу данных и возвращения ID новой строки.
2. convertIntToShortCode() для конвертации ID новой строки в короткий код.
3. insertShortCodeInDb() для обновления новой строки созданным коротким кодом.

Когда нужно создать короткий код для адреса  URL, мы создаем экземпляр класса, передаем конструктору экземпляр PDO, вызываем метод urlToShortCode() с длинным адресом URL, добавляем полученный короткий код к имени домена и передаем полученный результат запрашивающему контроллеру.

<?php
include "../include/config.php";
include "../include/ShortUrl.php";

try {
    $pdo = new PDO(DB_PDODRIVER . ":host=" . DB_HOST .
        ";dbname=" . DB_DATABASE,
        DB_USERNAME, DB_PASSWORD);
}
catch (\PDOException $e) {
    trigger_error("Ошибка: не могу установить соединение с базой данных.");
    exit;
}

$shortUrl = new ShortUrl($pdo);
try {
    $code = $shortUrl->urlToShortCode($_POST["url"]);
    printf('<p><strong>Короткий URL:</strong> <a href="/%s">%1$s</a></p>',
        SHORTURL_PREFIX . $code);
    exit;
}
catch (\Exception $e) {
    // Записываем в журнал ошибку и перенаправляем на страницу.
    header("Location: /error");
    exit;
}

Преобразуем короткий код

Код для декодирования короткого кода и получения длинного адреса URL также является частью класса ShortUrl. Мы вызываем метод shortCodeToUrl() и передаем ему короткий код, извлеченный из адреса URI. shortCodeToUrl() также принимает опциональный параметр $increment, который по умолчанию имеет значение true. Затем происходит следующее:

1. validateShortCodeFormat() выполняет проверку, что короткий код содержит только символы и числа.
2. getUrlFromDb() запрашивает базу данных с полученным коротким кодом и возвращает поля id, long_url, и counter.
3. Если параметр $increment имеет значение true, вызывается метод incrementCounter() для увеличения счетчика обращений к короткому коду.

Вот остальной код класса:

...
    public function shortCodeToUrl($code, $increment = true) {
        if (empty($code)) {
            throw new \Exception("Не задан короткий код.");
        }

        if ($this->validateShortCode($code) == false) {
            throw new \Exception(
                "Короткий код имеет неправильный формат.");
        }

        $urlRow = $this->getUrlFromDb($code);
        if (empty($urlRow)) {
            throw new \Exception(
                "Короткий код не содержится в базе.");
        }

        if ($increment == true) {
            $this->incrementCounter($urlRow["id"]);
        }

        return $urlRow["long_url"];
    }

    protected function validateShortCode($code) {
        return preg_match("|[" . self::$chars . "]+|", $code);
    }

    protected function getUrlFromDb($code) {
        $query = "SELECT id, long_url FROM " . self::$table .
            " WHERE short_code = :short_code LIMIT 1";
        $stmt = $this->pdo->prepare($query);
        $params=array(
            "short_code" => $code
        );
        $stmt->execute($params);

        $result = $stmt->fetch();
        return (empty($result)) ? false : $result;
    }

    protected function incrementCounter($id) {
        $query = "UPDATE " . self::$table .
            " SET counter = counter + 1 WHERE id = :id";
        $stmt = $this->pdo->prepare($query);
        $params = array(
            "id" => $id
        );
        $stmt->execute($params);
    }
}

Собираем все вместе

Построение контроллера или встраивание функционала в имеющийся пакет выходит за рамки нашего урока.  Вся логика нашего проекта помещается в файл с именем r.php (r - от слова redirect). Можно использовать короткие коды адресов URL по примеру http://example.com/r/X4c, где  r.php (или r/index.php, в зависимости от дизайна вашего проекта) будет контроллером. Такой формат легко встроить практически в любую систему без затрагивания существующего контроллера.

Преимуществом такого подхода является возможность организовать различные контроллеры для различных частей сайта с помощью использования разных таблиц для формирования максимально коротких кодов. Например, http://example.com/b/ можно использовать для блога, а http://example.com/i/ для изображений.

Если вы не используете контроллер или систему управления содержанием, то можно применить формат http://example.com/r?c=X4c, где r/index.php содержит декодирующий скрипт.

Файл r.php может выглядеть так:

<?php
include "../include/config.php";
include "../include/ShortUrl.php";

// Как вы получаете короткий код?

// Из CMS или контроллера с помощью формата URL наподобие
// http://.example.com/r/X4c
// $code = $uri_data[1];

// Из строки запроса с помощью формат URL наподобие
// http://example.com/r?c=X4c, где файл index.php находится
// в папке http_root/r/index.php
$code = $_GET["c"];

try {
    $pdo = new PDO(DB_PDODRIVER . ":host=" . DB_HOST .
        ";dbname=" . DB_DATABASE,
        DB_USERNAME, DB_PASSWORD);
}
catch (\PDOException $e) {
    trigger_error("Ошибка: не могу соединится с базой данных.");
    exit;
}

$shortUrl = new ShortUrl($pdo);
try {
    $url = $shortUrl->shortCodeToUrl($code);
    header("Location: " . $url);
    exit;
}
catch (\Exception $e) {
    header("Location: /error");
    exit;
}

В зависимости от метода получения короткого кода определяется значение переменной $code. Устанавливаем соединение PDO, реализуем экземпляр ShortUrl, и вызываем метод shortCodeToUrl(), передавая в него короткий код и увеличивая счетчик обращений по умолчанию. Если короткий код правильный, то вы получите длинный адрес URL, который можно использовать по назначению.

• Комментарии