<?php

/**
 * @file classes/migration/upgrade/PKPv3_3_0UpgradeMigration.inc.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2000-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class SubmissionsMigration
 * @brief Describe database table structures.
 */

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Capsule\Manager as Capsule;
use Illuminate\Database\PostgresConnection;
use Illuminate\Database\Query\JoinClause;

class PKPv3_3_0UpgradeMigration extends Migration {
	/**
	 * Run the migrations.
	 * @return void
	 */
	public function up() {
		if (Capsule::schema()->hasColumn('submissions', 'locale')) {
			Capsule::schema()->table('submissions', function (Blueprint $table) {
				// pkp/pkp-lib#3572 Remove OJS 2.x upgrade tools (OPS doesn't have this)
				$table->dropColumn('locale');
			});
		}
		Capsule::schema()->table('submissions', function (Blueprint $table) {
			// pkp/pkp-lib#6285 submissions.section_id in OMP appears only from 3.2.1
			if (Capsule::schema()->hasColumn($table->getTable(), 'section_id')) {
				// pkp/pkp-lib#2493 Remove obsolete columns
				$table->dropColumn('section_id');
			};
		});
		Capsule::schema()->table('publication_settings', function (Blueprint $table) {
			// pkp/pkp-lib#6096 DB field type TEXT is cutting off long content
			$table->mediumText('setting_value')->nullable()->change();
		});
		if (Capsule::schema()->hasColumn('authors', 'submission_id')) {
			Capsule::schema()->table('authors', function (Blueprint $table) {
				// pkp/pkp-lib#2493 Remove obsolete columns
				$table->dropColumn('submission_id');
			});
		}
		if (Capsule::schema()->hasColumn('author_settings', 'setting_type')) {
			Capsule::schema()->table('author_settings', function (Blueprint $table) {
				// pkp/pkp-lib#2493 Remove obsolete columns
				$table->dropColumn('setting_type');
			});
		}
		Capsule::schema()->table('announcements', function (Blueprint $table) {
			// pkp/pkp-lib#5865 Change announcement expiry format in database
			$table->date('date_expire')->change();
		});
		Capsule::schema()->table('announcement_settings', function (Blueprint $table) {
			// pkp/pkp-lib#6748 Change announcement setting type to permit nulls
			$table->string('setting_type', 6)->nullable()->change();
		});

		// Transitional: The stage_id column may have already been added by the ADODB schema toolset
		if (!Capsule::schema()->hasColumn('email_templates_default', 'stage_id')) {
			Capsule::schema()->table('email_templates_default', function (Blueprint $table) {
				// pkp/pkp-lib#4796 stage ID as a filter parameter to email templates
				$table->bigInteger('stage_id')->nullable();
			});
		}

		// pkp/pkp-lib#6301: Indexes may be missing that affect search performance.
		// (These are added for 3.2.1-2 so may or may not be present for this upgrade code.)
		$schemaManager = Capsule::connection()->getDoctrineSchemaManager();
		if (!in_array('submissions_publication_id', array_keys($schemaManager->listTableIndexes('submissions')))) {
			Capsule::schema()->table('submissions', function (Blueprint $table) {
				$table->index(['submission_id'], 'submissions_publication_id');
			});
		}
		if (!in_array('submission_search_object_submission', array_keys($schemaManager->listTableIndexes('submission_search_objects')))) {
			Capsule::schema()->table('submission_search_objects', function (Blueprint $table) {
				$table->index(['submission_id'], 'submission_search_object_submission');
			});
		}

		// pkp/pkp-lib#6093 Don't allow nulls (previously an upgrade workaround)
		Capsule::schema()->table('announcement_types', function (Blueprint $table) {
			$table->bigInteger('assoc_type')->nullable(false)->change();
		});
		Capsule::schema()->table('email_templates', function (Blueprint $table) {
			$table->bigInteger('context_id')->default(0)->nullable(false)->change();
		});
		Capsule::schema()->table('genres', function (Blueprint $table) {
			$table->bigInteger('seq')->nullable(false)->change();
			$table->smallInteger('supplementary')->default(0)->nullable(false)->change();
		});
		Capsule::schema()->table('event_log', function (Blueprint $table) {
			$table->bigInteger('assoc_type')->nullable(false)->change();
			$table->bigInteger('assoc_id')->nullable(false)->change();
		});
		Capsule::schema()->table('email_log', function (Blueprint $table) {
			$table->bigInteger('assoc_type')->nullable(false)->change();
			$table->bigInteger('assoc_id')->nullable(false)->change();
		});
		Capsule::schema()->table('notes', function (Blueprint $table) {
			$table->bigInteger('assoc_type')->nullable(false)->change();
			$table->bigInteger('assoc_id')->nullable(false)->change();
		});
		Capsule::schema()->table('review_assignments', function (Blueprint $table) {
			$table->bigInteger('review_round_id')->nullable(false)->change();
		});
		Capsule::schema()->table('authors', function (Blueprint $table) {
			$table->bigInteger('publication_id')->nullable(false)->change();
		});
		Capsule::connection()->unprepared('UPDATE review_assignments SET review_form_id=NULL WHERE review_form_id=0');

		$this->_populateEmailTemplates();
		$this->_makeRemoteUrlLocalizable();

		// pkp/pkp-lib#6057: Migrate locale property from publications to submissions
		Capsule::schema()->table('submissions', function (Blueprint $table) {
			$table->string('locale', 14)->nullable();
		});

		if (Capsule::connection() instanceof PostgresConnection) {
			Capsule::connection()->unprepared(
				'UPDATE submissions AS s
				SET locale = p.locale
				FROM publications AS p
				WHERE p.publication_id = s.current_publication_id'
			);
		} else {
			Capsule::table('submissions as s')
				->join('publications as p', 'p.publication_id', '=', 's.current_publication_id')
				->update(['s.locale' => Capsule::raw('p.locale')]);
		}

		Capsule::schema()->table('publications', function (Blueprint $table) {
			$table->dropColumn('locale');
		});

		// pkp/pkp-lib#6057 Submission files refactor
		$this->_migrateSubmissionFiles();

		$this->_fixCapitalCustomBlockTitles();
		$this->_createCustomBlockTitles();

		// Remove item views related to submission files and notes,
		// and convert the assoc_id to an integer
		Capsule::table('item_views')
			->where('assoc_type', '!=', ASSOC_TYPE_REVIEW_RESPONSE)
			->delete();
		// PostgreSQL requires an explicit type cast
		if (substr(Config::getVar('database', 'driver'), 0, strlen('postgres')) === 'postgres') {
			Capsule::statement('ALTER TABLE item_views ALTER COLUMN assoc_id TYPE BIGINT USING (assoc_id::INTEGER)');
		} else {
			Capsule::schema()->table('item_views', function (Blueprint $table) {
				$table->bigInteger('assoc_id')->change();
			});
		}

		// pkp/pkp-lib#4017 and pkp/pkp-lib#4622
		Capsule::schema()->create('jobs', function (Blueprint $table) {
			$table->bigIncrements('id');
			$table->string('queue');
			$table->longText('payload');
			$table->unsignedTinyInteger('attempts');
			$table->unsignedInteger('reserved_at')->nullable();
			$table->unsignedInteger('available_at');
			$table->unsignedInteger('created_at');
			$table->index(['queue', 'reserved_at']);
		});

		// pkp/pkp-lib#6594 Clear context defaults installed for unused languages
		$settingsWithDefaults = [
			'authorInformation',
			'librarianInformation',
			'openAccessPolicy',
			'privacyStatement',
			'readerInformation',
			'submissionChecklist',
			'clockssLicense',
			'lockssLicense',
		];
		$contextDao = Application::getContextDAO();
		$tableName = $contextDao->tableName;
		$settingsTableName = $contextDao->settingsTableName;
		$primaryKeyColumn = $contextDao->primaryKeyColumn;
		$rows = Capsule::table($settingsTableName . ' as js')
			->join($tableName . ' as j', 'j.' . $primaryKeyColumn, '=', 'js.' . $primaryKeyColumn)
			->where('js.setting_name', '=', 'supportedFormLocales')
			->select(['js.' . $primaryKeyColumn . ' as id', 'js.setting_value as locales'])
			->get();
		foreach ($rows as $row) {
			// account for some locale settings stored as assoc arrays
			$locales = $row->locales;
			if (empty($locales)) {
				$locales = [];
			} elseif (@unserialize($locales) !== false ) {
				$locales = unserialize($locales);
			} else {
				$locales = json_decode($locales, true);
			}
			$locales = array_values($locales);
			Capsule::table($settingsTableName)
				->where($primaryKeyColumn, '=', $row->id)
				->whereIn('setting_name', $settingsWithDefaults)
				->whereNotIn('locale', $locales)
				->delete();
		}
	}

