Elmar Hanlhofer - Grinch Selfie
zoom

English / Deutsch | Print version
Twitter
twitter

PHP XML Sitemap Generator


This is a simple and small PHP script that I wrote quickly for myself to create a XML sitemap of my page for Google and other search engines. Maybe others can use the script too.

Sitemap format: http://www.sitemaps.org/protocol.html


Plans for 2.2: Sitemap index file for websites with more than 50000 pages or XML files larger than 10 MB. Maybe gzip compression for the sitemap file.


How to start the script


The script can be started as CLI script or as Website. CLI is the prefered way to start this script.

CLI scripts are started from the command line, can be used with CRON and so on. You start it with the php program.

CLI command to create the XML file: php sitemap-2.1.php

To start the program with your Webserver as Website change in the script the line 57 from
   define ("CLI", true);
to
   define ("CLI", false);


sitemap.xml


Add the XML file to your /robots.txt.

Example line for the robots.txt:

Sitemap: https://www.plop.at/sitemap.xml


Download 2.1


Download sitemap-2.1.php - Version 2.1 2016/10/07

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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
<?php

/*************************************************************

 Simple site crawler to create a search engine XML Sitemap.
 Version: 2.1
 License: GPL v2
 Free to use, without any warranty.
 Written by Elmar Hanlhofer https://www.plop.at

 ChangeLog:
 ----------
 Version 2.1 2016/10/07 by Elmar Hanlhofer
 
     * strpos fix (swap arguments) for first anchor - by William
     * First anchor check optimized - by Elmar Hanlhofer

 Version 2.0 2016/08/11 by Elmar Hanlhofer
 
     * Most program parts rewritten
     * Using quotes on define command
     * Supporting single and double quotes in href
     * Notices disabled

 Version 1.0 2015/10/14 by Elmar Hanlhofer
 
     * CLI / Website mode added
     * Multiple extension support added
     * Support for quoted URLs with spaces added
     * Skip mailto links
     * Converting special chars in the URLs for the XML file
     * Added user agent
     * Minor code updates

 Version 0.2 2013/01/16  

     * curl support - by Emanuel Ulses
     * write url, then scan url - by Elmar Hanlhofer

 Version 0.1 2012/02/01 by Elmar Hanlhofer

     * Initital release

*************************************************************/

    // Set the output file name.
    
define ("OUTPUT_FILE""sitemap.xml");
    

    
// Set the start URL. Here is https used, use http:// for non SSL websites.
    
define ("SITE""https://www.plop.at");


    
// Set true or false to define how the script is used.
    // true:  As CLI script.
    // false: As Website script.
    
define ("CLI"true);


    
// Define here the URLs to skip. All URLs that start with the defined URL 
    // will be skipped too.
    // Example: "https://www.plop.at/print" will also skip
    //   https://www.plop.at/print/bootmanager.html
    
$skip_url = array (
                       
"https://www.plop.at/print",
                       
"https://www.plop.at/slide",
                      );
    

    
// General information for search engines how often they should crawl the page.
    
define ("FREQUENCY""weekly");
    

    
// General information for search engines. You have to modify the code to set
    // various priority values for different pages. Currently, the default behavior
    // is that all pages have the same priority.
    
define ("PRIORITY""0.5");


    
// When your web server does not send the Content-Type header, then set
    // this to 'true'. But I don't suggest this.
    
define ("IGNORE_EMPTY_CONTENT_TYPE"false);


/*************************************************************
    End of user defined settings.
*************************************************************/


function GetPage ($url)
{
    
$ch curl_init ($url);
    
curl_setopt ($chCURLOPT_RETURNTRANSFER1);
    
curl_setopt ($chCURLOPT_USERAGENTAGENT);

    
$data curl_exec($ch);

    
curl_close($ch);

    return 
$data;
}

function 
GetQuotedUrl ($str)
{
    
$quote substr ($str01);
    if ((
$quote != "\"") && ($quote != "'")) // Only process a string 
    
{                                        // starting with singe or
        
return $str;                         // double quotes
    
}                                                 

    
$ret "";
    
$len strlen ($str);    
    for (
$i 1$i $len$i++) // Start with 1 to skip first quote
    
{
        
$ch substr ($str$i1);
        
        if (
$ch == $quote) break; // End quote reached

        
$ret .= $ch;
    }
    
    return 
$ret;
}

