/*

* 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:

* Definition file for NotesTodoEditor class.

*

*/

// System includes

#include <QDateTime>

#include <HbApplication>

#include <HbLineEdit>

#include <HbMainWindow>

#include <HbNotificationDialog>

#include <HbDataForm>

#include <HbDataFormModel>

#include <HbDataFormModelItem>

#include <HbDataFormViewItem>

#include <HbInstance>

#include <HbView>

#include <HbMenu>

#include <HbAction>

#include <HbComboBox>

#include <HbExtendedLocale>

#include <HbLabel>

#include <HbPushButton>

#include <HbCheckBox>

#include <HbDialog>

#include <HbGroupBox>

#include <HbMessageBox>

// User includes

#include "notestodoeditor.h"

#include "notestodoeditorcustomitem.h"

#include "noteseditor_p.h"

#include "noteseditorcommon.h"

#include "noteseditordocloader.h"

#include <agendaentry.h>

#include "OstTraceDefinitions.h"

#ifdef OST_TRACE_COMPILER_IN_USE

#include "notestodoeditorTraces.h"

#endif

// Constants

const int MaxRowsInTextItem(10);

const int MaxCharacterLimit(255);

/*!

	\class NotesTodoEditor

	This class is responsible for editing to-dos. This is friend of

	NotesEditorPrivate and it handles all the cases related to to-dos.

 */

/*!

	Default Constructor.

	\param owner Of type NotesEditorPrivate.

	\param parent The parent.

 */

NotesTodoEditor::NotesTodoEditor(

		NotesEditorPrivate* owner, QObject *parent)

:QObject(parent),

 mOwner(owner),

 mReminderEnabler(0),

 mReminderItem(0),

 mDescriptionItemIndex(5),

 mDiscardChangesActive(false)

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_NOTESTODOEDITOR_ENTRY );

	mDocLoader = new NotesEditorDocLoader;

	Q_ASSERT(mDocLoader);

	bool success;

	// Load the to-do editor docml file.

	mDocLoader->load(TODO_EDITOR_DOCML, &success);

	Q_ASSERT(success);

	// Now load the view and the contents.

	mEditor = static_cast<HbView *> (

			mDocLoader->findWidget(TODO_EDITOR_VIEW));

	Q_ASSERT(mEditor);

	mSubHeading = static_cast<HbGroupBox *> (

			mDocLoader->findWidget(TODO_EDITOR_SUB_HEADING));

	Q_ASSERT(mSubHeading);

	mDataForm = static_cast<HbDataForm *> (

			mDocLoader->findWidget(TODO_EDITOR_DATA_FORM));

	// Initialize the data form model.

	initFormModel();

	// Add menu actions.

	addMenu();

	// Add the custiom widget to the form.

	NotesTodoEditorCustomItem *customItem =

			new NotesTodoEditorCustomItem(mOwner, mDataForm);

	QList <HbAbstractViewItem*> prototypes = mDataForm->itemPrototypes();

	prototypes.append(customItem);

	mDataForm->setItemPrototypes(prototypes);

	OstTraceFunctionExit0( NOTESTODOEDITOR_NOTESTODOEDITOR_EXIT );

}

/*!

	Destructor.

 */

NotesTodoEditor::~NotesTodoEditor()

{

	OstTraceFunctionEntry0( DUP1_NOTESTODOEDITOR_NOTESTODOEDITOR_ENTRY );

	if (mFormModel) {

		delete mFormModel;

	}

	mDocLoader->reset();

	delete mDocLoader;

	OstTraceFunctionExit0( DUP1_NOTESTODOEDITOR_NOTESTODOEDITOR_EXIT );

}

/*!

	Updates the summary text, as entered by the user.

 */

void NotesTodoEditor::updateSummaryText(const QString &text)

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_UPDATESUMMARYTEXT_ENTRY );

	mOwner->mModifiedNote.setSummary(text);

	addDiscardChangesAction();

	OstTraceFunctionExit0( NOTESTODOEDITOR_UPDATESUMMARYTEXT_EXIT );

}

/*!

	 updates the priority of the to-do entry

	 \param index The index of the priority item selected by the user

 */

void NotesTodoEditor::updatePriority(int index)

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_UPDATEPRIORITY_ENTRY );

	mOwner->mModifiedNote.setPriority(index + 1);

	addDiscardChangesAction();

	OstTraceFunctionExit0( NOTESTODOEDITOR_UPDATEPRIORITY_EXIT );

}

/*!

	Updates the description of the to-do entry.

	\param text The description entered by the user.

 */

