box_data_calendar_related.cc 19.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/* Glom
 *
 * Copyright (C) 2001-2004 Murray Cumming
 *
 * This program 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.
 *
 * This program 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, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

21 22 23
#include "box_data_calendar_related.h"
#include "dialog_layout_calendar_related.h"
#include <glom/application.h>
24 25 26 27 28 29 30 31
#include <glom/libglom/data_structure/glomconversions.h>
#include <glom/frame_glom.h> //For show_ok_dialog()
#include <bakery/App/App_Gtk.h> //For util_bold_message().
#include <glibmm/i18n.h>

namespace Glom
{

32
Box_Data_Calendar_Related::Box_Data_Calendar_Related()
33 34
: m_pMenuPopup(0),
  m_query_column_date_field(-1)
35 36 37
{
  set_size_request(400, -1); //An arbitrary default.

38 39 40 41
  remove(m_AddDel); //TODO: Don't even have this at all.
  m_Alignment.add(m_calendar);
  m_calendar.show();
  
42 43 44 45
  //m_calendar.set_show_details();
  m_calendar.set_detail_width_chars(7);
  m_calendar.set_detail_height_rows(2); 
  
46 47 48 49 50 51
  //Tell the calendar how to get the record details to show:
  m_calendar.set_detail_func( sigc::mem_fun(*this, &Box_Data_Calendar_Related::on_calendar_details) );
  
  setup_menu();
  //m_calendar.add_events(Gdk::BUTTON_PRESS_MASK); //Allow us to catch button_press_event and button_release_event
  m_calendar.signal_button_press_event().connect_notify( sigc::mem_fun(*this, &Box_Data_Calendar_Related::on_calendar_button_press_event) );
52

53
  m_layout_name = "list_related_calendar"; //TODO: We need a unique name when 2 portals use the same table.
54 55
}

56 57 58 59 60
Box_Data_Calendar_Related::~Box_Data_Calendar_Related()
{
  clear_cached_database_values();
}

61
void Box_Data_Calendar_Related::enable_buttons()
62
{
63 64
  //const bool view_details_possible = get_has_suitable_record_to_view_details();
  //m_calendar.set_allow_view_details(view_details_possible); //Don't allow the user to go to a record in a hidden table.
65 66
}

67
bool Box_Data_Calendar_Related::init_db_details(const sharedptr<const LayoutItem_CalendarPortal>& portal, bool show_title)
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
{
  m_portal = glom_sharedptr_clone(portal);

  LayoutWidgetBase::m_table_name = m_portal->get_table_used(Glib::ustring() /* parent table_name, not used. */); 
  Box_DB_Table::m_table_name = LayoutWidgetBase::m_table_name;

  const Glib::ustring relationship_title = m_portal->get_title_used(Glib::ustring() /* parent title - not relevant */);
  
  if(show_title)
  {
    m_Label.set_markup(Bakery::App_Gtk::util_bold_message(relationship_title));
    m_Label.show();

    m_Alignment.set_padding(Utils::DEFAULT_SPACING_SMALL /* top */, 0, Utils::DEFAULT_SPACING_LARGE /* left */, 0);
  }
  else
  {
    m_Label.set_markup(Glib::ustring());
    m_Label.hide();

    m_Alignment.set_padding(0, 0, 0, 0); //The box itself has padding of 6.
  }

  m_key_field = get_fields_for_table_one_field(LayoutWidgetBase::m_table_name, m_portal->get_to_field_used());

  enable_buttons();

  FoundSet found_set;
  found_set.m_table_name = LayoutWidgetBase::m_table_name;
  return Box_Data_List::init_db_details(found_set); //Calls create_layout() and fill_from_database().
}