	/**
	 * Reverse the downgrades
	 * @return void
	 */
	public function down() {
		throw new PKP\install\DowngradeNotSupportedException();
	}

	/**
	 * @return void
	 * @brief populate email templates with new records for workflow stage id
	 */
	private function _populateEmailTemplates() {
		$xmlDao = new XMLDAO();
		$emailTemplateDao = DAORegistry::getDAO('EmailTemplateDAO');
		$data = $xmlDao->parseStruct($emailTemplateDao->getMainEmailTemplatesFilename(), array('email'));
		foreach ($data['email'] as $template) {
			$attr = $template['attributes'];
			if (array_key_exists('stage_id', $attr)) {
				Capsule::table('email_templates_default')->where('email_key', $attr['key'])->update(array('stage_id' => $attr['stage_id']));
			}
		}
	}

	/**
	 * @return void
	 * @brief make remoteUrl navigation item type multilingual and drop the url column
	 */
	private function _makeRemoteUrlLocalizable() {
		$contextService = Services::get('context');
		$contextIds = $contextService->getIds();
		foreach ($contextIds as $contextId) {
			$context = $contextService->get($contextId);
			$locales = $context->getData('supportedLocales');

			$navigationItems = Capsule::table('navigation_menu_items')->where('context_id', $contextId)->pluck('url', 'navigation_menu_item_id')->filter()->all();
			foreach ($navigationItems as $navigation_menu_item_id => $url) {
				foreach ($locales as $locale) {
					Capsule::table('navigation_menu_item_settings')->insert([
						'navigation_menu_item_id' => $navigation_menu_item_id,
						'locale' => $locale,
						'setting_name' => 'remoteUrl',
						'setting_value' => $url,
						'setting_type' => 'string'
					]);
				}
			}
		}

		$siteDao = DAORegistry::getDAO('SiteDAO'); /* @var $siteDao SiteDAO */
		$site = $siteDao->getSite();
		$supportedLocales = $site->getSupportedLocales();
		$navigationItems = Capsule::table('navigation_menu_items')->where('context_id', '0')->pluck('url', 'navigation_menu_item_id')->filter()->all();
		foreach ($navigationItems as $navigation_menu_item_id => $url) {
			foreach ($supportedLocales as $locale) {
				Capsule::table('navigation_menu_item_settings')->insert([
					'navigation_menu_item_id' => $navigation_menu_item_id,
					'locale' => $locale,
					'setting_name' => 'remoteUrl',
					'setting_value' => $url,
					'setting_type' => 'string'
				]);
			}
		}

		Capsule::schema()->table('navigation_menu_items', function (Blueprint $table) {
			$table->dropColumn('url');
		});
	}

