Скарачаем спасылкі без тлушчу (F3)

Скарачаем спасылкі без тлушчу (F3)

Скарачаць спасылкі ў 13 гадоў не сорамна, праўда? Навічку, ды і не толькі пачаткоўцу, варта паспрабаваць напісаць свой Утаймавальнік Спасылак, паходу вывучаючы які-небудзь новы фрэймворк. Чым я і заняўся. Што сказаць - пяты бутстрап, абястлушчаны фрэймворк і часцінка душы.

Вось дэма, А вось код. Для такіх чытачоў, як я 😉

Фрэймворк, ці не так?

Вядома не Laravel і таму падобныя сёння абыйдземся 65-ю кілабайтамі. FatFreeFramework. Калі Вы знаёмыя з Python Flask, то ўзнікне адчуванне, што недзе гэта ўжо было:

#роутинг во Фласке
@app.route('/')
def hello_world():
    return 'Hello, World!'
//роутинг в Обезжиренном
$f3->route('GET /',
    function() {
        echo 'Hello, world!';
    }
);

Добра, забудзьцеся. Спампоўваем .zip з оф.сайта, які распакоўваецца ў тэчку, якая ў гэты ж момант адкрываецца ў вашым Любімым Рэдактары Кода. Ачысціце index.php і выдаліце ​​ўсё з /ui.

Тут усё лімітава проста - у тэчцы ui у нас усё люхты, а калі па простым — прапампаваныя ХТМЛ шаблоны, якія мы будзем паказваць карыстачу пры заходзе на вызначаны URL.

Вось каркас нашага "прыкладанні":

<?php
//Файл: index.php

// Kickstart the framework
$f3=require('lib/base.php');
$f3->set('DEBUG', 1);
if ((float)PCRE_VERSION<8.0)
    trigger_error('PCRE version is out of date');
$f3->config('config.ini');

//ВЕСЬ ОСТАЛЬНОЙ КОД БУДЕМ ПИСАТЬ ЗДЕСЬ

$f3->run();

Вось і ўсё, што трэба ведаць для пачатку. Прыступаем да кодынгу!

[для распрацоўкі я выкарыстаў лакальны XAMPP на Windows і VS Code, артыкул напісаны ў Ноўшэне]

Хатняя старонка

Пачнём з галоўнай старонкі. Лагічна, праўда?

//Файл: index.php

$f3->route('GET /',
    function($f3) { //чтобы использовать функции F3 передаем его в роут
                $view = new View; // создаем вьюшку
        echo $view->render('home.htm'); //рендерим шаблон
    }
);

Цяпер трэба гэты самы шаблён напісаць. Для прастаты я выкарыстоўваў бутстрап v5 alpfa.

Не забудзьцеся ствараць усе шаблоны ў тэчцы карыстацкі інтэрфейс, інакш яны не будуць бачныя фрэймворку

<!-- Файл: ui/home.htm -->

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="<?php echo $ENCODING; ?>" />
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <title>Пишем (код), сокращаем (ссылки)!</title>
        <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/5.0.0-alpha1/css/bootstrap.min.css" integrity="sha384-r4NyP46KrjDleawBgD5tp8Y7UzmLA05oM1iAEQ17CSuDqnUK2+k9luXQOfXJCJ4I" crossorigin="anonymous">
    </head>
    <body class="text-center bg-dark text-light"> <!-- темная тема ;) -->

        <!-- менюшка -->
        <nav class="m-2">
            <ul class="nav nav-pills justify-content-center">
                <li class="nav-item">
                    <a class="nav-link active" aria-current="page" href="#">Главная</a>
                </li>
                <li class="nav-item">
                    <a class="nav-link" href="#">Статья на Хабре</a>
                </li>
                <li class="nav-item">
                    <a class="nav-link" href="https://nikonovs.ru">Создатель</a>
                </li>
            </ul>
        </nav>

        <div class="container">
        <h1>Короткие ссылки уже здесь.</h1>

        <!-- Будем отправлять данные POST-запросом на /newLink -->
        <form class="mt-5 mb-3" action="/be/newLink/" method="POST">
            <div class="row justify-content-center">
                <div class="col-auto">
                <label for="inputLink" class="col-form-label">Введи ссылку:</label>
                </div>
                <div class="col-auto">
                <input required placeholder="https://" type="url" name="link" id="inputLink" class="form-control mb-1" aria-describedby="inputLink">
                </div>
                <div class="col-auto">
                <button type="submit" class="btn btn-outline-primary">Сократить!</button>
                </div>
            </div>
        </form>

        <!-- немного -->
        <p class="text-left m-auto mb-5" style="max-width: 30rem;">Lorem ipsum dolor sit, amet consectetur adipisicing elit. Omnis illum molestiae hic fugiat molestias nemo, architecto beatae repellat ullam exercitationem non ab, necessitatibus maxime quod iure ipsa quam quos! Reprehenderit. Lorem ipsum dolor, sit amet consectetur adipisicing elit. Necessitatibus eos sapiente voluptates veniam sequi delectus totam tenetur praesentium obcaecati. Repudiandae quisquam, ipsa ullam corrupti molestiae minima optio nihil est modi?</p>

        <footer class="m-2">Сделано с <img width="20" height="20" src="https://image.flaticon.com/icons/svg/833/833472.svg" alt="любовью">, <a href="https://v5.getbootstrap.com/">пятым Bootstrap'ом</a>    и <a href="https://fatfreeframework.com/">без жира</a></footer>
        </div>
    </body>
