]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/osm.pm
bzr: bzr rm no longer has a --force option, remove
[git.ikiwiki.info.git] / IkiWiki / Plugin / osm.pm
index 0fd7ca4004d53eb944f6ae8417ddd0c5d8ad174a..a7baa5f2b968ebb0464a787be7371a26a2f98423 100644 (file)
@@ -9,7 +9,6 @@ use warnings;
 use IkiWiki 3.0;
 
 sub import {
-       add_underlay("javascript");
        add_underlay("osm");
        hook(type => "getsetup", id => "osm", call => \&getsetup);
        hook(type => "format", id => "osm", call => \&format);
@@ -35,8 +34,8 @@ sub getsetup () {
                },
                osm_default_icon => {
                        type => "string",
-                       example => "/ikiwiki/images/osm.png",
-                       description => "the icon shon on links and on the main map",
+                       example => "ikiwiki/images/osm.png",
+                       description => "the icon shown on links and on the main map",
                        safe => 0,
                        rebuild => 1,
                },
@@ -57,51 +56,70 @@ sub getsetup () {
                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",
+                       description => "the icon attached to a tag, displayed on the map for tagged pages",
                        safe => 0,
                        rebuild => 1,
                },
-               osm_tag_icons => {
+               osm_openlayers_url => {
                        type => "string",
-                       example => {
-                               'test' => '/img/test.png',
-                               'trailer' => '/img/trailer.png'
-                       },
-                       description => "tag to icon mapping, leading slash is important!",
+                       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 $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
-       }
+       $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 = $params{'map'} || 'map';
+       
        $map = scrub($map, $page, $dest); # sanitized here
        my $name = scrub($params{'name'} || $map, $page, $dest);
 
@@ -112,16 +130,27 @@ sub preprocess {
        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 => $fullscreen,
+               fullscreen => 0,
                editable => defined($params{'editable'}),
                lat => $lat,
                lon => $lon,
                href => $href,
+               google_apikey => $config{'osm_google_apikey'},
        };
        return "<div id=\"mapdiv-$name\"></div>";
 }
@@ -138,7 +167,7 @@ sub process_waypoint {
        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 $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) {
@@ -151,46 +180,20 @@ sub process_waypoint {
        }
 
        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");
+       foreach my $t (keys %{$typedlinks{$page}{'tag'}}) {
+               if ($icon = get_tag_icon($t)) {
+                       $tag = $t;
+                       last;
                }
-               $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;
-                       }
+               $t =~ s!/$config{'tagbase'}/!!;
+               if ($icon = get_tag_icon($t)) {
+                       $tag = $t;
+                       last;
                }
        }
-       $icon = "/ikiwiki/images/osm.png" unless $icon;
+       $icon = urlto($icon, $dest, 1);
        $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";
-       }
+       register_rendered_files($map, $page, $dest);
        $pagestate{$page}{'osm'}{$map}{'waypoints'}{$name} = {
                page => $page,
                desc => $desc,
@@ -198,19 +201,28 @@ sub process_waypoint {
                tag => $tag,
                lat => $lat,
                lon => $lon,
-               # how to link back to the page from the map, not to be
+               # 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
-               href => urlto($page,$map),
+               # 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'})) {
-               $params{'href'} = $href; # propagate down to embeded
-               $output .= preprocess(%params);
+               $output .= preprocess(%params,
+                       href => $mapurl,
+               );
        }
        if (!$hidden) {
-               $href =~ s!&!&amp;!g;
-               $output .= "<a href=\"$href\"><img class=\"img\" src=\"$icon\" $alt /></a>";
+               $output .= "<a href=\"$mapurl\"><img class=\"img\" src=\"$icon\" $alt /></a>";
        }
        return $output;
 }
@@ -223,10 +235,6 @@ sub get_tag_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;
        }
@@ -309,10 +317,7 @@ sub savestate {
                }
        }
 
-       if (!defined($config{'osm_format'}) || !$config{'osm_format'}) {
-               $config{'osm_format'} = 'KML';
-       }
-       my %formats = map { $_ => 1 } split(/, */, $config{'osm_format'});
+       my %formats = get_formats();
        if ($formats{'GeoJSON'}) {
                writejson(\%waypoints, \%linestrings);
        }
@@ -342,8 +347,7 @@ sub writejson($;$) {
                                "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));
+               writefile("pois.json", $config{destdir} . "/$map", to_json(\%geojson));
        }
 }
 