100
bool Box_Data_Calendar_Related::fill_from_database()
101
{
102 103 104
  if(!m_portal)
    return false;
  
105 106 107 108 109 110 111 112 113 114 115 116 117 118
  bool result = false;

  if(m_key_field && m_found_set.m_where_clause.empty()) //There's a key field, but no value.
  {
    //No Foreign Key value, so just show the field names:

    result = Box_DB_Table::fill_from_database();

    //create_layout();

    fill_end();
  }
  else
  {
119 120 121 122 123 124 125 126 127 128 129 130
    if(m_query_column_date_field == -1)
      return false; //This is useless without the date in the result.
       
    //Create a date range from the beginning to end of the selected month:
    Glib::Date calendar_date;
    m_calendar.get_date(calendar_date);
    const Glib::Date date_start(1, calendar_date.get_month(), calendar_date.get_year());
    Glib::Date date_end = date_start;
    date_end.add_months(1);
    
    Gnome::Gda::Value date_start_value(date_start);
    Gnome::Gda::Value date_end_value(date_end);
131

132 133 134 135 136 137 138 139 140
    //Add a WHERE clause for this date range:
    sharedptr<Relationship> relationship = m_portal->get_relationship();
    Glib::ustring where_clause_to_table_name = relationship->get_to_table();
  
    sharedptr<LayoutItem_CalendarPortal> derived_portal = sharedptr<LayoutItem_CalendarPortal>::cast_dynamic(m_portal);
    const Glib::ustring date_field_name = derived_portal->get_date_field()->get_name();
    
    sharedptr<const Relationship> relationship_related = m_portal->get_related_relationship();
    if(relationship_related)
141
    {
142 143 144 145
      //Adjust the WHERE clause appropriately for the extra JOIN:
      sharedptr<UsesRelationship> uses_rel_temp = sharedptr<UsesRelationship>::create();
      uses_rel_temp->set_relationship(relationship);
      where_clause_to_table_name = uses_rel_temp->get_sql_join_alias_name();
146 147
    }

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
    //Add an AND to the existing where clause, to get only records within these dates, if any:
    sharedptr<const Field> date_field = derived_portal->get_date_field();
    const Glib::ustring extra_where_clause = "\"" + where_clause_to_table_name + "\".\"" + date_field->get_name() + "\""
      " BETWEEN DATE " + date_field->sql(date_start_value) + 
      " AND DATE " + date_field->sql(date_end_value);
    
    Glib::ustring where_clause;
    if(m_found_set.m_where_clause.empty())
      where_clause = extra_where_clause;
    else
      where_clause = "( " + m_found_set.m_where_clause + " ) AND ( " + extra_where_clause + " )";
    
    
    //Do one SQL query for the whole month and store the cached values here:
    clear_cached_database_values();
    
    const Glib::ustring sql_query = Utils::build_sql_select_with_where_clause(m_found_set.m_table_name, m_FieldsShown, where_clause, m_found_set.m_extra_join, m_found_set.m_sort_clause, m_found_set.m_extra_group_by);
    //std::cout << "DEBUG: sql_query=" << sql_query << std::endl;
    Glib::RefPtr<Gnome::Gda::DataModel> datamodel = query_execute(sql_query, get_app_window());
    if(!(datamodel))
      return true;
    
    const int rows_count = datamodel->get_n_rows();
    if(!(rows_count > 0))
      return true;
    
    //Get the data:
    for(int row_index = 0; row_index < rows_count; ++row_index)
    {
      const int columns_count = datamodel->get_n_columns();
      if(m_query_column_date_field > columns_count)
       continue;
       
      //Get the date value for this row:
      Gnome::Gda::Value value_date = datamodel->get_value_at(m_query_column_date_field, row_index);     
      const Glib::Date date = value_date.get_date();
      
      //Get all the values for this row:
      type_vector_values* pVector = new type_vector_values(m_FieldsShown.size());
      for(int column_index = 0; column_index < columns_count; ++column_index)
      {
        (*pVector)[column_index] = datamodel->get_value_at(column_index, row_index);
      }
      
      m_map_values[date].push_back(pVector);
    }
194 195
  }

196
 
197 198 199
  return result;
}

