/better-location

Telegram bot for parsing and generating various of location formats.

Primary LanguagePHPMIT LicenseMIT

BetterLocation

Simple but very smart Telegram bot for processing various types of location format and converting them to user-defined formats.

Available publicly on Telegram as @BetterLocationBot and web better-location.palider.cz.

GitHub Workflow Status

@BetterLocationBot example

Requirements

  • PHP webserver (written and tested with PHP 8.2)
  • Database server (written and tested with MariaDB 10)
  • Domain with SSL certificate (might be self-signed). Detailed requirements are described on Telegram's webhook page.

Installation

  1. Download/clone BetterLocation repository.
  2. Install production dependencies via composer install --no-dev - you need Composer to do that.
  3. Update APP_URL and all DB_* and TELEGRAM_* constants in data/config.local.php.
  4. Create database using structure.sql script.
  5. Optional: In case you are not doing this installation directly on your (web)hosting, copy all files there now.
  6. Follow instructions on /admin/index.php.

Development and testing

GitHub commit activity GitHub last commit

Install development depenencies via composer install --dev.

Code quality

Run PHPStan static analysis via composer phpstan.

Baseline can be re-generated via composer phpstan-baseline

Tests

Run PHPUnit tests via composer test which will run all tests available. For running only tests, that are very quick (great for precommit hook), run composer test-quick.

Notes

  • All tests, that are doing ANY request to external service must be labeled as @group request (more in PHPUnit docs)
  • Some tests may be skipped if missing configuration (Glympse, What3Words, ...)

Deep linking

This bot is supporting Telegram's deep linking using ?start=parameter or ?startgroup=parameter so you can create links from your website or app to directly perform one of actions listed below (currently only Show location).

Parameter start will open in user's private message and create "start" button.
Parameter startgroup works similarly, but user will be prompted to select group, where @BetterLocationBot will be added.

Show location

Show location as better message.
Because Telegram is very restrictive what can be in start parameter, WGS-84 coordinates are encoded as two parts (lat_lon) with _ as divider. To encode coordinate, multiply coordinate by 1 000 000 and round to integer.

Input coordinates Encoded coordinates Result link
50.733088,15.741169 50733088_15741169 https://t.me/BetterLocationBot?start=50733088_15741169
-14.7653,4.845524 -14765300_4845524 https://t.me/BetterLocationBot?start=-14765300_4845524
-41.326919711111,174.80770311111 -41326919_174807703 https://t.me/BetterLocationBot?start=-41326919_174807703

Internal

There are some internal usages of start parameters as add to favourite, but it is not recommended to use it from external applications, since it might change any time.
For encoding and decoding parameters are used InlineTextDecode(), InlineTextEncode(), generateStart() and generateStartCoords() methods from \App\TelegramCustomWrapper\TelegramHelper namespace.

Based on the simple DJTommek/php-template.