SM βuttonKeeper ReadMe (помощь, инструкции)

Что это?

SM βuttonKeeper — это PHP скрипт, способный хранить и показывать кнопки (баннеры, ссылки) дружественных Вам сайтов (или спонсорских). Человек приходит, берёт код Вашего баннера (кнопки, ссылки), помещает его у себя на сайте, затем регистрируется у Вас на SM βuttonKeeper. И после подтверждения электронной почты пользователя Вам приходит письмо от робота, содержащее код для установки на Ваш сайт, адрес страницы с Вашим кодом (кнопкой/баннером/ссылкой) и некоторые другие сведения. Вы проверяете корректность их, затем идёте в админку Вашего SM βuttonKeeper и там добавляете код пользователя. После этих операций кнопка/баннер/ссылка пользователя будет находиться на странице SM βuttonKeeper. Существует возможность установки и на ту страницу, на которую захочет пользователь. В этом случае придётся вручную добавлять его(её) код в HTML-код такой страницы, но только если Вы согласитесь с пожеланиями пользователя.

Установка

Извлеките содержимое архива в пустой каталог (с сохранением путей). Зайдите в админку (посетив login.php или admin.php), задайте пароль и другие данные в админке по свому вкусу. Пароль по умолчанию: password, обязательно смените его. Нажмите «Сохранить».

После этого можете загружать содержимое на удалённый сервер.

Обновление

Извлеките из архива все файлы, кроме файла config.php, файлов с точкой как первым символом в имени (например, .knopki) и содержимого подкаталога kdata. Извлеките также файл .htaccess. Закачайте всё извлечённое на сервер.

Использование

Для входа в админку зайдите браузером (в Интернете или на локальном сервере) на файл login.php, введите пароль (логин вводить не надо).

Вы можете выводить добавленные пользователями кнопки не только на главной странице SM βuttonKeeper`а, но и на любой HTML/PHP/и_т.д. странице при помощи создания ифрейма с адресом файла ifr.php (главное, правильно указать адрес, он должен быть или абсолютным, или задан относительно того файла, на котором размещается ифрейм). А цветовое оформление ифреймов задаётся стилями из файла ifrs.css, лежащего в корне скрипта SM βuttonKeeper`а. Файл ifrs.css редактируйте по своему вкусу, при этом достаточно загрузить его в корень нашего скрипта на сервере. Скриптовый файл ifr.php при этом редактировать особой надобности нет, там уже всё прописано так, чтоб стили из ifrs.css полностью определяли дизайн ifr.php, вернее, продуцируемых им страниц.

Чтобы вставить кнопки по N штук на страницу, можно придумать, к примеру, такой HTML-код:

Или чуть более сложный:

(В «чуть более сложном» параметр us означает имя (без точки и расширения) Вашего пользовательского файла стилей (.css), лежащего в каталоге со скриптом. Если этот параметр не указан, то подразумевается (и используется) ifrs, соответствующий файлу ifrs.css.)

И вставить его на страницу(-ы). Здесь в атрибуте src укажите URL Вашего файла ifr.php. Вы вольны, конечно же, поэкспериментировать с этим кодом — и добиться требуемого эффекта. Как говорится, вперёд и с песней!

История версий

Версия 2.2 от 12 марта 2024 г.

• теперь к файлу ifr.php в ифрейме (если Вы им пользуетесь) можно добавлять параметр us, задающий пользовательский css-файл; в качестве примеров в дистрибутиве имеются два таких файла: white.css и black.css; как их задавать в качестве стилей — см. выше, в разделе «Использование».

Версия 2.1 от 22 февраля 2024 г.

• убран баг предыдущей версии (если у кнопки в теге ссылки не было указано, в каком окне должна открываться страница, она открывалась в ифрейме; что, как Вы понимаете, не есть хорошо; теперь такие ссылки открываются в новом всплывающем окне, т.е. в _blank).

Версия 2.0 от 22 февраля 2024 г.

• созданы 2 новых файла — ifr.php и ifrs.css (стиль к ifr.php), предназначенные для того, чтоб кнопки/баннеры/ссылки можно было вывести на произвольной странице в ифрейме (читайте раздел «Использование» выше).

Версия 1.9.1 от 20 февраля 2024 г.

• устранена уязвимость, позволявшая украсть пароль, если пользователь/администратор/модератор перейдёт по ссылке, содержащей HTML-код в параметре id (как правило, хакеры подкидавыют его escape-закодированным, но вовсе не обязательно);
• устранена недоработка, выводившая сообщение «404» в неверной кодировке.

Версия 1.9 от 4 марта 2023 г.