200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
void Box_Data_Calendar_Related::clear_cached_database_values()
{
  for(type_map_values::iterator iter = m_map_values.begin(); iter != m_map_values.end(); ++iter)
  {
    type_list_vectors vec = iter->second;
    for(type_list_vectors::iterator iter = vec.begin(); iter != vec.end(); ++iter)
    {
      type_vector_values* pValues = *iter;
      if(pValues)
        delete pValues;
    }
  }
  
  m_map_values.clear(); 
}
215
void Box_Data_Calendar_Related::on_record_added(const Gnome::Gda::Value& primary_key_value, const Gtk::TreeModel::iterator& row)
216 217 218 219 220 221 222 223 224 225 226 227 228 229
{
  //primary_key_value is a new autogenerated or human-entered key for the row.
  //It has already been added to the database.

  if(!row)
    return;

  Gnome::Gda::Value key_value;

  if(m_key_field)
  {
    //m_key_field is the field in this table that must match another field in the parent table.
    sharedptr<LayoutItem_Field> layout_item = sharedptr<LayoutItem_Field>::create();
    layout_item->set_full_field_details(m_key_field);
230
    //TODO: key_value = m_calendar.get_value(row, layout_item);
231 232 233 234 235 236 237 238 239 240 241 242 243 244
  }

  Box_Data_List::on_record_added(key_value, row); //adds blank row.

  //Make sure that the new related record is related,
  //by setting the foreign key:
  //If it's not auto-generated.
  if(!Conversions::value_is_empty(key_value)) //If there is already a value.
  {
    //It was auto-generated. Tell the parent about it, so it can make a link.
    signal_record_added.emit(key_value);
  }
  else if(Conversions::value_is_empty(m_key_value))
  {
245
    g_warning("Box_Data_Calendar_Related::on_record_added(): m_key_value is NULL.");
246 247 248
  }
  else
  {
249
    sharedptr<Field> field_primary_key; //TODO: = m_calendar.get_key_field();
250 251 252 253 254 255 256 257 258 259 260 261 262 263

    //Create the link by setting the foreign key
    if(m_key_field)
    {
      Glib::ustring strQuery = "UPDATE \"" + m_portal->get_table_used(Glib::ustring() /* not relevant */) + "\"";
      strQuery += " SET \"" +  /* get_table_name() + "." +*/ m_key_field->get_name() + "\" = " + m_key_field->sql(m_key_value);
      strQuery += " WHERE \"" + get_table_name() + "\".\"" + field_primary_key->get_name() + "\" = " + field_primary_key->sql(primary_key_value);
      const bool test = query_execute(strQuery, get_app_window());
      if(test)
      {
        //Show it on the view, if it's visible:
        sharedptr<LayoutItem_Field> layout_item = sharedptr<LayoutItem_Field>::create();
        layout_item->set_full_field_details(field_primary_key);

264
        //TODO: m_calendar.set_value(row, layout_item, m_key_value);
265 266 267 268 269 270 271
      }
    }

    //on_adddel_user_changed(row, iKey); //Update the database.
  }
}

272
void Box_Data_Calendar_Related::on_record_deleted(const Gnome::Gda::Value& /* primary_key_value */)
273 274 275 276 277
{
  //Allow the parent record (Details view) to recalculate aggregations:
  signal_record_changed().emit(m_portal->get_relationship_name());
}

278
Box_Data_Calendar_Related::type_vecLayoutFields Box_Data_Calendar_Related::get_fields_to_show() const
279
{
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
  type_vecLayoutFields layout_fields = Box_Data_Portal::get_fields_to_show();
  
  sharedptr<LayoutItem_CalendarPortal> derived_portal = sharedptr<LayoutItem_CalendarPortal>::cast_dynamic(m_portal);
  if(!derived_portal)
    return layout_fields;
  
  sharedptr<const Field> date_field = derived_portal->get_date_field();
  if(!date_field)
    return layout_fields;
  
  //Add it to the list to ensure that we request the date (though it will not really be shown in the calendar):
  sharedptr<LayoutItem_Field> layout_item_date_field = sharedptr<LayoutItem_Field>::create();
  layout_item_date_field->set_full_field_details(date_field);
  layout_fields.push_back(layout_item_date_field);
  m_query_column_date_field = layout_fields.size() - 1;
  return layout_fields;
296 297 298
}

#ifndef GLOM_ENABLE_CLIENT_ONLY
299
void Box_Data_Calendar_Related::on_dialog_layout_hide()
300
{
301
  Dialog_Layout_Calendar_Related* dialog_related = dynamic_cast<Dialog_Layout_Calendar_Related*>(m_pDialogLayout);
302 303
  g_assert(dialog_related != NULL);
  m_portal = dialog_related->get_portal_layout();
304 305 306


  //Update the UI:
307 308
  sharedptr<LayoutItem_CalendarPortal> derived_portal = sharedptr<LayoutItem_CalendarPortal>::cast_dynamic(m_portal);
  init_db_details(derived_portal); 
309 310 311

  Box_Data::on_dialog_layout_hide();

312
  sharedptr<LayoutItem_CalendarPortal> pLayoutItem = sharedptr<LayoutItem_CalendarPortal>::cast_dynamic(get_layout_item());
313 314
  if(pLayoutItem)
  {
315 316 317 318
    sharedptr<LayoutItem_CalendarPortal> derived_portal = sharedptr<LayoutItem_CalendarPortal>::cast_dynamic(m_portal);
    if(derived_portal)
      *pLayoutItem = *derived_portal;
    
319 320 321 322 323
    signal_layout_changed().emit(); //TODO: Check whether it has really changed.
  }
}
#endif // !GLOM_ENABLE_CLIENT_ONLY

