File: TimesheetXmlWriter.cpp

package info (click to toggle)
charmtimetracker 1.12.0-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,340 kB
  • sloc: cpp: 19,176; xml: 284; python: 120; makefile: 14
file content (172 lines) | stat: -rw-r--r-- 6,118 bytes parent folder | download | duplicates (2)
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
/*
  TimesheetXmlWriter.cpp

  This file is part of Charm, a task-based time tracking application.

  Copyright (C) 2014-2018 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com

  Author: Frank Osterfeld <frank.osterfeld@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 "TimesheetXmlWriter.h"
#include "TimesheetInfo.h"
#include "CharmCMake.h"

#include "Core/CharmDataModel.h"
#include "Core/CharmConstants.h"
#include "Core/XmlSerialization.h"

#include <QDomDocument>

TimesheetXmlWriter::TimesheetXmlWriter(const QString &templateName)
    : m_templateName(templateName)
{
}

TimesheetXmlWriter::~TimesheetXmlWriter()
{
}

const CharmDataModel *TimesheetXmlWriter::dataModel() const
{
    return m_dataModel;
}

void TimesheetXmlWriter::setDataModel(const CharmDataModel *model)
{
    m_dataModel = model;
}

EventList TimesheetXmlWriter::events() const
{
    return m_events;
}

void TimesheetXmlWriter::setEvents(const EventList &events)
{
    m_events = events;
}

TaskId TimesheetXmlWriter::rootTask() const
{
    return m_rootTask;
}

void TimesheetXmlWriter::setRootTask(TaskId rootTask)
{
    m_rootTask = rootTask;
}

bool TimesheetXmlWriter::includeTaskList() const
{
    return m_includeTaskList;
}

void TimesheetXmlWriter::setIncludeTaskList(bool includeTaskList)
{
    m_includeTaskList = includeTaskList;
}

QByteArray TimesheetXmlWriter::saveToXml() const
{
    // now create the report:
    QDomDocument document = XmlSerialization::createXmlTemplate(m_templateName);

    // find metadata and report element:
    QDomElement root = document.documentElement();
    QDomElement metadata = XmlSerialization::metadataElement(document);
    QDomElement charmVersion = document.createElement(QStringLiteral("charmversion"));
    QDomText charmVersionString = document.createTextNode(CharmVersion());
    charmVersion.appendChild(charmVersionString);
    metadata.appendChild(charmVersion);
    auto installationId = document.createElement(QStringLiteral("installation-id"));
    const auto installationIdString = document.createTextNode(QString::number(CONFIGURATION.installationId));
    installationId.appendChild(installationIdString);
    metadata.appendChild(installationId);

    QDomElement report = XmlSerialization::reportElement(document);
    Q_ASSERT(!root.isNull() && !metadata.isNull() && !report.isNull());

    writeMetadata(document, metadata);

    TimeSheetInfoList timeSheetInfo = createTimeSheetInfo();
    // extend report tag: add tasks and effort structure

    if (m_includeTaskList) {   // tasks
        QDomElement tasks = document.createElement(QStringLiteral("tasks"));
        report.appendChild(tasks);
        Q_FOREACH (const TimeSheetInfo &info, timeSheetInfo) {
            if (info.taskId == 0)   // the root task
                continue;
            const Task &modelTask = m_dataModel->getTask(info.taskId);
            tasks.appendChild(modelTask.toXml(document));
        }
    }
    {   // effort
        // make effort element:
        QDomElement effort = document.createElement(QStringLiteral("effort"));
        report.appendChild(effort);

        // aggregate (group by task and day):
        typedef QPair<TaskId, QDate> Key;
        QMap< Key, Event> events;
        Q_FOREACH (const Event &event, m_events) {
            TimeSheetInfoList::iterator it;
            for (it = timeSheetInfo.begin(); it != timeSheetInfo.end(); ++it)
                if ((*it).taskId == event.taskId()) break;
            if (it == timeSheetInfo.end())
                continue;
            Key key(event.taskId(), event.startDateTime().date());
            if (events.contains(key)) {
                // add to previous events:
                const Event &oldEvent = events[key];
                const int seconds = oldEvent.duration() + event.duration();
                const QDateTime start = oldEvent.startDateTime();
                const QDateTime end(start.addSecs(seconds));
                Q_ASSERT(start.secsTo(end) == seconds);
                Event newEvent(oldEvent);
                newEvent.setStartDateTime(start);
                newEvent.setEndDateTime(end);
                Q_ASSERT(newEvent.duration() == seconds);
                QString comment = oldEvent.comment();
                if (!event.comment().isEmpty()) {
                    if (!comment.isEmpty())     // make separator
                        comment += QLatin1String(" / ");
                    comment += event.comment();
                    newEvent.setComment(comment);
                }
                events[key] = newEvent;
            } else {
                // add this event:
                events[key] = event;
                events[key].setId(-events[key].id());   // "synthetic" :-)
                // move to start at midnight in UTC (for privacy reasons)
                // never, never, never use setTime() here, it breaks on DST changes! (twice a year)
                QDateTime start(event.startDateTime().date(), QTime(0, 0, 0, 0), Qt::UTC);
                QDateTime end(start.addSecs(event.duration()));
                events[key].setStartDateTime(start);
                events[key].setEndDateTime(end);
                Q_ASSERT(events[key].duration() == event.duration());
                Q_ASSERT(start.time() == QTime(0, 0, 0, 0));
            }
        }
        // create elements:
        Q_FOREACH (const Event &event, events)
            effort.appendChild(event.toXml(document));
    }

    return document.toByteArray(4);
}