Merge "FancyCaptcha: Allow configuration of the actual directory captchas are stored in"

FancyCaptcha/extension.json

@@ -60,6 +60,10 @@
 		},
 		"CaptchaDeleteOnSolve": {
 			"value": false
+		},
+		"CaptchaStorageDirectory": {
+			"description": "The directory that captchas will be stored in on the CaptchaFileBackend. You probably don't need to change this!",
+			"value": "captcha-render"
 		}
 	},
 	"manifest_version": 2

FancyCaptcha/includes/FancyCaptcha.php

@@ -37,21 +37,22 @@ class FancyCaptcha extends SimpleCaptcha {
 		if ( $wgCaptchaFileBackend ) {
 			return MediaWikiServices::getInstance()->getFileBackendGroup()
 				->get( $wgCaptchaFileBackend );
-		} else {
-			static $backend = null;
-			if ( !$backend ) {
-				$backend = new FSFileBackend( [
-					'name'           => 'captcha-backend',
-					'wikiId'         => WikiMap::getCurrentWikiId(),
-					'lockManager'    => new NullLockManager( [] ),
-					'containerPaths' => [ 'captcha-render' => $wgCaptchaDirectory ],
-					'fileMode'       => 777,
-					'obResetFunc'    => 'wfResetOutputBuffers',
-					'streamMimeFunc' => [ 'StreamFile', 'contentTypeFromPath' ]
-				] );
-			}
-			return $backend;
 		}
+
+		static $backend = null;
+		if ( !$backend ) {
+			$backend = new FSFileBackend( [
+				'name'           => 'captcha-backend',
+				'wikiId'         => WikiMap::getCurrentWikiId(),
+				'lockManager'    => new NullLockManager( [] ),
+				'containerPaths' => [ $this->getStorageDir() => $wgCaptchaDirectory ],
+				'fileMode'       => 777,
+				'obResetFunc'    => 'wfResetOutputBuffers',
+				'streamMimeFunc' => [ 'StreamFile', 'contentTypeFromPath' ]
+			] );
+		}
+
+		return $backend;
 	}
 
 	/**
@@ -60,12 +61,20 @@ class FancyCaptcha extends SimpleCaptcha {
 	public function getCaptchaCount() {
 		$backend = $this->getBackend();
 		$files = $backend->getFileList(
-			[ 'dir' => $backend->getRootStoragePath() . '/captcha-render' ]
+			[ 'dir' => $backend->getRootStoragePath() . '/' . $this->getStorageDir() ]
 		);
 
 		return iterator_count( $files );
 	}
 
+	/**
+	 * @return string
+	 */
+	public function getStorageDir() {
+		global $wgCaptchaStorageDirectory;
+		return $wgCaptchaStorageDirectory;
+	}
+
 	/**
 	 * Check if the submitted form matches the captcha session data provided
 	 * by the plugin when the form was generated.
@@ -203,7 +212,7 @@ class FancyCaptcha extends SimpleCaptcha {
 
 		// number of times another process claimed a file before this one
 		$lockouts = 0;
-		$baseDir = $this->getBackend()->getRootStoragePath() . '/captcha-render';
+		$baseDir = $this->getBackend()->getRootStoragePath() . '/' . $this->getStorageDir();
 		return $this->pickImageDir( $baseDir, $wgCaptchaDirectoryLevels, $lockouts );
 	}
 
@@ -417,7 +426,7 @@ class FancyCaptcha extends SimpleCaptcha {
 	public function imagePath( $salt, $hash ) {
 		global $wgCaptchaDirectoryLevels;
 
-		$file = $this->getBackend()->getRootStoragePath() . '/captcha-render/';
+		$file = $this->getBackend()->getRootStoragePath() . '/' . $this->getStorageDir();
 		for ( $i = 0; $i < $wgCaptchaDirectoryLevels; $i++ ) {
 			$file .= $hash[ $i ] . '/';
 		}

includes/Store/CaptchaCacheStore.php

@@ -11,9 +11,7 @@ class CaptchaCacheStore extends CaptchaStore {
 
 	public function __construct() {
 		parent::__construct();
-
-		$services = MediaWikiServices::getInstance();
-		$this->store = $services->getMicroStash();
+		$this->store = MediaWikiServices::getInstance()->getMicroStash();
 	}
 
 	/**
@@ -22,14 +20,13 @@ class CaptchaCacheStore extends CaptchaStore {
 	public function store( $index, $info ) {
 		global $wgCaptchaSessionExpiration;
 
-		$store = $this->store;
-		$store->set(
-			$store->makeKey( 'captcha', $index ),
+		$this->store->set(
+			$this->store->makeKey( 'captcha', $index ),
 			$info,
 			$wgCaptchaSessionExpiration,
 			// Assume the write will reach the master DC before the user sends the
 			// HTTP POST request attempted to solve the captcha and perform an action
-			$store::WRITE_BACKGROUND
+			$this->store::WRITE_BACKGROUND
 		);
 	}
 
@@ -37,17 +34,14 @@ class CaptchaCacheStore extends CaptchaStore {
 	 * @inheritDoc
 	 */
 	public function retrieve( $index ) {
-		$store = $this->store;
-
-		return $store->get( $store->makeKey( 'captcha', $index ) );
+		return $this->store->get( $this->store->makeKey( 'captcha', $index ) );
 	}
 
 	/**
 	 * @inheritDoc
 	 */
 	public function clear( $index ) {
-		$store = $this->store;
-		$store->delete( $store->makeKey( 'captcha', $index ) );
+		$this->store->delete( $this->store->makeKey( 'captcha', $index ) );
 	}
 
 	public function cookiesNeeded() {

maintenance/CountFancyCaptchas.php

@@ -39,7 +39,13 @@ use MediaWiki\Extension\ConfirmEdit\Hooks;
 class CountFancyCaptchas extends Maintenance {
 	public function __construct() {
 		parent::__construct();
-		$this->addDescription( "Counts the number of fancy aptchas in storage" );
+		$this->addDescription( "Counts the number of fancy captchas in storage" );
+		$this->addOption(
+			'captchastoragedir',
+			'Overrides the value of $wgCaptchaStorageDirectory',
+			false,
+			true
+		);
 		$this->requireExtension( "FancyCaptcha" );
 	}
 
@@ -49,8 +55,14 @@ class CountFancyCaptchas extends Maintenance {
 			$this->fatalError( "\$wgCaptchaClass is not FancyCaptcha.\n", 1 );
 		}
 
+		// Overrides $wgCaptchaStorageDirectory for this script run
+		if ( $this->hasOption( 'captchastoragedir' ) ) {
+			global $wgCaptchaStorageDirectory;
+			$wgCaptchaStorageDirectory = $this->getOption( 'captchastoragedir' );
+		}
+
 		$countAct = $instance->getCaptchaCount();
-		$this->output( "Current number of captchas is $countAct.\n" );
+		$this->output( "Current number of stored captchas is $countAct.\n" );
 	}
 }
 

