Signal-Android/app/src/main/java/org/thoughtcrime/securesms/database/DatabaseFactory.java

/*
 * Copyright (C) 2018 Open Whisper Systems
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.thoughtcrime.securesms.database;

import android.content.Context;

import androidx.annotation.NonNull;

import net.zetetic.database.sqlcipher.SQLiteDatabase;

import org.thoughtcrime.securesms.contacts.ContactsDatabase;
import org.thoughtcrime.securesms.crypto.AttachmentSecret;
import org.thoughtcrime.securesms.crypto.AttachmentSecretProvider;
import org.thoughtcrime.securesms.crypto.DatabaseSecret;
import org.thoughtcrime.securesms.crypto.DatabaseSecretProvider;
import org.thoughtcrime.securesms.crypto.MasterSecret;
import org.thoughtcrime.securesms.database.helpers.ClassicOpenHelper;
import org.thoughtcrime.securesms.database.helpers.SQLCipherMigrationHelper;
import org.thoughtcrime.securesms.database.helpers.SQLCipherOpenHelper;
import org.thoughtcrime.securesms.database.model.AvatarPickerDatabase;
import org.thoughtcrime.securesms.migrations.LegacyMigrationJob;
import org.thoughtcrime.securesms.util.SqlUtil;
import org.thoughtcrime.securesms.util.TextSecurePreferences;

import java.io.Closeable;
import java.io.IOException;

public class DatabaseFactory {

  private static final Object lock = new Object();

  private static volatile DatabaseFactory instance;

  private final SQLCipherOpenHelper         databaseHelper;
  private final SmsDatabase                 sms;
  private final MmsDatabase                 mms;
  private final AttachmentDatabase          attachments;
  private final MediaDatabase               media;
  private final ThreadDatabase              thread;
  private final MmsSmsDatabase              mmsSmsDatabase;
  private final IdentityDatabase            identityDatabase;
  private final DraftDatabase               draftDatabase;
  private final PushDatabase                pushDatabase;
  private final GroupDatabase               groupDatabase;
  private final RecipientDatabase           recipientDatabase;
  private final ContactsDatabase            contactsDatabase;
  private final GroupReceiptDatabase        groupReceiptDatabase;
  private final OneTimePreKeyDatabase       preKeyDatabase;
  private final SignedPreKeyDatabase        signedPreKeyDatabase;
  private final SessionDatabase             sessionDatabase;
  private final SenderKeyDatabase           senderKeyDatabase;
  private final SenderKeySharedDatabase     senderKeySharedDatabase;
  private final PendingRetryReceiptDatabase pendingRetryReceiptDatabase;
  private final SearchDatabase              searchDatabase;
  private final StickerDatabase             stickerDatabase;
  private final UnknownStorageIdDatabase    storageIdDatabase;
  private final RemappedRecordsDatabase     remappedRecordsDatabase;
  private final MentionDatabase             mentionDatabase;
  private final PaymentDatabase             paymentDatabase;
  private final ChatColorsDatabase          chatColorsDatabase;
  private final EmojiSearchDatabase         emojiSearchDatabase;
  private final MessageSendLogDatabase      messageSendLogDatabase;
  private final AvatarPickerDatabase        avatarPickerDatabase;
  private final GroupCallRingDatabase       groupCallRingDatabase;

  public static DatabaseFactory getInstance(Context context) {
    if (instance == null) {
      synchronized (lock) {
        if (instance == null) {
          instance = new DatabaseFactory(context.getApplicationContext());
        }
      }
    }
    return instance;
  }

  public static MmsSmsDatabase getMmsSmsDatabase(Context context) {
    return getInstance(context).mmsSmsDatabase;
  }

  public static ThreadDatabase getThreadDatabase(Context context) {
    return getInstance(context).thread;
  }

  public static MessageDatabase getSmsDatabase(Context context) {
    return getInstance(context).sms;
  }

  public static MessageDatabase getMmsDatabase(Context context) {
    return getInstance(context).mms;
  }

  public static AttachmentDatabase getAttachmentDatabase(Context context) {
    return getInstance(context).attachments;
  }

  public static MediaDatabase getMediaDatabase(Context context) {
    return getInstance(context).media;
  }

  public static IdentityDatabase getIdentityDatabase(Context context) {
    return getInstance(context).identityDatabase;
  }

  public static DraftDatabase getDraftDatabase(Context context) {
    return getInstance(context).draftDatabase;
  }

  /**
   * @deprecated You probably shouldn't be using this anymore. It used to store encrypted envelopes,
   *             but now it's skipped over in favor of other mechanisms. It's only accessible to
   *             support old migrations and stuff.
   */
  @Deprecated
  public static PushDatabase getPushDatabase(Context context) {
    return getInstance(context).pushDatabase;
  }

  public static GroupDatabase getGroupDatabase(Context context) {
    return getInstance(context).groupDatabase;
  }

  public static RecipientDatabase getRecipientDatabase(Context context) {
    return getInstance(context).recipientDatabase;
  }

  public static ContactsDatabase getContactsDatabase(Context context) {
    return getInstance(context).contactsDatabase;
  }

  public static GroupReceiptDatabase getGroupReceiptDatabase(Context context) {
    return getInstance(context).groupReceiptDatabase;
  }

  public static OneTimePreKeyDatabase getPreKeyDatabase(Context context) {
    return getInstance(context).preKeyDatabase;
  }

  public static SignedPreKeyDatabase getSignedPreKeyDatabase(Context context) {
    return getInstance(context).signedPreKeyDatabase;
  }

  public static SessionDatabase getSessionDatabase(Context context) {
    return getInstance(context).sessionDatabase;
  }

  public static SenderKeyDatabase getSenderKeyDatabase(Context context) {
    return getInstance(context).senderKeyDatabase;
  }

  public static SenderKeySharedDatabase getSenderKeySharedDatabase(Context context) {
    return getInstance(context).senderKeySharedDatabase;
  }

  public static PendingRetryReceiptDatabase getPendingRetryReceiptDatabase(Context context) {
    return getInstance(context).pendingRetryReceiptDatabase;
  }

  public static SearchDatabase getSearchDatabase(Context context) {
    return getInstance(context).searchDatabase;
  }

  public static StickerDatabase getStickerDatabase(Context context) {
    return getInstance(context).stickerDatabase;
  }

  public static UnknownStorageIdDatabase getUnknownStorageIdDatabase(Context context) {
    return getInstance(context).storageIdDatabase;
  }

  static RemappedRecordsDatabase getRemappedRecordsDatabase(Context context) {
    return getInstance(context).remappedRecordsDatabase;
  }

  public static MentionDatabase getMentionDatabase(Context context) {
    return getInstance(context).mentionDatabase;
  }

  public static PaymentDatabase getPaymentDatabase(Context context) {
    return getInstance(context).paymentDatabase;
  }

  public static ChatColorsDatabase getChatColorsDatabase(Context context) {
    return getInstance(context).chatColorsDatabase;
  }

  public static EmojiSearchDatabase getEmojiSearchDatabase(Context context) {
    return getInstance(context).emojiSearchDatabase;
  }

  public static MessageSendLogDatabase getMessageLogDatabase(Context context) {
    return getInstance(context).messageSendLogDatabase;
  }

  public static AvatarPickerDatabase getAvatarPickerDatabase(Context context) {
    return getInstance(context).avatarPickerDatabase;
  }

  public static GroupCallRingDatabase getGroupCallRingDatabase(Context context) {
    return getInstance(context).groupCallRingDatabase;
  }

  public static net.zetetic.database.sqlcipher.SQLiteDatabase getBackupDatabase(Context context) {
    return getInstance(context).databaseHelper.getRawReadableDatabase();
  }

  public static void upgradeRestored(Context context, SQLiteDatabase database){
    synchronized (lock) {
      getInstance(context).databaseHelper.onUpgrade(database, database.getVersion(), -1);
      getInstance(context).databaseHelper.markCurrent(database);
      getInstance(context).sms.deleteAbandonedMessages();
      getInstance(context).mms.deleteAbandonedMessages();
      getInstance(context).mms.trimEntriesForExpiredMessages();
      getInstance(context).getRawDatabase().execSQL("DROP TABLE IF EXISTS key_value");
      getInstance(context).getRawDatabase().execSQL("DROP TABLE IF EXISTS megaphone");
      getInstance(context).getRawDatabase().execSQL("DROP TABLE IF EXISTS job_spec");
      getInstance(context).getRawDatabase().execSQL("DROP TABLE IF EXISTS constraint_spec");
      getInstance(context).getRawDatabase().execSQL("DROP TABLE IF EXISTS dependency_spec");
    }
  }

  public static boolean inTransaction(Context context) {
    return getInstance(context).databaseHelper.getSignalWritableDatabase().inTransaction();
  }

  private DatabaseFactory(@NonNull Context context) {
    SqlCipherLibraryLoader.load();

    DatabaseSecret   databaseSecret   = DatabaseSecretProvider.getOrCreateDatabaseSecret(context);
    AttachmentSecret attachmentSecret = AttachmentSecretProvider.getInstance(context).getOrCreateAttachmentSecret();

    this.databaseHelper              = new SQLCipherOpenHelper(context, databaseSecret);
    this.sms                         = new SmsDatabase(context, databaseHelper);
    this.mms                         = new MmsDatabase(context, databaseHelper);
    this.attachments                 = new AttachmentDatabase(context, databaseHelper, attachmentSecret);
    this.media                       = new MediaDatabase(context, databaseHelper);
    this.thread                      = new ThreadDatabase(context, databaseHelper);
    this.mmsSmsDatabase              = new MmsSmsDatabase(context, databaseHelper);
    this.identityDatabase            = new IdentityDatabase(context, databaseHelper);
    this.draftDatabase               = new DraftDatabase(context, databaseHelper);
    this.pushDatabase                = new PushDatabase(context, databaseHelper);
    this.groupDatabase               = new GroupDatabase(context, databaseHelper);
    this.recipientDatabase           = new RecipientDatabase(context, databaseHelper);
    this.groupReceiptDatabase        = new GroupReceiptDatabase(context, databaseHelper);
    this.contactsDatabase            = new ContactsDatabase(context);
    this.preKeyDatabase              = new OneTimePreKeyDatabase(context, databaseHelper);
    this.signedPreKeyDatabase        = new SignedPreKeyDatabase(context, databaseHelper);
    this.sessionDatabase             = new SessionDatabase(context, databaseHelper);
    this.senderKeyDatabase           = new SenderKeyDatabase(context, databaseHelper);
    this.senderKeySharedDatabase     = new SenderKeySharedDatabase(context, databaseHelper);
    this.pendingRetryReceiptDatabase = new PendingRetryReceiptDatabase(context, databaseHelper);
    this.searchDatabase              = new SearchDatabase(context, databaseHelper);
    this.stickerDatabase             = new StickerDatabase(context, databaseHelper, attachmentSecret);
    this.storageIdDatabase           = new UnknownStorageIdDatabase(context, databaseHelper);
    this.remappedRecordsDatabase     = new RemappedRecordsDatabase(context, databaseHelper);
    this.mentionDatabase             = new MentionDatabase(context, databaseHelper);
    this.paymentDatabase             = new PaymentDatabase(context, databaseHelper);
    this.chatColorsDatabase          = new ChatColorsDatabase(context, databaseHelper);
    this.emojiSearchDatabase         = new EmojiSearchDatabase(context, databaseHelper);
    this.messageSendLogDatabase      = new MessageSendLogDatabase(context, databaseHelper);
    this.avatarPickerDatabase        = new AvatarPickerDatabase(context, databaseHelper);
    this.groupCallRingDatabase       = new GroupCallRingDatabase(context, databaseHelper);
  }

  public void onApplicationLevelUpgrade(@NonNull Context context, @NonNull MasterSecret masterSecret,
                                        int fromVersion, LegacyMigrationJob.DatabaseUpgradeListener listener)
  {
    databaseHelper.getSignalWritableDatabase();

    ClassicOpenHelper legacyOpenHelper = null;

    if (fromVersion < LegacyMigrationJob.ASYMMETRIC_MASTER_SECRET_FIX_VERSION) {
      legacyOpenHelper = new ClassicOpenHelper(context);
      legacyOpenHelper.onApplicationLevelUpgrade(context, masterSecret, fromVersion, listener);
    }

    if (fromVersion < LegacyMigrationJob.SQLCIPHER && TextSecurePreferences.getNeedsSqlCipherMigration(context)) {
      if (legacyOpenHelper == null) {
        legacyOpenHelper = new ClassicOpenHelper(context);
      }

      SQLCipherMigrationHelper.migrateCiphertext(context, masterSecret,
                                                 legacyOpenHelper.getWritableDatabase(),
                                                 databaseHelper.getRawWritableDatabase(),
                                                 listener);
    }
  }

  public void triggerDatabaseAccess() {
    databaseHelper.getSignalWritableDatabase();
  }

  public net.zetetic.database.sqlcipher.SQLiteDatabase getRawDatabase() {
    return databaseHelper.getRawWritableDatabase();
  }

  public boolean hasTable(String table) {
    return SqlUtil.tableExists(databaseHelper.getRawReadableDatabase(), table);
  }

  public @NonNull Transaction transaction() {
    getRawDatabase().beginTransaction();
    return () -> {
      getRawDatabase().setTransactionSuccessful();
      getRawDatabase().endTransaction();
    };
  }

  public interface Transaction extends Closeable {
    @Override
    void close();
  }
}