
///////////////////////////////////////////////////////////
//                                                       //
//                         SAGA                          //
//                                                       //
//      System for Automated Geoscientific Analyses      //
//                                                       //
//                    User Interface                     //
//                                                       //
//                    Program: SAGA                      //
//                                                       //
//-------------------------------------------------------//
//                                                       //
//                  wksp_data_item.cpp                   //
//                                                       //
//          Copyright (C) 2013 by Olaf Conrad            //
//                                                       //
//-------------------------------------------------------//
//                                                       //
// This file is part of 'SAGA - System for Automated     //
// Geoscientific Analyses'. SAGA 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 2 of the     //
// License, or (at your option) any later version.       //
//                                                       //
// SAGA 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/>.                       //
//                                                       //
//-------------------------------------------------------//
//                                                       //
//    contact:    Olaf Conrad                            //
//                Institute of Geography                 //
//                University of Hamburg                  //
//                Germany                                //
//                                                       //
//    e-mail:     oconrad@saga-gis.org                   //
//                                                       //
///////////////////////////////////////////////////////////

//---------------------------------------------------------
#include "res_commands.h"
#include "res_dialogs.h"

#include "saga_frame.h"

#include "helper.h"

#include "active.h"
#include "active_parameters.h"

#include "wksp_base_control.h"

#include "wksp_data_manager.h"
#include "wksp_data_menu_files.h"

#include "wksp_map_manager.h"
#include "wksp_map.h"
#include "wksp_map_layer.h"

#include "wksp_data_manager.h"
#include "wksp_data_layers.h"
#include "wksp_data_item.h"

#include "view_histogram.h"
#include "view_scatterplot.h"

#include "data_source_pgsql.h"


///////////////////////////////////////////////////////////
//                                                       //
//                                                       //
//                                                       //
///////////////////////////////////////////////////////////

//---------------------------------------------------------
CWKSP_Data_Item::CWKSP_Data_Item(CSG_Data_Object *pObject)
{
	m_pObject = pObject; m_Updating = 0;
}

//---------------------------------------------------------
CWKSP_Data_Item::~CWKSP_Data_Item(void)
{
	CSG_Data_Object	*pObject = m_pObject; m_pObject = NULL;

	//-----------------------------------------------------
	for(int i=m_Views.GetCount()-1; i>=0; i--)
	{
		((CVIEW_Base *)m_Views[i])->Do_Destroy();
	}

	//-----------------------------------------------------
	if( pObject )
	{
		MSG_General_Add(wxString::Format("%s: %s...", _TL("Closing"), pObject->Get_Name()), true, true);

		g_pData->On_Data_Deletion(pObject);

		SG_Get_Data_Manager().Delete(pObject);

		MSG_General_Add(_TL("okay"), false, false, SG_UI_MSG_STYLE_SUCCESS);
	}
}

//---------------------------------------------------------
bool CWKSP_Data_Item::On_Data_Deletion(CSG_Data_Object *pObject)
{
	return( m_pObject && m_pObject != pObject ? CWKSP_Base_Item::On_Data_Deletion(pObject) : false );
}


///////////////////////////////////////////////////////////
//                                                       //
///////////////////////////////////////////////////////////

//---------------------------------------------------------
void Add_Metadata2Parameters(const CSG_MetaData &M, CSG_Parameters &P, CSG_Parameter *pParent = NULL)
{
	for(int i=0; i<M.Get_Children_Count(); i++)
	{
		CSG_String	Properties;

		for(int j=0; j<M[i].Get_Property_Count(); j++)
		{
			if( j > 0 )	Properties	+= "\n";

			Properties	+= M[i].Get_Property_Name(j) + ": " + M[i].Get_Property(j);
		}

		if( M[i].Get_Children_Count() > 0 )
		{
			Add_Metadata2Parameters(M[i], P, P.Add_Node(pParent, SG_Get_String(P.Get_Count()), M[i].Get_Name(), Properties));
		}
		else if( M[i].Get_Content().is_Empty() )
		{
			P.Add_Info_String(pParent, SG_Get_String(P.Get_Count()), M[i].Get_Name(), Properties, Properties);
		}
		else
		{
			P.Add_Info_String(pParent, SG_Get_String(P.Get_Count()), M[i].Get_Name(), Properties, M[i].Get_Content());
		}
	}
}

