X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/9f56a417a1c20508f64fd80dc3e8f0eab6ec5f98..cfbcbda0ad848334640ad849ed618873ecba8eb4:/IkiWiki/Plugin/osm.pm diff --git a/IkiWiki/Plugin/osm.pm b/IkiWiki/Plugin/osm.pm index 09b34850f..472e26945 100644 --- a/IkiWiki/Plugin/osm.pm +++ b/IkiWiki/Plugin/osm.pm @@ -9,457 +9,449 @@ use warnings; use IkiWiki 3.0; sub import { - add_underlay("javascript"); - hook(type => "getsetup", id => "osm", call => \&getsetup); - hook(type => "format", id => "osm", call => \&format); - hook(type => "preprocess", id => "osm", call => \&preprocess); # backward compatibility - hook(type => "preprocess", id => "waypoint", call => \&process_waypoint); - hook(type => "savestate", id => "waypoint", call => \&savestate); - hook(type => "cgi", id => "osm", call => \&cgi); + add_underlay("osm"); + hook(type => "getsetup", id => "osm", call => \&getsetup); + hook(type => "format", id => "osm", call => \&format); + hook(type => "preprocess", id => "osm", call => \&preprocess); + hook(type => "preprocess", id => "waypoint", call => \&process_waypoint); + hook(type => "savestate", id => "waypoint", call => \&savestate); + hook(type => "cgi", id => "osm", call => \&cgi); } sub getsetup () { - return - plugin => { - safe => 1, - rebuild => 1, - section => "special-purpose", - }, - osm_default_zoom => { - type => "integer", - example => "15", - description => "the default zoon when you click on the map link", - safe => 1, - rebuild => 1, - }, - osm_default_icon => { - type => "string", - example => "img/osm.png", - description => "the icon showed on links and on the main map", - safe => 0, - rebuild => 1, - }, - osm_alt => { - type => "string", - example => "", - description => "the alt tag of links, defaults to empty", - safe => 0, - rebuild => 1, - }, - osm_format => { - type => "string", - example => "KML", - description => "the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)", - safe => 1, - rebuild => 1, - }, - osm_tag_default_icon => { - type => "string", - example => "icon.png", - description => "the icon attached to a tag so that pages tagged with that tag will have that icon on the map", - safe => 0, - rebuild => 1, - }, - osm_tag_icons => { - type => "string", - example => { 'test' => '/img/test.png', - 'trailer' => '/img/trailer.png' ,}, - description => "tag to icon mapping, leading slash is important!", - safe => 0, - rebuild => 1, - }, + return + plugin => { + safe => 1, + rebuild => 1, + section => "special-purpose", + }, + osm_default_zoom => { + type => "integer", + example => "15", + description => "the default zoom when you click on the map link", + safe => 1, + rebuild => 1, + }, + osm_default_icon => { + type => "string", + example => "ikiwiki/images/osm.png", + description => "the icon shown on links and on the main map", + safe => 0, + rebuild => 1, + }, + osm_alt => { + type => "string", + example => "", + description => "the alt tag of links, defaults to empty", + safe => 0, + rebuild => 1, + }, + osm_format => { + type => "string", + example => "KML", + description => "the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)", + safe => 1, + rebuild => 1, + }, + osm_tag_default_icon => { + type => "string", + example => "icon.png", + description => "the icon attached to a tag, displayed on the map for tagged pages", + safe => 0, + rebuild => 1, + }, + osm_openlayers_url => { + type => "string", + example => "http://www.openlayers.org/api/OpenLayers.js", + description => "Url for the OpenLayers.js file", + safe => 0, + rebuild => 1, + }, + osm_layers => { + type => "string", + example => { 'OSM', 'GoogleSatellite' }, + description => "Layers to use in the map. Can be either the 'OSM' string or a type option for Google maps (GoogleNormal, GoogleSatellite, GoogleHybrid or GooglePhysical). It can also be an arbitrary URL in a syntax acceptable for OpenLayers.Layer.OSM.url parameter.", + safe => 0, + rebuild => 1, + }, + osm_google_apikey => { + type => "string", + example => "", + description => "Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key", + safe => 1, + rebuild => 1, + }, +} + +sub register_rendered_files { + my $map = shift; + my $page = shift; + my $dest = shift; + + if ($page eq $dest) { + my %formats = get_formats(); + if ($formats{'GeoJSON'}) { + will_render($page, "$map/pois.json"); + } + if ($formats{'CSV'}) { + will_render($page, "$map/pois.txt"); + } + if ($formats{'KML'}) { + will_render($page, "$map/pois.kml"); + } + } } sub preprocess { - my %params=@_; - my $page = $params{'page'}; - my $dest = $params{'destpage'}; - my $loc = $params{'loc'}; # sanitized below - my $lat = $params{'lat'}; # sanitized below - my $lon = $params{'lon'}; # sanitized below - my $href = $params{'href'}; - - my $fullscreen = defined($params{'fullscreen'}); # sanitized here - my ($width, $height, $float); - if ($fullscreen) { - $height = '100%'; - $width = '100%'; - $float = 0; - } else { - $height = scrub($params{'height'} || "300px", $page, $dest); # sanitized here - $width = scrub($params{'width'} || "500px", $page, $dest); # sanitized here - $float = (defined($params{'right'}) && 'right') || (defined($params{'left'}) && 'left'); # sanitized here - } - my $zoom = scrub($params{'zoom'} // $config{'osm_default_zoom'} // 15, $page, $dest); # sanitized below - my $map; - if ($fullscreen) { - $map = $params{'map'} || $page; - } else { - $map = $params{'map'} || 'map'; - } - $map = scrub($map, $page, $dest); # sanitized here - my $name = scrub($params{'name'} || $map, $page, $dest); - - if (defined($lon) || defined($lat) || defined($loc)) { - ($lon, $lat) = scrub_lonlat($loc, $lon, $lat); - } - - if ($zoom !~ /^\d\d?$/ || $zoom < 2 || $zoom > 18) { - error("Bad zoom"); - } - $pagestate{$page}{'osm'}{$map}{'displays'}{$name} = - { - 'height' => $height, - 'width' => $width, - 'float' => $float, - 'zoom' => $zoom, - 'fullscreen' => $fullscreen, - 'editable' => defined($params{'editable'}), - 'lat' => $lat, - 'lon' => $lon, - 'href' => $href, - }; - return "
"; + my %params=@_; + my $page = $params{page}; + my $dest = $params{destpage}; + my $loc = $params{loc}; # sanitized below + my $lat = $params{lat}; # sanitized below + my $lon = $params{lon}; # sanitized below + my $href = $params{href}; + + my ($width, $height, $float); + $height = scrub($params{'height'} || "300px", $page, $dest); # sanitized here + $width = scrub($params{'width'} || "500px", $page, $dest); # sanitized here + $float = (defined($params{'right'}) && 'right') || (defined($params{'left'}) && 'left'); # sanitized here + + my $zoom = scrub($params{'zoom'} // $config{'osm_default_zoom'} // 15, $page, $dest); # sanitized below + my $map; + $map = $params{'map'} || 'map'; + + $map = scrub($map, $page, $dest); # sanitized here + my $name = scrub($params{'name'} || $map, $page, $dest); + + if (defined($lon) || defined($lat) || defined($loc)) { + ($lon, $lat) = scrub_lonlat($loc, $lon, $lat); + } + + if ($zoom !~ /^\d\d?$/ || $zoom < 2 || $zoom > 18) { + error("Bad zoom"); + } + + if (! defined $href || ! length $href) { + $href=IkiWiki::cgiurl( + do => "osm", + map => $map, + ); + } + + register_rendered_files($map, $page, $dest); + + $pagestate{$page}{'osm'}{$map}{'displays'}{$name} = { + height => $height, + width => $width, + float => $float, + zoom => $zoom, + fullscreen => 0, + editable => defined($params{'editable'}), + lat => $lat, + lon => $lon, + href => $href, + google_apikey => $config{'osm_google_apikey'}, + }; + return ""; } sub process_waypoint { - my %params=@_; - my $loc = $params{'loc'}; # sanitized below - my $lat = $params{'lat'}; # sanitized below - my $lon = $params{'lon'}; # sanitized below - my $page = $params{'page'}; # not sanitized? - my $dest = $params{'destpage'}; # not sanitized? - my $hidden = defined($params{'hidden'}); # sanitized here - my ($p) = $page =~ /(?:^|\/)([^\/]+)\/?$/; # shorter page name - my $name = scrub($params{'name'} || $p, $page, $dest); # sanitized here - my $desc = scrub($params{'desc'} || '', $page, $dest); # sanitized here - my $zoom = scrub($params{'zoom'} // $config{'osm_default_zoom'} // 15, $page, $dest); # sanitized below - my $icon = $config{'osm__default_icon'} || "img/osm.png"; # sanitized: we trust $config - my $map = scrub($params{'map'} || 'map', $page, $dest); # sanitized here - my $alt = $config{'osm_alt'} ? "alt=\"$config{'osm_alt'}\"" : ''; # sanitized: we trust $config - if ($zoom !~ /^\d\d?$/ || $zoom < 2 || $zoom > 18) { - error("Bad zoom"); - } - - ($lon, $lat) = scrub_lonlat($loc, $lon, $lat); - if (!defined($lat) || !defined($lon)) { - error("Must specify lat and lon"); - } - - my $tag = $params{'tag'}; - if ($tag) { - if (!defined($config{'osm_tag_icons'}->{$tag})) { - error("invalid tag specified, see osm_tag_icons configuration or don't specify any"); - } - $icon = $config{'osm_tag_icons'}->{$tag}; - } else { - foreach my $t (keys %{$typedlinks{$page}{'tag'}}) { - if ($icon = get_tag_icon($t)) { - $tag = $t; - last; - } - $t =~ s!/$config{'tagbase'}/!!; - if ($icon = get_tag_icon($t)) { - $tag = $t; - last; - } - } - } - $icon = "/img/unknown.png" unless $icon; - $tag = '' unless $tag; - if ($page eq $dest) { - if (!defined($config{'osm_format'}) || !$config{'osm_format'}) { - $config{'osm_format'} = 'KML'; - } - my %formats = map { $_ => 1 } split(/, */, $config{'osm_format'}); - if ($formats{'GeoJSON'}) { - will_render($page,$config{destdir} . "/$map/pois.json"); - } - if ($formats{'CSV'}) { - will_render($page,$config{destdir} . "/$map/pois.txt"); - } - if ($formats{'KML'}) { - will_render($page,$config{destdir} . "/$map/pois.kml"); - } - - } - my $href = "/ikiwiki.cgi?do=osm&map=$map&lat=$lat&lon=$lon&zoom=$zoom"; - if (defined($destsources{htmlpage($map)})) { - $href = urlto($map,$page) . "?lat=$lat&lon=$lon&zoom=$zoom"; - } - $pagestate{$page}{'osm'}{$map}{'waypoints'}{$name} = - { - 'page' => $page, - 'desc' => $desc, - 'icon' => $icon, - 'tag' => $tag, - 'lat' => $lat, - 'lon' => $lon, - 'href' => urlto($page,$map), # how to link back to the page from the map, not to be confused with the URL of the map itself sent to the embeded map below - }; - my $output = ''; - if (defined($params{'embed'})) { - $params{'href'} = $href; # propagate down to embeded - $output .= preprocess(%params); - } - if (!$hidden) { - $href =~ s!&!&!g; - $output .= ""; - } - return $output; + my %params=@_; + my $loc = $params{'loc'}; # sanitized below + my $lat = $params{'lat'}; # sanitized below + my $lon = $params{'lon'}; # sanitized below + my $page = $params{'page'}; # not sanitized? + my $dest = $params{'destpage'}; # not sanitized? + my $hidden = defined($params{'hidden'}); # sanitized here + my ($p) = $page =~ /(?:^|\/)([^\/]+)\/?$/; # shorter page name + my $name = scrub($params{'name'} || $p, $page, $dest); # sanitized here + my $desc = scrub($params{'desc'} || '', $page, $dest); # sanitized here + my $zoom = scrub($params{'zoom'} // $config{'osm_default_zoom'} // 15, $page, $dest); # sanitized below + my $icon = $config{'osm_default_icon'} || "ikiwiki/images/osm.png"; # sanitized: we trust $config + my $map = scrub($params{'map'} || 'map', $page, $dest); # sanitized here + my $alt = $config{'osm_alt'} ? "alt=\"$config{'osm_alt'}\"" : ''; # sanitized: we trust $config + if ($zoom !~ /^\d\d?$/ || $zoom < 2 || $zoom > 18) { + error("Bad zoom"); + } + + ($lon, $lat) = scrub_lonlat($loc, $lon, $lat); + if (!defined($lat) || !defined($lon)) { + error("Must specify lat and lon"); + } + + my $tag = $params{'tag'}; + foreach my $t (keys %{$typedlinks{$page}{'tag'}}) { + if ($icon = get_tag_icon($t)) { + $tag = $t; + last; + } + $t =~ s!/$config{'tagbase'}/!!; + if ($icon = get_tag_icon($t)) { + $tag = $t; + last; + } + } + $icon = urlto($icon, $dest, 1); + $icon =~ s!/*$!!; # hack - urlto shouldn't be appending a slash in the first place + $tag = '' unless $tag; + register_rendered_files($map, $page, $dest); + $pagestate{$page}{'osm'}{$map}{'waypoints'}{$name} = { + page => $page, + desc => $desc, + icon => $icon, + tag => $tag, + lat => $lat, + lon => $lon, + # How to link back to the page from the map, not to be + # confused with the URL of the map itself sent to the + # embeded map below. Note: used in generated KML etc file, + # so must be absolute. + href => urlto($page), + }; + + my $mapurl = IkiWiki::cgiurl( + do => "osm", + map => $map, + lat => $lat, + lon => $lon, + zoom => $zoom, + ); + my $output = ''; + if (defined($params{'embed'})) { + $output .= preprocess(%params, + href => $mapurl, + ); + } + if (!$hidden) { + $output .= ""; + } + return $output; } # get the icon from the given tag sub get_tag_icon($) { - my $tag = shift; - # look for an icon attached to the tag - my $attached = $tag . '/' . $config{'osm_tag_default_icon'}; - if (srcfile($attached)) { - return $attached; - } - # look for the old way: mappings - if ($config{'osm_tag_icons'}->{$tag}) { - return $config{'osm_tag_icons'}->{$tag}; - } else { - return undef; - } + my $tag = shift; + # look for an icon attached to the tag + my $attached = $tag . '/' . $config{'osm_tag_default_icon'}; + if (srcfile($attached)) { + return $attached; + } + else { + return undef; + } } sub scrub_lonlat($$$) { - my ($loc, $lon, $lat) = @_; - if($loc) { - if($loc =~ /^\s*(\-?\d+(?:\.\d*°?|(?:°?|\s)\s*\d+(?:\.\d*\'?|(?:\'|\s)\s*\d+(?:\.\d*)?\"?|\'?)°?)[NS]?)\s*\,?\;?\s*(\-?\d+(?:\.\d*°?|(?:°?|\s)\s*\d+(?:\.\d*\'?|(?:\'|\s)\s*\d+(?:\.\d*)?\"?|\'?)°?)[EW]?)\s*$/) { - $lat = $1; - $lon = $2; - } else { - error("Bad loc"); - } - } - if(defined($lat)) { - if($lat =~ /^(\-?)(\d+)(?:(\.\d*)°?|(?:°|\s)\s*(\d+)(?:(\.\d*)\'?|(?:\'|\s)\s*(\d+(?:\.\d*)?\"?)|\'?)|°?)\s*([NS])?\s*$/) { - $lat = $2 + ($3//0) + ((($4//0) + (($5//0) + (($6//0)/60.)))/60.); - if (($1 eq '-') || (($7//'') eq 'S')) { - $lat = - $lat; - } - } else { - error("Bad lat"); - } - } - if(defined($lon)) { - if($lon =~ /^(\-?)(\d+)(?:(\.\d*)°?|(?:°|\s)\s*(\d+)(?:(\.\d*)\'?|(?:\'|\s)\s*(\d+(?:\.\d*)?\"?)|\'?)|°?)\s*([EW])?$/) { - $lon = $2 + ($3//0) + ((($4//0) + (($5//0) + (($6//0)/60.)))/60.); - if (($1 eq '-') || (($7//'') eq 'W')) { - $lon = - $lon; - } - } else { - error("Bad lon"); - } - } - if ($lat < -90 || $lat > 90 || $lon < -180 || $lon > 180) { - error("Location out of range"); - } - return ($lon, $lat); + my ($loc, $lon, $lat) = @_; + if ($loc) { + if ($loc =~ /^\s*(\-?\d+(?:\.\d*°?|(?:°?|\s)\s*\d+(?:\.\d*\'?|(?:\'|\s)\s*\d+(?:\.\d*)?\"?|\'?)°?)[NS]?)\s*\,?\;?\s*(\-?\d+(?:\.\d*°?|(?:°?|\s)\s*\d+(?:\.\d*\'?|(?:\'|\s)\s*\d+(?:\.\d*)?\"?|\'?)°?)[EW]?)\s*$/) { + $lat = $1; + $lon = $2; + } + else { + error("Bad loc"); + } + } + if (defined($lat)) { + if ($lat =~ /^(\-?)(\d+)(?:(\.\d*)°?|(?:°|\s)\s*(\d+)(?:(\.\d*)\'?|(?:\'|\s)\s*(\d+(?:\.\d*)?\"?)|\'?)|°?)\s*([NS])?\s*$/) { + $lat = $2 + ($3//0) + ((($4//0) + (($5//0) + (($6//0)/60.)))/60.); + if (($1 eq '-') || (($7//'') eq 'S')) { + $lat = - $lat; + } + } + else { + error("Bad lat"); + } + } + if (defined($lon)) { + if ($lon =~ /^(\-?)(\d+)(?:(\.\d*)°?|(?:°|\s)\s*(\d+)(?:(\.\d*)\'?|(?:\'|\s)\s*(\d+(?:\.\d*)?\"?)|\'?)|°?)\s*([EW])?$/) { + $lon = $2 + ($3//0) + ((($4//0) + (($5//0) + (($6//0)/60.)))/60.); + if (($1 eq '-') || (($7//'') eq 'W')) { + $lon = - $lon; + } + } + else { + error("Bad lon"); + } + } + if ($lat < -90 || $lat > 90 || $lon < -180 || $lon > 180) { + error("Location out of range"); + } + return ($lon, $lat); } sub savestate { - my %waypoints = (); - my %linestrings = (); - foreach my $page (keys %pagestate) { - if (exists $pagestate{$page}{'osm'}) { - foreach my $map (keys %{$pagestate{$page}{'osm'}}) { - foreach my $name (keys %{$pagestate{$page}{'osm'}{$map}{'waypoints'}}) { - debug("found waypoint $name"); - $waypoints{$map}{$name} = $pagestate{$page}{'osm'}{$map}{'waypoints'}{$name}; - } - } - } - } - foreach my $page (keys %pagestate) { - if (exists $pagestate{$page}{'osm'}) { - foreach my $map (keys %{$pagestate{$page}{'osm'}}) { - # examine the links on this page - foreach my $name (keys %{$pagestate{$page}{'osm'}{$map}{'waypoints'}}) { - if (exists $links{$page}) { - foreach my $otherpage (@{$links{$page}}) { - if (exists $waypoints{$map}{$otherpage}) { - push(@{$linestrings{$map}}, [ [ $waypoints{$map}{$name}{'lon'}, $waypoints{$map}{$name}{'lat'} ], - [ $waypoints{$map}{$otherpage}{'lon'}, $waypoints{$map}{$otherpage}{'lat'} ] ]); - } - } - } - } - } - # clear the state, it will be regenerated on the next parse - # the idea here is to clear up removed waypoints... - $pagestate{$page}{'osm'} = (); - } - } - if (!defined($config{'osm_format'}) || !$config{'osm_format'}) { - $config{'osm_format'} = 'KML'; - } - my %formats = map { $_ => 1 } split(/, */, $config{'osm_format'}); - if ($formats{'GeoJSON'}) { - writejson(\%waypoints, \%linestrings); - } - if ($formats{'CSV'}) { - writecsvs(\%waypoints, \%linestrings); - } - if ($formats{'KML'}) { - writekml(\%waypoints, \%linestrings); - } + my %waypoints = (); + my %linestrings = (); + + foreach my $page (keys %pagestate) { + if (exists $pagestate{$page}{'osm'}) { + foreach my $map (keys %{$pagestate{$page}{'osm'}}) { + foreach my $name (keys %{$pagestate{$page}{'osm'}{$map}{'waypoints'}}) { + debug("found waypoint $name"); + $waypoints{$map}{$name} = $pagestate{$page}{'osm'}{$map}{'waypoints'}{$name}; + } + } + } + } + + foreach my $page (keys %pagestate) { + if (exists $pagestate{$page}{'osm'}) { + foreach my $map (keys %{$pagestate{$page}{'osm'}}) { + # examine the links on this page + foreach my $name (keys %{$pagestate{$page}{'osm'}{$map}{'waypoints'}}) { + if (exists $links{$page}) { + foreach my $otherpage (@{$links{$page}}) { + if (exists $waypoints{$map}{$otherpage}) { + push(@{$linestrings{$map}}, [ + [ $waypoints{$map}{$name}{'lon'}, $waypoints{$map}{$name}{'lat'} ], + [ $waypoints{$map}{$otherpage}{'lon'}, $waypoints{$map}{$otherpage}{'lat'} ] + ]); + } + } + } + } + } + # clear the state, it will be regenerated on the next parse + # the idea here is to clear up removed waypoints... + $pagestate{$page}{'osm'} = (); + } + } + + my %formats = get_formats(); + if ($formats{'GeoJSON'}) { + writejson(\%waypoints, \%linestrings); + } + if ($formats{'CSV'}) { + writecsvs(\%waypoints, \%linestrings); + } + if ($formats{'KML'}) { + writekml(\%waypoints, \%linestrings); + } } sub writejson($;$) { - my %waypoints = %{$_[0]}; - my %linestrings = %{$_[1]}; - eval q{use JSON}; - error $@ if $@; - foreach my $map (keys %waypoints) { - my %geojson = ( "type" => "FeatureCollection", "features" => []); - foreach my $name (keys %{$waypoints{$map}}) { - my %marker = ( "type" => "Feature", - "geometry" => { "type" => "Point", "coordinates" => [ $waypoints{$map}{$name}{'lon'}, $waypoints{$map}{$name}{'lat'} ] }, - "properties" => $waypoints{$map}{$name} ); - push(@{$geojson{'features'}}, \%marker); - } - foreach my $linestring (@{$linestrings{$map}}) { - my %json = ( "type" => "Feature", - "geometry" => { "type" => "LineString", "coordinates" => $linestring }); - push(@{$geojson{'features'}}, \%json); - } - debug('writing pois file pois.json in ' . $config{destdir} . "/$map"); - writefile("pois.json",$config{destdir} . "/$map",to_json(\%geojson)); - } + my %waypoints = %{$_[0]}; + my %linestrings = %{$_[1]}; + eval q{use JSON}; + error $@ if $@; + foreach my $map (keys %waypoints) { + my %geojson = ( "type" => "FeatureCollection", "features" => []); + foreach my $name (keys %{$waypoints{$map}}) { + my %marker = ( "type" => "Feature", + "geometry" => { "type" => "Point", "coordinates" => [ $waypoints{$map}{$name}{'lon'}, $waypoints{$map}{$name}{'lat'} ] }, + "properties" => $waypoints{$map}{$name} ); + push @{$geojson{'features'}}, \%marker; + } + foreach my $linestring (@{$linestrings{$map}}) { + my %json = ( "type" => "Feature", + "geometry" => { "type" => "LineString", "coordinates" => $linestring }); + push @{$geojson{'features'}}, \%json; + } + writefile("pois.json", $config{destdir} . "/$map", to_json(\%geojson)); + } } sub writekml($;$) { - my %waypoints = %{$_[0]}; - my %linestrings = %{$_[1]}; - eval q{use XML::Writer}; - error $@ if $@; - foreach my $map (keys %waypoints) { - debug("writing pois file pois.kml in " . $config{destdir} . "/$map"); - -=pod -Sample placemark: - - -