	/**
	 * Migrate submission files after major refactor
	 *
	 *	- Add files table to manage underlying file storage
	 *	- Replace the use of file_id/revision as a unique id with a single
	 * 		auto-incrementing submission_file_id, and update all references.
	 *	- Move revisions to a submission_file_revisons table.
	 *	- Drop unused columns in submission_files table.
	 *
	 * @see pkp/pkp-lib#6057
	 */
	private function _migrateSubmissionFiles() {
		import('lib.pkp.classes.submission.SubmissionFile'); // SUBMISSION_FILE_ constants

		// pkp/pkp-lib#6616 Delete submission_files entries that correspond to nonexistent submissions
		$orphanedIds = Capsule::table('submission_files AS sf')->leftJoin('submissions AS s', 'sf.submission_id', '=', 's.submission_id')->whereNull('s.submission_id')->pluck('sf.submission_id', 'sf.file_id');
		foreach ($orphanedIds as $fileId => $submissionId) {
			error_log("Removing orphaned submission_files entry ID $fileId with submission_id $submissionId");
			Capsule::table('submission_files')->where('file_id', '=', $fileId)->delete();
		}

		// Add partial index (DBMS-specific)
		switch (Capsule::connection()->getDriverName()) {
			case 'mysql': Capsule::connection()->unprepared('CREATE INDEX event_log_settings_name_value ON event_log_settings (setting_name(50), setting_value(150))'); break;
			case 'pgsql': Capsule::connection()->unprepared("CREATE INDEX event_log_settings_name_value ON event_log_settings (setting_name, setting_value) WHERE setting_name IN ('fileId', 'submissionId')"); break;
		}

		// Create a new table to track files in file storage
		Capsule::schema()->create('files', function (Blueprint $table) {
			$table->bigIncrements('file_id');
			$table->string('path', 255);
			$table->string('mimetype', 255);
		});

		// Create a new table to track submission file revisions
		Capsule::schema()->create('submission_file_revisions', function (Blueprint $table) {
			$table->bigIncrements('revision_id');
			$table->unsignedBigInteger('submission_file_id');
			$table->unsignedBigInteger('file_id');
		});

		// Add columns to submission_files table
		Capsule::schema()->table('submission_files', function (Blueprint $table) {
			$table->unsignedBigInteger('new_file_id')->nullable(); // Renamed and made not nullable at the end of the migration
		});

		// Drop unique keys that will cause trouble while we're migrating
		Capsule::schema()->table('review_round_files', function (Blueprint $table) {
			$table->dropIndex('review_round_files_pkey');
		});

		// Create entry in files and revisions tables for every submission_file
		import('lib.pkp.classes.file.FileManager');
		$fileManager = new FileManager();
		$rows = Capsule::table('submission_files')
			->join('submissions', 'submission_files.submission_id', '=', 'submissions.submission_id')
			->orderBy('file_id')
			->orderBy('revision')
			->get([
				'context_id',
				'file_id',
				'revision',
				'submission_files.submission_id',
				'genre_id',
				'file_type',
				'file_stage',
				'date_uploaded',
				'original_file_name'
			]);
		$fileService = Services::get('file');
		$submissionFileService = Services::get('submissionFile');
		foreach ($rows as $row) {
			// Reproduces the removed method SubmissionFile::_generateFileName()
			// genre is %s because it can be blank with review attachments
			$filename = sprintf(
				'%d-%s-%d-%d-%d-%s.%s',
				$row->submission_id,
				$row->genre_id,
				$row->file_id,
				$row->revision,
				$row->file_stage,
				date('Ymd', strtotime($row->date_uploaded)),
				strtolower_codesafe($fileManager->parseFileExtension($row->original_file_name))
			);
			$path = sprintf(
				'%s/%s/%s',
				$submissionFileService->getSubmissionDir($row->context_id, $row->submission_id),
				$this->_fileStageToPath($row->file_stage),
				$filename
			);
			if (!$fileService->fs->has($path)) {
				error_log("A submission file was expected but not found at $path.");
			}
			$newFileId = Capsule::table('files')->insertGetId([
				'path' => $path,
				'mimetype' => $row->file_type,
			], 'file_id');
			Capsule::table('submission_files')
				->where('file_id', $row->file_id)
				->where('revision', $row->revision)
				->update(['new_file_id' => $newFileId]);
			Capsule::table('submission_file_revisions')->insert([
				'submission_file_id' => $row->file_id,
				'file_id' => $newFileId,
			]);

			// Update revision data in event logs
			Capsule::table('event_log_settings as els')
				->join('event_log_settings as file_setting', function (JoinClause $join) use ($row) {
					$join->on('file_setting.log_id', '=', 'els.log_id')
						->where('file_setting.setting_name', '=', 'fileId')
						->where('file_setting.setting_value', '=', (string) $row->file_id);
				})
				->where('els.setting_name', 'fileRevision')
				->where('els.setting_value', '=', $row->revision)
				->update(['els.setting_value' => $newFileId]);
		}

		// Collect rows that will be deleted because they are old revisions
		// They are identified by the new_file_id column, which is the only unique
		// column on the table at this point.
		$newFileIdsToDelete = [];

		// Get all the unique file_ids. For each one, determine the latest revision
		// in order to keep it in the table. The others will be flagged for removal
		foreach (Capsule::table('submission_files')->select('file_id')->distinct()->get() as $row) {
			$submissionFileRows = Capsule::table('submission_files')
				->where('file_id', '=', $row->file_id)
				->orderBy('revision', 'desc')
				->get([
					'file_id',
					'new_file_id',
				]);
			$latestFileId = $submissionFileRows[0]->new_file_id;
			foreach ($submissionFileRows as $submissionFileRow) {
				if ($submissionFileRow->new_file_id !== $latestFileId) {
					$newFileIdsToDelete[] = $submissionFileRow->new_file_id;
				}
			}
		}

		// Delete the rows for old revisions (chunked for performance)
		foreach (array_chunk($newFileIdsToDelete, 100) as $chunkFileIds) {
			Capsule::table('submission_files')
				->whereIn('new_file_id', $chunkFileIds)
				->delete();
		}

		// Remove all review round files that point to file ids
		// that don't exist, so that the foreign key can be set
		// up successfully.
		// See: https://github.com/pkp/pkp-lib/issues/6337
		Capsule::table('review_round_files as rrf')
			->leftJoin('submission_files as sf', 'sf.file_id', '=', 'rrf.file_id')
			->whereNotNull('rrf.file_id')
			->whereNull('sf.file_id')
			->delete();

		// Update review round files
		$rows = Capsule::table('review_round_files')->get();
		foreach ($rows as $row) {
			// Delete this row if another revision exists for this
			// submission file. This ensures that when the revision
			// column is dropped the submission_file_id column will
			// be unique.
			$count = Capsule::table('review_round_files')
				->where('file_id', '=', $row->file_id)
				->count();
			if ($count > 1) {
				Capsule::table('review_round_files')
					->where('file_id', '=', $row->file_id)
					->where('revision', '=', $row->revision)
					->delete();
				continue;
			}

			// Set assoc_type and assoc_id for all review round files
			// Run this before migration to internal review file stages
			Capsule::table('submission_files')
				->where('file_id', '=', $row->file_id)
				->whereIn('file_stage', [SUBMISSION_FILE_REVIEW_FILE, SUBMISSION_FILE_REVIEW_REVISION])
				->update([
					'assoc_type' => ASSOC_TYPE_REVIEW_ROUND,
					'assoc_id' => $row->review_round_id,
				]);
		}

		// Update name of event log params to reflect new file structure
		Capsule::table('event_log_settings')
			->where('setting_name', 'fileId')
			->update(['setting_name' => 'submissionFileId']);
		Capsule::table('event_log_settings')
			->where('setting_name', 'fileRevision')
			->update(['setting_name' => 'fileId']);

		// Update file name of dependent files, see: pkp/pkp-lib#6801
		Capsule::table('submission_files')
			->select('file_id', 'original_file_name')
			->where('file_stage' , '=', SUBMISSION_FILE_DEPENDENT)
			->chunkById(1000, function ($dependentFiles) {
				foreach ($dependentFiles as $dependentFile) {
					Capsule::table('submission_file_settings')
						->where('file_id', '=', $dependentFile->file_id)
						->where('setting_name', '=', 'name')
						->update(['setting_value' => $dependentFile->original_file_name]);
				}
			}, 'file_id');

		// Restructure submission_files and submission_file_settings tables
		Capsule::schema()->table('submission_files', function (Blueprint $table) {
			$table->bigInteger('file_id')->nullable(false)->unsigned()->change();
		});
		Capsule::schema()->table('submission_files', function (Blueprint $table) {
			$table->dropPrimary(); // Drop compound primary key constraint
		});
		Capsule::schema()->table('submission_files', function (Blueprint $table) {
			$table->renameColumn('file_id', 'submission_file_id');
			$table->renameColumn('new_file_id', 'file_id');
			$table->renameColumn('source_file_id', 'source_submission_file_id');
			$table->renameColumn('date_uploaded', 'created_at');
			$table->renameColumn('date_modified', 'updated_at');
			$table->dropColumn('revision');
			$table->dropColumn('source_revision');
			$table->dropColumn('file_size');
			$table->dropColumn('file_type');
			$table->dropColumn('original_file_name');
			$table->primary('submission_file_id');
		});
		//  pkp/pkp-lib#5804
		$schemaManager = Capsule::connection()->getDoctrineSchemaManager();
		if (!in_array('submission_files_stage_assoc', array_keys($schemaManager->listTableIndexes('submission_files')))) {
			Capsule::schema()->table('submission_files', function (Blueprint $table) {
				$table->index(['file_stage', 'assoc_type', 'assoc_id'], 'submission_files_stage_assoc');
			});
		}
		// Modify column types and attributes in separate migration
		// function to prevent error in postgres with unfound columns
		Capsule::schema()->table('submission_files', function (Blueprint $table) {
			$table->bigInteger('submission_file_id')->autoIncrement()->unsigned()->change();
			$table->bigInteger('file_id')->nullable(false)->unsigned()->change();
			$table->foreign('file_id')->references('file_id')->on('files');
		});
		Capsule::schema()->table('submission_file_settings', function (Blueprint $table) {
			$table->renameColumn('file_id', 'submission_file_id');
			$table->string('setting_type', 6)->default('string')->change();
		});

		// Update columns in related tables
		Capsule::schema()->table('review_round_files', function (Blueprint $table) {
			$table->renameColumn('file_id', 'submission_file_id');
			$table->dropColumn('revision');
		});
		Capsule::schema()->table('review_round_files', function (Blueprint $table) {
			$table->bigInteger('submission_file_id')->nullable(false)->unique()->unsigned()->change();
			$table->unique(['submission_id', 'review_round_id', 'submission_file_id'], 'review_round_files_pkey');
			$table->foreign('submission_file_id')->references('submission_file_id')->on('submission_files');
		});
		Capsule::schema()->table('review_files', function (Blueprint $table) {
			$table->renameColumn('file_id', 'submission_file_id');
		});

		// pkp/pkp-lib#6616 Delete review_files entries that correspond to nonexistent submission_files
		$orphanedIds = Capsule::table('review_files AS rf')
			->select('rf.submission_file_id', 'rf.review_id')
			->leftJoin('submission_files AS sf', 'rf.submission_file_id', '=', 'sf.submission_file_id')
			->whereNull('sf.submission_file_id')
			->whereNotNull('rf.submission_file_id')
			->get();
		foreach ($orphanedIds as $orphanedId) {
			$reviewId = $orphanedId->{'review_id'};
			$submissionFileId = $orphanedId->{'submission_file_id'};
			error_log("Removing orphaned review_files entry with review_id ID $reviewId and submission_file_id $submissionFileId");
			Capsule::table('review_files')
				->where('submission_file_id', '=', $submissionFileId)
				->where('review_id', '=', $reviewId)
				->delete();
		}

		Capsule::schema()->table('review_files', function (Blueprint $table) {
			$table->bigInteger('submission_file_id')->nullable(false)->unsigned()->change();
			$table->dropIndex('review_files_pkey');
			$table->unique(['review_id', 'submission_file_id'], 'review_files_pkey');
			$table->foreign('submission_file_id')->references('submission_file_id')->on('submission_files');
		});
		Capsule::schema()->table('submission_file_revisions', function (Blueprint $table) {
			$table->foreign('submission_file_id')->references('submission_file_id')->on('submission_files');
			$table->foreign('file_id')->references('file_id')->on('files');
		});

		// Postgres leaves the old file_id autoincrement sequence around, so
		// we delete it and apply a new sequence.
		if (substr(Config::getVar('database', 'driver'), 0, strlen('postgres')) === 'postgres') {
			Capsule::statement('DROP SEQUENCE submission_files_file_id_seq CASCADE');
			Capsule::schema()->table('submission_files', function (Blueprint $table) {
				$table->bigIncrements('submission_file_id')->change();
			});
		}
	}