//---------------------------------------------------------
bool CWKSP_Data_Item::On_Command(int Cmd_ID)
{
	switch( Cmd_ID )
	{
	default: return( CWKSP_Base_Item::On_Command(Cmd_ID) );

	case ID_CMD_DATA_FORCE_UPDATE : Force_Update (); break;
	case ID_CMD_DATA_SETTINGS_LOAD: Load_Settings(); break;
	case ID_CMD_DATA_SETTINGS_COPY: Copy_Settings(); break;

	case ID_CMD_DATA_RELOAD       : if( m_pObject->Reload() ) { DataObject_Changed(); } break;
	case ID_CMD_DATA_DEL_FILES    : if( m_pObject->Delete() ) { g_pActive->Update_Description(); } break;

	case ID_CMD_DATA_SAVE         : Save(m_pObject->Get_File_Name()); break;
	case ID_CMD_DATA_SAVEAS       : Save(); break;
	case ID_CMD_DATA_SAVETODB     :
		switch( Get_Type() )
		{
		case WKSP_ITEM_Table      : PGSQL_Save_Table ((CSG_Table  *)m_pObject);	break;
		case WKSP_ITEM_Shapes     : PGSQL_Save_Shapes((CSG_Shapes *)m_pObject);	break;
		case WKSP_ITEM_Grid       : PGSQL_Save_Grid  ((CSG_Grid   *)m_pObject);	break;
		case WKSP_ITEM_Grids      : PGSQL_Save_Grids ((CSG_Grids  *)m_pObject);	break;
		default                   : break;
		}
		break;

	case ID_CMD_DATA_METADATA     :
		if( m_pObject->Get_MetaData().Get_Children_Count() > 0 )
		{
			CSG_Parameters P; Add_Metadata2Parameters(m_pObject->Get_MetaData(), P);

			DLG_Parameters(&P, wxString::Format("%s [%s]", _TL("View Metadata"), m_pObject->Get_Name()));
		}
		break;
	}

	return( true );
}

//---------------------------------------------------------
bool CWKSP_Data_Item::On_Command_UI(wxUpdateUIEvent &event)
{
	switch( event.GetId() )
	{
	default: return( CWKSP_Base_Item::On_Command_UI(event) );

	case ID_CMD_DATA_SAVE      : event.Enable(m_pObject->is_Modified() && m_pObject->Get_File_Name() && *(m_pObject->Get_File_Name())); break;
	case ID_CMD_DATA_SAVETODB  : event.Enable(PGSQL_has_Connections()); break;
	case ID_CMD_DATA_RELOAD    : event.Enable(m_pObject->is_Modified() && SG_File_Exists(m_pObject->Get_File_Name(false))); break;
	case ID_CMD_DATA_DEL_FILES : event.Enable(m_pObject->is_File_Native() && SG_File_Exists(m_pObject->Get_File_Name()) ); break;
	}

	return( true );
}


///////////////////////////////////////////////////////////
//                                                       //
///////////////////////////////////////////////////////////

//---------------------------------------------------------
wxString CWKSP_Data_Item::Get_Name(void)
{
	wxString Name("###");

	if( m_pObject && *m_pObject->Get_Name() )
	{
		Name = m_pObject->Get_Name();
	}

	int Numbering = g_pData->Get_Parameter("NUMBERING")->asInt();

	if( Numbering ==  0 ) { return( Name ); }
	if( Numbering  >  1 ) { return( wxString::Format( "%*d. %s",  Numbering, 1 + Get_ID(), Name.c_str()) ); }
	if( Numbering  < -1 ) { return( wxString::Format("%0*d. %s", -Numbering, 1 + Get_ID(), Name.c_str()) ); }

	return( wxString::Format("%d. %s", 1 + Get_ID(), Name.c_str()) );
}


///////////////////////////////////////////////////////////
//                                                       //
///////////////////////////////////////////////////////////