@@ -353,61 +357,31 @@ sub writekml($;$) {
        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:
-
-<?xml version="1.0" encoding="UTF-8"?>
-<kml xmlns="http://www.opengis.net/kml/2.2">
-  <Placemark>
-    <name>Simple placemark</name>
-    <description>Attached to the ground. Intelligently places itself 
-       at the height of the underlying terrain.</description>
-    <Point>
-      <coordinates>-122.0822035425683,37.42228990140251,0</coordinates>
-    </Point>
-  </Placemark>
-</kml>
-
-Sample style:
-
-
-        <Style id="sh_sunny_copy69">
-                <IconStyle>
-                        <scale>1.4</scale>
-                        <Icon>
-                                <href>http://waypoints.google.com/mapfiles/kml/shapes/sunny.png</href>
-                        </Icon>
-                        <hotSpot x="0.5" y="0.5" xunits="fraction" yunits="fraction"/>
-                </IconStyle>
-                <LabelStyle>
-                        <color>ff00aaff</color>
-                </LabelStyle>
-        </Style>
-
-
-=cut
-
-               use IO::File;
-               my $output = IO::File->new(">".$config{destdir} . "/$map/pois.kml");
-
-               my $writer = XML::Writer->new( OUTPUT => $output, DATA_MODE => 1, ENCODING => 'UTF-8');
+               my $output;
+               my $writer = XML::Writer->new( OUTPUT => \$output,
+                       DATA_MODE => 1, DATA_INDENT => ' ', ENCODING => 'UTF-8');
                $writer->xmlDecl();
                $writer->startTag("kml", "xmlns" => "http://www.opengis.net/kml/2.2");
+               $writer->startTag("Document");
 
                # first pass: get the icons
+               my %tags_map = (); # keep track of tags seen
                foreach my $name (keys %{$waypoints{$map}}) {
                        my %options = %{$waypoints{$map}{$name}};
-                       $writer->startTag("Style", id => $options{tag});
-                       $writer->startTag("IconStyle");
-                       $writer->startTag("Icon");
-                       $writer->startTag("href");
-                       $writer->characters($options{icon});
-                       $writer->endTag();
-                       $writer->endTag();
-                       $writer->endTag();
-                       $writer->endTag();
+                       if (!$tags_map{$options{tag}}) {
+                           debug("found new style " . $options{tag});
+                           $tags_map{$options{tag}} = ();
+                           $writer->startTag("Style", id => $options{tag});
+                           $writer->startTag("IconStyle");
+                           $writer->startTag("Icon");
+                           $writer->startTag("href");
+                           $writer->characters($options{icon});
+                           $writer->endTag();
+                           $writer->endTag();
+                           $writer->endTag();
+                           $writer->endTag();
+                       }
+                       $tags_map{$options{tag}}{$name} = \%options;
                }
        
                foreach my $name (keys %{$waypoints{$map}}) {
@@ -454,8 +428,10 @@ Sample style:
                        $writer->endTag();
                }
                $writer->endTag();
+               $writer->endTag();
                $writer->end();
-               $output->close();
+
+               writefile("pois.kml", $config{destdir} . "/$map", $output);
        }
 }
 
@@ -473,8 +449,7 @@ sub writecsvs($;$) {
                                $options{'icon'} . "\n";
                        $poisf .= $line;
                }
-               debug("writing pois file pois.txt in " . $config{destdir} . "/$map");
-               writefile("pois.txt",$config{destdir} . "/$map",$poisf);
+               writefile("pois.txt", $config{destdir} . "/$map", $poisf);
        }
 }
 
@@ -504,7 +479,7 @@ sub format (@) {
        return $params{content};
 }
 
