first commit

wp-content/plugins/wpml-string-translation/classes/MO/File/FailureHooks.php

@@ -0,0 +1,132 @@
+<?php
+
+namespace WPML\ST\MO\File;
+
+use WP_Filesystem_Direct;
+use WPML\ST\MO\Generate\Process\Status;
+use WPML\ST\MO\Generate\Process\SingleSiteProcess;
+use WPML\ST\MO\Notice\RegenerationInProgressNotice;
+use function wpml_get_admin_notices;
+
+class FailureHooks implements \IWPML_Backend_Action {
+	use makeDir;
+
+	const NOTICE_GROUP             = 'mo-failure';
+	const NOTICE_ID_MISSING_FOLDER = 'missing-folder';
+
+	/** @var Status */
+	private $status;
+
+	/** @var SingleSiteProcess $singleProcess */
+	private $singleProcess;
+
+	public function __construct(
+		WP_Filesystem_Direct $filesystem,
+		Status $status,
+		SingleSiteProcess $singleProcess
+	) {
+		$this->filesystem    = $filesystem;
+		$this->status        = $status;
+		$this->singleProcess = $singleProcess;
+	}
+
+	public function add_hooks() {
+		add_action( 'admin_init', [ $this, 'checkDirectories' ] );
+	}
+
+	public function checkDirectories() {
+		if ( $this->isDirectoryMissing( WP_LANG_DIR ) ) {
+			$this->resetRegenerateStatus();
+			$this->displayMissingFolderNotice( WP_LANG_DIR );
+
+			return;
+		}
+
+		if ( $this->isDirectoryMissing( self::getSubdir() ) ) {
+			$this->resetRegenerateStatus();
+
+			if ( ! $this->maybeCreateSubdir() ) {
+				$this->displayMissingFolderNotice( self::getSubdir() );
+				return;
+			}
+		}
+
+		if ( ! $this->status->isComplete() ) {
+			$this->displayRegenerateInProgressNotice();
+			$this->singleProcess->runPage();
+		}
+
+		if ( $this->status->isComplete() ) {
+			wpml_get_admin_notices()->remove_notice( RegenerationInProgressNotice::GROUP, RegenerationInProgressNotice::ID );
+		}
+	}
+
+	/**
+	 * @param string $dir
+	 */
+	public function displayMissingFolderNotice( $dir ) {
+		$notices = wpml_get_admin_notices();
+		$notice = $notices->get_new_notice(
+			self::NOTICE_ID_MISSING_FOLDER, self::missingFolderNoticeContent( $dir ),
+			self::NOTICE_GROUP
+		);
+		$notice->set_css_classes( 'error' );
+		$notices->add_notice( $notice );
+	}
+
+	/**
+	 * @param string $dir
+	 *
+	 * @return string
+	 */
+	public static function missingFolderNoticeContent( $dir ) {
+		$text = '<p>' .
+		        esc_html__( 'WPML String Translation is attempting to write .mo files with translations to folder:',
+			        'wpml-string-translation' ) . '<br/>' .
+		        str_replace( '\\', '/', $dir ) .
+		        '</p>';
+
+		$text .= '<p>' . esc_html__( 'This folder appears to be not writable. This is blocking translation for strings from appearing on the site.',
+				'wpml-string-translation' ) . '</p>';
+
+		$text .= '<p>' . esc_html__( 'To resolve this, please contact your hosting company and request that they make that folder writable.',
+				'wpml-string-translation' ) . '</p>';
+
+		$url = 'https://wpml.org/faq/cannot-write-mo-files/?utm_source=plugin&utm_medium=gui&utm_campaign=wpmlst';
+		$link = '<a href="' . $url . '" target="_blank" rel="noreferrer noopener" >' .
+		        esc_html__( "WPML's documentation on troubleshooting .mo files generation.",
+			        'wpml-string-translation' ) .
+		        '</a>';
+
+		$text .= '<p>' . sprintf( esc_html__( 'For more details, see %s.', 'wpml-string-translation' ),
+				$link ) . '</p>';
+
+		return $text;
+	}
+
+	private function displayRegenerateInProgressNotice() {
+		$notices = wpml_get_admin_notices();
+		$notices->remove_notice( self::NOTICE_GROUP, self::NOTICE_ID_MISSING_FOLDER );
+		$notices->add_notice( new RegenerationInProgressNotice() );
+	}
+
+	/**
+	 * @return string
+	 */
+	public static function getSubdir() {
+		return WP_LANG_DIR . '/' . \WPML\ST\TranslationFile\Manager::SUB_DIRECTORY;
+	}
+
+	/**
+	 * @param string $dir
+	 *
+	 * @return bool
+	 */
+	private function isDirectoryMissing( $dir ) {
+		return ! $this->filesystem->is_writable( $dir );
+	}
+
+	private function resetRegenerateStatus() {
+		$this->status->markIncomplete();
+	}
+}