</html>

Вось і ўсё, у нас ужо працуе галоўная старонка. Форма адпраўляе POST-запытам спасылку, якую трэба скараціць.
Цяпер самае цікавае (не).

Праца з БД

Створым БД - MySQL. Калі ў Вас усталяваны PhpMyAdmin, то стварыце новую БД "Сувязі", а потым выканайце гэты SQL:

SET SQL_MODE = "NO_AUTO_VALUE_ON_ZERO";
SET time_zone = "+00:00";

CREATE TABLE IF NOT EXISTS `links` (
  `code` varchar(4) NOT NULL,
  `link` varchar(1000) NOT NULL,
  `hits` int(255) NOT NULL DEFAULT '0'
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

ALTER TABLE `links`
  ADD UNIQUE KEY `code` (`code`);

У нас будзе 3 палі ў кожнай спасылкі:

  1. Code - гэта рандомныя 4 знака пасля дамена, па якіх будзе адбывацца перанакіраванне, выгляду example.com/ABC1
  2. Link - Ня скарочаная спасылка.
  3. Hits - колькасць пераходаў па скарочанай спасылцы.

Коратка раскажу прынцып працы з БД, без тлушчу.

<?php
//сначала нужно подключиться к БД
$db = new DBSQL(
    'mysql:host=localhost;port=3306;dbname=linker',
    'root',
    ''
);

//Дальше есть два варианда работы с данными:

//Можно установить переменную в Фреймворк c помощью обычного SQL-запроса:
$f3->set('result', $db->exec('SELECT * FROM wherever')); 
//они будут доступны в шаблонах, как <?= $resul ? >

//А можно использовать встроенный SQL Mapper:
$row = new DBSQLMapper($db, 'links');

$row->load(array('link="https://habrahabr.ru"')); //теперь из этого объекта доступны все колонки строки, где ссылка на Хабр:
$row_value = $row->somerow; //Вот так

// Естесственно можно изменять значения:
$row->link = 'https://habr.com';
$row->save(); //изменения нужно сохранить, а что вы думали

// больше информации по работе с БД доступно здесь: https://a.nikonovs.ru/MPHR Настоятельно рекомендую прочитать, хотябы с помощью переводчика, встроенного в браузер.
?>

Прыступаем да Скарачэння.

Апрацоўка новай спасылкі

Ствараем новую люхту ў index'e, якая будзе апрацоўваць запыт з формы на галоўнай старонцы.

Спачатку створым новы, але вельмі падобны на першы (home.htm) шаблон - "newLink.htm".
Там мы будзем выводзіць ужо скарочаную спасылку і колькасць пераходаў па ёй (каб зноў убачыць гэтую "статыстыку" трэба зноў скараціць гэтую ж спасылку - адрас застанецца той жа).
Для высновы скарыстаемся трукам з "пераходам зменных":

<?php
//Файл: нет (пример)

//устанавливаем переменную в index'е и рендерим шаблон
$f3->set('link', $shorted_link);
$view = new View;
echo $view->render('newLink.htm');
//теперь в шаблоне можно использовать:
<?= $link ?>

А вось і лістынг newLink.html:

<!-- Файл: newLink.htm -->

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="<?php echo $ENCODING; ?>" />
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <title>Пишем (код), сокращаем (ссылки)!</title>
        <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/5.0.0-alpha1/css/bootstrap.min.css" integrity="sha384-r4NyP46KrjDleawBgD5tp8Y7UzmLA05oM1iAEQ17CSuDqnUK2+k9luXQOfXJCJ4I" crossorigin="anonymous">
    </head>
    <body class="text-center bg-dark text-light">
        <nav class="m-2">
            <ul class="nav nav-pills justify-content-center">
                <li class="nav-item">
                    <a class="nav-link" aria-current="page" href="/be/">Главная</a>
                </li>
                <li class="nav-item">
                    <a class="nav-link" href="#">Статья на Хабре</a>
                </li>
                <li class="nav-item">
                    <a class="nav-link" href="https://nikonovs.ru">Создатель</a>
                </li>
            </ul>
        </nav>

        <div class="container">
        <h1>Короткие ссылки уже здесь.</h1>

        <!-- Убираем из формы функционал формы и выводим переменные -->
        <form class="mt-5 mb-3">
            <div class="row justify-content-center">
                <div class="col-auto">
                    <label for="inputLink" class="col-form-label">Сократили:</label>
                </div>
                <div class="col-auto">
                    <input disabled required type="url" name="link" id="inputLink" class="form-control disabled" aria-describedby="inputLink" value="<?= $link ?>">
                </div>
            </div>
            <p class="m-2 text-secondary">По этой ссылке перешли: `<?= $hits ?>`</p>
        </form>

        <a href="/be/" class="mt-3 mb-5 btn btn-primary btn-lg">ВЕРНУТЬСЯ НА ГЛАВНУЮ</a>

        <footer class="m-2">Сделано с <img width="20" height="20" src="https://image.flaticon.com/icons/svg/833/833472.svg" alt="любовью">, <a href="https://v5.getbootstrap.com/">пятым Bootstrap'ом</a>    и <a href="https://fatfreeframework.com/">без жира</a></footer>
        </div>
    </body>
</html>

Пішам сам роўт.

$f3->route('GET|POST /newLink', //мы будем обрабатывать и POST и GET
    function($f3) {

            $db = new DBSQL( //Подключение к БД новое в каждом Роуте
                'mysql:host=localhost;port=3306;dbname=linker',
                'root',
                ''
            );

            //прекрасная функция генерации радомных символов:
            $permitted_chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
            function generate_string($input, $strength = 4) {
                $input_length = strlen($input);
                $random_string = '';
                for($i = 0; $i < $strength; $i++) {
                    $random_character = $input[mt_rand(0, $input_length - 1)];
                    $random_string .= $random_character;
                }

                return $random_string;
            }

            //проверка на повторение link - нам же не нужно чтобы каждый раз генерировались новые ссылки. link - уникальный.
            $check = new DBSQLMapper($db,'links');
            $check->load(array('link="'. $link .'"'));
            if ($check->dry()) {
                $g_code = generate_string($permitted_chars);
                $row = new DBSQLMapper($db,'links');
                $row->reset();
                $row->code = $g_code;
                $row->link = $link;
                $row->save();
            } else {
                $g_code = $check->code; //если link повторяется, то показываем старый код
            }

            $short_link = 'https://'. $_SERVER['HTTP_HOST'] . '/' . $g_code; //собираем конечную ссылку

            //параметры из $_POST можно получить с помощью $f3->get('POST'), поддерживается точечная нотация (поправьте, если неправильно называю): параметр "link" можно получить так: 
            $link = $f3->get('POST.link');

            if ( !empty($f3->get('POST')) ) { //Выдаем HTML, только если POST не пустой.

            $f3->set('link', $short_link);
            $f3->set('hits', $check->hits);
            $view = new View;
            echo $view->render('newLink.htm');

            } else { //иначе - редирект на главную
                $f3->$f3->reroute('/');
            }

        }
);

Гатова! Насамрэч, гэта было проста.

перанакіраванне

Справа засталася за малым:

  1. Атрымаць параметр з URL
  2. Праверыць яго наяўнасць у БД
  3. Атрымаць з БД адпаведную спасылку
  4. Перанакіраваць карыстальніка
  5. Profit!

Працягваем пісаць код пасля мінулага Роўта.

$f3->route('GET /@code', //указываем параметр после "@", он попадет в PARAMS
    function($f3) {

        //снова определяем $db
        $db = new DBSQL(
            'mysql:host=localhost;port=3306;dbname=linker',
            'root',
            ''
        );

        $code = $f3->get('PARAMS.code'); //получаем параметр

        $link = new DBSQLMapper($db,'links'); 

        //если получается получить ссылку из БД - получаем, увеличиваем количество переходов и перенаправляем
        if ($link->load(array('code="'.$code.'"', 'link=?'))) {
            $link->hits++;
            $link->save();

            $f3->reroute($link->link);
        } else {
            $f3->reroute('/'); //а если такой ссылки нет - милости просим на главную
        }
    }
);

Вы маглі заўважыць, што ў і ў роўце newLink, і ў роўце вышэй вызначацца адно і тое ж - бо код можа супасці з "newLink" (не можа, у генератары толькі літары верхняга рэгістра), але бо спачатку вызначаны ён, то ён і выканаецца першым.

$f3→run()!

Дзякуй за чытанне!
Я буду рады, калі Вы напішаце каментар, і паправіце калі што не так.

А ў якасці хатняга задання ці доказу ляноты аўтара (мяне), пакідаю спісачак, што можна зрабіць. Бо лепей вучыцца на практыцы!

  • Гэта вядома малаверагодна, але пры генерацыі $g_code можа паўтарыцца, так што прапаную вам напісаць функцыю, якая будзе правяраць гэта.
  • Яшчэ можна зрабіць нармальную статыстыку і выводзіць яе па пераходзе на /@code/stats
  • Забараніць ствараць спасылкі на сам сэрвіс скарачэння спасылак, стварыць спіс "абароненых" ад пакарочвання рэсурсаў
  • Настойліва рэкамендую нават у такой маленькай справе рабіць валідацыю ўводу і на боку сервера, з высновай якія адпавядаюць памылак, не варта спадзявацца на даданне аттрыбута required і тыпу type=«url» да поля ўводу
    RedComrade

  • Прапануйце ў каментары…

    На сувязі)

Крыніца: habr.com

Дадаць каментар