	/**
	 * Get the directory of a file based on its file stage
	 *
	 * @param int $fileStage ONe of SUBMISSION_FILE_ constants
	 * @return string
	 */
	private function _fileStageToPath($fileStage) {
		import('lib.pkp.classes.submission.SubmissionFile');
		static $fileStagePathMap = [
			SUBMISSION_FILE_SUBMISSION => 'submission',
			SUBMISSION_FILE_NOTE => 'note',
			SUBMISSION_FILE_REVIEW_FILE => 'submission/review',
			SUBMISSION_FILE_REVIEW_ATTACHMENT => 'submission/review/attachment',
			SUBMISSION_FILE_REVIEW_REVISION => 'submission/review/revision',
			SUBMISSION_FILE_FINAL => 'submission/final',
			7 /* SUBMISSION_FILE_FAIR_COPY */ => 'submission/fairCopy',
			8 /* SUBMISSION_FILE_EDITOR */ => 'submission/editor',
			SUBMISSION_FILE_COPYEDIT => 'submission/copyedit',
			SUBMISSION_FILE_DEPENDENT => 'submission/proof',
			SUBMISSION_FILE_PROOF => 'submission/proof',
			SUBMISSION_FILE_PRODUCTION_READY => 'submission/productionReady',
			SUBMISSION_FILE_ATTACHMENT => 'attachment',
			SUBMISSION_FILE_QUERY => 'submission/query',
		];

		if (!isset($fileStagePathMap[$fileStage])) {
			error_log('A file assigned to the file stage ' . $fileStage . ' could not be migrated.');
		}

		return $fileStagePathMap[$fileStage];
	}

