File: Event.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 (226 lines) | stat: -rw-r--r-- 6,788 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
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
/*
  Event.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>

  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 "Event.h"
#include "CharmExceptions.h"

#include <QDomElement>
#include <QDomText>

Event::Event()
{
}

bool Event::operator ==(const Event &other) const
{
    return other.id() == id()
           && other.taskId() == taskId()
           && other.comment() == comment()
           && other.startDateTime() == startDateTime()
           && other.endDateTime() == endDateTime()
           && other.userId() == userId()
           && other.reportId() == reportId();
}

EventId Event::id() const
{
    return m_id;
}

void Event::setId(EventId id)
{
    m_id = id;
}

int Event::userId() const
{
    return m_userid;
}

void Event::setUserId(int userId)
{
    m_userid = userId;
}

int Event::reportId() const
{
    return m_reportid;
}

void Event::setReportId(int reportId)
{
    m_reportid = reportId;
}

bool Event::isValid() const
{   // negative values are allowed and indicate calculated values
    return id() != 0;
}

TaskId Event::taskId() const
{
    return m_taskId;
}

void Event::setTaskId(TaskId taskId)
{
    m_taskId = taskId;
}

QString Event::comment() const
{
    return m_comment;
}

void Event::setComment(const QString &comment)
{
    m_comment = comment;
}

QDateTime Event::startDateTime(Qt::TimeSpec timeSpec) const
{
    return m_start.toTimeSpec(timeSpec);
}

void Event::setStartDateTime(const QDateTime &start)
{
    m_start = start.toUTC();
    // strip milliseconds, this is necessary for the precision of serialization:
    m_start = m_start.addMSecs(-m_start.time().msec());
    Q_ASSERT(qAbs(m_start.secsTo(start)) <= 1);
    Q_ASSERT(m_start.time().msec() == 0);
}

QDateTime Event::endDateTime(Qt::TimeSpec timeSpec) const
{
    return m_end.toTimeSpec(timeSpec);
}

void Event::setEndDateTime(const QDateTime &end)
{
    m_end = end.toUTC();
    // strip milliseconds, this is necessary for the precision of serialization:
    m_end = m_end.addMSecs(-m_end.time().msec());
    Q_ASSERT(qAbs(m_end.secsTo(end)) <= 1);
    Q_ASSERT(m_end.time().msec() == 0);
}

int Event::duration() const
{
    if (m_start.isValid() && m_end.isValid()) {
        return m_start.secsTo(m_end);
    } else {
        return 0;
    }
}

void Event::dump() const
{
    qDebug() << "[Event" << id() << "] - task "
             << taskId()
             << " - start: " << startDateTime()
             << " - end: " << endDateTime()
             << " - duration: " << duration()
             << "seconds - comment:" << comment();
}

void dumpEvents(const EventList &events)
{
    for (int i = 0; i < events.size(); ++i)
        events[i].dump();
}

const QString EventElement(QStringLiteral("event"));
const QString EventIdAttribute(QStringLiteral("eventid"));
const QString EventTaskIdAttribute(QStringLiteral("taskid"));
const QString EventUserIdAttribute(QStringLiteral("userid"));
const QString EventReportIdAttribute(QStringLiteral("reportid"));
const QString EventStartAttribute(QStringLiteral("start"));
const QString EventEndAttribute(QStringLiteral("end"));

QDomElement Event::toXml(QDomDocument document) const
{
    QDomElement element = document.createElement(EventElement);
    element.setAttribute(EventIdAttribute, QString().setNum(id()));
    element.setAttribute(EventTaskIdAttribute, QString().setNum(taskId()));
    element.setAttribute(EventUserIdAttribute, QString().setNum(userId()));
    element.setAttribute(EventReportIdAttribute, QString().setNum(reportId()));
    if (m_start.isValid())
        element.setAttribute(EventStartAttribute, m_start.toString(Qt::ISODate));
    if (m_end.isValid())
        element.setAttribute(EventEndAttribute, m_end.toString(Qt::ISODate));
    if (!comment().isEmpty()) {
        QDomText commentText = document.createTextNode(comment());
        element.appendChild(commentText);
    }
    return element;
}

QString Event::tagName()
{
    static const QString tag(QStringLiteral("event"));
    return tag;
}

Event Event::fromXml(const QDomElement &element, int databaseSchemaVersion)
{   // in case any event object creates trouble with
    // serialization/deserialization, add an object of it to
    // void XmlSerializationTests::testEventSerialization()
    Event event;
    bool ok;
    event.setComment(element.text());
    event.setId(element.attribute(EventIdAttribute).toInt(&ok));
    if (!ok) throw XmlSerializationException(QObject::tr("Event::fromXml: invalid event id"));

    event.setTaskId(element.attribute(EventTaskIdAttribute).toInt(&ok));
    if (!ok) throw XmlSerializationException(QObject::tr("Event::fromXml: invalid task id"));
    event.setUserId(element.attribute(EventUserIdAttribute).toInt(&ok));
    if (!ok && databaseSchemaVersion > 1) {
        throw XmlSerializationException(QObject::tr("Event::fromXml: invalid user id"));
        event.setUserId(0);
    }
    event.setReportId(element.attribute(EventReportIdAttribute).toInt(&ok));
    if (!ok && databaseSchemaVersion > 1) {
        throw XmlSerializationException(QObject::tr("Event::fromXml: invalid report id"));
        event.setReportId(0);
    }
    if (element.hasAttribute(EventStartAttribute)) {
        QDateTime start
            = QDateTime::fromString(element.attribute(EventStartAttribute), Qt::ISODate);
        if (!start.isValid()) throw XmlSerializationException(QObject::tr(
                                                                  "Event::fromXml: invalid start date"));

        start.setTimeSpec(Qt::UTC);
        event.setStartDateTime(start);
    }
    if (element.hasAttribute(EventEndAttribute)) {
        QDateTime end = QDateTime::fromString(element.attribute(EventEndAttribute), Qt::ISODate);
        if (!end.isValid()) throw XmlSerializationException(QObject::tr(
                                                                "Event::fromXml: invalid end date"));

        end.setTimeSpec(Qt::UTC);
        event.setEndDateTime(end.toLocalTime());
    }
    event.setComment(element.text());
    return event;
}