nasa / sitepod

A Sitemap Generator written in PHP

Sitepod

Sitepod; A Sitemap Generator written in PHP. Sitepod uses the Fat-Free Framework, a powerful yet easy-to-use PHP micro-framework designed to build dynamic and robust web applications.

Installation from the Composer PHP Package Manager

Sitemap can be installed using the Composer dependency manager for PHP as follows

$ composer require nasa/sitepod

This will install Sitepod into a directory structure vendor/nasa/sitepod/ relative to wherever the command was executed.

Alternatively, you can install the master branch from source

Installation from Source

See Sitepod Installation

Configuration and Usage

See Sitepod Setup and Usage

Community, Support and Development

Please open a ticket in the Sitepod issue tracker. Please use labels to classify your issue.

License

This code has been forked from the now unmaintained phpSitemapNG The code is licensed permissively under the GPLv3 License which respects the origin authors work e.g. Tobias Kluge, enarion.net. A copy of the GPLv3 License can be found below and is also included as part of this software.

This file is part of Sitepod.

Sitepod 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 3 of the License, or
(at your option) any later version.

Sitepod 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 Sitepod.  If not, see <http://www.gnu.org/licenses/>.

sitepod's Issues

Add sonarqube analysis

https://about.sonarcloud.io/get-started/

Fix timezone warning upon successful Sitemap creation and save

The screenshot below displays the Warning

Sitemap successfuly created and saved links are broken on localhost

When I am testing Sitepod locally, upon successful Sitemap creation I get the following screen

The links at the bottom which follow the green success messaged however are broken, they resolve to http://localhost/sitemap.xml and http://localhost/~lmcgibbn/admin/sitepod/sitepod/index.php respectively!

add CLI to allow easier automation

Here's the pertinent part of the ESDSWG Search Relevancy email thread between @eniad and @lewismc:

2. Can the sitemap generation be automated with sitepod? We'd prefer a command line interface for cronjobs, but need some way to programmatically run the generator. We would do this either periodically or when new content (like a new data set) is added.

This is not yet implemented and I would need to work on it a wee bit. I think it should be a priority so I will try to write some documentation and begin work on this shortly. I agree with you here, this needs to be automated and without a CLI is a near impossible.

Call to undefined function split()

I'm using php 7.2x
After starting sitepod I got the following error-message:
AH01071: Got error 'PHP message: PHP Fatal error: Uncaught Error: Call to undefined function split() in /var/www/vhosts/domainname.tld/httpdocs/vendor/nasa/sitepod/inc/classes/Crawler.class.php:340

This is because split() is in php 7.x removed!
Therefore split() must be replaced with str_split().
Because I'm not firm with GIT I can't do that.

Add Help Wanted issues to Code.gov

It looks like you have quite a few Help Wanted issues in your repo. You can feature these on Code.gov and reach a larger audience by adding specific tags to your Help Wanted issues.

Here are the specifics - https://github.com/GSA/code-gov/blob/master/HelpWanted.md
And, an example - https://github.com/GSA/code-gov-web/issues/417

Let me know if you have questions,
Cheers!
Joe

timeformat error when using Short Format

Short format timeformat (date only) causes error in Google sitemap test. See errors below:

Type | Issue | Description | Issues count | Example | Line | Detected
Errors | Invalid date | An invalid date was found. Please fix the date or formatting before resubmitting. | 8
Parent tag: urlTag: lastmodValue: 2017-06-20-04:00 | 7 | Aug 18, 2017
Parent tag: urlTag: lastmodValue: 2017-06-20-04:00 | 13 | Aug 18, 2017
Parent tag: urlTag: lastmodValue: 2017-06-20-04:00 | 19 | Aug 18, 2017

This is easily avoided using the Long format (with time) timeformat.

Fix encoding warning upon index.php form submit

Whenever we submit a new Sitemap generation task, we get a warning which we should fix.

A form was submitted in the windows-1252 encoding which cannot encode all Unicode characters, so user input may get corrupted. To avoid this problem, the page should be changed so that the form is submitted in the UTF-8 encoding either by changing the encoding of the page itself to UTF-8 or by specifying accept-charset=utf-8 on the form element.

Adapting Sitepod to Accomodate Dynamicaly-generated Content

Say, I have a 'one-page' Website/Web application or I serve my Website through a CMS such as Sharepoint where everything is dynamically generated. How will/does Sitepod currently perform? This issue should track and implement support for the above scenario.

FreeGeoIP API has been deprecated and moved to ipstack.com

However, ipstack requires auth key to call the API. One alternative is Snoopi.io, but its API rate limit is very low (2/sec).

Add travis-ci build to Sitepod

https://docs.travis-ci.com/user/languages/php/

Fix licensing headers

Right now license headers are all over the place. We should make them consistent.

Deprecate generation of .txt sitemaps in favor of sitemap.xml

Now Yahoo!... or Bing provides clear guidance that .xml sitemaps which meet the Sitemap 0.9 standard are preferred over anything else... even RSS or ATOM feeds.
https://www.bing.com/webmaster/help/how-to-submit-sitemaps-82a15bd4
We should remove the ability to generate .txt sitemaps.

Fix timezone warning upon submit success

Upon successful submission and completion of Sitemap generation, I see the following list of error presented to me

We should address the warnings.

Get Sitepod on to Packagist

Packagist is the main Composer repository. It aggregates public PHP packages installable with Composer.
We should get Sitepod on there.

Add Badge Poser badges

https://poser.pugx.org/

Authentication/Proxy Configuration for Sitepod

Say I want to use Sitepod to build Sitemaps for Websites in present in my intranet. Will sitepod be able to access those sites through network infrastructure such as VPN/Proxy, etc. If not, then we need to implement this support.

Use fatfree templates

https://fatfreeframework.com/3.6/views-and-templates

Implement a PHP Framework for Sitepod

I came across an article on PHP REST API Frameworks and thought it would be a good idea to build one into Sitepod.
I took a look at the documentation for the Fat-Free Framework and think it would be a good fit for Sitepod. This issue should track the rearchitecture of Sitepod to accommodate Fat Free.

Add functionality to ping BING

We can easily ping BING when we generate new sitemap's... this is documented at https://www.bing.com/webmaster/help/how-to-submit-sitemaps-82a15bd4 and I've copied the sentiment below for convenience. We should add similar functionality to how ping'ing works for Google.

Pinging Bing Using a HTTP request

If you have an automated system that generates your sitemap, you may find it easier to inform Bing about your sitemap by sending a HTTP request. Using your favorite method to send the request, use the following URL, replacing the example with your sitemap location and URL encoding everything behind the sitemap parameter:

http://www.bing.com/ping?sitemap=http%3A%2F%2Fwww.example.com/sitemap.xml

The server will respond with HTTP Status 200 (OK) if the submission was successful. Unlike the submission options inside Webmaster Tools you will not get any information about the validity about the actual sitemap itself.

noteNote
If you’d like more programmatic flexibility consider using the Bing Webmaster API and its methods to submit and get details about sitemaps. 

Upgrade Google Sitemap XSD

Currently, GsfXml.class.php references the Google Sitemap schema 0.84.
0.84 is now deprecated, so we should upgrade to 0.9.