/*
 * Copyright 2004-2019 H2 Group. Multiple-Licensed under the MPL 2.0,
 * and the EPL 1.0 (http://h2database.com/html/license.html).
 * Initial Developer: H2 Group
 */
package org.h2.engine;

import java.util.ArrayList;
import java.util.HashMap;

import org.h2.store.Data;
import org.h2.store.FileStore;
import org.h2.table.Table;
import org.h2.util.Utils;

Each session keeps a undo log if rollback is required.
/**
 * Each session keeps a undo log if rollback is required.
 */
public class UndoLog {

    private final Database database;
    private final ArrayList<Long> storedEntriesPos = Utils.newSmallArrayList();
    private final ArrayList<UndoLogRecord> records = Utils.newSmallArrayList();
    private FileStore file;
    private Data rowBuff;
    private int memoryUndo;
    private int storedEntries;
    private HashMap<Integer, Table> tables;

    
Create a new undo log for the given session.
Params:
database – the database/**
     * Create a new undo log for the given session.
     *
     * @param database the database
     */
    UndoLog(Database database) {
        this.database = database;
    }

    
Get the number of active rows in this undo log.
Returns:
the number of rows/**
     * Get the number of active rows in this undo log.
     *
     * @return the number of rows
     */
    int size() {
        return storedEntries + records.size();
    }

    
Clear the undo log. This method is called after the transaction is
committed.
/**
     * Clear the undo log. This method is called after the transaction is
     * committed.
     */
    void clear() {
        records.clear();
        storedEntries = 0;
        storedEntriesPos.clear();
        memoryUndo = 0;
        if (file != null) {
            file.closeAndDeleteSilently();
            file = null;
            rowBuff = null;
        }
    }

    
Get the last record and remove it from the list of operations.
Returns:
the last record/**
     * Get the last record and remove it from the list of operations.
     *
     * @return the last record
     */
    public UndoLogRecord getLast() {
        int i = records.size() - 1;
        if (i < 0 && storedEntries > 0) {
            int last = storedEntriesPos.size() - 1;
            long pos = storedEntriesPos.remove(last);
            long end = file.length();
            int bufferLength = (int) (end - pos);
            Data buff = Data.create(database, bufferLength, true);
            file.seek(pos);
            file.readFully(buff.getBytes(), 0, bufferLength);
            while (buff.length() < bufferLength) {
                UndoLogRecord e = UndoLogRecord.loadFromBuffer(buff, this);
                records.add(e);
                memoryUndo++;
            }
            storedEntries -= records.size();
            file.setLength(pos);
            file.seek(pos);
        }
        i = records.size() - 1;
        UndoLogRecord entry = records.get(i);
        if (entry.isStored()) {
            int start = Math.max(0, i - database.getMaxMemoryUndo() / 2);
            UndoLogRecord first = null;
            for (int j = start; j <= i; j++) {
                UndoLogRecord e = records.get(j);
                if (e.isStored()) {
                    e.load(rowBuff, file, this);
                    memoryUndo++;
                    if (first == null) {
                        first = e;
                    }
                }
            }
            for (int k = 0; k < i; k++) {
                UndoLogRecord e = records.get(k);
                e.invalidatePos();
            }
            seek(first.getFilePos());
        }
        return entry;
    }

    
Go to the right position in the file.
Params:
filePos – the position in the file/**
     * Go to the right position in the file.
     *
     * @param filePos the position in the file
     */
    void seek(long filePos) {
        file.seek(filePos * Constants.FILE_BLOCK_SIZE);
    }

    
Remove the last record from the list of operations.
/**
     * Remove the last record from the list of operations.
     */
    void removeLast() {
        int i = records.size() - 1;
        UndoLogRecord r = records.remove(i);
        if (!r.isStored()) {
            memoryUndo--;
        }
    }

    
Append an undo log entry to the log.
Params:
entry – the entry/**
     * Append an undo log entry to the log.
     *
     * @param entry the entry
     */
    void add(UndoLogRecord entry) {
        records.add(entry);
        memoryUndo++;
        if (memoryUndo > database.getMaxMemoryUndo() &&
                database.isPersistent() &&
                !database.isMVStore()) {
            if (file == null) {
                String fileName = database.createTempFile();
                file = database.openFile(fileName, "rw", false);
                file.autoDelete();
                file.setCheckedWriting(false);
                file.setLength(FileStore.HEADER_LENGTH);
            }
            Data buff = Data.create(database, Constants.DEFAULT_PAGE_SIZE, true);
            for (int i = 0; i < records.size(); i++) {
                UndoLogRecord r = records.get(i);
                buff.checkCapacity(Constants.DEFAULT_PAGE_SIZE);
                r.append(buff, this);
                if (i == records.size() - 1 || buff.length() > Constants.UNDO_BLOCK_SIZE) {
                    storedEntriesPos.add(file.getFilePointer());
                    file.write(buff.getBytes(), 0, buff.length());
                    buff.reset();
                }
            }
            storedEntries += records.size();
            memoryUndo = 0;
            records.clear();
        }
    }

    
Get the table id for this undo log. If the table is not registered yet,
this is done as well.
Params:
table – the table
Returns:
the id/**
     * Get the table id for this undo log. If the table is not registered yet,
     * this is done as well.
     *
     * @param table the table
     * @return the id
     */
    int getTableId(Table table) {
        int id = table.getId();
        if (tables == null) {
            tables = new HashMap<>();
        }
        // need to overwrite the old entry, because the old object
        // might be deleted in the meantime
        tables.put(id, table);
        return id;
    }

    
Get the table for this id. The table must be registered for this undo log
first by calling getTableId.
Params:
id – the table id
Returns:
the table object/**
     * Get the table for this id. The table must be registered for this undo log
     * first by calling getTableId.
     *
     * @param id the table id
     * @return the table object
     */
    Table getTable(int id) {
        return tables.get(id);
    }

}