/*

 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

 * All rights reserved.

 * This component and the accompanying materials are made available

 * under the terms of "Eclipse Public License v1.0"

 * which accompanies this distribution, and is available

 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

 *

 * Initial Contributors:

 * Nokia Corporation - initial contribution.

 *

 * Contributors:

 *

 * Description: Menu collection state.

 *

 */

#include <qstatemachine.h>

#include <HbGroupBox>

#include <HbListView>

#include <hbview.h>

#include <hbaction.h>

#include <hbabstractviewitem.h>

#include <hsmenueventfactory.h>

#include <hbmenu.h>

#include <hbinstance.h>

#include <hbsearchpanel.h>

#include "hsmenuevent.h"

#include "hsmenuservice.h"

#include "hsmenumodewrapper.h"

#include "hsmenuitemmodel.h"

#include "hsmenuviewbuilder.h"

#include "cadefs.h"

#include "caentry.h"

#include "hscollectionstate.h"

#include "hsaddappstocollectionstate.h"

#include "hsapp_defs.h"

/*!

 \class HsCollectionState

 \ingroup group_hsmenustateplugin

 \brief Collection State.

 Displays a concrete collection.

 \lib ?library

 \see StateMachine

 */

/*!

 \var HsCollectionState::mSortAttribute

 Sort order.

 */

/*!

 \var HsCollectionState::mCollectionsSortAttribute

 All collections sort order.

 */

/*!

 \var HsCollectionState::mCollectionId

 The id of the current collection.

 */

/*!

 \var HsCollectionState::mCollectionType

 The type of the current collection.

 */

/*!

 \var HsCollectionState::mMenuView

 The List View widget.

 */

/*!

 \var HsCollectionState::mSecondarySoftkeyAction

 Secondary Softkey action.

 Backstepping functionality.

 Own.

 */

/*!

 \var HsCollectionState::mOldNavigationAction

 Old navigation icon.

 Not own.

 */

/*!

 \var HsCollectionState::mCollectionModel

 Item Model for the List.

 Own.

 */

/*!

 \var HsCollectionState::mOptions

 Options menu.

 Own.

 */

/*!

  \fn void HsCollectionState::sortOrderChanged(SHsSortAttribute sortOrder);

  This signal is emitted when sort order is changed to \a sortOrder.

  \param sortAttribute sort attribute

 */

/*!

  \fn void HsCollectionState::constructMenu(bool isDynamic);

  Set up Menu.

  \param isDynamic Decides which options should be added to menu.

 */

/*!

 Constructor.

 \param menuViewBuilder Menu view builder.

 \param menuMode reference to object representing menu mode (add mode on/add mode off).

 \param parent Owner.

*/

HsCollectionState::HsCollectionState(HsMenuViewBuilder &menuViewBuilder,

                                     HsMenuModeWrapper &menuMode,

                                     QState *parent) :

    QState(parent),

    mSortAttribute(LatestOnTopHsSortAttribute),

    mCollectionsSortAttribute(CustomHsSortAttribute),

    mCollectionId(-1),

    mMenuView(menuViewBuilder, HsCollectionContext),

    mMenuMode(menuMode),

    mSecondarySoftkeyAction(new HbAction(Hb::BackNaviAction, this)),

    mCollectionModel(0),

{

    construct();

}

/*!

 Constructs contained objects.

 */

void HsCollectionState::construct()

{

    HSMENUTEST_FUNC_ENTRY("HsCollectionState::construct");

    const QString parentName =

        parent() != 0 ? parent()->objectName() : QString("");

    setObjectName(parentName + "/collectionstate");

    connect(this, SIGNAL(entered()),SLOT(stateEntered()));

    connect(this, SIGNAL(exited()),SLOT(stateExited()));

    makeConnect();

    mMenuView.view()->

    setNavigationAction(mSecondarySoftkeyAction);

    HSMENUTEST_FUNC_EXIT("HsCollectionState::construct");

}

/*!

 Destructor.

 */

HsCollectionState::~HsCollectionState()

{

    makeDisconnect();

    mMenuView.inactivate();

    mMenuView.setModel(NULL);

    mMenuView.view()->

    setNavigationAction(NULL);

    delete mCollectionModel;

}

/*!

 Sets entry event.

 \param event entry event.

 */

void HsCollectionState::onEntry(QEvent *event)

{

    qDebug("HsCollectionState::onEntry()");

    HSMENUTEST_FUNC_ENTRY("HsCollectionState::onEntry");

    QState::onEntry(event);

    if (event->type() == HsMenuEvent::eventType()) {

        HsMenuEvent *menuEvent = static_cast<HsMenuEvent *>(event);

        QVariantMap data = menuEvent->data();

        mCollectionId = data.value(itemIdKey()).toInt();

        mCollectionType = data.value(entryTypeNameKey()).toString();

    }

    HSMENUTEST_FUNC_EXIT("HsCollectionState::onEntry");

}

/*!

 Slot invoked when a state is entered.

 */

void HsCollectionState::stateEntered()

