1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 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 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 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 505 506 507 508 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 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
|
/*
CharmDataModel.cpp
This file is part of Charm, a task-based time tracking application.
Copyright (C) 2007-2018 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
Author: Mirko Boehm <mirko.boehm@kdab.com>
Author: Frank Osterfeld <frank.osterfeld@kdab.com>
Author: David Faure <david.faure@kdab.com>
Author: Mike McQuaid <mike.mcquaid@kdab.com>
Author: Guillermo A. Amaral <gamaral@kdab.com>
Author: Allen Winter <allen.winter@kdab.com>
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, see <http://www.gnu.org/licenses/>.
*/
#include "CharmDataModel.h"
#include "CharmConstants.h"
#include "Configuration.h"
#include <QList>
#include <QtDebug>
#include <QDateTime>
#include <QSettings>
#include <QStringList>
#include <algorithm>
#include <functional>
#include <queue>
#include <unordered_map>
#include <set>
CharmDataModel::CharmDataModel()
: QObject()
{
connect(&m_timer, SIGNAL(timeout()), SLOT(eventUpdateTimerEvent()));
}
CharmDataModel::~CharmDataModel()
{
m_adapters.clear();
setAllTasks(TaskList());
}
void CharmDataModel::stateChanged(State previous, State next)
{
if (previous == Connected && next == Disconnecting) {
Q_FOREACH (EventId id, m_activeEventIds) {
const Event &event = findEvent(id);
const Task &task = findTask(event.taskId());
Q_ASSERT(task.isValid());
endEventRequested(task);
}
setAllTasks(TaskList());
}
}
void CharmDataModel::registerAdapter(CharmDataModelAdapterInterface *adapter)
{
m_adapters.append(adapter);
adapter->resetEvents();
}
void CharmDataModel::unregisterAdapter(CharmDataModelAdapterInterface *adapter)
{
Q_ASSERT(m_adapters.contains(adapter));
m_adapters.removeAll(adapter);
}
void CharmDataModel::setAllTasks(const TaskList &tasks)
{
clearTasks();
Q_ASSERT(Task::checkForTreeness(tasks));
Q_ASSERT(Task::checkForUniqueTaskIds(tasks));
// fill the tasks into the map to TaskTreeItems
for (int i = 0; i < tasks.size(); ++i) {
const TaskTreeItem item(tasks[i], &m_rootItem);
Q_ASSERT(!taskExists(tasks[i].id())); // the tasks form a tree and have unique task ids
m_tasks[ tasks[i].id() ] = item;
}
// create parent-child-relationships:
for (TaskTreeItem::Map::iterator it = m_tasks.begin(); it != m_tasks.end(); ++it) {
const Task &task = it->second.task();
TaskTreeItem &parent = parentItem(task);
it->second.makeChildOf(parent);
}
// store task id length:
determineTaskPaddingLength();
m_nameCache.setAllTasks(tasks);
// notify adapters of changes
for_each(m_adapters.begin(), m_adapters.end(),
std::mem_fun(&CharmDataModelAdapterInterface::resetTasks));
emit resetGUIState();
}
void CharmDataModel::addTask(const Task &task)
{
Q_ASSERT_X(!taskExists(task.id()), Q_FUNC_INFO,
"New tasks need to have a unique task id");
if (task.isValid() && !taskExists(task.id())) {
const TaskTreeItem &parent = taskTreeItem(task.parent());
Q_FOREACH (auto adapter, m_adapters)
adapter->taskAboutToBeAdded(parent.task().id(),
parent.childCount());
const TaskTreeItem item(task);
m_tasks[ task.id() ] = item;
m_nameCache.addTask(task);
// the item in the map has a different address, let's find it:
Q_ASSERT(taskExists(task.id())); // we just put it in
const auto it = m_tasks.find(task.id());
it->second.makeChildOf(parentItem(task));
determineTaskPaddingLength();
// regenerateSmartNames();
Q_FOREACH (auto adapter, m_adapters)
adapter->taskAdded(task.id());
} else {
qCritical() << "CharmDataModel::addTask: duplicate task id"
<< task.id() << "ignored. THIS IS A BUG";
}
}
void CharmDataModel::modifyTask(const Task &task)
{
const auto it = m_tasks.find(task.id());
Q_ASSERT_X(it != m_tasks.end(), Q_FUNC_INFO,
"Task to modify has to exist");
if (it == m_tasks.end())
return;
const TaskId oldParentId = it->second.task().parent();
const bool parentChanged = task.parent() != oldParentId;
if (parentChanged) {
Q_FOREACH (auto adapter, m_adapters)
adapter->taskParentChanged(task.id(), oldParentId, task.parent());
m_tasks[ task.id() ].makeChildOf(parentItem(task));
}
m_tasks[ task.id() ].task() = task;
m_nameCache.modifyTask(task);
if (parentChanged) {
Q_FOREACH (auto adapter, m_adapters)
adapter->resetTasks();
} else {
Q_FOREACH (auto adapter, m_adapters)
adapter->taskModified(task.id());
}
}
void CharmDataModel::deleteTask(const Task &task)
{
Q_ASSERT_X(taskExists(task.id()), Q_FUNC_INFO,
"Task to delete has to exist");
Q_ASSERT_X(taskTreeItem(task.id()).childCount() == 0,
Q_FUNC_INFO,
"Cannot delete a task that has children");
Q_FOREACH (auto adapter, m_adapters)
adapter->taskAboutToBeDeleted(task.id());
const auto it = m_tasks.find(task.id());
if (it != m_tasks.end()) {
TaskTreeItem tmpParent;
it->second.makeChildOf(tmpParent);
m_tasks.erase(it);
}
m_nameCache.deleteTask(task);
Q_FOREACH (auto adapter, m_adapters)
adapter->taskDeleted(task.id());
}
void CharmDataModel::clearTasks()
{
// to clear the task list, all tasks have first to be changed to be children of the root item:
for (TaskTreeItem::Map::iterator it = m_tasks.begin(); it != m_tasks.end(); ++it)
it->second.makeChildOf(m_rootItem);
m_tasks.clear();
m_nameCache.clearTasks();
m_rootItem = TaskTreeItem();
Q_FOREACH (auto adapter, m_adapters)
adapter->resetTasks();
}
void CharmDataModel::setAllEvents(const EventList &events)
{
m_events.clear();
for (int i = 0; i < events.size(); ++i) {
if (!eventExists(events[i].id())) {
m_events[ events[i].id() ] = events[i];
} else {
qCritical() << "CharmDataModel::addTask: duplicate task id"
<< m_tasks[i].task().id() << "ignored. THIS IS A BUG";
}
}
Q_FOREACH (auto adapter, m_adapters)
adapter->resetEvents();
}
void CharmDataModel::addEvent(const Event &event)
{
Q_ASSERT_X(!eventExists(event.id()), Q_FUNC_INFO,
"New event must have a unique id");
Q_FOREACH (auto adapter, m_adapters)
adapter->eventAboutToBeAdded(event.id());
m_events[ event.id() ] = event;
Q_FOREACH (auto adapter, m_adapters)
adapter->eventAdded(event.id());
}
void CharmDataModel::modifyEvent(const Event &newEvent)
{
Q_ASSERT_X(eventExists(newEvent.id()), Q_FUNC_INFO,
"Event to modify has to exist");
const Event oldEvent = eventForId(newEvent.id());
m_events[ newEvent.id() ] = newEvent;
Q_FOREACH (auto adapter, m_adapters)
adapter->eventModified(newEvent.id(), oldEvent);
}
void CharmDataModel::deleteEvent(const Event &event)
{
Q_ASSERT_X(eventExists(event.id()), Q_FUNC_INFO,
"Event to delete has to exist");
Q_ASSERT_X(!m_activeEventIds.contains(event.id()), Q_FUNC_INFO,
"Cannot delete an active event");
Q_FOREACH (auto adapter, m_adapters)
adapter->eventAboutToBeDeleted(event.id());
const auto it = m_events.find(event.id());
if (it != m_events.end())
m_events.erase(it);
Q_FOREACH (auto adapter, m_adapters)
adapter->eventDeleted(event.id());
}
void CharmDataModel::clearEvents()
{
m_events.clear();
Q_FOREACH (auto adapter, m_adapters)
adapter->resetEvents();
}
const TaskTreeItem &CharmDataModel::taskTreeItem(TaskId id) const
{
if (id <= 0) return m_rootItem;
const auto it = m_tasks.find(id);
if (it == m_tasks.end()) {
return m_rootItem;
} else {
return it->second;
}
}
const Task &CharmDataModel::getTask(TaskId id) const
{
const TaskTreeItem &item = taskTreeItem(id);
return item.task();
}
TaskList CharmDataModel::getAllTasks() const
{
return m_rootItem.children();
}
Task &CharmDataModel::findTask(TaskId id)
{ // in this (private) method, the task has to exist
const TaskTreeItem::Map::iterator it = m_tasks.find(id);
Q_ASSERT(it != m_tasks.end());
return it->second.task();
}
const Event &CharmDataModel::eventForId(EventId id) const
{
static const Event InvalidEvent;
EventMap::const_iterator it = m_events.find(id);
if (it != m_events.end()) {
return it->second;
} else {
return InvalidEvent;
}
}
Event &CharmDataModel::findEvent(int id)
{
// in this method, the event has to exist
const auto it = m_events.find(id);
Q_ASSERT(it != m_events.end());
return it->second;
}
bool CharmDataModel::activateEvent(const Event &activeEvent)
{
const bool DoSanityChecks = true;
if (DoSanityChecks) {
TaskId taskId = activeEvent.taskId();
// this check may become obsolete:
for (int i = 0; i < m_activeEventIds.size(); ++i) {
if (m_activeEventIds[i] == activeEvent.id()) {
Q_ASSERT(!"inconsistency (event already active)!");
return false;
}
const Event &e = eventForId(m_activeEventIds[i]);
if (e.taskId() == taskId) {
Q_ASSERT(!"inconsistency (event already active for task)!");
return false;
}
}
}
m_activeEventIds << activeEvent.id();
Q_FOREACH (auto adapter, m_adapters)
adapter->eventActivated(activeEvent.id());
m_timer.start(10000);
return true;
}
void CharmDataModel::determineTaskPaddingLength()
{
int maxTaskId = 0;
for (TaskTreeItem::Map::iterator it = m_tasks.begin(); it != m_tasks.end(); ++it)
maxTaskId = qMax(maxTaskId, it->second.task().id());
QString temp;
temp.setNum(maxTaskId);
CONFIGURATION.taskPaddingLength = temp.length();
}
TaskTreeItem &CharmDataModel::parentItem(const Task &task)
{
TaskTreeItem &parent = m_tasks[ task.parent() ];
if (parent.isValid()) {
return parent;
} else {
return m_rootItem;
}
}
bool CharmDataModel::taskExists(TaskId id)
{
return m_tasks.find(id) != m_tasks.end();
}
bool CharmDataModel::eventExists(EventId id)
{
return m_events.find(id) != m_events.end();
}
bool CharmDataModel::isTaskActive(TaskId id) const
{
for (int i = 0; i < m_activeEventIds.size(); ++i) {
const Event &e = eventForId(m_activeEventIds[i]);
Q_ASSERT(e.isValid());
if (e.taskId() == id)
return true;
}
return false;
}
const Event &CharmDataModel::activeEventFor(TaskId id) const
{
static Event InvalidEvent;
for (int i = 0; i < m_activeEventIds.size(); ++i) {
const Event &e = eventForId(m_activeEventIds[i]);
if (e.taskId() == id)
return e;
}
return InvalidEvent;
}
void CharmDataModel::startEventRequested(const Task &task)
{
// respect configuration:
if (!m_activeEventIds.isEmpty())
endAllEventsRequested();
// clear the "last event editor datetime" so that the next manual "create event"
// doesn't use some old date
QSettings settings;
settings.remove(MetaKey_LastEventEditorDateTime);
emit makeAndActivateEvent(task);
updateToolTip();
}
void CharmDataModel::endEventRequested(const Task &task)
{
EventId eventId = 0;
// find the event in the list of active events and remove it:
for (int i = 0; i < m_activeEventIds.size(); ++i) {
if (eventForId(m_activeEventIds[i]).taskId() == task.id()) {
eventId = m_activeEventIds[i];
m_activeEventIds.removeAt(i);
Q_FOREACH (auto adapter, m_adapters)
adapter->eventDeactivated(eventId);
break;
}
}
Q_ASSERT(eventId != 0);
Event &event = findEvent(eventId);
Event old = event;
event.setEndDateTime(QDateTime::currentDateTime());
emit requestEventModification(event, old);
if (m_activeEventIds.isEmpty()) m_timer.stop();
updateToolTip();
}
void CharmDataModel::endAllEventsRequested()
{
QDateTime currentDateTime = QDateTime::currentDateTime();
while (!m_activeEventIds.isEmpty()) {
EventId eventId = m_activeEventIds.first();
m_activeEventIds.pop_front();
Q_FOREACH (auto adapter, m_adapters)
adapter->eventDeactivated(eventId);
Q_ASSERT(eventId != 0);
Event &event = findEvent(eventId);
Event old = event;
event.setEndDateTime(currentDateTime);
emit requestEventModification(event, old);
}
m_timer.stop();
updateToolTip();
}
void CharmDataModel::eventUpdateTimerEvent()
{
Q_FOREACH (EventId id, m_activeEventIds) {
// Not a ref (Event &), since we want to diff "old event"
// and "new event" in *Adapter::eventModified
Event event = findEvent(id);
Event old = event;
event.setEndDateTime(QDateTime::currentDateTime());
emit requestEventModification(event, old);
}
updateToolTip();
}
QString CharmDataModel::fullTaskName(const Task &task) const
{
if (task.isValid()) {
QString name = task.name().simplified();
if (task.parent() != 0) {
const Task &parent = getTask(task.parent());
if (parent.isValid())
name = fullTaskName(parent) + QLatin1Char('/') + name;
}
return name;
} else {
// qWarning() << "CharmReport::tasknameWithParents: WARNING: invalid task"
// << task.id();
return QString();
}
}
QString CharmDataModel::smartTaskName(const Task &task) const
{
return m_nameCache.smartName(task.id());
}
QString CharmDataModel::eventsString() const
{
QStringList eStrList;
Q_FOREACH (EventId eventId, activeEvents()) {
Event event = eventForId(eventId);
if (event.isValid()) {
const Task &task = getTask(event.taskId());
const int taskIdLength = CONFIGURATION.taskPaddingLength;
eStrList
<<tr("%1 - %2 %3")
.arg(hoursAndMinutes(event.duration()))
.arg(task.id(), taskIdLength, 10, QLatin1Char('0'))
.arg(fullTaskName(task));
}
}
return eStrList.join(QLatin1Char('\n'));
}
QString CharmDataModel::taskIdAndFullNameString(TaskId id) const
{
return QStringLiteral("%1 %2")
.arg(id, CONFIGURATION.taskPaddingLength, 10, QLatin1Char('0'))
.arg(fullTaskName(getTask(id)));
}
QString CharmDataModel::taskIdAndSmartNameString(TaskId id) const
{
return QStringLiteral("%1 %2")
.arg(id, CONFIGURATION.taskPaddingLength, 10, QLatin1Char('0'))
.arg(smartTaskName(getTask(id)));
}
QString CharmDataModel::taskIdAndNameString(TaskId id) const
{
return QStringLiteral("%1 %2")
.arg(id, CONFIGURATION.taskPaddingLength, 10, QLatin1Char('0'))
.arg(getTask(id).name());
}
int CharmDataModel::totalDuration() const
{
int totalDuration = 0;
Q_FOREACH (EventId eventId, activeEvents()) {
Event event = eventForId(eventId);
if (event.isValid())
totalDuration += event.duration();
}
return totalDuration;
}
QString CharmDataModel::totalDurationString() const
{
return hoursAndMinutes(totalDuration());
}
void CharmDataModel::updateToolTip()
{
QString toolTip;
int numEvents = activeEvents().count();
switch (numEvents) {
case 0:
toolTip = tr("No active events");
break;
case 1:
toolTip = eventsString();
break;
default:
toolTip = tr("<qt>%1 for %2 active events:<hr>%3</qt>")
.arg(totalDurationString()).arg(numEvents).arg(eventsString());
break;
}
emit sysTrayUpdate(toolTip, numEvents != 0);
}
const EventMap &CharmDataModel::eventMap() const
{
return m_events;
}
bool CharmDataModel::isEventActive(EventId id) const
{
return m_activeEventIds.contains(id);
}
int CharmDataModel::activeEventCount() const
{
return m_activeEventIds.count();
}
EventIdList CharmDataModel::eventsThatStartInTimeFrame(const QDate &start, const QDate &end) const
{
// do the comparisons in UTC, which is much faster as we only need to convert
// start and end date then
const QDateTime startUTC = QDateTime(start, QTime(0, 0, 0)).toUTC();
const QDateTime endUTC = QDateTime(end, QTime(0, 0, 0)).toUTC();
EventIdList events;
EventMap::const_iterator it;
for (it = m_events.begin();
it != m_events.end(); ++it) {
const Event &event(it->second);
if (event.startDateTime(Qt::UTC) >= startUTC && event.startDateTime(Qt::UTC) < endUTC)
events << event.id();
}
return events;
}
EventIdList CharmDataModel::eventsThatStartInTimeFrame(const TimeSpan &timeSpan) const
{
return eventsThatStartInTimeFrame(timeSpan.first, timeSpan.second);
}
bool CharmDataModel::isParentOf(TaskId parent, TaskId id) const
{
Q_ASSERT_X(parent != 0, Q_FUNC_INFO, "parent is invalid (0)");
if (id == parent) return false; // a task is not it's own child
// get the item, make sure it is valid
const TaskTreeItem &item(taskTreeItem(id));
Q_ASSERT_X(item.isValid(), Q_FUNC_INFO, "No such task");
if (!item.isValid()) return false;
TaskId parentId = item.task().parent();
if (parentId == parent) return true; // found it on the path
if (parentId == 0) return false; // the task has no parent
return isParentOf(parent, parentId);
}
EventIdList CharmDataModel::activeEvents() const
{
return m_activeEventIds;
}
TaskIdList CharmDataModel::mostFrequentlyUsedTasks() const
{
std::unordered_map<TaskId, quint32 > mfuMap;
const EventMap& events = eventMap();
for( auto it : events) {
mfuMap[it.second.taskId()]++;
}
const auto comp = []( quint32 a, quint32 b ){
return a > b;
};
std::map<quint32, TaskId, decltype( comp )> mfu( comp );
for ( const auto kv : mfuMap ) {
mfu[kv.second] = kv.first;
}
TaskIdList out;
out.reserve( static_cast<int>( mfu.size() ) );
std::transform( mfu.cbegin(), mfu.cend(), std::inserter( out, out.begin() ), []( const std::pair<const quint32, TaskId> &in ) {
return in.second;
});
return out;
}
TaskIdList CharmDataModel::mostRecentlyUsedTasks() const
{
std::unordered_map<TaskId, QDateTime> mruMap;
const EventMap& events = eventMap();
for( const auto &it : events ) {
const TaskId id = it.second.taskId();
if ( id == 0 )
continue;
// process use date
// Note: for a relative order, the UTC time is sufficient and much faster
const QDateTime date = it.second.startDateTime( Qt::UTC );
const auto old = mruMap.find( id );
if ( old != mruMap.cend() ) {
mruMap[id]= qMax( old->second, date );
} else {
mruMap[id]= date;
}
}
const auto comp = [] ( const QDateTime &a, const QDateTime &b )
{
return a > b;
};
std::map<QDateTime, TaskId, decltype( comp )> mru( comp );
for ( const auto kv : mruMap ) {
mru[kv.second] = kv.first;
}
TaskIdList out;
out.reserve( static_cast<int>( mru.size() ) );
std::transform( mru.cbegin(), mru.cend(), std::inserter( out, out.begin() ), []( const std::pair<const QDateTime, TaskId> &in ) {
return in.second;
});
return out;
}
bool CharmDataModel::operator==(const CharmDataModel &other) const
{
// not compared: m_timer, m_adapters
if (&other == this)
return true;
return getAllTasks() == other.getAllTasks()
&& m_events == other.m_events
&& m_activeEventIds == other.m_activeEventIds;
}
CharmDataModel *CharmDataModel::clone() const
{
auto c = new CharmDataModel();
c->setAllTasks(getAllTasks());
c->m_events = m_events;
c->m_activeEventIds = m_activeEventIds;
return c;
}
|