function 
GetHREFValue ($anchor)
{
    
$split1  explode ("href="$anchor);
    
$split2 explode (">"$split1[1]);
    
$href_string $split2[0];

    
$first_ch substr ($href_string01);
    if (
$first_ch == "\"" || $first_ch == "'")
    {
        
$url GetQuotedUrl ($href_string);
    }
    else
    {
        
$spaces_split explode (" "$href_string);
        
$url          $spaces_split[0];
    }
    return 
$url;
}

function 
GetEffectiveURL ($url)
{
    
// Create a curl handle
    
$ch curl_init ($url);

    
// Send HTTP request and follow redirections
    
curl_setopt($chCURLOPT_FOLLOWLOCATION1);
    
curl_setopt ($chCURLOPT_RETURNTRANSFER1);
    
curl_setopt ($chCURLOPT_USERAGENTAGENT);
    
curl_exec($ch);

    
// Get the last effective URL
    
$effective_url curl_getinfo($chCURLINFO_EFFECTIVE_URL);
    
// ie. "http://example.com/show_location.php?loc=M%C3%BCnchen"

    // Decode the URL, uncoment it an use the variable if needed
    // $effective_url_decoded = curl_unescape($ch, $effective_url);
    // "http://example.com/show_location.php?loc=M√ľnchen"

    // Close the handle
    
curl_close($ch);

    return 
$effective_url;
}

