calamares/src/modules/partition/gui/ChoicePage.cpp

/* === This file is part of Calamares - <http://github.com/calamares> ===
 *
 *   Copyright 2014-2015, Teo Mrnjavac <teo@kde.org>
 *
 *   Calamares 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.
 *
 *   Calamares 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 Calamares. If not, see <http://www.gnu.org/licenses/>.
 */

#include "ChoicePage.h"

#include "core/PartitionActions.h"
#include "core/PartitionCoreModule.h"
#include "core/DeviceModel.h"
#include "core/PartitionModel.h"
#include "core/OsproberEntry.h"

#include "PrettyRadioButton.h"
#include "PartitionPreview.h"

#include "utils/CalamaresUtilsGui.h"
#include "utils/Logger.h"
#include "utils/Retranslator.h"
#include "Branding.h"

#include <kpmcore/core/device.h>

#include <QBoxLayout>
#include <QButtonGroup>
#include <QComboBox>
#include <QDir>
#include <QLabel>
#include <QListView>


#define drivesList  qobject_cast< QListView* >( m_drivesView )
#define drivesCombo qobject_cast< QComboBox* >( m_drivesView )

/**
 * @brief ChoicePage::ChoicePage is the default constructor. Called on startup as part of
 *      the module loading code path.
 * @param compactMode if true, the drive selector will be a combo box on top, otherwise it
 *      will show up as a list view.
 * @param parent the QWidget parent.
 */
ChoicePage::ChoicePage( bool compactMode, QWidget* parent )
    : QWidget( parent )
    , m_compactMode( compactMode )
    , m_choice( NoChoice )
    , m_nextEnabled( false )
    , m_core( nullptr )
    , m_alongsideButton( nullptr )
    , m_eraseButton( nullptr )
    , m_replaceButton( nullptr )
    , m_somethingElseButton( nullptr )
    , m_lastSelectedDeviceIndex( -1 )
{
    setupUi( this );
    if ( m_compactMode )
    {
        m_mainLayout->setDirection( QBoxLayout::TopToBottom );
        m_drivesLayout->setDirection( QBoxLayout::LeftToRight );
        m_drivesView = new QComboBox( this );
        m_mainLayout->setStretchFactor( m_drivesLayout, 0 );
        m_mainLayout->setStretchFactor( m_rightLayout, 1 );
        m_drivesLabel->setBuddy( m_drivesView );
    }
    else
    {
        m_drivesView = new QListView( this );

        drivesList->setViewMode( QListView::ListMode );
        drivesList->setWrapping( false );
        drivesList->setFlow( QListView::TopToBottom );
        drivesList->setSelectionRectVisible( false );
        drivesList->setWordWrap( true );
        drivesList->setUniformItemSizes( true );
        drivesList->setSelectionMode( QAbstractItemView::SingleSelection );
        drivesList->setHorizontalScrollBarPolicy( Qt::ScrollBarAlwaysOff );

        drivesList->setIconSize( CalamaresUtils::defaultIconSize() / 2 );
    }

    m_drivesLayout->addWidget( m_drivesView );

    if ( m_compactMode )
        m_drivesLayout->addStretch();

    m_messageLabel->setWordWrap( true );

    CalamaresUtils::unmarginLayout( m_itemsLayout );

    // Drive selector + preview
    CALAMARES_RETRANSLATE( m_drivesLabel->setText( tr( "Storage de&vice:" ) ); )

    m_previewBeforeFrame->setSizePolicy( QSizePolicy::Preferred, QSizePolicy::Expanding );
    m_previewAfterFrame->setSizePolicy( QSizePolicy::Preferred, QSizePolicy::Expanding );
    m_previewAfterFrame->hide();
    // end
}


ChoicePage::~ChoicePage()
{}


/**
 * @brief ChoicePage::init runs when the PartitionViewStep and the PartitionCoreModule are
 *      ready. Sets up the rest of the UI based on os-prober output.
 * @param core the PartitionCoreModule pointer.
 * @param osproberEntries the output of os-prober, cleaned up and structured.
 */
