1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
<?php
// Classes and libraries for module system
//
// webtrees: Web based Family History software
// Copyright (C) 2014 webtrees development team.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
use WT\Auth;
class sitemap_WT_Module extends WT_Module implements WT_Module_Config {
const RECORDS_PER_VOLUME=500; // Keep sitemap files small, for memory, CPU and max_allowed_packet limits.
const CACHE_LIFE =1209600; // Two weeks
// Extend WT_Module
public function getTitle() {
return /* I18N: Name of a module - see http://en.wikipedia.org/wiki/Sitemaps */ WT_I18N::translate('Sitemaps');
}
// Extend WT_Module
public function getDescription() {
return /* I18N: Description of the “Sitemaps” module */ WT_I18N::translate('Generate sitemap files for search engines.');
}
// Extend WT_Module
public function modAction($mod_action) {
switch($mod_action) {
case 'admin':
$this->admin();
break;
case 'generate':
Zend_Session::writeClose();
$this->generate(WT_Filter::get('file'));
break;
default:
header('HTTP/1.0 404 Not Found');
}
}
private function generate($file) {
if ($file=='sitemap.xml') {
$this->generate_index();
} elseif (preg_match('/^sitemap-(\d+)-([isrmn])-(\d+).xml$/', $file, $match)) {
$this->generate_file($match[1], $match[2], $match[3]);
} else {
header('HTTP/1.0 404 Not Found');
}
}
// The index file contains references to all the other files.
// These files are the same for visitors/users/admins.
private function generate_index() {
// Check the cache
$timestamp = $this->getSetting( 'sitemap.timestamp');
if ($timestamp > WT_TIMESTAMP - self::CACHE_LIFE) {
$data = $this->getSetting('sitemap.xml');
} else {
$data='';
$lastmod='<lastmod>'.date('Y-m-d').'</lastmod>';
foreach (WT_Tree::getAll() as $tree) {
if ($tree->getPreference('include_in_sitemap')) {
$n=WT_DB::prepare("SELECT COUNT(*) FROM `##individuals` WHERE i_file=?")->execute(array($tree->tree_id))->fetchOne();
for ($i=0; $i<=$n/self::RECORDS_PER_VOLUME; ++$i) {
$data.='<sitemap><loc>'.WT_SERVER_NAME.WT_SCRIPT_PATH.'module.php?mod='.$this->getName().'&mod_action=generate&file=sitemap-'.$tree->tree_id.'-i-'.$i.'.xml</loc>'.$lastmod.'</sitemap>'.PHP_EOL;
}
$n=WT_DB::prepare("SELECT COUNT(*) FROM `##sources` WHERE s_file=?")->execute(array($tree->tree_id))->fetchOne();
if ($n) {
for ($i=0; $i<=$n/self::RECORDS_PER_VOLUME; ++$i) {
$data.='<sitemap><loc>'.WT_SERVER_NAME.WT_SCRIPT_PATH.'module.php?mod='.$this->getName().'&mod_action=generate&file=sitemap-'.$tree->tree_id.'-s-'.$i.'.xml</loc>'.$lastmod.'</sitemap>'.PHP_EOL;
}
}
$n=WT_DB::prepare("SELECT COUNT(*) FROM `##other` WHERE o_file=? AND o_type='REPO'")->execute(array($tree->tree_id))->fetchOne();
if ($n) {
for ($i=0; $i<=$n/self::RECORDS_PER_VOLUME; ++$i) {
$data.='<sitemap><loc>'.WT_SERVER_NAME.WT_SCRIPT_PATH.'module.php?mod='.$this->getName().'&mod_action=generate&file=sitemap-'.$tree->tree_id.'-r-'.$i.'.xml</loc>'.$lastmod.'</sitemap>'.PHP_EOL;
}
}
$n=WT_DB::prepare("SELECT COUNT(*) FROM `##other` WHERE o_file=? AND o_type='NOTE'")->execute(array($tree->tree_id))->fetchOne();
if ($n) {
for ($i=0; $i<=$n/self::RECORDS_PER_VOLUME; ++$i) {
$data.='<sitemap><loc>'.WT_SERVER_NAME.WT_SCRIPT_PATH.'module.php?mod='.$this->getName().'&mod_action=generate&file=sitemap-'.$tree->tree_id.'-n-'.$i.'.xml</loc>'.$lastmod.'</sitemap>'.PHP_EOL;
}
}
$n=WT_DB::prepare("SELECT COUNT(*) FROM `##media` WHERE m_file=?")->execute(array($tree->tree_id))->fetchOne();
if ($n) {
for ($i=0; $i<=$n/self::RECORDS_PER_VOLUME; ++$i) {
$data.='<sitemap><loc>'.WT_SERVER_NAME.WT_SCRIPT_PATH.'module.php?mod='.$this->getName().'&mod_action=generate&file=sitemap-'.$tree->tree_id.'-m-'.$i.'.xml</loc>'.$lastmod.'</sitemap>'.PHP_EOL;
}
}
}
}
$data = '<'.'?xml version="1.0" encoding="UTF-8" ?'.'>' . PHP_EOL . '<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">' . PHP_EOL . $data . '</sitemapindex>' . PHP_EOL;
// Cache this data.
$this->setSetting('sitemap.xml', $data);
$this->setSetting('sitemap.timestamp', WT_TIMESTAMP);
}
header('Content-Type: application/xml');
header('Content-Length: ' . strlen($data));
echo $data;
}
// A separate file for each family tree and each record type.
// These files depend on access levels, so only cache for visitors.
private function generate_file($ged_id, $rec_type, $volume) {
// Check the cache
$timestamp = $this->getSetting('sitemap-' . $ged_id . '-' . $rec_type . '-' . $volume . '.timestamp');
if ($timestamp > WT_TIMESTAMP - self::CACHE_LIFE && !WT_USER_ID) {
$data = $this->getSetting('sitemap-' . $ged_id . '-' . $rec_type . '-' . $volume . '.xml');
} else {
$tree=WT_Tree::get($ged_id);
$data='<url><loc>'.WT_SERVER_NAME.WT_SCRIPT_PATH.'index.php?ctype=gedcom&ged='.$tree->tree_name_url.'</loc></url>'.PHP_EOL;
$records=array();
switch ($rec_type) {
case 'i':
$rows=WT_DB::prepare(
"SELECT i_id AS xref, i_file AS gedcom_id, i_gedcom AS gedcom".
" FROM `##individuals`".
" WHERE i_file=?".
" ORDER BY i_id".
" LIMIT ".self::RECORDS_PER_VOLUME." OFFSET ".($volume*self::RECORDS_PER_VOLUME)
)->execute(array($ged_id))->fetchAll();
foreach ($rows as $row) {
$records[]=WT_Individual::getInstance($row->xref, $row->gedcom_id, $row->gedcom);
}
break;
case 's':
$rows=WT_DB::prepare(
"SELECT s_id AS xref, s_file AS gedcom_id, s_gedcom AS gedcom".
" FROM `##sources`".
" WHERE s_file=?".
" ORDER BY s_id".
" LIMIT ".self::RECORDS_PER_VOLUME." OFFSET ".($volume*self::RECORDS_PER_VOLUME)
)->execute(array($ged_id))->fetchAll();
foreach ($rows as $row) {
$records[]=WT_Source::getInstance($row->xref, $row->gedcom_id, $row->gedcom);
}
break;
case 'r':
$rows=WT_DB::prepare(
"SELECT o_id AS xref, o_file AS gedcom_id, o_gedcom AS gedcom".
" FROM `##other`".
" WHERE o_file=? AND o_type='REPO'".
" ORDER BY o_id".
" LIMIT ".self::RECORDS_PER_VOLUME." OFFSET ".($volume*self::RECORDS_PER_VOLUME)
)->execute(array($ged_id))->fetchAll();
foreach ($rows as $row) {
$records[]=WT_Repository::getInstance($row->xref, $row->gedcom_id, $row->gedcom);
}
break;
case 'n':
$rows=WT_DB::prepare(
"SELECT o_id AS xref, o_file AS gedcom_id, o_gedcom AS gedcom".
" FROM `##other`".
" WHERE o_file=? AND o_type='NOTE'".
" ORDER BY o_id".
" LIMIT ".self::RECORDS_PER_VOLUME." OFFSET ".($volume*self::RECORDS_PER_VOLUME)
)->execute(array($ged_id))->fetchAll();
foreach ($rows as $row) {
$records[]=WT_Note::getInstance($row->xref, $row->gedcom_id, $row->gedcom);
}
break;
case 'm':
$rows=WT_DB::prepare(
"SELECT m_id AS xref, m_file AS gedcom_id, m_gedcom AS gedcom".
" FROM `##media`".
" WHERE m_file=?".
" ORDER BY m_id".
" LIMIT ".self::RECORDS_PER_VOLUME." OFFSET ".($volume*self::RECORDS_PER_VOLUME)
)->execute(array($ged_id))->fetchAll();
foreach ($rows as $row) {
$records[]=WT_Media::getInstance($row->xref, $row->gedcom_id, $row->gedcom);
}
break;
}
foreach ($records as $record) {
if ($record->canShowName()) {
$data.='<url>';
$data.='<loc>'.WT_SERVER_NAME.WT_SCRIPT_PATH.$record->getHtmlUrl().'</loc>';
$chan=$record->getFirstFact('CHAN');
if ($chan) {
$date=$chan->getDate();
if ($date->isOK()) {
$data.='<lastmod>'.$date->minDate()->Format('%Y-%m-%d').'</lastmod>';
}
}
$data.='</url>'.PHP_EOL;
}
}
$data='<'.'?xml version="1.0" encoding="UTF-8" ?'.'>'.PHP_EOL.'<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">'.PHP_EOL.$data.'</urlset>'.PHP_EOL;
// Cache this data - but only for visitors, as we don’t want
// visitors to see data created by logged-in users.
if (!WT_USER_ID) {
$this->setSetting('sitemap-' . $ged_id . '-' . $rec_type . '-' . $volume . '.xml', $data);
$this->setSetting('sitemap-' . $ged_id . '-' . $rec_type . '-' . $volume . '.timestamp', WT_TIMESTAMP);
}
}
header('Content-Type: application/xml');
header('Content-Length: '.strlen($data));
echo $data;
}
private function admin() {
$controller=new WT_Controller_Page();
$controller
->restrictAccess(Auth::isAdmin())
->setPageTitle($this->getTitle())
->pageHeader();
// Save the updated preferences
if (WT_Filter::post('action')=='save') {
foreach (WT_Tree::getAll() as $tree) {
$tree->setPreference('include_in_sitemap', WT_Filter::postBool('include'.$tree->tree_id));
}
// Clear cache and force files to be regenerated
WT_DB::prepare(
"DELETE FROM `##module_setting` WHERE setting_name LIKE 'sitemap%'"
)->execute();
}
$include_any=false;
echo
'<h3>', $this->getTitle(), '</h3>',
'<p>',
/* I18N: The www.sitemaps.org site is translated into many languages (e.g. http://www.sitemaps.org/fr/) - choose an appropriate URL. */
WT_I18N::translate('Sitemaps are a way for webmasters to tell search engines about the pages on a website that are available for crawling. All major search engines support sitemaps. For more information, see <a href="http://www.sitemaps.org/">www.sitemaps.org</a>.').
'</p>',
'<p>', WT_I18N::translate('Which family trees should be included in the sitemaps?'), '</p>',
'<form method="post" action="module.php?mod=' . $this->getName() . '&mod_action=admin">',
'<input type="hidden" name="action" value="save">';
foreach (WT_Tree::getAll() as $tree) {
echo '<p><input type="checkbox" name="include', $tree->tree_id, '"';
if ($tree->getPreference('include_in_sitemap')) {
echo ' checked="checked"';
$include_any=true;
}
echo '>', $tree->tree_title_html, '</p>';
}
echo
'<input type="submit" value="', WT_I18N::translate('save'), '">',
'</form>',
'<hr>';
if ($include_any) {
$site_map_url1=WT_SERVER_NAME.WT_SCRIPT_PATH.'module.php?mod='.$this->getName().'&mod_action=generate&file=sitemap.xml';
$site_map_url2=rawurlencode(WT_SERVER_NAME.WT_SCRIPT_PATH.'module.php?mod='.$this->getName().'&mod_action=generate&file=sitemap.xml');
echo '<p>', WT_I18N::translate('To tell search engines that sitemaps are available, you should add the following line to your robots.txt file.'), '</p>';
echo
'<pre>Sitemap: ', $site_map_url1, '</pre>',
'<hr>',
'<p>', WT_I18N::translate('To tell search engines that sitemaps are available, you can use the following links.'), '</p>',
'<ul>',
// This list comes from http://en.wikipedia.org/wiki/Sitemaps
'<li><a target="_blank" href="http://www.bing.com/webmaster/ping.aspx?siteMap='.$site_map_url2.'">Bing</a></li>',
'<li><a target="_blank" href="http://www.google.com/webmasters/tools/ping?sitemap='.$site_map_url2.'">Google</a></li>',
'</ul>';
}
}
// Implement WT_Module_Config
public function getConfigLink() {
return 'module.php?mod='.$this->getName().'&mod_action=admin';
}
}
|