function 
ValidateURL ($url_base$url)
{
    global 
$scanned;
        
    
$parsed_url parse_url ($url);
        
    
$scheme $parsed_url["scheme"];
        
    
// Skip URL if different scheme or not relative URL (skips also mailto)
    
if (($scheme != SITE_SCHEME) && ($scheme != "")) return false;
        
    
$host $parsed_url["host"];
                
    
// Skip URL if different host
    
if (($host != SITE_HOST) && ($host != "")) return false;
    

    if (
$host == "")    // Handle URLs without host value
    
{
        if (
substr ($url01) == '#'// Handle page anchor
        
{
            echo 
"Skip page anchor: $urlNL;
            return 
false;
        }
    
        if (
substr ($url01) == '/'// Handle absolute URL
        
{
            
$url SITE_SCHEME "://" SITE_HOST $url;
        }
        else 
// Handle relative URL
        
{
        
            
$path parse_url ($url_basePHP_URL_PATH);
            
            if (
substr ($path, -1) == '/'// URL is a directory
            
{
                
// Construct full URL
                
$url SITE_SCHEME "://" SITE_HOST $path $url;
            }
            else 
// URL is a file
            
{
                
$dirname dirname ($path);

                
// Add slashes if needed
                
if ($dirname[0] != '/')
                {
                    
$dirname "/$dirname";
                }
    
                if (
substr ($dirname, -1) != '/')
                {
                    
$dirname "$dirname/";
                }

                
// Construct full URL
                
$url SITE_SCHEME "://" SITE_HOST $dirname $url;
            }
        }
    }

    
// Get effective URL, follow redirected URL
    
$url GetEffectiveURL ($url); 

    
// Don't scan when already scanned    
    
if (in_array ($url$scanned)) return false;
    
    return 
$url;
}

// Skip URLs from the $skip_url array
function SkipURL ($url)
{
    global 
$skip_url;

    if (isset (
$skip_url))
    {
        foreach (
$skip_url as $v)
        {           
            if (
substr ($url0strlen ($v)) == $v) return true// Skip this URL
        
}
    }

    return 
false;            
}

function 
Scan ($url)
{
    global 
$scanned$pf;

    
$scanned[] = $url;  // Add to URL to scanned array

    
if (SkipURL ($url))
    {
        echo 
"Skip URL $urlNL;
        return 
false;
    }
    
    
// Remove unneeded slashes
    
if (substr ($url, -2) == "//"
    {
        
$url substr ($url0, -2);
    }
    if (
substr ($url, -1) == "/"
    {
        
$url substr ($url0, -1);
    }


    echo 
"Scan $urlNL;

    
$headers get_headers ($url1);

    
// Handle pages not found
    
if (strpos ($headers[0], "404") !== false)
    {
        echo 
"Not found: $urlNL;
        return 
false;
    }

    
// Handle redirected pages
    
if (strpos ($headers[0], "301") !== false)
    {   
        
$url $headers["Location"];     // Continue with new URL
        
echo "Redirected to: $urlNL;
    }
    
// Handle other codes than 200
    
else if (strpos ($headers[0], "200") == false)
    {
        
$url $headers["Location"];
        echo 
"Skip HTTP code $headers[0]$urlNL;
        return 
false;
    }

    
// Get content type
    
if (is_array ($headers["Content-Type"]))
    {
        
$content explode (";"$headers["Content-Type"][0]);
    }
    else
    {
        
$content explode (";"$headers["Content-Type"]);
    }
    
    
$content_type trim (strtolower ($content[0]));
    
    
// Check content type for website
    
if ($content_type != "text/html"
    {
        if (
$content_type == "" && IGNORE_EMPTY_CONTENT_TYPE)
        {
            echo 
"Info: Ignoring empty Content-Type." NL;
        }
        else
        {
            if (
$content_type == "")
            {
                echo 
"Info: Content-Type is not sent by the web server. Change " .
                     
"'IGNORE_EMPTY_CONTENT_TYPE' to 'true' in the sitemap script " .
                     
"to scan those pages too." NL;
            }
            else
            {
                echo 
"Info: $url is not a website: $content[0]NL;
            }
            return 
false;
        }
    }

    
$html GetPage ($url);
    
$html trim ($html);
    if (
$html == "") return true;  // Return on empty page
    
    
$html str_replace ("\r"" "$html);        // Remove newlines
    
$html str_replace ("\n"" "$html);        // Remove newlines
    
$html str_replace ("\t"" "$html);        // Remove tabs
    
$html str_replace ("<A ""<a "$html);     // <A to lowercase

    
$first_anchor strpos ($html"<a ");    // Find first anchor

    
if ($first_anchor === false) return true// Return when no anchor found

    
$html substr ($html$first_anchor);    // Start processing from first anchor

    
$a1   explode ("<a "$html);
    foreach (
$a1 as $next_url)
    {
        
$next_url trim ($next_url);
        
        
// Skip empty array entry
        
if ($next_url == "") continue; 
        
        
// Get the attribute value from href
        
$next_url GetHREFValue ($next_url); 
        
        
// Do all skip checks and construct full URL
        
$next_url ValidateURL ($url$next_url);
        
        
// Skip if url is not valid
        
if ($next_url == false) continue;

        if (
Scan ($next_url))
        {
            
// Add URL to sitemap
            
fwrite ($pf"  <url>\n" .
                         
"    <loc>" htmlentities ($next_url) ."</loc>\n" .
                         
"    <changefreq>" FREQUENCY "</changefreq>\n" .
                         
"    <priority>" PRIORITY "</priority>\n" .
                         
"  </url>\n"); 
        }
    }

    return 
true;
}

    
// Program start
    
define ("VERSION""2.1");                                            
    
define ("AGENT""Mozilla/5.0 (compatible; Plop PHP XML Sitemap Generator/" VERSION ")");
    
define ("NL"CLI "\n" "<br>");
    
define ("SITE_SCHEME"parse_url (SITEPHP_URL_SCHEME));
    
define ("SITE_HOST"  parse_url (SITEPHP_URL_HOST));

    
error_reporting (E_ERROR E_WARNING E_PARSE);

    
$pf fopen (OUTPUT_FILE"w");
    if (!
$pf)
    {
        echo 
"Cannot create " OUTPUT_FILE "!" NL;
        return;
    }

    
fwrite ($pf"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" .
                 
"<!-- Created with Plop PHP XML Sitemap Generator " VERSION " https://www.plop.at -->\n" .
                 
"<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\"\n" .
                 
"        xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n" .
                 
"        xsi:schemaLocation=\"http://www.sitemaps.org/schemas/sitemap/0.9\n" .
                 
"        http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd\">\n" .
                 
"  <url>\n" .
                 
"    <loc>" SITE "/</loc>\n" .
                 
"    <changefreq>" FREQUENCY "</changefreq>\n" .
                 
"  </url>\n");

    
$scanned = array();
    
Scan (GetEffectiveURL (SITE));
    
    
fwrite ($pf"</urlset>\n");
    
fclose ($pf);

    echo 
"Done." NL;
    echo 
OUTPUT_FILE " created." NL;
?>


Note for version 1.0


When only the first page is scanned, then add a slash at the end of the start url at line 34.

Example: $url = "http://www.example.com/";

Thanks to David Cordovez for that info. This problem is fixed in 2.x.


Old versions


Download sitemap-2.0.php - Version 2.0 2016/08/11
Download sitemap-1.0.php - Version 1.0 2015/10/14
Download sitemap-0.2.php - Version 0.2 2013/01/16
Download sitemap-0.1.php - Version 0.1 2012/02/01


© 2016 by Elmar Hanlhofer
This page was last modified on 07/Oct/2016.