void
ChoicePage::init( PartitionCoreModule* core,
                  const OsproberEntryList& osproberEntries )
{
    m_core = core;
    m_osproberEntries = osproberEntries;

    setupChoices();

    if ( compact() )
    {
        // We need to do this because a PCM revert invalidates the deviceModel.
        connect( core, &PartitionCoreModule::reverted,
                 this, [=]
        {
            drivesCombo->setModel( core->deviceModel() );
            drivesCombo->setCurrentIndex( m_lastSelectedDeviceIndex );
        } );
        drivesCombo->setModel( core->deviceModel() );

        connect( drivesCombo,
                 static_cast< void ( QComboBox::* )( int ) >( &QComboBox::currentIndexChanged ),
                 this, &ChoicePage::applyDeviceChoice );
    }
    else
    {
        // Same as above.
        connect( core, &PartitionCoreModule::reverted,
                 this, [=]
        {
            drivesList->setModel( core->deviceModel() );
            drivesList->selectionModel()->setCurrentIndex(
                        core->deviceModel()->index( m_lastSelectedDeviceIndex ), QItemSelectionModel::ClearAndSelect );
        } );
        drivesList->setModel( core->deviceModel() );
        connect( drivesList->selectionModel(),
                 &QItemSelectionModel::currentChanged,
                 this, &ChoicePage::applyDeviceChoice );
    }

    ChoicePage::applyDeviceChoice();
}


/**
 * @brief ChoicePage::setupChoices creates PrettyRadioButton objects for the action
 *      choices.
 * @warning This must only run ONCE because it creates signal-slot connections for the
 *      actions. When an action is triggered, it runs action-specific code that may
 *      change the internal state of the PCM, and it updates the bottom preview (or
 *      split) widget.
 *      Synchronous loading ends here.
 */