//---------------------------------------------------------
void CWKSP_Data_Item::On_Create_Parameters(void)
{
	CWKSP_Base_Item::On_Create_Parameters();

	//-----------------------------------------------------
	// General...

	m_Parameters.Add_Node("", "NODE_GENERAL", _TL("General"), _TL(""));

	if( g_pData->Get_Parameter("NAME_BY_FILE")->asBool() && *m_pObject->Get_File_Name() )
	{
		CSG_String Name(SG_File_Get_Name(m_pObject->Get_File_Name(), false));

		if( !Name.is_Empty() )
		{
			m_pObject->Set_Name(Name);
		}
	}

	m_Parameters.Add_String("NODE_GENERAL",
		"OBJECT_NAME"  , _TL("Name"),
		_TL(""),
		m_pObject->Get_Name()
	);

	m_Parameters.Add_String("NODE_GENERAL",
		"OBJECT_DESC"  , _TL("Description"),
		_TL(""),
		m_pObject->Get_Description(), true
	);

	//-----------------------------------------------------
	// Values...

	m_Parameters.Add_Node("", "NODE_VALUES", _TL("Values"), _TL(""));

	m_Parameters.Add_Double("NODE_VALUES",
		"MAX_SAMPLES"       , _TL("Sample Size"), m_pObject->asTable(true)
		? _TL("Maximum number of samples used to build statistics and histograms expressed as percentage of the total number of records.")
		: _TL("Maximum number of samples used to build statistics and histograms expressed as percentage of the total number of cells."  ),
		100., 0., true, 100., true
	);

	m_Parameters.Add_Range ("NODE_VALUES",
		"OBJECT_NODATA", _TL("Data Exclusion"),
		_TL("The no-data value range to be used for data exclusion.")
	);

	if( m_pObject->asTable(true) )
	{
		m_Parameters.Add_Choice("NODE_VALUES",
			"TABLE_FLT_STYLE"   , _TL("Floating Point Numbers"),
			_TL("Specify floating point decimal precision in table and similar views."),
			CSG_String::Format("%s|%s|%s",
				_TL("system default"),
				_TL("compact"),
				_TL("fix number of decimals")
			), g_pData->Get_Parameter("TABLE_FLT_STYLE")->asInt()
		);

		m_Parameters.Add_Int("TABLE_FLT_STYLE",
			"TABLE_FLT_DECIMALS", _TL("Decimals"),
			_TL(""),
			g_pData->Get_Parameter("TABLE_FLT_DECIMALS")->asInt(), 0, true
		);
	}
}


///////////////////////////////////////////////////////////
//                                                       //
///////////////////////////////////////////////////////////

//---------------------------------------------------------
bool CWKSP_Data_Item::Save(void)
{
	int idDlg;

	switch( Get_Type() )
	{
	case WKSP_ITEM_Table     : idDlg = ID_DLG_TABLE_SAVE     ; break;
	case WKSP_ITEM_TIN       : idDlg = ID_DLG_SHAPES_SAVE    ; break;
	case WKSP_ITEM_Shapes    : idDlg = ID_DLG_SHAPES_SAVE    ; break;
	case WKSP_ITEM_PointCloud: idDlg = ID_DLG_POINTCLOUD_SAVE; break;
	case WKSP_ITEM_Grid      : idDlg = ID_DLG_GRID_SAVE      ; break;
	case WKSP_ITEM_Grids     : idDlg = ID_DLG_GRIDS_SAVE     ; break;
	default                  : return( false );
	}

	wxString FileName = m_pObject->Get_File_Name() && *m_pObject->Get_File_Name()
		? m_pObject->Get_File_Name()
		: m_pObject->Get_Name();

	if( DLG_Save(FileName, idDlg) )
	{
		if( m_pObject->asTable() )
		{
			return( m_pObject->asTable()->Save(&FileName, 0, '\0', g_pData->Get_Parameter("TABLE_ENCODING")->asInt()) );
		}

		return( m_pObject->Save(&FileName) );
	}

	return( false );
}

//---------------------------------------------------------
bool CWKSP_Data_Item::Save(const wxString &File_Name)
{
	if( File_Name.Length() )
	{
		bool	bResult	= m_pObject->Save(&File_Name);

		if( bResult )
		{
			g_pData->Get_Menu_Files()->Recent_Add(CWKSP_Data_Menu_File::Recent_Type::Data, m_pObject->Get_File_Name());
		}

		PROCESS_Set_Okay();

		return( bResult );
	}

	return( Save() );
}