void NotesTodoEditor::updateDescription(const QString &text)

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_UPDATEDESCRIPTION_ENTRY );

	mOwner->mModifiedNote.setDescription(text);

	addDiscardChangesAction();

	OstTraceFunctionExit0( NOTESTODOEDITOR_UPDATEDESCRIPTION_EXIT );

}

/*!

	Check for the reminder field entered by the user.

	If reminder is not enabled it simply returns with true value.

	\return bool Sends the value after validation of alarm vlaue.

 */

bool NotesTodoEditor::validAlarmSet()

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_VALIDALARMSET_ENTRY );

	bool alarmSet(true);

	// Sanity Check.

	if (mReminderItem) {

		// Get the reminder dateandtime set by user from date and time picker.

		// Get the reminder date.

		QString entryAlarmTimeText =

				mReminderItem->contentWidgetData("alarmTime").toString();

		QTime entryAlarmTime;

		entryAlarmTime = entryAlarmTime.fromString(

				entryAlarmTimeText, mOwner->timeFormatString());

		// Get the reminder time.

		QString entryAlarmDateText =

				mReminderItem->contentWidgetData("alarmDate").toString();

		QDate entryAlarmDate;

		entryAlarmDate = entryAlarmDate.fromString(

				entryAlarmDateText, mOwner->dateFormatString());

		QDateTime entryAlarmDateTime;

		if (entryAlarmTime.isValid()) {

			entryAlarmDateTime.setDate(entryAlarmDate);

			entryAlarmDateTime.setTime(entryAlarmTime);

		}else {

			HbNotificationDialog::launchDialog(tr("Alarm time is not valid"));

			alarmSet = false;

			OstTraceFunctionExit0( NOTESTODOEDITOR_VALIDALARMSET_EXIT );

			return alarmSet;

		}

		// Get the to-do entry due date and time.

		// Get the due date.

		QString entryDueDateText =

				mDueDateItem->contentWidgetData("text").toString();

		QDate entryDueDate;

		entryDueDate = entryDueDate.fromString(

				entryDueDateText, mOwner->dateFormatString());

		// Time is considered as 12 am for todo entries.

		QTime entryDueTime (0, 0, 0);

		QDateTime entryDueDateTime;

		if (entryDueTime.isValid()) {

			entryDueDateTime.setDate(entryDueDate);

			entryDueDateTime.setTime(entryDueTime);

		}else {

			HbNotificationDialog::launchDialog(tr("Alarm date is not valid"));

			alarmSet = false;

			OstTraceFunctionExit0( DUP1_NOTESTODOEDITOR_VALIDALARMSET_EXIT );

			return alarmSet;

		}

		// Check whether alarm time doesn't exceed due date

		// nor should be less than current time.

		if (entryAlarmDateTime > entryDueDateTime.addDays(1)) {

			HbNotificationDialog::launchDialog(

				tr("Alarm is set for later than entry starts"));

			alarmSet = false;

		}else if (entryAlarmDateTime.date() < QDate::currentDate()) {

			// if alarm date is set before the current date

			HbNotificationDialog::launchDialog(tr("Alarm already passed"));

			alarmSet = false;

		} else if( (entryAlarmDateTime.date() == QDate::currentDate()) &&

				entryAlarmDateTime.time() < QTime::currentTime() ) {

			// if alarm date is current date and alarm time is set before the

			// current time

			HbNotificationDialog::launchDialog(tr("Alarm already passed"));

			alarmSet = false;

		}else {

			uint entryDueTimeinSec = entryDueDateTime.toTime_t();

			uint entryAlarmTimeinSec = entryAlarmDateTime.toTime_t();

			int32_t diffinSec = entryDueTimeinSec - entryAlarmTimeinSec;

			AgendaAlarm newAlarm;

			newAlarm.setTimeOffset(diffinSec / 60);

			mOwner->mModifiedNote.setAlarm(newAlarm);

			alarmSet = true;

		}

	} else {

		AgendaAlarm dummyAlarm;

		mOwner->mModifiedNote.setAlarm(dummyAlarm);

		OstTraceFunctionExit0( DUP2_NOTESTODOEDITOR_VALIDALARMSET_EXIT );

		return alarmSet;

	}

	OstTraceFunctionExit0( DUP3_NOTESTODOEDITOR_VALIDALARMSET_EXIT );

	return alarmSet;

}

/*!

	Adds discard changes option item to the menu

 */

