Version 4.7.0

2025-12-19 16:00:35 -08:00
1 parent 517a5e1f70
commit 8ba7d43898
@@ -0,0 +1,141 @@
+<?php
+/**
+ * @brief		IndexNow Submission Class
+ * @author		<a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
+ * @copyright	(c) Invision Power Services, Inc.
+ * @license		https://www.invisioncommunity.com/legal/standards/
+ * @package		Invision Community
+ * @since		11 Jan 2022
+ */
+
+namespace IPS\core;
+
+/* To prevent PHP errors (extending class does not exist) revealing path */
+if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
+{
+	header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
+	exit;
+}
+
+/**
+ * IndexNow class
+ *
+ * Submits the content to indexnow - https://www.indexnow.org/documentation
+ *
+ * The submission should always happen via the queue system!
+ */
+class _IndexNow extends \IPS\Patterns\Singleton
+{
+	/**
+	 * @brief	Singleton Instances
+	 */
+	protected static $instance = NULL;
+
+	/**
+	 * @brief Target URL for the API Request
+	 *
+	 * @var string
+	 */
+	static $apiUrl = "https://api.indexnow.org/indexnow/";
+
+	/**
+	 * Is the extension enabled?
+	 *
+	 * @return bool
+	 */
+	public function isEnabled(): bool
+	{
+		return (bool) \IPS\Settings::i()->indexnow_enabled;
+	}
+
+	/**
+	 * Queues a URL to be sent to indexnow
+	 *
+	 * @param $url
+	 * @return void
+	 */
+	public static function addUrlToQueue( $url )
+	{
+		static::addUrlsToQueue([ $url ] );
+	}
+
+	/**
+	 * Queues an array with URLs to be sent to indexnow
+	 *
+	 * @param array $urls
+	 * @return void
+	 */
+	public static function addUrlsToQueue( array $urls )
+	{
+		$obj = static::i();
+		if( $obj->isEnabled() )
+		{
+			\IPS\Task::queue( 'core', 'IndexNow', [ 'urls' => array_map('strval', $urls) ] );
+		}
+	}
+
+	/**
+	 * Sends all the urls in the queue to indexnow
+	 *
+	 * @return void
+	 */
+	public function send( array $urls )
+	{
+		/* Move on if there's nothing to send */
+		if( !\count( $urls ) )
+		{
+			return;
+		}
+
+		$url = \IPS\Http\Url::internal('');
+		$data = array(
+			'host'         => \IPS\Http\Url::baseUrl(\IPS\Http\Url::PROTOCOL_WITHOUT ),
+			'key'          => \IPS\Settings::i()->indexnow_key,
+			'keyLocation'  => (string) $url->setPath( $url->data[ \IPS\Http\Url::COMPONENT_PATH ] .  $this->getKeyFileName() ),
+			'urlList'     => $urls,
+		);
+
+		$response = \IPS\Http\Url::external( static::$apiUrl )->request()
+			->setHeaders( array(	'Content-Type'  => 'application/json' ) )->post( json_encode( $data ) );
+
+		if( !$response->isSuccessful() )
+		{
+			switch ( $response->httpResponseCode )
+			{
+				case 400:
+					$error = 'invalid_request';
+					break;
+				case 403:
+					$error = 'invalid_api_key';
+					breaK;
+				case 422:
+					$error = 'invalid_url';
+					break;
+				case 429:
+				default:
+					$error = 'unknown_error';
+			}
+			\IPS\Log::log( $response->httpResponseCode . ' ' . $error . ' ' . print_r($data, TRUE ), 'IndexNow');
+		}
+	}
+
+	/**
+	 * Return the indexnow verification file name
+	 *
+	 * @return string
+	 */
+	public function getKeyFileName(): string
+	{
+		return \IPS\Settings::i()->indexnow_key . '.txt';
+	}
+
+	/**
+	 * Return the indexnow verification file content, which is literally only the key!
+	 *
+	 * @return string
+	 */
+	public function getKeyfileContent(): string
+	{
+		return \IPS\Settings::i()->indexnow_key;
+	}
+}