xml-sitemap.php

<?php
/**
 * XML Sitemap PHP Script
 * For more info, see: https://github.com/jdevalk/XML-Sitemap-PHP-Script
 * Copyright (C), 2011 - 2022 - Joost de Valk, joost@joost.blog
 */

class Joost_XML_Sitemap_PHP {
	const CONFIG_FILE = 'xml-sitemap-config.ini';

	/**
	 * Holds the output.
	 */
	private string $output = '';

	/**
	 * Holds the path.
	 */
	private string $path;

	/**
	 * Holds the base URL.
	 */
	private string $url;

	/**
	 * Array of filetypes we're adding to the XML sitemap.
	 */
	private array $filetypes;

	/**
	 * Relative path to the XSL file.
	 */
	private string $xsl = 'xml-sitemap.xsl';

	/**
	 * Files we ignore in our output.
	 */
	private array $ignore = [];

	/**
	 * The change frequency of the files.
	 */
	private string $changefreq = '';

	/**
	 * The priority of the file, between 0.1 and 1.
	 */
	private float $priority = 0;

	/**
	 * Determines if we recurse directories or not.
	 */
	private bool $recursive = true;

	/**
	 * URLs we replace with something else.
	 */
	private array $replacements;

	/**
	 * Generates our XML sitemap.
	 *
	 * @return void
	 */
	public function generate(): void {
		$this->read_ini();
		$this->read_dir();
		$this->output();
	}

	/**
	 * Read our ini file.
	 *
	 * @return void
	 */
	private function read_ini(): void {
		if ( file_exists( './' . self::CONFIG_FILE ) ) {
			$config = parse_ini_file( './' . self::CONFIG_FILE );
		} elseif ( file_exists( '../' . self::CONFIG_FILE ) ) {
			$config = parse_ini_file( '../' . self::CONFIG_FILE );
		} else {
			printf( 'Error: unable to load %1$s, please copy xml-sitemap-config-sample.ini to %1$s and adjust.' . PHP_EOL, self::CONFIG_FILE );
			die( 1 );
		}

		$this->changefreq   = (string) $config['changefreq'];
		$this->path         = (string) $config['directory'];
		$this->url          = (string) $config['directory_url'];
		$this->filetypes    = (array) $config['filetypes'];
		$this->ignore       = array_merge( $config['ignore'], [ '.', '..', 'xml-sitemap.php' ] );
		$this->priority     = (float) $config['priority'];
		$this->recursive    = (bool) $config['recursive'];
		$this->replacements = (array) $config['replacements'];
		$this->xsl          = (string) $config['xsl'];
	}

	/**
	 * Kick off the script reading the dir provided in config.
	 *
	 * @return void
	 */
	private function read_dir(): void {
		$this->parse_dir( $this->path, $this->url );
	}

	/**
	 * Reads a directory and adds files found to the output.
	 *
	 * @param string $dir The directory to read.
	 * @param string $url The base URL.
	 *
	 * @return void
	 */
	private function parse_dir( string $dir, string $url ): void {
		$handle = opendir( $dir );

		while ( false !== ( $file = readdir( $handle ) ) ) {
			// Check if this file needs to be ignored, if so, skip it.
			if ( in_array( utf8_encode( $file ), $this->ignore ) ) {
				continue;
			}

			if ( $this->recursive && is_dir( $dir . $file ) ) {
				$this->parse_dir( $dir . $file . '/', $url . $file . '/' );
			}

			// Check whether the file has on of the extensions allowed for this XML sitemap.
			$extension = pathinfo( $dir . $file, PATHINFO_EXTENSION );
			if ( empty( $extension ) || ! in_array( $extension, $this->filetypes ) ) {
				continue;
			}

			// Create a W3C valid date for use in the XML sitemap based on the file modification time.
			$file_mod_time = filemtime( $dir . $file );
			if ( ! $file_mod_time ) {
				$file_mod_time = filectime( $dir . $file );
			}

			$mod = date( 'c', $file_mod_time );

			// Replace the file with its replacement from the settings, if needed.
			if ( isset( $this->replacements[ $file ] ) ) {
				$file = $this->replacements[ $file ];
			}

			// Start creating the output
			$output = '<url>' . PHP_EOL;
			$output .= "\t" . '<loc>' . $url . rawurlencode( $file ) . '</loc>' . PHP_EOL;
			$output .= "\t" . '<lastmod>' . $mod . '</lastmod>' . PHP_EOL;
			if ( ! empty( $this->changefreq ) ) {
				$output .= "\t" . '<changefreq>' . $this->changefreq . '</changefreq>' . PHP_EOL;
			}
			if ( $this->priority > 0 && $this->priority <= 1 ) {
				$output .= "\t" . '<priority>' . $this->priority . '</priority>' . PHP_EOL;
			}
			$output .= '</url>' . PHP_EOL;

			$this->output .= $output;

		}
		closedir( $handle );
	}

	/**
	 * Output our XML sitemap.
	 *
	 * @return void
	 */
	private function output(): void {
		// Sent the correct header so browsers display properly, with or without XSL.
		header( 'Content-Type: application/xml' );

		echo '<?xml version="1.0" encoding="utf-8"?>' . PHP_EOL;
		if ( ! empty( $this->xsl ) ) {
			echo '<?xml-stylesheet type="text/xsl" href="' . $this->url . $this->xsl . '"?>' . PHP_EOL;
		}
		echo '<urlset xmlns="https://www.sitemaps.org/schemas/sitemap/0.9">' . PHP_EOL;
		echo $this->output;
		echo '</urlset>' . PHP_EOL;
	}
}

$joost_xml = new Joost_XML_Sitemap_PHP();
$joost_xml->generate();