From 97f7aba080be7d164bcc155a40c370995489ea82 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Rapha=C3=ABl=20Gertz?= Date: Tue, 7 Sep 2021 15:36:06 +0200 Subject: [PATCH] Add osm util class --- Resources/config/packages/rapsys_pack.yaml | 8 + Util/OsmUtil.php | 358 +++++++++++++++++++++ 2 files changed, 366 insertions(+) create mode 100644 Util/OsmUtil.php diff --git a/Resources/config/packages/rapsys_pack.yaml b/Resources/config/packages/rapsys_pack.yaml index da2416e..fd9803d 100644 --- a/Resources/config/packages/rapsys_pack.yaml +++ b/Resources/config/packages/rapsys_pack.yaml @@ -25,6 +25,14 @@ services: #Register intl util class alias Rapsys\PackBundle\Util\IntlUtil: alias: 'rapsys_pack.intl_util' + #Register osm util service + rapsys_pack.osm_util: + class: 'Rapsys\PackBundle\Util\OsmUtil' + arguments: [ '%kernel.project_dir%/var/cache', '%rapsys_pack.public.path%', '%rapsys_pack.public.url%' ] + public: true + #Register osm util class alias + Rapsys\PackBundle\Util\OsmUtil: + alias: 'rapsys_pack.osm_util' #Register slugger util service rapsys_pack.slugger_util: class: 'Rapsys\PackBundle\Util\SluggerUtil' diff --git a/Util/OsmUtil.php b/Util/OsmUtil.php new file mode 100644 index 0000000..df66f2f --- /dev/null +++ b/Util/OsmUtil.php @@ -0,0 +1,358 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Rapsys\PackBundle\Util; + +use Symfony\Component\Filesystem\Exception\IOExceptionInterface; +use Symfony\Component\Filesystem\Filesystem; + +/** + * Helps manage osm images + */ +class OsmUtil { + /** + * The tile size + */ + const tz = 256; + + /** + * The cache directory + */ + protected $cache; + + /** + * The public path + */ + protected $path; + + /** + * The tile server + */ + protected $server; + + /** + * The tile servers + * + * @see https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames#Tile_servers + */ + protected $servers = [ + 'osm' => 'https://tile.openstreetmap.org/{Z}/{X}/{Y}.png', + 'cycle' => 'http://a.tile.thunderforest.com/cycle/{Z}/{X}/{Y}.png', + 'transport' => 'http://a.tile.thunderforest.com/transport/{Z}/{X}/{Y}.png' + ]; + + /** + * The public url + */ + protected $url; + + /** + * Creates a new osm util + * + * @param string $cache The cache directory + * @param string $path The public path + * @param string $url The public url + * @param string $server The server key + */ + function __construct(string $cache, string $path, string $url, string $server = 'osm') { + //Set cache + $this->cache = $cache.'/'.$server; + + //Set path + $this->path = $path.'/'.$server; + + //Set url + $this->url = $url.'/'.$server; + + //Set server key + $this->server = $server; + } + + /** + * Return the image + * + * @desc Generate image in jpeg format or load it from cache + * + * @param string $pathInfo The path info + * @param string $alt The image alt + * @param int $updated The updated timestamp + * @param float $latitude The latitude + * @param float $longitude The longitude + * @param int $zoom The zoom + * @param int $width The width + * @param int $height The height + * @return array The image array + */ + public function getImage(string $pathInfo, string $alt, int $updated, float $latitude, float $longitude, int $zoom = 18, int $width = 1280, int $height = 1280): array { + //Set path file + $path = $this->path.$pathInfo.'.jpeg'; + + //Without existing path + if (!is_dir($dir = dirname($path))) { + //Create filesystem object + $filesystem = new Filesystem(); + + try { + //Create path + //XXX: set as 0775, symfony umask (0022) will reduce rights (0755) + $filesystem->mkdir($dir, 0775); + } catch (IOExceptionInterface $e) { + //Throw error + throw new \Exception(sprintf('Output path "%s" do not exists and unable to create it', $dir), 0, $e); + } + } + + //With path file + if ( + false && + is_file($path) && + ($stat = stat($path)) && + $stat['mtime'] >= $updated + ) { + //Return image data + return [ + 'src' => $this->url.'/'.$stat['mtime'].$pathInfo.'.jpeg', + 'alt' => $alt, + 'height' => $height, + 'width' => $width + ]; + } + + //Create image instance + $image = new \Imagick(); + + //Add new image + $image->newImage($width, $height, new \ImagickPixel('transparent'), 'jpeg'); + + //Create tile instance + $tile = new \Imagick(); + + //Init context + $ctx = stream_context_create( + [ + 'http' => [ + #'header' => ['Referer: https://www.openstreetmap.org/'], + 'max_redirects' => 5, + 'timeout' => (int)ini_get('default_socket_timeout'), + #'user_agent' => 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/93.0.4577.63 Safari/537.36', + 'user_agent' => (string)ini_get('user_agent')?:'rapsys_air/2.0.0', + ] + ] + ); + + //Get tile xy + $tileX = floor($centerX = $this->longitudeToX($longitude, $zoom)); + $tileY = floor($centerY = $this->latitudeToY($latitude, $zoom)); + + //Calculate start xy + $startX = floor(($tileX * self::tz - $width) / self::tz); + $startY = floor(($tileY * self::tz - $height) / self::tz); + + //Calculate end xy + $endX = ceil(($tileX * self::tz + $width) / self::tz); + $endY = ceil(($tileY * self::tz + $height) / self::tz); + + for($x = $startX; $x <= $endX; $x++) { + for($y = $startY; $y <= $endY; $y++) { + //Set cache path + $cache = $this->cache.'/'.$zoom.'/'.$x.'/'.$y.'.png'; + + //Without cache path + if (!is_dir($dir = dirname($cache))) { + //Create filesystem object + $filesystem = new Filesystem(); + + try { + //Create path + //XXX: set as 0775, symfony umask (0022) will reduce rights (0755) + $filesystem->mkdir($dir, 0775); + } catch (IOExceptionInterface $e) { + //Throw error + throw new \Exception(sprintf('Output directory "%s" do not exists and unable to create it', $dir), 0, $e); + } + } + + //Without cache image + if (!is_file($cache)) { + //Set tile url + $tileUri = str_replace(['{Z}', '{X}', '{Y}'], [$zoom, $x, $y], $this->servers[$this->server]); + + //Store tile in cache + file_put_contents($cache, file_get_contents($tileUri, false, $ctx)); + } + + //Set dest x + $destX = intval(floor(($width / 2) - self::tz * ($centerX - $x))); + + //Set dest y + $destY = intval(floor(($height / 2) - self::tz * ($centerY - $y))); + + //Read tile from cache + $tile->readImage($cache); + + //Compose image + $image->compositeImage($tile, \Imagick::COMPOSITE_OVER, $destX, $destY); + + //Clear tile + $tile->clear(); + } + } + + //Add circle + //XXX: see https://www.php.net/manual/fr/imagick.examples-1.php#example-3916 + $draw = new \ImagickDraw(); + + //Set text antialias + $draw->setTextAntialias(true); + + //Set fill color + $draw->setFillColor('#cff'); + + //Set stroke color + $draw->setStrokeColor('#00c3f9'); + + //Set stroke width + $draw->setStrokeWidth(2); + + //Draw circle + $draw->circle($width/2 - 5, $height/2 - 5, $width/2 + 5, $height/2 + 5); + #$draw->circle($tileX/self::tz - 5, $tileY/self::tz - 5, $tileX/self::tz + 5, $tileY/self::tz + 5); + + //Draw on image + $image->drawImage($draw); + + //Strip image exif data and properties + $image->stripImage(); + + //Add latitude + //XXX: not supported by imagick :'( + $image->setImageProperty('exif:GPSLatitude', $this->latitudeToSexagesimal($latitude)); + + //Add longitude + //XXX: not supported by imagick :'( + $image->setImageProperty('exif:GPSLongitude', $this->longitudeToSexagesimal($longitude)); + + //Add description + //XXX: not supported by imagick :'( + $image->setImageProperty('exif:Description', $alt); + + //Save image + if (!$image->writeImage($path)) { + //Throw error + throw new \Exception(sprintf('Unable to write image "%s"', $dest)); + } + + //Get dest stat + $stat = stat($path); + + //Return image data + return [ + 'src' => $this->url.'/'.$stat['mtime'].$pathInfo.'.jpeg', + 'alt' => $alt, + 'height' => $height, + 'width' => $width + ]; + } + + /** + * Convert longitude to tile x number + * + * @see https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames#Lon..2Flat._to_tile_numbers_5 + * + * @param float $longitude The longitude + * @param int $zoom The zoom + * + * @return float The tile x + */ + public function longitudeToX(float $longitude, int $zoom): float { + return (($longitude + 180) / 360) * pow(2, $zoom); + } + + /** + * Convert latitude to tile y number + * + * @see https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames#Lon..2Flat._to_tile_numbers_5 + * + * @param $latitude The latitude + * @param $zoom The zoom + * + * @return float The tile y + */ + public function latitudeToY(float $latitude, int $zoom): float { + return (1 - log(tan(deg2rad($latitude)) + 1 / cos(deg2rad($latitude))) / pi()) / 2 * pow(2, $zoom); + } + + /** + * Convert tile x to longitude + * + * @param float $x The tile x + * @param int $zoom The zoom + * + * @return float The longitude + */ + public function xToLongitude(float $x, int $zoom): float { + return $x / pow(2, $zoom) * 360.0 - 180.0; + } + + /** + * Convert tile y to latitude + * + * @param float $y The tile y + * @param int $zoom The zoom + * + * @return float The latitude + */ + public function yToLatitude(float $y, int $zoom): float { + return rad2deg(atan(sinh(pi() * (1 - 2 * $y / pow(2, $zoom))))); + } + + /** + * Convert decimal latitude to sexagesimal + * + * @param float $latitude The decimal latitude + * + * @return string The sexagesimal longitude + */ + public function latitudeToSexagesimal(float $latitude): string { + //Set degree + $degree = $latitude % 60; + + //Set minute + $minute = ($latitude - $degree) * 60 % 60; + + //Set second + $second = ($latitude - $degree - $minute / 60) * 3600 % 3600; + + //Return sexagesimal longitude + return $degree.'°'.$minute.'\''.$second.'"'.($latitude >= 0 ? 'N' : 'S'); + } + + /** + * Convert decimal longitude to sexagesimal + * + * @param float $longitude The decimal longitude + * + * @return string The sexagesimal longitude + */ + public function longitudeToSexagesimal(float $longitude): string { + //Set degree + $degree = $longitude % 60; + + //Set minute + $minute = ($longitude - $degree) * 60 % 60; + + //Set second + $second = ($longitude - $degree - $minute / 60) * 3600 % 3600; + + //Return sexagesimal longitude + return $degree.'°'.$minute.'\''.$second.'"'.($longitude >= 0 ? 'E' : 'W'); + } +} -- 2.41.1