324
Dialog_Layout* Box_Data_Calendar_Related::create_layout_dialog() const
325 326 327 328 329
{
#ifndef GLOM_ENABLE_CLIENT_ONLY
  Glib::RefPtr<Gnome::Glade::Xml> refXml = Gnome::Glade::Xml::create(GLOM_GLADEDIR "glom_developer.glade", "window_data_layout");
  if(refXml)
  {
330
    Dialog_Layout_Calendar_Related* dialog = 0;
331 332
    refXml->get_widget_derived("window_data_layout", dialog);
    return dialog;
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
  }
#endif // !GLOM_ENABLE_CLIENT_ONLY

  return NULL;
}

void Box_Data_Calendar_Related::prepare_layout_dialog(Dialog_Layout* dialog)
{
  Dialog_Layout_Calendar_Related* related_dialog = dynamic_cast<Dialog_Layout_Calendar_Related*>(dialog);
  g_assert(related_dialog != NULL);
  
  sharedptr<LayoutItem_CalendarPortal> derived_portal = sharedptr<LayoutItem_CalendarPortal>::cast_dynamic(m_portal);
  related_dialog->set_document(m_layout_name, get_document(), derived_portal);
}

Glib::ustring Box_Data_Calendar_Related::on_calendar_details(guint year, guint month, guint day)
{
  sharedptr<LayoutItem_CalendarPortal> derived_portal = sharedptr<LayoutItem_CalendarPortal>::cast_dynamic(m_portal);
351
  if(!derived_portal)
352 353 354 355 356
  {
    std::cout << "DEBUG: Box_Data_Calendar_Related::on_calendar_details(): date_field is NULL" << std::endl;
    return Glib::ustring();
  }
  
357 358 359 360
  sharedptr<const Field> date_field = derived_portal->get_date_field();
  if(!date_field)
    return Glib::ustring();
  
361 362
  Glib::Date date(day, Glib::Date::Month(month+1), year);
  
363 364 365 366 367
  //Examine the cached data:
  type_map_values::const_iterator iter_find = m_map_values.find(date);
  if(iter_find == m_map_values.end())
    return Glib::ustring(); //No data was found for this date.
  
368 369
  
  Glib::ustring result;
370 371 372 373
  
  //Look at each row for this date:
  const type_list_vectors& rows = iter_find->second;
  for(type_list_vectors::const_iterator iter = rows.begin(); iter != rows.end(); ++iter)
374
  {
375 376 377
    type_vector_values* pRow = *iter;
    if(!pRow)
      continue;
378
    
379 380 381
    //Get the data for each column in the row:
    Glib::ustring row_text;
    int column_index = 0;
382
    
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
    //We iterate over the original list of items from the portal,
    //instead of the ones used by the query (m_FieldsShown),
    //because we really don't want to show the extra fields (at the end) to the user:
    LayoutGroup::type_list_items items = m_portal->get_items();
    for(LayoutGroup::type_list_items::const_iterator iter = items.begin(); iter != items.end(); ++iter)
    {   
      sharedptr<const LayoutItem> layout_item = *iter;
      if(!layout_item)
        continue;
            
      Glib::ustring text;
      
      //Text for a text item:
      sharedptr<const LayoutItem_Text> layout_item_text = sharedptr<const LayoutItem_Text>::cast_dynamic(layout_item);
      if(layout_item_text)
        text = layout_item_text->get_text();
      else
400
      {
401 402 403 404
        //Text for a field:
        sharedptr<const LayoutItem_Field> layout_item_field = sharedptr<const LayoutItem_Field>::cast_dynamic(layout_item);
        
        const Gnome::Gda::Value value = (*pRow)[column_index];
405
        text = Conversions::get_text_for_gda_value(layout_item_field->get_glom_type(), value, layout_item_field->get_formatting_used().m_numeric_format);
406
        
407 408
        ++column_index;
      }
409 410 411 412 413 414 415 416 417
      
      //Add the field text to the row:
      if(!text.empty())
      {
        if(!row_text.empty())
          row_text += ", "; //TODO: Internationalization?
      
        row_text += text;
      }
418 419
    }
    
420 421
    //Add the row text to the result:
    if(!row_text.empty())
422 423
    {
      if(!result.empty())
424
        result += "\n";
425
      
426
      result += row_text;
427 428 429
    }
  }
  
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
  return result;
}