void NotesTodoEditor::addDiscardChangesAction()

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_ADDDISCARDCHANGESACTION_ENTRY );

	if(!mDiscardChangesActive) {

		mDiscardAction = new HbAction(hbTrId("txt_notes_opt_discard_changes"));

		mEditor->menu()->addAction(mDiscardAction);

		connect(

				mDiscardAction, SIGNAL(triggered()),

				this, SLOT(handleDiscardChangesAction()));

		mDiscardChangesActive = true;

	}

	OstTraceFunctionExit0( NOTESTODOEDITOR_ADDDISCARDCHANGESACTION_EXIT );

}

/*!

	Displays the to-do editor and populates the data with the given AgendaEntry.

	\param entry The entry from which data has to be read.

 */

void NotesTodoEditor::execute(AgendaEntry entry)

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_EXECUTE_ENTRY );

	HbMenu *viewMenu = mEditor->menu();

	if (!mDescriptionAction) {

		mDescriptionAction = new HbAction;

	}

	// Update the description menu item

	if (entry.description().length()) {

		// Insert description item

		insertDescriptionItem();

		mDescriptionAction->setText(hbTrId("txt_notes_opt_remove_description"));

		viewMenu->addAction(mDescriptionAction);

		connect(

				mDescriptionAction, SIGNAL(triggered()),

				this, SLOT(handleRemoveDescriptionAction()));

	} else {

		mDescriptionAction->setText(hbTrId("txt_notes_opt_add_description"));

		viewMenu->addAction(mDescriptionAction);

		connect(

				mDescriptionAction, SIGNAL(triggered()),

				this, SLOT(handleAddDescriptionAction()));

	}

	// Update the sub heading based on the new /existing entry

	if (mOwner->mNewEntry) {

		mSubHeading->setHeading(hbTrId("txt_notes_subhead_new_todo"));

	} else {

		mSubHeading->setHeading(hbTrId("txt_notes_subhead_todo"));

	}

	// Store the current view and set our view as the current view.

	HbMainWindow *window = hbInstance->allMainWindows().first();

	HbAction *action = new HbAction(Hb::BackNaviAction);

	mEditor->setNavigationAction(action);

	connect(

			action, SIGNAL(triggered()),

			this, SLOT(saveTodo()));

	window->addView(mEditor);

	window->setCurrentView(mEditor);

	OstTraceFunctionExit0( NOTESTODOEDITOR_EXECUTE_EXIT );

}

/*!

	Displays the to-do editor for creating new to-do entry

	\param entry The entry from which data has to be read.

 */

void NotesTodoEditor::create(AgendaEntry entry)

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_CREATE_ENTRY );

	Q_UNUSED(entry)

	OstTraceFunctionExit0( NOTESTODOEDITOR_CREATE_EXIT );

}

/*!

	Initializes the data form model.

 */

void NotesTodoEditor::initFormModel()

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_INITFORMMODEL_ENTRY );

	// Delete the model if already there.

	if (mFormModel) {

		delete mFormModel;

		mDataForm->setModel(0);

	}

	// Construct the form model.

	mFormModel = new HbDataFormModel(this);

	// Add items to the model.

	insertSubjectItem();

	insertDueDateItem();

	insertReminderToggle();

	// Need to display reminderitem while editing a ToDo entry having alarm.

	if (!mOwner->mModifiedNote.alarm().isNull()) {

		handleReminderItem(Qt::Checked);

	}

	insertPriorityItem();

	// Set the model to the form.

	mDataForm->setModel(mFormModel);

	OstTraceFunctionExit0( NOTESTODOEDITOR_INITFORMMODEL_EXIT );

}

/*!

	Inserts the subject item into the model.

 */

void NotesTodoEditor::insertSubjectItem()

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_INSERTSUBJECTITEM_ENTRY );

	mSubjectItem = mFormModel->appendDataFormItem(

			HbDataFormModelItem::TextItem,

			QString(""), mFormModel->invisibleRootItem());

	mSubjectItem->setContentWidgetData("text", mOwner->mModifiedNote.summary());

	mSubjectItem->setContentWidgetData("maxRows", MaxRowsInTextItem);

	mSubjectItem->setContentWidgetData("maxLength", MaxCharacterLimit);

	mSubjectItem->setContentWidgetData("objectName", "subjectItem");

	mDataForm->addConnection(

			mSubjectItem , SIGNAL(textChanged(const QString &)),

			this, SLOT(updateSummaryText(const QString &)));

	OstTraceFunctionExit0( NOTESTODOEDITOR_INSERTSUBJECTITEM_EXIT );

}

/*!

	Inserts the due date item into the model.

 */