void
ChoicePage::setupChoices()
{
    // sample os-prober output:
    // /dev/sda2:Windows 7 (loader):Windows:chain
    // /dev/sda6::Arch:linux
    //
    // There are three possibilities we have to consider:
    //  - There are no operating systems present
    //  - There is one operating system present
    //  - There are multiple operating systems present
    //
    // There are three outcomes we have to provide:
    //  1) Wipe+autopartition
    //  2) Resize+autopartition
    //  3) Manual
    //  TBD: upgrade option?

    QSize iconSize( CalamaresUtils::defaultIconSize().width() * 2,
                    CalamaresUtils::defaultIconSize().height() * 2 );
    QButtonGroup* grp = new QButtonGroup( this );

    m_alongsideButton = new PrettyRadioButton;
    m_alongsideButton->setIconSize( iconSize );
    m_alongsideButton->setIcon( CalamaresUtils::defaultPixmap( CalamaresUtils::PartitionAlongside,
                                                               CalamaresUtils::Original,
                                                               iconSize ) );
    grp->addButton( m_alongsideButton->buttonWidget() );

    m_eraseButton = new PrettyRadioButton;
    m_eraseButton->setIconSize( iconSize );
    m_eraseButton->setIcon( CalamaresUtils::defaultPixmap( CalamaresUtils::PartitionEraseAuto,
                                                           CalamaresUtils::Original,
                                                           iconSize ) );
    grp->addButton( m_eraseButton->buttonWidget() );

    m_replaceButton = new PrettyRadioButton;
    m_replaceButton->setIconSize( iconSize );
    m_replaceButton->setIcon( CalamaresUtils::defaultPixmap( CalamaresUtils::PartitionReplaceOs,
                                                             CalamaresUtils::Original,
                                                             iconSize ) );
    grp->addButton( m_replaceButton->buttonWidget() );

    m_itemsLayout->addWidget( m_alongsideButton );
    m_itemsLayout->addWidget( m_replaceButton );
    m_itemsLayout->addWidget( m_eraseButton );
    m_itemsLayout->setSpacing( CalamaresUtils::defaultFontHeight() / 2 );

    QFrame* hLine = new QFrame;
    hLine->setFrameStyle( QFrame::HLine );
    m_itemsLayout->addWidget( hLine );

    m_somethingElseButton = new PrettyRadioButton;
    CALAMARES_RETRANSLATE(
        m_somethingElseButton->setText( tr( "<strong>Manual partitioning</strong><br/>"
                                            "You can create or resize partitions yourself, or choose "
                                            "multiple partitions for %1." )
                                        .arg( Calamares::Branding::instance()->
                                              string( Calamares::Branding::ShortVersionedName ) ) );
    )
    m_somethingElseButton->setIconSize( iconSize );
    m_somethingElseButton->setIcon( CalamaresUtils::defaultPixmap( CalamaresUtils::PartitionManual,
                                                                   CalamaresUtils::Original,
                                                                   iconSize ) );
    m_itemsLayout->addWidget( m_somethingElseButton );
    grp->addButton( m_somethingElseButton->buttonWidget() );

    m_itemsLayout->addStretch();

    connect( m_alongsideButton->buttonWidget(), &QRadioButton::toggled,
             this, [ this ]( bool checked )
    {
        if ( checked )
        {
            m_choice = Alongside;
            setNextEnabled( true );
            emit actionChosen();
        }
    } );

    connect( m_eraseButton->buttonWidget(), &QRadioButton::toggled,
             this, [ this ]( bool checked )
    {
        if ( checked )
        {
            m_choice = Erase;
            setNextEnabled( true );
            emit actionChosen();
        }
    } );

    connect( m_replaceButton->buttonWidget(), &QRadioButton::toggled,
             this, [ this ]( bool checked )
    {
        if ( checked )
        {
            m_choice = Replace;
            setNextEnabled( true );
            emit actionChosen();
        }
    } );

    connect( m_somethingElseButton->buttonWidget(), &QRadioButton::toggled,
             this, [ this ]( bool checked )
    {
        if ( checked )
        {
            m_choice = Manual;
            setNextEnabled( true );
            emit actionChosen();
        }
    } );

    m_rightLayout->setStretchFactor( m_itemsLayout, 1 );
    m_rightLayout->setStretchFactor( m_previewBeforeFrame, 0 );
    m_rightLayout->setStretchFactor( m_previewAfterFrame, 0 );

    connect( this, &ChoicePage::actionChosen,
             this, [=]
    {
        Device* currd = selectedDevice();
        if ( currd )
        {
            applyActionChoice( currd, currentChoice() );
            updateActionChoicePreview( currd, currentChoice() );
        }
    } );
}


/**
 * @brief ChoicePage::selectedDevice queries the device picker (which may be a combo or
 *      a list view) to get a pointer to the currently selected Device.
 * @return a Device pointer, valid in the current state of the PCM, or nullptr if
 *      something goes wrong.
 */
Device*
ChoicePage::selectedDevice()
{
    if ( !compact() &&
         drivesList->selectionModel()->currentIndex() == QModelIndex() )
    {
        cDebug() << "No disk selected, bailing out.";
        return nullptr;
    }

    Device* currentDevice = nullptr;
    if ( compact() )
    {
        currentDevice = m_core->deviceModel()->deviceForIndex(
                  m_core->deviceModel()->index(
                      drivesCombo->currentIndex() ) );
    }
    else
    {
        currentDevice = m_core->deviceModel()->deviceForIndex(
                  drivesList->selectionModel()->currentIndex() );
    }

    return currentDevice;
}


/**
 * @brief ChoicePage::applyDeviceChoice handler for the selected event of the device
 *      picker. Calls ChoicePage::selectedDevice() to get the current Device*, then
 *      updates the preview widget for the on-disk state (calls ChoicePage::
 *      updateDeviceStatePreview()) and finally sets up the available actions and their
 *      text by calling ChoicePage::setupActions().
 */