• теперь HTML-код можно просмотреть любому посетителю (смысл скрывать его? всё равно человек может посмотреть исходник, так пусть лучше просмотрит его в удобном интерфейсе без необходимости «перелопачивать» код страницы);
• обновлены ссылки на официальную страницу и на некоторые другие места;
• в ReadMe (на веб-странице, которую сейчас читаете) добавлен счётчик.

Версия 1.8 от 6 декабря 2022 г.

• приспособлено для работы на HTTPS-сайтах, но старый добрый HTTP (без S) тоже поддерживается.

Версия 1.7 от 24 сентября 2022 г.

• теперь в админке не будет путаницы с GET-параметрами «do» и «action»; все action-ы превратились в do;
• если установлен пароль в виде слова «password», на странице админки admin.php Вы будете видеть ярко-красное предупреждение.

Версия 1.6 от 20 июля 2022 г.

• теперь из админки можно редактировать код кнопок/баннеров/ссылок, e-mail их хозяев и URL, на которых установлены кнопки/баннеры/ссылки Вашего сайта.

Версия 1.5 от 12 июля 2022 г.

• создана страница просмотра кода без его запуска и без необходимости лезть в меню браузера; вызывается из админки щелчком по ссылке «Код» напротив интересующей кнопки (баннера, ссылки);
• почистил ряд файлов от неиспользованного кода (редактирования несуществующего сообщения), унаследованного от других моих скриптов.

Версия 1.4 от 20 июня 2022 г.

• устранён некритичный баг (на странице info.php ссылки на разделы админки показывались не только админу, а и всем пользователям); а некритичный он потому, что при переходе по таким ссылкам в админку скрипт пускал только админа.

Версия 1.3 от 13 июня 2022 г.

• теперь в админке в списке появились пункты «Инфо»;
• исправлена ошибка (знак «&» вместо «?») в админке в ссылках на info.php.

Версия 1.2 от 2 июня 2022 г.

• убран баг (после добавления очередного сайта в админке выводилось сообщение о несуществующей переменной signa);
• теперь после добавления админом очередной кнопки (баннера/ссылки) в письме подателю отправляются как ссылка из ТОПа (так было в предыдущих версиях; а из ТОПа со временем пункт вытесняется последующими регистрациями), так и постоянная ссылка.

Версия 1.1 от 23 мая 2022 г.

• теперь в списке кнопок вместо предупредительных надписей «Действия по этому сайту пока не реализованы, находятся в разработке» появились ссылки на свойства, соответствующие конкретным кнопкам и их владельцам.

Версия 1.0 от 5 мая 2022 г.

• в админке можно создавать список так называемых «мест», смысл которого в том, что в форме заявки появляется список разных страниц, на которых пользователь, возможно, захочет видеть свою кнопку; выбрать можно только одну такую страницу или выбрать вариант «не важно».

Версия 0.9 от 18 апреля 2022 г.

• сделана полноценная админка; соответственно, больше не нужно редактировать конфиг-файл вручную.

Версия 0.8 от 13 апреля 2022 г.

• теперь пользователь вправе высказать пожелание о том, на какой странице хотел бы, чтобы Вы разместили его код.

Версия 0.7 от 14 марта 2022 г.

• теперь пользователь получает по e-mail извещение, когда администратор добавит его кнопку (баннер, ссылку) на страницу; т.е. когда код пройдёт модерацию.

Версия 0.6 от 2 марта 2022 г.

• теперь администратору не нужно самому придумывать ID, генерируется автоматически.

Версия 0.5 от 14 февраля 2022 г.

• теперь из админки можно перемещать выбранную запись (кнопку/баннер/ссылку) на первое место или на последнее;
• скорректирован ReadMe (из истории версий была ошибочно перемещена запись о версии 0.4 — она оказалась в разделе «Использование»).

Версия 0.4 от 29 января 2022 г.

• устранён баг при подтверждении e-mail (появлялась надпись о том, что указанной записи не существует).

Версия 0.3 от 27 января 2022 г.

• ряд ссылок и второстепенных текстов заключены в noindex; тем же ссылкам добавлен атрибут rel="nofollow"; это придаст большее значение ссылкам кнопок, ради которых, собственно, и подаются заявки на размещение;
• теперь не нужно править код в случае желания показывать собственный(-е) заголовок(-ки), заключенные в h1; теперь для этого достаточно править файл конфигурации (config.php).

Версия 0.2 от 24 января 2022 г.

• появились заголовки у форм отправки заявки и одобрения заявки.

Версия 0.1 от 21 января 2022 г.

• умеем показывать кнопки, баннеры, ссылки по несколько шт. на страницу (по умолчанию — по 5);
• можно подавать заявки на внесение кнопок (баннеров, ссылок) сайтов в «SM βuttonKeeper»;
• администратор может добавлять кнопки (тем самым одобряя заявки) и удалять записи.