fix site specific upload dir regex when determining global upload dir in a multisite install (#1341)

* fix site specific upload dir regex when determining global upload dir in a multisite install

* make sure to add ending slash after getting parent directory

* ignore possible warning from openbasedir

* test tweak

Author: diosmosis

classes/WpMatomo/Paths.php

@@ -146,8 +146,9 @@ public function get_gloal_upload_dir_if_possible( $file_to_look_for = '' ) {
 			return $path_upload_dir;
 		}
 
-		if ( preg_match( '/sites\/(\d)+$/', $path_upload_dir ) ) {
-			$path_upload_dir = preg_replace( '/sites\/(\d)+$/', '', $path_upload_dir );
+		$global_path_upload_dir = $this->get_global_path_upload_dir_if_matches_site_specific_dir( $path_upload_dir );
+		if ( ! empty( $global_path_upload_dir ) ) {
+			$path_upload_dir = $global_path_upload_dir;
 		} else {
 			// re-implement _wp_upload_dir to find hopefully the upload_dir for the network site
 			$upload_path = trim( get_option( 'upload_path' ) );
@@ -173,7 +174,10 @@ public function get_gloal_upload_dir_if_possible( $file_to_look_for = '' ) {
 			$parent_dir = $path_upload_dir;
 			do {
 				$parent_dir = dirname( $parent_dir );
-				if ( file_exists( $parent_dir . $file_to_look_for ) ) {
+				$parent_dir = rtrim( $parent_dir, '/' ) . '/';
+				// NOTE: file_exists here can trigger an open_basedir warning on some setups
+				// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+				if ( @file_exists( $parent_dir . $file_to_look_for ) ) {
 					return $parent_dir;
 				}
 			} while ( strpos( $parent_dir, ABSPATH ) === 0 ); // we don't go outside WP dir
@@ -233,4 +237,20 @@ public function is_upload_dir_writable() {
 			&& $this->get_host_init_filesystem_succeeded()
 			&& $is_filesystem_direct_available;
 	}
+
+	/**
+	 * public for tests
+	 *
+	 * @param string $path_upload_dir
+	 * @return string|null
+	 */
+	public function get_global_path_upload_dir_if_matches_site_specific_dir( $path_upload_dir ) {
+		$multisite_path_regex = '%sites/(\d)+/' . preg_quote( MATOMO_UPLOAD_DIR, '%' ) . '$%';
+
+		if ( ! preg_match( $multisite_path_regex, $path_upload_dir ) ) {
+			return null;
+		}
+
+		return preg_replace( $multisite_path_regex, '', $path_upload_dir );
+	}
 }

scripts/local-dev-entrypoint.sh

@@ -64,7 +64,7 @@ function handle_cli_command() {
     ./console $EXECUTE_ARGS
     exit $?
   elif [[ "$EXECUTE_TARGET" = "phpunit" ]]; then
-    cd /var/www/html/matomo-for-wordpress
+    cd /var/www/html/$WORDPRESS_FOLDER/wp-content/plugins/matomo
 
     php -r "\$pdo = new PDO('mysql:host=$WP_DB_HOST', 'root', 'pass');
     \$pdo->exec('DROP DATABASE IF EXISTS \`${WP_DB_NAME}_test\`');\

tests/phpunit/wpmatomo/test-paths.php

@@ -229,10 +229,29 @@ public function test_get_gloal_upload_dir_if_possible_forBlog() {
 			$this->markTestSkipped( 'Not multisite.' );
 			return;
 		}
+
 		$blogid1 = self::factory()->blog->create();
 		switch_to_blog( 2 );
 		wp_delete_site( $blogid1 );
 		$this->assertSame( ABSPATH . 'wp-content/uploads/matomo', $this->paths->get_gloal_upload_dir_if_possible() );
 	}
 
+	public function test_get_global_path_upload_dir_if_matches_site_specific_dir() {
+		if ( ! is_multisite() ) {
+			$this->markTestSkipped( 'Not multisite.' );
+			return;
+		}
+
+		$blogid1 = self::factory()->blog->create();
+		switch_to_blog( 2 );
+
+		try {
+			$upload_path_base_dir = $this->paths->get_upload_base_dir();
+
+			$global_upload_path = $this->paths->get_global_path_upload_dir_if_matches_site_specific_dir( $upload_path_base_dir );
+			$this->assertEquals( ABSPATH . 'wp-content/uploads/', $global_upload_path );
+		} finally {
+			wp_delete_site( $blogid1 );
+		}
+	}
 }