void
ChoicePage::applyDeviceChoice()
{
    Device* currd = selectedDevice();

    if ( m_core->isDirty() )
        m_core->clearJobs();

    // The device should only be nullptr immediately after a PCM reset.
    // applyDeviceChoice() will be called again momentarily as soon as we handle the
    // PartitionCoreModule::reverted signal.
    if ( !currd )
        return;

    updateDeviceStatePreview( currd );
    // Preview setup done. Now we show/hide choices as needed.

    setupActions( currd );

    if ( compact() )
        m_lastSelectedDeviceIndex = drivesCombo->currentIndex();
    else
        m_lastSelectedDeviceIndex = drivesList->selectionModel()->currentIndex().row();

    emit actionChosen();
}


void
ChoicePage::applyActionChoice( Device* currentDevice, ChoicePage::Choice choice )
{
    switch ( choice )
    {
    case Erase:
        if ( m_core->isDirty() )
            m_core->clearJobs();

        PartitionActions::doAutopartition( m_core, selectedDevice() );
        break;
    case Replace:
    case NoChoice:
    case Manual:
        break;
    }
}


/**
 * @brief ChoicePage::updateDeviceStatePreview clears and rebuilds the contents of the
 *      preview widget for the current on-disk state. This also triggers a rescan in the
 *      PCM to get a Device* copy that's unaffected by subsequent PCM changes.
 * @param currentDevice a pointer to the selected Device.
 */
void
ChoicePage::updateDeviceStatePreview( Device* currentDevice )
{
    //FIXME: this needs to be made async because the rescan can block the UI thread for
    //       a while. --Teo 10/2015
    Q_ASSERT( currentDevice );
    QMutexLocker locker( &m_previewsMutex );

    cDebug() << "Updating partitioning state widgets.";
    qDeleteAll( m_previewBeforeFrame->children() );
    m_previewBeforeFrame->layout()->deleteLater();

    QVBoxLayout* layout = new QVBoxLayout;
    m_previewBeforeFrame->setLayout( layout );
    layout->setMargin( 0 );

    PartitionPreview* preview = new PartitionPreview( m_previewBeforeFrame );
    preview->setLabelsVisible( true );

    Device* deviceBefore = m_core->createImmutableDeviceCopy( currentDevice );

    PartitionModel* model = new PartitionModel( preview );
    model->init( deviceBefore );

    // The QObject parents tree is meaningful for memory management here,
    // see qDeleteAll above.
    deviceBefore->setParent( model );
    model->setParent( preview );

    preview->setModel( model );
    layout->addWidget( preview );
}


/**
 * @brief ChoicePage::updateActionChoicePreview clears and rebuilds the contents of the
 *      preview widget for the current PCM-proposed state. No rescans here, this should
 *      be immediate.
 * @param currentDevice a pointer to the selected Device.
 * @param choice the chosen partitioning action.
 */
void
ChoicePage::updateActionChoicePreview( Device* currentDevice, ChoicePage::Choice choice )
{
    Q_ASSERT( currentDevice );
    QMutexLocker locker( &m_previewsMutex );

    cDebug() << "Updating partitioning preview widgets.";
    qDeleteAll( m_previewAfterFrame->children() );
    m_previewAfterFrame->layout()->deleteLater();

    QVBoxLayout* layout = new QVBoxLayout;
    m_previewAfterFrame->setLayout( layout );
    layout->setMargin( 0 );

    QLabel* label = new QLabel;
    layout->addWidget( label );

    switch ( choice )
    {
    case Alongside:
        // split widget goes here
        label->setText( tr( "Drag to split:" ) );

        break;
    case Erase:
    case Replace:
        {
            label->setText( tr( "Preview:" ) );
            PartitionPreview* preview = new PartitionPreview( m_previewAfterFrame );
            preview->setLabelsVisible( true );

            PartitionModel* model = new PartitionModel( preview );
            model->init( currentDevice );

            // The QObject parents tree is meaningful for memory management here,
            // see qDeleteAll above.
            model->setParent( preview );
            preview->setModel( model );
            layout->addWidget( preview );

            m_previewAfterFrame->show();
            break;
        }
    case NoChoice:
    case Manual:
        m_previewAfterFrame->hide();
        break;
    }
}