-sub prefered_format() {
+sub preferred_format() {
        if (!defined($config{'osm_format'}) || !$config{'osm_format'}) {
                $config{'osm_format'} = 'KML';
        }
@@ -512,24 +487,26 @@ sub prefered_format() {
        return shift @spl;
 }
 
+sub get_formats() {
+       if (!defined($config{'osm_format'}) || !$config{'osm_format'}) {
+               $config{'osm_format'} = 'KML';
+       }
+       map { $_ => 1 } split(/, */, $config{'osm_format'});
+}
+
 sub include_javascript ($) {
        my $page=shift;
        my $loader;
 
-       eval q{use JSON};
-       error $@ if $@;
        if (exists $pagestate{$page}{'osm'}) {
                foreach my $map (keys %{$pagestate{$page}{'osm'}}) {
                        foreach my $name (keys %{$pagestate{$page}{'osm'}{$map}{'displays'}}) {
-                               my %options = %{$pagestate{$page}{'osm'}{$map}{'displays'}{$name}};
-                               $options{'map'} = $map;
-                               $options{'format'} = prefered_format();
-                               $loader .= "mapsetup(\"mapdiv-$name\", " . to_json(\%options) . ");\n";
+                               $loader .= map_setup_code($map, $name, %{$pagestate{$page}{'osm'}{$map}{'displays'}{$name}});
                        }
                }
        }
        if ($loader) {
-               return embed_map_code() . "<script type=\"text/javascript\" charset=\"utf-8\">$loader</script>";
+               return embed_map_code($page) . "<script type=\"text/javascript\" charset=\"utf-8\">$loader</script>";
        }
        else {
                return '';
@@ -541,6 +518,8 @@ sub cgi($) {
 
        return unless defined $cgi->param('do') &&
                $cgi->param("do") eq "osm";
+       
+       IkiWiki::loadindex();
 
        IkiWiki::decode_cgi_utf8($cgi);
 
@@ -553,147 +532,63 @@ sub cgi($) {
        print ("\r\n");
        print "<html><body>";
        print "<div id=\"mapdiv-$map\"></div>";
-       print embed_map_code($map);
-       print "<script type=\"text/javascript\" charset=\"utf-8\">mapsetup( 'mapdiv-$map', { 'map': '$map', 'lat': urlParams['lat'], 'lon': urlParams['lon'], 'zoom': urlParams['zoom'], 'fullscreen': 1, 'editable': 1, 'format': '" . prefered_format() . "'});</script>";
+       print embed_map_code();
+       print "<script type=\"text/javascript\" charset=\"utf-8\">";
+       print map_setup_code($map, $map,
+               lat => "urlParams['lat']",
+               lon => "urlParams['lon']",
+               zoom => "urlParams['zoom']",
+               fullscreen => 1,
+               editable => 1,
+               google_apikey => $config{'osm_google_apikey'},
+       );
+       print "</script>";
        print "</body></html>";
 
        exit 0;
 }
 
-sub embed_map_code() {
-       return <<EOF;
-<script src="http://www.openlayers.org/api/OpenLayers.js"></script>
-<script>
-// taken from http://stackoverflow.com/questions/901115/get-query-string-values-in-javascript
-var urlParams = {};
-(function () {
-       var e,
-       a = /\\+/g,  // Regex for replacing addition symbol with a space
-       r = /([^&=]+)=?([^&]*)/g,
-       d = function (s) { return decodeURIComponent(s.replace(a, " ")); },
-       q = window.location.search.substring(1);
-
-       while (e = r.exec(q))
-       urlParams[d(e[1])] = d(e[2]);
-})();
-
-function mapsetup(divname, options) {
-       div = document.getElementById(divname);
-       if (options.fullscreen) {
-               permalink = 'permalink';
-               div.style.top = 0;
-               div.style.left = 0;
-               div.style.position = 'absolute';
-               div.style.width = '100%';
-               div.style.height = '100%';
+sub embed_map_code(;$) {
+       my $page=shift;
+       my $olurl = $config{osm_openlayers_url} || "http://www.openlayers.org/api/OpenLayers.js";
+       my $code = '<script src="'.$olurl.'" type="text/javascript" charset="utf-8"></script>'."\n".
+               '<script src="'.urlto("ikiwiki/osm.js", $page).
+               '" type="text/javascript" charset="utf-8"></script>'."\n";
+       if ($config{'osm_google_apikey'}) {
+           $code .= '<script src="http://maps.google.com/maps?file=api&amp;v=2&amp;key='.$config{'osm_google_apikey'}.'&sensor=false" type="text/javascript" charset="utf-8"></script>';
+       }
+       return $code;
+}
+
+sub map_setup_code($;@) {
+       my $map=shift;
+       my $name=shift;
+       my %options=@_;
+
+       my $mapurl = $config{osm_map_url};
+
+       eval q{use JSON};
+       error $@ if $@;
+                               
+       $options{'format'} = preferred_format();
+
+       my %formats = get_formats();
+       if ($formats{'GeoJSON'}) {
+               $options{'jsonurl'} = urlto($map."/pois.json");
        }
-       else {
-               div.style.height = options.height;
-               div.style.width = options.width;
-               div.style.float = options.float;
-               permalink = {base: options.href, title: "View larger map"};
-       }
-       map = new OpenLayers.Map(divname, {
-               controls: [
-                       new OpenLayers.Control.Navigation(),
-                       new OpenLayers.Control.ScaleLine(),
-                       new OpenLayers.Control.Permalink(permalink)
-               ],
-               displayProjection: new OpenLayers.Projection("EPSG:4326"),
-               numZoomLevels: 18
-       });
-
-
-       map.addLayer(new OpenLayers.Layer.OSM());
-       if (options.format == 'CSV') {
-               pois = new OpenLayers.Layer.Text( "CSV",
-                       { location:"/" + options.map + "/pois.txt",
-                         projection: map.displayProjection
-                       });
-       } else if (options.format == 'GeoJSON') {
-               pois = new OpenLayers.Layer.Vector("GeoJSON", {
-                       protocol: new OpenLayers.Protocol.HTTP({
-                               url: "/" + options.map + "/pois.json",
-                               format: new OpenLayers.Format.GeoJSON()
-                       }),
-                       strategies: [new OpenLayers.Strategy.Fixed()]
-               });
-       } else {
-               pois = new OpenLayers.Layer.Vector("KML", {
-                       protocol: new OpenLayers.Protocol.HTTP({
-                               url: "/" + options.map + "/pois.kml",
-                               format: new OpenLayers.Format.KML({
-                                       extractStyles: true,
-                                       extractAttributes: true
-                               })
-                       }),
-               strategies: [new OpenLayers.Strategy.Fixed()]});
-       }
-       map.addLayer(pois);
-       select = new OpenLayers.Control.SelectFeature(pois);
-       map.addControl(select);
-       select.activate();
-
-       pois.events.on({
-               "featureselected": function (event) {
-                       var feature = event.feature;
-                       var content = '<h2><a href="' + feature.attributes.href + '">' +feature.attributes.name + "</a></h2>" + feature.attributes.description;
-                       popup = new OpenLayers.Popup.FramedCloud("chicken",
-                               feature.geometry.getBounds().getCenterLonLat(),
-                               new OpenLayers.Size(100,100),
-                               content,
-                               null, true, function () {select.unselectAll()});
-                       feature.popup = popup;
-                       map.addPopup(popup);
-               },
-               "featureunselected": function (event) {
-                       var feature = event.feature;
-                       if (feature.popup) {
-                               map.removePopup(feature.popup);
-                               feature.popup.destroy();
-                               delete feature.popup;
-                       }
-               }
-       });
-
-       if (options.editable) {
-               vlayer = new OpenLayers.Layer.Vector( "Editable" );
-               map.addControl(new OpenLayers.Control.EditingToolbar(vlayer));
-               map.addLayer(vlayer);
-       }
-
-       if (options.fullscreen) {
-               map.addControl(new OpenLayers.Control.PanZoomBar());
-               map.addControl(new OpenLayers.Control.LayerSwitcher({'ascending':false}));
-               map.addControl(new OpenLayers.Control.MousePosition());
-               map.addControl(new OpenLayers.Control.KeyboardDefaults());
-       } else {
-               map.addControl(new OpenLayers.Control.ZoomPanel());
-       }
-
-       //Set start centrepoint and zoom    
-       if (!options.lat || !options.lon) {
-               options.lat = urlParams['lat'];
-               options.lon = urlParams['lon'];
-       }
-       if (!options.zoom) {
-               options.zoom = urlParams['zoom'];
-       }
-       if (options.lat && options.lon) {
-               var lat = options.lat;
-               var lon = options.lon;
-               var zoom= options.zoom || 10;
-               center = new OpenLayers.LonLat( lon, lat ).transform(
-                       new OpenLayers.Projection("EPSG:4326"), // transform from WGS 1984
-                       map.getProjectionObject() // to Spherical Mercator Projection
-               );
-               map.setCenter (center, zoom);
-       } else {
-               pois.events.register("loadend", this, function () { map.zoomToExtent(pois.getDataExtent()); });
+       if ($formats{'CSV'}) {
+               $options{'csvurl'} = urlto($map."/pois.txt");
        }
-}
-</script>
-EOF
+       if ($formats{'KML'}) {
+               $options{'kmlurl'} = urlto($map."/pois.kml");
+       }
+
+       if ($mapurl) {
+               $options{'mapurl'} = $mapurl;
+       }
+        $options{'layers'} = $config{osm_layers};
+
+       return "mapsetup('mapdiv-$name', " . to_json(\%options) . ");";
 }
 
 1;