///////////////////////////////////////////////////////////
//                                                       //
///////////////////////////////////////////////////////////

//---------------------------------------------------------
int CWKSP_Data_Item::On_Parameter_Changed(CSG_Parameters *pParameters, CSG_Parameter *pParameter, int Flags)
{
	if( Flags & PARAMETER_CHECK_ENABLE )
	{
		if( pParameter->Cmp_Identifier("TABLE_FLT_STYLE") )
		{
			pParameters->Set_Enabled("TABLE_FLT_DECIMALS", pParameter->asInt() == 2); // fix number of decimals
		}
	}

	return( CWKSP_Base_Item::On_Parameter_Changed(pParameters, pParameter, Flags) );
}


///////////////////////////////////////////////////////////
//                                                       //
///////////////////////////////////////////////////////////

//---------------------------------------------------------
void CWKSP_Data_Item::Parameters_Changed(void)
{
	if( m_Updating == 0 )
	{
		m_Updating++;

		On_Parameters_Changed();

		CWKSP_Base_Item::Parameters_Changed();

		m_Updating--;

		Update_Views(true);
	}
}

//---------------------------------------------------------
void CWKSP_Data_Item::On_Parameters_Changed(void)
{
	m_pObject->Set_Name              (m_Parameters["OBJECT_NAME"      ].asString());
	m_pObject->Set_Description       (m_Parameters["OBJECT_DESC"      ].asString());
	m_pObject->Set_NoData_Value_Range(m_Parameters["OBJECT_NODATA.MIN"].asDouble(),
	                                  m_Parameters["OBJECT_NODATA.MAX"].asDouble());

	//-----------------------------------------------------
	sLong nElements = m_pObject->asTable(true) ? m_pObject->asTable(true)->Get_Count() : m_pObject->asGrid() ? m_pObject->asGrid()->Get_NCells() : m_pObject->asGrids() ? m_pObject->asGrids()->Get_NCells() : 0L;

	if( nElements > 0 )
	{
		m_pObject->Set_Max_Samples((sLong)((double)nElements * m_Parameters["MAX_SAMPLES"].asDouble() / 100.));
	}
}

//---------------------------------------------------------
bool CWKSP_Data_Item::DataObject_Changed(void)
{
	m_Parameters.Set_Name(m_pObject->Get_Name());

	m_Parameters.Set_Parameter("OBJECT_NAME"      , m_pObject->Get_Name             ());
	m_Parameters.Set_Parameter("OBJECT_DESC"      , m_pObject->Get_Description      ());
	m_Parameters.Set_Parameter("OBJECT_NODATA.MIN", m_pObject->Get_NoData_Value(false));
	m_Parameters.Set_Parameter("OBJECT_NODATA.MAX", m_pObject->Get_NoData_Value(true ));

	//-----------------------------------------------------
	sLong nElements = m_pObject->asTable(true) ? m_pObject->asTable(true)->Get_Count() : m_pObject->asGrid() ? m_pObject->asGrid()->Get_NCells() : m_pObject->asGrids() ? m_pObject->asGrids()->Get_NCells() : 0L;

	if( nElements > 0 )
	{
		m_Parameters["MAX_SAMPLES"].Set_Value(nElements <= m_pObject->Get_Max_Samples() ? 100. : 100. * (double)m_pObject->Get_Max_Samples() / (double)nElements);
	}

	//-----------------------------------------------------
	On_DataObject_Changed();

	g_pActive->Update_Item(this, false);

	Parameters_Changed();

	return( true );
}

//---------------------------------------------------------
void CWKSP_Data_Item::On_DataObject_Changed(void)
{
	// nop
}


///////////////////////////////////////////////////////////
//                                                       //
///////////////////////////////////////////////////////////

//---------------------------------------------------------
bool CWKSP_Data_Item::Add_ScatterPlot(void)
{
	new CVIEW_ScatterPlot(this);

	return( true );
}


///////////////////////////////////////////////////////////
//                                                       //
///////////////////////////////////////////////////////////

