Skip to content

Commit 02c45c9

Browse files
mprinsmprins
committed
initial version of kml + georss sitemaps
1 parent 7c45299 commit 02c45c9

File tree

7 files changed

+311
-118
lines changed

7 files changed

+311
-118
lines changed

‎CHANGES

Whitespace-only changes.

‎README

-26
Original file line numberDiff line numberDiff line change
@@ -26,29 +26,3 @@ on how to install plugins in DokuWiki.
2626
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
2727
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
2828
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
29-
30-
31-
----
32-
Geohash.php
33-
(imported from https://github.com/riaf/rhaco2-repository/blob/master/libs/jp/riaf/util/Geohash.php)
34-
35-
Copyright (c) 2011 Keisuke SATO
36-
MIT License
37-
38-
Permission is hereby granted, free of charge, to any person obtaining a copy
39-
of this software and associated documentation files (the "Software"), to deal
40-
in the Software without restriction, including without limitation the rights
41-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
42-
copies of the Software, and to permit persons to whom the Software is
43-
furnished to do so, subject to the following conditions:
44-
45-
The above copyright notice and this permission notice shall be included in
46-
all copies or substantial portions of the Software.
47-
48-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
49-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
50-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
51-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
52-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
53-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
54-
THE SOFTWARE.

‎action.php

+86-37
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@
3030
*/
3131
class action_plugin_spatialhelper extends DokuWiki_Action_Plugin {
3232

33+
// TODO add configurable namespace, NOTE if $mediaID is namespaced the directory may need to be created
34+
private $media_kml = ':sitemap.kml';
35+
private $media_georss = ':sitemap.georss';
36+
3337
/**
3438
* Register for events.
3539
*
@@ -39,23 +43,23 @@ class action_plugin_spatialhelper extends DokuWiki_Action_Plugin {
3943
public function register(Doku_Event_Handler &$controller) {
4044
// listen for page add / delete events
4145
// http://www.dokuwiki.org/devel:event:indexer_page_add
42-
$controller->register_hook ( 'INDEXER_PAGE_ADD', 'BEFORE', $this, '_updateSpatialIndex' );
46+
$controller->register_hook ( 'INDEXER_PAGE_ADD', 'BEFORE', $this, 'handle_indexer_page_add' );
4347
$controller->register_hook ( 'IO_WIKIPAGE_WRITE', 'BEFORE', $this, '_removeFromIndex' );
4448

4549
// http://www.dokuwiki.org/devel:event:sitemap_generate
50+
$controller->register_hook ( 'SITEMAP_GENERATE', 'BEFORE', $this, 'handle_sitemap_generate_before' );
4651
// using after will only trigger us if a sitemap was actually created
47-
$controller->register_hook ( 'SITEMAP_GENERATE', 'AFTER', $this, '_createSpatialSitemap' );
48-
49-
// http://www.dokuwiki.org/devel:event:sitemap_ping
50-
// $controller->register_hook('SITEMAP_PING', 'AFTER', $this, '_ping');
52+
$controller->register_hook ( 'SITEMAP_GENERATE', 'AFTER', $this, 'handle_sitemap_generate_after' );
5153

5254
// handle actions we know of
53-
$controller->register_hook ( 'ACTION_ACT_PREPROCESS', 'BEFORE', $this, '_trap_action', array () );
55+
$controller->register_hook ( 'ACTION_ACT_PREPROCESS', 'BEFORE', $this, 'handle_action_act_preprocess', array () );
5456
$controller->register_hook ( 'TPL_ACT_UNKNOWN', 'BEFORE', $this, '_findnearby', array () );
5557

5658
// listen for media uploads and deletes
5759
$controller->register_hook ( 'MEDIA_UPLOAD_FINISH', 'BEFORE', $this, '_handle_media_uploaded', array () );
5860
$controller->register_hook ( 'MEDIA_DELETE_FILE', 'BEFORE', $this, '_handle_media_deleted', array () );
61+
62+
$controller->register_hook ( 'TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'handle_metaheader_output' );
5963
}
6064

6165
/**
@@ -66,19 +70,17 @@ public function register(Doku_Event_Handler &$controller) {
6670
* @param object $param
6771
* the parameters passed to register_hook when this handler was registered
6872
*/
69-
function _updateSpatialIndex(Doku_Event &$event, $param) {
73+
function handle_indexer_page_add(Doku_Event &$event, $param) {
7074
// $event→data['page'] – the page id
7175
// $event→data['body'] – empty, can be filled by additional content to index by your plugin
7276
// $event→data['metadata'] – the metadata that shall be indexed. This is an array where the keys are the metadata indexes and the value a string or an array of strings with the values. title and relation_references will already be set.
7377
$id = $event->data ['page'];
74-
dbg ( "start update spatial index for page: $id", '--- action_plugin_spatialhelper::_updateSpatialIndex ---' );
75-
76-
$indexer = plugin_load ( 'helper', 'spatialhelper_index' );
78+
$indexer = & plugin_load ( 'helper', 'spatialhelper_index' );
7779
if ($indexer) {
7880
$entries = $indexer->updateSpatialIndex ( $id );
79-
dbglog ( "Done indexing, entries: $entries", '--- action_plugin_spatialhelper::_updateSpatialIndex ---' );
81+
// dbglog ( "Done indexing, entries: $entries", '--- action_plugin_spatialhelper::_updateSpatialIndex ---' );
8082
} else {
81-
dbglog ( $indexer, '--- action_plugin_spatialhelper::_updateSpatialIndex: spatial indexer not found ---' );
83+
// dbglog ( $indexer, '--- action_plugin_spatialhelper::_updateSpatialIndex: spatial indexer not found ---' );
8284
}
8385
}
8486

@@ -98,8 +100,8 @@ function _removeFromIndex(Doku_Event &$event, $param) {
98100
// $data[1] – ns: The colon separated namespace path minus the trailing page name. (false if root ns)
99101
// $data[2] – page_name: The wiki page name.
100102
// $data[3] – rev: The page revision, false for current wiki pages.
101-
dbglog ( $event->data, "Event data in _removeFromIndex." );
102103

104+
// dbglog ( $event->data, "Event data in _removeFromIndex." );
103105
if (@file_exists ( $event->data [0] [0] )) {
104106
// file not new
105107
if (! $event->data [0] [1]) {
@@ -110,14 +112,27 @@ function _removeFromIndex(Doku_Event &$event, $param) {
110112
} else {
111113
$id = $event->data [1] . ":" . $event->data [2];
112114
}
113-
$indexer = plugin_load ( 'helper', 'spatialhelper_index' );
115+
$indexer = & plugin_load ( 'helper', 'spatialhelper_index' );
114116
if ($indexer) {
115117
$indexer->deleteFromIndex ( $id );
116118
}
117119
}
118120
}
119121
}
120122

123+
/**
124+
* Add a new SitemapItem object that points to the KML of public geocoded pages.
125+
*
126+
* @param Doku_Event $event
127+
* @param unknown $param
128+
*/
129+
function handle_sitemap_generate_before(Doku_Event &$event, $param) {
130+
$path = mediaFN ( $this->media_kml );
131+
$lastmod = @filemtime ( $path );
132+
$event->data ['items'] [] = new SitemapItem ( ml ( $this->media_kml, '', true, '&', true ), $lastmod );
133+
// dbglog ( $event->data ['items'], "Added a new SitemapItem object that points to the KML of public geocoded pages." );
134+
}
135+
121136
/**
122137
* Create a spatial sitemap or attach the geo/kml map to the sitemap.
123138
*
@@ -126,29 +141,35 @@ function _removeFromIndex(Doku_Event &$event, $param) {
126141
* @param mixed $param
127142
* not used
128143
*/
129-
function _createSpatialSitemap(Doku_Event &$event, $param) {
144+
function handle_sitemap_generate_after(Doku_Event &$event, $param) {
130145
// $event→data['items']: Array of SitemapItem instances, the array of sitemap items that already contains all public pages of the wiki
131146
// $event→data['sitemap']: The path of the file the sitemap will be saved to.
132-
dbglog ( $event->data, "_createSpatialSitemap" );
133-
dbglog ( $param, "_createSpatialSitemap" );
134-
// TODO add a new SitemapItem object that point to the KML of public geocoded pages
135-
// global $conf;
136-
// $url = $conf['baseurl'].$conf['cachedir'].'/sitemap.kml';
137-
// $lastmod = @filemtime($conf['cachedir'].'/sitemap.kml);
138-
// $event->data['items'][] = new SitemapItem($url,$lastmod);
147+
global $conf;
148+
149+
// dbglog ($event->data['items'], "createSpatialSitemap loading helper" );
150+
151+
if ($helper = & plugin_load ( 'helper', 'spatialhelper_sitemap' )) {
152+
// dbglog ( $helper, "createSpatialSitemap loaded helper." );
153+
154+
$kml = $helper->createKMLSitemap ( $this->media_kml );
155+
$rss = $helper->createGeoRSSSitemap ( $this->media_georss );
156+
157+
return $kml && $rss;
158+
} else {
159+
// dbglog ( $helper, "createSpatialSitemap NOT loaded helper." );
160+
}
139161
}
140162

141163
/**
142164
* trap findnearby action.
143-
* This addional handler is
144-
* required as described at: https://www.dokuwiki.org/devel:event:tpl_act_unknown
165+
* This addional handler is required as described at: https://www.dokuwiki.org/devel:event:tpl_act_unknown
145166
*
146167
* @param Doku_Event $event
147168
* event object by reference
148169
* @param mixed $param
149170
* not used
150171
*/
151-
function _trap_action(Doku_Event &$event, $param) {
172+
function handle_action_act_preprocess(Doku_Event &$event, $param) {
152173
if ($event->data != 'findnearby')
153174
return;
154175
$event->preventDefault ();
@@ -169,14 +190,14 @@ function _findnearby(Doku_Event &$event, $param) {
169190

170191
global $INPUT;
171192
$dist_prefix = '';
172-
if ($helper = &plugin_load ( 'helper', 'spatialhelper_search' )) {
193+
if ($helper = & plugin_load ( 'helper', 'spatialhelper_search' )) {
173194
if ($INPUT->has ( 'geohash' )) {
174195
$results = $helper->findNearby ( $INPUT->str ( 'geohash' ) );
175-
$dist_prefix = hsc($this->getLang ('result_distance_prefix')).' ';
196+
$dist_prefix = hsc ( $this->getLang ( 'result_distance_prefix' ) ) . ' ';
176197
} elseif ($INPUT->has ( 'lat' ) && $INPUT->has ( 'lon' )) {
177198
$results = $helper->findNearbyLatLon ( $INPUT->param ( 'lat' ), $INPUT->param ( 'lon' ) );
178199
} else {
179-
print '<div class="level1"><p>' . hsc ( $this->getLang ('invalidinput') ) . '</p></div>';
200+
print '<div class="level1"><p>' . hsc ( $this->getLang ( 'invalidinput' ) ) . '</p></div>';
180201
}
181202
$pages = ( array ) ($results [0]);
182203
$media = ( array ) $results [1];
@@ -185,7 +206,7 @@ function _findnearby(Doku_Event &$event, $param) {
185206
$precision = $results [4];
186207
}
187208

188-
print '<h1>' . $this->getLang ('results_header') . '</h1>' . DOKU_LF;
209+
print '<h1>' . $this->getLang ( 'results_header' ) . '</h1>' . DOKU_LF;
189210
print '<div class="level1">' . DOKU_LF;
190211
if (! empty ( $pages )) {
191212
$pagelist = '<ol>' . DOKU_LF;
@@ -194,26 +215,26 @@ function _findnearby(Doku_Event &$event, $param) {
194215
}
195216
$pagelist .= '</ol>' . DOKU_LF;
196217

197-
print '<h2>' . $this->getLang ('results_pages') . hsc ( ' lat,lon: ' . $location . ' (geohash: ' . $geohash . ')' ) . '</h2>';
218+
print '<h2>' . $this->getLang ( 'results_pages' ) . hsc ( ' lat,lon: ' . $location . ' (geohash: ' . $geohash . ')' ) . '</h2>';
198219
print '<div class="level2">' . DOKU_LF;
199220
print $pagelist;
200221
print "<p>Precision: $precision m</p>\n";
201222
print '</div>' . DOKU_LF;
202223
} else {
203-
print '<p>' . hsc ( $this->getLang ('nothingfound') ) . '</p>';
224+
print '<p>' . hsc ( $this->getLang ( 'nothingfound' ) ) . '</p>';
204225
}
205226
if (! empty ( $media )) {
206227
$pagelist = '<ol>' . DOKU_LF;
207228
foreach ( $media as $m ) {
208-
$opts = array();
229+
$opts = array ();
209230
$link = ml ( $m ['id'], $opts, false, '&amp;', false );
210231
$opts ['w'] = '100px';
211232
$src = ml ( $m ['id'], $opts );
212-
$pagelist .= '<li><a href="' . $link . '"><img src="' . $src . '"></a> (' . $dist_prefix . $page ['distance'] . 'm) </li>'. DOKU_LF;
233+
$pagelist .= '<li><a href="' . $link . '"><img src="' . $src . '"></a> (' . $dist_prefix . $page ['distance'] . 'm) </li>' . DOKU_LF;
213234
}
214235
$pagelist .= '</ol>' . DOKU_LF;
215236

216-
print '<h2>' . $this->getLang ('results_media') . hsc ( ' lat,lon: ' . $location . ' (geohash: ' . $geohash . ')' ) . '</h2>' . DOKU_LF;
237+
print '<h2>' . $this->getLang ( 'results_media' ) . hsc ( ' lat,lon: ' . $location . ' (geohash: ' . $geohash . ')' ) . '</h2>' . DOKU_LF;
217238
print '<div class="level2">' . DOKU_LF;
218239
print $pagelist;
219240
print "<p>Precision: $precision m</p>\n";
@@ -235,7 +256,8 @@ function _handle_media_uploaded(Doku_Event &$event, $param) {
235256
// data[3] the mime type of the file being uploaded
236257
// data[4] true if the uploaded file exists already
237258
// data[5] (since 2011-02-06) the PHP function used to move the file to the correct location
238-
dbglog ( $event->data, "_handle_media_uploaded::event data" );
259+
260+
// dbglog ( $event->data, "_handle_media_uploaded::event data" );
239261

240262
// check the list of mimetypes
241263
// if it's a supported type call appropriate index function
@@ -257,15 +279,42 @@ function _handle_media_deleted(Doku_Event &$event, $param) {
257279
// data['del'] Namespace directory unlink return code
258280
// data['name'] file name data['path'] full path to the file
259281
// data['size'] file size
260-
dbglog ( $event->data, "_handle_media_deleted::event data" );
282+
283+
// dbglog ( $event->data, "_handle_media_deleted::event data" );
261284

262285
// remove the media id from the index
263-
$indexer = plugin_load ( 'helper', 'spatialhelper_index' );
286+
$indexer = & plugin_load ( 'helper', 'spatialhelper_index' );
264287
if ($indexer) {
265288
$indexer->deleteFromIndex ( 'media__' . $event->data ['id'] );
266289
}
267290
}
268291

292+
/**
293+
* add a link to the spatial sitemap files in the header.
294+
*
295+
* @param Doku_Event $event
296+
* the DokuWiki event. $event->data is a two-dimensional
297+
* array of all meta headers. The keys are meta, link and script.
298+
* @param unknown_type $param
299+
*
300+
* @see http://www.dokuwiki.org/devel:event:tpl_metaheader_output
301+
*/
302+
public function handle_metaheader_output(Doku_Event &$event, $param) {
303+
// TODO maybe test for exist
304+
$event->data ["link"] [] = array (
305+
"type" => "application/atom+xml",
306+
"rel" => "alternate",
307+
"href" => ml ( $this->media_georss ),
308+
"title" => "Spatial ATOM Feed"
309+
);
310+
$event->data ["link"] [] = array (
311+
"type" => "application/vnd.google-earth.kml+xml",
312+
"rel" => "alternate",
313+
"href" => ml ( $this->media_kml ),
314+
"title" => "KML Sitemap"
315+
);
316+
}
317+
269318
/**
270319
* Calculate a new coordinate based on start, distance and bearing
271320
*

0 commit comments

Comments
 (0)