void NotesTodoEditor::insertDueDateItem()

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_INSERTDUEDATEITEM_ENTRY );

	HbDataFormModelItem::DataItemType itemType =

			static_cast<HbDataFormModelItem::DataItemType>

			(HbDataFormModelItem::CustomItemBase + DueDateItemOffset);

	mDueDateItem = mFormModel->appendDataFormItem(

			itemType, hbTrId("txt_notes_formlabel_due_date"),

			mFormModel->invisibleRootItem());

	QString dueDateText;

	if (mOwner->mModifiedNote.endTime().isNull()) {

		// Set the current date.

		dueDateText = QDate::currentDate().toString(

				mOwner->dateFormatString());

	} else {

		// Read the due date from agenda entry

		dueDateText =

			mOwner->mModifiedNote.endTime().date().toString(

					mOwner->dateFormatString());

	}

	mDueDateItem->setContentWidgetData("text",dueDateText);

	OstTraceFunctionExit0( NOTESTODOEDITOR_INSERTDUEDATEITEM_EXIT );

}

/*!

	 Inserts the reminder enabler item into the model.

 */

void NotesTodoEditor::insertReminderToggle()

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_INSERTREMINDERTOGGLE_ENTRY );

	mReminderEnabler = mFormModel->appendDataFormItem(

			HbDataFormModelItem::CheckBoxItem,

			tr(""), mFormModel->invisibleRootItem());

	mReminderEnabler->setContentWidgetData(

			QString("text"), QString(hbTrId("txt_notes_formlabel_alarm")));

	if (!mOwner->mModifiedNote.alarm().isNull()) {

		mReminderEnabler->setContentWidgetData("checkState",Qt::Checked);

	} else {

		mReminderEnabler->setContentWidgetData("checkState",Qt::Unchecked);

	}

	mReminderEnabler->setContentWidgetData("objectName", "remainderToggleItem");

	mDataForm->addConnection(

			mReminderEnabler, SIGNAL(stateChanged(int)),

			this, SLOT(handleReminderItem(int)));

	OstTraceFunctionExit0( NOTESTODOEDITOR_INSERTREMINDERTOGGLE_EXIT );

}

/*!

	Handle insertion/deletion of reminder item in todo editor.

 */

void NotesTodoEditor::handleReminderItem(int checked)

{

	OstTraceFunctionEntry0( NOTESTODOEDITOR_HANDLEREMINDERITEM_ENTRY );

	if (Qt::Checked == checked) {

		HbDataFormModelItem::DataItemType itemType =

			static_cast<HbDataFormModelItem::DataItemType>

		(HbDataFormModelItem::CustomItemBase + AlarmDateItemOffset);

		mReminderItem = mFormModel->insertDataFormItem(

				3,itemType,hbTrId("txt_notes_formlabel_alarm_date_and_time"));

		// Set alarm time to the buttton.

		QString alarmTimeText;

		if (mOwner->mModifiedNote.alarm().isNull()) {

			QTime alarmTime(8, 0, 0, 0);

			// Below statement can be used to format the string but there is no

			// reverse way meaning from "text to time" found to do this..

			alarmTimeText =

					alarmTime.toString(

							mOwner->timeFormatString());

		} else {

			int32_t timeOffsetInSec =

					mOwner->mModifiedNote.alarm().timeOffset() * 60;

			uint reminderTimeinSec =

					mOwner->mModifiedNote.endTime().toTime_t()- timeOffsetInSec;

			QDateTime reminderTime;

			reminderTime.setTime_t(reminderTimeinSec);

			alarmTimeText =

					reminderTime.time().toString(

							mOwner->timeFormatString());

		}

		mReminderItem->setContentWidgetData(

				"alarmTime",alarmTimeText);

		// Set alarm date to the buttton.

		QString alarmDateText;

		// Value is set based on convertion of a note to ToDo editor

		// or editing a ToDo editor(having alarm set) for time picker.

		if (mOwner->mModifiedNote.alarm().isNull()) {

			alarmDateText =

					mOwner->mModifiedNote.endTime().date().toString(

							mOwner->dateFormatString());

		} else {

			int64_t offsetInSec =

					mOwner->mModifiedNote.alarm().timeOffset()* 60;

			uint reminderTimeinSec =

					mOwner->mModifiedNote.endTime().toTime_t()- offsetInSec;

			QDateTime reminderTime;

			reminderTime.setTime_t(reminderTimeinSec);

			alarmDateText = reminderTime.date().toString(

					mOwner->dateFormatString());

		}

		mReminderItem->setContentWidgetData("alarmDate", alarmDateText);

		// Add discardChanges Action if reminder field is modified

		addDiscardChangesAction();

	} else if(Qt::Unchecked == checked) {

		if (mReminderItem) {

			mFormModel->removeItem(mReminderItem);