/**
 * @brief ChoicePage::setupActions happens every time a new Device* is selected in the
 *      device picker. Sets up the text and visibility of the partitioning actions based
 *      on the currently selected Device*, bootloader and os-prober output.
 * @param currentDevice
 */
void
ChoicePage::setupActions( Device *currentDevice )
{
    if ( m_osproberEntries.count() == 0 )
    {
        CALAMARES_RETRANSLATE(
            m_messageLabel->setText( tr( "This computer currently does not seem to have an operating system on it. "
                                         "What would you like to do?" ) );

            m_eraseButton->setText( tr( "<strong>Erase disk and install %1</strong><br/>"
                                        "This will <font color=\"red\">delete</font> all the data "
                                        "currently present on %2 (if any), including programs, "
                                        "documents, photos, music, and other files.<br/>"
                                        "You will be able to review and confirm your choice "
                                        "before proceeding." )
                                    .arg( Calamares::Branding::instance()->
                                          string( Calamares::Branding::ShortVersionedName ) )
                                    .arg( currentDevice->deviceNode() ) );
        )

        m_replaceButton->hide();
        m_alongsideButton->hide();
    }
    else if ( m_osproberEntries.count() == 1 )
    {
        QString osName = m_osproberEntries.first().prettyName;

        if ( !osName.isEmpty() )
        {
            CALAMARES_RETRANSLATE(
                m_messageLabel->setText( tr( "This computer currently has %1 on it. "
                                             "What would you like to do?" )
                                            .arg( osName ) );

                m_alongsideButton->setText( tr( "<strong>Install %2 alongside %1</strong><br/>"
                                                "The installer will shrink the %1 volume to make room for %2. "
                                                "You can choose which operating system you want each time the "
                                                "computer starts up." )
                                            .arg( osName )
                                            .arg( Calamares::Branding::instance()->
                                                  string( Calamares::Branding::ShortVersionedName ) ) );

                m_eraseButton->setText( tr( "<strong>Erase disk with %3 and install %1</strong><br/>"
                                            "This will <font color=\"red\">delete</font> all the data "
                                            "currently present on %2 (if any), including programs, "
                                            "documents, photos, music, and other files.<br/>"
                                            "You will be able to review and confirm your choice "
                                            "before proceeding." )
                                        .arg( Calamares::Branding::instance()->
                                              string( Calamares::Branding::ShortVersionedName ) )
                                        .arg( currentDevice->deviceNode() )
                                        .arg( osName ) );


                m_replaceButton->setText( tr( "<strong>Replace a partition with %1</strong><br/>"
                                              "You will be offered a choice of which partition to erase." )
                                        .arg( Calamares::Branding::instance()->
                                              string( Calamares::Branding::ShortVersionedName ) ) );
            )
        }
        else
        {
            CALAMARES_RETRANSLATE(
                m_messageLabel->setText( tr( "This computer already has an operating system on it. "
                                             "What would you like to do?" ) );

                m_alongsideButton->setText( tr( "<strong>Install %1 alongside your current operating system</strong><br/>"
                                                "The installer will shrink an existing volume to make room for %2. "
                                                "You can choose which operating system you want each time the "
                                                "computer starts up." )
                                            .arg( Calamares::Branding::instance()->
                                                  string( Calamares::Branding::ShortVersionedName ) )
                                            .arg( Calamares::Branding::instance()->
                                                  string( Calamares::Branding::ShortProductName ) ) );

                m_eraseButton->setText( tr( "<strong>Erase disk and install %1</strong><br/>"
                                            "This will <font color=\"red\">delete</font> all the data "
                                            "currently present on %2 (if any), including programs, "
                                            "documents, photos, music, and other files.<br/>"
                                            "You will be able to review and confirm your choice "
                                            "before proceeding." )
                                        .arg( Calamares::Branding::instance()->
                                              string( Calamares::Branding::ShortVersionedName ) )
                                        .arg( currentDevice->deviceNode() ) );

                m_replaceButton->setText( tr( "<strong>Replace a partition with %1</strong><br/>"
                                              "You will be offered a choice of which partition to erase." )
                                        .arg( Calamares::Branding::instance()->
                                              string( Calamares::Branding::ShortVersionedName ) ) );
            )
        }
        if ( !m_osproberEntries.first().canBeResized )
            m_alongsideButton->hide();
    }
    else
    {
        // m_osproberLines has at least 2 items.

        bool atLeastOneCanBeResized = false;

        foreach ( const OsproberEntry& entry, m_osproberEntries )
        {
            if ( entry.canBeResized )
            {
                atLeastOneCanBeResized = true;
                break;
            }
        }

        CALAMARES_RETRANSLATE(
            m_messageLabel->setText( tr( "This computer currently has multiple operating systems on it. "
                                         "What would you like to do?" ) );

            m_alongsideButton->setText( tr( "<strong>Install %1 alongside your current operating systems</strong><br/>"
                                            "The installer will shrink an existing volume to make room for %2. "
                                            "You can choose which operating system you want each time the "
                                            "computer starts up." )
                                        .arg( Calamares::Branding::instance()->
                                              string( Calamares::Branding::ShortVersionedName ) )
                                        .arg( Calamares::Branding::instance()->
                                              string( Calamares::Branding::ShortProductName ) ) );

            m_eraseButton->setText( tr( "<strong>Erase disk and install %1</strong><br/>"
                                        "This will <font color=\"red\">delete</font> all the data "
                                        "currently present on %2 (if any), including programs, "
                                        "documents, photos, music, and other files.<br/>"
                                        "You will be able to review and confirm your choice "
                                        "before proceeding." )
                                    .arg( Calamares::Branding::instance()->
                                          string( Calamares::Branding::ShortVersionedName ) )
                                    .arg( currentDevice->deviceNode() ) );

            m_replaceButton->setText( tr( "<strong>Replace a partition with %1</strong><br/>"
                                          "You will be offered a choice of which partition to erase." )
                                    .arg( Calamares::Branding::instance()->
                                          string( Calamares::Branding::ShortVersionedName ) ) );
        )

        if ( !atLeastOneCanBeResized )
            m_alongsideButton->hide();
    }

    bool isEfi = QDir( "/sys/firmware/efi/efivars" ).exists();
    bool efiSystemPartitionFound = !m_core->efiSystemPartitions().isEmpty();

    if ( isEfi && !efiSystemPartitionFound )
    {
        cDebug() << "WARNING: system is EFI but there's no EFI system partition, "
                    "DISABLING alongside and replace features.";
        m_alongsideButton->hide();
        m_replaceButton->hide();
    }
}


bool
ChoicePage::isNextEnabled() const
{
    return m_nextEnabled;
}


ChoicePage::Choice
ChoicePage::currentChoice() const
{
    return m_choice;
}


bool
ChoicePage::compact()
{
    if ( m_compactMode )
    {
        Q_ASSERT( drivesCombo );
        Q_ASSERT( !drivesList );
        return true;
    }
    else
    {
        Q_ASSERT( drivesList );
        Q_ASSERT( !drivesCombo );
        return false;
    }
}


void
ChoicePage::setNextEnabled( bool enabled )
{
    if ( enabled == m_nextEnabled )
        return;

    m_nextEnabled = enabled;
    emit nextStatusChanged( enabled );
}