Skip to content

Commit

Permalink
pkp/pkp-lib#2493 Convert xmlSchema descriptors to migrations
Browse files Browse the repository at this point in the history
  • Loading branch information
@asmecher
asmecher committed May 9, 2020
1 parent cdd07a9 commit f933c4a
Showing 1 changed file with 321 additions and 0 deletions.
321 changes: 321 additions & 0 deletions classes/migration/OJSMigration.inc.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,321 @@
<?php

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

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Builder;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Capsule\Manager as Capsule;

class OJSMigration extends Migration {
/**
* Run the migrations.
* @return void
*/
public function up() {
// Journals and basic journal settings.
Capsule::schema()->create('journals', function (Blueprint $table) {
$table->bigInteger('journal_id')->autoIncrement();
$table->unique(['journal_id']);
$table->string('path', 32);
$table->float('seq', 8, 2)->default('0')->comment('Used to order lists of journals');
$table->string('primary_locale', 14);
$table->boolean('enabled')->default('1')->comment('Controls whether or not the journal is considered "live" and will appear on the website. (Note that disabled journals may still be accessible, but only if the user knows the URL.)');
$table->unique(['path'], 'journals_path');
});

// Journal settings.
Capsule::schema()->create('journal_settings', function (Blueprint $table) {
$table->bigInteger('journal_id');
$table->string('locale', 14)->default('');
$table->string('setting_name', 255);
$table->text('setting_value')->nullable();
$table->string('setting_type', 6)->nullable();
$table->index(['journal_id'], 'journal_settings_journal_id');
$table->unique(['journal_id', 'locale', 'setting_name'], 'journal_settings_pkey');
});

// Journal sections.
Capsule::schema()->create('sections', function (Blueprint $table) {
$table->bigInteger('section_id')->autoIncrement();
$table->unique(['section_id']);
$table->bigInteger('journal_id');
$table->bigInteger('review_form_id')->nullable();
$table->float('seq', 8, 2)->default('0');
$table->boolean('editor_restricted')->default('0');
$table->boolean('meta_indexed')->default('0');
$table->boolean('meta_reviewed')->default('1');
$table->boolean('abstracts_not_required')->default('0');
$table->boolean('hide_title')->default('0');
$table->boolean('hide_author')->default('0');
$table->bigInteger('abstract_word_count')->nullable();
$table->index(['journal_id'], 'sections_journal_id');
});

// Section-specific settings
Capsule::schema()->create('section_settings', function (Blueprint $table) {
$table->bigInteger('section_id');
$table->string('locale', 14)->default('');
$table->string('setting_name', 255);
$table->text('setting_value')->nullable();
$table->string('setting_type', 6)->comment('(bool|int|float|string|object)');
$table->index(['section_id'], 'section_settings_section_id');
$table->unique(['section_id', 'locale', 'setting_name'], 'section_settings_pkey');
});

// Journal issues.
Capsule::schema()->create('issues', function (Blueprint $table) {
$table->bigInteger('issue_id')->autoIncrement();
$table->unique(['issue_id']);
$table->bigInteger('journal_id');
$table->smallInteger('volume')->nullable();
$table->string('number', 40)->nullable();
$table->smallInteger('year')->nullable();
$table->boolean('published')->default('0');
$table->boolean('current')->default('0');
$table->timestamp('date_published')->nullable();
$table->timestamp('date_notified')->nullable();
$table->timestamp('last_modified')->nullable();
$table->boolean('access_status')->default('1');
$table->timestamp('open_access_date')->nullable();
$table->boolean('show_volume')->default('0');
$table->boolean('show_number')->default('0');
$table->boolean('show_year')->default('0');
$table->boolean('show_title')->default('0');
$table->string('style_file_name', 90)->nullable();
$table->string('original_style_file_name', 255)->nullable();
$table->string('url_path', 64)->nullable();
$table->index(['journal_id'], 'issues_journal_id');
$table->index(['url_path'], 'issues_url_path');
});

// Locale-specific issue data
Capsule::schema()->create('issue_settings', function (Blueprint $table) {
$table->bigInteger('issue_id');
$table->string('locale', 14)->default('');
$table->string('setting_name', 255);
$table->text('setting_value')->nullable();
$table->string('setting_type', 6);
$table->index(['issue_id'], 'issue_settings_issue_id');
$table->unique(['issue_id', 'locale', 'setting_name'], 'issue_settings_pkey');
});

// Issue galleys.
Capsule::schema()->create('issue_galleys', function (Blueprint $table) {
$table->bigInteger('galley_id')->autoIncrement();
$table->unique(['galley_id']);
$table->string('locale', 14)->nullable();
$table->bigInteger('issue_id');
$table->bigInteger('file_id');
$table->string('label', 32)->nullable();
$table->float('seq', 8, 2)->default('0');
$table->string('url_path', 64)->nullable();
$table->index(['issue_id'], 'issue_galleys_issue_id');
$table->index(['url_path'], 'issue_galleys_url_path');
});

// Issue galley metadata.
Capsule::schema()->create('issue_galley_settings', function (Blueprint $table) {
$table->bigInteger('galley_id');
$table->string('locale', 14)->default('');
$table->string('setting_name', 255);
$table->text('setting_value')->nullable();
$table->string('setting_type', 6)->comment('(bool|int|float|string|object)');
$table->index(['galley_id'], 'issue_galley_settings_galley_id');
$table->unique(['galley_id', 'locale', 'setting_name'], 'issue_galley_settings_pkey');
});

Capsule::schema()->create('issue_files', function (Blueprint $table) {
$table->bigInteger('file_id')->autoIncrement();
$table->unique(['file_id']);
$table->bigInteger('issue_id');
$table->string('file_name', 90);
$table->string('file_type', 255);
$table->bigInteger('file_size');
$table->bigInteger('content_type');
$table->string('original_file_name', 127)->nullable();
$table->timestamp('date_uploaded');
$table->timestamp('date_modified');
$table->index(['issue_id'], 'issue_files_issue_id');
});

// Custom sequencing information for journal issues, when available
Capsule::schema()->create('custom_issue_orders', function (Blueprint $table) {
$table->bigInteger('issue_id');
$table->bigInteger('journal_id');
$table->float('seq', 8, 2)->default('0');
$table->unique(['issue_id'], 'custom_issue_orders_pkey');
});

// Custom sequencing information for journal sections by issue, when available.
Capsule::schema()->create('custom_section_orders', function (Blueprint $table) {
$table->bigInteger('issue_id');
$table->bigInteger('section_id');
$table->float('seq', 8, 2)->default('0');
$table->unique(['issue_id', 'section_id'], 'custom_section_orders_pkey');
});

// Archived, removed from TOC, unscheduled or unpublished journal articles.
Capsule::schema()->create('submission_tombstones', function (Blueprint $table) {
$table->bigInteger('tombstone_id')->autoIncrement();
$table->unique(['tombstone_id']);
$table->bigInteger('submission_id');
$table->timestamp('date_deleted');
$table->bigInteger('journal_id');
$table->bigInteger('section_id');
$table->string('set_spec', 255);
$table->string('set_name', 255);
$table->string('oai_identifier', 255);
$table->index(['journal_id'], 'submission_tombstones_journal_id');
$table->index(['submission_id'], 'submission_tombstones_submission_id');
});

// Publications
Capsule::schema()->create('publications', function (Blueprint $table) {
$table->bigInteger('publication_id')->autoIncrement();
$table->unique(['publication_id']);
$table->bigInteger('access_status')->default('0')->nullable();
$table->date('date_published')->nullable();
$table->timestamp('last_modified')->nullable();
$table->string('locale', 14)->nullable();
$table->bigInteger('primary_contact_id')->nullable();
$table->bigInteger('section_id')->nullable();
$table->float('seq', 8, 2)->default('0');
$table->bigInteger('submission_id');
// STATUS_QUEUED
$table->boolean('status')->default('1');
$table->string('url_path', 64)->nullable();
$table->bigInteger('version')->nullable();
$table->index(['submission_id'], 'publications_submission_id');
$table->index(['section_id'], 'publications_section_id');
$table->index(['url_path'], 'publications_url_path');
});

// Publication galleys
Capsule::schema()->create('publication_galleys', function (Blueprint $table) {
$table->bigInteger('galley_id')->autoIncrement();
$table->unique(['galley_id']);
$table->string('locale', 14)->nullable();
$table->bigInteger('publication_id');
$table->string('label', 255)->nullable();
$table->bigInteger('file_id')->nullable();
$table->float('seq', 8, 2)->default('0');
$table->string('remote_url', 2047)->nullable();
$table->boolean('is_approved')->default('0');
$table->string('url_path', 64)->nullable();
$table->index(['publication_id'], 'publication_galleys_publication_id');
$table->index(['url_path'], 'publication_galleys_url_path');
});

// Galley metadata.
Capsule::schema()->create('publication_galley_settings', function (Blueprint $table) {
$table->bigInteger('galley_id');
$table->string('locale', 14)->default('');
$table->string('setting_name', 255);
$table->text('setting_value')->nullable();
$table->index(['galley_id'], 'publication_galley_settings_galley_id');
$table->unique(['galley_id', 'locale', 'setting_name'], 'publication_galley_settings_pkey');
});

// Subscription types.
Capsule::schema()->create('subscription_types', function (Blueprint $table) {
$table->bigInteger('type_id')->autoIncrement();
$table->unique(['type_id']);
$table->bigInteger('journal_id');
$table->float('cost', 8, 2);
$table->string('currency_code_alpha', 3);
$table->boolean('non_expiring')->default('0');
$table->smallInteger('duration')->nullable();
$table->smallInteger('format');
$table->boolean('institutional')->default('0');
$table->boolean('membership')->default('0');
$table->boolean('disable_public_display');
$table->float('seq', 8, 2);
});

// Locale-specific subscription type data
Capsule::schema()->create('subscription_type_settings', function (Blueprint $table) {
$table->bigInteger('type_id');
$table->string('locale', 14)->default('');
$table->string('setting_name', 255);
$table->text('setting_value')->nullable();
$table->string('setting_type', 6);
$table->index(['type_id'], 'subscription_type_settings_type_id');
$table->unique(['type_id', 'locale', 'setting_name'], 'subscription_type_settings_pkey');
});

// Journal subscriptions.
Capsule::schema()->create('subscriptions', function (Blueprint $table) {
$table->bigInteger('subscription_id')->autoIncrement();
$table->unique(['subscription_id']);
$table->bigInteger('journal_id');
$table->bigInteger('user_id');
$table->bigInteger('type_id');
$table->date('date_start')->nullable();
$table->timestamp('date_end')->nullable();
$table->boolean('status')->default('1');
$table->string('membership', 40)->nullable();
$table->string('reference_number', 40)->nullable();
$table->text('notes')->nullable();
});

// Journal institutional subscriptions.
Capsule::schema()->create('institutional_subscriptions', function (Blueprint $table) {
$table->bigInteger('institutional_subscription_id')->autoIncrement();
$table->unique(['institutional_subscription_id']);
$table->bigInteger('subscription_id');
$table->string('institution_name', 255);
$table->string('mailing_address', 255)->nullable();
$table->string('domain', 255)->nullable();
$table->index(['subscription_id'], 'institutional_subscriptions_subscription_id');
$table->index(['domain'], 'institutional_subscriptions_domain');
});

// Journal institutional subscription IPs and IP ranges.
Capsule::schema()->create('institutional_subscription_ip', function (Blueprint $table) {
$table->bigInteger('institutional_subscription_ip_id')->autoIncrement();
$table->unique(['institutional_subscription_ip_id'], 'institutional_subscription_ip_id_pkey');
$table->bigInteger('subscription_id');
$table->string('ip_string', 40);
$table->bigInteger('ip_start');
$table->bigInteger('ip_end')->nullable();
$table->index(['subscription_id'], 'institutional_subscription_ip_subscription_id');
$table->index(['ip_start'], 'institutional_subscription_ip_start');
$table->index(['ip_end'], 'institutional_subscription_ip_end');
});

// Logs queued (unfulfilled) payments.
Capsule::schema()->create('queued_payments', function (Blueprint $table) {
$table->bigInteger('queued_payment_id')->autoIncrement();
$table->unique(['queued_payment_id']);
$table->timestamp('date_created');
$table->timestamp('date_modified');
$table->date('expiry_date')->nullable();
$table->text('payment_data')->nullable();
});

// Logs completed (fulfilled) payments.
Capsule::schema()->create('completed_payments', function (Blueprint $table) {
$table->bigInteger('completed_payment_id')->autoIncrement();
$table->unique(['completed_payment_id']);
$table->timestamp('timestamp');
$table->bigInteger('payment_type');
$table->bigInteger('context_id');
$table->bigInteger('user_id')->nullable();
$table->bigInteger('assoc_id')->nullable();
$table->float('amount', 8, 2);
$table->string('currency_code_alpha', 3)->nullable();
$table->string('payment_method_plugin_name', 80)->nullable();
});

}
}

0 comments on commit f933c4a

Please sign in to comment.