	/*
	 * Update block names to be all lowercase
	 *
	 * In previous versions, a custom block name would be stored in the
	 * array of blocks with capitals but the block name in the plugin_settings
	 * table is all lowercase. This migration aligns the two places by changing
	 * the block names to always use lowercase.
	 *
	 * @return void
	 */
	private function _fixCapitalCustomBlockTitles() {
		$rows = Capsule::table('plugin_settings')
			->where('plugin_name', 'customblockmanagerplugin')
			->where('setting_name', 'blocks')
			->get();
		foreach ($rows as $row) {
			$updateBlocks = false;
			$blocks = unserialize($row->setting_value);
			foreach ($blocks as $key => $block) {
				$newBlock = strtolower_codesafe($block);
				if ($block !== $newBlock) {
					$blocks[$key] = $newBlock;
					$updateBlocks = true;
				}
			}
			if ($updateBlocks) {
				Capsule::table('plugin_settings')
					->where('plugin_name', 'customblockmanagerplugin')
					->where('setting_name', 'blocks')
					->where('context_id', $row->context_id)
					->update(['setting_value' => serialize($blocks)]);
			}
		}
	}

	/*
	 * Create titles for custom block plugins
	 *
	 * This method copies the block names, which are a unique id,
	 * into a block setting, `blockTitle`, in the context's
	 * primary locale
	 *
	 * @see https://github.com/pkp/pkp-lib/issues/5619
	 */
	private function _createCustomBlockTitles() {
		$contextDao = \Application::get()->getContextDAO();

		$rows = Capsule::table('plugin_settings')
			->where('plugin_name', 'customblockmanagerplugin')
			->where('setting_name', 'blocks')
			->get();

		$newRows = [];
		foreach ($rows as $row) {
			$locale = Capsule::table($contextDao->tableName)
				->where($contextDao->primaryKeyColumn, $row->context_id)
				->first()
				->primary_locale;
			$blocks = unserialize($row->setting_value);
			foreach ($blocks as $block) {
				$newRows[] = [
					'plugin_name' => $block,
					'context_id' => $row->context_id,
					'setting_name' => 'blockTitle',
					'setting_value' => serialize([$locale => $block]),
					'setting_type' => 'object',
				];
			}
		}
		if (!Capsule::table('plugin_settings')->insert($newRows)) {
			error_log('Failed to create title for custom blocks. This can be fixed manually by editing each custom block and adding a title.');
		}
	}
}