maintenance/DeleteOldFancyCaptchas.php

@@ -47,6 +47,12 @@ class DeleteOldFancyCaptchas extends Maintenance {
 			true,
 			true
 		);
+		$this->addOption(
+			'captchastoragedir',
+			'Overrides the value of $wgCaptchaStorageDirectory',
+			false,
+			true
+		);
 		$this->requireExtension( "FancyCaptcha" );
 	}
 
@@ -56,11 +62,17 @@ class DeleteOldFancyCaptchas extends Maintenance {
 			$this->fatalError( "\$wgCaptchaClass is not FancyCaptcha.\n", 1 );
 		}
 
+		// Overrides $wgCaptchaStorageDirectory for this script run
+		if ( $this->hasOption( 'captchastoragedir' ) ) {
+			global $wgCaptchaStorageDirectory;
+			$wgCaptchaStorageDirectory = $this->getOption( 'captchastoragedir' );
+		}
+
 		$countAct = $instance->getCaptchaCount();
 		$this->output( "Current number of captchas is $countAct.\n" );
 
 		$backend = $instance->getBackend();
-		$dir = $backend->getRootStoragePath() . '/captcha-render';
+		$dir = $backend->getRootStoragePath() . '/' . $instance->getStorageDir();
 
 		$filesToDelete = [];
 		$deleteDate = $this->getOption( 'date' );

maintenance/GenerateFancyCaptchas.php

@@ -61,6 +61,12 @@ class GenerateFancyCaptchas extends Maintenance {
 		$this->addOption( "delete", "Deletes all the old captchas" );
 		$this->addOption( "threads", "The number of threads to use to generate the images",
 			false, true );
+		$this->addOption(
+			'captchastoragedir',
+			'Overrides the value of $wgCaptchaStorageDirectory',
+			false,
+			true
+		);
 		$this->addDescription( "Generate new fancy captchas and move them into storage" );
 
 		$this->requireExtension( "FancyCaptcha" );
@@ -75,6 +81,13 @@ class GenerateFancyCaptchas extends Maintenance {
 		if ( !( $instance instanceof FancyCaptcha ) ) {
 			$this->fatalError( "\$wgCaptchaClass is not FancyCaptcha.\n", 1 );
 		}
+
+		// Overrides $wgCaptchaStorageDirectory for this script run
+		if ( $this->hasOption( 'captchastoragedir' ) ) {
+			global $wgCaptchaStorageDirectory;
+			$wgCaptchaStorageDirectory = $this->getOption( 'captchastoragedir' );
+		}
+
 		$backend = $instance->getBackend();
 
 		$deleteOldCaptchas = $this->getOption( 'delete' );
@@ -87,7 +100,7 @@ class GenerateFancyCaptchas extends Maintenance {
 		}
 
 		if ( $countGen <= 0 ) {
-			$this->output( "No need to generate anymore captchas.\n" );
+			$this->output( "No need to generate any extra captchas.\n" );
 			return;
 		}
 
@@ -150,7 +163,7 @@ class GenerateFancyCaptchas extends Maintenance {
 		$filesToDelete = [];
 		if ( $deleteOldCaptchas ) {
 			$this->output( "Getting a list of old captchas to delete..." );
-			$path = $backend->getRootStoragePath() . '/captcha-render';
+			$path = $backend->getRootStoragePath() . '/' . $instance->getStorageDir();
 			foreach ( $backend->getFileList( [ 'dir' => $path ] ) as $file ) {
 				$filesToDelete[] = [
 					'op' => 'delete',