add constant KOKO_ANALYTICS_CUSTOM_ENDPOINT to allow using a custom e…

…ndpoint file location. relates to #70, closes #147

code-snippets/disable-custom-endpoint.php

@@ -0,0 +1,3 @@
+<?php
+
+define( 'KOKO_ANALYTICS_CUSTOM_ENDPOINT', false );

code-snippets/use-different-custom-endpoint.php

@@ -0,0 +1,15 @@
+<?php
+
+# Creating the custom endpoint file
+// To use a different custom endpoint file location, first create a file at your preferred location and copy over the contents from the file linked below
+// file: https://github.com/ibericode/koko-analytics/blob/master/koko-analytics-collect.php
+
+# Fix path references
+// In the file, fix the relative file paths to the uploads directory and the functions.php file from the wp-content/plugins/koko-analytics directory.
+
+# Define a constant
+// To tell Koko Analytics of your custom endpoint, define the following constant:
+define( 'KOKO_ANALYTICS_CUSTOM_ENDPOINT', '/path-to-your-custom-endpoint-file.php' );
+
+# Test the result
+// Finally, ensure the file is accessible through your web server and that Koko Analytics is able to use it correctly.

koko-analytics.php

@@ -76,7 +76,6 @@
 $plugin = new Plugin( $aggregator );
 $plugin->init();
 
-
 if ( class_exists( 'WP_CLI' ) ) {
 	require __DIR__ . '/src/class-command.php';
 	\WP_CLI::add_command( 'koko-analytics', 'KokoAnalytics\Command' );

src/class-admin.php

@@ -134,8 +134,12 @@ public function maybe_run_endpoint_installer()
 			return;
 		}
 
-		$endpoint_installer = new Endpoint_Installer();
-		$endpoint_installer->run();
+		// do not run if KOKO_ANALYTICS_CUSTOM_ENDPOINT is defined
+		if ( defined( 'KOKO_ANALYTICS_CUSTOM_ENDPOINT' ) ) {
+			return;
+		}
+
+		install_and_test_custom_endpoint();
 	}
 
 	public function maybe_run_migrations()

src/class-script-loader.php

@@ -65,6 +65,10 @@ private function get_post_id() {
 	}
 
 	private function get_tracker_url() {
+		if ( defined( 'KOKO_ANALYTICS_CUSTOM_ENDPOINT' ) && KOKO_ANALYTICS_CUSTOM_ENDPOINT ) {
+			return site_url( KOKO_ANALYTICS_CUSTOM_ENDPOINT );
+		}
+
 		// We should use site_url() here because we place the file in ABSPATH and other plugins may be filtering home_url (eg multilingual plugin)
 		// In any case: what we use here should match what we test when creating the optimized endpoint file.
 		return using_custom_endpoint() ? site_url( '/koko-analytics-collect.php' ) : admin_url( 'admin-ajax.php?action=koko_analytics_collect' );

src/functions.php

@@ -173,5 +173,14 @@ function get_realtime_pageview_count( $since = null ) {
 }
 
 function using_custom_endpoint() {
+	if ( defined( 'KOKO_ANALYTICS_CUSTOM_ENDPOINT' ) ) {
+		return KOKO_ANALYTICS_CUSTOM_ENDPOINT;
+	}
+
 	return get_option( 'koko_analytics_use_custom_endpoint', false );
 }
+
+function install_and_test_custom_endpoint() {
+	$endpoint_installer = new Endpoint_Installer();
+	$endpoint_installer->run();
+}