{

    HSMENUTEST_FUNC_ENTRY("HsCollectionState::stateEntered");

    mMenuView.activate();

    if (!mCollectionModel) {

        mCollectionModel =

            HsMenuService::getCollectionModel(

                mCollectionId, mSortAttribute, mCollectionType);

    }

    mMenuView.setModel(mCollectionModel);

    mMenuView.listView()->scrollTo(

        mCollectionModel->index(0), HbAbstractItemView::PositionAtTop);

    mMenuView.viewLabel()->setHeading(

        mCollectionModel->root().data(Qt::DisplayRole).toString());

    if (!mOptions) {

        mOptions = new HbMenu();

        mOptions->addAction(hbTrId("txt_applib_opt_task_switcher"),

                            this,

                            SLOT(openTaskSwitcher()));

        EntryFlags flags =

            mCollectionModel->root().data(CaItemModel::FlagsRole).value<

            EntryFlags> ();

        if (flags & RemovableEntryFlag) {

            mOptions->addAction(hbTrId("txt_applib_opt_add_content"), this,

                                SLOT(addAppsAction()));

        }

        mOptions->addAction(hbTrId("txt_applib_opt_add_to_home_screen"),

                            this, SLOT(addCollectionShortcutToHomeScreenAction()));

        if (flags & RemovableEntryFlag) {

            mOptions->addAction(

                hbTrId("txt_common_opt_rename_item"),

                this,

                SLOT(renameAction()));

            mOptions->addAction(

                hbTrId("txt_common_opt_delete"),

                this,

                SLOT(deleteAction()));

        }

        if (mCollectionType == collectionDownloadedTypeName()) {

            HbMenu *sortMenu = mOptions->addMenu(

                                   hbTrId("txt_applib_opt_sort_by"));

            //Grouped options are exclusive by default.

            QActionGroup *sortGroup = new QActionGroup(mOptions);

            sortGroup->addAction(

                sortMenu->addAction(

                    hbTrId("txt_applib_opt_sort_by_sub_latest_on_top"),

                    this,

                    SLOT(latestOnTopMenuAction())));

            sortGroup->addAction(

                sortMenu->addAction(

                    hbTrId("txt_applib_opt_sort_by_sub_oldest_on_top"),

                    this,

                    SLOT(oldestOnTopMenuAction())));

            foreach(QAction *action, sortMenu->actions()) {

                action->setCheckable(true);

            }

            static const int defaultSortingPosition = 0;

            sortGroup->actions().at(defaultSortingPosition)->setChecked(true);

        }

        mOptions->setParent(this);

        mMenuView.view()->setMenu(mOptions);

    }

    HSMENUTEST_FUNC_EXIT("HsCollectionState::stateEntered");

}

/*!

 Slot invoked when a state is exited.

 */

void HsCollectionState::stateExited()

{

    HSMENUTEST_FUNC_ENTRY("HsCollectionState::stateExited");

    mMenuView.setSearchPanelVisible(false);

    mMenuView.inactivate();

    delete mCollectionModel;

    mCollectionModel = NULL;

    delete mOptions;

    mOptions = NULL;

    if (mContextMenu)

        mContextMenu->close();

    HSMENUTEST_FUNC_EXIT("HsCollectionState::stateExited");

    qDebug("CollectionState::stateExited()");

}

/*!

 Perform all signal connections.

 */

void HsCollectionState::makeConnect()

{

    connect(mSecondarySoftkeyAction, SIGNAL(triggered()),

            SLOT(backSteppingAction()));

    connect(&mMenuView,

            SIGNAL(activated(QModelIndex)),

            SLOT(listItemActivated(QModelIndex)));

    connect(&mMenuView,

            SIGNAL(longPressed(HbAbstractViewItem *, QPointF)),

            SLOT(listItemLongPressed(HbAbstractViewItem *, QPointF)));

}

/*!

 Perform all signal disconnections.

 */

void HsCollectionState::makeDisconnect()

{

    disconnect(mSecondarySoftkeyAction, SIGNAL(triggered()),

               this, SLOT(backSteppingAction()));

    disconnect(&mMenuView,

               SIGNAL(activated(QModelIndex)),

               this, SLOT(listItemActivated(QModelIndex)));

    disconnect(&mMenuView,

               SIGNAL(longPressed(HbAbstractViewItem *, QPointF)),

               this, SLOT(listItemLongPressed(HbAbstractViewItem *, QPointF)));

}

/*!

 Open task switcher.

 \retval true if operation is successful.

 */

bool HsCollectionState::openTaskSwitcher()

{

    return HsMenuService::launchTaskSwitcher();

}

/*!

 Slot connected to List widget.

 \param index Model index of the activated item.

 */

void HsCollectionState::listItemActivated(const QModelIndex &index)