void Box_Data_Calendar_Related::setup_menu()
{
  m_refActionGroup = Gtk::ActionGroup::create();

  m_refActionGroup->add(Gtk::Action::create("ContextMenu", "Context Menu") );

  m_refContextEdit =  Gtk::Action::create("ContextEdit", Gtk::Stock::EDIT);

  m_refActionGroup->add(m_refContextEdit,
    sigc::mem_fun(*this, &Box_Data_Calendar_Related::on_MenuPopup_activate_Edit) );

#ifndef GLOM_ENABLE_CLIENT_ONLY
  // Don't add ContextLayout in client only mode because it would never
  // be sensitive anyway
  m_refContextLayout =  Gtk::Action::create("ContextLayout", _("Layout"));
  m_refActionGroup->add(m_refContextLayout,
    sigc::mem_fun(*this, &Box_Data_Calendar_Related::on_MenuPopup_activate_layout) );

  //TODO: This does not work until this widget is in a container in the window:
  App_Glom* pApp = get_application();
  if(pApp)
  {
    pApp->add_developer_action(m_refContextLayout); //So that it can be disabled when not in developer mode.
    pApp->update_userlevel_ui(); //Update our action's sensitivity. 
  }
#endif // !GLOM_ENABLE_CLIENT_ONLY

  m_refUIManager = Gtk::UIManager::create();

  m_refUIManager->insert_action_group(m_refActionGroup);

  //TODO: add_accel_group(m_refUIManager->get_accel_group());

#ifdef GLIBMM_EXCEPTIONS_ENABLED
  try
  {
#endif
    Glib::ustring ui_info = 
        "<ui>"
        "  <popup name='ContextMenu'>"
        "    <menuitem action='ContextEdit'/>"
#ifndef GLOM_ENABLE_CLIENT_ONLY
        "    <menuitem action='ContextLayout'/>"
#endif
        "  </popup>"
        "</ui>";

#ifdef GLIBMM_EXCEPTIONS_ENABLED
    m_refUIManager->add_ui_from_string(ui_info);
  }
  catch(const Glib::Error& ex)
  {
    std::cerr << "building menus failed: " <<  ex.what();
  }
#else
  std::auto_ptr<Glib::Error> error;
  m_refUIManager->add_ui_from_string(ui_info, error);
  if(error.get() != NULL)
  {
    std::cerr << "building menus failed: " << error->what();
  }
#endif //GLIBMM_EXCEPTIONS_ENABLED

  //Get the menu:
  m_pMenuPopup = dynamic_cast<Gtk::Menu*>( m_refUIManager->get_widget("/ContextMenu") ); 
  if(!m_pMenuPopup)
    g_warning("menu not found");

 
#ifndef GLOM_ENABLE_CLIENT_ONLY
  if(pApp)
    m_refContextLayout->set_sensitive(pApp->get_userlevel() == AppState::USERLEVEL_DEVELOPER);
505 506 507
#endif // !GLOM_ENABLE_CLIENT_ONLY
}

508
void Box_Data_Calendar_Related::on_calendar_button_press_event(GdkEventButton *event)
509
{
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
#ifndef GLOM_ENABLE_CLIENT_ONLY
  //Enable/Disable items.
  //We did this earlier, but get_application is more likely to work now:
  App_Glom* pApp = get_application();
  if(pApp)
  {
    pApp->add_developer_action(m_refContextLayout); //So that it can be disabled when not in developer mode.
    pApp->update_userlevel_ui(); //Update our action's sensitivity. 
  }
#endif

  GdkModifierType mods;
  gdk_window_get_pointer( Gtk::Widget::gobj()->window, 0, 0, &mods );
  if(mods & GDK_BUTTON3_MASK)
  {
    //Give user choices of actions on this item:
    m_pMenuPopup->popup(event->button, event->time);
    return; //handled.
  }
  else
  {
    if(event->type == GDK_2BUTTON_PRESS)
    {
      //Double-click means edit.
      //Don't do this usually, because users sometimes double-click by accident when they just want to edit a cell.

      //TODO: If the cell is not editable, handle the double-click as an edit/selection.
      //on_MenuPopup_activate_Edit();
      return; //Not handled.
    }
  }

  return; //Not handled. TODO: Call base class?
543 544
}

545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
void
Box_Data_Calendar_Related::on_MenuPopup_activate_Edit()
{
  const Gnome::Gda::Value primary_key_value; //TODO: = m_AddDel.get_value_key(row); //The primary key is in the key.

  signal_user_requested_details().emit(primary_key_value);
}

#ifndef GLOM_ENABLE_CLIENT_ONLY
void Box_Data_Calendar_Related::on_MenuPopup_activate_layout()
{
  show_layout_dialog();
}
#endif // !GLOM_ENABLE_CLIENT_ONLY


561
} //namespace Glom