//---------------------------------------------------------
bool CWKSP_Data_Item::View_Opened(MDI_ChildFrame *pView)
{
	if( m_Views.Index(pView) == wxNOT_FOUND )	// only add once
	{
		m_Views.Add(pView);

		return( true );
	}

	return( false );
}

//---------------------------------------------------------
bool CWKSP_Data_Item::View_Closes(MDI_ChildFrame *pView)
{
	if( m_Views.Index(pView) != wxNOT_FOUND )
	{
		m_Views.Remove(pView);

		return( true );
	}

	return( false );
}

//---------------------------------------------------------
bool CWKSP_Data_Item::Update_Views(bool bAll)
{
	if( m_Updating == 0 )
	{
		m_Updating++;

		On_Update_Views(bAll);

		if( bAll )
		{
			for(size_t i=0; i<m_Views.Count(); i++)
			{
				((CVIEW_Base *)m_Views[i])->Do_Update();
			}
		}

		if( g_pActive->Get_Active_Data_Item() == this )
		{
			g_pActive->Update_Description();
			g_pActive->Update_Attributes ();
			g_pActive->Update_Info       ();
		}

		m_Updating--;

		return( true );
	}

	return( false );
}


///////////////////////////////////////////////////////////
//                                                       //
///////////////////////////////////////////////////////////

//---------------------------------------------------------
bool CWKSP_Data_Item::Force_Update(void)
{
    SG_UI_Process_Set_Busy(true);//, CSG_String::Format("%s: %s...", _TL("Updating"), Get_Name()));

	m_pObject->Update(true);
	
    SG_UI_Process_Set_Busy(false);
    
    DataObject_Changed();

	return( true );
}

//---------------------------------------------------------
bool CWKSP_Data_Item::Load_Settings(const CSG_MetaData &Data)
{
	if( Get_Parameters()->Load(Data) )
	{
		Parameters_Changed();

		return( true );
	}

	return( false );
}

bool CWKSP_Data_Item::Load_Settings(void)
{
	wxString File; CSG_MetaData Data;

	return( DLG_Open(File, ID_DLG_PARAMETERS_OPEN) && Data.Load(&File) && Load_Settings(Data) );
}

//---------------------------------------------------------
bool CWKSP_Data_Item::Copy_Settings(CSG_Parameters *pParameters)
{
	if( pParameters && pParameters != Get_Parameters() )
	{
		for(int i=0; i<pParameters->Get_Count(); i++)
		{
			CSG_Parameter *pSource = pParameters->Get_Parameter(i);

			if( !pSource->Cmp_Identifier("OBJECT_NAME"    )
			&&  !pSource->Cmp_Identifier("OBJECT_DESC"    )
			&&  !pSource->Cmp_Identifier("OBJECT_NODATA"  )
			&&  !pSource->Cmp_Identifier("OBJECT_Z_UNIT"  )
			&&  !pSource->Cmp_Identifier("OBJECT_Z_FACTOR")
			&&  !pSource->Cmp_Identifier("OBJECT_Z_OFFSET")
			&&  !pSource->Cmp_Identifier("MAX_SAMPLES"    )
			&&  !pSource->Cmp_Identifier("FILE_CACHE"     ) )
			{
				CSG_Parameter *pTarget = Get_Parameter(pSource->Get_Identifier());

				if( pTarget && pTarget->Get_Type() == pSource->Get_Type() )
				{
					if( pSource->Get_Type() == PARAMETER_TYPE_Choice || pSource->Get_Type() == PARAMETER_TYPE_Data_Type )
					{
						pTarget->Set_Value(pSource->asString()); // only try to match feature attributes by name
					}
					else
					{
						pTarget->Set_Value(pSource);
					}
				}
			}
		}

		Parameters_Changed();

		return( true );
	}

	return( false );
}

bool CWKSP_Data_Item::Copy_Settings(void)
{
	return( Copy_Settings(CWKSP_Data_Manager::Get_Settings_Dialog()) );
}


///////////////////////////////////////////////////////////
//                                                       //
//                                                       //
//                                                       //
///////////////////////////////////////////////////////////

//---------------------------------------------------------