{

    HSMENUTEST_FUNC_ENTRY("HsCollectionState::listItemActivated");

    QSharedPointer<const CaEntry> entry = mCollectionModel->entry(index);

    if (entry->entryTypeName() == widgetTypeName()) {

        machine()->postEvent(

            HsMenuEventFactory::createPreviewHSWidgetEvent(

                entry->id(), entry->entryTypeName(), entry->attribute(

                    widgetUriAttributeName()), entry->attribute(

                    widgetLibraryAttributeName())));

        const int itemId = index.data(CaItemModel::IdRole).toInt();

        HsMenuService::touch(itemId);

    } else {

        QVariant data = mCollectionModel->data(index, CaItemModel::IdRole);

        HsMenuService::executeAction(data.toInt());

    }

    mMenuView.setSearchPanelVisible(false);

    HSMENUTEST_FUNC_EXIT("HsCollectionState::listItemActivated");

}

/*!

 Handles long-item-pressed event in all apps view by showing context menu

 \param item the event pertains to

 \param coords press point coordinates.

 \retval void

 */

void HsCollectionState::listItemLongPressed(HbAbstractViewItem *item,

        const QPointF &coords)

{

    Q_UNUSED(item);

    HSMENUTEST_FUNC_ENTRY("HsCollectionState::listItemLongPressed");

    // create context menu

    mContextMenu = new HbMenu();

    HbAction *addShortcutAction = mContextMenu->addAction(hbTrId(

                                      "txt_applib_menu_add_to_home_screen"));

    addShortcutAction->setData(AddToHomeScreenContextAction);

    HbAction *addToCollection = mContextMenu->addAction(hbTrId(

                                    "txt_applib_menu_add_to_collection"));

    addToCollection->setData(AddToCollectionContextAction);

    HbAction *removeAction(NULL);

    HbAction *uninstallAction(NULL);

    HbAction *appSettingsAction(NULL);

    // we do not add remove option in locked collection

    // check conditions and hide irrelevant menu items

    EntryFlags rootFlags =

        mCollectionModel->root().data(CaItemModel::FlagsRole).value<

        EntryFlags> ();

    if (rootFlags & RemovableEntryFlag) {

        removeAction = mContextMenu->addAction(

                           hbTrId("txt_applib_menu_remove_from_collection"));

        removeAction->setData(RemoveFromCollectionContextAction);

    }

    EntryFlags flags = item->modelIndex().data(CaItemModel::FlagsRole).value<

                       EntryFlags> ();

    if ((flags & RemovableEntryFlag)) {

        uninstallAction = mContextMenu->addAction(hbTrId("txt_common_menu_delete"));

        uninstallAction->setData(UninstallContextAction);

    }

    QSharedPointer<const CaEntry> entry = mCollectionModel->entry(item->modelIndex());

    if (!(entry->attribute(appSettingsPlugin()).isEmpty())) {

        appSettingsAction = mContextMenu->addAction(hbTrId(

                                                "txt_common_menu_settings"));

        appSettingsAction->setData(AppSettingContextAction);

    }

    mContextModelIndex = item->modelIndex();

    mContextMenu->setPreferredPos(coords);

    mContextMenu->setAttribute(Qt::WA_DeleteOnClose);

    mContextMenu->open(this, SLOT(contextMenuAction(HbAction*)));

    HSMENUTEST_FUNC_EXIT("HsCollectionState::listItemLongPressed");

}

/*!

 Handles context menu actions

 */

void HsCollectionState::contextMenuAction(HbAction *action)

{

    HsContextAction command = 

        static_cast<HsContextAction>(action->data().toInt());

    const int itemId = mContextModelIndex.data(CaItemModel::IdRole).toInt();

    switch (command) {

        case AddToHomeScreenContextAction:

            addElementToHomeScreen(mContextModelIndex);

            break;

        case AddToCollectionContextAction:

            machine()->postEvent(

                HsMenuEventFactory::createAddAppsFromCallectionViewEvent(

                    mCollectionId, itemId, mCollectionsSortAttribute));

            break;

        case UninstallContextAction:

            HsMenuService::executeAction(itemId, removeActionIdentifier());

            break;

        case RemoveFromCollectionContextAction:

            machine()->postEvent(

                HsMenuEventFactory::createRemoveAppFromCollectionEvent(

                    itemId, mCollectionId));

            break;

        case AppSettingContextAction: 

            machine()->postEvent(

                HsMenuEventFactory::createAppSettingsViewEvent(itemId));

            break;

        default:

            break;

    }

    mMenuView.setSearchPanelVisible(false);

}

/*!

 Menu add applications action slot

 */

void HsCollectionState::addAppsAction()

{

    // Add applications

    machine()->postEvent(

        HsMenuEventFactory::createAddAppsFromCallectionViewEvent(

            mCollectionId));

}

/*!

 Menu add shortcut action slot

 */

void HsCollectionState::addCollectionShortcutToHomeScreenAction()

{

    machine()->postEvent(HsMenuEventFactory::createAddToHomeScreenEvent(

                             mCollectionId, mMenuMode.getHsMenuMode()));

}

/*!

 Menu rename action slot

 */

void HsCollectionState::renameAction()

{

    machine()->postEvent(HsMenuEventFactory::createRenameCollectionEvent(

                             mCollectionId));

}